@vendure-io/docs-provider 0.9.0 → 0.10.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.
Files changed (31) hide show
  1. package/dist/browser.cjs +1 -1
  2. package/dist/browser.js +1 -1
  3. package/dist/{frontmatter-QFErVd9b.cjs → frontmatter-DJJguSGP.cjs} +1 -1
  4. package/dist/{frontmatter-B5d9WZzh.js → frontmatter-Dd7D5fcG.js} +1 -1
  5. package/dist/index.cjs +1 -1
  6. package/dist/index.js +3 -3
  7. package/dist/loader.cjs +1 -1
  8. package/dist/loader.js +2 -2
  9. package/dist/manifest-BTgLk3DA.cjs +1 -0
  10. package/dist/{manifest-DlSWyjsA.js → manifest-DGVvC75a.js} +13 -11
  11. package/dist/schema.d.ts +75 -391
  12. package/dist/schema.d.ts.map +1 -1
  13. package/dist/testing/index.d.ts +4 -1
  14. package/dist/testing/index.d.ts.map +1 -1
  15. package/dist/testing/run-all-tests.d.ts +56 -0
  16. package/dist/testing/run-all-tests.d.ts.map +1 -0
  17. package/dist/testing/types.d.ts +161 -0
  18. package/dist/testing/types.d.ts.map +1 -1
  19. package/dist/testing/validate-admonitions.d.ts.map +1 -1
  20. package/dist/testing/validate-code-languages.d.ts +86 -0
  21. package/dist/testing/validate-code-languages.d.ts.map +1 -0
  22. package/dist/testing/validate-frontmatter.d.ts +40 -0
  23. package/dist/testing/validate-frontmatter.d.ts.map +1 -0
  24. package/dist/testing.cjs +13 -6
  25. package/dist/testing.js +775 -143
  26. package/dist/types.d.ts +4 -0
  27. package/dist/types.d.ts.map +1 -1
  28. package/docs/frontmatter-reference.md +46 -2
  29. package/docs/mdx-testing.md +553 -140
  30. package/package.json +2 -2
  31. package/dist/manifest-BkO3d77g.cjs +0 -1
package/dist/schema.d.ts CHANGED
@@ -2,20 +2,23 @@ import { z } from 'zod';
2
2
  /**
3
3
  * Schema for supported Vendure versions
4
4
  */
5
- export declare const VendureVersionSchema: z.ZodEnum<["v1", "v2", "v3"]>;
5
+ export declare const VendureVersionSchema: z.ZodEnum<{
6
+ v1: "v1";
7
+ v2: "v2";
8
+ v3: "v3";
9
+ }>;
6
10
  /**
7
11
  * Schema for search configuration
8
12
  */
9
13
  export declare const SearchConfigSchema: z.ZodObject<{
10
- indexFields: z.ZodArray<z.ZodEnum<["title", "description", "content", "keywords"]>, "many">;
14
+ indexFields: z.ZodArray<z.ZodEnum<{
15
+ title: "title";
16
+ description: "description";
17
+ content: "content";
18
+ keywords: "keywords";
19
+ }>>;
11
20
  boosts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
12
- }, "strip", z.ZodTypeAny, {
13
- indexFields: ("title" | "description" | "content" | "keywords")[];
14
- boosts?: Record<string, number> | undefined;
15
- }, {
16
- indexFields: ("title" | "description" | "content" | "keywords")[];
17
- boosts?: Record<string, number> | undefined;
18
- }>;
21
+ }, z.core.$strip>;
19
22
  /**
20
23
  * Schema for GitHub repository configuration
21
24
  */
