@salesforcedevs/docs-components 0.0.5 → 0.0.6-edit

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.
Files changed (135) hide show
  1. package/lwc.config.json +25 -2
  2. package/package.json +17 -6
  3. package/src/modules/README.md +41 -0
  4. package/src/modules/doc/amfModelParser/amfModelParser.ts +674 -0
  5. package/src/modules/doc/amfReference/amfReference.css +25 -0
  6. package/src/modules/doc/amfReference/amfReference.html +60 -0
  7. package/src/modules/doc/amfReference/amfReference.ts +1494 -0
  8. package/src/modules/doc/amfReference/constants.ts +76 -0
  9. package/src/modules/doc/amfReference/types.ts +125 -0
  10. package/src/modules/doc/amfTopic/amfTopic.css +21 -0
  11. package/src/modules/doc/amfTopic/amfTopic.html +3 -0
  12. package/src/modules/doc/amfTopic/amfTopic.ts +111 -0
  13. package/src/modules/doc/amfTopic/types.ts +56 -0
  14. package/src/modules/doc/amfTopic/utils.ts +136 -0
  15. package/src/modules/doc/breadcrumbItem/breadcrumbItem.css +51 -0
  16. package/src/modules/doc/breadcrumbItem/breadcrumbItem.html +5 -0
  17. package/src/modules/doc/breadcrumbItem/breadcrumbItem.ts +71 -0
  18. package/src/modules/doc/breadcrumbs/breadcrumbs.css +27 -0
  19. package/src/modules/doc/breadcrumbs/breadcrumbs.html +58 -0
  20. package/src/modules/doc/breadcrumbs/breadcrumbs.ts +183 -0
  21. package/src/modules/doc/chat/README.md +179 -0
  22. package/src/modules/doc/chat/chat.css +821 -0
  23. package/src/modules/doc/chat/chat.html +241 -0
  24. package/src/modules/doc/chat/chat.ts +586 -0
  25. package/src/modules/doc/componentPlayground/componentPlayground.css +22 -0
  26. package/src/modules/doc/componentPlayground/componentPlayground.html +20 -0
  27. package/src/modules/doc/componentPlayground/componentPlayground.ts +29 -0
  28. package/src/modules/doc/content/content.css +382 -8
  29. package/src/modules/doc/content/content.html +3 -2
  30. package/src/modules/doc/content/content.ts +270 -128
  31. package/src/modules/doc/contentCallout/contentCallout.css +25 -26
  32. package/src/modules/doc/contentCallout/contentCallout.html +13 -4
  33. package/src/modules/doc/contentCallout/contentCallout.ts +21 -10
  34. package/src/modules/doc/contentLayout/contentLayout.css +1 -0
  35. package/src/modules/doc/contentLayout/contentLayout.html +68 -0
  36. package/src/modules/doc/contentLayout/contentLayout.ts +531 -0
  37. package/src/modules/doc/contentMedia/contentMedia.css +49 -0
  38. package/src/modules/doc/contentMedia/contentMedia.html +23 -0
  39. package/src/modules/doc/contentMedia/contentMedia.ts +34 -0
  40. package/src/modules/doc/doDont/doDont.css +47 -0
  41. package/src/modules/doc/doDont/doDont.html +27 -0
  42. package/src/modules/doc/doDont/doDont.ts +17 -0
  43. package/src/modules/doc/editFile/editFile.css +511 -0
  44. package/src/modules/doc/editFile/editFile.html +164 -0
  45. package/src/modules/doc/editFile/editFile.ts +214 -0
  46. package/src/modules/doc/header/header.css +132 -0
  47. package/src/modules/doc/header/header.html +55 -0
  48. package/src/modules/doc/header/header.ts +120 -0
  49. package/src/modules/doc/heading/heading.css +33 -0
  50. package/src/modules/doc/heading/heading.html +14 -0
  51. package/src/modules/doc/heading/heading.ts +67 -0
  52. package/src/modules/doc/headingAnchor/headingAnchor.css +33 -0
  53. package/src/modules/doc/headingAnchor/headingAnchor.html +19 -0
  54. package/src/modules/doc/headingAnchor/headingAnchor.ts +43 -0
  55. package/src/modules/doc/headingContent/headingContent.css +53 -0
  56. package/src/modules/doc/headingContent/headingContent.html +13 -0
  57. package/src/modules/doc/headingContent/headingContent.ts +30 -0
  58. package/src/modules/doc/lwcContentLayout/lwcContentLayout.css +1 -0
  59. package/src/modules/doc/lwcContentLayout/lwcContentLayout.html +68 -0
  60. package/src/modules/doc/lwcContentLayout/lwcContentLayout.ts +168 -0
  61. package/src/modules/doc/nav/nav.css +4 -2
  62. package/src/modules/doc/nav/nav.html +8 -13
  63. package/src/modules/doc/overview/overview.css +40 -0
  64. package/src/modules/doc/overview/overview.html +34 -0
  65. package/src/modules/doc/overview/overview.ts +12 -0
  66. package/src/modules/doc/phase/phase.css +70 -0
  67. package/src/modules/doc/phase/phase.html +38 -0
  68. package/src/modules/doc/phase/phase.ts +93 -0
  69. package/src/modules/doc/specificationContent/specificationContent.css +36 -0
  70. package/src/modules/doc/specificationContent/specificationContent.html +171 -0
  71. package/src/modules/doc/specificationContent/specificationContent.ts +127 -0
  72. package/src/modules/doc/sprigSurvey/sprigSurvey.html +20 -0
  73. package/src/modules/doc/sprigSurvey/sprigSurvey.scoped.css +16 -0
  74. package/src/modules/doc/sprigSurvey/sprigSurvey.ts +16 -0
  75. package/src/modules/doc/toc/toc.html +11 -6
  76. package/src/modules/doc/toc/toc.ts +1 -1
  77. package/src/modules/doc/toolbar/toolbar.html +8 -1
  78. package/src/modules/doc/versionPicker/versionPicker.css +64 -0
  79. package/src/modules/doc/versionPicker/versionPicker.html +38 -0
  80. package/src/modules/doc/versionPicker/versionPicker.ts +65 -0
  81. package/src/modules/doc/xmlContent/types.ts +120 -0
  82. package/src/modules/doc/xmlContent/utils.ts +163 -0
  83. package/src/modules/doc/xmlContent/xmlContent.css +54 -0
  84. package/src/modules/doc/xmlContent/xmlContent.html +52 -0
  85. package/src/modules/doc/xmlContent/xmlContent.ts +792 -0
  86. package/src/modules/docHelpers/amfStyle/amfStyle.css +355 -0
  87. package/src/modules/docHelpers/contentLayoutStyle/contentLayoutStyle.css +131 -0
  88. package/src/modules/docHelpers/imgStyle/imgStyle.css +59 -0
  89. package/src/modules/docHelpers/status/status.css +22 -0
  90. package/src/modules/docUtils/searchSyncer/searchSyncer.ts +86 -0
  91. package/src/modules/docUtils/utils/__mocks__/coveo.analytics.ts +16 -0
  92. package/src/modules/docUtils/utils/coveo.analytics.d.ts +10 -0
  93. package/src/modules/docUtils/utils/utils.ts +32 -0
  94. package/src/modules/doc/container/__benchmarks__/container.benchmark.js +0 -43
  95. package/src/modules/doc/container/__mocks__/mockAvailableLanguages.js +0 -8
  96. package/src/modules/doc/container/__mocks__/mockAvailableVersions.js +0 -122
  97. package/src/modules/doc/container/__mocks__/mockContentFetchResponse.json +0 -5
  98. package/src/modules/doc/container/__mocks__/mockDocContent.js +0 -29
  99. package/src/modules/doc/container/__mocks__/mockNavigationFetchResponse.json +0 -4061
  100. package/src/modules/doc/container/__mocks__/mockPageReference.js +0 -8
  101. package/src/modules/doc/container/__mocks__/mockPdfUrl.js +0 -1
  102. package/src/modules/doc/container/__mocks__/mockSelectedLanguage.js +0 -8
  103. package/src/modules/doc/container/__mocks__/mockSelectedVersion.js +0 -8
  104. package/src/modules/doc/container/__mocks__/mockToc.js +0 -146
  105. package/src/modules/doc/container/__tests__/container.test.ts +0 -82
  106. package/src/modules/doc/container/container.css +0 -34
  107. package/src/modules/doc/container/container.html +0 -23
  108. package/src/modules/doc/container/container.stories.ts +0 -18
  109. package/src/modules/doc/container/container.ts +0 -360
  110. package/src/modules/doc/content/__tests__/content.test.ts +0 -30
  111. package/src/modules/doc/content/__tests__/mockDocContent.ts +0 -29
  112. package/src/modules/doc/content/__tests__/mockPageReference.ts +0 -8
  113. package/src/modules/doc/contentCallout/__tests__/contentCallout.test.ts +0 -80
  114. package/src/modules/doc/contentCallout/__tests__/mockProps.ts +0 -14
  115. package/src/modules/doc/contentCallout/contentCallout.stories.ts +0 -29
  116. package/src/modules/doc/nav/__tests__/mockAvailableLanguages.ts +0 -8
  117. package/src/modules/doc/nav/__tests__/mockAvailableVersions.ts +0 -122
  118. package/src/modules/doc/nav/__tests__/mockPageReference.ts +0 -8
  119. package/src/modules/doc/nav/__tests__/mockPdfUrl.ts +0 -1
  120. package/src/modules/doc/nav/__tests__/mockSelectedLanguage.ts +0 -8
  121. package/src/modules/doc/nav/__tests__/mockSelectedVersion.ts +0 -8
  122. package/src/modules/doc/nav/__tests__/mockToc.ts +0 -146
  123. package/src/modules/doc/nav/__tests__/nav.test.ts +0 -66
  124. package/src/modules/doc/search/__tests__/search.test.ts +0 -20
  125. package/src/modules/doc/search/search.html +0 -1
  126. package/src/modules/doc/search/search.ts +0 -3
  127. package/src/modules/doc/toc/__tests__/mockPageReference.ts +0 -8
  128. package/src/modules/doc/toc/__tests__/mockToc.ts +0 -146
  129. package/src/modules/doc/toc/__tests__/toc.test.ts +0 -29
  130. package/src/modules/doc/toolbar/__tests__/mockAvailableLanguages.ts +0 -8
  131. package/src/modules/doc/toolbar/__tests__/mockAvailableVersions.ts +0 -122
  132. package/src/modules/doc/toolbar/__tests__/mockPdfUrl.ts +0 -1
  133. package/src/modules/doc/toolbar/__tests__/mockSelectedLanguage.ts +0 -8
  134. package/src/modules/doc/toolbar/__tests__/mockSelectedVersion.ts +0 -8
  135. package/src/modules/doc/toolbar/__tests__/toolbar.test.ts +0 -44
