axigen 1.1.0 → 1.2.1

package/README.md

@@ -56,6 +56,10 @@ module.exports = {
 
   language: "ts",
   jsdoc: true,
+  functionName: {
+    transforms: [{ match: "-([a-zA-Z])", flags: "g", replacement: "upper:$1" }],
+    appendMethod: ["post", "put", "delete", "patch", "get", "head", "options"],
+  },
 };
 ```
 
@@ -78,7 +82,8 @@ paths:
   /users:
     get:
       operationId: getUsers
-      summary: List all users
+      summary: Get user list
+      tags: [users]
       parameters:
         - name: page
           in: query
@@ -88,74 +93,76 @@ paths:
           in: query
           schema:
             type: integer
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/User"
+                  total:
+                    type: integer
 
   /users/{userId}:
     get:
       operationId: getUserById
-      summary: Get a user by ID
-      parameters:
-        - name: userId
-          in: path
-          required: true
-          schema:
-            type: string
-
-    put:
-      operationId: updateUser
-      summary: Update a user
+      summary: Get user by ID
+      tags: [users]
       parameters:
         - name: userId
           in: path
           required: true
           schema:
             type: string
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/UpdateUserBody"
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/User"
 ```
 
 axigen generates:
 
 ```ts
-// src/api/client.ts — auto-generated by axigen, do not edit
+// This file is auto-generated by axigen. DO NOT EDIT.
+// Generated at: 2026-06-25T18:37:24.080Z
 
-import type { AxiosResponse } from "axios";
+import type { AxiosRequestConfig, AxiosResponse } from "axios";
 import { axiosInstance } from "../lib/axios";
-import type {
-  GetUsersQueryParams,
-  GetUsersResponse,
-  GetUserByIdPathParams,
-  GetUserByIdResponse,
-  UpdateUserPathParams,
-  UpdateUserBody,
-  UpdateUserResponse,
-} from "./types";
+import type { GetUserByIdPathParams, GetUserByIdResponse, GetUsersQueryParams, GetUsersResponse } from "./types";
 
 /**
- * List all users
+ * Get user list
  * `GET /users`
+ * @tags users
  */
-export async function getUsers(params?: GetUsersQueryParams): Promise<AxiosResponse<GetUsersResponse>> {
-  return axiosInstance.get("/users", { params });
+export async function getUsersGet(
+  params?: GetUsersQueryParams,
+  config?: AxiosRequestConfig,
+  options?: AxiosRequestConfig,
+): Promise<AxiosResponse<GetUsersResponse>> {
+  const mergedConfig: AxiosRequestConfig = { ...config, params: { ...params, ...config?.params } };
+  return axiosInstance({ method: "GET", url: "/users", ...mergedConfig }, options);
 }
 
 /**
- * Get a user by ID
+ * Get user by ID
  * `GET /users/{userId}`
+ * @tags users
  */
-export async function getUserById(userId: GetUserByIdPathParams["userId"]): Promise<AxiosResponse<GetUserByIdResponse>> {
-  return axiosInstance.get(`/users/${userId}`);
-}
-
-/**
- * Update a user
- * `PUT /users/{userId}`
- */
-export async function updateUser(userId: UpdateUserPathParams["userId"], data: UpdateUserBody): Promise<AxiosResponse<UpdateUserResponse>> {
-  return axiosInstance.put(`/users/${userId}`, data);
+export async function getUserByIdGet(
+  userId: GetUserByIdPathParams["userId"],
+  config?: AxiosRequestConfig,
+  options?: AxiosRequestConfig,
+): Promise<AxiosResponse<GetUserByIdResponse>> {
+  return axiosInstance({ method: "GET", url: `/users/${userId}`, ...config }, options);
 }
 ```
 
