@sixtyninecommerce/admin 0.10.0 → 0.11.0

package/dist/shipping/rate-tables.d.ts

@@ -0,0 +1,179 @@
+import { type Transport } from '@sixtyninecommerce/core';
+import type { Call } from '../types.js';
+/**
+ * A weight-zone rate table: what the `weight-zone-calculator` of a shipping method prices with.
+ * The engine calls it a `ShippingZoneConfig`; a method names it in its calculator argument
+ * `shippingZoneConfigId`.
+ */
+export interface RateTableSummary {
+    id: string;
+    /** Unique within the store. */
+    name: string;
+    /**
+     * Turns a variant's package dimensions into a volumetric weight: length × width × height in cm,
+     * divided by this, is kilograms. An order is charged for the greater of its actual and its
+     * volumetric weight. `0` prices by actual weight only.
+     */
+    volumetricDivisor: number;
+    /** Grams a line weighs when its variant has no package weight; null weighs it as nothing. */
+    defaultWeightGrams: number | null;
+    /** A switched-off table prices nothing: every method using it quotes nothing. */
+    enabled: boolean;
+    /** ISO-8601, UTC. */
+    createdAt: string;
+    /** ISO-8601, UTC. */
+    updatedAt: string;
+}
+/** A place a domestic zone matches by postal code, or an international zone by country. */
+export interface RateTableZoneMember {
+    id: string;
+    /** ISO 3166-1 alpha-2; an international zone's member. */
+    countryCode: string | null;
+    /** First digits of a postal code, start of the range; a domestic zone's member. */
+    postalCodeFrom: string | null;
+    /** End of the range, inclusive. */
+    postalCodeTo: string | null;
+}
+/** One weight tier's price in one currency. */
+export interface RateTableRate {
+    id: string;
+    /** Inclusive. */
+    minWeightGrams: number;
+    /** Exclusive: the tier covers weights from its start up to, not including, this. */
+    maxWeightGrams: number;
+    /** In MINOR units of {@link currencyCode}, in the tax basis the method's calculator says. */
+    price: number;
+    /** ISO 4217. */
+    currencyCode: string;
+}
+/** One zone of a rate table. */
+export interface RateTableZone {
+    id: string;
+    name: string;
+    /**
+     * `domestic` matches its members' postal-code ranges, `international` their countries. A zone
+     * stored before the engine judged the type may hold another word, which prices as
+     * `international`.
+     */
+    type: string;
+    /** Zones are matched in position order; the first that matches the address prices the order. */
+    position: number;
+    members: RateTableZoneMember[];
+    /**
+     * In start-weight order. An order is priced with the tier of its own currency that covers its
+     * weight; without one, with the store's default-currency tier converted at the checkout's
+     * exchange rate; without either, the method quotes nothing.
+     */
+    rates: RateTableRate[];
+    /** ISO-8601, UTC. */
+    createdAt: string;
+    /** ISO-8601, UTC. */
+    updatedAt: string;
+}
+/** A rate table with its zones, as {@link RateTablesModule.get} reads it. */
+export interface RateTable extends RateTableSummary {
+    /** In position order. */
+    zones: RateTableZone[];
+}
+/** A new rate table, as {@link RateTablesModule.create} takes it. It starts switched on. */
+export interface CreateRateTableInput {
+    /** Trimmed; at most 255 characters. */
+    name: string;
+    /** Left out: 5000. See {@link RateTableSummary.volumetricDivisor}. */
+    volumetricDivisor?: number;
+    /** Left out or null: none. See {@link RateTableSummary.defaultWeightGrams}. */
+    defaultWeightGrams?: number | null;
+}
+/** A change to a rate table: a field left out keeps what the table has. */
+export interface UpdateRateTableInput {
+    name?: string;
+    volumetricDivisor?: number;
+    /** `null` clears it. */
+    defaultWeightGrams?: number | null;
+    enabled?: boolean;
+}
+/**
+ * `admin.shipping.rateTables`: the store's weight-zone rate tables (headless spec §9.2
+ * `shipping`, "zones, calculator config"). Scoped to the store the client is on: another
+ * store's table is not listed, reads as null and is refused as not found, whatever its id.
+ *
+ * Every refusal of the engine's rate-table doors carries a code:
+ *
+ * - `SHIPPING_ZONE_INPUT_INVALID` (`ValidationError`, 400): what was sent cannot be stored.
+ *   `error.details[]` names EVERY problem of the save at once, each with `field`, a JSON Pointer
+ *   into the arguments (`/input/name`, `/input/volumetricDivisor`), and `code`, the rule broken
+ *   (`required`, `type`, `minimum`, `maximum`, `maxLength`). The SDK raises the same code, with
+ *   the same pointers, for a value it cannot send at all (not a string, not a whole number
+ *   GraphQL's `Int` carries), before anything leaves.
+ * - `SHIPPING_ZONE_CONFIG_NAME_TAKEN` (`ConflictError`, 409): another table of this store has
+ *   the name (`details[0].field` is `/input/name`). Another store's names are free.
+ * - `SHIPPING_ZONE_CONFIG_IN_USE` (`BusinessRuleError`, 422): a delete of a table a shipping
+ *   method of this store prices with. The message names the methods (three, then "and N more");
+ *   the engine also lists them as `extensions.shippingMethods` (`{ id, code, name }`), which this
+ *   SDK does not lift onto the error. Nothing is deleted.
+ * - `ENTITY_NOT_FOUND` (`NotFoundError`, 404): an update of a table the store does not have (a
+ *   missing, malformed or another store's id read alike).
+ * - `FORBIDDEN` (`PermissionDeniedError`, 403): reads need `ReadSettings`, writes
+ *   `UpdateSettings` (a create and a delete too).
+ *
+ * Every write runs in one transaction: a refused write changes nothing.
+ */
+export interface RateTablesModule {
+    /**
+     * Every rate table of the store, switched off or not, newest first. Not paged: a store has a
+     * handful.
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    list(options?: Call): Promise<RateTableSummary[]>;
+    /**
+     * One rate table with its zones, their members and rates, or `null` when the store has no
+     * such table (a missing, malformed or another store's id read alike).
+     *
+     * @effect read
+     * @permission ReadSettings
+     */
+    get(id: string, options?: Call): Promise<RateTable | null>;
+    /**
+     * Add a rate table to the store, switched on and with no zones, and answer it as {@link get}
+     * reads it. Refused `SHIPPING_ZONE_INPUT_INVALID` (a blank or too long name, a negative
+     * divisor or default weight) or `SHIPPING_ZONE_CONFIG_NAME_TAKEN`.
+     *
+     * @effect write
+     * @permission UpdateSettings
+     */
+    create(input: CreateRateTableInput, options?: Call): Promise<RateTable>;
+    /**
+     * Change a rate table, and answer it as {@link get} reads it. Every method pricing with it
+     * quotes by the change from the next quote on, and switching it off makes them quote nothing
+     * (allowed: it is the switch's purpose, and it is undone by switching it back on).
+     *
+     * Refused `SHIPPING_ZONE_INPUT_INVALID` (as {@link create}, and `null` for the name, the
+     * divisor or `enabled`, which cannot be cleared), `SHIPPING_ZONE_CONFIG_NAME_TAKEN` or
+     * `ENTITY_NOT_FOUND`.
+     *
+     * @effect write
+     * @permission UpdateSettings
+     */
+    update(id: string, patch: UpdateRateTableInput, options?: Call): Promise<RateTable>;
+    /**
+     * Delete a rate table with its zones, members and rates. Refused
+     * `SHIPPING_ZONE_CONFIG_IN_USE` while a shipping method of this store prices with it (give the
+     * method another table, or delete it, first).
+     *
+     * The engine answers a table the store does not have (a missing, malformed or another store's
+     * id, or one already deleted) as a result rather than an error; this SDK raises it as
+     * `SHIPPING_ZONE_CONFIG_NOT_DELETED` (`ConflictError`, 409) with the engine's reason.
+     *
+     * @effect destructive
+     * @permission UpdateSettings
+     */
+    delete(id: string, options?: Call): Promise<void>;
+}
+export declare const RATE_TABLES_QUERY = "\n  query StoreRateTables {\n    shippingZoneConfigs { \n  id\n  name\n  volumetricDivisor\n  defaultWeightGrams\n  enabled\n  createdAt\n  updatedAt\n }\n  }\n";
+export declare const RATE_TABLE_QUERY = "\n  query StoreRateTable($id: ID!) {\n    shippingZoneConfig(id: $id) { \n  \n  id\n  name\n  volumetricDivisor\n  defaultWeightGrams\n  enabled\n  createdAt\n  updatedAt\n\n  zones {\n    id\n    name\n    type\n    position\n    members {\n      id\n      countryCode\n      postalCodeFrom\n      postalCodeTo\n    }\n    rates {\n      id\n      minWeightGrams\n      maxWeightGrams\n      price\n      currencyCode\n    }\n    createdAt\n    updatedAt\n  }\n }\n  }\n";
+export declare const CREATE_RATE_TABLE_MUTATION = "\n  mutation CreateStoreRateTable($input: CreateShippingZoneConfigInput!) {\n    createShippingZoneConfig(input: $input) { \n  \n  id\n  name\n  volumetricDivisor\n  defaultWeightGrams\n  enabled\n  createdAt\n  updatedAt\n\n  zones {\n    id\n    name\n    type\n    position\n    members {\n      id\n      countryCode\n      postalCodeFrom\n      postalCodeTo\n    }\n    rates {\n      id\n      minWeightGrams\n      maxWeightGrams\n      price\n      currencyCode\n    }\n    createdAt\n    updatedAt\n  }\n }\n  }\n";
+export declare const UPDATE_RATE_TABLE_MUTATION = "\n  mutation UpdateStoreRateTable($id: ID!, $input: UpdateShippingZoneConfigInput!) {\n    updateShippingZoneConfig(id: $id, input: $input) { \n  \n  id\n  name\n  volumetricDivisor\n  defaultWeightGrams\n  enabled\n  createdAt\n  updatedAt\n\n  zones {\n    id\n    name\n    type\n    position\n    members {\n      id\n      countryCode\n      postalCodeFrom\n      postalCodeTo\n    }\n    rates {\n      id\n      minWeightGrams\n      maxWeightGrams\n      price\n      currencyCode\n    }\n    createdAt\n    updatedAt\n  }\n }\n  }\n";
+export declare const DELETE_RATE_TABLE_MUTATION = "\n  mutation DeleteStoreRateTable($id: ID!) {\n    deleteShippingZoneConfig(id: $id) {\n      result\n      message\n    }\n  }\n";
+export declare function createRateTablesModule(transport: Transport): RateTablesModule;

