nuxt-auther 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 nuxt-alt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,217 @@
+<h1 align="center">Auth</h1>
+<p align="center">Alternative Auth module for Nuxt</p>
+
+<p align="center">
+<a href="https://www.npmjs.com/package/@nuxt-alt/auth">
+    <img alt="" src="https://img.shields.io/npm/v/@nuxt-alt/auth.svg?style=flat&colorA=18181B&colorB=28CF8D">
+</a>
+<a href="https://www.npmjs.com/package/@nuxt-alt/auth">
+    <img alt="" src="https://img.shields.io/npm/dt/@nuxt-alt/auth.svg?style=flat&colorA=18181B&colorB=28CF8D">
+</a>
+</p>
+
+## Info
+
+This module is meant as an alternative to @nuxtjs/auth, except this is for nuxt3 only with no backwards compatibility support.
+
+## Setup
+
+1. Add `@nuxt-alt/auth` and `@nuxt-alt/http` dependency to your project
+
+```bash
+yarn add @nuxt-alt/auth @nuxt-alt/http
+```
+
+2. Add `@nuxt-alt/auth` and `@pinia/nuxt` to the `modules` section of `nuxt.config.ts`
+
+**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
+it will use nuxt's `useState` by default.
+
+```ts
+export default defineNuxtConfig({
+    modules: [
+        '@nuxt-alt/auth'
+    ],
+    auth: {
+        /* module options */
+    }
+});
+
+```
+
+## Documentation
+[Read Documentation](https://nuxt-alt-auth.vercel.app)
+
+## Changes 
+
+The 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.
+
+## Composable
+
+A `useAuth()` composable is availale to use to access the auth methods.
+
+## Options
+Most 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.
+
+### `globalMiddleware`
+
+- Type: `Boolean`
+- Default: `false`
+
+Enables/disables the middleware to be used globally.
+
+### `enableMiddleware`
+
+- Type: `Boolean`
+- Default: `true`
+
+Enables/disables the built-in middleware.
+
+### `stores.state.namespace`
+
+- Type: `String`
+- Default: `auth`
+
+This is the namespace to use for nuxt useState.
+
+### `stores.pinia.enabled`
+- Type: `Boolean`
+- Default: `false`
+
+Enable this option to use the pinia store, bey default this is disabled and nuxt's `useState` is used instead.
+
+### `stores.pinia.namespace`
+
+- Type: `String`
+- Default: `auth`
+
+This is the namespace to use for the pinia store.
+
+### `stores.local.enabled`
+- Type: `Boolean`
+- Default: `true`
+
+Enable this option to use the localStorage store.
+
+### `stores.local.prefix`
+
+- Type: `String`
+- Default: `auth.`
+
+This sets the localStorage prefix.
+
+### `stores.session.enabled`
+- Type: `Boolean`
+- Default: `true`
+
+Enable this option to use the sessionStorage store.
+
+### `stores.session.prefix`
+
+- Type: `String`
+- Default: `auth.`
+
+Similar to the localstorage option, this is the prefix for session storage.
+
+### `stores.cookie.enabled`
+- Type: `Boolean`
+- Default: `true`
+
+Enable this option to use the cookie storage.
+
+### `stores.cookie.prefix`
+
+- Type: `String`
+- Default: `auth.`
+
+Similar to the localstorage option, this is the prefix for the cookie storage.
+
+### `stores.cookie.options`
+
+- Type: `Object`
+- Default: `{ path: '/' }`
+
+The default cookie storage options.
+
+### `redirectStrategy`
+
+- Type: `query | storage`
+- Default: `storage`
+
+The type of redirection strategy you want to use, `storage` utilizng localStorage for redirects, `query` utilizing the route query parameters.
+
+### `tokenValidationInterval`
+
+- Type: `Boolean | Number`
+- Default: `false`
+
+This 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.
+
+### `resetOnResponseError`
+
+- Type: `Boolean | Function`
+- Default: `false`
+
+When 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:
+```ts
+auth: {
+    //... module options
+    resetOnResponseError: (error, auth, scheme) => {
+       if (error.response.status === 401) {
+           scheme.reset?.()
+           auth.redirect('login')
+       }
+   },
+}
+```
+
+## TypeScript (2.6.0+)
+The user information can be edited like so for TypeScript:
+```ts
+declare module '@nuxt-alt/auth' {
+    interface UserInfo {
+        email: string
+        name: string
+    }
+}
+```
+
+## Tokens (Types)
+
+In addition to [Auth Tokens](https://auth.nuxtjs.org/api/tokens);
+
+By 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.
+
+## Oauth2
+
+Oauth2 now has client window authentication thanks to this pull request: https://github.com/nuxt-community/auth-module/pull/1746 
+
+Properties have been changed to:
+
+### `clientWindow`
+
+- Type: `Boolean`
+- Default: `false`
+
+Enable/disable the use of a popup for client authentication.
+
+### `clientWidth`
+
+- Type: `Number`
+- Default: `400`
+
+The width of the client window.
+
+### `clientHieght`
+
+- Type: `Number`
+- Default: `600`
+
+The width of the client window.
+
+## Aliases
+Available aliases to use within nuxt
+
+- `#auth/runtime`
+- `#auth/utils`
+- `#auth/providers`

package/package.json

@@ -0,0 +1,70 @@
+{
+    "name": "nuxt-auther",
+    "version": "1.0.0",
+    "description": "Authentication module for Nuxt.JS",
+    "homepage": "https://github.com/zerosdev/nuxt-auther",
+    "author": "zerosdev",
+    "keywords": [
+        "auth",
+        "nuxt",
+        "nuxt3",
+        "nuxtjs",
+        "nuxt-module",
+        "nuxt-plugin",
+        "@nuxtjs/auth",
+        "@nuxt-alt/auth"
+    ],
+    "license": "MIT",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/types/index.d.ts",
+            "import": "./dist/module.mjs",
+            "require": "./dist/module.cjs"
+        }
+    },
+    "main": "./dist/module.cjs",
+    "module": "./dist/module.mjs",
+    "types": "./dist/types/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "dev": "nuxi dev playground",
+        "dev:build": "nuxi build playground"
+    },
+    "dependencies": {
+        "@nuxt-alt/http": "latest",
+        "@nuxt/kit": "^3.12.2",
+        "@refactorjs/serialize": "latest",
+        "cookie-es": "^1.1.0",
+        "defu": "^6.1.3",
+        "jwt-decode": "^4.0.0",
+        "ohash": "^1.1.3",
+        "pathe": "^1.1.2",
+        "pinia": "^2.1.7",
+        "requrl": "^3.0.2"
+    },
+    "devDependencies": {
+        "@nuxt-alt/proxy": "^2.5.8",
+        "@nuxt/schema": "^3.12.2",
+        "@nuxtjs/i18n": "next",
+        "@types/node": "^20",
+        "jiti": "^1.21.6",
+        "nuxt": "^3.9.3",
+        "typescript": "5.3.3",
+        "unbuild": "^2.0.0"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/zerosdev/nuxt-auther.git",
+        "directory": "nuxt-auther"
+    },
+    "bugs": {
+        "url": "https://github.com/zerosdev/nuxt-auther/issues"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "packageManager": "yarn@4.9.2"
+}