@adobe/aio-commerce-lib-app 0.2.0 → 0.3.0

package/dist/cjs/error-Byj1DVHZ.cjs

@@ -0,0 +1,344 @@
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") {
+		for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+			key = keys[i];
+			if (!__hasOwnProp.call(to, key) && key !== except) {
+				__defProp(to, key, {
+					get: ((k) => from[k]).bind(null, key),
+					enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+				});
+			}
+		}
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+let valibot = require("valibot");
+valibot = __toESM(valibot);
+let _adobe_aio_commerce_lib_core_error = require("@adobe/aio-commerce-lib-core/error");
+
+//#region ../../packages-private/common-utils/source/valibot/schemas.ts
+const ALPHANUMERIC_OR_UNDERSCORE_REGEX = {
+	any: /^[a-zA-Z0-9_]+$/,
+	lowercase: /^[a-z0-9_]+$/,
+	uppercase: /^[A-Z0-9_]+$/
+};
+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 valibot.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 valibot.pipe(stringValueSchema(name), valibot.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 valibot.boolean(`Expected a boolean value for '${name}'`);
+}
+/**
+* A schema for a string that only contains alphanumeric characters and underscores.
+* @param name The name of the field this schema refers to.
+* @param casing The allowed casing for the string (default: "any").
+*/
+function alphaNumericOrUnderscoreSchema(name, casing = "any") {
+	const casingLabel = casing === "any" ? "" : ` (${casing} only)`;
+	return valibot.pipe(stringValueSchema(name), valibot.regex(ALPHANUMERIC_OR_UNDERSCORE_REGEX[casing], `Only alphanumeric characters and underscores are allowed in string value of "${name}"${casingLabel}`));
+}
+/**
+* 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 valibot.pipe(stringValueSchema(name), valibot.regex(ALPHANUMERIC_OR_HYPHEN_REGEX[casing], `Only alphanumeric characters and hyphens are allowed in string value of "${name}"${casingLabel}`));
+}
+
+//#endregion
+//#region source/config/schema/installation.ts
+const MAX_DESCRIPTION_LENGTH$1 = 255;
+const MAX_NAME_LENGTH = 255;
+const MAX_MESSAGE_LENGTH = 1e3;
+/**
+* Regex for script paths that can be relative or absolute.
+* Must end with .js extension
+* Examples:
+*   - "./scripts/setup.js"
+*   - "./setup.js"
+*   - "../../scripts/setup.js"
+*/
+const SCRIPT_PATH_REGEX = /^(?:\.{0,2}\/)*[\w-/]*[\w-]+\.js$/;
+/**
+* Schema for custom installation step configuration
+*/
+const CustomInstallationStepSchema = valibot.object({
+	script: valibot.pipe(nonEmptyStringValueSchema("script path"), valibot.regex(SCRIPT_PATH_REGEX, "Script path must end with .js (e.g., \"./setup.js\", \"./scripts/setup.js\", or \"../../scripts/setup.js\")")),
+	name: valibot.pipe(nonEmptyStringValueSchema("step name"), valibot.maxLength(MAX_NAME_LENGTH, `The step name must not be longer than ${MAX_NAME_LENGTH} characters`)),
+	description: valibot.pipe(nonEmptyStringValueSchema("step description"), valibot.maxLength(MAX_DESCRIPTION_LENGTH$1, `The step description must not be longer than ${MAX_DESCRIPTION_LENGTH$1} characters`))
+});
+/**
+* Schema for installation messages configuration
+*/
+const MessagesSchema = valibot.object({
+	preInstallation: valibot.optional(valibot.pipe(nonEmptyStringValueSchema("preInstallation message"), valibot.maxLength(MAX_MESSAGE_LENGTH, `The preInstallation message must not be longer than ${MAX_MESSAGE_LENGTH} characters`))),
+	postInstallation: valibot.optional(valibot.pipe(nonEmptyStringValueSchema("postInstallation message"), valibot.maxLength(MAX_MESSAGE_LENGTH, `The postInstallation message must not be longer than ${MAX_MESSAGE_LENGTH} characters`)))
+});
+/**
+* Schema for installation configuration
+*/
+const InstallationSchema = valibot.object({
+	messages: valibot.optional(MessagesSchema),
+	customInstallationSteps: valibot.pipe(valibot.optional(valibot.array(CustomInstallationStepSchema, "Expected an array of custom installation steps")), valibot.check((input) => {
+		const steps = input || [];
+		return new Set(steps.map((step) => step.name)).size === steps.length;
+	}, "Duplicate step names detected in custom installation steps. Each step must have a unique name."))
+});
+/**
+* Check if config has custom installation settings.
+* @param config - The configuration to check.
+*/
+function hasCustomInstallation(config) {
+	return config.installation !== void 0;
+}
+/**
+* Check if config has custom installation steps.
+* @param config - The configuration to check.
+*/
+function hasCustomInstallationSteps(config) {
+	return Array.isArray(config?.installation?.customInstallationSteps) && config.installation.customInstallationSteps.length > 0;
+}
+
+//#endregion
+//#region source/config/schema/eventing.ts
+const MAX_DESCRIPTION_LENGTH = 255;
+const MAX_LABEL_LENGTH = 100;
+const MAX_KEY_LENGTH = 50;
+/**
+* Regex for Commerce event names that must start with "plugin." or "observer."
+* followed by lowercase letters and underscores only.
+* Examples: "plugin.order_placed", "observer.catalog_update"
+*/
+const COMMERCE_EVENT_NAME_REGEX = /^(?:plugin|observer)\.[a-z_]+$/;
+/**
+* Regex for field names according to XSD fieldName pattern.
+* Field name can either contain only [a-zA-Z0-9_\-\.\[\]] or be set to *.
+*/
+const FIELD_NAME_REGEX = /^([a-zA-Z0-9_\-.[\]]+|\*)$/;
+/**
+* Schema for Commerce event names.
+* Validates that the event name starts with "plugin." or "observer."
+* followed by lowercase letters and underscores only.
+*/
+function commerceEventNameSchema() {
+	return valibot.pipe(nonEmptyStringValueSchema("event name"), valibot.regex(COMMERCE_EVENT_NAME_REGEX, "Event name must start with \"plugin.\" or \"observer.\" followed by lowercase letters and underscores only (e.g., \"plugin.order_placed\")"));
+}
+/**
+* Schema for field names.
+* Validates that the field name matches the XSD fieldName pattern:
+* can either contain only [a-zA-Z0-9_\-\.\[\]] or be set to *.
+*/
+function fieldNameSchema() {
+	return valibot.pipe(nonEmptyStringValueSchema("field name"), valibot.regex(FIELD_NAME_REGEX, "Field name must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), dots (.), and square brackets ([, ]), or be exactly \"*\""));
+}
+/**
+* Schema for field objects in Commerce events.
+* Each field has a required name and an optional source.
+*/
+function commerceEventFieldSchema() {
+	return valibot.object({
+		name: fieldNameSchema(),
+		source: valibot.optional(stringValueSchema("field source"))
+	});
+}
+/** Schema for event provider configuration */
+const ProviderSchema = valibot.object({
+	label: valibot.pipe(nonEmptyStringValueSchema("provider label"), valibot.maxLength(MAX_LABEL_LENGTH, `The provider label must not be longer than ${MAX_LABEL_LENGTH} characters`)),
+	description: valibot.pipe(nonEmptyStringValueSchema("provider description"), valibot.maxLength(MAX_DESCRIPTION_LENGTH, `The provider description must not be longer than ${MAX_DESCRIPTION_LENGTH} characters`)),
+	key: valibot.optional(valibot.pipe(alphaNumericOrHyphenSchema("provider key"), valibot.maxLength(MAX_KEY_LENGTH, `The provider key must not be longer than ${MAX_KEY_LENGTH} characters`)))
+});
+/** Schema for base shared properties between event types. */
+const BaseEventSchema = valibot.object({
+	label: valibot.pipe(nonEmptyStringValueSchema("event label"), valibot.maxLength(MAX_LABEL_LENGTH, `The event label must not be longer than ${MAX_LABEL_LENGTH} characters`)),
+	description: valibot.pipe(nonEmptyStringValueSchema("event description"), valibot.maxLength(MAX_DESCRIPTION_LENGTH, `The event description must not be longer than ${MAX_DESCRIPTION_LENGTH} characters`)),
+	runtimeActions: valibot.array(valibot.pipe(nonEmptyStringValueSchema("runtime action"), valibot.regex(/^[a-z0-9-]+\/[a-z0-9-]+$/, "Runtime action must be in the format \"<package>/<action>\" (e.g., \"my-package/my-action\")")), "Expected an array of runtime actions in the format <package>/<action>")
+});
+/**
+* Schema for rule operator values.
+* Valid operators for Commerce event filtering rules.
+*/
+const OPERATORS = [
+	"greaterThan",
+	"lessThan",
+	"equal",
+	"regex",
+	"in",
+	"onChange"
+];
+const ruleOperatorSchema = valibot.union(OPERATORS.map((op) => valibot.literal(op)), `Operator must be one of: ${OPERATORS.join(", ")}`);
+/** Schema for Commerce event rule configuration */
+const CommerceEventRuleSchema = valibot.object({
+	field: nonEmptyStringValueSchema("rule field"),
+	operator: ruleOperatorSchema,
+	value: nonEmptyStringValueSchema("rule value")
+});
+/** Schema for Commerce event configuration */
+const CommerceEventSchema = valibot.object({
+	...BaseEventSchema.entries,
+	name: commerceEventNameSchema(),
+	fields: valibot.array(commerceEventFieldSchema(), "Expected an array of event field objects with a 'name' property"),
+	rules: valibot.optional(valibot.array(CommerceEventRuleSchema, "Expected an array of event rules with field, operator, and value")),
+	destination: valibot.optional(nonEmptyStringValueSchema("destination")),
+	hipaaAuditRequired: valibot.optional(booleanValueSchema("hipaaAuditRequired")),
+	prioritary: valibot.optional(booleanValueSchema("prioritary")),
+	force: valibot.optional(booleanValueSchema("force"))
+});
+/** Schema for external event configuration */
+const ExternalEventSchema = valibot.object({
+	...BaseEventSchema.entries,
+	name: alphaNumericOrUnderscoreSchema("event name", "lowercase")
+});
+/** Schema for Commerce event source configuration */
+const CommerceEventSourceSchema = valibot.object({
+	provider: ProviderSchema,
+	events: valibot.array(CommerceEventSchema, "Expected an array of Commerce events")
+});
+/** Schema for external event source configuration */
+const ExternalEventSourceSchema = valibot.object({
+	provider: ProviderSchema,
+	events: valibot.array(ExternalEventSchema, "Expected an array of external events")
+});
+/** Schema for eventing configuration with separate commerce and external arrays */
+const EventingSchema = valibot.object({
+	commerce: valibot.optional(valibot.array(CommerceEventSourceSchema, "Expected an array of Commerce event sources")),
+	external: valibot.optional(valibot.array(ExternalEventSourceSchema, "Expected an array of external event sources"))
+});
+/**
+* Check if config has commerce event sources.
+* @param config - The configuration to check.
+*/
+function hasCommerceEvents(config) {
+	return Array.isArray(config?.eventing?.commerce) && config.eventing.commerce.length > 0;
+}
+/**
+* Check if config has external event sources.
+* @param config - The configuration to check.
+*/
+function hasExternalEvents(config) {
+	return Array.isArray(config?.eventing?.external) && config.eventing.external.length > 0;
+}
+/**
+* Check if config has any eventing configuration.
+* @param config - The configuration to check.
+*/
+function hasEventing(config) {
+	return config.eventing !== void 0;
+}
+
+//#endregion
+//#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, 'EventingSchema', {
+  enumerable: true,
+  get: function () {
+    return EventingSchema;
+  }
+});
+Object.defineProperty(exports, 'InstallationSchema', {
+  enumerable: true,
+  get: function () {
+    return InstallationSchema;
+  }
+});
+Object.defineProperty(exports, '__toESM', {
+  enumerable: true,
+  get: function () {
+    return __toESM;
+  }
+});
+Object.defineProperty(exports, 'alphaNumericOrHyphenSchema', {
+  enumerable: true,
+  get: function () {
+    return alphaNumericOrHyphenSchema;
+  }
+});
+Object.defineProperty(exports, 'hasCommerceEvents', {
+  enumerable: true,
+  get: function () {
+    return hasCommerceEvents;
+  }
+});
+Object.defineProperty(exports, 'hasCustomInstallation', {
+  enumerable: true,
+  get: function () {
+    return hasCustomInstallation;
+  }
+});
+Object.defineProperty(exports, 'hasCustomInstallationSteps', {
+  enumerable: true,
+  get: function () {
+    return hasCustomInstallationSteps;
+  }
+});
+Object.defineProperty(exports, 'hasEventing', {
+  enumerable: true,
+  get: function () {
+    return hasEventing;
+  }
+});
+Object.defineProperty(exports, 'hasExternalEvents', {
+  enumerable: true,
+  get: function () {
+    return hasExternalEvents;
+  }
+});
+Object.defineProperty(exports, 'nonEmptyStringValueSchema', {
+  enumerable: true,
+  get: function () {
+    return nonEmptyStringValueSchema;
+  }
+});
+Object.defineProperty(exports, 'stringifyError', {
+  enumerable: true,
+  get: function () {
+    return stringifyError;
+  }
+});

