@adobe/aio-commerce-lib-app 2.0.0 → 2.1.0-alpha-20260923164312

package/dist/es/cli/index.mjs

@@ -0,0 +1,435 @@
+/**
+ * @license
+ *
+ * Copyright 2026 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+import { p as getProjectRootDirectory, r as parseCommerceAppConfig } from "../index.node-C5D5IzSs.mjs";
+import { C as BACKEND_UI_V2_EXTENSION_POINT_ID, E as EXTENSIBILITY_EXTENSION_POINT_ID, T as CONFIGURATION_EXTENSION_POINT_ID, c as run$4, d as readExtConfig, f as updateExtConfig, g as getRuntimeActions, k as getExtensionPointFolderPath, l as generateActionFiles, n as prepareWebSourceImportAlias, o as run$5, t as generateWebSrc, u as prepareRuntimeAppConfigModule, v as loadAppManifest, x as TEMPLATES_DIR } from "../web-src-CLEUvMl7.mjs";
+import { n as INSTALLATION_INVOCATION_SOURCE_HEADER, r as POST_APP_DEPLOY_INVOCATION_SOURCE } from "../common-BWUDGasu.mjs";
+import { l as hasBackendUiV2Components } from "../webhooks-BMBfTqwi.mjs";
+import { CommerceSdkValidationError } from "@adobe/aio-commerce-lib-core/error";
+import { existsSync, readFileSync, writeFileSync } from "fs";
+import path, { join } from "path";
+import consola$1, { consola } from "consola";
+import aioIms from "@adobe/aio-lib-ims";
+import config from "@adobe/aio-lib-core-config";
+import { colors } from "consola/utils";
+import ky, { HTTPError } from "ky";
+import * as v from "valibot";
+import { setTimeout } from "timers/promises";
+import dotenv from "dotenv";
+
+//#region ../../packages-private/scripting-utils/source/aio/auth.ts
+const { context: context$1, getToken } = aioIms;
+/** Gets an IMS access token for the current CLI IMS context. */
+async function getUserToken() {
+	const contextName = await context$1.getCurrent() ?? "cli";
+	return getToken(contextName, {});
+}
+
+//#endregion
+//#region ../../packages-private/scripting-utils/source/aio/context.ts
+/**
+* Reads the current App Builder project and Runtime namespace from the local AIO CLI config.
+* @throws If either the project or the runtime namespace is not configured.
+*/
+function getAioProjectContext() {
+	const project = config.get("project");
+	const namespace = config.get("runtime.namespace");
+	if (!(project && namespace)) throw new Error("The current App Builder project and Runtime namespace are required");
+	return {
+		namespace,
+		project
+	};
+}
+/** Reads the configured AIO CLI environment, defaulting to `"prod"`. */
+function getAioCliEnv() {
+	return config.get("cli.env") === "stage" ? "stage" : "prod";
+}
+
+//#endregion
+//#region source/commands/hooks/post-app-deploy/polling.ts
+const POLL_INTERVAL_MS = 1e3;
+const UpgradeStateSchema = v.object({
+	failure: v.optional(v.object({
+		key: v.string(),
+		message: v.optional(v.string())
+	})),
+	id: v.string(),
+	status: v.picklist([
+		"pending",
+		"in-progress",
+		"succeeded",
+		"failed"
+	])
+});
+/** Reads the latest upgrade state from the installation action. */
+async function getUpgradeState(request) {
+	try {
+		const response = await ky.get(request.endpoint, { headers: request.headers });
+		if (response.status === 204) return null;
+		const parsed = v.safeParse(UpgradeStateSchema, await response.json());
+		return parsed.success ? parsed.output : null;
+	} catch (error) {
+		consola.debug("Unable to read upgrade status; stopping upgrade polling.", { error });
+		return null;
+	}
+}
+/** Waits for an automatic upgrade when its status remains available. */
+async function waitForAutomaticUpgrade(request) {
+	const state = await getUpgradeState(request);
+	if (!state) return;
+	if (state.status === "succeeded") {
+		consola.success("App upgrade completed.\n");
+		return;
+	}
+	if (state.status === "failed") {
+		const reason = state.failure?.message ?? state.failure?.key ?? "The lifecycle attempt failed";
+		throw new Error(`App upgrade failed: ${reason}`);
+	}
+	consola.start("App upgrade is in progress...");
+	await setTimeout(POLL_INTERVAL_MS);
+	return waitForAutomaticUpgrade(request);
+}
+
+//#endregion
+//#region source/commands/hooks/post-app-deploy/main.ts
+/** Returns true for a no-op reason defined by the upgrade API contract. */
+function isSkippedReason(reason) {
+	return reason === "already-current" || reason === "not-associated" || reason === "not-installed";
+}
+/** Returns true if the result indicates that the upgrade was skipped. */
+function isSkippedResult(result) {
+	return "skipped" in result;
+}
+/** Invokes the upgrade action. */
+async function createUpgradeRequest() {
+	const { project, namespace } = getAioProjectContext();
+	const token = await getUserToken();
+	const endpoint = `https://${namespace}.adobeioruntime.net/api/v1/web/app-management/installation`;
+	const ioEventsEnv = getAioCliEnv();
+	const ioEventsUrl = ioEventsEnv === "stage" ? "https://events-stage.adobe.io" : "https://events.adobe.io";
+	return {
+		body: {
+			appData: {
+				consumerOrgId: project.org.id,
+				orgName: project.org.name,
+				projectId: project.id,
+				projectName: project.name,
+				projectTitle: project.title,
+				workspaceId: project.workspace.id,
+				workspaceName: project.workspace.name,
+				workspaceTitle: project.workspace.title
+			},
+			ioEventsEnv,
+			ioEventsUrl
+		},
+		endpoint,
+		headers: {
+			Authorization: `Bearer ${token}`,
+			[INSTALLATION_INVOCATION_SOURCE_HEADER]: POST_APP_DEPLOY_INVOCATION_SOURCE,
+			"x-gw-ims-org-id": project.org.ims_org_id
+		}
+	};
+}
+/** Invokes the upgrade action. */
+async function invokeAction(request) {
+	consola.debug(`Upgrade endpoint: ${request.endpoint}`);
+	try {
+		return await ky.post(request.endpoint, {
+			headers: request.headers,
+			json: request.body
+		}).json();
+	} catch (error) {
+		if (error instanceof HTTPError) {
+			const details = await error.response.json();
+			if (error.response.status === 409 && isSkippedReason(details.reason)) return {
+				reason: details.reason,
+				skipped: true
+			};
+			throw new Error(`Failed to trigger app upgrade (HTTP ${error.response.status}): ${JSON.stringify(details, null, 2)}`, { cause: error });
+		}
+		throw error;
+	}
+}
+/** Invokes the deployed app's upgrade endpoint. */
+async function run$3() {
+	const { upgradeMode } = (await parseCommerceAppConfig()).metadata;
+	consola.log("");
+	consola.start("Checking for app upgrades...");
+	const request = await createUpgradeRequest();
+	const result = await invokeAction(request);
+	if (isSkippedResult(result)) {
+		consola.info(`No upgrade was run: ${result.reason}.\n`);
+		return result;
+	}
+	if (upgradeMode === "manual") consola.success(`You have set ${colors.cyan("metadata.upgradeMode")} to ${colors.cyan("manual")}. The upgrade plan has been created but will not be executed.`);
+	else consola.success(`You have set ${colors.cyan("metadata.upgradeMode")} to ${colors.cyan("auto")}. The upgrade plan has been created. Execution will begin shortly.`);
+	consola.box(["Upgrade plan", JSON.stringify(result.plan, null, 2)].join("\n\n"));
+	if (upgradeMode === "auto") await waitForAutomaticUpgrade(request);
+	return result;
+}
+
+//#endregion
+//#region ../../packages-private/scripting-utils/source/env.ts
+/**
+* This module exports shared environment utilities for the AIO Commerce SDK.
+* @packageDocumentation
+*/
+const { context } = aioIms;
+const IMS_KEYS = {
+	client_id: "AIO_COMMERCE_AUTH_IMS_CLIENT_ID",
+	client_secrets: "AIO_COMMERCE_AUTH_IMS_CLIENT_SECRETS",
+	ims_org_id: "AIO_COMMERCE_AUTH_IMS_ORG_ID",
+	scopes: "AIO_COMMERCE_AUTH_IMS_SCOPES",
+	technical_account_email: "AIO_COMMERCE_AUTH_IMS_TECHNICAL_ACCOUNT_EMAIL",
+	technical_account_id: "AIO_COMMERCE_AUTH_IMS_TECHNICAL_ACCOUNT_ID"
+};
+/**
+* Replaces or creates an environment variable in a .env file and sets it in the
+* current process.
+* @param filePath - The path to the .env file
+* @param key - The environment variable key to replace or create
+* @param value - The new value for the environment variable
+*/
+function replaceEnvVar(filePath, key, value) {
+	const envPath = path.resolve(filePath);
+	const envLines = readFileSync(envPath, "utf8").split("\n");
+	const formattedValue = value.includes(" ") ? `"${value}"` : value;
+	let keyExists = false;
+	const updatedLines = envLines.map((line) => {
+		if (line.trim().startsWith("#") || !line.includes("=")) return line;
+		const [currentKey] = line.split("=");
+		if (currentKey === key) {
+			keyExists = true;
+			return `${key}=${formattedValue}`;
+		}
+		return line;
+	});
+	if (!keyExists) updatedLines.push(`${key}=${formattedValue}`);
+	writeFileSync(envPath, updatedLines.join("\n"), "utf8");
+	process.env[key] = value;
+}
+/**
+* Sets the `NODE_ENV` environment variable in the current process and in the app
+* `.env` file, so the web bundler (Parcel) ships the matching React build.
+* Creates the `.env` if absent.
+* @param mode - The environment mode to set in `NODE_ENV`.
+* @param projectRoot - Resolved project root containing the `.env` file.
+*/
+function setNodeEnv(mode, projectRoot) {
+	const envPath = path.join(projectRoot, ".env");
+	if (!existsSync(envPath)) writeFileSync(envPath, "", "utf8");
+	replaceEnvVar(envPath, "NODE_ENV", mode);
+}
+/** Resolves the IMS server to server context from the project workspace credentials. */
+function resolveImsS2SContext() {
+	const [credential] = (config.get("project.workspace.details.credentials") ?? []).filter(({ integration_type }) => integration_type === "oauth_server_to_server").map(({ name }) => name);
+	if (!credential) return Promise.resolve(null);
+	return context.get(credential);
+}
+/**
+* Syncs the IMS credentials environment variables from the configured IMS context in
+* the .env file, in a way that is compatible with `@adobe/aio-commerce-lib-auth`.
+* @param projectRoot - Resolved project root containing the `.env` file.
+*/
+async function syncImsCredentials(projectRoot) {
+	const envPath = path.join(projectRoot, ".env");
+	if (!existsSync(envPath)) return {
+		ok: false,
+		reason: "missing-env"
+	};
+	const envVars = dotenv.parse(readFileSync(envPath, "utf8"));
+	const imsContext = await resolveImsS2SContext();
+	if (!imsContext) return {
+		ok: false,
+		reason: "no-ims-context"
+	};
+	const { data } = imsContext;
+	for (const [key, value] of Object.entries(data)) {
+		const oauthKey = IMS_KEYS[key];
+		if (!oauthKey) continue;
+		if (!envVars[oauthKey] || envVars[oauthKey] !== value) replaceEnvVar(envPath, oauthKey, value);
+	}
+	return { ok: true };
+}
+
+//#endregion
+//#region source/commands/hooks/pre-app-build.ts
+/**
+* Runs the pre-app-build hook for the given extension.
+* @param extension - The extension to run the hook for.
+* @param projectRoot - Resolved project root containing extension files.
+* @param templatesDir - Directory containing action templates.
+* @param options - Hook options.
+* @param options.isDevSession - Whether the build runs within `aio app run` or `aio app dev`, which keeps `NODE_ENV` untouched.
+*/
+async function run$2(extension, projectRoot, templatesDir = TEMPLATES_DIR, { isDevSession = false } = {}) {
+	const appManifest = await loadAppManifest(projectRoot);
+	await prepareRuntimeAppConfigModule(appManifest, projectRoot);
+	if (extension === "extensibility/1") {
+		const { doc: extensibilityExtConfig } = await readExtConfig(EXTENSIBILITY_EXTENSION_POINT_ID, projectRoot);
+		await run$4(appManifest, projectRoot);
+		await generateActionFiles(appManifest, getRuntimeActions(extensibilityExtConfig.toJS(), "app-management"), EXTENSIBILITY_EXTENSION_POINT_ID, templatesDir, projectRoot);
+		consola$1.info("Syncing IMS credentials...");
+		await syncImsCredentials(projectRoot);
+		return;
+	}
+	if (extension === "configuration/1") {
+		const { doc: businessConfigExtConfig } = await readExtConfig(CONFIGURATION_EXTENSION_POINT_ID, projectRoot);
+		await run$5(appManifest, projectRoot);
+		await generateActionFiles(appManifest, getRuntimeActions(businessConfigExtConfig.toJS(), "business-configuration"), CONFIGURATION_EXTENSION_POINT_ID, templatesDir, projectRoot);
+		return;
+	}
+	if (extension === "backend-ui/2") {
+		if (hasBackendUiV2Components(appManifest)) {
+			const extConfig = await updateExtConfig(appManifest, BACKEND_UI_V2_EXTENSION_POINT_ID, projectRoot);
+			if (extConfig.operations?.view) {
+				await prepareWebSourceImportAlias(extConfig, projectRoot);
+				await generateWebSrc(extConfig, appManifest.metadata.displayName, projectRoot, templatesDir);
+				if (!isDevSession) await setNodeEnv("production", projectRoot);
+			}
+		}
+		return;
+	}
+	throw new Error(`Unsupported extension: ${extension}`);
+}
+
+//#endregion
+//#region source/commands/hooks/pre-app-dev.ts
+/**
+* Resets the web build back to development by setting `NODE_ENV` in the process and the project `.env`.
+* @param projectRoot - Resolved project root containing the `.env` file.
+*/
+async function run$1(projectRoot) {
+	await setNodeEnv("development", projectRoot);
+}
+
+//#endregion
+//#region source/commands/hooks/pre-app-run.ts
+/**
+* Resets the web build back to development by setting `NODE_ENV` in the process and the project `.env`.
+* @param projectRoot - Resolved project root containing the `.env` file.
+*/
+async function run(projectRoot) {
+	await setNodeEnv("development", projectRoot);
+}
+
+//#endregion
+//#region source/cli/index.ts
+/**
+* Internal App Builder hook handlers, loaded by the hook files that
+* `@adobe/aio-commerce-lib-app` generates. Not part of the public API.
+* @packageDocumentation
+*/
+const USER_HOOKS_DIR = "hooks";
+const USER_HOOK_FILE_EXTENSIONS = [
+	".ts",
+	".mts",
+	".cts",
+	".js",
+	".mjs",
+	".cjs"
+];
+let isDevSession = false;
+/**
+* Finds the user hook file for a hook, looking in the extension point's `hooks`
+* folder first and then in the project root `hooks` folder.
+*
+* @param projectRoot - Resolved project root.
+* @param extensionPointId - The extension point ID, e.g. "commerce/backend-ui/2".
+* @param hookName - The hook name, e.g. "pre-app-build".
+*/
+function findUserHook(projectRoot, extensionPointId, hookName) {
+	const dirs = [join(projectRoot, getExtensionPointFolderPath(extensionPointId), USER_HOOKS_DIR), join(projectRoot, USER_HOOKS_DIR)];
+	for (const dir of dirs) {
+		const matches = USER_HOOK_FILE_EXTENSIONS.map((extension) => join(dir, `${hookName}${extension}`)).filter((file) => existsSync(file));
+		if (matches.length > 1) throw new Error(`Found more than one "${hookName}" hook file in ${dir}: ${matches.join(", ")}. Keep only one.`);
+		if (matches.length === 1) return matches[0];
+	}
+	return null;
+}
+/**
+* Runs the user hook file for a hook, if there is one.
+*
+* @param projectRoot - Resolved project root.
+* @param hookName - The hook name, e.g. "pre-app-build".
+* @param extension - The extension the hook is registered for.
+* @param hookArgs - The argument the aio CLI passed to the hook.
+*/
+async function runUserHook(projectRoot, hookName, extension, hookArgs) {
+	const extensionPoint = `commerce/${extension}`;
+	const file = findUserHook(projectRoot, extensionPoint, hookName);
+	if (!file) return;
+	const { createJiti } = await import("jiti");
+	const hook = await createJiti(import.meta.url).import(file, { default: true });
+	if (typeof hook !== "function") throw new Error(`${file} must export a function as its default export.`);
+	await hook(hookArgs, { extensionPoint });
+}
+/**
+* Creates an async App Builder hook that runs the given function and then the
+* user hook file, logging any error and exiting the process with code 1.
+*
+* @param hookName - The hook name, e.g. "pre-app-build".
+* @param extension - The extension the hook is registered for.
+* @param fn - The hook implementation.
+*/
+function createHook(hookName, extension, fn) {
+	return async (hookArgs) => {
+		try {
+			const projectRoot = await getProjectRootDirectory();
+			await fn(projectRoot);
+			await runUserHook(projectRoot, hookName, extension, hookArgs);
+		} catch (error) {
+			if (error instanceof CommerceSdkValidationError) consola$1.error(error.display());
+			else consola$1.error(error);
+			process.exit(1);
+		}
+	};
+}
+/**
+* Creates the `pre-app-build` hook for the given extension.
+* @param extension - The extension the hook is registered for.
+*/
+function preAppBuild(extension) {
+	return createHook("pre-app-build", extension, (projectRoot) => run$2(extension, projectRoot, TEMPLATES_DIR, { isDevSession }));
+}
+/**
+* Creates the `pre-app-run` hook for the given extension.
+* @param extension - The extension the hook is registered for.
+*/
+function preAppRun(extension) {
+	return createHook("pre-app-run", extension, (projectRoot) => {
+		isDevSession = true;
+		return run(projectRoot);
+	});
+}
+/**
+* Creates the `pre-app-dev` hook for the given extension.
+* @param extension - The extension the hook is registered for.
+*/
+function preAppDev(extension) {
+	return createHook("pre-app-dev", extension, (projectRoot) => {
+		isDevSession = true;
+		return run$1(projectRoot);
+	});
+}
+/**
+* Creates the `post-app-deploy` hook for the given extension.
+* @param extension - The extension the hook is registered for.
+*/
+function postAppDeploy(extension) {
+	return createHook("post-app-deploy", extension, () => run$3());
+}
+
+//#endregion
+export { postAppDeploy, preAppBuild, preAppDev, preAppRun };