@shell-shock/core 0.17.10 → 0.17.11

package/dist/api.cjs

@@ -1,148 +1,36 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_runtime = require('./_virtual/_rolldown/runtime.cjs');
+const require_package = require('./package.cjs');
 const require_plugin = require('./plugin.cjs');
-let powerlines_api = require("powerlines/api");
+let powerlines_api_build = require("powerlines/api/build");
+let powerlines_api_clean = require("powerlines/api/clean");
+let powerlines_api_create = require("powerlines/api/create");
+let powerlines_api_deploy = require("powerlines/api/deploy");
+let powerlines_api_docs = require("powerlines/api/docs");
+let powerlines_api_lint = require("powerlines/api/lint");
+let powerlines_api_prepare = require("powerlines/api/prepare");
+let powerlines_api_test = require("powerlines/api/test");
+let powerlines_api_types = require("powerlines/api/types");
+let powerlines_helpers = require("powerlines/helpers");
 
 //#region src/api.ts
-/**
-* The Shell Shock API class.
-*
-* @remarks
-* This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.
-*/
-var ShellShockAPI = class ShellShockAPI {
-	#powerlines;
-	/**
-	* Creates a new instance of the {@link ShellShockAPI} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.
-	*
-	* @param options - The user configuration options.
-	* @returns A promise that resolves to a {@link ShellShockAPI} instance.
-	*/
-	static async from(options) {
-		const { name, root, cwd, mode, logLevel, organization, configFile, ...pluginOptions } = options;
-		return new ShellShockAPI(await powerlines_api.PowerlinesAPI.from({
-			name,
-			root,
-			cwd: cwd || process.cwd(),
-			mode,
-			logLevel,
-			organization,
-			configFile,
-			framework: "shell-shock"
-		}, {
-			plugins: [require_plugin.default(pluginOptions)],
-			framework: "shell-shock"
-		}));
-	}
-	/**
-	* Gets the current build context, which includes information about the project, environment, and configuration. This context is used internally by the Shell Shock API to manage the build process and provide relevant data to plugins and other components.
-	*
-	* @returns The current build context.
-	*/
-	get context() {
-		return this.#powerlines.context;
-	}
-	constructor(powerlines) {
-		this.#powerlines = powerlines;
-	}
-	/**
-	* Executes the clean phase of the build process, which typically involves removing generated files and resetting the build environment. The `inlineConfig` parameter allows users to specify additional options or overrides for the clean operation.
-	*
-	* @param inlineConfig - The inline configuration options for the clean operation.
-	* @returns A promise that resolves when the clean operation is complete.
-	*/
-	async clean(inlineConfig) {
-		return this.#powerlines.clean(inlineConfig);
-	}
-	/**
-	* Executes the prepare phase of the build process, which typically involves setting up the build environment and installing dependencies. The `inlineConfig` parameter allows users to specify additional options or overrides for the prepare operation.
-	*
-	* @param inlineConfig - The inline configuration options for the prepare operation.
-	* @returns A promise that resolves when the prepare operation is complete.
-	*/
-	async prepare(inlineConfig) {
-		return this.#powerlines.prepare(inlineConfig);
-	}
-	/**
-	* Executes the lint phase of the build process, which typically involves analyzing code for quality and style issues. The `inlineConfig` parameter allows users to specify additional options or overrides for the lint operation.
-	*
-	* @param inlineConfig - The inline configuration options for the lint operation.
-	* @returns A promise that resolves when the lint operation is complete.
-	*/
-	async lint(inlineConfig) {
-		return this.#powerlines.lint(inlineConfig);
-	}
-	/**
-	* Executes the build phase of the build process, which typically involves compiling source code and generating output artifacts. The `inlineConfig` parameter allows users to specify additional options or overrides for the build operation.
-	*
-	* @param inlineConfig - The inline configuration options for the build operation.
-	* @returns A promise that resolves when the build operation is complete.
-	*/
-	async build(inlineConfig) {
-		return this.#powerlines.build(inlineConfig);
-	}
-	/**
-	* Executes the documentation generation phase of the build process, which typically involves creating API documentation and other project documentation. The `inlineConfig` parameter allows users to specify additional options or overrides for the documentation operation.
-	*
-	* @param inlineConfig - The inline configuration options for the documentation operation.
-	* @returns A promise that resolves when the documentation generation is complete.
-	*/
-	async docs(inlineConfig) {
-		return this.#powerlines.docs(inlineConfig);
-	}
-	/**
-	* Executes the finalize phase of the build process, which typically involves cleanup tasks and final reporting. This method should be called after all other build phases have completed.
-	*
-	* @returns A promise that resolves when the finalize operation is complete.
-	*/
-	async finalize() {
-		return this.#powerlines.finalize();
-	}
-	static __type = [
-		"#powerlines",
-		"EngineOptions",
-		"options",
-		() => ShellShockAPI,
-		"from",
-		"Creates a new instance of the {@link ShellShockAPI} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.",
-		"powerlines",
-		"constructor",
-		"inlineConfig",
-		"clean",
-		"Executes the clean phase of the build process, which typically involves removing generated files and resetting the build environment. The `inlineConfig` parameter allows users to specify additional options or overrides for the clean operation.",
-		"prepare",
-		"Executes the prepare phase of the build process, which typically involves setting up the build environment and installing dependencies. The `inlineConfig` parameter allows users to specify additional options or overrides for the prepare operation.",
-		"lint",
-		"Executes the lint phase of the build process, which typically involves analyzing code for quality and style issues. The `inlineConfig` parameter allows users to specify additional options or overrides for the lint operation.",
-		"build",
-		"Executes the build phase of the build process, which typically involves compiling source code and generating output artifacts. The `inlineConfig` parameter allows users to specify additional options or overrides for the build operation.",
-		"docs",
-		"Executes the documentation generation phase of the build process, which typically involves creating API documentation and other project documentation. The `inlineConfig` parameter allows users to specify additional options or overrides for the documentation operation.",
-		"finalize",
-		"Executes the finalize phase of the build process, which typically involves cleanup tasks and final reporting. This method should be called after all other build phases have completed.",
-		"ShellShockAPI",
-		"The Shell Shock API class.",
-		"!3!P\"w\"2#P7$`0%s?&!P!2'\"0(P!2)$`0*?+P!2)$`0,?-P!2)$`0.?/P!2)$`00?1P!2)$`02?3P$`04?55w6?7"
-	];
-};
-/**
-* Creates a new {@link ShellShockAPI} instance.
-*
-* @param options - The user configuration options.
-* @returns A promise that resolves to a {@link ShellShockAPI} instance.
-*/
-async function createShellShock(options) {
-	return ShellShockAPI.from(options);
-}
-createShellShock.__type = [
-	"EngineOptions",
-	"options",
-	() => ShellShockAPI,
-	"createShellShock",
-	"Creates a new {@link ShellShockAPI} instance.",
-	"P\"w!2\"P7#`/$?%"
-];
+var api_default = (0, powerlines_helpers.createApi)({
+	types: powerlines_api_types.types,
+	prepare: powerlines_api_prepare.prepare,
+	create: powerlines_api_create.create,
+	clean: powerlines_api_clean.clean,
+	lint: powerlines_api_lint.lint,
+	test: powerlines_api_test.test,
+	build: powerlines_api_build.build,
+	docs: powerlines_api_docs.docs,
+	deploy: powerlines_api_deploy.deploy
+}, {
+	plugins: [require_plugin.default()],
+	framework: {
+		name: "shell-shock",
+		version: require_package.version,
+		orgId: "storm-software"
+	}
+});
 
 //#endregion
