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

package/dist/es/config-BSGerqCG.mjs

@@ -1,457 +0,0 @@
-import { a as hasExternalEvents, c as hasCustomInstallationSteps, l as alphaNumericOrHyphenSchema, n as EventingSchema, o as InstallationSchema, r as hasCommerceEvents, s as hasCustomInstallation, t as stringifyError } from "./error-P7JgUTds.mjs";
-import * as v from "valibot";
-import { CommerceSdkValidationError } from "@adobe/aio-commerce-lib-core/error";
-import { dirname, join, parse } from "path";
-import { existsSync } from "fs";
-import { access, mkdir, readFile } from "fs/promises";
-import { createJiti } from "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 } = parse(cwd);
-	const stopAt = options.stopAt || root;
-	let currentDir = cwd;
-	while (true) {
-		for (const fileName of names) {
-			const filePath = join(currentDir, fileName);
-			try {
-				await access(filePath);
-				return filePath;
-			} catch {}
-		}
-		if (currentDir === stopAt || currentDir === root) return;
-		currentDir = 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 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 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 = join(await getProjectRootDirectory(), fileOrFolder);
-	if (!existsSync(outputDir)) await 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) => existsSync(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 = v.object({
-	name: v.pipe(v.string("Expected a string for the field name"), v.nonEmpty("The field name must not be empty")),
-	label: v.optional(v.string("Expected a string for the field label")),
-	description: v.optional(v.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 = v.object({
-	label: v.string("Expected a string for the option label"),
-	value: v.string("Expected a string for the option value")
-});
-/** Schema for a list field that allows single selection from a list of options */
-const SingleListSchema = v.object({
-	...BaseOptionSchema.entries,
-	type: v.literal("list", "Expected the type to be 'list'"),
-	selectionMode: v.literal("single", "Expected the selectionMode to be 'single'"),
-	options: v.array(ListOptionSchema, "Expected an array of list options"),
-	default: v.pipe(v.string("Expected a string for the default value"), v.nonEmpty("The default value must not be empty"))
-});
-/** Schema for a list field that allows multiple selections from a list of options */
-const MultipleListSchema = v.object({
-	...BaseOptionSchema.entries,
-	type: v.literal("list", "Expected the type to be 'list'"),
-	selectionMode: v.literal("multiple", "Expected the selectionMode to be 'multiple'"),
-	options: v.array(ListOptionSchema, "Expected an array of list options"),
-	default: v.optional(v.array(v.pipe(v.string("Expected a string for each default value"), v.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 = v.variant("selectionMode", [SingleListSchema, MultipleListSchema]);
-/** Schema for a text input field that accepts string values */
-const TextSchema = v.object({
-	...BaseOptionSchema.entries,
-	type: v.literal("text", "Expected the type to be 'text'"),
-	default: v.optional(v.string("Expected a string for the default value"))
-});
-/** Schema for a password input field that accepts string values (typically masked in UI) */
-const PasswordSchema = v.object({
-	...BaseOptionSchema.entries,
-	type: v.literal("password", "Expected the type to be 'password'"),
-	default: v.optional(v.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 = v.object({
-	...BaseOptionSchema.entries,
-	type: v.literal("email", "Expected the type to be 'email'"),
-	default: v.optional(v.pipe(v.string("Expected a string for the default email value"), v.email("The email must be a valid email address")))
-});
-/** Schema for a URL input field that accepts and validates URL strings */
-const UrlSchema = v.object({
-	...BaseOptionSchema.entries,
-	type: v.literal("url", "Expected the type to be 'url'"),
-	default: v.optional(v.pipe(v.string("Expected a string for the default URL value"), v.url("The URL must be a valid URL")))
-});
-/** Schema for a phone number input field that accepts and validates telephone numbers */
-const PhoneSchema = v.object({
-	...BaseOptionSchema.entries,
-	type: v.literal("tel", "Expected the type to be 'tel'"),
-	default: v.optional(v.pipe(v.string("Expected a string for the default phone number value"), v.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 = v.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 = v.pipe(v.array(FieldSchema, "Expected an array of configuration fields"), v.minLength(1, "At least one configuration parameter is required"));
-/** The schema used to validate the `businessConfig` settings in the app config file. */
-const SchemaBusinessConfig = v.object({ schema: v.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 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
-//#region source/config/lib/parser.ts
-const jiti = createJiti(import.meta.url);
-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 = 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.import(configFilePath);
-	} catch (error) {
-		const message = 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
-export { readPackageJson as _, validateCommerceAppConfigDomain as a, hasConfigDomain as c, hasBusinessConfigSchema as d, detectPackageManager as f, makeOutputDirFor as g, isESM as h, validateCommerceAppConfig as i, hasMetadata as l, getProjectRootDirectory as m, readCommerceAppConfig as n, CommerceAppConfigSchemas as o, getExecCommand as p, resolveCommerceAppConfig as r, getConfigDomains as s, parseCommerceAppConfig as t, hasBusinessConfig as u, defineConfig as v };