Skip to content

Strip null from FlattenedDeepRequired for enum-values to prevent type error #2737

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.

Sign up for GitHub

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
vesan wants to merge 1 commit into
base: main
Choose a base branch
from
+64 −8
Open

Strip null from FlattenedDeepRequired for enum-values to prevent type error #2737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion packages/openapi-typescript/src/lib/ts.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ export function tsArrayLiteralExpression(
)
) {
const helper = stringToAST(
"type FlattenedDeepRequired<T> = { [K in keyof T]-?: FlattenedDeepRequired<T[K] extends unknown[] | undefined | null ? Extract<T[K], unknown[]>[number] : T[K]>; };",
"type FlattenedDeepRequired<T> = { [K in keyof T]-?: FlattenedDeepRequired<NonNullable<T[K]> extends unknown[] ? Extract<NonNullable<T[K]>, unknown[]>[number] : NonNullable<T[K]>>; };",
)[0] as any;
options.injectFooter.push(helper);
}
Expand Down
70 changes: 63 additions & 7 deletions packages/openapi-typescript/test/node-api.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -991,7 +991,7 @@ export interface components {
}
export type $defs = Record<string, never>;
type FlattenedDeepRequired<T> = {
[K in keyof T]-?: FlattenedDeepRequired<T[K] extends unknown[] | undefined | null ? Extract<T[K], unknown[]>[number] : T[K]>;
[K in keyof T]-?: FlattenedDeepRequired<NonNullable<T[K]> extends unknown[] ? Extract<NonNullable<T[K]>, unknown[]>[number] : NonNullable<T[K]>>;
};
type ReadonlyArray<T> = [
Exclude<T, undefined>
Expand Down Expand Up @@ -1046,7 +1046,7 @@ export interface components {
}
export type $defs = Record<string, never>;
type FlattenedDeepRequired<T> = {
[K in keyof T]-?: FlattenedDeepRequired<T[K] extends unknown[] | undefined | null ? Extract<T[K], unknown[]>[number] : T[K]>;
[K in keyof T]-?: FlattenedDeepRequired<NonNullable<T[K]> extends unknown[] ? Extract<NonNullable<T[K]>, unknown[]>[number] : NonNullable<T[K]>>;
};
type ReadonlyArray<T> = [
Exclude<T, undefined>
Expand Down Expand Up @@ -1225,7 +1225,7 @@ export interface operations {
};
}
type FlattenedDeepRequired<T> = {
[K in keyof T]-?: FlattenedDeepRequired<T[K] extends unknown[] | undefined | null ? Extract<T[K], unknown[]>[number] : T[K]>;
[K in keyof T]-?: FlattenedDeepRequired<NonNullable<T[K]> extends unknown[] ? Extract<NonNullable<T[K]>, unknown[]>[number] : NonNullable<T[K]>>;
};
type ReadonlyArray<T> = [
Exclude<T, undefined>
Expand Down Expand Up @@ -1457,7 +1457,7 @@ export interface components {
}
export type $defs = Record<string, never>;
type FlattenedDeepRequired<T> = {
[K in keyof T]-?: FlattenedDeepRequired<T[K] extends unknown[] | undefined | null ? Extract<T[K], unknown[]>[number] : T[K]>;
[K in keyof T]-?: FlattenedDeepRequired<NonNullable<T[K]> extends unknown[] ? Extract<NonNullable<T[K]>, unknown[]>[number] : NonNullable<T[K]>>;
};
type ReadonlyArray<T> = [
Exclude<T, undefined>
Expand Down Expand Up @@ -1552,7 +1552,7 @@ export interface components {
}
export type $defs = Record<string, never>;
type FlattenedDeepRequired<T> = {
[K in keyof T]-?: FlattenedDeepRequired<T[K] extends unknown[] | undefined | null ? Extract<T[K], unknown[]>[number] : T[K]>;
[K in keyof T]-?: FlattenedDeepRequired<NonNullable<T[K]> extends unknown[] ? Extract<NonNullable<T[K]>, unknown[]>[number] : NonNullable<T[K]>>;
};
type ReadonlyArray<T> = [
Exclude<T, undefined>
Expand Down Expand Up @@ -1653,7 +1653,7 @@ export interface components {
}
export type $defs = Record<string, never>;
type FlattenedDeepRequired<T> = {
[K in keyof T]-?: FlattenedDeepRequired<T[K] extends unknown[] | undefined | null ? Extract<T[K], unknown[]>[number] : T[K]>;
[K in keyof T]-?: FlattenedDeepRequired<NonNullable<T[K]> extends unknown[] ? Extract<NonNullable<T[K]>, unknown[]>[number] : NonNullable<T[K]>>;
};
type ReadonlyArray<T> = [
Exclude<T, undefined>
Expand Down Expand Up @@ -1769,7 +1769,7 @@ export interface components {
}
export type $defs = Record<string, never>;
type FlattenedDeepRequired<T> = {
[K in keyof T]-?: FlattenedDeepRequired<T[K] extends unknown[] | undefined | null ? Extract<T[K], unknown[]>[number] : T[K]>;
[K in keyof T]-?: FlattenedDeepRequired<NonNullable<T[K]> extends unknown[] ? Extract<NonNullable<T[K]>, unknown[]>[number] : NonNullable<T[K]>>;
};
type ReadonlyArray<T> = [
Exclude<T, undefined>
Expand Down Expand Up @@ -1799,6 +1799,62 @@ export const resourceOuterOneOf0InnerOneOf1DeepCodeValues: ReadonlyArray<Extract
export const resourceOuterOneOf1KindValues: ReadonlyArray<Extract<FlattenedDeepRequired<components>["schemas"]["Resource"]["outer"], {
kind: unknown;
}>["kind"]> = ["typeB"];
export type operations = Record<string, never>;`,
options: { enumValues: true },
},
],
[
"options > enumValues with nullable intermediate object",
{
given: {
openapi: "3.1",
info: { title: "Test", version: "1.0" },
components: {
schemas: {
Submission: {
type: "object",
properties: {
details: {
type: ["object", "null"],
properties: {
status: {
type: "string",
enum: ["draft", "submitted"],
},
},
},
},
},
},
},
},
want: `export type paths = Record<string, never>;
export type webhooks = Record<string, never>;
export interface components {
schemas: {
Submission: {
details?: {
/** @enum {string} */
status?: "draft" | "submitted";
} | null;
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
type FlattenedDeepRequired<T> = {
[K in keyof T]-?: FlattenedDeepRequired<NonNullable<T[K]> extends unknown[] ? Extract<NonNullable<T[K]>, unknown[]>[number] : NonNullable<T[K]>>;
};
type ReadonlyArray<T> = [
Exclude<T, undefined>
] extends [
unknown[]
] ? Readonly<Exclude<T, undefined>> : Readonly<Exclude<T, undefined>[]>;
export const submissionDetailsStatusValues: ReadonlyArray<FlattenedDeepRequired<components>["schemas"]["Submission"]["details"]["status"]> = ["draft", "submitted"];
export type operations = Record<string, never>;`,
options: { enumValues: true },
},
Expand Down
Loading