@adobe/aio-commerce-lib-app 1.5.0 → 1.7.0

package/dist/es/commands/index.mjs

@@ -13,26 +13,28 @@
  * governing permissions and limitations under the License.
  */
 
-import { a as hasCustomInstallationSteps, d as hasAdminUiSdk } from "../webhooks-Dhrkkip7.mjs";
-import { c as hasBusinessConfigSchema, i as getConfigDomains, t as validateCommerceAppConfig } from "../validate-Dn3lLTGj.mjs";
-import { a as getExecCommand, c as isESM, i as detectPackageManager, l as makeOutputDirFor, n as readCommerceAppConfig, o as getInstallCommand, s as getProjectRootDirectory, t as parseCommerceAppConfig, u as readPackageJson } from "../config-DGPFTk6w.mjs";
-import { t as stringifyError } from "../error-DHlYzkbb.mjs";
-import { t as inspect } from "../logging-XIUXDK5T.mjs";
+import { t as stringifyError } from "../error-_RMwtrUA.mjs";
+import { a as getExecCommand, c as isESM, i as detectPackageManager, l as makeOutputDirFor, n as readCommerceAppConfig, o as getInstallCommand, r as resolveCommerceAppConfig, s as getProjectRootDirectory, t as parseCommerceAppConfig, u as readPackageJson } from "../config-3I4eLyyR.mjs";
+import { a as hasCustomInstallationSteps, d as hasAdminUiSdk } from "../webhooks-B5oq9ULL.mjs";
+import { o as getConfigDomains, r as requiresInstallation, t as validateCommerceAppConfig, u as hasBusinessConfigSchema } from "../validate-Dfajrp99.mjs";
+import { t as inspect } from "../logging-DbJHXSKh.mjs";
 import { CommerceSdkValidationError } from "@adobe/aio-commerce-lib-core/error";
-import path, { basename, dirname, join, relative, resolve } from "path";
-import { existsSync, readFileSync, writeFileSync } from "fs";
-import { readFile, writeFile } from "fs/promises";
 import consola, { consola as consola$1 } from "consola";
+import path, { basename, dirname, extname, join, relative, resolve, sep } from "path";
+import { hasDynamicSchema } from "@adobe/aio-commerce-lib-config";
 import * as prettier from "prettier";
+import { existsSync, readFileSync, writeFileSync } from "fs";
+import { access, readFile, rm, writeFile } from "fs/promises";
 import { fileURLToPath } from "url";
-import { Document, YAMLMap, YAMLSeq, isMap, isSeq, parseDocument } from "yaml";
+import { Document, YAMLMap, YAMLSeq, isMap, isPair, isSeq, parseDocument } from "yaml";
+import NpmPackageJson from "@npmcli/package-json";
 import { colorize, formatTree } from "consola/utils";
+import { build } from "esbuild";
 import stringify, { stringify as stringify$1 } from "safe-stable-stringify";
 import { execSync, spawnSync } from "child_process";
 import config from "@adobe/aio-lib-core-config";
 import aioIms from "@adobe/aio-lib-ims";
 import dotenv from "dotenv";
-import NpmPackageJson from "@npmcli/package-json";
 
 //#region source/commands/constants.ts
 /** The name of the package containing all the generated runtime actions */
@@ -55,6 +57,10 @@ const ADMIN_UI_SDK_PACKAGE_NAME = "admin-ui-sdk";
 const ADMIN_UI_SDK_ACTIONS_PATH = `${GENERATED_PATH}/actions/registration`;
 /** The name of the configuration schema file */
 const APP_MANIFEST_FILE = "app.commerce.manifest.json";
+/** The name of the generated runtime-safe app config module (dynamic schemas only). */
+const RUNTIME_APP_CONFIG_FILE = "app.commerce.config.js";
+/** Package import alias for the generated runtime-safe app config module. */
+const APP_CONFIG_IMPORT_ALIAS = "#app.commerce.config";
 /** The name of the commerce app configuration file */
 const COMMERCE_APP_CONFIG_FILE = "app.commerce.config";
 /** The name of the configuration schema file */
