@sixtyninecommerce/client 0.30.0 → 0.32.0

package/dist/commerce/parcel-pricing.js

@@ -0,0 +1,39 @@
+function isCount(value, min) {
+    return typeof value === 'number' && Number.isInteger(value) && value >= min;
+}
+/**
+ * The parcel pricing of a shipping quote, or `null` when the method does not
+ * price per parcel.
+ *
+ * Every key is optional on the wire: the engine adds them only when the method
+ * has an extra parcel price, and an engine older than the feature never adds
+ * them. A missing or malformed count yields `null` rather than a guess; a
+ * missing `parcelCountExact` reads as exact.
+ *
+ * Show counts, not `extraParcels × extraParcelPrice` as money: that product is
+ * in the method's own tax basis before tax resolution, so it is not what the
+ * extras add to the `price` or `priceWithTax` beside it.
+ *
+ * @example
+ * const parcels = readParcelPricing(method.metadata);
+ * if (parcels && parcels.extraParcels > 0) {
+ *   label = `${parcels.parcelCount} parcels (${parcels.extraParcels} extra)`;
+ * }
+ */
+export function readParcelPricing(metadata) {
+    if (!metadata || typeof metadata !== 'object')
+        return null;
+    const { parcelCount, extraParcels, extraParcelPrice, parcelCountExact } = metadata;
+    if (!isCount(parcelCount, 1) || !isCount(extraParcels, 0) || !isCount(extraParcelPrice, 0)) {
+        return null;
+    }
+    if (extraParcels >= parcelCount)
+        return null;
+    return {
+        parcelCount,
+        extraParcels,
+        extraParcelPrice,
+        parcelCountExact: parcelCountExact !== false,
+    };
+}
+//# sourceMappingURL=parcel-pricing.js.map

package/dist/commerce/parcel-pricing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parcel-pricing.js","sourceRoot":"","sources":["../../src/commerce/parcel-pricing.ts"],"names":[],"mappings":"AA8BA,SAAS,OAAO,CAAC,KAAc,EAAE,GAAW;IAC1C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,GAAG,CAAC;AAC9E,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,iBAAiB,CAAC,QAAiB;IACjD,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC;IAC3D,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,QAGzE,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC,EAAE,CAAC;QAC3F,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,YAAY,IAAI,WAAW;QAAE,OAAO,IAAI,CAAC;IAC7C,OAAO;QACL,WAAW;QACX,YAAY;QACZ,gBAAgB;QAChB,gBAAgB,EAAE,gBAAgB,KAAK,KAAK;KAC7C,CAAC;AACJ,CAAC"}

package/dist/commerce/parked-orders.d.ts

@@ -0,0 +1,22 @@
+import type { HttpClient } from '../core/http.js';
+import type * as Shop from '../generated/shop.js';
+import type { RequestOptions } from '../types.js';
+/**
+ * Orders the store is HOLDING for the signed-in shopper.
+ *
+ * A held ("parked") order is one the merchant kept while the rest of its money
+ * is arranged — a deposit taken in store, an invoice still to be paid. It is
+ * deliberately NOT the shopper's active order: `getActiveOrder` returns a fresh
+ * cart while one is held, so the hold never blocks them from shopping, and it
+ * is the reason a storefront has to ask for these separately.
+ */
+export declare function createParkedOrderMethods(http: HttpClient): {
+    getParkedOrders(options?: RequestOptions): Promise<Shop.ParkedOrderFragment[]>;
+    payParkedOrder(orderCode: string, input: Shop.PayParkedOrderInput, options?: RequestOptions & {
+        idempotencyKey?: string;
+    }): Promise<Shop.PayParkedOrderMutation["payParkedOrder"]>;
+    createParkedOrderPaymentIntent(orderCode: string, input: Shop.ParkedOrderPaymentIntentInput, options?: RequestOptions & {
+        idempotencyKey?: string;
+    }): Promise<Shop.CreateParkedOrderPaymentIntentMutation["createParkedOrderPaymentIntent"]>;
+};
+//# sourceMappingURL=parked-orders.d.ts.map

package/dist/commerce/parked-orders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parked-orders.d.ts","sourceRoot":"","sources":["../../src/commerce/parked-orders.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,KAAK,IAAI,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAOlD;;;;;;;;GAQG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,UAAU;8BAErB,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;8BAUvE,MAAM,SACV,IAAI,CAAC,mBAAmB,YACrB,cAAc,GAAG;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,GACrD,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;8CAqB5C,MAAM,SACV,IAAI,CAAC,6BAA6B,YAC/B,cAAc,GAAG;QAAE,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,GACrD,OAAO,CAAC,IAAI,CAAC,sCAAsC,CAAC,gCAAgC,CAAC,CAAC;EAkB5F"}

package/dist/commerce/parked-orders.js

