@01.software/sdk 0.38.0 → 0.40.0

package/dist/query.cjs

@@ -30,7 +30,11 @@ __export(query_exports, {
   customerKeys: () => customerKeys,
   getQueryClient: () => getQueryClient,
   getStorefrontQueryClient: () => getStorefrontQueryClient,
-  productKeys: () => productKeys
+  prefetchInfiniteProductListingPage: () => prefetchInfiniteProductListingPage,
+  prefetchProductListingPage: () => prefetchProductListingPage,
+  productKeys: () => productKeys,
+  productListingPageInfiniteQueryOptions: () => productListingPageInfiniteQueryOptions,
+  productListingPageQueryOptions: () => productListingPageQueryOptions
 });
 module.exports = __toCommonJS(query_exports);
 
@@ -90,6 +94,49 @@ function getStorefrontQueryClient() {
 }
 
 // src/core/query/query-keys.ts
+function nonEmpty(values) {
+  return values?.length ? values : void 0;
+}
+function canonicalProductListingPageParams(params = {}, limit) {
+  const filters = params.filters;
+  const canonicalFilters = {};
+  const ids = nonEmpty(filters?.ids);
+  if (ids) canonicalFilters.ids = ids;
+  const slugs = nonEmpty(filters?.slugs);
+  if (slugs) canonicalFilters.slugs = slugs;
+  const handles = nonEmpty(filters?.handles);
+  if (handles) canonicalFilters.handles = handles;
+  const categoryIds = nonEmpty(filters?.categoryIds);
+  if (categoryIds) canonicalFilters.categoryIds = categoryIds;
+  const tagIds = nonEmpty(filters?.tagIds);
+  if (tagIds) canonicalFilters.tagIds = tagIds;
+  if (filters?.price?.min != null || filters?.price?.max != null) {
+    canonicalFilters.price = {
+      ...filters.price.min != null && { min: filters.price.min },
+      ...filters.price.max != null && { max: filters.price.max }
+    };
+  }
+  if (filters?.availableForSale != null) {
+    canonicalFilters.availableForSale = filters.availableForSale;
+  }
+  const search = params.search?.trim();
+  return {
+    mode: params.mode ?? "catalog",
+    ...params.page != null && { page: params.page },
+    ...limit != null ? { limit } : params.limit != null ? { limit: params.limit } : {},
+    ...search && { search },
+    ...params.sort != null && { sort: params.sort },
+    ...Object.keys(canonicalFilters).length > 0 && {
+      filters: canonicalFilters
+    },
+    ...params.basePath != null && { basePath: params.basePath },
+    ...params.trailingSlash != null && { trailingSlash: params.trailingSlash },
+    ...params.emit != null && { emit: params.emit },
+    ...params.preferCompleteVariantFromHint != null && {
+      preferCompleteVariantFromHint: params.preferCompleteVariantFromHint
+    }
+  };
+}
 function collectionKeys(collection) {
   return {
     all: [collection],
@@ -98,7 +145,11 @@ function collectionKeys(collection) {
     details: () => [collection, "detail"],
     detail: (id, options) => [collection, "detail", id, options],
     infinites: () => [collection, "infinite"],
-    infinite: (options) => [collection, "infinite", options]
+    infinite: (options, pageSize) => [
+      collection,
+      "infinite",
+      pageSize === void 0 ? options : { ...options, limit: pageSize }
+    ]
   };
 }
 var customerKeys = {
@@ -108,8 +159,29 @@ var customerKeys = {
 var productKeys = {
   listingGroups: (options) => ["products", "listing-groups", "list", options],
   listingGroupsCatalog: (options) => ["products", "listing-groups", "catalog", options],
-  listingGroupsInfinite: (options) => ["products", "listing-groups", "infinite", options],
-  listingGroupsCatalogInfinite: (options) => ["products", "listing-groups", "catalog", "infinite", options],
+  listingGroupsInfinite: (options, pageSize) => [
+    "products",
+    "listing-groups",
+    "infinite",
+    pageSize === void 0 ? options : { ...options, limit: pageSize }
+  ],
+  listingGroupsCatalogInfinite: (options, pageSize) => [
+    "products",
+    "listing-groups",
+    "catalog",
+    "infinite",
+    pageSize === void 0 ? options : { ...options, limit: pageSize }
+  ],
+  listingPage: (params) => ["products", "listing-page", canonicalProductListingPageParams(params)],
+  listingPageInfinite: (params, pageSize) => [
+    "products",
+    "listing-page",
+    "infinite",
+    canonicalProductListingPageParams(
+      params,
+      pageSize
+    )
+  ],
   detail: (params) => ["products", "detail", params],
   detailAll: () => ["products", "detail"]
 };
@@ -190,13 +262,14 @@ var CollectionHooks = class {
   }
   // ===== useInfiniteQuery =====
   useInfiniteQuery(params, options) {
-    const {
-      collection,
-      options: queryOptions,
-      pageSize = DEFAULT_PAGE_SIZE
-    } = params;
+    const { collection, options: queryOptions } = params;
+    const explicitPageSize = params.pageSize;
+    const pageSize = explicitPageSize ?? DEFAULT_PAGE_SIZE;
     return (0, import_react_query2.useInfiniteQuery)({
-      queryKey: collectionKeys(collection).infinite(queryOptions),
+      queryKey: collectionKeys(collection).infinite(
+        queryOptions,
+        explicitPageSize
+      ),
       queryFn: async ({ pageParam }) => {
         const response = await this.collectionClient.from(collection).find({ ...queryOptions, page: pageParam, limit: pageSize });
         return response;
@@ -210,13 +283,14 @@ var CollectionHooks = class {
   }
   // ===== useSuspenseInfiniteQuery =====
   useSuspenseInfiniteQuery(params, options) {
-    const {
-      collection,
-      options: queryOptions,
-      pageSize = DEFAULT_PAGE_SIZE
-    } = params;
+    const { collection, options: queryOptions } = params;
+    const explicitPageSize = params.pageSize;
+    const pageSize = explicitPageSize ?? DEFAULT_PAGE_SIZE;
     return (0, import_react_query2.useSuspenseInfiniteQuery)({
-      queryKey: collectionKeys(collection).infinite(queryOptions),
+      queryKey: collectionKeys(collection).infinite(
+        queryOptions,
+        explicitPageSize
+      ),
       queryFn: async ({ pageParam }) => {
         const response = await this.collectionClient.from(collection).find({ ...queryOptions, page: pageParam, limit: pageSize });
         return response;
@@ -252,13 +326,14 @@ var CollectionHooks = class {
   }
   // ===== prefetchInfiniteQuery =====
   async prefetchInfiniteQuery(params, options) {
-    const {
-      collection,
-      options: queryOptions,
-      pageSize = DEFAULT_PAGE_SIZE
-    } = params;
+    const { collection, options: queryOptions } = params;
+    const explicitPageSize = params.pageSize;
+    const pageSize = explicitPageSize ?? DEFAULT_PAGE_SIZE;
     return this.queryClient.prefetchInfiniteQuery({
-      queryKey: collectionKeys(collection).infinite(queryOptions),
+      queryKey: collectionKeys(collection).infinite(
+        queryOptions,
+        explicitPageSize
+      ),
       queryFn: async ({ pageParam }) => {
         const response = await this.collectionClient.from(collection).find({ ...queryOptions, page: pageParam, limit: pageSize });
         return response;
@@ -559,6 +634,50 @@ function fetchProductListingGroupsCatalogQuery(collectionClient, queryOptions) {
     listingGroupsQueryCatalogUrl(queryOptions)
   );
 }
+function productListingPageQueryOptions(commerceClient, params = {}) {
+  return {
+    queryKey: productKeys.listingPage(params),
+    queryFn: () => commerceClient.product.listingPage(params)
+  };
+}
+function productListingPageInfiniteQueryOptions(commerceClient, params = {}) {
+  const {
+    pageSize: explicitPageSize,
+    page: _page,
+    limit: _limit,
+    ...pageParams
+  } = params;
+  const pageSize = explicitPageSize ?? 20;
+  return {
+    queryKey: productKeys.listingPageInfinite(pageParams, explicitPageSize),
+    queryFn: ({ pageParam }) => commerceClient.product.listingPage({
+      ...pageParams,
+      page: pageParam,
+      limit: pageSize
+    }),
+    initialPageParam: 1,
+    getNextPageParam: (lastPage) => lastPage.hasNextPage ? lastPage.nextPage : void 0
+  };
+}
+function prefetchProductListingPage(queryClient, commerceClient, params = {}, options) {
+  return queryClient.prefetchQuery({
+    ...productListingPageQueryOptions(
+      commerceClient,
+      params
+    ),
+    ...options
+  });
+}
+function prefetchInfiniteProductListingPage(queryClient, commerceClient, params = {}, options) {
+  return queryClient.prefetchInfiniteQuery({
+    ...productListingPageInfiniteQueryOptions(
+      commerceClient,
+      params
+    ),
+    pages: options?.pages ?? 1,
+    staleTime: options?.staleTime
+  });
+}
 var QueryHooks = class extends CollectionHooks {
   constructor(queryClient, collectionClient, customerAuth, commerceClient) {
     super(queryClient, collectionClient);
@@ -579,6 +698,14 @@ var QueryHooks = class extends CollectionHooks {
     this._customer = new CustomerHooks(queryClient, customerAuth);
     this._commerce = commerceClient;
   }
+  ensureCommerce() {
+    if (!this._commerce) {
+      throw createConfigError(
+        "Product listing page hooks require Client or ServerClient. Use createQueryHooks(client) or createServerQueryHooks(server) instead of constructing QueryHooks directly."
+      );
+    }
+    return this._commerce;
+  }
   useProductListingGroupsQuery(params, options) {
     const queryOptions = params.options;
     const { placeholderData, ...restOptions } = options ?? {};
@@ -626,12 +753,14 @@ var QueryHooks = class extends CollectionHooks {
     });
   }
   useInfiniteProductListingGroupsQuery(params, options) {
-    const {
-      options: queryOptions,
-      pageSize = 20
-    } = params;
+    const { options: queryOptions } = params;
+    const explicitPageSize = params.pageSize;
+    const pageSize = explicitPageSize ?? 20;
     return (0, import_react_query4.useInfiniteQuery)({
-      queryKey: productKeys.listingGroupsInfinite(queryOptions),
+      queryKey: productKeys.listingGroupsInfinite(
+        queryOptions,
+        explicitPageSize
+      ),
       queryFn: async ({ pageParam }) => fetchProductListingGroupsQuery(this.collectionClient, {
         ...queryOptions,
         page: pageParam,
@@ -643,12 +772,14 @@ var QueryHooks = class extends CollectionHooks {
     });
   }
   useInfiniteProductListingGroupsCatalogQuery(params, options) {
-    const {
-      options: queryOptions,
-      pageSize = 20
-    } = params;
+    const { options: queryOptions } = params;
+    const explicitPageSize = params.pageSize;
+    const pageSize = explicitPageSize ?? 20;
     return (0, import_react_query4.useInfiniteQuery)({
-      queryKey: productKeys.listingGroupsCatalogInfinite(queryOptions),
+      queryKey: productKeys.listingGroupsCatalogInfinite(
+        queryOptions,
+        explicitPageSize
+      ),
       queryFn: async ({ pageParam }) => fetchProductListingGroupsCatalogQuery(this.collectionClient, {
         ...queryOptions,
         page: pageParam,
@@ -660,12 +791,14 @@ var QueryHooks = class extends CollectionHooks {
     });
   }
   useSuspenseInfiniteProductListingGroupsQuery(params, options) {
-    const {
-      options: queryOptions,
-      pageSize = 20
-    } = params;
+    const { options: queryOptions } = params;
+    const explicitPageSize = params.pageSize;
+    const pageSize = explicitPageSize ?? 20;
     return (0, import_react_query4.useSuspenseInfiniteQuery)({
-      queryKey: productKeys.listingGroupsInfinite(queryOptions),
+      queryKey: productKeys.listingGroupsInfinite(
+        queryOptions,
+        explicitPageSize
+      ),
       queryFn: async ({ pageParam }) => fetchProductListingGroupsQuery(this.collectionClient, {
         ...queryOptions,
         page: pageParam,
@@ -677,12 +810,14 @@ var QueryHooks = class extends CollectionHooks {
     });
   }
   useSuspenseInfiniteProductListingGroupsCatalogQuery(params, options) {
-    const {
-      options: queryOptions,
-      pageSize = 20
-    } = params;
+    const { options: queryOptions } = params;
+    const explicitPageSize = params.pageSize;
+    const pageSize = explicitPageSize ?? 20;
     return (0, import_react_query4.useSuspenseInfiniteQuery)({
-      queryKey: productKeys.listingGroupsCatalogInfinite(queryOptions),
+      queryKey: productKeys.listingGroupsCatalogInfinite(
+        queryOptions,
+        explicitPageSize
+      ),
       queryFn: async ({ pageParam }) => fetchProductListingGroupsCatalogQuery(this.collectionClient, {
         ...queryOptions,
         page: pageParam,
@@ -713,12 +848,14 @@ var QueryHooks = class extends CollectionHooks {
     });
   }
   async prefetchInfiniteProductListingGroupsQuery(params, options) {
-    const {
-      options: queryOptions,
-      pageSize = 20
-    } = params;
+    const { options: queryOptions } = params;
+    const explicitPageSize = params.pageSize;
+    const pageSize = explicitPageSize ?? 20;
     return this.queryClient.prefetchInfiniteQuery({
-      queryKey: productKeys.listingGroupsInfinite(queryOptions),
+      queryKey: productKeys.listingGroupsInfinite(
+        queryOptions,
+        explicitPageSize
+      ),
       queryFn: async ({ pageParam }) => fetchProductListingGroupsQuery(this.collectionClient, {
         ...queryOptions,
         page: pageParam,
@@ -731,12 +868,14 @@ var QueryHooks = class extends CollectionHooks {
     });
   }
   async prefetchInfiniteProductListingGroupsCatalogQuery(params, options) {
-    const {
-      options: queryOptions,
-      pageSize = 20
-    } = params;
+    const { options: queryOptions } = params;
+    const explicitPageSize = params.pageSize;
+    const pageSize = explicitPageSize ?? 20;
     return this.queryClient.prefetchInfiniteQuery({
-      queryKey: productKeys.listingGroupsCatalogInfinite(queryOptions),
+      queryKey: productKeys.listingGroupsCatalogInfinite(
+        queryOptions,
+        explicitPageSize
+      ),
       queryFn: async ({ pageParam }) => fetchProductListingGroupsCatalogQuery(this.collectionClient, {
         ...queryOptions,
         page: pageParam,
@@ -748,6 +887,45 @@ var QueryHooks = class extends CollectionHooks {
       staleTime: options?.staleTime
     });
   }
+  useProductListingPage(params = {}, options) {
+    const { placeholderData, ...restOptions } = options ?? {};
+    return (0, import_react_query4.useQuery)({
+      ...productListingPageQueryOptions(this.ensureCommerce(), params),
+      ...restOptions,
+      ...placeholderData !== void 0 && {
+        placeholderData
+      }
+    });
+  }
+  useSuspenseProductListingPage(params = {}, options) {
+    const suspenseOptions = options;
+    return (0, import_react_query4.useSuspenseQuery)({
+      ...productListingPageQueryOptions(this.ensureCommerce(), params),
+      ...suspenseOptions
+    });
+  }
+  useInfiniteProductListingPage(params = {}, options) {
+    return (0, import_react_query4.useInfiniteQuery)({
+      ...productListingPageInfiniteQueryOptions(this.ensureCommerce(), params),
+      ...options
+    });
+  }
+  async prefetchProductListingPage(params = {}, options) {
+    return prefetchProductListingPage(
+      this.queryClient,
+      this.ensureCommerce(),
+      params,
+      options
+    );
+  }
+  async prefetchInfiniteProductListingPage(params = {}, options) {
+    return prefetchInfiniteProductListingPage(
+      this.queryClient,
+      this.ensureCommerce(),
+      params,
+      options
+    );
+  }
   useProductDetail(params, options) {
     const discriminator = "slug" in params ? params.slug : params.id;
     const { enabled, ...restOptions } = options ?? {};
@@ -939,12 +1117,17 @@ function createReadOnlyQueryHooksFacade(hooks) {
     invalidateCustomerQueries: hooks.invalidateCustomerQueries.bind(hooks),
     getCustomerData: hooks.getCustomerData.bind(hooks),
     setCustomerData: hooks.setCustomerData.bind(hooks),
-    useProductListingGroupsQuery: hooks.useProductListingGroupsQuery.bind(hooks),
-    useSuspenseProductListingGroupsQuery: hooks.useSuspenseProductListingGroupsQuery.bind(hooks),
-    useInfiniteProductListingGroupsQuery: hooks.useInfiniteProductListingGroupsQuery.bind(hooks),
-    useSuspenseInfiniteProductListingGroupsQuery: hooks.useSuspenseInfiniteProductListingGroupsQuery.bind(hooks),
-    prefetchProductListingGroupsQuery: hooks.prefetchProductListingGroupsQuery.bind(hooks),
-    prefetchInfiniteProductListingGroupsQuery: hooks.prefetchInfiniteProductListingGroupsQuery.bind(hooks),
+    useProductListingGroupsCatalogQuery: hooks.useProductListingGroupsCatalogQuery.bind(hooks),
+    useSuspenseProductListingGroupsCatalogQuery: hooks.useSuspenseProductListingGroupsCatalogQuery.bind(hooks),
+    useInfiniteProductListingGroupsCatalogQuery: hooks.useInfiniteProductListingGroupsCatalogQuery.bind(hooks),
+    useSuspenseInfiniteProductListingGroupsCatalogQuery: hooks.useSuspenseInfiniteProductListingGroupsCatalogQuery.bind(hooks),
+    prefetchProductListingGroupsCatalogQuery: hooks.prefetchProductListingGroupsCatalogQuery.bind(hooks),
+    prefetchInfiniteProductListingGroupsCatalogQuery: hooks.prefetchInfiniteProductListingGroupsCatalogQuery.bind(hooks),
+    useProductListingPage: hooks.useProductListingPage.bind(hooks),
+    useSuspenseProductListingPage: hooks.useSuspenseProductListingPage.bind(hooks),
+    useInfiniteProductListingPage: hooks.useInfiniteProductListingPage.bind(hooks),
+    prefetchProductListingPage: hooks.prefetchProductListingPage.bind(hooks),
+    prefetchInfiniteProductListingPage: hooks.prefetchInfiniteProductListingPage.bind(hooks),
     useProductDetail: hooks.useProductDetail.bind(hooks),
     useProductDetailBySlug: hooks.useProductDetailBySlug.bind(hooks),
     useProductDetailById: hooks.useProductDetailById.bind(hooks)