ts-class-to-openapi 1.3.4 → 1.4.0

package/README.md

@@ -27,7 +27,26 @@ class User {
 }
 
 const schema = transform(User)
-// Returns complete OpenAPI schema ready for Swagger/API documentation
+
+console.log(JSON.stringify(shema), null, 2)
+```
+
+**Generated output:**
+
+```json
+{
+  "name": "User",
+  "schema": {
+    "type": "object",
+    "properties": {
+      "id": { "type": "number" },
+      "name": { "type": "string" },
+      "email": { "type": "string" },
+      "age": { "type": "number" }
+    },
+    "required": ["id", "name", "email"]
+  }
+}
 ```
 
 ## 📦 Installation
@@ -55,57 +74,7 @@ npm install ts-class-to-openapi class-validator
 
 ## 🎨 Class Transformation Examples
 
-### 1. Basic TypeScript Class
-
-Fundamental method: transform any TypeScript class without decorators:
-
-```typescript
-import { transform } from 'ts-class-to-openapi'
-
-// Basic TypeScript class - no decorators required
-class User {
-  id: number
-  name: string
-  email: string
-  age: number
-  active: boolean
-  tags: string[]
-  createdAt: Date
-}
-
-// Transform class to OpenAPI schema
-const result = transform(User)
-console.log(JSON.stringify(result, null, 2))
-```
-
-**Generated output:**
-
-```json
-{
-  "name": "User",
-  "schema": {
-    "type": "object",
-    "properties": {
-      "id": { "type": "number" },
-      "name": { "type": "string" },
-      "email": { "type": "string" },
-      "age": { "type": "number" },
-      "active": { "type": "boolean" },
-      "tags": {
-        "type": "array",
-        "items": { "type": "string" }
-      },
-      "createdAt": {
-        "type": "string",
-        "format": "date-time"
-      }
-    },
-    "required": ["id", "name", "email", "age", "active", "tags", "createdAt"]
-  }
-}
-```
-
-### 2. Class with Advanced Validations
+### 1. Class with Advanced Validations
 
 For more detailed schemas, class-validator decorators can be incorporated:
 
@@ -156,7 +125,7 @@ const result = transform(User)
 }
 ```
 
-### 3. Nested Objects and Arrays
+### 2. Nested Objects and Arrays
 
 Automatic processing of complex relationships:
 
@@ -229,9 +198,9 @@ const schema = transform(User)
 }
 ```
 
-### 4. Enumerations and Special Types
+### 3. Enumerations and Special Types
 
-Full compatibility with TypeScript enumerations (both decorated and pure):
+Full compatibility with TypeScript enumerations (both decorated and pure), and literal object as enums:
 
 ```typescript
 import { transform } from 'ts-class-to-openapi'
