@redocly/openapi-docs 3.13.0 → 3.14.0-next.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 (5) hide show
  1. package/dist/redocly-openapi-docs.min.js +1511 -1511
  2. package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsStandalone.js +1 -1
  3. package/lib/utils/loadAndBundleSpec.d.ts +2 -659
  4. package/lib/utils/loadAndBundleSpec.js +1 -1
  5. package/package.json +6 -6
package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsStandalone.js CHANGED
@@ -1 +1 @@
1
- import{jsx as u}from"react/jsx-runtime";import{cloneElement as w,isValidElement as v,useEffect as g,useMemo as x,useState as a}from"react";import{Loading as A}from"@redocly/theme/components/Loaders/Loading";import{useDeepCompareMemoize as D,fixSpec as L}from"./utils.js";import{argValueToBoolean as B}from"../../utils/index.js";import{RedoclyOpenAPIDocs as E}from"./RedoclyOpenAPIDocs.js";import{loadAndBundleDefinition as p,loadRedoclyConfig as O}from"../../utils/loadAndBundleSpec.js";async function C(e,o,t){let n;if(t?.skipBundle){if(!e)throw new Error('spec must be specified when using "skipBundleAndConvert"');n=e}else n=await p(e||o);try{L(n)}catch{}return n}function z(e,o){return e.endsWith(".md")?p({openapi:"3.0.0",info:{title:o||"",version:"1.0",description:{$ref:e}},paths:{}}):p(e)}const I=({options:e,definitionUrl:o,definition:t,activeSampleLanguage:n,children:r})=>{const[,l]=a(),[s,f]=a(!0),[d,y]=a(null),[m,h]=a(e||{});g(()=>{async function S(){f(!0);try{const c=await O();h({...e,...c}),y(await C(t,o,e))}catch(c){l(()=>{throw c})}}S()},[t,o,e]);const i=x(()=>{if(d)return{definition:d,options:m,definitionUrl:o,activeSampleLanguage:n}},D([d,o,m]));return g(()=>{i&&f(!1)},[i]),i?s?B(e?.hideLoading,!1)?null:u(A,{color:"--loading-spinner-color"}):v(r)?w(r,{store:i}):null:null};function T({definition:e,definitionUrl:o,options:t={},activeItemId:n,activeSampleLanguage:r,activeDeepLink:l,router:s}){return u(I,{definition:e,definitionUrl:o,options:t,activeItemId:n,activeSampleLanguage:r,activeDeepLink:l,children:u(E,{withCommonStyles:!0,router:s})})}export{I as AppProvider,T as RedoclyOpenAPIDocsStandalone,z as loadAndBundleSpecOrMd,C as loadSingle};
1
+ import{jsx as p}from"react/jsx-runtime";import{cloneElement as w,isValidElement as v,useEffect as g,useMemo as x,useState as a}from"react";import{Loading as A}from"@redocly/theme/components/Loaders/Loading";import{useDeepCompareMemoize as D,fixSpec as L}from"./utils.js";import{argValueToBoolean as O}from"../../utils/index.js";import{RedoclyOpenAPIDocs as B}from"./RedoclyOpenAPIDocs.js";import{loadAndBundleDefinition as u,loadOpenapiConfig as E}from"../../utils/loadAndBundleSpec.js";async function C(e,o,t){let n;if(t?.skipBundle){if(!e)throw new Error('spec must be specified when using "skipBundleAndConvert"');n=e}else n=await u(e||o);try{L(n)}catch{}return n}function z(e,o){return e.endsWith(".md")?u({openapi:"3.0.0",info:{title:o||"",version:"1.0",description:{$ref:e}},paths:{}}):u(e)}const I=({options:e,definitionUrl:o,definition:t,activeSampleLanguage:n,children:r})=>{const[,l]=a(),[s,f]=a(!0),[d,h]=a(null),[m,y]=a(e||{});g(()=>{async function S(){f(!0);try{const c=await E();y({...e,...c}),h(await C(t,o,e))}catch(c){l(()=>{throw c})}}S()},[t,o,e]);const i=x(()=>{if(d)return{definition:d,options:m,definitionUrl:o,activeSampleLanguage:n}},D([d,o,m]));return g(()=>{i&&f(!1)},[i]),i?s?O(e?.hideLoading,!1)?null:p(A,{color:"--loading-spinner-color"}):v(r)?w(r,{store:i}):null:null};function T({definition:e,definitionUrl:o,options:t={},activeItemId:n,activeSampleLanguage:r,activeDeepLink:l,router:s}){return p(I,{definition:e,definitionUrl:o,options:t,activeItemId:n,activeSampleLanguage:r,activeDeepLink:l,children:p(B,{withCommonStyles:!0,router:s})})}export{I as AppProvider,T as RedoclyOpenAPIDocsStandalone,z as loadAndBundleSpecOrMd,C as loadSingle};
package/lib/utils/loadAndBundleSpec.d.ts CHANGED
@@ -1,661 +1,4 @@
1
1
  import type { OpenAPIDefinition } from '../types/index.js';
