@coveo/quantic 3.30.2-pre.05fd9d4454 → 3.30.2-pre.90867109cf

package/README.md

@@ -46,7 +46,7 @@ Optionally install the [VSCode Salesforce Extension Pack](https://marketplace.vi
 
 - Make sure you are at the root of `packages/quantic`.
 
-- Run `pnpm run setup:examples`.
+- Run `npm run setup:examples`.
 
 This command will create two scratch orgs for you:
 
@@ -69,7 +69,7 @@ Or you can run the individual commands below.
 #### Create a Default Scratch Org
 
 - Make sure you are in the `packages/quantic` root folder.
-- Run this command to create the default scratch org. `pnpm run scratch:create`.
+- Run this command to create the default scratch org. `npm run scratch:create`.
 - In VS Code, press Command + Shift P, enter sfdx, and select SFDX: Create a Default Scratch Org.
 - You can also run this command from the command line. `sf org create scratch --set-default --definition-file config/lws-enabled-scratch-def.json --alias Quantic__LWS_enabled`
 - `Quantic__LWS_enabled` is an alias for the scratch org that you can use in other Salesforce CLI commands. You can create any alias that you like.
@@ -87,7 +87,7 @@ Example components are available as Salesforce communities (Digital Experiences)
 To set up both communities in scratch orgs, run:
 
 ```bash
-pnpm run setup:examples
+npm run setup:examples
 ```
 
 This script creates, configures, and deploys everything required to have fully working examples in **two scratch orgs**:
@@ -110,15 +110,15 @@ https://your-salesforce-lws-disabled-scratch-org-instance.force.com/examples
 Once the community has been deployed, you can deploy the `main` or `example` components to a specific org only when needed by running the corresponding commands:
 
 ```bash
-pnpm run deploy:main --target-org Quantic__LWS_enabled
-pnpm run deploy:examples --target-org Quantic__LWS_enabled
+npm run deploy:main --target-org Quantic__LWS_enabled
+npm run deploy:examples --target-org Quantic__LWS_enabled
 ```
 
 You can replace Quantic\_\_LWS_enabled with your target org alias. For example:
 
 ```bash
-pnpm run deploy:main --target-org MyCustomOrg
-pnpm run deploy:examples --target-org MyCustomOrg
+npm run deploy:main --target-org MyCustomOrg
+npm run deploy:examples --target-org MyCustomOrg
 ```
 
 ### Run Playwright for Quantic Components
@@ -130,19 +130,19 @@ pnpm run deploy:examples --target-org MyCustomOrg
 To run Playwright tests, run:
 
 ```bash
-pnpm run e2e:playwright
+npm run e2e:playwright
 ```
 
 To run Playwright tests only for the scratch org where LWS is enabled, run:
 
 ```bash
-pnpm run e2e:playwright:lws-enabled
+npm run e2e:playwright:lws-enabled
 ```
 
 To run Playwright tests only for the scratch org where LWS is disabled, run:
 
 ```bash
-pnpm run e2e:playwright:lws-disabled
+npm run e2e:playwright:lws-disabled
 ```
 
 ### Run LWC unit tests for Quantic Components
@@ -150,20 +150,20 @@ pnpm run e2e:playwright:lws-disabled
 To run LWC unit tests directly in your console, run:
 
 ```bash
-pnpm run test:unit
+npm run test:unit
 ```
 
 To run specific file/components LWC unit tests directly in your console, run:
 
 ```bash
-pnpm run test:unit -p force-app/main/default/lwc/nameOfComponent/
+npm run test:unit -p force-app/main/default/lwc/nameOfComponent/
 ```
 
 ## Use Quantic From Source
 
 After you have cloned the repository and have run `npm install`, run the following commands:
 
-- `pnpm run build`
+- `npm run build`
 - `sf project deploy start --source-dir force-app/main/default`
 
 ## Other Useful Commands

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

@@ -0,0 +1,35 @@
+<template>
+  <lightning-card title="Attached Results" icon-name="standard:attach">
+    <template lwc:if={results.length}>
+      <table class="slds-table slds-table_cell-buffer slds-table_bordered slds-table_fixed-layout">
+        <thead>
+          <tr>
+                <th style="width: 75%">Title</th>
+                <th style="width: 15%">Source</th>
+                <th style="width: 10%">Actions</th>
+          </tr>
+        </thead>
+        <tbody>
+          <template for:each={results} for:item="result">
+            <tr key={result.permanentId}>
+              <td class="slds-grid">
+                <a href={result.resultUrl} target="_blank" class="slds-truncate" title={result.title}>
+                  {result.title}
+                </a>
+              </td>
+              <td>{result.source}</td>
+              <td class="slds-text-align_center">
+                <lightning-button-icon onclick={result.handleDetach} icon-name="utility:attach" variant="bare"
+                  alternative-text="Detach Result" title="Detach Result"></lightning-button-icon>
+              </td>
+            </tr>
+          </template>
+        </tbody>
+      </table>
+
+    </template>
+    <template lwc:else>
+      <div class="slds-p-horizontal_medium slds-text-color_weak">No attached results to show.</div>
+    </template>
+  </lightning-card>
+</template>

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

@@ -0,0 +1,103 @@
+import {
+  registerComponentForInit,
+  initializeWithHeadless,
+  getHeadlessBundle,
+} from 'c/quanticHeadlessLoader';
+import { LightningElement, api, track } from 'lwc';
+// @ts-ignore
+import DetachFromCase from '@salesforce/apex/AttachToCaseController.AuraDetachFromCase';
+
+export default class QuanticAttachedResults extends LightningElement {
+  /**
+   * The ID of the engine instance the component registers to.
+   * Note: this needs to be the same as the one set in Hosted Insight Panel. it should be in the format `insight-recordId`.
+   * For example, `insight-500RL00000NA2BNYA1`, the current record id is just an example for the POC.
+   * @api
+   * @type {string}
+   */
+  engineId = `insight-500RL00000NA2BNYA1`;
+  @track results = [];
+
+  attachedResults;
+  unsubscribe;
+  headless;
+
+  connectedCallback() {
+    registerComponentForInit(this, this.engineId);
+  }
+
+  renderedCallback() {
+    initializeWithHeadless(this, this.engineId, this.initialize);
+  }
+
+  initialize = (engine) => {
+    // This component needs to do a logic similar to what the Insight Renderer does to use APEX to get the attached results saved in Salesforce and setting them in the Headless state.
+    // While doing that the loading state should be handled properly and reflected in the UI.
+    this.engine = engine;
+    this.headless = getHeadlessBundle(this.engineId);
+    this.attachedResults = this.headless.buildAttachToCase(engine, {
+      options: {
+        result: null,
+        caseId: '123', // The caseId should be dynamic based on the current record id.
+      },
+    });
+    this.unsubscribe = this.attachedResults.subscribe(() => this.updateState());
+    this.actions = {
+      ...this.headless.loadAttachedResultsActions(engine),
+      ...this.headless.loadAttachedResultsAnalyticsActions(engine),
+    };
+  };
+
+  disconnectedCallback() {
+    this.unsubscribe?.();
+  }
+
+  updateState() {
+    this.results =
+      this.attachedResults.state?.results.map((result) => ({
+        ...result,
+        handleDetach: () => {
+          this.detach(result);
+        },
+      })) || [];
+  }
+
+  detach = (result) => {
+    // Loading state should be handled properly in the UI after clicking the detach button.
+    this._isLoading = true;
+    // We detach using the attach to case APEX service. 
+    DetachFromCase({
+      uriHash: result.permanentId,
+      sfkbid: result.knowledgeArticleId,
+      caseId: '500RL00000NA2BNYA1',
+    })
+      .then((response) => {
+        const parsedResponse = JSON.parse(response);
+        if (parsedResponse?.succeeded) {
+          // we detach from the Headless state.
+          this.engine.dispatch(
+            this.actions.detachResult({ ...result, uriHash: result.permanentId }
+            )
+          );
+          // We log analytics event.
+          this.engine.dispatch(
+            this.actions.logCaseDetach({
+              ...result,
+              raw: {
+                urihash: result.permanentId,
+                permanentid: result.permanentId,
+              },
+            })
+          );
+        } else {
+          console.error('Error detaching result:', parsedResponse?.errors);
+        }
+      })
+      .catch((error) => {
+        console.error('Error detaching result:');
+      })
+      .finally(() => {
+        this._isLoading = false;
+      });
+  };
+}

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

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
+    <apiVersion>53.0</apiVersion>
+    <isExposed>true</isExposed>
+    <targets>
+        <target>lightning__RecordPage</target>
+    </targets>
+</LightningComponentBundle>