@powerlines/core 0.15.0 → 0.15.1

package/dist/storage/virtual.mjs

@@ -0,0 +1,97 @@
+import { BaseStorageAdapter } from "./base.mjs";
+import { isParentPath } from "@stryke/path/is-parent-path";
+
+//#region src/storage/virtual.ts
+/**
+* Virtual/in-memory storage adapter implementation.
+*/
+var VirtualStorageAdapter = class extends BaseStorageAdapter {
+	/**
+	* A name identifying the storage adapter type.
+	*/
+	name = "virtual";
+	/**
+	* The storage preset for the adapter.
+	*
+	* @remarks
+	* This can be used as an alternate way to identify the type of storage being used.
+	*/
+	preset = "virtual";
+	/**
+	* In-memory data storage.
+	*/
+	data = /* @__PURE__ */ new Map();
+	/**
+	* Constructor for the VirtualStorageAdapter.
+	*
+	* @param context - The Powerlines context.
+	* @param options - Configuration options for the storage adapter.
+	*/
+	constructor(context, options) {
+		super(context, options);
+	}
+	/**
+	* Synchronously checks if a key exists in the storage.
+	*
+	* @param key - The key to check for existence.
+	* @returns Returns `true` if the key exists, otherwise `false`.
+	*/
+	existsSync(key) {
+		return this.data.has(this.resolve(key));
+	}
+	/**
+	* Synchronously retrieves the value associated with a given key.
+	*
+	* @param key - The key whose value is to be retrieved.
+	* @returns The value associated with the key, or `null` if the key does not exist.
+	*/
+	getSync(key) {
+		return this.data.get(this.resolve(key)) ?? null;
+	}
+	/**
+	* Synchronously sets the value for a given key.
+	*
+	* @param key - The key to set the value for.
+	* @param value - The value to set.
+	*/
+	setSync(key, value) {
+		if (!this.isReadOnly && (!this.existsSync(key) || this.overwrite)) this.data.set(this.resolve(key), value);
+	}
+	/**
+	* Synchronously removes a key from the storage.
+	*
+	* @param key - The key to remove.
+	*/
+	removeSync(key) {
+		if (!this.isReadOnly && this.overwrite) this.data.delete(this.resolve(key));
+	}
+	/**
+	* Lists all keys under a given base path synchronously.
+	*
+	* @param base - The base path to list keys from.
+	* @returns An array of keys under the specified base path.
+	*/
+	listSync(base) {
+		return [...this.data.keys().filter((key) => !base ? true : isParentPath(key, this.resolve(base)))];
+	}
+	/**
+	* Disposes of the storage adapter, releasing any held resources.
+	*
+	* @returns A promise that resolves when the disposal is complete.
+	*/
+	async dispose() {
+		return this.clear();
+	}
+	/**
+	* Determines if the storage adapter should overwrite existing keys based on the provided options and context configuration.
+	*
+	* @returns `true` if the storage adapter should overwrite existing keys, otherwise `false`.
+	*/
+	get overwrite() {
+		return !this.isReadOnly;
+	}
+};
+
+//#endregion
+export { VirtualStorageAdapter };
+//# sourceMappingURL=virtual.mjs.map

