api-farmer 0.1.3 → 0.1.4

package/dist/index.d.mts

@@ -0,0 +1,377 @@
+import pluralize from "pluralize";
+import { OpenAPI3, OpenAPITSOptions, OperationObject, ReferenceObject, RequestBodyObject } from "openapi-typescript";
+
+//#region src/utils.d.ts
+type Preset = 'axle' | 'axios';
+type StatusCodeStrategy = 'strict' | 'loose' | 'smart';
+interface StatusCodes {
+  get?: number;
+  post?: number;
+  put?: number;
+  delete?: number;
+  patch?: number;
+  options?: number;
+  head?: number;
+}
+declare function createStatusCodesByStrategy(strategy: StatusCodeStrategy): {
+  get: number;
+  post: number;
+  put: number;
+  delete: number;
+  patch: number;
+  options: number;
+  head: number;
+} | {
+  get: number;
+  post: number;
+  put: number;
+  delete: number;
+  patch: number;
+  options: number;
+  head: number;
+} | {
+  get: number;
+  post: number;
+  put: number;
+  delete: number;
+  patch: number;
+  options: number;
+  head: number;
+};
+declare function readSchema(input: string): Promise<OpenAPI3>;
+declare function getSchemaNode(schema: OpenAPI3, path: string): any;
+declare function readSchemaContent(input: string): Promise<string>;
+declare function isRemoteSchema(path: string): boolean;
+declare function readTemplateFile(preset?: Preset): string;
+declare function getCliVersion(): any;
+declare function isRequiredRequestBody(value: RequestBodyObject | ReferenceObject): boolean;
+declare function findObjectKey(object: Record<string, any>, targetKeys: string[]): string | undefined;
+declare function getRequestBodyContentType(value: RequestBodyObject | ReferenceObject): string | undefined;
+type ResponseMetadataItem = {
+  status: number;
+  responseContentType: string;
+};
+declare function getResponseMetadataItems(operation: OperationObject, validateStatus: (status: number) => boolean): ResponseMetadataItem[];
+//#endregion
+//#region src/transformer.d.ts
+type TransformerBaseArgs = {
+  path: string;
+  fullPath: string;
+  base: string | undefined;
+  url: string;
+  method: string;
+  operation: OperationObject;
+  uncountableNouns: string[];
+};
+declare function transformModuleName({
+  name
+}: {
+  name: string;
+}): string;
+declare function transformUrl({
+  path
+}: {
+  path: string;
+  fullPath: string;
+  base: string | undefined;
+}): string;
+declare function transformComment({
+  summary,
+  description,
+  path,
+  method
+}: {
+  summary?: string;
+  description?: string;
+  path: string;
+  method: string;
+} & TransformerBaseArgs): string;
+declare function transformVerb({
+  method
+}: {
+  method: string;
+}): string;
+declare function transformEntity({
+  path,
+  method,
+  uncountableNouns
+}: TransformerBaseArgs): string;
+declare function transformFn({
+  verb,
+  entity
+}: {
+  verb: string;
+  entity: string;
+} & TransformerBaseArgs): string;
+declare function transformType({
+  verb,
+  entity
+}: {
+  verb: string;
+  entity: string;
+} & TransformerBaseArgs): string;
+declare function transformTypeValue({
+  fullPath,
+  method
+}: {
+  verb: string;
+  entity: string;
+} & TransformerBaseArgs): string;
+declare function transformTypeQuery({
+  type
+}: {
+  type: string;
+  verb: string;
+  entity: string;
+} & TransformerBaseArgs): string;
+declare function transformTypeQueryValue({
+  type
+}: {
+  type: string;
+  verb: string;
+  entity: string;
+} & TransformerBaseArgs): string;
+declare function transformTypeRequestBody({
+  type
+}: {
+  type: string;
+  verb: string;
+  entity: string;
+} & TransformerBaseArgs): string;
+declare function transformTypeRequestBodyValue({
+  type,
+  required,
+  requestContentType
+}: {
+  type: string;
+  verb: string;
+  entity: string;
+  required: boolean;
+  requestContentType: string;
+} & TransformerBaseArgs): string;
+declare function transformTypeResponseBody({
+  type
+}: {
+  type: string;
+  verb: string;
+  entity: string;
+} & TransformerBaseArgs): string;
+declare function transformTypeResponseBodyValue({
+  type,
+  responseMetadataItems
+}: {
+  type: string;
+  verb: string;
+  entity: string;
+  responseMetadataItems: ResponseMetadataItem[];
+} & TransformerBaseArgs): string;
+interface Transformer {
+  moduleName: typeof transformModuleName;
+  verb: typeof transformVerb;
+  url: typeof transformUrl;
+  comment: typeof transformComment;
+  entity: typeof transformEntity;
+  fn: typeof transformFn;
+  type: typeof transformType;
+  typeValue: typeof transformTypeValue;
+  typeQuery: typeof transformTypeQuery;
+  typeQueryValue: typeof transformTypeQueryValue;
+  typeRequestBody: typeof transformTypeRequestBody;
+  typeRequestBodyValue: typeof transformTypeRequestBodyValue;
+  typeResponseBody: typeof transformTypeResponseBody;
+  typeResponseBodyValue: typeof transformTypeResponseBodyValue;
+}
+declare function createTransformer(): Transformer;
+//#endregion
+//#region src/generate.d.ts
+interface ApiModuleTemplateData {
+  /**
+   * API module metadata
+   */
+  apiModule: ApiModule;
+  /**
+   * The name of the generated api ts type aggregation file
+   */
+  typesFilename: string;
+  /**
+   * Whether to generate ts code
+   */
+  ts: boolean;
+  /**
+   * Whether to generate only types
+   */
+  typesOnly: boolean;
+}
+interface ApiModule {
+  /**
+   * The name of the API module
+   */
+  name: string;
+  /**
+   * API module payloads
+   */
+  payloads: ApiModulePayload[];
+}
+interface ApiModulePayload {
+  /**
+   * The comment of the API endpoint, including summary, description, URL, and method.
+   */
+  comment: string;
+  /**
+   * The name of the API function/dispatcher, such as apiGetUsers, apiCreatePost, apiUpdateComment, etc.
+   */
+  fn: string;
+  /**
+   * The URL of the API endpoint, such as /users, /posts, /comments, etc.
+   */
+  url: string;
+  /**
+   * The HTTP method of the API endpoint, such as get, post, put, delete, etc.
+   */
+  method: string;
+  /**
+   * The HTTP verb of the API endpoint, such as Get, Create, Update, Delete, etc.
+   */
+  verb: string;
+  /**
+   * The entity name of the API endpoint, such as User, Comment, Post, etc.
+   */
+  entity: string;
+  /**
+   * The request content type of the API endpoint, such as 'application/json', 'application/x-www-form-urlencoded'.
+   */
+  requestContentType?: string;
+  /**
+   * The type name of the API endpoint, such as ApiGetUsers, ApiCreatePost, ApiUpdateComment, etc.
+   */
+  type: string;
+  /**
+   * The value of the type of the API endpoint, such as paths['/users']['get'], paths['/posts']['post'], paths['/comments']['put'], etc.
+   */
+  typeValue: string;
+  /**
+   * The type name of the query parameters of the API endpoint, such as ApiGetUsersQuery, ApiCreatePostQuery, ApiUpdateCommentQuery, etc.
+   */
+  typeQuery: string;
+  /**
+   * The value of the type of the query parameters of the API endpoint, such as ApiGetUsersQuery['parameters']['query'], ApiCreatePostQuery['parameters']['query'], ApiUpdateCommentQuery['parameters']['query'], etc.
+   */
+  typeQueryValue: string;
+  /**
+   * The type name of the request body of the API endpoint, such as ApiGetUsersRequestBody, ApiCreatePostRequestBody, ApiUpdateCommentRequestBody, etc.
+   */
+  typeRequestBody: string;
+  /**
+   * The value of the type of the request body of the API endpoint, such as ApiGetUsersRequestBody['requestBody']['content']['application/json'], ApiCreatePostRequestBody['requestBody']['content']['application/json'], ApiUpdateCommentRequestBody['requestBody']['content']['application/json'], etc.
+   */
+  typeRequestBodyValue: string;
+  /**
+   * The type name of the response body of the API endpoint, such as ApiGetUsersResponseBody, ApiCreatePostResponseBody, ApiUpdateCommentResponseBody, etc.
+   */
+  typeResponseBody: string;
+  /**
+   * The value of the type of the response body of the API endpoint, such as ApiGetUsersResponseBody['responses']['200']['content']['application/json'], ApiCreatePostResponseBody['responses']['201']['content']['application/json'], ApiUpdateCommentResponseBody['responses']['200']['content']['application/json'], etc.
+   */
+  typeResponseBodyValue: string;
+}
+interface GenerateOptions {
+  /**
+   * The path to the OpenAPI/Swagger schema file.
+   * @default './schema.json'
+   */
+  input?: string;
+  /**
+   * The path to the output directory.
+   * @default './src/apis/generated'
+   */
+  output?: string;
+  /**
+   * The base path of the API endpoints.
+   */
+  base?: string;
+  /**
+   * The filename of the generated openapi types file.
+   * @default '_types.ts'
+   */
+  typesFilename?: string;
+  /**
+   * Whether to generate TypeScript code.
+   * @default true
+   */
+  ts?: boolean;
+  /**
+   * Whether to generate only types.
+   * @default false
+   */
+  typesOnly?: boolean;
+  /**
+   * Whether to override the existing files, or an array of filenames to override.
+   * @default true
+   */
+  overrides?: boolean | string[];
+  /**
+   * The preset ejs template to use.
+   * @default 'axle'
+   */
+  preset?: Preset;
+  /**
+   * Defines which return status codes will be typed
+   * @default (status) => status >= 200 && status < 300
+   */
+  validateStatus?: (status: number) => boolean;
+  /**
+   * 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[];
+  /**
+   * 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;
+  fullPath: string;
+  base: string | undefined;
+  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;
+  typesFilename: string;
+  ts: boolean;
+  typesOnly: boolean;
+  overrides: boolean | string[];
+  preset: Preset;
+}): Promise<unknown[]>;
+declare function generateTypes(schema: OpenAPI3, output: string, typesFilename: string, openapiTsOptions: OpenAPITSOptions): Promise<void>;
+declare function generate(userOptions?: GenerateOptions): Promise<void>;
+//#endregion
+//#region src/config.d.ts
+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 };

package/dist/index.mjs

@@ -0,0 +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 { 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 };

package/dist/utils-DachPo4u.mjs

@@ -0,0 +1,119 @@
+import { tryParseJSON } from "rattail";
+import { resolve } from "path";
+import fse from "fs-extra";
+import { logger } from "rslog";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { createAxle } from "rattail/axle";
+import swagger from "swagger2openapi";
+import yaml from "yaml";
+//#region node_modules/.pnpm/@voidzero-dev+vite-plus-core@0.1.16_@types+node@22.19.17_esbuild@0.25.12_jiti@2.6.1_tsx_c6a4ec143665127b4e0039cf3983defb/node_modules/@voidzero-dev/vite-plus-core/dist/esm-shims.js
+const getFilename = () => fileURLToPath(import.meta.url);
+const getDirname = () => path.dirname(getFilename());
+const __dirname = /* @__PURE__ */ getDirname();
+//#endregion
+//#region src/constants.ts
+const CWD = process.cwd();
+const CUSTOM_TEMPLATE_FILE = resolve(CWD, `./api-farmer.ejs`);
+const CLI_PACKAGE_JSON = resolve(__dirname, "../package.json");
+const SUPPORTED_HTTP_METHODS = [
+	"get",
+	"post",
+	"put",
+	"delete",
+	"patch",
+	"options",
+	"head"
+];
+//#endregion
+//#region src/utils.ts
+function createStatusCodesByStrategy(strategy) {
+	return {
+		strict: {
+			get: 200,
+			post: 201,
+			put: 200,
+			delete: 204,
+			patch: 200,
+			options: 204,
+			head: 200
+		},
+		loose: {
+			get: 200,
+			post: 200,
+			put: 200,
+			delete: 200,
+			patch: 200,
+			options: 200,
+			head: 200
+		},
+		smart: {
+			get: 200,
+			post: 200,
+			put: 200,
+			delete: 200,
+			patch: 200,
+			options: 200,
+			head: 200
+		}
+	}[strategy];
+}
+async function readSchema(input) {
+	const content = await readSchemaContent(input);
+	const jsonSchema = tryParseJSON(content);
+	const swaggerOrOpenapiSchema = jsonSchema ? jsonSchema : yaml.parse(content);
+	return swaggerOrOpenapiSchema.swagger ? (await swagger.convert(swaggerOrOpenapiSchema, {})).openapi : swaggerOrOpenapiSchema;
+}
+function getSchemaNode(schema, path) {
+	return path.split("/").reduce((node, path) => node[path], schema);
+}
+async function readSchemaContent(input) {
+	if (isRemoteSchema(input)) try {
+		logger.info("Fetching remote schema...");
+		const { data } = await createAxle().get(input);
+		return JSON.stringify(data);
+	} catch {
+		throw new Error("Failed to fetch remote schema");
+	}
+	const path = resolve(CWD, input);
+	return fse.readFileSync(path, "utf-8");
+}
+function isRemoteSchema(path) {
+	return path.startsWith("http://") || path.startsWith("https://");
+}
+function readTemplateFile(preset = "axle") {
+	if (fse.existsSync(CUSTOM_TEMPLATE_FILE)) return fse.readFileSync(CUSTOM_TEMPLATE_FILE, "utf-8");
+	return fse.readFileSync(resolve(__dirname, `../templates/${preset}.ejs`), "utf-8");
+}
+function getCliVersion() {
+	return fse.readJsonSync(CLI_PACKAGE_JSON).version;
+}
+function isRequiredRequestBody(value) {
+	return "required" in value && value.required === true;
+}
+function findObjectKey(object, targetKeys) {
+	return Object.keys(object).find((key) => targetKeys.includes(key));
+}
+function getRequestBodyContentType(value) {
+	if (!("content" in value)) return "";
+	return findObjectKey(value.content, [
+		"application/json",
+		"application/x-www-form-urlencoded",
+		"multipart/form-data"
+	]);
+}
+function getResponseMetadataItems(operation, validateStatus) {
+	const responses = operation.responses ?? {};
+	return Object.keys(responses).sort((a, b) => Number(a) - Number(b)).filter((key) => validateStatus(Number(key))).map(Number).map((status) => {
+		return {
+			status,
+			responseContentType: findObjectKey((operation.responses?.[status])?.content ?? {}, [
+				"application/json",
+				"application/octet-stream",
+				"*/*"
+			])
+		};
+	}).filter((result) => result.responseContentType);
+}
+//#endregion
+export { getResponseMetadataItems as a, isRequiredRequestBody as c, readTemplateFile as d, CWD as f, getRequestBodyContentType as i, readSchema as l, findObjectKey as n, getSchemaNode as o, SUPPORTED_HTTP_METHODS as p, getCliVersion as r, isRemoteSchema as s, createStatusCodesByStrategy as t, readSchemaContent as u };

package/package.json

@@ -1,95 +1,77 @@
 {
   "name": "api-farmer",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "API module generation tool based on Openapi3/Swagger2.",
   "keywords": [
-    "cli",
     "api generator",
+    "cli",
+    "json schema",
     "openapi",
-    "swagger",
-    "json schema"
+    "swagger"
   ],
   "bugs": {
     "url": "https://github.com/varletjs/api-farmer/issues"
   },
+  "license": "MIT",
+  "author": "haoziqaq <357229046@qq.com>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/varletjs/api-farmer.git"
   },
-  "license": "MIT",
-  "author": "haoziqaq <357229046@qq.com>",
-  "sideEffects": false,
-  "type": "module",
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    }
-  },
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
   "bin": {
-    "af": "dist/cli.js"
+    "af": "dist/cli.mjs"
   },
   "files": [
     "dist",
     "templates"
   ],