package/dist/cjs/{index-DS3IlISO.d.cts → index-C5SutkJQ.d.cts}

@@ -1,4 +1,4 @@
-import { r as CommerceAppConfigOutputModel } from "./app-C4HhkXbP.cjs";
+import { n as CommerceAppConfigOutputModel } from "./app-Dx0ca6oL.cjs";
 import { RuntimeActionParams } from "@adobe/aio-commerce-lib-core/params";
 import * as v from "valibot";
 import AioLogger from "@adobe/aio-lib-core-logging";

package/dist/cjs/logging-DYwr5WQk.cjs

@@ -0,0 +1,25 @@
+const require_error = require('./error-Byj1DVHZ.cjs');
+let util = require("util");
+util = require_error.__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/cjs/management/index.cjs

@@ -1 +1,9 @@
-const require_error=require(`../error-yAk1zzvx.cjs`),require_management=require(`../management-CE3_DJw4.cjs`);exports.createInitialInstallationState=require_management.t,exports.defineCustomInstallationStep=require_management.r,exports.isCompletedState=require_management.i,exports.isFailedState=require_management.a,exports.isInProgressState=require_management.o,exports.isSucceededState=require_management.s,exports.runInstallation=require_management.n;
+const require_management = require('../management-Dm5h0E6l.cjs');
+
+exports.createInitialInstallationState = require_management.createInitialInstallationState;
+exports.defineCustomInstallationStep = require_management.defineCustomInstallationStep;
+exports.isCompletedState = require_management.isCompletedState;
+exports.isFailedState = require_management.isFailedState;
+exports.isInProgressState = require_management.isInProgressState;
+exports.isSucceededState = require_management.isSucceededState;
+exports.runInstallation = require_management.runInstallation;