@@ -299,59 +268,6 @@ const schema = transform(Task)
 }
 ```
 
-### 5. File Upload
-
-Integrated support for binary file handling:
-
-```typescript
-import { transform } from 'ts-class-to-openapi'
-import { IsNotEmpty, IsOptional } from 'class-validator'
-
-// Custom file type definition
-class UploadFile {}
-
-class UserProfile {
-  @IsNotEmpty()
-  profilePicture: UploadFile
-
-  @IsOptional()
-  resume: UploadFile
-
-  documents: UploadFile[] // Multiple files
-}
-
-const schema = transform(UserProfile)
-```
-
-**Generated output:**
-
-```json
-{
-  "name": "UserProfile",
-  "schema": {
-    "type": "object",
-    "properties": {
-      "profilePicture": {
-        "type": "string",
-        "format": "binary"
-      },
-      "resume": {
-        "type": "string",
-        "format": "binary"
-      },
-      "documents": {
-        "type": "array",
-        "items": {
-          "type": "string",
-          "format": "binary"
-        }
-      }
-    },
-    "required": ["profilePicture", "documents"]
-  }
-}
-```
-
 ## 🌐 REST API Integration
 
 ### Implementation with Express.js and Swagger UI

package/dist/index.cjs

@@ -332,6 +332,11 @@ var SchemaTransformer = class SchemaTransformer {
 				if (types.length > 0 && types[0]) return types[0];
 				return "object";
 			default:
+				if (typescript.default.isIndexedAccessTypeNode(typeNode)) {
+					const resolvedType = this.checker.getTypeAtLocation(typeNode);
+					const resolved = this.checker.typeToString(resolvedType);
+					if (this.isPrimitiveType(resolved)) return resolved;
+				}
 				const typeText = typeNode.getText();
 				if (genericTypeMap && genericTypeMap.has(typeText)) return genericTypeMap.get(typeText);
 				if (typeText.startsWith("Date")) return constants.jsPrimitives.Date.type;
@@ -838,6 +843,11 @@ var SchemaTransformer = class SchemaTransformer {
 		if (decorator.arguments.length === 0) return;
 		const arg = decorator.arguments[0];
 		if (arg && typeof arg === "object" && "kind" in arg) {
+			if (typescript.default.isArrayLiteralExpression(arg)) {
+				const values = this.extractValuesFromArrayLiteral(arg);
+				if (values.length > 0) this.applyEnumValues(values, schema);
+				return;
+			}
 			const type = this.checker.getTypeAtLocation(arg);
 			if (type.symbol && type.symbol.exports) {
 				const values = [];
@@ -849,15 +859,46 @@ var SchemaTransformer = class SchemaTransformer {
 					}
 				});
 				if (values.length > 0) {
-					schema.enum = values;
-					const isString = values.every((v) => typeof v === "string");
-					const isNumber = values.every((v) => typeof v === "number");
-					if (isString) schema.type = "string";
-					else if (isNumber) schema.type = "number";
-					else schema.type = "string";
+					this.applyEnumValues(values, schema);
+					return;
 				}
 			}
+			const values = this.extractValuesFromObjectLiteral(type);
+			if (values.length > 0) this.applyEnumValues(values, schema);
+		}
+	}
+	extractValuesFromArrayLiteral(arrayLiteral) {
+		const values = [];
+		for (const element of arrayLiteral.elements) if (typescript.default.isStringLiteral(element)) values.push(element.text);
+		else if (typescript.default.isNumericLiteral(element)) values.push(Number(element.text));
+		else if (typescript.default.isPrefixUnaryExpression(element) && element.operator === typescript.default.SyntaxKind.MinusToken && typescript.default.isNumericLiteral(element.operand)) values.push(-Number(element.operand.text));
+		return values;
+	}
+	extractValuesFromObjectLiteral(type) {
+		const values = [];
+		const properties = type.getProperties();
+		if (!properties || properties.length === 0) return values;
+		for (const prop of properties) {
+			const propType = this.checker.getTypeOfSymbolAtLocation(prop, prop.valueDeclaration);
+			if (propType.isStringLiteral()) values.push(propType.value);
+			else if (propType.isNumberLiteral()) values.push(propType.value);
+			else if (prop.valueDeclaration && typescript.default.isPropertyAssignment(prop.valueDeclaration)) {
+				const initializer = prop.valueDeclaration.initializer;
+				if (typescript.default.isStringLiteral(initializer)) values.push(initializer.text);
+				else if (typescript.default.isNumericLiteral(initializer)) values.push(Number(initializer.text));
+			}
 		}
+		return values;
+	}
+	applyEnumValues(values, schema) {
+		schema.enum = values;
+		const isString = values.every((v) => typeof v === "string");
+		const isNumber = values.every((v) => typeof v === "number");
+		if (isString) schema.type = "string";
+		else if (isNumber) schema.type = "number";
+		else schema.type = "string";
+		delete schema.properties;
+		delete schema.additionalProperties;
 	}
 	applyDecorators(property, schema) {
 		for (const decorator of property.decorators) switch (decorator.name) {
@@ -935,7 +976,13 @@ var SchemaTransformer = class SchemaTransformer {
 				break;
 			case constants.validatorDecorators.IsEnum.name:
 				if (!property.isArray) this.applyEnumDecorator(decorator, schema);
-				else if (schema.items) this.applyEnumDecorator(decorator, schema.items);
+				else {
+					if (!schema.items) {
+						schema.type = "array";
+						schema.items = {};
+					}
+					this.applyEnumDecorator(decorator, schema.items);
+				}
 				break;
 		}
 	}

package/dist/index.mjs

@@ -307,6 +307,11 @@ var SchemaTransformer = class SchemaTransformer {
 				if (types.length > 0 && types[0]) return types[0];
 				return "object";
 			default:
+				if (ts.isIndexedAccessTypeNode(typeNode)) {
+					const resolvedType = this.checker.getTypeAtLocation(typeNode);
+					const resolved = this.checker.typeToString(resolvedType);
+					if (this.isPrimitiveType(resolved)) return resolved;
+				}
 				const typeText = typeNode.getText();
 				if (genericTypeMap && genericTypeMap.has(typeText)) return genericTypeMap.get(typeText);
 				if (typeText.startsWith("Date")) return constants.jsPrimitives.Date.type;
@@ -813,6 +818,11 @@ var SchemaTransformer = class SchemaTransformer {
 		if (decorator.arguments.length === 0) return;
 		const arg = decorator.arguments[0];
 		if (arg && typeof arg === "object" && "kind" in arg) {
+			if (ts.isArrayLiteralExpression(arg)) {
+				const values = this.extractValuesFromArrayLiteral(arg);
+				if (values.length > 0) this.applyEnumValues(values, schema);
+				return;
+			}
 			const type = this.checker.getTypeAtLocation(arg);
 			if (type.symbol && type.symbol.exports) {
 				const values = [];
@@ -824,15 +834,46 @@ var SchemaTransformer = class SchemaTransformer {
 					}
 				});
 				if (values.length > 0) {
-					schema.enum = values;
-					const isString = values.every((v) => typeof v === "string");
-					const isNumber = values.every((v) => typeof v === "number");
-					if (isString) schema.type = "string";
-					else if (isNumber) schema.type = "number";
-					else schema.type = "string";
+					this.applyEnumValues(values, schema);
+					return;
 				}
 			}
+			const values = this.extractValuesFromObjectLiteral(type);
+			if (values.length > 0) this.applyEnumValues(values, schema);
+		}
+	}
+	extractValuesFromArrayLiteral(arrayLiteral) {
+		const values = [];
+		for (const element of arrayLiteral.elements) if (ts.isStringLiteral(element)) values.push(element.text);
+		else if (ts.isNumericLiteral(element)) values.push(Number(element.text));
+		else if (ts.isPrefixUnaryExpression(element) && element.operator === ts.SyntaxKind.MinusToken && ts.isNumericLiteral(element.operand)) values.push(-Number(element.operand.text));
+		return values;
+	}
+	extractValuesFromObjectLiteral(type) {
+		const values = [];
+		const properties = type.getProperties();
+		if (!properties || properties.length === 0) return values;
+		for (const prop of properties) {
+			const propType = this.checker.getTypeOfSymbolAtLocation(prop, prop.valueDeclaration);
+			if (propType.isStringLiteral()) values.push(propType.value);
+			else if (propType.isNumberLiteral()) values.push(propType.value);
+			else if (prop.valueDeclaration && ts.isPropertyAssignment(prop.valueDeclaration)) {
+				const initializer = prop.valueDeclaration.initializer;
+				if (ts.isStringLiteral(initializer)) values.push(initializer.text);
+				else if (ts.isNumericLiteral(initializer)) values.push(Number(initializer.text));
+			}
 		}
+		return values;
+	}
+	applyEnumValues(values, schema) {
+		schema.enum = values;
+		const isString = values.every((v) => typeof v === "string");
+		const isNumber = values.every((v) => typeof v === "number");
+		if (isString) schema.type = "string";
+		else if (isNumber) schema.type = "number";
+		else schema.type = "string";
+		delete schema.properties;
+		delete schema.additionalProperties;
 	}
 	applyDecorators(property, schema) {
 		for (const decorator of property.decorators) switch (decorator.name) {
@@ -910,7 +951,13 @@ var SchemaTransformer = class SchemaTransformer {
 				break;
 			case constants.validatorDecorators.IsEnum.name:
 				if (!property.isArray) this.applyEnumDecorator(decorator, schema);
-				else if (schema.items) this.applyEnumDecorator(decorator, schema.items);
+				else {
+					if (!schema.items) {
+						schema.type = "array";
+						schema.items = {};
+					}
+					this.applyEnumDecorator(decorator, schema.items);
+				}
 				break;
 		}
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-class-to-openapi",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "description": "Transform TypeScript classes into OpenAPI 3.1.0 schema objects, which support class-validator decorators",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -81,9 +81,9 @@
     "test": "node --import tsx --test test/testCases/**/*.test.ts",
     "test:watch": "node --import tsx --inspect --test --watch test/testCases/**/*.test.ts",
     "test:coverage": "node --import tsx --test --experimental-test-coverage test/testCases/**/*.test.ts",
-    "build": "tsc --noEmit && rm -rf dist && tsdown",
+    "build": "tsc --noEmit && tsdown",
     "build:watch": "rm -rf dist && tsdown --watch",
-    "dev": "node --import tsx --test --inspect --watch ./src/run.ts",
+    "dev": "node --import tsx --inspect --watch ./src/run.ts",
     "format": "prettier --write .",
     "format:check": "prettier --check .",
     "prepublish": "pnpm build"