package/dist/shipping/rate-tables.js

@@ -0,0 +1,184 @@
+import { ValidationError } from '@sixtyninecommerce/core';
+import { assertDeleted, fieldOf } from '../catalog/types.js';
+const SUMMARY_FIELDS = /* GraphQL */ `
+  id
+  name
+  volumetricDivisor
+  defaultWeightGrams
+  enabled
+  createdAt
+  updatedAt
+`;
+/** One selection for the single read and both writes, so all three answer the same table. */
+const TABLE_FIELDS = /* GraphQL */ `
+  ${SUMMARY_FIELDS}
+  zones {
+    id
+    name
+    type
+    position
+    members {
+      id
+      countryCode
+      postalCodeFrom
+      postalCodeTo
+    }
+    rates {
+      id
+      minWeightGrams
+      maxWeightGrams
+      price
+      currencyCode
+    }
+    createdAt
+    updatedAt
+  }
+`;
+export const RATE_TABLES_QUERY = /* GraphQL */ `
+  query StoreRateTables {
+    shippingZoneConfigs { ${SUMMARY_FIELDS} }
+  }
+`;
+export const RATE_TABLE_QUERY = /* GraphQL */ `
+  query StoreRateTable($id: ID!) {
+    shippingZoneConfig(id: $id) { ${TABLE_FIELDS} }
+  }
+`;
+export const CREATE_RATE_TABLE_MUTATION = /* GraphQL */ `
+  mutation CreateStoreRateTable($input: CreateShippingZoneConfigInput!) {
+    createShippingZoneConfig(input: $input) { ${TABLE_FIELDS} }
+  }
+`;
+export const UPDATE_RATE_TABLE_MUTATION = /* GraphQL */ `
+  mutation UpdateStoreRateTable($id: ID!, $input: UpdateShippingZoneConfigInput!) {
+    updateShippingZoneConfig(id: $id, input: $input) { ${TABLE_FIELDS} }
+  }
+`;
+export const DELETE_RATE_TABLE_MUTATION = /* GraphQL */ `
+  mutation DeleteStoreRateTable($id: ID!) {
+    deleteShippingZoneConfig(id: $id) {
+      result
+      message
+    }
+  }
+`;
+/** GraphQL's `Int`: a 32-bit signed integer. A wider number cannot be sent at all. */
+const INT_MIN = -2_147_483_648;
+const INT_MAX = 2_147_483_647;
+/**
+ * Collects every problem of one call, and refuses them in ONE error with the engine's code and
+ * JSON Pointers, so a caller marks each field the same way whichever side refused.
+ */
+class Problems {
+    details = [];
+    add(field, code, message) {
+        this.details.push({ field, code, message });
+    }
+    throwIfAny() {
+        const [first, ...rest] = this.details;
+        if (!first)
+            return;
+        const more = rest.length;
+        throw new ValidationError({
+            code: 'SHIPPING_ZONE_INPUT_INVALID',
+            message: more === 0
+                ? first.message
+                : `${first.message} ${String(more)} more ${more === 1 ? 'problem' : 'problems'} with this save.`,
+            status: 400,
+            service: 'vendure',
+            details: this.details,
+        });
+    }
+}
+const isObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+/**
+ * A whole number GraphQL's `Int` carries. Whether it is a sensible value (not negative) is the
+ * engine's to judge, so this refuses only what could not be sent.
+ */
+function intInput(problems, field, label, value) {
+    if (typeof value !== 'number' || !Number.isSafeInteger(value)) {
+        problems.add(field, 'type', `${label} must be a whole number.`);
+    }
+    else if (value > INT_MAX) {
+        problems.add(field, 'maximum', `${label} must be at most ${String(INT_MAX)}.`);
+    }
+    else if (value < INT_MIN) {
+        problems.add(field, 'minimum', `${label} cannot be negative.`);
+    }
+}
+/**
+ * The input as the engine takes it, with only the fields the caller named. An explicit `null`
+ * goes through as sent: the engine says which field cannot be cleared.
+ */
+function tableInput(input, mode) {
+    const problems = new Problems();
+    if (!isObject(input)) {
+        problems.add('/input', 'type', mode === 'create'
+            ? 'A new rate table must be an object.'
+            : 'The change to a rate table must be an object.');
+        problems.throwIfAny();
+    }
+    const fields = input;
+    const out = {};
+    // A create's name is `String!`: null cannot be sent at all (only an update may send null, which
+    // the engine refuses as "cannot be cleared").
+    if (fields.name == null && mode === 'create') {
+        problems.add('/input/name', 'required', 'Give the rate table a name.');
+    }
+    else if (fields.name !== undefined) {
+        if (fields.name !== null && typeof fields.name !== 'string') {
+            problems.add('/input/name', 'type', 'The rate table name must be text.');
+        }
+        out.name = fields.name;
+    }
+    const numbers = [
+        ['volumetricDivisor', 'The volumetric divisor'],
+        ['defaultWeightGrams', 'The default weight'],
+    ];
+    for (const [key, label] of numbers) {
+        const value = fields[key];
+        if (value === undefined)
+            continue;
+        if (value !== null)
+            intInput(problems, `/input/${key}`, label, value);
+        out[key] = value;
+    }
+    if (mode === 'update' && fields.enabled !== undefined) {
+        if (fields.enabled !== null && typeof fields.enabled !== 'boolean') {
+            problems.add('/input/enabled', 'type', 'Enabled must be true or false.');
+        }
+        out.enabled = fields.enabled;
+    }
+    problems.throwIfAny();
+    return out;
+}
+const requireId = (id) => {
+    if (typeof id !== 'string' || id === '') {
+        const problems = new Problems();
+        problems.add('/id', 'type', 'id must be a rate table id.');
+        problems.throwIfAny();
+    }
+    return id;
+};
+export function createRateTablesModule(transport) {
+    return {
+        async list(options) {
+            return fieldOf(transport, RATE_TABLES_QUERY, 'shippingZoneConfigs', {}, options);
+        },
+        async get(id, options) {
+            return fieldOf(transport, RATE_TABLE_QUERY, 'shippingZoneConfig', { id: requireId(id) }, options);
+        },
+        async create(input, options) {
+            return fieldOf(transport, CREATE_RATE_TABLE_MUTATION, 'createShippingZoneConfig', { input: tableInput(input, 'create') }, options);
+        },
+        async update(id, patch, options) {
+            const tableId = requireId(id);
+            return fieldOf(transport, UPDATE_RATE_TABLE_MUTATION, 'updateShippingZoneConfig', { id: tableId, input: tableInput(patch, 'update') }, options);
+        },
+        async delete(id, options) {
+            assertDeleted('SHIPPING_ZONE_CONFIG_NOT_DELETED', [
+                await fieldOf(transport, DELETE_RATE_TABLE_MUTATION, 'deleteShippingZoneConfig', { id: requireId(id) }, options),
+            ]);
+        },
+    };
+}

