apigen-ts 0.2.0 → 1.0.0

package/dist/_template.ts

@@ -1,8 +1,11 @@
 // Note: Use uppercase for names in ApiClient to avoid conflict with the generated code
 
+type Headers = Record<string, string>
+export type ApigenHeaders = Headers | ((method: string, path: string) => Headers | Promise<Headers>)
+
 export interface ApigenConfig {
   baseUrl: string
-  headers: Record<string, string>
+  headers: ApigenHeaders
 }
 
 export interface ApigenRequest extends Omit<RequestInit, "body"> {
@@ -58,7 +61,12 @@ export class ApiClient {
       url.searchParams.append(k, Array.isArray(v) ? v.join(",") : (v as string))
     }
 
-    const headers = new Headers({ ...this.Config.headers, ...opts.headers })
+    const configHeaders =
+      typeof this.Config.headers === "function"
+        ? await this.Config.headers(method, path)
+        : this.Config.headers
+
+    const headers = new Headers({ ...configHeaders, ...opts.headers })
     const ct = headers.get("content-type") ?? "application/json"
 
     let body: FormData | URLSearchParams | string | undefined = undefined

package/dist/cli.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var main$1 = require('./main-Dkcn3PTN.cjs');
+var main$1 = require('./main-oWgfChRG.cjs');
 require('fs/promises');
 require('path');
 require('url');

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { a as apigen, g as getCliConfig } from './main-byN_-fkF.js';
+import { a as apigen, g as getCliConfig } from './main-BTcttgNf.js';
 import 'fs/promises';
 import 'path';
 import 'url';

package/dist/cli.mjs

@@ -1,4 +1,4 @@
-import { a as apigen, g as getCliConfig } from './main-byN_-fkF.mjs';
+import { a as apigen, g as getCliConfig } from './main-BTcttgNf.mjs';
 import 'fs/promises';
 import 'path';
 import 'url';

package/dist/{main-byN_-fkF.js → main-BTcttgNf.js}

@@ -4,13 +4,13 @@ import { fileURLToPath } from 'url';
 import { cli } from 'cleye';
 import redocly from '@redocly/openapi-core';
 import { filterEmpty, filterNullable } from 'array-utils-ts';
-import { get, uniq, upperFirst, isArray, isObject, sortBy, lowerFirst, uniqBy } from 'lodash-es';
+import { get, uniq, upperFirst, isArray, isBoolean, isObject, sortBy, lowerFirst, uniqBy } from 'lodash-es';
 import { convertObj } from 'swagger2openapi';
 import ts from 'typescript';
 import path from 'node:path';
 
 var name = "apigen-ts";
-var version = "0.2.0";
+var version = "1.0.0";
 
 const initCtx = (config) => {
   return {
@@ -194,6 +194,16 @@ const makeInlineEnum = (s) => {
   console.warn(`enum with unknown type "${s.type}" in`, s);
   return void 0;
 };
+const makeObject = (ctx, s) => {
+  if (s.type !== "object") throw new Error(`makeObject: not an object ${JSON.stringify(s)}`);
+  if (s.additionalProperties && !isBoolean(s.additionalProperties)) {
+    return f$2.createTypeReferenceNode("Record", [
+      f$2.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
+      makeType(ctx, s.additionalProperties)
+    ]);
+  }
+  return f$2.createKeywordTypeNode(ts.SyntaxKind.ObjectKeyword);
+};
 const makeType = (ctx, s) => {
   const mk = makeType.bind(null, ctx);
   if (s === void 0) return f$2.createKeywordTypeNode(ts.SyntaxKind.VoidKeyword);
@@ -235,7 +245,7 @@ const makeType = (ctx, s) => {
       return mk({ oneOf: types });
     }
     let t;
-    if (s.type === "object") t = f$2.createKeywordTypeNode(ts.SyntaxKind.ObjectKeyword);
+    if (s.type === "object") t = makeObject(ctx, s);
     else if (s.type === "boolean") t = f$2.createKeywordTypeNode(ts.SyntaxKind.BooleanKeyword);
     else if (s.type === "number") t = f$2.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword);
     else if (s.type === "string") t = f$2.createKeywordTypeNode(ts.SyntaxKind.StringKeyword);

package/dist/{main-byN_-fkF.mjs → main-BTcttgNf.mjs}

@@ -4,13 +4,13 @@ import { fileURLToPath } from 'url';
 import { cli } from 'cleye';
 import redocly from '@redocly/openapi-core';
 import { filterEmpty, filterNullable } from 'array-utils-ts';
-import { get, uniq, upperFirst, isArray, isObject, sortBy, lowerFirst, uniqBy } from 'lodash-es';
+import { get, uniq, upperFirst, isArray, isBoolean, isObject, sortBy, lowerFirst, uniqBy } from 'lodash-es';
 import { convertObj } from 'swagger2openapi';
 import ts from 'typescript';
 import path from 'node:path';
 
 var name = "apigen-ts";
-var version = "0.2.0";
+var version = "1.0.0";
 
 const initCtx = (config) => {
   return {
@@ -194,6 +194,16 @@ const makeInlineEnum = (s) => {
   console.warn(`enum with unknown type "${s.type}" in`, s);
   return void 0;
 };
+const makeObject = (ctx, s) => {
+  if (s.type !== "object") throw new Error(`makeObject: not an object ${JSON.stringify(s)}`);
+  if (s.additionalProperties && !isBoolean(s.additionalProperties)) {
+    return f$2.createTypeReferenceNode("Record", [
+      f$2.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
+      makeType(ctx, s.additionalProperties)
+    ]);
+  }
+  return f$2.createKeywordTypeNode(ts.SyntaxKind.ObjectKeyword);
+};
 const makeType = (ctx, s) => {
   const mk = makeType.bind(null, ctx);
   if (s === void 0) return f$2.createKeywordTypeNode(ts.SyntaxKind.VoidKeyword);
@@ -235,7 +245,7 @@ const makeType = (ctx, s) => {
       return mk({ oneOf: types });
     }
     let t;
-    if (s.type === "object") t = f$2.createKeywordTypeNode(ts.SyntaxKind.ObjectKeyword);
+    if (s.type === "object") t = makeObject(ctx, s);
     else if (s.type === "boolean") t = f$2.createKeywordTypeNode(ts.SyntaxKind.BooleanKeyword);
     else if (s.type === "number") t = f$2.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword);
     else if (s.type === "string") t = f$2.createKeywordTypeNode(ts.SyntaxKind.StringKeyword);

package/dist/{main-Dkcn3PTN.cjs → main-oWgfChRG.cjs}

@@ -13,7 +13,7 @@ var path = require('node:path');
 
 var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
 var name = "apigen-ts";
-var version = "0.2.0";
+var version = "1.0.0";
 
 const initCtx = (config) => {
   return {
@@ -197,6 +197,16 @@ const makeInlineEnum = (s) => {
   console.warn(`enum with unknown type "${s.type}" in`, s);
   return void 0;
 };
+const makeObject = (ctx, s) => {
+  if (s.type !== "object") throw new Error(`makeObject: not an object ${JSON.stringify(s)}`);
+  if (s.additionalProperties && !lodashEs.isBoolean(s.additionalProperties)) {
+    return f$2.createTypeReferenceNode("Record", [
+      f$2.createKeywordTypeNode(ts.SyntaxKind.StringKeyword),
+      makeType(ctx, s.additionalProperties)
+    ]);
+  }
+  return f$2.createKeywordTypeNode(ts.SyntaxKind.ObjectKeyword);
+};
 const makeType = (ctx, s) => {
   const mk = makeType.bind(null, ctx);
   if (s === void 0) return f$2.createKeywordTypeNode(ts.SyntaxKind.VoidKeyword);
@@ -238,7 +248,7 @@ const makeType = (ctx, s) => {
       return mk({ oneOf: types });
     }
     let t;
-    if (s.type === "object") t = f$2.createKeywordTypeNode(ts.SyntaxKind.ObjectKeyword);
+    if (s.type === "object") t = makeObject(ctx, s);
     else if (s.type === "boolean") t = f$2.createKeywordTypeNode(ts.SyntaxKind.BooleanKeyword);
     else if (s.type === "number") t = f$2.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword);
     else if (s.type === "string") t = f$2.createKeywordTypeNode(ts.SyntaxKind.StringKeyword);
@@ -505,7 +515,7 @@ const apigen = async (config) => {
   const doc = await loadSchema(config.source);
   const ctx = initCtx({ ...config, doc });
   const { modules, types } = await generateAst(ctx);
-  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-Dkcn3PTN.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-oWgfChRG.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`,

package/dist/main.cjs

@@ -3,7 +3,7 @@
 require('fs/promises');
 require('path');
 require('url');
-var main = require('./main-Dkcn3PTN.cjs');
+var main = require('./main-oWgfChRG.cjs');
 require('cleye');
 require('@redocly/openapi-core');
 require('array-utils-ts');

package/dist/main.js

@@ -1,7 +1,7 @@
 import 'fs/promises';
 import 'path';
 import 'url';
-export { a as apigen } from './main-byN_-fkF.js';
+export { a as apigen } from './main-BTcttgNf.js';
 import 'cleye';
 import '@redocly/openapi-core';
 import 'array-utils-ts';

package/dist/main.mjs

@@ -1,7 +1,7 @@
 import 'fs/promises';
 import 'path';
 import 'url';
-export { a as apigen } from './main-byN_-fkF.mjs';
+export { a as apigen } from './main-BTcttgNf.mjs';
 import 'cleye';
 import '@redocly/openapi-core';
 import 'array-utils-ts';

package/package.json

@@ -1,11 +1,11 @@
 {
   "type": "module",
   "name": "apigen-ts",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "license": "MIT",
   "author": "vladkens <v.pronsky@gmail.com>",
   "repository": "vladkens/apigen-ts",
-  "description": "OpenAPI TypeScript client generator",
+  "description": "Simple typed OpenAPI client generator",
   "keywords": [
     "openapi",
     "swagger",
@@ -22,24 +22,24 @@
     "ci": "tsc --noEmit && yarn test-cov && yarn build"
   },
   "dependencies": {
-    "@redocly/openapi-core": "^1.22.1",
-    "@types/lodash-es": "^4.17.12",
-    "@types/swagger2openapi": "^7.0.4",
-    "array-utils-ts": "^0.1.2",
-    "cleye": "^1.3.2",
-    "lodash-es": "^4.17.21",
-    "swagger2openapi": "^7.0.8"
+    "@redocly/openapi-core": "1.25.5",
+    "@types/lodash-es": "4.17.12",
+    "@types/swagger2openapi": "7.0.4",
+    "array-utils-ts": "0.1.2",
+    "cleye": "1.3.2",
+    "lodash-es": "4.17.21",
+    "swagger2openapi": "7.0.8"
   },
   "devDependencies": {
-    "@types/node": "^22.5.2",
-    "c8": "^10.1.2",
-    "fetch-mock": "^11.1.3",
-    "pkgroll": "^2.4.2",
-    "prettier": "^3.3.3",
-    "prettier-plugin-organize-imports": "^4.0.0",
-    "tsm": "^2.3.0",
-    "typescript": "^5.5.4",
-    "uvu": "^0.5.6"
+    "@types/node": "22.7.5",
+    "c8": "10.1.2",
+    "fetch-mock": "11.1.5",
+    "pkgroll": "2.5.0",
+    "prettier": "3.3.3",
+    "prettier-plugin-organize-imports": "4.1.0",
+    "tsm": "2.3.0",
+    "typescript": "5.6.3",
+    "uvu": "0.5.6"
   },
   "peerDependencies": {
     "prettier": "^3.0.0",

package/readme.md

@@ -12,7 +12,7 @@
 
 <div align="center">
   <img src="./logo.svg" alt="apigen-ts logo" height="80" />
-  <div>TypeScript client generator from OpenAPI schema</div>
+  <div>Simple typed OpenAPI client generator</div>
 </div>
 
 ## Features
@@ -168,6 +168,33 @@ await apigen({
 
 Then run with: `node apigen.mjs`
 
+## Usage with different backend frameworks
+
+### FastAPI
+
+By default `apigen-ts` generates noisy method names when used with FastAPI. This can be fixed by [custom resolving](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#using-the-path-operation-function-name-as-the-operationid) for operations ids.
+
+```py
+from fastapi import FastAPI
+from fastapi.routing import APIRoute
+
+app = FastAPI()
+
+# add your routes here
+
+def update_operation_ids(app: FastAPI) -> None:
+    for route in app.routes:
+        if isinstance(route, APIRoute):
+            ns = route.tags[0] if route.tags else "general"
+            route.operation_id = f"{ns}_{route.name}".lower()
+
+
+# this function should be after all routes added
+update_operation_ids(app)
+```
+
+_Note: If you want FastAPI to be added as preset, open PR please._
+
 ## 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)