@salesforcedevs/docs-components 0.0.1 → 0.0.2-edit

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;
@@ -21,7 +21,6 @@ export interface AmfMetaTopicType extends AmfTopicType {
 export interface NavItem {
     name: string;
     label: string;
-    // TODO: Better type here
     children?: ({
         id: string;
         label?: string;
@@ -47,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";
 
 /**
@@ -74,7 +65,7 @@ export interface ParsedMarkdownTopic {
 export interface AmfConfig {
     id: string;
     version?: string;
-    docPhase?: DocPhaseEntry;
+    docPhase?: DocPhaseInfo;
     title: string;
     href: string;
     referenceType: ReferenceType;
@@ -104,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.ts

@@ -1,6 +1,6 @@
 import { track } from "dxUtils/analytics";
 import { LightningElement, api } from "lwc";
-import { AnalyticsPayload, BreadcrumbItemVariant } from "typings/custom";
+import { BreadcrumbItemVariant } from "typings/custom";
 
 const BREADCRUMB_LONG = "breadcrumb_long";
 const BREADCRUMB_BACK_ARROW = "breadcrumb_back-arrow";
@@ -8,8 +8,8 @@ const BREADCRUMB_BACK_ARROW = "breadcrumb_back-arrow";
 const LONG_LABEL_NUMBER = 30;
 export default class BreadcrumbItem extends LightningElement {
     @api href?: string;
-    @api analyticsEvent!: string;
-    @api analyticsBasePayload!: AnalyticsPayload;
+    @api level?: string;
+    @api breadcrumbLabels?: string;
 
     @api
     get label() {
@@ -51,14 +51,21 @@ export default class BreadcrumbItem extends LightningElement {
     }
 
     private onLinkClick(event: Event): void {
-        if (!this.analyticsEvent) {
-            return;
-        }
+        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!, this.analyticsEvent, {
-            ...this.analyticsBasePayload,
-            clickText: this.label,
-            clickUrl: this.href
+        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.html

@@ -3,21 +3,19 @@
         <template if:true={displayCrumbs}>
             <template if:false={renderSmallVariant}>
                 <doc-breadcrumb-item
-                    analytics-event={analyticsEventName}
-                    analytics-base-payload={analyticsBasePayload}
                     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}
-                        analytics-event={analyticsEventName}
-                        analytics-base-payload={analyticsBasePayload}
                         options={dropdownOptions}
                         open-on-hover
                         placement="bottom"
-                        suppress-gtm-nav-headings
                         variant="indented"
                         width="fit-content"
                     >
@@ -32,11 +30,11 @@
                 </template>
                 <template for:each={breadcrumbItems} for:item="breadcrumb">
                     <doc-breadcrumb-item
-                        analytics-event={analyticsEventName}
-                        analytics-base-payload={analyticsBasePayload}
                         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}>
                         /
@@ -44,14 +42,14 @@
                 </template>
                 <doc-breadcrumb-item
                     label={lastCrumb.label}
+                    breadcrumb-labels={breadcrumbLabels}
                 ></doc-breadcrumb-item>
             </template>
             <template if:true={renderSmallVariant}>
                 <doc-breadcrumb-item
-                    analytics-event={analyticsEventName}
-                    analytics-base-payload={analyticsBasePayload}
                     href={lastLinkCrump.href}
                     label={lastLinkCrump.label}
+                    breadcrumb-labels={breadcrumbLabels}
                     variant="back-arrow"
                 ></doc-breadcrumb-item>
             </template>

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

@@ -17,13 +17,6 @@ const CONSTANTS = {
     dropdownWidth: 32
 };
 
-export const ANALYTICS_EVENT_NAME = "custEv_breadcrumbClick";
-export const ANALYTICS_BASE_PAYLOAD = {
-    elementType: "breadcrumb",
-    locationOnPage: "breadcrumb",
-    ctaClick: true
-};
-
 export default class Breadcrumbs extends LightningElement {
     @api ariaLabel: string = "Documentation Breadcrumbs";
 
@@ -35,8 +28,8 @@ export default class Breadcrumbs extends LightningElement {
     set breadcrumbs(value) {
         this.normalizeAndAssignBreadcrumbs(value);
         this.calculateBreadcrumbsConfigs();
-        if (this.observer) {
-            this.updateDropdownOptionAmount();
+        if (this.isRendered) {
+            this.onWidthOrContentChange();
         }
     }
 
@@ -52,9 +45,9 @@ export default class Breadcrumbs extends LightningElement {
     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 (
@@ -100,38 +93,38 @@ export default class Breadcrumbs extends LightningElement {
         return this.breadcrumbs[0];
     }
 
-    private get lastCrumb(): Breadcrumb {
-        return this.breadcrumbs[this.breadcrumbs.length - 1];
+    private get breadcrumbLabels(): string {
+        return this.breadcrumbs.map((crumb) => crumb.label).join(":");
     }
 
-    private get analyticsEventName() {
-        return ANALYTICS_EVENT_NAME;
+    private get lastCrumb(): Breadcrumb {
+        return this.breadcrumbs[this.breadcrumbs.length - 1];
     }
 
-    private get analyticsBasePayload() {
+    // this payload is only used for breadcrumb dropdown
+    private get ANALYTICS_PAYLOAD() {
         return {
-            ...ANALYTICS_BASE_PAYLOAD,
-            itemTitle: this.breadcrumbs.map((crumb) => crumb.label).join("/")
+            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) {
@@ -139,10 +132,13 @@ export default class Breadcrumbs extends LightningElement {
             return;
         }
 
-        this._breadcrumbs = toJson(breadcrumbs).map((crumb: Breadcrumb) => ({
-            ...crumb,
-            id: crumb.id || crumb.href
-        }));
+        this._breadcrumbs = toJson(breadcrumbs).map(
+            (crumb: Breadcrumb, index: number) => ({
+                ...crumb,
+                id: crumb.id || crumb.href,
+                level: index
+            })
+        );
     }
 
     private updateDropdownOptionAmount(): void {

package/src/modules/doc/chat/README.md

@@ -0,0 +1,179 @@
+# Sliding Chat Component (doc-chat)
+
+A self-contained sliding chat component with a floating trigger button that can be embedded in any layout, perfect for customer support, documentation help, or any conversational interface.
+
+## Features
+
+- 🎯 **Sliding Component**: Slides in/out with smooth animations
+- 🔘 **Floating Trigger**: Built-in floating button to open chat (bottom-right corner)
+- 💬 **Real-time Chat**: Interactive messaging with typing indicators
+- 🎨 **Modern Design**: Clean, responsive interface with subtle animations
+- ⚙️ **Configurable**: Customizable title, placeholder, and assistant name
+- 📱 **Mobile Friendly**: Full-width on mobile devices
+- ♿ **Accessible**: ARIA labels and keyboard navigation
+- 🎭 **Storybook Ready**: Multiple story variations for testing
+
+## Basic Usage
+
+The component is completely self-contained with a built-in floating trigger button:
+
+```html
+<doc-chat
+    title="Customer Support"
+    placeholder="How can we help you today?"
+    assistant-name="Support Bot"
+    is-open="false"
+    show-timestamp="true"
+></doc-chat>
+```
+
+That's it! The component will automatically show a floating chat button in the bottom-right corner when closed, and slide in the chat interface when opened.
+
+## Properties
+
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `title` | String | `"Chat"` | Title displayed in the chat header |
+| `placeholder` | String | `"Type your message..."` | Placeholder text for input field |
+| `assistant-name` | String | `"Assistant"` | Name of the assistant/bot |
+| `disabled` | Boolean | `false` | Disables the chat functionality |
+| `show-timestamp` | Boolean | `false` | Shows timestamps on messages |
+| `is-open` | Boolean | `false` | Controls sidebar visibility |
+
+## Methods
+
+| Method | Description |
+|--------|-------------|
+| `openChat()` | Opens the chat sidebar |
+| `closeChat()` | Closes the chat sidebar |
+
+## Events
+
+| Event | Description | Detail |
+|-------|-------------|--------|
+| `chatopened` | Fired when chat is opened | `{ opened: true }` |
+| `chatclosed` | Fired when chat is closed | `{ closed: true }` |
+
+## Integration Example
+
+### Simple Integration (Self-Contained)
+```html
+<!-- The component includes its own trigger button -->
+<doc-chat
+    title="Customer Support"
+    placeholder="How can we help you today?"
+    assistant-name="Support Bot"
+    show-timestamp="true"
+    is-open="false"
+></doc-chat>
+```
+
+### Advanced Integration (With Custom Triggers)
+```html
+<!-- Optional: Custom trigger button -->
+<button id="chat-trigger" onclick="openSupportChat()">
+    💬 Need Help?
+</button>
+
+<!-- Chat component -->
+<doc-chat
+    id="support-chat"
+    title="Customer Support"
+    placeholder="How can we help you today?"
+    assistant-name="Support Bot"
+    show-timestamp="true"
+    is-open="false"
+></doc-chat>
+```
+
+### JavaScript
+```javascript
+// Optional: Custom trigger function
+function openSupportChat() {
+    const chat = document.getElementById('support-chat');
+    chat.openChat();
+}
+
+// Listen for chat events
+document.getElementById('support-chat').addEventListener('chatclosed', (event) => {
+    console.log('Chat was closed');
+});
+
+document.getElementById('support-chat').addEventListener('chatopened', (event) => {
+    console.log('Chat was opened');
+});
+```
+
+## Styling
+
+The component uses CSS custom properties for easy theming:
+
+```css
+doc-chat {
+    --chat-width: 400px;
+    --chat-z-index: 1000;
+    --chat-transition-duration: 0.3s;
+    --chat-header-bg: #f8f9fa;
+    --chat-primary-color: #0066cc;
+    --chat-border-color: #e0e0e0;
+}
+```
+
+## Responsive Behavior
+
+- **Desktop**: Fixed width component (400px)
+- **Tablet**: Full width component
+- **Mobile**: Full width component
+
+## Accessibility
+
+- ARIA labels for screen readers
+- Keyboard navigation support
+- High contrast mode support
+- Reduced motion preferences respected
+
+## Assistant Response Simulation
+
+The component includes a built-in response simulation system that responds to:
+
+- **Greetings**: "Hello", "Hi" → Friendly greeting
+- **Help requests**: "Help" → Assistance offer
+- **Documentation**: "Documentation", "Docs" → Navigation help
+- **General messages**: Contextual responses
+
+### Replacing with Real API
+
+To integrate with a real chat API, replace the `simulateAssistantResponse` method:
+
+```javascript
+// Replace this method in your extended component
+simulateAssistantResponse(userMessage) {
+    // Call your chat API
+    fetch('/api/chat', {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({ message: userMessage })
+    })
+    .then(response => response.json())
+    .then(data => {
+        this.addMessage(data.response, 'assistant');
+    });
+}
+```
+
+## Browser Support
+
+- Chrome 80+
+- Firefox 72+
+- Safari 13+
+- Edge 80+
+
+## Examples
+
+Check out the Storybook examples for various use cases:
+
+- **Default**: Basic chat setup
+- **With Timestamps**: Shows message timestamps
+- **Interactive Demo**: Fully functional example
+- **Mobile View**: Mobile device simulation
+- **Chat Trigger Example**: Integration patterns