@redocly/config 0.26.1 → 0.26.3-rc.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 (41) hide show
  1. package/lib/common.d.ts +160 -0
  2. package/lib/common.js +40 -0
  3. package/lib/default-theme-config-schema.d.ts +657 -4260
  4. package/lib/default-theme-config-schema.js +3 -2
  5. package/lib/entities-catalog-config-schema.d.ts +718 -0
  6. package/lib/entities-catalog-config-schema.js +84 -0
  7. package/lib/ex-theme-config-schemas.d.ts +147 -12
  8. package/lib/ex-theme-config-schemas.js +4 -12
  9. package/lib/graphql-config-schema.d.ts +9 -0
  10. package/lib/graphql-config-schema.js +9 -0
  11. package/lib/product-override-schema.d.ts +168 -24
  12. package/lib/root-config-schema.d.ts +30277 -25599
  13. package/lib/root-config-schema.js +12 -73
  14. package/lib/types/catalog-entity-types.d.ts +29 -0
  15. package/lib/types/catalog-entity-types.js +3 -0
  16. package/lib/types/code-walkthrough-types.d.ts +0 -1
  17. package/lib/types/config-types.d.ts +2 -0
  18. package/lib/types/index.d.ts +1 -0
  19. package/lib/types/index.js +1 -0
  20. package/lib/types/portal-shared-types.d.ts +12 -1
  21. package/lib-esm/common.d.ts +160 -0
  22. package/lib-esm/common.js +37 -0
  23. package/lib-esm/default-theme-config-schema.d.ts +657 -4260
  24. package/lib-esm/default-theme-config-schema.js +2 -1
  25. package/lib-esm/entities-catalog-config-schema.d.ts +718 -0
  26. package/lib-esm/entities-catalog-config-schema.js +81 -0
  27. package/lib-esm/ex-theme-config-schemas.d.ts +147 -12
  28. package/lib-esm/ex-theme-config-schemas.js +4 -12
  29. package/lib-esm/graphql-config-schema.d.ts +9 -0
  30. package/lib-esm/graphql-config-schema.js +9 -0
  31. package/lib-esm/product-override-schema.d.ts +168 -24
  32. package/lib-esm/root-config-schema.d.ts +37428 -32290
  33. package/lib-esm/root-config-schema.js +12 -73
  34. package/lib-esm/types/catalog-entity-types.d.ts +29 -0
  35. package/lib-esm/types/catalog-entity-types.js +2 -0
  36. package/lib-esm/types/code-walkthrough-types.d.ts +0 -1
  37. package/lib-esm/types/config-types.d.ts +2 -0
  38. package/lib-esm/types/index.d.ts +1 -0
  39. package/lib-esm/types/index.js +1 -0
  40. package/lib-esm/types/portal-shared-types.d.ts +12 -1
  41. package/package.json +2 -2
