@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/stock/transfers.js

@@ -1,5 +1,6 @@
 import { pageFromVendureList, readOffsetCursor, } from '@sixtyninecommerce/core';
 import { decodeBase64, MYPARCEL_LABEL_TIMEOUT_MS, toUnretractedShipments, UNRETRACTED_SHIPMENT_FIELDS, } from '../fulfillments/index.js';
+import { isUnknownFieldRejection } from '../payments/store-credit-fields.js';
 const TRANSFER_FIELDS = /* GraphQL */ `
   id
   code
@@ -29,14 +30,74 @@ const TRANSFER_FIELDS = /* GraphQL */ `
   }
   createdAt
   updatedAt
+  initiatedBy { id firstName lastName }
   items {
     id
-    productVariant { id sku }
+    productVariant { id name sku }
     quantity
     receivedQuantity
     lostQuantity
     outstandingQuantity
   }
+  totalLines
+  totalQuantity
+  totalReceivedQuantity
+  totalLostQuantity
+`;
+/**
+ * What `get` and every write answer. Every field is one the transfer module has always served
+ * (the dashboard's own transfer pages read them all), so no engine refuses it.
+ */
+const TRANSFER_DETAIL_FIELDS = /* GraphQL */ `
+  id
+  code
+  kind
+  state
+  sourceLocation { id name }
+  destinationLocation { id name customFields { address } }
+  label
+  note
+  carrier
+  trackingCode
+  estimatedArrivalAt
+  shippedAt
+  receivedAt
+  cancelledAt
+  cancelReason
+  deliveryAddress {
+    contactName
+    company
+    streetLine1
+    streetLine2
+    city
+    province
+    postalCode
+    countryCode
+    phoneNumber
+  }
+  createdAt
+  updatedAt
+  initiatedBy { id firstName lastName }
+  shippedBy { id firstName lastName }
+  receivedBy { id firstName lastName }
+  consumptionTotalValue
+  consumptionHasUnpricedLines
+  pdfStorageKey
+  fulfillmentHandlerCode
+  handlerArgs
+  myparcelShipmentId
+  myparcelBarcode
+  hendriksRemotePath
+  items {
+    id
+    productVariant { id name sku }
+    quantity
+    receivedQuantity
+    lostQuantity
+    outstandingQuantity
+    unitCost
+  }
+  totalLines
   totalQuantity
   totalReceivedQuantity
   totalLostQuantity
