@adobe/aio-commerce-lib-app 1.0.2 → 1.2.0

package/dist/es/{schemas-B8yIv0_b.mjs → schemas-CVXHgUhv.mjs}

@@ -1,3 +1,17 @@
+/**
+ * @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 * as v from "valibot";
 
 //#region ../../packages-private/common-utils/source/valibot/schemas.ts
@@ -7,6 +21,20 @@ const ALPHANUMERIC_OR_HYPHEN_REGEX = {
 	uppercase: /^[A-Z0-9-]+$/
 };
 /**
+* A schema for a number value.
+* @param name The name of the field this schema refers to.
+*/
+function numberValueSchema(name) {
+	return v.number(`Expected a number value for '${name}'`);
+}
+/**
+* A schema for a positive number value (including zero).
+* @param name The name of the field this schema refers to.
+*/
+function positiveNumberValueSchema(name) {
+	return v.pipe(numberValueSchema(name), v.minValue(0, `The value of ${name} must be a non-negative number`));
+}
+/**
 * A schema for a string value.
 * @param name The name of the field this schema refers to.
 */
@@ -38,4 +66,4 @@ function alphaNumericOrHyphenSchema(name, casing = "any") {
 }
 
 //#endregion
-export { stringValueSchema as i, booleanValueSchema as n, nonEmptyStringValueSchema as r, alphaNumericOrHyphenSchema as t };
+export { stringValueSchema as a, positiveNumberValueSchema as i, booleanValueSchema as n, nonEmptyStringValueSchema as r, alphaNumericOrHyphenSchema as t };

package/dist/es/{validate-DKnju9-R.mjs → validate-CqJdGzyZ.mjs}

@@ -1,5 +1,19 @@
-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";
+/**
+ * @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 { a as hasCustomInstallationSteps, d as hasAdminUiSdk, i as hasCustomInstallation, l as hasExternalEvents, n as hasWebhooks, o as EventingSchema, r as InstallationSchema, s as hasCommerceEvents, t as WebhooksSchema, u as AdminUiSdkSchema } from "./webhooks-CYo-pqbR.mjs";
+import { t as alphaNumericOrHyphenSchema } from "./schemas-CVXHgUhv.mjs";
 import { CommerceSdkValidationError } from "@adobe/aio-commerce-lib-core/error";
 import * as v from "valibot";
 import { SchemaBusinessConfig } from "@adobe/aio-commerce-lib-config";
@@ -22,6 +36,7 @@ function hasBusinessConfigSchema(config) {
 
 //#endregion
 //#region source/config/schema/metadata.ts
+const MAX_ID_LENGTH = 100;
 const MAX_DESCRIPTION_LENGTH = 255;
 const MAX_DISPLAY_NAME_LENGTH = 50;
 const NUMERIC_IDENTIFIER = "(0|[1-9]\\d*)";
@@ -31,10 +46,10 @@ function nonEmptyString(fieldName) {
 }
 /** The schema for the metadata of the application. */
 const MetadataSchema = v.object({
-	id: alphaNumericOrHyphenSchema("application id (metadata.id)"),
+	id: v.pipe(alphaNumericOrHyphenSchema("application id (metadata.id)"), v.maxLength(MAX_ID_LENGTH, `The application id must not be longer than ${MAX_ID_LENGTH} characters`)),
 	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"))
+	version: v.pipe(nonEmptyString("version"), v.regex(SEMVER_REGEX, "The version must follow semantic versioning (semver) format: Major.Minor.Patch (e.g., '1.0.0', '2.3.1')"))
 });
 /**
 * Check if config has metadata.
@@ -52,7 +67,9 @@ const CommerceAppConfigSchema = v.looseObject({
 	metadata: MetadataSchema,
 	businessConfig: v.optional(SchemaBusinessConfig),
 	eventing: v.optional(EventingSchema),
-	installation: v.optional(InstallationSchema)
+	adminUiSdk: v.optional(AdminUiSdkSchema),
+	installation: v.optional(InstallationSchema),
+	webhooks: v.optional(WebhooksSchema)
 });
 
 //#endregion
@@ -63,10 +80,12 @@ const CommerceAppConfigSchemas = {
 	businessConfig: SchemaBusinessConfig,
 	eventing: EventingSchema,
 	installation: InstallationSchema,
+	webhooks: WebhooksSchema,
 	"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)
+	"installation.customInstallationSteps": v.unwrap(InstallationSchema.entries.customInstallationSteps),
+	adminUiSdk: AdminUiSdkSchema
 };
 /**
 * Get the config domains that are present in the config.
@@ -80,6 +99,8 @@ function getConfigDomains(config) {
 		businessConfig: hasBusinessConfig(config),
 		eventing: withCommerceEvents || withExternalEvents,
 		installation: hasCustomInstallation(config),
+		webhooks: hasWebhooks(config),
+		adminUiSdk: hasAdminUiSdk(config),
 		"businessConfig.schema": hasBusinessConfigSchema(config),
 		"eventing.commerce": withCommerceEvents,
 		"eventing.external": withExternalEvents,

package/dist/es/{installation-BTL9X7iv.mjs → webhooks-CYo-pqbR.mjs}

@@ -1,6 +1,41 @@
-import { i as stringValueSchema, n as booleanValueSchema, r as nonEmptyStringValueSchema, t as alphaNumericOrHyphenSchema } from "./schemas-B8yIv0_b.mjs";
+/**
+ * @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 { a as stringValueSchema, i as positiveNumberValueSchema, n as booleanValueSchema, r as nonEmptyStringValueSchema, t as alphaNumericOrHyphenSchema } from "./schemas-CVXHgUhv.mjs";
 import * as v from "valibot";
 
+//#region source/config/schema/admin-ui-sdk.ts
+/**
+* Schema for the Admin UI SDK registration parameters (for the `adminUiSdk.registration` config section).
+* @see https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/extension-points/ for more details.
+*/
+const AdminUiSdkRegistrationSchema = v.object({ menuItems: v.array(v.object({
+	id: v.string(),
+	title: v.optional(v.string()),
+	parent: v.optional(v.string()),
+	sortOrder: v.optional(v.number()),
+	sandbox: v.optional(v.string()),
+	isSection: v.optional(v.boolean())
+})) });
+/** Schema for Admin UI SDK configuration. */
+const AdminUiSdkSchema = v.object({ registration: AdminUiSdkRegistrationSchema });
+/** Check if config has Admin UI SDK registration configuration. */
+function hasAdminUiSdk(config) {
+	return config.adminUiSdk !== void 0 && config.adminUiSdk.registration !== void 0;
+}
+
+//#endregion
 //#region source/config/schema/eventing.ts
 const MAX_DESCRIPTION_LENGTH$1 = 255;
 const MAX_LABEL_LENGTH = 100;
