@salesforcedevs/docs-components 1.29.0-newct-alpha → 1.29.0-newct-alpha2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforcedevs/docs-components",
-  "version": "1.29.0-newct-alpha",
+  "version": "1.29.0-newct-alpha2",
   "description": "Docs Lightning web components for DSC",
   "license": "MIT",
   "main": "index.js",

package/src/modules/doc/unifiedContentLayout/unifiedContentLayout.css

@@ -1,9 +1,3 @@
-/*
- * Keep the host transparent to layout: no positioning context, no new
- * stacking/containment block, no margin/padding. This is critical so the
- * inner <doc-content-layout>'s sticky math for the sidebar / right-nav / doc-
- * phase wrapper continues to use the document viewport as its reference.
- */
 :host {
     display: block;
 }

package/src/modules/doc/unifiedContentLayout/unifiedContentLayout.html

@@ -1,31 +1,34 @@
 <template>
     <doc-content-layout
+        class="content-type content-type-markdown content-type-docs"
         breadcrumbs={breadcrumbs}
-        sidebar-content={sidebarContent}
-        sidebar-value={sidebarValue}
+        share-title={shareTitle}
+        share-twitter-via={twitterVia}
         sidebar-header={sidebarHeader}
+        sidebar-value={sidebarValue}
+        sidebar-content={sidebarContent}
         toc-title={tocTitle}
         toc-options={tocOptions}
         toc-aria-level={tocAriaLevel}
-        enable-slot-change={enableSlotChange}
-        use-old-sidebar={useOldSidebar}
+        enable-slot-change="true"
         languages={languages}
         language={language}
-        bail-href={bailHref}
-        bail-label={bailLabel}
-        dev-center={devCenter}
-        brand={brand}
-        empty-state-message={emptyStateMessage}
-        show-footer={showFooter}
-        reading-time={readingTime}
-        share-title={shareTitle}
-        share-url={shareUrl}
-        share-twitter-via={shareTwitterVia}
+        show-footer={enableFooter}
         origin={origin}
     >
-        <slot></slot>
-        <slot name="doc-phase" slot="doc-phase"></slot>
-        <slot name="version-banner" slot="version-banner"></slot>
-        <slot name="sidebar-header" slot="sidebar-header"></slot>
+        <doc-phase
+            slot="doc-phase"
+            lwc:if={docPhaseInfo}
+            doc-phase-info={docPhaseInfo}
+        ></doc-phase>
+
+        <template lwc:if={isMarkdownTopic}>
+            <slot></slot>
+        </template>
+        <!--
+            TODO(W-22340752): render OAS specs via doc-redoc-reference when
+            topicType === "spec". The docs content-type parser currently 404s
+            spec topics until that path lands.
+        -->
     </doc-content-layout>
 </template>

package/src/modules/doc/unifiedContentLayout/unifiedContentLayout.ts

@@ -1,98 +1,94 @@
 import { LightningElement, api } from "lwc";
+import { toJson, normalizeBoolean } from "dxUtils/normalizers";
 import type { OptionWithLink } from "typings/custom";
