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

package/dist/cjs/config-JQ_n-5Nk.cjs

@@ -1,565 +0,0 @@
-const require_error = require('./error-Byj1DVHZ.cjs');
-let valibot = require("valibot");
-valibot = require_error.__toESM(valibot);
-let _adobe_aio_commerce_lib_core_error = require("@adobe/aio-commerce-lib-core/error");
-let path = require("path");
-let fs = require("fs");
-let fs_promises = require("fs/promises");
-let jiti = require("jiti");
-
-//#region source/config/lib/define.ts
-/**
-* Helper to type-safely define the app config.
-* @param config - The app config to define.
-*
-* @example
-* ```typescript
-* import { defineConfig } from "@adobe/aio-commerce-lib-app";
-*
-* // In app.commerce.config.js
-* export default defineConfig({
-*   // You get autocompletion and type-safety for the config object.
-*   businessConfig: { ... }
-* });
-*/
-function defineConfig(config) {
-	return config;
-}
-
-//#endregion
-//#region ../../packages-private/scripting-utils/source/project.ts
-/**
-* This module exports shared project utilities for the AIO Commerce SDK.
-* @packageDocumentation
-*/
-/**
-* Find a file by walking up parent directories
-* @param name - The file name to search for (or array of file names)
-* @param options - Search options
-* @returns The path to the file, or undefined if not found
-*/
-async function findUp(name, options = {}) {
-	const names = Array.isArray(name) ? name : [name];
-	const cwd = options.cwd || process.cwd();
-	const { root } = (0, path.parse)(cwd);
-	const stopAt = options.stopAt || root;
-	let currentDir = cwd;
-	while (true) {
-		for (const fileName of names) {
-			const filePath = (0, path.join)(currentDir, fileName);
-			try {
-				await (0, fs_promises.access)(filePath);
-				return filePath;
-			} catch {}
-		}
-		if (currentDir === stopAt || currentDir === root) return;
-		currentDir = (0, path.dirname)(currentDir);
-	}
-}
-/**
-* Find the nearest package.json file in the current working directory or its parents
-* @param cwd The current working directory
-*/
-async function findNearestPackageJson(cwd = process.cwd()) {
-	const packageJsonPath = await findUp("package.json", { cwd });
-	if (!packageJsonPath) return null;
-	return packageJsonPath;
-}
-/**
-* Read the package.json file
-* @param cwd The current working directory
-*/
-async function readPackageJson(cwd = process.cwd()) {
-	const packageJsonPath = await findNearestPackageJson(cwd);
-	if (!packageJsonPath) return null;
-	return JSON.parse(await (0, fs_promises.readFile)(packageJsonPath, "utf-8"));
-}
-/**
-* Check if the current working directory is an ESM project.
-* @param cwd The current working directory
-*/
-async function isESM(cwd = process.cwd()) {
-	const packageJson = await readPackageJson(cwd);
-	if (!packageJson) throw new Error("Could not find a `package.json` file in the current working directory or its parents.");
-	return packageJson.type === "module";
-}
-/**
-* Get the root directory of the project
-* @param cwd The current working directory
-*/
-async function getProjectRootDirectory(cwd = process.cwd()) {
-	const packageJsonPath = await findNearestPackageJson(cwd);
-	if (!packageJsonPath) throw new Error("Could not find a the root directory of the project. `package.json` file not found.");
-	return (0, path.dirname)(packageJsonPath);
-}
-/**
-* Create the output directory for the given file or folder (relative to the project root)
-* @param fileOrFolder - The file or folder to create
-*/
-async function makeOutputDirFor(fileOrFolder) {
-	const outputDir = (0, path.join)(await getProjectRootDirectory(), fileOrFolder);
-	if (!(0, fs.existsSync)(outputDir)) await (0, fs_promises.mkdir)(outputDir, { recursive: true });
-	return outputDir;
-}
-/** Detect the package manager by checking for lock files */
-async function detectPackageManager(cwd = process.cwd()) {
-	const rootDirectory = await getProjectRootDirectory(cwd);
-	const lockFileMap = {
-		"bun.lockb": "bun",
-		"pnpm-lock.yaml": "pnpm",
-		"yarn.lock": "yarn",
-		"package-lock.json": "npm"
-	};
-	const lockFileName = Object.keys(lockFileMap).find((name) => (0, fs.existsSync)((0, path.join)(rootDirectory, name)));
-	if (!lockFileName) return "npm";
-	return lockFileMap[lockFileName];
-}
-/** Get the appropriate exec command based on package manager */
-function getExecCommand(packageManager) {
-	return {
-		pnpm: "pnpx",
-		yarn: "yarn dlx",
-		bun: "bunx",
-		npm: "npx"
-	}[packageManager];
-}
-
-//#endregion
-//#region source/config/schema/business-configuration.ts
-/** Base schema for configuration field options with name, optional label, and optional description */
-const BaseOptionSchema = valibot.object({
-	name: valibot.pipe(valibot.string("Expected a string for the field name"), valibot.nonEmpty("The field name must not be empty")),
-	label: valibot.optional(valibot.string("Expected a string for the field label")),
-	description: valibot.optional(valibot.string("Expected a string for the field description"))
-});
-/** Schema for a single option in a list field, containing a display label and a value */
-const ListOptionSchema = valibot.object({
-	label: valibot.string("Expected a string for the option label"),
-	value: valibot.string("Expected a string for the option value")
-});
-/** Schema for a list field that allows single selection from a list of options */
-const SingleListSchema = valibot.object({
-	...BaseOptionSchema.entries,
-	type: valibot.literal("list", "Expected the type to be 'list'"),
-	selectionMode: valibot.literal("single", "Expected the selectionMode to be 'single'"),
-	options: valibot.array(ListOptionSchema, "Expected an array of list options"),
-	default: valibot.pipe(valibot.string("Expected a string for the default value"), valibot.nonEmpty("The default value must not be empty"))
-});
-/** Schema for a list field that allows multiple selections from a list of options */
-const MultipleListSchema = valibot.object({
-	...BaseOptionSchema.entries,
-	type: valibot.literal("list", "Expected the type to be 'list'"),
-	selectionMode: valibot.literal("multiple", "Expected the selectionMode to be 'multiple'"),
-	options: valibot.array(ListOptionSchema, "Expected an array of list options"),
-	default: valibot.optional(valibot.array(valibot.pipe(valibot.string("Expected a string for each default value"), valibot.nonEmpty("Each default value must not be empty")), "Expected an array of default values"), [])
-});
-/** Schema for list fields supporting either single or multiple selection modes */
-const ListSchema = valibot.variant("selectionMode", [SingleListSchema, MultipleListSchema]);
-/** Schema for a text input field that accepts string values */
-const TextSchema = valibot.object({
-	...BaseOptionSchema.entries,
-	type: valibot.literal("text", "Expected the type to be 'text'"),
-	default: valibot.optional(valibot.string("Expected a string for the default value"))
-});
-/** Schema for a password input field that accepts string values (typically masked in UI) */
-const PasswordSchema = valibot.object({
-	...BaseOptionSchema.entries,
-	type: valibot.literal("password", "Expected the type to be 'password'"),
-	default: valibot.optional(valibot.string("Expected a string for the default value"))
-});
-/** Schema for a boolean field that accepts true or false values */
-/** Schema for a number input field that accepts numeric values */
-/** Schema for a date input field that accepts date values */
-/** Schema for an email input field that accepts and validates email addresses */
-const EmailSchema = valibot.object({
-	...BaseOptionSchema.entries,
-	type: valibot.literal("email", "Expected the type to be 'email'"),
-	default: valibot.optional(valibot.pipe(valibot.string("Expected a string for the default email value"), valibot.email("The email must be a valid email address")))
-});
-/** Schema for a URL input field that accepts and validates URL strings */
-const UrlSchema = valibot.object({
-	...BaseOptionSchema.entries,
-	type: valibot.literal("url", "Expected the type to be 'url'"),
-	default: valibot.optional(valibot.pipe(valibot.string("Expected a string for the default URL value"), valibot.url("The URL must be a valid URL")))
-});
-/** Schema for a phone number input field that accepts and validates telephone numbers */
-const PhoneSchema = valibot.object({
-	...BaseOptionSchema.entries,
-	type: valibot.literal("tel", "Expected the type to be 'tel'"),
-	default: valibot.optional(valibot.pipe(valibot.string("Expected a string for the default phone number value"), valibot.regex(/^\+?[0-9\s\-()]+$/, "The phone number must contain only numbers and/or country codes")))
-});
-/** Schema for a configuration field that can be one of various field types (list, text, password, email, url, or phone) */
-const FieldSchema = valibot.variant("type", [
-	ListSchema,
-	TextSchema,
-	PasswordSchema,
-	EmailSchema,
-	UrlSchema,
-	PhoneSchema
-]);
-/** Schema for the schema of the business configuration, which is an array of configuration fields with at least one field required */
-const SchemaBusinessConfigSchema = valibot.pipe(valibot.array(FieldSchema, "Expected an array of configuration fields"), valibot.minLength(1, "At least one configuration parameter is required"));
-/** The schema used to validate the `businessConfig` settings in the app config file. */
-const SchemaBusinessConfig = valibot.object({ schema: valibot.optional(SchemaBusinessConfigSchema, []) });
-/**
-* 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 = /* @__PURE__ */ new RegExp(`^${NUMERIC_IDENTIFIER}\\.${NUMERIC_IDENTIFIER}\\.${NUMERIC_IDENTIFIER}$`);
-function nonEmptyString(fieldName) {
-	return valibot.pipe(valibot.string(`Expected a string for the ${fieldName}`), valibot.nonEmpty(`The ${fieldName} must not be empty`));
-}
-/** The schema for the metadata of the application. */
-const MetadataSchema = valibot.object({
-	id: require_error.alphaNumericOrHyphenSchema("application id (metadata.id)"),
-	displayName: valibot.pipe(nonEmptyString("application display name"), valibot.maxLength(MAX_DISPLAY_NAME_LENGTH, `The application display name must not be longer than ${MAX_DISPLAY_NAME_LENGTH} characters`)),
-	description: valibot.pipe(nonEmptyString("metadata description"), valibot.maxLength(MAX_DESCRIPTION_LENGTH, `The metadata description must not be longer than ${MAX_DESCRIPTION_LENGTH} characters`)),
-	version: valibot.pipe(nonEmptyString("version"), valibot.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 = valibot.looseObject({
-	metadata: MetadataSchema,
-	businessConfig: valibot.optional(SchemaBusinessConfig),
-	eventing: valibot.optional(require_error.EventingSchema),
-	installation: valibot.optional(require_error.InstallationSchema)
-});
-
-//#endregion
-//#region source/config/schema/domains.ts
-/** The individual validatable domains of the app config. */
-const CommerceAppConfigSchemas = {
-	metadata: MetadataSchema,
-	businessConfig: SchemaBusinessConfig,
-	eventing: require_error.EventingSchema,
-	installation: require_error.InstallationSchema,
-	"businessConfig.schema": valibot.unwrap(SchemaBusinessConfig.entries.schema),
-	"eventing.commerce": valibot.unwrap(require_error.EventingSchema.entries.commerce),
-	"eventing.external": valibot.unwrap(require_error.EventingSchema.entries.external),
-	"installation.customInstallationSteps": valibot.unwrap(require_error.InstallationSchema.entries.customInstallationSteps)
-};
-/**
-* Get the config domains that are present in the config.
-* @param config - The configuration to check.
-*/
-function getConfigDomains(config) {
-	const withCommerceEvents = require_error.hasCommerceEvents(config);
-	const withExternalEvents = require_error.hasExternalEvents(config);
-	const domains = {
-		metadata: hasMetadata(config),
-		businessConfig: hasBusinessConfig(config),
-		eventing: withCommerceEvents || withExternalEvents,
-		installation: require_error.hasCustomInstallation(config),
-		"businessConfig.schema": hasBusinessConfigSchema(config),
-		"eventing.commerce": withCommerceEvents,
-		"eventing.external": withExternalEvents,
-		"installation.customInstallationSteps": require_error.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 = valibot.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 = valibot.safeParse(CommerceAppConfigSchema, config);
-	if (!validatedConfig.success) throw new _adobe_aio_commerce_lib_core_error.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 = valibot.safeParse(commerceAppConfigDomainsSchema, domain);
-	if (!domainSchema.success) throw new _adobe_aio_commerce_lib_core_error.CommerceSdkValidationError("Invalid commerce app config domain", { issues: domainSchema.issues });
-	const domainConfigSchema = CommerceAppConfigSchemas[domain];
-	const validatedConfig = valibot.safeParse(domainConfigSchema, config);
-	if (!validatedConfig.success) throw new _adobe_aio_commerce_lib_core_error.CommerceSdkValidationError(`Invalid commerce app config: ${domain}`, { issues: validatedConfig.issues });
-	return validatedConfig.output;
-}
-
-//#endregion
-//#region source/config/lib/parser.ts
-const jiti$1 = (0, jiti.createJiti)(require("url").pathToFileURL(__filename).href);
-const configPaths = Object.freeze([
-	"app.commerce.config.js",
-	"app.commerce.config.ts",
-	"app.commerce.config.cjs",
-	"app.commerce.config.mjs",
-	"app.commerce.config.mts",
-	"app.commerce.config.cts"
-]);
-/**
-* Try to find (up to the nearest package.json file) the app config file.
-*
-* Searches for config files in the following order of priority:
-* 1. `app.commerce.config.js` - JavaScript (CommonJS or ESM)
-* 2. `app.commerce.config.ts` - TypeScript
-* 3. `app.commerce.config.cjs` - CommonJS
-* 4. `app.commerce.config.mjs` - ES Module
-* 5. `app.commerce.config.mts` - ES Module TypeScript
-* 6. `app.commerce.config.cts` - CommonJS TypeScript
-*
-* @param cwd The current working directory
-* @returns The path to the config file, or null if not found
-*/
-async function resolveCommerceAppConfig(cwd = process.cwd()) {
-	const packageJsonPath = await findNearestPackageJson(cwd);
-	if (!packageJsonPath) return null;
-	const rootDirectory = (0, path.dirname)(packageJsonPath);
-	for (const configPath of configPaths) {
-		const configFilePath = await findUp(configPath, {
-			cwd,
-			stopAt: rootDirectory
-		});
-		if (configFilePath) return configFilePath;
-	}
-	return null;
-}
-/**
-* Read the commerce app config file as-is, without validating it.
-*
-* Supports multiple config file formats (see {@link resolveCommerceAppConfig} for the list).
-* The config file must export a default export with the configuration object.
-*
-* @param cwd The current working directory
-* @returns The raw config object from the file
-* @throws {Error} If no config file is found or if the file doesn't export a default export
-*/
-async function readCommerceAppConfig(cwd = process.cwd()) {
-	const configFilePath = await resolveCommerceAppConfig(cwd);
-	if (!configFilePath) throw new Error("Could not find a commerce app config file in the current working directory or its parents.");
-	let config = null;
-	try {
-		config = await jiti$1.import(configFilePath);
-	} catch (error) {
-		const message = require_error.stringifyError(error);
-		throw new Error(`Failed to read commerce app config file at ${configFilePath}: ${message}`, { cause: error });
-	}
-	if (!(config && "default" in config) || config.default === void 0 || config.default === null || typeof config.default === "object" && Object.keys(config.default).length === 0) throw new Error("Commerce app config file does not export a default export. Make sure you use `export default` or `module.exports = { /* your config */ }`");
-	return config.default;
-}
-/**
-* Read the commerce app config file and parse its contents into its schema.
-*
-* Supports multiple config file formats (see {@link resolveCommerceAppConfig} for the list).
-* The config file must export a default export with the configuration object.
-*
-* @param cwd The current working directory
-* @returns The validated and parsed config object
-* @throws {Error} If no config file is found, if the file doesn't export a default export, or if validation fails
-*/
-async function parseCommerceAppConfig(cwd = process.cwd()) {
-	return validateCommerceAppConfig(await readCommerceAppConfig(cwd));
-}
-
-//#endregion
-Object.defineProperty(exports, 'CommerceAppConfigSchemas', {
-  enumerable: true,
-  get: function () {
-    return CommerceAppConfigSchemas;
-  }
-});
-Object.defineProperty(exports, 'defineConfig', {
-  enumerable: true,
-  get: function () {
-    return defineConfig;
-  }
-});
-Object.defineProperty(exports, 'detectPackageManager', {
-  enumerable: true,
-  get: function () {
-    return detectPackageManager;
-  }
-});
-Object.defineProperty(exports, 'getConfigDomains', {
-  enumerable: true,
-  get: function () {
-    return getConfigDomains;
-  }
-});
-Object.defineProperty(exports, 'getExecCommand', {
-  enumerable: true,
-  get: function () {
-    return getExecCommand;
-  }
-});
-Object.defineProperty(exports, 'getProjectRootDirectory', {
-  enumerable: true,
-  get: function () {
-    return getProjectRootDirectory;
-  }
-});
-Object.defineProperty(exports, 'hasBusinessConfig', {
-  enumerable: true,
-  get: function () {
-    return hasBusinessConfig;
-  }
-});
-Object.defineProperty(exports, 'hasBusinessConfigSchema', {
-  enumerable: true,
-  get: function () {
-    return hasBusinessConfigSchema;
-  }
-});
-Object.defineProperty(exports, 'hasConfigDomain', {
-  enumerable: true,
-  get: function () {
-    return hasConfigDomain;
-  }
-});
-Object.defineProperty(exports, 'hasMetadata', {
-  enumerable: true,
-  get: function () {
-    return hasMetadata;
-  }
-});
-Object.defineProperty(exports, 'isESM', {
-  enumerable: true,
-  get: function () {
-    return isESM;
-  }
-});
-Object.defineProperty(exports, 'makeOutputDirFor', {
-  enumerable: true,
-  get: function () {
-    return makeOutputDirFor;
-  }
-});
-Object.defineProperty(exports, 'parseCommerceAppConfig', {
-  enumerable: true,
-  get: function () {
-    return parseCommerceAppConfig;
-  }
-});
-Object.defineProperty(exports, 'readCommerceAppConfig', {
-  enumerable: true,
-  get: function () {
-    return readCommerceAppConfig;
-  }
-});
-Object.defineProperty(exports, 'readPackageJson', {
-  enumerable: true,
-  get: function () {
-    return readPackageJson;
-  }
-});
-Object.defineProperty(exports, 'resolveCommerceAppConfig', {
-  enumerable: true,
-  get: function () {
-    return resolveCommerceAppConfig;
-  }
-});
-Object.defineProperty(exports, 'validateCommerceAppConfig', {
-  enumerable: true,
-  get: function () {
-    return validateCommerceAppConfig;
-  }
-});
-Object.defineProperty(exports, 'validateCommerceAppConfigDomain', {
-  enumerable: true,
-  get: function () {
-    return validateCommerceAppConfigDomain;
-  }
-});