react-shopwave-connect 0.4.1 → 0.4.3

package/dist/index.cjs

@@ -375,6 +375,106 @@ async function fetchProductsMap(productIds, options = {}, batchSize = 200) {
 	return result;
 }
 
+//#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/core/productTags.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.
+*/
+function normalizeTagList(value) {
+	const list = Array.isArray(value) ? value : value && typeof value === "object" ? Object.values(value) : [];
+	const seen = /* @__PURE__ */ new Set();
+	const out = [];
+	for (const item of list) {
+		if (typeof item !== "string" && typeof item !== "number") continue;
+		const tag = String(item).trim();
+		if (!tag || seen.has(tag)) continue;
+		seen.add(tag);
+		out.push(tag);
+	}
+	return out;
+}
+async function fetchLookup(kind, options) {
+	const def = SHOPWAVE_LOOKUPS[kind];
+	if (!def) throw new Error(`Unknown Shopwave lookup "${kind}"`);
+	const json = await apiGet(`/api/${def.route}`, {}, options);
+	assertNoApiErrors(json, 200);
+	return normalizeTagList(json?.[def.key]);
+}
+/**
+* Every distinct tag used on the merchant's products (`GET /product/tags`),
+* for a tag field's suggestions. Returns `[]` when there are none.
+*/
+function fetchProductTags(options = {}) {
+	return fetchLookup("productTags", options);
+}
+/**
+* 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.
+*/
+function fetchProductInstanceTags(options = {}) {
+	return fetchLookup("productInstanceTags", options);
+}
+
 //#endregion
 //#region src/core/promotion.ts
 /** Promotion rule identifiers as stored by the Shopwave API. */
