@powerlines/nx 0.13.233 → 0.13.234

package/dist/src/_virtual/_rolldown/runtime.js

@@ -0,0 +1,28 @@
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule || !__hasOwnProp.call(mod, "default") ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+exports.__toESM = __toESM;

package/dist/src/base/base-executor.d.mts

@@ -0,0 +1,60 @@
+import { BaseExecutorSchema } from "./base-executor.schema.mjs";
+import { ExecutorContext, PromiseExecutor } from "@nx/devkit";
+import { StormWorkspaceConfig } from "@storm-software/config/types";
+import { BaseExecutorResult } from "@storm-software/workspace-tools/types";
+import { DeepPartial } from "@stryke/types/base";
+import { ExecutionOptions, FrameworkOptions, InlineConfig } from "powerlines";
+//#region src/base/base-executor.d.ts
+type PowerlinesExecutorContext<TExecutorSchema extends BaseExecutorSchema = BaseExecutorSchema> = ExecutorContext & {
+  projectName: string;
+  command: string;
+  options: TExecutorSchema;
+  inlineConfig: InlineConfig;
+  workspaceConfig: StormWorkspaceConfig;
+};
+type PowerlinesExecutorApi = (inlineConfig: InlineConfig) => Promise<void>;
+interface WithExecutorOptions {
+  /**
+   * The import path for the executor API module, which is used to dynamically import the API function that will be called during execution. This value should be a string representing the module path, and it defaults to "powerlines/api" if not provided. The specified module should export a default function that matches the expected signature for the executor API, which will be invoked with the execution parameters when the executor is run.
+   *
+   * @defaultValue "powerlines/api"
+   */
+  importPath?: string;
+  /**
+   * Default options to be merged with the execution options, which can be used to provide default values for certain execution parameters or to override specific options for all executions of the executor. This value should be an object that matches the shape of the `ExecutionOptions` type, and it will be merged with the options provided during execution to create the final set of options that will be passed to the executor API function.
+   *
+   * @remarks
+   * This can be useful for setting default values for options that are commonly used across multiple executions, or for providing a consistent set of options for all executions of the executor without requiring the caller to specify them each time.
+   */
+  defaultOptions?: DeepPartial<ExecutionOptions>;
+  /**
+   * Details about the framework being used in the current execution, which can be used by plugins and other parts of the system to customize behavior based on the framework.
+   *
+   * @remarks
+   * This should only be used by framework plugins to ensure the correct framework name is applied
+   *
+   * @defaultValue
+   * ```ts
+   * {
+   *   name: "powerlines",
+   *   orgId: "storm-software"
+   * }
+   * ```
+   */
+  framework?: FrameworkOptions;
+}
+/**
+ * A utility function to create a Powerlines executor that can be used with the `withRunExecutor` function.
+ *
+ * @remarks
+ * This function is designed to simplify the creation of Powerlines executors by providing a consistent interface and error handling.
+ *
+ * @param command - The command that the executor will handle (e.g., "new", "prepare", "build", etc.).
+ * @param executorFn - The function that will be executed when the command is run.
+ * @param options - Additional options for configuring the executor, such as the import path for the API module and default execution options.
+ * @returns A Promise that resolves to the result of the executor function.
+ */
+declare function withExecutor<TExecutorSchema extends BaseExecutorSchema = BaseExecutorSchema>(command: string, executorFn: (context: PowerlinesExecutorContext<TExecutorSchema>, api: PowerlinesExecutorApi) => Promise<BaseExecutorResult | null | undefined> | BaseExecutorResult | null | undefined, options?: WithExecutorOptions): PromiseExecutor<TExecutorSchema>;
+//#endregion
+export { PowerlinesExecutorApi, PowerlinesExecutorContext, WithExecutorOptions, withExecutor };
+//# sourceMappingURL=base-executor.d.mts.map

package/dist/src/base/base-executor.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-executor.d.mts","names":[],"sources":["../../../src/base/base-executor.ts"],"mappings":";;;;;;;KA4CY,0BACV,wBAAwB,qBAAqB,sBAC3C;EACF;EACA;EACA,SAAS;EACT,cAAc;EACd,iBAAiB;;KAGP,yBACV,cAAc,iBACX;UAEY;;;;;;EAMf;;;;;;;EAQA,iBAAiB,YAAY;;;;;;;;;;;;;;;EAgB7B,YAAY;;;;;;;;;;;;;iBAcE,aACd,wBAAwB,qBAAqB,oBAE7C,iBACA,aACE,SAAS,0BAA0B,kBACnC,KAAK,0BAEH,QAAQ,yCACR,uCAGJ,UAAS,sBACR,gBAAgB"}

package/dist/src/base/base-executor.d.ts

