@powerlines/engine 0.47.4 → 0.49.1

package/dist/api/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","names":[],"sources":["../../src/api/types.ts"],"mappings":";;;;;;;AA8CA;;;;;;iBAAsB,KAAA,yBACI,oBAAA,yBACD,mBAAA,CAAA,CACvB,OAAA,EAAS,gBAAA,CAAiB,eAAA,EAAiB,cAAA,IAAe,OAAA"}

package/dist/api/types.mjs

@@ -0,0 +1,70 @@
+import { prepare } from "./prepare.mjs";
+import { executeEnvironments } from "@powerlines/core/lib/environment";
+import { handleTypes } from "@powerlines/core/lib/generate-types";
+import { installDependencies } from "@powerlines/core/lib/install-dependencies";
+import { writeMetaFile } from "@powerlines/core/lib/meta";
+import { initializeTsconfig, resolveTsconfig } from "@powerlines/core/lib/typescript/tsconfig";
+import { format } from "@powerlines/core/lib/utilities/format";
+import { toArray } from "@stryke/convert/to-array";
+import { createDirectory } from "@stryke/fs/helpers";
+import { isObject } from "@stryke/type-checks/is-object";
+import { formatLogMessage } from "@storm-software/config-tools/logger";
+import { omit } from "@stryke/helpers/omit";
+import { isSetObject } from "@stryke/type-checks/is-set-object";
+
+//#region src/api/types.ts
+/**
+* Generate runtime types for the Powerlines project.
+*
+* @remarks
+* This function is responsible for generating TypeScript declaration files based on the project's configuration and environment. It executes hooks at various stages of the type generation process, allowing for customization and extension by plugins. The generated types are formatted and written to the appropriate location in the project's file system, ensuring that they are available for use by other parts of the Powerlines system and by end-users of the project.
+*
+* @param context - The execution context for the build process, which provides access to the project configuration, environment, and utility functions for performing the build. The context is used to manage the state and behavior of the build process, allowing for hooks to be called at different stages of the build and for environment-specific configurations to be applied.
+*/
+async function types(context) {
+	const timer = context.timer("Type Generation");
+	context.debug(" Aggregating configuration options for the Powerlines project");
+	await executeEnvironments(context, async (env) => {
+		env.debug(`Initializing the processing options for the Powerlines project.`);
+		await context.callHook("configResolved", {
+			environment: env,
+			order: "pre"
+		});
+		await initializeTsconfig(env);
+		await context.callHook("configResolved", {
+			environment: env,
+			order: "normal"
+		});
+		if (env.entry.length > 0) env.debug(`The configuration provided ${isObject(env.config.input) ? Object.keys(env.config.input).length : toArray(env.config.input).length} entry point(s), Powerlines has found ${env.entry.length} entry files(s) for the ${env.config.title} project${env.entry.length > 0 && env.entry.length < 10 ? `: \n${env.entry.map((entry) => `- ${entry.file}${entry.output ? ` -> ${entry.output}` : ""}`).join(" \n")}` : ""}`);
+		else env.warn(`No entry files were found for the ${env.config.title} project. Please ensure this is correct. Powerlines plugins generally require at least one entry point to function properly.`);
+		await resolveTsconfig(env);
+		await installDependencies(env);
+		await context.callHook("configResolved", {
+			environment: env,
+			order: "post"
+		});
+		context.trace(`Powerlines configuration has been resolved: \n\n${formatLogMessage({
+			...env.config,
+			userConfig: isSetObject(env.config.userConfig) ? omit(env.config.userConfig, ["plugins"]) : void 0,
+			inlineConfig: isSetObject(env.config.inlineConfig) ? env.config.inlineConfig : void 0,
+			plugins: env.plugins.map((plugin) => plugin.name)
+		})}`);
+		if (!env.fs.existsSync(env.cachePath)) await createDirectory(env.cachePath);
+		if (!env.fs.existsSync(env.dataPath)) await createDirectory(env.dataPath);
+		if (env.config.skipCache === true || env.persistedMeta?.checksum !== env.meta.checksum) env.debug(`Using previously prepared files as the meta checksum has not changed.`);
+		else {
+			env.info(`Running \`prepare\` command as the meta checksum has changed since the last run.`);
+			await prepare(context, true);
+		}
+		await handleTypes(context, env);
+		context.debug("Formatting files generated during the types step.");
+		await format(env, env.typesPath, await env.fs.read(env.typesPath) ?? "");
+		await writeMetaFile(env);
+		env.persistedMeta = env.meta;
+	});
+	timer();
+}
+
+//#endregion
+export { types };
+//# sourceMappingURL=types.mjs.map

