@aglyn/plugins-commerce 1.0.0-beta.221 → 1.0.0-beta.222

package/src/lib/server/api-v1/openapi.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { type ApiV1ResourceDescription } from '@aglyn/tenant-data-admin/server/api-v1-description';
+/**
+ * A site's products and orders as the customer API's OpenAPI document
+ * describes them — what the console's builder turns into paths, tags and
+ * schemas, and the MCP tools derive from. Transcribed unchanged from the
+ * builder's own list when the resources moved here (AGL-3080);
+ * `api-v1-openapi.spec.ts` holds the document to every endpoint the
+ * documentation promises.
+ */
+export declare const PRODUCTS_API_V1_DESCRIPTION: ApiV1ResourceDescription;
+export declare const ORDERS_API_V1_DESCRIPTION: ApiV1ResourceDescription;

package/src/lib/server/api-v1/openapi.js

@@ -0,0 +1,219 @@
+import { _ as _extends } from "@swc/helpers/_/_extends";
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ import { booleanField as bool, integerField as int, nullableField as nullable, objectKindField as OBJECT_FIELD, openObjectField as objectOf, postalAddressField as ADDRESS, queryParam as q, RECORD_STAMPS as STAMPS, stringField as str, stringListField as strList } from "@aglyn/tenant-data-admin/server/api-v1-description";
+/**
+ * A site's products and orders as the customer API's OpenAPI document
+ * describes them — what the console's builder turns into paths, tags and
+ * schemas, and the MCP tools derive from. Transcribed unchanged from the
+ * builder's own list when the resources moved here (AGL-3080);
+ * `api-v1-openapi.spec.ts` holds the document to every endpoint the
+ * documentation promises.
+ */ export const PRODUCTS_API_V1_DESCRIPTION = {
+    tag: 'Products',
+    description: 'A site’s catalog. Read-only over the API.',
+    schemaName: 'Product',
+    required: [
+        'id',
+        'object',
+        'name'
+    ],
+    fields: _extends({
+        id: str('Product id.'),
+        object: OBJECT_FIELD('product'),
+        name: str('Product name.'),
+        slug: str('URL slug.'),
+        description: nullable(str('Description.')),
+        type: str('Product type.'),
+        status: str('Publication status.'),
+        tags: strList('Free-form tags.'),
+        categoryIds: strList('Categories this product belongs to.'),
+        mediaUrls: strList('Image URLs.'),
+        options: {
+            type: 'array',
+            description: 'Option definitions, e.g. size.',
+            items: {
+                type: 'object',
+                additionalProperties: true
+            }
+        },
+        variants: {
+            type: 'array',
+            description: 'Purchasable variants.',
+            items: {
+                type: 'object',
+                additionalProperties: true
+            }
+        },
+        inventory: nullable(int('Stock on hand, when tracked.')),
+        subscription: nullable(objectOf('Subscription terms, when the product is one.'))
+    }, STAMPS),
+    ops: [
+        {
+            path: '/v1/sites/{siteId}/products',
+            method: 'get',
+            operationId: 'listProducts',
+            summary: 'List products',
+            list: true,
+            returns: 'Product',
+            description: 'Rows deleted since they were written are dropped after the read, so pages can come back short.',
+            pathParams: [
+                {
+                    name: 'siteId',
+                    description: 'Site id.'
+                }
+            ]
+        },
+        {
+            path: '/v1/sites/{siteId}/products/{productId}',
+            method: 'get',
+            operationId: 'getProduct',
+            summary: 'Retrieve a product',
+            returns: 'Product',
+            pathParams: [
+                {
+                    name: 'siteId',
+                    description: 'Site id.'
+                },
+                {
+                    name: 'productId',
+                    description: 'Product id.'
+                }
+            ]
+        }
+    ]
+};
+export const ORDERS_API_V1_DESCRIPTION = {
+    tag: 'Orders',
+    description: 'A site’s orders. Status moves are constrained.',
+    schemaName: 'Order',
+    required: [
+        'id',
+        'object',
+        'number',
+        'status'
+    ],
+    writable: [
+        'status',
+        'carrier',
+        'trackingNumber'
+    ],
+    writeOnly: {
+        status: {
+            type: 'string',
+            enum: [
+                'fulfilled',
+                'delivered'
+            ],
+            description: 'The status to move the order to.'
+        },
+        carrier: str('Free text, e.g. `UPS`. Trimmed to 40 characters.'),
+        trackingNumber: str('Free text. Trimmed to 60 characters.')
+    },
+    writeRequired: [
+        'status'
+    ],
+    fields: {
+        id: str('Order id.'),
+        object: OBJECT_FIELD('order'),
+        number: int('Human-facing order number.'),
+        status: str('Order status.'),
+        channel: str('`online` by default. Older orders carry no stored value, so `?channel=online` drops them after the read.'),
+        currency: str('ISO 4217 code.'),
+        customerEmail: nullable(str('Customer email.')),
+        customerName: nullable(str('Customer name.')),
+        lineItems: {
+            type: 'array',
+            description: 'What was bought.',
+            items: {
+                type: 'object',
+                additionalProperties: true
+            }
+        },
+        totals: objectOf('Money totals, in the smallest unit of `currency`.'),
+        refundedCents: int('Amount refunded so far.'),
+        disputed: bool('Whether a chargeback is open.'),
+        shippingAddress: ADDRESS(),
+        couponCode: nullable(str('Coupon applied.')),
+        fulfillments: {
+            type: 'array',
+            description: 'Shipments and deliveries.',
+            items: {
+                type: 'object',
+                additionalProperties: true
+            }
+        },
+        created: STAMPS.created
+    },
+    ops: [
+        {
+            path: '/v1/sites/{siteId}/orders',
+            method: 'get',
+            operationId: 'listOrders',
+            summary: 'List orders',
+            list: true,
+            returns: 'Order',
+            filters: [
+                q('channel', '`online` is a default rather than a stored value, so filtering on it drops older orders after the read.'),
+                q('status', 'Order status.')
+            ],
+            pathParams: [
+                {
+                    name: 'siteId',
+                    description: 'Site id.'
+                }
+            ]
+        },
+        {
+            path: '/v1/sites/{siteId}/orders/{orderId}',
+            method: 'get',
+            operationId: 'getOrder',
+            summary: 'Retrieve an order',
+            returns: 'Order',
+            pathParams: [
+                {
+                    name: 'siteId',
+                    description: 'Site id.'
+                },
+                {
+                    name: 'orderId',
+                    description: 'Order id.'
+                }
+            ]
+        },
+        {
+            path: '/v1/sites/{siteId}/orders/{orderId}',
+            method: 'patch',
+            operationId: 'updateOrder',
+            summary: 'Move an order’s status',
+            accepts: 'OrderWrite',
+            returns: 'Order',
+            description: 'An illegal transition is `409 conflict` (`code: "order_transition"`), and the message names the status it is in.',
+            pathParams: [
+                {
+                    name: 'siteId',
+                    description: 'Site id.'
+                },
+                {
+                    name: 'orderId',
+                    description: 'Order id.'
+                }
+            ]
+        }
+    ]
+};
+
+//# sourceMappingURL=openapi.js.map