package/dist/stock/index.d.ts

@@ -1,5 +1,6 @@
 import { type Page, type Transport } from '@sixtyninecommerce/core';
 import type { Call, ListOptions } from '../types.js';
+import { type StockLocationsModule } from './locations.js';
 import { type StockTransfersModule } from './transfers.js';
 /**
  * One variant's stock at one location, in integer units.
@@ -14,7 +15,10 @@ import { type StockTransfersModule } from './transfers.js';
  *   allocates past on-hand, and that shortfall shows as a negative figure. A
  *   negative threshold (an oversell allowance) raises it above
  *   `onHand − allocated`.
- * - `incoming` — open units expected at this location (purchase orders).
+ * - `incoming` — open units expected at this location (purchase orders), customer-facing: a
+ *   purchase order counts only what its supplier confirmed.
+ * - `onOrder` — units ordered from suppliers and still to come at this location, confirmed or
+ *   not: the remainders of sent purchase orders plus the open lines an ERP mirrors. Internal.
  * - `trackInventory: false` — the variant does not track stock, so none of
  *   these figures gates a sale.
  */
@@ -25,6 +29,7 @@ export interface StockPosition {
     allocated: number;
     available: number;
     incoming: number;
+    onOrder: number;
     reserved: number;
     trackInventory: boolean;
 }