@@ -23,15 +26,7 @@ export declare const GitHubConfigSchema: z.ZodObject<{
23
26
  repository: z.ZodString;
24
27
  branch: z.ZodOptional<z.ZodString>;
25
28
  docsPath: z.ZodOptional<z.ZodString>;
26
- }, "strip", z.ZodTypeAny, {
27
- repository: string;
28
- branch?: string | undefined;
29
- docsPath?: string | undefined;
30
- }, {
31
- repository: string;
32
- branch?: string | undefined;
33
- docsPath?: string | undefined;
34
- }>;
29
+ }, z.core.$strip>;
35
30
  /**
36
31
  * Schema for navigation nodes (recursive)
37
32
  */
@@ -51,7 +46,11 @@ export declare const DocsPackageManifestSchema: z.ZodObject<{
51
46
  id: z.ZodString;
52
47
  name: z.ZodString;
53
48
  version: z.ZodString;
54
- vendureVersion: z.ZodEnum<["v1", "v2", "v3"]>;
49
+ vendureVersion: z.ZodEnum<{
50
+ v1: "v1";
51
+ v2: "v2";
52
+ v3: "v3";
53
+ }>;
55
54
  navigation: z.ZodArray<z.ZodType<{
56
55
  title: string;
57
56
  slug: string;
@@ -60,7 +59,7 @@ export declare const DocsPackageManifestSchema: z.ZodObject<{
60
59
  badge?: string;
61
60
  hidden?: boolean;
62
61
  lastModified?: string;
63
- }, z.ZodTypeDef, {
62
+ }, unknown, z.core.$ZodTypeInternals<{
64
63
  title: string;
65
64
  slug: string;
66
65
  file?: string;
@@ -68,164 +67,55 @@ export declare const DocsPackageManifestSchema: z.ZodObject<{
68
67
  badge?: string;
69
68
  hidden?: boolean;
70
69
  lastModified?: string;
71
- }>, "many">;
70
+ }, unknown>>>;
72
71
  search: z.ZodOptional<z.ZodObject<{
73
- indexFields: z.ZodArray<z.ZodEnum<["title", "description", "content", "keywords"]>, "many">;
72
+ indexFields: z.ZodArray<z.ZodEnum<{
73
+ title: "title";
74
+ description: "description";
75
+ content: "content";
76
+ keywords: "keywords";
77
+ }>>;
74
78
  boosts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
75
- }, "strip", z.ZodTypeAny, {
76
- indexFields: ("title" | "description" | "content" | "keywords")[];
77
- boosts?: Record<string, number> | undefined;
78
- }, {
79
- indexFields: ("title" | "description" | "content" | "keywords")[];
80
- boosts?: Record<string, number> | undefined;
81
- }>>;
79
+ }, z.core.$strip>>;
82
80
  github: z.ZodOptional<z.ZodObject<{
83
81
  repository: z.ZodString;
84
82
  branch: z.ZodOptional<z.ZodString>;
85
83
  docsPath: z.ZodOptional<z.ZodString>;
86
- }, "strip", z.ZodTypeAny, {
87
- repository: string;
88
- branch?: string | undefined;
89
- docsPath?: string | undefined;
90
- }, {
91
- repository: string;
92
- branch?: string | undefined;
93
- docsPath?: string | undefined;
94
- }>>;
84
+ }, z.core.$strip>>;
95
85
  basePath: z.ZodOptional<z.ZodString>;
96
- }, "strip", z.ZodTypeAny, {
97
- id: string;
98
- name: string;
99
- version: string;
100
- vendureVersion: "v1" | "v2" | "v3";
101
- navigation: {
102
- title: string;
103
- slug: string;
104
- file?: string;
105
- children?: unknown[];
106
- badge?: string;
107
- hidden?: boolean;
108
- lastModified?: string;
109
- }[];
110
- search?: {
111
- indexFields: ("title" | "description" | "content" | "keywords")[];
112
- boosts?: Record<string, number> | undefined;
113
- } | undefined;
114
- github?: {
115
- repository: string;
116
- branch?: string | undefined;
117
- docsPath?: string | undefined;
118
- } | undefined;
119
- basePath?: string | undefined;
120
- }, {
121
- id: string;
122
- name: string;
123
- version: string;
124
- vendureVersion: "v1" | "v2" | "v3";
125
- navigation: {
126
- title: string;
127
- slug: string;
128
- file?: string;
129
- children?: unknown[];
130
- badge?: string;
131
- hidden?: boolean;
132
- lastModified?: string;
133
- }[];
134
- search?: {
135
- indexFields: ("title" | "description" | "content" | "keywords")[];
136
- boosts?: Record<string, number> | undefined;
137
- } | undefined;
138
- github?: {
139
- repository: string;
140
- branch?: string | undefined;
141
- docsPath?: string | undefined;
142
- } | undefined;
143
- basePath?: string | undefined;
144
- }>;
86
+ }, z.core.$strip>;
145
87
  /**
146
88
  * Schema for documentation page frontmatter/metadata
147
89
  */
