@orval/core 8.5.1 → 8.5.3

package/dist/index.d.mts

@@ -8,7 +8,7 @@ import { TypeDocOptions } from "typedoc";
 //#region src/types.d.ts
 interface Options {
   output?: string | OutputOptions;
-  input?: string | InputOptions;
+  input?: string | string[] | InputOptions;
   hooks?: Partial<HooksOptions>;
 }
 type OptionsFn = () => Options | Promise<Options>;
@@ -222,7 +222,7 @@ type InputFiltersOptions = {
   schemas?: (string | RegExp)[];
 };
 type InputOptions = {
-  target: string | Record<string, unknown> | OpenApiDocument;
+  target: string | string[] | Record<string, unknown> | OpenApiDocument;
   override?: OverrideInput;
   filters?: InputFiltersOptions;
   parserOptions?: {
@@ -654,7 +654,7 @@ interface GlobalOptions {
   mode?: OutputMode;
   tsconfig?: string | Tsconfig;
   packageJson?: string;
-  input?: string;
+  input?: string | string[];
   output?: string;
   verbose?: boolean;
 }
@@ -1031,10 +1031,7 @@ type GeneratorClientFooter = (data: {
 type GeneratorClientImports = (data: {
   client: OutputClient | OutputClientFunc;
   implementation: string;
-  imports: {
-    exports: GeneratorImport[];
-    dependency: string;
-  }[];
+  imports: readonly GeneratorDependency[];
   projectName?: string;
   hasSchemaDir: boolean;
   isAllowSyntheticDefaultImports: boolean;
@@ -1046,10 +1043,7 @@ type GeneratorClientImports = (data: {
 }) => string;
 type GenerateMockImports = (data: {
   implementation: string;
-  imports: {
-    exports: GeneratorImport[];
-    dependency: string;
-  }[];
+  imports: readonly GeneratorDependency[];
   projectName?: string;
   hasSchemaDir: boolean;
   isAllowSyntheticDefaultImports: boolean;
@@ -1676,13 +1670,24 @@ declare function resolveObject({
 }: ResolveOptions): ResolverValue;
 //#endregion
 //#region src/resolvers/ref.d.ts
-declare function resolveRef<TSchema extends OpenApiComponentsObject = OpenApiComponentsObject>(schema: OpenApiComponentsObject, context: ContextSpec, imports?: GeneratorImport[]): {
+type Example = OpenApiExampleObject | OpenApiReferenceObject;
+type ResolvedExample = unknown;
+type Examples = Example[] | Record<string, Example> | ResolvedExample[] | Record<string, ResolvedExample> | undefined;
+/**
+ * Recursively resolves a `$ref` in an OpenAPI document, following
+ * nested schema refs and collecting imports along the way.
+ *
+ * Handles OpenAPI 3.0 `nullable` and 3.1 type-array hints on direct refs.
+ *
+ * @see https://spec.openapis.org/oas/v3.0.3#reference-object
+ * @see https://spec.openapis.org/oas/v3.1.0#reference-object
+ */
+declare function resolveRef<TSchema extends object = OpenApiComponentsObject>(schema: OpenApiComponentsObject | OpenApiReferenceObject, context: ContextSpec, imports?: GeneratorImport[]): {
   schema: TSchema;
   imports: GeneratorImport[];
 };
-type Example = OpenApiExampleObject | OpenApiReferenceObject;
-type Examples = Example[] | Record<string, Example> | undefined;
-declare function resolveExampleRefs(examples: Examples, context: ContextSpec): Examples;
+/** Recursively resolves `$ref` entries in an examples array or record. */
+declare function resolveExampleRefs(examples: Examples, context: ContextSpec): ResolvedExample[] | Record<string, ResolvedExample> | undefined;
 //#endregion
 //#region src/resolvers/value.d.ts
 interface ResolveValueOptions {
@@ -1897,9 +1902,10 @@ declare function mergeDeep<T extends Record<string, unknown>, U extends Record<s
 //#region src/utils/occurrence.d.ts
 declare function count(str: string | undefined, key: string): number;
 declare namespace path_d_exports {
-  export { basename, dirname, extname, getSchemaFileName, isAbsolute, join, joinSafe, normalizeSafe, relativeSafe, resolve, separator$1 as separator };
+  export { getRelativeImportPath, getSchemaFileName, join, joinSafe, normalizeSafe, relativeSafe, separator$1 as separator, toUnix };
 }
-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;
+declare function toUnix(value: string): string;
+declare function join(...args: string[]): string;
 /**
  * Behaves exactly like `path.relative(from, to)`, but keeps the first meaningful "./"
  */
@@ -1908,6 +1914,29 @@ declare function getSchemaFileName(path: string): string;
 declare const separator$1 = "/";
 declare function normalizeSafe(value: string): string;
 declare function joinSafe(...values: string[]): string;
+/**
+ * Given two absolute file paths, generates a valid ESM relative import path
+ * from the 'importer' file to the 'exporter' file.
+ *
+ * @example
+ * ```ts
+ * getRelativeImportPath('/path/to/importer.ts', '/path/to/exporter.ts')
+ * // => './exporter'
+ * getRelativeImportPath('/path/to/importer.ts', '/path/to/sub/exporter.ts')
+ * // => './sub/exporter'
+ * getRelativeImportPath('/path/to/importer.ts', '/path/sibling/exporter.ts')
+ * // => '../sibling/exporter'
+ * ```
+ *
+ * This function handles path normalization, cross-platform separators, and
+ * ensures the path is a valid ESM relative specifier (e.g., starts with './').
+ *
+ * @param importerFilePath - The absolute path of the file that will contain the import statement.
+ * @param exporterFilePath - The absolute path of the file being imported.
+ * @param [includeFileExtension=false] - Whether the import path should include the file extension, defaults to false.
+ * @returns The relative import path string.
+ */
+declare function getRelativeImportPath(importerFilePath: string, exporterFilePath: string, includeFileExtension?: boolean): string;
 //#endregion
 //#region src/utils/resolve-version.d.ts
 declare function resolveInstalledVersion(packageName: string, fromDir: string): string | undefined;
@@ -1989,14 +2018,16 @@ declare function toObjectString<T>(props: T[], path?: keyof T): string;
  */
 declare function getNumberWord(num: number): string;
 /**
- * Escapes a specific character in a string by prefixing it with a backslash.
+ * Escapes a specific character in a string by prefixing all of its occurrences with a backslash.
  *
  * @param str - The string to escape, or null.
  * @param char - The character to escape. Defaults to single quote (').
  * @returns The escaped string, or null if the input is null.
  * @example
  * escape("don't") // returns "don\'t"
+ * escape("it's John's") // returns "it\'s John\'s"
  * escape('say "hello"', '"') // returns 'say \\"hello\\"'
+ * escape("a'''b", "'") // returns "a\'\'\'b"
  */
 declare function escape(str: string | null, char?: string): string | undefined;
 /**