@salesforcedevs/dx-components 0.17.0 → 0.17.1-review-diff1

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) => 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/sanitizeHtml/sanitizeHtml.ts

@@ -0,0 +1,8 @@
+export function sanitizeHtml(str: string) {
+    const allowedTags = ["a", "b", "em", "br", "strong", "ol", "ul", "li"];
+    const pattern = new RegExp(
+        `<(/?(?!${allowedTags.join("|")})\\b[^>]*?)>`,
+        "gi"
+    );
+    return str.replace(pattern, "");
+}

package/src/modules/dxUtils/urlWatcher/urlWatcher.ts

@@ -0,0 +1,79 @@
+// utils/urlWatcher.ts
+// there's a _lot_ of typescript fuckery happening here, because this whole class violates the laws of nature
+// please do not be alarmed.
+export class UrlWatcher {
+    // eslint-disable-next-line no-use-before-define
+    private static instance: UrlWatcher;
+    private lastUrl: string = window.location.href;
+
+    private constructor() {
+        this.patchHistoryMethods();
+        this.init();
+    }
+
+    static getInstance(): UrlWatcher {
+        if (!UrlWatcher.instance) {
+            UrlWatcher.instance = new UrlWatcher();
+        }
+        return UrlWatcher.instance;
+    }
+
+    private patchHistoryMethods() {
+        const originalPushState = window.history.pushState;
+        const originalReplaceState = window.history.replaceState;
+
+        window.history.pushState = function (...args) {
+            const result = originalPushState.apply(this, args);
+            window.dispatchEvent(new Event("urlchange"));
+            return result;
+        };
+
+        window.history.replaceState = function (...args) {
+            const result = originalReplaceState.apply(this, args);
+            window.dispatchEvent(new Event("urlchange"));
+            return result;
+        };
+    }
+
+    private init() {
+        // Handle all relevant events
+        window.addEventListener("popstate", () => this.checkUrlChange());
+        window.addEventListener("urlchange", () => this.checkUrlChange());
+
+        // Fallback for missed changes
+        setInterval(() => this.checkUrlChange(), 1000);
+    }
+
+    private async checkUrlChange() {
+        const currentUrl = window.location.href;
+        if (currentUrl !== this.lastUrl) {
+            this.lastUrl = currentUrl;
+            await this.pingUrl(currentUrl);
+        }
+    }
+
+    private async pingUrl(url: string) {
+        try {
+            const response = await fetch(
+                url.replace(
+                    "localhost:3000",
+                    "staging.developer.salesforce.com"
+                ),
+                {
+                    method: "HEAD",
+                    redirect: "manual"
+                }
+            );
+
+            if (
+                response.type === "opaqueredirect" ||
+                (response.status >= 300 && response.status < 400)
+            ) {
+                // eslint-disable-next-line no-self-assign
+                window.location.href = window.location.href;
+            }
+        } catch (error) {
+            console.error("Error checking URL:", error);
+        }
+    }
+}

package/src/modules/dxUtils/withTypedRefs/withTypedRefs.ts

@@ -0,0 +1,26 @@
+import { LightningElement } from "lwc";
+
+// mixin version for more flexibility
+export const withTypedRefs = <
+    RefsType extends LightningElement["refs"] = LightningElement["refs"],
+    BaseClass extends new (...args: any[]) => any = new (
+        ...args: any[]
+    ) => LightningElement
+>(
+    BaseClass: BaseClass
+) => {
+    return class extends BaseClass {
+        get typedRefs() {
+            return this.refs as RefsType;
+        }
+    };
+};
+
+// class version if you just want a lightning element with typed refs and nothing else
+export class LightningElementWithTypedRefs<
+    RefsType extends LightningElement["refs"]
+> extends LightningElement {
+    get typedRefs() {
+        return this.refs as RefsType;
+    }
+}

package/src/modules/{utils → dxUtils}/wordpress/wordpress.ts

@@ -11,3 +11,17 @@ export const fetchWordpressPosts = async (
     const json = await res.json();
     return json.posts.map(normalizer);
 };
+
+export const fetchSingleWordpressPost = async (
+    path: string,
+    id: string,
+    normalizer: any
+) => {
+    const res = await fetch(`${path}/${id}`);
+    if (res.status !== 200) {
+        console.error(`Failed to fetch post with id: ${id}`, res);
+        return null;
+    }
+    const json = await res.json();
+    return normalizer(json);
+};

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.