@salesforcedevs/docs-components 0.0.2 → 0.0.3-edit

package/src/modules/docUtils/utils/utils.ts

@@ -0,0 +1,32 @@
+import { CoveoAnalyticsClient } from "coveo.analytics/dist/browser.mjs"; // This fix is required for Node 20 upgrade, so that Coveo analytics is loaded properly by LWR.
+
+export const oldVersionDocInfo = (latestVersionLink: string) => {
+    return {
+        title: "Newer Version Available",
+        body: `This content describes an older version of this product. 
+        <a style="font-weight: bold;" href="${latestVersionLink}">View Latest</a>`
+    };
+};
+
+export function logCoveoPageView(
+    coveoOrganizationId: string | undefined,
+    coveoAnalyticsToken: string | undefined
+) {
+    if (coveoOrganizationId && coveoAnalyticsToken) {
+        const ua = new CoveoAnalyticsClient({
+            token: coveoAnalyticsToken,
+            endpoint: `https://${coveoOrganizationId}.analytics.org.coveo.com`
+        });
+        const pathParts = window.location.pathname.split("/");
+        let contentType;
+        if (pathParts.length >= 2) {
+            contentType = pathParts[1];
+        }
+
+        ua.sendViewEvent({
+            contentIdKey: "@clickableuri",
+            contentType: contentType,
+            contentIdValue: window.location.href
+        });
+    }
+}

package/src/modules/doc/container/__benchmarks__/container.benchmarkrenamed.js

@@ -1,18 +0,0 @@
-import { createElement } from "lwc";
-import Container from "doc/container";
-
-describe("doc-container", () => {
-    benchmark("creates and renders", () => {
-        let element;
-        run(() => {
-            element = createElement("doc-container", {
-                is: Container
-            });
-            element.performanceTest = require("../__fixtures__/metadata.json");
-            document.body.appendChild(element);
-        });
-        after(() => {
-            return element && element.parentElement.removeChild(element);
-        });
-    });
-});

package/src/modules/doc/container/container.css

@@ -1,8 +0,0 @@
-div {
-    display: flex;
-}
-
-doc-nav {
-    margin-right: 50px;
-    width: 400px;
-}

package/src/modules/doc/container/container.html

@@ -1,11 +0,0 @@
-<template>
-    <div if:true={loaded}>
-        <doc-nav
-            toc={toc}
-            available-languages={availableLanguages}
-            pdf-url={pdfUrl}
-            available-versions={availableVersions}
-        ></doc-nav>
-        <doc-content docs-data={docContent}></doc-content>
-    </div>
-</template>

package/src/modules/doc/container/container.stories.ts

@@ -1,15 +0,0 @@
-export default {
-    title: "docs/doc-container",
-    component: "doc-container"
-};
-
-export const Base = (args: any) => {
-    return `
-    <doc-container storybook-content-document-id='${args.selectedContentDocumentId}' storybook-content-id='${args.selectedContentId}'></doc-container>
-`;
-};
-
-Base.args = {
-    selectedContentDocumentId: "atlas.en-us.api_action.meta",
-    selectedContentId: "api_action"
-};

package/src/modules/doc/container/container.ts

