@salesforcedevs/dx-components 1.43.0-alpha.0 → 1.44.0

package/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2020, Salesforce.com, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/lwc.config.json

@@ -93,6 +93,7 @@
         "dx/sectionBanner",
         "dx/sectionSignup",
         "dx/sectionSmall",
+        "dx/searchRedirect",
         "dx/select",
         "dx/sidebar",
         "dx/sidebarOld",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/dx-components",
-    "version": "1.43.0-alpha.0",
+    "version": "1.44.0",
     "description": "DX Lightning web components",
     "license": "MIT",
     "engines": {
@@ -43,5 +43,6 @@
         "eventsourcemock": "2.0.0",
         "luxon": "3.4.4",
         "msw": "^2.12.4"
-    }
+    },
+    "gitHead": "0abdf26134a564b4a943ae4d8a99a1f66dbf6baa"
 }

package/src/modules/dx/searchHybrid/searchHybrid.css

@@ -1,3 +1,4 @@
+@import "dxHelpers/reset";
 @import "dxHelpers/text";
 
 :host {
@@ -81,6 +82,7 @@
     color: var(--dx-g-blue-vibrant-50);
     font-family: var(--dx-g-font-display);
     font-size: var(--dx-g-text-sm);
+    cursor: pointer;
 }
 
 .dx-filter-clear:disabled {
@@ -88,10 +90,6 @@
     cursor: default;
 }
 
