react-shopwave-connect 0.4.5 → 0.4.7

package/dist/hooks/index.d.cts

@@ -183,6 +183,32 @@ interface FetchProductsParams {
   token?: string;
 }
 //#endregion
+//#region src/core/store.d.ts
+interface Store {
+  id: number;
+  lat: number;
+  lng: number;
+  addressLine1: string;
+  addressLine2: string | null;
+  addressLine3: string;
+  phoneNumber: string;
+  city: string;
+  postcode: string;
+  countryId: number | null;
+  timezoneId: number | null;
+  storeDeleteDate: string | null;
+  email: string | null;
+  sandbox: boolean | null;
+}
+interface FetchStoresParams {
+  /** Optional id filter. */
+  storeIds?: Array<number>;
+  /** Whether to include soft-deleted records. Defaults to `false`. */
+  deleted?: boolean;
+  /** @deprecated Pass `options.token` instead. Sent the same way (Authorization header). */
+  token?: string;
+}
+//#endregion
 //#region src/core/promotion.d.ts
 /** Promotion rule identifiers as stored by the Shopwave API. */
 declare enum PromotionRuleSet {
@@ -226,30 +252,62 @@ interface FetchPromotionsParams {
   token?: string;
 }
 //#endregion
-//#region src/core/store.d.ts
-interface Store {
+//#region src/core/productComponent.d.ts
+/**
+ * Product components are modifier groups: a group belongs to a parent product
+ * (`productId`) and offers other products as options. Each option product has
+ * one or more option rows (`productInstances`). See `SHOPWAVE_ENTITIES.productComponent`
+ * for what the live API does on reads, saves and deletes.
+ */
+/** One option row of a product component. */
+interface ProductComponentInstance {
   id: number;
-  lat: number;
-  lng: number;
-  addressLine1: string;
-  addressLine2: string | null;
-  addressLine3: string;
-  phoneNumber: string;
-  city: string;
-  postcode: string;
-  countryId: number | null;
-  timezoneId: number | null;
-  storeDeleteDate: string | null;
-  email: string | null;
-  sandbox: boolean | null;
-}
-interface FetchStoresParams {
-  /** Optional id filter. */
-  storeIds?: Array<number>;
-  /** Whether to include soft-deleted records. Defaults to `false`. */
+  /** Name override for the option; `null` or `""` means the product's own name. Stored as sent. */
+  name: string | null;
+  /** Price as a decimal string, pence excluding VAT (reads return `"100.0"` for `"100"`). */
+  price: string;
+  /** VAT as a fraction string (`"0.200"`). */
+  vatPercentage: string;
+  quantity: number;
+  /** Comma-separated price tags, or `null`. Stored as sent (not trimmed). */
+  tags: string | null;
+  size?: string | null;
+  activeDate?: string | null;
+  /** Set once the row has been deleted; deleted rows still appear in live reads. */
+  deleteDate?: string | null;
+}
+/** A product offered as an option in a product component, with its option rows. */
+interface ProductComponentProduct {
+  id: number;
+  name: string;
+  barcode?: string | null;
+  details?: string | null;
+  unit?: number | null;
+  activeDate?: string | null;
+  /** Option rows, keyed by row id on reads. */
+  productInstances: Record<string, ProductComponentInstance>;
+}
+/** A product component (modifier group). */
+interface ProductComponent {
+  id: number;
+  name: string;
+  /** The parent product the group belongs to. */
+  productId: number;
+  minQuantity: number;
+  maxQuantity: number;
+  productTimestamp?: string;
+  /** Set once the group has been deleted (only `deleted: true` reads return it then). */
+  deleteDate?: string | null;
+  /** Option products, keyed by product id. */
+  products: Record<string, ProductComponentProduct>;
+}
+interface FetchProductComponentsParams {
+  /** Parent products whose groups to read. */
+  productIds?: ReadonlyArray<number | string>;
+  /** Groups to read, by id. */
+  productComponentIds?: ReadonlyArray<number | string>;
+  /** `false` (default): live groups only. `true`: deleted groups only. */
   deleted?: boolean;
-  /** @deprecated Pass `options.token` instead. Sent the same way (Authorization header). */
-  token?: string;
 }
 //#endregion
 //#region src/core/report.d.ts
@@ -357,8 +415,8 @@ type UploadKind = "merchant" | "merchantFeature" | "product" | "user" | "applica
 /**
  * The role an image plays, sent to Shopwave as the uploader's `prefix` header.
  * The uploader names the file `<prefix>_<hash>.<ext>`, so the role travels with
- * the file wherever a record stores it (a product's `images`). Live, merchant
- * 5644, 4 Nov 2026: all four values answered 201.
+ * the file wherever a record stores it (a product's `images`). Live, test
+ * merchant, 4 Nov 2026: all four values answered 201.
  * - `product`: a product gallery image;
  * - `product_thumbnail`: the product's lead image, shown in lists;
  * - `variant` / `variant_thumbnail`: a variant's own image and its lead image
@@ -402,7 +460,7 @@ interface UploadedImage {
 //#endregion
 //#region src/core/merchantImages.d.ts
 /**
- * Merchant images, as adminV1 saves them and adminV2 reads them:
+ * Merchant images, as Shopwave's existing admin apps save and read them:
  *
  * ```
  * { logo: { receipt: "<file>", square: "<file>" }, feature: ["<file>"] }
@@ -419,7 +477,7 @@ interface UploadedImage {
  *   So a featured image must be uploaded with kind `merchantFeature` (which
  *   stores it under `feature/`); a `merchant` upload lands under `logo/`.
  *
- * Confirmed on the live API, merchant 5644, 30 Sep 2026.
+ * Confirmed on the live API, 30 Sep 2026.
  */
 interface MerchantImageIds {
   logo?: {
@@ -452,7 +510,7 @@ interface MerchantColourSet {
   [key: string]: string | null | undefined;
 }
 /**
- * Brand colours, as adminV1 saves them and adminV2 reads them
+ * Brand colours, as Shopwave's existing admin apps save and read them
  * (`colours.primary.main` is the logo background): `{ primary: { main,
  * highlight, contrast } }`. `{}` when unset. Confirmed live, 30 Sep 2026.
  */
@@ -461,7 +519,7 @@ interface MerchantColours {
   [key: string]: MerchantColourSet | null | undefined;
 }
 /**
- * Web and social links, as adminV1 saves them:
+ * Web and social links, as Shopwave's existing admin saves them:
  * `{ website: { home }, social: { twitter, facebook, instagram } }`.
  * `{}` when empty (confirmed live, 30 Sep 2026). Use {@link normalizeMerchantLinks} to read older shapes and
  * {@link merchantLinksToForm} / {@link merchantLinksFromForm} for flat forms.
@@ -585,6 +643,15 @@ declare function useProductTags(options?: LookupOptions): QueryState<string[]>;
  */
 declare function useProductInstanceTags(options?: LookupOptions): QueryState<string[]>;
 //#endregion
+//#region src/hooks/useProductComponent.d.ts
+/**
+ * Auto-fetches product components (modifier groups) on mount and whenever the params change:
+ * a product's groups with `{ productIds: [id] }`, one group with `{ productComponentIds: [id] }`,
+ * or every group with no filter. Option rows with a `deleteDate` are included; skip them when
+ * listing options.
+ */
+declare function useProductComponent(params?: FetchProductComponentsParams, options?: RequestOptions): QueryState<ProductComponent[]>;
+//#endregion
 //#region src/hooks/usePromotion.d.ts
 /**
  * Auto-fetches promotions on mount and whenever the params change.
@@ -738,5 +805,5 @@ interface UseBasketReportReturn {
  */
 declare function useBasketReport(options?: RequestOptions): UseBasketReportReturn;
 //#endregion
-export { type MutationState, type QueryState, type UseBasketReportReturn, useBasketReport, useCategory, useConsumer, useDelete, useEmployee, useLogout, useMerchant, useProduct, useProductInstanceTags, useProductTags, usePromotion, useReport, useSession, useStore, useSubmit, useUpdateMerchant, useUploadImage, useUploadMerchantImage, useUser };
+export { type MutationState, type QueryState, type UseBasketReportReturn, useBasketReport, useCategory, useConsumer, useDelete, useEmployee, useLogout, useMerchant, useProduct, useProductComponent, useProductInstanceTags, useProductTags, usePromotion, useReport, useSession, useStore, useSubmit, useUpdateMerchant, useUploadImage, useUploadMerchantImage, useUser };
 //# sourceMappingURL=index.d.cts.map

package/dist/hooks/index.d.ts

@@ -183,6 +183,32 @@ interface FetchProductsParams {
   token?: string;
 }
 //#endregion
+//#region src/core/store.d.ts
+interface Store {
+  id: number;
+  lat: number;
+  lng: number;
+  addressLine1: string;
+  addressLine2: string | null;
+  addressLine3: string;
+  phoneNumber: string;
+  city: string;
+  postcode: string;
+  countryId: number | null;
+  timezoneId: number | null;
+  storeDeleteDate: string | null;
+  email: string | null;
+  sandbox: boolean | null;
+}
+interface FetchStoresParams {
+  /** Optional id filter. */
+  storeIds?: Array<number>;
+  /** Whether to include soft-deleted records. Defaults to `false`. */
+  deleted?: boolean;
+  /** @deprecated Pass `options.token` instead. Sent the same way (Authorization header). */
+  token?: string;
+}
+//#endregion
 //#region src/core/promotion.d.ts
 /** Promotion rule identifiers as stored by the Shopwave API. */
 declare enum PromotionRuleSet {
@@ -226,30 +252,62 @@ interface FetchPromotionsParams {
   token?: string;
 }
 //#endregion
-//#region src/core/store.d.ts
-interface Store {
+//#region src/core/productComponent.d.ts
+/**
+ * Product components are modifier groups: a group belongs to a parent product
+ * (`productId`) and offers other products as options. Each option product has
+ * one or more option rows (`productInstances`). See `SHOPWAVE_ENTITIES.productComponent`
+ * for what the live API does on reads, saves and deletes.
+ */
+/** One option row of a product component. */
+interface ProductComponentInstance {
   id: number;
-  lat: number;
-  lng: number;
-  addressLine1: string;
-  addressLine2: string | null;
-  addressLine3: string;
-  phoneNumber: string;
-  city: string;
-  postcode: string;
-  countryId: number | null;
-  timezoneId: number | null;
-  storeDeleteDate: string | null;
-  email: string | null;
-  sandbox: boolean | null;
-}
-interface FetchStoresParams {
-  /** Optional id filter. */
-  storeIds?: Array<number>;
-  /** Whether to include soft-deleted records. Defaults to `false`. */
+  /** Name override for the option; `null` or `""` means the product's own name. Stored as sent. */
+  name: string | null;
+  /** Price as a decimal string, pence excluding VAT (reads return `"100.0"` for `"100"`). */
+  price: string;
+  /** VAT as a fraction string (`"0.200"`). */
+  vatPercentage: string;
+  quantity: number;
+  /** Comma-separated price tags, or `null`. Stored as sent (not trimmed). */
+  tags: string | null;
+  size?: string | null;
+  activeDate?: string | null;
+  /** Set once the row has been deleted; deleted rows still appear in live reads. */
+  deleteDate?: string | null;
+}
+/** A product offered as an option in a product component, with its option rows. */
+interface ProductComponentProduct {
+  id: number;
+  name: string;
+  barcode?: string | null;
+  details?: string | null;
+  unit?: number | null;
+  activeDate?: string | null;
+  /** Option rows, keyed by row id on reads. */
+  productInstances: Record<string, ProductComponentInstance>;
+}
+/** A product component (modifier group). */
+interface ProductComponent {
+  id: number;
+  name: string;
+  /** The parent product the group belongs to. */
+  productId: number;
+  minQuantity: number;
+  maxQuantity: number;
+  productTimestamp?: string;
+  /** Set once the group has been deleted (only `deleted: true` reads return it then). */
+  deleteDate?: string | null;
+  /** Option products, keyed by product id. */
+  products: Record<string, ProductComponentProduct>;
+}
+interface FetchProductComponentsParams {
+  /** Parent products whose groups to read. */
+  productIds?: ReadonlyArray<number | string>;
+  /** Groups to read, by id. */
+  productComponentIds?: ReadonlyArray<number | string>;
+  /** `false` (default): live groups only. `true`: deleted groups only. */
   deleted?: boolean;
-  /** @deprecated Pass `options.token` instead. Sent the same way (Authorization header). */
-  token?: string;
 }
 //#endregion
 //#region src/core/report.d.ts
@@ -357,8 +415,8 @@ type UploadKind = "merchant" | "merchantFeature" | "product" | "user" | "applica
 /**
  * The role an image plays, sent to Shopwave as the uploader's `prefix` header.
  * The uploader names the file `<prefix>_<hash>.<ext>`, so the role travels with
- * the file wherever a record stores it (a product's `images`). Live, merchant
- * 5644, 4 Nov 2026: all four values answered 201.
+ * the file wherever a record stores it (a product's `images`). Live, test
+ * merchant, 4 Nov 2026: all four values answered 201.
  * - `product`: a product gallery image;
  * - `product_thumbnail`: the product's lead image, shown in lists;
  * - `variant` / `variant_thumbnail`: a variant's own image and its lead image
@@ -402,7 +460,7 @@ interface UploadedImage {
 //#endregion
 //#region src/core/merchantImages.d.ts
 /**
- * Merchant images, as adminV1 saves them and adminV2 reads them:
+ * Merchant images, as Shopwave's existing admin apps save and read them:
  *
  * ```
  * { logo: { receipt: "<file>", square: "<file>" }, feature: ["<file>"] }
@@ -419,7 +477,7 @@ interface UploadedImage {
  *   So a featured image must be uploaded with kind `merchantFeature` (which
  *   stores it under `feature/`); a `merchant` upload lands under `logo/`.
  *
- * Confirmed on the live API, merchant 5644, 30 Sep 2026.
+ * Confirmed on the live API, 30 Sep 2026.
  */
 interface MerchantImageIds {
   logo?: {
@@ -452,7 +510,7 @@ interface MerchantColourSet {
   [key: string]: string | null | undefined;
 }
 /**
- * Brand colours, as adminV1 saves them and adminV2 reads them
+ * Brand colours, as Shopwave's existing admin apps save and read them
  * (`colours.primary.main` is the logo background): `{ primary: { main,
  * highlight, contrast } }`. `{}` when unset. Confirmed live, 30 Sep 2026.
  */
@@ -461,7 +519,7 @@ interface MerchantColours {
   [key: string]: MerchantColourSet | null | undefined;
 }
 /**
- * Web and social links, as adminV1 saves them:
+ * Web and social links, as Shopwave's existing admin saves them:
  * `{ website: { home }, social: { twitter, facebook, instagram } }`.
  * `{}` when empty (confirmed live, 30 Sep 2026). Use {@link normalizeMerchantLinks} to read older shapes and
  * {@link merchantLinksToForm} / {@link merchantLinksFromForm} for flat forms.
@@ -585,6 +643,15 @@ declare function useProductTags(options?: LookupOptions): QueryState<string[]>;
  */
 declare function useProductInstanceTags(options?: LookupOptions): QueryState<string[]>;
 //#endregion
+//#region src/hooks/useProductComponent.d.ts
+/**
+ * Auto-fetches product components (modifier groups) on mount and whenever the params change:
+ * a product's groups with `{ productIds: [id] }`, one group with `{ productComponentIds: [id] }`,
+ * or every group with no filter. Option rows with a `deleteDate` are included; skip them when
+ * listing options.
+ */
+declare function useProductComponent(params?: FetchProductComponentsParams, options?: RequestOptions): QueryState<ProductComponent[]>;
+//#endregion
 //#region src/hooks/usePromotion.d.ts
 /**
  * Auto-fetches promotions on mount and whenever the params change.
@@ -738,5 +805,5 @@ interface UseBasketReportReturn {
  */
 declare function useBasketReport(options?: RequestOptions): UseBasketReportReturn;
 //#endregion
-export { type MutationState, type QueryState, type UseBasketReportReturn, useBasketReport, useCategory, useConsumer, useDelete, useEmployee, useLogout, useMerchant, useProduct, useProductInstanceTags, useProductTags, usePromotion, useReport, useSession, useStore, useSubmit, useUpdateMerchant, useUploadImage, useUploadMerchantImage, useUser };
+export { type MutationState, type QueryState, type UseBasketReportReturn, useBasketReport, useCategory, useConsumer, useDelete, useEmployee, useLogout, useMerchant, useProduct, useProductComponent, useProductInstanceTags, useProductTags, usePromotion, useReport, useSession, useStore, useSubmit, useUpdateMerchant, useUploadImage, useUploadMerchantImage, useUser };
 //# sourceMappingURL=index.d.ts.map