Skip to content

fix(transform): avoid duplicate enum declaration when using root types with no prefix #2351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,9 @@ export default function transformComponentsObject(componentsObject: ComponentsOb
}
const ref = ts.factory.createTypeReferenceNode(`components['${key}']['${name}']`);
if (ctx.rootTypesNoSchemaPrefix && key === "schemas") {
if (ctx.enum && item.enum) {
continue;
}
aliasName = aliasName.replace(componentKey, "");
}
const typeAlias = ts.factory.createTypeAliasDeclaration(
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
import { fileURLToPath } from "node:url";
import { transformSchema } from "../../../src/index.js";
import { astToString } from "../../../src/lib/ts.js";
import type { GlobalContext } from "../../../src/types.js";
import { DEFAULT_CTX, type TestCase } from "../../test-helpers.js";

const DEFAULT_OPTIONS = DEFAULT_CTX;

describe("transformComponentsObject", () => {
const tests: TestCase<any, GlobalContext>[] = [
[
"options > rootTypes: true and rootTypesNoSchemaPrefix: true",
{
given: {
openapi: "3.0.0",
info: {
title: "Status API",
version: "1.0.0",
},
paths: {
"/status": {
get: {
summary: "Get current status",
responses: {
"200": {
description: "Status response",
content: {
"application/json": {
schema: {
$ref: "#/components/schemas/StatusResponse",
},
},
},
},
},
},
},
},
components: {
schemas: {
StatusResponse: {
type: "object",
properties: {
status: {
$ref: "#/components/schemas/Status",
},
},
},
Status: {
type: "string",
enum: ["pending", "active", "done"],
},
},
},
},
want: `export interface paths {
"/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get current status */
get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Status response */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["StatusResponse"];
};
};
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
StatusResponse: {
status?: components["schemas"]["Status"];
};
/** @enum {string} */
Status: Status;
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type StatusResponse = components['schemas']['StatusResponse'];
export type $defs = Record<string, never>;
export enum Status {
pending = "pending",
active = "active",
done = "done"
}
export type operations = Record<string, never>;`,
options: { ...DEFAULT_OPTIONS, enum: true, rootTypes: true, rootTypesNoSchemaPrefix: true },
},
],
];

for (const [testName, { given, want, options, ci }] of tests) {
test.skipIf(ci?.skipIf)(
testName,
async () => {
const result = astToString(transformSchema(given, options ?? DEFAULT_OPTIONS));
if (want instanceof URL) {
await expect(result).toMatchFileSnapshot(fileURLToPath(want));
} else {
expect(result.trim()).toBe(want.trim());
}
},
ci?.timeout,
);
}
});