@orval/core 8.16.0 → 8.18.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 +22 -5
- package/dist/index.mjs +397 -112
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -265,7 +265,7 @@ interface NormalizedFactoryMethodsOptions {
|
|
|
265
265
|
}
|
|
266
266
|
interface SchemaOptions {
|
|
267
267
|
path: string;
|
|
268
|
-
type
|
|
268
|
+
type?: SchemaGenerationType;
|
|
269
269
|
importPath?: string;
|
|
270
270
|
}
|
|
271
271
|
interface NormalizedSchemaOptions {
|
|
@@ -395,27 +395,32 @@ interface CommonMockOptions {
|
|
|
395
395
|
generateEachHttpStatus?: boolean;
|
|
396
396
|
locale?: keyof typeof allLocales;
|
|
397
397
|
preferredContentType?: string;
|
|
398
|
+
arrayItems?: boolean;
|
|
398
399
|
}
|
|
399
400
|
interface MswMockOptions extends CommonMockOptions {
|
|
400
401
|
type: typeof OutputMockType.MSW;
|
|
401
402
|
baseUrl?: string;
|
|
402
403
|
delay?: false | number | (() => number);
|
|
403
404
|
delayFunctionLazyExecute?: boolean;
|
|
405
|
+
path?: string;
|
|
404
406
|
}
|
|
405
407
|
interface FakerMockOptions extends CommonMockOptions {
|
|
406
408
|
type: typeof OutputMockType.FAKER;
|
|
407
409
|
schemas?: boolean;
|
|
410
|
+
schemasImportPath?: string;
|
|
408
411
|
operationResponses?: boolean;
|
|
409
|
-
|
|
412
|
+
path?: string;
|
|
410
413
|
}
|
|
411
414
|
type GlobalMockOptions = MswMockOptions | FakerMockOptions;
|
|
412
415
|
interface OutputMocksConfig {
|
|
413
416
|
indexMockFiles?: boolean;
|
|
417
|
+
path?: string;
|
|
414
418
|
generators: (GlobalMockOptions | ClientMockBuilder)[];
|
|
415
419
|
}
|
|
416
420
|
type OutputMocksOption = boolean | OutputMocksConfig | ClientMockBuilder;
|
|
417
421
|
interface NormalizedMocksConfig {
|
|
418
422
|
indexMockFiles: boolean;
|
|
423
|
+
path?: string;
|
|
419
424
|
generators: (GlobalMockOptions | ClientMockBuilder)[];
|
|
420
425
|
}
|
|
421
426
|
type OverrideMockOptions = Partial<GlobalMockOptions> & {
|
|
@@ -667,7 +672,7 @@ interface EffectOptions {
|
|
|
667
672
|
generateEachHttpStatus?: boolean;
|
|
668
673
|
useBrandedTypes?: boolean;
|
|
669
674
|
}
|
|
670
|
-
type ZodCoerceType = 'string' | 'number' | 'boolean' | 'bigint' | 'date';
|
|
675
|
+
type ZodCoerceType = 'string' | 'number' | 'boolean' | 'bigint' | 'date' | 'array';
|
|
671
676
|
interface NormalizedZodOptions {
|
|
672
677
|
strict: {
|
|
673
678
|
param: boolean;
|
|
@@ -953,9 +958,16 @@ interface ContextSpec {
|
|
|
953
958
|
* Tracks array-item mock factory names already emitted per output file scope.
|
|
954
959
|
* Populated by `@orval/mock` when `arrayItems: true` so shared `$ref` item
|
|
955
960
|
* factories are not re-declared within the same file (single/split) or tag
|
|
956
|
-
* bucket (tags/tags-split).
|
|
961
|
+
* bucket (tags/tags-split). Scope keys include the active mock generator
|
|
962
|
+
* type so separate `.msw.ts` / `.faker.ts` files each get their own copy.
|
|
957
963
|
*/
|
|
958
964
|
arrayItemMockFactories?: Map<string, Set<string>>;
|
|
965
|
+
/**
|
|
966
|
+
* Set by `@orval/mock` while generating per-operation mock output so
|
|
967
|
+
* file-scoped helpers (e.g. array-item factory dedup) can distinguish
|
|
968
|
+
* separate mock generator files.
|
|
969
|
+
*/
|
|
970
|
+
activeMockOutputType?: OutputMockType;
|
|
959
971
|
}
|
|
960
972
|
/**
|
|
961
973
|
* Maps a `$dynamicAnchor` name to its resolution target.
|
|
@@ -1063,11 +1075,13 @@ interface GeneratorApiResponse {
|
|
|
1063
1075
|
schemas: GeneratorSchema[];
|
|
1064
1076
|
}
|
|
1065
1077
|
type GeneratorOperations = Record<string, GeneratorOperation>;
|
|
1078
|
+
type StrictMockSchemaKind = 'object' | 'alias' | 'binary';
|
|
1066
1079
|
interface GeneratorMockOutput {
|
|
1067
1080
|
type: OutputMockType;
|
|
1068
1081
|
implementation: string;
|
|
1069
1082
|
imports: GeneratorImport[];
|
|
1070
1083
|
strictMockSchemaTypeNames?: string[];
|
|
1084
|
+
strictMockSchemaKinds?: Record<string, StrictMockSchemaKind>;
|
|
1071
1085
|
}
|
|
1072
1086
|
interface GeneratorMockOutputFull {
|
|
1073
1087
|
type: OutputMockType;
|
|
@@ -1078,6 +1092,7 @@ interface GeneratorMockOutputFull {
|
|
|
1078
1092
|
};
|
|
1079
1093
|
imports: GeneratorImport[];
|
|
1080
1094
|
strictMockSchemaTypeNames?: string[];
|
|
1095
|
+
strictMockSchemaKinds?: Record<string, StrictMockSchemaKind>;
|
|
1081
1096
|
}
|
|
1082
1097
|
interface GeneratorTarget {
|
|
1083
1098
|
imports: GeneratorImport[];
|
|
@@ -1214,6 +1229,7 @@ interface ClientMockGeneratorBuilder {
|
|
|
1214
1229
|
imports: GeneratorImport[];
|
|
1215
1230
|
implementation: ClientMockGeneratorImplementation;
|
|
1216
1231
|
strictMockSchemaTypeNames?: string[];
|
|
1232
|
+
strictMockSchemaKinds?: Record<string, StrictMockSchemaKind>;
|
|
1217
1233
|
}
|
|
1218
1234
|
type ClientMockBuilder = (verbOptions: GeneratorVerbOptions, generatorOptions: GeneratorOptions) => ClientMockGeneratorBuilder;
|
|
1219
1235
|
interface ClientGeneratorsBuilder {
|
|
@@ -1353,6 +1369,7 @@ type ResReqTypesValue = ScalarValue & {
|
|
|
1353
1369
|
interface FinalizeMockImplementationOptions {
|
|
1354
1370
|
mockOptions?: Pick<MockOptions, 'required' | 'nonNullable'>;
|
|
1355
1371
|
strictSchemaTypeNames?: readonly string[];
|
|
1372
|
+
strictMockSchemaKinds?: Readonly<Record<string, StrictMockSchemaKind>>;
|
|
1356
1373
|
}
|
|
1357
1374
|
interface WriteSpecBuilder {
|
|
1358
1375
|
operations: GeneratorOperations;
|
|
@@ -2863,5 +2880,5 @@ declare function generateTargetForTags(builder: WriteSpecBuilder, options: Norma
|
|
|
2863
2880
|
declare function getOrvalGeneratedTypes(): string;
|
|
2864
2881
|
declare function getTypedResponse(): string;
|
|
2865
2882
|
//#endregion
|
|
2866
|
-
export { AngularHttpResourceOptions, AngularOptions, BODY_TYPE_NAME, BaseUrlFromConstant, BaseUrlFromSpec, BaseUrlRuntime, BoundAliasInfo, ClientBuilder, ClientDependenciesBuilder, ClientExtraFilesBuilder, ClientFileBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMockBuilder, ClientMockGeneratorBuilder, ClientMockGeneratorImplementation, ClientTitleBuilder, CommonMockOptions, Config, ConfigExternal, ConfigFn, ContentTypeFilter, ContextSpec, DeepNonNullable, DefaultTag, DynamicScopeEntry, EffectOptions, EnumGeneration, ErrorWithTag, FactoryMethodsMode, FactoryMethodsOptions, FakerMockOptions, FetchOptions, FinalizeMockImplementationOptions, FormDataArrayHandling, FormDataContext, FormDataType, GenerateMockImports, GenerateVerbOptionsParams, GenerateVerbsOptionsParams, GeneratorApiBuilder, GeneratorApiOperations, GeneratorApiResponse, GeneratorClient, GeneratorClientExtra, GeneratorClientFooter, GeneratorClientHeader, GeneratorClientImports, GeneratorClientTitle, GeneratorClients, GeneratorDependency, GeneratorImport, GeneratorMockOutput, GeneratorMockOutputFull, GeneratorMutator, GeneratorMutatorParsingInfo, GeneratorOperation, GeneratorOperations, GeneratorOptions, GeneratorSchema, GeneratorTarget, GeneratorTargetFull, GeneratorVerbOptions, GeneratorVerbsOptions, GetterBody, GetterParam, GetterParameters, GetterParams, GetterProp, GetterPropType, GetterProps, GetterQueryParam, GetterResponse, GlobalMockOptions, GlobalOptions, HonoHandlerStrategy, 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, MswMockOptions, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NAMED_COMPONENT_SECTIONS, NamingConvention, NormalizedAngularOptions, NormalizedConfig, NormalizedEffectOptions, NormalizedFactoryMethodsOptions, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMcpOptions, NormalizedMcpServerOptions, NormalizedMocksConfig, NormalizedMutator, NormalizedOperationOptions, NormalizedOptions, NormalizedOutputOptions, NormalizedOverrideOutput, NormalizedParamsSerializerOptions, NormalizedQueryOptions, NormalizedSchemaOptions, NormalizedZodOptions, OpenApiComponentsObject, OpenApiDocument, OpenApiDynamicReferenceObject, 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, OutputMocksConfig, OutputMocksOption, OutputMode, OutputOptions, OverrideInput, OverrideMockOptions, OverrideOutput, OverrideOutputContentType, PackageJson, ParamsSerializerOptions, PreferredContentType, PropertySortOrder, QueryOptions, ReadonlyRequestBodiesMode, RefComponentSuffix, RefInfo, ResReqTypesValue, ResolverValue, ResponseTypeCategory, ScalarValue, SchemaGenerationType, SchemaOptionLike, 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, buildDynamicScope, camel, collectReferencedComponents, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dedupeUnionType, dynamicAnchorToParamName, dynamicAnchorsToUniqueParamNames, dynamicImport, escape, escapeRegExp, extractBoundAliasInfo, filterByContentType, filteredVerbs, fixCrossDirectoryImports, fixRegularSchemaImports, generalJSTypes, generalJSTypesWithArray, generateAxiosOptions, generateBodyMutatorConfig, generateBodyOptions, generateComponentDefinition, generateDependencyImports, generateFactory, 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, getDynamicAnchorName, 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, getSchemasImportPath, getSuccessResponseType, getTypedResponse, getWarningCount, isBinaryContentType, isBinaryScalarSchema, isBoolean, isComponentRef, isDirectory, isDynamicReference, isFakerMock, isFunction, isModule, isMswMock, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, isVerbose, jsDoc, jsStringEscape, jsStringLiteralEscape, kebab, keyValuePairsToJsDoc, log, logError, logVerbose, logWarning, makeRouteSafe, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resetWarnings, resolveDiscriminators, resolveDynamicRef, resolveExampleRefs, resolveInstalledVersion, resolveInstalledVersions, resolveObject, resolveRef, resolveValue, sanitize, setVerbose, snake, sortByPriority, splitSchemasByType, startMessage, stringify, toObjectString, path_d_exports as upath, upper, wrapRouteParameters, writeGeneratedFile, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
|
|
2883
|
+
export { AngularHttpResourceOptions, AngularOptions, BODY_TYPE_NAME, BaseUrlFromConstant, BaseUrlFromSpec, BaseUrlRuntime, BoundAliasInfo, ClientBuilder, ClientDependenciesBuilder, ClientExtraFilesBuilder, ClientFileBuilder, ClientFooterBuilder, ClientGeneratorsBuilder, ClientHeaderBuilder, ClientMockBuilder, ClientMockGeneratorBuilder, ClientMockGeneratorImplementation, ClientTitleBuilder, CommonMockOptions, Config, ConfigExternal, ConfigFn, ContentTypeFilter, ContextSpec, DeepNonNullable, DefaultTag, DynamicScopeEntry, EffectOptions, EnumGeneration, ErrorWithTag, FactoryMethodsMode, FactoryMethodsOptions, FakerMockOptions, FetchOptions, FinalizeMockImplementationOptions, FormDataArrayHandling, FormDataContext, FormDataType, GenerateMockImports, GenerateVerbOptionsParams, GenerateVerbsOptionsParams, GeneratorApiBuilder, GeneratorApiOperations, GeneratorApiResponse, GeneratorClient, GeneratorClientExtra, GeneratorClientFooter, GeneratorClientHeader, GeneratorClientImports, GeneratorClientTitle, GeneratorClients, GeneratorDependency, GeneratorImport, GeneratorMockOutput, GeneratorMockOutputFull, GeneratorMutator, GeneratorMutatorParsingInfo, GeneratorOperation, GeneratorOperations, GeneratorOptions, GeneratorSchema, GeneratorTarget, GeneratorTargetFull, GeneratorVerbOptions, GeneratorVerbsOptions, GetterBody, GetterParam, GetterParameters, GetterParams, GetterProp, GetterPropType, GetterProps, GetterQueryParam, GetterResponse, GlobalMockOptions, GlobalOptions, HonoHandlerStrategy, 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, MswMockOptions, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NAMED_COMPONENT_SECTIONS, NamingConvention, NormalizedAngularOptions, NormalizedConfig, NormalizedEffectOptions, NormalizedFactoryMethodsOptions, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMcpOptions, NormalizedMcpServerOptions, NormalizedMocksConfig, NormalizedMutator, NormalizedOperationOptions, NormalizedOptions, NormalizedOutputOptions, NormalizedOverrideOutput, NormalizedParamsSerializerOptions, NormalizedQueryOptions, NormalizedSchemaOptions, NormalizedZodOptions, OpenApiComponentsObject, OpenApiDocument, OpenApiDynamicReferenceObject, 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, OutputMocksConfig, OutputMocksOption, OutputMode, OutputOptions, OverrideInput, OverrideMockOptions, OverrideOutput, OverrideOutputContentType, PackageJson, ParamsSerializerOptions, PreferredContentType, PropertySortOrder, QueryOptions, ReadonlyRequestBodiesMode, RefComponentSuffix, RefInfo, ResReqTypesValue, ResolverValue, ResponseTypeCategory, ScalarValue, SchemaGenerationType, SchemaOptionLike, SchemaOptions, SchemaType, StrictMockSchemaKind, SupportedFormatter, SwrOptions, TEMPLATE_TAG_REGEX, TsConfigModule, TsConfigModuleResolution, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecBuilder, ZodCoerceType, ZodDateTimeOptions, ZodOptions, ZodTimeOptions, addDependency, asyncReduce, buildAngularParamsFilterExpression, buildDynamicScope, camel, collectReferencedComponents, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dedupeUnionType, dynamicAnchorToParamName, dynamicAnchorsToUniqueParamNames, dynamicImport, escape, escapeRegExp, extractBoundAliasInfo, filterByContentType, filteredVerbs, fixCrossDirectoryImports, fixRegularSchemaImports, generalJSTypes, generalJSTypesWithArray, generateAxiosOptions, generateBodyMutatorConfig, generateBodyOptions, generateComponentDefinition, generateDependencyImports, generateFactory, 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, getDynamicAnchorName, 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, getSchemasImportPath, getSuccessResponseType, getTypedResponse, getWarningCount, isBinaryContentType, isBinaryScalarSchema, isBoolean, isComponentRef, isDirectory, isDynamicReference, isFakerMock, isFunction, isModule, isMswMock, isNullish, isNumber, isNumeric, isObject, isReference, isSchema, isString, isStringLike, isSyntheticDefaultImportsAllow, isUrl, isVerb, isVerbose, jsDoc, jsStringEscape, jsStringLiteralEscape, kebab, keyValuePairsToJsDoc, log, logError, logVerbose, logWarning, makeRouteSafe, mergeDeep, mismatchArgsMessage, pascal, removeFilesAndEmptyFolders, resetWarnings, resolveDiscriminators, resolveDynamicRef, resolveExampleRefs, resolveInstalledVersion, resolveInstalledVersions, resolveObject, resolveRef, resolveValue, sanitize, setVerbose, snake, sortByPriority, splitSchemasByType, startMessage, stringify, toObjectString, path_d_exports as upath, upper, wrapRouteParameters, writeGeneratedFile, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
|
|
2867
2884
|
//# sourceMappingURL=index.d.mts.map
|