@ godspideai/ cognate- proto
生成了Cognate所制作的 Cononical protobuf schemas (the cognate.v1 软件包) 库夫 财务报告和审定财务报表 原生出产。 。 。 .
何时使用此软件包 : 您需要键入 RuntimeService 服务描述符和生成的用于Cognate电线格式的信息和enum类——用于自定义传输,另一个堆栈中的网关,或消息级工具. 简单的调用 Cognate 运行时间的应用程序 @godspeedai/cognate-client 或协议适配器;它们以这些绑定物为基础,为您处理电线细节.
安装
bun add @godspeedai/cognate-proto
要求数 阿宝 >= 1.4.0. 软件包取决于 @bufbuild/protobuf;通过 HTTP 调用运行时间需要连接传输(@connectrpc/connect附加时 @connectrpc/connect-web 或便利出口 @godspeedai/cognate-protocol-connect-bun) (中文(简体) ).
出口的东西
切入点再出口所有从卡通里产生的东西 cognate/v1 计划 :
- 页:1
RuntimeService服务描述符(运行启动/get/cancel/list、事件流、续作、能力引用、文物、预测、共享状态、远程能力提供); - 信件类型及其计划
Event编号 :EventSchema, (中文(简体) ),Run, (中文(简体) ),Continuation, (中文(简体) ),StateUpdate, (中文(简体) ),RemoteCapabilityOffer, (中文(简体) ),SemanticRef以及家庭其他成员; - 词库
RunStatus, (中文(简体) ),ContinuationStatus, (中文(简体) ),ContinuationAction,以及ResolveOutcome。 。 。 .
快开始
消息是普通的原生取出-es值——从JSON创建,再序列化为 canonical JSON或二进制原生取:
import { fromJson, toJson } from "@bufbuild/protobuf";
import { EventSchema } from "@godspeedai/cognate-proto";
const event = fromJson(EventSchema, {
eventId: "e-1",
streamId: "s-1",
streamSequence: "1", // uint64 fields are strings in canonical JSON
position: "1",
eventType: "run.started",
schemaVersion: 1,
occurredAt: new Date().toISOString(),
recordedAt: new Date().toISOString(),
tenant: "tenant-a",
correlationId: "c-1",
scopeId: "workspace-1",
});
const json = toJson(EventSchema, event); // canonical JSON
const bytes = event.toBinary(); // binary protobuf
要调用一个输入客户端的服务运行时间, 请将服务描述符交给连接传输 :
import { createClient } from "@connectrpc/connect";
import { connectTransport } from "@godspeedai/cognate-protocol-connect-bun";
import { RuntimeService } from "@godspeedai/cognate-proto";
const client = createClient(RuntimeService, connectTransport("http://127.0.0.1:3000"));
const run = await client.getRun({ runId: "<run id>" });
偏爱 @godspeedai/cognate-protocol-connect是因为 createRemoteRuntimeService 当您自己调用运行时间时 : 生成的客户端不会强制 plain JSON google.protobuf.Value 字段( 如运行) input),该适配器在双向执行转换并映射出错误代码.
重新生成
生成的文件( E)src/gen/**)是承诺的,从不手工编辑. 在Cognate寄存器中进行再生, 不在下游: 运行 bun run generate 在此软件包中执行 buf generate 被钉住 protoc-gen-es 插件对屏蔽 proto/ 来源。 已出版软件包的消费者从不运行代码源——他们像其他模块一样导入承诺的输出.
生成是决定性的:两个跑入独立的目录是字节对相和对所承诺的输出的同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同同.
限制
- 生成的
RuntimeService仅声明无源和服务器流方法; 计划没有客户端流或双向方法 . - protobuf-es可以将每个消息序列化为JSON或二进制;选择有线格式是一种传输决定,而不是这个包配置的东西.
- 消息和字段形状只通过这个软件包的新发布来改变,因为没有下游的代码路径.
相关软件包
@godspeedai/cognate-protocol-connect- 运输中立服务器路线和遥控器RuntimeService以这些束缚为基础.@godspeedai/cognate-protocol-connect-bun服务于Bun.serve并且提供接送工具.@godspeedai/cognate-client高级客户端大多数应用应该使用.@godspeedai/cognateSDK伞.
许可证
阿帕奇 - 2.0