package/dist/storage/virtual.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtual.mjs","names":[],"sources":["../../src/storage/virtual.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 { isParentPath } from \"@stryke/path/is-parent-path\";\nimport type { Context } from \"../types/context\";\nimport { BaseStorageAdapter, StorageAdapterOptions } from \"./base\";\n\n/**\n * Virtual/in-memory storage adapter implementation.\n */\nexport class VirtualStorageAdapter extends BaseStorageAdapter {\n  /**\n   * A name identifying the storage adapter type.\n   */\n  public name = \"virtual\";\n\n  /**\n   * The storage preset for the adapter.\n   *\n   * @remarks\n   * This can be used as an alternate way to identify the type of storage being used.\n   */\n  public override readonly preset = \"virtual\";\n\n  /**\n   * In-memory data storage.\n   */\n  protected data = new Map<string, any>();\n\n  /**\n   * Constructor for the VirtualStorageAdapter.\n   *\n   * @param context - The Powerlines context.\n   * @param options - Configuration options for the storage adapter.\n   */\n  public constructor(context: Context, options?: StorageAdapterOptions) {\n    super(context, options);\n  }\n\n  /**\n   * Synchronously checks if a key exists in the storage.\n   *\n   * @param key - The key to check for existence.\n   * @returns Returns `true` if the key exists, otherwise `false`.\n   */\n  public existsSync(key: string): boolean {\n    return this.data.has(this.resolve(key));\n  }\n\n  /**\n   * Synchronously retrieves the value associated with a given key.\n   *\n   * @param key - The key whose value is to be retrieved.\n   * @returns The value associated with the key, or `null` if the key does not exist.\n   */\n  public getSync(key: string): string | null {\n    return this.data.get(this.resolve(key)) ?? null;\n  }\n\n  /**\n   * Synchronously sets the value for a given key.\n   *\n   * @param key - The key to set the value for.\n   * @param value - The value to set.\n   */\n  public setSync(key: string, value: string) {\n    if (!this.isReadOnly && (!this.existsSync(key) || this.overwrite)) {\n      this.data.set(this.resolve(key), value);\n    }\n  }\n\n  /**\n   * Synchronously removes a key from the storage.\n   *\n   * @param key - The key to remove.\n   */\n  public removeSync(key: string) {\n    if (!this.isReadOnly && this.overwrite) {\n      this.data.delete(this.resolve(key));\n    }\n  }\n\n  /**\n   * Lists all keys under a given base path synchronously.\n   *\n   * @param base - The base path to list keys from.\n   * @returns An array of keys under the specified base path.\n   */\n  public listSync(base?: string): string[] {\n    return [\n      ...this.data\n        .keys()\n        .filter(key => (!base ? true : isParentPath(key, this.resolve(base))))\n    ];\n  }\n\n  /**\n   * Disposes of the storage adapter, releasing any held resources.\n   *\n   * @returns A promise that resolves when the disposal is complete.\n   */\n  public override async dispose(): Promise<void> {\n    return this.clear();\n  }\n\n  /**\n   * Determines if the storage adapter should overwrite existing keys based on the provided options and context configuration.\n   *\n   * @returns `true` if the storage adapter should overwrite existing keys, otherwise `false`.\n   */\n  protected override get overwrite() {\n    return !this.isReadOnly;\n  }\n}\n"],"mappings":";;;;;;;AAyBA,IAAa,wBAAb,cAA2C,mBAAmB;;;;CAI5D,AAAO,OAAO;;;;;;;CAQd,AAAyB,SAAS;;;;CAKlC,AAAU,uBAAO,IAAI,KAAkB;;;;;;;CAQvC,AAAO,YAAY,SAAkB,SAAiC;AACpE,QAAM,SAAS,QAAQ;;;;;;;;CASzB,AAAO,WAAW,KAAsB;AACtC,SAAO,KAAK,KAAK,IAAI,KAAK,QAAQ,IAAI,CAAC;;;;;;;;CASzC,AAAO,QAAQ,KAA4B;AACzC,SAAO,KAAK,KAAK,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI;;;;;;;;CAS7C,AAAO,QAAQ,KAAa,OAAe;AACzC,MAAI,CAAC,KAAK,eAAe,CAAC,KAAK,WAAW,IAAI,IAAI,KAAK,WACrD,MAAK,KAAK,IAAI,KAAK,QAAQ,IAAI,EAAE,MAAM;;;;;;;CAS3C,AAAO,WAAW,KAAa;AAC7B,MAAI,CAAC,KAAK,cAAc,KAAK,UAC3B,MAAK,KAAK,OAAO,KAAK,QAAQ,IAAI,CAAC;;;;;;;;CAUvC,AAAO,SAAS,MAAyB;AACvC,SAAO,CACL,GAAG,KAAK,KACL,MAAM,CACN,QAAO,QAAQ,CAAC,OAAO,OAAO,aAAa,KAAK,KAAK,QAAQ,KAAK,CAAC,CAAE,CACzE;;;;;;;CAQH,MAAsB,UAAyB;AAC7C,SAAO,KAAK,OAAO;;;;;;;CAQrB,IAAuB,YAAY;AACjC,SAAO,CAAC,KAAK"}

package/dist/types/api.d.cts