-exports.ShellShockAPI = ShellShockAPI;
-exports.createShellShock = createShellShock;
+module.exports = api_default;
+//# sourceMappingURL=api.cjs.map

package/dist/api.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.cjs","names":[],"sources":[],"mappings":""}

package/dist/api.d.cts

@@ -1,79 +1,4 @@
-import { EngineOptions as EngineOptions$1 } from "./types/config.cjs";
-import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, LintInlineConfig, PrepareInlineConfig } from "powerlines";
-import { PowerlinesExecutionContext } from "powerlines/context";
-
 //#region src/api.d.ts
-/**
- * The Shell Shock API class.
- *
- * @remarks
- * This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.
- */
-declare class ShellShockAPI {
-  #private;
-  /**
-   * Creates a new instance of the {@link ShellShockAPI} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.
-   *
-   * @param options - The user configuration options.
-   * @returns A promise that resolves to a {@link ShellShockAPI} instance.
-   */
-  static from(options: EngineOptions$1): Promise<ShellShockAPI>;
-  /**
-   * Gets the current build context, which includes information about the project, environment, and configuration. This context is used internally by the Shell Shock API to manage the build process and provide relevant data to plugins and other components.
-   *
-   * @returns The current build context.
-   */
-  get context(): PowerlinesExecutionContext;
-  private constructor();
-  /**
-   * Executes the clean phase of the build process, which typically involves removing generated files and resetting the build environment. The `inlineConfig` parameter allows users to specify additional options or overrides for the clean operation.
-   *
-   * @param inlineConfig - The inline configuration options for the clean operation.
-   * @returns A promise that resolves when the clean operation is complete.
-   */
-  clean(inlineConfig: CleanInlineConfig): Promise<void>;
-  /**
-   * Executes the prepare phase of the build process, which typically involves setting up the build environment and installing dependencies. The `inlineConfig` parameter allows users to specify additional options or overrides for the prepare operation.
-   *
-   * @param inlineConfig - The inline configuration options for the prepare operation.
-   * @returns A promise that resolves when the prepare operation is complete.
-   */
-  prepare(inlineConfig: PrepareInlineConfig): Promise<void>;
-  /**
-   * Executes the lint phase of the build process, which typically involves analyzing code for quality and style issues. The `inlineConfig` parameter allows users to specify additional options or overrides for the lint operation.
-   *
-   * @param inlineConfig - The inline configuration options for the lint operation.
-   * @returns A promise that resolves when the lint operation is complete.
-   */
-  lint(inlineConfig: LintInlineConfig): Promise<void>;
-  /**
-   * Executes the build phase of the build process, which typically involves compiling source code and generating output artifacts. The `inlineConfig` parameter allows users to specify additional options or overrides for the build operation.
-   *
-   * @param inlineConfig - The inline configuration options for the build operation.
-   * @returns A promise that resolves when the build operation is complete.
-   */
-  build(inlineConfig: BuildInlineConfig): Promise<void>;
-  /**
-   * Executes the documentation generation phase of the build process, which typically involves creating API documentation and other project documentation. The `inlineConfig` parameter allows users to specify additional options or overrides for the documentation operation.
-   *
-   * @param inlineConfig - The inline configuration options for the documentation operation.
-   * @returns A promise that resolves when the documentation generation is complete.
-   */
-  docs(inlineConfig: DocsInlineConfig): Promise<void>;
-  /**
-   * Executes the finalize phase of the build process, which typically involves cleanup tasks and final reporting. This method should be called after all other build phases have completed.
-   *
-   * @returns A promise that resolves when the finalize operation is complete.
-   */
-  finalize(): Promise<void>;
-}
-/**
- * Creates a new {@link ShellShockAPI} instance.
- *
- * @param options - The user configuration options.
- * @returns A promise that resolves to a {@link ShellShockAPI} instance.
- */
-declare function createShellShock(options: EngineOptions$1): Promise<ShellShockAPI>;
-//#endregion
-export { ShellShockAPI, createShellShock };
+declare const _default: (params: import("@powerlines/engine").ExecutionApiParams<import("powerlines").ExecutionOptions, "types" | "docs" | "create" | "clean" | "prepare" | "lint" | "test" | "build" | "deploy">) => Promise<void>;
+export = _default;
 //# sourceMappingURL=api.d.cts.map

