@orval/core 8.5.3 → 8.6.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.
- package/dist/index.d.mts +244 -153
- package/dist/index.mjs +299 -158
- package/dist/index.mjs.map +1 -1
- package/package.json +15 -4
package/dist/index.d.mts
CHANGED
|
@@ -22,7 +22,7 @@ interface NormalizedOptions {
|
|
|
22
22
|
input: NormalizedInputOptions;
|
|
23
23
|
hooks: NormalizedHookOptions;
|
|
24
24
|
}
|
|
25
|
-
|
|
25
|
+
interface NormalizedOutputOptions {
|
|
26
26
|
workspace?: string;
|
|
27
27
|
target: string;
|
|
28
28
|
schemas?: string | SchemaOptions;
|
|
@@ -48,11 +48,30 @@ type NormalizedOutputOptions = {
|
|
|
48
48
|
unionAddMissingProperties: boolean;
|
|
49
49
|
optionsParamRequired: boolean;
|
|
50
50
|
propertySortOrder: PropertySortOrder;
|
|
51
|
-
}
|
|
52
|
-
|
|
51
|
+
}
|
|
52
|
+
interface NormalizedParamsSerializerOptions {
|
|
53
53
|
qs?: Record<string, unknown>;
|
|
54
|
-
}
|
|
55
|
-
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Controls how readonly properties are treated when a schema is reused as a request body.
|
|
57
|
+
*
|
|
58
|
+
* Best practice:
|
|
59
|
+
* - `strip` (default): recommended for most OpenAPI specs, because `readOnly`
|
|
60
|
+
* properties are response-oriented and generally should not constrain request
|
|
61
|
+
* payload authoring.
|
|
62
|
+
* - `preserve`: use when your schema intentionally models immutable request DTOs
|
|
63
|
+
* and you want generated request-body types to keep readonly modifiers.
|
|
64
|
+
*
|
|
65
|
+
* Note: this applies to request bodies regardless of the generated client style
|
|
66
|
+
* (`httpClient`, `httpResource`, etc.). `httpResource` still issues request
|
|
67
|
+
* payloads, so the same OpenAPI guidance applies.
|
|
68
|
+
*
|
|
69
|
+
* If we later want a stricter OpenAPI-aligned mode that omits `readOnly`
|
|
70
|
+
* properties from request bodies entirely, that should be introduced as a new
|
|
71
|
+
* explicit mode rather than overloading `preserve`.
|
|
72
|
+
*/
|
|
73
|
+
type ReadonlyRequestBodiesMode = 'strip' | 'preserve';
|
|
74
|
+
interface NormalizedOverrideOutput {
|
|
56
75
|
title?: (title: string) => string;
|
|
57
76
|
transformer?: OutputTransformer;
|
|
58
77
|
mutator?: NormalizedMutator;
|
|
@@ -85,7 +104,7 @@ type NormalizedOverrideOutput = {
|
|
|
85
104
|
};
|
|
86
105
|
hono: NormalizedHonoOptions;
|
|
87
106
|
query: NormalizedQueryOptions;
|
|
88
|
-
angular:
|
|
107
|
+
angular: NormalizedAngularOptions;
|
|
89
108
|
swr: SwrOptions;
|
|
90
109
|
zod: NormalizedZodOptions;
|
|
91
110
|
fetch: NormalizedFetchOptions;
|
|
@@ -98,6 +117,14 @@ type NormalizedOverrideOutput = {
|
|
|
98
117
|
useNamedParameters?: boolean;
|
|
99
118
|
enumGenerationType: EnumGeneration;
|
|
100
119
|
suppressReadonlyModifier?: boolean;
|
|
120
|
+
/**
|
|
121
|
+
* Controls how readonly properties are handled for generated request-body types.
|
|
122
|
+
*
|
|
123
|
+
* Prefer `strip` for most OpenAPI specs because `readOnly` fields are
|
|
124
|
+
* response-oriented. Use `preserve` only when your request DTOs are
|
|
125
|
+
* intentionally immutable and should remain readonly in generated types.
|
|
126
|
+
*/
|
|
127
|
+
preserveReadonlyRequestBodies?: ReadonlyRequestBodiesMode;
|
|
101
128
|
jsDoc: NormalizedJsDocOptions;
|
|
102
129
|
aliasCombinedTypes: boolean;
|
|
103
130
|
/**
|
|
@@ -105,16 +132,16 @@ type NormalizedOverrideOutput = {
|
|
|
105
132
|
* @default false
|
|
106
133
|
*/
|
|
107
134
|
useNullForOptional?: boolean;
|
|
108
|
-
}
|
|
109
|
-
|
|
135
|
+
}
|
|
136
|
+
interface NormalizedMutator {
|
|
110
137
|
path: string;
|
|
111
138
|
name?: string;
|
|
112
139
|
default: boolean;
|
|
113
140
|
alias?: Record<string, string>;
|
|
114
141
|
external?: string[];
|
|
115
142
|
extension?: string;
|
|
116
|
-
}
|
|
117
|
-
|
|
143
|
+
}
|
|
144
|
+
interface NormalizedOperationOptions {
|
|
118
145
|
transformer?: OutputTransformer;
|
|
119
146
|
mutator?: NormalizedMutator;
|
|
120
147
|
mock?: {
|
|
@@ -123,7 +150,7 @@ type NormalizedOperationOptions = {
|
|
|
123
150
|
};
|
|
124
151
|
contentType?: OverrideOutputContentType;
|
|
125
152
|
query?: NormalizedQueryOptions;
|
|
126
|
-
angular?:
|
|
153
|
+
angular?: NormalizedAngularOptions;
|
|
127
154
|
swr?: SwrOptions;
|
|
128
155
|
zod?: NormalizedZodOptions;
|
|
129
156
|
operationName?: (operation: OpenApiOperationObject, route: string, verb: Verbs) => string;
|
|
@@ -132,8 +159,8 @@ type NormalizedOperationOptions = {
|
|
|
132
159
|
formUrlEncoded?: boolean | NormalizedMutator;
|
|
133
160
|
paramsSerializer?: NormalizedMutator;
|
|
134
161
|
requestOptions?: object | boolean;
|
|
135
|
-
}
|
|
136
|
-
|
|
162
|
+
}
|
|
163
|
+
interface NormalizedInputOptions {
|
|
137
164
|
target: string | OpenApiDocument;
|
|
138
165
|
override: OverrideInput;
|
|
139
166
|
filters?: InputFiltersOptions;
|
|
@@ -143,20 +170,20 @@ type NormalizedInputOptions = {
|
|
|
143
170
|
headers: Record<string, string>;
|
|
144
171
|
}[];
|
|
145
172
|
};
|
|
146
|
-
}
|
|
173
|
+
}
|
|
147
174
|
type OutputClientFunc = (clients: GeneratorClients) => ClientGeneratorsBuilder;
|
|
148
|
-
|
|
175
|
+
interface BaseUrlFromSpec {
|
|
149
176
|
getBaseUrlFromSpecification: true;
|
|
150
177
|
variables?: Record<string, string>;
|
|
151
178
|
index?: number;
|
|
152
179
|
baseUrl?: never;
|
|
153
|
-
}
|
|
154
|
-
|
|
180
|
+
}
|
|
181
|
+
interface BaseUrlFromConstant {
|
|
155
182
|
getBaseUrlFromSpecification: false;
|
|
156
183
|
variables?: never;
|
|
157
184
|
index?: never;
|
|
158
185
|
baseUrl: string;
|
|
159
|
-
}
|
|
186
|
+
}
|
|
160
187
|
declare const PropertySortOrder: {
|
|
161
188
|
readonly ALPHABETICAL: "Alphabetical";
|
|
162
189
|
readonly SPECIFICATION: "Specification";
|
|
@@ -176,15 +203,15 @@ declare const EnumGeneration: {
|
|
|
176
203
|
};
|
|
177
204
|
type EnumGeneration = (typeof EnumGeneration)[keyof typeof EnumGeneration];
|
|
178
205
|
type SchemaGenerationType = 'typescript' | 'zod';
|
|
179
|
-
|
|
206
|
+
interface SchemaOptions {
|
|
180
207
|
path: string;
|
|
181
208
|
type: SchemaGenerationType;
|
|
182
|
-
}
|
|
183
|
-
|
|
209
|
+
}
|
|
210
|
+
interface NormalizedSchemaOptions {
|
|
184
211
|
path: string;
|
|
185
212
|
type: SchemaGenerationType;
|
|
186
|
-
}
|
|
187
|
-
|
|
213
|
+
}
|
|
214
|
+
interface OutputOptions {
|
|
188
215
|
workspace?: string;
|
|
189
216
|
target: string;
|
|
190
217
|
schemas?: string | SchemaOptions;
|
|
@@ -215,13 +242,13 @@ type OutputOptions = {
|
|
|
215
242
|
unionAddMissingProperties?: boolean;
|
|
216
243
|
optionsParamRequired?: boolean;
|
|
217
244
|
propertySortOrder?: PropertySortOrder;
|
|
218
|
-
}
|
|
219
|
-
|
|
245
|
+
}
|
|
246
|
+
interface InputFiltersOptions {
|
|
220
247
|
mode?: 'include' | 'exclude';
|
|
221
248
|
tags?: (string | RegExp)[];
|
|
222
249
|
schemas?: (string | RegExp)[];
|
|
223
|
-
}
|
|
224
|
-
|
|
250
|
+
}
|
|
251
|
+
interface InputOptions {
|
|
225
252
|
target: string | string[] | Record<string, unknown> | OpenApiDocument;
|
|
226
253
|
override?: OverrideInput;
|
|
227
254
|
filters?: InputFiltersOptions;
|
|
@@ -231,7 +258,7 @@ type InputOptions = {
|
|
|
231
258
|
headers: Record<string, string>;
|
|
232
259
|
}[];
|
|
233
260
|
};
|
|
234
|
-
}
|
|
261
|
+
}
|
|
235
262
|
declare const OutputClient: {
|
|
236
263
|
readonly ANGULAR: "angular";
|
|
237
264
|
readonly ANGULAR_QUERY: "angular-query";
|
|
@@ -270,7 +297,7 @@ declare const OutputMockType: {
|
|
|
270
297
|
};
|
|
271
298
|
type OutputMockType = (typeof OutputMockType)[keyof typeof OutputMockType];
|
|
272
299
|
type PreferredContentType = 'application/json' | 'application/xml' | 'text/plain' | 'text/html' | 'application/octet-stream' | (string & {});
|
|
273
|
-
|
|
300
|
+
interface GlobalMockOptions {
|
|
274
301
|
type: OutputMockType;
|
|
275
302
|
useExamples?: boolean;
|
|
276
303
|
generateEachHttpStatus?: boolean;
|
|
@@ -278,9 +305,9 @@ type GlobalMockOptions = {
|
|
|
278
305
|
delayFunctionLazyExecute?: boolean;
|
|
279
306
|
baseUrl?: string;
|
|
280
307
|
locale?: keyof typeof allLocales;
|
|
281
|
-
preferredContentType?:
|
|
308
|
+
preferredContentType?: string;
|
|
282
309
|
indexMockFiles?: boolean;
|
|
283
|
-
}
|
|
310
|
+
}
|
|
284
311
|
type OverrideMockOptions = Partial<GlobalMockOptions> & {
|
|
285
312
|
arrayMin?: number;
|
|
286
313
|
arrayMax?: number;
|
|
@@ -312,18 +339,18 @@ type MockDataArrayFn = (specs: OpenApiDocument) => MockDataArray;
|
|
|
312
339
|
type MockData = MockDataObject | MockDataObjectFn | MockDataArray | MockDataArrayFn;
|
|
313
340
|
type OutputTransformerFn = (verb: GeneratorVerbOptions) => GeneratorVerbOptions;
|
|
314
341
|
type OutputTransformer = string | OutputTransformerFn;
|
|
315
|
-
|
|
342
|
+
interface MutatorObject {
|
|
316
343
|
path: string;
|
|
317
344
|
name?: string;
|
|
318
345
|
default?: boolean;
|
|
319
346
|
alias?: Record<string, string>;
|
|
320
347
|
external?: string[];
|
|
321
348
|
extension?: string;
|
|
322
|
-
}
|
|
349
|
+
}
|
|
323
350
|
type Mutator = string | MutatorObject;
|
|
324
|
-
|
|
351
|
+
interface ParamsSerializerOptions {
|
|
325
352
|
qs?: Record<string, unknown>;
|
|
326
|
-
}
|
|
353
|
+
}
|
|
327
354
|
declare const FormDataArrayHandling: {
|
|
328
355
|
readonly SERIALIZE: "serialize";
|
|
329
356
|
readonly EXPLODE: "explode";
|
|
@@ -346,7 +373,7 @@ type FormDataType<TMutator> = {
|
|
|
346
373
|
mutator?: TMutator;
|
|
347
374
|
arrayHandling: FormDataArrayHandling;
|
|
348
375
|
};
|
|
349
|
-
|
|
376
|
+
interface OverrideOutput {
|
|
350
377
|
title?: (title: string) => string;
|
|
351
378
|
transformer?: OutputTransformer;
|
|
352
379
|
mutator?: Mutator;
|
|
@@ -392,6 +419,14 @@ type OverrideOutput = {
|
|
|
392
419
|
useNamedParameters?: boolean;
|
|
393
420
|
enumGenerationType?: EnumGeneration;
|
|
394
421
|
suppressReadonlyModifier?: boolean;
|
|
422
|
+
/**
|
|
423
|
+
* Controls how readonly properties are handled for generated request-body types.
|
|
424
|
+
*
|
|
425
|
+
* Prefer `strip` for most OpenAPI specs because `readOnly` fields are
|
|
426
|
+
* response-oriented. Use `preserve` only when your request DTOs are
|
|
427
|
+
* intentionally immutable and should remain readonly in generated types.
|
|
428
|
+
*/
|
|
429
|
+
preserveReadonlyRequestBodies?: ReadonlyRequestBodiesMode;
|
|
395
430
|
jsDoc?: JsDocOptions;
|
|
396
431
|
aliasCombinedTypes?: boolean;
|
|
397
432
|
/**
|
|
@@ -399,38 +434,38 @@ type OverrideOutput = {
|
|
|
399
434
|
* @default false
|
|
400
435
|
*/
|
|
401
436
|
useNullForOptional?: boolean;
|
|
402
|
-
}
|
|
403
|
-
|
|
437
|
+
}
|
|
438
|
+
interface JsDocOptions {
|
|
404
439
|
filter?: (schema: Record<string, unknown>) => {
|
|
405
440
|
key: string;
|
|
406
441
|
value: string;
|
|
407
442
|
}[];
|
|
408
|
-
}
|
|
409
|
-
|
|
443
|
+
}
|
|
444
|
+
interface NormalizedJsDocOptions {
|
|
410
445
|
filter?: (schema: Record<string, unknown>) => {
|
|
411
446
|
key: string;
|
|
412
447
|
value: string;
|
|
413
448
|
}[];
|
|
414
|
-
}
|
|
415
|
-
|
|
449
|
+
}
|
|
450
|
+
interface OverrideOutputContentType {
|
|
416
451
|
include?: string[];
|
|
417
452
|
exclude?: string[];
|
|
418
|
-
}
|
|
419
|
-
|
|
453
|
+
}
|
|
454
|
+
interface NormalizedHonoOptions {
|
|
420
455
|
handlers?: string;
|
|
421
456
|
compositeRoute: string;
|
|
422
457
|
validator: boolean | 'hono';
|
|
423
458
|
validatorOutputPath: string;
|
|
424
|
-
}
|
|
425
|
-
|
|
459
|
+
}
|
|
460
|
+
interface ZodDateTimeOptions {
|
|
426
461
|
offset?: boolean;
|
|
427
462
|
local?: boolean;
|
|
428
463
|
precision?: number;
|
|
429
|
-
}
|
|
430
|
-
|
|
464
|
+
}
|
|
465
|
+
interface ZodTimeOptions {
|
|
431
466
|
precision?: -1 | 0 | 1 | 2 | 3;
|
|
432
|
-
}
|
|
433
|
-
|
|
467
|
+
}
|
|
468
|
+
interface ZodOptions {
|
|
434
469
|
strict?: {
|
|
435
470
|
param?: boolean;
|
|
436
471
|
query?: boolean;
|
|
@@ -462,9 +497,9 @@ type ZodOptions = {
|
|
|
462
497
|
dateTimeOptions?: ZodDateTimeOptions;
|
|
463
498
|
timeOptions?: ZodTimeOptions;
|
|
464
499
|
generateEachHttpStatus?: boolean;
|
|
465
|
-
}
|
|
500
|
+
}
|
|
466
501
|
type ZodCoerceType = 'string' | 'number' | 'boolean' | 'bigint' | 'date';
|
|
467
|
-
|
|
502
|
+
interface NormalizedZodOptions {
|
|
468
503
|
strict: {
|
|
469
504
|
param: boolean;
|
|
470
505
|
query: boolean;
|
|
@@ -496,25 +531,25 @@ type NormalizedZodOptions = {
|
|
|
496
531
|
generateEachHttpStatus: boolean;
|
|
497
532
|
dateTimeOptions: ZodDateTimeOptions;
|
|
498
533
|
timeOptions: ZodTimeOptions;
|
|
499
|
-
}
|
|
534
|
+
}
|
|
500
535
|
type InvalidateTarget = string | {
|
|
501
536
|
query: string;
|
|
502
537
|
params?: string[] | Record<string, string>;
|
|
503
538
|
invalidateMode?: 'invalidate' | 'reset';
|
|
504
539
|
file?: string;
|
|
505
540
|
};
|
|
506
|
-
|
|
541
|
+
interface MutationInvalidatesRule {
|
|
507
542
|
onMutations: string[];
|
|
508
543
|
invalidates: InvalidateTarget[];
|
|
509
|
-
}
|
|
544
|
+
}
|
|
510
545
|
type MutationInvalidatesConfig = MutationInvalidatesRule[];
|
|
511
|
-
|
|
546
|
+
interface HonoOptions {
|
|
512
547
|
handlers?: string;
|
|
513
548
|
compositeRoute?: string;
|
|
514
549
|
validator?: boolean | 'hono';
|
|
515
550
|
validatorOutputPath?: string;
|
|
516
|
-
}
|
|
517
|
-
|
|
551
|
+
}
|
|
552
|
+
interface NormalizedQueryOptions {
|
|
518
553
|
useQuery?: boolean;
|
|
519
554
|
useSuspenseQuery?: boolean;
|
|
520
555
|
useMutation?: boolean;
|
|
@@ -536,8 +571,8 @@ type NormalizedQueryOptions = {
|
|
|
536
571
|
version?: 3 | 4 | 5;
|
|
537
572
|
mutationInvalidates?: MutationInvalidatesConfig;
|
|
538
573
|
runtimeValidation?: boolean;
|
|
539
|
-
}
|
|
540
|
-
|
|
574
|
+
}
|
|
575
|
+
interface QueryOptions {
|
|
541
576
|
useQuery?: boolean;
|
|
542
577
|
useSuspenseQuery?: boolean;
|
|
543
578
|
useMutation?: boolean;
|
|
@@ -559,12 +594,58 @@ type QueryOptions = {
|
|
|
559
594
|
version?: 3 | 4 | 5;
|
|
560
595
|
mutationInvalidates?: MutationInvalidatesConfig;
|
|
561
596
|
runtimeValidation?: boolean;
|
|
562
|
-
}
|
|
563
|
-
|
|
597
|
+
}
|
|
598
|
+
interface AngularOptions {
|
|
564
599
|
provideIn?: 'root' | 'any' | boolean;
|
|
600
|
+
/**
|
|
601
|
+
* Preferred name for configuring how retrieval-style operations are emitted.
|
|
602
|
+
*
|
|
603
|
+
* - `httpClient`: keep retrievals as service methods
|
|
604
|
+
* - `httpResource`: emit retrievals as Angular `httpResource` helpers
|
|
605
|
+
* - `both`: emit retrieval helpers and keep service methods where needed
|
|
606
|
+
*
|
|
607
|
+
* Mutation-style operations still use generated `HttpClient` service methods
|
|
608
|
+
* by default unless a per-operation override forces a different behavior.
|
|
609
|
+
*/
|
|
610
|
+
retrievalClient?: 'httpClient' | 'httpResource' | 'both';
|
|
611
|
+
/**
|
|
612
|
+
* Backward-compatible alias for `retrievalClient`.
|
|
613
|
+
*
|
|
614
|
+
* Kept for compatibility with existing configs.
|
|
615
|
+
*/
|
|
616
|
+
client?: 'httpClient' | 'httpResource' | 'both';
|
|
565
617
|
runtimeValidation?: boolean;
|
|
566
|
-
|
|
567
|
-
|
|
618
|
+
httpResource?: AngularHttpResourceOptions;
|
|
619
|
+
}
|
|
620
|
+
interface NormalizedAngularOptions {
|
|
621
|
+
provideIn: 'root' | 'any' | boolean;
|
|
622
|
+
client: 'httpClient' | 'httpResource' | 'both';
|
|
623
|
+
runtimeValidation: boolean;
|
|
624
|
+
httpResource?: AngularHttpResourceOptions;
|
|
625
|
+
}
|
|
626
|
+
interface AngularHttpResourceOptions {
|
|
627
|
+
/**
|
|
628
|
+
* Value to expose while the resource is idle/loading.
|
|
629
|
+
*
|
|
630
|
+
* Serialized as a literal into generated code.
|
|
631
|
+
*/
|
|
632
|
+
defaultValue?: unknown;
|
|
633
|
+
/**
|
|
634
|
+
* Debug name shown in Angular DevTools.
|
|
635
|
+
*/
|
|
636
|
+
debugName?: string;
|
|
637
|
+
/**
|
|
638
|
+
* Raw code expression for HttpResourceOptions.injector.
|
|
639
|
+
* Example: `inject(Injector)`.
|
|
640
|
+
*/
|
|
641
|
+
injector?: string;
|
|
642
|
+
/**
|
|
643
|
+
* Raw code expression for HttpResourceOptions.equal.
|
|
644
|
+
* Example: `(a, b) => a.id === b.id`.
|
|
645
|
+
*/
|
|
646
|
+
equal?: string;
|
|
647
|
+
}
|
|
648
|
+
interface SwrOptions {
|
|
568
649
|
useInfinite?: boolean;
|
|
569
650
|
useSWRMutationForGet?: boolean;
|
|
570
651
|
useSuspense?: boolean;
|
|
@@ -572,25 +653,25 @@ type SwrOptions = {
|
|
|
572
653
|
swrOptions?: unknown;
|
|
573
654
|
swrMutationOptions?: unknown;
|
|
574
655
|
swrInfiniteOptions?: unknown;
|
|
575
|
-
}
|
|
576
|
-
|
|
656
|
+
}
|
|
657
|
+
interface NormalizedFetchOptions {
|
|
577
658
|
includeHttpResponseReturnType: boolean;
|
|
578
659
|
forceSuccessResponse: boolean;
|
|
579
660
|
jsonReviver?: Mutator;
|
|
580
661
|
runtimeValidation: boolean;
|
|
581
|
-
}
|
|
582
|
-
|
|
662
|
+
}
|
|
663
|
+
interface FetchOptions {
|
|
583
664
|
includeHttpResponseReturnType?: boolean;
|
|
584
665
|
forceSuccessResponse?: boolean;
|
|
585
666
|
jsonReviver?: Mutator;
|
|
586
667
|
runtimeValidation?: boolean;
|
|
587
|
-
}
|
|
668
|
+
}
|
|
588
669
|
type InputTransformerFn = (spec: OpenApiDocument) => OpenApiDocument;
|
|
589
670
|
type InputTransformer = string | InputTransformerFn;
|
|
590
|
-
|
|
671
|
+
interface OverrideInput {
|
|
591
672
|
transformer?: InputTransformer;
|
|
592
|
-
}
|
|
593
|
-
|
|
673
|
+
}
|
|
674
|
+
interface OperationOptions {
|
|
594
675
|
transformer?: OutputTransformer;
|
|
595
676
|
mutator?: Mutator;
|
|
596
677
|
mock?: {
|
|
@@ -598,7 +679,7 @@ type OperationOptions = {
|
|
|
598
679
|
properties?: MockProperties;
|
|
599
680
|
};
|
|
600
681
|
query?: QueryOptions;
|
|
601
|
-
angular?:
|
|
682
|
+
angular?: AngularOptions;
|
|
602
683
|
swr?: SwrOptions;
|
|
603
684
|
zod?: ZodOptions;
|
|
604
685
|
operationName?: (operation: OpenApiOperationObject, route: string, verb: Verbs) => string;
|
|
@@ -607,9 +688,9 @@ type OperationOptions = {
|
|
|
607
688
|
formUrlEncoded?: boolean | Mutator;
|
|
608
689
|
paramsSerializer?: Mutator;
|
|
609
690
|
requestOptions?: object | boolean;
|
|
610
|
-
}
|
|
691
|
+
}
|
|
611
692
|
type Hook = 'afterAllFilesWrite';
|
|
612
|
-
type HookFunction = (...args:
|
|
693
|
+
type HookFunction<TArgs extends unknown[] = unknown[]> = (...args: TArgs) => void | Promise<void>;
|
|
613
694
|
interface HookOption {
|
|
614
695
|
command: string | HookFunction;
|
|
615
696
|
injectGeneratedDirsAndFiles?: boolean;
|
|
@@ -627,14 +708,14 @@ declare const Verbs: {
|
|
|
627
708
|
DELETE: Verbs;
|
|
628
709
|
HEAD: Verbs;
|
|
629
710
|
};
|
|
630
|
-
|
|
711
|
+
interface ImportOpenApi {
|
|
631
712
|
spec: OpenApiDocument;
|
|
632
713
|
input: NormalizedInputOptions;
|
|
633
714
|
output: NormalizedOutputOptions;
|
|
634
715
|
target: string;
|
|
635
716
|
workspace: string;
|
|
636
717
|
projectName?: string;
|
|
637
|
-
}
|
|
718
|
+
}
|
|
638
719
|
interface ContextSpec {
|
|
639
720
|
projectName?: string;
|
|
640
721
|
target: string;
|
|
@@ -645,6 +726,7 @@ interface ContextSpec {
|
|
|
645
726
|
}
|
|
646
727
|
interface GlobalOptions {
|
|
647
728
|
watch?: boolean | string | string[];
|
|
729
|
+
verbose?: boolean;
|
|
648
730
|
clean?: boolean | string[];
|
|
649
731
|
prettier?: boolean;
|
|
650
732
|
biome?: boolean;
|
|
@@ -656,7 +738,6 @@ interface GlobalOptions {
|
|
|
656
738
|
packageJson?: string;
|
|
657
739
|
input?: string | string[];
|
|
658
740
|
output?: string;
|
|
659
|
-
verbose?: boolean;
|
|
660
741
|
}
|
|
661
742
|
interface Tsconfig {
|
|
662
743
|
baseUrl?: string;
|
|
@@ -677,14 +758,14 @@ interface PackageJson {
|
|
|
677
758
|
catalogs?: Record<string, Record<string, string>>;
|
|
678
759
|
resolvedVersions?: Record<string, string>;
|
|
679
760
|
}
|
|
680
|
-
|
|
761
|
+
interface GeneratorSchema {
|
|
681
762
|
name: string;
|
|
682
763
|
model: string;
|
|
683
764
|
imports: GeneratorImport[];
|
|
684
765
|
dependencies?: string[];
|
|
685
766
|
schema?: OpenApiSchemaObject;
|
|
686
|
-
}
|
|
687
|
-
|
|
767
|
+
}
|
|
768
|
+
interface GeneratorImport {
|
|
688
769
|
readonly name: string;
|
|
689
770
|
readonly schemaName?: string;
|
|
690
771
|
readonly isZodSchema?: boolean;
|
|
@@ -695,17 +776,17 @@ type GeneratorImport = {
|
|
|
695
776
|
readonly syntheticDefaultImport?: boolean;
|
|
696
777
|
readonly namespaceImport?: boolean;
|
|
697
778
|
readonly importPath?: string;
|
|
698
|
-
}
|
|
699
|
-
|
|
779
|
+
}
|
|
780
|
+
interface GeneratorDependency {
|
|
700
781
|
readonly exports: readonly GeneratorImport[];
|
|
701
782
|
readonly dependency: string;
|
|
702
|
-
}
|
|
703
|
-
|
|
783
|
+
}
|
|
784
|
+
interface GeneratorApiResponse {
|
|
704
785
|
operations: GeneratorOperations;
|
|
705
786
|
schemas: GeneratorSchema[];
|
|
706
|
-
}
|
|
787
|
+
}
|
|
707
788
|
type GeneratorOperations = Record<string, GeneratorOperation>;
|
|
708
|
-
|
|
789
|
+
interface GeneratorTarget {
|
|
709
790
|
imports: GeneratorImport[];
|
|
710
791
|
implementation: string;
|
|
711
792
|
implementationMock: string;
|
|
@@ -716,8 +797,8 @@ type GeneratorTarget = {
|
|
|
716
797
|
formUrlEncoded?: GeneratorMutator[];
|
|
717
798
|
paramsSerializer?: GeneratorMutator[];
|
|
718
799
|
fetchReviver?: GeneratorMutator[];
|
|
719
|
-
}
|
|
720
|
-
|
|
800
|
+
}
|
|
801
|
+
interface GeneratorTargetFull {
|
|
721
802
|
imports: GeneratorImport[];
|
|
722
803
|
implementation: string;
|
|
723
804
|
implementationMock: {
|
|
@@ -732,8 +813,8 @@ type GeneratorTargetFull = {
|
|
|
732
813
|
formUrlEncoded?: GeneratorMutator[];
|
|
733
814
|
paramsSerializer?: GeneratorMutator[];
|
|
734
815
|
fetchReviver?: GeneratorMutator[];
|
|
735
|
-
}
|
|
736
|
-
|
|
816
|
+
}
|
|
817
|
+
interface GeneratorOperation {
|
|
737
818
|
imports: GeneratorImport[];
|
|
738
819
|
implementation: string;
|
|
739
820
|
implementationMock: {
|
|
@@ -753,8 +834,8 @@ type GeneratorOperation = {
|
|
|
753
834
|
types?: {
|
|
754
835
|
result: (title?: string) => string;
|
|
755
836
|
};
|
|
756
|
-
}
|
|
757
|
-
|
|
837
|
+
}
|
|
838
|
+
interface GeneratorVerbOptions {
|
|
758
839
|
verb: Verbs;
|
|
759
840
|
route: string;
|
|
760
841
|
pathRoute: string;
|
|
@@ -777,26 +858,26 @@ type GeneratorVerbOptions = {
|
|
|
777
858
|
override: NormalizedOverrideOutput;
|
|
778
859
|
deprecated?: boolean;
|
|
779
860
|
originalOperation: OpenApiOperationObject;
|
|
780
|
-
}
|
|
861
|
+
}
|
|
781
862
|
type GeneratorVerbsOptions = GeneratorVerbOptions[];
|
|
782
|
-
|
|
863
|
+
interface GeneratorOptions {
|
|
783
864
|
route: string;
|
|
784
865
|
pathRoute: string;
|
|
785
866
|
override: NormalizedOverrideOutput;
|
|
786
867
|
context: ContextSpec;
|
|
787
868
|
mock?: GlobalMockOptions | ClientMockBuilder;
|
|
788
869
|
output: string;
|
|
789
|
-
}
|
|
790
|
-
|
|
870
|
+
}
|
|
871
|
+
interface GeneratorClient {
|
|
791
872
|
implementation: string;
|
|
792
873
|
imports: GeneratorImport[];
|
|
793
874
|
mutators?: GeneratorMutator[];
|
|
794
|
-
}
|
|
795
|
-
|
|
875
|
+
}
|
|
876
|
+
interface GeneratorMutatorParsingInfo {
|
|
796
877
|
numberOfParams: number;
|
|
797
878
|
returnNumberOfParams?: number;
|
|
798
|
-
}
|
|
799
|
-
|
|
879
|
+
}
|
|
880
|
+
interface GeneratorMutator {
|
|
800
881
|
name: string;
|
|
801
882
|
path: string;
|
|
802
883
|
default: boolean;
|
|
@@ -806,12 +887,12 @@ type GeneratorMutator = {
|
|
|
806
887
|
hasThirdArg: boolean;
|
|
807
888
|
isHook: boolean;
|
|
808
889
|
bodyTypeName?: string;
|
|
809
|
-
}
|
|
890
|
+
}
|
|
810
891
|
type ClientBuilder = (verbOptions: GeneratorVerbOptions, options: GeneratorOptions, outputClient: OutputClient | OutputClientFunc, output?: NormalizedOutputOptions) => GeneratorClient | Promise<GeneratorClient>;
|
|
811
|
-
|
|
892
|
+
interface ClientFileBuilder {
|
|
812
893
|
path: string;
|
|
813
894
|
content: string;
|
|
814
|
-
}
|
|
895
|
+
}
|
|
815
896
|
type ClientExtraFilesBuilder = (verbOptions: Record<string, GeneratorVerbOptions>, output: NormalizedOutputOptions, context: ContextSpec) => Promise<ClientFileBuilder[]>;
|
|
816
897
|
type ClientHeaderBuilder = (params: {
|
|
817
898
|
title: string;
|
|
@@ -834,16 +915,16 @@ type ClientFooterBuilder = (params: {
|
|
|
834
915
|
hasMutator: boolean;
|
|
835
916
|
}) => string;
|
|
836
917
|
type ClientTitleBuilder = (title: string) => string;
|
|
837
|
-
type ClientDependenciesBuilder = (hasGlobalMutator: boolean, hasParamsSerializerOptions: boolean, packageJson?: PackageJson, httpClient?: OutputHttpClient, hasTagsMutator?: boolean, override?: NormalizedOverrideOutput) =>
|
|
838
|
-
|
|
918
|
+
type ClientDependenciesBuilder = (hasGlobalMutator: boolean, hasParamsSerializerOptions: boolean, packageJson?: PackageJson, httpClient?: OutputHttpClient, hasTagsMutator?: boolean, override?: NormalizedOverrideOutput) => GeneratorDependency[];
|
|
919
|
+
interface ClientMockGeneratorImplementation {
|
|
839
920
|
function: string;
|
|
840
921
|
handlerName: string;
|
|
841
922
|
handler: string;
|
|
842
|
-
}
|
|
843
|
-
|
|
923
|
+
}
|
|
924
|
+
interface ClientMockGeneratorBuilder {
|
|
844
925
|
imports: GeneratorImport[];
|
|
845
926
|
implementation: ClientMockGeneratorImplementation;
|
|
846
|
-
}
|
|
927
|
+
}
|
|
847
928
|
type ClientMockBuilder = (verbOptions: GeneratorVerbOptions, generatorOptions: GeneratorOptions) => ClientMockGeneratorBuilder;
|
|
848
929
|
interface ClientGeneratorsBuilder {
|
|
849
930
|
client: ClientBuilder;
|
|
@@ -854,7 +935,7 @@ interface ClientGeneratorsBuilder {
|
|
|
854
935
|
extraFiles?: ClientExtraFilesBuilder;
|
|
855
936
|
}
|
|
856
937
|
type GeneratorClients = Record<OutputClient, ClientGeneratorsBuilder>;
|
|
857
|
-
|
|
938
|
+
interface GetterResponse {
|
|
858
939
|
imports: GeneratorImport[];
|
|
859
940
|
definition: {
|
|
860
941
|
success: string;
|
|
@@ -868,8 +949,8 @@ type GetterResponse = {
|
|
|
868
949
|
contentTypes: string[];
|
|
869
950
|
schemas: GeneratorSchema[];
|
|
870
951
|
originalSchema?: OpenApiResponsesObject;
|
|
871
|
-
}
|
|
872
|
-
|
|
952
|
+
}
|
|
953
|
+
interface GetterBody {
|
|
873
954
|
originalSchema: OpenApiReferenceObject | OpenApiRequestBodyObject;
|
|
874
955
|
imports: GeneratorImport[];
|
|
875
956
|
definition: string;
|
|
@@ -879,8 +960,8 @@ type GetterBody = {
|
|
|
879
960
|
formUrlEncoded?: string;
|
|
880
961
|
contentType: string;
|
|
881
962
|
isOptional: boolean;
|
|
882
|
-
}
|
|
883
|
-
|
|
963
|
+
}
|
|
964
|
+
interface GetterParameters {
|
|
884
965
|
query: {
|
|
885
966
|
parameter: OpenApiParameterObject;
|
|
886
967
|
imports: GeneratorImport[];
|
|
@@ -893,23 +974,23 @@ type GetterParameters = {
|
|
|
893
974
|
parameter: OpenApiParameterObject;
|
|
894
975
|
imports: GeneratorImport[];
|
|
895
976
|
}[];
|
|
896
|
-
}
|
|
897
|
-
|
|
977
|
+
}
|
|
978
|
+
interface GetterParam {
|
|
898
979
|
name: string;
|
|
899
980
|
definition: string;
|
|
900
981
|
implementation: string;
|
|
901
|
-
default:
|
|
982
|
+
default: unknown;
|
|
902
983
|
required: boolean;
|
|
903
984
|
imports: GeneratorImport[];
|
|
904
|
-
}
|
|
985
|
+
}
|
|
905
986
|
type GetterParams = GetterParam[];
|
|
906
|
-
|
|
987
|
+
interface GetterQueryParam {
|
|
907
988
|
schema: GeneratorSchema;
|
|
908
989
|
deps: GeneratorSchema[];
|
|
909
990
|
isOptional: boolean;
|
|
910
|
-
requiredNullableKeys?: string[];
|
|
911
991
|
originalSchema?: OpenApiSchemaObject;
|
|
912
|
-
|
|
992
|
+
requiredNullableKeys?: string[];
|
|
993
|
+
}
|
|
913
994
|
type GetterPropType = 'param' | 'body' | 'queryParam' | 'header' | 'namedPathParams';
|
|
914
995
|
declare const GetterPropType: {
|
|
915
996
|
readonly PARAM: "param";
|
|
@@ -918,13 +999,13 @@ declare const GetterPropType: {
|
|
|
918
999
|
readonly QUERY_PARAM: "queryParam";
|
|
919
1000
|
readonly HEADER: "header";
|
|
920
1001
|
};
|
|
921
|
-
|
|
1002
|
+
interface GetterPropBase {
|
|
922
1003
|
name: string;
|
|
923
1004
|
definition: string;
|
|
924
1005
|
implementation: string;
|
|
925
|
-
default:
|
|
1006
|
+
default: unknown;
|
|
926
1007
|
required: boolean;
|
|
927
|
-
}
|
|
1008
|
+
}
|
|
928
1009
|
type GetterProp = GetterPropBase & ({
|
|
929
1010
|
type: 'namedPathParams';
|
|
930
1011
|
destructured: string;
|
|
@@ -945,7 +1026,7 @@ declare const SchemaType: {
|
|
|
945
1026
|
enum: string;
|
|
946
1027
|
unknown: string;
|
|
947
1028
|
};
|
|
948
|
-
|
|
1029
|
+
interface ScalarValue {
|
|
949
1030
|
value: string;
|
|
950
1031
|
useTypeAlias?: boolean;
|
|
951
1032
|
isEnum: boolean;
|
|
@@ -956,8 +1037,8 @@ type ScalarValue = {
|
|
|
956
1037
|
isRef: boolean;
|
|
957
1038
|
dependencies: string[];
|
|
958
1039
|
example?: unknown;
|
|
959
|
-
examples?: Record<string, unknown
|
|
960
|
-
}
|
|
1040
|
+
examples?: Record<string, unknown> | unknown[];
|
|
1041
|
+
}
|
|
961
1042
|
type ResolverValue = ScalarValue & {
|
|
962
1043
|
originalSchema: OpenApiSchemaObject;
|
|
963
1044
|
};
|
|
@@ -970,7 +1051,7 @@ type ResReqTypesValue = ScalarValue & {
|
|
|
970
1051
|
contentType: string;
|
|
971
1052
|
originalSchema?: OpenApiSchemaObject;
|
|
972
1053
|
};
|
|
973
|
-
|
|
1054
|
+
interface WriteSpecBuilder {
|
|
974
1055
|
operations: GeneratorOperations;
|
|
975
1056
|
verbOptions: Record<string, GeneratorVerbOptions>;
|
|
976
1057
|
schemas: GeneratorSchema[];
|
|
@@ -983,24 +1064,24 @@ type WriteSpecBuilder = {
|
|
|
983
1064
|
info: OpenApiInfoObject;
|
|
984
1065
|
target: string;
|
|
985
1066
|
spec: OpenApiDocument;
|
|
986
|
-
}
|
|
987
|
-
|
|
1067
|
+
}
|
|
1068
|
+
interface WriteModeProps {
|
|
988
1069
|
builder: WriteSpecBuilder;
|
|
989
1070
|
output: NormalizedOutputOptions;
|
|
990
1071
|
workspace: string;
|
|
991
1072
|
projectName?: string;
|
|
992
1073
|
header: string;
|
|
993
1074
|
needSchema: boolean;
|
|
994
|
-
}
|
|
995
|
-
|
|
1075
|
+
}
|
|
1076
|
+
interface GeneratorApiOperations {
|
|
996
1077
|
verbOptions: Record<string, GeneratorVerbOptions>;
|
|
997
1078
|
operations: GeneratorOperations;
|
|
998
1079
|
schemas: GeneratorSchema[];
|
|
999
|
-
}
|
|
1000
|
-
|
|
1080
|
+
}
|
|
1081
|
+
interface GeneratorClientExtra {
|
|
1001
1082
|
implementation: string;
|
|
1002
1083
|
implementationMock: string;
|
|
1003
|
-
}
|
|
1084
|
+
}
|
|
1004
1085
|
type GeneratorClientTitle = (data: {
|
|
1005
1086
|
outputClient?: OutputClient | OutputClientFunc;
|
|
1006
1087
|
title: string;
|
|
@@ -1095,7 +1176,6 @@ declare function generateComponentDefinition(responses: OpenApiComponentsObject[
|
|
|
1095
1176
|
//#region src/generators/imports.d.ts
|
|
1096
1177
|
interface GenerateImportsOptions {
|
|
1097
1178
|
imports: readonly GeneratorImport[];
|
|
1098
|
-
target: string;
|
|
1099
1179
|
namingConvention?: NamingConvention;
|
|
1100
1180
|
}
|
|
1101
1181
|
declare function generateImports({
|
|
@@ -1142,7 +1222,7 @@ declare function generateVerbImports({
|
|
|
1142
1222
|
//#endregion
|
|
1143
1223
|
//#region src/generators/models-inline.d.ts
|
|
1144
1224
|
declare function generateModelInline(acc: string, model: string): string;
|
|
1145
|
-
declare function generateModelsInline(obj: Record<string, GeneratorSchema[]>): string;
|
|
1225
|
+
declare function generateModelsInline(obj: Record<string, GeneratorSchema[]> | GeneratorSchema[]): string;
|
|
1146
1226
|
//#endregion
|
|
1147
1227
|
//#region src/generators/mutator.d.ts
|
|
1148
1228
|
declare const BODY_TYPE_NAME = "BodyType";
|
|
@@ -1175,7 +1255,7 @@ declare function generateMutator({
|
|
|
1175
1255
|
* (e.g. observe-mode branches), prefer getAngularFilteredParamsCallExpression +
|
|
1176
1256
|
* getAngularFilteredParamsHelperBody instead.
|
|
1177
1257
|
*/
|
|
1178
|
-
declare const getAngularFilteredParamsExpression: (paramsExpression: string, requiredNullableParamKeys?: string[]) => string;
|
|
1258
|
+
declare const getAngularFilteredParamsExpression: (paramsExpression: string, requiredNullableParamKeys?: string[], preserveRequiredNullables?: boolean) => string;
|
|
1179
1259
|
/**
|
|
1180
1260
|
* Returns the body of a standalone `filterParams` helper function
|
|
1181
1261
|
* to be emitted once in the generated file header, replacing the
|
|
@@ -1185,7 +1265,7 @@ declare const getAngularFilteredParamsHelperBody: () => string;
|
|
|
1185
1265
|
/**
|
|
1186
1266
|
* Returns a call expression to the `filterParams` helper function.
|
|
1187
1267
|
*/
|
|
1188
|
-
declare const getAngularFilteredParamsCallExpression: (paramsExpression: string, requiredNullableParamKeys?: string[]) => string;
|
|
1268
|
+
declare const getAngularFilteredParamsCallExpression: (paramsExpression: string, requiredNullableParamKeys?: string[], preserveRequiredNullables?: boolean) => string;
|
|
1189
1269
|
interface GenerateFormDataAndUrlEncodedFunctionOptions {
|
|
1190
1270
|
body: GetterBody;
|
|
1191
1271
|
formData?: GeneratorMutator;
|
|
@@ -1462,16 +1542,16 @@ declare function getEnumNames(schemaObject: OpenApiSchemaObject | undefined): st
|
|
|
1462
1542
|
declare function getEnumDescriptions(schemaObject: OpenApiSchemaObject | undefined): string[] | undefined;
|
|
1463
1543
|
declare function getEnum(value: string, enumName: string, names: string[] | undefined, enumGenerationType: EnumGeneration, descriptions?: string[], enumNamingConvention?: NamingConvention): string;
|
|
1464
1544
|
declare function getEnumImplementation(value: string, names?: string[], descriptions?: string[], enumNamingConvention?: NamingConvention): string;
|
|
1465
|
-
|
|
1545
|
+
interface CombinedEnumInput {
|
|
1466
1546
|
value: string;
|
|
1467
1547
|
isRef: boolean;
|
|
1468
1548
|
schema: OpenApiSchemaObject | undefined;
|
|
1469
|
-
}
|
|
1470
|
-
|
|
1549
|
+
}
|
|
1550
|
+
interface CombinedEnumValue {
|
|
1471
1551
|
value: string;
|
|
1472
1552
|
valueImports: string[];
|
|
1473
1553
|
hasNull: boolean;
|
|
1474
|
-
}
|
|
1554
|
+
}
|
|
1475
1555
|
declare function getEnumUnionFromSchema(schema: OpenApiSchemaObject | undefined): string;
|
|
1476
1556
|
declare function getCombinedEnumValue(inputs: CombinedEnumInput[]): CombinedEnumValue;
|
|
1477
1557
|
//#endregion
|
|
@@ -1725,8 +1805,8 @@ declare function asyncReduce<IterationItem, AccValue>(array: IterationItem[], re
|
|
|
1725
1805
|
//#region src/utils/case.d.ts
|
|
1726
1806
|
declare function pascal(s?: string): string;
|
|
1727
1807
|
declare function camel(s?: string): string;
|
|
1728
|
-
declare function snake(s
|
|
1729
|
-
declare function kebab(s
|
|
1808
|
+
declare function snake(s?: string): string;
|
|
1809
|
+
declare function kebab(s?: string): string;
|
|
1730
1810
|
declare function upper(s: string, fillWith: string, isDeapostrophe?: boolean): string;
|
|
1731
1811
|
declare function conventionName(name: string, convention: NamingConvention): string;
|
|
1732
1812
|
//#endregion
|
|
@@ -1791,7 +1871,7 @@ declare function createDebugger(ns: string, options?: DebuggerOptions): debug.De
|
|
|
1791
1871
|
type DeepNonNullable<T> = T extends ((...args: never[]) => unknown) ? T : T extends readonly (infer U)[] ? DeepNonNullable<NonNullable<U>>[] : T extends object ? { [K in keyof T]: DeepNonNullable<NonNullable<T[K]>> } : NonNullable<T>;
|
|
1792
1872
|
//#endregion
|
|
1793
1873
|
//#region src/utils/doc.d.ts
|
|
1794
|
-
|
|
1874
|
+
interface JsDocSchema extends Record<string, unknown> {
|
|
1795
1875
|
description?: string[] | string;
|
|
1796
1876
|
deprecated?: boolean;
|
|
1797
1877
|
summary?: string;
|
|
@@ -1805,7 +1885,8 @@ declare function jsDoc(schema: {
|
|
|
1805
1885
|
maxItems?: number;
|
|
1806
1886
|
type?: string | string[];
|
|
1807
1887
|
pattern?: string;
|
|
1808
|
-
}
|
|
1888
|
+
}
|
|
1889
|
+
declare function jsDoc(schema: object & JsDocSchema, tryOneLine?: boolean, context?: ContextSpec): string;
|
|
1809
1890
|
declare function keyValuePairsToJsDoc(keyValues: {
|
|
1810
1891
|
key: string;
|
|
1811
1892
|
value: string;
|
|
@@ -1897,7 +1978,7 @@ interface LoggerOptions {
|
|
|
1897
1978
|
declare function createLogger(level?: LogLevel, options?: LoggerOptions): Logger;
|
|
1898
1979
|
//#endregion
|
|
1899
1980
|
//#region src/utils/merge-deep.d.ts
|
|
1900
|
-
declare function mergeDeep<T extends
|
|
1981
|
+
declare function mergeDeep<T extends object, U extends object>(source: T, target: U): T & U;
|
|
1901
1982
|
//#endregion
|
|
1902
1983
|
//#region src/utils/occurrence.d.ts
|
|
1903
1984
|
declare function count(str: string | undefined, key: string): number;
|
|
@@ -1944,10 +2025,10 @@ declare function resolveInstalledVersions(packageJson: PackageJson, fromDir: str
|
|
|
1944
2025
|
//#endregion
|
|
1945
2026
|
//#region src/utils/sort.d.ts
|
|
1946
2027
|
declare const sortByPriority: <T>(arr: (T & {
|
|
1947
|
-
default?:
|
|
2028
|
+
default?: unknown;
|
|
1948
2029
|
required?: boolean;
|
|
1949
2030
|
})[]) => (T & {
|
|
1950
|
-
default?:
|
|
2031
|
+
default?: unknown;
|
|
1951
2032
|
required?: boolean;
|
|
1952
2033
|
})[];
|
|
1953
2034
|
//#endregion
|
|
@@ -1957,14 +2038,14 @@ declare const sortByPriority: <T>(arr: (T & {
|
|
|
1957
2038
|
* Handles strings, numbers, booleans, functions, arrays, and objects.
|
|
1958
2039
|
*
|
|
1959
2040
|
* @param data - The data to stringify. Can be a string, array, object, number, boolean, function, null, or undefined.
|
|
1960
|
-
* @returns A string representation of the data, or undefined if data is
|
|
2041
|
+
* @returns A string representation of the data, `null` for null, or undefined if data is undefined.
|
|
1961
2042
|
* @example
|
|
1962
2043
|
* stringify('hello') // returns "'hello'"
|
|
1963
2044
|
* stringify(42) // returns "42"
|
|
1964
2045
|
* stringify([1, 2, 3]) // returns "[1, 2, 3]"
|
|
1965
2046
|
* stringify({ a: 1, b: 'test' }) // returns "{ a: 1, b: 'test', }"
|
|
1966
2047
|
*/
|
|
1967
|
-
declare function stringify(data?:
|
|
2048
|
+
declare function stringify(data?: unknown): string | undefined;
|
|
1968
2049
|
/**
|
|
1969
2050
|
* Sanitizes a string value by removing or replacing special characters and ensuring
|
|
1970
2051
|
* it conforms to JavaScript identifier naming rules if needed.
|
|
@@ -2030,6 +2111,16 @@ declare function getNumberWord(num: number): string;
|
|
|
2030
2111
|
* escape("a'''b", "'") // returns "a\'\'\'b"
|
|
2031
2112
|
*/
|
|
2032
2113
|
declare function escape(str: string | null, char?: string): string | undefined;
|
|
2114
|
+
/**
|
|
2115
|
+
* Escapes regular expression metacharacters in a string so it can be safely
|
|
2116
|
+
* embedded inside a RegExp pattern.
|
|
2117
|
+
*
|
|
2118
|
+
* @param value - The raw string value to escape for regex usage.
|
|
2119
|
+
* @returns The escaped string.
|
|
2120
|
+
* @example
|
|
2121
|
+
* escapeRegExp('foo$bar') // returns 'foo\\$bar'
|
|
2122
|
+
*/
|
|
2123
|
+
declare function escapeRegExp(value: string): string;
|
|
2033
2124
|
/**
|
|
2034
2125
|
* Escape all characters not included in SingleStringCharacters and
|
|
2035
2126
|
* DoubleStringCharacters on
|
|
@@ -2149,5 +2240,5 @@ declare function generateTargetForTags(builder: WriteSpecBuilder, options: Norma
|
|
|
2149
2240
|
declare function getOrvalGeneratedTypes(): string;
|
|
2150
2241
|
declare function getTypedResponse(): string;
|
|
2151
2242
|
//#endregion
|
|
2152
|
-
export { AngularOptions, BODY_TYPE_NAME, BaseUrlFromConstant, BaseUrlFromSpec, ClientBuilder, ClientDependenciesBuilder, ClientExtraFilesBuilder, ClientFileBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMockBuilder, ClientMockGeneratorBuilder, ClientMockGeneratorImplementation, ClientTitleBuilder, Config, ConfigExternal, ConfigFn, ContentTypeFilter, ContextSpec, DeepNonNullable, EnumGeneration, ErrorWithTag, FetchOptions, FormDataArrayHandling, FormDataContext, FormDataType, GenerateMockImports, GenerateVerbOptionsParams, GenerateVerbsOptionsParams, GeneratorApiBuilder, GeneratorApiOperations, GeneratorApiResponse, GeneratorClient, GeneratorClientExtra, GeneratorClientFooter, GeneratorClientHeader, GeneratorClientImports, GeneratorClientTitle, GeneratorClients, GeneratorDependency, GeneratorImport, GeneratorMutator, GeneratorMutatorParsingInfo, GeneratorOperation, GeneratorOperations, GeneratorOptions, GeneratorSchema, GeneratorTarget, GeneratorTargetFull, GeneratorVerbOptions, GeneratorVerbsOptions, GetterBody, GetterParam, GetterParameters, GetterParams, GetterProp, GetterPropType, GetterProps, GetterQueryParam, GetterResponse, GlobalMockOptions, GlobalOptions, HonoOptions, Hook, HookCommand, HookFunction, HookOption, HooksOptions, ImportOpenApi, InputFiltersOptions, InputOptions, InputTransformerFn, InvalidateTarget, JsDocOptions, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, MockData, MockDataArray, MockDataArrayFn, MockDataObject, MockDataObjectFn, MockOptions, MockProperties, MockPropertiesObject, MockPropertiesObjectFn, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NamingConvention, NormalizedConfig, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMutator, NormalizedOperationOptions, NormalizedOptions, NormalizedOutputOptions, NormalizedOverrideOutput, NormalizedParamsSerializerOptions, NormalizedQueryOptions, NormalizedSchemaOptions, NormalizedZodOptions, OpenApiComponentsObject, OpenApiDocument, OpenApiEncodingObject, OpenApiExampleObject, OpenApiInfoObject, OpenApiMediaTypeObject, OpenApiOperationObject, OpenApiParameterObject, OpenApiPathItemObject, OpenApiPathsObject, OpenApiReferenceObject, OpenApiRequestBodyObject, OpenApiResponseObject, OpenApiResponsesObject, OpenApiSchemaObject, OpenApiSchemaObjectType, OpenApiSchemasObject, OpenApiServerObject, OperationOptions, Options, OptionsExport, OptionsFn, OutputClient, OutputClientFunc, OutputDocsOptions, OutputHttpClient, OutputMockType, OutputMode, OutputOptions, OverrideInput, OverrideMockOptions, OverrideOutput, OverrideOutputContentType, PackageJson, ParamsSerializerOptions, PreferredContentType, PropertySortOrder, QueryOptions, RefComponentSuffix, RefInfo, ResReqTypesValue, ResolverValue, ResponseTypeCategory, ScalarValue, SchemaGenerationType, SchemaOptions, SchemaType, SwrOptions, TEMPLATE_TAG_REGEX, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecBuilder, ZodCoerceType, ZodDateTimeOptions, ZodOptions, ZodTimeOptions, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dedupeUnionType, dynamicImport, escape, filterByContentType, fixCrossDirectoryImports, fixRegularSchemaImports, generalJSTypes, generalJSTypesWithArray, generateAxiosOptions, generateBodyMutatorConfig, generateBodyOptions, generateComponentDefinition, generateDependencyImports, generateFormDataAndUrlEncodedFunction, generateImports, generateModelInline, generateModelsInline, generateMutator, generateMutatorConfig, generateMutatorImports, generateMutatorRequestOptions, generateOptions, generateParameterDefinition, generateQueryParamsAxiosConfig, generateSchemasDefinition, generateTarget, generateTargetForTags, generateVerbImports, generateVerbOptions, generateVerbsOptions, getAngularFilteredParamsCallExpression, getAngularFilteredParamsExpression, getAngularFilteredParamsHelperBody, getArray, getBody, getCombinedEnumValue, getDefaultContentType, getEnum, getEnumDescriptions, getEnumImplementation, getEnumNames, getEnumUnionFromSchema, getExtension, getFileInfo, getFormDataFieldFileType, getFullRoute, getIsBodyVerb, getKey, getMockFileExtensionByTypeName, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getPropertySafe, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getResponseTypeCategory, getRoute, getRouteAsArray, getScalar, getSuccessResponseType, getTypedResponse, isBinaryContentType, isBoolean, isDirectory, isFunction, isModule, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, isVerbose, jsDoc, jsStringEscape, kebab, keyValuePairsToJsDoc, log, logError, logVerbose, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resolveDiscriminators, resolveExampleRefs, resolveInstalledVersion, resolveInstalledVersions, resolveObject, resolveRef, resolveValue, sanitize, setVerbose, snake, sortByPriority, splitSchemasByType, startMessage, stringify, toObjectString, path_d_exports as upath, upper, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
|
|
2243
|
+
export { AngularHttpResourceOptions, AngularOptions, BODY_TYPE_NAME, BaseUrlFromConstant, BaseUrlFromSpec, ClientBuilder, ClientDependenciesBuilder, ClientExtraFilesBuilder, ClientFileBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMockBuilder, ClientMockGeneratorBuilder, ClientMockGeneratorImplementation, ClientTitleBuilder, Config, ConfigExternal, ConfigFn, ContentTypeFilter, ContextSpec, DeepNonNullable, EnumGeneration, ErrorWithTag, FetchOptions, FormDataArrayHandling, FormDataContext, FormDataType, GenerateMockImports, GenerateVerbOptionsParams, GenerateVerbsOptionsParams, GeneratorApiBuilder, GeneratorApiOperations, GeneratorApiResponse, GeneratorClient, GeneratorClientExtra, GeneratorClientFooter, GeneratorClientHeader, GeneratorClientImports, GeneratorClientTitle, GeneratorClients, GeneratorDependency, GeneratorImport, GeneratorMutator, GeneratorMutatorParsingInfo, GeneratorOperation, GeneratorOperations, GeneratorOptions, GeneratorSchema, GeneratorTarget, GeneratorTargetFull, GeneratorVerbOptions, GeneratorVerbsOptions, GetterBody, GetterParam, GetterParameters, GetterParams, GetterProp, GetterPropType, GetterProps, GetterQueryParam, GetterResponse, GlobalMockOptions, GlobalOptions, HonoOptions, Hook, HookCommand, HookFunction, HookOption, HooksOptions, ImportOpenApi, InputFiltersOptions, InputOptions, InputTransformerFn, InvalidateTarget, JsDocOptions, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, MockData, MockDataArray, MockDataArrayFn, MockDataObject, MockDataObjectFn, MockOptions, MockProperties, MockPropertiesObject, MockPropertiesObjectFn, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NamingConvention, NormalizedAngularOptions, NormalizedConfig, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMutator, NormalizedOperationOptions, NormalizedOptions, NormalizedOutputOptions, NormalizedOverrideOutput, NormalizedParamsSerializerOptions, NormalizedQueryOptions, NormalizedSchemaOptions, NormalizedZodOptions, OpenApiComponentsObject, OpenApiDocument, OpenApiEncodingObject, OpenApiExampleObject, OpenApiInfoObject, OpenApiMediaTypeObject, OpenApiOperationObject, OpenApiParameterObject, OpenApiPathItemObject, OpenApiPathsObject, OpenApiReferenceObject, OpenApiRequestBodyObject, OpenApiResponseObject, OpenApiResponsesObject, OpenApiSchemaObject, OpenApiSchemaObjectType, OpenApiSchemasObject, OpenApiServerObject, OperationOptions, Options, OptionsExport, OptionsFn, OutputClient, OutputClientFunc, OutputDocsOptions, OutputHttpClient, OutputMockType, OutputMode, OutputOptions, OverrideInput, OverrideMockOptions, OverrideOutput, OverrideOutputContentType, PackageJson, ParamsSerializerOptions, PreferredContentType, PropertySortOrder, QueryOptions, ReadonlyRequestBodiesMode, RefComponentSuffix, RefInfo, ResReqTypesValue, ResolverValue, ResponseTypeCategory, ScalarValue, SchemaGenerationType, SchemaOptions, SchemaType, SwrOptions, TEMPLATE_TAG_REGEX, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecBuilder, ZodCoerceType, ZodDateTimeOptions, ZodOptions, ZodTimeOptions, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dedupeUnionType, dynamicImport, escape, escapeRegExp, filterByContentType, fixCrossDirectoryImports, fixRegularSchemaImports, generalJSTypes, generalJSTypesWithArray, generateAxiosOptions, generateBodyMutatorConfig, generateBodyOptions, generateComponentDefinition, generateDependencyImports, generateFormDataAndUrlEncodedFunction, generateImports, generateModelInline, generateModelsInline, generateMutator, generateMutatorConfig, generateMutatorImports, generateMutatorRequestOptions, generateOptions, generateParameterDefinition, generateQueryParamsAxiosConfig, generateSchemasDefinition, generateTarget, generateTargetForTags, generateVerbImports, generateVerbOptions, generateVerbsOptions, getAngularFilteredParamsCallExpression, getAngularFilteredParamsExpression, getAngularFilteredParamsHelperBody, getArray, getBody, getCombinedEnumValue, getDefaultContentType, getEnum, getEnumDescriptions, getEnumImplementation, getEnumNames, getEnumUnionFromSchema, getExtension, getFileInfo, getFormDataFieldFileType, getFullRoute, getIsBodyVerb, getKey, getMockFileExtensionByTypeName, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getPropertySafe, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getResponseTypeCategory, getRoute, getRouteAsArray, getScalar, getSuccessResponseType, getTypedResponse, isBinaryContentType, isBoolean, isDirectory, isFunction, isModule, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, isVerbose, jsDoc, jsStringEscape, kebab, keyValuePairsToJsDoc, log, logError, logVerbose, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resolveDiscriminators, resolveExampleRefs, resolveInstalledVersion, resolveInstalledVersions, resolveObject, resolveRef, resolveValue, sanitize, setVerbose, snake, sortByPriority, splitSchemasByType, startMessage, stringify, toObjectString, path_d_exports as upath, upper, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
|
|
2153
2244
|
//# sourceMappingURL=index.d.mts.map
|