2
- export declare function loadRedoclyConfig(): Promise<{
3
- onDeepLinkClick?: {
4
- [x: string]: unknown;
5
- } | undefined;
6
- theme?: {
7
- [x: string]: unknown;
8
- schema?: {
9
- [x: string]: unknown;
10
- examples?: {
11
- [x: string]: unknown;
12
- border?: string | undefined;
13
- backgroundColor?: string | undefined;
14
- } | undefined;
15
- constraints?: {
16
- [x: string]: unknown;
17
- border?: string | undefined;
18
- backgroundColor?: string | undefined;
19
- } | undefined;
20
- breakFieldNames?: boolean | undefined;
21
- caretColor?: string | undefined;
22
- caretSize?: string | undefined;
23
- defaultDetailsWidth?: string | undefined;
24
- labelsTextSize?: string | undefined;
25
- linesColor?: string | undefined;
26
- nestedBackground?: string | undefined;
27
- nestingSpacing?: string | undefined;
28
- requireLabelColor?: string | undefined;
29
- typeNameColor?: string | undefined;
30
- typeTitleColor?: string | undefined;
31
- } | undefined;
32
- links?: unknown;
33
- layout?: {
34
- [x: string]: unknown;
35
- stacked?: {
36
- [x: string]: unknown;
37
- maxWidth?: {
38
- [x: string]: unknown;
39
- small?: string | undefined;
40
- medium?: string | undefined;
41
- large?: string | undefined;
42
- } | undefined;
43
- } | undefined;
44
- "three-panel"?: {
45
- [x: string]: unknown;
46
- maxWidth?: {
47
- [x: string]: unknown;
48
- small?: string | undefined;
49
- medium?: string | undefined;
50
- large?: string | undefined;
51
- } | undefined;
52
- middlePanelMaxWidth?: {
53
- [x: string]: unknown;
54
- small?: string | undefined;
55
- medium?: string | undefined;
56
- large?: string | undefined;
57
- } | undefined;
58
- } | undefined;
59
- showDarkRightPanel?: boolean | undefined;
60
- } | undefined;
61
- spacing?: {
62
- [x: string]: unknown;
63
- unit?: number | undefined;
64
- sectionHorizontal?: number | undefined;
65
- sectionVertical?: number | undefined;
66
- } | undefined;
67
- components?: {
68
- [x: string]: unknown;
69
- buttons?: {
70
- [x: string]: unknown;
71
- fontSize?: string | undefined;
72
- fontWeight?: string | undefined;
73
- fontFamily?: string | undefined;
74
- lineHeight?: string | undefined;
75
- sizes?: {
76
- [x: string]: unknown;
77
- small?: {
78
- [x: string]: unknown;
79
- fontSize?: string | undefined;
80
- padding?: string | undefined;
81
- minWidth?: string | undefined;
82
- } | undefined;
83
- medium?: {
84
- [x: string]: unknown;
85
- fontSize?: string | undefined;
86
- padding?: string | undefined;
87
- minWidth?: string | undefined;
88
- } | undefined;
89
- large?: {
90
- [x: string]: unknown;
91
- fontSize?: string | undefined;
92
- padding?: string | undefined;
93
- minWidth?: string | undefined;
94
- } | undefined;
95
- xlarge?: {
96
- [x: string]: unknown;
97
- fontSize?: string | undefined;
98
- padding?: string | undefined;
99
- minWidth?: string | undefined;
100
- } | undefined;
101
- } | undefined;
102
- borderRadius?: string | undefined;
103
- hoverStyle?: string | undefined;
104
- boxShadow?: string | undefined;
105
- hoverBoxShadow?: string | undefined;
106
- } | undefined;
107
- httpBadges?: {
108
- [x: string]: unknown;
109
- fontSize?: string | undefined;
110
- fontWeight?: string | undefined;
111
- fontFamily?: string | undefined;
112
- lineHeight?: string | undefined;
113
- color?: string | undefined;
114
- sizes?: {
115
- [x: string]: unknown;
116
- small?: {
117
- [x: string]: unknown;
118
- fontSize?: string | undefined;
119
- fontWeight?: string | undefined;
120
- fontFamily?: string | undefined;
121
- lineHeight?: string | undefined;
122
- } | undefined;
123
- medium?: {
124
- [x: string]: unknown;
125
- fontSize?: string | undefined;
126
- fontWeight?: string | undefined;
127
- fontFamily?: string | undefined;
128
- lineHeight?: string | undefined;
129
- } | undefined;
130
- } | undefined;
131
- borderRadius?: string | undefined;
132
- } | undefined;
133
- layoutControls?: {
134
- [x: string]: unknown;
135
- height?: string | undefined;
136
- width?: string | undefined;
137
- top?: string | undefined;
138
- } | undefined;
139
- panels?: {
140
- [x: string]: unknown;
141
- backgroundColor?: string | undefined;
142
- borderRadius?: string | undefined;
143
- } | undefined;
144
- tryItButton?: {
145
- [x: string]: unknown;
146
- fullWidth?: boolean | undefined;
147
- } | undefined;
148
- tryItSendButton?: {
149
- [x: string]: unknown;
150
- fullWidth?: boolean | undefined;
151
- } | undefined;
152
- } | undefined;
153
- logo?: {
154
- [x: string]: unknown;
155
- maxWidth?: string | undefined;
156
- gutter?: string | undefined;
157
- maxHeight?: string | undefined;
158
- } | undefined;
159
- sidebar?: {
160
- [x: string]: unknown;
161
- width?: string | undefined;
162
- fontSize?: string | undefined;
163
- fontWeight?: string | undefined;
164
- fontFamily?: string | undefined;
165
- lineHeight?: string | undefined;
166
- spacing?: {
167
- [x: string]: unknown;
168
- offsetTop?: string | undefined;
169
- unit?: number | undefined;
170
- paddingHorizontal?: string | undefined;
171
- paddingVertical?: string | undefined;
172
- offsetLeft?: string | undefined;
173
- offsetNesting?: string | undefined;
174
- } | undefined;
175
- backgroundColor?: string | undefined;
176
- borderRadius?: string | undefined;
177
- showAtBreakpoint?: string | undefined;
178
- textColor?: string | undefined;
179
- caretColor?: string | undefined;
180
- caretSize?: string | undefined;
181
- activeBgColor?: string | undefined;
182
- activeTextColor?: string | undefined;
183
- breakPath?: boolean | undefined;
184
- groupItems?: {
185
- [x: string]: unknown;
186
- fontWeight?: string | undefined;
187
- textTransform?: string | undefined;
188
- subItemsColor?: string | undefined;
189
- } | undefined;
190
- level1items?: {
191
- [x: string]: unknown;
192
- fontWeight?: string | undefined;
193
- textTransform?: string | undefined;
194
- subItemsColor?: string | undefined;
195
- } | undefined;
196
- rightLineColor?: string | undefined;
197
- separatorLabelColor?: string | undefined;
198
- } | undefined;
199
- breakpoints?: {
200
- [x: string]: unknown;
201
- small?: string | undefined;
202
- medium?: string | undefined;
203
- large?: string | undefined;
204
- } | undefined;
205
- codeBlock?: {
206
- [x: string]: unknown;
207
- backgroundColor?: string | undefined;
208
- borderRadius?: string | undefined;
209
- tokens?: {
210
- [x: string]: unknown;
211
- fontSize?: string | undefined;
212
- fontWeight?: string | undefined;
213
- fontFamily?: string | undefined;
214
- lineHeight?: string | undefined;
215
- color?: string | undefined;
216
- } | undefined;
217
- } | undefined;
218
- colors?: {
219
- [x: string]: unknown;
220
- responses?: {
221
- [x: string]: unknown;
222
- error?: {
223
- [x: string]: unknown;
224
- color?: string | undefined;
225
- backgroundColor?: string | undefined;
226
- borderColor?: string | undefined;
227
- tabTextColor?: string | undefined;
228
- } | undefined;
229
- success?: {
230
- [x: string]: unknown;
231
- color?: string | undefined;
232
- backgroundColor?: string | undefined;
233
- borderColor?: string | undefined;
234
- tabTextColor?: string | undefined;
235
- } | undefined;
236
- redirect?: {
237
- [x: string]: unknown;
238
- color?: string | undefined;
239
- backgroundColor?: string | undefined;
240
- borderColor?: string | undefined;
241
- tabTextColor?: string | undefined;
242
- } | undefined;
243
- info?: {
244
- [x: string]: unknown;
245
- color?: string | undefined;
246
- backgroundColor?: string | undefined;
247
- borderColor?: string | undefined;
248
- tabTextColor?: string | undefined;
249
- } | undefined;
250
- } | undefined;
251
- http?: {
252
- [x: string]: unknown;
253
- get?: string | undefined;
254
- put?: string | undefined;
255
- post?: string | undefined;
256
- delete?: string | undefined;
257
- options?: string | undefined;
258
- head?: string | undefined;
259
- patch?: string | undefined;
260
- link?: string | undefined;
261
- basic?: string | undefined;
262
- } | undefined;
263
- border?: {
264
- [x: string]: unknown;
265
- main?: string | undefined;
266
- dark?: string | undefined;
267
- light?: string | undefined;
268
- contrastText?: string | undefined;
269
- } | undefined;
270
- text?: {
271
- [x: string]: unknown;
272
- light?: string | undefined;
273
- primary?: string | undefined;
274
- secondary?: string | undefined;
275
- } | undefined;
276
- error?: {
277
- [x: string]: unknown;
278
- main?: string | undefined;
279
- dark?: string | undefined;
280
- light?: string | undefined;
281
- contrastText?: string | undefined;
282
- } | undefined;
283
- success?: {
284
- [x: string]: unknown;
285
- main?: string | undefined;
286
- dark?: string | undefined;
287
- light?: string | undefined;
288
- contrastText?: string | undefined;
289
- } | undefined;
290
- primary?: {
291
- [x: string]: unknown;
292
- main?: string | undefined;
293
- dark?: string | undefined;
294
- light?: string | undefined;
295
- contrastText?: string | undefined;
296
- } | undefined;
297
- secondary?: {
298
- [x: string]: unknown;
299
- main?: string | undefined;
300
- dark?: string | undefined;
301
- light?: string | undefined;
302
- contrastText?: string | undefined;
303
- } | undefined;
304
- accent?: {
305
- [x: string]: unknown;
306
- main?: string | undefined;
307
- dark?: string | undefined;
308
- light?: string | undefined;
309
- contrastText?: string | undefined;
310
- } | undefined;
311
- tonalOffset?: number | undefined;
312
- warning?: {
313
- [x: string]: unknown;
314
- main?: string | undefined;
315
- dark?: string | undefined;
316
- light?: string | undefined;
317
- contrastText?: string | undefined;
318
- } | undefined;
319
- } | undefined;
320
- fab?: {
321
- [x: string]: unknown;
322
- color?: string | undefined;
323
- backgroundColor?: string | undefined;
324
- } | undefined;
325
- overrides?: {
326
- [x: string]: unknown;
327
- DownloadButton?: {
328
- [x: string]: unknown;
329
- custom?: string | undefined;
330
- } | undefined;
331
- NextSectionButton?: {
332
- [x: string]: unknown;
333
- custom?: string | undefined;
334
- } | undefined;
335
- } | undefined;
336
- rightPanel?: {
337
- [x: string]: unknown;
338
- width?: string | undefined;
339
- backgroundColor?: string | undefined;
340
- panelBackgroundColor?: string | undefined;
341
- panelControlsBackgroundColor?: string | undefined;
342
- showAtBreakpoint?: string | undefined;
343
- textColor?: string | undefined;
344
- } | undefined;
345
- shape?: {
346
- [x: string]: unknown;
347
- borderRadius?: string | undefined;
348
- } | undefined;
349
- typography?: {
350
- [x: string]: unknown;
351
- links?: {
352
- [x: string]: unknown;
353
- color?: string | undefined;
354
- textDecoration?: string | undefined;
355
- hover?: string | undefined;
356
- hoverTextDecoration?: string | undefined;
357
- visited?: string | undefined;
358
- } | undefined;
359
- code?: {
360
- [x: string]: unknown;
361
- fontSize?: string | undefined;
362
- fontWeight?: string | undefined;
363
- fontFamily?: string | undefined;
364
- lineHeight?: string | undefined;
365
- color?: string | undefined;
366
- backgroundColor?: string | undefined;
367
- wordBreak?: "inherit" | "initial" | "break-all" | "break-word" | "revert" | "unset" | "keep-all" | "normal" | undefined;
368
- wrap?: boolean | undefined;
369
- } | undefined;
370
- fontSize?: string | undefined;
371
- fontWeight?: string | undefined;
372
- fontFamily?: string | undefined;
373
- lineHeight?: string | undefined;
374
- fieldName?: {
375
- [x: string]: unknown;
376
- fontSize?: string | undefined;
377
- fontWeight?: string | undefined;
378
- fontFamily?: string | undefined;
379
- lineHeight?: string | undefined;
380
- } | undefined;
381
- fontWeightBold?: string | undefined;
382
- fontWeightLight?: string | undefined;
383
- fontWeightRegular?: string | undefined;
384
- heading1?: {
385
- [x: string]: unknown;
386
- fontSize?: string | undefined;
387
- fontWeight?: string | undefined;
388
- fontFamily?: string | undefined;
389
- lineHeight?: string | undefined;
390
- color?: string | undefined;
391
- transform?: string | undefined;
392
- } | undefined;
393
- heading2?: {
394
- [x: string]: unknown;
395
- fontSize?: string | undefined;
396
- fontWeight?: string | undefined;
397
- fontFamily?: string | undefined;
398
- lineHeight?: string | undefined;
399
- color?: string | undefined;
400
- transform?: string | undefined;
401
- } | undefined;
402
- heading3?: {
403
- [x: string]: unknown;
404
- fontSize?: string | undefined;
405
- fontWeight?: string | undefined;
406
- fontFamily?: string | undefined;
407
- lineHeight?: string | undefined;
408
- color?: string | undefined;
409
- transform?: string | undefined;
410
- } | undefined;
411
- headings?: {
412
- [x: string]: unknown;
413
- fontSize?: string | undefined;
414
- fontWeight?: string | undefined;
415
- fontFamily?: string | undefined;
416
- lineHeight?: string | undefined;
417
- } | undefined;
418
- optimizeSpeed?: boolean | undefined;
419
- rightPanelHeading?: {
420
- [x: string]: unknown;
421
- fontSize?: string | undefined;
422
- fontWeight?: string | undefined;
423
- fontFamily?: string | undefined;
424
- lineHeight?: string | undefined;
425
- color?: string | undefined;
426
- transform?: string | undefined;
427
- } | undefined;
428
- smoothing?: "none" | "auto" | "antialiased" | "subpixel-antialiased" | "grayscale" | undefined;
429
- } | undefined;
430
- codeSample?: unknown;
431
- } | undefined;
432
- onlyRequiredInSamples?: boolean | undefined;
433
- generatedSamplesMaxDepth?: string | number | undefined;
434
- generatedPayloadSamplesMaxDepth?: number | undefined;
435
- licenseKey?: string | undefined;
436
- hideLoading?: boolean | undefined;
437
- disableRouter?: boolean | undefined;
438
- hideSidebar?: boolean | undefined;
439
- feedback?: {
440
- type?: "comment" | "rating" | "sentiment" | "reasons" | "mood" | "scale" | undefined;
441
- hide?: boolean | undefined;
442
- settings?: {
443
- label?: string | undefined;
444
- items?: string[] | undefined;
445
- comment?: {
446
- label?: string | undefined;
447
- hide?: boolean | undefined;
448
- likeLabel?: string | undefined;
449
- dislikeLabel?: string | undefined;
450
- satisfiedLabel?: string | undefined;
451
- neutralLabel?: string | undefined;
452
- dissatisfiedLabel?: string | undefined;
453
- } | undefined;
454
- reasons?: {
455
- label?: string | undefined;
456
- items?: string[] | undefined;
457
- hide?: boolean | undefined;
458
- component?: "checkbox" | "radio" | undefined;
459
- like?: {
460
- label?: string | undefined;
461
- items?: string[] | undefined;
462
- hide?: boolean | undefined;
463
- component?: "checkbox" | "radio" | undefined;
464
- } | undefined;
465
- dislike?: {
466
- label?: string | undefined;
467
- items?: string[] | undefined;
468
- hide?: boolean | undefined;
469
- component?: "checkbox" | "radio" | undefined;
470
- } | undefined;
471
- satisfied?: {
472
- label?: string | undefined;
473
- items?: string[] | undefined;
474
- hide?: boolean | undefined;
475
- component?: "checkbox" | "radio" | undefined;
476
- } | undefined;
477
- neutral?: {
478
- label?: string | undefined;
479
- items?: string[] | undefined;
480
- hide?: boolean | undefined;
481
- component?: "checkbox" | "radio" | undefined;
482
- } | undefined;
483
- dissatisfied?: {
484
- label?: string | undefined;
485
- items?: string[] | undefined;
486
- hide?: boolean | undefined;
487
- component?: "checkbox" | "radio" | undefined;
488
- } | undefined;
489
- } | undefined;
490
- submitText?: string | undefined;
491
- buttonText?: string | undefined;
492
- component?: "checkbox" | "radio" | undefined;
493
- leftScaleLabel?: string | undefined;
494
- rightScaleLabel?: string | undefined;
495
- optionalEmail?: {
496
- label?: string | undefined;
497
- hide?: boolean | undefined;
498
- placeholder?: string | undefined;
499
- } | undefined;
500
- } | undefined;
501
- } | undefined;
502
- hideReplay?: boolean | undefined;
503
- oAuth2RedirectURI?: string | null | undefined;
504
- corsProxyUrl?: string | undefined;
505
- sortRequiredPropsFirst?: boolean | undefined;
506
- sanitize?: boolean | undefined;
507
- hideDownloadButtons?: boolean | undefined;
508
- downloadUrls?: {
509
- title?: string | undefined;
510
- url: string;
511
- }[] | undefined;
512
- showExtensions?: string | boolean | string[] | undefined;
513
- hideSchemaTitles?: boolean | undefined;
514
- jsonSamplesExpandLevel?: string | number | undefined;
515
- schemasExpansionLevel?: string | number | undefined;
516
- mockServer?: {
517
- [x: string]: unknown;
518
- description?: string | undefined;
519
- url?: string | undefined;
520
- position?: "replace" | "off" | "first" | "last" | undefined;
521
- } | undefined;
522
- maxDisplayedEnumValues?: number | undefined;
523
- schemaDefinitionsTagName?: string | undefined;
524
- layout?: "stacked" | "three-panel" | undefined;
525
- hideInfoMetadata?: boolean | undefined;
526
- events?: {
527
- [x: string]: unknown;
528
- } | undefined;
529
- skipBundle?: boolean | undefined;
530
- routingBasePath?: string | undefined;
531
- codeSamples?: {
532
- skipOptionalParameters?: boolean | undefined;
533
- withOAuth2Call?: boolean | undefined;
534
- languages: {
535
- label?: string | undefined;
536
- options?: {
537
- indent?: string | undefined;
538
- binary?: boolean | undefined;
539
- withImports?: boolean | undefined;
540
- withComments?: boolean | undefined;
541
- credentials?: "omit" | "same-origin" | "include" | undefined;
542
- } | undefined;
543
- lang: string;
544
- }[];
545
- } | undefined;
546
- ignoreNamedSchemas?: string | string[] | undefined;
547
- hidePropertiesPrefix?: boolean | undefined;
548
- excludeFromSearch?: boolean | undefined;
549
- scrollYOffset?: string | number | undefined;
550
- disableDeepLinks?: boolean | undefined;
551
- ctrlFHijack?: boolean | undefined;
552
- defaultSampleLanguage?: string | undefined;
553
- disableSearch?: boolean | undefined;
554
- disableSidebar?: boolean | undefined;
555
- downloadDefinitionUrl?: string | undefined;
556
- expandDefaultServerVariables?: boolean | undefined;
557
- enumSkipQuotes?: boolean | undefined;
558
- expandDefaultRequest?: boolean | undefined;
559
- expandDefaultResponse?: boolean | undefined;
560
- expandResponses?: string | undefined;
561
- expandSingleSchemaField?: boolean | undefined;
562
- generateCodeSamples?: {
563
- [x: string]: unknown;
564
- skipOptionalParameters?: boolean | undefined;
565
- languages: {
566
- [x: string]: unknown;
567
- label?: string | undefined;
568
- lang: "JavaScript" | "Node.js" | "curl" | "Java8+Apache" | "Java" | "Python" | "Go" | "PHP" | "C#" | "Ruby" | "R";
569
- }[];
570
- } | undefined;
571
- hideDownloadButton?: boolean | undefined;
572
- hideHostname?: boolean | undefined;
573
- hideInfoSection?: boolean | undefined;
574
- hideLogo?: boolean | undefined;
575
- hideRequestPayloadSample?: boolean | undefined;
576
- hideRightPanel?: boolean | undefined;
577
- hideSchemaPattern?: boolean | undefined;
578
- hideSingleRequestSampleTab?: boolean | undefined;
579
- hideSecuritySection?: boolean | undefined;
580
- hideTryItPanel?: boolean | undefined;
581
- hideFab?: boolean | undefined;
582
- hideOneOfDescription?: boolean | undefined;
583
- htmlTemplate?: string | undefined;
584
- jsonSampleExpandLevel?: string | number | undefined;
585
- labels?: {
586
- [x: string]: unknown;
587
- enum?: string | undefined;
588
- default?: string | undefined;
589
- deprecated?: string | undefined;
590
- example?: string | undefined;
591
- examples?: string | undefined;
592
- nullable?: string | undefined;
593
- enumSingleValue?: string | undefined;
594
- enumArray?: string | undefined;
595
- recursive?: string | undefined;
596
- arrayOf?: string | undefined;
597
- webhook?: string | undefined;
598
- authorizations?: string | undefined;
599
- tryItAuthBasicUsername?: string | undefined;
600
- tryItAuthBasicPassword?: string | undefined;
601
- } | undefined;
602
- menuToggle?: boolean | undefined;
603
- nativeScrollbars?: boolean | undefined;
604
- noAutoAuth?: boolean | undefined;
605
- pagination?: "section" | "none" | "item" | undefined;
606
- pathInMiddlePanel?: boolean | undefined;
607
- payloadSampleIdx?: number | undefined;
608
- requestInterceptor?: {
609
- [x: string]: unknown;
610
- } | undefined;
611
- requiredPropsFirst?: boolean | undefined;
612
- routingStrategy?: string | undefined;
613
- samplesTabsMaxCount?: number | undefined;
614
- schemaExpansionLevel?: string | number | undefined;
615
- minCharacterLengthToInitSearch?: number | undefined;
616
- maxResponseHeadersToShowInTryIt?: number | undefined;
617
- searchAutoExpand?: boolean | undefined;
618
- searchFieldLevelBoost?: number | undefined;
619
- searchMaxDepth?: number | undefined;
620
- searchMode?: "default" | "path-only" | undefined;
621
- searchOperationTitleBoost?: number | undefined;
622
- searchTagTitleBoost?: number | undefined;
623
- sendXUserAgentInTryIt?: boolean | undefined;
624
- showChangeLayoutButton?: boolean | undefined;
625
- showConsole?: boolean | undefined;
626
- showNextButton?: boolean | undefined;
627
- showRightPanelToggle?: boolean | undefined;
628
- showSecuritySchemeType?: boolean | undefined;
629
- showWebhookVerb?: boolean | undefined;
630
- showObjectSchemaExamples?: boolean | undefined;
631
- disableTryItRequestUrlEncoding?: boolean | undefined;
632
- sidebarLinks?: {
633
- [x: string]: unknown;
634
- end?: {
635
- [x: string]: unknown;
636
- target?: string | undefined;
637
- label: string;
638
- link: string;
639
- }[] | undefined;
640
- beforeInfo?: {
641
- [x: string]: unknown;
642
- target?: string | undefined;
643
- label: string;
644
- link: string;
645
- }[] | undefined;
646
- } | undefined;
647
- sideNavStyle?: "path-only" | "summary-only" | "path-first" | "id-only" | undefined;
648
- simpleOneOfTypeLabel?: boolean | undefined;
649
- sortEnumValuesAlphabetically?: boolean | undefined;
650
- sortOperationsAlphabetically?: boolean | undefined;
651
- sortPropsAlphabetically?: boolean | undefined;
652
- sortTagsAlphabetically?: boolean | undefined;
653
- suppressWarnings?: boolean | undefined;
654
- unstable_externalDescription?: boolean | undefined;
655
- unstable_ignoreMimeParameters?: boolean | undefined;
656
- untrustedDefinition?: boolean | undefined;
657
- showAccessMode?: boolean | undefined;
658
- preserveOriginalExtensionsName?: boolean | undefined;
659
- markdownHeadingsAnchorLevel?: number | undefined;
660
- } | undefined>;
2
+ import type { RedocConfig } from '@redocly/config';
3
+ export declare function loadOpenapiConfig(): Promise<RedocConfig>;
661
4
  export declare function loadAndBundleDefinition(specUrlOrObject: Record<string, any> | string): Promise<OpenAPIDefinition>;
