@salesforcedevs/dx-components 1.28.7-alpha.12 → 1.28.7-alpha.14

package/lwc.config.json

@@ -127,7 +127,7 @@
         "dxUtils/analytics",
         "dxUtils/async",
         "dxUtils/constants",
-        "dxUtils/dataCloudSearch",
+        "dxUtils/data360Search",
         "dxUtils/contentTypes",
         "dxUtils/coveo",
         "dxUtils/dates",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/dx-components",
-    "version": "1.28.7-alpha.12",
+    "version": "1.28.7-alpha.14",
     "description": "DX Lightning web components",
     "license": "MIT",
     "engines": {
@@ -44,5 +44,5 @@
         "luxon": "3.4.4",
         "msw": "^2.12.4"
     },
-    "gitHead": "d90a01c3e0b1366d6f262d986bfa0ef6ede99137"
+    "gitHead": "01442763b9d41a4eb0f50911dba1bb1f5b94f5c8"
 }

package/src/modules/dx/searchResults/searchResults.ts

@@ -2,10 +2,10 @@ import { LightningElement, api, track } from "lwc";
 import debounce from "debounce";
 import { track as trackGTM } from "dxUtils/analytics";
 import {
-    type DataCloudSearchResultItem,
+    type Data360SearchResultItem,
     fetchSearch,
     getQueryFromUrl
-} from "dxUtils/dataCloudSearch";
+} from "dxUtils/data360Search";
 
 const SEARCH_DEBOUNCE_DELAY = 400;
 