@@ -1,19 +1,393 @@
1
- @import "helpers/code";
2
- @import "helpers/text";
3
- @import "helpers/reset";
1
+ /* stylelint-disable selector-class-pattern */
2
+
3
+ /* This css file contains rules for the content html and it's specific selectors,
4
+ * pattern validation cannot be applied
5
+ */
6
+
7
+ @import "dxHelpers/text";
8
+ @import "dxHelpers/reset";
9
+ @import "dxHelpers/table";
10
+ @import "docHelpers/imgStyle";
4
11
 
5
12
  .doc-content {
6
13
  width: 100%;
7
14
  }
8
15
 
9
- .helpHead1 {
10
- font-size: 1.5rem;
16
+ .container {
17
+ font-family: var(--dx-g-font-sans);
18
+ }
19
+
20
+ .doc-content-callout {
21
+ padding-top: var(--dx-g-spacing-sm);
22
+ }
23
+
24
+ .sectiontitle {
25
+ margin-top: 36px;
26
+ margin-bottom: var(--dx-g-spacing-md);
27
+ }
28
+
29
+ .codeSection {
30
+ margin-top: var(--dx-g-spacing-md);
31
+ margin-bottom: var(--dx-g-spacing-md);
32
+ }
33
+
34
+ .relinfo {
35
+ padding-top: var(--dx-g-spacing-sm);
36
+ padding-bottom: var(--dx-g-spacing-sm);
37
+ }
38
+
39
+ .pagination {
40
+ padding-top: var(--dx-g-spacing-sm);
41
+ padding-bottom: var(--dx-g-spacing-sm);
42
+ }
43
+
44
+ .image-block .content-image {
45
+ margin-top: var(--dx-g-spacing-lg);
46
+ margin-bottom: var(--dx-g-spacing-sm);
47
+ display: block;
48
+ }
49
+
50
+ td > img.content-image:first-child:last-child[alt="Yes"],
51
+ td > img.content-image:first-child:last-child[alt="No"] {
52
+ width: var(--dx-g-spacing-md);
53
+ }
54
+
55
+ h1,
56
+ h2,
57
+ h3,
58
+ h4,
59
+ h5,
60
+ h6 {
61
+ color: var(--dx-g-blue-vibrant-20);
62
+ font-family: var(--dx-g-font-display);
63
+ font-weight: var(--dx-g-font-demi);
64
+ }
65
+
66
+ h1 {
67
+ font-size: var(--dx-g-text-3xl);
68
+ letter-spacing: -0.8px;
69
+ line-height: var(--dx-g-spacing-3xl);
70
+ margin: var(--dx-g-spacing-2xl) 0 var(--dx-g-spacing-md) 0;
71
+ }
72
+
73
+ h2 {
74
+ font-size: var(--dx-g-text-2xl);
75
+ letter-spacing: -0.4px;
76
+ line-height: var(--dx-g-spacing-2xl);
77
+ margin: var(--dx-g-spacing-2xl) 0 var(--dx-g-spacing-md) 0;
78
+ }
79
+
80
+ h3 {
81
+ font-size: var(--dx-g-text-xl);
82
+ letter-spacing: -0.4px;
83
+ line-height: var(--dx-g-spacing-xl);
84
+ margin: var(--dx-g-spacing-xl) 0 var(--dx-g-spacing-md) 0;
85
+ }
86
+
87
+ h4 {
88
+ font-size: var(--dx-g-text-base);
89
+ letter-spacing: -0.5px;
90
+ line-height: var(--dx-g-spacing-lg);
91
+ margin: var(--dx-g-spacing-lg) 0 var(--dx-g-spacing-sm) 0;
92
+ }
93
+
94
+ h5 {
95
+ font-size: var(--dx-g-text-sm);
96
+ letter-spacing: -0.3px;
97
+ line-height: var(--dx-g-spacing-mlg);
98
+ margin: var(--dx-g-spacing-md) 0 var(--dx-g-spacing-sm) 0;
99
+ }
100
+
101
+ h6 {
102
+ font-size: var(--dx-g-text-xs);
103
+ letter-spacing: -0.3px;
104
+ line-height: var(--dx-g-spacing-md);
105
+ margin: var(--dx-g-spacing-sm) 0 var(--dx-g-spacing-sm) 0;
106
+ }
107
+
108
+ img {
109
+ image-rendering: optimize-contrast;
110
+ }
111
+
112
+ p,
113
+ .p {
114
+ font-family: var(--dx-g-font-sans);
115
+ font-size: var(--dx-g-text-base);
116
+ color: var(--dx-g-gray-10);
117
+ letter-spacing: 0;
118
+ line-height: var(--dx-g-spacing-lg);
119
+ margin-top: var(--dx-g-spacing-md);
120
+ margin-bottom: var(--dx-g-spacing-md);
121
+ }
122
+
123
+ dd > p,
124
+ dd > .p {
125
+ margin-top: 0;
126
+ margin-bottom: 0;
127
+ }
128
+
129
+ .li {
130
+ font-family: var(--dx-g-font-sans);
131
+ font-size: var(--dx-g-text-base);
132
+ color: var(--dx-g-gray-10);
133
+ letter-spacing: 0;
134
+ line-height: var(--dx-g-spacing-lg);
135
+ }
136
+
137
+ .dx-text-body-3 {
138
+ font-family: var(--dx-g-font-sans);
139
+ font-size: var(--dx-g-text-sm);
140
+ color: var(--dx-g-gray-10);
141
+ letter-spacing: 0;
142
+ line-height: var(--dx-g-spacing-mlg);
143
+ }
144
+
145
+ a,
146
+ .link a {
147
+ font-family: var(--dx-g-font-sans);
148
+ box-sizing: border-box;
149
+ border-width: 0;
150
+ border-style: solid;
151
+ border-color: #e2e8f0;
152
+ font-size: var(--dx-g-text-md);
153
+ color: var(--dx-g-blue-vibrant-50);
11
154
  }
12
155
 
13
156
  .shortdesc {
14
- font-style: italic;
157
+ font-family: var(--dx-g-font-sans);
158
+ font-size: var(--dx-g-text-base);
159
+ color: var(--dx-g-gray-10);
160
+ letter-spacing: 0;
161
+ line-height: var(--dx-g-spacing-lg);
162
+ margin-bottom: var(--dx-g-spacing-md);
163
+ margin-top: var(--dx-g-spacing-md);
164
+ }
165
+
166
+ .ullinks {
167
+ list-style-type: disc;
168
+ }
169
+
170
+ .related-links .ullinks {
171
+ margin-left: var(--dx-g-spacing-lg);
172
+ margin-right: var(--dx-g-spacing-lg);
173
+ }
174
+
175
+ .olchildlinks {
176
+ list-style-type: disc;
177
+ }
178
+
179
+ .related-links .olchildlinks {
180
+ margin-left: var(--dx-g-spacing-lg);
181
+ margin-right: var(--dx-g-spacing-lg);
182
+ }
183
+
184
+ .codeph,
185
+ .filepath {
186
+ font-family: var(--dx-g-font-mono);
187
+ font-size: var(--dx-g-text-sm);
188
+ line-height: var(--dx-g-text-lg);
189
+ letter-spacing: 0;
190
+ color: #181818;
191
+ background-color: var(--dx-g-gray-95);
192
+ border-radius: 4px;
193
+ padding: var(--dx-g-spacing-2xs);
194
+ }
195
+
196
+ a .codeph {
197
+ color: var(--dx-g-blue-vibrant-50);
198
+ }
199
+
200
+ .ulchildlink {
201
+ font-family: var(--dx-g-font-sans);
202
+ }
203
+
204
+ .olchildlink {
205
+ font-family: var(--dx-g-font-sans);
206
+ padding-top: var(--dx-g-spacing-sm);
207
+ padding-bottom: var(--dx-g-spacing-sm);
208
+ }
209
+
210
+ .editionTable {
211
+ font-family: var(--dx-g-font-sans);
212
+ font-size: var(--dx-g-text-sm);
213
+ color: var(--dx-g-gray-10);
214
+ letter-spacing: 0;
215
+ line-height: var(--dx-g-spacing-lg);
216
+ padding-top: var(--dx-g-spacing-sm);
217
+ padding-bottom: var(--dx-g-spacing-sm);
218
+ }
219
+
220
+ .editionTable a {
221
+ box-sizing: border-box;
222
+ border-width: 0;
223
+ border-style: solid;
224
+ border-color: #e2e8f0;
225
+ color: var(--dx-g-blue-vibrant-50);
15
226
  }
16
227
 
17
- p {
18
- font-size: 15px;
228
+ .detaillist {
229
+ font-family: var(--dx-g-font-sans);
230
+ }
231
+
232
+ dt {
233
+ font-family: var(--dx-g-font-display);
234
+ font-size: var(--dx-g-text-base);
235
+ color: var(--dx-g-blue-vibrant-20);
236
+ letter-spacing: 0;
237
+ line-height: var(--dx-g-spacing-mlg);
238
+ padding-top: var(--dx-g-spacing-sm);
239
+ padding-bottom: var(--dx-g-spacing-sm);
240
+ }
241
+
242
+ dd {
243
+ font-family: var(--dx-g-font-sans);
244
+ font-size: var(--dx-g-text-base);
245
+ color: var(--dx-g-gray-10);
246
+ letter-spacing: 0;
247
+ line-height: var(--dx-g-spacing-lg);
248
+ margin-left: var(--dx-g-spacing-smd);
249
+ margin-bottom: var(--dx-g-spacing-md);
250
+ }
251
+
252
+ li {
253
+ margin: var(--dx-g-spacing-sm) 0 var(--dx-g-spacing-sm)
254
+ var(--dx-g-spacing-lg);
255
+ }
256
+
257
+ li table {
258
+ margin-bottom: var(--dx-g-spacing-lg);
259
+ }
260
+
261
+ li > li {
262
+ margin-left: var(--dx-g-spacing-2xl);
263
+ }
264
+
265
+ .pagination > li {
266
+ display: inline-block;
267
+ }
268
+
269
+ a:hover,
270
+ .link a:hover {
271
+ text-decoration: underline;
272
+ }
273
+
274
+ ul,
275
+ ol {
276
+ margin-left: var(--dx-g-spacing-lg);
277
+ margin-bottom: var(--dx-g-spacing-md);
278
+ }
279
+
280
+ ul {
281
+ list-style-type: disc;
282
+ }
283
+
284
+ ol {
285
+ list-style-type: decimal;
286
+ }
287
+
288
+ doc-content-callout ul,
289
+ doc-content-callout ol {
290
+ margin-top: var(--dx-g-spacing-md);
291
+ }
292
+
293
+ ol ol {
294
+ list-style-type: lower-alpha;
295
+ }
296
+
297
+ ol ol,
298
+ ol ul,
299
+ ul ol {
300
+ margin-bottom: 0;
301
+ margin-left: var(--dx-g-spacing-md);
302
+ }
303
+
304
+ ol ol ol {
305
+ list-style-type: lower-roman;
306
+ }
307
+
308
+ ol ol ol ol {
309
+ list-style-type: decimal;
310
+ }
311
+
312
+ ol ol ol ol ol {
313
+ list-style-type: lower-alpha;
314
+ }
315
+
316
+ ol ol ol ol ol ol {
317
+ list-style-type: lower-roman;
318
+ }
319
+
320
+ ul ul {
321
+ list-style-type: circle;
322
+ margin-bottom: 0;
323
+ margin-left: var(--dx-g-spacing-md);
324
+ }
325
+
326
+ ul ul ul {
327
+ list-style-type: square;
328
+ }
329
+
330
+ ul ul ul ul {
331
+ list-style-type: disc;
332
+ }
333
+
334
+ ul ul ul ul ul {
335
+ list-style-type: circle;
336
+ }
337
+
338
+ ul ul ul ul ul ul {
339
+ list-style-type: square;
340
+ }
341
+
342
+ .box {
343
+ margin: var(--dx-g-spacing-lg) 0;
344
+ }
345
+
346
+ figure,
347
+ .fig {
348
+ margin: var(--dx-g-spacing-lg) 0;
349
+ text-align: left;
350
+ display: flex;
351
+ flex-direction: column;
352
+ align-items: left;
353
+ justify-content: left;
354
+ }
355
+
356
+ figcaption,
357
+ .figcap {
358
+ display: block;
359
+ font-size: var(--dx-g-text-xs);
360
+ margin: var(--dx-g-spacing-sm) 0;
361
+ order: 2;
362
+ }
363
+
364
+ .figcap .image {
365
+ order: 1;
366
+ }
367
+
368
+ .fig.fig-centered {
369
+ text-align: center;
370
+ }
371
+
372
+ code,
373
+ kbd,
374
+ pre,
375
+ samp,
376
+ .parmname {
377
+ font-family: Menlo, monospace;
378
+ font-size: 1em;
379
+ }
380
+
381
+ mark {
382
+ background-color: var(--dx-g-yellow-vibrant-90);
383
+ }
384
+
385
+ /* offset page jump link due to fixed header */
386
+ [id] {
387
+ --dx-c-content-scroll-margin-top: calc(
388
+ var(--dx-g-global-header-height) + var(--dx-g-doc-header-height) +
389
+ var(--dx-g-spacing-2xl)
390
+ );
391
+
392
+ scroll-margin-top: var(--dx-c-content-scroll-margin-top);
19
393
  }
@@ -1,6 +1,7 @@
1
1
  <template>
2
+ <dx-redirect-checker></dx-redirect-checker>
2
3
  <template if:true={docsData}>
3
- <div data-name="content" lwc:dom="manual"></div>
4
+ <div class="container" data-name="content" lwc:dom="manual"></div>
4
5
  </template>
5
- <template if:false={docsData}> No content provided </template>
6
+ <template if:false={docsData}>No content provided</template>
6
7
  </template>