@spec2ts/openapi 2.0.0 → 3.0.1

package/cli/command.js

@@ -51,7 +51,7 @@ exports.builder = builder;
 async function handler(options) {
     const files = await core_1.cli.findFiles(options.input);
     for (const file of files) {
-        const ast = await openapi_parser_1.parseOpenApiFile(file, options);
+        const ast = await (0, openapi_parser_1.parseOpenApiFile)(file, options);
         const content = core_1.printer.printNodes(ast.all);
         const output = core_1.cli.getOutputPath(file, options);
         await core_1.cli.mkdirp(output);

package/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/core-parser.d.ts

@@ -1,5 +1,5 @@
 import * as ts from "typescript";
-import { SchemaObject, ReferenceObject, PathItemObject, OperationObject, ParameterObject, ContentObject } from "openapi3-ts";
+import type { SchemaObject, ReferenceObject, PathItemObject, OperationObject, ParameterObject, ContentObject } from "openapi3-ts/oas30";
 import { ParserContext, ParsedReference } from "@spec2ts/jsonschema/lib/core-parser";
 import type { ParseOpenApiOptions } from "./openapi-parser";
 export interface ParseOpenApiResult {
@@ -18,7 +18,7 @@ export interface OApiParserContext extends ParserContext {
 }
 export declare function parsePathItem(path: string, item: PathItemObject, context: OApiParserContext, result: ParseOpenApiResult): void;
 export declare function parseOperation(path: string, verb: string, operation: OperationObject, baseParams: ParsedParams | undefined, context: OApiParserContext, result: ParseOpenApiResult): void;
-export declare type ParamType = "params" | "headers" | "query" | "cookie";
+export type ParamType = "params" | "headers" | "query" | "cookie";
 export declare function parseParameters(baseName: string, data: Array<ReferenceObject | ParameterObject>, baseParams: ParsedParams | undefined, context: OApiParserContext, result: ParseOpenApiResult): ParsedParams;
 export declare function parseReference(ref: ParsedReference, context: ParserContext): void;
 export declare function getContentDeclaration(name: string, content: ReferenceObject | ContentObject | undefined, context: OApiParserContext): ts.Statement | undefined;

package/lib/core-parser.js

@@ -6,16 +6,10 @@ const core = require("@spec2ts/core");
 const core_parser_1 = require("@spec2ts/jsonschema/lib/core-parser");
 const VERBS = ["GET", "PUT", "POST", "DELETE", "OPTIONS", "HEAD", "PATCH", "TRACE"];
 function parsePathItem(path, item, context, result) {
-    let baseParams;
-    if (item.parameters) {
-        baseParams = parseParameters(getPathName(path, context), item.parameters, undefined, context, result);
-    }
-    Object.keys(item).forEach(verb => {
-        const method = verb.toUpperCase();
-        if (!VERBS.includes(method))
-            return;
-        parseOperation(path, verb, item[verb], baseParams, context, result);
-    });
+    const baseParams = item.parameters && parseParameters(getPathName(path, context), item.parameters, undefined, context, result);
+    Object.entries(item)
+        .filter(([verb,]) => VERBS.includes(verb.toUpperCase()))
+        .forEach(([verb, entry]) => parseOperation(path, verb, entry, baseParams, context, result));
 }
 exports.parsePathItem = parsePathItem;
 function parseOperation(path, verb, operation, baseParams, context, result) {
@@ -24,16 +18,16 @@ function parseOperation(path, verb, operation, baseParams, context, result) {
         parseParameters(name, operation.parameters, baseParams, context, result);
     }
     if (operation.requestBody) {
-        const requestBody = core_parser_1.resolveReference(operation.requestBody, context);
+        const requestBody = (0, core_parser_1.resolveReference)(operation.requestBody, context);
         const decla = getContentDeclaration(name + "Body", requestBody.content, context);
         if (decla) {
             addToOpenApiResult(result, "body", decla);
         }
     }
     if (operation.responses) {
-        const responses = core_parser_1.resolveReference(operation.responses, context);
-        Object.keys(responses).forEach(status => {
-            const response = core_parser_1.resolveReference(responses[status], context);
+        const responses = (0, core_parser_1.resolveReference)(operation.responses, context);
+        Object.entries(responses).forEach(([status, responseObj]) => {
+            const response = (0, core_parser_1.resolveReference)(responseObj, context);
             const decla = getContentDeclaration(getResponseName(name, status, context), response.content, context);
             if (decla) {
                 addToOpenApiResult(result, "responses", decla);
@@ -49,7 +43,7 @@ function parseParameters(baseName, data, baseParams = {}, context, result) {
     const cookie = [];
     const res = {};
     data.forEach(item => {
-        item = core_parser_1.resolveReference(item, context);
+        item = (0, core_parser_1.resolveReference)(item, context);
         switch (item.in) {
             case "path":
                 params.push(item);
@@ -73,7 +67,7 @@ function parseParameters(baseName, data, baseParams = {}, context, result) {
     function addParams(params, paramType) {
         if (!params.length)
             return;
-        const name = baseName + core_parser_1.pascalCase(paramType);
+        const name = baseName + (0, core_parser_1.pascalCase)(paramType);
         const type = getParamType(paramType, params, baseParams[paramType], context);
         addToOpenApiResult(result, paramType, core.createTypeOrInterfaceDeclaration({
             modifiers: [core.modifier.export],
@@ -85,7 +79,7 @@ function parseParameters(baseName, data, baseParams = {}, context, result) {
 }
 exports.parseParameters = parseParameters;
 function parseReference(ref, context) {
-    const type = core_parser_1.getTypeFromSchema(ref.schema, core_parser_1.createRefContext(ref, context));
+    const type = (0, core_parser_1.getTypeFromSchema)(ref.schema, (0, core_parser_1.createRefContext)(ref, context));
     context.aliases.push(core.createTypeOrInterfaceDeclaration({
         modifiers: [core.modifier.export],
         name: ref.name,
@@ -98,11 +92,11 @@ exports.parseReference = parseReference;
 function getContentDeclaration(name, content, context) {
     if (!content)
         return;
-    content = core_parser_1.resolveReference(content, context);
+    content = (0, core_parser_1.resolveReference)(content, context);
     const schema = getSchemaFromContent(content);
     if (!schema)
         return;
-    const type = core_parser_1.getTypeFromSchema(schema, context);
+    const type = (0, core_parser_1.getTypeFromSchema)(schema, context);
     return core.createTypeOrInterfaceDeclaration({
         modifiers: [core.modifier.export],
         name,
@@ -126,7 +120,7 @@ function getParamType(paramType, data, baseType, context) {
     const ctx = paramType === "query" && typeof context.options.enableDateForQueryParams !== "undefined"
         ? { ...context, options: { ...context.options, enableDate: context.options.enableDateForQueryParams } }
         : context;
-    const type = core_parser_1.getTypeFromProperties(props, required, false, ctx);
+    const type = (0, core_parser_1.getTypeFromProperties)(props, required, false, ctx);
     if (baseType) {
         return ts.factory.createIntersectionTypeNode([baseType, type]);
     }
@@ -135,7 +129,10 @@ function getParamType(paramType, data, baseType, context) {
 exports.getParamType = getParamType;
 function getSchemaFromContent(content) {
     var _a, _b, _c, _d;
-    return ((_a = content === null || content === void 0 ? void 0 : content["application/json"]) === null || _a === void 0 ? void 0 : _a.schema) || ((_b = content === null || content === void 0 ? void 0 : content["application/x-www-form-urlencoded"]) === null || _b === void 0 ? void 0 : _b.schema) || ((_c = content === null || content === void 0 ? void 0 : content["multipart/form-data"]) === null || _c === void 0 ? void 0 : _c.schema) || ((_d = content === null || content === void 0 ? void 0 : content["*/*"]) === null || _d === void 0 ? void 0 : _d.schema);
+    return ((_a = content === null || content === void 0 ? void 0 : content["application/json"]) === null || _a === void 0 ? void 0 : _a.schema) ||
+        ((_b = content === null || content === void 0 ? void 0 : content["application/x-www-form-urlencoded"]) === null || _b === void 0 ? void 0 : _b.schema) ||
+        ((_c = content === null || content === void 0 ? void 0 : content["multipart/form-data"]) === null || _c === void 0 ? void 0 : _c.schema) ||
+        ((_d = content === null || content === void 0 ? void 0 : content["*/*"]) === null || _d === void 0 ? void 0 : _d.schema);
 }
 exports.getSchemaFromContent = getSchemaFromContent;
 function getResponseName(operationName, statusCode, context) {
@@ -152,7 +149,7 @@ function getResponseName(operationName, statusCode, context) {
     }
     else {
         // default
-        name += core_parser_1.pascalCase(statusCode);
+        name += (0, core_parser_1.pascalCase)(statusCode);
     }
     return name;
 }
@@ -167,7 +164,7 @@ function getOperationName(verb, path, operationId, context) {
 exports.getOperationName = getOperationName;
 function getPathName(path, context) {
     path = path.replace(/\{(.+?)\}/, "by $1").replace(/\{(.+?)\}/g, "and $1");
-    let name = core_parser_1.pascalCase(path);
+    let name = (0, core_parser_1.pascalCase)(path);
     const count = (context.names[name] = (context.names[name] || 0) + 1);
     if (count > 1) {
         name += count;
@@ -180,7 +177,7 @@ function getOperationIdentifier(id) {
         return;
     if (id.match(/[^\w\s]/))
         return;
-    id = core_parser_1.pascalCase(id);
+    id = (0, core_parser_1.pascalCase)(id);
     if (core.isValidIdentifier(id))
         return id;
 }

package/lib/openapi-parser.d.ts

@@ -1,4 +1,4 @@
-import type { OpenAPIObject } from "openapi3-ts";
+import type { OpenAPIObject } from "openapi3-ts/oas30";
 import { ParserOptions } from "@spec2ts/jsonschema/lib/core-parser";
 import { ParseOpenApiResult } from "./core-parser";
 export { ParseOpenApiResult };

package/lib/openapi-parser.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseOpenApi = exports.parseOpenApiFile = void 0;
 const path = require("path");
-const $RefParser = require("@apidevtools/json-schema-ref-parser");
+const json_schema_ref_parser_1 = require("@apidevtools/json-schema-ref-parser");
 const core_parser_1 = require("@spec2ts/jsonschema/lib/core-parser");
 const core_parser_2 = require("./core-parser");
 async function parseOpenApiFile(file, options = {}) {
-    const schema = await $RefParser.parse(file);
+    const schema = await json_schema_ref_parser_1.default.parse(file);
     return parseOpenApi(schema, {
         cwd: path.resolve(path.dirname(file)) + "/",
         ...options
@@ -17,12 +17,12 @@ async function parseOpenApi(spec, options = {}) {
     if (!options.parseReference) {
         options.parseReference = core_parser_2.parseReference;
     }
-    const context = await core_parser_1.createContext(spec, options);
-    const result = core_parser_2.createOpenApiResult();
-    Object.keys(spec.paths).forEach(path => {
-        core_parser_2.parsePathItem(path, spec.paths[path], context, result);
+    const context = await (0, core_parser_1.createContext)(spec, options);
+    const result = (0, core_parser_2.createOpenApiResult)();
+    Object.entries(spec.paths).forEach(([path, item]) => {
+        (0, core_parser_2.parsePathItem)(path, item, context, result);
     });
-    core_parser_2.addToOpenApiResult(result, "models", context.aliases);
+    (0, core_parser_2.addToOpenApiResult)(result, "models", context.aliases);
     return result;
 }
 exports.parseOpenApi = parseOpenApi;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spec2ts/openapi",
-    "version": "2.0.0",
+    "version": "3.0.1",
     "description": "Utility to convert OpenAPI v3 specifications to Typescript using TypeScript native compiler",
     "author": "Touchify <dev@touchify.co>",
     "license": "MIT",
@@ -32,23 +32,23 @@
         "test:jest": "jest -c ../../jest.config.js --rootDir .",
         "test:coverage": "npm run test -- -- --coverage",
         "lint": "npm run lint:ts",
-        "lint:ts": "eslint \"*.ts\" \"{bin,cli,lib}/**/*.ts\"",
+        "lint:ts": "eslint '*.ts' '{bin,cli,lib}/**/*.ts'",
         "lint:fix": "npm run lint -- -- --fix",
         "clean": "npm run clean:ts",
-        "clean:ts": "del *.{js,d.ts} {bin,cli,lib}/**/*.{js,d.ts}",
+        "clean:ts": "del '*.{js,d.ts}' '{bin,cli,lib}/**/*.{js,d.ts}'",
         "prepublishOnly": "npm test && npm run build"
     },
     "dependencies": {
-        "@spec2ts/core": "^2.0.0",
-        "@spec2ts/jsonschema": "^2.0.0",
-        "openapi3-ts": "^1.3.0",
-        "yargs": "^15.3.1"
+        "@spec2ts/core": "^3.0.0",
+        "@spec2ts/jsonschema": "^3.0.1",
+        "openapi3-ts": "^4.1.2",
+        "yargs": "^17.7.2"
     },
     "devDependencies": {
-        "del-cli": "^5.0.0",
-        "eslint": "^7.11.0",
-        "jest": "^26.5.3",
-        "typescript": "^4.0.0"
+        "del-cli": "^5.1.0",
+        "eslint": "^8.49.0",
+        "jest": "^29.6.4",
+        "typescript": "^5.2.2"
     },
     "keywords": [
         "openapi",
@@ -65,5 +65,5 @@
         "spec2ts",
         "share"
     ],
-    "gitHead": "34fe406a4701ba1b7c173d3580e85f65e2950012"
+    "gitHead": "bb551ca5222ea751290b8d78577d4a571a8b03cb"
 }

package/CHANGELOG.md

@@ -1,227 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [2.0.0](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@2.0.0-beta.8...@spec2ts/openapi@2.0.0) (2023-09-07)
-
-**Note:** Version bump only for package @spec2ts/openapi
-
-
-
-
-
-# [2.0.0-beta.8](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@2.0.0-beta.7...@spec2ts/openapi@2.0.0-beta.8) (2022-09-21)
-
-
-### Features
-
-* **openapi:** add option to disable date parsing in querystring ([e69547f](https://github.com/touchifyapp/spec2ts/commit/e69547ffdeb87cebe18cb622eee1d46829b35ad4))
-
-
-
-
-
-# [2.0.0-beta.7](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@2.0.0-beta.6...@spec2ts/openapi@2.0.0-beta.7) (2022-07-29)
-
-**Note:** Version bump only for package @spec2ts/openapi
-
-
-
-
-
-# [2.0.0-beta.6](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@2.0.0-beta.5...@spec2ts/openapi@2.0.0-beta.6) (2022-01-27)
-
-**Note:** Version bump only for package @spec2ts/openapi
-
-
-
-
-
-# [2.0.0-beta.5](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@2.0.0-beta.4...@spec2ts/openapi@2.0.0-beta.5) (2021-11-03)
-
-**Note:** Version bump only for package @spec2ts/openapi
-
-
-
-
-
-# [2.0.0-beta.4](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@2.0.0-beta.3...@spec2ts/openapi@2.0.0-beta.4) (2021-10-23)
-
-
-### Features
-
-* allow --ext option to specify output extension ([4c70ca1](https://github.com/touchifyapp/spec2ts/commit/4c70ca13f3fc12ce1fd16c0430c7f90f90b0ed64))
-
-
-
-
-
-# [2.0.0-beta.3](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@2.0.0-beta.2...@spec2ts/openapi@2.0.0-beta.3) (2021-02-27)
-
-
-### Bug Fixes
-
-* **jsonschema:** avoid external references duplication ([9508d9e](https://github.com/touchifyapp/spec2ts/commit/9508d9eee0ae19523d03a2874bad73808ec5bf71))
-
-
-
-
-
-# [2.0.0-beta.2](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@2.0.0-beta.1...@spec2ts/openapi@2.0.0-beta.2) (2020-11-29)
-
-
-### Bug Fixes
-
-* **openapi:** bad yargs options for enableDate ([84e7ec9](https://github.com/touchifyapp/spec2ts/commit/84e7ec9977d910b71e0e6e20b5eacc113b89d24b))
-
-
-
-
-
-# [2.0.0-beta.1](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@2.0.0-beta.0...@spec2ts/openapi@2.0.0-beta.1) (2020-11-29)
-
-
-### Features
-
-* **openapi:** add support for new lax date style ([4d7eb0b](https://github.com/touchifyapp/spec2ts/commit/4d7eb0baad32e83c7f9cbf4feeec01cd34ec3be3))
-
-
-
-
-
-# [2.0.0-beta.0](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@1.2.4...@spec2ts/openapi@2.0.0-beta.0) (2020-11-13)
-
-
-### Features
-
-* **global:** upgrade typescript 4 ([#16](https://github.com/touchifyapp/spec2ts/issues/16)) ([fcd82be](https://github.com/touchifyapp/spec2ts/commit/fcd82be93be3986a2f723680f1c52818eb7ba1bc))
-
-
-### BREAKING CHANGES
-
-* **global:** use typescript v4
-* **global:** updates are now immutable
-
-
-
-
-
-## [1.2.4](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@1.2.3...@spec2ts/openapi@1.2.4) (2020-10-26)
-
-
-### Bug Fixes
-
-* **jsonschema,openapi:** cover more nested refs cases ([1badafb](https://github.com/touchifyapp/spec2ts/commit/1badafbe0865a186ef5fc92bfc0ab5b334d4fa6e))
-
-
-
-
-
-## [1.2.3](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@1.2.2...@spec2ts/openapi@1.2.3) (2020-10-26)
-
-
-### Bug Fixes
-
-* **jsonschema,openapi:** nested references not resolved ([9825a40](https://github.com/touchifyapp/spec2ts/commit/9825a405630c101e7a70452ce3a18e02ccad9ce8)), closes [#15](https://github.com/touchifyapp/spec2ts/issues/15)
-
-
-
-
-
-## [1.2.2](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@1.2.1...@spec2ts/openapi@1.2.2) (2020-10-06)
-
-
-### Bug Fixes
-
-* **openapi:** resolve response reference ([29e7ee5](https://github.com/touchifyapp/spec2ts/commit/29e7ee51a18049e2335eda08ceb68460b22de055)), closes [#7](https://github.com/touchifyapp/spec2ts/issues/7)
-
-
-
-
-
-## [1.2.1](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@1.2.0...@spec2ts/openapi@1.2.1) (2020-05-27)
-
-**Note:** Version bump only for package @spec2ts/openapi
-
-
-
-
-
-# [1.2.0](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@1.1.3...@spec2ts/openapi@1.2.0) (2020-05-24)
-
-
-### Features
-
-* **cli:** add default banner ([b0945e0](https://github.com/touchifyapp/spec2ts/commit/b0945e08b2c1da4dc494dca1890d491768a13e60))
-
-
-
-
-
-## [1.1.3](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@1.1.2...@spec2ts/openapi@1.1.3) (2020-05-18)
-
-
-### Bug Fixes
-
-* **openapi:** fix missing await on mkdirp ([ba2ae64](https://github.com/touchifyapp/spec2ts/commit/ba2ae64805626b706f25f4caadec4bfb96a1055e))
-
-
-
-
-
-## [1.1.2](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@1.1.1...@spec2ts/openapi@1.1.2) (2020-05-16)
-
-
-### Bug Fixes
-
-* **openapi:** fix avoid imports ([be6cf64](https://github.com/touchifyapp/spec2ts/commit/be6cf64e84588ee8773c2756fed0e24ea9d18ae1))
-
-
-
-
-
-## [1.1.1](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@1.1.0...@spec2ts/openapi@1.1.1) (2020-04-27)
-
-
-### Bug Fixes
-
-* **openapi:** pass options to parser ([7b02e71](https://github.com/touchifyapp/spec2ts/commit/7b02e7146eafbf8dc2f0cf1fe97cc1051095df63))
-
-
-
-
-
-# [1.1.0](https://github.com/touchifyapp/spec2ts/compare/@spec2ts/openapi@1.0.0...@spec2ts/openapi@1.1.0) (2020-04-27)
-
-
-### Features
-
-* **openapi:** add lowerHeaders option ([7520550](https://github.com/touchifyapp/spec2ts/commit/752055038827457c5058578be0d1ddf01ffead04))
-
-
-
-
-
-# 1.0.0 (2020-04-24)
-
-
-### Bug Fixes
-
-* **release:** fix lerna publish ([fe36558](https://github.com/touchifyapp/spec2ts/commit/fe36558a1a2742e2e3d99aa08061ab9be0cf03f2))
-
-
-### Code Refactoring
-
-* **global:** improve project architecture ([2b2c0a1](https://github.com/touchifyapp/spec2ts/commit/2b2c0a1d98b78457520fff2c116b7f8d0e5c5df5))
-
-
-### Features
-
-* **jsonschema:** add cli command ([7592c43](https://github.com/touchifyapp/spec2ts/commit/7592c439be99fabb97cc270aa7a09794ee86f738))
-* **openapi:** add openapi parser to monorepo ([e9ca537](https://github.com/touchifyapp/spec2ts/commit/e9ca5375e2692f909d32eacae653f918cd348040))
-
-
-### BREAKING CHANGES
-
-* **global:** force v1

package/bin/oapi2ts.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-import "../cli";