package/dist/api.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.cts","names":[],"sources":["../src/api.ts"],"mappings":";;;;;;;AAoCA;;;;cAAa,aAAA;EAAA;EA8CW;;;;;;EAAA,OArCF,IAAA,CAAK,OAAA,EAAS,eAAA,GAAgB,OAAA,CAAQ,aAAA;EAiFzB;;;;;EAAA,IA5CtB,OAAA,CAAA,GAAW,0BAAA;EAAA,QAIf,WAAA,CAAA;;;;;;;EAUM,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAd/B;;;;;;EAwBT,OAAA,CAAQ,YAAA,EAAc,mBAAA,GAAsB,OAAA;EAAtB;;;;;;EAUtB,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;EAUtC;;;;;;EAAA,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAUF;;;;;AAoBrD;EApBe,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;;;;;;EAStC,QAAA,CAAA,GAAY,OAAA;AAAA;;;;;;;iBAWL,gBAAA,CACpB,OAAA,EAAS,eAAA,GACR,OAAA,CAAQ,aAAA"}
+{"version":3,"file":"api.d.cts","names":[],"sources":["../src/api.ts"],"mappings":""}

package/dist/api.d.mts

@@ -1,79 +1,5 @@
-import { EngineOptions as EngineOptions$1 } from "./types/config.mjs";
-import { BuildInlineConfig, CleanInlineConfig, DocsInlineConfig, LintInlineConfig, PrepareInlineConfig } from "powerlines";
-import { PowerlinesExecutionContext } from "powerlines/context";
-
 //#region src/api.d.ts
