@salesforcedevs/dx-components 0.10.1-alpha.96 → 0.10.1-alpha.97

package/src/modules/dx/sidebarSearchResult/__tests__/sidebarSearchResult.test.ts

@@ -39,4 +39,17 @@ describe(TAG, () => {
 
         return expect(element).toBeAccessible();
     });
+
+    it("doesn't add bold class when there is no highlighted term", () => {
+        const element = render({
+            ...PROPS,
+            descriptionHighlights: [],
+            titleHighlights: []
+        });
+
+        const selected = element.shadowRoot.querySelector(".bold");
+        expect(selected).toBeNull();
+
+        return expect(element).toBeAccessible();
+    });
 });

package/src/modules/dx/sidebarSearchResult/sidebarSearchResult.css

@@ -25,7 +25,6 @@ a {
 
 .title {
     color: var(--dx-g-text-heading-color);
-    font-weight: 600;
 }
 
 .bold {

package/src/modules/utils/coveo/coveo.ts

@@ -1,25 +1,60 @@
-import { buildSearchEngine as _buildSearchEngine } from "@coveo/headless";
+import {
+    buildSearchEngine as _buildSearchEngine,
+    SearchAppState,
+    SearchEngineOptions
+} from "@coveo/headless";
 
 export const buildSearchEngine = ({
     organizationId,
+    preloadedState,
     publicAccessToken,
-    searchPipeline: pipeline,
-    searchHub
+    searchHub,
+    searchPipeline
 }: {
     organizationId: string;
     publicAccessToken: string;
     searchPipeline: string;
     searchHub: string;
+    preloadedState: SearchAppState;
 }) => {
-    const search = pipeline ? { pipeline, searchHub } : { searchHub };
-    return _buildSearchEngine({
-        configuration: {
-            organizationId,
-            accessToken: publicAccessToken,
-            search
-        }
-    });
+    const search = searchPipeline
+        ? { pipeline: searchPipeline, searchHub }
+        : { searchHub };
+
+    const configuration = {
+        accessToken: publicAccessToken,
+        organizationId,
+        search
+    };
+
+    const engineConfiguration: SearchEngineOptions = preloadedState
+        ? { configuration, preloadedState }
+        : { configuration };
+
+    return _buildSearchEngine(engineConfiguration);
 };
 
 export const getSidebarSearchParams = () =>
     new URLSearchParams(window.location.search).get("q");
+
+export const coveoXMLDocsConfig = {
+    coveoOrganizationId: "coveosalesforcetestakshatha",
+    coveoPublicAccessToken: "xxfeb39525-e402-4e41-a870-7132441f7875",
+    coveoSearchHub: "Developer_Docs_SS",
+    coveoAdvancedQueryConfig: JSON.stringify({
+        objecttype: "HTDeveloperDocumentsC",
+        sflanguage: "en_US",
+        sfrelease__c: "232.0",
+        sfdelivarable__c: "apexcode"
+    })
+};
+
+export const coveoSFDocsConfig = {
+    coveoOrganizationId: "coveosalesforcetestakshatha",
+    coveoPublicAccessToken: "xxfeb39525-e402-4e41-a870-7132441f7875",
+    coveoSearchHub: "Developer_MdDocs_SS",
+    coveoAdvancedQueryConfig: JSON.stringify({
+        source: "Sitemap - Developer Docs",
+        path_segment_3: "pardot"
+    })
+};

package/src/modules/utils/recentSearches/__tests__/recentSearches.test.ts

@@ -0,0 +1,79 @@
+import { RecentSearches, LOCAL_STORAGE_KEY, LIMIT } from "utils/recentSearches";
+
+describe("recentSearches", () => {
+    beforeEach(() => {
+        window.localStorage.clear();
+    });
+
+    it("initializes correctly from local storage", () => {
+        const initial = ["test", "test1", "test2"];
+
+        window.localStorage.setItem(LOCAL_STORAGE_KEY, JSON.stringify(initial));
+        const Searches = new RecentSearches();
+
+        expect(Searches.get()).toEqual(initial);
+    });
+
+    it("ignores exact duplicate additions", () => {
+        const Searches = new RecentSearches();
+
+        const item = "test";
+
+        Searches.add(item);
+        Searches.add(item);
+
+        expect(Searches.get().length).toEqual(1);
+    });
+
+    it("ignores duplicate additions with extraneous white space", () => {
+        const Searches = new RecentSearches();
+
+        const item1 = "test";
+        const item2 = " test ";
+
+        Searches.add(item1);
+        Searches.add(item2);
+
+        expect(Searches.get().length).toEqual(1);
+        expect(Searches.get()[0]).toEqual(item1);
+    });
+
+    it("prioritizes the last searched item", () => {
+        const Searches = new RecentSearches();
+
+        const item1 = "test1";
+        const item2 = "test2";
+
+        Searches.add(item1);
+        Searches.add(item2);
+
+        expect(Searches.get().length).toEqual(2);
+
+        expect(Searches.get()[0]).toEqual(item2);
+        expect(Searches.get()[1]).toEqual(item1);
+
+        Searches.add(item1);
+
+        expect(Searches.get().length).toEqual(2);
+        expect(Searches.get()[0]).toEqual(item1);
+        expect(Searches.get()[1]).toEqual(item2);
+    });
+
+    it("will not exceed the limit", () => {
+        const Searches = new RecentSearches();
+
+        Array.apply(null, Array(LIMIT + 1)).forEach((_, i) => {
+            Searches.add(i.toString());
+        });
+
+        expect(Searches.get().length).toEqual(LIMIT);
+    });
+
+    it("doesn't add a bogus value", () => {
+        const Searches = new RecentSearches();
+
+        [null, "", " ", "    ", 5].forEach((v) => Searches.add(v));
+
+        expect(Searches.get().length).toEqual(0);
+    });
+});

package/src/modules/utils/recentSearches/recentSearches.ts

@@ -1,6 +1,6 @@
-const RECENT_SEARCHES = "dx-sidebar-recent-searches";
+export const LOCAL_STORAGE_KEY = "dx-sidebar-recent-searches";
 
-const LIMIT = 5;
+export const LIMIT = 5;
 
 export class RecentSearches {
     items: string[] = [];
@@ -10,11 +10,11 @@ export class RecentSearches {
     }
 
     get() {
-        return this.items.map((item) => ({ id: item, label: item }));
+        return this.items;
     }
 
     add(item: string | undefined) {
-        if (!item) {
+        if (!item || typeof item !== "string") {
             return;
         }
         const normalized = item.trim();
@@ -30,7 +30,7 @@ export class RecentSearches {
     // private
     _init() {
         this.items = JSON.parse(
-            window.localStorage.getItem(RECENT_SEARCHES) || "[]"
+            window.localStorage.getItem(LOCAL_STORAGE_KEY) || "[]"
         );
     }
 
@@ -50,17 +50,8 @@ export class RecentSearches {
 
     _addToStorage() {
         window.localStorage.setItem(
-            RECENT_SEARCHES,
+            LOCAL_STORAGE_KEY,
             JSON.stringify(this.items)
         );
     }
-
-    _isDuplicate(searchItem: string) {
-        return (
-            this.items.filter(
-                (item: string) =>
-                    item.toLowerCase() === searchItem.toLowerCase()
-            ).length > 0
-        );
-    }
 }