@eienjs/adonisjs-simple-auth 1.0.1 → 2.0.0

package/{LICENSE.md → LICENSE}

@@ -1,6 +1,6 @@
 # The MIT License
 
-Copyright (c) 2025 - EienJS
+Copyright (c) 2025 - 2026 | EienJS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -7,15 +7,38 @@
 [![Build Status][badge-build]][build]
 [![Total Downloads][badge-downloads]][downloads]
 
-<!-- [![Build Status][badge-build]][build] -->
-
-> Single authentication key that allows authenticate
+> Single authentication key that allows authenticate on your adonisjs v7 application
 
 ## Introduction
 
 This package enables you to create a single authentication key that allows you to authenticate just by including the key.
 This simplicity also allows a user to make calls easily, with cURL, with interactive docs, or even in their browser.
 
+## Quick Start
+
+Install the package from npm using the following command:
+
+```sh
+node ace add @eienjs/adonisjs-simple-auth
+```
+
+Automatically the command will register the provider and the command. You will be able to use the package immediately. Now you need run the command to generate your api key
+
+```sh
+node ace generate:api-key
+```
+
+So, protect your routes with the following middleware
+
+```typescript
+import router from '@adonisjs/core/services/router';
+import { middleware } from '#start/kernel';
+
+/// ...other routes
+
+router.get('/', () => 'Hello World').use(middleware.apiKey());
+```
+
 ## Documentation
 
 The documentation is available on [EienJS](https://eienjs.com/packages/adonisjs-simple-auth/getting-started/).

package/build/_virtual/_@oxc-project_runtime@0.137.0/helpers/esm/decorate.js

@@ -0,0 +1,9 @@
+//#region \0@oxc-project+runtime@0.137.0/helpers/esm/decorate.js
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+//#endregion
+export { __decorate as default };

package/build/commands/generate_api_key.d.ts

@@ -1,8 +1,12 @@
-import { BaseCommand } from '@adonisjs/core/ace';
-export default class GenerateApiKey extends BaseCommand {
-    static readonly commandName = "generate:api-key";
-    static readonly description = "Generate a a cryptographically secure random value suffixed with a CRC32 checksum";
-    show: boolean;
-    force: boolean;
-    run(): Promise<void>;
+import { BaseCommand } from "@adonisjs/core/ace";
+
+//#region commands/generate_api_key.d.ts
+declare class GenerateApiKey extends BaseCommand {
+  static readonly commandName = "generate:api-key";
+  static readonly description = "Generate a a cryptographically secure random value suffixed with a CRC32 checksum";
+  show: boolean;
+  force: boolean;
+  run(): Promise<void>;
 }
+//#endregion
+export { GenerateApiKey as default };

package/build/commands/generate_api_key.js

@@ -1,353 +1,29 @@
-import {
-  __decorateClass
-} from "../chunk-EUXUH3YW.js";
-
-// commands/generate_api_key.ts
+import { CRC32 } from "../src/helpers/crc32.js";
+import __decorate from "../_virtual/_@oxc-project_runtime@0.137.0/helpers/esm/decorate.js";
+import { Secret, base64 } from "@adonisjs/core/helpers";
 import process from "node:process";
 import { BaseCommand, flags } from "@adonisjs/core/ace";
 import { EnvEditor } from "@adonisjs/core/env/editor";
-import { base64, Secret } from "@adonisjs/core/helpers";
 import string from "@adonisjs/core/helpers/string";
-
-// src/helpers/crc32.ts
-import { TextEncoder } from "node:util";
-var CRC32 = class {
-  /**
-   * Lookup table calculated for 0xEDB88320 divisor
-   */
-  lookupTable = [
-    0,
-    1996959894,
-    3993919788,
-    2567524794,
-    124634137,
-    1886057615,
-    3915621685,
-    2657392035,
-    249268274,
-    2044508324,
-    3772115230,
-    2547177864,
-    162941995,
-    2125561021,
-    3887607047,
-    2428444049,
-    498536548,
-    1789927666,
-    4089016648,
-    2227061214,
-    450548861,
-    1843258603,
-    4107580753,
-    2211677639,
-    325883990,
-    1684777152,
-    4251122042,
-    2321926636,
-    335633487,
-    1661365465,
-    4195302755,
-    2366115317,
-    997073096,
-    1281953886,
-    3579855332,
-    2724688242,
-    1006888145,
-    1258607687,
-    3524101629,
-    2768942443,
-    901097722,
-    1119000684,
-    3686517206,
-    2898065728,
-    853044451,
-    1172266101,
-    3705015759,
-    2882616665,
-    651767980,
-    1373503546,
-    3369554304,
-    3218104598,
-    565507253,
-    1454621731,
-    3485111705,
-    3099436303,
-    671266974,
-    1594198024,
-    3322730930,
-    2970347812,
-    795835527,
-    1483230225,
-    3244367275,
-    3060149565,
-    1994146192,
-    31158534,
-    2563907772,
-    4023717930,
-    1907459465,
-    112637215,
-    2680153253,
-    3904427059,
-    2013776290,
-    251722036,
-    2517215374,
-    3775830040,
-    2137656763,
-    141376813,
-    2439277719,
-    3865271297,
-    1802195444,
-    476864866,
-    2238001368,
-    4066508878,
-    1812370925,
-    453092731,
-    2181625025,
-    4111451223,
-    1706088902,
-    314042704,
-    2344532202,
-    4240017532,
-    1658658271,
-    366619977,
-    2362670323,
-    4224994405,
-    1303535960,
-    984961486,
-    2747007092,
-    3569037538,
-    1256170817,
-    1037604311,
-    2765210733,
-    3554079995,
-    1131014506,
-    879679996,
-    2909243462,
-    3663771856,
-    1141124467,
-    855842277,
-    2852801631,
-    3708648649,
-    1342533948,
-    654459306,
-    3188396048,
-    3373015174,
-    1466479909,
-    544179635,
-    3110523913,
-    3462522015,
-    1591671054,
-    702138776,
-    2966460450,
-    3352799412,
-    1504918807,
-    783551873,
-    3082640443,
-    3233442989,
-    3988292384,
-    2596254646,
-    62317068,
-    1957810842,
-    3939845945,
-    2647816111,
-    81470997,
-    1943803523,
-    3814918930,
-    2489596804,
-    225274430,
-    2053790376,
-    3826175755,
-    2466906013,
-    167816743,
-    2097651377,
-    4027552580,
-    2265490386,
-    503444072,
-    1762050814,
-    4150417245,
-    2154129355,
-    426522225,
-    1852507879,
-    4275313526,
-    2312317920,
-    282753626,
-    1742555852,
-    4189708143,
-    2394877945,
-    397917763,
-    1622183637,
-    3604390888,
-    2714866558,
-    953729732,
-    1340076626,
-    3518719985,
-    2797360999,
-    1068828381,
-    1219638859,
-    3624741850,
-    2936675148,
-    906185462,
-    1090812512,
-    3747672003,
-    2825379669,
-    829329135,
-    1181335161,
-    3412177804,
-    3160834842,
-    628085408,
-    1382605366,
-    3423369109,
-    3138078467,
-    570562233,
-    1426400815,
-    3317316542,
-    2998733608,
-    733239954,
-    1555261956,
-    3268935591,
-    3050360625,
-    752459403,
-    1541320221,
-    2607071920,
-    3965973030,
-    1969922972,
-    40735498,
-    2617837225,
-    3943577151,
-    1913087877,
-    83908371,
-    2512341634,
-    3803740692,
-    2075208622,
-    213261112,
-    2463272603,
-    3855990285,
-    2094854071,
-    198958881,
-    2262029012,
-    4057260610,
-    1759359992,
-    534414190,
-    2176718541,
-    4139329115,
-    1873836001,
-    414664567,
-    2282248934,
-    4279200368,
-    1711684554,
-    285281116,
-    2405801727,
-    4167216745,
-    1634467795,
-    376229701,
-    2685067896,
-    3608007406,
-    1308918612,
-    956543938,
-    2808555105,
-    3495958263,
-    1231636301,
-    1047427035,
-    2932959818,
-    3654703836,
-    1088359270,
-    936918e3,
-    2847714899,
-    3736837829,
-    1202900863,
-    817233897,
-    3183342108,
-    3401237130,
-    1404277552,
-    615818150,
-    3134207493,
-    3453421203,
-    1423857449,
-    601450431,
-    3009837614,
-    3294710456,
-    1567103746,
-    711928724,
-    3020668471,
-    3272380065,
-    1510334235,
-    755167117
-  ];
-  initialCRC = 4294967295;
-  calculateBytes(bytes, accumulator) {
-    let crc = accumulator ?? this.initialCRC;
-    for (const byte of bytes) {
-      const tableIndex = (crc ^ byte) & 255;
-      const tableVal = this.lookupTable[tableIndex];
-      crc = crc >>> 8 ^ tableVal;
-    }
-    return crc;
-  }
-  crcToUint(crc) {
-    return this.toUint32(crc ^ 4294967295);
-  }
-  strToBytes(input) {
-    const encoder = new TextEncoder();
-    return encoder.encode(input);
-  }
-  toUint32(num) {
-    if (num >= 0) {
-      return num;
-    }
-    return 4294967295 - num * -1 + 1;
-  }
-  calculate(input) {
-    return this.forString(input);
-  }
-  forString(input) {
-    const bytes = this.strToBytes(input);
-    return this.forBytes(bytes);
-  }
-  forBytes(bytes, accumulator) {
-    const crc = this.calculateBytes(bytes, accumulator);
-    return this.crcToUint(crc);
-  }
-};
-
-// commands/generate_api_key.ts
+//#region commands/generate_api_key.ts
 var GenerateApiKey = class extends BaseCommand {
-  static commandName = "generate:api-key";
-  static description = "Generate a a cryptographically secure random value suffixed with a CRC32 checksum";
-  async run() {
-    let writeToFile = process.env.NODE_ENV !== "production";
-    if (this.force) {
-      writeToFile = true;
-    }
-    if (this.show) {
-      writeToFile = false;
-    }
-    const seed = string.random(40);
-    const tokenSecret = new Secret(`${seed}${new CRC32().calculate(seed)}`);
-    const result = new Secret(
-      `oat_${base64.urlEncode(String(string.random(2)))}.${base64.urlEncode(tokenSecret.release())}`
-    );
-    const tokenString = result.release();
-    if (writeToFile) {
-      const editor = await EnvEditor.create(this.app.appRoot);
-      editor.add("API_KEY", tokenString, true);
-      await editor.save();
-      this.logger.action("add API_KEY to .env").succeeded();
-    } else {
-      this.logger.log(`API_KEY = ${tokenString}`);
-    }
-  }
-};
-__decorateClass([
-  flags.boolean({
-    description: "Display the token on the terminal, instead of writing it to .env file"
-  })
-], GenerateApiKey.prototype, "show", 2);
-__decorateClass([
-  flags.boolean({
-    description: "Force update .env file in production environment"
-  })
-], GenerateApiKey.prototype, "force", 2);
-export {
-  GenerateApiKey as default
+	static commandName = "generate:api-key";
+	static description = "Generate a a cryptographically secure random value suffixed with a CRC32 checksum";
+	async run() {
+		let shouldWriteToFile = this.force ? true : process.env.NODE_ENV !== "production";
+		if (this.show) shouldWriteToFile = false;
+		const seed = string.random(40);
+		const tokenSecret = new Secret(`${seed}${new CRC32().calculate(seed)}`);
+		const tokenString = new Secret(`oat_${base64.urlEncode(string.random(2))}.${base64.urlEncode(tokenSecret.release())}`).release();
+		if (shouldWriteToFile) {
+			const editor = await EnvEditor.create(this.app.appRoot);
+			editor.add("API_KEY", tokenString, true);
+			await editor.save();
+			this.logger.action("add API_KEY to .env").succeeded();
+		} else this.logger.log(`API_KEY = ${tokenString}`);
+	}
 };
-//# sourceMappingURL=generate_api_key.js.map
+__decorate([flags.boolean({ description: "Display the token on the terminal, instead of writing it to .env file" })], GenerateApiKey.prototype, "show", void 0);
+__decorate([flags.boolean({ description: "Force update .env file in production environment" })], GenerateApiKey.prototype, "force", void 0);
+//#endregion
+export { GenerateApiKey as default };

package/build/configure.d.ts

@@ -1,2 +1,6 @@
-import type Configure from '@adonisjs/core/commands/configure';
-export declare const configure: (command: Configure) => Promise<void>;
+import Configure from "@adonisjs/core/commands/configure";
+
+//#region configure.d.ts
+declare const configure: (command: Configure) => Promise<void>;
+//#endregion
+export { configure };

package/build/configure.js

@@ -0,0 +1,18 @@
+import { stubsRoot } from "./stubs/main.js";
+//#region configure.ts
+const configure = async (command) => {
+	const codemods = await command.createCodemods();
+	await codemods.updateRcFile((rcFile) => {
+		rcFile.addCommand("@eienjs/adonisjs-simple-auth/commands");
+		rcFile.addProvider("@eienjs/adonisjs-simple-auth/providers/simple_auth_provider");
+	});
+	await codemods.makeUsingStub(stubsRoot, "config.stub", {});
+	await codemods.makeUsingStub(stubsRoot, "middleware/api_key.stub", { entity: command.app.generators.createEntity("api_key") });
+	await codemods.registerMiddleware("router", [{ path: "@eienjs/adonisjs-simple-auth/middleware/simple_auth_middleware" }]);
+	await codemods.registerMiddleware("named", [{
+		name: "apiKey",
+		path: "#middleware/api_key_middleware"
+	}]);
+};
+//#endregion
+export { configure };

package/build/index.d.ts

@@ -1,5 +1,6 @@
-export { configure } from './configure.js';
-export { defineConfig } from './src/define_config.js';
-export { SimpleAuthException } from './src/errors.js';
-export { SimpleAuth } from './src/simple_auth.js';
-export { stubsRoot } from './stubs/main.js';
+import { configure } from "./configure.js";
+import { defineConfig } from "./src/define_config.js";
+import { SimpleAuthException } from "./src/errors.js";
+import { SimpleAuth } from "./src/simple_auth.js";
+import { stubsRoot } from "./stubs/main.js";
+export { SimpleAuth, SimpleAuthException, configure, defineConfig, stubsRoot };

package/build/index.js

@@ -1,49 +1,6 @@
-import {
-  SimpleAuth,
-  SimpleAuthException
-} from "./chunk-JUF7K25A.js";
-import "./chunk-EUXUH3YW.js";
-
-// stubs/main.ts
-import { getDirname } from "@adonisjs/core/helpers";
-var stubsRoot = getDirname(import.meta.url);
-
-// configure.ts
-var configure = async (command) => {
-  const codemods = await command.createCodemods();
-  await codemods.updateRcFile((rcFile) => {
-    rcFile.addCommand("@eienjs/adonisjs-simple-auth/commands");
-    rcFile.addProvider("@eienjs/adonisjs-simple-auth/simple_auth_provider");
-  });
-  await codemods.makeUsingStub(stubsRoot, "config.stub", {});
-  await codemods.makeUsingStub(stubsRoot, "middleware/api_key.stub", {
-    entity: command.app.generators.createEntity("api_key")
-  });
-  await codemods.registerMiddleware("router", [{ path: "@eienjs/adonisjs-simple-auth/simple_auth_middleware" }]);
-  await codemods.registerMiddleware("named", [
-    {
-      name: "apiKey",
-      path: "#middleware/api_key_middleware"
-    }
-  ]);
-};
-
-// src/define_config.ts
-import { configProvider } from "@adonisjs/core";
-import { Secret } from "@adonisjs/core/helpers";
-var defineConfig = (config) => {
-  return configProvider.create(async (_) => {
-    return {
-      apiKeyHeader: config.apiKeyHeader ?? "x-api-key",
-      apiKeyValue: new Secret(config.apiKeyValue)
-    };
-  });
-};
-export {
-  SimpleAuth,
-  SimpleAuthException,
-  configure,
-  defineConfig,
-  stubsRoot
-};
-//# sourceMappingURL=index.js.map
+import { stubsRoot } from "./stubs/main.js";
+import { configure } from "./configure.js";
+import { defineConfig } from "./src/define_config.js";
+import { SimpleAuthException } from "./src/errors.js";
+import { SimpleAuth } from "./src/simple_auth.js";
+export { SimpleAuth, SimpleAuthException, configure, defineConfig, stubsRoot };

package/build/middleware/simple_auth_middleware.d.ts

@@ -0,0 +1,12 @@
+import { ResolvedSimpleAuthConfig } from "../types.js";
+import { HttpContext } from "@adonisjs/core/http";
+import { NextFn } from "@adonisjs/core/types/http";
+
+//#region src/middleware/simple_auth_middleware.d.ts
+declare class SimpleAuthMiddleware {
+  protected config: ResolvedSimpleAuthConfig;
+  constructor(config: ResolvedSimpleAuthConfig);
+  handle(ctx: HttpContext, next: NextFn): Promise<unknown>;
+}
+//#endregion
+export { SimpleAuthMiddleware as default };

package/build/middleware/simple_auth_middleware.js

@@ -0,0 +1,14 @@
+import { SimpleAuth } from "../src/simple_auth.js";
+//#region src/middleware/simple_auth_middleware.ts
+var SimpleAuthMiddleware = class {
+	config;
+	constructor(config) {
+		this.config = config;
+	}
+	async handle(ctx, next) {
+		ctx.simpleAuth = new SimpleAuth(ctx, this.config);
+		return next();
+	}
+};
+//#endregion
+export { SimpleAuthMiddleware as default };

package/build/plugins/api_client.d.ts

@@ -0,0 +1,14 @@
+import { ApplicationService } from "@adonisjs/core/types";
+import { PluginFn } from "@japa/runner/types";
+
+//#region src/plugins/japa/api_client.d.ts
+declare const API_KEY_ENABLED: unique symbol;
+declare module '@japa/api-client' {
+  interface ApiRequest {
+    [API_KEY_ENABLED]: boolean;
+    withApiKey: () => this;
+  }
+}
+declare const simpleAuthApiClient: (app: ApplicationService) => PluginFn;
+//#endregion
+export { simpleAuthApiClient };

package/build/plugins/api_client.js

@@ -0,0 +1,23 @@
+import { configProvider } from "@adonisjs/core";
+import { RuntimeException } from "@adonisjs/core/exceptions";
+import { ApiClient, ApiRequest } from "@japa/api-client";
+//#region src/plugins/japa/api_client.ts
+const API_KEY_ENABLED = Symbol.for("API_KEY_ENABLED");
+const simpleAuthApiClient = (app) => {
+	const pluginFn = async function() {
+		const simpleAuthConfigProvider = app.config.get("simpleauth");
+		const config = await configProvider.resolve(app, simpleAuthConfigProvider);
+		if (!config) throw new RuntimeException("Invalid \"config/simpleauth.ts\" file. Make sure you are using the \"defineConfig\" method");
+		ApiRequest.macro("withApiKey", function() {
+			this[API_KEY_ENABLED] = true;
+			return this;
+		});
+		ApiClient.setup(async (request) => {
+			if (!request[API_KEY_ENABLED]) return;
+			request.header(config.apiKeyHeader, config.apiKeyValue.release());
+		});
+	};
+	return pluginFn;
+};
+//#endregion
+export { simpleAuthApiClient };

package/build/providers/simple_auth_provider.d.ts

@@ -1,15 +1,19 @@
-import { type ApplicationService } from '@adonisjs/core/types';
-import { type SimpleAuth } from '../src/simple_auth.js';
+import { SimpleAuth } from "../src/simple_auth.js";
+import { ApplicationService } from "@adonisjs/core/types";
+
+//#region providers/simple_auth_provider.d.ts
 /**
  * HttpContext augmentations
  */
 declare module '@adonisjs/core/http' {
-    interface HttpContext {
-        simpleAuth: SimpleAuth;
-    }
+  interface HttpContext {
+    simpleAuth: SimpleAuth;
+  }
 }
-export default class SimpleAuthProvider {
-    protected app: ApplicationService;
-    constructor(app: ApplicationService);
-    register(): void;
+declare class SimpleAuthProvider {
+  protected app: ApplicationService;
+  constructor(app: ApplicationService);
+  register(): void;
 }
+//#endregion
+export { SimpleAuthProvider as default };