@@ -0,0 +1,60 @@
+import { BaseExecutorSchema } from "./base-executor.schema.js";
+import { ExecutorContext, PromiseExecutor } from "@nx/devkit";
+import { StormWorkspaceConfig } from "@storm-software/config/types";
+import { BaseExecutorResult } from "@storm-software/workspace-tools/types";
+import { DeepPartial } from "@stryke/types/base";
+import { ExecutionOptions, FrameworkOptions, InlineConfig } from "powerlines";
+//#region src/base/base-executor.d.ts
+type PowerlinesExecutorContext<TExecutorSchema extends BaseExecutorSchema = BaseExecutorSchema> = ExecutorContext & {
+  projectName: string;
+  command: string;
+  options: TExecutorSchema;
+  inlineConfig: InlineConfig;
+  workspaceConfig: StormWorkspaceConfig;
+};
+type PowerlinesExecutorApi = (inlineConfig: InlineConfig) => Promise<void>;
+interface WithExecutorOptions {
+  /**
+   * The import path for the executor API module, which is used to dynamically import the API function that will be called during execution. This value should be a string representing the module path, and it defaults to "powerlines/api" if not provided. The specified module should export a default function that matches the expected signature for the executor API, which will be invoked with the execution parameters when the executor is run.
+   *
+   * @defaultValue "powerlines/api"
+   */
+  importPath?: string;
+  /**
+   * Default options to be merged with the execution options, which can be used to provide default values for certain execution parameters or to override specific options for all executions of the executor. This value should be an object that matches the shape of the `ExecutionOptions` type, and it will be merged with the options provided during execution to create the final set of options that will be passed to the executor API function.
+   *
+   * @remarks
+   * This can be useful for setting default values for options that are commonly used across multiple executions, or for providing a consistent set of options for all executions of the executor without requiring the caller to specify them each time.
+   */
+  defaultOptions?: DeepPartial<ExecutionOptions>;
+  /**
+   * Details about the framework being used in the current execution, which can be used by plugins and other parts of the system to customize behavior based on the framework.
+   *
+   * @remarks
+   * This should only be used by framework plugins to ensure the correct framework name is applied
+   *
+   * @defaultValue
+   * ```ts
+   * {
+   *   name: "powerlines",
+   *   orgId: "storm-software"
+   * }
+   * ```
+   */
+  framework?: FrameworkOptions;
+}
+/**
+ * A utility function to create a Powerlines executor that can be used with the `withRunExecutor` function.
+ *
+ * @remarks
+ * This function is designed to simplify the creation of Powerlines executors by providing a consistent interface and error handling.
+ *
+ * @param command - The command that the executor will handle (e.g., "new", "prepare", "build", etc.).
+ * @param executorFn - The function that will be executed when the command is run.
+ * @param options - Additional options for configuring the executor, such as the import path for the API module and default execution options.
+ * @returns A Promise that resolves to the result of the executor function.
+ */
+declare function withExecutor<TExecutorSchema extends BaseExecutorSchema = BaseExecutorSchema>(command: string, executorFn: (context: PowerlinesExecutorContext<TExecutorSchema>, api: PowerlinesExecutorApi) => Promise<BaseExecutorResult | null | undefined> | BaseExecutorResult | null | undefined, options?: WithExecutorOptions): PromiseExecutor<TExecutorSchema>;
+//#endregion
+export { PowerlinesExecutorApi, PowerlinesExecutorContext, WithExecutorOptions, withExecutor };
+//# sourceMappingURL=base-executor.d.ts.map

package/dist/src/base/base-executor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-executor.d.ts","names":[],"sources":["../../../src/base/base-executor.ts"],"mappings":";;;;;;;KA4CY,0BACV,wBAAwB,qBAAqB,sBAC3C;EACF;EACA;EACA,SAAS;EACT,cAAc;EACd,iBAAiB;;KAGP,yBACV,cAAc,iBACX;UAEY;;;;;;EAMf;;;;;;;EAQA,iBAAiB,YAAY;;;;;;;;;;;;;;;EAgB7B,YAAY;;;;;;;;;;;;;iBAcE,aACd,wBAAwB,qBAAqB,oBAE7C,iBACA,aACE,SAAS,0BAA0B,kBACnC,KAAK,0BAEH,QAAQ,yCACR,uCAGJ,UAAS,sBACR,gBAAgB"}

package/dist/src/base/base-executor.js

