osra 0.2.9 → 0.2.11

package/build/index.d.ts

@@ -13,12 +13,12 @@ declare namespace arrayBuffer {
     export {
         type,
         isType,
-        box,
-        revive
+        box_2 as box,
+        revive_2 as revive
     }
 }
 
-declare type BidirectionalConnectionMessage = {
+export declare type BidirectionalConnectionMessage = {
     type: 'init';
     remoteUuid: Uuid;
     data: Capable;
@@ -39,7 +39,11 @@ declare type BidirectionalConnectionMessage = {
     portId: string;
 };
 
-declare const box: <T extends ArrayBuffer, T2 extends RevivableContext>(value: T, _context: T2) => {
+export declare const box: <T extends Capable, T2 extends RevivableContext>(value: T, context: T2) => ReplaceWithBox<T, T2["revivableModules"][number]>;
+
+declare const box_10: <T extends ReadableStream, T2 extends RevivableContext>(value: T, context: T2) => BoxedReadableStream<T>;
+
+declare const box_2: <T extends ArrayBuffer, T2 extends RevivableContext>(value: T, _context: T2) => {
     type: "arrayBuffer";
     __OSRA_BOX__: "revivable";
 } & (IsJsonOnlyTransport<T2["transport"]> extends true ? {
@@ -52,26 +56,26 @@ declare const box: <T extends ArrayBuffer, T2 extends RevivableContext>(value: T
     arrayBuffer: ArrayBuffer;
 });
 
-declare const box_2: <T extends Date, T2 extends RevivableContext>(value: T, _context: T2) => {
+declare const box_3: <T extends Date, T2 extends RevivableContext>(value: T, _context: T2) => {
     type: "date";
     ISOString: string;
     __OSRA_BOX__: "revivable";
 };
 
-declare const box_3: <T extends Headers, T2 extends RevivableContext>(value: T, _context: T2) => {
+declare const box_4: <T extends Headers, T2 extends RevivableContext>(value: T, _context: T2) => {
     type: "headers";
     entries: [string, string][];
     __OSRA_BOX__: "revivable";
 };
 
-declare const box_4: <T extends Error, T2 extends RevivableContext>(value: T, _context: T2) => {
+declare const box_5: <T extends Error, T2 extends RevivableContext>(value: T, _context: T2) => {
     type: "error";
     message: string;
     stack: string;
     __OSRA_BOX__: "revivable";
 };
 
-declare const box_5: <T extends TypedArray, T2 extends RevivableContext>(value: T, context: T2) => {
+declare const box_6: <T extends TypedArray, T2 extends RevivableContext>(value: T, context: T2) => {
     type: "typedArray";
     typedArrayType: string;
     __OSRA_BOX__: "revivable";
@@ -87,7 +91,7 @@ declare const box_5: <T extends TypedArray, T2 extends RevivableContext>(value:
     [UnderlyingType]: T;
 };
 
-declare const box_6: <T, T2 extends RevivableContext = RevivableContext>(value: StructurableTransferablePort<T>, context: T2) => ({
+declare const box_7: <T, T2 extends RevivableContext = RevivableContext>(value: StructurableTransferablePort<T>, context: T2) => ({
     type: "messagePort";
     portId: `${string}-${string}-${string}-${string}-${string}`;
     __OSRA_BOX__: "revivable";
@@ -101,11 +105,9 @@ declare const box_6: <T, T2 extends RevivableContext = RevivableContext>(value:
     [UnderlyingType]: StrictMessagePort<ExtractStructurableTransferable<T>>;
 });
 
-declare const box_7: <T, T2 extends RevivableContext>(value: CapablePromise<T>, context: T2) => BoxedPromise<ExtractCapable<T>>;
+declare const box_8: <T, T2 extends RevivableContext>(value: CapablePromise<T>, context: T2) => BoxedPromise<ExtractCapable<T>>;
 
-declare const box_8: <T extends (...args: any[]) => any, T2 extends RevivableContext>(value: T & CapableFunction<T>, context: T2) => BoxedFunction<T>;
-
-declare const box_9: <T extends ReadableStream, T2 extends RevivableContext>(value: T, context: T2) => BoxedReadableStream<T>;
+declare const box_9: <T extends (...args: any[]) => any, T2 extends RevivableContext>(value: T & CapableFunction<T>, context: T2) => BoxedFunction<T>;
 
 export declare const BoxBase: {
     readonly __OSRA_BOX__: "revivable";
@@ -133,7 +135,7 @@ declare type BoxedMessagePort<T extends StructurableTransferable = StructurableT
 declare type BoxedPromise<T extends Capable = Capable> = {
     __OSRA_BOX__: 'revivable';
     type: typeof type_6;
-    port: ReturnType<typeof box_6>;
+    port: ReturnType<typeof box_7>;
     [UnderlyingType]: T;
 };
 
@@ -151,7 +153,7 @@ MessagePort | string,
 Capable[]
 ];
 
-declare type Capable<TModules extends readonly RevivableModule[] = DefaultRevivableModules> = StructurableTransferable | InferRevivables<TModules> | {
+export declare type Capable<TModules extends readonly RevivableModule[] = DefaultRevivableModules> = StructurableTransferable | InferRevivables<TModules> | {
     [key: string]: Capable;
 } | Array<Capable> | Map<Capable, Capable> | Set<Capable>;
 
@@ -164,7 +166,7 @@ declare type CapablePromise<T> = T extends Capable ? Promise<T> : {
     __badType__: T;
 };
 
-declare type ConnectionMessage = BidirectionalConnectionMessage | UnidirectionalConnectionMessage;
+export declare type ConnectionMessage = BidirectionalConnectionMessage | UnidirectionalConnectionMessage;
 
 declare type Context = {
     type: 'resolve';
@@ -174,7 +176,15 @@ declare type Context = {
     error: string;
 };
 
-declare type CustomTransport = {
+export declare type CustomEmitTransport = Extract<CustomTransport, {
+    emit: any;
+}>;
+
+export declare type CustomReceiveTransport = Extract<CustomTransport, {
+    receive: any;
+}>;
+
+export declare type CustomTransport = {
     isJson?: boolean;
 } & ({
     receive: ReceivePlatformTransport | ((listener: (event: Message, messageContext: MessageContext) => void) => void);
@@ -189,25 +199,43 @@ declare namespace date {
     export {
         type_2 as type,
         isType_2 as isType,
-        box_2 as box,
-        revive_2 as revive
+        box_3 as box,
+        revive_3 as revive
     }
 }
 
-declare type DefaultRevivableModules = typeof defaultRevivableModules;
+declare type DeepReplaceWithBox<T, M> = [
+FindMatchingBox<T, M>
+] extends [never] ? (T extends Array<infer U> ? Array<DeepReplaceWithBox<U, M>> : T extends object ? {
+    [K in keyof T]: DeepReplaceWithBox<T[K], M>;
+} : T) : FindMatchingBox<T, M>;
+
+declare type DeepReplaceWithRevive<T, M> = [
+FindMatchingRevive<T, M>
+] extends [never] ? (T extends Array<infer U> ? Array<DeepReplaceWithRevive<U, M>> : T extends object ? {
+    [K in keyof T]: DeepReplaceWithRevive<T[K], M>;
+} : T) : FindMatchingRevive<T, M>;
+
+export declare type DefaultRevivableModule = DefaultRevivableModules[number];
+
+export declare type DefaultRevivableModules = typeof defaultRevivableModules;
 
-declare const defaultRevivableModules: readonly [typeof arrayBuffer, typeof date, typeof headers, typeof error, typeof typedArray, typeof promise, typeof func, typeof messagePort, typeof readableStream];
+export declare const defaultRevivableModules: readonly [typeof arrayBuffer, typeof date, typeof headers, typeof error, typeof typedArray, typeof promise, typeof func, typeof messagePort, typeof readableStream];
 
-declare type EmitJsonPlatformTransport = WebSocket | WebExtPort;
+export declare type EmitJsonPlatformTransport = WebSocket | WebExtPort;
 
-declare type EmitPlatformTransport = EmitJsonPlatformTransport | Window | ServiceWorker | Worker | SharedWorker | MessagePort;
+export declare type EmitPlatformTransport = EmitJsonPlatformTransport | Window | ServiceWorker | Worker | SharedWorker | MessagePort;
+
+export declare type EmitTransport = EmitPlatformTransport & Extract<CustomTransport, {
+    emit: any;
+}>;
 
 declare namespace error {
     export {
         type_4 as type,
         isType_4 as isType,
-        box_4 as box,
-        revive_4 as revive
+        box_5 as box,
+        revive_5 as revive
     }
 }
 
@@ -240,14 +268,26 @@ declare type ExtractType<T> = T extends {
     isType: (value: unknown) => value is infer S;
 } ? S : never;
 
+declare type FindMatchingBox<T, M> = M extends {
+    isType: (value: unknown) => value is infer S;
+    box: (...args: any[]) => infer B;
+} ? T extends S ? B : never : never;
+
+declare type FindMatchingRevive<T, M> = M extends {
+    box: (...args: any[]) => infer S;
+    revive: (...args: any[]) => infer R;
+} ? T extends S ? R : never : never;
+
+export declare const findModuleForValue: <T extends Capable, T2 extends RevivableContext>(value: T, context: T2) => ReplaceWithBox<T, T2["revivableModules"][number]>;
+
 declare namespace func {
     export {
         type_7 as type,
         CallContext,
         BoxedFunction,
         isType_7 as isType,
-        box_8 as box,
-        revive_7 as revive
+        box_9 as box,
+        revive_8 as revive
     }
 }
 
@@ -255,8 +295,8 @@ declare namespace headers {
     export {
         type_3 as type,
         isType_3 as isType,
-        box_3 as box,
-        revive_3 as revive
+        box_4 as box,
+        revive_4 as revive
     }
 }
 
@@ -282,11 +322,11 @@ declare const isType_8: (value: unknown) => value is MessagePort;
 
 declare const isType_9: (value: unknown) => value is ReadableStream;
 
-declare type Jsonable = boolean | null | number | string | {
+export declare type Jsonable = boolean | null | number | string | {
     [key: string]: Jsonable;
 } | Array<Jsonable>;
 
-declare type JsonPlatformTransport = {
+export declare type JsonPlatformTransport = {
     isJson: true;
 } | EmitJsonPlatformTransport | ReceiveJsonPlatformTransport;
 
@@ -313,9 +353,9 @@ declare const makeMessageChannelAllocator: () => {
     }) => AllocatedMessageChannel<StructurableTransferable, StructurableTransferable>;
 };
 
-declare type Message = MessageBase & MessageVariant;
+export declare type Message = MessageBase & MessageVariant;
 
-declare type MessageBase = {
+export declare type MessageBase = {
     [OSRA_KEY]: string;
     /** UUID of the client that sent the message */
     uuid: Uuid;
@@ -324,32 +364,37 @@ declare type MessageBase = {
 
 declare type MessageChannelAllocator = ReturnType<typeof makeMessageChannelAllocator>;
 
-declare type MessageContext = {
+export declare type MessageContext = {
     port?: MessagePort | WebExtPort;
     sender?: WebExtSender;
     receiveTransport?: ReceivePlatformTransport;
     source?: MessageEventSource | null;
 };
 
-declare type MessageEventMap = {
+export declare type MessageEventMap = {
     message: CustomEvent<Message>;
 };
 
 declare type MessageEventTarget_2 = TypedEventTarget<MessageEventMap>;
+export { MessageEventTarget_2 as MessageEventTarget }
 
 declare namespace messagePort {
     export {
         type_8 as type,
         BoxedMessagePort,
         isType_8 as isType,
-        box_6 as box,
-        revive_8 as revive
+        box_7 as box,
+        revive_9 as revive
     }
 }
 
-declare type MessageVariant = ProtocolMessage | ConnectionMessage;
+export declare type MessageVariant = ProtocolMessage | ConnectionMessage;
+
+export declare const OSRA_BOX: "__OSRA_BOX__";
+
+export declare const OSRA_DEFAULT_KEY: "__OSRA_DEFAULT_KEY__";
 
-declare const OSRA_KEY: "__OSRA_KEY__";
+export declare const OSRA_KEY: "__OSRA_KEY__";
 
 declare type PlatformCapabilities = {
     jsonOnly: boolean;
@@ -359,7 +404,7 @@ declare type PlatformCapabilities = {
     transferableStream: boolean;
 };
 
-declare type PlatformTransport = EmitPlatformTransport | ReceivePlatformTransport;
+export declare type PlatformTransport = EmitPlatformTransport | ReceivePlatformTransport;
 
 declare namespace promise {
     export {
@@ -367,12 +412,12 @@ declare namespace promise {
         Context,
         BoxedPromise,
         isType_6 as isType,
-        box_7 as box,
-        revive_6 as revive
+        box_8 as box,
+        revive_7 as revive
     }
 }
 
-declare type ProtocolMessage = {
+export declare type ProtocolMessage = {
     type: 'announce';
     /** Only set when acknowledging a remote announcement */
     remoteUuid?: Uuid;
@@ -395,14 +440,30 @@ declare namespace readableStream {
         PullContext,
         BoxedReadableStream,
         isType_9 as isType,
-        box_9 as box,
-        revive_9 as revive
+        box_10 as box,
+        revive_10 as revive
     }
 }
 
-declare type ReceiveJsonPlatformTransport = WebSocket | WebExtPort | WebExtOnConnect | WebExtOnMessage;
+export declare type ReceiveJsonPlatformTransport = WebSocket | WebExtPort | WebExtOnConnect | WebExtOnMessage;
+
+export declare type ReceivePlatformTransport = ReceiveJsonPlatformTransport | Window | ServiceWorker | Worker | SharedWorker | MessagePort;
+
+export declare type ReceiveTransport = ReceivePlatformTransport & Extract<CustomTransport, {
+    receive: any;
+}>;
+
+export declare const recursiveBox: <T extends Capable, T2 extends RevivableContext>(value: T, context: T2) => DeepReplaceWithBox<T, T2["revivableModules"][number]>;
+
+export declare const recursiveRevive: <T extends Capable, T2 extends RevivableContext>(value: T, context: T2) => DeepReplaceWithRevive<T, T2["revivableModules"][number]>;
 
-declare type ReceivePlatformTransport = ReceiveJsonPlatformTransport | Window | ServiceWorker | Worker | SharedWorker | MessagePort;
+declare type ReplaceWithBox<T, M> = [
+FindMatchingBox<T, M>
+] extends [never] ? T : FindMatchingBox<T, M>;
+
+declare type ReplaceWithRevive<T, M> = [
+FindMatchingRevive<T, M>
+] extends [never] ? T : FindMatchingRevive<T, M>;
 
 declare type RevivableContext<TModules extends readonly RevivableModule[] = DefaultRevivableModules> = {
     platformCapabilities: PlatformCapabilities;
@@ -415,30 +476,32 @@ declare type RevivableContext<TModules extends readonly RevivableModule[] = Defa
     eventTarget: MessageEventTarget_2;
 };
 
-declare type RevivableModule<T extends string = string, T2 = any, T3 extends BoxBase<T> = any> = {
+export declare type RevivableModule<T extends string = string, T2 = any, T3 extends BoxBase<T> = any> = {
     readonly type: T;
     readonly isType: (value: unknown) => value is T2;
     readonly box: ((value: T2, context: RevivableContext) => T3) | ((...args: any[]) => any);
     readonly revive: (value: T3, context: RevivableContext) => T2;
 };
 
-declare const revive: <T extends ReturnType<typeof box>, T2 extends RevivableContext>(value: T, _context: T2) => ArrayBuffer;
+export declare const revive: <T extends ReturnType<typeof box>, T2 extends RevivableContext>(value: T, context: T2) => ReplaceWithRevive<T, T2["revivableModules"][number]>;
+
+declare const revive_10: <T extends BoxedReadableStream, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
 
-declare const revive_2: <T extends ReturnType<typeof box_2>, T2 extends RevivableContext>(value: T, _context: T2) => Date;
+declare const revive_2: <T extends ReturnType<typeof box_2>, T2 extends RevivableContext>(value: T, _context: T2) => ArrayBuffer;
 
-declare const revive_3: <T extends ReturnType<typeof box_3>, T2 extends RevivableContext>(value: T, _context: T2) => Headers;
+declare const revive_3: <T extends ReturnType<typeof box_3>, T2 extends RevivableContext>(value: T, _context: T2) => Date;
 
-declare const revive_4: <T extends ReturnType<typeof box_4>, T2 extends RevivableContext>(value: T, _context: T2) => Error;
+declare const revive_4: <T extends ReturnType<typeof box_4>, T2 extends RevivableContext>(value: T, _context: T2) => Headers;
 
-declare const revive_5: <T extends ReturnType<typeof box_5>, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
+declare const revive_5: <T extends ReturnType<typeof box_5>, T2 extends RevivableContext>(value: T, _context: T2) => Error;
 
-declare const revive_6: <T extends BoxedPromise, T2 extends RevivableContext>(value: T, context: T2) => Promise<T[typeof UnderlyingType]>;
+declare const revive_6: <T extends ReturnType<typeof box_6>, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
 
-declare const revive_7: <T extends BoxedFunction, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
+declare const revive_7: <T extends BoxedPromise, T2 extends RevivableContext>(value: T, context: T2) => Promise<T[typeof UnderlyingType]>;
 
-declare const revive_8: <T extends StructurableTransferable, T2 extends RevivableContext>(value: BoxedMessagePort<T>, context: T2) => StrictMessagePort<T>;
+declare const revive_8: <T extends BoxedFunction, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
 
-declare const revive_9: <T extends BoxedReadableStream, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
+declare const revive_9: <T extends StructurableTransferable, T2 extends RevivableContext>(value: BoxedMessagePort<T>, context: T2) => StrictMessagePort<T>;
 
 /**
  * A type-safe MessagePort wrapper that provides generic typing for messages.
@@ -461,13 +524,13 @@ declare type StrictMessagePortEventMap<T = unknown> = {
     'messageerror': MessageEvent;
 };
 
-declare type Structurable = Jsonable
+export declare type Structurable = Jsonable
 /** not really structureable but here for convenience */
 | void | undefined | BigInt | Date | RegExp | Blob | File | FileList | ArrayBuffer | ArrayBufferView | ImageBitmap | ImageData | {
     [key: string]: Structurable;
 } | Array<Structurable> | Map<Structurable, Structurable> | Set<Structurable>;
 
-declare type StructurableTransferable = Structurable | Transferable | {
+export declare type StructurableTransferable = Structurable | Transferable | {
     [key: string]: StructurableTransferable;
 } | Array<StructurableTransferable> | Map<StructurableTransferable, StructurableTransferable> | Set<StructurableTransferable>;
 
@@ -478,7 +541,7 @@ declare type StructurableTransferablePort<T> = T extends StructurableTransferabl
     __badType__: T;
 };
 
-declare type Transport = PlatformTransport | CustomTransport;
+export declare type Transport = PlatformTransport | CustomTransport;
 
 declare const type: "arrayBuffer";
 
@@ -509,8 +572,8 @@ declare namespace typedArray {
         TypedArrayType,
         typedArrayTypeToTypedArrayConstructor,
         isType_5 as isType,
-        box_5 as box,
-        revive_5 as revive
+        box_6 as box,
+        revive_6 as revive
     }
 }
 
@@ -530,14 +593,14 @@ export declare const UnderlyingType: unique symbol;
 
 export declare type UnderlyingType = typeof UnderlyingType;
 
-declare type UnidirectionalConnectionMessage = {
+export declare type UnidirectionalConnectionMessage = {
     type: 'message';
     remoteUuid: Uuid;
     data: Capable;
     portId: Uuid;
 };
 
-declare type Uuid = `${string}-${string}-${string}-${string}-${string}`;
+export declare type Uuid = `${string}-${string}-${string}-${string}-${string}`;
 
 declare type WebExtOnConnect = WebExtRuntime['onConnect'];