@@ -94,6 +100,14 @@ async function loadAppManifest() {
 	return appConfig;
 }
 /**
+* Whether the app config contains anything that can't be JSON-serialized as-is
+* and therefore requires generating a runtime-safe ESM config module.
+*/
+function hasDynamicAppConfig(appConfig) {
+	const schema = appConfig.businessConfig?.schema;
+	return Array.isArray(schema) && hasDynamicSchema(schema);
+}
+/**
 * Path to an extension point's `.generated` directory, relative to the project root.
 * @param extensionPointId - The extension point ID, e.g. "commerce/extensibility/1"
 */
@@ -136,6 +150,21 @@ function getAdminUiSdkActionsDir(extensionPointId) {
 function getAdminUiSdkRegistrationActionPath(extensionPointId) {
 	return join(getAdminUiSdkActionsDir(extensionPointId), "index.js");
 }
+/** Path to the generated app manifest JSON file, relative to the project root. */
+function getManifestPath() {
+	return join(getGeneratedDir(EXTENSIBILITY_EXTENSION_POINT_ID), APP_MANIFEST_FILE);
+}
+/**
+* Path to the generated runtime-safe app config ESM module, relative to the
+* project root. Used when the business config schema contains dynamic options.
+*/
+function getRuntimeAppConfigPath() {
+	return join(getGeneratedDir(EXTENSIBILITY_EXTENSION_POINT_ID), RUNTIME_APP_CONFIG_FILE);
+}
+/** Path to the generated configuration schema file, relative to the project root. */
+function getSchemaPath() {
+	return join(getGeneratedDir(CONFIGURATION_EXTENSION_POINT_ID), CONFIG_SCHEMA_FILE_NAME);
+}
 
 //#endregion
 //#region source/commands/generate/actions/config.ts
@@ -164,7 +193,7 @@ function createActionDefinition(actionName, config = {}, options = {}) {
 		...options,
 		function: `${GENERATED_ACTIONS_PATH}/${actionName}.js`,
 		web: options.web ?? "yes",
-		runtime: "nodejs:22",
+		runtime: "nodejs:24",
 		annotations: {
 			"require-adobe-auth": true,
 			final: true
@@ -191,8 +220,6 @@ function getRuntimeActions(extConfig, dir) {
 * @param features - The features that are enabled for the app.
 */
 function buildAppManagementExtConfig(appConfig) {
-	const features = getConfigDomains(appConfig);
-	const hasPasswordFieldsInSchema = hasBusinessConfigSchema(appConfig) && appConfig.businessConfig.schema.some((field) => field.type === "password");
 	const extConfig = {
 		hooks: { "pre-app-build": "EXTENSION=extensibility/1 $packageExec aio-commerce-lib-app hooks pre-app-build" },
 		operations: { workerProcess: [{
@@ -204,13 +231,9 @@ function buildAppManagementExtConfig(appConfig) {
 			actions: { "app-config": createActionDefinition("app-config") }
 		} } }
 	};
-	if ([
-		"installation.customInstallationSteps",
-		"eventing.commerce",
-		"eventing.external",
-		"webhooks",
-		"adminUiSdk"
-	].some((feature) => features.has(feature))) {
+	const needsInstallAction = requiresInstallation(appConfig);
+	const hasPasswordFieldsInSchema = hasBusinessConfigSchema(appConfig) && appConfig.businessConfig.schema.some((field) => field.type === "password");
+	if (needsInstallAction) {
 		extConfig.operations.workerProcess.push({
 			type: "action",
 			impl: `${PACKAGE_NAME}/installation`
@@ -263,7 +286,7 @@ function buildAdminUiSdkExtConfig() {
 			actions: { registration: {
 				function: `${ADMIN_UI_SDK_ACTIONS_PATH}/index.js`,
 				web: "yes",
-				runtime: "nodejs:22",
+				runtime: "nodejs:24",
 				annotations: {
 					"require-adobe-auth": true,
 					final: true
@@ -337,6 +360,33 @@ function getOrCreateMap(doc, path, options) {
 		typeName: "map"
 	});
 }
+/**
+* Read the `inputs` map from an existing YAML action definition into a plain
+* object. Used by codegen to merge developer-added inputs with the ones the
+* generator manages, so regeneration does not strip user-added entries.
+*
+* @param existingAction - The YAML map representing the existing action.
+*/
+function getExistingInputs(existingAction) {
+	const inputs = existingAction?.get("inputs");
+	if (!isMap(inputs)) return {};
+	return Object.fromEntries(inputs.items.map((item) => {
+		if (!isPair(item)) return [];
+		return [String(item.key), item.value];
+	}));
+}
+/**
+* Read a string field from an existing YAML action definition. Used by codegen
+* to preserve developer-set values (e.g. `runtime`) across regeneration
+* instead of overwriting them.
+*
+* @param key - The field to read.
+* @param existingAction - The YAML map representing the existing action.
+*/
+function getExistingString(key, existingAction) {
+	const value = existingAction?.get(key);
+	return typeof value === "string" ? value : void 0;
+}
 
 //#endregion
 //#region ../../packages-private/scripting-utils/source/yaml/codegen.ts
@@ -365,19 +415,30 @@ function buildWeb(extConfig, web) {
 	if (!extConfig.hasIn(["web"])) extConfig.add(extConfig.createPair("web", web));
 }
 /**
-* Build the definition for a runtime action
-* @param name - The name of the action
-* @param path - The path where the action is located
-* @param action - The action definition
+* Build the definition for a runtime action.
+*
+* Developer-added `inputs` keys (anything not in the generator-managed set) on
+* `existingAction` are preserved so that hand-written entries — for example
+* factory credentials for `dynamicList` fields — survive regeneration.
+*
+* A `runtime` already set on `existingAction` is likewise preserved, so a
+* developer can pin a different Node runtime (e.g. `nodejs:24`) in
+* `ext.config.yaml` once without codegen reverting it on the next run.
+*
+* @param action - The action definition to build.
+* @param existingAction - The action's previous YAML definition, if any.
 */
-function buildActionDefinition(action) {
+function buildActionDefinition(action, existingAction) {
 	const actionDef = new YAMLMap();
-	const inputs = { LOG_LEVEL: "$LOG_LEVEL" };
+	const existingInputs = getExistingInputs(existingAction);
+	const existingRuntime = getExistingString("runtime", existingAction);
+	const managedInputs = { LOG_LEVEL: "$LOG_LEVEL" };
 	actionDef.set("function", action.function);
 	actionDef.set("web", action.web ?? "yes");
-	actionDef.set("runtime", action.runtime ?? "nodejs:22");
+	actionDef.set("runtime", existingRuntime ?? action.runtime ?? "nodejs:24");
 	actionDef.set("inputs", {
-		...inputs,
+		...existingInputs,
+		...managedInputs,
 		...action.inputs ?? {}
 	});
 	actionDef.set("annotations", { ...action.annotations ?? {
@@ -452,11 +513,13 @@ function buildRuntimeManifest(extConfig, manifest) {
 		], { onBeforeCreate: (pair) => {
 			pair.key.commentBefore = " This package definition is auto-generated. Do not remove or manually edit.";
 		} });
+		const existingActions = packageDef.get("actions");
 		const actions = new YAMLMap();
 		packageDef.set("license", pkg.license ?? "Apache-2.0");
 		packageDef.set("actions", actions);
 		for (const [actionName, action] of Object.entries(pkg.actions ?? {})) {
-			const actionDef = buildActionDefinition(action);
+			const existingAction = isMap(existingActions) ? existingActions.get(actionName) : void 0;
+			const actionDef = buildActionDefinition(action, isMap(existingAction) ? existingAction : void 0);
 			actions.set(actionName, actionDef);
 		}
 	}
@@ -499,6 +562,109 @@ async function writeExtConfig(configPath, doc) {
 const __dirname = dirname(fileURLToPath(import.meta.url));
 /** The path to the action templates directory, sibling to this file. */
 const TEMPLATES_DIR = join(__dirname, "templates");
+const TYPESCRIPT_CONFIG_EXTENSIONS = new Set([
+	".ts",
+	".mts",
+	".cts"
+]);
+const LEADING_DOT_SLASH_PATTERN = /^\.\//u;
+const DYNAMIC_APP_CONFIG_IMPORT = `import appConfig from "${APP_CONFIG_IMPORT_ALIAS}";`;
+const STATIC_APP_MANIFEST_IMPORT = "import appConfig from \"../../app.commerce.manifest.json\" with { type: \"json\" };";
+const STATIC_CONFIG_SCHEMA_IMPORT = "import configSchema from \"../../configuration-schema.json\" with { type: \"json\" };";
+/** Normalize a path for use as an ESM import specifier. */
+function normalizeImportPath(path) {
+	const normalizedPath = path.split(sep).join("/");
+	return normalizedPath.startsWith(".") ? normalizedPath : `./${normalizedPath}`;
+}
+/** Normalize a generated file path for package.json imports. */
+function normalizePackageJsonPath(path) {
+	return normalizeImportPath(path).replace(LEADING_DOT_SLASH_PATTERN, "./");
+}
+/** Add or update the package import alias used by dynamic generated actions. */
+async function updateAppConfigImportAlias(projectRoot, runtimeConfigPath) {
+	const pkg = await NpmPackageJson.load(projectRoot);
+	const existingImports = typeof pkg.content.imports === "object" && pkg.content.imports !== null ? pkg.content.imports : {};
+	pkg.update({ imports: {
+		...existingImports,
+		[APP_CONFIG_IMPORT_ALIAS]: normalizePackageJsonPath(runtimeConfigPath)
+	} });
+	await pkg.save();
+}
+/** Remove the package import alias used only by dynamic generated actions. */
+async function deleteAppConfigImportAlias(projectRoot) {
+	const pkg = await NpmPackageJson.load(projectRoot);
+	const existingImports = typeof pkg.content.imports === "object" && pkg.content.imports !== null ? pkg.content.imports : {};
+	if (!("#app.commerce.config" in existingImports)) return;
+	const imports = { ...existingImports };
+	delete imports[APP_CONFIG_IMPORT_ALIAS];
+	if (Object.keys(imports).length > 0) pkg.update({ imports });
+	else pkg.content.imports = void 0;
+	await pkg.save();
+}
+/** Write an ESM passthrough module for JavaScript app config files. */
+async function writeJavaScriptAppConfigModule(configFilePath, outputPath) {
+	await writeFile(outputPath, [
+		"// This file has been auto-generated by `@adobe/aio-commerce-lib-app`",
+		"// Do not modify this file directly",
+		"",
+		`import appConfig from "${normalizeImportPath(relative(dirname(outputPath), configFilePath))}";`,
+		"",
+		"export default appConfig;",
+		""
+	].join("\n"), "utf-8");
+}
+/** Bundle a TypeScript app config file into runtime-safe ESM. */
+async function bundleTypeScriptAppConfigModule(configFilePath, outputPath) {
+	await build({
+		entryPoints: [configFilePath],
+		outfile: outputPath,
+		bundle: true,
+		format: "esm",
+		platform: "node",
+		target: "node22",
+		packages: "external",
+		logLevel: "silent"
+	});
+}
+/** Generate the runtime-safe app config module used by generated runtime actions. */
+async function generateRuntimeAppConfigModule() {
+	const projectRoot = await getProjectRootDirectory();
+	const runtimeConfigPath = getRuntimeAppConfigPath();
+	await makeOutputDirFor(dirname(runtimeConfigPath));
+	const outputPath = join(projectRoot, runtimeConfigPath);
+	const configFilePath = await resolveCommerceAppConfig(projectRoot);
+	if (!configFilePath) throw new Error("Dynamic list options require an app.commerce.config.* file so generated actions can import the option factories at runtime.");
+	consola$1.info("Generating JS config module...");
+	if (TYPESCRIPT_CONFIG_EXTENSIONS.has(extname(configFilePath))) await bundleTypeScriptAppConfigModule(configFilePath, outputPath);
+	else await writeJavaScriptAppConfigModule(configFilePath, outputPath);
+	await updateAppConfigImportAlias(projectRoot, runtimeConfigPath);
+	consola$1.success(`Generated JS config module: ${relative(process.cwd(), outputPath)}`);
+}
+/** Remove the generated app config module when generated actions use static JSON. */
+async function cleanupRuntimeAppConfigModule() {
+	const projectRoot = await getProjectRootDirectory();
+	await rm(join(projectRoot, getRuntimeAppConfigPath()), { force: true });
+	await deleteAppConfigImportAlias(projectRoot);
+}
+/**
+* Prepare runtime-side config artifacts consumed by generated actions: the
+* bundled ESM module and its `#app.commerce.config` package import alias.
+*
+* Generates them for dynamic schemas, cleans them up for static ones.
+*/
+async function prepareRuntimeAppConfigModule(appManifest) {
+	if (hasDynamicAppConfig(appManifest)) {
+		await generateRuntimeAppConfigModule();
+		return;
+	}
+	await cleanupRuntimeAppConfigModule();
+}
+/** Switch static JSON imports to the generated runtime config module for dynamic schemas. */
+function applyRuntimeAppConfigImport(template, actionName) {
+	if (actionName === "app-config" || actionName === "installation") return template.replace(STATIC_APP_MANIFEST_IMPORT, DYNAMIC_APP_CONFIG_IMPORT);
+	if (actionName === "config") return template.replace(STATIC_CONFIG_SCHEMA_IMPORT, DYNAMIC_APP_CONFIG_IMPORT).replace("const args = { configSchema };", "const args = { configSchema: appConfig.businessConfig.schema };");
+	return template;
+}
 /**
 * Read an extension point's ext.config.yaml file and return it as a JS object.
 * @param extensionPointId - The extension point ID to read the config for.
@@ -545,8 +711,10 @@ async function generateActionFiles(appManifest, actions, extensionPointId, templ
 	await makeOutputDirFor(getActionsDir(extensionPointId));
 	const projectRoot = await getProjectRootDirectory();
 	const outputFiles = [];
+	const useDynamicImports = hasDynamicAppConfig(appManifest);
 	for (const action of actions) {
 		let template = await readFile(join(templatesDir, action.templateFile), "utf-8");
+		if (useDynamicImports) template = applyRuntimeAppConfigImport(template, action.name);
 		if (action.name === "installation") {
 			const scriptsTemplate = await generateCustomScriptsTemplate(await readFile(join(templatesDir, "app-management", "custom-scripts.js.template"), "utf-8"), appManifest);
 			template = applyCustomScripts(template, scriptsTemplate);
@@ -614,6 +782,7 @@ async function generateRegistrationActionFile(appManifest, extensionPointId, tem
 * @param templatesDir - The directory to load templates from, for testing purposes. Defaults to the generated actions template root.
 */
 async function run$5(appManifest, templatesDir = TEMPLATES_DIR) {
+	await prepareRuntimeAppConfigModule(appManifest);
 	await generateActionFiles(appManifest, getRuntimeActions(await updateExtConfig(appManifest, EXTENSIBILITY_EXTENSION_POINT_ID), "app-management"), EXTENSIBILITY_EXTENSION_POINT_ID, templatesDir);
 	if (hasBusinessConfigSchema(appManifest)) await generateActionFiles(appManifest, getRuntimeActions(await updateExtConfig(appManifest, CONFIGURATION_EXTENSION_POINT_ID), "business-configuration"), CONFIGURATION_EXTENSION_POINT_ID, templatesDir);
 	if (hasAdminUiSdk(appManifest)) {
@@ -635,10 +804,18 @@ async function exec$5() {
 //#endregion
 //#region source/commands/generate/manifest/main.ts
 async function run$4(appConfig) {
+	if (hasDynamicAppConfig(appConfig)) {
+		const stalePath = join(await getProjectRootDirectory(), getManifestPath());
+		if (await access(stalePath).then(() => true, () => false)) {
+			await rm(stalePath, { force: true });
+			consola$1.success(`Removed stale ${APP_MANIFEST_FILE}`);
+		}
+		return;
+	}
 	consola$1.info("Generating app manifest...");
 	const contents = stringify$1(appConfig, null, 2);
 	await writeFile(join(await makeOutputDirFor(getGeneratedDir(EXTENSIBILITY_EXTENSION_POINT_ID)), APP_MANIFEST_FILE), contents, "utf-8");
-	consola$1.success(`Generated ${APP_MANIFEST_FILE}`);
+	consola$1.success(`Generated ${APP_MANIFEST_FILE}\n`);
 }
 /** Run the generate manifest command */
 async function exec$4() {
@@ -670,7 +847,6 @@ async function run$3(appConfig) {
 		consola$1.debug("Business configuration schema not found in application configuration. Nothing to do.");
 		return;
 	}
-	consola$1.info("Generating configuration schema...");
 	const projectDir = await getProjectRootDirectory();
 	const envPath = join(projectDir, ".env");
 	await touch(envPath);
@@ -680,9 +856,19 @@ async function run$3(appConfig) {
 		if ("AIO_COMMERCE_CONFIG_ENCRYPTION_KEY" in process.env && String(process.env.AIO_COMMERCE_CONFIG_ENCRYPTION_KEY).trim().length > 0) execSync(`${packageExec} aio-commerce-lib-config encryption validate`);
 		else execSync(`${packageExec} aio-commerce-lib-config encryption setup`);
 	}
+	if (hasDynamicAppConfig(appConfig)) {
+		const stalePath = join(projectDir, getSchemaPath());
+		if (await access(stalePath).then(() => true, () => false)) {
+			await rm(stalePath, { force: true });
+			consola$1.success(`Removed stale ${CONFIG_SCHEMA_FILE_NAME}`);
+		}
+		return;
+	}
+	consola$1.info("Generating configuration schema...");
+	const outputDir = await makeOutputDirFor(getGeneratedDir(CONFIGURATION_EXTENSION_POINT_ID));
 	const contents = stringify$1(appConfig.businessConfig.schema, null, 2);
-	await writeFile(join(await makeOutputDirFor(getGeneratedDir(CONFIGURATION_EXTENSION_POINT_ID)), CONFIG_SCHEMA_FILE_NAME), contents, "utf-8");
-	consola$1.success(`Generated ${CONFIG_SCHEMA_FILE_NAME}`);
+	await writeFile(join(outputDir, CONFIG_SCHEMA_FILE_NAME), contents, "utf-8");
+	consola$1.success(`Generated ${CONFIG_SCHEMA_FILE_NAME}\n`);
 }
 /** Run the generate schema command */
 async function exec$3() {
@@ -797,6 +983,7 @@ async function syncImsCredentials() {
 */
 async function run$1(extension, templatesDir = TEMPLATES_DIR) {
 	const appManifest = await loadAppManifest();
+	await prepareRuntimeAppConfigModule(appManifest);
 	if (extension === "extensibility/1") {
 		const { doc: extensibilityExtConfig } = await readExtConfig(EXTENSIBILITY_EXTENSION_POINT_ID);
 		await run$4(appManifest);
@@ -1206,7 +1393,7 @@ function runInstall(packageManager, dependencies, cwd = process.cwd()) {
 */
 function installDependencies(packageManager, domains, cwd = process.cwd()) {
 	const packages = [];
-	if (domains.has("businessConfig.schema")) packages.push(`@adobe/aio-commerce-lib-config@^1.4.0`);
+	if (domains.has("businessConfig.schema")) packages.push(`@adobe/aio-commerce-lib-config@^1.5.1`);
 	if (packages.length === 0) {
 		consola$1.info("No additional domain dependencies to install.");
 		return;
@@ -1233,7 +1420,7 @@ async function ensureInstallYaml(domains, cwd = process.cwd()) {
 
 //#endregion
 //#region source/commands/init/main.ts
-const REQUIRED_DEPENDENCIES = ["@adobe/aio-commerce-sdk", `@adobe/aio-commerce-lib-app@1.5.0`];
+const REQUIRED_DEPENDENCIES = ["@adobe/aio-commerce-sdk", `@adobe/aio-commerce-lib-app@1.7.0`];
 /** Initialize the project */
 async function run(flags, extraOptions) {
 	consola$1.start("Initializing app...");
@@ -1298,9 +1485,7 @@ Examples:
 /** Run all generate targets in sequence */
 async function generateAll() {
 	await exec$5();
-	consola.log.raw("");
 	await exec$4();
-	consola.log.raw("");
 	await exec$3();
 }
 /** Command handlers registry mapping command names to their subcommand handlers */

package/dist/es/commands/templates/app-management/app-config.js.template

@@ -16,7 +16,7 @@
 import { appConfigRuntimeAction } from "@adobe/aio-commerce-lib-app/actions/app-config";
 
 // The manifest is always at this relative constant path from the action.
-import commerceAppManifest from "../../app.commerce.manifest.json" with { type: "json" };
+import appConfig from "../../app.commerce.manifest.json" with { type: "json" };
 
-const args = { appConfig: commerceAppManifest };
+const args = { appConfig };
 export const main = appConfigRuntimeAction(args);