osra 0.2.6 → 0.2.7

package/build/index.d.ts

@@ -52,26 +52,33 @@ 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_10: <T extends ReadableStream, T2 extends RevivableContext>(value: T, context: T2) => BoxedReadableStream<T>;
+
+declare const box_2: <T extends MessageContext, T2 extends RevivableContext>(_value: T, _context: T2) => {
+    type: "context";
+    __OSRA_BOX__: "revivable";
+};
+
+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 +94,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 +108,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 extends (...args: any[]) => any, T2 extends RevivableContext>(value: T & CapableFunction<T>, context: T2) => BoxedFunction<T>;
+declare const box_8: <T, T2 extends RevivableContext>(value: CapablePromise<T>, context: T2) => BoxedPromise<ExtractCapable<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";
@@ -116,13 +121,13 @@ export declare type BoxBase<T extends string = string> = typeof BoxBase & {
     type: T;
 };
 
-declare type BoxedFunction<T extends (...args: any[]) => any = (...args: any[]) => any> = BoxBase<typeof type_7> & {
+declare type BoxedFunction<T extends (...args: any[]) => any = (...args: any[]) => any> = BoxBase<typeof type_8> & {
     port: BoxedMessagePort;
 } & {
     [UnderlyingType]: (...args: Parameters<T>) => Promise<Awaited<ReturnType<T>>>;
 };
 
-declare type BoxedMessagePort<T extends StructurableTransferable = StructurableTransferable> = BoxBase<typeof type_8> & ({
+declare type BoxedMessagePort<T extends StructurableTransferable = StructurableTransferable> = BoxBase<typeof type_9> & ({
     portId: string;
 } | {
     port: StrictMessagePort<T>;
@@ -132,14 +137,14 @@ 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>;
+    type: typeof type_7;
+    port: ReturnType<typeof box_7>;
     [UnderlyingType]: T;
 };
 
 declare type BoxedReadableStream<T extends ReadableStream = ReadableStream> = {
     __OSRA_BOX__: 'revivable';
-    type: typeof type_9;
+    type: typeof type_10;
     port: BoxedMessagePort;
     [UnderlyingType]: T;
 };
@@ -174,6 +179,16 @@ declare type Context = {
     error: string;
 };
 
+declare namespace context {
+    export {
+        type_2 as type,
+        OSRA_CONTEXT,
+        isType_2 as isType,
+        box_2 as box,
+        revive_2 as revive
+    }
+}
+
 declare type CustomTransport = {
     isJson?: boolean;
 } & ({
@@ -187,16 +202,16 @@ declare type CustomTransport = {
 
 declare namespace date {
     export {
-        type_2 as type,
-        isType_2 as isType,
-        box_2 as box,
-        revive_2 as revive
+        type_3 as type,
+        isType_3 as isType,
+        box_3 as box,
+        revive_3 as revive
     }
 }
 
 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];
+declare const defaultRevivableModules: readonly [typeof arrayBuffer, typeof context, typeof date, typeof headers, typeof error, typeof typedArray, typeof promise, typeof func, typeof messagePort, typeof readableStream];
 
 declare type EmitJsonPlatformTransport = WebSocket | WebExtPort;
 
@@ -204,10 +219,10 @@ declare type EmitPlatformTransport = EmitJsonPlatformTransport | Window | Servic
 
 declare namespace error {
     export {
-        type_4 as type,
-        isType_4 as isType,
-        box_4 as box,
-        revive_4 as revive
+        type_5 as type,
+        isType_5 as isType,
+        box_5 as box,
+        revive_5 as revive
     }
 }
 
@@ -242,21 +257,21 @@ declare type ExtractType<T> = T extends {
 
 declare namespace func {
     export {
-        type_7 as type,
+        type_8 as type,
         CallContext,
         BoxedFunction,
-        isType_7 as isType,
-        box_8 as box,
-        revive_7 as revive
+        isType_8 as isType,
+        box_9 as box,
+        revive_8 as revive
     }
 }
 
 declare namespace headers {
     export {
-        type_3 as type,
-        isType_3 as isType,
-        box_3 as box,
-        revive_3 as revive
+        type_4 as type,
+        isType_4 as isType,
+        box_4 as box,
+        revive_4 as revive
     }
 }
 
@@ -266,21 +281,23 @@ declare type IsJsonOnlyTransport<T extends Transport> = T extends JsonPlatformTr
 
 declare const isType: (value: unknown) => value is ArrayBuffer;
 
-declare const isType_2: (value: unknown) => value is Date;
+declare const isType_10: (value: unknown) => value is ReadableStream;
+
+declare const isType_2: (value: unknown) => value is MessageContext;
 
-declare const isType_3: (value: unknown) => value is Headers;
+declare const isType_3: (value: unknown) => value is Date;
 
-declare const isType_4: (value: unknown) => value is Error;
+declare const isType_4: (value: unknown) => value is Headers;
 
-declare const isType_5: (value: unknown) => value is TypedArray;
+declare const isType_5: (value: unknown) => value is Error;
 
-declare const isType_6: (value: unknown) => value is Promise<any>;
+declare const isType_6: (value: unknown) => value is TypedArray;
 
-declare const isType_7: (value: unknown) => value is (...args: any[]) => any;
+declare const isType_7: (value: unknown) => value is Promise<any>;
 
-declare const isType_8: (value: unknown) => value is MessagePort;
+declare const isType_8: (value: unknown) => value is (...args: any[]) => any;
 
-declare const isType_9: (value: unknown) => value is ReadableStream;
+declare const isType_9: (value: unknown) => value is MessagePort;
 
 declare type Jsonable = boolean | null | number | string | {
     [key: string]: Jsonable;
@@ -324,31 +341,44 @@ 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 MessageEventDetail = {
+    message: Message;
+    messageContext: MessageContext;
+};
+
 declare type MessageEventMap = {
-    message: CustomEvent<Message>;
+    message: CustomEvent<MessageEventDetail>;
 };
 
 declare type MessageEventTarget_2 = TypedEventTarget<MessageEventMap>;
 
 declare namespace messagePort {
     export {
-        type_8 as type,
+        type_9 as type,
         BoxedMessagePort,
-        isType_8 as isType,
-        box_6 as box,
-        revive_8 as revive
+        isType_9 as isType,
+        box_7 as box,
+        revive_9 as revive
     }
 }
 
 declare type MessageVariant = ProtocolMessage | ConnectionMessage;
 
+/**
+ * A special token that gets transformed into the MessageContext when revived on the receiving side.
+ * Pass this value in your exposed API to receive information about the message context.
+ *
+ * Typed as MessageContext so it can be passed directly where MessageContext is expected.
+ */
+export declare const OSRA_CONTEXT: MessageContext;
+
 declare const OSRA_KEY: "__OSRA_KEY__";
 
 declare type PlatformCapabilities = {
@@ -363,12 +393,12 @@ declare type PlatformTransport = EmitPlatformTransport | ReceivePlatformTranspor
 
 declare namespace promise {
     export {
-        type_6 as type,
+        type_7 as type,
         Context,
         BoxedPromise,
-        isType_6 as isType,
-        box_7 as box,
-        revive_6 as revive
+        isType_7 as isType,
+        box_8 as box,
+        revive_7 as revive
     }
 }
 
@@ -391,12 +421,12 @@ declare type PullContext = {
 
 declare namespace readableStream {
     export {
-        type_9 as type,
+        type_10 as type,
         PullContext,
         BoxedReadableStream,
-        isType_9 as isType,
-        box_9 as box,
-        revive_9 as revive
+        isType_10 as isType,
+        box_10 as box,
+        revive_10 as revive
     }
 }
 
@@ -413,6 +443,8 @@ declare type RevivableContext<TModules extends readonly RevivableModule[] = Defa
     sendMessage: (message: ConnectionMessage) => void;
     revivableModules: TModules;
     eventTarget: MessageEventTarget_2;
+    /** MessageContext of the message being revived, used by OSRA_CONTEXT revivable */
+    messageContext?: MessageContext;
 };
 
 declare type RevivableModule<T extends string = string, T2 = any, T3 extends BoxBase<T> = any> = {
@@ -424,21 +456,23 @@ declare type RevivableModule<T extends string = string, T2 = any, T3 extends Box
 
 declare const revive: <T extends ReturnType<typeof box>, T2 extends RevivableContext>(value: T, _context: T2) => ArrayBuffer;
 
-declare const revive_2: <T extends ReturnType<typeof box_2>, T2 extends RevivableContext>(value: T, _context: T2) => Date;
+declare const revive_10: <T extends BoxedReadableStream, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
 
-declare const revive_3: <T extends ReturnType<typeof box_3>, T2 extends RevivableContext>(value: T, _context: T2) => Headers;
+declare const revive_2: <T extends ReturnType<typeof box_2>, T2 extends RevivableContext>(_value: T, context: T2) => MessageContext;
 
-declare const revive_4: <T extends ReturnType<typeof box_4>, T2 extends RevivableContext>(value: T, _context: T2) => Error;
+declare const revive_3: <T extends ReturnType<typeof box_3>, T2 extends RevivableContext>(value: T, _context: T2) => Date;
 
-declare const revive_5: <T extends ReturnType<typeof box_5>, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
+declare const revive_4: <T extends ReturnType<typeof box_4>, T2 extends RevivableContext>(value: T, _context: T2) => Headers;
 
-declare const revive_6: <T extends BoxedPromise, T2 extends RevivableContext>(value: T, context: T2) => Promise<T[typeof UnderlyingType]>;
+declare const revive_5: <T extends ReturnType<typeof box_5>, T2 extends RevivableContext>(value: T, _context: T2) => Error;
 
-declare const revive_7: <T extends BoxedFunction, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
+declare const revive_6: <T extends ReturnType<typeof box_6>, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
 
-declare const revive_8: <T extends StructurableTransferable, T2 extends RevivableContext>(value: BoxedMessagePort<T>, context: T2) => StrictMessagePort<T>;
+declare const revive_7: <T extends BoxedPromise, T2 extends RevivableContext>(value: T, context: T2) => Promise<T[typeof UnderlyingType]>;
 
-declare const revive_9: <T extends BoxedReadableStream, T2 extends RevivableContext>(value: T, context: T2) => T[UnderlyingType];
+declare const revive_8: <T extends BoxedFunction, 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.
@@ -482,35 +516,37 @@ declare type Transport = PlatformTransport | CustomTransport;
 
 declare const type: "arrayBuffer";
 
-declare const type_2: "date";
+declare const type_10: "readableStream";
+
+declare const type_2: "context";
 
-declare const type_3: "headers";
+declare const type_3: "date";
 
-declare const type_4: "error";
+declare const type_4: "headers";
 
-declare const type_5: "typedArray";
+declare const type_5: "error";
 
-declare const type_6: "promise";
+declare const type_6: "typedArray";
 
-declare const type_7: "function";
+declare const type_7: "promise";
 
-declare const type_8: "messagePort";
+declare const type_8: "function";
 
-declare const type_9: "readableStream";
+declare const type_9: "messagePort";
 
 declare type TypedArray = typeof typedArrays[number];
 
 declare namespace typedArray {
     export {
-        type_5 as type,
+        type_6 as type,
         TypedArrayConstructor,
         TypedArray,
         typedArrayToType,
         TypedArrayType,
         typedArrayTypeToTypedArrayConstructor,
-        isType_5 as isType,
-        box_5 as box,
-        revive_5 as revive
+        isType_6 as isType,
+        box_6 as box,
+        revive_6 as revive
     }
 }