148
90
  export declare const DocPageMetaSchema: z.ZodObject<{
149
91
  title: z.ZodString;
92
+ metaTitle: z.ZodOptional<z.ZodString>;
93
+ metaDescription: z.ZodOptional<z.ZodString>;
150
94
  description: z.ZodOptional<z.ZodString>;
151
- keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
95
+ keywords: z.ZodOptional<z.ZodArray<z.ZodString>>;
152
96
  sidebarLabel: z.ZodOptional<z.ZodString>;
153
97
  hidden: z.ZodOptional<z.ZodBoolean>;
154
98
  order: z.ZodOptional<z.ZodNumber>;
155
99
  lastModified: z.ZodOptional<z.ZodString>;
156
- }, "strip", z.ZodTypeAny, {
157
- title: string;
158
- description?: string | undefined;
159
- keywords?: string[] | undefined;
160
- hidden?: boolean | undefined;
161
- lastModified?: string | undefined;
162
- sidebarLabel?: string | undefined;
163
- order?: number | undefined;
164
- }, {
165
- title: string;
166
- description?: string | undefined;
167
- keywords?: string[] | undefined;
168
- hidden?: boolean | undefined;
169
- lastModified?: string | undefined;
170
- sidebarLabel?: string | undefined;
171
- order?: number | undefined;
172
- }>;
100
+ }, z.core.$strip>;
173
101
  /**
174
102
  * Schema for a loaded documentation page
175
103
  */
176
104
  export declare const DocPageSchema: z.ZodObject<{
177
105
  meta: z.ZodObject<{
178
106
  title: z.ZodString;
107
+ metaTitle: z.ZodOptional<z.ZodString>;
108
+ metaDescription: z.ZodOptional<z.ZodString>;
179
109
  description: z.ZodOptional<z.ZodString>;
180
- keywords: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
110
+ keywords: z.ZodOptional<z.ZodArray<z.ZodString>>;
181
111
  sidebarLabel: z.ZodOptional<z.ZodString>;
182
112
  hidden: z.ZodOptional<z.ZodBoolean>;
183
113
  order: z.ZodOptional<z.ZodNumber>;
184
114
  lastModified: z.ZodOptional<z.ZodString>;
185
- }, "strip", z.ZodTypeAny, {
186
- title: string;
187
- description?: string | undefined;
188
- keywords?: string[] | undefined;
189
- hidden?: boolean | undefined;
190
- lastModified?: string | undefined;
191
- sidebarLabel?: string | undefined;
192
- order?: number | undefined;
193
- }, {
194
- title: string;
195
- description?: string | undefined;
196
- keywords?: string[] | undefined;
197
- hidden?: boolean | undefined;
198
- lastModified?: string | undefined;
199
- sidebarLabel?: string | undefined;
200
- order?: number | undefined;
201
- }>;
115
+ }, z.core.$strip>;
202
116
  content: z.ZodString;
203
117
  filePath: z.ZodString;
