@adonisjs/auth 8.2.2 → 9.0.0-0

package/build/src/guards/session/token_providers/main.d.ts

@@ -0,0 +1,33 @@
+import { RememberMeToken } from '../token.js';
+import type { RememberMeProviderContract } from '../types.js';
+import { DatabaseTokenProvider } from '../../../core/token_providers/database.js';
+/**
+ * Remember me token provider to persist tokens inside the database
+ * using db query builder.
+ */
+export declare class DatabaseRememberTokenProvider extends DatabaseTokenProvider<RememberMeToken> implements RememberMeProviderContract {
+    /**
+     * Prepares a token from the database result
+     */
+    protected prepareToken(dbRow: {
+        series: string;
+        user_id: string | number;
+        type: string;
+        token: string;
+        created_at: Date;
+        updated_at: Date;
+        expires_at: Date | null;
+    }): RememberMeToken;
+    /**
+     * Converts the remember me token into a database row
+     */
+    protected parseToken(token: RememberMeToken): {
+        series: string;
+        user_id: string | number;
+        type: string;
+        token: string;
+        created_at: Date;
+        updated_at: Date;
+        expires_at: Date | null;
+    };
+}

package/build/src/guards/session/token_providers/main.js

@@ -0,0 +1,42 @@
+/*
+ * @adonisjs/auth
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { RememberMeToken } from '../token.js';
+import { DatabaseTokenProvider } from '../../../core/token_providers/database.js';
+/**
+ * Remember me token provider to persist tokens inside the database
+ * using db query builder.
+ */
+export class DatabaseRememberTokenProvider extends DatabaseTokenProvider {
+    /**
+     * Prepares a token from the database result
+     */
+    prepareToken(dbRow) {
+        const token = new RememberMeToken(dbRow.user_id, dbRow.series, undefined, dbRow.token);
+        if (dbRow.expires_at) {
+            token.expiresAt = dbRow.expires_at;
+        }
+        token.createdAt = dbRow.created_at;
+        token.updatedAt = dbRow.updated_at;
+        return token;
+    }
+    /**
+     * Converts the remember me token into a database row
+     */
+    parseToken(token) {
+        return {
+            series: token.series,
+            user_id: token.userId,
+            type: token.type,
+            token: token.hash,
+            created_at: token.createdAt,
+            updated_at: token.updatedAt,
+            expires_at: token.expiresAt,
+        };
+    }
+}

package/build/src/guards/session/types.d.ts

@@ -0,0 +1,97 @@
+import { Exception } from '@poppinss/utils';
+import type { RememberMeToken } from './token.js';
+import type { UserProviderContract, TokenProviderContract, DatabaseTokenProviderOptions } from '../../core/types.js';
+/**
+ * The SessionUserProvider is used to lookup a user for session based authentication.
+ */
+export interface SessionUserProviderContract<RealUser> extends UserProviderContract<RealUser> {
+}
+/**
+ * The RememberMeProviderContract is used to persist and lookup tokens for
+ * session based authentication with remember me option.
+ */
+export interface RememberMeProviderContract extends TokenProviderContract<RememberMeToken> {
+}
+/**
+ * Config accepted by the session guard
+ */
+export type SessionGuardConfig = {
+    /**
+     * The expiry for the remember me cookie.
+     *
+     * Defaults to "5 years"
+     */
+    rememberMeTokenAge?: string | number;
+};
+/**
+ * Events emitted by the session guard
+ */
+export type SessionGuardEvents<User> = {
+    /**
+     * The event is emitted when the user credentials
+     * have been verified successfully.
+     */
+    'session_auth:credentials_verified': {
+        uid: string;
+        user: User;
+        password: string;
+    };
+    /**
+     * The event is emitted when unable to login the
+     * user.
+     */
+    'session_auth:login_failed': {
+        error: Exception;
+        user: User | null;
+    };
+    /**
+     * The event is emitted when login is attempted for
+     * a given user.
+     */
+    'session_auth:login_attempted': {
+        user: User;
+    };
+    /**
+     * The event is emitted when user has been logged in
+     * successfully
+     */
+    'session_auth:login_succeeded': {
+        user: User;
+        sessionId: string;
+        rememberMeToken?: RememberMeToken;
+    };
+    /**
+     * Attempting to authenticate the user
+     */
+    'session_auth:authentication_attempted': {
+        sessionId: string;
+    };
+    /**
+     * Authentication was successful
+     */
+    'session_auth:authentication_succeeded': {
+        user: User;
+        sessionId: string;
+        rememberMeToken?: RememberMeToken;
+    };
+    /**
+     * Authentication failed
+     */
+    'session_auth:authentication_failed': {
+        error: Exception;
+        sessionId: string;
+    };
+    /**
+     * The event is emitted when user has been logged out
+     * sucessfully
+     */
+    'session_auth:logged_out': {
+        user: User;
+        sessionId: string;
+    };
+};
+/**
+ * Options accepted by the database implementation of the
+ * RememberMeProvider
+ */
+export type DatabaseRememberMeProviderOptions = DatabaseTokenProviderOptions;

