codegen-openapi-ts 0.8.0-alpha.9 → 0.9.0-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "codegen-openapi-ts",
-    "version": "0.8.0-alpha.9",
+    "version": "0.9.0-alpha.2",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "devteaa",
     "homepage": "https://github.com/devteaa/codegen-openapi-ts",
@@ -24,89 +24,108 @@
     ],
     "maintainers": [
         {
-            "name": "devteaa",
-            "email": "devtea@protonmail.com"
+            "name": "Ferdi Koomen",
+            "email": "info@madebyferdi.com"
         }
     ],
     "main": "dist/index.js",
-    "types": "dist/index.d.ts",
+    "types": "types/index.d.ts",
     "bin": {
-        "codegen-openapi-ts": "bin/index.js",
-        "codegen-openapi-ts-cli": "bin/cli.js"
+        "openapi": "bin/index.js"
     },
     "files": [
         "bin/index.js",
         "dist/index.js",
-        "dist/index.d.ts"
+        "types/index.d.ts"
     ],
     "scripts": {
         "clean": "rimraf ./dist ./test/generated ./test/e2e/generated ./samples/generated ./coverage ./node_modules/.cache",
         "build": "rollup --config --environment NODE_ENV:development",
         "build:watch": "rollup --config --environment NODE_ENV:development --watch",
         "release": "rollup --config --environment NODE_ENV:production",
-        "run": "NODE_ENV=production node ./test/index.js",
+        "validate": "tsc --project tsconfig.json --noEmit",
+        "run": "node ./test/index.js",
         "test": "jest --selectProjects UNIT",
         "test:update": "jest --selectProjects UNIT --updateSnapshot",
         "test:watch": "jest --selectProjects UNIT --watch",
         "test:coverage": "jest --selectProjects UNIT --coverage",
-        "test:e2e": "jest --selectProjects E2E --runInBand",
-        "eslint": "eslint \"./src/**/*.ts\" \"./bin/index.js\" \"./types/index.d.ts\"",
-        "eslint:fix": "eslint \"./src/**/*.ts\" \"./bin/index.js\" \"./types/index.d.ts\" --fix",
-        "prettier": "prettier \"./src/**/*.ts\" \"./bin/index.js\" \"./types/index.d.ts\" --check",
-        "prettier:fix": "prettier \"./src/**/*.ts\" \"./bin/index.js\" \"./types/index.d.ts\" --write",
-        "prepublishOnly": "yarn run clean && yarn run release",
+        "test:e2e": "jest --selectProjects E2E --runInBand --verbose",
+        "eslint": "eslint .",
+        "eslint:fix": "eslint . --fix",
+        "prepare": "npm run clean && npm run release",
         "codecov": "codecov --token=66c30c23-8954-4892-bef9-fbaed0a2e42b",
+        "docker": "docker build -t eeelenbaas/openapi-typescript-codegen .",
         "deploy-dry": "npm publish --dry-run",
         "deploy-prod": "npm publish && npm version patch",
         "deploy-prerelease": "npm version prerelease && npm publish"
     },
     "dependencies": {
-        "@types/node-fetch": "^2.5.12",
-        "abort-controller": "^3.0.0",
+        "@apidevtools/json-schema-ref-parser": "^10.1.0",
         "api-spec-converter": "^2.12.0",
-        "axios": "^0.24.0",
-        "camelcase": "^6.2.1",
-        "commander": "^8.3.0",
-        "cross-blob": "^2.0.1",
+        "camelcase": "^6.3.0",
+        "commander": "^11.1.0",
         "esm-config": "^1.1.0",
-        "form-data": "^4.0.0",
-        "handlebars": "^4.7.6",
-        "json-schema-ref-parser": "^9.0.7",
-        "mkdirp": "^1.0.4",
-        "node-fetch": "^2.6.5",
-        "rimraf": "^3.0.2",
+        "fs-extra": "^11.2.0",
+        "handlebars": "^4.7.8",
         "shelljs": "^0.8.5"
     },
     "devDependencies": {
-        "@babel/cli": "7.16.0",
-        "@babel/core": "7.16.0",
-        "@babel/preset-env": "7.16.4",
-        "@babel/preset-typescript": "7.16.0",
-        "@rollup/plugin-commonjs": "21.0.1",
-        "@rollup/plugin-node-resolve": "13.0.6",
-        "@types/express": "4.17.13",
-        "@types/glob": "7.2.0",
-        "@types/jest": "^27.0.3",
-        "@types/node": "16.11.11",
-        "@types/qs": "6.9.7",
-        "@typescript-eslint/eslint-plugin": "5.5.0",
-        "@typescript-eslint/parser": "5.5.0",
+        "@angular-devkit/build-angular": "17.0.9",
+        "@angular/animations": "17.0.8",
+        "@angular/cli": "17.0.9",
+        "@angular/common": "17.0.8",
+        "@angular/compiler": "17.0.8",
+        "@angular/compiler-cli": "17.0.8",
+        "@angular/core": "17.0.8",
+        "@angular/forms": "17.0.8",
+        "@angular/platform-browser": "17.0.8",
+        "@angular/platform-browser-dynamic": "17.0.8",
+        "@angular/router": "17.0.8",
+        "@babel/cli": "7.23.9",
+        "@babel/core": "7.23.9",
+        "@babel/preset-env": "7.23.9",
+        "@babel/preset-typescript": "7.23.3",
+        "@rollup/plugin-commonjs": "25.0.7",
+        "@rollup/plugin-node-resolve": "15.2.3",
+        "@rollup/plugin-terser": "^0.4.4",
+        "@rollup/plugin-typescript": "11.1.6",
+        "@types/cross-spawn": "6.0.6",
+        "@types/express": "4.17.21",
+        "@types/fs-extra": "^11.0.4",
+        "@types/glob": "8.1.0",
+        "@types/jest": "29.5.11",
+        "@types/node": "20.11.11",
+        "@types/node-fetch": "2.6.10",
+        "@types/qs": "6.9.11",
+        "@typescript-eslint/eslint-plugin": "6.20.0",
+        "@typescript-eslint/parser": "6.20.0",
+        "abort-controller": "3.0.0",
+        "axios": "1.6.7",
         "codecov": "3.8.3",
-        "eslint": "8.3.0",
-        "eslint-config-prettier": "8.3.0",
-        "eslint-plugin-prettier": "4.0.0",
-        "eslint-plugin-simple-import-sort": "7.0.0",
-        "express": "4.17.1",
-        "glob": "7.2.0",
-        "jest": "27.4.3",
-        "jest-cli": "27.4.3",
-        "prettier": "2.8.4",
-        "puppeteer": "12.0.1",
-        "qs": "6.10.1",
-        "rollup": "2.60.2",
-        "rollup-plugin-terser": "7.0.2",
-        "rollup-plugin-typescript2": "0.31.1",
-        "tslib": "2.3.1",
-        "typescript": "4.5.2"
+        "cross-spawn": "7.0.3",
+        "eslint": "8.56.0",
+        "eslint-config-prettier": "9.1.0",
+        "eslint-plugin-prettier": "5.1.3",
+        "eslint-plugin-simple-import-sort": "10.0.0",
+        "express": "4.18.2",
+        "form-data": "4.0.0",
+        "glob": "10.3.10",
+        "jest": "29.7.0",
+        "jest-cli": "29.7.0",
+        "node-fetch": "2.7.0",
+        "prettier": "3.2.4",
+        "puppeteer": "21.10.0",
+        "qs": "6.11.2",
+        "rimraf": "5.0.5",
+        "rollup": "4.7.0",
+        "rxjs": "7.8.1",
+        "ts-node": "10.9.2",
+        "tslib": "2.6.2",
+        "typescript": "5.2.2",
+        "zone.js": "0.14.3"
+    },
+    "overrides": {
+        "node-fetch": "2.7.0",
+        "rollup": "4.7.0"
     }
 }

