react-shopwave-connect 0.4.2 → 0.4.4

package/dist/hooks/index.cjs

@@ -283,6 +283,118 @@ 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"
+});
+/** 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/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
 /**
@@ -392,194 +504,6 @@ async function submitEntity({ endpoint, method = "POST", payload }, options = {}
 	return json ?? void 0;
 }
 
-//#endregion
-//#region src/core/basket.ts
-const DEFAULT_BASKET_FILTERS = {
-	search: "",
-	dateRange: {
-		start: null,
-		end: null
-	},
-	consumerId: null,
-	status: "all"
-};
-const DEFAULT_PAGINATION = {
-	page: 0,
-	pageSize: 25,
-	total: 0
-};
-/** Formats a date as `YYYY-MM-DD HH:mm:ss` for the report query. */
-function formatDateForQuery(date, isEndOfDay = false) {
-	return `${date.getFullYear()}-${String(date.getMonth() + 1).padStart(2, "0")}-${String(date.getDate()).padStart(2, "0")} ${isEndOfDay ? "23:59:59" : "00:00:00"}`;
-}
-/** Builds the `Basket` report query from a set of filters. */
-function buildBasketReportQuery(filters) {
-	const whereConditions = [];
-	const today = /* @__PURE__ */ new Date();
-	const startDate = filters.dateRange.start ?? today;
-	const endDate = filters.dateRange.end ?? today;
-	whereConditions.push(`Basket.completeDate > '${formatDateForQuery(startDate, false)}'`);
-	whereConditions.push(`Basket.completeDate < '${formatDateForQuery(endDate, true)}'`);
-	if (filters.consumerId) whereConditions.push(`Basket.consumerId = ${filters.consumerId}`);
-	if (filters.status !== "all") whereConditions.push(`Basket.status = '${filters.status}'`);
-	return { baskets: {
-		FROM: "Basket",
-		WHERE: whereConditions.length > 0 ? { AND: whereConditions } : void 0
-	} };
-}
-/** Flattens the raw report rows/keys into structured baskets. */
-function parseBasketReportData(reports) {
-	if (!reports?.baskets?.data || !reports?.baskets?.keys) return [];
-	const { keys, data } = reports.baskets;
-	const keyIndices = {};
-	keys.forEach((key, index) => {
-		keyIndices[key.name] = index;
-	});
-	const productKey = keys.find((k) => k.name === "Basket.Product");
-	const productSubKeys = {};
-	if (productKey?.item) productKey.item.forEach((subKey, index) => {
-		productSubKeys[subKey.name] = index;
-	});
-	return data.map((row) => {
-		const products = (row[keyIndices["Basket.Product"]] || []).map((productRow) => ({
-			productId: productRow[productSubKeys["Basket.Product.productId"]],
-			productName: `Product #${productRow[productSubKeys["Basket.Product.productId"]]}`,
-			quantity: productRow[productSubKeys["Basket.Product.quantity"]] || 1,
-			price: productRow[productSubKeys["Basket.Product.productPrice"]] || 0,
-			tax: productRow[productSubKeys["Basket.Product.productTaxPercentage"]] || 0
-		}));
-		const total = products.reduce((sum, p) => sum + p.price * p.quantity, 0);
-		const taxTotal = products.reduce((sum, p) => sum + p.price * p.quantity * p.tax, 0);
-		const completeDateTimestamp = row[keyIndices["Basket.completeDate"]];
-		const completeDate = completeDateTimestamp ? new Date(completeDateTimestamp).toISOString() : "";
-		return {
-			id: row[keyIndices["Basket.id"]],
-			name: row[keyIndices["Basket.name"]],
-			consumerId: row[keyIndices["Basket.consumerId"]],
-			products,
-			total,
-			taxTotal,
-			status: "completed",
-			completeDate
-		};
-	});
-}
-/** Unique non-null consumer ids referenced by a set of baskets. */
-function collectConsumerIds(baskets) {
-	if (!baskets.length) return null;
-	const ids = baskets.map((b) => b.consumerId).filter((id) => id != null);
-	return ids.length > 0 ? [...new Set(ids)] : null;
-}
-/** Unique product ids referenced by a set of baskets. */
-function collectProductIds(baskets) {
-	if (!baskets.length) return null;
-	const ids = /* @__PURE__ */ new Set();
-	baskets.forEach((basket) => {
-		basket.products.forEach((product) => {
-			if (product.productId) ids.add(product.productId);
-		});
-	});
-	return ids.size > 0 ? [...ids] : null;
-}
-/** Joins baskets with consumer + product lookups, applies search, sorts. */
-function combineBasketRows({ baskets, consumerMap, productMap, search }) {
-	if (!baskets.length) return [];
-	let combinedRows = baskets.map((basket) => {
-		const consumer = basket.consumerId ? consumerMap[basket.consumerId] : null;
-		const productsWithNames = basket.products.map((p) => {
-			const product = productMap[p.productId];
-			return {
-				...p,
-				productName: product?.name || `Product #${p.productId}`
-			};
-		});
-		return {
-			id: basket.id,
-			basketId: basket.id,
-			basketName: basket.name || `Basket #${basket.id}`,
-			consumerId: basket.consumerId,
-			consumerName: consumer ? `${consumer.firstName} ${consumer.lastName}` : "Unknown",
-			consumerEmail: consumer?.email || "-",
-			products: productsWithNames,
-			basketTotal: (basket.total || 0) / 100,
-			tax: basket.taxTotal || 0,
-			dateTime: basket.completeDate,
-			status: basket.status || "pending"
-		};
-	});
-	if (search) {
-		const searchLower = search.toLowerCase();
-		combinedRows = combinedRows.filter((row) => row.basketId.toString().includes(searchLower) || row.basketName.toLowerCase().includes(searchLower) || row.consumerName.toLowerCase().includes(searchLower) || row.consumerEmail.toLowerCase().includes(searchLower));
-	}
-	combinedRows.sort((a, b) => {
-		const dateA = new Date(a.dateTime).getTime();
-		return new Date(b.dateTime).getTime() - dateA;
-	});
-	return combinedRows;
-}
-/** Aggregate totals for a set of report rows. */
-function computeBasketSummary(rows) {
-	const uniqueConsumerIds = new Set(rows.map((row) => row.consumerId));
-	return {
-		totalBaskets: rows.length,
-		totalRevenue: rows.reduce((sum, row) => sum + row.basketTotal, 0),
-		totalTax: rows.reduce((sum, row) => sum + row.tax, 0),
-		uniqueConsumers: uniqueConsumerIds.size
-	};
-}
-/** Builds a consumer id → consumer lookup. */
-function buildConsumerMap(consumers) {
-	const map = {};
-	if (consumers) consumers.forEach((consumer) => {
-		map[consumer.id] = consumer;
-	});
-	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
 /**
@@ -690,10 +614,12 @@ function getImageUrl(path, base = SHOPWAVE_IMAGE_BASE_URL) {
 async function uploadImage(file, params, options = {}) {
 	if (!file || typeof file.size !== "number") throw new Error("uploadImage: file must be a File or Blob");
 	if (!isUploadKind(params?.kind)) throw new Error(`uploadImage: unknown kind "${params?.kind}"`);
+	if (params.prefix != null && !isUploadPrefix(params.prefix)) throw new Error(`uploadImage: unknown prefix "${params.prefix}"`);
 	const name = params.fileName ?? file.name ?? "upload";
 	const form = new FormData();
 	form.append(SHOPWAVE_UPLOAD.fileField, file, name);
 	form.append(SHOPWAVE_UPLOAD.kindField, params.kind);
+	if (params.prefix != null) form.append(SHOPWAVE_UPLOAD.prefixField, params.prefix);
 	const { status, body: raw } = await apiRequest(`/api/${SHOPWAVE_UPLOAD.route}`, {
 		method: "POST",
 		body: form
@@ -781,6 +707,150 @@ async function uploadMerchantImage(file, slot, options = {}) {
 	return uploadImage(fit ? await fitImageToSize(file, def.width, def.height, fitOptions) : file, { kind: def.uploadKind }, requestOptions);
 }
 
+//#endregion
+//#region src/core/basket.ts
+const DEFAULT_BASKET_FILTERS = {
+	search: "",
+	dateRange: {
+		start: null,
+		end: null
+	},
+	consumerId: null,
+	status: "all"
+};
+const DEFAULT_PAGINATION = {
+	page: 0,
+	pageSize: 25,
+	total: 0
+};
+/** Formats a date as `YYYY-MM-DD HH:mm:ss` for the report query. */
+function formatDateForQuery(date, isEndOfDay = false) {
+	return `${date.getFullYear()}-${String(date.getMonth() + 1).padStart(2, "0")}-${String(date.getDate()).padStart(2, "0")} ${isEndOfDay ? "23:59:59" : "00:00:00"}`;
+}
+/** Builds the `Basket` report query from a set of filters. */
+function buildBasketReportQuery(filters) {
+	const whereConditions = [];
+	const today = /* @__PURE__ */ new Date();
+	const startDate = filters.dateRange.start ?? today;
+	const endDate = filters.dateRange.end ?? today;
+	whereConditions.push(`Basket.completeDate > '${formatDateForQuery(startDate, false)}'`);
+	whereConditions.push(`Basket.completeDate < '${formatDateForQuery(endDate, true)}'`);
+	if (filters.consumerId) whereConditions.push(`Basket.consumerId = ${filters.consumerId}`);
+	if (filters.status !== "all") whereConditions.push(`Basket.status = '${filters.status}'`);
+	return { baskets: {
+		FROM: "Basket",
+		WHERE: whereConditions.length > 0 ? { AND: whereConditions } : void 0
+	} };
+}
+/** Flattens the raw report rows/keys into structured baskets. */
+function parseBasketReportData(reports) {
+	if (!reports?.baskets?.data || !reports?.baskets?.keys) return [];
+	const { keys, data } = reports.baskets;
+	const keyIndices = {};
+	keys.forEach((key, index) => {
+		keyIndices[key.name] = index;
+	});
+	const productKey = keys.find((k) => k.name === "Basket.Product");
+	const productSubKeys = {};
+	if (productKey?.item) productKey.item.forEach((subKey, index) => {
+		productSubKeys[subKey.name] = index;
+	});
+	return data.map((row) => {
+		const products = (row[keyIndices["Basket.Product"]] || []).map((productRow) => ({
+			productId: productRow[productSubKeys["Basket.Product.productId"]],
+			productName: `Product #${productRow[productSubKeys["Basket.Product.productId"]]}`,
+			quantity: productRow[productSubKeys["Basket.Product.quantity"]] || 1,
+			price: productRow[productSubKeys["Basket.Product.productPrice"]] || 0,
+			tax: productRow[productSubKeys["Basket.Product.productTaxPercentage"]] || 0
+		}));
+		const total = products.reduce((sum, p) => sum + p.price * p.quantity, 0);
+		const taxTotal = products.reduce((sum, p) => sum + p.price * p.quantity * p.tax, 0);
+		const completeDateTimestamp = row[keyIndices["Basket.completeDate"]];
+		const completeDate = completeDateTimestamp ? new Date(completeDateTimestamp).toISOString() : "";
+		return {
+			id: row[keyIndices["Basket.id"]],
+			name: row[keyIndices["Basket.name"]],
+			consumerId: row[keyIndices["Basket.consumerId"]],
+			products,
+			total,
+			taxTotal,
+			status: "completed",
+			completeDate
+		};
+	});
+}
+/** Unique non-null consumer ids referenced by a set of baskets. */
+function collectConsumerIds(baskets) {
+	if (!baskets.length) return null;
+	const ids = baskets.map((b) => b.consumerId).filter((id) => id != null);
+	return ids.length > 0 ? [...new Set(ids)] : null;
+}
+/** Unique product ids referenced by a set of baskets. */
+function collectProductIds(baskets) {
+	if (!baskets.length) return null;
+	const ids = /* @__PURE__ */ new Set();
+	baskets.forEach((basket) => {
+		basket.products.forEach((product) => {
+			if (product.productId) ids.add(product.productId);
+		});
+	});
+	return ids.size > 0 ? [...ids] : null;
+}
+/** Joins baskets with consumer + product lookups, applies search, sorts. */
+function combineBasketRows({ baskets, consumerMap, productMap, search }) {
+	if (!baskets.length) return [];
+	let combinedRows = baskets.map((basket) => {
+		const consumer = basket.consumerId ? consumerMap[basket.consumerId] : null;
+		const productsWithNames = basket.products.map((p) => {
+			const product = productMap[p.productId];
+			return {
+				...p,
+				productName: product?.name || `Product #${p.productId}`
+			};
+		});
+		return {
+			id: basket.id,
+			basketId: basket.id,
+			basketName: basket.name || `Basket #${basket.id}`,
+			consumerId: basket.consumerId,
+			consumerName: consumer ? `${consumer.firstName} ${consumer.lastName}` : "Unknown",
+			consumerEmail: consumer?.email || "-",
+			products: productsWithNames,
+			basketTotal: (basket.total || 0) / 100,
+			tax: basket.taxTotal || 0,
+			dateTime: basket.completeDate,
+			status: basket.status || "pending"
+		};
+	});
+	if (search) {
+		const searchLower = search.toLowerCase();
+		combinedRows = combinedRows.filter((row) => row.basketId.toString().includes(searchLower) || row.basketName.toLowerCase().includes(searchLower) || row.consumerName.toLowerCase().includes(searchLower) || row.consumerEmail.toLowerCase().includes(searchLower));
+	}
+	combinedRows.sort((a, b) => {
+		const dateA = new Date(a.dateTime).getTime();
+		return new Date(b.dateTime).getTime() - dateA;
+	});
+	return combinedRows;
+}
+/** Aggregate totals for a set of report rows. */
+function computeBasketSummary(rows) {
+	const uniqueConsumerIds = new Set(rows.map((row) => row.consumerId));
+	return {
+		totalBaskets: rows.length,
+		totalRevenue: rows.reduce((sum, row) => sum + row.basketTotal, 0),
+		totalTax: rows.reduce((sum, row) => sum + row.tax, 0),
+		uniqueConsumers: uniqueConsumerIds.size
+	};
+}
+/** Builds a consumer id → consumer lookup. */
+function buildConsumerMap(consumers) {
+	const map = {};
+	if (consumers) consumers.forEach((consumer) => {
+		map[consumer.id] = consumer;
+	});
+	return map;
+}
+
 //#endregion
 //#region src/core/merchant.ts
 const MERCHANT_PATH = `/api/${SHOPWAVE_RESOURCES.merchant.route}`;
@@ -1124,6 +1194,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
 /**
@@ -1442,6 +1539,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;