@@ -158,9 +163,11 @@ export interface StockModule {
     /** Stock transfers between this store's locations, and consumptions at one. */
     transfers: StockTransfersModule;
     allocations: StockAllocationsModule;
+    /** The store's stock locations themselves: list, read, create, change, delete. */
+    locations: StockLocationsModule;
 }
-export declare const STOCK_POSITION_QUERY = "\n  query StockPosition($variantId: ID!, $locationId: ID) {\n    stockPosition(variantId: $variantId, locationId: $locationId) { \n  locationId\n  locationName\n  onHand\n  allocated\n  available\n  incoming\n  reserved\n  trackInventory\n }\n  }\n";
+export declare const STOCK_POSITION_QUERY = "\n  query StockPosition($variantId: ID!, $locationId: ID) {\n    stockPosition(variantId: $variantId, locationId: $locationId) { \n  locationId\n  locationName\n  onHand\n  allocated\n  available\n  incoming\n  onOrder\n  reserved\n  trackInventory\n }\n  }\n";
 export declare const STOCK_MOVEMENTS_QUERY: string;
-export declare const ADJUST_STOCK_MUTATION = "\n  mutation AdjustStock($input: AdjustStockInput!, $idempotencyKey: String) {\n    adjustStock(input: $input, idempotencyKey: $idempotencyKey) { \n  locationId\n  locationName\n  onHand\n  allocated\n  available\n  incoming\n  reserved\n  trackInventory\n }\n  }\n";
+export declare const ADJUST_STOCK_MUTATION = "\n  mutation AdjustStock($input: AdjustStockInput!, $idempotencyKey: String) {\n    adjustStock(input: $input, idempotencyKey: $idempotencyKey) { \n  locationId\n  locationName\n  onHand\n  allocated\n  available\n  incoming\n  onOrder\n  reserved\n  trackInventory\n }\n  }\n";
 export declare const RELEASE_ORDER_ALLOCATION_MUTATION = "\n  mutation ReleaseOrderAllocation($orderId: ID!) {\n    releaseOrderAllocation(orderId: $orderId) {\n      __typename\n      ... on ReleaseOrderAllocationSuccess { orderId releasedQuantity }\n      ... on ErrorResult { errorCode message }\n    }\n  }\n";
 export declare function createStockModule(transport: Transport): StockModule;

