@powerlines/core 0.47.4 → 0.48.2

package/dist/types/api.d.mts

@@ -1,168 +1,16 @@
-import { BASE_API_FUNCTIONS, POWERLINES_API_FUNCTIONS } from "../constants/api.mjs";
+import { BASE_EXECUTION_API_METHODS, EXECUTION_API_METHODS } from "../constants/api.mjs";
 import { SUPPORTED_COMMANDS } from "../constants/commands.mjs";
-import { CallHookOptions, InferHookParameters, InferHookReturnType } from "./hooks.mjs";
-import { WorkerProcess } from "./utils.mjs";
-import { EngineContext, EnvironmentContext, ExecutionContext, PluginContext } from "./context.mjs";
-import { BuildInlineConfig, CleanInlineConfig, DeployInlineConfig, DocsInlineConfig, ExecutionOptions, InlineConfig, LintInlineConfig, NewInlineConfig, PrepareInlineConfig, ResolvedConfig, TestInlineConfig, TypesInlineConfig, UserConfig } from "./config.mjs";
-import { DeepPartial } from "@stryke/types/base";
+import { Context } from "./context.mjs";
+import { MaybePromise } from "@stryke/types/base";
+import { ArrayValues } from "@stryke/types/array";
 
 //#region src/types/api.d.ts
-type BaseAPIFunctions = (typeof BASE_API_FUNCTIONS)[number];
-type APIFunctions = (typeof POWERLINES_API_FUNCTIONS)[number];
+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];
-/**
- * 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: ExecutionOptions;
-  /**
-   * The initial 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. This is typically the user configuration provided in the Powerlines configuration file, but may also include additional configuration options provided by plugins or other sources.
-   */
-  initialConfig: DeepPartial<UserConfig>;
-  /**
-   * 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 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 __ΩBaseAPIFunctions = any[];
-declare type __ΩAPIFunctions = any[];
-declare type __ΩSupportedCommands = any[];
-declare type __ΩExecution = any[];
-declare type __ΩAPI = any[];
-declare type __ΩExecutionWorkerParams = any[];
-declare type __ΩExecutionWorkerProcess = any[];
-declare type __ΩEngine = any[];
 //#endregion
-export { API, APIFunctions, BaseAPIFunctions, Engine, Execution, ExecutionWorkerParams, ExecutionWorkerProcess, SupportedCommands, __ΩAPI, __ΩAPIFunctions, __ΩBaseAPIFunctions, __ΩEngine, __ΩExecution, __ΩExecutionWorkerParams, __ΩExecutionWorkerProcess, __ΩSupportedCommands };
+export { 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":";;;;;;;;;KAiDY,gBAAA,WAA2B,kBAAA;AAAA,KAC3B,YAAA,WAAuB,wBAAA;AAAA,KACvB,iBAAA,WAA4B,kBAAA;;;;AADxC;;;UASiB,SAAA;EAT0C;AAC3D;;;;;AAQA;;EASE,OAAA,GACE,YAAA,EACI,mBAAA,GACA,eAAA,GACA,iBAAA,GACA,iBAAA,GACA,gBAAA,GACA,gBAAA,GACA,kBAAA,KACD,OAAA;EAPC;;;;;;;;EAiBN,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;EAAA;;;;;;;;;EAW5C,GAAA,GAAM,YAAA,EAAc,eAAA,KAAoB,OAAA;EAwClB;;;;;;;;;EA7BtB,KAAA,GACE,YAAA,EAAc,iBAAA,GAAoB,mBAAA,KAC/B,OAAA;EAzCC;;;;;;EAiDN,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EAlDxC;;;;;;EA0DF,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EA7BtB;;;;;;;;;EAwCpB,KAAA,GAAQ,YAAA,EAAc,iBAAA,KAAsB,OAAA;EAnBrC;;;;;;EA2BP,IAAA,GAAO,YAAA,EAAc,gBAAA,KAAqB,OAAA;EARpB;;;;;;;;EAkBtB,MAAA,GAAS,YAAA,EAAc,kBAAA,KAAuB,OAAA;EAArC;;;;;;AAmBX;;EATE,QAAA,QAAgB,OAAA;AAAA;;;;;;;UASD,GAAA,yBACS,cAAA,GAAiB,cAAA,UACjC,SAAA;EAsBqC;;;EAlB7C,OAAA,EAAS,gBAAA,CAAiB,eAAA;EAoBU;;;;;;;;;;;EAPpC,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;EAXJ;;;EAeX,OAAA,EAAS,gBAAA;EAZL;;;EAiBJ,aAAA,EAAe,WAAA,CAAY,UAAA;EAftB;;;EAoBL,YAAA,EAAc,YAAA;AAAA;AAAA,KAGJ,sBAAA,GAAyB,aAAA,CACnC,qBAAA,SACO,wBAAA;;;;UAMQ,MAAA,SAAe,SAAA;EA7B4B;;AAI5D;EA6BE,OAAA,EAAS,aAAA;AAAA;AAAA"}
+{"version":3,"file":"api.d.mts","names":[],"sources":["../../src/types/api.ts"],"mappings":";;;;;;;KA2BY,eAAA,GACR,WAAW,QAAQ,0BAAA;AAAA,KAGX,WAAA,GAAc,WAAW,QAAQ,kBAAA;AAAA,KACjC,QAAA,kBAA0B,OAAA,GAAU,OAAA,IAAW,MAAA,CACzD,WAAA,GACC,IAAA,EAAM,QAAA,KAAa,YAAA;AAAA,KAGV,uBAAA,WACF,0BAA0B;AAAA,KACxB,6BAAA,WACF,qBAAqB;AAAA,KACnB,iBAAA,WAA4B,kBAAkB"}