@redocly/config 0.36.2 → 0.38.0-custom.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 (29) hide show
  1. package/lib/default-theme-config-schema.d.ts +82 -6
  2. package/lib/default-theme-config-schema.js +1 -0
  3. package/lib/ex-theme-config-schemas.d.ts +18 -6
  4. package/lib/ex-theme-config-schemas.js +14 -5
  5. package/lib/graphql-config-schema.d.ts +64 -0
  6. package/lib/graphql-config-schema.js +64 -0
  7. package/lib/product-override-schema.d.ts +128 -0
  8. package/lib/root-config-schema.d.ts +1025 -69
  9. package/lib/root-config-schema.js +2 -1
  10. package/lib/types/api-functions-types.d.ts +49 -1
  11. package/lib/types/config-types.d.ts +2 -1
  12. package/lib/types/portal-shared-types.d.ts +2 -2
  13. package/lib/types/scorecards-types.d.ts +3 -0
  14. package/lib/types/scorecards-types.js +3 -0
  15. package/lib-esm/default-theme-config-schema.d.ts +82 -6
  16. package/lib-esm/default-theme-config-schema.js +2 -1
  17. package/lib-esm/ex-theme-config-schemas.d.ts +18 -6
  18. package/lib-esm/ex-theme-config-schemas.js +13 -4
  19. package/lib-esm/graphql-config-schema.d.ts +64 -0
  20. package/lib-esm/graphql-config-schema.js +64 -0
  21. package/lib-esm/product-override-schema.d.ts +128 -0
  22. package/lib-esm/root-config-schema.d.ts +1176 -220
  23. package/lib-esm/root-config-schema.js +3 -2
  24. package/lib-esm/types/api-functions-types.d.ts +49 -1
  25. package/lib-esm/types/config-types.d.ts +2 -1
  26. package/lib-esm/types/portal-shared-types.d.ts +2 -2
  27. package/lib-esm/types/scorecards-types.d.ts +3 -0
  28. package/lib-esm/types/scorecards-types.js +2 -0
  29. package/package.json +2 -2
package/lib/default-theme-config-schema.d.ts CHANGED
@@ -989,7 +989,7 @@ export declare const themeConfigSchema: {
989
989
  readonly inputIcon: {
990
990
  readonly type: "string";
991
991
  readonly enum: readonly ["chat", "sparkles", "redocly"];
992
- readonly default: "redocly";
992
+ readonly default: "sparkles";
993
993
  };
994
994
  };
995
995
  readonly additionalProperties: false;
@@ -1052,9 +1052,9 @@ export declare const themeConfigSchema: {
1052
1052
  readonly type: "array";
1053
1053
  readonly items: {
1054
1054
  readonly type: "string";
1055
- readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
1055
+ readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
1056
1056
  };
1057
- readonly default: readonly ["copy", "view", "chatgpt", "claude"];
1057
+ readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
1058
1058
  };
1059
1059
  readonly hide: {
1060
1060
  readonly type: "boolean";
@@ -3146,6 +3146,70 @@ export declare const themeConfigSchema: {
3146
3146
  };
3147
3147
  readonly additionalProperties: false;
3148
3148
  };
