@viu/emporix-sdk-react 2.2.0 → 2.3.0

package/dist/hooks.d.cts

@@ -1,4 +1,4 @@
-import { Customer, AuthContext, Product, PaginatedItems, Category, CategoryNode, Cart, CartItemInput, CartItemUpdate, CartAddress, CartCreated, CreateCartInput, CheckoutResult, CheckoutInput, QuoteCheckoutInput, PaymentMode, PriceMatchByContextInput, PriceMatch, Media, SegmentCategoryTree, SegmentItem, Segment, PasswordChangeInput, CustomerUpdateInput, Address, AddressCreateInput, AddressUpdateInput, PasswordResetRequestInput, PasswordResetConfirmInput, Site, LegalEntity, ContactAssignment, Location, IamGroup, ContactAssignmentCreate, LegalEntityCreate, LocationCreate, LegalEntityUpdate, ContactAssignmentUpdate, LocationUpdate, OrderStatus, Order, SalesOrderPatch, Availability } from '@viu/emporix-sdk';
+import { Customer, AuthContext, Product, PaginatedItems, ShoppingListItem, ShoppingListDraft, ShoppingList, Category, CategoryNode, Cart, CartItemInput, CartItemUpdate, CartAddress, CartCreated, CreateCartInput, CheckoutResult, CheckoutInput, QuoteCheckoutInput, PaymentMode, PriceMatchByContextInput, PriceMatch, Media, SegmentCategoryTree, SegmentItem, Segment, PasswordChangeInput, CustomerUpdateInput, Address, AddressCreateInput, AddressUpdateInput, PasswordResetRequestInput, PasswordResetConfirmInput, Site, LegalEntity, ContactAssignment, Location, IamGroup, ContactAssignmentCreate, LegalEntityCreate, LocationCreate, LegalEntityUpdate, ContactAssignmentUpdate, LocationUpdate, OrderStatus, Order, SalesOrderPatch, Availability } from '@viu/emporix-sdk';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseQueryResult, UseInfiniteQueryResult, UseMutationResult } from '@tanstack/react-query';
 import { S as SiteContextValue } from './provider-BhvQWnnh.cjs';
@@ -81,6 +81,39 @@ declare function useProductsByCodes(codes: string[], options?: {
     chunkSize?: number;
 } & QueryOpts): UseQueryResult<Product[]>;
 
+/** The caller's shopping lists (customer-only). Optionally filtered by name. */
+declare function useShoppingLists(opts?: {
+    name?: string;
+}): UseQueryResult<ShoppingList[]>;
+/** Create a shopping list. */
+declare function useCreateShoppingList(): UseMutationResult<{
+    id: string;
+}, unknown, ShoppingListDraft>;
+/** Delete a named list (or all the customer's lists when `name` is omitted). */
+declare function useDeleteShoppingList(): UseMutationResult<void, unknown, {
+    customerId: string;
+    name?: string;
+}>;
+/** Add/replace an item in a list. */
+declare function useAddToShoppingList(): UseMutationResult<void, unknown, {
+    customerId: string;
+    listName: string;
+    item: ShoppingListItem;
+}>;
+/** Remove an item from a list by productId. */
+declare function useRemoveFromShoppingList(): UseMutationResult<void, unknown, {
+    customerId: string;
+    listName: string;
+    productId: string;
+}>;
+/** Set an item's quantity (0 removes it). */
+declare function useSetShoppingListItemQuantity(): UseMutationResult<void, unknown, {
+    customerId: string;
+    listName: string;
+    productId: string;
+    quantity: number;
+}>;
+
 type UseVariantChildrenOptions = QueryOpts & {
     pageSize?: number;
 };
