@salesforcedevs/docs-components 1.17.6-redoc1 → 1.17.6-redoc3

package/lwc.config.json

@@ -14,13 +14,13 @@
         "doc/contentLayout",
         "doc/contentMedia",
         "doc/docXmlContent",
+        "doc/flexReference",
         "doc/lwcContentLayout",
         "doc/header",
         "doc/heading",
         "doc/headingAnchor",
         "doc/overview",
         "doc/phase",
-        "doc/docReference",
         "doc/specificationContent",
         "doc/versionPicker",
         "doc/xmlContent",

package/package.json

@@ -1,12 +1,16 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "1.17.6-redoc1",
+    "version": "1.17.6-redoc3",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",
     "engines": {
         "node": "20.x"
     },
+    "volta": {
+        "node": "20.18.2",
+        "yarn": "1.22.19"
+    },
     "publishConfig": {
         "access": "public"
     },

package/src/modules/doc/flexReference/constants.ts

@@ -0,0 +1,20 @@
+export const REFERENCE_TYPES = {
+    markdown: "markdown",
+    raml: "rest-raml",
+    oa2: "rest-oa2",
+    oa3: "rest-oa3"
+};
+
+const oldReferenceIdNewReferenceIdMap: Record<string, string> = {
+    "commerce-api-assignments": "assignments",
+    "commerce-api-campaigns": "campaigns",
+    "commerce-api-catalogs": "catalogs",
+    "cdn-zones": "cdn-api-process-apis",
+    "inventory-impex": "impex",
+    "inventory-reservations": "inventory-reservation-service",
+    "shopper-login-and-api-access-service": "shopper-login",
+    "shopper-login-and-api-access-service-admin": "slas-admin",
+    "einstein-recommendations": "einstein-api-quick-start-guide"
+};
+
+export { oldReferenceIdNewReferenceIdMap };

package/src/modules/doc/{docReference/docReference.ts → flexReference/flexReference.ts}

@@ -6,12 +6,12 @@ import type {
     ReferenceVersion,
     ReferenceSetConfig,
     ParsedMarkdownTopic
-} from "../amfReference/types";
+} from "./types";
 
 import {
     REFERENCE_TYPES,
     oldReferenceIdNewReferenceIdMap
-} from "../amfReference/constants";
+} from "./constants";
 import { restoreScroll } from "dx/scrollManager";
 import { DocPhaseInfo } from "typings/custom";
 import { logCoveoPageView, oldVersionDocInfo } from "docUtils/utils";
@@ -26,7 +26,7 @@ type NavigationItem = {
     isChildrenLoading: boolean;
 };
 
-export default class DocReference extends LightningElement {
+export default class FlexReference extends LightningElement {
     @api breadcrumbs: string | null = null;
     @api sidebarHeader!: string;
     @api coveoOrganizationId!: string;
@@ -355,11 +355,11 @@ export default class DocReference extends LightningElement {
      * Fetch spec and generate Redoc structure
      */
     private async fetchSpec(amfConfig: AmfConfig): Promise<RedocSidebarData | null> {
-        const { amf } = amfConfig;
+        const { source } = amfConfig;
         try {
-            // Load Redoc sidebar structure
-            if (window.Redoc?.getSpecStructure && amf) {
-                return await window.Redoc.getSpecStructure(amf);
+            // Load Redoc sidebar structure using the source spec URL
+            if (window.Redoc?.getSpecStructure && source) {
+                return await window.Redoc.getSpecStructure(source);
             }
             return null;
         } catch (error) {
@@ -554,9 +554,9 @@ export default class DocReference extends LightningElement {
                 redocContainer.firstChild.remove();
             }
             
-            // Initialize Redoc
-            if (window.Redoc && amfConfig.amf) {
-                await window.Redoc.init(amfConfig.amf, {
+            // Initialize Redoc using the source spec URL
+            if (window.Redoc && amfConfig.source) {
+                await window.Redoc.init(amfConfig.source, {
                     expandResponses: '200,400',
                     scrollYOffset: 73,
                     sidebar: false

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

@@ -0,0 +1,81 @@
+import { DocPhaseInfo } from "typings/custom";
+
+// Redoc type declarations for window object
+export interface RedocNavigationItem {
+    label: string;
+    name: string; // Hash-based URL (#section-id)
+    id: string;   // Section ID for scroll targeting
+    children?: RedocNavigationItem[];
+}
+
+export interface RedocSidebarData {
+    spec: {
+        title: string;
+        version: string;
+    };
+    items: RedocNavigationItem[];
+}
+
+// Core types needed for reference handling
+export type ReferenceType = "markdown" | "rest-raml" | "rest-oa2" | "rest-oa3";
+
+/**
+ * Represents parsed topic for the sidebar.
+ */
+export interface ParsedMarkdownTopic {
+    label: string;
+    name: string;
+    children: ParsedMarkdownTopic[];
+    link?: {
+        href: string;
+        target?: string;
+    };
+    isExpanded?: boolean;
+}
+
+export interface AmfConfig {
+    id: string;
+    version?: string;
+    docPhase?: DocPhaseInfo;
+    title: string;
+    href: string;
+    referenceType: ReferenceType;
+
+    // determines if a reference config is the current active and selected one.
+    isSelected: boolean;
+
+    // required for spec based references
+    amf?: string;      // compiled JSON for amfTopic (legacy)
+    source?: string;   // spec URL
+
+    // required for markdown based references
+    topic?: ParsedMarkdownTopic;
+}
+
+export interface ReferenceVersion {
+    id: string;
+    label: string;
+    deprecated?: boolean;
+    selected?: boolean;
+    link: {
+        href: string;
+    };
+}
+
+export interface ReferenceSetConfig {
+    refId?: string;
+    versionToRefMap?: Map<string, Array<AmfConfig>>;
+    refList: Array<AmfConfig>;
+    versions: Array<ReferenceVersion>;
+}
+
+declare global {
+    interface Window {
+        Redoc?: {
+            init: (specUrl: string, options: any, container: Element) => Promise<void>;
+            getSpecStructure?: (specUrl: string) => Promise<RedocSidebarData>;
+        };
+    }
+}
+
+export {};

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

@@ -1,24 +0,0 @@
-// Redoc type declarations for window object
-export interface RedocNavigationItem {
-    label: string;
-    name: string; // Hash-based URL (#section-id)
-    id: string;   // Section ID for scroll targeting
-    children?: RedocNavigationItem[];
-}
-
-export interface RedocSidebarData {
-    spec: {
-        title: string;
-        version: string;
-    };
-    items: RedocNavigationItem[];
-}
-
-declare global {
-    interface Window {
-        Redoc?: {
-            init: (specUrl: string, options: any, container: Element) => Promise<void>;
-            getSpecStructure?: (specUrl: string) => Promise<RedocSidebarData>;
-        };
-    }
-}