simplified the way of storing the Quantic version

coveo · Nov 22, 2024 · 5025d9b · 5025d9b
1 parent 2293fb3
commit 5025d9b
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 68 deletions.
diff --git a/packages/quantic/.gitignore b/packages/quantic/.gitignore
@@ -40,7 +40,6 @@ force-app/main/default/staticresources/coveoheadless
 force-app/main/default/staticresources/coveobueno
 force-app/main/default/staticresources/marked
 force-app/main/default/staticresources/dompurify
-force-app/main/default/staticresources/quanticMetadata.json
 
 # Test Coverage & Report
 coverage

diff --git a/packages/quantic/build-static-resources.js b/packages/quantic/build-static-resources.js
@@ -25,7 +25,6 @@ const main = async () => {
   await copyBueno();
   await copyMarked();
   await copyDompurify();
-  await setupQuanticMetadata();
 };
 
 const copyDompurify = async () => {
@@ -73,22 +72,34 @@ const copyHeadless = async () => {
   await fs.mkdir(`${staticResourcesPath}/coveoheadless/definitions/`, {
     recursive: true,
   });
+
   await copy(
     '.tmp/quantic-compiled/headless.js',
     `${staticResourcesPath}/coveoheadless/headless.js`
   );
+  await writeQuanticVersion(`${staticResourcesPath}/coveoheadless/headless.js`);
   await copy(
     '.tmp/quantic-compiled/case-assist/headless.js',
     `${staticResourcesPath}/coveoheadless/case-assist/headless.js`
   );
+  await writeQuanticVersion(
+    `${staticResourcesPath}/coveoheadless/case-assist/headless.js`
+  );
+
   await copy(
     '.tmp/quantic-compiled/insight/headless.js',
     `${staticResourcesPath}/coveoheadless/insight/headless.js`
   );
+  await writeQuanticVersion(
+    `${staticResourcesPath}/coveoheadless/insight/headless.js`
+  );
   await copy(
     '.tmp/quantic-compiled/recommendation/headless.js',
     `${staticResourcesPath}/coveoheadless/recommendation/headless.js`
   );
+  await writeQuanticVersion(
+    `${staticResourcesPath}/coveoheadless/recommendation/headless.js`
+  );
   await copy(
     '../../node_modules/@coveo/headless/dist/definitions',
     `${staticResourcesPath}/coveoheadless/definitions`
@@ -120,19 +131,20 @@ const copyBueno = async () => {
   console.info('Bueno copied.');
 };
 
-const setupQuanticMetadata = async () => {
+const writeQuanticVersion = async (filePath) => {
   try {
-    console.info('Begin Quantic metadata creation');
-    const outputJsonPath = `${staticResourcesPath}/quanticMetadata.json`;
-
+    console.info('Begin Quantic version writing');
+    const existingContent = await fs.readFile(filePath, 'utf8');
     const version = await getPackageVersion();
-    const metadata = {
-      version: version,
-    };
-    fs.writeFile(outputJsonPath, JSON.stringify(metadata, null, 2), 'utf8');
-    console.info('Quantic metadata created.');
+    const contentToAppend = `\nwindow.quanticVersion = '${version}';`;
+    const endsWithNewline = existingContent.endsWith('\n');
+    const newContent = endsWithNewline
+      ? existingContent + contentToAppend
+      : existingContent + '\n' + contentToAppend;
+    await fs.writeFile(filePath, newContent, 'utf8');
+    console.info('Quantic version written.');
   } catch (error) {
-    console.error('Error occurred Quantic metadata creation: ', error);
+    console.error('Error occurred Quantic version writing: ', error);
   }
 };
 

diff --git a/packages/quantic/coveo.d.ts b/packages/quantic/coveo.d.ts
@@ -56,6 +56,7 @@ declare global {
         bundle: AnyHeadless;
       };
     };
+    coveoQuanticVersion: string
   }
 }
 

diff --git a/...antic/force-app/main/default/lwc/quanticCaseAssistInterface/quanticCaseAssistInterface.js b/...antic/force-app/main/default/lwc/quanticCaseAssistInterface/quanticCaseAssistInterface.js
@@ -8,7 +8,6 @@ import {
   HeadlessBundleNames,
 } from 'c/quanticHeadlessLoader';
 import {LightningElement, api} from 'lwc';
-import quanticMetadata from '@salesforce/resourceUrl/quanticMetadata';
 
 /** @typedef {import("coveo").CaseAssistEngine} CaseAssistEngine */
 /** @typedef {import("coveo").CaseAssistEngineOptions} CaseAssistEngineOptions */
@@ -50,19 +49,10 @@ export default class QuanticCaseAssistInterface extends LightningElement {
     loadDependencies(this, HeadlessBundleNames.caseAssist)
       .then(() => {
         if (!getHeadlessBindings(this.engineId)?.engine) {
-          const beforeInitPromises = [
-            getHeadlessConfiguration(),
-            fetch(quanticMetadata).then((response) => response.json()),
-          ];
-
-          Promise.all(beforeInitPromises)
+          getHeadlessConfiguration()
             .then((data) => {
               if (data) {
-                const {organizationId, accessToken, ...rest} = JSON.parse(
-                  data[0]
-                );
-                const {version: quanticVersion} = data[1];
-
+                const {organizationId, accessToken, ...rest} = JSON.parse(data);
                 this.engineOptions = {
                   configuration: {
                     organizationId,
@@ -78,7 +68,8 @@ export default class QuanticCaseAssistInterface extends LightningElement {
                         if (!payload.customData) {
                           payload.customData = {};
                         }
-                        payload.customData.coveoQuanticVersion = quanticVersion;
+                        payload.customData.coveoQuanticVersion =
+                          window.coveoQuanticVersion;
                         return payload;
                       },
                     },

diff --git a/...ges/quantic/force-app/main/default/lwc/quanticInsightInterface/quanticInsightInterface.js b/...ges/quantic/force-app/main/default/lwc/quanticInsightInterface/quanticInsightInterface.js
@@ -10,7 +10,6 @@ import {
   setInitializedCallback,
 } from 'c/quanticHeadlessLoader';
 import {LightningElement, api} from 'lwc';
-import quanticMetadata from '@salesforce/resourceUrl/quanticMetadata';
 
 /** @typedef {import("coveo").InsightEngine} InsightEngine */
 /** @typedef {import("coveo").InsightEngineOptions} InsightEngineOptions */
@@ -64,19 +63,10 @@ export default class QuanticInsightInterface extends LightningElement {
     loadDependencies(this, HeadlessBundleNames.insight)
       .then(() => {
         if (!getHeadlessBindings(this.engineId)?.engine) {
-          const beforeInitPromises = [
-            getHeadlessConfiguration(),
-            fetch(quanticMetadata).then((response) => response.json()),
-          ];
-
-          Promise.all(beforeInitPromises)
+          getHeadlessConfiguration()
             .then((data) => {
               if (data) {
-                const {organizationId, accessToken, ...rest} = JSON.parse(
-                  data[0]
-                );
-                const {version: quanticVersion} = data[1];
-
+                const {organizationId, accessToken, ...rest} = JSON.parse(data);
                 this.engineOptions = {
                   configuration: {
                     organizationId,
@@ -94,7 +84,8 @@ export default class QuanticInsightInterface extends LightningElement {
                         if (!payload.customData) {
                           payload.customData = {};
                         }
-                        payload.customData.coveoQuanticVersion = quanticVersion;
+                        payload.customData.coveoQuanticVersion =
+                          window.coveoQuanticVersion;
                         return payload;
                       },
                     },

diff --git a/...rce-app/main/default/lwc/quanticRecommendationInterface/quanticRecommendationInterface.js b/...rce-app/main/default/lwc/quanticRecommendationInterface/quanticRecommendationInterface.js
@@ -10,7 +10,6 @@ import {
   HeadlessBundleNames,
 } from 'c/quanticHeadlessLoader';
 import {LightningElement, api} from 'lwc';
-import quanticMetadata from '@salesforce/resourceUrl/quanticMetadata';
 
 /** @typedef {import("coveo").RecommendationEngine} RecommendationEngine */
 /** @typedef {import("coveo").RecommendationEngineOptions} RecommendationEngineOptions */
@@ -66,16 +65,9 @@ export default class QuanticRecommendationInterface extends LightningElement {
   connectedCallback() {
     loadDependencies(this, HeadlessBundleNames.recommendation).then(() => {
       if (!getHeadlessBindings(this.engineId)?.engine) {
-        const beforeInitPromises = [
-          getHeadlessConfiguration(),
-          fetch(quanticMetadata).then((response) => response.json()),
-        ];
-
-        Promise.all(beforeInitPromises).then((data) => {
+        getHeadlessConfiguration().then((data) => {
           if (data) {
-            const {organizationId, accessToken, ...rest} = JSON.parse(data[0]);
-            const {version: quanticVersion} = data[1];
-
+            const {organizationId, accessToken, ...rest} = JSON.parse(data);
             this.engineOptions = {
               configuration: {
                 organizationId,
@@ -94,7 +86,8 @@ export default class QuanticRecommendationInterface extends LightningElement {
                     if (!payload.customData) {
                       payload.customData = {};
                     }
-                    payload.customData.coveoQuanticVersion = quanticVersion;
+                    payload.customData.coveoQuanticVersion =
+                      window.coveoQuanticVersion;
                     return payload;
                   },
                 },

diff --git a/packages/quantic/force-app/main/default/lwc/quanticSearchInterface/quanticSearchInterface.js b/packages/quantic/force-app/main/default/lwc/quanticSearchInterface/quanticSearchInterface.js
@@ -2,7 +2,6 @@
 import getHeadlessConfiguration from '@salesforce/apex/HeadlessController.getHeadlessConfiguration';
 import LOCALE from '@salesforce/i18n/locale';
 import TIMEZONE from '@salesforce/i18n/timeZone';
-import quanticMetadata from '@salesforce/resourceUrl/quanticMetadata';
 import {
   getHeadlessBindings,
   loadDependencies,
@@ -90,18 +89,9 @@ export default class QuanticSearchInterface extends LightningElement {
     loadDependencies(this)
       .then(() => {
         if (!getHeadlessBindings(this.engineId)?.engine) {
-          const beforeInitPromises = [
-            getHeadlessConfiguration(),
-            fetch(quanticMetadata).then((response) => response.json()),
-          ];
-
-          Promise.all(beforeInitPromises)
+          getHeadlessConfiguration()
             .then((data) => {
-              const {organizationId, accessToken, ...rest} = JSON.parse(
-                data[0]
-              );
-              const {version: quanticVersion} = data[1];
-
+              const {organizationId, accessToken, ...rest} = JSON.parse(data);
               this.engineOptions = {
                 configuration: {
                   organizationId,
@@ -121,7 +111,8 @@ export default class QuanticSearchInterface extends LightningElement {
                       if (!payload.customData) {
                         payload.customData = {};
                       }
-                      payload.customData.coveoQuanticVersion = quanticVersion;
+                      payload.customData.coveoQuanticVersion =
+                        window.coveoQuanticVersion;
                       return payload;
                     },
                   },

diff --git a/packages/quantic/force-app/main/default/staticresources/quanticMetadata.resource-meta.xml b/packages/quantic/force-app/main/default/staticresources/quanticMetadata.resource-meta.xml