@redocly/config 0.49.0 → 0.50.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 (41) hide show
  1. package/lib/asyncapi-config-schema.d.ts +106 -106
  2. package/lib/common.d.ts +158 -135
  3. package/lib/constants/config.d.ts +10 -10
  4. package/lib/constants/entities.d.ts +21 -43
  5. package/lib/constants/identity-provider-slug.d.ts +8 -0
  6. package/lib/default-theme-config-schema.d.ts +3534 -3488
  7. package/lib/entities-catalog-config-schema.d.ts +469 -469
  8. package/lib/entities-catalog-entity-file-schema.d.ts +441 -441
  9. package/lib/ex-theme-config-schemas.d.ts +3020 -2997
  10. package/lib/feedback-config-schema.d.ts +99 -99
  11. package/lib/graphql-config-schema.d.ts +165 -165
  12. package/lib/index.d.ts +1 -0
  13. package/lib/index.js +1 -1
  14. package/lib/product-override-schema.d.ts +11541 -11518
  15. package/lib/redoc-config-schema.d.ts +155 -155
  16. package/lib/reference-docs-config-schema.d.ts +481 -481
  17. package/lib/reunite-config-schema.d.ts +41 -41
  18. package/lib/root-config-schema.d.ts +52200 -51598
  19. package/lib/scorecards-config-schema.d.ts +405 -405
  20. package/lib/types/config-types.d.ts +5 -1
  21. package/lib-esm/asyncapi-config-schema.d.ts +106 -106
  22. package/lib-esm/common.d.ts +158 -135
  23. package/lib-esm/constants/config.d.ts +10 -10
  24. package/lib-esm/constants/entities.d.ts +21 -43
  25. package/lib-esm/constants/identity-provider-slug.d.ts +8 -0
  26. package/lib-esm/default-theme-config-schema.d.ts +3534 -3488
  27. package/lib-esm/entities-catalog-config-schema.d.ts +469 -469
  28. package/lib-esm/entities-catalog-entity-file-schema.d.ts +441 -441
  29. package/lib-esm/ex-theme-config-schemas.d.ts +3020 -2997
  30. package/lib-esm/feedback-config-schema.d.ts +99 -99
  31. package/lib-esm/graphql-config-schema.d.ts +165 -165
  32. package/lib-esm/index.d.ts +1 -0
  33. package/lib-esm/index.js +1 -1
  34. package/lib-esm/product-override-schema.d.ts +11541 -11518
  35. package/lib-esm/redoc-config-schema.d.ts +155 -155
  36. package/lib-esm/reference-docs-config-schema.d.ts +481 -481
  37. package/lib-esm/reunite-config-schema.d.ts +41 -41
  38. package/lib-esm/root-config-schema.d.ts +52200 -51598
  39. package/lib-esm/scorecards-config-schema.d.ts +405 -405
  40. package/lib-esm/types/config-types.d.ts +5 -1
  41. package/package.json +9 -9
package/lib/types/config-types.d.ts CHANGED
@@ -33,7 +33,7 @@ export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
33
33
  export type ScorecardsConfig = FromSchema<typeof scorecardsConfigSchema>;
34
34
  export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
35
35
  type RootRedoclyConfig = FromSchema<typeof rootRedoclyConfigSchema>;
36
- export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' | 'requiresLogin' | 'sso' | 'residency' | 'logoutReturnUrl'> & {
36
+ export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' | 'requiresLogin' | 'sso' | 'idps' | 'residency' | 'logoutReturnUrl'> & {
37
37
  /**
38
38
  * @deprecated Should use `access.rbac` instead
39
39
  */
@@ -46,6 +46,10 @@ export type RedoclyConfig = Omit<RootRedoclyConfig, 'theme' | 'apis' | 'rbac' |
46
46
  * @deprecated Should use `access.sso` instead
47
47
  */
48
48
  sso?: RootRedoclyConfig['sso'];
49
+ /**
50
+ * @deprecated Should use `access.idps` instead
51
+ */
52
+ idps?: RootRedoclyConfig['idps'];
49
53
  /**
50
54
  * @deprecated Should use `access.residency` instead
51
55
  */
