@spec2ts/openapi 3.1.3 → 4.0.1

package/README.md

@@ -8,15 +8,16 @@
 
 ## Features
 
-* **AST-based:** Unlike other code generators `@spec2ts/openapi` does not use templates to generate code but uses TypeScript's built-in API to generate and pretty-print an abstract syntax tree.
-* **Tree-shakeable:** Individually exported types allows you to bundle only the ones you actually use.
-* **YAML or JSON:** Use YAML or JSON for your OpenAPI v3 specification.
-* **External references:** Resolves automatically external references and bundle or import them in generated files.
-* **Implementation agnostic:** Use generated types in any projet or framework.
+- **AST-based:** Unlike other code generators `@spec2ts/openapi` does not use templates to generate code but uses TypeScript's built-in API to generate and pretty-print an abstract syntax tree.
+- **Tree-shakeable:** Individually exported types allows you to bundle only the ones you actually use.
+- **YAML or JSON:** Use YAML or JSON for your OpenAPI v3 specification.
+- **External references:** Resolves automatically external references and bundle or import them in generated files.
+- **Implementation agnostic:** Use generated types in any projet or framework.
 
 ## Installation
 
 Install in your project:
+
 ```bash
 npm install @spec2ts/openapi
 ```
@@ -56,32 +57,34 @@ async function generateSpec(path: string): Promise<string> {
 ## Implementations
 
 - [x] Types for parameters:
-  - [x] path
-  - [x] header
-  - [x] query
-  - [x] cookie
+    - [x] path
+    - [x] header
+    - [x] query
+    - [x] cookie
 - [x] Types for requestBody
 - [x] Types for responses
 - [x] Automatic naming
-  - [x] From operationId
-  - [x] From path
+    - [x] From operationId
+    - [x] From path
 - [x] Parameters merging
-  - [x] From path item
-  - [x] From operation
-  - [x] Override from operation
+    - [x] From path item
+    - [x] From operation
+    - [x] Override from operation
 - [x] [Schema references](http://json-schema.org/latest/json-schema-core.html#rfc.section.7.2.2)
-  - [x] Local (filesystem) schema references
-  - [x] External (network) schema references
+    - [x] Local (filesystem) schema references
+    - [x] External (network) schema references
 - [x] Modular architecture
-  - [x] Import local references
-  - [x] Embed external references
+    - [x] Import local references
+    - [x] Embed external references
 
 ## Compatibility Matrix
 
 | TypeScript version | spec2ts version |
-|--------------------|-----------------|
-| v3.x.x             | v1              | 
-| v4.x.x             | v2              | 
+| ------------------ | --------------- |
+| v3.x.x             | v1              |
+| v4.x.x             | v2              |
+| v5.x.x             | v3              |
+| v6.x.x             | v4              |
 
 ## License
 

package/dist/bin/oapi2ts.d.mts

@@ -0,0 +1 @@
+export { };

package/dist/bin/oapi2ts.mjs

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import { i as usage, n as describe, r as handler, t as builder } from "../command-BDMCeG0A.mjs";
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+//#region src/bin/oapi2ts.ts
+yargs(hideBin(process.argv)).command(usage, describe, builder, handler).help("help", "Show help usage").demandCommand().argv;
+//#endregion
+export {};

package/dist/cli/index.d.mts

@@ -0,0 +1,15 @@
+import { t as ParseOpenApiOptions } from "../openapi-parser-BJ3RQyRq.mjs";
+import { Argv } from "yargs";
+//#region src/cli/command.d.ts
+interface BuildTsFromOpenApiOptions extends ParseOpenApiOptions {
+  input: string | string[];
+  output?: string;
+  ext?: string;
+  banner?: string;
+}
+declare const usage = "$0 <input..>";
+declare const describe = "Generate TypeScript types from OpenAPI specification";
+declare function builder(argv: Argv): Argv<BuildTsFromOpenApiOptions>;
+declare function handler(options: BuildTsFromOpenApiOptions): Promise<void>;
+//#endregion
+export { BuildTsFromOpenApiOptions, builder, describe, handler, usage };

package/dist/cli/index.mjs

@@ -0,0 +1,2 @@
+import { i as usage, n as describe, r as handler, t as builder } from "../command-BDMCeG0A.mjs";
+export { builder, describe, handler, usage };

package/dist/command-BDMCeG0A.mjs

@@ -0,0 +1,64 @@
+import { n as parseOpenApiFile } from "./openapi-parser-3wx-i5_G.mjs";
+import { cli, printer } from "@spec2ts/core";
+//#region src/cli/command.ts
+const usage = "$0 <input..>";
+const describe = "Generate TypeScript types from OpenAPI specification";
+function builder(argv) {
+	return argv.positional("input", {
+		array: true,
+		type: "string",
+		describe: "Path to OpenAPI Specification(s) to convert to TypeScript",
+		demandOption: true
+	}).option("output", {
+		type: "string",
+		alias: "o",
+		describe: "Output directory for generated types"
+	}).option("ext", {
+		type: "string",
+		alias: "e",
+		describe: "Output extension for generated types",
+		choices: [".d.ts", ".ts"]
+	}).option("cwd", {
+		type: "string",
+		alias: "c",
+		describe: "Root directory for resolving $refs"
+	}).option("avoidAny", {
+		type: "boolean",
+		describe: "Avoid the `any` type and use `unknown` instead"
+	}).option("enableDate", {
+		choices: [
+			true,
+			"strict",
+			"lax"
+		],
+		describe: "Build `Date` for format `date` and `date-time`"
+	}).option("lowerHeaders", {
+		type: "boolean",
+		describe: "Lowercase headers keys to match Node.js standard"
+	}).option("banner", {
+		type: "string",
+		alias: "b",
+		describe: "Comment prepended to the top of each generated file"
+	});
+}
+async function handler(options) {
+	const files = await cli.findFiles(options.input);
+	for (const file of files) {
+		const ast = await parseOpenApiFile(file, options);
+		const content = printer.printNodes(ast.all);
+		const output = cli.getOutputPath(file, options);
+		await cli.mkdirp(output);
+		await cli.writeFile(output, (options.banner || defaultBanner()) + "\n\n" + content);
+	}
+}
+function defaultBanner() {
+	return `/**
+ * DO NOT MODIFY
+ * Generated using @spec2ts/openapi.
+ * See https://www.npmjs.com/package/@spec2ts/openapi
+ */
+
+/* eslint-disable */`;
+}
+//#endregion
+export { usage as i, describe as n, handler as r, builder as t };

package/dist/index.d.mts

@@ -0,0 +1,2 @@
+import { _ as parseParameters, a as ParamType, c as createOpenApiResult, d as getOperationName, f as getParamType, g as parseOperation, h as getSchemaFromContent, i as OApiParserContext, l as getContentDeclaration, m as getResponseName, n as parseOpenApi, o as ParseOpenApiResult, p as getPathName, r as parseOpenApiFile, s as addToOpenApiResult, t as ParseOpenApiOptions, u as getOperationIdentifier, v as parsePathItem, y as parseReference } from "./openapi-parser-BJ3RQyRq.mjs";
+export { OApiParserContext, ParamType, ParseOpenApiOptions, ParseOpenApiResult, addToOpenApiResult, createOpenApiResult, getContentDeclaration, getOperationIdentifier, getOperationName, getParamType, getPathName, getResponseName, getSchemaFromContent, parseOpenApi, parseOpenApiFile, parseOperation, parseParameters, parsePathItem, parseReference };

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import { a as getContentDeclaration, c as getParamType, d as getSchemaFromContent, f as parseOperation, h as parseReference, i as createOpenApiResult, l as getPathName, m as parsePathItem, n as parseOpenApiFile, o as getOperationIdentifier, p as parseParameters, r as addToOpenApiResult, s as getOperationName, t as parseOpenApi, u as getResponseName } from "./openapi-parser-3wx-i5_G.mjs";
+export { addToOpenApiResult, createOpenApiResult, getContentDeclaration, getOperationIdentifier, getOperationName, getParamType, getPathName, getResponseName, getSchemaFromContent, parseOpenApi, parseOpenApiFile, parseOperation, parseParameters, parsePathItem, parseReference };

package/dist/openapi-parser-3wx-i5_G.mjs

@@ -0,0 +1,184 @@
+import * as core from "@spec2ts/core";
+import { createContext, createRefContext, getTypeFromProperties, getTypeFromSchema, pascalCase, resolveReference } from "@spec2ts/jsonschema";
+import ts from "typescript";
+import $RefParser from "@apidevtools/json-schema-ref-parser";
+import path from "node:path";
+//#region src/lib/core-parser.ts
+const VERBS = [
+	"GET",
+	"PUT",
+	"POST",
+	"DELETE",
+	"OPTIONS",
+	"HEAD",
+	"PATCH",
+	"TRACE"
+];
+function parsePathItem(path, item, context, result) {
+	const baseParams = item.parameters && parseParameters(getPathName(path, context), item.parameters, void 0, context, result);
+	Object.entries(item).filter(([verb]) => VERBS.includes(verb.toUpperCase())).forEach(([verb, entry]) => parseOperation(path, verb, entry, baseParams, context, result));
+}
+function parseOperation(path, verb, operation, baseParams, context, result) {
+	const name = getOperationName(verb, path, operation.operationId, context);
+	if (operation.parameters) parseParameters(name, operation.parameters, baseParams, context, result);
+	if (operation.requestBody) {
+		const requestBody = resolveReference(operation.requestBody, context);
+		const decla = getContentDeclaration(name + "Body", requestBody.content, context);
+		if (decla) addToOpenApiResult(result, "body", decla);
+	}
+	if (operation.responses) {
+		const responses = resolveReference(operation.responses, context);
+		Object.entries(responses).forEach(([status, responseObj]) => {
+			const response = resolveReference(responseObj, context);
+			const decla = getContentDeclaration(getResponseName(name, status, context), response.content, context);
+			if (decla) addToOpenApiResult(result, "responses", decla);
+		});
+	}
+}
+function parseParameters(baseName, data, baseParams = {}, context, result) {
+	const params = [];
+	const query = [];
+	const headers = [];
+	const cookie = [];
+	const res = {};
+	data.forEach((item) => {
+		item = resolveReference(item, context);
+		switch (item.in) {
+			case "path":
+				params.push(item);
+				break;
+			case "header":
+				headers.push(item);
+				break;
+			case "query":
+				query.push(item);
+				break;
+			case "cookie":
+				cookie.push(item);
+				break;
+		}
+	});
+	addParams(params, "params");
+	addParams(headers, "headers");
+	addParams(query, "query");
+	addParams(cookie, "cookie");
+	return res;
+	function addParams(params, paramType) {
+		if (!params.length) return;
+		const name = baseName + pascalCase(paramType);
+		const type = getParamType(paramType, params, baseParams[paramType], context);
+		addToOpenApiResult(result, paramType, core.createTypeOrInterfaceDeclaration({
+			modifiers: [core.modifier.export],
+			name,
+			type
+		}));
+		res[paramType] = ts.factory.createTypeReferenceNode(name, void 0);
+	}
+}
+function parseReference(ref, context) {
+	const type = getTypeFromSchema(ref.schema, createRefContext(ref, context));
+	context.aliases.push(core.createTypeOrInterfaceDeclaration({
+		modifiers: [core.modifier.export],
+		name: ref.name,
+		type
+	}));
+}
+function getContentDeclaration(name, content, context) {
+	if (!content) return;
+	content = resolveReference(content, context);
+	const schema = getSchemaFromContent(content);
+	if (!schema) return;
+	const type = getTypeFromSchema(schema, context);
+	return core.createTypeOrInterfaceDeclaration({
+		modifiers: [core.modifier.export],
+		name,
+		type
+	});
+}
+function getParamType(paramType, data, baseType, context) {
+	const required = [];
+	const props = {};
+	data.forEach((m) => {
+		let name = m.name;
+		if (paramType === "headers" && context.options.lowerHeaders) name = name.toLowerCase();
+		props[name] = m.schema || {};
+		if (m.required) required.push(name);
+	});
+	const type = getTypeFromProperties(props, required, false, paramType === "query" && typeof context.options.enableDateForQueryParams !== "undefined" ? {
+		...context,
+		options: {
+			...context.options,
+			enableDate: context.options.enableDateForQueryParams
+		}
+	} : context);
+	if (baseType) return ts.factory.createIntersectionTypeNode([baseType, type]);
+	return type;
+}
+function getSchemaFromContent(content) {
+	return content?.["application/json"]?.schema || content?.["application/x-www-form-urlencoded"]?.schema || content?.["multipart/form-data"]?.schema || content?.["*/*"]?.schema;
+}
+function getResponseName(operationName, statusCode, context) {
+	let name = operationName + "Response";
+	const status = parseInt(statusCode);
+	if (status >= 200 && status < 300) {
+		if ((context.names[name] = (context.names[name] || 0) + 1) > 1) name += statusCode;
+	} else if (!isNaN(status)) name += statusCode;
+	else name += pascalCase(statusCode);
+	return name;
+}
+function getOperationName(verb, path, operationId, context) {
+	const id = getOperationIdentifier(operationId);
+	if (id) return id;
+	return getPathName(`${verb} ${path}`, context);
+}
+function getPathName(path, context) {
+	path = path.replace(/\{(.+?)\}/, "by $1").replace(/\{(.+?)\}/g, "and $1");
+	let name = pascalCase(path);
+	const count = context.names[name] = (context.names[name] || 0) + 1;
+	if (count > 1) name += count;
+	return name;
+}
+function getOperationIdentifier(id) {
+	if (!id) return;
+	if (id.match(/[^\w\s]/)) return;
+	id = pascalCase(id);
+	if (core.isValidIdentifier(id)) return id;
+}
+function addToOpenApiResult(result, prop, statement) {
+	const statements = Array.isArray(statement) ? statement : [statement];
+	result[prop].push(...statements);
+	result.all.push(...statements);
+}
+function createOpenApiResult() {
+	return {
+		params: [],
+		query: [],
+		headers: [],
+		body: [],
+		responses: [],
+		models: [],
+		cookie: [],
+		import: [],
+		all: []
+	};
+}
+//#endregion
+//#region src/lib/openapi-parser.ts
+async function parseOpenApiFile(file, options = {}) {
+	return parseOpenApi(await $RefParser.parse(file), {
+		cwd: path.resolve(path.dirname(file)) + "/",
+		...options
+	});
+}
+async function parseOpenApi(spec, options = {}) {
+	if (!options.parseReference) options.parseReference = parseReference;
+	const context = await createContext(spec, options);
+	const result = createOpenApiResult();
+	Object.entries(spec.paths ?? {}).forEach(([path, item]) => {
+		parsePathItem(path, item, context, result);
+	});
+	addToOpenApiResult(result, "models", context.aliases);
+	return result;
+}
+//#endregion
+export { getContentDeclaration as a, getParamType as c, getSchemaFromContent as d, parseOperation as f, parseReference as h, createOpenApiResult as i, getPathName as l, parsePathItem as m, parseOpenApiFile as n, getOperationIdentifier as o, parseParameters as p, addToOpenApiResult as r, getOperationName as s, parseOpenApi as t, getResponseName as u };

package/dist/openapi-parser-BJ3RQyRq.d.mts

@@ -0,0 +1,48 @@
+import { ParsedReference, ParserContext, ParserOptions } from "@spec2ts/jsonschema";
+import ts from "typescript";
+import { ContentObject, OpenAPIObject, OperationObject, ParameterObject, PathItemObject, ReferenceObject, SchemaObject } from "openapi3-ts/oas31";
+//#region src/lib/core-parser.d.ts
+interface ParseOpenApiResult {
+  import: ts.Statement[];
+  params: ts.Statement[];
+  query: ts.Statement[];
+  headers: ts.Statement[];
+  body: ts.Statement[];
+  responses: ts.Statement[];
+  models: ts.Statement[];
+  cookie: ts.Statement[];
+  all: ts.Statement[];
+}
+interface OApiParserContext extends ParserContext {
+  options: ParseOpenApiOptions;
+}
+declare function parsePathItem(path: string, item: PathItemObject, context: OApiParserContext, result: ParseOpenApiResult): void;
+declare function parseOperation(path: string, verb: string, operation: OperationObject, baseParams: ParsedParams | undefined, context: OApiParserContext, result: ParseOpenApiResult): void;
+type ParamType = "params" | "headers" | "query" | "cookie";
+declare function parseParameters(baseName: string, data: Array<ReferenceObject | ParameterObject>, baseParams: ParsedParams | undefined, context: OApiParserContext, result: ParseOpenApiResult): ParsedParams;
+declare function parseReference(ref: ParsedReference, context: ParserContext): void;
+declare function getContentDeclaration(name: string, content: ReferenceObject | ContentObject | undefined, context: OApiParserContext): ts.Statement | undefined;
+declare function getParamType(paramType: ParamType, data: ParameterObject[], baseType: ts.TypeReferenceNode | undefined, context: OApiParserContext): ts.TypeNode;
+declare function getSchemaFromContent(content: ContentObject): SchemaObject | ReferenceObject | undefined;
+declare function getResponseName(operationName: string, statusCode: string, context: OApiParserContext): string;
+declare function getOperationName(verb: string, path: string, operationId: string | undefined, context: OApiParserContext): string;
+declare function getPathName(path: string, context: OApiParserContext): string;
+declare function getOperationIdentifier(id?: string): string | void;
+declare function addToOpenApiResult(result: ParseOpenApiResult, prop: keyof ParseOpenApiResult, statement: ts.Statement | ts.Statement[]): void;
+declare function createOpenApiResult(): ParseOpenApiResult;
+interface ParsedParams {
+  params?: ts.TypeReferenceNode;
+  query?: ts.TypeReferenceNode;
+  headers?: ts.TypeReferenceNode;
+  cookie?: ts.TypeReferenceNode;
+}
+//#endregion
+//#region src/lib/openapi-parser.d.ts
+interface ParseOpenApiOptions extends ParserOptions {
+  lowerHeaders?: boolean;
+  enableDateForQueryParams?: boolean | "strict" | "lax";
+}
+declare function parseOpenApiFile(file: string, options?: ParseOpenApiOptions): Promise<ParseOpenApiResult>;
+declare function parseOpenApi(spec: OpenAPIObject, options?: ParseOpenApiOptions): Promise<ParseOpenApiResult>;
+//#endregion
+export { parseParameters as _, ParamType as a, createOpenApiResult as c, getOperationName as d, getParamType as f, parseOperation as g, getSchemaFromContent as h, OApiParserContext as i, getContentDeclaration as l, getResponseName as m, parseOpenApi as n, ParseOpenApiResult as o, getPathName as p, parseOpenApiFile as r, addToOpenApiResult as s, ParseOpenApiOptions as t, getOperationIdentifier as u, parsePathItem as v, parseReference as y };

package/package.json

@@ -1,69 +1,77 @@
 {
-    "name": "@spec2ts/openapi",
-    "version": "3.1.3",
-    "description": "Utility to convert OpenAPI v3 specifications to Typescript using TypeScript native compiler",
-    "author": "Touchify <dev@touchify.co>",
-    "license": "MIT",
-    "main": "index.js",
-    "homepage": "https://github.com/touchifyapp/spec2ts/blob/master/packages/openapi#readme",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/touchifyapp/spec2ts"
+  "name": "@spec2ts/openapi",
+  "version": "4.0.1",
+  "description": "Utility to convert OpenAPI v3 specifications to Typescript using TypeScript native compiler",
+  "keywords": [
+    "ast",
+    "compile",
+    "compiler",
+    "interface",
+    "openapi",
+    "openapi3",
+    "share",
+    "spec",
+    "spec2ts",
+    "specification",
+    "transpile",
+    "typescript",
+    "typing"
+  ],
+  "homepage": "https://github.com/touchifyapp/spec2ts/blob/master/packages/openapi#readme",
+  "license": "MIT",
+  "author": "Touchify <dev@touchify.co>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/touchifyapp/spec2ts"
+  },
+  "bin": {
+    "oapi2ts": "./dist/bin/oapi2ts.mjs"
+  },
+  "files": [
+    "dist/**/*.mjs",
+    "dist/**/*.d.mts"
+  ],
+  "type": "module",
+  "main": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.mts"
     },
-    "publishConfig": {
-        "access": "public"
+    "./cli": {
+      "import": "./dist/cli/index.mjs",
+      "types": "./dist/cli/index.d.mts"
     },
-    "bin": {
-        "oapi2ts": "./bin/oapi2ts.js"
+    "./bin/oapi2ts": {
+      "import": "./dist/bin/oapi2ts.mjs",
+      "types": "./dist/bin/oapi2ts.d.mts"
     },
-    "files": [
-        "*.js",
-        "*.d.ts",
-        "bin/**/*.js",
-        "cli/**/*.js",
-        "cli/**/*.d.ts",
-        "lib/**/*.js",
-        "lib/**/*.d.ts"
-    ],
-    "scripts": {
-        "build": "npm run clean && npm run lint && npm run build:ts",
-        "build:ts": "tsc -p .",
-        "test": "npm run clean && npm run lint && npm run test:jest",
-        "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:fix": "npm run lint -- -- --fix",
-        "clean": "npm run clean:ts",
-        "clean:ts": "del '*.{js,d.ts}' '{bin,cli,lib}/**/*.{js,d.ts}'",
-        "prepublishOnly": "npm test && npm run build"
-    },
-    "dependencies": {
-        "@spec2ts/core": "^3.0.2",
-        "@spec2ts/jsonschema": "^3.0.5",
-        "openapi3-ts": "^4.1.2",
-        "typescript": "^5.0.0",
-        "yargs": "^17.7.2"
-    },
-    "devDependencies": {
-        "del-cli": "^5.1.0",
-        "eslint": "^8.49.0",
-        "jest": "^29.6.4"
-    },
-    "keywords": [
-        "openapi",
-        "specification",
-        "openapi3",
-        "spec",
-        "typescript",
-        "compile",
-        "compiler",
-        "ast",
-        "transpile",
-        "interface",
-        "typing",
-        "spec2ts",
-        "share"
-    ],
-    "gitHead": "81f76779f541e0bc2ef8d7051a0121fff07916ae"
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "npm run lint && npm run build:ts",
+    "build:ts": "tsdown",
+    "test": "npm run lint && npm run format:check && npm run test:vitest",
+    "test:prepublish": "npm run lint && npm run test:vitest",
+    "test:vitest": "vitest run -c ../../vitest.config.ts",
+    "test:coverage": "npm run test -- -- --coverage",
+    "lint": "npm run lint:ts",
+    "lint:ts": "oxlint -c ../../oxlint.config.ts",
+    "lint:fix": "npm run lint -- -- --fix",
+    "format": "oxfmt -c ../../oxfmt.config.ts",
+    "format:check": "oxfmt -c ../../oxfmt.config.ts --check",
+    "prepublishOnly": "npm run test:prepublish && npm run build"
+  },
+  "dependencies": {
+    "@apidevtools/json-schema-ref-parser": "^10.1.0",
+    "@spec2ts/core": "^4.0.1",
+    "@spec2ts/jsonschema": "^4.0.1",
+    "openapi3-ts": "^4.6.0",
+    "typescript": "^6.0.0",
+    "yargs": "^18.0.0"
+  }
 }

package/bin/oapi2ts.js

@@ -1,4 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-require("../cli");

package/cli/command.d.ts

@@ -1,12 +0,0 @@
-import { Argv } from "yargs";
-import { ParseOpenApiOptions } from "../lib/openapi-parser";
-export interface BuildTsFromOpenApiOptions extends ParseOpenApiOptions {
-    input: string | string[];
-    output?: string;
-    ext?: string;
-    banner?: string;
-}
-export declare const usage = "$0 <input..>";
-export declare const describe = "Generate TypeScript types from OpenAPI specification";
-export declare function builder(argv: Argv): Argv<BuildTsFromOpenApiOptions>;
-export declare function handler(options: BuildTsFromOpenApiOptions): Promise<void>;

package/cli/command.js

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.handler = exports.builder = exports.describe = exports.usage = void 0;
-const core_1 = require("@spec2ts/core");
-const openapi_parser_1 = require("../lib/openapi-parser");
-exports.usage = "$0 <input..>";
-exports.describe = "Generate TypeScript types from OpenAPI specification";
-function builder(argv) {
-    return argv
-        .positional("input", {
-        array: true,
-        type: "string",
-        describe: "Path to OpenAPI Specification(s) to convert to TypeScript",
-        demandOption: true
-    })
-        .option("output", {
-        type: "string",
-        alias: "o",
-        describe: "Output directory for generated types"
-    })
-        .option("ext", {
-        type: "string",
-        alias: "e",
-        describe: "Output extension for generated types",
-        choices: [".d.ts", ".ts"]
-    })
-        .option("cwd", {
-        type: "string",
-        alias: "c",
-        describe: "Root directory for resolving $refs"
-    })
-        .option("avoidAny", {
-        type: "boolean",
-        describe: "Avoid the `any` type and use `unknown` instead"
-    })
-        .option("enableDate", {
-        choices: [true, "strict", "lax"],
-        describe: "Build `Date` for format `date` and `date-time`"
-    })
-        .option("lowerHeaders", {
-        type: "boolean",
-        describe: "Lowercase headers keys to match Node.js standard"
-    })
-        .option("banner", {
-        type: "string",
-        alias: "b",
-        describe: "Comment prepended to the top of each generated file"
-    });
-}
-exports.builder = builder;
-async function handler(options) {
-    const files = await core_1.cli.findFiles(options.input);
-    for (const file of files) {
-        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);
-        await core_1.cli.writeFile(output, (options.banner || defaultBanner()) +
-            "\n\n" +
-            content);
-    }
-}
-exports.handler = handler;
-function defaultBanner() {
-    return `/**
- * DO NOT MODIFY
- * Generated using @spec2ts/openapi.
- * See https://www.npmjs.com/package/@spec2ts/openapi
- */
-
-/* eslint-disable */`;
-}

