fix: typescript export not handling NotRequired and regression with handling of additional_properties (#4318)

* chore: handle additional properties causing schema == None

* fix: make properties optional when no required fields specified

When schema.required is None or empty, properties should default to optional
rather than required. This fixes NotRequired TypedDict fields not being
converted to optional TypeScript properties with '?'.

* chore: updated test

(cherry picked from commit a43525b)

Author: Goldziher

litestar/_openapi/typescript_converter/schema_parsing.py

@@ -94,7 +94,7 @@ def create_interface(
         TypeScriptProperty(
             key=normalize_typescript_namespace(key, allow_quoted=True),
             value=parse_schema(schema),
-            required=key in required if required is not None else True,
+            required=key in required if required is not None else False,
         )
         for key, schema in properties.items()
     )
@@ -124,6 +124,10 @@ def parse_type_schema(schema: Schema) -> TypeScriptPrimitive | TypeScriptLiteral
         )
     if schema.type in openapi_to_typescript_type_map and isinstance(schema.type, OpenAPIType):
         return TypeScriptPrimitive(openapi_to_typescript_type_map[schema.type])
+    if schema.type is None:
+        # Handle schemas with no type specified (e.g., additional_properties that can contain any value)
+        # According to OpenAPI spec, a schema without a type can contain any JSON value
+        return TypeScriptPrimitive("any")
     raise TypeError(f"received an unexpected openapi type: {schema.type}")  # pragma: no cover
 
 

tests/unit/test_openapi/test_typescript_converter/test_converter.py

@@ -69,17 +69,17 @@ def test_openapi_to_typescript_converter(person_controller: Type[Controller], pe
 
 	export namespace Http201 {
 	export type ResponseBody = {
-	complex: {
+	complex?: {
 	
 };
-	first_name: string;
-	id: string;
-	last_name: string;
-	optional: null | string;
-	pets: null | {
-	age: number;
-	name: string;
-	species: "Cat" | "Dog" | "Monkey" | "Pig";
+	first_name?: string;
+	id?: string;
+	last_name?: string;
+	optional?: null | string;
+	pets?: null | {
+	age?: number;
+	name?: string;
+	species?: "Cat" | "Dog" | "Monkey" | "Pig";
 }[];
 }[];
 };
@@ -97,17 +97,17 @@ def test_openapi_to_typescript_converter(person_controller: Type[Controller], pe
 };
 
 	export type RequestBody = {
-	complex: {
+	complex?: {
 	
 };
-	first_name: string;
-	id: string;
-	last_name: string;
-	optional: null | string;
-	pets: null | {
-	age: number;
-	name: string;
-	species: "Cat" | "Dog" | "Monkey" | "Pig";
+	first_name?: string;
+	id?: string;
+	last_name?: string;
+	optional?: null | string;
+	pets?: null | {
+	age?: number;
+	name?: string;
+	species?: "Cat" | "Dog" | "Monkey" | "Pig";
 }[];
 }[];
 };
@@ -119,17 +119,17 @@ def test_openapi_to_typescript_converter(person_controller: Type[Controller], pe
 
 	export namespace Http200 {
 	export type ResponseBody = {
-	complex: {
+	complex?: {
 	
 };
-	first_name: string;
-	id: string;
-	last_name: string;
-	optional: null | string;
-	pets: null | {
-	age: number;
-	name: string;
-	species: "Cat" | "Dog" | "Monkey" | "Pig";
+	first_name?: string;
+	id?: string;
+	last_name?: string;
+	optional?: null | string;
+	pets?: null | {
+	age?: number;
+	name?: string;
+	species?: "Cat" | "Dog" | "Monkey" | "Pig";
 }[];
 }[];
 };
@@ -147,17 +147,17 @@ def test_openapi_to_typescript_converter(person_controller: Type[Controller], pe
 };
 
 	export type RequestBody = {
-	complex: {
+	complex?: {
 	
 };
-	first_name: string;
-	id: string;
-	last_name: string;
-	optional: null | string;
-	pets: null | {
-	age: number;
-	name: string;
-	species: "Cat" | "Dog" | "Monkey" | "Pig";
+	first_name?: string;
+	id?: string;
+	last_name?: string;
+	optional?: null | string;
+	pets?: null | {
+	age?: number;
+	name?: string;
+	species?: "Cat" | "Dog" | "Monkey" | "Pig";
 }[];
 }[];
 };
@@ -396,17 +396,17 @@ def test_openapi_to_typescript_converter(person_controller: Type[Controller], pe
 	export namespace ServiceIdPersonPersonIdPartialUpdatePerson {
 	export namespace Http200 {
 	export type ResponseBody = {
-	complex: {
+	complex?: {
 	
 };
-	first_name: string;
-	id: string;
-	last_name: string;
-	optional: null | string;
-	pets: null | {
-	age: number;
-	name: string;
-	species: "Cat" | "Dog" | "Monkey" | "Pig";
+	first_name?: string;
+	id?: string;
+	last_name?: string;
+	optional?: null | string;
+	pets?: null | {
+	age?: number;
+	name?: string;
+	species?: "Cat" | "Dog" | "Monkey" | "Pig";
 }[];
 };
 };
@@ -425,17 +425,17 @@ def test_openapi_to_typescript_converter(person_controller: Type[Controller], pe
 };
 
 	export type RequestBody = {
-	complex: {
+	complex?: {
 	
 };
-	first_name: string;
-	id: string;
-	last_name: string;
-	optional: null | string;
-	pets: null | {
-	age: number;
-	name: string;
-	species: "Cat" | "Dog" | "Monkey" | "Pig";
+	first_name?: string;
+	id?: string;
+	last_name?: string;
+	optional?: null | string;
+	pets?: null | {
+	age?: number;
+	name?: string;
+	species?: "Cat" | "Dog" | "Monkey" | "Pig";
 }[];
 };
 };