@spec2ts/openapi-client 3.1.3 → 4.0.0

package/package.json

@@ -1,74 +1,80 @@
 {
-    "name": "@spec2ts/openapi-client",
-    "version": "3.1.3",
-    "description": "Utility to convert OpenAPI v3 specifications to Typescript HTTP client 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-client",
+  "version": "4.0.0",
+  "description": "Utility to convert OpenAPI v3 specifications to Typescript HTTP client using TypeScript native compiler",
+  "keywords": [
+    "ast",
+    "client",
+    "compile",
+    "compiler",
+    "http",
+    "interface",
+    "openapi",
+    "openapi3",
+    "rest",
+    "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": {
+    "oapi2tsclient": "./dist/bin/oapi2tsclient.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": {
-        "oapi2tsclient": "./bin/oapi2tsclient.js"
+    "./bin/oapi2tsclient": {
+      "import": "./dist/bin/oapi2tsclient.mjs",
+      "types": "./dist/bin/oapi2tsclient.d.mts"
     },
-    "files": [
-        "*.js",
-        "*.d.ts",
-        "bin/**/*.js",
-        "cli/**/*.js",
-        "cli/**/*.d.ts",
-        "lib/**/*.js",
-        "lib/**/*.d.ts",
-        "lib/templates/*.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",
-        "@spec2ts/openapi": "^3.1.3",
-        "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",
-        "client",
-        "http",
-        "rest",
-        "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": {
+    "@spec2ts/core": "^4.0.0",
+    "@spec2ts/jsonschema": "^4.0.0",
+    "@spec2ts/openapi": "^4.0.0",
+    "openapi3-ts": "^4.6.0",
+    "typescript": "^6.0.0",
+    "yargs": "^18.0.0"
+  }
 }

package/bin/oapi2tsclient.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,20 +0,0 @@
-import { Argv } from "yargs";
-import { OApiGeneratorOptions } from "../lib/openapi-generator";
-export 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;
-}
-export declare const usage = "$0 <input..>";
-export declare const describe = "Generate TypeScript HTTP client from OpenAPI specification";
-export declare function builder(argv: Argv): Argv<BuildClientFromOpenApiOptions>;
-export declare function handler(options: BuildClientFromOpenApiOptions): Promise<void>;

package/cli/command.js

@@ -1,168 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.handler = exports.builder = exports.describe = exports.usage = void 0;
-const path = require("path");
-const fs_1 = require("fs");
-const core_1 = require("@spec2ts/core");
-const openapi_generator_1 = require("../lib/openapi-generator");
-exports.usage = "$0 <input..>";
-exports.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("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 output = options.output || core_1.cli.getOutputPath(file, options);
-        await core_1.cli.mkdirp(output);
-        if (options.typesPath) {
-            if (!options.typesPath.startsWith(".")) {
-                options.typesPath = "./" + options.typesPath;
-            }
-            const res = await (0, openapi_generator_1.generateClientFromFile)(file, options);
-            printFile(res.client, output, options);
-            const outputTypes = path.resolve(path.dirname(output), options.typesPath + ".ts");
-            printFile(res.types, outputTypes, options);
-        }
-        else {
-            const sourceFile = await (0, openapi_generator_1.generateClientFromFile)(file, options);
-            printFile(sourceFile, output, options);
-        }
-        if (options.packageName) {
-            await generatePackage(output, options);
-        }
-    }
-}
-exports.handler = handler;
-async function printFile(file, output, options) {
-    const content = core_1.printer.printFile(file);
-    await core_1.cli.mkdirp(output);
-    await core_1.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 || "UMD"} --moduleResolution node --skipLibCheck`,
-            prepublishOnly: "npm run build"
-        },
-        dependencies: {},
-        devDependencies: {
-            typescript: "^4.2.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 fs_1.promises.writeFile(path.join(outputDir, "package.json"), JSON.stringify(pkg, null, 2), "utf8");
-}

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-generator";

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-generator"), exports);

package/lib/core-generator.d.ts

@@ -1,7 +0,0 @@
-import * as ts from "typescript";
-import type { OpenAPIObject } from "openapi3-ts/oas31";
-import { OApiGeneratorContext } from "./core-parser";
-export type Formatter = "space" | "pipe" | "deep" | "explode" | "form";
-export declare function generateServers(file: ts.SourceFile, { servers }: OpenAPIObject, context: OApiGeneratorContext): ts.SourceFile;
-export declare function generateDefaults(file: ts.SourceFile, context: OApiGeneratorContext): ts.SourceFile;
-export declare function generateFunctions(file: ts.SourceFile, spec: OpenAPIObject, context: OApiGeneratorContext): ts.SourceFile;

package/lib/core-generator.js

@@ -1,155 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateFunctions = exports.generateDefaults = exports.generateServers = void 0;
-const ts = require("typescript");
-const core = require("@spec2ts/core");
-const core_parser_1 = require("@spec2ts/jsonschema/lib/core-parser");
-const server_parser_1 = require("./server-parser");
-const core_parser_2 = require("./core-parser");
-const util_1 = require("./util");
-//#region Public
-function generateServers(file, { servers }, context) {
-    servers = servers || [];
-    if (context.options.baseUrl)
-        servers = [{ url: context.options.baseUrl }];
-    const serversConst = core.findFirstVariableStatement(file.statements, "servers");
-    const defaultsConst = core.findFirstVariableStatement(file.statements, "defaults");
-    if (!serversConst || !defaultsConst) {
-        throw new Error("Invalid template: missing servers or defaults const");
-    }
-    file = core.replaceSourceFileStatement(file, serversConst, core.updateVariableStatementValue(serversConst, "servers", (0, server_parser_1.parseServers)(servers)));
-    file = core.replaceSourceFileStatement(file, defaultsConst, core.updateVariableStatementPropertyValue(defaultsConst, "defaults", "baseUrl", (0, server_parser_1.defaultBaseUrl)(servers)));
-    return file;
-}
-exports.generateServers = generateServers;
-function generateDefaults(file, context) {
-    if (context.options.importFetch) {
-        const defaultsConst = core.findFirstVariableStatement(file.statements, "defaults");
-        if (!defaultsConst) {
-            throw new Error("Invalid template: missing defaults const");
-        }
-        file = core.prependSourceFileStatements(file, core.createDefaultImportDeclaration({
-            moduleSpecifier: context.options.importFetch,
-            name: "fetch",
-            bindings: ["RequestInit", "Headers"]
-        }), core.createNamespaceImportDeclaration({
-            moduleSpecifier: "form-data",
-            name: "FormData"
-        }));
-        file = core.replaceSourceFileStatement(file, defaultsConst, core.updateVariableStatementPropertyValue(defaultsConst, "defaults", "fetch", core.toExpression("fetch")));
-    }
-    return file;
-}
-exports.generateDefaults = generateDefaults;
-function generateFunctions(file, spec, context) {
-    var _a;
-    const paths = Object.fromEntries(Object.entries((_a = spec.paths) !== null && _a !== void 0 ? _a : {})
-        .filter(([path]) => !context.options.prefix || path.startsWith(context.options.prefix)));
-    const functions = Object.entries(paths).map(([path, pathSpec]) => {
-        const item = (0, core_parser_1.resolveReference)(pathSpec, context);
-        return Object.entries(item)
-            .filter(([verb,]) => (0, core_parser_2.isMethod)(verb.toUpperCase()))
-            .map(([verb, entry]) => generateFunction(path, item, verb.toUpperCase(), entry, context));
-    }).flat();
-    if (context.options.typesPath && context.typesFile) {
-        context.typesFile = core.updateSourceFileStatements(context.typesFile, context.aliases);
-        file = core.updateSourceFileStatements(file, [
-            core.createNamedImportDeclaration({
-                moduleSpecifier: context.options.typesPath,
-                bindings: context.aliases.map(a => a.name.text)
-            }),
-            ...file.statements,
-            ...functions
-        ]);
-    }
-    else {
-        file = core.appendSourceFileStatements(file, ...context.aliases, ...functions);
-    }
-    return file;
-}
-exports.generateFunctions = generateFunctions;
-function generateFunction(path, item, method, operation, context) {
-    const { name, query, header, paramsVars, args, bodyMode, bodyVar, response, responseVoid, responseJSON } = (0, core_parser_2.parseOperation)(path, item, method, operation, context);
-    const qs = generateQs(query, paramsVars);
-    const url = generateUrl(path, qs);
-    const init = [
-        ts.factory.createSpreadAssignment(ts.factory.createIdentifier("options")),
-    ];
-    if (method !== "GET") {
-        init.push(ts.factory.createPropertyAssignment("method", ts.factory.createStringLiteral(method)));
-    }
-    if (bodyVar) {
-        init.push(core.createPropertyAssignment("body", ts.factory.createIdentifier(bodyVar)));
-    }
-    if (header.length) {
-        init.push(ts.factory.createPropertyAssignment("headers", ts.factory.createObjectLiteralExpression([
-            ts.factory.createSpreadAssignment(ts.factory.createPropertyAccessChain(ts.factory.createIdentifier("options"), core.questionDotToken, ts.factory.createIdentifier("headers"))),
-            ...header.map(({ name }) => core.createPropertyAssignment(name, ts.factory.createIdentifier(paramsVars[name]))),
-        ], true)));
-    }
-    const fetchArgs = [url];
-    if (init.length) {
-        const initObj = ts.factory.createObjectLiteralExpression(init, true);
-        fetchArgs.push(bodyMode ? callFunction("http", bodyMode, [initObj]) : initObj);
-    }
-    return core.addComment(core.createFunctionDeclaration(name, {
-        modifiers: [core.modifier.export, core.modifier.async],
-        type: ts.factory.createTypeReferenceNode("Promise", [
-            ts.factory.createTypeReferenceNode("ApiResponse", [response])
-        ])
-    }, args, core.block(ts.factory.createReturnStatement(ts.factory.createAwaitExpression(callFunction("http", responseJSON ? "fetchJson" :
-        responseVoid ? "fetchVoid" :
-            "fetch", fetchArgs))))), operation.summary || operation.description);
-}
-function generateQs(parameters, paramsVars) {
-    if (!parameters.length) {
-        return;
-    }
-    const paramsByFormatter = groupByFormatter(parameters);
-    return callFunction("QS", "query", Object.entries(paramsByFormatter).map(([format, params]) => {
-        return callFunction("QS", format, [
-            core.createObjectLiteral(params.map((p) => [p.name, paramsVars[p.name]])),
-        ]);
-    }));
-}
-function generateUrl(path, qs) {
-    const spans = [];
-    // Use a replacer function to collect spans as a side effect:
-    const head = path.replace(/(.*?)\{(.+?)\}(.*?)(?=\{|$)/g, (_, head, name, literal) => {
-        const expression = (0, util_1.camelCase)(name);
-        spans.push({ expression: ts.factory.createIdentifier(expression), literal });
-        return head;
-    });
-    if (qs) {
-        // add the query string as last span
-        spans.push({ expression: qs, literal: "" });
-    }
-    return core.createTemplateString(head, spans);
-}
-//#endregion
-//#region Utils
-function callFunction(ns, name, args) {
-    return core.createCall(ts.factory.createPropertyAccessExpression(ts.factory.createIdentifier(ns), name), { args });
-}
-function groupByFormatter(parameters) {
-    const res = {};
-    parameters.forEach(param => {
-        const formatter = getFormatter(param);
-        res[formatter] = res[formatter] || [];
-        res[formatter].push(param);
-    });
-    return res;
-}
-function getFormatter({ style, explode }) {
-    if (style === "spaceDelimited")
-        return "space";
-    if (style === "pipeDelimited")
-        return "pipe";
-    if (style === "deepObject")
-        return "deep";
-    if (style === "form") {
-        return explode === false ? "form" : "explode";
-    }
-    return explode ? "explode" : "form";
-}
-//#endregion

package/lib/core-parser.d.ts

@@ -1,24 +0,0 @@
-import * as ts from "typescript";
-import type { PathItemObject, OperationObject, ParameterObject } from "openapi3-ts/oas31";
-import { ParserContext } from "@spec2ts/jsonschema/lib/core-parser";
-import type { OApiGeneratorOptions } from "./openapi-generator";
-export type Method = "GET" | "PUT" | "POST" | "DELETE" | "OPTIONS" | "HEAD" | "PATCH" | "TRACE";
-export type ContentTypeMode = "json" | "form" | "multipart";
-export interface OApiGeneratorContext extends ParserContext {
-    options: OApiGeneratorOptions;
-    typesFile?: ts.SourceFile;
-}
-export interface ParsedOperation {
-    name: string;
-    paramsVars: Record<string, string>;
-    args: ts.ParameterDeclaration[];
-    query: ParameterObject[];
-    header: ParameterObject[];
-    response: ts.TypeNode;
-    responseJSON?: boolean;
-    responseVoid?: boolean;
-    bodyMode?: ContentTypeMode;
-    bodyVar?: string;
-}
-export declare function parseOperation(path: string, item: PathItemObject, method: Method, operation: OperationObject, context: OApiGeneratorContext): ParsedOperation;
-export declare function isMethod(method: string): method is Method;