jszy-swagger-doc-generator 1.4.1 → 1.5.0

package/dist/generators/swagger.generator.d.ts

@@ -0,0 +1,90 @@
+import { SwaggerDoc } from '../types';
+export declare class SwaggerDocGenerator {
+    /**
+     * Fetches the Swagger/OpenAPI JSON from a given URL
+     */
+    fetchSwaggerJSON(url: string): Promise<SwaggerDoc>;
+    /**
+     * Loads Swagger JSON from a local file
+     */
+    loadSwaggerFromFile(filePath: string): SwaggerDoc;
+    /**
+     * Generates frontend resources using Handlebars templates
+     */
+    generateHandlebarsResources(swaggerDoc: SwaggerDoc, templatePaths?: {
+        hooks?: string;
+        types?: string;
+        components?: string;
+        pages?: string;
+    }): Map<string, {
+        hooks: string;
+        types: string;
+    }>;
+    /**
+     * Checks if a schema is used in any of the endpoints
+     */
+    isSchemaUsedInEndpoints(schemaName: string, endpoints: Array<{
+        path: string;
+        method: string;
+        endpointInfo: any;
+    }>, allSchemas: {
+        [key: string]: any;
+    }): boolean;
+    /**
+     * Checks if a schema contains a reference to another schema
+     */
+    schemaContainsRef(schema: any, targetSchemaName: string, allSchemas: {
+        [key: string]: any;
+    }): boolean;
+    /**
+     * Find all referenced schemas from a set of directly used schemas
+     */
+    findAllReferencedSchemas(initialSchemas: Set<string>, allSchemas: {
+        [key: string]: any;
+    }): Set<string>;
+    /**
+     * Find schema references in a given schema
+     */
+    findSchemaReferences(schema: any, allSchemas: {
+        [key: string]: any;
+    }): Set<string>;
+    /**
+     * Generates a parameter interface for an API endpoint
+     */
+    generateParamInterface(path: string, method: string, endpointInfo: any, schemas: {
+        [key: string]: any;
+    }): string;
+    /**
+     * Generates a React Query hook using axios
+     */
+    generateReactQueryHook(path: string, method: string, endpointInfo: any, schemas: {
+        [key: string]: any;
+    }): string;
+    /**
+     * Generate operation ID from path and method if not provided
+     */
+    generateOperationId(path: string, method: string): string;
+    /**
+     * Formats code using Prettier - sync version with child process
+     */
+    private formatCode;
+    /**
+     * Gets the parser based on file extension
+     */
+    private getParserForFile;
+    /**
+     * Saves the generated documentation to a file
+     */
+    saveDocumentationToFile(documentation: string, outputPath: string): void;
+    /**
+     * Saves the generated TypeScript types to a file
+     */
+    saveTypesToFile(types: string, outputPath: string): void;
+    /**
+     * Saves the generated React hooks to files organized by tag
+     */
+    saveHooksByTag(hooksByTag: Map<string, {
+        hooks: string;
+        types: string;
+    }>, outputDir: string): void;
+}