package/dist/api/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","names":[],"sources":["../../src/api/types.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { executeEnvironments } from \"@powerlines/core/lib/environment\";\nimport { handleTypes } from \"@powerlines/core/lib/generate-types\";\nimport { installDependencies } from \"@powerlines/core/lib/install-dependencies\";\nimport { writeMetaFile } from \"@powerlines/core/lib/meta\";\nimport {\n  initializeTsconfig,\n  resolveTsconfig\n} from \"@powerlines/core/lib/typescript/tsconfig\";\nimport { format } from \"@powerlines/core/lib/utilities/format\";\nimport { ExecutionContext } from \"@powerlines/core/types/context\";\nimport { formatLogMessage } from \"@storm-software/config-tools/logger\";\nimport { toArray } from \"@stryke/convert/to-array\";\nimport { createDirectory } from \"@stryke/fs/helpers\";\nimport { omit } from \"@stryke/helpers/omit\";\nimport { isObject } from \"@stryke/type-checks/is-object\";\nimport { isSetObject } from \"@stryke/type-checks/is-set-object\";\nimport { EngineResolvedConfig } from \"../types/config\";\nimport { EngineSystemContext } from \"../types/context\";\nimport { prepare } from \"./prepare\";\n\n/**\n * Generate runtime types for the Powerlines project.\n *\n * @remarks\n * This function is responsible for generating TypeScript declaration files based on the project's configuration and environment. It executes hooks at various stages of the type generation process, allowing for customization and extension by plugins. The generated types are formatted and written to the appropriate location in the project's file system, ensuring that they are available for use by other parts of the Powerlines system and by end-users of the project.\n *\n * @param context - The execution context for the build process, which provides access to the project configuration, environment, and utility functions for performing the build. The context is used to manage the state and behavior of the build process, allowing for hooks to be called at different stages of the build and for environment-specific configurations to be applied.\n */\nexport async function types<\n  TResolvedConfig extends EngineResolvedConfig,\n  TSystemContext extends EngineSystemContext\n>(context: ExecutionContext<TResolvedConfig, TSystemContext>) {\n  const timer = context.timer(\"Type Generation\");\n  context.debug(\n    \" Aggregating configuration options for the Powerlines project\"\n  );\n\n  await executeEnvironments(context, async env => {\n    env.debug(\n      `Initializing the processing options for the Powerlines project.`\n    );\n\n    await context.callHook(\"configResolved\", {\n      environment: env,\n      order: \"pre\"\n    });\n\n    await initializeTsconfig<TResolvedConfig, TSystemContext>(env);\n\n    await context.callHook(\"configResolved\", {\n      environment: env,\n      order: \"normal\"\n    });\n\n    if (env.entry.length > 0) {\n      env.debug(\n        `The configuration provided ${\n          isObject(env.config.input)\n            ? Object.keys(env.config.input).length\n            : toArray(env.config.input).length\n        } entry point(s), Powerlines has found ${\n          env.entry.length\n        } entry files(s) for the ${env.config.title} project${\n          env.entry.length > 0 && env.entry.length < 10\n            ? `: \\n${env.entry\n                .map(\n                  entry =>\n                    `- ${entry.file}${\n                      entry.output ? ` -> ${entry.output}` : \"\"\n                    }`\n                )\n                .join(\" \\n\")}`\n            : \"\"\n        }`\n      );\n    } else {\n      env.warn(\n        `No entry files were found for the ${\n          env.config.title\n        } project. Please ensure this is correct. Powerlines plugins generally require at least one entry point to function properly.`\n      );\n    }\n\n    await resolveTsconfig<TResolvedConfig, TSystemContext>(env);\n    await installDependencies(env);\n\n    await context.callHook(\"configResolved\", {\n      environment: env,\n      order: \"post\"\n    });\n\n    context.trace(\n      `Powerlines configuration has been resolved: \\n\\n${formatLogMessage({\n        ...env.config,\n        userConfig: isSetObject(env.config.userConfig)\n          ? omit(env.config.userConfig, [\"plugins\"])\n          : undefined,\n        inlineConfig: isSetObject(env.config.inlineConfig)\n          ? env.config.inlineConfig\n          : undefined,\n        plugins: env.plugins.map(plugin => plugin.name)\n      })}`\n    );\n\n    if (!env.fs.existsSync(env.cachePath)) {\n      await createDirectory(env.cachePath);\n    }\n\n    if (!env.fs.existsSync(env.dataPath)) {\n      await createDirectory(env.dataPath);\n    }\n\n    if (\n      env.config.skipCache === true ||\n      env.persistedMeta?.checksum !== env.meta.checksum\n    ) {\n      env.debug(\n        `Using previously prepared files as the meta checksum has not changed.`\n      );\n    } else {\n      env.info(\n        `Running \\`prepare\\` command as the meta checksum has changed since the last run.`\n      );\n\n      await prepare(context, true);\n    }\n\n    await handleTypes(context, env);\n\n    context.debug(\"Formatting files generated during the types step.\");\n\n    await format(env, env.typesPath, (await env.fs.read(env.typesPath)) ?? \"\");\n\n    await writeMetaFile(env);\n    env.persistedMeta = env.meta;\n  });\n\n  timer();\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AA8CA,eAAsB,MAGpB,SAA4D;CAC5D,MAAM,QAAQ,QAAQ,MAAM,iBAAiB;CAC7C,QAAQ,MACN,+DACF;CAEA,MAAM,oBAAoB,SAAS,OAAM,QAAO;EAC9C,IAAI,MACF,iEACF;EAEA,MAAM,QAAQ,SAAS,kBAAkB;GACvC,aAAa;GACb,OAAO;EACT,CAAC;EAED,MAAM,mBAAoD,GAAG;EAE7D,MAAM,QAAQ,SAAS,kBAAkB;GACvC,aAAa;GACb,OAAO;EACT,CAAC;EAED,IAAI,IAAI,MAAM,SAAS,GACrB,IAAI,MACF,8BACE,SAAS,IAAI,OAAO,KAAK,IACrB,OAAO,KAAK,IAAI,OAAO,KAAK,EAAE,SAC9B,QAAQ,IAAI,OAAO,KAAK,EAAE,OAC/B,wCACC,IAAI,MAAM,OACX,0BAA0B,IAAI,OAAO,MAAM,UAC1C,IAAI,MAAM,SAAS,KAAK,IAAI,MAAM,SAAS,KACvC,OAAO,IAAI,MACR,KACC,UACE,KAAK,MAAM,OACT,MAAM,SAAS,OAAO,MAAM,WAAW,IAE7C,EACC,KAAK,KAAK,MACb,IAER;OAEA,IAAI,KACF,qCACE,IAAI,OAAO,MACZ,6HACH;EAGF,MAAM,gBAAiD,GAAG;EAC1D,MAAM,oBAAoB,GAAG;EAE7B,MAAM,QAAQ,SAAS,kBAAkB;GACvC,aAAa;GACb,OAAO;EACT,CAAC;EAED,QAAQ,MACN,mDAAmD,iBAAiB;GAClE,GAAG,IAAI;GACP,YAAY,YAAY,IAAI,OAAO,UAAU,IACzC,KAAK,IAAI,OAAO,YAAY,CAAC,SAAS,CAAC,IACvC;GACJ,cAAc,YAAY,IAAI,OAAO,YAAY,IAC7C,IAAI,OAAO,eACX;GACJ,SAAS,IAAI,QAAQ,KAAI,WAAU,OAAO,IAAI;EAChD,CAAC,GACH;EAEA,IAAI,CAAC,IAAI,GAAG,WAAW,IAAI,SAAS,GAClC,MAAM,gBAAgB,IAAI,SAAS;EAGrC,IAAI,CAAC,IAAI,GAAG,WAAW,IAAI,QAAQ,GACjC,MAAM,gBAAgB,IAAI,QAAQ;EAGpC,IACE,IAAI,OAAO,cAAc,QACzB,IAAI,eAAe,aAAa,IAAI,KAAK,UAEzC,IAAI,MACF,uEACF;OACK;GACL,IAAI,KACF,kFACF;GAEA,MAAM,QAAQ,SAAS,IAAI;EAC7B;EAEA,MAAM,YAAY,SAAS,GAAG;EAE9B,QAAQ,MAAM,mDAAmD;EAEjE,MAAM,OAAO,KAAK,IAAI,WAAY,MAAM,IAAI,GAAG,KAAK,IAAI,SAAS,KAAM,EAAE;EAEzE,MAAM,cAAc,GAAG;EACvB,IAAI,gBAAgB,IAAI;CAC1B,CAAC;CAED,MAAM;AACR"}

