@salesforcedevs/docs-components 1.36.0-alpha.0 → 1.37.0-final-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.
@@ -4,11 +4,26 @@ import DocPhase from "doc/phase";
4
4
  import DxFooter from "dx/footer";
5
5
  import DxIcon from "dx/icon";
6
6
  import SidebarFooterNav from "dx/sidebarFooterNav";
7
+ import VersionPicker from "dx/versionPicker";
7
8
  import SprigSurvey from "doc/sprigSurvey";
8
9
  import { throttle } from "throttle-debounce";
9
10
  import { pollUntil } from "dxUtils/async";
10
11
  import { toJson } from "dxUtils/normalizers";
11
- import type { OptionWithLink } from "typings/custom";
12
+ import { oldVersionDocInfo } from "docUtils/utils";
13
+ import {
14
+ applyVersionToHref,
15
+ collectSubtreeCanonicalHrefs,
16
+ DOCS_LOCALE_SEGMENT_INDEX,
17
+ DOCS_PATH_SEGMENT,
18
+ normalizePath,
19
+ getTopicVersionKey,
20
+ getVersionPickerOptions,
21
+ persistTopicVersion,
22
+ REFERENCES_LOCALE_SEGMENT_INDEX,
23
+ toCanonicalHref
24
+ } from "dxUtils/topicVersion";
25
+ import type { VersionedNode } from "dxUtils/topicVersion";
26
+ import type { DocPhaseInfo, OptionWithLink } from "typings/custom";
12
27
 