204
- }, "strip", z.ZodTypeAny, {
205
- content: string;
206
- meta: {
207
- title: string;
208
- description?: string | undefined;
209
- keywords?: string[] | undefined;
210
- hidden?: boolean | undefined;
211
- lastModified?: string | undefined;
212
- sidebarLabel?: string | undefined;
213
- order?: number | undefined;
214
- };
215
- filePath: string;
216
- }, {
217
- content: string;
218
- meta: {
219
- title: string;
220
- description?: string | undefined;
221
- keywords?: string[] | undefined;
222
- hidden?: boolean | undefined;
223
- lastModified?: string | undefined;
224
- sidebarLabel?: string | undefined;
225
- order?: number | undefined;
226
- };
227
- filePath: string;
228
- }>;
118
+ }, z.core.$strip>;
229
119
  /**
230
120
  * Schema for loaded docs package result
231
121
  */
@@ -234,7 +124,11 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
234
124
  id: z.ZodString;
235
125
  name: z.ZodString;
236
126
  version: z.ZodString;
237
- vendureVersion: z.ZodEnum<["v1", "v2", "v3"]>;
127
+ vendureVersion: z.ZodEnum<{
128
+ v1: "v1";
129
+ v2: "v2";
130
+ v3: "v3";
131
+ }>;
238
132
  navigation: z.ZodArray<z.ZodType<{
239
133
  title: string;
240
134
  slug: string;
@@ -243,7 +137,7 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
243
137
  badge?: string;
244
138
  hidden?: boolean;
245
139
  lastModified?: string;
246
- }, z.ZodTypeDef, {
140
+ }, unknown, z.core.$ZodTypeInternals<{
247
141
  title: string;
248
142
  slug: string;
249
143
  file?: string;
@@ -251,136 +145,25 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
251
145
  badge?: string;
252
146
  hidden?: boolean;
253
147
  lastModified?: string;
254
- }>, "many">;
148
+ }, unknown>>>;
255
149
  search: z.ZodOptional<z.ZodObject<{
256
- indexFields: z.ZodArray<z.ZodEnum<["title", "description", "content", "keywords"]>, "many">;
150
+ indexFields: z.ZodArray<z.ZodEnum<{
151
+ title: "title";
152
+ description: "description";
153
+ content: "content";
154
+ keywords: "keywords";
155
+ }>>;
257
156
  boosts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
258
- }, "strip", z.ZodTypeAny, {
259
- indexFields: ("title" | "description" | "content" | "keywords")[];
260
- boosts?: Record<string, number> | undefined;
261
- }, {
262
- indexFields: ("title" | "description" | "content" | "keywords")[];
263
- boosts?: Record<string, number> | undefined;
264
- }>>;
157
+ }, z.core.$strip>>;
265
158
  github: z.ZodOptional<z.ZodObject<{
266
159
  repository: z.ZodString;
267
160
  branch: z.ZodOptional<z.ZodString>;
268
161
  docsPath: z.ZodOptional<z.ZodString>;
269
- }, "strip", z.ZodTypeAny, {
270
- repository: string;
271
- branch?: string | undefined;
272
- docsPath?: string | undefined;
273
- }, {
274
- repository: string;
275
- branch?: string | undefined;
276
- docsPath?: string | undefined;
277
- }>>;
162
+ }, z.core.$strip>>;
278
163
  basePath: z.ZodOptional<z.ZodString>;
