@reactionary/core 0.6.1 → 0.6.3

package/cache/memory-cache.js

@@ -1,10 +1,8 @@
 import { getReactionaryCacheMeter } from "../metrics/metrics.js";
 import { error, NotFoundErrorSchema, success } from "../schemas/index.js";
 class MemoryCache {
-  constructor() {
-    this.entries = new Array();
-    this.meter = getReactionaryCacheMeter();
-  }
+  entries = new Array();
+  meter = getReactionaryCacheMeter();
   async get(key, schema) {
     const c = this.entries.find((x) => x.key === key);
     if (!c) {

package/cache/noop-cache.js

@@ -1,8 +1,6 @@
 import { getReactionaryCacheMeter } from "../metrics/metrics.js";
 class NoOpCache {
-  constructor() {
-    this.meter = getReactionaryCacheMeter();
-  }
+  meter = getReactionaryCacheMeter();
   async get(_key, _schema) {
     this.meter.misses.add(1, {
       "labels.cache_type": "noop"

package/cache/redis-cache.js

@@ -1,8 +1,9 @@
 import { Redis } from "@upstash/redis";
 import { getReactionaryCacheMeter } from "../metrics/metrics.js";
 class RedisCache {
+  redis;
+  meter = getReactionaryCacheMeter();
   constructor() {
-    this.meter = getReactionaryCacheMeter();
     this.redis = Redis.fromEnv();
   }
   async get(key, schema) {

package/{providers/analytics.provider.js → capabilities/analytics.capability.js}

@@ -9,12 +9,12 @@ var __decorateClass = (decorators, target, key, kind) => {
     __defProp(target, key, result);
   return result;
 };
-import { BaseProvider } from "./base.provider.js";
+import { BaseCapability } from "./base.capability.js";
 import {
   AnalyticsMutationSchema
 } from "../schemas/index.js";
 import { Reactionary } from "../decorators/reactionary.decorator.js";
-class AnalyticsProvider extends BaseProvider {
+class AnalyticsCapability extends BaseCapability {
   getResourceName() {
     return "analytics";
   }
@@ -48,14 +48,15 @@ class AnalyticsProvider extends BaseProvider {
   async processPurchase(event) {
   }
 }
-class MulticastAnalyticsProvider extends AnalyticsProvider {
-  constructor(cache, requestContext, providers) {
+class MulticastAnalyticsCapability extends AnalyticsCapability {
+  capabilities;
+  constructor(cache, requestContext, capabilities) {
     super(cache, requestContext);
-    this.providers = providers;
+    this.capabilities = capabilities;
   }
   async track(event) {
-    for (const provider of this.providers) {
-      provider.track(event);
+    for (const capability of this.capabilities) {
+      capability.track(event);
     }
   }
 }
@@ -63,8 +64,8 @@ __decorateClass([
   Reactionary({
     inputSchema: AnalyticsMutationSchema
   })
-], MulticastAnalyticsProvider.prototype, "track", 1);
+], MulticastAnalyticsCapability.prototype, "track", 1);
 export {
-  AnalyticsProvider,
-  MulticastAnalyticsProvider
+  AnalyticsCapability,
+  MulticastAnalyticsCapability
 };

package/{providers/base.provider.js → capabilities/base.capability.js}

@@ -1,6 +1,8 @@
 import {} from "../schemas/session.schema.js";
 import { hasher } from "node-object-hash";
-class BaseProvider {
+class BaseCapability {
+  cache;
+  context;
   constructor(cache, context) {
     this.cache = cache;
     this.context = context;
@@ -21,5 +23,5 @@ class BaseProvider {
   }
 }
 export {
-  BaseProvider
+  BaseCapability
 };

package/capabilities/cart.capability.js

@@ -0,0 +1,9 @@
+import { BaseCapability } from "./base.capability.js";
+class CartCapability extends BaseCapability {
+  getResourceName() {
+    return "cart";
+  }
+}
+export {
+  CartCapability
+};

package/capabilities/category.capability.js

@@ -0,0 +1,9 @@
+import { BaseCapability } from "./base.capability.js";
+class CategoryCapability extends BaseCapability {
+  getResourceName() {
+    return "category";
+  }
+}
+export {
+  CategoryCapability
+};

package/capabilities/checkout.capability.js

@@ -0,0 +1,9 @@
+import { BaseCapability } from "./base.capability.js";
+class CheckoutCapability extends BaseCapability {
+  getResourceName() {
+    return "checkout";
+  }
+}
+export {
+  CheckoutCapability
+};

package/{providers/identity.provider.js → capabilities/identity.capability.js}

@@ -1,5 +1,5 @@
-import { BaseProvider } from "./base.provider.js";
-class IdentityProvider extends BaseProvider {
+import { BaseCapability } from "./base.capability.js";
+class IdentityCapability extends BaseCapability {
   getResourceName() {
     return "identity";
   }
@@ -9,5 +9,5 @@ class IdentityProvider extends BaseProvider {
   }
 }
 export {
-  IdentityProvider
+  IdentityCapability
 };

package/capabilities/index.js

@@ -0,0 +1,18 @@
+export * from "./analytics.capability.js";
+export * from "./base.capability.js";
+export * from "./cart.capability.js";
+export * from "./category.capability.js";
+export * from "./checkout.capability.js";
+export * from "./identity.capability.js";
+export * from "./inventory.capability.js";
+export * from "./price.capability.js";
+export * from "./product.capability.js";
+export * from "./profile.capability.js";
+export * from "./product-search.capability.js";
+export * from "./product-recommendations.capability.js";
+export * from "./product-associations.capability.js";
+export * from "./product-reviews.capability.js";
+export * from "./product-list.capability.js";
+export * from "./store.capability.js";
+export * from "./order.capability.js";
+export * from "./order-search.capability.js";

package/{providers/inventory.provider.js → capabilities/inventory.capability.js}

@@ -1,5 +1,5 @@
-import { BaseProvider } from "./base.provider.js";
-class InventoryProvider extends BaseProvider {
+import { BaseCapability } from "./base.capability.js";
+class InventoryCapability extends BaseCapability {
   getResourceName() {
     return "inventory";
   }
@@ -13,5 +13,5 @@ class InventoryProvider extends BaseProvider {
   }
 }
 export {
-  InventoryProvider
+  InventoryCapability
 };

package/capabilities/order-search.capability.js

@@ -0,0 +1,9 @@
+import { BaseCapability } from "./base.capability.js";
+class OrderSearchCapability extends BaseCapability {
+  getResourceName() {
+    return "order-search";
+  }
+}
+export {
+  OrderSearchCapability
+};

package/{providers/order.provider.js → capabilities/order.capability.js}

@@ -1,5 +1,5 @@
-import { BaseProvider } from "./base.provider.js";
-class OrderProvider extends BaseProvider {
+import { BaseCapability } from "./base.capability.js";
+class OrderCapability extends BaseCapability {
   createEmptyOrder() {
     const order = {
       identifier: {
@@ -46,5 +46,5 @@ class OrderProvider extends BaseProvider {
   }
 }
 export {
-  OrderProvider
+  OrderCapability
 };

package/{providers/price.provider.js → capabilities/price.capability.js}

@@ -1,5 +1,5 @@
-import { BaseProvider } from "./base.provider.js";
-class PriceProvider extends BaseProvider {
+import { BaseCapability } from "./base.capability.js";
+class PriceCapability extends BaseCapability {
   /**
    * Utility function to create an empty price result, with a value of -1.
    * This is used when no price is found for a given SKU + currency combination.
@@ -29,5 +29,5 @@ class PriceProvider extends BaseProvider {
   }
 }
 export {
-  PriceProvider
+  PriceCapability
 };

package/capabilities/product-associations.capability.js

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

package/capabilities/product-list.capability.js

@@ -0,0 +1,10 @@
+import {} from "../schemas/queries/product-list.query.js";
+import { BaseCapability } from "./base.capability.js";
+class ProductListCapability extends BaseCapability {
+  getResourceName() {
+    return "product-lists";
+  }
+}
+export {
+  ProductListCapability
+};

package/{providers/product-recommendations.provider.js → capabilities/product-recommendations.capability.js}

@@ -12,10 +12,10 @@ var __decorateClass = (decorators, target, key, kind) => {
 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 {
+import { BaseCapability } from "./base.capability.js";
+class ProductRecommendationsCapability extends BaseCapability {
   /**
-   * 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.
+   * 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 capability 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 capability if needed.
    *   *
    * Usecase:
    *   - PDP - "Customers who viewed this product also viewed"
@@ -76,20 +76,21 @@ class ProductRecommendationsProvider extends BaseProvider {
     return "product-recommendations";
   }
 }
-class MulticastProductRecommendationsProvider extends ProductRecommendationsProvider {
-  constructor(cache, requestContext, providers) {
+class MulticastProductRecommendationsCapability extends ProductRecommendationsCapability {
+  capabilities;
+  constructor(cache, requestContext, capabilities) {
     super(cache, requestContext);
-    this.providers = providers;
+    this.capabilities = capabilities;
   }
   async getRecommendations(query) {
     const output = [];
-    for (const provider of this.providers) {
-      const providerOutput = await provider.getRecommendations(query);
-      if (providerOutput.success) {
-        output.push(...providerOutput.value);
+    for (const capability of this.capabilities) {
+      const capabilityOutput = await capability.getRecommendations(query);
+      if (capabilityOutput.success) {
+        output.push(...capabilityOutput.value);
       } else {
-        console.error(`Error from provider ${provider.constructor.name}:`, providerOutput.error);
-        return providerOutput;
+        console.error(`Error from capability ${capability.constructor.name}:`, capabilityOutput.error);
+        return capabilityOutput;
       }
       if (output.length >= query.numberOfRecommendations) {
         break;
@@ -99,16 +100,16 @@ class MulticastProductRecommendationsProvider extends ProductRecommendationsProv
   }
   async getCollection(query) {
     const output = [];
-    for (const provider of this.providers) {
-      const providerOutput = await provider.getCollection(query);
-      if (providerOutput.success) {
-        output.push(...providerOutput.value);
+    for (const capability of this.capabilities) {
+      const capabilityOutput = await capability.getCollection(query);
+      if (capabilityOutput.success) {
+        output.push(...capabilityOutput.value);
       } else {
-        if (providerOutput.error.type === "NotFound") {
+        if (capabilityOutput.error.type === "NotFound") {
           continue;
         } else {
-          console.error(`Error from provider ${provider.constructor.name}:`, providerOutput.error);
-          return providerOutput;
+          console.error(`Error from capability ${capability.constructor.name}:`, capabilityOutput.error);
+          return capabilityOutput;
         }
       }
       if (output.length >= query.numberOfRecommendations) {
@@ -122,8 +123,8 @@ __decorateClass([
   Reactionary({
     inputSchema: ProductRecommendationsQuerySchema
   })
-], MulticastProductRecommendationsProvider.prototype, "getRecommendations", 1);
+], MulticastProductRecommendationsCapability.prototype, "getRecommendations", 1);
 export {
-  MulticastProductRecommendationsProvider,
-  ProductRecommendationsProvider
+  MulticastProductRecommendationsCapability,
+  ProductRecommendationsCapability
 };

package/{providers/product-reviews.provider.js → capabilities/product-reviews.capability.js}

@@ -1,6 +1,6 @@
-import { BaseProvider } from "./base.provider.js";
+import { BaseCapability } from "./base.capability.js";
 import {} from "../schemas/models/identifiers.model.js";
-class ProductReviewsProvider extends BaseProvider {
+class ProductReviewsCapability extends BaseCapability {
   createEmptyProductRatingSummary(key) {
     return {
       identifier: key,
@@ -14,5 +14,5 @@ class ProductReviewsProvider extends BaseProvider {
   }
 }
 export {
-  ProductReviewsProvider
+  ProductReviewsCapability
 };

package/capabilities/product-search.capability.js

@@ -0,0 +1,15 @@
+import { BaseCapability } from "./base.capability.js";
+class ProductSearchCapability extends BaseCapability {
+  getResourceName() {
+    return "product-search";
+  }
+  /**
+   * Parses a facet value from the search response.
+   * @param facetValueIdentifier The identifier for the facet value.
+   * @param label The label for the facet value.
+   * @param count The count for the facet value.
+   */
+}
+export {
+  ProductSearchCapability
+};

package/{providers/product.provider.js → capabilities/product.capability.js}

@@ -1,5 +1,5 @@
-import { BaseProvider } from "./base.provider.js";
-class ProductProvider extends BaseProvider {
+import { BaseCapability } from "./base.capability.js";
+class ProductCapability extends BaseCapability {
   createEmptyProduct(id) {
     const product = {
       brand: "",
@@ -40,5 +40,5 @@ class ProductProvider extends BaseProvider {
   }
 }
 export {
-  ProductProvider
+  ProductCapability
 };

package/capabilities/profile.capability.js

@@ -0,0 +1,9 @@
+import { BaseCapability } from "./base.capability.js";
+class ProfileCapability extends BaseCapability {
+  getResourceName() {
+    return "profile";
+  }
+}
+export {
+  ProfileCapability
+};

package/capabilities/store.capability.js

@@ -0,0 +1,9 @@
+import { BaseCapability } from "./base.capability.js";
+class StoreCapability extends BaseCapability {
+  getResourceName() {
+    return "store";
+  }
+}
+export {
+  StoreCapability
+};

package/client/client-builder.js

@@ -1,12 +1,15 @@
 import { NoOpCache } from "../cache/noop-cache.js";
-import { MulticastAnalyticsProvider } from "../providers/analytics.provider.js";
+import { MulticastAnalyticsCapability } from "../capabilities/analytics.capability.js";
 import {
   RequestContextSchema
 } from "../schemas/session.schema.js";
-import { MulticastProductRecommendationsProvider } from "../providers/product-recommendations.provider.js";
+import { MulticastProductRecommendationsCapability } from "../capabilities/product-recommendations.capability.js";
 class ClientBuilder {
+  factories = [];
+  cache;
+  context;
+  collisionStrategy = "last-wins";
   constructor(context) {
-    this.factories = [];
     this.context = context;
   }
   withCapability(factory) {
@@ -14,6 +17,7 @@ class ClientBuilder {
     newBuilder.factories = [...this.factories, factory];
     newBuilder.cache = this.cache;
     newBuilder.context = this.context;
+    newBuilder.collisionStrategy = this.collisionStrategy;
     return newBuilder;
   }
   withCache(cache) {
@@ -21,6 +25,15 @@ class ClientBuilder {
     newBuilder.factories = [...this.factories];
     newBuilder.cache = cache;
     newBuilder.context = this.context;
+    newBuilder.collisionStrategy = this.collisionStrategy;
+    return newBuilder;
+  }
+  withCollisionStrategy(strategy) {
+    const newBuilder = new ClientBuilder(this.context);
+    newBuilder.factories = [...this.factories];
+    newBuilder.cache = this.cache;
+    newBuilder.context = this.context;
+    newBuilder.collisionStrategy = strategy;
     return newBuilder;
   }
   build() {
@@ -31,28 +44,47 @@ class ClientBuilder {
       throw new Error("Invalid context: " + validatedContext.error);
     }
     const mergedAnalytics = [];
-    const mergedProductRecommendationsProviders = [];
+    const mergedProductRecommendations = [];
     for (const factory of this.factories) {
-      const provider = factory(sharedCache, this.context);
-      client = {
-        ...client,
-        ...provider
-      };
-      if (provider.analytics) {
-        mergedAnalytics.push(provider.analytics);
+      const capability = this.resolveFactory(factory, sharedCache, this.context);
+      client = this.mergeCapabilities(client, capability);
+      if (capability.analytics) {
+        mergedAnalytics.push(capability.analytics);
       }
-      if (provider.productRecommendations) {
-        mergedProductRecommendationsProviders.push(provider.productRecommendations);
+      if (capability.productRecommendations) {
+        mergedProductRecommendations.push(capability.productRecommendations);
       }
     }
     const completeClient = {
       ...client,
-      analytics: new MulticastAnalyticsProvider(sharedCache, this.context, mergedAnalytics),
-      productRecommendations: new MulticastProductRecommendationsProvider(sharedCache, this.context, mergedProductRecommendationsProviders),
+      analytics: new MulticastAnalyticsCapability(sharedCache, this.context, mergedAnalytics),
+      productRecommendations: new MulticastProductRecommendationsCapability(sharedCache, this.context, mergedProductRecommendations),
       cache: sharedCache
     };
     return completeClient;
   }
+  resolveFactory(factory, cache, context) {
+    if (factory.length <= 1) {
+      return factory({ cache, context });
+    }
+    return factory(cache, context);
+  }
+  mergeCapabilities(target, source) {
+    const result = { ...target };
+    for (const key of Object.keys(source)) {
+      const hasExisting = Object.prototype.hasOwnProperty.call(result, key);
+      if (hasExisting) {
+        if (this.collisionStrategy === "first-wins") {
+          continue;
+        }
+        if (this.collisionStrategy === "throw") {
+          throw new Error(`Capability collision detected for "${key}"`);
+        }
+      }
+      result[key] = source[key];
+    }
+    return result;
+  }
 }
 export {
   ClientBuilder

package/decorators/reactionary.decorator.js

@@ -8,37 +8,35 @@ function getTracer() {
   return trace.getTracer(TRACER_NAME, TRACER_VERSION);
 }
 class ReactionaryDecoratorOptions {
-  constructor() {
-    /**
-     * Whether or not the query is eligible for caching. Queries that depend
-     * heavily on personalization, for example, are likely to be a poor fit
-     * for caching.
-     */
-    this.cache = false;
-    /**
-     * Whether or not the cache entry should be variable based on the locale
-     * of the context in which it is querried.
-     */
-    this.localeDependentCaching = false;
-    /**
-     * Whether or not the cache entry should be variable based on the currency
-     * of the context in which it is querried.
-     */
-    this.currencyDependentCaching = false;
-    /**
-     * The number of seconds which a cache entry should be considered valid for the
-     * given query.
-     */
-    this.cacheTimeToLiveInSeconds = 60;
-    /**
-     * The schema for the input (query or mutation) type, for validation purposes
-     */
-    this.inputSchema = z.unknown();
-    /**
-     * The schema for the primary output type, for validation purposes
-     */
-    this.outputSchema = z.unknown();
-  }
+  /**
+   * Whether or not the query is eligible for caching. Queries that depend
+   * heavily on personalization, for example, are likely to be a poor fit
+   * for caching.
+   */
+  cache = false;
+  /**
+   * Whether or not the cache entry should be variable based on the locale
+   * of the context in which it is querried.
+   */
+  localeDependentCaching = false;
+  /**
+   * Whether or not the cache entry should be variable based on the currency
+   * of the context in which it is querried.
+   */
+  currencyDependentCaching = false;
+  /**
+   * The number of seconds which a cache entry should be considered valid for the
+   * given query.
+   */
+  cacheTimeToLiveInSeconds = 60;
+  /**
+   * The schema for the input (query or mutation) type, for validation purposes
+   */
+  inputSchema = z.unknown();
+  /**
+   * The schema for the primary output type, for validation purposes
+   */
+  outputSchema = z.unknown();
 }
 function Reactionary(options) {
   return function(target, propertyKey, descriptor) {
@@ -54,7 +52,7 @@ function Reactionary(options) {
     let cacheStatus = "miss";
     if (!original) {
       throw new Error(
-        "@Reactionary decorator may only be applied to methods on classes extending BaseProvider."
+        "@Reactionary decorator may only be applied to methods on classes extending BaseCapability."
       );
     }
     descriptor.value = async function(...args) {

package/factories/index.js

@@ -0,0 +1,15 @@
+export * from "./cart.factory.js";
+export * from "./category.factory.js";
+export * from "./checkout.factory.js";
+export * from "./identity.factory.js";
+export * from "./inventory.factory.js";
+export * from "./order.factory.js";
+export * from "./order-search.factory.js";
+export * from "./price.factory.js";
+export * from "./product.factory.js";
+export * from "./product-associations.factory.js";
+export * from "./product-list.factory.js";
+export * from "./product-reviews.factory.js";
+export * from "./product-search.factory.js";
+export * from "./profile.factory.js";
+export * from "./store.factory.js";

package/index.js

@@ -1,6 +1,7 @@
 export * from "./cache/index.js";
 export * from "./client/index.js";
 export * from "./decorators/index.js";
-export * from "./providers/index.js";
+export * from "./factories/index.js";
+export * from "./capabilities/index.js";
 export * from "./schemas/index.js";
 export * from "./initialization.js";