-/**
- * The Shell Shock API class.
- *
- * @remarks
- * This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.
- */
-declare class ShellShockAPI {
-  #private;
-  /**
-   * Creates a new instance of the {@link ShellShockAPI} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.
-   *
-   * @param options - The user configuration options.
-   * @returns A promise that resolves to a {@link ShellShockAPI} instance.
-   */
-  static from(options: EngineOptions$1): Promise<ShellShockAPI>;
-  /**
-   * Gets the current build context, which includes information about the project, environment, and configuration. This context is used internally by the Shell Shock API to manage the build process and provide relevant data to plugins and other components.
-   *
-   * @returns The current build context.
-   */
-  get context(): PowerlinesExecutionContext;
-  private constructor();
-  /**
-   * Executes the clean phase of the build process, which typically involves removing generated files and resetting the build environment. The `inlineConfig` parameter allows users to specify additional options or overrides for the clean operation.
-   *
-   * @param inlineConfig - The inline configuration options for the clean operation.
-   * @returns A promise that resolves when the clean operation is complete.
-   */
-  clean(inlineConfig: CleanInlineConfig): Promise<void>;
-  /**
-   * Executes the prepare phase of the build process, which typically involves setting up the build environment and installing dependencies. The `inlineConfig` parameter allows users to specify additional options or overrides for the prepare operation.
-   *
-   * @param inlineConfig - The inline configuration options for the prepare operation.
-   * @returns A promise that resolves when the prepare operation is complete.
-   */
-  prepare(inlineConfig: PrepareInlineConfig): Promise<void>;
-  /**
-   * Executes the lint phase of the build process, which typically involves analyzing code for quality and style issues. The `inlineConfig` parameter allows users to specify additional options or overrides for the lint operation.
-   *
-   * @param inlineConfig - The inline configuration options for the lint operation.
-   * @returns A promise that resolves when the lint operation is complete.
-   */
-  lint(inlineConfig: LintInlineConfig): Promise<void>;
-  /**
-   * Executes the build phase of the build process, which typically involves compiling source code and generating output artifacts. The `inlineConfig` parameter allows users to specify additional options or overrides for the build operation.
-   *
-   * @param inlineConfig - The inline configuration options for the build operation.
-   * @returns A promise that resolves when the build operation is complete.
-   */
-  build(inlineConfig: BuildInlineConfig): Promise<void>;
-  /**
-   * Executes the documentation generation phase of the build process, which typically involves creating API documentation and other project documentation. The `inlineConfig` parameter allows users to specify additional options or overrides for the documentation operation.
-   *
-   * @param inlineConfig - The inline configuration options for the documentation operation.
-   * @returns A promise that resolves when the documentation generation is complete.
-   */
-  docs(inlineConfig: DocsInlineConfig): Promise<void>;
-  /**
-   * Executes the finalize phase of the build process, which typically involves cleanup tasks and final reporting. This method should be called after all other build phases have completed.
-   *
-   * @returns A promise that resolves when the finalize operation is complete.
-   */
-  finalize(): Promise<void>;
-}
-/**
- * Creates a new {@link ShellShockAPI} instance.
- *
- * @param options - The user configuration options.
- * @returns A promise that resolves to a {@link ShellShockAPI} instance.
- */
-declare function createShellShock(options: EngineOptions$1): Promise<ShellShockAPI>;
+declare const _default: (params: import("@powerlines/engine").ExecutionApiParams<import("powerlines").ExecutionOptions, "types" | "docs" | "create" | "clean" | "prepare" | "lint" | "test" | "build" | "deploy">) => Promise<void>;
 //#endregion
