@dxos/protocols 0.8.4-main.69d29f4 → 0.8.4-main.6fa680abb7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/src/FeedProtocol.d.ts +528 -0
- package/dist/src/FeedProtocol.d.ts.map +1 -0
- package/dist/src/FeedProtocol.js +237 -0
- package/dist/src/FeedProtocol.js.map +1 -0
- package/dist/src/FunctionProtocol.d.ts +2 -2
- package/dist/src/FunctionProtocol.d.ts.map +1 -1
- package/dist/src/buf/proto/gen/dxos/client/queue_pb.d.ts +42 -0
- package/dist/src/buf/proto/gen/dxos/client/queue_pb.d.ts.map +1 -1
- package/dist/src/buf/proto/gen/dxos/client/queue_pb.js +7 -2
- package/dist/src/buf/proto/gen/dxos/client/queue_pb.js.map +1 -1
- package/dist/src/buf/proto/gen/dxos/client/services_pb.d.ts +5 -1
- package/dist/src/buf/proto/gen/dxos/client/services_pb.d.ts.map +1 -1
- package/dist/src/buf/proto/gen/dxos/client/services_pb.js +5 -1
- package/dist/src/buf/proto/gen/dxos/client/services_pb.js.map +1 -1
- package/dist/src/buf/proto/gen/dxos/config_pb.d.ts +0 -4
- package/dist/src/buf/proto/gen/dxos/config_pb.d.ts.map +1 -1
- package/dist/src/buf/proto/gen/dxos/config_pb.js +1 -1
- package/dist/src/buf/proto/gen/dxos/config_pb.js.map +1 -1
- package/dist/src/buf/proto/gen/dxos/google_pb.js +1 -1
- package/dist/src/buf/proto/gen/dxos/tracing_pb.js +1 -1
- package/dist/src/codec.test.js +1 -1
- package/dist/src/edge/EdgeFunctionEnv.d.ts +11 -23
- package/dist/src/edge/EdgeFunctionEnv.d.ts.map +1 -1
- package/dist/src/edge/edge.d.ts +7 -0
- package/dist/src/edge/edge.d.ts.map +1 -1
- package/dist/src/edge/edge.js +9 -0
- package/dist/src/edge/edge.js.map +1 -1
- package/dist/src/edge/errors.d.ts +1 -1
- package/dist/src/edge/errors.js +1 -1
- package/dist/src/edge/index.d.ts +3 -3
- package/dist/src/edge/index.js +3 -3
- package/dist/src/errors/encoding.d.ts +1 -1
- package/dist/src/errors/encoding.js +1 -1
- package/dist/src/errors/errors.d.ts +1 -1
- package/dist/src/errors/errors.js +1 -1
- package/dist/src/errors/errors.test.js +1 -1
- package/dist/src/errors/helpers.d.ts +1 -1
- package/dist/src/errors/index.d.ts +5 -5
- package/dist/src/errors/index.js +5 -5
- package/dist/src/index.d.ts +12 -12
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +11 -12
- package/dist/src/index.js.map +1 -1
- package/dist/src/indexing.test.js +1 -1
- package/dist/src/proto/gen/dxos/client/services.d.ts +998 -973
- package/dist/src/proto/gen/dxos/client/services.d.ts.map +1 -1
- package/dist/src/proto/gen/dxos/client/services.js +95 -94
- package/dist/src/proto/gen/dxos/client/services.js.map +1 -1
- package/dist/src/proto/gen/dxos/config.d.ts +0 -5
- package/dist/src/proto/gen/dxos/config.d.ts.map +1 -1
- package/dist/src/proto/gen/dxos/config.js.map +1 -1
- package/dist/src/proto/gen/dxos/devtools/host.d.ts +31 -31
- package/dist/src/proto/gen/dxos/devtools/host.d.ts.map +1 -1
- package/dist/src/proto/gen/google/protobuf.d.ts +326 -40
- package/dist/src/proto/gen/google/protobuf.d.ts.map +1 -1
- package/dist/src/proto/gen/google/protobuf.js +127 -1
- package/dist/src/proto/gen/google/protobuf.js.map +1 -1
- package/dist/src/proto/gen/index.d.ts +25 -0
- package/dist/src/proto/gen/index.d.ts.map +1 -1
- package/dist/src/proto/gen/index.js +1 -1
- package/dist/src/proto/gen/index.js.map +1 -1
- package/dist/src/proto/index.d.ts +2 -2
- package/dist/src/proto/index.js +1 -1
- package/dist/src/proto/types.d.ts +1 -1
- package/dist/src/types.d.ts +2 -2
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +14 -14
- package/src/FeedProtocol.ts +320 -0
- package/src/FunctionProtocol.ts +2 -4
- package/src/buf/proto/gen/dxos/agent/dashboard_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/agent/echo-proxy_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/agent/epoch_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/agent/functions_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/bot_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/client/invitation_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/client/logging_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/client/queue_pb.ts +51 -2
- package/src/buf/proto/gen/dxos/client/services_pb.ts +7 -2
- package/src/buf/proto/gen/dxos/config_pb.ts +2 -7
- package/src/buf/proto/gen/dxos/devtools/diagnostics_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/devtools/host_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/devtools/swarm_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/blob_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/feed_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/filter_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/indexing_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/metadata_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/model/document_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/model/messenger_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/model/text_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/object_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/query_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/service_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/snapshot_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/echo/timeframe_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/edge/calls_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/edge/messenger_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/edge/signal_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/error_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/field_options_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/google_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/gravity_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/halo/credentials/auth_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/halo/credentials/greet_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/halo/credentials/identity_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/halo/credentials_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/halo/invitations_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/halo/keyring_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/halo/keys_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/halo/signed_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/iframe_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/keys_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/bridge_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/broadcast_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/messaging_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/muxer_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/presence_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/protocol_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/replicator_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/signal_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/swarm_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/teleport/admission-discovery_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/teleport/auth_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/teleport/automerge_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/teleport/blobsync_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/teleport/control_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/teleport/gossip_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/teleport/notarization_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/mesh/teleport/replicator_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/registry_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/rpc_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/service/agentmanager_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/service/publisher_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/service/supervisor_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/service/tunnel_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/tracing_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/type_pb.ts +1 -1
- package/src/buf/proto/gen/dxos/value_pb.ts +1 -1
- package/src/buf/proto/gen/example/testing/data_pb.ts +1 -1
- package/src/buf/proto/gen/example/testing/rpc_pb.ts +1 -1
- package/src/codec.test.ts +1 -1
- package/src/edge/EdgeFunctionEnv.ts +20 -26
- package/src/edge/edge.ts +9 -0
- package/src/edge/errors.ts +1 -1
- package/src/edge/index.ts +3 -3
- package/src/errors/encoding.ts +2 -2
- package/src/errors/errors.test.ts +1 -1
- package/src/errors/errors.ts +2 -2
- package/src/errors/helpers.ts +1 -1
- package/src/errors/index.ts +5 -5
- package/src/index.ts +12 -14
- package/src/indexing.test.ts +1 -1
- package/src/proto/dxos/client/queue.proto +11 -0
- package/src/proto/dxos/client/services.proto +1 -0
- package/src/proto/dxos/config.proto +1 -3
- package/src/proto/gen/dxos/client/services.ts +998 -973
- package/src/proto/gen/dxos/config.ts +0 -5
- package/src/proto/gen/dxos/devtools/host.ts +31 -31
- package/src/proto/gen/google/protobuf.ts +326 -40
- package/src/proto/gen/index.ts +26 -1
- package/src/proto/index.ts +2 -2
- package/src/proto/types.ts +1 -1
- package/src/types.ts +2 -2
- package/dist/src/queue.d.ts +0 -3
- package/dist/src/queue.d.ts.map +0 -1
- package/dist/src/queue.js +0 -5
- package/dist/src/queue.js.map +0 -1
- package/src/queue.ts +0 -14
package/README.md
CHANGED
|
@@ -0,0 +1,528 @@
|
|
|
1
|
+
export { type QueueService, type QueueQuery, type QueueQueryResult as QueryResult, type QueryQueueRequest, type InsertIntoQueueRequest, type DeleteFromQueueRequest, type SyncQueueRequest, } from './proto/gen/dxos/client/services.js';
|
|
2
|
+
export declare const KEY_QUEUE_POSITION = "org.dxos.key.queue-position";
|
|
3
|
+
import * as Schema from 'effect/Schema';
|
|
4
|
+
import { SpaceId } from '@dxos/keys';
|
|
5
|
+
/**
|
|
6
|
+
* Opaque pagination cursor for feed queries.
|
|
7
|
+
*/
|
|
8
|
+
export declare const FeedCursor: Schema.brand<typeof Schema.String, "@dxos/feed/FeedCursor">;
|
|
9
|
+
export type FeedCursor = Schema.Schema.Type<typeof FeedCursor>;
|
|
10
|
+
/**
|
|
11
|
+
* Replicated queue block payload and ordering metadata.
|
|
12
|
+
*/
|
|
13
|
+
export declare const Block: Schema.Struct<{
|
|
14
|
+
/**
|
|
15
|
+
* Appears on blocks returned from query.
|
|
16
|
+
*/
|
|
17
|
+
feedId: Schema.UndefinedOr<typeof Schema.String>;
|
|
18
|
+
/**
|
|
19
|
+
* Actor that produced this block.
|
|
20
|
+
*/
|
|
21
|
+
actorId: typeof Schema.String;
|
|
22
|
+
/**
|
|
23
|
+
* Per-feed monotonic sequence assigned by the actor.
|
|
24
|
+
*/
|
|
25
|
+
sequence: typeof Schema.Number;
|
|
26
|
+
/**
|
|
27
|
+
* Actor of the immediate predecessor block, if any.
|
|
28
|
+
*/
|
|
29
|
+
prevActorId: Schema.NullOr<typeof Schema.String>;
|
|
30
|
+
/**
|
|
31
|
+
* Sequence of the immediate predecessor block, if any.
|
|
32
|
+
*/
|
|
33
|
+
prevSequence: Schema.NullOr<typeof Schema.Number>;
|
|
34
|
+
/**
|
|
35
|
+
* Globally ordered position assigned by a position authority.
|
|
36
|
+
* Unlike `sequence` (per-feed causal order), this enables merged incremental reads across feeds.
|
|
37
|
+
*/
|
|
38
|
+
position: Schema.NullOr<typeof Schema.Number>;
|
|
39
|
+
/**
|
|
40
|
+
* Milliseconds since Unix epoch when the block was created.
|
|
41
|
+
*/
|
|
42
|
+
timestamp: typeof Schema.Number;
|
|
43
|
+
/**
|
|
44
|
+
* Serialized application payload.
|
|
45
|
+
*/
|
|
46
|
+
data: typeof Schema.Uint8Array;
|
|
47
|
+
/**
|
|
48
|
+
* Local insertion ID.
|
|
49
|
+
* Not replicated.
|
|
50
|
+
*/
|
|
51
|
+
insertionId: Schema.optional<typeof Schema.Number>;
|
|
52
|
+
}>;
|
|
53
|
+
export interface Block extends Schema.Schema.Type<typeof Block> {
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Query parameters for retrieving blocks from one namespace in one space.
|
|
57
|
+
*/
|
|
58
|
+
export declare const QueryRequest: Schema.Struct<{
|
|
59
|
+
/**
|
|
60
|
+
* Optional request correlation identifier.
|
|
61
|
+
*/
|
|
62
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
63
|
+
/**
|
|
64
|
+
* Target space identifier.
|
|
65
|
+
*/
|
|
66
|
+
spaceId: Schema.Schema<SpaceId, string, never> & {
|
|
67
|
+
byteLength: number;
|
|
68
|
+
encode: (value: Uint8Array) => SpaceId;
|
|
69
|
+
decode: (value: SpaceId) => Uint8Array;
|
|
70
|
+
isValid: (value: unknown) => value is SpaceId;
|
|
71
|
+
make: (value: string) => SpaceId;
|
|
72
|
+
random: () => SpaceId;
|
|
73
|
+
};
|
|
74
|
+
/**
|
|
75
|
+
* Feed namespace to query.
|
|
76
|
+
*/
|
|
77
|
+
feedNamespace: typeof Schema.String;
|
|
78
|
+
query: Schema.optional<Schema.Union<[Schema.Struct<{
|
|
79
|
+
/**
|
|
80
|
+
* Explicit list of feed IDs to read from.
|
|
81
|
+
*/
|
|
82
|
+
feedIds: Schema.Array$<typeof Schema.String>;
|
|
83
|
+
}>, Schema.Struct<{
|
|
84
|
+
/**
|
|
85
|
+
* Existing subscription to resolve feed IDs from.
|
|
86
|
+
*/
|
|
87
|
+
subscriptionId: typeof Schema.String;
|
|
88
|
+
}>]>>;
|
|
89
|
+
/**
|
|
90
|
+
* Get changes following this cursor (exclusive).
|
|
91
|
+
*
|
|
92
|
+
* Must not be used with `position`.
|
|
93
|
+
*/
|
|
94
|
+
cursor: Schema.optional<Schema.brand<typeof Schema.String, "@dxos/feed/FeedCursor">>;
|
|
95
|
+
/**
|
|
96
|
+
* Get changes following this position.
|
|
97
|
+
* Returned blocks have strictly greater position than this.
|
|
98
|
+
*
|
|
99
|
+
* Must not be used with `cursor`.
|
|
100
|
+
*/
|
|
101
|
+
position: Schema.optional<typeof Schema.Number>;
|
|
102
|
+
/**
|
|
103
|
+
* Only return blocks that are not positioned.
|
|
104
|
+
*
|
|
105
|
+
* Must not be used with `cursor` or `position`.
|
|
106
|
+
*/
|
|
107
|
+
unpositionedOnly: Schema.optional<typeof Schema.Boolean>;
|
|
108
|
+
/**
|
|
109
|
+
* Maximum number of blocks to return.
|
|
110
|
+
*/
|
|
111
|
+
limit: Schema.optional<typeof Schema.Number>;
|
|
112
|
+
}>;
|
|
113
|
+
export interface QueryRequest extends Schema.Schema.Type<typeof QueryRequest> {
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* Result payload for a query operation.
|
|
117
|
+
*/
|
|
118
|
+
export declare const QueryResponse: Schema.Struct<{
|
|
119
|
+
/**
|
|
120
|
+
* Echoed request correlation identifier.
|
|
121
|
+
*/
|
|
122
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
123
|
+
/**
|
|
124
|
+
* Cursor to continue reading from this result boundary.
|
|
125
|
+
*/
|
|
126
|
+
nextCursor: Schema.brand<typeof Schema.String, "@dxos/feed/FeedCursor">;
|
|
127
|
+
/**
|
|
128
|
+
* Indicates whether more matching blocks are available.
|
|
129
|
+
*/
|
|
130
|
+
hasMore: typeof Schema.Boolean;
|
|
131
|
+
/**
|
|
132
|
+
* Returned blocks for the current page.
|
|
133
|
+
*/
|
|
134
|
+
blocks: Schema.Array$<Schema.Struct<{
|
|
135
|
+
/**
|
|
136
|
+
* Appears on blocks returned from query.
|
|
137
|
+
*/
|
|
138
|
+
feedId: Schema.UndefinedOr<typeof Schema.String>;
|
|
139
|
+
/**
|
|
140
|
+
* Actor that produced this block.
|
|
141
|
+
*/
|
|
142
|
+
actorId: typeof Schema.String;
|
|
143
|
+
/**
|
|
144
|
+
* Per-feed monotonic sequence assigned by the actor.
|
|
145
|
+
*/
|
|
146
|
+
sequence: typeof Schema.Number;
|
|
147
|
+
/**
|
|
148
|
+
* Actor of the immediate predecessor block, if any.
|
|
149
|
+
*/
|
|
150
|
+
prevActorId: Schema.NullOr<typeof Schema.String>;
|
|
151
|
+
/**
|
|
152
|
+
* Sequence of the immediate predecessor block, if any.
|
|
153
|
+
*/
|
|
154
|
+
prevSequence: Schema.NullOr<typeof Schema.Number>;
|
|
155
|
+
/**
|
|
156
|
+
* Globally ordered position assigned by a position authority.
|
|
157
|
+
* Unlike `sequence` (per-feed causal order), this enables merged incremental reads across feeds.
|
|
158
|
+
*/
|
|
159
|
+
position: Schema.NullOr<typeof Schema.Number>;
|
|
160
|
+
/**
|
|
161
|
+
* Milliseconds since Unix epoch when the block was created.
|
|
162
|
+
*/
|
|
163
|
+
timestamp: typeof Schema.Number;
|
|
164
|
+
/**
|
|
165
|
+
* Serialized application payload.
|
|
166
|
+
*/
|
|
167
|
+
data: typeof Schema.Uint8Array;
|
|
168
|
+
/**
|
|
169
|
+
* Local insertion ID.
|
|
170
|
+
* Not replicated.
|
|
171
|
+
*/
|
|
172
|
+
insertionId: Schema.optional<typeof Schema.Number>;
|
|
173
|
+
}>>;
|
|
174
|
+
}>;
|
|
175
|
+
export interface QueryResponse extends Schema.Schema.Type<typeof QueryResponse> {
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* Parameters for creating or refreshing a feed subscription.
|
|
179
|
+
*/
|
|
180
|
+
export declare const SubscribeRequest: Schema.Struct<{
|
|
181
|
+
/**
|
|
182
|
+
* Optional request correlation identifier.
|
|
183
|
+
*/
|
|
184
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
185
|
+
/**
|
|
186
|
+
* Optional space scope for the subscription.
|
|
187
|
+
*/
|
|
188
|
+
spaceId: Schema.optional<typeof Schema.String>;
|
|
189
|
+
/**
|
|
190
|
+
* Feeds to include in the subscription.
|
|
191
|
+
*/
|
|
192
|
+
feedIds: Schema.Array$<typeof Schema.String>;
|
|
193
|
+
}>;
|
|
194
|
+
export interface SubscribeRequest extends Schema.Schema.Type<typeof SubscribeRequest> {
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* Response payload for subscription creation.
|
|
198
|
+
*/
|
|
199
|
+
export declare const SubscribeResponse: Schema.Struct<{
|
|
200
|
+
/**
|
|
201
|
+
* Echoed request correlation identifier.
|
|
202
|
+
*/
|
|
203
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
204
|
+
/**
|
|
205
|
+
* Identifier to use in subsequent subscription queries.
|
|
206
|
+
*/
|
|
207
|
+
subscriptionId: typeof Schema.String;
|
|
208
|
+
/**
|
|
209
|
+
* Expiration timestamp in milliseconds since Unix epoch.
|
|
210
|
+
*/
|
|
211
|
+
expiresAt: typeof Schema.Number;
|
|
212
|
+
}>;
|
|
213
|
+
export interface SubscribeResponse extends Schema.Schema.Type<typeof SubscribeResponse> {
|
|
214
|
+
}
|
|
215
|
+
/**
|
|
216
|
+
* Request payload for appending one or more blocks.
|
|
217
|
+
*/
|
|
218
|
+
export declare const AppendRequest: Schema.Struct<{
|
|
219
|
+
/**
|
|
220
|
+
* Optional request correlation identifier.
|
|
221
|
+
*/
|
|
222
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
223
|
+
/**
|
|
224
|
+
* Target space identifier.
|
|
225
|
+
*/
|
|
226
|
+
spaceId: typeof Schema.String;
|
|
227
|
+
/**
|
|
228
|
+
* Namespace that all appended blocks belong to.
|
|
229
|
+
*/
|
|
230
|
+
feedNamespace: typeof Schema.String;
|
|
231
|
+
/**
|
|
232
|
+
* Blocks to append.
|
|
233
|
+
*/
|
|
234
|
+
blocks: Schema.Array$<Schema.Struct<{
|
|
235
|
+
/**
|
|
236
|
+
* Appears on blocks returned from query.
|
|
237
|
+
*/
|
|
238
|
+
feedId: Schema.UndefinedOr<typeof Schema.String>;
|
|
239
|
+
/**
|
|
240
|
+
* Actor that produced this block.
|
|
241
|
+
*/
|
|
242
|
+
actorId: typeof Schema.String;
|
|
243
|
+
/**
|
|
244
|
+
* Per-feed monotonic sequence assigned by the actor.
|
|
245
|
+
*/
|
|
246
|
+
sequence: typeof Schema.Number;
|
|
247
|
+
/**
|
|
248
|
+
* Actor of the immediate predecessor block, if any.
|
|
249
|
+
*/
|
|
250
|
+
prevActorId: Schema.NullOr<typeof Schema.String>;
|
|
251
|
+
/**
|
|
252
|
+
* Sequence of the immediate predecessor block, if any.
|
|
253
|
+
*/
|
|
254
|
+
prevSequence: Schema.NullOr<typeof Schema.Number>;
|
|
255
|
+
/**
|
|
256
|
+
* Globally ordered position assigned by a position authority.
|
|
257
|
+
* Unlike `sequence` (per-feed causal order), this enables merged incremental reads across feeds.
|
|
258
|
+
*/
|
|
259
|
+
position: Schema.NullOr<typeof Schema.Number>;
|
|
260
|
+
/**
|
|
261
|
+
* Milliseconds since Unix epoch when the block was created.
|
|
262
|
+
*/
|
|
263
|
+
timestamp: typeof Schema.Number;
|
|
264
|
+
/**
|
|
265
|
+
* Serialized application payload.
|
|
266
|
+
*/
|
|
267
|
+
data: typeof Schema.Uint8Array;
|
|
268
|
+
/**
|
|
269
|
+
* Local insertion ID.
|
|
270
|
+
* Not replicated.
|
|
271
|
+
*/
|
|
272
|
+
insertionId: Schema.optional<typeof Schema.Number>;
|
|
273
|
+
}>>;
|
|
274
|
+
}>;
|
|
275
|
+
export interface AppendRequest extends Schema.Schema.Type<typeof AppendRequest> {
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* Result payload for append operations.
|
|
279
|
+
*/
|
|
280
|
+
export declare const AppendResponse: Schema.Struct<{
|
|
281
|
+
/**
|
|
282
|
+
* Echoed request correlation identifier.
|
|
283
|
+
*/
|
|
284
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
285
|
+
/**
|
|
286
|
+
* Assigned global positions for appended blocks.
|
|
287
|
+
*/
|
|
288
|
+
positions: Schema.Array$<typeof Schema.Number>;
|
|
289
|
+
}>;
|
|
290
|
+
export interface AppendResponse extends Schema.Schema.Type<typeof AppendResponse> {
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* Tagged transport message union for queue protocol RPC traffic.
|
|
294
|
+
*/
|
|
295
|
+
export declare const ProtocolMessage: Schema.extend<Schema.Union<[Schema.TaggedStruct<"QueryRequest", Readonly<{
|
|
296
|
+
/**
|
|
297
|
+
* Optional request correlation identifier.
|
|
298
|
+
*/
|
|
299
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
300
|
+
/**
|
|
301
|
+
* Target space identifier.
|
|
302
|
+
*/
|
|
303
|
+
spaceId: Schema.Schema<SpaceId, string, never> & {
|
|
304
|
+
byteLength: number;
|
|
305
|
+
encode: (value: Uint8Array) => SpaceId;
|
|
306
|
+
decode: (value: SpaceId) => Uint8Array;
|
|
307
|
+
isValid: (value: unknown) => value is SpaceId;
|
|
308
|
+
make: (value: string) => SpaceId;
|
|
309
|
+
random: () => SpaceId;
|
|
310
|
+
};
|
|
311
|
+
/**
|
|
312
|
+
* Feed namespace to query.
|
|
313
|
+
*/
|
|
314
|
+
feedNamespace: typeof Schema.String;
|
|
315
|
+
query: Schema.optional<Schema.Union<[Schema.Struct<{
|
|
316
|
+
/**
|
|
317
|
+
* Explicit list of feed IDs to read from.
|
|
318
|
+
*/
|
|
319
|
+
feedIds: Schema.Array$<typeof Schema.String>;
|
|
320
|
+
}>, Schema.Struct<{
|
|
321
|
+
/**
|
|
322
|
+
* Existing subscription to resolve feed IDs from.
|
|
323
|
+
*/
|
|
324
|
+
subscriptionId: typeof Schema.String;
|
|
325
|
+
}>]>>;
|
|
326
|
+
/**
|
|
327
|
+
* Get changes following this cursor (exclusive).
|
|
328
|
+
*
|
|
329
|
+
* Must not be used with `position`.
|
|
330
|
+
*/
|
|
331
|
+
cursor: Schema.optional<Schema.brand<typeof Schema.String, "@dxos/feed/FeedCursor">>;
|
|
332
|
+
/**
|
|
333
|
+
* Get changes following this position.
|
|
334
|
+
* Returned blocks have strictly greater position than this.
|
|
335
|
+
*
|
|
336
|
+
* Must not be used with `cursor`.
|
|
337
|
+
*/
|
|
338
|
+
position: Schema.optional<typeof Schema.Number>;
|
|
339
|
+
/**
|
|
340
|
+
* Only return blocks that are not positioned.
|
|
341
|
+
*
|
|
342
|
+
* Must not be used with `cursor` or `position`.
|
|
343
|
+
*/
|
|
344
|
+
unpositionedOnly: Schema.optional<typeof Schema.Boolean>;
|
|
345
|
+
/**
|
|
346
|
+
* Maximum number of blocks to return.
|
|
347
|
+
*/
|
|
348
|
+
limit: Schema.optional<typeof Schema.Number>;
|
|
349
|
+
}>>, Schema.TaggedStruct<"QueryResponse", Readonly<{
|
|
350
|
+
/**
|
|
351
|
+
* Echoed request correlation identifier.
|
|
352
|
+
*/
|
|
353
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
354
|
+
/**
|
|
355
|
+
* Cursor to continue reading from this result boundary.
|
|
356
|
+
*/
|
|
357
|
+
nextCursor: Schema.brand<typeof Schema.String, "@dxos/feed/FeedCursor">;
|
|
358
|
+
/**
|
|
359
|
+
* Indicates whether more matching blocks are available.
|
|
360
|
+
*/
|
|
361
|
+
hasMore: typeof Schema.Boolean;
|
|
362
|
+
/**
|
|
363
|
+
* Returned blocks for the current page.
|
|
364
|
+
*/
|
|
365
|
+
blocks: Schema.Array$<Schema.Struct<{
|
|
366
|
+
/**
|
|
367
|
+
* Appears on blocks returned from query.
|
|
368
|
+
*/
|
|
369
|
+
feedId: Schema.UndefinedOr<typeof Schema.String>;
|
|
370
|
+
/**
|
|
371
|
+
* Actor that produced this block.
|
|
372
|
+
*/
|
|
373
|
+
actorId: typeof Schema.String;
|
|
374
|
+
/**
|
|
375
|
+
* Per-feed monotonic sequence assigned by the actor.
|
|
376
|
+
*/
|
|
377
|
+
sequence: typeof Schema.Number;
|
|
378
|
+
/**
|
|
379
|
+
* Actor of the immediate predecessor block, if any.
|
|
380
|
+
*/
|
|
381
|
+
prevActorId: Schema.NullOr<typeof Schema.String>;
|
|
382
|
+
/**
|
|
383
|
+
* Sequence of the immediate predecessor block, if any.
|
|
384
|
+
*/
|
|
385
|
+
prevSequence: Schema.NullOr<typeof Schema.Number>;
|
|
386
|
+
/**
|
|
387
|
+
* Globally ordered position assigned by a position authority.
|
|
388
|
+
* Unlike `sequence` (per-feed causal order), this enables merged incremental reads across feeds.
|
|
389
|
+
*/
|
|
390
|
+
position: Schema.NullOr<typeof Schema.Number>;
|
|
391
|
+
/**
|
|
392
|
+
* Milliseconds since Unix epoch when the block was created.
|
|
393
|
+
*/
|
|
394
|
+
timestamp: typeof Schema.Number;
|
|
395
|
+
/**
|
|
396
|
+
* Serialized application payload.
|
|
397
|
+
*/
|
|
398
|
+
data: typeof Schema.Uint8Array;
|
|
399
|
+
/**
|
|
400
|
+
* Local insertion ID.
|
|
401
|
+
* Not replicated.
|
|
402
|
+
*/
|
|
403
|
+
insertionId: Schema.optional<typeof Schema.Number>;
|
|
404
|
+
}>>;
|
|
405
|
+
}>>, Schema.TaggedStruct<"SubscribeRequest", Readonly<{
|
|
406
|
+
/**
|
|
407
|
+
* Optional request correlation identifier.
|
|
408
|
+
*/
|
|
409
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
410
|
+
/**
|
|
411
|
+
* Optional space scope for the subscription.
|
|
412
|
+
*/
|
|
413
|
+
spaceId: Schema.optional<typeof Schema.String>;
|
|
414
|
+
/**
|
|
415
|
+
* Feeds to include in the subscription.
|
|
416
|
+
*/
|
|
417
|
+
feedIds: Schema.Array$<typeof Schema.String>;
|
|
418
|
+
}>>, Schema.TaggedStruct<"SubscribeResponse", Readonly<{
|
|
419
|
+
/**
|
|
420
|
+
* Echoed request correlation identifier.
|
|
421
|
+
*/
|
|
422
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
423
|
+
/**
|
|
424
|
+
* Identifier to use in subsequent subscription queries.
|
|
425
|
+
*/
|
|
426
|
+
subscriptionId: typeof Schema.String;
|
|
427
|
+
/**
|
|
428
|
+
* Expiration timestamp in milliseconds since Unix epoch.
|
|
429
|
+
*/
|
|
430
|
+
expiresAt: typeof Schema.Number;
|
|
431
|
+
}>>, Schema.TaggedStruct<"AppendRequest", Readonly<{
|
|
432
|
+
/**
|
|
433
|
+
* Optional request correlation identifier.
|
|
434
|
+
*/
|
|
435
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
436
|
+
/**
|
|
437
|
+
* Target space identifier.
|
|
438
|
+
*/
|
|
439
|
+
spaceId: typeof Schema.String;
|
|
440
|
+
/**
|
|
441
|
+
* Namespace that all appended blocks belong to.
|
|
442
|
+
*/
|
|
443
|
+
feedNamespace: typeof Schema.String;
|
|
444
|
+
/**
|
|
445
|
+
* Blocks to append.
|
|
446
|
+
*/
|
|
447
|
+
blocks: Schema.Array$<Schema.Struct<{
|
|
448
|
+
/**
|
|
449
|
+
* Appears on blocks returned from query.
|
|
450
|
+
*/
|
|
451
|
+
feedId: Schema.UndefinedOr<typeof Schema.String>;
|
|
452
|
+
/**
|
|
453
|
+
* Actor that produced this block.
|
|
454
|
+
*/
|
|
455
|
+
actorId: typeof Schema.String;
|
|
456
|
+
/**
|
|
457
|
+
* Per-feed monotonic sequence assigned by the actor.
|
|
458
|
+
*/
|
|
459
|
+
sequence: typeof Schema.Number;
|
|
460
|
+
/**
|
|
461
|
+
* Actor of the immediate predecessor block, if any.
|
|
462
|
+
*/
|
|
463
|
+
prevActorId: Schema.NullOr<typeof Schema.String>;
|
|
464
|
+
/**
|
|
465
|
+
* Sequence of the immediate predecessor block, if any.
|
|
466
|
+
*/
|
|
467
|
+
prevSequence: Schema.NullOr<typeof Schema.Number>;
|
|
468
|
+
/**
|
|
469
|
+
* Globally ordered position assigned by a position authority.
|
|
470
|
+
* Unlike `sequence` (per-feed causal order), this enables merged incremental reads across feeds.
|
|
471
|
+
*/
|
|
472
|
+
position: Schema.NullOr<typeof Schema.Number>;
|
|
473
|
+
/**
|
|
474
|
+
* Milliseconds since Unix epoch when the block was created.
|
|
475
|
+
*/
|
|
476
|
+
timestamp: typeof Schema.Number;
|
|
477
|
+
/**
|
|
478
|
+
* Serialized application payload.
|
|
479
|
+
*/
|
|
480
|
+
data: typeof Schema.Uint8Array;
|
|
481
|
+
/**
|
|
482
|
+
* Local insertion ID.
|
|
483
|
+
* Not replicated.
|
|
484
|
+
*/
|
|
485
|
+
insertionId: Schema.optional<typeof Schema.Number>;
|
|
486
|
+
}>>;
|
|
487
|
+
}>>, Schema.TaggedStruct<"AppendResponse", Readonly<{
|
|
488
|
+
/**
|
|
489
|
+
* Echoed request correlation identifier.
|
|
490
|
+
*/
|
|
491
|
+
requestId: Schema.optional<typeof Schema.String>;
|
|
492
|
+
/**
|
|
493
|
+
* Assigned global positions for appended blocks.
|
|
494
|
+
*/
|
|
495
|
+
positions: Schema.Array$<typeof Schema.Number>;
|
|
496
|
+
}>>, Schema.TaggedStruct<"Error", {
|
|
497
|
+
/**
|
|
498
|
+
* Human-readable error message.
|
|
499
|
+
*/
|
|
500
|
+
message: typeof Schema.String;
|
|
501
|
+
}>]>, Schema.Struct<{
|
|
502
|
+
senderPeerId: Schema.UndefinedOr<typeof Schema.String>;
|
|
503
|
+
/**
|
|
504
|
+
* Could be undefined if the recipient could be assumed from the context.
|
|
505
|
+
*/
|
|
506
|
+
recipientPeerId: Schema.UndefinedOr<typeof Schema.String>;
|
|
507
|
+
}>>;
|
|
508
|
+
export type ProtocolMessage = Schema.Schema.Type<typeof ProtocolMessage>;
|
|
509
|
+
/**
|
|
510
|
+
* Reserved namespaces with protocol-level semantics.
|
|
511
|
+
*/
|
|
512
|
+
export declare const WellKnownNamespaces: {
|
|
513
|
+
readonly data: "data";
|
|
514
|
+
readonly trace: "trace";
|
|
515
|
+
};
|
|
516
|
+
export declare const isWellKnownNamespace: (namespace: string) => boolean;
|
|
517
|
+
/**
|
|
518
|
+
* Encodes queue replicator service identifier as `<service>:<namespace>:<spaceId>`.
|
|
519
|
+
*/
|
|
520
|
+
export declare const encodeServiceId: (namespace: string, spaceId: SpaceId) => string;
|
|
521
|
+
/**
|
|
522
|
+
* Decodes and validates queue replicator service identifier.
|
|
523
|
+
*/
|
|
524
|
+
export declare const decodeServiceId: (serviceId: string) => {
|
|
525
|
+
namespace: keyof typeof WellKnownNamespaces;
|
|
526
|
+
spaceId: SpaceId;
|
|
527
|
+
};
|
|
528
|
+
//# sourceMappingURL=FeedProtocol.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"FeedProtocol.d.ts","sourceRoot":"","sources":["../../src/FeedProtocol.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,UAAU,EACf,KAAK,gBAAgB,IAAI,WAAW,EACpC,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,GACtB,MAAM,qCAAqC,CAAC;AAE7C,eAAO,MAAM,kBAAkB,gCAAgC,CAAC;AAEhE,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAIrC;;GAEG;AACH,eAAO,MAAM,UAAU,6DAA4D,CAAC;AACpF,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,UAAU,CAAC,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,KAAK;IAChB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;;OAGG;;EAGH,CAAC;AACH,MAAM,WAAW,KAAM,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC;CAAG;AAMlE;;GAEG;AACH,eAAO,MAAM,YAAY;IACvB;;OAEG;;IAGH;;OAEG;;;;;;;;;IAGH;;OAEG;;;QAMG;;WAEG;;;QAIH;;WAEG;;;IAMT;;;;OAIG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;OAEG;;EAEH,CAAC;AACH,MAAM,WAAW,YAAa,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,YAAY,CAAC;CAAG;AAEhF;;GAEG;AACH,eAAO,MAAM,aAAa;IACxB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;QA5IH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;;WAGG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;;WAGG;;;EAkGH,CAAC;AACH,MAAM,WAAW,aAAc,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,aAAa,CAAC;CAAG;AAElF;;GAEG;AACH,eAAO,MAAM,gBAAgB;IAC3B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;EAEH,CAAC;AACH,MAAM,WAAW,gBAAiB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,gBAAgB,CAAC;CAAG;AAExF;;GAEG;AACH,eAAO,MAAM,iBAAiB;IAC5B;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;EAEH,CAAC;AACH,MAAM,WAAW,iBAAkB,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,iBAAiB,CAAC;CAAG;AAE1F;;GAEG;AACH,eAAO,MAAM,aAAa;IACxB;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;QAhNH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;;WAGG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;;WAGG;;;EAsKH,CAAC;AACH,MAAM,WAAW,aAAc,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,aAAa,CAAC;CAAG;AAElF;;GAEG;AACH,eAAO,MAAM,cAAc;IACzB;;OAEG;;IAGH;;OAEG;;EAEH,CAAC;AACH,MAAM,WAAW,cAAe,SAAQ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,cAAc,CAAC;CAAG;AAEpF;;GAEG;AACH,eAAO,MAAM,eAAe;IA9K1B;;OAEG;;IAGH;;OAEG;;;;;;;;;IAGH;;OAEG;;;QAMG;;WAEG;;;QAIH;;WAEG;;;IAMT;;;;OAIG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;OAEG;;;IASH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;QA5IH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;;WAGG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;;WAGG;;;;IAyGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;IASH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;;IASH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;IAGH;;OAEG;;QAhNH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;;WAGG;;QAGH;;WAEG;;QAGH;;WAEG;;QAGH;;;WAGG;;;;IA6KH;;OAEG;;IAGH;;OAEG;;;IAgBD;;OAEG;;;;IAOD;;OAEG;;GAIR,CAAC;AACF,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,eAAe,CAAC,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;CAGtB,CAAC;AAEX,eAAO,MAAM,oBAAoB,GAAI,WAAW,MAAM,YACS,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,eAAe,GAAI,WAAW,MAAM,EAAE,SAAS,OAAO,WACR,CAAC;AAE5D;;GAEG;AACH,eAAO,MAAM,eAAe,GAC1B,WAAW,MAAM,KAChB;IAAE,SAAS,EAAE,MAAM,OAAO,mBAAmB,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAMjE,CAAC"}
|