osra 0.2.7 → 0.2.9
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/build/index.d.ts +73 -109
- package/build/index.js +264 -281
- package/build/index.js.map +1 -1
- package/package.json +1 -1
package/build/index.d.ts
CHANGED
|
@@ -52,33 +52,26 @@ declare const box: <T extends ArrayBuffer, T2 extends RevivableContext>(value: T
|
|
|
52
52
|
arrayBuffer: ArrayBuffer;
|
|
53
53
|
});
|
|
54
54
|
|
|
55
|
-
declare const
|
|
56
|
-
|
|
57
|
-
declare const box_2: <T extends MessageContext, T2 extends RevivableContext>(_value: T, _context: T2) => {
|
|
58
|
-
type: "context";
|
|
59
|
-
__OSRA_BOX__: "revivable";
|
|
60
|
-
};
|
|
61
|
-
|
|
62
|
-
declare const box_3: <T extends Date, T2 extends RevivableContext>(value: T, _context: T2) => {
|
|
55
|
+
declare const box_2: <T extends Date, T2 extends RevivableContext>(value: T, _context: T2) => {
|
|
63
56
|
type: "date";
|
|
64
57
|
ISOString: string;
|
|
65
58
|
__OSRA_BOX__: "revivable";
|
|
66
59
|
};
|
|
67
60
|
|
|
68
|
-
declare const
|
|
61
|
+
declare const box_3: <T extends Headers, T2 extends RevivableContext>(value: T, _context: T2) => {
|
|
69
62
|
type: "headers";
|
|
70
63
|
entries: [string, string][];
|
|
71
64
|
__OSRA_BOX__: "revivable";
|
|
72
65
|
};
|
|
73
66
|
|
|
74
|
-
declare const
|
|
67
|
+
declare const box_4: <T extends Error, T2 extends RevivableContext>(value: T, _context: T2) => {
|
|
75
68
|
type: "error";
|
|
76
69
|
message: string;
|
|
77
70
|
stack: string;
|
|
78
71
|
__OSRA_BOX__: "revivable";
|
|
79
72
|
};
|
|
80
73
|
|
|
81
|
-
declare const
|
|
74
|
+
declare const box_5: <T extends TypedArray, T2 extends RevivableContext>(value: T, context: T2) => {
|
|
82
75
|
type: "typedArray";
|
|
83
76
|
typedArrayType: string;
|
|
84
77
|
__OSRA_BOX__: "revivable";
|
|
@@ -94,7 +87,7 @@ declare const box_6: <T extends TypedArray, T2 extends RevivableContext>(value:
|
|
|
94
87
|
[UnderlyingType]: T;
|
|
95
88
|
};
|
|
96
89
|
|
|
97
|
-
declare const
|
|
90
|
+
declare const box_6: <T, T2 extends RevivableContext = RevivableContext>(value: StructurableTransferablePort<T>, context: T2) => ({
|
|
98
91
|
type: "messagePort";
|
|
99
92
|
portId: `${string}-${string}-${string}-${string}-${string}`;
|
|
100
93
|
__OSRA_BOX__: "revivable";
|
|
@@ -108,9 +101,11 @@ declare const box_7: <T, T2 extends RevivableContext = RevivableContext>(value:
|
|
|
108
101
|
[UnderlyingType]: StrictMessagePort<ExtractStructurableTransferable<T>>;
|
|
109
102
|
});
|
|
110
103
|
|
|
111
|
-
declare const
|
|
104
|
+
declare const box_7: <T, T2 extends RevivableContext>(value: CapablePromise<T>, context: T2) => BoxedPromise<ExtractCapable<T>>;
|
|
105
|
+
|
|
106
|
+
declare const box_8: <T extends (...args: any[]) => any, T2 extends RevivableContext>(value: T & CapableFunction<T>, context: T2) => BoxedFunction<T>;
|
|
112
107
|
|
|
113
|
-
declare const box_9: <T extends
|
|
108
|
+
declare const box_9: <T extends ReadableStream, T2 extends RevivableContext>(value: T, context: T2) => BoxedReadableStream<T>;
|
|
114
109
|
|
|
115
110
|
export declare const BoxBase: {
|
|
116
111
|
readonly __OSRA_BOX__: "revivable";
|
|
@@ -121,13 +116,13 @@ export declare type BoxBase<T extends string = string> = typeof BoxBase & {
|
|
|
121
116
|
type: T;
|
|
122
117
|
};
|
|
123
118
|
|
|
124
|
-
declare type BoxedFunction<T extends (...args: any[]) => any = (...args: any[]) => any> = BoxBase<typeof
|
|
119
|
+
declare type BoxedFunction<T extends (...args: any[]) => any = (...args: any[]) => any> = BoxBase<typeof type_7> & {
|
|
125
120
|
port: BoxedMessagePort;
|
|
126
121
|
} & {
|
|
127
122
|
[UnderlyingType]: (...args: Parameters<T>) => Promise<Awaited<ReturnType<T>>>;
|
|
128
123
|
};
|
|
129
124
|
|
|
130
|
-
declare type BoxedMessagePort<T extends StructurableTransferable = StructurableTransferable> = BoxBase<typeof
|
|
125
|
+
declare type BoxedMessagePort<T extends StructurableTransferable = StructurableTransferable> = BoxBase<typeof type_8> & ({
|
|
131
126
|
portId: string;
|
|
132
127
|
} | {
|
|
133
128
|
port: StrictMessagePort<T>;
|
|
@@ -137,14 +132,14 @@ declare type BoxedMessagePort<T extends StructurableTransferable = StructurableT
|
|
|
137
132
|
|
|
138
133
|
declare type BoxedPromise<T extends Capable = Capable> = {
|
|
139
134
|
__OSRA_BOX__: 'revivable';
|
|
140
|
-
type: typeof
|
|
141
|
-
port: ReturnType<typeof
|
|
135
|
+
type: typeof type_6;
|
|
136
|
+
port: ReturnType<typeof box_6>;
|
|
142
137
|
[UnderlyingType]: T;
|
|
143
138
|
};
|
|
144
139
|
|
|
145
140
|
declare type BoxedReadableStream<T extends ReadableStream = ReadableStream> = {
|
|
146
141
|
__OSRA_BOX__: 'revivable';
|
|
147
|
-
type: typeof
|
|
142
|
+
type: typeof type_9;
|
|
148
143
|
port: BoxedMessagePort;
|
|
149
144
|
[UnderlyingType]: T;
|
|
150
145
|
};
|
|
@@ -179,16 +174,6 @@ declare type Context = {
|
|
|
179
174
|
error: string;
|
|
180
175
|
};
|
|
181
176
|
|
|
182
|
-
declare namespace context {
|
|
183
|
-
export {
|
|
184
|
-
type_2 as type,
|
|
185
|
-
OSRA_CONTEXT,
|
|
186
|
-
isType_2 as isType,
|
|
187
|
-
box_2 as box,
|
|
188
|
-
revive_2 as revive
|
|
189
|
-
}
|
|
190
|
-
}
|
|
191
|
-
|
|
192
177
|
declare type CustomTransport = {
|
|
193
178
|
isJson?: boolean;
|
|
194
179
|
} & ({
|
|
@@ -202,16 +187,16 @@ declare type CustomTransport = {
|
|
|
202
187
|
|
|
203
188
|
declare namespace date {
|
|
204
189
|
export {
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
190
|
+
type_2 as type,
|
|
191
|
+
isType_2 as isType,
|
|
192
|
+
box_2 as box,
|
|
193
|
+
revive_2 as revive
|
|
209
194
|
}
|
|
210
195
|
}
|
|
211
196
|
|
|
212
197
|
declare type DefaultRevivableModules = typeof defaultRevivableModules;
|
|
213
198
|
|
|
214
|
-
declare const defaultRevivableModules: readonly [typeof arrayBuffer, typeof
|
|
199
|
+
declare const defaultRevivableModules: readonly [typeof arrayBuffer, typeof date, typeof headers, typeof error, typeof typedArray, typeof promise, typeof func, typeof messagePort, typeof readableStream];
|
|
215
200
|
|
|
216
201
|
declare type EmitJsonPlatformTransport = WebSocket | WebExtPort;
|
|
217
202
|
|
|
@@ -219,10 +204,10 @@ declare type EmitPlatformTransport = EmitJsonPlatformTransport | Window | Servic
|
|
|
219
204
|
|
|
220
205
|
declare namespace error {
|
|
221
206
|
export {
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
207
|
+
type_4 as type,
|
|
208
|
+
isType_4 as isType,
|
|
209
|
+
box_4 as box,
|
|
210
|
+
revive_4 as revive
|
|
226
211
|
}
|
|
227
212
|
}
|
|
228
213
|
|
|
@@ -257,21 +242,21 @@ declare type ExtractType<T> = T extends {
|
|
|
257
242
|
|
|
258
243
|
declare namespace func {
|
|
259
244
|
export {
|
|
260
|
-
|
|
245
|
+
type_7 as type,
|
|
261
246
|
CallContext,
|
|
262
247
|
BoxedFunction,
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
248
|
+
isType_7 as isType,
|
|
249
|
+
box_8 as box,
|
|
250
|
+
revive_7 as revive
|
|
266
251
|
}
|
|
267
252
|
}
|
|
268
253
|
|
|
269
254
|
declare namespace headers {
|
|
270
255
|
export {
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
256
|
+
type_3 as type,
|
|
257
|
+
isType_3 as isType,
|
|
258
|
+
box_3 as box,
|
|
259
|
+
revive_3 as revive
|
|
275
260
|
}
|
|
276
261
|
}
|
|
277
262
|
|
|
@@ -281,23 +266,21 @@ declare type IsJsonOnlyTransport<T extends Transport> = T extends JsonPlatformTr
|
|
|
281
266
|
|
|
282
267
|
declare const isType: (value: unknown) => value is ArrayBuffer;
|
|
283
268
|
|
|
284
|
-
declare const
|
|
285
|
-
|
|
286
|
-
declare const isType_2: (value: unknown) => value is MessageContext;
|
|
269
|
+
declare const isType_2: (value: unknown) => value is Date;
|
|
287
270
|
|
|
288
|
-
declare const isType_3: (value: unknown) => value is
|
|
271
|
+
declare const isType_3: (value: unknown) => value is Headers;
|
|
289
272
|
|
|
290
|
-
declare const isType_4: (value: unknown) => value is
|
|
273
|
+
declare const isType_4: (value: unknown) => value is Error;
|
|
291
274
|
|
|
292
|
-
declare const isType_5: (value: unknown) => value is
|
|
275
|
+
declare const isType_5: (value: unknown) => value is TypedArray;
|
|
293
276
|
|
|
294
|
-
declare const isType_6: (value: unknown) => value is
|
|
277
|
+
declare const isType_6: (value: unknown) => value is Promise<any>;
|
|
295
278
|
|
|
296
|
-
declare const isType_7: (value: unknown) => value is
|
|
279
|
+
declare const isType_7: (value: unknown) => value is (...args: any[]) => any;
|
|
297
280
|
|
|
298
|
-
declare const isType_8: (value: unknown) => value is
|
|
281
|
+
declare const isType_8: (value: unknown) => value is MessagePort;
|
|
299
282
|
|
|
300
|
-
declare const isType_9: (value: unknown) => value is
|
|
283
|
+
declare const isType_9: (value: unknown) => value is ReadableStream;
|
|
301
284
|
|
|
302
285
|
declare type Jsonable = boolean | null | number | string | {
|
|
303
286
|
[key: string]: Jsonable;
|
|
@@ -341,44 +324,31 @@ declare type MessageBase = {
|
|
|
341
324
|
|
|
342
325
|
declare type MessageChannelAllocator = ReturnType<typeof makeMessageChannelAllocator>;
|
|
343
326
|
|
|
344
|
-
|
|
327
|
+
declare type MessageContext = {
|
|
345
328
|
port?: MessagePort | WebExtPort;
|
|
346
329
|
sender?: WebExtSender;
|
|
347
330
|
receiveTransport?: ReceivePlatformTransport;
|
|
348
331
|
source?: MessageEventSource | null;
|
|
349
332
|
};
|
|
350
333
|
|
|
351
|
-
declare type MessageEventDetail = {
|
|
352
|
-
message: Message;
|
|
353
|
-
messageContext: MessageContext;
|
|
354
|
-
};
|
|
355
|
-
|
|
356
334
|
declare type MessageEventMap = {
|
|
357
|
-
message: CustomEvent<
|
|
335
|
+
message: CustomEvent<Message>;
|
|
358
336
|
};
|
|
359
337
|
|
|
360
338
|
declare type MessageEventTarget_2 = TypedEventTarget<MessageEventMap>;
|
|
361
339
|
|
|
362
340
|
declare namespace messagePort {
|
|
363
341
|
export {
|
|
364
|
-
|
|
342
|
+
type_8 as type,
|
|
365
343
|
BoxedMessagePort,
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
344
|
+
isType_8 as isType,
|
|
345
|
+
box_6 as box,
|
|
346
|
+
revive_8 as revive
|
|
369
347
|
}
|
|
370
348
|
}
|
|
371
349
|
|
|
372
350
|
declare type MessageVariant = ProtocolMessage | ConnectionMessage;
|
|
373
351
|
|
|
374
|
-
/**
|
|
375
|
-
* A special token that gets transformed into the MessageContext when revived on the receiving side.
|
|
376
|
-
* Pass this value in your exposed API to receive information about the message context.
|
|
377
|
-
*
|
|
378
|
-
* Typed as MessageContext so it can be passed directly where MessageContext is expected.
|
|
379
|
-
*/
|
|
380
|
-
export declare const OSRA_CONTEXT: MessageContext;
|
|
381
|
-
|
|
382
352
|
declare const OSRA_KEY: "__OSRA_KEY__";
|
|
383
353
|
|
|
384
354
|
declare type PlatformCapabilities = {
|
|
@@ -393,12 +363,12 @@ declare type PlatformTransport = EmitPlatformTransport | ReceivePlatformTranspor
|
|
|
393
363
|
|
|
394
364
|
declare namespace promise {
|
|
395
365
|
export {
|
|
396
|
-
|
|
366
|
+
type_6 as type,
|
|
397
367
|
Context,
|
|
398
368
|
BoxedPromise,
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
369
|
+
isType_6 as isType,
|
|
370
|
+
box_7 as box,
|
|
371
|
+
revive_6 as revive
|
|
402
372
|
}
|
|
403
373
|
}
|
|
404
374
|
|
|
@@ -421,12 +391,12 @@ declare type PullContext = {
|
|
|
421
391
|
|
|
422
392
|
declare namespace readableStream {
|
|
423
393
|
export {
|
|
424
|
-
|
|
394
|
+
type_9 as type,
|
|
425
395
|
PullContext,
|
|
426
396
|
BoxedReadableStream,
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
397
|
+
isType_9 as isType,
|
|
398
|
+
box_9 as box,
|
|
399
|
+
revive_9 as revive
|
|
430
400
|
}
|
|
431
401
|
}
|
|
432
402
|
|
|
@@ -443,8 +413,6 @@ declare type RevivableContext<TModules extends readonly RevivableModule[] = Defa
|
|
|
443
413
|
sendMessage: (message: ConnectionMessage) => void;
|
|
444
414
|
revivableModules: TModules;
|
|
445
415
|
eventTarget: MessageEventTarget_2;
|
|
446
|
-
/** MessageContext of the message being revived, used by OSRA_CONTEXT revivable */
|
|
447
|
-
messageContext?: MessageContext;
|
|
448
416
|
};
|
|
449
417
|
|
|
450
418
|
declare type RevivableModule<T extends string = string, T2 = any, T3 extends BoxBase<T> = any> = {
|
|
@@ -456,23 +424,21 @@ declare type RevivableModule<T extends string = string, T2 = any, T3 extends Box
|
|
|
456
424
|
|
|
457
425
|
declare const revive: <T extends ReturnType<typeof box>, T2 extends RevivableContext>(value: T, _context: T2) => ArrayBuffer;
|
|
458
426
|
|
|
459
|
-
declare const
|
|
427
|
+
declare const revive_2: <T extends ReturnType<typeof box_2>, T2 extends RevivableContext>(value: T, _context: T2) => Date;
|
|
460
428
|
|
|
461
|
-
declare const
|
|
429
|
+
declare const revive_3: <T extends ReturnType<typeof box_3>, T2 extends RevivableContext>(value: T, _context: T2) => Headers;
|
|
462
430
|
|
|
463
|
-
declare const
|
|
431
|
+
declare const revive_4: <T extends ReturnType<typeof box_4>, T2 extends RevivableContext>(value: T, _context: T2) => Error;
|
|
464
432
|
|
|
465
|
-
declare const
|
|
433
|
+
declare const revive_5: <T extends ReturnType<typeof box_5>, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
|
|
466
434
|
|
|
467
|
-
declare const
|
|
435
|
+
declare const revive_6: <T extends BoxedPromise, T2 extends RevivableContext>(value: T, context: T2) => Promise<T[typeof UnderlyingType]>;
|
|
468
436
|
|
|
469
|
-
declare const
|
|
437
|
+
declare const revive_7: <T extends BoxedFunction, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
|
|
470
438
|
|
|
471
|
-
declare const
|
|
439
|
+
declare const revive_8: <T extends StructurableTransferable, T2 extends RevivableContext>(value: BoxedMessagePort<T>, context: T2) => StrictMessagePort<T>;
|
|
472
440
|
|
|
473
|
-
declare const
|
|
474
|
-
|
|
475
|
-
declare const revive_9: <T extends StructurableTransferable, T2 extends RevivableContext>(value: BoxedMessagePort<T>, context: T2) => StrictMessagePort<T>;
|
|
441
|
+
declare const revive_9: <T extends BoxedReadableStream, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
|
|
476
442
|
|
|
477
443
|
/**
|
|
478
444
|
* A type-safe MessagePort wrapper that provides generic typing for messages.
|
|
@@ -516,37 +482,35 @@ declare type Transport = PlatformTransport | CustomTransport;
|
|
|
516
482
|
|
|
517
483
|
declare const type: "arrayBuffer";
|
|
518
484
|
|
|
519
|
-
declare const
|
|
520
|
-
|
|
521
|
-
declare const type_2: "context";
|
|
485
|
+
declare const type_2: "date";
|
|
522
486
|
|
|
523
|
-
declare const type_3: "
|
|
487
|
+
declare const type_3: "headers";
|
|
524
488
|
|
|
525
|
-
declare const type_4: "
|
|
489
|
+
declare const type_4: "error";
|
|
526
490
|
|
|
527
|
-
declare const type_5: "
|
|
491
|
+
declare const type_5: "typedArray";
|
|
528
492
|
|
|
529
|
-
declare const type_6: "
|
|
493
|
+
declare const type_6: "promise";
|
|
530
494
|
|
|
531
|
-
declare const type_7: "
|
|
495
|
+
declare const type_7: "function";
|
|
532
496
|
|
|
533
|
-
declare const type_8: "
|
|
497
|
+
declare const type_8: "messagePort";
|
|
534
498
|
|
|
535
|
-
declare const type_9: "
|
|
499
|
+
declare const type_9: "readableStream";
|
|
536
500
|
|
|
537
501
|
declare type TypedArray = typeof typedArrays[number];
|
|
538
502
|
|
|
539
503
|
declare namespace typedArray {
|
|
540
504
|
export {
|
|
541
|
-
|
|
505
|
+
type_5 as type,
|
|
542
506
|
TypedArrayConstructor,
|
|
543
507
|
TypedArray,
|
|
544
508
|
typedArrayToType,
|
|
545
509
|
TypedArrayType,
|
|
546
510
|
typedArrayTypeToTypedArrayConstructor,
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
511
|
+
isType_5 as isType,
|
|
512
|
+
box_5 as box,
|
|
513
|
+
revive_5 as revive
|
|
550
514
|
}
|
|
551
515
|
}
|
|
552
516
|
|