@powerlines/engine 0.49.34 → 0.49.35

package/dist/{engine-BKEDCOCb.cjs → _internal/execution-api-worker.cjs}

@@ -1,16 +1,9 @@
-const require_chunk = require('./chunk-C_NdSu1c.cjs');
-const require_helpers_stream = require('./helpers/stream.cjs');
-const require_context_engine_context = require('./context/engine-context.cjs');
+const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+const require_helpers_stream = require('../helpers/stream.cjs');
 let _stryke_path_append = require("@stryke/path/append");
 let _stryke_type_checks_is_number = require("@stryke/type-checks/is-number");
 let _stryke_type_checks_is_set = require("@stryke/type-checks/is-set");
-let node_events = require("node:events");
 let node_stream = require("node:stream");
-let devframe_node = require("devframe/node");
-let get_port_please = require("get-port-please");
-let h3 = require("h3");
-let sirv = require("sirv");
-sirv = require_chunk.__toESM(sirv, 1);
 let _powerlines_core_lib_config = require("@powerlines/core/lib/config");
 let _stryke_env_environment_checks = require("@stryke/env/environment-checks");
 let _stryke_fs_resolve = require("@stryke/fs/resolve");
@@ -20,7 +13,7 @@ let date_fns_formatDuration = require("date-fns/formatDuration");
 let node_util = require("node:util");
 let node_worker_threads = require("node:worker_threads");
 let tinypool = require("tinypool");
-tinypool = require_chunk.__toESM(tinypool, 1);
+tinypool = require_runtime.__toESM(tinypool, 1);
 
 //#region src/_internal/execution-api-worker.ts
 const RESTARTED = Symbol("powerlines-worker:restarted");
@@ -317,270 +310,4 @@ var ExecutionApiWorker = class ExecutionApiWorker {
 };
 
 //#endregion
