@reactionary/core 0.3.2 → 0.3.4

package/client/client-builder.js

@@ -3,6 +3,7 @@ import { MulticastAnalyticsProvider } from "../providers/analytics.provider.js";
 import {
   RequestContextSchema
 } from "../schemas/session.schema.js";
+import { MulticastProductRecommendationsProvider } from "../providers/product-recommendations.provider.js";
 class ClientBuilder {
   constructor(context) {
     this.factories = [];
@@ -30,6 +31,7 @@ class ClientBuilder {
       throw new Error("Invalid context: " + validatedContext.error);
     }
     const mergedAnalytics = [];
+    const mergedProductRecommendationsProviders = [];
     for (const factory of this.factories) {
       const provider = factory(sharedCache, this.context);
       client = {
@@ -39,10 +41,14 @@ class ClientBuilder {
       if (provider.analytics) {
         mergedAnalytics.push(provider.analytics);
       }
+      if (provider.productRecommendations) {
+        mergedProductRecommendationsProviders.push(provider.productRecommendations);
+      }
     }
     const completeClient = {
       ...client,
       analytics: new MulticastAnalyticsProvider(sharedCache, this.context, mergedAnalytics),
+      productRecommendations: new MulticastProductRecommendationsProvider(sharedCache, this.context, mergedProductRecommendationsProviders),
       cache: sharedCache
     };
     return completeClient;

package/package.json

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

package/providers/index.js

@@ -9,6 +9,8 @@ export * from "./price.provider.js";
 export * from "./product.provider.js";
 export * from "./profile.provider.js";
 export * from "./product-search.provider.js";
+export * from "./product-recommendations.provider.js";
+export * from "./product-associations.provider.js";
 export * from "./store.provider.js";
 export * from "./order.provider.js";
 export * from "./order-search.provider.js";

package/providers/product-associations.provider.js

@@ -0,0 +1,9 @@
+import { BaseProvider } from "./base.provider.js";
+class ProductAssociationsProvider extends BaseProvider {
+  getResourceName() {
+    return "product-associations";
+  }
+}
+export {
+  ProductAssociationsProvider
+};

package/providers/product-recommendations.provider.js

@@ -0,0 +1,129 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result)
+    __defProp(target, key, result);
+  return result;
+};
+import { Reactionary } from "../decorators/reactionary.decorator.js";
+import { success } from "../schemas/index.js";
+import { ProductRecommendationsQuerySchema } from "../schemas/queries/product-recommendations.query.js";
+import { BaseProvider } from "./base.provider.js";
+class ProductRecommendationsProvider extends BaseProvider {
+  /**
+   * returns a list of recommended products, based on the selected algorithm and the provided query parameters. The recommendations should be relevant to the product specified in the query, and can be personalized based on the customer segments or contexts provided. The provider should return a list of product variant identifiers that are recommended for the given product, which can then be used to fetch the full product details from the product provider if needed.
+   *   *
+   * Usecase:
+   *   - PDP - "Customers who viewed this product also viewed"
+   *   - Cart - "You might also like"
+   *   - Post-purchase - "Customers who bought this product also bought"
+   *   - Article page: "Products related to the product mentioned in this article"
+   * @param query
+   */
+  async getRecommendations(query) {
+    if (query.algorithm === "frequentlyBoughtTogether") {
+      return success(await this.getFrequentlyBoughtTogetherRecommendations(query));
+    }
+    if (query.algorithm === "similar") {
+      return success(await this.getSimilarProductsRecommendations(query));
+    }
+    if (query.algorithm === "related") {
+      return success(await this.getRelatedProductsRecommendations(query));
+    }
+    if (query.algorithm === "trendingInCategory") {
+      return success(await this.getTrendingInCategoryRecommendations(query));
+    }
+    if (query.algorithm === "popular") {
+      return success(await this.getPopularProductsRecommendations(query));
+    }
+    if (query.algorithm === "topPicks") {
+      return success(await this.getTopPicksProductsRecommendations(query));
+    }
+    if (query.algorithm === "alsoViewed") {
+      return success(await this.getAlsoViewedProductsRecommendations(query));
+    }
+    return success([]);
+  }
+  async getCollection(query) {
+    return success([]);
+  }
+  async getFrequentlyBoughtTogetherRecommendations(query) {
+    return [];
+  }
+  async getSimilarProductsRecommendations(query) {
+    return [];
+  }
+  async getTrendingInCategoryRecommendations(query) {
+    return [];
+  }
+  async getRelatedProductsRecommendations(query) {
+    return [];
+  }
+  async getPopularProductsRecommendations(query) {
+    return [];
+  }
+  async getTopPicksProductsRecommendations(query) {
+    return [];
+  }
+  async getAlsoViewedProductsRecommendations(query) {
+    return [];
+  }
+  getResourceName() {
+    return "product-recommendations";
+  }
+}
+class MulticastProductRecommendationsProvider extends ProductRecommendationsProvider {
+  constructor(cache, requestContext, providers) {
+    super(cache, requestContext);
+    this.providers = providers;
+  }
+  async getRecommendations(query) {
+    const output = [];
+    for (const provider of this.providers) {
+      const providerOutput = await provider.getRecommendations(query);
+      if (providerOutput.success) {
+        output.push(...providerOutput.value);
+      } else {
+        console.error(`Error from provider ${provider.constructor.name}:`, providerOutput.error);
+        return providerOutput;
+      }
+      if (output.length >= query.numberOfRecommendations) {
+        break;
+      }
+    }
+    return success(output.slice(0, query.numberOfRecommendations));
+  }
+  async getCollection(query) {
+    const output = [];
+    for (const provider of this.providers) {
+      const providerOutput = await provider.getCollection(query);
+      if (providerOutput.success) {
+        output.push(...providerOutput.value);
+      } else {
+        if (providerOutput.error.type === "NotFound") {
+          continue;
+        } else {
+          console.error(`Error from provider ${provider.constructor.name}:`, providerOutput.error);
+          return providerOutput;
+        }
+      }
+      if (output.length >= query.numberOfRecommendations) {
+        break;
+      }
+    }
+    return success(output.slice(0, query.numberOfRecommendations));
+  }
+}
+__decorateClass([
+  Reactionary({
+    inputSchema: ProductRecommendationsQuerySchema
+  })
+], MulticastProductRecommendationsProvider.prototype, "getRecommendations", 1);
+export {
+  MulticastProductRecommendationsProvider,
+  ProductRecommendationsProvider
+};

package/schemas/capabilities.schema.js

@@ -2,6 +2,8 @@ import { z } from "zod";
 const CapabilitiesSchema = z.looseObject({
   product: z.boolean(),
   productSearch: z.boolean(),
+  productAssociations: z.boolean(),
+  productRecommendations: z.boolean(),
   analytics: z.boolean(),
   identity: z.boolean(),
   cart: z.boolean(),

package/schemas/models/identifiers.model.js

@@ -85,6 +85,10 @@ const PaymentInstructionIdentifierSchema = z.looseObject({
 const PickupPointIdentifierSchema = z.looseObject({
   key: z.string()
 });
+const ProductRecommendationIdentifierSchema = z.looseObject({
+  key: z.string(),
+  algorithm: 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."),
@@ -128,6 +132,7 @@ export {
   ProductIdentifierSchema,
   ProductOptionIdentifierSchema,
   ProductOptionValueIdentifierSchema,
+  ProductRecommendationIdentifierSchema,
   ProductSearchIdentifierSchema,
   ProductVariantIdentifierSchema,
   ShippingMethodIdentifierSchema,

package/schemas/models/index.js

@@ -18,3 +18,4 @@ export * from "./cost.model.js";
 export * from "./checkout.model.js";
 export * from "./payment.model.js";
 export * from "./order-search.model.js";
+export * from "./product-recommendations.model.js";

package/schemas/models/product-recommendations.model.js

@@ -0,0 +1,9 @@
+import z from "zod";
+import { ProductIdentifierSchema, ProductRecommendationIdentifierSchema, ProductVariantIdentifierSchema } from "./identifiers.model.js";
+const ProductRecommendationSchema = z.looseObject({
+  recommendationIdentifier: ProductRecommendationIdentifierSchema.describe("The identifier for the product recommendation, which includes a key and an algorithm and any other vendor specific/instance specific data "),
+  product: ProductIdentifierSchema.describe("The identifier for the recommended product.")
+});
+export {
+  ProductRecommendationSchema
+};

package/schemas/queries/index.js

@@ -12,3 +12,5 @@ export * from "./store.query.js";
 export * from "./order.query.js";
 export * from "./checkout.query.js";
 export * from "./order-search.query.js";
+export * from "./product-recommendations.query.js";
+export * from "./product-associations.query.js";

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

@@ -0,0 +1,19 @@
+import z from "zod";
+import { BaseQuerySchema } from "./base.query.js";
+import { ProductIdentifierSchema, ProductVariantIdentifierSchema } from "../models/identifiers.model.js";
+import { CartItemSchema } from "../models/cart.model.js";
+const ProductAssociationsGetAccessoriesQuerySchema = BaseQuerySchema.extend({
+  forProductVariant: ProductVariantIdentifierSchema.describe("The product variant identifier for which to get accessory recommendations. The provider should return recommendations that are relevant to this product, e.g., products that are frequently bought together, products that are similar in style or category, or products that are popular among users with similar preferences."),
+  numberOfAccessories: z.number().min(1).max(12).describe("The number of accessory recommendations requested. The provider may return fewer than this number, but should not return more.")
+});
+const ProductAssociationsGetSparepartsQuerySchema = BaseQuerySchema.extend({
+  forProductVariant: ProductVariantIdentifierSchema.describe("The product variant identifier for which to get similar item recommendations. The provider should return recommendations that are relevant to this product, e.g., products that are frequently bought together, products that are similar in style or category, or products that are popular among users with similar preferences.")
+});
+const ProductAssociationsGetReplacementsQuerySchema = BaseQuerySchema.extend({
+  forProductVariant: ProductVariantIdentifierSchema.describe("The product variant identifier for which to get replacement recommendations. The provider should return recommendations that are relevant to this product, e.g., products that are frequently bought together, products that are similar in style or category, or products that are popular among users with similar preferences.")
+});
+export {
+  ProductAssociationsGetAccessoriesQuerySchema,
+  ProductAssociationsGetReplacementsQuerySchema,
+  ProductAssociationsGetSparepartsQuerySchema
+};

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

@@ -0,0 +1,59 @@
+import z from "zod";
+import { CategoryIdentifierSchema, ProductIdentifierSchema } from "../models/identifiers.model.js";
+import { BaseQuerySchema } from "./base.query.js";
+const ProductRecommendationBaseQuerySchema = BaseQuerySchema.extend({
+  numberOfRecommendations: z.number().min(1).max(12).describe("The number of recommendations requested. The provider may return fewer than this number, but should not return more."),
+  labels: z.array(z.string()).optional().describe("The customer segments, quirks, chirps or other labels to which the recommendations can optimize themselves to be relevant. This can be used by the provider to personalize the recommendations based on the preferences and behaviors of users in these segments.")
+});
+const ProductRecommendationsByCollectionQuerySchema = ProductRecommendationBaseQuerySchema.extend({
+  collectionName: z.string().describe("The name of the collection for which to get product recommendations. This is to access either manually curated lists, or interface marketing rules engines that define zones by name"),
+  sourceProduct: z.array(ProductIdentifierSchema).optional().describe("The products on screen or in the context you are asking for the recommendations. Could be all the variants from the current cart (resolved into their products), or just the variant of the PDP, or the 4 first products of a category."),
+  sourceCategory: CategoryIdentifierSchema.optional().describe("The category identifier to use as a seed for the recommendations. The provider should return recommendations that are relevant to this category, e.g., products that are frequently bought together, products that are similar in style or category, or products that are popular among users with similar preferences. This is optional, as the collection may already be curated to be relevant to a specific product or category, but it can be used by the provider to further personalize the recommendations based on the preferences and behaviors of users who have interacted with this category.")
+});
+const ProductRecommendationProductBasedBaseQuerySchema = ProductRecommendationBaseQuerySchema.extend({
+  sourceProduct: ProductIdentifierSchema.describe("The product identifiers for which to get recommendations. The provider should return recommendations that are relevant to these products, e.g., products that are frequently bought together, products that are similar in style or category, or products that are popular among users with similar preferences.")
+});
+const ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuerySchema = ProductRecommendationProductBasedBaseQuerySchema.extend({
+  algorithm: z.literal("frequentlyBoughtTogether").describe("The provider should return recommendations based on products that are frequently bought together with the source products. The provider should leverage the Request Context to personalize the recommendations as much as possible, taking into account factors such as the user's browsing history, purchase history, and demographic information.")
+});
+const ProductRecommendationAlgorithmSimilarProductsQuerySchema = ProductRecommendationProductBasedBaseQuerySchema.extend({
+  algorithm: z.literal("similar").describe("The provider should return recommendations based on products that are similar to the source products either visually or data wise")
+});
+const ProductRecommendationAlgorithmRelatedProductsQuerySchema = ProductRecommendationProductBasedBaseQuerySchema.extend({
+  algorithm: z.literal("related").describe("The provider should return recommendations based on products that are related to the source products. ")
+});
+const ProductRecommendationAlgorithmTrendingInCategoryQuerySchema = ProductRecommendationBaseQuerySchema.extend({
+  algorithm: z.literal("trendingInCategory").describe("The provider should return recommendations based on products that are trending in the specified category. The provider should leverage the Request Context to personalize the recommendations as much as possible, taking into account factors such as the user's browsing history, purchase history, and demographic information."),
+  sourceCategory: CategoryIdentifierSchema.describe("The category identifier for which to get trending product recommendations. The provider should return recommendations that are relevant to this category, e.g., products that are frequently bought together, products that are similar in style or category, or products that are popular among users with similar preferences.")
+});
+const ProductRecommendationAlgorithmPopuplarProductsQuerySchema = ProductRecommendationBaseQuerySchema.extend({
+  algorithm: z.literal("popular").describe("The provider should return recommendations based on products that are popular among users. The provider should leverage the Request Context to personalize the recommendations as much as possible, taking into account factors such as the user's browsing history, purchase history, and demographic information.")
+});
+const ProductRecommendationAlgorithmTopPicksProductsQuerySchema = ProductRecommendationBaseQuerySchema.extend({
+  algorithm: z.literal("topPicks").describe("The provider should return recommendations based on products that are top picks among users. The provider should leverage the Request Context to personalize the recommendations as much as possible, taking into account factors such as the user's browsing history, purchase history, and demographic information.")
+});
+const ProductRecommendationAlgorithmAlsoViewedProductsQuerySchema = ProductRecommendationProductBasedBaseQuerySchema.extend({
+  algorithm: z.literal("alsoViewed").describe("The provider should return recommendations based on products that are also viewed by users. The provider should leverage the Request Context to personalize the recommendations as much as possible, taking into account factors such as the user's browsing history, purchase history, and demographic information.")
+});
+const ProductRecommendationsQuerySchema = z.discriminatedUnion("algorithm", [
+  ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuerySchema,
+  ProductRecommendationAlgorithmTrendingInCategoryQuerySchema,
+  ProductRecommendationAlgorithmSimilarProductsQuerySchema,
+  ProductRecommendationAlgorithmRelatedProductsQuerySchema,
+  ProductRecommendationAlgorithmPopuplarProductsQuerySchema,
+  ProductRecommendationAlgorithmTopPicksProductsQuerySchema,
+  ProductRecommendationAlgorithmAlsoViewedProductsQuerySchema
+]);
+export {
+  ProductRecommendationAlgorithmAlsoViewedProductsQuerySchema,
+  ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuerySchema,
+  ProductRecommendationAlgorithmPopuplarProductsQuerySchema,
+  ProductRecommendationAlgorithmRelatedProductsQuerySchema,
+  ProductRecommendationAlgorithmSimilarProductsQuerySchema,
+  ProductRecommendationAlgorithmTopPicksProductsQuerySchema,
+  ProductRecommendationAlgorithmTrendingInCategoryQuerySchema,
+  ProductRecommendationBaseQuerySchema,
+  ProductRecommendationProductBasedBaseQuerySchema,
+  ProductRecommendationsByCollectionQuerySchema,
+  ProductRecommendationsQuerySchema
+};

package/src/client/client.d.ts

@@ -8,9 +8,13 @@ import type { Cache } from "../cache/cache.interface.js";
 import type { CategoryProvider } from "../providers/category.provider.js";
 import type { AnalyticsProvider, CheckoutProvider, OrderProvider, ProfileProvider, StoreProvider } from "../providers/index.js";
 import type { OrderSearchProvider } from "../providers/order-search.provider.js";
+import type { ProductRecommendationsProvider } from "../providers/product-recommendations.provider.js";
+import type { ProductAssociationsProvider } from "../providers/product-associations.provider.js";
 export interface Client {
     product: ProductProvider;
     productSearch: ProductSearchProvider;
+    productRecommendations: ProductRecommendationsProvider;
+    productAssociations: ProductAssociationsProvider;
     identity: IdentityProvider;
     cache: Cache;
     cart: CartProvider;

package/src/providers/index.d.ts

@@ -9,6 +9,8 @@ export * from './price.provider.js';
 export * from './product.provider.js';
 export * from './profile.provider.js';
 export * from './product-search.provider.js';
+export * from './product-recommendations.provider.js';
+export * from './product-associations.provider.js';
 export * from './store.provider.js';
 export * from './order.provider.js';
 export * from './order-search.provider.js';

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

@@ -0,0 +1,35 @@
+import type { ProductVariantIdentifier } from "../schemas/index.js";
+import type { ProductAssociationsGetAccessoriesQuery, ProductAssociationsGetSparepartsQuery, ProductAssociationsGetReplacementsQuery } from "../schemas/queries/product-associations.query.js";
+import { BaseProvider } from "./base.provider.js";
+/**
+ * The product association provider is responsible for providing evidence based associations between products, such as
+ * accessories, spareparts, and replacements. These associations are typically used to provide recommendations to customers on the product detail page, but can also be used in other contexts such as the cart or post-purchase, but
+ * do not carry any personalization concept to them.
+ */
+export declare abstract class ProductAssociationsProvider extends BaseProvider {
+    /**
+     * Returns a list of product identifiers which are accessories to the given product.
+     * Accessories in are products in their own right, but are commonly purchased alongside or recommended as complementary to the main product. Examples of accessories include:
+     * - A phone case for a smartphone
+     * - A camera bag for a camera
+     *
+     *
+     * Usecase:
+     * - PDP: Accessories for this product
+     */
+    abstract getAccessories(query: ProductAssociationsGetAccessoriesQuery): Promise<ProductVariantIdentifier[]>;
+    /**
+     * Returns a list of product identifiers which are spareparts to the given product.
+     * Spareparts are products which are necessary for the use of the main product, but are not typically purchased alongside it. Examples of spareparts include:
+     *
+     * Usecase:
+     * - PDP: Accessories for this product
+     */
+    abstract getSpareparts(query: ProductAssociationsGetSparepartsQuery): Promise<ProductVariantIdentifier[]>;
+    /**
+     * This product is replaced by these equivalent or newer products
+     * @param query
+     */
+    abstract getReplacements(query: ProductAssociationsGetReplacementsQuery): Promise<ProductVariantIdentifier[]>;
+    getResourceName(): string;
+}

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

@@ -0,0 +1,32 @@
+import type { Cache } from '../cache/cache.interface.js';
+import { type ProductRecommendation, type ProductRecommendationsByCollectionQuery, type RequestContext, type Result } from "../schemas/index.js";
+import { type ProductRecommendationAlgorithmAlsoViewedProductsQuery, type ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuery, type ProductRecommendationAlgorithmPopuplarProductsQuery, type ProductRecommendationAlgorithmRelatedProductsQuery, type ProductRecommendationAlgorithmSimilarProductsQuery, type ProductRecommendationAlgorithmTopPicksProductsQuery, type ProductRecommendationAlgorithmTrendingInCategoryQuery, type ProductRecommendationsQuery } from "../schemas/queries/product-recommendations.query.js";
+import { BaseProvider } from "./base.provider.js";
+export declare abstract class ProductRecommendationsProvider extends BaseProvider {
+    /**
+     * returns a list of recommended products, based on the selected algorithm and the provided query parameters. The recommendations should be relevant to the product specified in the query, and can be personalized based on the customer segments or contexts provided. The provider should return a list of product variant identifiers that are recommended for the given product, which can then be used to fetch the full product details from the product provider if needed.
+     *   *
+     * Usecase:
+     *   - PDP - "Customers who viewed this product also viewed"
+     *   - Cart - "You might also like"
+     *   - Post-purchase - "Customers who bought this product also bought"
+     *   - Article page: "Products related to the product mentioned in this article"
+     * @param query
+     */
+    getRecommendations(query: ProductRecommendationsQuery): Promise<Result<ProductRecommendation[]>>;
+    getCollection(query: ProductRecommendationsByCollectionQuery): Promise<Result<ProductRecommendation[]>>;
+    protected getFrequentlyBoughtTogetherRecommendations(query: ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuery): Promise<ProductRecommendation[]>;
+    protected getSimilarProductsRecommendations(query: ProductRecommendationAlgorithmSimilarProductsQuery): Promise<ProductRecommendation[]>;
+    protected getTrendingInCategoryRecommendations(query: ProductRecommendationAlgorithmTrendingInCategoryQuery): Promise<ProductRecommendation[]>;
+    protected getRelatedProductsRecommendations(query: ProductRecommendationAlgorithmRelatedProductsQuery): Promise<ProductRecommendation[]>;
+    protected getPopularProductsRecommendations(query: ProductRecommendationAlgorithmPopuplarProductsQuery): Promise<ProductRecommendation[]>;
+    protected getTopPicksProductsRecommendations(query: ProductRecommendationAlgorithmTopPicksProductsQuery): Promise<ProductRecommendation[]>;
+    protected getAlsoViewedProductsRecommendations(query: ProductRecommendationAlgorithmAlsoViewedProductsQuery): Promise<ProductRecommendation[]>;
+    protected getResourceName(): string;
+}
+export declare class MulticastProductRecommendationsProvider extends ProductRecommendationsProvider {
+    protected providers: Array<ProductRecommendationsProvider>;
+    constructor(cache: Cache, requestContext: RequestContext, providers: Array<ProductRecommendationsProvider>);
+    getRecommendations(query: ProductRecommendationsQuery): Promise<Result<ProductRecommendation[]>>;
+    getCollection(query: ProductRecommendationsByCollectionQuery): Promise<Result<ProductRecommendation[]>>;
+}

package/src/schemas/capabilities.schema.d.ts

@@ -4,6 +4,8 @@ import type { Client } from '../client/client.js';
 export declare const CapabilitiesSchema: z.ZodObject<{
     product: z.ZodBoolean;
     productSearch: z.ZodBoolean;
+    productAssociations: z.ZodBoolean;
+    productRecommendations: z.ZodBoolean;
     analytics: z.ZodBoolean;
     identity: z.ZodBoolean;
     cart: z.ZodBoolean;

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

@@ -108,6 +108,10 @@ export declare const PaymentInstructionIdentifierSchema: z.ZodObject<{
 export declare const PickupPointIdentifierSchema: z.ZodObject<{
     key: z.ZodString;
 }, z.core.$loose>;
+export declare const ProductRecommendationIdentifierSchema: z.ZodObject<{
+    key: z.ZodString;
+    algorithm: z.ZodString;
+}, z.core.$loose>;
 export declare const ProductSearchIdentifierSchema: z.ZodObject<{
     term: z.ZodString;
     facets: z.ZodArray<z.ZodObject<{
@@ -179,4 +183,5 @@ export type ProductOptionIdentifier = InferType<typeof ProductOptionIdentifierSc
 export type ProductOptionValueIdentifier = InferType<typeof ProductOptionValueIdentifierSchema>;
 export type ProductAttributeIdentifier = InferType<typeof ProductAttributeIdentifierSchema>;
 export type ProductAttributeValueIdentifier = InferType<typeof ProductAttributeValueIdentifierSchema>;
-export type IdentifierType = ProductIdentifier | ProductVariantIdentifier | SearchIdentifier | FacetIdentifier | FacetValueIdentifier | CartIdentifier | CartItemIdentifier | PriceIdentifier | CategoryIdentifier | WebStoreIdentifier | InventoryIdentifier | FulfillmentCenterIdentifier | IdentityIdentifier | ShippingMethodIdentifier | PaymentMethodIdentifier | AddressIdentifier | PaymentInstructionIdentifier | OrderIdentifier | OrderItemIdentifier | CheckoutIdentifier | CheckoutItemIdentifier | StoreIdentifier | ProductOptionIdentifier | ProductOptionValueIdentifier | PickupPointIdentifier | ProductAttributeIdentifier | ProductAttributeValueIdentifier;
+export type ProductRecommendationIdentifier = InferType<typeof ProductRecommendationIdentifierSchema>;
+export type IdentifierType = ProductIdentifier | ProductVariantIdentifier | SearchIdentifier | FacetIdentifier | FacetValueIdentifier | CartIdentifier | CartItemIdentifier | PriceIdentifier | CategoryIdentifier | WebStoreIdentifier | InventoryIdentifier | ProductRecommendationIdentifier | FulfillmentCenterIdentifier | IdentityIdentifier | ShippingMethodIdentifier | PaymentMethodIdentifier | AddressIdentifier | PaymentInstructionIdentifier | OrderIdentifier | OrderItemIdentifier | CheckoutIdentifier | CheckoutItemIdentifier | StoreIdentifier | ProductOptionIdentifier | ProductOptionValueIdentifier | PickupPointIdentifier | ProductAttributeIdentifier | ProductAttributeValueIdentifier;

package/src/schemas/models/index.d.ts

@@ -18,3 +18,4 @@ export * from './cost.model.js';
 export * from './checkout.model.js';
 export * from './payment.model.js';
 export * from './order-search.model.js';
+export * from './product-recommendations.model.js';

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

@@ -0,0 +1,11 @@
+import z from "zod";
+export declare const ProductRecommendationSchema: z.ZodObject<{
+    recommendationIdentifier: z.ZodObject<{
+        key: z.ZodString;
+        algorithm: z.ZodString;
+    }, z.z.core.$loose>;
+    product: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+}, z.z.core.$loose>;
+export type ProductRecommendation = z.infer<typeof ProductRecommendationSchema>;

package/src/schemas/queries/index.d.ts

@@ -12,3 +12,5 @@ export * from './store.query.js';
 export * from './order.query.js';
 export * from './checkout.query.js';
 export * from './order-search.query.js';
+export * from './product-recommendations.query.js';
+export * from './product-associations.query.js';

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

@@ -0,0 +1,20 @@
+import z from "zod";
+export declare const ProductAssociationsGetAccessoriesQuerySchema: z.ZodObject<{
+    forProductVariant: z.ZodObject<{
+        sku: z.ZodString;
+    }, z.z.core.$loose>;
+    numberOfAccessories: z.ZodNumber;
+}, z.z.core.$loose>;
+export declare const ProductAssociationsGetSparepartsQuerySchema: z.ZodObject<{
+    forProductVariant: z.ZodObject<{
+        sku: z.ZodString;
+    }, z.z.core.$loose>;
+}, z.z.core.$loose>;
+export declare const ProductAssociationsGetReplacementsQuerySchema: z.ZodObject<{
+    forProductVariant: z.ZodObject<{
+        sku: z.ZodString;
+    }, z.z.core.$loose>;
+}, z.z.core.$loose>;
+export type ProductAssociationsGetAccessoriesQuery = z.infer<typeof ProductAssociationsGetAccessoriesQuerySchema>;
+export type ProductAssociationsGetSparepartsQuery = z.infer<typeof ProductAssociationsGetSparepartsQuerySchema>;
+export type ProductAssociationsGetReplacementsQuery = z.infer<typeof ProductAssociationsGetReplacementsQuerySchema>;

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

@@ -0,0 +1,127 @@
+import z from "zod";
+import type { InferType } from "../../zod-utils.js";
+export declare const ProductRecommendationBaseQuerySchema: z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.z.core.$loose>;
+export declare const ProductRecommendationsByCollectionQuerySchema: z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    collectionName: z.ZodString;
+    sourceProduct: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>>>;
+    sourceCategory: z.ZodOptional<z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>>;
+}, z.z.core.$loose>;
+export declare const ProductRecommendationProductBasedBaseQuerySchema: z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    sourceProduct: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+}, z.z.core.$loose>;
+export declare const ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuerySchema: z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    sourceProduct: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+    algorithm: z.ZodLiteral<"frequentlyBoughtTogether">;
+}, z.z.core.$loose>;
+export declare const ProductRecommendationAlgorithmSimilarProductsQuerySchema: z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    sourceProduct: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+    algorithm: z.ZodLiteral<"similar">;
+}, z.z.core.$loose>;
+export declare const ProductRecommendationAlgorithmRelatedProductsQuerySchema: z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    sourceProduct: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+    algorithm: z.ZodLiteral<"related">;
+}, z.z.core.$loose>;
+export declare const ProductRecommendationAlgorithmTrendingInCategoryQuerySchema: z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    algorithm: z.ZodLiteral<"trendingInCategory">;
+    sourceCategory: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+}, z.z.core.$loose>;
+export declare const ProductRecommendationAlgorithmPopuplarProductsQuerySchema: z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    algorithm: z.ZodLiteral<"popular">;
+}, z.z.core.$loose>;
+export declare const ProductRecommendationAlgorithmTopPicksProductsQuerySchema: z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    algorithm: z.ZodLiteral<"topPicks">;
+}, z.z.core.$loose>;
+export declare const ProductRecommendationAlgorithmAlsoViewedProductsQuerySchema: z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    sourceProduct: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+    algorithm: z.ZodLiteral<"alsoViewed">;
+}, z.z.core.$loose>;
+export declare const ProductRecommendationsQuerySchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    sourceProduct: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+    algorithm: z.ZodLiteral<"frequentlyBoughtTogether">;
+}, z.z.core.$loose>, z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    algorithm: z.ZodLiteral<"trendingInCategory">;
+    sourceCategory: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+}, z.z.core.$loose>, z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    sourceProduct: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+    algorithm: z.ZodLiteral<"similar">;
+}, z.z.core.$loose>, z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    sourceProduct: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+    algorithm: z.ZodLiteral<"related">;
+}, z.z.core.$loose>, z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    algorithm: z.ZodLiteral<"popular">;
+}, z.z.core.$loose>, z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    algorithm: z.ZodLiteral<"topPicks">;
+}, z.z.core.$loose>, z.ZodObject<{
+    numberOfRecommendations: z.ZodNumber;
+    labels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    sourceProduct: z.ZodObject<{
+        key: z.ZodString;
+    }, z.z.core.$loose>;
+    algorithm: z.ZodLiteral<"alsoViewed">;
+}, z.z.core.$loose>], "algorithm">;
+export type ProductRecommendationsQuery = InferType<typeof ProductRecommendationsQuerySchema>;
+export type ProductRecommendationsByCollectionQuery = InferType<typeof ProductRecommendationsByCollectionQuerySchema>;
+export type ProductRecommendationAlgorithmTopPicksProductsQuery = InferType<typeof ProductRecommendationAlgorithmTopPicksProductsQuerySchema>;
+export type ProductRecommendationAlgorithmPopuplarProductsQuery = InferType<typeof ProductRecommendationAlgorithmPopuplarProductsQuerySchema>;
+export type ProductRecommendationAlgorithmTrendingInCategoryQuery = InferType<typeof ProductRecommendationAlgorithmTrendingInCategoryQuerySchema>;
+export type ProductRecommendationAlgorithmRelatedProductsQuery = InferType<typeof ProductRecommendationAlgorithmRelatedProductsQuerySchema>;
+export type ProductRecommendationAlgorithmSimilarProductsQuery = InferType<typeof ProductRecommendationAlgorithmSimilarProductsQuerySchema>;
+export type ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuery = InferType<typeof ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuerySchema>;
+export type ProductRecommendationAlgorithmAlsoViewedProductsQuery = InferType<typeof ProductRecommendationAlgorithmAlsoViewedProductsQuerySchema>;