@adonisjs/assembler 8.0.0-next.9 → 8.0.0

package/build/src/hooks.d.ts

@@ -1,224 +0,0 @@
-import { type AsyncOrSync } from '@poppinss/utils/types';
-import { type HookParams } from './types/hooks.ts';
-/**
- * Collection of hooks that can be used to listen for various events during
- * the application lifecycle. These hooks allow you to execute custom logic
- * at specific points in the development server, build process, and testing.
- *
- * @example
- * ```js
- * const { hooks } = await import('@adonisjs/assembler/hooks')
- *
- * hooks.init((app) => {
- *   console.log('Application initialized')
- * })
- *
- * hooks.devServerStarted((server) => {
- *   console.log('Dev server started on port', server.port)
- * })
- * ```
- */
-export declare const hooks: {
-    /**
-     * Hook called during application initialization. This is the first hook
-     * that gets executed when the assembler starts up.
-     *
-     * @param callback - Function to execute when the init event occurs
-     *
-     * @example
-     * ```js
-     * hooks.init((app) => {
-     *   console.log('Application is initializing')
-     *   // Setup global configurations
-     * })
-     * ```
-     */
-    init(callback: (...args: HookParams<"init">) => AsyncOrSync<void>): (parent: import("./dev_server.ts").DevServer | import("./test_runner.ts").TestRunner | import("./bundler.ts").Bundler, indexGenerator: import("./index_generator/main.ts").IndexGenerator) => AsyncOrSync<void>;
-    /**
-     * Hook called after routes have been committed to the router.
-     * This occurs after all route definitions have been processed.
-     *
-     * @param callback - Function to execute when routes are committed
-     *
-     * @example
-     * ```js
-     * hooks.routesCommitted((router) => {
-     *   console.log('All routes have been committed to the router')
-     *   // Perform route-based setup
-     * })
-     * ```
-     */
-    routesCommitted(callback: (...args: HookParams<"routesCommitted">) => AsyncOrSync<void>): (parent: import("./dev_server.ts").DevServer, routes: Record<string, import("./types/code_scanners.ts").RoutesListItem[]>) => AsyncOrSync<void>;
-    /**
-     * Hook called when the assembler starts scanning for route files.
-     * This happens before any route files are actually processed.
-     *
-     * @param callback - Function to execute when route scanning begins
-     *
-     * @example
-     * ```js
-     * hooks.routesScanning(() => {
-     *   console.log('Starting to scan for route files')
-     *   // Setup route scanning configurations
-     * })
-     * ```
-     */
-    routesScanning(callback: (...args: HookParams<"routesScanning">) => AsyncOrSync<void>): (parent: import("./dev_server.ts").DevServer, routesScanner: import("./code_scanners/routes_scanner/main.ts").RoutesScanner) => AsyncOrSync<void>;
-    /**
-     * Hook called after all route files have been scanned and processed.
-     * This occurs once the route scanning phase is complete.
-     *
-     * @param callback - Function to execute when route scanning is finished
-     *
-     * @example
-     * ```js
-     * hooks.routesScanned((scannedRoutes) => {
-     *   console.log('Route scanning completed')
-     *   // Process scanned route information
-     * })
-     * ```
-     */
-    routesScanned(callback: (...args: HookParams<"routesScanned">) => AsyncOrSync<void>): (parent: import("./dev_server.ts").DevServer, routesScanner: import("./code_scanners/routes_scanner/main.ts").RoutesScanner) => AsyncOrSync<void>;
-    /**
-     * Hook called when a file is modified during development.
-     * This is triggered by the file watcher when changes are detected.
-     *
-     * @param callback - Function to execute when a file changes
-     *
-     * @example
-     * ```js
-     * hooks.fileChanged((filePath, stats) => {
-     *   console.log(`File changed: ${filePath}`)
-     *   // Handle file change logic
-     * })
-     * ```
-     */
-    fileChanged(callback: (...args: HookParams<"fileChanged">) => AsyncOrSync<void>): (relativePath: string, absolutePath: string, info: {
-        source: "hot-hook" | "watcher";
-        hotReloaded: boolean;
-        fullReload: boolean;
-    }, parent: import("./dev_server.ts").DevServer | import("./test_runner.ts").TestRunner) => AsyncOrSync<void>;
-    /**
-     * Hook called when a new file is added during development.
-     * This is triggered by the file watcher when new files are created.
-     *
-     * @param callback - Function to execute when a file is added
-     *
-     * @example
-     * ```js
-     * hooks.fileAdded((filePath, stats) => {
-     *   console.log(`New file added: ${filePath}`)
-     *   // Handle new file logic
-     * })
-     * ```
-     */
-    fileAdded(callback: (...args: HookParams<"fileAdded">) => AsyncOrSync<void>): (relativePath: string, absolutePath: string, server: import("./dev_server.ts").DevServer | import("./test_runner.ts").TestRunner) => AsyncOrSync<void>;
-    /**
-     * Hook called when a file is removed during development.
-     * This is triggered by the file watcher when files are deleted.
-     *
-     * @param callback - Function to execute when a file is removed
-     *
-     * @example
-     * ```js
-     * hooks.fileRemoved((filePath) => {
-     *   console.log(`File removed: ${filePath}`)
-     *   // Handle file removal logic
-     * })
-     * ```
-     */
-    fileRemoved(callback: (...args: HookParams<"fileRemoved">) => AsyncOrSync<void>): (relativePath: string, absolutePath: string, server: import("./dev_server.ts").DevServer | import("./test_runner.ts").TestRunner) => AsyncOrSync<void>;
-    /**
-     * Hook called when the development server is about to start.
-     * This occurs before the server begins listening for connections.
-     *
-     * @param callback - Function to execute when dev server is starting
-     *
-     * @example
-     * ```js
-     * hooks.devServerStarting((server) => {
-     *   console.log('Development server is starting')
-     *   // Setup server configurations
-     * })
-     * ```
-     */
-    devServerStarting(callback: (...args: HookParams<"devServerStarting">) => AsyncOrSync<void>): (server: import("./dev_server.ts").DevServer) => AsyncOrSync<void>;
-    /**
-     * Hook called after the development server has successfully started.
-     * This occurs once the server is listening and ready to accept requests.
-     *
-     * @param callback - Function to execute when dev server has started
-     *
-     * @example
-     * ```js
-     * hooks.devServerStarted((server) => {
-     *   console.log(`Development server started on port ${server.port}`)
-     *   // Notify external services or open browser
-     * })
-     * ```
-     */
-    devServerStarted(callback: (...args: HookParams<"devServerStarted">) => AsyncOrSync<void>): (server: import("./dev_server.ts").DevServer, info: {
-        port: number;
-        host: string;
-    }, uiInstructions: import("@poppinss/cliui").Instructions) => AsyncOrSync<void>;
-    /**
-     * Hook called when the build process is about to start.
-     * This occurs before any build tasks are executed.
-     *
-     * @param callback - Function to execute when build is starting
-     *
-     * @example
-     * ```js
-     * hooks.buildStarting((buildConfig) => {
-     *   console.log('Build process is starting')
-     *   // Setup build configurations or clean directories
-     * })
-     * ```
-     */
-    buildStarting(callback: (...args: HookParams<"buildStarting">) => AsyncOrSync<void>): (server: import("./bundler.ts").Bundler) => AsyncOrSync<void>;
-    /**
-     * Hook called after the build process has completed.
-     * This occurs once all build tasks have finished executing.
-     *
-     * @param callback - Function to execute when build is finished
-     *
-     * @example
-     * ```js
-     * hooks.buildFinished((buildResult) => {
-     *   console.log('Build process completed')
-     *   // Deploy artifacts or notify build completion
-     * })
-     * ```
-     */
-    buildFinished(callback: (...args: HookParams<"buildFinished">) => AsyncOrSync<void>): (server: import("./bundler.ts").Bundler, uiInstructions: import("@poppinss/cliui").Instructions) => AsyncOrSync<void>;
-    /**
-     * Hook called when the test suite is about to start.
-     * This occurs before any test files are executed.
-     *
-     * @param callback - Function to execute when tests are starting
-     *
-     * @example
-     * ```js
-     * hooks.testsStarting((testConfig) => {
-     *   console.log('Test suite is starting')
-     *   // Setup test database or mock services
-     * })
-     * ```
-     */
-    testsStarting(callback: (...args: HookParams<"testsStarting">) => AsyncOrSync<void>): (server: import("./test_runner.ts").TestRunner) => AsyncOrSync<void>;
-    /**
-     * Hook called after the test suite has completed.
-     * This occurs once all test files have finished executing.
-     *
-     * @param callback - Function to execute when tests are finished
-     *
-     * @example
-     * ```js
-     * hooks.testsFinished((testResults) => {
-     *   console.log('Test suite completed')
-     *   // Generate test reports or cleanup test resources
-     * })
-     * ```
-     */
-    testsFinished(callback: (...args: HookParams<"testsFinished">) => AsyncOrSync<void>): (server: import("./test_runner.ts").TestRunner) => AsyncOrSync<void>;
-};