api-farmer 0.0.5 → 0.0.7

package/README.md

@@ -51,6 +51,7 @@ npx af
 
 > [!TIP]
 > The generated content does not include the integration of the request client.
+> If you allow ts code output, you will see a custom type called `Res`. This type needs to be defined in `global.d.ts` for use.
 
 #### Some Examples
 

package/dist/{chunk-6T5EWOBD.js → chunk-GHW46C2M.js}

@@ -1,11 +1,12 @@
 import {
   CWD,
   createStatusCodesByStrategy,
+  getResponseMime,
   hasQueryParameter,
-  hasResponseBody,
+  isRequiredRequestBody,
   readSchema,
   readTemplateFile
-} from "./chunk-6N4OHGAC.js";
+} from "./chunk-OBPECFFY.js";
 import {
   __export
 } from "./chunk-6OIOYGN7.js";
@@ -22784,8 +22785,8 @@ function transformTypeQueryValue({ type: type2 }) {
 function transformTypeRequestBody({ verb, entity }) {
   return `Api${verb}${entity}RequestBody`;
 }
-function transformTypeRequestBodyValue({ type: type2 }) {
-  return `${type2}['requestBody']['content']['application/json']`;
+function transformTypeRequestBodyValue({ type: type2, required }) {
+  return required ? `${type2}['requestBody']['content']['application/json']` : `NonNullable<${type2}['requestBody']>['content']['application/json'] | undefined`;
 }
 function transformTypeResponseBody({ verb, entity }) {
   return `Api${verb}${entity}ResponseBody`;
@@ -22835,11 +22836,14 @@ function partitionApiModules(schema2, transformer, options8) {
         const typeQuery = transformer.typeQuery({ verb, entity });
         const typeQueryValue = hasQueryParameter(operation) ? transformer.typeQueryValue({ type: type2 }) : "never";
         const typeRequestBody = transformer.typeRequestBody({ verb, entity });
-        const typeRequestBodyValue = operation.requestBody ? transformer.typeRequestBodyValue({ type: type2 }) : "never";
-        const typeResponseBody = transformer.typeResponseBody({ verb, entity });
+        const typeRequestBodyValue = operation.requestBody ? transformer.typeRequestBodyValue({
+          type: type2,
+          required: isRequiredRequestBody(operation.requestBody)
+        }) : "never";
         const statusCode = statusCodes[method] ?? 200;
-        const mime = operation.responses?.[statusCode]?.content?.["application/json"] ? "application/json" : "*/*";
-        const typeResponseBodyValue = hasResponseBody(operation) ? transformer.typeResponseBodyValue({ type: type2, statusCode, mime }) : "never";
+        const mime = getResponseMime(operation, statusCode);
+        const typeResponseBody = transformer.typeResponseBody({ verb, entity });
+        const typeResponseBodyValue = mime ? transformer.typeResponseBodyValue({ type: type2, statusCode, mime }) : "never";
         payloads3.push({
           fn,
           url: url2,

package/dist/{chunk-6N4OHGAC.js → chunk-OBPECFFY.js}

@@ -52,14 +52,16 @@ function readTemplateFile(preset = "axle") {
 function hasQueryParameter(operation) {
   return (operation.parameters ?? []).some((param) => "in" in param && param.in === "query");
 }
-function hasResponseBody(operation) {
-  return Object.values(operation.responses ?? {}).some(
-    (responseObject) => "content" in responseObject && responseObject.content
-  );
-}
 function getCliVersion() {
   return fse.readJsonSync(CLI_PACKAGE_JSON).version;
 }
+function isRequiredRequestBody(value) {
+  return "required" in value && value.required === true;
+}
+function getResponseMime(operation, statusCode) {
+  const content = operation.responses?.[statusCode]?.content;
+  return content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
+}
 
 export {
   CWD,
@@ -67,6 +69,7 @@ export {
   readSchema,
   readTemplateFile,
   hasQueryParameter,
-  hasResponseBody,
-  getCliVersion
+  getCliVersion,
+  isRequiredRequestBody,
+  getResponseMime
 };

package/dist/cli.cjs

@@ -93,14 +93,16 @@ function readTemplateFile(preset = "axle") {
 function hasQueryParameter(operation) {
   return (operation.parameters ?? []).some((param) => "in" in param && param.in === "query");
 }
-function hasResponseBody(operation) {
-  return Object.values(operation.responses ?? {}).some(
-    (responseObject) => "content" in responseObject && responseObject.content
-  );
-}
 function getCliVersion() {
   return import_fs_extra.default.readJsonSync(CLI_PACKAGE_JSON).version;
 }
+function isRequiredRequestBody(value) {
+  return "required" in value && value.required === true;
+}
+function getResponseMime(operation, statusCode) {
+  const content = operation.responses?.[statusCode]?.content;
+  return content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
+}
 var import_path2, import_fs_extra, import_swagger2openapi, import_yaml;
 var init_utils = __esm({
   "src/utils.ts"() {
@@ -102043,8 +102045,8 @@ function transformTypeQueryValue({ type: type2 }) {
 function transformTypeRequestBody({ verb, entity }) {
   return `Api${verb}${entity}RequestBody`;
 }
-function transformTypeRequestBodyValue({ type: type2 }) {
-  return `${type2}['requestBody']['content']['application/json']`;
+function transformTypeRequestBodyValue({ type: type2, required }) {
+  return required ? `${type2}['requestBody']['content']['application/json']` : `NonNullable<${type2}['requestBody']>['content']['application/json'] | undefined`;
 }
 function transformTypeResponseBody({ verb, entity }) {
   return `Api${verb}${entity}ResponseBody`;
@@ -102110,11 +102112,14 @@ function partitionApiModules(schema2, transformer, options8) {
         const typeQuery = transformer.typeQuery({ verb, entity });
         const typeQueryValue = hasQueryParameter(operation) ? transformer.typeQueryValue({ type: type2 }) : "never";
         const typeRequestBody = transformer.typeRequestBody({ verb, entity });
-        const typeRequestBodyValue = operation.requestBody ? transformer.typeRequestBodyValue({ type: type2 }) : "never";
-        const typeResponseBody = transformer.typeResponseBody({ verb, entity });
+        const typeRequestBodyValue = operation.requestBody ? transformer.typeRequestBodyValue({
+          type: type2,
+          required: isRequiredRequestBody(operation.requestBody)
+        }) : "never";
         const statusCode = statusCodes[method] ?? 200;
-        const mime = operation.responses?.[statusCode]?.content?.["application/json"] ? "application/json" : "*/*";
-        const typeResponseBodyValue = hasResponseBody(operation) ? transformer.typeResponseBodyValue({ type: type2, statusCode, mime }) : "never";
+        const mime = getResponseMime(operation, statusCode);
+        const typeResponseBody = transformer.typeResponseBody({ verb, entity });
+        const typeResponseBodyValue = mime ? transformer.typeResponseBodyValue({ type: type2, statusCode, mime }) : "never";
         payloads3.push({
           fn: fn8,
           url: url2,

package/dist/cli.js

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

package/dist/{generate-544AKFJX.js → generate-QIKM4YKD.js}

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

package/dist/index.cjs

@@ -79232,8 +79232,9 @@ __export(index_exports, {
   generateTypes: () => generateTypes,
   getCliVersion: () => getCliVersion,
   getConfig: () => getConfig,
+  getResponseMime: () => getResponseMime,
   hasQueryParameter: () => hasQueryParameter,
-  hasResponseBody: () => hasResponseBody,
+  isRequiredRequestBody: () => isRequiredRequestBody,
   partitionApiModules: () => partitionApiModules,
   pluralize: () => import_pluralize2.default,
   readSchema: () => readSchema,
@@ -79308,8 +79309,8 @@ function transformTypeQueryValue({ type: type2 }) {
 function transformTypeRequestBody({ verb, entity }) {
   return `Api${verb}${entity}RequestBody`;
 }
-function transformTypeRequestBodyValue({ type: type2 }) {
-  return `${type2}['requestBody']['content']['application/json']`;
+function transformTypeRequestBodyValue({ type: type2, required }) {
+  return required ? `${type2}['requestBody']['content']['application/json']` : `NonNullable<${type2}['requestBody']>['content']['application/json'] | undefined`;
 }
 function transformTypeResponseBody({ verb, entity }) {
   return `Api${verb}${entity}ResponseBody`;
@@ -102118,14 +102119,16 @@ function readTemplateFile(preset = "axle") {
 function hasQueryParameter(operation) {
   return (operation.parameters ?? []).some((param) => "in" in param && param.in === "query");
 }
-function hasResponseBody(operation) {
-  return Object.values(operation.responses ?? {}).some(
-    (responseObject) => "content" in responseObject && responseObject.content
-  );
-}
 function getCliVersion() {
   return import_fs_extra.default.readJsonSync(CLI_PACKAGE_JSON).version;
 }
+function isRequiredRequestBody(value) {
+  return "required" in value && value.required === true;
+}
+function getResponseMime(operation, statusCode) {
+  const content = operation.responses?.[statusCode]?.content;
+  return content?.["application/json"] ? "application/json" : content?.["*/*"] ? "*/*" : void 0;
+}
 
 // src/generate.ts
 function partitionApiModules(schema2, transformer, options8) {
@@ -102147,11 +102150,14 @@ function partitionApiModules(schema2, transformer, options8) {
         const typeQuery = transformer.typeQuery({ verb, entity });
         const typeQueryValue = hasQueryParameter(operation) ? transformer.typeQueryValue({ type: type2 }) : "never";
         const typeRequestBody = transformer.typeRequestBody({ verb, entity });
-        const typeRequestBodyValue = operation.requestBody ? transformer.typeRequestBodyValue({ type: type2 }) : "never";
-        const typeResponseBody = transformer.typeResponseBody({ verb, entity });
+        const typeRequestBodyValue = operation.requestBody ? transformer.typeRequestBodyValue({
+          type: type2,
+          required: isRequiredRequestBody(operation.requestBody)
+        }) : "never";
         const statusCode = statusCodes[method] ?? 200;
-        const mime = operation.responses?.[statusCode]?.content?.["application/json"] ? "application/json" : "*/*";
-        const typeResponseBodyValue = hasResponseBody(operation) ? transformer.typeResponseBodyValue({ type: type2, statusCode, mime }) : "never";
+        const mime = getResponseMime(operation, statusCode);
+        const typeResponseBody = transformer.typeResponseBody({ verb, entity });
+        const typeResponseBodyValue = mime ? transformer.typeResponseBodyValue({ type: type2, statusCode, mime }) : "never";
         payloads3.push({
           fn: fn8,
           url: url2,
@@ -102257,8 +102263,9 @@ var import_pluralize2 = __toESM(require("pluralize"), 1);
   generateTypes,
   getCliVersion,
   getConfig,
+  getResponseMime,
   hasQueryParameter,
-  hasResponseBody,
+  isRequiredRequestBody,
   partitionApiModules,
   pluralize,
   readSchema,

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { OpenAPI3, OperationObject } from 'openapi-typescript';
+import { OpenAPI3, OperationObject, RequestBodyObject, ReferenceObject } from 'openapi-typescript';
 export { default as pluralize } from 'pluralize';
 
 declare function transformModuleName({ name }: {
@@ -39,8 +39,9 @@ declare function transformTypeRequestBody({ verb, entity }: {
     verb: string;
     entity: string;
 }): string;
-declare function transformTypeRequestBodyValue({ type }: {
+declare function transformTypeRequestBodyValue({ type, required }: {
     type: string;
+    required: boolean;
 }): string;
 declare function transformTypeResponseBody({ verb, entity }: {
     verb: string;
@@ -99,8 +100,9 @@ declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
 declare function readSchema(input: string): Promise<OpenAPI3>;
 declare function readTemplateFile(preset?: Preset): string;
 declare function hasQueryParameter(operation: OperationObject): boolean;
-declare function hasResponseBody(operation: OperationObject): boolean;
 declare function getCliVersion(): any;
+declare function isRequiredRequestBody(value: RequestBodyObject | ReferenceObject): boolean;
+declare function getResponseMime(operation: OperationObject, statusCode: number): "application/json" | "*/*" | undefined;
 
 interface ApiModuleTemplateData {
     /**
@@ -249,4 +251,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, createStatusCodesByStrategy, createTransformer, defineConfig, generate, generateTypes, getCliVersion, getConfig, hasQueryParameter, hasResponseBody, 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, 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 };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { OpenAPI3, OperationObject } from 'openapi-typescript';
+import { OpenAPI3, OperationObject, RequestBodyObject, ReferenceObject } from 'openapi-typescript';
 export { default as pluralize } from 'pluralize';
 
 declare function transformModuleName({ name }: {
@@ -39,8 +39,9 @@ declare function transformTypeRequestBody({ verb, entity }: {
     verb: string;
     entity: string;
 }): string;
-declare function transformTypeRequestBodyValue({ type }: {
+declare function transformTypeRequestBodyValue({ type, required }: {
     type: string;
+    required: boolean;
 }): string;
 declare function transformTypeResponseBody({ verb, entity }: {
     verb: string;
@@ -99,8 +100,9 @@ declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
 declare function readSchema(input: string): Promise<OpenAPI3>;
 declare function readTemplateFile(preset?: Preset): string;
 declare function hasQueryParameter(operation: OperationObject): boolean;
-declare function hasResponseBody(operation: OperationObject): boolean;
 declare function getCliVersion(): any;
+declare function isRequiredRequestBody(value: RequestBodyObject | ReferenceObject): boolean;
+declare function getResponseMime(operation: OperationObject, statusCode: number): "application/json" | "*/*" | undefined;
 
 interface ApiModuleTemplateData {
     /**
@@ -249,4 +251,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, createStatusCodesByStrategy, createTransformer, defineConfig, generate, generateTypes, getCliVersion, getConfig, hasQueryParameter, hasResponseBody, 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, 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 };

package/dist/index.js

@@ -19,15 +19,16 @@ import {
   transformTypeValue,
   transformUrl,
   transformVerb
-} from "./chunk-6T5EWOBD.js";
+} from "./chunk-GHW46C2M.js";
 import {
   createStatusCodesByStrategy,
   getCliVersion,
+  getResponseMime,
   hasQueryParameter,
-  hasResponseBody,
+  isRequiredRequestBody,
   readSchema,
   readTemplateFile
-} from "./chunk-6N4OHGAC.js";
+} from "./chunk-OBPECFFY.js";
 import "./chunk-6OIOYGN7.js";
 
 // src/index.ts
@@ -40,8 +41,9 @@ export {
   generateTypes,
   getCliVersion,
   getConfig,
+  getResponseMime,
   hasQueryParameter,
-  hasResponseBody,
+  isRequiredRequestBody,
   partitionApiModules,
   default2 as pluralize,
   readSchema,

package/package.json

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