@@ -0,0 +1,118 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('../_virtual/_rolldown/runtime.js');
+let _storm_software_config_tools_logger = require("@storm-software/config-tools/logger");
+let _storm_software_workspace_tools_base_base_executor = require("@storm-software/workspace-tools/base/base-executor");
+let _stryke_helpers_omit = require("@stryke/helpers/omit");
+let _stryke_path_join = require("@stryke/path/join");
+let _stryke_string_format_kebab_case = require("@stryke/string-format/kebab-case");
+let _stryke_string_format_title_case = require("@stryke/string-format/title-case");
+let _stryke_type_checks_is_error = require("@stryke/type-checks/is-error");
+let _stryke_type_checks_is_set = require("@stryke/type-checks/is-set");
+let _stryke_type_checks_is_set_array = require("@stryke/type-checks/is-set-array");
+let _stryke_type_checks_is_set_object = require("@stryke/type-checks/is-set-object");
+let defu = require("defu");
+defu = require_runtime.__toESM(defu);
+let jiti = require("jiti");
+
+//#region src/base/base-executor.ts
+/**
+* A utility function to create a Powerlines executor that can be used with the `withRunExecutor` function.
+*
+* @remarks
+* This function is designed to simplify the creation of Powerlines executors by providing a consistent interface and error handling.
+*
+* @param command - The command that the executor will handle (e.g., "new", "prepare", "build", etc.).
+* @param executorFn - The function that will be executed when the command is run.
+* @param options - Additional options for configuring the executor, such as the import path for the API module and default execution options.
+* @returns A Promise that resolves to the result of the executor function.
+*/
+function withExecutor(command, executorFn, options = {}) {
+	const { importPath = "powerlines/api", defaultOptions = {}, framework = {} } = options;
+	framework.name ??= "powerlines";
+	framework.orgId ??= "storm-software";
+	return (0, _storm_software_workspace_tools_base_base_executor.withRunExecutor)(`${(0, _stryke_string_format_title_case.titleCase)(framework.name)} - ${(0, _stryke_string_format_title_case.titleCase)(command)} executor`, async (options, context, workspaceConfig) => {
+		if (!context.projectName) throw new Error(`The ${(0, _stryke_string_format_title_case.titleCase)(framework.name)} - ${(0, _stryke_string_format_title_case.titleCase)(command)} executor requires \`projectName\` on the context object.`);
+		if (!context.projectName || !context.projectsConfigurations?.projects || !context.projectsConfigurations.projects[context.projectName] || !context.projectsConfigurations.projects[context.projectName]?.root) throw new Error(`The ${(0, _stryke_string_format_title_case.titleCase)(framework.name)} - ${(0, _stryke_string_format_title_case.titleCase)(command)} executor requires \`projectsConfigurations\` on the context object.`);
+		const projectConfig = context.projectsConfigurations.projects[context.projectName];
+		const jiti$1 = (0, jiti.createJiti)(context.root, {
+			cache: false,
+			tsconfigPaths: true
+		});
+		const [{ formatExecutionId, getName }, api] = await Promise.all([jiti$1.import("powerlines/plugin-utils"), jiti$1.import(jiti$1.esmResolve(importPath)).then((mod) => mod.default)]);
+		try {
+			return await Promise.resolve(executorFn((0, defu.default)({
+				projectName: context.projectName,
+				options,
+				workspaceConfig,
+				command,
+				inlineConfig: (0, defu.default)({
+					command,
+					root: projectConfig.root,
+					configFile: options.configFile || options.config,
+					configIndex: options.configIndex,
+					projectType: projectConfig.projectType,
+					mode: options.mode,
+					output: {
+						path: options.outputPath,
+						copy: options.copyPath === false ? false : {
+							path: options.copyPath,
+							assets: options.assets
+						},
+						minify: options.minify,
+						sourceMap: options.sourceMap
+					},
+					resolve: (0, _stryke_type_checks_is_set_array.isSetArray)(options.external) || (0, _stryke_type_checks_is_set_array.isSetArray)(options.noExternal) || (0, _stryke_type_checks_is_set.isSet)(options.skipNodeModulesBundle) ? {
+						external: (0, _stryke_type_checks_is_set_array.isSetArray)(options.external) ? options.external : void 0,
+						noExternal: (0, _stryke_type_checks_is_set_array.isSetArray)(options.noExternal) ? options.noExternal : void 0,
+						skipNodeModulesBundle: (0, _stryke_type_checks_is_set.isSet)(options.skipNodeModulesBundle) ? options.skipNodeModulesBundle : void 0
+					} : void 0,
+					define: (0, _stryke_type_checks_is_set_object.isSetObject)(options.define) ? options.define : void 0,
+					assets: (0, _stryke_type_checks_is_set_object.isSetObject)(options.assets) ? options.assets : void 0
+				}, (0, _stryke_helpers_omit.omit)(options, [
+					"config",
+					"configFile",
+					"outputPath",
+					"copyPath",
+					"sourceMap",
+					"minify",
+					"format",
+					"external",
+					"noExternal",
+					"skipNodeModulesBundle",
+					"mode",
+					"define",
+					"assets"
+				]))
+			}, context), async (inlineConfig) => {
+				const name = inlineConfig.name || context.projectName || await getName(context.root, projectConfig.root);
+				return api({
+					options: (0, defu.default)(defaultOptions, {
+						name,
+						executionId: formatExecutionId(name, command, options.configIndex ?? 0),
+						cwd: context.root,
+						root: projectConfig.root,
+						configFile: options.configFile || options.config || (0, _stryke_path_join.joinPaths)(projectConfig.root, `${(0, _stryke_string_format_kebab_case.kebabCase)(framework.name)}.config.ts`),
+						configIndex: options.configIndex,
+						framework
+					}),
+					command,
+					inlineConfig
+				});
+			}));
+		} catch (error) {
+			(0, _storm_software_config_tools_logger.writeError)(`An error occurred while executing the ${(0, _stryke_string_format_title_case.titleCase)(framework.name)} - ${(0, _stryke_string_format_title_case.titleCase)(command)} executor: ${(0, _stryke_type_checks_is_error.isError)(error) ? `${error.message}
+
+${error.stack}` : "Unknown error"}`);
+			return { success: false };
+		}
+	}, {
+		skipReadingConfig: false,
+		hooks: { applyDefaultOptions: (options) => {
+			options.copyPath ??= "dist/{projectRoot}";
+			return options;
+		} }
+	});
+}
+
+//#endregion
+exports.withExecutor = withExecutor;

