@commercelayer/agent-cli 0.2.5 → 0.3.0

package/README.md

@@ -31,6 +31,11 @@ npx -y @commercelayer/agent-cli@latest init --name "The Blue Brand"   # runs c11
 | `orders list` | The orders placed in the store, newest first, as UCP order entities. |
 | `orders show <id or number>` | One order. |
 | `ucp profile [--agent]` | The store's UCP business profile (`/.well-known/ucp`); with `--agent`, this CLI's own platform profile. |
+| `ucp search [<query>] [--country <CC>]` · `ucp product <id>` | Buy for the human, step by step (see [Buying for the human](#buying-for-the-human)): the store's products, prices in major units in `price.display`. |
+| `ucp checkout create --item <sku>[:<qty>] … [--code <discount>] [--country <CC>]` | Open a checkout; `messages` say what is still missing (email, shipping address). |
+| `ucp checkout update <id> [--email …] [--street …] [--item <sku>:<qty>] [--code …] [--shipping <option>]` | Give the buyer's details (flags, or YAML or JSON on stdin or `-f`), change items or codes; `ready_for_complete` once nothing is missing, with shipping in the total. |
+| `ucp checkout show <id>` · `cancel <id>` · `complete <id> [--decline]` | Read, cancel, or pay a checkout with the sandbox handler (after the human said yes): `order` has `label` and `permalink_url`. |
+| `ucp order <id>` · `ucp ask "<question>"` | Read an order the CLI placed; ask the store a question. Every `ucp` buying command takes `--store <host>` to buy from any UCP store. |
 | `ucp check` | Walk every UCP capability the store advertises and report what passes. Places and pays one real test order on the way (the output says which). Exits 1 on a failed check. |
 | `status` | The sandbox, the sales channel client id, the published storefront, what is applied, the last import job (`apply`), the pending changes (exactly what `plan` lists; a store that does not load is pending too, with the error), orders, the UCP profile URL. |
 | `claim` | Start the device flow that keeps the sandbox: a URL and a code for the human. |
@@ -146,6 +151,10 @@ Each store is a UCP business at `https://<org>.sandbox.commercelayer.store` (liv
 | Pages | `/policies/{privacy,terms,returns}` (defaults when `store.yml` has no `policies`), `/carts/{id}`, `/checkout-sessions/{id}` (`continue_url`), `/orders/{id}` (`permalink_url`), and the published storefront at `/`. |
 Transport rules the store enforces: `UCP-Agent` (an HTTPS platform profile URL) and `Request-Id` on every request; `Idempotency-Key` on every state change, replayed when the body matches and `409` when it does not; `Content-Digest` verified when present. Every service response carries `Content-Digest`, `Signature-Input` and `Signature` (ES256 over `@status`, `content-digest`, `content-type`, key `kid` from the profile). Orders are private: readable by the platform that placed them or with a buyer token carrying an order scope; anything else gets `401` with `WWW-Authenticate: Bearer`. Catalog ids are the skus (`product.id` is `prod_<sku>`, `variant.id` is the sku); amounts are integers in minor units.
 The CLI is a UCP **platform**: its profile is served at `https://commercelayer.ai/ucp/agent-cli/profile.json` (`ucp profile --agent` prints it) and goes in `UCP-Agent` on every call. The store negotiates the capability intersection with it. `orders test` is the buyer; `ucp check` runs 30-odd checks across profile, transport rules, catalog, cart, discount, checkout, fulfillment, consent, payment, signatures, idempotency, order, identity linking, ask and permalink.
+### Buying for the human
+
+An agent can buy from any UCP store on behalf of its human, one step per command, talking to the human in between: `ucp search` to show the products, `ucp checkout create --item <sku>:<qty>` for what they picked, `ucp checkout update <id>` with the email and shipping address they give (never invented), then, once they said yes to the total, `ucp checkout complete <id>`, and the order's `label` and `permalink_url` back to them. Money comes as `{ amount, currency, major, display }`: `amount` in minor units as UCP has it, `display` for the human. The store is `--store <hostname or origin>`, or this folder's store when there is one; checkout and order ids are remembered with their store (in `~/.local/state/c11r/ucp.json`), so later steps need no `--store`. Paying needs the store's sandbox handler (`ai.commercelayer.sandbox`, test payments only): a store with a real gateway answers `payment_handler_unsupported`, and the human pays at the checkout's `continue_url`. Responses are signature-checked like `orders test`: `signature` is `verified`, `invalid`, `unknown_key` or `unsigned`.
+
 ## Requirements
 
 Node 20 or later. One runtime dependency (`yaml`).

package/dist/api/client.js

@@ -66,7 +66,8 @@ export function createApi(auth) {
         deleteLink: async (id) => {
             await found('links', id, request('DELETE', one('links', id)));
         },
-        createSandbox: (name) => request('POST', '/sandboxes', { name }),
+        // C11R_TEST=1 (our own test runs) asks the API to tag the organization as a test.
+        createSandbox: (name) => request('POST', '/sandboxes', process.env.C11R_TEST === '1' ? { name, test: true } : { name }),
         getStore: () => request('GET', org()),
         applyStore: (body) => request('PUT', `${org()}/resources`, body),
         uploadAssets: (files) => request('PUT', `${org()}/assets`, { files }),

package/dist/api/stub/management.js

@@ -111,7 +111,8 @@ export function handleManagement(req) {
     if (req.method === 'POST' && path === '/sandboxes') {
         // Like Commerce Layer: the organization is named `name`, and its slug is derived
         // from it, suffixed -2, -3, ... when taken. The slug is the org and the store host.
-        const name = String(readJson(req)?.name ?? 'store');
+        const body = readJson(req);
+        const name = String(body?.name ?? 'store');
         const base = name.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '') || 'store';
         let slug = base;
         for (let n = 2; db[slug]; n++)
@@ -124,6 +125,7 @@ export function handleManagement(req) {
             org: slug,
             token: `sbx_${crypto.randomBytes(16).toString('hex')}`,
             sandbox: true,
+            ...(body?.test === true ? { test: true } : {}),
             claimed: false,
             claim_url: `https://commercelayer.ai/claim/${crypto.randomBytes(6).toString('hex')}`,
             expires_at: expires.toISOString(),

package/dist/bin.js

@@ -4,10 +4,16 @@
 // Output is always JSON; exit code 1 on an error or a failed check.
 import * as cmd from './commands.js';
 import { CliError, print } from './output.js';
-const VALUE_OPTIONS = new Set(['--name', '--sku', '--quantity', '--country', '--code', '--file']);
+const VALUE_OPTIONS = new Set(['--name', '--sku', '--quantity', '--country', '--code', '--file', '--store', '--item', '--email', '--first-name', '--last-name', '--phone', '--street', '--city', '--postal-code', '--region', '--shipping']);
 const argv = process.argv.slice(2);
 const flags = new Set();
 const values = {};
+/** Every value of an option given more than once (--item, --code), in order; values keeps the last. */
+const lists = {};
+const set = (k, v) => {
+    values[k] = v;
+    (lists[k] ??= []).push(v);
+};
 const args = [];
 for (let i = 0; i < argv.length; i++) {
     const a = argv[i];
@@ -21,9 +27,9 @@ for (let i = 0; i < argv.length; i++) {
     }
     const eq = a.indexOf('=');
     if (eq > 0)
-        values[a.slice(2, eq)] = a.slice(eq + 1);
+        set(a.slice(2, eq), a.slice(eq + 1));
     else if (VALUE_OPTIONS.has(a) && i + 1 < argv.length && !argv[i + 1].startsWith('--'))
-        values[a.slice(2)] = argv[++i];
+        set(a.slice(2), argv[++i]);
     else
         flags.add(a);
 }
@@ -96,7 +102,29 @@ async function run() {
                 return cmd.ucpProfile(flags);
             if (sub === 'check')
                 return cmd.ucpCheck();
-            throw new CliError('unknown_command', `There is no command "ucp ${sub ?? ''}".`, 'Use `c11r ucp profile` or `c11r ucp check`.');
+            if (sub === 'search')
+                return cmd.ucpSearch(args.slice(2).join(' '), values);
+            if (sub === 'product')
+                return cmd.ucpProduct(args[2], values);
+            if (sub === 'order')
+                return cmd.ucpOrder(args[2], values);
+            if (sub === 'ask')
+                return cmd.ucpAsk(args.slice(2).join(' '), values);
+            if (sub === 'checkout') {
+                const [, , action, id] = args;
+                if (action === 'create')
+                    return cmd.ucpCheckoutCreate(values, lists);
+                if (action === 'update')
+                    return cmd.ucpCheckoutUpdate(id, values, lists);
+                if (action === 'show')
+                    return cmd.ucpCheckoutShow(id, values);
+                if (action === 'cancel')
+                    return cmd.ucpCheckoutCancel(id, values);
+                if (action === 'complete')
+                    return cmd.ucpCheckoutComplete(id, values, flags);
+                throw new CliError('unknown_command', `There is no command "ucp checkout ${action ?? ''}".`, 'Use `c11r ucp checkout create`, `update <id>`, `show <id>`, `cancel <id>` or `complete <id>`.');
+            }
+            throw new CliError('unknown_command', `There is no command "ucp ${sub ?? ''}".`, 'Use `c11r ucp search`, `product`, `checkout`, `order`, `ask`, `profile` or `check`.');
         default:
             throw new CliError('unknown_command', `There is no command "${name}".`, `Run \`c11r help\`. Commands: ${Object.keys(cmd.HELP).join(', ')}.`);
     }

package/dist/commands.js

@@ -17,6 +17,7 @@ import { storefrontCheck } from './check.js';
 import { buy } from './ucp/buy.js';
 import { check } from './ucp/check.js';
 import { discover } from './ucp/client.js';
+import * as shop from './ucp/shop.js';
 import { agentProfile, AGENT_PROFILE_URL } from './ucp/platform.js';
 /** The package version, read from package.json so a release bumps it in one place. */
 export const VERSION = createRequire(import.meta.url)('../package.json').version;
@@ -46,6 +47,15 @@ export const HELP = {
     'orders show': 'Show one order: c11r orders show <id or number>.',
     'ucp profile': 'Show the store\'s UCP business profile (/.well-known/ucp). With --agent, this CLI\'s own platform profile instead.',
     'ucp check': 'Walk every UCP capability the store advertises and report what passes. Places and pays one real test order on the way. Exits 1 when a check fails.',
+    'ucp search': "Buy for the human, step 1: search a store's catalog over UCP. c11r ucp search [<query>] [--country CC] [--store <host>]; no query lists the whole catalog (up to 50). Returns { store, query, count, total_count, has_more, products: [{ id, title, description, url, image_url, variants: [{ id, sku, title, price: { amount, currency, major, display }, available, availability, ships }] }], signature }. Show the human the titles and price.display (amount is in minor units: never show it), let them pick, then c11r ucp checkout create --item <sku>. --store is any UCP store (hostname or https origin); the default is this folder's store.",
+    'ucp product': 'Look at one product over UCP, with every variant and the full description: c11r ucp product <product id or sku> [--country CC] [--store <host>]. Returns { store, product: { id, title, description, url, image_url, variants: [...] }, signature }, variants as in ucp search.',
+    'ucp checkout create': "Buy for the human, step 2: open a checkout with the items the human picked. c11r ucp checkout create --item <sku>[:<qty>] [--item ...] [--code <discount>] [--country CC] [--store <host>]. Returns the checkout: { id, status, store, currency, line_items: [{ id, sku, title, quantity, unit_price, total }], buyer, ship_to, shipping, discounts, codes, totals: [{ type, label, amount, major, display }], total, messages, continue_url, expires_at, links, signature }. status is incomplete until the buyer's email and shipping address are given: messages say what is missing. Ask the human for them, never invent them, then c11r ucp checkout update <id>. The id is remembered with its store: later steps need no --store.",
+    'ucp checkout update': "Buy for the human, step 3: give the buyer's details, change items or codes. c11r ucp checkout update <id> [--email --first-name --last-name --phone] [--street --city --postal-code --region --country] [--item <sku>:<qty> (0 removes)] [--code <discount> (adds)] [--shipping <option id>]; or the same as YAML or JSON on stdin or -f <file>: { buyer: { email, first_name, last_name, phone_number }, address: { street_address, address_locality, postal_code, address_region, address_country }, items: [\"SKU:2\"], codes: [...] (replaces), shipping }. Only what is given changes. Returns the checkout as in create: status ready_for_complete once nothing is missing, with shipping and the total including it; or incomplete with messages (address_undeliverable says where the store ships). Show the human the line items, shipping and total.display, ask for an explicit yes, then c11r ucp checkout complete <id>.",
+    'ucp checkout show': 'Show a checkout as the store has it now: c11r ucp checkout show <id> [--store <host>]. Returns the checkout as in ucp checkout create.',
+    'ucp checkout cancel': 'Cancel a checkout the human no longer wants: c11r ucp checkout cancel <id> [--store <host>]. Returns the checkout, status canceled.',
+    'ucp checkout complete': "Buy for the human, step 4, only after the human said yes to the total: pay the checkout. c11r ucp checkout complete <id> [--decline] [--store <host>]. Pays with the sandbox handler (ai.commercelayer.sandbox: test payments, no money moves); --decline uses the declined test card. Returns the checkout with status completed and order: { id, label, permalink_url }, plus payment_handler. Tell the human the order label and give them permalink_url. A store with no sandbox handler (a live store with a real payment gateway) answers payment_handler_unsupported: give the human continue_url to pay there. A declined payment leaves status ready_for_complete with a payment_failed message.",
+    'ucp order': 'Read an order this CLI placed: c11r ucp order <id> [--store <host>]. Returns { id, label, permalink_url, store, checkout_id, currency, line_items: [{ sku, title, quantity, status, total }], fulfillment: [{ method, destination, description }], events, totals, signature }.',
+    'ucp ask': 'Ask a store a question in plain language over UCP (shipping, returns, what it sells): c11r ucp ask "<question>" [--store <host>]. Returns { store, question, answer, links, messages, signature }. The answer is the store\'s: quote it, do not embellish it. Ask only answers; buy with ucp checkout.',
     status: 'Show the sandbox, what is applied, and whether the store files have changes not yet applied (the same changes plan lists).',
     claim: 'Start keeping this sandbox store: returns a URL and a code for the human to approve in the browser.',
     help: 'Describe the commands. `c11r help <command>` for one command, `c11r help <group>` (catalog, orders, storefront, ucp) for a group.',
@@ -354,6 +364,133 @@ export async function claim() {
         next: 'Ask the human to open verification_url and enter user_code, then run `c11r status`.',
     };
 }
+// ---------- ucp: buying for the human, step by step, from this store or any UCP store
+/** The store to buy from: --store, else the one an id was made at, else this folder's. */
+async function shopOrigin(values, id) {
+    if (values.store)
+        return shop.originOf(values.store);
+    const known = id ? shop.remembered(id) : undefined;
+    if (known)
+        return known;
+    if (!readCredentials())
+        fail('no_store', 'There is no store in this folder, and no --store was given.', 'Pass the store to buy from: --store <hostname or https origin>.');
+    return storeOrigin();
+}
+const needId = (id, command) => {
+    if (!id)
+        fail('missing_argument', `${command} needs a checkout id.`, 'Use the id that c11r ucp checkout create printed (chk_...).');
+    return id;
+};
+const checkoutNext = (ck) => {
+    if (ck.status === 'completed')
+        return `Paid. Tell the human: order ${ck.order?.label ?? ck.order?.id}, and give them ${ck.order?.permalink_url}.`;
+    if (ck.status === 'canceled')
+        return 'Canceled. Open a new one with c11r ucp checkout create --item <sku> if the human wants to buy.';
+    if (ck.status === 'ready_for_complete') {
+        const declined = (ck.messages ?? []).some((m) => m.code === 'payment_failed');
+        if (declined)
+            return `The payment failed: tell the human. Try again only if they ask: c11r ucp checkout complete ${ck.id}.`;
+        return `Show the human the items, shipping and total (${ck.total?.display}), ask for an explicit yes, then run c11r ucp checkout complete ${ck.id}.`;
+    }
+    const errors = (ck.messages ?? []).filter((m) => m.type === 'error').map((m) => m.content);
+    return `Still needed: ${errors.join(' ') || 'see messages'} Ask the human (never invent buyer details), then run c11r ucp checkout update ${ck.id} with what they said.`;
+};
+export async function ucpSearch(query, values) {
+    const r = await shop.search(await shopOrigin(values), query, values.country);
+    return { ...r, next: r.count ? 'Show the human the products (title, price.display), let them pick, then c11r ucp checkout create --item <sku>[:<qty>].' : 'Nothing matched: try another query, or none for the whole catalog.' };
+}
+export async function ucpProduct(id, values) {
+    if (!id)
+        fail('missing_argument', 'ucp product needs a product id or sku.', 'Use an id or sku from c11r ucp search.');
+    return shop.product(await shopOrigin(values), id, values.country);
+}
+export async function ucpCheckoutCreate(values, lists) {
+    const items = (lists.item ?? []).map(shop.parseItem);
+    if (!items.length)
+        fail('missing_argument', 'ucp checkout create needs at least one --item.', 'Example: c11r ucp checkout create --item ETH-250:2. The skus are in c11r ucp search.');
+    if (items.some((l) => l.quantity < 1))
+        fail('invalid_argument', 'An --item quantity must be 1 or more.', 'Example: --item ETH-250:2.');
+    const ck = await shop.createCheckout(await shopOrigin(values), items, lists.code ?? [], values.country);
+    return { ...ck, next: checkoutNext(ck) };
+}
+const BUYER_FLAGS = { email: 'email', 'first-name': 'first_name', 'last-name': 'last_name', phone: 'phone_number' };
+const ADDRESS_FLAGS = { street: 'street_address', city: 'address_locality', 'postal-code': 'postal_code', region: 'address_region', country: 'address_country' };
+export async function ucpCheckoutUpdate(id, values, lists) {
+    needId(id, 'ucp checkout update');
+    const pick = (map) => {
+        const out = {};
+        for (const [flag, key] of Object.entries(map))
+            if (values[flag] !== undefined)
+                out[key] = values[flag];
+        return Object.keys(out).length ? out : undefined;
+    };
+    const changes = { buyer: pick(BUYER_FLAGS), address: pick(ADDRESS_FLAGS), items: lists.item?.map(shop.parseItem), add_codes: lists.code, shipping: values.shipping };
+    const flagged = Object.values(changes).some((v) => v !== undefined);
+    if (!flagged || values.file) {
+        // No flags: the changes as YAML or JSON on stdin or -f.
+        const raw = await readText(values, 'checkout update', `Give the changes as flags (--email ..., --street ...) or as YAML or JSON on stdin or -f <file>: { buyer: {...}, address: {...}, items, codes, shipping }.`);
+        const bad = (msg) => fail('invalid_argument', `checkout update: ${msg}`, 'The input is { buyer: { email, first_name, last_name, phone_number }, address: { street_address, address_locality, postal_code, address_region, address_country }, items: ["SKU:2"], codes: [...], shipping }.');
+        if (!raw || typeof raw !== 'object' || Array.isArray(raw))
+            bad('the input is not a map.');
+        const r = raw;
+        for (const k of Object.keys(r))
+            if (!['buyer', 'address', 'items', 'codes', 'shipping'].includes(k))
+                bad(`unknown key ${k}.`);
+        const map = (o, keys, what) => {
+            if (o === undefined)
+                return undefined;
+            if (!o || typeof o !== 'object' || Array.isArray(o))
+                bad(`${what} is not a map.`);
+            for (const [k, v] of Object.entries(o))
+                if (!keys.includes(k) || typeof v !== 'string')
+                    bad(`${what}.${k} is not one of ${keys.join(', ')} with a text value.`);
+            return o;
+        };
+        if (r.buyer !== undefined)
+            changes.buyer = { ...map(r.buyer, Object.values(BUYER_FLAGS), 'buyer'), ...changes.buyer };
+        if (r.address !== undefined)
+            changes.address = { ...map(r.address, ['first_name', 'last_name', 'extended_address', ...Object.values(ADDRESS_FLAGS)], 'address'), ...changes.address };
+        if (r.items !== undefined) {
+            if (!Array.isArray(r.items))
+                bad('items is not a list.');
+            changes.items = [...r.items.map((x) => (typeof x === 'string' ? shop.parseItem(x) : x && typeof x === 'object' && typeof x.sku === 'string' && Number.isInteger(x.quantity) ? { sku: x.sku, quantity: x.quantity } : bad('items holds "SKU:QTY" or { sku, quantity }.'))), ...(changes.items ?? [])];
+        }
+        if (r.codes !== undefined) {
+            if (!Array.isArray(r.codes) || r.codes.some((c) => typeof c !== 'string'))
+                bad('codes is not a list of codes.');
+            changes.codes = [...r.codes, ...(changes.add_codes ?? [])];
+        }
+        if (r.shipping !== undefined)
+            changes.shipping = changes.shipping ?? String(r.shipping);
+    }
+    if (changes.items?.some((l) => !Number.isInteger(l.quantity) || l.quantity < 0))
+        fail('invalid_argument', 'An item quantity must be 0 (remove it) or more.', 'Example: --item ETH-250:2.');
+    const ck = await shop.updateCheckout(await shopOrigin(values, id), id, changes);
+    return { ...ck, next: checkoutNext(ck) };
+}
+export async function ucpCheckoutShow(id, values) {
+    const ck = await shop.getCheckout(await shopOrigin(values, needId(id, 'ucp checkout show')), id);
+    return { ...ck, next: checkoutNext(ck) };
+}
+export async function ucpCheckoutCancel(id, values) {
+    const ck = await shop.cancelCheckout(await shopOrigin(values, needId(id, 'ucp checkout cancel')), id);
+    return { ...ck, next: checkoutNext(ck) };
+}
+export async function ucpCheckoutComplete(id, values, flags) {
+    const ck = await shop.completeCheckout(await shopOrigin(values, needId(id, 'ucp checkout complete')), id, flags.has('--decline'));
+    return { ...ck, payment_handler: 'ai.commercelayer.sandbox (test payments only)', next: checkoutNext(ck) };
+}
+export async function ucpOrder(id, values) {
+    if (!id)
+        fail('missing_argument', 'ucp order needs an order id.', 'Use order.id from c11r ucp checkout complete.');
+    const o = await shop.getOrder(await shopOrigin(values, id), id);
+    return { ...o, next: `Tell the human: order ${o.label}, details at ${o.permalink_url}.` };
+}
+export async function ucpAsk(question, values) {
+    if (!question.trim())
+        fail('missing_argument', 'ucp ask needs a question.', 'Example: c11r ucp ask "Do you ship to Canada?".');
+    return shop.ask(await shopOrigin(values), question);
+}
 // ---------- promotions: live settings in Commerce Layer, not store files
 /** What list and show print beyond the spec: dropped when it is sent back. */
 const READ_ONLY = ['status', 'uses', 'managed', 'url', 'urls', 'created_at'];
@@ -362,7 +499,14 @@ const READ_ONLY = ['status', 'uses', 'managed', 'url', 'urls', 'created_at'];
  * can be edited and sent back: the read-only fields are dropped.
  */
 async function readInput(values, what) {
-    const usage = `Give the ${what} as YAML or JSON on stdin (c11r ${what}s create <<'EOF' ... EOF) or with -f <file>.`;
+    const raw = await readText(values, what, `Give the ${what} as YAML or JSON on stdin (c11r ${what}s create <<'EOF' ... EOF) or with -f <file>.`, `invalid_${what}`);
+    if (raw && typeof raw === 'object' && !Array.isArray(raw))
+        for (const k of READ_ONLY)
+            delete raw[k];
+    return raw;
+}
+/** YAML or JSON from -f <file> or stdin, parsed. */
+async function readText(values, what, usage, invalid = 'invalid_argument') {
     let text = '';
     if (values.file) {
         if (!fs.existsSync(values.file))
@@ -385,11 +529,8 @@ async function readInput(values, what) {
         raw = YAML.parse(text);
     }
     catch (e) {
-        fail(`invalid_${what}`, `${what}: not valid YAML or JSON: ${e.message.split('\n')[0]}`, 'Fix the syntax and run the command again.');
+        fail(invalid, `${what}: not valid YAML or JSON: ${e.message.split('\n')[0]}`, 'Fix the syntax and run the command again.');
     }
-    if (raw && typeof raw === 'object' && !Array.isArray(raw))
-        for (const k of READ_ONLY)
-            delete raw[k];
     return raw;
 }
 /** A promotion spec, validated against store.yml's markets and products. */

package/dist/ucp/platform.js

@@ -74,7 +74,7 @@ export function agentProfile() {
             },
         },
         name: 'Commerce Layer agent CLI',
-        description: 'c11r, the Commerce Layer CLI for coding agents, acting as a shopping platform: it places test orders and checks a store speaks UCP.',
+        description: 'The Commerce Layer agent CLI: a shopping agent that buys from UCP stores on behalf of a human, places test orders in its own store and checks that a store speaks UCP.',
     };
 }
 /** Minor units per currency unit (ISO 4217 exponent). */

package/dist/ucp/shop.js

@@ -0,0 +1,308 @@
+// Buying from a store step by step, for an agent shopping on behalf of its human: search,
+// look at a product, open a checkout, give the buyer's details, pay, read the order. Each
+// step is one command, so the agent talks to the human in between. The results are trimmed
+// for a conversation: prices in major units as well as minor, what is still missing.
+// buy.ts is the one-shot test buyer; this is the real one, with the human's details.
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { fail } from '../output.js';
+import { discover, replay, shopping, UcpError } from './client.js';
+import { sandboxInstrument } from './buy.js';
+import { minorUnits, SANDBOX_HANDLER } from './platform.js';
+// ---------- which store an id belongs to
+/** Checkout and order ids, by the store origin they were made at: later steps need no --store. */
+const stateFile = () => process.env.C11R_UCP_STATE ?? path.join(process.env.XDG_STATE_HOME ?? path.join(os.homedir(), '.local', 'state'), 'c11r', 'ucp.json');
+const MAX_REMEMBERED = 200;
+function readState() {
+    try {
+        return JSON.parse(fs.readFileSync(stateFile(), 'utf8'));
+    }
+    catch {
+        return {};
+    }
+}
+export function remember(id, origin) {
+    const s = readState();
+    delete s[id];
+    s[id] = origin;
+    const keys = Object.keys(s);
+    for (const k of keys.slice(0, Math.max(0, keys.length - MAX_REMEMBERED)))
+        delete s[k];
+    fs.mkdirSync(path.dirname(stateFile()), { recursive: true });
+    fs.writeFileSync(stateFile(), JSON.stringify(s, null, 2) + '\n', { mode: 0o600 });
+}
+export const remembered = (id) => readState()[id];
+/** A store origin from --store: an origin, a URL on the store, or a bare hostname. */
+export function originOf(given) {
+    let url;
+    try {
+        url = new URL(/^[a-z]+:\/\//i.test(given) ? given : `https://${given}`);
+    }
+    catch {
+        fail('invalid_argument', `--store ${given} is not a URL or hostname.`, 'Give the store as a hostname (shop.example.com) or an origin (https://shop.example.com).');
+    }
+    if (url.protocol !== 'https:' && !(url.protocol === 'http:' && ['localhost', '127.0.0.1'].includes(url.hostname)))
+        fail('invalid_argument', `--store ${given} is not https.`, 'UCP stores are served over https: give https://<host>.');
+    return url.origin;
+}
+export function money(amount, currency) {
+    const minor = minorUnits(currency);
+    const decimals = Math.round(Math.log10(minor));
+    const major = amount / minor;
+    return { amount, currency, major, display: `${amount < 0 ? '-' : ''}${currency} ${Math.abs(major).toFixed(decimals)}` };
+}
+const plain = (d) => d?.plain ?? d?.markdown ?? d?.html;
+function variantView(v) {
+    const shipping = v.fulfillment?.methods?.map((m) => plain(m.description)).filter(Boolean).join('; ');
+    return {
+        id: v.id,
+        sku: v.sku ?? v.id,
+        title: v.title,
+        price: v.price ? money(v.price.amount, v.price.currency) : undefined,
+        available: v.availability?.available ?? undefined,
+        availability: v.availability?.status ?? undefined,
+        image_url: v.media?.find((m) => m.type === 'image')?.url,
+        ships: shipping || undefined,
+    };
+}
+export function productView(p, full = false) {
+    const variants = (p.variants ?? []).map(variantView);
+    const description = plain(p.description);
+    const image = p.media?.find((m) => m.type === 'image')?.url ?? variants[0]?.image_url;
+    return {
+        id: p.id,
+        title: p.title,
+        description: full || !description || description.length <= 200 ? description : `${description.slice(0, 197)}...`,
+        url: p.url,
+        image_url: image,
+        // A search lists a variant's image only when it is not the product's.
+        variants: full ? variants : variants.map((v) => ({ ...v, image_url: v.image_url === image ? undefined : v.image_url })),
+    };
+}
+const sign = (c) => c.signature ?? 'unsigned';
+function selectedDestination(ck) {
+    const m = ck.fulfillment?.methods?.[0];
+    return m?.destinations?.find((d) => d.id === m.selected_destination_id);
+}
+/** A checkout for the conversation: what is in it, what it costs, what is still missing. */
+export function checkoutView(ck, origin, call) {
+    const cur = ck.currency;
+    const method = ck.fulfillment?.methods?.[0];
+    const group = method?.groups?.[0];
+    const options = group?.options ?? [];
+    const option = options.find((o) => o.id === group?.selected_option_id);
+    const optionView = (o) => ({ id: o.id, title: o.title, description: plain(o.description), price: o.totals?.find((t) => t.type === 'total') ? money(o.totals.find((t) => t.type === 'total').amount, cur) : undefined });
+    const { id: _id, type: _type, ...address } = selectedDestination(ck) ?? {};
+    const total = (ck.totals ?? []).find((t) => t.type === 'total');
+    return {
+        id: ck.id,
+        status: ck.status,
+        store: origin,
+        currency: cur,
+        line_items: (ck.line_items ?? []).map((l) => ({
+            id: l.id,
+            sku: l.item?.id,
+            title: l.item?.title,
+            quantity: l.quantity,
+            unit_price: l.item?.price === undefined ? undefined : money(l.item.price, cur),
+            total: money((l.totals ?? []).find((t) => t.type === 'total')?.amount ?? 0, cur),
+        })),
+        buyer: ck.buyer ? Object.fromEntries(Object.entries(ck.buyer).filter(([k]) => k !== 'consent')) : undefined,
+        ship_to: Object.keys(address).length ? address : undefined,
+        shipping: option ? optionView(option) : undefined,
+        shipping_options: options.length > 1 ? options.map(optionView) : undefined,
+        discounts: ck.discounts?.applied?.length ? ck.discounts.applied.map((d) => ({ code: d.code, title: d.title, automatic: d.automatic, amount: money(d.amount, cur) })) : undefined,
+        codes: ck.discounts?.codes?.length ? ck.discounts.codes : undefined,
+        totals: (ck.totals ?? []).map((t) => ({ type: t.type, label: t.display_text, ...money(t.amount, cur) })),
+        total: total ? money(total.amount, cur) : undefined,
+        messages: ck.messages,
+        order: ck.order,
+        continue_url: ck.continue_url,
+        expires_at: ck.expires_at,
+        links: ck.links,
+        signature: sign(call),
+    };
+}
+export function orderView(o, origin, call) {
+    const cur = o.currency;
+    return {
+        id: o.id,
+        label: o.label,
+        permalink_url: o.permalink_url,
+        store: origin,
+        checkout_id: o.checkout_id,
+        currency: cur,
+        line_items: (o.line_items ?? []).map((l) => ({
+            sku: l.item?.id,
+            title: l.item?.title,
+            quantity: l.quantity?.total ?? l.quantity,
+            status: l.status,
+            total: money((l.totals ?? []).find((t) => t.type === 'total')?.amount ?? 0, cur),
+        })),
+        fulfillment: (o.fulfillment?.expectations ?? []).map((e) => ({ method: e.method_type, destination: e.destination, description: e.description })),
+        events: o.fulfillment?.events?.length ? o.fulfillment.events : undefined,
+        totals: (o.totals ?? []).map((t) => ({ type: t.type, label: t.display_text, ...money(t.amount, cur) })),
+        signature: sign(call),
+    };
+}
+// ---------- the steps
+/** Turn a store's refusal into a CLI error; a missing checkout or order is not_found. */
+async function step(origin, run) {
+    try {
+        return await run();
+    }
+    catch (e) {
+        if (!(e instanceof UcpError))
+            throw e;
+        const code = e.call.body?.messages?.[0]?.code;
+        if (code === 'not_found' || e.call.status === 404)
+            fail('not_found', e.message, `The store at ${origin} does not know it. Check the id, or pass --store <the store it was made at>.`);
+        if (code === 'identity_required' || e.call.status === 401)
+            fail('identity_required', e.message, 'Orders are readable by the platform that placed them: this CLI can only read orders it placed.');
+        fail('ucp_error', e.message, `The store at ${origin} refused it: tell the human what it said. The skus it sells are in c11r ucp search.`);
+    }
+}
+/** --item SKU or SKU:QTY. */
+export function parseItem(raw) {
+    const m = String(raw).match(/^(.+?)(?::(\d+))?$/);
+    if (!m || !m[1].trim())
+        fail('invalid_argument', `--item ${raw} is not SKU or SKU:QUANTITY.`, 'Example: --item ETH-250:2 (quantity 1 when left out, 0 to remove it in checkout update).');
+    return { sku: m[1].trim(), quantity: m[2] === undefined ? 1 : Number(m[2]) };
+}
+export async function open(origin) {
+    const store = await discover(origin);
+    if (!store.capabilities.has('dev.ucp.shopping.checkout'))
+        fail('checkout_unsupported', `The store at ${origin} does not offer UCP checkout to this CLI.`, 'It can only be browsed: give the human the store URL to buy there.');
+    return store;
+}
+export async function search(origin, query, country) {
+    const store = await discover(origin);
+    const body = { query, pagination: { limit: 50 } };
+    if (country)
+        body.context = { address_country: country.toUpperCase() };
+    const call = await step(origin, () => shopping.search(store, body));
+    const r = call.body;
+    const products = r.products ?? [];
+    return {
+        store: origin,
+        query,
+        count: products.length,
+        total_count: r.pagination?.total_count,
+        has_more: r.pagination?.has_next_page || undefined,
+        products: products.map((p) => productView(p)),
+        messages: r.messages,
+        signature: sign(call),
+    };
+}
+export async function product(origin, id, country) {
+    const store = await discover(origin);
+    const body = { id };
+    if (country)
+        body.context = { address_country: country.toUpperCase() };
+    const call = await step(origin, () => shopping.product(store, body));
+    return { store: origin, product: productView(call.body.product, true), signature: sign(call) };
+}
+export async function createCheckout(origin, items, codes, country) {
+    const store = await open(origin);
+    const body = { line_items: items.map((l) => ({ item: { id: l.sku }, quantity: l.quantity })) };
+    if (country)
+        body.context = { address_country: country.toUpperCase() };
+    if (codes.length)
+        body.discounts = { codes };
+    const call = await step(origin, () => shopping.createCheckout(store, body));
+    remember(call.body.id, origin);
+    return checkoutView(call.body, origin, call);
+}
+export async function getCheckout(origin, id) {
+    const store = await open(origin);
+    const call = await step(origin, () => shopping.getCheckout(store, id));
+    return checkoutView(call.body, origin, call);
+}
+const clean = (o) => Object.fromEntries(Object.entries(o).filter(([, v]) => v !== undefined && v !== ''));
+export async function updateCheckout(origin, id, ch) {
+    const store = await open(origin);
+    const current = (await step(origin, () => shopping.getCheckout(store, id))).body;
+    if (current.status === 'completed' || current.status === 'canceled')
+        fail('checkout_closed', `The checkout ${id} is ${current.status}.`, current.status === 'completed' ? `It is paid: c11r ucp order ${current.order?.id ?? '<id>'}.` : 'Open a new one: c11r ucp checkout create --item <sku>.');
+    const body = replay(current);
+    if (ch.buyer)
+        body.buyer = clean({ ...(current.buyer ?? {}), ...ch.buyer });
+    for (const l of ch.items ?? []) {
+        const i = body.line_items.findIndex((x) => x.item.id === l.sku);
+        if (l.quantity === 0) {
+            if (i >= 0)
+                body.line_items.splice(i, 1);
+        }
+        else if (i >= 0)
+            body.line_items[i].quantity = l.quantity;
+        else
+            body.line_items.push({ item: { id: l.sku }, quantity: l.quantity });
+    }
+    if (!body.line_items.length)
+        fail('invalid_argument', 'The update leaves the checkout with no items.', `Keep at least one item, or cancel it: c11r ucp checkout cancel ${id}.`);
+    const codes = ch.codes ?? [...(current.discounts?.codes ?? []), ...(ch.add_codes ?? [])];
+    if (ch.codes || ch.add_codes?.length)
+        body.discounts = { codes: [...new Set(codes)] };
+    if (ch.address || ch.shipping) {
+        const method = body.fulfillment?.methods?.[0] ?? { type: 'shipping', line_item_ids: (current.line_items ?? []).map((l) => l.id) };
+        if (ch.address) {
+            const prev = selectedDestination(current) ?? {};
+            const buyer = (body.buyer ?? {});
+            const dest = clean({ ...prev, first_name: buyer.first_name, last_name: buyer.last_name, ...ch.address, id: prev.id ?? 'dest_1' });
+            if (dest.address_country)
+                dest.address_country = String(dest.address_country).toUpperCase();
+            delete dest.type;
+            method.destinations = [dest];
+            method.selected_destination_id = dest.id;
+        }
+        if (ch.shipping)
+            method.groups = (method.groups?.length ? method.groups : [{ id: 'grp_1' }]).map((g) => ({ ...g, selected_option_id: ch.shipping }));
+        body.fulfillment = { methods: [method, ...(body.fulfillment?.methods?.slice(1) ?? [])] };
+    }
+    let call = await step(origin, () => shopping.updateCheckout(store, id, body));
+    // A store that offers shipping options without picking one: take its first, and say which in the result.
+    const group = call.body.fulfillment?.methods?.[0]?.groups?.[0];
+    if (group && !group.selected_option_id && group.options?.length) {
+        const again = replay(call.body);
+        again.fulfillment.methods[0].groups[0].selected_option_id = group.options[0].id;
+        call = await step(origin, () => shopping.updateCheckout(store, id, again));
+    }
+    // A store can answer ready_for_complete before the shipping is in the totals (seen once on a
+    // Commerce Layer store): read it again rather than show the human a total without shipping.
+    const ck = call.body;
+    if (ck.status === 'ready_for_complete' && ck.fulfillment?.methods?.[0]?.groups?.[0]?.selected_option_id && !(ck.totals ?? []).some((t) => t.type === 'fulfillment')) {
+        call = await step(origin, () => shopping.getCheckout(store, id));
+    }
+    return checkoutView(call.body, origin, call);
+}
+export async function cancelCheckout(origin, id) {
+    const store = await open(origin);
+    const call = await step(origin, () => shopping.cancelCheckout(store, id));
+    return checkoutView(call.body, origin, call);
+}
+export async function completeCheckout(origin, id, decline) {
+    const store = await open(origin);
+    if (!store.profile.ucp?.payment_handlers?.[SANDBOX_HANDLER]) {
+        const handlers = Object.keys(store.profile.ucp?.payment_handlers ?? {});
+        fail('payment_handler_unsupported', `The store at ${origin} takes ${handlers.length ? handlers.join(', ') : 'no payment handler this CLI knows'}; this CLI can only pay sandbox stores (${SANDBOX_HANDLER}) today.`, `Give the human the checkout's continue_url to pay there: c11r ucp checkout show ${id}.`);
+    }
+    const call = await step(origin, () => shopping.completeCheckout(store, id, { payment: { instruments: [sandboxInstrument(decline)] }, signals: { 'dev.ucp.user_agent': 'c11r' } }));
+    const ck = call.body;
+    if (ck.order?.id)
+        remember(ck.order.id, origin);
+    return checkoutView(ck, origin, call);
+}
+export async function getOrder(origin, id) {
+    const store = await discover(origin);
+    const call = await step(origin, () => shopping.getOrder(store, id));
+    return orderView(call.body, origin, call);
+}
+export async function ask(origin, question) {
+    const store = await discover(origin);
+    if (!store.capabilities.has('dev.ucp.common.ask'))
+        fail('ask_unsupported', `The store at ${origin} does not answer questions over UCP.`, 'Search its catalog instead: c11r ucp search <query>.');
+    const call = await step(origin, () => shopping.ask(store, { query: question }));
+    const r = call.body;
+    return { store: origin, question, answer: plain(r.answer), links: r.links, messages: r.messages, signature: sign(call) };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercelayer/agent-cli",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "description": "c11r: the Commerce Layer CLI for coding agents. Builds a sandbox store that people and shopping agents can buy from.",
   "homepage": "https://commercelayer.ai",
   "keywords": [