codegen-openapi-ts 0.8.0-alpha.10 → 0.8.0-alpha.12

package/dist/index.d.ts

@@ -51,18 +51,37 @@ export declare function generate({ input, output, httpClient, useOptions, useUni
  */
 export declare function convertAndGenerate({ from, source }: ConverterInput, { input, output, useOptions, useUnionTypes }: Options, urlMethodMapping?: ServiceConfigWithMappings['urlMethodMapping'], selectedOnly?: ServiceConfigWithMappings['selectedOnly'], modelNameMapping?: BaseServiceConfig['modelNameMapping'], appendTemplate?: ReturnType<typeof defineConfig>['appendTemplate'], proxyConfig?: BaseServiceConfig['proxyConfig']): Promise<void>;
 export declare type BaseServiceConfig = {
+    /**
+     * API Docs request url for the json response
+     */
     source: string;
+    /**
+     * Specify the API specs response format version
+     */
     from: 'swagger_1' | 'swagger_2' | 'openapi_3' | 'api_blueprint' | 'io_docs' | 'google' | 'raml' | 'wadl';
+    /**
+     * Specify the folder for the codegen output
+     */
     output: string;
+    /**
+     * Create a function for proxying the request
+     * @example
+     * {
+     *  // ... other config
+     *  proxyConfig: (path) => {
+     *    return path.replace('/api/', '/be/')
+     *  }
+     * }
+     * @param {string} path
+     */
     proxyConfig?: (path: string) => string;
     /**
      * Can be used to replace long model names specified on the schema.
-     * Please use the api-schema.json generated on root project files
+     * Please use the api-schema.json generated on root project folder
      * to debug the desired results. Also note that the original schema name
      * with dot (.) will be generated as underscore (_). Example:
      * some.long.name will be generated as some_long_name,
      * if this modelNameMapping supplied
-     * @param {string} json: stringified json schema
      * @example
      * {
      *  // ... other config
@@ -71,7 +90,8 @@ export declare type BaseServiceConfig = {
      *    return config.replace(new RegExp('some.long.name', g), 'shortname')
      *  }
      * }
-     * @returns {string}
+     *
+     * @param {string} json - stringified json schema
      */
     modelNameMapping?: (json: string) => string;
 };
@@ -80,16 +100,43 @@ export declare type ServiceConfigDefault = BaseServiceConfig & {
     selectedOnly: undefined;
 };
 export declare type ServiceConfigWithMappings = BaseServiceConfig & {
+    /**
+     * Custom spec paths mapping. You can configure to rename the method name
+     * or customise the proxyUrl for the specific API
+     *
+     * @example
+     * {
+     *  // ... other config
+     *  urlMethodMapping: [
+     *    { originalUrl: '/pokemon-list', method: 'get', methodName: 'GetPokemonList' },
+     *    { originalUrl: '/pokemon-detail/{id}', method: 'get', methodName: 'GetPokemonList', proxyUrl: '/proxy/pokemon-detail/{id}' }
+     *  ]
+     * }
+     *
+     */
     urlMethodMapping: {
         originalUrl: string;
         method: 'get' | 'post' | 'put' | 'delete';
         methodName: string;
         proxyUrl?: string;
     }[];
+    /**
+     * Flag to only generate listed specs based on urlMethodMapping.
+     * The codegen will still generate all the models listed on the api specs
+     */
     selectedOnly: boolean;
 };
+/**
+ * Type helper to make it easier to use codegen.config.js
+ */
 export declare function defineConfig(config: {
+    /**
+     * Custom api templates append on top of service files
+     */
     appendTemplate?: string;
+    /**
+     * List config for every services
+     */
     services: (ServiceConfigDefault | ServiceConfigWithMappings)[];
 }): {
     appendTemplate?: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "codegen-openapi-ts",
-    "version": "0.8.0-alpha.10",
+    "version": "0.8.0-alpha.12",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "devteaa",
     "homepage": "https://github.com/devteaa/codegen-openapi-ts",