@adonisjs/assembler 8.0.0-next.3 → 8.0.0-next.30

package/build/src/code_transformer/main.d.ts

@@ -1,44 +1,81 @@
-import { type OneOrMore } from '@poppinss/utils/types';
 import { installPackage, detectPackageManager } from '@antfu/install-pkg';
 import { Project } from 'ts-morph';
 import { RcFileTransformer } from './rc_file_transformer.ts';
 import type { MiddlewareNode, EnvValidationNode, BouncerPolicyNode } from '../types/code_transformer.ts';
 /**
- * This class is responsible for updating
+ * This class is responsible for transforming AdonisJS project code,
+ * including updating middleware, environment validations, and other
+ * code generation tasks.
+ *
+ * The CodeTransformer provides methods for modifying various AdonisJS
+ * configuration files and code structures using AST manipulation through
+ * ts-morph. It can update middleware stacks, add environment validations,
+ * register plugins, and modify RC file configurations.
+ *
+ * @example
+ * const transformer = new CodeTransformer(cwd)
+ * await transformer.addMiddlewareToStack('server', [{
+ *   path: '#middleware/cors_middleware',
+ *   position: 'before'
+ * }])
  */
 export declare class CodeTransformer {
     #private;
     /**
-     * Exporting utilities to install package and detect
-     * the package manager
+     * Utility function for installing packages
      */
     installPackage: typeof installPackage;
+    /**
+     * Utility function for detecting the package manager
+     */
     detectPackageManager: typeof detectPackageManager;
     /**
-     * The TsMorph project
+     * The TsMorph project instance for AST manipulation
      */
     project: Project;
+    /**
+     * Create a new CodeTransformer instance
+     *
+     * @param cwd - The current working directory URL
+     */
     constructor(cwd: URL);
     /**
-     * Add new env variable validation in the
-     * `env.ts` file
+     * Get directories configured in adonisrc.ts, with defaults fallback.
+     *
+     * This method reads the adonisrc.ts file and extracts the directories
+     * configuration. If a directory is not configured, the default value is used.
+     *
+     * @returns Object containing directory paths
+     */
+    getDirectories(): Record<string, string>;
+    /**
+     * Add new env variable validation in the `env.ts` file
+     *
+     * @param definition - Environment validation definition containing variables and comment
      */
     defineEnvValidations(definition: EnvValidationNode): Promise<void>;
     /**
-     * Define new middlewares inside the `start/kernel.ts`
-     * file
+     * Define new middlewares inside the `start/kernel.ts` file
      *
      * This function is highly based on some assumptions
      * and will not work if you significantly tweaked
      * your `start/kernel.ts` file.
+     *
+     * @param stack - The middleware stack to add to ('server', 'router', or 'named')
+     * @param middleware - Array of middleware entries to add
      */
     addMiddlewareToStack(stack: 'server' | 'router' | 'named', middleware: MiddlewareNode[]): Promise<void>;
     /**
-     * Update the `adonisrc.ts` file
+     * Update the `adonisrc.ts` file using the provided callback
+     *
+     * @param callback - Function that receives the RcFileTransformer for modifications
      */
     updateRcFile(callback: (transformer: RcFileTransformer) => void): Promise<void>;
     /**
      * Add a new Japa plugin in the `tests/bootstrap.ts` file
+     *
+     * @param pluginCall - The plugin function call to add
+     * @param importDeclarations - Import declarations needed for the plugin
      */
     addJapaPlugin(pluginCall: string, importDeclarations: {
         isNamed: boolean;
@@ -46,7 +83,10 @@ export declare class CodeTransformer {
         identifier: string;
     }[]): Promise<void>;
     /**
-     * Add a new Vite plugin
+     * Add a new Vite plugin to the `vite.config.ts` file
+     *
+     * @param pluginCall - The plugin function call to add
+     * @param importDeclarations - Import declarations needed for the plugin
      */
     addVitePlugin(pluginCall: string, importDeclarations: {
         isNamed: boolean;
@@ -56,38 +96,8 @@ export declare class CodeTransformer {
     /**
      * Adds a policy to the list of `policies` object configured
      * inside the `app/policies/main.ts` file.
-     */
-    addPolicies(policies: BouncerPolicyNode[]): Promise<void>;
-    /**
-     * Creates an index file that exports an object in which the key is the PascalCase
-     * name of the entity and the value is a dynamic import.
-     *
-     * For example, in case of controllers, the index file will be the list of controller
-     * names pointing a dynamically imported controller file.
      *
-     * ```ts
-     * export const controllers = {
-     *   LoginController: () => import('#controllers/login_controller'),
-     *   LogoutController: () => import('#controllers/logout_controller'),
-     * }
-     * ```
-     *
-     * @param source
-     * @param outputPath
-     * @param importAlias
+     * @param policies - Array of bouncer policy entries to add
      */
-    makeEntityIndex(input: OneOrMore<{
-        source: string;
-        importAlias?: string;
-        allowedExtensions?: string[];
-    }>, output: {
-        destination: string;
-        exportName?: string;
-        removeNameSuffix?: string;
-        computeBaseName?: (filePath: string, sourcePath: string) => string;
-        computeOutput?: (entries: {
-            name: string;
-            importPath: string;
-        }[]) => string;
-    }): Promise<void>;
+    addPolicies(policies: BouncerPolicyNode[]): Promise<void>;
 }