test(core): add regression coverage for cross-file $ref schema exports (#1107) (#3381)

* test(core): add regression coverage for cross-file $ref schema exports (#1107)

* test(core): document cross-file $ref intent in issue-1107 spec

Author: wadakatu

tests/__snapshots__/default/issue-1107-cross-file-ref/endpoints.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.11.0 🍺
+ * Do not edit manually.
+ * Issue 1107 - cross-file $ref type alias exports
+ * OpenAPI spec version: 1.0.0
+ */
+import axios from 'axios';
+import type { AxiosRequestConfig, AxiosResponse } from 'axios';
+
+import type { Pets } from './model';
+
+export const listPets = (
+  options?: AxiosRequestConfig,
+): Promise<AxiosResponse<Pets>> => {
+  return axios.get(`/pets`, options);
+};
+
+export type ListPetsResult = AxiosResponse<Pets>;

tests/__snapshots__/default/issue-1107-cross-file-ref/model/error.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval v8.11.0 🍺
+ * Do not edit manually.
+ * Issue 1107 - cross-file $ref type alias exports
+ * OpenAPI spec version: 1.0.0
+ */
+
+export interface Error {
+  code: number;
+  message: string;
+}

tests/__snapshots__/default/issue-1107-cross-file-ref/model/index.ts

@@ -0,0 +1,10 @@
+/**
+ * Generated by orval v8.11.0 🍺
+ * Do not edit manually.
+ * Issue 1107 - cross-file $ref type alias exports
+ * OpenAPI spec version: 1.0.0
+ */
+
+export * from './error';
+export * from './pet';
+export * from './pets';

tests/__snapshots__/default/issue-1107-cross-file-ref/model/pet.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.11.0 🍺
+ * Do not edit manually.
+ * Issue 1107 - cross-file $ref type alias exports
+ * OpenAPI spec version: 1.0.0
+ */
+
+export interface Pet {
+  id: number;
+  name: string;
+  tag?: string;
+}

tests/__snapshots__/default/issue-1107-cross-file-ref/model/pets.ts

@@ -0,0 +1,9 @@
+/**
+ * Generated by orval v8.11.0 🍺
+ * Do not edit manually.
+ * Issue 1107 - cross-file $ref type alias exports
+ * OpenAPI spec version: 1.0.0
+ */
+import type { Pet } from './pet';
+
+export type Pets = Pet[];

tests/api-generation.spec.ts

@@ -209,3 +209,27 @@ test('vue-query issue-1026 keeps header params out of the query key getter', asy
   expect(content).toContain('headers?: MaybeRef<GetSomeEndpointHeaders>');
   expect(content).toContain('headers = unref(headers);');
 });
+
+test('default issue-1107 emits exports for schemas defined via cross-file $ref', async () => {
+  // Regression for #1107: a top-level `components.schemas.X` that is itself a
+  // cross-file `$ref` (X -> another file's X) used to generate a schema file
+  // with the import but no `export` for X, producing a dangling, unusable
+  // module. Each referenced schema must still be a usable exported type.
+  // Keep this focused assertion alongside the snapshot so #1107 fails with a
+  // targeted message instead of a full-file snapshot diff.
+  const model = (file: string) =>
+    readFile(
+      generated('default', 'issue-1107-cross-file-ref', 'model', file),
+      'utf8',
+    );
+
+  // Object schemas reached through a cross-file `$ref` are exported as types.
+  expect(await model('pet.ts')).toContain('export interface Pet {');
+  expect(await model('error.ts')).toContain('export interface Error {');
+
+  // The array schema both imports its item type and exports its own alias;
+  // the missing `export type` line was the #1107 bug.
+  const pets = await model('pets.ts');
+  expect(pets).toContain("import type { Pet } from './pet';");
+  expect(pets).toContain('export type Pets = Pet[];');
+});

tests/configs/default.config.ts

@@ -681,6 +681,17 @@ export default defineConfig({
       target: '../specifications/issue-398-encoded-path-ref.yaml',
     },
   },
+  'issue-1107-cross-file-ref': {
+    output: {
+      target: '../generated/default/issue-1107-cross-file-ref/endpoints.ts',
+      schemas: '../generated/default/issue-1107-cross-file-ref/model',
+      clean: true,
+      formatter: 'prettier',
+    },
+    input: {
+      target: '../specifications/issue-1107/issue-1107.yaml',
+    },
+  },
   'boolean-discriminator': {
     output: {
       target: '../generated/default/boolean-discriminator/endpoints.ts',

tests/specifications/issue-1107/issue-1107-petstore.yaml

@@ -0,0 +1,35 @@
+openapi: 3.0.0
+info:
+  title: Issue 1107 - external petstore
+  version: 1.0.0
+paths: {}
+components:
+  schemas:
+    Pet:
+      type: object
+      required:
+        - id
+        - name
+      properties:
+        id:
+          type: integer
+          format: int64
+        name:
+          type: string
+        tag:
+          type: string
+    Pets:
+      type: array
+      items:
+        $ref: '#/components/schemas/Pet'
+    Error:
+      type: object
+      required:
+        - code
+        - message
+      properties:
+        code:
+          type: integer
+          format: int32
+        message:
+          type: string

tests/specifications/issue-1107/issue-1107.yaml

@@ -0,0 +1,33 @@
+openapi: 3.0.0
+info:
+  title: Issue 1107 - cross-file $ref type alias exports
+  version: 1.0.0
+paths:
+  /pets:
+    get:
+      operationId: listPets
+      responses:
+        '200':
+          description: A list of pets
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pets'
+        default:
+          description: unexpected error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+components:
+  # Regression for #1107: every top-level schema here is itself a cross-file
+  # `$ref`. `Pet` is intentionally not referenced by any path — it is reached
+  # only transitively (`Pets` resolves to `Pet[]` in the external file), which
+  # exercises emitting an export for a referenced-but-not-path-used schema.
+  schemas:
+    Pet:
+      $ref: './issue-1107-petstore.yaml#/components/schemas/Pet'
+    Pets:
+      $ref: './issue-1107-petstore.yaml#/components/schemas/Pets'
+    Error:
+      $ref: './issue-1107-petstore.yaml#/components/schemas/Error'