react-shopwave-connect 0.4.5 → 0.4.7

package/dist/core/index.d.cts

@@ -94,9 +94,10 @@ declare function apiSend<T>(path: string, method: "POST" | "PUT", payload: unkno
 /**
  * DELETE helper. Shopwave answers deletes with 205 and an empty body; if a body
  * does come back and carries API errors, they are thrown. Returns the parsed
- * body (`null` when empty).
+ * body (`null` when empty). `extras`, when given, travel in the `extras` header
+ * (the server forwards only keys its delete route allows).
  */
-declare function apiDelete(path: string, options?: RequestOptions): Promise<unknown>;
+declare function apiDelete(path: string, options?: RequestOptions, extras?: Extras): Promise<unknown>;
 //#endregion
 //#region src/core/errors.d.ts
 /** Map of Shopwave API errors as found in `api.message.errors`, keyed by error code. */
@@ -360,6 +361,42 @@ declare function fetchProductTags(options?: RequestOptions): Promise<string[]>;
  */
 declare function fetchProductInstanceTags(options?: RequestOptions): Promise<string[]>;
 //#endregion
+//#region src/core/store.d.ts
+interface Store {
+  id: number;
+  lat: number;
+  lng: number;
+  addressLine1: string;
+  addressLine2: string | null;
+  addressLine3: string;
+  phoneNumber: string;
+  city: string;
+  postcode: string;
+  countryId: number | null;
+  timezoneId: number | null;
+  storeDeleteDate: string | null;
+  email: string | null;
+  sandbox: boolean | null;
+}
+interface StoreResponse {
+  stores: {
+    [key: number]: Store;
+  };
+  api: apiResponse;
+}
+interface FetchStoresParams {
+  /** Optional id filter. */
+  storeIds?: Array<number>;
+  /** Whether to include soft-deleted records. Defaults to `false`. */
+  deleted?: boolean;
+  /** @deprecated Pass `options.token` instead. Sent the same way (Authorization header). */
+  token?: string;
+}
+/**
+ * Fetches stores. Returns the flattened `Store[]`.
+ */
+declare function fetchStores(params?: FetchStoresParams, options?: RequestOptions): Promise<Store[]>;
+//#endregion
 //#region src/core/promotion.d.ts
 /** Promotion rule identifiers as stored by the Shopwave API. */
 declare enum PromotionRuleSet {
@@ -413,147 +450,6 @@ interface FetchPromotionsParams {
  */
 declare function fetchPromotions(params?: FetchPromotionsParams, options?: RequestOptions): Promise<Promotion[]>;
 //#endregion
-//#region src/core/store.d.ts
-interface Store {
-  id: number;
-  lat: number;
-  lng: number;
-  addressLine1: string;
-  addressLine2: string | null;
-  addressLine3: string;
-  phoneNumber: string;
-  city: string;
-  postcode: string;
-  countryId: number | null;
-  timezoneId: number | null;
-  storeDeleteDate: string | null;
-  email: string | null;
-  sandbox: boolean | null;
-}
-interface StoreResponse {
-  stores: {
-    [key: number]: Store;
-  };
-  api: apiResponse;
-}
-interface FetchStoresParams {
-  /** Optional id filter. */
-  storeIds?: Array<number>;
-  /** Whether to include soft-deleted records. Defaults to `false`. */
-  deleted?: boolean;
-  /** @deprecated Pass `options.token` instead. Sent the same way (Authorization header). */
-  token?: string;
-}
-/**
- * Fetches stores. Returns the flattened `Store[]`.
- */
-declare function fetchStores(params?: FetchStoresParams, options?: RequestOptions): Promise<Store[]>;
-//#endregion
-//#region src/core/report.d.ts
-interface ReportKey {
-  name: string;
-  type: string;
-  item?: ReportKey[];
-}
-interface ReportData {
-  keys: ReportKey[];
-  data: any[][];
-}
-interface ReportResponse {
-  reports: {
-    [key: string]: ReportData;
-  };
-  api: apiResponse;
-}
-interface ReportQuery {
-  FROM: string;
-  WHERE?: {
-    AND?: string[];
-    OR?: string[];
-  };
-  SELECT?: string[];
-  LIMIT?: number;
-  OFFSET?: number;
-}
-interface ReportQueryMap {
-  [key: string]: ReportQuery;
-}
-/**
- * Runs one or more report queries and returns the `reports` map keyed by query
- * name. The query is JSON-encoded into the `extras.query` header, matching the
- * original endpoint contract.
- */
-declare function fetchReport(query: ReportQueryMap, options?: RequestOptions): Promise<ReportResponse["reports"]>;
-//#endregion
-//#region src/core/session.d.ts
-/**
- * Login status returned by the app's `/api/session` route. It deliberately
- * never contains tokens — those stay in the encrypted httpOnly cookie.
- */
-interface SessionStatus {
-  loggedIn: boolean;
-  /** Access-token expiry (epoch ms), when known. */
-  expiresAt?: number;
-}
-/**
- * Reads the current login status from `GET /api/session`.
- *
- * Works with the new `react-shopwave-connect/next` session route
- * (`{ loggedIn }`) and with older routes that returned the raw session
- * (`{ token: {...} }`) — in that case only a boolean is surfaced.
- */
-declare function fetchSession(options?: RequestOptions): Promise<SessionStatus>;
-/**
- * Path that starts a login and returns to `returnTo` afterwards.
- * Navigate the browser to it (`window.location.href = loginPath(...)`).
- */
-declare function loginPath(returnTo?: string, authPath?: string): string;
-/** Path that logs out of the app and the Shopwave auth server. */
-declare function logoutPath(authPath?: string): string;
-/**
- * Ends the current server session (no redirect).
- *
- * Prefer navigating to {@link logoutPath} when using
- * `react-shopwave-connect/next`: it also signs the user out of the auth server.
- */
-declare function logout(options?: RequestOptions): Promise<void>;
-//#endregion
-//#region src/core/entity.d.ts
-/**
- * Low-level, untyped mutations: the caller supplies the route and payload.
- *
- * Prefer the typed functions in `./entities` (`saveProduct`, `deleteCategory`,
- * …): they know each route, build the request envelope, check the response and
- * return the saved entity with its id. Keep these for routes that have no typed
- * function yet (e.g. `/api/merchant`).
- */
-/**
- * Deletes `/api/{resourcePath}/{entityId}`.
- */
-declare function deleteEntity(resourcePath: string, entityId: number | string, options?: RequestOptions): Promise<void>;
-interface SubmitEntityArgs {
-  /** Fully-resolved endpoint, e.g. `/api/products` or `/api/products/42`. */
-  endpoint: string;
-  /** Defaults to PUT when an `entityId` exists, otherwise POST. */
-  method?: "POST" | "PUT";
-  /** The request payload (already transformed by the caller). */
-  payload: unknown;
-}
-interface SubmitEntityResponse<R = any> {
-  result?: R;
-  [key: string]: unknown;
-}
-/**
- * Sends a create/update mutation. Returns the response's `result` field when it
- * has one (older app routes wrapped their answer that way), otherwise the whole
- * parsed response body. Throws `ShopwaveApiError` on HTTP or API errors.
- */
-declare function submitEntity<R = any>({
-  endpoint,
-  method,
-  payload
-}: SubmitEntityArgs, options?: RequestOptions): Promise<R | undefined>;
-//#endregion
 //#region src/core/entities.d.ts
 /**
  * How each Shopwave entity is addressed, shared by the client functions below
@@ -596,8 +492,15 @@ interface EntityDefinition {
    * start = end and the record is expired without ever running.
    */
   retireStartField?: string;
+  /**
+   * Header naming child records to delete instead of the whole record
+   * (`productComponentInstanceIds: 1,2`). Only `item()` DELETE uses it, and only when
+   * the caller's `extras` carry this one key (a non-empty list of ids); every other
+   * `extras` key is still dropped. Only for `deleteMode: "delete"`.
+   */
+  childIdsHeader?: string;
 }
-type EntityKind = "product" | "category" | "store" | "promotion" | "employee" | "consumer";
+type EntityKind = "product" | "category" | "store" | "promotion" | "employee" | "consumer" | "productComponent";
 /** Entities that can be created/updated through the API. */
 type WritableEntityKind = Exclude<EntityKind, "consumer">;
 /** Entities that can be deleted (or retired) through the API. */
@@ -614,6 +517,27 @@ type DeletableEntityKind = Exclude<EntityKind, "consumer">;
  * - employee: POST updates `roleId`, `joinedDate`, `exitDate` (names can't be
  *   changed); no DELETE (live API: "Cannot DELETE /employee") → retired via `exitDate`.
  * - consumer: read-only (`GET` with `ids`, comma-separated); live POST → 404.
+ * - productComponent: modifier groups, `/product/component` (live, staging, 11 Nov 2026). The
+ *   API reference lists no read filters; these are what the live API does:
+ *   - Reads filter by `componentIds` (group ids) or `productIds` (the parent product; option
+ *     products don't match). `productComponentIds` is ignored on reads: every group comes back.
+ *     `deleted: false` gives live groups only, `true` deleted groups only, no header both.
+ *     No match → 204 with an empty body. No order, sort, priority or position field anywhere.
+ *   - Groups are keyed by id; `products` (option products) by product id; `productInstances`
+ *     (option rows) by row id. Reads reformat values: price `"100"` → `"100.0"`,
+ *     vatPercentage `"0.2000"` → `"0.200"`. `tags` and `name` are stored as sent (no trimming;
+ *     a `tags` array is joined with commas; `tags` null or left out → null).
+ *   - POST upserts (201, echoed under the ref). For each option product in `products`, its rows
+ *     are replaced: every row sent is created afresh with a new id (a row `id` is ignored, also
+ *     on a price change) and rows left out are removed. Option products left out of the save
+ *     are untouched, and an empty `productInstances` removes nothing. A save without `products`
+ *     updates only the group's own fields. The echo isn't proof of what was stored: renames of
+ *     groups created moments earlier by a test run echoed the new name but never stuck (re-read
+ *     for 90 s), while older groups, and groups created in Shopwave's own admin, renamed at
+ *     once. Cause not yet known.
+ *   - DELETE with `productComponentIds` (plural, comma list) → 205, soft delete. Adding
+ *     `productComponentInstanceIds` deletes just those rows (205); they stay in live reads with
+ *     `deleteDate` set. The singular `productComponentId` hangs (504 after 60 s).
  */
 declare const SHOPWAVE_ENTITIES: Readonly<Record<EntityKind, EntityDefinition>>;
 interface EntityTypes {
@@ -623,6 +547,7 @@ interface EntityTypes {
   promotion: Promotion;
   employee: Employee;
   consumer: Consumer;
+  productComponent: ProductComponent;
 }
 /**
  * What a save accepts: any subset of the entity's fields (plus extra API
@@ -710,6 +635,228 @@ declare const deleteEmployee: (id: EntityId, options?: RequestOptions) => Promis
 declare const fetchEmployee: (id: EntityId, params?: FetchByIdParams, options?: RequestOptions) => Promise<Employee | null>;
 declare const fetchConsumer: (id: EntityId, params?: FetchByIdParams, options?: RequestOptions) => Promise<Consumer | null>;
 //#endregion
+//#region src/core/productComponent.d.ts
+/**
+ * Product components are modifier groups: a group belongs to a parent product
+ * (`productId`) and offers other products as options. Each option product has
+ * one or more option rows (`productInstances`). See `SHOPWAVE_ENTITIES.productComponent`
+ * for what the live API does on reads, saves and deletes.
+ */
+/** One option row of a product component. */
+interface ProductComponentInstance {
+  id: number;
+  /** Name override for the option; `null` or `""` means the product's own name. Stored as sent. */
+  name: string | null;
+  /** Price as a decimal string, pence excluding VAT (reads return `"100.0"` for `"100"`). */
+  price: string;
+  /** VAT as a fraction string (`"0.200"`). */
+  vatPercentage: string;
+  quantity: number;
+  /** Comma-separated price tags, or `null`. Stored as sent (not trimmed). */
+  tags: string | null;
+  size?: string | null;
+  activeDate?: string | null;
+  /** Set once the row has been deleted; deleted rows still appear in live reads. */
+  deleteDate?: string | null;
+}
+/** A product offered as an option in a product component, with its option rows. */
+interface ProductComponentProduct {
+  id: number;
+  name: string;
+  barcode?: string | null;
+  details?: string | null;
+  unit?: number | null;
+  activeDate?: string | null;
+  /** Option rows, keyed by row id on reads. */
+  productInstances: Record<string, ProductComponentInstance>;
+}
+/** A product component (modifier group). */
+interface ProductComponent {
+  id: number;
+  name: string;
+  /** The parent product the group belongs to. */
+  productId: number;
+  minQuantity: number;
+  maxQuantity: number;
+  productTimestamp?: string;
+  /** Set once the group has been deleted (only `deleted: true` reads return it then). */
+  deleteDate?: string | null;
+  /** Option products, keyed by product id. */
+  products: Record<string, ProductComponentProduct>;
+}
+/** An option row as a caller holds it: every field optional, `tags` also as a list. */
+type ProductComponentInstanceInput = Partial<Omit<ProductComponentInstance, "tags">> & {
+  tags?: string | ReadonlyArray<string> | null;
+};
+/** An option product as a caller holds it: rows keyed (as read) or as a list. */
+type ProductComponentProductInput = Partial<Omit<ProductComponentProduct, "productInstances">> & {
+  productInstances?: Readonly<Record<string, ProductComponentInstanceInput>> | ReadonlyArray<ProductComponentInstanceInput>;
+};
+/**
+ * What {@link saveProductComponent} accepts. Include `id` to update; leave it out to create.
+ * `products` may be keyed by product id (as read) or a list.
+ */
+type ProductComponentSaveInput = Partial<Omit<ProductComponent, "products">> & {
+  products?: Readonly<Record<string, ProductComponentProductInput>> | ReadonlyArray<ProductComponentProductInput>;
+  [field: string]: unknown;
+};
+/**
+ * Builds the save body for a product component from a group as read (or as a form holds it):
+ * - `products` keyed by product id (a product without `id` takes its key);
+ * - each product's rows keyed `"0"`, `"1"`, …, like every other ref in a save;
+ * - rows that have a `deleteDate` are left out: the API recreates every row it's sent, so
+ *   sending one back would bring a deleted option back as a new row;
+ * - server row fields (`id`, `activeDate`, `deleteDate`, `timestamp`) are removed, since the
+ *   API gives every row it's sent a new id anyway;
+ * - a `tags` list becomes a comma string.
+ *
+ * The API replaces the rows of every option product in the save and leaves the others alone,
+ * so send all the rows to keep for each product included. To remove an option product
+ * entirely, delete its rows with {@link deleteProductComponentInstances}.
+ */
+declare function toProductComponentForSave(input: ProductComponentSaveInput): Record<string, unknown>;
+interface FetchProductComponentsParams {
+  /** Parent products whose groups to read. */
+  productIds?: ReadonlyArray<number | string>;
+  /** Groups to read, by id. */
+  productComponentIds?: ReadonlyArray<number | string>;
+  /** `false` (default): live groups only. `true`: deleted groups only. */
+  deleted?: boolean;
+}
+/**
+ * Reads product components, optionally filtered by parent product and/or group id.
+ * With no filter it returns every group on the merchant. Returns `[]` when nothing matches
+ * (the API answers 204), and when a filter list is empty (no request is made).
+ *
+ * Rows deleted with {@link deleteProductComponentInstances} are still returned, with
+ * `deleteDate` set; skip them when listing options.
+ */
+declare function fetchProductComponents(params?: FetchProductComponentsParams, options?: RequestOptions): Promise<ProductComponent[]>;
+/**
+ * Reads one product component by id, or `null` when there's no such live group.
+ * Note that `{ deleted: true }` returns the group only if it *has* been deleted.
+ */
+declare const fetchProductComponent: (id: EntityId, params?: FetchByIdParams, options?: RequestOptions) => Promise<ProductComponent | null>;
+/**
+ * Creates (no `id`) or updates (with `id`) a product component and returns it with its id.
+ * The body is built with {@link toProductComponentForSave}. Every option row sent is stored
+ * under a new id, so re-read with {@link fetchProductComponent} for the stored rows.
+ */
+declare const saveProductComponent: (input: ProductComponentSaveInput, options?: RequestOptions) => Promise<Saved<ProductComponent>>;
+/** Deletes a product component (soft delete: `deleted: true` reads still return it). */
+declare const deleteProductComponent: (id: EntityId, options?: RequestOptions) => Promise<void>;
+/**
+ * Deletes some option rows of a product component, leaving the group and its other rows.
+ * The rows stay in reads with `deleteDate` set. Throws without calling the API when
+ * `instanceIds` is empty, because a delete without them would delete the whole group.
+ */
+declare function deleteProductComponentInstances(id: EntityId, instanceIds: ReadonlyArray<number | string>, options?: RequestOptions): Promise<void>;
+//#endregion
+//#region src/core/report.d.ts
+interface ReportKey {
+  name: string;
+  type: string;
+  item?: ReportKey[];
+}
+interface ReportData {
+  keys: ReportKey[];
+  data: any[][];
+}
+interface ReportResponse {
+  reports: {
+    [key: string]: ReportData;
+  };
+  api: apiResponse;
+}
+interface ReportQuery {
+  FROM: string;
+  WHERE?: {
+    AND?: string[];
+    OR?: string[];
+  };
+  SELECT?: string[];
+  LIMIT?: number;
+  OFFSET?: number;
+}
+interface ReportQueryMap {
+  [key: string]: ReportQuery;
+}
+/**
+ * Runs one or more report queries and returns the `reports` map keyed by query
+ * name. The query is JSON-encoded into the `extras.query` header, matching the
+ * original endpoint contract.
+ */
+declare function fetchReport(query: ReportQueryMap, options?: RequestOptions): Promise<ReportResponse["reports"]>;
+//#endregion
+//#region src/core/session.d.ts
+/**
+ * Login status returned by the app's `/api/session` route. It deliberately
+ * never contains tokens — those stay in the encrypted httpOnly cookie.
+ */
+interface SessionStatus {
+  loggedIn: boolean;
+  /** Access-token expiry (epoch ms), when known. */
+  expiresAt?: number;
+}
+/**
+ * Reads the current login status from `GET /api/session`.
+ *
+ * Works with the new `react-shopwave-connect/next` session route
+ * (`{ loggedIn }`) and with older routes that returned the raw session
+ * (`{ token: {...} }`) — in that case only a boolean is surfaced.
+ */
+declare function fetchSession(options?: RequestOptions): Promise<SessionStatus>;
+/**
+ * Path that starts a login and returns to `returnTo` afterwards.
+ * Navigate the browser to it (`window.location.href = loginPath(...)`).
+ */
+declare function loginPath(returnTo?: string, authPath?: string): string;
+/** Path that logs out of the app and the Shopwave auth server. */
+declare function logoutPath(authPath?: string): string;
+/**
+ * Ends the current server session (no redirect).
+ *
+ * Prefer navigating to {@link logoutPath} when using
+ * `react-shopwave-connect/next`: it also signs the user out of the auth server.
+ */
+declare function logout(options?: RequestOptions): Promise<void>;
+//#endregion
+//#region src/core/entity.d.ts
+/**
+ * Low-level, untyped mutations: the caller supplies the route and payload.
+ *
+ * Prefer the typed functions in `./entities` (`saveProduct`, `deleteCategory`,
+ * …): they know each route, build the request envelope, check the response and
+ * return the saved entity with its id. Keep these for routes that have no typed
+ * function yet (e.g. `/api/merchant`).
+ */
+/**
+ * Deletes `/api/{resourcePath}/{entityId}`.
+ */
+declare function deleteEntity(resourcePath: string, entityId: number | string, options?: RequestOptions): Promise<void>;
+interface SubmitEntityArgs {
+  /** Fully-resolved endpoint, e.g. `/api/products` or `/api/products/42`. */
+  endpoint: string;
+  /** Defaults to PUT when an `entityId` exists, otherwise POST. */
+  method?: "POST" | "PUT";
+  /** The request payload (already transformed by the caller). */
+  payload: unknown;
+}
+interface SubmitEntityResponse<R = any> {
+  result?: R;
+  [key: string]: unknown;
+}
+/**
+ * Sends a create/update mutation. Returns the response's `result` field when it
+ * has one (older app routes wrapped their answer that way), otherwise the whole
+ * parsed response body. Throws `ShopwaveApiError` on HTTP or API errors.
+ */
+declare function submitEntity<R = any>({
+  endpoint,
+  method,
+  payload
+}: SubmitEntityArgs, options?: RequestOptions): Promise<R | undefined>;
+//#endregion
 //#region src/core/basket.d.ts
 interface BasketItem {
   productId: number;
@@ -850,8 +997,8 @@ declare const UPLOAD_KINDS: Readonly<Record<UploadKind, string>>;
 /**
  * The role an image plays, sent to Shopwave as the uploader's `prefix` header.
  * The uploader names the file `<prefix>_<hash>.<ext>`, so the role travels with
- * the file wherever a record stores it (a product's `images`). Live, merchant
- * 5644, 4 Nov 2026: all four values answered 201.
+ * the file wherever a record stores it (a product's `images`). Live, test
+ * merchant, 4 Nov 2026: all four values answered 201.
  * - `product`: a product gallery image;
  * - `product_thumbnail`: the product's lead image, shown in lists;
  * - `variant` / `variant_thumbnail`: a variant's own image and its lead image
@@ -892,7 +1039,7 @@ declare function isUploadPrefix(value: unknown): value is UploadPrefix;
  *   on the merchant's products. No parameters. The API reference says
  *   "internal SKU tags are excluded", but the live API includes system tags
  *   written by imports and syncs (`PID-133`, `VID-137`, `#Hash:…`, `upc-…`;
- *   test merchant 5644, 29 Oct 2026). Apps that offer the list as suggestions
+ *   a test merchant, 29 Oct 2026). Apps that offer the list as suggestions
  *   filter those themselves. Tags of deleted products drop out of the list.
  * - productInstanceTags: `GET /product/instance/tags` → `{ tags: string[] }`,
  *   the same for price instances (channels such as "Eat In", "Takeout").
@@ -1079,7 +1226,7 @@ declare const SHOPWAVE_IMAGE_BASE_URL = "https://s3-eu-west-1.amazonaws.com/stat
 /**
  * Turns an image path from the API into a URL a page can load over HTTPS:
  * `http://static.merchantstack.com/images/x.png` → `<base>/x.png`, and a
- * relative path (`merchant/5644/logo/x.png`) → `<base>/merchant/5644/logo/x.png`.
+ * relative path (`merchant/123/logo/x.png`) → `<base>/merchant/123/logo/x.png`.
  * Other absolute URLs are returned unchanged; empty input gives `""`.
  */
 declare function getImageUrl(path: string | null | undefined, base?: string): string;
@@ -1095,7 +1242,7 @@ declare function uploadImage(file: Blob, params: UploadImageParams, options?: Re
 //#endregion
 //#region src/core/merchantImages.d.ts
 /**
- * Merchant images, as adminV1 saves them and adminV2 reads them:
+ * Merchant images, as Shopwave's existing admin apps save and read them:
  *
  * ```
  * { logo: { receipt: "<file>", square: "<file>" }, feature: ["<file>"] }
@@ -1112,7 +1259,7 @@ declare function uploadImage(file: Blob, params: UploadImageParams, options?: Re
  *   So a featured image must be uploaded with kind `merchantFeature` (which
  *   stores it under `feature/`); a `merchant` upload lands under `logo/`.
  *
- * Confirmed on the live API, merchant 5644, 30 Sep 2026.
+ * Confirmed on the live API, 30 Sep 2026.
  */
 interface MerchantImageIds {
   logo?: {
@@ -1131,12 +1278,12 @@ interface MerchantImageSlotDefinition {
   field: "logo.receipt" | "logo.square" | "feature[0]";
   /** Uploader `contentType` (the featured image has its own). */
   uploadKind: UploadKind;
-  /** Exact size in pixels. adminV1 refuses any other size; the API doesn't resize. */
+  /** Exact size in pixels. Shopwave's existing admin refuses any other size; the API doesn't resize. */
   width: number;
   height: number;
 }
 /**
- * Where each slot lives, its upload kind and its exact size (from adminV1's
+ * Where each slot lives, its upload kind and its exact size (from the existing admin's
  * merchant settings page).
  */
 declare const MERCHANT_IMAGE_SLOTS: Readonly<Record<MerchantImageSlot, MerchantImageSlotDefinition>>;
@@ -1161,7 +1308,7 @@ declare function getMerchantImageUrl(imageIds: MerchantImageIds | null | undefin
 declare function setMerchantImage(imageIds: MerchantImageIds | null | undefined, slot: MerchantImageSlot, fileName: string | null): MerchantImageIds;
 /**
  * The `imageIds` to send on a save: every URL is turned back into its file
- * name (what adminV1 does with images you didn't change) and empty values
+ * name (what the existing admin does with images you didn't change) and empty values
  * are dropped. No images gives `{}`.
  */
 declare function toStoredImageIds(imageIds: unknown): MerchantImageIds;
@@ -1190,7 +1337,7 @@ interface MerchantColourSet {
   [key: string]: string | null | undefined;
 }
 /**
- * Brand colours, as adminV1 saves them and adminV2 reads them
+ * Brand colours, as Shopwave's existing admin apps save and read them
  * (`colours.primary.main` is the logo background): `{ primary: { main,
  * highlight, contrast } }`. `{}` when unset. Confirmed live, 30 Sep 2026.
  */
@@ -1202,7 +1349,7 @@ interface MerchantColours {
 declare const MERCHANT_COLOUR_KEYS: readonly ["main", "highlight", "contrast"];
 type MerchantColourKey = (typeof MERCHANT_COLOUR_KEYS)[number];
 /**
- * Web and social links, as adminV1 saves them:
+ * Web and social links, as Shopwave's existing admin saves them:
  * `{ website: { home }, social: { twitter, facebook, instagram } }`.
  * `{}` when empty (confirmed live, 30 Sep 2026). Use {@link normalizeMerchantLinks} to read older shapes and
  * {@link merchantLinksToForm} / {@link merchantLinksFromForm} for flat forms.
@@ -1228,9 +1375,9 @@ declare const MERCHANT_LINK_PATHS: Readonly<Record<MerchantLinkKey, readonly [st
 /**
  * Reads `merchant.links` as flat fields (`{ website, twitter, facebook,
  * instagram }`), whatever shape it was saved in:
- * - the nested shape adminV1 saves (`{ website: { home }, social: { … } }`);
+ * - the nested shape the existing admin saves (`{ website: { home }, social: { … } }`);
  * - flat keys (`{ website: "…" }`, what SDK 0.4.0 pre-releases sent);
- * - an array in {@link MERCHANT_LINK_KEYS} order (older AdminUI versions).
+ * - an array in {@link MERCHANT_LINK_KEYS} order (older app versions).
  * Empty values are dropped.
  */
 declare function merchantLinksToForm(links: unknown): Partial<Record<MerchantLinkKey, string>>;
@@ -1239,7 +1386,7 @@ declare function merchantLinksToForm(links: unknown): Partial<Record<MerchantLin
  * out, and so is a group with nothing in it; no links gives `{}`.
  */
 declare function merchantLinksFromForm(form: Partial<Record<MerchantLinkKey, string | null | undefined>>): MerchantLinks;
-/** Reads any stored or older `links` value into the nested shape adminV1 saves. */
+/** Reads any stored or older `links` value into the nested shape the existing admin saves. */
 declare function normalizeMerchantLinks(links: unknown): MerchantLinks;
 interface Merchant {
   id: number;
@@ -1352,7 +1499,7 @@ declare function fetchUser(options?: RequestOptions): Promise<User | null>;
 //#endregion
 //#region src/core/productImages.d.ts
 /**
- * Product images, as the live API stores them (merchant 5644, 4 Nov 2026):
+ * Product images, as the live API stores them (4 Nov 2026):
  * - A product's `images` is a list. **Reads return full URLs**
  *   (`http://static.merchantstack.com/images/merchant/<id>/product/<file>`);
  *   **writes take the uploader's file names** ({@link toStoredProductImages};
@@ -1375,5 +1522,5 @@ declare function productImageRole(value: unknown): UploadPrefix | null;
  */
 declare function toStoredProductImages(images: unknown): string[];
 //#endregion
-export { Basket, BasketFilters, BasketItem, BasketPagination, BasketReportRow, BasketSummary, Category, CategoryResponse, CombineBasketRowsParams, Consumer, ConsumerResponse, CropRect, DEFAULT_BASKET_FILTERS, DEFAULT_PAGINATION, DeletableEntityKind, Employee, EmployeeResponse, EntityDefinition, EntityId, EntityInput, EntityKind, EntityTypes, ErrorMessage, Extras, FetchByIdParams, FetchCategoriesParams, FetchEmployeesParams, FetchProductsParams, FetchPromotionsParams, FetchStoresParams, FitImageOptions, ImageFitPlan, ImageRule, ImageRuleError, ImageSize, ImageTooSmallError, LookupDefinition, LookupKind, MERCHANT_COLOUR_KEYS, MERCHANT_FIELD_MAX_LENGTH, MERCHANT_IMAGE_SLOTS, MERCHANT_IMAGE_SLOT_KEYS, MERCHANT_LINK_KEYS, MERCHANT_LINK_PATHS, MERCHANT_OBJECT_FIELDS, MERCHANT_READ_ONLY_FIELDS, Merchant, MerchantColourKey, MerchantColourSet, MerchantColours, MerchantImageIds, MerchantImageSlot, MerchantImageSlotDefinition, MerchantLinkKey, MerchantLinks, MerchantPatch, MerchantResponse, MessageInfo, ParsedBasket, PrepareImageOptions, Product, ProductInstance, ProductInstanceInput, ProductInstances, ProductResponse, ProductSaveInput, Promotion, PromotionResponse, PromotionRuleSet, ReportData, ReportKey, ReportQuery, ReportQueryMap, ReportResponse, RepricedInstance, RequestOptions, ResourceDefinition, ResourceKind, SHOPWAVE_ENTITIES, SHOPWAVE_IMAGE_BASE_URL, SHOPWAVE_LOOKUPS, SHOPWAVE_RESOURCES, SHOPWAVE_UPLOAD, Saved, SessionStatus, ShopwaveApiError, ShopwaveErrorMap, Store, StoreResponse, SubmitEntityArgs, SubmitEntityResponse, SuccessMessage, UPLOAD_KINDS, UPLOAD_PREFIXES, UpdateMerchantOptions, UploadImageParams, UploadKind, UploadMerchantImageOptions, UploadPrefix, UploadedImage, User, UserEmployee, UserResponse, WritableEntityKind, apiDelete, apiGet, apiRequest, apiResponse, apiSend, assertNoApiErrors, authorizationFor, buildBasketReportQuery, buildConsumerMap, checkImageRule, collectConsumerIds, collectProductIds, combineBasketRows, computeBasketSummary, coverCrop, deleteCategory, deleteEmployee, deleteEntity, deleteEntityById, deleteProduct, deletePromotion, deleteStore, fetchCategories, fetchCategory, fetchConsumer, fetchConsumers, fetchEmployee, fetchEmployees, fetchEntityById, fetchMerchant, fetchProduct, fetchProductInstanceTags, fetchProductTags, fetchProducts, fetchProductsMap, fetchPromotion, fetchPromotions, fetchReport, fetchSession, fetchStore, fetchStores, fetchUser, findRepricedInstances, fitImageToSize, formatDateForQuery, getApiErrorMap, getApiErrors, getImageUrl, getMerchantImage, getMerchantImageUrl, imageFileName, isSameInstancePrice, isUploadKind, isUploadPrefix, loginPath, logout, logoutPath, merchantLinksFromForm, merchantLinksToForm, normalizeMerchantLinks, normalizeTagList, parseAspectRatio, parseBasketReportData, planImageFit, prepareImage, productImageRole, readImageSize, rolesById, saveCategory, saveEmployee, saveEntities, saveEntity, saveProduct, savePromotion, saveStore, setMerchantImage, submitEntity, toProductInstancesForSave, toShopwaveApiError, toStoredImageIds, toStoredProductImages, updateMerchant, uploadImage, uploadMerchantImage, validateMerchant, withToken };
+export { Basket, BasketFilters, BasketItem, BasketPagination, BasketReportRow, BasketSummary, Category, CategoryResponse, CombineBasketRowsParams, Consumer, ConsumerResponse, CropRect, DEFAULT_BASKET_FILTERS, DEFAULT_PAGINATION, DeletableEntityKind, Employee, EmployeeResponse, EntityDefinition, EntityId, EntityInput, EntityKind, EntityTypes, ErrorMessage, Extras, FetchByIdParams, FetchCategoriesParams, FetchEmployeesParams, FetchProductComponentsParams, FetchProductsParams, FetchPromotionsParams, FetchStoresParams, FitImageOptions, ImageFitPlan, ImageRule, ImageRuleError, ImageSize, ImageTooSmallError, LookupDefinition, LookupKind, MERCHANT_COLOUR_KEYS, MERCHANT_FIELD_MAX_LENGTH, MERCHANT_IMAGE_SLOTS, MERCHANT_IMAGE_SLOT_KEYS, MERCHANT_LINK_KEYS, MERCHANT_LINK_PATHS, MERCHANT_OBJECT_FIELDS, MERCHANT_READ_ONLY_FIELDS, Merchant, MerchantColourKey, MerchantColourSet, MerchantColours, MerchantImageIds, MerchantImageSlot, MerchantImageSlotDefinition, MerchantLinkKey, MerchantLinks, MerchantPatch, MerchantResponse, MessageInfo, ParsedBasket, PrepareImageOptions, Product, ProductComponent, ProductComponentInstance, ProductComponentInstanceInput, ProductComponentProduct, ProductComponentProductInput, ProductComponentSaveInput, ProductInstance, ProductInstanceInput, ProductInstances, ProductResponse, ProductSaveInput, Promotion, PromotionResponse, PromotionRuleSet, ReportData, ReportKey, ReportQuery, ReportQueryMap, ReportResponse, RepricedInstance, RequestOptions, ResourceDefinition, ResourceKind, SHOPWAVE_ENTITIES, SHOPWAVE_IMAGE_BASE_URL, SHOPWAVE_LOOKUPS, SHOPWAVE_RESOURCES, SHOPWAVE_UPLOAD, Saved, SessionStatus, ShopwaveApiError, ShopwaveErrorMap, Store, StoreResponse, SubmitEntityArgs, SubmitEntityResponse, SuccessMessage, UPLOAD_KINDS, UPLOAD_PREFIXES, UpdateMerchantOptions, UploadImageParams, UploadKind, UploadMerchantImageOptions, UploadPrefix, UploadedImage, User, UserEmployee, UserResponse, WritableEntityKind, apiDelete, apiGet, apiRequest, apiResponse, apiSend, assertNoApiErrors, authorizationFor, buildBasketReportQuery, buildConsumerMap, checkImageRule, collectConsumerIds, collectProductIds, combineBasketRows, computeBasketSummary, coverCrop, deleteCategory, deleteEmployee, deleteEntity, deleteEntityById, deleteProduct, deleteProductComponent, deleteProductComponentInstances, deletePromotion, deleteStore, fetchCategories, fetchCategory, fetchConsumer, fetchConsumers, fetchEmployee, fetchEmployees, fetchEntityById, fetchMerchant, fetchProduct, fetchProductComponent, fetchProductComponents, fetchProductInstanceTags, fetchProductTags, fetchProducts, fetchProductsMap, fetchPromotion, fetchPromotions, fetchReport, fetchSession, fetchStore, fetchStores, fetchUser, findRepricedInstances, fitImageToSize, formatDateForQuery, getApiErrorMap, getApiErrors, getImageUrl, getMerchantImage, getMerchantImageUrl, imageFileName, isSameInstancePrice, isUploadKind, isUploadPrefix, loginPath, logout, logoutPath, merchantLinksFromForm, merchantLinksToForm, normalizeMerchantLinks, normalizeTagList, parseAspectRatio, parseBasketReportData, planImageFit, prepareImage, productImageRole, readImageSize, rolesById, saveCategory, saveEmployee, saveEntities, saveEntity, saveProduct, saveProductComponent, savePromotion, saveStore, setMerchantImage, submitEntity, toProductComponentForSave, toProductInstancesForSave, toShopwaveApiError, toStoredImageIds, toStoredProductImages, updateMerchant, uploadImage, uploadMerchantImage, validateMerchant, withToken };
 //# sourceMappingURL=index.d.cts.map