react-shopwave-connect 0.3.0 → 0.4.0

package/dist/core/index.js

@@ -709,5 +709,485 @@ function buildConsumerMap(consumers) {
 }
 
 //#endregion
-export { DEFAULT_BASKET_FILTERS, DEFAULT_PAGINATION, PromotionRuleSet, SHOPWAVE_ENTITIES, ShopwaveApiError, apiDelete, apiGet, apiRequest, apiSend, assertNoApiErrors, authorizationFor, buildBasketReportQuery, buildConsumerMap, collectConsumerIds, collectProductIds, combineBasketRows, computeBasketSummary, deleteCategory, deleteEmployee, deleteEntity, deleteEntityById, deleteProduct, deletePromotion, deleteStore, fetchCategories, fetchCategory, fetchConsumer, fetchConsumers, fetchEmployee, fetchEmployees, fetchEntityById, fetchProduct, fetchProducts, fetchProductsMap, fetchPromotion, fetchPromotions, fetchReport, fetchSession, fetchStore, fetchStores, formatDateForQuery, getApiErrorMap, getApiErrors, loginPath, logout, logoutPath, parseBasketReportData, rolesById, saveCategory, saveEmployee, saveEntities, saveEntity, saveProduct, savePromotion, saveStore, submitEntity, toShopwaveApiError, withToken };
+//#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
+/**
+* The centred part of a `srcWidth × srcHeight` image with the aspect ratio of
+* `dstWidth × dstHeight` (like CSS `object-fit: cover`).
+*/
+function coverCrop(srcWidth, srcHeight, dstWidth, dstHeight) {
+	if (![
+		srcWidth,
+		srcHeight,
+		dstWidth,
+		dstHeight
+	].every((n) => Number.isFinite(n) && n > 0)) throw new Error("coverCrop: sizes must be positive numbers");
+	const srcRatio = srcWidth / srcHeight;
+	const dstRatio = dstWidth / dstHeight;
+	if (srcRatio > dstRatio) {
+		const sw = Math.round(srcHeight * dstRatio);
+		return {
+			sx: Math.round((srcWidth - sw) / 2),
+			sy: 0,
+			sw,
+			sh: srcHeight
+		};
+	}
+	const sh = Math.round(srcWidth / dstRatio);
+	return {
+		sx: 0,
+		sy: Math.round((srcHeight - sh) / 2),
+		sw: srcWidth,
+		sh
+	};
+}
+function requireBrowserImages(fn) {
+	if (typeof createImageBitmap !== "function") throw new Error(`${fn} needs a browser (createImageBitmap is not available)`);
+}
+/** Reads an image file's pixel size (browser only). */
+async function readImageSize(file) {
+	requireBrowserImages("readImageSize");
+	const bitmap = await createImageBitmap(file);
+	try {
+		return {
+			width: bitmap.width,
+			height: bitmap.height
+		};
+	} finally {
+		bitmap.close?.();
+	}
+}
+/**
+* Returns the image at exactly `width × height`: scaled and centre-cropped
+* (never stretched). Browser only. The result is a `File` named like the
+* input, with the output type's extension.
+*/
+async function fitImageToSize(file, width, height, options = {}) {
+	requireBrowserImages("fitImageToSize");
+	const { type = "image/png", quality, keepIfExact = true } = options;
+	const name = file.name || "image";
+	const ext = type === "image/jpeg" ? "jpg" : type.split("/")[1];
+	const outName = `${name.replace(/\.[^.]+$/, "")}.${ext}`;
+	const bitmap = await createImageBitmap(file);
+	try {
+		if (keepIfExact && bitmap.width === width && bitmap.height === height && file.type === type) return file instanceof File ? file : new File([file], outName, { type });
+		const { sx, sy, sw, sh } = coverCrop(bitmap.width, bitmap.height, width, height);
+		let blob;
+		if (typeof OffscreenCanvas === "function") {
+			const canvas = new OffscreenCanvas(width, height);
+			const ctx = canvas.getContext("2d");
+			if (!ctx) throw new Error("fitImageToSize: no 2D canvas context");
+			ctx.imageSmoothingQuality = "high";
+			ctx.drawImage(bitmap, sx, sy, sw, sh, 0, 0, width, height);
+			blob = await canvas.convertToBlob({
+				type,
+				quality
+			});
+		} else {
+			const canvas = document.createElement("canvas");
+			canvas.width = width;
+			canvas.height = height;
+			const ctx = canvas.getContext("2d");
+			if (!ctx) throw new Error("fitImageToSize: no 2D canvas context");
+			ctx.imageSmoothingQuality = "high";
+			ctx.drawImage(bitmap, sx, sy, sw, sh, 0, 0, width, height);
+			blob = await new Promise((resolve, reject) => canvas.toBlob((b) => b ? resolve(b) : reject(/* @__PURE__ */ new Error("fitImageToSize: encoding failed")), type, quality));
+		}
+		return new File([blob], outName, { type });
+	} finally {
+		bitmap.close?.();
+	}
+}
+
+//#endregion
+//#region src/core/upload.ts
+/**
+* HTTPS host that serves the Shopwave CDN's images. The API returns
+* `http://static.merchantstack.com/images/…`, which has no HTTPS endpoint
+* (checked Sep 2026), so pages served over HTTPS can't show it.
+*/
+const SHOPWAVE_IMAGE_BASE_URL = "https://s3-eu-west-1.amazonaws.com/static.merchantstack.com/images";
+const STATIC_HOST = /^https?:\/\/static\.merchantstack\.com\/images\//i;
+/**
+* Turns an image path from the API into a URL a page can load over HTTPS:
+* `http://static.merchantstack.com/images/x.png` → `<base>/x.png`, and a
+* relative path (`merchant/5644/logo/x.png`) → `<base>/merchant/5644/logo/x.png`.
+* Other absolute URLs are returned unchanged; empty input gives `""`.
+*/
+function getImageUrl(path, base = SHOPWAVE_IMAGE_BASE_URL) {
+	if (!path) return "";
+	const root = base.replace(/\/+$/, "");
+	if (STATIC_HOST.test(path)) return `${root}/${path.replace(STATIC_HOST, "")}`;
+	if (/^[a-z][a-z0-9+.-]*:/i.test(path) || path.startsWith("//")) return path;
+	return `${root}/${path.replace(/^\/+/, "")}`;
+}
+/**
+* Uploads one image to the Shopwave CDN through the app's `/api/upload` route
+* (`createShopwaveApi(...).upload()`), and returns its id and URL.
+*
+* The file only lands on the CDN (under `…/images/<kind>/<merchantId>/…`); a
+* record has to point at it to use it. Live API (Sep 2026): the upload answers
+* 201 `{ fileName, path }`.
+*/
+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}"`);
+	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);
+	const { status, body: raw } = await apiRequest(`/api/${SHOPWAVE_UPLOAD.route}`, {
+		method: "POST",
+		body: form
+	}, options);
+	const body = raw;
+	assertNoApiErrors(body, status);
+	const id = typeof body?.fileName === "string" ? body.fileName : "";
+	const path = typeof body?.path === "string" ? body.path : "";
+	if (!id) throw new ShopwaveApiError(status, `Shopwave API error (${status}): the upload response has no fileName`, { body });
+	return {
+		id,
+		url: getImageUrl(path),
+		path
+	};
+}
+
+//#endregion
+//#region src/core/merchantImages.ts
+/** The three image slots on the merchant settings page. */
+const MERCHANT_IMAGE_SLOT_KEYS = [
+	"receipt",
+	"square",
+	"featured"
+];
+/**
+* Where each slot lives, its upload kind and its exact size (from adminV1's
+* merchant settings page).
+*/
+const MERCHANT_IMAGE_SLOTS = Object.freeze({
+	receipt: {
+		field: "logo.receipt",
+		uploadKind: "merchant",
+		width: 576,
+		height: 325
+	},
+	square: {
+		field: "logo.square",
+		uploadKind: "merchant",
+		width: 1e3,
+		height: 1e3
+	},
+	featured: {
+		field: "feature[0]",
+		uploadKind: "merchantFeature",
+		width: 1200,
+		height: 600
+	}
+});
+/**
+* The file name in an image value: `"http://…/logo/abc.png"` → `"abc.png"`,
+* `"abc.png"` → `"abc.png"`. Query strings and fragments are ignored.
+* Returns `null` for empty or non-string values.
+*/
+function imageFileName(value) {
+	if (typeof value !== "string") return null;
+	const last = value.trim().replace(/[?#].*$/, "").split("/").pop() ?? "";
+	return last ? decodeURIComponent(last) : null;
+}
+/** The stored value for a slot (a URL when read from the API; a file name right after an upload). */
+function getMerchantImage(imageIds, slot) {
+	if (!imageIds || typeof imageIds !== "object") return null;
+	let value;
+	if (slot === "featured") value = Array.isArray(imageIds.feature) ? imageIds.feature[0] : void 0;
+	else {
+		const logo = imageIds.logo;
+		value = logo && typeof logo === "object" ? logo[slot] : void 0;
+	}
+	return typeof value === "string" && value.trim() ? value.trim() : null;
+}
+/**
+* An HTTPS URL for a slot's stored image, or `""` when the slot is empty or
+* holds only a file name (a fresh upload not yet saved; use the upload's `url`).
+*/
+function getMerchantImageUrl(imageIds, slot, base) {
+	const value = getMerchantImage(imageIds, slot);
+	if (!value || !value.includes("/")) return "";
+	return getImageUrl(value, base);
+}
+/**
+* Returns a copy of `imageIds` with one slot set to `fileName` (or cleared
+* with `null`). Other slots and unknown keys are kept; an empty `logo` or
+* `feature` is removed.
+*/
+function setMerchantImage(imageIds, slot, fileName) {
+	const next = { ...imageIds && typeof imageIds === "object" ? imageIds : {} };
+	if (slot === "featured") {
+		const rest = Array.isArray(next.feature) ? next.feature.slice(1) : [];
+		const feature = fileName ? [fileName, ...rest] : rest;
+		if (feature.length > 0) next.feature = feature;
+		else delete next.feature;
+	} else {
+		const logo = { ...next.logo && typeof next.logo === "object" ? next.logo : {} };
+		if (fileName) logo[slot] = fileName;
+		else delete logo[slot];
+		if (Object.keys(logo).length > 0) next.logo = logo;
+		else delete next.logo;
+	}
+	return next;
+}
+function toStored(value) {
+	if (typeof value === "string") return imageFileName(value) ?? void 0;
+	if (Array.isArray(value)) {
+		const items = value.map(toStored).filter((v) => v !== void 0 && v !== null && v !== "");
+		return items.length > 0 ? items : void 0;
+	}
+	if (value && typeof value === "object") {
+		const out = {};
+		for (const [k, v] of Object.entries(value)) {
+			const stored = toStored(v);
+			if (stored !== void 0 && stored !== null && stored !== "") out[k] = stored;
+		}
+		return Object.keys(out).length > 0 ? out : void 0;
+	}
+}
+/**
+* The `imageIds` to send on a save: every URL is turned back into its file
+* name (what adminV1 does with images you didn't change) and empty values
+* are dropped. No images gives `{}`.
+*/
+function toStoredImageIds(imageIds) {
+	return toStored(imageIds) ?? {};
+}
+/**
+* Uploads an image for a merchant slot: fits it to the slot's size, uploads
+* it with the slot's kind, and returns `{ id, url, path }`. Put `id` into
+* `imageIds` with {@link setMerchantImage} and save with `updateMerchant`.
+*/
+async function uploadMerchantImage(file, slot, options = {}) {
+	const def = MERCHANT_IMAGE_SLOTS[slot];
+	if (!def) throw new Error(`uploadMerchantImage: unknown slot "${slot}"`);
+	const { fit = true, fitOptions,...requestOptions } = options;
+	return uploadImage(fit ? await fitImageToSize(file, def.width, def.height, fitOptions) : file, { kind: def.uploadKind }, requestOptions);
+}
+
+//#endregion
+//#region src/core/merchant.ts
+const MERCHANT_PATH = `/api/${SHOPWAVE_RESOURCES.merchant.route}`;
+/** Colour keys inside `colours.primary`, in display order. */
+const MERCHANT_COLOUR_KEYS = [
+	"main",
+	"highlight",
+	"contrast"
+];
+/** Flat link fields a form edits, in display order. */
+const MERCHANT_LINK_KEYS = [
+	"website",
+	"twitter",
+	"facebook",
+	"instagram"
+];
+/** Where each flat link field lives in `merchant.links`. */
+const MERCHANT_LINK_PATHS = Object.freeze({
+	website: ["website", "home"],
+	twitter: ["social", "twitter"],
+	facebook: ["social", "facebook"],
+	instagram: ["social", "instagram"]
+});
+function trimmed(value) {
+	return typeof value === "string" && value.trim() ? value.trim() : void 0;
+}
+/**
+* Reads `merchant.links` as flat fields (`{ website, twitter, facebook,
+* instagram }`), whatever shape it was saved in:
+* - the nested shape adminV1 saves (`{ website: { home }, social: { … } }`);
+* - flat keys (`{ website: "…" }`, what SDK 0.4.0 pre-releases sent);
+* - an array in {@link MERCHANT_LINK_KEYS} order (older AdminUI versions).
+* Empty values are dropped.
+*/
+function merchantLinksToForm(links) {
+	const out = {};
+	if (Array.isArray(links)) {
+		links.forEach((value, i) => {
+			const key = MERCHANT_LINK_KEYS[i];
+			const v = trimmed(value);
+			if (key && v) out[key] = v;
+		});
+		return out;
+	}
+	if (!links || typeof links !== "object") return out;
+	const obj = links;
+	for (const key of MERCHANT_LINK_KEYS) {
+		const [group, field] = MERCHANT_LINK_PATHS[key];
+		const nested = obj[group];
+		const v = nested && typeof nested === "object" && !Array.isArray(nested) ? trimmed(nested[field]) : trimmed(obj[key]);
+		if (v) out[key] = v;
+	}
+	return out;
+}
+/**
+* Builds the stored `links` object from flat fields. Empty values are left
+* out, and so is a group with nothing in it; no links gives `{}`.
+*/
+function merchantLinksFromForm(form) {
+	const out = {};
+	for (const key of MERCHANT_LINK_KEYS) {
+		const v = trimmed(form[key]);
+		if (!v) continue;
+		const [group, field] = MERCHANT_LINK_PATHS[key];
+		(out[group] ??= {})[field] = v;
+	}
+	return out;
+}
+/** Reads any stored or older `links` value into the nested shape adminV1 saves. */
+function normalizeMerchantLinks(links) {
+	return merchantLinksFromForm(merchantLinksToForm(links));
+}
+/**
+* Object fields of the merchant. The API keeps one you leave out, and
+* replaces it as a whole when you send it.
+*/
+const MERCHANT_OBJECT_FIELDS = [
+	"colours",
+	"links",
+	"imageIds"
+];
+/** Fields the API sets itself; `updateMerchant` never sends them back. */
+const MERCHANT_READ_ONLY_FIELDS = ["createdDate", "modifiedDate"];
+/**
+* Longest values the API stores. Longer values are cut off silently
+* (live API, Sep 2026), so `updateMerchant` rejects them instead.
+* `vatNumber` fits a UK VAT number without the `GB` prefix.
+*/
+const MERCHANT_FIELD_MAX_LENGTH = Object.freeze({
+	companyNumber: 11,
+	vatNumber: 9
+});
+/** Returns `"<field> is longer than <n> characters"` messages for over-long fields. */
+function validateMerchant(merchant) {
+	const problems = [];
+	for (const [field, max] of Object.entries(MERCHANT_FIELD_MAX_LENGTH)) {
+		const value = merchant[field];
+		if (typeof value === "string" && value.length > max) problems.push(`${field} is longer than ${max} characters`);
+	}
+	return problems;
+}
+/**
+* Reads the logged-in user's merchant (a user has exactly one), or `null`
+* when the API returns none.
+*/
+async function fetchMerchant(options = {}) {
+	const json = await apiGet(MERCHANT_PATH, {}, options);
+	assertNoApiErrors(json, 200);
+	return json?.merchant ?? null;
+}
+/**
+* Updates the merchant and returns it as stored.
+*
+* Shopwave's `POST /merchant` replaces the whole record: a scalar field you
+* leave out (`companyNumber`, `vatNumber`, `note`, …) is set to null, while
+* an object field you leave out (`colours`, `links`, `imageIds`) is kept and
+* one you send replaces the stored one; sending `{}` clears it (live API,
+* Sep 2026). So by default the
+* current merchant is read first and the patch is merged over it.
+*
+* `imageIds` is always sent as file names ({@link toStoredImageIds}), so you
+* can pass back what you read. See `MerchantImageIds` for the shape.
+*
+* The API answers 205 with an empty body, so the merchant is read again after
+* the save and that is what's returned (it shows exactly what was kept).
+* Throws before sending when a value is longer than the API stores
+* ({@link MERCHANT_FIELD_MAX_LENGTH}).
+*/
+async function updateMerchant(patch, options = {}) {
+	const { merge = true,...requestOptions } = options;
+	let merchant = { ...patch };
+	if (merge) {
+		const current = await fetchMerchant(requestOptions);
+		if (!current) throw new ShopwaveApiError(404, "Shopwave API error (404): no merchant to update");
+		if (patch.id != null && String(patch.id) !== String(current.id)) throw new Error(`Merchant id ${patch.id} is not the logged-in merchant (${current.id})`);
+		merchant = {
+			...current,
+			...patch,
+			id: current.id
+		};
+		for (const field of MERCHANT_OBJECT_FIELDS) if (!(field in patch)) delete merchant[field];
+	}
+	if (merchant.imageIds && typeof merchant.imageIds === "object") merchant.imageIds = toStoredImageIds(merchant.imageIds);
+	if (merchant.id == null || merchant.id === "") throw new Error("merchant id is missing");
+	for (const field of MERCHANT_READ_ONLY_FIELDS) delete merchant[field];
+	const problems = validateMerchant(merchant);
+	if (problems.length > 0) throw new Error(`Invalid merchant: ${problems.join("; ")}`);
+	const { status, body: raw } = await apiRequest(MERCHANT_PATH, {
+		method: "PUT",
+		headers: { "Content-Type": "application/json" },
+		body: JSON.stringify({ merchant })
+	}, requestOptions);
+	const body = raw;
+	assertNoApiErrors(body, status);
+	const echoed = body?.merchant && typeof body.merchant === "object" ? body.merchant : null;
+	if (echoed) return {
+		...merchant,
+		...echoed,
+		id: Number(echoed.id ?? merchant.id)
+	};
+	return await fetchMerchant(requestOptions) ?? {
+		...merchant,
+		id: Number(merchant.id)
+	};
+}
+
+//#endregion
+//#region src/core/user.ts
+/** Reads the logged-in user, or `null` when the API returns none. */
+async function fetchUser(options = {}) {
+	const json = await apiGet(`/api/${SHOPWAVE_RESOURCES.user.route}`, {}, options);
+	assertNoApiErrors(json, 200);
+	return json?.user ?? null;
+}
+
+//#endregion
+export { DEFAULT_BASKET_FILTERS, DEFAULT_PAGINATION, MERCHANT_COLOUR_KEYS, MERCHANT_FIELD_MAX_LENGTH, MERCHANT_IMAGE_SLOTS, MERCHANT_IMAGE_SLOT_KEYS, MERCHANT_LINK_KEYS, MERCHANT_LINK_PATHS, MERCHANT_OBJECT_FIELDS, MERCHANT_READ_ONLY_FIELDS, PromotionRuleSet, SHOPWAVE_ENTITIES, SHOPWAVE_IMAGE_BASE_URL, SHOPWAVE_RESOURCES, SHOPWAVE_UPLOAD, ShopwaveApiError, UPLOAD_KINDS, apiDelete, apiGet, apiRequest, apiSend, assertNoApiErrors, authorizationFor, buildBasketReportQuery, buildConsumerMap, collectConsumerIds, collectProductIds, combineBasketRows, computeBasketSummary, coverCrop, deleteCategory, deleteEmployee, deleteEntity, deleteEntityById, deleteProduct, deletePromotion, deleteStore, fetchCategories, fetchCategory, fetchConsumer, fetchConsumers, fetchEmployee, fetchEmployees, fetchEntityById, fetchMerchant, fetchProduct, fetchProducts, fetchProductsMap, fetchPromotion, fetchPromotions, fetchReport, fetchSession, fetchStore, fetchStores, fetchUser, fitImageToSize, formatDateForQuery, getApiErrorMap, getApiErrors, getImageUrl, getMerchantImage, getMerchantImageUrl, imageFileName, isUploadKind, loginPath, logout, logoutPath, merchantLinksFromForm, merchantLinksToForm, normalizeMerchantLinks, parseBasketReportData, readImageSize, rolesById, saveCategory, saveEmployee, saveEntities, saveEntity, saveProduct, savePromotion, saveStore, setMerchantImage, submitEntity, toShopwaveApiError, toStoredImageIds, updateMerchant, uploadImage, uploadMerchantImage, validateMerchant, withToken };
 //# sourceMappingURL=index.js.map