@ubean/codegen 0.1.2 → 0.1.3

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+import { AutoImportOptions } from "@ubean/auto-imports";
+import { ScanResult } from "@ubean/routing";
+//#region src/route-types.d.ts
+interface RouteTypesOptions {
+  outDir: string;
+  fileName?: string;
+}
+declare function generateRouteTypes(result: ScanResult, options: RouteTypesOptions): Promise<string>;
+interface PageTypesOptions {
+  outDir: string;
+  fileName?: string;
+}
+declare function generatePageTypes(result: ScanResult, options: PageTypesOptions): Promise<string>;
+//#endregion
+//#region src/openapi-types.d.ts
+/**
+ * OpenAPI 类型生成
+ *
+ * 从 OpenAPI schema 生成 `paths` 类型声明文件(.ubean/openapi.d.ts),
+ * 供 `createTypedClient<paths>` / `createTypedFlatClient<paths>` / `callTypedInternal<paths>` 消费。
+ *
+ * 底层使用 `openapi-typescript` 编译 schema 为 TypeScript 类型声明。
+ */
+interface GenerateOpenApiTypesOptions {
+  /** 输出目录(如 .ubean) */
+  outDir: string;
+  /** 输出文件名,默认 `openapi.d.ts` */
+  fileName?: string;
+}
+/**
+ * 从 OpenAPI schema 对象生成 paths 类型声明文件。
+ */
+declare function generateOpenApiTypes(schema: unknown, options: GenerateOpenApiTypesOptions): Promise<string>;
+/**
+ * 从 dev server 的 `/_openapi.json` 路由获取 schema 并生成类型声明文件。
+ */
+declare function generateOpenApiTypesFromServer(baseUrl: string, options: GenerateOpenApiTypesOptions): Promise<string>;
+//#endregion
+//#region src/index.d.ts
+interface CodegenOptions extends Omit<AutoImportOptions, 'cwd' | 'srcDir' | 'buildDir'> {
+  cwd: string;
+  srcDir: string;
+  buildDir: string;
+}
+interface CodegenResult {
+  routeTypesPath: string;
+  pageTypesPath: string;
+  autoImportsDtsPath?: string;
+  componentsDtsPath?: string;
+  generated: string[];
+}
+declare function generateTypes(result: ScanResult, options: CodegenOptions): Promise<CodegenResult>;
+//#endregion
+export { CodegenOptions, CodegenResult, type GenerateOpenApiTypesOptions, type PageTypesOptions, type RouteTypesOptions, generateOpenApiTypes, generateOpenApiTypesFromServer, generatePageTypes, generateRouteTypes, generateTypes };

package/dist/index.js

