@icib.dev/api-client 1.1.1 → 1.1.3

package/README.md

@@ -61,9 +61,13 @@ BASE_PATH=/v2 npx api-client-generate
 # Custom client base URL (default: from spec URL, BASE_URL, or spec host)
 npx api-client-generate --base-url https://api.mycompany.com
 BASE_URL=https://api.mycompany.com npx api-client-generate
+
+# Override client.ts (by default, existing client is preserved if you customized it)
+npx api-client-generate --override-client   # prompts for confirmation
+npx api-client-generate --override-client --yes   # skip confirmation (e.g. CI)
 ```
 
-The client is generated in your project directory (e.g. `./api/`).
+The client is generated in your project directory (e.g. `./api/`). If `client.ts` already exists, it is **not** overwritten unless you pass `--override-client` (which prompts for confirmation; use `--yes` to skip the prompt).
 
 ### From the library repo (maintainers)
 

package/dist/scripts/generate.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
-import { readFileSync, mkdirSync, writeFileSync } from "fs";
+import { readFileSync, mkdirSync, writeFileSync, existsSync } from "fs";
+import { createInterface } from "readline";
 import { dirname, join } from "path";
 import { fileURLToPath } from "url";
 import SwaggerParser from "@apidevtools/swagger-parser";
@@ -20,6 +21,8 @@ function parseArgs() {
     let out = DEFAULT_OUT;
     let basePath = process.env.BASE_PATH;
     let baseUrl = process.env.BASE_URL;
+    let overrideClient = false;
+    let yes = false;
     for (let i = 0; i < args.length; i++) {
         if (args[i] === "--url" && args[i + 1]) {
             url = args[++i];
@@ -35,8 +38,24 @@ function parseArgs() {
             args[i + 1]) {
             baseUrl = args[++i];
         }
+        else if (args[i] === "--override-client" || args[i] === "--overwrite-client") {
+            overrideClient = true;
+        }
+        else if (args[i] === "--yes" || args[i] === "-y") {
+            yes = true;
+        }
     }
-    return { url, out, basePath, baseUrl };
+    return { url, out, basePath, baseUrl, overrideClient, yes };
+}
+function askConfirmation(question) {
+    return new Promise((resolve) => {
+        const rl = createInterface({ input: process.stdin, output: process.stdout });
+        rl.question(question, (answer) => {
+            rl.close();
+            const normalized = answer.trim().toLowerCase();
+            resolve(normalized === "y" || normalized === "yes");
+        });
+    });
 }
 async function fetchSpec(url) {
     const res = await fetch(url);
@@ -92,7 +111,11 @@ function getDefinitions(doc) {
 function getPaths(doc) {
     return doc.paths ?? {};
 }
-/** Extract response schema from OpenAPI 2.0 (schema) or OpenAPI 3.0 (content) */
+/**
+ * Extract response schema. Compatible with:
+ * - OpenAPI 2.0: response.schema
+ * - OpenAPI 3.0: response.content['application/json'].schema
+ */
 function getResponseSchema(response) {
     if (!response || typeof response !== "object")
         return undefined;
@@ -111,6 +134,23 @@ function getResponseSchema(response) {
     }
     return undefined;
 }
+/**
+ * Extract request body schema from OpenAPI 3.0 requestBody.content.
+ * OpenAPI 2.0 uses parameters with in: "body" (handled separately in extractOperations).
+ */
+function getRequestBodySchema(requestBody) {
+    if (!requestBody || typeof requestBody !== "object")
+        return undefined;
+    const rb = requestBody;
+    const content = rb.content;
+    if (content) {
+        const jsonContent = content["application/json"] ??
+            content["*/*"] ??
+            Object.values(content)[0];
+        return jsonContent?.schema;
+    }
+    return undefined;
+}
 function schemaToTsType(schema, definitions, refsSeen = new Set()) {
     if (!schema)
         return "unknown";
@@ -269,6 +309,29 @@ function extractOperations(paths, definitions) {
                     };
                 }
             }
+            // OpenAPI 3.0: body in requestBody (OAS 2.0 uses parameters in: "body" above)
+            if (!bodyParam && op.requestBody) {
+                const bodySchema = getRequestBodySchema(op.requestBody);
+                if (bodySchema) {
+                    const propertyDescriptions = {};
+                    if (bodySchema.properties) {
+                        for (const [propName, propSchema] of Object.entries(bodySchema.properties)) {
+                            const desc = propSchema
+                                .description ??
+                                propSchema.title;
+                            if (desc)
+                                propertyDescriptions[propName] = desc;
+                        }
+                    }
+                    bodyParam = {
+                        name: "data",
+                        schema: bodySchema,
+                        propertyDescriptions: Object.keys(propertyDescriptions).length > 0
+                            ? propertyDescriptions
+                            : undefined,
+                    };
+                }
+            }
             const successResponse = op.responses?.["200"] ?? op.responses?.["201"];
             const respSchema = getResponseSchema(successResponse);
             const respDesc = successResponse?.description ?? "";
@@ -676,7 +739,7 @@ function generateIndex(contextTags) {
     return exports.join("\n");
 }
 async function main() {
-    const { url, out, basePath: basePathOverride, baseUrl: baseUrlOverride, } = parseArgs();
+    const { url, out, basePath: basePathOverride, baseUrl: baseUrlOverride, overrideClient, yes, } = parseArgs();
     console.log(`Fetching spec from ${url}...`);
     const rawSpec = await loadRawSpec(url);
     const doc = await parseSpec(rawSpec);
@@ -713,7 +776,23 @@ async function main() {
         ? `${baseUrl.replace(/\/$/, "")}${basePath}`
         : baseUrl;
     writeFileSync(join(typesDir, "index.ts"), generateTypes(definitions));
-    writeFileSync(join(outDir, "client.ts"), generateClient(clientBaseUrl));
+    const clientPath = join(outDir, "client.ts");
+    const clientExists = existsSync(clientPath);
+    let writeClient = !clientExists;
+    if (clientExists) {
+        if (overrideClient) {
+            if (yes) {
+                writeClient = true;
+            }
+            else {
+                const confirmed = await askConfirmation("This will overwrite your client.ts. Are you sure? (y/N) ");
+                writeClient = confirmed;
+            }
+        }
+    }
+    if (writeClient) {
+        writeFileSync(clientPath, generateClient(clientBaseUrl));
+    }
     const sortedTags = [...byTag.keys()].sort();
     for (const tag of sortedTags) {
         const ctxName = sanitizeContextName(tag);
@@ -736,7 +815,7 @@ async function main() {
     writeFileSync(manifestPath, JSON.stringify(manifest, null, 2));
     console.log(`Generated API client in ${outDir}`);
     console.log(`  - types/index.ts`);
-    console.log(`  - client.ts`);
+    console.log(`  - client.ts${writeClient ? "" : " (skipped, use --override-client to overwrite)"}`);
     console.log(`  - apiClient.ts`);
     console.log(`  - contexts/*.ts (${sortedTags.length} files)`);
     console.log(`  - index.ts`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@icib.dev/api-client",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "Generator for strictly-typed TypeScript API clients from OpenAPI specs",
   "type": "module",
   "bin": {