@@ -579,4 +612,4 @@ interface UseAvailabilitiesOptions {
  */
 declare function useAvailabilities(productIds: string[], siteCode: string, options?: UseAvailabilitiesOptions): UseQueryResult<Availability[]>;
 
-export { type AddressMutationsApi, type CartMutationsApi, type CheckoutApi, type CompanySwitcherApi, type CustomerSessionApi, type PasswordResetApi, type UseAvailabilitiesOptions, type UseAvailabilityOptions, type UseCancelOrderVars, type UseMyOrdersInfiniteOptions, type UseMyOrdersOptions, type UseOrderOptions, type UseOrderTransitionVars, type UseReorderResult, type UseReorderVars, type UseUpdateSalesOrderVars, type UseVariantChildrenOptions, useActiveCart, useAddressMutations, useAssignContact, useAvailabilities, useAvailability, useCancelOrder, useCart, useCartMutations, useCategories, useCategoriesInfinite, useCategory, useCategoryTree, useChangePassword, useCheckout, useCompany, useCompanyContacts, useCompanyGroups, useCompanyLocations, useCompanySwitcher, useCreateCart, useCreateCompany, useCreateLocation, useCustomerAddresses, useCustomerSession, useDefaultSite, useDeleteCompany, useDeleteLocation, useMatchPrices, useMatchPricesChunked, useMyCompanies, useMyOrders, useMyOrdersInfinite, useMySegmentCategories, useMySegmentCategoriesInfinite, useMySegmentCategoryTree, useMySegmentItems, useMySegmentProducts, useMySegmentProductsInfinite, useMySegments, useOrder, useOrderTransition, usePasswordReset, usePaymentModes, useProduct, useProductByCode, useProductMedia, useProductSearch, useProducts, useProductsByCodes, useProductsInCategory, useProductsInCategoryInfinite, useProductsInfinite, useReorder, useSalesOrder, useSiteContext, useSites, useUnassignContact, useUpdateCompany, useUpdateContactAssignment, useUpdateCustomer, useUpdateLocation, useUpdateSalesOrder, useVariantChildren };
+export { type AddressMutationsApi, type CartMutationsApi, type CheckoutApi, type CompanySwitcherApi, type CustomerSessionApi, type PasswordResetApi, type UseAvailabilitiesOptions, type UseAvailabilityOptions, type UseCancelOrderVars, type UseMyOrdersInfiniteOptions, type UseMyOrdersOptions, type UseOrderOptions, type UseOrderTransitionVars, type UseReorderResult, type UseReorderVars, type UseUpdateSalesOrderVars, type UseVariantChildrenOptions, useActiveCart, useAddToShoppingList, useAddressMutations, useAssignContact, useAvailabilities, useAvailability, useCancelOrder, useCart, useCartMutations, useCategories, useCategoriesInfinite, useCategory, useCategoryTree, useChangePassword, useCheckout, useCompany, useCompanyContacts, useCompanyGroups, useCompanyLocations, useCompanySwitcher, useCreateCart, useCreateCompany, useCreateLocation, useCreateShoppingList, useCustomerAddresses, useCustomerSession, useDefaultSite, useDeleteCompany, useDeleteLocation, useDeleteShoppingList, useMatchPrices, useMatchPricesChunked, useMyCompanies, useMyOrders, useMyOrdersInfinite, useMySegmentCategories, useMySegmentCategoriesInfinite, useMySegmentCategoryTree, useMySegmentItems, useMySegmentProducts, useMySegmentProductsInfinite, useMySegments, useOrder, useOrderTransition, usePasswordReset, usePaymentModes, useProduct, useProductByCode, useProductMedia, useProductSearch, useProducts, useProductsByCodes, useProductsInCategory, useProductsInCategoryInfinite, useProductsInfinite, useRemoveFromShoppingList, useReorder, useSalesOrder, useSetShoppingListItemQuantity, useShoppingLists, useSiteContext, useSites, useUnassignContact, useUpdateCompany, useUpdateContactAssignment, useUpdateCustomer, useUpdateLocation, useUpdateSalesOrder, useVariantChildren };

package/dist/hooks.d.ts

@@ -1,4 +1,4 @@
-import { Customer, AuthContext, Product, PaginatedItems, Category, CategoryNode, Cart, CartItemInput, CartItemUpdate, CartAddress, CartCreated, CreateCartInput, CheckoutResult, CheckoutInput, QuoteCheckoutInput, PaymentMode, PriceMatchByContextInput, PriceMatch, Media, SegmentCategoryTree, SegmentItem, Segment, PasswordChangeInput, CustomerUpdateInput, Address, AddressCreateInput, AddressUpdateInput, PasswordResetRequestInput, PasswordResetConfirmInput, Site, LegalEntity, ContactAssignment, Location, IamGroup, ContactAssignmentCreate, LegalEntityCreate, LocationCreate, LegalEntityUpdate, ContactAssignmentUpdate, LocationUpdate, OrderStatus, Order, SalesOrderPatch, Availability } from '@viu/emporix-sdk';
+import { Customer, AuthContext, Product, PaginatedItems, ShoppingListItem, ShoppingListDraft, ShoppingList, Category, CategoryNode, Cart, CartItemInput, CartItemUpdate, CartAddress, CartCreated, CreateCartInput, CheckoutResult, CheckoutInput, QuoteCheckoutInput, PaymentMode, PriceMatchByContextInput, PriceMatch, Media, SegmentCategoryTree, SegmentItem, Segment, PasswordChangeInput, CustomerUpdateInput, Address, AddressCreateInput, AddressUpdateInput, PasswordResetRequestInput, PasswordResetConfirmInput, Site, LegalEntity, ContactAssignment, Location, IamGroup, ContactAssignmentCreate, LegalEntityCreate, LocationCreate, LegalEntityUpdate, ContactAssignmentUpdate, LocationUpdate, OrderStatus, Order, SalesOrderPatch, Availability } from '@viu/emporix-sdk';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseQueryResult, UseInfiniteQueryResult, UseMutationResult } from '@tanstack/react-query';
 import { S as SiteContextValue } from './provider-fvcYdqqX.js';
