@coveo/quantic 3.17.1 → 3.18.0-pre.1cdc15abee

package/docs/out/quantic-docs.json

@@ -4911,6 +4911,34 @@
                     }
                 ]
             },
+            {
+                "name": "QuanticInsightPanelSummary",
+                "attribute": "quantic-insight-panel-summary",
+                "description": "<p>The <code>QuanticInsightPanelSummary</code> component is a composite component that displays a title or a Quantic Query Summary depending whether a user query is performed.</p>",
+                "categories": [
+                    "Insight Panel"
+                ],
+                "fires": "",
+                "examples": [
+                    "<c-quantic-insight-query-summary engine-id={engineId}></c-quantic-insight-query-summary>"
+                ],
+                "xmlMeta": {
+                    "apiVersion": "60.0",
+                    "isExposed": "false",
+                    "targets": []
+                },
+                "properties": [
+                    {
+                        "name": "engineId",
+                        "attribute": "engine-id",
+                        "access": "@api",
+                        "description": "<p>The ID of the engine instance the component registers to.</p>",
+                        "required": true,
+                        "defaultValue": "",
+                        "type": "string"
+                    }
+                ]
+            },
             {
                 "name": "QuanticModal",
                 "attribute": "quantic-modal",

package/force-app/main/default/labels/CustomLabels.labels-meta.xml

@@ -1610,4 +1610,11 @@
     <protected>false</protected>
     <shortDescription>Close notification</shortDescription>
   </labels>
+  <labels>
+    <fullName>quantic_InsightRelatedToThisCase</fullName>
+    <value>Insights related to this case</value>
+    <language>en_US</language>
+    <protected>false</protected>
+    <shortDescription>Insights related to this case</shortDescription>
+  </labels>
 </CustomLabels>

package/force-app/main/default/lwc/quanticInsightSummary/quanticInsightSummary.css

@@ -0,0 +1,5 @@
+.initial-summary-message {
+  background-color: #d8e6fe;
+  color: #54698d;
+  width: 100%;
+}

package/force-app/main/default/lwc/quanticInsightSummary/quanticInsightSummary.html

@@ -0,0 +1,18 @@
+<template>
+  <template lwc:if={hasInitializationError}>
+    <c-quantic-component-error component-name={template.host.localName}>
+    </c-quantic-component-error>
+  </template>
+  <template lwc:else>
+    <template if:false={hasError}>
+      <template if:false={showQuerySummary}>
+        <div data-testid="initial-summary-message" class="slds-text-title_bold initial-summary-message slds-var-p-vertical_small slds-var-p-horizontal_medium">{labels.insightRelatedToThisCase}</div>
+      </template>
+      <template if:true={showQuerySummary}>
+        <div class="slds-var-p-vertical_small slds-var-p-horizontal_medium">
+          <c-quantic-summary engine-id={engineId}></c-quantic-summary>
+        </div>
+      </template>
+    </template>
+  </template>
+</template>

package/force-app/main/default/lwc/quanticInsightSummary/quanticInsightSummary.js

@@ -0,0 +1,95 @@
+import {LightningElement, api} from 'lwc';
+import {
+  registerComponentForInit,
+  initializeWithHeadless,
+  getHeadlessBundle,
+} from 'c/quanticHeadlessLoader';
+import insightRelatedToThisCase from '@salesforce/label/c.quantic_InsightRelatedToThisCase';
+
+/** @typedef {import("coveo").InsightEngine} InsightEngine */
+/** @typedef {import("coveo").SearchBox} SearchBox */
+/** @typedef {import("coveo").QuerySummary} QuerySummary */
+
+/**
+ * The `QuanticInsightPanelSummary` component is a composite component that displays a title or a Quantic Query Summary depending whether a user query is performed.
+ * @category Insight Panel
+ * @example
+ * <c-quantic-insight-query-summary engine-id={engineId}></c-quantic-insight-query-summary>
+ */
+export default class QuanticInsightPanelSummary extends LightningElement {
+  /**
+   * The ID of the engine instance the component registers to.
+   * @api
+   * @type {string}
+   */
+  @api engineId;
+
+  labels = {
+    insightRelatedToThisCase,
+  };
+
+  /** @type {boolean} */
+  showQuerySummary = false;
+  /** @type {boolean} */
+  hasError = false;
+
+  /** @type {AnyHeadless} */
+  headless;
+  /** @type {SearchBox} */
+  searchBox;
+  /** @type {QuerySummary} */
+  querySummary;
+  /** @type {boolean} */
+  hasInitializationError;
+
+  connectedCallback() {
+    registerComponentForInit(this, this.engineId);
+  }
+
+  renderedCallback() {
+    initializeWithHeadless(this, this.engineId, this.initialize);
+  }
+
+  /**
+   * @param {InsightEngine} engine
+   */
+  initialize = (engine) => {
+    this.headless = getHeadlessBundle(this.engineId);
+    this.searchBox = this.headless.buildSearchBox(engine);
+    this.querySummary = this.headless.buildQuerySummary(engine);
+    this.unsubscribeSearchBox = this.searchBox.subscribe(() =>
+      this.updateSummaryVisibility()
+    );
+    this.unsubscribeQuerySummary = this.querySummary.subscribe(() =>
+      this.updateHasError()
+    );
+  };
+
+  disconnectedCallback() {
+    this.unsubscribeSearchBox?.();
+    this.unsubscribeQuerySummary?.();
+  }
+
+  /**
+   * Updates summary visibility.
+   * @returns {void}
+   */
+  updateSummaryVisibility() {
+    this.showQuerySummary = !!this.searchBox.state.value;
+  }
+
+  /**
+   * updates the error state of the component.
+   * @returns {void}
+   */
+  updateHasError() {
+    this.hasError = this.querySummary?.state?.hasError;
+  }
+
+  /**
+   * Sets the component in the initialization error state.
+   */
+  setInitializationError() {
+    this.hasInitializationError = true;
+  }
+}

package/force-app/main/default/lwc/quanticInsightSummary/quanticInsightSummary.js-meta.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>60.0</apiVersion>
+    <isExposed>false</isExposed>
+</LightningComponentBundle>

package/force-app/main/default/lwc/quanticResultAction/quanticResultAction.html

@@ -11,7 +11,7 @@
       </button>
     </template>
     <template if:false={loading}>
-      <lightning-button-icon-stateful onclick={handleClick} aria-label={displayedLabel} variant="border-filled"
+      <lightning-button-icon-stateful data-testid="result-action-button" onclick={handleClick} aria-label={displayedLabel} variant="border-filled"
         class={resultActionOrderClasses} icon-name={displayedIcon} selected={_selected}>
       </lightning-button-icon-stateful>
     </template>

package/force-app/main/default/staticresources/coveoheadless/case-assist/headless.js

@@ -49,4 +49,4 @@ For more information, refer to the documentation: https://docs.coveo.com/en/o3r9
  * limitations under the License.
  */if(__exports!=exports)module.exports=exports;return module.exports});
 