package/dist/cjs/management/index.d.cts

@@ -1,2 +1,2 @@
-import { A as BranchStep, B as defineBranchStep, C as StepStatus, D as isInProgressState, E as isFailedState, F as LeafStep, H as isBranchStep, I as LeafStepOptions, L as Step, M as ExecutionContext, N as InferStepOutput, O as isSucceededState, P as InstallationContext, R as StepContextFactory, S as InstallationStatus, T as isCompletedState, U as isLeafStep, V as defineLeafStep, _ as FailedInstallationState, a as CustomInstallationStepHandler, b as InstallationError, c as ExecuteWorkflowOptions, d as InstallationHooks, f as StepEvent, g as ExecutionStatus, h as StepSucceededEvent, i as runInstallation, j as BranchStepOptions, k as AnyStep, l as createInitialState, m as StepStartedEvent, n as RunInstallationOptions, o as defineCustomInstallationStep, p as StepFailedEvent, r as createInitialInstallationState, s as CreateInitialStateOptions, t as CreateInitialInstallationStateOptions, u as executeWorkflow, v as InProgressInstallationState, w as SucceededInstallationState, x as InstallationState, y as InstallationData, z as StepMeta } from "../index-DS3IlISO.cjs";
+import { A as BranchStep, B as defineBranchStep, C as StepStatus, D as isInProgressState, E as isFailedState, F as LeafStep, H as isBranchStep, I as LeafStepOptions, L as Step, M as ExecutionContext, N as InferStepOutput, O as isSucceededState, P as InstallationContext, R as StepContextFactory, S as InstallationStatus, T as isCompletedState, U as isLeafStep, V as defineLeafStep, _ as FailedInstallationState, a as CustomInstallationStepHandler, b as InstallationError, c as ExecuteWorkflowOptions, d as InstallationHooks, f as StepEvent, g as ExecutionStatus, h as StepSucceededEvent, i as runInstallation, j as BranchStepOptions, k as AnyStep, l as createInitialState, m as StepStartedEvent, n as RunInstallationOptions, o as defineCustomInstallationStep, p as StepFailedEvent, r as createInitialInstallationState, s as CreateInitialStateOptions, t as CreateInitialInstallationStateOptions, u as executeWorkflow, v as InProgressInstallationState, w as SucceededInstallationState, x as InstallationState, y as InstallationData, z as StepMeta } from "../index-C5SutkJQ.cjs";
 export { AnyStep, BranchStep, BranchStepOptions, CreateInitialInstallationStateOptions, CreateInitialStateOptions, CustomInstallationStepHandler, ExecuteWorkflowOptions, ExecutionContext, ExecutionStatus, FailedInstallationState, InProgressInstallationState, InferStepOutput, InstallationContext, InstallationData, InstallationError, InstallationHooks, InstallationState, InstallationStatus, LeafStep, LeafStepOptions, RunInstallationOptions, Step, StepContextFactory, StepEvent, StepFailedEvent, StepMeta, StepStartedEvent, StepStatus, StepSucceededEvent, SucceededInstallationState, createInitialInstallationState, createInitialState, defineBranchStep, defineCustomInstallationStep, defineLeafStep, executeWorkflow, isBranchStep, isCompletedState, isFailedState, isInProgressState, isLeafStep, isSucceededState, runInstallation };