@@ -1,164 +0,0 @@
-import { LightningElement, api, track } from "lwc";
-
-const API_MAIN_URL = "https://developer.salesforce.com/docs/get_document/";
-const API_DETAIL_URL =
-    "https://developer.salesforce.com/docs/get_document_content";
-
-/**
- * @element doc-container
- */
-export default class Container extends LightningElement {
-    // TODO: We have to evaluate if we can find a better way to do component testing in Storybook.
-    @api
-    set storybookContentId(value: string) {
-        this.selectedContentId = value;
-        this._isStorybook = true;
-    }
-    get storybookContentId() {
-        return this.selectedContentId;
-    }
-    @api
-    set storybookContentDocumentId(value: string) {
-        this.selectedContentDocumentId = value;
-    }
-    get storybookContentDocumentId() {
-        return this.selectedContentDocumentId;
-    }
-
-    @track docData: any; // TODO: We have to define proper TypeScript typings for data payloads
-
-    // Decouple navigation from content
-
-    // Navigation
-    navigationLoaded = false;
-    contentLoaded = false;
-    toc: string[] = [];
-    availableLanguages: string[] = [];
-    availableVersions: string[] = [];
-    pdfUrl: string | undefined;
-    deliverable: string | undefined;
-
-    // Content
-    @track docContent: any;
-
-    // Document selections
-    selectedContentDocumentId: string | undefined;
-    selectedContentId: string | undefined;
-    selectedLanguage: string[] = [];
-    selectedVersion: string[] = [];
-    selectedVersionUrl: string | undefined;
-
-    _isStorybook = false;
-
-    constructor() {
-        super();
-        this.template.addEventListener(
-            "navclick",
-            this.handleNavEvent.bind(this)
-        );
-        this.template.addEventListener(
-            "versionselected",
-            this.handleVersionEvent.bind(this)
-        );
-        this.template.addEventListener(
-            "languageselected",
-            this.handleLanguageEvent.bind(this)
-        );
-    }
-
-    connectedCallback() {
-        if (!this.navigationLoaded) {
-            this.fetchDocData("navigation");
-        } else {
-            this.fetchDocData("content");
-        }
-    }
-
-    handleNavEvent(event: CustomEvent) {
-        if (event.detail.url) {
-            let docIdPartials = window.location.pathname.split("/");
-            if (event.detail.type === "navigation") {
-                docIdPartials[4] = this.selectedContentId = `${event.detail.url}.htm`;
-            } else if (event.detail.type === "content") {
-                docIdPartials[4] = this.selectedContentId = `${event.detail.url}`;
-            }
-            const urlRewrite = docIdPartials.join("/");
-            window.history.pushState("Docs", "Docs", urlRewrite);
-            this.fetchDocData("content");
-        }
-    }
-
-    // TODO: handle language changes to doc_id
-
-    handleLanguageEvent(event: CustomEvent) {
-        this.selectedLanguage = event.detail;
-    }
-
-    handleVersionEvent(event: CustomEvent) {
-        this.selectedVersion = event.detail;
-    }
-
-    fetchDocData(docType: string) {
-        let docRestUrl = "";
-        let isContentDocumentIdFetch = false;
-
-        if (this._isStorybook) {
-            // TODO: We have to evaluate if we can find a better way to do component testing in Storybook.
-            docRestUrl = `${API_MAIN_URL}/${this.selectedContentDocumentId}/${this.selectedContentId}`;
-            isContentDocumentIdFetch = true;
-            this._isStorybook = false;
-        } else {
-            docRestUrl = this.generateCalloutURL(docType);
-        }
-
-        fetch(docRestUrl)
-            .then((result) => {
-                return result.json();
-            })
-            .then((json) => {
-                this.docData = json;
-                if (docType === "navigation") {
-                    this.toc = this.docData.toc;
-                    this.availableLanguages = this.docData.available_languages;
-                    this.availableVersions = this.docData.available_versions;
-                    this.selectedLanguage = this.docData.language;
-                    this.selectedVersion = this.docData.version;
-                    this.pdfUrl = this.docData.pdf_url;
-                    this.navigationLoaded = true;
-                    this.fetchDocData("content");
-                } else if (docType === "content") {
-                    this.docContent = this.docData.content;
-                    this.deliverable = this.docData.deliverable;
-                    let urlRewrite = window.location.pathname;
-                    if (urlRewrite.split("/").length < 2) {
-                        urlRewrite = `${window.location.pathname}/${this.deliverable}/${this.docData.toc[0].a_attr.href}`;
-                    }
-                    window.history.pushState("Docs", "Docs", urlRewrite);
-                    this.contentLoaded = true;
-                }
-            })
-            .catch((error) => console.log(error));
-    }
-
-    // Abstract the callout url creation
-    generateCalloutURL(docType: string) {
-        let base, page, docId, deliverable, contentDocumentId;
-        [
-            base,
-            page,
-            docId,
-            deliverable,
-            contentDocumentId
-        ] = window.location.pathname.split("/");
-        if (docType === "navigation") {
-            return API_MAIN_URL + "/" + docId;
-        } else if (docType === "content") {
-            return `${API_DETAIL_URL}/${deliverable}/${contentDocumentId}/${this.selectedLanguage.locale}/${this.selectedVersion.doc_version}`;
-        }
-    }
-
-    // Render page only with navigation and content are both loaded
-    get loaded() {
-        return this.navigationLoaded && this.contentLoaded;
-    }
-}

package/src/modules/doc/content/prismjs.css

