react-shopwave-connect 0.4.5 → 0.4.7

package/dist/next/index.d.cts

@@ -126,8 +126,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";
 /**
  * Addressing per entity, following the Shopwave API reference
  * (https://developer.merchantstack.com/api-reference.html) and checked against
@@ -140,6 +147,27 @@ type EntityKind = "product" | "category" | "store" | "promotion" | "employee" |
  * - 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>>;
 //#endregion
@@ -185,8 +213,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
@@ -208,7 +236,7 @@ declare const UPLOAD_PREFIXES: ReadonlyArray<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").
@@ -303,7 +331,10 @@ interface ItemHandlers {
   GET: RouteHandler;
   /** Update the record at `[id]` (the id in the URL wins). */
   PUT: RouteHandler;
-  /** Delete the record at `[id]`. Shopwave answers 205 with an empty body. */
+  /**
+   * Delete the record at `[id]`. Shopwave answers 205 with an empty body. For an entity with
+   * `childIdsHeader`, `extras` carrying that key deletes just those child rows instead.
+   */
   DELETE: RouteHandler;
 }
 interface ResourceHandlers {

package/dist/next/index.d.ts

@@ -126,8 +126,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";
 /**
  * Addressing per entity, following the Shopwave API reference
  * (https://developer.merchantstack.com/api-reference.html) and checked against
@@ -140,6 +147,27 @@ type EntityKind = "product" | "category" | "store" | "promotion" | "employee" |
  * - 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>>;
 //#endregion
@@ -185,8 +213,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
@@ -208,7 +236,7 @@ declare const UPLOAD_PREFIXES: ReadonlyArray<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").
@@ -303,7 +331,10 @@ interface ItemHandlers {
   GET: RouteHandler;
   /** Update the record at `[id]` (the id in the URL wins). */
   PUT: RouteHandler;
-  /** Delete the record at `[id]`. Shopwave answers 205 with an empty body. */
+  /**
+   * Delete the record at `[id]`. Shopwave answers 205 with an empty body. For an entity with
+   * `childIdsHeader`, `extras` carrying that key deletes just those child rows instead.
+   */
   DELETE: RouteHandler;
 }
 interface ResourceHandlers {

package/dist/next/index.js

@@ -48,7 +48,7 @@ function tokenFromResponse(response, previous, now = Date.now()) {
 }
 /**
 * Reads a token from session storage. Accepts both the current shape and the
-* legacy raw response that older apps (e.g. AdminUI ≤ 0.1) stored directly in
+* legacy raw response that older apps stored directly in
 * the session, so existing sessions survive an upgrade.
 */
 function normalizeStoredToken(raw) {
@@ -330,6 +330,27 @@ const SHOPWAVE_LOOKUPS = Object.freeze({
 * - 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).
 */
 const SHOPWAVE_ENTITIES = Object.freeze({
 	product: {
@@ -389,6 +410,16 @@ const SHOPWAVE_ENTITIES = Object.freeze({
 		idHeader: "consumerId",
 		writable: false,
 		deleteMode: "none"
+	},
+	productComponent: {
+		route: "product-components",
+		collection: "productComponents",
+		upstream: "product/component",
+		idsHeader: "componentIds",
+		idHeader: "productComponentIds",
+		writable: true,
+		deleteMode: "delete",
+		childIdsHeader: "productComponentInstanceIds"
 	}
 });
 
@@ -478,7 +509,7 @@ function isPlainObject(value) {
 *
 * Accepts:
 *  - the SDK ≥ 0.3 shape `{ <collection>: { "0": {...}, "1": {...} } }` (refs kept),
-*  - the older AdminUI shapes `{ <collection>: { new: {...} } }` / `{ updated: {...} }`,
+*  - the older app shapes `{ <collection>: { new: {...} } }` / `{ updated: {...} }`,
 *  - a bare entity object `{ title: … }`.
 *
 * With `forcedId` (item routes) exactly one entity is allowed and its `id` is
@@ -562,6 +593,29 @@ async function readUpstream(response) {
 		};
 	}
 }
+/**
+* The child ids a DELETE names in `extras` under `header` (case-insensitive), as one comma
+* list: `undefined` when the key is absent, `null` when `extras` or the value is invalid (not a
+* JSON object, or not a non-empty list of ids). The key may hold an array or a comma string.
+*/
+function readChildIds(raw, header) {
+	if (!raw) return void 0;
+	let parsed;
+	try {
+		parsed = JSON.parse(raw);
+	} catch {
+		return null;
+	}
+	if (!isPlainObject(parsed)) return null;
+	const key = Object.keys(parsed).find((k) => k.toLowerCase() === header.toLowerCase());
+	if (key === void 0) return void 0;
+	const value = parsed[key];
+	const list = Array.isArray(value) ? value : typeof value === "string" || typeof value === "number" ? String(value).split(",") : null;
+	if (!list) return null;
+	const ids = list.map((v) => typeof v === "string" || typeof v === "number" ? String(v).trim() : "");
+	if (ids.length === 0 || ids.some((id) => !ID_PATTERN.test(id))) return null;
+	return ids.join(",");
+}
 async function routeParam(context, name) {
 	const value = (await context?.params)?.[name];
 	const id = Array.isArray(value) ? value[0] : value;
@@ -812,6 +866,19 @@ function createShopwaveApiHandlers(config) {
 					const id = await routeParam(context, param);
 					if (!id) return badId();
 					if (def.deleteMode === "none") return notSupported(def, "deletes");
+					if (def.deleteMode === "delete" && def.childIdsHeader) {
+						const childIds = readChildIds(request.headers.get("extras"), def.childIdsHeader);
+						if (childIds === null) return jsonError(400, "invalid_extras", `"${def.childIdsHeader}" must be a non-empty list of ids`);
+						if (childIds !== void 0) return forward(request, {
+							method: "DELETE",
+							path: def.upstream,
+							headers: {
+								[def.idHeader]: id,
+								[def.childIdsHeader]: childIds
+							},
+							forwardExtras: false
+						});
+					}
 					if (def.deleteMode === "retire") {
 						const field = def.retireField ?? "exitDate";
 						if (def.retireWithRecord) return retireWithRecord(request, def, id, field);