@orval/core 8.0.0-rc.1 → 8.0.0-rc.3
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.ts → index.d.mts} +390 -370
- package/dist/{index.js → index.mjs} +714 -630
- package/dist/index.mjs.map +1 -0
- package/package.json +16 -21
- package/dist/index.js.map +0 -1
- /package/dist/{chunk-Bp6m_JJh.js → chunk-jass6xSI.mjs} +0 -0
|
@@ -1,13 +1,8 @@
|
|
|
1
|
-
import { t as __export } from "./chunk-Bp6m_JJh.js";
|
|
2
1
|
import { CompareOperator } from "compare-versions";
|
|
3
2
|
import debug from "debug";
|
|
4
|
-
import { ConvertInputOptions } from "swagger2openapi";
|
|
5
|
-
import SwaggerParser from "@apidevtools/swagger-parser";
|
|
6
3
|
import { allLocales } from "@faker-js/faker";
|
|
7
|
-
import {
|
|
8
|
-
import { ComponentsObject, ExampleObject, InfoObject, OpenAPIObject, OperationObject, ParameterObject, PathItemObject, ReferenceObject, RequestBodyObject, ResponseObject, ResponsesObject, SchemaObject, SchemasObject } from "openapi3-ts/oas30";
|
|
4
|
+
import { OpenAPIV3_1 } from "@scalar/openapi-types";
|
|
9
5
|
import { TypeDocOptions } from "typedoc";
|
|
10
|
-
import { ServerObject } from "openapi3-ts/oas31";
|
|
11
6
|
|
|
12
7
|
//#region src/types.d.ts
|
|
13
8
|
interface Options {
|
|
@@ -28,7 +23,7 @@ interface NormalizedOptions {
|
|
|
28
23
|
}
|
|
29
24
|
type NormalizedOutputOptions = {
|
|
30
25
|
workspace?: string;
|
|
31
|
-
target
|
|
26
|
+
target: string;
|
|
32
27
|
schemas?: string;
|
|
33
28
|
namingConvention: NamingConvention;
|
|
34
29
|
fileExtension: string;
|
|
@@ -59,11 +54,11 @@ type NormalizedOverrideOutput = {
|
|
|
59
54
|
title?: (title: string) => string;
|
|
60
55
|
transformer?: OutputTransformer;
|
|
61
56
|
mutator?: NormalizedMutator;
|
|
62
|
-
operations: Record<string, NormalizedOperationOptions>;
|
|
63
|
-
tags: Record<string, NormalizedOperationOptions>;
|
|
57
|
+
operations: Record<string, NormalizedOperationOptions | undefined>;
|
|
58
|
+
tags: Record<string, NormalizedOperationOptions | undefined>;
|
|
64
59
|
mock?: OverrideMockOptions;
|
|
65
60
|
contentType?: OverrideOutputContentType;
|
|
66
|
-
header: false | ((info:
|
|
61
|
+
header: false | ((info: OpenApiInfoObject) => string[] | string);
|
|
67
62
|
formData: NormalizedFormDataType<NormalizedMutator>;
|
|
68
63
|
formUrlEncoded: boolean | NormalizedMutator;
|
|
69
64
|
paramsSerializer?: NormalizedMutator;
|
|
@@ -92,7 +87,7 @@ type NormalizedOverrideOutput = {
|
|
|
92
87
|
swr: SwrOptions;
|
|
93
88
|
zod: NormalizedZodOptions;
|
|
94
89
|
fetch: NormalizedFetchOptions;
|
|
95
|
-
operationName?: (operation:
|
|
90
|
+
operationName?: (operation: OpenApiOperationObject, route: string, verb: Verbs) => string;
|
|
96
91
|
requestOptions: Record<string, any> | boolean;
|
|
97
92
|
useDates?: boolean;
|
|
98
93
|
useTypeOverInterfaces?: boolean;
|
|
@@ -122,7 +117,7 @@ type NormalizedOperationOptions = {
|
|
|
122
117
|
angular?: Required<AngularOptions>;
|
|
123
118
|
swr?: SwrOptions;
|
|
124
119
|
zod?: NormalizedZodOptions;
|
|
125
|
-
operationName?: (operation:
|
|
120
|
+
operationName?: (operation: OpenApiOperationObject, route: string, verb: Verbs) => string;
|
|
126
121
|
fetch?: FetchOptions;
|
|
127
122
|
formData?: NormalizedFormDataType<NormalizedMutator>;
|
|
128
123
|
formUrlEncoded?: boolean | NormalizedMutator;
|
|
@@ -130,12 +125,9 @@ type NormalizedOperationOptions = {
|
|
|
130
125
|
requestOptions?: object | boolean;
|
|
131
126
|
};
|
|
132
127
|
type NormalizedInputOptions = {
|
|
133
|
-
target: string |
|
|
134
|
-
validation: boolean | object;
|
|
128
|
+
target: string | OpenApiDocument;
|
|
135
129
|
override: OverrideInput;
|
|
136
|
-
|
|
137
|
-
parserOptions: SwaggerParserOptions;
|
|
138
|
-
filters?: InputFiltersOption;
|
|
130
|
+
filters?: InputFiltersOptions;
|
|
139
131
|
};
|
|
140
132
|
type OutputClientFunc = (clients: GeneratorClients) => ClientGeneratorsBuilder;
|
|
141
133
|
type BaseUrlFromSpec = {
|
|
@@ -170,7 +162,7 @@ declare const EnumGeneration: {
|
|
|
170
162
|
type EnumGeneration = (typeof EnumGeneration)[keyof typeof EnumGeneration];
|
|
171
163
|
type OutputOptions = {
|
|
172
164
|
workspace?: string;
|
|
173
|
-
target
|
|
165
|
+
target: string;
|
|
174
166
|
schemas?: string;
|
|
175
167
|
namingConvention?: NamingConvention;
|
|
176
168
|
fileExtension?: string;
|
|
@@ -194,21 +186,15 @@ type OutputOptions = {
|
|
|
194
186
|
optionsParamRequired?: boolean;
|
|
195
187
|
propertySortOrder?: PropertySortOrder;
|
|
196
188
|
};
|
|
197
|
-
type
|
|
198
|
-
validate?: boolean;
|
|
199
|
-
};
|
|
200
|
-
type InputFiltersOption = {
|
|
189
|
+
type InputFiltersOptions = {
|
|
201
190
|
mode?: 'include' | 'exclude';
|
|
202
191
|
tags?: (string | RegExp)[];
|
|
203
192
|
schemas?: (string | RegExp)[];
|
|
204
193
|
};
|
|
205
194
|
type InputOptions = {
|
|
206
|
-
target: string | Record<string, unknown> |
|
|
207
|
-
validation?: boolean | object;
|
|
195
|
+
target: string | Record<string, unknown> | OpenApiDocument;
|
|
208
196
|
override?: OverrideInput;
|
|
209
|
-
|
|
210
|
-
parserOptions?: SwaggerParserOptions;
|
|
211
|
-
filters?: InputFiltersOption;
|
|
197
|
+
filters?: InputFiltersOptions;
|
|
212
198
|
};
|
|
213
199
|
declare const OutputClient: {
|
|
214
200
|
readonly ANGULAR: "angular";
|
|
@@ -275,12 +261,12 @@ type MockOptions = Omit<OverrideMockOptions, 'properties'> & {
|
|
|
275
261
|
}>;
|
|
276
262
|
};
|
|
277
263
|
type MockPropertiesObject = Record<string, unknown>;
|
|
278
|
-
type MockPropertiesObjectFn = (specs:
|
|
264
|
+
type MockPropertiesObjectFn = (specs: OpenApiDocument) => MockPropertiesObject;
|
|
279
265
|
type MockProperties = MockPropertiesObject | MockPropertiesObjectFn;
|
|
280
266
|
type MockDataObject = Record<string, unknown>;
|
|
281
|
-
type MockDataObjectFn = (specs:
|
|
267
|
+
type MockDataObjectFn = (specs: OpenApiDocument) => MockDataObject;
|
|
282
268
|
type MockDataArray = unknown[];
|
|
283
|
-
type MockDataArrayFn = (specs:
|
|
269
|
+
type MockDataArrayFn = (specs: OpenApiDocument) => MockDataArray;
|
|
284
270
|
type MockData = MockDataObject | MockDataObjectFn | MockDataArray | MockDataArrayFn;
|
|
285
271
|
type OutputTransformerFn = (verb: GeneratorVerbOptions) => GeneratorVerbOptions;
|
|
286
272
|
type OutputTransformer = string | OutputTransformerFn;
|
|
@@ -325,7 +311,7 @@ type OverrideOutput = {
|
|
|
325
311
|
tags?: Record<string, OperationOptions>;
|
|
326
312
|
mock?: OverrideMockOptions;
|
|
327
313
|
contentType?: OverrideOutputContentType;
|
|
328
|
-
header?: boolean | ((info:
|
|
314
|
+
header?: boolean | ((info: OpenApiInfoObject) => string[] | string);
|
|
329
315
|
formData?: boolean | Mutator | FormDataType<Mutator>;
|
|
330
316
|
formUrlEncoded?: boolean | Mutator;
|
|
331
317
|
paramsSerializer?: Mutator;
|
|
@@ -353,7 +339,7 @@ type OverrideOutput = {
|
|
|
353
339
|
swr?: SwrOptions;
|
|
354
340
|
angular?: AngularOptions;
|
|
355
341
|
zod?: ZodOptions;
|
|
356
|
-
operationName?: (operation:
|
|
342
|
+
operationName?: (operation: OpenApiOperationObject, route: string, verb: Verbs) => string;
|
|
357
343
|
fetch?: FetchOptions;
|
|
358
344
|
requestOptions?: Record<string, any> | boolean;
|
|
359
345
|
useDates?: boolean;
|
|
@@ -451,7 +437,7 @@ type NormalizedZodOptions = {
|
|
|
451
437
|
body: boolean | ZodCoerceType[];
|
|
452
438
|
response: boolean | ZodCoerceType[];
|
|
453
439
|
};
|
|
454
|
-
preprocess
|
|
440
|
+
preprocess?: {
|
|
455
441
|
param?: NormalizedMutator;
|
|
456
442
|
query?: NormalizedMutator;
|
|
457
443
|
header?: NormalizedMutator;
|
|
@@ -516,9 +502,9 @@ type AngularOptions = {
|
|
|
516
502
|
type SwrOptions = {
|
|
517
503
|
useInfinite?: boolean;
|
|
518
504
|
useSWRMutationForGet?: boolean;
|
|
519
|
-
swrOptions?:
|
|
520
|
-
swrMutationOptions?:
|
|
521
|
-
swrInfiniteOptions?:
|
|
505
|
+
swrOptions?: unknown;
|
|
506
|
+
swrMutationOptions?: unknown;
|
|
507
|
+
swrInfiniteOptions?: unknown;
|
|
522
508
|
};
|
|
523
509
|
type NormalizedFetchOptions = {
|
|
524
510
|
includeHttpResponseReturnType: boolean;
|
|
@@ -530,7 +516,7 @@ type FetchOptions = {
|
|
|
530
516
|
forceSuccessResponse?: boolean;
|
|
531
517
|
jsonReviver?: Mutator;
|
|
532
518
|
};
|
|
533
|
-
type InputTransformerFn = (spec:
|
|
519
|
+
type InputTransformerFn = (spec: OpenApiDocument) => OpenApiDocument;
|
|
534
520
|
type InputTransformer = string | InputTransformerFn;
|
|
535
521
|
type OverrideInput = {
|
|
536
522
|
transformer?: InputTransformer;
|
|
@@ -546,7 +532,7 @@ type OperationOptions = {
|
|
|
546
532
|
angular?: Required<AngularOptions>;
|
|
547
533
|
swr?: SwrOptions;
|
|
548
534
|
zod?: ZodOptions;
|
|
549
|
-
operationName?: (operation:
|
|
535
|
+
operationName?: (operation: OpenApiOperationObject, route: string, verb: Verbs) => string;
|
|
550
536
|
fetch?: FetchOptions;
|
|
551
537
|
formData?: boolean | Mutator | FormDataType<Mutator>;
|
|
552
538
|
formUrlEncoded?: boolean | Mutator;
|
|
@@ -561,7 +547,7 @@ interface HookOption {
|
|
|
561
547
|
}
|
|
562
548
|
type HookCommand = string | HookFunction | HookOption | (string | HookFunction | HookOption)[];
|
|
563
549
|
type NormalizedHookCommand = HookCommand[];
|
|
564
|
-
type HooksOptions<T
|
|
550
|
+
type HooksOptions<T = HookCommand | NormalizedHookCommand> = Partial<Record<Hook, T>>;
|
|
565
551
|
type NormalizedHookOptions = HooksOptions<NormalizedHookCommand>;
|
|
566
552
|
type Verbs = 'post' | 'put' | 'get' | 'patch' | 'delete' | 'head';
|
|
567
553
|
declare const Verbs: {
|
|
@@ -573,23 +559,23 @@ declare const Verbs: {
|
|
|
573
559
|
HEAD: Verbs;
|
|
574
560
|
};
|
|
575
561
|
type ImportOpenApi = {
|
|
576
|
-
|
|
562
|
+
spec: OpenApiDocument;
|
|
577
563
|
input: NormalizedInputOptions;
|
|
578
564
|
output: NormalizedOutputOptions;
|
|
579
565
|
target: string;
|
|
580
566
|
workspace: string;
|
|
567
|
+
projectName?: string;
|
|
581
568
|
};
|
|
582
|
-
interface
|
|
583
|
-
|
|
569
|
+
interface ContextSpec {
|
|
570
|
+
projectName?: string;
|
|
584
571
|
target: string;
|
|
585
572
|
workspace: string;
|
|
586
|
-
|
|
573
|
+
spec: OpenApiDocument;
|
|
587
574
|
parents?: string[];
|
|
588
575
|
output: NormalizedOutputOptions;
|
|
589
576
|
}
|
|
590
577
|
interface GlobalOptions {
|
|
591
|
-
|
|
592
|
-
watch?: boolean | string | (string | boolean)[];
|
|
578
|
+
watch?: boolean | string | string[];
|
|
593
579
|
clean?: boolean | string[];
|
|
594
580
|
prettier?: boolean;
|
|
595
581
|
biome?: boolean;
|
|
@@ -622,13 +608,13 @@ type GeneratorSchema = {
|
|
|
622
608
|
name: string;
|
|
623
609
|
model: string;
|
|
624
610
|
imports: GeneratorImport[];
|
|
611
|
+
dependencies?: string[];
|
|
625
612
|
};
|
|
626
613
|
type GeneratorImport = {
|
|
627
614
|
name: string;
|
|
628
615
|
schemaName?: string;
|
|
629
616
|
isConstant?: boolean;
|
|
630
617
|
alias?: string;
|
|
631
|
-
specKey?: string;
|
|
632
618
|
default?: boolean;
|
|
633
619
|
values?: boolean;
|
|
634
620
|
syntheticDefaultImport?: boolean;
|
|
@@ -714,14 +700,14 @@ type GeneratorVerbOptions = {
|
|
|
714
700
|
fetchReviver?: GeneratorMutator;
|
|
715
701
|
override: NormalizedOverrideOutput;
|
|
716
702
|
deprecated?: boolean;
|
|
717
|
-
originalOperation:
|
|
703
|
+
originalOperation: OpenApiOperationObject;
|
|
718
704
|
};
|
|
719
705
|
type GeneratorVerbsOptions = GeneratorVerbOptions[];
|
|
720
706
|
type GeneratorOptions = {
|
|
721
707
|
route: string;
|
|
722
708
|
pathRoute: string;
|
|
723
709
|
override: NormalizedOverrideOutput;
|
|
724
|
-
context:
|
|
710
|
+
context: ContextSpec;
|
|
725
711
|
mock?: GlobalMockOptions | ClientMockBuilder;
|
|
726
712
|
output: string;
|
|
727
713
|
};
|
|
@@ -750,7 +736,7 @@ type ClientFileBuilder = {
|
|
|
750
736
|
path: string;
|
|
751
737
|
content: string;
|
|
752
738
|
};
|
|
753
|
-
type ClientExtraFilesBuilder = (verbOptions: Record<string, GeneratorVerbOptions>, output: NormalizedOutputOptions, context:
|
|
739
|
+
type ClientExtraFilesBuilder = (verbOptions: Record<string, GeneratorVerbOptions>, output: NormalizedOutputOptions, context: ContextSpec) => Promise<ClientFileBuilder[]>;
|
|
754
740
|
type ClientHeaderBuilder = (params: {
|
|
755
741
|
title: string;
|
|
756
742
|
isRequestOptions: boolean;
|
|
@@ -805,10 +791,10 @@ type GetterResponse = {
|
|
|
805
791
|
};
|
|
806
792
|
contentTypes: string[];
|
|
807
793
|
schemas: GeneratorSchema[];
|
|
808
|
-
originalSchema?:
|
|
794
|
+
originalSchema?: OpenApiResponsesObject;
|
|
809
795
|
};
|
|
810
796
|
type GetterBody = {
|
|
811
|
-
originalSchema:
|
|
797
|
+
originalSchema: OpenApiReferenceObject | OpenApiRequestBodyObject;
|
|
812
798
|
imports: GeneratorImport[];
|
|
813
799
|
definition: string;
|
|
814
800
|
implementation: string;
|
|
@@ -820,15 +806,15 @@ type GetterBody = {
|
|
|
820
806
|
};
|
|
821
807
|
type GetterParameters = {
|
|
822
808
|
query: {
|
|
823
|
-
parameter:
|
|
809
|
+
parameter: OpenApiParameterObject;
|
|
824
810
|
imports: GeneratorImport[];
|
|
825
811
|
}[];
|
|
826
812
|
path: {
|
|
827
|
-
parameter:
|
|
813
|
+
parameter: OpenApiParameterObject;
|
|
828
814
|
imports: GeneratorImport[];
|
|
829
815
|
}[];
|
|
830
816
|
header: {
|
|
831
|
-
parameter:
|
|
817
|
+
parameter: OpenApiParameterObject;
|
|
832
818
|
imports: GeneratorImport[];
|
|
833
819
|
}[];
|
|
834
820
|
};
|
|
@@ -845,7 +831,7 @@ type GetterQueryParam = {
|
|
|
845
831
|
schema: GeneratorSchema;
|
|
846
832
|
deps: GeneratorSchema[];
|
|
847
833
|
isOptional: boolean;
|
|
848
|
-
originalSchema?:
|
|
834
|
+
originalSchema?: OpenApiSchemaObject;
|
|
849
835
|
};
|
|
850
836
|
type GetterPropType = 'param' | 'body' | 'queryParam' | 'header' | 'namedPathParams';
|
|
851
837
|
declare const GetterPropType: {
|
|
@@ -890,11 +876,12 @@ type ScalarValue = {
|
|
|
890
876
|
imports: GeneratorImport[];
|
|
891
877
|
schemas: GeneratorSchema[];
|
|
892
878
|
isRef: boolean;
|
|
879
|
+
dependencies: string[];
|
|
893
880
|
example?: any;
|
|
894
881
|
examples?: Record<string, any>;
|
|
895
882
|
};
|
|
896
883
|
type ResolverValue = ScalarValue & {
|
|
897
|
-
originalSchema:
|
|
884
|
+
originalSchema: OpenApiSchemaObject;
|
|
898
885
|
};
|
|
899
886
|
type ResReqTypesValue = ScalarValue & {
|
|
900
887
|
formData?: string;
|
|
@@ -903,26 +890,26 @@ type ResReqTypesValue = ScalarValue & {
|
|
|
903
890
|
hasReadonlyProps?: boolean;
|
|
904
891
|
key: string;
|
|
905
892
|
contentType: string;
|
|
906
|
-
originalSchema?:
|
|
893
|
+
originalSchema?: OpenApiSchemaObject;
|
|
907
894
|
};
|
|
908
|
-
type
|
|
895
|
+
type WriteSpecBuilder = {
|
|
909
896
|
operations: GeneratorOperations;
|
|
910
|
-
schemas: Record<string, GeneratorSchema[]>;
|
|
911
897
|
verbOptions: Record<string, GeneratorVerbOptions>;
|
|
898
|
+
schemas: GeneratorSchema[];
|
|
912
899
|
title: GeneratorClientTitle;
|
|
913
900
|
header: GeneratorClientHeader;
|
|
914
901
|
footer: GeneratorClientFooter;
|
|
915
902
|
imports: GeneratorClientImports;
|
|
916
903
|
importsMock: GenerateMockImports;
|
|
917
904
|
extraFiles: ClientFileBuilder[];
|
|
918
|
-
info:
|
|
905
|
+
info: OpenApiInfoObject;
|
|
919
906
|
target: string;
|
|
920
907
|
};
|
|
921
908
|
type WriteModeProps = {
|
|
922
|
-
builder:
|
|
909
|
+
builder: WriteSpecBuilder;
|
|
923
910
|
output: NormalizedOutputOptions;
|
|
924
911
|
workspace: string;
|
|
925
|
-
|
|
912
|
+
projectName?: string;
|
|
926
913
|
header: string;
|
|
927
914
|
needSchema: boolean;
|
|
928
915
|
};
|
|
@@ -969,7 +956,7 @@ type GeneratorClientImports = (data: {
|
|
|
969
956
|
exports: GeneratorImport[];
|
|
970
957
|
dependency: string;
|
|
971
958
|
}[];
|
|
972
|
-
|
|
959
|
+
projectName?: string;
|
|
973
960
|
hasSchemaDir: boolean;
|
|
974
961
|
isAllowSyntheticDefaultImports: boolean;
|
|
975
962
|
hasGlobalMutator: boolean;
|
|
@@ -984,7 +971,7 @@ type GenerateMockImports = (data: {
|
|
|
984
971
|
exports: GeneratorImport[];
|
|
985
972
|
dependency: string;
|
|
986
973
|
}[];
|
|
987
|
-
|
|
974
|
+
projectName?: string;
|
|
988
975
|
hasSchemaDir: boolean;
|
|
989
976
|
isAllowSyntheticDefaultImports: boolean;
|
|
990
977
|
options?: GlobalMockOptions;
|
|
@@ -997,13 +984,29 @@ type GeneratorApiBuilder = GeneratorApiOperations & {
|
|
|
997
984
|
importsMock: GenerateMockImports;
|
|
998
985
|
extraFiles: ClientFileBuilder[];
|
|
999
986
|
};
|
|
1000
|
-
interface SchemaWithConst extends SchemaObject {
|
|
1001
|
-
const: string;
|
|
1002
|
-
}
|
|
1003
987
|
declare class ErrorWithTag extends Error {
|
|
1004
988
|
tag: string;
|
|
1005
989
|
constructor(message: string, tag: string, options?: ErrorOptions);
|
|
1006
990
|
}
|
|
991
|
+
type OpenApiSchemaObjectType = 'string' | 'number' | 'boolean' | 'object' | 'integer' | 'null' | 'array';
|
|
992
|
+
type OpenApiDocument = OpenAPIV3_1.Document;
|
|
993
|
+
type OpenApiSchemaObject = OpenAPIV3_1.SchemaObject;
|
|
994
|
+
type OpenApiSchemasObject = Record<string, OpenApiSchemaObject>;
|
|
995
|
+
type OpenApiReferenceObject = OpenAPIV3_1.ReferenceObject & {
|
|
996
|
+
$ref?: string;
|
|
997
|
+
};
|
|
998
|
+
type OpenApiComponentsObject = OpenAPIV3_1.ComponentsObject;
|
|
999
|
+
type OpenApiPathsObject = OpenAPIV3_1.PathsObject;
|
|
1000
|
+
type OpenApiPathItemObject = OpenAPIV3_1.PathItemObject;
|
|
1001
|
+
type OpenApiResponsesObject = OpenAPIV3_1.ResponsesObject;
|
|
1002
|
+
type OpenApiResponseObject = OpenAPIV3_1.ResponseObject;
|
|
1003
|
+
type OpenApiParameterObject = OpenAPIV3_1.ParameterObject;
|
|
1004
|
+
type OpenApiRequestBodyObject = OpenAPIV3_1.RequestBodyObject;
|
|
1005
|
+
type OpenApiInfoObject = OpenAPIV3_1.InfoObject;
|
|
1006
|
+
type OpenApiExampleObject = OpenAPIV3_1.ExampleObject;
|
|
1007
|
+
type OpenApiOperationObject = OpenAPIV3_1.OperationObject;
|
|
1008
|
+
type OpenApiMediaTypeObject = OpenAPIV3_1.MediaTypeObject;
|
|
1009
|
+
type OpenApiServerObject = OpenAPIV3_1.ServerObject;
|
|
1007
1010
|
//#endregion
|
|
1008
1011
|
//#region src/constants.d.ts
|
|
1009
1012
|
declare const generalJSTypes: string[];
|
|
@@ -1013,95 +1016,88 @@ declare const URL_REGEX: RegExp;
|
|
|
1013
1016
|
declare const TEMPLATE_TAG_REGEX: RegExp;
|
|
1014
1017
|
//#endregion
|
|
1015
1018
|
//#region src/generators/component-definition.d.ts
|
|
1016
|
-
declare
|
|
1019
|
+
declare function generateComponentDefinition(responses: OpenApiComponentsObject['responses'] | OpenApiComponentsObject['requestBodies'], context: ContextSpec, suffix: string): GeneratorSchema[];
|
|
1017
1020
|
//#endregion
|
|
1018
1021
|
//#region src/generators/imports.d.ts
|
|
1019
|
-
|
|
1020
|
-
imports,
|
|
1021
|
-
target,
|
|
1022
|
-
isRootKey,
|
|
1023
|
-
specsName,
|
|
1024
|
-
specKey: currentSpecKey,
|
|
1025
|
-
namingConvention
|
|
1026
|
-
}: {
|
|
1022
|
+
interface GenerateImportsOptions {
|
|
1027
1023
|
imports: GeneratorImport[];
|
|
1028
1024
|
target: string;
|
|
1029
|
-
isRootKey: boolean;
|
|
1030
|
-
specsName: Record<string, string>;
|
|
1031
|
-
specKey: string;
|
|
1032
1025
|
namingConvention?: NamingConvention;
|
|
1033
|
-
}
|
|
1034
|
-
declare
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1026
|
+
}
|
|
1027
|
+
declare function generateImports({
|
|
1028
|
+
imports,
|
|
1029
|
+
namingConvention
|
|
1030
|
+
}: GenerateImportsOptions): string;
|
|
1031
|
+
interface GenerateMutatorImportsOptions {
|
|
1039
1032
|
mutators: GeneratorMutator[];
|
|
1040
1033
|
implementation?: string;
|
|
1041
1034
|
oneMore?: boolean;
|
|
1042
|
-
}
|
|
1043
|
-
declare
|
|
1035
|
+
}
|
|
1036
|
+
declare function generateMutatorImports({
|
|
1037
|
+
mutators,
|
|
1044
1038
|
implementation,
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
hasSchemaDir,
|
|
1049
|
-
isAllowSyntheticDefaultImports
|
|
1050
|
-
}: {
|
|
1039
|
+
oneMore
|
|
1040
|
+
}: GenerateMutatorImportsOptions): string;
|
|
1041
|
+
interface AddDependencyOptions {
|
|
1051
1042
|
implementation: string;
|
|
1052
1043
|
exports: GeneratorImport[];
|
|
1053
1044
|
dependency: string;
|
|
1054
|
-
|
|
1045
|
+
projectName?: string;
|
|
1055
1046
|
hasSchemaDir: boolean;
|
|
1056
1047
|
isAllowSyntheticDefaultImports: boolean;
|
|
1057
|
-
}
|
|
1058
|
-
declare
|
|
1048
|
+
}
|
|
1049
|
+
declare function addDependency({
|
|
1050
|
+
implementation,
|
|
1051
|
+
exports,
|
|
1052
|
+
dependency,
|
|
1053
|
+
projectName,
|
|
1054
|
+
hasSchemaDir,
|
|
1055
|
+
isAllowSyntheticDefaultImports
|
|
1056
|
+
}: AddDependencyOptions): string | undefined;
|
|
1057
|
+
declare function generateDependencyImports(implementation: string, imports: {
|
|
1059
1058
|
exports: GeneratorImport[];
|
|
1060
1059
|
dependency: string;
|
|
1061
|
-
}[],
|
|
1062
|
-
declare
|
|
1060
|
+
}[], projectName: string | undefined, hasSchemaDir: boolean, isAllowSyntheticDefaultImports: boolean): string;
|
|
1061
|
+
declare function generateVerbImports({
|
|
1063
1062
|
response,
|
|
1064
1063
|
body,
|
|
1065
1064
|
queryParams,
|
|
1066
1065
|
props,
|
|
1067
1066
|
headers,
|
|
1068
1067
|
params
|
|
1069
|
-
}: GeneratorVerbOptions)
|
|
1068
|
+
}: GeneratorVerbOptions): GeneratorImport[];
|
|
1070
1069
|
//#endregion
|
|
1071
1070
|
//#region src/generators/models-inline.d.ts
|
|
1072
|
-
declare
|
|
1073
|
-
declare
|
|
1071
|
+
declare function generateModelInline(acc: string, model: string): string;
|
|
1072
|
+
declare function generateModelsInline(obj: Record<string, GeneratorSchema[]>): string;
|
|
1074
1073
|
//#endregion
|
|
1075
1074
|
//#region src/generators/mutator.d.ts
|
|
1076
1075
|
declare const BODY_TYPE_NAME = "BodyType";
|
|
1076
|
+
interface GenerateMutatorOptions {
|
|
1077
|
+
output?: string;
|
|
1078
|
+
mutator?: NormalizedMutator;
|
|
1079
|
+
name: string;
|
|
1080
|
+
workspace: string;
|
|
1081
|
+
tsconfig?: Tsconfig;
|
|
1082
|
+
}
|
|
1077
1083
|
declare function generateMutator({
|
|
1078
1084
|
output,
|
|
1079
1085
|
mutator,
|
|
1080
1086
|
name,
|
|
1081
1087
|
workspace,
|
|
1082
1088
|
tsconfig
|
|
1083
|
-
}:
|
|
1084
|
-
output?: string;
|
|
1085
|
-
mutator?: NormalizedMutator;
|
|
1086
|
-
name: string;
|
|
1087
|
-
workspace: string;
|
|
1088
|
-
tsconfig?: Tsconfig;
|
|
1089
|
-
}): Promise<GeneratorMutator | undefined>;
|
|
1089
|
+
}: GenerateMutatorOptions): Promise<GeneratorMutator | undefined>;
|
|
1090
1090
|
//#endregion
|
|
1091
1091
|
//#region src/generators/options.d.ts
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
isAngular,
|
|
1102
|
-
paramsSerializer,
|
|
1103
|
-
paramsSerializerOptions
|
|
1104
|
-
}: {
|
|
1092
|
+
interface GenerateFormDataAndUrlEncodedFunctionOptions {
|
|
1093
|
+
body: GetterBody;
|
|
1094
|
+
formData?: GeneratorMutator;
|
|
1095
|
+
formUrlEncoded?: GeneratorMutator;
|
|
1096
|
+
isFormData: boolean;
|
|
1097
|
+
isFormUrlEncoded: boolean;
|
|
1098
|
+
}
|
|
1099
|
+
declare function generateBodyOptions(body: GetterBody, isFormData: boolean, isFormUrlEncoded: boolean): string;
|
|
1100
|
+
interface GenerateAxiosOptions {
|
|
1105
1101
|
response: GetterResponse;
|
|
1106
1102
|
isExactOptionalPropertyTypes: boolean;
|
|
1107
1103
|
queryParams?: GeneratorSchema;
|
|
@@ -1112,24 +1108,20 @@ declare const generateAxiosOptions: ({
|
|
|
1112
1108
|
isAngular: boolean;
|
|
1113
1109
|
paramsSerializer?: GeneratorMutator;
|
|
1114
1110
|
paramsSerializerOptions?: ParamsSerializerOptions;
|
|
1115
|
-
}
|
|
1116
|
-
declare
|
|
1117
|
-
route,
|
|
1118
|
-
body,
|
|
1119
|
-
headers,
|
|
1120
|
-
queryParams,
|
|
1111
|
+
}
|
|
1112
|
+
declare function generateAxiosOptions({
|
|
1121
1113
|
response,
|
|
1122
|
-
verb,
|
|
1123
|
-
requestOptions,
|
|
1124
|
-
isFormData,
|
|
1125
|
-
isFormUrlEncoded,
|
|
1126
|
-
isAngular,
|
|
1127
1114
|
isExactOptionalPropertyTypes,
|
|
1115
|
+
queryParams,
|
|
1116
|
+
headers,
|
|
1117
|
+
requestOptions,
|
|
1128
1118
|
hasSignal,
|
|
1129
1119
|
isVue,
|
|
1120
|
+
isAngular,
|
|
1130
1121
|
paramsSerializer,
|
|
1131
1122
|
paramsSerializerOptions
|
|
1132
|
-
}:
|
|
1123
|
+
}: GenerateAxiosOptions): string;
|
|
1124
|
+
interface GenerateOptionsOptions {
|
|
1133
1125
|
route: string;
|
|
1134
1126
|
body: GetterBody;
|
|
1135
1127
|
headers?: GetterQueryParam;
|
|
@@ -1145,22 +1137,27 @@ declare const generateOptions: ({
|
|
|
1145
1137
|
isVue?: boolean;
|
|
1146
1138
|
paramsSerializer?: GeneratorMutator;
|
|
1147
1139
|
paramsSerializerOptions?: ParamsSerializerOptions;
|
|
1148
|
-
}
|
|
1149
|
-
declare
|
|
1150
|
-
declare const generateQueryParamsAxiosConfig: (response: GetterResponse, isVue: boolean, queryParams?: GetterQueryParam) => string;
|
|
1151
|
-
declare const generateMutatorConfig: ({
|
|
1140
|
+
}
|
|
1141
|
+
declare function generateOptions({
|
|
1152
1142
|
route,
|
|
1153
1143
|
body,
|
|
1154
1144
|
headers,
|
|
1155
1145
|
queryParams,
|
|
1156
1146
|
response,
|
|
1157
1147
|
verb,
|
|
1148
|
+
requestOptions,
|
|
1158
1149
|
isFormData,
|
|
1159
1150
|
isFormUrlEncoded,
|
|
1160
|
-
|
|
1151
|
+
isAngular,
|
|
1161
1152
|
isExactOptionalPropertyTypes,
|
|
1162
|
-
|
|
1163
|
-
|
|
1153
|
+
hasSignal,
|
|
1154
|
+
isVue,
|
|
1155
|
+
paramsSerializer,
|
|
1156
|
+
paramsSerializerOptions
|
|
1157
|
+
}: GenerateOptionsOptions): string;
|
|
1158
|
+
declare function generateBodyMutatorConfig(body: GetterBody, isFormData: boolean, isFormUrlEncoded: boolean): string;
|
|
1159
|
+
declare function generateQueryParamsAxiosConfig(response: GetterResponse, isVue: boolean, queryParams?: GetterQueryParam): string;
|
|
1160
|
+
interface GenerateMutatorConfigOptions {
|
|
1164
1161
|
route: string;
|
|
1165
1162
|
body: GetterBody;
|
|
1166
1163
|
headers?: GetterQueryParam;
|
|
@@ -1172,24 +1169,31 @@ declare const generateMutatorConfig: ({
|
|
|
1172
1169
|
hasSignal: boolean;
|
|
1173
1170
|
isExactOptionalPropertyTypes: boolean;
|
|
1174
1171
|
isVue?: boolean;
|
|
1175
|
-
}
|
|
1176
|
-
declare
|
|
1177
|
-
|
|
1172
|
+
}
|
|
1173
|
+
declare function generateMutatorConfig({
|
|
1174
|
+
route,
|
|
1175
|
+
body,
|
|
1176
|
+
headers,
|
|
1177
|
+
queryParams,
|
|
1178
|
+
response,
|
|
1179
|
+
verb,
|
|
1180
|
+
isFormData,
|
|
1181
|
+
isFormUrlEncoded,
|
|
1182
|
+
hasSignal,
|
|
1183
|
+
isExactOptionalPropertyTypes,
|
|
1184
|
+
isVue
|
|
1185
|
+
}: GenerateMutatorConfigOptions): string;
|
|
1186
|
+
declare function generateMutatorRequestOptions(requestOptions: boolean | object | undefined, hasSecondArgument: boolean): string;
|
|
1187
|
+
declare function generateFormDataAndUrlEncodedFunction({
|
|
1178
1188
|
body,
|
|
1179
1189
|
formData,
|
|
1180
1190
|
formUrlEncoded,
|
|
1181
1191
|
isFormData,
|
|
1182
1192
|
isFormUrlEncoded
|
|
1183
|
-
}:
|
|
1184
|
-
body: GetterBody;
|
|
1185
|
-
formData?: GeneratorMutator;
|
|
1186
|
-
formUrlEncoded?: GeneratorMutator;
|
|
1187
|
-
isFormData: boolean;
|
|
1188
|
-
isFormUrlEncoded: boolean;
|
|
1189
|
-
}) => string;
|
|
1193
|
+
}: GenerateFormDataAndUrlEncodedFunctionOptions): string;
|
|
1190
1194
|
//#endregion
|
|
1191
1195
|
//#region src/generators/parameter-definition.d.ts
|
|
1192
|
-
declare
|
|
1196
|
+
declare function generateParameterDefinition(parameters: OpenApiComponentsObject['parameters'], context: ContextSpec, suffix: string): GeneratorSchema[];
|
|
1193
1197
|
//#endregion
|
|
1194
1198
|
//#region src/generators/schema-definition.d.ts
|
|
1195
1199
|
/**
|
|
@@ -1197,58 +1201,80 @@ declare const generateParameterDefinition: (parameters: ComponentsObject["parame
|
|
|
1197
1201
|
*
|
|
1198
1202
|
* @param schemas
|
|
1199
1203
|
*/
|
|
1200
|
-
declare
|
|
1204
|
+
declare function generateSchemasDefinition(schemas: OpenApiSchemasObject | undefined, context: ContextSpec, suffix: string, filters?: InputFiltersOptions): GeneratorSchema[];
|
|
1201
1205
|
//#endregion
|
|
1202
1206
|
//#region src/generators/verbs-options.d.ts
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
1207
|
+
interface GenerateVerbOptionsParams {
|
|
1208
|
+
verb: Verbs;
|
|
1209
|
+
output: NormalizedOutputOptions;
|
|
1210
|
+
operation: OpenApiOperationObject;
|
|
1211
|
+
route: string;
|
|
1212
|
+
pathRoute: string;
|
|
1213
|
+
verbParameters?: OpenApiPathItemObject['parameters'];
|
|
1214
|
+
components?: OpenApiComponentsObject;
|
|
1215
|
+
context: ContextSpec;
|
|
1216
|
+
}
|
|
1217
|
+
declare function generateVerbOptions({
|
|
1218
|
+
verb,
|
|
1206
1219
|
output,
|
|
1220
|
+
operation,
|
|
1207
1221
|
route,
|
|
1208
1222
|
pathRoute,
|
|
1223
|
+
verbParameters,
|
|
1209
1224
|
context
|
|
1210
|
-
}:
|
|
1211
|
-
|
|
1225
|
+
}: GenerateVerbOptionsParams): Promise<GeneratorVerbOptions>;
|
|
1226
|
+
interface GenerateVerbsOptionsParams {
|
|
1227
|
+
verbs: OpenApiPathItemObject;
|
|
1212
1228
|
input: NormalizedInputOptions;
|
|
1213
1229
|
output: NormalizedOutputOptions;
|
|
1214
1230
|
route: string;
|
|
1215
1231
|
pathRoute: string;
|
|
1216
|
-
context:
|
|
1217
|
-
}
|
|
1218
|
-
declare
|
|
1232
|
+
context: ContextSpec;
|
|
1233
|
+
}
|
|
1234
|
+
declare function generateVerbsOptions({
|
|
1235
|
+
verbs,
|
|
1236
|
+
input,
|
|
1237
|
+
output,
|
|
1238
|
+
route,
|
|
1239
|
+
pathRoute,
|
|
1240
|
+
context
|
|
1241
|
+
}: GenerateVerbsOptionsParams): Promise<GeneratorVerbsOptions>;
|
|
1242
|
+
declare function _filteredVerbs(verbs: OpenApiPathItemObject, filters: NormalizedInputOptions['filters']): [string, any][];
|
|
1219
1243
|
//#endregion
|
|
1220
1244
|
//#region src/getters/array.d.ts
|
|
1245
|
+
interface GetArrayOptions {
|
|
1246
|
+
schema: OpenApiSchemaObject;
|
|
1247
|
+
name?: string;
|
|
1248
|
+
context: ContextSpec;
|
|
1249
|
+
}
|
|
1221
1250
|
/**
|
|
1222
1251
|
* Return the output type from an array
|
|
1223
1252
|
*
|
|
1224
1253
|
* @param item item with type === "array"
|
|
1225
1254
|
*/
|
|
1226
|
-
declare
|
|
1255
|
+
declare function getArray({
|
|
1227
1256
|
schema,
|
|
1228
1257
|
name,
|
|
1229
1258
|
context
|
|
1230
|
-
}:
|
|
1231
|
-
schema: SchemaObject;
|
|
1232
|
-
name?: string;
|
|
1233
|
-
context: ContextSpecs;
|
|
1234
|
-
}) => ScalarValue;
|
|
1259
|
+
}: GetArrayOptions): ScalarValue;
|
|
1235
1260
|
//#endregion
|
|
1236
1261
|
//#region src/getters/body.d.ts
|
|
1237
|
-
|
|
1262
|
+
interface GetBodyOptions {
|
|
1263
|
+
requestBody: OpenApiReferenceObject | OpenApiRequestBodyObject;
|
|
1264
|
+
operationName: string;
|
|
1265
|
+
context: ContextSpec;
|
|
1266
|
+
contentType?: OverrideOutputContentType;
|
|
1267
|
+
}
|
|
1268
|
+
declare function getBody({
|
|
1238
1269
|
requestBody,
|
|
1239
1270
|
operationName,
|
|
1240
1271
|
context,
|
|
1241
1272
|
contentType
|
|
1242
|
-
}:
|
|
1243
|
-
requestBody: ReferenceObject | RequestBodyObject;
|
|
1244
|
-
operationName: string;
|
|
1245
|
-
context: ContextSpecs;
|
|
1246
|
-
contentType?: OverrideOutputContentType;
|
|
1247
|
-
}) => GetterBody;
|
|
1273
|
+
}: GetBodyOptions): GetterBody;
|
|
1248
1274
|
//#endregion
|
|
1249
1275
|
//#region src/getters/combine.d.ts
|
|
1250
1276
|
type Separator = 'allOf' | 'anyOf' | 'oneOf';
|
|
1251
|
-
declare
|
|
1277
|
+
declare function combineSchemas({
|
|
1252
1278
|
name,
|
|
1253
1279
|
schema,
|
|
1254
1280
|
separator,
|
|
@@ -1256,53 +1282,55 @@ declare const combineSchemas: ({
|
|
|
1256
1282
|
nullable
|
|
1257
1283
|
}: {
|
|
1258
1284
|
name?: string;
|
|
1259
|
-
schema:
|
|
1285
|
+
schema: OpenApiSchemaObject;
|
|
1260
1286
|
separator: Separator;
|
|
1261
|
-
context:
|
|
1287
|
+
context: ContextSpec;
|
|
1262
1288
|
nullable: string;
|
|
1263
|
-
})
|
|
1289
|
+
}): ScalarValue;
|
|
1264
1290
|
//#endregion
|
|
1265
1291
|
//#region src/getters/discriminators.d.ts
|
|
1266
|
-
declare
|
|
1292
|
+
declare function resolveDiscriminators(schemas: OpenApiSchemasObject, context: ContextSpec): OpenApiSchemasObject;
|
|
1267
1293
|
//#endregion
|
|
1268
1294
|
//#region src/getters/enum.d.ts
|
|
1269
|
-
declare
|
|
1270
|
-
declare
|
|
1271
|
-
declare
|
|
1272
|
-
declare
|
|
1295
|
+
declare function getEnumNames(schemaObject: OpenApiSchemaObject | undefined): any;
|
|
1296
|
+
declare function getEnumDescriptions(schemaObject: OpenApiSchemaObject | undefined): any;
|
|
1297
|
+
declare function getEnum(value: string, enumName: string, names: string[] | undefined, enumGenerationType: EnumGeneration, descriptions?: string[], enumNamingConvention?: NamingConvention): string;
|
|
1298
|
+
declare function getEnumImplementation(value: string, names?: string[], descriptions?: string[], enumNamingConvention?: NamingConvention): string;
|
|
1273
1299
|
//#endregion
|
|
1274
1300
|
//#region src/getters/keys.d.ts
|
|
1275
|
-
declare
|
|
1301
|
+
declare function getKey(key: string): string;
|
|
1276
1302
|
//#endregion
|
|
1277
1303
|
//#region src/getters/object.d.ts
|
|
1304
|
+
interface GetObjectOptions {
|
|
1305
|
+
item: OpenApiSchemaObject;
|
|
1306
|
+
name?: string;
|
|
1307
|
+
context: ContextSpec;
|
|
1308
|
+
nullable: string;
|
|
1309
|
+
}
|
|
1278
1310
|
/**
|
|
1279
1311
|
* Return the output type from an object
|
|
1280
1312
|
*
|
|
1281
1313
|
* @param item item with type === "object"
|
|
1282
1314
|
*/
|
|
1283
|
-
declare
|
|
1315
|
+
declare function getObject({
|
|
1284
1316
|
item,
|
|
1285
1317
|
name,
|
|
1286
1318
|
context,
|
|
1287
1319
|
nullable
|
|
1288
|
-
}:
|
|
1289
|
-
item: SchemaObject;
|
|
1290
|
-
name?: string;
|
|
1291
|
-
context: ContextSpecs;
|
|
1292
|
-
nullable: string;
|
|
1293
|
-
}) => ScalarValue;
|
|
1320
|
+
}: GetObjectOptions): ScalarValue;
|
|
1294
1321
|
//#endregion
|
|
1295
1322
|
//#region src/getters/operation.d.ts
|
|
1296
|
-
declare
|
|
1323
|
+
declare function getOperationId(operation: OpenApiOperationObject, route: string, verb: Verbs): string;
|
|
1297
1324
|
//#endregion
|
|
1298
1325
|
//#region src/getters/parameters.d.ts
|
|
1299
|
-
|
|
1326
|
+
interface GetParametersOptions {
|
|
1327
|
+
parameters: (OpenApiReferenceObject | OpenApiParameterObject)[];
|
|
1328
|
+
context: ContextSpec;
|
|
1329
|
+
}
|
|
1330
|
+
declare function getParameters({
|
|
1300
1331
|
parameters,
|
|
1301
1332
|
context
|
|
1302
|
-
}:
|
|
1303
|
-
parameters: (ReferenceObject | ParameterObject)[];
|
|
1304
|
-
context: ContextSpecs;
|
|
1305
|
-
}) => GetterParameters;
|
|
1333
|
+
}: GetParametersOptions): GetterParameters;
|
|
1306
1334
|
//#endregion
|
|
1307
1335
|
//#region src/getters/params.d.ts
|
|
1308
1336
|
/**
|
|
@@ -1315,50 +1343,53 @@ declare const getParameters: ({
|
|
|
1315
1343
|
* ```
|
|
1316
1344
|
* @param path
|
|
1317
1345
|
*/
|
|
1318
|
-
declare
|
|
1319
|
-
|
|
1346
|
+
declare function getParamsInPath(path: string): string[];
|
|
1347
|
+
interface GetParamsOptions {
|
|
1348
|
+
route: string;
|
|
1349
|
+
pathParams?: GetterParameters['query'];
|
|
1350
|
+
operationId: string;
|
|
1351
|
+
context: ContextSpec;
|
|
1352
|
+
output: NormalizedOutputOptions;
|
|
1353
|
+
}
|
|
1354
|
+
declare function getParams({
|
|
1320
1355
|
route,
|
|
1321
1356
|
pathParams,
|
|
1322
1357
|
operationId,
|
|
1323
1358
|
context,
|
|
1324
1359
|
output
|
|
1325
|
-
}:
|
|
1326
|
-
route: string;
|
|
1327
|
-
pathParams?: GetterParameters["query"];
|
|
1328
|
-
operationId: string;
|
|
1329
|
-
context: ContextSpecs;
|
|
1330
|
-
output: NormalizedOutputOptions;
|
|
1331
|
-
}) => GetterParams;
|
|
1360
|
+
}: GetParamsOptions): GetterParams;
|
|
1332
1361
|
//#endregion
|
|
1333
1362
|
//#region src/getters/props.d.ts
|
|
1334
|
-
|
|
1363
|
+
interface GetPropsOptions {
|
|
1364
|
+
body: GetterBody;
|
|
1365
|
+
queryParams?: GetterQueryParam;
|
|
1366
|
+
params: GetterParams;
|
|
1367
|
+
operationName: string;
|
|
1368
|
+
headers?: GetterQueryParam;
|
|
1369
|
+
context: ContextSpec;
|
|
1370
|
+
}
|
|
1371
|
+
declare function getProps({
|
|
1335
1372
|
body,
|
|
1336
1373
|
queryParams,
|
|
1337
1374
|
params,
|
|
1338
1375
|
operationName,
|
|
1339
1376
|
headers,
|
|
1340
1377
|
context
|
|
1341
|
-
}:
|
|
1342
|
-
body: GetterBody;
|
|
1343
|
-
queryParams?: GetterQueryParam;
|
|
1344
|
-
params: GetterParams;
|
|
1345
|
-
operationName: string;
|
|
1346
|
-
headers?: GetterQueryParam;
|
|
1347
|
-
context: ContextSpecs;
|
|
1348
|
-
}) => GetterProps;
|
|
1378
|
+
}: GetPropsOptions): GetterProps;
|
|
1349
1379
|
//#endregion
|
|
1350
1380
|
//#region src/getters/query-params.d.ts
|
|
1351
|
-
|
|
1381
|
+
interface GetQueryParamsOptions {
|
|
1382
|
+
queryParams: GetterParameters['query'];
|
|
1383
|
+
operationName: string;
|
|
1384
|
+
context: ContextSpec;
|
|
1385
|
+
suffix?: string;
|
|
1386
|
+
}
|
|
1387
|
+
declare function getQueryParams({
|
|
1352
1388
|
queryParams,
|
|
1353
1389
|
operationName,
|
|
1354
1390
|
context,
|
|
1355
1391
|
suffix
|
|
1356
|
-
}:
|
|
1357
|
-
queryParams: GetterParameters["query"];
|
|
1358
|
-
operationName: string;
|
|
1359
|
-
context: ContextSpecs;
|
|
1360
|
-
suffix?: string;
|
|
1361
|
-
}) => GetterQueryParam | undefined;
|
|
1392
|
+
}: GetQueryParamsOptions): GetterQueryParam | undefined;
|
|
1362
1393
|
//#endregion
|
|
1363
1394
|
//#region src/getters/ref.d.ts
|
|
1364
1395
|
type RefComponent = 'schemas' | 'responses' | 'parameters' | 'requestBodies';
|
|
@@ -1373,86 +1404,88 @@ interface RefInfo {
|
|
|
1373
1404
|
name: string;
|
|
1374
1405
|
originalName: string;
|
|
1375
1406
|
refPaths?: string[];
|
|
1376
|
-
specKey?: string;
|
|
1377
1407
|
}
|
|
1378
1408
|
/**
|
|
1379
1409
|
* Return the output type from the $ref
|
|
1380
1410
|
*
|
|
1381
1411
|
* @param $ref
|
|
1382
1412
|
*/
|
|
1383
|
-
declare
|
|
1413
|
+
declare function getRefInfo($ref: string, context: ContextSpec): RefInfo;
|
|
1384
1414
|
//#endregion
|
|
1385
1415
|
//#region src/getters/res-req-types.d.ts
|
|
1386
|
-
declare
|
|
1416
|
+
declare function getResReqTypes(responsesOrRequests: [string, OpenApiReferenceObject | OpenApiResponseObject | OpenApiRequestBodyObject][], name: string, context: ContextSpec, defaultType?: string, uniqueKey?: (item: ResReqTypesValue, index: number, data: ResReqTypesValue[]) => unknown): ResReqTypesValue[];
|
|
1387
1417
|
//#endregion
|
|
1388
1418
|
//#region src/getters/response.d.ts
|
|
1389
|
-
|
|
1419
|
+
interface GetResponseOptions {
|
|
1420
|
+
responses: OpenApiResponsesObject;
|
|
1421
|
+
operationName: string;
|
|
1422
|
+
context: ContextSpec;
|
|
1423
|
+
contentType?: OverrideOutputContentType;
|
|
1424
|
+
}
|
|
1425
|
+
declare function getResponse({
|
|
1390
1426
|
responses,
|
|
1391
1427
|
operationName,
|
|
1392
1428
|
context,
|
|
1393
1429
|
contentType
|
|
1394
|
-
}:
|
|
1395
|
-
responses: ResponsesObject;
|
|
1396
|
-
operationName: string;
|
|
1397
|
-
context: ContextSpecs;
|
|
1398
|
-
contentType?: OverrideOutputContentType;
|
|
1399
|
-
}) => GetterResponse;
|
|
1430
|
+
}: GetResponseOptions): GetterResponse;
|
|
1400
1431
|
//#endregion
|
|
1401
1432
|
//#region src/getters/route.d.ts
|
|
1402
|
-
declare
|
|
1403
|
-
declare
|
|
1404
|
-
declare
|
|
1433
|
+
declare function getRoute(route: string): string;
|
|
1434
|
+
declare function getFullRoute(route: string, servers: OpenApiServerObject[] | undefined, baseUrl: string | BaseUrlFromConstant | BaseUrlFromSpec | undefined): string;
|
|
1435
|
+
declare function getRouteAsArray(route: string): string;
|
|
1405
1436
|
//#endregion
|
|
1406
1437
|
//#region src/getters/scalar.d.ts
|
|
1438
|
+
interface GetScalarOptions {
|
|
1439
|
+
item: OpenApiSchemaObject;
|
|
1440
|
+
name?: string;
|
|
1441
|
+
context: ContextSpec;
|
|
1442
|
+
}
|
|
1407
1443
|
/**
|
|
1408
1444
|
* Return the typescript equivalent of open-api data type
|
|
1409
1445
|
*
|
|
1410
1446
|
* @param item
|
|
1411
|
-
* @ref https://github.com/OAI/OpenAPI-Specification/blob/
|
|
1447
|
+
* @ref https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#data-types
|
|
1412
1448
|
*/
|
|
1413
|
-
declare
|
|
1449
|
+
declare function getScalar({
|
|
1414
1450
|
item,
|
|
1415
1451
|
name,
|
|
1416
1452
|
context
|
|
1417
|
-
}:
|
|
1418
|
-
item: SchemaObject;
|
|
1419
|
-
name?: string;
|
|
1420
|
-
context: ContextSpecs;
|
|
1421
|
-
}) => ScalarValue;
|
|
1453
|
+
}: GetScalarOptions): ScalarValue;
|
|
1422
1454
|
//#endregion
|
|
1423
1455
|
//#region src/resolvers/object.d.ts
|
|
1424
|
-
|
|
1456
|
+
interface ResolveOptions {
|
|
1457
|
+
schema: OpenApiSchemaObject | OpenApiReferenceObject;
|
|
1458
|
+
propName?: string;
|
|
1459
|
+
combined?: boolean;
|
|
1460
|
+
context: ContextSpec;
|
|
1461
|
+
}
|
|
1462
|
+
declare function resolveObject({
|
|
1425
1463
|
schema,
|
|
1426
1464
|
propName,
|
|
1427
1465
|
combined,
|
|
1428
1466
|
context
|
|
1429
|
-
}:
|
|
1430
|
-
schema: SchemaObject | ReferenceObject;
|
|
1431
|
-
propName?: string;
|
|
1432
|
-
combined?: boolean;
|
|
1433
|
-
context: ContextSpecs;
|
|
1434
|
-
}) => ResolverValue;
|
|
1467
|
+
}: ResolveOptions): ResolverValue;
|
|
1435
1468
|
//#endregion
|
|
1436
1469
|
//#region src/resolvers/ref.d.ts
|
|
1437
|
-
|
|
1438
|
-
|
|
1439
|
-
schema: Schema;
|
|
1470
|
+
declare function resolveRef<TSchema extends OpenApiComponentsObject = OpenApiComponentsObject>(schema: OpenApiComponentsObject, context: ContextSpec, imports?: GeneratorImport[]): {
|
|
1471
|
+
schema: TSchema;
|
|
1440
1472
|
imports: GeneratorImport[];
|
|
1441
1473
|
};
|
|
1442
|
-
type Example =
|
|
1474
|
+
type Example = OpenApiExampleObject | OpenApiReferenceObject;
|
|
1443
1475
|
type Examples = Example[] | Record<string, Example> | undefined;
|
|
1444
|
-
declare
|
|
1476
|
+
declare function resolveExampleRefs(examples: Examples, context: ContextSpec): Examples;
|
|
1445
1477
|
//#endregion
|
|
1446
1478
|
//#region src/resolvers/value.d.ts
|
|
1447
|
-
|
|
1479
|
+
interface ResolveValueOptions {
|
|
1480
|
+
schema: OpenApiSchemaObject | OpenApiReferenceObject;
|
|
1481
|
+
name?: string;
|
|
1482
|
+
context: ContextSpec;
|
|
1483
|
+
}
|
|
1484
|
+
declare function resolveValue({
|
|
1448
1485
|
schema,
|
|
1449
1486
|
name,
|
|
1450
1487
|
context
|
|
1451
|
-
}:
|
|
1452
|
-
schema: SchemaObject | ReferenceObject;
|
|
1453
|
-
name?: string;
|
|
1454
|
-
context: ContextSpecs;
|
|
1455
|
-
}) => ResolverValue;
|
|
1488
|
+
}: ResolveValueOptions): ResolverValue;
|
|
1456
1489
|
//#endregion
|
|
1457
1490
|
//#region src/utils/assertion.d.ts
|
|
1458
1491
|
/**
|
|
@@ -1460,8 +1493,8 @@ declare const resolveValue: ({
|
|
|
1460
1493
|
*
|
|
1461
1494
|
* @param property
|
|
1462
1495
|
*/
|
|
1463
|
-
declare
|
|
1464
|
-
declare
|
|
1496
|
+
declare function isReference(obj: object): obj is OpenApiReferenceObject;
|
|
1497
|
+
declare function isDirectory(path: string): boolean;
|
|
1465
1498
|
declare function isObject(x: any): x is Record<string, unknown>;
|
|
1466
1499
|
declare function isModule(x: any): x is Record<string, unknown>;
|
|
1467
1500
|
declare function isString(x: any): x is string;
|
|
@@ -1471,24 +1504,23 @@ declare function isBoolean(x: any): x is boolean;
|
|
|
1471
1504
|
declare function isFunction(x: any): x is Function;
|
|
1472
1505
|
declare function isUndefined(x: any): x is undefined;
|
|
1473
1506
|
declare function isNull(x: any): x is null;
|
|
1474
|
-
declare function isSchema(x:
|
|
1475
|
-
declare
|
|
1476
|
-
declare
|
|
1477
|
-
declare const isUrl: (str: string) => boolean;
|
|
1507
|
+
declare function isSchema(x: unknown): x is OpenApiSchemaObject;
|
|
1508
|
+
declare function isVerb(verb: string): verb is Verbs;
|
|
1509
|
+
declare function isUrl(str: string): boolean;
|
|
1478
1510
|
//#endregion
|
|
1479
1511
|
//#region src/utils/async-reduce.d.ts
|
|
1480
1512
|
declare function asyncReduce<IterationItem, AccValue>(array: IterationItem[], reducer: (accumulate: AccValue, current: IterationItem) => AccValue | Promise<AccValue>, initValue: AccValue): Promise<AccValue>;
|
|
1481
1513
|
//#endregion
|
|
1482
1514
|
//#region src/utils/case.d.ts
|
|
1483
|
-
declare
|
|
1484
|
-
declare
|
|
1485
|
-
declare
|
|
1486
|
-
declare
|
|
1487
|
-
declare
|
|
1488
|
-
declare
|
|
1515
|
+
declare function pascal(s: string): string;
|
|
1516
|
+
declare function camel(s: string): string;
|
|
1517
|
+
declare function snake(s: string): string;
|
|
1518
|
+
declare function kebab(s: string): string;
|
|
1519
|
+
declare function upper(s: string, fillWith: string, isDeapostrophe?: boolean): string;
|
|
1520
|
+
declare function conventionName(name: string, convention: NamingConvention): string;
|
|
1489
1521
|
//#endregion
|
|
1490
1522
|
//#region src/utils/compare-version.d.ts
|
|
1491
|
-
declare
|
|
1523
|
+
declare function compareVersions(firstVersion: string, secondVersions: string, operator?: CompareOperator): boolean;
|
|
1492
1524
|
//#endregion
|
|
1493
1525
|
//#region src/utils/debug.d.ts
|
|
1494
1526
|
interface DebuggerOptions {
|
|
@@ -1497,7 +1529,7 @@ interface DebuggerOptions {
|
|
|
1497
1529
|
declare function createDebugger(ns: string, options?: DebuggerOptions): debug.Debugger['log'];
|
|
1498
1530
|
//#endregion
|
|
1499
1531
|
//#region src/utils/deep-non-nullable.d.ts
|
|
1500
|
-
type DeepNonNullable<T
|
|
1532
|
+
type DeepNonNullable<T> = T extends Function ? T : T extends readonly (infer U)[] ? DeepNonNullable<NonNullable<U>>[] : T extends object ? { [K in keyof T]: DeepNonNullable<NonNullable<T[K]>> } : NonNullable<T>;
|
|
1501
1533
|
//#endregion
|
|
1502
1534
|
//#region src/utils/doc.d.ts
|
|
1503
1535
|
declare function jsDoc(schema: {
|
|
@@ -1508,32 +1540,32 @@ declare function jsDoc(schema: {
|
|
|
1508
1540
|
maxLength?: number;
|
|
1509
1541
|
minimum?: number;
|
|
1510
1542
|
maximum?: number;
|
|
1511
|
-
exclusiveMinimum?:
|
|
1512
|
-
exclusiveMaximum?:
|
|
1543
|
+
exclusiveMinimum?: number;
|
|
1544
|
+
exclusiveMaximum?: number;
|
|
1513
1545
|
minItems?: number;
|
|
1514
1546
|
maxItems?: number;
|
|
1515
|
-
|
|
1547
|
+
type?: string | string[];
|
|
1516
1548
|
pattern?: string;
|
|
1517
|
-
}, tryOneLine?: boolean, context?:
|
|
1549
|
+
}, tryOneLine?: boolean, context?: ContextSpec): string;
|
|
1518
1550
|
declare function keyValuePairsToJsDoc(keyValues: {
|
|
1519
1551
|
key: string;
|
|
1520
1552
|
value: string;
|
|
1521
1553
|
}[]): string;
|
|
1522
1554
|
//#endregion
|
|
1523
1555
|
//#region src/utils/dynamic-import.d.ts
|
|
1524
|
-
declare
|
|
1556
|
+
declare function dynamicImport<T>(toImport: T | string, from?: string, takeDefault?: boolean): Promise<T>;
|
|
1525
1557
|
//#endregion
|
|
1526
1558
|
//#region src/utils/extension.d.ts
|
|
1527
|
-
declare
|
|
1559
|
+
declare function getExtension(path: string): "yaml" | "json";
|
|
1528
1560
|
//#endregion
|
|
1529
1561
|
//#region src/utils/file.d.ts
|
|
1530
|
-
declare
|
|
1562
|
+
declare function getFileInfo(target?: string, {
|
|
1531
1563
|
backupFilename,
|
|
1532
1564
|
extension
|
|
1533
1565
|
}?: {
|
|
1534
1566
|
backupFilename?: string;
|
|
1535
1567
|
extension?: string;
|
|
1536
|
-
})
|
|
1568
|
+
}): {
|
|
1537
1569
|
path: string;
|
|
1538
1570
|
pathWithoutExtension: string;
|
|
1539
1571
|
extension: string;
|
|
@@ -1544,14 +1576,32 @@ declare const getFileInfo: (target?: string, {
|
|
|
1544
1576
|
declare function removeFilesAndEmptyFolders(patterns: string[], dir: string): Promise<void>;
|
|
1545
1577
|
//#endregion
|
|
1546
1578
|
//#region src/utils/file-extensions.d.ts
|
|
1547
|
-
declare
|
|
1579
|
+
declare function getMockFileExtensionByTypeName(mock: GlobalMockOptions | ClientMockBuilder): string;
|
|
1580
|
+
//#endregion
|
|
1581
|
+
//#region src/utils/get-property-safe.d.ts
|
|
1582
|
+
/**
|
|
1583
|
+
* Type safe way to get arbitrary property from an object.
|
|
1584
|
+
*
|
|
1585
|
+
* @param obj - The object from which to retrieve the property.
|
|
1586
|
+
* @param propertyName - The name of the property to retrieve.
|
|
1587
|
+
* @returns Object with `hasProperty: true` and `value` of the property if it exists; otherwise `hasProperty: false` and undefined.
|
|
1588
|
+
*
|
|
1589
|
+
* @remarks Until TypeScript adds type-narrowing for Object.hasOwn we have to use this workaround
|
|
1590
|
+
*/
|
|
1591
|
+
declare function getPropertySafe<T extends object, K$1 extends keyof T>(obj: T, propertyName: K$1 | string): {
|
|
1592
|
+
hasProperty: true;
|
|
1593
|
+
value: T[K$1];
|
|
1594
|
+
} | {
|
|
1595
|
+
hasProperty: false;
|
|
1596
|
+
value: undefined;
|
|
1597
|
+
};
|
|
1548
1598
|
//#endregion
|
|
1549
1599
|
//#region src/utils/is-body-verb.d.ts
|
|
1550
|
-
declare
|
|
1600
|
+
declare function getIsBodyVerb(verb: Verbs): boolean;
|
|
1551
1601
|
//#endregion
|
|
1552
1602
|
//#region src/utils/logger.d.ts
|
|
1553
1603
|
declare const log: (message?: any, ...optionalParams: any[]) => void;
|
|
1554
|
-
declare
|
|
1604
|
+
declare function startMessage({
|
|
1555
1605
|
name,
|
|
1556
1606
|
version,
|
|
1557
1607
|
description
|
|
@@ -1559,18 +1609,10 @@ declare const startMessage: ({
|
|
|
1559
1609
|
name: string;
|
|
1560
1610
|
version: string;
|
|
1561
1611
|
description: string;
|
|
1562
|
-
})
|
|
1563
|
-
declare
|
|
1564
|
-
declare
|
|
1565
|
-
declare
|
|
1566
|
-
declare const ibmOpenapiValidatorWarnings: (warnings: {
|
|
1567
|
-
path: string[];
|
|
1568
|
-
message: string;
|
|
1569
|
-
}[]) => void;
|
|
1570
|
-
declare const ibmOpenapiValidatorErrors: (errors: {
|
|
1571
|
-
path: string[];
|
|
1572
|
-
message: string;
|
|
1573
|
-
}[]) => void;
|
|
1612
|
+
}): string;
|
|
1613
|
+
declare function logError(err: unknown, tag?: string): void;
|
|
1614
|
+
declare function mismatchArgsMessage(mismatchArgs: string[]): void;
|
|
1615
|
+
declare function createSuccessMessage(backend?: string): void;
|
|
1574
1616
|
type LogType = 'error' | 'warn' | 'info';
|
|
1575
1617
|
type LogLevel = LogType | 'silent';
|
|
1576
1618
|
interface Logger {
|
|
@@ -1593,26 +1635,22 @@ interface LoggerOptions {
|
|
|
1593
1635
|
declare function createLogger(level?: LogLevel, options?: LoggerOptions): Logger;
|
|
1594
1636
|
//#endregion
|
|
1595
1637
|
//#region src/utils/merge-deep.d.ts
|
|
1596
|
-
declare function mergeDeep<T
|
|
1638
|
+
declare function mergeDeep<T extends Record<string, any>, U$1 extends Record<string, any>>(source: T, target: U$1): T & U$1;
|
|
1597
1639
|
//#endregion
|
|
1598
1640
|
//#region src/utils/occurrence.d.ts
|
|
1599
|
-
declare
|
|
1600
|
-
//#endregion
|
|
1601
|
-
//#region src/utils/open-api-converter.d.ts
|
|
1602
|
-
declare const openApiConverter: (schema: any, options: Partial<ConvertInputOptions> | undefined, specKey: string) => Promise<OpenAPIObject>;
|
|
1641
|
+
declare function count(str: string | undefined, key: string): number;
|
|
1603
1642
|
declare namespace path_d_exports {
|
|
1604
|
-
export { basename, dirname, extname, getSchemaFileName,
|
|
1643
|
+
export { basename, dirname, extname, getSchemaFileName, isAbsolute, join, joinSafe, normalizeSafe, relativeSafe, resolve, separator$1 as separator };
|
|
1605
1644
|
}
|
|
1606
1645
|
declare const join: (...paths: string[]) => string, resolve: (...paths: string[]) => string, extname: (path: string) => string, dirname: (path: string) => string, basename: (path: string, suffix?: string) => string, isAbsolute: (path: string) => boolean;
|
|
1607
1646
|
/**
|
|
1608
1647
|
* Behaves exactly like `path.relative(from, to)`, but keeps the first meaningful "./"
|
|
1609
1648
|
*/
|
|
1610
|
-
declare
|
|
1611
|
-
declare
|
|
1612
|
-
declare const getSchemaFileName: (path: string) => string;
|
|
1649
|
+
declare function relativeSafe(from: string, to: string): string;
|
|
1650
|
+
declare function getSchemaFileName(path: string): string;
|
|
1613
1651
|
declare const separator$1 = "/";
|
|
1614
|
-
declare
|
|
1615
|
-
declare
|
|
1652
|
+
declare function normalizeSafe(value: string): string;
|
|
1653
|
+
declare function joinSafe(...values: string[]): string;
|
|
1616
1654
|
//#endregion
|
|
1617
1655
|
//#region src/utils/sort.d.ts
|
|
1618
1656
|
declare const sortByPriority: <T>(arr: (T & {
|
|
@@ -1624,8 +1662,8 @@ declare const sortByPriority: <T>(arr: (T & {
|
|
|
1624
1662
|
})[];
|
|
1625
1663
|
//#endregion
|
|
1626
1664
|
//#region src/utils/string.d.ts
|
|
1627
|
-
declare
|
|
1628
|
-
declare
|
|
1665
|
+
declare function stringify(data?: string | any[] | Record<string, any>): string | undefined;
|
|
1666
|
+
declare function sanitize(value: string, options?: {
|
|
1629
1667
|
whitespace?: string | true;
|
|
1630
1668
|
underscore?: string | true;
|
|
1631
1669
|
dot?: string | true;
|
|
@@ -1633,10 +1671,10 @@ declare const sanitize: (value: string, options?: {
|
|
|
1633
1671
|
es5keyword?: boolean;
|
|
1634
1672
|
es5IdentifierName?: boolean;
|
|
1635
1673
|
special?: boolean;
|
|
1636
|
-
})
|
|
1637
|
-
declare
|
|
1638
|
-
declare
|
|
1639
|
-
declare
|
|
1674
|
+
}): string;
|
|
1675
|
+
declare function toObjectString<T>(props: T[], path?: keyof T): string;
|
|
1676
|
+
declare function getNumberWord(num: number): string;
|
|
1677
|
+
declare function escape(str: string | null, char?: string): string | undefined;
|
|
1640
1678
|
/**
|
|
1641
1679
|
* Escape all characters not included in SingleStringCharacters and
|
|
1642
1680
|
* DoubleStringCharacters on
|
|
@@ -1646,112 +1684,94 @@ declare const escape: (str: string | null, char?: string) => string | undefined;
|
|
|
1646
1684
|
*
|
|
1647
1685
|
* @param input String to escape
|
|
1648
1686
|
*/
|
|
1649
|
-
declare
|
|
1687
|
+
declare function jsStringEscape(input: string): string;
|
|
1650
1688
|
//#endregion
|
|
1651
1689
|
//#region src/utils/tsconfig.d.ts
|
|
1652
|
-
declare
|
|
1653
|
-
//#endregion
|
|
1654
|
-
//#region src/utils/validator.d.ts
|
|
1655
|
-
/**
|
|
1656
|
-
* Validate the spec with ibm-openapi-validator (with a custom pretty logger).
|
|
1657
|
-
* More information: https://github.com/IBM/openapi-validator/#configuration
|
|
1658
|
-
* @param specs openAPI spec
|
|
1659
|
-
*/
|
|
1660
|
-
declare const ibmOpenapiValidator: (specs: OpenAPIObject, validation: boolean | object) => Promise<void>;
|
|
1690
|
+
declare function isSyntheticDefaultImportsAllow(config?: Tsconfig): boolean;
|
|
1661
1691
|
//#endregion
|
|
1662
1692
|
//#region src/writers/schemas.d.ts
|
|
1663
|
-
declare
|
|
1664
|
-
declare
|
|
1665
|
-
|
|
1693
|
+
declare function writeModelInline(acc: string, model: string): string;
|
|
1694
|
+
declare function writeModelsInline(array: GeneratorSchema[]): string;
|
|
1695
|
+
interface WriteSchemaOptions {
|
|
1696
|
+
path: string;
|
|
1697
|
+
schema: GeneratorSchema;
|
|
1698
|
+
target: string;
|
|
1699
|
+
namingConvention: NamingConvention;
|
|
1700
|
+
fileExtension: string;
|
|
1701
|
+
header: string;
|
|
1702
|
+
}
|
|
1703
|
+
declare function writeSchema({
|
|
1666
1704
|
path,
|
|
1667
1705
|
schema,
|
|
1668
1706
|
target,
|
|
1669
1707
|
namingConvention,
|
|
1670
1708
|
fileExtension,
|
|
1671
|
-
specKey,
|
|
1672
|
-
isRootKey,
|
|
1673
|
-
specsName,
|
|
1674
1709
|
header
|
|
1675
|
-
}:
|
|
1676
|
-
|
|
1677
|
-
|
|
1710
|
+
}: WriteSchemaOptions): Promise<void>;
|
|
1711
|
+
interface WriteSchemasOptions {
|
|
1712
|
+
schemaPath: string;
|
|
1713
|
+
schemas: GeneratorSchema[];
|
|
1678
1714
|
target: string;
|
|
1679
1715
|
namingConvention: NamingConvention;
|
|
1680
1716
|
fileExtension: string;
|
|
1681
|
-
specKey: string;
|
|
1682
|
-
isRootKey: boolean;
|
|
1683
|
-
specsName: Record<string, string>;
|
|
1684
1717
|
header: string;
|
|
1685
|
-
|
|
1686
|
-
|
|
1718
|
+
indexFiles: boolean;
|
|
1719
|
+
}
|
|
1720
|
+
declare function writeSchemas({
|
|
1687
1721
|
schemaPath,
|
|
1688
1722
|
schemas,
|
|
1689
1723
|
target,
|
|
1690
1724
|
namingConvention,
|
|
1691
1725
|
fileExtension,
|
|
1692
|
-
specKey,
|
|
1693
|
-
isRootKey,
|
|
1694
|
-
specsName,
|
|
1695
1726
|
header,
|
|
1696
1727
|
indexFiles
|
|
1697
|
-
}:
|
|
1698
|
-
schemaPath: string;
|
|
1699
|
-
schemas: GeneratorSchema[];
|
|
1700
|
-
target: string;
|
|
1701
|
-
namingConvention: NamingConvention;
|
|
1702
|
-
fileExtension: string;
|
|
1703
|
-
specKey: string;
|
|
1704
|
-
isRootKey: boolean;
|
|
1705
|
-
specsName: Record<string, string>;
|
|
1706
|
-
header: string;
|
|
1707
|
-
indexFiles: boolean;
|
|
1708
|
-
}) => Promise<void>;
|
|
1728
|
+
}: WriteSchemasOptions): Promise<void>;
|
|
1709
1729
|
//#endregion
|
|
1710
1730
|
//#region src/writers/single-mode.d.ts
|
|
1711
|
-
declare
|
|
1731
|
+
declare function writeSingleMode({
|
|
1712
1732
|
builder,
|
|
1713
1733
|
output,
|
|
1714
|
-
|
|
1734
|
+
projectName,
|
|
1715
1735
|
header,
|
|
1716
1736
|
needSchema
|
|
1717
|
-
}: WriteModeProps)
|
|
1737
|
+
}: WriteModeProps): Promise<string[]>;
|
|
1718
1738
|
//#endregion
|
|
1719
1739
|
//#region src/writers/split-mode.d.ts
|
|
1720
|
-
declare
|
|
1740
|
+
declare function writeSplitMode({
|
|
1721
1741
|
builder,
|
|
1722
1742
|
output,
|
|
1723
|
-
|
|
1743
|
+
projectName,
|
|
1724
1744
|
header,
|
|
1725
1745
|
needSchema
|
|
1726
|
-
}: WriteModeProps)
|
|
1746
|
+
}: WriteModeProps): Promise<string[]>;
|
|
1727
1747
|
//#endregion
|
|
1728
1748
|
//#region src/writers/split-tags-mode.d.ts
|
|
1729
|
-
declare
|
|
1749
|
+
declare function writeSplitTagsMode({
|
|
1730
1750
|
builder,
|
|
1731
1751
|
output,
|
|
1732
|
-
|
|
1752
|
+
projectName,
|
|
1733
1753
|
header,
|
|
1734
1754
|
needSchema
|
|
1735
|
-
}: WriteModeProps)
|
|
1755
|
+
}: WriteModeProps): Promise<string[]>;
|
|
1736
1756
|
//#endregion
|
|
1737
1757
|
//#region src/writers/tags-mode.d.ts
|
|
1738
|
-
declare
|
|
1758
|
+
declare function writeTagsMode({
|
|
1739
1759
|
builder,
|
|
1740
1760
|
output,
|
|
1741
|
-
|
|
1761
|
+
projectName,
|
|
1742
1762
|
header,
|
|
1743
1763
|
needSchema
|
|
1744
|
-
}: WriteModeProps)
|
|
1764
|
+
}: WriteModeProps): Promise<string[]>;
|
|
1745
1765
|
//#endregion
|
|
1746
1766
|
//#region src/writers/target.d.ts
|
|
1747
|
-
declare
|
|
1767
|
+
declare function generateTarget(builder: WriteSpecBuilder, options: NormalizedOutputOptions): GeneratorTarget;
|
|
1748
1768
|
//#endregion
|
|
1749
1769
|
//#region src/writers/target-tags.d.ts
|
|
1750
|
-
declare
|
|
1770
|
+
declare function generateTargetForTags(builder: WriteSpecBuilder, options: NormalizedOutputOptions): Record<string, GeneratorTarget>;
|
|
1751
1771
|
//#endregion
|
|
1752
1772
|
//#region src/writers/types.d.ts
|
|
1753
|
-
declare
|
|
1754
|
-
declare
|
|
1773
|
+
declare function getOrvalGeneratedTypes(): string;
|
|
1774
|
+
declare function getTypedResponse(): string;
|
|
1755
1775
|
//#endregion
|
|
1756
|
-
export { AngularOptions, BODY_TYPE_NAME, BaseUrlFromConstant, BaseUrlFromSpec, ClientBuilder, ClientDependenciesBuilder, ClientExtraFilesBuilder, ClientFileBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMockBuilder, ClientMockGeneratorBuilder, ClientMockGeneratorImplementation, ClientTitleBuilder, Config, ConfigExternal, ConfigFn,
|
|
1757
|
-
//# sourceMappingURL=index.d.
|
|
1776
|
+
export { AngularOptions, BODY_TYPE_NAME, BaseUrlFromConstant, BaseUrlFromSpec, ClientBuilder, ClientDependenciesBuilder, ClientExtraFilesBuilder, ClientFileBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMockBuilder, ClientMockGeneratorBuilder, ClientMockGeneratorImplementation, ClientTitleBuilder, Config, ConfigExternal, ConfigFn, ContextSpec, DeepNonNullable, EnumGeneration, ErrorWithTag, FetchOptions, FormDataArrayHandling, 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, JsDocOptions, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, MockData, MockDataArray, MockDataArrayFn, MockDataObject, MockDataObjectFn, MockOptions, MockProperties, MockPropertiesObject, MockPropertiesObjectFn, Mutator, MutatorObject, NamingConvention, NormalizedConfig, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMutator, NormalizedOperationOptions, NormalizedOptions, NormalizedOutputOptions, NormalizedOverrideOutput, NormalizedParamsSerializerOptions, NormalizedQueryOptions, NormalizedZodOptions, OpenApiComponentsObject, OpenApiDocument, 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, PropertySortOrder, QueryOptions, RefComponentSuffix, RefInfo, ResReqTypesValue, ResolverValue, ScalarValue, 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, dynamicImport, escape, generalJSTypes, generalJSTypesWithArray, generateAxiosOptions, generateBodyMutatorConfig, generateBodyOptions, generateComponentDefinition, generateDependencyImports, generateFormDataAndUrlEncodedFunction, generateImports, generateModelInline, generateModelsInline, generateMutator, generateMutatorConfig, generateMutatorImports, generateMutatorRequestOptions, generateOptions, generateParameterDefinition, generateQueryParamsAxiosConfig, generateSchemasDefinition, generateTarget, generateTargetForTags, generateVerbImports, generateVerbOptions, generateVerbsOptions, getArray, getBody, getEnum, getEnumDescriptions, getEnumImplementation, getEnumNames, getExtension, getFileInfo, getFullRoute, getIsBodyVerb, getKey, getMockFileExtensionByTypeName, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getPropertySafe, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getRoute, getRouteAsArray, getScalar, getTypedResponse, isBoolean, isDirectory, isFunction, isModule, isNull, isNumber, isNumeric, isObject, isReference, isSchema, isString, isSyntheticDefaultImportsAllow, isUndefined, isUrl, isVerb, jsDoc, jsStringEscape, kebab, keyValuePairsToJsDoc, log, logError, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resolveDiscriminators, resolveExampleRefs, resolveObject, resolveRef, resolveValue, sanitize, snake, sortByPriority, startMessage, stringify, toObjectString, path_d_exports as upath, upper, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
|
|
1777
|
+
//# sourceMappingURL=index.d.mts.map
|