package/dist/src/base/base-executor.mjs

@@ -0,0 +1,116 @@
+import { writeError } from "@storm-software/config-tools/logger";
+import { withRunExecutor } from "@storm-software/workspace-tools/base/base-executor";
+import { omit } from "@stryke/helpers/omit";
+import { joinPaths } from "@stryke/path/join";
+import { kebabCase } from "@stryke/string-format/kebab-case";
+import { titleCase } from "@stryke/string-format/title-case";
+import { isError } from "@stryke/type-checks/is-error";
+import { isSet } from "@stryke/type-checks/is-set";
+import { isSetArray } from "@stryke/type-checks/is-set-array";
+import { isSetObject } from "@stryke/type-checks/is-set-object";
+import defu from "defu";
+import { createJiti } from "jiti";
+
+//#region src/base/base-executor.ts
+/**
+* A utility function to create a Powerlines executor that can be used with the `withRunExecutor` function.
+*
+* @remarks
+* This function is designed to simplify the creation of Powerlines executors by providing a consistent interface and error handling.
+*
+* @param command - The command that the executor will handle (e.g., "new", "prepare", "build", etc.).
+* @param executorFn - The function that will be executed when the command is run.
+* @param options - Additional options for configuring the executor, such as the import path for the API module and default execution options.
+* @returns A Promise that resolves to the result of the executor function.
+*/
+function withExecutor(command, executorFn, options = {}) {
+	const { importPath = "powerlines/api", defaultOptions = {}, framework = {} } = options;
+	framework.name ??= "powerlines";
+	framework.orgId ??= "storm-software";
+	return withRunExecutor(`${titleCase(framework.name)} - ${titleCase(command)} executor`, async (options, context, workspaceConfig) => {
+		if (!context.projectName) throw new Error(`The ${titleCase(framework.name)} - ${titleCase(command)} executor requires \`projectName\` on the context object.`);
+		if (!context.projectName || !context.projectsConfigurations?.projects || !context.projectsConfigurations.projects[context.projectName] || !context.projectsConfigurations.projects[context.projectName]?.root) throw new Error(`The ${titleCase(framework.name)} - ${titleCase(command)} executor requires \`projectsConfigurations\` on the context object.`);
+		const projectConfig = context.projectsConfigurations.projects[context.projectName];
+		const jiti = createJiti(context.root, {
+			cache: false,
+			tsconfigPaths: true
+		});
+		const [{ formatExecutionId, getName }, api] = await Promise.all([jiti.import("powerlines/plugin-utils"), jiti.import(jiti.esmResolve(importPath)).then((mod) => mod.default)]);
+		try {
+			return await Promise.resolve(executorFn(defu({
+				projectName: context.projectName,
+				options,
+				workspaceConfig,
+				command,
+				inlineConfig: defu({
+					command,
+					root: projectConfig.root,
+					configFile: options.configFile || options.config,
+					configIndex: options.configIndex,
+					projectType: projectConfig.projectType,
+					mode: options.mode,
+					output: {
+						path: options.outputPath,
+						copy: options.copyPath === false ? false : {
+							path: options.copyPath,
+							assets: options.assets
+						},
+						minify: options.minify,
+						sourceMap: options.sourceMap
+					},
+					resolve: isSetArray(options.external) || isSetArray(options.noExternal) || isSet(options.skipNodeModulesBundle) ? {
+						external: isSetArray(options.external) ? options.external : void 0,
+						noExternal: isSetArray(options.noExternal) ? options.noExternal : void 0,
+						skipNodeModulesBundle: isSet(options.skipNodeModulesBundle) ? options.skipNodeModulesBundle : void 0
+					} : void 0,
+					define: isSetObject(options.define) ? options.define : void 0,
+					assets: isSetObject(options.assets) ? options.assets : void 0
+				}, omit(options, [
+					"config",
+					"configFile",
+					"outputPath",
+					"copyPath",
+					"sourceMap",
+					"minify",
+					"format",
+					"external",
+					"noExternal",
+					"skipNodeModulesBundle",
+					"mode",
+					"define",
+					"assets"
+				]))
+			}, context), async (inlineConfig) => {
+				const name = inlineConfig.name || context.projectName || await getName(context.root, projectConfig.root);
+				return api({
+					options: defu(defaultOptions, {
+						name,
+						executionId: formatExecutionId(name, command, options.configIndex ?? 0),
+						cwd: context.root,
+						root: projectConfig.root,
+						configFile: options.configFile || options.config || joinPaths(projectConfig.root, `${kebabCase(framework.name)}.config.ts`),
+						configIndex: options.configIndex,
+						framework
+					}),
+					command,
+					inlineConfig
+				});
+			}));
+		} catch (error) {
+			writeError(`An error occurred while executing the ${titleCase(framework.name)} - ${titleCase(command)} executor: ${isError(error) ? `${error.message}
+
+${error.stack}` : "Unknown error"}`);
+			return { success: false };
+		}
+	}, {
+		skipReadingConfig: false,
+		hooks: { applyDefaultOptions: (options) => {
+			options.copyPath ??= "dist/{projectRoot}";
+			return options;
+		} }
+	});
+}
+
+//#endregion
+export { withExecutor };
+//# sourceMappingURL=base-executor.mjs.map

