api-farmer 0.0.17 → 0.0.19

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 varletjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -56,6 +56,16 @@ npx af
 
 Some simple usage examples can be found [here](fixtures)
 
+### Custom code generation templates
+
+Create `api-farmer.ejs` in the project root, which will replace the `preset` template.
+The template format can refer to the preset template listed below:
+
+- [Axle](templates/axle.ejs)
+- [Axios](templates/axios.ejs)
+
+And see the bottom of the document for template variable definitions.
+
 ### Transformer API
 
 You can use the Transformer API to further define template variables, which will override the default transformation rules.
@@ -86,26 +96,18 @@ export default defineConfig({
 })
 ```
 
-### Custom EJS Template
-
-Create `api-farmer.ejs` in the project root, which will replace the `preset` template.
-The template format can refer to the preset template listed below:
-
-- [Axle](templates/axle.ejs)
-- [Axios](templates/axios.ejs)
-
-See the bottom of the document for template variable definitions.
-
 ### Configuration Options
 
 ```ts
 export interface Config {
   /**
    * The path to the OpenAPI/Swagger schema file.
+   * @default './schema.json'
    */
   input?: string
   /**
    * The path to the output directory.
+   * @default './src/apis/generated'
    */
   output?: string
   /**
@@ -114,28 +116,38 @@ export interface Config {
   base?: string
   /**
    * The filename of the generated openapi types file.
+   * @default '_types.ts'
    */
   typesFilename?: string
-  /**
-   * The transformer api options, used to override the default transformation rules.
-   */
-  transformer?: Partial<Transformer>
   /**
    * Whether to generate TypeScript code.
+   * @default true
    */
   ts?: boolean
   /**
    * Whether to generate only types.
+   * @default false
    */
   typesOnly?: boolean
   /**
    * Whether to override the existing files, or an array of filenames to override.
+   * @default true
    */
   overrides?: boolean | string[]
   /**
    * The preset ejs template to use.
+   * @default 'axle'
    */
   preset?: Preset
+  /**
+   * Defines which return status codes will be typed
+   * @default (status) => status >= 200 && status < 300
+   */
+  validateStatus?: (status: number) => boolean
+  /**
+   * The transformer api options, used to override the default transformation rules.
+   */
+  transformer?: Partial<Transformer>
 }
 ```
 

package/dist/{chunk-J2G2MBMU.js → chunk-K46PCBCF.js}

@@ -1,12 +1,12 @@
 import {
   CWD,
   SUPPORTED_HTTP_METHODS,
-  getSuccessfulResponseMeme,
+  getValidResponseMetadataItems,
   hasQueryParameter,
   isRequiredRequestBody,
   readSchema,
   readTemplateFile
-} from "./chunk-MLHGCJ6R.js";
+} from "./chunk-SKKHIIUE.js";
 import {
   __export
 } from "./chunk-6OIOYGN7.js";
@@ -22803,10 +22803,9 @@ function transformTypeResponseBody({
 }
 function transformTypeResponseBodyValue({
   type: type2,
-  statusCode,
-  mime
+  responseMetadataItems
 }) {
-  return `${type2}['responses']['${statusCode}']['content']['${mime}']`;
+  return responseMetadataItems.map(({ status, mime }) => `${type2}['responses']['${status}']['content']['${mime}']`).join(" | ");
 }
 function createTransformer() {
   return {
@@ -22828,7 +22827,7 @@ function createTransformer() {
 
 // src/generate.ts
 function transformPayloads(pathItems, options8) {
-  const { transformer, path: path13, base } = options8;
+  const { transformer, path: path13, base, validateStatus } = options8;
   return Object.entries(pathItems).filter(([key2]) => SUPPORTED_HTTP_METHODS.includes(key2)).reduce((payloads, [method, operation]) => {
     const url2 = transformer.url({ path: path13, base });
     const args = { path: path13, base, url: url2, method, operation };
@@ -22847,9 +22846,9 @@ function transformPayloads(pathItems, options8) {
       entity,
       required: isRequiredRequestBody(operation.requestBody)
     }) : "undefined";
-    const { mime, statusCode } = getSuccessfulResponseMeme(operation);
     const typeResponseBody = transformer.typeResponseBody({ ...args, type: type2, verb, entity });
-    const typeResponseBodyValue = mime && statusCode ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, statusCode, mime }) : "undefined";
+    const responseMetadataItems = getValidResponseMetadataItems(operation, validateStatus);
+    const typeResponseBodyValue = responseMetadataItems.length > 0 ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, responseMetadataItems }) : "undefined";
     payloads.push({
       fn,
       url: url2,
@@ -22869,14 +22868,16 @@ function transformPayloads(pathItems, options8) {
   }, []);
 }
 function partitionApiModules(schema2, options8) {
-  const { base, transformer } = options8;
+  const { base, transformer, validateStatus } = options8;
   const schemaPaths = schema2.paths ?? {};
   const schemaPathKeys = base ? Object.keys(schemaPaths).map((key2) => key2.replace(base, "")) : Object.keys(schemaPaths);
   const keyToPaths = groupBy(schemaPathKeys, (key2) => key2.split("/")[1]);
   const apiModules = Object.entries(keyToPaths).reduce((apiModules2, [name, paths]) => {
     const payloads = paths.reduce((payloads2, path13) => {
       const pathItems = schemaPaths[path13];
-      payloads2.push(...transformPayloads(pathItems, { ...options8, path: base ? base + path13 : path13, transformer }));
+      payloads2.push(
+        ...transformPayloads(pathItems, { ...options8, path: base ? base + path13 : path13, transformer, validateStatus })
+      );
       return payloads2;
     }, []);
     apiModules2.push({ name: transformer.moduleName({ name }), payloads });
@@ -22937,6 +22938,7 @@ async function generate(userOptions = {}) {
     input = "./schema.json",
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
+    validateStatus = (status) => status >= 200 && status < 300,
     transformer = {}
   } = options8;
   const mergedTransformer = { ...createTransformer(), ...transformer };
@@ -22947,7 +22949,8 @@ async function generate(userOptions = {}) {
   }
   const apiModules = partitionApiModules(schema2, {
     base,
-    transformer: mergedTransformer
+    transformer: mergedTransformer,
+    validateStatus
   });
   await renderApiModules(apiModules, { output, typesFilename, ts, typesOnly, overrides, preset });
   logger.success("Done");

package/dist/{chunk-MLHGCJ6R.js → chunk-SKKHIIUE.js}

@@ -68,22 +68,18 @@ function getCliVersion() {
 function isRequiredRequestBody(value) {
   return "required" in value && value.required === true;
 }
-function getSuccessfulResponseMeme(operation) {
+function getValidResponseMetadataItems(operation, validateStatus) {
   const responses = operation.responses ?? {};
-  const codeKey = Object.keys(responses).sort((a, b) => Number(a) - Number(b)).find((codeKey2) => Number(codeKey2) >= 200 && Number(codeKey2) <= 299);
-  if (!codeKey) {
+  const validStatusResults = Object.keys(responses).sort((a, b) => Number(a) - Number(b)).filter((key) => validateStatus(Number(key))).map(Number);
+  const results = validStatusResults.map((status) => {
+    const content = operation.responses?.[status]?.content;
+    const mime = content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
     return {
-      statusCode: void 0,
-      mime: void 0
+      status,
+      mime
     };
-  }
-  const statusCode = Number(codeKey);
-  const content = operation.responses?.[statusCode]?.content;
-  const mime = content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
-  return {
-    statusCode,
-    mime
-  };
+  }).filter((result) => result.mime);
+  return results;
 }
 
 export {
@@ -95,5 +91,5 @@ export {
   hasQueryParameter,
   getCliVersion,
   isRequiredRequestBody,
-  getSuccessfulResponseMeme
+  getValidResponseMetadataItems
 };

package/dist/cli.cjs

@@ -78,22 +78,18 @@ function getCliVersion() {
 function isRequiredRequestBody(value) {
   return "required" in value && value.required === true;
 }
-function getSuccessfulResponseMeme(operation) {
+function getValidResponseMetadataItems(operation, validateStatus) {
   const responses = operation.responses ?? {};
-  const codeKey = Object.keys(responses).sort((a5, b8) => Number(a5) - Number(b8)).find((codeKey2) => Number(codeKey2) >= 200 && Number(codeKey2) <= 299);
-  if (!codeKey) {
+  const validStatusResults = Object.keys(responses).sort((a5, b8) => Number(a5) - Number(b8)).filter((key2) => validateStatus(Number(key2))).map(Number);
+  const results = validStatusResults.map((status) => {
+    const content = operation.responses?.[status]?.content;
+    const mime = content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
     return {
-      statusCode: void 0,
-      mime: void 0
+      status,
+      mime
     };
-  }
-  const statusCode = Number(codeKey);
-  const content = operation.responses?.[statusCode]?.content;
-  const mime = content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
-  return {
-    statusCode,
-    mime
-  };
+  }).filter((result) => result.mime);
+  return results;
 }
 var import_path2, import_fs_extra, import_swagger2openapi, import_yaml;
 var init_utils = __esm({
@@ -102055,10 +102051,9 @@ function transformTypeResponseBody({
 }
 function transformTypeResponseBodyValue({
   type: type2,
-  statusCode,
-  mime
+  responseMetadataItems
 }) {
-  return `${type2}['responses']['${statusCode}']['content']['${mime}']`;
+  return responseMetadataItems.map(({ status, mime }) => `${type2}['responses']['${status}']['content']['${mime}']`).join(" | ");
 }
 function createTransformer() {
   return {
@@ -102097,7 +102092,7 @@ __export(generate_exports, {
   transformPayloads: () => transformPayloads
 });
 function transformPayloads(pathItems, options8) {
-  const { transformer, path: path13, base } = options8;
+  const { transformer, path: path13, base, validateStatus } = options8;
   return Object.entries(pathItems).filter(([key2]) => SUPPORTED_HTTP_METHODS.includes(key2)).reduce((payloads, [method, operation]) => {
     const url2 = transformer.url({ path: path13, base });
     const args = { path: path13, base, url: url2, method, operation };
@@ -102116,9 +102111,9 @@ function transformPayloads(pathItems, options8) {
       entity,
       required: isRequiredRequestBody(operation.requestBody)
     }) : "undefined";
-    const { mime, statusCode } = getSuccessfulResponseMeme(operation);
     const typeResponseBody = transformer.typeResponseBody({ ...args, type: type2, verb, entity });
-    const typeResponseBodyValue = mime && statusCode ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, statusCode, mime }) : "undefined";
+    const responseMetadataItems = getValidResponseMetadataItems(operation, validateStatus);
+    const typeResponseBodyValue = responseMetadataItems.length > 0 ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, responseMetadataItems }) : "undefined";
     payloads.push({
       fn: fn8,
       url: url2,
@@ -102138,14 +102133,16 @@ function transformPayloads(pathItems, options8) {
   }, []);
 }
 function partitionApiModules(schema2, options8) {
-  const { base, transformer } = options8;
+  const { base, transformer, validateStatus } = options8;
   const schemaPaths = schema2.paths ?? {};
   const schemaPathKeys = base ? Object.keys(schemaPaths).map((key2) => key2.replace(base, "")) : Object.keys(schemaPaths);
   const keyToPaths = (0, import_rattail2.groupBy)(schemaPathKeys, (key2) => key2.split("/")[1]);
   const apiModules = Object.entries(keyToPaths).reduce((apiModules2, [name, paths]) => {
     const payloads = paths.reduce((payloads2, path13) => {
       const pathItems = schemaPaths[path13];
-      payloads2.push(...transformPayloads(pathItems, { ...options8, path: base ? base + path13 : path13, transformer }));
+      payloads2.push(
+        ...transformPayloads(pathItems, { ...options8, path: base ? base + path13 : path13, transformer, validateStatus })
+      );
       return payloads2;
     }, []);
     apiModules2.push({ name: transformer.moduleName({ name }), payloads });
@@ -102206,6 +102203,7 @@ async function generate(userOptions = {}) {
     input = "./schema.json",
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
+    validateStatus = (status) => status >= 200 && status < 300,
     transformer = {}
   } = options8;
   const mergedTransformer = { ...createTransformer(), ...transformer };
@@ -102216,7 +102214,8 @@ async function generate(userOptions = {}) {
   }
   const apiModules = partitionApiModules(schema2, {
     base,
-    transformer: mergedTransformer
+    transformer: mergedTransformer,
+    validateStatus
   });
   await renderApiModules(apiModules, { output, typesFilename, ts: ts9, typesOnly, overrides, preset });
   import_rslog.logger.success("Done");

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   getCliVersion
-} from "./chunk-MLHGCJ6R.js";
+} from "./chunk-SKKHIIUE.js";
 import "./chunk-6OIOYGN7.js";
 
 // src/cli.ts
@@ -9,7 +9,7 @@ import { Command } from "commander";
 var program = new Command();
 program.version(getCliVersion());
 program.action(async () => {
-  const { generate } = await import("./generate-7X5RRT3J.js");
+  const { generate } = await import("./generate-IJGTBA2I.js");
   return generate();
 });
 program.parse();

package/dist/{generate-7X5RRT3J.js → generate-IJGTBA2I.js}

@@ -4,8 +4,8 @@ import {
   partitionApiModules,
   renderApiModules,
   transformPayloads
-} from "./chunk-J2G2MBMU.js";
-import "./chunk-MLHGCJ6R.js";
+} from "./chunk-K46PCBCF.js";
+import "./chunk-SKKHIIUE.js";
 import "./chunk-6OIOYGN7.js";
 export {
   generate,

package/dist/index.cjs

@@ -79232,7 +79232,7 @@ __export(index_exports, {
   generateTypes: () => generateTypes,
   getCliVersion: () => getCliVersion,
   getConfig: () => getConfig,
-  getSuccessfulResponseMeme: () => getSuccessfulResponseMeme,
+  getValidResponseMetadataItems: () => getValidResponseMetadataItems,
   hasQueryParameter: () => hasQueryParameter,
   isRequiredRequestBody: () => isRequiredRequestBody,
   partitionApiModules: () => partitionApiModules,
@@ -79328,10 +79328,9 @@ function transformTypeResponseBody({
 }
 function transformTypeResponseBodyValue({
   type: type2,
-  statusCode,
-  mime
+  responseMetadataItems
 }) {
-  return `${type2}['responses']['${statusCode}']['content']['${mime}']`;
+  return responseMetadataItems.map(({ status, mime }) => `${type2}['responses']['${status}']['content']['${mime}']`).join(" | ");
 }
 function createTransformer() {
   return {
@@ -102146,27 +102145,23 @@ function getCliVersion() {
 function isRequiredRequestBody(value) {
   return "required" in value && value.required === true;
 }
-function getSuccessfulResponseMeme(operation) {
+function getValidResponseMetadataItems(operation, validateStatus) {
   const responses = operation.responses ?? {};
-  const codeKey = Object.keys(responses).sort((a5, b8) => Number(a5) - Number(b8)).find((codeKey2) => Number(codeKey2) >= 200 && Number(codeKey2) <= 299);
-  if (!codeKey) {
+  const validStatusResults = Object.keys(responses).sort((a5, b8) => Number(a5) - Number(b8)).filter((key2) => validateStatus(Number(key2))).map(Number);
+  const results = validStatusResults.map((status) => {
+    const content = operation.responses?.[status]?.content;
+    const mime = content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
     return {
-      statusCode: void 0,
-      mime: void 0
+      status,
+      mime
     };
-  }
-  const statusCode = Number(codeKey);
-  const content = operation.responses?.[statusCode]?.content;
-  const mime = content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
-  return {
-    statusCode,
-    mime
-  };
+  }).filter((result) => result.mime);
+  return results;
 }
 
 // src/generate.ts
 function transformPayloads(pathItems, options8) {
-  const { transformer, path: path13, base } = options8;
+  const { transformer, path: path13, base, validateStatus } = options8;
   return Object.entries(pathItems).filter(([key2]) => SUPPORTED_HTTP_METHODS.includes(key2)).reduce((payloads, [method, operation]) => {
     const url2 = transformer.url({ path: path13, base });
     const args = { path: path13, base, url: url2, method, operation };
@@ -102185,9 +102180,9 @@ function transformPayloads(pathItems, options8) {
       entity,
       required: isRequiredRequestBody(operation.requestBody)
     }) : "undefined";
-    const { mime, statusCode } = getSuccessfulResponseMeme(operation);
     const typeResponseBody = transformer.typeResponseBody({ ...args, type: type2, verb, entity });
-    const typeResponseBodyValue = mime && statusCode ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, statusCode, mime }) : "undefined";
+    const responseMetadataItems = getValidResponseMetadataItems(operation, validateStatus);
+    const typeResponseBodyValue = responseMetadataItems.length > 0 ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, responseMetadataItems }) : "undefined";
     payloads.push({
       fn: fn8,
       url: url2,
@@ -102207,14 +102202,16 @@ function transformPayloads(pathItems, options8) {
   }, []);
 }
 function partitionApiModules(schema2, options8) {
-  const { base, transformer } = options8;
+  const { base, transformer, validateStatus } = options8;
   const schemaPaths = schema2.paths ?? {};
   const schemaPathKeys = base ? Object.keys(schemaPaths).map((key2) => key2.replace(base, "")) : Object.keys(schemaPaths);
   const keyToPaths = (0, import_rattail2.groupBy)(schemaPathKeys, (key2) => key2.split("/")[1]);
   const apiModules = Object.entries(keyToPaths).reduce((apiModules2, [name, paths]) => {
     const payloads = paths.reduce((payloads2, path13) => {
       const pathItems = schemaPaths[path13];
-      payloads2.push(...transformPayloads(pathItems, { ...options8, path: base ? base + path13 : path13, transformer }));
+      payloads2.push(
+        ...transformPayloads(pathItems, { ...options8, path: base ? base + path13 : path13, transformer, validateStatus })
+      );
       return payloads2;
     }, []);
     apiModules2.push({ name: transformer.moduleName({ name }), payloads });
@@ -102275,6 +102272,7 @@ async function generate(userOptions = {}) {
     input = "./schema.json",
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
+    validateStatus = (status) => status >= 200 && status < 300,
     transformer = {}
   } = options8;
   const mergedTransformer = { ...createTransformer(), ...transformer };
@@ -102285,7 +102283,8 @@ async function generate(userOptions = {}) {
   }
   const apiModules = partitionApiModules(schema2, {
     base,
-    transformer: mergedTransformer
+    transformer: mergedTransformer,
+    validateStatus
   });
   await renderApiModules(apiModules, { output, typesFilename, ts: ts9, typesOnly, overrides, preset });
   import_rslog.logger.success("Done");
@@ -102302,7 +102301,7 @@ var import_pluralize2 = __toESM(require("pluralize"), 1);
   generateTypes,
   getCliVersion,
   getConfig,
-  getSuccessfulResponseMeme,
+  getValidResponseMetadataItems,
   hasQueryParameter,
   isRequiredRequestBody,
   partitionApiModules,

package/dist/index.d.cts

@@ -1,6 +1,53 @@
-import { OperationObject, OpenAPI3, RequestBodyObject, ReferenceObject } from 'openapi-typescript';
+import { OpenAPI3, OperationObject, RequestBodyObject, ReferenceObject } from 'openapi-typescript';
 export { default as pluralize } from 'pluralize';
 
+type Preset = 'axle' | 'axios';
+type StatusCodeStrategy = 'strict' | 'loose' | 'smart';
+interface StatusCodes {
+    get?: number;
+    post?: number;
+    put?: number;
+    delete?: number;
+    patch?: number;
+    options?: number;
+    head?: number;
+}
+declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
+    get: number;
+    post: number;
+    put: number;
+    delete: number;
+    patch: number;
+    options: number;
+    head: number;
+} | {
+    get: number;
+    post: number;
+    put: number;
+    delete: number;
+    patch: number;
+    options: number;
+    head: number;
+} | {
+    get: number;
+    post: number;
+    put: number;
+    delete: number;
+    patch: number;
+    options: number;
+    head: number;
+};
+declare function readSchema(input: string): Promise<OpenAPI3>;
+declare function readTemplateFile(preset?: Preset): string;
+declare function hasQueryParameter(operation: OperationObject): boolean;
+declare function getCliVersion(): any;
+declare function isRequiredRequestBody(value: RequestBodyObject | ReferenceObject): boolean;
+type ResponseMetadataItem = {
+    status: number;
+    mime: string;
+};
+declare function getValidResponseMetadataItems(operation: OperationObject, validateStatus: (status: number) => boolean): ResponseMetadataItem[];
+
 type TransformerBaseArgs = {
     path: string;
     base: string | undefined;
@@ -57,12 +104,11 @@ declare function transformTypeResponseBody({ type, }: {
     verb: string;
     entity: string;
 } & TransformerBaseArgs): string;
-declare function transformTypeResponseBodyValue({ type, statusCode, mime, }: {
+declare function transformTypeResponseBodyValue({ type, responseMetadataItems, }: {
     type: string;
     verb: string;
     entity: string;
-    statusCode: number;
-    mime: string;
+    responseMetadataItems: ResponseMetadataItem[];
 } & TransformerBaseArgs): string;
 interface Transformer {
     moduleName: typeof transformModuleName;
@@ -81,55 +127,6 @@ interface Transformer {
 }
 declare function createTransformer(): Transformer;
 
-type Preset = 'axle' | 'axios';
-type StatusCodeStrategy = 'strict' | 'loose' | 'smart';
-interface StatusCodes {
-    get?: number;
-    post?: number;
-    put?: number;
-    delete?: number;
-    patch?: number;
-    options?: number;
-    head?: number;
-}
-declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-} | {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-} | {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-};
-declare function readSchema(input: string): Promise<OpenAPI3>;
-declare function readTemplateFile(preset?: Preset): string;
-declare function hasQueryParameter(operation: OperationObject): boolean;
-declare function getCliVersion(): any;
-declare function isRequiredRequestBody(value: RequestBodyObject | ReferenceObject): boolean;
-declare function getSuccessfulResponseMeme(operation: OperationObject): {
-    statusCode: undefined;
-    mime: undefined;
-} | {
-    statusCode: number;
-    mime: string | undefined;
-};
-
 interface ApiModuleTemplateData {
     /**
      * API module metadata
@@ -215,10 +212,12 @@ interface ApiModulePayload {
 interface GenerateOptions {
     /**
      * The path to the OpenAPI/Swagger schema file.
+     * @default './schema.json'
      */
     input?: string;
     /**
      * The path to the output directory.
+     * @default './src/apis/generated'
      */
     output?: string;
     /**
@@ -227,37 +226,49 @@ interface GenerateOptions {
     base?: string;
     /**
      * The filename of the generated openapi types file.
+     * @default '_types.ts'
      */
     typesFilename?: string;
-    /**
-     * The transformer api options, used to override the default transformation rules.
-     */
-    transformer?: Partial<Transformer>;
     /**
      * Whether to generate TypeScript code.
+     * @default true
      */
     ts?: boolean;
     /**
      * Whether to generate only types.
+     * @default false
      */
     typesOnly?: boolean;
     /**
      * Whether to override the existing files, or an array of filenames to override.
+     * @default true
      */
     overrides?: boolean | string[];
     /**
      * The preset ejs template to use.
+     * @default 'axle'
      */
     preset?: Preset;
+    /**
+     * Defines which return status codes will be typed
+     * @default (status) => status >= 200 && status < 300
+     */
+    validateStatus?: (status: number) => boolean;
+    /**
+     * The transformer api options, used to override the default transformation rules.
+     */
+    transformer?: Partial<Transformer>;
 }
 declare function transformPayloads(pathItems: Record<string, OperationObject>, options: {
     path: string;
     transformer: Transformer;
     base: string | undefined;
+    validateStatus: (status: number) => boolean;
 }): ApiModulePayload[];
 declare function partitionApiModules(schema: OpenAPI3, options: {
     transformer: Transformer;
     base: string | undefined;
+    validateStatus: (status: number) => boolean;
 }): ApiModule[];
 declare function renderApiModules(apiModules: ApiModule[], options: {
     output: string;
@@ -274,4 +285,4 @@ type Config = GenerateOptions;
 declare function defineConfig(config: Config): GenerateOptions;
 declare function getConfig(): Promise<Config>;
 
-export { type ApiModule, type ApiModulePayload, type ApiModuleTemplateData, type Config, type GenerateOptions, type Preset, type StatusCodeStrategy, type StatusCodes, type Transformer, type TransformerBaseArgs, createStatusCodesByStrategy, createTransformer, defineConfig, generate, generateTypes, getCliVersion, getConfig, getSuccessfulResponseMeme, hasQueryParameter, isRequiredRequestBody, partitionApiModules, readSchema, readTemplateFile, renderApiModules, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };
+export { type ApiModule, type ApiModulePayload, type ApiModuleTemplateData, type Config, type GenerateOptions, type Preset, type ResponseMetadataItem, type StatusCodeStrategy, type StatusCodes, type Transformer, type TransformerBaseArgs, createStatusCodesByStrategy, createTransformer, defineConfig, generate, generateTypes, getCliVersion, getConfig, getValidResponseMetadataItems, hasQueryParameter, isRequiredRequestBody, partitionApiModules, readSchema, readTemplateFile, renderApiModules, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };

package/dist/index.d.ts

@@ -1,6 +1,53 @@
-import { OperationObject, OpenAPI3, RequestBodyObject, ReferenceObject } from 'openapi-typescript';
+import { OpenAPI3, OperationObject, RequestBodyObject, ReferenceObject } from 'openapi-typescript';
 export { default as pluralize } from 'pluralize';
 
+type Preset = 'axle' | 'axios';
+type StatusCodeStrategy = 'strict' | 'loose' | 'smart';
+interface StatusCodes {
+    get?: number;
+    post?: number;
+    put?: number;
+    delete?: number;
+    patch?: number;
+    options?: number;
+    head?: number;
+}
+declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
+    get: number;
+    post: number;
+    put: number;
+    delete: number;
+    patch: number;
+    options: number;
+    head: number;
+} | {
+    get: number;
+    post: number;
+    put: number;
+    delete: number;
+    patch: number;
+    options: number;
+    head: number;
+} | {
+    get: number;
+    post: number;
+    put: number;
+    delete: number;
+    patch: number;
+    options: number;
+    head: number;
+};
+declare function readSchema(input: string): Promise<OpenAPI3>;
+declare function readTemplateFile(preset?: Preset): string;
+declare function hasQueryParameter(operation: OperationObject): boolean;
+declare function getCliVersion(): any;
+declare function isRequiredRequestBody(value: RequestBodyObject | ReferenceObject): boolean;
+type ResponseMetadataItem = {
+    status: number;
+    mime: string;
+};
+declare function getValidResponseMetadataItems(operation: OperationObject, validateStatus: (status: number) => boolean): ResponseMetadataItem[];
+
 type TransformerBaseArgs = {
     path: string;
     base: string | undefined;
@@ -57,12 +104,11 @@ declare function transformTypeResponseBody({ type, }: {
     verb: string;
     entity: string;
 } & TransformerBaseArgs): string;
-declare function transformTypeResponseBodyValue({ type, statusCode, mime, }: {
+declare function transformTypeResponseBodyValue({ type, responseMetadataItems, }: {
     type: string;
     verb: string;
     entity: string;
-    statusCode: number;
-    mime: string;
+    responseMetadataItems: ResponseMetadataItem[];
 } & TransformerBaseArgs): string;
 interface Transformer {
     moduleName: typeof transformModuleName;
@@ -81,55 +127,6 @@ interface Transformer {
 }
 declare function createTransformer(): Transformer;
 
-type Preset = 'axle' | 'axios';
-type StatusCodeStrategy = 'strict' | 'loose' | 'smart';
-interface StatusCodes {
-    get?: number;
-    post?: number;
-    put?: number;
-    delete?: number;
-    patch?: number;
-    options?: number;
-    head?: number;
-}
-declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-} | {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-} | {
-    get: number;
-    post: number;
-    put: number;
-    delete: number;
-    patch: number;
-    options: number;
-    head: number;
-};
-declare function readSchema(input: string): Promise<OpenAPI3>;
-declare function readTemplateFile(preset?: Preset): string;
-declare function hasQueryParameter(operation: OperationObject): boolean;
-declare function getCliVersion(): any;
-declare function isRequiredRequestBody(value: RequestBodyObject | ReferenceObject): boolean;
-declare function getSuccessfulResponseMeme(operation: OperationObject): {
-    statusCode: undefined;
-    mime: undefined;
-} | {
-    statusCode: number;
-    mime: string | undefined;
-};
-
 interface ApiModuleTemplateData {
     /**
      * API module metadata
@@ -215,10 +212,12 @@ interface ApiModulePayload {
 interface GenerateOptions {
     /**
      * The path to the OpenAPI/Swagger schema file.
+     * @default './schema.json'
      */
     input?: string;
     /**
      * The path to the output directory.
+     * @default './src/apis/generated'
      */
     output?: string;
     /**
@@ -227,37 +226,49 @@ interface GenerateOptions {
     base?: string;
     /**
      * The filename of the generated openapi types file.
+     * @default '_types.ts'
      */
     typesFilename?: string;
-    /**
-     * The transformer api options, used to override the default transformation rules.
-     */
-    transformer?: Partial<Transformer>;
     /**
      * Whether to generate TypeScript code.
+     * @default true
      */
     ts?: boolean;
     /**
      * Whether to generate only types.
+     * @default false
      */
     typesOnly?: boolean;
     /**
      * Whether to override the existing files, or an array of filenames to override.
+     * @default true
      */
     overrides?: boolean | string[];
     /**
      * The preset ejs template to use.
+     * @default 'axle'
      */
     preset?: Preset;
+    /**
+     * Defines which return status codes will be typed
+     * @default (status) => status >= 200 && status < 300
+     */
+    validateStatus?: (status: number) => boolean;
+    /**
+     * The transformer api options, used to override the default transformation rules.
+     */
+    transformer?: Partial<Transformer>;
 }
 declare function transformPayloads(pathItems: Record<string, OperationObject>, options: {
     path: string;
     transformer: Transformer;
     base: string | undefined;
+    validateStatus: (status: number) => boolean;
 }): ApiModulePayload[];
 declare function partitionApiModules(schema: OpenAPI3, options: {
     transformer: Transformer;
     base: string | undefined;
+    validateStatus: (status: number) => boolean;
 }): ApiModule[];
 declare function renderApiModules(apiModules: ApiModule[], options: {
     output: string;
@@ -274,4 +285,4 @@ type Config = GenerateOptions;
 declare function defineConfig(config: Config): GenerateOptions;
 declare function getConfig(): Promise<Config>;
 
-export { type ApiModule, type ApiModulePayload, type ApiModuleTemplateData, type Config, type GenerateOptions, type Preset, type StatusCodeStrategy, type StatusCodes, type Transformer, type TransformerBaseArgs, createStatusCodesByStrategy, createTransformer, defineConfig, generate, generateTypes, getCliVersion, getConfig, getSuccessfulResponseMeme, hasQueryParameter, isRequiredRequestBody, partitionApiModules, readSchema, readTemplateFile, renderApiModules, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };
+export { type ApiModule, type ApiModulePayload, type ApiModuleTemplateData, type Config, type GenerateOptions, type Preset, type ResponseMetadataItem, type StatusCodeStrategy, type StatusCodes, type Transformer, type TransformerBaseArgs, createStatusCodesByStrategy, createTransformer, defineConfig, generate, generateTypes, getCliVersion, getConfig, getValidResponseMetadataItems, hasQueryParameter, isRequiredRequestBody, partitionApiModules, readSchema, readTemplateFile, renderApiModules, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };

package/dist/index.js

@@ -20,16 +20,16 @@ import {
   transformTypeValue,
   transformUrl,
   transformVerb
-} from "./chunk-J2G2MBMU.js";
+} from "./chunk-K46PCBCF.js";
 import {
   createStatusCodesByStrategy,
   getCliVersion,
-  getSuccessfulResponseMeme,
+  getValidResponseMetadataItems,
   hasQueryParameter,
   isRequiredRequestBody,
   readSchema,
   readTemplateFile
-} from "./chunk-MLHGCJ6R.js";
+} from "./chunk-SKKHIIUE.js";
 import "./chunk-6OIOYGN7.js";
 
 // src/index.ts
@@ -42,7 +42,7 @@ export {
   generateTypes,
   getCliVersion,
   getConfig,
-  getSuccessfulResponseMeme,
+  getValidResponseMetadataItems,
   hasQueryParameter,
   isRequiredRequestBody,
   partitionApiModules,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-farmer",
-  "version": "0.0.17",
+  "version": "0.0.19",
   "description": "API module generation tool based on Openapi3/Swagger2.",
   "keywords": [
     "cli",
@@ -89,6 +89,7 @@
     "dev": "tsup src/index.ts src/cli.ts --format esm,cjs --watch --dts --shims",
     "format": "prettier --write .",
     "lint": "eslint . --fix",
-    "release": "pnpm build && vr release"
+    "release": "pnpm build && vr release",
+    "gen": "pnpm --dir ./fixtures/axios gen & pnpm --dir ./fixtures/axle gen"
   }
 }

package/templates/axios.ejs

@@ -1,10 +1,10 @@
-<% if (ts && !typesOnly) { %> import { type AxiosRequestConfig } from 'axios' <% } %>
+<% if (ts && !typesOnly) { %> import type { RequestConfig } from '@/request' <% } %>
 <% if (!typesOnly) { %> import { request } from '@/request' <% } %>
 <% if (ts) { %> import { type paths } from './<%- typesFilename %>' <% } %>
 
 <% if (!typesOnly) { %>
 <% apiModule.payloads.forEach(payload => { %> -%>
-export const <%- payload.fn %> = (config<% if (ts) { %>: AxiosRequestConfig<<%- payload.typeRequestBody %>> <% } %>) 
+export const <%- payload.fn %> = (config<% if (ts) { %>: RequestConfig<<%- payload.typeRequestBody %>> <% } %> = {}) 
 => request<% if (ts) { %><any, <%- payload.typeResponseBody %>><% } %>({
   url: '<%- payload.url %>', 
   method: '<%- payload.method %>',