@commercelayer/agent-cli 0.8.1 → 1.0.0-dev.1

package/dist/api/client.js

@@ -1,190 +0,0 @@
-// The client for the management API at api.commercelayer.ai.
-import { CliError, fail, notice } from '../output.js';
-import { NPX } from '../version.js';
-import { apiUrl, DEFAULT_API_URL, send } from './transport.js';
-export function createApi(auth) {
-    const base = apiUrl() === 'stub' ? DEFAULT_API_URL : apiUrl().replace(/\/$/, '');
-    const org = () => {
-        if (!auth)
-            fail('no_store', 'There is no store in this repo.', 'Run `c11r init` in the repo root first.');
-        return `/stores/${auth.org}`;
-    };
-    const request = async (method, path, body) => {
-        const headers = { accept: 'application/json' };
-        if (auth)
-            headers.authorization = `Bearer ${auth.token}`;
-        const res = await send(method, base + path, headers, body === undefined ? undefined : JSON.stringify(body));
-        let data;
-        try {
-            data = res.body ? JSON.parse(res.body) : null;
-        }
-        catch {
-            fail('api_error', `${base} answered ${res.status} with something that is not JSON.`, 'Try again. If it keeps happening, tell the human, with the output of `c11r status`.');
-        }
-        // The API flags an outdated CLI (from the User-Agent) in warnings, on any answer, errors included.
-        const warnings = data && typeof data === 'object' && !Array.isArray(data) ? data.warnings : undefined;
-        if (Array.isArray(warnings)) {
-            const isOutdated = (w) => !!w && typeof w === 'object' && w.code === 'cli_outdated';
-            for (const n of warnings.filter(isOutdated))
-                notice({ ...n, hint: n.hint ?? `Run the commands with ${NPX}. If c11r is installed globally, tell the human it is on ${n.current} and ${n.latest} exists.` });
-            // Printed once, at the top of the output, not inside the order or store it came with.
-            const rest = warnings.filter((w) => !isOutdated(w));
-            if (rest.length)
-                data.warnings = rest;
-            else
-                delete data.warnings;
-        }
-        if (res.status < 400)
-            return data;
-        const err = data?.error;
-        if (err)
-            fail(err.code, err.message, err.hint, err.path);
-        fail('api_error', `The API answered ${res.status}.`, 'Try again. If it keeps happening, tell the human, with the output of `c11r status`.');
-    };
-    // Promotions and links: on an API older than them, the collection route is an unknown route (404 not_found).
-    const collection = (kind) => `${org()}/${kind}`;
-    const one = (kind, id) => `${collection(kind)}/${encodeURIComponent(id)}`;
-    const unsupported = async (kind, call) => {
-        try {
-            return await call;
-        }
-        catch (e) {
-            if (e instanceof CliError && (e.code === 'not_found' || (e.code === 'api_error' && /\b404\b/.test(e.message))))
-                fail(`${kind}_unsupported`, `This API does not manage ${kind} yet.`, 'Try again later; tell the human if it persists.');
-            throw e;
-        }
-    };
-    const found = async (kind, id, call) => {
-        try {
-            return await call;
-        }
-        catch (e) {
-            if (e instanceof CliError && e.code === 'not_found')
-                fail('not_found', `There is no ${kind.slice(0, -1)} ${id}.`, `Run \`c11r ${kind} list\` for the ids, or \`c11r ${kind} create\` to make it.`);
-            throw e;
-        }
-    };
-    // Orders and shipments for the merchant: an API older than them answers the UCP array on GET
-    // /orders?view=merchant and not_found on the routes it lacks. A not_found on one order or
-    // shipment is checked against the list, so a missing order is still not_found.
-    const qs = (query) => {
-        const p = new URLSearchParams(Object.entries(query).filter(([, v]) => v !== undefined && v !== ''));
-        return p.toString() ? `&${p}` : '';
-    };
-    const ordersUnsupported = () => fail('orders_unsupported', 'This API does not manage orders for the merchant yet.', 'Try again later; tell the human if it persists. c11r orders test still places test orders.');
-    const shipmentsUnsupported = () => fail('fulfillment_unsupported', 'This API does not manage shipments yet.', 'Try again later; tell the human if it persists.');
-    const listMerchantOrders = async (query) => {
-        const r = (await request('GET', `${org()}/orders?view=merchant${qs(query)}`));
-        if (Array.isArray(r) || !Array.isArray(r.orders))
-            ordersUnsupported();
-        return r;
-    };
-    const listShipments = async (query) => {
-        try {
-            const p = new URLSearchParams(Object.entries(query).filter(([, v]) => v !== undefined && v !== ''));
-            return (await request('GET', `${org()}/shipments${p.toString() ? `?${p}` : ''}`));
-        }
-        catch (e) {
-            if (e instanceof CliError && e.code === 'not_found')
-                shipmentsUnsupported();
-            throw e;
-        }
-    };
-    const orderCall = async (call) => {
-        try {
-            return await call();
-        }
-        catch (e) {
-            if (e instanceof CliError && e.code === 'not_found')
-                await listMerchantOrders({ limit: '1' });
-            throw e;
-        }
-    };
-    const shipmentCall = async (call) => {
-        try {
-            return await call();
-        }
-        catch (e) {
-            if (e instanceof CliError && e.code === 'not_found')
-                await listShipments({ limit: '1' });
-            throw e;
-        }
-    };
-    const orderPath = (id) => `${org()}/orders/${encodeURIComponent(id)}`;
-    const shipmentPath = (id) => `${org()}/shipments/${encodeURIComponent(id)}`;
-    return {
-        listMerchantOrders,
-        getMerchantOrder: (id) => orderCall(async () => {
-            const o = (await request('GET', `${orderPath(id)}?view=merchant`));
-            if (o && o.payment_status === undefined)
-                ordersUnsupported();
-            return o;
-        }),
-        createOrder: async (body) => {
-            try {
-                return (await request('POST', `${org()}/orders`, body));
-            }
-            catch (e) {
-                // An API before orders from messages has no POST /orders.
-                if (e instanceof CliError && e.code === 'not_found')
-                    fail('orders_unsupported', 'This API cannot create orders from messages yet.', 'Try again later; tell the human if it persists.');
-                throw e;
-            }
-        },
-        orderAction: (id, action, body) => orderCall(() => request('POST', `${orderPath(id)}/${action}`, body ?? {})),
-        listShipments,
-        // An API before the snapshot answers not_found: ops_unsupported, and the CLI reads the lists instead.
-        getOps: async (query) => {
-            try {
-                const r = (await request('GET', `${org()}/ops${qs(query).replace(/^&/, '?')}`));
-                if (!r || typeof r !== 'object' || !r.orders || !r.shipments)
-                    fail('ops_unsupported', 'This API has no operations snapshot yet.', 'The CLI reads the order and shipment lists instead.');
-                return r;
-            }
-            catch (e) {
-                if (e instanceof CliError && e.code === 'not_found')
-                    fail('ops_unsupported', 'This API has no operations snapshot yet.', 'The CLI reads the order and shipment lists instead.');
-                throw e;
-            }
-        },
-        insights: async (query) => {
-            try {
-                const r = (await request('GET', `${org()}/insights${qs(query).replace(/^&/, '?')}`));
-                if (!r || typeof r !== 'object' || !('totals' in r))
-                    fail('insights_unsupported', 'This API does not report insights yet.', 'Try again later; tell the human if it persists.');
-                return r;
-            }
-            catch (e) {
-                if (e instanceof CliError && e.code === 'not_found')
-                    fail('insights_unsupported', 'This API does not report insights yet.', 'Try again later; tell the human if it persists.');
-                throw e;
-            }
-        },
-        getShipment: (id) => shipmentCall(() => request('GET', shipmentPath(id))),
-        shipmentAction: (id, action, body) => shipmentCall(() => request('POST', `${shipmentPath(id)}/${action}`, body ?? {})),
-        listPromotions: () => unsupported('promotions', request('GET', collection('promotions'))),
-        createPromotion: (spec) => unsupported('promotions', request('POST', collection('promotions'), spec)),
-        getPromotion: (id) => found('promotions', id, request('GET', one('promotions', id))),
-        updatePromotion: (id, spec) => found('promotions', id, request('PUT', one('promotions', id), spec)),
-        setPromotionEnabled: (id, enabled) => found('promotions', id, request('POST', `${one('promotions', id)}/${enabled ? 'enable' : 'disable'}`)),
-        deletePromotion: async (id) => {
-            await found('promotions', id, request('DELETE', one('promotions', id)));
-        },
-        listLinks: () => unsupported('links', request('GET', collection('links'))),
-        createLink: (spec) => unsupported('links', request('POST', collection('links'), spec)),
-        getLink: (id) => found('links', id, request('GET', one('links', id))),
-        setLinkEnabled: (id, enabled) => found('links', id, request('POST', `${one('links', id)}/${enabled ? 'enable' : 'disable'}`)),
-        deleteLink: async (id) => {
-            await found('links', id, request('DELETE', one('links', id)));
-        },
-        // 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 }),
-        publishStorefront: (path, files) => request('PUT', `${org()}/storefront`, { path, files }),
-        listOrders: () => request('GET', `${org()}/orders`),
-        getOrder: (id) => request('GET', `${org()}/orders/${encodeURIComponent(id)}`),
-        startClaim: () => request('POST', `${org()}/claim`),
-    };
-}

