@adonisjs/assembler 8.0.0-next.2 → 8.0.0-next.20

package/build/src/code_transformer/main.js

@@ -1,15 +1,6 @@
-import {
-  debug_default
-} from "../../chunk-RR4HCA4M.js";
-
 // src/code_transformer/main.ts
+import { join } from "path";
 import { fileURLToPath as fileURLToPath2 } from "url";
-import string from "@poppinss/utils/string";
-import { isScriptFile } from "@poppinss/utils";
-import { fsReadAll } from "@poppinss/utils/fs";
-import { mkdir, writeFile } from "fs/promises";
-import StringBuilder from "@poppinss/utils/string_builder";
-import { basename, dirname, extname, join, relative } from "path";
 import { installPackage, detectPackageManager } from "@antfu/install-pkg";
 import {
   Node as Node2,
@@ -26,7 +17,13 @@ import {
 } from "ts-morph";
 var ALLOWED_ENVIRONMENTS = ["web", "console", "test", "repl"];
 var RcFileTransformer = class {
+  /**
+   * The current working directory URL
+   */
   #cwd;
+  /**
+   * The TsMorph project instance
+   */
   #project;
   /**
    * Settings to use when persisting files
@@ -40,12 +37,21 @@ var RcFileTransformer = class {
     // @ts-expect-error SemicolonPreference doesn't seem to be re-exported from ts-morph
     semicolons: "remove"
   };
+  /**
+   * Create a new RcFileTransformer instance
+   *
+   * @param cwd - The current working directory URL
+   * @param project - The TsMorph project instance
+   */
   constructor(cwd, project) {
     this.#cwd = cwd;
     this.#project = project;
   }
   /**
    * Get the `adonisrc.ts` source file
+   *
+   * @returns The adonisrc.ts source file
+   * @throws Error if the file cannot be found
    */
   #getRcFileOrThrow() {
     const kernelUrl = fileURLToPath(new URL("./adonisrc.ts", this.#cwd));
@@ -53,6 +59,9 @@ var RcFileTransformer = class {
   }
   /**
    * Check if environments array has a subset of available environments
+   *
+   * @param environments - Optional array of environment names
+   * @returns True if the provided environments are a subset of available ones
    */
   #isInSpecificEnvironment(environments) {
     if (!environments) {
@@ -62,6 +71,10 @@ var RcFileTransformer = class {
   }
   /**
    * Locate the `defineConfig` call inside the `adonisrc.ts` file
+   *
+   * @param file - The source file to search in
+   * @returns The defineConfig call expression
+   * @throws Error if defineConfig call cannot be found
    */
   #locateDefineConfigCallOrThrow(file) {
     const call = file.getDescendantsOfKind(SyntaxKind.CallExpression).find((statement) => statement.getExpression().getText() === "defineConfig");
@@ -72,6 +85,10 @@ var RcFileTransformer = class {
   }
   /**
    * Return the ObjectLiteralExpression of the defineConfig call
+   *
+   * @param defineConfigCall - The defineConfig call expression
+   * @returns The configuration object literal expression
+   * @throws Error if the object literal cannot be found
    */
   #getDefineConfigObjectOrThrow(defineConfigCall) {
     const configObject = defineConfigCall.getArguments()[0].asKindOrThrow(SyntaxKind.ObjectLiteralExpression);
@@ -80,6 +97,10 @@ var RcFileTransformer = class {
   /**
    * Check if the defineConfig() call has the property assignment
    * inside it or not. If not, it will create one and return it.
+   *
+   * @param propertyName - The name of the property to find or create
+   * @param initializer - The initial value if the property needs to be created
+   * @returns The property assignment node
    */
   #getPropertyAssignmentInDefineConfigCall(propertyName, initializer) {
     const file = this.#getRcFileOrThrow();
@@ -151,6 +172,9 @@ var RcFileTransformer = class {
   }
   /**
    * Add a new command to the rcFile
+   *
+   * @param commandPath - The path to the command file
+   * @returns This RcFileTransformer instance for method chaining
    */
   addCommand(commandPath) {
     const commandsProperty = this.#getPropertyAssignmentInDefineConfigCall("commands", "[]");
@@ -166,6 +190,10 @@ var RcFileTransformer = class {
   }
   /**
    * Add a new preloaded file to the rcFile
+   *
+   * @param modulePath - The path to the preload file
+   * @param environments - Optional array of environments where this preload should run
+   * @returns This RcFileTransformer instance for method chaining
    */
   addPreloadFile(modulePath, environments) {
     const preloadsProperty = this.#getPropertyAssignmentInDefineConfigCall("preloads", "[]");
@@ -182,6 +210,10 @@ var RcFileTransformer = class {
   }
   /**
    * Add a new provider to the rcFile
+   *
+   * @param providerPath - The path to the provider file
+   * @param environments - Optional array of environments where this provider should run
+   * @returns This RcFileTransformer instance for method chaining
    */
   addProvider(providerPath, environments) {
     const property = this.#getPropertyAssignmentInDefineConfigCall("providers", "[]");
@@ -196,6 +228,10 @@ var RcFileTransformer = class {
   }
   /**
    * Add a new meta file to the rcFile
+   *
+   * @param globPattern - The glob pattern for the meta file
+   * @param reloadServer - Whether the server should reload when this file changes
+   * @returns This RcFileTransformer instance for method chaining
    */
   addMetaFile(globPattern, reloadServer = false) {
     const property = this.#getPropertyAssignmentInDefineConfigCall("metaFiles", "[]");
@@ -213,7 +249,11 @@ var RcFileTransformer = class {
     return this;
   }
   /**
-   * Set directory name and path
+   * Set directory name and path in the directories configuration
+   *
+   * @param key - The directory key (e.g., 'controllers', 'models')
+   * @param value - The directory path
+   * @returns This RcFileTransformer instance for method chaining
    */
   setDirectory(key, value) {
     const property = this.#getPropertyAssignmentInDefineConfigCall("directories", "{}");
@@ -222,7 +262,11 @@ var RcFileTransformer = class {
     return this;
   }
   /**
-   * Set command alias
+   * Set command alias in the command aliases configuration
+   *
+   * @param alias - The alias name
+   * @param command - The full command name
+   * @returns This RcFileTransformer instance for method chaining
    */
   setCommandAlias(alias, command) {
     const aliasProperty = this.#getPropertyAssignmentInDefineConfigCall("commandsAliases", "{}");
@@ -232,6 +276,11 @@ var RcFileTransformer = class {
   }
   /**
    * Add a new test suite to the rcFile
+   *
+   * @param suiteName - The name of the test suite
+   * @param files - File patterns for the test suite (string or array)
+   * @param timeout - Optional timeout in milliseconds (defaults to 2000)
+   * @returns This RcFileTransformer instance for method chaining
    */
   addSuite(suiteName, files, timeout) {
     const testProperty = this.#getPropertyAssignmentInDefineConfigCall(
@@ -256,6 +305,10 @@ var RcFileTransformer = class {
   }
   /**
    * Add a new assembler hook
+   *
+   * @param type - The type of hook to add
+   * @param path - The path to the hook file
+   * @returns This RcFileTransformer instance for method chaining
    */
   addAssemblerHook(type, path) {
     const hooksProperty = this.#getPropertyAssignmentInDefineConfigCall("hooks", "{}");
@@ -274,7 +327,11 @@ var RcFileTransformer = class {
     return this;
   }
   /**
-   * Save the adonisrc.ts file
+   * Save the adonisrc.ts file with all applied transformations
+   *
+   * Formats the file according to editor settings and saves it to disk.
+   *
+   * @returns Promise that resolves when the file is saved
    */
   save() {
     const file = this.#getRcFileOrThrow();
@@ -286,18 +343,23 @@ var RcFileTransformer = class {
 // src/code_transformer/main.ts
 var CodeTransformer = class {
   /**
-   * Exporting utilities to install package and detect
-   * the package manager
+   * Utility function for installing packages
    */
   installPackage = installPackage;
+  /**
+   * Utility function for detecting the package manager
+   */
   detectPackageManager = detectPackageManager;
   /**
    * Directory of the adonisjs project
    */
   #cwd;
+  /**
+   * String path version of the current working directory
+   */
   #cwdPath;
   /**
-   * The TsMorph project
+   * The TsMorph project instance for AST manipulation
    */
   project;
   /**
@@ -312,6 +374,11 @@ var CodeTransformer = class {
     // @ts-expect-error SemicolonPreference doesn't seem to be re-exported from ts-morph
     semicolons: "remove"
   };
+  /**
+   * Create a new CodeTransformer instance
+   *
+   * @param cwd - The current working directory URL
+   */
   constructor(cwd) {
     this.#cwd = cwd;
     this.#cwdPath = fileURLToPath2(this.#cwd);
@@ -321,8 +388,14 @@ var CodeTransformer = class {
     });
   }
   /**
-   * Add a new middleware to the middleware array of the
-   * given file
+   * Add a new middleware to the middleware array of the given file
+   *
+   * This method locates middleware stack calls (like server.use or router.use)
+   * and adds the middleware entry to the appropriate position in the array.
+   *
+   * @param file - The source file to modify
+   * @param target - The target method call (e.g., 'server.use', 'router.use')
+   * @param middlewareEntry - The middleware entry to add
    */
   #addToMiddlewareArray(file, target, middlewareEntry) {
     const callExpressions = file.getDescendantsOfKind(SyntaxKind2.CallExpression).filter((statement) => statement.getExpression().getText() === target);
@@ -345,6 +418,12 @@ var CodeTransformer = class {
   }
   /**
    * Add a new middleware to the named middleware of the given file
+   *
+   * This method adds middleware entries to the named middleware object,
+   * typically used for route-specific middleware registration.
+   *
+   * @param file - The source file to modify
+   * @param middlewareEntry - The middleware entry to add (must have a name)
    */
   #addToNamedMiddleware(file, middlewareEntry) {
     if (!middlewareEntry.name) {
@@ -365,7 +444,13 @@ var CodeTransformer = class {
     }
   }
   /**
-   * Add a policy to the list of pre-registered policy
+   * Add a policy to the list of pre-registered policies
+   *
+   * This method adds bouncer policy entries to the policies object,
+   * allowing them to be used in route authorization.
+   *
+   * @param file - The source file to modify
+   * @param policyEntry - The policy entry to add
    */
   #addToPoliciesList(file, policyEntry) {
     const policiesObject = file.getVariableDeclarationOrThrow("policies").getInitializerIfKindOrThrow(SyntaxKind2.ObjectLiteralExpression);
@@ -410,8 +495,9 @@ var CodeTransformer = class {
     return writer.blankLine().writeLine("/*").writeLine(`|----------------------------------------------------------`).writeLine(`| ${comment}`).writeLine(`|----------------------------------------------------------`).writeLine(`*/`);
   }
   /**
-   * Add new env variable validation in the
-   * `env.ts` file
+   * Add new env variable validation in the `env.ts` file
+   *
+   * @param definition - Environment validation definition containing variables and comment
    */
   async defineEnvValidations(definition) {
     const kernelUrl = join(this.#cwdPath, "./start/env.ts");
@@ -448,12 +534,14 @@ var CodeTransformer = class {
     await file.save();
   }
   /**
-   * 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
    */
   async addMiddlewareToStack(stack, middleware) {
     const kernelUrl = join(this.#cwdPath, "./start/kernel.ts");
@@ -469,7 +557,9 @@ var CodeTransformer = class {
     await file.save();
   }
   /**
-   * Update the `adonisrc.ts` file
+   * Update the `adonisrc.ts` file using the provided callback
+   *
+   * @param callback - Function that receives the RcFileTransformer for modifications
    */
   async updateRcFile(callback) {
     const rcFileTransformer = new RcFileTransformer(this.#cwd, this.project);
@@ -478,6 +568,9 @@ var CodeTransformer = class {
   }
   /**
    * 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
    */
   async addJapaPlugin(pluginCall, importDeclarations) {
     const testBootstrapUrl = join(this.#cwdPath, "./tests/bootstrap.ts");
@@ -493,7 +586,10 @@ var CodeTransformer = class {
     await file.save();
   }
   /**
-   * 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
    */
   async addVitePlugin(pluginCall, importDeclarations) {
     const viteConfigTsUrl = join(this.#cwdPath, "./vite.config.ts");
@@ -520,6 +616,8 @@ var CodeTransformer = class {
   /**
    * Adds a policy to the list of `policies` object configured
    * inside the `app/policies/main.ts` file.
+   *
+   * @param policies - Array of bouncer policy entries to add
    */
   async addPolicies(policies) {
     const kernelUrl = join(this.#cwdPath, "./app/policies/main.ts");
@@ -530,82 +628,6 @@ var CodeTransformer = class {
     file.formatText(this.#editorSettings);
     await file.save();
   }
-  /**
-   * 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
-   */
-  async makeEntityIndex(input, output) {
-    const inputs = Array.isArray(input) ? input : [input];
-    const outputPath = join(this.#cwdPath, output.destination);
-    const outputDir = dirname(outputPath);
-    const exportName = output.exportName ?? new StringBuilder(basename(output.destination)).removeExtension().camelCase();
-    debug_default(
-      'creating index for "%s" at destination "%s" using sources %O',
-      exportName,
-      outputPath,
-      inputs
-    );
-    const entries = await Promise.all(
-      inputs.map(async ({ source, importAlias, allowedExtensions }) => {
-        const sourcePath = join(this.#cwdPath, source);
-        const filesList = await fsReadAll(sourcePath, {
-          filter: (filePath) => {
-            if (allowedExtensions) {
-              const ext = extname(filePath);
-              return allowedExtensions.includes(ext);
-            }
-            return isScriptFile(filePath);
-          },
-          pathType: "absolute"
-        });
-        const knownBaseNames = /* @__PURE__ */ new Set();
-        return filesList.map((filePath) => {
-          let baseName = basename(filePath);
-          if (output.computeBaseName) {
-            baseName = output.computeBaseName?.(filePath, sourcePath);
-          } else {
-            if (knownBaseNames.has(baseName)) {
-              baseName = string.toUnixSlash(relative(sourcePath, filePath));
-            }
-            knownBaseNames.add(baseName);
-          }
-          const name = new StringBuilder(baseName).removeExtension().removeSuffix(output.removeNameSuffix ?? "").pascalCase().toString();
-          const baseImportPath = importAlias ? string.toUnixSlash(relative(sourcePath, filePath)) : string.toUnixSlash(relative(outputDir, filePath));
-          const importPath = importAlias ? `${importAlias}/${new StringBuilder(baseImportPath).removeExtension().toString()}` : baseImportPath;
-          return {
-            name,
-            importPath
-          };
-        });
-      })
-    );
-    const computeOutput = output.computeOutput ?? ((list) => {
-      return list.reduce(
-        (result, entry) => {
-          debug_default('adding "%O" to the index', entry);
-          result.push(`  ${entry.name}: () => import('${entry.importPath}'),`);
-          return result;
-        },
-        [`export const ${exportName} = {`]
-      ).concat("}").join("\n");
-    });
-    await mkdir(outputDir, { recursive: true });
-    await writeFile(outputPath, computeOutput(entries.flat(2)));
-  }
 };
 export {
   CodeTransformer

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

@@ -3,45 +3,97 @@ import { type AssemblerRcFile } from '../types/common.ts';
 declare const ALLOWED_ENVIRONMENTS: readonly ["web", "console", "test", "repl"];
 /**
  * RcFileTransformer is used to transform the `adonisrc.ts` file
- * for adding new commands, providers, meta files etc
+ * for adding new commands, providers, meta files etc.
+ *
+ * This class provides a fluent API for modifying the AdonisJS configuration
+ * file (adonisrc.ts) by adding various types of entries like providers,
+ * commands, preloaded files, meta files, and test suites.
+ *
+ * @example
+ * const transformer = new RcFileTransformer(cwd, project)
+ * transformer.addProvider('#providers/app_provider')
+ * transformer.addCommand('#commands/make_controller')
+ * await transformer.save()
  */
 export declare class RcFileTransformer {
     #private;
+    /**
+     * Create a new RcFileTransformer instance
+     *
+     * @param cwd - The current working directory URL
+     * @param project - The TsMorph project instance
+     */
     constructor(cwd: URL, project: Project);
     /**
      * Add a new command to the rcFile
+     *
+     * @param commandPath - The path to the command file
+     * @returns This RcFileTransformer instance for method chaining
      */
     addCommand(commandPath: string): this;
     /**
      * Add a new preloaded file to the rcFile
+     *
+     * @param modulePath - The path to the preload file
+     * @param environments - Optional array of environments where this preload should run
+     * @returns This RcFileTransformer instance for method chaining
      */
     addPreloadFile(modulePath: string, environments?: (typeof ALLOWED_ENVIRONMENTS)[number][]): this;
     /**
      * Add a new provider to the rcFile
+     *
+     * @param providerPath - The path to the provider file
+     * @param environments - Optional array of environments where this provider should run
+     * @returns This RcFileTransformer instance for method chaining
      */
     addProvider(providerPath: string, environments?: (typeof ALLOWED_ENVIRONMENTS)[number][]): this;
     /**
      * Add a new meta file to the rcFile
+     *
+     * @param globPattern - The glob pattern for the meta file
+     * @param reloadServer - Whether the server should reload when this file changes
+     * @returns This RcFileTransformer instance for method chaining
      */
     addMetaFile(globPattern: string, reloadServer?: boolean): this;
     /**
-     * Set directory name and path
+     * Set directory name and path in the directories configuration
+     *
+     * @param key - The directory key (e.g., 'controllers', 'models')
+     * @param value - The directory path
+     * @returns This RcFileTransformer instance for method chaining
      */
     setDirectory(key: string, value: string): this;
     /**
-     * Set command alias
+     * Set command alias in the command aliases configuration
+     *
+     * @param alias - The alias name
+     * @param command - The full command name
+     * @returns This RcFileTransformer instance for method chaining
      */
     setCommandAlias(alias: string, command: string): this;
     /**
      * Add a new test suite to the rcFile
+     *
+     * @param suiteName - The name of the test suite
+     * @param files - File patterns for the test suite (string or array)
+     * @param timeout - Optional timeout in milliseconds (defaults to 2000)
+     * @returns This RcFileTransformer instance for method chaining
      */
     addSuite(suiteName: string, files: string | string[], timeout?: number): this;
     /**
      * Add a new assembler hook
+     *
+     * @param type - The type of hook to add
+     * @param path - The path to the hook file
+     * @returns This RcFileTransformer instance for method chaining
      */
     addAssemblerHook(type: keyof Exclude<AssemblerRcFile['hooks'], undefined>, path: string): this;
     /**
-     * Save the adonisrc.ts file
+     * Save the adonisrc.ts file with all applied transformations
+     *
+     * Formats the file according to editor settings and saves it to disk.
+     *
+     * @returns Promise that resolves when the file is saved
      */
     save(): Promise<void>;
 }

package/build/src/debug.d.ts

@@ -1,2 +1,14 @@
+/**
+ * Debug logger for the AdonisJS assembler package.
+ *
+ * This debug instance is configured to log messages under the 'adonisjs:assembler'
+ * namespace. Debug messages are only shown when the NODE_DEBUG environment variable
+ * includes 'adonisjs:assembler'.
+ *
+ * @example
+ * // Enable debug logging
+ * // NODE_DEBUG=adonisjs:assembler node ace serve
+ * debug('Starting development server...')
+ */
 declare const _default: import("util").DebugLogger;
 export default _default;

package/build/src/dev_server.d.ts

@@ -1,21 +1,24 @@
-import type tsStatic from 'typescript';
 import type { DevServerOptions } from './types/common.ts';
 /**
- * Exposes the API to start the development server in HMR, watch or static mode.
+ * Exposes the API to start the development server in HMR, watch or static mode
  *
  * In HMR mode, the DevServer will exec the "bin/server.ts" file and let hot-hook
  * manage the changes using hot module reloading.
  *
- * In watch mode, the DevServer will start an internal watcher and restarts the after
- * every file change. The files must be part of the TypeScript project (via tsconfig.json),
+ * In watch mode, the DevServer will start an internal watcher and restarts the server
+ * after every file change. The files must be part of the TypeScript project (via tsconfig.json),
  * or registered as metaFiles.
+ *
+ * In static mode, the server runs without file watching or hot reloading.
+ *
+ * @example
+ * const devServer = new DevServer(cwd, { hmr: true, hooks: [] })
+ * await devServer.start(ts)
  */
 export declare class DevServer {
     #private;
-    cwd: URL;
-    options: DevServerOptions;
     /**
-     * CLI UI to log colorful messages
+     * CLI UI instance for displaying colorful messages and progress information
      */
     ui: {
         colors: import("@poppinss/colors/types").Colors;
@@ -39,36 +42,108 @@ export declare class DevServer {
         useColors(colorsToUse: import("@poppinss/colors/types").Colors): void;
     };
     /**
-     * The mode in which the DevServer is running.
+     * The mode in which the DevServer is running
+     *
+     * Returns the current operating mode of the development server:
+     * - 'hmr': Hot Module Reloading enabled
+     * - 'watch': File system watching with full restarts
+     * - 'static': No file watching or hot reloading
      */
     get mode(): "hmr" | "watch" | "static";
     /**
      * Script file to start the development server
      */
     scriptFile: string;
+    /**
+     * The current working directory URL
+     */
+    cwd: URL;
+    /**
+     * File path computed from the cwd
+     */
+    cwdPath: string;
+    /**
+     * Development server configuration options including hooks and environment variables
+     */
+    options: DevServerOptions;
+    /**
+     * Create a new DevServer instance
+     *
+     * @param cwd - The current working directory URL
+     * @param options - Development server configuration options
+     */
     constructor(cwd: URL, options: DevServerOptions);
     /**
-     * Add listener to get notified when dev server is
-     * closed
+     * Adds listener to get notified when dev server is closed
+     *
+     * Registers a callback function that will be invoked when the development
+     * server's child process exits. The callback receives the exit code.
+     *
+     * @param callback - Function to call when dev server closes
+     * @returns This DevServer instance for method chaining
+     *
+     * @example
+     * devServer.onClose((exitCode) => {
+     *   console.log(`Server closed with exit code: ${exitCode}`)
+     * })
      */
     onClose(callback: (exitCode: number) => any): this;
     /**
-     * Add listener to get notified when dev server exists
-     * with an error
+     * Adds listener to get notified when dev server encounters an error
+     *
+     * Registers a callback function that will be invoked when the development
+     * server's child process encounters an error or fails to start.
+     *
+     * @param callback - Function to call when dev server encounters an error
+     * @returns This DevServer instance for method chaining
+     *
+     * @example
+     * devServer.onError((error) => {
+     *   console.error('Dev server error:', error.message)
+     * })
      */
     onError(callback: (error: any) => any): this;
     /**
-     * Close watchers and the running child process
+     * Closes watchers and terminates the running child process
+     *
+     * Cleans up keyboard shortcuts, stops file system watchers, and kills
+     * the HTTP server child process. This should be called when shutting down
+     * the development server.
+     *
+     * @example
+     * await devServer.close()
      */
     close(): Promise<void>;
     /**
-     * Start the development server
+     * Starts the development server in static or HMR mode
+     *
+     * Initializes the server and starts the HTTP server. The mode is determined
+     * by the `hmr` option in DevServerOptions. In HMR mode, hot-hook is configured
+     * to enable hot module reloading.
+     *
+     * @param ts - TypeScript module reference
+     *
+     * @example
+     * const devServer = new DevServer(cwd, { hmr: true, hooks: [] })
+     * await devServer.start(ts)
      */
-    start(ts: typeof tsStatic): Promise<void>;
+    start(): Promise<void>;
     /**
-     * Start the development server in watch mode
+     * Starts the development server in watch mode and restarts on file changes
+     *
+     * Initializes the server, starts the HTTP server, and sets up a file system
+     * watcher that monitors for changes. When files are added, modified, or deleted,
+     * the server automatically restarts. The watcher respects TypeScript project
+     * configuration and metaFiles settings.
+     *
+     * @param ts - TypeScript module reference
+     * @param options - Watch options including polling mode
+     *
+     * @example
+     * const devServer = new DevServer(cwd, { hooks: [] })
+     * await devServer.startAndWatch(ts, { poll: false })
      */
-    startAndWatch(ts: typeof tsStatic, options?: {
+    startAndWatch(options?: {
         poll: boolean;
     }): Promise<void>;
 }