@ps-aux/api-client-gen 0.1.2-rc1 → 0.7.0-rc.3

package/dist/index.mjs

@@ -0,0 +1,10 @@
+export { g as generateApiClient } from './generateApiClient.mjs';
+import 'path';
+import 'fs';
+import 'fs/promises';
+import 'swagger-typescript-api';
+import 'node:url';
+import 'node:fs/promises';
+import 'node:path';
+import 'node:fs';
+import 'ts-to-zod';

package/package.json

@@ -1,28 +1,80 @@
 {
   "name": "@ps-aux/api-client-gen",
-  "version": "0.1.2-rc1",
-  "main": "dist/index.js",
-  "module": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
+  "version": "0.7.0-rc.3",
+  "main": "dist/index.cjs",
+  "type": "module",
   "bin": {
-    "gen-api-client": "dist/bin.js"
+    "gen-api-client": "dist/bin.cjs"
   },
   "scripts": {
-    "build": "rollup -c",
+    "build": "npm run clean && rollup -c && node scripts/ensure-bin-executable.mjs",
+    "clean": "rm -rf dist",
     "dev": "rollup -c --watch",
-    "pub": "npm test && npm run build && npm publish",
-    "test": "vitest",
-    "tc": "tsc"
+    "lint": "eslint",
+    "pack:tarball": "npm run build && npm pack",
+    "prepublishOnly": "echo \"Publishing disabled for this repo. Use CI workflow.\" && exit 1",
+    "test": "npm run test:generation && npm run test:generated-code && npm run tc:after-gen",
+    "test:generation": "vitest run test/generateApiClient.spec.ts test/gen-open-api/*/generate*.spec.ts test/gen-open-api/*/integration.spec.ts",
+    "test:generated-code": "vitest run test/gen-open-api/swagger-ts-api/contract.spec.ts test/gen-open-api/v-next/contract.spec.ts",
+    "tc": "echo 'No typecheck'",
+    "tc:after-gen": "tsc",
+    "tc:v-next-compat": "tsc -p tsconfig.v-next-compat.json"
   },
-  "author": "",
-  "license": "ISC",
+  "author": "psaux",
+  "license": "MIT",
   "dependencies": {
-    "axios": "1.5.0",
-    "cosmiconfig": "8.3.6",
+    "cosmiconfig": "9.0.0",
+    "eta": "^2.2.0",
+    "prettier": "^3.8.1",
     "swagger-typescript-api": "13.0.23",
-    "ts-to-zod": "3.15.0"
+    "ts-to-zod": "5.1.0",
+    "zod": "^4.3.6"
   },
   "devDependencies": {
-    "vitest": "^3.1.1"
-  }
+    "@local/open-api": "file:../../shared/open-api"
+  },
+  "description": "CLI and programmatic generator for OpenAPI clients with optional Zod schemas.",
+  "keywords": [
+    "openapi",
+    "client",
+    "generator",
+    "swagger",
+    "zod",
+    "typescript",
+    "cli"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ps-aux/api-tests.git",
+    "directory": "packages/api-client-generator"
+  },
+  "homepage": "https://github.com/ps-aux/api-tests",
+  "bugs": {
+    "url": "https://github.com/ps-aux/api-tests/issues"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "templates",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "default": "./dist/index.mjs"
+    }
+  },
+  "sideEffects": false
 }

package/templates/api.ejs