package/dist/api-BgyEi2hF.d.mts

@@ -0,0 +1,138 @@
+import { t as EngineExecutionOptions } from "./config-ByLyzMI0.mjs";
+import { t as EngineContext } from "./context-DcXV6_GL.mjs";
+import { BuildInlineConfig, CleanInlineConfig, CreateInlineConfig, DeployInlineConfig, DocsInlineConfig, InlineConfig, LintInlineConfig, PrepareInlineConfig, TestInlineConfig, TypesInlineConfig } from "@powerlines/core";
+import { EXECUTION_API_METHODS } from "@powerlines/core/constants/api";
+
+//#region src/types/utils.d.ts
+type Worker<TParams extends any[], TExposedMethods extends ReadonlyArray<string>> = { [K in TExposedMethods[number]]: (...params: TParams) => Promise<void> } & {
+  finalize: () => Promise<void>;
+};
+//#endregion
+//#region src/types/api.d.ts
+/**
+ * The Powerlines Base API Interface
+ *
+ * @remarks
+ * This interface defines the base API for Powerlines, which includes the shared context and the core commands. It is extended by the ExecutionAPI and EngineAPI interfaces to provide additional functionality specific to their respective contexts.
+ */
+interface ExecutionInterface {
+  /**
+   * 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
+   */
+  prepare: (inlineConfig: PrepareInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  types: (inlineConfig: TypesInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  create: (inlineConfig: CreateInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  clean: (inlineConfig: CleanInlineConfig) => Promise<void>;
+  /**
+   * Lint the project source code
+   *
+   * @param inlineConfig - The inline configuration for the lint command
+   * @returns A promise that resolves when the lint command has completed
+   */
+  lint: (inlineConfig: LintInlineConfig) => Promise<void>;
+  /**
+   * Test the project source code
+   *
+   * @param inlineConfig - The inline configuration for the test command
+   * @returns A promise that resolves when the test command has completed
+   */
+  test: (inlineConfig: TestInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  build: (inlineConfig: BuildInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  docs: (inlineConfig: DocsInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  deploy: (inlineConfig: DeployInlineConfig) => Promise<void>;
+  /**
+   * Finalization process
+   *
+   * @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
+   */
+  finalize: () => Promise<void>;
+}
+interface ExecutionHostParams {
+  /**
+   * The {@link MessagePort} used for communication between the execution host and the engine. This port will be used to send and receive messages, allowing the execution host to invoke API methods and return results to the engine.
+   */
+  port: MessagePort;
+  /**
+   * The execution options for the current execution instance
+   */
+  options: EngineExecutionOptions;
+  /**
+   * The inline configuration for the current execution instance, which is the result of merging the user configuration with any configuration provided by plugins during the "config" hook.
+   */
+  inlineConfig: InlineConfig;
+}
+type ExecutionHost<TExecutionAPI extends ReadonlyArray<string>> = Worker<[EngineExecutionOptions, InlineConfig], TExecutionAPI>;
+type PowerlinesExecutionHost = ExecutionHost<typeof EXECUTION_API_METHODS>;
+/**
+ * The Engine interface represents the Powerlines process' orchestration and coordination API.
+ */
+interface Engine<TExecutionAPI extends ReadonlyArray<string>> extends ExecutionInterface {
+  /**
+   * The Powerlines shared context
+   */
+  context: EngineContext;
+  /**
+   * 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.
+   */
+  host: ExecutionHost<TExecutionAPI>;
+}
+//#endregion
+export { PowerlinesExecutionHost as a, ExecutionInterface as i, ExecutionHost as n, Worker as o, ExecutionHostParams as r, Engine as t };
+//# sourceMappingURL=api-BgyEi2hF.d.mts.map

package/dist/api-BgyEi2hF.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-BgyEi2hF.d.mts","names":[],"sources":["../src/types/utils.ts","../src/types/api.ts"],"mappings":";;;;;;KAkBY,MAAA,gDAEc,aAAA,oBAElB,eAAA,eAA8B,MAAA,EAAQ,OAAA,KAAY,OAAA;EAExD,QAAA,QAAgB,OAAA;AAAA;;;;AANlB;;;;;UCuBiB,kBAAA;EDnByC;;;;;;;;EC4BxD,OAAA,GAAU,YAAA,EAAc,mBAAA,KAAwB,OAAA;ED5BZ;;;;;;AAEb;;ECoCvB,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;;AAnB9C;;;;;;;;EA8BE,MAAA,GAAS,YAAA,EAAc,kBAAA,KAAuB,OAAA;EAWxB;;;;;;;;;EAAtB,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;EA6CrB;;;;;;EArCvB,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EAxChC;;;;;;EAgDV,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EA3BnB;;;;;;;;;EAsCvB,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;EAnBF;;;;;;EA2B1C,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EARlC;;;;;;;;EAkBR,MAAA,GAAS,YAAA,EAAc,kBAAA,KAAuB,OAAA;EAAA;;;;AAUvB;AAGzB;;;EAHE,QAAA,QAAgB,OAAA;AAAA;AAAA,UAGD,mBAAA;EAcW;;;EAV1B,IAAA,EAAM,WAAA;EAKN;;;EAAA,OAAA,EAAS,sBAAA;EAKiB;AAAA;AAG5B;EAHE,YAAA,EAAc,YAAA;AAAA;AAAA,KAGJ,aAAA,uBAAoC,aAAA,YAAyB,MAAA,EACtE,sBAAA,EAAwB,YAAA,GACzB,aAAA;AAAA,KAGU,uBAAA,GAA0B,aAAa,QAC1C,qBAAA;;;;UAMQ,MAAA,uBACO,aAAA,kBACd,kBAAA;EAd+D;;;EAkBvE,OAAA,EAAS,aAAA;EAhBI;AAAA;AAGf;EAkBE,IAAA,EAAM,aAAA,CAAc,aAAA;AAAA"}

package/dist/api-DcHfCjQK.d.cts

@@ -0,0 +1,138 @@
+import { t as EngineExecutionOptions } from "./config-DKEmqMrh.cjs";
+import { t as EngineContext } from "./context-D0_a0kRO.cjs";
+import { BuildInlineConfig, CleanInlineConfig, CreateInlineConfig, DeployInlineConfig, DocsInlineConfig, InlineConfig, LintInlineConfig, PrepareInlineConfig, TestInlineConfig, TypesInlineConfig } from "@powerlines/core";
+import { EXECUTION_API_METHODS } from "@powerlines/core/constants/api";
+
+//#region src/types/utils.d.ts
+type Worker<TParams extends any[], TExposedMethods extends ReadonlyArray<string>> = { [K in TExposedMethods[number]]: (...params: TParams) => Promise<void> } & {
+  finalize: () => Promise<void>;
+};
+//#endregion
+//#region src/types/api.d.ts
+/**
+ * The Powerlines Base API Interface
+ *
+ * @remarks
+ * This interface defines the base API for Powerlines, which includes the shared context and the core commands. It is extended by the ExecutionAPI and EngineAPI interfaces to provide additional functionality specific to their respective contexts.
+ */
+interface ExecutionInterface {
+  /**
+   * 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
+   */
+  prepare: (inlineConfig: PrepareInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  types: (inlineConfig: TypesInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  create: (inlineConfig: CreateInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  clean: (inlineConfig: CleanInlineConfig) => Promise<void>;
+  /**
+   * Lint the project source code
+   *
+   * @param inlineConfig - The inline configuration for the lint command
+   * @returns A promise that resolves when the lint command has completed
+   */
+  lint: (inlineConfig: LintInlineConfig) => Promise<void>;
+  /**
+   * Test the project source code
+   *
+   * @param inlineConfig - The inline configuration for the test command
+   * @returns A promise that resolves when the test command has completed
+   */
+  test: (inlineConfig: TestInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  build: (inlineConfig: BuildInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  docs: (inlineConfig: DocsInlineConfig) => Promise<void>;
+  /**
+   * 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
+   */
+  deploy: (inlineConfig: DeployInlineConfig) => Promise<void>;
+  /**
+   * Finalization process
+   *
+   * @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
+   */
+  finalize: () => Promise<void>;
+}
+interface ExecutionHostParams {
+  /**
+   * The {@link MessagePort} used for communication between the execution host and the engine. This port will be used to send and receive messages, allowing the execution host to invoke API methods and return results to the engine.
+   */
+  port: MessagePort;
+  /**
+   * The execution options for the current execution instance
+   */
+  options: EngineExecutionOptions;
+  /**
+   * The inline configuration for the current execution instance, which is the result of merging the user configuration with any configuration provided by plugins during the "config" hook.
+   */
+  inlineConfig: InlineConfig;
+}
+type ExecutionHost<TExecutionAPI extends ReadonlyArray<string>> = Worker<[EngineExecutionOptions, InlineConfig], TExecutionAPI>;
+type PowerlinesExecutionHost = ExecutionHost<typeof EXECUTION_API_METHODS>;
+/**
+ * The Engine interface represents the Powerlines process' orchestration and coordination API.
+ */
+interface Engine<TExecutionAPI extends ReadonlyArray<string>> extends ExecutionInterface {
+  /**
+   * The Powerlines shared context
+   */
+  context: EngineContext;
+  /**
+   * 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.
+   */
+  host: ExecutionHost<TExecutionAPI>;
+}
+//#endregion
+export { PowerlinesExecutionHost as a, ExecutionInterface as i, ExecutionHost as n, Worker as o, ExecutionHostParams as r, Engine as t };
+//# sourceMappingURL=api-DcHfCjQK.d.cts.map

package/dist/api-DcHfCjQK.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-DcHfCjQK.d.cts","names":[],"sources":["../src/types/utils.ts","../src/types/api.ts"],"mappings":";;;;;;KAkBY,MAAA,gDAEc,aAAA,oBAElB,eAAA,eAA8B,MAAA,EAAQ,OAAA,KAAY,OAAA;EAExD,QAAA,QAAgB,OAAA;AAAA;;;;AANlB;;;;;UCuBiB,kBAAA;EDnByC;;;;;;;;EC4BxD,OAAA,GAAU,YAAA,EAAc,mBAAA,KAAwB,OAAA;ED5BZ;;;;;;AAEb;;ECoCvB,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;;AAnB9C;;;;;;;;EA8BE,MAAA,GAAS,YAAA,EAAc,kBAAA,KAAuB,OAAA;EAWxB;;;;;;;;;EAAtB,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;EA6CrB;;;;;;EArCvB,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EAxChC;;;;;;EAgDV,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EA3BnB;;;;;;;;;EAsCvB,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;EAnBF;;;;;;EA2B1C,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EARlC;;;;;;;;EAkBR,MAAA,GAAS,YAAA,EAAc,kBAAA,KAAuB,OAAA;EAAA;;;;AAUvB;AAGzB;;;EAHE,QAAA,QAAgB,OAAA;AAAA;AAAA,UAGD,mBAAA;EAcW;;;EAV1B,IAAA,EAAM,WAAA;EAKN;;;EAAA,OAAA,EAAS,sBAAA;EAKiB;AAAA;AAG5B;EAHE,YAAA,EAAc,YAAA;AAAA;AAAA,KAGJ,aAAA,uBAAoC,aAAA,YAAyB,MAAA,EACtE,sBAAA,EAAwB,YAAA,GACzB,aAAA;AAAA,KAGU,uBAAA,GAA0B,aAAa,QAC1C,qBAAA;;;;UAMQ,MAAA,uBACO,aAAA,kBACd,kBAAA;EAd+D;;;EAkBvE,OAAA,EAAS,aAAA;EAhBI;AAAA;AAGf;EAkBE,IAAA,EAAM,aAAA,CAAc,aAAA;AAAA"}