api-farmer 0.1.1 → 0.1.3

package/README.md

@@ -153,6 +153,11 @@ 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

package/dist/{chunk-P3SVS555.js → chunk-RIXLRGPZ.js}

@@ -146,8 +146,8 @@ function createTransformer() {
 
 // src/generate.ts
 function transformPayloads(pathItems, options) {
-  const { transformer, path, fullPath, base, uncountableNouns, validateStatus } = options;
-  return Object.entries(pathItems).filter(([key]) => SUPPORTED_HTTP_METHODS.includes(key)).reduce((payloads, [method, operation]) => {
+  const { transformer, path, fullPath, base, uncountableNouns, validateStatus, excludeDeprecated } = options;
+  return Object.entries(pathItems).filter(([key]) => SUPPORTED_HTTP_METHODS.includes(key)).filter(([, operation]) => !(excludeDeprecated && operation.deprecated)).reduce((payloads, [method, operation]) => {
     const url = transformer.url({ path, base, fullPath });
     const args = { path, base, fullPath, url, method, uncountableNouns, operation };
     const entity = transformer.entity(args);
@@ -192,7 +192,7 @@ function transformPayloads(pathItems, options) {
   }, []);
 }
 function partitionApiModules(schema, options) {
-  const { base, transformer, uncountableNouns, validateStatus } = options;
+  const { base, transformer, uncountableNouns, validateStatus, excludeDeprecated } = options;
   const schemaPaths = schema.paths ?? {};
   const schemaPathKeys = base ? Object.keys(schemaPaths).map((key) => key.replace(base, "")) : Object.keys(schemaPaths);
   const keyToPaths = groupBy(schemaPathKeys, (key) => key.split("/")[1]);
@@ -207,7 +207,8 @@ function partitionApiModules(schema, options) {
           fullPath,
           transformer,
           uncountableNouns,
-          validateStatus
+          validateStatus,
+          excludeDeprecated
         })
       );
       return payloads2;
@@ -280,14 +281,23 @@ async function generate(userOptions = {}) {
     input = "./schema.json",
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
+    clean = false,
     validateStatus = (status) => status >= 200 && status < 300,
     transformer = {},
     uncountableNouns = [],
-    openapiTsOptions = {}
+    openapiTsOptions = {},
+    excludeDeprecated = false
   } = 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 (openapiTsOptions.excludeDeprecated === void 0) {
+    openapiTsOptions.excludeDeprecated = excludeDeprecated;
+  }
   if (ts2) {
     await generateTypes(schema, output, typesFilename, openapiTsOptions);
   }
@@ -295,7 +305,8 @@ async function generate(userOptions = {}) {
     base,
     uncountableNouns,
     transformer: mergedTransformer,
-    validateStatus
+    validateStatus,
+    excludeDeprecated
   });
   await renderApiModules(apiModules, { output, typesFilename, ts: ts2, typesOnly, overrides, preset });
   logger.success("Done");

package/dist/cli.cjs

@@ -273,8 +273,8 @@ __export(generate_exports, {
   transformPayloads: () => transformPayloads
 });
 function transformPayloads(pathItems, options) {
-  const { transformer, path, fullPath, base, uncountableNouns, validateStatus } = options;
-  return Object.entries(pathItems).filter(([key]) => SUPPORTED_HTTP_METHODS.includes(key)).reduce((payloads, [method, operation]) => {
+  const { transformer, path, fullPath, base, uncountableNouns, validateStatus, excludeDeprecated } = options;
+  return Object.entries(pathItems).filter(([key]) => SUPPORTED_HTTP_METHODS.includes(key)).filter(([, operation]) => !(excludeDeprecated && operation.deprecated)).reduce((payloads, [method, operation]) => {
     const url = transformer.url({ path, base, fullPath });
     const args = { path, base, fullPath, url, method, uncountableNouns, operation };
     const entity = transformer.entity(args);
@@ -319,7 +319,7 @@ function transformPayloads(pathItems, options) {
   }, []);
 }
 function partitionApiModules(schema, options) {
-  const { base, transformer, uncountableNouns, validateStatus } = options;
+  const { base, transformer, uncountableNouns, validateStatus, excludeDeprecated } = options;
   const schemaPaths = schema.paths ?? {};
   const schemaPathKeys = base ? Object.keys(schemaPaths).map((key) => key.replace(base, "")) : Object.keys(schemaPaths);
   const keyToPaths = (0, import_rattail3.groupBy)(schemaPathKeys, (key) => key.split("/")[1]);
@@ -334,7 +334,8 @@ function partitionApiModules(schema, options) {
           fullPath,
           transformer,
           uncountableNouns,
-          validateStatus
+          validateStatus,
+          excludeDeprecated
         })
       );
       return payloads2;
@@ -407,14 +408,23 @@ async function generate(userOptions = {}) {
     input = "./schema.json",
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
+    clean = false,
     validateStatus = (status) => status >= 200 && status < 300,
     transformer = {},
     uncountableNouns = [],
-    openapiTsOptions = {}
+    openapiTsOptions = {},
+    excludeDeprecated = false
   } = 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 (openapiTsOptions.excludeDeprecated === void 0) {
+    openapiTsOptions.excludeDeprecated = excludeDeprecated;
+  }
   if (ts2) {
     await generateTypes(schema, output, typesFilename, openapiTsOptions);
   }
@@ -422,7 +432,8 @@ async function generate(userOptions = {}) {
     base,
     uncountableNouns,
     transformer: mergedTransformer,
-    validateStatus
+    validateStatus,
+    excludeDeprecated
   });
   await renderApiModules(apiModules, { output, typesFilename, ts: ts2, typesOnly, overrides, preset });
   import_rslog2.logger.success("Done");

package/dist/cli.js

@@ -8,7 +8,7 @@ import { Command } from "commander";
 var program = new Command();
 program.version(getCliVersion());
 program.action(async () => {
-  const { generate } = await import("./generate-WIU5E7EL.js");
+  const { generate } = await import("./generate-4J5VPBTS.js");
   return generate();
 });
 program.parse();

package/dist/{generate-WIU5E7EL.js → generate-4J5VPBTS.js}

@@ -4,7 +4,7 @@ import {
   partitionApiModules,
   renderApiModules,
   transformPayloads
-} from "./chunk-P3SVS555.js";
+} from "./chunk-RIXLRGPZ.js";
 import "./chunk-2227C45C.js";
 export {
   generate,

package/dist/index.cjs

@@ -314,8 +314,8 @@ function getResponseMetadataItems(operation, validateStatus) {
 
 // src/generate.ts
 function transformPayloads(pathItems, options) {
-  const { transformer, path, fullPath, base, uncountableNouns, validateStatus } = options;
-  return Object.entries(pathItems).filter(([key]) => SUPPORTED_HTTP_METHODS.includes(key)).reduce((payloads, [method, operation]) => {
+  const { transformer, path, fullPath, base, uncountableNouns, validateStatus, excludeDeprecated } = options;
+  return Object.entries(pathItems).filter(([key]) => SUPPORTED_HTTP_METHODS.includes(key)).filter(([, operation]) => !(excludeDeprecated && operation.deprecated)).reduce((payloads, [method, operation]) => {
     const url = transformer.url({ path, base, fullPath });
     const args = { path, base, fullPath, url, method, uncountableNouns, operation };
     const entity = transformer.entity(args);
@@ -360,7 +360,7 @@ function transformPayloads(pathItems, options) {
   }, []);
 }
 function partitionApiModules(schema, options) {
-  const { base, transformer, uncountableNouns, validateStatus } = options;
+  const { base, transformer, uncountableNouns, validateStatus, excludeDeprecated } = options;
   const schemaPaths = schema.paths ?? {};
   const schemaPathKeys = base ? Object.keys(schemaPaths).map((key) => key.replace(base, "")) : Object.keys(schemaPaths);
   const keyToPaths = (0, import_rattail3.groupBy)(schemaPathKeys, (key) => key.split("/")[1]);
@@ -375,7 +375,8 @@ function partitionApiModules(schema, options) {
           fullPath,
           transformer,
           uncountableNouns,
-          validateStatus
+          validateStatus,
+          excludeDeprecated
         })
       );
       return payloads2;
@@ -448,14 +449,23 @@ async function generate(userOptions = {}) {
     input = "./schema.json",
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
+    clean = false,
     validateStatus = (status) => status >= 200 && status < 300,
     transformer = {},
     uncountableNouns = [],
-    openapiTsOptions = {}
+    openapiTsOptions = {},
+    excludeDeprecated = false
   } = 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 (openapiTsOptions.excludeDeprecated === void 0) {
+    openapiTsOptions.excludeDeprecated = excludeDeprecated;
+  }
   if (ts2) {
     await generateTypes(schema, output, typesFilename, openapiTsOptions);
   }
@@ -463,7 +473,8 @@ async function generate(userOptions = {}) {
     base,
     uncountableNouns,
     transformer: mergedTransformer,
-    validateStatus
+    validateStatus,
+    excludeDeprecated
   });
   await renderApiModules(apiModules, { output, typesFilename, ts: ts2, typesOnly, overrides, preset });
   import_rslog2.logger.success("Done");

package/dist/index.d.cts

@@ -285,10 +285,20 @@ 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;
+    /**
+     * Whether to exclude deprecated API endpoints.
+     * @default false
+     */
+    excludeDeprecated?: boolean;
 }
 declare function transformPayloads(pathItems: Record<string, OperationObject>, options: {
     path: string;
@@ -297,12 +307,14 @@ declare function transformPayloads(pathItems: Record<string, OperationObject>, o
     transformer: Transformer;
     uncountableNouns: string[];
     validateStatus: (status: number) => boolean;
+    excludeDeprecated?: boolean;
 }): ApiModulePayload[];
 declare function partitionApiModules(schema: OpenAPI3, options: {
     transformer: Transformer;
     base: string | undefined;
     uncountableNouns: string[];
     validateStatus: (status: number) => boolean;
+    excludeDeprecated?: boolean;
 }): ApiModule[];
 declare function renderApiModules(apiModules: ApiModule[], options: {
     output: string;

package/dist/index.d.ts

@@ -285,10 +285,20 @@ 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;
+    /**
+     * Whether to exclude deprecated API endpoints.
+     * @default false
+     */
+    excludeDeprecated?: boolean;
 }
 declare function transformPayloads(pathItems: Record<string, OperationObject>, options: {
     path: string;
@@ -297,12 +307,14 @@ declare function transformPayloads(pathItems: Record<string, OperationObject>, o
     transformer: Transformer;
     uncountableNouns: string[];
     validateStatus: (status: number) => boolean;
+    excludeDeprecated?: boolean;
 }): ApiModulePayload[];
 declare function partitionApiModules(schema: OpenAPI3, options: {
     transformer: Transformer;
     base: string | undefined;
     uncountableNouns: string[];
     validateStatus: (status: number) => boolean;
+    excludeDeprecated?: boolean;
 }): ApiModule[];
 declare function renderApiModules(apiModules: ApiModule[], options: {
     output: string;

package/dist/index.js

@@ -21,7 +21,7 @@ import {
   transformTypeValue,
   transformUrl,
   transformVerb
-} from "./chunk-P3SVS555.js";
+} from "./chunk-RIXLRGPZ.js";
 import {
   createStatusCodesByStrategy,
   findObjectKey,

package/package.json

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