@@ -1,156 +1,22 @@
-import { POWERLINES_API_FUNCTIONS } from "../constants/api.cjs";
-import { WorkerProcess } from "./utils.cjs";
-import { CallHookOptions, InferHookParameters, InferHookReturnType } from "./hooks.cjs";
-import { EngineContext, EnvironmentContext, ExecutionContext, PluginContext } from "./context.cjs";
-import { BuildInlineConfig, CleanInlineConfig, DeployInlineConfig, DocsInlineConfig, InlineConfig, LintInlineConfig, NewInlineConfig, PrepareInlineConfig, ResolvedConfig, ResolvedExecutionOptions, TestInlineConfig, TypesInlineConfig } from "./config.cjs";
+import { BASE_EXECUTION_API_METHODS, EXECUTION_API_METHODS } from "../constants/api.cjs";
+import { SUPPORTED_COMMANDS } from "../constants/commands.cjs";
+import { Context } from "./context.cjs";
+import { MaybePromise } from "@stryke/types/base";
+import { ArrayValues } from "@stryke/types/array";
 
 //#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 Execution {
-  /**
-   * 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 | NewInlineConfig | CleanInlineConfig | BuildInlineConfig | LintInlineConfig | DocsInlineConfig | DeployInlineConfig) => 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 new command
-   * @returns A promise that resolves when the project has been created
-   */
-  new: (inlineConfig: NewInlineConfig) => 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 | PrepareInlineConfig) => 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>;
-}
-/**
- * Powerlines API Interface
- *
- * @remarks
- * The API interface represents the API available during a single execution of Powerlines. It provides access to the shared context and the ability to call plugin hooks. It extends the base API with additional functionality specific to command execution.
- */
-interface API<TResolvedConfig extends ResolvedConfig = ResolvedConfig> extends Execution {
-  /**
-   * The Powerlines shared API context
-   */
-  context: ExecutionContext<TResolvedConfig>;
-  /**
-   * Invokes the configured plugin hooks
-   *
-   * @remarks
-   * By default, it will call the `"pre"`, `"normal"`, and `"post"` ordered hooks in sequence
-   *
-   * @param hook - The hook to call
-   * @param options - The options to provide to the hook
-   * @param args - The arguments to pass to the hook
-   * @returns The result of the hook call
-   */
-  callHook: <TKey extends string>(hook: TKey, options: CallHookOptions & {
-    environment?: string | EnvironmentContext<TResolvedConfig>;
-  }, ...args: InferHookParameters<PluginContext<TResolvedConfig>, TKey>) => Promise<InferHookReturnType<PluginContext<TResolvedConfig>, TKey> | undefined>;
-}
-interface ExecutionWorkerParams {
-  /**
-   * The execution options for the current execution instance
-   */
-  options: ResolvedExecutionOptions;
-  /**
-   * 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.
-   */
-  config: InlineConfig;
-}
-type ExecutionWorkerProcess = WorkerProcess<ExecutionWorkerParams, typeof POWERLINES_API_FUNCTIONS>;
-/**
- * The Engine API interface represents the API available during the entire lifecycle of the Powerlines engine. It provides access to the shared context and the registered command executions. It extends the base API with additional functionality specific to the engine lifecycle.
- */
-interface Engine extends Execution {
-  /**
-   * The Powerlines shared context
-   */
-  context: EngineContext;
-}
-declare type __ΩExecution = any[];
-declare type __ΩAPI = any[];
-declare type __ΩExecutionWorkerParams = any[];
-declare type __ΩExecutionWorkerProcess = any[];
-declare type __ΩEngine = any[];
+type BaseCommandType = ArrayValues<typeof BASE_EXECUTION_API_METHODS> | "finalize";
+type CommandType = ArrayValues<typeof SUPPORTED_COMMANDS>;
+type Commands<TContext extends Context = Context> = Record<CommandType, (this: TContext) => MaybePromise<void>>;
+type BaseExecutionAPIMethods = (typeof BASE_EXECUTION_API_METHODS)[number];
+type PowerlinesExecutionAPIMethods = (typeof EXECUTION_API_METHODS)[number];
+type SupportedCommands = (typeof SUPPORTED_COMMANDS)[number];
+declare type __ΩBaseCommandType = any[];
+declare type __ΩCommandType = any[];
+declare type __ΩCommands = any[];
+declare type __ΩBaseExecutionAPIMethods = any[];
+declare type __ΩPowerlinesExecutionAPIMethods = any[];
+declare type __ΩSupportedCommands = any[];
 //#endregion