-.dx-search-range {
-    margin: 0 0 var(--dx-g-spacing-lg);
-}
-
 .dx-search-main {
     flex: 1 1 0;
     min-width: 0;

package/src/modules/dx/searchHybrid/searchHybrid.html

@@ -31,9 +31,7 @@
                         class="dx-filter-type"
                         name="contentType"
                         header="Content Type"
-                        single-select
                         options={typeFilterOptions}
-                        value={selectedTypeValue}
                         onchange={handleTypeFilterChange}
                     ></dx-filter-menu>
                     <dx-filter-menu
@@ -49,13 +47,6 @@
                 </aside>
 
                 <div class="dx-search-main">
-                    <p
-                        if:true={showRange}
-                        class="dx-search-range dx-text-body-2"
-                        aria-live="polite"
-                    >
-                        Showing {rangeStart} - {rangeEnd} of {total}
-                    </p>
                     <!-- Loading -->
                     <template if:true={isLoading}>
                         <div class="dx-search-status" aria-live="polite">

package/src/modules/dx/searchHybrid/searchHybrid.mock.ts

@@ -221,8 +221,12 @@ const ALL = ROWS.map(row);
  * reflect the full result set (disjunctive facets), as the real API does.
  */
 export function mockSearchResponse(params: URLSearchParams) {
-    const type = params.get("type");
-    const results = type ? ALL.filter((r) => r.contentType === type) : ALL;
+    // `type` is a comma-separated list; selected types are OR'd.
+    const types = (params.get("type") ?? "").split(",").filter(Boolean);
+    const type = types.length > 0;
+    const results = type
+        ? ALL.filter((r) => types.includes(r.contentType))
+        : ALL;
     return {
         query: params.get("q") ?? "apex",
         locale: params.get("lang") ?? "en-us",

package/src/modules/dx/searchHybrid/searchHybrid.ts

@@ -57,7 +57,6 @@ interface DisplayResult {
 interface FacetChip {
     value: string;
     label: string;
-    count: number;
     active: boolean;
     cssClass: string;
 }
@@ -77,6 +76,15 @@ export default class SearchHybrid extends LightningElement {
     /** The page's server locale, used as the default search language. */
     @api defaultLanguage: string = "en-us";
 
+    /**
+     * Comma-separated content types to always offer in the Content Type filter
+     * (e.g. "docs,blog,page"), in display order. Counts come from the search
+     * response and default to 0. Types that appear in a response but are not
+     * listed here are appended, so nothing is hidden. When unset, the menu lists
+     * only the types in the response.
+     */
+    @api contentTypes?: string;
+
     /** Results per page. */
     @api limit?: number;
 
@@ -256,66 +264,76 @@ export default class SearchHybrid extends LightningElement {
     // ---- content-type facet chips (disjunctive) ---------------------------
 
     get facetChips(): FacetChip[] {
-        const facets = this.vm?.contentTypeFacets ?? [];
-        const selected = this.vm?.selectedType ?? null;
-        return facets
-            .filter((b) => b.value != null && b.value !== "")
-            .map((b) => {
-                const active = selected === b.value;
-                return {
-                    value: b.value,
-                    label: this.contentTypeLabel(b.value) ?? b.value,
-                    count: b.count,
-                    active,
-                    cssClass: active
-                        ? "dx-facet-chip dx-facet-chip_active"
-                        : "dx-facet-chip"
-                };
-            });
+        const responseFacets = (this.vm?.contentTypeFacets ?? []).filter(
+            (b) => b.value != null && b.value !== ""
+        );
+        const configured = (this.contentTypes ?? "")
+            .split(",")
+            .map((t) => t.trim())
+            .filter(Boolean);
+        // Configured types first (stable order), then any extra types the
+        // response returned. Per-type counts are intentionally not shown: they
+        // change as filters change, which is confusing.
+        const values = [
+            ...new Set([...configured, ...responseFacets.map((b) => b.value)])
+        ];
+        const selected = this.selectedTypeList;
+        return values.map((value) => {
+            const active = selected.includes(value);
+            return {
+                value,
+                label: this.contentTypeLabel(value) ?? value,
+                active,
+                cssClass: active
+                    ? "dx-facet-chip dx-facet-chip_active"
+                    : "dx-facet-chip"
+            };
+        });
     }
 
     get hasFacets(): boolean {
         return this.facetChips.length > 0;
     }
 
-    /** Options for the sidebar dx-filter-menu (single-select by content type, sent to the API as `type`). */
+    /** Options for the sidebar dx-filter-menu (multi-select by content type, sent to the API as a comma-separated `type`). */
     get typeFilterOptions(): Array<{
         id: string;
         name: string;
         value: string;
+        checked: boolean;
     }> {
         return this.facetChips.map((chip) => ({
             id: chip.value,
-            name: `${chip.label} (${chip.count})`,
-            value: chip.value
+            name: chip.label,
+            value: chip.value,
+            checked: chip.active
         }));
     }
 
-    get selectedTypeValue(): string {
-        return this.vm?.selectedType ?? "";
+    /** The view model's selectedType (null | string | string[]) as a list. */
+    private get selectedTypeList(): string[] {
+        const t = this.vm?.selectedType;
+        return t == null ? [] : Array.isArray(t) ? t : [t];
+    }
+
+    /** Adds `value` to the selection, or removes it if already selected. */
+    private toggleType(value: string): void {
+        const list = this.selectedTypeList;
+        const next = list.includes(value)
+            ? list.filter((t) => t !== value)
+            : [...list, value];
+        // A single type is passed as a string, several as an array.
+        this.controller?.setType(next.length > 1 ? next : next[0] ?? null);
     }
 
     get hasActiveType(): boolean {
-        return !!this.vm?.selectedType;
+        return this.selectedTypeList.length > 0;
     }
 
     get noActiveFilters(): boolean {
         return !this.hasActiveType && this.localeValue === this.defaultLanguage;
     }
 
-    get showRange(): boolean {
-        return this.hasResults && this.total > 0;
-    }
-
-    get rangeStart(): number {
-        return ((this.vm?.page ?? 1) - 1) * (this.vm?.limit ?? 10) + 1;
-    }
-
-    get rangeEnd(): number {
-        const limit = this.vm?.limit ?? 10;
-        return Math.min(this.rangeStart + limit - 1, this.total);
-    }
-
     // ---- locale select options -------------------------------------
 
     get showLocaleSelector(): boolean {
@@ -369,8 +387,8 @@ export default class SearchHybrid extends LightningElement {
     ): void {
         const value = event.detail?.value?.value;
         if (value) {
-            // Disjunctive toggle: the controller clears it if already active.
-            this.controller?.setType(value);
+            // Toggle: the controller adds the type, or removes it if selected.
+            this.toggleType(value);
         }
     }
 
@@ -386,9 +404,9 @@ export default class SearchHybrid extends LightningElement {
     handleFacetClick(event: Event): void {
         const value = (event.currentTarget as HTMLElement)?.dataset?.value;
         if (value) {
-            // Disjunctive toggle: the controller clears it if it is already
-            // active.
-            this.controller?.setType(value);
+            // Toggle: the controller adds the type, or removes it if it is
+            // already selected.
+            this.toggleType(value);
         }
     }
 

package/src/modules/dx/searchRedirect/searchRedirect.html

@@ -0,0 +1 @@
+<template></template>

package/src/modules/dx/searchRedirect/searchRedirect.ts

@@ -0,0 +1,111 @@
+import { LightningElement, api } from "lwc";
+
+const DEFAULT_LANG = "en-us";
+
+// Language ids accepted by the developer-website /search page (`locales` in its
+// content/en-us/pages/search.njk, lowercase BCP 47). The page ignores any ?lang=
+// value outside this set.
+const SEARCH_LANGS = new Set([
+    "en-us",
+    "ja-jp",
+    "de-de",
+    "fr-fr",
+    "es-es",
+    "es-mx",
+    "it-it",
+    "pt-br",
+    "nl-nl",
+    "da-dk",
+    "fi-fi",
+    "nb-no",
+    "sv-se",
+    "ru-ru",
+    "ko-kr",
+    "zh-cn",
+    "zh-tw"
+]);
+
+// First-path-segment prefixes that imply a language, e.g. /jp/docs -> ja-jp.
+const PATH_PREFIX_LANG: Record<string, string> = {
+    jp: "ja-jp",
+    jpblogs: "ja-jp"
+};
+const LOCALE_SEGMENT = /^[a-z]{2}-[a-z]{2}$/i;
+
+/**
+ * Derives the search language id from a URL path. Docs carry the locale as
+ * /docs/<product>/<locale>/... or /docs/atlas.<locale>.<guide>/...; other pages
+ * lead with it (/ja-jp/...) or use a prefix such as /jp/. Returns en-us when no
+ * supported language is found.
+ */
+export function langFromPath(pathname: string): string {
+    const segs = pathname.split("/").filter(Boolean);
+    const first = (segs[0] || "").toLowerCase();
+    if (first === "docs" && segs[1]) {
+        const atlas = segs[1].match(/^atlas\.([a-z]{2}-[a-z]{2})\./i);
+        const code = (
+            atlas ? atlas[1] : LOCALE_SEGMENT.test(segs[2] || "") ? segs[2] : ""
+        ).toLowerCase();
+        if (SEARCH_LANGS.has(code)) {
+            return code;
+        }
+    }
+    if (SEARCH_LANGS.has(first)) {
+        return first;
+    }
+    return PATH_PREFIX_LANG[first] || DEFAULT_LANG;
+}
+
+/** Builds the relative search URL, adding `lang` only for non-default languages. */
+export function buildSearchUrl(
+    searchPath: string,
+    query: string,
+    pathname: string
+): string {
+    const params = new URLSearchParams({ q: query });
+    const lang = langFromPath(pathname);
+    if (lang !== DEFAULT_LANG) {
+        params.set("lang", lang);
+    }
+    return `${searchPath}?${params.toString()}`;
+}
+
+/**
+ * Redirects global nav searches to a search page on the current host.
+ *
+ * With `search-spa="true"` in the header settings, the nav doesn't navigate on
+ * submit; it dispatches `www_spasearch` with { searchTerm } and leaves navigation
+ * to the host page. This component handles that event, redirecting to
+ * `<searchPath>?q=<term>` and adding `&lang=<id>` when the page isn't English.
+ * Render it once next to <dx-global-header>.
+ *
+ * Mirrors arch-xsf-mfe-events; once Developer and Architect share a search, this
+ * can move into dx-global-header.
+ */
+export default class SearchRedirect extends LightningElement {
+    @api searchPath: string = "/search";
+
+    connectedCallback(): void {
+        document.addEventListener("www_spasearch", this.handleSearch);
+    }
+
+    disconnectedCallback(): void {
+        document.removeEventListener("www_spasearch", this.handleSearch);
+    }
+
+    private handleSearch = (event: Event): void => {
+        const searchTerm = (
+            (event as CustomEvent<{ searchTerm?: string }>).detail
+                ?.searchTerm || ""
+        ).trim();
+        if (searchTerm) {
+            window.location.assign(
+                buildSearchUrl(
+                    this.searchPath,
+                    searchTerm,
+                    window.location.pathname
+                )
+            );
+        }
+    };
+}

package/src/modules/dx/sidebarOld/sidebarOld.css

@@ -5,11 +5,6 @@
     padding: var(--dx-g-spacing-sm) 0 var(--dx-g-spacing-2xl);
 }
 
-.trees-loading {
-    margin: var(--dx-g-spacing-sm) var(--dx-g-spacing-lg) var(--dx-g-spacing-md)
-        var(--dx-g-global-header-padding-horizontal);
-}
-
 dx-empty-state {
     --dx-c-empty-state-background-alt: var(--sds-g-gray-1);
     --dx-c-empty-state-image-width: 400px;

package/src/modules/dx/sidebarOld/sidebarOld.html

@@ -77,12 +77,6 @@
                     onselecteditemrendered={onSelectedItemRendered}
                 ></dx-tree>
             </div>
-            <img
-                lwc:elseif={loading}
-                class="trees-loading"
-                src="https://developer.salesforce.com/ns-assets/sidebar-item-loading.svg"
-                alt="Loading"
-            />
             <dx-empty-state
                 variant="alt"
                 class="padding-horizontal"

package/src/modules/dx/sidebarOld/sidebarOld.ts

@@ -2,7 +2,7 @@ import cx from "classnames";
 import { api } from "lwc";
 
 import { TreeNode } from "typings/custom";
-import { normalizeBoolean, toJson } from "dxUtils/normalizers";
+import { toJson } from "dxUtils/normalizers";
 import { SidebarBase } from "dxBaseElements/sidebarBase";
 import { escapeRegExp } from "dxUtils/regexps";
 
@@ -38,17 +38,6 @@ export default class Sidebar extends SidebarBase {
         this._emptyStateMessage = value;
     }
 
-    /** Shows a loading placeholder instead of the empty state while the trees load. */
-    @api
-    get loading(): boolean {
-        return this._loading;
-    }
-
-    set loading(value) {
-        this._loading = normalizeBoolean(value);
-    }
-
-    private _loading = false;
     private _searchTimeout?: number;
     private _trees!: Array<TreeNode>;