@salesforcedevs/docs-components 1.28.7 → 1.29.0-llm-alpha

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lwc.config.json CHANGED
@@ -5,6 +5,7 @@
5
5
  { "npm": "@salesforcedevs/dw-components" }
6
6
  ],
7
7
  "expose": [
8
+ "doc/aiToolbar",
8
9
  "doc/amfReference",
9
10
  "doc/banner",
10
11
  "doc/localeBanner",
package/package.json CHANGED
@@ -1,29 +1,29 @@
1
1
  {
2
- "name": "@salesforcedevs/docs-components",
3
- "version": "1.28.7",
4
- "description": "Docs Lightning web components for DSC",
5
- "license": "MIT",
6
- "main": "index.js",
7
- "engines": {
8
- "node": "22.x"
9
- },
10
- "publishConfig": {
11
- "access": "public"
12
- },
13
- "dependencies": {
14
- "@api-components/amf-helper-mixin": "4.5.29",
15
- "classnames": "2.5.1",
16
- "dompurify": "3.2.4",
17
- "kagekiri": "1.4.2",
18
- "lodash.orderby": "4.6.0",
19
- "lodash.uniqby": "4.7.0",
20
- "query-string": "7.1.3",
21
- "sentence-case": "3.0.4"
22
- },
23
- "devDependencies": {
24
- "@types/classnames": "2.3.1",
25
- "@types/lodash.orderby": "4.6.9",
26
- "@types/lodash.uniqby": "4.7.9"
27
- },
28
- "gitHead": "aedcb1c0ab8cb16ff85f61c0d3ed0c908502d843"
29
- }
2
+ "name": "@salesforcedevs/docs-components",
3
+ "version": "1.29.0-llm-alpha",
4
+ "description": "Docs Lightning web components for DSC",
5
+ "license": "MIT",
6
+ "main": "index.js",
7
+ "engines": {
8
+ "node": "22.x"
9
+ },
10
+ "publishConfig": {
11
+ "access": "public"
12
+ },
13
+ "dependencies": {
14
+ "@api-components/amf-helper-mixin": "4.5.29",
15
+ "classnames": "2.5.1",
16
+ "dompurify": "3.2.4",
17
+ "kagekiri": "1.4.2",
18
+ "lodash.orderby": "4.6.0",
19
+ "lodash.uniqby": "4.7.0",
20
+ "query-string": "7.1.3",
21
+ "sentence-case": "3.0.4"
22
+ },
23
+ "devDependencies": {
24
+ "@types/classnames": "2.3.1",
25
+ "@types/lodash.orderby": "4.6.9",
26
+ "@types/lodash.uniqby": "4.7.9"
27
+ },
28
+ "gitHead": "4629fdd9ca18a13480044ad43515b91945d16aad"
29
+ }
@@ -0,0 +1,40 @@
1
+ @import "dxHelpers/reset";
2
+
3
+ :host {
4
+ display: inline-flex;
5
+ }
6
+
7
+ .ai-toolbar {
8
+ display: flex;
9
+ align-items: center;
10
+ gap: var(--dx-g-spacing-sm);
11
+ padding-bottom: var(--dx-g-spacing-xl);
12
+ }
13
+
14
+ .toolbar-button {
15
+ --dx-g-button-inline-color: var(--dx-g-blue-vibrant-50);
16
+ --dx-g-button-inline-color-hover: var(--dx-g-blue-vibrant-30);
17
+ --dx-c-button-font-size: var(--dx-g-text-sm);
18
+ --dx-c-button-horizontal-spacing: 0;
19
+ --dx-c-button-icon-vertical-align: middle;
20
+ }
21
+
22
+ .toolbar-button::part(content) {
23
+ font-family: var(--dx-g-font-display);
24
+ font-weight: var(--dx-g-font-demi);
25
+ line-height: var(--dx-g-spacing-mlg);
26
+ letter-spacing: 0.07px;
27
+ }
28
+
29
+ .divider {
30
+ width: 1px;
31
+ height: var(--dx-g-spacing-md);
32
+ background-color: var(--dx-g-gray-70);
33
+ }
34
+
35
+ @media screen and (max-width: 480px) {
36
+ .toolbar-button_copy-url,
37
+ .divider_copy-url {
38
+ display: none;
39
+ }
40
+ }
@@ -0,0 +1,53 @@
1
+ <template>
2
+ <div class="ai-toolbar">
3
+ <dx-tooltip placement="top-right" label={copyMarkdownLabel}>
4
+ <dx-button
5
+ class="toolbar-button"
6
+ variant="inline"
7
+ size="small"
8
+ icon-sprite="utility"
9
+ icon-symbol="copy"
10
+ icon-size="medium"
11
+ icon-position="right"
12
+ aria-label="Copy as Markdown"
13
+ onclick={handleCopyMarkdown}
14
+ >
15
+ Copy as Markdown
16
+ </dx-button>
17
+ </dx-tooltip>
18
+
19
+ <div class="divider"></div>
20
+
21
+ <dx-button
22
+ class="toolbar-button"
23
+ variant="inline"
24
+ size="small"
25
+ icon-sprite="utility"
26
+ icon-symbol="new_window"
27
+ icon-size="medium"
28
+ icon-position="right"
29
+ aria-label="View as Markdown"
30
+ onclick={handleViewMarkdown}
31
+ >
32
+ View as Markdown
33
+ </dx-button>
34
+
35
+ <div class="divider divider_copy-url"></div>
36
+
37
+ <dx-tooltip placement="top-right" label={copyUrlLabel}>
38
+ <dx-button
39
+ class="toolbar-button toolbar-button_copy-url"
40
+ variant="inline"
41
+ size="small"
42
+ icon-sprite="utility"
43
+ icon-symbol="link"
44
+ icon-size="medium"
45
+ icon-position="right"
46
+ aria-label="Copy URL to Markdown"
47
+ onclick={handleCopyUrl}
48
+ >
49
+ Copy URL to Markdown
50
+ </dx-button>
51
+ </dx-tooltip>
52
+ </div>
53
+ </template>
@@ -0,0 +1,83 @@
1
+ import { LightningElement } from "lwc";
2
+
3
+ const DEFAULT_COPY_TOOLTIP_LABEL = "Click to copy";
4
+ const COPIED_TOOLTIP_LABEL = "Copied!";
5
+ const COPIED_TOOLTIP_RESET_MS = 2000;
6
+
7
+ export default class AiToolbar extends LightningElement {
8
+ copyMarkdownLabel: string = DEFAULT_COPY_TOOLTIP_LABEL;
9
+ copyUrlLabel: string = DEFAULT_COPY_TOOLTIP_LABEL;
10
+
11
+ private copyTooltipResetTimeout: number | null = null;
12
+
13
+ async handleCopyMarkdown() {
14
+ const markdownUrl = this.getMarkdownUrl();
15
+ if (!markdownUrl) {
16
+ return;
17
+ }
18
+
19
+ try {
20
+ const response = await fetch(markdownUrl);
21
+ if (!response.ok) {
22
+ return;
23
+ }
24
+ const markdown = await response.text();
25
+ await navigator.clipboard.writeText(markdown);
26
+ this.flashCopied("copyMarkdownLabel");
27
+ } catch (error) {
28
+ console.error(error);
29
+ }
30
+ }
31
+
32
+ handleViewMarkdown() {
33
+ const markdownUrl = this.getMarkdownUrl();
34
+ if (!markdownUrl) {
35
+ return;
36
+ }
37
+ window.open(markdownUrl, "_blank", "noopener,noreferrer");
38
+ }
39
+
40
+ async handleCopyUrl() {
41
+ const markdownUrl = this.getMarkdownUrl();
42
+ if (!markdownUrl) {
43
+ return;
44
+ }
45
+
46
+ try {
47
+ await navigator.clipboard.writeText(markdownUrl);
48
+ this.flashCopied("copyUrlLabel");
49
+ } catch (error) {
50
+ console.error(error);
51
+ }
52
+ }
53
+
54
+ /**
55
+ * Returns the `.md` equivalent of the current page URL with any hash and
56
+ * query string stripped, or `null` when the current page does not end
57
+ * with `.html`.
58
+ */
59
+ private getMarkdownUrl(): string | null {
60
+ const url = new URL(window.location.href);
61
+ url.hash = "";
62
+ url.search = "";
63
+
64
+ if (!url.pathname.endsWith(".html")) {
65
+ return null;
66
+ }
67
+
68
+ url.pathname = url.pathname.replace(/\.html$/, ".md");
69
+ return url.toString();
70
+ }
71
+
72
+ private flashCopied(labelKey: "copyMarkdownLabel" | "copyUrlLabel") {
73
+ if (this.copyTooltipResetTimeout !== null) {
74
+ window.clearTimeout(this.copyTooltipResetTimeout);
75
+ }
76
+ this[labelKey] = COPIED_TOOLTIP_LABEL;
77
+ this.copyTooltipResetTimeout = window.setTimeout(() => {
78
+ this.copyMarkdownLabel = DEFAULT_COPY_TOOLTIP_LABEL;
79
+ this.copyUrlLabel = DEFAULT_COPY_TOOLTIP_LABEL;
80
+ this.copyTooltipResetTimeout = null;
81
+ }, COPIED_TOOLTIP_RESET_MS);
82
+ }
83
+ }
@@ -0,0 +1,48 @@
1
+ import { http, HttpResponse } from "msw";
2
+
3
+ /**
4
+ * Mocks for the AI toolbar so stories never hit the real
5
+ * docs backend. Any story rendering `doc-ai-toolbar` (directly or via
6
+ * `doc-content-layout`) must register `aiToolbarMswHandlers` and call
7
+ * `interceptWindowOpenForAiToolbar()`.
8
+ */
9
+ export const DUMMY_MARKDOWN_CONTENT = `# Dummy Markdown
10
+
11
+ Storybook serves this placeholder content in place of the real markdown
12
+ that the docs backend would return for the current page. It exists so
13
+ the "Copied" tooltip, the "View as Markdown" new tab, and the
14
+ "Copy URL to Markdown" clipboard behavior are all exercisable in
15
+ storybook without hitting the live backend.
16
+
17
+ - Item 1
18
+ - Item 2
19
+ - Item 3
20
+ `;
21
+
22
+ export const DUMMY_MARKDOWN_DATA_URL = `data:text/markdown;charset=utf-8,${encodeURIComponent(
23
+ DUMMY_MARKDOWN_CONTENT
24
+ )}`;
25
+
26
+ /** Intercepts any `.md` GET request and returns the dummy markdown. */
27
+ export const aiToolbarMswHandlers = [
28
+ http.get(/\.md(\?.*)?$/, () => HttpResponse.text(DUMMY_MARKDOWN_CONTENT))
29
+ ];
30
+
31
+ let windowOpenIntercepted = false;
32
+
33
+ /** Redirects `window.open` calls for `.md` URLs to the dummy markdown data URL (MSW does not cover new tabs). */
34
+ export function interceptWindowOpenForAiToolbar() {
35
+ if (windowOpenIntercepted) {
36
+ return;
37
+ }
38
+ windowOpenIntercepted = true;
39
+
40
+ const originalOpen = window.open.bind(window);
41
+ window.open = ((url?: string | URL, target?: string, features?: string) => {
42
+ const stringUrl = url?.toString() ?? "";
43
+ if (stringUrl.endsWith(".md")) {
44
+ return originalOpen(DUMMY_MARKDOWN_DATA_URL, target, features);
45
+ }
46
+ return originalOpen(url ?? "", target, features);
47
+ }) as typeof window.open;
48
+ }
@@ -37,6 +37,7 @@ type NavigationItem = {
37
37
  isExpanded: boolean;
38
38
  children: ParsedMarkdownTopic[];
39
39
  isChildrenLoading: boolean;
40
+ showForwardArrow?: boolean;
40
41
  };
