@adobe/aio-commerce-lib-app 0.3.2 → 1.0.1

package/dist/es/{management-Y7pwEbNI.mjs → runner-vwAhjD5r.mjs}

@@ -1,5 +1,6 @@
-import { a as hasExternalEvents, c as hasCustomInstallationSteps, i as hasEventing, r as hasCommerceEvents, t as stringifyError } from "./error-P7JgUTds.mjs";
-import { t as inspect } from "./logging-VgerMhp6.mjs";
+import { a as hasCommerceEvents, o as hasEventing, r as hasCustomInstallationSteps, s as hasExternalEvents } from "./installation-BTL9X7iv.mjs";
+import { t as stringifyError } from "./error-CMV3IjBz.mjs";
+import { t as inspect } from "./logging-CzmXDzxI.mjs";
 import camelcase from "camelcase";
 import { resolveAuthParams } from "@adobe/aio-commerce-lib-auth";
 import { resolveCommerceHttpClientParams, resolveIoEventsHttpClientParams } from "@adobe/aio-commerce-lib-api";
@@ -558,9 +559,9 @@ async function getIoEventsExistingData(context) {
 	});
 	const providersWithMetadata = existingProviders.map((providerHal) => {
 		const { _embedded, _links, ...providerData } = providerHal;
-		const actualMetadata = (_embedded?.eventmetadata ?? []).map(({ _embedded: _embedded$1, _links: _links$1, ...meta }) => ({
+		const actualMetadata = (_embedded?.eventmetadata ?? []).map(({ _embedded, _links, ...meta }) => ({
 			...meta,
-			sample: _embedded$1?.sample_event ?? null
+			sample: _embedded?.sample_event ?? null
 		}));
 		return {
 			...providerData,
@@ -749,13 +750,13 @@ async function configureCommerceEventing(params, existingData) {
 		enabled: true
 	};
 	if (existingData.isDefaultWorkspaceConfigurationEmpty) {
-		if (!config.workspaceConfiguration) {
+		if (!config.workspace_configuration) {
 			const message = "Workspace configuration is required to enable Commerce Eventing when there is not an existing one.";
 			logger.error(message);
 			throw new Error(message);
 		}
 		logger.info("Default provider workspace configuration already present, it will not be overriden");
-		const { workspaceConfiguration, ...rest } = updateParams;
+		const { workspace_configuration, ...rest } = updateParams;
 		updateParams = rest;
 	}
 	logger.info("Updating Commerce Eventing configuration with provided workspace configuration.");
@@ -779,11 +780,8 @@ async function createCommerceProvider(params) {
 	const { commerceEventsClient, logger } = context;
 	logger.info(`Creating Commerce provider "${provider.label}" with instance ID "${provider.instance_id}"`);
 	return commerceEventsClient.createEventProvider({
-		providerId: provider.id,
-		instanceId: provider.instance_id,
-		label: provider.label,
-		description: provider.description,
-		associatedWorkspaceConfiguration: provider.workspaceConfiguration
+		...provider,
+		provider_id: provider.id
 	}).then((res) => {
 		logger.info(`Commerce provider "${provider.label}" created with ID '${res.provider_id}'`);
 		return res;
@@ -820,10 +818,10 @@ async function createCommerceEventSubscription(params) {
 		name: eventName,
 		parent: event.config.name,
 		fields: event.config.fields,
-		providerId: provider.id,
+		provider_id: provider.id,
 		destination: event.config.destination,
-		hipaaAuditRequired: event.config.hipaaAuditRequired,
-		prioritary: event.config.prioritary,
+		hipaa_audit_required: event.config.hipaa_audit_required,
+		priority: event.config.priority,
 		force: event.config.force
 	};
 	logger.debug(`Event subscription specification for event "${event.config.name}": ${inspect(eventSpec)}`);
@@ -846,12 +844,7 @@ async function createOrGetCommerceEventSubscription(params, existingData) {
 	const existing = findExistingSubscription(existingData, getNamespacedEvent(metadata, event.config.name));
 	if (existing) {
 		logger.info(`Subscription for event "${event.config.name}" already exists, skipping creation.`);
-		return {
-			name: existing.name,
-			parent: existing.parent,
-			fields: existing.fields,
-			providerId: existing.provider_id
-		};
+		return existing;
 	}
 	return createCommerceEventSubscription(params);
 }
@@ -920,7 +913,7 @@ async function onboardCommerceEventing(params, existingData) {
 	const subscriptions = [];
 	await configureCommerceEventing({
 		context,
-		config: { workspaceConfiguration }
+		config: { workspace_configuration: workspaceConfiguration }
 	}, existingData);
 	const { workspace_configuration: _, ...commerceProviderData } = await createOrGetCommerceProvider({
 		context,
@@ -929,7 +922,7 @@ async function onboardCommerceEventing(params, existingData) {
 			instance_id: instanceId,
 			label: provider.label,
 			description: provider.description,
-			workspaceConfiguration
+			workspace_configuration: workspaceConfiguration
 		}
 	}, existingData.providers);
 	for (const event of events) subscriptions.push(await createOrGetCommerceEventSubscription({
@@ -984,9 +977,9 @@ const commerceEventsStep = defineLeafStep({
 				data: {
 					ioEvents: providerData,
 					commerce: commerceProvider,
-					events: eventsData.map(({ config: config$1, data }, index) => {
+					events: eventsData.map(({ config, data }, index) => {
 						return {
-							config: config$1,
+							config,
 							data: {
 								...data,
 								subscription: subscriptions[index]

package/dist/es/schemas-B8yIv0_b.mjs

@@ -0,0 +1,41 @@
+import * as v from "valibot";
+
+//#region ../../packages-private/common-utils/source/valibot/schemas.ts
+const ALPHANUMERIC_OR_HYPHEN_REGEX = {
+	any: /^[a-zA-Z0-9-]+$/,
+	lowercase: /^[a-z0-9-]+$/,
+	uppercase: /^[A-Z0-9-]+$/
+};
+/**
+* A schema for a string value.
+* @param name The name of the field this schema refers to.
+*/
+function stringValueSchema(name) {
+	return v.string(`Expected a string value for '${name}'`);
+}
+/**
+* A schema for a non-empty string value.
+* @param name The name of the field this schema refers to.
+*/
+function nonEmptyStringValueSchema(name) {
+	return v.pipe(stringValueSchema(name), v.nonEmpty(`The value of "${name}" must not be empty`));
+}
+/**
+* A schema for a boolean value.
+* @param name The name of the field this schema refers to.
+*/
+function booleanValueSchema(name) {
+	return v.boolean(`Expected a boolean value for '${name}'`);
+}
+/**
+* A schema for a string that only contains alphanumeric characters and hyphens.
+* @param name The name of the field this schema refers to.
+* @param casing The allowed casing for the string (default: "any").
+*/
+function alphaNumericOrHyphenSchema(name, casing = "any") {
+	const casingLabel = casing === "any" ? "" : ` (${casing} only)`;
+	return v.pipe(stringValueSchema(name), v.regex(ALPHANUMERIC_OR_HYPHEN_REGEX[casing], `Only alphanumeric characters and hyphens are allowed in string value of "${name}"${casingLabel}`));
+}
+
+//#endregion
+export { stringValueSchema as i, booleanValueSchema as n, nonEmptyStringValueSchema as r, alphaNumericOrHyphenSchema as t };

package/dist/es/validate-DKnju9-R.mjs

@@ -0,0 +1,187 @@
+import { t as alphaNumericOrHyphenSchema } from "./schemas-B8yIv0_b.mjs";
+import { a as hasCommerceEvents, i as EventingSchema, n as hasCustomInstallation, r as hasCustomInstallationSteps, s as hasExternalEvents, t as InstallationSchema } from "./installation-BTL9X7iv.mjs";
+import { CommerceSdkValidationError } from "@adobe/aio-commerce-lib-core/error";
+import * as v from "valibot";
+import { SchemaBusinessConfig } from "@adobe/aio-commerce-lib-config";
+
+//#region source/config/schema/business-configuration.ts
+/**
+* Check if config has business config.
+* @param config - The configuration to check.
+*/
+function hasBusinessConfig(config) {
+	return config.businessConfig !== void 0;
+}
+/**
+* Check if config has business config schema.
+* @param config - The configuration to check.
+*/
+function hasBusinessConfigSchema(config) {
+	return config.businessConfig?.schema !== void 0 && config.businessConfig.schema.length > 0;
+}
+
+//#endregion
+//#region source/config/schema/metadata.ts
+const MAX_DESCRIPTION_LENGTH = 255;
+const MAX_DISPLAY_NAME_LENGTH = 50;
+const NUMERIC_IDENTIFIER = "(0|[1-9]\\d*)";
+const SEMVER_REGEX = new RegExp(`^${NUMERIC_IDENTIFIER}\\.${NUMERIC_IDENTIFIER}\\.${NUMERIC_IDENTIFIER}$`);
+function nonEmptyString(fieldName) {
+	return v.pipe(v.string(`Expected a string for the ${fieldName}`), v.nonEmpty(`The ${fieldName} must not be empty`));
+}
+/** The schema for the metadata of the application. */
+const MetadataSchema = v.object({
+	id: alphaNumericOrHyphenSchema("application id (metadata.id)"),
+	displayName: v.pipe(nonEmptyString("application display name"), v.maxLength(MAX_DISPLAY_NAME_LENGTH, `The application display name must not be longer than ${MAX_DISPLAY_NAME_LENGTH} characters`)),
+	description: v.pipe(nonEmptyString("metadata description"), v.maxLength(MAX_DESCRIPTION_LENGTH, `The metadata description must not be longer than ${MAX_DESCRIPTION_LENGTH} characters`)),
+	version: v.pipe(nonEmptyString("version"), v.regex(SEMVER_REGEX, "The version must follow semantic versioning (semver) format"))
+});
+/**
+* Check if config has metadata.
+* @param config - The configuration to check.
+*/
+function hasMetadata(config) {
+	return config.metadata !== void 0;
+}
+
+//#endregion
+//#region source/config/schema/app.ts
+/** biome-ignore-all lint/performance/noBarrelFile: We want to have all the schema exports in one file. */
+/** The schema used to validate the commerce app config file. */
+const CommerceAppConfigSchema = v.looseObject({
+	metadata: MetadataSchema,
+	businessConfig: v.optional(SchemaBusinessConfig),
+	eventing: v.optional(EventingSchema),
+	installation: v.optional(InstallationSchema)
+});
+
+//#endregion
+//#region source/config/schema/domains.ts
+/** The individual validatable domains of the app config. */
+const CommerceAppConfigSchemas = {
+	metadata: MetadataSchema,
+	businessConfig: SchemaBusinessConfig,
+	eventing: EventingSchema,
+	installation: InstallationSchema,
+	"businessConfig.schema": v.unwrap(SchemaBusinessConfig.entries.schema),
+	"eventing.commerce": v.unwrap(EventingSchema.entries.commerce),
+	"eventing.external": v.unwrap(EventingSchema.entries.external),
+	"installation.customInstallationSteps": v.unwrap(InstallationSchema.entries.customInstallationSteps)
+};
+/**
+* Get the config domains that are present in the config.
+* @param config - The configuration to check.
+*/
+function getConfigDomains(config) {
+	const withCommerceEvents = hasCommerceEvents(config);
+	const withExternalEvents = hasExternalEvents(config);
+	const domains = {
+		metadata: hasMetadata(config),
+		businessConfig: hasBusinessConfig(config),
+		eventing: withCommerceEvents || withExternalEvents,
+		installation: hasCustomInstallation(config),
+		"businessConfig.schema": hasBusinessConfigSchema(config),
+		"eventing.commerce": withCommerceEvents,
+		"eventing.external": withExternalEvents,
+		"installation.customInstallationSteps": hasCustomInstallationSteps(config)
+	};
+	const domainsList = Object.entries(domains).filter(([_, value]) => value).map(([key]) => key);
+	return new Set(domainsList);
+}
+/**
+* Check if the config has a specific domain.
+* @param config - The configuration to check.
+* @param domain - The domain to check.
+*/
+function hasConfigDomain(config, domain) {
+	return getConfigDomains(config).has(domain);
+}
+
+//#endregion
+//#region source/config/lib/validate.ts
+const commerceAppConfigDomainsSchema = v.picklist(Object.keys(CommerceAppConfigSchemas));
+/**
+* Validates a complete commerce app configuration object against the schema.
+*
+* @param config - The configuration object to validate.
+* @returns The validated and typed configuration output model.
+*
+* @throws {CommerceSdkValidationError} If the configuration is invalid, with
+* detailed validation issues included.
+*
+* @example
+* ```typescript
+* const config = {
+*   businessConfiguration: {
+*     // ... configuration data
+*   }
+* };
+*
+* try {
+*   const validatedConfig = validateCommerceAppConfig(config);
+*   // Use validatedConfig safely
+* } catch (error) {
+*   if (error instanceof CommerceSdkValidationError) {
+*     console.error('Validation failed:', error.display());
+*   }
+* }
+* ```
+*/
+function validateCommerceAppConfig(config) {
+	const validatedConfig = v.safeParse(CommerceAppConfigSchema, config);
+	if (!validatedConfig.success) throw new CommerceSdkValidationError("Invalid commerce app config", { issues: validatedConfig.issues });
+	return validatedConfig.output;
+}
+/**
+* Validates a specific domain configuration within the commerce app config.
+*
+* This function validates only a specific domain's configuration rather than
+* the entire commerce app configuration object. It first validates that the
+* domain name is valid, then validates the configuration data against the
+* schema for that specific domain.
+*
+* @template T - The type of the domain, constrained to valid domain names.
+*
+* @param config - The domain configuration object to validate.
+* @param domain - The name of the domain to validate (e.g., 'businessConfiguration').
+* @returns The validated and typed configuration for the specified domain.
+*
+* @throws {CommerceSdkValidationError} If the domain name is invalid or if the
+* configuration doesn't match the domain's schema.
+*
+* @example
+* ```typescript
+* const businessConfig = {
+*   fields: [
+*     {
+*       name: 'category',
+*       type: 'dropdown',
+*       // ... field configuration
+*     }
+*   ]
+* };
+*
+* try {
+*   const validatedConfig = validateCommerceAppConfigDomain(
+*     businessConfig,
+*     'businessConfig'
+*   );
+*   // Use validatedConfig safely
+* } catch (error) {
+*   if (error instanceof CommerceSdkValidationError) {
+*     console.error('Domain validation failed:', error.issues);
+*   }
+* }
+* ```
+*/
+function validateCommerceAppConfigDomain(config, domain) {
+	const domainSchema = v.safeParse(commerceAppConfigDomainsSchema, domain);
+	if (!domainSchema.success) throw new CommerceSdkValidationError("Invalid commerce app config domain", { issues: domainSchema.issues });
+	const domainConfigSchema = CommerceAppConfigSchemas[domain];
+	const validatedConfig = v.safeParse(domainConfigSchema, config);
+	if (!validatedConfig.success) throw new CommerceSdkValidationError(`Invalid commerce app config: ${domain}`, { issues: validatedConfig.issues });
+	return validatedConfig.output;
+}
+
+//#endregion
+export { hasConfigDomain as a, hasBusinessConfigSchema as c, getConfigDomains as i, validateCommerceAppConfigDomain as n, hasMetadata as o, CommerceAppConfigSchemas as r, hasBusinessConfig as s, validateCommerceAppConfig as t };

package/package.json

@@ -2,13 +2,24 @@
   "name": "@adobe/aio-commerce-lib-app",
   "type": "module",
   "author": "Adobe Inc.",
-  "version": "0.3.2",
+  "version": "1.0.1",
   "private": false,
   "engines": {
     "node": ">=20 <=24"
   },
   "license": "Apache-2.0",
   "description": "App configuration management library for Adobe Commerce applications",
+  "keywords": [
+    "aio",
+    "adobe-io",
+    "commerce",
+    "adobe-commerce",
+    "adobe-commerce-sdk",
+    "aio-commerce-sdk",
+    "aio-commerce-lib-app",
+    "configuration",
+    "app-builder"
+  ],
   "bugs": {
     "url": "https://github.com/adobe/aio-commerce-sdk/issues"
   },
@@ -18,17 +29,17 @@
     "directory": "packages/aio-commerce-lib-app"
   },
   "bin": {
-    "@adobe/aio-commerce-lib-app": "./dist/es/commands/index.mjs"
+    "@adobe/aio-commerce-lib-app": "./bin/cli.mjs"
   },
   "exports": {
-    "./actions": {
+    "./actions/*": {
       "import": {
-        "types": "./dist/es/actions/index.d.mts",
-        "default": "./dist/es/actions/index.mjs"
+        "types": "./dist/es/actions/*.d.mts",
+        "default": "./dist/es/actions/*.mjs"
       },
       "require": {
-        "types": "./dist/cjs/actions/index.d.cts",
-        "default": "./dist/cjs/actions/index.cjs"
+        "types": "./dist/cjs/actions/*.d.cts",
+        "default": "./dist/cjs/actions/*.cjs"
       }
     },
     "./config": {
@@ -59,41 +70,44 @@
     "#templates/*": "./source/commands/generate/actions/templates/*.template"
   },
   "files": [
+    "bin",
     "dist",
     "package.json",
     "CHANGELOG.md",
     "README.md"
   ],
   "dependencies": {
+    "@adobe/aio-lib-core-config": "^5.0.1",
+    "@adobe/aio-lib-core-logging": "^3.0.2",
+    "@adobe/aio-lib-files": "^4.1.2",
+    "@adobe/aio-lib-ims": "^8.1.1",
+    "@adobe/aio-lib-state": "^5.3.1",
     "camelcase": "^8.0.0",
     "consola": "^3.4.2",
+    "dotenv": "^17.2.3",
     "jiti": "^2.6.1",
     "openwhisk": "^3.21.8",
     "prettier": "^3.8.1",
+    "regexparam": "^3.0.0",
     "safe-stable-stringify": "^2.5.0",
+    "type-fest": "^5.0.0",
     "valibot": "^1.1.0",
-    "dotenv": "^17.2.3",
-    "regexparam": "^3.0.0",
-    "@adobe/aio-lib-core-config": "^5.0.1",
-    "@adobe/aio-lib-ims": "^8.1.1",
-    "@adobe/aio-lib-core-logging": "^3.0.2",
-    "@adobe/aio-lib-files": "^4.1.2",
-    "@adobe/aio-lib-state": "^5.3.1",
-    "@standard-schema/spec": "^1.1.0",
-    "yaml": "^2.8.2",
-    "@adobe/aio-commerce-lib-api": "0.6.1",
-    "@adobe/aio-commerce-lib-auth": "0.8.1",
-    "@adobe/aio-commerce-lib-core": "0.6.1",
-    "@adobe/aio-commerce-lib-events": "0.6.0"
+    "yaml": "^2.8.1",
+    "@adobe/aio-commerce-lib-api": "1.0.0",
+    "@adobe/aio-commerce-lib-auth": "1.0.0",
+    "@adobe/aio-commerce-lib-config": "1.0.1",
+    "@adobe/aio-commerce-lib-core": "1.0.0",
+    "@adobe/aio-commerce-lib-events": "1.0.0"
   },
   "devDependencies": {
-    "@adobe/aio-lib-core-logging": "^3.0.2",
-    "@aio-commerce-sdk/common-utils": "0.2.1",
-    "@aio-commerce-sdk/config-tsdown": "1.0.0",
+    "typescript": "^5.9.2",
+    "@aio-commerce-sdk/common-utils": "0.2.2",
     "@aio-commerce-sdk/config-typedoc": "1.0.0",
     "@aio-commerce-sdk/config-typescript": "1.0.0",
+    "@aio-commerce-sdk/config-tsdown": "1.0.1",
     "@aio-commerce-sdk/config-vitest": "1.0.0",
-    "@aio-commerce-sdk/scripting-utils": "0.2.1"
+    "@aio-commerce-sdk/scripting-utils": "0.3.0",
+    "@aio-commerce-sdk/scripts": "0.1.0"
   },
   "sideEffects": false,
   "scripts": {