@@ -47,36 +108,36 @@ export const STOCK_TRANSFERS_QUERY = /* GraphQL */ `
   }
 `;
 export const STOCK_TRANSFER_QUERY = /* GraphQL */ `
-  query StockTransfer($id: ID!) { stockTransfer(id: $id) { ${TRANSFER_FIELDS} } }
+  query StockTransfer($id: ID!) { stockTransfer(id: $id) { ${TRANSFER_DETAIL_FIELDS} } }
 `;
 export const CREATE_STOCK_TRANSFER_MUTATION = /* GraphQL */ `
   mutation CreateStockTransfer($input: CreateStockTransferInput!) {
-    createStockTransfer(input: $input) { ${TRANSFER_FIELDS} }
+    createStockTransfer(input: $input) { ${TRANSFER_DETAIL_FIELDS} }
   }
 `;
 export const UPDATE_STOCK_TRANSFER_MUTATION = /* GraphQL */ `
   mutation UpdateStockTransfer($id: ID!, $input: UpdateStockTransferInput!) {
-    updateStockTransfer(id: $id, input: $input) { ${TRANSFER_FIELDS} }
+    updateStockTransfer(id: $id, input: $input) { ${TRANSFER_DETAIL_FIELDS} }
   }
 `;
 export const SHIP_STOCK_TRANSFER_MUTATION = /* GraphQL */ `
   mutation ShipStockTransfer($id: ID!, $input: ShipStockTransferInput) {
-    shipStockTransfer(id: $id, input: $input) { ${TRANSFER_FIELDS} }
+    shipStockTransfer(id: $id, input: $input) { ${TRANSFER_DETAIL_FIELDS} }
   }
 `;
 export const POST_STOCK_TRANSFER_CONSUMPTION_MUTATION = /* GraphQL */ `
   mutation PostStockTransferConsumption($id: ID!) {
-    postStockTransferConsumption(id: $id) { ${TRANSFER_FIELDS} }
+    postStockTransferConsumption(id: $id) { ${TRANSFER_DETAIL_FIELDS} }
   }
 `;
 export const RECEIVE_STOCK_TRANSFER_LINES_MUTATION = /* GraphQL */ `
   mutation ReceiveStockTransferLines($id: ID!, $lines: [ReceiveStockTransferLineInput!]!) {
-    receiveStockTransferLines(id: $id, lines: $lines) { ${TRANSFER_FIELDS} }
+    receiveStockTransferLines(id: $id, lines: $lines) { ${TRANSFER_DETAIL_FIELDS} }
   }
 `;
 export const CLOSE_STOCK_TRANSFER_MUTATION = /* GraphQL */ `
   mutation CloseStockTransfer($id: ID!, $acceptShortfallAsLost: Boolean) {
-    closeStockTransfer(id: $id, acceptShortfallAsLost: $acceptShortfallAsLost) { ${TRANSFER_FIELDS} }
+    closeStockTransfer(id: $id, acceptShortfallAsLost: $acceptShortfallAsLost) { ${TRANSFER_DETAIL_FIELDS} }
   }
 `;
 /**
@@ -94,17 +155,49 @@ export const CLOSE_STOCK_TRANSFER_WITH_SHORTFALL_MUTATION = /* GraphQL */ `
       id: $id
       acceptShortfallAsLost: $acceptShortfallAsLost
       shortfall: $shortfall
-    ) { ${TRANSFER_FIELDS} }
+    ) { ${TRANSFER_DETAIL_FIELDS} }
   }
 `;
 export const CANCEL_STOCK_TRANSFER_MUTATION = /* GraphQL */ `
   mutation CancelStockTransfer($id: ID!, $reason: String) {
-    cancelStockTransfer(id: $id, reason: $reason) { ${TRANSFER_FIELDS} }
+    cancelStockTransfer(id: $id, reason: $reason) { ${TRANSFER_DETAIL_FIELDS} }
   }
 `;
 export const CREATE_STOCK_TRANSFER_RETURN_MUTATION = /* GraphQL */ `
   mutation CreateStockTransferReturn($id: ID!, $input: CreateStockTransferReturnInput!) {
-    createStockTransferReturn(id: $id, input: $input) { ${TRANSFER_FIELDS} }
+    createStockTransferReturn(id: $id, input: $input) { ${TRANSFER_DETAIL_FIELDS} }
+  }
+`;
+export const REMOVE_STOCK_TRANSFER_SHIPMENT_MUTATION = /* GraphQL */ `
+  mutation RemoveStockTransferShipment($id: ID!) {
+    removeStockTransferShipment(id: $id) { ${TRANSFER_DETAIL_FIELDS} }
+  }
+`;
+export const RETRY_STOCK_TRANSFER_HENDRIKS_EXPORT_MUTATION = /* GraphQL */ `
+  mutation RetryStockTransferHendriksExport($id: ID!) {
+    retryStockTransferHendriksExport(id: $id) { ${TRANSFER_DETAIL_FIELDS} }
+  }
+`;
+export const REGENERATE_STOCK_TRANSFER_PDF_MUTATION = /* GraphQL */ `
+  mutation RegenerateStockTransferPdf($id: ID!) {
+    regenerateStockTransferPdf(id: $id) { ${TRANSFER_DETAIL_FIELDS} }
+  }
+`;
+const NUMBERING_FIELDS = /* GraphQL */ `
+  prefix
+  suffix
+  digits
+  yearFormat
+  yearReset
+`;
+export const STOCK_TRANSFER_NUMBERING_QUERY = /* GraphQL */ `
+  query StockTransferNumberingConfig {
+    stockTransferNumberingConfig { ${NUMBERING_FIELDS} }
+  }
+`;
+export const UPDATE_STOCK_TRANSFER_NUMBERING_MUTATION = /* GraphQL */ `
+  mutation UpdateStockTransferNumberingConfig($input: UpdateStockTransferNumberingConfigInput!) {
+    updateStockTransferNumberingConfig(input: $input) { ${NUMBERING_FIELDS} }
   }
 `;
 /**
@@ -134,9 +227,19 @@ export const STOCK_TRANSFER_RETURNS_QUERY = /* GraphQL */ `
         returnedQuantity
         returnableQuantity
       }
+      returnAvailability { available reasonCode }
     }
   }
 `;
