@salesforcedevs/docs-components 1.34.4 → 1.34.5-bug-fix-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
@@ -26,7 +26,6 @@
26
26
  "doc/phase",
27
27
  "doc/redocReference",
28
28
  "doc/specificationContent",
29
- "doc/versionPicker",
30
29
  "doc/xmlContent",
31
30
  "docUtils/searchClient",
32
31
  "docUtils/searchController",
package/package.json CHANGED
@@ -1,29 +1,29 @@
1
1
  {
2
- "name": "@salesforcedevs/docs-components",
3
- "version": "1.34.4",
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": "563b708d0438eb63783483178fc116897aa12b7a"
29
- }
2
+ "name": "@salesforcedevs/docs-components",
3
+ "version": "1.34.5-bug-fix-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
+ }
@@ -35,13 +35,13 @@
35
35
  ondismissphase={handleDismissVersionBanner}
36
36
  ></doc-phase>
37
37
  <div lwc:if={isVersionEnabled} slot="sidebar-header">
38
- <doc-version-picker
38
+ <dx-version-picker
39
39
  onchange={handleVersionChange}
40
40
  data-type="version"
41
41
  versions={versions}
42
42
  selected-version={selectedVersion}
43
43
  latest-version={latestVersion}
44
- ></doc-version-picker>
44
+ ></dx-version-picker>
45
45
  </div>
46
46
  <template lwc:if={showSpecBasedReference}>
47
47
  <div class="container">
@@ -3,4 +3,5 @@
3
3
  --doc-c-redoc-sidebar-top: calc(
4
4
  var(--dx-g-global-header-height) + var(--dx-g-doc-header-height)
5
5
  );
6
+ --doc-c-redoc-sidebar-bg: white;
6
7
  }
@@ -4,11 +4,25 @@ 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
+ persistTopicVersion,
21
+ REFERENCES_LOCALE_SEGMENT_INDEX,
22
+ toCanonicalHref
23
+ } from "dxUtils/topicVersion";
24
+ import type { VersionedNode } from "dxUtils/topicVersion";
25
+ import type { DocPhaseInfo, OptionWithLink } from "typings/custom";
12
26
 
