react-shopwave-connect 0.4.2 → 0.4.4

package/dist/next/index.cjs

@@ -274,6 +274,74 @@ function safeEqual(a, b) {
 	return diff === 0;
 }
 
+//#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/entities.ts
 /**
@@ -350,50 +418,6 @@ const SHOPWAVE_ENTITIES = Object.freeze({
 	}
 });
 
-//#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/server/api.ts
 /**
@@ -722,6 +746,8 @@ function createShopwaveApiHandlers(config) {
 		if (!file || typeof file === "string" || file.size === 0) return jsonError(400, "invalid_body", `Missing "${SHOPWAVE_UPLOAD.fileField}"`);
 		const kind = form.get(SHOPWAVE_UPLOAD.kindField);
 		if (!isUploadKind(kind)) return jsonError(400, "invalid_body", `"${SHOPWAVE_UPLOAD.kindField}" must be one of ${Object.keys(UPLOAD_KINDS).join(", ")}`);
+		const prefix = form.get(SHOPWAVE_UPLOAD.prefixField);
+		if (prefix !== null && !isUploadPrefix(prefix)) return jsonError(400, "invalid_body", `"${SHOPWAVE_UPLOAD.prefixField}" must be one of ${UPLOAD_PREFIXES.join(", ")}`);
 		if (file.size > maxBytes) return jsonError(413, "too_large", `The file is larger than ${maxBytes} bytes`);
 		if (!acceptsType(file.type || "", accept)) return jsonError(415, "unsupported_type", `Files of type "${file.type || "unknown"}" aren't accepted`);
 		const upstreamForm = new FormData();
@@ -729,7 +755,10 @@ function createShopwaveApiHandlers(config) {
 		return forward(request, {
 			method: "PUT",
 			path: SHOPWAVE_UPLOAD.upstream,
-			headers: { [SHOPWAVE_UPLOAD.kindHeader]: UPLOAD_KINDS[kind] },
+			headers: {
+				[SHOPWAVE_UPLOAD.kindHeader]: UPLOAD_KINDS[kind],
+				...prefix !== null ? { [SHOPWAVE_UPLOAD.prefixHeader]: prefix } : {}
+			},
 			formData: upstreamForm,
 			forwardExtras: false
 		});
@@ -834,6 +863,14 @@ function createShopwaveApiHandlers(config) {
 		passthrough(path) {
 			return { GET: (request) => forward(request, { path }) };
 		},
+		lookup(kind) {
+			const def = SHOPWAVE_LOOKUPS[kind];
+			if (!def) throw new Error(`Unknown Shopwave lookup "${kind}"`);
+			return { GET: (request) => forward(request, {
+				path: def.upstream,
+				forwardExtras: false
+			}) };
+		},
 		resource(kind) {
 			const def = resourceDef(kind);
 			const save = (request) => writeResource(request, def);
@@ -1176,6 +1213,9 @@ function createShopwaveAuth(config) {
 * export const { GET } = shopwave.resource("user");
 * // app/api/upload/route.ts
 * export const { POST } = shopwave.upload();
+* // app/api/products/tags/route.ts, app/api/products/instance-tags/route.ts
+* export const { GET } = shopwave.lookup("productTags");
+* export const { GET } = shopwave.lookup("productInstanceTags");
 * ```
 */
 function createShopwaveApi(config) {
@@ -1189,9 +1229,11 @@ function createShopwaveApi(config) {
 
 //#endregion
 exports.SHOPWAVE_ENTITIES = SHOPWAVE_ENTITIES;
+exports.SHOPWAVE_LOOKUPS = SHOPWAVE_LOOKUPS;
 exports.SHOPWAVE_RESOURCES = SHOPWAVE_RESOURCES;
 exports.ShopwaveAuthError = ShopwaveAuthError;
 exports.UPLOAD_KINDS = UPLOAD_KINDS;
+exports.UPLOAD_PREFIXES = UPLOAD_PREFIXES;
 exports.authorizationHeader = authorizationHeader;
 exports.createShopwaveApi = createShopwaveApi;
 exports.createShopwaveAuth = createShopwaveAuth;