@salesforcedevs/docs-components 1.3.209-alpha1 → 1.3.209-alpha2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.209-alpha1",
+    "version": "1.3.209-alpha2",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",

package/src/modules/doc/atlasContent/atlasContent.ts

@@ -1,15 +1,11 @@
-import {BaseContentElement} from "../xmlContent/baseContentElement";
+import { BaseContentElement } from "docBaseElements/baseContentElement";
+
 import { HistoryState, PageReference } from "../xmlContent/types";
 
-export default class xmlContentElement extends BaseContentElement{
-    
+export default class xmlContentElement extends BaseContentElement {
     getReferenceFromUrl(): PageReference {
-        const [
-            page,
-            docId,
-            deliverable,
-            contentDocumentId
-        ] = window.location.pathname.substr(1).split("/");
+        const [page, docId, deliverable, contentDocumentId] =
+            window.location.pathname.substr(1).split("/");
 
         const { origin: domain, hash, search } = window.location;
 
@@ -112,5 +108,4 @@ export default class xmlContentElement extends BaseContentElement{
             isFetchingContent: false
         });
     }
-    
-}
+}

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

@@ -87,7 +87,6 @@ export type ZoominApiNavItem = {
     url: string;
 };
 
-
 export type ApiDocData = {
     available_languages: Array<ApiDocLanguage>;
     available_versions: Array<ApiDocVersion>;
@@ -127,9 +126,6 @@ export type ContentApiOptions = {
 
 export type TocMap = { [key: string]: TreeNode };
 
-
-
-
 // ZOOMIN TYPES - START
 
 export type ZoominTocNode = {
@@ -137,7 +133,7 @@ export type ZoominTocNode = {
     bundle_id: string;
     childEntries?: Array<ZoominTocNode> | [];
     nav_path: string;
-    outputclasses: Array<string>,
+    outputclasses: Array<string>;
     title: string;
     url: string;
     parent?: ZoominTocNode;
@@ -222,6 +218,6 @@ export type ZoominDocContent = {
     topic_language: string;
     views: number;
     your_rating: null;
-}
+};
 
 // ZOOMIN TYPES - End

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

@@ -75,7 +75,7 @@ export class FetchContent {
             `${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) {
@@ -87,9 +87,7 @@ export class FetchContent {
         return json;
     }
 
-    private normalizeToc(
-        apiToc: Array<ApiNavItem>
-    ): {
+    private normalizeToc(apiToc: Array<ApiNavItem>): {
         tocMap: { [key: string]: TreeNode };
         normalizedToc: Array<TreeNode>;
     } {

package/src/modules/doc/zoominContent/mockResponses.ts

@@ -4208,7 +4208,6 @@ const zoominFetchDocContent = {
     your_rating: null
 };
 
-
 const zoominToc = [
     {
         bundle_id: "pardot-guides",
@@ -5219,5 +5218,9 @@ const zoominToc = [
     }
 ];
 
-
-export default { fetchResponseAtlas, atlastResponse, zoominFetchDocContent , zoominToc};
+export default {
+    fetchResponseAtlas,
+    atlastResponse,
+    zoominFetchDocContent,
+    zoominToc
+};

package/src/modules/doc/zoominContent/zoominContent.ts

@@ -1,11 +1,25 @@
-import {BaseContentElement} from "../xmlContent/baseContentElement";
-import { ApiDocLanguage, ApiDocVersion, ApiNavItem, DocLanguage, DocVersion, DocumentData, HistoryState, PageReference, TocMap, TreeNode, ZoominApiNavItem, ZoominDocContent } from "../xmlContent/types";
+import {
+    ApiDocLanguage,
+    ApiDocVersion,
+    ApiNavItem,
+    DocLanguage,
+    DocVersion,
+    DocumentData,
+    HistoryState,
+    PageReference,
+    TocMap,
+    TreeNode,
+    ZoominApiNavItem,
+    ZoominDocContent
+} from "../xmlContent/types";
 import { Language } from "typings/custom";
+import { BaseContentElement } from "docBaseElements/baseContentElement";
+
 import mockResponses from "./mockResponses";
 import { ZoominFetchContent } from "./zoominUtils";
 
-export default class xmlContentElement extends BaseContentElement{
-    connectedCallback(){
+export default class DocZoomInContent extends BaseContentElement {
+    connectedCallback() {
         this.contentProvider = new ZoominFetchContent(
             this.apiDomain,
             this.allLanguages
@@ -15,7 +29,7 @@ export default class xmlContentElement extends BaseContentElement{
 
     getReferenceFromUrl(): PageReference {
         //console.log(`get Reference from URL ${window.location.pathname}`);
-        
+
         // const [
         //     page,
         //     docId,
@@ -25,17 +39,14 @@ export default class xmlContentElement extends BaseContentElement{
 
         // const { origin: domain, hash, search } = window.location;
 
-        const [
-            page,
-            docId,
-            deliverable,
-            contentDocumentId
-        ] = "/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/bi_ext_data_overview.htm".substr(1).split("/");
+        const [page, docId, deliverable, contentDocumentId] =
+            "/docs/atlas.en-us.bi_dev_guide_ext_data.meta/bi_dev_guide_ext_data/bi_ext_data_overview.htm"
+                .substr(1)
+                .split("/");
 
-        const domain = "localhost:3000"
-        const hash = ""
-        const search = ""
-        
+        const domain = "localhost:3000";
+        const hash = "";
+        const search = "";
 
         return {
             contentDocumentId,
@@ -80,11 +91,8 @@ export default class xmlContentElement extends BaseContentElement{
     //     this.availableVersions = data.availableVersions;
     //     this.pdfUrl = data.pdfUrl;
 
-
-        
-
     //     const { normalizedToc, tocMap } = this.normalizeToc(toc);
-        
+
     //     const data =  {
     //         availableLanguages:
     //             available_languages &&
@@ -169,10 +177,12 @@ export default class xmlContentElement extends BaseContentElement{
         //     this.pageReference.docId!
         // );
 
-        console.log("Get this doc ID now ---> " +this.pageReference.docId);
-        
-        const data = await this.mockedFetchDocumentData(this.pageReference.docId!)
-    
+        console.log("Get this doc ID now ---> " + this.pageReference.docId);
+
+        const data = await this.mockedFetchDocumentData(
+            this.pageReference.docId!
+        );
+
         //const data = zoominResponse;
 
         // This could be a 404 scenario.
@@ -247,15 +257,13 @@ export default class xmlContentElement extends BaseContentElement{
         //const data = mockResponses.zoominFetchDocContent;
 
         const data: ZoominDocContent = await this.contentProvider!.fetchContent(
-                this.pageReference.deliverable!,
+            this.pageReference.deliverable!,
             this.pageReference.contentDocumentId!,
             {
                 language: this.language!.id,
                 version: this.version!.id
             }
-        ) 
-
-
+        );
 
         // const data = await this.contentProvider!.zoominFetchContent(
         //         this.pageReference.deliverable!,
@@ -264,7 +272,7 @@ export default class xmlContentElement extends BaseContentElement{
         //         language: this.language!.id,
         //         version: this.version!.id
         //     }
-        // ) 
+        // )
 
         if (data) {
             this.docContent = data.topic_html;
@@ -278,14 +286,17 @@ export default class xmlContentElement extends BaseContentElement{
             isFetchingContent: false
         });
     }
-    
+
     async mockedFetchDocumentData(docId: string): Promise<DocumentData | null> {
         try {
-            console.log(`Doc requested ${docId} `)
+            console.log(`Doc requested ${docId} `);
             //const zoominToc: Array<ZoominApiNavItem> = mockResponses.zoominToc;
-            const zoominToc: Array<ZoominApiNavItem> = await this.contentProvider!.fetchDocumentData(this.pageReference.docId!)
+            const zoominToc: Array<ZoominApiNavItem> =
+                await this.contentProvider!.fetchDocumentData(
+                    this.pageReference.docId!
+                );
 
-            const atlastToc = this.transformZoominTocToAtlasToc(zoominToc)
+            const atlastToc = this.transformZoominTocToAtlasToc(zoominToc);
             const { normalizedToc, tocMap } = this.normalizeToc(atlastToc);
 
             const zoominDocData = mockResponses.zoominFetchDocContent;
@@ -314,8 +325,7 @@ export default class xmlContentElement extends BaseContentElement{
             const content_document_id = zoominDocData.bundle_id;
             const title = zoominDocData.title;
 
-
-            const mock_available_versions= [
+            const mock_available_versions = [
                 {
                     version_text: "Winter '24 (API version 59.0)",
                     release_version: "59.0",
@@ -328,32 +338,33 @@ export default class xmlContentElement extends BaseContentElement{
                     doc_version: "244.0",
                     version_url: "atlas.en-us.244.0.apexcode.meta"
                 }
-            ]
-            const mock_available_languages= [
+            ];
+            const mock_available_languages = [
                 {
                     label: "ENGLISH",
                     code: "EN",
                     locale: "en-us",
                     url: "atlas.en-us.246.0.apexcode.meta"
-                }
-                ,
+                },
                 {
                     label: "JAPANESE",
                     code: "JA",
                     locale: "ja-jp",
                     url: "atlas.ja-jp.246.0.apexcode.meta"
                 }
-            ]
-
+            ];
 
-            
             return {
                 availableLanguages:
                     mock_available_languages &&
-                    mock_available_languages.map(this.normalizeLanguage.bind(this)),
+                    mock_available_languages.map(
+                        this.normalizeLanguage.bind(this)
+                    ),
                 availableVersions:
                     mock_available_versions &&
-                    mock_available_versions.map(this.normalizeVersion.bind(this)),
+                    mock_available_versions.map(
+                        this.normalizeVersion.bind(this)
+                    ),
                 content: docContent,
                 version: this.normalizeVersion(version),
                 id: content_document_id,
@@ -371,25 +382,24 @@ export default class xmlContentElement extends BaseContentElement{
         }
     }
 
-    transformZoominTocToAtlasToc(zoominToc: ZoominApiNavItem[]): Array<ApiNavItem> 
-    {
+    transformZoominTocToAtlasToc(
+        zoominToc: ZoominApiNavItem[]
+    ): Array<ApiNavItem> {
         if (!zoominToc) {
             return [];
         }
         console.log(`transformZoominTocToAtlasToc ${zoominToc}`);
 
-        return zoominToc.map(zoominTocItem => ({
+        return zoominToc.map((zoominTocItem) => ({
             text: zoominTocItem.title,
             id: zoominTocItem.bundle_id,
             children: zoominTocItem.childEntries
                 ? this.transformZoominTocToAtlasToc(zoominTocItem.childEntries)
                 : []
-        }))
+        }));
     }
 
-    private normalizeToc(
-        apiToc: Array<ApiNavItem>
-    ): {
+    private normalizeToc(apiToc: Array<ApiNavItem>): {
         tocMap: { [key: string]: TreeNode };
         normalizedToc: Array<TreeNode>;
     } {
@@ -400,7 +410,7 @@ export default class xmlContentElement extends BaseContentElement{
 
         return { normalizedToc, tocMap };
     }
-    
+
     private normalizeNavItem(
         navItem: ApiNavItem,
         tocMap: TocMap,
@@ -437,7 +447,7 @@ export default class xmlContentElement extends BaseContentElement{
                 label: version.version_text,
                 releaseVersion:
                     version.release_version &&
-                    !version.release_version.startsWith("v")
+                        !version.release_version.startsWith("v")
                         ? `v${version.release_version}`
                         : version.release_version,
                 id: version.doc_version,
@@ -454,23 +464,21 @@ export default class xmlContentElement extends BaseContentElement{
                 //         this.languages,
                 //         language.locale
                 //     ) || language.label,
-                label: 'English',
-                id: 'en-us',
-                code: 'EN',
-                url: 'atlas.en-us.246.0.apexcode.meta'
+                label: "English",
+                id: "en-us",
+                code: "EN",
+                url: "atlas.en-us.246.0.apexcode.meta"
             }
         );
     }
 
-    private getLanguageDisplayTextById (
+    private getLanguageDisplayTextById(
         languages: Language[],
         languageId: string
-    ): string 
-    {
+    ): string {
         const language = languages.find(
             (languageItem) => languageItem.id === languageId
         );
         return language ? language.displayText : "";
-    };
-
-}
+    }
+}

package/src/modules/doc/zoominContent/zoominUtils.ts

@@ -1,6 +1,10 @@
 import { Language } from "typings/custom";
-import { ContentApiOptions, ZoominApiNavItem, ZoominDocContent } from "../xmlContent/types";
-import jsonwebtoken from 'jsonwebtoken'
+import {
+    ContentApiOptions,
+    ZoominApiNavItem,
+    ZoominDocContent
+} from "../xmlContent/types";
+//import jsonwebtoken from 'jsonwebtoken'
 import mockResponses from "./mockResponses";
 
 export class ZoominFetchContent {
@@ -11,7 +15,7 @@ export class ZoominFetchContent {
         this.apiDomain = apiDomain;
         this.languages = languages;
     }
-    
+
     async fetchDocumentData(docId: string): Promise<Array<ZoominApiNavItem>> {
         try {
             // const token = this.fetchZoomInToken();
@@ -20,14 +24,13 @@ export class ZoominFetchContent {
             //     `https://salesforce-be-dev.zoominsoftware.io/api/bundle/pardot-guides/toc?jwt=${token}`
             // );
             // return data;
-            console.log(`Doc Id ${docId} `)
+            console.log(`Doc Id ${docId} `);
             return new Promise((resolve) => {
                 // Simulating an asynchronous operation, such as fetching data from a server
                 setTimeout(() => {
-                  return resolve(mockResponses.zoominToc); // Resolve the promise with the string value
+                    return resolve(mockResponses.zoominToc); // Resolve the promise with the string value
                 }, 50); // Simulating a delay of 1 second
             });
-
         } catch (error) {
             console.log(error);
             return null;
@@ -45,10 +48,12 @@ export class ZoominFetchContent {
         //     `https://salesforce-be-dev.zoominsoftware.io/api/bundle/sample_md/page/b2c-developer-sandboxes.html?jwt=${token}`
         // );
         // return data;
+        console.log(`ZoominContent ${deliverable} ${contentId} ${options}`);
+
         return new Promise((resolve) => {
             // Simulating an asynchronous operation, such as fetching data from a server
             setTimeout(() => {
-              return resolve(mockResponses.zoominFetchDocContent); // Resolve the promise with the string value
+                return resolve(mockResponses.zoominFetchDocContent); // Resolve the promise with the string value
             }, 50); // Simulating a delay of 1 second
         });
     }
@@ -64,25 +69,25 @@ export class ZoominFetchContent {
         return json;
     }
 
-    private fetchZoomInToken(){
+    private fetchZoomInToken() {
         const payload = {
-          aud: 'https://salesforce-be-dev.zoominsoftware.io',
-          iss: 'https://salesforce.com',
-          iat: Math.floor(Date.now() / 1000),
-          exp: Math.floor(Date.now() / 1000) + 360,
-          sub: 'lnemalipuri@salesforce.com',
-          data: {
-            ZoominRole: 'admin',
-            fullName: 'kishore',
-          },
+            aud: "https://salesforce-be-dev.zoominsoftware.io",
+            iss: "https://salesforce.com",
+            iat: Math.floor(Date.now() / 1000),
+            exp: Math.floor(Date.now() / 1000) + 360,
+            sub: "lnemalipuri@salesforce.com",
+            data: {
+                ZoominRole: "admin",
+                fullName: "kishore"
+            }
         };
+        console.log(`${payload}`);
+
         // Need to update the token while running
         //const token = jsonwebtoken.sign(payload, 'fcrvBbXi1Aimu6sIiZMlcvIP9CqjYjVd');
         //console.log(token);
         // return token;
 
-        return `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJodHRwczovL3NhbGVzZm9yY2UtYmUtZGV2Lnpvb21pbnNvZnR3YXJlLmlvIiwiaXNzIjoiaHR0cHM6Ly9zYWxlc2ZvcmNlLmNvbSIsImlhdCI6MTcwODQxOTkxMCwiZXhwIjoxNzA4Nzc5OTEwLCJzdWIiOiJsbmVtYWxpcHVyaUBzYWxlc2ZvcmNlLmNvbSIsImRhdGEiOnsiWm9vbWluUm9sZSI6ImFkbWluIiwiZnVsbE5hbWUiOiJraXNob3JlIn19.1ekF_78Mq5136do4TdpQaPTy-CUroom0N1DdczcirSk`
+        return `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJodHRwczovL3NhbGVzZm9yY2UtYmUtZGV2Lnpvb21pbnNvZnR3YXJlLmlvIiwiaXNzIjoiaHR0cHM6Ly9zYWxlc2ZvcmNlLmNvbSIsImlhdCI6MTcwODQxOTkxMCwiZXhwIjoxNzA4Nzc5OTEwLCJzdWIiOiJsbmVtYWxpcHVyaUBzYWxlc2ZvcmNlLmNvbSIsImRhdGEiOnsiWm9vbWluUm9sZSI6ImFkbWluIiwiZnVsbE5hbWUiOiJraXNob3JlIn19.1ekF_78Mq5136do4TdpQaPTy-CUroom0N1DdczcirSk`;
     }
-
 }
-

package/src/modules/{doc/xmlContent → docBaseElements/baseContentElement}/baseContentElement.ts

@@ -1,20 +1,20 @@
 /* eslint-disable @lwc/lwc/no-document-query */
 import { api, track } from "lwc";
 import { normalizeBoolean } from "dxUtils/normalizers";
-import { FetchContent } from "./utils";
+import { FetchContent } from "../../doc/xmlContent/utils";
 import {
     CoveoAdvancedQueryXMLConfig,
     DocLanguage,
     DocVersion,
     TreeNode,
     Header,
-    HistoryState,
+    //HistoryState,
     PageReference,
     TocMap
-} from "./types";
+} from "../../doc/xmlContent/types";
 import { SearchSyncer } from "docUtils/searchSyncer";
 import { LightningElementWithState } from "dxBaseElements/lightningElementWithState";
-import { logCoveoPageView, oldVersionDocInfo } from "docUtils/utils";
+import { /*logCoveoPageView,*/ oldVersionDocInfo } from "docUtils/utils";
 import { Breadcrumb, DocPhaseInfo, Language } from "typings/custom";
 import { track as trackGTM } from "dxUtils/analytics";
 
@@ -567,9 +567,8 @@ export abstract class BaseContentElement extends LightningElementWithState<{
         }
     }
 
-    updateUrl(method = HistoryState.PUSH_STATE): void {
+    updateUrl(/*method = HistoryState.PUSH_STATE*/): void {
         //TODO: Revert this commenting - commented to work on storybook - window object is not working there.
-        
         //logCoveoPageView(this.coveoOrganizationId, this.coveoAnalyticsToken);
         // window.history[method](
         //     {},
@@ -586,20 +585,14 @@ export abstract class BaseContentElement extends LightningElementWithState<{
     }
 
     private updateSearchInput(searchParam: string): void {
-        (this.template.querySelector(
-            "doc-content-layout"
-        ) as any)?.setSidebarInputValue(searchParam);
+        (
+            this.template.querySelector("doc-content-layout") as any
+        )?.setSidebarInputValue(searchParam);
     }
 
     private pageReferenceToString(reference: PageReference): string {
-        const {
-            page,
-            docId,
-            deliverable,
-            contentDocumentId,
-            hash,
-            search
-        } = reference;
+        const { page, docId, deliverable, contentDocumentId, hash, search } =
+            reference;
         return `/${page}/${docId}/${deliverable}/${contentDocumentId}${this.normalizeSearch(
             search!
         )}${this.normalizeHash(hash)}`;