@@ -163,31 +170,44 @@ export async function updateUser(userId: UpdateUserPathParams["userId"], data: U
 
 ## Configuration
 
-| Option                | Type           | Default         | Description                                           |
-| --------------------- | -------------- | --------------- | ----------------------------------------------------- |
-| `input`               | `string`       | —               | Path to your OpenAPI spec file (YAML or JSON)         |
-| `output.client`       | `string`       | —               | Output path for the generated client functions        |
-| `output.types`        | `string`       | —               | Output path for generated TypeScript types (optional) |
-| `axiosInstancePath`   | `string`       | —               | Import path to your Axios instance                    |
-| `axiosInstanceExport` | `string`       | `axiosInstance` | Named export of your Axios instance                   |
-| `language`            | `'ts' \| 'js'` | `'ts'`          | Output language                                       |
-| `jsdoc`               | `boolean`      | `true`          | Add JSDoc comments to generated functions             |
-| `tags`                | `string[]`     | —               | Only generate endpoints matching these tags           |
+| Option                      | Type           | Default         | Description                                                              |
+| --------------------------- | -------------- | --------------- | ------------------------------------------------------------------------ |
+| `input`                     | `string`       | —               | Path to your OpenAPI spec file (YAML or JSON)                            |
+| `output.client`             | `string`       | —               | Output path for the generated client functions                           |
+| `output.types`              | `string`       | —               | Output path for generated TypeScript types (optional)                    |
+| `axiosInstancePath`         | `string`       | —               | Import path to your Axios instance                                       |
+| `axiosInstanceExport`       | `string`       | `axiosInstance` | Named export of your Axios instance                                      |
+| `language`                  | `'ts' \| 'js'` | `'ts'`          | Output language                                                          |
+| `jsdoc`                     | `boolean`      | `true`          | Add JSDoc comments to generated functions                                |
+| `tags`                      | `string[]`     | —               | Only generate endpoints matching these tags                              |
+| `functionName`              | `object`       | —               | Control generated function name transforms and method suffix (see below) |
+| `functionName.transforms`   | `Transform[]`  | `[]`            | Array of regex transform rules applied to the operationId                |
+| `functionName.appendMethod` | `string[]`     | `[]`            | HTTP methods whose name is appended as a suffix to the function name     |
 
 ### Axios Instance
 
-axigen does not create an Axios instance for you — it imports the one you already have in your project. For example:
+axigen does not create an Axios instance for you — it imports the one you already have in your project. The generated functions expect your instance to follow this call signature:
+
+```ts
+axiosInstance(config: AxiosRequestConfig, options?: AxiosRequestConfig): Promise<AxiosResponse>
+```
+
+This is intentional: it lets you intercept or merge options at the instance level (e.g. passing per-request auth headers or timeout overrides as a second argument), keeping generated code decoupled from your instance's internal logic.
+
+A typical instance looks like this:
 
 ```ts
 // src/lib/axios.ts
-import axios from "axios";
+import axios, { type AxiosRequestConfig } from "axios";
 
-export const axiosInstance = axios.create({
+const instance = axios.create({
   baseURL: "https://api.example.com/v1",
   headers: {
     "Content-Type": "application/json",
   },
 });
+
+export const axiosInstance = (config: AxiosRequestConfig, options?: AxiosRequestConfig) => instance({ ...config, ...options });
 ```
 
 Then in your config:
@@ -197,6 +217,8 @@ axiosInstancePath: '../lib/axios',
 axiosInstanceExport: 'axiosInstance', // default, can be omitted
 ```
 
+> **Note:** If you use a plain `axios.create()` instance without the two-argument wrapper, the `options` parameter passed by generated functions will be ignored. The wrapper pattern above is the recommended approach.
+
 ---
 
 ## CLI

package/dist/cli/index.mjs

@@ -623,6 +623,10 @@ module.exports = {
   axiosInstancePath: '../lib/axios',
   language: 'ts',
   jsdoc: true,
+  functionName: {
+    transforms: [{ match: "-([a-zA-Z])", flags: "g", replacement: "upper:$1" }],
+    appendMethod: ["post", "put", "delete", "patch", "get", "head", "options"],
+  },
 }
 `;
   fs4.writeFileSync(dest, template, "utf-8");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axigen",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "Generate typed Axios client functions from OpenAPI / Swagger specs",
   "keywords": [
     "openapi",