3149
+ readonly servers: {
3150
+ readonly type: "array";
3151
+ readonly items: {
3152
+ readonly type: "object";
3153
+ readonly properties: {
3154
+ readonly url: {
3155
+ readonly type: "string";
3156
+ };
3157
+ readonly description: {
3158
+ readonly type: "string";
3159
+ };
3160
+ readonly variables: {
3161
+ readonly type: "object";
3162
+ readonly additionalProperties: true;
3163
+ };
3164
+ };
3165
+ readonly required: readonly ["url"];
3166
+ };
3167
+ };
3168
+ readonly info: {
3169
+ readonly type: "object";
3170
+ readonly properties: {
3171
+ readonly title: {
3172
+ readonly type: "string";
3173
+ };
3174
+ readonly description: {
3175
+ readonly type: "string";
3176
+ };
3177
+ readonly summary: {
3178
+ readonly type: "string";
3179
+ };
3180
+ readonly version: {
3181
+ readonly type: "string";
3182
+ };
3183
+ readonly termsOfService: {
3184
+ readonly type: "string";
3185
+ };
3186
+ readonly contact: {
3187
+ readonly type: "object";
3188
+ readonly properties: {
3189
+ readonly name: {
3190
+ readonly type: "string";
3191
+ };
3192
+ readonly email: {
3193
+ readonly type: "string";
3194
+ };
3195
+ readonly url: {
3196
+ readonly type: "string";
3197
+ };
3198
+ };
3199
+ };
3200
+ readonly license: {
3201
+ readonly type: "object";
3202
+ readonly properties: {
3203
+ readonly name: {
3204
+ readonly type: "string";
3205
+ };
3206
+ readonly url: {
3207
+ readonly type: "string";
3208
+ };
3209
+ };
3210
+ };
3211
+ };
3212
+ };
3149
3213
  readonly sidebar: {
3150
3214
  readonly type: "object";
3151
3215
  readonly properties: {
@@ -5505,15 +5569,16 @@ export declare const themeConfigSchema: {
5505
5569
  readonly type: "object";
5506
5570
  readonly additionalProperties: true;
5507
5571
  };
5572
+ readonly ignore: {
5573
+ readonly type: "boolean";
5574
+ };
5508
5575
  readonly where: {
5509
5576
  readonly type: "object";
5510
5577
  readonly required: readonly ["metadata"];
5511
5578
  readonly properties: {
5512
5579
  readonly metadata: {
5513
5580
  readonly type: "object";
5514
- readonly additionalProperties: {
5515
- readonly type: "string";
5516
- };
5581
+ readonly additionalProperties: {};
5517
5582
  };
5518
5583
  };
5519
5584
  readonly additionalProperties: false;
@@ -5534,6 +5599,17 @@ export declare const themeConfigSchema: {
5534
5599
  };
5535
5600
  };
5536
5601
  };
5602
+ readonly scorecards: {
5603
+ readonly type: "object";
5604
+ readonly additionalProperties: true;
5605
+ readonly required: readonly [];
5606
+ readonly properties: {
5607
+ readonly test: {
5608
+ readonly type: "boolean";
5609
+ readonly default: true;
5610
+ };
5611
+ };
5612
+ };
5537
5613
  };
5538
5614
  readonly additionalProperties: true;
5539
5615
  };
package/lib/default-theme-config-schema.js CHANGED
@@ -42,6 +42,7 @@ exports.themeConfigSchema = {
42
42
  entitiesCatalog: entities_catalog_config_schema_1.entitiesCatalogConfigSchema,
43
43
  catalogClassic: ex_theme_config_schemas_1.catalogsConfigSchema,
44
44
  scorecard: ex_theme_config_schemas_1.scorecardConfigSchema,
45
+ scorecards: ex_theme_config_schemas_1.scorecardsConfigSchema,
45
46
  },
46
47
  additionalProperties: true,
47
48
  };
package/lib/ex-theme-config-schemas.d.ts CHANGED
@@ -1022,7 +1022,7 @@ export declare const aiAssistantSchema: {
1022
1022
  readonly inputIcon: {
1023
1023
  readonly type: "string";
1024
1024
  readonly enum: readonly ["chat", "sparkles", "redocly"];
1025
- readonly default: "redocly";
1025
+ readonly default: "sparkles";
1026
1026
  };
1027
1027
  };
1028
1028
  readonly additionalProperties: false;
@@ -1085,9 +1085,9 @@ export declare const navigationConfigSchema: {
1085
1085
  readonly type: "array";
1086
1086
  readonly items: {
1087
1087
  readonly type: "string";
1088
- readonly enum: readonly ["copy", "view", "chatgpt", "claude"];
1088
+ readonly enum: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
1089
1089
  };
1090
- readonly default: readonly ["copy", "view", "chatgpt", "claude"];
1090
+ readonly default: readonly ["copy", "view", "chatgpt", "claude", "docs-mcp-cursor", "docs-mcp-vscode"];
1091
1091
  };
