![\"\"](\"https://img.shields.io/npm/v/@nuxt-alt/auth.svg?style=flat-square\")
\r\n\r\n\r\n ![\"\"](\"https://img.shields.io/npm/dt/@nuxt-alt/auth.svg?style=flat-square\")
\r\n\r\nAlternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n ![\"\"](\"https://img.shields.io/npm/v/@nuxt-alt/auth.svg?style=flat&colorA=18181B&colorB=28CF8D\")
\r\n\r\n\r\n ![\"\"](\"https://img.shields.io/npm/dt/@nuxt-alt/auth.svg?style=flat&colorA=18181B&colorB=28CF8D\")
\r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n \r\n\r\n\r\n \r\n\r\n
Alternative Auth module for Nuxt
\r\n\r\n\r\n\r\n## Info\r\n\r\nThis module is meant as an alternative to @nuxtjs/auth, except this is for nuxt3 only with no backwards compatibility support.\r\n\r\n## Setup\r\n\r\n1. Add `@nuxt-alt/auth` and `@nuxt-alt/http` dependency to your project\r\n\r\n```bash\r\nyarn add @nuxt-alt/auth @nuxt-alt/http\r\n```\r\n\r\n2. Add `@nuxt-alt/auth` and `@pinia/nuxt` to the `modules` section of `nuxt.config.ts`\r\n\r\n**Note:** you dont need to specify `@nuxt-alt/http`, it will automatically be added but if you want to manually add it, make sure it is below the auth module (and above the proxy module if you are using it). It also doesn't need pinia\r\nit will use nuxt's `useState` by default.\r\n\r\n```ts\r\nexport default defineNuxtConfig({\r\n modules: [\r\n '@nuxt-alt/auth'\r\n ],\r\n auth: {\r\n /* module options */\r\n }\r\n});\r\n\r\n```\r\n\r\n## Documentation\r\n[Read Documentation](https://nuxt-alt-auth.vercel.app)\r\n\r\n## Changes \r\n\r\nThe module now uses '@nuxt-alt/http' to function, that module extends ohmyfetch. Please note that if you were using `data` to post data, you now need to use `body` since this is what `ohmyfetch` uses. If you intend to use ssr, please consider using the `@nuxt-alt/proxy` module.\r\n\r\n## Composable\r\n\r\nA `useAuth()` composable is availale to use to access the auth methods.\r\n\r\n## Options\r\nMost of the options are taken directly from the [@nuxtjs/auth](https://auth.nuxtjs.org/api/options) module. In addition there are some extra options available.\r\n\r\n### `globalMiddleware`\r\n\r\n- Type: `Boolean`\r\n- Default: `false`\r\n\r\nEnables/disables the middleware to be used globally.\r\n\r\n### `enableMiddleware`\r\n\r\n- Type: `Boolean`\r\n- Default: `true`\r\n\r\nEnables/disables the built-in middleware.\r\n\r\n### `stores.state.namespace`\r\n\r\n- Type: `String`\r\n- Default: `auth`\r\n\r\nThis is the namespace to use for nuxt useState.\r\n\r\n### `stores.pinia.enabled`\r\n- Type: `Boolean`\r\n- Default: `false`\r\n\r\nEnable this option to use the pinia store, bey default this is disabled and nuxt's `useState` is used instead.\r\n\r\n### `stores.pinia.namespace`\r\n\r\n- Type: `String`\r\n- Default: `auth`\r\n\r\nThis is the namespace to use for the pinia store.\r\n\r\n### `stores.local.enabled`\r\n- Type: `Boolean`\r\n- Default: `true`\r\n\r\nEnable this option to use the localStorage store.\r\n\r\n### `stores.local.prefix`\r\n\r\n- Type: `String`\r\n- Default: `auth.`\r\n\r\nThis sets the localStorage prefix.\r\n\r\n### `stores.session.enabled`\r\n- Type: `Boolean`\r\n- Default: `true`\r\n\r\nEnable this option to use the sessionStorage store.\r\n\r\n### `stores.session.prefix`\r\n\r\n- Type: `String`\r\n- Default: `auth.`\r\n\r\nSimilar to the localstorage option, this is the prefix for session storage.\r\n\r\n### `stores.cookie.enabled`\r\n- Type: `Boolean`\r\n- Default: `true`\r\n\r\nEnable this option to use the cookie storage.\r\n\r\n### `stores.cookie.prefix`\r\n\r\n- Type: `String`\r\n- Default: `auth.`\r\n\r\nSimilar to the localstorage option, this is the prefix for the cookie storage.\r\n\r\n### `stores.cookie.options`\r\n\r\n- Type: `Object`\r\n- Default: `{ path: '/' }`\r\n\r\nThe default cookie storage options.\r\n\r\n### `redirectStrategy`\r\n\r\n- Type: `query | storage`\r\n- Default: `storage`\r\n\r\nThe type of redirection strategy you want to use, `storage` utilizng localStorage for redirects, `query` utilizing the route query parameters.\r\n\r\n### `tokenValidationInterval`\r\n\r\n- Type: `Boolean | Number`\r\n- Default: `false`\r\n\r\nThis is experimental. If set to true, default interval is 1000ms, otherwise set time in milliseconds. This is how often the module with attempt to validate the token for expiry.\r\n\r\n### `resetOnResponseError`\r\n\r\n- Type: `Boolean | Function`\r\n- Default: `false`\r\n\r\nWhen enabled it will reset when there's a 401 error in any of the responses. You are able to turn this into a function to handle this yourself:\r\n```ts\r\nauth: {\r\n //... module options\r\n resetOnResponseError: (error, auth, scheme) => {\r\n if (error.response.status === 401) {\r\n scheme.reset?.()\r\n auth.redirect('login')\r\n }\r\n },\r\n}\r\n```\r\n\r\n## TypeScript (2.6.0+)\r\nThe user information can be edited like so for TypeScript:\r\n```ts\r\ndeclare module '@nuxt-alt/auth' {\r\n interface UserInfo {\r\n email: string\r\n name: string\r\n }\r\n}\r\n```\r\n\r\n## Tokens (Types)\r\n\r\nIn addition to [Auth Tokens](https://auth.nuxtjs.org/api/tokens);\r\n\r\nBy default the `$auth.strategy` getter uses the `Scheme` type which does not have `token` or `refreshToken` property types. To help with this, a `$auth.refreshStrategy` and a `$auth.tokenStrategy` getter have been added for typing. They all do the same thing, this is just meant for type hinting.\r\n\r\n## Oauth2\r\n\r\nOauth2 now has client window authentication thanks to this pull request: https://github.com/nuxt-community/auth-module/pull/1746 \r\n\r\nProperties have been changed to:\r\n\r\n### `clientWindow`\r\n\r\n- Type: `Boolean`\r\n- Default: `false`\r\n\r\nEnable/disable the use of a popup for client authentication.\r\n\r\n### `clientWidth`\r\n\r\n- Type: `Number`\r\n- Default: `400`\r\n\r\nThe width of the client window.\r\n\r\n### `clientHieght`\r\n\r\n- Type: `Number`\r\n- Default: `600`\r\n\r\nThe width of the client window.\r\n\r\n## Aliases\r\nAvailable aliases to use within nuxt\r\n\r\n- `#auth/runtime`\r\n- `#auth/utils`\r\n- `#auth/providers`\r\n","readmeFilename":"readme.md"}