@salesforcedevs/docs-components 0.56.0 → 0.56.2-comp-flex-ref-2

package/src/modules/doc/amfReference/constants.ts

@@ -0,0 +1,76 @@
+const NAVIGATION_ITEMS = [
+    {
+        label: "Summary",
+        name: "summary",
+        childrenPropertyName: undefined,
+        type: "summary"
+    },
+    {
+        label: "Endpoints",
+        name: "endpoints",
+        childrenPropertyName: "endpoints",
+        type: "endpoint"
+    },
+    {
+        label: "Documentation",
+        name: "documentation",
+        childrenPropertyName: "docs",
+        type: "documentation"
+    },
+    {
+        label: "Types",
+        name: "types",
+        childrenPropertyName: "types",
+        type: "type"
+    },
+    {
+        label: "Security",
+        name: "security",
+        childrenPropertyName: "security",
+        type: "security"
+    }
+];
+
+const URL_CONFIG = {
+    summary: {
+        urlIdentifer: "label"
+    },
+    endpoint: {
+        urlIdentifer: "path"
+    },
+    method: {
+        urlIdentifer: "label"
+    },
+    documentation: {
+        urlIdentifer: "label"
+    },
+    type: {
+        urlIdentifer: "label",
+        prefix: "type:"
+    },
+    security: {
+        urlIdentifer: "label",
+        prefix: "security:"
+    }
+};
+
+export const REFERENCE_TYPES = {
+    markdown: "markdown",
+    raml: "rest-raml",
+    oa2: "rest-oa2",
+    oa3: "rest-oa3"
+};
+
+const oldReferenceIdNewReferenceIdMap: Record<string, string> = {
+    "commerce-api-assignments": "assignments",
+    "commerce-api-campaigns": "campaigns",
+    "commerce-api-catalogs": "catalogs",
+    "cdn-zones": "cdn-api-process-apis",
+    "inventory-impex": "impex",
+    "inventory-reservations": "inventory-reservation-service",
+    "shopper-login-and-api-access-service": "shopper-login",
+    "shopper-login-and-api-access-service-admin": "slas-admin",
+    "einstein-recommendations": "einstein-api-quick-start-guide"
+};
+
+export { NAVIGATION_ITEMS, URL_CONFIG, oldReferenceIdNewReferenceIdMap };

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