package/build/{adonis-typings/events.js → src/guards/session/types.js}

@@ -1,8 +1,9 @@
 /*
  * @adonisjs/auth
  *
- * (c) Harminder Virk <virk@adonisjs.com>
+ * (c) AdonisJS
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
+export {};

package/build/stubs/config/auth_middleware.stub

@@ -0,0 +1,12 @@
+import { HttpContext } from '@adonisjs/core/http'
+import { NextFn } from '@adonisjs/core/http/types'
+
+type AuthMiddlewareOptions = {
+  guards?: (keyof Authenticators)[]
+}
+
+export default class AuthMiddleware {
+  async handle({ auth }: HttpContext, next: NextFn, options?: AuthMiddlewareOptions) {
+    return next()
+  }
+}

package/build/stubs/config.stub

@@ -0,0 +1,35 @@
+{{{
+  exports({ to: app.configPath('auth.ts') })
+}}}
+import { defineConfig, providers } from '@adonisjs/auth'
+{{#if provider === 'lucid'}}
+/**
+ * Using the "models/user" model to find users during
+ * login and authentication
+ */
+const userProvider = providers.lucid({
+  model: () => import('#models/user'),
+  uids: ['email'],
+})
+{{/if}}
+{{#if provider === 'db'}}
+/**
+ * Using Lucid query builder to directly query the database
+ * to find users during login and authentication.
+ */
+const userProvider = providers.db({
+  table: 'users',
+  passwordColumnName: 'password',
+  id: 'id',
+  uids: ['email']
+})
+{{/if}}
+
+const authConfig = defineConfig({
+  guards: {}
+})
+
+export default authConfig
+declare module '@adonisjs/auth/types' {
+  interface Authenticators extends InferAuthenticators<typeof authConfig> {}
+}

package/build/stubs/main.d.ts

@@ -0,0 +1 @@
+export declare const stubsRoot: string;

package/build/{adonis-typings/tests.js → stubs/main.js}

@@ -1,4 +1,3 @@
-"use strict";
 /*
  * @adonisjs/auth
  *
@@ -7,5 +6,5 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-require("@japa/api-client");
+import { getDirname } from '@poppinss/utils';
+export const stubsRoot = getDirname(import.meta.url);

package/package.json

@@ -1,39 +1,56 @@
 {
   "name": "@adonisjs/auth",
-  "version": "8.2.2",
+  "version": "9.0.0-0",
   "description": "Official authentication provider for Adonis framework",
-  "types": "build/adonis-typings/index.d.ts",
-  "main": "build/providers/AuthProvider.js",
+  "type": "module",
+  "main": "build/index.js",
   "files": [
-    "build/adonis-typings",
+    "build/configure.js",
+    "build/configure.d.ts",
+    "build/index.js",
+    "build/index.d.ts",
+    "build/factories",
     "build/providers",
-    "build/templates",
+    "build/services",
     "build/src",
-    "build/instructions.js",
-    "build/standalone.js",
-    "build/standalone.d.ts"
+    "build/stubs"
   ],
+  "engines": {
+    "node": ">=18.16.0"
+  },
+  "exports": {
+    ".": "./build/index.js",
+    "./types": "./build/src/types/main.js",
+    "./auth_provider": "./build/providers/auth_provider.js",
+    "./services/main": "./build/services/auth.js",
+    "./core/token": "./build/src/core/token.js",
+    "./core/guard_user": "./build/src/core/guard_user.js",
+    "./core/user_providers/*": "./build/src/core/user_providers/*.js",
+    "./core/token_providers/*": "./build/src/core/token_providers/*.js",
+    "./types/core": "./build/src/core/types.js",
+    "./session": "./build/src/guards/session/main.js",
+    "./types/session": "./build/src/guards/session/types.js"
+  },
   "scripts": {
-    "mrm": "mrm --preset=@adonisjs/mrm-preset",
     "pretest": "npm run lint",
-    "test": "node -r @adonisjs/require-ts/build/register ./bin/test.ts",
+    "test": "c8 npm run quick:test",
+    "quick:test": "cross-env NODE_DEBUG=\"adonisjs:auth\" node --enable-source-maps --loader=ts-node/esm ./bin/test.js",
     "clean": "del-cli build",
-    "copyfiles": "copyfiles \"templates/**/*.txt\" build",
-    "compile": "npm run lint && npm run clean && tsc",
-    "build": "npm run compile && npm run copyfiles",
-    "commit": "git-cz",
+    "copy:templates": "copyfiles \"stubs/**/**/*.stub\" build",
+    "compile": "npm run lint && npm run clean && tsc && npm run copy:templates",
+    "build": "npm run compile",
     "release": "np",
     "version": "npm run build",
-    "lint": "eslint . --ext=.ts",
     "prepublishOnly": "npm run build",
-    "sync-labels": "github-label-sync --labels ./node_modules/@adonisjs/mrm-preset/gh-labels.json adonisjs/auth",
+    "lint": "eslint . --ext=.ts",
+    "typecheck": "tsc --noEmit",
+    "sync-labels": "github-label-sync --labels .github/labels.json adonisjs/auth",
     "format": "prettier --write ."
   },
   "keywords": [
-    "adonis",
-    "adonis-framework",
-    "adonis-auth",
-    "authentication"
+    "adonisjs",
+    "authentication",
+    "auth"
   ],
   "author": "adonisjs,virk",
   "license": "MIT",
@@ -46,95 +63,83 @@
     "url": "https://github.com/adonisjs/auth/issues"
   },
   "devDependencies": {
-    "@adonisjs/core": "^5.8.2",
-    "@adonisjs/i18n": "^1.5.5",
-    "@adonisjs/lucid": "^18.0.0",
-    "@adonisjs/mrm-preset": "^5.0.3",
-    "@adonisjs/redis": "^7.3.0",
-    "@adonisjs/repl": "^3.1.10",
-    "@adonisjs/require-ts": "^2.0.11",
-    "@adonisjs/session": "^6.4.0",
-    "@adonisjs/sink": "^5.3.1",
-    "@japa/assert": "^1.3.4",
-    "@japa/preset-adonis": "^1.0.16",
-    "@japa/run-failed-tests": "^1.0.6",
-    "@japa/runner": "^2.0.8",
-    "@japa/spec-reporter": "^1.1.11",
-    "@poppinss/dev-utils": "^2.0.3",
-    "@types/node": "^17.0.35",
-    "@types/supertest": "^2.0.12",
+    "@adonisjs/assembler": "^6.1.3-25",
+    "@adonisjs/core": "^6.1.5-30",
+    "@adonisjs/eslint-config": "^1.1.8",
+    "@adonisjs/lucid": "^19.0.0-3",
+    "@adonisjs/prettier-config": "^1.1.8",
+    "@adonisjs/session": "^7.0.0-13",
+    "@adonisjs/tsconfig": "^1.1.8",
+    "@commitlint/cli": "^18.0.0",
+    "@commitlint/config-conventional": "^18.0.0",
+    "@japa/assert": "^2.0.0",
+    "@japa/expect-type": "^2.0.0",
+    "@japa/file-system": "^2.0.0",
+    "@japa/runner": "^3.0.4",
+    "@japa/snapshot": "^2.0.0",
+    "@swc/core": "1.3.82",
+    "@types/luxon": "^3.3.3",
+    "@types/node": "^20.8.7",
+    "@types/set-cookie-parser": "^2.4.5",
+    "c8": "^8.0.1",
     "copyfiles": "^2.4.1",
-    "del-cli": "^4.0.1",
-    "eslint": "^8.16.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-adonis": "^2.1.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "github-label-sync": "^2.2.0",
-    "husky": "^8.0.1",
-    "mrm": "^4.0.0",
-    "np": "^7.6.1",
-    "phc-bcrypt": "^1.0.7",
-    "pino-pretty": "^7.6.1",
-    "prettier": "^2.6.2",
-    "reflect-metadata": "^0.1.13",
-    "set-cookie-parser": "^2.4.8",
-    "sqlite3": "^5.0.8",
-    "supertest": "^6.2.3",
-    "ts-essentials": "^9.1.2",
-    "typescript": "^4.6.4"
+    "cross-env": "^7.0.3",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.52.0",
+    "github-label-sync": "^2.3.1",
+    "husky": "^8.0.3",
+    "luxon": "^3.4.3",
+    "np": "^8.0.4",
+    "prettier": "^3.0.3",
+    "set-cookie-parser": "^2.6.0",
+    "sqlite3": "^5.1.6",
+    "timekeeper": "^2.3.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.2.2"
   },
