@reactionary/core 0.1.5 → 0.1.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactionary/core",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "main": "index.js",
   "types": "src/index.d.ts",
   "dependencies": {

package/schemas/models/identifiers.model.js

@@ -26,12 +26,6 @@ const ProductOptionValueIdentifierSchema = z.looseObject({
 const ProductIdentifierSchema = z.looseObject({
   key: z.string()
 });
-const ProductSearchIdentifierSchema = z.looseObject({
-  term: z.string(),
-  facets: z.array(FacetValueIdentifierSchema),
-  filters: z.array(z.string()),
-  paginationOptions: PaginationOptionsSchema
-});
 const CartIdentifierSchema = z.looseObject({
   key: z.string()
 });
@@ -89,6 +83,13 @@ const PaymentInstructionIdentifierSchema = z.looseObject({
 const PickupPointIdentifierSchema = z.looseObject({
   key: z.string()
 });
+const ProductSearchIdentifierSchema = z.looseObject({
+  term: z.string().describe("The search term used to find products."),
+  facets: z.array(FacetValueIdentifierSchema).describe("The facets applied to filter the search results."),
+  filters: z.array(z.string()).describe("Additional filters applied to the search results."),
+  paginationOptions: PaginationOptionsSchema.describe("Pagination options for the search results."),
+  categoryFilter: FacetValueIdentifierSchema.optional().describe("An optional category filter applied to the search results.")
+});
 export {
   AddressIdentifierSchema,
   CartIdentifierSchema,

package/schemas/queries/product-search.query.js

@@ -1,8 +1,14 @@
-import { BaseQuerySchema } from "./base.query.js";
+import { z } from "zod";
+import { CategorySchema } from "../models/category.model.js";
 import { ProductSearchIdentifierSchema } from "../models/identifiers.model.js";
+import { BaseQuerySchema } from "./base.query.js";
 const ProductSearchQueryByTermSchema = BaseQuerySchema.extend({
   search: ProductSearchIdentifierSchema
 });
+const ProductSearchQueryCreateNavigationFilterSchema = z.looseObject({
+  categoryPath: z.array(CategorySchema).describe("An array representing the breadcrumb path to a category, from root to the specific category.")
+}).describe("Payload to create a category navigation filter from a breadcrumb path.");
 export {
-  ProductSearchQueryByTermSchema
+  ProductSearchQueryByTermSchema,
+  ProductSearchQueryCreateNavigationFilterSchema
 };

package/src/providers/product-search.provider.d.ts

@@ -1,10 +1,29 @@
 import type { FacetIdentifier, FacetValueIdentifier } from '../index.js';
 import type { ProductSearchResult, ProductSearchResultFacet, ProductSearchResultFacetValue, ProductSearchResultItemVariant } from '../schemas/models/product-search.model.js';
-import type { ProductSearchQueryByTerm } from '../schemas/queries/product-search.query.js';
+import type { ProductSearchQueryByTerm, ProductSearchQueryCreateNavigationFilter } from '../schemas/queries/product-search.query.js';
 import { BaseProvider } from './base.provider.js';
 export declare abstract class ProductSearchProvider extends BaseProvider {
     protected getResourceName(): string;
     abstract queryByTerm(payload: ProductSearchQueryByTerm): Promise<ProductSearchResult>;
+    /**
+     * Since each platform has it own way of representing categories and their hierarchy, we leave it to the platform to tell us how to get from a
+     * category breadcrumb path to a global category navigation filter that can be applied to product searches.
+     *
+     * So, the CLP pattern would be
+     *
+     * const c: Category = await categoryProvider.getBySlug({ slug: 'some-category' });
+     * const breadcrumbPath: Category[] = await categoryProvider.getBreadcrumbPathToCategory({ id: c.identifier });
+     * const categoryFilter: FacetValueIdentifier = categoryNavigationProvider.createCategoryNavigationFilterBreadcrumbs(breadcrumbPath);
+     * const searchResult: ProductSearchResult = await productSearchProvider.queryByTerm({ term: 'some search', facets: [], categoryFilter: [categoryFilter], ... });
+     *
+     * from here, you would maybe get facets back with subcategories, but those are relative to the current category filter you have applied, so you
+     * do not need any special handling for that.
+     *
+     * Usecase: You are rendering a category page and you want to run a product search to find everything in that category (or below).
+     *
+     * @param categoryPath
+     */
+    abstract createCategoryNavigationFilter(payload: ProductSearchQueryCreateNavigationFilter): Promise<FacetValueIdentifier>;
     /**
      * Parses a facet value from the search response.
      * @param facetValueIdentifier The identifier for the facet value.

package/src/schemas/models/identifiers.model.d.ts

@@ -30,20 +30,6 @@ export declare const ProductOptionValueIdentifierSchema: z.ZodObject<{
 export declare const ProductIdentifierSchema: z.ZodObject<{
     key: z.ZodString;
 }, z.core.$loose>;
-export declare const ProductSearchIdentifierSchema: z.ZodObject<{
-    term: z.ZodString;
-    facets: z.ZodArray<z.ZodObject<{
-        facet: z.ZodObject<{
-            key: z.ZodString;
-        }, z.core.$loose>;
-        key: z.ZodString;
-    }, z.core.$strip>>;
-    filters: z.ZodArray<z.ZodString>;
-    paginationOptions: z.ZodObject<{
-        pageNumber: z.ZodDefault<z.ZodNumber>;
-        pageSize: z.ZodDefault<z.ZodNumber>;
-    }, z.core.$loose>;
-}, z.core.$loose>;
 export declare const CartIdentifierSchema: z.ZodObject<{
     key: z.ZodString;
 }, z.core.$loose>;
@@ -110,6 +96,26 @@ export declare const PaymentInstructionIdentifierSchema: z.ZodObject<{
 export declare const PickupPointIdentifierSchema: z.ZodObject<{
     key: z.ZodString;
 }, z.core.$loose>;
+export declare const ProductSearchIdentifierSchema: z.ZodObject<{
+    term: z.ZodString;
+    facets: z.ZodArray<z.ZodObject<{
+        facet: z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>;
+        key: z.ZodString;
+    }, z.core.$strip>>;
+    filters: z.ZodArray<z.ZodString>;
+    paginationOptions: z.ZodObject<{
+        pageNumber: z.ZodDefault<z.ZodNumber>;
+        pageSize: z.ZodDefault<z.ZodNumber>;
+    }, z.core.$loose>;
+    categoryFilter: z.ZodOptional<z.ZodObject<{
+        facet: z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>;
+        key: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$loose>;
 export type ProductIdentifier = InferType<typeof ProductIdentifierSchema>;
 export type ProductVariantIdentifier = InferType<typeof ProductVariantIdentifierSchema>;
 export type SearchIdentifier = InferType<typeof ProductSearchIdentifierSchema>;

package/src/schemas/models/product-search.model.d.ts

@@ -159,6 +159,12 @@ export declare const ProductSearchResultSchema: z.ZodObject<{
             pageNumber: z.ZodDefault<z.ZodNumber>;
             pageSize: z.ZodDefault<z.ZodNumber>;
         }, z.core.$loose>;
+        categoryFilter: z.ZodOptional<z.ZodObject<{
+            facet: z.ZodObject<{
+                key: z.ZodString;
+            }, z.core.$loose>;
+            key: z.ZodString;
+        }, z.core.$strip>>;
     }, z.core.$loose>;
     facets: z.ZodArray<z.ZodObject<{
         identifier: z.ZodObject<{

package/src/schemas/mutations/analytics.mutation.d.ts

@@ -15,6 +15,12 @@ export declare const AnalyticsMutationSearchEventSchema: z.ZodObject<{
             pageNumber: z.ZodDefault<z.ZodNumber>;
             pageSize: z.ZodDefault<z.ZodNumber>;
         }, z.core.$loose>;
+        categoryFilter: z.ZodOptional<z.ZodObject<{
+            facet: z.ZodObject<{
+                key: z.ZodString;
+            }, z.core.$loose>;
+            key: z.ZodString;
+        }, z.core.$strip>>;
     }, z.core.$loose>;
     products: z.ZodArray<z.ZodObject<{
         key: z.ZodString;
@@ -35,6 +41,12 @@ export declare const AnalyticsMutationSearchProductClickEventSchema: z.ZodObject
             pageNumber: z.ZodDefault<z.ZodNumber>;
             pageSize: z.ZodDefault<z.ZodNumber>;
         }, z.core.$loose>;
+        categoryFilter: z.ZodOptional<z.ZodObject<{
+            facet: z.ZodObject<{
+                key: z.ZodString;
+            }, z.core.$loose>;
+            key: z.ZodString;
+        }, z.core.$strip>>;
     }, z.core.$loose>;
     product: z.ZodObject<{
         key: z.ZodString;
@@ -56,6 +68,12 @@ export declare const AnalyticsMutationSchema: z.ZodUnion<readonly [z.ZodObject<{
             pageNumber: z.ZodDefault<z.ZodNumber>;
             pageSize: z.ZodDefault<z.ZodNumber>;
         }, z.core.$loose>;
+        categoryFilter: z.ZodOptional<z.ZodObject<{
+            facet: z.ZodObject<{
+                key: z.ZodString;
+            }, z.core.$loose>;
+            key: z.ZodString;
+        }, z.core.$strip>>;
     }, z.core.$loose>;
     products: z.ZodArray<z.ZodObject<{
         key: z.ZodString;
@@ -75,6 +93,12 @@ export declare const AnalyticsMutationSchema: z.ZodUnion<readonly [z.ZodObject<{
             pageNumber: z.ZodDefault<z.ZodNumber>;
             pageSize: z.ZodDefault<z.ZodNumber>;
         }, z.core.$loose>;
+        categoryFilter: z.ZodOptional<z.ZodObject<{
+            facet: z.ZodObject<{
+                key: z.ZodString;
+            }, z.core.$loose>;
+            key: z.ZodString;
+        }, z.core.$strip>>;
     }, z.core.$loose>;
     product: z.ZodObject<{
         key: z.ZodString;

package/src/schemas/queries/product-search.query.d.ts

@@ -1,4 +1,4 @@
-import type { z } from 'zod';
+import { z } from 'zod';
 import type { InferType } from '../../zod-utils.js';
 export declare const ProductSearchQueryByTermSchema: z.ZodObject<{
     search: z.ZodObject<{
@@ -14,6 +14,39 @@ export declare const ProductSearchQueryByTermSchema: z.ZodObject<{
             pageNumber: z.ZodDefault<z.ZodNumber>;
             pageSize: z.ZodDefault<z.ZodNumber>;
         }, z.core.$loose>;
+        categoryFilter: z.ZodOptional<z.ZodObject<{
+            facet: z.ZodObject<{
+                key: z.ZodString;
+            }, z.core.$loose>;
+            key: z.ZodString;
+        }, z.core.$strip>>;
     }, z.core.$loose>;
 }, z.core.$loose>;
+export declare const ProductSearchQueryCreateNavigationFilterSchema: z.ZodObject<{
+    categoryPath: z.ZodArray<z.ZodObject<{
+        meta: z.ZodDefault<z.ZodObject<{
+            cache: z.ZodDefault<z.ZodObject<{
+                hit: z.ZodDefault<z.ZodBoolean>;
+                key: z.ZodDefault<z.ZodString>;
+            }, z.core.$loose>>;
+            placeholder: z.ZodDefault<z.ZodBoolean>;
+        }, z.core.$loose>>;
+        identifier: z.ZodDefault<z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>>;
+        name: z.ZodDefault<z.ZodString>;
+        slug: z.ZodDefault<z.ZodString>;
+        text: z.ZodDefault<z.ZodString>;
+        images: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            sourceUrl: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+            altText: z.ZodNonOptional<z.ZodDefault<z.ZodString>>;
+            width: z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>;
+            height: z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>;
+        }, z.core.$loose>>>;
+        parentCategory: z.ZodOptional<z.ZodObject<{
+            key: z.ZodString;
+        }, z.core.$loose>>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
 export type ProductSearchQueryByTerm = InferType<typeof ProductSearchQueryByTermSchema>;
+export type ProductSearchQueryCreateNavigationFilter = InferType<typeof ProductSearchQueryCreateNavigationFilterSchema>;