@@ -1,184 +0,0 @@
-code[class*="language-"],
-pre[class*="language-"] {
-    color: #000;
-    background: 0 0;
-    font-family: Consolas, Monaco, "Andale Mono", "Ubuntu Mono", monospace;
-    font-size: 1em;
-    text-align: left;
-    white-space: pre;
-    word-spacing: normal;
-    word-break: normal;
-    word-wrap: normal;
-    line-height: 1.5;
-    -moz-tab-size: 4;
-    -o-tab-size: 4;
-    tab-size: 4;
-    -webkit-hyphens: none;
-    -moz-hyphens: none;
-    -ms-hyphens: none;
-    hyphens: none;
-}
-pre[class*="language-"] {
-    position: relative;
-    margin: 0.5em 0;
-    overflow: visible;
-    padding: 0;
-}
-pre[class*="language-"] > code {
-    position: relative;
-    border-left: 10px solid #358ccb;
-    box-shadow: -1px 0 0 0 #358ccb, 0 0 0 1px #dfdfdf;
-    background-color: #fdfdfd;
-    background-image: linear-gradient(
-        transparent 50%,
-        rgba(69, 142, 209, 0.04) 50%
-    );
-    background-size: 3em 3em;
-    background-origin: content-box;
-    background-attachment: local;
-}
-code[class*="language-"] {
-    max-height: inherit;
-    height: inherit;
-    padding: 0 1em;
-    display: block;
-    overflow: auto;
-}
-:not(pre) > code[class*="language-"],
-pre[class*="language-"] {
-    background-color: #fdfdfd;
-    -webkit-box-sizing: border-box;
-    -moz-box-sizing: border-box;
-    box-sizing: border-box;
-    margin-bottom: 1em;
-}
-:not(pre) > code[class*="language-"] {
-    position: relative;
-    padding: 0.2em;
-    border-radius: 0.3em;
-    color: #c92c2c;
-    border: 1px solid rgba(0, 0, 0, 0.1);
-    display: inline;
-    white-space: normal;
-}
-pre[class*="language-"]:after,
-pre[class*="language-"]:before {
-    content: "";
-    z-index: -2;
-    display: block;
-    position: absolute;
-    bottom: 0.75em;
-    left: 0.18em;
-    width: 40%;
-    height: 20%;
-    max-height: 13em;
-    box-shadow: 0 13px 8px #979797;
-    -webkit-transform: rotate(-2deg);
-    -moz-transform: rotate(-2deg);
-    -ms-transform: rotate(-2deg);
-    -o-transform: rotate(-2deg);
-    transform: rotate(-2deg);
-}
-pre[class*="language-"]:after {
-    right: 0.75em;
-    left: auto;
-    -webkit-transform: rotate(2deg);
-    -moz-transform: rotate(2deg);
-    -ms-transform: rotate(2deg);
-    -o-transform: rotate(2deg);
-    transform: rotate(2deg);
-}
-.token.block-comment,
-.token.cdata,
-.token.comment,
-.token.doctype,
-.token.prolog {
-    color: #7d8b99;
-}
-.token.punctuation {
-    color: #5f6364;
-}
-.token.boolean,
-.token.constant,
-.token.deleted,
-.token.function-name,
-.token.number,
-.token.property,
-.token.symbol,
-.token.tag {
-    color: #c92c2c;
-}
-.token.attr-name,
-.token.builtin,
-.token.char,
-.token.function,
-.token.inserted,
-.token.selector,
-.token.string {
-    color: #2f9c0a;
-}
-.token.entity,
-.token.operator,
-.token.url,
-.token.variable {
-    color: #a67f59;
-    background: rgba(255, 255, 255, 0.5);
-}
-.token.atrule,
-.token.attr-value,
-.token.class-name,
-.token.keyword {
-    color: #1990b8;
-}
-.token.important,
-.token.regex {
-    color: #e90;
-}
-.language-css .token.string,
-.style .token.string {
-    color: #a67f59;
-    background: rgba(255, 255, 255, 0.5);
-}
-.token.important {
-    font-weight: 400;
-}
-.token.bold {
-    font-weight: 700;
-}
-.token.italic {
-    font-style: italic;
-}
-.token.entity {
-    cursor: help;
-}
-.token.namespace {
-    opacity: 0.7;
-}
-@media screen and (max-width: 767px) {
-    pre[class*="language-"]:after,
-    pre[class*="language-"]:before {
-        bottom: 14px;
-        box-shadow: none;
-    }
-}
-pre[class*="language-"].line-numbers.line-numbers {
-    padding-left: 0;
-}
-pre[class*="language-"].line-numbers.line-numbers code {
-    padding-left: 3.8em;
-}
-pre[class*="language-"].line-numbers.line-numbers .line-numbers-rows {
-    left: 0;
-}
-pre[class*="language-"][data-line] {
-    padding-top: 0;
-    padding-bottom: 0;
-    padding-left: 0;
-}
-pre[data-line] code {
-    position: relative;
-    padding-left: 4em;
-}
-pre .line-highlight {
-    margin-top: 0;
-}

package/src/modules/doc/content/prismjs.html

@@ -1,3 +0,0 @@
-<template>
-    <!-- TODO: We don't need this file and have to figure why it's required by the build process. 🤷🏼‍♂️ -->
-</template>