@vercube/devkit 0.0.3 → 0.0.5

package/dist/index.d.mts

@@ -0,0 +1,98 @@
+import { Hookable } from "hookable";
+import { ConfigTypes } from "@vercube/core";
+import { Worker } from "node:worker_threads";
+
+//#region src/Types/DevKitTypes.d.ts
+declare namespace DevKitTypes {
+  export type BuildFunc = (ctx?: ConfigTypes.BuildOptions) => void | Promise<void>;
+  export type WatchFunc = (app?: App) => void | Promise<void>;
+  type HookResult = void | Promise<void>;
+  export interface Hooks {
+    'dev:reload': () => HookResult;
+    'bundler-watch:init': () => HookResult;
+    'bundler-watch:start': () => HookResult;
+    'bundler-watch:end': () => HookResult;
+    'bundler-watch:error': (_error: Error) => HookResult;
+  }
+  /**
+   * Represents an application with hooks.
+   */
+  export interface App {
+    /**
+     * The hooks associated with the application.
+     */
+    hooks: Hookable<Hooks>;
+    /**
+     * The configuration object for the application.
+     */
+    config: ConfigTypes.Config;
+  }
+  /**
+   * Represents a development server.
+   */
+  export interface DevServer {
+    /**
+     * The application associated with the development server.
+     */
+    app: App;
+    /**
+     * Reloads the development server.
+     * @returns {Promise<void>} A promise that resolves when the server is reloaded.
+     */
+    reload: () => Promise<void>;
+  }
+  /**
+   * Represents a worker instance.
+   */
+  export interface Worker {
+    /**
+     * The worker thread instance.
+     */
+    worker: Worker | null;
+    /**
+     * The address information of the worker.
+     */
+    address: {
+      host: string;
+      port: number;
+      socketPath?: string;
+    };
+  }
+  export {};
+}
+//#endregion
+//#region src/Common/App.d.ts
+/**
+ * Creates a development server application.
+ * @returns {DevKitTypes.App} The development server application instance.
+ */
+declare function createVercube(): Promise<DevKitTypes.App>;
+//#endregion
+//#region src/Build/Build.d.ts
+/**
+ * Builds the application using the given application instance.
+ * @param {DevKitTypes.App} app - The application instance.
+ * @returns {Promise<void>} A promise that resolves when the build is complete.
+ */
+declare function build(app: DevKitTypes.App): Promise<void>;
+//#endregion
+//#region src/Build/Watch.d.ts
+/**
+ * Creates a watcher for the given application.
+ * @param {DevKitTypes.App} app - The application instance.
+ * This file is highly inspired by Nitro
+ * @see https://github.com/nitrojs/nitro/blob/v2/src/core/build/dev.ts
+ */
+declare function watch(app: DevKitTypes.App): Promise<void>;
+//#endregion
+//#region src/Server/DevServer.d.ts
+/**
+ * Creates a development server for the given application.
+ * @param {DevKitTypes.App} app - The application instance.
+ * @returns {DevKitTypes.DevServer} The development server instance.
+ * This file is highly inspired by Nitro
+ * @see https://github.com/nitrojs/nitro/blob/v2/src/core/dev-server/server.ts
+ */
+declare function createDevServer(app: DevKitTypes.App): DevKitTypes.DevServer;
+//#endregion
+export { build, createDevServer, createVercube, watch };