@reactionary/provider-algolia 0.3.1 → 0.3.2

package/README.md

@@ -38,11 +38,19 @@ You can have more, for use with facets, and additional searchable fields, but th
 
 The `objectID` corrosponds to your productIdentifier, and `variantID` should match your SKU
 
+## Analytics
 
-## Building
+The Algolia analytics provider maps the following tracked event types to data tracked in Algolia:
 
-Run `nx build provider-algolia` to build the library.
+- AnalyticsMutationProductSummaryViewEvent => ViewedObjectIDs
+- AnalyticsMutationProductSummaryClickEvent => ClickedObjectIDsAfterSearch / ClickedObjectIDs
+- AnalyticsMutationProductAddToCartEvent => AddedToCartObjectIDsAfterSearch / AddedToCartObjectIDs
+- AnalyticsMutationPurchaseEvent => PurchasedObjectIDs
 
-## Running unit tests
+The `AfterSearch` variants are (with the exception of purchase) preferred by the provider in the cases where Algolia is the source of the events. For search or recommendation this would typically be the case, but not necesarily for users arriving on a PDP as a direct target from a search or a link.
 
-Run `nx test provider-algolia` to execute the unit tests via [Jest](https://jestjs.io).
+Note that we do not map `PurchasedObjectIDsAfterSearch` as it would require us to persist the search query ID that lead to the add-to-cart occuring on the cart items. This currently seems like an excess burden to impose on the cart interface. 
+
+The `ConvertedObjectIDs` and `ConvertedObjectIDsAfterSearch` are not mapped as they seem superfluous by all accounts in a product-purchase based flow. They could likely be used for other types of conversions in a more general setup, such as a customer finishing reading an article.
+
+Finally the events that are related to filtering are not mapped, as they are by all accounts deprecated and no longer influence any of the recommendation or personalization features.

package/core/initialize.js

@@ -1,10 +1,10 @@
-import { AlgoliaSearchProvider } from "../providers/product-search.provider.js";
+import { AlgoliaProductSearchProvider } from "../providers/product-search.provider.js";
 import { AlgoliaAnalyticsProvider } from "../providers/analytics.provider.js";
 function withAlgoliaCapabilities(configuration, capabilities) {
   return (cache, context) => {
     const client = {};
     if (capabilities.productSearch) {
-      client.productSearch = new AlgoliaSearchProvider(configuration, cache, context);
+      client.productSearch = new AlgoliaProductSearchProvider(cache, context, configuration);
     }
     if (capabilities.analytics) {
       client.analytics = new AlgoliaAnalyticsProvider(cache, context, configuration);

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@reactionary/provider-algolia",
-  "version": "0.3.1",
+  "version": "0.3.2",
   "main": "index.js",
   "types": "src/index.d.ts",
   "dependencies": {
-    "@reactionary/core": "0.3.1",
+    "@reactionary/core": "0.3.2",
     "algoliasearch": "^5.23.4",
     "zod": "4.1.9"
   },

package/providers/analytics.provider.js

@@ -2,13 +2,13 @@ import {
   AnalyticsProvider
 } from "@reactionary/core";
 import {
-  insightsClient
+  algoliasearch
 } from "algoliasearch";
 class AlgoliaAnalyticsProvider extends AnalyticsProvider {
   constructor(cache, requestContext, config) {
     super(cache, requestContext);
     this.config = config;
-    this.client = insightsClient(this.config.appId, this.config.apiKey);
+    this.client = algoliasearch(this.config.appId, this.config.apiKey).initInsights({});
   }
   async processProductAddToCart(event) {
     if (event.source && event.source.type === "search") {
@@ -21,7 +21,7 @@ class AlgoliaAnalyticsProvider extends AnalyticsProvider {
         userToken: this.context.session.identityContext.personalizationKey,
         queryID: event.source.identifier.key
       };
-      this.client.pushEvents({
+      const response = await this.client.pushEvents({
         events: [algoliaEvent]
       });
     }
@@ -37,7 +37,7 @@ class AlgoliaAnalyticsProvider extends AnalyticsProvider {
         positions: [event.position],
         queryID: event.source.identifier.key
       };
-      this.client.pushEvents({
+      const response = await this.client.pushEvents({
         events: [algoliaEvent]
       });
     }
@@ -51,7 +51,7 @@ class AlgoliaAnalyticsProvider extends AnalyticsProvider {
         objectIDs: event.products.map((x) => x.key),
         userToken: this.context.session.identityContext.personalizationKey
       };
-      this.client.pushEvents({
+      const response = await this.client.pushEvents({
         events: [algoliaEvent]
       });
     }
@@ -62,10 +62,10 @@ class AlgoliaAnalyticsProvider extends AnalyticsProvider {
       eventType: "conversion",
       eventSubtype: "purchase",
       index: this.config.indexName,
-      objectIDs: event.order.items.map((x) => x.identifier.key),
+      objectIDs: event.order.items.map((x) => x.variant.sku),
       userToken: this.context.session.identityContext.personalizationKey
     };
-    this.client.pushEvents({
+    const response = await this.client.pushEvents({
       events: [algoliaEvent]
     });
   }

package/providers/product-search.provider.js

@@ -23,8 +23,8 @@ import {
   success
 } from "@reactionary/core";
 import { algoliasearch } from "algoliasearch";
-class AlgoliaSearchProvider extends ProductSearchProvider {
-  constructor(config, cache, context) {
+class AlgoliaProductSearchProvider extends ProductSearchProvider {
+  constructor(cache, context, config) {
     super(cache, context);
     this.config = config;
   }
@@ -136,7 +136,9 @@ class AlgoliaSearchProvider extends ProductSearchProvider {
         term: query.search.term,
         facets: query.search.facets,
         filters: query.search.filters,
-        paginationOptions: query.search.paginationOptions
+        paginationOptions: query.search.paginationOptions,
+        index: body.index || "",
+        key: body.queryID || ""
       },
       pageNumber: (body.page || 0) + 1,
       pageSize: body.hitsPerPage || 0,
@@ -177,7 +179,7 @@ __decorateClass([
     inputSchema: ProductSearchQueryByTermSchema,
     outputSchema: ProductSearchResultSchema
   })
-], AlgoliaSearchProvider.prototype, "queryByTerm", 1);
+], AlgoliaProductSearchProvider.prototype, "queryByTerm", 1);
 export {
-  AlgoliaSearchProvider
+  AlgoliaProductSearchProvider
 };

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

@@ -11,9 +11,9 @@ interface AlgoliaNativeRecord {
     name?: string;
     variants: Array<AlgoliaNativeVariant>;
 }
-export declare class AlgoliaSearchProvider extends ProductSearchProvider {
+export declare class AlgoliaProductSearchProvider extends ProductSearchProvider {
     protected config: AlgoliaConfiguration;
-    constructor(config: AlgoliaConfiguration, cache: Cache, context: RequestContext);
+    constructor(cache: Cache, context: RequestContext, config: AlgoliaConfiguration);
     queryByTerm(payload: ProductSearchQueryByTerm): Promise<Result<ProductSearchResult>>;
     createCategoryNavigationFilter(payload: ProductSearchQueryCreateNavigationFilter): Promise<Result<FacetValueIdentifier>>;
     protected parseSingle(body: AlgoliaNativeRecord): {
@@ -39,6 +39,8 @@ export declare class AlgoliaSearchProvider extends ProductSearchProvider {
                 pageNumber: number;
                 pageSize: number;
             };
+            index: string;
+            key: string;
         };
         pageNumber: number;
         pageSize: number;