react-shopwave-connect 0.4.5 → 0.4.6

package/dist/index.d.cts

@@ -850,8 +850,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 +892,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 +1079,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 +1095,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 +1112,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 +1131,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 +1161,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 +1190,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 +1202,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 +1228,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 +1239,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 +1352,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};

package/dist/index.d.ts

@@ -850,8 +850,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 +892,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 +1079,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 +1095,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 +1112,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 +1131,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 +1161,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 +1190,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 +1202,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 +1228,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 +1239,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 +1352,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};

package/dist/index.js

@@ -876,7 +876,7 @@ const STATIC_HOST = /^https?:\/\/static\.merchantstack\.com\/images\//i;
 /**
 * 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 `""`.
 */
 function getImageUrl(path, base = SHOPWAVE_IMAGE_BASE_URL) {
@@ -928,7 +928,7 @@ const MERCHANT_IMAGE_SLOT_KEYS = [
 	"featured"
 ];
 /**
-* 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).
 */
 const MERCHANT_IMAGE_SLOTS = Object.freeze({
@@ -1019,7 +1019,7 @@ function toStored(value) {
 }
 /**
 * 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 `{}`.
 */
 function toStoredImageIds(imageIds) {
@@ -1040,7 +1040,7 @@ async function uploadMerchantImage(file, slot, options = {}) {
 //#endregion
 //#region src/core/productImages.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};
@@ -1442,9 +1442,9 @@ function trimmed(value) {
 /**
 * 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.
 */
 function merchantLinksToForm(links) {
@@ -1481,7 +1481,7 @@ function merchantLinksFromForm(form) {
 	}
 	return out;
 }
-/** 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. */
 function normalizeMerchantLinks(links) {
 	return merchantLinksFromForm(merchantLinksToForm(links));
 }