+/**
+ * The availability verdicts (W10-71) are newer than the documents that carry them: an engine
+ * before them refuses the whole document, so the read is sent once more without them and
+ * answers the verdict as null.
+ */
+const AVAILABILITY_SELECTION = /\s*(?:cancelAvailability|returnAvailability) \{ available reasonCode \}/g;
+function withoutAvailability(document) {
+    return document.replace(AVAILABILITY_SELECTION, '');
+}
 /** The per-line settlement fields, in a document of their own like the return fields. */
 export const STOCK_TRANSFER_SHORTFALL_QUERY = /* GraphQL */ `
   query StockTransferShortfall($id: ID!) {
@@ -187,6 +290,7 @@ export const STOCK_TRANSFER_CANCELLATION_QUERY = /* GraphQL */ `
       fulfillmentHandlerCode
       hendriksRemotePath
       hendriksBluJayOrderNumber
+      cancelAvailability { available reasonCode }
     }
   }
 `;
@@ -233,9 +337,10 @@ const MYPARCEL_HANDLER_CODE = 'myparcel';
 /**
  * A MyParcel ship and its retry book every parcel at MyParcel before they
  * answer (per parcel an adopt-by-reference lookup of up to 3 × 10s plus two
- * capped waits, and a 30s POST), and a cancel voids every parcel there. The
+ * capped waits, and a 30s POST), a cancel or a shipment removal voids every
+ * parcel there, and a Hendriks ship or export retry uploads its export. The
  * default 15s aborted calls the engine went on to finish, so the caller saw a
- * failure for a ship, booking or cancel that succeeded.
+ * failure for a ship, booking, cancel or removal that succeeded.
  */
 const CARRIER_CALL_TIMEOUT_MS = 120_000;
 /**
@@ -286,6 +391,7 @@ function toCancellation(raw) {
         cancelReason: raw.cancelReason,
         cancelledBy: raw.cancelledBy,
         hendriksExport: exported ? { bluJayOrderNumber: raw.hendriksBluJayOrderNumber } : null,
+        cancelAvailability: raw.cancelAvailability ?? null,
     };
 }
 function toTransfer(raw) {
@@ -295,9 +401,73 @@ function toTransfer(raw) {
             ...line,
             variantId: productVariant.id,
             sku: productVariant.sku,
+            variantName: productVariant.name,
         })),
     };
 }
+const ADDRESS_KEYS = [
+    'contactName',
+    'company',
+    'streetLine1',
+    'streetLine2',
+    'city',
+    'province',
+    'postalCode',
+    'countryCode',
+    'phoneNumber',
+];
+/**
+ * A location's `customFields.address`: JSON text earlier writers filled freely. Only its string
+ * fields are taken. Text that is not a JSON object, or one with no string field, reads as no
+ * address; the engine reads such a column the same way, and refuses to address a parcel to it.
+ */
+function locationAddress(raw) {
+    if (!raw?.trim())
+        return null;
+    let parsed;
+    try {
+        parsed = JSON.parse(raw);
+    }
+    catch {
+        return null;
+    }
+    if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed))
+        return null;
+    const source = parsed;
+    const address = {};
+    let any = false;
+    for (const key of ADDRESS_KEYS) {
+        const value = source[key];
+        address[key] = typeof value === 'string' ? value : null;
+        any ||= typeof value === 'string' && value.trim() !== '';
+    }
+    return any ? address : null;
+}
+function toHandlerArgs(raw) {
+    if (Array.isArray(raw))
+        return raw;
+    if (raw && typeof raw === 'object')
+        return raw;
+    return null;
+}
+function toDetail(raw) {
+    const { destinationLocation, items, handlerArgs, ...rest } = raw;
+    return {
+        ...rest,
+        destinationLocation: destinationLocation && {
+            id: destinationLocation.id,
+            name: destinationLocation.name,
+            address: locationAddress(destinationLocation.customFields?.address),
+        },
+        items: items.map(({ productVariant, ...line }) => ({
+            ...line,
+            variantId: productVariant.id,
+            sku: productVariant.sku,
+            variantName: productVariant.name,
+        })),
+        handlerArgs: toHandlerArgs(handlerArgs),
+    };
+}
 function toReturns(raw) {
     return {
         returnOfTransferId: raw.returnOfTransferId,
@@ -309,14 +479,26 @@ function toReturns(raw) {
             variantName: productVariant.name,
             ...quantities,
         })),
+        returnAvailability: raw.returnAvailability ?? null,
     };
 }
+/** Read the document, and once more without the availability verdicts when the engine does not know them. */
+async function readWithoutAvailabilityOnOlderEngine(transport, query, id, options) {
+    try {
+        return await transport.graphql({ api: 'admin', query, variables: { id } }, options);
+    }
+    catch (error) {
+        if (!isUnknownFieldRejection(error))
+            throw error;
+        return transport.graphql({ api: 'admin', query: withoutAvailability(query), variables: { id } }, options);
+    }
+}
 const toLines = (lines) => lines.map((line) => ({ productVariantId: line.variantId, quantity: line.quantity }));
 const DEFAULT_PAGE_SIZE = 25;
 export function createStockTransfersModule(transport) {
     const one = async (field, query, variables, options) => {
         const data = await transport.graphql({ api: 'admin', query, variables }, options);
-        return toTransfer(data[field]);
+        return toDetail(data[field]);
     };
     const listPage = async (skip, take, filter) => {
         const data = await transport.graphql({
@@ -333,6 +515,9 @@ export function createStockTransfersModule(transport) {
                     dateFrom: filter?.dateFrom,
                     dateTo: filter?.dateTo,
                     search: filter?.search,
+                    // Only when set, as the return filters below: a caller that never names a mode
+                    // keeps sending the document every engine since the transfer module accepts.
+                    ...(filter?.searchMode === undefined ? {} : { searchMode: filter.searchMode }),
                     // Only when set: an engine without returns refuses an unknown
                     // input field, which would fail every list against it.
                     ...(filter?.returnOfTransferId === undefined
@@ -355,7 +540,7 @@ export function createStockTransfersModule(transport) {
         },
         async get(id, options) {
             const data = await transport.graphql({ api: 'admin', query: STOCK_TRANSFER_QUERY, variables: { id } }, options);
-            return data.stockTransfer === null ? null : toTransfer(data.stockTransfer);
+            return data.stockTransfer === null ? null : toDetail(data.stockTransfer);
         },
         create(input, options) {
             const { lines, ...rest } = input;
@@ -393,7 +578,7 @@ export function createStockTransfersModule(transport) {
             return one('createStockTransferReturn', CREATE_STOCK_TRANSFER_RETURN_MUTATION, { id, input: { ...rest, lines: toLines(lines) } }, options);
         },
         async returns(id, options) {
-            const data = await transport.graphql({ api: 'admin', query: STOCK_TRANSFER_RETURNS_QUERY, variables: { id } }, options);
+            const data = await readWithoutAvailabilityOnOlderEngine(transport, STOCK_TRANSFER_RETURNS_QUERY, id, options);
             return data.stockTransfer === null ? null : toReturns(data.stockTransfer);
         },
         async shortfall(id, options) {
@@ -401,7 +586,7 @@ export function createStockTransfersModule(transport) {
             return data.stockTransfer === null ? null : toShortfall(data.stockTransfer);
         },
         async cancellation(id, options) {
-            const data = await transport.graphql({ api: 'admin', query: STOCK_TRANSFER_CANCELLATION_QUERY, variables: { id } }, options);
+            const data = await readWithoutAvailabilityOnOlderEngine(transport, STOCK_TRANSFER_CANCELLATION_QUERY, id, options);
             return data.stockTransfer === null ? null : toCancellation(data.stockTransfer);
         },
         async parcels(id, options) {
@@ -433,5 +618,25 @@ export function createStockTransfersModule(transport) {
             const { base64, ...document } = data.getMyparcelStockTransferLabel;
             return { ...document, bytes: decodeBase64(base64) };
         },
+        removeShipment(id, options) {
+            return one('removeStockTransferShipment', REMOVE_STOCK_TRANSFER_SHIPMENT_MUTATION, { id }, { timeoutMs: CARRIER_CALL_TIMEOUT_MS, ...options });
+        },
+        retryHendriksExport(id, options) {
+            // The ship's budget: the same upload runs inside the call.
+            return one('retryStockTransferHendriksExport', RETRY_STOCK_TRANSFER_HENDRIKS_EXPORT_MUTATION, { id }, { timeoutMs: CARRIER_CALL_TIMEOUT_MS, ...options });
+        },
+        regeneratePdf(id, options) {
+            return one('regenerateStockTransferPdf', REGENERATE_STOCK_TRANSFER_PDF_MUTATION, { id }, options);
+        },
+        numbering: {
+            async get(options) {
+                const data = await transport.graphql({ api: 'admin', query: STOCK_TRANSFER_NUMBERING_QUERY }, options);
+                return data.stockTransferNumberingConfig;
+            },
+            async set(input, options) {
+                const data = await transport.graphql({ api: 'admin', query: UPDATE_STOCK_TRANSFER_NUMBERING_MUTATION, variables: { input } }, options);
+                return data.updateStockTransferNumberingConfig;
+            },
+        },
     };
 }