react-shopwave-connect 0.4.2 → 0.4.4

package/dist/core/index.d.cts

@@ -340,6 +340,26 @@ declare function fetchProductsMap(productIds: number[] | null | undefined, optio
   [id: number]: Product;
 }>;
 //#endregion
+//#region src/core/productTags.d.ts
+/**
+ * Turns a tag list from the API into clean strings: trims each tag, drops
+ * blanks and anything that isn't text, and removes exact duplicates (first one
+ * wins). The API's own order is kept. A map is accepted too (its values are
+ * used), in case the API ever answers keyed by id.
+ */
+declare function normalizeTagList(value: unknown): string[];
+/**
+ * Every distinct tag used on the merchant's products (`GET /product/tags`),
+ * for a tag field's suggestions. Returns `[]` when there are none.
+ */
+declare function fetchProductTags(options?: RequestOptions): Promise<string[]>;
+/**
+ * Every distinct tag used on the merchant's price instances
+ * (`GET /product/instance/tags`): the channel names (Eat In, Takeout, …).
+ * Returns `[]` when there are none.
+ */
+declare function fetchProductInstanceTags(options?: RequestOptions): Promise<string[]>;
+//#endregion
 //#region src/core/promotion.d.ts
 /** Promotion rule identifiers as stored by the Shopwave API. */
 declare enum PromotionRuleSet {
@@ -537,8 +557,9 @@ declare function submitEntity<R = any>({
 //#region src/core/entities.d.ts
 /**
  * How each Shopwave entity is addressed, shared by the client functions below
- * and the server route handlers in `react-shopwave-connect/next`, so the two
- * halves of the contract can't drift apart.
+ * and the server route handlers in `react-shopwave-connect/server` (wrapped with
+ * the session by `react-shopwave-connect/next`), so the two halves of the
+ * contract can't drift apart.
  */
 interface EntityDefinition {
   /** App route segment: `/api/<route>` and `/api/<route>/<id>`. */
@@ -655,6 +676,9 @@ declare function fetchEntityById<K extends EntityKind>(kind: K, id: EntityId, pa
  * read) so an edited price is sent as a new instance. As a safeguard, a new
  * product (no `id`, e.g. a duplicate) never sends instance ids: an id copied from
  * another product would otherwise point the save at that product's instances.
+ *
+ * `images` is sent as file names ({@link toStoredProductImages}), so the URLs a
+ * read returns can be passed straight back; leaving `images` out keeps them.
  */
 declare const saveProduct: (product: ProductSaveInput, options?: RequestOptions) => Promise<Saved<Product>>;
 declare const deleteProduct: (id: EntityId, options?: RequestOptions) => Promise<void>;
@@ -790,7 +814,7 @@ declare function buildConsumerMap(consumers: Consumer[] | null | undefined): {
  *
  * Like `SHOPWAVE_ENTITIES`, this table is shared by the client functions
  * (`fetchMerchant`, `fetchUser`, `uploadImage`, …) and the server route
- * handlers in `react-shopwave-connect/next`, so the two halves of the contract
+ * handlers in `react-shopwave-connect/server`, so the two halves of the contract
  * can't drift apart. These aren't in `SHOPWAVE_ENTITIES` because they aren't
  * keyed collections: `GET /merchant` answers `{ merchant: {…} }`, not a map by id.
  */
@@ -823,20 +847,69 @@ declare const SHOPWAVE_RESOURCES: Readonly<Record<ResourceKind, ResourceDefiniti
 type UploadKind = "merchant" | "merchantFeature" | "product" | "user" | "applicationLogo" | "applicationImages";
 /** `UploadKind` → the API's `contentType` value. */
 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.
+ * - `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
+ *   (used by the Connect integrations).
+ *
+ * Values are the ones Connect's `uploadFileToShopwave` sends.
+ */
+type UploadPrefix = "product" | "product_thumbnail" | "variant" | "variant_thumbnail";
+/** Every `UploadPrefix`, longest first so a name check never takes `product` for `product_thumbnail`. */
+declare const UPLOAD_PREFIXES: ReadonlyArray<UploadPrefix>;
 /** How uploads are addressed (app route and Shopwave uploader). */
 declare const SHOPWAVE_UPLOAD: Readonly<{
-  /** App route: `POST /api/<route>` (multipart `file` + `kind`). */
+  /** App route: `POST /api/<route>` (multipart `file` + `kind`, optional `prefix`). */
   route: "upload";
   /** Shopwave path: `PUT {apiUrl}/uploader` (multipart `file`). */
   upstream: "uploader";
   /** Header that carries the upload kind upstream. */
   kindHeader: "contentType";
+  /** Header that carries the image role upstream (see `UploadPrefix`). */
+  prefixHeader: "prefix";
   /** Multipart field name for the file, on both sides. */
   fileField: "file";
   /** Multipart field name for the kind in the app request. */
   kindField: "kind";
+  /** Multipart field name for the image role in the app request. */
+  prefixField: "prefix";
 }>;
 declare function isUploadKind(value: unknown): value is UploadKind;
+declare function isUploadPrefix(value: unknown): value is UploadPrefix;
+/**
+ * Read-only lists that aren't records: the merchant's distinct tags.
+ *
+ * Like `SHOPWAVE_RESOURCES`, shared by the client functions
+ * (`fetchProductTags`, `fetchProductInstanceTags`) and the server route
+ * handlers (`shopwave.lookup(kind)`), so the two halves can't drift apart.
+ *
+ * - productTags: `GET /product/tags` → `{ tags: string[] }`, every distinct tag
+ *   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
+ *   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").
+ *
+ * The app route for instance tags is `products/instance-tags`, one segment
+ * under `products`, so it sits beside `products/[id]` without nesting deeper.
+ */
+interface LookupDefinition {
+  /** App route: `/api/<route>`. */
+  route: string;
+  /** Key of the list in the response (`{ tags: [...] }`). */
+  key: string;
+  /** Shopwave API path. */
+  upstream: string;
+}
+type LookupKind = "productTags" | "productInstanceTags";
+declare const SHOPWAVE_LOOKUPS: Readonly<Record<LookupKind, LookupDefinition>>;
 //#endregion
 //#region src/core/imageFit.d.ts
 /**
@@ -883,6 +956,12 @@ declare function fitImageToSize(file: Blob, width: number, height: number, optio
 interface UploadImageParams {
   /** What the image is for (sent to Shopwave as the uploader's `contentType`). */
   kind: UploadKind;
+  /**
+   * The image's role (sent to Shopwave as the uploader's `prefix` header), e.g.
+   * `product_thumbnail` for a product's lead image. Leave it out for images
+   * without a role (merchant logos).
+   */
+  prefix?: UploadPrefix;
   /** File name to send when `file` is a Blob without one. Defaults to `File.name`, else `"upload"`. */
   fileName?: string;
 }
@@ -1174,5 +1253,30 @@ interface UserResponse {
 /** Reads the logged-in user, or `null` when the API returns none. */
 declare function fetchUser(options?: RequestOptions): Promise<User | null>;
 //#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, ImageSize, 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, 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_RESOURCES, SHOPWAVE_UPLOAD, Saved, SessionStatus, ShopwaveApiError, ShopwaveErrorMap, Store, StoreResponse, SubmitEntityArgs, SubmitEntityResponse, SuccessMessage, UPLOAD_KINDS, UpdateMerchantOptions, UploadImageParams, UploadKind, UploadMerchantImageOptions, UploadedImage, User, UserEmployee, UserResponse, WritableEntityKind, apiDelete, apiGet, apiRequest, apiResponse, apiSend, assertNoApiErrors, authorizationFor, buildBasketReportQuery, buildConsumerMap, collectConsumerIds, collectProductIds, combineBasketRows, computeBasketSummary, coverCrop, deleteCategory, deleteEmployee, deleteEntity, deleteEntityById, deleteProduct, deletePromotion, deleteStore, fetchCategories, fetchCategory, fetchConsumer, fetchConsumers, fetchEmployee, fetchEmployees, fetchEntityById, fetchMerchant, fetchProduct, fetchProducts, fetchProductsMap, fetchPromotion, fetchPromotions, fetchReport, fetchSession, fetchStore, fetchStores, fetchUser, findRepricedInstances, fitImageToSize, formatDateForQuery, getApiErrorMap, getApiErrors, getImageUrl, getMerchantImage, getMerchantImageUrl, imageFileName, isSameInstancePrice, isUploadKind, loginPath, logout, logoutPath, merchantLinksFromForm, merchantLinksToForm, normalizeMerchantLinks, parseBasketReportData, readImageSize, rolesById, saveCategory, saveEmployee, saveEntities, saveEntity, saveProduct, savePromotion, saveStore, setMerchantImage, submitEntity, toProductInstancesForSave, toShopwaveApiError, toStoredImageIds, updateMerchant, uploadImage, uploadMerchantImage, validateMerchant, withToken };
+//#region src/core/productImages.d.ts
+/**
+ * Product images, as the live API stores them (merchant 5644, 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};
+ *   `saveProduct` does this for you).
+ * - The uploader takes one file per request. With a `prefix` (see
+ *   `UploadPrefix`) it names the file `<prefix>_<hash>.<ext>`
+ *   (`product_thumbnail_1bdd…41090b.png`); without one, `<hash>.<ext>`. So an
+ *   image's role can be read back from its name ({@link productImageRole}).
+ */
+/**
+ * The role in an image's file name or URL, from the uploader's `prefix`:
+ * `"…/product_thumbnail_1bdd.png"` → `"product_thumbnail"`. `null` for a name
+ * without one (images uploaded without a prefix, e.g. before prefixes existed).
+ */
+declare function productImageRole(value: unknown): UploadPrefix | null;
+/**
+ * A product's `images` as the API takes them on a save: file names, not the
+ * URLs a read returns. Non-strings, blanks and duplicates are dropped; the
+ * order is kept.
+ */
+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, ImageSize, 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, 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, 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, parseBasketReportData, productImageRole, readImageSize, rolesById, saveCategory, saveEmployee, saveEntities, saveEntity, saveProduct, savePromotion, saveStore, setMerchantImage, submitEntity, toProductInstancesForSave, toShopwaveApiError, toStoredImageIds, toStoredProductImages, updateMerchant, uploadImage, uploadMerchantImage, validateMerchant, withToken };
 //# sourceMappingURL=index.d.cts.map

package/dist/core/index.d.ts

@@ -340,6 +340,26 @@ declare function fetchProductsMap(productIds: number[] | null | undefined, optio
   [id: number]: Product;
 }>;
 //#endregion
+//#region src/core/productTags.d.ts
+/**
+ * Turns a tag list from the API into clean strings: trims each tag, drops
+ * blanks and anything that isn't text, and removes exact duplicates (first one
+ * wins). The API's own order is kept. A map is accepted too (its values are
+ * used), in case the API ever answers keyed by id.
+ */
+declare function normalizeTagList(value: unknown): string[];
+/**
+ * Every distinct tag used on the merchant's products (`GET /product/tags`),
+ * for a tag field's suggestions. Returns `[]` when there are none.
+ */
+declare function fetchProductTags(options?: RequestOptions): Promise<string[]>;
+/**
+ * Every distinct tag used on the merchant's price instances
+ * (`GET /product/instance/tags`): the channel names (Eat In, Takeout, …).
+ * Returns `[]` when there are none.
+ */
+declare function fetchProductInstanceTags(options?: RequestOptions): Promise<string[]>;
+//#endregion
 //#region src/core/promotion.d.ts
 /** Promotion rule identifiers as stored by the Shopwave API. */
 declare enum PromotionRuleSet {
@@ -537,8 +557,9 @@ declare function submitEntity<R = any>({
 //#region src/core/entities.d.ts
 /**
  * How each Shopwave entity is addressed, shared by the client functions below
- * and the server route handlers in `react-shopwave-connect/next`, so the two
- * halves of the contract can't drift apart.
+ * and the server route handlers in `react-shopwave-connect/server` (wrapped with
+ * the session by `react-shopwave-connect/next`), so the two halves of the
+ * contract can't drift apart.
  */
 interface EntityDefinition {
   /** App route segment: `/api/<route>` and `/api/<route>/<id>`. */
@@ -655,6 +676,9 @@ declare function fetchEntityById<K extends EntityKind>(kind: K, id: EntityId, pa
  * read) so an edited price is sent as a new instance. As a safeguard, a new
  * product (no `id`, e.g. a duplicate) never sends instance ids: an id copied from
  * another product would otherwise point the save at that product's instances.
+ *
+ * `images` is sent as file names ({@link toStoredProductImages}), so the URLs a
+ * read returns can be passed straight back; leaving `images` out keeps them.
  */
 declare const saveProduct: (product: ProductSaveInput, options?: RequestOptions) => Promise<Saved<Product>>;
 declare const deleteProduct: (id: EntityId, options?: RequestOptions) => Promise<void>;
@@ -790,7 +814,7 @@ declare function buildConsumerMap(consumers: Consumer[] | null | undefined): {
  *
  * Like `SHOPWAVE_ENTITIES`, this table is shared by the client functions
  * (`fetchMerchant`, `fetchUser`, `uploadImage`, …) and the server route
- * handlers in `react-shopwave-connect/next`, so the two halves of the contract
+ * handlers in `react-shopwave-connect/server`, so the two halves of the contract
  * can't drift apart. These aren't in `SHOPWAVE_ENTITIES` because they aren't
  * keyed collections: `GET /merchant` answers `{ merchant: {…} }`, not a map by id.
  */
@@ -823,20 +847,69 @@ declare const SHOPWAVE_RESOURCES: Readonly<Record<ResourceKind, ResourceDefiniti
 type UploadKind = "merchant" | "merchantFeature" | "product" | "user" | "applicationLogo" | "applicationImages";
 /** `UploadKind` → the API's `contentType` value. */
 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.
+ * - `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
+ *   (used by the Connect integrations).
+ *
+ * Values are the ones Connect's `uploadFileToShopwave` sends.
+ */
+type UploadPrefix = "product" | "product_thumbnail" | "variant" | "variant_thumbnail";
+/** Every `UploadPrefix`, longest first so a name check never takes `product` for `product_thumbnail`. */
+declare const UPLOAD_PREFIXES: ReadonlyArray<UploadPrefix>;
 /** How uploads are addressed (app route and Shopwave uploader). */
 declare const SHOPWAVE_UPLOAD: Readonly<{
-  /** App route: `POST /api/<route>` (multipart `file` + `kind`). */
+  /** App route: `POST /api/<route>` (multipart `file` + `kind`, optional `prefix`). */
   route: "upload";
   /** Shopwave path: `PUT {apiUrl}/uploader` (multipart `file`). */
   upstream: "uploader";
   /** Header that carries the upload kind upstream. */
   kindHeader: "contentType";
+  /** Header that carries the image role upstream (see `UploadPrefix`). */
+  prefixHeader: "prefix";
   /** Multipart field name for the file, on both sides. */
   fileField: "file";
   /** Multipart field name for the kind in the app request. */
   kindField: "kind";
+  /** Multipart field name for the image role in the app request. */
+  prefixField: "prefix";
 }>;
 declare function isUploadKind(value: unknown): value is UploadKind;
+declare function isUploadPrefix(value: unknown): value is UploadPrefix;
+/**
+ * Read-only lists that aren't records: the merchant's distinct tags.
+ *
+ * Like `SHOPWAVE_RESOURCES`, shared by the client functions
+ * (`fetchProductTags`, `fetchProductInstanceTags`) and the server route
+ * handlers (`shopwave.lookup(kind)`), so the two halves can't drift apart.
+ *
+ * - productTags: `GET /product/tags` → `{ tags: string[] }`, every distinct tag
+ *   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
+ *   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").
+ *
+ * The app route for instance tags is `products/instance-tags`, one segment
+ * under `products`, so it sits beside `products/[id]` without nesting deeper.
+ */
+interface LookupDefinition {
+  /** App route: `/api/<route>`. */
+  route: string;
+  /** Key of the list in the response (`{ tags: [...] }`). */
+  key: string;
+  /** Shopwave API path. */
+  upstream: string;
+}
+type LookupKind = "productTags" | "productInstanceTags";
+declare const SHOPWAVE_LOOKUPS: Readonly<Record<LookupKind, LookupDefinition>>;
 //#endregion
 //#region src/core/imageFit.d.ts
 /**
@@ -883,6 +956,12 @@ declare function fitImageToSize(file: Blob, width: number, height: number, optio
 interface UploadImageParams {
   /** What the image is for (sent to Shopwave as the uploader's `contentType`). */
   kind: UploadKind;
+  /**
+   * The image's role (sent to Shopwave as the uploader's `prefix` header), e.g.
+   * `product_thumbnail` for a product's lead image. Leave it out for images
+   * without a role (merchant logos).
+   */
+  prefix?: UploadPrefix;
   /** File name to send when `file` is a Blob without one. Defaults to `File.name`, else `"upload"`. */
   fileName?: string;
 }
@@ -1174,5 +1253,30 @@ interface UserResponse {
 /** Reads the logged-in user, or `null` when the API returns none. */
 declare function fetchUser(options?: RequestOptions): Promise<User | null>;
 //#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, ImageSize, 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, 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_RESOURCES, SHOPWAVE_UPLOAD, Saved, SessionStatus, ShopwaveApiError, ShopwaveErrorMap, Store, StoreResponse, SubmitEntityArgs, SubmitEntityResponse, SuccessMessage, UPLOAD_KINDS, UpdateMerchantOptions, UploadImageParams, UploadKind, UploadMerchantImageOptions, UploadedImage, User, UserEmployee, UserResponse, WritableEntityKind, apiDelete, apiGet, apiRequest, apiResponse, apiSend, assertNoApiErrors, authorizationFor, buildBasketReportQuery, buildConsumerMap, collectConsumerIds, collectProductIds, combineBasketRows, computeBasketSummary, coverCrop, deleteCategory, deleteEmployee, deleteEntity, deleteEntityById, deleteProduct, deletePromotion, deleteStore, fetchCategories, fetchCategory, fetchConsumer, fetchConsumers, fetchEmployee, fetchEmployees, fetchEntityById, fetchMerchant, fetchProduct, fetchProducts, fetchProductsMap, fetchPromotion, fetchPromotions, fetchReport, fetchSession, fetchStore, fetchStores, fetchUser, findRepricedInstances, fitImageToSize, formatDateForQuery, getApiErrorMap, getApiErrors, getImageUrl, getMerchantImage, getMerchantImageUrl, imageFileName, isSameInstancePrice, isUploadKind, loginPath, logout, logoutPath, merchantLinksFromForm, merchantLinksToForm, normalizeMerchantLinks, parseBasketReportData, readImageSize, rolesById, saveCategory, saveEmployee, saveEntities, saveEntity, saveProduct, savePromotion, saveStore, setMerchantImage, submitEntity, toProductInstancesForSave, toShopwaveApiError, toStoredImageIds, updateMerchant, uploadImage, uploadMerchantImage, validateMerchant, withToken };
+//#region src/core/productImages.d.ts
+/**
+ * Product images, as the live API stores them (merchant 5644, 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};
+ *   `saveProduct` does this for you).
+ * - The uploader takes one file per request. With a `prefix` (see
+ *   `UploadPrefix`) it names the file `<prefix>_<hash>.<ext>`
+ *   (`product_thumbnail_1bdd…41090b.png`); without one, `<hash>.<ext>`. So an
+ *   image's role can be read back from its name ({@link productImageRole}).
+ */
+/**
+ * The role in an image's file name or URL, from the uploader's `prefix`:
+ * `"…/product_thumbnail_1bdd.png"` → `"product_thumbnail"`. `null` for a name
+ * without one (images uploaded without a prefix, e.g. before prefixes existed).
+ */
+declare function productImageRole(value: unknown): UploadPrefix | null;
+/**
+ * A product's `images` as the API takes them on a save: file names, not the
+ * URLs a read returns. Non-strings, blanks and duplicates are dropped; the
+ * order is kept.
+ */
+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, ImageSize, 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, 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, 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, parseBasketReportData, productImageRole, readImageSize, rolesById, saveCategory, saveEmployee, saveEntities, saveEntity, saveProduct, savePromotion, saveStore, setMerchantImage, submitEntity, toProductInstancesForSave, toShopwaveApiError, toStoredImageIds, toStoredProductImages, updateMerchant, uploadImage, uploadMerchantImage, validateMerchant, withToken };
 //# sourceMappingURL=index.d.ts.map