codegen-openapi-ts 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -0,0 +1,157 @@
+declare enum HttpClient {
+    FETCH = "fetch",
+    XHR = "xhr",
+    NODE = "node",
+    AXIOS = "axios"
+}
+
+declare enum Indent {
+    SPACE_4 = "4",
+    SPACE_2 = "2",
+    TAB = "tab"
+}
+
+type Options = {
+    input: string | Record<string, any>;
+    output: string;
+    httpClient?: HttpClient;
+    clientName?: string;
+    useOptions?: boolean;
+    useUnionTypes?: boolean;
+    exportCore?: boolean;
+    exportServices?: boolean;
+    exportModels?: boolean;
+    exportSchemas?: boolean;
+    indent?: Indent;
+    postfixServices?: string;
+    postfixModels?: string;
+    request?: string;
+    write?: boolean;
+    selectedOnly?: boolean;
+    appendTemplate?: ReturnType<typeof defineConfig>['appendTemplate'];
+};
+/**
+ * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the
+ * given language it will generate the client, including the typed models, validation schemas,
+ * service layer, etc.
+ * @param input The relative location of the OpenAPI spec
+ * @param output The relative location of the output directory
+ * @param httpClient The selected httpClient (fetch, xhr, node or axios)
+ * @param clientName Custom client class name
+ * @param useOptions Use options or arguments functions
+ * @param useUnionTypes Use union types instead of enums
+ * @param exportCore Generate core client classes
+ * @param exportServices Generate services
+ * @param exportModels Generate models
+ * @param exportSchemas Generate schemas
+ * @param indent Indentation options (4, 2 or tab)
+ * @param postfixServices Service name postfix
+ * @param postfixModels Model name postfix
+ * @param request Path to custom request file
+ * @param write Write the files to disk (true or false)
+ */
+declare const generate: ({ input, output, httpClient, clientName, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, indent, postfixServices, postfixModels, request, write, selectedOnly, appendTemplate, }: Options) => Promise<void>;
+declare const _default: {
+    HttpClient: typeof HttpClient;
+    generate: ({ input, output, httpClient, clientName, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, indent, postfixServices, postfixModels, request, write, selectedOnly, appendTemplate, }: Options) => Promise<void>;
+};
+
+declare function convertAndGenerate({ from, source }: {
+    from: string;
+    source: string;
+}, { input, output, useOptions, useUnionTypes }: Options, urlMethodMapping?: ServiceConfigWithMappings['urlMethodMapping'], selectedOnly?: ServiceConfigWithMappings['selectedOnly'], modelNameMapping?: BaseServiceConfig['modelNameMapping'], appendTemplate?: ReturnType<typeof defineConfig>['appendTemplate'], proxyConfig?: BaseServiceConfig['proxyConfig']): Promise<void>;
+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 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
+     * @example
+     * {
+     *  // ... other config
+     *  modelNameMapping: (json) => {
+     *    // remember to use global flag to all regexp used here
+     *    return config.replace(new RegExp('some.long.name', g), 'shortname')
+     *  }
+     * }
+     *
+     * @param {string} json - stringified json schema
+     */
+    modelNameMapping?: (json: string) => string;
+};
+type ServiceConfigDefault = BaseServiceConfig & {
+    urlMethodMapping: undefined;
+    selectedOnly: undefined;
+};
+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
+ */
+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;
+    services: (ServiceConfigDefault | ServiceConfigWithMappings)[];
+};
+
+export { HttpClient, Indent, convertAndGenerate, _default as default, defineConfig, generate };
+export type { BaseServiceConfig, Options, ServiceConfigDefault, ServiceConfigWithMappings };