@salesforcedevs/docs-components 1.3.124-old-version-banner-4 → 1.3.124-old-version-banner-6

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.124-old-version-banner-4",
+    "version": "1.3.124-old-version-banner-6",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",

package/src/modules/doc/amfReference/amfReference.html

@@ -26,7 +26,7 @@
             if:true={oldVersionInfo}
             doc-phase-info={oldVersionInfo}
             dismissible="true"
-            icon="warning"
+            icon-name="warning"
         ></doc-phase>
         <div slot="sidebar-header" class="version-picker">
             <template if:true={isVersionEnabled}>

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

@@ -1,4 +1,4 @@
-import { Json } from "typings/custom";
+import { Json, DocPhaseInfo } from "typings/custom";
 
 export interface AmfTopicType {
     referenceId: string;
@@ -46,14 +46,6 @@ export interface AmfModelRecord {
     parsedModel: Json;
 }
 
-export type DocPhase = "pilot" | "dev-preview" | "beta";
-
-export type DocPhaseEntry = {
-    phase: DocPhase;
-    title: string;
-    body: string;
-};
-
 export type ReferenceType = "markdown" | "rest-raml" | "rest-oa2" | "rest-oa3";
 
 /**
@@ -73,7 +65,7 @@ export interface ParsedMarkdownTopic {
 export interface AmfConfig {
     id: string;
     version?: string;
-    docPhase?: DocPhaseEntry;
+    docPhase?: DocPhaseInfo;
     title: string;
     href: string;
     referenceType: ReferenceType;

package/src/modules/doc/phase/phase.css

@@ -66,6 +66,7 @@ dx-button {
 
 .dismissible-icon {
     margin-left: auto;
+    cursor: pointer;
 }
 
 /* Small Devices */

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

@@ -36,8 +36,8 @@ export type DocVersion = DropdownOption & {
     releaseVersion: string;
     url: string;
     link?: {
-        href: string
-    }
+        href: string;
+    };
 };
 
 export type DocLanguage = DropdownOption & {

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

@@ -13,10 +13,11 @@
     >
         <doc-phase
             slot="version-banner"
-            if:true={oldVersionInfo}
+            if:true={showVersionBanner}
             doc-phase-info={oldVersionInfo}
+            icon-name="warning"
             dismissible="true"
-            icon="warning"
+            ondismissphase={handleDismissVersionBanner}
         ></doc-phase>
         <div slot="sidebar-header" class="document-pickers">
             <dx-dropdown

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

@@ -14,7 +14,7 @@ import {
 } from "./types";
 import { SearchSyncer } from "docUtils/SearchSyncer";
 import { LightningElementWithState } from "docBaseElements/lightningElementWithState";
-import { oldVersionDocInfo } from "docUtils/utils"
+import { oldVersionDocInfo } from "docUtils/utils";
 import { Breadcrumb, DocPhaseInfo, Language } from "typings/custom";
 
 // TODO: Imitating from actual implementation as doc-content use it like this. We should refactor it later.
@@ -35,30 +35,6 @@ export default class DocXmlContent extends LightningElementWithState<{
     @api coveoPublicAccessToken!: string;
     @api coveoSearchHub!: string;
 
-    @api
-    get oldVersionInfo(): DocPhaseInfo | null {
-        let info = null;
-        if (!this.disableVersion) {
-            const currentGAVersion = this.versionOptions.find((version) => version.url.includes(version.id));
-            if (currentGAVersion?.link?.href && this.version?.id) {
-                const versionNo = currentGAVersion.id;
-                /**
-                 * Need to show old version doc banner only if the version is less than the current ga version
-                 * We should not show it to the preview version whose version is more than ga
-                **/
-                try {
-                    if (parseFloat(this.version.id) < parseFloat(versionNo)) {
-                        info = oldVersionDocInfo(currentGAVersion.link.href)
-                    }
-                } catch (exception) {
-                    /* Ideally this use case should not happen, but just added to not to break the page*/
-                    console.warn(exception);
-                }
-            }
-        }
-        return info;
-    }
-
     @api
     get allLanguages(): Array<Language> {
         return this._allLanguages;
@@ -133,6 +109,33 @@ export default class DocXmlContent extends LightningElementWithState<{
     });
     private _allLanguages: Array<Language> = [];
 
+    private get oldVersionInfo(): DocPhaseInfo | null {
+        let info = null;
+        if (!this.disableVersion) {
+            const currentGAVersion = this.versionOptions.find(
+                (version) => !version.url.includes(version.id)
+            );
+            if (currentGAVersion?.link?.href && this.version?.id) {
+                const versionNo = currentGAVersion.id;
+                /**
+                 * Need to show old version doc banner only if the version is less than the current ga version
+                 * We should not show it to the preview version whose version is more than ga
+                 **/
+                try {
+                    if (parseFloat(this.version.id) < parseFloat(versionNo)) {
+                        info = oldVersionDocInfo(currentGAVersion.link.href);
+                    }
+                } catch (exception) {
+                    /* Ideally this use case should not happen, but just added to not to break the page*/
+                    console.warn(exception);
+                }
+            }
+        }
+        return info;
+    }
+
+    @track showVersionBanner = false;
+
     @track private pageReference: PageReference = {};
     @track breadcrumbs: Array<Breadcrumb> = [];
 
@@ -289,8 +292,9 @@ export default class DocXmlContent extends LightningElementWithState<{
 
     private get sidebarValue(): string {
         if (this.pageReference?.contentDocumentId) {
-            const hashedUri = `${this.pageReference.contentDocumentId
-                }${this.normalizeHash(this.pageReference.hash)}`;
+            const hashedUri = `${
+                this.pageReference.contentDocumentId
+            }${this.normalizeHash(this.pageReference.hash)}`;
             if (hashedUri in this.tocMap) {
                 return hashedUri;
             }
@@ -311,14 +315,14 @@ export default class DocXmlContent extends LightningElementWithState<{
         return this.disableVersion
             ? this.availableVersions
             : this.availableVersions.map((version) => ({
-                ...version,
-                link: {
-                    href: this.pageReferenceToString({
-                        ...this.pageReference,
-                        docId: version.url
-                    })
-                }
-            }));
+                  ...version,
+                  link: {
+                      href: this.pageReferenceToString({
+                          ...this.pageReference,
+                          docId: version.url
+                      })
+                  }
+              }));
     }
 
     private get breadcrumbPixelPerCharacter() {
@@ -338,6 +342,10 @@ export default class DocXmlContent extends LightningElementWithState<{
     private handlePopState = (event: PopStateEvent): void =>
         this.updatePageReference(this.getReferenceFromUrl(), event);
 
+    handleDismissVersionBanner() {
+        this.showVersionBanner = false;
+    }
+
     handleSelect(event: CustomEvent<{ name: string }>): void {
         event.stopPropagation();
         const { name } = event.detail;
@@ -428,7 +436,7 @@ export default class DocXmlContent extends LightningElementWithState<{
     isSamePage(reference: PageReference): boolean {
         return (
             this.pageReference.contentDocumentId ===
-            reference.contentDocumentId &&
+                reference.contentDocumentId &&
             this.pageReference.docId === reference.docId &&
             this.pageReference.page === reference.page &&
             this.pageReference.deliverable === reference.deliverable
@@ -469,6 +477,10 @@ export default class DocXmlContent extends LightningElementWithState<{
             this.updateUrl(HistoryState.REPLACE_STATE);
         }
 
+        if (this.oldVersionInfo) {
+            this.showVersionBanner = true;
+        }
+
         if (
             this.pageReference?.contentDocumentId?.replace(/\.htm$/, "") !==
             data.id
@@ -719,9 +731,9 @@ export default class DocXmlContent extends LightningElementWithState<{
                 metadescription.setAttribute(
                     "href",
                     window.location.protocol +
-                    "//" +
-                    window.location.host +
-                    this.pageReferenceToString(copyPageReference)
+                        "//" +
+                        window.location.host +
+                        this.pageReferenceToString(copyPageReference)
                 );
             }
         }

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

@@ -4,4 +4,4 @@ export const oldVersionDocInfo = (latestVersionLink: string) => {
         body: `This content describes an older version of this product. 
         <a style="font-weight: bold;" href="${latestVersionLink}">View Latest</a>`
     };
-}
+};