package/types/index.d.ts

@@ -0,0 +1,41 @@
+export declare enum HttpClient {
+    FETCH = 'fetch',
+    XHR = 'xhr',
+    NODE = 'node',
+    AXIOS = 'axios',
+    ANGULAR = 'angular',
+}
+
+export declare enum Indent {
+    SPACE_4 = '4',
+    SPACE_2 = '2',
+    TAB = 'tab',
+}
+
+export type Options = {
+    input: string | Record<string, any>;
+    output: string;
+    httpClient?: HttpClient | 'fetch' | 'xhr' | 'node' | 'axios' | 'angular';
+    clientName?: string;
+    useOptions?: boolean;
+    useUnionTypes?: boolean;
+    exportCore?: boolean;
+    exportServices?: boolean;
+    exportModels?: boolean;
+    exportSchemas?: boolean;
+    indent?: Indent | '4' | '2' | 'tab';
+    postfixServices?: string;
+    postfixModels?: string;
+    request?: string;
+    write?: boolean;
+};
+
+export declare function generate(options: Options): Promise<void>;
+
+declare type OpenAPI = {
+    HttpClient: HttpClient;
+    Indent: Indent;
+    generate: typeof generate;
+};
+
+export default OpenAPI;

package/bin/cli.js

@@ -1,27 +0,0 @@
-#!/usr/bin/env node
-
-'use strict';
-
-const path = require('path');
-const program = require('commander');
-const pkg = require('../package.json');
-
-const params = program
-    .name('codegen-openapi-ts-cli')
-    .usage('[options]')
-    .version(pkg.version)
-    .argument('<source>', 'Swagger/OpenAPI response url')
-    .argument('<output>', 'Output folder name')
-    .parse(process.argv)
-    .processedArgs;
-
-const OpenAPI = require(path.resolve(__dirname, '../dist/index.js'));
-
-if (OpenAPI) {
-    OpenAPI.generate({
-      input: params[0],
-      output: params[1],
-      useOptions: true,
-      useUnionTypes: true 
-    })
-}

