Merge pull request #110 from Relewise/feature/api-1.228.1-release

Feature: Add support for setting an evaluation mode on object facets

Author: mzanoni

packages/client/src/builders/search/dataObjectFacetBuilder.ts

@@ -21,7 +21,8 @@ export class DataObjectFacetBuilder {
             skip?: number,
             take?: number 
         },
-        facetSettings?: FacetSettings | ((facetSettingsBuilder: FacetSettingsBuilder) => void)): this {
+        facetSettings?: FacetSettings | ((facetSettingsBuilder: FacetSettingsBuilder) => void),
+        evaluationMode?: "And" | "Or"): this {
 
         const facetBuilder = new DataObjectFacetBuilder();
         if (builder) {
@@ -43,7 +44,8 @@ export class DataObjectFacetBuilder {
                 take: filter?.take,
                 skip: filter?.skip,
             },
-            settings: handleFacetSettings(facetSettings)
+            settings: handleFacetSettings(facetSettings),
+            evaluationMode: evaluationMode
         };
         this.facets.push(facet);
 

packages/client/src/builders/search/facetBuilder.ts

@@ -331,7 +331,8 @@ export class FacetBuilder {
             skip?: number,
             take?: number
         },
-        facetSettings?: FacetSettings | ((facetSettingsBuilder: FacetSettingsBuilder) => void)): this {
+        facetSettings?: FacetSettings | ((facetSettingsBuilder: FacetSettingsBuilder) => void),
+        evaluationMode?: "And" | "Or"): this {
 
         const facetBuilder = new DataObjectFacetBuilder();
         if (builder) {
@@ -355,6 +356,7 @@ export class FacetBuilder {
             dataSelectionStrategy: selectionStrategy,
             settings: handleFacetSettings(facetSettings),
             key: key,
+            evaluationMode: evaluationMode
         };
         this.facets.push(facet);
 
@@ -486,7 +488,8 @@ export class FacetBuilder {
             skip?: number,
             take?: number
         },
-        facetSettings?: FacetSettings | ((facetSettingsBuilder: FacetSettingsBuilder) => void)): this {
+        facetSettings?: FacetSettings | ((facetSettingsBuilder: FacetSettingsBuilder) => void),
+        evaluationMode?: "And" | "Or"): this {
 
         const facetBuilder = new DataObjectFacetBuilder();
         if (builder) {
@@ -509,6 +512,7 @@ export class FacetBuilder {
             },
             settings: handleFacetSettings(facetSettings),
             key: key,
+            evaluationMode: evaluationMode
         };
         this.facets.push(facet);
 
@@ -621,7 +625,8 @@ export class FacetBuilder {
             skip?: number,
             take?: number
         },
-        facetSettings?: FacetSettings | ((facetSettingsBuilder: FacetSettingsBuilder) => void)): this {
+        facetSettings?: FacetSettings | ((facetSettingsBuilder: FacetSettingsBuilder) => void),
+        evaluationMode?: "And" | "Or"): this {
 
         const facetBuilder = new DataObjectFacetBuilder();
         if (builder) {
@@ -644,6 +649,7 @@ export class FacetBuilder {
             },
             settings: handleFacetSettings(facetSettings),
             key: key,
+            evaluationMode: evaluationMode
         };
         this.facets.push(facet);
 

packages/client/src/models/data-contracts.ts

@@ -1566,6 +1566,7 @@ export type DataObjectFacet = UtilRequiredKeys<Facet, "$type"> & {
     | VariantSpecificationFacet
   )[];
   filter: DataObjectFilter;
+  evaluationMode?: "And" | "Or" | null;
 };
 
 export type DataObjectFacetResult = UtilRequiredKeys<FacetResult, "$type"> & {
@@ -1612,6 +1613,7 @@ export type DataObjectFacetResult = UtilRequiredKeys<FacetResult, "$type"> & {
       )[]
     | null;
   filter?: DataObjectFilter | null;
+  evaluationMode: "And" | "Or";
 };
 
 export interface DataObjectFilter {

packages/client/tests/integration-tests/productSearch.integration.test.ts

@@ -1,4 +1,4 @@
-import { Searcher, ProductSearchBuilder, ProductSearchRequest, UserFactory, ValueSelectorFactory, DataValueFactory, GetProductFacet, ProductAssortmentFacet, ProductDataStringValueFacetResult, CategoryFacetResult, BrandFacetResult, Tracker } from '../../src';
+import { Searcher, ProductSearchBuilder, ProductSearchRequest, UserFactory, ValueSelectorFactory, DataValueFactory, GetProductFacet, ProductAssortmentFacet, ProductDataStringValueFacetResult, CategoryFacetResult, BrandFacetResult, Tracker, ProductDataObjectFacet } from '../../src';
 import { Integrator, ProductUpdateBuilder, ProductVariantBuilder } from '@relewise/integrations';
 import { test, expect } from '@jest/globals'
 import { fail } from 'assert';
@@ -50,6 +50,40 @@ test('Product search - data object facets', async () => {
     expect(result?.hits).toBeGreaterThan(0);
 });
 
+test('Product search - data object facets evaluation mode', async () => {
+
+    const product = new ProductUpdateBuilder({
+        id: 'Object facet evaluation mode test product',
+        productUpdateKind: 'ReplaceProvidedProperties',
+    })
+        .data({
+            'ObjectForFacet': DataValueFactory.object({
+                'Key': DataValueFactory.string('data')
+            })
+        });
+
+    await integrator.updateProduct(product.build());
+
+    const request: ProductSearchRequest = baseProductBuilder()
+        .facets(f => f.addProductDataObjectFacet(
+            'ObjectForFacet',
+            'Product',
+            f => f
+                .addStringFacet('Key', [])
+                .addStringFacet('Key2', []),
+           undefined,
+           undefined,
+           'Or'))
+
+        .build();
+
+    const result = await searcher.searchProducts(request);
+    const facet = result?.facets?.items?.find(x => x.$type.includes('ProductDataObjectFacetResult'))  as ProductDataObjectFacet;
+    
+    expect(facet).toBeDefined();
+    expect(facet.evaluationMode).toBe('Or');
+});
+
 test('Product search - with cleared facets', async () => {
     const request = baseProductBuilder()
         .facets(f => f.addBrandFacet());