@reactionary/algolia 0.8.0 → 0.9.1

package/capabilities/analytics.capability.js

@@ -5,13 +5,18 @@ import {
   algoliasearch
 } from "algoliasearch";
 import { getProductIndexNameForLocale } from "../core/index-utils.js";
+import { hash } from "node:crypto";
 class AlgoliaAnalyticsCapability extends AnalyticsCapability {
   client;
   config;
+  authenticatedUserToken = void 0;
   constructor(cache, requestContext, config) {
     super(cache, requestContext);
     this.config = config;
     this.client = algoliasearch(this.config.appId, this.config.apiKey).initInsights({});
+    if (requestContext.session.identityContext.identity.type === "Registered") {
+      this.authenticatedUserToken = hash("sha256", requestContext.session.identityContext.identity.id.userId);
+    }
   }
   async processProductAddToCart(event) {
     if (event.source && event.source.type === "search") {
@@ -21,7 +26,8 @@ class AlgoliaAnalyticsCapability extends AnalyticsCapability {
         eventSubtype: "addToCart",
         index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
         objectIDs: [event.product.key],
-        userToken: this.context.session.identityContext.personalizationKey,
+        userToken: event.personalizationProfile?.identifier.key || "anonymous",
+        authenticatedUserToken: this.authenticatedUserToken,
         queryID: event.source.identifier.key
       };
       await this.client.pushEvents({
@@ -36,7 +42,8 @@ class AlgoliaAnalyticsCapability extends AnalyticsCapability {
         eventType: "click",
         index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
         objectIDs: [event.product.key],
-        userToken: this.context.session.identityContext.personalizationKey,
+        userToken: event.personalizationProfile?.identifier.key || "anonymous",
+        authenticatedUserToken: this.authenticatedUserToken,
         positions: [event.position],
         queryID: event.source.identifier.key
       };
@@ -52,7 +59,8 @@ class AlgoliaAnalyticsCapability extends AnalyticsCapability {
         eventType: "view",
         index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
         objectIDs: event.products.map((x) => x.key),
-        userToken: this.context.session.identityContext.personalizationKey
+        userToken: event.personalizationProfile?.identifier.key || "anonymous",
+        authenticatedUserToken: this.authenticatedUserToken
       };
       await this.client.pushEvents({
         events: [algoliaEvent]
@@ -66,7 +74,8 @@ class AlgoliaAnalyticsCapability extends AnalyticsCapability {
       eventSubtype: "purchase",
       index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
       objectIDs: event.order.items.map((x) => x.variant.sku),
-      userToken: this.context.session.identityContext.personalizationKey
+      userToken: event.personalizationProfile?.identifier.key || "anonymous",
+      authenticatedUserToken: this.authenticatedUserToken
     };
     await this.client.pushEvents({
       events: [algoliaEvent]

package/capabilities/product-recommendations.capability.js

@@ -19,11 +19,16 @@ class AlgoliaProductRecommendationsCapability extends ProductRecommendationsCapa
   getRecommendationThreshold(_algorithm) {
     return 10;
   }
-  getQueryParametersForRecommendations(algorithm) {
+  getQueryParametersForRecommendations(algorithm, query) {
+    const ruleContexts = query.personalizationProfile ? [...query.personalizationProfile.segments.map((segment) => "segment:" + segment)] : [];
+    if (query.labels) {
+      ruleContexts.push(...query.labels);
+    }
     return {
-      userToken: this.context.session.identityContext?.personalizationKey || "anonymous",
+      userToken: query.personalizationProfile?.identifier.key || "anonymous",
       analytics: true,
       analyticsTags: ["reactionary", algorithm],
+      ruleContexts,
       clickAnalytics: true
     };
   }
@@ -44,7 +49,7 @@ class AlgoliaProductRecommendationsCapability extends ProductRecommendationsCapa
             objectID: query.sourceProduct.key,
             maxRecommendations: query.numberOfRecommendations,
             threshold: this.getRecommendationThreshold("bought-together"),
-            queryParameters: this.getQueryParametersForRecommendations("bought-together")
+            queryParameters: this.getQueryParametersForRecommendations("bought-together", query)
           }
         ]
       });
@@ -77,7 +82,7 @@ class AlgoliaProductRecommendationsCapability extends ProductRecommendationsCapa
             objectID: query.sourceProduct.key,
             maxRecommendations: query.numberOfRecommendations,
             threshold: this.getRecommendationThreshold("looking-similar"),
-            queryParameters: this.getQueryParametersForRecommendations("looking-similar")
+            queryParameters: this.getQueryParametersForRecommendations("looking-similar", query)
           }
         ]
       });
@@ -110,7 +115,7 @@ class AlgoliaProductRecommendationsCapability extends ProductRecommendationsCapa
             objectID: query.sourceProduct.key,
             maxRecommendations: query.numberOfRecommendations,
             threshold: this.getRecommendationThreshold("related-products"),
-            queryParameters: this.getQueryParametersForRecommendations("related-products")
+            queryParameters: this.getQueryParametersForRecommendations("related-products", query)
           }
         ]
       });
