@salesforcedevs/docs-components 1.3.124-old-version-banner → 1.3.124-old-version-banner-3

package/package.json

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

package/src/modules/doc/amfReference/amfReference.css

@@ -14,7 +14,7 @@ doc-phase:nth-child(2)::part(container) {
     border-bottom: 1px solid #f9e3b6 !important;
 }
 
-/* We don't want second component to sticky as we need to handle different cases like position*/
+/* We don't want second component to sticky as we need to handle different cases like position */
 doc-phase:nth-child(2) {
     position: static;
 }

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

@@ -44,16 +44,17 @@ export default class AmfReference extends LightningElement {
     @track
     protected topicModel!: TopicModel;
 
-    @api oldVersionInfo = {
-        title: "Newer Version Available",
-        body: `This content describes an older version of this product. <a style="font-weight: bold;" href="https://developer.salesforce.com/">
-                View Latest</a>`,
-    }
-
     get isVersionEnabled(): boolean {
         return !!this._referenceSetConfig?.versions?.length;
     }
 
+    /*TODO: Get the info based on logic*/
+    @api oldVersionInfo = {
+        title: "Newer Version Available",
+        body: `This content describes an older version of this product. <a style="font-weight: bold;" href="https://developer.salesforce.com/">
+                View Latest</a>`
+    };
+
     /**
      * Gives if the currently selected reference is spec based or not
      */
@@ -173,12 +174,10 @@ export default class AmfReference extends LightningElement {
     constructor() {
         super();
 
-        this._boundOnApiNavigationChanged = this.onApiNavigationChanged.bind(
-            this
-        );
-        this._boundUpdateSelectedItemFromUrlQuery = this.updateSelectedItemFromUrlQuery.bind(
-            this
-        );
+        this._boundOnApiNavigationChanged =
+            this.onApiNavigationChanged.bind(this);
+        this._boundUpdateSelectedItemFromUrlQuery =
+            this.updateSelectedItemFromUrlQuery.bind(this);
     }
 
     connectedCallback(): void {
@@ -234,9 +233,8 @@ export default class AmfReference extends LightningElement {
                 const updatedReferenceId =
                     oldReferenceIdNewReferenceIdMap[referenceId];
                 const newReferenceId = updatedReferenceId || referenceId;
-                const referenceItemConfig = this.getAmfConfigWithId(
-                    newReferenceId
-                );
+                const referenceItemConfig =
+                    this.getAmfConfigWithId(newReferenceId);
                 if (referenceItemConfig) {
                     hashBasedRedirectUrl = `${referenceItemConfig.href}?meta=${encodedMeta}`;
                 }
@@ -305,9 +303,8 @@ export default class AmfReference extends LightningElement {
                 for (let i = 0; i < allVersions.length; i++) {
                     const versionItem = allVersions[i];
                     const referenceLink = versionItem.link.href;
-                    const referenceId = this.getReferenceIdFromUrl(
-                        referenceLink
-                    );
+                    const referenceId =
+                        this.getReferenceIdFromUrl(referenceLink);
                     if (this._currentReferenceId === referenceId) {
                         // This is to navigate to respective topic in the changed version
                         versionItem.link.href = `${referenceLink}/${currentRefMeta}`;
@@ -1232,12 +1229,10 @@ export default class AmfReference extends LightningElement {
         }
         if (!isRedirecting) {
             const currentReferenceUrl = window.location.href;
-            const referenceMeta = this.getMarkdownReferenceMeta(
-                currentReferenceUrl
-            );
-            const selectedItemRefId = this.getReferenceIdFromUrl(
-                currentReferenceUrl
-            );
+            const referenceMeta =
+                this.getMarkdownReferenceMeta(currentReferenceUrl);
+            const selectedItemRefId =
+                this.getReferenceIdFromUrl(currentReferenceUrl);
             const referenceDetails = this.getRefDetailsForGivenTopicMeta(
                 selectedItemRefId,
                 referenceMeta
@@ -1276,9 +1271,8 @@ export default class AmfReference extends LightningElement {
         const name = event.detail.name;
         if (name) {
             const urlReferenceId = this.getReferenceIdFromUrl(name);
-            const specBasedReference = this.isSpecBasedReference(
-                urlReferenceId
-            );
+            const specBasedReference =
+                this.isSpecBasedReference(urlReferenceId);
             if (specBasedReference) {
                 const metaVal = this.getMetaFromUrl(name);
                 const currentSelectedMeta = this.selectedTopic
@@ -1328,9 +1322,8 @@ export default class AmfReference extends LightningElement {
             const currentReferenceId = this.getReferenceIdFromUrl(currentUrl);
             //No need to do anything if user is expanding currently selected reference
             if (referenceId !== currentReferenceId) {
-                const isSpecBasedReference = this.isSpecBasedReference(
-                    referenceId
-                );
+                const isSpecBasedReference =
+                    this.isSpecBasedReference(referenceId);
                 if (isSpecBasedReference) {
                     // Perform functionality same as item selection
                     this.onNavSelect(event);

package/src/modules/doc/phase/phase.html

@@ -20,9 +20,9 @@
                     {hideBodyText}
                 </dx-button>
                 <dx-icon
+                    if:true={dismissible}
                     class="dismissible-icon"
                     onclick={onDismiss}
-                    if:true={dismissible}
                     symbol="close"
                     size="large"
                     color="status-icon-color"

package/src/modules/doc/phase/phase.ts

@@ -7,7 +7,7 @@ import { toJson, normalizeBoolean } from "dxUtils/normalizers";
 export default class Phase extends LightningElement {
     _docPhaseInfo: DocPhaseInfo | null = null;
     _dismissible = false;
-    _iconName = 'recipe';
+    _iconName = "recipe";
 
     @api
     get docPhaseInfo(): DocPhaseInfo | null {
@@ -67,9 +67,8 @@ export default class Phase extends LightningElement {
     }
 
     renderedCallback() {
-        const phaseBodyContainer = this.template.querySelector(
-            ".doc-phase-body"
-        );
+        const phaseBodyContainer =
+            this.template.querySelector(".doc-phase-body");
         if (phaseBodyContainer && this.docPhaseInfo) {
             // eslint-disable-next-line @lwc/lwc/no-inner-html
             phaseBodyContainer.innerHTML = this.docPhaseInfo.body;
@@ -79,16 +78,16 @@ export default class Phase extends LightningElement {
     onShowHide() {
         this.isBodyHidden = !this.isBodyHidden;
     }
-    
-    onDismiss(){
+
+    onDismiss() {
         this.dispatchEvent(
-            new CustomEvent("dismissbanner", {
-                detail: { 
+            new CustomEvent("dismissphase", {
+                detail: {
                     docPhaseInfo: this.docPhaseInfo
                 },
                 composed: true,
                 bubbles: true
             })
-        );   
+        );
     }
 }

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

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

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

@@ -44,3 +44,9 @@ dx-dropdown > dx-button:hover {
     margin-left: auto;
     margin-right: var(--dx-g-spacing-sm);
 }
+
+doc-phase {
+    --doc-c-phase-top: calc(
+        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
+    );
+}

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

@@ -14,7 +14,8 @@ import {
 } from "./types";
 import { SearchSyncer } from "docUtils/SearchSyncer";
 import { LightningElementWithState } from "docBaseElements/lightningElementWithState";
-import { Breadcrumb, Language } from "typings/custom";
+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.
 const handleContentError = (error): void => console.log(error);
@@ -34,10 +35,23 @@ export default class DocXmlContent extends LightningElementWithState<{
     @api coveoPublicAccessToken!: string;
     @api coveoSearchHub!: string;
 
-    @api oldVersionInfo = {
-        title: "Newer Version Available",
-        body: `This content describes an older version of this product. <a style="font-weight: bold;" href="https://developer.salesforce.com/">
-                View Latest</a>`,
+    @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) {
+                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
+                **/
+                if (parseFloat(this.version.id) < parseFloat(versionNo)) {
+                    info = oldVersionDocInfo(currentGAVersion.link.href)
+                }
+            }
+        }
+        return info;
     }
 
     @api
@@ -270,9 +284,8 @@ 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;
             }
@@ -293,14 +306,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() {
@@ -410,7 +423,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
@@ -701,9 +714,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

@@ -0,0 +1,7 @@
+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>`
+    };
+}