@redocly/config 0.38.0 → 0.40.0

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 (35) hide show
  1. package/lib/default-theme-config-schema.d.ts +315 -0
  2. package/lib/default-theme-config-schema.js +5 -0
  3. package/lib/entities-catalog-entity-file-schema.d.ts +87 -0
  4. package/lib/entities-catalog-entity-file-schema.js +9 -0
  5. package/lib/ex-theme-config-schemas.d.ts +11 -0
  6. package/lib/ex-theme-config-schemas.js +9 -1
  7. package/lib/graphql-config-schema.d.ts +52 -0
  8. package/lib/graphql-config-schema.js +31 -0
  9. package/lib/product-override-schema.d.ts +104 -0
  10. package/lib/root-config-schema.d.ts +2293 -34
  11. package/lib/root-config-schema.js +5 -1
  12. package/lib/types/api-functions-types.d.ts +49 -1
  13. package/lib/types/catalog-entity-types.d.ts +2 -0
  14. package/lib/types/config-types.d.ts +2 -1
  15. package/lib/types/portal-shared-types.d.ts +2 -1
  16. package/lib/types/scorecards-types.d.ts +3 -0
  17. package/lib/types/scorecards-types.js +3 -0
  18. package/lib-esm/default-theme-config-schema.d.ts +315 -0
  19. package/lib-esm/default-theme-config-schema.js +6 -1
  20. package/lib-esm/entities-catalog-entity-file-schema.d.ts +87 -0
  21. package/lib-esm/entities-catalog-entity-file-schema.js +9 -0
  22. package/lib-esm/ex-theme-config-schemas.d.ts +11 -0
  23. package/lib-esm/ex-theme-config-schemas.js +8 -0
  24. package/lib-esm/graphql-config-schema.d.ts +52 -0
  25. package/lib-esm/graphql-config-schema.js +31 -0
  26. package/lib-esm/product-override-schema.d.ts +104 -0
  27. package/lib-esm/root-config-schema.d.ts +2293 -34
  28. package/lib-esm/root-config-schema.js +6 -2
  29. package/lib-esm/types/api-functions-types.d.ts +49 -1
  30. package/lib-esm/types/catalog-entity-types.d.ts +2 -0
  31. package/lib-esm/types/config-types.d.ts +2 -1
  32. package/lib-esm/types/portal-shared-types.d.ts +2 -1
  33. package/lib-esm/types/scorecards-types.d.ts +3 -0
  34. package/lib-esm/types/scorecards-types.js +2 -0
  35. package/package.json +1 -1
@@ -171,11 +171,20 @@ export declare const entityRelationFileSchema: {
171
171
  readonly minLength: 2;
172
172
  readonly maxLength: 100;
173
173
  };
174
+ readonly version: {
175
+ readonly type: "string";
176
+ };
177
+ readonly revision: {
178
+ readonly type: "string";
179
+ };
174
180
  };
175
181
  readonly required: readonly ["type", "key"];
176
182
  readonly additionalProperties: false;
177
183
  };
