Merge branch 'master' into KIT-2606_headless_react_utils

https://coveord.atlassian.net/browse/KIT-2606
coveo · Aug 23, 2023 · 1dfa9ff · 1dfa9ff
2 parents 9f6c551 + c75c586
commit 1dfa9ff
Show file tree

Hide file tree

Showing 49 changed files with 1,728 additions and 2,615 deletions.
diff --git a/.gitignore b/.gitignore
@@ -11,7 +11,7 @@ reports/*.xml
 sarifs
 **.cy.ts.mp4
 .cspellcache
-utils/translation-gpt/temporary.json
+scripts/translation-gpt/temporary.json
 
 # CI Release
 topology.json

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/atomic-angular/package.json b/packages/atomic-angular/package.json
@@ -18,11 +18,11 @@
     "@angular/platform-browser": "16.0.2",
     "@angular/platform-browser-dynamic": "16.0.2",
     "@angular/router": "16.0.2",
-    "@coveo/atomic": "2.40.2",
+    "@coveo/atomic": "2.41.0",
     "rxjs": "7.5.6"
   },
   "peerDependencies": {
-    "@coveo/headless": "2.26.1"
+    "@coveo/headless": "2.27.0"
   },
   "devDependencies": {
     "@angular-devkit/build-angular": "16.0.2",
@@ -39,6 +39,6 @@
     "ncp": "2.0.0",
     "ng-packagr": "16.0.1",
     "typescript": "4.9.5",
-    "@coveo/headless": "2.26.1"
+    "@coveo/headless": "2.27.0"
   }
 }
diff --git a/packages/atomic-angular/projects/atomic-angular/CHANGELOG.md b/packages/atomic-angular/projects/atomic-angular/CHANGELOG.md
@@ -1,3 +1,9 @@
+# 2.13.0 (2023-08-21)
+
+### Features
+
+- **atomic, headless:** add numberOfValues property in automatic facet generator ([#3101](https://github.com/coveo/ui-kit/issues/3101)) ([8fcd1ed](https://github.com/coveo/ui-kit/commits/8fcd1edba96c2226ddc9fca6c3774e9842f3bca2))
+
 # 2.12.0 (2023-08-09)
 
 ### Features

diff --git a/packages/atomic-angular/projects/atomic-angular/package.json b/packages/atomic-angular/projects/atomic-angular/package.json
@@ -1,14 +1,14 @@
 {
   "name": "@coveo/atomic-angular",
-  "version": "2.12.3",
+  "version": "2.13.0",
   "license": "Apache-2.0",
   "peerDependencies": {
     "@angular/common": "14 - 16",
     "@angular/core": "14 - 16",
-    "@coveo/headless": "2.26.1"
+    "@coveo/headless": "2.27.0"
   },
   "dependencies": {
-    "@coveo/atomic": "2.40.2",
+    "@coveo/atomic": "2.41.0",
     "tslib": "2.4.0"
   }
 }
diff --git a/packages/atomic-angular/projects/atomic-angular/src/lib/stencil-generated/components.ts b/packages/atomic-angular/projects/atomic-angular/src/lib/stencil-generated/components.ts
@@ -52,13 +52,13 @@ export declare interface AtomicAutomaticFacetGenerator extends Components.Atomic
 
 @ProxyCmp({
   defineCustomElementFn: undefined,
-  inputs: ['areCollapsed', 'desiredCount']
+  inputs: ['areCollapsed', 'desiredCount', 'numberOfValues']
 })
 @Component({
   selector: 'atomic-automatic-facet-generator',
   changeDetection: ChangeDetectionStrategy.OnPush,
   template: '<ng-content></ng-content>',
-  inputs: ['areCollapsed', 'desiredCount']
+  inputs: ['areCollapsed', 'desiredCount', 'numberOfValues']
 })
 export class AtomicAutomaticFacetGenerator {
   protected el: HTMLElement;

diff --git a/packages/atomic-hosted-page/package.json b/packages/atomic-hosted-page/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@coveo/atomic-hosted-page",
   "description": "Web Component used to inject a Coveo Hosted Search Page in the DOM.",
-  "version": "0.3.26",
+  "version": "0.3.27",
   "repository": {
     "type": "git",
     "url": "https://github.com/coveo/ui-kit.git",
@@ -32,7 +32,7 @@
   },
   "dependencies": {
     "@coveo/bueno": "0.43.7",
-    "@coveo/headless": "2.26.1",
+    "@coveo/headless": "2.27.0",
     "@stencil/core": "2.17.3"
   },
   "devDependencies": {

diff --git a/packages/atomic-react/package.json b/packages/atomic-react/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@coveo/atomic-react",
   "sideEffects": false,
-  "version": "2.5.6",
+  "version": "2.5.7",
   "description": "React specific wrapper for the Atomic component library",
   "repository": {
     "type": "git",
@@ -28,10 +28,10 @@
     "recommendation/"
   ],
   "dependencies": {
-    "@coveo/atomic": "2.40.2"
+    "@coveo/atomic": "2.41.0"
   },
   "devDependencies": {
-    "@coveo/headless": "2.26.1",
+    "@coveo/headless": "2.27.0",
     "@rollup/plugin-commonjs": "^22.0.2",
     "@rollup/plugin-node-resolve": "^14.1.0",
     "@rollup/plugin-replace": "^4.0.0",
@@ -47,7 +47,7 @@
     "rollup-plugin-terser": "^7.0.2"
   },
   "peerDependencies": {
-    "@coveo/headless": "2.26.1",
+    "@coveo/headless": "2.27.0",
     "react": ">=18.0.0",
     "react-dom": ">=18.0.0"
   }

diff --git a/packages/atomic/CHANGELOG.md b/packages/atomic/CHANGELOG.md
@@ -1,3 +1,9 @@
+# 2.41.0 (2023-08-21)
+
+### Features
+
+- **atomic, headless:** add numberOfValues property in automatic facet generator ([#3101](https://github.com/coveo/ui-kit/issues/3101)) ([8fcd1ed](https://github.com/coveo/ui-kit/commits/8fcd1edba96c2226ddc9fca6c3774e9842f3bca2))
+
 ## 2.40.2 (2023-08-16)
 
 ### Bug Fixes

diff --git a/packages/atomic/cypress/e2e/search-interface.cypress.ts b/packages/atomic/cypress/e2e/search-interface.cypress.ts
@@ -152,7 +152,9 @@ describe('Search Interface Component', () => {
       // - searchHub = 'testing hub'
       // - pipeline = 'testing';
       // - userDisplayname = 'Alice Smith';
+
       const accessToken =
+        // eslint-disable-next-line @cspell/spellchecker
         'eyJhbGciOiJIUzI1NiJ9.eyJwaXBlbGluZSI6InRlc3RpbmciLCJzZWFyY2hIdWIiOiJ0ZXN0aW5nIGh1YiIsInY4Ijp0cnVlLCJvcmdhbml6YXRpb24iOiJzZWFyY2h1aXNhbXBsZXMiLCJ1c2VySWRzIjpbeyJhdXRoQ29va2llIjoiIiwicHJvdmlkZXIiOiJFbWFpbCBTZWN1cml0eSBQcm92aWRlciIsIm5hbWUiOiJhc21pdGhAZXhhbXBsZS5jb20iLCJ0eXBlIjoiVXNlciIsImluZm9zIjp7fX1dLCJyb2xlcyI6WyJxdWVyeUV4ZWN1dG9yIl0sInVzZXJEaXNwbGF5TmFtZSI6IkFsaWNlIFNtaXRoIiwiZXhwIjoxNjQ2NzUzNDM0LCJpYXQiOjE2NDY2NjcwMzR9.p70UUYXKmg3sHU961G1Vmwp45qp8EgxvHisPMk-RUPw';
       const tokenPipeline = 'testing';
       const tokenSearchHub = 'testing hub';
@@ -261,7 +263,7 @@ describe('Search Interface Component', () => {
     it('should work with lowercase regions', () => {
       setLanguageAndWait('zh-tw');
 
-      QuerySummarySelectors.text().should('contain', '结果数');
+      QuerySummarySelectors.text().should('contain', '結果數');
     });
 
     it('should support adding a non-existing language', () => {

diff --git a/packages/atomic/package.json b/packages/atomic/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@coveo/atomic",
-  "version": "2.40.2",
+  "version": "2.41.0",
   "description": "A web-component library for building modern UIs interfacing with the Coveo platform",
   "homepage": "https://docs.coveo.com/en/atomic/latest/",
   "repository": {
@@ -63,7 +63,7 @@
   },
   "devDependencies": {
     "@babel/core": "7.18.10",
-    "@coveo/headless": "2.26.1",
+    "@coveo/headless": "2.27.0",
     "@fullhuman/postcss-purgecss": "4.1.3",
     "@rollup/plugin-alias": "3.1.9",
     "@rollup/plugin-replace": "2.4.2",
@@ -96,7 +96,7 @@
     "tailwindcss": "3.3.3"
   },
   "peerDependencies": {
-    "@coveo/headless": "2.26.1"
+    "@coveo/headless": "2.27.0"
   },
   "license": "Apache-2.0",
   "engines": {

diff --git a/packages/atomic/src/components.d.ts b/packages/atomic/src/components.d.ts
@@ -46,9 +46,15 @@ export namespace Components {
          */
         "areCollapsed": boolean;
         /**
-          * @beta - This prop is part of the automatic facets feature. Automatic facets are currently in beta testing and should be available soon.  The desired count of automatic facets. Must be a positive integer.
+          * @beta - This prop is part of the automatic facets feature. Automatic facets are currently in beta testing and should be available soon.  The desired count of automatic facets.  Minimum: `1` Maximum: `10`
+          * @defaultValue `5`
          */
         "desiredCount": number;
