@orval/core 8.9.1 → 8.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +116 -22
- package/dist/index.mjs +389 -106
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -89,6 +89,7 @@ interface NormalizedOverrideOutput {
|
|
|
89
89
|
formUrlEncoded: boolean | NormalizedMutator;
|
|
90
90
|
paramsSerializer?: NormalizedMutator;
|
|
91
91
|
paramsSerializerOptions?: NormalizedParamsSerializerOptions;
|
|
92
|
+
paramsFilter?: NormalizedMutator;
|
|
92
93
|
namingConvention: {
|
|
93
94
|
enum?: NamingConvention;
|
|
94
95
|
};
|
|
@@ -181,6 +182,7 @@ interface NormalizedOperationOptions {
|
|
|
181
182
|
formData?: NormalizedFormDataType<NormalizedMutator>;
|
|
182
183
|
formUrlEncoded?: boolean | NormalizedMutator;
|
|
183
184
|
paramsSerializer?: NormalizedMutator;
|
|
185
|
+
paramsFilter?: NormalizedMutator;
|
|
184
186
|
requestOptions?: object | boolean;
|
|
185
187
|
}
|
|
186
188
|
interface NormalizedInputOptions {
|
|
@@ -430,6 +432,7 @@ interface OverrideOutput {
|
|
|
430
432
|
formUrlEncoded?: boolean | Mutator;
|
|
431
433
|
paramsSerializer?: Mutator;
|
|
432
434
|
paramsSerializerOptions?: ParamsSerializerOptions;
|
|
435
|
+
paramsFilter?: Mutator;
|
|
433
436
|
namingConvention?: {
|
|
434
437
|
enum?: NamingConvention;
|
|
435
438
|
};
|
|
@@ -753,7 +756,7 @@ interface FetchOptions {
|
|
|
753
756
|
runtimeValidation?: boolean;
|
|
754
757
|
useRuntimeFetcher?: boolean;
|
|
755
758
|
}
|
|
756
|
-
type InputTransformerFn = (spec: OpenApiDocument) => OpenApiDocument
|
|
759
|
+
type InputTransformerFn = (spec: OpenApiDocument) => OpenApiDocument | Promise<OpenApiDocument>;
|
|
757
760
|
type InputTransformer = string | InputTransformerFn;
|
|
758
761
|
interface OverrideInput {
|
|
759
762
|
transformer?: InputTransformer;
|
|
@@ -774,6 +777,7 @@ interface OperationOptions {
|
|
|
774
777
|
formData?: boolean | Mutator | FormDataType<Mutator>;
|
|
775
778
|
formUrlEncoded?: boolean | Mutator;
|
|
776
779
|
paramsSerializer?: Mutator;
|
|
780
|
+
paramsFilter?: Mutator;
|
|
777
781
|
requestOptions?: object | boolean;
|
|
778
782
|
}
|
|
779
783
|
type Hook = 'afterAllFilesWrite';
|
|
@@ -795,6 +799,10 @@ declare const Verbs: {
|
|
|
795
799
|
DELETE: Verbs;
|
|
796
800
|
HEAD: Verbs;
|
|
797
801
|
};
|
|
802
|
+
/**
|
|
803
|
+
* Canonical tag name used for the generated bucket that collects untagged operations.
|
|
804
|
+
*/
|
|
805
|
+
declare const DefaultTag: "default";
|
|
798
806
|
interface ImportOpenApi {
|
|
799
807
|
spec: OpenApiDocument;
|
|
800
808
|
input: NormalizedInputOptions;
|
|
@@ -834,9 +842,32 @@ interface Tsconfig {
|
|
|
834
842
|
exactOptionalPropertyTypes?: boolean;
|
|
835
843
|
paths?: Record<string, string[]>;
|
|
836
844
|
target?: TsConfigTarget;
|
|
845
|
+
module?: TsConfigModule;
|
|
846
|
+
moduleResolution?: TsConfigModuleResolution;
|
|
847
|
+
allowImportingTsExtensions?: boolean;
|
|
837
848
|
};
|
|
838
849
|
}
|
|
839
|
-
type TsConfigTarget = 'es3' | 'es5' | 'es6' | 'es2015' | 'es2016' | 'es2017' | 'es2018' | 'es2019' | 'es2020' | 'es2021' | 'es2022' | 'esnext';
|
|
850
|
+
type TsConfigTarget = 'es3' | 'es5' | 'es6' | 'es2015' | 'es2016' | 'es2017' | 'es2018' | 'es2019' | 'es2020' | 'es2021' | 'es2022' | 'es2023' | 'es2024' | 'es2025' | 'esnext';
|
|
851
|
+
/** Accepts both the canonical casing and the all-lowercase variant of a string literal. */
|
|
852
|
+
type CaseInsensitive<T extends string> = T | Lowercase<T>;
|
|
853
|
+
/**
|
|
854
|
+
* Valid values for the TypeScript `compilerOptions.module` setting.
|
|
855
|
+
*
|
|
856
|
+
* Both title-case (e.g. `"NodeNext"`) and lower-case (e.g. `"nodenext"`) are
|
|
857
|
+
* accepted, matching TypeScript's own case-insensitive parsing.
|
|
858
|
+
*
|
|
859
|
+
* @see {@link https://www.typescriptlang.org/tsconfig#module}
|
|
860
|
+
*/
|
|
861
|
+
type TsConfigModule = CaseInsensitive<'None' | 'CommonJS' | 'AMD' | 'UMD' | 'System' | 'ES6' | 'ES2015' | 'ES2020' | 'ES2022' | 'ESNext' | 'Node16' | 'Node18' | 'Node20' | 'NodeNext' | 'Preserve'>;
|
|
862
|
+
/**
|
|
863
|
+
* Valid values for the TypeScript `compilerOptions.moduleResolution` setting.
|
|
864
|
+
*
|
|
865
|
+
* Both title-case (e.g. `"NodeNext"`) and lower-case (e.g. `"nodenext"`) are
|
|
866
|
+
* accepted, matching TypeScript's own case-insensitive parsing.
|
|
867
|
+
*
|
|
868
|
+
* @see https://www.typescriptlang.org/tsconfig#moduleResolution
|
|
869
|
+
*/
|
|
870
|
+
type TsConfigModuleResolution = CaseInsensitive<'Classic' | 'Node' | 'Node10' | 'Node16' | 'NodeNext' | 'Bundler'>;
|
|
840
871
|
interface PackageJson {
|
|
841
872
|
dependencies?: Record<string, string>;
|
|
842
873
|
devDependencies?: Record<string, string>;
|
|
@@ -883,6 +914,7 @@ interface GeneratorTarget {
|
|
|
883
914
|
formData?: GeneratorMutator[];
|
|
884
915
|
formUrlEncoded?: GeneratorMutator[];
|
|
885
916
|
paramsSerializer?: GeneratorMutator[];
|
|
917
|
+
paramsFilter?: GeneratorMutator[];
|
|
886
918
|
fetchReviver?: GeneratorMutator[];
|
|
887
919
|
}
|
|
888
920
|
interface GeneratorTargetFull {
|
|
@@ -899,6 +931,7 @@ interface GeneratorTargetFull {
|
|
|
899
931
|
formData?: GeneratorMutator[];
|
|
900
932
|
formUrlEncoded?: GeneratorMutator[];
|
|
901
933
|
paramsSerializer?: GeneratorMutator[];
|
|
934
|
+
paramsFilter?: GeneratorMutator[];
|
|
902
935
|
fetchReviver?: GeneratorMutator[];
|
|
903
936
|
}
|
|
904
937
|
interface GeneratorOperation {
|
|
@@ -916,6 +949,7 @@ interface GeneratorOperation {
|
|
|
916
949
|
formData?: GeneratorMutator;
|
|
917
950
|
formUrlEncoded?: GeneratorMutator;
|
|
918
951
|
paramsSerializer?: GeneratorMutator;
|
|
952
|
+
paramsFilter?: GeneratorMutator;
|
|
919
953
|
fetchReviver?: GeneratorMutator;
|
|
920
954
|
operationName: string;
|
|
921
955
|
types?: {
|
|
@@ -941,6 +975,7 @@ interface GeneratorVerbOptions {
|
|
|
941
975
|
formData?: GeneratorMutator;
|
|
942
976
|
formUrlEncoded?: GeneratorMutator;
|
|
943
977
|
paramsSerializer?: GeneratorMutator;
|
|
978
|
+
paramsFilter?: GeneratorMutator;
|
|
944
979
|
fetchReviver?: GeneratorMutator;
|
|
945
980
|
override: NormalizedOverrideOutput;
|
|
946
981
|
deprecated?: boolean;
|
|
@@ -994,6 +1029,7 @@ type ClientHeaderBuilder = (params: {
|
|
|
994
1029
|
output: NormalizedOutputOptions;
|
|
995
1030
|
verbOptions: Record<string, GeneratorVerbOptions>;
|
|
996
1031
|
tag?: string;
|
|
1032
|
+
isDefaultTagBucket?: boolean;
|
|
997
1033
|
clientImplementation: string;
|
|
998
1034
|
}) => string;
|
|
999
1035
|
type ClientFooterBuilder = (params: {
|
|
@@ -1079,6 +1115,14 @@ interface GetterQueryParam {
|
|
|
1079
1115
|
isOptional: boolean;
|
|
1080
1116
|
originalSchema?: OpenApiSchemaObject;
|
|
1081
1117
|
requiredNullableKeys?: string[];
|
|
1118
|
+
/**
|
|
1119
|
+
* Names of query parameters whose declared schema is non-primitive
|
|
1120
|
+
* (object, array of objects, or untyped). Used by Angular generators to
|
|
1121
|
+
* preserve these values through the default `filterParams` helper instead
|
|
1122
|
+
* of silently dropping them — the user's `paramsSerializer`, `mutator`, or
|
|
1123
|
+
* `paramsFilter` is then responsible for handling them. See issue #3326.
|
|
1124
|
+
*/
|
|
1125
|
+
nonPrimitiveKeys?: string[];
|
|
1082
1126
|
}
|
|
1083
1127
|
type GetterPropType = 'param' | 'body' | 'queryParam' | 'header' | 'namedPathParams';
|
|
1084
1128
|
declare const GetterPropType: {
|
|
@@ -1189,6 +1233,7 @@ type GeneratorClientHeader = (data: {
|
|
|
1189
1233
|
output: NormalizedOutputOptions;
|
|
1190
1234
|
verbOptions: Record<string, GeneratorVerbOptions>;
|
|
1191
1235
|
tag?: string;
|
|
1236
|
+
isDefaultTagBucket?: boolean;
|
|
1192
1237
|
clientImplementation: string;
|
|
1193
1238
|
}) => GeneratorClientExtra;
|
|
1194
1239
|
type GeneratorClientFooter = (data: {
|
|
@@ -1267,10 +1312,12 @@ declare function generateComponentDefinition(responses: OpenApiComponentsObject[
|
|
|
1267
1312
|
interface GenerateImportsOptions {
|
|
1268
1313
|
imports: readonly GeneratorImport[];
|
|
1269
1314
|
namingConvention?: NamingConvention;
|
|
1315
|
+
importExtension?: string;
|
|
1270
1316
|
}
|
|
1271
1317
|
declare function generateImports({
|
|
1272
1318
|
imports,
|
|
1273
|
-
namingConvention
|
|
1319
|
+
namingConvention,
|
|
1320
|
+
importExtension
|
|
1274
1321
|
}: GenerateImportsOptions): string;
|
|
1275
1322
|
interface GenerateMutatorImportsOptions {
|
|
1276
1323
|
mutators: GeneratorMutator[];
|
|
@@ -1351,7 +1398,7 @@ declare function generateMutator({
|
|
|
1351
1398
|
* (e.g. observe-mode branches), prefer getAngularFilteredParamsCallExpression +
|
|
1352
1399
|
* getAngularFilteredParamsHelperBody instead.
|
|
1353
1400
|
*/
|
|
1354
|
-
declare const getAngularFilteredParamsExpression: (paramsExpression: string, requiredNullableParamKeys?: string[], preserveRequiredNullables?: boolean) => string;
|
|
1401
|
+
declare const getAngularFilteredParamsExpression: (paramsExpression: string, requiredNullableParamKeys?: string[], preserveRequiredNullables?: boolean, nonPrimitiveKeys?: string[]) => string;
|
|
1355
1402
|
/**
|
|
1356
1403
|
* Returns the body of a standalone `filterParams` helper function
|
|
1357
1404
|
* to be emitted once in the generated file header, replacing the
|
|
@@ -1361,7 +1408,32 @@ declare const getAngularFilteredParamsHelperBody: () => string;
|
|
|
1361
1408
|
/**
|
|
1362
1409
|
* Returns a call expression to the `filterParams` helper function.
|
|
1363
1410
|
*/
|
|
1364
|
-
declare const getAngularFilteredParamsCallExpression: (paramsExpression: string, requiredNullableParamKeys?: string[], preserveRequiredNullables?: boolean) => string;
|
|
1411
|
+
declare const getAngularFilteredParamsCallExpression: (paramsExpression: string, requiredNullableParamKeys?: string[], preserveRequiredNullables?: boolean, nonPrimitiveKeys?: string[]) => string;
|
|
1412
|
+
/**
|
|
1413
|
+
* Returns the filter call/IIFE used to massage query params before passing
|
|
1414
|
+
* them to Angular's HttpParams. When the user supplied a `paramsFilter`
|
|
1415
|
+
* mutator, the built-in `filterParams` is bypassed entirely and the user's
|
|
1416
|
+
* function is called with the raw params — they own nullish-stripping and
|
|
1417
|
+
* any object/array handling. Otherwise the built-in filter is used (either
|
|
1418
|
+
* the shared helper or an inline IIFE), and callers should only pass
|
|
1419
|
+
* `nonPrimitiveKeys` when a downstream serializer or custom consumer can
|
|
1420
|
+
* legally handle raw object/array values.
|
|
1421
|
+
*/
|
|
1422
|
+
declare const buildAngularParamsFilterExpression: ({
|
|
1423
|
+
paramsExpression,
|
|
1424
|
+
requiredNullableParamKeys,
|
|
1425
|
+
preserveRequiredNullables,
|
|
1426
|
+
nonPrimitiveKeys,
|
|
1427
|
+
paramsFilter,
|
|
1428
|
+
useSharedHelper
|
|
1429
|
+
}: {
|
|
1430
|
+
paramsExpression: string;
|
|
1431
|
+
requiredNullableParamKeys?: string[];
|
|
1432
|
+
preserveRequiredNullables?: boolean;
|
|
1433
|
+
nonPrimitiveKeys?: string[];
|
|
1434
|
+
paramsFilter?: GeneratorMutator;
|
|
1435
|
+
useSharedHelper: boolean;
|
|
1436
|
+
}) => string;
|
|
1365
1437
|
interface GenerateFormDataAndUrlEncodedFunctionOptions {
|
|
1366
1438
|
body: GetterBody;
|
|
1367
1439
|
formData?: GeneratorMutator;
|
|
@@ -1369,13 +1441,14 @@ interface GenerateFormDataAndUrlEncodedFunctionOptions {
|
|
|
1369
1441
|
isFormData: boolean;
|
|
1370
1442
|
isFormUrlEncoded: boolean;
|
|
1371
1443
|
}
|
|
1372
|
-
declare function generateBodyOptions(body: GetterBody, isFormData: boolean, isFormUrlEncoded: boolean): string;
|
|
1444
|
+
declare function generateBodyOptions(body: GetterBody, isFormData: boolean, isFormUrlEncoded: boolean): string | undefined;
|
|
1373
1445
|
interface GenerateAxiosOptions {
|
|
1374
1446
|
response: GetterResponse;
|
|
1375
1447
|
isExactOptionalPropertyTypes: boolean;
|
|
1376
1448
|
angularObserve?: 'body' | 'events' | 'response';
|
|
1377
1449
|
angularParamsRef?: string;
|
|
1378
1450
|
requiredNullableQueryParamKeys?: string[];
|
|
1451
|
+
nonPrimitiveQueryParamKeys?: string[];
|
|
1379
1452
|
queryParams?: GeneratorSchema;
|
|
1380
1453
|
headers?: GeneratorSchema;
|
|
1381
1454
|
requestOptions?: object | boolean;
|
|
@@ -1385,6 +1458,7 @@ interface GenerateAxiosOptions {
|
|
|
1385
1458
|
isAngular: boolean;
|
|
1386
1459
|
paramsSerializer?: GeneratorMutator;
|
|
1387
1460
|
paramsSerializerOptions?: ParamsSerializerOptions;
|
|
1461
|
+
paramsFilter?: GeneratorMutator;
|
|
1388
1462
|
}
|
|
1389
1463
|
declare function generateAxiosOptions({
|
|
1390
1464
|
response,
|
|
@@ -1392,6 +1466,7 @@ declare function generateAxiosOptions({
|
|
|
1392
1466
|
angularObserve,
|
|
1393
1467
|
angularParamsRef,
|
|
1394
1468
|
requiredNullableQueryParamKeys,
|
|
1469
|
+
nonPrimitiveQueryParamKeys,
|
|
1395
1470
|
queryParams,
|
|
1396
1471
|
headers,
|
|
1397
1472
|
requestOptions,
|
|
@@ -1400,7 +1475,8 @@ declare function generateAxiosOptions({
|
|
|
1400
1475
|
isVue,
|
|
1401
1476
|
isAngular,
|
|
1402
1477
|
paramsSerializer,
|
|
1403
|
-
paramsSerializerOptions
|
|
1478
|
+
paramsSerializerOptions,
|
|
1479
|
+
paramsFilter
|
|
1404
1480
|
}: GenerateAxiosOptions): string;
|
|
1405
1481
|
interface GenerateOptionsOptions {
|
|
1406
1482
|
route: string;
|
|
@@ -1421,6 +1497,7 @@ interface GenerateOptionsOptions {
|
|
|
1421
1497
|
isVue?: boolean;
|
|
1422
1498
|
paramsSerializer?: GeneratorMutator;
|
|
1423
1499
|
paramsSerializerOptions?: ParamsSerializerOptions;
|
|
1500
|
+
paramsFilter?: GeneratorMutator;
|
|
1424
1501
|
}
|
|
1425
1502
|
declare function generateOptions({
|
|
1426
1503
|
route,
|
|
@@ -1440,10 +1517,11 @@ declare function generateOptions({
|
|
|
1440
1517
|
hasSignalParam,
|
|
1441
1518
|
isVue,
|
|
1442
1519
|
paramsSerializer,
|
|
1443
|
-
paramsSerializerOptions
|
|
1520
|
+
paramsSerializerOptions,
|
|
1521
|
+
paramsFilter
|
|
1444
1522
|
}: GenerateOptionsOptions): string;
|
|
1445
1523
|
declare function generateBodyMutatorConfig(body: GetterBody, isFormData: boolean, isFormUrlEncoded: boolean): string;
|
|
1446
|
-
declare function generateQueryParamsAxiosConfig(response: GetterResponse, isVue: boolean, isAngular: boolean, requiredNullableQueryParamKeys?: string[], queryParams?: GetterQueryParam): string;
|
|
1524
|
+
declare function generateQueryParamsAxiosConfig(response: GetterResponse, isVue: boolean, isAngular: boolean, requiredNullableQueryParamKeys?: string[], queryParams?: GetterQueryParam, paramsFilter?: GeneratorMutator): string;
|
|
1447
1525
|
interface GenerateMutatorConfigOptions {
|
|
1448
1526
|
route: string;
|
|
1449
1527
|
body: GetterBody;
|
|
@@ -1458,6 +1536,7 @@ interface GenerateMutatorConfigOptions {
|
|
|
1458
1536
|
isExactOptionalPropertyTypes: boolean;
|
|
1459
1537
|
isVue?: boolean;
|
|
1460
1538
|
isAngular?: boolean;
|
|
1539
|
+
paramsFilter?: GeneratorMutator;
|
|
1461
1540
|
}
|
|
1462
1541
|
declare function generateMutatorConfig({
|
|
1463
1542
|
route,
|
|
@@ -1472,7 +1551,8 @@ declare function generateMutatorConfig({
|
|
|
1472
1551
|
hasSignalParam,
|
|
1473
1552
|
isExactOptionalPropertyTypes,
|
|
1474
1553
|
isVue,
|
|
1475
|
-
isAngular
|
|
1554
|
+
isAngular,
|
|
1555
|
+
paramsFilter
|
|
1476
1556
|
}: GenerateMutatorConfigOptions): string;
|
|
1477
1557
|
declare function generateMutatorRequestOptions(requestOptions: boolean | object | undefined, hasSecondArgument: boolean): string;
|
|
1478
1558
|
declare function generateFormDataAndUrlEncodedFunction({
|
|
@@ -1738,14 +1818,22 @@ declare function getQueryParams({
|
|
|
1738
1818
|
}: GetQueryParamsOptions): GetterQueryParam | undefined;
|
|
1739
1819
|
//#endregion
|
|
1740
1820
|
//#region src/getters/ref.d.ts
|
|
1741
|
-
|
|
1742
|
-
|
|
1743
|
-
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
|
|
1821
|
+
/**
|
|
1822
|
+
* `$ref`s targeting these sections under `#/components/...` are emitted as
|
|
1823
|
+
* named TypeScript imports (e.g. `import type { Pet } from './model'`).
|
|
1824
|
+
* Refs to any other location — for example `#/paths/.../schema` produced by
|
|
1825
|
+
* JSON-Schema-Ref-Parser `bundle()` — have no corresponding `export type`
|
|
1826
|
+
* and must be inlined by the resolver. See issue #398.
|
|
1827
|
+
*/
|
|
1828
|
+
declare const NAMED_COMPONENT_SECTIONS: readonly ["schemas", "responses", "parameters", "requestBodies"];
|
|
1829
|
+
type RefComponent = (typeof NAMED_COMPONENT_SECTIONS)[number];
|
|
1748
1830
|
declare const RefComponentSuffix: Record<RefComponent, string>;
|
|
1831
|
+
/**
|
|
1832
|
+
* True iff `ref` targets a named slot eligible for emission as a TypeScript
|
|
1833
|
+
* import. Used by `resolveValue` to decide between named import vs inlining
|
|
1834
|
+
* the resolved schema.
|
|
1835
|
+
*/
|
|
1836
|
+
declare function isComponentRef(ref: string): boolean;
|
|
1749
1837
|
interface RefInfo {
|
|
1750
1838
|
name: string;
|
|
1751
1839
|
originalName: string;
|
|
@@ -2002,6 +2090,7 @@ interface JsDocSchema extends Record<string, unknown> {
|
|
|
2002
2090
|
maxItems?: number;
|
|
2003
2091
|
type?: string | string[];
|
|
2004
2092
|
pattern?: string;
|
|
2093
|
+
items?: JsDocSchema;
|
|
2005
2094
|
}
|
|
2006
2095
|
declare function jsDoc(schema: object & JsDocSchema, tryOneLine?: boolean, context?: ContextSpec): string;
|
|
2007
2096
|
declare function keyValuePairsToJsDoc(keyValues: {
|
|
@@ -2260,6 +2349,7 @@ declare function dedupeUnionType(unionType: string): string;
|
|
|
2260
2349
|
//#endregion
|
|
2261
2350
|
//#region src/utils/tsconfig.d.ts
|
|
2262
2351
|
declare function isSyntheticDefaultImportsAllow(config?: Tsconfig): boolean;
|
|
2352
|
+
declare function getImportExtension(fileExtension: string, tsconfig?: Tsconfig): string;
|
|
2263
2353
|
//#endregion
|
|
2264
2354
|
//#region src/writers/schemas.d.ts
|
|
2265
2355
|
/**
|
|
@@ -2272,11 +2362,11 @@ declare function splitSchemasByType(schemas: GeneratorSchema[]): {
|
|
|
2272
2362
|
/**
|
|
2273
2363
|
* Fix imports in operation schemas that reference regular schemas.
|
|
2274
2364
|
*/
|
|
2275
|
-
declare function fixCrossDirectoryImports(operationSchemas: GeneratorSchema[], regularSchemaNames: Set<string>, schemaPath: string, operationSchemaPath: string, namingConvention: NamingConvention, fileExtension: string): void;
|
|
2365
|
+
declare function fixCrossDirectoryImports(operationSchemas: GeneratorSchema[], regularSchemaNames: Set<string>, schemaPath: string, operationSchemaPath: string, namingConvention: NamingConvention, fileExtension: string, tsconfig?: Tsconfig): void;
|
|
2276
2366
|
/**
|
|
2277
2367
|
* Fix imports in regular schemas that reference operation schemas.
|
|
2278
2368
|
*/
|
|
2279
|
-
declare function fixRegularSchemaImports(regularSchemas: GeneratorSchema[], operationSchemaNames: Set<string>, schemaPath: string, operationSchemaPath: string, namingConvention: NamingConvention, fileExtension: string): void;
|
|
2369
|
+
declare function fixRegularSchemaImports(regularSchemas: GeneratorSchema[], operationSchemaNames: Set<string>, schemaPath: string, operationSchemaPath: string, namingConvention: NamingConvention, fileExtension: string, tsconfig?: Tsconfig): void;
|
|
2280
2370
|
declare function writeModelInline(acc: string, model: string): string;
|
|
2281
2371
|
declare function writeModelsInline(array: GeneratorSchema[]): string;
|
|
2282
2372
|
interface WriteSchemaOptions {
|
|
@@ -2286,6 +2376,7 @@ interface WriteSchemaOptions {
|
|
|
2286
2376
|
namingConvention: NamingConvention;
|
|
2287
2377
|
fileExtension: string;
|
|
2288
2378
|
header: string;
|
|
2379
|
+
tsconfig?: Tsconfig;
|
|
2289
2380
|
}
|
|
2290
2381
|
declare function writeSchema({
|
|
2291
2382
|
path,
|
|
@@ -2293,7 +2384,8 @@ declare function writeSchema({
|
|
|
2293
2384
|
target,
|
|
2294
2385
|
namingConvention,
|
|
2295
2386
|
fileExtension,
|
|
2296
|
-
header
|
|
2387
|
+
header,
|
|
2388
|
+
tsconfig
|
|
2297
2389
|
}: WriteSchemaOptions): Promise<void>;
|
|
2298
2390
|
interface WriteSchemasOptions {
|
|
2299
2391
|
schemaPath: string;
|
|
@@ -2303,6 +2395,7 @@ interface WriteSchemasOptions {
|
|
|
2303
2395
|
fileExtension: string;
|
|
2304
2396
|
header: string;
|
|
2305
2397
|
indexFiles: boolean;
|
|
2398
|
+
tsconfig?: Tsconfig;
|
|
2306
2399
|
}
|
|
2307
2400
|
declare function writeSchemas({
|
|
2308
2401
|
schemaPath,
|
|
@@ -2311,7 +2404,8 @@ declare function writeSchemas({
|
|
|
2311
2404
|
namingConvention,
|
|
2312
2405
|
fileExtension,
|
|
2313
2406
|
header,
|
|
2314
|
-
indexFiles
|
|
2407
|
+
indexFiles,
|
|
2408
|
+
tsconfig
|
|
2315
2409
|
}: WriteSchemasOptions): Promise<void>;
|
|
2316
2410
|
//#endregion
|
|
2317
2411
|
//#region src/writers/single-mode.d.ts
|
|
@@ -2364,5 +2458,5 @@ declare function generateTargetForTags(builder: WriteSpecBuilder, options: Norma
|
|
|
2364
2458
|
declare function getOrvalGeneratedTypes(): string;
|
|
2365
2459
|
declare function getTypedResponse(): string;
|
|
2366
2460
|
//#endregion
|
|
2367
|
-
export { AngularHttpResourceOptions, AngularOptions, BODY_TYPE_NAME, BaseUrlFromConstant, BaseUrlFromSpec, BaseUrlRuntime, 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, InvalidateTargetParam, JsDocOptions, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, McpOptions, McpServerOptions, MockData, MockDataArray, MockDataArrayFn, MockDataObject, MockDataObjectFn, MockOptions, MockProperties, MockPropertiesObject, MockPropertiesObjectFn, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NamingConvention, NormalizedAngularOptions, NormalizedConfig, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMcpOptions, NormalizedMcpServerOptions, 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, SupportedFormatter, SwrOptions, TEMPLATE_TAG_REGEX, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecBuilder, ZodCoerceType, ZodDateTimeOptions, ZodOptions, ZodTimeOptions, addDependency, asyncReduce, camel, collectReferencedComponents, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dedupeUnionType, dynamicImport, escape, escapeRegExp, filterByContentType, filteredVerbs, 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, getBaseUrlRuntimeImports, getBodiesByContentType, 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, getWarningCount, isBinaryContentType, isBoolean, isDirectory, isFunction, isModule, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, isVerbose, jsDoc, jsStringEscape, kebab, keyValuePairsToJsDoc, log, logError, logVerbose, logWarning, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resetWarnings, 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 };
|
|
2461
|
+
export { AngularHttpResourceOptions, AngularOptions, BODY_TYPE_NAME, BaseUrlFromConstant, BaseUrlFromSpec, BaseUrlRuntime, ClientBuilder, ClientDependenciesBuilder, ClientExtraFilesBuilder, ClientFileBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMockBuilder, ClientMockGeneratorBuilder, ClientMockGeneratorImplementation, ClientTitleBuilder, Config, ConfigExternal, ConfigFn, ContentTypeFilter, ContextSpec, DeepNonNullable, DefaultTag, 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, InvalidateTargetParam, JsDocOptions, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, McpOptions, McpServerOptions, MockData, MockDataArray, MockDataArrayFn, MockDataObject, MockDataObjectFn, MockOptions, MockProperties, MockPropertiesObject, MockPropertiesObjectFn, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NAMED_COMPONENT_SECTIONS, NamingConvention, NormalizedAngularOptions, NormalizedConfig, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMcpOptions, NormalizedMcpServerOptions, 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, SupportedFormatter, SwrOptions, TEMPLATE_TAG_REGEX, TsConfigModule, TsConfigModuleResolution, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecBuilder, ZodCoerceType, ZodDateTimeOptions, ZodOptions, ZodTimeOptions, addDependency, asyncReduce, buildAngularParamsFilterExpression, camel, collectReferencedComponents, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dedupeUnionType, dynamicImport, escape, escapeRegExp, filterByContentType, filteredVerbs, 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, getBaseUrlRuntimeImports, getBodiesByContentType, getBody, getCombinedEnumValue, getDefaultContentType, getEnum, getEnumDescriptions, getEnumImplementation, getEnumNames, getEnumUnionFromSchema, getExtension, getFileInfo, getFormDataFieldFileType, getFullRoute, getImportExtension, getIsBodyVerb, getKey, getMockFileExtensionByTypeName, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getPropertySafe, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getResponseTypeCategory, getRoute, getRouteAsArray, getScalar, getSuccessResponseType, getTypedResponse, getWarningCount, isBinaryContentType, isBoolean, isComponentRef, isDirectory, isFunction, isModule, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, isVerbose, jsDoc, jsStringEscape, kebab, keyValuePairsToJsDoc, log, logError, logVerbose, logWarning, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resetWarnings, 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 };
|
|
2368
2462
|
//# sourceMappingURL=index.d.mts.map
|