@orval/core 8.0.3 → 8.2.0

package/dist/index.d.mts

@@ -99,6 +99,11 @@ type NormalizedOverrideOutput = {
   suppressReadonlyModifier?: boolean;
   jsDoc: NormalizedJsDocOptions;
   aliasCombinedTypes: boolean;
+  /**
+   * When enabled, optional properties will be typed as `T | null` instead of just `T`.
+   * @default false
+   */
+  useNullForOptional?: boolean;
 };
 type NormalizedMutator = {
   path: string;
@@ -386,6 +391,11 @@ type OverrideOutput = {
   suppressReadonlyModifier?: boolean;
   jsDoc?: JsDocOptions;
   aliasCombinedTypes?: boolean;
+  /**
+   * When enabled, optional properties will be typed as `T | null` instead of just `T`.
+   * @default false
+   */
+  useNullForOptional?: boolean;
 };
 type JsDocOptions = {
   filter?: (schema: Record<string, any>) => {
@@ -654,6 +664,8 @@ interface PackageJson {
   dependencies?: Record<string, string>;
   devDependencies?: Record<string, string>;
   peerDependencies?: Record<string, string>;
+  catalog?: Record<string, string>;
+  catalogs?: Record<string, Record<string, string>>;
 }
 type GeneratorSchema = {
   name: string;
@@ -924,6 +936,7 @@ declare const SchemaType: {
 };
 type ScalarValue = {
   value: string;
+  useTypeAlias?: boolean;
   isEnum: boolean;
   hasReadonlyProps: boolean;
   type: SchemaType;
@@ -1301,11 +1314,61 @@ declare function generateVerbsOptions({
 }: GenerateVerbsOptionsParams): Promise<GeneratorVerbsOptions>;
 declare function _filteredVerbs(verbs: OpenApiPathItemObject, filters: NormalizedInputOptions['filters']): [string, any][];
 //#endregion
+//#region src/getters/object.d.ts
+/**
+ * Context for multipart/form-data type generation.
+ * Discriminated union with two states:
+ *
+ * 1. `{ atPart: false, encoding }` - At form-data root, before property iteration
+ *    - May traverse through allOf/anyOf/oneOf to reach properties
+ *    - Carries encoding map so getObject can look up `encoding[key]`
+ *
+ * 2. `{ atPart: true, partContentType }` - At a multipart part (top-level property)
+ *    - `partContentType` = Encoding Object's `contentType` for this part
+ *    - Used by getScalar for file type detection (precedence over contentMediaType)
+ *    - Arrays pass this through to items; combiners inside arrays also get context
+ *
+ * `undefined` means not in form-data context (or nested inside plain object field = JSON)
+ */
+type FormDataContext = {
+  atPart: false;
+  encoding: Record<string, {
+    contentType?: string;
+  }>;
+} | {
+  atPart: true;
+  partContentType?: string;
+};
+interface GetObjectOptions {
+  item: OpenApiSchemaObject;
+  name?: string;
+  context: ContextSpec;
+  nullable: string;
+  /**
+   * Multipart/form-data context for file type handling.
+   * @see FormDataContext
+   */
+  formDataContext?: FormDataContext;
+}
+/**
+ * Return the output type from an object
+ *
+ * @param item item with type === "object"
+ */
+declare function getObject({
+  item,
+  name,
+  context,
+  nullable,
+  formDataContext
+}: GetObjectOptions): ScalarValue;
+//#endregion
 //#region src/getters/array.d.ts
 interface GetArrayOptions {
   schema: OpenApiSchemaObject;
   name?: string;
   context: ContextSpec;
+  formDataContext?: FormDataContext;
 }
 /**
  * Return the output type from an array
@@ -1315,7 +1378,8 @@ interface GetArrayOptions {
 declare function getArray({
   schema,
   name,
-  context
+  context,
+  formDataContext
 }: GetArrayOptions): ScalarValue;
 //#endregion
 //#region src/getters/body.d.ts
@@ -1339,13 +1403,15 @@ declare function combineSchemas({
   schema,
   separator,
   context,
-  nullable
+  nullable,
+  formDataContext
 }: {
   name?: string;
   schema: OpenApiSchemaObject;
   separator: Separator;
   context: ContextSpec;
   nullable: string;
+  formDataContext?: FormDataContext;
 }): ScalarValue;
 //#endregion
 //#region src/getters/discriminators.d.ts
@@ -1356,35 +1422,22 @@ declare function getEnumNames(schemaObject: OpenApiSchemaObject | undefined): st
 declare function getEnumDescriptions(schemaObject: OpenApiSchemaObject | undefined): string[] | undefined;
 declare function getEnum(value: string, enumName: string, names: string[] | undefined, enumGenerationType: EnumGeneration, descriptions?: string[], enumNamingConvention?: NamingConvention): string;
 declare function getEnumImplementation(value: string, names?: string[], descriptions?: string[], enumNamingConvention?: NamingConvention): string;
+type CombinedEnumInput = {
+  value: string;
+  isRef: boolean;
+  schema: OpenApiSchemaObject | undefined;
+};
+type CombinedEnumValue = {
+  value: string;
+  valueImports: string[];
+  hasNull: boolean;
+};
+declare function getEnumUnionFromSchema(schema: OpenApiSchemaObject | undefined): any;
+declare function getCombinedEnumValue(inputs: CombinedEnumInput[]): CombinedEnumValue;
 //#endregion
 //#region src/getters/keys.d.ts
 declare function getKey(key: string): string;
 //#endregion
-//#region src/getters/object.d.ts
-interface GetObjectOptions {
-  item: OpenApiSchemaObject;
-  name?: string;
-  context: ContextSpec;
-  nullable: string;
-  /**
-   * Override resolved values for properties at THIS level only.
-   * Not passed to nested schemas. Used by form-data for file type handling.
-   */
-  propertyOverrides?: Record<string, ScalarValue>;
-}
-/**
- * Return the output type from an object
- *
- * @param item item with type === "object"
- */
-declare function getObject({
-  item,
-  name,
-  context,
-  nullable,
-  propertyOverrides
-}: GetObjectOptions): ScalarValue;
-//#endregion
 //#region src/getters/operation.d.ts
 declare function getOperationId(operation: OpenApiOperationObject, route: string, verb: Verbs): string;
 //#endregion
@@ -1480,7 +1533,6 @@ declare function getRefInfo($ref: string, context: ContextSpec): RefInfo;
 //#endregion
 //#region src/getters/res-req-types.d.ts
 declare function getResReqTypes(responsesOrRequests: [string, OpenApiReferenceObject | OpenApiResponseObject | OpenApiRequestBodyObject][], name: string, context: ContextSpec, defaultType?: string, uniqueKey?: (item: ResReqTypesValue, index: number, data: ResReqTypesValue[]) => unknown): ResReqTypesValue[];
-declare function isBinaryContentType(contentType: string): boolean;
 /**
  * Response type categories for HTTP client response parsing.
  * Maps to Angular HttpClient's responseType, Axios responseType, and Fetch response methods.
@@ -1502,16 +1554,6 @@ declare function getResponseTypeCategory(contentType: string): ResponseTypeCateg
  * @returns The default content type to use
  */
 declare function getDefaultContentType(contentTypes: string[]): string;
-/**
- * Determine if a form-data root field should be treated as binary or text file
- * based on encoding.contentType or contentMediaType.
- *
- * Returns:
- * - 'binary': field is a binary file (Blob in types, File in zod)
- * - 'text': field is a text file that can accept string (Blob | string in types, File | string in zod)
- * - undefined: no override, use standard resolution
- */
-declare function getFormDataFieldFileType(resolvedSchema: OpenApiSchemaObject, encodingContentType: string | undefined): 'binary' | 'text' | undefined;
 //#endregion
 //#region src/getters/response.d.ts
 interface GetResponseOptions {
@@ -1537,6 +1579,7 @@ interface GetScalarOptions {
   item: OpenApiSchemaObject;
   name?: string;
   context: ContextSpec;
+  formDataContext?: FormDataContext;
 }
 /**
  * Return the typescript equivalent of open-api data type
@@ -1547,7 +1590,8 @@ interface GetScalarOptions {
 declare function getScalar({
   item,
   name,
-  context
+  context,
+  formDataContext
 }: GetScalarOptions): ScalarValue;
 //#endregion
 //#region src/resolvers/object.d.ts
@@ -1556,6 +1600,7 @@ interface ResolveOptions {
   propName?: string;
   combined?: boolean;
   context: ContextSpec;
+  formDataContext?: FormDataContext;
 }
 interface CreateTypeAliasOptions {
   resolvedValue: ResolverValue;
@@ -1575,7 +1620,8 @@ declare function resolveObject({
   schema,
   propName,
   combined,
-  context
+  context,
+  formDataContext
 }: ResolveOptions): ResolverValue;
 //#endregion
 //#region src/resolvers/ref.d.ts
@@ -1592,11 +1638,13 @@ interface ResolveValueOptions {
   schema: OpenApiSchemaObject | OpenApiReferenceObject;
   name?: string;
   context: ContextSpec;
+  formDataContext?: FormDataContext;
 }
 declare function resolveValue({
   schema,
   name,
-  context
+  context,
+  formDataContext
 }: ResolveValueOptions): ResolverValue;
 //#endregion
 //#region src/utils/assertion.d.ts
@@ -1631,6 +1679,23 @@ declare function kebab(s: string): string;
 declare function upper(s: string, fillWith: string, isDeapostrophe?: boolean): string;
 declare function conventionName(name: string, convention: NamingConvention): string;
 //#endregion
+//#region src/utils/content-type.d.ts
+/**
+ * Determine if a content type is binary (vs text-based).
+ */
+declare function isBinaryContentType(contentType: string): boolean;
+/**
+ * Determine if a form-data field should be treated as a file (binary or text).
+ *
+ * Precedence (per OAS 3.1): encoding.contentType > schema.contentMediaType
+ *
+ * Returns:
+ * - 'binary': binary file (Blob)
+ * - 'text': text file (Blob | string)
+ * - undefined: not a file, use standard string resolution
+ */
+declare function getFormDataFieldFileType(resolvedSchema: OpenApiSchemaObject, partContentType: string | undefined): 'binary' | 'text' | undefined;
+//#endregion
 //#region src/utils/compare-version.d.ts
 declare function compareVersions(firstVersion: string, secondVersions: string, operator?: CompareOperator): boolean;
 //#endregion
@@ -1860,6 +1925,12 @@ declare function escape(str: string | null, char?: string): string | undefined;
  * @param input String to escape
  */
 declare function jsStringEscape(input: string): string;
+/**
+ * Deduplicates a TypeScript union type string.
+ * Handles types like "A | B | B" → "A | B" and "null | null" → "null".
+ * Only splits on top-level | (not inside {} () [] <> or string literals).
+ */
+declare function dedupeUnionType(unionType: string): string;
 //#endregion
 //#region src/utils/tsconfig.d.ts
 declare function isSyntheticDefaultImportsAllow(config?: Tsconfig): boolean;
@@ -1963,5 +2034,5 @@ declare function generateTargetForTags(builder: WriteSpecBuilder, options: Norma
 declare function getOrvalGeneratedTypes(): string;
 declare function getTypedResponse(): string;
 //#endregion
-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, InvalidateTarget, JsDocOptions, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, MockData, MockDataArray, MockDataArrayFn, MockDataObject, MockDataObjectFn, MockOptions, MockProperties, MockPropertiesObject, MockPropertiesObjectFn, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NamingConvention, NormalizedConfig, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMutator, NormalizedOperationOptions, NormalizedOptions, NormalizedOutputOptions, NormalizedOverrideOutput, NormalizedParamsSerializerOptions, NormalizedQueryOptions, NormalizedSchemaOptions, NormalizedZodOptions, OpenApiComponentsObject, OpenApiDocument, OpenApiEncodingObject, OpenApiExampleObject, OpenApiInfoObject, OpenApiMediaTypeObject, OpenApiOperationObject, OpenApiParameterObject, OpenApiPathItemObject, OpenApiPathsObject, OpenApiReferenceObject, OpenApiRequestBodyObject, OpenApiResponseObject, OpenApiResponsesObject, OpenApiSchemaObject, OpenApiSchemaObjectType, OpenApiSchemasObject, OpenApiServerObject, OperationOptions, Options, OptionsExport, OptionsFn, OutputClient, OutputClientFunc, OutputDocsOptions, OutputHttpClient, OutputMockType, OutputMode, OutputOptions, OverrideInput, OverrideMockOptions, OverrideOutput, OverrideOutputContentType, PackageJson, ParamsSerializerOptions, PropertySortOrder, QueryOptions, RefComponentSuffix, RefInfo, ResReqTypesValue, ResolverValue, ResponseTypeCategory, ScalarValue, SchemaGenerationType, SchemaOptions, SchemaType, SwrOptions, TEMPLATE_TAG_REGEX, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecBuilder, ZodCoerceType, ZodDateTimeOptions, ZodOptions, ZodTimeOptions, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dynamicImport, escape, 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, getArray, getBody, getDefaultContentType, getEnum, getEnumDescriptions, getEnumImplementation, getEnumNames, getExtension, getFileInfo, getFormDataFieldFileType, getFullRoute, getIsBodyVerb, getKey, getMockFileExtensionByTypeName, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getPropertySafe, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getResponseTypeCategory, getRoute, getRouteAsArray, getScalar, getTypedResponse, isBinaryContentType, 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, splitSchemasByType, startMessage, stringify, toObjectString, path_d_exports as upath, upper, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
+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, FormDataContext, FormDataType, GenerateMockImports, GenerateVerbOptionsParams, GenerateVerbsOptionsParams, GeneratorApiBuilder, GeneratorApiOperations, GeneratorApiResponse, GeneratorClient, GeneratorClientExtra, GeneratorClientFooter, GeneratorClientHeader, GeneratorClientImports, GeneratorClientTitle, GeneratorClients, GeneratorDependency, GeneratorImport, GeneratorMutator, GeneratorMutatorParsingInfo, GeneratorOperation, GeneratorOperations, GeneratorOptions, GeneratorSchema, GeneratorTarget, GeneratorTargetFull, GeneratorVerbOptions, GeneratorVerbsOptions, GetterBody, GetterParam, GetterParameters, GetterParams, GetterProp, GetterPropType, GetterProps, GetterQueryParam, GetterResponse, GlobalMockOptions, GlobalOptions, HonoOptions, Hook, HookCommand, HookFunction, HookOption, HooksOptions, ImportOpenApi, InputFiltersOptions, InputOptions, InputTransformerFn, InvalidateTarget, JsDocOptions, LogLevel, LogLevels, LogOptions, LogType, Logger, LoggerOptions, MockData, MockDataArray, MockDataArrayFn, MockDataObject, MockDataObjectFn, MockOptions, MockProperties, MockPropertiesObject, MockPropertiesObjectFn, MutationInvalidatesConfig, MutationInvalidatesRule, Mutator, MutatorObject, NamingConvention, NormalizedConfig, NormalizedFetchOptions, NormalizedFormDataType, NormalizedHonoOptions, NormalizedHookCommand, NormalizedHookOptions, NormalizedInputOptions, NormalizedJsDocOptions, NormalizedMutator, NormalizedOperationOptions, NormalizedOptions, NormalizedOutputOptions, NormalizedOverrideOutput, NormalizedParamsSerializerOptions, NormalizedQueryOptions, NormalizedSchemaOptions, NormalizedZodOptions, OpenApiComponentsObject, OpenApiDocument, OpenApiEncodingObject, OpenApiExampleObject, OpenApiInfoObject, OpenApiMediaTypeObject, OpenApiOperationObject, OpenApiParameterObject, OpenApiPathItemObject, OpenApiPathsObject, OpenApiReferenceObject, OpenApiRequestBodyObject, OpenApiResponseObject, OpenApiResponsesObject, OpenApiSchemaObject, OpenApiSchemaObjectType, OpenApiSchemasObject, OpenApiServerObject, OperationOptions, Options, OptionsExport, OptionsFn, OutputClient, OutputClientFunc, OutputDocsOptions, OutputHttpClient, OutputMockType, OutputMode, OutputOptions, OverrideInput, OverrideMockOptions, OverrideOutput, OverrideOutputContentType, PackageJson, ParamsSerializerOptions, PropertySortOrder, QueryOptions, RefComponentSuffix, RefInfo, ResReqTypesValue, ResolverValue, ResponseTypeCategory, ScalarValue, SchemaGenerationType, SchemaOptions, SchemaType, SwrOptions, TEMPLATE_TAG_REGEX, TsConfigTarget, Tsconfig, URL_REGEX, VERBS_WITH_BODY, Verbs, WriteModeProps, WriteSpecBuilder, ZodCoerceType, ZodDateTimeOptions, ZodOptions, ZodTimeOptions, _filteredVerbs, addDependency, asyncReduce, camel, combineSchemas, compareVersions, conventionName, count, createDebugger, createLogger, createSuccessMessage, createTypeAliasIfNeeded, dedupeUnionType, dynamicImport, escape, 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, getArray, getBody, getCombinedEnumValue, getDefaultContentType, getEnum, getEnumDescriptions, getEnumImplementation, getEnumNames, getEnumUnionFromSchema, getExtension, getFileInfo, getFormDataFieldFileType, getFullRoute, getIsBodyVerb, getKey, getMockFileExtensionByTypeName, getNumberWord, getObject, getOperationId, getOrvalGeneratedTypes, getParameters, getParams, getParamsInPath, getPropertySafe, getProps, getQueryParams, getRefInfo, getResReqTypes, getResponse, getResponseTypeCategory, getRoute, getRouteAsArray, getScalar, getTypedResponse, isBinaryContentType, 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, splitSchemasByType, startMessage, stringify, toObjectString, path_d_exports as upath, upper, writeModelInline, writeModelsInline, writeSchema, writeSchemas, writeSingleMode, writeSplitMode, writeSplitTagsMode, writeTagsMode };
 //# sourceMappingURL=index.d.mts.map