@@ -198,4 +233,82 @@ function hasCustomInstallationSteps(config) {
 }
 
 //#endregion
-export { hasCommerceEvents as a, EventingSchema as i, hasCustomInstallation as n, hasEventing as o, hasCustomInstallationSteps as r, hasExternalEvents as s, InstallationSchema as t };
+//#region source/config/schema/webhooks.ts
+/** Schema for webhook field configuration (name and optional source). */
+const WebhookFieldSchema = v.object({
+	name: nonEmptyStringValueSchema("field name"),
+	source: v.optional(stringValueSchema("field source"))
+});
+/** Schema for webhook rule configuration (field, operator, value). */
+const WebhookRuleSchema = v.object({
+	field: nonEmptyStringValueSchema("rule field"),
+	operator: nonEmptyStringValueSchema("rule operator"),
+	value: nonEmptyStringValueSchema("rule value")
+});
+/** Schema for webhook header configuration (name, value). */
+const WebhookHeaderSchema = v.object({
+	name: nonEmptyStringValueSchema("header name"),
+	value: nonEmptyStringValueSchema("header value")
+});
+/** batch_name and hook_name must contain only letters, numbers, and underscores. */
+const WEBHOOK_IDENTIFIER_REGEX = /^[a-zA-Z0-9_]+$/;
+/** Category for conflict detection: validation, append, or modification. */
+const CATEGORIES = [
+	"validation",
+	"append",
+	"modification"
+];
+const CategorySchema = v.picklist(CATEGORIES, `Webhook category must be one of: ${CATEGORIES.join(", ")}`);
+/** Schema for the nested webhook payload without url — used when runtimeAction resolves the URL at runtime. */
+const WebhookDefinitionBaseSchema = v.object({
+	webhook_method: nonEmptyStringValueSchema("webhook_method"),
+	webhook_type: nonEmptyStringValueSchema("webhook_type"),
+	batch_name: v.pipe(nonEmptyStringValueSchema("batch_name"), v.regex(WEBHOOK_IDENTIFIER_REGEX, "batch_name must contain only letters, numbers, and underscores")),
+	batch_order: v.optional(positiveNumberValueSchema("batch_order")),
+	hook_name: v.pipe(nonEmptyStringValueSchema("hook_name"), v.regex(WEBHOOK_IDENTIFIER_REGEX, "hook_name must contain only letters, numbers, and underscores")),
+	priority: v.optional(positiveNumberValueSchema("priority")),
+	required: v.optional(booleanValueSchema("required")),
+	soft_timeout: v.optional(positiveNumberValueSchema("soft_timeout")),
+	timeout: v.optional(positiveNumberValueSchema("timeout")),
+	method: nonEmptyStringValueSchema("HTTP method"),
+	fallback_error_message: v.optional(stringValueSchema("fallback_error_message")),
+	ttl: v.optional(positiveNumberValueSchema("ttl")),
+	fields: v.optional(v.array(WebhookFieldSchema, "Expected an array of webhook field objects")),
+	rules: v.optional(v.array(WebhookRuleSchema, "Expected an array of webhook rule objects")),
+	headers: v.optional(v.array(WebhookHeaderSchema, "Expected an array of webhook header objects"))
+});
+/** Schema for the nested webhook payload with a required url. */
+const WebhookDefinitionWithUrlSchema = v.object({
+	...WebhookDefinitionBaseSchema.entries,
+	url: v.pipe(stringValueSchema("webhook URL"), v.url("The 'url' field must be a valid absolute URL (e.g., 'https://example.com/webhook')"))
+});
+/** Schema for a webhook entry that resolves its URL from a runtime action. */
+const WebhookEntryWithRuntimeActionSchema = v.object({
+	label: nonEmptyStringValueSchema("webhook label"),
+	description: nonEmptyStringValueSchema("webhook description"),
+	category: v.optional(CategorySchema),
+	runtimeAction: nonEmptyStringValueSchema("runtimeAction"),
+	requireAdobeAuth: v.optional(booleanValueSchema("requireAdobeAuth")),
+	webhook: WebhookDefinitionBaseSchema
+});
+/** Schema for a webhook entry that provides an explicit URL. */
+const WebhookEntryWithUrlSchema = v.object({
+	label: nonEmptyStringValueSchema("webhook label"),
+	description: nonEmptyStringValueSchema("webhook description"),
+	category: v.optional(CategorySchema),
+	webhook: WebhookDefinitionWithUrlSchema
+});
+/** Schema for a single webhook entry — either runtimeAction (no url) or explicit url (no runtimeAction). */
+const WebhookEntrySchema = v.union([WebhookEntryWithRuntimeActionSchema, WebhookEntryWithUrlSchema], "Each webhook entry must define either a 'runtimeAction' (to resolve the URL from a runtime action) or an explicit 'url' inside the 'webhook' object, but not both");
+/** Schema for the optional webhooks array (when present, must have at least one item). */
+const WebhooksSchema = v.optional(v.pipe(v.array(WebhookEntrySchema, "Expected an array of webhook entries"), v.minLength(1, "webhooks array must contain at least one webhook when present")));
+/**
+* Check if config has webhooks (non-empty array).
+* @param config - The configuration to check.
+*/
+function hasWebhooks(config) {
+	return Array.isArray(config?.webhooks) && config.webhooks.length > 0;
+}
+
+//#endregion
+export { hasCustomInstallationSteps as a, hasEventing as c, hasAdminUiSdk as d, hasCustomInstallation as i, hasExternalEvents as l, hasWebhooks as n, EventingSchema as o, InstallationSchema as r, hasCommerceEvents as s, WebhooksSchema as t, AdminUiSdkSchema as u };