279
- }, "strip", z.ZodTypeAny, {
280
- id: string;
281
- name: string;
282
- version: string;
283
- vendureVersion: "v1" | "v2" | "v3";
284
- navigation: {
285
- title: string;
286
- slug: string;
287
- file?: string;
288
- children?: unknown[];
289
- badge?: string;
290
- hidden?: boolean;
291
- lastModified?: string;
292
- }[];
293
- search?: {
294
- indexFields: ("title" | "description" | "content" | "keywords")[];
295
- boosts?: Record<string, number> | undefined;
296
- } | undefined;
297
- github?: {
298
- repository: string;
299
- branch?: string | undefined;
300
- docsPath?: string | undefined;
301
- } | undefined;
302
- basePath?: string | undefined;
303
- }, {
304
- id: string;
305
- name: string;
306
- version: string;
307
- vendureVersion: "v1" | "v2" | "v3";
308
- navigation: {
309
- title: string;
310
- slug: string;
311
- file?: string;
312
- children?: unknown[];
313
- badge?: string;
314
- hidden?: boolean;
315
- lastModified?: string;
316
- }[];
317
- search?: {
318
- indexFields: ("title" | "description" | "content" | "keywords")[];
319
- boosts?: Record<string, number> | undefined;
320
- } | undefined;
321
- github?: {
322
- repository: string;
323
- branch?: string | undefined;
324
- docsPath?: string | undefined;
325
- } | undefined;
326
- basePath?: string | undefined;
327
- }>;
164
+ }, z.core.$strip>;
328
165
  basePath: z.ZodString;
329
- }, "strip", z.ZodTypeAny, {
330
- basePath: string;
331
- manifest: {
332
- id: string;
333
- name: string;
334
- version: string;
335
- vendureVersion: "v1" | "v2" | "v3";
336
- navigation: {
337
- title: string;
338
- slug: string;
339
- file?: string;
340
- children?: unknown[];
341
- badge?: string;
342
- hidden?: boolean;
343
- lastModified?: string;
344
- }[];
345
- search?: {
346
- indexFields: ("title" | "description" | "content" | "keywords")[];
347
- boosts?: Record<string, number> | undefined;
348
- } | undefined;
349
- github?: {
350
- repository: string;
351
- branch?: string | undefined;
352
- docsPath?: string | undefined;
353
- } | undefined;
354
- basePath?: string | undefined;
355
- };
356
- }, {
357
- basePath: string;
358
- manifest: {
359
- id: string;
360
- name: string;
361
- version: string;
362
- vendureVersion: "v1" | "v2" | "v3";
363
- navigation: {
364
- title: string;
365
- slug: string;
366
- file?: string;
367
- children?: unknown[];
368
- badge?: string;
369
- hidden?: boolean;
370
- lastModified?: string;
371
- }[];
372
- search?: {
373
- indexFields: ("title" | "description" | "content" | "keywords")[];
374
- boosts?: Record<string, number> | undefined;
375
- } | undefined;
376
- github?: {
377
- repository: string;
378
- branch?: string | undefined;
379
- docsPath?: string | undefined;
380
- } | undefined;
381
- basePath?: string | undefined;
382
- };
383
- }>;
166
+ }, z.core.$strip>;
384
167
  /**
385
168
  * Schema for breadcrumb items
386
169
  */
@@ -388,15 +171,7 @@ export declare const BreadcrumbItemSchema: z.ZodObject<{
388
171
  title: z.ZodString;
389
172
  slug: z.ZodString;
390
173
  path: z.ZodString;
391
- }, "strip", z.ZodTypeAny, {
392
- title: string;
393
- path: string;
394
- slug: string;
395
- }, {
396
- title: string;
397
- path: string;
398
- slug: string;
399
- }>;
174
+ }, z.core.$strip>;
400
175
  /**
401
176
  * Schema for flattened navigation nodes
402
177
  */
@@ -412,7 +187,7 @@ export declare const FlatNavigationNodeSchema: z.ZodObject<{
412
187
  badge?: string;
413
188
  hidden?: boolean;
414
189
  lastModified?: string;
415
- }, z.ZodTypeDef, {
190
+ }, unknown, z.core.$ZodTypeInternals<{
416
191
  title: string;
417
192
  slug: string;
418
193
  file?: string;
@@ -420,52 +195,14 @@ export declare const FlatNavigationNodeSchema: z.ZodObject<{
420
195
  badge?: string;
421
196
  hidden?: boolean;
422
197
  lastModified?: string;
423
- }>>, "many">>;
198
+ }, unknown>>>>>;
424
199
  badge: z.ZodOptional<z.ZodString>;