-//#region src/engine.ts
-/**
-* The Powerlines process' orchestration and coordination API.
-*
-* @public
-*/
-var PowerlinesEngine = class {
-	/**
-	* The Powerlines context
-	*/
-	#context;
-	/**
-	* The execution host, which provides methods to call the execution API functions from the engine context. This allows the engine to invoke commands and other API functions during the execution of Powerlines commands, enabling communication between the engine and the execution contexts.
-	*/
-	#api;
-	/**
-	* The Powerlines context
-	*/
-	get context() {
-		return this.#context;
-	}
-	/**
-	* The execution host, which provides methods to call the execution API functions from the engine context. This allows the engine to invoke commands and other API functions during the execution of Powerlines commands, enabling communication between the engine and the execution contexts.
-	*/
-	get api() {
-		return this.#api;
-	}
-	/**
-	* Create a new Powerlines Engine instance
-	*
-	* @param context - The Powerlines context
-	* @param api - The API host for the execution workers
-	* @returns A new instance of the Powerlines Engine
-	*/
-	constructor(context, api) {
-		this.#context = context;
-		this.#api = api;
-	}
-	/**
-	* Create a new Powerlines project
-	*
-	* @remarks
-	* This method will create a new Powerlines project in the current directory.
-	*
-	* @param inlineConfig - The inline configuration for the create command
-	* @returns A promise that resolves when the project has been created
-	*/
-	async create(inlineConfig) {
-		const timer = this.context.timer("Create");
-		this.context.info("🆕 Creating a new project");
-		await this.execute("create", inlineConfig);
-		this.context.debug("✔ Create command completed successfully");
-		timer();
-	}
-	/**
-	* Generate the Powerlines typescript declaration file
-	*
-	* @remarks
-	* This method will only generate the typescript declaration file for the Powerlines project. It is generally recommended to run the full `prepare` command, which will run this method as part of its process.
-	*
-	* @param inlineConfig - The inline configuration for the types command
-	*/
-	async types(inlineConfig) {
-		const timer = this.context.timer("Types");
-		this.context.info("🏗️  Generating typescript declarations for the project");
-		await this.execute("types", inlineConfig);
-		this.context.debug("✔ Types generation has completed successfully");
-		timer();
-	}
-	/**
-	* Prepare the Powerlines API
-	*
-	* @remarks
-	* This method will prepare the Powerlines API for use, initializing any necessary resources.
-	*
-	* @param inlineConfig - The inline configuration for the prepare command
-	*/
-	async prepare(inlineConfig) {
-		const timer = this.context.timer("Prepare");
-		this.context.info("🏗️ Preparing the project");
-		await this.execute("prepare", inlineConfig);
-		this.context.debug("✔ Preparation has completed successfully");
-		timer();
-	}
-	/**
-	* Clean any previously prepared artifacts
-	*
-	* @remarks
-	* This method will remove the previous Powerlines artifacts from the project.
-	*
-	* @param inlineConfig - The inline configuration for the clean command
-	* @returns A promise that resolves when the clean command has completed
-	*/
-	async clean(inlineConfig) {
-		const timer = this.context.timer("Clean");
-		this.context.info("🧹 Cleaning the previous artifacts");
-		await this.execute("clean", inlineConfig);
-		this.context.debug("✔ Cleaning completed successfully");
-		timer();
-	}
-	/**
-	* Lint the project
-	*
-	* @param inlineConfig - The inline configuration for the lint command
-	* @returns A promise that resolves when the lint command has completed
-	*/
-	async lint(inlineConfig) {
-		const timer = this.context.timer("Lint");
-		this.context.info("📝 Linting the project");
-		await this.execute("lint", inlineConfig);
-		this.context.debug("✔ Linting completed successfully");
-		timer();
-	}
-	/**
-	* Test the project
-	*
-	* @remarks
-	* This method will run the tests for the Powerlines project.
-	*
-	* @param inlineConfig - The inline configuration for the test command
-	* @returns A promise that resolves when the test command has completed
-	*/
-	async test(inlineConfig) {
-		const timer = this.context.timer("Test");
-		this.context.info("🧪 Running tests for the project");
-		await this.execute("test", inlineConfig);
-		this.context.debug("✔ Testing completed successfully");
-		timer();
-	}
-	/**
-	* Build the project
-	*
-	* @remarks
-	* This method will build the Powerlines project, generating the necessary artifacts.
-	*
-	* @param inlineConfig - The inline configuration for the build command
-	* @returns A promise that resolves when the build command has completed
-	*/
-	async build(inlineConfig) {
-		const timer = this.context.timer("Build");
-		this.context.info("📦 Building the project");
-		await this.execute("build", inlineConfig);
-		this.context.debug("✔ Build completed successfully");
-		timer();
-	}
-	/**
-	* Prepare the documentation for the project
-	*
-	* @param inlineConfig - The inline configuration for the docs command
-	* @returns A promise that resolves when the documentation generation has completed
-	*/
-	async docs(inlineConfig) {
-		const timer = this.context.timer("Docs");
-		this.context.info("📓 Generating documentation for the project");
-		await this.execute("docs", inlineConfig);
-		this.context.debug("✔ Documentation generation completed successfully");
-		timer();
-	}
-	/**
-	* Deploy the project source code
-	*
-	* @remarks
-	* This method will prepare and build the Powerlines project, generating the necessary artifacts for the deployment.
-	*
-	* @param inlineConfig - The inline configuration for the deploy command
-	* @returns A promise that resolves when the deploy command has completed
-	*/
-	async deploy(inlineConfig) {
-		const timer = this.context.timer("Deploy");
-		this.context.info("🚀 Deploying the project");
-		await this.execute("deploy", inlineConfig);
-		this.context.debug("✔ Deployment completed successfully");
-		timer();
-	}
-	/**
-	* Finalization/cleanup processing for the Powerlines API
-	*
-	* @remarks
-	* This step includes any final processes or clean up required by Powerlines. It will be run after each Powerlines command.
-	*
-	* @returns A promise that resolves when the finalization process has completed
-	*/
-	async finalize() {
-		const timer = this.context.timer("Finalize");
-		this.context.info("🏁 Finalization processes started");
-		await this.api.finalize();
-		this.context.debug("✔ Finalization completed successfully");
-		timer();
-	}
-	/**
-	* Asynchronous disposal method for the Powerlines Engine, which will call the finalize method to perform any necessary cleanup when the engine is disposed of.
-	*/
-	async [Symbol.asyncDispose]() {
-		return this.finalize();
-	}
-	/**
-	* Execute a Powerlines command based on the provided execution path and inline configuration, loading the necessary executions from the context and managing their lifecycle.
-	*
-	* @remarks
-	* This method will load the executions for the specified command and inline configuration, then execute each one while managing their lifecycle, including handling their completion and any errors that may occur during execution.
-	*
-	* @param command - The path to the execution configuration to load and run, which can be used to specify different execution configurations for different commands or scenarios.
-	* @param inlineConfig - Additional configuration options provided at runtime, which can override or supplement the options defined in the user configuration file.
-	* @returns A promise that resolves when all executions for the specified command have completed
-	*/
-	async execute(command, inlineConfig) {
-		await Promise.all((await this.context.loadExecutions(command, inlineConfig)).map(async (execution) => {
-			try {
-				await this.api.execute(command, execution.options, inlineConfig);
-			} catch (error) {
-				this.context.error(`Execution of method "${command}" failed for execution with invocation ID "${execution.invocationId}" and execution ID "${execution.options.executionId}": \n\n${error instanceof Error ? error.stack || error.message : String(error)}`);
-				throw error;
-			} finally {
-				this.context.completeExecution(execution.invocationId, execution.options.executionId);
-			}
-		}));
-	}
-};
-async function createContext(options) {
-	const port = options.port ?? await (0, get_port_please.getPort)({
-		host: options.host || "localhost",
-		random: true
-	});
-	const app = (0, h3.createApp)();
-	const host = (0, devframe_node.createH3DevToolsHost)({
-		appName: options.framework?.name || "powerlines",
-		origin: `http://${options.host || "localhost"}:${port}`,
-		mount: (base, dir) => {
-			app.use(base, (0, h3.fromNodeMiddleware)((0, sirv.default)(dir, {
-				dev: true,
-				single: true
-			})));
-		}
-	});
-	return require_context_engine_context.PowerlinesEngineContext.from(options, host, {
-		backend: "websocket",
-		websocket: port
-	});
-}
-async function createEngine(options, apiPath = "@powerlines/engine/api") {
-	node_events.EventEmitter.setMaxListeners(Infinity);
-	const context = await createContext(options);
-	return new PowerlinesEngine(context, await ExecutionApiWorker.from(apiPath, {
-		root: options.root,
-		context
-	}));
-}
-
-//#endregion
-Object.defineProperty(exports, 'PowerlinesEngine', {
-  enumerable: true,
-  get: function () {
-    return PowerlinesEngine;
-  }
-});
-Object.defineProperty(exports, 'createContext', {
-  enumerable: true,
-  get: function () {
-    return createContext;
-  }
-});
-Object.defineProperty(exports, 'createEngine', {
-  enumerable: true,
-  get: function () {
-    return createEngine;
-  }
-});
+exports.ExecutionApiWorker = ExecutionApiWorker;

