@naeemo/capnp 0.2.0 → 0.4.0

package/README.md

@@ -1,8 +1,11 @@
 # Cap'n Proto TypeScript
 
+[![npm version](https://img.shields.io/npm/v/@naeemo/capnp.svg)](https://www.npmjs.com/package/@naeemo/capnp)
+[![Documentation](https://img.shields.io/badge/docs-website-blue.svg)](https://naeemo.github.io/capnp/)
+
 A pure TypeScript implementation of Cap'n Proto, featuring zero-copy deserialization and full interoperability with the official C++ implementation.
 
-[中文文档](./README.zh.md)
+[📖 Documentation](https://naeemo.github.io/capnp/) | [中文文档](./README.zh.md)
 
 ## Features
 
@@ -11,6 +14,7 @@ A pure TypeScript implementation of Cap'n Proto, featuring zero-copy deserializa
 - ✅ **Official Compatible** - Tested against official C++ implementation
 - 📦 **Schema Code Generation** - Generate TypeScript types from `.capnp` schemas
 - ⚡ **High Performance** - 1.4μs serialization, 0.6μs deserialization for simple structs
+- 🌐 **Full RPC Stack** - Complete Level 0-4 RPC implementation (Bootstrap, Pipelining, SturdyRefs, 3-way Handoff, Join)
 
 ## Installation
 
@@ -92,6 +96,7 @@ See [PERFORMANCE.md](./PERFORMANCE.md) for detailed benchmarks.
 
 ## Documentation
 
+- [📖 Documentation Website](https://naeemo.github.io/capnp/)
 - [API Documentation](./docs/API.md)
 - [Performance Report](./PERFORMANCE.md)
 - [Test Coverage](./TEST_COVERAGE.md)

package/README.zh.md

@@ -1,8 +1,11 @@
 # Cap'n Proto TypeScript
 
+[![npm version](https://img.shields.io/npm/v/@naeemo/capnp.svg)](https://www.npmjs.com/package/@naeemo/capnp)
+[![Documentation](https://img.shields.io/badge/docs-website-blue.svg)](https://naeemo.github.io/capnp/)
+
 纯 TypeScript 实现的 Cap'n Proto，支持零拷贝反序列化，与官方 C++ 实现完全兼容。
 
-[English Documentation](./README.md)
+[📖 文档网站](https://naeemo.github.io/capnp/) | [English Documentation](./README.md)
 
 ## 特性
 
@@ -72,6 +75,7 @@ npx capnp-ts-codegen schema.capnp -o types.ts -r ../my-runtime
 
 ## 文档
 
+- [📖 文档网站](https://naeemo.github.io/capnp/)
 - [API 文档](./docs/API.md)
 - [性能报告](./PERFORMANCE.md)
 - [测试覆盖](./TEST_COVERAGE.md)

package/dist/codegen/cli-v3.js

@@ -138,6 +138,12 @@ var Segment = class Segment {
 		return new Uint8Array(this.buffer, 0, this._size);
 	}
 	/**
+	* 获取底层 ArrayBuffer
+	*/
+	getArrayBuffer() {
+		return this.buffer;
+	}
+	/**
 	* 获取字数量
 	*/
 	get wordCount() {
@@ -586,6 +592,22 @@ var NodeReader = class {
 		}
 		return enumerants;
 	}
+	get interfaceMethods() {
+		const listReader = this.reader.getList(3, ElementSize.INLINE_COMPOSITE, {
+			dataWords: 5,
+			pointerCount: 2
+		});
+		if (!listReader) return [];
+		const methods = [];
+		for (let i = 0; i < listReader.length; i++) try {
+			const method = new MethodReader(listReader.getStruct(i));
+			if (!method.name && i > 0) break;
+			methods.push(method);
+		} catch (_e) {
+			break;
+		}
+		return methods;
+	}
 	get nestedNodes() {
 		const listReader = this.reader.getList(1, ElementSize.INLINE_COMPOSITE, {
 			dataWords: 1,
@@ -801,6 +823,23 @@ var ValueReader = class {
 		if (this.isBool) return this.boolValue;
 	}
 };
+var MethodReader = class {
+	constructor(reader) {
+		this.reader = reader;
+	}
+	get name() {
+		return this.reader.getText(0);
+	}
+	get codeOrder() {
+		return this.reader.getUint16(0);
+	}
+	get paramStructType() {
+		return this.reader.getUint64(8);
+	}
+	get resultStructType() {
+		return this.reader.getUint64(16);
+	}
+};
 var EnumerantReader = class {
 	constructor(reader) {
 		this.reader = reader;
@@ -924,10 +963,21 @@ function generateFile(fileId, allNodes, options) {
 	lines.push("  return view.getFloat64(0, true);");
 	lines.push("}");
 	lines.push("");
-	const fileNodes = allNodes.filter((n) => n.scopeId === fileId);
+	let filePrefix = "";
+	try {
+		filePrefix = allNodes.find((n) => n.id === fileId)?.displayName || "";
+	} catch (_e) {}
+	const fileNodes = allNodes.filter((n) => {
+		try {
+			if (n.scopeId === fileId) return true;
+			if (n.scopeId === 0n && filePrefix && n.displayName.startsWith(`${filePrefix}:`)) return n.displayName.substring(filePrefix.length + 1).includes("$");
+		} catch (_e) {}
+		return false;
+	});
 	for (const node of fileNodes) {
 		if (node.isStruct) lines.push(generateStruct(node, allNodes));
 		else if (node.isEnum) lines.push(generateEnum(node));
+		else if (node.isInterface) lines.push(generateInterface(node, allNodes));
 		lines.push("");
 	}
 	return lines.join("\n");
@@ -938,7 +988,28 @@ function generateFile(fileId, allNodes, options) {
 function generateStruct(node, allNodes) {
 	const lines = [];
 	const structName = getShortName(node.displayName);
-	const { unionGroups, regularFields, groupFields } = analyzeFields(node, allNodes);
+	let unionGroups = [];
+	let regularFields = [];
+	let groupFields = [];
+	try {
+		const analysis = analyzeFields(node, allNodes);
+		unionGroups = analysis.unionGroups;
+		regularFields = analysis.regularFields;
+		groupFields = analysis.groupFields;
+	} catch (_e) {
+		lines.push(`export interface ${structName} {`);
+		lines.push("  // Note: Could not parse struct fields");
+		lines.push("}");
+		lines.push("");
+		lines.push(`export class ${structName}Reader {`);
+		lines.push("  constructor(private reader: StructReader) {}");
+		lines.push("}");
+		lines.push("");
+		lines.push(`export class ${structName}Builder {`);
+		lines.push("  constructor(private builder: StructBuilder) {}");
+		lines.push("}");
+		return lines.join("\n");
+	}
 	lines.push(`export interface ${structName} {`);
 	for (const field of regularFields) {
 		if (!field.isSlot) continue;
@@ -947,11 +1018,13 @@ function generateStruct(node, allNodes) {
 	}
 	for (const { field: groupField, groupNode } of groupFields) {
 		const groupName = groupField.name;
-		for (const field of groupNode.structFields) {
-			if (!field.isSlot) continue;
-			const tsType = getTypeScriptType(field.slotType, allNodes);
-			lines.push(`  ${groupName}${capitalize(field.name)}: ${tsType};`);
-		}
+		try {
+			for (const field of groupNode.structFields) {
+				if (!field.isSlot) continue;
+				const tsType = getTypeScriptType(field.slotType, allNodes);
+				lines.push(`  ${groupName}${capitalize(field.name)}: ${tsType};`);
+			}
+		} catch (_e) {}
 	}
 	for (const [groupIndex, group] of unionGroups.entries()) {
 		const unionName = group.fields.length > 0 ? `${capitalize(group.fields[0].name)}Union` : `Union${groupIndex}`;
@@ -970,12 +1043,14 @@ function generateStruct(node, allNodes) {
 	}
 	for (const { field: groupField, groupNode } of groupFields) {
 		const groupName = groupField.name;
-		for (const field of groupNode.structFields) {
-			if (!field.isSlot) continue;
-			const getter = generateGroupFieldGetter(field, groupName);
-			lines.push(`  ${getter}`);
-			lines.push("");
-		}
+		try {
+			for (const field of groupNode.structFields) {
+				if (!field.isSlot) continue;
+				const getter = generateGroupFieldGetter(field, groupName);
+				lines.push(`  ${getter}`);
+				lines.push("");
+			}
+		} catch (_e) {}
 	}
 	for (const [groupIndex, group] of unionGroups.entries()) {
 		const unionName = group.fields.length > 0 ? `${capitalize(group.fields[0].name)}Union` : `Union${groupIndex}`;
@@ -1016,12 +1091,14 @@ function generateStruct(node, allNodes) {
 	}
 	for (const { field: groupField, groupNode } of groupFields) {
 		const groupName = groupField.name;
-		for (const field of groupNode.structFields) {
-			if (!field.isSlot) continue;
-			const setter = generateGroupFieldSetter(field, groupName);
-			lines.push(`  ${setter}`);
-			lines.push("");
-		}
+		try {
+			for (const field of groupNode.structFields) {
+				if (!field.isSlot) continue;
+				const setter = generateGroupFieldSetter(field, groupName);
+				lines.push(`  ${setter}`);
+				lines.push("");
+			}
+		} catch (_e) {}
 	}
 	for (const [groupIndex, group] of unionGroups.entries()) {
 		const unionName = group.fields.length > 0 ? `${capitalize(group.fields[0].name)}Union` : `Union${groupIndex}`;
@@ -1512,11 +1589,114 @@ function getTypeScriptType(type, allNodes) {
 /**
 * 从 displayName 获取短名称
 * 例如 "test-schema.capnp:Person" -> "Person"
+* 处理 auto-generated 名称如 "Calculator.evaluate$Params" -> "EvaluateParams"
 */
 function getShortName(displayName) {
+	if (!displayName) return "Unknown";
 	const colonIndex = displayName.lastIndexOf(":");
-	if (colonIndex >= 0) return displayName.substring(colonIndex + 1);
-	return displayName.replace(/\.capnp$/, "").replace(/[^a-zA-Z0-9_]/g, "_");
+	let name = colonIndex >= 0 ? displayName.substring(colonIndex + 1) : displayName;
+	if (name.includes(".")) {
+		const parts = name.split(".");
+		if (parts.length === 2 && parts[1].includes("$")) {
+			const methodPart = parts[1];
+			const dollarIndex = methodPart.indexOf("$");
+			if (dollarIndex > 0) {
+				const methodName = methodPart.substring(0, dollarIndex);
+				const suffix = methodPart.substring(dollarIndex + 1);
+				name = capitalize(methodName) + suffix;
+			} else name = capitalize(parts[1]);
+		} else name = parts[parts.length - 1];
+	}
+	name = name.replace(/[^a-zA-Z0-9_]/g, "_");
+	return name;
+}
+/**
+* 生成 Interface 的 TypeScript 代码
+* 包括：Method Constants、Client Class、Server Interface、Server Stub
+*/
+function generateInterface(node, allNodes) {
+	const lines = [];
+	const interfaceName = getShortName(node.displayName);
+	const methods = node.interfaceMethods;
+	if (methods.length === 0) return `// Interface ${interfaceName} has no methods`;
+	lines.push(`// ${interfaceName} Method IDs`);
+	lines.push(`export const ${interfaceName}InterfaceId = ${node.id}n;`);
+	lines.push(`export const ${interfaceName}MethodIds = {`);
+	for (const method of methods) lines.push(`  ${method.name}: ${method.codeOrder},`);
+	lines.push("} as const;");
+	lines.push("");
+	lines.push(`// ${interfaceName} Server Interface`);
+	lines.push(`export interface ${interfaceName}Server {`);
+	for (const method of methods) {
+		const paramType = getTypeNameById(method.paramStructType, allNodes, "unknown");
+		const resultType = getTypeNameById(method.resultStructType, allNodes, "unknown");
+		lines.push(`  ${method.name}(context: CallContext<${paramType}Reader, ${resultType}Builder>): Promise<void> | void;`);
+	}
+	lines.push("}");
+	lines.push("");
+	lines.push(`// ${interfaceName} Server Stub`);
+	lines.push(`export class ${interfaceName}Stub {`);
+	lines.push(`  private server: ${interfaceName}Server;`);
+	lines.push("");
+	lines.push(`  constructor(server: ${interfaceName}Server) {`);
+	lines.push("    this.server = server;");
+	lines.push("  }");
+	lines.push("");
+	lines.push(`  static readonly interfaceId = ${node.id}n;`);
+	lines.push("");
+	lines.push("  /** Dispatch a method call to the appropriate handler */");
+	lines.push("  async dispatch(methodId: number, context: CallContext<unknown, unknown>): Promise<void> {");
+	lines.push("    switch (methodId) {");
+	for (const method of methods) {
+		const paramType = getTypeNameById(method.paramStructType, allNodes, "unknown");
+		const resultType = getTypeNameById(method.resultStructType, allNodes, "unknown");
+		lines.push(`      case ${interfaceName}MethodIds.${method.name}:`);
+		lines.push(`        return this.server.${method.name}(context as CallContext<${paramType}Reader, ${resultType}Builder>);`);
+	}
+	lines.push("      default:");
+	lines.push("        throw new Error(`Unknown method ID: ${methodId}`);");
+	lines.push("    }");
+	lines.push("  }");
+	lines.push("");
+	lines.push("  /** Check if a method ID is valid */");
+	lines.push("  isValidMethod(methodId: number): boolean {");
+	lines.push("    return [");
+	for (const method of methods) lines.push(`      ${interfaceName}MethodIds.${method.name},`);
+	lines.push("    ].includes(methodId);");
+	lines.push("  }");
+	lines.push("}");
+	lines.push("");
+	lines.push(`// ${interfaceName} Client Class`);
+	lines.push(`export class ${interfaceName}Client extends BaseCapabilityClient {`);
+	lines.push(`  static readonly interfaceId = ${node.id}n;`);
+	lines.push("");
+	for (const method of methods) {
+		const paramType = getTypeNameById(method.paramStructType, allNodes, "unknown");
+		const resultType = getTypeNameById(method.resultStructType, allNodes, "unknown");
+		lines.push("  /**");
+		lines.push(`   * ${method.name}`);
+		lines.push(`   * @param params - ${paramType}`);
+		lines.push(`   * @returns PipelineClient<${resultType}Reader>`);
+		lines.push("   */");
+		lines.push(`  ${method.name}(params: ${paramType}Builder): PipelineClient<${resultType}Reader> {`);
+		lines.push("    return this._call(");
+		lines.push(`      ${interfaceName}Client.interfaceId,`);
+		lines.push(`      ${interfaceName}MethodIds.${method.name},`);
+		lines.push("      params");
+		lines.push(`    ) as PipelineClient<${resultType}Reader>;`);
+		lines.push("  }");
+		lines.push("");
+	}
+	lines.push("}");
+	return lines.join("\n");
+}
+/**
+* 根据类型 ID 获取类型名称
+*/
+function getTypeNameById(id, allNodes, fallback) {
+	const node = allNodes.find((n) => n.id === id);
+	if (!node) return fallback;
+	return getShortName(node.displayName);
 }
 
 //#endregion
@@ -1586,11 +1766,11 @@ Features:
   - Group
   - Default values (XOR encoding)
   - Multi-segment messages
+  - Interface (RPC client/server generation)
 
 Not yet supported:
-  - Interface
   - Const
-  - RPC
+  - Advanced RPC features (Level 2-4)
 `);
 	process.exit(0);
 }
@@ -1630,9 +1810,10 @@ async function main() {
 		});
 		console.error("Reading binary schema...");
 		const buffer = readFileSync(binFile);
-		const arrayBuffer = buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength);
+		const arrayBuffer = new Uint8Array(buffer.byteLength);
+		arrayBuffer.set(new Uint8Array(buffer.buffer, buffer.byteOffset, buffer.byteLength));
 		console.error("Generating TypeScript code...");
-		const files = generateFromRequest(CodeGeneratorRequestReader.fromBuffer(arrayBuffer), { runtimeImportPath: values.runtimePath || "@naeemo/capnp" });
+		const files = generateFromRequest(CodeGeneratorRequestReader.fromBuffer(arrayBuffer.buffer), { runtimeImportPath: values.runtimePath || "@naeemo/capnp" });
 		if (values.outDir) {
 			mkdirSync(values.outDir, { recursive: true });
 			for (const [filename, code] of files) {