@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/orders/money-view.js

@@ -0,0 +1,99 @@
+/**
+ * `admin.orders.moneyView(orderId, { basis })`: an order's money as rows that add up exactly to
+ * its own totals, in one basis (pricing-display-consistency, USER O12). Every surface that shows
+ * an order's money prints these rows, so an order page, an email and an invoice cannot disagree
+ * by a cent. The engine builds them (`Order.moneyView`); this module only reads them.
+ */
+import { NotFoundError, ValidationError, } from '@sixtyninecommerce/core';
+import { isUnknownFieldRejection } from '../payments/store-credit-fields.js';
+/**
+ * Which prices a view shows. `GROSS` = incl. VAT, `NET` = excl. VAT. `STORE` follows how the
+ * store sets its prices; `CUSTOMER` how the shop shows prices to the order's customer. The view
+ * answers the one it used, `GROSS` or `NET`.
+ */
+export const ORDER_MONEY_BASES = ['STORE', 'CUSTOMER', 'GROSS', 'NET'];
+const ROW_FIELDS = 'key description amount taxRate';
+/** Every field of an `OrderMoneyView`, at every depth: the selection each document reads it with. */
+export const ORDER_MONEY_VIEW_FIELDS = /* GraphQL */ `
+        basis
+        currencyCode
+        lines { orderLineId quantity taxRate unitAmount amount }
+        goodsAdjustments { ${ROW_FIELDS} }
+        surcharges { ${ROW_FIELDS} }
+        subtotal
+        shipping { ${ROW_FIELDS} }
+        shippingAdjustments { ${ROW_FIELDS} }
+        shippingTotal
+        totalExcludingTax
+        taxes { taxRate base amount }
+        taxIncluded
+        taxTotal
+        rounding
+        total
+        totalBeforeRounding
+        balance { paid giftCard storeCredit credited stillToPay stillToPayNote }
+        reconciles
+`;
+export const ORDER_MONEY_VIEW_QUERY = /* GraphQL */ `
+  query OrderMoneyView($id: ID!, $basis: OrderMoneyBasis!) {
+    order(id: $id) {
+      id
+      moneyView(basis: $basis) {${ORDER_MONEY_VIEW_FIELDS}      }
+    }
+  }
+`;
+/** `INVALID_ORDER_MONEY_BASIS` for a basis not in `ORDER_MONEY_BASES`, before anything is sent. */
+export function assertOrderMoneyBasis(basis) {
+    if (!ORDER_MONEY_BASES.includes(basis)) {
+        throw new ValidationError({
+            code: 'INVALID_ORDER_MONEY_BASIS',
+            message: `The basis must be one of ${ORDER_MONEY_BASES.join(', ')}.`,
+            status: 400,
+            service: 'vendure',
+        });
+    }
+}
+const STILL_TO_PAY_NOTE_FIELD = /\bstillToPayNote\b/g;
+/** `document` without `stillToPayNote`: what an engine before it accepts. */
+export function withoutStillToPayNote(document) {
+    return document.replace(STILL_TO_PAY_NOTE_FIELD, '');
+}
+/**
+ * The transport, sending a document that names `balance.stillToPayNote` (pricing-display-consistency
+ * B1c) once more without it when the engine refused it as unknown. Safe for a mutation too: a
+ * refused document never ran. The newest money-view field, so it falls away first: wrap it inside
+ * any other `*Aware` transport.
+ */
+export function stillToPayNoteAware(transport) {
+    return {
+        async graphql(call, options) {
+            try {
+                return await transport.graphql(call, options);
+            }
+            catch (error) {
+                const legacy = withoutStillToPayNote(call.query);
+                if (legacy === call.query || !isUnknownFieldRejection(error))
+                    throw error;
+                return transport.graphql({ ...call, query: legacy }, options);
+            }
+        },
+    };
+}
+export function createOrderMoneyViewModule(transport) {
+    return {
+        async moneyView(orderId, options) {
+            const basis = options?.basis ?? 'STORE';
+            assertOrderMoneyBasis(basis);
+            const data = await stillToPayNoteAware(transport).graphql({ api: 'admin', query: ORDER_MONEY_VIEW_QUERY, variables: { id: orderId, basis } }, options);
+            if (!data.order) {
+                throw new NotFoundError({
+                    code: 'ORDER_NOT_FOUND',
+                    message: `This store has no order ${orderId}.`,
+                    status: 404,
+                    service: 'vendure',
+                });
+            }
+            return data.order.moneyView;
+        },
+    };
+}