@@ -2,6 +2,7 @@ import { Json } from "typings/custom";
 
 export interface AmfTopicType {
     referenceId: string;
+    parentReferencePath: string;
     amfId: string;
     elementId: string;
     type: string;
@@ -53,11 +54,37 @@ export type DocPhaseEntry = {
     body: string;
 };
 
-export interface AmfConfig extends AmfModelRecord {
+export type ReferenceType = "markdown" | "rest-raml" | "rest-oa2" | "rest-oa3";
+
+/**
+ * Represents parsed topic for the sidebar.
+ */
+export interface ParsedMarkdownTopic {
+    label: string;
+    name: string;
+    children: ParsedMarkdownTopic[];
+    link?: {
+        href: string;
+        target?: string;
+    };
+}
+
+export interface AmfConfig {
     id: string;
-    amf: string;
     version?: string;
     docPhase?: DocPhaseEntry;
+    title: string;
+    href: string;
+    referenceType: ReferenceType;
+
+    // determines if a reference config is the current active and selected one.
+    isSelected: boolean;
+
+    // required for spec based references
+    amf?: string;
+
+    // required for markdown based references
+    topic?: ParsedMarkdownTopic;
 }
 
 export interface ParsedTopicModel {
@@ -84,10 +111,22 @@ export interface ReferenceVersion {
     label: string;
     deprecated?: boolean;
     selected?: boolean;
+    link: {
+        href: string;
+    };
 }
 
 export interface ReferenceSetConfig {
+    refId?: string;
     versionToRefMap?: Map<string, Array<AmfConfig>>;
     refList: Array<AmfConfig>;
-    versions?: Array<ReferenceVersion>;
+    versions: Array<ReferenceVersion>;
+}
+
+export interface RouteMeta {
+    meta: string;
+    referenceId: string;
+    topicId: string;
+    //type is only for spec based references
+    type?: string;
 }

package/src/modules/doc/contentLayout/contentLayout.ts

@@ -20,6 +20,7 @@ const HIGHLIGHTABLE_SELECTOR = [
     "th",
     "td"
 ].join(",");
+const OBSERVER_ATTACH_WAIT_TIME = 500;
 
 export default class ContentLayout extends LightningElement {
     @api sidebarValue: string;
@@ -95,6 +96,8 @@ export default class ContentLayout extends LightningElement {
         target: window
     });
     private tocValue?: string = undefined;
+    private observerTimerId = null;
+    private didScrollToSelectedHash = false;
 
     get showToc(): boolean {
         return this.tocOptions && this.tocOptions.length > 0;
@@ -119,6 +122,18 @@ export default class ContentLayout extends LightningElement {
         }
     }
 
+    renderedCallback(): void {
+        /**
+         * Note: We are adding timeout because chrome is optimizing and not triggering recent renderedCallback though elements reference is changed
+         * Also we are considering recent renderedCallback
+         */
+        this.clearRenderObserverTimer();
+        this.observerTimerId = setTimeout(
+            this.attachInteractionObserver,
+            OBSERVER_ATTACH_WAIT_TIME
+        );
+    }
+
     disconnectedCallback(): void {
         this.disconnectObserver();
         window.removeEventListener(
@@ -126,19 +141,25 @@ export default class ContentLayout extends LightningElement {
             this.updateHighlighted
         );
         this.searchSyncer.dispose();
+        this.clearRenderObserverTimer();
     }
 
+    clearRenderObserverTimer = () => {
+        if (this.observerTimerId) {
+            clearTimeout(this.observerTimerId);
+        }
+    };
+
     updateHighlighted = (event: Event): void =>
         highlightTerms(
             this.querySelectorAll(HIGHLIGHTABLE_SELECTOR),
             (event as CustomEvent<string>).detail
         );
 
-    onSlotChange(event: Event): void {
+    attachInteractionObserver = (): void => {
         if (!this.enableSlotChange) {
             return;
         }
-
         this.disconnectObserver();
         this.observer = new IntersectionObserver((entries) => {
             entries.forEach(
@@ -150,30 +171,54 @@ export default class ContentLayout extends LightningElement {
             this.calculateActualSection();
         });
 
-        const anchoredTags = (event.target as HTMLSlotElement)
-            .assignedElements()
-            .filter(({ tagName }) => tagName === TOC_HEADER_TAG)
-            .map((tag) => {
-                tag.id = tag.hash;
-                return tag;
-            });
-
-        this._tocOptions = anchoredTags.map((tag) => ({
-            anchor: `#${tag.hash}`,
-            id: tag.id,
-            label: tag.title
-        }));
-
-        this.scrollToHash(anchoredTags);
-
-        anchoredTags.forEach((section) => {
-            const id = section.getAttribute("id");
+        // Note: We are doing document.querySelectorAll as a quick fix as we are not getting heading elements reference this.querySelectorAll
+        const headingElements = document.querySelectorAll(TOC_HEADER_TAG);
+        for (const headingElement of headingElements) {
+            // Add headingElements to intersectionObserver for highlighting respective RNB item when user scroll
+            const id = headingElement.getAttribute("id");
             this.anchoredElements[id] = {
                 id,
                 intersect: false
             };
-            this.observer.observe(section);
-        });
+            this.observer.observe(headingElement);
+        }
+        if (!this.didScrollToSelectedHash) {
+            this.didScrollToSelectedHash = true;
+            this.scrollToHash(headingElements);
+        }
+    };
+
+    onSlotChange(event: Event): void {
+        const slotElements = (
+            event.target as HTMLSlotElement
+        ).assignedElements();
+
+        if (slotElements.length) {
+            const slotContentElement = slotElements[0];
+            const headingElements =
+                slotContentElement.ownerDocument?.getElementsByTagName(
+                    TOC_HEADER_TAG
+                );
+            for (const headingElement of headingElements) {
+                // Sometimes elements hash is not being set when slot content is wrapped with div
+                headingElement.hash =
+                    headingElement.attributes.hash?.nodeValue;
+            }
+            const tocOptions = [];
+            for (const headingElement of headingElements) {
+                headingElement.id = headingElement.hash;
+
+                // Update tocOptions from anchorTags
+                const tocItem = {
+                    anchor: `#${headingElement.hash}`,
+                    id: headingElement.id,
+                    label: headingElement.title
+                };
+                tocOptions.push(tocItem);
+            }
+
+            this._tocOptions = tocOptions;
+        }
     }
 
     private disconnectObserver(): void {
@@ -183,16 +228,16 @@ export default class ContentLayout extends LightningElement {
         }
     }
 
-    private scrollToHash(anchoredTags: Array<Element>): void {
+    // eslint-disable-next-line no-undef
+    private scrollToHash(headingElements: NodeListOf<Element>): void {
         let { hash } = window.location;
-
         if (hash) {
             hash = hash.substr(1);
-            const toScrollElement = anchoredTags.find(
-                (element) => element.getAttribute("id") === hash
-            );
-            if (toScrollElement) {
-                toScrollElement.scrollIntoView({ behavior: "auto" });
+            for (const headingElement of headingElements) {
+                if (headingElement.getAttribute("id") === hash) {
+                    headingElement.scrollIntoView({ behavior: "auto" });
+                    break;
+                }
             }
         }
     }

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

@@ -19,12 +19,6 @@ export enum HistoryState {
     REPLACE_STATE = "replaceState"
 }
 
-export type Labels = {
-    language_english: string;
-    language_japanese: string;
-    toc_title: string;
-};
-
 export type TreeNode = {
     label: string;
     name: string;

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

@@ -8,22 +8,18 @@ import {
     DocumentData,
     DocLanguage,
     DocVersion,
-    Labels,
     TreeNode
 } from "./types";
-
-const LOCALE_TO_LABEL = {
-    "en-us": "language_english",
-    "ja-jp": "language_japanese"
-};
+import { Language } from "typings/custom";
+import { getLanguageDisplayTextById } from "dxUtils/language";
 
 export class FetchContent {
     private apiDomain: string;
-    private labels: Labels;
+    private languages: Array<Language> = [];
 
-    constructor(apiDomain: string, labels: Labels) {
+    constructor(apiDomain: string, languages: Array<Language>) {
         this.apiDomain = apiDomain;
-        this.labels = labels;
+        this.languages = languages;
     }
 
     async fetchDocumentData(docId: string): Promise<DocumentData | null> {
@@ -148,11 +144,10 @@ export class FetchContent {
     }
 
     private normalizeLanguage(language: ApiDocLanguage): DocLanguage {
-        const labelKey = language.locale && LOCALE_TO_LABEL[language.locale];
+
         return (
             language && {
-                label:
-                    (labelKey && this.labels && this.labels[labelKey]) ||
+                label: getLanguageDisplayTextById(this.languages, language.locale) || 
                     language.label,
                 id: language.locale,
                 code: language.code,

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

@@ -1,11 +1,10 @@
 import { api, track } from "lwc";
-import { normalizeBoolean, toJson } from "dxUtils/normalizers";
+import { normalizeBoolean } from "dxUtils/normalizers";
 import { FetchContent } from "./utils";
 import {
     CoveoAdvancedQueryXMLConfig,
     DocLanguage,
     DocVersion,
-    Labels,
     TreeNode,
     Header,
     HistoryState,
@@ -13,6 +12,8 @@ import {
 } from "./types";
 import { SearchSyncer } from "docUtils/SearchSyncer";
 import { LightningElementWithState } from "docBaseElements/lightningElementWithState";
+import { Language } from "typings/custom";
+import { DEFAULT_LANGUAGES } from "dxUtils/constants";
 
 // TODO: Imitating from actual implementation as doc-content use it like this. We should refactor it later.
 const handleContentError = (error): void => console.log(error);
@@ -27,12 +28,14 @@ export default class DocXmlContent extends LightningElementWithState<{
     @api coveoPublicAccessToken!: string;
 
     @api
-    get labels() {
-        return this._labels;
+    get allLanguages(): Array<Language> {
+        return this._allLanguages;
     }
 
-    set labels(value) {
-        this._labels = toJson(value);
+    set allLanguages(value: string) {
+        if (value) {
+            this._allLanguages = JSON.parse(value);
+        }
     }
 
     @api
@@ -44,7 +47,6 @@ export default class DocXmlContent extends LightningElementWithState<{
         this._enableCoveo = normalizeBoolean(value);
     }
 
-    private _labels: Labels = null;
     private availableLanguages: Array<DocLanguage> = [];
     private availableVersions: Array<DocVersion> = [];
     private contentProvider: FetchContent;
@@ -98,6 +100,7 @@ export default class DocXmlContent extends LightningElementWithState<{
         shouldStopPropagation: true,
         target: window
     });
+    private _allLanguages: Array<Language> = DEFAULT_LANGUAGES;
 
     @track private pageReference: PageReference = {};
 
@@ -120,8 +123,10 @@ export default class DocXmlContent extends LightningElementWithState<{
             window.location.href = "/docs";
             return;
         }
-
-        this.contentProvider = new FetchContent(this.apiDomain, this._labels);
+        this.contentProvider = new FetchContent(
+            this.apiDomain,
+            this.allLanguages
+        );
         this.fetchDocument().then(() => (this.loaded = true));
         window.addEventListener("popstate", this.handlePopState);
 

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/doc/amfReference/route-meta.ts

@@ -1,22 +0,0 @@
-/**
- * Represents the URL reference meta on Reference page.
- * Contains information on selected Reference ID, Topic ID, and Topic Type
- * separated by ":"
- */
-export class RouteMeta {
-    meta: string;
-    referenceId = "";
-    topicId = "";
-    type = "";
-
-    constructor(meta: string) {
-        this.meta = meta;
-
-        if (meta && meta.includes(":")) {
-            const [referenceId, type, topicId] = meta.split(":");
-            this.referenceId = referenceId;
-            this.topicId = topicId || type;
-            this.type = type;
-        }
-    }
-}