@sixtyninecommerce/admin 0.10.0 → 0.12.0

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

@@ -1,4 +1,5 @@
 import { type Transport } from '@sixtyninecommerce/core';
+import type { StoreCreditMove } from '../payments/account-credit.js';
 import type { Call } from '../types.js';
 import type { OrderEditDiff, OrderEditPlan } from './plan-edit.js';
 import type { OrderOverpaymentChoice } from './surcharges.js';
@@ -32,6 +33,11 @@ export interface OrderEditOverpaymentSettlement {
     currencyCode: string;
     /** For `ACCOUNT_CREDIT`: the receipts on the customer's account, one per payment it came from. */
     unappliedCashIds: string[];
+    /**
+     * For `ACCOUNT_CREDIT` in a store whose book is store credit: the move to the customer's
+     * wallet (`unappliedCashIds` is then empty). Null otherwise; absent from an engine before it.
+     */
+    storeCredit?: StoreCreditMove | null;
 }
 export interface OrderEditCommit {
     order: OrderEditCommittedOrder;
@@ -66,12 +72,28 @@ export interface CommitOrderEditCall extends Call {
      * Part of the request: a retry under the same key re-sends the same choice.
      */
     overpaymentChoice?: OrderOverpaymentChoice;
+    /**
+     * With `overpaymentChoice: 'ACCOUNT_CREDIT'` in a store whose book is store credit (the plan's
+     * `overpayment.accountCredit.book` `STORE_CREDIT`): whether the customer expressly agreed to
+     * store credit instead of a refund to their payment (EU consumer law, CRD art. 13(1)), as staff
+     * recorded it. The move records it on its ledger entries (`StoredValueEntry.customerAgreed`);
+     * never a condition, nothing is refused for it. Part of the request like the choice: a retry
+     * under the same key re-sends the same answer, and another answer under it is
+     * `IDEMPOTENCY_CONFLICT`. Sent only when given; an engine before the field (incentives sprint 8
+     * PR 6a) refuses a call that gives it.
+     */
+    customerAgreed?: boolean;
 }
 /**
  * Its own document on purpose: `commitOrderEdit` exists only on an engine with the order-edit
  * commit, so on an older one this call alone fails validation and no other order call does.
  */
-export declare const COMMIT_ORDER_EDIT_MUTATION = "\n  mutation CommitOrderEdit(\n    $orderId: ID!\n    $diff: OrderEditDiffInput!\n    $expectedPlanHash: String!\n    $idempotencyKey: String!\n    $overpaymentChoice: OrderOverpaymentChoice\n  ) {\n    commitOrderEdit(\n      orderId: $orderId\n      diff: $diff\n      expectedPlanHash: $expectedPlanHash\n      idempotencyKey: $idempotencyKey\n      overpaymentChoice: $overpaymentChoice\n    ) {\n      order {\n        id\n        code\n        state\n        currencyCode\n        totalWithTax\n      }\n      plan {\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      refund {\n        id\n        state\n        total\n        paymentId\n      }\n      overpayment {\n        choice\n        amount\n        currencyCode\n        unappliedCashIds\n      }\n    }\n  }\n";
+export declare const COMMIT_ORDER_EDIT_MUTATION = "\n  mutation CommitOrderEdit(\n    $orderId: ID!\n    $diff: OrderEditDiffInput!\n    $expectedPlanHash: String!\n    $idempotencyKey: String!\n    $overpaymentChoice: OrderOverpaymentChoice\n  ) {\n    commitOrderEdit(\n      orderId: $orderId\n      diff: $diff\n      expectedPlanHash: $expectedPlanHash\n      idempotencyKey: $idempotencyKey\n      overpaymentChoice: $overpaymentChoice\n    ) {\n      order {\n        id\n        code\n        state\n        currencyCode\n        totalWithTax\n      }\n      plan {\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      refund {\n        id\n        state\n        total\n        paymentId\n      }\n      overpayment {\n        choice\n        amount\n        currencyCode\n        unappliedCashIds\n        storeCredit { accountId amount currencyCode entryIds }\n      }\n    }\n  }\n";
+/**
+ * The same, declaring the customer's answer to store credit: sent only by a call that states it,
+ * so an engine before the argument still takes every call that does not.
+ */
+export declare const COMMIT_ORDER_EDIT_WITH_CONSENT_MUTATION: string;
 export interface OrderCommitEditModule {
     /**
      * Carry out an edit of a placed order as its plan (`planEdit`) states it, once. Needs

package/dist/orders/commit-edit.js

@@ -1,4 +1,6 @@
 import { idempotencyKey as mintIdempotencyKey } from '@sixtyninecommerce/core';
+import { customerAgreedVariable, withCustomerAgreed } from '../payments/customer-consent.js';
+import { STORE_CREDIT_MOVE_FIELDS, storeCreditAware } from '../payments/store-credit-fields.js';
 /**
  * Its own document on purpose: `commitOrderEdit` exists only on an engine with the order-edit
  * commit, so on an older one this call alone fails validation and no other order call does.
@@ -46,11 +48,13 @@ export const COMMIT_ORDER_EDIT_MUTATION = /* GraphQL */ `
             available
             code
             message
+            book
           }
           accountCredit {
             available
             code
             message
+            book
           }
           refundWhenChosen {
             paymentId
@@ -103,18 +107,30 @@ export const COMMIT_ORDER_EDIT_MUTATION = /* GraphQL */ `
         amount
         currencyCode
         unappliedCashIds
+        storeCredit { ${STORE_CREDIT_MOVE_FIELDS} }
       }
     }
   }
 `;
+/**
+ * The same, declaring the customer's answer to store credit: sent only by a call that states it,
+ * so an engine before the argument still takes every call that does not.
+ */
+export const COMMIT_ORDER_EDIT_WITH_CONSENT_MUTATION = withCustomerAgreed(COMMIT_ORDER_EDIT_MUTATION, {
+    declaration: '$overpaymentChoice: OrderOverpaymentChoice',
+    argument: 'overpaymentChoice: $overpaymentChoice',
+});
 export function createOrderCommitEditModule(transport) {
     return {
         async commitEdit(orderId, diff, options) {
             const key = options.idempotencyKey ?? mintIdempotencyKey();
+            const customerAgreed = customerAgreedVariable(options.customerAgreed);
             try {
-                const data = await transport.graphql({
+                const data = await storeCreditAware(transport).graphql({
                     api: 'admin',
-                    query: COMMIT_ORDER_EDIT_MUTATION,
+                    query: customerAgreed === undefined
+                        ? COMMIT_ORDER_EDIT_MUTATION
+                        : COMMIT_ORDER_EDIT_WITH_CONSENT_MUTATION,
                     // The diff goes out as given, never normalised (see `planEdit`): left out, `null` and
                     // a value are three different requests.
                     variables: {
@@ -126,6 +142,7 @@ export function createOrderCommitEditModule(transport) {
                         ...(options.overpaymentChoice !== undefined
                             ? { overpaymentChoice: options.overpaymentChoice }
                             : {}),
+                        ...(customerAgreed !== undefined ? { customerAgreed } : {}),
                     },
                 }, { ...options, idempotencyKey: key });
                 return { ...data.commitOrderEdit, idempotencyKey: key };

package/dist/orders/deposit-policy.d.ts

@@ -32,7 +32,9 @@ export interface OrderDepositPolicy {
     /**
      * The store-wide switch. Off: a payment must cover the whole outstanding
      * amount (`payments.record` refuses a part payment `DEPOSITS_NOT_ENABLED`) and
-     * no order can be parked.
+     * no order can be parked. Stored value (a gift card or store credit) is the
+     * exception: it may pay part of an order still arranging payment, and the
+     * order is placed only once its money covers it.
      */
     enabled: boolean;
     /**