-export { ShellShockAPI, createShellShock };
+export { _default as default };
 //# sourceMappingURL=api.d.mts.map

package/dist/api.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"api.d.mts","names":[],"sources":["../src/api.ts"],"mappings":";;;;;;;AAoCA;;;;cAAa,aAAA;EAAA;EA8CW;;;;;;EAAA,OArCF,IAAA,CAAK,OAAA,EAAS,eAAA,GAAgB,OAAA,CAAQ,aAAA;EAiFzB;;;;;EAAA,IA5CtB,OAAA,CAAA,GAAW,0BAAA;EAAA,QAIf,WAAA,CAAA;;;;;;;EAUM,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAd/B;;;;;;EAwBT,OAAA,CAAQ,YAAA,EAAc,mBAAA,GAAsB,OAAA;EAAtB;;;;;;EAUtB,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;EAUtC;;;;;;EAAA,KAAA,CAAM,YAAA,EAAc,iBAAA,GAAoB,OAAA;EAUF;;;;;AAoBrD;EApBe,IAAA,CAAK,YAAA,EAAc,gBAAA,GAAmB,OAAA;;;;;;EAStC,QAAA,CAAA,GAAY,OAAA;AAAA;;;;;;;iBAWL,gBAAA,CACpB,OAAA,EAAS,eAAA,GACR,OAAA,CAAQ,aAAA"}
+{"version":3,"file":"api.d.mts","names":[],"sources":["../src/api.ts"],"mappings":""}

package/dist/api.mjs

@@ -1,146 +1,36 @@
+import { version } from "./package.mjs";
 import plugin from "./plugin.mjs";
-import { PowerlinesAPI } from "powerlines/api";
+import { build } from "powerlines/api/build";
+import { clean } from "powerlines/api/clean";
+import { create } from "powerlines/api/create";
+import { deploy } from "powerlines/api/deploy";
+import { docs } from "powerlines/api/docs";
+import { lint } from "powerlines/api/lint";
+import { prepare } from "powerlines/api/prepare";
+import { test } from "powerlines/api/test";
+import { types } from "powerlines/api/types";
+import { createApi } from "powerlines/helpers";
 
 //#region src/api.ts
