@ng-openapi/http-resource 0.0.2-pr-9-feature-http-resource-e6134bb.0

package/index.d.ts

@@ -0,0 +1,221 @@
+import { ScriptTarget, ModuleKind, Project, ClassDeclaration, OptionalKind, ParameterDeclarationStructure, MethodDeclarationOverloadStructure } from 'ts-morph';
+import { Info, ExternalDocs, Path, ParameterType, XML, BodyParameter, QueryParameter, Security, Tag } from 'swagger-schema-official';
+
+interface Parameter {
+    name: string;
+    in: "query" | "path" | "header" | "cookie";
+    required?: boolean;
+    schema?: any;
+    type?: string;
+    format?: string;
+    description?: string;
+}
+interface PathInfo {
+    path: string;
+    method: string;
+    operationId?: string;
+    summary?: string;
+    description?: string;
+    tags?: string[];
+    parameters?: Parameter[];
+    requestBody?: RequestBody;
+    responses?: Record<string, SwaggerResponse>;
+}
+interface RequestBody {
+    required?: boolean;
+    content?: Record<string, {
+        schema?: SwaggerDefinition;
+    }>;
+}
+interface SwaggerResponse {
+    description?: string;
+    content?: Record<string, {
+        schema?: any;
+    }>;
+}
+interface SwaggerDefinition {
+    type?: ParameterType | undefined;
+    format?: string | undefined;
+    title?: string | undefined;
+    description?: string | undefined;
+    default?: any;
+    multipleOf?: number | undefined;
+    maximum?: number | undefined;
+    exclusiveMaximum?: boolean | undefined;
+    minimum?: number | undefined;
+    exclusiveMinimum?: boolean | undefined;
+    maxLength?: number | undefined;
+    minLength?: number | undefined;
+    pattern?: string | undefined;
+    maxItems?: number | undefined;
+    minItems?: number | undefined;
+    uniqueItems?: boolean | undefined;
+    maxProperties?: number | undefined;
+    minProperties?: number | undefined;
+    enum?: any[] | undefined;
+    items?: SwaggerDefinition | SwaggerDefinition[] | undefined;
+    $ref?: string | undefined;
+    allOf?: SwaggerDefinition[] | undefined;
+    additionalProperties?: SwaggerDefinition | boolean | undefined;
+    properties?: {
+        [propertyName: string]: SwaggerDefinition;
+    } | undefined;
+    discriminator?: string | undefined;
+    readOnly?: boolean | undefined;
+    nullable?: boolean | undefined;
+    xml?: XML | undefined;
+    externalDocs?: ExternalDocs | undefined;
+    example?: any;
+    required?: string[] | undefined;
+    oneOf?: SwaggerDefinition[];
+    anyOf?: SwaggerDefinition[];
+}
+interface SwaggerSpec {
+    openapi: string;
+    swagger: string;
+    info: Info;
+    externalDocs?: ExternalDocs | undefined;
+    host?: string | undefined;
+    basePath?: string | undefined;
+    schemes?: string[] | undefined;
+    consumes?: string[] | undefined;
+    produces?: string[] | undefined;
+    paths: {
+        [pathName: string]: Path;
+    };
+    definitions?: {
+        [definitionsName: string]: SwaggerDefinition;
+    } | undefined;
+    parameters?: {
+        [parameterName: string]: BodyParameter | QueryParameter;
+    } | undefined;
+    responses?: {
+        [responseName: string]: SwaggerResponse;
+    } | undefined;
+    security?: Array<{
+        [securityDefinitionName: string]: string[];
+    }> | undefined;
+    securityDefinitions?: {
+        [securityDefinitionName: string]: Security;
+    } | undefined;
+    tags?: Tag[] | undefined;
+    components?: {
+        schemas?: Record<string, SwaggerDefinition>;
+    };
+}
+
+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 GeneratorConfig {
+    input: string;
+    output: string;
+    clientName?: string;
+    validateInput?: (spec: SwaggerSpec) => boolean;
+    options: {
+        dateType: "string" | "Date";
+        enumStyle: "enum" | "union";
+        generateServices?: boolean;
+        generateEnumBasedOnDescription?: boolean;
+        customHeaders?: Record<string, string>;
+        responseTypeMapping?: {
+            [contentType: string]: "json" | "blob" | "arraybuffer" | "text";
+        };
+        customizeMethodName?: (operationId: string) => string;
+    };
+    compilerOptions?: {
+        declaration?: boolean;
+        target?: ScriptTarget;
+        module?: ModuleKind;
+        strict?: boolean;
+    };
+    plugins?: (new (...args: any) => IPluginGenerator)[];
+}
+
+declare class HttpResourceGenerator implements IPluginGenerator {
+    private project;
+    private parser;
+    private spec;
+    private config;
+    private methodGenerator;
+    private indexGenerator;
+    constructor(parser: SwaggerParser, project: Project, config: GeneratorConfig);
+    static create(swaggerPathOrUrl: string, project: Project, config: GeneratorConfig): Promise<HttpResourceGenerator>;
+    generate(outputRoot: string): void;
+    private groupPathsByController;
+    private generateServiceFile;
+    private addImports;
+    private addServiceClass;
+}
+
+declare class HttpResourceMethodGenerator {
+    #private;
+    private config;
+    private bodyGenerator;
+    private paramsGenerator;
+    constructor(config: GeneratorConfig);
+    addResourceMethod(serviceClass: ClassDeclaration, operation: PathInfo): void;
+    generateMethodName(operation: PathInfo): string;
+    generateReturnType(operation: PathInfo): string;
+    generateMethodOverload(methodParams: OptionalKind<ParameterDeclarationStructure>[]): OptionalKind<MethodDeclarationOverloadStructure>[];
+}
+
+declare class HttpResourceIndexGenerator {
+    private project;
+    constructor(project: Project);
+    generateIndex(outputRoot: string): void;
+}
+
+declare class HttpResourceMethodBodyGenerator {
+    private config;
+    constructor(config: GeneratorConfig);
+    generateMethodBody(operation: PathInfo): string;
+    private createGenerationContext;
+    private generateUrl;
+    private generateQueryParams;
+    private generateHeaders;
+    private generateRequestOptions;
+    private generateHttpResource;
+    private determineResponseType;
+}
+
+declare class HttpResourceMethodParamsGenerator {
+    private config;
+    constructor(config: GeneratorConfig);
+    generateMethodParameters(operation: PathInfo): OptionalKind<ParameterDeclarationStructure>[];
+    generateApiParameters(operation: PathInfo): OptionalKind<ParameterDeclarationStructure>[];
+    addOptionsParameter(responseType: string): OptionalKind<ParameterDeclarationStructure>[];
+    private getApiReturnType;
+    private getResourceRawDataType;
+}
+
+export { HttpResourceGenerator, HttpResourceIndexGenerator, HttpResourceMethodBodyGenerator, HttpResourceMethodGenerator, HttpResourceMethodParamsGenerator };