@@ -0,0 +1,84 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.entitiesCatalogConfigSchema = exports.entityCatalogSpecificCatalogSchema = exports.entityCatalogFilterSchema = exports.entityCatalogIncludeSchema = exports.entityCatalogExcludeSchema = void 0;
4
+ exports.entityCatalogExcludeSchema = {
5
+ type: 'object',
6
+ required: ['key'],
7
+ properties: {
8
+ key: { type: 'string' },
9
+ },
10
+ additionalProperties: false,
11
+ };
12
+ exports.entityCatalogIncludeSchema = {
13
+ type: 'object',
14
+ required: ['type'],
15
+ properties: {
16
+ type: { type: 'string' },
17
+ },
18
+ additionalProperties: false,
19
+ };
20
+ exports.entityCatalogFilterSchema = {
21
+ type: 'object',
22
+ required: ['property', 'title'],
23
+ properties: {
24
+ property: { type: 'string' },
25
+ hide: { type: 'boolean' },
26
+ label: { type: 'string' },
27
+ options: {
28
+ type: 'array',
29
+ items: { type: 'string' },
30
+ },
31
+ type: {
32
+ type: 'string',
33
+ enum: ['select', 'checkboxes', 'date-range'],
34
+ default: 'checkboxes',
35
+ },
36
+ title: { type: 'string' },
37
+ titleTranslationKey: { type: 'string' },
38
+ parentFilter: { type: 'string' },
39
+ valuesMapping: { type: 'object', additionalProperties: { type: 'string' } },
40
+ },
41
+ additionalProperties: false,
42
+ };
43
+ exports.entityCatalogSpecificCatalogSchema = {
44
+ type: 'object',
45
+ properties: {
46
+ slug: { type: 'string' },
47
+ hide: { type: 'boolean' },
48
+ includes: {
49
+ type: 'array',
50
+ items: exports.entityCatalogIncludeSchema,
51
+ },
52
+ excludes: {
53
+ type: 'array',
54
+ items: exports.entityCatalogExcludeSchema,
55
+ },
56
+ filters: {
57
+ type: 'array',
58
+ items: exports.entityCatalogFilterSchema,
59
+ },
60
+ titleTranslationKey: { type: 'string' },
61
+ descriptionTranslationKey: { type: 'string' },
62
+ catalogSwitcherLabelTranslationKey: { type: 'string' },
63
+ },
64
+ additionalProperties: false,
65
+ };
66
+ exports.entitiesCatalogConfigSchema = {
67
+ type: 'object',
68
+ properties: {
69
+ catalogs: {
70
+ type: 'object',
71
+ properties: {
72
+ all: exports.entityCatalogSpecificCatalogSchema,
73
+ services: exports.entityCatalogSpecificCatalogSchema,
74
+ domains: exports.entityCatalogSpecificCatalogSchema,
75
+ teams: exports.entityCatalogSpecificCatalogSchema,
76
+ users: exports.entityCatalogSpecificCatalogSchema,
77
+ apiDescriptions: exports.entityCatalogSpecificCatalogSchema,
78
+ },
79
+ additionalProperties: false,
80
+ },
81
+ },
82
+ additionalProperties: false,
83
+ };
84
+ //# sourceMappingURL=entities-catalog-config-schema.js.map
@@ -4128,17 +4128,69 @@ export declare const scorecardConfigSchema: {
4128
4128
  readonly type: "object";
4129
4129
  readonly required: readonly ["name"];
4130
4130
  readonly properties: {
4131
- readonly name: {
4132
- readonly type: "string";
4131
+ readonly decorators: {
4132
+ readonly type: "object";
4133
+ readonly additionalProperties: true;
4133
4134
  };
4134
- readonly color: {
4135
- readonly type: "string";
4135
+ readonly oas2Decorators: {
4136
+ readonly type: "object";
4137
+ readonly additionalProperties: true;
4136
4138
  };
4137
- readonly extends: {
4138
- readonly type: "array";
4139
- readonly items: {
4140
- readonly type: "string";
4141
- };
4139
+ readonly oas3_0Decorators: {
4140
+ readonly type: "object";
4141
+ readonly additionalProperties: true;
4142
+ };
4143
+ readonly oas3_1Decorators: {
4144
+ readonly type: "object";
4145
+ readonly additionalProperties: true;
4146
+ };
4147
+ readonly async2Decorators: {
4148
+ readonly type: "object";
4149
+ readonly additionalProperties: true;
4150
+ };
4151
+ readonly async3Decorators: {
4152
+ readonly type: "object";
4153
+ readonly additionalProperties: true;
4154
+ };
4155
+ readonly arazzo1Decorators: {
4156
+ readonly type: "object";
4157
+ readonly additionalProperties: true;
4158
+ };
4159
+ readonly overlay1Decorators: {
4160
+ readonly type: "object";
4161
+ readonly additionalProperties: true;
4162
+ };
4163
+ readonly preprocessors: {
4164
+ readonly type: "object";
4165
+ readonly additionalProperties: true;
4166
+ };
4167
+ readonly oas2Preprocessors: {
4168
+ readonly type: "object";
4169
+ readonly additionalProperties: true;
4170
+ };
4171
+ readonly oas3_0Preprocessors: {
4172
+ readonly type: "object";
4173
+ readonly additionalProperties: true;
4174
+ };
4175
+ readonly oas3_1Preprocessors: {
4176
+ readonly type: "object";
4177
+ readonly additionalProperties: true;
4178
+ };
4179
+ readonly async2Preprocessors: {
4180
+ readonly type: "object";
4181
+ readonly additionalProperties: true;
4182
+ };
4183
+ readonly async3Preprocessors: {
4184
+ readonly type: "object";
4185
+ readonly additionalProperties: true;
4186
+ };
4187
+ readonly arazzo1Preprocessors: {
4188
+ readonly type: "object";
4189
+ readonly additionalProperties: true;
4190
+ };
4191
+ readonly overlay1Preprocessors: {
4192
+ readonly type: "object";
4193
+ readonly additionalProperties: true;
4142
4194
  };
4143
4195
  readonly rules: {
4144
4196
  readonly type: "object";
@@ -4150,6 +4202,88 @@ export declare const scorecardConfigSchema: {
4150
4202
  }];
4151
4203
  };
4152
4204
  };
4205
+ readonly oas2Rules: {
4206
+ readonly type: "object";
4207
+ readonly additionalProperties: {
4208
+ readonly oneOf: readonly [{
4209
+ readonly type: "string";
4210
+ }, {
4211
+ readonly type: "object";
4212
+ }];
4213
+ };
4214
+ };
4215
+ readonly oas3_0Rules: {
4216
+ readonly type: "object";
4217
+ readonly additionalProperties: {
4218
+ readonly oneOf: readonly [{
4219
+ readonly type: "string";
4220
+ }, {
4221
+ readonly type: "object";
4222
+ }];
4223
+ };
4224
+ };
4225
+ readonly oas3_1Rules: {
4226
+ readonly type: "object";
4227
+ readonly additionalProperties: {
4228
+ readonly oneOf: readonly [{
4229
+ readonly type: "string";
4230
+ }, {
4231
+ readonly type: "object";
4232
+ }];
4233
+ };
4234
+ };
4235
+ readonly async2Rules: {
4236
+ readonly type: "object";
4237
+ readonly additionalProperties: {
4238
+ readonly oneOf: readonly [{
4239
+ readonly type: "string";
4240
+ }, {
4241
+ readonly type: "object";
4242
+ }];
4243
+ };
4244
+ };
4245
+ readonly async3Rules: {
4246
+ readonly type: "object";
4247
+ readonly additionalProperties: {
4248
+ readonly oneOf: readonly [{
4249
+ readonly type: "string";
4250
+ }, {
4251
+ readonly type: "object";
4252
+ }];
4253
+ };
4254
+ };
4255
+ readonly arazzo1Rules: {
4256
+ readonly type: "object";
4257
+ readonly additionalProperties: {
4258
+ readonly oneOf: readonly [{
4259
+ readonly type: "string";
4260
+ }, {
4261
+ readonly type: "object";
4262
+ }];
4263
+ };
4264
+ };
4265
+ readonly overlay1Rules: {
4266
+ readonly type: "object";
4267
+ readonly additionalProperties: {
4268
+ readonly oneOf: readonly [{
4269
+ readonly type: "string";
4270
+ }, {
4271
+ readonly type: "object";
4272
+ }];
4273
+ };
4274
+ };
4275
+ readonly name: {
4276
+ readonly type: "string";
4277
+ };
4278
+ readonly color: {
4279
+ readonly type: "string";
4280
+ };
4281
+ readonly extends: {
4282
+ readonly type: "array";
4283
+ readonly items: {
4284
+ readonly type: "string";
4285
+ };
4286
+ };
4153
4287
  };
4154
4288
  readonly additionalProperties: false;
4155
4289
  };
@@ -4167,15 +4301,16 @@ export declare const scorecardConfigSchema: {
4167
4301
  readonly type: "object";
4168
4302
  readonly additionalProperties: true;
4169
4303
  };
4304
+ readonly ignore: {
4305
+ readonly type: "boolean";
4306
+ };
4170
4307
  readonly where: {
4171
4308
  readonly type: "object";
4172
4309
  readonly required: readonly ["metadata"];
4173
4310
  readonly properties: {
4174
4311
  readonly metadata: {
4175
4312
  readonly type: "object";
4176
- readonly additionalProperties: {
4177
- readonly type: "string";
4178
- };
4313
+ readonly additionalProperties: {};
4179
4314
  };
4180
4315
  };
4181
4316
  readonly additionalProperties: false;
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.scorecardConfigSchema = exports.catalogsConfigSchema = exports.catalogSchema = exports.catalogFilterSchema = exports.breadcrumbsConfigSchema = exports.versionPickerConfigSchema = exports.userMenuConfigSchema = exports.analyticsConfigSchema = exports.googleAnalyticsConfigSchema = exports.productGoogleAnalyticsConfigSchema = exports.gtmAnalyticsConfigSchema = exports.segmentAnalyticsConfigSchema = exports.rudderstackAnalyticsConfigSchema = exports.heapAnalyticsConfigSchema = exports.fullstoryAnalyticsConfigSchema = exports.amplitudeAnalyticsConfigSchema = exports.openapiConfigSchema = exports.markdownConfigSchema = exports.codeSnippetConfigSchema = exports.navigationConfigSchema = exports.colorModeConfigSchema = exports.searchConfigSchema = exports.linksConfigSchema = exports.scriptsConfigSchema = exports.sidebarConfigSchema = exports.footerConfigSchema = exports.productsConfigSchema = exports.navbarConfigSchema = exports.logoConfigSchema = exports.searchFiltersConfigSchema = exports.searchFacetsConfigSchema = exports.aiSearchConfigSchema = exports.productConfigSchema = exports.navItemsSchema = void 0;
4
4
  const redoc_config_schema_1 = require("./redoc-config-schema");
5
5
  const reference_docs_config_schema_1 = require("./reference-docs-config-schema");
6
+ const common_1 = require("./common");
6
7
  const hideConfigSchema = {
7
8
  type: 'object',
8
9
  properties: {
@@ -567,17 +568,7 @@ exports.scorecardConfigSchema = {
567
568
  items: {
568
569
  type: 'object',
569
570
  required: ['name'],
570
- properties: {
571
- name: { type: 'string' },
572
- color: { type: 'string' },
573
- extends: { type: 'array', items: { type: 'string' } },
574
- rules: {
575
- type: 'object',
576
- additionalProperties: {
577
- oneOf: [{ type: 'string' }, { type: 'object' }],
578
- },
579
- },
580
- },
571
+ properties: Object.assign(Object.assign(Object.assign({ name: { type: 'string' }, color: { type: 'string' }, extends: { type: 'array', items: { type: 'string' } } }, common_1.ruleSchemas), common_1.preprocessorSchemas), common_1.decoratorsSchemas),
581
572
  additionalProperties: false,
582
573
  },
583
574
  },
@@ -589,11 +580,12 @@ exports.scorecardConfigSchema = {
589
580
  properties: {
590
581
  minimumLevel: { type: 'string' },
591
582
  rules: { type: 'object', additionalProperties: true },
583
+ ignore: { type: 'boolean' },
592
584
  where: {
593
585
  type: 'object',
594
586
  required: ['metadata'],
595
587
  properties: {
596
- metadata: { type: 'object', additionalProperties: { type: 'string' } },
588
+ metadata: { type: 'object', additionalProperties: {} },
597
589
  },
598
590
  additionalProperties: false,
599
591
  },
@@ -177,6 +177,15 @@ export declare const graphqlConfigSchema: {
177
177
  readonly baseUrlPath: {
178
178
  readonly type: "string";
179
179
  };
180
+ readonly metadata: {
181
+ readonly type: "object";
182
+ readonly properties: {
183
+ readonly apiId: {
184
+ readonly type: "string";
185
+ };
186
+ };
187
+ readonly additionalProperties: true;
188
+ };
180
189
  readonly feedback: {
181
190
  readonly type: "object";
182
191
  readonly properties: {
@@ -104,6 +104,15 @@ exports.graphqlConfigSchema = {
104
104
  baseUrlPath: {
105
105
  type: 'string',
106
106
  },
107
+ metadata: {
108
+ type: 'object',
109
+ properties: {
110
+ apiId: {
111
+ type: 'string',
112
+ },
113
+ },
114
+ additionalProperties: true,
115
+ },
107
116
  feedback: feedback_config_schema_1.feedbackConfigSchema,
108
117
  },
109
118
  additionalProperties: false,
@@ -2716,6 +2716,156 @@ export declare const productConfigOverrideSchema: {
2716
2716
  readonly additionalProperties: {
2717
2717
  readonly type: "object";
2718
2718
  readonly properties: {
2719
+ readonly extends: {
2720
+ readonly type: "array";
2721
+ readonly items: {
2722
+ readonly type: "string";
2723
+ };
2724
+ };
2725
+ readonly decorators: {
2726
+ readonly type: "object";
2727
+ readonly additionalProperties: true;
2728
+ };
2729
+ readonly oas2Decorators: {
2730
+ readonly type: "object";
2731
+ readonly additionalProperties: true;
2732
+ };
2733
+ readonly oas3_0Decorators: {
2734
+ readonly type: "object";
2735
+ readonly additionalProperties: true;
2736
+ };
2737
+ readonly oas3_1Decorators: {
2738
+ readonly type: "object";
2739
+ readonly additionalProperties: true;
2740
+ };
2741
+ readonly async2Decorators: {
2742
+ readonly type: "object";
2743
+ readonly additionalProperties: true;
2744
+ };
2745
+ readonly async3Decorators: {
2746
+ readonly type: "object";
2747
+ readonly additionalProperties: true;
2748
+ };
2749
+ readonly arazzo1Decorators: {
2750
+ readonly type: "object";
2751
+ readonly additionalProperties: true;
2752
+ };
2753
+ readonly overlay1Decorators: {
2754
+ readonly type: "object";
2755
+ readonly additionalProperties: true;
2756
+ };
2757
+ readonly preprocessors: {
2758
+ readonly type: "object";
2759
+ readonly additionalProperties: true;
2760
+ };
2761
+ readonly oas2Preprocessors: {
2762
+ readonly type: "object";
2763
+ readonly additionalProperties: true;
2764
+ };
2765
+ readonly oas3_0Preprocessors: {
2766
+ readonly type: "object";
2767
+ readonly additionalProperties: true;
2768
+ };
2769
+ readonly oas3_1Preprocessors: {
2770
+ readonly type: "object";
2771
+ readonly additionalProperties: true;
2772
+ };
2773
+ readonly async2Preprocessors: {
2774
+ readonly type: "object";
2775
+ readonly additionalProperties: true;
2776
+ };
2777
+ readonly async3Preprocessors: {
2778
+ readonly type: "object";
2779
+ readonly additionalProperties: true;
2780
+ };
2781
+ readonly arazzo1Preprocessors: {
2782
+ readonly type: "object";
2783
+ readonly additionalProperties: true;
2784
+ };
2785
+ readonly overlay1Preprocessors: {
2786
+ readonly type: "object";
2787
+ readonly additionalProperties: true;
2788
+ };
2789
+ readonly rules: {
2790
+ readonly type: "object";
2791
+ readonly additionalProperties: {
2792
+ readonly oneOf: readonly [{
2793
+ readonly type: "string";
2794
+ }, {
2795
+ readonly type: "object";
2796
+ }];
2797
+ };
2798
+ };
2799
+ readonly oas2Rules: {
2800
+ readonly type: "object";
2801
+ readonly additionalProperties: {
2802
+ readonly oneOf: readonly [{
2803
+ readonly type: "string";
2804
+ }, {
2805
+ readonly type: "object";
2806
+ }];
2807
+ };
2808
+ };
2809
+ readonly oas3_0Rules: {
2810
+ readonly type: "object";
2811
+ readonly additionalProperties: {
2812
+ readonly oneOf: readonly [{
2813
+ readonly type: "string";
2814
+ }, {
2815
+ readonly type: "object";
2816
+ }];
2817
+ };
2818
+ };
2819
+ readonly oas3_1Rules: {
2820
+ readonly type: "object";
2821
+ readonly additionalProperties: {
2822
+ readonly oneOf: readonly [{
2823
+ readonly type: "string";
2824
+ }, {
2825
+ readonly type: "object";
2826
+ }];
2827
+ };
2828
+ };
2829
+ readonly async2Rules: {
2830
+ readonly type: "object";
2831
+ readonly additionalProperties: {
2832
+ readonly oneOf: readonly [{
2833
+ readonly type: "string";
2834
+ }, {
2835
+ readonly type: "object";
2836
+ }];
2837
+ };
2838
+ };
2839
+ readonly async3Rules: {
2840
+ readonly type: "object";
2841
+ readonly additionalProperties: {
2842
+ readonly oneOf: readonly [{
2843
+ readonly type: "string";
2844
+ }, {
2845
+ readonly type: "object";
2846
+ }];
2847
+ };
2848
+ };
2849
+ readonly arazzo1Rules: {
2850
+ readonly type: "object";
2851
+ readonly additionalProperties: {
2852
+ readonly oneOf: readonly [{
2853
+ readonly type: "string";
2854
+ }, {
2855
+ readonly type: "object";
2856
+ }];
2857
+ };
2858
+ };
2859
+ readonly overlay1Rules: {
2860
+ readonly type: "object";
2861
+ readonly additionalProperties: {
2862
+ readonly oneOf: readonly [{
2863
+ readonly type: "string";
2864
+ }, {
2865
+ readonly type: "object";
2866
+ }];
2867
+ };
2868
+ };
2719
2869
  readonly root: {
2720
2870
  readonly type: "string";
2721
2871
  };
@@ -4714,6 +4864,15 @@ export declare const productConfigOverrideSchema: {
4714
4864
  readonly baseUrlPath: {
4715
4865
  readonly type: "string";
4716
4866
  };
4867
+ readonly metadata: {
4868
+ readonly type: "object";
4869
+ readonly properties: {
4870
+ readonly apiId: {
4871
+ readonly type: "string";
4872
+ };
4873
+ };
4874
+ readonly additionalProperties: true;
4875
+ };
4717
4876
  readonly feedback: {
4718
4877
  readonly type: "object";
4719
4878
  readonly properties: {
@@ -6943,6 +7102,15 @@ export declare const productConfigOverrideSchema: {
6943
7102
  readonly baseUrlPath: {
6944
7103
  readonly type: "string";
6945
7104
  };
7105
+ readonly metadata: {
7106
+ readonly type: "object";
7107
+ readonly properties: {
7108
+ readonly apiId: {
7109
+ readonly type: "string";
7110
+ };
7111
+ };
7112
+ readonly additionalProperties: true;
7113
+ };
6946
7114
  readonly feedback: {
6947
7115
  readonly type: "object";
6948
7116
  readonly properties: {
@@ -7192,30 +7360,6 @@ export declare const productConfigOverrideSchema: {
7192
7360
  readonly type: "object";
7193
7361
  readonly additionalProperties: true;
7194
7362
  };
7195
- readonly rules: {
7196
- readonly type: "object";
7197
- readonly additionalProperties: {
7198
- readonly oneOf: readonly [{
7199
- readonly type: "string";
7200
- }, {
7201
- readonly type: "object";
7202
- }];
7203
- };
7204
- };
7205
- readonly decorators: {
7206
- readonly type: "object";
7207
- readonly additionalProperties: true;
7208
- };
7209
- readonly preprocessors: {
7210
- readonly type: "object";
7211
- readonly additionalProperties: true;
7212
- };
7213
- readonly extends: {
7214
- readonly type: "array";
7215
- readonly items: {
7216
- readonly type: "string";
7217
- };
7218
- };
7219
7363
  };
7220
7364
  readonly required: readonly ["root"];
7221
7365
  };