package/package.json

@@ -2,7 +2,7 @@
   "name": "@adobe/aio-commerce-lib-app",
   "type": "module",
   "author": "Adobe Inc.",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "private": false,
   "engines": {
     "node": ">=20 <=24"
@@ -86,6 +86,7 @@
     "consola": "^3.4.2",
     "dotenv": "^17.2.3",
     "jiti": "^2.6.1",
+    "ky": "^1.9.0",
     "openwhisk": "^3.21.8",
     "prettier": "^3.8.1",
     "regexparam": "^3.0.0",
@@ -93,20 +94,22 @@
     "type-fest": "^5.0.0",
     "valibot": "^1.1.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.2",
+    "@adobe/aio-commerce-lib-api": "1.0.1",
+    "@adobe/aio-commerce-lib-auth": "1.0.1",
+    "@adobe/aio-commerce-lib-config": "1.1.0",
     "@adobe/aio-commerce-lib-core": "1.0.0",
-    "@adobe/aio-commerce-lib-events": "1.0.0"
+    "@adobe/aio-commerce-lib-events": "1.0.1",
+    "@adobe/aio-commerce-lib-webhooks": "0.1.0"
   },
   "devDependencies": {
-    "typescript": "^5.9.2",
-    "@aio-commerce-sdk/config-tsdown": "1.0.1",
+    "msw": "^2.11.1",
+    "typescript": "^5.9.3",
+    "@aio-commerce-sdk/common-utils": "0.2.3",
     "@aio-commerce-sdk/config-typedoc": "1.0.0",
     "@aio-commerce-sdk/config-typescript": "1.0.0",
     "@aio-commerce-sdk/config-vitest": "1.0.0",
+    "@aio-commerce-sdk/config-tsdown": "1.0.1",
     "@aio-commerce-sdk/scripting-utils": "0.3.0",
-    "@aio-commerce-sdk/common-utils": "0.2.2",
     "@aio-commerce-sdk/scripts": "0.1.0"
   },
   "sideEffects": false,
