ng-openapi 0.0.41 → 0.0.42-pr-9-feature-http-resource-e6134bb.0

package/index.d.ts

@@ -1,4 +1,4 @@
-import { ScriptTarget, ModuleKind } from 'ts-morph';
+import { Project, ScriptTarget, ModuleKind, MethodDeclaration, FunctionDeclaration } from 'ts-morph';
 import { HttpInterceptor } from '@angular/common/http';
 import { Info, ExternalDocs, Path, ParameterType, XML, BodyParameter, QueryParameter, Security, Tag } from 'swagger-schema-official';
 
@@ -25,6 +25,17 @@ interface TypeSchema {
     enum?: Array<string | number>;
     [key: string]: any;
 }
+interface GetMethodGenerationContext {
+    pathParams: Array<{
+        name: string;
+        in: string;
+    }>;
+    queryParams: Array<{
+        name: string;
+        in: string;
+    }>;
+    responseType: "json" | "blob" | "arraybuffer" | "text";
+}
 
 interface Parameter {
     name: string;
@@ -133,6 +144,57 @@ type EnumValueObject = {
     Value: number;
 };
 
+declare class SwaggerParser {
+    private readonly spec;
+    private constructor();
+    static create(swaggerPathOrUrl: string, config: GeneratorConfig): Promise<SwaggerParser>;
+    private static loadContent;
+    private static isUrl;
+    private static fetchUrlContent;
+    private static parseSpecContent;
+    private static detectFormat;
+    getDefinitions(): Record<string, SwaggerDefinition>;
+    getDefinition(name: string): SwaggerDefinition | undefined;
+    resolveReference(ref: string): SwaggerDefinition | undefined;
+    getAllDefinitionNames(): string[];
+    getSpec(): SwaggerSpec;
+    getPaths(): Record<string, any>;
+    isValidSpec(): boolean;
+    getSpecVersion(): {
+        type: "swagger" | "openapi";
+        version: string;
+    } | null;
+}
+
+/**
+ * Interface for generator instances
+ */
+interface IPluginGenerator {
+    /**
+     * Generate code files
+     */
+    generate(outputRoot: string): void;
+}
+/**
+ * Interface for generator constructor with static methods
+ */
+interface IPluginGeneratorConstructor {
+    /**
+     * Create a generator instance
+     */
+    create(swaggerPathOrUrl: string, project: Project, config: GeneratorConfig): Promise<IPluginGenerator>;
+    /**
+     * Constructor signature
+     */
+    new (parser: SwaggerParser, project: Project, config: GeneratorConfig): IPluginGenerator;
+}
+/**
+ * Combined type that includes both static and instance methods
+ */
+type IPluginGeneratorClass = IPluginGeneratorConstructor & {
+    prototype: IPluginGenerator;
+};
+
 interface GeneratorConfig {
     input: string;
     output: string;
@@ -155,6 +217,7 @@ interface GeneratorConfig {
         module?: ModuleKind;
         strict?: boolean;
     };
+    plugins?: (new (...args: any) => IPluginGenerator)[];
 }
 interface NgOpenapiClientConfig {
     clientName: string;
@@ -163,31 +226,53 @@ interface NgOpenapiClientConfig {
     interceptors?: (new (...args: HttpInterceptor[]) => HttpInterceptor)[];
 }
 
-declare class SwaggerParser {
-    private readonly spec;
-    private constructor();
-    static create(swaggerPathOrUrl: string, config: GeneratorConfig): Promise<SwaggerParser>;
-    private static loadContent;
-    private static isUrl;
-    private static fetchUrlContent;
-    private static parseSpecContent;
-    private static detectFormat;
-    getDefinitions(): Record<string, SwaggerDefinition>;
-    getDefinition(name: string): SwaggerDefinition | undefined;
-    resolveReference(ref: string): SwaggerDefinition | undefined;
-    getAllDefinitionNames(): string[];
-    getSpec(): SwaggerSpec;
-    getPaths(): Record<string, any>;
-    isValidSpec(): boolean;
-    getSpecVersion(): {
-        type: "swagger" | "openapi";
-        version: string;
-    } | null;
-}
+declare function camelCase(str: string): string;
+declare function kebabCase(str: string): string;
+declare function pascalCase(str: string): string;
+
+/**
+ * Convert OpenAPI/Swagger types to TypeScript types
+ * @param schemaOrType - Either a schema object or a type string
+ * @param config - generator configuration
+ * @param formatOrNullable - Either format string (if first param is string) or nullable boolean
+ * @param isNullable - Nullable boolean (only used if first param is string)
+ * @param context - Whether this is for type generation or service generation
+ */
+declare function getTypeScriptType(schemaOrType: TypeSchema | string | undefined, config: GeneratorConfig, formatOrNullable?: string | boolean, isNullable?: boolean, context?: "type" | "service"): string;
+declare function nullableType(type: string, isNullable?: boolean): string;
+declare function escapeString(str: string): string;
+
+type placeHolder = {};
+
+declare function collectUsedTypes(operations: PathInfo[]): Set<string>;
+
+declare function getClientContextTokenName(clientName?: string): string;
+declare function getBasePathTokenName(clientName?: string): string;
+
+declare function hasDuplicateFunctionNames<T extends MethodDeclaration | FunctionDeclaration>(arr: T[]): boolean;
+
+declare function extractPaths(swaggerPaths?: {
+    [p: string]: Path;
+}, methods?: string[]): PathInfo[];
+
+declare function getResponseTypeFromResponse(response: SwaggerResponse, responseTypeMapping?: {
+    [p: string]: "json" | "blob" | "arraybuffer" | "text";
+}): "json" | "blob" | "arraybuffer" | "text";
+declare function isPrimitiveType(schema: any): boolean;
+declare function inferResponseTypeFromContentType(contentType: string): "json" | "blob" | "arraybuffer" | "text";
+declare function getResponseType(response: SwaggerResponse, config: GeneratorConfig): string;
+
+declare const TYPE_GENERATOR_HEADER_COMMENT: string;
+declare const SERVICE_INDEX_GENERATOR_HEADER_COMMENT: string;
+declare const SERVICE_GENERATOR_HEADER_COMMENT: (controllerName: string) => string;
+declare const MAIN_INDEX_GENERATOR_HEADER_COMMENT: string;
+declare const PROVIDER_GENERATOR_HEADER_COMMENT: string;
+declare const BASE_INTERCEPTOR_HEADER_COMMENT: (clientName: string) => string;
+declare const HTTP_RESOURCE_GENERATOR_HEADER_COMMENT: (resourceName: string) => string;
 
 /**
  * Generates Angular services and types from a configuration object
  */
 declare function generateFromConfig(config: GeneratorConfig): Promise<void>;
 
-export { type EnumValueObject, type GeneratorConfig, type MethodGenerationContext, type NgOpenapiClientConfig, type Parameter, type PathInfo, type RequestBody, type SwaggerDefinition, SwaggerParser, type SwaggerResponse, type SwaggerSpec, type TypeSchema, generateFromConfig };
+export { BASE_INTERCEPTOR_HEADER_COMMENT, type EnumValueObject, type GeneratorConfig, type GetMethodGenerationContext, HTTP_RESOURCE_GENERATOR_HEADER_COMMENT, type IPluginGenerator, type IPluginGeneratorClass, type IPluginGeneratorConstructor, MAIN_INDEX_GENERATOR_HEADER_COMMENT, type MethodGenerationContext, type NgOpenapiClientConfig, PROVIDER_GENERATOR_HEADER_COMMENT, type Parameter, type PathInfo, type RequestBody, SERVICE_GENERATOR_HEADER_COMMENT, SERVICE_INDEX_GENERATOR_HEADER_COMMENT, type SwaggerDefinition, SwaggerParser, type SwaggerResponse, type SwaggerSpec, TYPE_GENERATOR_HEADER_COMMENT, type TypeSchema, camelCase, collectUsedTypes, escapeString, extractPaths, generateFromConfig, getBasePathTokenName, getClientContextTokenName, getResponseType, getResponseTypeFromResponse, getTypeScriptType, hasDuplicateFunctionNames, inferResponseTypeFromContentType, isPrimitiveType, kebabCase, nullableType, pascalCase, type placeHolder };