@adobe/aio-commerce-lib-app 2.0.0-beta-20260820174436 → 2.0.0

package/dist/es/{management-BTWQdJNO.mjs → management-DgwAhaaJ.mjs}

@@ -15,17 +15,17 @@
 import { C as makeWorkspaceConfig, S as groupEventsByRuntimeActions, T as sanitizeEventingIdentifier, _ as getNamespacedEvent, a as eventCodeOf, b as getRegistrationName, c as findExistingRegistrations, d as generateInstanceIdDeprecated, f as getCommerceEventingConfigurationUpdateParams, g as getLegacyRegistrationName, h as getIoEventsExistingData, i as diffByKey, l as findExistingSubscription, m as getIoEventCode, n as EVENTS_STORAGE_KEY, o as findExistingProvider, p as getCommerceEventingExistingData, r as EXTERNAL_PROVIDER_TYPE, s as findExistingProviderMetadata, t as COMMERCE_PROVIDER_TYPE, u as generateInstanceId, v as getProviderKey, w as removeStoredEventProviders, x as getSubscriptionChangeKind, y as getRegistrationDescription } from "./utils-DgpVB4lT.mjs";
 import { t as stringifyError } from "./error-_RMwtrUA.mjs";
 import { a as parseOrThrow, i as getInstallCommerceEnv, t as appliesToEnv } from "./environment-C84BPRJZ.mjs";
-import { a as hasCustomInstallationSteps, c as hasEventing, d as hasAdminUi, l as hasExternalEvents, n as hasWebhooks, s as hasCommerceEvents } from "./webhooks-BQ8kSN2Z.mjs";
+import { a as hasCustomInstallationSteps, c as hasEventing, d as hasAdminUi, l as hasExternalEvents, n as hasWebhooks, s as hasCommerceEvents } from "./webhooks-CHZ1SXxw.mjs";
 import { n as LIFECYCLE_HTTP_CLIENT_TIMEOUT_MS, t as inspect } from "./logging-CXesop3u.mjs";
 import { resolveCommerceHttpClientParams, resolveIoEventsHttpClientParams } from "@adobe/aio-commerce-lib-api";
 import { getSystemConfigByKey, setSystemConfigByKey } from "@adobe/aio-commerce-lib-config";
 import { resolveImsAuthParams } from "@adobe/aio-commerce-lib-auth";
 import stringify, { stringify as stringify$1 } from "safe-stable-stringify";
 import * as v from "valibot";
+import { createAdminUiApiClient } from "@adobe/aio-commerce-lib-admin-ui/api";
 import { HTTPError } from "ky";
 import { HTTP_NOT_FOUND, unwrapHttpError } from "@adobe/aio-commerce-lib-api/utils";
 import * as camelcaseModule from "camelcase";
-import { createAdminUiApiClient } from "@adobe/aio-commerce-lib-admin-ui/api";
 import { createCustomCommerceEventsApiClient, createEventProvider, createEventSubscription, deleteEventProvider, deleteEventSubscription, getAllEventProviders, getAllEventSubscriptions, updateEventSubscription, updateEventingConfiguration } from "@adobe/aio-commerce-lib-events/commerce";
 import { createCustomAdobeIoEventsApiClient, createEventMetadataForProvider, createEventProvider as createEventProvider$1, createRegistration, deleteEventMetadataForProvider, deleteEventProvider as deleteEventProvider$1, deleteRegistration, getAllEventProviders as getAllEventProviders$1, getAllRegistrations, updateRegistration } from "@adobe/aio-commerce-lib-events/io-events";
 import { createCustomCommerceWebhooksApiClient, getWebhookList, subscribeWebhook, unsubscribeWebhook } from "@adobe/aio-commerce-lib-webhooks/api";