178
184
  export declare const entityBaseProperties: {
185
+ readonly version: {
186
+ readonly type: "string";
187
+ };
179
188
  readonly key: {
180
189
  readonly type: "string";
181
190
  readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -273,6 +282,12 @@ export declare const entityBaseProperties: {
273
282
  readonly minLength: 2;
274
283
  readonly maxLength: 100;
275
284
  };
285
+ readonly version: {
286
+ readonly type: "string";
287
+ };
288
+ readonly revision: {
289
+ readonly type: "string";
290
+ };
276
291
  };
277
292
  readonly required: readonly ["type", "key"];
278
293
  readonly additionalProperties: false;
@@ -305,6 +320,9 @@ export declare const entityFileSchema: {
305
320
  readonly required: readonly ["email"];
306
321
  readonly additionalProperties: true;
307
322
  };
323
+ readonly version: {
324
+ readonly type: "string";
325
+ };
308
326
  readonly key: {
309
327
  readonly type: "string";
310
328
  readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -398,6 +416,12 @@ export declare const entityFileSchema: {
398
416
  readonly minLength: 2;
399
417
  readonly maxLength: 100;
400
418
  };
419
+ readonly version: {
420
+ readonly type: "string";
421
+ };
422
+ readonly revision: {
423
+ readonly type: "string";
424
+ };
401
425
  };
402
426
  readonly required: readonly ["type", "key"];
403
427
  readonly additionalProperties: false;
@@ -442,6 +466,9 @@ export declare const entityFileSchema: {
442
466
  readonly required: readonly ["method", "path"];
443
467
  readonly additionalProperties: true;
444
468
  };
469
+ readonly version: {
470
+ readonly type: "string";
471
+ };
445
472
  readonly key: {
446
473
  readonly type: "string";
447
474
  readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -535,6 +562,12 @@ export declare const entityFileSchema: {
535
562
  readonly minLength: 2;
536
563
  readonly maxLength: 100;
537
564
  };
565
+ readonly version: {
566
+ readonly type: "string";
567
+ };
568
+ readonly revision: {
569
+ readonly type: "string";
570
+ };
538
571
  };
539
572
  readonly required: readonly ["type", "key"];
540
573
  readonly additionalProperties: false;
@@ -569,6 +602,9 @@ export declare const entityFileSchema: {
569
602
  readonly required: readonly ["specType"];
570
603
  readonly additionalProperties: true;
571
604
  };
605
+ readonly version: {
606
+ readonly type: "string";
607
+ };
572
608
  readonly key: {
573
609
  readonly type: "string";
574
610
  readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -662,6 +698,12 @@ export declare const entityFileSchema: {
662
698
  readonly minLength: 2;
663
699
  readonly maxLength: 100;
664
700
  };
701
+ readonly version: {
702
+ readonly type: "string";
703
+ };
704
+ readonly revision: {
705
+ readonly type: "string";
706
+ };
665
707
  };
666
708
  readonly required: readonly ["type", "key"];
667
709
  readonly additionalProperties: false;
@@ -692,6 +734,9 @@ export declare const entityFileSchema: {
692
734
  readonly required: readonly ["specType", "descriptionFile"];
693
735
  readonly additionalProperties: true;
694
736
  };
737
+ readonly version: {
738
+ readonly type: "string";
739
+ };
695
740
  readonly key: {
696
741
  readonly type: "string";
697
742
  readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -785,6 +830,12 @@ export declare const entityFileSchema: {
785
830
  readonly minLength: 2;
786
831
  readonly maxLength: 100;
787
832
  };
833
+ readonly version: {
834
+ readonly type: "string";
835
+ };
836
+ readonly revision: {
837
+ readonly type: "string";
838
+ };
788
839
  };
789
840
  readonly required: readonly ["type", "key"];
790
841
  readonly additionalProperties: false;
@@ -799,6 +850,9 @@ export declare const entityFileSchema: {
799
850
  readonly type: {
800
851
  readonly const: "service";
801
852
  };
853
+ readonly version: {
854
+ readonly type: "string";
855
+ };
802
856
  readonly key: {
803
857
  readonly type: "string";
804
858
  readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -892,6 +946,12 @@ export declare const entityFileSchema: {
892
946
  readonly minLength: 2;
893
947
  readonly maxLength: 100;
894
948
  };
949
+ readonly version: {
950
+ readonly type: "string";
951
+ };
952
+ readonly revision: {
953
+ readonly type: "string";
954
+ };
895
955
  };
896
956
  readonly required: readonly ["type", "key"];
897
957
  readonly additionalProperties: false;
@@ -910,6 +970,9 @@ export declare const entityFileSchema: {
910
970
  readonly type: {
911
971
  readonly const: "domain";
912
972
  };
973
+ readonly version: {
974
+ readonly type: "string";
975
+ };
913
976
  readonly key: {
914
977
  readonly type: "string";
915
978
  readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -1003,6 +1066,12 @@ export declare const entityFileSchema: {
1003
1066
  readonly minLength: 2;
1004
1067
  readonly maxLength: 100;
1005
1068
  };
1069
+ readonly version: {
1070
+ readonly type: "string";
1071
+ };
1072
+ readonly revision: {
1073
+ readonly type: "string";
1074
+ };
1006
1075
  };
1007
1076
  readonly required: readonly ["type", "key"];
1008
1077
  readonly additionalProperties: false;
@@ -1021,6 +1090,9 @@ export declare const entityFileSchema: {
1021
1090
  readonly type: {
1022
1091
  readonly const: "team";
1023
1092
  };
1093
+ readonly version: {
1094
+ readonly type: "string";
1095
+ };
1024
1096
  readonly key: {
1025
1097
  readonly type: "string";
1026
1098
  readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -1114,6 +1186,12 @@ export declare const entityFileSchema: {
1114
1186
  readonly minLength: 2;
1115
1187
  readonly maxLength: 100;
1116
1188
  };
1189
+ readonly version: {
1190
+ readonly type: "string";
1191
+ };
1192
+ readonly revision: {
1193
+ readonly type: "string";
1194
+ };
1117
1195
  };
1118
1196
  readonly required: readonly ["type", "key"];
1119
1197
  readonly additionalProperties: false;
@@ -1131,6 +1209,9 @@ export declare const entityFileSchema: {
1131
1209
  export declare const entityFileDefaultSchema: {
1132
1210
  readonly type: "object";
1133
1211
  readonly properties: {
1212
+ readonly version: {
1213
+ readonly type: "string";
1214
+ };
1134
1215
  readonly key: {
1135
1216
  readonly type: "string";
1136
1217
  readonly pattern: "^[a-z0-9]+(?:-[a-z0-9]+)*$";
@@ -1228,6 +1309,12 @@ export declare const entityFileDefaultSchema: {
1228
1309
  readonly minLength: 2;
1229
1310
  readonly maxLength: 100;
1230
1311
  };
1312
+ readonly version: {
1313
+ readonly type: "string";
1314
+ };
1315
+ readonly revision: {
1316
+ readonly type: "string";
1317
+ };
1231
1318
  };
1232
1319
  readonly required: readonly ["type", "key"];
1233
1320
  readonly additionalProperties: false;
@@ -172,12 +172,21 @@ export const entityRelationFileSchema = {
172
172
  minLength: 2,
173
173
  maxLength: 100,
174
174
  },
175
+ version: {
176
+ type: 'string',
177
+ },
178
+ revision: {
179
+ type: 'string',
180
+ },
175
181
  },
176
182
  required: ['type', 'key'],
177
183
  additionalProperties: false,
178
184
  };
179
185
  // Base entity schema properties
180
186
  export const entityBaseProperties = {
187
+ version: {
188
+ type: 'string',
189
+ },
181
190
  key: {
182
191
  type: 'string',
183
192
  pattern: '^[a-z0-9]+(?:-[a-z0-9]+)*$',
@@ -4453,3 +4453,14 @@ export declare const scorecardConfigSchema: {
4453
4453
  };
4454
4454
  };
4455
4455
  };
4456
+ export declare const scorecardsConfigSchema: {
4457
+ readonly type: "object";
4458
+ readonly additionalProperties: true;
4459
+ readonly required: readonly [];
4460
+ readonly properties: {
4461
+ readonly test: {
4462
+ readonly type: "boolean";
4463
+ readonly default: true;
4464
+ };
4465
+ };
4466
+ };
@@ -655,4 +655,12 @@ export const scorecardConfigSchema = {
655
655
  fromProjectUrl: { type: 'string', format: 'uri' },
656
656
  },
657
657
  };
658
+ export const scorecardsConfigSchema = {
659
+ type: 'object',
660
+ additionalProperties: true,
661
+ required: [],
662
+ properties: {
663
+ test: { type: 'boolean', default: true },
664
+ },
665
+ };
658
666
  //# sourceMappingURL=ex-theme-config-schemas.js.map
@@ -445,6 +445,58 @@ export declare const graphqlConfigSchema: {
445
445
  readonly showBuiltInDirectives: {
446
446
  readonly type: "boolean";
447
447
  };
448
+ readonly info: {
449
+ readonly type: "object";
450
+ readonly properties: {
451
+ readonly title: {
452
+ readonly type: "string";
453
+ };
454
+ readonly version: {
455
+ readonly type: "string";
456
+ };
457
+ readonly description: {
458
+ readonly type: "string";
459
+ };
460
+ readonly termsOfService: {
461
+ readonly type: "string";
462
+ readonly format: "uri";
463
+ };
464
+ readonly contact: {
465
+ readonly type: "object";
466
+ readonly properties: {
467
+ readonly name: {
468
+ readonly type: "string";
469
+ };
470
+ readonly url: {
471
+ readonly type: "string";
472
+ readonly format: "uri";
473
+ };
474
+ readonly email: {
475
+ readonly type: "string";
476
+ readonly format: "email";
477
+ };
478
+ };
479
+ readonly additionalProperties: false;
480
+ };
481
+ readonly license: {
482
+ readonly type: "object";
483
+ readonly properties: {
484
+ readonly name: {
485
+ readonly type: "string";
486
+ };
487
+ readonly url: {
488
+ readonly type: "string";
489
+ readonly format: "uri";
490
+ };
491
+ readonly identifier: {
492
+ readonly type: "string";
493
+ };
494
+ };
495
+ readonly additionalProperties: false;
496
+ };
497
+ };
498
+ readonly additionalProperties: false;
499
+ };
448
500
  };
449
501
  readonly additionalProperties: false;
450
502
  };
@@ -51,6 +51,36 @@ const menuGroupingConfig = {
51
51
  required: ['requireExactGroups', 'groups', 'otherItemsGroupName'],
52
52
  additionalProperties: false,
53
53
  };
54
+ const graphqlContactConfigSchema = {
55
+ type: 'object',
56
+ properties: {
57
+ name: { type: 'string' },
58
+ url: { type: 'string', format: 'uri' },
59
+ email: { type: 'string', format: 'email' },
60
+ },
61
+ additionalProperties: false,
62
+ };
63
+ const graphqlLicenseConfigSchema = {
64
+ type: 'object',
65
+ properties: {
66
+ name: { type: 'string' },
67
+ url: { type: 'string', format: 'uri' },
68
+ identifier: { type: 'string' },
69
+ },
70
+ additionalProperties: false,
71
+ };
72
+ const graphqlInfoConfigSchema = {
73
+ type: 'object',
74
+ properties: {
75
+ title: { type: 'string' },
76
+ version: { type: 'string' },
77
+ description: { type: 'string' },
78
+ termsOfService: { type: 'string', format: 'uri' },
79
+ contact: graphqlContactConfigSchema,
80
+ license: graphqlLicenseConfigSchema,
81
+ },
82
+ additionalProperties: false,
83
+ };
54
84
  export const graphqlConfigSchema = {
55
85
  type: 'object',
56
86
  properties: {
@@ -117,6 +147,7 @@ export const graphqlConfigSchema = {
117
147
  showBuiltInDirectives: {
118
148
  type: 'boolean',
119
149
  },
150
+ info: graphqlInfoConfigSchema,
120
151
  },
121
152
  additionalProperties: false,
122
153
  };
@@ -5192,6 +5192,58 @@ export declare const productConfigOverrideSchema: {
5192
5192
  readonly showBuiltInDirectives: {
5193
5193
  readonly type: "boolean";
5194
5194
  };
5195
+ readonly info: {
5196
+ readonly type: "object";
5197
+ readonly properties: {
5198
+ readonly title: {
5199
+ readonly type: "string";
5200
+ };
5201
+ readonly version: {
5202
+ readonly type: "string";
5203
+ };
5204
+ readonly description: {
5205
+ readonly type: "string";
5206
+ };
5207
+ readonly termsOfService: {
5208
+ readonly type: "string";
5209
+ readonly format: "uri";
5210
+ };
5211
+ readonly contact: {
5212
+ readonly type: "object";
5213
+ readonly properties: {
5214
+ readonly name: {
5215
+ readonly type: "string";
5216
+ };
5217
+ readonly url: {
5218
+ readonly type: "string";
5219
+ readonly format: "uri";
5220
+ };
5221
+ readonly email: {
5222
+ readonly type: "string";
5223
+ readonly format: "email";
5224
+ };
5225
+ };
5226
+ readonly additionalProperties: false;
5227
+ };
5228
+ readonly license: {
5229
+ readonly type: "object";
5230
+ readonly properties: {
5231
+ readonly name: {
5232
+ readonly type: "string";
5233
+ };
5234
+ readonly url: {
5235
+ readonly type: "string";
5236
+ readonly format: "uri";
5237
+ };
5238
+ readonly identifier: {
5239
+ readonly type: "string";
5240
+ };
5241
+ };
5242
+ readonly additionalProperties: false;
5243
+ };
5244
+ };
5245
+ readonly additionalProperties: false;
5246
+ };
5195
5247
  };
5196
5248
  readonly additionalProperties: false;
5197
5249
  };
@@ -7452,6 +7504,58 @@ export declare const productConfigOverrideSchema: {
7452
7504
  readonly showBuiltInDirectives: {
7453
7505
  readonly type: "boolean";
7454
7506
  };
7507
+ readonly info: {
7508
+ readonly type: "object";
7509
+ readonly properties: {
7510
+ readonly title: {
7511
+ readonly type: "string";
7512
+ };
7513
+ readonly version: {
7514
+ readonly type: "string";
7515
+ };
7516
+ readonly description: {
7517
+ readonly type: "string";
7518
+ };
7519
+ readonly termsOfService: {
7520
+ readonly type: "string";
7521
+ readonly format: "uri";
7522
+ };
7523
+ readonly contact: {
7524
+ readonly type: "object";
7525
+ readonly properties: {
7526
+ readonly name: {
7527
+ readonly type: "string";
7528
+ };
7529
+ readonly url: {
7530
+ readonly type: "string";
7531
+ readonly format: "uri";
7532
+ };
7533
+ readonly email: {
7534
+ readonly type: "string";
7535
+ readonly format: "email";
7536
+ };
7537
+ };
7538
+ readonly additionalProperties: false;
7539
+ };
7540
+ readonly license: {
7541
+ readonly type: "object";
7542
+ readonly properties: {
7543
+ readonly name: {
7544
+ readonly type: "string";
7545
+ };
7546
+ readonly url: {
7547
+ readonly type: "string";
7548
+ readonly format: "uri";
7549
+ };
7550
+ readonly identifier: {
7551
+ readonly type: "string";
7552
+ };
7553
+ };
7554
+ readonly additionalProperties: false;
7555
+ };
7556
+ };
7557
+ readonly additionalProperties: false;
7558
+ };
7455
7559
  };
7456
7560
  readonly additionalProperties: false;
7457
7561
  };