41
42
 
42
43
  export default class AmfReference extends LightningElement {
@@ -204,6 +205,7 @@ export default class AmfReference extends LightningElement {
204
205
 
205
206
  _boundOnApiNavigationChanged;
206
207
  _boundUpdateSelectedItemFromUrlQuery;
208
+ _boundOnPageShow;
207
209
 
208
210
  constructor() {
209
211
  super();
@@ -212,6 +214,7 @@ export default class AmfReference extends LightningElement {
212
214
  this.onApiNavigationChanged.bind(this);
213
215
  this._boundUpdateSelectedItemFromUrlQuery =
214
216
  this.updateSelectedItemFromUrlQuery.bind(this);
217
+ this._boundOnPageShow = this.onPageShow.bind(this);
215
218
  }
216
219
 
217
220
  connectedCallback(): void {
@@ -223,6 +226,7 @@ export default class AmfReference extends LightningElement {
223
226
  "popstate",
224
227
  this._boundUpdateSelectedItemFromUrlQuery
225
228
  );
229
+ window.addEventListener("pageshow", this._boundOnPageShow);
226
230
  }
227
231
 
228
232
  disconnectedCallback(): void {
@@ -234,6 +238,22 @@ export default class AmfReference extends LightningElement {
234
238
  "popstate",
235
239
  this._boundUpdateSelectedItemFromUrlQuery
236
240
  );
241
+ window.removeEventListener("pageshow", this._boundOnPageShow);
242
+ }
243
+
244
+ /**
245
+ * On bfcache restore, reset the sidebar selection so the tree re-syncs
246
+ * its highlighted tile with the current URL.
247
+ */
248
+ protected onPageShow(event: PageTransitionEvent): void {
249
+ if (!event.persisted) {
250
+ return;
251
+ }
252
+ const currentPath = window.location.pathname;
253
+ this.selectedSidebarValue = "";
254
+ Promise.resolve().then(() => {
255
+ this.selectedSidebarValue = currentPath;
256
+ });
237
257
  }
238
258
 
239
259
  renderedCallback(): void {
@@ -443,16 +463,21 @@ export default class AmfReference extends LightningElement {
443
463
  let navItemChildren = [] as ParsedMarkdownTopic[];
444
464
  let isChildrenLoading = false;
445
465
  if (amfConfig.referenceType !== REFERENCE_TYPES.markdown) {
446
- if (amfConfig.isSelected) {
447
- const amfPromise = this.fetchAmf(amfConfig).then(
448
- (amfJson) => {
449
- this.updateModel(amfConfig.id, amfJson);
450
- this.assignNavigationItemsFromAmf(amfConfig, index);
451
- }
452
- );
453
- this.amfFetchPromiseMap[amfConfig.id] = amfPromise;
466
+ if (amfConfig.amf) {
467
+ if (amfConfig.isSelected) {
468
+ const amfPromise = this.fetchAmf(amfConfig).then(
469
+ (amfJson) => {
470
+ this.updateModel(amfConfig.id, amfJson);
471
+ this.assignNavigationItemsFromAmf(
472
+ amfConfig,
473
+ index
474
+ );
475
+ }
476
+ );
477
+ this.amfFetchPromiseMap[amfConfig.id] = amfPromise;
478
+ }
479
+ isChildrenLoading = true;
454
480
  }
455
- isChildrenLoading = true;
456
481
  } else {
457
482
  const isExpandChildrenEnabled = this.isExpandChildrenEnabled(
458
483
  amfConfig.id
@@ -473,13 +498,30 @@ export default class AmfReference extends LightningElement {
473
498
  amfConfig.isSelected ||
474
499
  this.isExpandChildrenEnabled(amfConfig.id),
475
500
  children: navItemChildren,
476
- isChildrenLoading
501
+ isChildrenLoading,
502
+ showForwardArrow: this.resolveNavRenderWith(amfConfig)
477
503
  };
478
504
  this.parentReferenceUrls.push(amfConfig.href);
479
505
  }
480
506
  this.navigation = navAmfOrder;
481
507
  }
482
508
 
509
+ /**
510
+ * Determines whether the sidebar tile should render a forward arrow for
511
+ * this reference. Honors `redoc` set on the config, and also infers it
512
+ * for non-markdown references that have no AMF URL (i.e. those rendered
513
+ * by Redoc).
514
+ */
515
+ private resolveNavRenderWith(amfConfig: AmfConfig): boolean {
516
+ if (amfConfig.renderWith) {
517
+ return amfConfig.renderWith === "redoc";
518
+ }
519
+ return (
520
+ amfConfig.referenceType !== REFERENCE_TYPES.markdown &&
521
+ !amfConfig.amf
522
+ );
523
+ }
524
+
483
525
  /**
484
526
  * Returns a boolean indicating whether the children should be expanded or not.
485
527
  */
@@ -78,6 +78,11 @@ export interface AmfConfig {
78
78
 
79
79
  // required for markdown based references
80
80
  topic?: ParsedMarkdownTopic;
81
+
82
+ /**
83
+ * Required for rendering the arrow on LNB
84
+ */
85
+ renderWith?: string;
81
86
  }
82
87
 
83
88
  export interface ParsedTopicModel {
@@ -1,11 +1,15 @@
1
1
  /* eslint-disable @lwc/lwc/no-document-query */
2
- import { LightningElement, api, track } from "lwc";
3
- import { closest } from "kagekiri";
2
+ import { LightningElement, api, createElement, track } from "lwc";
3
+ import { closest, querySelector } from "kagekiri";
4
4
  import { toJson, normalizeBoolean } from "dxUtils/normalizers";
5
5
  import { highlightTerms } from "dxUtils/highlight";
6
6
  import { SearchSyncer } from "docUtils/searchSyncer";
7
7
  import type { OptionWithLink } from "typings/custom";
8
8
  import { buildDocLinkClickHandler } from "dxUtils/analytics";
9
+ import AiToolbar from "doc/aiToolbar";
10
+
11
+ const AI_TOOLBAR_TAG = "doc-ai-toolbar";
12
+ const PAGE_HEADING_SELECTOR = "h1";
9
13
 
10
14
  type AnchorMap = { [key: string]: { intersect: boolean; id: string } };
11
15
 
@@ -95,6 +99,17 @@ export default class ContentLayout extends LightningElement {
95
99
  /** Optional origin URL for the footer MFE (e.g. wp-json endpoint). Passed through to dx-footer. */
96
100
  @api origin: string | null = null;
97
101
 
102
+ /** Controls whether the AI toolbar is displayed. */
103
+ @api
104
+ get showAiToolbar() {
105
+ return this._showAiToolbar;
106
+ }
107
+ set showAiToolbar(value) {
108
+ this._showAiToolbar = normalizeBoolean(value);
109
+ this.updateAiToolbar();
110
+ }
111
+ private _showAiToolbar = false;
112
+
98
113
  @api
99
114
  get breadcrumbs() {
100
115
  return this._breadcrumbs;
@@ -152,6 +167,7 @@ export default class ContentLayout extends LightningElement {
152
167
  protected hasRendered: boolean = false;
153
168
  protected contentLoaded: boolean = false;
154
169
  protected sidebarOpen: boolean = false;
170
+ protected aiToolbarElement: HTMLElement | null = null;
155
171
 
156
172
  get shouldDisplayFeedback() {
157
173
  return this.contentLoaded && typeof Sprig !== "undefined";
@@ -257,6 +273,8 @@ export default class ContentLayout extends LightningElement {
257
273
  window.addEventListener("scroll", this.adjustNavPosition);
258
274
  window.addEventListener("resize", this.adjustNavPosition);
259
275
 
276
+ this.updateAiToolbar();
277
+
260
278
  if (!this.hasRendered) {
261
279
  this.hasRendered = true;
262
280
  this.restoreScroll();
@@ -266,6 +284,47 @@ export default class ContentLayout extends LightningElement {
266
284
  }
267
285
  }
268
286
 
287
+ /**
288
+ * Inserts the AI toolbar into the slotted content immediately after the
289
+ * first H1 found inside this layout. The H1 typically lives deep in
290
+ * `doc-content`'s shadow (rendered via `lwc:dom="manual"`), so we use
291
+ * kagekiri's shadow-piercing query to locate it from here.
292
+ */
293
+ protected updateAiToolbar(): void {
294
+ if (!this.showAiToolbar) {
295
+ this.removeAiToolbar();
296
+ return;
297
+ }
298
+
299
+ const heading = querySelector(
300
+ PAGE_HEADING_SELECTOR,
301
+ this.template.host
302
+ ) as HTMLElement | null;
303
+
304
+ if (!heading) {
305
+ return;
306
+ }
307
+
308
+ if (this.aiToolbarElement?.previousElementSibling === heading) {
309
+ return;
310
+ }
311
+
312
+ this.removeAiToolbar();
313
+
314
+ const toolbar = createElement(AI_TOOLBAR_TAG, {
315
+ is: AiToolbar
316
+ }) as unknown as HTMLElement;
317
+ heading.parentNode?.insertBefore(toolbar, heading.nextSibling);
318
+ this.aiToolbarElement = toolbar;
319
+ }
320
+
321
+ protected removeAiToolbar(): void {
322
+ if (this.aiToolbarElement) {
323
+ this.aiToolbarElement.remove();
324
+ this.aiToolbarElement = null;
325
+ }
326
+ }
327
+
269
328
  disconnectedCallback(): void {
270
329
  this.disconnectObserver();
271
330
  window.removeEventListener(
@@ -281,6 +340,8 @@ export default class ContentLayout extends LightningElement {
281
340
 
282
341
  // Remove link click handler
283
342
  this.template.removeEventListener("click", this.handleLinkClick);
343
+
344
+ this.removeAiToolbar();
284
345
  }
285
346
 
286
347
  restoreScroll() {
@@ -523,6 +584,7 @@ export default class ContentLayout extends LightningElement {
523
584
 
524
585
  onSlotChange(): void {
525
586
  this.updateRNB();
587
+ this.updateAiToolbar();
526
588
  this.contentLoaded = true;
527
589
  }
528
590
 
@@ -13,7 +13,6 @@
13
13
  onclick={onLinkClick}
14
14
  class="dev-center-content"
15
15
  >
16
- <dx-icon symbol="back"></dx-icon>
17
16
  <dx-icon
18
17
  class="brand-icon"
19
18
  lwc:if={devCenter.icon}
@@ -2,6 +2,7 @@
2
2
  import { createElement, LightningElement, api } from "lwc";
3
3
  import DocPhase from "doc/phase";
4
4
  import DxFooter from "dx/footer";
5
+ import DxIcon from "dx/icon";
5
6
  import SprigSurvey from "doc/sprigSurvey";
6
7
  import { throttle } from "throttle-debounce";
7
8
  import { pollUntil } from "dxUtils/async";
@@ -14,11 +15,19 @@ declare global {
14
15
 
15
16
  declare const Sprig: (eventType: string, eventName: string) => void;
16
17
 
18
+ type ReferenceTopic = {
19
+ link?: { href?: string };
20
+ children?: ReferenceTopic[];
21
+ };
22
+
17
23
  type ReferenceItem = {
18
24
  source: string;
19
25
  href: string;
26
+ title?: string;
20
27
  isSelected?: boolean;
21
28
  docPhase?: string | null;
29
+ referenceType?: string;
30
+ topic?: ReferenceTopic;
22
31
  };
23
32
 
24
33
  type ReferenceConfig = {
@@ -28,6 +37,7 @@ type ReferenceConfig = {
28
37
  const SCROLL_THROTTLE_DELAY = 50;
29
38
  const ELEMENT_TIMEOUT = 10000;
30
39
  const ELEMENT_CHECK_INTERVAL = 100;
40
+ const REFERENCES_SEGMENT = "/references/";
31
41
 
32
42
  export default class RedocReference extends LightningElement {
33
43
  private _referenceConfig: ReferenceConfig = { refList: [] };
@@ -38,6 +48,12 @@ export default class RedocReference extends LightningElement {
38
48
  private docPhaseWrapperElement: Element | null = null;
39
49
  private lastSidebarTop = 0;
40
50
 
51
+ /**
52
+ * History length captured at mount (pre-Redoc), used by `onBackClick` to
53
+ * distinguish in-tab navigation (> 1) from a fresh entry (=== 1).
54
+ */
55
+ private initialHistoryLength = 0;
56
+
41
57
  showError = false;
42
58
 
43
59
  @api
@@ -71,6 +87,75 @@ export default class RedocReference extends LightningElement {
71
87
  /** Optional origin URL for the footer MFE (e.g. wp-json endpoint). Passed through to dx-footer. */
72
88
  @api origin: string | null = null;
73
89
 
90
+ /**
91
+ * Project title (same value passed to `<doc-header>` as `subtitle`). Used
92
+ * inside the Redoc-rendered UI to label the parent project.
93
+ */
94
+ @api projectTitle: string | null = "All Reference";
95
+
96
+ get specTitle(): string | null {
97
+ return this.getSelectedReference()?.title ?? null;
98
+ }
99
+
100
+ /**
101
+ * Whether to show the project header (only for multi-spec reference sets).
102
+ */
103
+ get showRedocHeader(): boolean {
104
+ const refCount = this._referenceConfig?.refList?.length ?? 0;
105
+ const isMultiSpecSet = refCount > 1;
106
+ return isMultiSpecSet && !!(this.projectTitle || this.specTitle);
107
+ }
108
+
109
+ /**
110
+ * Navigates back to reference doc.
111
+ */
112
+ private onBackClick = (event: Event): void => {
113
+ event.preventDefault();
114
+ const referrerHref = this.getSameOriginReferrerHref();
115
+ if (referrerHref) {
116
+ window.location.href = referrerHref;
117
+ return;
118
+ }
119
+ const fallbackHref = this.getReferencesRootHref();
120
+ if (fallbackHref) {
121
+ window.location.href = fallbackHref;
122
+ }
123
+ };
124
+
125
+ /**
126
+ * Returns the referrer URL when the page was reached via in-tab navigation
127
+ * from a same-origin page; otherwise `null`. Both `initialHistoryLength`
128
+ * and `document.referrer` are checked since neither signal is reliable on
129
+ * its own.
130
+ */
131
+ private getSameOriginReferrerHref(): string | null {
132
+ if (this.initialHistoryLength <= 1 || !document.referrer) {
133
+ return null;
134
+ }
135
+ try {
136
+ const referrerUrl = new URL(document.referrer);
137
+ if (referrerUrl.origin !== window.location.origin) {
138
+ return null;
139
+ }
140
+ return referrerUrl.href;
141
+ } catch {
142
+ return null;
143
+ }
144
+ }
145
+
146
+ /**
147
+ * Derives the project's `.../references` root from the current URL by
148
+ * trimming any trailing reference id (and deeper segments). Returns null
149
+ * when the URL doesn't contain a `/references` segment.
150
+ */
151
+ private getReferencesRootHref(): string | null {
152
+ const { pathname } = window.location;
153
+ const idx = pathname.lastIndexOf(REFERENCES_SEGMENT);
154
+ return idx === -1
155
+ ? null
156
+ : pathname.slice(0, idx + REFERENCES_SEGMENT.length);
157
+ }
158
+
74
159
  /** When origin is provided, pass it to the footer; otherwise use dx-footer's default. */
75
160
  get effectiveFooterOrigin(): string {
76
161
  return (
@@ -79,6 +164,10 @@ export default class RedocReference extends LightningElement {
79
164
  }
80
165
 
81
166
  connectedCallback(): void {
167
+ // Snapshot history length before Redoc pushes its own hash entries,
168
+ // so it reflects real in-tab navigation rather than Redoc's churn.
169
+ this.initialHistoryLength = window.history.length;
170
+
82
171
  window.addEventListener("scroll", this.handleScrollAndResize);
83
172
  window.addEventListener("resize", this.handleScrollAndResize);
84
173
  }
@@ -304,6 +393,9 @@ export default class RedocReference extends LightningElement {
304
393
 
305
394
  this.appendFooterItems(apiContentDiv);
306
395
 
396
+ // Inject the multi-spec project header into Redoc's left menu only.
397
+ this.insertProjectHeaderInMenu(redocContainer);
398
+
307
399
  // Wait for footer to be rendered before updating styles
308
400
  requestAnimationFrame(() => {
309
401
  this.updateRedocThirdColumnStyle(redocContainer);
@@ -316,6 +408,65 @@ export default class RedocReference extends LightningElement {
316
408
  }
317
409
  }
318
410
 
411
+ /**
412
+ * Inserts the project header into Redoc for multi-spec reference sets.
413
+ */
414
+ private insertProjectHeaderInMenu(redocContainer: HTMLElement): void {
415
+ if (!this.showRedocHeader) {
416
+ return;
417
+ }
418
+
419
+ // Select the LNB and content area of Redoc and insert the requried header.
420
+ redocContainer
421
+ .querySelectorAll<HTMLElement>(".menu-content, .api-content")
422
+ .forEach((target) => {
423
+ target.insertBefore(
424
+ this.buildProjectHeaderDom(),
425
+ target.firstChild
426
+ );
427
+ });
428
+ }
429
+
430
+ /**
431
+ * Builds a fresh project-title/spec-title header DOM node.
432
+ */
433
+ private buildProjectHeaderDom(): HTMLElement {
434
+ const wrapper = document.createElement("div");
435
+ wrapper.className = "redoc-project-header";
436
+
437
+ if (this.projectTitle) {
438
+ const backLink = document.createElement("a");
439
+ backLink.className = "redoc-project-back";
440
+ backLink.href = "#";
441
+ backLink.addEventListener("click", this.onBackClick);
442
+
443
+ const icon = createElement("dx-icon", { is: DxIcon });
444
+ Object.assign(icon, {
445
+ sprite: "utility",
446
+ symbol: "back",
447
+ size: "medium"
448
+ });
449
+ icon.classList.add("redoc-project-back-arrow");
450
+
451
+ const label = document.createElement("span");
452
+ label.className = "redoc-project-title";
453
+ label.textContent = this.projectTitle;
454
+
455
+ backLink.appendChild(icon);
456
+ backLink.appendChild(label);
457
+ wrapper.appendChild(backLink);
458
+ }
459
+
460
+ if (this.specTitle) {
461
+ const specEl = document.createElement("h2");
462
+ specEl.className = "redoc-spec-title dx-text-display-7";
463
+ specEl.textContent = this.specTitle;
464
+ wrapper.appendChild(specEl);
465
+ }
466
+
467
+ return wrapper;
468
+ }
469
+
319
470
  // Waits for Redoc's API content element to be rendered
320
471
  private async waitForApiContent(
321
472
  container: HTMLElement
package/LICENSE DELETED
@@ -1,12 +0,0 @@
1
- Copyright (c) 2020, Salesforce.com, Inc.
2
- All rights reserved.
3
-
4
- Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5
-
6
- * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
7
-
8
- * 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.
9
-
10
- * 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.
11
-
12
- 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.