@@ -26,8 +26,6 @@ const descriptionLines = _.compact([
 
 %>
 
-<% if (config.httpClientType === config.constants.HTTP_CLIENT.AXIOS) { %> import type { AxiosRequestConfig, AxiosResponse } from "axios"; <% } %>
-
 <% if (descriptionLines.length) { %>
 /**
 <% descriptionLines.forEach((descriptionLine) => { %>
@@ -36,13 +34,8 @@ const descriptionLines = _.compact([
 <% }) %>
 */
 <% } %>
-export class <%~ config.apiClassName %><RequestParams>{
-
-  http: HttpClient<RequestParams>;
-
-  constructor (http: HttpClient<RequestParams>) {
-    this.http = http;
-  }
+export class <%~ config.apiClassName %><RequestParams = never>{
+  constructor (private http: HttpClient<RequestParams>) {}
 
   <% for (const { routes: combinedRoutes = [], moduleName } of routes.combined) { %>
   <%~ moduleName %> = {

package/templates/http-client.eta

@@ -1,20 +1,44 @@
-export type ContentType = {}
+export type KnownRequestContentType =
+    | 'application/json'
+    | 'multipart/form-data'
+    | 'application/x-www-form-urlencoded'
 
-export const ContentType = {
-    Json: 'application/json',
-    FormData: 'multipart/form-data',
-}
+export type RequestContentType = KnownRequestContentType | string
+
+export type QueryValue =
+    | string
+    | number
+    | boolean
+    | null
+    | undefined
+    | QueryValue[]
+    | Record<string, any>
+    // Empty schema support
+    | unknown
+
+export type QueryParams = Record<string, QueryValue>
 
 export type Request = {
     path: string
     method: 'GET' | 'POST' | 'PUT' | 'DELETE'
     format?: 'json' | 'document'
-    query?: any
+    headers?: Record<string, string>
+    query?: QueryParams
     body?: any
-    type?: string
-    secure?: boolean
+    requestContentType?: RequestContentType
 }
 
-export type HttpClient<RequestParams> = {
-    request: <Data>(req: Request, params?: RequestParams) => Promise<Data>
+export type HttpResponse<Data> = {
+    body: Data
+    headers: Record<string, string | string[]>
+    status: number
+}
+
+export type QuerySerializer = (params: QueryParams) => string
+
+export type HttpClient<RequestParams = never> = {
+    request: <Data>(
+        req: Request,
+        params?: RequestParams
+    ) => Promise<HttpResponse<Data>>
 }

package/templates/procedure-call.ejs

@@ -2,16 +2,14 @@
 const { utils, route, config } = it;
 const { requestBodyInfo, responseBodyInfo, specificArgNameResolver } = route;
 const { _, getInlineParseContent, getParseContent, parseSchema, getComponentByRef, require } = utils;
-const { parameters, path, method, payload, query, formData, security, requestParams } = route.request;
+const { parameters, path, method, payload, query, formData, requestParams } = route.request;
 const { type, errorType, contentTypes } = route.response;
-const { HTTP_CLIENT, RESERVED_REQ_PARAMS_ARG_NAMES } = config.constants;
+const { RESERVED_REQ_PARAMS_ARG_NAMES } = config.constants;
 const routeDocs = includeFile("@base/route-docs", { config, route, utils });
 const queryName = (query && query.name) || "query";
 const pathParams = _.values(parameters);
 const pathParamsNames = _.map(pathParams, "name");
 
-const isFetchTemplate = config.httpClientType === HTTP_CLIENT.FETCH;
-
 const requestConfigParam = {
     name: specificArgNameResolver.resolve(RESERVED_REQ_PARAMS_ARG_NAMES),
     optional: true,
@@ -44,47 +42,58 @@ const wrapperArgs = _
     .map(argToTmpl)
     .join(', ')
 
-// RequestParams["type"]
+// Request["requestContentType"]
 const requestContentKind = {
-    "JSON": "ContentType.Json",
-    "URL_ENCODED": "ContentType.UrlEncoded",
-    "FORM_DATA": "ContentType.FormData",
-    "TEXT": "ContentType.Text",
+    "JSON": '"application/json"',
+    "URL_ENCODED": '"application/x-www-form-urlencoded"',
+    "FORM_DATA": '"multipart/form-data"',
+    "TEXT": '"text/plain"',
 }
 // RequestParams["format"]
 const responseContentKind = {
     "JSON": '"json"',
     "IMAGE": '"blob"',
-    "FORM_DATA": isFetchTemplate ? '"formData"' : '"document"'
+    "FORM_DATA": '"document"'
 }
 
 const bodyTmpl = _.get(payload, "name") || null;
 const queryTmpl = (query != null && queryName) || null;
 const bodyContentKindTmpl = requestContentKind[requestBodyInfo.contentKind] || null;
-const responseFormatTmpl = responseContentKind[responseBodyInfo.success && responseBodyInfo.success.schema && responseBodyInfo.success.schema.contentKind] || null;
-const securityTmpl = security ? 'true' : null;
+const successResponseSchema = _.get(responseBodyInfo, "success.schema") || null;
+const hasBinaryResponseSchema = _.some(
+    _.values(_.get(successResponseSchema, "content", {})),
+    contentItem => {
+        const schema = _.get(contentItem, "schema");
+        return (
+            _.get(schema, "type") === "string" &&
+            _.get(schema, "format") === "binary"
+        );
+    }
+);
+// TODO understand this more. Right know we believe the agent it is needed.
+const hasFileResponseType = typeof type === "string" &&
+    /(^|[^a-zA-Z0-9_])File([^a-zA-Z0-9_]|$)/.test(type);
+const responseFormatByContentKind = responseContentKind[
+    responseBodyInfo.success &&
+        responseBodyInfo.success.schema &&
+        responseBodyInfo.success.schema.contentKind
+] || null;
+const responseFormatTmpl = hasBinaryResponseSchema || hasFileResponseType
+    ? '"document"'
+    : responseFormatByContentKind;
+const routeDocLines = routeDocs.lines ? `${routeDocs.lines}\n` : '';
 
 const describeReturnType = () => {
     if (!config.toJS) return "";
-
-    switch(config.httpClientType) {
-        case HTTP_CLIENT.AXIOS: {
-          return `Promise<AxiosResponse<${type}>>`
-        }
-        default: {
-          return `Promise<HttpResponse<${type}, ${errorType}>`
-        }
-    }
+    return `Promise<${type}>`
 }
 
 %>
 /**
+<% if (route.raw.description) { %>
 <%~ routeDocs.description %>
-
- *<% /* Here you can add some other JSDoc tags */ %>
-
-<%~ routeDocs.lines %>
-
+<% } %>
+<%~ routeDocLines %>
  */
 <%~ route.routeName.usage %><%~ route.namespace ? ': ' : ' = ' %>(<%~ wrapperArgs %>)<%~ config.toJS ? `: ${describeReturnType()}` : "" %> =>
     <%~ config.singleHttpClient ? 'this.http.request' : 'this.request' %><<%~ type %>>({
@@ -92,7 +101,6 @@ const describeReturnType = () => {
         method: '<%~ _.upperCase(method) %>',
         <%~ queryTmpl ? `query: ${queryTmpl},` : '' %>
         <%~ bodyTmpl ? `body: ${bodyTmpl},` : '' %>
-        <%~ securityTmpl ? `secure: ${securityTmpl},` : '' %>
-        <%~ bodyContentKindTmpl ? `type: ${bodyContentKindTmpl},` : '' %>
+        <%~ bodyContentKindTmpl ? `requestContentType: ${bodyContentKindTmpl},` : '' %>
         <%~ responseFormatTmpl ? `format: ${responseFormatTmpl},` : '' %>
-    }, params)<%~ route.namespace ? ',' : '' %>
+    }, params).then(res => res.body)<%~ route.namespace ? ',' : '' %>

package/dist/bin.esm.js

@@ -1,22 +0,0 @@
-#!/bin/env node
-import { g as generateApiClient } from './generateApiClient-QyDbHHKj.js';
-import { cosmiconfigSync } from 'cosmiconfig';
-import 'path';
-import 'fs';
-import 'axios';
-import 'fs/promises';
-import 'swagger-typescript-api';
-import 'ts-to-zod';
-
-const profile = process.argv[2];
-if (!profile)
-    throw new Error(`No profile specified`);
-const conf = cosmiconfigSync('api-client-gen')
-    .search();
-// TODO validate config
-if (!conf)
-    throw new Error(`No config provided`);
-const profileConf = conf.config[profile];
-if (!profile)
-    throw new Error(`Profile ${profile} not present in the configuration`);
-generateApiClient(profileConf).catch(console.error);

package/dist/bin.js

@@ -1,24 +0,0 @@
-#!/bin/env node
-'use strict';
-
-var generateApiClient = require('./generateApiClient-C11lxAxn.js');
-var cosmiconfig = require('cosmiconfig');
-require('path');
-require('fs');
-require('axios');
-require('fs/promises');
-require('swagger-typescript-api');
-require('ts-to-zod');
-
-const profile = process.argv[2];
-if (!profile)
-    throw new Error(`No profile specified`);
-const conf = cosmiconfig.cosmiconfigSync('api-client-gen')
-    .search();
-// TODO validate config
-if (!conf)
-    throw new Error(`No config provided`);
-const profileConf = conf.config[profile];
-if (!profile)
-    throw new Error(`Profile ${profile} not present in the configuration`);
-generateApiClient.generateApiClient(profileConf).catch(console.error);

package/dist/downloadSpec.d.ts

@@ -1 +0,0 @@
-export declare const downloadSpec: (path: string, url: string) => Promise<void>;

package/dist/generateApiClient-BHDOH9mh.js

@@ -1,188 +0,0 @@
-'use strict';
-
-var Path = require('path');
-var fs$1 = require('fs');
-var axios = require('axios');
-var fs = require('fs/promises');
-var swaggerTypescriptApi = require('swagger-typescript-api');
-var tsToZod = require('ts-to-zod');
-
-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 fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs$1);
-
-const downloadSpec = async (path, url) => {
-    const res = await axios({
-        url,
-        method: 'GET',
-        responseType: 'arraybuffer',
-    }).catch(err => {
-        throw err.toString();
-    });
-    const content = res.data.toString();
-    await fs.writeFile(path, format(content));
-};
-const format = (content) => JSON.stringify(JSON.parse(content), null, 4);
-
-const generateOpenApiModel = async ({ input, isNode, responseWrapper, name, outputDir }, log) => {
-    log(`Will generate API client name=${name} to ${outputDir}, node=${isNode}`);
-    const specialMapping = isNode
-        ? {
-            File: '{file: Buffer | stream.Readable, name: string}',
-        }
-        : {};
-    const fileName = 'index';
-    const dstFile = Path.join(outputDir, `${fileName}.ts`);
-    await swaggerTypescriptApi.generateApi({
-        name: 'index',
-        output: outputDir,
-        input: input,
-        // modular: true,
-        httpClientType: 'axios',
-        templates: Path.resolve(getThisScriptDirname(), '../templates'),
-        defaultResponseAsSuccess: true,
-        // generateRouteTypes: true,
-        singleHttpClient: true,
-        // extractRequestBody: true,
-        cleanOutput: true,
-        moduleNameFirstTag: true,
-        apiClassName: capitalize(name) + 'Api',
-        // @ts-ignore
-        codeGenConstructs: (struct) => ({
-            // @ts-ignore
-            Keyword: specialMapping,
-        }),
-        // extractRequestParams: true,
-    });
-    const addImports = [];
-    const replaces = [];
-    if (isNode) {
-        addImports.push('import stream from \'node:stream\'');
-    }
-    if (responseWrapper) {
-        log(`Will use response wrapper '${JSON.stringify(responseWrapper)}'`);
-        if (responseWrapper.import)
-            addImports.push(responseWrapper.import);
-        replaces.push(['Promise', responseWrapper.symbol]);
-    }
-    // Remove unnecessary generics
-    replaces.push(['<SecurityDataType extends unknown>', '']);
-    replaces.push(['<SecurityDataType>', '']);
-    log(`Will modify the outputs ${JSON.stringify({
-        addImports,
-        replaces,
-    })}`);
-    await modifyOutput(dstFile, {
-        addImports,
-        replaces,
-    });
-    return dstFile;
-};
-const modifyOutput = async (path, cmd) => {
-    let content = await fs.readFile(path).then((r) => r.toString());
-    if (cmd.addImports.length) {
-        content = cmd.addImports.join('\n') + '\n' + content;
-    }
-    cmd.replaces.forEach(([from, to]) => {
-        content = content.replaceAll(from, to);
-    });
-    await fs.writeFile(path, content);
-};
-const getThisScriptDirname = () => {
-    // Might be problem in ESM mode
-    return __dirname;
-};
-const capitalize = (str) => {
-    return str[0].toUpperCase() + str.substring(1);
-};
-
-// TODO needed?
-const removeGenericTypes = (code) => {
-    const regex = /export (interface|enum|type) [^<]* \{\n(.*\n)*?}/mg;
-    const matches = code.matchAll(regex);
-    const types = Array.from(matches).map(m => m[0]);
-    return types.join('\n');
-};
-const generateSchemas = (inputFile, outputFile, opts = {}) => {
-    const code = fs$1.readFileSync(inputFile).toString();
-    const { getZodSchemasFile } = tsToZod.generate({
-        sourceText: removeGenericTypes(code),
-        // inputOutputMappings: {
-        //
-        // },
-        customJSDocFormatTypes: {
-        // Custom mapping
-        // 'date-time': 'blablaj' - regex
-        }
-    });
-    const fileName = Path.basename(inputFile);
-    let f = getZodSchemasFile(`./${fileName.replace('.ts', '')}`);
-    // Add import from the api model - TODO find a way how to define on generate
-    f = f.replaceAll('"./index";', '"./client"');
-    // Backend sends nulls not undefined - should be properly set in the OpenAPI TS types generation!
-    f = f.replaceAll('.optional()', '.nullable()');
-    if (opts.localDateTimes) {
-        f = f.replaceAll('z.string().datetime()', 'z.string().datetime({local: true})');
-    }
-    fs$1.writeFileSync(outputFile, f);
-};
-
-const generateApiClient = async ({ dstDir, apiName, env, srcSpec, responseWrapper, zodSchemas, }, log = console.log) => {
-    if (!srcSpec)
-        throw new Error(`Url or path ('srcSpec' not specified`);
-    if (!apiName)
-        throw new Error('apiName not specified');
-    if (!dstDir)
-        throw new Error('dstDir not specified');
-    if (!env)
-        throw new Error('env not specified');
-    const dir = Path.resolve(dstDir, apiName);
-    if (!fs__namespace.existsSync(dir)) {
-        log(`Creating dir ${dir}`);
-        fs__namespace.mkdirSync(dir, {
-            recursive: true,
-        });
-    }
-    const clientDir = Path.resolve(dir, 'client');
-    const specPath = await getSpecPath(srcSpec, dir, log);
-    const clientFile = await generateOpenApiModel({
-        name: apiName,
-        input: specPath,
-        outputDir: clientDir,
-        isNode: env === 'node',
-        responseWrapper,
-    }, log);
-    console.log('client file', clientFile);
-    if (zodSchemas?.enabled === false)
-        return;
-    log('Generating Zod schemas');
-    generateSchemas(Path.resolve(dir, clientFile), Path.resolve(dir, './zod.ts'), zodSchemas);
-};
-const getSpecPath = async (urlOrPath, dir, log) => {
-    if (!urlOrPath.startsWith('http')) {
-        if (!fs__namespace.existsSync(urlOrPath))
-            throw new Error(`Spec file ${urlOrPath} does not exists`);
-        return urlOrPath;
-    }
-    const specPath = Path.resolve(dir, `spec.json`);
-    log(`Will download the API spec from ${urlOrPath} to ${specPath}`);
-    await downloadSpec(specPath, urlOrPath);
-    return specPath;
-};
-
-exports.generateApiClient = generateApiClient;