package/dist/api/server.js

@@ -1,26 +0,0 @@
-#!/usr/bin/env node
-// Serve the stub platform over HTTP, so the CLI's real HTTP client can be exercised:
-//   npm run stub-api                       (port 4747)
-//   C11R_API_URL=http://localhost:4747 c11r init
-// Store hosts are reached as http://localhost:4747/-/<org>.sandbox.commercelayer.store/...
-// or with a real Host header.
-import http from 'node:http';
-import { handle } from './stub/index.js';
-const port = Number(process.env.PORT ?? 4747);
-http
-    .createServer((req, res) => {
-    let raw = '';
-    req.on('data', (chunk) => (raw += chunk));
-    req.on('end', () => {
-        const headers = {};
-        for (const [k, v] of Object.entries(req.headers))
-            if (typeof v === 'string')
-                headers[k.toLowerCase()] = v;
-        const host = headers.host ?? `localhost:${port}`;
-        const url = new URL(req.url ?? '/', `http://${host}`);
-        const { status, headers: resHeaders, body } = handle({ method: req.method ?? 'GET', url, headers, body: raw || undefined });
-        res.writeHead(status, resHeaders);
-        res.end(body);
-    });
-})
-    .listen(port, () => console.log(`stub platform on http://localhost:${port}`));

