react-shopwave-connect 0.4.6 → 0.4.7

package/dist/index.cjs

@@ -211,12 +211,15 @@ async function apiSend(path, method, payload, options = {}) {
 /**
 * 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).
 */
-async function apiDelete(path, options = {}) {
+async function apiDelete(path, options = {}, extras) {
+	const headers = baseHeaders(options);
+	if (extras) headers.extras = JSON.stringify(buildExtras(extras));
 	const { status, body } = await send(path, {
 		method: "DELETE",
-		headers: baseHeaders(options)
+		headers
 	}, options);
 	if (getApiErrorMap(body)) throw toShopwaveApiError(status, body);
 	return body;
@@ -487,133 +490,6 @@ function fetchProductInstanceTags(options = {}) {
 	return fetchLookup("productInstanceTags", options);
 }
 
-//#endregion
-//#region src/core/promotion.ts
-/** Promotion rule identifiers as stored by the Shopwave API. */
-let PromotionRuleSet = /* @__PURE__ */ function(PromotionRuleSet$1) {
-	PromotionRuleSet$1["Percentage"] = "|%^/";
-	PromotionRuleSet$1["Combo"] = "&%</";
-	PromotionRuleSet$1["MealDeal"] = "&=^/";
-	return PromotionRuleSet$1;
-}({});
-/**
-* Fetches promotions. Returns the flattened `Promotion[]`.
-*/
-async function fetchPromotions(params = {}, options = {}) {
-	const extras = { deleted: params.deleted ?? false };
-	if (params.promotionIds) extras.promotionIds = params.promotionIds;
-	if (params.imminent !== void 0) extras.imminent = params.imminent;
-	if (params.active !== void 0) extras.active = params.active;
-	if (params.expired !== void 0) extras.expired = params.expired;
-	const json = await apiGet("/api/promotions", extras, withToken(options, params.token));
-	assertNoApiErrors(json, 200);
-	return Object.values(json?.promotions ?? {});
-}
-
-//#endregion
-//#region src/core/store.ts
-/**
-* Fetches stores. Returns the flattened `Store[]`.
-*/
-async function fetchStores(params = {}, options = {}) {
-	const extras = { deleted: params.deleted ?? false };
-	if (params.storeIds) extras.storeIds = params.storeIds;
-	const json = await apiGet("/api/stores", extras, withToken(options, params.token));
-	assertNoApiErrors(json, 200);
-	return Object.values(json?.stores ?? {});
-}
-
-//#endregion
-//#region src/core/report.ts
-/**
-* 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.
-*/
-async function fetchReport(query, options = {}) {
-	const json = await apiGet("/api/report", { query: JSON.stringify(query) }, options);
-	assertNoApiErrors(json, 200);
-	return json?.reports ?? {};
-}
-
-//#endregion
-//#region src/core/session.ts
-/**
-* 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.
-*/
-async function fetchSession(options = {}) {
-	const doFetch = options.fetch ?? (typeof fetch !== "undefined" ? fetch : void 0);
-	if (!doFetch) throw new Error("No fetch implementation available. Pass `options.fetch`.");
-	const response = await doFetch(`${options.baseUrl ?? ""}/api/session`, {
-		method: "GET",
-		headers: { Accept: "application/json" },
-		cache: "no-store",
-		credentials: "same-origin",
-		signal: options.signal
-	});
-	if (response.status === 401) return { loggedIn: false };
-	if (!response.ok) throw new Error(`Session request failed (${response.status})`);
-	const json = await response.json();
-	if (json && typeof json.loggedIn === "boolean") return {
-		loggedIn: json.loggedIn,
-		expiresAt: typeof json.expiresAt === "number" ? json.expiresAt : void 0
-	};
-	return { loggedIn: Boolean(json && json.token) };
-}
-/**
-* Path that starts a login and returns to `returnTo` afterwards.
-* Navigate the browser to it (`window.location.href = loginPath(...)`).
-*/
-function loginPath(returnTo, authPath = "/auth") {
-	return returnTo ? `${authPath}?returnTo=${encodeURIComponent(returnTo)}` : authPath;
-}
-/** Path that logs out of the app and the Shopwave auth server. */
-function logoutPath(authPath = "/auth") {
-	return `${authPath}/logout`;
-}
-/**
-* 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.
-*/
-async function logout(options = {}) {
-	await apiDelete("/api/session?action=logout", options);
-}
-
-//#endregion
-//#region src/core/entity.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}`.
-*/
-async function deleteEntity(resourcePath, entityId, options = {}) {
-	if (entityId == null || entityId === "") throw new Error("entityId is missing");
-	await apiDelete(`/api/${resourcePath}/${entityId}`, options);
-}
-/**
-* 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.
-*/
-async function submitEntity({ endpoint, method = "POST", payload }, options = {}) {
-	const json = await apiSend(endpoint, method, payload, options);
-	assertNoApiErrors(json, 200);
-	if (json && typeof json === "object" && "result" in json) return json.result;
-	return json ?? void 0;
-}
-
 //#endregion
 //#region src/core/imageFit.ts
 /**
@@ -1109,6 +985,27 @@ function toStoredProductImages(images) {
 * - 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: {
@@ -1168,6 +1065,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"
 	}
 });
 function definition(kind) {
@@ -1293,6 +1200,237 @@ const deleteEmployee = (id, options) => deleteEntityById("employee", id, options
 const fetchEmployee = (id, params, options) => fetchEntityById("employee", id, params, options);
 const fetchConsumer = (id, params, options) => fetchEntityById("consumer", id, params, options);
 
+//#endregion
+//#region src/core/productComponent.ts
+/** Row fields the server sets; never sent back. */
+const SERVER_ROW_FIELDS = [
+	"id",
+	"activeDate",
+	"deleteDate",
+	"timestamp"
+];
+const isObject = (v) => !!v && typeof v === "object" && !Array.isArray(v);
+function listOf(value) {
+	if (!value) return [];
+	if (Array.isArray(value)) return value.map((v) => [null, v]);
+	return Object.entries(value);
+}
+/**
+* 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}.
+*/
+function toProductComponentForSave(input) {
+	const { products,...group } = input;
+	if (products == null) return { ...group };
+	const out = {};
+	for (const [key, product] of listOf(products)) {
+		if (!isObject(product)) continue;
+		const id = product.id ?? key;
+		if (id == null || String(id).trim() === "") continue;
+		const { productInstances,...rest } = product;
+		const rows = {};
+		let index = 0;
+		for (const [, row] of listOf(productInstances)) {
+			if (!isObject(row) || row.deleteDate) continue;
+			const copy = { ...row };
+			for (const field of SERVER_ROW_FIELDS) delete copy[field];
+			if (Array.isArray(copy.tags)) copy.tags = copy.tags.map(String).join(",");
+			rows[String(index++)] = copy;
+		}
+		out[String(id)] = {
+			...rest,
+			id,
+			productInstances: rows
+		};
+	}
+	return {
+		...group,
+		products: out
+	};
+}
+/**
+* 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.
+*/
+async function fetchProductComponents(params = {}, options = {}) {
+	const def = SHOPWAVE_ENTITIES.productComponent;
+	if (params.productIds?.length === 0 || params.productComponentIds?.length === 0) return [];
+	const extras = { deleted: params.deleted ?? false };
+	if (params.productIds) extras.productIds = params.productIds;
+	if (params.productComponentIds) extras[def.idsHeader] = params.productComponentIds;
+	const json = await apiGet(`/api/${def.route}`, extras, options);
+	assertNoApiErrors(json, 200);
+	const map = json?.[def.collection];
+	return isObject(map) ? Object.values(map) : [];
+}
+/**
+* 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.
+*/
+const fetchProductComponent = (id, params, options) => fetchEntityById("productComponent", id, params, options);
+/**
+* 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.
+*/
+const saveProductComponent = (input, options) => saveEntity("productComponent", toProductComponentForSave(input), options);
+/** Deletes a product component (soft delete: `deleted: true` reads still return it). */
+const deleteProductComponent = (id, options) => deleteEntityById("productComponent", id, options);
+/**
+* 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.
+*/
+async function deleteProductComponentInstances(id, instanceIds, options = {}) {
+	const def = SHOPWAVE_ENTITIES.productComponent;
+	const groupId = id == null ? "" : String(id).trim();
+	if (!groupId) throw new Error("productComponent id is missing");
+	const ids = (instanceIds ?? []).map((v) => String(v).trim()).filter(Boolean);
+	if (ids.length === 0) throw new Error("productComponent instance ids are missing");
+	await apiDelete(`/api/${def.route}/${encodeURIComponent(groupId)}`, options, { [def.childIdsHeader]: ids.join(",") });
+}
+
+//#endregion
+//#region src/core/promotion.ts
+/** Promotion rule identifiers as stored by the Shopwave API. */
+let PromotionRuleSet = /* @__PURE__ */ function(PromotionRuleSet$1) {
+	PromotionRuleSet$1["Percentage"] = "|%^/";
+	PromotionRuleSet$1["Combo"] = "&%</";
+	PromotionRuleSet$1["MealDeal"] = "&=^/";
+	return PromotionRuleSet$1;
+}({});
+/**
+* Fetches promotions. Returns the flattened `Promotion[]`.
+*/
+async function fetchPromotions(params = {}, options = {}) {
+	const extras = { deleted: params.deleted ?? false };
+	if (params.promotionIds) extras.promotionIds = params.promotionIds;
+	if (params.imminent !== void 0) extras.imminent = params.imminent;
+	if (params.active !== void 0) extras.active = params.active;
+	if (params.expired !== void 0) extras.expired = params.expired;
+	const json = await apiGet("/api/promotions", extras, withToken(options, params.token));
+	assertNoApiErrors(json, 200);
+	return Object.values(json?.promotions ?? {});
+}
+
+//#endregion
+//#region src/core/store.ts
+/**
+* Fetches stores. Returns the flattened `Store[]`.
+*/
+async function fetchStores(params = {}, options = {}) {
+	const extras = { deleted: params.deleted ?? false };
+	if (params.storeIds) extras.storeIds = params.storeIds;
+	const json = await apiGet("/api/stores", extras, withToken(options, params.token));
+	assertNoApiErrors(json, 200);
+	return Object.values(json?.stores ?? {});
+}
+
+//#endregion
+//#region src/core/report.ts
+/**
+* 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.
+*/
+async function fetchReport(query, options = {}) {
+	const json = await apiGet("/api/report", { query: JSON.stringify(query) }, options);
+	assertNoApiErrors(json, 200);
+	return json?.reports ?? {};
+}
+
+//#endregion
+//#region src/core/session.ts
+/**
+* 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.
+*/
+async function fetchSession(options = {}) {
+	const doFetch = options.fetch ?? (typeof fetch !== "undefined" ? fetch : void 0);
+	if (!doFetch) throw new Error("No fetch implementation available. Pass `options.fetch`.");
+	const response = await doFetch(`${options.baseUrl ?? ""}/api/session`, {
+		method: "GET",
+		headers: { Accept: "application/json" },
+		cache: "no-store",
+		credentials: "same-origin",
+		signal: options.signal
+	});
+	if (response.status === 401) return { loggedIn: false };
+	if (!response.ok) throw new Error(`Session request failed (${response.status})`);
+	const json = await response.json();
+	if (json && typeof json.loggedIn === "boolean") return {
+		loggedIn: json.loggedIn,
+		expiresAt: typeof json.expiresAt === "number" ? json.expiresAt : void 0
+	};
+	return { loggedIn: Boolean(json && json.token) };
+}
+/**
+* Path that starts a login and returns to `returnTo` afterwards.
+* Navigate the browser to it (`window.location.href = loginPath(...)`).
+*/
+function loginPath(returnTo, authPath = "/auth") {
+	return returnTo ? `${authPath}?returnTo=${encodeURIComponent(returnTo)}` : authPath;
+}
+/** Path that logs out of the app and the Shopwave auth server. */
+function logoutPath(authPath = "/auth") {
+	return `${authPath}/logout`;
+}
+/**
+* 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.
+*/
+async function logout(options = {}) {
+	await apiDelete("/api/session?action=logout", options);
+}
+
+//#endregion
+//#region src/core/entity.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}`.
+*/
+async function deleteEntity(resourcePath, entityId, options = {}) {
+	if (entityId == null || entityId === "") throw new Error("entityId is missing");
+	await apiDelete(`/api/${resourcePath}/${entityId}`, options);
+}
+/**
+* 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.
+*/
+async function submitEntity({ endpoint, method = "POST", payload }, options = {}) {
+	const json = await apiSend(endpoint, method, payload, options);
+	assertNoApiErrors(json, 200);
+	if (json && typeof json === "object" && "result" in json) return json.result;
+	return json ?? void 0;
+}
+
 //#endregion
 //#region src/core/basket.ts
 const DEFAULT_BASKET_FILTERS = {
@@ -1869,6 +2007,25 @@ function useProductInstanceTags(options) {
 	}), [options?.baseUrl, options?.token], options?.enabled ?? true);
 }
 
+//#endregion
+//#region src/hooks/useProductComponent.ts
+/**
+* Auto-fetches product components (modifier groups) on mount and whenever the params change:
+* a product's groups with `{ productIds: [id] }`, one group with `{ productComponentIds: [id] }`,
+* or every group with no filter. Option rows with a `deleteDate` are included; skip them when
+* listing options.
+*/
+function useProductComponent(params = {}, options) {
+	return useQuery((signal) => fetchProductComponents(params, {
+		...options,
+		signal
+	}), [
+		JSON.stringify(params),
+		options?.baseUrl,
+		options?.token
+	]);
+}
+
 //#endregion
 //#region src/hooks/usePromotion.ts
 /**
@@ -2219,6 +2376,8 @@ exports.deleteEmployee = deleteEmployee;
 exports.deleteEntity = deleteEntity;
 exports.deleteEntityById = deleteEntityById;
 exports.deleteProduct = deleteProduct;
+exports.deleteProductComponent = deleteProductComponent;
+exports.deleteProductComponentInstances = deleteProductComponentInstances;
 exports.deletePromotion = deletePromotion;
 exports.deleteStore = deleteStore;
 exports.fetchCategories = fetchCategories;
@@ -2230,6 +2389,8 @@ exports.fetchEmployees = fetchEmployees;
 exports.fetchEntityById = fetchEntityById;
 exports.fetchMerchant = fetchMerchant;
 exports.fetchProduct = fetchProduct;
+exports.fetchProductComponent = fetchProductComponent;
+exports.fetchProductComponents = fetchProductComponents;
 exports.fetchProductInstanceTags = fetchProductInstanceTags;
 exports.fetchProductTags = fetchProductTags;
 exports.fetchProducts = fetchProducts;
@@ -2272,10 +2433,12 @@ exports.saveEmployee = saveEmployee;
 exports.saveEntities = saveEntities;
 exports.saveEntity = saveEntity;
 exports.saveProduct = saveProduct;
+exports.saveProductComponent = saveProductComponent;
 exports.savePromotion = savePromotion;
 exports.saveStore = saveStore;
 exports.setMerchantImage = setMerchantImage;
 exports.submitEntity = submitEntity;
+exports.toProductComponentForSave = toProductComponentForSave;
 exports.toProductInstancesForSave = toProductInstancesForSave;
 exports.toShopwaveApiError = toShopwaveApiError;
 exports.toStoredImageIds = toStoredImageIds;
@@ -2291,6 +2454,7 @@ exports.useEmployee = useEmployee;
 exports.useLogout = useLogout;
 exports.useMerchant = useMerchant;
 exports.useProduct = useProduct;
+exports.useProductComponent = useProductComponent;
 exports.useProductInstanceTags = useProductInstanceTags;
 exports.useProductTags = useProductTags;
 exports.usePromotion = usePromotion;