1092
1092
  readonly hide: {
1093
1093
  readonly type: "boolean";
@@ -4424,15 +4424,16 @@ export declare const scorecardConfigSchema: {
4424
4424
  readonly type: "object";
4425
4425
  readonly additionalProperties: true;
4426
4426
  };
4427
+ readonly ignore: {
4428
+ readonly type: "boolean";
4429
+ };
4427
4430
  readonly where: {
4428
4431
  readonly type: "object";
4429
4432
  readonly required: readonly ["metadata"];
4430
4433
  readonly properties: {
4431
4434
  readonly metadata: {
4432
4435
  readonly type: "object";
4433
- readonly additionalProperties: {
4434
- readonly type: "string";
4435
- };
4436
+ readonly additionalProperties: {};
4436
4437
  };
4437
4438
  };
4438
4439
  readonly additionalProperties: false;
@@ -4453,3 +4454,14 @@ export declare const scorecardConfigSchema: {
4453
4454
  };
4454
4455
  };
4455
4456
  };
4457
+ export declare const scorecardsConfigSchema: {
4458
+ readonly type: "object";
4459
+ readonly additionalProperties: true;
4460
+ readonly required: readonly [];
4461
+ readonly properties: {
4462
+ readonly test: {
4463
+ readonly type: "boolean";
4464
+ readonly default: true;
4465
+ };
4466
+ };
4467
+ };
package/lib/ex-theme-config-schemas.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
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.aiAssistantSchema = 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;
3
+ exports.scorecardsConfigSchema = 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.aiAssistantSchema = 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
6
  const common_1 = require("./common");
@@ -257,7 +257,7 @@ exports.aiAssistantSchema = {
257
257
  inputIcon: {
258
258
  type: 'string',
259
259
  enum: ['chat', 'sparkles', 'redocly'],
260
- default: 'redocly',
260
+ default: 'sparkles',
261
261
  },
262
262
  },
263
263
  additionalProperties: false,
@@ -280,9 +280,9 @@ const navigationActionsConfigSchema = {
280
280
  type: 'array',
281
281
  items: {
282
282
  type: 'string',
283
- enum: ['copy', 'view', 'chatgpt', 'claude'],
283
+ enum: ['copy', 'view', 'chatgpt', 'claude', 'docs-mcp-cursor', 'docs-mcp-vscode'],
284
284
  },
285
- default: ['copy', 'view', 'chatgpt', 'claude'],
285
+ default: ['copy', 'view', 'chatgpt', 'claude', 'docs-mcp-cursor', 'docs-mcp-vscode'],
286
286
  } }),
287
287
  additionalProperties: false,
288
288
  };
@@ -639,11 +639,12 @@ exports.scorecardConfigSchema = {
639
639
  properties: {
640
640
  minimumLevel: { type: 'string' },
641
641
  rules: { type: 'object', additionalProperties: true },
642
+ ignore: { type: 'boolean' },
642
643
  where: {
643
644
  type: 'object',
644
645
  required: ['metadata'],
645
646
  properties: {
646
- metadata: { type: 'object', additionalProperties: { type: 'string' } },
647
+ metadata: { type: 'object', additionalProperties: {} },
647
648
  },
648
649
  additionalProperties: false,
649
650
  },
@@ -658,4 +659,12 @@ exports.scorecardConfigSchema = {
658
659
  fromProjectUrl: { type: 'string', format: 'uri' },
659
660
  },
660
661
  };
662
+ exports.scorecardsConfigSchema = {
663
+ type: 'object',
664
+ additionalProperties: true,
665
+ required: [],
666
+ properties: {
667
+ test: { type: 'boolean', default: true },
668
+ },
669
+ };
661
670
  //# sourceMappingURL=ex-theme-config-schemas.js.map
package/lib/graphql-config-schema.d.ts CHANGED
@@ -134,6 +134,70 @@ export declare const graphqlConfigSchema: {
134
134
  };
135
135
  readonly additionalProperties: false;
136
136
  };