@@ -81,6 +81,39 @@ declare function useProductsByCodes(codes: string[], options?: {
     chunkSize?: number;
 } & QueryOpts): UseQueryResult<Product[]>;
 
+/** The caller's shopping lists (customer-only). Optionally filtered by name. */
+declare function useShoppingLists(opts?: {
+    name?: string;
+}): UseQueryResult<ShoppingList[]>;
+/** Create a shopping list. */
+declare function useCreateShoppingList(): UseMutationResult<{
+    id: string;
+}, unknown, ShoppingListDraft>;
+/** Delete a named list (or all the customer's lists when `name` is omitted). */
+declare function useDeleteShoppingList(): UseMutationResult<void, unknown, {
+    customerId: string;
+    name?: string;
+}>;
+/** Add/replace an item in a list. */
+declare function useAddToShoppingList(): UseMutationResult<void, unknown, {
+    customerId: string;
+    listName: string;
+    item: ShoppingListItem;
+}>;
+/** Remove an item from a list by productId. */
+declare function useRemoveFromShoppingList(): UseMutationResult<void, unknown, {
+    customerId: string;
+    listName: string;
+    productId: string;
+}>;
+/** Set an item's quantity (0 removes it). */
+declare function useSetShoppingListItemQuantity(): UseMutationResult<void, unknown, {
+    customerId: string;
+    listName: string;
+    productId: string;
+    quantity: number;
+}>;
+
 type UseVariantChildrenOptions = QueryOpts & {
     pageSize?: number;
 };
