@salesforcedevs/docs-components 1.36.0-alpha.0 → 1.37.0-node24-1

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/package.json CHANGED
@@ -1,29 +1,29 @@
1
1
  {
2
- "name": "@salesforcedevs/docs-components",
3
- "version": "1.36.0-alpha.0",
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
- }
2
+ "name": "@salesforcedevs/docs-components",
3
+ "version": "1.37.0-node24-1",
4
+ "description": "Docs Lightning web components for DSC",
5
+ "license": "MIT",
6
+ "main": "index.js",
7
+ "engines": {
8
+ "node": "24.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
+ }
@@ -29,7 +29,6 @@ import {
29
29
  import { restoreScroll } from "dx/scrollManager";
30
30
  import { DocPhaseInfo } from "typings/custom";
31
31
  import { oldVersionDocInfo } from "docUtils/utils";
32
- import { loadSidebar } from "docUtils/sidebarLoader";
33
32
  import { track as trackEvent } from "dxUtils/analytics";
34
33
 
35
34
  type NavigationItem = {
@@ -101,7 +100,6 @@ export default class AmfReference extends LightningElement {
101
100
  };
102
101
  }
103
102
 
104
- this.markdownTopicsPromise = undefined;
105
103
  this._amfConfigList = this._referenceSetConfig.refList || [];
106
104
 
107
105
  this._amfConfigList.forEach((amfConfig) => {
@@ -166,20 +164,6 @@ export default class AmfReference extends LightningElement {
166
164
  this._expandChildren = normalizeBoolean(value);
167
165
  }
168
166
 
169
- /**
170
- * URL of the left-nav JSON file with the topic trees of the markdown
171
- * references, used when the reference set config omits them.
172
- */
173
- @api
174
- get sidebarSrc(): string | undefined {
175
- return this._sidebarSrc;
176
- }
177
-
178
- set sidebarSrc(value: string | undefined) {
179
- this._sidebarSrc = value || undefined;
180
- this.loadMarkdownTopics();
181
- }
182
-
183
167
  private get enableFooter(): boolean {
184
168
  return !this.hideFooter;
185
169
  }
@@ -212,9 +196,6 @@ export default class AmfReference extends LightningElement {
212
196
  private isParentLevelDocPhaseEnabled = false;
213
197
  private selectedReferenceDocPhase?: string | null = null;
214
198
  private _expandChildren?: boolean = false;
215
- private _sidebarSrc?: string;
216
- /** Set while the markdown reference topics load from `sidebarSrc`. */
217
- private markdownTopicsPromise?: Promise<void>;
218
199
  private isVersionFetched = false;
219
200
  private latestVersion = false;
220
201
 
@@ -418,7 +399,6 @@ export default class AmfReference extends LightningElement {
418
399
  if (this._amfConfigList && this._amfConfigList.length) {
419
400
  // fetch AMF Json as soon as config is set
420
401
  this.populateReferenceItems();
421
- this.loadMarkdownTopics();
422
402
  // update() must be called after renderedCallback.
423
403
  if (this.hasRendered) {
424
404
  this.updateView();
@@ -501,7 +481,16 @@ export default class AmfReference extends LightningElement {
501
481
  isChildrenLoading = true;
502
482
  }
503
483
  } else {
504
- navItemChildren = this.getMarkdownNavItemChildren(amfConfig);
484
+ const isExpandChildrenEnabled = this.isExpandChildrenEnabled(
485
+ amfConfig.id
486
+ );
487
+ // check whether we should expand all the child nodes, this is required for Coveo to crawl.
488
+ if (isExpandChildrenEnabled) {
489
+ this.expandChildrenForMarkdownReferences(
490
+ amfConfig.topic!.children
491
+ );
492
+ }
493
+ navItemChildren = amfConfig.topic!.children;
505
494
  }
506
495
  // store nav items for each spec in order
507
496
  navAmfOrder[index] = {
@@ -519,118 +508,6 @@ export default class AmfReference extends LightningElement {
519
508
  this.navigation = navAmfOrder;
520
509
  }
521
510
 
522
- /**
523
- * Returns the sidebar children of a markdown reference, expanded when
524
- * expand children is enabled for it.
525
- */
526
- private getMarkdownNavItemChildren(
527
- amfConfig: AmfConfig
528
- ): ParsedMarkdownTopic[] {
529
- // check whether we should expand all the child nodes, this is required for Coveo to crawl.
530
- if (this.isExpandChildrenEnabled(amfConfig.id)) {
531
- this.expandChildrenForMarkdownReferences(amfConfig.topic!.children);
532
- }
533
- return amfConfig.topic!.children;
534
- }
535
-
536
- /**
537
- * Loads the topic trees of the markdown references from `sidebarSrc`
538
- * when the reference set config does not include them.
539
- */
540
- private loadMarkdownTopics(): void {
541
- const src = this._sidebarSrc;
542
- const referenceSetConfig = this._referenceSetConfig;
543
- const pendingIds = this._amfConfigList
544
- .filter(
545
- (amfConfig) =>
546
- amfConfig.referenceType === REFERENCE_TYPES.markdown &&
547
- !amfConfig.topic?.children?.length
548
- )
549
- .map((amfConfig) => amfConfig.id);
550
- if (!src || !pendingIds.length || this.markdownTopicsPromise) {
551
- return;
552
- }
553
-
554
- this.updateMarkdownNavItems(pendingIds, true);
555
- this.markdownTopicsPromise = loadSidebar<
556
- Record<string, ParsedMarkdownTopic>
557
- >(src)
558
- .then(
559
- (topics) => {
560
- if (referenceSetConfig !== this._referenceSetConfig) {
561
- return;
562
- }
563
- // the config can be read-only, so replace the entries with copies
564
- this._amfConfigList = this._amfConfigList.map(
565
- (amfConfig) => {
566
- const topic = pendingIds.includes(amfConfig.id)
567
- ? topics[amfConfig.id]
568
- : undefined;
569
- if (!topic?.children) {
570
- return amfConfig;
571
- }
572
- const loadedConfig = {
573
- ...amfConfig,
574
- topic: amfConfig.topic
575
- ? {
576
- ...amfConfig.topic,
577
- children: topic.children
578
- }
579
- : topic
580
- };
581
- this._amfConfigMap.set(amfConfig.id, loadedConfig);
582
- return loadedConfig;
583
- }
584
- );
585
- },
586
- (error) => console.error(error)
587
- )
588
- .then(() => {
589
- if (referenceSetConfig !== this._referenceSetConfig) {
590
- return;
591
- }
592
- this.markdownTopicsPromise = undefined;
593
- this.updateMarkdownNavItems(pendingIds, false);
594
- });
595
- }
596
-
597
- /**
598
- * Rebuilds the sidebar items of the given markdown references.
599
- */
600
- private updateMarkdownNavItems(
601
- referenceIds: string[],
602
- isChildrenLoading: boolean
603
- ): void {
604
- this.navigation = this.navigation.map((navItem, index) => {
605
- const amfConfig = this._amfConfigList[index];
606
- return referenceIds.includes(amfConfig.id)
607
- ? {
608
- ...navItem,
609
- children: this.getMarkdownNavItemChildren(amfConfig),
610
- isChildrenLoading
611
- }
612
- : navItem;
613
- });
614
- }
615
-
616
- /**
617
- * Runs the callback once the markdown reference topics are loaded, or
618
- * right away when they are not loading.
619
- */
620
- private afterMarkdownTopics(callback: () => void): void {
621
- const promise = this.markdownTopicsPromise;
622
- if (!promise) {
623
- callback();
624
- return;
625
- }
626
- const referenceSetConfig = this._referenceSetConfig;
627
- promise.then(() => {
628
- if (referenceSetConfig === this._referenceSetConfig) {
629
- callback();
630
- }
631
- });
632
- }
633
-
634
511
  /**
635
512
  * Determines whether the sidebar tile should render a forward arrow for
636
513
  * this reference. Honors `redoc` set on the config, and also infers it
@@ -1052,7 +929,7 @@ export default class AmfReference extends LightningElement {
1052
929
  );
1053
930
  }
1054
931
  } else {
1055
- this.afterMarkdownTopics(() => this.loadMarkdownBasedReference());
932
+ this.loadMarkdownBasedReference();
1056
933
  }
1057
934
 
1058
935
  restoreScroll(); // don't try this at home kids
@@ -1087,7 +964,7 @@ export default class AmfReference extends LightningElement {
1087
964
  );
1088
965
  }
1089
966
  } else {
1090
- this.afterMarkdownTopics(() => this.loadMarkdownBasedReference());
967
+ this.loadMarkdownBasedReference();
1091
968
  }
1092
969
  }
1093
970
 
@@ -1365,21 +1242,18 @@ export default class AmfReference extends LightningElement {
1365
1242
  }
1366
1243
  });
1367
1244
  } else {
1368
- this.afterMarkdownTopics(() => {
1369
- let invalidTopicReferenceUrl: string | null = "";
1370
- if (topicId) {
1371
- const referenceDetails =
1372
- this.getRefDetailsForGivenTopicMeta(
1373
- referenceId,
1374
- topicId
1375
- );
1376
- const selectedItemUrl = referenceDetails?.referenceUrl;
1377
- if (!selectedItemUrl) {
1378
- invalidTopicReferenceUrl = previousRefUrlInSession;
1379
- }
1245
+ let invalidTopicReferenceUrl: string | null = "";
1246
+ if (topicId) {
1247
+ const referenceDetails = this.getRefDetailsForGivenTopicMeta(
1248
+ referenceId,
1249
+ topicId
1250
+ );
1251
+ const selectedItemUrl = referenceDetails?.referenceUrl;
1252
+ if (!selectedItemUrl) {
1253
+ invalidTopicReferenceUrl = previousRefUrlInSession;
1380
1254
  }
1381
- this.loadMarkdownBasedReference(invalidTopicReferenceUrl);
1382
- });
1255
+ }
1256
+ this.loadMarkdownBasedReference(invalidTopicReferenceUrl);
1383
1257
  }
1384
1258
  }
1385
1259
 
@@ -1617,9 +1491,7 @@ export default class AmfReference extends LightningElement {
1617
1491
  }
1618
1492
  }
1619
1493
  } else {
1620
- this.afterMarkdownTopics(() =>
1621
- this.loadMarkdownBasedReference(name)
1622
- );
1494
+ this.loadMarkdownBasedReference(name);
1623
1495
  }
1624
1496
  }
1625
1497
  }
@@ -31,7 +31,6 @@
31
31
  dev-center={devCenter}
32
32
  brand={brand}
33
33
  empty-state-message={emptyStateMessage}
34
- loading={showSidebarLoading}
35
34
  >
36
35
  <slot name="sidebar-header" slot="version-picker"></slot>
37
36
  </dx-sidebar-old>
@@ -5,7 +5,6 @@ import { closest, querySelector } from "kagekiri";
5
5
  import { toJson, normalizeBoolean } from "dxUtils/normalizers";
6
6
  import { highlightTerms } from "dxUtils/highlight";
7
7
  import { SearchSyncer } from "docUtils/searchSyncer";
8
- import { loadSidebar } from "docUtils/sidebarLoader";
9
8
  import type { OptionWithLink } from "typings/custom";
10
9
  import { buildDocLinkClickHandler } from "dxUtils/analytics";
11
10
  import ContentActionToolbar from "doc/contentActionToolbar";
@@ -80,15 +79,6 @@ export default class ContentLayout extends LightningElement {
80
79
  @api brand: any;
81
80
  @api emptyStateMessage?: string;
82
81
 
83
- @api
84
- get enableOpenSearch() {
85
- return this._enableOpenSearch;
86
- }
87
- set enableOpenSearch(value) {
88
- this._enableOpenSearch = normalizeBoolean(value);
89
- }
90
- private _enableOpenSearch = false;
91
-
92
82
  // This is needed for now to prevent failing snapshot tests due to links in the footer
93
83
  @api
94
84
  get showFooter() {
@@ -141,34 +131,7 @@ export default class ContentLayout extends LightningElement {
141
131
  }
142
132
 
143
133
  set sidebarContent(value: any) {
144
- // An empty attribute means the page has no inline tree (see sidebarSrc).
145
- this._sidebarContent = value === "" ? null : toJson(value);
146
- }
147
-
148
- /**
149
- * URL of the left-nav JSON, loaded when the page has no inline
150
- * `sidebar-content`.
151
- */
152
- @api
153
- get sidebarSrc(): string | undefined {
154
- return this._sidebarSrc;
155
- }
156
-
157
- set sidebarSrc(value: string | undefined) {
158
- this._sidebarSrc = value || undefined;
159
- if (this.hasConnected) {
160
- this.loadSidebarContent();
161
- }
162
- }
163
-
164
- /** Set by wrapping layouts that load the sidebar content themselves. */
165
- @api
166
- get sidebarLoading(): boolean {
167
- return this._sidebarLoading;
168
- }
169
-
170
- set sidebarLoading(value) {
171
- this._sidebarLoading = normalizeBoolean(value);
134
+ this._sidebarContent = toJson(value);
172
135
  }
173
136
 
174
137
  @api
@@ -193,30 +156,18 @@ export default class ContentLayout extends LightningElement {
193
156
  );
194
157
  }
195
158
 
196
- /** Show the OpenSearch sidebar when enabled, configured, and the old sidebar isn't requested. */
159
+ /** Show the OpenSearch sidebar when SEARCH_API_PATH is set and the old sidebar isn't requested. */
197
160
  protected get showOpenSearchSidebar(): boolean {
198
- return (
199
- this.enableOpenSearch &&
200
- !this.useOldSidebar &&
201
- isOpenSearchConfigured()
202
- );
161
+ return !this.useOldSidebar && isOpenSearchConfigured();
203
162
  }
204
163
 
205
- /** Show the legacy (keyword) sidebar when requested, or when OpenSearch is disabled or not configured. */
164
+ /** Show the legacy (keyword) sidebar when requested, or when OpenSearch isn't configured. */
206
165
  protected get showOldSidebar(): boolean {
207
166
  return !this.showOpenSearchSidebar;
208
167
  }
209
168
 
210
169
  @track
211
170
  protected _sidebarContent: unknown;
212
- protected _sidebarSrc?: string;
213
- protected _sidebarLoading = false;
214
- protected isSidebarSrcLoading = false;
215
- private hasConnected = false;
216
-
217
- protected get showSidebarLoading(): boolean {
218
- return this.sidebarLoading || this.isSidebarSrcLoading;
219
- }
220
171
 
221
172
  protected _breadcrumbs = null;
222
173
 
@@ -319,35 +270,6 @@ export default class ContentLayout extends LightningElement {
319
270
 
320
271
  // Add click handler for all links
321
272
  this.template.addEventListener("click", this.handleLinkClick);
322
-
323
- this.hasConnected = true;
324
- this.loadSidebarContent();
325
- }
326
-
327
- /**
328
- * Loads the sidebar content from `sidebarSrc`. Inline `sidebar-content`
329
- * wins; on failure the sidebar shows its empty state.
330
- */
331
- protected loadSidebarContent(): void {
332
- const src = this._sidebarSrc;
333
- if (!src || this._sidebarContent) {
334
- return;
335
- }
336
- this.isSidebarSrcLoading = true;
337
- loadSidebar(src)
338
- .then(
339
- (topics) => {
340
- if (src === this._sidebarSrc && !this._sidebarContent) {
341
- this._sidebarContent = topics;
342
- }
343
- },
344
- (error) => console.error(error)
345
- )
346
- .then(() => {
347
- if (src === this._sidebarSrc) {
348
- this.isSidebarSrcLoading = false;
349
- }
350
- });
351
273
  }
352
274
 
353
275
  // Placeholder for childs renderedCallback
@@ -419,7 +341,6 @@ export default class ContentLayout extends LightningElement {
419
341
  }
420
342
 
421
343
  disconnectedCallback(): void {
422
- this.hasConnected = false;
423
344
  this.disconnectObserver();
424
345
  window.removeEventListener(
425
346
  "highlightedtermchange",
@@ -13,7 +13,6 @@
13
13
  bail-label={bailLabel}
14
14
  dev-center={devCenter}
15
15
  brand={brand}
16
- loading={showSidebarLoading}
17
16
  >
18
17
  <slot name="sidebar-header" slot="version-picker"></slot>
19
18
  </dx-sidebar-old>
@@ -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}
@@ -1,6 +1,5 @@
1
1
  import { LightningElement, api } from "lwc";
2
2
  import { toJson } from "dxUtils/normalizers";
3
- import { loadSidebar } from "docUtils/sidebarLoader";
4
3
  import type { OptionWithLink, TreeNode } from "typings/custom";
5
4
 
6
5
  /**
@@ -118,61 +117,7 @@ export default class UnifiedContentLayout extends LightningElement {
118
117
  }
119
118
 
120
119
  set sidebarContent(value: string) {
121
- this._sidebarContent =
122
- value === "" ? null : decorateTopics(toJson(value)?.topics);
123
- }
124
-
125
- /**
126
- * URL of the left-nav JSON file, loaded when no inline `sidebarContent`
127
- * is set. Loaded here rather than in `doc-content-layout` so the topics
128
- * are decorated the same way as inline content.
129
- */
130
- @api
131
- get sidebarSrc(): string | undefined {
132
- return this._sidebarSrc;
133
- }
134
-
135
- set sidebarSrc(value: string | undefined) {
136
- this._sidebarSrc = value || undefined;
137
- if (this.hasConnected) {
138
- this.loadSidebarContent();
139
- }
140
- }
141
-
142
- private _sidebarSrc?: string;
143
- private isSidebarLoading = false;
144
- private hasConnected = false;
145
-
146
- connectedCallback(): void {
147
- this.hasConnected = true;
148
- this.loadSidebarContent();
149
- }
150
-
151
- disconnectedCallback(): void {
152
- this.hasConnected = false;
153
- }
154
-
155
- private loadSidebarContent(): void {
156
- const src = this._sidebarSrc;
157
- if (!src || this._sidebarContent) {
158
- return;
159
- }
160
-
161
- this.isSidebarLoading = true;
162
- loadSidebar<Array<TreeNode & { topicType?: string }>>(src)
163
- .then(
164
- (topics) => {
165
- if (src === this._sidebarSrc && !this._sidebarContent) {
166
- this._sidebarContent = decorateTopics(topics);
167
- }
168
- },
169
- (error) => console.error(error)
170
- )
171
- .then(() => {
172
- if (src === this._sidebarSrc) {
173
- this.isSidebarLoading = false;
174
- }
175
- });
120
+ this._sidebarContent = decorateTopics(toJson(value)?.topics);
176
121
  }
177
122
 
178
123
  private get enableFooter(): boolean {
@@ -2,7 +2,6 @@
2
2
  <doc-content-layout
3
3
  lwc:if={displayContent}
4
4
  lwc:ref="docContentLayout"
5
- enable-open-search
6
5
  sidebar-header={docTitle}
7
6
  sidebar-content={sidebarContent}
8
7
  sidebar-value={sidebarValue}
@@ -23,7 +23,8 @@ export interface SearchViewModel {
23
23
  status: SearchStatus;
24
24
  query: string;
25
25
  locale: string;
26
- selectedType: string | null;
26
+ /** null = none, a string = one type, an array = several (OR'd). */
27
+ selectedType: string | string[] | null;
27
28
  sort: SortOption;
28
29
  results: SearchResult[];
29
30
  contentTypeFacets: FacetBucket[];
@@ -113,7 +114,9 @@ export class SearchController {
113
114
  status: this.status,
114
115
  query: this.query,
115
116
  locale: this.locale,
116
- selectedType: this.selectedType,
117
+ selectedType: this.selectedType?.includes(",")
118
+ ? this.selectedType.split(",")
119
+ : this.selectedType,
117
120
  sort: this.sort,
118
121
  results: this.results,
119
122
  contentTypeFacets: this.contentTypeFacets,
@@ -234,9 +237,12 @@ export class SearchController {
234
237
  }
235
238
  }
236
239
 
237
- setType(type: string | null): void {
238
- // Disjunctive toggle: selecting the active type clears it.
239
- this.selectedType = this.selectedType === type ? null : type;
240
+ setType(type: string | string[] | null): void {
241
+ // Several types are held (and sent to the API / URL) as one
242
+ // comma-separated string. An empty array clears the selection.
243
+ const next = Array.isArray(type) ? type.join(",") || null : type;
244
+ // Disjunctive toggle: selecting the active selection clears it.
245
+ this.selectedType = this.selectedType === next ? null : next;
240
246
  this.page = 1;
241
247
  this.offset = 0;
242
248
  this.syncUrl();
@@ -1,50 +0,0 @@
1
- /**
2
- * Loads the left-nav JSON that the doc framework writes once per content type
3
- * (`lnb.<hash>.json`) and references from each page as `sidebar-src`.
4
- */
5
-
6
- /** Schema version of the left-nav JSON files this loader understands. */
7
- export const SIDEBAR_SCHEMA_VERSION = 1;
8
-
9
- type SidebarFile<T> = { schemaVersion: number; topics: T };
10
-
11
- const requests = new Map<string, Promise<unknown>>();
12
-
13
- /**
14
- * Fetches the left-nav JSON at `src` and returns its `topics`.
15
- * Requests are shared per URL; a failed request is dropped so the next call
16
- * retries. The returned topics are shared between callers.
17
- */
18
- export function loadSidebar<T>(src: string): Promise<T> {
19
- let request = requests.get(src);
20
- if (!request) {
21
- request = fetch(src, { credentials: "same-origin" })
22
- .then((response) => {
23
- if (!response.ok) {
24
- throw new Error(
25
- `Failed to load the sidebar ${src}: ${response.status}`
26
- );
27
- }
28
- return response.json();
29
- })
30
- .then((file: SidebarFile<T>) => {
31
- if (file?.schemaVersion !== SIDEBAR_SCHEMA_VERSION) {
32
- throw new Error(
33
- `Unsupported sidebar schema version ${file?.schemaVersion} in ${src}`
34
- );
35
- }
36
- return file.topics;
37
- })
38
- .catch((error) => {
39
- requests.delete(src);
40
- throw error;
41
- });
42
- requests.set(src, request);
43
- }
44
- return request as Promise<T>;
45
- }
46
-
47
- /** Drops all cached requests. Used by tests. */
48
- export function clearSidebarRequests(): void {
49
- requests.clear();
50
- }