@adonisjs/core 7.0.1 → 7.1.1

package/build/modules/ace/codemods.js

@@ -1,20 +1,66 @@
-import { t as debug_default } from "../../debug-CGQmxzGt.js";
-import stringHelpers from "../../src/helpers/string.js";
+import "../../chunk-Do49iUES.js";
+import { t as debug_default } from "../../debug-DWofTfIX.js";
+import { t as stringHelpers } from "../../string-8_8He-HH.js";
 import { EnvEditor } from "@adonisjs/env/editor";
 import { isAbsolute } from "node:path";
 import { readFile } from "node:fs/promises";
 import { EventEmitter } from "node:events";
+//#region modules/ace/codemods.ts
+/**
+* Codemods class for programmatically modifying AdonisJS source files.
+* This class provides APIs to modify configuration files, register middleware,
+* generate stubs, and install packages.
+*
+* The codemod APIs rely on the "@adonisjs/assembler" package, which must be
+* installed as a dependency in the user application.
+*
+* @example
+* ```ts
+* const codemods = new Codemods(app, logger)
+*
+* // Generate a controller from a stub
+* await codemods.makeUsingStub(stubsRoot, 'controller.stub', {
+*   filename: 'UserController',
+*   entity: { name: 'User' }
+* })
+*
+* // Install packages
+* await codemods.installPackages([
+*   { name: '@adonisjs/lucid', isDevDependency: false }
+* ])
+* ```
+*/
 var Codemods = class extends EventEmitter {
+	/**
+	* Reference to lazily imported assembler code transformer
+	*/
 	#codeTransformer;
+	/**
+	* Reference to AdonisJS application
+	*/
 	#app;
+	/**
+	* Reference to CLI logger to write logs
+	*/
 	#cliLogger;
+	/**
+	* Overwrite existing files when generating files
+	* from stubs
+	*/
 	overwriteExisting = false;
+	/**
+	* Display verbose logs for package installation
+	*/
 	verboseInstallOutput = false;
 	constructor(app, cliLogger) {
 		super();
 		this.#app = app;
 		this.#cliLogger = cliLogger;
 	}
+	/**
+	* - Lazily import the code transformer
+	* - Return a fresh or reused instance of the code transformer
+	*/
 	async #getCodeTransformer() {
 		try {
 			if (!this.#codeTransformer) {
@@ -26,6 +72,10 @@ var Codemods = class extends EventEmitter {
 			return null;
 		}
 	}
+	/**
+	* Returns the installation command for different
+	* package managers
+	*/
 	#getInstallationCommands(packages, packageManager, isDev) {
 		if (!packages.length) return "";
 		const colors = this.#cliLogger.getColors();
@@ -37,6 +87,24 @@ var Codemods = class extends EventEmitter {
 			default: return `${colors.yellow(`npm i${devFlag}`)} ${packages.join(" ")}`;
 		}
 	}
+	/**
+	* Define one or more environment variables in the .env file
+	*
+	* @param environmentVariables - Key-value pairs of environment variables
+	* @param options - Configuration options
+	* @param options.omitFromExample - Keys to exclude from .env.example file
+	*
+	* @example
+	* ```ts
+	* await codemods.defineEnvVariables({
+	*   DB_CONNECTION: 'mysql',
+	*   DB_HOST: 'localhost',
+	*   SECRET_KEY: 'abc123'
+	* }, {
+	*   omitFromExample: ['SECRET_KEY']
+	* })
+	* ```
+	*/
 	async defineEnvVariables(environmentVariables, options) {
 		const editor = new EnvEditor(this.#app.appRoot);
 		await editor.load();
@@ -47,6 +115,19 @@ var Codemods = class extends EventEmitter {
 		await editor.save();
 		this.#cliLogger.action("update .env file").succeeded();
 	}
+	/**
+	* Returns the TsMorph project instance for advanced AST manipulations.
+	* See https://ts-morph.com/ for documentation.
+	*
+	* @example
+	* ```ts
+	* const project = await codemods.getTsMorphProject()
+	* if (project) {
+	*   const sourceFile = project.getSourceFile('app/controllers/user_controller.ts')
+	*   // Perform advanced AST operations
+	* }
+	* ```
+	*/
 	async getTsMorphProject() {
 		const transformer = await this.#getCodeTransformer();
 		if (!transformer) {
@@ -55,6 +136,21 @@ var Codemods = class extends EventEmitter {
 		}
 		return transformer.project;
 	}
+	/**
+	* Define validations for the environment variables in the start/env.ts file.
+	* This method updates the environment validation schema using the assembler.
+	*
+	* @param validations - Validation schema node for environment variables
+	*
+	* @example
+	* ```ts
+	* await codemods.defineEnvValidations({
+	*   NODE_ENV: 'Env.schema.enum(["development", "production", "test"] as const)',
+	*   PORT: 'Env.schema.number()',
+	*   HOST: 'Env.schema.string({ format: "host" })'
+	* })
+	* ```
+	*/
 	async defineEnvValidations(validations) {
 		const transformer = await this.#getCodeTransformer();
 		if (!transformer) {
@@ -70,6 +166,23 @@ var Codemods = class extends EventEmitter {
 			action.failed(error.message);
 		}
 	}
+	/**
+	* Register middleware in the start/kernel.ts file.
+	* This method adds middleware to the specified stack (server, router, or named).
+	*
+	* @param stack - The middleware stack to register to ('server' | 'router' | 'named')
+	* @param middleware - Array of middleware nodes to register
+	*
+	* @example
+	* ```ts
+	* await codemods.registerMiddleware('server', [
+	*   {
+	*     name: 'cors',
+	*     path: '@adonisjs/cors/cors_middleware'
+	*   }
+	* ])
+	* ```
+	*/
 	async registerMiddleware(stack, middleware) {
 		const transformer = await this.#getCodeTransformer();
 		if (!transformer) {
@@ -85,6 +198,23 @@ var Codemods = class extends EventEmitter {
 			action.failed(error.message);
 		}
 	}
+	/**
+	* Register bouncer policies to the list of policies collection exported from
+	* the "app/policies/main.ts" file. This method adds new policy definitions
+	* to the policies export.
+	*
+	* @param policies - Array of policy nodes to register
+	*
+	* @example
+	* ```ts
+	* await codemods.registerPolicies([
+	*   {
+	*     name: 'UserPolicy',
+	*     path: '#policies/user_policy'
+	*   }
+	* ])
+	* ```
+	*/
 	async registerPolicies(policies) {
 		const transformer = await this.#getCodeTransformer();
 		if (!transformer) {
@@ -100,6 +230,20 @@ var Codemods = class extends EventEmitter {
 			action.failed(error.message);
 		}
 	}
+	/**
+	* Update the adonisrc.ts file with new configuration settings.
+	* This method allows modification of the AdonisJS runtime configuration.
+	*
+	* @param params - Parameters for updating the RC file (varies based on update type)
+	*
+	* @example
+	* ```ts
+	* await codemods.updateRcFile((rcFile) => {
+	*   rcFile.addCommand('make:custom')
+	*   rcFile.addPreloadFile('#app/events/main')
+	* })
+	* ```
+	*/
 	async updateRcFile(...params) {
 		const transformer = await this.#getCodeTransformer();
 		if (!transformer) {
@@ -115,6 +259,21 @@ var Codemods = class extends EventEmitter {
 			action.failed(error.message);
 		}
 	}
+	/**
+	* Register a new Vite plugin in the vite.config.ts file.
+	* This method adds plugin configuration to the Vite build configuration.
+	*
+	* @param params - Parameters for adding the Vite plugin (varies based on plugin type)
+	*
+	* @example
+	* ```ts
+	* await codemods.registerVitePlugin({
+	*   name: 'vue',
+	*   import: 'import vue from "@vitejs/plugin-vue"',
+	*   options: '()'
+	* })
+	* ```
+	*/
 	async registerVitePlugin(...params) {
 		const transformer = await this.#getCodeTransformer();
 		if (!transformer) {
@@ -130,6 +289,20 @@ var Codemods = class extends EventEmitter {
 			action.failed(error.message);
 		}
 	}
+	/**
+	* Register a new Japa plugin in the tests/bootstrap.ts file.
+	* This method adds plugin configuration to the test runner setup.
+	*
+	* @param params - Parameters for adding the Japa plugin (varies based on plugin type)
+	*
+	* @example
+	* ```ts
+	* await codemods.registerJapaPlugin({
+	*   name: 'expect',
+	*   import: 'import { expect } from "@japa/expect"'
+	* })
+	* ```
+	*/
 	async registerJapaPlugin(...params) {
 		const transformer = await this.#getCodeTransformer();
 		if (!transformer) {
@@ -145,6 +318,21 @@ var Codemods = class extends EventEmitter {
 			action.failed(error.message);
 		}
 	}
+	/**
+	* Add a new validator file to the validators directory.
+	* This method creates a new validator file with the provided definition.
+	*
+	* @param params - Parameters for adding the validator
+	*
+	* @example
+	* ```ts
+	* await codemods.addValidator({
+	*   validatorFileName: 'create_user',
+	*   exportName: 'createUserValidator',
+	*   contents: 'export const createUserValidator = vine.compile(...)'
+	* })
+	* ```
+	*/
 	async addValidator(...params) {
 		const transformer = await this.#getCodeTransformer();
 		if (!transformer) {
@@ -160,6 +348,21 @@ var Codemods = class extends EventEmitter {
 			action.failed(error.message);
 		}
 	}
+	/**
+	* Add a new rate limiter file to the limiters directory.
+	* This method creates a new limiter file with the provided definition.
+	*
+	* @param params - Parameters for adding the limiter
+	*
+	* @example
+	* ```ts
+	* await codemods.addLimiter({
+	*   limiterFileName: 'api_throttle',
+	*   exportName: 'apiThrottleLimiter',
+	*   contents: 'export const apiThrottleLimiter = limiter.define(...)'
+	* })
+	* ```
+	*/
 	async addLimiter(...params) {
 		const transformer = await this.#getCodeTransformer();
 		if (!transformer) {
@@ -175,6 +378,23 @@ var Codemods = class extends EventEmitter {
 			action.failed(error.message);
 		}
 	}
+	/**
+	* Add mixins to a model class.
+	* This method adds mixin calls to the specified model file.
+	*
+	* @param params - Parameters for adding model mixins (modelFileName, mixins array)
+	*
+	* @example
+	* ```ts
+	* await codemods.addModelMixins('user', [
+	*   {
+	*     name: 'SoftDeletes',
+	*     importPath: '@adonisjs/lucid/mixins/soft_deletes',
+	*     importType: 'named'
+	*   }
+	* ])
+	* ```
+	*/
 	async addModelMixins(...params) {
 		const transformer = await this.#getCodeTransformer();
 		if (!transformer) {
@@ -190,6 +410,25 @@ var Codemods = class extends EventEmitter {
 			action.failed(error.message);
 		}
 	}
+	/**
+	* Add a new method to an existing controller class.
+	* This method injects a new method into the specified controller file.
+	*
+	* @param params - Parameters for adding the controller method
+	*
+	* @example
+	* ```ts
+	* await codemods.addControllerMethod({
+	*   controllerFileName: 'users_controller',
+	*   className: 'UsersController',
+	*   name: 'destroy',
+	*   contents: 'async destroy({ params, response }: HttpContext) { ... }',
+	*   imports: [
+	*     { isType: false, isNamed: true, name: 'HttpContext', path: '@adonisjs/core/http' }
+	*   ]
+	* })
+	* ```
+	*/
 	async addControllerMethod(...params) {
 		const transformer = await this.#getCodeTransformer();
 		if (!transformer) {
@@ -205,8 +444,32 @@ var Codemods = class extends EventEmitter {
 			action.failed(error.message);
 		}
 	}
+	/**
+	* Generate a file using a stub template
+	*
+	* @param stubsRoot - Root directory containing stub files
+	* @param stubPath - Path to the specific stub file
+	* @param stubState - Template variables for stub generation
+	*
+	* @example
+	* ```ts
+	* const result = await codemods.makeUsingStub(
+	*   './stubs',
+	*   'controller.stub',
+	*   {
+	*     filename: 'UserController',
+	*     entity: { name: 'User', modelName: 'User' },
+	*     resourceful: true
+	*   }
+	* )
+	* ```
+	*/
 	async makeUsingStub(stubsRoot, stubPath, stubState, options) {
 		const stub = await (await this.#app.stubs.create()).build(stubPath, { source: stubsRoot });
+		/**
+		* Overwrite the contents of the stub output with the contents
+		* of the provided file.
+		*/
 		if (options?.contentsFromFile) {
 			const source = isAbsolute(options.contentsFromFile) ? options.contentsFromFile : this.#app.makePath(options.contentsFromFile);
 			try {
@@ -234,6 +497,22 @@ var Codemods = class extends EventEmitter {
 		this.#cliLogger.action(`create ${entityFileName}`).succeeded();
 		return result;
 	}
+	/**
+	* Install packages using the detected or specified package manager.
+	* Automatically detects npm, yarn, or pnpm and installs dependencies accordingly.
+	* You can specify version of each package by setting it in the name like '@adonisjs/lucid'.
+	*
+	* @param packages - Array of packages with their dependency type
+	* @param packageManager - Optional package manager to use (auto-detected if not provided)
+	*
+	* @example
+	* ```ts
+	* const success = await codemods.installPackages([
+	*   { name: '@adonisjs/lucid', isDevDependency: false },
+	*   { name: '@types/node', isDevDependency: true }
+	* ])
+	* ```
+	*/
 	async installPackages(packages, packageManager) {
 		const transformer = await this.#getCodeTransformer();
 		const appPath = this.#app.makePath();
@@ -277,6 +556,25 @@ var Codemods = class extends EventEmitter {
 			return false;
 		}
 	}
+	/**
+	* List the packages that should be installed manually.
+	* This method displays installation commands for different package managers
+	* when automatic installation is not available or desired.
+	*
+	* @param packages - Array of packages with their dependency type
+	*
+	* @example
+	* ```ts
+	* await codemods.listPackagesToInstall([
+	*   { name: '@adonisjs/lucid', isDevDependency: false },
+	*   { name: '@types/node', isDevDependency: true }
+	* ])
+	* // Output:
+	* // Please install following packages
+	* // npm i -D @types/node
+	* // npm i @adonisjs/lucid
+	* ```
+	*/
 	async listPackagesToInstall(packages) {
 		const appPath = this.#app.makePath();
 		const devDependencies = packages.filter((pkg) => pkg.isDevDependency).map(({ name }) => name);
@@ -289,4 +587,5 @@ var Codemods = class extends EventEmitter {
 		this.#cliLogger.log(this.#getInstallationCommands(dependencies, packageManager || "npm", false));
 	}
 };
+//#endregion
 export { Codemods };

package/build/modules/ace/commands.d.ts

@@ -94,6 +94,11 @@ export declare class ListCommand extends AceListCommand implements BaseCommand {
     get staysAlive(): boolean | undefined;
     get startApp(): boolean | undefined;
     constructor(app: ApplicationService, kernel: Kernel, parsed: ParsedOutput, ui: UIPrimitives, prompt: Kernel['prompt']);
+    /**
+     * Auto-select JSON output when running inside an AI agent
+     * and no explicit format flag is provided.
+     */
+    run(): Promise<void>;
     /**
      * Creates the codemods module to modify source files programmatically.
      * This method provides access to AST-based code transformations.

package/build/modules/ace/main.js

@@ -1,2 +1,3 @@
-import { a as Parser, c as errors, d as Kernel, f as BaseCommand, i as ListLoader, l as flags, n as HelpCommand, o as args, p as ListCommand, r as IndexGenerator, s as cliHelpers, t as FsLoader, u as tracingChannels } from "../../main-MBAMnmJb.js";
+import "../../chunk-Do49iUES.js";
+import { a as Parser, c as errors, d as Kernel, f as BaseCommand, i as ListLoader, l as flags, n as HelpCommand, o as args, p as ListCommand, r as IndexGenerator, s as cliHelpers, t as FsLoader, u as tracingChannels } from "../../main-CRnMnrH7.js";
 export { BaseCommand, FsLoader, HelpCommand, IndexGenerator, Kernel, ListCommand, ListLoader, Parser, args, cliHelpers, errors, flags, tracingChannels };

package/build/modules/app.js

@@ -1,6 +1,4 @@
-import { n as __reExport, t as __exportAll } from "../chunk-iKc69rpz.js";
+import "../chunk-Do49iUES.js";
+import "../app-BCcG_oDd.js";
 export * from "@adonisjs/application";
-var app_exports = /* @__PURE__ */ __exportAll({});
-import * as import__adonisjs_application from "@adonisjs/application";
-__reExport(app_exports, import__adonisjs_application);
-export { app_exports as t };
+export {};

package/build/modules/bodyparser/bodyparser_middleware.js

@@ -1,3 +1,3 @@
-import { BodyParserMiddleware } from "@adonisjs/bodyparser/bodyparser_middleware";
-var bodyparser_middleware_default = BodyParserMiddleware;
+import "../../chunk-Do49iUES.js";
+import { t as bodyparser_middleware_default } from "../../bodyparser_middleware-H5FArWkI.js";
 export { bodyparser_middleware_default as default };

package/build/modules/bodyparser/main.js

@@ -1,6 +1,4 @@
-import { n as __reExport, t as __exportAll } from "../../chunk-iKc69rpz.js";
+import "../../chunk-Do49iUES.js";
+import "../../main-zxNP7iRl.js";
 export * from "@adonisjs/bodyparser";
-var main_exports = /* @__PURE__ */ __exportAll({});
-import * as import__adonisjs_bodyparser from "@adonisjs/bodyparser";
-__reExport(main_exports, import__adonisjs_bodyparser);
-export { main_exports as t };
+export {};

package/build/modules/config.js

@@ -1,6 +1,4 @@
-import { n as __reExport, t as __exportAll } from "../chunk-iKc69rpz.js";
+import "../chunk-Do49iUES.js";
+import "../config-Coti2q6R.js";
 export * from "@adonisjs/config";
-var config_exports = /* @__PURE__ */ __exportAll({});
-import * as import__adonisjs_config from "@adonisjs/config";
-__reExport(config_exports, import__adonisjs_config);
-export { config_exports as t };
+export {};

package/build/modules/container.js

@@ -1,6 +1,4 @@
-import { n as __reExport, t as __exportAll } from "../chunk-iKc69rpz.js";
+import "../chunk-Do49iUES.js";
+import "../container-CGfEwWof.js";
 export * from "@adonisjs/fold";
-var container_exports = /* @__PURE__ */ __exportAll({});
-import * as import__adonisjs_fold from "@adonisjs/fold";
-__reExport(container_exports, import__adonisjs_fold);
-export { container_exports as t };
+export {};

package/build/modules/dumper/main.js

@@ -1,6 +1,33 @@
-import "../../chunk-iKc69rpz.js";
-import { n as errors_exports, t as Dumper } from "../../dumper-BBgqFX5a.js";
+import "../../chunk-Do49iUES.js";
+import { n as errors_exports, t as Dumper } from "../../dumper-3R77st8F.js";
+//#region modules/dumper/define_config.ts
+/**
+* Define configuration for the dumper service exported by the
+* "@adonisjs/core/services/dumper" module. This function allows
+* you to customize HTML and console output formatting options.
+*
+* @param dumperConfig - Configuration object with HTML and console options
+* @param dumperConfig.html - HTML output formatting configuration
+* @param dumperConfig.console - Console output formatting configuration
+*
+* @example
+* ```ts
+* export default defineConfig({
+*   html: {
+*     showHidden: true,
+*     depth: 5,
+*     colors: true
+*   },
+*   console: {
+*     showHidden: false,
+*     depth: 3,
+*     collapse: ['Date', 'DateTime']
+*   }
+* })
+* ```
+*/
 function defineConfig(dumperConfig) {
 	return dumperConfig;
 }
+//#endregion
 export { Dumper, defineConfig, errors_exports as errors };

package/build/modules/dumper/plugins/edge.js

@@ -1,47 +1,3 @@
-import { Template } from "edge.js";
-function pluginEdgeDumper(dumper) {
-	Template.macro("dumper", dumper);
-	return (edge) => {
-		edge.registerTag({
-			tagName: "dump",
-			block: false,
-			seekable: true,
-			noNewLine: true,
-			compile(parser, buffer, token) {
-				const parsed = parser.utils.transformAst(parser.utils.generateAST(token.properties.jsArg, token.loc, token.filename), token.filename, parser);
-				buffer.writeExpression(`template.stacks.pushOnceTo('dumper', 'dumper_globals', template.dumper.getHeadElements(state.cspNonce))`, token.filename, token.loc.start.line);
-				buffer.outputExpression(`template.dumper.dumpToHtml(${parser.utils.stringify(parsed)}, { cspNonce: state.cspNonce, source: { location: $filename, line: $lineNumber } })`, token.filename, token.loc.start.line, true);
-			}
-		});
-		edge.registerTag({
-			tagName: "dd",
-			block: false,
-			seekable: true,
-			noNewLine: true,
-			compile(parser, buffer, token) {
-				const parsed = parser.utils.transformAst(parser.utils.generateAST(token.properties.jsArg, token.loc, token.filename), token.filename, parser);
-				const ddStatement = [
-					"try {",
-					`  template.dumper.dd(${parser.utils.stringify(parsed)})`,
-					"} catch (error) {",
-					`  if (error.code === 'E_DUMP_DIE_EXCEPTION') {`,
-					"    const edgeError = template.createError(error.message, $filename, $lineNumber)",
-					"    error.fileName = $filename",
-					"    error.lineNumber = $lineNumber",
-					"    edgeError.handle = function (_, ctx) {",
-					"      return error.handle(error, ctx)",
-					"    }",
-					"    edgeError.report = function () {",
-					"      return error.report(error)",
-					"    }",
-					"    throw edgeError",
-					"  }",
-					"  throw error",
-					"}"
-				].join("\n");
-				buffer.writeStatement(ddStatement, token.filename, token.loc.start.line);
-			}
-		});
-	};
-}
+import "../../../chunk-Do49iUES.js";
+import { t as pluginEdgeDumper } from "../../../edge-BG5ZYp6Z.js";
 export { pluginEdgeDumper };

package/build/modules/encryption/drivers/aes_256_cbc.js

@@ -1,2 +1,3 @@
+import "../../../chunk-Do49iUES.js";
 import { AES256CBC } from "@boringnode/encryption/drivers/aes_256_cbc";
 export { AES256CBC };

package/build/modules/encryption/drivers/aes_256_gcm.js

@@ -1,2 +1,3 @@
+import "../../../chunk-Do49iUES.js";
 import { AES256GCM } from "@boringnode/encryption/drivers/aes_256_gcm";
 export { AES256GCM };

package/build/modules/encryption/drivers/aes_siv.js

@@ -1,2 +1,3 @@
+import "../../../chunk-Do49iUES.js";
 import { AESSIV } from "@boringnode/encryption/drivers/aes_siv";
 export { AESSIV };

package/build/modules/encryption/drivers/chacha20_poly1305.js

@@ -1,2 +1,3 @@
+import "../../../chunk-Do49iUES.js";
 import { ChaCha20Poly1305 } from "@boringnode/encryption/drivers/chacha20_poly1305";
 export { ChaCha20Poly1305 };

package/build/modules/encryption/drivers/legacy.js

@@ -1,16 +1,51 @@
-import { t as E_BLIND_INDEX_NOT_SUPPORTED } from "../../../errors-CrCO-k44.js";
+import "../../../chunk-Do49iUES.js";
+import "../../../exceptions-B2MzIlHY.js";
+import { t as E_BLIND_INDEX_NOT_SUPPORTED } from "../../../errors-BScZTzBu.js";
 import { BaseDriver, Hmac, base64UrlDecode, base64UrlEncode, errors } from "@boringnode/encryption";
 import { MessageBuilder } from "@poppinss/utils";
 import { createCipheriv, createDecipheriv, randomBytes } from "node:crypto";
+//#region modules/encryption/drivers/legacy.ts
+/**
+* Factory function to create a Legacy encryption configuration.
+*
+* @example
+* ```ts
+* drivers.legacy({
+*   keys: [env.get('APP_KEY')]
+* })
+* ```
+*/
 function legacy(config) {
 	return {
 		driver: (key) => new Legacy({ key }),
 		keys: config.keys
 	};
 }
+/**
+* Legacy encryption driver for AdonisJS.
+*
+* This driver maintains compatibility with the old AdonisJS v6 encryption
+* format. It uses:
+* - AES-256-CBC for encryption
+* - HMAC SHA-256 for integrity verification
+* - MessageBuilder from @poppinss/utils for encoding values
+*
+* Encrypted format: `[encrypted_base64url].[iv_base64url].[hmac]`
+*
+* @example
+* ```ts
+* const driver = new Legacy({ key: 'your-32-character-secret-key!!' })
+*
+* const encrypted = driver.encrypt('sensitive data')
+* const decrypted = driver.decrypt(encrypted)
+* ```
+*/
 var Legacy = class extends BaseDriver {
 	constructor(config) {
 		super(config);
+		/**
+		* The key length must be at least 16 characters
+		*/
 		if (this.cryptoKey.length < 16) throw new errors.E_INSECURE_ENCRYPTER_KEY();
 	}
 	encrypt(payload, expiresInOrOptions, purpose) {
@@ -30,6 +65,9 @@ var Legacy = class extends BaseDriver {
 		const hmac = new Hmac(this.cryptoKey).generate(macPayload);
 		return this.computeReturns([macPayload, hmac]);
 	}
+	/**
+	* Decrypt value and verify it against a purpose
+	*/
 	decrypt(value, purpose) {
 		if (typeof value !== "string") return null;
 		const [cipherEncoded, ivEncoded, macEncoded] = value.split(this.separator);
@@ -47,11 +85,18 @@ var Legacy = class extends BaseDriver {
 			return null;
 		}
 	}
+	/**
+	* Legacy driver does not support blind indexes.
+	*/
 	blindIndex(_payload, _purpose) {
 		throw new E_BLIND_INDEX_NOT_SUPPORTED(["legacy"]);
 	}
+	/**
+	* Legacy driver does not support blind indexes.
+	*/
 	blindIndexes(_payload, _purpose) {
 		throw new E_BLIND_INDEX_NOT_SUPPORTED(["legacy"]);
 	}
 };
+//#endregion
 export { Legacy, legacy };