package/dist/src/base/base-executor.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-executor.mjs","names":[],"sources":["../../../src/base/base-executor.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 type { ExecutorContext, PromiseExecutor } from \"@nx/devkit\";\nimport { writeError } from \"@storm-software/config-tools/logger\";\nimport type { StormWorkspaceConfig } from \"@storm-software/config/types\";\nimport { withRunExecutor } from \"@storm-software/workspace-tools/base/base-executor\";\nimport type { BaseExecutorResult } from \"@storm-software/workspace-tools/types\";\nimport { omit } from \"@stryke/helpers/omit\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { kebabCase } from \"@stryke/string-format/kebab-case\";\nimport { titleCase } from \"@stryke/string-format/title-case\";\nimport { isError } from \"@stryke/type-checks/is-error\";\nimport { isSet } from \"@stryke/type-checks/is-set\";\nimport { isSetArray } from \"@stryke/type-checks/is-set-array\";\nimport { isSetObject } from \"@stryke/type-checks/is-set-object\";\nimport type { DeepPartial } from \"@stryke/types/base\";\nimport defu from \"defu\";\nimport { createJiti } from \"jiti\";\nimport type {\n  ExecutionApiParams,\n  ExecutionOptions,\n  FrameworkOptions,\n  InlineConfig,\n  Mode,\n  OutputConfig\n} from \"powerlines\";\nimport type { BaseExecutorSchema } from \"./base-executor.schema\";\n\nexport type PowerlinesExecutorContext<\n  TExecutorSchema extends BaseExecutorSchema = BaseExecutorSchema\n> = ExecutorContext & {\n  projectName: string;\n  command: string;\n  options: TExecutorSchema;\n  inlineConfig: InlineConfig;\n  workspaceConfig: StormWorkspaceConfig;\n};\n\nexport type PowerlinesExecutorApi = (\n  inlineConfig: InlineConfig\n) => Promise<void>;\n\nexport interface WithExecutorOptions {\n  /**\n   * The import path for the executor API module, which is used to dynamically import the API function that will be called during execution. This value should be a string representing the module path, and it defaults to \"powerlines/api\" if not provided. The specified module should export a default function that matches the expected signature for the executor API, which will be invoked with the execution parameters when the executor is run.\n   *\n   * @defaultValue \"powerlines/api\"\n   */\n  importPath?: string;\n\n  /**\n   * Default options to be merged with the execution options, which can be used to provide default values for certain execution parameters or to override specific options for all executions of the executor. This value should be an object that matches the shape of the `ExecutionOptions` type, and it will be merged with the options provided during execution to create the final set of options that will be passed to the executor API function.\n   *\n   * @remarks\n   * This can be useful for setting default values for options that are commonly used across multiple executions, or for providing a consistent set of options for all executions of the executor without requiring the caller to specify them each time.\n   */\n  defaultOptions?: DeepPartial<ExecutionOptions>;\n\n  /**\n   * Details about the framework being used in the current execution, which can be used by plugins and other parts of the system to customize behavior based on the framework.\n   *\n   * @remarks\n   * This should only be used by framework plugins to ensure the correct framework name is applied\n   *\n   * @defaultValue\n   * ```ts\n   * {\n   *   name: \"powerlines\",\n   *   orgId: \"storm-software\"\n   * }\n   * ```\n   */\n  framework?: FrameworkOptions;\n}\n\n/**\n * A utility function to create a Powerlines executor that can be used with the `withRunExecutor` function.\n *\n * @remarks\n * This function is designed to simplify the creation of Powerlines executors by providing a consistent interface and error handling.\n *\n * @param command - The command that the executor will handle (e.g., \"new\", \"prepare\", \"build\", etc.).\n * @param executorFn - The function that will be executed when the command is run.\n * @param options - Additional options for configuring the executor, such as the import path for the API module and default execution options.\n * @returns A Promise that resolves to the result of the executor function.\n */\nexport function withExecutor<\n  TExecutorSchema extends BaseExecutorSchema = BaseExecutorSchema\n>(\n  command: string,\n  executorFn: (\n    context: PowerlinesExecutorContext<TExecutorSchema>,\n    api: PowerlinesExecutorApi\n  ) =>\n    | Promise<BaseExecutorResult | null | undefined>\n    | BaseExecutorResult\n    | null\n    | undefined,\n  options: WithExecutorOptions = {}\n): PromiseExecutor<TExecutorSchema> {\n  const {\n    importPath = \"powerlines/api\",\n    defaultOptions = {},\n    framework = {} as FrameworkOptions\n  } = options;\n\n  framework.name ??= \"powerlines\";\n  framework.orgId ??= \"storm-software\";\n\n  return withRunExecutor(\n    `${titleCase(framework.name)} - ${titleCase(command)} executor`,\n    async (\n      options: TExecutorSchema,\n      context: ExecutorContext,\n      workspaceConfig: StormWorkspaceConfig\n    ): Promise<BaseExecutorResult | null | undefined> => {\n      if (!context.projectName) {\n        throw new Error(\n          `The ${titleCase(framework.name)} - ${titleCase(\n            command\n          )} executor requires \\`projectName\\` on the context object.`\n        );\n      }\n\n      if (\n        !context.projectName ||\n        !context.projectsConfigurations?.projects ||\n        !context.projectsConfigurations.projects[context.projectName] ||\n        !context.projectsConfigurations.projects[context.projectName]?.root\n      ) {\n        throw new Error(\n          `The ${titleCase(framework.name)} - ${titleCase(\n            command\n          )} executor requires \\`projectsConfigurations\\` on the context object.`\n        );\n      }\n\n      const projectConfig =\n        context.projectsConfigurations.projects[context.projectName]!;\n\n      const jiti = createJiti(context.root, {\n        cache: false,\n        tsconfigPaths: true\n      });\n      // Load via jiti — static require() of powerlines/plugin-utils fails when Nx\n      // registers ts-node + tsconfig paths (maps to ESM .ts source under type:module).\n      const [{ formatExecutionId, getName }, api] = await Promise.all([\n        jiti.import<{\n          formatExecutionId: (\n            projectName: string,\n            command: string,\n            configIndex?: number\n          ) => string;\n          getName: (cwd: string, root: string) => Promise<string>;\n        }>(\"powerlines/plugin-utils\"),\n        jiti\n          .import<{\n            default: (params: ExecutionApiParams) => Promise<void>;\n          }>(jiti.esmResolve(importPath))\n          .then(mod => mod.default)\n      ]);\n\n      try {\n        return await Promise.resolve(\n          executorFn(\n            defu(\n              {\n                projectName: context.projectName,\n                options,\n                workspaceConfig,\n                command,\n                inlineConfig: defu(\n                  {\n                    command,\n                    root: projectConfig.root,\n                    configFile: options.configFile || options.config,\n                    configIndex: options.configIndex,\n                    projectType: projectConfig.projectType,\n                    mode: options.mode as Mode,\n                    output: {\n                      path: options.outputPath,\n                      copy:\n                        options.copyPath === false\n                          ? false\n                          : {\n                              path: options.copyPath,\n                              assets: options.assets\n                            },\n                      minify: options.minify,\n                      sourceMap: options.sourceMap\n                    } as OutputConfig,\n                    resolve:\n                      isSetArray(options.external) ||\n                      isSetArray(options.noExternal) ||\n                      isSet(options.skipNodeModulesBundle)\n                        ? {\n                            external: isSetArray(options.external)\n                              ? options.external\n                              : undefined,\n                            noExternal: isSetArray(options.noExternal)\n                              ? options.noExternal\n                              : undefined,\n                            skipNodeModulesBundle: isSet(\n                              options.skipNodeModulesBundle\n                            )\n                              ? options.skipNodeModulesBundle\n                              : undefined\n                          }\n                        : undefined,\n                    define: isSetObject(options.define)\n                      ? options.define\n                      : undefined,\n                    assets: isSetObject(options.assets)\n                      ? options.assets\n                      : undefined\n                  },\n                  omit(options, [\n                    \"config\",\n                    \"configFile\",\n                    \"outputPath\",\n                    \"copyPath\",\n                    \"sourceMap\",\n                    \"minify\",\n                    \"format\",\n                    \"external\",\n                    \"noExternal\",\n                    \"skipNodeModulesBundle\",\n                    \"mode\",\n                    \"define\",\n                    \"assets\"\n                  ])\n                ) as InlineConfig\n              },\n              context\n            ),\n            async (inlineConfig: InlineConfig) => {\n              const name =\n                inlineConfig.name ||\n                context.projectName ||\n                (await getName(context.root, projectConfig.root));\n\n              return api({\n                options: defu(defaultOptions, {\n                  name,\n                  executionId: formatExecutionId(\n                    name,\n                    command,\n                    options.configIndex ?? 0\n                  ),\n                  cwd: context.root,\n                  root: projectConfig.root,\n                  configFile:\n                    options.configFile ||\n                    options.config ||\n                    joinPaths(\n                      projectConfig.root,\n                      `${kebabCase(framework.name)}.config.ts`\n                    ),\n                  configIndex: options.configIndex,\n                  framework\n                }) as ExecutionOptions,\n                command,\n                inlineConfig\n              });\n            }\n          )\n        );\n      } catch (error) {\n        writeError(\n          `An error occurred while executing the ${titleCase(\n            framework.name\n          )} - ${titleCase(command)} executor: ${\n            isError(error)\n              ? `${error.message}\n\n${error.stack}`\n              : \"Unknown error\"\n          }`\n        );\n\n        return { success: false };\n      }\n    },\n    {\n      skipReadingConfig: false,\n      hooks: {\n        applyDefaultOptions: (options: Partial<TExecutorSchema>) => {\n          options.copyPath ??= \"dist/{projectRoot}\";\n\n          return options as TExecutorSchema;\n        }\n      }\n    }\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAsGA,SAAgB,aAGd,SACA,YAQA,UAA+B,CAAC,GACE;CAClC,MAAM,EACJ,aAAa,kBACb,iBAAiB,CAAC,GAClB,YAAY,CAAC,MACX;CAEJ,UAAU,SAAS;CACnB,UAAU,UAAU;CAEpB,OAAO,gBACL,GAAG,UAAU,UAAU,IAAI,EAAE,KAAK,UAAU,OAAO,EAAE,YACrD,OACE,SACA,SACA,oBACmD;EACnD,IAAI,CAAC,QAAQ,aACX,MAAM,IAAI,MACR,OAAO,UAAU,UAAU,IAAI,EAAE,KAAK,UACpC,OACF,EAAE,0DACJ;EAGF,IACE,CAAC,QAAQ,eACT,CAAC,QAAQ,wBAAwB,YACjC,CAAC,QAAQ,uBAAuB,SAAS,QAAQ,gBACjD,CAAC,QAAQ,uBAAuB,SAAS,QAAQ,YAAY,EAAE,MAE/D,MAAM,IAAI,MACR,OAAO,UAAU,UAAU,IAAI,EAAE,KAAK,UACpC,OACF,EAAE,qEACJ;EAGF,MAAM,gBACJ,QAAQ,uBAAuB,SAAS,QAAQ;EAElD,MAAM,OAAO,WAAW,QAAQ,MAAM;GACpC,OAAO;GACP,eAAe;EACjB,CAAC;EAGD,MAAM,CAAC,EAAE,mBAAmB,WAAW,OAAO,MAAM,QAAQ,IAAI,CAC9D,KAAK,OAOF,yBAAyB,GAC5B,KACG,OAEE,KAAK,WAAW,UAAU,CAAC,CAAC,CAC9B,MAAK,QAAO,IAAI,OAAO,CAC5B,CAAC;EAED,IAAI;GACF,OAAO,MAAM,QAAQ,QACnB,WACE,KACE;IACE,aAAa,QAAQ;IACrB;IACA;IACA;IACA,cAAc,KACZ;KACE;KACA,MAAM,cAAc;KACpB,YAAY,QAAQ,cAAc,QAAQ;KAC1C,aAAa,QAAQ;KACrB,aAAa,cAAc;KAC3B,MAAM,QAAQ;KACd,QAAQ;MACN,MAAM,QAAQ;MACd,MACE,QAAQ,aAAa,QACjB,QACA;OACE,MAAM,QAAQ;OACd,QAAQ,QAAQ;MAClB;MACN,QAAQ,QAAQ;MAChB,WAAW,QAAQ;KACrB;KACA,SACE,WAAW,QAAQ,QAAQ,KAC3B,WAAW,QAAQ,UAAU,KAC7B,MAAM,QAAQ,qBAAqB,IAC/B;MACE,UAAU,WAAW,QAAQ,QAAQ,IACjC,QAAQ,WACR;MACJ,YAAY,WAAW,QAAQ,UAAU,IACrC,QAAQ,aACR;MACJ,uBAAuB,MACrB,QAAQ,qBACV,IACI,QAAQ,wBACR;KACN,IACA;KACN,QAAQ,YAAY,QAAQ,MAAM,IAC9B,QAAQ,SACR;KACJ,QAAQ,YAAY,QAAQ,MAAM,IAC9B,QAAQ,SACR;IACN,GACA,KAAK,SAAS;KACZ;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;KACA;IACF,CAAC,CACH;GACF,GACA,OACF,GACA,OAAO,iBAA+B;IACpC,MAAM,OACJ,aAAa,QACb,QAAQ,eACP,MAAM,QAAQ,QAAQ,MAAM,cAAc,IAAI;IAEjD,OAAO,IAAI;KACT,SAAS,KAAK,gBAAgB;MAC5B;MACA,aAAa,kBACX,MACA,SACA,QAAQ,eAAe,CACzB;MACA,KAAK,QAAQ;MACb,MAAM,cAAc;MACpB,YACE,QAAQ,cACR,QAAQ,UACR,UACE,cAAc,MACd,GAAG,UAAU,UAAU,IAAI,EAAE,WAC/B;MACF,aAAa,QAAQ;MACrB;KACF,CAAC;KACD;KACA;IACF,CAAC;GACH,CACF,CACF;EACF,SAAS,OAAO;GACd,WACE,yCAAyC,UACvC,UAAU,IACZ,EAAE,KAAK,UAAU,OAAO,EAAE,aACxB,QAAQ,KAAK,IACT,GAAG,MAAM,QAAQ;;EAE/B,MAAM,UACQ,iBAER;GAEA,OAAO,EAAE,SAAS,MAAM;EAC1B;CACF,GACA;EACE,mBAAmB;EACnB,OAAO,EACL,sBAAsB,YAAsC;GAC1D,QAAQ,aAAa;GAErB,OAAO;EACT,EACF;CACF,CACF;AACF"}

