ts-class-to-openapi 1.4.0 → 1.4.1

package/dist/index.cjs

@@ -189,6 +189,7 @@ var SchemaTransformer = class SchemaTransformer {
 	maxCacheSize;
 	autoCleanup;
 	classFileIndex = /* @__PURE__ */ new Map();
+	transformCallIndex = /* @__PURE__ */ new Map();
 	constructor(tsConfigPath = constants.TS_CONFIG_DEFAULT_PATH, options = {}) {
 		this.maxCacheSize = options.maxCacheSize ?? 100;
 		this.autoCleanup = options.autoCleanup ?? true;
@@ -200,19 +201,7 @@ var SchemaTransformer = class SchemaTransformer {
 		const { options: tsOptions, fileNames } = typescript.default.parseJsonConfigFileContent(config, typescript.default.sys, "./");
 		this.program = typescript.default.createProgram(fileNames, tsOptions);
 		this.checker = this.program.getTypeChecker();
-		this.program.getSourceFiles().forEach((sf) => {
-			sf.statements.forEach((stmt) => {
-				if (typescript.default.isClassDeclaration(stmt) && stmt.name) {
-					const name = stmt.name.text;
-					const entry = this.classFileIndex.get(name) || [];
-					entry.push({
-						sourceFile: sf,
-						node: stmt
-					});
-					this.classFileIndex.set(name, entry);
-				}
-			});
-		});
+		this.buildTransformCallIndex();
 	}
 	getPropertiesByClassDeclaration(classNode, visitedDeclarations = /* @__PURE__ */ new Set(), genericTypeMap = /* @__PURE__ */ new Map()) {
 		if (visitedDeclarations.has(classNode)) return [];
@@ -260,6 +249,18 @@ var SchemaTransformer = class SchemaTransformer {
 				const isOptional = !!member.questionToken;
 				const isGeneric = this.isPropertyTypeGeneric(member);
 				const isEnum = this.isEnum(member);
+				const isPrimitive = this.isPrimitiveType(type) || isEnum;
+				const isClassType = this.isClassType(member);
+				const isArray = this.isArrayProperty(member);
+				const isTypeLiteral = this.isTypeLiteral(member);
+				let genericClassReference = void 0;
+				if (isGeneric && !isPrimitive) {
+					const baseTypeName = type.replace(/\[\]$/, "").trim();
+					if (!this.isPrimitiveType(baseTypeName)) {
+						const matches = this.classFileIndex.get(baseTypeName);
+						if (matches && matches.length > 0 && matches[0]) genericClassReference = matches[0].node;
+					}
+				}
 				const property = {
 					name: propertyName,
 					type,
@@ -267,12 +268,13 @@ var SchemaTransformer = class SchemaTransformer {
 					isOptional,
 					isGeneric,
 					originalProperty: member,
-					isPrimitive: this.isPrimitiveType(type) || isEnum,
-					isClassType: this.isClassType(member),
-					isArray: this.isArrayProperty(member),
+					isPrimitive,
+					isClassType,
+					isArray,
 					isEnum,
 					isRef: false,
-					isTypeLiteral: this.isTypeLiteral(member)
+					isTypeLiteral,
+					genericClassReference
 				};
 				if (property.isClassType) {
 					const declaration = this.getDeclarationProperty(property);
@@ -310,6 +312,7 @@ var SchemaTransformer = class SchemaTransformer {
 			if (typeName.toLowerCase() === "uploadfile") return "UploadFile";
 			if (typeName.toLowerCase() === "uploadfiledto") return "UploadFileDto";
 			if (typeNode.typeArguments && typeNode.typeArguments.length > 0) {
+				if (typeName === "Array") return `${this.getTypeNodeToString(typeNode.typeArguments[0], genericTypeMap)}[]`;
 				const firstTypeArg = typeNode.typeArguments[0];
 				if (firstTypeArg && typescript.default.isTypeReferenceNode(firstTypeArg) && typescript.default.isIdentifier(firstTypeArg.typeName)) {
 					if (firstTypeArg.typeName.text.toLowerCase() === "uploadfile") return "UploadFile";
@@ -411,7 +414,7 @@ var SchemaTransformer = class SchemaTransformer {
 	isGenericTypeFromSymbol(type) {
 		if (this.isSimpleArrayType(type)) return false;
 		if (type.aliasTypeArguments && type.aliasTypeArguments.length > 0) return true;
-		if (type.typeArguments && type.typeArguments.length > 0) {
+		if (type.typeArguments && type.typeArguments.length > 0 && type.typeArguments[0].symbol.getName() === "Array") {
 			const symbol = type.getSymbol();
 			if (symbol && symbol.getName() === "Array") {
 				const elementType = type.typeArguments[0];
@@ -456,6 +459,7 @@ var SchemaTransformer = class SchemaTransformer {
 			if (!elementType) return false;
 			if (this.isUtilityTypeFromType(elementType)) return false;
 			if (elementType.typeArguments && elementType.typeArguments.length > 0) return false;
+			if (type.typeArguments && type.typeArguments[0].symbol && type.typeArguments[0].symbol.getName() !== "Array") return false;
 			return true;
 		}
 		return false;
@@ -513,22 +517,6 @@ var SchemaTransformer = class SchemaTransformer {
 		}
 		return matches[0];
 	}
-	checkTypeMatch(value, typeNode) {
-		const runtimeType = typeof value;
-		if (runtimeType === "string" && typeNode.kind === typescript.default.SyntaxKind.StringKeyword) return true;
-		if (runtimeType === "number" && typeNode.kind === typescript.default.SyntaxKind.NumberKeyword) return true;
-		if (runtimeType === "boolean" && typeNode.kind === typescript.default.SyntaxKind.BooleanKeyword) return true;
-		if (Array.isArray(value) && typescript.default.isArrayTypeNode(typeNode)) {
-			if (value.length === 0) return true;
-			const firstItem = value[0];
-			const elementType = typeNode.elementType;
-			return this.checkTypeMatch(firstItem, elementType);
-		}
-		if (runtimeType === "object" && value !== null && !Array.isArray(value)) {
-			if (typescript.default.isTypeReferenceNode(typeNode) || typeNode.kind === typescript.default.SyntaxKind.ObjectKeyword) return true;
-		}
-		return false;
-	}
 	findBestMatch(cls, matches) {
 		let instance = {};
 		try {
@@ -570,7 +558,11 @@ var SchemaTransformer = class SchemaTransformer {
 	isClassType(propertyDeclaration) {
 		if (!propertyDeclaration.type) return false;
 		if (this.isArrayProperty(propertyDeclaration)) {
-			const elementType = propertyDeclaration.type.elementType;
+			var _propertyDeclaration$;
+			let elementType;
+			if (typescript.default.isArrayTypeNode(propertyDeclaration.type)) elementType = propertyDeclaration.type.elementType;
+			else if (typescript.default.isTypeReferenceNode(propertyDeclaration.type) && ((_propertyDeclaration$ = propertyDeclaration.type.typeArguments) === null || _propertyDeclaration$ === void 0 ? void 0 : _propertyDeclaration$[0])) elementType = propertyDeclaration.type.typeArguments[0];
+			if (!elementType) return false;
 			if (typescript.default.isTypeReferenceNode(elementType) && elementType.typeArguments && elementType.typeArguments.length > 0) {
 				const firstTypeArg = elementType.typeArguments[0];
 				if (firstTypeArg) {
@@ -631,7 +623,9 @@ var SchemaTransformer = class SchemaTransformer {
 	}
 	isArrayProperty(propertyDeclaration) {
 		if (!propertyDeclaration.type) return false;
-		return typescript.default.isArrayTypeNode(propertyDeclaration.type);
+		if (typescript.default.isArrayTypeNode(propertyDeclaration.type)) return true;
+		if (typescript.default.isTypeReferenceNode(propertyDeclaration.type) && typescript.default.isIdentifier(propertyDeclaration.type.typeName) && propertyDeclaration.type.typeName.text === "Array") return true;
+		return false;
 	}
 	getSchemaFromProperties({ properties, visitedClass, transformedSchema, classDeclaration }) {
 		let schema = {};
@@ -666,6 +660,17 @@ var SchemaTransformer = class SchemaTransformer {
 			visitedClass,
 			transformedSchema
 		});
+		else if (property.isGeneric) if (property.genericClassReference) schema = this.getSchemaFromClass({
+			isArray: property.isArray,
+			visitedClass,
+			transformedSchema,
+			declaration: property.genericClassReference
+		});
+		else schema = {
+			type: "object",
+			properties: {},
+			additionalProperties: true
+		};
 		else schema = {
 			type: "object",
 			properties: {},
@@ -986,12 +991,55 @@ var SchemaTransformer = class SchemaTransformer {
 				break;
 		}
 	}
+	/**
+	* Scans all non-declaration source files in the program once and records
+	* every call of the form `transform(Foo<Bar, Baz>)`, keyed by class name.
+	* This means generic resolution in transform() is a pure O(1) Map lookup
+	* with no runtime stack inspection.
+	*/
+	buildTransformCallIndex() {
+		this.program.getSourceFiles().forEach((sf) => {
+			if (sf.isDeclarationFile) return;
+			sf.statements.forEach((stmt) => {
+				if (typescript.default.isClassDeclaration(stmt) && stmt.name) {
+					const name = stmt.name.text;
+					const entry = this.classFileIndex.get(name) || [];
+					entry.push({
+						sourceFile: sf,
+						node: stmt
+					});
+					this.classFileIndex.set(name, entry);
+				}
+			});
+			const visit = (node) => {
+				if (typescript.default.isCallExpression(node) && node.arguments.length > 0) {
+					const callee = node.expression;
+					if (typescript.default.isIdentifier(callee) && callee.text === "transform" || typescript.default.isPropertyAccessExpression(callee) && callee.name.text === "transform") {
+						const firstArg = node.arguments[0];
+						const typeArgs = firstArg.typeArguments;
+						if (typeArgs && typeArgs.length > 0) {
+							const baseExpr = firstArg.expression ?? firstArg;
+							if (typescript.default.isIdentifier(baseExpr)) {
+								var _this$classFileIndex$;
+								const classNode = (_this$classFileIndex$ = this.classFileIndex.get(baseExpr.text)) === null || _this$classFileIndex$ === void 0 || (_this$classFileIndex$ = _this$classFileIndex$[0]) === null || _this$classFileIndex$ === void 0 ? void 0 : _this$classFileIndex$.node;
+								if (classNode === null || classNode === void 0 ? void 0 : classNode.typeParameters) {
+									const typeMap = /* @__PURE__ */ new Map();
+									classNode.typeParameters.forEach((param, i) => {
+										const typeArg = typeArgs[i];
+										if (typeArg) typeMap.set(param.name.text, this.getTypeNodeToString(typeArg, /* @__PURE__ */ new Map()));
+									});
+									if (typeMap.size > 0) this.transformCallIndex.set(baseExpr.text, typeMap);
+								}
+							}
+						}
+					}
+				}
+				typescript.default.forEachChild(node, visit);
+			};
+			visit(sf);
+		});
+	}
 	transform(cls, sourceOptions) {
-		if (this.classCache.has(cls)) return this.classCache.get(cls);
-		let schema = {
-			type: "object",
-			properties: {}
-		};
 		const result = this.getSourceFileByClass(cls, sourceOptions);
 		if (!result || !(result === null || result === void 0 ? void 0 : result.sourceFile)) {
 			console.warn(`Class ${cls.name} not found in any source file.`);
@@ -1005,11 +1053,22 @@ var SchemaTransformer = class SchemaTransformer {
 				}
 			};
 		}
-		const properties = this.getPropertiesByClassDeclaration(result.node);
+		const genericTypeMap = this.transformCallIndex.get(cls.name) ?? /* @__PURE__ */ new Map();
+		const hasGenericArgs = genericTypeMap.size > 0;
+		if (!hasGenericArgs && this.classCache.has(cls)) return this.classCache.get(cls);
+		let schema = {
+			type: "object",
+			properties: {}
+		};
+		const properties = this.getPropertiesByClassDeclaration(result.node, void 0, genericTypeMap);
 		schema = this.getSchemaFromProperties({
 			properties,
 			classDeclaration: result.node
 		});
+		if (!hasGenericArgs) this.classCache.set(cls, {
+			name: cls.name,
+			schema
+		});
 		return {
 			name: cls.name,
 			schema

package/dist/index.mjs

@@ -164,6 +164,7 @@ var SchemaTransformer = class SchemaTransformer {
 	maxCacheSize;
 	autoCleanup;
 	classFileIndex = /* @__PURE__ */ new Map();
+	transformCallIndex = /* @__PURE__ */ new Map();
 	constructor(tsConfigPath = constants.TS_CONFIG_DEFAULT_PATH, options = {}) {
 		this.maxCacheSize = options.maxCacheSize ?? 100;
 		this.autoCleanup = options.autoCleanup ?? true;
@@ -175,19 +176,7 @@ var SchemaTransformer = class SchemaTransformer {
 		const { options: tsOptions, fileNames } = ts.parseJsonConfigFileContent(config, ts.sys, "./");
 		this.program = ts.createProgram(fileNames, tsOptions);
 		this.checker = this.program.getTypeChecker();
-		this.program.getSourceFiles().forEach((sf) => {
-			sf.statements.forEach((stmt) => {
-				if (ts.isClassDeclaration(stmt) && stmt.name) {
-					const name = stmt.name.text;
-					const entry = this.classFileIndex.get(name) || [];
-					entry.push({
-						sourceFile: sf,
-						node: stmt
-					});
-					this.classFileIndex.set(name, entry);
-				}
-			});
-		});
+		this.buildTransformCallIndex();
 	}
 	getPropertiesByClassDeclaration(classNode, visitedDeclarations = /* @__PURE__ */ new Set(), genericTypeMap = /* @__PURE__ */ new Map()) {
 		if (visitedDeclarations.has(classNode)) return [];
@@ -235,6 +224,18 @@ var SchemaTransformer = class SchemaTransformer {
 				const isOptional = !!member.questionToken;
 				const isGeneric = this.isPropertyTypeGeneric(member);
 				const isEnum = this.isEnum(member);
+				const isPrimitive = this.isPrimitiveType(type) || isEnum;
+				const isClassType = this.isClassType(member);
+				const isArray = this.isArrayProperty(member);
+				const isTypeLiteral = this.isTypeLiteral(member);
+				let genericClassReference = void 0;
+				if (isGeneric && !isPrimitive) {
+					const baseTypeName = type.replace(/\[\]$/, "").trim();
+					if (!this.isPrimitiveType(baseTypeName)) {
+						const matches = this.classFileIndex.get(baseTypeName);
+						if (matches && matches.length > 0 && matches[0]) genericClassReference = matches[0].node;
+					}
+				}
 				const property = {
 					name: propertyName,
 					type,
@@ -242,12 +243,13 @@ var SchemaTransformer = class SchemaTransformer {
 					isOptional,
 					isGeneric,
 					originalProperty: member,
-					isPrimitive: this.isPrimitiveType(type) || isEnum,
-					isClassType: this.isClassType(member),
-					isArray: this.isArrayProperty(member),
+					isPrimitive,
+					isClassType,
+					isArray,
 					isEnum,
 					isRef: false,
-					isTypeLiteral: this.isTypeLiteral(member)
+					isTypeLiteral,
+					genericClassReference
 				};
 				if (property.isClassType) {
 					const declaration = this.getDeclarationProperty(property);
@@ -285,6 +287,7 @@ var SchemaTransformer = class SchemaTransformer {
 			if (typeName.toLowerCase() === "uploadfile") return "UploadFile";
 			if (typeName.toLowerCase() === "uploadfiledto") return "UploadFileDto";
 			if (typeNode.typeArguments && typeNode.typeArguments.length > 0) {
+				if (typeName === "Array") return `${this.getTypeNodeToString(typeNode.typeArguments[0], genericTypeMap)}[]`;
 				const firstTypeArg = typeNode.typeArguments[0];
 				if (firstTypeArg && ts.isTypeReferenceNode(firstTypeArg) && ts.isIdentifier(firstTypeArg.typeName)) {
 					if (firstTypeArg.typeName.text.toLowerCase() === "uploadfile") return "UploadFile";
@@ -386,7 +389,7 @@ var SchemaTransformer = class SchemaTransformer {
 	isGenericTypeFromSymbol(type) {
 		if (this.isSimpleArrayType(type)) return false;
 		if (type.aliasTypeArguments && type.aliasTypeArguments.length > 0) return true;
-		if (type.typeArguments && type.typeArguments.length > 0) {
+		if (type.typeArguments && type.typeArguments.length > 0 && type.typeArguments[0].symbol.getName() === "Array") {
 			const symbol = type.getSymbol();
 			if (symbol && symbol.getName() === "Array") {
 				const elementType = type.typeArguments[0];
@@ -431,6 +434,7 @@ var SchemaTransformer = class SchemaTransformer {
 			if (!elementType) return false;
 			if (this.isUtilityTypeFromType(elementType)) return false;
 			if (elementType.typeArguments && elementType.typeArguments.length > 0) return false;
+			if (type.typeArguments && type.typeArguments[0].symbol && type.typeArguments[0].symbol.getName() !== "Array") return false;
 			return true;
 		}
 		return false;
@@ -488,22 +492,6 @@ var SchemaTransformer = class SchemaTransformer {
 		}
 		return matches[0];
 	}
-	checkTypeMatch(value, typeNode) {
-		const runtimeType = typeof value;
-		if (runtimeType === "string" && typeNode.kind === ts.SyntaxKind.StringKeyword) return true;
-		if (runtimeType === "number" && typeNode.kind === ts.SyntaxKind.NumberKeyword) return true;
-		if (runtimeType === "boolean" && typeNode.kind === ts.SyntaxKind.BooleanKeyword) return true;
-		if (Array.isArray(value) && ts.isArrayTypeNode(typeNode)) {
-			if (value.length === 0) return true;
-			const firstItem = value[0];
-			const elementType = typeNode.elementType;
-			return this.checkTypeMatch(firstItem, elementType);
-		}
-		if (runtimeType === "object" && value !== null && !Array.isArray(value)) {
-			if (ts.isTypeReferenceNode(typeNode) || typeNode.kind === ts.SyntaxKind.ObjectKeyword) return true;
-		}
-		return false;
-	}
 	findBestMatch(cls, matches) {
 		let instance = {};
 		try {
@@ -545,7 +533,11 @@ var SchemaTransformer = class SchemaTransformer {
 	isClassType(propertyDeclaration) {
 		if (!propertyDeclaration.type) return false;
 		if (this.isArrayProperty(propertyDeclaration)) {
-			const elementType = propertyDeclaration.type.elementType;
+			var _propertyDeclaration$;
+			let elementType;
+			if (ts.isArrayTypeNode(propertyDeclaration.type)) elementType = propertyDeclaration.type.elementType;
+			else if (ts.isTypeReferenceNode(propertyDeclaration.type) && ((_propertyDeclaration$ = propertyDeclaration.type.typeArguments) === null || _propertyDeclaration$ === void 0 ? void 0 : _propertyDeclaration$[0])) elementType = propertyDeclaration.type.typeArguments[0];
+			if (!elementType) return false;
 			if (ts.isTypeReferenceNode(elementType) && elementType.typeArguments && elementType.typeArguments.length > 0) {
 				const firstTypeArg = elementType.typeArguments[0];
 				if (firstTypeArg) {
@@ -606,7 +598,9 @@ var SchemaTransformer = class SchemaTransformer {
 	}
 	isArrayProperty(propertyDeclaration) {
 		if (!propertyDeclaration.type) return false;
-		return ts.isArrayTypeNode(propertyDeclaration.type);
+		if (ts.isArrayTypeNode(propertyDeclaration.type)) return true;
+		if (ts.isTypeReferenceNode(propertyDeclaration.type) && ts.isIdentifier(propertyDeclaration.type.typeName) && propertyDeclaration.type.typeName.text === "Array") return true;
+		return false;
 	}
 	getSchemaFromProperties({ properties, visitedClass, transformedSchema, classDeclaration }) {
 		let schema = {};
@@ -641,6 +635,17 @@ var SchemaTransformer = class SchemaTransformer {
 			visitedClass,
 			transformedSchema
 		});
+		else if (property.isGeneric) if (property.genericClassReference) schema = this.getSchemaFromClass({
+			isArray: property.isArray,
+			visitedClass,
+			transformedSchema,
+			declaration: property.genericClassReference
+		});
+		else schema = {
+			type: "object",
+			properties: {},
+			additionalProperties: true
+		};
 		else schema = {
 			type: "object",
 			properties: {},
@@ -961,12 +966,55 @@ var SchemaTransformer = class SchemaTransformer {
 				break;
 		}
 	}
+	/**
+	* Scans all non-declaration source files in the program once and records
+	* every call of the form `transform(Foo<Bar, Baz>)`, keyed by class name.
+	* This means generic resolution in transform() is a pure O(1) Map lookup
+	* with no runtime stack inspection.
+	*/
+	buildTransformCallIndex() {
+		this.program.getSourceFiles().forEach((sf) => {
+			if (sf.isDeclarationFile) return;
+			sf.statements.forEach((stmt) => {
+				if (ts.isClassDeclaration(stmt) && stmt.name) {
+					const name = stmt.name.text;
+					const entry = this.classFileIndex.get(name) || [];
+					entry.push({
+						sourceFile: sf,
+						node: stmt
+					});
+					this.classFileIndex.set(name, entry);
+				}
+			});
+			const visit = (node) => {
+				if (ts.isCallExpression(node) && node.arguments.length > 0) {
+					const callee = node.expression;
+					if (ts.isIdentifier(callee) && callee.text === "transform" || ts.isPropertyAccessExpression(callee) && callee.name.text === "transform") {
+						const firstArg = node.arguments[0];
+						const typeArgs = firstArg.typeArguments;
+						if (typeArgs && typeArgs.length > 0) {
+							const baseExpr = firstArg.expression ?? firstArg;
+							if (ts.isIdentifier(baseExpr)) {
+								var _this$classFileIndex$;
+								const classNode = (_this$classFileIndex$ = this.classFileIndex.get(baseExpr.text)) === null || _this$classFileIndex$ === void 0 || (_this$classFileIndex$ = _this$classFileIndex$[0]) === null || _this$classFileIndex$ === void 0 ? void 0 : _this$classFileIndex$.node;
+								if (classNode === null || classNode === void 0 ? void 0 : classNode.typeParameters) {
+									const typeMap = /* @__PURE__ */ new Map();
+									classNode.typeParameters.forEach((param, i) => {
+										const typeArg = typeArgs[i];
+										if (typeArg) typeMap.set(param.name.text, this.getTypeNodeToString(typeArg, /* @__PURE__ */ new Map()));
+									});
+									if (typeMap.size > 0) this.transformCallIndex.set(baseExpr.text, typeMap);
+								}
+							}
+						}
+					}
+				}
+				ts.forEachChild(node, visit);
+			};
+			visit(sf);
+		});
+	}
 	transform(cls, sourceOptions) {
-		if (this.classCache.has(cls)) return this.classCache.get(cls);
-		let schema = {
-			type: "object",
-			properties: {}
-		};
 		const result = this.getSourceFileByClass(cls, sourceOptions);
 		if (!result || !(result === null || result === void 0 ? void 0 : result.sourceFile)) {
 			console.warn(`Class ${cls.name} not found in any source file.`);
@@ -980,11 +1028,22 @@ var SchemaTransformer = class SchemaTransformer {
 				}
 			};
 		}
-		const properties = this.getPropertiesByClassDeclaration(result.node);
+		const genericTypeMap = this.transformCallIndex.get(cls.name) ?? /* @__PURE__ */ new Map();
+		const hasGenericArgs = genericTypeMap.size > 0;
+		if (!hasGenericArgs && this.classCache.has(cls)) return this.classCache.get(cls);
+		let schema = {
+			type: "object",
+			properties: {}
+		};
+		const properties = this.getPropertiesByClassDeclaration(result.node, void 0, genericTypeMap);
 		schema = this.getSchemaFromProperties({
 			properties,
 			classDeclaration: result.node
 		});
+		if (!hasGenericArgs) this.classCache.set(cls, {
+			name: cls.name,
+			schema
+		});
 		return {
 			name: cls.name,
 			schema

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-class-to-openapi",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "Transform TypeScript classes into OpenAPI 3.1.0 schema objects, which support class-validator decorators",
   "type": "module",
   "main": "./dist/index.cjs",