@maximemrf/adonisjs-jwt 0.0.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright (c) 2023
+
+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,115 @@
+# AdonisJS package starter kit
+
+> A boilerplate for creating AdonisJS packages
+
+This repo provides you with a starting point for creating AdonisJS packages. Of course, you can create a package from scratch with your folder structure and workflow. However, using this starter kit can speed up the process, as you have fewer decisions to make.
+
+## Setup
+
+- Clone the repo on your computer, or use `giget` to download this repo without the Git history.
+  ```sh
+  npx giget@latest gh:adonisjs/pkg-starter-kit
+  ```
+- Install dependencies.
+- Update the `package.json` file and define the `name`, `description`, `keywords`, and `author` properties.
+- The repo is configured with an MIT license. Feel free to change that if you are not publishing under the MIT license.
+
+## Folder structure
+
+The starter kit mimics the folder structure of the official packages. Feel free to rename files and folders as per your requirements.
+
+```
+├── providers
+├── src
+├── bin
+├── stubs
+├── configure.ts
+├── index.ts
+├── LICENSE.md
+├── package.json
+├── README.md
+├── tsconfig.json
+├── tsnode.esm.js
+```
+
+- The `configure.ts` file exports the `configure` hook to configure the package using the `node ace configure` command.
+- The `index.ts` file is the main entry point of the package.
+- The `tsnode.esm.js` file runs TypeScript code using TS-Node + SWC. Please read the code comment in this file to learn more.
+- The `bin` directory contains the entry point file to run Japa tests.
+- Learn more about [the `providers` directory](./providers/README.md).
+- Learn more about [the `src` directory](./src/README.md).
+- Learn more about [the `stubs` directory](./stubs/README.md).
+
+### File system naming convention
+
+We use `snake_case` naming conventions for the file system. The rule is enforced using ESLint. However, turn off the rule and use your preferred naming conventions.
+
+## Peer dependencies
+
+The starter kit has a peer dependency on `@adonisjs/core@6`. Since you are creating a package for AdonisJS, you must make it against a specific version of the framework core.
+
+If your package needs Lucid to be functional, you may install `@adonisjs/lucid` as a development dependency and add it to the list of `peerDependencies`.
+
+As a rule of thumb, packages installed in the user application should be part of the `peerDependencies` of your package and not the main dependency.
+
+For example, if you install `@adonisjs/core` as a main dependency, then essentially, you are importing a separate copy of `@adonisjs/core` and not sharing the one from the user application. Here is a great article explaining [peer dependencies](https://blog.bitsrc.io/understanding-peer-dependencies-in-javascript-dbdb4ab5a7be).
+
+## Published files
+
+Instead of publishing your repo's source code to npm, you must cherry-pick files and folders to publish only the required files.
+
+The cherry-picking uses the `files` property inside the `package.json` file. By default, we publish the following files and folders.
+
+```json
+{
+  "files": ["build/src", "build/providers", "build/stubs", "build/index.d.ts", "build/index.js"]
+}
+```
+
+If you create additional folders or files, mention them inside the `files` array.
+
+## Exports
+
+[Node.js Subpath exports](https://nodejs.org/api/packages.html#subpath-exports) allows you to define the exports of your package regardless of the folder structure. This starter kit defines the following exports.
+
+```json
+{
+  "exports": {
+    ".": "./build/index.js",
+    "./types": "./build/src/types.js"
+  }
+}
+```
+
+- The dot `.` export is the main export.
+- The `./types` exports all the types defined inside the `./build/src/types.js` file (the compiled output).
+
+Feel free to change the exports as per your requirements.
+
+## Testing
+
+We configure the [Japa test runner](https://japa.dev/) with this starter kit. Japa is used in AdonisJS applications as well. Just run one of the following commands to execute tests.
+
+- `npm run test`: This command will first lint the code using ESlint and then run tests and report the test coverage using [c8](https://github.com/bcoe/c8).
+- `npm run quick:test`: Runs only the tests without linting or coverage reporting.
+
+The starter kit also has a Github workflow file to run tests using Github Actions. The tests are executed against `Node.js 20.x` and `Node.js 21.x` versions on both Linux and Windows. Feel free to edit the workflow file in the `.github/workflows` directory.
+
+## TypeScript workflow
+
+- The starter kit uses [tsc](https://www.typescriptlang.org/docs/handbook/compiler-options.html) for compiling the TypeScript to JavaScript when publishing the package.
+- [TS-Node](https://typestrong.org/ts-node/) and [SWC](https://swc.rs/) are used to run tests without compiling the source code.
+- The `tsconfig.json` file is extended from [`@adonisjs/tsconfig`](https://github.com/adonisjs/tooling-config/tree/main/packages/typescript-config) and uses the `NodeNext` module system. Meaning the packages are written using ES modules.
+- You can perform type checking without compiling the source code using the `npm run type check` script.
+
+Feel free to explore the `tsconfig.json` file for all the configured options.
+
+## ESLint and Prettier setup
+
+The starter kit configures ESLint and Prettier. Both configurations are stored within the `package.json` file and use our [shared config](https://github.com/adonisjs/tooling-config/tree/main/packages). Feel free to change the configuration, use custom plugins, or remove both tools altogether.
+
+## Using Stale bot
+
+The [Stale bot](https://github.com/apps/stale) is a Github application that automatically marks issues and PRs as stale and closes after a specific duration of inactivity.
+
+Feel free to delete the `.github/stale.yml` and `.github/lock.yml` files if you decide not to use the Stale bot.

package/build/index.d.ts

@@ -0,0 +1 @@
+export { configure } from './configure.js';

package/build/index.js

@@ -0,0 +1,9 @@
+/*
+|--------------------------------------------------------------------------
+| Package entrypoint
+|--------------------------------------------------------------------------
+|
+| Export values from the package entrypoint as you see fit.
+|
+*/
+export { configure } from './configure.js';

package/build/providers/jwt.d.ts

@@ -0,0 +1,12 @@
+import type { ApplicationService } from '@adonisjs/core/types';
+import { jwtGuard } from '../src/define_config.js';
+export default class JwtProvider {
+    protected app: ApplicationService;
+    constructor(app: ApplicationService);
+    register(): void;
+}
+declare module '@adonisjs/core/types' {
+    interface ContainerBindings {
+        'max/jwt': typeof jwtGuard;
+    }
+}

package/build/providers/jwt.js

@@ -0,0 +1,12 @@
+import { jwtGuard } from '../src/define_config.js';
+export default class JwtProvider {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    register() {
+        this.app.container.singleton('max/jwt', async () => {
+            return jwtGuard;
+        });
+    }
+}

package/build/src/define_config.d.ts

@@ -0,0 +1,7 @@
+import { GuardConfigProvider } from '@adonisjs/auth/types';
+import type { HttpContext } from '@adonisjs/core/http';
+import { JwtGuard, JwtUserProviderContract } from './jwt.js';
+export declare function jwtGuard<UserProvider extends JwtUserProviderContract<unknown>>(config: {
+    provider: UserProvider;
+    tokenExpiresIn: number | string;
+}): GuardConfigProvider<(ctx: HttpContext) => JwtGuard<UserProvider>>;

package/build/src/define_config.js

@@ -0,0 +1,10 @@
+import { JwtGuard } from './jwt.js';
+export function jwtGuard(config) {
+    return {
+        async resolver(_, app) {
+            const appKey = app.config.get('app.appKey').release();
+            const options = { secret: appKey, expiresIn: config.tokenExpiresIn };
+            return (ctx) => new JwtGuard(ctx, config.provider, options);
+        },
+    };
+}

package/build/src/jwt.d.ts

@@ -0,0 +1,95 @@
+import { symbols } from '@adonisjs/auth';
+import { AuthClientResponse, GuardContract } from '@adonisjs/auth/types';
+import type { HttpContext } from '@adonisjs/core/http';
+/**
+ * The bridge between the User provider and the
+ * Guard
+ */
+export type JwtGuardUser<RealUser> = {
+    /**
+     * Returns the unique ID of the user
+     */
+    getId(): string | number | BigInt;
+    /**
+     * Returns the original user object
+     */
+    getOriginal(): RealUser;
+};
+/**
+ * The interface for the UserProvider accepted by the
+ * JWT guard.
+ */
+export interface JwtUserProviderContract<RealUser> {
+    /**
+     * A property the guard implementation can use to infer
+     * the data type of the actual user (aka RealUser)
+     */
+    [symbols.PROVIDER_REAL_USER]: RealUser;
+    /**
+     * Create a user object that acts as an adapter between
+     * the guard and real user value.
+     */
+    createUserForGuard(user: RealUser): Promise<JwtGuardUser<RealUser>>;
+    /**
+     * Find a user by their id.
+     */
+    findById(identifier: string | number | BigInt): Promise<JwtGuardUser<RealUser> | null>;
+}
+export type JwtGuardOptions = {
+    secret: string;
+    expiresIn?: number | string;
+};
+export declare class JwtGuard<UserProvider extends JwtUserProviderContract<unknown>> implements GuardContract<UserProvider[typeof symbols.PROVIDER_REAL_USER]> {
+    #private;
+    constructor(ctx: HttpContext, userProvider: UserProvider, option: JwtGuardOptions);
+    /**
+     * A list of events and their types emitted by
+     * the guard.
+     */
+    [symbols.GUARD_KNOWN_EVENTS]: {};
+    /**
+     * A unique name for the guard driver
+     */
+    driverName: 'jwt';
+    /**
+     * A flag to know if the authentication was an attempt
+     * during the current HTTP request
+     */
+    authenticationAttempted: boolean;
+    /**
+     * A boolean to know if the current request has
+     * been authenticated
+     */
+    isAuthenticated: boolean;
+    /**
+     * Reference to the currently authenticated user
+     */
+    user?: UserProvider[typeof symbols.PROVIDER_REAL_USER];
+    /**
+     * Generate a JWT token for a given user.
+     */
+    generate(user: UserProvider[typeof symbols.PROVIDER_REAL_USER]): Promise<{
+        type: string;
+        token: string;
+        expiresIn: string | number | undefined;
+    }>;
+    /**
+     * Authenticate the current HTTP request and return
+     * the user instance if there is a valid JWT token
+     * or throw an exception
+     */
+    authenticate(): Promise<UserProvider[typeof symbols.PROVIDER_REAL_USER]>;
+    /**
+     * Same as authenticate, but does not throw an exception
+     */
+    check(): Promise<boolean>;
+    /**
+     * Returns the authenticated user or throws an error
+     */
+    getUserOrFail(): UserProvider[typeof symbols.PROVIDER_REAL_USER];
+    /**
+     * This method is called by Japa during testing when "loginAs"
+     * method is used to login the user.
+     */
+    authenticateAsClient(user: UserProvider[typeof symbols.PROVIDER_REAL_USER]): Promise<AuthClientResponse>;
+}

package/build/src/jwt.js

@@ -0,0 +1,132 @@
+import { symbols, errors } from '@adonisjs/auth';
+import jwt from 'jsonwebtoken';
+export class JwtGuard {
+    #ctx;
+    #userProvider;
+    #options;
+    constructor(ctx, userProvider, option) {
+        this.#ctx = ctx;
+        this.#userProvider = userProvider;
+        this.#options = option;
+    }
+    /**
+     * A unique name for the guard driver
+     */
+    driverName = 'jwt';
+    /**
+     * A flag to know if the authentication was an attempt
+     * during the current HTTP request
+     */
+    authenticationAttempted = false;
+    /**
+     * A boolean to know if the current request has
+     * been authenticated
+     */
+    isAuthenticated = false;
+    /**
+     * Reference to the currently authenticated user
+     */
+    user;
+    /**
+     * Generate a JWT token for a given user.
+     */
+    async generate(user) {
+        const providerUser = await this.#userProvider.createUserForGuard(user);
+        const token = jwt.sign({ userId: providerUser.getId() }, this.#options.secret, {
+            expiresIn: this.#options.expiresIn,
+        });
+        return {
+            type: 'bearer',
+            token: token,
+            expiresIn: this.#options.expiresIn,
+        };
+    }
+    /**
+     * Authenticate the current HTTP request and return
+     * the user instance if there is a valid JWT token
+     * or throw an exception
+     */
+    async authenticate() {
+        /**
+         * Avoid re-authentication when it has been done already
+         * for the given request
+         */
+        if (this.authenticationAttempted) {
+            return this.getUserOrFail();
+        }
+        this.authenticationAttempted = true;
+        /**
+         * Ensure the auth header exists
+         */
+        const authHeader = this.#ctx.request.header('authorization');
+        if (!authHeader) {
+            throw new errors.E_UNAUTHORIZED_ACCESS('Unauthorized access', {
+                guardDriverName: this.driverName,
+            });
+        }
+        /**
+         * Split the header value and read the token from it
+         */
+        const [, token] = authHeader.split('Bearer ');
+        if (!token) {
+            throw new errors.E_UNAUTHORIZED_ACCESS('Unauthorized access', {
+                guardDriverName: this.driverName,
+            });
+        }
+        /**
+         * Verify token
+         */
+        const payload = jwt.verify(token, this.#options.secret);
+        if (typeof payload !== 'object' || !('userId' in payload)) {
+            throw new errors.E_UNAUTHORIZED_ACCESS('Unauthorized access', {
+                guardDriverName: this.driverName,
+            });
+        }
+        /**
+         * Fetch the user by user ID and save a reference to it
+         */
+        const providerUser = await this.#userProvider.findById(payload.userId);
+        if (!providerUser) {
+            throw new errors.E_UNAUTHORIZED_ACCESS('Unauthorized access', {
+                guardDriverName: this.driverName,
+            });
+        }
+        this.user = providerUser.getOriginal();
+        return this.getUserOrFail();
+    }
+    /**
+     * Same as authenticate, but does not throw an exception
+     */
+    async check() {
+        try {
+            await this.authenticate();
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Returns the authenticated user or throws an error
+     */
+    getUserOrFail() {
+        if (!this.user) {
+            throw new errors.E_UNAUTHORIZED_ACCESS('Unauthorized access', {
+                guardDriverName: this.driverName,
+            });
+        }
+        return this.user;
+    }
+    /**
+     * This method is called by Japa during testing when "loginAs"
+     * method is used to login the user.
+     */
+    async authenticateAsClient(user) {
+        const token = await this.generate(user);
+        return {
+            headers: {
+                authorization: `Bearer ${token.token}`,
+            },
+        };
+    }
+}

package/build/stubs/main.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export declare const stubsRoot: string;

package/build/stubs/main.js

@@ -0,0 +1,7 @@
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+/**
+ * Path to the root directory where the stubs are stored. We use
+ * this path within commands and the configure hook
+ */
+export const stubsRoot = dirname(fileURLToPath(import.meta.url));

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@maximemrf/adonisjs-jwt",
+  "description": "",
+  "version": "0.0.1",
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "type": "module",
+  "files": [
+    "build/src",
+    "build/providers",
+    "build/stubs",
+    "build/index.d.ts",
+    "build/index.js"
+  ],
+  "exports": {
+    ".": "./build/index.js",
+    "./types": "./build/src/types.js"
+  },
+  "scripts": {
+    "clean": "del-cli build",
+    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint . --ext=.ts",
+    "format": "prettier --write .",
+    "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts",
+    "pretest": "npm run lint",
+    "test": "c8 npm run quick:test",
+    "prebuild": "npm run lint && npm run clean",
+    "build": "tsc",
+    "postbuild": "npm run copy:templates",
+    "release": "np",
+    "version": "npm run build",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@adonisjs/assembler": "^7.2.3",
+    "@adonisjs/auth": "^9.1.1",
+    "@adonisjs/core": "^6.3.1",
+    "@adonisjs/eslint-config": "^1.3.0",
+    "@adonisjs/lucid": "^20.4.0",
+    "@adonisjs/prettier-config": "^1.3.0",
+    "@adonisjs/tsconfig": "^1.3.0",
+    "@japa/assert": "^2.1.0",
+    "@japa/runner": "^3.1.1",
+    "@swc/core": "^1.4.6",
+    "@types/node": "^20.11.25",
+    "c8": "^9.1.0",
+    "copyfiles": "^2.4.1",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.57.0",
+    "np": "^10.0.0",
+    "prettier": "^3.2.5",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.2"
+  },
+  "peerDependencies": {
+    "@adonisjs/core": "^6.2.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "np": {
+    "message": "chore(release): %s",
+    "tag": "latest",
+    "branch": "main",
+    "anyBranch": false
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  },
+  "eslintConfig": {
+    "extends": "@adonisjs/eslint-config/package"
+  },
+  "prettier": "@adonisjs/prettier-config",
+  "dependencies": {
+    "@types/jsonwebtoken": "^9.0.6",
+    "jsonwebtoken": "^9.0.2"
+  }
+}