package/dist/_internal/execution-api-worker.d.cts

@@ -0,0 +1,64 @@
+import { EngineExecutionOptions } from "../types/config.cjs";
+import { EngineContext } from "../types/context.cjs";
+import { ExecutionApiWorkerInterface } from "../types/api.cjs";
+import { InlineConfig, Mode } from "@powerlines/core";
+
+//#region src/_internal/execution-api-worker.d.ts
+declare const RESTARTED: unique symbol;
+interface ExecutionApiWorkerOptions {
+  /**
+   * The maximum time in milliseconds a worker can run before being terminated.
+   *
+   * @defaultValue 900000 (15 minutes)
+   */
+  timeout?: number;
+  /**
+   * True if `--max-old-space-size` should not be forwarded to the worker.
+   */
+  isolatedMemory?: boolean;
+  /**
+   * The mode to run the worker in, which can affect how the worker is initialized and how it behaves. This is determined based on the resolved configuration of the engine, and can be used to optimize the worker for different environments (e.g., development, production, etc.).
+   */
+  mode?: Mode;
+  /**
+   * An optional root to resolve the execution host path from, which can be used to specify a custom root directory for the worker to use when resolving paths and loading configuration files. If this option is not provided, the worker will use the current working directory as the root directory by default.
+   */
+  root?: string;
+  /**
+   * The context of the {@link @powerlines/engine#Engine | Engine instance}, which can be used to access the engine's state and services within the worker.
+   */
+  context: EngineContext;
+}
+declare class ExecutionApiWorker implements ExecutionApiWorkerInterface {
+  #private;
+  protected executionApiPath: string;
+  protected options: ExecutionApiWorkerOptions;
+  protected get restartPromise(): Promise<typeof RESTARTED>;
+  protected resolveRestartPromise(): void;
+  /**
+   * Creates a new instance of the Execution API Worker class, which manages a worker process for executing tasks related to the Powerlines Engine. The worker is initialized with the specified options and can be used to run tasks in an isolated environment, with support for automatic restarts and activity monitoring.
+   *
+   * @param apiPath - The path to the Execution API file.
+   * @param options - The options for configuring the worker, including the execution context, exposed methods, timeout, and mode.
+   * @returns A promise that resolves to an instance of the ExecutionApiWorker class.
+   */
+  static from(apiPath: string, options: ExecutionApiWorkerOptions): Promise<ExecutionApiWorker>;
+  /**
+   * Create a new API worker instance.
+   *
+   * @param executionApiPath - The path to the worker file.
+   * @param options - The options for the worker, including exposed commands, timeout, and hooks for activity and restart.
+   */
+  protected constructor(executionApiPath: string, options: ExecutionApiWorkerOptions);
+  execute(command: string, options: Omit<EngineExecutionOptions, "channel">, inlineConfig: InlineConfig): Promise<void>;
+  /**
+   * Closes the worker process, terminating it if it's still running. This method should be called when the worker is no longer needed, to free up system resources and ensure a clean shutdown. If the worker has already been terminated, this method will have no effect.
+   */
+  finalize(): Promise<void>;
+  protected onHanging(): void;
+  protected onActivity(): void;
+  protected innerExecute(command: string, options: Omit<EngineExecutionOptions, "channel">, inlineConfig: InlineConfig): Promise<void>;
+}
+//#endregion
+export { ExecutionApiWorker };
+//# sourceMappingURL=execution-api-worker.d.cts.map

