api-farmer 0.0.23 → 0.0.24

package/README.md

@@ -148,6 +148,10 @@ export interface Config {
    * The transformer api options, used to override the default transformation rules.
    */
   transformer?: Partial<Transformer>
+  /**
+   * Certain uncountable nouns that do not change from singular to plural
+   */
+  uncountableNouns?: string[]
 }
 ```
 

package/dist/{chunk-DJ4JEQRW.js → chunk-MMYZTUXF.js}

@@ -53,7 +53,7 @@ function transformVerb({ method }) {
       return pascalCase(method);
   }
 }
-function transformEntity({ path, method, base }) {
+function transformEntity({ path, method, base, uncountableNouns }) {
   path = base ? path.replace(base, "") : path;
   const words = path.split("/").filter(Boolean);
   return words.reduce((entity, word, index) => {
@@ -61,9 +61,9 @@ function transformEntity({ path, method, base }) {
       return entity;
     }
     word = word.replace(/\.([a-z])/g, (_, p) => p.toUpperCase());
-    word = pluralize.singular(pascalCase(word));
+    word = uncountableNouns.includes(word) ? word : pluralize.singular(pascalCase(word));
     if (method === "get" && index === words.length - 1) {
-      word = pluralize.plural(word);
+      word = uncountableNouns.includes(word) ? `${word}List` : pluralize.plural(word);
     }
     return `${entity}${word}`;
   }, "");
@@ -128,10 +128,10 @@ function createTransformer() {
 
 // src/generate.ts
 function transformPayloads(pathItems, options) {
-  const { transformer, path, base, validateStatus } = options;
+  const { transformer, path, base, uncountableNouns, validateStatus } = options;
   return Object.entries(pathItems).filter(([key]) => SUPPORTED_HTTP_METHODS.includes(key)).reduce((payloads, [method, operation]) => {
     const url = transformer.url({ path, base });
-    const args = { path, base, url, method, operation };
+    const args = { path, base, url, method, uncountableNouns, operation };
     const entity = transformer.entity(args);
     const verb = transformer.verb(args);
     const requestContentType = operation.requestBody ? getRequestBodyContentType(operation.requestBody) : void 0;
@@ -172,7 +172,7 @@ function transformPayloads(pathItems, options) {
   }, []);
 }
 function partitionApiModules(schema, options) {
-  const { base, transformer, validateStatus } = options;
+  const { base, transformer, uncountableNouns, validateStatus } = 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]);
@@ -180,7 +180,13 @@ function partitionApiModules(schema, options) {
     const payloads = paths.reduce((payloads2, path) => {
       const pathItems = schemaPaths[path];
       payloads2.push(
-        ...transformPayloads(pathItems, { ...options, path: base ? base + path : path, transformer, validateStatus })
+        ...transformPayloads(pathItems, {
+          ...options,
+          path: base ? base + path : path,
+          transformer,
+          uncountableNouns,
+          validateStatus
+        })
       );
       return payloads2;
     }, []);
@@ -243,7 +249,8 @@ async function generate(userOptions = {}) {
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
     validateStatus = (status) => status >= 200 && status < 300,
-    transformer = {}
+    transformer = {},
+    uncountableNouns = []
   } = options;
   const mergedTransformer = { ...createTransformer(), ...transformer };
   const schema = await readSchema(input);
@@ -253,6 +260,7 @@ async function generate(userOptions = {}) {
   }
   const apiModules = partitionApiModules(schema, {
     base,
+    uncountableNouns,
     transformer: mergedTransformer,
     validateStatus
   });

package/dist/cli.cjs

@@ -166,7 +166,7 @@ function transformVerb({ method }) {
       return (0, import_rattail2.pascalCase)(method);
   }
 }
-function transformEntity({ path, method, base }) {
+function transformEntity({ path, method, base, uncountableNouns }) {
   path = base ? path.replace(base, "") : path;
   const words = path.split("/").filter(Boolean);
   return words.reduce((entity, word, index) => {
@@ -174,9 +174,9 @@ function transformEntity({ path, method, base }) {
       return entity;
     }
     word = word.replace(/\.([a-z])/g, (_, p) => p.toUpperCase());
-    word = import_pluralize.default.singular((0, import_rattail2.pascalCase)(word));
+    word = uncountableNouns.includes(word) ? word : import_pluralize.default.singular((0, import_rattail2.pascalCase)(word));
     if (method === "get" && index === words.length - 1) {
-      word = import_pluralize.default.plural(word);
+      word = uncountableNouns.includes(word) ? `${word}List` : import_pluralize.default.plural(word);
     }
     return `${entity}${word}`;
   }, "");
@@ -258,10 +258,10 @@ __export(generate_exports, {
   transformPayloads: () => transformPayloads
 });
 function transformPayloads(pathItems, options) {
-  const { transformer, path, base, validateStatus } = options;
+  const { transformer, path, base, uncountableNouns, validateStatus } = options;
   return Object.entries(pathItems).filter(([key]) => SUPPORTED_HTTP_METHODS.includes(key)).reduce((payloads, [method, operation]) => {
     const url = transformer.url({ path, base });
-    const args = { path, base, url, method, operation };
+    const args = { path, base, url, method, uncountableNouns, operation };
     const entity = transformer.entity(args);
     const verb = transformer.verb(args);
     const requestContentType = operation.requestBody ? getRequestBodyContentType(operation.requestBody) : void 0;
@@ -302,7 +302,7 @@ function transformPayloads(pathItems, options) {
   }, []);
 }
 function partitionApiModules(schema, options) {
-  const { base, transformer, validateStatus } = options;
+  const { base, transformer, uncountableNouns, validateStatus } = 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]);
@@ -310,7 +310,13 @@ function partitionApiModules(schema, options) {
     const payloads = paths.reduce((payloads2, path) => {
       const pathItems = schemaPaths[path];
       payloads2.push(
-        ...transformPayloads(pathItems, { ...options, path: base ? base + path : path, transformer, validateStatus })
+        ...transformPayloads(pathItems, {
+          ...options,
+          path: base ? base + path : path,
+          transformer,
+          uncountableNouns,
+          validateStatus
+        })
       );
       return payloads2;
     }, []);
@@ -373,7 +379,8 @@ async function generate(userOptions = {}) {
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
     validateStatus = (status) => status >= 200 && status < 300,
-    transformer = {}
+    transformer = {},
+    uncountableNouns = []
   } = options;
   const mergedTransformer = { ...createTransformer(), ...transformer };
   const schema = await readSchema(input);
@@ -383,6 +390,7 @@ async function generate(userOptions = {}) {
   }
   const apiModules = partitionApiModules(schema, {
     base,
+    uncountableNouns,
     transformer: mergedTransformer,
     validateStatus
   });

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-5XSJIKDA.js");
+  const { generate } = await import("./generate-FIMT7H74.js");
   return generate();
 });
 program.parse();

package/dist/{generate-5XSJIKDA.js → generate-FIMT7H74.js}

@@ -4,7 +4,7 @@ import {
   partitionApiModules,
   renderApiModules,
   transformPayloads
-} from "./chunk-DJ4JEQRW.js";
+} from "./chunk-MMYZTUXF.js";
 import "./chunk-KEUG7T6E.js";
 export {
   generate,

package/dist/index.cjs

@@ -85,7 +85,7 @@ function transformVerb({ method }) {
       return (0, import_rattail.pascalCase)(method);
   }
 }
-function transformEntity({ path, method, base }) {
+function transformEntity({ path, method, base, uncountableNouns }) {
   path = base ? path.replace(base, "") : path;
   const words = path.split("/").filter(Boolean);
   return words.reduce((entity, word, index) => {
@@ -93,9 +93,9 @@ function transformEntity({ path, method, base }) {
       return entity;
     }
     word = word.replace(/\.([a-z])/g, (_, p) => p.toUpperCase());
-    word = import_pluralize.default.singular((0, import_rattail.pascalCase)(word));
+    word = uncountableNouns.includes(word) ? word : import_pluralize.default.singular((0, import_rattail.pascalCase)(word));
     if (method === "get" && index === words.length - 1) {
-      word = import_pluralize.default.plural(word);
+      word = uncountableNouns.includes(word) ? `${word}List` : import_pluralize.default.plural(word);
     }
     return `${entity}${word}`;
   }, "");
@@ -293,10 +293,10 @@ function getResponseMetadataItems(operation, validateStatus) {
 
 // src/generate.ts
 function transformPayloads(pathItems, options) {
-  const { transformer, path, base, validateStatus } = options;
+  const { transformer, path, base, uncountableNouns, validateStatus } = options;
   return Object.entries(pathItems).filter(([key]) => SUPPORTED_HTTP_METHODS.includes(key)).reduce((payloads, [method, operation]) => {
     const url = transformer.url({ path, base });
-    const args = { path, base, url, method, operation };
+    const args = { path, base, url, method, uncountableNouns, operation };
     const entity = transformer.entity(args);
     const verb = transformer.verb(args);
     const requestContentType = operation.requestBody ? getRequestBodyContentType(operation.requestBody) : void 0;
@@ -337,7 +337,7 @@ function transformPayloads(pathItems, options) {
   }, []);
 }
 function partitionApiModules(schema, options) {
-  const { base, transformer, validateStatus } = options;
+  const { base, transformer, uncountableNouns, validateStatus } = 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]);
@@ -345,7 +345,13 @@ function partitionApiModules(schema, options) {
     const payloads = paths.reduce((payloads2, path) => {
       const pathItems = schemaPaths[path];
       payloads2.push(
-        ...transformPayloads(pathItems, { ...options, path: base ? base + path : path, transformer, validateStatus })
+        ...transformPayloads(pathItems, {
+          ...options,
+          path: base ? base + path : path,
+          transformer,
+          uncountableNouns,
+          validateStatus
+        })
       );
       return payloads2;
     }, []);
@@ -408,7 +414,8 @@ async function generate(userOptions = {}) {
     output = "./src/apis/generated",
     typesFilename = "_types.ts",
     validateStatus = (status) => status >= 200 && status < 300,
-    transformer = {}
+    transformer = {},
+    uncountableNouns = []
   } = options;
   const mergedTransformer = { ...createTransformer(), ...transformer };
   const schema = await readSchema(input);
@@ -418,6 +425,7 @@ async function generate(userOptions = {}) {
   }
   const apiModules = partitionApiModules(schema, {
     base,
+    uncountableNouns,
     transformer: mergedTransformer,
     validateStatus
   });

package/dist/index.d.cts

@@ -58,6 +58,7 @@ type TransformerBaseArgs = {
     url: string;
     method: string;
     operation: OperationObject;
+    uncountableNouns: string[];
 };
 declare function transformModuleName({ name }: {
     name: string;
@@ -69,7 +70,7 @@ declare function transformUrl({ path, base }: {
 declare function transformVerb({ method }: {
     method: string;
 }): string;
-declare function transformEntity({ path, method, base }: TransformerBaseArgs): string;
+declare function transformEntity({ path, method, base, uncountableNouns }: TransformerBaseArgs): string;
 declare function transformFn({ verb, entity }: {
     verb: string;
     entity: string;
@@ -267,16 +268,22 @@ interface GenerateOptions {
      * The transformer api options, used to override the default transformation rules.
      */
     transformer?: Partial<Transformer>;
+    /**
+     * Certain uncountable nouns that do not change from singular to plural
+     */
+    uncountableNouns?: string[];
 }
 declare function transformPayloads(pathItems: Record<string, OperationObject>, options: {
     path: string;
     transformer: Transformer;
     base: string | undefined;
+    uncountableNouns: string[];
     validateStatus: (status: number) => boolean;
 }): ApiModulePayload[];
 declare function partitionApiModules(schema: OpenAPI3, options: {
     transformer: Transformer;
     base: string | undefined;
+    uncountableNouns: string[];
     validateStatus: (status: number) => boolean;
 }): ApiModule[];
 declare function renderApiModules(apiModules: ApiModule[], options: {

package/dist/index.d.ts

@@ -58,6 +58,7 @@ type TransformerBaseArgs = {
     url: string;
     method: string;
     operation: OperationObject;
+    uncountableNouns: string[];
 };
 declare function transformModuleName({ name }: {
     name: string;
@@ -69,7 +70,7 @@ declare function transformUrl({ path, base }: {
 declare function transformVerb({ method }: {
     method: string;
 }): string;
-declare function transformEntity({ path, method, base }: TransformerBaseArgs): string;
+declare function transformEntity({ path, method, base, uncountableNouns }: TransformerBaseArgs): string;
 declare function transformFn({ verb, entity }: {
     verb: string;
     entity: string;
@@ -267,16 +268,22 @@ interface GenerateOptions {
      * The transformer api options, used to override the default transformation rules.
      */
     transformer?: Partial<Transformer>;
+    /**
+     * Certain uncountable nouns that do not change from singular to plural
+     */
+    uncountableNouns?: string[];
 }
 declare function transformPayloads(pathItems: Record<string, OperationObject>, options: {
     path: string;
     transformer: Transformer;
     base: string | undefined;
+    uncountableNouns: string[];
     validateStatus: (status: number) => boolean;
 }): ApiModulePayload[];
 declare function partitionApiModules(schema: OpenAPI3, options: {
     transformer: Transformer;
     base: string | undefined;
+    uncountableNouns: string[];
     validateStatus: (status: number) => boolean;
 }): ApiModule[];
 declare function renderApiModules(apiModules: ApiModule[], options: {

package/dist/index.js

@@ -20,7 +20,7 @@ import {
   transformTypeValue,
   transformUrl,
   transformVerb
-} from "./chunk-DJ4JEQRW.js";
+} from "./chunk-MMYZTUXF.js";
 import {
   createStatusCodesByStrategy,
   findObjectKey,

package/package.json

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