-export { API, Engine, Execution, ExecutionWorkerParams, ExecutionWorkerProcess, __ΩAPI, __ΩEngine, __ΩExecution, __ΩExecutionWorkerParams, __ΩExecutionWorkerProcess };
+export { BaseCommandType, BaseExecutionAPIMethods, CommandType, Commands, PowerlinesExecutionAPIMethods, SupportedCommands, __ΩBaseCommandType, __ΩBaseExecutionAPIMethods, __ΩCommandType, __ΩCommands, __ΩPowerlinesExecutionAPIMethods, __ΩSupportedCommands };
 //# sourceMappingURL=api.d.cts.map

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

@@ -1 +1 @@
-{"version":3,"file":"api.d.cts","names":[],"sources":["../../src/types/api.ts"],"mappings":";;;;;;;;AAoDA;;;;;UAAiB,SAAA;EAcT;;;;;;;;EALN,OAAA,GACE,YAAA,EACI,mBAAA,GACA,eAAA,GACA,iBAAA,GACA,iBAAA,GACA,gBAAA,GACA,gBAAA,GACA,kBAAA,KACD,OAAA;EAiCW;;;;;;;;EAvBhB,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;EA2DvB;;;;;;;;;EAhDrB,GAAA,GAAM,YAAA,EAAc,eAAA,KAAoB,OAAA;EA1BlC;;;;;;;;;EAqCN,KAAA,GACE,YAAA,EAAc,iBAAA,GAAoB,mBAAA,KAC/B,OAAA;EAxBuC;;;;;;EAgC5C,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EATN;;;;;;EAiBpC,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EAA1C;;;;;;;;;EAWA,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;EAQrC;;;;;;EAAP,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EAoB1B;;;AASlB;;;;;EAnBE,MAAA,GAAS,YAAA,EAAc,kBAAA,KAAuB,OAAA;EAyBrC;;;;;;;;EAfT,QAAA,QAAgB,OAAA;AAAA;;;;;;;UASD,GAAA,yBACS,cAAA,GAAiB,cAAA,UACjC,SAAA;EADR;;;EAKA,OAAA,EAAS,gBAAA,CAAiB,eAAA;EAA1B;;;;;;;;;;;EAaA,QAAA,wBACE,IAAA,EAAM,IAAA,EACN,OAAA,EAAS,eAAA;IACP,WAAA,YAAuB,kBAAA,CAAmB,eAAA;EAAA,MAEzC,IAAA,EAAM,mBAAA,CAAoB,aAAA,CAAc,eAAA,GAAkB,IAAA,MAC1D,OAAA,CACH,mBAAA,CAAoB,aAAA,CAAc,eAAA,GAAkB,IAAA;AAAA;AAAA,UAIvC,qBAAA;EANgD;;;EAU/D,OAAA,EAAS,wBAAA;EAR2B;;;EAapC,MAAA,EAAQ,YAAA;AAAA;AAAA,KAGE,sBAAA,GAAyB,aAAA,CACnC,qBAAA,SACO,wBAAA;;;;UAMQ,MAAA,SAAe,SAAA;EAX9B;;;EAeA,OAAA,EAAS,aAAA;AAAA;AAAA"}
+{"version":3,"file":"api.d.cts","names":[],"sources":["../../src/types/api.ts"],"mappings":";;;;;;;KA2BY,eAAA,GACR,WAAA,QAAmB,0BAAA;AAAA,KAGX,WAAA,GAAc,WAAA,QAAmB,kBAAA;AAAA,KACjC,QAAA,kBAA0B,OAAA,GAAU,OAAA,IAAW,MAAA,CACzD,WAAA,GACC,IAAA,EAAM,QAAA,KAAa,YAAA;AAAA,KAGV,uBAAA,WACF,0BAAA;AAAA,KACE,6BAAA,WACF,qBAAA;AAAA,KACE,iBAAA,WAA4B,kBAAA;AAAA"}

