@sixtyninecommerce/admin 0.11.0 → 0.13.0

package/dist/stock/settings.d.ts

@@ -0,0 +1,106 @@
+import { type Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+/** The store's default for ordering beyond saleable stock: never, up to stock on order, any quantity. */
+export type StockBackorderPolicy = 'deny' | 'incoming' | 'unlimited';
+/**
+ * How the storefront warehouse selection reads: `ALL` (no selection, every warehouse), `SUBSET`
+ * (only the listed ones), or `MALFORMED` (the stored value cannot be read; the engine sells from
+ * every warehouse and logs it, and saving a selection replaces it).
+ */
+export type StorefrontStockLocationSelectionMode = 'ALL' | 'SUBSET' | 'MALFORMED';
+export interface StorefrontStockLocations {
+    mode: StorefrontStockLocationSelectionMode;
+    /** The selected stock location ids, trimmed and de-duplicated (`SUBSET` only); else empty. */
+    locationIds: string[];
+    /** Why the stored value cannot be read (`MALFORMED` only); else null. */
+    reason: string | null;
+}
+/** A store's stock settings as the engine reads them. */
+export interface StockSettings {
+    /** The channel the settings are stored on. */
+    channelId: string;
+    /**
+     * The store's own "track inventory" value; `null` = the store inherits
+     * {@link defaultTrackInventory}. It decides availability for this store's customers: a variant
+     * set to inherit tracks by it (a variant's own `TRUE`/`FALSE` wins), and an untracked variant
+     * is always available (saleable stock, add to cart, checkout, the storefront `stockLevel`,
+     * search, the till, feeds).
+     */
+    trackInventory: boolean | null;
+    /**
+     * The store's own out-of-stock threshold; `null` = the store inherits
+     * {@link defaultOutOfStockThreshold}. A variant on the global threshold (its own threshold
+     * wins otherwise, and a warehouse's own threshold wins at that warehouse) is unavailable once
+     * its stock on hand less allocations falls to it.
+     */
+    outOfStockThreshold: number | null;
+    /** The platform default a store that inherits tracks by. */
+    defaultTrackInventory: boolean;
+    /** The platform default threshold a store that inherits uses. */
+    defaultOutOfStockThreshold: number;
+    /** Whether the Shop API exposes operational stock numbers (on hand, allocated, saleable). */
+    exposeStockToStorefront: boolean;
+    /** Which warehouses back the storefront's saleable stock and its orders' reservations. */
+    storefrontStockLocations: StorefrontStockLocations;
+    /** The store's backorder default; a variant may override it. Unreadable reads `deny`. */
+    backorderPolicy: StockBackorderPolicy;
+}
+/** A change to the stock settings. An omitted field keeps the stored value. */
+export interface StockSettingsPatch {
+    /**
+     * `null` = inherit the platform default. Changes which of this store's variants are available
+     * (see {@link StockSettings.trackInventory}).
+     */
+    trackInventory?: boolean | null;
+    /** `null` = inherit the platform default (see {@link StockSettings.outOfStockThreshold}). */
+    outOfStockThreshold?: number | null;
+    exposeStockToStorefront?: boolean;
+    /** Stock location ids of the store; `[]` clears the selection (every warehouse). */
+    storefrontStockLocationIds?: string[];
+    backorderPolicy?: StockBackorderPolicy;
+}
+/**
+ * The ACTIVE store's stock settings (`admin.stock.settings`). Reading needs any administrator
+ * permission on the store; writing needs `UpdateChannel` (the settings are stored on the channel
+ * and written through core `updateChannel`).
+ *
+ * The engine owns every rule: how a stored value reads is never worked out in the client. Ask
+ * {@link preview} for a change that is not saved.
+ */
+export interface StockSettingsModule {
+    /**
+     * The settings as the engine reads them. An unreadable warehouse selection is `MALFORMED`, an
+     * unreadable backorder policy is `deny`, an unreadable exposure flag is off.
+     *
+     * @effect read
+     */
+    get(options?: Call): Promise<StockSettings>;
+    /**
+     * How the settings WOULD read with `patch` applied, without saving anything.
+     *
+     * Refused `CHANNEL_SETTINGS_INVALID` (`ValidationError`, one `details[]` entry per field, named
+     * like `customFields.backorderPolicy`) for a change the save would refuse: a `null` track
+     * inventory, threshold, exposure flag or policy, a policy that is not exactly one of the values,
+     * a blank warehouse id, or more than 500 warehouses. A malformed warehouse id is refused
+     * `ENTITY_NOT_FOUND` (`NotFoundError`).
+     *
+     * @effect read
+     */
+    preview(patch: StockSettingsPatch, options?: Call): Promise<StockSettings>;
+    /**
+     * Save `patch`, and answer the settings as the engine now reads them. Only the fields named are
+     * written; the warehouse list is stored as the engine reads it (trimmed, de-duplicated, `[]` as
+     * no selection).
+     *
+     * Refused, before anything is written, as {@link preview} refuses. Refused by the save itself:
+     * `FORBIDDEN` without `UpdateChannel`. A warehouse id that is not a stock location of the store
+     * is stored and ignored by the engine (it never widens the store's warehouses).
+     *
+     * @effect write
+     */
+    set(patch: StockSettingsPatch, options?: Call): Promise<StockSettings>;
+}
+export declare const STOCK_SETTINGS_QUERY = "\n  query StockSettings {\n    stockSettings { \n  channelId\n  trackInventory\n  outOfStockThreshold\n  defaultTrackInventory\n  defaultOutOfStockThreshold\n  exposeStockToStorefront\n  storefrontStockLocations {\n    mode\n    locationIds\n    reason\n  }\n  backorderPolicy\n }\n  }\n";
+export declare const PREVIEW_STOCK_SETTINGS_QUERY = "\n  query PreviewStockSettings($input: StockSettingsInput!) {\n    previewStockSettings(input: $input) { \n  channelId\n  trackInventory\n  outOfStockThreshold\n  defaultTrackInventory\n  defaultOutOfStockThreshold\n  exposeStockToStorefront\n  storefrontStockLocations {\n    mode\n    locationIds\n    reason\n  }\n  backorderPolicy\n }\n  }\n";
+export declare const SET_STOCK_SETTINGS_MUTATION = "\n  mutation SetStockSettings($input: UpdateChannelInput!) {\n    updateChannel(input: $input) {\n      ... on Channel { id }\n      ... on ErrorResult { errorCode message }\n    }\n  }\n";
+export declare function createStockSettingsModule(transport: Transport): StockSettingsModule;

package/dist/stock/settings.js

@@ -0,0 +1,103 @@
+import { errorFromErrorResult, isErrorResult, } from '@sixtyninecommerce/core';
+const VIEW_FIELDS = /* GraphQL */ `
+  channelId
+  trackInventory
+  outOfStockThreshold
+  defaultTrackInventory
+  defaultOutOfStockThreshold
+  exposeStockToStorefront
+  storefrontStockLocations {
+    mode
+    locationIds
+    reason
+  }
+  backorderPolicy
+`;
+export const STOCK_SETTINGS_QUERY = /* GraphQL */ `
+  query StockSettings {
+    stockSettings { ${VIEW_FIELDS} }
+  }
+`;
+export const PREVIEW_STOCK_SETTINGS_QUERY = /* GraphQL */ `
+  query PreviewStockSettings($input: StockSettingsInput!) {
+    previewStockSettings(input: $input) { ${VIEW_FIELDS} }
+  }
+`;
+export const SET_STOCK_SETTINGS_MUTATION = /* GraphQL */ `
+  mutation SetStockSettings($input: UpdateChannelInput!) {
+    updateChannel(input: $input) {
+      ... on Channel { id }
+      ... on ErrorResult { errorCode message }
+    }
+  }
+`;
+/** Exactly the fields the patch names: an omitted one keeps the stored value. */
+function inputOf(patch) {
+    const input = {};
+    if (patch.trackInventory !== undefined)
+        input.trackInventory = patch.trackInventory;
+    if (patch.outOfStockThreshold !== undefined)
+        input.outOfStockThreshold = patch.outOfStockThreshold;
+    if (patch.exposeStockToStorefront !== undefined) {
+        input.exposeStockToStorefront = patch.exposeStockToStorefront;
+    }
+    if (patch.storefrontStockLocationIds !== undefined) {
+        input.storefrontStockLocationIds = [...patch.storefrontStockLocationIds];
+    }
+    if (patch.backorderPolicy !== undefined)
+        input.backorderPolicy = patch.backorderPolicy;
+    return input;
+}
+export function createStockSettingsModule(transport) {
+    const get = async (options) => {
+        const data = await transport.graphql({ api: 'admin', query: STOCK_SETTINGS_QUERY }, options);
+        return data.stockSettings;
+    };
+    const preview = async (patch, options) => {
+        const data = await transport.graphql({
+            api: 'admin',
+            query: PREVIEW_STOCK_SETTINGS_QUERY,
+            variables: { input: inputOf(patch) },
+        }, options);
+        return data.previewStockSettings;
+    };
+    return {
+        get,
+        preview,
+        async set(patch, options) {
+            // The engine judges the change first (its refusal is the save's) and answers the channel id
+            // and the warehouse list as it reads it, so the client keeps no copy of either rule.
+            const judged = await preview(patch, options);
+            const input = inputOf(patch);
+            const customFields = {};
+            if ('exposeStockToStorefront' in input) {
+                customFields.exposeStockToStorefront = input.exposeStockToStorefront;
+            }
+            if ('backorderPolicy' in input)
+                customFields.backorderPolicy = input.backorderPolicy;
+            if ('storefrontStockLocationIds' in input) {
+                const selection = judged.storefrontStockLocations;
+                // `null` is the column's "no selection", and the only value that clears a stored list.
+                customFields.storefrontStockLocationIds =
+                    selection.mode === 'SUBSET' ? JSON.stringify(selection.locationIds) : null;
+            }
+            const data = await transport.graphql({
+                api: 'admin',
+                query: SET_STOCK_SETTINGS_MUTATION,
+                variables: {
+                    input: {
+                        id: judged.channelId,
+                        ...('trackInventory' in input ? { trackInventory: input.trackInventory } : {}),
+                        ...('outOfStockThreshold' in input
+                            ? { outOfStockThreshold: input.outOfStockThreshold }
+                            : {}),
+                        ...(Object.keys(customFields).length > 0 ? { customFields } : {}),
+                    },
+                },
+            }, options);
+            if (isErrorResult(data.updateChannel))
+                throw errorFromErrorResult(data.updateChannel);
+            return get(options);
+        },
+    };
+}

package/dist/stock/transfers.d.ts

@@ -5,6 +5,32 @@ import type { Call, ListOptions } from '../types.js';
 export type StockTransferState = 'draft' | 'in_transit' | 'received' | 'cancelled';
 /** A `transfer` moves stock between two locations; a `consumption` uses it up at one. */
 export type StockTransferKind = 'transfer' | 'consumption';
+/**
+ * Why the engine would refuse a cancel or a return of a transfer now.
+ *
+ * - `STATE`: the state has no way to it (a cancel of a received transfer or a posted consumption).
+ * - `CANCELLED`: the transfer is cancelled.
+ * - `PARTIALLY_RECEIVED`: a cancel once any unit was received; `close` it instead.
+ * - `DRAFT_NOT_SHIPPED`: a return of a draft: nothing has moved yet.
+ * - `NOT_YET_RECEIVED`: a return of a transfer in transit that has received nothing yet.
+ * - `NOTHING_RECEIVED`: a return of a received transfer that received nothing.
+ * - `ALL_ON_RETURNS`: every received unit is already on a return; cancelling one frees its units.
+ * - `CONSUMPTION`, `IS_RETURN`, `NO_DESTINATION`: a return of a consumption, of a return, or
+ *   of a transfer with no destination.
+ *
+ * Codes may be added; treat an unknown one as a refusal.
+ */
+export type StockTransferActionRefusalCode = 'STATE' | 'CANCELLED' | 'PARTIALLY_RECEIVED' | 'DRAFT_NOT_SHIPPED' | 'NOT_YET_RECEIVED' | 'NOTHING_RECEIVED' | 'ALL_ON_RETURNS' | 'CONSUMPTION' | 'IS_RETURN' | 'NO_DESTINATION';
+/**
+ * Whether an action on a transfer is available now, as the engine judges it, and why not.
+ * Advice only: the write judges again (with the caller's permission and locations), so a
+ * transfer that changed meanwhile is still refused.
+ */
+export interface StockTransferActionAvailability {
+    available: boolean;
+    /** Null exactly when `available`. */
+    reasonCode: StockTransferActionRefusalCode | null;
+}
 /**
  * What `search` matches in `list`: the transfer code only (`code`, the engine's default), or the
  * code or the label (`all`).
@@ -330,6 +356,12 @@ export interface StockTransferReturns {
      * return, or a transfer with nothing received.
      */
     returnableLines: StockTransferReturnableLine[];
+    /**
+     * Whether `createReturn` can make a return of it now, and why not (the engine's own rule).
+     * Null from an engine before the field: it says nothing either way, and `createReturn` still
+     * judges.
+     */
+    returnAvailability: StockTransferActionAvailability | null;
 }
 /**
  * The administrator who acted on a transfer. Usually a member of staff; an app installation or
@@ -368,6 +400,11 @@ export interface StockTransferCancellation {
     hendriksExport: {
         bluJayOrderNumber: string | null;
     } | null;
+    /**
+     * Whether `cancel` would accept it now, and why not (the engine's own rule). Null from an
+     * engine before the field: it says nothing either way, and `cancel` still judges.
+     */
+    cancelAvailability: StockTransferActionAvailability | null;
 }
 /** One MyParcel parcel of a stock transfer: its own shipment, label and barcode. */
 export interface StockTransferParcel {
@@ -430,6 +467,62 @@ export interface StockTransferLabel {
     filename: string;
     bytes: Uint8Array;
 }
+/**
+ * The format of a store's transfer codes: `{prefix}{year}-{number}{suffix}`, e.g. `ST-2026-0001`
+ * (the defaults, until the store first sets its own).
+ */
+export interface StockTransferNumberingConfig {
+    prefix: string;
+    suffix: string;
+    /** How many digits the number is padded to, 3 to 8. */
+    digits: number;
+    /**
+     * `none`, `short` (`26`) or `full` (`2026`). A row written before the engine checked it may
+     * hold another value, which prints like `none`.
+     */
+    yearFormat: string;
+    /**
+     * Stored for the shared numbering contract only: the counter restarts each UTC year whenever
+     * the code shows the year, and never when it does not, whatever this says.
+     */
+    yearReset: boolean;
+}
+/** A patch: a field left out keeps its value. */
+export interface UpdateStockTransferNumberingConfigInput {
+    prefix?: string;
+    suffix?: string;
+    /** Clamped to 3..8. */
+    digits?: number;
+    /**
+     * `none`, `short` or `full`. Any other CHANGE is refused `NUMBERING_YEAR_FORMAT_INVALID`
+     * (→ `ValidationError`) and saves nothing; sending the stored value back always passes.
+     */
+    yearFormat?: string;
+    yearReset?: boolean;
+}
+/** `admin.stock.transfers.numbering`: the format the store's transfer codes take. */
+export interface StockTransferNumberingModule {
+    /**
+     * The format the store's NEXT transfer code takes. A store in an organization that shares its
+     * numbering formats (`settings.numbering_formats`) reads the organization's format; the counter
+     * is always the store's own. Needs `ReadStockLocation`.
+     *
+     * @effect read
+     * @permission ReadStockLocation
+     */
+    get(options?: Call): Promise<StockTransferNumberingConfig>;
+    /**
+     * Change the format of the store's OWN row; codes already issued keep theirs, and the counter
+     * never changes. Answers that row, which is not what `get` reads while the store inherits the
+     * organization's format: read `get` again for the format in use. A store that inherits it is
+     * refused `ORGANIZATION_SETTINGS_INHERITED` until it overrides the group, and one whose
+     * organization locks the group `MANAGED_BY_ORGANIZATION`. Needs `UpdateStockLocation`.
+     *
+     * @effect write
+     * @permission UpdateStockLocation
+     */
+    set(input: UpdateStockTransferNumberingConfigInput, options?: Call): Promise<StockTransferNumberingConfig>;
+}
 /**
  * Stock transfers (the engine's stock-transfer module, wrapped): a draft is
  * created, shipped (debiting the source), received line by line (crediting the
@@ -570,7 +663,8 @@ export interface StockTransfersModule {
      * source). An in-transit MyParcel shipment's parcels are voided at MyParcel
      * inside the call, so it is allowed up to 120s. A cancelled transfer is
      * final: cancelling it again is refused (`ValidationError`) and restores
-     * nothing twice. An in-transit cancel is refused `FIELD_GROUP_LOCKED`
+     * nothing twice. Whether it would be accepted now, and why not, is
+     * `cancellation(id).cancelAvailability`. An in-transit cancel is refused `FIELD_GROUP_LOCKED`
      * (`BusinessRuleError`) while an app or API key owns the store's Stock.
      *
      * @effect destructive
@@ -592,9 +686,14 @@ export interface StockTransfersModule {
     createReturn(id: string, input: CreateStockTransferReturnInput, options?: Call): Promise<StockTransferDetail>;
     /**
      * How transfer `id` is linked to returns — the transfer it returns from, its
-     * own returns, and what a new return may still take per variant — or null
-     * when this store has no such transfer. Its own request, never part of
-     * `get`. Needs `ReadStockLocation`.
+     * own returns, what a new return may still take per variant, and whether
+     * `createReturn` can make one now (`returnAvailability`, the engine's own
+     * rule: `createReturn` judges again, per line) — or null when this store has
+     * no such transfer. Its own request, never part of `get`. Needs
+     * `ReadStockLocation`.
+     *
+     * @effect read
+     * @permission ReadStockLocation
      */
     returns(id: string, options?: Call): Promise<StockTransferReturns | null>;
     /**
@@ -607,10 +706,14 @@ export interface StockTransfersModule {
     /**
      * Who cancelled transfer `id`, why, and the Hendriks export a cancel leaves
      * to be retracted by hand — or null when this store has no such transfer.
-     * Read it before `cancel` to warn about the export, and after to show who
-     * did it. Its own request, never part of `get`: a caller deployed ahead of
-     * an engine that does not record the canceller sees only this call refused.
-     * Needs `ReadStockLocation`.
+     * Read it before `cancel` to warn about the export and to know whether the
+     * cancel is offered (`cancelAvailability`, the engine's own rule: `cancel`
+     * judges again, with the caller's permission and locations), and after to
+     * show who did it. Its own request, never part of `get`: a caller deployed
+     * ahead of the engine sees only this call refused. Needs `ReadStockLocation`.
+     *
+     * @effect read
+     * @permission ReadStockLocation
      */
     cancellation(id: string, options?: Call): Promise<StockTransferCancellation | null>;
     /**
@@ -660,6 +763,59 @@ export interface StockTransfersModule {
      * default timeout does not cover.
      */
     myparcelLabel(id: string, format: StockTransferLabelFormat, options?: Call): Promise<StockTransferLabel>;
+    /**
+     * Void an in-transit shipment back to an editable draft, to correct a wrong handler or carrier
+     * and ship again. It undoes `ship`: the units go back to the source, every MyParcel parcel is
+     * voided at MyParcel inside the call, and the handler, its arguments, the carrier, tracking
+     * code, ETA, parcels and transfer note are cleared (the delivery address stays, for the
+     * re-ship). Answers the draft.
+     *
+     * MyParcel deletes only a concept: a parcel it keeps (a registered label) is named on
+     * `parcels(id).lastError`, recorded in `unretractedShipments` and never adopted by a re-ship.
+     * A Hendriks export, or any other handler's shipment, is NOT withdrawn: it is voided here only,
+     * and must be retracted at the 3PL by hand.
+     *
+     * Refused (`ValidationError`) for a transfer not in transit, so a repeat restores nothing
+     * twice, and once any unit was received or lost (close or cancel it instead). Refused
+     * `FIELD_GROUP_LOCKED` (`BusinessRuleError`) while an app or API key owns the store's Stock. A
+     * restricted credential must hold the source. The MyParcel calls make it allowed up to 120s;
+     * a `REQUEST_TIMEOUT` does not mean it failed, so `get` the transfer before trying again.
+     *
+     * @effect destructive
+     * @permission AdjustStock
+     */
+    removeShipment(id: string, options?: Call): Promise<StockTransferDetail>;
+    /**
+     * Upload the Hendriks (BluJay) export again for an in-transit transfer shipped with Hendriks
+     * whose export did not land at ship time (`hendriksRemotePath` still null). It reuses the
+     * transfer's BluJay order number and moves no stock. Answers the transfer with its
+     * `hendriksRemotePath`; an upload that fails is thrown, in the engine's words.
+     *
+     * Refused (`ValidationError`) for a transfer not shipped with Hendriks, not in transit, or
+     * already exported: a second retry waits for the first under the transfer's lock and is then
+     * refused, so one transfer never sends Hendriks two orders. A store without the Hendriks plugin
+     * is refused (`ValidationError`) too; one whose Hendriks set-up is missing or switched off is
+     * refused with no code yet, so that arrives as a `GRAPHQL_ERROR` (status 500) in the engine's
+     * words, and nothing is uploaded. A restricted credential must hold the source. The
+     * upload makes it allowed up to 120s; a `REQUEST_TIMEOUT` does not mean it failed, so `get` the
+     * transfer and look at `hendriksRemotePath` before trying again.
+     *
+     * @effect irreversible
+     * @permission AdjustStock
+     */
+    retryHendriksExport(id: string, options?: Call): Promise<StockTransferDetail>;
+    /**
+     * Generate the transfer's note (a consumption's: its consumption note) again and store it;
+     * answers the transfer with the new `pdfStorageKey`. Refused (`ValidationError`) for a draft.
+     * A store without document storage set up answers the transfer unchanged. A restricted
+     * credential must hold either end.
+     *
+     * @effect write
+     * @permission AdjustStock
+     */
+    regeneratePdf(id: string, options?: Call): Promise<StockTransferDetail>;
+    /** The format of the store's transfer codes. */
+    numbering: StockTransferNumberingModule;
 }
 export declare const STOCK_TRANSFERS_QUERY = "\n  query StockTransfers($options: StockTransferListOptions) {\n    stockTransfers(options: $options) { items { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  initiatedBy { id firstName lastName }\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n  }\n  totalLines\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n } totalItems }\n  }\n";
 export declare const STOCK_TRANSFER_QUERY = "\n  query StockTransfer($id: ID!) { stockTransfer(id: $id) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name customFields { address } }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n } }\n";
