api-farmer 0.1.0 → 0.1.2

package/README.md

@@ -153,6 +153,16 @@ export interface Config {
    * Certain uncountable nouns that do not change from singular to plural
    */
   uncountableNouns?: string[]
+  /**
+   * Whether to clean the output directory before generating.
+   * @default false
+   */
+  clean?: boolean
+  /**
+   *  The options for the openapiTS library.
+   *  @see https://openapi-ts.dev/node
+   */
+  openapiTsOptions?: OpenAPITSOptions
 }
 ```
 

package/dist/{chunk-56NOW5DM.js → chunk-2227C45C.js}

@@ -105,7 +105,7 @@ function getResponseMetadataItems(operation, validateStatus) {
   const validStatusResults = Object.keys(responses).sort((a, b) => Number(a) - Number(b)).filter((key) => validateStatus(Number(key))).map(Number);
   const metadataItems = validStatusResults.map((status) => {
     const content = operation.responses?.[status]?.content ?? {};
-    const responseContentType = findObjectKey(content, ["application/json", "*/*"]);
+    const responseContentType = findObjectKey(content, ["application/json", "application/octet-stream", "*/*"]);
     return {
       status,
       responseContentType

package/dist/{chunk-XM4XA35S.js → chunk-FOIQWD3Q.js}

@@ -6,7 +6,7 @@ import {
   isRequiredRequestBody,
   readSchema,
   readTemplateFile
-} from "./chunk-56NOW5DM.js";
+} from "./chunk-2227C45C.js";
 
 // src/generate.ts
 import { resolve } from "path";
@@ -16,6 +16,7 @@ import openapiTS, { astToString } from "openapi-typescript";
 import prettier from "prettier";
 import { groupBy, isArray, merge } from "rattail";
 import { logger } from "rslog";
+import ts from "typescript";
 
 // src/config.ts
 import { loadConfig } from "unconfig";
@@ -217,7 +218,7 @@ function partitionApiModules(schema, options) {
   return apiModules;
 }
 function renderApiModules(apiModules, options) {
-  const { output, ts, typesOnly, overrides, preset } = options;
+  const { output, ts: ts2, typesOnly, overrides, preset } = options;
   const templateFile = readTemplateFile(preset);
   const typesFilename = options.typesFilename.replace(".ts", "");
   return Promise.all(
@@ -226,7 +227,7 @@ function renderApiModules(apiModules, options) {
         const data = {
           apiModule,
           typesFilename,
-          ts,
+          ts: ts2,
           typesOnly
         };
         prettier.format(ejs.render(templateFile, data), {
@@ -235,7 +236,7 @@ function renderApiModules(apiModules, options) {
           singleQuote: true,
           printWidth: 120
         }).then((content) => {
-          const path = resolve(output, `${apiModule.name}.${ts ? "ts" : "js"}`);
+          const path = resolve(output, `${apiModule.name}.${ts2 ? "ts" : "js"}`);
           const shouldSkip = (!overrides || isArray(overrides) && !overrides.includes(apiModule.name)) && fse.existsSync(path);
           if (shouldSkip) {
             logger.warn(`File already exists, skip: ${path}`);
@@ -250,9 +251,17 @@ function renderApiModules(apiModules, options) {
     )
   );
 }
-async function generateTypes(schema, output, typesFilename) {
+async function generateTypes(schema, output, typesFilename, openapiTsOptions) {
+  const BLOB = ts.factory.createTypeReferenceNode(ts.factory.createIdentifier("Blob"));
+  const NULL = ts.factory.createLiteralTypeNode(ts.factory.createNull());
   const ast = await openapiTS(schema, {
-    defaultNonNullable: false
+    defaultNonNullable: false,
+    transform(schemaObject) {
+      if (schemaObject.format === "binary") {
+        return schemaObject.nullable ? ts.factory.createUnionTypeNode([BLOB, NULL]) : BLOB;
+      }
+    },
+    ...openapiTsOptions
   });
   const contents = astToString(ast);
   const typesFilepath = resolve(CWD, output, typesFilename);
@@ -264,22 +273,28 @@ async function generate(userOptions = {}) {
   const options = merge(config, userOptions);
   const {
     base,
-    ts = true,
+    ts: ts2 = true,
     typesOnly = false,
     overrides = true,
     preset = "axle",
     input = "./schema.json",
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
+    clean = false,
     validateStatus = (status) => status >= 200 && status < 300,
     transformer = {},
-    uncountableNouns = []
+    uncountableNouns = [],
+    openapiTsOptions = {}
   } = options;
   const mergedTransformer = { ...createTransformer(), ...transformer };
   const schema = await readSchema(input);
+  if (clean) {
+    fse.removeSync(resolve(CWD, output));
+    logger.info(`Cleaned output directory: ${resolve(CWD, output)}`);
+  }
   logger.info("Generating API modules...");
-  if (ts) {
-    await generateTypes(schema, output, typesFilename);
+  if (ts2) {
+    await generateTypes(schema, output, typesFilename, openapiTsOptions);
   }
   const apiModules = partitionApiModules(schema, {
     base,
@@ -287,7 +302,7 @@ async function generate(userOptions = {}) {
     transformer: mergedTransformer,
     validateStatus
   });
-  await renderApiModules(apiModules, { output, typesFilename, ts, typesOnly, overrides, preset });
+  await renderApiModules(apiModules, { output, typesFilename, ts: ts2, typesOnly, overrides, preset });
   logger.success("Done");
 }
 

package/dist/cli.cjs

@@ -102,7 +102,7 @@ function getResponseMetadataItems(operation, validateStatus) {
   const validStatusResults = Object.keys(responses).sort((a, b) => Number(a) - Number(b)).filter((key) => validateStatus(Number(key))).map(Number);
   const metadataItems = validStatusResults.map((status) => {
     const content = operation.responses?.[status]?.content ?? {};
-    const responseContentType = findObjectKey(content, ["application/json", "*/*"]);
+    const responseContentType = findObjectKey(content, ["application/json", "application/octet-stream", "*/*"]);
     return {
       status,
       responseContentType
@@ -345,7 +345,7 @@ function partitionApiModules(schema, options) {
   return apiModules;
 }
 function renderApiModules(apiModules, options) {
-  const { output, ts, typesOnly, overrides, preset } = options;
+  const { output, ts: ts2, typesOnly, overrides, preset } = options;
   const templateFile = readTemplateFile(preset);
   const typesFilename = options.typesFilename.replace(".ts", "");
   return Promise.all(
@@ -354,7 +354,7 @@ function renderApiModules(apiModules, options) {
         const data = {
           apiModule,
           typesFilename,
-          ts,
+          ts: ts2,
           typesOnly
         };
         import_prettier.default.format(import_ejs.default.render(templateFile, data), {
@@ -363,7 +363,7 @@ function renderApiModules(apiModules, options) {
           singleQuote: true,
           printWidth: 120
         }).then((content) => {
-          const path = (0, import_path3.resolve)(output, `${apiModule.name}.${ts ? "ts" : "js"}`);
+          const path = (0, import_path3.resolve)(output, `${apiModule.name}.${ts2 ? "ts" : "js"}`);
           const shouldSkip = (!overrides || (0, import_rattail3.isArray)(overrides) && !overrides.includes(apiModule.name)) && import_fs_extra2.default.existsSync(path);
           if (shouldSkip) {
             import_rslog2.logger.warn(`File already exists, skip: ${path}`);
@@ -378,9 +378,17 @@ function renderApiModules(apiModules, options) {
     )
   );
 }
-async function generateTypes(schema, output, typesFilename) {
+async function generateTypes(schema, output, typesFilename, openapiTsOptions) {
+  const BLOB = import_typescript.default.factory.createTypeReferenceNode(import_typescript.default.factory.createIdentifier("Blob"));
+  const NULL = import_typescript.default.factory.createLiteralTypeNode(import_typescript.default.factory.createNull());
   const ast = await (0, import_openapi_typescript.default)(schema, {
-    defaultNonNullable: false
+    defaultNonNullable: false,
+    transform(schemaObject) {
+      if (schemaObject.format === "binary") {
+        return schemaObject.nullable ? import_typescript.default.factory.createUnionTypeNode([BLOB, NULL]) : BLOB;
+      }
+    },
+    ...openapiTsOptions
   });
   const contents = (0, import_openapi_typescript.astToString)(ast);
   const typesFilepath = (0, import_path3.resolve)(CWD, output, typesFilename);
@@ -392,22 +400,28 @@ async function generate(userOptions = {}) {
   const options = (0, import_rattail3.merge)(config, userOptions);
   const {
     base,
-    ts = true,
+    ts: ts2 = true,
     typesOnly = false,
     overrides = true,
     preset = "axle",
     input = "./schema.json",
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
+    clean = false,
     validateStatus = (status) => status >= 200 && status < 300,
     transformer = {},
-    uncountableNouns = []
+    uncountableNouns = [],
+    openapiTsOptions = {}
   } = options;
   const mergedTransformer = { ...createTransformer(), ...transformer };
   const schema = await readSchema(input);
+  if (clean) {
+    import_fs_extra2.default.removeSync((0, import_path3.resolve)(CWD, output));
+    import_rslog2.logger.info(`Cleaned output directory: ${(0, import_path3.resolve)(CWD, output)}`);
+  }
   import_rslog2.logger.info("Generating API modules...");
-  if (ts) {
-    await generateTypes(schema, output, typesFilename);
+  if (ts2) {
+    await generateTypes(schema, output, typesFilename, openapiTsOptions);
   }
   const apiModules = partitionApiModules(schema, {
     base,
@@ -415,10 +429,10 @@ async function generate(userOptions = {}) {
     transformer: mergedTransformer,
     validateStatus
   });
-  await renderApiModules(apiModules, { output, typesFilename, ts, typesOnly, overrides, preset });
+  await renderApiModules(apiModules, { output, typesFilename, ts: ts2, typesOnly, overrides, preset });
   import_rslog2.logger.success("Done");
 }
-var import_path3, import_ejs, import_fs_extra2, import_openapi_typescript, import_prettier, import_rattail3, import_rslog2;
+var import_path3, import_ejs, import_fs_extra2, import_openapi_typescript, import_prettier, import_rattail3, import_rslog2, import_typescript;
 var init_generate = __esm({
   "src/generate.ts"() {
     "use strict";
@@ -430,6 +444,7 @@ var init_generate = __esm({
     import_prettier = __toESM(require("prettier"), 1);
     import_rattail3 = require("rattail");
     import_rslog2 = require("rslog");
+    import_typescript = __toESM(require("typescript"), 1);
     init_config();
     init_constants();
     init_transformer();

package/dist/cli.js

@@ -1,14 +1,14 @@
 #!/usr/bin/env node
 import {
   getCliVersion
-} from "./chunk-56NOW5DM.js";
+} from "./chunk-2227C45C.js";
 
 // src/cli.ts
 import { Command } from "commander";
 var program = new Command();
 program.version(getCliVersion());
 program.action(async () => {
-  const { generate } = await import("./generate-BJMNBKQH.js");
+  const { generate } = await import("./generate-K6NGTXOH.js");
   return generate();
 });
 program.parse();

package/dist/{generate-BJMNBKQH.js → generate-K6NGTXOH.js}

@@ -4,8 +4,8 @@ import {
   partitionApiModules,
   renderApiModules,
   transformPayloads
-} from "./chunk-XM4XA35S.js";
-import "./chunk-56NOW5DM.js";
+} from "./chunk-FOIQWD3Q.js";
+import "./chunk-2227C45C.js";
 export {
   generate,
   generateTypes,

package/dist/index.cjs

@@ -185,6 +185,7 @@ var import_openapi_typescript = __toESM(require("openapi-typescript"), 1);
 var import_prettier = __toESM(require("prettier"), 1);
 var import_rattail3 = require("rattail");
 var import_rslog2 = require("rslog");
+var import_typescript = __toESM(require("typescript"), 1);
 
 // src/config.ts
 var import_unconfig = require("unconfig");
@@ -302,7 +303,7 @@ function getResponseMetadataItems(operation, validateStatus) {
   const validStatusResults = Object.keys(responses).sort((a, b) => Number(a) - Number(b)).filter((key) => validateStatus(Number(key))).map(Number);
   const metadataItems = validStatusResults.map((status) => {
     const content = operation.responses?.[status]?.content ?? {};
-    const responseContentType = findObjectKey(content, ["application/json", "*/*"]);
+    const responseContentType = findObjectKey(content, ["application/json", "application/octet-stream", "*/*"]);
     return {
       status,
       responseContentType
@@ -385,7 +386,7 @@ function partitionApiModules(schema, options) {
   return apiModules;
 }
 function renderApiModules(apiModules, options) {
-  const { output, ts, typesOnly, overrides, preset } = options;
+  const { output, ts: ts2, typesOnly, overrides, preset } = options;
   const templateFile = readTemplateFile(preset);
   const typesFilename = options.typesFilename.replace(".ts", "");
   return Promise.all(
@@ -394,7 +395,7 @@ function renderApiModules(apiModules, options) {
         const data = {
           apiModule,
           typesFilename,
-          ts,
+          ts: ts2,
           typesOnly
         };
         import_prettier.default.format(import_ejs.default.render(templateFile, data), {
@@ -403,7 +404,7 @@ function renderApiModules(apiModules, options) {
           singleQuote: true,
           printWidth: 120
         }).then((content) => {
-          const path = (0, import_path3.resolve)(output, `${apiModule.name}.${ts ? "ts" : "js"}`);
+          const path = (0, import_path3.resolve)(output, `${apiModule.name}.${ts2 ? "ts" : "js"}`);
           const shouldSkip = (!overrides || (0, import_rattail3.isArray)(overrides) && !overrides.includes(apiModule.name)) && import_fs_extra2.default.existsSync(path);
           if (shouldSkip) {
             import_rslog2.logger.warn(`File already exists, skip: ${path}`);
@@ -418,9 +419,17 @@ function renderApiModules(apiModules, options) {
     )
   );
 }
-async function generateTypes(schema, output, typesFilename) {
+async function generateTypes(schema, output, typesFilename, openapiTsOptions) {
+  const BLOB = import_typescript.default.factory.createTypeReferenceNode(import_typescript.default.factory.createIdentifier("Blob"));
+  const NULL = import_typescript.default.factory.createLiteralTypeNode(import_typescript.default.factory.createNull());
   const ast = await (0, import_openapi_typescript.default)(schema, {
-    defaultNonNullable: false
+    defaultNonNullable: false,
+    transform(schemaObject) {
+      if (schemaObject.format === "binary") {
+        return schemaObject.nullable ? import_typescript.default.factory.createUnionTypeNode([BLOB, NULL]) : BLOB;
+      }
+    },
+    ...openapiTsOptions
   });
   const contents = (0, import_openapi_typescript.astToString)(ast);
   const typesFilepath = (0, import_path3.resolve)(CWD, output, typesFilename);
@@ -432,22 +441,28 @@ async function generate(userOptions = {}) {
   const options = (0, import_rattail3.merge)(config, userOptions);
   const {
     base,
-    ts = true,
+    ts: ts2 = true,
     typesOnly = false,
     overrides = true,
     preset = "axle",
     input = "./schema.json",
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
+    clean = false,
     validateStatus = (status) => status >= 200 && status < 300,
     transformer = {},
-    uncountableNouns = []
+    uncountableNouns = [],
+    openapiTsOptions = {}
   } = options;
   const mergedTransformer = { ...createTransformer(), ...transformer };
   const schema = await readSchema(input);
+  if (clean) {
+    import_fs_extra2.default.removeSync((0, import_path3.resolve)(CWD, output));
+    import_rslog2.logger.info(`Cleaned output directory: ${(0, import_path3.resolve)(CWD, output)}`);
+  }
   import_rslog2.logger.info("Generating API modules...");
-  if (ts) {
-    await generateTypes(schema, output, typesFilename);
+  if (ts2) {
+    await generateTypes(schema, output, typesFilename, openapiTsOptions);
   }
   const apiModules = partitionApiModules(schema, {
     base,
@@ -455,7 +470,7 @@ async function generate(userOptions = {}) {
     transformer: mergedTransformer,
     validateStatus
   });
-  await renderApiModules(apiModules, { output, typesFilename, ts, typesOnly, overrides, preset });
+  await renderApiModules(apiModules, { output, typesFilename, ts: ts2, typesOnly, overrides, preset });
   import_rslog2.logger.success("Done");
 }
 

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { OpenAPI3, RequestBodyObject, ReferenceObject, OperationObject } from 'openapi-typescript';
+import { OpenAPI3, RequestBodyObject, ReferenceObject, OperationObject, OpenAPITSOptions } from 'openapi-typescript';
 export { default as pluralize } from 'pluralize';
 
 type Preset = 'axle' | 'axios';
@@ -285,6 +285,15 @@ interface GenerateOptions {
      * Certain uncountable nouns that do not change from singular to plural
      */
     uncountableNouns?: string[];
+    /**
+     * Whether to clean the output directory before generating.
+     * @default false
+     */
+    clean?: boolean;
+    /**
+     *  A function to transform the generated types AST before printing to string.
+     */
+    openapiTsOptions?: OpenAPITSOptions;
 }
 declare function transformPayloads(pathItems: Record<string, OperationObject>, options: {
     path: string;
@@ -308,7 +317,7 @@ declare function renderApiModules(apiModules: ApiModule[], options: {
     overrides: boolean | string[];
     preset: Preset;
 }): Promise<unknown[]>;
-declare function generateTypes(schema: OpenAPI3, output: string, typesFilename: string): Promise<void>;
+declare function generateTypes(schema: OpenAPI3, output: string, typesFilename: string, openapiTsOptions: OpenAPITSOptions): Promise<void>;
 declare function generate(userOptions?: GenerateOptions): Promise<void>;
 
 type Config = GenerateOptions;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { OpenAPI3, RequestBodyObject, ReferenceObject, OperationObject } from 'openapi-typescript';
+import { OpenAPI3, RequestBodyObject, ReferenceObject, OperationObject, OpenAPITSOptions } from 'openapi-typescript';
 export { default as pluralize } from 'pluralize';
 
 type Preset = 'axle' | 'axios';
@@ -285,6 +285,15 @@ interface GenerateOptions {
      * Certain uncountable nouns that do not change from singular to plural
      */
     uncountableNouns?: string[];
+    /**
+     * Whether to clean the output directory before generating.
+     * @default false
+     */
+    clean?: boolean;
+    /**
+     *  A function to transform the generated types AST before printing to string.
+     */
+    openapiTsOptions?: OpenAPITSOptions;
 }
 declare function transformPayloads(pathItems: Record<string, OperationObject>, options: {
     path: string;
@@ -308,7 +317,7 @@ declare function renderApiModules(apiModules: ApiModule[], options: {
     overrides: boolean | string[];
     preset: Preset;
 }): Promise<unknown[]>;
-declare function generateTypes(schema: OpenAPI3, output: string, typesFilename: string): Promise<void>;
+declare function generateTypes(schema: OpenAPI3, output: string, typesFilename: string, openapiTsOptions: OpenAPITSOptions): Promise<void>;
 declare function generate(userOptions?: GenerateOptions): Promise<void>;
 
 type Config = GenerateOptions;

package/dist/index.js

@@ -21,7 +21,7 @@ import {
   transformTypeValue,
   transformUrl,
   transformVerb
-} from "./chunk-XM4XA35S.js";
+} from "./chunk-FOIQWD3Q.js";
 import {
   createStatusCodesByStrategy,
   findObjectKey,
@@ -34,7 +34,7 @@ import {
   readSchema,
   readSchemaContent,
   readTemplateFile
-} from "./chunk-56NOW5DM.js";
+} from "./chunk-2227C45C.js";
 
 // src/index.ts
 import { default as default2 } from "pluralize";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "api-farmer",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "API module generation tool based on Openapi3/Swagger2.",
   "keywords": [
     "cli",
@@ -78,7 +78,7 @@
     "typescript": "5.3.3"
   },
   "peerDependencies": {
-    "eslint": "^9.17.0"
+    "typescript": "^5.3.3"
   },
   "engines": {
     "pnpm": ">=9.0"