@@ -0,0 +1,176 @@
+import { mkdir, writeFile } from "node:fs/promises";
+import { generateAutoImports } from "@ubean/auto-imports";
+import { join } from "pathe";
+import openapiTS, { astToString } from "openapi-typescript";
+//#region src/route-types.ts
+async function generateRouteTypes(result, options) {
+	const { outDir, fileName = "routes.d.ts" } = options;
+	await mkdir(outDir, { recursive: true });
+	const apiRoutes = result.apiRoutes;
+	const lines = [
+		"// Auto-generated by ubean - do not edit manually",
+		"/* eslint-disable */",
+		"// @ts-nocheck",
+		"",
+		"declare module \"ubean:routes\" {",
+		"  export interface ApiRoute {",
+		"    method: string;",
+		"    path: string;",
+		"    filePath: string;",
+		"    meta?: Record<string, unknown>;",
+		"  }",
+		""
+	];
+	const routeEntries = apiRoutes.map((r) => `    "${r.method?.toUpperCase() || "ALL"} ${r.route}": { filePath: ${JSON.stringify(r.fullPath)} }`);
+	if (routeEntries.length > 0) {
+		lines.push("  export type ApiRouteMap = {");
+		lines.push(routeEntries.join(";\n"));
+		lines.push("  };");
+	} else lines.push("  export type ApiRouteMap = {};");
+	lines.push("");
+	const routePaths = [...new Set(apiRoutes.map((r) => r.route))].sort();
+	if (routePaths.length > 0) {
+		lines.push("  export type ApiRoutePath =");
+		lines.push(routePaths.map((p) => `    | ${JSON.stringify(p)}`).join("\n"));
+		lines.push("  ;");
+	} else lines.push("  export type ApiRoutePath = string;");
+	lines.push("");
+	const routeMethods = [...new Set(apiRoutes.map((r) => r.method?.toUpperCase()).filter(Boolean))].sort();
+	if (routeMethods.length > 0) {
+		lines.push("  export type ApiMethod =");
+		lines.push(routeMethods.map((m) => `    | ${JSON.stringify(m)}`).join("\n"));
+		lines.push("  ;");
+	} else lines.push("  export type ApiMethod = \"GET\" | \"POST\" | \"PUT\" | \"PATCH\" | \"DELETE\" | \"OPTIONS\" | \"HEAD\";");
+	lines.push("");
+	lines.push("  export const routes: ApiRoute[];");
+	lines.push("  export const middlewares: { filePath: string; order: number; global: boolean }[];");
+	lines.push("}");
+	const content = `${lines.join("\n")}\n`;
+	const filePath = join(outDir, fileName);
+	await writeFile(filePath, content, "utf-8");
+	return filePath;
+}
+async function generatePageTypes(result, options) {
+	const { outDir, fileName = "pages.d.ts" } = options;
+	await mkdir(outDir, { recursive: true });
+	const pages = result.pages;
+	const layouts = result.layouts;
+	const lines = [
+		"// Auto-generated by ubean - do not edit manually",
+		"/* eslint-disable */",
+		"// @ts-nocheck",
+		"",
+		"declare module \"ubean:pages\" {",
+		"  export interface PageInfo {",
+		"    name: string;",
+		"    path: string;",
+		"    filePath: string;",
+		"    layout?: string;",
+		"    reuseTarget?: string;",
+		"  }",
+		"",
+		"  export interface LayoutInfo {",
+		"    name: string;",
+		"    filePath: string;",
+		"    isDefault: boolean;",
+		"  }",
+		""
+	];
+	const pageNames = pages.map((p) => JSON.stringify(p.name));
+	if (pageNames.length > 0) {
+		lines.push("  export type RouteName =");
+		lines.push(pageNames.map((n) => `    | ${n}`).join("\n"));
+		lines.push("  ;");
+	} else lines.push("  export type RouteName = string;");
+	lines.push("");
+	const layoutNames = layouts.map((l) => JSON.stringify(l.name));
+	if (layoutNames.length > 0) {
+		lines.push("  export type LayoutName =");
+		lines.push(layoutNames.map((n) => `    | ${n}`).join("\n"));
+		lines.push("  ;");
+	} else lines.push("  export type LayoutName = string;");
+	lines.push("");
+	const pageEntries = pages.map((p) => `    ${JSON.stringify(p.name)}: { name: ${JSON.stringify(p.name)}, path: ${JSON.stringify(p.path)}, filePath: ${JSON.stringify(p.fullPath)}, layout: ${JSON.stringify(p.layout)}, reuseTarget: ${JSON.stringify(p.reuseTarget)} }`);
+	if (pageEntries.length > 0) {
+		lines.push("  export const pages: {");
+		lines.push(pageEntries.join(",\n"));
+		lines.push("  };");
+	} else lines.push("  export const pages: Record<string, PageInfo>;");
+	lines.push("");
+	const layoutEntries = layouts.map((l) => `    ${JSON.stringify(l.name)}: { name: ${JSON.stringify(l.name)}, filePath: ${JSON.stringify(l.fullPath)}, isDefault: ${l.isDefault} }`);
+	if (layoutEntries.length > 0) {
+		lines.push("  export const layouts: {");
+		lines.push(layoutEntries.join(",\n"));
+		lines.push("  };");
+	} else lines.push("  export const layouts: Record<string, LayoutInfo>;");
+	lines.push("}");
+	const content = `${lines.join("\n")}\n`;
+	const filePath = join(outDir, fileName);
+	await writeFile(filePath, content, "utf-8");
+	return filePath;
+}
+//#endregion
+//#region src/openapi-types.ts
+/**
+* OpenAPI 类型生成
+*
+* 从 OpenAPI schema 生成 `paths` 类型声明文件(.ubean/openapi.d.ts),
+* 供 `createTypedClient<paths>` / `createTypedFlatClient<paths>` / `callTypedInternal<paths>` 消费。
+*
+* 底层使用 `openapi-typescript` 编译 schema 为 TypeScript 类型声明。
+*/
+/**
+* 从 OpenAPI schema 对象生成 paths 类型声明文件。
+*/
+async function generateOpenApiTypes(schema, options) {
+	const { outDir, fileName = "openapi.d.ts" } = options;
+	await mkdir(outDir, { recursive: true });
+	const typesContent = astToString(await openapiTS(schema));
+	const content = `${[
+		"// Auto-generated by ubean - do not edit manually",
+		"/* eslint-disable */",
+		"/* @ts-nocheck */",
+		"",
+		""
+	].join("\n") + typesContent}\n`;
+	const filePath = join(outDir, fileName);
+	await writeFile(filePath, content, "utf-8");
+	return filePath;
+}
+/**
+* 从 dev server 的 `/_openapi.json` 路由获取 schema 并生成类型声明文件。
+*/
+async function generateOpenApiTypesFromServer(baseUrl, options) {
+	const url = `${baseUrl.replace(/\/$/, "")}/_openapi.json`;
+	const response = await fetch(url);
+	if (!response.ok) throw new Error(`[openapi-types] Failed to fetch OpenAPI schema from ${url}: ${response.status} ${response.statusText}`);
+	return generateOpenApiTypes(await response.json(), options);
+}
+//#endregion
+//#region src/index.ts
+async function generateTypes(result, options) {
+	const { cwd, srcDir, buildDir, ...autoImportOptions } = options;
+	const outDir = join(cwd, buildDir);
+	await mkdir(outDir, { recursive: true });
+	const generated = [];
+	const routeTypesPath = await generateRouteTypes(result, { outDir });
+	generated.push(routeTypesPath);
+	const pageTypesPath = await generatePageTypes(result, { outDir });
+	generated.push(pageTypesPath);
+	const { autoImportsDtsPath, componentsDtsPath } = await generateAutoImports(result, {
+		cwd,
+		srcDir,
+		buildDir,
+		...autoImportOptions
+	});
+	generated.push(autoImportsDtsPath, componentsDtsPath);
+	return {
+		routeTypesPath,
+		pageTypesPath,
+		autoImportsDtsPath,
+		componentsDtsPath,
+		generated
+	};
+}
+//#endregion
+export { generateOpenApiTypes, generateOpenApiTypesFromServer, generatePageTypes, generateRouteTypes, generateTypes };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ubean/codegen",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Type generation for ubean (generateTypes, routes.d.ts, pages.d.ts, openapi.d.ts)",
   "files": [
     "dist"
@@ -18,8 +18,8 @@
   "dependencies": {
     "openapi-typescript": "^7.13.0",
     "pathe": "^2.0.3",
-    "@ubean/routing": "0.1.2",
-    "@ubean/auto-imports": "0.1.2"
+    "@ubean/auto-imports": "0.1.3",
+    "@ubean/routing": "0.1.3"
   },
   "devDependencies": {
     "@types/node": "^26.1.1",