@salesforcedevs/docs-components 0.0.0

package/src/modules/doc/toc/toc.css

@@ -0,0 +1,31 @@
+:host,
+.nav1 {
+    display: block;
+}
+
+li {
+    font-size: 14px;
+    word-wrap: break-word !important;
+    overflow-wrap: break-word !important;
+}
+
+ul {
+    list-style-type: none;
+    padding-left: 0;
+}
+
+ul ul {
+    padding-left: 8px;
+}
+
+ul ul ul {
+    padding-left: 16px;
+}
+
+ul ul ul ul {
+    padding-left: 16px;
+}
+
+ul ul ul ul ul {
+    padding-left: 16px;
+}

package/src/modules/doc/toc/toc.html

@@ -0,0 +1,127 @@
+<template>
+    <!--template if:true={toc}>
+        <doc-tree items={toc} selected-item={selectedItem} onselect={handleNavClick}></doc-tree>
+    </template-->
+    <ul class="doc-toc-container">
+        <template for:each={toc} for:item="child1">
+            <li key={child1.id}>
+                <template if:true={child1.a_attr}>
+                    <a
+                        href={child1.a_attr.href}
+                        data-id={child1.id}
+                        class="nav1"
+                        onclick={handleNavClick}
+                    >
+                        {child1.text}
+                    </a>
+                </template>
+                <template if:false={child1.a_attr}>{child1.text}</template>
+            </li>
+            <template if:true={child1.children}>
+                <ul key={child1.id}>
+                    <template for:each={child1.children} for:item="child2">
+                        <li key={child2.id}>
+                            <template if:true={child2.a_attr}>
+                                <a
+                                    href={child2.a_attr.href}
+                                    data-id={child2.id}
+                                    class="nav1"
+                                    onclick={handleNavClick}
+                                >
+                                    {child2.text}
+                                </a>
+                            </template>
+                            <template if:false={child2.a_attr}>
+                                {child2.text}
+                            </template>
+                        </li>
+                        <template if:true={child2.children}>
+                            <ul key={child2.id}>
+                                <template
+                                    for:each={child2.children}
+                                    for:item="child3"
+                                >
+                                    <li key={child3.id}>
+                                        <template if:true={child3.a_attr}>
+                                            <a
+                                                href={child3.a_attr.href}
+                                                data-id={child3.id}
+                                                class="nav1"
+                                                onclick={handleNavClick}
+                                            >
+                                                {child3.text}
+                                            </a>
+                                        </template>
+                                        <template if:false={child3.a_attr}>
+                                            {child3.text}
+                                        </template>
+                                    </li>
+                                    <template if:true={child3.children}>
+                                        <ul key={child3.id}>
+                                            <template
+                                                for:each={child3.children}
+                                                for:item="child4"
+                                            >
+                                                <li key={child4.id}>
+                                                    <template
+                                                        if:true={child4.a_attr}
+                                                    >
+                                                        <a
+                                                            href={child4.a_attr.href}
+                                                            data-id={child4.id}
+                                                            class="nav1"
+                                                            onclick={handleNavClick}
+                                                        >
+                                                            {child4.text}
+                                                        </a>
+                                                    </template>
+                                                    <template
+                                                        if:false={child4.a_attr}
+                                                    >
+                                                        {child4.text}
+                                                    </template>
+                                                </li>
+                                                <template
+                                                    if:true={child4.children}
+                                                >
+                                                    <ul key={child4.id}>
+                                                        <template
+                                                            for:each={child4.children}
+                                                            for:item="child5"
+                                                        >
+                                                            <li key={child5.id}>
+                                                                <template
+                                                                    if:true={child5.a_attr}
+                                                                >
+                                                                    <a
+                                                                        href={child5.a_attr.href}
+                                                                        data-id={child5.id}
+                                                                        class="
+                                                                            nav1
+                                                                        "
+                                                                        onclick={handleNavClick}
+                                                                    >
+                                                                        {child5.text}
+                                                                    </a>
+                                                                </template>
+                                                                <template
+                                                                    if:false={child5.a_attr}
+                                                                >
+                                                                    {child5.text}
+                                                                </template>
+                                                            </li>
+                                                        </template>
+                                                    </ul>
+                                                </template>
+                                            </template>
+                                        </ul>
+                                    </template>
+                                </template>
+                            </ul>
+                        </template>
+                    </template>
+                </ul>
+            </template>
+        </template>
+    </ul>
+</template>

package/src/modules/doc/toc/toc.ts