package/dist/api/stub/db.js

@@ -1,37 +0,0 @@
-// The stub's state: one JSON file, one record per sandbox. The real platform keeps
-// the same data behind api.commercelayer.ai and the store hosts.
-import fs from 'node:fs';
-import os from 'node:os';
-import path from 'node:path';
-const dbFile = process.env.C11R_STUB_DB
-    ?? path.join(process.env.XDG_STATE_HOME ?? path.join(os.homedir(), '.local', 'state'), 'c11r', 'stub-api.json');
-export function readDb() {
-    return fs.existsSync(dbFile) ? JSON.parse(fs.readFileSync(dbFile, 'utf8')) : {};
-}
-export function writeDb(db) {
-    fs.mkdirSync(path.dirname(dbFile), { recursive: true });
-    fs.writeFileSync(dbFile, JSON.stringify(db, null, 2) + '\n');
-}
-export const SANDBOX_DOMAIN = 'sandbox.commercelayer.store';
-/** The org a store hostname belongs to, or null if it is not a store host. */
-export function orgOfHost(hostname) {
-    const m = hostname.match(/^([a-z0-9-]+)\.sandbox\.commercelayer\.store$/);
-    return m ? m[1] : null;
-}
-/** Orders of a store, newest first, without private members. */
-export function publicOrders(r) {
-    return Object.values(r.ucp.orders).map((o) => strip(o)).reverse();
-}
-/** A deep copy without the members whose name starts with _. */
-export function strip(value) {
-    if (Array.isArray(value))
-        return value.map(strip);
-    if (value && typeof value === 'object') {
-        const out = {};
-        for (const [k, v] of Object.entries(value))
-            if (!k.startsWith('_'))
-                out[k] = strip(v);
-        return out;
-    }
-    return value;
-}

package/dist/api/stub/http.js

@@ -1,18 +0,0 @@
-// The HTTP shapes the stub works with: what a Cloudflare Worker would see. Keeping
-// the stub HTTP-shaped lets UCP headers (UCP-Agent, Idempotency-Key, signatures)
-// be modelled the way the real API will have to handle them.
-export function json(status, body, headers = {}) {
-    return { status, headers: { 'content-type': 'application/json', ...headers }, body: JSON.stringify(body) };
-}
-/** The management API's error shape, the same the CLI prints. */
-export function error(status, code, message, hint, path) {
-    return json(status, { error: { code, message, hint, ...(path ? { path } : {}) } });
-}
-export function readJson(req) {
-    if (!req.body)
-        return undefined;
-    return JSON.parse(req.body);
-}
-export function bearer(req) {
-    return req.headers.authorization?.replace(/^Bearer /i, '');
-}

package/dist/api/stub/index.js

