dsh-typert-protocol/packages/typert/protocol官方

175.3kStar19.0kFork0Issue752Watching

提供Remote服务装饰器、调用描述符、编码器和协议映射等编译器无关的声明,供业务包、Typert工件、Host Gateway和Client API共享使用

语言
TypeScript
License
MIT
分支
master
ai-agentscordisdshdsh-plugin

安装

$ dsh plugin --profile web add npm:@deepseek-ai/dsh-typert-protocol

在终端中运行以上命令,通过 dsh CLI 安装此插件。可在右上角切换 Profile。 第一次用 dsh?看这篇新手教程

English | 中文

Compiler-independent declarations shared by business packages, generated Typert artifacts, the Host Gateway, and Client API. This package owns the Remote Service base, decorators, explicit binding fallback, merge-extensible protocol maps, invocation descriptors, codecs, and provider contracts; it does not run TypeScript analysis or register a concrete Cordis service.

Remote declarations

  • @Remote marks a public instance method for direct invocation on its registered Cordis Service.
  • @RemoteScope(key) marks a method whose receiver is selected from a merge-declared scoped Context kind.
  • TypertRemoteService binds the Cordis key passed to super(ctx, serviceKey, options?) to the same default wire namespace.
  • bindTypertRemote(this, serviceKey, options?) provides the same visible, frozen binding for a Service that cannot inherit from TypertRemoteService.
  • remoteMethods(service) returns a detached declaration-order snapshot used by the Gateway's SRC fallback.

A Host method opts into cooperative cancellation by declaring signal: AbortSignal as its final parameter. InvocationDescriptor.cancellation records that reserved injection point; the signal never becomes a JSON parameter or lookup field. SRC recognizes the final parameter name, while strict generation also verifies the global AbortSignal type.

Decorator initializers retain markers in a module-private WeakMap keyed by the Service prototype. They do not add constructor symbols, prototype properties, parameter metadata, or runtime reflection fields. A TypertRemoteService exposes the same public readonly typertRemote binding that the explicit helper returns.

Typert protocol

Business packages extend TypertLookupMap and TypertContextMap to associate Host objects or scoped Contexts with their wire identities. Generated artifacts extend TypertRemoteMap, TypertRemoteScopeMap, and TypertRemoteNamespaceMap so Client imports expose only selected Remote methods. InvocationDescriptor is the shared runtime form consumed by the registry, Gateway, and Client Remote.

The Host assembly extends TypertRemoteEventSelection with the Host events it forwards to consumers, which narrows the ctx.remote.$on key face; TypertForwardableEvent states the shapes a one-way delivery can carry at all, excluding Scope-bound and answered events. TypertClientRemote carries both roles of that surface: consumers subscribe through $on, and the Client half owning the host frame sink hands frames over through $dispatch.

Lookup and Context packages own both sides of their contract: declaration merging supplies the static association, while runtime providers register identity resolution with ctx.typert. A lookup or Host Context provider supplies the stable declaration and default resolver, while Host composition may separately configure a synchronous or asynchronous resolver; policy rejections may use TypertLookupFailure to carry a failure value owned by the boundary adapter. Strict codecs carry generated schemas; src-json codecs identify the weaker source-launch path.

Model Experience

None, as this protocol package declares application reflection and registers nothing model-facing.

KV Cache effect

No direct effect.

Known Limitations and Deferred Work

  • Decorator markers contain only the method name and direct or Context invocation mode. Parameter, result, lookup, and schema reflection require the Typert build pipeline.
  • Remote decorators accept only public, non-static instance methods with string names. SRC execution cannot represent overloaded, destructured, defaulted, or rest-parameter signatures.