package/dist/_internal/execution-api-worker.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execution-api-worker.d.cts","names":[],"sources":["../../src/_internal/execution-api-worker.ts"],"mappings":";;;;;;cAwCM,SAAA;AAAA,UA8DW,yBAAA;EA9DX;;;;AAAiD;EA8ErD,OAAA;EAhBwC;;;EAqBxC,cAAA;EAAA;;;EAKA,IAAA,GAAO,IAAA;EAUP;;;EALA,IAAA;EAQW;;;EAHX,OAAA,EAAS,aAAa;AAAA;AAAA,cAGX,kBAAA,YAA8B,2BAAA;EAAA;YAsE7B,gBAAA;EAAA,UACA,OAAA,EAAS,yBAAA;EAAA,cAxDP,cAAA,IAAc,OAAA,QAAA,SAAA;EAAA,UASlB,qBAAA;EAuWC;;;;;;;EAAA,OAxVS,IAAA,CAClB,OAAA,UACA,OAAA,EAAS,yBAAA,GAAyB,OAAA,CAAA,kBAAA;EAzCK;;;;;;EAAA,UAqEhC,WAAA,CACG,gBAAA,UACA,OAAA,EAAS,yBAAA;EAsTR,OAAA,CACX,OAAA,UACA,OAAA,EAAS,IAAA,CAAK,sBAAA,cACd,YAAA,EAAc,YAAA,GAAY,OAAA;EAjXd;;;EAoZD,QAAA,IAAY,OAAA;EAAA,UAUf,SAAA;EAAA,UAoBA,UAAA;EAAA,UAUM,YAAA,CACd,OAAA,UACA,OAAA,EAAS,IAAA,CAAK,sBAAA,cACd,YAAA,EAAc,YAAA,GAAY,OAAA;AAAA"}

package/dist/_internal/execution-api-worker.d.mts

