@xyo-network/dapp-kit-port 0.1.2

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.
Files changed (30) hide show
  1. package/README.md +23 -0
  2. package/dist/browser/applicationPortClient.d.ts +6 -0
  3. package/dist/browser/applicationPortClient.d.ts.map +1 -0
  4. package/dist/browser/applicationPortHost.d.ts +10 -0
  5. package/dist/browser/applicationPortHost.d.ts.map +1 -0
  6. package/dist/browser/applicationPortModel.d.ts +154 -0
  7. package/dist/browser/applicationPortModel.d.ts.map +1 -0
  8. package/dist/browser/applicationPortWire.d.ts +327 -0
  9. package/dist/browser/applicationPortWire.d.ts.map +1 -0
  10. package/dist/browser/index.d.ts +6 -0
  11. package/dist/browser/index.d.ts.map +1 -0
  12. package/dist/browser/index.mjs +1180 -0
  13. package/dist/browser/index.mjs.map +7 -0
  14. package/dist/browser/webSocketApplicationPortClient.d.ts +46 -0
  15. package/dist/browser/webSocketApplicationPortClient.d.ts.map +1 -0
  16. package/dist/node/applicationPortClient.d.ts +6 -0
  17. package/dist/node/applicationPortClient.d.ts.map +1 -0
  18. package/dist/node/applicationPortHost.d.ts +10 -0
  19. package/dist/node/applicationPortHost.d.ts.map +1 -0
  20. package/dist/node/applicationPortModel.d.ts +154 -0
  21. package/dist/node/applicationPortModel.d.ts.map +1 -0
  22. package/dist/node/applicationPortWire.d.ts +327 -0
  23. package/dist/node/applicationPortWire.d.ts.map +1 -0
  24. package/dist/node/index.d.ts +6 -0
  25. package/dist/node/index.d.ts.map +1 -0
  26. package/dist/node/index.mjs +1180 -0
  27. package/dist/node/index.mjs.map +7 -0
  28. package/dist/node/webSocketApplicationPortClient.d.ts +46 -0
  29. package/dist/node/webSocketApplicationPortClient.d.ts.map +1 -0
  30. package/package.json +74 -0
