apigen-ts 0.1.0 → 0.1.2

package/dist/_template.ts

@@ -1,11 +1,11 @@
 // Note: Use uppercase for names in ApiClient to avoid conflict with the generated code
 
-interface ApigenConfig {
+export interface ApigenConfig {
   baseUrl: string
   headers: Record<string, string>
 }
 
-interface ApigenRequest extends Omit<RequestInit, "body"> {
+export interface ApigenRequest extends Omit<RequestInit, "body"> {
   search?: Record<string, unknown>
   body?: unknown
 }
@@ -42,8 +42,10 @@ export class ApiClient {
 
   async Fetch<T>(method: string, path: string, opts: ApigenRequest = {}): Promise<T> {
     let base = this.Config.baseUrl
-    if (globalThis.location && (base === "" || base.startsWith("/"))) {
-      base = `${globalThis.location.origin}${base.endsWith("/") ? base : `/${base}`}`
+    if ("location" in globalThis && (base === "" || base.startsWith("/"))) {
+      // make ts happy in pure nodejs environment, should never pass here
+      const { location } = globalThis as unknown as { location: { origin: string } }
+      base = `${location.origin}${base.endsWith("/") ? base : `/${base}`}`
     }
 
     const url = new URL(path, base)
@@ -57,7 +59,8 @@ export class ApiClient {
     let body: FormData | URLSearchParams | string | undefined = undefined
 
     if (ct === "multipart/form-data" || ct === "application/x-www-form-urlencoded") {
-      headers.delete("content-type") // https://stackoverflow.com/a/61053359/3664464
+      // https://stackoverflow.com/a/61053359/3664464
+      headers.delete("content-type")
       body = ct === "multipart/form-data" ? new FormData() : new URLSearchParams()
       for (const [k, v] of Object.entries(opts.body as Record<string, string>)) {
         body.append(k, v)
@@ -75,7 +78,7 @@ export class ApiClient {
 
     const rs = await rep.text()
     try {
-      return this.PopulateDates(JSON.parse(rs))
+      return this.PopulateDates(JSON.parse(rs) as T)
     } catch (e) {
       return rs as unknown as T
     }

package/dist/cli.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var main$1 = require('./main-0ae61014.cjs');
+var main$1 = require('./main-c2426ec2.cjs');
 require('fs/promises');
 require('path');
 require('url');
@@ -10,7 +10,7 @@ require('array-utils-ts');
 require('lodash-es');
 require('swagger2openapi');
 require('typescript');
-require('prettier');
+require('node:path');
 
 const main = async () => {
   await main$1.apigen(main$1.getCliConfig());

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { a as apigen, g as getCliConfig } from './main-0c2fa229.js';
+import { a as apigen, g as getCliConfig } from './main-bbe33f1b.js';
 import 'fs/promises';
 import 'path';
 import 'url';
@@ -9,7 +9,7 @@ import 'array-utils-ts';
 import 'lodash-es';
 import 'swagger2openapi';
 import 'typescript';
-import 'prettier';
+import 'node:path';
 
 const main = async () => {
   await apigen(getCliConfig());

package/dist/cli.mjs

@@ -1,4 +1,4 @@
-import { a as apigen, g as getCliConfig } from './main-0c2fa229.mjs';
+import { a as apigen, g as getCliConfig } from './main-bbe33f1b.mjs';
 import 'fs/promises';
 import 'path';
 import 'url';
@@ -8,7 +8,7 @@ import 'array-utils-ts';
 import 'lodash-es';
 import 'swagger2openapi';
 import 'typescript';
-import 'prettier';
+import 'node:path';
 
 const main = async () => {
   await apigen(getCliConfig());

package/dist/{main-0c2fa229.js → main-bbe33f1b.js}

@@ -7,7 +7,7 @@ import { filterEmpty, filterNullable } from 'array-utils-ts';
 import { get, uniq, upperFirst, isArray, isObject, sortBy, lowerFirst, uniqBy } from 'lodash-es';
 import { convertObj } from 'swagger2openapi';
 import ts from 'typescript';
-import * as prettier from 'prettier';
+import path from 'node:path';
 
 const initCtx = (config) => {
   return {
@@ -24,8 +24,8 @@ const initCtx = (config) => {
 const getCliConfig = () => {
   const argv = cli({
     name: "apigen",
-    // version: "0.0.1",
-    parameters: ["<source>", "<output>"],
+    version: "0.1.1",
+    parameters: ["<source>", "[output]"],
     flags: {
       name: {
         type: String,
@@ -41,7 +41,7 @@ const getCliConfig = () => {
   });
   const config = {
     source: argv._.source,
-    output: argv._.output,
+    output: argv._.output ?? null,
     name: argv.flags.name,
     parseDates: argv.flags.parseDates
   };
@@ -163,7 +163,8 @@ const Keywords = /* @__PURE__ */ new Set([
   "Extract",
   // ts keywords
   "Date",
-  "object"
+  "object",
+  "Response"
   // ts type names
 ]);
 const normalizeIdentifier = (val, asVar = false) => {
@@ -498,6 +499,8 @@ const generateAst = async (ctx) => {
   return { modules, types };
 };
 const loadSchema = async (url, upgrade = true) => {
+  if (url.startsWith("file://"))
+    url = url.substring(7);
   const { bundle } = await redocly.bundle({
     ref: url,
     config: await redocly.createConfig({}),
@@ -529,8 +532,13 @@ const printCode = (nodes) => {
   ).replaceAll("}, ", "},\n\n");
 };
 const formatCode = async (code) => {
-  const options = await prettier.resolveConfig(import.meta.url);
-  return prettier.format(code, { ...options, parser: "typescript" });
+  try {
+    const prettier = await import('prettier');
+    const options = await prettier.resolveConfig(path.join(process.cwd(), "file"));
+    return prettier.format(code, { ...options, parser: "typescript" });
+  } catch (e) {
+    return code;
+  }
 };
 
 const apigen = async (config) => {
@@ -543,17 +551,24 @@ const apigen = async (config) => {
     `// Auto-generated by https://github.com/vladkens/apigen-ts`,
     `// Source: ${config.source}
 `,
-    ...file.split("\n").filter((x) => !x.startsWith("// Note: "))
+    // remove all comments expect which starts with "// apigen:"
+    ...file.split("\n").filter((x) => !/\s*\/\/\s(?!apigen:)/.test(x))
   ].join("\n");
   if (!ctx.parseDates) {
+    code = code.replace(/\s*ISO_FORMAT\s=.+$/gm, "");
     code = code.replace(/PopulateDates.+?\n\s{2}\}/s, "");
     code = code.replace(/this.PopulateDates\((.+)\)/, "$1");
   }
   code = code.replace("// apigen:modules", printCode(modules));
   code = code.replace("// apigen:types", printCode(types));
   code = code.replace("class ApiClient", `class ${ctx.name}`);
-  await fs.mkdir(dirname(config.output), { recursive: true });
-  await fs.writeFile(config.output, await formatCode(code));
+  const result = await formatCode(code);
+  if (config.output === null) {
+    process.stdout.write(result);
+  } else {
+    await fs.mkdir(dirname(config.output), { recursive: true });
+    await fs.writeFile(config.output, result);
+  }
 };
 
 export { apigen as a, getCliConfig as g };

package/dist/{main-0c2fa229.mjs → main-bbe33f1b.mjs}

@@ -7,7 +7,7 @@ import { filterEmpty, filterNullable } from 'array-utils-ts';
 import { get, uniq, upperFirst, isArray, isObject, sortBy, lowerFirst, uniqBy } from 'lodash-es';
 import { convertObj } from 'swagger2openapi';
 import ts from 'typescript';
-import * as prettier from 'prettier';
+import path from 'node:path';
 
 const initCtx = (config) => {
   return {
@@ -24,8 +24,8 @@ const initCtx = (config) => {
 const getCliConfig = () => {
   const argv = cli({
     name: "apigen",
-    // version: "0.0.1",
-    parameters: ["<source>", "<output>"],
+    version: "0.1.1",
+    parameters: ["<source>", "[output]"],
     flags: {
       name: {
         type: String,
@@ -41,7 +41,7 @@ const getCliConfig = () => {
   });
   const config = {
     source: argv._.source,
-    output: argv._.output,
+    output: argv._.output ?? null,
     name: argv.flags.name,
     parseDates: argv.flags.parseDates
   };
@@ -163,7 +163,8 @@ const Keywords = /* @__PURE__ */ new Set([
   "Extract",
   // ts keywords
   "Date",
-  "object"
+  "object",
+  "Response"
   // ts type names
 ]);
 const normalizeIdentifier = (val, asVar = false) => {
@@ -498,6 +499,8 @@ const generateAst = async (ctx) => {
   return { modules, types };
 };
 const loadSchema = async (url, upgrade = true) => {
+  if (url.startsWith("file://"))
+    url = url.substring(7);
   const { bundle } = await redocly.bundle({
     ref: url,
     config: await redocly.createConfig({}),
@@ -529,8 +532,13 @@ const printCode = (nodes) => {
   ).replaceAll("}, ", "},\n\n");
 };
 const formatCode = async (code) => {
-  const options = await prettier.resolveConfig(import.meta.url);
-  return prettier.format(code, { ...options, parser: "typescript" });
+  try {
+    const prettier = await import('prettier');
+    const options = await prettier.resolveConfig(path.join(process.cwd(), "file"));
+    return prettier.format(code, { ...options, parser: "typescript" });
+  } catch (e) {
+    return code;
+  }
 };
 
 const apigen = async (config) => {
@@ -543,17 +551,24 @@ const apigen = async (config) => {
     `// Auto-generated by https://github.com/vladkens/apigen-ts`,
     `// Source: ${config.source}
 `,
-    ...file.split("\n").filter((x) => !x.startsWith("// Note: "))
+    // remove all comments expect which starts with "// apigen:"
+    ...file.split("\n").filter((x) => !/\s*\/\/\s(?!apigen:)/.test(x))
   ].join("\n");
   if (!ctx.parseDates) {
+    code = code.replace(/\s*ISO_FORMAT\s=.+$/gm, "");
     code = code.replace(/PopulateDates.+?\n\s{2}\}/s, "");
     code = code.replace(/this.PopulateDates\((.+)\)/, "$1");
   }
   code = code.replace("// apigen:modules", printCode(modules));
   code = code.replace("// apigen:types", printCode(types));
   code = code.replace("class ApiClient", `class ${ctx.name}`);
-  await fs.mkdir(dirname(config.output), { recursive: true });
-  await fs.writeFile(config.output, await formatCode(code));
+  const result = await formatCode(code);
+  if (config.output === null) {
+    process.stdout.write(result);
+  } else {
+    await fs.mkdir(dirname(config.output), { recursive: true });
+    await fs.writeFile(config.output, result);
+  }
 };
 
 export { apigen as a, getCliConfig as g };

package/dist/{main-0ae61014.cjs → main-c2426ec2.cjs}

@@ -1,7 +1,7 @@
 'use strict';
 
 var fs = require('fs/promises');
-var path = require('path');
+var path$1 = require('path');
 var url = require('url');
 var cleye = require('cleye');
 var redocly = require('@redocly/openapi-core');
@@ -9,28 +9,9 @@ var arrayUtilsTs = require('array-utils-ts');
 var lodashEs = require('lodash-es');
 var swagger2openapi = require('swagger2openapi');
 var ts = require('typescript');
-var prettier = require('prettier');
+var path = require('node:path');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
-function _interopNamespaceDefault(e) {
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-
-var prettier__namespace = /*#__PURE__*/_interopNamespaceDefault(prettier);
-
 const initCtx = (config) => {
   return {
     source: "",
@@ -46,8 +27,8 @@ const initCtx = (config) => {
 const getCliConfig = () => {
   const argv = cleye.cli({
     name: "apigen",
-    // version: "0.0.1",
-    parameters: ["<source>", "<output>"],
+    version: "0.1.1",
+    parameters: ["<source>", "[output]"],
     flags: {
       name: {
         type: String,
@@ -63,7 +44,7 @@ const getCliConfig = () => {
   });
   const config = {
     source: argv._.source,
-    output: argv._.output,
+    output: argv._.output ?? null,
     name: argv.flags.name,
     parseDates: argv.flags.parseDates
   };
@@ -185,7 +166,8 @@ const Keywords = /* @__PURE__ */ new Set([
   "Extract",
   // ts keywords
   "Date",
-  "object"
+  "object",
+  "Response"
   // ts type names
 ]);
 const normalizeIdentifier = (val, asVar = false) => {
@@ -520,6 +502,8 @@ const generateAst = async (ctx) => {
   return { modules, types };
 };
 const loadSchema = async (url, upgrade = true) => {
+  if (url.startsWith("file://"))
+    url = url.substring(7);
   const { bundle } = await redocly.bundle({
     ref: url,
     config: await redocly.createConfig({}),
@@ -551,31 +535,43 @@ const printCode = (nodes) => {
   ).replaceAll("}, ", "},\n\n");
 };
 const formatCode = async (code) => {
-  const options = await prettier__namespace.resolveConfig((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('main-0ae61014.cjs', document.baseURI).href)));
-  return prettier__namespace.format(code, { ...options, parser: "typescript" });
+  try {
+    const prettier = await import('prettier');
+    const options = await prettier.resolveConfig(path.join(process.cwd(), "file"));
+    return prettier.format(code, { ...options, parser: "typescript" });
+  } catch (e) {
+    return code;
+  }
 };
 
 const apigen = async (config) => {
   const doc = await loadSchema(config.source);
   const ctx = initCtx({ ...config, doc });
   const { modules, types } = await generateAst(ctx);
-  const filepath = path.join(path.dirname(url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('main-0ae61014.cjs', document.baseURI).href)))), "_template.ts");
+  const filepath = path$1.join(path$1.dirname(url.fileURLToPath((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.src || new URL('main-c2426ec2.cjs', document.baseURI).href)))), "_template.ts");
   const file = await fs.readFile(filepath, "utf-8");
   let code = [
     `// Auto-generated by https://github.com/vladkens/apigen-ts`,
     `// Source: ${config.source}
 `,
-    ...file.split("\n").filter((x) => !x.startsWith("// Note: "))
+    // remove all comments expect which starts with "// apigen:"
+    ...file.split("\n").filter((x) => !/\s*\/\/\s(?!apigen:)/.test(x))
   ].join("\n");
   if (!ctx.parseDates) {
+    code = code.replace(/\s*ISO_FORMAT\s=.+$/gm, "");
     code = code.replace(/PopulateDates.+?\n\s{2}\}/s, "");
     code = code.replace(/this.PopulateDates\((.+)\)/, "$1");
   }
   code = code.replace("// apigen:modules", printCode(modules));
   code = code.replace("// apigen:types", printCode(types));
   code = code.replace("class ApiClient", `class ${ctx.name}`);
-  await fs.mkdir(path.dirname(config.output), { recursive: true });
-  await fs.writeFile(config.output, await formatCode(code));
+  const result = await formatCode(code);
+  if (config.output === null) {
+    process.stdout.write(result);
+  } else {
+    await fs.mkdir(path$1.dirname(config.output), { recursive: true });
+    await fs.writeFile(config.output, result);
+  }
 };
 
 exports.apigen = apigen;

package/dist/main.cjs

@@ -3,14 +3,14 @@
 require('fs/promises');
 require('path');
 require('url');
-var main = require('./main-0ae61014.cjs');
+var main = require('./main-c2426ec2.cjs');
 require('cleye');
 require('@redocly/openapi-core');
 require('array-utils-ts');
 require('lodash-es');
 require('swagger2openapi');
 require('typescript');
-require('prettier');
+require('node:path');
 
 
 

package/dist/main.d.cts

@@ -8,7 +8,7 @@ type OpConfig = Oas3Operation & {
 type OpName = [string, string];
 type Config = {
     source: string;
-    output: string;
+    output: string | null;
     name: string;
     parseDates: boolean;
     resolveName?: (ctx: Context, op: OpConfig, proposal: OpName) => OpName | undefined;

package/dist/main.d.mts

@@ -8,7 +8,7 @@ type OpConfig = Oas3Operation & {
 type OpName = [string, string];
 type Config = {
     source: string;
-    output: string;
+    output: string | null;
     name: string;
     parseDates: boolean;
     resolveName?: (ctx: Context, op: OpConfig, proposal: OpName) => OpName | undefined;

package/dist/main.js

@@ -1,11 +1,11 @@
 import 'fs/promises';
 import 'path';
 import 'url';
-export { a as apigen } from './main-0c2fa229.js';
+export { a as apigen } from './main-bbe33f1b.js';
 import 'cleye';
 import '@redocly/openapi-core';
 import 'array-utils-ts';
 import 'lodash-es';
 import 'swagger2openapi';
 import 'typescript';
-import 'prettier';
+import 'node:path';

package/dist/main.mjs

@@ -1,11 +1,11 @@
 import 'fs/promises';
 import 'path';
 import 'url';
-export { a as apigen } from './main-0c2fa229.mjs';
+export { a as apigen } from './main-bbe33f1b.mjs';
 import 'cleye';
 import '@redocly/openapi-core';
 import 'array-utils-ts';
 import 'lodash-es';
 import 'swagger2openapi';
 import 'typescript';
-import 'prettier';
+import 'node:path';

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "apigen-ts",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "license": "MIT",
   "author": "Vlad Pronsky <v.pronsky@gmail.com>",
   "repository": "vladkens/apigen-ts",
@@ -22,7 +22,7 @@
     "ci": "tsc --noEmit && yarn test-cov && yarn build"
   },
   "dependencies": {
-    "@redocly/openapi-core": "^1.4.1",
+    "@redocly/openapi-core": "^1.6.0",
     "@types/lodash-es": "^4.17.12",
     "@types/swagger2openapi": "^7.0.4",
     "array-utils-ts": "^0.1.2",
@@ -31,8 +31,8 @@
     "swagger2openapi": "^7.0.8"
   },
   "devDependencies": {
-    "@types/node": "^20.10.5",
-    "c8": "^8.0.1",
+    "@types/node": "^20.10.8",
+    "c8": "^9.0.0",
     "fetch-mock": "^9.11.0",
     "pkgroll": "^2.0.1",
     "prettier": "^3.1.0",
@@ -48,6 +48,7 @@
   "files": [
     "dist"
   ],
+  "main": "./dist/main.js",
   "types": "./dist/main.d.cts",
   "exports": {
     "require": {

package/readme.md

@@ -3,31 +3,28 @@
 <div align="center">
 
 [<img src="https://badgen.net/npm/v/apigen-ts" alt="version" />](https://npmjs.org/package/apigen-ts)
-[<img src="https://github.com/vladkens/apigen-ts/workflows/test/badge.svg" alt="test status" />](https://github.com/vladkens/apigen-ts/actions)
 [<img src="https://badgen.net/packagephobia/publish/apigen-ts" alt="size" />](https://packagephobia.now.sh/result?p=apigen-ts)
 [<img src="https://badgen.net/npm/dm/apigen-ts" alt="downloads" />](https://npmjs.org/package/apigen-ts)
 [<img src="https://badgen.net/github/license/vladkens/apigen-ts" alt="license" />](https://github.com/vladkens/apigen-ts/blob/main/LICENSE)
+[<img src="https://badgen.net/static/-/buy%20me%20a%20coffee/ff813f?icon=buymeacoffee&label" alt="donate" />](https://buymeacoffee.com/vladkens)
 
 </div>
 
 <div align="center">
   <img src="./logo.svg" alt="apigen-ts logo" height="80" />
-</div>
-
-<div align="center">
-  TypeScript api client generator from OpenAPI specification
+  <div>TypeScript client generator from OpenAPI schema</div>
 </div>
 
 ## Features
 
 - Generates ready to use `ApiClient` with types (using `fetch`)
 - Single output file, minimal third-party code
-- Load schema from JSON / YAML, locally and remote
+- Loads schemas from JSON / YAML, locally and remote
 - Ability to customize `fetch` with your custom function
-- Uses `type` instead of `interface`, no problem with declaration merging
 - Automatic formating with Prettier
 - Can parse dates from date-time format (`--parse-dates` flag)
 - Support OpenAPI v2, v3, v3.1
+- Can be used with npx as well
 
 ## Install
 
@@ -37,7 +34,7 @@ yarn install -D apigen-ts
 
 ## Usage
 
-### Generate
+### 1. Generate
 
 ```sh
 # From url
@@ -47,11 +44,11 @@ yarn apigen-ts https://petstore3.swagger.io/api/v3/openapi.json ./api-client.ts
 yarn apigen-ts ./openapi.json ./api-client.ts
 ```
 
-Run `yarn apigen-ts --help` for more options. See examples of generated clients [here](./examples/).
+Run `yarn apigen-ts --help` for more options. Examples of generated clients [here](./examples/).
 
-### Import
+### 2. Import
 
-```typescript
+```ts
 import { ApiClient } from "./api-client"
 
 const api = new ApiClient({
@@ -60,9 +57,9 @@ const api = new ApiClient({
 })
 ```
 
-### Use
+### 3. Use
 
-```typescript
+```ts
 // GET /pet/{petId}
 await api.pet.getPetById(1) // -> Pet
 
@@ -77,18 +74,59 @@ await api.user.updateUser("username", { firstName: "John" })
 
 ### Login flow
 
-```typescript
+```ts
 const { token } = await api.auth.login({ usename, password })
 api.Config.headers = { Authorization: token }
 
 await api.protectedRoute.get() // here authenticated
 ```
 
-### NodeJS API
+### Automatic date parsing
+
+```sh
+yarn apigen-ts ./openapi.json ./api-client.ts --parse-dates
+```
+
+```ts
+const pet = await api.pet.getPetById(1)
+const createdAt: Date = pet.createdAt // date parsed from string with format=date-time
+```
+
+### Errors handling
+
+An exception will be thrown for all unsuccessful return codes.
+
+```ts
+try {
+  const pet = await api.pet.getPetById(404)
+} catch (e) {
+  console.log(e) // parse error depend of your domain model, e is awaited response.json()
+}
+```
+
+Also you can define custom function to parse error:
+
+```ts
+class MyClient extends ApiClient {
+  async ParseError(rep: Response) {
+    // do what you want
+    return { code: "API_ERROR" }
+  }
+}
+
+try {
+  const api = MyClient()
+  const pet = await api.pet.getPetById(404)
+} catch (e) {
+  console.log(e) // e is { code: "API_ERROR" }
+}
+```
+
+### Node.js API
 
 Create file like `apigen.mjs` with content:
 
-```javascript
+```js
 import { apigen } from "apigen-ts"
 
 await apigen({
@@ -109,7 +147,14 @@ await apigen({
 
 Then run with: `node apigen.mjs`
 
-## Useful for development
+## Compare
+
+- [openapi-typescript-codegen](https://github.com/ferdikoomen/openapi-typescript-codegen) ([npm](https://www.npmjs.com/package/openapi-typescript-codegen)): no single file mode [#1263](https://github.com/ferdikoomen/openapi-typescript-codegen/issues/1263#issuecomment-1502890838)
+- [openapi-typescript](https://github.com/drwpow/openapi-typescript) ([npm](https://www.npmjs.com/package/openapi-typescript)): low level api; no named types export to use in client code
+- [openapi-generator-cli](https://github.com/OpenAPITools/openapi-generator-cli) ([npm](https://www.npmjs.com/package/@openapitools/openapi-generator-cli)): wrapper around java lib
+- [swagger-typescript-api](https://github.com/acacode/swagger-typescript-api) ([npm](https://www.npmjs.com/package/swagger-typescript-api)): complicated configuration; user-api breaking changes between versions
+
+## Development
 
 - https://ts-ast-viewer.com
 - https://jsonschemalint.com