@reactionary/algolia 0.10.24 → 0.10.26

package/capabilities/analytics.capability.js

@@ -27,7 +27,7 @@ class AlgoliaAnalyticsCapability extends AnalyticsCapability {
         eventName: "addToCart",
         eventType: "conversion",
         eventSubtype: "addToCart",
-        index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
+        index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale, this.config),
         objectIDs: [event.product.key],
         userToken: event.personalizationProfile?.identifier.key || "anonymous",
         authenticatedUserToken: this.authenticatedUserToken,
@@ -45,7 +45,7 @@ class AlgoliaAnalyticsCapability extends AnalyticsCapability {
       const algoliaEvent = {
         eventName: "click",
         eventType: "click",
-        index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
+        index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale, this.config),
         objectIDs: [event.product.key],
         userToken: event.personalizationProfile?.identifier.key || "anonymous",
         authenticatedUserToken: this.authenticatedUserToken,
@@ -64,7 +64,7 @@ class AlgoliaAnalyticsCapability extends AnalyticsCapability {
       const algoliaEvent = {
         eventName: "view",
         eventType: "view",
-        index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
+        index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale, this.config),
         objectIDs: event.products.map((x) => x.key),
         userToken: event.personalizationProfile?.identifier.key || "anonymous",
         authenticatedUserToken: this.authenticatedUserToken
@@ -81,7 +81,7 @@ class AlgoliaAnalyticsCapability extends AnalyticsCapability {
       eventName: "purchase",
       eventType: "conversion",
       eventSubtype: "purchase",
-      index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
+      index: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale, this.config),
       objectIDs: event.order.items.map((x) => x.variant.sku),
       userToken: event.personalizationProfile?.identifier.key || "anonymous",
       authenticatedUserToken: this.authenticatedUserToken

package/capabilities/product-recommendations.capability.js

@@ -1,7 +1,8 @@
 import {
   ProductRecommendationsCapability,
   ProductSearchResultItemVariantSchema,
-  ImageSchema
+  ImageSchema,
+  ProductSearchResultItemComplianceDataSchema
 } from "@reactionary/core";
 import {
   liteClient
@@ -44,7 +45,7 @@ class AlgoliaProductRecommendationsCapability extends ProductRecommendationsCapa
       const response = await this.client.getRecommendations({
         requests: [
           {
-            indexName: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
+            indexName: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale, this.config),
             model: "bought-together",
             objectID: query.sourceProduct.key,
             maxRecommendations: query.numberOfRecommendations,
@@ -77,7 +78,7 @@ class AlgoliaProductRecommendationsCapability extends ProductRecommendationsCapa
       const response = await this.client.getRecommendations({
         requests: [
           {
-            indexName: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
+            indexName: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale, this.config),
             model: "looking-similar",
             objectID: query.sourceProduct.key,
             maxRecommendations: query.numberOfRecommendations,
@@ -110,7 +111,7 @@ class AlgoliaProductRecommendationsCapability extends ProductRecommendationsCapa
       const response = await this.client.getRecommendations({
         requests: [
           {
-            indexName: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
+            indexName: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale, this.config),
             model: "related-products",
             objectID: query.sourceProduct.key,
             maxRecommendations: query.numberOfRecommendations,
@@ -143,7 +144,7 @@ class AlgoliaProductRecommendationsCapability extends ProductRecommendationsCapa
       const response = await this.client.getRecommendations({
         requests: [
           {
-            indexName: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
+            indexName: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale, this.config),
             model: "trending-items",
             facetName: "categories",
             facetValue: query.sourceCategory.key,
@@ -195,10 +196,14 @@ class AlgoliaProductRecommendationsCapability extends ProductRecommendationsCapa
       identifier: { key: body.objectID },
       name: body.name || body.objectID,
       slug: body.slug || body.objectID,
-      variants: [...body.variants || []].map((variant) => this.parseVariant(variant, body))
+      variants: [...body.variants || []].map((variant) => this.parseVariant(variant, body)),
+      complianceData: this.parseComplianceData(body)
     };
     return product;
   }
+  parseComplianceData(body) {
+    return body.complianceData ?? ProductSearchResultItemComplianceDataSchema.parse({});
+  }
   parseVariant(variant, product) {
     const result = ProductSearchResultItemVariantSchema.parse({
       variant: {

package/capabilities/product-search.capability.js

@@ -44,7 +44,7 @@ class AlgoliaProductSearchCapability extends ProductSearchCapability {
       rulesContext.push(...payload.personalizationProfile.segments.map((s) => `segment_${s}`));
     }
     return {
-      indexName: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale),
+      indexName: getProductIndexNameForLocale(this.config.indexName, this.context.languageContext.locale, this.config),
       query: payload.search.term,
       page: payload.search.paginationOptions.pageNumber - 1,
       hitsPerPage: payload.search.paginationOptions.pageSize,

package/core/index-utils.js

@@ -1,6 +1,6 @@
-function getProductIndexNameForLocale(baseIndexName, locale) {
+function getProductIndexNameForLocale(baseIndexName, locale, config) {
   const localeShortCode = locale.split("-")[0];
-  if (localeShortCode === "en") {
+  if (localeShortCode === "en" && config.useBaseIndexNameForEnglishLocale) {
     return baseIndexName;
   }
   return `${baseIndexName}_${localeShortCode}`;

package/factories/product-search/product-search.factory.js

@@ -4,6 +4,7 @@ import {
   ImageSchema,
   ProductSearchResultFacetSchema,
   ProductSearchResultFacetValueSchema,
+  ProductSearchResultItemComplianceDataSchema,
   ProductSearchResultItemVariantSchema
 } from "@reactionary/core";
 class AlgoliaProductSearchFactory {
@@ -61,11 +62,15 @@ class AlgoliaProductSearchFactory {
     };
     return this.productSearchResultSchema.parse(result);
   }
+  parseComplianceData(data) {
+    return data.complianceData ?? ProductSearchResultItemComplianceDataSchema.parse({});
+  }
   parseSingle(body) {
     return {
       identifier: { key: body.objectID },
       name: body.name || body.objectID,
       slug: body.slug || body.objectID,
+      complianceData: this.parseComplianceData(body),
       variants: [...body.variants || []].map(
         (variant) => this.parseVariant(variant, body)
       )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactionary/algolia",
-  "version": "0.10.24",
+  "version": "0.10.26",
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts",
@@ -9,7 +9,7 @@
     "url": "git+https://github.com/Solteq/reactionary.git"
   },
   "dependencies": {
-    "@reactionary/core": "0.10.24",
+    "@reactionary/core": "0.10.26",
     "zod": "4.1.9",
     "algoliasearch": "^5.48.0"
   },

package/schema/configuration.schema.js

@@ -3,7 +3,8 @@ const AlgoliaConfigurationSchema = z.looseObject({
   appId: z.string(),
   apiKey: z.string(),
   indexName: z.string(),
-  useRecommendationsForBots: z.boolean().default(false).meta({ description: "Whether to use recommendations for bot traffic. By default, recommendations are not used for bots to save on API costs, but enabling this can provide a better experience for bot traffic such as search engine crawlers." })
+  useRecommendationsForBots: z.boolean().default(false).meta({ description: "Whether to use recommendations for bot traffic. By default, recommendations are not used for bots to save on API costs, but enabling this can provide a better experience for bot traffic such as search engine crawlers." }),
+  useBaseIndexNameForEnglishLocale: z.boolean().default(true).meta({ description: "Deprecated. When possible, move to all indexes with locale suffix. Whether to use the base name for the English locale. By default, this is enabled.", deprecated: true })
 });
 export {
   AlgoliaConfigurationSchema

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, type ProductRecommendationBaseQuery } from '@reactionary/core';
+import { type Cache, ProductRecommendationsCapability, type ProductRecommendation, type ProductRecommendationAlgorithmFrequentlyBoughtTogetherQuery, type ProductRecommendationAlgorithmSimilarProductsQuery, type ProductRecommendationAlgorithmRelatedProductsQuery, type ProductRecommendationAlgorithmTrendingInCategoryQuery, type RequestContext, type ProductRecommendationsQuery, type ProductSearchResultItem, type ProductSearchResultItemVariant, type ProductRecommendationBaseQuery, type ProductSearchResultItemComplianceData } 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';
@@ -83,6 +83,14 @@ export declare class AlgoliaProductRecommendationsCapability extends ProductReco
                     };
                 } | undefined;
             }[];
+            complianceData?: {
+                ce_marking: boolean;
+                weee_symbol: boolean;
+                energy_class?: string | undefined;
+                garan_duration?: number | undefined;
+                is_organic?: boolean | undefined;
+                organic_certification_type?: string | undefined;
+            } | undefined;
         };
     } & {
         _?: never;
@@ -91,13 +99,7 @@ export declare class AlgoliaProductRecommendationsCapability extends ProductReco
      * Maps Algolia recommendation results to ProductRecommendation format
      */
     protected parseSingle(hit: AlgoliaNativeRecord, recommendationIdentifier: AlgoliaProductRecommendationIdentifier): ProductRecommendation;
-    protected parseSearchResultItem(body: AlgoliaNativeRecord): {
-        identifier: {
-            key: string;
-        };
-        name: string;
-        slug: string;
-        variants: ProductSearchResultItemVariant[];
-    };
+    protected parseSearchResultItem(body: AlgoliaNativeRecord): ProductSearchResultItem;
+    protected parseComplianceData(body: AlgoliaNativeRecord): ProductSearchResultItemComplianceData;
     protected parseVariant(variant: AlgoliaNativeVariant, product: AlgoliaNativeRecord): ProductSearchResultItemVariant;
 }

package/src/core/index-utils.d.ts

@@ -1 +1,2 @@
-export declare function getProductIndexNameForLocale(baseIndexName: string, locale: string): string;
+import type { AlgoliaConfiguration } from "../schema/configuration.schema.js";
+export declare function getProductIndexNameForLocale(baseIndexName: string, locale: string, config: AlgoliaConfiguration): string;

package/src/factories/product-search/product-search.factory.d.ts

@@ -1,4 +1,4 @@
-import type { AnyProductSearchResultSchema, FacetIdentifier, FacetValueIdentifier, ProductSearchFactory, ProductSearchQueryByTerm, ProductSearchResultFacet, ProductSearchResultFacetValue, ProductSearchResultItem, ProductSearchResultItemVariant, RequestContext } from '@reactionary/core';
+import type { AnyProductSearchResultSchema, FacetIdentifier, FacetValueIdentifier, ProductSearchFactory, ProductSearchQueryByTerm, ProductSearchResultFacet, ProductSearchResultFacetValue, ProductSearchResultItem, ProductSearchResultItemComplianceData, ProductSearchResultItemVariant, RequestContext } from '@reactionary/core';
 import type * as z from 'zod';
 import type { SearchResponse } from 'algoliasearch';
 import type { AlgoliaNativeRecord, AlgoliaNativeVariant } from '../../schema/search.schema.js';
@@ -7,6 +7,7 @@ export declare class AlgoliaProductSearchFactory<TProductSearchResultSchema exte
     readonly productSearchResultSchema: TProductSearchResultSchema;
     constructor(productSearchResultSchema: TProductSearchResultSchema);
     parseSearchResult(_context: RequestContext, data: unknown, query: ProductSearchQueryByTerm): z.output<TProductSearchResultSchema>;
+    protected parseComplianceData(data: AlgoliaNativeRecord): ProductSearchResultItemComplianceData;
     protected parseSingle(body: AlgoliaNativeRecord): ProductSearchResultItem;
     protected parseVariant(variant: AlgoliaNativeVariant, product: AlgoliaNativeRecord): ProductSearchResultItemVariant;
     protected parseFacet(facetIdentifier: FacetIdentifier, facetValues: Record<string, number>): ProductSearchResultFacet;

package/src/schema/configuration.schema.d.ts

@@ -4,5 +4,6 @@ export declare const AlgoliaConfigurationSchema: z.ZodObject<{
     apiKey: z.ZodString;
     indexName: z.ZodString;
     useRecommendationsForBots: z.ZodDefault<z.ZodBoolean>;
+    useBaseIndexNameForEnglishLocale: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$loose>;
 export type AlgoliaConfiguration = z.infer<typeof AlgoliaConfigurationSchema>;

package/src/schema/search.schema.d.ts

@@ -1,3 +1,4 @@
+import { type ProductSearchResultItemComplianceData } from '@reactionary/core';
 import * as z from 'zod';
 export declare const AlgoliaProductSearchIdentifierSchema: z.ZodObject<{
     term: z.ZodString;
@@ -35,6 +36,14 @@ export declare const AlgoliaProductSearchResultSchema: z.ZodObject<{
         }, z.core.$loose>;
         name: z.ZodString;
         slug: z.ZodString;
+        complianceData: z.ZodOptional<z.ZodObject<{
+            ce_marking: z.ZodDefault<z.ZodBoolean>;
+            weee_symbol: z.ZodDefault<z.ZodBoolean>;
+            energy_class: z.ZodOptional<z.ZodString>;
+            garan_duration: z.ZodOptional<z.ZodNumber>;
+            is_organic: z.ZodOptional<z.ZodBoolean>;
+            organic_certification_type: z.ZodOptional<z.ZodString>;
+        }, z.core.$loose>>;
         variants: z.ZodArray<z.ZodObject<{
             variant: z.ZodObject<{
                 sku: z.ZodString;
@@ -116,4 +125,5 @@ export interface AlgoliaNativeRecord {
     slug?: string;
     name?: string;
     variants: Array<AlgoliaNativeVariant>;
+    complianceData?: ProductSearchResultItemComplianceData;
 }

package/test/client-builder-product-search-extension.example.js

@@ -34,7 +34,8 @@ const config = {
   appId: "ALGOLIA_APP_ID",
   apiKey: "ALGOLIA_API_KEY",
   indexName: "ALGOLIA_INDEX",
-  useRecommendationsForBots: false
+  useRecommendationsForBots: false,
+  useBaseIndexNameForEnglishLocale: true
 };
 const client = new ClientBuilder(createInitialRequestContext()).withCache(new NoOpCache()).withCapability(
   withAlgoliaCapabilities(config, {