@@ -1,52 +0,0 @@
-// A stand-in for the whole platform: api.commercelayer.ai (management) and
-// <org>.sandbox.commercelayer.store (the store: UCP, OAuth, the storefront).
-// server.ts serves it over HTTP; transport.ts calls handle() in-process when
-// C11R_API_URL=stub, so agent tests need no server running.
-//
-// Routing is by hostname. Over local HTTP, where subdomains do not resolve, the
-// path prefix /-/<host>/... stands in for the hostname.
-import { orgOfHost, readDb, writeDb } from './db.js';
-import { json } from './http.js';
-import { handleManagement } from './management.js';
-import { handleUcp } from './ucp.js';
-export function handle(req) {
-    let url = req.url;
-    const prefixed = url.pathname.match(/^\/-\/([^/]+)(\/.*)?$/);
-    if (prefixed)
-        url = new URL(`https://${prefixed[1]}${prefixed[2] ?? '/'}${url.search}`);
-    const org = orgOfHost(url.hostname);
-    if (org === null)
-        return outdated(req, handleManagement({ ...req, url }));
-    const db = readDb();
-    const store = db[org];
-    if (!store)
-        return json(404, { error: { code: 'not_found', message: `There is no store at ${url.hostname}.`, hint: 'The sandbox may have expired.' } });
-    const res = handleUcp({ ...req, url }, store);
-    writeDb(db);
-    return res;
-}
-/** "0.5.1" → [0, 5, 1], for comparing versions. */
-const parts = (v) => v.split('.').map((n) => Number.parseInt(n, 10) || 0);
-const older = (a, b) => {
-    const [x, y] = [parts(a), parts(b)];
-    for (let i = 0; i < 3; i++)
-        if ((x[i] ?? 0) !== (y[i] ?? 0))
-            return (x[i] ?? 0) < (y[i] ?? 0);
-    return false;
-};
-/**
- * Like the API: a CLI whose User-Agent (c11r/<version>) is older than the latest gets a
- * cli_outdated warning on every JSON object it is answered. The stub's latest is
- * C11R_STUB_LATEST_CLI; unset, every CLI is current.
- */
-function outdated(req, res) {
-    const latest = process.env.C11R_STUB_LATEST_CLI;
-    const current = req.headers['user-agent']?.match(/^c11r\/(\d+\.\d+\.\d+)/)?.[1];
-    if (!latest || !current || !older(current, latest) || !res.body)
-        return res;
-    const body = JSON.parse(res.body.toString());
-    if (!body || typeof body !== 'object' || Array.isArray(body))
-        return res;
-    const warning = { code: 'cli_outdated', current, latest, hint: `Run the commands with npx -y @commercelayer/agent-cli@latest. If c11r is installed globally, tell the human it is on ${current} and ${latest} exists.` };
-    return { ...res, body: JSON.stringify({ ...body, warnings: [...(Array.isArray(body.warnings) ? body.warnings : []), warning] }) };
-}

package/dist/api/stub/locale.js

@@ -1,52 +0,0 @@
-// Locales on the store host, as the store Worker does them: one per country, from the
-// `locales` the API derives on apply (the stub keeps them on the record). The texts come
-// from applied.products[sku].translations[ll], falling back to the base language.
-export const COOKIE = 'c11r_locale';
-export const baseLanguage = (r) => r.applied?.language ?? 'en';
-/** The languages the store has: the base one, then every language a product is translated into. */
-export function languagesOf(r) {
-    const out = new Set([baseLanguage(r)]);
-    for (const p of Object.values(r.applied?.products ?? {}))
-        for (const ll of Object.keys(p.translations ?? {}))
-            out.add(ll);
-    return out;
-}
-/** A product's name, description and category in a language, falling back to the base one. */
-export function texts(p, ll) {
-    const t = p.translations?.[ll] ?? {};
-    return { name: t.name ?? p.name, description: t.description ?? p.description, category: t.category ?? p.category };
-}
-/** The store's locales; none before an apply that derived them (the site stays as it was). */
-export const localesOf = (r) => r.locales ?? [];
-/** The locale at /<path>/, by its country: a known country with the wrong language still matches. */
-export const localeOfCountry = (r, country) => localesOf(r).find((l) => l.country === country.toUpperCase());
-/** The locale a cookie names, if it is one of the store's. */
-export function cookieLocale(r, cookie) {
-    const m = cookie?.match(new RegExp(`(?:^|;\\s*)${COOKIE}=([a-z]{2}-[a-z]{2})`));
-    return m ? localesOf(r).find((l) => l.path === m[1]) : undefined;
-}
-/** The locale of a product URL for a market: the buyer's country when it is in the market, else the market's first. */
-export function marketLocale(r, market, country) {
-    const ls = localesOf(r).filter((l) => l.market === market);
-    return ls.find((l) => country && l.country === country.toUpperCase()) ?? ls[0];
-}
-/**
- * The language of a UCP catalog answer: context.language (primary subtag), else the first
- * Accept-Language the store has, else the language of the buyer's country's locale, else the base.
- */
-export function ucpLanguage(r, context, acceptLanguage) {
-    const has = languagesOf(r);
-    const primary = (tag) => tag.trim().split(/[-_;]/)[0].toLowerCase();
-    const asked = typeof context?.language === 'string' ? primary(context.language) : '';
-    if (has.has(asked))
-        return asked;
-    for (const part of (acceptLanguage ?? '').split(',')) {
-        const ll = primary(part);
-        if (ll && has.has(ll))
-            return ll;
-    }
-    const country = typeof context?.address_country === 'string' ? localeOfCountry(r, context.address_country) : undefined;
-    if (country && has.has(country.language))
-        return country.language;
-    return baseLanguage(r);
-}