425
200
  hidden: z.ZodOptional<z.ZodBoolean>;
426
201
  lastModified: z.ZodOptional<z.ZodString>;
427
202
  path: z.ZodString;
428
203
  depth: z.ZodNumber;
429
204
  parentPath: z.ZodOptional<z.ZodString>;
430
- }, "strip", z.ZodTypeAny, {
431
- title: string;
432
- path: string;
433
- slug: string;
434
- depth: number;
435
- file?: string | undefined;
436
- children?: {
437
- title: string;
438
- slug: string;
439
- file?: string;
440
- children?: unknown[];
441
- badge?: string;
442
- hidden?: boolean;
443
- lastModified?: string;
444
- }[] | undefined;
445
- badge?: string | undefined;
446
- hidden?: boolean | undefined;
447
- lastModified?: string | undefined;
448
- parentPath?: string | undefined;
449
- }, {
450
- title: string;
451
- path: string;
452
- slug: string;
453
- depth: number;
454
- file?: string | undefined;
455
- children?: {
456
- title: string;
457
- slug: string;
458
- file?: string;
459
- children?: unknown[];
460
- badge?: string;
461
- hidden?: boolean;
462
- lastModified?: string;
463
- }[] | undefined;
464
- badge?: string | undefined;
465
- hidden?: boolean | undefined;
466
- lastModified?: string | undefined;
467
- parentPath?: string | undefined;
468
- }>;
205
+ }, z.core.$strip>;
469
206
  /**
470
207
  * Schema for navigation node input (with optional title/slug)
471
208
  */
@@ -485,7 +222,11 @@ export declare const DocsPackageManifestInputSchema: z.ZodObject<{
485
222
  id: z.ZodString;
486
223
  name: z.ZodString;
487
224
  version: z.ZodString;
488
- vendureVersion: z.ZodEnum<["v1", "v2", "v3"]>;
225
+ vendureVersion: z.ZodEnum<{
226
+ v1: "v1";
227
+ v2: "v2";
228
+ v3: "v3";
229
+ }>;
489
230
  navigation: z.ZodArray<z.ZodType<{
490
231
  title?: string;
491
232
  slug?: string;
@@ -494,7 +235,7 @@ export declare const DocsPackageManifestInputSchema: z.ZodObject<{
494
235
  badge?: string;
495
236
  hidden?: boolean;
496
237
  lastModified?: string;
497
- }, z.ZodTypeDef, {
238
+ }, unknown, z.core.$ZodTypeInternals<{
498
239
  title?: string;
499
240
  slug?: string;
500
241
  file?: string;
@@ -502,80 +243,23 @@ export declare const DocsPackageManifestInputSchema: z.ZodObject<{
502
243
  badge?: string;
503
244
  hidden?: boolean;
504
245
  lastModified?: string;
505
- }>, "many">;
246
+ }, unknown>>>;
506
247
  search: z.ZodOptional<z.ZodObject<{
507
- indexFields: z.ZodArray<z.ZodEnum<["title", "description", "content", "keywords"]>, "many">;
248
+ indexFields: z.ZodArray<z.ZodEnum<{
249
+ title: "title";
250
+ description: "description";
251
+ content: "content";
252
+ keywords: "keywords";
253
+ }>>;
508
254
  boosts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
509
- }, "strip", z.ZodTypeAny, {
510
- indexFields: ("title" | "description" | "content" | "keywords")[];
511
- boosts?: Record<string, number> | undefined;
512
- }, {
513
- indexFields: ("title" | "description" | "content" | "keywords")[];
514
- boosts?: Record<string, number> | undefined;
515
- }>>;
255
+ }, z.core.$strip>>;
516
256
  github: z.ZodOptional<z.ZodObject<{
517
257
  repository: z.ZodString;
518
258
  branch: z.ZodOptional<z.ZodString>;
519
259
  docsPath: z.ZodOptional<z.ZodString>;
520
- }, "strip", z.ZodTypeAny, {
521
- repository: string;
522
- branch?: string | undefined;
523
- docsPath?: string | undefined;
524
- }, {
525
- repository: string;
526
- branch?: string | undefined;
527
- docsPath?: string | undefined;
528
- }>>;
260
+ }, z.core.$strip>>;
529
261
  basePath: z.ZodOptional<z.ZodString>;