package/dist/types/api.d.mts

@@ -1,156 +1,22 @@
-import { POWERLINES_API_FUNCTIONS } from "../constants/api.mjs";
-import { WorkerProcess } from "./utils.mjs";
-import { CallHookOptions, InferHookParameters, InferHookReturnType } from "./hooks.mjs";
-import { EngineContext, EnvironmentContext, ExecutionContext, PluginContext } from "./context.mjs";
-import { BuildInlineConfig, CleanInlineConfig, DeployInlineConfig, DocsInlineConfig, InlineConfig, LintInlineConfig, NewInlineConfig, PrepareInlineConfig, ResolvedConfig, ResolvedExecutionOptions, TestInlineConfig, TypesInlineConfig } from "./config.mjs";
+import { BASE_EXECUTION_API_METHODS, EXECUTION_API_METHODS } from "../constants/api.mjs";
+import { SUPPORTED_COMMANDS } from "../constants/commands.mjs";
+import { Context } from "./context.mjs";
+import { MaybePromise } from "@stryke/types/base";
+import { ArrayValues } from "@stryke/types/array";
 
 //#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 Execution {
-  /**
-   * 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 | NewInlineConfig | CleanInlineConfig | BuildInlineConfig | LintInlineConfig | DocsInlineConfig | DeployInlineConfig) => 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 new command
-   * @returns A promise that resolves when the project has been created
-   */
-  new: (inlineConfig: NewInlineConfig) => 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 | PrepareInlineConfig) => 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>;
-}
-/**
- * Powerlines API Interface
- *
- * @remarks
- * The API interface represents the API available during a single execution of Powerlines. It provides access to the shared context and the ability to call plugin hooks. It extends the base API with additional functionality specific to command execution.
- */
-interface API<TResolvedConfig extends ResolvedConfig = ResolvedConfig> extends Execution {
-  /**
-   * The Powerlines shared API context
-   */
-  context: ExecutionContext<TResolvedConfig>;
-  /**
-   * Invokes the configured plugin hooks
-   *
-   * @remarks
-   * By default, it will call the `"pre"`, `"normal"`, and `"post"` ordered hooks in sequence
-   *
-   * @param hook - The hook to call
-   * @param options - The options to provide to the hook
-   * @param args - The arguments to pass to the hook
-   * @returns The result of the hook call
-   */
-  callHook: <TKey extends string>(hook: TKey, options: CallHookOptions & {
-    environment?: string | EnvironmentContext<TResolvedConfig>;
-  }, ...args: InferHookParameters<PluginContext<TResolvedConfig>, TKey>) => Promise<InferHookReturnType<PluginContext<TResolvedConfig>, TKey> | undefined>;
-}
-interface ExecutionWorkerParams {
-  /**
-   * The execution options for the current execution instance
-   */
-  options: ResolvedExecutionOptions;
-  /**
-   * 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.
-   */
-  config: InlineConfig;
-}
-type ExecutionWorkerProcess = WorkerProcess<ExecutionWorkerParams, typeof POWERLINES_API_FUNCTIONS>;
-/**
- * The Engine API interface represents the API available during the entire lifecycle of the Powerlines engine. It provides access to the shared context and the registered command executions. It extends the base API with additional functionality specific to the engine lifecycle.
- */
-interface Engine extends Execution {
-  /**
-   * The Powerlines shared context
-   */
-  context: EngineContext;
-}
-declare type __ΩExecution = any[];
-declare type __ΩAPI = any[];
-declare type __ΩExecutionWorkerParams = any[];
-declare type __ΩExecutionWorkerProcess = any[];
-declare type __ΩEngine = any[];
+type BaseCommandType = ArrayValues<typeof BASE_EXECUTION_API_METHODS> | "finalize";
+type CommandType = ArrayValues<typeof SUPPORTED_COMMANDS>;
+type Commands<TContext extends Context = Context> = Record<CommandType, (this: TContext) => MaybePromise<void>>;
+type BaseExecutionAPIMethods = (typeof BASE_EXECUTION_API_METHODS)[number];
+type PowerlinesExecutionAPIMethods = (typeof EXECUTION_API_METHODS)[number];
+type SupportedCommands = (typeof SUPPORTED_COMMANDS)[number];
+declare type __ΩBaseCommandType = any[];
+declare type __ΩCommandType = any[];
+declare type __ΩCommands = any[];
+declare type __ΩBaseExecutionAPIMethods = any[];
+declare type __ΩPowerlinesExecutionAPIMethods = any[];
+declare type __ΩSupportedCommands = any[];
 //#endregion