package/cli/index.d.ts

@@ -1 +0,0 @@
-export {};

package/cli/index.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const yargs = require("yargs");
-const command_1 = require("../cli/command");
-yargs
-    .command(command_1.usage, command_1.describe, command_1.builder, command_1.handler)
-    .help("help", "Show help usage")
-    .demandCommand()
-    .argv;

package/index.d.ts

@@ -1 +0,0 @@
-export * from "./lib/openapi-parser";

package/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = 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];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./lib/openapi-parser"), exports);

package/lib/core-parser.d.ts

@@ -1,39 +0,0 @@
-import * as ts from "typescript";
-import type { SchemaObject, ReferenceObject, PathItemObject, OperationObject, ParameterObject, ContentObject } from "openapi3-ts/oas31";
-import { ParserContext, ParsedReference } from "@spec2ts/jsonschema/lib/core-parser";
-import type { ParseOpenApiOptions } from "./openapi-parser";
-export interface ParseOpenApiResult {
-    import: ts.Statement[];
-    params: ts.Statement[];
-    query: ts.Statement[];
-    headers: ts.Statement[];
-    body: ts.Statement[];
-    responses: ts.Statement[];
-    models: ts.Statement[];
-    cookie: ts.Statement[];
-    all: ts.Statement[];
-}
-export interface OApiParserContext extends ParserContext {
-    options: ParseOpenApiOptions;
-}
-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 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;
-export declare function getParamType(paramType: ParamType, data: ParameterObject[], baseType: ts.TypeReferenceNode | undefined, context: OApiParserContext): ts.TypeNode;
-export declare function getSchemaFromContent(content: ContentObject): SchemaObject | ReferenceObject | undefined;
-export declare function getResponseName(operationName: string, statusCode: string, context: OApiParserContext): string;
-export declare function getOperationName(verb: string, path: string, operationId: string | undefined, context: OApiParserContext): string;
-export declare function getPathName(path: string, context: OApiParserContext): string;
-export declare function getOperationIdentifier(id?: string): string | void;
-export declare function addToOpenApiResult(result: ParseOpenApiResult, prop: keyof ParseOpenApiResult, statement: ts.Statement | ts.Statement[]): void;
-export declare function createOpenApiResult(): ParseOpenApiResult;
-interface ParsedParams {
-    params?: ts.TypeReferenceNode;
-    query?: ts.TypeReferenceNode;
-    headers?: ts.TypeReferenceNode;
-    cookie?: ts.TypeReferenceNode;
-}
-export {};

