@redocly/config 0.50.1 → 0.52.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 (47) hide show
  1. package/lib/asyncapi-config-schema.d.ts +10 -27
  2. package/lib/common.d.ts +120 -120
  3. package/lib/constants/identity-provider-slug.d.ts +2 -1
  4. package/lib/constants/shared.d.ts +1 -0
  5. package/lib/default-theme-config-schema.d.ts +520 -621
  6. package/lib/entities-catalog-config-schema.d.ts +60 -72
  7. package/lib/entities-catalog-entity-file-schema.d.ts +74 -67
  8. package/lib/ex-theme-config-schemas.d.ts +266 -354
  9. package/lib/feedback-config-schema.d.ts +9 -29
  10. package/lib/graphql-config-schema.d.ts +11 -28
  11. package/lib/index.d.ts +2 -2
  12. package/lib/index.js +1 -1
  13. package/lib/product-override-schema.d.ts +4203 -4461
  14. package/lib/redoc-config-schema.d.ts +14 -33
  15. package/lib/reference-docs-config-schema.d.ts +14 -10
  16. package/lib/reunite-config-schema.d.ts +11 -12
  17. package/lib/root-config-schema.d.ts +22685 -17296
  18. package/lib/scorecards-config-schema.d.ts +168 -108
  19. package/lib/types/config-types.d.ts +2 -1
  20. package/lib/types/index.d.ts +1 -0
  21. package/lib/types/json-schema-types.d.ts +69 -0
  22. package/lib/types/portal-shared-types.d.ts +3 -0
  23. package/lib-esm/asyncapi-config-schema.d.ts +10 -27
  24. package/lib-esm/common.d.ts +120 -120
  25. package/lib-esm/constants/identity-provider-slug.d.ts +2 -1
  26. package/lib-esm/constants/shared.d.ts +1 -0
  27. package/lib-esm/default-theme-config-schema.d.ts +520 -621
  28. package/lib-esm/entities-catalog-config-schema.d.ts +60 -72
  29. package/lib-esm/entities-catalog-entity-file-schema.d.ts +74 -67
  30. package/lib-esm/ex-theme-config-schemas.d.ts +266 -354
  31. package/lib-esm/feedback-config-schema.d.ts +9 -29
  32. package/lib-esm/graphql-config-schema.d.ts +11 -28
  33. package/lib-esm/index.d.ts +2 -2
  34. package/lib-esm/index.js +1 -1
  35. package/lib-esm/product-override-schema.d.ts +4203 -4461
  36. package/lib-esm/redoc-config-schema.d.ts +14 -33
  37. package/lib-esm/reference-docs-config-schema.d.ts +14 -10
  38. package/lib-esm/reunite-config-schema.d.ts +11 -12
  39. package/lib-esm/root-config-schema.d.ts +22685 -17296
  40. package/lib-esm/scorecards-config-schema.d.ts +168 -108
  41. package/lib-esm/types/config-types.d.ts +2 -1
  42. package/lib-esm/types/index.d.ts +1 -0
  43. package/lib-esm/types/json-schema-types.d.ts +69 -0
  44. package/lib-esm/types/portal-shared-types.d.ts +3 -0
  45. package/package.json +2 -2
  46. package/lib/remove-property-recursively.d.ts +0 -5
  47. package/lib-esm/remove-property-recursively.d.ts +0 -5