@@ -509,7 +609,10 @@ async function submitEntity({ endpoint, method = "POST", payload }, options = {}
 * (https://developer.merchantstack.com/api-reference.html) and checked against
 * the live API where noted:
 * - category/product/store: GET filtered by `<x>Ids`, POST upsert, DELETE with `<x>Id` → 205.
-* - promotion: no DELETE; "deleting" a promotion ends it by setting `endDate` to now.
+* - promotion: no DELETE; promotions are never deleted, only expired. Expiring
+*   reads the promotion and saves the whole record back with `endDate` = now (and
+*   `startDate` = now too if it hadn't started); the live API rejects a partial
+*   `{ id, endDate }` save with error 899. Dates are UTC `YYYY-MM-DD HH:mm:ss`.
 * - 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.
@@ -550,7 +653,9 @@ const SHOPWAVE_ENTITIES = Object.freeze({
 		idHeader: "promotionId",
 		writable: true,
 		deleteMode: "retire",
-		retireField: "endDate"
+		retireField: "endDate",
+		retireWithRecord: true,
+		retireStartField: "startDate"
 	},
 	employee: {
 		route: "employees",
@@ -625,7 +730,8 @@ async function saveEntity(kind, item, options = {}) {
 /**
 * Deletes one entity (a soft delete: it stays readable with `deleted: true`).
 * Employees and promotions can't be deleted in Shopwave; for them the route
-* sets `exitDate` / `endDate` to now instead (see `SHOPWAVE_ENTITIES`).
+* sets `exitDate` / `endDate` to now instead (see `SHOPWAVE_ENTITIES`), and a
+* promotion is saved back whole (see {@link deletePromotion}).
 *
 * Shopwave answers 205 with an empty body — also for ids that don't exist — so
 * a resolved promise means "the API accepted the request", not "a record was
@@ -666,7 +772,12 @@ const saveStore = (store, options) => saveEntity("store", store, options);
 const deleteStore = (id, options) => deleteEntityById("store", id, options);
 const fetchStore = (id, params, options) => fetchEntityById("store", id, params, options);
 const savePromotion = (promotion, options) => saveEntity("promotion", promotion, options);
-/** Ends a promotion: Shopwave has no promotion DELETE, so this sets `endDate` to now. */
+/**
+* Expires a promotion (Shopwave never deletes promotions). The route reads the
+* promotion and saves it back with `endDate` set to now; a promotion that hasn't
+* started yet gets `startDate` = `endDate` = now. Rejects if the promotion doesn't
+* exist or the save fails.
+*/
 const deletePromotion = (id, options) => deleteEntityById("promotion", id, options);
 const fetchPromotion = (id, params, options) => fetchEntityById("promotion", id, params, options);
 /**
@@ -825,50 +936,6 @@ function buildConsumerMap(consumers) {
 	return map;
 }
 
-//#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);
-}
-
 //#endregion
 //#region src/core/imageFit.ts
 /**
@@ -1535,6 +1602,33 @@ function useProduct(params = {}, options) {
 	]);
 }
 
+//#endregion
+//#region src/hooks/useProductTags.ts
+/**
+* The merchant's distinct product tags, for a tag field's suggestions.
+* `data` is `string[]` once loaded.
+*
+* @example
+* const [opened, setOpened] = useState(false);
+* const { data: tags, loading } = useProductTags({ enabled: opened });
+*/
+function useProductTags(options) {
+	return useQuery((signal) => fetchProductTags({
+		...options,
+		signal
+	}), [options?.baseUrl, options?.token], options?.enabled ?? true);
+}
+/**
+* The merchant's distinct price-instance (channel) tags: Eat In, Takeout, …
+* `data` is `string[]` once loaded.
+*/
+function useProductInstanceTags(options) {
+	return useQuery((signal) => fetchProductInstanceTags({
+		...options,
+		signal
+	}), [options?.baseUrl, options?.token], options?.enabled ?? true);
+}
+
 //#endregion
 //#region src/hooks/usePromotion.ts
 /**
@@ -1858,6 +1952,7 @@ exports.MERCHANT_READ_ONLY_FIELDS = MERCHANT_READ_ONLY_FIELDS;
 exports.PromotionRuleSet = PromotionRuleSet;
 exports.SHOPWAVE_ENTITIES = SHOPWAVE_ENTITIES;
 exports.SHOPWAVE_IMAGE_BASE_URL = SHOPWAVE_IMAGE_BASE_URL;
+exports.SHOPWAVE_LOOKUPS = SHOPWAVE_LOOKUPS;
 exports.SHOPWAVE_RESOURCES = SHOPWAVE_RESOURCES;
 exports.SHOPWAVE_UPLOAD = SHOPWAVE_UPLOAD;
 exports.ShopwaveApiError = ShopwaveApiError;
@@ -1891,6 +1986,8 @@ exports.fetchEmployees = fetchEmployees;
 exports.fetchEntityById = fetchEntityById;
 exports.fetchMerchant = fetchMerchant;
 exports.fetchProduct = fetchProduct;
+exports.fetchProductInstanceTags = fetchProductInstanceTags;
+exports.fetchProductTags = fetchProductTags;
 exports.fetchProducts = fetchProducts;
 exports.fetchProductsMap = fetchProductsMap;
 exports.fetchPromotion = fetchPromotion;
@@ -1917,6 +2014,7 @@ exports.logoutPath = logoutPath;
 exports.merchantLinksFromForm = merchantLinksFromForm;
 exports.merchantLinksToForm = merchantLinksToForm;
 exports.normalizeMerchantLinks = normalizeMerchantLinks;
+exports.normalizeTagList = normalizeTagList;
 exports.parseBasketReportData = parseBasketReportData;
 exports.readImageSize = readImageSize;
 exports.rolesById = rolesById;
@@ -1943,6 +2041,8 @@ exports.useEmployee = useEmployee;
 exports.useLogout = useLogout;
 exports.useMerchant = useMerchant;
 exports.useProduct = useProduct;
+exports.useProductInstanceTags = useProductInstanceTags;
+exports.useProductTags = useProductTags;
 exports.usePromotion = usePromotion;
 exports.useReport = useReport;
 exports.useSession = useSession;