package/dist/orders/order-entry.d.ts

@@ -13,19 +13,27 @@ export type ExternalLinePriceBasis = 'net' | 'gross';
 /**
  * What is going to happen to the goods.
  *
- * A fact the vertical STATES about the order rather than an instruction
- * commerce acts on in this release: nothing here creates a fulfilment or picks
- * a shipping method. It is recorded as the order's `platform.fulfilment`
- * metafield so a document, a WMS push or a later fulfilment flow can read back
- * what the caller actually asked for.
+ * Commerce ACTS on it. Nothing here creates a fulfilment or picks a shipping
+ * method, but the value decides whether the order needs a shipping method to be
+ * placed and whether a fulfilment of it owes a delivery charge. It is recorded
+ * as the order's `platform.fulfilment` metafield (only the platform writes it),
+ * so a document, a WMS push or a merchant can also read back what you asked for.
  *
  * - `pickup` — collected at a location. Needs no shipping method and no
- *   address.
+ *   address. Handed over through an ordinary fulfilment, which adds no delivery
+ *   charge and is not held to a fulfilment profile's minimum.
  * - `ship` — shipped. The order still needs a shipping method before it can
  *   leave `Draft`, and `transitionTo: 'ArrangingPayment'` on an order that has
  *   none is refused by the platform's own placement gate, not by this call.
+ *   Delivery charges and profile minimums apply as for any delivered order.
  * - `none` — neither shipped nor collected: a service, a subscription set-up,
- *   a fee.
+ *   a fee. Needs no shipping method, owes no delivery charge and takes no
+ *   profile minimum. The order is marked as having nothing to ship, so it
+ *   completes on its own once it is paid (after the store's completion grace
+ *   period). It may not hold goods that are stock-tracked: such a catalog line
+ *   is refused `LINE_NEEDS_FULFILMENT` here, and so is placing (or modifying)
+ *   the order to carry one later. Send goods as a `pickup` order, a service as
+ *   an external line.
  */
 export type ExternalOrderFulfilment = 'pickup' | 'ship' | 'none';
 /**
@@ -478,6 +486,11 @@ export interface OrderEntryModule {
      * - `LINE_DUPLICATE_VARIANT` — two catalog lines name the same variant.
      *   `details` carries the second one's `position` and the first one's
      *   `firstPosition`. Send one line with the quantity you want.
+     * - `LINE_NEEDS_FULFILMENT` — a catalog line whose variant is stock-tracked on
+     *   an order with `fulfilment: 'none'`. Nothing ships or is handed over on
+     *   such an order, so nothing would ever sell or release that stock.
+     *   `details` carries its `position` and `variantId`. Send the order as
+     *   `pickup` (or `ship`), or the service as an external line.
      * - `EXTERNAL_LINE_PROMOTION_UNSUPPORTED` — a promotion discounted one of your
      *   externally priced lines. An order-level promotion is shared across every
      *   line of an order by the engine, so the platform refuses rather than

package/dist/orders/plan-edit.d.ts

@@ -1,5 +1,6 @@
 import type { Transport } from '@sixtyninecommerce/core';
 import type { Call } from '../types.js';
+import { type OrderMoneyBasis, type OrderMoneyView } from './money-view.js';
 import type { OverpaymentOption } from './surcharges.js';
 /**
  * How a one-time discount is stated. A whole-order discount is `PERCENTAGE` or
@@ -376,6 +377,22 @@ export interface OrderEditPreview {
     taxSummary: OrderEditTaxSummaryLine[];
     /** The order's total with tax before the edit. */
     totalWithTaxBefore: number;