@@ -0,0 +1,327 @@
1
+ import type { PortFrame } from '@xyo-network/dapp-kit';
2
+ import { z } from 'zod';
3
+ export declare const ApplicationPortTransportSchema: "network.xyo.dapp.port.transport";
4
+ export declare const ApplicationPortTransportHelloZod: z.ZodObject<{
5
+ schema: z.ZodLiteral<"network.xyo.dapp.port.transport">;
6
+ schemaVersion: z.ZodLiteral<1>;
7
+ messageKind: z.ZodLiteral<"hello">;
8
+ maximumFrameBytes: z.ZodNumber;
9
+ grant: z.ZodObject<{
10
+ attachmentId: z.ZodString;
11
+ principalId: z.ZodString;
12
+ dappId: z.ZodString;
13
+ protocolVersion: z.ZodString;
14
+ planId: z.ZodString;
15
+ systemInstanceId: z.ZodString;
16
+ hostSessionId: z.ZodString;
17
+ createdAt: z.ZodNumber;
18
+ lastSeenAt: z.ZodNumber;
19
+ expiresAt: z.ZodNumber;
20
+ leasePolicy: z.ZodEnum<{
21
+ "fixed-expiry": "fixed-expiry";
22
+ "disconnect-expiry": "disconnect-expiry";
23
+ }>;
24
+ operations: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
25
+ portId: z.ZodString;
26
+ operationId: z.ZodString;
27
+ streaming: z.ZodLiteral<false>;
28
+ }, z.core.$strict>, z.ZodObject<{
29
+ portId: z.ZodString;
30
+ operationId: z.ZodString;
31
+ streaming: z.ZodLiteral<true>;
32
+ resumable: z.ZodBoolean;
33
+ maximumCredit: z.ZodNumber;
34
+ }, z.core.$strict>], "streaming">>;
35
+ }, z.core.$strict>;
36
+ }, z.core.$strict>;
37
+ export type ApplicationPortTransportHello = z.infer<typeof ApplicationPortTransportHelloZod>;
38
+ export declare const ApplicationPortTransportErrorZod: z.ZodObject<{
39
+ schema: z.ZodLiteral<"network.xyo.dapp.port.transport">;
40
+ schemaVersion: z.ZodLiteral<1>;
41
+ messageKind: z.ZodLiteral<"error">;
42
+ code: z.ZodString;
43
+ retriable: z.ZodBoolean;
44
+ }, z.core.$strict>;
45
+ export type ApplicationPortTransportError = z.infer<typeof ApplicationPortTransportErrorZod>;
46
+ export declare const ApplicationPortWireMessageZod: z.ZodUnion<readonly [z.ZodDiscriminatedUnion<[z.ZodObject<{
47
+ frameKind: z.ZodLiteral<"request">;
48
+ body: z.ZodType<import("@xyo-network/dapp-kit").JsonValue, unknown, z.core.$ZodTypeInternals<import("@xyo-network/dapp-kit").JsonValue, unknown>>;
49
+ schema: z.ZodLiteral<"network.xyo.dapp.port.frame">;
50
+ schemaVersion: z.ZodLiteral<1>;
51
+ dappId: z.ZodString;
52
+ protocolVersion: z.ZodString;
53
+ planId: z.ZodString;
54
+ systemInstanceId: z.ZodString;
55
+ hostSessionId: z.ZodString;
56
+ attachmentId: z.ZodString;
57
+ requestId: z.ZodString;
58
+ deadlineUnixMs: z.ZodNumber;
59
+ portId: z.ZodString;
60
+ operationId: z.ZodString;
61
+ }, z.core.$strict>, z.ZodObject<{
62
+ frameKind: z.ZodLiteral<"response">;
63
+ consistency: z.ZodDiscriminatedUnion<[z.ZodObject<{
64
+ mode: z.ZodLiteral<"not-applicable">;
65
+ }, z.core.$strict>, z.ZodObject<{
66
+ mode: z.ZodLiteral<"finalized-through">;
67
+ blockNumber: z.ZodNumber;
68
+ blockHash: z.ZodString;
69
+ }, z.core.$strict>, z.ZodObject<{
70
+ mode: z.ZodLiteral<"projection-through">;
71
+ blockNumber: z.ZodNumber;
72
+ blockHash: z.ZodString;
73
+ projectionId: z.ZodString;
74
+ projectionVersion: z.ZodString;
75
+ }, z.core.$strict>, z.ZodObject<{
76
+ mode: z.ZodLiteral<"provisional">;
77
+ blockNumber: z.ZodNumber;
78
+ blockHash: z.ZodString;
79
+ transactionHash: z.ZodString;
80
+ }, z.core.$strict>, z.ZodObject<{
81
+ mode: z.ZodLiteral<"local-ephemeral">;
82
+ }, z.core.$strict>], "mode">;
83
+ body: z.ZodType<import("@xyo-network/dapp-kit").JsonValue, unknown, z.core.$ZodTypeInternals<import("@xyo-network/dapp-kit").JsonValue, unknown>>;
84
+ schema: z.ZodLiteral<"network.xyo.dapp.port.frame">;
85
+ schemaVersion: z.ZodLiteral<1>;
86
+ dappId: z.ZodString;
87
+ protocolVersion: z.ZodString;
88
+ planId: z.ZodString;
89
+ systemInstanceId: z.ZodString;
90
+ hostSessionId: z.ZodString;
91
+ attachmentId: z.ZodString;
92
+ requestId: z.ZodString;
93
+ deadlineUnixMs: z.ZodNumber;
94
+ portId: z.ZodString;
95
+ operationId: z.ZodString;
96
+ }, z.core.$strict>, z.ZodObject<{
97
+ frameKind: z.ZodLiteral<"error">;
98
+ error: z.ZodObject<{
99
+ code: z.ZodString;
100
+ retriable: z.ZodBoolean;
101
+ details: z.ZodOptional<z.ZodType<import("@xyo-network/dapp-kit").JsonValue, unknown, z.core.$ZodTypeInternals<import("@xyo-network/dapp-kit").JsonValue, unknown>>>;
102
+ }, z.core.$strict>;
103
+ schema: z.ZodLiteral<"network.xyo.dapp.port.frame">;
104
+ schemaVersion: z.ZodLiteral<1>;
105
+ dappId: z.ZodString;
106
+ protocolVersion: z.ZodString;
107
+ planId: z.ZodString;
108
+ systemInstanceId: z.ZodString;
109
+ hostSessionId: z.ZodString;
110
+ attachmentId: z.ZodString;
111
+ requestId: z.ZodString;
112
+ deadlineUnixMs: z.ZodNumber;
113
+ portId: z.ZodString;
114
+ operationId: z.ZodString;
115
+ }, z.core.$strict>, z.ZodObject<{
116
+ frameKind: z.ZodLiteral<"cancel">;
117
+ reasonCode: z.ZodString;
118
+ schema: z.ZodLiteral<"network.xyo.dapp.port.frame">;
119
+ schemaVersion: z.ZodLiteral<1>;
120
+ dappId: z.ZodString;
121
+ protocolVersion: z.ZodString;
122
+ planId: z.ZodString;
123
+ systemInstanceId: z.ZodString;
124
+ hostSessionId: z.ZodString;
125
+ attachmentId: z.ZodString;
126
+ requestId: z.ZodString;
127
+ deadlineUnixMs: z.ZodNumber;
128
+ portId: z.ZodString;
129
+ operationId: z.ZodString;
130
+ }, z.core.$strict>, z.ZodObject<{
131
+ frameKind: z.ZodLiteral<"cancel-ack">;
132
+ willEmitNoNewWork: z.ZodLiteral<true>;
133
+ schema: z.ZodLiteral<"network.xyo.dapp.port.frame">;
134
+ schemaVersion: z.ZodLiteral<1>;
135
+ dappId: z.ZodString;
136
+ protocolVersion: z.ZodString;
137
+ planId: z.ZodString;
138
+ systemInstanceId: z.ZodString;
139
+ hostSessionId: z.ZodString;
140
+ attachmentId: z.ZodString;
141
+ requestId: z.ZodString;
142
+ deadlineUnixMs: z.ZodNumber;
143
+ portId: z.ZodString;
144
+ operationId: z.ZodString;
145
+ }, z.core.$strict>, z.ZodObject<{
146
+ frameKind: z.ZodLiteral<"stream-open">;
147
+ streamId: z.ZodString;
148
+ delivery: z.ZodLiteral<"at-least-once">;
149
+ resumable: z.ZodBoolean;
150
+ nextSequence: z.ZodNumber;
151
+ resumeCursor: z.ZodOptional<z.ZodString>;
152
+ schema: z.ZodLiteral<"network.xyo.dapp.port.frame">;
153
+ schemaVersion: z.ZodLiteral<1>;
154
+ dappId: z.ZodString;
155
+ protocolVersion: z.ZodString;
156
+ planId: z.ZodString;
157
+ systemInstanceId: z.ZodString;
158
+ hostSessionId: z.ZodString;
159
+ attachmentId: z.ZodString;
160
+ requestId: z.ZodString;
161
+ deadlineUnixMs: z.ZodNumber;
162
+ portId: z.ZodString;
163
+ operationId: z.ZodString;
164
+ }, z.core.$strict>, z.ZodObject<{
165
+ frameKind: z.ZodLiteral<"stream-item">;
166
+ streamId: z.ZodString;
167
+ sequence: z.ZodNumber;
168
+ resumeCursor: z.ZodOptional<z.ZodString>;
169
+ consistency: z.ZodDiscriminatedUnion<[z.ZodObject<{
170
+ mode: z.ZodLiteral<"not-applicable">;
171
+ }, z.core.$strict>, z.ZodObject<{
172
+ mode: z.ZodLiteral<"finalized-through">;
173
+ blockNumber: z.ZodNumber;
174
+ blockHash: z.ZodString;
175
+ }, z.core.$strict>, z.ZodObject<{
176
+ mode: z.ZodLiteral<"projection-through">;
177
+ blockNumber: z.ZodNumber;
178
+ blockHash: z.ZodString;
179
+ projectionId: z.ZodString;
180
+ projectionVersion: z.ZodString;
181
+ }, z.core.$strict>, z.ZodObject<{
182
+ mode: z.ZodLiteral<"provisional">;
183
+ blockNumber: z.ZodNumber;
184
+ blockHash: z.ZodString;
185
+ transactionHash: z.ZodString;
186
+ }, z.core.$strict>, z.ZodObject<{
187
+ mode: z.ZodLiteral<"local-ephemeral">;
188
+ }, z.core.$strict>], "mode">;
189
+ body: z.ZodType<import("@xyo-network/dapp-kit").JsonValue, unknown, z.core.$ZodTypeInternals<import("@xyo-network/dapp-kit").JsonValue, unknown>>;
190
+ schema: z.ZodLiteral<"network.xyo.dapp.port.frame">;
191
+ schemaVersion: z.ZodLiteral<1>;
192
+ dappId: z.ZodString;
193
+ protocolVersion: z.ZodString;
194
+ planId: z.ZodString;
195
+ systemInstanceId: z.ZodString;
196
+ hostSessionId: z.ZodString;
197
+ attachmentId: z.ZodString;
198
+ requestId: z.ZodString;
199
+ deadlineUnixMs: z.ZodNumber;
200
+ portId: z.ZodString;
201
+ operationId: z.ZodString;
202
+ }, z.core.$strict>, z.ZodObject<{
203
+ frameKind: z.ZodLiteral<"stream-credit">;
204
+ streamId: z.ZodString;
205
+ credit: z.ZodNumber;
206
+ schema: z.ZodLiteral<"network.xyo.dapp.port.frame">;
207
+ schemaVersion: z.ZodLiteral<1>;
208
+ dappId: z.ZodString;
209
+ protocolVersion: z.ZodString;
210
+ planId: z.ZodString;
211
+ systemInstanceId: z.ZodString;
212
+ hostSessionId: z.ZodString;
213
+ attachmentId: z.ZodString;
214
+ requestId: z.ZodString;
215
+ deadlineUnixMs: z.ZodNumber;
216
+ portId: z.ZodString;
217
+ operationId: z.ZodString;
218
+ }, z.core.$strict>, z.ZodObject<{
219
+ frameKind: z.ZodLiteral<"stream-close">;
220
+ streamId: z.ZodString;
221
+ lastSequence: z.ZodNumber;
222
+ resumeCursor: z.ZodOptional<z.ZodString>;
223
+ schema: z.ZodLiteral<"network.xyo.dapp.port.frame">;
224
+ schemaVersion: z.ZodLiteral<1>;
225
+ dappId: z.ZodString;
226
+ protocolVersion: z.ZodString;
227
+ planId: z.ZodString;
228
+ systemInstanceId: z.ZodString;
229
+ hostSessionId: z.ZodString;
230
+ attachmentId: z.ZodString;
231
+ requestId: z.ZodString;
232
+ deadlineUnixMs: z.ZodNumber;
233
+ portId: z.ZodString;
234
+ operationId: z.ZodString;
235
+ }, z.core.$strict>, z.ZodObject<{
236
+ frameKind: z.ZodLiteral<"stream-error">;
237
+ streamId: z.ZodString;
238
+ lastSequence: z.ZodNumber;
239
+ resumeCursor: z.ZodOptional<z.ZodString>;
240
+ error: z.ZodObject<{
241
+ code: z.ZodString;
242
+ retriable: z.ZodBoolean;
243
+ details: z.ZodOptional<z.ZodType<import("@xyo-network/dapp-kit").JsonValue, unknown, z.core.$ZodTypeInternals<import("@xyo-network/dapp-kit").JsonValue, unknown>>>;
244
+ }, z.core.$strict>;
245
+ schema: z.ZodLiteral<"network.xyo.dapp.port.frame">;
246
+ schemaVersion: z.ZodLiteral<1>;
247
+ dappId: z.ZodString;
248
+ protocolVersion: z.ZodString;
249
+ planId: z.ZodString;
250
+ systemInstanceId: z.ZodString;
251
+ hostSessionId: z.ZodString;
252
+ attachmentId: z.ZodString;
253
+ requestId: z.ZodString;
254
+ deadlineUnixMs: z.ZodNumber;
255
+ portId: z.ZodString;
256
+ operationId: z.ZodString;
257
+ }, z.core.$strict>, z.ZodObject<{
258
+ frameKind: z.ZodLiteral<"stream-resume">;
259
+ streamId: z.ZodString;
260
+ lastAcceptedSequence: z.ZodNumber;
261
+ resumeCursor: z.ZodString;
262
+ credit: z.ZodNumber;
263
+ schema: z.ZodLiteral<"network.xyo.dapp.port.frame">;
264
+ schemaVersion: z.ZodLiteral<1>;
265
+ dappId: z.ZodString;
266
+ protocolVersion: z.ZodString;
267
+ planId: z.ZodString;
268
+ systemInstanceId: z.ZodString;
269
+ hostSessionId: z.ZodString;
270
+ attachmentId: z.ZodString;
271
+ requestId: z.ZodString;
272
+ deadlineUnixMs: z.ZodNumber;
273
+ portId: z.ZodString;
274
+ operationId: z.ZodString;
275
+ }, z.core.$strict>], "frameKind">, z.ZodObject<{
276
+ schema: z.ZodLiteral<"network.xyo.dapp.port.transport">;
277
+ schemaVersion: z.ZodLiteral<1>;
278
+ messageKind: z.ZodLiteral<"hello">;
279
+ maximumFrameBytes: z.ZodNumber;
280
+ grant: z.ZodObject<{
281
+ attachmentId: z.ZodString;
282
+ principalId: z.ZodString;
283
+ dappId: z.ZodString;
284
+ protocolVersion: z.ZodString;
285
+ planId: z.ZodString;
286
+ systemInstanceId: z.ZodString;
287
+ hostSessionId: z.ZodString;
288
+ createdAt: z.ZodNumber;
289
+ lastSeenAt: z.ZodNumber;
290
+ expiresAt: z.ZodNumber;
291
+ leasePolicy: z.ZodEnum<{
292
+ "fixed-expiry": "fixed-expiry";
293
+ "disconnect-expiry": "disconnect-expiry";
294
+ }>;
295
+ operations: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
296
+ portId: z.ZodString;
297
+ operationId: z.ZodString;
298
+ streaming: z.ZodLiteral<false>;
299
+ }, z.core.$strict>, z.ZodObject<{
300
+ portId: z.ZodString;
301
+ operationId: z.ZodString;
302
+ streaming: z.ZodLiteral<true>;
303
+ resumable: z.ZodBoolean;
304
+ maximumCredit: z.ZodNumber;
305
+ }, z.core.$strict>], "streaming">>;
306
+ }, z.core.$strict>;
307
+ }, z.core.$strict>, z.ZodObject<{
308
+ schema: z.ZodLiteral<"network.xyo.dapp.port.transport">;
309
+ schemaVersion: z.ZodLiteral<1>;
310
+ messageKind: z.ZodLiteral<"error">;
311
+ code: z.ZodString;
312
+ retriable: z.ZodBoolean;
313
+ }, z.core.$strict>]>;
314
+ export type ApplicationPortWireMessage = z.infer<typeof ApplicationPortWireMessageZod>;
315
+ export declare const ApplicationPortWireErrorCode: {
316
+ readonly frameTooLarge: "port.wire-frame-too-large";
317
+ readonly invalidMessage: "port.wire-invalid-message";
318
+ };
319
+ export type ApplicationPortWireErrorCode = typeof ApplicationPortWireErrorCode[keyof typeof ApplicationPortWireErrorCode];
320
+ export declare class ApplicationPortWireError extends Error {
321
+ readonly code: ApplicationPortWireErrorCode;
322
+ constructor(code: ApplicationPortWireErrorCode, message: string, options?: ErrorOptions);
323
+ }
324
+ export declare function isApplicationPortFrame(message: ApplicationPortWireMessage): message is PortFrame;
325
+ export declare function parseApplicationPortWireText(source: string, maximumFrameBytes: number): ApplicationPortWireMessage;
326
+ export declare function serializeApplicationPortWireMessage(message: ApplicationPortWireMessage, maximumFrameBytes: number): string;
327
+ //# sourceMappingURL=applicationPortWire.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"applicationPortWire.d.ts","sourceRoot":"","sources":["../../src/applicationPortWire.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAQtD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,eAAO,MAAM,8BAA8B,EAAG,iCAA0C,CAAA;AAExF,eAAO,MAAM,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kBAM3C,CAAA;AAEF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AAE5F,eAAO,MAAM,gCAAgC;;;;;;kBAM3C,CAAA;AAEF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAA;AAE5F,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;oBAIxC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AAEtF,eAAO,MAAM,4BAA4B;;;CAG/B,CAAA;AAEV,MAAM,MAAM,4BAA4B,GACpC,OAAO,4BAA4B,CAAC,MAAM,OAAO,4BAA4B,CAAC,CAAA;AAElF,qBAAa,wBAAyB,SAAQ,KAAK;IACjD,QAAQ,CAAC,IAAI,EAAE,4BAA4B,CAAA;gBAE/B,IAAI,EAAE,4BAA4B,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;CAKxF;AAaD,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,IAAI,SAAS,CAEhG;AAED,wBAAgB,4BAA4B,CAC1C,MAAM,EAAE,MAAM,EACd,iBAAiB,EAAE,MAAM,GACxB,0BAA0B,CAkB5B;AAED,wBAAgB,mCAAmC,CACjD,OAAO,EAAE,0BAA0B,EACnC,iBAAiB,EAAE,MAAM,GACxB,MAAM,CAmBR"}
@@ -0,0 +1,6 @@
1
+ export * from './applicationPortClient.ts';
2
+ export * from './applicationPortHost.ts';
3
+ export * from './applicationPortModel.ts';
4
+ export * from './applicationPortWire.ts';
5
+ export * from './webSocketApplicationPortClient.ts';
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAA;AAC1C,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA;AACzC,cAAc,0BAA0B,CAAA;AACxC,cAAc,qCAAqC,CAAA"}