@@ -0,0 +1,47 @@
+import { CREATE_PARKED_ORDER_PAYMENT_INTENT_MUTATION, PARKED_ORDERS_QUERY, PAY_PARKED_ORDER_MUTATION, } from './queries.js';
+/**
+ * Orders the store is HOLDING for the signed-in shopper.
+ *
+ * A held ("parked") order is one the merchant kept while the rest of its money
+ * is arranged — a deposit taken in store, an invoice still to be paid. It is
+ * deliberately NOT the shopper's active order: `getActiveOrder` returns a fresh
+ * cart while one is held, so the hold never blocks them from shopping, and it
+ * is the reason a storefront has to ask for these separately.
+ */
+export function createParkedOrderMethods(http) {
+    return {
+        async getParkedOrders(options) {
+            const data = await http.graphql(PARKED_ORDERS_QUERY, undefined, options);
+            return data.parkedOrders ?? [];
+        },
+        async payParkedOrder(orderCode, input, options) {
+            const data = await http.graphql(PAY_PARKED_ORDER_MUTATION, {
+                orderCode,
+                input: {
+                    method: input.method,
+                    // `undefined`, never an explicit null: omitting the amount is how a
+                    // caller says "the whole outstanding balance", and an explicit null
+                    // is a value a future server could read as something else.
+                    amount: input.amount,
+                    metadata: input.metadata,
+                },
+                idempotencyKey: options?.idempotencyKey,
+            }, options);
+            return data.payParkedOrder;
+        },
+        async createParkedOrderPaymentIntent(orderCode, input, options) {
+            const data = await http.graphql(CREATE_PARKED_ORDER_PAYMENT_INTENT_MUTATION, {
+                orderCode,
+                input: {
+                    method: input.method,
+                    redirectUrl: input.redirectUrl,
+                    // `undefined`, never null — omitted means the whole balance.
+                    amount: input.amount,
+                },
+                idempotencyKey: options?.idempotencyKey,
+            }, options);
+            return data.createParkedOrderPaymentIntent;
+        },
+    };
+}
+//# sourceMappingURL=parked-orders.js.map

package/dist/commerce/parked-orders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parked-orders.js","sourceRoot":"","sources":["../../src/commerce/parked-orders.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,2CAA2C,EAC3C,mBAAmB,EACnB,yBAAyB,GAC1B,MAAM,cAAc,CAAC;AAEtB;;;;;;;;GAQG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAgB;IACvD,OAAO;QACL,KAAK,CAAC,eAAe,CAAC,OAAwB;YAC5C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,mBAAmB,EACnB,SAAS,EACT,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC;QACjC,CAAC;QAED,KAAK,CAAC,cAAc,CAClB,SAAiB,EACjB,KAA+B,EAC/B,OAAsD;YAEtD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,yBAAyB,EACzB;gBACE,SAAS;gBACT,KAAK,EAAE;oBACL,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,oEAAoE;oBACpE,oEAAoE;oBACpE,2DAA2D;oBAC3D,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,QAAQ,EAAE,KAAK,CAAC,QAAQ;iBACzB;gBACD,cAAc,EAAE,OAAO,EAAE,cAAc;aACxC,EACD,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,cAAc,CAAC;QAC7B,CAAC;QAED,KAAK,CAAC,8BAA8B,CAClC,SAAiB,EACjB,KAAyC,EACzC,OAAsD;YAEtD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,2CAA2C,EAC3C;gBACE,SAAS;gBACT,KAAK,EAAE;oBACL,MAAM,EAAE,KAAK,CAAC,MAAM;oBACpB,WAAW,EAAE,KAAK,CAAC,WAAW;oBAC9B,6DAA6D;oBAC7D,MAAM,EAAE,KAAK,CAAC,MAAM;iBACrB;gBACD,cAAc,EAAE,OAAO,EAAE,cAAc;aACxC,EACD,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,8BAA8B,CAAC;QAC7C,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/commerce/payments.d.ts

@@ -1,10 +1,17 @@
 import type { HttpClient } from '../core/http.js';
-import type { CreateMolliePaymentIntentInput, MollieOrderStatusResult, MolliePaymentIntentResult, MolliePaymentMethod, MolliePaymentMethodsInput, OrderedMollieMethod, RequestOptions, StripePaymentIntentResult } from '../types.js';
+import type * as Shop from '../generated/shop.js';
+import type { MolliePaymentIntentResult, RequestOptions, StripePaymentIntentResult } from '../types.js';
 export declare function createPaymentMethods(http: HttpClient): {
+    /**
+     * See {@link CommerceModule.getActivePaymentMethods}. The Shop API types
+     * the items as nullable; a `null` item carries nothing to show and is
+     * dropped.
+     */
+    getActivePaymentMethods(options?: RequestOptions): Promise<Shop.PublicPaymentMethodFragment[]>;
     createStripePaymentIntent(options?: RequestOptions): Promise<StripePaymentIntentResult>;
-    getMolliePaymentMethods(input: MolliePaymentMethodsInput, options?: RequestOptions): Promise<MolliePaymentMethod[]>;
-    getOrderedMolliePaymentMethods(paymentMethodCode: string, options?: RequestOptions): Promise<OrderedMollieMethod[]>;
-    createMolliePaymentIntent(input: CreateMolliePaymentIntentInput, options?: RequestOptions): Promise<MolliePaymentIntentResult>;
-    syncMolliePaymentStatus(orderCode: string, options?: RequestOptions): Promise<MollieOrderStatusResult | null>;
+    getMolliePaymentMethods(input: Shop.MolliePaymentMethodsInput, options?: RequestOptions): Promise<Shop.MolliePaymentMethodsQuery["molliePaymentMethods"]>;
+    getOrderedMolliePaymentMethods(paymentMethodCode: string, options?: RequestOptions): Promise<Shop.OrderedMolliePaymentMethodsQuery["orderedMolliePaymentMethods"]>;
+    createMolliePaymentIntent(input: Shop.MolliePaymentIntentInput, options?: RequestOptions): Promise<MolliePaymentIntentResult>;
+    syncMolliePaymentStatus(orderCode: string, options?: RequestOptions): Promise<Shop.SyncMolliePaymentStatusMutation["syncMolliePaymentStatus"]>;
 };
 //# sourceMappingURL=payments.d.ts.map