package/dist/index.d.ts

@@ -1,79 +0,0 @@
-import { ConverterInput } from 'api-spec-converter';
-import { HttpClient } from './HttpClient';
-export { HttpClient } from './HttpClient';
-export declare type Options = {
-    input: string | Record<string, any>;
-    output: string;
-    httpClient?: HttpClient;
-    useOptions?: boolean;
-    useUnionTypes?: boolean;
-    exportCore?: boolean;
-    exportServices?: boolean;
-    exportModels?: boolean;
-    exportSchemas?: boolean;
-    postfix?: 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 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 postfix: Service name postfix
- * @param request: Path to custom request file
- * @param write Write the files to disk (true or false)
- */
-export declare function generate({ input, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, postfix, request, write, selectedOnly, appendTemplate }: Options): Promise<void>;
-/**
- * Generate the OpenAPI client with options to convert swagger to openapi etc.
- * @param converterInput.from The schema specification for the response (swagger_1, swagger_2, openapi_3)
- * @param converterInput.to The schema specification for the output (openapi_3)
- * @param converterInput.source The relative location of the OpenAPI spec
- * @param options.httpClient The selected httpClient (fetch, xhr, node or axios)
- * @param options.useUnionTypes Use union types instead of enums
- * @param options.exportCore: Generate core client classes
- * @param options.exportServices: Generate services
- * @param options.exportModels: Generate models
- * @param options.exportSchemas: Generate schemas
- * @param options.postfix: Service name postfix
- * @param options.request: Path to custom request file
- * @param options.write Write the files to disk (true or false)
- */
-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 = {
-    source: string;
-    from: 'swagger_1' | 'swagger_2' | 'openapi_3' | 'api_blueprint' | 'io_docs' | 'google' | 'raml' | 'wadl';
-    output: string;
-    proxyConfig?: (path: string) => string;
-    modelNameMapping?: (path: string) => string;
-};
-export declare type ServiceConfigDefault = BaseServiceConfig & {
-    urlMethodMapping: undefined;
-    selectedOnly: undefined;
-};
-export declare type ServiceConfigWithMappings = BaseServiceConfig & {
-    urlMethodMapping: {
-        originalUrl: string;
-        method: 'get' | 'post' | 'put' | 'delete';
-        methodName: string;
-        proxyUrl?: string;
-    }[];
-    selectedOnly: boolean;
-};
-export declare function defineConfig(config: {
-    appendTemplate?: string;
-    services: (ServiceConfigDefault | ServiceConfigWithMappings)[];
-}): {
-    appendTemplate?: string | undefined;
-    services: (ServiceConfigDefault | ServiceConfigWithMappings)[];
-};