13
27
  declare global {
14
28
  interface Window {
@@ -33,8 +47,20 @@ type ReferenceItem = {
33
47
  topic?: ReferenceTopic;
34
48
  };
35
49
 
50
+ /** A selectable spec version. Mirrors `ReferenceVersion` in `doc/amfReference`. */
51
+ type ReferenceVersion = {
52
+ id: string;
53
+ label: string;
54
+ deprecated?: boolean;
55
+ selected?: boolean;
56
+ link: { href: string };
57
+ };
58
+
36
59
  type ReferenceConfig = {
37
60
  refList: ReferenceItem[];
61
+ versions?: ReferenceVersion[];
62
+ /** Sidebar topic name. Sidebar stores the selected version under this key. */
63
+ versionTopicKey?: string;
38
64
  };
39
65
 
40
66
  const SCROLL_THROTTLE_DELAY = 50;
@@ -42,7 +68,7 @@ const ELEMENT_TIMEOUT = 10000;
42
68
  const ELEMENT_CHECK_INTERVAL = 100;
43
69
  const DEFAULT_PROJECT_TITLE = "All Reference";
44
70
  const BACK_TARGET_STORAGE_KEY = "redoc-back-target";
45
- const DOCS_PATH_SEGMENT = "docs";
71
+ const SELECTED_VIEW_STORAGE_KEY = "redoc-selected-view";
46
72
  const DEFAULT_LOCALE = "en-us";
47
73
 
48
74
  export default class RedocReference extends LightningElement {
@@ -116,6 +142,29 @@ export default class RedocReference extends LightningElement {
116
142
  */
117
143
  @api headerHref: string | null = null;
118
144
 
145
+ /**
146
+ * Versioned topic that owns this spec, including its children.
147
+ * Href matches this page, so an older version still has its version
148
+ * in the path.
149
+ */
150
+ @api
151
+ set parentTopicFamily(value: string | { topics?: VersionedNode[] } | null) {
152
+ try {
153
+ const parsed = toJson(value) as { topics?: VersionedNode[] } | null;
154
+ this._parentTopicFamilyNode = parsed?.topics?.[0] ?? null;
155
+ } catch (error) {
156
+ this._parentTopicFamilyNode = null;
157
+ }
158
+ }
159
+
160
+ get parentTopicFamily(): { topics?: VersionedNode[] } | null {
161
+ return this._parentTopicFamilyNode
162
+ ? { topics: [this._parentTopicFamilyNode] }
163
+ : null;
164
+ }
165
+
166
+ private _parentTopicFamilyNode: VersionedNode | null = null;
167
+
119
168
  @api
120
169
  get contentType(): string {
121
170
  return this._contentType;
@@ -152,6 +201,40 @@ export default class RedocReference extends LightningElement {
152
201
  return refCount > 1;
153
202
  }
154
203
 
204
+ get versions(): ReferenceVersion[] {
205
+ return this._referenceConfig?.versions ?? [];
206
+ }
207
+
208
+ /** The version flagged `selected`, else the first (the latest/GA version). */
209
+ get selectedVersion(): ReferenceVersion | null {
210
+ const versions = this.versions;
211
+ return versions.find((v) => v.selected) ?? versions[0] ?? null;
212
+ }
213
+
214
+ /** True when the selected version is the latest/GA one (index 0). */
215
+ get latestVersion(): boolean {
216
+ return this.versions.length
217
+ ? this.selectedVersion?.id === this.versions[0].id
218
+ : false;
219
+ }
220
+
221
+ get hasVersionPicker(): boolean {
222
+ return this.versions.length > 0;
223
+ }
224
+
225
+ /** "Newer version available" banner info when on a non-latest version, else null. */
226
+ private get oldVersionInfo(): DocPhaseInfo | null {
227
+ if (this.versions.length > 1 && !this.latestVersion) {
228
+ return oldVersionDocInfo(this.versions[0].link.href);
229
+ }
230
+ return null;
231
+ }
232
+
233
+ /** A single version has nothing to choose, so it renders read-only. */
234
+ get isVersionReadOnly(): boolean {
235
+ return this.versions.length === 1;
236
+ }
237
+
155
238
  // Reads stored back target
156
239
  private getBackTargetFromSession(): string | null {
157
240
  return sessionStorage.getItem(BACK_TARGET_STORAGE_KEY);
@@ -186,13 +269,64 @@ export default class RedocReference extends LightningElement {
186
269
  private onBackClick = (event: Event): void => {
187
270
  event.preventDefault();
188
271
 
189
- const target = this.getTranslatedBackTarget() ?? this.headerHref;
272
+ const target = this.getVersionedBackTarget() ?? this.headerHref;
190
273
 
191
274
  if (target) {
192
275
  window.location.assign(target);
193
276
  }
194
277
  };
195
278
 
279
+ /**
280
+ * When the back target is in this spec's topic, return it on the
281
+ * selected version. With no back target, do the same for the header
282
+ * link when that link is the versioned parent.
283
+ */
284
+ private getVersionedBackTarget(): string | null {
285
+ const stored = this.getTranslatedBackTarget();
286
+ const selectedVersion = this.selectedVersion;
287
+ const target = stored ?? this.headerHref;
288
+ if (!target || !selectedVersion) {
289
+ return stored;
290
+ }
291
+
292
+ let targetUrl: URL;
293
+ try {
294
+ targetUrl = new URL(target, window.location.origin);
295
+ } catch {
296
+ return target;
297
+ }
298
+
299
+ // Family hrefs match this page's version. Compare them without
300
+ // the version segment. Rewrite only the pathname so the target's
301
+ // query and hash survive.
302
+ const familyHrefs = this._parentTopicFamilyNode
303
+ ? collectSubtreeCanonicalHrefs(this._parentTopicFamilyNode).map(
304
+ (href) => toCanonicalHref(href, this.versions)
305
+ )
306
+ : [];
307
+
308
+ const canonicalTarget = toCanonicalHref(
309
+ targetUrl.pathname,
310
+ this.versions
311
+ );
312
+ const inFamily = familyHrefs.some(
313
+ (href) => normalizePath(href) === normalizePath(canonicalTarget)
314
+ );
315
+ if (!inFamily) {
316
+ return target;
317
+ }
318
+
319
+ const versioned = applyVersionToHref(
320
+ canonicalTarget,
321
+ selectedVersion,
322
+ this.versions
323
+ );
324
+ if (!versioned) {
325
+ return target;
326
+ }
327
+ return `${versioned}${targetUrl.search}${targetUrl.hash}`;
328
+ }
329
+
196
330
  private getTranslatedBackTarget(): string | null {
197
331
  const stored = this.getBackTargetFromSession();
198
332
  if (stored) {
@@ -202,7 +336,9 @@ export default class RedocReference extends LightningElement {
202
336
  }
203
337
 
204
338
  const referrer = this.getSameOriginReferrerHref();
205
- return referrer && !this.isLocaleHref(new URL(referrer).pathname)
339
+ return referrer &&
340
+ !this.isLocaleHref(new URL(referrer).pathname) &&
341
+ !this.isVersionHref(new URL(referrer).pathname)
206
342
  ? referrer
207
343
  : null;
208
344
  }
@@ -216,7 +352,9 @@ export default class RedocReference extends LightningElement {
216
352
  const segments = url.pathname.split("/").filter(Boolean);
217
353
 
218
354
  // docs -> right after "docs"; references -> after the product segment.
219
- const localeIndex = this.isDocContentType ? 1 : 2;
355
+ const localeIndex = this.isDocContentType
356
+ ? DOCS_LOCALE_SEGMENT_INDEX
357
+ : REFERENCES_LOCALE_SEGMENT_INDEX;
220
358
 
221
359
  if (segments[0] === DOCS_PATH_SEGMENT) {
222
360
  // Drop the existing locale segment, if any
@@ -241,7 +379,10 @@ export default class RedocReference extends LightningElement {
241
379
  }
242
380
 
243
381
  const referrerUrl = new URL(referrerHref);
244
- if (this.isLocaleHref(referrerUrl.pathname)) {
382
+ if (
383
+ this.isLocaleHref(referrerUrl.pathname) ||
384
+ this.isVersionHref(referrerUrl.pathname)
385
+ ) {
245
386
  return;
246
387
  }
247
388
 
@@ -282,6 +423,19 @@ export default class RedocReference extends LightningElement {
282
423
  });
283
424
  }
284
425
 
426
+ /**
427
+ * switching version on this same page.
428
+ */
429
+ private isVersionHref(pathname: string): boolean {
430
+ return this.versions.some((version) => {
431
+ const href = version?.link?.href;
432
+ return (
433
+ !!href &&
434
+ new URL(href, window.location.origin).pathname === pathname
435
+ );
436
+ });
437
+ }
438
+
285
439
  /** When origin is provided, pass it to the footer; otherwise use dx-footer's default. */
286
440
  get effectiveFooterOrigin(): string {
287
441
  return (
@@ -297,6 +451,13 @@ export default class RedocReference extends LightningElement {
297
451
  // Track the back target, preserving it across locale switches
298
452
  this.trackBackTarget();
299
453
 
454
+ // Remember the selected version for the sidebar. Changing version
455
+ // reloads this page.
456
+ const topicKey = this.getParentTopicVersionKey();
457
+ if (topicKey && this.selectedVersion) {
458
+ persistTopicVersion(topicKey, this.selectedVersion.id);
459
+ }
460
+
300
461
  window.addEventListener("scroll", this.handleScrollAndResize);
301
462
  window.addEventListener("resize", this.handleScrollAndResize);
302
463
  }
@@ -354,6 +515,14 @@ export default class RedocReference extends LightningElement {
354
515
  return parseInt(value, 10) || 0;
355
516
  }
356
517
 
518
+ /** Redoc's LNB background color, themeable via `--doc-c-redoc-sidebar-bg`. */
519
+ private get sidebarBackgroundColor(): string {
520
+ const value = getComputedStyle(this.template.host).getPropertyValue(
521
+ "--doc-c-redoc-sidebar-bg"
522
+ );
523
+ return value.trim() || "white";
524
+ }
525
+
357
526
  /*
358
527
  ** Since we could not use --dx-g-global-header-height as getPropertyValue returns a calc expression,
359
528
  ** we are using the respective CSS variables to calculate the height.
@@ -469,7 +638,14 @@ export default class RedocReference extends LightningElement {
469
638
  specUrl,
470
639
  {
471
640
  // Dynamic scroll offset to account for headers
472
- scrollYOffset: this.calculateScrollYOffset
641
+ scrollYOffset: this.calculateScrollYOffset,
642
+ // Redoc's own styled background outranks injected
643
+ // CSS, so the LNB background must be set via theme.
644
+ theme: {
645
+ sidebar: {
646
+ backgroundColor: this.sidebarBackgroundColor
647
+ }
648
+ }
473
649
  },
474
650
  redocContainer,
475
651
  (error: any) => {
@@ -515,10 +691,7 @@ export default class RedocReference extends LightningElement {
515
691
  const apiContentDiv = await this.waitForApiContent(redocContainer);
516
692
  apiContentDiv.setAttribute("lwc:dom", "manual");
517
693
 
518
- const docPhaseInfo = this.getDocPhaseInfo();
519
- if (docPhaseInfo) {
520
- this.insertDocPhase(apiContentDiv, docPhaseInfo);
521
- }
694
+ this.insertStatusItems(apiContentDiv);
522
695
 
523
696
  this.appendFooterItems(apiContentDiv);
524
697
 
@@ -527,10 +700,22 @@ export default class RedocReference extends LightningElement {
527
700
 
528
701
  // Wait for footer to be rendered before updating styles
529
702
  requestAnimationFrame(() => {
530
- this.updateRedocThirdColumnStyle(redocContainer);
531
-
532
- // Fix initial hash scroll after doc phase insertion
533
- this.handleInitialHashScrollFix();
703
+ try {
704
+ this.updateRedocThirdColumnStyle(redocContainer);
705
+
706
+ // Restore the view selected before a version switch only
707
+ // after all layout mutations (footer, header) are
708
+ // complete, so the scroll lands on the correct element.
709
+ this.restoreSelectedView();
710
+
711
+ // Fix initial hash scroll after doc phase insertion
712
+ this.handleInitialHashScrollFix();
713
+ } catch (error) {
714
+ this.showErrorUI(
715
+ "Failed to integrate custom components:",
716
+ error
717
+ );
718
+ }
534
719
  });
535
720
  } catch (error) {
536
721
  this.showErrorUI("Failed to integrate custom components:", error);
@@ -560,6 +745,70 @@ export default class RedocReference extends LightningElement {
560
745
  }
561
746
  }
562
747
 
748
+ /** Builds the version picker DOM by reusing `dx-version-picker`. */
749
+ private buildVersionPickerDom(): HTMLElement {
750
+ const wrapper = document.createElement("div");
751
+ wrapper.className = "redoc-version-picker";
752
+
753
+ const picker = createElement("dx-version-picker", {
754
+ is: VersionPicker
755
+ });
756
+
757
+ Object.assign(picker, {
758
+ versions: this.versions,
759
+ selectedVersion: this.selectedVersion,
760
+ latestVersion: this.latestVersion,
761
+ readOnly: this.isVersionReadOnly
762
+ });
763
+ picker.addEventListener("change", this.onVersionChange);
764
+ wrapper.appendChild(picker);
765
+
766
+ return wrapper;
767
+ }
768
+
769
+ /**
770
+ * Key the sidebar uses for this topic's selected version.
771
+ * Missing `versionTopicKey` returns null so nothing is written.
772
+ */
773
+ private getParentTopicVersionKey(): string | null {
774
+ const versionTopicKey = this._referenceConfig?.versionTopicKey;
775
+ if (!versionTopicKey) {
776
+ return null;
777
+ }
778
+ return (
779
+ getTopicVersionKey(
780
+ { name: versionTopicKey },
781
+ this.language ?? undefined
782
+ ) || null
783
+ );
784
+ }
785
+
786
+ /** Stashes the current view (URL hash) before the version link navigates. */
787
+ private onVersionChange = (): void => {
788
+ sessionStorage.setItem(
789
+ SELECTED_VIEW_STORAGE_KEY,
790
+ window.location.hash || ""
791
+ );
792
+ };
793
+
794
+ /**
795
+ * Re-applies the view stashed before a version switch, if its anchor exists
796
+ * in the new spec; otherwise a no-op (lands on the spec root).
797
+ */
798
+ private restoreSelectedView(): void {
799
+ const storedHash = sessionStorage.getItem(SELECTED_VIEW_STORAGE_KEY);
800
+ sessionStorage.removeItem(SELECTED_VIEW_STORAGE_KEY);
801
+
802
+ if (!storedHash || window.location.hash) {
803
+ return;
804
+ }
805
+
806
+ const targetId = storedHash.replace(/^#/, "");
807
+ if (targetId && document.getElementById(targetId)) {
808
+ window.location.hash = storedHash;
809
+ }
810
+ }
811
+
563
812
  /**
564
813
  * Builds the locale picker DOM by reusing `dx-sidebar-footer-nav`
565
814
  */
@@ -581,12 +830,17 @@ export default class RedocReference extends LightningElement {
581
830
  }
582
831
 
583
832
  /**
584
- * Builds a fresh project-title/spec-title header DOM node.
833
+ * Builds the doc header: a title group (back link + spec title) and, when
834
+ * versions are available, the version picker as a sibling row. Layout/gaps
835
+ * are styled by the developer-website's redoc CSS.
585
836
  */
586
837
  private buildProjectHeaderDom(): HTMLElement {
587
838
  const wrapper = document.createElement("div");
588
839
  wrapper.className = "redoc-project-header";
589
840
 
841
+ const main = document.createElement("div");
842
+ main.className = "redoc-project-header-main";
843
+
590
844
  if (this.projectTitle) {
591
845
  const backLink = document.createElement("a");
592
846
  backLink.className = "redoc-project-back";
@@ -607,14 +861,20 @@ export default class RedocReference extends LightningElement {
607
861
 
608
862
  backLink.appendChild(icon);
609
863
  backLink.appendChild(label);
610
- wrapper.appendChild(backLink);
864
+ main.appendChild(backLink);
611
865
  }
612
866
 
613
867
  if (this.specTitle) {
614
868
  const specEl = document.createElement("h2");
615
869
  specEl.className = "redoc-spec-title dx-text-display-7";
616
870
  specEl.textContent = this.specTitle;
617
- wrapper.appendChild(specEl);
871
+ main.appendChild(specEl);
872
+ }
873
+
874
+ wrapper.appendChild(main);
875
+
876
+ if (this.hasVersionPicker) {
877
+ wrapper.appendChild(this.buildVersionPickerDom());
618
878
  }
619
879
 
620
880
  return wrapper;
@@ -639,15 +899,40 @@ export default class RedocReference extends LightningElement {
639
899
  return container.querySelector<HTMLElement>(".api-content")!;
640
900
  }
641
901
 
642
- // Creates and inserts doc phase component at container start
643
- private insertDocPhase(container: HTMLElement, docPhaseInfo: string): void {
902
+ // Inserts the doc phase and, on a non-latest version, a dismissible
903
+ // "newer version" banner into a shared doc-phase-wrapper at container start
904
+ private insertStatusItems(container: HTMLElement): void {
905
+ const docPhaseInfo = this.getDocPhaseInfo();
906
+ const oldVersionInfo = this.oldVersionInfo;
907
+ if (!docPhaseInfo && !oldVersionInfo) {
908
+ return;
909
+ }
910
+
644
911
  const wrapper = document.createElement("div");
645
912
  wrapper.className = "doc-phase-wrapper";
646
913
  container.insertBefore(wrapper, container.firstChild);
647
914
 
648
- const docPhaseElement = createElement("doc-phase", { is: DocPhase });
649
- Object.assign(docPhaseElement, { docPhaseInfo });
650
- wrapper.appendChild(docPhaseElement);
915
+ if (docPhaseInfo) {
916
+ const docPhaseElement = createElement("doc-phase", {
917
+ is: DocPhase
918
+ });
919
+ Object.assign(docPhaseElement, { docPhaseInfo });
920
+ wrapper.appendChild(docPhaseElement);
921
+ }
922
+
923
+ if (oldVersionInfo) {
924
+ const versionBanner = createElement("doc-phase", { is: DocPhase });
925
+ Object.assign(versionBanner, {
926
+ docPhaseInfo: oldVersionInfo,
927
+ dismissible: true,
928
+ iconName: "warning"
929
+ });
930
+ versionBanner.addEventListener("dismissphase", () => {
931
+ versionBanner.remove();
932
+ this.updateSidebarPosition();
933
+ });
934
+ wrapper.appendChild(versionBanner);
935
+ }
651
936
  }
652
937
 
653
938
  // Appends footer component to container
@@ -24,6 +24,14 @@
24
24
  lwc:if={docPhaseInfo}
25
25
  doc-phase-info={docPhaseInfo}
26
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>
27
35
  <slot></slot>
28
36
  </doc-content-layout>
29
37
  </template>
@@ -1,6 +1,12 @@
1
- import { LightningElement, api } from "lwc";
1
+ import { LightningElement, api, track } from "lwc";
2
2
  import { toJson } from "dxUtils/normalizers";
3
- import type { OptionWithLink, TreeNode } from "typings/custom";
3
+ import type { VersionedNode } from "dxUtils/topicVersion";
4
+ import {
5
+ findTopicVersionForCurrentPage,
6
+ latestHrefForCurrentPage
7
+ } from "dxUtils/topicVersion";
8
+ import { oldVersionDocInfo } from "docUtils/utils";
9
+ import type { DocPhaseInfo, OptionWithLink, TreeNode } from "typings/custom";
4
10
 
5
11
  /**
6
12
  * Per-topic type emitted by the docs content-type parser
@@ -10,61 +16,48 @@ import type { OptionWithLink, TreeNode } from "typings/custom";
10
16
  */
11
17
  const TOPIC_TYPE_SPEC = "spec";
12
18
 
13
- /**
14
- * Walks down the first-child chain and returns the first markdown content
15
- * page found, descending through nested content-less parents. Returns
16
- * undefined if the chain breaks on a spec or external link before reaching a
17
- * content page.
18
- */
19
- function firstChildContentPage(node: TreeNode): TreeNode | undefined {
20
- const firstChild = node.children?.[0];
21
- if (!firstChild) {
22
- return undefined;
23
- }
24
-
25
- const isSpec =
26
- (firstChild as { topicType?: string }).topicType === TOPIC_TYPE_SPEC;
27
- const isExternal = firstChild.link?.target === "_blank";
28
- if (isSpec || isExternal) {
29
- return undefined;
30
- }
31
-
32
- if (firstChild.link?.href) {
33
- return firstChild;
34
- }
35
-
36
- return firstChildContentPage(firstChild);
37
- }
38
-
39
19
  /**
40
20
  * Translates per-topic `topicType` into the generic `showForwardArrow` flag
41
- * that `dx-tree-tile` reads (spec topics get the forward arrow icon for Redoc),
42
- * and redirects content-less parent topics whose first child is a content page
21
+ * that `dx-tree-tile` reads (spec topics get the forward arrow icon for Redoc).
22
+ *
23
+ * Content-less parents are flagged with redirectToChild and left without a
24
+ * link. The tree selects the first markdown descendant. Copying that child's
25
+ * href onto the parent makes the parent win selection.
43
26
  */
44
- function decorateTopics(
45
- topics: Array<TreeNode & { topicType?: string }> | undefined
27
+ function decorateTopicsWithForwardArrow(
28
+ topics:
29
+ | Array<TreeNode & { topicType?: string; versions?: unknown }>
30
+ | undefined
46
31
  ): TreeNode[] | undefined {
47
32
  return topics?.map((topic) => {
48
- const { topicType, ...decorated } = topic;
33
+ const { topicType, versions, ...decorated } = topic;
49
34
  if (topicType === TOPIC_TYPE_SPEC) {
50
35
  decorated.showForwardArrow = true;
36
+ // Nested and standalone specs never get a sidebar picker; only the
37
+ // parent MD topic (when versioned) shows one.
38
+ } else if (Array.isArray(versions)) {
39
+ decorated.versions = versions.map(
40
+ (version: { children?: TreeNode[] }) =>
41
+ version.children
42
+ ? {
43
+ ...version,
44
+ children: decorateTopicsWithForwardArrow(
45
+ version.children
46
+ )
47
+ }
48
+ : version
49
+ );
51
50
  }
52
51
  if (decorated.children) {
53
- decorated.children = decorateTopics(decorated.children);
52
+ decorated.children = decorateTopicsWithForwardArrow(
53
+ decorated.children
54
+ );
54
55
  }
55
56
 
56
- /** Redirect a parent that has no content of its own to its first child
57
- * but only when that first child is itself a content page
58
- */
59
- const isContentlessParent =
60
- !!decorated.children?.length && !decorated.link?.href;
61
-
62
- if (isContentlessParent) {
57
+ // Flag a parent with no page of its own. Leave its link empty so the
58
+ // child's URL stays indexed to the child.
59
+ if (!!decorated.children?.length && !decorated.link?.href) {
63
60
  decorated.redirectToChild = true;
64
- const firstChild = firstChildContentPage(topic);
65
- if (firstChild?.link) {
66
- decorated.link = { ...firstChild.link };
67
- }
68
61
  }
69
62
 
70
63
  return decorated;
@@ -101,6 +94,9 @@ export default class UnifiedContentLayout extends LightningElement {
101
94
 
102
95
  private _docPhaseInfo: string | null = null;
103
96
  private _sidebarContent: unknown = null;
97
+ private _oldVersionInfo: DocPhaseInfo | null = null;
98
+
99
+ @track showVersionBanner = false;
104
100
 
105
101
  @api
106
102
  get docPhaseInfo(): string | null {
@@ -117,7 +113,40 @@ export default class UnifiedContentLayout extends LightningElement {
117
113
  }
118
114
 
119
115
  set sidebarContent(value: string) {
120
- this._sidebarContent = decorateTopics(toJson(value)?.topics);
116
+ const topics = decorateTopicsWithForwardArrow(toJson(value)?.topics);
117
+ this._sidebarContent = topics;
118
+ this.updateTopicVersionBanner(topics as VersionedNode[] | undefined);
119
+ }
120
+
121
+ get oldVersionInfo(): DocPhaseInfo | null {
122
+ return this._oldVersionInfo;
123
+ }
124
+
125
+ handleDismissVersionBanner(): void {
126
+ this.showVersionBanner = false;
127
+ }
128
+
129
+ /**
130
+ * Same banner references use when the reader is on an older version.
131
+ * Topic versions are not a separate page property: the sidebar tree
132
+ * carries each version's switching URL, and the current pathname says
133
+ * which one is open.
134
+ */
135
+ private updateTopicVersionBanner(
136
+ topics: VersionedNode[] | undefined
137
+ ): void {
138
+ const match = findTopicVersionForCurrentPage(topics);
139
+ const latest = match?.node.versions?.[0];
140
+ const latestHref = latestHrefForCurrentPage(match?.node.versions);
141
+
142
+ if (match && latest && match.version.id !== latest.id && latestHref) {
143
+ this._oldVersionInfo = oldVersionDocInfo(latestHref);
144
+ this.showVersionBanner = true;
145
+ return;
146
+ }
147
+
148
+ this._oldVersionInfo = null;
149
+ this.showVersionBanner = false;
121
150
  }
122
151
 
123
152
  private get enableFooter(): boolean {
@@ -24,7 +24,7 @@
24
24
  ondismissphase={handleDismissVersionBanner}
25
25
  ></doc-phase>
26
26
  <div lwc:if={showVersionPicker} slot="sidebar-header">
27
- <doc-version-picker
27
+ <dx-version-picker
28
28
  data-type="version"
29
29
  analytics-event="custEv_linkClick"
30
30
  analytics-payload={ANALYTICS_PAYLOAD}
@@ -32,7 +32,7 @@
32
32
  selected-version={version}
33
33
  latest-version={latestVersion}
34
34
  hide-badge={previewVersion}
35
- ></doc-version-picker>
35
+ ></dx-version-picker>
36
36
  </div>
37
37
  <div class="breadcrumb-row" lwc:if={showBreadcrumbs}>
38
38
  <doc-breadcrumbs
@@ -23,6 +23,9 @@ export interface SearchResult {
23
23
  // and existing fixtures still satisfy the type.
24
24
  snippet?: string | null;
25
25
  snippetSource?: SnippetSource;
26
+ // `url` plus `#anchor` of the page section that matched, or null/absent
27
+ // when the matched chunk has no anchor. Link to it via resultHref().
28
+ sectionUrl?: string | null;
26
29
  }
27
30
 
28
31
  export interface FacetBucket {
@@ -208,6 +211,19 @@ export function sanitizeSnippetHtml(value: unknown): string {
208
211
  * text path. So for anything but a headline we return `null` and let the
209
212
  * caller keep today's text rendering.
210
213
  */
214
+ /**
215
+ * Where a result's title should link: the matched section when the backend
216
+ * returned one, else the page. The section link is only trusted when it is the
217
+ * page URL plus a fragment, so a malformed value can never send the user
218
+ * somewhere else.
219
+ */
220
+ export function resultHref(result: SearchResult): string {
221
+ const { url, sectionUrl } = result;
222
+ return typeof sectionUrl === "string" && sectionUrl.startsWith(`${url}#`)
223
+ ? sectionUrl
224
+ : url;
225
+ }
226
+
211
227
  export function highlightedSnippetHtml(result: SearchResult): string | null {
212
228
  if (result.snippetSource !== "headline") {
213
229
  return null;
@@ -1,10 +1,28 @@
1
1
  import { CoveoAnalyticsClient } from "coveo.analytics/dist/browser.mjs"; // This fix is required for Node 20 upgrade, so that Coveo analytics is loaded properly by LWR.
2
2
 
3
+ // Resolve against the current origin (version links are usually relative) and
4
+ // keep only http/https. Blocks executable schemes like javascript:/data: that
5
+ // would run when the innerHTML-rendered link is clicked
6
+ // encodeURI then keeps the value from breaking out of the href attribute.
7
+ const toSafeHref = (link: string): string => {
8
+ try {
9
+ const { protocol } = new URL(link, window.location.origin);
10
+ if (protocol === "http:" || protocol === "https:") {
11
+ return encodeURI(link);
12
+ }
13
+ } catch {
14
+ // Fall through to the rejection below.
15
+ }
16
+ console.warn(`Blocked unsafe version link: ${link}`);
17
+ return "#";
18
+ };
19
+
3
20
  export const oldVersionDocInfo = (latestVersionLink: string) => {
21
+ const safeLink = toSafeHref(latestVersionLink);
4
22
  return {
5
23
  title: "Newer Version Available",
6
- body: `This content describes an older version of this product.
7
- <a style="font-weight: bold;" href="${latestVersionLink}">View Latest</a>`
24
+ body: `This content describes an older version of this product.
25
+ <a style="font-weight: bold;" href="${safeLink}">View Latest</a>`
8
26
  };
9
27
  };
10
28
 
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.
@@ -1,64 +0,0 @@
1
- @import "dxHelpers/reset";
2
-
3
- /* NOTE: doc-version-picker-width width variable is used by both dx-button and dx-dropdown to maintain a consistent width. */
4
- :host {
5
- --dx-c-dropdown-option-font-weight: normal;
6
- --dx-c-dropdown-option-label-color: var(--dx-g-gray-10);
7
- --popover-container-open-transform: translateY(4px);
8
- }
9
-
10
- .version-picker-container {
11
- padding: 8px var(--dx-g-spacing-lg) 8px
12
- var(--dx-g-global-header-padding-horizontal);
13
- border-top: 1px solid var(--dx-g-gray-90);
14
- border-bottom: 1px solid var(--dx-g-gray-90);
15
- }
16
-
17
- .version-picker-button {
18
- display: flex;
19
- width: var(--doc-version-picker-width, 296px);
20
- }
21
-
22
- .version-picker-button:hover,
23
- .version-picker-button:active,
24
- .version-picker-button:focus {
25
- --dx-c-button-secondary-color-hover: var(--dx-g-cloud-blue-vibrant-95);
26
- --dx-c-button-primary-color: var(--dx-g-blue-vibrant-40);
27
- }
28
-
29
- /**
30
- * NOTE: This CSS ensures the span inside the button stays within the parent's width, avoiding overflow.
31
- * Not keeping this in common component to ensure that existing functionality works as it is.
32
- */
33
- dx-button::part(content) {
34
- width: inherit;
35
- overflow: hidden;
36
- }
37
-
38
- .selected-version {
39
- display: flex;
40
- flex-direction: row;
41
- align-items: center;
42
- }
43
-
44
- .selected-version-label {
45
- flex: 1;
46
- overflow: hidden;
47
- text-align: left;
48
- text-overflow: ellipsis;
49
- white-space: nowrap;
50
- }
51
-
52
- dx-type-badge.latest-badge {
53
- --dx-c-type-badge-color: var(--dx-g-green-vibrant-40);
54
- --dx-c-type-badge-background: var(--dx-g-green-vibrant-95);
55
-
56
- margin-left: var(--dx-g-spacing-sm);
57
- }
58
-
59
- dx-type-badge.not-latest-badge {
60
- --dx-c-type-badge-color: var(--dx-g-red-vibrant-40);
61
- --dx-c-type-badge-background: var(--dx-g-red-vibrant-95);
62
-
63
- margin-left: var(--dx-g-spacing-sm);
64
- }
@@ -1,40 +0,0 @@
1
- <template>
2
- <div lwc:if={showVersionPicker} class="version-picker-container">
3
- <dx-dropdown
4
- options={versions}
5
- analytics-event="custEv_docVersionSelect"
6
- analytics-payload={analyticsPayload}
7
- value={selectedVersion.id}
8
- width="var(--doc-version-picker-width)"
9
- onchange={onVersionChange}
10
- >
11
- <dx-button
12
- class="version-picker-button"
13
- variant="tertiary"
14
- size="small"
15
- icon-symbol="chevrondown"
16
- icon-size="medium"
17
- >
18
- <div class="selected-version">
19
- <p class="selected-version-label">
20
- {selectedVersion.label}
21
- </p>
22
- <template lwc:if={showLatestTag}>
23
- <dx-type-badge
24
- class="latest-badge"
25
- lwc:if={latestVersion}
26
- value="Latest"
27
- size="small"
28
- ></dx-type-badge>
29
- <dx-type-badge
30
- class="not-latest-badge"
31
- lwc:else
32
- value="Not Latest"
33
- size="small"
34
- ></dx-type-badge>
35
- </template>
36
- </div>
37
- </dx-button>
38
- </dx-dropdown>
39
- </div>
40
- </template>
@@ -1,65 +0,0 @@
1
- import { LightningElement, api, track } from "lwc";
2
-
3
- import { AnalyticsPayload, OptionWithNested } from "typings/custom";
4
-
5
- import { toJson, normalizeBoolean } from "dxUtils/normalizers";
6
-
7
- export default class VersionPicker extends LightningElement {
8
- @api analyticsEvent?: string;
9
- @api analyticsPayload?: AnalyticsPayload;
10
-
11
- @track private _versions!: OptionWithNested[];
12
- private _selectedVersion?: OptionWithNested;
13
- private _latestVersion: boolean = false;
14
- private _hideBadge: boolean = false;
15
-
16
- @api
17
- get versions() {
18
- return this._versions;
19
- }
20
-
21
- set versions(value: OptionWithNested[]) {
22
- this._versions = toJson(value);
23
- }
24
-
25
- @api
26
- get selectedVersion(): OptionWithNested | undefined {
27
- return this._selectedVersion || this.versions[0];
28
- }
29
-
30
- set selectedVersion(value: OptionWithNested) {
31
- if (value) {
32
- this._selectedVersion = toJson(value);
33
- }
34
- }
35
-
36
- @api
37
- get latestVersion() {
38
- return this._latestVersion;
39
- }
40
-
41
- set latestVersion(value) {
42
- this._latestVersion = normalizeBoolean(value);
43
- }
44
-
45
- @api
46
- get hideBadge() {
47
- return this._hideBadge;
48
- }
49
-
50
- set hideBadge(value) {
51
- this._hideBadge = normalizeBoolean(value);
52
- }
53
-
54
- private get showVersionPicker() {
55
- return this._versions && this._versions.length !== 0;
56
- }
57
-
58
- private get showLatestTag(): boolean {
59
- return !this.hideBadge;
60
- }
61
-
62
- private onVersionChange(e: CustomEvent) {
63
- this.dispatchEvent(new CustomEvent("change", { detail: e.detail }));
64
- }
65
- }