@salesforcedevs/dx-components 0.3.12 → 0.3.14-banner-alpha1

package/src/modules/dxUtils/queryCoordinator/queryCoordinator.ts

@@ -0,0 +1,43 @@
+import qs, { ParsedQuery } from "query-string";
+/*
+ we import this util function below to get/set the query params as hyphenated versions of their camelcase counterparts.
+*/
+import kebabCase from "lodash.kebabcase";
+
+export function getUrlParamValue(key: string) {
+    const urlParams: ParsedQuery<string> = qs.parse(window.location.search);
+    const hyphenatedKey = kebabCase(key);
+
+    if (hyphenatedKey in urlParams) {
+        return (urlParams[hyphenatedKey] as string)
+            .split(",")
+            .map((urlParam) => urlParam.replace("-", " "));
+    }
+
+    return [];
+}
+
+export function setUrlParamValue(options: { [key: string]: string[] }) {
+    const url = new URL(window.location.href);
+
+    const newParams = {} as any;
+    const urlParams = qs.parse(window.location.search) as any;
+
+    for (const [key, value] of Object.entries(options)) {
+        if (value?.length) {
+            newParams[kebabCase(key)] = value.map((v) => kebabCase(v));
+        } else {
+            delete urlParams[kebabCase(key)];
+        }
+    }
+
+    url.search = qs.stringify(
+        {
+            ...urlParams,
+            ...newParams
+        },
+        { arrayFormat: "comma" }
+    );
+
+    window.history.replaceState(null, "", url.href);
+}

package/src/modules/dxUtils/recentSearches/recentSearches.ts

@@ -0,0 +1,57 @@
+export const LOCAL_STORAGE_KEY = "dx-sidebar-recent-searches";
+
+export const LIMIT = 5;
+
+export class RecentSearches {
+    items: string[] = [];
+
+    constructor() {
+        this._init();
+    }
+
+    get() {
+        return this.items;
+    }
+
+    add(item: string | undefined) {
+        if (!item || typeof item !== "string") {
+            return;
+        }
+        const normalized = item.trim();
+        if (normalized === "") {
+            return;
+        }
+        this._prepend(normalized);
+        this._removeDuplicates(normalized);
+        this._cutOffExcess();
+        this._addToStorage();
+    }
+
+    // private
+    _init() {
+        this.items = JSON.parse(
+            window.localStorage.getItem(LOCAL_STORAGE_KEY) || "[]"
+        );
+    }
+
+    _prepend(item: string) {
+        this.items.unshift(item);
+    }
+
+    _removeDuplicates(item: string) {
+        while (this.items.lastIndexOf(item) > 0) {
+            this.items.splice(this.items.lastIndexOf(item), 1);
+        }
+    }
+
+    _cutOffExcess() {
+        this.items = this.items.slice(0, LIMIT);
+    }
+
+    _addToStorage() {
+        window.localStorage.setItem(
+            LOCAL_STORAGE_KEY,
+            JSON.stringify(this.items)
+        );
+    }
+}

package/src/modules/dxUtils/regexps/regexps.ts

@@ -0,0 +1,5 @@
+const escapeRegExp = (text: string) =>
+    text.replace(/[-[\]{}()*+?.,\\^$|]/g, "\\$&");
+
+export const createSearchRegExp = (searchTerm: string): RegExp =>
+    new RegExp(`(?:${escapeRegExp(searchTerm)})(?![^<>]*>)`, "gi");

package/src/modules/dxUtils/seo/seo.ts

@@ -0,0 +1,4 @@
+export function isPrerender(): boolean {
+    const userAgent = window.navigator.userAgent;
+    return userAgent.includes("Prerender");
+}

package/LICENSE

@@ -1,12 +0,0 @@
-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/src/modules/dx/banner/__tests__/banner.test.ts