@@ -144,7 +149,7 @@ class AlgoliaProductRecommendationsCapability extends ProductRecommendationsCapa
             facetValue: query.sourceCategory.key,
             maxRecommendations: query.numberOfRecommendations,
             threshold: this.getRecommendationThreshold("trending-items"),
-            queryParameters: this.getQueryParametersForRecommendations("trending-items")
+            queryParameters: this.getQueryParametersForRecommendations("trending-items", query)
           }
         ]
       });

package/capabilities/product-search.capability.js

@@ -40,6 +40,10 @@ class AlgoliaProductSearchCapability extends ProductSearchCapability {
     if (categoryFacet) {
       finalFilters.push(`categories:"${categoryFacet.key}"`);
     }
+    const rulesContext = [];
+    if (payload.personalizationProfile) {
+      rulesContext.push(...payload.personalizationProfile.segments.map((s) => `segment:${s}`));
+    }
     return {
       indexName: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
       query: payload.search.term,
@@ -49,7 +53,9 @@ class AlgoliaProductSearchCapability extends ProductSearchCapability {
       analytics: true,
       clickAnalytics: true,
       facetFilters: finalFacetFilters,
-      filters: finalFilters.join(" AND ")
+      filters: finalFilters.join(" AND "),
+      ruleContexts: rulesContext,
+      userToken: payload.personalizationProfile?.identifier.key || "anonymous"
     };
   }
   async queryByTerm(payload) {

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@reactionary/algolia",
-  "version": "0.8.0",
+  "version": "0.9.1",
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@reactionary/core": "0.8.0",
+    "@reactionary/core": "0.9.1",
     "zod": "4.1.9",
     "algoliasearch": "^5.48.0",
     "vitest": "^4.0.9",

package/src/capabilities/analytics.capability.d.ts

@@ -4,6 +4,7 @@ import type { AlgoliaConfiguration } from '../schema/configuration.schema.js';
 export declare class AlgoliaAnalyticsCapability extends AnalyticsCapability {
     protected client: InsightsClient;
     protected config: AlgoliaConfiguration;
+    protected authenticatedUserToken: string | undefined;
     constructor(cache: Cache, requestContext: RequestContext, config: AlgoliaConfiguration);
     protected processProductAddToCart(event: AnalyticsMutationProductAddToCartEvent): Promise<void>;
     protected processProductSummaryClick(event: AnalyticsMutationProductSummaryClickEvent): Promise<void>;

package/src/capabilities/product-recommendations.capability.d.ts

@@ -1,4 +1,4 @@
-import { type Cache, ProductRecommendationsCapability, type ProductRecommendation, type ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuery, type ProductRecommendationAlgorithmSimilarProductsQuery, type ProductRecommendationAlgorithmRelatedProductsQuery, type ProductRecommendationAlgorithmTrendingInCategoryQuery, type RequestContext, type ProductRecommendationsQuery, type ProductSearchResultItemVariant } from '@reactionary/core';
+import { type Cache, ProductRecommendationsCapability, type ProductRecommendation, type ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuery, type ProductRecommendationAlgorithmSimilarProductsQuery, type ProductRecommendationAlgorithmRelatedProductsQuery, type ProductRecommendationAlgorithmTrendingInCategoryQuery, type RequestContext, type ProductRecommendationsQuery, type ProductSearchResultItemVariant, type ProductRecommendationBaseQuery } from '@reactionary/core';
 import { type RecommendationsResults, type RecommendSearchParams, type LiteClient } from 'algoliasearch/lite';
 import type { AlgoliaConfiguration } from '../schema/configuration.schema.js';
 import type { AlgoliaProductRecommendationIdentifier } from '../schema/product-recommendation.schema.js';
@@ -17,7 +17,7 @@ export declare class AlgoliaProductRecommendationsCapability extends ProductReco
     protected client: LiteClient;
     constructor(config: AlgoliaConfiguration, cache: Cache, context: RequestContext);
     protected getRecommendationThreshold(_algorithm: string): number;
-    protected getQueryParametersForRecommendations(algorithm: string): RecommendSearchParams;
+    protected getQueryParametersForRecommendations(algorithm: string, query: ProductRecommendationBaseQuery): RecommendSearchParams;
     /**
      * Get frequently bought together recommendations using Algolia Recommend
      */

package/src/capabilities/product-search.capability.d.ts

@@ -11,10 +11,12 @@ export declare class AlgoliaProductSearchCapability<TFactory extends ProductSear
         page: number;
         hitsPerPage: number;
         facets: string[];
-        analytics: boolean;
-        clickAnalytics: boolean;
+        analytics: true;
+        clickAnalytics: true;
         facetFilters: string[];
         filters: string;
+        ruleContexts: string[];
+        userToken: string;
     };
     queryByTerm(payload: ProductSearchQueryByTerm): Promise<Result<ProductSearchFactoryOutput<TFactory>>>;
     createCategoryNavigationFilter(payload: ProductSearchQueryCreateNavigationFilter): Promise<Result<FacetValueIdentifier>>;