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

package/dist/es/error-P7JgUTds.mjs

@@ -0,0 +1,251 @@
+import * as v from "valibot";
+import { CommerceSdkValidationError } from "@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 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 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 v.pipe(stringValueSchema(name), v.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 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
+//#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 = v.object({
+	script: v.pipe(nonEmptyStringValueSchema("script path"), v.regex(SCRIPT_PATH_REGEX, "Script path must end with .js (e.g., \"./setup.js\", \"./scripts/setup.js\", or \"../../scripts/setup.js\")")),
+	name: v.pipe(nonEmptyStringValueSchema("step name"), v.maxLength(MAX_NAME_LENGTH, `The step name must not be longer than ${MAX_NAME_LENGTH} characters`)),
+	description: v.pipe(nonEmptyStringValueSchema("step description"), v.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 = v.object({
+	preInstallation: v.optional(v.pipe(nonEmptyStringValueSchema("preInstallation message"), v.maxLength(MAX_MESSAGE_LENGTH, `The preInstallation message must not be longer than ${MAX_MESSAGE_LENGTH} characters`))),
+	postInstallation: v.optional(v.pipe(nonEmptyStringValueSchema("postInstallation message"), v.maxLength(MAX_MESSAGE_LENGTH, `The postInstallation message must not be longer than ${MAX_MESSAGE_LENGTH} characters`)))
+});
+/**
+* Schema for installation configuration
+*/
+const InstallationSchema = v.object({
+	messages: v.optional(MessagesSchema),
+	customInstallationSteps: v.pipe(v.optional(v.array(CustomInstallationStepSchema, "Expected an array of custom installation steps")), v.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 v.pipe(nonEmptyStringValueSchema("event name"), v.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 v.pipe(nonEmptyStringValueSchema("field name"), v.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 v.object({
+		name: fieldNameSchema(),
+		source: v.optional(stringValueSchema("field source"))
+	});
+}
+/** Schema for event provider configuration */
+const ProviderSchema = v.object({
+	label: v.pipe(nonEmptyStringValueSchema("provider label"), v.maxLength(MAX_LABEL_LENGTH, `The provider label must not be longer than ${MAX_LABEL_LENGTH} characters`)),
+	description: v.pipe(nonEmptyStringValueSchema("provider description"), v.maxLength(MAX_DESCRIPTION_LENGTH, `The provider description must not be longer than ${MAX_DESCRIPTION_LENGTH} characters`)),
+	key: v.optional(v.pipe(alphaNumericOrHyphenSchema("provider key"), v.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 = v.object({
+	label: v.pipe(nonEmptyStringValueSchema("event label"), v.maxLength(MAX_LABEL_LENGTH, `The event label must not be longer than ${MAX_LABEL_LENGTH} characters`)),
+	description: v.pipe(nonEmptyStringValueSchema("event description"), v.maxLength(MAX_DESCRIPTION_LENGTH, `The event description must not be longer than ${MAX_DESCRIPTION_LENGTH} characters`)),
+	runtimeActions: v.array(v.pipe(nonEmptyStringValueSchema("runtime action"), v.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 = v.union(OPERATORS.map((op) => v.literal(op)), `Operator must be one of: ${OPERATORS.join(", ")}`);
+/** Schema for Commerce event rule configuration */
+const CommerceEventRuleSchema = v.object({
+	field: nonEmptyStringValueSchema("rule field"),
+	operator: ruleOperatorSchema,
+	value: nonEmptyStringValueSchema("rule value")
+});
+/** Schema for Commerce event configuration */
+const CommerceEventSchema = v.object({
+	...BaseEventSchema.entries,
+	name: commerceEventNameSchema(),
+	fields: v.array(commerceEventFieldSchema(), "Expected an array of event field objects with a 'name' property"),
+	rules: v.optional(v.array(CommerceEventRuleSchema, "Expected an array of event rules with field, operator, and value")),
+	destination: v.optional(nonEmptyStringValueSchema("destination")),
+	hipaaAuditRequired: v.optional(booleanValueSchema("hipaaAuditRequired")),
+	prioritary: v.optional(booleanValueSchema("prioritary")),
+	force: v.optional(booleanValueSchema("force"))
+});
+/** Schema for external event configuration */
+const ExternalEventSchema = v.object({
+	...BaseEventSchema.entries,
+	name: alphaNumericOrUnderscoreSchema("event name", "lowercase")
+});
+/** Schema for Commerce event source configuration */
+const CommerceEventSourceSchema = v.object({
+	provider: ProviderSchema,
+	events: v.array(CommerceEventSchema, "Expected an array of Commerce events")
+});
+/** Schema for external event source configuration */
+const ExternalEventSourceSchema = v.object({
+	provider: ProviderSchema,
+	events: v.array(ExternalEventSchema, "Expected an array of external events")
+});
+/** Schema for eventing configuration with separate commerce and external arrays */
+const EventingSchema = v.object({
+	commerce: v.optional(v.array(CommerceEventSourceSchema, "Expected an array of Commerce event sources")),
+	external: v.optional(v.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 CommerceSdkValidationError) return error.display();
+	return error instanceof Error ? error.message : String(error);
+}
+
+//#endregion
+export { hasExternalEvents as a, hasCustomInstallationSteps as c, hasEventing as i, alphaNumericOrHyphenSchema as l, EventingSchema as n, InstallationSchema as o, hasCommerceEvents as r, hasCustomInstallation as s, stringifyError as t, nonEmptyStringValueSchema as u };

package/dist/es/{index-DQepSWYP.d.mts → index-Bxr3zvCT.d.mts}

@@ -1,7 +1,7 @@
-import { r as CommerceAppConfigOutputModel } from "./app-CMpx3D7Y.mjs";
+import { n as CommerceAppConfigOutputModel } from "./app-Cx1-6dn0.mjs";
+import AioLogger from "@adobe/aio-lib-core-logging";
 import * as v from "valibot";
 import { RuntimeActionParams } from "@adobe/aio-commerce-lib-core/params";
-import AioLogger from "@adobe/aio-lib-core-logging";
 
 //#region source/management/installation/schema.d.ts
 /** Schema for validating Adobe I/O app credentials required for installation. */

package/dist/es/logging-VgerMhp6.mjs

@@ -0,0 +1,18 @@
+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 };

package/dist/es/management/index.d.mts

@@ -1,3 +1,3 @@
-import "../app-CMpx3D7Y.mjs";
-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-DQepSWYP.mjs";
+import "../app-Cx1-6dn0.mjs";
+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-Bxr3zvCT.mjs";
 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 };

package/dist/es/management/index.mjs

@@ -1 +1,3 @@
-import{a as isFailedState,i as isCompletedState,n as runInstallation,o as isInProgressState,r as defineCustomInstallationStep,s as isSucceededState,t as createInitialInstallationState}from"../management-BM2WcbV6.mjs";export{createInitialInstallationState,defineCustomInstallationStep,isCompletedState,isFailedState,isInProgressState,isSucceededState,runInstallation};
+import { a as isFailedState, i as isCompletedState, n as runInstallation, o as isInProgressState, r as defineCustomInstallationStep, s as isSucceededState, t as createInitialInstallationState } from "../management-Y7pwEbNI.mjs";
+
+export { createInitialInstallationState, defineCustomInstallationStep, isCompletedState, isFailedState, isInProgressState, isSucceededState, runInstallation };