@@ -99,12 +99,12 @@ export default class SearchResults extends LightningElement {
         try {
             const raw = await fetchSearch(query);
             this.results = raw.map(
-                (item: DataCloudSearchResultItem, index: number) =>
+                (item: Data360SearchResultItem, index: number) =>
                     this.normalizeResult(item, index)
             );
             this.trackSearchResultsOnce(query, this.results.length);
         } catch (err) {
-            console.error("Data Cloud Search request failed", err);
+            console.error("Data 360 Search request failed", err);
             this.results = [];
         } finally {
             this.isLoading = false;
@@ -116,7 +116,7 @@ export default class SearchResults extends LightningElement {
     }, SEARCH_DEBOUNCE_DELAY);
 
     private normalizeResult(
-        item: DataCloudSearchResultItem,
+        item: Data360SearchResultItem,
         index: number
     ): SearchResultDisplay {
         const href = item.url ?? "";

package/src/modules/dx/sidebarSearch/sidebarSearch.ts

@@ -1,9 +1,14 @@
 import { LightningElement, api } from "lwc";
 import debounce from "debounce";
 import {
-    type DataCloudSearchResultItem,
-    fetchSearch
-} from "dxUtils/dataCloudSearch";
+    type Data360SearchCacheItem,
+    type Data360SearchResultItem,
+    fetchSearch,
+    getBaseUrlPath,
+    getStoredSearch,
+    isCacheStale,
+    setStoredSearch
+} from "dxUtils/data360Search";
 import { createSearchRegExp } from "dxUtils/regexps";
 import { RecentSearches } from "dxUtils/recentSearches";
 import {
@@ -38,13 +43,28 @@ function getHighlightRanges(
 
 const UserRecentSearches = new RecentSearches();
 
+function resultPathFromHref(href: string): string {
+    return href.startsWith("http") ? new URL(href).pathname : href;
+}
+
+function applySelectedAndSelect(
+    items: Data360SearchCacheItem[]
+): SidebarSearchResult[] {
+    const currentPath = window.location.pathname;
+    return items.map((item) => ({
+        ...item,
+        selected: !!item.href && resultPathFromHref(item.href) === currentPath,
+        select: () => {}
+    }));
+}
+
 const getSearchQueryParam = (): string =>
     new URLSearchParams(window.location.search).get("q") ?? "";
 
 export default class SidebarSearch extends LightningElement {
     @api
     public fetchMoreResults() {
-        // Data Cloud Search API does not expose pagination in the same way; no-op
+        // Data 360 Search API does not expose pagination in the same way; no-op
     }
 
     @api
@@ -64,7 +84,7 @@ export default class SidebarSearch extends LightningElement {
     private recentSearches: Option[] = [];
     private value: string = "";
     private didRender = false;
-    private dataCloudSearchInitialized: boolean = false;
+    private data360SearchInitialized: boolean = false;
 
     private get isDropdownOpen() {
         return (
@@ -81,16 +101,42 @@ export default class SidebarSearch extends LightningElement {
     }
 
     renderedCallback() {
-        if (!this.dataCloudSearchInitialized) {
-            this.dataCloudSearchInitialized = true;
+        if (!this.data360SearchInitialized) {
+            this.data360SearchInitialized = true;
             if (this.value) {
-                // Page load with ?q= in URL: run search so results and loading state resolve
-                if (!this.didRender) {
-                    this.dispatchHighlightedTermChange();
+                const baseUrlPath = getBaseUrlPath();
+                const cached = getStoredSearch(baseUrlPath);
+                const queryTrimmed = this.value.trim();
+                if (
+                    cached?.query === queryTrimmed &&
+                    Array.isArray(cached.results) &&
+                    !isCacheStale(cached)
+                ) {
+                    if (!this.didRender) {
+                        this.dispatchHighlightedTermChange();
+                    }
+                    const results = applySelectedAndSelect(cached.results);
+                    this.dispatchChange(results);
+                    this.dispatchOnLoading(false);
+                } else {
+                    if (!this.didRender) {
+                        this.dispatchHighlightedTermChange();
+                    }
+                    this.dispatchOnLoading(true);
+                    this.fetchDataCloudSearch();
                 }
-                this.dispatchOnLoading(true);
-                this.fetchDataCloudSearch();
             } else {
+                // No URL query: restore search bar and results from localStorage for this path
+                const baseUrlPath = getBaseUrlPath();
+                const cached = getStoredSearch(baseUrlPath);
+                if (cached?.query && !isCacheStale(cached)) {
+                    this.value = cached.query;
+                    const results = applySelectedAndSelect(
+                        cached.results ?? []
+                    );
+                    this.dispatchChange(results);
+                    this.dispatchHighlightedTermChange();
+                }
                 this.dispatchOnLoading(false);
             }
         }
@@ -101,7 +147,7 @@ export default class SidebarSearch extends LightningElement {
     }
 
     private normalizeDataCloudResult = (
-        item: DataCloudSearchResultItem,
+        item: Data360SearchResultItem,
         index: number
     ): SidebarSearchResult => {
         const href = item.url ?? "";
@@ -132,8 +178,20 @@ export default class SidebarSearch extends LightningElement {
                 this.normalizeDataCloudResult
             );
             this.dispatchChange(results);
+            const cacheItems: Data360SearchCacheItem[] = results.map((r) => ({
+                title: r.title,
+                titleHighlights: r.titleHighlights,
+                excerpt: r.excerpt,
+                excerptHighlights: r.excerptHighlights,
+                uniqueId: r.uniqueId,
+                href: r.href
+            }));
+            setStoredSearch(getBaseUrlPath(), {
+                query: this.value.trim(),
+                results: cacheItems
+            });
         } catch (err) {
-            console.error("Data Cloud Search request failed", err);
+            console.error("Data 360 Search request failed", err);
             this.dispatchChange([]);
         } finally {
             this.dispatchOnLoading(false);
@@ -227,6 +285,7 @@ export default class SidebarSearch extends LightningElement {
             this.dispatchOnLoading(false);
             this.dispatchChange([]);
             this.dispatchSidebarSearchChange(this.value);
+            setStoredSearch(getBaseUrlPath(), { query: "", results: [] });
         }
     }
 }

package/src/modules/dxUtils/data360Search/data360Search.ts

@@ -0,0 +1,168 @@
+/**
+ * Data 360 search API – shared endpoints and helpers for sidebar search,
+ * search results page, and has-results check.
+ */
+
+const STORAGE_KEY_PREFIX = "data360-search:";
+
+/** Data 360 Search API result item (title, url, matchedText) */
+export interface Data360SearchResultItem {
+    title?: string;
+    url?: string;
+    matchedText?: string;
+}
+
+/** Normalized result shape stored in cache (no selected/select; those are applied on restore). */
+export interface Data360SearchCacheItem {
+    title: string;
+    titleHighlights: Array<{ length: number; offset: number }>;
+    excerpt: string;
+    excerptHighlights: Array<{ length: number; offset: number }>;
+    uniqueId: string;
+    href: string;
+}
+
+export interface Data360SearchCache {
+    query: string;
+    results: Data360SearchCacheItem[];
+    /** Timestamp when stored (Date.now()); missing on older entries (treated as stale). */
+    storedAt?: number;
+}
+
+const CACHE_MAX_AGE_MS = 2 * 60 * 60 * 1000; // 2 hours
+
+export function isCacheStale(cache: Data360SearchCache | null): boolean {
+    if (!cache?.storedAt) {
+        return true;
+    }
+    return Date.now() - cache.storedAt > CACHE_MAX_AGE_MS;
+}
+
+export function getStoredSearch(
+    baseUrlPath: string
+): Data360SearchCache | null {
+    try {
+        const raw = localStorage.getItem(`${STORAGE_KEY_PREFIX}${baseUrlPath}`);
+        if (!raw) {
+            return null;
+        }
+        const parsed = JSON.parse(raw) as Data360SearchCache;
+        if (
+            !parsed ||
+            typeof parsed.query !== "string" ||
+            !Array.isArray(parsed.results)
+        ) {
+            return null;
+        }
+        return parsed;
+    } catch {
+        return null;
+    }
+}
+
+export function setStoredSearch(
+    baseUrlPath: string,
+    data: Data360SearchCache
+): void {
+    try {
+        const toStore: Data360SearchCache = {
+            ...data,
+            storedAt: Date.now()
+        };
+        localStorage.setItem(
+            `${STORAGE_KEY_PREFIX}${baseUrlPath}`,
+            JSON.stringify(toStore)
+        );
+    } catch {
+        /* ignore quota or disabled localStorage */
+    }
+}
+
+export const DATA_360_SEARCH_PATH = "/data-360-search/search";
+export const DATA_360_HAS_RESULTS_PATH = "/data-360-search/has-results";
+export const DATA_360_SEARCH_ORIGIN = "https://developer.salesforce.com";
+
+export function getBaseUrlPath(): string {
+    const url = DATA_360_SEARCH_ORIGIN + window.location.pathname;
+    const lastSlash = url.lastIndexOf("/");
+    return lastSlash > 0 ? url.substring(0, lastSlash) : url;
+}
+
+/**
+ * Read search query from URL: ?q=, ?keywords= (migrated to q), or #q=.
+ */
+export function getQueryFromUrl(): string {
+    const params = new URLSearchParams(window.location.search);
+    const keywords = params.get("keywords");
+    if (keywords) {
+        const url = new URL(window.location.href);
+        url.searchParams.delete("keywords");
+        url.searchParams.set("q", keywords);
+        window.history.replaceState(null, "", url.href);
+        return keywords;
+    }
+    const qFromSearch = params.get("q");
+    if (qFromSearch) {
+        return qFromSearch;
+    }
+    const hash = window.location.hash.slice(1);
+    if (hash) {
+        try {
+            const qFromHash = new URLSearchParams(hash).get("q");
+            if (qFromHash) {
+                return qFromHash;
+            }
+        } catch {
+            /* ignore */
+        }
+    }
+    return "";
+}
+
+/**
+ * Quick check if the current page has searchable results.
+ * Only when this returns true should the Data 360 sidebar be shown.
+ */
+export async function fetchHasResults(): Promise<boolean> {
+    try {
+        const res = await fetch(DATA_360_HAS_RESULTS_PATH, {
+            method: "POST",
+            headers: { "Content-Type": "application/json" },
+            body: JSON.stringify({ baseUrlPath: getBaseUrlPath() })
+        });
+        if (!res.ok) {
+            return false;
+        }
+        const data = await res.json();
+        return data.hasResults === true;
+    } catch {
+        return false;
+    }
+}
+
+/**
+ * Run a Data 360 search. Returns the raw result items; callers normalize for UI.
+ */
+export async function fetchSearch(
+    searchQuery: string
+): Promise<Data360SearchResultItem[]> {
+    const query = searchQuery.trim();
+    if (!query) {
+        return [];
+    }
+    const res = await fetch(DATA_360_SEARCH_PATH, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({
+            searchQuery: query,
+            baseUrlPath: getBaseUrlPath()
+        })
+    });
+    if (!res.ok) {
+        throw new Error(`Search API error: ${res.status}`);
+    }
+    const data = await res.json();
+    return Array.isArray(data)
+        ? data
+        : data?.results ?? data?.data?.results ?? [];
+}

package/src/modules/dxUtils/dataCloudSearch/dataCloudSearch.ts

@@ -1,100 +0,0 @@
-/**
- * Data Cloud search API – shared endpoints and helpers for sidebar search,
- * search results page, and has-results check.
- */
-
-export const DATA_CLOUD_SEARCH_PATH = "/data-cloud-search/search";
-export const DATA_CLOUD_HAS_RESULTS_PATH = "/data-cloud-search/has-results";
-export const DATA_CLOUD_SEARCH_ORIGIN = "https://developer.salesforce.com";
-
-/** Data Cloud Search API result item (title, url, matchedText) */
-export interface DataCloudSearchResultItem {
-    title?: string;
-    url?: string;
-    matchedText?: string;
-}
-
-export function getBaseUrlPath(): string {
-    const url = DATA_CLOUD_SEARCH_ORIGIN + window.location.pathname;
-    const lastSlash = url.lastIndexOf("/");
-    return lastSlash > 0 ? url.substring(0, lastSlash) : url;
-}
-
-/**
- * Read search query from URL: ?q=, ?keywords= (migrated to q), or #q=.
- */
-export function getQueryFromUrl(): string {
-    const params = new URLSearchParams(window.location.search);
-    const keywords = params.get("keywords");
-    if (keywords) {
-        const url = new URL(window.location.href);
-        url.searchParams.delete("keywords");
-        url.searchParams.set("q", keywords);
-        window.history.replaceState(null, "", url.href);
-        return keywords;
-    }
-    const qFromSearch = params.get("q");
-    if (qFromSearch) {
-        return qFromSearch;
-    }
-    const hash = window.location.hash.slice(1);
-    if (hash) {
-        try {
-            const qFromHash = new URLSearchParams(hash).get("q");
-            if (qFromHash) {
-                return qFromHash;
-            }
-        } catch {
-            /* ignore */
-        }
-    }
-    return "";
-}
-
-/**
- * Quick check if the current page has searchable results.
- * Only when this returns true should the Data Cloud sidebar be shown.
- */
-export async function fetchHasResults(): Promise<boolean> {
-    try {
-        const res = await fetch(DATA_CLOUD_HAS_RESULTS_PATH, {
-            method: "POST",
-            headers: { "Content-Type": "application/json" },
-            body: JSON.stringify({ baseUrlPath: getBaseUrlPath() })
-        });
-        if (!res.ok) {
-            return false;
-        }
-        const data = await res.json();
-        return data.hasResults === true;
-    } catch {
-        return false;
-    }
-}
-
-/**
- * Run a Data Cloud search. Returns the raw result items; callers normalize for UI.
- */
-export async function fetchSearch(
-    searchQuery: string
-): Promise<DataCloudSearchResultItem[]> {
-    const query = searchQuery.trim();
-    if (!query) {
-        return [];
-    }
-    const res = await fetch(DATA_CLOUD_SEARCH_PATH, {
-        method: "POST",
-        headers: { "Content-Type": "application/json" },
-        body: JSON.stringify({
-            searchQuery: query,
-            baseUrlPath: getBaseUrlPath()
-        })
-    });
-    if (!res.ok) {
-        throw new Error(`Search API error: ${res.status}`);
-    }
-    const data = await res.json();
-    return Array.isArray(data)
-        ? data
-        : data?.results ?? data?.data?.results ?? [];
-}