@@ -118,6 +121,7 @@
     "assist": "biome check --formatter-enabled=false --linter-enabled=false --assist-enabled=true --no-errors-on-unmatched",
     "assist:apply": "biome check --write --formatter-enabled=false --linter-enabled=false --assist-enabled=true --no-errors-on-unmatched",
     "check:ci": "biome ci --formatter-enabled=true --linter-enabled=true --assist-enabled=true --no-errors-on-unmatched",
+    "code:fix": "pnpm run lint:fix && pnpm run assist:apply && pnpm run format && pnpm run format:markdown",
     "format": "biome format --write --no-errors-on-unmatched",
     "format:markdown": "prettier --no-error-on-unmatched-pattern --write '**/*.md' \"!**/{CODE_OF_CONDUCT.md,COPYRIGHT,LICENSE,SECURITY.md,CONTRIBUTING.md}\"",
     "format:check": "biome format --no-errors-on-unmatched",

package/dist/cjs/error-DJ2UAPH2.cjs

@@ -1,24 +0,0 @@
-const require_schemas = require('./schemas-CZ6c8Id9.cjs');
-let _adobe_aio_commerce_lib_core_error = require("@adobe/aio-commerce-lib-core/error");
-
-//#region ../../packages-private/scripting-utils/source/error.ts
-/**
-* This module exports shared error utilities for the AIO Commerce SDK.
-* @packageDocumentation
-*/
-/**
-* Stringify an error to a human-friendly string.
-* @param error - The error to stringify.
-*/
-function stringifyError(error) {
-	if (error instanceof _adobe_aio_commerce_lib_core_error.CommerceSdkValidationError) return error.display();
-	return error instanceof Error ? error.message : String(error);
-}
-
-//#endregion
-Object.defineProperty(exports, 'stringifyError', {
-  enumerable: true,
-  get: function () {
-    return stringifyError;
-  }
-});

package/dist/cjs/logging-IDRQG0as.cjs

@@ -1,25 +0,0 @@
-const require_schemas = require('./schemas-CZ6c8Id9.cjs');
-let util = require("util");
-util = require_schemas.__toESM(util);
-
-//#region ../../packages-private/common-utils/source/logging.ts
-/**
-* Shorthand to inspect an object.
-*
-* @param obj - The object to inspect.
-* @returns A string representation of the object.
-*/
-function inspect(obj, params = {}) {
-	return util.default.inspect(obj, {
-		depth: null,
-		...params
-	});
-}
-
-//#endregion
-Object.defineProperty(exports, 'inspect', {
-  enumerable: true,
-  get: function () {
-    return inspect;
-  }
-});

package/dist/es/error-CMV3IjBz.mjs

@@ -1,18 +0,0 @@
-import { CommerceSdkValidationError } from "@adobe/aio-commerce-lib-core/error";
-
-//#region ../../packages-private/scripting-utils/source/error.ts
-/**
-* This module exports shared error utilities for the AIO Commerce SDK.
-* @packageDocumentation
-*/
-/**
-* Stringify an error to a human-friendly string.
-* @param error - The error to stringify.
-*/
-function stringifyError(error) {
-	if (error instanceof CommerceSdkValidationError) return error.display();
-	return error instanceof Error ? error.message : String(error);
-}
-
-//#endregion
-export { stringifyError as t };

package/dist/es/logging-CzmXDzxI.mjs

@@ -1,18 +0,0 @@
-import util from "util";
-
-//#region ../../packages-private/common-utils/source/logging.ts
-/**
-* Shorthand to inspect an object.
-*
-* @param obj - The object to inspect.
-* @returns A string representation of the object.
-*/
-function inspect(obj, params = {}) {
-	return util.inspect(obj, {
-		depth: null,
-		...params
-	});
-}
-
-//#endregion
-export { inspect as t };