api-farmer 0.0.19 → 0.0.21

package/dist/index.d.cts

@@ -38,15 +38,18 @@ declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
     head: number;
 };
 declare function readSchema(input: string): Promise<OpenAPI3>;
+declare function readSchemaContent(input: string): Promise<string>;
+declare function isRemoteSchema(path: string): boolean;
 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 getRequestBodyContentType(value: RequestBodyObject | ReferenceObject): "" | "application/json" | "application/x-www-form-urlencoded" | undefined;
 type ResponseMetadataItem = {
     status: number;
-    mime: string;
+    responseContentType: string;
 };
-declare function getValidResponseMetadataItems(operation: OperationObject, validateStatus: (status: number) => boolean): ResponseMetadataItem[];
+declare function getResponseMetadataItems(operation: OperationObject, validateStatus: (status: number) => boolean): ResponseMetadataItem[];
 
 type TransformerBaseArgs = {
     path: string;
@@ -93,11 +96,12 @@ declare function transformTypeRequestBody({ type, }: {
     verb: string;
     entity: string;
 } & TransformerBaseArgs): string;
-declare function transformTypeRequestBodyValue({ type, required, }: {
+declare function transformTypeRequestBodyValue({ type, required, requestContentType, }: {
     type: string;
     verb: string;
     entity: string;
     required: boolean;
+    requestContentType: string;
 } & TransformerBaseArgs): string;
 declare function transformTypeResponseBody({ type, }: {
     type: string;
@@ -176,6 +180,10 @@ interface ApiModulePayload {
      * The entity name of the API endpoint, such as User, Comment, Post, etc.
      */
     entity: string;
+    /**
+     * The request content type of the API endpoint, such as 'application/json', 'application/x-www-form-urlencoded'.
+     */
+    requestContentType?: string;
     /**
      * The type name of the API endpoint, such as ApiGetUsers, ApiCreatePost, ApiUpdateComment, etc.
      */
@@ -285,4 +293,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 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 };
+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, getRequestBodyContentType, getResponseMetadataItems, hasQueryParameter, isRemoteSchema, isRequiredRequestBody, partitionApiModules, readSchema, readSchemaContent, readTemplateFile, renderApiModules, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };

package/dist/index.d.ts

@@ -38,15 +38,18 @@ declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
     head: number;
 };
 declare function readSchema(input: string): Promise<OpenAPI3>;
+declare function readSchemaContent(input: string): Promise<string>;
+declare function isRemoteSchema(path: string): boolean;
 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 getRequestBodyContentType(value: RequestBodyObject | ReferenceObject): "" | "application/json" | "application/x-www-form-urlencoded" | undefined;
 type ResponseMetadataItem = {
     status: number;
-    mime: string;
+    responseContentType: string;
 };
-declare function getValidResponseMetadataItems(operation: OperationObject, validateStatus: (status: number) => boolean): ResponseMetadataItem[];
+declare function getResponseMetadataItems(operation: OperationObject, validateStatus: (status: number) => boolean): ResponseMetadataItem[];
 
 type TransformerBaseArgs = {
     path: string;
@@ -93,11 +96,12 @@ declare function transformTypeRequestBody({ type, }: {
     verb: string;
     entity: string;
 } & TransformerBaseArgs): string;
-declare function transformTypeRequestBodyValue({ type, required, }: {
+declare function transformTypeRequestBodyValue({ type, required, requestContentType, }: {
     type: string;
     verb: string;
     entity: string;
     required: boolean;
+    requestContentType: string;
 } & TransformerBaseArgs): string;
 declare function transformTypeResponseBody({ type, }: {
     type: string;
@@ -176,6 +180,10 @@ interface ApiModulePayload {
      * The entity name of the API endpoint, such as User, Comment, Post, etc.
      */
     entity: string;
+    /**
+     * The request content type of the API endpoint, such as 'application/json', 'application/x-www-form-urlencoded'.
+     */
+    requestContentType?: string;
     /**
      * The type name of the API endpoint, such as ApiGetUsers, ApiCreatePost, ApiUpdateComment, etc.
      */
@@ -285,4 +293,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 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 };
+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, getRequestBodyContentType, getResponseMetadataItems, hasQueryParameter, isRemoteSchema, isRequiredRequestBody, partitionApiModules, readSchema, readSchemaContent, readTemplateFile, renderApiModules, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };

package/dist/index.js

@@ -20,17 +20,19 @@ import {
   transformTypeValue,
   transformUrl,
   transformVerb
-} from "./chunk-K46PCBCF.js";
+} from "./chunk-GMB5TIVL.js";
 import {
   createStatusCodesByStrategy,
   getCliVersion,
-  getValidResponseMetadataItems,
+  getRequestBodyContentType,
+  getResponseMetadataItems,
   hasQueryParameter,
+  isRemoteSchema,
   isRequiredRequestBody,
   readSchema,
+  readSchemaContent,
   readTemplateFile
-} from "./chunk-SKKHIIUE.js";
-import "./chunk-6OIOYGN7.js";
+} from "./chunk-PTGO2Y5X.js";
 
 // src/index.ts
 import { default as default2 } from "pluralize";
@@ -42,12 +44,15 @@ export {
   generateTypes,
   getCliVersion,
   getConfig,
-  getValidResponseMetadataItems,
+  getRequestBodyContentType,
+  getResponseMetadataItems,
   hasQueryParameter,
+  isRemoteSchema,
   isRequiredRequestBody,
   partitionApiModules,
   default2 as pluralize,
   readSchema,
+  readSchemaContent,
   readTemplateFile,
   renderApiModules,
   transformEntity,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-farmer",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "description": "API module generation tool based on Openapi3/Swagger2.",
   "keywords": [
     "cli",
@@ -49,7 +49,7 @@
   },
   "dependencies": {
     "@types/pluralize": "^0.0.33",
-    "@varlet/axle": "^0.10.1",
+    "@varlet/axle": "^0.10.3",
     "commander": "^13.0.0",
     "ejs": "^3.1.10",
     "fs-extra": "^11.2.0",
@@ -59,7 +59,8 @@
     "rslog": "^1.2.3",
     "swagger2openapi": "^7.0.8",
     "unconfig": "^0.6.0",
-    "yaml": "^2.7.0"
+    "yaml": "^2.7.0",
+    "prettier": "^3.4.2"
   },
   "devDependencies": {
     "@configurajs/eslint": "^0.1.0",
@@ -71,7 +72,6 @@
     "@varlet/release": "^0.3.1",
     "eslint": "^9.17.0",
     "nano-staged": "0.8.0",
-    "prettier": "^3.4.2",
     "rimraf": "^6.0.1",
     "simple-git-hooks": "^2.11.1",
     "tsup": "8.3.5",

package/templates/axios.ejs

@@ -4,11 +4,16 @@
 
 <% if (!typesOnly) { %>
 <% apiModule.payloads.forEach(payload => { %> -%>
-export const <%- payload.fn %> = (config<% if (ts) { %>: RequestConfig<<%- payload.typeRequestBody %>> <% } %> = {}) 
-=> request<% if (ts) { %><any, <%- payload.typeResponseBody %>><% } %>({
+export const <%- payload.fn %> = (config<% if (ts) { %>: RequestConfig<<%- payload.typeQuery %>, <%- payload.typeRequestBody %>> <% } %> = {}) 
+=> request<% if (ts) { %><<%- payload.typeResponseBody %>><% } %>({
   url: '<%- payload.url %>', 
   method: '<%- payload.method %>',
-  ...config
+  ...config,
+  <% if (payload.requestContentType === 'application/x-www-form-urlencoded') { %>headers: {
+    'Content-Type': 'application/x-www-form-urlencoded',
+    ...config.headers,
+  },
+  <% } %>
 })
 
 <% }) %>

package/templates/axle.ejs

@@ -10,9 +10,11 @@ export const <%- payload.fn %> = api
   <%- payload.typeQuery %> 
 <% } else { %>
   <%- payload.typeRequestBody %> 
-<% } %>, <%- payload.typeRequestBody %>>
+<% } %>, 
+<%- payload.typeRequestBody %>>
 <% } %>
-('<%- payload.url %>', '<%- payload.method %>')
+('<%- payload.url %>', 
+<% if (payload.requestContentType === 'application/x-www-form-urlencoded' && payload.method === 'post') { %> 'postUrlEncode'<% } else { %> '<%- payload.method %>' <% } %>)
 
 <% }) %>
 <% } %>