react-shopwave-connect 0.4.3 → 0.4.5

package/dist/server/index.d.cts

@@ -275,18 +275,37 @@ 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";
 }>;
 /**
  * Read-only lists that aren't records: the merchant's distinct tags.
@@ -445,9 +464,11 @@ interface UploadOptions {
 }
 interface UploadHandlers {
   /**
-   * Multipart `file` + `kind` (see `UploadKind`) → `PUT {apiUrl}/uploader`.
-   * Answers with Shopwave's reply (201 `{ fileName, path, api }`); 400 for a
-   * missing file or unknown kind, 413 when too large, 415 for other types.
+   * Multipart `file` + `kind` (see `UploadKind`), and optionally `prefix`
+   * (see `UploadPrefix`) → `PUT {apiUrl}/uploader` with the `contentType` and
+   * `prefix` headers. Answers with Shopwave's reply (201 `{ fileName, path, api }`);
+   * 400 for a missing file or an unknown kind or prefix, 413 when too large,
+   * 415 for other types.
    */
   POST: RouteHandler;
 }
@@ -483,5 +504,5 @@ interface ShopwaveApiHandlers {
 declare function shopwaveDateTime(date?: Date): string;
 declare function createShopwaveApiHandlers(config: ShopwaveApiConfig): ShopwaveApiHandlers;
 //#endregion
-export { BLOCKED_EXTRAS, type CollectionHandlers, type DeletableEntityKind, type EntityDefinition, type EntityKind, type ForwardInit, type ItemHandlers, type LookupDefinition, type LookupKind, RequestBodyError, type ResourceDefinition, type ResourceHandlers, type ResourceKind, type RouteContext, type RouteHandler, SHOPWAVE_ENTITIES, SHOPWAVE_LOOKUPS, SHOPWAVE_RESOURCES, SHOPWAVE_TOKEN_EXPIRED_ERROR_ID, SHOPWAVE_UPLOAD, type ShopwaveApiConfig, type ShopwaveApiHandlers, ShopwaveAuthError, type ShopwaveAuthErrorCode, type ShopwaveOAuthClient, type ShopwaveOAuthConfig, type ShopwaveToken, type ShopwaveTokenResponse, UPLOAD_KINDS, type UploadHandlers, type UploadKind, type UploadOptions, type WritableEntityKind, assertOAuthConfig, authorizationHeader, createShopwaveApiHandlers, createShopwaveOAuth, createState, isExpiredTokenResponse, isTokenExpired, normalizeStoredToken, normalizeWriteBody, parseExtras, readRequestToken, safeEqual, sanitizeReturnTo, shopwaveDateTime, tokenFromResponse };
+export { BLOCKED_EXTRAS, type CollectionHandlers, type DeletableEntityKind, type EntityDefinition, type EntityKind, type ForwardInit, type ItemHandlers, type LookupDefinition, type LookupKind, RequestBodyError, type ResourceDefinition, type ResourceHandlers, type ResourceKind, type RouteContext, type RouteHandler, SHOPWAVE_ENTITIES, SHOPWAVE_LOOKUPS, SHOPWAVE_RESOURCES, SHOPWAVE_TOKEN_EXPIRED_ERROR_ID, SHOPWAVE_UPLOAD, type ShopwaveApiConfig, type ShopwaveApiHandlers, ShopwaveAuthError, type ShopwaveAuthErrorCode, type ShopwaveOAuthClient, type ShopwaveOAuthConfig, type ShopwaveToken, type ShopwaveTokenResponse, UPLOAD_KINDS, UPLOAD_PREFIXES, type UploadHandlers, type UploadKind, type UploadOptions, type UploadPrefix, type WritableEntityKind, assertOAuthConfig, authorizationHeader, createShopwaveApiHandlers, createShopwaveOAuth, createState, isExpiredTokenResponse, isTokenExpired, normalizeStoredToken, normalizeWriteBody, parseExtras, readRequestToken, safeEqual, sanitizeReturnTo, shopwaveDateTime, tokenFromResponse };
 //# sourceMappingURL=index.d.cts.map

package/dist/server/index.d.ts

@@ -275,18 +275,37 @@ 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";
 }>;
 /**
  * Read-only lists that aren't records: the merchant's distinct tags.
@@ -445,9 +464,11 @@ interface UploadOptions {
 }
 interface UploadHandlers {
   /**
-   * Multipart `file` + `kind` (see `UploadKind`) → `PUT {apiUrl}/uploader`.
-   * Answers with Shopwave's reply (201 `{ fileName, path, api }`); 400 for a
-   * missing file or unknown kind, 413 when too large, 415 for other types.
+   * Multipart `file` + `kind` (see `UploadKind`), and optionally `prefix`
+   * (see `UploadPrefix`) → `PUT {apiUrl}/uploader` with the `contentType` and
+   * `prefix` headers. Answers with Shopwave's reply (201 `{ fileName, path, api }`);
+   * 400 for a missing file or an unknown kind or prefix, 413 when too large,
+   * 415 for other types.
    */
   POST: RouteHandler;
 }
