@salesforcedevs/docs-components 1.3.2 → 1.3.4-alpha

package/lwc.config.json

@@ -7,15 +7,22 @@
     "expose": [
         "doc/amfReference",
         "doc/breadcrumbs",
+        "doc/componentPlayground",
         "doc/content",
         "doc/contentCallout",
+        "doc/doDont",
         "doc/contentLayout",
         "doc/contentMedia",
         "doc/docXmlContent",
+        "doc/lwcContentLayout",
         "doc/header",
         "doc/heading",
         "doc/headingAnchor",
+        "doc/overview",
         "doc/phase",
-        "doc/xmlContent"
+        "doc/specificationContent",
+        "doc/versionPicker",
+        "doc/xmlContent",
+        "docUtils/utils"
     ]
 }

package/package.json

@@ -1,28 +1,28 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.3.2",
+    "version": "1.3.4-alpha",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
     "engines": {
-        "node": ">= 14.x"
+        "node": "20.x"
     },
     "publishConfig": {
         "access": "public"
     },
     "dependencies": {
-        "@api-components/amf-helper-mixin": "^4.5.17",
-        "classnames": "^2.2.6",
-        "kagekiri": "^1.4.1",
-        "lodash.orderby": "^4.6.0",
-        "lodash.uniqby": "^4.7.0",
-        "query-string": "^7.1.1",
-        "sentence-case": "^3.0.4"
+        "@api-components/amf-helper-mixin": "4.5.24",
+        "classnames": "2.5.1",
+        "kagekiri": "1.4.2",
+        "lodash.orderby": "4.6.0",
+        "lodash.uniqby": "4.7.0",
+        "query-string": "7.1.3",
+        "sentence-case": "3.0.4"
     },
     "devDependencies": {
-        "@types/classnames": "^2.2.10",
-        "@types/lodash.orderby": "^4.6.7",
-        "@types/lodash.uniqby": "^4.7.7"
+        "@types/classnames": "2.3.1",
+        "@types/lodash.orderby": "4.6.9",
+        "@types/lodash.uniqby": "4.7.9"
     },
-    "gitHead": "6bce82b465b57812c5de5e80abbdb291e3809be1"
+    "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
 }

package/src/modules/doc/{amfReference/utils.ts → amfModelParser/amfModelParser.ts}

@@ -1,4 +1,9 @@
-import { AmfHelperMixin } from "@api-components/amf-helper-mixin";
+// @ts-nocheck not going to check this file because it deals almost entirely with the AmfHelperMixin, which is terrible and not worth messing with. We should just upgrade our LWC version instead.
+import {
+    AmfHelperMixin,
+    EndPoint,
+    Operation
+} from "@api-components/amf-helper-mixin";
 import { normalizeDomId } from "dxUtils/normalizers";
 
 const ID_PROPERTY = "@id";