@@ -0,0 +1,27 @@
+import { LightningElement, api } from "lwc";
+import { PageReference, SelectedNavigationItem, DocToc } from "typings/custom";
+
+export default class Toc extends LightningElement {
+    @api toc!: DocToc;
+    @api selectedNavigationItem!: SelectedNavigationItem;
+    @api pageReference!: PageReference;
+
+    handleNavClick(event: InputEvent) {
+        event.preventDefault();
+        const newPageReference = { ...this.pageReference };
+        // When moving to the new navigation component
+        //const target = event.detail.name.split('-')
+        const target = event.currentTarget.dataset.id.split("-");
+        newPageReference.contentDocumentId = target[0] + ".htm";
+        newPageReference.hash = target[1];
+        this.dispatchEvent(
+            new CustomEvent("navclick", {
+                detail: {
+                    pageReference: newPageReference
+                },
+                bubbles: true,
+                composed: true
+            })
+        );
+    }
+}

package/src/modules/doc/toolbar/toolbar.css

@@ -0,0 +1,8 @@
+.doc-toolbar-container {
+    margin: auto;
+    width: 80%;
+}
+
+.doc-toolbar-item {
+    margin: 5px;
+}

package/src/modules/doc/toolbar/toolbar.html

@@ -0,0 +1,34 @@
+<template>
+    <div class="doc-toolbar-container">
+        <select
+            class="doc-toolbar-item"
+            name="versions"
+            onchange={handleVersionChange}
+        >
+            <template for:each={availableVersions} for:item="version">
+                <option key={version.doc_version} value={version.doc_version}>
+                    v{version.release_version}
+                </option>
+            </template>
+        </select>
+        <select
+            class="dx-toolbar-item"
+            name="languages"
+            onchange={handleLanguageChange}
+        >
+            <template for:each={availableLanguages} for:item="language">
+                <option key={language.locale} value={language.locale}>
+                    {language.code}
+                </option>
+            </template>
+        </select>
+        <a
+            class="doc-toolbar-item"
+            href={pdfUrl}
+            target="_blank"
+            rel="noopener"
+        >
+            PDF
+        </a>
+    </div>
+</template>

package/src/modules/doc/toolbar/toolbar.ts

@@ -0,0 +1,79 @@
+import { LightningElement, api } from "lwc";
+import {
+    AvailableLanguages,
+    AvailableVersions,
+    PdfUrl,
+    SelectedLanguage,
+    SelectedVersion
+} from "typings/custom";
+
+export default class Toolbar extends LightningElement {
+    // Language Selector
+    @api availableLanguages!: AvailableLanguages;
+
+    @api selectedLanguage!: SelectedLanguage;
+
+    // Version Selector
+    @api availableVersions!: AvailableVersions;
+
+    @api selectedVersion!: SelectedVersion;
+
+    // PDF
+    @api pdfUrl!: PdfUrl;
+
+    /*
+    TODO: Update language on page load
+
+    renderedCallback(){
+        this.updateSelectedLanguage();
+    }
+
+    updateSelectedLanguage(){
+        const locale = this.selectedLanguage.locale;
+        const optionEl = this.template.querySelector(`option[name='${locale}']`);
+        console.log(JSON.stringify(optionEl));
+    }
+    */
+
+    handleLanguageChange() {
+        const languageEl = this.template.querySelector(
+            "select[name=languages]"
+        ) as HTMLSelectElement;
+        if (languageEl) {
+            const languageValue = (
+                languageEl[languageEl.selectedIndex] as HTMLOptionElement
+            ).value;
+            this.dispatchEvent(
+                new CustomEvent("languageselected", {
+                    detail: {
+                        value: languageValue,
+                        type: "language"
+                    },
+                    bubbles: true,
+                    composed: true
+                })
+            );
+        }
+    }
+
+    handleVersionChange() {
+        const versionEl = this.template.querySelector(
+            "select[name=versions]"
+        ) as HTMLSelectElement;
+        if (versionEl) {
+            const versionValue = (
+                versionEl[versionEl.selectedIndex] as HTMLOptionElement
+            ).value;
+            this.dispatchEvent(
+                new CustomEvent("versionselected", {
+                    detail: {
+                        value: versionValue,
+                        type: "version"
+                    },
+                    bubbles: true,
+                    composed: true
+                })
+            );
+        }
+    }
+}

package/src/modules/doc/xmlContent/types.ts

