Don't remove null type from enums if default is present.

luhn · luhn · commit 1e6f967524dc · 2025-02-06T22:41:55.000-08:00
diff --git a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts
@@ -32229,7 +32229,7 @@ export type components = {
              * @default RIGHT
              * @enum {string|null}
              */
-            readonly start_side: "LEFT" | "RIGHT";
+            readonly start_side: "LEFT" | "RIGHT" | null;
             /**
              * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
              * @example 2
@@ -33004,7 +33004,7 @@ export type components = {
              * @default RIGHT
              * @enum {string|null}
              */
-            readonly start_side: "LEFT" | "RIGHT";
+            readonly start_side: "LEFT" | "RIGHT" | null;
             /**
              * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
              * @example 2
diff --git a/packages/openapi-typescript/examples/github-api-immutable.ts b/packages/openapi-typescript/examples/github-api-immutable.ts
@@ -32229,7 +32229,7 @@ export interface components {
              * @default RIGHT
              * @enum {string|null}
              */
-            readonly start_side: "LEFT" | "RIGHT";
+            readonly start_side: "LEFT" | "RIGHT" | null;
             /**
              * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
              * @example 2
@@ -33004,7 +33004,7 @@ export interface components {
              * @default RIGHT
              * @enum {string|null}
              */
-            readonly start_side: "LEFT" | "RIGHT";
+            readonly start_side: "LEFT" | "RIGHT" | null;
             /**
              * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
              * @example 2
diff --git a/packages/openapi-typescript/examples/github-api-required.ts b/packages/openapi-typescript/examples/github-api-required.ts
@@ -32229,7 +32229,7 @@ export interface components {
              * @default RIGHT
              * @enum {string|null}
              */
-            start_side: "LEFT" | "RIGHT";
+            start_side: "LEFT" | "RIGHT" | null;
             /**
              * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
              * @example 2
@@ -33004,7 +33004,7 @@ export interface components {
              * @default RIGHT
              * @enum {string|null}
              */
-            start_side: "LEFT" | "RIGHT";
+            start_side: "LEFT" | "RIGHT" | null;
             /**
              * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
              * @example 2
diff --git a/packages/openapi-typescript/examples/github-api-root-types.ts b/packages/openapi-typescript/examples/github-api-root-types.ts
@@ -32229,7 +32229,7 @@ export interface components {
              * @default RIGHT
              * @enum {string|null}
              */
-            start_side: "LEFT" | "RIGHT";
+            start_side: "LEFT" | "RIGHT" | null;
             /**
              * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
              * @example 2
@@ -33004,7 +33004,7 @@ export interface components {
              * @default RIGHT
              * @enum {string|null}
              */
-            start_side: "LEFT" | "RIGHT";
+            start_side: "LEFT" | "RIGHT" | null;
             /**
              * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
              * @example 2
diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts
@@ -32229,7 +32229,7 @@ export interface components {
              * @default RIGHT
              * @enum {string|null}
              */
-            start_side: "LEFT" | "RIGHT";
+            start_side: "LEFT" | "RIGHT" | null;
             /**
              * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
              * @example 2
@@ -33004,7 +33004,7 @@ export interface components {
              * @default RIGHT
              * @enum {string|null}
              */
-            start_side: "LEFT" | "RIGHT";
+            start_side: "LEFT" | "RIGHT" | null;
             /**
              * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
              * @example 2
diff --git a/packages/openapi-typescript/src/transform/schema-object.ts b/packages/openapi-typescript/src/transform/schema-object.ts
@@ -130,10 +130,7 @@ export function transformSchemaObjectWithComposition(
       return hasNull ? tsUnion([ref, NULL]) : ref;
     }
     const enumType = schemaObject.enum.map(tsLiteral);
-    if (
-      ((Array.isArray(schemaObject.type) && schemaObject.type.includes("null")) || schemaObject.nullable) &&
-      !schemaObject.default
-    ) {
+    if ((Array.isArray(schemaObject.type) && schemaObject.type.includes("null")) || schemaObject.nullable) {
       enumType.push(NULL);
     }
 
diff --git a/packages/openapi-typescript/test/transform/schema-object/string.test.ts b/packages/openapi-typescript/test/transform/schema-object/string.test.ts
@@ -109,7 +109,7 @@ describe("transformSchemaObject > string", () => {
       "default + nullable + enum",
       {
         given: { type: ["string", "null"], enum: ["en", "es", "fr", "de"], default: "en" },
-        want: '"en" | "es" | "fr" | "de"',
+        want: '"en" | "es" | "fr" | "de" | null',
       },
     ],
     [

Original file line number	Diff line number	Diff line change
`@@ -130,10 +130,7 @@ export function transformSchemaObjectWithComposition(`
`130`	`130`	`return hasNull ? tsUnion([ref, NULL]) : ref;`
`131`	`131`	`}`
`132`	`132`	`const enumType = schemaObject.enum.map(tsLiteral);`
`133`		`- if (`
`134`		`- ((Array.isArray(schemaObject.type) && schemaObject.type.includes("null")) \|\| schemaObject.nullable) &&`
`135`		`- !schemaObject.default`
`136`		`- ) {`
	`133`	`+ if ((Array.isArray(schemaObject.type) && schemaObject.type.includes("null")) \|\| schemaObject.nullable) {`
`137`	`134`	`enumType.push(NULL);`
`138`	`135`	`}`
`139`	`136`
Original file line number	Diff line number	Diff line change
`@@ -109,7 +109,7 @@ describe("transformSchemaObject > string", () => {`
`109`	`109`	`"default + nullable + enum",`
`110`	`110`	`{`
`111`	`111`	`given: { type: ["string", "null"], enum: ["en", "es", "fr", "de"], default: "en" },`
`112`		`- want: '"en" \| "es" \| "fr" \| "de"',`
	`112`	`+ want: '"en" \| "es" \| "fr" \| "de" \| null',`
`113`	`113`	`},`
`114`	`114`	`],`
`115`	`115`	`[`