package/dist/commerce/payments.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../src/commerce/payments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EACV,8BAA8B,EAC9B,uBAAuB,EACvB,yBAAyB,EACzB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,cAAc,EACd,yBAAyB,EAC1B,MAAM,aAAa,CAAC;AASrB,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU;wCAEP,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;mCAiBpF,yBAAyB,YACtB,cAAc,GACvB,OAAO,CAAC,mBAAmB,EAAE,CAAC;sDAUZ,MAAM,YACf,cAAc,GACvB,OAAO,CAAC,mBAAmB,EAAE,CAAC;qCAUxB,8BAA8B,YAC3B,cAAc,GACvB,OAAO,CAAC,yBAAyB,CAAC;uCAexB,MAAM,YACP,cAAc,GACvB,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC;EAO7C"}
+{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["../../src/commerce/payments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,KAAK,IAAI,MAAM,sBAAsB,CAAC;AAClD,OAAO,KAAK,EACV,yBAAyB,EACzB,cAAc,EACd,yBAAyB,EAC1B,MAAM,aAAa,CAAC;AAUrB,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU;IAEjD;;;;OAIG;sCAES,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,2BAA2B,EAAE,CAAC;wCAWJ,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;mCAiBpF,IAAI,CAAC,yBAAyB,YAC3B,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,sBAAsB,CAAC,CAAC;sDAU7C,MAAM,YACf,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,gCAAgC,CAAC,6BAA6B,CAAC,CAAC;qCAUvE,IAAI,CAAC,wBAAwB,YAC1B,cAAc,GACvB,OAAO,CAAC,yBAAyB,CAAC;uCAiBxB,MAAM,YACP,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC,+BAA+B,CAAC,yBAAyB,CAAC,CAAC;EAS9E"}

package/dist/commerce/payments.js

@@ -1,7 +1,16 @@
 import { MutationError } from '../errors.js';
-import { CREATE_MOLLIE_PAYMENT_INTENT, CREATE_STRIPE_PAYMENT_INTENT, MOLLIE_PAYMENT_METHODS, ORDERED_MOLLIE_PAYMENT_METHODS, SYNC_MOLLIE_PAYMENT_STATUS, } from './queries.js';
+import { ACTIVE_PAYMENT_METHODS, CREATE_MOLLIE_PAYMENT_INTENT, CREATE_STRIPE_PAYMENT_INTENT, MOLLIE_PAYMENT_METHODS, ORDERED_MOLLIE_PAYMENT_METHODS, SYNC_MOLLIE_PAYMENT_STATUS, } from './queries.js';
 export function createPaymentMethods(http) {
     return {
+        /**
+         * See {@link CommerceModule.getActivePaymentMethods}. The Shop API types
+         * the items as nullable; a `null` item carries nothing to show and is
+         * dropped.
+         */
+        async getActivePaymentMethods(options) {
+            const data = await http.graphql(ACTIVE_PAYMENT_METHODS, undefined, options);
+            return data.activePaymentMethods.filter((method) => method !== null);
+        },
         async createStripePaymentIntent(options) {
             const data = await http.graphql(CREATE_STRIPE_PAYMENT_INTENT, undefined, options);
             const clientSecret = data.createStripePaymentIntent;

package/dist/commerce/payments.js.map

@@ -1 +1 @@
-{"version":3,"file":"payments.js","sourceRoot":"","sources":["../../src/commerce/payments.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAW7C,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,sBAAsB,EACtB,8BAA8B,EAC9B,0BAA0B,GAC3B,MAAM,cAAc,CAAC;AAEtB,MAAM,UAAU,oBAAoB,CAAC,IAAgB;IACnD,OAAO;QACL,KAAK,CAAC,yBAAyB,CAAC,OAAwB;YACtD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,4BAA4B,EAC5B,SAAS,EACT,OAAO,CACR,CAAC;YACF,MAAM,YAAY,GAAG,IAAI,CAAC,yBAAyB,CAAC;YACpD,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClE,MAAM,IAAI,aAAa,CACrB,8BAA8B,EAC9B,4IAA4I,CAC7I,CAAC;YACJ,CAAC;YACD,OAAO,EAAE,YAAY,EAAE,CAAC;QAC1B,CAAC;QAED,KAAK,CAAC,uBAAuB,CAC3B,KAAgC,EAChC,OAAwB;YAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,sBAAsB,EACtB,EAAE,KAAK,EAAE,EACT,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,oBAAoB,CAAC;QACnC,CAAC;QAED,KAAK,CAAC,8BAA8B,CAClC,iBAAyB,EACzB,OAAwB;YAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,8BAA8B,EAC9B,EAAE,iBAAiB,EAAE,EACrB,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,2BAA2B,CAAC;QAC1C,CAAC;QAED,KAAK,CAAC,yBAAyB,CAC7B,KAAqC,EACrC,OAAwB;YAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAE5B,4BAA4B,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,CAAC,CAAC;YACrD,MAAM,MAAM,GAAG,IAAI,CAAC,yBAAyB,CAAC;YAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,aAAa,CAAC,eAAe,EAAE,0CAA0C,CAAC,CAAC;YACvF,CAAC;YACD,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;gBAC1B,MAAM,IAAI,aAAa,CAAC,MAAM,CAAC,SAAmB,EAAE,MAAM,CAAC,OAAiB,EAAE,MAAM,CAAC,CAAC;YACxF,CAAC;YACD,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,GAAa,EAAE,CAAC;QACvC,CAAC;QAED,KAAK,CAAC,uBAAuB,CAC3B,SAAiB,EACjB,OAAwB;YAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAE5B,0BAA0B,EAAE,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;YACvD,OAAO,IAAI,CAAC,uBAAuB,CAAC;QACtC,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"payments.js","sourceRoot":"","sources":["../../src/commerce/payments.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAO7C,OAAO,EACL,sBAAsB,EACtB,4BAA4B,EAC5B,4BAA4B,EAC5B,sBAAsB,EACtB,8BAA8B,EAC9B,0BAA0B,GAC3B,MAAM,cAAc,CAAC;AAEtB,MAAM,UAAU,oBAAoB,CAAC,IAAgB;IACnD,OAAO;QACL;;;;WAIG;QACH,KAAK,CAAC,uBAAuB,CAC3B,OAAwB;YAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,sBAAsB,EACtB,SAAS,EACT,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,oBAAoB,CAAC,MAAM,CACrC,CAAC,MAAM,EAA8C,EAAE,CAAC,MAAM,KAAK,IAAI,CACxE,CAAC;QACJ,CAAC;QAED,KAAK,CAAC,yBAAyB,CAAC,OAAwB;YACtD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,4BAA4B,EAC5B,SAAS,EACT,OAAO,CACR,CAAC;YACF,MAAM,YAAY,GAAG,IAAI,CAAC,yBAAyB,CAAC;YACpD,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClE,MAAM,IAAI,aAAa,CACrB,8BAA8B,EAC9B,4IAA4I,CAC7I,CAAC;YACJ,CAAC;YACD,OAAO,EAAE,YAAY,EAAE,CAAC;QAC1B,CAAC;QAED,KAAK,CAAC,uBAAuB,CAC3B,KAAqC,EACrC,OAAwB;YAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,sBAAsB,EACtB,EAAE,KAAK,EAAE,EACT,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,oBAAoB,CAAC;QACnC,CAAC;QAED,KAAK,CAAC,8BAA8B,CAClC,iBAAyB,EACzB,OAAwB;YAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,8BAA8B,EAC9B,EAAE,iBAAiB,EAAE,EACrB,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,2BAA2B,CAAC;QAC1C,CAAC;QAED,KAAK,CAAC,yBAAyB,CAC7B,KAAoC,EACpC,OAAwB;YAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,4BAA4B,EAC5B,EAAE,KAAK,EAAE,EACT,OAAO,CACR,CAAC;YACF,MAAM,MAAM,GAAG,IAAI,CAAC,yBAAyB,CAAC;YAC9C,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,aAAa,CAAC,eAAe,EAAE,0CAA0C,CAAC,CAAC;YACvF,CAAC;YACD,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;gBAC1B,MAAM,IAAI,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YACpE,CAAC;YACD,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC;QAC7B,CAAC;QAED,KAAK,CAAC,uBAAuB,CAC3B,SAAiB,EACjB,OAAwB;YAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAC7B,0BAA0B,EAC1B,EAAE,SAAS,EAAE,EACb,OAAO,CACR,CAAC;YACF,OAAO,IAAI,CAAC,uBAAuB,CAAC;QACtC,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/commerce/placement-error.d.ts

@@ -19,6 +19,23 @@
  */
 import { MutationError } from '../errors.js';
 import type { PlacementRejection, PlacementRejectionLine } from '../types.js';
+/**
+ * What a Shop API result union field resolves to once its ErrorResult members —
+ * every member that selects `errorCode` — are thrown by {@link toMutationError}
+ * and a missing result is refused: the success member(s) of the generated type,
+ * e.g. `OrderFragment` out of `AddToCartMutation['addItemToOrder']`.
+ *
+ * Also left out: `Record<PropertyKey, never>`, which codegen emits for a union
+ * member the document does not select. Such a member arrives as `{}`, carries
+ * no `errorCode`, and so is returned as if it were the success value — which is
+ * why a document must select every member of its union. The four cart documents
+ * that do not select `OrderInterceptorError` (`AddToCart`, `AdjustOrderLine`,
+ * `RemoveOrderLine`, `RemoveAllOrderLines`) are a recorded finding; the engine
+ * registers no order interceptor today, so no `{}` reaches a storefront yet.
+ */
+export type ResultData<T> = Exclude<NonNullable<T>, {
+    errorCode: unknown;
+} | Record<PropertyKey, never>>;
 /**
  * The `placement` payload, when the document selected it AND the engine filled
  * it in. Null/absent is the normal case for a core state-machine error, for a

package/dist/commerce/placement-error.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"placement-error.d.ts","sourceRoot":"","sources":["../../src/commerce/placement-error.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,KAAK,EACV,kBAAkB,EAElB,sBAAsB,EACvB,MAAM,aAAa,CAAC;AAsErB;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,kBAAkB,GAAG,SAAS,CAiB7F;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,sBAAsB,GAAG,SAAS,CAEpC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAU,EACxC,aAAa,CAAC,EAAE,sBAAsB,EAAE,GACvC,aAAa,CA+Bf"}
+{"version":3,"file":"placement-error.d.ts","sourceRoot":"","sources":["../../src/commerce/placement-error.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,KAAK,EACV,kBAAkB,EAElB,sBAAsB,EACvB,MAAM,aAAa,CAAC;AA0BrB;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,OAAO,CACjC,WAAW,CAAC,CAAC,CAAC,EACd;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,GAAG,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,CACpD,CAAC;AA+CF;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,kBAAkB,GAAG,SAAS,CAiB7F;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,sBAAsB,GAAG,SAAS,CAEpC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAU,EACxC,aAAa,CAAC,EAAE,sBAAsB,EAAE,GACvC,aAAa,CA+Bf"}

package/dist/commerce/placement-error.js.map

@@ -1 +1 @@
-{"version":3,"file":"placement-error.js","sourceRoot":"","sources":["../../src/commerce/placement-error.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAO7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,aAAa,GAAG,CAAC,iBAAiB,EAAE,kBAAkB,CAAU,CAAC;AAEvE,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAClF,CAAC;AAED,gGAAgG;AAChG,SAAS,MAAM,CAAC,KAAc;IAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAChE,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,OAAO,CAAC,KAAc;IAC7B,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,SAAS,QAAQ,CAAC,GAA4B;IAC5C,MAAM,gBAAgB,GAAG,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACtD,IAAI,CAAC,gBAAgB;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO;QACL,gBAAgB;QAChB,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC;QACpC,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;QACtB,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC;QACtC,kBAAkB,EAAE,QAAQ,CAAC,GAAG,CAAC,kBAAkB,CAAC;QACpD,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;QACjD,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;KAClD,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,GAAc;IAC/B,MAAM,KAAK,GAA6B,EAAE,CAAC;IAC3C,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,SAAS;QAClD,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAgC,CAAC,CAAC;QACxD,IAAI,IAAI;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,MAA+B;IAC3D,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC;IAC7B,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IACtD,MAAM,OAAO,GAAG,GAA8B,CAAC;IAC/C,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,MAAM,SAAS,GAAuB;QACpC,GAAI,OAAyC;QAC7C,IAAI;QACJ,0EAA0E;QAC1E,cAAc,EAAE,OAAO,CAAC,cAAc,KAAK,IAAI;KAChD,CAAC;IACF,wEAAwE;IACxE,wEAAwE;IACxE,mDAAmD;IACnD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7E,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAA+B;IAE/B,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,eAAe,CAC7B,MAA+B,EAC/B,SAAkC,MAAM,EACxC,aAAwC;IAExC,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,eAAe,CAAC;IAChE,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IAExC,MAAM,SAAS,GACb,SAAS,KAAK,0BAA0B,CAAC,CAAC,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvF,MAAM,cAAc,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9E,MAAM,KAAK,GAAG,aAAa,EAAE,MAAM;QACjC,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAE9D,yEAAyE;IACzE,0EAA0E;IAC1E,4CAA4C;IAC5C,MAAM,IAAI,GACR,SAAS,EAAE,IAAI;QACf,CAAC,SAAS,KAAK,0BAA0B;YACvC,CAAC,CAAE,oBAAsD;YACzD,CAAC,CAAC,SAAS,CAAC,CAAC;IAEjB,IAAI,MAA0B,CAAC;IAC/B,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;QAClC,MAAM,KAAK,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACrC,CAAC;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,IAAI,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAE3F,OAAO,IAAI,aAAa,CAAC,SAAS,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,EAAE;QAChE,IAAI;QACJ,SAAS;QACT,KAAK;KACN,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"placement-error.js","sourceRoot":"","sources":["../../src/commerce/placement-error.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAO7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,aAAa,GAAG,CAAC,iBAAiB,EAAE,kBAAkB,CAAU,CAAC;AAsBvE,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAClF,CAAC;AAED,gGAAgG;AAChG,SAAS,MAAM,CAAC,KAAc;IAC5B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAChE,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACpD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,OAAO,CAAC,KAAc;IAC7B,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AACvD,CAAC;AAED;;;;;GAKG;AACH,SAAS,QAAQ,CAAC,GAA4B;IAC5C,MAAM,gBAAgB,GAAG,MAAM,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IACtD,IAAI,CAAC,gBAAgB;QAAE,OAAO,SAAS,CAAC;IACxC,OAAO;QACL,gBAAgB;QAChB,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC;QACpC,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;QACtB,WAAW,EAAE,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC;QACtC,kBAAkB,EAAE,QAAQ,CAAC,GAAG,CAAC,kBAAkB,CAAC;QACpD,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;QACjD,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;KAClD,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,GAAc;IAC/B,MAAM,KAAK,GAA6B,EAAE,CAAC;IAC3C,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,SAAS;QAClD,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAgC,CAAC,CAAC;QACxD,IAAI,IAAI;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,aAAa,CAAC,MAA+B;IAC3D,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC;IAC7B,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IACtD,MAAM,OAAO,GAAG,GAA8B,CAAC;IAC/C,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,MAAM,SAAS,GAAuB;QACpC,GAAI,OAAyC;QAC7C,IAAI;QACJ,0EAA0E;QAC1E,cAAc,EAAE,OAAO,CAAC,cAAc,KAAK,IAAI;KAChD,CAAC;IACF,wEAAwE;IACxE,wEAAwE;IACxE,mDAAmD;IACnD,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7E,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAA+B;IAE/B,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,eAAe,CAC7B,MAA+B,EAC/B,SAAkC,MAAM,EACxC,aAAwC;IAExC,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,eAAe,CAAC;IAChE,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IAExC,MAAM,SAAS,GACb,SAAS,KAAK,0BAA0B,CAAC,CAAC,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvF,MAAM,cAAc,GAAG,SAAS,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAC9E,MAAM,KAAK,GAAG,aAAa,EAAE,MAAM;QACjC,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAE9D,yEAAyE;IACzE,0EAA0E;IAC1E,4CAA4C;IAC5C,MAAM,IAAI,GACR,SAAS,EAAE,IAAI;QACf,CAAC,SAAS,KAAK,0BAA0B;YACvC,CAAC,CAAE,oBAAsD;YACzD,CAAC,CAAC,SAAS,CAAC,CAAC;IAEjB,IAAI,MAA0B,CAAC;IAC/B,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;QAClC,MAAM,KAAK,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACrC,CAAC;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,IAAI,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAE3F,OAAO,IAAI,aAAa,CAAC,SAAS,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,EAAE;QAChE,IAAI;QACJ,SAAS;QACT,KAAK;KACN,CAAC,CAAC;AACL,CAAC"}

package/dist/commerce/products.d.ts

@@ -1,5 +1,36 @@
 import { type HttpClient } from '../core/http.js';
-import type { Collection, CollectionDetail, CollectionListOptions, CollectionProductListOptions, CollectionProductSummary, Facet, PaginatedList, Product, ProductListOptions, ProductPropertyGroupValues, ProductPropertyRecord, ProductSummary, PropertyGroup, RequestOptions } from '../types.js';
+import type { CollectionDetailFragment, CollectionFragment, FacetFragment, GetCollectionWithMetafieldsQuery, GetProductWithMetafieldsQuery, ProductCardFragment, ProductPropertyGroupValuesFragment, ProductSummaryFragment, ProductVariantFragment, PropertyGroupFragment } from '../generated/shop.js';
+import type { ProductMetadata } from '../seo/metadata-types.js';
+import type { CollectionListOptions, CollectionProductListOptions, CollectionProductSummary, PaginatedList, Product, ProductListOptions, ProductListPage, ProductPropertyRecord, RequestOptions } from '../types.js';
+/**
+ * Ask a detail read for the entity's storefront-visible metafields (the
+ * `storefront: read` values an app or the store published, headless spec
+ * §8.13): `true` for every namespace, `{ namespace }` for one app's.
+ * Omitted or `false`: the read is unchanged and carries no `metafields`.
+ *
+ * Needs an engine that serves `metafields` on the entity (vendure-server with
+ * W8-14); against an older one only a read that ASKS for them fails, with the
+ * engine's validation error, and every other read keeps working.
+ */
+export type MetafieldsOption = boolean | {
+    namespace: string;
+};
+/** {@link RequestOptions} plus the opt-in {@link MetafieldsOption}. */
+export interface CatalogDetailOptions extends RequestOptions {
+    metafields?: MetafieldsOption;
+}
+/** One variant of a {@link ProductWithMetafields}: the usual variant plus its own metafields. */
+export type ProductVariantWithMetafields = ProductVariantFragment & Pick<NonNullable<GetProductWithMetafieldsQuery['product']>['variants'][number], 'metafields'>;
+/**
+ * A product read with `{ metafields }`: {@link Product} plus the product's
+ * own metafields and each variant's.
+ */
+export type ProductWithMetafields = Omit<NonNullable<GetProductWithMetafieldsQuery['product']>, 'metadata' | 'variants'> & {
+    metadata: ProductMetadata | null;
+    variants: ProductVariantWithMetafields[];
+};
+/** A collection read with `{ metafields }`: the collection detail plus its own metafields. */
+export type CollectionWithMetafields = NonNullable<GetCollectionWithMetafieldsQuery['collection']>;
 /**
  * Flatten `getProductProperties(...)` output into a `slug → value` record for
  * the product-detail view. Walks every group's `properties` to recover each
@@ -11,38 +42,41 @@ import type { Collection, CollectionDetail, CollectionListOptions, CollectionPro
  * `producer_winehouse`) map to a CMS item id string, not a name; resolve it
  * against the CMS before display (see `ProductPropertyRecord`).
  */
-export declare function mapProductProperties(groups: ProductPropertyGroupValues[]): ProductPropertyRecord;
+export declare function mapProductProperties(groups: ProductPropertyGroupValuesFragment[]): ProductPropertyRecord;
 export declare function createProductMethods(http: HttpClient): {
-    getProduct(slug: string, options?: RequestOptions): Promise<Product>;
-    getProductById(id: string, options?: RequestOptions): Promise<Product>;
-    /**
-     * List products for the active channel via the `products` list query.
-     * Defaults to `filter: { enabled: { eq: true } }` (and the Shop API forces
-     * the same server-side), so `totalItems` matches the browsable catalogue.
-     *
-     * Cannot sort by price — Vendure's `ProductSortParameter` has no price
-     * field. Price-sorted listings go through `getProductsInCollection` or
-     * `searchProducts`.
-     *
-     * The deprecated `{ collectionSlug }` option reroutes to the search
-     * backend with its flatter row shape — call `getProductsInCollection`
-     * instead, which returns that shape honestly typed. That branch returns
-     * before the document switch, so `detail` has no effect on it.
-     *
-     * Pass `{ detail: 'card' }` for listing pages: it swaps in a grid-tile
-     * selection that drops the per-VARIANT stock reads a tile never shows
-     * (`availabilityByLocation`, `stockOnHand`/`stockAllocated`, and the
-     * incoming-stock trio) plus the product `description`, including the
-     * per-language copy inside `translations`. Those variant fields are
-     * per-variant field resolvers server-side, so this cuts backend work and SQL
-     * statements, not only bytes.
-     *
-     * The collection tree, the translated slugs and `priceTiers` are KEPT, so a
-     * card row still drives canonical/hreflang URLs and quantity-break pricing —
-     * see `ProductListOptions.detail` for the full kept/dropped list and why.
-     * The default is unchanged, so existing callers keep the full shape.
-     */
-    getProducts(listOptions?: ProductListOptions, options?: RequestOptions): Promise<PaginatedList<ProductSummary>>;
+    getProduct: {
+        (slug: string, options: CatalogDetailOptions & {
+            metafields: true | {
+                namespace: string;
+            };
+        }): Promise<ProductWithMetafields>;
+        (slug: string, options?: CatalogDetailOptions & {
+            metafields?: false;
+        }): Promise<Product>;
+        (slug: string, options?: CatalogDetailOptions): Promise<Product | ProductWithMetafields>;
+    };
+    getProductById: {
+        (id: string, options: CatalogDetailOptions & {
+            metafields: true | {
+                namespace: string;
+            };
+        }): Promise<ProductWithMetafields>;
+        (id: string, options?: CatalogDetailOptions & {
+            metafields?: false;
+        }): Promise<Product>;
+        (id: string, options?: CatalogDetailOptions): Promise<Product | ProductWithMetafields>;
+    };
+    getProducts: {
+        (listOptions: ProductListOptions & {
+            detail: "card";
+            collectionSlug?: undefined;
+        }, options?: RequestOptions): Promise<PaginatedList<ProductCardFragment>>;
+        (listOptions?: ProductListOptions & {
+            detail?: "full";
+            collectionSlug?: undefined;
+        }, options?: RequestOptions): Promise<PaginatedList<ProductSummaryFragment>>;
+        (listOptions?: ProductListOptions, options?: RequestOptions): Promise<ProductListPage>;
+    };
     /**
      * List the products of one collection, via the search backend — the only
      * Shop API path that filters by collection. Returns the honest search-row
@@ -55,12 +89,32 @@ export declare function createProductMethods(http: HttpClient): {
     getProductsInCollection(collectionSlug: string, listOptions?: CollectionProductListOptions, options?: RequestOptions): Promise<PaginatedList<CollectionProductSummary>>;
     /** `getProductsInCollection` by id, tagged `collection:<id>`. */
     getProductsInCollectionById(collectionId: string, listOptions?: CollectionProductListOptions, options?: RequestOptions): Promise<PaginatedList<CollectionProductSummary>>;
-    getFacets(options?: RequestOptions): Promise<Facet[]>;
-    getCollections(listOptions?: CollectionListOptions, options?: RequestOptions): Promise<Collection[]>;
-    getCollection(slug: string, options?: RequestOptions): Promise<CollectionDetail>;
-    getCollectionById(id: string, options?: RequestOptions): Promise<CollectionDetail>;
-    getPropertyGroups(options?: RequestOptions): Promise<PropertyGroup[]>;
-    getProductProperties(productId: string, options?: RequestOptions): Promise<ProductPropertyGroupValues[]>;
+    getFacets(options?: RequestOptions): Promise<FacetFragment[]>;
+    getCollections(listOptions?: CollectionListOptions, options?: RequestOptions): Promise<CollectionFragment[]>;
+    getCollection: {
+        (slug: string, options: CatalogDetailOptions & {
+            metafields: true | {
+                namespace: string;
+            };
+        }): Promise<CollectionWithMetafields>;
+        (slug: string, options?: CatalogDetailOptions & {
+            metafields?: false;
+        }): Promise<CollectionDetailFragment>;
+        (slug: string, options?: CatalogDetailOptions): Promise<CollectionDetailFragment | CollectionWithMetafields>;
+    };
+    getCollectionById: {
+        (id: string, options: CatalogDetailOptions & {
+            metafields: true | {
+                namespace: string;
+            };
+        }): Promise<CollectionWithMetafields>;
+        (id: string, options?: CatalogDetailOptions & {
+            metafields?: false;
+        }): Promise<CollectionDetailFragment>;
+        (id: string, options?: CatalogDetailOptions): Promise<CollectionDetailFragment | CollectionWithMetafields>;
+    };
+    getPropertyGroups(options?: RequestOptions): Promise<PropertyGroupFragment[]>;
+    getProductProperties(productId: string, options?: RequestOptions): Promise<ProductPropertyGroupValuesFragment[]>;
     mapProductProperties: typeof mapProductProperties;
 };
 //# sourceMappingURL=products.d.ts.map

package/dist/commerce/products.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../src/commerce/products.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAc,MAAM,iBAAiB,CAAC;AAG9D,OAAO,KAAK,EACV,UAAU,EACV,gBAAgB,EAChB,qBAAqB,EACrB,4BAA4B,EAC5B,wBAAwB,EACxB,KAAK,EACL,aAAa,EACb,OAAO,EACP,kBAAkB,EAClB,0BAA0B,EAC1B,qBAAqB,EACrB,cAAc,EACd,aAAa,EACb,cAAc,EAEf,MAAM,aAAa,CAAC;AAoHrB;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,0BAA0B,EAAE,GAAG,qBAAqB,CAUhG;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU;qBAE1B,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;uBAYjD,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAY5E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;8BAEa,kBAAkB,YACtB,cAAc,GACvB,OAAO,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;IAuEzC;;;;;;;;OAQG;4CAEe,MAAM,gBACR,4BAA4B,YAChC,cAAc,GACvB,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC;IAoBnD,iEAAiE;8CAEjD,MAAM,gBACN,4BAA4B,YAChC,cAAc,GACvB,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC;wBAoBzB,cAAc,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;iCAU3C,qBAAqB,YACzB,cAAc,GACvB,OAAO,CAAC,UAAU,EAAE,CAAC;wBAWE,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;0BAY1D,MAAM,YAAY,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;gCAYtD,cAAc,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;oCAU9D,MAAM,YACP,cAAc,GACvB,OAAO,CAAC,0BAA0B,EAAE,CAAC;;EAa3C"}
+{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../src/commerce/products.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAkB,MAAM,iBAAiB,CAAC;AAElE,OAAO,KAAK,EACV,wBAAwB,EACxB,kBAAkB,EAClB,aAAa,EAOb,gCAAgC,EAQhC,6BAA6B,EAO7B,mBAAmB,EAInB,kCAAkC,EAClC,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EAKtB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EACV,qBAAqB,EACrB,4BAA4B,EAC5B,wBAAwB,EACxB,aAAa,EACb,OAAO,EACP,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EACrB,cAAc,EACf,MAAM,aAAa,CAAC;AAqBrB;;;;;;;;;GASG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAAC;AAG/D,uEAAuE;AACvE,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC1D,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B;AAED,iGAAiG;AACjG,MAAM,MAAM,4BAA4B,GAAG,sBAAsB,GAC/D,IAAI,CAAC,WAAW,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC;AAEhG;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CACtC,WAAW,CAAC,6BAA6B,CAAC,SAAS,CAAC,CAAC,EACrD,UAAU,GAAG,UAAU,CACxB,GAAG;IACF,QAAQ,EAAE,eAAe,GAAG,IAAI,CAAC;IACjC,QAAQ,EAAE,4BAA4B,EAAE,CAAC;CAC1C,CAAC;AAEF,8FAA8F;AAC9F,MAAM,MAAM,wBAAwB,GAAG,WAAW,CAAC,gCAAgC,CAAC,YAAY,CAAC,CAAC,CAAC;AAoInG;;;;;;;;;;GAUG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,kCAAkC,EAAE,GAC3C,qBAAqB,CAUvB;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU;;eA+H3C,MAAM,WACH,oBAAoB,GAAG;YAAE,UAAU,EAAE,IAAI,GAAG;gBAAE,SAAS,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,GAC3E,OAAO,CAAC,qBAAqB,CAAC;eAEzB,MAAM,YACF,oBAAoB,GAAG;YAAE,UAAU,CAAC,EAAE,KAAK,CAAA;SAAE,GACtD,OAAO,CAAC,OAAO,CAAC;eAEX,MAAM,YACF,oBAAoB,GAC7B,OAAO,CAAC,OAAO,GAAG,qBAAqB,CAAC;;;aA2BrC,MAAM,WACD,oBAAoB,GAAG;YAAE,UAAU,EAAE,IAAI,GAAG;gBAAE,SAAS,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,GAC3E,OAAO,CAAC,qBAAqB,CAAC;aAE3B,MAAM,YACA,oBAAoB,GAAG;YAAE,UAAU,CAAC,EAAE,KAAK,CAAA;SAAE,GACtD,OAAO,CAAC,OAAO,CAAC;aAEb,MAAM,YACA,oBAAoB,GAC7B,OAAO,CAAC,OAAO,GAAG,qBAAqB,CAAC;;;sBAjJ5B,kBAAkB,GAAG;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,cAAc,CAAC,EAAE,SAAS,CAAA;SAAE,YACtE,cAAc,GACvB,OAAO,CAAC,aAAa,CAAC,mBAAmB,CAAC,CAAC;uBAE9B,kBAAkB,GAAG;YAAE,MAAM,CAAC,EAAE,MAAM,CAAC;YAAC,cAAc,CAAC,EAAE,SAAS,CAAA;SAAE,YACxE,cAAc,GACvB,OAAO,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;uBAEjC,kBAAkB,YACtB,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC;;IAuPzB;;;;;;;;OAQG;4CAEe,MAAM,gBACR,4BAA4B,YAChC,cAAc,GACvB,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC;IAoBnD,iEAAiE;8CAEjD,MAAM,gBACN,4BAA4B,YAChC,cAAc,GACvB,OAAO,CAAC,aAAa,CAAC,wBAAwB,CAAC,CAAC;wBAoBzB,cAAc,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;iCAUnD,qBAAqB,YACzB,cAAc,GACvB,OAAO,CAAC,kBAAkB,EAAE,CAAC;;eAxJ1B,MAAM,WACH,oBAAoB,GAAG;YAAE,UAAU,EAAE,IAAI,GAAG;gBAAE,SAAS,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,GAC3E,OAAO,CAAC,wBAAwB,CAAC;eAE5B,MAAM,YACF,oBAAoB,GAAG;YAAE,UAAU,CAAC,EAAE,KAAK,CAAA;SAAE,GACtD,OAAO,CAAC,wBAAwB,CAAC;eAE5B,MAAM,YACF,oBAAoB,GAC7B,OAAO,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;;;aA8BzD,MAAM,WACD,oBAAoB,GAAG;YAAE,UAAU,EAAE,IAAI,GAAG;gBAAE,SAAS,EAAE,MAAM,CAAA;aAAE,CAAA;SAAE,GAC3E,OAAO,CAAC,wBAAwB,CAAC;aAE9B,MAAM,YACA,oBAAoB,GAAG;YAAE,UAAU,CAAC,EAAE,KAAK,CAAA;SAAE,GACtD,OAAO,CAAC,wBAAwB,CAAC;aAE9B,MAAM,YACA,oBAAoB,GAC7B,OAAO,CAAC,wBAAwB,GAAG,wBAAwB,CAAC;;gCAqH3B,cAAc,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;oCAUtE,MAAM,YACP,cAAc,GACvB,OAAO,CAAC,kCAAkC,EAAE,CAAC;;EAWnD"}