@@ -579,4 +612,4 @@ interface UseAvailabilitiesOptions {
  */
 declare function useAvailabilities(productIds: string[], siteCode: string, options?: UseAvailabilitiesOptions): UseQueryResult<Availability[]>;
 
-export { type AddressMutationsApi, type CartMutationsApi, type CheckoutApi, type CompanySwitcherApi, type CustomerSessionApi, type PasswordResetApi, type UseAvailabilitiesOptions, type UseAvailabilityOptions, type UseCancelOrderVars, type UseMyOrdersInfiniteOptions, type UseMyOrdersOptions, type UseOrderOptions, type UseOrderTransitionVars, type UseReorderResult, type UseReorderVars, type UseUpdateSalesOrderVars, type UseVariantChildrenOptions, useActiveCart, useAddressMutations, useAssignContact, useAvailabilities, useAvailability, useCancelOrder, useCart, useCartMutations, useCategories, useCategoriesInfinite, useCategory, useCategoryTree, useChangePassword, useCheckout, useCompany, useCompanyContacts, useCompanyGroups, useCompanyLocations, useCompanySwitcher, useCreateCart, useCreateCompany, useCreateLocation, useCustomerAddresses, useCustomerSession, useDefaultSite, useDeleteCompany, useDeleteLocation, useMatchPrices, useMatchPricesChunked, useMyCompanies, useMyOrders, useMyOrdersInfinite, useMySegmentCategories, useMySegmentCategoriesInfinite, useMySegmentCategoryTree, useMySegmentItems, useMySegmentProducts, useMySegmentProductsInfinite, useMySegments, useOrder, useOrderTransition, usePasswordReset, usePaymentModes, useProduct, useProductByCode, useProductMedia, useProductSearch, useProducts, useProductsByCodes, useProductsInCategory, useProductsInCategoryInfinite, useProductsInfinite, useReorder, useSalesOrder, useSiteContext, useSites, useUnassignContact, useUpdateCompany, useUpdateContactAssignment, useUpdateCustomer, useUpdateLocation, useUpdateSalesOrder, useVariantChildren };
+export { type AddressMutationsApi, type CartMutationsApi, type CheckoutApi, type CompanySwitcherApi, type CustomerSessionApi, type PasswordResetApi, type UseAvailabilitiesOptions, type UseAvailabilityOptions, type UseCancelOrderVars, type UseMyOrdersInfiniteOptions, type UseMyOrdersOptions, type UseOrderOptions, type UseOrderTransitionVars, type UseReorderResult, type UseReorderVars, type UseUpdateSalesOrderVars, type UseVariantChildrenOptions, useActiveCart, useAddToShoppingList, useAddressMutations, useAssignContact, useAvailabilities, useAvailability, useCancelOrder, useCart, useCartMutations, useCategories, useCategoriesInfinite, useCategory, useCategoryTree, useChangePassword, useCheckout, useCompany, useCompanyContacts, useCompanyGroups, useCompanyLocations, useCompanySwitcher, useCreateCart, useCreateCompany, useCreateLocation, useCreateShoppingList, useCustomerAddresses, useCustomerSession, useDefaultSite, useDeleteCompany, useDeleteLocation, useDeleteShoppingList, useMatchPrices, useMatchPricesChunked, useMyCompanies, useMyOrders, useMyOrdersInfinite, useMySegmentCategories, useMySegmentCategoriesInfinite, useMySegmentCategoryTree, useMySegmentItems, useMySegmentProducts, useMySegmentProductsInfinite, useMySegments, useOrder, useOrderTransition, usePasswordReset, usePaymentModes, useProduct, useProductByCode, useProductMedia, useProductSearch, useProducts, useProductsByCodes, useProductsInCategory, useProductsInCategoryInfinite, useProductsInfinite, useRemoveFromShoppingList, useReorder, useSalesOrder, useSetShoppingListItemQuantity, useShoppingLists, useSiteContext, useSites, useUnassignContact, useUpdateCompany, useUpdateContactAssignment, useUpdateCustomer, useUpdateLocation, useUpdateSalesOrder, useVariantChildren };

package/dist/hooks.js

@@ -1,4 +1,4 @@
-export { useActiveCart, useAddressMutations, useAssignContact, useAvailabilities, useAvailability, useCancelOrder, useCart, useCartMutations, useCategories, useCategoriesInfinite, useCategory, useCategoryTree, useChangePassword, useCheckout, useCompany, useCompanyContacts, useCompanyGroups, useCompanyLocations, useCompanySwitcher, useCreateCart, useCreateCompany, useCreateLocation, useCustomerAddresses, useCustomerSession, useDefaultSite, useDeleteCompany, useDeleteLocation, useMatchPrices, useMatchPricesChunked, useMyCompanies, useMyOrders, useMyOrdersInfinite, useMySegmentCategories, useMySegmentCategoriesInfinite, useMySegmentCategoryTree, useMySegmentItems, useMySegmentProducts, useMySegmentProductsInfinite, useMySegments, useOrder, useOrderTransition, usePasswordReset, usePaymentModes, useProduct, useProductByCode, useProductMedia, useProductSearch, useProducts, useProductsByCodes, useProductsInCategory, useProductsInCategoryInfinite, useProductsInfinite, useReorder, useSalesOrder, useSiteContext, useSites, useUnassignContact, useUpdateCompany, useUpdateContactAssignment, useUpdateCustomer, useUpdateLocation, useUpdateSalesOrder, useVariantChildren } from './chunk-P6QTUYBT.js';
+export { useActiveCart, useAddToShoppingList, useAddressMutations, useAssignContact, useAvailabilities, useAvailability, useCancelOrder, useCart, useCartMutations, useCategories, useCategoriesInfinite, useCategory, useCategoryTree, useChangePassword, useCheckout, useCompany, useCompanyContacts, useCompanyGroups, useCompanyLocations, useCompanySwitcher, useCreateCart, useCreateCompany, useCreateLocation, useCreateShoppingList, useCustomerAddresses, useCustomerSession, useDefaultSite, useDeleteCompany, useDeleteLocation, useDeleteShoppingList, useMatchPrices, useMatchPricesChunked, useMyCompanies, useMyOrders, useMyOrdersInfinite, useMySegmentCategories, useMySegmentCategoriesInfinite, useMySegmentCategoryTree, useMySegmentItems, useMySegmentProducts, useMySegmentProductsInfinite, useMySegments, useOrder, useOrderTransition, usePasswordReset, usePaymentModes, useProduct, useProductByCode, useProductMedia, useProductSearch, useProducts, useProductsByCodes, useProductsInCategory, useProductsInCategoryInfinite, useProductsInfinite, useRemoveFromShoppingList, useReorder, useSalesOrder, useSetShoppingListItemQuantity, useShoppingLists, useSiteContext, useSites, useUnassignContact, useUpdateCompany, useUpdateContactAssignment, useUpdateCustomer, useUpdateLocation, useUpdateSalesOrder, useVariantChildren } from './chunk-AZDCAJLL.js';
 import './chunk-D43CSHK3.js';
 import './chunk-FBQY2N7S.js';
 //# sourceMappingURL=hooks.js.map

package/dist/index.cjs

@@ -950,6 +950,63 @@ function useProductsByCodes(codes, options = {}) {
     staleTime: 3e4
   });
 }