-window.coveoQuanticVersion = '3.17.1';
+window.coveoQuanticVersion = '3.18.0-pre.1cdc15abee';

package/force-app/main/default/staticresources/coveoheadless/headless.js

@@ -53,4 +53,4 @@ For more information, refer to the documentation: https://docs.coveo.com/en/o3r9
  * limitations under the License.
  */if(__exports!=exports)module.exports=exports;return module.exports});
 
-window.coveoQuanticVersion = '3.17.1';
+window.coveoQuanticVersion = '3.18.0-pre.1cdc15abee';

package/force-app/main/default/staticresources/coveoheadless/insight/headless.js

@@ -50,4 +50,4 @@ For more information, refer to the documentation: https://docs.coveo.com/en/o3r9
  * limitations under the License.
  */if(__exports!=exports)module.exports=exports;return module.exports});
 
-window.coveoQuanticVersion = '3.17.1';
+window.coveoQuanticVersion = '3.18.0-pre.1cdc15abee';

package/force-app/main/default/staticresources/coveoheadless/recommendation/headless.js

@@ -46,4 +46,4 @@ In order to be iterable, non-array objects must have a [Symbol.iterator]() metho
  * limitations under the License.
  */if(__exports!=exports)module.exports=exports;return module.exports});
 
-window.coveoQuanticVersion = '3.17.1';
+window.coveoQuanticVersion = '3.18.0-pre.1cdc15abee';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/quantic",
-  "version": "3.17.1",
+  "version": "3.18.0-pre.1cdc15abee",
   "description": "A Salesforce Lightning Web Component (LWC) library for building modern UIs interfacing with the Coveo platform",
   "author": "coveo.com",
   "homepage": "https://coveo.com",