@@ -3,12 +3,10 @@ export declare const reasonsSettings: {
3
3
  readonly properties: {
4
4
  readonly hide: {
5
5
  readonly type: 'boolean';
6
- readonly default: false;
7
6
  };
8
7
  readonly component: {
9
8
  readonly type: 'string';
10
- readonly enum: readonly ['radio', 'checkbox'];
11
- readonly default: 'checkbox';
9
+ readonly enum: readonly ["radio", "checkbox"];
12
10
  };
13
11
  readonly label: {
14
12
  readonly type: 'string';
@@ -27,7 +25,6 @@ export declare const optionalEmailSettings: {
27
25
  readonly properties: {
28
26
  readonly hide: {
29
27
  readonly type: 'boolean';
30
- readonly default: false;
31
28
  };
32
29
  readonly label: {
33
30
  readonly type: 'string';
@@ -43,12 +40,10 @@ export declare const feedbackConfigSchema: {
43
40
  readonly properties: {
44
41
  readonly hide: {
45
42
  readonly type: 'boolean';
46
- readonly default: false;
47
43
  };
48
44
  readonly type: {
49
45
  readonly type: 'string';
50
- readonly enum: readonly ['rating', 'sentiment', 'comment', 'reasons', 'mood', 'scale'];
51
- readonly default: 'sentiment';
46
+ readonly enum: readonly ["rating", "sentiment", "comment", "reasons", "mood", "scale"];
52
47
  };
53
48
  readonly settings: {
54
49
  readonly type: 'object';
@@ -64,8 +59,7 @@ export declare const feedbackConfigSchema: {
64
59
  };
65
60
  readonly component: {
66
61
  readonly type: 'string';
67
- readonly enum: readonly ['radio', 'checkbox'];
68
- readonly default: 'checkbox';
62
+ readonly enum: readonly ["radio", "checkbox"];
69
63
  };
70
64
  readonly items: {
71
65
  readonly type: 'array';
@@ -85,12 +79,10 @@ export declare const feedbackConfigSchema: {
85
79
  readonly properties: {
86
80
  readonly hide: {
87
81
  readonly type: 'boolean';
88
- readonly default: false;
89
82
  };
90
83
  readonly component: {
91
84
  readonly type: 'string';
92
- readonly enum: readonly ['radio', 'checkbox'];
93
- readonly default: 'checkbox';
85
+ readonly enum: readonly ["radio", "checkbox"];
94
86
  };
95
87
  readonly label: {
96
88
  readonly type: 'string';
@@ -106,12 +98,10 @@ export declare const feedbackConfigSchema: {
106
98
  readonly properties: {
107
99
  readonly hide: {
108
100
  readonly type: 'boolean';
109
- readonly default: false;
110
101
  };
111
102
  readonly component: {
112
103
  readonly type: 'string';
113
- readonly enum: readonly ['radio', 'checkbox'];
114
- readonly default: 'checkbox';
104
+ readonly enum: readonly ["radio", "checkbox"];
115
105
  };
116
106
  readonly label: {
117
107
  readonly type: 'string';
@@ -130,12 +120,10 @@ export declare const feedbackConfigSchema: {
130
120
  readonly properties: {
131
121
  readonly hide: {
132
122
  readonly type: 'boolean';
133
- readonly default: false;
134
123
  };
135
124
  readonly component: {
136
125
  readonly type: 'string';
137
- readonly enum: readonly ['radio', 'checkbox'];
138
- readonly default: 'checkbox';
126
+ readonly enum: readonly ["radio", "checkbox"];
139
127
  };
140
128
  readonly label: {
141
129
  readonly type: 'string';
@@ -154,12 +142,10 @@ export declare const feedbackConfigSchema: {
154
142
  readonly properties: {
155
143
  readonly hide: {
156
144
  readonly type: 'boolean';
157
- readonly default: false;
158
145
  };
159
146
  readonly component: {
160
147
  readonly type: 'string';
161
- readonly enum: readonly ['radio', 'checkbox'];
162
- readonly default: 'checkbox';
148
+ readonly enum: readonly ["radio", "checkbox"];
163
149
  };
164
150
  readonly label: {
165
151
  readonly type: 'string';
@@ -178,12 +164,10 @@ export declare const feedbackConfigSchema: {
178
164
  readonly properties: {
179
165
  readonly hide: {
180
166
  readonly type: 'boolean';
181
- readonly default: false;
182
167
  };
183
168
  readonly component: {
184
169
  readonly type: 'string';
185
- readonly enum: readonly ['radio', 'checkbox'];
186
- readonly default: 'checkbox';
170
+ readonly enum: readonly ["radio", "checkbox"];
187
171
  };
188
172
  readonly label: {
189
173
  readonly type: 'string';
@@ -202,12 +186,10 @@ export declare const feedbackConfigSchema: {
202
186
  readonly properties: {
203
187
  readonly hide: {
204
188
  readonly type: 'boolean';
205
- readonly default: false;
206
189
  };
207
190
  readonly component: {
208
191
  readonly type: 'string';
209
- readonly enum: readonly ['radio', 'checkbox'];
210
- readonly default: 'checkbox';
192
+ readonly enum: readonly ["radio", "checkbox"];
211
193
  };
212
194
  readonly label: {
213
195
  readonly type: 'string';
@@ -229,7 +211,6 @@ export declare const feedbackConfigSchema: {
229
211
  readonly properties: {
230
212
  readonly hide: {
231
213
  readonly type: 'boolean';
232
- readonly default: false;
233
214
  };
234
215
  readonly label: {
235
216
  readonly type: 'string';
@@ -257,7 +238,6 @@ export declare const feedbackConfigSchema: {
257
238
  readonly properties: {
258
239
  readonly hide: {
259
240
  readonly type: 'boolean';
260
- readonly default: false;
261
241
  };
262
242
  readonly label: {
263
243
  readonly type: 'string';
@@ -124,7 +124,7 @@ export declare const graphqlConfigSchema: {
124
124
  readonly additionalProperties: false;
125
125
  };
126
126
  };
127
- readonly required: readonly ['name'];
127
+ readonly required: readonly ["name"];
128
128
  readonly additionalProperties: false;
129
129
  };
130
130
  };
@@ -154,7 +154,7 @@ export declare const graphqlConfigSchema: {
154
154
  readonly type: 'string';
155
155
  };
156
156
  };
157
- readonly required: readonly ['url'];
157
+ readonly required: readonly ["url"];
158
158
  readonly additionalProperties: false;
159
159
  };
160
160
  };
@@ -204,12 +204,10 @@ export declare const graphqlConfigSchema: {
204
204
  readonly properties: {
205
205
  readonly hide: {
206
206
  readonly type: 'boolean';
207
- readonly default: false;
208
207
  };
209
208
  readonly type: {
210
209
  readonly type: 'string';
211
- readonly enum: readonly ['rating', 'sentiment', 'comment', 'reasons', 'mood', 'scale'];
212
- readonly default: 'sentiment';
210
+ readonly enum: readonly ["rating", "sentiment", "comment", "reasons", "mood", "scale"];
213
211
  };
214
212
  readonly settings: {
215
213
  readonly type: 'object';
@@ -225,8 +223,7 @@ export declare const graphqlConfigSchema: {
225
223
  };
226
224
  readonly component: {
227
225
  readonly type: 'string';
228
- readonly enum: readonly ['radio', 'checkbox'];
229
- readonly default: 'checkbox';
226
+ readonly enum: readonly ["radio", "checkbox"];
230
227
  };
231
228
  readonly items: {
232
229
  readonly type: 'array';
@@ -246,12 +243,10 @@ export declare const graphqlConfigSchema: {
246
243
  readonly properties: {
247
244
  readonly hide: {
248
245
  readonly type: 'boolean';
249
- readonly default: false;
250
246
  };
251
247
  readonly component: {
252
248
  readonly type: 'string';
253
- readonly enum: readonly ['radio', 'checkbox'];
254
- readonly default: 'checkbox';
249
+ readonly enum: readonly ["radio", "checkbox"];
255
250
  };
256
251
  readonly label: {
257
252
  readonly type: 'string';
@@ -267,12 +262,10 @@ export declare const graphqlConfigSchema: {
267
262
  readonly properties: {
268
263
  readonly hide: {
269
264
  readonly type: 'boolean';
270
- readonly default: false;
271
265
  };
272
266
  readonly component: {
273
267
  readonly type: 'string';
274
- readonly enum: readonly ['radio', 'checkbox'];
275
- readonly default: 'checkbox';
268
+ readonly enum: readonly ["radio", "checkbox"];
276
269
  };
277
270
  readonly label: {
278
271
  readonly type: 'string';
@@ -291,12 +284,10 @@ export declare const graphqlConfigSchema: {
291
284
  readonly properties: {
292
285
  readonly hide: {
293
286
  readonly type: 'boolean';
294
- readonly default: false;
295
287
  };
296
288
  readonly component: {
297
289
  readonly type: 'string';
298
- readonly enum: readonly ['radio', 'checkbox'];
299
- readonly default: 'checkbox';
290
+ readonly enum: readonly ["radio", "checkbox"];
300
291
  };
301
292
  readonly label: {
302
293
  readonly type: 'string';
@@ -315,12 +306,10 @@ export declare const graphqlConfigSchema: {
315
306
  readonly properties: {
316
307
  readonly hide: {
317
308
  readonly type: 'boolean';
318
- readonly default: false;
319
309
  };
320
310
  readonly component: {
321
311
  readonly type: 'string';
322
- readonly enum: readonly ['radio', 'checkbox'];
323
- readonly default: 'checkbox';
312
+ readonly enum: readonly ["radio", "checkbox"];
324
313
  };
325
314
  readonly label: {
326
315
  readonly type: 'string';
@@ -339,12 +328,10 @@ export declare const graphqlConfigSchema: {
339
328
  readonly properties: {
340
329
  readonly hide: {
341
330
  readonly type: 'boolean';
342
- readonly default: false;
343
331
  };
344
332
  readonly component: {
345
333
  readonly type: 'string';
346
- readonly enum: readonly ['radio', 'checkbox'];
347
- readonly default: 'checkbox';
334
+ readonly enum: readonly ["radio", "checkbox"];
348
335
  };
349
336
  readonly label: {
350
337
  readonly type: 'string';
@@ -363,12 +350,10 @@ export declare const graphqlConfigSchema: {
363
350
  readonly properties: {
364
351
  readonly hide: {
365
352
  readonly type: 'boolean';
366
- readonly default: false;
367
353
  };
368
354
  readonly component: {
369
355
  readonly type: 'string';
370
- readonly enum: readonly ['radio', 'checkbox'];
371
- readonly default: 'checkbox';
356
+ readonly enum: readonly ["radio", "checkbox"];
372
357
  };
373
358
  readonly label: {
374
359
  readonly type: 'string';
@@ -390,7 +375,6 @@ export declare const graphqlConfigSchema: {
390
375
  readonly properties: {
391
376
  readonly hide: {
392
377
  readonly type: 'boolean';
393
- readonly default: false;
394
378
  };
395
379
  readonly label: {
396
380
  readonly type: 'string';
@@ -418,7 +402,6 @@ export declare const graphqlConfigSchema: {
418
402
  readonly properties: {
419
403
  readonly hide: {
420
404
  readonly type: 'boolean';
421
- readonly default: false;
422
405
  };
423
406
  readonly label: {
424
407
  readonly type: 'string';
@@ -437,7 +420,7 @@ export declare const graphqlConfigSchema: {
437
420
  };
438
421
  readonly layout: {
439
422
  readonly type: 'string';
440
- readonly enum: readonly ['stacked', 'three-panel'];
423
+ readonly enum: readonly ["stacked", "three-panel"];
441
424
  };
442
425
  readonly showBuiltInScalars: {
443
426
  readonly type: 'boolean';
package/lib/index.d.ts CHANGED
@@ -3,8 +3,8 @@ export { rbacConfigSchema, rootRedoclyConfigSchema } from './root-config-schema.
3
3
  export { redocConfigSchema } from './redoc-config-schema.js';
4
4
  export * from './types/index.js';
5
5
  export * from './common.js';
6
- export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, } from './constants/shared.js';
6
+ export { ApigeeDevOnboardingIntegrationAuthType, AuthProviderType, DEFAULT_TEAM_CLAIM_NAME, LayoutVariant, REDOCLY_TEAMS_RBAC, REDOCLY_ROUTE_RBAC, DEFAULT_SEARCH_ENGINE, } from './constants/shared.js';
7
7
  export { CONFIG_NODE_TYPE_NAMES } from './constants/config.js';
8
8
  export { ENTITY_RELATION_TYPES, ENTITY_NODE_TYPE_NAMES } from './constants/entities.js';
9
- export { IDENTITY_PROVIDER_RESERVED_MESSAGE, IDENTITY_PROVIDER_RESERVED_SLUGS, IDENTITY_PROVIDER_SLUG_MAX_LENGTH, IDENTITY_PROVIDER_SLUG_MAX_LENGTH_MESSAGE, IDENTITY_PROVIDER_SLUG_MESSAGE, IDENTITY_PROVIDER_SLUG_PATTERN, IDENTITY_PROVIDER_SLUG_REGEX, } from './constants/identity-provider-slug.js';
9
+ export { IDENTITY_PROVIDER_RESERVED_MESSAGE, IDENTITY_PROVIDER_RESERVED_SLUGS, IDENTITY_PROVIDER_SLUG_MAX_LENGTH, IDENTITY_PROVIDER_SLUG_MAX_LENGTH_MESSAGE, IDENTITY_PROVIDER_SLUG_MESSAGE, IDENTITY_PROVIDER_SLUG_PATTERN, IDENTITY_PROVIDER_SLUG_REGEX, REDOCLY_IDP_SLUG, } from './constants/identity-provider-slug.js';
10
10
  export * from './entities-catalog-entity-file-schema.js';