patchbay_protocol library
Patchbay 的 protocol / wire implementer 入口（PB-060-02 / DG-060-02）。
内容是生成的 *Wire 类型、catalog capability 与 digest、CLI syntax 词汇、permission
companion 协议、client 侧请求类型，以及 canonical protocol command descriptor。写第三方
transport、复刻 CLI 行为或直接构造 wire 文档时用它。
它同样是自足闭包：canonical descriptor 常量的类型是 PatchbayCommandDescriptor，所以
descriptor / schema 这一组 consumer 类型也在本清单里。本入口与默认 consumer 入口有意
重叠——重叠的是两个闭包都真正需要的类型，不是把默认面整库带过来。同时 import 两个入口
不会冲突。
本 library 不 re-export host 面：PatchbayServiceHost、audit 与 invocation lifecycle
只在 package:patchbay/patchbay_host.dart。
这里的类型跟着 wire 走：字段与 JSON 形态由协议决定，不是给业务代码当 DTO 用的便利类型。 只收仓内与已知接入方真正用到的 wire 类型，不承诺每个 wire 文档都有对应的公共 Dart 类型 （DG-080-03）；wire 契约以 JSON 形态为准。
Classes
- PatchbayBlobChunkWire
-
Strict wire representation of
PatchbayBlobChunkWire. - PatchbayBlobMetadataWire
-
Strict wire representation of
PatchbayBlobMetadataWire. - PatchbayCaptureDiffRequestWire
-
Strict wire representation of
PatchbayCaptureDiffRequestWire. - PatchbayCaptureDiffResultWire
-
Strict wire representation of
PatchbayCaptureDiffResultWire. - PatchbayCaptureRequestWire
-
Strict wire representation of
PatchbayCaptureRequestWire. - PatchbayCaptureResultWire
-
Strict wire representation of
PatchbayCaptureResultWire. - PatchbayCatalogDigest
- A stable content digest of the command surface an App declares.
- PatchbayCliEqualsCondition
- PatchbayCliSyntax
- One CLI spelling derived from a protocol-owned command descriptor.
- PatchbayCommandDescriptor
- Consumer-neutral catalog entry. Business namespaces remain consumer-owned.
- PatchbayCommandDescriptorWire
-
Strict wire representation of
PatchbayCommandDescriptorWire. - PatchbayDestinationDescriptorWire
-
Strict wire representation of
PatchbayDestinationDescriptorWire. - PatchbayExecutionContract
-
Descriptor-owned policy used to interpret a payload's
executionobject. - PatchbayInspectSelectRequestWire
-
Strict wire representation of
PatchbayInspectSelectRequestWire. - PatchbayInspectStateWire
-
Strict wire representation of
PatchbayInspectStateWire. - PatchbayInvocationWire
-
Strict wire representation of
PatchbayInvocationWire. - PatchbayJobEventWire
-
Strict wire representation of
PatchbayJobEventWire. - PatchbayJobSnapshotWire
-
Strict wire representation of
PatchbayJobSnapshotWire. - PatchbayJobWaitResultWire
-
Strict wire representation of
PatchbayJobWaitResultWire. - PatchbayKeepAwakeRequestWire
-
Strict wire representation of
PatchbayKeepAwakeRequestWire. - PatchbayKeepAwakeStateWire
-
Strict wire representation of
PatchbayKeepAwakeStateWire. - PatchbayLogRecordWire
-
Strict wire representation of
PatchbayLogRecordWire. -
Strict wire representation of
PatchbayNavigationCatalogWire. -
Strict wire representation of
PatchbayNavigationCurrentWire. -
Strict wire representation of
PatchbayNavigationResultWire. - PatchbayOutputArtifactProjection
-
The
artifacthalf of a declaration: at most one artifact per command. - PatchbayOutputBriefProjection
-
The
briefhalf of a declaration: a stable id plus a deny-list. - PatchbayOutputProjection
- One command's whole machine-output declaration.
- PatchbayOutputProjectionPath
-
A parsed restricted path:
$followed by one or more.field, where any non-final field may carry[]to traverse the maps of a list. - PatchbayOutputProjectionPathSegment
-
One
.field(optionally[]) step of a restricted projection path. - PatchbayParameterDescriptor
- Machine-readable argument declaration used by both validation and CLI help.
- PatchbayParameterDescriptorWire
-
Strict wire representation of
PatchbayParameterDescriptorWire. - PatchbayPermissionCapabilities
- PatchbayPermissionCapability
- PatchbayPermissionDriverRequest
- PatchbayPermissionDriverResponse
- PatchbayPermissionEvidence
- PatchbayPermissionInterruption
- PatchbayPermissionStatus
- PatchbayRejectionWire
-
Strict wire representation of
PatchbayRejectionWire. - PatchbayResponseSchema
- Accepted and job-terminal payload declarations for one command.
- PatchbayResponseValueSchema
- One recursively declared response value.
- PatchbayRetryPolicy
- Bounded retry contract for one consumer-owned external command.
- PatchbayRevealContainerWire
-
Strict wire representation of
PatchbayRevealContainerWire. - PatchbayRevealRequestWire
-
Strict wire representation of
PatchbayRevealRequestWire. - PatchbayRevealResultWire
-
Strict wire representation of
PatchbayRevealResultWire. - PatchbaySemanticsNodeWire
-
Strict wire representation of
PatchbaySemanticsNodeWire. - PatchbaySemanticsRectWire
-
Strict wire representation of
PatchbaySemanticsRectWire. - PatchbaySemanticsSnapshotWire
-
Strict wire representation of
PatchbaySemanticsSnapshotWire. - PatchbaySnapshotDiffRequest
- A request for the changes since one host-observed snapshot revision.
- PatchbaySnapshotDiffRequestWire
-
Strict wire representation of
PatchbaySnapshotDiffRequestWire. - PatchbaySnapshotRequest
- Validated request for one snapshot field selection, optionally waited on.
- PatchbaySnapshotRequestWire
-
Strict wire representation of
PatchbaySnapshotRequestWire. - PatchbaySnapshotSelection
- One resolution of a PatchbaySnapshotRequest.path against a snapshot.
- PatchbaySnapshotSelectionWire
-
Strict wire representation of
PatchbaySnapshotSelectionWire. - PatchbayUiTargetDescriptorWire
-
Strict wire representation of
PatchbayUiTargetDescriptorWire. - PatchbayUiWaitRequest
- Validated, consumer-neutral request for one bounded Flutter observation.
- PatchbayUiWaitRequestWire
-
Strict wire representation of
PatchbayUiWaitRequestWire. - PatchbayUiWaitResultWire
-
Strict wire representation of
PatchbayUiWaitResultWire.
Enums
- PatchbayAdmissionWire
-
Strict wire representation of
PatchbayAdmissionWire. - PatchbayBlobSourceWire
-
Strict wire representation of
PatchbayBlobSourceWire. - PatchbayCaptureTargetWire
-
Strict wire representation of
PatchbayCaptureTargetWire. - PatchbayCaptureWarningWire
-
Strict wire representation of
PatchbayCaptureWarningWire. - PatchbayCliArtifactDisposition
- PatchbayCliInputMode
- PatchbayCommandMode
- PatchbayCommandModeWire
-
Strict wire representation of
PatchbayCommandModeWire. - PatchbayFactSource
- Closed vocabulary for the strength and origin of a Patchbay fact.
- PatchbayFactSourceWire
-
Strict wire representation of
PatchbayFactSourceWire. - PatchbayFeature
- A protocol capability a host declares on the identity plane.
- PatchbayInspectReleaseWire
-
Strict wire representation of
PatchbayInspectReleaseWire. -
Strict wire representation of
PatchbayInspectUnavailableWire. - PatchbayInteractionModel
- Closed catalog-wire classification distinguishing an explicit consumer automation surface from an action that must still satisfy user-like reachability (DG-060-05, "交互模型进入 catalog").
- PatchbayJobPhaseWire
-
Strict wire representation of
PatchbayJobPhaseWire. - PatchbayJobWaitOutcomeWire
-
Strict wire representation of
PatchbayJobWaitOutcomeWire. - PatchbayKeepAwakeReleaseWire
-
Strict wire representation of
PatchbayKeepAwakeReleaseWire. - PatchbayLogDirectionWire
-
Strict wire representation of
PatchbayLogDirectionWire. - PatchbayLogLevelWire
-
Strict wire representation of
PatchbayLogLevelWire. - PatchbayLogRedactionWire
-
Strict wire representation of
PatchbayLogRedactionWire. -
Strict wire representation of
PatchbayNavigationOperationWire. - PatchbayOutputArtifactEncoding
- How a PatchbayOutputArtifactKind.renderedMember member becomes bytes.
- PatchbayOutputArtifactKind
- Where an artifact's bytes come from. A closed set: a declaration may not name a path, a template, a formatter or a second artifact.
- PatchbayParameterType
- PatchbayParameterTypeWire
-
Strict wire representation of
PatchbayParameterTypeWire. - PatchbayPermissionAction
- PatchbayPermissionDecision
- PatchbayPermissionFactSource
- PatchbayPermissionOperation
- PatchbayPermissionState
- PatchbayPlane
- PatchbayPlaneWire
-
Strict wire representation of
PatchbayPlaneWire. - PatchbayResponseType
- Closed JSON value kinds supported by command response schemas.
- PatchbayRevealDirectionWire
-
Strict wire representation of
PatchbayRevealDirectionWire. - PatchbayRevealReachabilityWire
-
Strict wire representation of
PatchbayRevealReachabilityWire. - PatchbaySensitivePolicyWire
-
Strict wire representation of
PatchbaySensitivePolicyWire. - PatchbaySideEffect
- PatchbaySideEffectWire
-
Strict wire representation of
PatchbaySideEffectWire. - PatchbaySnapshotCondition
- Closed vocabulary of snapshot-domain wait conditions.
- PatchbaySnapshotConditionWire
-
Strict wire representation of
PatchbaySnapshotConditionWire. - PatchbaySnapshotMiss
- Why a path resolved to nothing.
- PatchbaySnapshotMissWire
-
Strict wire representation of
PatchbaySnapshotMissWire. - PatchbayUiTargetKindWire
-
Strict wire representation of
PatchbayUiTargetKindWire. - PatchbayUiWaitCondition
- PatchbayUiWaitConditionWire
-
Strict wire representation of
PatchbayUiWaitConditionWire.
Constants
- patchbayCatalogDigestScopeCommands → const String
- The catalog region PatchbayCatalogDigest.ofCommands covers.
- patchbayDigestAlgorithmSha256 → const String
- The only digest algorithm this protocol version computes.
- patchbayPermissionProtocolMajor → const int
- patchbayPermissionProtocolVersion → const String
Properties
-
patchbayProtocolCliCommandDescriptors
→ List<
PatchbayCommandDescriptor> -
Protocol-owned descriptors currently migrated to generated CLI syntax.
final
- patchbayUiCaptureCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiGestureDragCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiGestureFlingCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiGesturePressHoldCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiGestureTapCommandDescriptor → PatchbayCommandDescriptor
-
tap 是家族里唯一没有
durationMs的成员：down→up 间隔是实现内部常数， 不进 wire（DG-050-08 复核改判）。它的start也因此从"路径起点"退化为 "唯一那个点"，可缺省到目标中心——默认值必须进 descriptor 而不是只写在 实现里，catalog 是调用方唯一读得到的声明面。两处形状开关都带默认值， 既有三条 descriptor 的字节因此一位不变。final - patchbayUiInspectSelectCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiInspectStatusCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiKeepAwakeSetCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiKeepAwakeStatusCommandDescriptor → PatchbayCommandDescriptor
-
final
-
patchbayUiProtocolCliCommandDescriptors
→ List<
PatchbayCommandDescriptor> -
final
- patchbayUiRevealCommandDescriptor → PatchbayCommandDescriptor
-
PB-050-17 / DG-050-10：identifier 锚定的 scroll-to-reveal。
final
- patchbayUiSemanticsActionByIdentifierCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiSemanticsActionCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiSemanticsTapCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiSemanticsTreeCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiTextEnterCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiTextSetCommandDescriptor → PatchbayCommandDescriptor
-
final
- patchbayUiWaitCommandDescriptor → PatchbayCommandDescriptor
-
final
Functions
-
patchbayCanonicalJson(
Object? value) → String -
Encodes
valueas JSON with every object's keys in sorted order. -
patchbayDecodeCatalogOutputProjections(
Map< String, Object?> catalog) → Map<String, PatchbayOutputProjection> -
Decodes every
outputProjectiona catalog document carries, so one malformed declaration fails the catalog as a whole. -
patchbayParameterShape(
Map< String, Object?> arguments) → Map<String, Object?> - Produces a recursively redacted JSON shape without retaining scalar values.
-
patchbayPermissionProtocolMajorOf(
String version) → int