ts-class-to-openapi 1.0.3 → 1.0.4

package/dist/transformer.d.ts

@@ -94,14 +94,26 @@ declare class SchemaTransformer {
     private getRelevantSourceFiles;
     /**
      * Transforms a class by its name into an OpenAPI schema object.
+     * Now considers the context of the calling file to resolve ambiguous class names.
      *
      * @param className - The name of the class to transform
      * @param filePath - Optional path to the file containing the class
+     * @param contextFile - Optional context file for resolving class ambiguity
      * @returns Object containing the class name and its corresponding JSON schema
      * @throws {Error} When the specified class cannot be found
      * @private
      */
     private transformByName;
+    /**
+     * Prioritizes source files based on context to resolve class name conflicts.
+     * Gives priority to files in the same directory or with similar names.
+     *
+     * @param sourceFiles - Array of source files to prioritize
+     * @param contextFile - Optional context file for prioritization
+     * @returns Prioritized array of source files
+     * @private
+     */
+    private prioritizeSourceFiles;
     /**
      * Gets the singleton instance of SchemaTransformer.
      *
@@ -195,6 +207,7 @@ declare class SchemaTransformer {
      * Transforms a TypeScript class declaration into a schema object.
      *
      * @param classNode - The TypeScript class declaration node
+     * @param sourceFile - The source file containing the class (for context)
      * @returns Object containing class name and generated schema
      * @private
      */
@@ -215,6 +228,82 @@ declare class SchemaTransformer {
      * @private
      */
     private getPropertyType;
+    /**
+     * Resolves generic types by analyzing the type alias and its arguments.
+     * For example, User<Role> where User is a type alias will be resolved to its structure.
+     *
+     * @param typeNode - The TypeScript type reference node with generic arguments
+     * @returns String representation of the resolved type or schema
+     * @private
+     */
+    private resolveGenericType;
+    /**
+     * Checks if a type string represents a resolved generic type.
+     *
+     * @param type - The type string to check
+     * @returns True if it's a resolved generic type
+     * @private
+     */
+    private isResolvedGenericType;
+    /**
+     * Checks if a type is a known class or interface.
+     *
+     * @param typeName - The type name to check
+     * @returns True if it's a known type
+     * @private
+     */
+    private isKnownType;
+    /**
+     * Finds a class by name in the project without transforming it.
+     *
+     * @param className - The class name to find
+     * @returns True if found, false otherwise
+     * @private
+     */
+    private findClassInProject;
+    /**
+     * Checks if a type is a primitive type.
+     *
+     * @param typeName - The type name to check
+     * @returns True if it's a primitive type
+     * @private
+     */
+    private isPrimitiveType;
+    /**
+     * Resolves a generic type schema by analyzing the type alias structure.
+     *
+     * @param resolvedTypeName - The resolved generic type name (e.g., User_Role)
+     * @returns OpenAPI schema for the resolved generic type
+     * @private
+     */
+    private resolveGenericTypeSchema;
+    /**
+     * Finds a type alias declaration by name.
+     *
+     * @param typeName - The type alias name to find
+     * @returns The type alias declaration node or null
+     * @private
+     */
+    private findTypeAliasDeclaration;
+    /**
+     * Creates a schema from a type alias declaration, substituting type parameters.
+     *
+     * @param typeAlias - The type alias declaration
+     * @param typeArgNames - The concrete type arguments
+     * @returns OpenAPI schema for the type alias
+     * @private
+     */
+    private createSchemaFromTypeAlias;
+    /**
+     * Resolves type parameters in a type alias to concrete types.
+     *
+     * @param typeNode - The type node to resolve
+     * @param typeParameters - The type parameters of the type alias
+     * @param typeArgNames - The concrete type arguments
+     * @returns The resolved type string
+     * @private
+     */
+    private resolveTypeParameterInTypeAlias;
     /**
      * Converts a TypeScript type node to its string representation.
      *
@@ -251,6 +340,7 @@ declare class SchemaTransformer {
      * Generates an OpenAPI schema from extracted property information.
      *
      * @param properties - Array of property information to process
+     * @param contextFile - Optional context file path for resolving class references
      * @returns Complete OpenAPI schema object with properties and validation rules
      * @private
      */
@@ -260,6 +350,7 @@ declare class SchemaTransformer {
      * Handles primitive types, arrays, and nested objects recursively.
      *
      * @param type - The TypeScript type string to map
+     * @param contextFile - Optional context file path for resolving class references
      * @returns Object containing OpenAPI type, optional format, and nested schema
      * @private
      */
@@ -274,6 +365,52 @@ declare class SchemaTransformer {
      * @private
      */
     private applyDecorators;
+    /**
+     * Applies the @IsEnum decorator to a property, handling both primitive values and object enums.
+     * Supports arrays of enum values as well.
+     *
+     * @param decorator - The IsEnum decorator information
+     * @param schema - The schema object to modify
+     * @param propertyName - The name of the property
+     * @param isArrayType - Whether the property is an array type
+     * @private
+     */
+    private applyEnumDecorator;
+    /**
+     * Attempts to resolve enum values from an enum type name.
+     * This searches through the TypeScript AST to find the enum declaration
+     * and extract its values.
+     *
+     * @param enumTypeName - The name of the enum type
+     * @returns Array of enum values if found, empty array otherwise
+     * @private
+     */
+    private resolveEnumValues;
+    /**
+     * Finds enum values in a specific source file.
+     *
+     * @param sourceFile - The source file to search
+     * @param enumTypeName - The name of the enum to find
+     * @returns Array of enum values if found, empty array otherwise
+     * @private
+     */
+    private findEnumValues;
+    /**
+     * Extracts values from a TypeScript enum declaration.
+     *
+     * @param enumNode - The enum declaration node
+     * @returns Array of enum values
+     * @private
+     */
+    private extractEnumValues;
+    /**
+     * Extracts values from object literal enum (const object as const).
+     *
+     * @param initializer - The object literal initializer
+     * @returns Array of enum values
+     * @private
+     */
+    private extractObjectEnumValues;
     /**
      * Applies sensible default behaviors for properties without class-validator decorators.
      * This allows the schema generator to work with plain TypeScript classes.

package/dist/transformer.fixtures.d.ts

@@ -140,6 +140,10 @@ declare const constants: {
         ArrayMinSize: {
             name: string;
         };
+        IsEnum: {
+            name: string;
+            type: string;
+        };
     };
 };
 export { messages, constants };

package/package.json

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