137
+ readonly servers: {
138
+ readonly type: "array";
139
+ readonly items: {
140
+ readonly type: "object";
141
+ readonly properties: {
142
+ readonly url: {
143
+ readonly type: "string";
144
+ };
145
+ readonly description: {
146
+ readonly type: "string";
147
+ };
148
+ readonly variables: {
149
+ readonly type: "object";
150
+ readonly additionalProperties: true;
151
+ };
152
+ };
153
+ readonly required: readonly ["url"];
154
+ };
155
+ };
156
+ readonly info: {
157
+ readonly type: "object";
158
+ readonly properties: {
159
+ readonly title: {
160
+ readonly type: "string";
161
+ };
162
+ readonly description: {
163
+ readonly type: "string";
164
+ };
165
+ readonly summary: {
166
+ readonly type: "string";
167
+ };
168
+ readonly version: {
169
+ readonly type: "string";
170
+ };
171
+ readonly termsOfService: {
172
+ readonly type: "string";
173
+ };
174
+ readonly contact: {
175
+ readonly type: "object";
176
+ readonly properties: {
177
+ readonly name: {
178
+ readonly type: "string";
179
+ };
180
+ readonly email: {
181
+ readonly type: "string";
182
+ };
183
+ readonly url: {
184
+ readonly type: "string";
185
+ };
186
+ };
187
+ };
188
+ readonly license: {
189
+ readonly type: "object";
190
+ readonly properties: {
191
+ readonly name: {
192
+ readonly type: "string";
193
+ };
194
+ readonly url: {
195
+ readonly type: "string";
196
+ };
197
+ };
198
+ };
199
+ };
200
+ };
137
201
  readonly sidebar: {
138
202
  readonly type: "object";
139
203
  readonly properties: {
package/lib/graphql-config-schema.js CHANGED
@@ -62,6 +62,70 @@ exports.graphqlConfigSchema = {
62
62
  properties: Object.assign({}, menuGroupingConfig.properties),
63
63
  additionalProperties: false,
64
64
  },
65
+ servers: {
66
+ type: 'array',
67
+ items: {
68
+ type: 'object',
69
+ properties: {
70
+ url: {
71
+ type: 'string',
72
+ },
73
+ description: {
74
+ type: 'string',
75
+ },
76
+ variables: {
77
+ type: 'object',
78
+ additionalProperties: true,
79
+ },
80
+ },
81
+ required: ['url'],
82
+ },
83
+ },
84
+ info: {
85
+ type: 'object',
86
+ properties: {
87
+ title: {
88
+ type: 'string',
89
+ },
90
+ description: {
91
+ type: 'string',
92
+ },
93
+ summary: {
94
+ type: 'string',
95
+ },
96
+ version: {
97
+ type: 'string',
98
+ },
99
+ termsOfService: {
100
+ type: 'string',
101
+ },
102
+ contact: {
103
+ type: 'object',
104
+ properties: {
105
+ name: {
106
+ type: 'string',
107
+ },
108
+ email: {
109
+ type: 'string',
110
+ },
111
+ url: {
112
+ type: 'string',
113
+ },
114
+ },
115
+ },
116
+ license: {
117
+ type: 'object',
118
+ properties: {
119
+ name: {
120
+ type: 'string',
121
+ },
122
+ url: {
123
+ type: 'string',
124
+ },
125
+ },
126
+ },
127
+ },
128
+ },
65
129
  sidebar: {
66
130
  type: 'object',
67
131
  properties: {
package/lib/product-override-schema.d.ts CHANGED
@@ -4881,6 +4881,70 @@ export declare const productConfigOverrideSchema: {
4881
4881
  };
4882
4882
  readonly additionalProperties: false;
4883
4883
  };
4884
+ readonly servers: {
4885
+ readonly type: "array";
4886
+ readonly items: {
4887
+ readonly type: "object";
4888
+ readonly properties: {
4889
+ readonly url: {
4890
+ readonly type: "string";
4891
+ };
4892
+ readonly description: {
4893
+ readonly type: "string";
4894
+ };
4895
+ readonly variables: {
4896
+ readonly type: "object";
4897
+ readonly additionalProperties: true;
4898
+ };
4899
+ };
4900
+ readonly required: readonly ["url"];
4901
+ };
4902
+ };
4903
+ readonly info: {
4904
+ readonly type: "object";
4905
+ readonly properties: {
4906
+ readonly title: {
4907
+ readonly type: "string";
4908
+ };
4909
+ readonly description: {
4910
+ readonly type: "string";
4911
+ };
4912
+ readonly summary: {
4913
+ readonly type: "string";
4914
+ };
4915
+ readonly version: {
4916
+ readonly type: "string";
4917
+ };
4918
+ readonly termsOfService: {
4919
+ readonly type: "string";
4920
+ };
4921
+ readonly contact: {
4922
+ readonly type: "object";
4923
+ readonly properties: {
4924
+ readonly name: {
4925
+ readonly type: "string";
4926
+ };
4927
+ readonly email: {
4928
+ readonly type: "string";
4929
+ };
4930
+ readonly url: {
4931
+ readonly type: "string";
4932
+ };
4933
+ };
4934
+ };
4935
+ readonly license: {
4936
+ readonly type: "object";
4937
+ readonly properties: {
4938
+ readonly name: {
4939
+ readonly type: "string";
4940
+ };
4941
+ readonly url: {
4942
+ readonly type: "string";
4943
+ };
4944
+ };
4945
+ };
4946
+ };
4947
+ };
4884
4948
  readonly sidebar: {
4885
4949
  readonly type: "object";
4886
4950
  readonly properties: {
@@ -7141,6 +7205,70 @@ export declare const productConfigOverrideSchema: {
7141
7205
  };
7142
7206
  readonly additionalProperties: false;
7143
7207
  };
7208
+ readonly servers: {
7209
+ readonly type: "array";
7210
+ readonly items: {
7211
+ readonly type: "object";
7212
+ readonly properties: {
7213
+ readonly url: {
7214
+ readonly type: "string";
7215
+ };
7216
+ readonly description: {
7217
+ readonly type: "string";
7218
+ };
7219
+ readonly variables: {
7220
+ readonly type: "object";
7221
+ readonly additionalProperties: true;
7222
+ };
7223
+ };
7224
+ readonly required: readonly ["url"];
7225
+ };
7226
+ };
7227
+ readonly info: {
7228
+ readonly type: "object";
7229
+ readonly properties: {
7230
+ readonly title: {
7231
+ readonly type: "string";
7232
+ };
7233
+ readonly description: {
7234
+ readonly type: "string";
7235
+ };
7236
+ readonly summary: {
7237
+ readonly type: "string";
7238
+ };
7239
+ readonly version: {
7240
+ readonly type: "string";
7241
+ };
7242
+ readonly termsOfService: {
7243
+ readonly type: "string";
7244
+ };
7245
+ readonly contact: {
7246
+ readonly type: "object";
7247
+ readonly properties: {
7248
+ readonly name: {
7249
+ readonly type: "string";
7250
+ };
7251
+ readonly email: {
7252
+ readonly type: "string";
7253
+ };
7254
+ readonly url: {
7255
+ readonly type: "string";
7256
+ };
7257
+ };
7258
+ };
7259
+ readonly license: {
7260
+ readonly type: "object";
7261
+ readonly properties: {
7262
+ readonly name: {
7263
+ readonly type: "string";
7264
+ };
7265
+ readonly url: {
7266
+ readonly type: "string";
7267
+ };
7268
+ };
7269
+ };
7270
+ };
7271
+ };
7144
7272
  readonly sidebar: {
7145
7273
  readonly type: "object";
7146
7274
  readonly properties: {