package/lib/utils/loadAndBundleSpec.js CHANGED
@@ -1 +1 @@
1
- import{bundle as t,loadConfig as s,Config as a}from"@redocly/openapi-core";import{combineUrls as c}from"@redocly/theme/core/openapi";import{convertSwagger2OpenAPI as f}from"./convertSwagger2OpenAPI.js";import{IS_BROWSER as r}from"./dom.js";import{REDOCLY_CONFIG_FILE as l}from"../constants.js";async function b(){const o=r?window.location.origin:typeof globalThis.process<"u"?globalThis.process.cwd():"";try{return(await s({configPath:c(o,l)})).resolvedConfig.openapi}catch(n){return console.warn("Error loading redocly.yaml",n),{}}}async function h(o){const n=new a({}),e={config:n,base:r?window.location.origin:typeof globalThis.process<"u"?globalThis.process.cwd():""};r&&(n.resolve.http.customFetch=globalThis.fetch),typeof o=="object"&&o!==null?e.doc=d(o):e.ref=o;const{bundle:{parsed:i}}=await t(e);return i.swagger!==void 0?f(i):i}function d(o){return{source:{absoluteRef:""},parsed:o}}export{h as loadAndBundleDefinition,b as loadRedoclyConfig};
1
+ import{bundle as a,loadConfig as r}from"@redocly/openapi-core";import{combineUrls as s}from"@redocly/theme/core/openapi";import{convertSwagger2OpenAPI as c}from"./convertSwagger2OpenAPI.js";import{IS_BROWSER as t}from"./dom.js";import{REDOCLY_CONFIG_FILE as f}from"../constants.js";async function w(){const o=t?window.location.origin:typeof globalThis.process<"u"?globalThis.process.cwd():"";try{return(await r({configPath:s(o,f)}))?.resolvedConfig.openapi||{}}catch(n){return console.warn("Error loading redocly.yaml",n),{}}}async function b(o){const n=await r(),e={config:n,base:t?window.location.origin:typeof globalThis.process<"u"?globalThis.process.cwd():""};t&&(n.resolve.http.customFetch=globalThis.fetch),typeof o=="object"&&o!==null?e.doc=l(o):e.ref=o;const{bundle:{parsed:i}}=await a(e);return i.swagger!==void 0?c(i):i}function l(o){return{source:{absoluteRef:""},parsed:o}}export{b as loadAndBundleDefinition,w as loadOpenapiConfig};