13
28
  declare global {
14
29
  interface Window {
@@ -33,8 +48,20 @@ type ReferenceItem = {
33
48
  topic?: ReferenceTopic;
34
49
  };
35
50
 
51
+ /** A selectable spec version. Mirrors `ReferenceVersion` in `doc/amfReference`. */
52
+ type ReferenceVersion = {
53
+ id: string;
54
+ label: string;
55
+ deprecated?: boolean;
56
+ selected?: boolean;
57
+ link: { href: string };
58
+ };
59
+
36
60
  type ReferenceConfig = {
37
61
  refList: ReferenceItem[];
62
+ versions?: ReferenceVersion[];
63
+ /** Latest switching URL. The sidebar stores the selected version under this key. */
64
+ versionTopicSessionKey?: string;
38
65
  };
39
66
 
40
67
  const SCROLL_THROTTLE_DELAY = 50;
@@ -42,7 +69,7 @@ const ELEMENT_TIMEOUT = 10000;
42
69
  const ELEMENT_CHECK_INTERVAL = 100;
43
70
  const DEFAULT_PROJECT_TITLE = "All Reference";
44
71
  const BACK_TARGET_STORAGE_KEY = "redoc-back-target";
45
- const DOCS_PATH_SEGMENT = "docs";
72
+ const SELECTED_VIEW_STORAGE_KEY = "redoc-selected-view";
46
73
  const DEFAULT_LOCALE = "en-us";
47
74
 
48
75
  export default class RedocReference extends LightningElement {
@@ -80,6 +107,7 @@ export default class RedocReference extends LightningElement {
80
107
  error
81
108
  );
82
109
  }
110
+ this.refreshVersions();
83
111
  }
84
112
 
85
113
  @api
@@ -116,6 +144,32 @@ export default class RedocReference extends LightningElement {
116
144
  */
117
145
  @api headerHref: string | null = null;
118
146
 
147
+ /**
148
+ * Versioned topic that owns this spec, including its children.
149
+ * Href matches this page, so an older version still has its version
150
+ * in the path.
151
+ */
152
+ @api
153
+ set versionedTopicTree(
154
+ value: string | { topics?: VersionedNode[] } | null
155
+ ) {
156
+ try {
157
+ const parsed = toJson(value) as { topics?: VersionedNode[] } | null;
158
+ this._versionedTopicNode = parsed?.topics?.[0] ?? null;
159
+ } catch (error) {
160
+ this._versionedTopicNode = null;
161
+ }
162
+ this.refreshVersions();
163
+ }
164
+
165
+ get versionedTopicTree(): { topics?: VersionedNode[] } | null {
166
+ return this._versionedTopicNode
167
+ ? { topics: [this._versionedTopicNode] }
168
+ : null;
169
+ }
170
+
171
+ private _versionedTopicNode: VersionedNode | null = null;
172
+
119
173
  @api
120
174
  get contentType(): string {
121
175
  return this._contentType;
@@ -152,6 +206,76 @@ export default class RedocReference extends LightningElement {
152
206
  return refCount > 1;
153
207
  }
154
208
 
209
+ private _versions: ReferenceVersion[] = [];
210
+
211
+ get versions(): ReferenceVersion[] {
212
+ return this._versions;
213
+ }
214
+
215
+ /**
216
+ * Picker hrefs for the open page. Both setters call this because LWC can
217
+ * assign referenceConfig and versionedTopicTree in either order. The page
218
+ * URL is already set by then and does not change for this instance.
219
+ */
220
+ private refreshVersions(): void {
221
+ const versions = this._referenceConfig?.versions ?? [];
222
+ const node = this._versionedTopicNode;
223
+ if (!node?.versions?.length || typeof window === "undefined") {
224
+ this._versions = versions;
225
+ return;
226
+ }
227
+
228
+ // Same helper as the markdown sidebar. The same array means this page
229
+ // is outside the topic, so the backend switching URLs stay as authored.
230
+ const rewritten = getVersionPickerOptions(node);
231
+ if (!rewritten || rewritten === node.versions) {
232
+ this._versions = versions;
233
+ return;
234
+ }
235
+
236
+ this._versions = versions.map((version) => {
237
+ const href = rewritten.find((option) => option.id === version.id)
238
+ ?.link?.href;
239
+ if (!href || href === version.link?.href) {
240
+ return version;
241
+ }
242
+ return {
243
+ ...version,
244
+ link: { ...version.link, href }
245
+ };
246
+ });
247
+ }
248
+
249
+ /** The version flagged `selected`, else the first (the latest/GA version). */
250
+ get selectedVersion(): ReferenceVersion | null {
251
+ const versions = this.versions;
252
+ return versions.find((v) => v.selected) ?? versions[0] ?? null;
253
+ }
254
+
255
+ /** True when the selected version is the latest/GA one (index 0). */
256
+ get latestVersion(): boolean {
257
+ return this.versions.length
258
+ ? this.selectedVersion?.id === this.versions[0].id
259
+ : false;
260
+ }
261
+
262
+ get hasVersionPicker(): boolean {
263
+ return this.versions.length > 0;
264
+ }
265
+
266
+ /** "Newer version available" banner info when on a non-latest version, else null. */
267
+ private get oldVersionInfo(): DocPhaseInfo | null {
268
+ if (this.versions.length > 1 && !this.latestVersion) {
269
+ return oldVersionDocInfo(this.versions[0].link.href);
270
+ }
271
+ return null;
272
+ }
273
+
274
+ /** A single version has nothing to choose, so it renders read-only. */
275
+ get isVersionReadOnly(): boolean {
276
+ return this.versions.length === 1;
277
+ }
278
+
155
279
  // Reads stored back target
156
280
  private getBackTargetFromSession(): string | null {
157
281
  return sessionStorage.getItem(BACK_TARGET_STORAGE_KEY);
@@ -186,13 +310,88 @@ export default class RedocReference extends LightningElement {
186
310
  private onBackClick = (event: Event): void => {
187
311
  event.preventDefault();
188
312
 
189
- const target = this.getTranslatedBackTarget() ?? this.headerHref;
313
+ const target = this.getVersionedBackTarget() ?? this.headerHref;
190
314
 
191
315
  if (target) {
192
316
  window.location.assign(target);
193
317
  }
194
318
  };
195
319
 
320
+ /**
321
+ * When the back target is in this spec's topic, return it on the
322
+ * selected version. With no back target, do the same for the header
323
+ * link when that link is the versioned parent.
324
+ */
325
+ private getVersionedBackTarget(): string | null {
326
+ const stored = this.getTranslatedBackTarget();
327
+ const selectedVersion = this.selectedVersion;
328
+ const target = stored ?? this.headerHref;
329
+ if (!target || !selectedVersion) {
330
+ return stored;
331
+ }
332
+
333
+ let targetUrl: URL;
334
+ try {
335
+ targetUrl = new URL(target, window.location.origin);
336
+ } catch {
337
+ return target;
338
+ }
339
+
340
+ // The spec picker links can use a different file name in each version
341
+ // (`sample-api` and `new-sample-api`). That pair cannot move a sibling
342
+ // page between versions. The parent topic's switching URLs share one
343
+ // slug, so the back target is rewritten from those.
344
+ const rewriteVersions = this.backTargetVersions();
345
+ const rewriteVersion =
346
+ rewriteVersions.find(
347
+ (version) => version.id === selectedVersion.id
348
+ ) ?? selectedVersion;
349
+ const familyHrefs = this._versionedTopicNode
350
+ ? collectSubtreeCanonicalHrefs(this._versionedTopicNode).map(
351
+ (href) => toCanonicalHref(href, rewriteVersions)
352
+ )
353
+ : [];
354
+
355
+ const canonicalTarget = toCanonicalHref(
356
+ targetUrl.pathname,
357
+ rewriteVersions
358
+ );
359
+ const inFamily = familyHrefs.some(
360
+ (href) => normalizePath(href) === normalizePath(canonicalTarget)
361
+ );
362
+ if (!inFamily) {
363
+ return target;
364
+ }
365
+
366
+ const versioned = applyVersionToHref(
367
+ canonicalTarget,
368
+ rewriteVersion,
369
+ rewriteVersions
370
+ );
371
+ if (!versioned) {
372
+ return target;
373
+ }
374
+ return `${versioned}${targetUrl.search}${targetUrl.hash}`;
375
+ }
376
+
377
+ /**
378
+ * Version URLs used to move the back target. Prefer the parent topic's
379
+ * switching URLs. Fall back to the spec picker when this spec is the
380
+ * versioned topic itself.
381
+ */
382
+ private backTargetVersions(): ReferenceVersion[] {
383
+ const familyVersions = this._versionedTopicNode?.versions;
384
+ if (!familyVersions?.length) {
385
+ return this.versions;
386
+ }
387
+ return familyVersions.map((version) => ({
388
+ id: version.id,
389
+ label: version.label,
390
+ link: { href: version.link?.href ?? "" },
391
+ selected: version.id === this.selectedVersion?.id
392
+ }));
393
+ }
394
+
196
395
  private getTranslatedBackTarget(): string | null {
197
396
  const stored = this.getBackTargetFromSession();
198
397
  if (stored) {
@@ -202,7 +401,9 @@ export default class RedocReference extends LightningElement {
202
401
  }
203
402
 
204
403
  const referrer = this.getSameOriginReferrerHref();
205
- return referrer && !this.isLocaleHref(new URL(referrer).pathname)
404
+ return referrer &&
405
+ !this.isLocaleHref(new URL(referrer).pathname) &&
406
+ !this.isVersionHref(new URL(referrer).pathname)
206
407
  ? referrer
207
408
  : null;
208
409
  }
@@ -216,7 +417,9 @@ export default class RedocReference extends LightningElement {
216
417
  const segments = url.pathname.split("/").filter(Boolean);
217
418
 
218
419
  // docs -> right after "docs"; references -> after the product segment.
219
- const localeIndex = this.isDocContentType ? 1 : 2;
420
+ const localeIndex = this.isDocContentType
421
+ ? DOCS_LOCALE_SEGMENT_INDEX
422
+ : REFERENCES_LOCALE_SEGMENT_INDEX;
220
423
 
221
424
  if (segments[0] === DOCS_PATH_SEGMENT) {
222
425
  // Drop the existing locale segment, if any
@@ -241,7 +444,10 @@ export default class RedocReference extends LightningElement {
241
444
  }
242
445
 
243
446
  const referrerUrl = new URL(referrerHref);
244
- if (this.isLocaleHref(referrerUrl.pathname)) {
447
+ if (
448
+ this.isLocaleHref(referrerUrl.pathname) ||
449
+ this.isVersionHref(referrerUrl.pathname)
450
+ ) {
245
451
  return;
246
452
  }
247
453
 
@@ -282,6 +488,19 @@ export default class RedocReference extends LightningElement {
282
488
  });
283
489
  }
284
490
 
491
+ /**
492
+ * switching version on this same page.
493
+ */
494
+ private isVersionHref(pathname: string): boolean {
495
+ return this.versions.some((version) => {
496
+ const href = version?.link?.href;
497
+ return (
498
+ !!href &&
499
+ new URL(href, window.location.origin).pathname === pathname
500
+ );
501
+ });
502
+ }
503
+
285
504
  /** When origin is provided, pass it to the footer; otherwise use dx-footer's default. */
286
505
  get effectiveFooterOrigin(): string {
287
506
  return (
@@ -297,6 +516,13 @@ export default class RedocReference extends LightningElement {
297
516
  // Track the back target, preserving it across locale switches
298
517
  this.trackBackTarget();
299
518
 
519
+ // Remember the selected version for the sidebar. Changing version
520
+ // reloads this page.
521
+ const topicKey = this.getParentTopicVersionKey();
522
+ if (topicKey && this.selectedVersion) {
523
+ persistTopicVersion(topicKey, this.selectedVersion.id);
524
+ }
525
+
300
526
  window.addEventListener("scroll", this.handleScrollAndResize);
301
527
  window.addEventListener("resize", this.handleScrollAndResize);
302
528
  }
@@ -354,6 +580,14 @@ export default class RedocReference extends LightningElement {
354
580
  return parseInt(value, 10) || 0;
355
581
  }
356
582
 
583
+ /** Redoc's LNB background color, themeable via `--doc-c-redoc-sidebar-bg`. */
584
+ private get sidebarBackgroundColor(): string {
585
+ const value = getComputedStyle(this.template.host).getPropertyValue(
586
+ "--doc-c-redoc-sidebar-bg"
587
+ );
588
+ return value.trim() || "white";
589
+ }
590
+
357
591
  /*
358
592
  ** Since we could not use --dx-g-global-header-height as getPropertyValue returns a calc expression,
359
593
  ** we are using the respective CSS variables to calculate the height.
@@ -469,7 +703,14 @@ export default class RedocReference extends LightningElement {
469
703
  specUrl,
470
704
  {
471
705
  // Dynamic scroll offset to account for headers
472
- scrollYOffset: this.calculateScrollYOffset
706
+ scrollYOffset: this.calculateScrollYOffset,
707
+ // Redoc's own styled background outranks injected
708
+ // CSS, so the LNB background must be set via theme.
709
+ theme: {
710
+ sidebar: {
711
+ backgroundColor: this.sidebarBackgroundColor
712
+ }
713
+ }
473
714
  },
474
715
  redocContainer,
475
716
  (error: any) => {
@@ -515,10 +756,7 @@ export default class RedocReference extends LightningElement {
515
756
  const apiContentDiv = await this.waitForApiContent(redocContainer);
516
757
  apiContentDiv.setAttribute("lwc:dom", "manual");
517
758
 
518
- const docPhaseInfo = this.getDocPhaseInfo();
519
- if (docPhaseInfo) {
520
- this.insertDocPhase(apiContentDiv, docPhaseInfo);
521
- }
759
+ this.insertStatusItems(apiContentDiv);
522
760
 
523
761
  this.appendFooterItems(apiContentDiv);
524
762
 
@@ -527,10 +765,22 @@ export default class RedocReference extends LightningElement {
527
765
 
528
766
  // Wait for footer to be rendered before updating styles
529
767
  requestAnimationFrame(() => {
530
- this.updateRedocThirdColumnStyle(redocContainer);
531
-
532
- // Fix initial hash scroll after doc phase insertion
533
- this.handleInitialHashScrollFix();
768
+ try {
769
+ this.updateRedocThirdColumnStyle(redocContainer);
770
+
771
+ // Restore the view selected before a version switch only
772
+ // after all layout mutations (footer, header) are
773
+ // complete, so the scroll lands on the correct element.
774
+ this.restoreSelectedView();
775
+
776
+ // Fix initial hash scroll after doc phase insertion
777
+ this.handleInitialHashScrollFix();
778
+ } catch (error) {
779
+ this.showErrorUI(
780
+ "Failed to integrate custom components:",
781
+ error
782
+ );
783
+ }
534
784
  });
535
785
  } catch (error) {
536
786
  this.showErrorUI("Failed to integrate custom components:", error);
@@ -560,6 +810,71 @@ export default class RedocReference extends LightningElement {
560
810
  }
561
811
  }
562
812
 
813
+ /** Builds the version picker DOM by reusing `dx-version-picker`. */
814
+ private buildVersionPickerDom(): HTMLElement {
815
+ const wrapper = document.createElement("div");
816
+ wrapper.className = "redoc-version-picker";
817
+
818
+ const picker = createElement("dx-version-picker", {
819
+ is: VersionPicker
820
+ });
821
+
822
+ Object.assign(picker, {
823
+ versions: this.versions,
824
+ selectedVersion: this.selectedVersion,
825
+ latestVersion: this.latestVersion,
826
+ readOnly: this.isVersionReadOnly
827
+ });
828
+ picker.addEventListener("change", this.onVersionChange);
829
+ wrapper.appendChild(picker);
830
+
831
+ return wrapper;
832
+ }
833
+
834
+ /**
835
+ * Key the sidebar uses for this topic's selected version.
836
+ * Missing `versionTopicSessionKey` returns null so nothing is written.
837
+ */
838
+ private getParentTopicVersionKey(): string | null {
839
+ const versionTopicSessionKey =
840
+ this._referenceConfig?.versionTopicSessionKey;
841
+ if (!versionTopicSessionKey) {
842
+ return null;
843
+ }
844
+ return (
845
+ getTopicVersionKey(
846
+ { name: versionTopicSessionKey },
847
+ this.language ?? undefined
848
+ ) || null
849
+ );
850
+ }
851
+
852
+ /** Stashes the current view (URL hash) before the version link navigates. */
853
+ private onVersionChange = (): void => {
854
+ sessionStorage.setItem(
855
+ SELECTED_VIEW_STORAGE_KEY,
856
+ window.location.hash || ""
857
+ );
858
+ };
859
+
860
+ /**
861
+ * Re-applies the view stashed before a version switch, if its anchor exists
862
+ * in the new spec; otherwise a no-op (lands on the spec root).
863
+ */
864
+ private restoreSelectedView(): void {
865
+ const storedHash = sessionStorage.getItem(SELECTED_VIEW_STORAGE_KEY);
866
+ sessionStorage.removeItem(SELECTED_VIEW_STORAGE_KEY);
867
+
868
+ if (!storedHash || window.location.hash) {
869
+ return;
870
+ }
871
+
872
+ const targetId = storedHash.replace(/^#/, "");
873
+ if (targetId && document.getElementById(targetId)) {
874
+ window.location.hash = storedHash;
875
+ }
876
+ }
877
+
563
878
  /**
564
879
  * Builds the locale picker DOM by reusing `dx-sidebar-footer-nav`
565
880
  */
@@ -581,12 +896,17 @@ export default class RedocReference extends LightningElement {
581
896
  }
582
897
 
583
898
  /**
584
- * Builds a fresh project-title/spec-title header DOM node.
899
+ * Builds the doc header: a title group (back link + spec title) and, when
900
+ * versions are available, the version picker as a sibling row. Layout/gaps
901
+ * are styled by the developer-website's redoc CSS.
585
902
  */
586
903
  private buildProjectHeaderDom(): HTMLElement {
587
904
  const wrapper = document.createElement("div");
588
905
  wrapper.className = "redoc-project-header";
589
906
 
907
+ const main = document.createElement("div");
908
+ main.className = "redoc-project-header-main";
909
+
590
910
  if (this.projectTitle) {
591
911
  const backLink = document.createElement("a");
592
912
  backLink.className = "redoc-project-back";
@@ -607,14 +927,20 @@ export default class RedocReference extends LightningElement {
607
927
 
608
928
  backLink.appendChild(icon);
609
929
  backLink.appendChild(label);
610
- wrapper.appendChild(backLink);
930
+ main.appendChild(backLink);
611
931
  }
612
932
 
613
933
  if (this.specTitle) {
614
934
  const specEl = document.createElement("h2");
615
935
  specEl.className = "redoc-spec-title dx-text-display-7";
616
936
  specEl.textContent = this.specTitle;
617
- wrapper.appendChild(specEl);
937
+ main.appendChild(specEl);
938
+ }
939
+
940
+ wrapper.appendChild(main);
941
+
942
+ if (this.hasVersionPicker) {
943
+ wrapper.appendChild(this.buildVersionPickerDom());
618
944
  }
619
945
 
620
946
  return wrapper;
@@ -639,15 +965,40 @@ export default class RedocReference extends LightningElement {
639
965
  return container.querySelector<HTMLElement>(".api-content")!;
640
966
  }
641
967
 
642
- // Creates and inserts doc phase component at container start
643
- private insertDocPhase(container: HTMLElement, docPhaseInfo: string): void {
968
+ // Inserts the doc phase and, on a non-latest version, a dismissible
969
+ // "newer version" banner into a shared doc-phase-wrapper at container start
970
+ private insertStatusItems(container: HTMLElement): void {
971
+ const docPhaseInfo = this.getDocPhaseInfo();
972
+ const oldVersionInfo = this.oldVersionInfo;
973
+ if (!docPhaseInfo && !oldVersionInfo) {
974
+ return;
975
+ }
976
+
644
977
  const wrapper = document.createElement("div");
645
978
  wrapper.className = "doc-phase-wrapper";
646
979
  container.insertBefore(wrapper, container.firstChild);
647
980
 
648
- const docPhaseElement = createElement("doc-phase", { is: DocPhase });
649
- Object.assign(docPhaseElement, { docPhaseInfo });
650
- wrapper.appendChild(docPhaseElement);
981
+ if (docPhaseInfo) {
982
+ const docPhaseElement = createElement("doc-phase", {
983
+ is: DocPhase
984
+ });
985
+ Object.assign(docPhaseElement, { docPhaseInfo });
986
+ wrapper.appendChild(docPhaseElement);
987
+ }
988
+
989
+ if (oldVersionInfo) {
990
+ const versionBanner = createElement("doc-phase", { is: DocPhase });
991
+ Object.assign(versionBanner, {
992
+ docPhaseInfo: oldVersionInfo,
993
+ dismissible: true,
994
+ iconName: "warning"
995
+ });
996
+ versionBanner.addEventListener("dismissphase", () => {
997
+ versionBanner.remove();
998
+ this.updateSidebarPosition();
999
+ });
1000
+ wrapper.appendChild(versionBanner);
1001
+ }
651
1002
  }
652
1003
 
653
1004
  // Appends footer component to container
@@ -7,7 +7,6 @@
7
7
  sidebar-header={sidebarHeader}
8
8
  sidebar-value={sidebarValue}
9
9
  sidebar-content={sidebarContent}
10
- sidebar-loading={isSidebarLoading}
11
10
  toc-title={tocTitle}
12
11
  toc-options={tocOptions}
13
12
  toc-aria-level={tocAriaLevel}
@@ -25,6 +24,14 @@
25
24
  lwc:if={docPhaseInfo}
26
25
  doc-phase-info={docPhaseInfo}
27
26
  ></doc-phase>
27
+ <doc-phase
28
+ slot="version-banner"
29
+ lwc:if={showVersionBanner}
30
+ doc-phase-info={oldVersionInfo}
31
+ icon-name="warning"
32
+ dismissible="true"
33
+ ondismissphase={handleDismissVersionBanner}
34
+ ></doc-phase>
28
35
  <slot></slot>
29
36
  </doc-content-layout>
30
37
  </template>