@salesforcedevs/docs-components 0.0.0

package/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2020, Salesforce.com, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/lwc.config.json

@@ -0,0 +1,20 @@
+{
+    "modules": [
+        { "dir": "src/modules" },
+        { "npm": "@salesforcedevs/dx-components" }
+    ],
+    "expose": [
+        "doc/amfReference",
+        "doc/breadcrumbs",
+        "doc/content",
+        "doc/contentCallout",
+        "doc/contentLayout",
+        "doc/contentMedia",
+        "doc/docXmlContent",
+        "doc/header",
+        "doc/heading",
+        "doc/headingAnchor",
+        "doc/phase",
+        "doc/xmlContent"
+    ]
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+    "name": "@salesforcedevs/docs-components",
+    "version": "0.0.0",
+    "description": "Docs Lightning web components for DSC",
+    "license": "MIT",
+    "main": "index.js",
+    "engines": {
+        "node": ">= 14.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"
+    },
+    "devDependencies": {
+        "@types/classnames": "^2.2.10",
+        "@types/lodash.orderby": "^4.6.7",
+        "@types/lodash.uniqby": "^4.7.7"
+    },
+    "gitHead": "28224ddff4bbcb00044ecca05aea6f6511b4eccc"
+}

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.css

@@ -0,0 +1,5 @@
+@import "docHelpers/phaseContentLayout";
+
+.version-picker {
+    margin-left: auto;
+}

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

@@ -0,0 +1,47 @@
+<template>
+    <doc-content-layout
+        use-old-sidebar={useOldSidebar}
+        class="content-type content-type-reference"
+        coveo-organization-id={coveoOrganizationId}
+        coveo-public-access-token={coveoPublicAccessToken}
+        coveo-search-hub={coveoSearchHub}
+        coveo-advanced-query-config={coveoAdvancedQueryConfig}
+        breadcrumbs={breadcrumbs}
+        sidebar-header={sidebarHeader}
+        sidebar-value={selectedSidebarValue}
+        sidebar-content={navigation}
+        onselect={onNavSelect}
+        onexpandcollapse={onExpandCollapse}
+        toc-title={tocTitle}
+        toc-options={tocOptions}
+        enable-slot-change="true"
+    >
+        <div slot="doc-phase" if:true={docPhaseInfo} class="doc-phase-wrapper">
+            <doc-phase doc-phase-info={docPhaseInfo}></doc-phase>
+        </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}>
+            <div class="container">
+                <div class="api-documentation">
+                    <doc-amf-topic model={topicModel}></doc-amf-topic>
+                </div>
+            </div>
+        </template>
+    </doc-content-layout>
+</template>