@moccona/apicodegen 0.0.1 → 0.0.3

package/npm/index.d.cts

@@ -154,7 +154,7 @@ interface ProviderInitResult {
 
 /**
  * @file Adapter abstract class definition
- * @author [Your Name]
+ * @author wp.l
  * @description Base adapter implementation for various code generation tools
  */
 
@@ -200,7 +200,7 @@ declare abstract class Adapter {
 
 /**
  * @file Base class implementation
- * @author [Your Name]
+ * @author wp.l
  * @description Base utility class providing common methods for code generation and API handling
  */
 
@@ -239,7 +239,7 @@ declare abstract class Base {
      * @param [operationId] - Unique identifier for the operation.
      * @returns - The generated function name.
      */
-    static pathToFnName(path: string, method?: string, operationId?: string): string;
+    static pathToFnName(path: string, method?: string, _operationId?: string): string;
     /**
      * Normalizes a string by replacing special characters and avoiding TypeScript keywords.
      * @param text - Input text to normalize.
@@ -314,13 +314,13 @@ declare abstract class Base {
      * @param schema - The object to check.
      * @returns - True if the object is a reference.
      */
-    static isRef(schema: any): schema is ReferenceObject;
+    static isRef(schema: unknown): schema is ReferenceObject;
 }
 
 /**
- * @file Provider abstract class.
- * This file defines the `Provider` abstract class, which serves as a base for providers responsible for parsing
- * and processing API documentation.
+ * @file Base class implementation
+ * @author wp.l
+ * @description This file defines the `Provider` abstract class, which serves as a base for providers responsible for parsing and processing API documentation.
  */
 
 /**
@@ -488,7 +488,7 @@ declare class Generator {
      * @param path - The base path string containing placeholders.
      * @param parameters - Array of parameter objects defining the parameters.
      * @param basePath - Optional base path to prepend (default: "").
-     * @returns A TypeScript template expression node.
+     * @returns A TypeScript template expressi
      */
     static toUrlTemplate(path: string, parameters: ParameterObject[], basePath?: string): typescript.NoSubstitutionTemplateLiteral | typescript.TemplateExpression;
     /**
@@ -507,7 +507,7 @@ declare class Generator {
     static isBinarySchema(schema: SchemaObject): boolean;
     static toRequestBodyTypeNode(schema: SchemaObject): ParameterDeclaration;
     static toTypeNode(schema: SchemaObject): TypeNode;
-    static toDeclarationNode(parameters: ParameterObject[]): ParameterDeclaration;
+    static toDeclarationNodes(parameters: ParameterObject[]): ParameterDeclaration[];
     static toFormDataStatement(parameters: ParameterObject[], requestBody?: SchemaObject): Statement[];
     static bodyBlock(uri: string, method: string, parameters: ParameterObject[], requestBody: MediaTypeObject | undefined, response: MediaTypeObject | undefined, adapter: Adapter): Block;
     static schemaToStatemets(parsedDoc: ProviderInitResult, adaptor: Adapter, options: Omit<ProviderInitOptions, "docURL" | "output" | "requestOptions">): Statement[];
@@ -530,7 +530,7 @@ type apiCodeGenPluginOptions = ProviderInitOptions & {
     name: string;
     proxy?: ServerOptions["proxy"];
 };
-declare const tsc: () => Promise<void>;
+declare const tsc: (path: string) => Promise<void>;
 declare function apiCodeGenPlugin(options: apiCodeGenPluginOptions[]): PluginOption;
 
 export { Adapter, Adaptors, ArraySchemaType, type ArrayTypeSchemaObject, AxiosAdapter, Base, type CommentObject, type Comments, type EnumSchemaObject, FetchAdapter, type FetchDocRequestInit, Generator, HttpMethods, type JSONValue, type MediaTypeObject, MediaTypes, NonArraySchemaType, OpenAPIProvider, OpenAPIVersion, type OperationObject, ParameterIn, type ParameterObject, type PathObject, type PathsObject, Provider, type ProviderInitOptions, type ProviderInitResult, type ReferenceObject, type RequestBodyObject, type ResponsesObject, SchemaFormatType, type SchemaObject, SchemaType, type SingleTypeSchemaObject, SuccessHttpStatusCode, apiCodeGenPlugin, type apiCodeGenPluginOptions, codeGen, tsc };

package/npm/index.d.ts

@@ -154,7 +154,7 @@ interface ProviderInitResult {
 
 /**
  * @file Adapter abstract class definition
- * @author [Your Name]
+ * @author wp.l
  * @description Base adapter implementation for various code generation tools
  */
 
@@ -200,7 +200,7 @@ declare abstract class Adapter {
 
 /**
  * @file Base class implementation
- * @author [Your Name]
+ * @author wp.l
  * @description Base utility class providing common methods for code generation and API handling
  */
 
@@ -239,7 +239,7 @@ declare abstract class Base {
      * @param [operationId] - Unique identifier for the operation.
      * @returns - The generated function name.
      */
-    static pathToFnName(path: string, method?: string, operationId?: string): string;
+    static pathToFnName(path: string, method?: string, _operationId?: string): string;
     /**
      * Normalizes a string by replacing special characters and avoiding TypeScript keywords.
      * @param text - Input text to normalize.
@@ -314,13 +314,13 @@ declare abstract class Base {
      * @param schema - The object to check.
      * @returns - True if the object is a reference.
      */
-    static isRef(schema: any): schema is ReferenceObject;
+    static isRef(schema: unknown): schema is ReferenceObject;
 }
 
 /**
- * @file Provider abstract class.
- * This file defines the `Provider` abstract class, which serves as a base for providers responsible for parsing
- * and processing API documentation.
+ * @file Base class implementation
+ * @author wp.l
+ * @description This file defines the `Provider` abstract class, which serves as a base for providers responsible for parsing and processing API documentation.
  */
 
 /**
@@ -488,7 +488,7 @@ declare class Generator {
      * @param path - The base path string containing placeholders.
      * @param parameters - Array of parameter objects defining the parameters.
      * @param basePath - Optional base path to prepend (default: "").
-     * @returns A TypeScript template expression node.
+     * @returns A TypeScript template expressi
      */
     static toUrlTemplate(path: string, parameters: ParameterObject[], basePath?: string): typescript.NoSubstitutionTemplateLiteral | typescript.TemplateExpression;
     /**
@@ -507,7 +507,7 @@ declare class Generator {
     static isBinarySchema(schema: SchemaObject): boolean;
     static toRequestBodyTypeNode(schema: SchemaObject): ParameterDeclaration;
     static toTypeNode(schema: SchemaObject): TypeNode;
-    static toDeclarationNode(parameters: ParameterObject[]): ParameterDeclaration;
+    static toDeclarationNodes(parameters: ParameterObject[]): ParameterDeclaration[];
     static toFormDataStatement(parameters: ParameterObject[], requestBody?: SchemaObject): Statement[];
     static bodyBlock(uri: string, method: string, parameters: ParameterObject[], requestBody: MediaTypeObject | undefined, response: MediaTypeObject | undefined, adapter: Adapter): Block;
     static schemaToStatemets(parsedDoc: ProviderInitResult, adaptor: Adapter, options: Omit<ProviderInitOptions, "docURL" | "output" | "requestOptions">): Statement[];
@@ -530,7 +530,7 @@ type apiCodeGenPluginOptions = ProviderInitOptions & {
     name: string;
     proxy?: ServerOptions["proxy"];
 };
-declare const tsc: () => Promise<void>;
+declare const tsc: (path: string) => Promise<void>;
 declare function apiCodeGenPlugin(options: apiCodeGenPluginOptions[]): PluginOption;
 
 export { Adapter, Adaptors, ArraySchemaType, type ArrayTypeSchemaObject, AxiosAdapter, Base, type CommentObject, type Comments, type EnumSchemaObject, FetchAdapter, type FetchDocRequestInit, Generator, HttpMethods, type JSONValue, type MediaTypeObject, MediaTypes, NonArraySchemaType, OpenAPIProvider, OpenAPIVersion, type OperationObject, ParameterIn, type ParameterObject, type PathObject, type PathsObject, Provider, type ProviderInitOptions, type ProviderInitResult, type ReferenceObject, type RequestBodyObject, type ResponsesObject, SchemaFormatType, type SchemaObject, SchemaType, type SingleTypeSchemaObject, SuccessHttpStatusCode, apiCodeGenPlugin, type apiCodeGenPluginOptions, codeGen, tsc };