@salesforcedevs/docs-components 0.56.2-comp-flex-ref-1 → 0.56.2-example

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;
@@ -11,6 +11,7 @@ export interface AmfTopicType {
 export interface AmfMetadataTopic extends AmfTopicType {
     meta: string;
     identifier: string;
+    navTitle?: string;
 }
 
 export interface AmfMetaTopicType extends AmfTopicType {
@@ -20,7 +21,6 @@ export interface AmfMetaTopicType extends AmfTopicType {
 export interface NavItem {
     name: string;
     label: string;
-    // TODO: Better type here
     children?: ({
         id: string;
         label?: 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";
 
 /**
@@ -67,12 +59,13 @@ export interface ParsedMarkdownTopic {
         href: string;
         target?: string;
     };
+    isExpanded?: boolean;
 }
 
 export interface AmfConfig {
     id: string;
     version?: string;
-    docPhase?: DocPhaseEntry;
+    docPhase?: DocPhaseInfo;
     title: string;
     href: string;
     referenceType: ReferenceType;
@@ -102,7 +95,7 @@ export interface ParsedTopicModel {
 export interface TopicModel {
     id: string;
     type: string;
-    amf: AmfModel;
+    amf: string;
     parser: AmfParser;
 }
 

package/src/modules/doc/amfTopic/amfTopic.css

@@ -1 +1,21 @@
 @import "docHelpers/amfStyle";
+
+:host {
+    --reference-container-margin-top: var(--dx-g-spacing-sm);
+    --api-documentation-margin-top: var(--dx-g-spacing-3xl);
+}
+
+/**
+ * 1. We need to scroll to top from the tablet size as side nav bar and content in side by side from tablet size
+ * 2. Consider global nav height, doc header height and content margins to scroll to the right position
+ */
+
+@media screen and (min-width: 769px) {
+    .topic-container {
+        scroll-margin-top: calc(
+            var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
+                var(--reference-container-margin-top) +
+                var(--api-documentation-margin-top)
+        );
+    }
+}

package/src/modules/doc/amfTopic/amfTopic.ts

@@ -8,14 +8,17 @@ import {
     createTypeElement
 } from "./utils";
 import type { TopicModel } from "./types";
+import { Json } from "typings/custom";
+
+const TABLE_SIZE_MATCH = "769px";
 
 export default class AmfTopic extends LightningElement {
-    private _model;
-    private amf;
-    private type;
+    private _model: TopicModel | undefined;
+    private amf: Json;
+    private type: string | undefined;
 
     @api
-    get model(): TopicModel {
+    get model(): TopicModel | undefined {
         return this._model;
     }
 
@@ -24,13 +27,17 @@ export default class AmfTopic extends LightningElement {
             !this.amf ||
             (value && this._model && value.amf !== this._model?.amf)
         ) {
-            this.amf = value && clone(value.amf);
+            try {
+                this.amf = value && JSON.parse(value.amf);
+            } catch (error) {
+                console.error(`Error parsing amf model: ${error}`);
+            }
         }
         if (
             !this.type ||
             (value && this._model && value.type !== this._model?.type)
         ) {
-            this.type = value && clone(value.type);
+            this.type = value && value.type;
         }
 
         this._model = value;
@@ -41,7 +48,11 @@ export default class AmfTopic extends LightningElement {
     }
 
     update(): void {
-        const container = this.template.querySelector("div.topic-container");
+        if (!this.model) {
+            throw new Error("Amf TopicModel undefined when trying to update");
+        }
+
+        const container = this.template.querySelector(".topic-container")!;
         const { id } = this.model;
         const type = this.type;
         const amf = this.amf;
@@ -76,19 +87,25 @@ export default class AmfTopic extends LightningElement {
             element = createDocumentationElement(amf, docsModel);
         }
 
-        if (container.firstChild) {
+        if (container?.firstChild) {
             container.firstChild.remove();
         }
-        container.appendChild(element);
+        container?.appendChild(element as Node);
+
+        const isTabletOrDesktop = window.matchMedia(
+            `(min-width: ${TABLE_SIZE_MATCH})`
+        ).matches;
+
+        if (isTabletOrDesktop) {
+            window.scrollTo(0, 0);
+        }
     }
-}
 
-/**
- * The underlying web components we use from api-console mutate their models we pass in.
- * Since LWC makes them Read Only, we need to copy them before passing to the Web Component.
- * @param value JSON Serializable object to clone.
- * @returns A copy of Value. One that has been serialized and parsed via JSON. (Functions, Regex, etc are not preserved.)
- */
-function clone(value): object {
-    return JSON.parse(JSON.stringify(value));
+    renderedCallback(): void {
+        try {
+            this.update();
+        } catch (error) {
+            console.error(error);
+        }
+    }
 }

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

@@ -1,4 +1,11 @@
 import { Json } from "typings/custom";
+import { AmfModelParser } from "doc/amfModelParser";
+import {
+    DomainElement,
+    EndPoint,
+    Operation,
+    Shape
+} from "@api-components/amf-helper-mixin";
 
 export type ApiSummaryElement = HTMLElement & {
     amf: Json;
@@ -11,44 +18,39 @@ export type ApiEndpointElement = HTMLElement & {
     inlineMethods: boolean;
     noNavigation: boolean;
     selected: string;
-    endpoint: Json;
+    endpoint: EndPoint;
     noTryIt: boolean;
 };
 
 export type ApiMethodElement = HTMLElement & {
     amf: Json;
     noNavigation: boolean;
-    endpoint: Json;
-    method: Json;
+    endpoint: EndPoint | undefined;
+    method: Operation | undefined;
     noTryIt: boolean;
 };
 
 export type ApiSecurityElement = HTMLElement & {
     amf: Json;
-    security: Json;
+    security: DomainElement | undefined;
 };
 
 export type ApiTypeElement = HTMLElement & {
     amf: Json;
-    type: Json;
+    type?: Shape;
     mediaTypes: Json;
 };
 
 export type ApiDocElement = HTMLElement & {
     amf: Json;
-    shape: Json;
+    shape: DomainElement | undefined;
 };
 
 export type AmfModel = Json;
 
-export interface AmfParser {
-    parse(): void;
-    parsedModel: any;
-}
-
 export interface TopicModel {
     id: string;
     type: string;
-    amf: AmfModel;
-    parser: AmfParser;
+    amf: string;
+    parser: AmfModelParser;
 }

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

@@ -1,3 +1,9 @@
+import {
+    DomainElement,
+    EndPoint,
+    Operation,
+    Shape
+} from "@api-components/amf-helper-mixin";
 import type {
     ApiDocElement,
     ApiEndpointElement,
@@ -37,7 +43,7 @@ export function createSummaryElement(amf: Json): HTMLElement {
  */
 export function createEndpointElement(
     amf: Json,
-    endpointModel: Json,
+    endpointModel: EndPoint,
     selected: string
 ): HTMLElement {
     const el: ApiEndpointElement = document.createElement(
@@ -57,8 +63,8 @@ export function createEndpointElement(
  */
 export function createMethodElement(
     amf: Json,
-    endpointMethodModel: Json,
-    methodModel: Json
+    endpointMethodModel: EndPoint | undefined,
+    methodModel: Operation | undefined
 ): HTMLElement {
     const el: ApiMethodElement = document.createElement(
         "api-method-documentation"
@@ -79,7 +85,7 @@ export function createMethodElement(
  */
 export function createSecurityElement(
     amf: Json,
-    securityModel: Json
+    securityModel: DomainElement | undefined
 ): HTMLElement {
     const el: ApiSecurityElement = document.createElement(
         "api-security-documentation"
@@ -98,7 +104,7 @@ export function createSecurityElement(
  */
 export function createTypeElement(
     amf: Json,
-    typeModel: Json,
+    typeModel: Shape | undefined,
     mediaTypes: Json
 ): HTMLElement {
     const el: ApiTypeElement = document.createElement(
@@ -119,7 +125,7 @@ export function createTypeElement(
  */
 export function createDocumentationElement(
     amf: Json,
-    docsModel: Json
+    docsModel: DomainElement | undefined
 ): HTMLElement {
     const el: ApiDocElement = document.createElement(
         "api-documentation-document"

package/src/modules/doc/breadcrumbItem/breadcrumbItem.css

@@ -4,12 +4,13 @@
 :host {
     display: flex;
     align-items: center;
+    justify-content: center;
     width: fit-content;
 }
 
 :host(.breadcrumb_long) {
     /* ensure 30 character min-width */
-    min-width: 245px;
+    min-width: 200px;
 }
 
 :host(.breadcrumb_back-arrow) {

package/src/modules/doc/breadcrumbItem/breadcrumbItem.html

@@ -1,5 +1,5 @@
 <template>
     <dx-icon if:true={isBackArrowVariant} symbol="back"></dx-icon>
-    <a if:true={href} href={href}>{label}</a>
+    <a if:true={href} href={href} onclick={onLinkClick}>{label}</a>
     <span if:false={href}>{label}</span>
 </template>

package/src/modules/doc/breadcrumbItem/breadcrumbItem.ts

@@ -1,3 +1,4 @@
+import { track } from "dxUtils/analytics";
 import { LightningElement, api } from "lwc";
 import { BreadcrumbItemVariant } from "typings/custom";
 
@@ -7,6 +8,8 @@ const BREADCRUMB_BACK_ARROW = "breadcrumb_back-arrow";
 const LONG_LABEL_NUMBER = 30;
 export default class BreadcrumbItem extends LightningElement {
     @api href?: string;
+    @api level?: string;
+    @api breadcrumbLabels?: string;
 
     @api
     get label() {
@@ -46,4 +49,23 @@ export default class BreadcrumbItem extends LightningElement {
     private get isBackArrowVariant(): boolean {
         return this._variant === "back-arrow";
     }
+
+    private onLinkClick(event: Event): void {
+        track(event.target!, "custEv_breadcrumbClick", {
+            click_text: this.label,
+            click_url: `${window.location.origin}${this.href}`,
+            element_type: "link",
+            nav_type: "breadcrumb",
+            nav_level: this.level ? this.level + 1 : 1,
+            nav_item: this.breadcrumbLabels
+        });
+
+        track(event.target!, "custEv_linkClick", {
+            click_text: this.label,
+            click_url: `${window.location.origin}${this.href}`,
+            element_title: this.label,
+            element_type: "link",
+            content_category: "cta"
+        });
+    }
 }

package/src/modules/doc/breadcrumbs/breadcrumbs.css

@@ -4,12 +4,13 @@
 :host {
     --dx-c-breadcrumbs-title-color: var(--dx-g-blue-vibrant-20);
     --dx-c-breadcrumbs-breadcrumb-color: var(--dx-g-blue-vibrant-20);
+
+    font-family: var(--dx-g-font-sans);
 }
 
 nav {
     display: flex;
     align-items: center;
-    height: 100%;
     position: relative;
     gap: var(--dx-g-spacing-sm);
 }
@@ -17,3 +18,10 @@ nav {
 .breadcrumb-item_slash {
     min-width: fit-content;
 }
+
+dx-dropdown {
+    --dx-c-dropdown-option-font-size: var(--dx-g-text-sm);
+    --dx-c-dropdown-option-label-color: var(
+        --dx-c-breadcrumbs-breadcrumb-color
+    );
+}

package/src/modules/doc/breadcrumbs/breadcrumbs.html

@@ -1,48 +1,58 @@
 <template>
     <nav role="navigation" aria-label={ariaLabel}>
-        <template if:false={renderSmallVariant}>
-            <template if:true={renderFirstCrumb}>
+        <template if:true={displayCrumbs}>
+            <template if:false={renderSmallVariant}>
                 <doc-breadcrumb-item
                     href={firstCrumb.href}
                     label={firstCrumb.label}
+                    breadcrumb-labels={breadcrumbLabels}
                 ></doc-breadcrumb-item>
                 <span class="breadcrumb-item_slash">/</span>
+                <template if:true={renderDropdown}>
+                    <dx-dropdown
+                        analytics-event="custEv_breadcrumbClick"
+                        analytics-payload={ANALYTICS_PAYLOAD}
+                        if:true={renderDropdown}
+                        options={dropdownOptions}
+                        open-on-hover
+                        placement="bottom"
+                        variant="indented"
+                        width="fit-content"
+                    >
+                        <dx-button
+                            aria-label="Open Breadcrumbs Dropdown"
+                            icon-size="large"
+                            icon-symbol="threedots"
+                            variant="tertiary"
+                        ></dx-button>
+                    </dx-dropdown>
+                    <span class="breadcrumb-item_slash">/</span>
+                </template>
+                <template for:each={breadcrumbItems} for:item="breadcrumb">
+                    <doc-breadcrumb-item
+                        href={breadcrumb.href}
+                        key={breadcrumb.id}
+                        label={breadcrumb.label}
+                        level={breadcrumb.level}
+                        breadcrumb-labels={breadcrumbLabels}
+                    ></doc-breadcrumb-item>
+                    <span class="breadcrumb-item_slash" key={breadcrumb.label}>
+                        /
+                    </span>
+                </template>
+                <doc-breadcrumb-item
+                    label={lastCrumb.label}
+                    breadcrumb-labels={breadcrumbLabels}
+                ></doc-breadcrumb-item>
             </template>
-            <template if:true={renderDropdown}>
-                <dx-dropdown
-                    if:true={renderDropdown}
-                    options={dropdownOptions}
-                    open-on-hover
-                    placement="bottom"
-                    width="200px"
-                >
-                    <dx-button
-                        aria-label="Open Breadcrumbs Dropdown"
-                        icon-size="large"
-                        icon-symbol="threedots"
-                        variant="tertiary"
-                    ></dx-button>
-                </dx-dropdown>
-                <span class="breadcrumb-item_slash">/</span>
-            </template>
-            <template for:each={breadcrumbItems} for:item="breadcrumb">
+            <template if:true={renderSmallVariant}>
                 <doc-breadcrumb-item
-                    href={breadcrumb.href}
-                    key={breadcrumb.label}
-                    label={breadcrumb.label}
+                    href={lastLinkCrump.href}
+                    label={lastLinkCrump.label}
+                    breadcrumb-labels={breadcrumbLabels}
+                    variant="back-arrow"
                 ></doc-breadcrumb-item>
-                <span class="breadcrumb-item_slash" key={breadcrumb.label}>
-                    /
-                </span>
             </template>
-            <doc-breadcrumb-item label={lastCrumb.label}></doc-breadcrumb-item>
-        </template>
-        <template if:true={renderSmallVariant}>
-            <doc-breadcrumb-item
-                href={lastLinkCrump.href}
-                label={lastLinkCrump.label}
-                variant="back-arrow"
-            ></doc-breadcrumb-item>
         </template>
     </nav>
 </template>

package/src/modules/doc/breadcrumbs/breadcrumbs.ts

@@ -8,10 +8,12 @@ type BreadcrumbConfig = {
 };
 
 const GAP = 8;
+
+// Unit in pixels based on Salesforce Sans font-family.
 const CONSTANTS = {
-    pixelPerCharacter: 7.2,
-    pixelPerCrumbSpace: GAP * 2 + 4.6,
-    minWidthPerCrumb: 245,
+    pixelPerCharacter: 7.7,
+    pixelPerCrumbSpace: GAP * 2 + 8.6,
+    minWidthPerCrumb: 200,
     dropdownWidth: 32
 };
 
@@ -22,19 +24,30 @@ export default class Breadcrumbs extends LightningElement {
     get breadcrumbs(): Breadcrumb[] {
         return this._breadcrumbs;
     }
+
     set breadcrumbs(value) {
-        this._breadcrumbs = toJson(value) || [];
+        this.normalizeAndAssignBreadcrumbs(value);
         this.calculateBreadcrumbsConfigs();
-        if (this.observer) {
-            this.updateDropdownOptionAmount();
+        if (this.isRendered) {
+            this.onWidthOrContentChange();
         }
     }
 
+    @api
+    get pixelPerCharacter(): number {
+        return this._pixelPerCharacter;
+    }
+
+    set pixelPerCharacter(value: number | string) {
+        this._pixelPerCharacter = +value;
+    }
+
     private _breadcrumbs: Breadcrumb[] = [];
+    private _pixelPerCharacter = CONSTANTS.pixelPerCharacter;
     private navWidth = 0;
-    private observer: ResizeObserver | null = null;
     private breadcrumbConfigs: BreadcrumbConfig[] = [];
     private dropdownOptionAmount? = 0;
+    private isRendered = false;
 
     private get renderSmallVariant(): boolean {
         return (
@@ -65,14 +78,14 @@ export default class Breadcrumbs extends LightningElement {
     private get dropdownOptions(): OptionWithLink[] {
         return this.breadcrumbs!.slice(1, this.dropdownOptionAmount! + 1).map(
             (link) => ({
-                id: link.href!,
+                id: link.id!,
                 label: link.label,
                 link: { href: link.href! }
             })
         );
     }
 
-    private get renderFirstCrumb(): boolean {
+    private get displayCrumbs(): boolean {
         return this.breadcrumbs.length > 1;
     }
 
@@ -80,27 +93,52 @@ export default class Breadcrumbs extends LightningElement {
         return this.breadcrumbs[0];
     }
 
+    private get breadcrumbLabels(): string {
+        return this.breadcrumbs.map((crumb) => crumb.label).join(":");
+    }
+
     private get lastCrumb(): Breadcrumb {
         return this.breadcrumbs[this.breadcrumbs.length - 1];
     }
 
+    // this payload is only used for breadcrumb dropdown
+    private get ANALYTICS_PAYLOAD() {
+        return {
+            element_type: "link",
+            nav_type: "breadcrumb",
+            nav_level: 1
+        };
+    }
+
+    private onWidthOrContentChange = () => {
+        this.navWidth = this.template
+            .querySelector("nav")!
+            .getBoundingClientRect().width;
+        this.updateDropdownOptionAmount();
+    };
+
     renderedCallback(): void {
-        if (!this.observer) {
-            this.observer = new ResizeObserver((entries) => {
-                const [nav] = entries;
-                if (this.navWidth === nav.contentRect.width) {
-                    return;
-                }
-                this.navWidth = nav.contentRect.width;
-                this.updateDropdownOptionAmount();
-            });
-
-            this.observer.observe(this.template.querySelector("nav")!);
-        }
+        this.isRendered = true;
+        this.onWidthOrContentChange();
+        window.addEventListener("resize", this.onWidthOrContentChange);
     }
 
     disconnectedCallback(): void {
-        this.observer?.disconnect();
+        window.removeEventListener("resize", this.onWidthOrContentChange);
+    }
+
+    private normalizeAndAssignBreadcrumbs(breadcrumbs?: Breadcrumb[] | string) {
+        if (!breadcrumbs) {
+            return;
+        }
+
+        this._breadcrumbs = toJson(breadcrumbs).map(
+            (crumb: Breadcrumb, index: number) => ({
+                ...crumb,
+                id: crumb.id || crumb.href,
+                level: index
+            })
+        );
     }
 
     private updateDropdownOptionAmount(): void {
@@ -135,7 +173,8 @@ export default class Breadcrumbs extends LightningElement {
             (previousValue, element) =>
                 previousValue +
                 Math.min(
-                    element.label.length * CONSTANTS.pixelPerCharacter,
+                    element.label.length *
+                        (this.pixelPerCharacter || CONSTANTS.pixelPerCharacter),
                     CONSTANTS.minWidthPerCrumb
                 ),
             (breadcrumbs.length - 1) * CONSTANTS.pixelPerCrumbSpace + offset

package/src/modules/doc/componentPlayground/componentPlayground.css

@@ -0,0 +1,22 @@
+@import "dxHelpers/reset";
+
+/**
+ * Designs link - https://www.figma.com/design/9SalRPlJmtRDZHq03o8dL1/One-Doc-Site-Visionary-Mocks?node-id=9968-366397&m=dev
+ * Preview padding: 24px
+ * Example Selector height: 122px
+ * Example Preview min height: 150px
+ * Tab height with border: 46px(45px height and 1px border)
+ * Codeblock height: 264px(224px for codeblock and 40px for panel)
+ * Total: 606px
+**/
+
+iframe {
+    width: 100%;
+    height: 606px;
+    border-radius: var(--dx-g-spacing-sm);
+    border: 1px solid var(--dx-g-gray-90);
+}
+
+.playground-container {
+    position: relative;
+}

package/src/modules/doc/componentPlayground/componentPlayground.html

@@ -0,0 +1,20 @@
+<template>
+    <div class="playground-container" lwc:if={playgroundAvailable}>
+        <dx-spinner
+            size="large"
+            variant="brand"
+            if:true={isLoading}
+        ></dx-spinner>
+        <iframe
+            src={playgroundSrc}
+            onload={handleIframeLoad}
+            title={playgroundTitle}
+            allow="clipboard-write"
+        ></iframe>
+    </div>
+    <dx-error-fallback
+        lwc:else
+        title="Code Examples Unavailable"
+        description="This component's code examples are currently unavailable. Please check again later."
+    ></dx-error-fallback>
+</template>