@@ -1,80 +0,0 @@
-import { createElement } from "lwc";
-import Banner from "dx/banner";
-
-const create = (props: object = {}) => {
-    const element = createElement("dx-banner", {
-        is: Banner
-    });
-    Object.assign(element, {
-        backgroundColor: "dark-indigo",
-        title: "This is the title",
-        subtitle: "A subtitle for sure",
-        ...props
-    });
-    return element;
-};
-
-describe("dx-banner", () => {
-    it("renders the default elements", async () => {
-        const element = create();
-        document.body.appendChild(element);
-
-        const bannerEl = element.shadowRoot.querySelector(".banner");
-        const titleEl = element.shadowRoot.querySelector(".title");
-        const subtitleEl = element.shadowRoot.querySelector(".subtitle");
-        const ctaEl = element.shadowRoot.querySelector("dx-button");
-        const imgEl = element.shadowRoot.querySelector("img");
-
-        expect(bannerEl).not.toBeNull();
-        expect(titleEl).not.toBeNull();
-        expect(subtitleEl).not.toBeNull();
-        expect(ctaEl).toBeNull();
-        expect(imgEl).toBeNull();
-
-        await expect(element).toBeAccessible();
-    });
-
-    it("renders the cta and image optionally", async () => {
-        const element = create({
-            cta: "Call to action",
-            ctaHref: "https://salesforce.com",
-            img: "https://placekitten.com/300/300",
-            imgAlt: "Image alt"
-        });
-        document.body.appendChild(element);
-
-        const bannerEl = element.shadowRoot.querySelector(".banner");
-        const titleEl = element.shadowRoot.querySelector(".title");
-        const subtitleEl = element.shadowRoot.querySelector(".subtitle");
-        const ctaEl = element.shadowRoot.querySelector("dx-button");
-        const imgEl = element.shadowRoot.querySelector("img");
-
-        expect(bannerEl).not.toBeNull();
-        expect(titleEl).not.toBeNull();
-        expect(subtitleEl).not.toBeNull();
-        expect(ctaEl).not.toBeNull();
-        expect(imgEl).not.toBeNull();
-
-        await expect(element).toBeAccessible();
-    });
-
-    it("renders the graphic optionally", async () => {
-        const element = create({
-            img: "bear",
-            imgAlt: "bear"
-        });
-        document.body.appendChild(element);
-
-        const bannerEl = element.shadowRoot.querySelector(".banner");
-        const titleEl = element.shadowRoot.querySelector(".title");
-        const subtitleEl = element.shadowRoot.querySelector(".subtitle");
-        const imgEl = element.shadowRoot.querySelector("img");
-
-        expect(bannerEl).not.toBeNull();
-        expect(titleEl).not.toBeNull();
-        expect(subtitleEl).not.toBeNull();
-        expect(imgEl).not.toBeNull();
-
-        await expect(element).toBeAccessible();
-    });
-});

package/src/modules/dx/banner/banner.stories.ts

@@ -1,121 +0,0 @@
-import { html } from "lit-html";
-
-export default {
-    title: "dx/dx-banner",
-    component: "dx-banner"
-};
-
-const colors = [
-    "teal",
-    "dark-indigo",
-    "cloud-blue-natural",
-    "cloud-blue-vibrant",
-    "light-blue",
-    "blue",
-    "light-indigo",
-    "transparent"
-];
-
-const graphics = ["bear", "clouds", "moon-clouds", "moon-stars"];
-
-const Banner = ({
-    color,
-    inset = "",
-    small = "",
-    cta = "",
-    image = `https://placekitten.com/300/300`,
-    backgroundImage = "",
-    props = ""
-}) => `
-    <dx-banner
-        background-color="${color}"
-        ${props}
-        ${inset && `inset="true"`}
-        ${small && `size="small"`}
-        ${
-            cta &&
-            `
-                cta="Read more on the blog"
-                cta-href="https://www.salesforce.com"
-                cta-target="_blank"
-                cta-aria-label="Salesforce button"
-            `
-        }
-        title="Hello Architects"
-        subtitle="${`You’re both a big picture thinker and an in-depth problem solver${
-            small ? ". " : ""
-        }`.repeat(small ? 10 : 1)}"
-        ${image && `img="${image}"`}
-        ${backgroundImage && `background-img="${backgroundImage}"`}
-    ></dx-banner>
-`;
-
-export const Base = () => html`
-    <dx-banner
-        title="This is the title"
-        subtitle="This is the subtitle"
-        background-color="dark-indigo"
-        title-position="center"
-        cta="Read more on the blog"
-        cta-href="https://www.salesforce.com"
-        cta-target="_blank"
-        cta-aria-label="Salesforce button"
-        img="https://placekitten.com/300/300"
-        img-alt="A kitty"
-    ></dx-banner>
-`;
-
-export const Color = () => `
-    ${colors.map((color) => Banner({ color })).join("<br/>")}
-`;
-
-export const Hero = () => `
-    ${colors.map((color) => Banner({ color, small: "true" })).join("<br/>")}
-`;
-
-export const Inset = () => `
-    ${colors
-        .map(
-            (color) => `
-                ${Banner({ color, inset: "true" })}
-                <br/>
-                ${Banner({ color, inset: "true", small: "true" })}
-            `
-        )
-        .join("<br/>")}
-`;
-
-export const CTA = () => `
-    ${colors.map((color) => Banner({ color, cta: "true" })).join("<br/>")}
-`;
-
-export const Position = () => `
-    ${Banner({ color: "dark-indigo", cta: "true" })}
-    <br/>
-    ${Banner({
-        color: "dark-indigo",
-        cta: "true",
-        props: `img-position="left"`
-    })}
-    <br/>
-    ${Banner({
-        color: "dark-indigo",
-        cta: "true",
-        props: `title-position="bottom" img="https://placekitten.com/200/600"`
-    })}
-`;
-
-export const Graphic = () => `
-    ${colors
-        .map((color) =>
-            graphics
-                .map((graphic) =>
-                    Banner({ backgroundImage: graphic, color, image: "" })
-                )
-                .join("<br/>")
-        )
-        .join("<br/>")}
-`;
-Graphic.parameters = {
-    a11y: { manual: true }
-};