530
- }, "strip", z.ZodTypeAny, {
531
- id: string;
532
- name: string;
533
- version: string;
534
- vendureVersion: "v1" | "v2" | "v3";
535
- navigation: {
536
- title?: string;
537
- slug?: string;
538
- file?: string;
539
- children?: unknown[];
540
- badge?: string;
541
- hidden?: boolean;
542
- lastModified?: string;
543
- }[];
544
- search?: {
545
- indexFields: ("title" | "description" | "content" | "keywords")[];
546
- boosts?: Record<string, number> | undefined;
547
- } | undefined;
548
- github?: {
549
- repository: string;
550
- branch?: string | undefined;
551
- docsPath?: string | undefined;
552
- } | undefined;
553
- basePath?: string | undefined;
554
- }, {
555
- id: string;
556
- name: string;
557
- version: string;
558
- vendureVersion: "v1" | "v2" | "v3";
559
- navigation: {
560
- title?: string;
561
- slug?: string;
562
- file?: string;
563
- children?: unknown[];
564
- badge?: string;
565
- hidden?: boolean;
566
- lastModified?: string;
567
- }[];
568
- search?: {
569
- indexFields: ("title" | "description" | "content" | "keywords")[];
570
- boosts?: Record<string, number> | undefined;
571
- } | undefined;
572
- github?: {
573
- repository: string;
574
- branch?: string | undefined;
575
- docsPath?: string | undefined;
576
- } | undefined;
577
- basePath?: string | undefined;
578
- }>;
262
+ }, z.core.$strip>;
579
263
  export type VendureVersionInferred = z.infer<typeof VendureVersionSchema>;
580
264
  export type SearchConfigInferred = z.infer<typeof SearchConfigSchema>;
581
265
  export type GitHubConfigInferred = z.infer<typeof GitHubConfigSchema>;
package/dist/schema.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;GAEG;AACH,eAAO,MAAM,oBAAoB,+BAA6B,CAAA;AAE9D;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;EAG7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAI7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAUA,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;eAtB7B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;eANd,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eANd,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;;;;;;;;;;;;;eANd,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;;;;;;;EAyBrB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;EAQ5B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIxB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;mBA1D3B,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;2BACD,MAAM;;mBANd,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;2BACD,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBANd,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;2BACD,MAAM;;;;;;;;;;;;;;;;;;mBANd,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;2BACD,MAAM;;;;;;;;;;;;;;;;;;;;;;mBANd,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;2BACD,MAAM;;;;;;;;;;;;;;;;;;;;;mBANd,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;2BACD,MAAM;;;;;;;;;;;;;EAuDrB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;EAI/B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;eA3E5B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;eANd,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;;;;;;;;;;eANd,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;;;;;;;;eANd,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;EAgFrB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAAC;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAUA,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,8BAA8B;;;;;;gBAtBjC,MAAM;eACP,MAAM;eACN,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;gBANb,MAAM;eACP,MAAM;eACN,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBANb,MAAM;eACP,MAAM;eACN,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;;;;;;;;;;;;;gBANb,MAAM;eACP,MAAM;eACN,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;;;;;;;EAyBrB,CAAA;AAGF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AACnF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AACnE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAC3D,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAC/E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AACjF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AACnF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA"}
1
+ {"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;EAA6B,CAAA;AAE9D;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;iBAG7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;iBAI7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAUA,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;eAtB7B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;eANd,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;;;;;;;;;;;;iBAyBrB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;iBAU5B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;iBAIxB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;mBA5D3B,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;2BACD,MAAM;;mBANd,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;qBACL,OAAO;2BACD,MAAM;;;;;;;;;;;;;;;;;;;iBAyDrB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;iBAI/B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;eA7E5B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;eANd,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;;;iBAkFrB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAAC;IAChD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB,CAUA,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;gBAtBjC,MAAM;eACP,MAAM;eACN,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;gBANb,MAAM;eACP,MAAM;eACN,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;iBACL,OAAO;uBACD,MAAM;;;;;;;;;;;;;;;;;iBAyBrB,CAAA;AAGF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AACnF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AACnE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAC3D,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAC/E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AACjF,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AACnF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAA"}
package/dist/testing/index.d.ts CHANGED
@@ -1,8 +1,11 @@
1
1
  import { MdxCompilationResult, MdxTestReport } from './types';
