@redocly/realm 0.89.5 → 0.89.7
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.
- package/CHANGELOG.md +21 -0
- package/dist/.tsbuildinfo +1 -1
- package/dist/client/app/hooks/products/useProducts.d.ts.map +1 -1
- package/dist/client/app/hooks/products/useProducts.js +1 -1
- package/dist/client/app/hooks/products/useProducts.js.map +1 -1
- package/dist/server/config/schema.d.ts +2 -8
- package/dist/server/config/schema.d.ts.map +1 -1
- package/dist/server/config/schema.js.map +1 -1
- package/dist/server/plugins/scorecard/get-scorecard-config.d.ts +4 -25
- package/dist/server/plugins/scorecard/get-scorecard-config.d.ts.map +1 -1
- package/dist/server/store.d.ts +4 -677
- package/dist/server/store.d.ts.map +1 -1
- package/package.json +6 -6
package/dist/server/store.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ import type { ApiRouteDetails, CustomSsoProviderDetails, MiddlewareDetails, Page
|
|
|
4
4
|
import type { ContentProvider } from './content/content-provider';
|
|
5
5
|
import type { RedoclyConfig, RedirectConfig, SsoConfig } from './config/schema';
|
|
6
6
|
import type { MarkdocDeps, MarkdocRawContent } from './plugins/markdown/compiler.js';
|
|
7
|
-
import type { SearchDocument } from '@redocly/theme';
|
|
7
|
+
import type { SearchDocument, ThemeConfig } from '@redocly/theme';
|
|
8
8
|
import type { CommonError } from './utils/index.js';
|
|
9
9
|
export declare const MARKDOC_PARTIALS_DATA_KEY = "markdown/partials";
|
|
10
10
|
type LifecycleEventType = 'template-updated' | 'global-data-updated' | 'shared-data-updated' | 'search-data-updated' | 'routes-updated' | 'build-updated' | 'build-started' | 'errors-updated';
|
|
@@ -81,7 +81,7 @@ export declare class Store {
|
|
|
81
81
|
reloadMarkdocOptions(): Promise<void>;
|
|
82
82
|
get markdocOptions(): {
|
|
83
83
|
partials: any;
|
|
84
|
-
themeConfig:
|
|
84
|
+
themeConfig: {
|
|
85
85
|
frontMatterKeysToResolve?: string[] | undefined;
|
|
86
86
|
partialsFolders?: string[] | undefined;
|
|
87
87
|
lastUpdatedBlock?: {
|
|
@@ -98,24 +98,7 @@ export declare class Store {
|
|
|
98
98
|
hide?: boolean | undefined;
|
|
99
99
|
baseUrl?: string | undefined;
|
|
100
100
|
} | undefined;
|
|
101
|
-
}
|
|
102
|
-
frontMatterKeysToResolve?: string[] | undefined;
|
|
103
|
-
partialsFolders?: string[] | undefined;
|
|
104
|
-
lastUpdatedBlock?: {
|
|
105
|
-
format?: "timeago" | "iso" | "long" | "short" | undefined;
|
|
106
|
-
hide?: boolean | undefined;
|
|
107
|
-
locale?: string | undefined;
|
|
108
|
-
} | undefined;
|
|
109
|
-
toc?: {
|
|
110
|
-
hide?: boolean | undefined;
|
|
111
|
-
header?: string | undefined;
|
|
112
|
-
depth?: number | undefined;
|
|
113
|
-
} | undefined;
|
|
114
|
-
editPage?: {
|
|
115
|
-
hide?: boolean | undefined;
|
|
116
|
-
baseUrl?: string | undefined;
|
|
117
|
-
} | undefined;
|
|
118
|
-
}) | undefined;
|
|
101
|
+
} | undefined;
|
|
119
102
|
tags?: any;
|
|
120
103
|
nodes?: any;
|
|
121
104
|
variables?: Record<string, any> | undefined;
|
|
@@ -141,663 +124,7 @@ export declare class Store {
|
|
|
141
124
|
setSearchIndexReady(): void;
|
|
142
125
|
setCliOptions(data: Record<string, string>): void;
|
|
143
126
|
setGlobalConfig: (data: Partial<RedoclyConfig>) => void;
|
|
144
|
-
getConfig: <T =
|
|
145
|
-
[x: string]: unknown;
|
|
146
|
-
imports?: string[] | undefined;
|
|
147
|
-
logo?: {
|
|
148
|
-
image?: string | undefined;
|
|
149
|
-
srcSet?: string | undefined;
|
|
150
|
-
altText?: string | undefined;
|
|
151
|
-
link?: string | undefined;
|
|
152
|
-
favicon?: string | undefined;
|
|
153
|
-
} | undefined;
|
|
154
|
-
navbar?: {
|
|
155
|
-
items?: {
|
|
156
|
-
[x: string]: unknown;
|
|
157
|
-
items?: {
|
|
158
|
-
[x: string]: unknown;
|
|
159
|
-
items?: {
|
|
160
|
-
[x: string]: unknown;
|
|
161
|
-
}[] | undefined;
|
|
162
|
-
separatorLine?: boolean | undefined;
|
|
163
|
-
linePosition?: "top" | "bottom" | undefined;
|
|
164
|
-
page?: string | undefined;
|
|
165
|
-
directory?: string | undefined;
|
|
166
|
-
disconnect?: boolean | undefined;
|
|
167
|
-
group?: string | undefined;
|
|
168
|
-
label?: string | undefined;
|
|
169
|
-
href?: string | undefined;
|
|
170
|
-
external?: boolean | undefined;
|
|
171
|
-
labelTranslationKey?: string | undefined;
|
|
172
|
-
groupTranslationKey?: string | undefined;
|
|
173
|
-
icon?: string | {
|
|
174
|
-
[x: string]: unknown;
|
|
175
|
-
srcSet: string;
|
|
176
|
-
} | undefined;
|
|
177
|
-
separator?: string | undefined;
|
|
178
|
-
version?: string | undefined;
|
|
179
|
-
menuStyle?: "drilldown" | undefined;
|
|
180
|
-
expanded?: "always" | undefined;
|
|
181
|
-
selectFirstItemOnExpand?: boolean | undefined;
|
|
182
|
-
flatten?: boolean | undefined;
|
|
183
|
-
linkedSidebars?: string[] | undefined;
|
|
184
|
-
}[] | undefined;
|
|
185
|
-
separatorLine?: boolean | undefined;
|
|
186
|
-
linePosition?: "top" | "bottom" | undefined;
|
|
187
|
-
page?: string | undefined;
|
|
188
|
-
directory?: string | undefined;
|
|
189
|
-
disconnect?: boolean | undefined;
|
|
190
|
-
group?: string | undefined;
|
|
191
|
-
label?: string | undefined;
|
|
192
|
-
href?: string | undefined;
|
|
193
|
-
external?: boolean | undefined;
|
|
194
|
-
labelTranslationKey?: string | undefined;
|
|
195
|
-
groupTranslationKey?: string | undefined;
|
|
196
|
-
icon?: string | {
|
|
197
|
-
[x: string]: unknown;
|
|
198
|
-
srcSet: string;
|
|
199
|
-
} | undefined;
|
|
200
|
-
separator?: string | undefined;
|
|
201
|
-
version?: string | undefined;
|
|
202
|
-
menuStyle?: "drilldown" | undefined;
|
|
203
|
-
expanded?: "always" | undefined;
|
|
204
|
-
selectFirstItemOnExpand?: boolean | undefined;
|
|
205
|
-
flatten?: boolean | undefined;
|
|
206
|
-
linkedSidebars?: string[] | undefined;
|
|
207
|
-
}[] | undefined;
|
|
208
|
-
hide?: boolean | undefined;
|
|
209
|
-
} | undefined;
|
|
210
|
-
products?: {
|
|
211
|
-
[x: string]: {
|
|
212
|
-
icon?: string | undefined;
|
|
213
|
-
name: string;
|
|
214
|
-
folder: string;
|
|
215
|
-
};
|
|
216
|
-
} | undefined;
|
|
217
|
-
footer?: {
|
|
218
|
-
items?: {
|
|
219
|
-
[x: string]: unknown;
|
|
220
|
-
items?: {
|
|
221
|
-
[x: string]: unknown;
|
|
222
|
-
items?: {
|
|
223
|
-
[x: string]: unknown;
|
|
224
|
-
}[] | undefined;
|
|
225
|
-
separatorLine?: boolean | undefined;
|
|
226
|
-
linePosition?: "top" | "bottom" | undefined;
|
|
227
|
-
page?: string | undefined;
|
|
228
|
-
directory?: string | undefined;
|
|
229
|
-
disconnect?: boolean | undefined;
|
|
230
|
-
group?: string | undefined;
|
|
231
|
-
label?: string | undefined;
|
|
232
|
-
href?: string | undefined;
|
|
233
|
-
external?: boolean | undefined;
|
|
234
|
-
labelTranslationKey?: string | undefined;
|
|
235
|
-
groupTranslationKey?: string | undefined;
|
|
236
|
-
icon?: string | {
|
|
237
|
-
[x: string]: unknown;
|
|
238
|
-
srcSet: string;
|
|
239
|
-
} | undefined;
|
|
240
|
-
separator?: string | undefined;
|
|
241
|
-
version?: string | undefined;
|
|
242
|
-
menuStyle?: "drilldown" | undefined;
|
|
243
|
-
expanded?: "always" | undefined;
|
|
244
|
-
selectFirstItemOnExpand?: boolean | undefined;
|
|
245
|
-
flatten?: boolean | undefined;
|
|
246
|
-
linkedSidebars?: string[] | undefined;
|
|
247
|
-
}[] | undefined;
|
|
248
|
-
separatorLine?: boolean | undefined;
|
|
249
|
-
linePosition?: "top" | "bottom" | undefined;
|
|
250
|
-
page?: string | undefined;
|
|
251
|
-
directory?: string | undefined;
|
|
252
|
-
disconnect?: boolean | undefined;
|
|
253
|
-
group?: string | undefined;
|
|
254
|
-
label?: string | undefined;
|
|
255
|
-
href?: string | undefined;
|
|
256
|
-
external?: boolean | undefined;
|
|
257
|
-
labelTranslationKey?: string | undefined;
|
|
258
|
-
groupTranslationKey?: string | undefined;
|
|
259
|
-
icon?: string | {
|
|
260
|
-
[x: string]: unknown;
|
|
261
|
-
srcSet: string;
|
|
262
|
-
} | undefined;
|
|
263
|
-
separator?: string | undefined;
|
|
264
|
-
version?: string | undefined;
|
|
265
|
-
menuStyle?: "drilldown" | undefined;
|
|
266
|
-
expanded?: "always" | undefined;
|
|
267
|
-
selectFirstItemOnExpand?: boolean | undefined;
|
|
268
|
-
flatten?: boolean | undefined;
|
|
269
|
-
linkedSidebars?: string[] | undefined;
|
|
270
|
-
}[] | undefined;
|
|
271
|
-
logo?: {
|
|
272
|
-
hide?: boolean | undefined;
|
|
273
|
-
} | undefined;
|
|
274
|
-
hide?: boolean | undefined;
|
|
275
|
-
copyrightText?: string | undefined;
|
|
276
|
-
} | undefined;
|
|
277
|
-
sidebar?: {
|
|
278
|
-
hide?: boolean | undefined;
|
|
279
|
-
separatorLine?: boolean | undefined;
|
|
280
|
-
linePosition?: "top" | "bottom" | undefined;
|
|
281
|
-
} | undefined;
|
|
282
|
-
scripts?: {
|
|
283
|
-
head?: {
|
|
284
|
-
[x: string]: unknown;
|
|
285
|
-
type?: string | undefined;
|
|
286
|
-
async?: boolean | undefined;
|
|
287
|
-
crossorigin?: string | undefined;
|
|
288
|
-
defer?: boolean | undefined;
|
|
289
|
-
fetchpriority?: string | undefined;
|
|
290
|
-
integrity?: string | undefined;
|
|
291
|
-
module?: boolean | undefined;
|
|
292
|
-
nomodule?: boolean | undefined;
|
|
293
|
-
nonce?: string | undefined;
|
|
294
|
-
referrerpolicy?: string | undefined;
|
|
295
|
-
src: string;
|
|
296
|
-
}[] | undefined;
|
|
297
|
-
body?: {
|
|
298
|
-
[x: string]: unknown;
|
|
299
|
-
type?: string | undefined;
|
|
300
|
-
async?: boolean | undefined;
|
|
301
|
-
crossorigin?: string | undefined;
|
|
302
|
-
defer?: boolean | undefined;
|
|
303
|
-
fetchpriority?: string | undefined;
|
|
304
|
-
integrity?: string | undefined;
|
|
305
|
-
module?: boolean | undefined;
|
|
306
|
-
nomodule?: boolean | undefined;
|
|
307
|
-
nonce?: string | undefined;
|
|
308
|
-
referrerpolicy?: string | undefined;
|
|
309
|
-
src: string;
|
|
310
|
-
}[] | undefined;
|
|
311
|
-
} | undefined;
|
|
312
|
-
links?: {
|
|
313
|
-
[x: string]: unknown;
|
|
314
|
-
type?: string | undefined;
|
|
315
|
-
title?: string | undefined;
|
|
316
|
-
crossorigin?: string | undefined;
|
|
317
|
-
fetchpriority?: string | undefined;
|
|
318
|
-
integrity?: string | undefined;
|
|
319
|
-
referrerpolicy?: string | undefined;
|
|
320
|
-
as?: string | undefined;
|
|
321
|
-
hreflang?: string | undefined;
|
|
322
|
-
imagesizes?: string | undefined;
|
|
323
|
-
imagesrcset?: string | undefined;
|
|
324
|
-
media?: string | undefined;
|
|
325
|
-
prefetch?: string | undefined;
|
|
326
|
-
rel?: string | undefined;
|
|
327
|
-
sizes?: string | undefined;
|
|
328
|
-
href: string;
|
|
329
|
-
}[] | undefined;
|
|
330
|
-
feedback?: {
|
|
331
|
-
type?: "rating" | "sentiment" | "comment" | "reasons" | "mood" | "scale" | undefined;
|
|
332
|
-
hide?: boolean | undefined;
|
|
333
|
-
settings?: {
|
|
334
|
-
items?: string[] | undefined;
|
|
335
|
-
label?: string | undefined;
|
|
336
|
-
comment?: {
|
|
337
|
-
hide?: boolean | undefined;
|
|
338
|
-
label?: string | undefined;
|
|
339
|
-
likeLabel?: string | undefined;
|
|
340
|
-
dislikeLabel?: string | undefined;
|
|
341
|
-
satisfiedLabel?: string | undefined;
|
|
342
|
-
neutralLabel?: string | undefined;
|
|
343
|
-
dissatisfiedLabel?: string | undefined;
|
|
344
|
-
} | undefined;
|
|
345
|
-
reasons?: {
|
|
346
|
-
items?: string[] | undefined;
|
|
347
|
-
hide?: boolean | undefined;
|
|
348
|
-
label?: string | undefined;
|
|
349
|
-
component?: "radio" | "checkbox" | undefined;
|
|
350
|
-
} | undefined;
|
|
351
|
-
submitText?: string | undefined;
|
|
352
|
-
buttonText?: string | undefined;
|
|
353
|
-
component?: "radio" | "checkbox" | undefined;
|
|
354
|
-
leftScaleLabel?: string | undefined;
|
|
355
|
-
rightScaleLabel?: string | undefined;
|
|
356
|
-
} | undefined;
|
|
357
|
-
} | undefined;
|
|
358
|
-
search?: {
|
|
359
|
-
hide?: boolean | undefined;
|
|
360
|
-
placement?: string | undefined;
|
|
361
|
-
shortcuts?: string[] | undefined;
|
|
362
|
-
suggestedPages?: {
|
|
363
|
-
[x: string]: unknown;
|
|
364
|
-
label?: string | undefined;
|
|
365
|
-
labelTranslationKey?: string | undefined;
|
|
366
|
-
page: string;
|
|
367
|
-
}[] | undefined;
|
|
368
|
-
fuzzy?: boolean | undefined;
|
|
369
|
-
} | undefined;
|
|
370
|
-
colorMode?: {
|
|
371
|
-
hide?: boolean | undefined;
|
|
372
|
-
ignoreDetection?: boolean | undefined;
|
|
373
|
-
modes?: string[] | undefined;
|
|
374
|
-
} | undefined;
|
|
375
|
-
navigation?: {
|
|
376
|
-
nextButton?: {
|
|
377
|
-
hide?: boolean | undefined;
|
|
378
|
-
text?: string | undefined;
|
|
379
|
-
} | undefined;
|
|
380
|
-
previousButton?: {
|
|
381
|
-
hide?: boolean | undefined;
|
|
382
|
-
text?: string | undefined;
|
|
383
|
-
} | undefined;
|
|
384
|
-
} | undefined;
|
|
385
|
-
codeSnippet?: {
|
|
386
|
-
elementFormat?: string | undefined;
|
|
387
|
-
copy?: {
|
|
388
|
-
hide?: boolean | undefined;
|
|
389
|
-
} | undefined;
|
|
390
|
-
report?: {
|
|
391
|
-
hide?: boolean | undefined;
|
|
392
|
-
label?: string | undefined;
|
|
393
|
-
buttonText?: string | undefined;
|
|
394
|
-
tooltipText?: string | undefined;
|
|
395
|
-
} | undefined;
|
|
396
|
-
expand?: {
|
|
397
|
-
hide?: boolean | undefined;
|
|
398
|
-
} | undefined;
|
|
399
|
-
collapse?: {
|
|
400
|
-
hide?: boolean | undefined;
|
|
401
|
-
} | undefined;
|
|
402
|
-
} | undefined;
|
|
403
|
-
markdown?: {
|
|
404
|
-
frontMatterKeysToResolve?: string[] | undefined;
|
|
405
|
-
partialsFolders?: string[] | undefined;
|
|
406
|
-
lastUpdatedBlock?: {
|
|
407
|
-
format?: "timeago" | "iso" | "long" | "short" | undefined;
|
|
408
|
-
hide?: boolean | undefined;
|
|
409
|
-
locale?: string | undefined;
|
|
410
|
-
} | undefined;
|
|
411
|
-
toc?: {
|
|
412
|
-
hide?: boolean | undefined;
|
|
413
|
-
header?: string | undefined;
|
|
414
|
-
depth?: number | undefined;
|
|
415
|
-
} | undefined;
|
|
416
|
-
editPage?: {
|
|
417
|
-
hide?: boolean | undefined;
|
|
418
|
-
baseUrl?: string | undefined;
|
|
419
|
-
} | undefined;
|
|
420
|
-
} | undefined;
|
|
421
|
-
openapi?: {
|
|
422
|
-
feedback?: {
|
|
423
|
-
type?: "rating" | "sentiment" | "comment" | "reasons" | "mood" | "scale" | undefined;
|
|
424
|
-
hide?: boolean | undefined;
|
|
425
|
-
settings?: {
|
|
426
|
-
items?: string[] | undefined;
|
|
427
|
-
label?: string | undefined;
|
|
428
|
-
comment?: {
|
|
429
|
-
hide?: boolean | undefined;
|
|
430
|
-
label?: string | undefined;
|
|
431
|
-
likeLabel?: string | undefined;
|
|
432
|
-
dislikeLabel?: string | undefined;
|
|
433
|
-
satisfiedLabel?: string | undefined;
|
|
434
|
-
neutralLabel?: string | undefined;
|
|
435
|
-
dissatisfiedLabel?: string | undefined;
|
|
436
|
-
} | undefined;
|
|
437
|
-
reasons?: {
|
|
438
|
-
items?: string[] | undefined;
|
|
439
|
-
hide?: boolean | undefined;
|
|
440
|
-
label?: string | undefined;
|
|
441
|
-
component?: "radio" | "checkbox" | undefined;
|
|
442
|
-
} | undefined;
|
|
443
|
-
submitText?: string | undefined;
|
|
444
|
-
buttonText?: string | undefined;
|
|
445
|
-
component?: "radio" | "checkbox" | undefined;
|
|
446
|
-
leftScaleLabel?: string | undefined;
|
|
447
|
-
rightScaleLabel?: string | undefined;
|
|
448
|
-
} | undefined;
|
|
449
|
-
} | null | undefined;
|
|
450
|
-
licenseKey?: string | undefined;
|
|
451
|
-
hideLoading?: boolean | undefined;
|
|
452
|
-
disableRouter?: boolean | undefined;
|
|
453
|
-
hideSidebar?: boolean | undefined;
|
|
454
|
-
hideReplay?: boolean | undefined;
|
|
455
|
-
oAuth2RedirectURI?: string | null | undefined;
|
|
456
|
-
corsProxyUrl?: string | undefined;
|
|
457
|
-
sortRequiredPropsFirst?: boolean | undefined;
|
|
458
|
-
sanitize?: boolean | undefined;
|
|
459
|
-
hideDownloadButtons?: boolean | undefined;
|
|
460
|
-
downloadUrls?: {
|
|
461
|
-
title?: string | undefined;
|
|
462
|
-
url: string;
|
|
463
|
-
}[] | undefined;
|
|
464
|
-
onlyRequiredInSamples?: boolean | undefined;
|
|
465
|
-
generatedSamplesMaxDepth?: string | number | undefined;
|
|
466
|
-
showExtensions?: string | boolean | string[] | undefined;
|
|
467
|
-
hideSchemaTitles?: boolean | undefined;
|
|
468
|
-
jsonSamplesExpandLevel?: string | number | undefined;
|
|
469
|
-
schemasExpansionLevel?: string | number | undefined;
|
|
470
|
-
mockServer?: {
|
|
471
|
-
[x: string]: unknown;
|
|
472
|
-
description?: string | undefined;
|
|
473
|
-
url?: string | undefined;
|
|
474
|
-
position?: "first" | "last" | "replace" | "off" | undefined;
|
|
475
|
-
} | undefined;
|
|
476
|
-
maxDisplayedEnumValues?: number | undefined;
|
|
477
|
-
schemaDefinitionsTagName?: string | undefined;
|
|
478
|
-
layout?: "stacked" | "three-panel" | undefined;
|
|
479
|
-
hideInfoMetadata?: boolean | undefined;
|
|
480
|
-
events?: {
|
|
481
|
-
[x: string]: unknown;
|
|
482
|
-
} | undefined;
|
|
483
|
-
skipBundle?: boolean | undefined;
|
|
484
|
-
routingBasePath?: string | undefined;
|
|
485
|
-
codeSamples?: {
|
|
486
|
-
skipOptionalParameters?: boolean | undefined;
|
|
487
|
-
withOAuth2Call?: boolean | undefined;
|
|
488
|
-
languages: {
|
|
489
|
-
label?: string | undefined;
|
|
490
|
-
options?: {
|
|
491
|
-
indent?: string | undefined;
|
|
492
|
-
withImports?: boolean | undefined;
|
|
493
|
-
withComments?: boolean | undefined;
|
|
494
|
-
binary?: boolean | undefined;
|
|
495
|
-
credentials?: "omit" | "same-origin" | "include" | undefined;
|
|
496
|
-
} | undefined;
|
|
497
|
-
lang: "curl" | "JavaScript" | "Node.js" | "Python" | "Java8+Apache" | "Java" | "C#" | "C#+Newtonsoft" | "PHP" | "Go" | "Ruby" | "R" | "Payload";
|
|
498
|
-
}[];
|
|
499
|
-
} | undefined;
|
|
500
|
-
ignoreNamedSchemas?: string | string[] | undefined;
|
|
501
|
-
hidePropertiesPrefix?: boolean | undefined;
|
|
502
|
-
excludeFromSearch?: boolean | undefined;
|
|
503
|
-
} | undefined;
|
|
504
|
-
graphql?: {
|
|
505
|
-
sidebar?: {
|
|
506
|
-
[x: string]: unknown;
|
|
507
|
-
hide?: boolean | undefined;
|
|
508
|
-
} | undefined;
|
|
509
|
-
feedback?: {
|
|
510
|
-
type?: "rating" | "sentiment" | "comment" | "reasons" | "mood" | "scale" | undefined;
|
|
511
|
-
hide?: boolean | undefined;
|
|
512
|
-
settings?: {
|
|
513
|
-
items?: string[] | undefined;
|
|
514
|
-
label?: string | undefined;
|
|
515
|
-
comment?: {
|
|
516
|
-
hide?: boolean | undefined;
|
|
517
|
-
label?: string | undefined;
|
|
518
|
-
likeLabel?: string | undefined;
|
|
519
|
-
dislikeLabel?: string | undefined;
|
|
520
|
-
satisfiedLabel?: string | undefined;
|
|
521
|
-
neutralLabel?: string | undefined;
|
|
522
|
-
dissatisfiedLabel?: string | undefined;
|
|
523
|
-
} | undefined;
|
|
524
|
-
reasons?: {
|
|
525
|
-
items?: string[] | undefined;
|
|
526
|
-
hide?: boolean | undefined;
|
|
527
|
-
label?: string | undefined;
|
|
528
|
-
component?: "radio" | "checkbox" | undefined;
|
|
529
|
-
} | undefined;
|
|
530
|
-
submitText?: string | undefined;
|
|
531
|
-
buttonText?: string | undefined;
|
|
532
|
-
component?: "radio" | "checkbox" | undefined;
|
|
533
|
-
leftScaleLabel?: string | undefined;
|
|
534
|
-
rightScaleLabel?: string | undefined;
|
|
535
|
-
} | undefined;
|
|
536
|
-
} | null | undefined;
|
|
537
|
-
navigation?: {
|
|
538
|
-
[x: string]: unknown;
|
|
539
|
-
contentPrefix?: string | undefined;
|
|
540
|
-
menuPrefix?: string | undefined;
|
|
541
|
-
} | undefined;
|
|
542
|
-
licenseKey?: string | undefined;
|
|
543
|
-
jsonSamplesExpandLevel?: number | undefined;
|
|
544
|
-
pagination?: "none" | "section" | "item" | undefined;
|
|
545
|
-
hidePaginationButtons?: boolean | undefined;
|
|
546
|
-
menu?: {
|
|
547
|
-
requireExactGroups?: boolean | undefined;
|
|
548
|
-
groups?: {
|
|
549
|
-
items?: {
|
|
550
|
-
includeByName?: string[] | undefined;
|
|
551
|
-
excludeByName?: string[] | undefined;
|
|
552
|
-
} | undefined;
|
|
553
|
-
queries?: {
|
|
554
|
-
includeByName?: string[] | undefined;
|
|
555
|
-
excludeByName?: string[] | undefined;
|
|
556
|
-
} | undefined;
|
|
557
|
-
mutations?: {
|
|
558
|
-
includeByName?: string[] | undefined;
|
|
559
|
-
excludeByName?: string[] | undefined;
|
|
560
|
-
} | undefined;
|
|
561
|
-
subscriptions?: {
|
|
562
|
-
includeByName?: string[] | undefined;
|
|
563
|
-
excludeByName?: string[] | undefined;
|
|
564
|
-
} | undefined;
|
|
565
|
-
types?: {
|
|
566
|
-
includeByName?: string[] | undefined;
|
|
567
|
-
excludeByName?: string[] | undefined;
|
|
568
|
-
} | undefined;
|
|
569
|
-
directives?: {
|
|
570
|
-
includeByName?: string[] | undefined;
|
|
571
|
-
excludeByName?: string[] | undefined;
|
|
572
|
-
} | undefined;
|
|
573
|
-
name: string;
|
|
574
|
-
}[] | undefined;
|
|
575
|
-
otherItemsGroupName?: string | undefined;
|
|
576
|
-
initialLoadState?: "default" | "all-expanded" | undefined;
|
|
577
|
-
} | undefined;
|
|
578
|
-
apiLogo?: {
|
|
579
|
-
[x: string]: unknown;
|
|
580
|
-
altText?: string | undefined;
|
|
581
|
-
href?: string | undefined;
|
|
582
|
-
imageUrl?: string | undefined;
|
|
583
|
-
backgroundColor?: string | undefined;
|
|
584
|
-
} | undefined;
|
|
585
|
-
sampleMaxInlineArgs?: number | undefined;
|
|
586
|
-
fieldExpandLevel?: number | undefined;
|
|
587
|
-
baseUrlPath?: string | undefined;
|
|
588
|
-
} | undefined;
|
|
589
|
-
analytics?: {
|
|
590
|
-
[x: string]: unknown;
|
|
591
|
-
adobe?: {
|
|
592
|
-
includeInDevelopment?: boolean | undefined;
|
|
593
|
-
pageViewEventName?: string | undefined;
|
|
594
|
-
scriptUrl: string;
|
|
595
|
-
} | undefined;
|
|
596
|
-
amplitude?: {
|
|
597
|
-
head?: boolean | undefined;
|
|
598
|
-
includeInDevelopment?: boolean | undefined;
|
|
599
|
-
pageViewEventName?: string | undefined;
|
|
600
|
-
respectDNT?: boolean | undefined;
|
|
601
|
-
exclude?: string[] | undefined;
|
|
602
|
-
outboundClickEventName?: string | undefined;
|
|
603
|
-
amplitudeConfig?: {
|
|
604
|
-
[x: string]: unknown;
|
|
605
|
-
} | undefined;
|
|
606
|
-
apiKey: string;
|
|
607
|
-
} | undefined;
|
|
608
|
-
fullstory?: {
|
|
609
|
-
includeInDevelopment?: boolean | undefined;
|
|
610
|
-
orgId: string;
|
|
611
|
-
} | undefined;
|
|
612
|
-
heap?: {
|
|
613
|
-
includeInDevelopment?: boolean | undefined;
|
|
614
|
-
appId: string;
|
|
615
|
-
} | undefined;
|
|
616
|
-
rudderstack?: {
|
|
617
|
-
includeInDevelopment?: boolean | undefined;
|
|
618
|
-
trackPage?: boolean | undefined;
|
|
619
|
-
dataPlaneUrl?: string | undefined;
|
|
620
|
-
controlPlaneUrl?: string | undefined;
|
|
621
|
-
sdkUrl?: string | undefined;
|
|
622
|
-
loadOptions?: {
|
|
623
|
-
[x: string]: unknown;
|
|
624
|
-
} | undefined;
|
|
625
|
-
writeKey: string;
|
|
626
|
-
} | undefined;
|
|
627
|
-
segment?: {
|
|
628
|
-
includeInDevelopment?: boolean | undefined;
|
|
629
|
-
trackPage?: boolean | undefined;
|
|
630
|
-
includeTitleInPageCall?: boolean | undefined;
|
|
631
|
-
host?: string | undefined;
|
|
632
|
-
writeKey: string;
|
|
633
|
-
} | undefined;
|
|
634
|
-
gtm?: {
|
|
635
|
-
includeInDevelopment?: boolean | undefined;
|
|
636
|
-
pageViewEventName?: string | undefined;
|
|
637
|
-
gtmAuth?: string | undefined;
|
|
638
|
-
gtmPreview?: string | undefined;
|
|
639
|
-
defaultDataLayer?: unknown;
|
|
640
|
-
dataLayerName?: string | undefined;
|
|
641
|
-
enableWebVitalsTracking?: boolean | undefined;
|
|
642
|
-
selfHostedOrigin?: string | undefined;
|
|
643
|
-
trackingId: string;
|
|
644
|
-
} | undefined;
|
|
645
|
-
ga?: {
|
|
646
|
-
head?: boolean | undefined;
|
|
647
|
-
includeInDevelopment?: boolean | undefined;
|
|
648
|
-
respectDNT?: boolean | undefined;
|
|
649
|
-
exclude?: string[] | undefined;
|
|
650
|
-
conversionId?: string | undefined;
|
|
651
|
-
floodlightId?: string | undefined;
|
|
652
|
-
optimizeId?: string | undefined;
|
|
653
|
-
anonymizeIp?: boolean | undefined;
|
|
654
|
-
cookieExpires?: number | undefined;
|
|
655
|
-
trackers?: {
|
|
656
|
-
[x: string]: {
|
|
657
|
-
includeInDevelopment?: boolean | undefined;
|
|
658
|
-
exclude?: string[] | undefined;
|
|
659
|
-
conversionId?: string | undefined;
|
|
660
|
-
floodlightId?: string | undefined;
|
|
661
|
-
optimizeId?: string | undefined;
|
|
662
|
-
trackingId: string;
|
|
663
|
-
};
|
|
664
|
-
} | undefined;
|
|
665
|
-
trackingId: string;
|
|
666
|
-
} | undefined;
|
|
667
|
-
} | undefined;
|
|
668
|
-
userMenu?: {
|
|
669
|
-
items?: {
|
|
670
|
-
[x: string]: unknown;
|
|
671
|
-
link?: string | undefined;
|
|
672
|
-
separatorLine?: boolean | undefined;
|
|
673
|
-
label?: string | undefined;
|
|
674
|
-
external?: boolean | undefined;
|
|
675
|
-
}[] | undefined;
|
|
676
|
-
hide?: boolean | undefined;
|
|
677
|
-
hideLoginButton?: boolean | undefined;
|
|
678
|
-
} | undefined;
|
|
679
|
-
versionPicker?: {
|
|
680
|
-
[x: string]: unknown;
|
|
681
|
-
hide?: boolean | undefined;
|
|
682
|
-
showForUnversioned?: boolean | undefined;
|
|
683
|
-
} | undefined;
|
|
684
|
-
breadcrumbs?: {
|
|
685
|
-
hide?: boolean | undefined;
|
|
686
|
-
prefixItems?: {
|
|
687
|
-
page?: string | undefined;
|
|
688
|
-
label?: string | undefined;
|
|
689
|
-
labelTranslationKey?: string | undefined;
|
|
690
|
-
}[] | undefined;
|
|
691
|
-
} | undefined;
|
|
692
|
-
catalog?: {
|
|
693
|
-
[x: string]: {
|
|
694
|
-
[x: string]: unknown;
|
|
695
|
-
title?: string | undefined;
|
|
696
|
-
description?: string | undefined;
|
|
697
|
-
filters?: {
|
|
698
|
-
type?: "select" | "checkboxes" | "date-range" | undefined;
|
|
699
|
-
options?: string[] | undefined;
|
|
700
|
-
titleTranslationKey?: string | undefined;
|
|
701
|
-
parentFilter?: string | undefined;
|
|
702
|
-
valuesMapping?: {
|
|
703
|
-
[x: string]: string;
|
|
704
|
-
} | undefined;
|
|
705
|
-
missingCategoryName?: string | undefined;
|
|
706
|
-
missingCategoryNameTranslationKey?: string | undefined;
|
|
707
|
-
title: string;
|
|
708
|
-
property: string;
|
|
709
|
-
}[] | undefined;
|
|
710
|
-
groupByFirstFilter?: boolean | undefined;
|
|
711
|
-
filterValuesCasing?: "sentence" | "original" | "lowercase" | "uppercase" | undefined;
|
|
712
|
-
requiredPermission?: string | undefined;
|
|
713
|
-
separateVersions?: boolean | undefined;
|
|
714
|
-
titleTranslationKey?: string | undefined;
|
|
715
|
-
descriptionTranslationKey?: string | undefined;
|
|
716
|
-
items: {
|
|
717
|
-
[x: string]: unknown;
|
|
718
|
-
items?: {
|
|
719
|
-
[x: string]: unknown;
|
|
720
|
-
items?: {
|
|
721
|
-
[x: string]: unknown;
|
|
722
|
-
}[] | undefined;
|
|
723
|
-
separatorLine?: boolean | undefined;
|
|
724
|
-
linePosition?: "top" | "bottom" | undefined;
|
|
725
|
-
page?: string | undefined;
|
|
726
|
-
directory?: string | undefined;
|
|
727
|
-
disconnect?: boolean | undefined;
|
|
728
|
-
group?: string | undefined;
|
|
729
|
-
label?: string | undefined;
|
|
730
|
-
href?: string | undefined;
|
|
731
|
-
external?: boolean | undefined;
|
|
732
|
-
labelTranslationKey?: string | undefined;
|
|
733
|
-
groupTranslationKey?: string | undefined;
|
|
734
|
-
icon?: string | {
|
|
735
|
-
[x: string]: unknown;
|
|
736
|
-
srcSet: string;
|
|
737
|
-
} | undefined;
|
|
738
|
-
separator?: string | undefined;
|
|
739
|
-
version?: string | undefined;
|
|
740
|
-
menuStyle?: "drilldown" | undefined;
|
|
741
|
-
expanded?: "always" | undefined;
|
|
742
|
-
selectFirstItemOnExpand?: boolean | undefined;
|
|
743
|
-
flatten?: boolean | undefined;
|
|
744
|
-
linkedSidebars?: string[] | undefined;
|
|
745
|
-
}[] | undefined;
|
|
746
|
-
separatorLine?: boolean | undefined;
|
|
747
|
-
linePosition?: "top" | "bottom" | undefined;
|
|
748
|
-
page?: string | undefined;
|
|
749
|
-
directory?: string | undefined;
|
|
750
|
-
disconnect?: boolean | undefined;
|
|
751
|
-
group?: string | undefined;
|
|
752
|
-
label?: string | undefined;
|
|
753
|
-
href?: string | undefined;
|
|
754
|
-
external?: boolean | undefined;
|
|
755
|
-
labelTranslationKey?: string | undefined;
|
|
756
|
-
groupTranslationKey?: string | undefined;
|
|
757
|
-
icon?: string | {
|
|
758
|
-
[x: string]: unknown;
|
|
759
|
-
srcSet: string;
|
|
760
|
-
} | undefined;
|
|
761
|
-
separator?: string | undefined;
|
|
762
|
-
version?: string | undefined;
|
|
763
|
-
menuStyle?: "drilldown" | undefined;
|
|
764
|
-
expanded?: "always" | undefined;
|
|
765
|
-
selectFirstItemOnExpand?: boolean | undefined;
|
|
766
|
-
flatten?: boolean | undefined;
|
|
767
|
-
linkedSidebars?: string[] | undefined;
|
|
768
|
-
}[];
|
|
769
|
-
slug: string;
|
|
770
|
-
};
|
|
771
|
-
} | undefined;
|
|
772
|
-
scorecard?: {
|
|
773
|
-
[x: string]: unknown;
|
|
774
|
-
ignoreNonCompliant?: boolean | undefined;
|
|
775
|
-
teamMetadataProperty?: {
|
|
776
|
-
[x: string]: unknown;
|
|
777
|
-
default?: string | undefined;
|
|
778
|
-
label?: string | undefined;
|
|
779
|
-
property?: string | undefined;
|
|
780
|
-
} | undefined;
|
|
781
|
-
levels?: {
|
|
782
|
-
color?: string | undefined;
|
|
783
|
-
extends?: string[] | undefined;
|
|
784
|
-
rules?: {
|
|
785
|
-
[x: string]: string | {
|
|
786
|
-
[x: string]: unknown;
|
|
787
|
-
};
|
|
788
|
-
} | undefined;
|
|
789
|
-
name: string;
|
|
790
|
-
}[] | undefined;
|
|
791
|
-
targets?: {
|
|
792
|
-
minimumLevel?: string | undefined;
|
|
793
|
-
where: {
|
|
794
|
-
metadata: {
|
|
795
|
-
[x: string]: string;
|
|
796
|
-
};
|
|
797
|
-
};
|
|
798
|
-
}[] | undefined;
|
|
799
|
-
} | undefined;
|
|
800
|
-
}>() => RedoclyConfig<T>;
|
|
127
|
+
getConfig: <T = ThemeConfig>() => RedoclyConfig<T>;
|
|
801
128
|
getGlobalConfig: <T = unknown>(key: string) => T;
|
|
802
129
|
addRedirect(from: string, to: RedirectConfig): void;
|
|
803
130
|
createSharedData: (id: string, data: unknown) => Promise<string>;
|