-import "doc/contentLayout";
-import "doc/phase";
 
 /**
- * Orchestrator LWC for the unified `docs` content-type.
- *
- * Today (Phase 2): thin pass-through over `<doc-content-layout>` for markdown
- * topics. The data contract matches what `DocsContentTypeParser.compile()`
- * already emits (`dxSideBarContents`, `routeurl`, `breadcrumbs`,
- * `docPhaseInfo`, etc.), so the parser does not need to fabricate a
- * `reference-set-config` shape the way `<doc-amf-reference>` requires.
- *
- * Navigation: LNB clicks go through the browser's default `<a href>`
- * navigation (the same behavior as references and every other SFDocs
- * content-type). SFDocs is a server-rendered (Nunjucks) framework; LWR's
- * Outlet only swaps LWC view components, not server-rendered HTML, so there
- * is no soft-nav mechanism here today. A previous experiment to fake soft
- * nav with `history.pushState` + a synthetic `popstate` was removed because
- * it updated the URL bar but did NOT re-fetch the new topic's content (the
- * content body stayed as the originally-loaded topic until a manual
- * refresh). Real client-side soft nav for server-rendered routes would
- * require a Turbo-style fetch + DOM surgery; if that becomes a requirement
- * it should live in @salesforcedocs/doc-framework so every content-type
- * benefits, not be patched into this wrapper.
- *
- * The two side-effect imports above (`doc/contentLayout`, `doc/phase`) exist
- * so LWR's static-analysis-based modulepreload emitter discovers them on
- * the route. Without them the docs route's first paint shows a visible
- * flash on local dev because the inner LWC + phase badge load only after
- * this wrapper's bundle parses.
+ * Topic types emitted by the docs content-type parser
+ * (see @salesforcedevs/sfdocs-doc-framework: `TopicTypeEnum`).
+ */
+const TOPIC_TYPE_MARKDOWN = "markdown";
+const TOPIC_TYPE_SPEC = "spec";
+
+/**
+ * Wrapper around `doc-content-layout` for the "docs" content type emitted by
+ * the `DocsContentTypeParser`.
  *
- * Future:
- *   - Phase 3: version-picker wiring in the `sidebar-header` named slot
- *     (parser emits `versions` / `selectedVersion`; wrapper renders
- *     `<doc-version-picker>` here).
- *   - Phase 4: markdown-vs-spec branching in the default slot (use the
- *     existing `<doc-amf-topic>` + `AmfModelParser` primitives, mirroring
- *     `<doc-amf-reference>`'s template pattern but without inheriting its
- *     `/references/` URL conventions or per-reference sidebar tiles).
+ * Mirrors the role that `doc-amf-reference` plays for the "reference" content
+ * type: it owns content-type-aware concerns (markdown body vs. OAS spec via
+ * Redoc) and forwards the chrome (sidebar, breadcrumbs, TOC, footer) to
+ * `doc-content-layout`.
  *
- * Every property is a plain pass-through. `contentLayout`'s own setters run
- * `toJson` / `normalizeBoolean` on the values, so re-normalizing here would
- * only risk diverging from upstream as the inner component evolves.
+ * Only the markdown topic type is wired up today. OAS spec rendering via Redoc
+ * is tracked separately (W-22340752) and currently 404s upstream in the parser.
  */
 export default class UnifiedContentLayout extends LightningElement {
-    /* ---------- Sidebar / breadcrumb / TOC inputs ---------- */
     @api breadcrumbs: string | null = null;
-    @api sidebarContent: string | object | null = null;
-    @api sidebarValue: string | null = null;
-    @api sidebarHeader: string | null = null;
-
+    @api sidebarHeader?: string;
+    @api sidebarValue?: string;
     @api tocTitle?: string;
     @api tocOptions?: string;
     @api tocAriaLevel?: string;
+    @api languages?: OptionWithLink[];
+    @api language?: string;
 
-    /* ---------- contentLayout feature toggles ---------- */
-    @api enableSlotChange: string | boolean = false;
-    @api useOldSidebar: string | boolean = false;
-    @api showFooter: string | boolean = false;
-
-    /* ---------- Localization ---------- */
-    @api languages: OptionWithLink[] | null = null;
-    @api language: string | null = null;
-
-    /* ---------- Empty-state / chrome ---------- */
-    @api bailHref: string | null = null;
-    @api bailLabel: string | null = null;
-    @api emptyStateMessage: string | null = null;
-    @api readingTime: string | null = null;
-
-    @api devCenter: string | null = null;
-    @api brand: string | null = null;
+    /** Optional origin URL for the footer MFE (e.g. wp-json endpoint). */
+    @api origin: string | null = null;
 
-    /* ---------- Social share ---------- */
+    /** Article name from breadcrumbs, used as share title (e.g. for social share). */
     @api shareTitle: string | null = null;
-    @api shareUrl: string | null = null;
-    @api shareTwitterVia: string | null = null;
 
-    /* ---------- Footer integration ---------- */
-    @api origin: string | null = null;
+    /** Optional Twitter "via" handle (e.g. SalesforceDevs) for social share. */
+    @api twitterVia: string | null = null;
+
+    @api hideFooter = false;
 
     /**
-     * Forwarded imperative method so any caller that holds a reference to the
-     * wrapper (and previously called `contentLayout.setSidebarInputValue`)
-     * keeps working without changes.
+     * Topic type forwarded from the layout template. The docs parser supports
+     * `markdown` today and `spec` (OAS via Redoc) in a follow-up.
      */
+    @api topicType: string = TOPIC_TYPE_MARKDOWN;
+
+    private _docPhaseInfo: string | null = null;
+    private _sidebarContent: unknown = null;
+
+    @api
+    get docPhaseInfo(): string | null {
+        return this._docPhaseInfo;
+    }
+
+    set docPhaseInfo(value: string | null) {
+        this._docPhaseInfo = value || null;
+    }
+
+    @api
+    get sidebarContent(): unknown {
+        return this._sidebarContent;
+    }
+
+    set sidebarContent(value: string | { topics?: unknown } | null) {
+        this._sidebarContent = value ? toJson(value)?.topics ?? null : null;
+    }
+
+    private _expandChildren = false;
+
     @api
-    setSidebarInputValue(searchTerm: string): void {
-        const inner = this.template.querySelector("doc-content-layout") as
-            | (HTMLElement & {
-                  setSidebarInputValue?: (term: string) => void;
-              })
-            | null;
-        inner?.setSidebarInputValue?.(searchTerm);
+    get expandChildren(): boolean {
+        return this._expandChildren;
+    }
+
+    set expandChildren(value: boolean | string) {
+        this._expandChildren = normalizeBoolean(value);
+    }
+
+    get isMarkdownTopic(): boolean {
+        return this.topicType === TOPIC_TYPE_MARKDOWN;
+    }
+
+    get isSpecTopic(): boolean {
+        return this.topicType === TOPIC_TYPE_SPEC;
+    }
+
+    private get enableFooter(): boolean {
+        return !this.hideFooter;
     }
 }