@adobe/aio-commerce-lib-app 0.1.0

package/dist/es/config/index.mjs

@@ -0,0 +1,14 @@
+/**
+* @license
+* 
+* Copyright 2025 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 validateCommerceAppConfig,i as resolveCommerceAppConfig,n as readBundledCommerceAppConfig,o as validateCommerceAppConfigDomain,r as readCommerceAppConfig,t as parseCommerceAppConfig}from"../parser-BoZ6cYn-.mjs";function defineConfig(config){return config}export{defineConfig,parseCommerceAppConfig,readBundledCommerceAppConfig,readCommerceAppConfig,resolveCommerceAppConfig,validateCommerceAppConfig,validateCommerceAppConfigDomain};

package/dist/es/parser-BoZ6cYn-.mjs

@@ -0,0 +1,14 @@
+/**
+* @license
+* 
+* Copyright 2025 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{access,mkdir,readFile}from"fs/promises";import{dirname,join,parse}from"path";import{CommerceSdkValidationError}from"@adobe/aio-commerce-lib-core/error";import{existsSync}from"fs";import{createJiti}from"jiti";import*as v from"valibot";function stringifyError(error){return error instanceof CommerceSdkValidationError?error.display():error instanceof Error?error.message:String(error)}async function findUp(name,options={}){let names=Array.isArray(name)?name:[name],cwd=options.cwd||process.cwd(),{root}=parse(cwd),stopAt=options.stopAt||root,currentDir=cwd;for(;;){for(let fileName of names){let filePath=join(currentDir,fileName);try{return await access(filePath),filePath}catch{}}if(currentDir===stopAt||currentDir===root)return;currentDir=dirname(currentDir)}}async function findNearestPackageJson(cwd=process.cwd()){return await findUp(`package.json`,{cwd})||null}async function getProjectRootDirectory(cwd=process.cwd()){let packageJsonPath=await findNearestPackageJson(cwd);if(!packageJsonPath)throw Error("Could not find a the root directory of the project. `package.json` file not found.");return dirname(packageJsonPath)}async function makeOutputDirFor(fileOrFolder){let outputDir=join(await getProjectRootDirectory(),fileOrFolder);return existsSync(outputDir)||await mkdir(outputDir,{recursive:!0}),outputDir}async function detectPackageManager(cwd=process.cwd()){let rootDirectory=await getProjectRootDirectory(cwd),lockFileMap={"bun.lockb":`bun`,"pnpm-lock.yaml":`pnpm`,"yarn.lock":`yarn`,"package-lock.json":`npm`},lockFileName=Object.keys(lockFileMap).find(name=>existsSync(join(rootDirectory,name)));return lockFileName?lockFileMap[lockFileName]:`npm`}function getExecCommand(packageManager){return{pnpm:`pnpx`,yarn:`yarn dlx`,bun:`bunx`,npm:`npx`}[packageManager]}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`))}),ListOptionSchema=v.object({label:v.string(`Expected a string for the option label`),value:v.string(`Expected a string for the option value`)}),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`))}),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`),[])}),ListSchema=v.variant(`selectionMode`,[SingleListSchema,MultipleListSchema]),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`))}),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`))}),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`)))}),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`)))}),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`)))}),FieldSchema=v.variant(`type`,[ListSchema,TextSchema,PasswordSchema,EmailSchema,UrlSchema,PhoneSchema]),SchemaBusinessConfigSchema=v.pipe(v.array(FieldSchema,`Expected an array of configuration fields`),v.minLength(1,`At least one configuration parameter is required`)),SchemaBusinessConfig=v.object({schema:v.optional(SchemaBusinessConfigSchema,[])}),NUMERIC_IDENTIFIER=`(0|[1-9]\\d*)`,SEMVER_REGEX=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`))}const MetadataSchema=v.object({id:v.pipe(nonEmptyString(`application id`),v.regex(/^[a-zA-Z0-9-]+$/,`The application id must contain only alphanumeric characters and dashes`)),displayName:v.pipe(nonEmptyString(`application display name`),v.maxLength(50,`The application display name must not be longer than 50 characters`)),description:v.pipe(nonEmptyString(`metadata description`),v.maxLength(255,`The metadata description must not be longer than 255 characters`)),version:v.pipe(nonEmptyString(`version`),v.regex(SEMVER_REGEX,`The version must follow semantic versioning (semver) format`))}),CommerceAppConfigSchemas={metadata:MetadataSchema,businessConfig:SchemaBusinessConfig,"businessConfig.schema":SchemaBusinessConfigSchema},CommerceAppConfigSchema=v.object({metadata:MetadataSchema,businessConfig:v.optional(SchemaBusinessConfig)}),commerceAppConfigDomainsSchema=v.picklist(Object.keys(CommerceAppConfigSchemas));function validateCommerceAppConfig(config){let validatedConfig=v.safeParse(CommerceAppConfigSchema,config);if(!validatedConfig.success)throw new CommerceSdkValidationError(`Invalid commerce app config`,{issues:validatedConfig.issues});return validatedConfig.output}function validateCommerceAppConfigDomain(config,domain){let domainSchema=v.safeParse(commerceAppConfigDomainsSchema,domain);if(!domainSchema.success)throw new CommerceSdkValidationError(`Invalid commerce app config domain`,{issues:domainSchema.issues});let domainConfigSchema=CommerceAppConfigSchemas[domain],validatedConfig=v.safeParse(domainConfigSchema,config);if(!validatedConfig.success)throw new CommerceSdkValidationError(`Invalid commerce app config: ${domain}`,{issues:validatedConfig.issues});return validatedConfig.output}const jiti=createJiti(import.meta.url),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`]);async function resolveCommerceAppConfig(cwd=process.cwd()){let packageJsonPath=await findNearestPackageJson(cwd);if(!packageJsonPath)return null;let rootDirectory=dirname(packageJsonPath);for(let configPath of configPaths){let configFilePath=await findUp(configPath,{cwd,stopAt:rootDirectory});if(configFilePath)return configFilePath}return null}async function readCommerceAppConfig(cwd=process.cwd()){let configFilePath=await resolveCommerceAppConfig(cwd);if(!configFilePath)throw 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){let message=stringifyError(error);throw 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 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}async function parseCommerceAppConfig(cwd=process.cwd()){return validateCommerceAppConfig(await readCommerceAppConfig(cwd))}async function readBundledCommerceAppConfig(){try{let fileContents=await readFile(`app-management/app.commerce.manifest.json`,`utf-8`);return validateCommerceAppConfig(JSON.parse(fileContents))}catch(error){let message=stringifyError(error);throw Error(`Failed to read bundled commerce app config file: ${message}`,{cause:error})}}export{validateCommerceAppConfig as a,getExecCommand as c,resolveCommerceAppConfig as i,makeOutputDirFor as l,readBundledCommerceAppConfig as n,validateCommerceAppConfigDomain as o,readCommerceAppConfig as r,detectPackageManager as s,parseCommerceAppConfig as t,stringifyError as u};

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@adobe/aio-commerce-lib-app",
+  "type": "module",
+  "author": "Adobe Inc.",
+  "version": "0.1.0",
+  "private": false,
+  "engines": {
+    "node": ">=20 <=24"
+  },
+  "license": "Apache-2.0",
+  "description": "App configuration management library for Adobe Commerce applications",
+  "bugs": {
+    "url": "https://github.com/adobe/aio-commerce-sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adobe/aio-commerce-sdk.git",
+    "directory": "packages/aio-commerce-lib-app"
+  },
+  "bin": {
+    "@adobe/aio-commerce-lib-app": "./dist/es/commands/index.mjs"
+  },
+  "exports": {
+    "./config": {
+      "import": {
+        "types": "./dist/es/config/index.d.mts",
+        "default": "./dist/es/config/index.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/config/index.d.cts",
+        "default": "./dist/cjs/config/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "imports": {
+    "#*": "./source/*.ts",
+    "#test/*": "./test/*.ts"
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "dependencies": {
+    "@adobe/aio-commerce-lib-core": "^0.5.1",
+    "consola": "^3.4.2",
+    "jiti": "^2.6.1",
+    "valibot": "^1.1.0"
+  },
+  "devDependencies": {
+    "@aio-commerce-sdk/config-tsdown": "1.0.0",
+    "@aio-commerce-sdk/config-typedoc": "1.0.0",
+    "@aio-commerce-sdk/config-typescript": "1.0.0",
+    "@aio-commerce-sdk/scripting-utils": "0.1.1",
+    "@aio-commerce-sdk/config-vitest": "1.0.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsdown",
+    "publint": "publint",
+    "docs": "typedoc && prettier --write '**/*.md'",
+    "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",
+    "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",
+    "lint": "biome lint --no-errors-on-unmatched",
+    "lint:fix": "biome lint --write --no-errors-on-unmatched",
+    "typecheck": "tsc --noEmit && echo '✅ No type errors found.'",
+    "test": "vitest run --coverage",
+    "test:watch": "vitest --coverage",
+    "test:ui": "vitest --ui --coverage"
+  }
+}