package/lib/core-parser.js

@@ -1,194 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createOpenApiResult = exports.addToOpenApiResult = exports.getOperationIdentifier = exports.getPathName = exports.getOperationName = exports.getResponseName = exports.getSchemaFromContent = exports.getParamType = exports.getContentDeclaration = exports.parseReference = exports.parseParameters = exports.parseOperation = exports.parsePathItem = void 0;
-const ts = require("typescript");
-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) {
-    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) {
-    const name = getOperationName(verb, path, operation.operationId, context);
-    if (operation.parameters) {
-        parseParameters(name, operation.parameters, baseParams, context, result);
-    }
-    if (operation.requestBody) {
-        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 = (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);
-            }
-        });
-    }
-}
-exports.parseOperation = parseOperation;
-function parseParameters(baseName, data, baseParams = {}, context, result) {
-    const params = [];
-    const query = [];
-    const headers = [];
-    const cookie = [];
-    const res = {};
-    data.forEach(item => {
-        item = (0, core_parser_1.resolveReference)(item, context);
-        switch (item.in) {
-            case "path":
-                params.push(item);
-                break;
-            case "header":
-                headers.push(item);
-                break;
-            case "query":
-                query.push(item);
-                break;
-            case "cookie":
-                cookie.push(item);
-                break;
-        }
-    });
-    addParams(params, "params");
-    addParams(headers, "headers");
-    addParams(query, "query");
-    addParams(cookie, "cookie");
-    return res;
-    function addParams(params, paramType) {
-        if (!params.length)
-            return;
-        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],
-            name,
-            type
-        }));
-        res[paramType] = ts.factory.createTypeReferenceNode(name, undefined);
-    }
-}
-exports.parseParameters = parseParameters;
-function parseReference(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,
-        type
-    }));
-}
-exports.parseReference = parseReference;
-//#endregion
-//#region Utils
-function getContentDeclaration(name, content, context) {
-    if (!content)
-        return;
-    content = (0, core_parser_1.resolveReference)(content, context);
-    const schema = getSchemaFromContent(content);
-    if (!schema)
-        return;
-    const type = (0, core_parser_1.getTypeFromSchema)(schema, context);
-    return core.createTypeOrInterfaceDeclaration({
-        modifiers: [core.modifier.export],
-        name,
-        type
-    });
-}
-exports.getContentDeclaration = getContentDeclaration;
-function getParamType(paramType, data, baseType, context) {
-    const required = [];
-    const props = {};
-    data.forEach(m => {
-        let name = m.name;
-        if (paramType === "headers" && context.options.lowerHeaders) {
-            name = name.toLowerCase();
-        }
-        props[name] = m.schema || {};
-        if (m.required) {
-            required.push(name);
-        }
-    });
-    const ctx = paramType === "query" && typeof context.options.enableDateForQueryParams !== "undefined"
-        ? { ...context, options: { ...context.options, enableDate: context.options.enableDateForQueryParams } }
-        : context;
-    const type = (0, core_parser_1.getTypeFromProperties)(props, required, false, ctx);
-    if (baseType) {
-        return ts.factory.createIntersectionTypeNode([baseType, type]);
-    }
-    return type;
-}
-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);
-}
-exports.getSchemaFromContent = getSchemaFromContent;
-function getResponseName(operationName, statusCode, context) {
-    let name = operationName + "Response";
-    const status = parseInt(statusCode);
-    if (status >= 200 && status < 300) {
-        const count = (context.names[name] = (context.names[name] || 0) + 1);
-        if (count > 1) {
-            name += statusCode;
-        }
-    }
-    else if (!isNaN(status)) {
-        name += statusCode;
-    }
-    else {
-        // default
-        name += (0, core_parser_1.pascalCase)(statusCode);
-    }
-    return name;
-}
-exports.getResponseName = getResponseName;
-function getOperationName(verb, path, operationId, context) {
-    const id = getOperationIdentifier(operationId);
-    if (id) {
-        return id;
-    }
-    return getPathName(`${verb} ${path}`, context);
-}
-exports.getOperationName = getOperationName;
-function getPathName(path, context) {
-    path = path.replace(/\{(.+?)\}/, "by $1").replace(/\{(.+?)\}/g, "and $1");
-    let name = (0, core_parser_1.pascalCase)(path);
-    const count = (context.names[name] = (context.names[name] || 0) + 1);
-    if (count > 1) {
-        name += count;
-    }
-    return name;
-}
-exports.getPathName = getPathName;
-function getOperationIdentifier(id) {
-    if (!id)
-        return;
-    if (id.match(/[^\w\s]/))
-        return;
-    id = (0, core_parser_1.pascalCase)(id);
-    if (core.isValidIdentifier(id))
-        return id;
-}
-exports.getOperationIdentifier = getOperationIdentifier;
-function addToOpenApiResult(result, prop, statement) {
-    const statements = Array.isArray(statement) ? statement : [statement];
-    result[prop].push(...statements);
-    result.all.push(...statements);
-}
-exports.addToOpenApiResult = addToOpenApiResult;
-function createOpenApiResult() {
-    return { params: [], query: [], headers: [], body: [], responses: [], models: [], cookie: [], import: [], all: [] };
-}
-exports.createOpenApiResult = createOpenApiResult;