-/**
-* The Shell Shock API class.
-*
-* @remarks
-* This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.
-*/
-var ShellShockAPI = class ShellShockAPI {
-	#powerlines;
-	/**
-	* Creates a new instance of the {@link ShellShockAPI} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.
-	*
-	* @param options - The user configuration options.
-	* @returns A promise that resolves to a {@link ShellShockAPI} instance.
-	*/
-	static async from(options) {
-		const { name, root, cwd, mode, logLevel, organization, configFile, ...pluginOptions } = options;
-		return new ShellShockAPI(await PowerlinesAPI.from({
-			name,
-			root,
-			cwd: cwd || process.cwd(),
-			mode,
-			logLevel,
-			organization,
-			configFile,
-			framework: "shell-shock"
-		}, {
-			plugins: [plugin(pluginOptions)],
-			framework: "shell-shock"
-		}));
-	}
-	/**
-	* Gets the current build context, which includes information about the project, environment, and configuration. This context is used internally by the Shell Shock API to manage the build process and provide relevant data to plugins and other components.
-	*
-	* @returns The current build context.
-	*/
-	get context() {
-		return this.#powerlines.context;
-	}
-	constructor(powerlines) {
-		this.#powerlines = powerlines;
-	}
-	/**
-	* Executes the clean phase of the build process, which typically involves removing generated files and resetting the build environment. The `inlineConfig` parameter allows users to specify additional options or overrides for the clean operation.
-	*
-	* @param inlineConfig - The inline configuration options for the clean operation.
-	* @returns A promise that resolves when the clean operation is complete.
-	*/
-	async clean(inlineConfig) {
-		return this.#powerlines.clean(inlineConfig);
-	}
-	/**
-	* Executes the prepare phase of the build process, which typically involves setting up the build environment and installing dependencies. The `inlineConfig` parameter allows users to specify additional options or overrides for the prepare operation.
-	*
-	* @param inlineConfig - The inline configuration options for the prepare operation.
-	* @returns A promise that resolves when the prepare operation is complete.
-	*/
-	async prepare(inlineConfig) {
-		return this.#powerlines.prepare(inlineConfig);
-	}
-	/**
-	* Executes the lint phase of the build process, which typically involves analyzing code for quality and style issues. The `inlineConfig` parameter allows users to specify additional options or overrides for the lint operation.
-	*
-	* @param inlineConfig - The inline configuration options for the lint operation.
-	* @returns A promise that resolves when the lint operation is complete.
-	*/
-	async lint(inlineConfig) {
-		return this.#powerlines.lint(inlineConfig);
-	}
-	/**
-	* Executes the build phase of the build process, which typically involves compiling source code and generating output artifacts. The `inlineConfig` parameter allows users to specify additional options or overrides for the build operation.
-	*
-	* @param inlineConfig - The inline configuration options for the build operation.
-	* @returns A promise that resolves when the build operation is complete.
-	*/
-	async build(inlineConfig) {
-		return this.#powerlines.build(inlineConfig);
-	}
-	/**
-	* Executes the documentation generation phase of the build process, which typically involves creating API documentation and other project documentation. The `inlineConfig` parameter allows users to specify additional options or overrides for the documentation operation.
-	*
-	* @param inlineConfig - The inline configuration options for the documentation operation.
-	* @returns A promise that resolves when the documentation generation is complete.
-	*/
-	async docs(inlineConfig) {
-		return this.#powerlines.docs(inlineConfig);
-	}
-	/**
-	* Executes the finalize phase of the build process, which typically involves cleanup tasks and final reporting. This method should be called after all other build phases have completed.
-	*
-	* @returns A promise that resolves when the finalize operation is complete.
-	*/
-	async finalize() {
-		return this.#powerlines.finalize();
-	}
-	static __type = [
-		"#powerlines",
-		"EngineOptions",
-		"options",
-		() => ShellShockAPI,
-		"from",
-		"Creates a new instance of the {@link ShellShockAPI} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.",
-		"powerlines",
-		"constructor",
-		"inlineConfig",
-		"clean",
-		"Executes the clean phase of the build process, which typically involves removing generated files and resetting the build environment. The `inlineConfig` parameter allows users to specify additional options or overrides for the clean operation.",
-		"prepare",
-		"Executes the prepare phase of the build process, which typically involves setting up the build environment and installing dependencies. The `inlineConfig` parameter allows users to specify additional options or overrides for the prepare operation.",
-		"lint",
-		"Executes the lint phase of the build process, which typically involves analyzing code for quality and style issues. The `inlineConfig` parameter allows users to specify additional options or overrides for the lint operation.",
-		"build",
-		"Executes the build phase of the build process, which typically involves compiling source code and generating output artifacts. The `inlineConfig` parameter allows users to specify additional options or overrides for the build operation.",
-		"docs",
-		"Executes the documentation generation phase of the build process, which typically involves creating API documentation and other project documentation. The `inlineConfig` parameter allows users to specify additional options or overrides for the documentation operation.",
-		"finalize",
-		"Executes the finalize phase of the build process, which typically involves cleanup tasks and final reporting. This method should be called after all other build phases have completed.",
-		"ShellShockAPI",
-		"The Shell Shock API class.",
-		"!3!P\"w\"2#P7$`0%s?&!P!2'\"0(P!2)$`0*?+P!2)$`0,?-P!2)$`0.?/P!2)$`00?1P!2)$`02?3P$`04?55w6?7"
-	];
-};
-/**
-* Creates a new {@link ShellShockAPI} instance.
-*
-* @param options - The user configuration options.
-* @returns A promise that resolves to a {@link ShellShockAPI} instance.
-*/
-async function createShellShock(options) {
-	return ShellShockAPI.from(options);
-}
-createShellShock.__type = [
-	"EngineOptions",
-	"options",
-	() => ShellShockAPI,
-	"createShellShock",
-	"Creates a new {@link ShellShockAPI} instance.",
-	"P\"w!2\"P7#`/$?%"
-];
+var api_default = createApi({
+	types,
+	prepare,
+	create,
+	clean,
+	lint,
+	test,
+	build,
+	docs,
+	deploy
+}, {
+	plugins: [plugin()],
+	framework: {
+		name: "shell-shock",
+		version,
+		orgId: "storm-software"
+	}
+});
 
 //#endregion
