@spec2ts/openapi-client 3.1.3 → 4.0.0

package/README.md

@@ -8,15 +8,16 @@
 
 ## Features
 
-* **AST-based:** Unlike other code generators `@spec2ts/openapi-client` 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-client` 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-client
 ```
@@ -65,9 +66,11 @@ async function generate(path: string): Promise<string> {
 ## 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/oapi2tsclient.d.mts

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

package/dist/bin/oapi2tsclient.mjs

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+import { i as usage, n as describe, r as handler, t as builder } from "../command-Djig04Ub.mjs";
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+//#region src/bin/oapi2tsclient.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,24 @@
+import { t as OApiGeneratorOptions } from "../openapi-generator-DfC4jH9J.mjs";
+import { Argv } from "yargs";
+//#region src/cli/command.d.ts
+interface BuildClientFromOpenApiOptions extends OApiGeneratorOptions {
+  input: string | string[];
+  output?: string;
+  banner?: string;
+  importFetchVersion?: string;
+  importFormDataVersion?: string;
+  packageName?: string;
+  packageVersion?: string;
+  packageAuthor?: string;
+  packageLicense?: string;
+  packagePrivate?: boolean;
+  packageBuildTarget?: string;
+  packageBuildModule?: string;
+  packageBuildModuleResolution?: string;
+}
+declare const usage = "$0 <input..>";
+declare const describe = "Generate TypeScript HTTP client from OpenAPI specification";
+declare function builder(argv: Argv): Argv<BuildClientFromOpenApiOptions>;
+declare function handler(options: BuildClientFromOpenApiOptions): Promise<void>;
+//#endregion
+export { BuildClientFromOpenApiOptions, 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-Djig04Ub.mjs";
+export { builder, describe, handler, usage };

package/dist/command-Djig04Ub.mjs

@@ -0,0 +1,143 @@
+import { n as generateClientFromFile } from "./openapi-generator-DwzcjKrv.mjs";
+import * as path from "path";
+import { cli, printer } from "@spec2ts/core";
+import { promises } from "fs";
+//#region src/cli/command.ts
+const usage = "$0 <input..>";
+const describe = "Generate TypeScript HTTP client from OpenAPI specification";
+function builder(argv) {
+	return argv.positional("input", {
+		array: true,
+		type: "string",
+		describe: "Path to OpenAPI Specification(s) to convert to TypeScript HTTP client",
+		demandOption: true
+	}).option("output", {
+		type: "string",
+		alias: "o",
+		describe: "Output file for generated client"
+	}).option("cwd", {
+		type: "string",
+		alias: "c",
+		describe: "Root directory for resolving $refs"
+	}).option("baseUrl", {
+		type: "string",
+		describe: "Base url of the server"
+	}).option("prefix", {
+		type: "string",
+		describe: "Only generate paths with this prefix"
+	}).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("inlineRequired", {
+		type: "boolean",
+		describe: "Create a method argument for each required parameter"
+	}).option("importFetch", {
+		choices: [
+			"node-fetch",
+			"cross-fetch",
+			"isomorphic-fetch"
+		],
+		describe: "Use a custom fetch implementation"
+	}).option("typesPath", {
+		type: "string",
+		describe: "Generate client types in external file relative to the output file"
+	}).option("importFetchVersion", {
+		type: "string",
+		describe: "Use a custom fetch implementation version"
+	}).option("importFormDataVersion", {
+		type: "string",
+		describe: "Use a custom form-data implementation version"
+	}).option("packageName", {
+		type: "string",
+		describe: "Generate a package.json with given name"
+	}).option("packageVersion", {
+		type: "string",
+		describe: "Set the version of the package.json"
+	}).option("packageAuthor", {
+		type: "string",
+		describe: "Set the author of the package.json"
+	}).option("packageLicense", {
+		type: "string",
+		describe: "Set the license of the package.json"
+	}).option("packagePrivate", {
+		type: "boolean",
+		describe: "Set the package.json private"
+	}).option("packageBuildTarget", {
+		type: "string",
+		describe: "Set the TypeScript build target"
+	}).option("packageBuildModule", {
+		type: "string",
+		describe: "Set the TypeScript build module"
+	}).option("packageBuildModuleResolution", {
+		type: "string",
+		describe: "Set the TypeScript build module resolution"
+	}).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 output = options.output || cli.getOutputPath(file, options);
+		await cli.mkdirp(output);
+		if (options.typesPath) {
+			if (!options.typesPath.startsWith(".")) options.typesPath = "./" + options.typesPath;
+			const res = await generateClientFromFile(file, options);
+			await printFile(res.client, output, options);
+			const outputTypes = path.resolve(path.dirname(output), options.typesPath + ".ts");
+			await printFile(res.types, outputTypes, options);
+		} else await printFile(await generateClientFromFile(file, options), output, options);
+		if (options.packageName) await generatePackage(output, options);
+	}
+}
+async function printFile(file, output, options) {
+	const content = printer.printFile(file);
+	await cli.mkdirp(output);
+	await cli.writeFile(output, (options.banner || defaultBanner()) + "\n\n" + content);
+}
+function defaultBanner() {
+	return `/**
+ * DO NOT MODIFY
+ * Generated using @spec2ts/openapi-client.
+ * See https://www.npmjs.com/package/@spec2ts/openapi-client
+ */
+
+/* eslint-disable */`;
+}
+async function generatePackage(output, options) {
+	const outputDir = path.dirname(output);
+	const main = path.relative(outputDir, output);
+	const pkg = {
+		name: options.packageName,
+		version: options.packageVersion || "1.0.0",
+		description: "OpenAPI v3 client for " + options.packageName,
+		author: options.packageAuthor || "@spec2ts/openapi-client",
+		license: options.packageLicense || "UNLICENSED",
+		main: main.replace(/\.ts$/, ".js"),
+		files: ["*.js", "*.d.ts"],
+		scripts: {
+			build: `tsc ${main} --strict --target ${options.packageBuildTarget || "ES2018"} --module ${options.packageBuildModule || "node16"} --moduleResolution ${options.packageBuildModuleResolution || "node16"} --skipLibCheck`,
+			prepublishOnly: "npm run build"
+		},
+		dependencies: {},
+		devDependencies: { typescript: "^6.0.0" }
+	};
+	if (options.importFetch) {
+		pkg.dependencies[options.importFetch] = options.importFetchVersion || "*";
+		pkg.dependencies["form-data"] = options.importFormDataVersion || "*";
+		pkg.devDependencies["@types/node"] = "*";
+	}
+	if (options.packagePrivate) pkg.private = options.packagePrivate;
+	await promises.writeFile(path.join(outputDir, "package.json"), JSON.stringify(pkg, null, 2), "utf8");
+}
+//#endregion
+export { usage as i, describe as n, handler as r, builder as t };

package/dist/index.d.mts

@@ -0,0 +1,2 @@
+import { i as generateClientFromFile, n as SeparatedClientResult, r as generateClient, t as OApiGeneratorOptions } from "./openapi-generator-DfC4jH9J.mjs";
+export { OApiGeneratorOptions, SeparatedClientResult, generateClient, generateClientFromFile };

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import { n as generateClientFromFile, t as generateClient } from "./openapi-generator-DwzcjKrv.mjs";
+export { generateClient, generateClientFromFile };

package/dist/openapi-generator-DfC4jH9J.d.mts

@@ -0,0 +1,25 @@
+import { ParserOptions } from "@spec2ts/jsonschema";
+import * as ts from "typescript";
+import { OpenAPIObject } from "openapi3-ts/oas31";
+//#region src/lib/openapi-generator.d.ts
+interface OApiGeneratorOptions extends ParserOptions {
+  inlineRequired?: boolean;
+  importFetch?: "node-fetch" | "cross-fetch" | "isomorphic-fetch";
+  typesPath?: string;
+  baseUrl?: string;
+  prefix?: string;
+}
+declare function generateClientFromFile(file: string, options: OApiGeneratorOptions & {
+  typesPath: string;
+}): Promise<SeparatedClientResult>;
+declare function generateClientFromFile(file: string, options?: OApiGeneratorOptions): Promise<ts.SourceFile>;
+declare function generateClient(spec: OpenAPIObject, options: OApiGeneratorOptions & {
+  typesPath: string;
+}): Promise<SeparatedClientResult>;
+declare function generateClient(spec: OpenAPIObject, options?: OApiGeneratorOptions): Promise<ts.SourceFile>;
+interface SeparatedClientResult {
+  client: ts.SourceFile;
+  types: ts.SourceFile;
+}
+//#endregion
+export { generateClientFromFile as i, SeparatedClientResult as n, generateClient as r, OApiGeneratorOptions as t };