@@ -511,6 +511,18 @@ function resolveCustomScriptHandler(scriptModule, handler) {
 	return null;
 }
 /**
+* Resolves a script module from the customScripts context, throwing when it's absent.
+*
+* @param customScripts - The customScripts context containing the loaded modules.
+* @param script - The script path to resolve the module for.
+* @throws If the script is not present in the context.
+*/
+function getScriptModuleOrThrow(customScripts, script) {
+	const scriptModule = getScriptModule(customScripts, script);
+	if (!scriptModule) throw new Error(`Script ${script} not found in customScripts context. Make sure the script is defined in the configuration and the action was generated with custom scripts support.`);
+	return scriptModule;
+}
+/**
 * Creates a leaf step for executing a single custom installation script.
 */
 function createCustomScriptStep(scriptConfig) {
@@ -521,9 +533,7 @@ function createCustomScriptStep(scriptConfig) {
 			const customScripts = context.customScripts || {};
 			logger.info(`Executing custom installation script: ${name}`);
 			logger.debug(`Script path: ${script}`);
-			const scriptModule = getScriptModule(customScripts, script);
-			if (!scriptModule) throw new Error(`Script ${script} not found in customScripts context. Make sure the script is defined in the configuration and the action was generated with custom scripts support.`);
-			const scriptResult = await resolveCustomScriptHandler(scriptModule, "install")(config, context);
+			const scriptResult = await resolveCustomScriptHandler(getScriptModuleOrThrow(customScripts, script), "install")(config, context);
 			logger.info(`Successfully executed script: ${name}`);
 			return {
 				data: scriptResult,
@@ -565,8 +575,134 @@ function createCustomScriptSteps(config) {
 	return steps.map((scriptConfig) => createCustomScriptStep(scriptConfig));
 }
 
+//#endregion
+//#region source/management/domains/custom-installation/apply.ts
+/** Runs a newly-added step's `install` handler and returns its persisted identity. */
+async function runAddedStep(step, targetConfig, context) {
+	const { logger } = context;
+	const scriptModule = getScriptModuleOrThrow(context.customScripts ?? {}, step.script);
+	logger.info(`Executing custom installation script: ${step.name}`);
+	await resolveCustomScriptHandler(scriptModule, "install")(targetConfig, context);
+	logger.info(`Successfully executed script: ${step.name}`);
+	return {
+		name: step.name,
+		script: step.script
+	};
+}
+/**
+* Applies the plan: runs `install` for first-time steps, warns about retained steps that point to
+* a different script (without re-running them), and ignores steps no longer in the config. Returns
+* the baseline history with the newly-added steps appended.
+*/
+async function applyCustomInstallationSteps(plan, context) {
+	const { baselineExecutedSteps, targetConfig, operations } = plan;
+	if (!targetConfig) return { snapshotData: { executedSteps: baselineExecutedSteps } };
+	const targetSteps = hasCustomInstallationSteps(targetConfig) ? targetConfig.installation.customInstallationSteps : [];
+	const addedNames = new Set(operations.filter((op) => op.kind === "add").map((op) => op.after.name));
+	for (const targetStep of targetSteps) {
+		if (addedNames.has(targetStep.name)) continue;
+		const baselineStep = baselineExecutedSteps.find((step) => step.name === targetStep.name);
+		if (baselineStep && baselineStep.script !== targetStep.script) context.logger.warn(`Custom installation step "${targetStep.name}" now points to a different script ("${targetStep.script}" instead of "${baselineStep.script}"). This does not affect append-only behavior: its install already ran and will not run again.`);
+	}
+	const addedSteps = targetSteps.filter((step) => addedNames.has(step.name));
+	const addedIdentities = [];
+	for (const step of addedSteps) addedIdentities.push(await runAddedStep(step, targetConfig, context));
+	return { snapshotData: { executedSteps: [...baselineExecutedSteps, ...addedIdentities] } };
+}
+
+//#endregion
+//#region source/management/domains/custom-installation/plan.ts
+/** Builds an `add` operation for a step run for the first time. */
+function buildAddOperation(step) {
+	return {
+		after: {
+			name: step.name,
+			script: step.script
+		},
+		id: `add:${step.name}`,
+		kind: "add",
+		label: `Run custom installation step "${step.name}"`
+	};
+}
+/**
+* Builds an informational `remove` operation for a step no longer in the target config. No
+* `uninstall` runs from it; it exists so the plan reflects that the step left the configuration.
+*/
+function buildRemoveOperation(step) {
+	return {
+		before: {
+			name: step.name,
+			script: step.script
+		},
+		id: `remove:${step.name}`,
+		kind: "remove",
+		label: `Custom installation step "${step.name}" no longer in the configuration`
+	};
+}
+/**
+* Resolves the executed-step history to diff the target against. Prefers the reconciliation
+* snapshot when present, and otherwise reconstructs it from the baseline config's own steps.
+*/
+function resolveBaselineExecutedSteps(baseline) {
+	const recorded = baseline?.data?.executedSteps;
+	if (recorded) return recorded;
+	if (baseline && hasCustomInstallationSteps(baseline.config)) return baseline.config.installation.customInstallationSteps.map((step) => ({
+		name: step.name,
+		script: step.script
+	}));
+	return [];
+}
+/**
+* Plans the custom installation steps domain by diffing the baseline's executed-step history
+* against the target config's steps, by `name`: `add` for names not seen before, `remove` for
+* names no longer configured. Steps present in both produce no operation and are never re-run.
+*/
+function planCustomInstallationSteps(input, _context) {
+	const { path, baseline, targetConfig } = input;
+	const baselineExecutedSteps = resolveBaselineExecutedSteps(baseline);
+	const targetSteps = targetConfig && hasCustomInstallationSteps(targetConfig) ? targetConfig.installation.customInstallationSteps : [];
+	const baselineNames = new Set(baselineExecutedSteps.map((s) => s.name));
+	const targetNames = new Set(targetSteps.map((s) => s.name));
+	const operations = [...targetSteps.filter((step) => !baselineNames.has(step.name)).map((step) => buildAddOperation(step)), ...baselineExecutedSteps.filter((step) => !targetNames.has(step.name)).map((step) => buildRemoveOperation(step))];
+	return Promise.resolve({
+		kind: "planned",
+		plan: {
+			baselineExecutedSteps,
+			operations,
+			path,
+			targetConfig
+		}
+	});
+}
+
 //#endregion
 //#region source/management/domains/custom-installation/branch.ts
+/**
+* Leaf step that reconciles the custom installation steps domain as a whole via `plan`/`apply`.
+* It participates only in the upgrade tree; the per-script leaves handle install and uninstall.
+*/
+const reconciliationStep = defineLeafStep({
+	apply: applyCustomInstallationSteps,
+	install: (config) => {
+		if (!hasCustomInstallationSteps(config)) return { executedSteps: [] };
+		return { executedSteps: config.installation.customInstallationSteps.map((step) => ({
+			name: step.name,
+			script: step.script
+		})) };
+	},
+	meta: {
+		install: {
+			description: "Records which custom installation steps ran, so future upgrades can detect additions and removals",
+			label: "Reconcile Custom Installation Steps"
+		},
+		upgrade: {
+			description: "Runs custom installation steps added since the last version",
+			label: "Reconcile Custom Installation Steps"
+		}
+	},
+	name: "reconciliation",
+	plan: planCustomInstallationSteps
+});
 /** Root custom installation step that executes custom installation scripts. */
 const customInstallationStepBase = defineBranchStep({
 	children: [],
@@ -579,18 +715,33 @@ const customInstallationStepBase = defineBranchStep({
 		uninstall: {
 			description: "Executes custom uninstallation scripts defined in the application configuration",
 			label: "Custom Uninstallation Steps"
+		},
+		upgrade: {
+			description: "Reconciles custom installation steps added or removed between versions",
+			label: "Custom Installation Steps"
 		}
 	},
 	name: "customInstallationSteps"
 });
 /**
-* Creates the custom installation step with dynamic children based on config.
-* Each custom script becomes a direct child step.
-*/
-function createCustomInstallationStep(config) {
+* Creates the custom installation step with dynamic children based on config. `executedSteps` is
+* the recorded run history, only passed when building the full-uninstall tree.
+* `includeReconciliation` adds the reconciliation leaf, which only runs on upgrade; install and
+* uninstall leave it out.
+*/
+function createCustomInstallationStep(config, executedSteps = [], includeReconciliation = false) {
+	const children = executedSteps.length > 0 ? [...executedSteps].reverse().map((identity) => {
+		const currentStep = hasCustomInstallationSteps(config) ? config.installation.customInstallationSteps.find((step) => step.name === identity.name) : void 0;
+		return createCustomScriptStep(currentStep ?? {
+			description: "Previously executed custom installation step, no longer present in the configuration.",
+			name: identity.name,
+			script: identity.script
+		});
+	}) : [...createCustomScriptSteps(config), ...includeReconciliation ? [reconciliationStep] : []];
 	return {
 		...customInstallationStepBase,
-		children: createCustomScriptSteps(config)
+		children,
+		isConfigured: (candidateConfig) => hasCustomInstallationSteps(candidateConfig) || executedSteps.length > 0
 	};
 }
 
@@ -841,6 +992,18 @@ function enumerateComponents(adminUi) {
 		label: "menu",
 		ref: { kind: "menu" }
 	});
+	for (const aclEntry of adminUi.acl ?? []) {
+		const key = `acl.${aclEntry.id}`;
+		components.set(key, {
+			config: aclEntry,
+			key,
+			label: `acl resource "${aclEntry.id}"`,
+			ref: {
+				id: aclEntry.id,
+				kind: "acl"
+			}
+		});
+	}
 	for (const entity of ADMIN_UI_ENTITIES) {
 		const entityConfig = adminUi[entity];
 		if (!entityConfig) continue;
@@ -1116,15 +1279,24 @@ async function reconcileProviderSubResources(baseline, target, targetMetadata, b
 	}
 	await removeDroppedMetadata(providerData, options.type, target.events, baseline.events, targetMetadata, baselineMetadata, context);
 }
-/** Finds the deployed I/O Events provider by its current or legacy instance id. */
+/**
+* Finds the deployed I/O Events provider for a target, preferring the current workspace-scoped
+* instance id over the legacy (workspace-less) one, and a metadata-bearing provider over an empty
+* duplicate that shares its instance id.
+*/
 function resolveDeployedProvider(target, targetMetadata, baselineMetadata, workspaceId, existingData) {
-	const candidates = /* @__PURE__ */ new Set([
+	const orderedCandidates = [
 		generateInstanceId(targetMetadata, target.provider, workspaceId),
-		generateInstanceIdDeprecated(targetMetadata, target.provider),
 		generateInstanceId(baselineMetadata, target.provider, workspaceId),
+		generateInstanceIdDeprecated(targetMetadata, target.provider),
 		generateInstanceIdDeprecated(baselineMetadata, target.provider)
-	]);
-	return existingData.providersWithMetadata.find((candidate) => candidates.has(candidate.instance_id)) ?? null;
+	];
+	for (const candidate of orderedCandidates) {
+		const matches = existingData.providersWithMetadata.filter((provider) => provider.instance_id === candidate);
+		if (matches.length === 0) continue;
+		return matches.find((provider) => provider.metadata.length > 0) ?? matches[0];
+	}
+	return null;
 }
 /** The fully-qualified I/O Events code set for a group of events under a provider type. */
 function eventCodeSet(events, type, metadata) {
@@ -2941,22 +3113,26 @@ const webhooksStep = defineBranchStep({
 //#endregion
 //#region source/management/installation/root.ts
 /**
-* Creates the default child steps built-in in the library with dynamic children based on the config.
+* Creates the default child steps built-in in the library with dynamic children based on the
+* config. `executedCustomInstallationSteps` is only meaningful for a full uninstall (see
+* {@link createRootUninstallationStep}). `includeReconciliation` adds the reconciliation leaf,
+* which only runs on upgrade.
 */
-function createDefaultChildSteps(config) {
+function createDefaultChildSteps(config, executedCustomInstallationSteps = [], includeReconciliation = false) {
 	return [
 		eventingStep,
 		webhooksStep,
 		adminUiStep,
-		createCustomInstallationStep(config)
+		createCustomInstallationStep(config, executedCustomInstallationSteps, includeReconciliation)
 	];
 }
 /**
-* Creates a root installation step with dynamic children based on the config.
+* Creates a root installation step with dynamic children based on the config. `forUpgrade` adds the
+* reconciliation leaf, which only runs on upgrade.
 */
-function createRootInstallationStep(config) {
+function createRootInstallationStep(config, { forUpgrade = false } = {}) {
 	return defineBranchStep({
-		children: createDefaultChildSteps(config),
+		children: createDefaultChildSteps(config, [], forUpgrade),
 		meta: {
 			install: {
 				description: "App installation workflow",
@@ -2976,10 +3152,14 @@ function createRootInstallationStep(config) {
 }
 /**
 * Creates a root uninstallation step with dynamic children based on the config.
+*
+* `executedCustomInstallationSteps` is the persisted history of every custom installation step
+* that ever ran (from the lifecycle baseline snapshot). Passing it lets a full unassociate reach
+* steps that ran in a previous version but were since removed from the config.
 */
-function createRootUninstallationStep(config) {
+function createRootUninstallationStep(config, executedCustomInstallationSteps = []) {
 	return defineBranchStep({
-		children: createDefaultChildSteps(config),
+		children: createDefaultChildSteps(config, executedCustomInstallationSteps),
 		meta: { install: {
 			description: "App uninstallation workflow",
 			label: "Uninstallation"
@@ -3067,8 +3247,8 @@ async function runInstallation(options) {
 * Creates an initial uninstallation state from the config and step definitions.
 */
 function createInitialUninstallationState(options) {
-	const { config } = options;
-	const rootStep = createRootUninstallationStep(config);
+	const { config, executedCustomInstallationSteps = [] } = options;
+	const rootStep = createRootUninstallationStep(config, executedCustomInstallationSteps);
 	return createInitialState({
 		config,
 		mode: "uninstall",
@@ -3079,8 +3259,8 @@ function createInitialUninstallationState(options) {
 * Runs the full uninstallation workflow. Returns the final state (never throws).
 */
 function runUninstallation(options) {
-	const { installationContext, config, initialState, hooks } = options;
-	const rootStep = createRootUninstallationStep(config);
+	const { installationContext, config, initialState, hooks, executedCustomInstallationSteps = [] } = options;
+	const rootStep = createRootUninstallationStep(config, executedCustomInstallationSteps);
 	return executeUninstallWorkflow({
 		config,
 		failureKey: "INSTALLATION_FAILED",