@salesforcedevs/docs-components 0.54.0-alpha02 → 0.54.0-alpha05

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.54.0-alpha02",
+    "version": "0.54.0-alpha05",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
@@ -17,7 +17,8 @@
         "kagekiri": "^1.4.1",
         "lodash.orderby": "^4.6.0",
         "lodash.uniqby": "^4.7.0",
-        "query-string": "^7.1.1"
+        "query-string": "^7.1.1",
+        "sentence-case": "^3.0.4"
     },
     "devDependencies": {
         "@types/classnames": "^2.2.10",

package/src/modules/README.md

@@ -0,0 +1,41 @@
+## AMF Reference
+
+AMF refers to MuleSoft’s AML Modeling Framework for modeling documentation and it’s metadata. In this context, AMF is leveraged to parse and normalize API documentation from varying sources and formats, to one format which is the AMF file. We then leverage HTML Web Components created by MuleSoft to render this API documentation by passing it the generated AMF. These HTML Web Components may be referred to as API Console components, ARC (advanced rest components) components, or api documentation components (for the npm package).
+
+Ref:
+https://a.ml/docs/amf/
+https://github.com/aml-org/amf
+
+## AMF Reference Component
+
+_Components:_ doc-amf-reference, apihub-amf-topic
+
+The AMF Reference Component is a LWC component defined within the developer website’s theme. This component is rendered on the API Reference pages.
+
+Ref: https://github.com/salesforcedevs/developer-website/tree/main/theme/src/modules/apihub
+
+This component takes as input a list of JSON metadata containing the URL information of the reference spec data files. This JSON configuration is generated for each writer repository that contains reference content, and is generated by the SFDocs framework.
+
+This component
+
+-   Takes as input the reference data files (as AMF JSON)
+-   Parses the AML data into a model
+-   Plugs the model into the ARC components to surface documentation content
+-   Handles navigation events to browse the content
+
+### AMF Parser
+
+Ref: https://github.com/salesforcedevs/developer-website/blob/main/theme/src/modules/apihub/amfReference/amf-parser.js
+
+This class parses the AMF JSON data for one spec and extrapolates the data specific to rendering sections of that specs topic documentation.
+
+The parsed data includes:
+
+-   Title
+-   Topics:
+    -   Summary
+    -   Endpoints
+        -   Methods
+    -   Types
+    -   Docs
+    -   Security

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

@@ -1,5 +1,9 @@
 import { LightningElement, api, track } from "lwc";
+import { noCase } from "no-case";
+import { sentenceCase } from "sentence-case";
 import qs from "query-string";
+import { AmfModelParser } from "./utils";
+import { RouteMeta } from "./route-meta";
 import type {
     AmfConfig,
     AmfMetadataTopic,
@@ -12,8 +16,6 @@ import type {
     ReferenceSetConfig,
     AmfMetaTopicType
 } from "./types";
-import { AmfModelParser } from "./utils";
-import { RouteMeta } from "./route-meta";
 
 const NAVIGATION_ITEMS = [
     {
@@ -191,10 +193,12 @@ 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 {
@@ -294,38 +298,15 @@ export default class AmfReference extends LightningElement {
     }
 
     /**
-     * Maps a single endpoint model to a nav item.
-     * Populates the children of this endpoints nav item
-     * with the list of methods if they exist.
-     * Adds the endpoint and any associated methods to the metadata.
-     * @param {Object} model Endpoint Model
-     * @returns {Object} Navigation item object model for dx-sidebar
+     * Convert any case to a readable Title
+     * ex: snake_case => Snake case
+     * ex: camelCase =>  Camel case
+     * ex: PascalCase => Pascal case
+     * @param label
+     * @returns string
      */
-    private createEndpointNavItem(
-        referenceId: string,
-        model: ParsedTopicModel
-    ): NavItem {
-        const { label, methods = [] } = model;
-        const meta = this.addToMetadata(referenceId, "endpoint", model);
-
-        const navItem: NavItem = {
-            name: this.getReferencePathWithMeta(meta),
-            label
-        };
-
-        if (methods.length) {
-            // assign the endpoint methods as its children
-            navItem.children = methods.map((method) => {
-                const _meta = this.addToMetadata(referenceId, "method", method);
-                return Object.assign(method, {
-                    name: this.getReferencePathWithMeta(_meta),
-                    label: method.label || method.method
-                });
-            });
-            navItem.isExpanded = false;
-        }
-
-        return navItem;
+    private getTitleForLabel(label: string): string {
+        return sentenceCase(noCase(label));
     }
 
     /**
@@ -341,71 +322,22 @@ export default class AmfReference extends LightningElement {
         referenceId: string,
         items: ParsedTopicModel[]
     ): NavItem[] {
-        const indentStack = [];
-        let prevIndent = -1;
+        const methodList = [];
 
         items.forEach((item) => {
-            // 'indent' only present for AMF data parsed from RAML spec.
-            // 'indent' is not present for AMF data parsed from OAS spec where endpoints cannot be nested
-            // thus we default indent at 0 to reflect the flat structure for OAS spec
-            const { indent = 0 } = item;
-            const endpoint = this.createEndpointNavItem(referenceId, item);
-
-            if (indent > prevIndent) {
-                // new or equivalent endpoint indentation level
-                // create new indent group
-                const indentGroup = {
-                    indent,
-                    children: [endpoint]
-                };
-                // push to stack
-                indentStack.push(indentGroup);
-            } else if (indent === prevIndent) {
-                // no change in indentation level
-                const lastIndentGroup = indentStack[indentStack.length - 1];
-                lastIndentGroup.children.push(endpoint);
-            } else {
-                // indent < prevIndent: back out to last matching indentation level
-                let indentGroup = indentStack.pop();
-                // hold on to the last indent group's children
-                let lastIndentGroupChildren = indentGroup.children;
-
-                while (indent < indentGroup.indent) {
-                    // back out another indentation level
-                    indentGroup = indentStack.pop();
-                    // append children to next level's last child
-                    const lastChild =
-                        indentGroup.children[indentGroup.children.length - 1];
-                    lastChild.children = (lastChild.children || []).concat(
-                        lastIndentGroupChildren
-                    );
-                    lastIndentGroupChildren = indentGroup.children;
-                }
-                indentGroup.children.push(endpoint);
-                indentStack.push(indentGroup);
-            }
-
-            // update prevIndent
-            prevIndent = indent;
-        });
-
-        // fold remaining indent levels up to the root
-        if (prevIndent > 0) {
-            let indentGroup = indentStack.pop();
-            let lastIndentGroupChildren = indentGroup.children;
-            while (indentGroup.indent > 0) {
-                indentGroup = indentStack.pop();
-                const lastChild =
-                    indentGroup.children[indentGroup.children.length - 1];
-                lastChild.children = (lastChild.children || []).concat(
-                    lastIndentGroupChildren
+            item.methods?.forEach((method) => {
+                const meta = this.addToMetadata(referenceId, "method", method);
+                methodList.push(
+                    Object.assign(method, {
+                        name: this.getReferencePathWithMeta(meta),
+                        label:
+                            this.getTitleForLabel(method.label) || method.method
+                    })
                 );
-                lastIndentGroupChildren = indentGroup.children;
-            }
-            indentStack.push(indentGroup);
-        }
+            });
+        });
 
-        return indentStack[0].children;
+        return methodList;
     }
 
     private getReferencePathWithMeta(meta: string): string {
@@ -678,8 +610,12 @@ export default class AmfReference extends LightningElement {
         const currentMeta: RouteMeta | null = this.getCurrentRefMeta();
         const metadata = currentMeta && this.getMetadataByUrlQuery(currentMeta);
         if (metadata) {
-            const { referenceId, amfId, type, elementId }: AmfMetadataTopic =
-                metadata;
+            const {
+                referenceId,
+                amfId,
+                type,
+                elementId
+            }: AmfMetadataTopic = metadata;
             this.loadContent(
                 referenceId,
                 amfId,
@@ -691,12 +627,15 @@ export default class AmfReference extends LightningElement {
     }
     protected onApiNavigationChanged(): void {
         // The API Navigation event will always intend to navigate within the current reference
-        const metadata =
-            this.metadata[
-                this.getReferencePathWithMeta(this.selectedTopic.meta)
-            ];
-        const { referenceId, amfId, type, elementId }: AmfMetadataTopic =
-            metadata;
+        const metadata = this.metadata[
+            this.getReferencePathWithMeta(this.selectedTopic.meta)
+        ];
+        const {
+            referenceId,
+            amfId,
+            type,
+            elementId
+        }: AmfMetadataTopic = metadata;
         this.loadContent(referenceId, amfId, type, elementId, metadata.meta);
         this.updateUrlWithSelected();
     }

package/src/modules/doc/contentCallout/contentCallout.css

@@ -48,4 +48,4 @@
 
 .dx-callout-base_column > dx-type-badge-group {
     margin-bottom: var(--dx-g-spacing-sm);
-}
+}

package/src/modules/docBaseElements/lightningElementWithState/lightningElementWithState.ts

@@ -1,4 +1,3 @@
-
 import { LightningElement, track } from "lwc";
 
 /**
@@ -76,7 +75,9 @@ export abstract class LightningElementWithState<
             };
             this._didInitializeState = true;
         } else {
-            throw new Error("To mutate state after initialization, use `this.setState`.");
+            throw new Error(
+                "To mutate state after initialization, use `this.setState`."
+            );
         }
     }
 
@@ -90,4 +91,3 @@ export abstract class LightningElementWithState<
         };
     };
 }
-

package/src/modules/docHelpers/phaseContentLayout/phaseContentLayout.css

@@ -25,7 +25,9 @@ doc-phase::part(container) {
 
 @media screen and (min-width: 1496px) {
     doc-phase::part(container) {
-        margin-right: calc(var(--dx-g-page-padding-horizontal) - var(--dx-g-spacing-lg));
+        margin-right: calc(
+            var(--dx-g-page-padding-horizontal) - var(--dx-g-spacing-lg)
+        );
     }
 }
 

package/src/modules/docUtils/SearchSyncer/SearchSyncer.ts

@@ -4,7 +4,9 @@ export interface SearchSyncerConstructorArgs {
         onUrlChange?: (nextSearchString: string) => unknown;
     };
     eventName: string;
-    historyMethod?: typeof window.history.pushState | typeof window.history.replaceState;
+    historyMethod?:
+        | typeof window.history.pushState
+        | typeof window.history.replaceState;
     searchParam: string;
     shouldStopPropagation?: boolean;
     target: EventTarget;
@@ -40,7 +42,10 @@ export class SearchSyncer {
     };
 
     public dispose = (): void => {
-        this.target.removeEventListener(this.eventName, this.handleSearchChange);
+        this.target.removeEventListener(
+            this.eventName,
+            this.handleSearchChange
+        );
         this.target.removeEventListener("popstate", this.handlePopState);
         this.target = undefined;
         this.callbacks.onSearchChange = undefined;