+    /**
+     * The order's money after the edit as the order page prints it once the edit is saved
+     * (`orders.moneyView`'s rows, in `planEdit`'s `moneyBasis`), read inside the preview's run.
+     * Its `balance` is the order's payments before the plan's `refund`. Print these rows, never
+     * the figures above: they are the engine's, before a staff rounding. `null` from an engine
+     * before it; absent from `commitEdit`'s plan (read the saved order's `moneyView`).
+     */
+    moneyView?: OrderMoneyView | null;
+    /** The order's money before the edit, read in the same run, in the same basis. */
+    moneyViewBefore?: OrderMoneyView | null;
+    /**
+     * What the edit changes the billable total by (a staff rounding included):
+     * `moneyView.total - moneyViewBefore.total`, computed by the engine. Print it as the
+     * difference; `totalWithTax - totalWithTaxBefore` ignores the rounding.
+     */
+    totalDifference?: number | null;
 }
 export interface OrderEditPlan {
     orderId: string;
@@ -422,7 +439,12 @@ export interface OrderEditPlan {
  * the order-edit plan, so on an older one this call alone fails validation and
  * no other order call does.
  */
-export declare const PLAN_ORDER_EDIT_QUERY = "\n  query PlanOrderEdit($orderId: ID!, $diff: OrderEditDiffInput!) {\n    planOrderEdit(orderId: $orderId, diff: $diff) {\n      orderId\n      planHash\n      orderVersion\n      steps {\n        kind\n        input\n        moneyEffect\n      }\n      refund {\n        paymentId\n        amount\n      }\n      overpayment {\n        amount\n        currencyCode\n        surchargeIds\n        refund {\n          available\n          code\n          message\n        }\n        accountCredit {\n          available\n          code\n          message\n        }\n        refundWhenChosen {\n          paymentId\n          amount\n        }\n      }\n      returnState\n      blockers {\n        code\n        message\n        details\n      }\n      notices {\n        code\n        message\n        details\n      }\n      payment {\n        collected\n        reason\n        method\n      }\n      preview {\n        currencyCode\n        subTotal\n        subTotalWithTax\n        shipping\n        shippingWithTax\n        surcharges\n        surchargesWithTax\n        total\n        totalWithTax\n        taxSummary {\n          description\n          taxRate\n          taxBase\n          taxTotal\n        }\n        totalWithTaxBefore\n      }\n    }\n  }\n";
+export declare const PLAN_ORDER_EDIT_QUERY = "\n  query PlanOrderEdit($orderId: ID!, $diff: OrderEditDiffInput!, $moneyBasis: OrderMoneyBasis!) {\n    planOrderEdit(orderId: $orderId, diff: $diff) {\n      orderId\n      planHash\n      orderVersion\n      steps {\n        kind\n        input\n        moneyEffect\n      }\n      refund {\n        paymentId\n        amount\n      }\n      overpayment {\n        amount\n        currencyCode\n        surchargeIds\n        refund {\n          available\n          code\n          message\n          book\n        }\n        accountCredit {\n          available\n          code\n          message\n          book\n        }\n        refundWhenChosen {\n          paymentId\n          amount\n        }\n      }\n      returnState\n      blockers {\n        code\n        message\n        details\n      }\n      notices {\n        code\n        message\n        details\n      }\n      payment {\n        collected\n        reason\n        method\n      }\n      preview {\n        currencyCode\n        subTotal\n        subTotalWithTax\n        shipping\n        shippingWithTax\n        surcharges\n        surchargesWithTax\n        total\n        totalWithTax\n        taxSummary {\n          description\n          taxRate\n          taxBase\n          taxTotal\n        }\n        totalWithTaxBefore\n        moneyView(basis: $moneyBasis) {\n        basis\n        currencyCode\n        lines { orderLineId quantity taxRate unitAmount amount }\n        goodsAdjustments { key description amount taxRate }\n        surcharges { key description amount taxRate }\n        subtotal\n        shipping { key description amount taxRate }\n        shippingAdjustments { key description amount taxRate }\n        shippingTotal\n        totalExcludingTax\n        taxes { taxRate base amount }\n        taxIncluded\n        taxTotal\n        rounding\n        total\n        totalBeforeRounding\n        balance { paid giftCard storeCredit credited stillToPay stillToPayNote }\n        reconciles\n        }\n        moneyViewBefore(basis: $moneyBasis) {\n        basis\n        currencyCode\n        lines { orderLineId quantity taxRate unitAmount amount }\n        goodsAdjustments { key description amount taxRate }\n        surcharges { key description amount taxRate }\n        subtotal\n        shipping { key description amount taxRate }\n        shippingAdjustments { key description amount taxRate }\n        shippingTotal\n        totalExcludingTax\n        taxes { taxRate base amount }\n        taxIncluded\n        taxTotal\n        rounding\n        total\n        totalBeforeRounding\n        balance { paid giftCard storeCredit credited stillToPay stillToPayNote }\n        reconciles\n        }\n        totalDifference\n      }\n    }\n  }\n";
+/**
+ * The document for an engine before the preview's money view (pricing-display-consistency B3):
+ * the same plan without `moneyView`, `moneyViewBefore`, `totalDifference` and their basis.
+ */
+export declare const PLAN_ORDER_EDIT_QUERY_BEFORE_MONEY_VIEW = "\n  query PlanOrderEdit($orderId: ID!, $diff: OrderEditDiffInput!) {\n    planOrderEdit(orderId: $orderId, diff: $diff) {\n      orderId\n      planHash\n      orderVersion\n      steps {\n        kind\n        input\n        moneyEffect\n      }\n      refund {\n        paymentId\n        amount\n      }\n      overpayment {\n        amount\n        currencyCode\n        surchargeIds\n        refund {\n          available\n          code\n          message\n          book\n        }\n        accountCredit {\n          available\n          code\n          message\n          book\n        }\n        refundWhenChosen {\n          paymentId\n          amount\n        }\n      }\n      returnState\n      blockers {\n        code\n        message\n        details\n      }\n      notices {\n        code\n        message\n        details\n      }\n      payment {\n        collected\n        reason\n        method\n      }\n      preview {\n        currencyCode\n        subTotal\n        subTotalWithTax\n        shipping\n        shippingWithTax\n        surcharges\n        surchargesWithTax\n        total\n        totalWithTax\n        taxSummary {\n          description\n          taxRate\n          taxBase\n          taxTotal\n        }\n        totalWithTaxBefore\n      }\n    }\n  }\n";
 export interface OrderPlanEditModule {
     /**
      * How an edit of a placed order would be carried out, and what the order
@@ -466,6 +488,12 @@ export interface OrderPlanEditModule {
      * Keep `planHash` with what you show: `commitEdit` carries the edit out and
      * names it, so what is saved is what the merchant saw.
      *
+     * Show the edit's money from `preview.moneyView` (after) and `moneyViewBefore`, in
+     * `options.moneyBasis` (default `STORE`; `INVALID_ORDER_MONEY_BASIS` before sending for any
+     * other value than `ORDER_MONEY_BASES`): the same rows the order page prints once the edit is
+     * saved, each promotion, fee, VAT rate and staff rounding its own row. The difference is
+     * `preview.totalDifference`. An engine before them answers the plan without them (`null`).
+     *
      * Refusals of the call:
      * - `ORDER_EDIT_ORDER_NOT_FOUND`, `ORDER_EDIT_LINE_NOT_FOUND`,
      *   `ORDER_EDIT_SURCHARGE_NOT_FOUND` and `ORDER_EDIT_VARIANT_NOT_FOUND`
@@ -483,7 +511,11 @@ export interface OrderPlanEditModule {
      *   was made from the default channel instead of the order's own.
      * - `ORDER_BUSY` (`ConflictError`, 409): another change of the order was
      *   still being applied. Ask again.
+     *
+     * @effect read
      */
-    planEdit(orderId: string, diff: OrderEditDiff, options?: Call): Promise<OrderEditPlan>;
+    planEdit(orderId: string, diff: OrderEditDiff, options?: Call & {
+        moneyBasis?: OrderMoneyBasis;
+    }): Promise<OrderEditPlan>;
 }
 export declare function createOrderPlanEditModule(transport: Transport): OrderPlanEditModule;

package/dist/orders/plan-edit.js

@@ -1,9 +1,91 @@
+import { isUnknownFieldRejection, storeCreditAware } from '../payments/store-credit-fields.js';
+import { assertOrderMoneyBasis, ORDER_MONEY_VIEW_FIELDS, stillToPayNoteAware, } from './money-view.js';
 /**
  * Its own document on purpose: `planOrderEdit` exists only on an engine with
  * the order-edit plan, so on an older one this call alone fails validation and
  * no other order call does.
  */
 export const PLAN_ORDER_EDIT_QUERY = /* GraphQL */ `
+  query PlanOrderEdit($orderId: ID!, $diff: OrderEditDiffInput!, $moneyBasis: OrderMoneyBasis!) {
+    planOrderEdit(orderId: $orderId, diff: $diff) {
+      orderId
+      planHash
+      orderVersion
+      steps {
+        kind
+        input
+        moneyEffect
+      }
+      refund {
+        paymentId
+        amount
+      }
+      overpayment {
+        amount
+        currencyCode
+        surchargeIds
+        refund {
+          available
+          code
+          message
+          book
+        }
+        accountCredit {
+          available
+          code
+          message
+          book
+        }
+        refundWhenChosen {
+          paymentId
+          amount
+        }
+      }
+      returnState
+      blockers {
+        code
+        message
+        details
+      }
+      notices {
+        code
+        message
+        details
+      }
+      payment {
+        collected
+        reason
+        method
+      }
+      preview {
+        currencyCode
+        subTotal
+        subTotalWithTax
+        shipping
+        shippingWithTax
+        surcharges
+        surchargesWithTax
+        total
+        totalWithTax
+        taxSummary {
+          description
+          taxRate
+          taxBase
+          taxTotal
+        }
+        totalWithTaxBefore
+        moneyView(basis: $moneyBasis) {${ORDER_MONEY_VIEW_FIELDS}        }
+        moneyViewBefore(basis: $moneyBasis) {${ORDER_MONEY_VIEW_FIELDS}        }
+        totalDifference
+      }
+    }
+  }
+`;
+/**
+ * The document for an engine before the preview's money view (pricing-display-consistency B3):
+ * the same plan without `moneyView`, `moneyViewBefore`, `totalDifference` and their basis.
+ */
+export const PLAN_ORDER_EDIT_QUERY_BEFORE_MONEY_VIEW = /* GraphQL */ `
   query PlanOrderEdit($orderId: ID!, $diff: OrderEditDiffInput!) {
     planOrderEdit(orderId: $orderId, diff: $diff) {
       orderId
@@ -26,11 +108,13 @@ export const PLAN_ORDER_EDIT_QUERY = /* GraphQL */ `
           available
           code
           message
+          book
         }
         accountCredit {
           available
           code
           message
+          book
         }
         refundWhenChosen {
           paymentId
@@ -77,17 +161,34 @@ export const PLAN_ORDER_EDIT_QUERY = /* GraphQL */ `
 export function createOrderPlanEditModule(transport) {
     return {
         async planEdit(orderId, diff, options) {
-            const data = await transport.graphql({
-                api: 'admin',
-                query: PLAN_ORDER_EDIT_QUERY,
-                // The diff goes out as given, never normalised: `orderDiscount` left
-                // out, `null` and a value are three different requests to the engine
-                // (keep, remove, set). `JSON.stringify` drops a key that is
-                // `undefined` and keeps a `null`, so a default here would turn
-                // "keep" into "remove".
-                variables: { orderId, diff },
-            }, options);
-            return data.planOrderEdit;
+            const moneyBasis = options?.moneyBasis ?? 'STORE';
+            assertOrderMoneyBasis(moneyBasis);
+            const send = (query, variables) => storeCreditAware(stillToPayNoteAware(transport)).graphql(
+            // The diff goes out as given, never normalised: `orderDiscount` left
+            // out, `null` and a value are three different requests to the engine
+            // (keep, remove, set). `JSON.stringify` drops a key that is
+            // `undefined` and keeps a `null`, so a default here would turn
+            // "keep" into "remove".
+            { api: 'admin', query, variables: { orderId, diff, ...variables } }, options);
+            try {
+                return (await send(PLAN_ORDER_EDIT_QUERY, { moneyBasis })).planOrderEdit;
+            }
+            catch (error) {
+                // An engine before the preview's money refuses the document before it runs, so
+                // nothing was planned: ask again without it.
+                if (!isUnknownFieldRejection(error))
+                    throw error;
+                const { planOrderEdit } = await send(PLAN_ORDER_EDIT_QUERY_BEFORE_MONEY_VIEW, {});
+                return {
+                    ...planOrderEdit,
+                    preview: planOrderEdit.preview && {
+                        ...planOrderEdit.preview,
+                        moneyView: null,
+                        moneyViewBefore: null,
+                        totalDifference: null,
+                    },
+                };
+            }
         },
     };
 }

package/dist/orders/settings.d.ts

@@ -0,0 +1,201 @@
+import { type Transport } from '@sixtyninecommerce/core';
+import type { SettingsSourceKind } from '../tenant/settings-sources.js';
+import type { Call } from '../types.js';
+/** The states an order status rule may move a placed order to. */
+export declare const ORDER_STATUS_RULE_TARGET_STATES: readonly ["AwaitingApproval", "PaymentAuthorized", "PaymentSettled"];
+/** What an order status rule matches on. */
+export declare const ORDER_STATUS_RULE_CONDITION_TYPES: readonly ["product", "coupon", "collection", "facet_value"];
+/** The fewest zero-padded digits of a sequential order number. */
+export declare const ORDER_CODE_DIGITS_MIN = 4;
+/** The most zero-padded digits of a sequential order number. */
+export declare const ORDER_CODE_DIGITS_MAX = 8;
+/**
+ * The longest order-number prefix. The engine stores more, but every order code is
+ * `NAMESPACE-PREFIX00001` in a 255-character column: a long prefix fails EVERY order placement.
+ */
+export declare const ORDER_CODE_PREFIX_MAX_LENGTH = 20;
+/** The youngest minimum purchase age (the engine checks no age below 1: `minimumAge > 0`). */
+export declare const MINIMUM_AGE_MIN = 1;
+/** The oldest minimum purchase age the platform accepts. */
+export declare const MINIMUM_AGE_MAX = 99;
+/**
+ * The largest amount (minor units) the minimum and the thresholds hold: the columns are Vendure
+ * `int` custom fields, GraphQL `Int` (32 bits). ₩30,000,000 is 3,000,000,000 hundredths, past it.
+ */
+export declare const ORDER_SETTINGS_AMOUNT_MAX = 2147483647;
+export type OrderStatusRuleTargetState = (typeof ORDER_STATUS_RULE_TARGET_STATES)[number];
+export type OrderStatusRuleConditionType = (typeof ORDER_STATUS_RULE_CONDITION_TYPES)[number];
+/**
+ * A rule that moves an order into `targetState` on its FIRST placement when it matches. Rules run
+ * in array order and the first enabled match wins; a rule whose list for its `conditionType` is
+ * empty never fires.
+ */
+export interface OrderStatusRule {
+    id: string;
+    /** For people only. `''` for a stored rule that has none: the engine fires it all the same. */
+    name: string;
+    targetState: OrderStatusRuleTargetState;
+    conditionType: OrderStatusRuleConditionType;
+    /** Read for `product`. */
+    productVariantIds?: string[];
+    /** Read for `coupon`, compared without case. */
+    couponCodes?: string[];
+    /** Read for `collection`. */
+    collectionIds?: string[];
+    /** Read for `facet_value`. */
+    facetValueIds?: string[];
+    enabled: boolean;
+}
+/** Where the minimum purchase age the engine applies comes from (`settings.age_verification`). */
+export interface MinimumAgeSource {
+    /** `channel`: the store's own `minimumAge`; `organization`: its organization's. */
+    source: SettingsSourceKind | (string & {});
+    /**
+     * The organization locked the group: {@link OrderSettingsModule.set} refuses a changed
+     * `minimumAge` with `MANAGED_BY_ORGANIZATION`, SuperAdmins included.
+     */
+    locked: boolean;
+    /** The organization shares the group without locking it. */
+    inheritable: boolean;
+    /** The store keeps its own value although the organization shares the group. */
+    overridden: boolean;
+    /** The age the engine applies to this store's checkout; null when none. */
+    effective: number | null;
+}
+/**
+ * The ACTIVE store's order settings, as its channel stores them. Every amount is in minor units
+ * (hundredths, for every currency: ¥5,000 is 500000, as the platform stores all money) of
+ * {@link OrderSettings.currencyCode}, the store's default currency.
+ */
+export interface OrderSettings {
+    /** The store these are the settings of (its channel id). */
+    channelId: string;
+    /** The store's default currency (ISO 4217): the minimum and both thresholds are in it. */
+    currencyCode: string;
+    /**
+     * The least an order may cost (with tax) before it can be placed; null when there is no
+     * minimum. An order in another currency is held to it converted at the checkout's rate.
+     */
+    minOrderAmount: number | null;
+    /** Customer groups whose members are not held to the minimum. */
+    exemptCustomerGroupIds: string[];
+    /** Collections whose items do not count toward the minimum. */
+    exemptCollectionIds: string[];
+    /** Placed orders get sequential numbers (`NAMESPACE-PREFIX00001`); off: random codes. */
+    orderCodeEnabled: boolean;
+    /**
+     * The store's part of every sequential order number, set by the platform (from the store's
+     * code) and never by a caller; read-only here. Null until sequential numbers were first on.
+     */
+    orderCodeNamespace: string | null;
+    /** The merchant's part after the namespace, e.g. `VIN-`; null for none. */
+    orderCodePrefix: string | null;
+    /** How many zero-padded digits the number has, 4 to 8; null is the platform's 5. */
+    orderCodeDigits: number | null;
+    /**
+     * The store's OWN minimum purchase age, what {@link OrderSettingsModule.set} writes; null for
+     * none. While the store takes `settings.age_verification` from its organization the engine
+     * applies the organization's instead: see {@link OrderSettings.minimumAgeSource}.
+     */
+    minimumAge: number | null;
+    minimumAgeSource: MinimumAgeSource;
+    /**
+     * The rules the engine applies, read as the engine reads them: an entry without a string `id`,
+     * a known `targetState` and a known `conditionType` is left out (the engine never fires it);
+     * a rule without a name reads `name: ''`, its `enabled` as the engine takes it, and its lists
+     * as their non-empty strings.
+     */
+    orderStatusRules: OrderStatusRule[];
+    /** A customer's balance above this shows as a warning; null for no warning tier. */
+    outstandingBalanceWarningThreshold: number | null;
+    /** A customer's balance above this shows as critical; null for no critical tier. */
+    outstandingBalanceCriticalThreshold: number | null;
+}
+/**
+ * A PATCH of {@link OrderSettings}: a key left out is unchanged, `null` clears it. At least one
+ * key. There is no `orderCodeNamespace`: the platform sets it (ruling G125).
+ */
+export interface UpdateOrderSettingsInput {
+    /** Whole minor units, 0 to {@link ORDER_SETTINGS_AMOUNT_MAX}; null for no minimum. */
+    minOrderAmount?: number | null;
+    /** The whole list (it replaces the stored one); empty for none. */
+    exemptCustomerGroupIds?: string[];
+    /** The whole list (it replaces the stored one); empty for none. */
+    exemptCollectionIds?: string[];
+    /**
+     * Switching it on for a store that never had sequential numbers also sets its namespace to the
+     * store's code in capitals, as provisioning does for a new store.
+     */
+    orderCodeEnabled?: boolean;
+    /** At most 20 characters; null for none. */
+    orderCodePrefix?: string | null;
+    /** A whole number from 4 to 8; null for the platform's 5. */
+    orderCodeDigits?: number | null;
+    /** A whole number of years from 1 to 99; null for no age check. */
+    minimumAge?: number | null;
+    /** The whole list, in priority order (it replaces the stored one); empty for none. */
+    orderStatusRules?: OrderStatusRule[];
+    /** Whole minor units, 0 to {@link ORDER_SETTINGS_AMOUNT_MAX}; null for no warning tier. */
+    outstandingBalanceWarningThreshold?: number | null;
+    /** Whole minor units, 0 to {@link ORDER_SETTINGS_AMOUNT_MAX}; null for no critical tier. */
+    outstandingBalanceCriticalThreshold?: number | null;
+}
+/**
+ * `admin.orders.settings`: the ACTIVE store's order settings (Settings → Orders): its order
+ * minimum and who is exempt from it, how its orders are numbered, the minimum purchase age, the
+ * rules that route a placed order into a state, and the outstanding-balance warning tiers. Stored
+ * as Channel custom fields; written through core `updateChannel` (typed per domain, ruling G80).
+ *
+ * The deposit policy (`orders.depositPolicy`) and the fulfilment payment policy
+ * (`fulfillments.paymentPolicy`) have doors of their own.
+ */
+export interface OrderSettingsModule {
+    /**
+     * The settings as the engine applies them, with where the minimum age comes from. Reading
+     * needs an administrator of the store with any permission beyond `Authenticated`.
+     *
+     * @effect read
+     */
+    get(options?: Call): Promise<OrderSettings>;
+    /**
+     * Change the settings `patch` names, and answer them all as the engine now stores them.
+     *
+     * Changing the minimum or its exemptions changes which orders the store accepts from the next
+     * checkout on; orders already placed keep the rule they were placed under.
+     *
+     * **Coded refusals:**
+     * - `ORDER_SETTINGS_INVALID` → {@link ValidationError} (400), before any request: an empty
+     *   patch; a key that is not an order setting (`orderCodeNamespace` included: the platform
+     *   sets it); an amount that is not a whole number of minor units from 0 to
+     *   {@link ORDER_SETTINGS_AMOUNT_MAX} (the column is a 32-bit `Int`); digits outside
+     *   4–8; a prefix longer than 20 characters; an age outside 1–99; a list that is not an array.
+     *   One `details[]` entry per failing key, `field` naming it.
+     * - `CHANNEL_SETTINGS_INVALID` → {@link ValidationError} (400), from the engine: an exemption
+     *   list that is not distinct non-empty ids (at most 255 characters encoded, about six ids),
+     *   a malformed status rule, or a critical threshold not above the warning threshold
+     *   (`code: 'MUST_EXCEED_WARNING'`). `details[].field` is the input path, such as
+     *   `customFields.outstandingBalanceCriticalThreshold`; `details[].message` is the engine's
+     *   sentence, with the amounts in the store's currency.
+     * - `MANAGED_BY_ORGANIZATION` → `BusinessRuleError` (422): a changed `minimumAge` while the
+     *   organization locks `settings.age_verification`.
+     * - `ORGANIZATION_SETTINGS_INHERITED` → `BusinessRuleError` (422): a changed `minimumAge`
+     *   while the store inherits the group; `tenant.settingsSources.override` it first. Sending
+     *   the stored value back unchanged is accepted and changes nothing.
+     * - `FORBIDDEN` → `PermissionDeniedError` (403): the credential lacks `UpdateChannel`.
+     *
+     * @effect write
+     * @permission UpdateChannel
+     */
+    set(patch: UpdateOrderSettingsInput, options?: Call): Promise<OrderSettings>;
+}
+export declare const ORDER_SETTINGS_QUERY = "\n  query OrderSettings {\n    activeChannel { \n  id\n  code\n  defaultCurrencyCode\n  customFields {\n    minOrderAmount\n    exemptCustomerGroupIds\n    exemptCollectionIds\n    orderCodeNamespace\n    orderCodePrefix\n    orderCodeDigits\n    orderCodeEnabled\n    minimumAge\n    orderStatusRules\n    outstandingBalanceWarningThreshold\n    outstandingBalanceCriticalThreshold\n  }\n }\n    channelSettingsSources { group source locked overridden inheritable values }\n  }\n";
+export declare const UPDATE_ORDER_SETTINGS_MUTATION = "\n  mutation UpdateOrderSettings($input: UpdateChannelInput!) {\n    updateChannel(input: $input) {\n      ... on Channel { \n  id\n  code\n  defaultCurrencyCode\n  customFields {\n    minOrderAmount\n    exemptCustomerGroupIds\n    exemptCollectionIds\n    orderCodeNamespace\n    orderCodePrefix\n    orderCodeDigits\n    orderCodeEnabled\n    minimumAge\n    orderStatusRules\n    outstandingBalanceWarningThreshold\n    outstandingBalanceCriticalThreshold\n  }\n }\n      ... on ErrorResult { errorCode message }\n    }\n  }\n";
+/**
+ * The column as the engine's `parseRules` keeps it: an entry with a string `id`, a known
+ * `targetState` and a known `conditionType`. A rule the engine keeps is never dropped here (a
+ * stricter reader would erase it on the next save, turning off the transition it performs), so
+ * a missing `name` reads `''` and `enabled` reads as the engine takes it (truthy fires). Only the
+ * rule's own keys come back, so the list can be sent back as the engine's schema wants it.
+ */
+export declare function readOrderStatusRules(raw: unknown): OrderStatusRule[];
+export declare function createOrderSettingsModule(transport: Transport): OrderSettingsModule;