api-farmer 0.1.4 → 0.1.5

package/README.md

@@ -83,6 +83,7 @@ export default defineConfig({
     verb() {},
     url() {},
     entity() {},
+    name() {},
     fn() {},
     comment() {},
     type() {},
@@ -97,6 +98,25 @@ export default defineConfig({
 })
 ```
 
+#### `name` Transformer
+
+The `name` transformer is a convenience option that derives both `fn` and `type` from a single function. When set, `fn` is the return value, and `type` is automatically capitalized from `fn`. This avoids writing duplicate logic for `fn` and `type`.
+
+```ts
+export default defineConfig({
+  transformer: {
+    name({ verb, entity }) {
+      return `api${verb}${entity}`
+      // fn   -> apiGetUsers
+      // type -> ApiGetUsers
+    },
+  },
+})
+```
+
+> [!NOTE]
+> If `name` is set, `fn` and `type` transformers will be ignored.
+
 ### Configuration Options
 
 ```ts
@@ -163,6 +183,11 @@ export interface Config {
    *  @see https://openapi-ts.dev/node
    */
   openapiTsOptions?: OpenAPITSOptions
+  /**
+   * Whether to exclude deprecated API endpoints.
+   * @default false
+   */
+  excludeDeprecated?: boolean
 }
 ```
 

package/dist/cli.mjs

@@ -5,7 +5,7 @@ import { Command } from "commander";
 const program = new Command();
 program.version(getCliVersion());
 program.action(async () => {
-	const { generate } = await import("./generate-C4lplT2F.mjs").then((n) => n.r);
+	const { generate } = await import("./generate-SAL57AwU.mjs").then((n) => n.i);
 	return generate();
 });
 program.parse();

package/dist/{generate-C4lplT2F.mjs → generate-SAL57AwU.mjs}

@@ -1,6 +1,6 @@
 import { a as getResponseMetadataItems, c as isRequiredRequestBody, d as readTemplateFile, f as CWD, i as getRequestBodyContentType, l as readSchema, p as SUPPORTED_HTTP_METHODS } from "./utils-DachPo4u.mjs";
 import pluralize from "pluralize";
-import { camelize, groupBy, isArray, merge, pascalCase } from "rattail";
+import { camelize, groupBy, isArray, merge, pascalCase, upperFirst } from "rattail";
 import { resolve } from "path";
 import ejs from "ejs";
 import fse from "fs-extra";
@@ -112,6 +112,7 @@ async function getConfig() {
 //#endregion
 //#region src/generate.ts
 var generate_exports = /* @__PURE__ */ __exportAll({
+	detectCollisions: () => detectCollisions,
 	generate: () => generate,
 	generateTypes: () => generateTypes,
 	partitionApiModules: () => partitionApiModules,
@@ -143,16 +144,13 @@ function transformPayloads(pathItems, options) {
 		});
 		const requestContentType = operation.requestBody ? getRequestBodyContentType(operation.requestBody) : void 0;
 		const responseMetadataItems = getResponseMetadataItems(operation, validateStatus);
-		const fn = transformer.fn({
+		const nameArgs = {
 			...args,
 			verb,
 			entity
-		});
-		const type = transformer.type({
-			...args,
-			verb,
-			entity
-		});
+		};
+		const fn = transformer.name ? transformer.name(nameArgs) : transformer.fn(nameArgs);
+		const type = transformer.name ? upperFirst(fn) : transformer.type(nameArgs);
 		const typeValue = transformer.typeValue({
 			...args,
 			verb,
@@ -286,6 +284,22 @@ async function generateTypes(schema, output, typesFilename, openapiTsOptions) {
 	fse.outputFileSync(typesFilepath, contents);
 	logger.success(`Generated ${typesFilepath}`);
 }
+function detectCollisions(apiModules) {
+	const fnMap = /* @__PURE__ */ new Map();
+	for (const apiModule of apiModules) for (const payload of apiModule.payloads) {
+		const entries = fnMap.get(payload.fn) ?? [];
+		entries.push({
+			module: apiModule.name,
+			url: payload.url,
+			method: payload.method
+		});
+		fnMap.set(payload.fn, entries);
+	}
+	for (const [fn, entries] of fnMap) if (entries.length > 1) {
+		const endpoints = entries.map((e) => `[${e.method.toUpperCase()}] ${e.url}`).join(", ");
+		logger.warn(`API name collision: "${fn}" is generated by multiple endpoints: ${endpoints}. Consider using the "transformer" option to customize API naming.`);
+	}
+}
 async function generate(userOptions = {}) {
 	const { base, ts = true, typesOnly = false, overrides = true, preset = "axle", input = "./schema.json", output = "./src/apis/generated", typesFilename = "_types.ts", clean = true, validateStatus = (status) => status >= 200 && status < 300, transformer = {}, uncountableNouns = [], openapiTsOptions = {}, excludeDeprecated = false } = merge(await getConfig(), userOptions);
 	const mergedTransformer = {
@@ -300,13 +314,15 @@ async function generate(userOptions = {}) {
 	logger.info("Generating API modules...");
 	if (openapiTsOptions.excludeDeprecated === void 0) openapiTsOptions.excludeDeprecated = excludeDeprecated;
 	if (ts) await generateTypes(schema, output, typesFilename, openapiTsOptions);
-	await renderApiModules(partitionApiModules(schema, {
+	const apiModules = partitionApiModules(schema, {
 		base,
 		uncountableNouns,
 		transformer: mergedTransformer,
 		validateStatus,
 		excludeDeprecated
-	}), {
+	});
+	detectCollisions(apiModules);
+	await renderApiModules(apiModules, {
 		output,
 		typesFilename,
 		ts,
@@ -317,4 +333,4 @@ async function generate(userOptions = {}) {
 	logger.success("Done");
 }
 //#endregion
-export { transformVerb as C, transformUrl as S, transformTypeRequestBody as _, renderApiModules as a, transformTypeResponseBodyValue as b, getConfig as c, transformEntity as d, transformFn as f, transformTypeQueryValue as g, transformTypeQuery as h, partitionApiModules as i, createTransformer as l, transformType as m, generateTypes as n, transformPayloads as o, transformModuleName as p, generate_exports as r, defineConfig as s, generate as t, transformComment as u, transformTypeRequestBodyValue as v, transformTypeValue as x, transformTypeResponseBody as y };
+export { transformUrl as C, transformTypeValue as S, transformTypeQueryValue as _, partitionApiModules as a, transformTypeResponseBody as b, defineConfig as c, transformComment as d, transformEntity as f, transformTypeQuery as g, transformType as h, generate_exports as i, getConfig as l, transformModuleName as m, generate as n, renderApiModules as o, transformFn as p, generateTypes as r, transformPayloads as s, detectCollisions as t, createTransformer as u, transformTypeRequestBody as v, transformVerb as w, transformTypeResponseBodyValue as x, transformTypeRequestBodyValue as y };

package/dist/index.d.mts

@@ -171,6 +171,7 @@ interface Transformer {
   url: typeof transformUrl;
   comment: typeof transformComment;
   entity: typeof transformEntity;
+  name?: typeof transformFn;
   fn: typeof transformFn;
   type: typeof transformType;
   typeValue: typeof transformTypeValue;
@@ -367,6 +368,7 @@ declare function renderApiModules(apiModules: ApiModule[], options: {
   preset: Preset;
 }): Promise<unknown[]>;
 declare function generateTypes(schema: OpenAPI3, output: string, typesFilename: string, openapiTsOptions: OpenAPITSOptions): Promise<void>;
+declare function detectCollisions(apiModules: ApiModule[]): void;
 declare function generate(userOptions?: GenerateOptions): Promise<void>;
 //#endregion
 //#region src/config.d.ts
@@ -374,4 +376,4 @@ type Config = GenerateOptions;
 declare function defineConfig(config: Config): GenerateOptions;
 declare function getConfig(): Promise<Config>;
 //#endregion
-export { ApiModule, ApiModulePayload, ApiModuleTemplateData, Config, GenerateOptions, Preset, ResponseMetadataItem, StatusCodeStrategy, StatusCodes, Transformer, TransformerBaseArgs, createStatusCodesByStrategy, createTransformer, defineConfig, findObjectKey, generate, generateTypes, getCliVersion, getConfig, getRequestBodyContentType, getResponseMetadataItems, getSchemaNode, isRemoteSchema, isRequiredRequestBody, partitionApiModules, pluralize, readSchema, readSchemaContent, readTemplateFile, renderApiModules, transformComment, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };
+export { ApiModule, ApiModulePayload, ApiModuleTemplateData, Config, GenerateOptions, Preset, ResponseMetadataItem, StatusCodeStrategy, StatusCodes, Transformer, TransformerBaseArgs, createStatusCodesByStrategy, createTransformer, defineConfig, detectCollisions, findObjectKey, generate, generateTypes, getCliVersion, getConfig, getRequestBodyContentType, getResponseMetadataItems, getSchemaNode, isRemoteSchema, isRequiredRequestBody, partitionApiModules, pluralize, readSchema, readSchemaContent, readTemplateFile, renderApiModules, transformComment, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { C as transformVerb, S as transformUrl, _ as transformTypeRequestBody, a as renderApiModules, b as transformTypeResponseBodyValue, c as getConfig, d as transformEntity, f as transformFn, g as transformTypeQueryValue, h as transformTypeQuery, i as partitionApiModules, l as createTransformer, m as transformType, n as generateTypes, o as transformPayloads, p as transformModuleName, s as defineConfig, t as generate, u as transformComment, v as transformTypeRequestBodyValue, x as transformTypeValue, y as transformTypeResponseBody } from "./generate-C4lplT2F.mjs";
+import { C as transformUrl, S as transformTypeValue, _ as transformTypeQueryValue, a as partitionApiModules, b as transformTypeResponseBody, c as defineConfig, d as transformComment, f as transformEntity, g as transformTypeQuery, h as transformType, l as getConfig, m as transformModuleName, n as generate, o as renderApiModules, p as transformFn, r as generateTypes, s as transformPayloads, t as detectCollisions, u as createTransformer, v as transformTypeRequestBody, w as transformVerb, x as transformTypeResponseBodyValue, y as transformTypeRequestBodyValue } from "./generate-SAL57AwU.mjs";
 import { a as getResponseMetadataItems, c as isRequiredRequestBody, d as readTemplateFile, i as getRequestBodyContentType, l as readSchema, n as findObjectKey, o as getSchemaNode, r as getCliVersion, s as isRemoteSchema, t as createStatusCodesByStrategy, u as readSchemaContent } from "./utils-DachPo4u.mjs";
 import pluralize from "pluralize";
-export { createStatusCodesByStrategy, createTransformer, defineConfig, findObjectKey, generate, generateTypes, getCliVersion, getConfig, getRequestBodyContentType, getResponseMetadataItems, getSchemaNode, isRemoteSchema, isRequiredRequestBody, partitionApiModules, pluralize, readSchema, readSchemaContent, readTemplateFile, renderApiModules, transformComment, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };
+export { createStatusCodesByStrategy, createTransformer, defineConfig, detectCollisions, findObjectKey, generate, generateTypes, getCliVersion, getConfig, getRequestBodyContentType, getResponseMetadataItems, getSchemaNode, isRemoteSchema, isRequiredRequestBody, partitionApiModules, pluralize, readSchema, readSchemaContent, readTemplateFile, renderApiModules, transformComment, transformEntity, transformFn, transformModuleName, transformPayloads, transformType, transformTypeQuery, transformTypeQueryValue, transformTypeRequestBody, transformTypeRequestBodyValue, transformTypeResponseBody, transformTypeResponseBodyValue, transformTypeValue, transformUrl, transformVerb };

package/package.json

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