api-farmer 0.0.9 → 0.0.10

package/README.md

@@ -69,15 +69,17 @@ See the bottom of the document for template variable definitions.
 
 ### Status Code Strategy
 
-`Restful API` recommends using different successful http status codes for different methods, such as `get: 200`, `post: 201`, etc. If you don't need this strategy, you can set `statusCodeStrategy` to `loose`
+`smart`: find a valid status code between [`200`, `299`] that is closest to `200` <br>
+`loose`: all success status codes are `200` <br>
+`strict`: `Restful API` recommends using different successful http status codes for different methods, such as `get: 200`, `post: 201`, etc. <br>
 
 ```ts
 // api-farmer.config.ts
 import { defineConfig } from 'api-farmer'
 
 export default defineConfig({
-  // 'strict' or 'loose', defaults 'strict'
-  statusCodeStrategy: 'loose',
+  // 'strict' or 'loose' or 'smart', defaults 'smart'
+  statusCodeStrategy: 'strict',
 })
 ```
 
@@ -149,7 +151,9 @@ export interface Config {
   preset?: Preset
   /**
    * The status code strategy to use.
-   * loose: all success status codes are 200, strict: use the openapi recommended success status codes.
+   * loose: all success status codes are 200,
+   * strict: use the openapi recommended success status codes.
+   * smart: find a valid status code between [200, 299] that is closest to 200
    */
   statusCodeStrategy?: StatusCodeStrategy
   /**

package/dist/{chunk-ZOF4QGMP.js → chunk-I24WWW5F.js}

@@ -1,12 +1,12 @@
 import {
   CWD,
   createStatusCodesByStrategy,
-  getResponseMime,
+  doStatusCodeStrategy,
   hasQueryParameter,
   isRequiredRequestBody,
   readSchema,
   readTemplateFile
-} from "./chunk-OBPECFFY.js";
+} from "./chunk-THTMWQYI.js";
 import {
   __export
 } from "./chunk-6OIOYGN7.js";
@@ -22827,7 +22827,7 @@ function createTransformer() {
 
 // src/generate.ts
 function partitionApiModules(schema2, transformer, options8) {
-  const { statusCodes, base } = options8;
+  const { statusCodes, statusCodeStrategy, base } = 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]);
@@ -22853,10 +22853,13 @@ function partitionApiModules(schema2, transformer, options8) {
           entity,
           required: isRequiredRequestBody(operation.requestBody)
         }) : "never";
-        const statusCode = statusCodes[method] ?? 200;
-        const mime = getResponseMime(operation, statusCode);
+        const { mime, statusCode } = doStatusCodeStrategy(
+          operation,
+          statusCodes[method] ?? 200,
+          statusCodeStrategy
+        );
         const typeResponseBody = transformer.typeResponseBody({ ...args, type: type2, verb, entity });
-        const typeResponseBodyValue = mime ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, statusCode, mime }) : "never";
+        const typeResponseBodyValue = mime && statusCode ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, statusCode, mime }) : "never";
         payloads3.push({
           fn,
           url: url2,
@@ -22930,7 +22933,7 @@ async function generate(userOptions = {}) {
     ts = true,
     overrides = true,
     preset = "axle",
-    statusCodeStrategy = "strict",
+    statusCodeStrategy = "smart",
     input = "./schema.json",
     output = "./src/apis",
     typesFilename = "types.generated.ts",
@@ -22946,7 +22949,7 @@ async function generate(userOptions = {}) {
   if (ts) {
     await generateTypes(schema2, output, typesFilename);
   }
-  const apiModules = partitionApiModules(schema2, mergedTransformer, { statusCodes, ts, base });
+  const apiModules = partitionApiModules(schema2, mergedTransformer, { statusCodes, statusCodeStrategy, ts, base });
   await renderApiModules(apiModules, { output, typesFilename, ts, overrides, preset });
   logger.success("Done");
 }

package/dist/{chunk-OBPECFFY.js → chunk-THTMWQYI.js}

@@ -32,6 +32,15 @@ function createStatusCodesByStrategy(strategy) {
       patch: 200,
       options: 200,
       head: 200
+    },
+    smart: {
+      get: 200,
+      post: 200,
+      put: 200,
+      delete: 200,
+      patch: 200,
+      options: 200,
+      head: 200
     }
   }[strategy];
 }
@@ -58,9 +67,24 @@ function getCliVersion() {
 function isRequiredRequestBody(value) {
   return "required" in value && value.required === true;
 }
-function getResponseMime(operation, statusCode) {
+function doStatusCodeStrategy(operation, statusCode, strategy) {
+  if (strategy === "smart") {
+    const responses = operation.responses ?? {};
+    const codeKey = Object.keys(responses).sort((a, b) => Number(a) - Number(b)).find((codeKey2) => Number(codeKey2) >= statusCode && Number(codeKey2) <= 299);
+    if (!codeKey) {
+      return {
+        statusCode: void 0,
+        mime: void 0
+      };
+    }
+    statusCode = Number(codeKey);
+  }
   const content = operation.responses?.[statusCode]?.content;
-  return content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
+  const mime = content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
+  return {
+    statusCode,
+    mime
+  };
 }
 
 export {
@@ -71,5 +95,5 @@ export {
   hasQueryParameter,
   getCliVersion,
   isRequiredRequestBody,
-  getResponseMime
+  doStatusCodeStrategy
 };

package/dist/cli.cjs

@@ -73,6 +73,15 @@ function createStatusCodesByStrategy(strategy) {
       patch: 200,
       options: 200,
       head: 200
+    },
+    smart: {
+      get: 200,
+      post: 200,
+      put: 200,
+      delete: 200,
+      patch: 200,
+      options: 200,
+      head: 200
     }
   }[strategy];
 }
@@ -99,9 +108,24 @@ function getCliVersion() {
 function isRequiredRequestBody(value) {
   return "required" in value && value.required === true;
 }
-function getResponseMime(operation, statusCode) {
+function doStatusCodeStrategy(operation, statusCode, strategy) {
+  if (strategy === "smart") {
+    const responses = operation.responses ?? {};
+    const codeKey = Object.keys(responses).sort((a5, b8) => Number(a5) - Number(b8)).find((codeKey2) => Number(codeKey2) >= statusCode && Number(codeKey2) <= 299);
+    if (!codeKey) {
+      return {
+        statusCode: void 0,
+        mime: void 0
+      };
+    }
+    statusCode = Number(codeKey);
+  }
   const content = operation.responses?.[statusCode]?.content;
-  return content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
+  const mime = content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
+  return {
+    statusCode,
+    mime
+  };
 }
 var import_path2, import_fs_extra, import_swagger2openapi, import_yaml;
 var init_utils = __esm({
@@ -102103,7 +102127,7 @@ __export(generate_exports, {
   renderApiModules: () => renderApiModules
 });
 function partitionApiModules(schema2, transformer, options8) {
-  const { statusCodes, base } = options8;
+  const { statusCodes, statusCodeStrategy, base } = 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]);
@@ -102129,10 +102153,13 @@ function partitionApiModules(schema2, transformer, options8) {
           entity,
           required: isRequiredRequestBody(operation.requestBody)
         }) : "never";
-        const statusCode = statusCodes[method] ?? 200;
-        const mime = getResponseMime(operation, statusCode);
+        const { mime, statusCode } = doStatusCodeStrategy(
+          operation,
+          statusCodes[method] ?? 200,
+          statusCodeStrategy
+        );
         const typeResponseBody = transformer.typeResponseBody({ ...args, type: type2, verb, entity });
-        const typeResponseBodyValue = mime ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, statusCode, mime }) : "never";
+        const typeResponseBodyValue = mime && statusCode ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, statusCode, mime }) : "never";
         payloads3.push({
           fn: fn8,
           url: url2,
@@ -102206,7 +102233,7 @@ async function generate(userOptions = {}) {
     ts: ts9 = true,
     overrides = true,
     preset = "axle",
-    statusCodeStrategy = "strict",
+    statusCodeStrategy = "smart",
     input = "./schema.json",
     output = "./src/apis",
     typesFilename = "types.generated.ts",
@@ -102222,7 +102249,7 @@ async function generate(userOptions = {}) {
   if (ts9) {
     await generateTypes(schema2, output, typesFilename);
   }
-  const apiModules = partitionApiModules(schema2, mergedTransformer, { statusCodes, ts: ts9, base });
+  const apiModules = partitionApiModules(schema2, mergedTransformer, { statusCodes, statusCodeStrategy, ts: ts9, base });
   await renderApiModules(apiModules, { output, typesFilename, ts: ts9, overrides, preset });
   import_rslog.logger.success("Done");
 }

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   getCliVersion
-} from "./chunk-OBPECFFY.js";
+} from "./chunk-THTMWQYI.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-KEVAHIZH.js");
+  const { generate } = await import("./generate-A4HBYHRZ.js");
   return generate();
 });
 program.parse();

package/dist/{generate-KEVAHIZH.js → generate-A4HBYHRZ.js}

@@ -3,8 +3,8 @@ import {
   generateTypes,
   partitionApiModules,
   renderApiModules
-} from "./chunk-ZOF4QGMP.js";
-import "./chunk-OBPECFFY.js";
+} from "./chunk-I24WWW5F.js";
+import "./chunk-THTMWQYI.js";
 import "./chunk-6OIOYGN7.js";
 export {
   generate,

package/dist/index.cjs

@@ -79228,11 +79228,11 @@ __export(index_exports, {
   createStatusCodesByStrategy: () => createStatusCodesByStrategy,
   createTransformer: () => createTransformer,
   defineConfig: () => defineConfig,
+  doStatusCodeStrategy: () => doStatusCodeStrategy,
   generate: () => generate,
   generateTypes: () => generateTypes,
   getCliVersion: () => getCliVersion,
   getConfig: () => getConfig,
-  getResponseMime: () => getResponseMime,
   hasQueryParameter: () => hasQueryParameter,
   isRequiredRequestBody: () => isRequiredRequestBody,
   partitionApiModules: () => partitionApiModules,
@@ -102108,6 +102108,15 @@ function createStatusCodesByStrategy(strategy) {
       patch: 200,
       options: 200,
       head: 200
+    },
+    smart: {
+      get: 200,
+      post: 200,
+      put: 200,
+      delete: 200,
+      patch: 200,
+      options: 200,
+      head: 200
     }
   }[strategy];
 }
@@ -102134,14 +102143,29 @@ function getCliVersion() {
 function isRequiredRequestBody(value) {
   return "required" in value && value.required === true;
 }
-function getResponseMime(operation, statusCode) {
+function doStatusCodeStrategy(operation, statusCode, strategy) {
+  if (strategy === "smart") {
+    const responses = operation.responses ?? {};
+    const codeKey = Object.keys(responses).sort((a5, b8) => Number(a5) - Number(b8)).find((codeKey2) => Number(codeKey2) >= statusCode && Number(codeKey2) <= 299);
+    if (!codeKey) {
+      return {
+        statusCode: void 0,
+        mime: void 0
+      };
+    }
+    statusCode = Number(codeKey);
+  }
   const content = operation.responses?.[statusCode]?.content;
-  return content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
+  const mime = content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
+  return {
+    statusCode,
+    mime
+  };
 }
 
 // src/generate.ts
 function partitionApiModules(schema2, transformer, options8) {
-  const { statusCodes, base } = options8;
+  const { statusCodes, statusCodeStrategy, base } = 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]);
@@ -102167,10 +102191,13 @@ function partitionApiModules(schema2, transformer, options8) {
           entity,
           required: isRequiredRequestBody(operation.requestBody)
         }) : "never";
-        const statusCode = statusCodes[method] ?? 200;
-        const mime = getResponseMime(operation, statusCode);
+        const { mime, statusCode } = doStatusCodeStrategy(
+          operation,
+          statusCodes[method] ?? 200,
+          statusCodeStrategy
+        );
         const typeResponseBody = transformer.typeResponseBody({ ...args, type: type2, verb, entity });
-        const typeResponseBodyValue = mime ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, statusCode, mime }) : "never";
+        const typeResponseBodyValue = mime && statusCode ? transformer.typeResponseBodyValue({ ...args, type: type2, verb, entity, statusCode, mime }) : "never";
         payloads3.push({
           fn: fn8,
           url: url2,
@@ -102244,7 +102271,7 @@ async function generate(userOptions = {}) {
     ts: ts9 = true,
     overrides = true,
     preset = "axle",
-    statusCodeStrategy = "strict",
+    statusCodeStrategy = "smart",
     input = "./schema.json",
     output = "./src/apis",
     typesFilename = "types.generated.ts",
@@ -102260,7 +102287,7 @@ async function generate(userOptions = {}) {
   if (ts9) {
     await generateTypes(schema2, output, typesFilename);
   }
-  const apiModules = partitionApiModules(schema2, mergedTransformer, { statusCodes, ts: ts9, base });
+  const apiModules = partitionApiModules(schema2, mergedTransformer, { statusCodes, statusCodeStrategy, ts: ts9, base });
   await renderApiModules(apiModules, { output, typesFilename, ts: ts9, overrides, preset });
   import_rslog.logger.success("Done");
 }
@@ -102272,11 +102299,11 @@ var import_pluralize2 = __toESM(require("pluralize"), 1);
   createStatusCodesByStrategy,
   createTransformer,
   defineConfig,
+  doStatusCodeStrategy,
   generate,
   generateTypes,
   getCliVersion,
   getConfig,
-  getResponseMime,
   hasQueryParameter,
   isRequiredRequestBody,
   partitionApiModules,

package/dist/index.d.cts

@@ -82,7 +82,7 @@ interface Transformer {
 declare function createTransformer(): Transformer;
 
 type Preset = 'axle' | 'axios';
-type StatusCodeStrategy = 'strict' | 'loose';
+type StatusCodeStrategy = 'strict' | 'loose' | 'smart';
 interface StatusCodes {
     get?: number;
     post?: number;
@@ -108,13 +108,27 @@ declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
     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 getResponseMime(operation: OperationObject, statusCode: number): "application/json" | "*/*" | undefined;
+declare function doStatusCodeStrategy(operation: OperationObject, statusCode: number, strategy: StatusCodeStrategy): {
+    statusCode: undefined;
+    mime: undefined;
+} | {
+    statusCode: number;
+    mime: string | undefined;
+};
 
 interface ApiModuleTemplateData {
     /**
@@ -228,7 +242,10 @@ interface GenerateOptions {
      */
     preset?: Preset;
     /**
-     * The status code strategy to use. loose: all success status codes are 200, strict: use the openapi recommended success status codes.
+     * The status code strategy to use.
+     * loose: all success status codes are 200,
+     * strict: use the openapi recommended success status codes.
+     * smart: find a valid status code between [200, 299] that is closest to 200
      */
     statusCodeStrategy?: StatusCodeStrategy;
     /**
@@ -246,6 +263,7 @@ interface GenerateOptions {
 }
 declare function partitionApiModules(schema: OpenAPI3, transformer: Transformer, options: {
     ts: boolean;
+    statusCodeStrategy: StatusCodeStrategy;
     statusCodes: StatusCodes;
     base?: string;
 }): ApiModule[];
@@ -263,4 +281,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, getResponseMime, hasQueryParameter, isRequiredRequestBody, partitionApiModules, readSchema, readTemplateFile, renderApiModules, transformEntity, transformFn, transformModuleName, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };
+export { type ApiModule, type ApiModulePayload, type ApiModuleTemplateData, type Config, type GenerateOptions, type Preset, type StatusCodeStrategy, type StatusCodes, type Transformer, type TransformerBaseArgs, createStatusCodesByStrategy, createTransformer, defineConfig, doStatusCodeStrategy, generate, generateTypes, getCliVersion, getConfig, hasQueryParameter, isRequiredRequestBody, partitionApiModules, readSchema, readTemplateFile, renderApiModules, transformEntity, transformFn, transformModuleName, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };

package/dist/index.d.ts

@@ -82,7 +82,7 @@ interface Transformer {
 declare function createTransformer(): Transformer;
 
 type Preset = 'axle' | 'axios';
-type StatusCodeStrategy = 'strict' | 'loose';
+type StatusCodeStrategy = 'strict' | 'loose' | 'smart';
 interface StatusCodes {
     get?: number;
     post?: number;
@@ -108,13 +108,27 @@ declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
     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 getResponseMime(operation: OperationObject, statusCode: number): "application/json" | "*/*" | undefined;
+declare function doStatusCodeStrategy(operation: OperationObject, statusCode: number, strategy: StatusCodeStrategy): {
+    statusCode: undefined;
+    mime: undefined;
+} | {
+    statusCode: number;
+    mime: string | undefined;
+};
 
 interface ApiModuleTemplateData {
     /**
@@ -228,7 +242,10 @@ interface GenerateOptions {
      */
     preset?: Preset;
     /**
-     * The status code strategy to use. loose: all success status codes are 200, strict: use the openapi recommended success status codes.
+     * The status code strategy to use.
+     * loose: all success status codes are 200,
+     * strict: use the openapi recommended success status codes.
+     * smart: find a valid status code between [200, 299] that is closest to 200
      */
     statusCodeStrategy?: StatusCodeStrategy;
     /**
@@ -246,6 +263,7 @@ interface GenerateOptions {
 }
 declare function partitionApiModules(schema: OpenAPI3, transformer: Transformer, options: {
     ts: boolean;
+    statusCodeStrategy: StatusCodeStrategy;
     statusCodes: StatusCodes;
     base?: string;
 }): ApiModule[];
@@ -263,4 +281,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, getResponseMime, hasQueryParameter, isRequiredRequestBody, partitionApiModules, readSchema, readTemplateFile, renderApiModules, transformEntity, transformFn, transformModuleName, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };
+export { type ApiModule, type ApiModulePayload, type ApiModuleTemplateData, type Config, type GenerateOptions, type Preset, type StatusCodeStrategy, type StatusCodes, type Transformer, type TransformerBaseArgs, createStatusCodesByStrategy, createTransformer, defineConfig, doStatusCodeStrategy, generate, generateTypes, getCliVersion, getConfig, hasQueryParameter, isRequiredRequestBody, partitionApiModules, readSchema, readTemplateFile, renderApiModules, transformEntity, transformFn, transformModuleName, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };

package/dist/index.js

@@ -19,16 +19,16 @@ import {
   transformTypeValue,
   transformUrl,
   transformVerb
-} from "./chunk-ZOF4QGMP.js";
+} from "./chunk-I24WWW5F.js";
 import {
   createStatusCodesByStrategy,
+  doStatusCodeStrategy,
   getCliVersion,
-  getResponseMime,
   hasQueryParameter,
   isRequiredRequestBody,
   readSchema,
   readTemplateFile
-} from "./chunk-OBPECFFY.js";
+} from "./chunk-THTMWQYI.js";
 import "./chunk-6OIOYGN7.js";
 
 // src/index.ts
@@ -37,11 +37,11 @@ export {
   createStatusCodesByStrategy,
   createTransformer,
   defineConfig,
+  doStatusCodeStrategy,
   generate,
   generateTypes,
   getCliVersion,
   getConfig,
-  getResponseMime,
   hasQueryParameter,
   isRequiredRequestBody,
   partitionApiModules,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-farmer",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "API module generation tool based on Openapi3/Swagger2.",
   "keywords": [
     "cli",