package/dist/stock/index.js

@@ -1,4 +1,5 @@
 import { errorFromErrorResult, isErrorResult, pageFromVendureList, readOffsetCursor, } from '@sixtyninecommerce/core';
+import { createStockLocationsModule } from './locations.js';
 import { createStockTransfersModule } from './transfers.js';
 const POSITION_FIELDS = /* GraphQL */ `
   locationId
@@ -7,6 +8,7 @@ const POSITION_FIELDS = /* GraphQL */ `
   allocated
   available
   incoming
+  onOrder
   reserved
   trackInventory
 `;
@@ -101,6 +103,7 @@ export function createStockModule(transport) {
             return data.adjustStock;
         },
         transfers: createStockTransfersModule(transport),
+        locations: createStockLocationsModule(transport),
         allocations: {
             async release(orderId, options) {
                 const data = await transport.graphql({ api: 'admin', query: RELEASE_ORDER_ALLOCATION_MUTATION, variables: { orderId } }, options);

package/dist/stock/locations.d.ts

@@ -0,0 +1,144 @@
+import { type Page, type Transport } from '@sixtyninecommerce/core';
+import type { Call, ListOptions } from '../types.js';
+/**
+ * One stock location (warehouse, shop, back room) of the store the client is on.
+ *
+ * The parcel sender (`address`, the default sender) is not here: it has its own door
+ * (`locations.upsert` for the address, MyParcel's sender card for the default), with rules
+ * these methods cannot apply.
+ */
+export interface StockLocation {
+    id: string;
+    name: string;
+    /** Empty when none was given. */
+    description: string;
+    /** ISO 8601, UTC. */
+    createdAt: string;
+    /** ISO 8601, UTC. */
+    updatedAt: string;
+    /**
+     * Whether shoppers see this location's stock (the Shop API's per-variant availability). True
+     * unless set off, for a back room or a staging area.
+     */
+    isPublic: boolean;
+    /**
+     * This location's own out-of-stock threshold, in units: non-zero replaces the variant's (or the
+     * store's) threshold for stock held here. Negative lets it sell that many below zero, positive
+     * holds a buffer back from sale; 0 uses the variant's or the store's.
+     */
+    outOfStockThreshold: number;
+}
+/** The fields a list can be sorted by. */
+export declare const STOCK_LOCATION_SORT_FIELDS: readonly ["name", "createdAt", "updatedAt"];
+export type StockLocationSortField = (typeof STOCK_LOCATION_SORT_FIELDS)[number];
+export interface StockLocationListOptions extends ListOptions {
+    /**
+     * Locations whose name OR description contains this, ignoring case (the engine's list filter;
+     * the search index is not used). Blank or omitted: every location.
+     */
+    term?: string;
+    /** One key. Omitted: the engine's own order. */
+    sort?: {
+        field: StockLocationSortField;
+        direction: 'ASC' | 'DESC';
+    };
+}
+export interface CreateStockLocationInput {
+    name: string;
+    description?: string;
+    /** On (shoppers see its stock) when omitted. */
+    isPublic?: boolean;
+    /** 0 (use the variant's or the store's threshold) when omitted. */
+    outOfStockThreshold?: number;
+}
+/** A PATCH: an absent field keeps what the location has. */
+export interface UpdateStockLocationInput {
+    name?: string;
+    description?: string;
+    isPublic?: boolean;
+    outOfStockThreshold?: number;
+}
+export interface DeleteStockLocationOptions extends Call {
+    /**
+     * Another location of this store that takes over the deleted location's stock levels. Omitted:
+     * the levels go with the location.
+     */
+    transferToLocationId?: string;
+}
+/**
+ * `admin.stock.locations`: the store's stock locations themselves (spec §9.2 `stock`, §8.7). A
+ * location's profile (code, time zone, opening hours, address) is `admin.locations`; its pickup
+ * settings are `admin.locations.pickup`.
+ *
+ * Scoped to the store the client is on: another store's location is not listed, `get` answers
+ * `null` for it, and `update`/`delete` refuse it `ENTITY_NOT_FOUND` (`NotFoundError`), the same
+ * answer as for an id that does not exist. A location SHARED with another store is changed or
+ * deleted only by a caller who may do so in every store holding it (`ENTITY_NOT_FOUND` too
+ * otherwise).
+ *
+ * A hub-owned location (multi-region phase 5) will be refused `MANAGED_BY_ORGANIZATION`
+ * (`BusinessRuleError`) by `update` and `delete` from a member store; no location is hub-owned
+ * yet. A member store's Stock owner (an app or API token owning the Stock field group) never
+ * locks the hub's warehouse (ruling U8).
+ */
+export interface StockLocationsModule {
+    /**
+     * The store's locations, a page at a time (`options.limit`, default 100, at most 1,000; and
+     * `options.after` from a previous page); `for await (const location of page)` walks them all.
+     * An API token or app restricted with `locationIds` still lists every location of the store.
+     *
+     * @effect read
+     * @permission ReadStockLocation
+     */
+    list(options?: StockLocationListOptions): Promise<Page<StockLocation>>;
+    /**
+     * One location by id, or `null` when the store has no such location (one only another store
+     * holds reads the same).
+     *
+     * @effect read
+     * @permission ReadStockLocation
+     */
+    get(id: string, options?: Call): Promise<StockLocation | null>;
+    /**
+     * Create a location in this store. `name` must not be blank (`STOCK_LOCATION_INPUT_INVALID`,
+     * `ValidationError`, before anything is sent).
+     *
+     * @effect write
+     * @permission CreateStockLocation
+     */
+    create(input: CreateStockLocationInput, options?: Call): Promise<StockLocation>;
+    /**
+     * Change a location's name, description, `isPublic` or threshold. Moves no stock, so a
+     * credential restricted with `locationIds` may change any location of the store. A blank
+     * `name` is `STOCK_LOCATION_INPUT_INVALID` (`ValidationError`, nothing sent). The engine also
+     * refuses `STOCK_LOCATION_SENDER_READ_ONLY` (`BusinessRuleError`) a change to the parcel sender,
+     * which this method never sends.
+     *
+     * @effect write
+     * @permission UpdateStockLocation
+     */
+    update(id: string, input: UpdateStockLocationInput, options?: Call): Promise<StockLocation>;
+    /**
+     * Delete a location. Its stock levels move to `options.transferToLocationId`, or are deleted
+     * with it: there is no undo.
+     *
+     * Refused:
+     * - `STOCK_LOCATION_NOT_DELETED` (`BusinessRuleError`), in the engine's words, when the engine
+     *   keeps it (the store's last location, for one);
+     * - `LOCATION_NOT_ALLOWED` (`PermissionDeniedError`) to a credential restricted with
+     *   `locationIds` that does not hold the location and the transfer target;
+     * - `FIELD_GROUP_LOCKED` (`BusinessRuleError`) while an app or API token owns the store's Stock
+     *   and the location holds stock;
+     * - `ENTITY_NOT_FOUND` (`NotFoundError`) for another store's location or the transfer target.
+     *
+     * @effect destructive
+     * @permission DeleteStockLocation
+     */
+    delete(id: string, options?: DeleteStockLocationOptions): Promise<void>;
+}
+export declare const STOCK_LOCATIONS_QUERY = "\n  query StockLocations($options: StockLocationListOptions) {\n    stockLocations(options: $options) {\n      items { \n  id\n  name\n  description\n  createdAt\n  updatedAt\n  customFields {\n    isPublic\n    outOfStockThreshold\n  }\n }\n      totalItems\n    }\n  }\n";
+export declare const STOCK_LOCATION_QUERY = "\n  query StockLocation($id: ID!) {\n    stockLocation(id: $id) { \n  id\n  name\n  description\n  createdAt\n  updatedAt\n  customFields {\n    isPublic\n    outOfStockThreshold\n  }\n }\n  }\n";
+export declare const CREATE_STOCK_LOCATION_MUTATION = "\n  mutation CreateStockLocation($input: CreateStockLocationInput!) {\n    createStockLocation(input: $input) { \n  id\n  name\n  description\n  createdAt\n  updatedAt\n  customFields {\n    isPublic\n    outOfStockThreshold\n  }\n }\n  }\n";
+export declare const UPDATE_STOCK_LOCATION_MUTATION = "\n  mutation UpdateStockLocation($input: UpdateStockLocationInput!) {\n    updateStockLocation(input: $input) { \n  id\n  name\n  description\n  createdAt\n  updatedAt\n  customFields {\n    isPublic\n    outOfStockThreshold\n  }\n }\n  }\n";
+export declare const DELETE_STOCK_LOCATION_MUTATION = "\n  mutation DeleteStockLocation($input: DeleteStockLocationInput!) {\n    deleteStockLocation(input: $input) {\n      result\n      message\n    }\n  }\n";
+export declare function createStockLocationsModule(transport: Transport): StockLocationsModule;