-export { ShellShockAPI, createShellShock };
+export { api_default as default };
 //# sourceMappingURL=api.mjs.map

package/dist/api.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"api.mjs","names":[],"sources":["../src/api.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                  ⚡ Storm Software - Shell Shock\n\n This code was released as part of the Shell Shock project. Shell Shock\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/shell-shock.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/shell-shock\n Documentation:            https://docs.stormsoftware.com/projects/shell-shock\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport type {\n  BuildInlineConfig,\n  CleanInlineConfig,\n  DocsInlineConfig,\n  LintInlineConfig,\n  PrepareInlineConfig\n} from \"powerlines\";\nimport { PowerlinesAPI } from \"powerlines/api\";\nimport type { PowerlinesExecutionContext } from \"powerlines/context\";\nimport { plugin } from \"./plugin\";\nimport type { EngineOptions } from \"./types/config\";\n\n/**\n * The Shell Shock API class.\n *\n * @remarks\n * This class provides methods to interact with the Shell Shock build system, including cleaning, preparing, linting, building, generating documentation, and finalizing projects.\n */\nexport class ShellShockAPI {\n  #powerlines: PowerlinesAPI;\n\n  /**\n   * Creates a new instance of the {@link ShellShockAPI} class using the provided configuration options. This method initializes the underlying Powerlines API with the appropriate plugins and settings for Shell Shock.\n   *\n   * @param options - The user configuration options.\n   * @returns A promise that resolves to a {@link ShellShockAPI} instance.\n   */\n  public static async from(options: EngineOptions): Promise<ShellShockAPI> {\n    const {\n      name,\n      root,\n      cwd,\n      mode,\n      logLevel,\n      organization,\n      configFile,\n      ...pluginOptions\n    } = options;\n\n    const powerlines = await PowerlinesAPI.from(\n      {\n        name,\n        root,\n        cwd: cwd || process.cwd(),\n        mode,\n        logLevel,\n        organization,\n        configFile,\n        framework: \"shell-shock\"\n      },\n      {\n        plugins: [plugin(pluginOptions)],\n        framework: \"shell-shock\"\n      }\n    );\n\n    return new ShellShockAPI(powerlines);\n  }\n\n  /**\n   * Gets the current build context, which includes information about the project, environment, and configuration. This context is used internally by the Shell Shock API to manage the build process and provide relevant data to plugins and other components.\n   *\n   * @returns The current build context.\n   */\n  public get context(): PowerlinesExecutionContext {\n    return this.#powerlines.context;\n  }\n\n  private constructor(powerlines: PowerlinesAPI) {\n    this.#powerlines = powerlines;\n  }\n\n  /**\n   * Executes the clean phase of the build process, which typically involves removing generated files and resetting the build environment. The `inlineConfig` parameter allows users to specify additional options or overrides for the clean operation.\n   *\n   * @param inlineConfig - The inline configuration options for the clean operation.\n   * @returns A promise that resolves when the clean operation is complete.\n   */\n  public async clean(inlineConfig: CleanInlineConfig): Promise<void> {\n    return this.#powerlines.clean(inlineConfig);\n  }\n\n  /**\n   * Executes the prepare phase of the build process, which typically involves setting up the build environment and installing dependencies. The `inlineConfig` parameter allows users to specify additional options or overrides for the prepare operation.\n   *\n   * @param inlineConfig - The inline configuration options for the prepare operation.\n   * @returns A promise that resolves when the prepare operation is complete.\n   */\n  public async prepare(inlineConfig: PrepareInlineConfig): Promise<void> {\n    return this.#powerlines.prepare(inlineConfig);\n  }\n\n  /**\n   * Executes the lint phase of the build process, which typically involves analyzing code for quality and style issues. The `inlineConfig` parameter allows users to specify additional options or overrides for the lint operation.\n   *\n   * @param inlineConfig - The inline configuration options for the lint operation.\n   * @returns A promise that resolves when the lint operation is complete.\n   */\n  public async lint(inlineConfig: LintInlineConfig): Promise<void> {\n    return this.#powerlines.lint(inlineConfig);\n  }\n\n  /**\n   * Executes the build phase of the build process, which typically involves compiling source code and generating output artifacts. The `inlineConfig` parameter allows users to specify additional options or overrides for the build operation.\n   *\n   * @param inlineConfig - The inline configuration options for the build operation.\n   * @returns A promise that resolves when the build operation is complete.\n   */\n  public async build(inlineConfig: BuildInlineConfig): Promise<void> {\n    return this.#powerlines.build(inlineConfig);\n  }\n\n  /**\n   * Executes the documentation generation phase of the build process, which typically involves creating API documentation and other project documentation. The `inlineConfig` parameter allows users to specify additional options or overrides for the documentation operation.\n   *\n   * @param inlineConfig - The inline configuration options for the documentation operation.\n   * @returns A promise that resolves when the documentation generation is complete.\n   */\n  public async docs(inlineConfig: DocsInlineConfig): Promise<void> {\n    return this.#powerlines.docs(inlineConfig);\n  }\n\n  /**\n   * Executes the finalize phase of the build process, which typically involves cleanup tasks and final reporting. This method should be called after all other build phases have completed.\n   *\n   * @returns A promise that resolves when the finalize operation is complete.\n   */\n  public async finalize(): Promise<void> {\n    return this.#powerlines.finalize();\n  }\n}\n\n/**\n * Creates a new {@link ShellShockAPI} instance.\n *\n * @param options - The user configuration options.\n * @returns A promise that resolves to a {@link ShellShockAPI} instance.\n */\nexport async function createShellShock(\n  options: EngineOptions\n): Promise<ShellShockAPI> {\n  return ShellShockAPI.from(options);\n}\n"],"mappings":";;;;;;;;;;AAyBA,IAAS,gBAAT,MAAS,cAAgB;CACzB;;;;;;;CAOE,aAAE,KAAA,SAAA;EACD,MAAK,EACN,MACI,MACH,WAEC,UACC,cACF,YACG,GAAA,kBACA;AAcF,SAAM,IAAA,cAAmB,MAbzB,cAAA,KAAA;GACF;GACE;GACE,KAAI,OAAA,QAAA,KAAA;GACJ;GACA;GACA;GACA;GACA,WAAA;GACD,EAAC;GACA,SAAG,CAAA,OAAA,cAAA,CAAA;GACH,WAAS;KAEc;;;;;;;CAO3B,IAAI,UAAE;AACJ,SAAI,MAAA,WAAU;;CAEhB,YAAK,YAAA;AACH,QAAE,aAAA;;;;;;;;;AASF,SAAA,MAAA,WAAA,MAAA,aAAA;;;;;;;;;AASF,SAAQ,MAAA,WAAY,QAAY,aAAe;;;;;;;;CAQ/C,MAAI,KAAO,cAAW;AACpB,SAAA,MAAA,WAAA,KAAA,aAAA;;;;;;;;CAQF,MAAI,MAAM,cAAe;AACvB,SAAE,MAAU,WAAY,MAAC,aAAkB;;;;;;;;CAQ7C,MAAC,KAAA,cAAA;AACC,SAAO,MAAC,WAAe,KAAI,aAAO;;;;;;;CAOpC,MAAE,WAAA;AACA,SAAC,MAAS,WAAU,UAAa;;CAEnC,OAAI,SAAM;EAAA;EAAmB;EAAoB;QAAiB;EAAe;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;EAAA;;;;;;;;AAQnF,eAAkB,iBAAc,SAAgB;AAC9C,QAAC,cAAA,KAAA,QAAA;;AAEH,iBAAgB,SAAQ;CAAA;CAAmB;OAAkB;CAAc;CAAQ;CAAA;CAAA"}
+{"version":3,"file":"api.mjs","names":[],"sources":[],"mappings":""}