@reactionary/core 0.3.13 → 0.3.15

package/package.json

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

package/schemas/models/index.js

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

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

@@ -2,24 +2,24 @@ import * as z from "zod";
 import { ProductIdentifierSchema, ProductAssociationsIdentifierSchema, ProductVariantIdentifierSchema } from "./identifiers.model.js";
 import { ProductSearchResultItemSchema } from "./product-search.model.js";
 import { BaseModelSchema } from "./base.model.js";
-const BaseProductAssociationsSchema = BaseModelSchema.extend({
+const BaseProductAssociationSchema = BaseModelSchema.extend({
   associationIdentifier: ProductAssociationsIdentifierSchema.meta({ description: "The identifier for the product recommendation, which includes a key and an algorithm and any other vendor specific/instance specific data " })
 });
-const ProductAssociationsIdOnlySchema = BaseProductAssociationsSchema.extend({
+const ProductAssociationIdOnlySchema = BaseProductAssociationSchema.extend({
   associationReturnType: z.literal("idOnly").meta({ description: "The type of recommendation return" }),
   product: ProductIdentifierSchema.meta({ description: "The identifier for the recommended product." })
 });
-const ProductAssociationsProductSearchResultItemSchema = BaseProductAssociationsSchema.extend({
+const ProductAssociationProductSearchResultItemSchema = BaseProductAssociationSchema.extend({
   associationReturnType: z.literal("productSearchResultItem").meta({ description: "The type of recommendation return" }),
   product: ProductSearchResultItemSchema.meta({ description: "The recommended product, including its identifier, name, slug, and variants. This can be used to display the recommended product directly on the frontend without needing to make an additional request to fetch the product details." })
 });
-const ProductAssociationsSchema = z.discriminatedUnion("associationReturnType", [
-  ProductAssociationsIdOnlySchema,
-  ProductAssociationsProductSearchResultItemSchema
+const ProductAssociationSchema = z.discriminatedUnion("associationReturnType", [
+  ProductAssociationIdOnlySchema,
+  ProductAssociationProductSearchResultItemSchema
 ]);
 export {
-  BaseProductAssociationsSchema,
-  ProductAssociationsIdOnlySchema,
-  ProductAssociationsProductSearchResultItemSchema,
-  ProductAssociationsSchema
+  BaseProductAssociationSchema,
+  ProductAssociationIdOnlySchema,
+  ProductAssociationProductSearchResultItemSchema,
+  ProductAssociationSchema
 };

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

@@ -3,14 +3,16 @@ 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."),
+  forProduct: ProductIdentifierSchema.describe("The product 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).meta({ description: "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.")
+  forProduct: ProductIdentifierSchema.describe("The product 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."),
+  numberOfSpareparts: z.number().min(1).max(12).meta({ description: "The number of spare part recommendations requested. The provider may return fewer than this number, but should not return more." })
 });
 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.")
+  forProduct: ProductIdentifierSchema.describe("The product 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."),
+  numberOfReplacements: z.number().min(1).max(12).meta({ description: "The number of replacement recommendations requested. The provider may return fewer than this number, but should not return more." })
 });
 export {
   ProductAssociationsGetAccessoriesQuerySchema,

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

@@ -1,6 +1,7 @@
-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";
+import type { Result } from '../schemas/result.js';
+import type { ProductAssociation } from '../schemas/models/product-associations.model.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
@@ -16,20 +17,26 @@ export declare abstract class ProductAssociationsProvider extends BaseProvider {
      *
      * Usecase:
      * - PDP: Accessories for this product
+     *
+     * TODO:  This should be a PaginatedResult
      */
-    abstract getAccessories(query: ProductAssociationsGetAccessoriesQuery): Promise<ProductVariantIdentifier[]>;
+    abstract getAccessories(query: ProductAssociationsGetAccessoriesQuery): Promise<Result<ProductAssociation[]>>;
     /**
      * 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
+     * - PDP: Spareparts for this product
+     *
+     * TODO:  This should be a PaginatedResult
      */
-    abstract getSpareparts(query: ProductAssociationsGetSparepartsQuery): Promise<ProductVariantIdentifier[]>;
+    abstract getSpareparts(query: ProductAssociationsGetSparepartsQuery): Promise<Result<ProductAssociation[]>>;
     /**
      * This product is replaced by these equivalent or newer products
+     *
+     * TODO:  This should be a PaginatedResult
      * @param query
      */
-    abstract getReplacements(query: ProductAssociationsGetReplacementsQuery): Promise<ProductVariantIdentifier[]>;
+    abstract getReplacements(query: ProductAssociationsGetReplacementsQuery): Promise<Result<ProductAssociation[]>>;
     getResourceName(): string;
 }

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

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

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

@@ -1,11 +1,11 @@
 import * as z from "zod";
 import type { InferType } from "../../zod-utils.js";
-export declare const BaseProductAssociationsSchema: z.ZodObject<{
+export declare const BaseProductAssociationSchema: z.ZodObject<{
     associationIdentifier: z.ZodObject<{
         key: z.ZodString;
     }, z.core.$loose>;
 }, z.core.$loose>;
-export declare const ProductAssociationsIdOnlySchema: z.ZodObject<{
+export declare const ProductAssociationIdOnlySchema: z.ZodObject<{
     associationIdentifier: z.ZodObject<{
         key: z.ZodString;
     }, z.core.$loose>;
@@ -14,7 +14,7 @@ export declare const ProductAssociationsIdOnlySchema: z.ZodObject<{
         key: z.ZodString;
     }, z.core.$loose>;
 }, z.core.$loose>;
-export declare const ProductAssociationsProductSearchResultItemSchema: z.ZodObject<{
+export declare const ProductAssociationProductSearchResultItemSchema: z.ZodObject<{
     associationIdentifier: z.ZodObject<{
         key: z.ZodString;
     }, z.core.$loose>;
@@ -53,7 +53,7 @@ export declare const ProductAssociationsProductSearchResultItemSchema: z.ZodObje
         }, z.core.$loose>>;
     }, z.core.$loose>;
 }, z.core.$loose>;
-export declare const ProductAssociationsSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+export declare const ProductAssociationSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     associationIdentifier: z.ZodObject<{
         key: z.ZodString;
     }, z.core.$loose>;
@@ -100,6 +100,6 @@ export declare const ProductAssociationsSchema: z.ZodDiscriminatedUnion<[z.ZodOb
         }, z.core.$loose>>;
     }, z.core.$loose>;
 }, z.core.$loose>], "associationReturnType">;
-export type ProductAssociationsIdOnly = InferType<typeof ProductAssociationsIdOnlySchema>;
-export type ProductAssociationsSearchItem = InferType<typeof ProductAssociationsProductSearchResultItemSchema>;
-export type ProductAssociations = InferType<typeof ProductAssociationsSchema>;
+export type ProductAssociationIdOnly = InferType<typeof ProductAssociationIdOnlySchema>;
+export type ProductAssociationSearchItem = InferType<typeof ProductAssociationProductSearchResultItemSchema>;
+export type ProductAssociation = InferType<typeof ProductAssociationSchema>;

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

@@ -1,19 +1,21 @@
 import * as z from "zod";
 export declare const ProductAssociationsGetAccessoriesQuerySchema: z.ZodObject<{
-    forProductVariant: z.ZodObject<{
-        sku: z.ZodString;
+    forProduct: z.ZodObject<{
+        key: z.ZodString;
     }, z.core.$loose>;
     numberOfAccessories: z.ZodNumber;
 }, z.core.$loose>;
 export declare const ProductAssociationsGetSparepartsQuerySchema: z.ZodObject<{
-    forProductVariant: z.ZodObject<{
-        sku: z.ZodString;
+    forProduct: z.ZodObject<{
+        key: z.ZodString;
     }, z.core.$loose>;
+    numberOfSpareparts: z.ZodNumber;
 }, z.core.$loose>;
 export declare const ProductAssociationsGetReplacementsQuerySchema: z.ZodObject<{
-    forProductVariant: z.ZodObject<{
-        sku: z.ZodString;
+    forProduct: z.ZodObject<{
+        key: z.ZodString;
     }, z.core.$loose>;
+    numberOfReplacements: z.ZodNumber;
 }, z.core.$loose>;
 export type ProductAssociationsGetAccessoriesQuery = z.infer<typeof ProductAssociationsGetAccessoriesQuerySchema>;
 export type ProductAssociationsGetSparepartsQuery = z.infer<typeof ProductAssociationsGetSparepartsQuerySchema>;