react-shopwave-connect 0.4.2 → 0.4.3

package/dist/next/index.d.cts

@@ -87,8 +87,9 @@ interface ShopwaveOAuthClient {
 //#region src/core/entities.d.ts
 /**
  * How each Shopwave entity is addressed, shared by the client functions below
- * and the server route handlers in `react-shopwave-connect/next`, so the two
- * halves of the contract can't drift apart.
+ * and the server route handlers in `react-shopwave-connect/server` (wrapped with
+ * the session by `react-shopwave-connect/next`), so the two halves of the
+ * contract can't drift apart.
  */
 interface EntityDefinition {
   /** App route segment: `/api/<route>` and `/api/<route>/<id>`. */
@@ -148,7 +149,7 @@ declare const SHOPWAVE_ENTITIES: Readonly<Record<EntityKind, EntityDefinition>>;
  *
  * Like `SHOPWAVE_ENTITIES`, this table is shared by the client functions
  * (`fetchMerchant`, `fetchUser`, `uploadImage`, …) and the server route
- * handlers in `react-shopwave-connect/next`, so the two halves of the contract
+ * handlers in `react-shopwave-connect/server`, so the two halves of the contract
  * can't drift apart. These aren't in `SHOPWAVE_ENTITIES` because they aren't
  * keyed collections: `GET /merchant` answers `{ merchant: {…} }`, not a map by id.
  */
@@ -181,6 +182,35 @@ declare const SHOPWAVE_RESOURCES: Readonly<Record<ResourceKind, ResourceDefiniti
 type UploadKind = "merchant" | "merchantFeature" | "product" | "user" | "applicationLogo" | "applicationImages";
 /** `UploadKind` → the API's `contentType` value. */
 declare const UPLOAD_KINDS: Readonly<Record<UploadKind, string>>;
+/**
+ * Read-only lists that aren't records: the merchant's distinct tags.
+ *
+ * Like `SHOPWAVE_RESOURCES`, shared by the client functions
+ * (`fetchProductTags`, `fetchProductInstanceTags`) and the server route
+ * handlers (`shopwave.lookup(kind)`), so the two halves can't drift apart.
+ *
+ * - productTags: `GET /product/tags` → `{ tags: string[] }`, every distinct tag
+ *   on the merchant's products. No parameters. The API reference says
+ *   "internal SKU tags are excluded", but the live API includes system tags
+ *   written by imports and syncs (`PID-133`, `VID-137`, `#Hash:…`, `upc-…`;
+ *   test merchant 5644, 29 Oct 2026). Apps that offer the list as suggestions
+ *   filter those themselves. Tags of deleted products drop out of the list.
+ * - productInstanceTags: `GET /product/instance/tags` → `{ tags: string[] }`,
+ *   the same for price instances (channels such as "Eat In", "Takeout").
+ *
+ * The app route for instance tags is `products/instance-tags`, one segment
+ * under `products`, so it sits beside `products/[id]` without nesting deeper.
+ */
+interface LookupDefinition {
+  /** App route: `/api/<route>`. */
+  route: string;
+  /** Key of the list in the response (`{ tags: [...] }`). */
+  key: string;
+  /** Shopwave API path. */
+  upstream: string;
+}
+type LookupKind = "productTags" | "productInstanceTags";
+declare const SHOPWAVE_LOOKUPS: Readonly<Record<LookupKind, LookupDefinition>>;
 //#endregion
 //#region src/server/api.d.ts
 /**
@@ -303,6 +333,14 @@ interface ShopwaveApiHandlers {
   passthrough(path: string): {
     GET: RouteHandler;
   };
+  /**
+   * Handler for a read-only list (see `SHOPWAVE_LOOKUPS`), e.g.
+   * `app/api/products/tags/route.ts`: `export const { GET } = shopwave.lookup("productTags")`.
+   * Takes no parameters, so the caller's `extras` aren't forwarded.
+   */
+  lookup(kind: LookupKind): {
+    GET: RouteHandler;
+  };
   /** Handlers for a singleton resource: `app/api/merchant/route.ts`, `app/api/user/route.ts`. */
   resource(kind: ResourceKind): ResourceHandlers;
   /** Handler for `app/api/upload/route.ts`. */
@@ -510,9 +548,12 @@ interface ShopwaveNextApiConfig extends Omit<ShopwaveApiConfig, "getAuthorizatio
  * 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");
  * ```
  */
 declare function createShopwaveApi(config: ShopwaveNextApiConfig): ShopwaveApiHandlers;
 //#endregion
-export { AuthContext, type CollectionHandlers, type EntityDefinition, type EntityKind, type ForwardInit, type ItemHandlers, ProtectOptions, type ResourceHandlers, type ResourceKind, type RouteContext, type RouteHandler, SHOPWAVE_ENTITIES, SHOPWAVE_RESOURCES, type SessionStatus, type ShopwaveApiHandlers, ShopwaveAuth, ShopwaveAuthConfig, ShopwaveAuthError, ShopwaveNextApiConfig, ShopwaveSessionConfig, ShopwaveSessionData, type ShopwaveToken, UPLOAD_KINDS, type UploadHandlers, type UploadKind, type UploadOptions, authorizationHeader, createShopwaveApi, createShopwaveAuth, isExpiredTokenResponse, readRequestToken };
+export { AuthContext, type CollectionHandlers, type EntityDefinition, type EntityKind, type ForwardInit, type ItemHandlers, type LookupKind, ProtectOptions, type ResourceHandlers, type ResourceKind, type RouteContext, type RouteHandler, SHOPWAVE_ENTITIES, SHOPWAVE_LOOKUPS, SHOPWAVE_RESOURCES, type SessionStatus, type ShopwaveApiHandlers, ShopwaveAuth, ShopwaveAuthConfig, ShopwaveAuthError, ShopwaveNextApiConfig, ShopwaveSessionConfig, ShopwaveSessionData, type ShopwaveToken, UPLOAD_KINDS, type UploadHandlers, type UploadKind, type UploadOptions, authorizationHeader, createShopwaveApi, createShopwaveAuth, isExpiredTokenResponse, readRequestToken };
 //# sourceMappingURL=index.d.cts.map

package/dist/next/index.d.ts

@@ -87,8 +87,9 @@ interface ShopwaveOAuthClient {
 //#region src/core/entities.d.ts
 /**
  * How each Shopwave entity is addressed, shared by the client functions below
- * and the server route handlers in `react-shopwave-connect/next`, so the two
- * halves of the contract can't drift apart.
+ * and the server route handlers in `react-shopwave-connect/server` (wrapped with
+ * the session by `react-shopwave-connect/next`), so the two halves of the
+ * contract can't drift apart.
  */
 interface EntityDefinition {
   /** App route segment: `/api/<route>` and `/api/<route>/<id>`. */
@@ -148,7 +149,7 @@ declare const SHOPWAVE_ENTITIES: Readonly<Record<EntityKind, EntityDefinition>>;
  *
  * Like `SHOPWAVE_ENTITIES`, this table is shared by the client functions
  * (`fetchMerchant`, `fetchUser`, `uploadImage`, …) and the server route
- * handlers in `react-shopwave-connect/next`, so the two halves of the contract
+ * handlers in `react-shopwave-connect/server`, so the two halves of the contract
  * can't drift apart. These aren't in `SHOPWAVE_ENTITIES` because they aren't
  * keyed collections: `GET /merchant` answers `{ merchant: {…} }`, not a map by id.
  */
@@ -181,6 +182,35 @@ declare const SHOPWAVE_RESOURCES: Readonly<Record<ResourceKind, ResourceDefiniti
 type UploadKind = "merchant" | "merchantFeature" | "product" | "user" | "applicationLogo" | "applicationImages";
 /** `UploadKind` → the API's `contentType` value. */
 declare const UPLOAD_KINDS: Readonly<Record<UploadKind, string>>;
+/**
+ * Read-only lists that aren't records: the merchant's distinct tags.
+ *
+ * Like `SHOPWAVE_RESOURCES`, shared by the client functions
+ * (`fetchProductTags`, `fetchProductInstanceTags`) and the server route
+ * handlers (`shopwave.lookup(kind)`), so the two halves can't drift apart.
+ *
+ * - productTags: `GET /product/tags` → `{ tags: string[] }`, every distinct tag
+ *   on the merchant's products. No parameters. The API reference says
+ *   "internal SKU tags are excluded", but the live API includes system tags
+ *   written by imports and syncs (`PID-133`, `VID-137`, `#Hash:…`, `upc-…`;
+ *   test merchant 5644, 29 Oct 2026). Apps that offer the list as suggestions
+ *   filter those themselves. Tags of deleted products drop out of the list.
+ * - productInstanceTags: `GET /product/instance/tags` → `{ tags: string[] }`,
+ *   the same for price instances (channels such as "Eat In", "Takeout").
+ *
+ * The app route for instance tags is `products/instance-tags`, one segment
+ * under `products`, so it sits beside `products/[id]` without nesting deeper.
+ */
+interface LookupDefinition {
+  /** App route: `/api/<route>`. */
+  route: string;
+  /** Key of the list in the response (`{ tags: [...] }`). */
+  key: string;
+  /** Shopwave API path. */
+  upstream: string;
+}
+type LookupKind = "productTags" | "productInstanceTags";
+declare const SHOPWAVE_LOOKUPS: Readonly<Record<LookupKind, LookupDefinition>>;
 //#endregion
 //#region src/server/api.d.ts
 /**
@@ -303,6 +333,14 @@ interface ShopwaveApiHandlers {
   passthrough(path: string): {
     GET: RouteHandler;
   };
+  /**
+   * Handler for a read-only list (see `SHOPWAVE_LOOKUPS`), e.g.
+   * `app/api/products/tags/route.ts`: `export const { GET } = shopwave.lookup("productTags")`.
+   * Takes no parameters, so the caller's `extras` aren't forwarded.
+   */
+  lookup(kind: LookupKind): {
+    GET: RouteHandler;
+  };
   /** Handlers for a singleton resource: `app/api/merchant/route.ts`, `app/api/user/route.ts`. */
   resource(kind: ResourceKind): ResourceHandlers;
   /** Handler for `app/api/upload/route.ts`. */
@@ -510,9 +548,12 @@ interface ShopwaveNextApiConfig extends Omit<ShopwaveApiConfig, "getAuthorizatio
  * 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");
  * ```
  */
 declare function createShopwaveApi(config: ShopwaveNextApiConfig): ShopwaveApiHandlers;
 //#endregion
-export { AuthContext, type CollectionHandlers, type EntityDefinition, type EntityKind, type ForwardInit, type ItemHandlers, ProtectOptions, type ResourceHandlers, type ResourceKind, type RouteContext, type RouteHandler, SHOPWAVE_ENTITIES, SHOPWAVE_RESOURCES, type SessionStatus, type ShopwaveApiHandlers, ShopwaveAuth, ShopwaveAuthConfig, ShopwaveAuthError, ShopwaveNextApiConfig, ShopwaveSessionConfig, ShopwaveSessionData, type ShopwaveToken, UPLOAD_KINDS, type UploadHandlers, type UploadKind, type UploadOptions, authorizationHeader, createShopwaveApi, createShopwaveAuth, isExpiredTokenResponse, readRequestToken };
+export { AuthContext, type CollectionHandlers, type EntityDefinition, type EntityKind, type ForwardInit, type ItemHandlers, type LookupKind, ProtectOptions, type ResourceHandlers, type ResourceKind, type RouteContext, type RouteHandler, SHOPWAVE_ENTITIES, SHOPWAVE_LOOKUPS, SHOPWAVE_RESOURCES, type SessionStatus, type ShopwaveApiHandlers, ShopwaveAuth, ShopwaveAuthConfig, ShopwaveAuthError, ShopwaveNextApiConfig, ShopwaveSessionConfig, ShopwaveSessionData, type ShopwaveToken, UPLOAD_KINDS, type UploadHandlers, type UploadKind, type UploadOptions, authorizationHeader, createShopwaveApi, createShopwaveAuth, isExpiredTokenResponse, readRequestToken };
 //# sourceMappingURL=index.d.ts.map

package/dist/next/index.js

@@ -367,6 +367,18 @@ const SHOPWAVE_UPLOAD = Object.freeze({
 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/server/api.ts
@@ -808,6 +820,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);
@@ -1150,6 +1170,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) {
@@ -1162,5 +1185,5 @@ function createShopwaveApi(config) {
 }
 
 //#endregion
-export { SHOPWAVE_ENTITIES, SHOPWAVE_RESOURCES, ShopwaveAuthError, UPLOAD_KINDS, authorizationHeader, createShopwaveApi, createShopwaveAuth, isExpiredTokenResponse, readRequestToken };
+export { SHOPWAVE_ENTITIES, SHOPWAVE_LOOKUPS, SHOPWAVE_RESOURCES, ShopwaveAuthError, UPLOAD_KINDS, authorizationHeader, createShopwaveApi, createShopwaveAuth, isExpiredTokenResponse, readRequestToken };
 //# sourceMappingURL=index.js.map