@spec2ts/openapi 3.1.2 → 4.0.0

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-kheR7V25.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-RoDGKcjO.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-kheR7V25.mjs";
+export { builder, describe, handler, usage };

package/dist/command-kheR7V25.mjs

@@ -0,0 +1,64 @@
+import { n as parseOpenApiFile } from "./openapi-parser-CQvFG8Kq.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-RoDGKcjO.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-CQvFG8Kq.mjs";
+export { addToOpenApiResult, createOpenApiResult, getContentDeclaration, getOperationIdentifier, getOperationName, getParamType, getPathName, getResponseName, getSchemaFromContent, parseOpenApi, parseOpenApiFile, parseOperation, parseParameters, parsePathItem, parseReference };