+var SHOPPING_LIST_STALE_TIME = 3e4;
+var INVALIDATE_KEY = ["emporix", "shopping-lists"];
+function useShoppingLists(opts = {}) {
+  const { client } = useEmporix();
+  const ctx = useCustomerOnlyCtx();
+  const { siteCode } = useReadSite();
+  return reactQuery.useQuery({
+    queryKey: emporixKey("shopping-lists", [opts.name ?? null], { tenant: client.tenant, authKind: ctx.kind, siteCode }),
+    queryFn: () => client.shoppingLists.list(ctx, opts),
+    staleTime: SHOPPING_LIST_STALE_TIME
+  });
+}
+function useCreateShoppingList() {
+  const { client } = useEmporix();
+  const ctx = useCustomerOnlyCtx();
+  const qc = reactQuery.useQueryClient();
+  return reactQuery.useMutation({
+    mutationFn: (draft) => client.shoppingLists.create(draft, ctx),
+    onSuccess: () => void qc.invalidateQueries({ queryKey: INVALIDATE_KEY })
+  });
+}
+function useDeleteShoppingList() {
+  const { client } = useEmporix();
+  const ctx = useCustomerOnlyCtx();
+  const qc = reactQuery.useQueryClient();
+  return reactQuery.useMutation({
+    mutationFn: ({ customerId, name }) => client.shoppingLists.delete(customerId, ctx, name !== void 0 ? { name } : {}),
+    onSuccess: () => void qc.invalidateQueries({ queryKey: INVALIDATE_KEY })
+  });
+}
+function useAddToShoppingList() {
+  const { client } = useEmporix();
+  const ctx = useCustomerOnlyCtx();
+  const qc = reactQuery.useQueryClient();
+  return reactQuery.useMutation({
+    mutationFn: ({ customerId, listName, item }) => client.shoppingLists.addItem(customerId, listName, item, ctx),
+    onSuccess: () => void qc.invalidateQueries({ queryKey: INVALIDATE_KEY })
+  });
+}
+function useRemoveFromShoppingList() {
+  const { client } = useEmporix();
+  const ctx = useCustomerOnlyCtx();
+  const qc = reactQuery.useQueryClient();
+  return reactQuery.useMutation({
+    mutationFn: ({ customerId, listName, productId }) => client.shoppingLists.removeItem(customerId, listName, productId, ctx),
+    onSuccess: () => void qc.invalidateQueries({ queryKey: INVALIDATE_KEY })
+  });
+}
+function useSetShoppingListItemQuantity() {
+  const { client } = useEmporix();
+  const ctx = useCustomerOnlyCtx();
+  const qc = reactQuery.useQueryClient();
+  return reactQuery.useMutation({
+    mutationFn: ({ customerId, listName, productId, quantity }) => client.shoppingLists.setItemQuantity(customerId, listName, productId, quantity, ctx),
+    onSuccess: () => void qc.invalidateQueries({ queryKey: INVALIDATE_KEY })
+  });
+}
 var VARIANT_CHILDREN_STALE_TIME = 6e4;
 function useVariantChildren(parentVariantId, options = {}) {
   const { client } = useEmporix();
@@ -1900,6 +1957,7 @@ exports.prefetchOrder = prefetchOrder;
 exports.prefetchProduct = prefetchProduct;
 exports.useActiveCart = useActiveCart;
 exports.useActiveCompany = useActiveCompany;
+exports.useAddToShoppingList = useAddToShoppingList;
 exports.useAddressMutations = useAddressMutations;
 exports.useAssignContact = useAssignContact;
 exports.useAvailabilities = useAvailabilities;
@@ -1921,11 +1979,13 @@ exports.useCompanySwitcher = useCompanySwitcher;
 exports.useCreateCart = useCreateCart;
 exports.useCreateCompany = useCreateCompany;
 exports.useCreateLocation = useCreateLocation;
+exports.useCreateShoppingList = useCreateShoppingList;
 exports.useCustomerAddresses = useCustomerAddresses;
 exports.useCustomerSession = useCustomerSession;
 exports.useDefaultSite = useDefaultSite;
 exports.useDeleteCompany = useDeleteCompany;
 exports.useDeleteLocation = useDeleteLocation;
+exports.useDeleteShoppingList = useDeleteShoppingList;
 exports.useEmporix = useEmporix;
 exports.useEmporixErrorHandler = useEmporixErrorHandler;
 exports.useEmporixTelemetry = useEmporixTelemetry;
@@ -1954,8 +2014,11 @@ exports.useProductsByCodes = useProductsByCodes;
 exports.useProductsInCategory = useProductsInCategory;
 exports.useProductsInCategoryInfinite = useProductsInCategoryInfinite;
 exports.useProductsInfinite = useProductsInfinite;
+exports.useRemoveFromShoppingList = useRemoveFromShoppingList;
 exports.useReorder = useReorder;
 exports.useSalesOrder = useSalesOrder;
+exports.useSetShoppingListItemQuantity = useSetShoppingListItemQuantity;
+exports.useShoppingLists = useShoppingLists;
 exports.useSiteContext = useSiteContext;
 exports.useSites = useSites;
 exports.useUnassignContact = useUnassignContact;