-export { API, Engine, Execution, ExecutionWorkerParams, ExecutionWorkerProcess, __ΩAPI, __ΩEngine, __ΩExecution, __ΩExecutionWorkerParams, __ΩExecutionWorkerProcess };
+export { BaseCommandType, BaseExecutionAPIMethods, CommandType, Commands, PowerlinesExecutionAPIMethods, SupportedCommands, __ΩBaseCommandType, __ΩBaseExecutionAPIMethods, __ΩCommandType, __ΩCommands, __ΩPowerlinesExecutionAPIMethods, __ΩSupportedCommands };
 //# sourceMappingURL=api.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"api.d.mts","names":[],"sources":["../../src/types/api.ts"],"mappings":";;;;;;;;AAoDA;;;;;UAAiB,SAAA;EAcT;;;;;;;;EALN,OAAA,GACE,YAAA,EACI,mBAAA,GACA,eAAA,GACA,iBAAA,GACA,iBAAA,GACA,gBAAA,GACA,gBAAA,GACA,kBAAA,KACD,OAAA;EAiCW;;;;;;;;EAvBhB,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;EA2DvB;;;;;;;;;EAhDrB,GAAA,GAAM,YAAA,EAAc,eAAA,KAAoB,OAAA;EA1BlC;;;;;;;;;EAqCN,KAAA,GACE,YAAA,EAAc,iBAAA,GAAoB,mBAAA,KAC/B,OAAA;EAxBuC;;;;;;EAgC5C,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EATN;;;;;;EAiBpC,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EAA1C;;;;;;;;;EAWA,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;EAQrC;;;;;;EAAP,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EAoB1B;;;AASlB;;;;;EAnBE,MAAA,GAAS,YAAA,EAAc,kBAAA,KAAuB,OAAA;EAyBrC;;;;;;;;EAfT,QAAA,QAAgB,OAAA;AAAA;;;;;;;UASD,GAAA,yBACS,cAAA,GAAiB,cAAA,UACjC,SAAA;EADR;;;EAKA,OAAA,EAAS,gBAAA,CAAiB,eAAA;EAA1B;;;;;;;;;;;EAaA,QAAA,wBACE,IAAA,EAAM,IAAA,EACN,OAAA,EAAS,eAAA;IACP,WAAA,YAAuB,kBAAA,CAAmB,eAAA;EAAA,MAEzC,IAAA,EAAM,mBAAA,CAAoB,aAAA,CAAc,eAAA,GAAkB,IAAA,MAC1D,OAAA,CACH,mBAAA,CAAoB,aAAA,CAAc,eAAA,GAAkB,IAAA;AAAA;AAAA,UAIvC,qBAAA;EANgD;;;EAU/D,OAAA,EAAS,wBAAA;EAR2B;;;EAapC,MAAA,EAAQ,YAAA;AAAA;AAAA,KAGE,sBAAA,GAAyB,aAAA,CACnC,qBAAA,SACO,wBAAA;;;;UAMQ,MAAA,SAAe,SAAA;EAX9B;;;EAeA,OAAA,EAAS,aAAA;AAAA;AAAA"}
+{"version":3,"file":"api.d.mts","names":[],"sources":["../../src/types/api.ts"],"mappings":";;;;;;;KA2BY,eAAA,GACR,WAAA,QAAmB,0BAAA;AAAA,KAGX,WAAA,GAAc,WAAA,QAAmB,kBAAA;AAAA,KACjC,QAAA,kBAA0B,OAAA,GAAU,OAAA,IAAW,MAAA,CACzD,WAAA,GACC,IAAA,EAAM,QAAA,KAAa,YAAA;AAAA,KAGV,uBAAA,WACF,0BAAA;AAAA,KACE,6BAAA,WACF,qBAAA;AAAA,KACE,iBAAA,WAA4B,kBAAA;AAAA"}