-  "nyc": {
-    "exclude": [
-      "test"
-    ],
-    "extension": [
-      ".ts"
+  "prettier": "@adonisjs/prettier-config",
+  "eslintConfig": {
+    "extends": "@adonisjs/eslint-config/package"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
     ]
   },
-  "config": {
-    "commitizen": {
-      "path": "cz-conventional-changelog"
-    }
+  "publishConfig": {
+    "access": "public",
+    "tag": "next"
   },
   "np": {
-    "contents": ".",
+    "message": "chore(release): %s",
+    "tag": "next",
+    "branch": "main",
     "anyBranch": false
   },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**",
+      "factories/**"
+    ]
+  },
   "dependencies": {
-    "@poppinss/hooks": "^5.0.3",
-    "@poppinss/utils": "^4.0.4",
-    "luxon": "^2.4.0"
+    "@poppinss/utils": "^6.5.0"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^5.7.1",
-    "@adonisjs/i18n": "^1.5.0",
-    "@adonisjs/lucid": "^18.0.0",
-    "@adonisjs/redis": "^7.2.0",
-    "@adonisjs/session": "^6.2.0"
+    "@adonisjs/core": "^6.1.5-30",
+    "@adonisjs/lucid": "^19.0.0-3",
+    "@adonisjs/session": "^7.0.0-13"
   },
   "peerDependenciesMeta": {
-    "@adonisjs/i18n": {
-      "optional": true
-    },
     "@adonisjs/lucid": {
       "optional": true
     },
     "@adonisjs/session": {
       "optional": true
-    },
-    "@adonisjs/redis": {
-      "optional": true
     }
-  },
-  "publishConfig": {
-    "access": "public",
-    "tag": "latest"
-  },
-  "adonisjs": {
-    "instructions": "./build/instructions.js",
-    "types": "@adonisjs/auth",
-    "providers": [
-      "@adonisjs/auth"
-    ]
   }
 }