@@ -483,5 +504,5 @@ interface ShopwaveApiHandlers {
 declare function shopwaveDateTime(date?: Date): string;
 declare function createShopwaveApiHandlers(config: ShopwaveApiConfig): ShopwaveApiHandlers;
 //#endregion
-export { BLOCKED_EXTRAS, type CollectionHandlers, type DeletableEntityKind, type EntityDefinition, type EntityKind, type ForwardInit, type ItemHandlers, type LookupDefinition, type LookupKind, RequestBodyError, type ResourceDefinition, type ResourceHandlers, type ResourceKind, type RouteContext, type RouteHandler, SHOPWAVE_ENTITIES, SHOPWAVE_LOOKUPS, SHOPWAVE_RESOURCES, SHOPWAVE_TOKEN_EXPIRED_ERROR_ID, SHOPWAVE_UPLOAD, type ShopwaveApiConfig, type ShopwaveApiHandlers, ShopwaveAuthError, type ShopwaveAuthErrorCode, type ShopwaveOAuthClient, type ShopwaveOAuthConfig, type ShopwaveToken, type ShopwaveTokenResponse, UPLOAD_KINDS, type UploadHandlers, type UploadKind, type UploadOptions, type WritableEntityKind, assertOAuthConfig, authorizationHeader, createShopwaveApiHandlers, createShopwaveOAuth, createState, isExpiredTokenResponse, isTokenExpired, normalizeStoredToken, normalizeWriteBody, parseExtras, readRequestToken, safeEqual, sanitizeReturnTo, shopwaveDateTime, tokenFromResponse };
+export { BLOCKED_EXTRAS, type CollectionHandlers, type DeletableEntityKind, type EntityDefinition, type EntityKind, type ForwardInit, type ItemHandlers, type LookupDefinition, type LookupKind, RequestBodyError, type ResourceDefinition, type ResourceHandlers, type ResourceKind, type RouteContext, type RouteHandler, SHOPWAVE_ENTITIES, SHOPWAVE_LOOKUPS, SHOPWAVE_RESOURCES, SHOPWAVE_TOKEN_EXPIRED_ERROR_ID, SHOPWAVE_UPLOAD, type ShopwaveApiConfig, type ShopwaveApiHandlers, ShopwaveAuthError, type ShopwaveAuthErrorCode, type ShopwaveOAuthClient, type ShopwaveOAuthConfig, type ShopwaveToken, type ShopwaveTokenResponse, UPLOAD_KINDS, UPLOAD_PREFIXES, type UploadHandlers, type UploadKind, type UploadOptions, type UploadPrefix, type WritableEntityKind, assertOAuthConfig, authorizationHeader, createShopwaveApiHandlers, createShopwaveOAuth, createState, isExpiredTokenResponse, isTokenExpired, normalizeStoredToken, normalizeWriteBody, parseExtras, readRequestToken, safeEqual, sanitizeReturnTo, shopwaveDateTime, tokenFromResponse };
 //# sourceMappingURL=index.d.ts.map

package/dist/server/index.js

@@ -244,6 +244,74 @@ function safeEqual(a, b) {
 	return diff === 0;
 }
 
+//#endregion
+//#region src/core/resources.ts
+/**
+* - merchant: `GET /merchant`; `POST /merchant` with `{ merchant: { id, … } }`
+*   updates it (without an `id` the API would create a second merchant, so the
+*   route requires one).
+* - user: `GET /user` (read-only here; the API's `POST /user` invites users and
+*   needs the admin scope).
+*/
+const SHOPWAVE_RESOURCES = Object.freeze({
+	merchant: {
+		route: "merchant",
+		key: "merchant",
+		upstream: "merchant",
+		writable: true
+	},
+	user: {
+		route: "user",
+		key: "user",
+		upstream: "user",
+		writable: false
+	}
+});
+/** `UploadKind` → the API's `contentType` value. */
+const UPLOAD_KINDS = Object.freeze({
+	merchant: "merchant",
+	merchantFeature: "merchantFeature",
+	product: "product",
+	user: "user",
+	applicationLogo: "applicaionLogo",
+	applicationImages: "applicaionImages"
+});
+/** Every `UploadPrefix`, longest first so a name check never takes `product` for `product_thumbnail`. */
+const UPLOAD_PREFIXES = Object.freeze([
+	"product_thumbnail",
+	"variant_thumbnail",
+	"product",
+	"variant"
+]);
+/** How uploads are addressed (app route and Shopwave uploader). */
+const SHOPWAVE_UPLOAD = Object.freeze({
+	route: "upload",
+	upstream: "uploader",
+	kindHeader: "contentType",
+	prefixHeader: "prefix",
+	fileField: "file",
+	kindField: "kind",
+	prefixField: "prefix"
+});
+function isUploadKind(value) {
+	return typeof value === "string" && Object.prototype.hasOwnProperty.call(UPLOAD_KINDS, value);
+}
+function isUploadPrefix(value) {
+	return typeof value === "string" && UPLOAD_PREFIXES.includes(value);
+}
+const SHOPWAVE_LOOKUPS = Object.freeze({
+	productTags: {
+		route: "products/tags",
+		key: "tags",
+		upstream: "product/tags"
+	},
+	productInstanceTags: {
+		route: "products/instance-tags",
+		key: "tags",
+		upstream: "product/instance/tags"
+	}
+});
+
 //#endregion
 //#region src/core/entities.ts
 /**
@@ -320,62 +388,6 @@ const SHOPWAVE_ENTITIES = Object.freeze({
 	}
 });
 
-//#endregion
-//#region src/core/resources.ts
-/**
-* - merchant: `GET /merchant`; `POST /merchant` with `{ merchant: { id, … } }`
-*   updates it (without an `id` the API would create a second merchant, so the
-*   route requires one).
-* - user: `GET /user` (read-only here; the API's `POST /user` invites users and
-*   needs the admin scope).
-*/
-const SHOPWAVE_RESOURCES = Object.freeze({
-	merchant: {
-		route: "merchant",
-		key: "merchant",
-		upstream: "merchant",
-		writable: true
-	},
-	user: {
-		route: "user",
-		key: "user",
-		upstream: "user",
-		writable: false
-	}
-});
-/** `UploadKind` → the API's `contentType` value. */
-const UPLOAD_KINDS = Object.freeze({
-	merchant: "merchant",
-	merchantFeature: "merchantFeature",
-	product: "product",
-	user: "user",
-	applicationLogo: "applicaionLogo",
-	applicationImages: "applicaionImages"
-});
-/** How uploads are addressed (app route and Shopwave uploader). */
-const SHOPWAVE_UPLOAD = Object.freeze({
-	route: "upload",
-	upstream: "uploader",
-	kindHeader: "contentType",
-	fileField: "file",
-	kindField: "kind"
-});
-function isUploadKind(value) {
-	return typeof value === "string" && Object.prototype.hasOwnProperty.call(UPLOAD_KINDS, value);
-}
-const SHOPWAVE_LOOKUPS = Object.freeze({
-	productTags: {
-		route: "products/tags",
-		key: "tags",
-		upstream: "product/tags"
-	},
-	productInstanceTags: {
-		route: "products/instance-tags",
-		key: "tags",
-		upstream: "product/instance/tags"
-	}
-});
-
 //#endregion
 //#region src/server/api.ts
 /**
@@ -704,6 +716,8 @@ function createShopwaveApiHandlers(config) {
 		if (!file || typeof file === "string" || file.size === 0) return jsonError(400, "invalid_body", `Missing "${SHOPWAVE_UPLOAD.fileField}"`);
 		const kind = form.get(SHOPWAVE_UPLOAD.kindField);
 		if (!isUploadKind(kind)) return jsonError(400, "invalid_body", `"${SHOPWAVE_UPLOAD.kindField}" must be one of ${Object.keys(UPLOAD_KINDS).join(", ")}`);
+		const prefix = form.get(SHOPWAVE_UPLOAD.prefixField);
+		if (prefix !== null && !isUploadPrefix(prefix)) return jsonError(400, "invalid_body", `"${SHOPWAVE_UPLOAD.prefixField}" must be one of ${UPLOAD_PREFIXES.join(", ")}`);
 		if (file.size > maxBytes) return jsonError(413, "too_large", `The file is larger than ${maxBytes} bytes`);
 		if (!acceptsType(file.type || "", accept)) return jsonError(415, "unsupported_type", `Files of type "${file.type || "unknown"}" aren't accepted`);
 		const upstreamForm = new FormData();
@@ -711,7 +725,10 @@ function createShopwaveApiHandlers(config) {
 		return forward(request, {
 			method: "PUT",
 			path: SHOPWAVE_UPLOAD.upstream,
-			headers: { [SHOPWAVE_UPLOAD.kindHeader]: UPLOAD_KINDS[kind] },
+			headers: {
+				[SHOPWAVE_UPLOAD.kindHeader]: UPLOAD_KINDS[kind],
+				...prefix !== null ? { [SHOPWAVE_UPLOAD.prefixHeader]: prefix } : {}
+			},
 			formData: upstreamForm,
 			forwardExtras: false
 		});
@@ -840,5 +857,5 @@ function createShopwaveApiHandlers(config) {
 }
 
 //#endregion
-export { BLOCKED_EXTRAS, RequestBodyError, SHOPWAVE_ENTITIES, SHOPWAVE_LOOKUPS, SHOPWAVE_RESOURCES, SHOPWAVE_TOKEN_EXPIRED_ERROR_ID, SHOPWAVE_UPLOAD, ShopwaveAuthError, UPLOAD_KINDS, assertOAuthConfig, authorizationHeader, createShopwaveApiHandlers, createShopwaveOAuth, createState, isExpiredTokenResponse, isTokenExpired, normalizeStoredToken, normalizeWriteBody, parseExtras, readRequestToken, safeEqual, sanitizeReturnTo, shopwaveDateTime, tokenFromResponse };
+export { BLOCKED_EXTRAS, RequestBodyError, SHOPWAVE_ENTITIES, SHOPWAVE_LOOKUPS, SHOPWAVE_RESOURCES, SHOPWAVE_TOKEN_EXPIRED_ERROR_ID, SHOPWAVE_UPLOAD, ShopwaveAuthError, UPLOAD_KINDS, UPLOAD_PREFIXES, assertOAuthConfig, authorizationHeader, createShopwaveApiHandlers, createShopwaveOAuth, createState, isExpiredTokenResponse, isTokenExpired, normalizeStoredToken, normalizeWriteBody, parseExtras, readRequestToken, safeEqual, sanitizeReturnTo, shopwaveDateTime, tokenFromResponse };
 //# sourceMappingURL=index.js.map