-  "simple-git-hooks": {
-    "pre-commit": "pnpm exec nano-staged --allow-empty",
-    "commit-msg": "pnpm exec vr commit-lint -p $1"
-  },
-  "nano-staged": {
-    "*.{md}": "prettier --write",
-    "*.{ts}": [
-      "prettier --write",
-      "eslint --fix"
-    ]
+  "type": "module",
+  "sideEffects": false,
+  "main": "dist/index.mjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
   },
   "dependencies": {
     "@types/pluralize": "^0.0.33",
-    "@varlet/axle": "^0.10.3",
     "commander": "^13.0.0",
     "ejs": "^3.1.10",
     "fs-extra": "^11.2.0",
     "openapi-typescript": "^7.5.2",
     "pluralize": "^8.0.0",
     "prettier": "^3.4.2",
-    "rattail": "^1.0.19",
+    "rattail": "^1.8.3",
     "rslog": "^1.2.3",
     "swagger2openapi": "^7.0.8",
     "unconfig": "^0.6.0",
     "yaml": "^2.7.0"
   },
   "devDependencies": {
-    "@configurajs/eslint": "^0.1.2",
-    "@configurajs/prettier": "^0.1.4",
     "@types/ejs": "^3.1.5",
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^22.8.1",
     "@types/swagger2openapi": "^7.0.4",
     "@varlet/release": "^0.4.1",
-    "eslint": "^9.17.0",
-    "nano-staged": "0.8.0",
     "rimraf": "^6.0.1",
-    "simple-git-hooks": "^2.11.1",
-    "tsup": "8.3.5",
-    "typescript": "5.3.3"
+    "typescript": "5.3.3",
+    "vite-plus": "0.1.16"
   },
   "peerDependencies": {
     "typescript": "^5.3.3"
   },
   "engines": {
-    "pnpm": ">=9.0"
+    "pnpm": ">=10.0.0"
   },
   "scripts": {
-    "build": "tsup src/index.ts src/cli.ts --format esm,cjs --dts --clean --shims",
+    "build": "vp pack",
     "clean": "rimraf node_modules dist",
-    "dev": "tsup src/index.ts src/cli.ts --format esm,cjs --watch --dts --shims",
-    "format": "prettier --write .",
+    "format": "vp fmt",
     "gen": "rimraf ./fixtures/axios/src/apis/generated ./fixtures/axle/src/apis/generated && pnpm --dir ./fixtures/axios gen & pnpm --dir ./fixtures/axle gen",
-    "lint": "eslint . --fix",
+    "lint": "vp lint --fix",
     "release": "pnpm build && vr release"
   }
 }