@@ -0,0 +1,114 @@
+export type CoveoAdvancedQueryXMLConfig = {
+    locale?: string;
+    version?: string;
+    topicid?: string;
+};
+
+export type PageReference = {
+    domain?: string;
+    page?: string;
+    docId?: string;
+    deliverable?: string;
+    contentDocumentId?: string;
+    hash?: string;
+    search?: string;
+};
+
+export enum HistoryState {
+    PUSH_STATE = "pushState",
+    REPLACE_STATE = "replaceState"
+}
+
+export type TreeNode = {
+    label: string;
+    name: string;
+    children?: Array<TreeNode>;
+    isExpanded?: boolean;
+    parent?: TreeNode;
+};
+
+type DropdownOption = {
+    id: string;
+    label: string;
+};
+
+export type DocVersion = DropdownOption & {
+    releaseVersion: string;
+    url: string;
+};
+
+export type DocLanguage = DropdownOption & {
+    code: string;
+    url: string;
+};
+
+export type ApiDocVersion = {
+    version_text: string;
+    release_version: string;
+    doc_version: string;
+    version_url: string;
+};
+
+export type ApiDocLanguage = {
+    code: string;
+    label: string;
+    locale: string;
+    url: string;
+};
+
+export interface Header extends Element {
+    subtitle: string;
+    bailHref: string;
+    bailLabel: string;
+    languages: Array<DocLanguage>;
+    language: string;
+    headerHref: string;
+}
+
+export type ApiNavItem = {
+    children: Array<ApiNavItem>;
+    text: string;
+    a_attr: {
+        href: string;
+    };
+    id: string;
+};
+
+export type ApiDocData = {
+    available_languages: Array<ApiDocLanguage>;
+    available_versions: Array<ApiDocVersion>;
+    content: string;
+    content_document_id: string;
+    deliverable: string;
+    doc_title: string;
+    language: ApiDocLanguage;
+    title: string;
+    toc: Array<ApiNavItem>;
+    version: ApiDocVersion;
+    pdf_url: string;
+};
+
+export type ContentData = {
+    content: string;
+    id: string;
+    title: string;
+};
+
+export type DocumentData = ContentData & {
+    availableLanguages: Array<DocLanguage>;
+    availableVersions: Array<DocVersion>;
+    deliverable: string;
+    docTitle: string;
+    language: DocLanguage;
+    toc: Array<TreeNode>;
+    tocMap: { [key: string]: TreeNode };
+    version: DocVersion;
+    pdfUrl: string;
+};
+
+export type ContentApiOptions = {
+    version: string;
+    language: string;
+};
+
+export type TocMap = { [key: string]: TreeNode };

package/src/modules/doc/xmlContent/utils.ts

@@ -0,0 +1,161 @@
+import {
+    ApiDocData,
+    ApiDocLanguage,
+    ApiDocVersion,
+    ApiNavItem,
+    ContentApiOptions,
+    ContentData,
+    DocumentData,
+    DocLanguage,
+    DocVersion,
+    TreeNode,
+    TocMap
+} from "./types";
+import { Language } from "typings/custom";
+import { getLanguageDisplayTextById } from "dxUtils/language";
+
+export class FetchContent {
+    private apiDomain: string;
+    private languages: Array<Language> = [];
+
+    constructor(apiDomain: string, languages: Array<Language>) {
+        this.apiDomain = apiDomain;
+        this.languages = languages;
+    }
+
+    async fetchDocumentData(docId: string): Promise<DocumentData | null> {
+        try {
+            const {
+                available_languages,
+                available_versions,
+                toc,
+                content,
+                version,
+                language,
+                content_document_id,
+                title,
+                doc_title,
+                pdf_url,
+                deliverable
+            } = await this.fetchResource<ApiDocData>(
+                `${this.apiDomain}/docs/get_document/${docId}`
+            );
+
+            const { normalizedToc, tocMap } = this.normalizeToc(toc);
+            return {
+                availableLanguages:
+                    available_languages &&
+                    available_languages.map(this.normalizeLanguage.bind(this)),
+                availableVersions:
+                    available_versions &&
+                    available_versions.map(this.normalizeVersion.bind(this)),
+                content,
+                version: this.normalizeVersion(version),
+                id: content_document_id,
+                language: this.normalizeLanguage(language),
+                title,
+                toc: normalizedToc,
+                tocMap,
+                docTitle: doc_title,
+                pdfUrl: pdf_url,
+                deliverable
+            };
+        } catch (error) {
+            console.log(error);
+            return null;
+        }
+    }
+
+    fetchContent(
+        deliverable: string,
+        contentId: string,
+        options: ContentApiOptions
+    ): Promise<ContentData> {
+        return this.fetchResource<ContentData>(
+            `${this.apiDomain}/docs/get_document_content/${deliverable}/${contentId}/${options.language}/${options.version}`
+        );
+    }
+
+    private async fetchResource<T>(url: string): Promise<T> {
+        const response = await fetch(url);
+        if (!response.ok) {
+            throw new Error(response.statusText);
+        }
+
+        const json = await response.json();
+
+        return json;
+    }
+
+    private normalizeToc(apiToc: Array<ApiNavItem>): {
+        tocMap: { [key: string]: TreeNode };
+        normalizedToc: Array<TreeNode>;
+    } {
+        const tocMap = {};
+        const normalizedToc =
+            apiToc &&
+            apiToc.map((navItem) => this.normalizeNavItem(navItem, tocMap));
+
+        return { normalizedToc, tocMap };
+    }
+
+    private normalizeNavItem(
+        navItem: ApiNavItem,
+        tocMap: TocMap,
+        parentNavItem?: TreeNode
+    ): TreeNode {
+        const name = this.calculateNavItemName(navItem, tocMap);
+        const node: TreeNode = {
+            label: navItem.text,
+            name,
+            parent: parentNavItem
+        };
+
+        if (name) {
+            tocMap[name] = node;
+        }
+        node.children = navItem.children?.map((child) =>
+            this.normalizeNavItem(child, tocMap, node)
+        );
+        return node;
+    }
+
+    private calculateNavItemName(navItem: ApiNavItem, tocMap: TocMap): string {
+        let href = navItem.a_attr?.href || "";
+        if (href.includes("#")) {
+            const [pathUrl] = href.split("#");
+            href = pathUrl in tocMap ? href : pathUrl;
+        }
+        return href || navItem.id;
+    }
+
+    private normalizeVersion(version: ApiDocVersion): DocVersion {
+        return (
+            version && {
+                label: version.version_text,
+                releaseVersion:
+                    version.release_version &&
+                    !version.release_version.startsWith("v")
+                        ? `v${version.release_version}`
+                        : version.release_version,
+                id: version.doc_version,
+                url: version.version_url
+            }
+        );
+    }
+
+    private normalizeLanguage(language: ApiDocLanguage): DocLanguage {
+        return (
+            language && {
+                label:
+                    getLanguageDisplayTextById(
+                        this.languages,
+                        language.locale
+                    ) || language.label,
+                id: language.locale,
+                code: language.code,
+                url: language.url
+            }
+        );
+    }
+}