@@ -7,7 +12,7 @@ const TYPE_PROPERTY = "@type";
 export class AmfModelParser extends AmfHelperMixin(Object) {
     _parsedModel = null;
 
-    constructor(api) {
+    constructor(api: any) {
         super();
         if (api) {
             this.amf = Array.isArray(api) ? api[0] : api;
@@ -517,7 +522,7 @@ export class AmfModelParser extends AmfHelperMixin(Object) {
      * @param {string} selected Currently selected `@id`.
      * @return {any|undefined} Model definition for an endpoint fragment.
      */
-    computeEndpointApiModel(model, selectedId) {
+    computeEndpointApiModel(model, selectedId): EndPoint {
         const webApi = this._computeApi(model);
         return this._computeEndpointModel(webApi, selectedId);
     }
@@ -529,7 +534,7 @@ export class AmfModelParser extends AmfHelperMixin(Object) {
      * @param {string} selected Currently selected `@id`.
      * @return {any|undefined} Model definition for an endpoint fragment.
      */
-    computeMethodApiModel(model, selected) {
+    computeMethodApiModel(model, selected): Operation | undefined {
         const webApi = this._computeApi(model);
         return this._computeMethodModel(webApi, selected);
     }
@@ -541,7 +546,7 @@ export class AmfModelParser extends AmfHelperMixin(Object) {
      * @param {string} selected Currently selected `@id`.
      * @return {any|undefined} Model definition for an endpoint fragment.
      */
-    computeEndpointApiMethodModel(model, selected) {
+    computeEndpointApiMethodModel(model, selected): EndPoint | undefined {
         const webApi = this._computeApi(model);
         return this._computeMethodEndpoint(webApi, selected);
     }

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

@@ -1,5 +1,25 @@
-@import "docHelpers/phaseContentLayout";
+doc-phase {
+    --doc-c-phase-top: calc(
+        var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
+            var(--dx-g-spacing-xl)
+    );
+}
+
+/* We need to apply some borders when there are two doc phases */
+doc-phase:not(:only-of-type)::part(container) {
+    border-top: 1px solid var(--dx-g-yellow-vibrant-90);
+}
+
+doc-phase:nth-child(2)::part(container) {
+    border-top: 1px solid var(--dx-g-yellow-vibrant-90);
+    border-bottom: 1px solid var(--dx-g-yellow-vibrant-90);
+}
+
+/* We don't want second component to sticky as we need to handle different cases like position */
+doc-phase:nth-child(2) {
+    position: static;
+}
 
-.version-picker {
-    margin-left: auto;
+.api-documentation {
+    margin-top: 48px;
 }

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

@@ -1,9 +1,11 @@
 <template>
     <doc-content-layout
+        lwc:if={isVersionFetched}
         use-old-sidebar={useOldSidebar}
         class="content-type content-type-reference"
         coveo-organization-id={coveoOrganizationId}
         coveo-public-access-token={coveoPublicAccessToken}
+        coveo-analytics-token={coveoAnalyticsToken}
         coveo-search-hub={coveoSearchHub}
         coveo-advanced-query-config={coveoAdvancedQueryConfig}
         breadcrumbs={breadcrumbs}
@@ -15,33 +17,44 @@
         toc-title={tocTitle}
         toc-options={tocOptions}
         enable-slot-change="true"
+        languages={languages}
+        language={language}
+        show-footer={enableFooter}
     >
-        <div slot="doc-phase" if:true={docPhaseInfo} class="doc-phase-wrapper">
-            <doc-phase doc-phase-info={docPhaseInfo}></doc-phase>
+        <doc-phase
+            slot="doc-phase"
+            lwc:if={docPhaseInfo}
+            doc-phase-info={docPhaseInfo}
+        ></doc-phase>
+        <doc-phase
+            slot="version-banner"
+            lwc:if={showVersionBanner}
+            doc-phase-info={oldVersionInfo}
+            icon-name="warning"
+            dismissible="true"
+            ondismissphase={handleDismissVersionBanner}
+        ></doc-phase>
+        <div lwc:if={isVersionEnabled} slot="sidebar-header">
+            <doc-version-picker
+                onchange={handleVersionChange}
+                data-type="version"
+                versions={versions}
+                selected-version={selectedVersion}
+                latest-version={latestVersion}
+            ></doc-version-picker>
         </div>
-        <div slot="sidebar-header" class="version-picker">
-            <template if:true={isVersionEnabled}>
-                <dx-dropdown
-                    suppress-gtm-nav-headings
-                    onchange={handleVersionChange}
-                    data-type="version"
-                    options={versions}
-                    value={selectedVersion.id}
-                    width="290px"
-                >
-                    <dx-button variant="inline">{selectedVersion.id}</dx-button>
-                </dx-dropdown>
-            </template>
-        </div>
-        <template if:false={showSpecBasedReference}>
-            <slot></slot>
-        </template>
-        <template if:true={showSpecBasedReference}>
+        <template lwc:if={showSpecBasedReference}>
             <div class="container">
                 <div class="api-documentation">
-                    <doc-amf-topic model={topicModel}></doc-amf-topic>
+                    <doc-amf-topic
+                        lwc:if={topicModel}
+                        model={topicModel}
+                    ></doc-amf-topic>
                 </div>
             </div>
         </template>
+        <template lwc:else>
+            <slot></slot>
+        </template>
     </doc-content-layout>
 </template>