@@ -677,7 +833,12 @@ export declare const CLOSE_STOCK_TRANSFER_MUTATION = "\n  mutation CloseStockTra
 export declare const CLOSE_STOCK_TRANSFER_WITH_SHORTFALL_MUTATION = "\n  mutation CloseStockTransferWithShortfall(\n    $id: ID!\n    $acceptShortfallAsLost: Boolean\n    $shortfall: [StockTransferShortfallLineInput!]!\n  ) {\n    closeStockTransfer(\n      id: $id\n      acceptShortfallAsLost: $acceptShortfallAsLost\n      shortfall: $shortfall\n    ) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name customFields { address } }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
 export declare const CANCEL_STOCK_TRANSFER_MUTATION = "\n  mutation CancelStockTransfer($id: ID!, $reason: String) {\n    cancelStockTransfer(id: $id, reason: $reason) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name customFields { address } }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
 export declare const CREATE_STOCK_TRANSFER_RETURN_MUTATION = "\n  mutation CreateStockTransferReturn($id: ID!, $input: CreateStockTransferReturnInput!) {\n    createStockTransferReturn(id: $id, input: $input) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name customFields { address } }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
-export declare const STOCK_TRANSFER_RETURNS_QUERY = "\n  query StockTransferReturns($id: ID!) {\n    stockTransfer(id: $id) {\n      returnOfTransferId\n      returnOf { \n  id\n  code\n  state\n  label\n  sourceLocation { id name }\n  destinationLocation { id name }\n  createdAt\n  totalQuantity\n }\n      returns { \n  id\n  code\n  state\n  label\n  sourceLocation { id name }\n  destinationLocation { id name }\n  createdAt\n  totalQuantity\n }\n      returnableLines {\n        productVariantId\n        productVariant { name sku }\n        receivedQuantity\n        returnedQuantity\n        returnableQuantity\n      }\n    }\n  }\n";
+export declare const REMOVE_STOCK_TRANSFER_SHIPMENT_MUTATION = "\n  mutation RemoveStockTransferShipment($id: ID!) {\n    removeStockTransferShipment(id: $id) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name customFields { address } }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+export declare const RETRY_STOCK_TRANSFER_HENDRIKS_EXPORT_MUTATION = "\n  mutation RetryStockTransferHendriksExport($id: ID!) {\n    retryStockTransferHendriksExport(id: $id) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name customFields { address } }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+export declare const REGENERATE_STOCK_TRANSFER_PDF_MUTATION = "\n  mutation RegenerateStockTransferPdf($id: ID!) {\n    regenerateStockTransferPdf(id: $id) { \n  id\n  code\n  kind\n  state\n  sourceLocation { id name }\n  destinationLocation { id name customFields { address } }\n  label\n  note\n  carrier\n  trackingCode\n  estimatedArrivalAt\n  shippedAt\n  receivedAt\n  cancelledAt\n  cancelReason\n  deliveryAddress {\n    contactName\n    company\n    streetLine1\n    streetLine2\n    city\n    province\n    postalCode\n    countryCode\n    phoneNumber\n  }\n  createdAt\n  updatedAt\n  initiatedBy { id firstName lastName }\n  shippedBy { id firstName lastName }\n  receivedBy { id firstName lastName }\n  consumptionTotalValue\n  consumptionHasUnpricedLines\n  pdfStorageKey\n  fulfillmentHandlerCode\n  handlerArgs\n  myparcelShipmentId\n  myparcelBarcode\n  hendriksRemotePath\n  items {\n    id\n    productVariant { id name sku }\n    quantity\n    receivedQuantity\n    lostQuantity\n    outstandingQuantity\n    unitCost\n  }\n  totalLines\n  totalQuantity\n  totalReceivedQuantity\n  totalLostQuantity\n }\n  }\n";
+export declare const STOCK_TRANSFER_NUMBERING_QUERY = "\n  query StockTransferNumberingConfig {\n    stockTransferNumberingConfig { \n  prefix\n  suffix\n  digits\n  yearFormat\n  yearReset\n }\n  }\n";
+export declare const UPDATE_STOCK_TRANSFER_NUMBERING_MUTATION = "\n  mutation UpdateStockTransferNumberingConfig($input: UpdateStockTransferNumberingConfigInput!) {\n    updateStockTransferNumberingConfig(input: $input) { \n  prefix\n  suffix\n  digits\n  yearFormat\n  yearReset\n }\n  }\n";
+export declare const STOCK_TRANSFER_RETURNS_QUERY = "\n  query StockTransferReturns($id: ID!) {\n    stockTransfer(id: $id) {\n      returnOfTransferId\n      returnOf { \n  id\n  code\n  state\n  label\n  sourceLocation { id name }\n  destinationLocation { id name }\n  createdAt\n  totalQuantity\n }\n      returns { \n  id\n  code\n  state\n  label\n  sourceLocation { id name }\n  destinationLocation { id name }\n  createdAt\n  totalQuantity\n }\n      returnableLines {\n        productVariantId\n        productVariant { name sku }\n        receivedQuantity\n        returnedQuantity\n        returnableQuantity\n      }\n      returnAvailability { available reasonCode }\n    }\n  }\n";
 /** The per-line settlement fields, in a document of their own like the return fields. */
 export declare const STOCK_TRANSFER_SHORTFALL_QUERY = "\n  query StockTransferShortfall($id: ID!) {\n    stockTransfer(id: $id) {\n      id\n      state\n      items {\n        id\n        productVariant { id sku }\n        quantity\n        receivedQuantity\n        lostQuantity\n        returnedToSourceQuantity\n        outstandingQuantity\n      }\n      totalLostQuantity\n      totalReturnedToSourceQuantity\n    }\n  }\n";
 /**
@@ -685,7 +846,7 @@ export declare const STOCK_TRANSFER_SHORTFALL_QUERY = "\n  query StockTransferSh
  * parcel fields: `cancelledBy` is newer than the transfer module, and
  * `get`/`list`/`cancel` keep working against an engine without it.
  */