package/dist/src/base/base-executor.schema.d.mts

@@ -0,0 +1,167 @@
+//#region src/base/base-executor.schema.d.ts
+// Generated by @storm-software/untyped
+// Do not edit this file directly
+interface BaseExecutorSchema {
+  /**
+   * Powerlines Configuration File
+   *
+   * The path to the Powerlines configuration file. Alias for `configFile`.
+   *
+   *
+   * @format path
+   */
+  config?: string;
+  /**
+   * Powerlines Configuration File
+   *
+   * The path to the Powerlines configuration file. Alias for `config`.
+   *
+   *
+   * @format path
+   */
+  configFile?: string;
+  /**
+   * Powerlines Configuration Index
+   *
+   * The index in the Powerlines configuration file to use (if an array of configurations are provided).
+   *
+   * @default 0
+   */
+  configIndex?: number;
+  /**
+   * Input Entry File(s)
+   *
+   * The entry file(s) that serve as the input for the project
+   *
+   *
+   * @format path
+   */
+  input?: Array<string>;
+  /**
+   * TSConfig Path
+   *
+   * The path to the tsconfig file
+   *
+   *
+   * @format path
+   */
+  tsconfig?: string;
+  /**
+   * Output Path
+   *
+   * The path to the output directory for the build artifacts
+   *
+   *
+   * @format path
+   */
+  outputPath?: string;
+  /**
+   * Copy Path
+   *
+   * A directory path to copy the build artifacts into
+   *
+   *
+   * @oneOf [object Object],[object Object]
+   */
+  copyPath?: any;
+  /**
+   * Sourcemap
+   *
+   * Generate a sourcemap
+   *
+   */
+  sourceMap?: boolean;
+  /**
+   * Minify
+   *
+   * Minify the output
+   *
+   */
+  minify?: boolean;
+  /**
+   * Format
+   *
+   * The format to build
+   *
+   * @default ["cjs","esm"]
+   */
+  format?: Array<string>;
+  /**
+   * Platform
+   *
+   * The platform to build
+   *
+   *
+   * @enum neutral,node,browser
+   */
+  platform?: string;
+  /**
+   * External
+   *
+   * The external dependencies
+   *
+   */
+  external?: Array<any>;
+  /**
+   * No External
+   *
+   * The dependencies that should not be treated as external
+   *
+   */
+  noExternal?: Array<any>;
+  /**
+   * Skip Node Modules Bundle
+   *
+   * Skip bundling node_modules during the build process (if required)
+   *
+   */
+  skipNodeModulesBundle?: boolean;
+  /**
+   * Mode
+   *
+   * The build mode
+   *
+   *
+   * @enum development,test,production
+   */
+  mode?: string;
+  /**
+   * Log Level
+   *
+   * The log level to use for the build process
+   *
+   *
+   * @enum fatal,error,warn,success,info,debug,trace,silent
+   */
+  logLevel?: string;
+  /**
+   * Define
+   *
+   * The `define` values
+   *
+   */
+  define?: Record<string, string>;
+  /**
+   * Assets
+   *
+   * The `assets` values
+   *
+   */
+  assets?: Array<{
+    input?: string;
+    output?: string;
+    glob: string;
+    ignore?: string[];
+    dot?: boolean;
+  }>;
+  /**
+   * Additional Arguments
+   *
+   * The additional arguments provided during execution of the command
+   *
+   */
+  additionalArgs?: Record<string, string>;
+}
+//#endregion
+export { BaseExecutorSchema };
+//# sourceMappingURL=base-executor.schema.d.mts.map

package/dist/src/base/base-executor.schema.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-executor.schema.d.mts","names":[],"sources":["../../../src/base/base-executor.schema.d.ts"],"mappings":";;;UAIiB;;;;;;;;;EAShB;;;;;;;;;EAUA;;;;;;;;EASA;;;;;;;;;EAUA,QAAQ;;;;;;;;;EAUR;;;;;;;;;EAUA;;;;;;;;;EAUA;;;;;;;EAQA;;;;;;;EAQA;;;;;;;;EASA,SAAS;;;;;;;;;EAUT;;;;;;;EAQA,WAAW;;;;;;;EAQX,aAAa;;;;;;;EAQb;;;;;;;;;EAUA;;;;;;;;;EAUA;;;;;;;EAQA,SAAS;;;;;;;EAQT,SAAS;IAAQ;IAAgB;IAAiB;IAAc;IAAmB;;;;;;;;EAQnF,iBAAiB"}