package/lib/openapi-parser.d.ts

@@ -1,10 +0,0 @@
-import type { OpenAPIObject } from "openapi3-ts/oas31";
-import { ParserOptions } from "@spec2ts/jsonschema/lib/core-parser";
-import { ParseOpenApiResult } from "./core-parser";
-export { ParseOpenApiResult };
-export interface ParseOpenApiOptions extends ParserOptions {
-    lowerHeaders?: boolean;
-    enableDateForQueryParams?: boolean | "strict" | "lax";
-}
-export declare function parseOpenApiFile(file: string, options?: ParseOpenApiOptions): Promise<ParseOpenApiResult>;
-export declare function parseOpenApi(spec: OpenAPIObject, options?: ParseOpenApiOptions): Promise<ParseOpenApiResult>;

package/lib/openapi-parser.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseOpenApi = exports.parseOpenApiFile = void 0;
-const path = require("path");
-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 json_schema_ref_parser_1.default.parse(file);
-    return parseOpenApi(schema, {
-        cwd: path.resolve(path.dirname(file)) + "/",
-        ...options
-    });
-}
-exports.parseOpenApiFile = parseOpenApiFile;
-async function parseOpenApi(spec, options = {}) {
-    var _a;
-    if (!options.parseReference) {
-        options.parseReference = core_parser_2.parseReference;
-    }
-    const context = await (0, core_parser_1.createContext)(spec, options);
-    const result = (0, core_parser_2.createOpenApiResult)();
-    Object.entries((_a = spec.paths) !== null && _a !== void 0 ? _a : {}).forEach(([path, item]) => {
-        (0, core_parser_2.parsePathItem)(path, item, context, result);
-    });
-    (0, core_parser_2.addToOpenApiResult)(result, "models", context.aliases);
-    return result;
-}
-exports.parseOpenApi = parseOpenApi;