package/src/lib/server/api-v1/openapi.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../../libs/plugins/commerce/src/lib/server/api-v1/openapi.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  type ApiV1ResourceDescription,\n  booleanField as bool,\n  integerField as int,\n  nullableField as nullable,\n  objectKindField as OBJECT_FIELD,\n  openObjectField as objectOf,\n  postalAddressField as ADDRESS,\n  queryParam as q,\n  RECORD_STAMPS as STAMPS,\n  stringField as str,\n  stringListField as strList,\n} from '@aglyn/tenant-data-admin/server/api-v1-description'\n\n/**\n * A site's products and orders as the customer API's OpenAPI document\n * describes them — what the console's builder turns into paths, tags and\n * schemas, and the MCP tools derive from. Transcribed unchanged from the\n * builder's own list when the resources moved here (AGL-3080);\n * `api-v1-openapi.spec.ts` holds the document to every endpoint the\n * documentation promises.\n */\nexport const PRODUCTS_API_V1_DESCRIPTION: ApiV1ResourceDescription = {\n  tag: 'Products',\n  description: 'A site’s catalog. Read-only over the API.',\n  schemaName: 'Product',\n  required: ['id', 'object', 'name'],\n  fields: {\n    id: str('Product id.'),\n    object: OBJECT_FIELD('product'),\n    name: str('Product name.'),\n    slug: str('URL slug.'),\n    description: nullable(str('Description.')),\n    type: str('Product type.'),\n    status: str('Publication status.'),\n    tags: strList('Free-form tags.'),\n    categoryIds: strList('Categories this product belongs to.'),\n    mediaUrls: strList('Image URLs.'),\n    options: { type: 'array', description: 'Option definitions, e.g. size.', items: { type: 'object', additionalProperties: true } },\n    variants: { type: 'array', description: 'Purchasable variants.', items: { type: 'object', additionalProperties: true } },\n    inventory: nullable(int('Stock on hand, when tracked.')),\n    subscription: nullable(objectOf('Subscription terms, when the product is one.')),\n    ...STAMPS,\n  },\n  ops: [\n    { path: '/v1/sites/{siteId}/products', method: 'get', operationId: 'listProducts', summary: 'List products', list: true, returns: 'Product', description: 'Rows deleted since they were written are dropped after the read, so pages can come back short.', pathParams: [{ name: 'siteId', description: 'Site id.' }] },\n    { path: '/v1/sites/{siteId}/products/{productId}', method: 'get', operationId: 'getProduct', summary: 'Retrieve a product', returns: 'Product', pathParams: [{ name: 'siteId', description: 'Site id.' }, { name: 'productId', description: 'Product id.' }] },\n  ],\n}\n\nexport const ORDERS_API_V1_DESCRIPTION: ApiV1ResourceDescription = {\n  tag: 'Orders',\n  description: 'A site’s orders. Status moves are constrained.',\n  schemaName: 'Order',\n  required: ['id', 'object', 'number', 'status'],\n  writable: ['status', 'carrier', 'trackingNumber'],\n  writeOnly: {\n    status: { type: 'string', enum: ['fulfilled', 'delivered'], description: 'The status to move the order to.' },\n    carrier: str('Free text, e.g. `UPS`. Trimmed to 40 characters.'),\n    trackingNumber: str('Free text. Trimmed to 60 characters.'),\n  },\n  writeRequired: ['status'],\n  fields: {\n    id: str('Order id.'),\n    object: OBJECT_FIELD('order'),\n    number: int('Human-facing order number.'),\n    status: str('Order status.'),\n    channel: str('`online` by default. Older orders carry no stored value, so `?channel=online` drops them after the read.'),\n    currency: str('ISO 4217 code.'),\n    customerEmail: nullable(str('Customer email.')),\n    customerName: nullable(str('Customer name.')),\n    lineItems: { type: 'array', description: 'What was bought.', items: { type: 'object', additionalProperties: true } },\n    totals: objectOf('Money totals, in the smallest unit of `currency`.'),\n    refundedCents: int('Amount refunded so far.'),\n    disputed: bool('Whether a chargeback is open.'),\n    shippingAddress: ADDRESS(),\n    couponCode: nullable(str('Coupon applied.')),\n    fulfillments: { type: 'array', description: 'Shipments and deliveries.', items: { type: 'object', additionalProperties: true } },\n    created: STAMPS.created,\n  },\n  ops: [\n    { path: '/v1/sites/{siteId}/orders', method: 'get', operationId: 'listOrders', summary: 'List orders', list: true, returns: 'Order', filters: [q('channel', '`online` is a default rather than a stored value, so filtering on it drops older orders after the read.'), q('status', 'Order status.')], pathParams: [{ name: 'siteId', description: 'Site id.' }] },\n    { path: '/v1/sites/{siteId}/orders/{orderId}', method: 'get', operationId: 'getOrder', summary: 'Retrieve an order', returns: 'Order', pathParams: [{ name: 'siteId', description: 'Site id.' }, { name: 'orderId', description: 'Order id.' }] },\n    { path: '/v1/sites/{siteId}/orders/{orderId}', method: 'patch', operationId: 'updateOrder', summary: 'Move an order’s status', accepts: 'OrderWrite', returns: 'Order', description: 'An illegal transition is `409 conflict` (`code: \"order_transition\"`), and the message names the status it is in.', pathParams: [{ name: 'siteId', description: 'Site id.' }, { name: 'orderId', description: 'Order id.' }] },\n  ],\n}\n"],"names":["booleanField","bool","integerField","int","nullableField","nullable","objectKindField","OBJECT_FIELD","openObjectField","objectOf","postalAddressField","ADDRESS","queryParam","q","RECORD_STAMPS","STAMPS","stringField","str","stringListField","strList","PRODUCTS_API_V1_DESCRIPTION","tag","description","schemaName","required","fields","id","object","name","slug","type","status","tags","categoryIds","mediaUrls","options","items","additionalProperties","variants","inventory","subscription","ops","path","method","operationId","summary","list","returns","pathParams","ORDERS_API_V1_DESCRIPTION","writable","writeOnly","enum","carrier","trackingNumber","writeRequired","number","channel","currency","customerEmail","customerName","lineItems","totals","refundedCents","disputed","shippingAddress","couponCode","fulfillments","created","filters","accepts"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAEEA,gBAAgBC,IAAI,EACpBC,gBAAgBC,GAAG,EACnBC,iBAAiBC,QAAQ,EACzBC,mBAAmBC,YAAY,EAC/BC,mBAAmBC,QAAQ,EAC3BC,sBAAsBC,OAAO,EAC7BC,cAAcC,CAAC,EACfC,iBAAiBC,MAAM,EACvBC,eAAeC,GAAG,EAClBC,mBAAmBC,OAAO,QACrB,qDAAoD;AAE3D;;;;;;;CAOC,GACD,OAAO,MAAMC,8BAAwD;IACnEC,KAAK;IACLC,aAAa;IACbC,YAAY;IACZC,UAAU;QAAC;QAAM;QAAU;KAAO;IAClCC,QAAQ;QACNC,IAAIT,IAAI;QACRU,QAAQpB,aAAa;QACrBqB,MAAMX,IAAI;QACVY,MAAMZ,IAAI;QACVK,aAAajB,SAASY,IAAI;QAC1Ba,MAAMb,IAAI;QACVc,QAAQd,IAAI;QACZe,MAAMb,QAAQ;QACdc,aAAad,QAAQ;QACrBe,WAAWf,QAAQ;QACnBgB,SAAS;YAAEL,MAAM;YAASR,aAAa;YAAkCc,OAAO;gBAAEN,MAAM;gBAAUO,sBAAsB;YAAK;QAAE;QAC/HC,UAAU;YAAER,MAAM;YAASR,aAAa;YAAyBc,OAAO;gBAAEN,MAAM;gBAAUO,sBAAsB;YAAK;QAAE;QACvHE,WAAWlC,SAASF,IAAI;QACxBqC,cAAcnC,SAASI,SAAS;OAC7BM;IAEL0B,KAAK;QACH;YAAEC,MAAM;YAA+BC,QAAQ;YAAOC,aAAa;YAAgBC,SAAS;YAAiBC,MAAM;YAAMC,SAAS;YAAWzB,aAAa;YAAkG0B,YAAY;gBAAC;oBAAEpB,MAAM;oBAAUN,aAAa;gBAAW;aAAE;QAAC;QACtT;YAAEoB,MAAM;YAA2CC,QAAQ;YAAOC,aAAa;YAAcC,SAAS;YAAsBE,SAAS;YAAWC,YAAY;gBAAC;oBAAEpB,MAAM;oBAAUN,aAAa;gBAAW;gBAAG;oBAAEM,MAAM;oBAAaN,aAAa;gBAAc;aAAE;QAAC;KAC9P;AACH,EAAC;AAED,OAAO,MAAM2B,4BAAsD;IACjE5B,KAAK;IACLC,aAAa;IACbC,YAAY;IACZC,UAAU;QAAC;QAAM;QAAU;QAAU;KAAS;IAC9C0B,UAAU;QAAC;QAAU;QAAW;KAAiB;IACjDC,WAAW;QACTpB,QAAQ;YAAED,MAAM;YAAUsB,MAAM;gBAAC;gBAAa;aAAY;YAAE9B,aAAa;QAAmC;QAC5G+B,SAASpC,IAAI;QACbqC,gBAAgBrC,IAAI;IACtB;IACAsC,eAAe;QAAC;KAAS;IACzB9B,QAAQ;QACNC,IAAIT,IAAI;QACRU,QAAQpB,aAAa;QACrBiD,QAAQrD,IAAI;QACZ4B,QAAQd,IAAI;QACZwC,SAASxC,IAAI;QACbyC,UAAUzC,IAAI;QACd0C,eAAetD,SAASY,IAAI;QAC5B2C,cAAcvD,SAASY,IAAI;QAC3B4C,WAAW;YAAE/B,MAAM;YAASR,aAAa;YAAoBc,OAAO;gBAAEN,MAAM;gBAAUO,sBAAsB;YAAK;QAAE;QACnHyB,QAAQrD,SAAS;QACjBsD,eAAe5D,IAAI;QACnB6D,UAAU/D,KAAK;QACfgE,iBAAiBtD;QACjBuD,YAAY7D,SAASY,IAAI;QACzBkD,cAAc;YAAErC,MAAM;YAASR,aAAa;YAA6Bc,OAAO;gBAAEN,MAAM;gBAAUO,sBAAsB;YAAK;QAAE;QAC/H+B,SAASrD,OAAOqD,OAAO;IACzB;IACA3B,KAAK;QACH;YAAEC,MAAM;YAA6BC,QAAQ;YAAOC,aAAa;YAAcC,SAAS;YAAeC,MAAM;YAAMC,SAAS;YAASsB,SAAS;gBAACxD,EAAE,WAAW;gBAA4GA,EAAE,UAAU;aAAiB;YAAEmC,YAAY;gBAAC;oBAAEpB,MAAM;oBAAUN,aAAa;gBAAW;aAAE;QAAC;QACjW;YAAEoB,MAAM;YAAuCC,QAAQ;YAAOC,aAAa;YAAYC,SAAS;YAAqBE,SAAS;YAASC,YAAY;gBAAC;oBAAEpB,MAAM;oBAAUN,aAAa;gBAAW;gBAAG;oBAAEM,MAAM;oBAAWN,aAAa;gBAAY;aAAE;QAAC;QAChP;YAAEoB,MAAM;YAAuCC,QAAQ;YAASC,aAAa;YAAeC,SAAS;YAA0ByB,SAAS;YAAcvB,SAAS;YAASzB,aAAa;YAAoH0B,YAAY;gBAAC;oBAAEpB,MAAM;oBAAUN,aAAa;gBAAW;gBAAG;oBAAEM,MAAM;oBAAWN,aAAa;gBAAY;aAAE;QAAC;KACnZ;AACH,EAAC"}

package/src/lib/server/api-v1/orders-and-products.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { type ApiV1Context } from '@aglyn/tenant-data-admin/server/api-v1-kit';
+export declare function handleOrders(request: Request, ctx: ApiV1Context, segments: string[], url: URL): Promise<Response>;
+export declare function handleProducts(request: Request, ctx: ApiV1Context, segments: string[], url: URL): Promise<Response>;