-export declare const STOCK_TRANSFER_CANCELLATION_QUERY = "\n  query StockTransferCancellation($id: ID!) {\n    stockTransfer(id: $id) {\n      id\n      state\n      cancelledAt\n      cancelReason\n      cancelledBy { id firstName lastName }\n      fulfillmentHandlerCode\n      hendriksRemotePath\n      hendriksBluJayOrderNumber\n    }\n  }\n";
+export declare const STOCK_TRANSFER_CANCELLATION_QUERY = "\n  query StockTransferCancellation($id: ID!) {\n    stockTransfer(id: $id) {\n      id\n      state\n      cancelledAt\n      cancelReason\n      cancelledBy { id firstName lastName }\n      fulfillmentHandlerCode\n      hendriksRemotePath\n      hendriksBluJayOrderNumber\n      cancelAvailability { available reasonCode }\n    }\n  }\n";
 export declare const STOCK_TRANSFER_PARCELS_QUERY = "\n  query StockTransferParcels($id: ID!) { stockTransfer(id: $id) { \n  id\n  state\n  fulfillmentHandlerCode\n  parcelCount\n  myparcelParcels { ordinal shipmentId barcode labelReady lastError }\n  trackingCodes\n  myparcelBarcode\n  myparcelLastError\n  myparcelUnretractedShipments { \n  shipmentId\n  reference\n  verdict\n  status\n  statusName\n  billable\n  hidden\n  reason\n  cause\n  firstRecordedAt\n  lastCheckedAt\n  resolvedAt\n }\n } }\n";
 export declare const RETRY_STOCK_TRANSFER_MYPARCEL_SHIPMENTS_MUTATION = "\n  mutation RetryStockTransferMyparcelShipments($id: ID!) {\n    retryStockTransferMyparcelShipments(id: $id) { \n  id\n  state\n  fulfillmentHandlerCode\n  parcelCount\n  myparcelParcels { ordinal shipmentId barcode labelReady lastError }\n  trackingCodes\n  myparcelBarcode\n  myparcelLastError\n  myparcelUnretractedShipments { \n  shipmentId\n  reference\n  verdict\n  status\n  statusName\n  billable\n  hidden\n  reason\n  cause\n  firstRecordedAt\n  lastCheckedAt\n  resolvedAt\n }\n }\n  }\n";
 export declare const LABEL_STOCK_TRANSFER_MYPARCEL_PARCELS_MUTATION = "\n  mutation LabelStockTransferMyparcelParcels($id: ID!) {\n    labelStockTransferMyparcelParcels(id: $id) { \n  id\n  state\n  fulfillmentHandlerCode\n  parcelCount\n  myparcelParcels { ordinal shipmentId barcode labelReady lastError }\n  trackingCodes\n  myparcelBarcode\n  myparcelLastError\n  myparcelUnretractedShipments { \n  shipmentId\n  reference\n  verdict\n  status\n  statusName\n  billable\n  hidden\n  reason\n  cause\n  firstRecordedAt\n  lastCheckedAt\n  resolvedAt\n }\n }\n  }\n";

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
@@ -167,6 +168,38 @@ export const CREATE_STOCK_TRANSFER_RETURN_MUTATION = /* GraphQL */ `
     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} }
+  }
+`;
 /**
  * The return fields, in a document of their own like the parcel fields below:
  * `get`/`list` keep working against an engine without them.
@@ -194,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!) {
@@ -247,6 +290,7 @@ export const STOCK_TRANSFER_CANCELLATION_QUERY = /* GraphQL */ `
       fulfillmentHandlerCode
       hendriksRemotePath
       hendriksBluJayOrderNumber
+      cancelAvailability { available reasonCode }
     }
   }
 `;
@@ -293,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;
 /**
@@ -346,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) {
@@ -433,8 +479,20 @@ 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) {
@@ -520,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) {
@@ -528,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) {
@@ -560,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;
+            },
+        },
     };
 }