Commerce App Business Config

import { defineConfig } from "@adobe/aio-commerce-lib-app/config";

export default defineConfig({
  metadata: {
    id: "my-commerce-app", // alphanumeric + hyphens only, max 100 chars
    displayName: "My Commerce App", // shown in App Management UI, max 50 chars
    description: "A Commerce app built with aio-commerce-sdk.", // max 255 chars
    version: "1.0.0", // Major.Minor.Patch only, no pre-release identifiers
  },
  businessConfig: {
    schema: [
      // Single-select list — merchant picks one value from a fixed set
      {
        name: "shipping_provider", // required, non-empty; used as config key at runtime
        type: "list",
        selectionMode: "single", // "single" or "multiple"
        label: "Shipping Provider", // optional; shown as field label in Admin
        description: "Select the active shipping provider.", // optional; shown as help text
        options: [
          // required for list fields; each option needs both label and value
          { label: "FedEx", value: "fedex" },
          { label: "UPS", value: "ups" },
          { label: "DHL", value: "dhl" },
        ],
        default: "fedex", // required for single; must exactly match one of the option values
      },
      // Multi-select list — merchant picks one or more values
      {
        name: "enabled_payment_methods",
        type: "list",
        selectionMode: "multiple",
        label: "Enabled Payment Methods",
        options: [
          { label: "Credit Card", value: "cc" },
          { label: "PayPal", value: "paypal" },
          { label: "Apple Pay", value: "apple_pay" },
        ],
        default: ["cc", "paypal"], // optional array; defaults to []; each must match an option value
      },
      // Text — free-form string input
      {
        name: "store_code",
        type: "text",
        label: "Store Code",
        description: "Internal identifier for this store.",
        default: "", // optional string; defaults to ""
      },
      // Password — masked input for secrets; shown as *** in Admin
      {
        name: "api_key",
        type: "password",
        label: "API Key",
        description: "Secret key for the external service.",
        default: "", // must be "" — non-empty defaults are rejected to prevent secrets in config
      },
      // Email — validated email address input
      {
        name: "notification_email",
        type: "email",
        label: "Notification Email",
        default: "", // "" or a fully valid email address (e.g. "admin@example.com")
      },
      // URL — validated absolute URL input
      {
        name: "webhook_endpoint",
        type: "url",
        label: "Webhook Endpoint",
        default: "", // "" or a fully valid absolute URL (e.g. "https://service.example.com/hook")
      },
      // Tel — phone number input
      {
        name: "support_phone",
        type: "tel",
        label: "Support Phone",
        default: "", // "" or matches /^\+?[0-9\s\-()]+$/ (e.g. "+1 (800) 555-0100")
      },
      // Boolean — toggle switch
      {
        name: "debug_mode",
        type: "boolean",
        label: "Enable Debug Mode",
        default: false, // optional boolean; defaults to false
      },
      // Dynamic list — options resolved at runtime via a factory.
      // Use when option values depend on merchant-specific data (e.g. payment
      // methods enabled in the merchant's Commerce store). Any credentials the
      // factory uses must be declared as `inputs` for the action that resolves
      // the schema in that action's `ext.config.yaml`.
      {
        name: "default_payment_method",
        type: "dynamicList",
        selectionMode: "single",
        label: "Default Payment Method",
        // Receives the action's runtime params; may be sync or async.
        // Example: `await fetchPaymentMethods(params.PAYMENT_API_KEY)` then
        // map each entry to `{ label, value }`.
        options: () => [{ label: "Credit Card", value: "cc" }],
        // Required for single-select; optional for "multiple" (defaults to []).
        default: (resolvedOptions) => resolvedOptions[0].value,
      },
    ],
  },
});

{
  "skill_name": "commerce-app-business-config",
  "evals": [
    {
      "id": 1,
      "prompt": "My Commerce app needs to call an external tax service. Add a business config field so merchants can enter their tax service API key in Commerce Admin.",
      "expected_output": "The agent adds a businessConfig.schema entry of type 'password' to app.commerce.config.ts. The entry has a name, type: 'password', and default: ''. No non-empty default is set. aio app build completes without errors.",
      "assertions": [
        "app.commerce.config.ts contains a businessConfig.schema array",
        "At least one entry has type: 'password'",
        "The password entry has default: '' (empty string only)",
        "The password entry has a non-empty name field",
        "aio app build completes without errors"
      ]
    },
    {
      "id": 2,
      "prompt": "Add two settings to my Commerce app: a dropdown so merchants can choose their region (EU, US, or APAC), and a toggle to enable or disable a beta feature.",
      "expected_output": "The agent adds two businessConfig.schema entries: one of type 'list' with selectionMode 'single', three options, and a valid default matching one of the option values; and one of type 'boolean' with default false. aio app build completes without errors.",
      "assertions": [
        "app.commerce.config.ts contains a businessConfig.schema array with at least two entries",
        "One entry has type: 'list' and selectionMode: 'single'",
        "The list entry has an options array with at least one { label, value } entry",
        "The list entry default matches one of the option values",
        "One entry has type: 'boolean'",
        "aio app build completes without errors"
      ]
    },
    {
      "id": 3,
      "prompt": "Set up business config for my Commerce app with the following merchant settings: a notification email address, the URL of an external fulfillment service, a support phone number, and a free-text field for a custom store identifier.",
      "expected_output": "The agent adds four businessConfig.schema entries of types email, url, tel, and text respectively. All have name and type fields. Defaults are '' or omitted. After build passes, the agent suggests commerce-app-webhooks or commerce-app-eventing as next steps.",
      "assertions": [
        "app.commerce.config.ts contains a businessConfig.schema array with at least four entries",
        "One entry has type: 'email'",
        "One entry has type: 'url'",
        "One entry has type: 'tel'",
        "One entry has type: 'text'",
        "aio app build completes without errors",
        "Agent mentions commerce-app-webhooks or commerce-app-eventing as next steps"
      ]
    }
  ]
}