@@ -0,0 +1,64 @@
+import { EngineExecutionOptions } from "../types/config.mjs";
+import { EngineContext } from "../types/context.mjs";
+import { ExecutionApiWorkerInterface } from "../types/api.mjs";
+import { InlineConfig, Mode } from "@powerlines/core";
+
+//#region src/_internal/execution-api-worker.d.ts
+declare const RESTARTED: unique symbol;
+interface ExecutionApiWorkerOptions {
+  /**
+   * The maximum time in milliseconds a worker can run before being terminated.
+   *
+   * @defaultValue 900000 (15 minutes)
+   */
+  timeout?: number;
+  /**
+   * True if `--max-old-space-size` should not be forwarded to the worker.
+   */
+  isolatedMemory?: boolean;
+  /**
+   * The mode to run the worker in, which can affect how the worker is initialized and how it behaves. This is determined based on the resolved configuration of the engine, and can be used to optimize the worker for different environments (e.g., development, production, etc.).
+   */
+  mode?: Mode;
+  /**
+   * An optional root to resolve the execution host path from, which can be used to specify a custom root directory for the worker to use when resolving paths and loading configuration files. If this option is not provided, the worker will use the current working directory as the root directory by default.
+   */
+  root?: string;
+  /**
+   * The context of the {@link @powerlines/engine#Engine | Engine instance}, which can be used to access the engine's state and services within the worker.
+   */
+  context: EngineContext;
+}
+declare class ExecutionApiWorker implements ExecutionApiWorkerInterface {
+  #private;
+  protected executionApiPath: string;
+  protected options: ExecutionApiWorkerOptions;
+  protected get restartPromise(): Promise<typeof RESTARTED>;
+  protected resolveRestartPromise(): void;
+  /**
+   * Creates a new instance of the Execution API Worker class, which manages a worker process for executing tasks related to the Powerlines Engine. The worker is initialized with the specified options and can be used to run tasks in an isolated environment, with support for automatic restarts and activity monitoring.
+   *
+   * @param apiPath - The path to the Execution API file.
+   * @param options - The options for configuring the worker, including the execution context, exposed methods, timeout, and mode.
+   * @returns A promise that resolves to an instance of the ExecutionApiWorker class.
+   */
+  static from(apiPath: string, options: ExecutionApiWorkerOptions): Promise<ExecutionApiWorker>;
+  /**
+   * Create a new API worker instance.
+   *
+   * @param executionApiPath - The path to the worker file.
+   * @param options - The options for the worker, including exposed commands, timeout, and hooks for activity and restart.
+   */
+  protected constructor(executionApiPath: string, options: ExecutionApiWorkerOptions);
+  execute(command: string, options: Omit<EngineExecutionOptions, "channel">, inlineConfig: InlineConfig): Promise<void>;
+  /**
+   * Closes the worker process, terminating it if it's still running. This method should be called when the worker is no longer needed, to free up system resources and ensure a clean shutdown. If the worker has already been terminated, this method will have no effect.
+   */
+  finalize(): Promise<void>;
+  protected onHanging(): void;
+  protected onActivity(): void;
+  protected innerExecute(command: string, options: Omit<EngineExecutionOptions, "channel">, inlineConfig: InlineConfig): Promise<void>;
+}
+//#endregion
+export { ExecutionApiWorker };
+//# sourceMappingURL=execution-api-worker.d.mts.map

package/dist/_internal/execution-api-worker.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execution-api-worker.d.mts","names":[],"sources":["../../src/_internal/execution-api-worker.ts"],"mappings":";;;;;;cAwCM,SAAA;AAAA,UA8DW,yBAAA;EA9DX;;;;AAAiD;EA8ErD,OAAA;EAhBwC;;;EAqBxC,cAAA;EAAA;;;EAKA,IAAA,GAAO,IAAA;EAUP;;;EALA,IAAA;EAQW;;;EAHX,OAAA,EAAS,aAAa;AAAA;AAAA,cAGX,kBAAA,YAA8B,2BAAA;EAAA;YAsE7B,gBAAA;EAAA,UACA,OAAA,EAAS,yBAAA;EAAA,cAxDP,cAAA,IAAc,OAAA,QAAA,SAAA;EAAA,UASlB,qBAAA;EAuWC;;;;;;;EAAA,OAxVS,IAAA,CAClB,OAAA,UACA,OAAA,EAAS,yBAAA,GAAyB,OAAA,CAAA,kBAAA;EAzCK;;;;;;EAAA,UAqEhC,WAAA,CACG,gBAAA,UACA,OAAA,EAAS,yBAAA;EAsTR,OAAA,CACX,OAAA,UACA,OAAA,EAAS,IAAA,CAAK,sBAAA,cACd,YAAA,EAAc,YAAA,GAAY,OAAA;EAjXd;;;EAoZD,QAAA,IAAY,OAAA;EAAA,UAUf,SAAA;EAAA,UAoBA,UAAA;EAAA,UAUM,YAAA,CACd,OAAA,UACA,OAAA,EAAS,IAAA,CAAK,sBAAA,cACd,YAAA,EAAc,YAAA,GAAY,OAAA;AAAA"}