package/src/modules/doc/xmlContent/xmlContent.css

@@ -0,0 +1,32 @@
+:host {
+    --button-primary-color: var(--dx-g-blue-vibrant-50);
+    --button-primary-color-hover: var(--dx-g-blue-vibrant-40);
+}
+
+doc-breadcrumbs {
+    --dx-c-popover-z-index: 5;
+
+    display: block;
+    margin-bottom: var(--dx-g-spacing-2xl);
+}
+
+dx-dropdown {
+    --dx-c-dropdown-option-font-size: var(--dx-g-text-sm);
+}
+
+dx-dropdown > dx-button {
+    --dx-c-button-primary-color: var(--button-primary-color);
+    --dx-c-button-primary-color-hover: var(--button-primary-color-hover);
+    --border-color: var(--button-primary-color);
+
+    border-bottom: 1px dashed var(--border-color);
+}
+
+dx-dropdown > dx-button:hover {
+    --border-color: var(--button-primary-color-hover);
+}
+
+.document-pickers {
+    margin-left: auto;
+    margin-right: var(--dx-g-spacing-sm);
+}

package/src/modules/doc/xmlContent/xmlContent.html

@@ -0,0 +1,40 @@
+<template>
+    <doc-content-layout
+        if:true={loaded}
+        coveo-organization-id={coveoOrganizationId}
+        coveo-public-access-token={coveoPublicAccessToken}
+        coveo-search-hub="Developer_Docs_SS"
+        coveo-advanced-query-config={coveoAdvancedQueryConfig}
+        sidebar-header="Pages"
+        sidebar-content={sidebarContent}
+        sidebar-value={sidebarValue}
+        onselect={handleSelect}
+        use-old-sidebar={useOldSidebar}
+    >
+        <div slot="sidebar-header" class="document-pickers">
+            <dx-dropdown
+                data-type="version"
+                suppress-gtm-nav-headings
+                analytics-event={analyticsEvent}
+                options={versionOptions}
+                value={version.id}
+                width="290px"
+            >
+                <dx-button variant="inline" disabled={disableVersion}>
+                    {version.releaseVersion}
+                </dx-button>
+            </dx-dropdown>
+        </div>
+        <doc-breadcrumbs
+            if:true={showBreadcrumbs}
+            breadcrumbs={breadcrumbs}
+            pixel-per-character={breadcrumbPixelPerCharacter}
+        ></doc-breadcrumbs>
+        <doc-content
+            docs-data={docContent}
+            page-reference={pageReference}
+            onnavclick={handleNavClick}
+            style={docContentStyle}
+        ></doc-content>
+    </doc-content-layout>
+</template>