+        /**
+          * @beta - This prop is part of the automatic facets feature. Automatic facets are currently in beta testing and should be available soon.  The desired number of automatically generated facet values.  Minimum: `1`
+          * @defaultValue `8`
+         */
+        "numberOfValues": number;
     }
     interface AtomicAutomaticFacetSlotContent {
         "isThereStaticFacets": boolean;
@@ -3040,9 +3046,15 @@ declare namespace LocalJSX {
          */
         "areCollapsed"?: boolean;
         /**
-          * @beta - This prop is part of the automatic facets feature. Automatic facets are currently in beta testing and should be available soon.  The desired count of automatic facets. Must be a positive integer.
+          * @beta - This prop is part of the automatic facets feature. Automatic facets are currently in beta testing and should be available soon.  The desired count of automatic facets.  Minimum: `1` Maximum: `10`
+          * @defaultValue `5`
          */
         "desiredCount": number;
+        /**
+          * @beta - This prop is part of the automatic facets feature. Automatic facets are currently in beta testing and should be available soon.  The desired number of automatically generated facet values.  Minimum: `1`
+          * @defaultValue `8`
+         */
+        "numberOfValues"?: number;
     }
     interface AtomicAutomaticFacetSlotContent {
         "isThereStaticFacets": boolean;

diff --git a/...nents/search/facets/atomic-automatic-facet-generator/atomic-automatic-facet-generator.tsx b/...nents/search/facets/atomic-automatic-facet-generator/atomic-automatic-facet-generator.tsx
@@ -49,7 +49,10 @@ export class AtomicAutomaticFacetGenerator implements InitializableComponent {
    * Automatic facets are currently in beta testing and should be available soon.
    *
    * The desired count of automatic facets.
-   * Must be a positive integer.
+   *
+   * Minimum: `1`
+   * Maximum: `10`
+   * @defaultValue `5`
    */
   @Prop() public desiredCount!: number;
 
@@ -61,13 +64,27 @@ export class AtomicAutomaticFacetGenerator implements InitializableComponent {
    */
   @Prop() public areCollapsed = true;
 
+  /**
+   * @beta - This prop is part of the automatic facets feature.
+   * Automatic facets are currently in beta testing and should be available soon.
+   *
+   * The desired number of automatically generated facet values.
+   *
+   * Minimum: `1`
+   * @defaultValue `8`
+   */
+  @Prop() public numberOfValues = 8;
+
   public initialize() {
     this.validateProps();
     this.searchStatus = buildSearchStatus(this.bindings.engine);
     this.automaticFacetGenerator = buildAutomaticFacetGenerator(
       this.bindings.engine,
       {
-        desiredCount: this.desiredCount,
+        options: {
+          desiredCount: this.desiredCount,
+          numberOfValues: this.numberOfValues,
+        },
       }
     );
   }
@@ -96,7 +113,10 @@ export class AtomicAutomaticFacetGenerator implements InitializableComponent {
       });
     if (!this.searchStatus.state.firstSearchExecuted) {
       return Array.from({length: this.desiredCount}, () => (
-        <FacetPlaceholder numberOfValues={8} isCollapsed={this.areCollapsed} /> //TODO: Change '8' to variable whenever adding the 'numberOfValues' attribute in the AF query
+        <FacetPlaceholder
+          numberOfValues={this.numberOfValues}
+          isCollapsed={this.areCollapsed}
+        />
       ));
     }
 

diff --git a/...search/facets/atomic-automatic-facet-slot-content/atomic-automatic-facet-slot-content.tsx b/...search/facets/atomic-automatic-facet-slot-content/atomic-automatic-facet-slot-content.tsx
@@ -38,10 +38,17 @@ export class AtomicAutomaticFacetSlotContent implements InitializableComponent {
   public initialize() {
     const desiredCount =
       this.bindings.engine.state.automaticFacetSet?.desiredCount;
+    const numberOfValues =
+      this.bindings.engine.state.automaticFacetSet?.numberOfValues;
     if (desiredCount) {
       this.automaticFacetGenerator = buildAutomaticFacetGenerator(
         this.bindings.engine,
-        {desiredCount}
+        {
+          options: {
+            desiredCount,
+            numberOfValues,
+          },
+        }
       );
     }
     this.searchStatus = buildSearchStatus(this.bindings.engine);