package/lib-esm/asyncapi-config-schema.d.ts CHANGED
@@ -1,286 +1,286 @@
1
1
  export declare const asyncapiConfigSchema: {
2
- readonly type: "object";
2
+ readonly type: 'object';
3
3
  readonly properties: {
4
4
  readonly downloadUrls: {
5
- readonly type: "array";
5
+ readonly type: 'array';
6
6
  readonly items: {
7
- readonly type: "object";
7
+ readonly type: 'object';
8
8
  readonly properties: {
9
9
  readonly title: {
10
- readonly type: "string";
10
+ readonly type: 'string';
11
11
  };
12
12
  readonly url: {
13
- readonly type: "string";
13
+ readonly type: 'string';
14
14
  };
15
15
  };
16
- readonly required: readonly ["url"];
16
+ readonly required: readonly ['url'];
17
17
  readonly additionalProperties: false;
18
18
  };
19
19
  };
20
20
  readonly apiLogo: {
21
- readonly type: "object";
21
+ readonly type: 'object';
22
22
  readonly properties: {
23
23
  readonly imageUrl: {
24
- readonly type: "string";
24
+ readonly type: 'string';
25
25
  };
26
26
  readonly href: {
27
- readonly type: "string";
27
+ readonly type: 'string';
28
28
  };
29
29
  readonly altText: {
30
- readonly type: "string";
30
+ readonly type: 'string';
31
31
  };
32
32
  readonly backgroundColor: {
33
- readonly type: "string";
33
+ readonly type: 'string';
34
34
  };
35
35
  };
36
36
  };
37
37
  readonly jsonSamplesDepth: {
38
- readonly type: "number";
38
+ readonly type: 'number';
39
39
  };
40
40
  readonly samplesMaxInlineArgs: {
41
- readonly type: "number";
41
+ readonly type: 'number';
42
42
  };
43
43
  readonly fieldExpandLevel: {
44
- readonly type: "number";
44
+ readonly type: 'number';
45
45
  };
46
46
  readonly baseUrlPath: {
47
- readonly type: "string";
47
+ readonly type: 'string';
48
48
  };
49
49
  readonly metadata: {
50
- readonly type: "object";
50
+ readonly type: 'object';
51
51
  readonly properties: {
52
52
  readonly apiId: {
53
- readonly type: "string";
53
+ readonly type: 'string';
54
54
  };
55
55
  };
56
56
  readonly additionalProperties: true;
57
57
  };
58
58
  readonly feedback: {
59
- readonly type: "object";
59
+ readonly type: 'object';
60
60
  readonly properties: {
61
61
  readonly hide: {
62
- readonly type: "boolean";
62
+ readonly type: 'boolean';
63
63
  readonly default: false;
64
64
  };
65
65
  readonly type: {
66
- readonly type: "string";
67
- readonly enum: readonly ["rating", "sentiment", "comment", "reasons", "mood", "scale"];
68
- readonly default: "sentiment";
66
+ readonly type: 'string';
67
+ readonly enum: readonly ['rating', 'sentiment', 'comment', 'reasons', 'mood', 'scale'];
68
+ readonly default: 'sentiment';
69
69
  };
70
70
  readonly settings: {
71
- readonly type: "object";
71
+ readonly type: 'object';
72
72
  readonly properties: {
73
73
  readonly label: {
74
- readonly type: "string";
74
+ readonly type: 'string';
75
75
  };
76
76
  readonly submitText: {
77
- readonly type: "string";
77
+ readonly type: 'string';
78
78
  };
79
79
  readonly buttonText: {
80
- readonly type: "string";
80
+ readonly type: 'string';
81
81
  };
82
82
  readonly component: {
83
- readonly type: "string";
84
- readonly enum: readonly ["radio", "checkbox"];
85
- readonly default: "checkbox";
83
+ readonly type: 'string';
84
+ readonly enum: readonly ['radio', 'checkbox'];
85
+ readonly default: 'checkbox';
86
86
  };
87
87
  readonly items: {
88
- readonly type: "array";
88
+ readonly type: 'array';
89
89
  readonly items: {
90
- readonly type: "string";
90
+ readonly type: 'string';
91
91
  };
92
92
  readonly minItems: 1;
93
93
  };
94
94
  readonly leftScaleLabel: {
95
- readonly type: "string";
95
+ readonly type: 'string';
96
96
  };
97
97
  readonly rightScaleLabel: {
98
- readonly type: "string";
98
+ readonly type: 'string';
99
99
  };
100
100
  readonly reasons: {
101
- readonly type: "object";
101
+ readonly type: 'object';
102
102
  readonly properties: {
103
+ readonly hide: {
104
+ readonly type: 'boolean';
105
+ readonly default: false;
106
+ };
107
+ readonly component: {
108
+ readonly type: 'string';
109
+ readonly enum: readonly ['radio', 'checkbox'];
110
+ readonly default: 'checkbox';
111
+ };
112
+ readonly label: {
113
+ readonly type: 'string';
114
+ };
115
+ readonly items: {
116
+ readonly type: 'array';
117
+ readonly items: {
118
+ readonly type: 'string';
119
+ };
120
+ };
103
121
  readonly like: {
104
- readonly type: "object";
122
+ readonly type: 'object';
105
123
  readonly properties: {
106
124
  readonly hide: {
107
- readonly type: "boolean";
125
+ readonly type: 'boolean';
108
126
  readonly default: false;
109
127
  };
110
128
  readonly component: {
111
- readonly type: "string";
112
- readonly enum: readonly ["radio", "checkbox"];
113
- readonly default: "checkbox";
129
+ readonly type: 'string';
130
+ readonly enum: readonly ['radio', 'checkbox'];
131
+ readonly default: 'checkbox';
114
132
  };
115
133
  readonly label: {
116
- readonly type: "string";
134
+ readonly type: 'string';
117
135
  };
118
136
  readonly items: {
119
- readonly type: "array";
137
+ readonly type: 'array';
120
138
  readonly items: {
121
- readonly type: "string";
139
+ readonly type: 'string';
122
140
  };
123
141
  };
124
142
  };
125
143
  readonly additionalProperties: false;
126
144
  };
127
145
  readonly dislike: {
128
- readonly type: "object";
146
+ readonly type: 'object';
129
147
  readonly properties: {
130
148
  readonly hide: {
131
- readonly type: "boolean";
149
+ readonly type: 'boolean';
132
150
  readonly default: false;
133
151
  };
134
152
  readonly component: {
135
- readonly type: "string";
136
- readonly enum: readonly ["radio", "checkbox"];
137
- readonly default: "checkbox";
153
+ readonly type: 'string';
154
+ readonly enum: readonly ['radio', 'checkbox'];
155
+ readonly default: 'checkbox';
138
156
  };
139
157
  readonly label: {
140
- readonly type: "string";
158
+ readonly type: 'string';
141
159
  };
142
160
  readonly items: {
143
- readonly type: "array";
161
+ readonly type: 'array';
144
162
  readonly items: {
145
- readonly type: "string";
163
+ readonly type: 'string';
146
164
  };
147
165
  };
148
166
  };
149
167
  readonly additionalProperties: false;
150
168
  };
151
169
  readonly satisfied: {
152
- readonly type: "object";
170
+ readonly type: 'object';
153
171
  readonly properties: {
154
172
  readonly hide: {
155
- readonly type: "boolean";
173
+ readonly type: 'boolean';
156
174
  readonly default: false;
157
175
  };
158
176
  readonly component: {
159
- readonly type: "string";
160
- readonly enum: readonly ["radio", "checkbox"];
161
- readonly default: "checkbox";
177
+ readonly type: 'string';
178
+ readonly enum: readonly ['radio', 'checkbox'];
179
+ readonly default: 'checkbox';
162
180
  };
163
181
  readonly label: {
164
- readonly type: "string";
182
+ readonly type: 'string';
165
183
  };
166
184
  readonly items: {
167
- readonly type: "array";
185
+ readonly type: 'array';
168
186
  readonly items: {
169
- readonly type: "string";
187
+ readonly type: 'string';
170
188
  };
171
189
  };
172
190
  };
173
191
  readonly additionalProperties: false;
174
192
  };
175
193
  readonly neutral: {
176
- readonly type: "object";
194
+ readonly type: 'object';
177
195
  readonly properties: {
178
196
  readonly hide: {
179
- readonly type: "boolean";
197
+ readonly type: 'boolean';
180
198
  readonly default: false;
181
199
  };
182
200
  readonly component: {
183
- readonly type: "string";
184
- readonly enum: readonly ["radio", "checkbox"];
185
- readonly default: "checkbox";
201
+ readonly type: 'string';
202
+ readonly enum: readonly ['radio', 'checkbox'];
203
+ readonly default: 'checkbox';
186
204
  };
187
205
  readonly label: {
188
- readonly type: "string";
206
+ readonly type: 'string';
189
207
  };
190
208
  readonly items: {
191
- readonly type: "array";
209
+ readonly type: 'array';
192
210
  readonly items: {
193
- readonly type: "string";
211
+ readonly type: 'string';
194
212
  };
195
213
  };
196
214
  };
197
215
  readonly additionalProperties: false;
198
216
  };
199
217
  readonly dissatisfied: {
200
- readonly type: "object";
218
+ readonly type: 'object';
201
219
  readonly properties: {
202
220
  readonly hide: {
203
- readonly type: "boolean";
221
+ readonly type: 'boolean';
204
222
  readonly default: false;
205
223
  };
206
224
  readonly component: {
207
- readonly type: "string";
208
- readonly enum: readonly ["radio", "checkbox"];
209
- readonly default: "checkbox";
225
+ readonly type: 'string';
226
+ readonly enum: readonly ['radio', 'checkbox'];
227
+ readonly default: 'checkbox';
210
228
  };
211
229
  readonly label: {
212
- readonly type: "string";
230
+ readonly type: 'string';
213
231
  };
214
232
  readonly items: {
215
- readonly type: "array";
233
+ readonly type: 'array';
216
234
  readonly items: {
217
- readonly type: "string";
235
+ readonly type: 'string';
218
236
  };
219
237
  };
220
238
  };
221
239
  readonly additionalProperties: false;
222
240
  };
223
- readonly hide: {
224
- readonly type: "boolean";
225
- readonly default: false;
226
- };
227
- readonly component: {
228
- readonly type: "string";
229
- readonly enum: readonly ["radio", "checkbox"];
230
- readonly default: "checkbox";
231
- };
232
- readonly label: {
233
- readonly type: "string";
234
- };
235
- readonly items: {
236
- readonly type: "array";
237
- readonly items: {
238
- readonly type: "string";
239
- };
240
- };
241
241
  };
242
242
  readonly additionalProperties: false;
243
243
  };
244
244
  readonly comment: {
245
- readonly type: "object";
245
+ readonly type: 'object';
246
246
  readonly properties: {
247
247
  readonly hide: {
248
- readonly type: "boolean";
248
+ readonly type: 'boolean';
249
249
  readonly default: false;
250
250
  };
251
251
  readonly label: {
252
- readonly type: "string";
252
+ readonly type: 'string';
253
253
  };
254
254
  readonly likeLabel: {
255
- readonly type: "string";
255
+ readonly type: 'string';
256
256
  };
257
257
  readonly dislikeLabel: {
258
- readonly type: "string";
258
+ readonly type: 'string';
259
259
  };
260
260
  readonly satisfiedLabel: {
261
- readonly type: "string";
261
+ readonly type: 'string';
262
262
  };
263
263
  readonly neutralLabel: {
264
- readonly type: "string";
264
+ readonly type: 'string';
265
265
  };
266
266
  readonly dissatisfiedLabel: {
267
- readonly type: "string";
267
+ readonly type: 'string';
268
268
  };
269
269
  };
270
270
  readonly additionalProperties: false;
271
271
  };
272
272
  readonly optionalEmail: {
273
- readonly type: "object";
273
+ readonly type: 'object';
274
274
  readonly properties: {
275
275
  readonly hide: {
276
- readonly type: "boolean";
276
+ readonly type: 'boolean';
277
277
  readonly default: false;
278
278
  };
279
279
  readonly label: {
280
- readonly type: "string";
280
+ readonly type: 'string';
281
281
  };
282
282
  readonly placeholder: {
283
- readonly type: "string";
283
+ readonly type: 'string';
284
284
  };
285
285
  };
286
286
  readonly additionalProperties: false;
@@ -292,8 +292,8 @@ export declare const asyncapiConfigSchema: {
292
292
  readonly additionalProperties: false;
293
293
  };
294
294
  readonly layout: {
295
- readonly type: "string";
296
- readonly enum: readonly ["stacked", "three-panel"];
295
+ readonly type: 'string';
296
+ readonly enum: readonly ['stacked', 'three-panel'];
297
297
  };
298
298
  };
299
299
  readonly additionalProperties: false;