2
- export type { AdmonitionError, AdmonitionValidationReport, CompileMdxOptions, MdxCompilationResult, MdxTestReport, TestManifestOptions, ValidateAdmonitionsOptions, } from './types';
2
+ export type { AdmonitionError, AdmonitionValidationReport, CodeLanguageError, CodeLanguageValidationReport, CompileMdxOptions, FrontmatterError, FrontmatterValidationReport, MdxCompilationResult, MdxTestReport, TestManifestOptions, TestRunnerOptions, TestRunnerReport, ValidateAdmonitionsOptions, ValidateCodeLanguagesOptions, ValidateFrontmatterOptions, } from './types';
3
3
  export { compileMdx, getDefaultRehypePlugins, getDefaultRemarkPlugins } from './mdx-compiler';
4
+ export { formatTestRunnerReport, runAllTests } from './run-all-tests';
4
5
  export { testManifestMdx } from './test-manifest';
5
6
  export { ADMONITION_TYPES, formatAdmonitionReport, INVALID_ADMONITION_PATTERN, validateAdmonitions, } from './validate-admonitions';
7
+ export { formatCodeLanguageReport, getCanonicalLanguage, isValidCodeLanguage, LANGUAGE_ALIASES, SHIKI_BUNDLED_LANGUAGES, validateCodeLanguages, } from './validate-code-languages';
8
+ export { formatFrontmatterReport, validateFrontmatter } from './validate-frontmatter';
6
9
  /**
7
10
  * Format a test report for console output.
8
11
  *
package/dist/testing/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAGlE,YAAY,EACV,eAAe,EACf,0BAA0B,EAC1B,iBAAiB,EACjB,oBAAoB,EACpB,aAAa,EACb,mBAAmB,EACnB,0BAA0B,GAC3B,MAAM,SAAS,CAAA;AAGhB,OAAO,EAAE,UAAU,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,0BAA0B,EAC1B,mBAAmB,GACpB,MAAM,wBAAwB,CAAA;AAE/B;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,UAAQ,GAAG,MAAM,CAgE/E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,IAAI,CACxC,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,oBAAoB,KACzB,IAAI,CAcR"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAGlE,YAAY,EACV,eAAe,EACf,0BAA0B,EAC1B,iBAAiB,EACjB,4BAA4B,EAC5B,iBAAiB,EACjB,gBAAgB,EAChB,2BAA2B,EAC3B,oBAAoB,EACpB,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,gBAAgB,EAChB,0BAA0B,EAC1B,4BAA4B,EAC5B,0BAA0B,GAC3B,MAAM,SAAS,CAAA;AAGhB,OAAO,EAAE,UAAU,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAC7F,OAAO,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,0BAA0B,EAC1B,mBAAmB,GACpB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACL,wBAAwB,EACxB,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,uBAAuB,EACvB,qBAAqB,GACtB,MAAM,2BAA2B,CAAA;AAClC,OAAO,EAAE,uBAAuB,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAA;AAErF;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,UAAQ,GAAG,MAAM,CAgE/E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,sBAAsB,IAAI,CACxC,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,oBAAoB,KACzB,IAAI,CAcR"}