osra 0.2.13 → 0.3.0

package/build/connections/bidirectional.d.ts

@@ -0,0 +1,53 @@
+import type { Transport } from '../utils/transport';
+import type { DefaultRevivableModules, RevivableModule } from '../revivables';
+import type { DeepReplaceWithBox } from '../utils/replace';
+import type { ProtocolContext } from './utils';
+import type { Capable, MessageEventTarget, MessageFields, Uuid } from '../types';
+export declare const type: 'bidirectional';
+export type InitMessage<TModules extends readonly RevivableModule[] = DefaultRevivableModules, T extends Capable<TModules> = Capable<TModules>> = {
+    type: 'init';
+    remoteUuid: Uuid;
+    data: DeepReplaceWithBox<T, TModules[number]>;
+};
+export declare const Messages: <TModules extends readonly RevivableModule[] = DefaultRevivableModules, T extends Capable<TModules> = Capable<TModules>>(modules: TModules, value: T) => InitMessage<TModules, T>;
+export type Messages<TModules extends readonly RevivableModule[] = DefaultRevivableModules, T extends Capable<TModules> = Capable<TModules>> = ReturnType<typeof Messages<TModules, T>>;
+export type ConnectionContext<TModules extends readonly RevivableModule[] = DefaultRevivableModules> = {
+    type: 'bidirectional';
+    eventTarget: MessageEventTarget<TModules>;
+    connection: BidirectionalConnection<TModules>;
+};
+export type ConnectionRevivableContext<TModules extends readonly RevivableModule[] = DefaultRevivableModules> = {
+    transport: Transport;
+    remoteUuid: Uuid;
+    sendMessage: (message: MessageFields & Record<string, unknown>) => void;
+    revivableModules: TModules;
+    eventTarget: MessageEventTarget<TModules>;
+};
+export declare const startBidirectionalConnection: <TModules extends readonly RevivableModule[] = readonly [typeof import("../revivables/transfer"), typeof import("../revivables/identity"), typeof import("../revivables/array-buffer"), typeof import("../revivables/date"), typeof import("../revivables/headers"), typeof import("../revivables/error"), typeof import("../revivables/typed-array"), typeof import("../revivables/promise"), typeof import("../revivables/function"), typeof import("../revivables/message-port"), typeof import("../revivables/readable-stream"), typeof import("../revivables/abort-signal"), typeof import("../revivables/response"), typeof import("../revivables/request"), typeof import("../revivables/map"), typeof import("../revivables/set"), typeof import("../revivables/bigint"), typeof import("../revivables/event-target")]>({ transport, value, remoteUuid, eventTarget, send, revivableModules }: {
+    transport: Transport;
+    value: Capable<TModules>;
+    remoteUuid: Uuid;
+    eventTarget: MessageEventTarget<TModules>;
+    send: (message: MessageFields & Record<string, unknown>) => void;
+    revivableModules: TModules;
+}) => {
+    revivableContext: {
+        transport: Transport;
+        remoteUuid: `${string}-${string}-${string}-${string}-${string}`;
+        sendMessage: (message: MessageFields & Record<string, unknown>) => void;
+        eventTarget: MessageEventTarget<TModules>;
+        revivableModules: TModules;
+    };
+    remoteValue: Promise<any>;
+};
+export type BidirectionalConnection<TModules extends readonly RevivableModule[] = DefaultRevivableModules> = {
+    revivableContext: ConnectionRevivableContext<TModules>;
+    remoteValue: Promise<Capable>;
+};
+/**
+ * init() — mounts the bidirectional mode on the shared protocol context.
+ * Only activates when the transport can both emit and receive. Owns the
+ * announce / close handshake and routes per-connection messages (init /
+ * message / message-port-close) to the right connection's eventTarget.
+ */
+export declare const init: <TModules extends readonly RevivableModule[]>(ctx: ProtocolContext<TModules>) => void;

package/build/connections/index.d.ts

@@ -0,0 +1,20 @@
+import type { DefaultRevivableModules, RevivableModule } from '../revivables';
+import type { ConnectionContext as BidirectionalConnectionContext } from './bidirectional';
+import type { ProtocolContext, StartConnectionsOptions } from '../utils';
+import type { Capable } from '../types';
+import * as bidirectional from './bidirectional';
+export * from './bidirectional';
+export * from './utils';
+export type ConnectionModule<T> = {
+    readonly type: string;
+    readonly init: (ctx: ProtocolContext<any>) => void;
+    readonly Messages?: T;
+};
+export declare const connections: readonly [typeof bidirectional];
+export type DefaultConnectionModules = typeof connections;
+export type DefaultConnectionModule = DefaultConnectionModules[number];
+export type ConnectionMessage<TModules extends readonly RevivableModule[] = DefaultRevivableModules, T extends Capable<TModules> = Capable<TModules>> = DefaultConnectionModule extends {
+    Messages: (modules: TModules, value: T) => infer R;
+} ? R : never;
+export type ConnectionContext<TModules extends readonly RevivableModule[] = DefaultRevivableModules> = BidirectionalConnectionContext<TModules>;
+export declare const startConnections: <T = unknown, const TUserModules extends readonly RevivableModule[] = readonly []>(value: Capable<[...DefaultRevivableModules, ...TUserModules]>, { transport: _transport, name, remoteName, key, origin, unregisterSignal, revivableModules: _userRevivableModules }: StartConnectionsOptions<TUserModules>) => Promise<T>;

package/build/connections/utils.d.ts

@@ -0,0 +1,31 @@
+import type { Message, MessageVariant, Uuid, Capable, MessageEventMap } from '../types';
+import type { DefaultRevivableModules, RevivableModule } from '../revivables';
+import type { Transport } from '../utils/transport';
+import type { ConnectionContext } from '.';
+import type { TypedEventTarget } from '../utils/typed-event-target';
+export declare const normalizeTransport: (transport: Transport) => Transport;
+export declare const mergeRevivableModules: <TUserModules extends readonly RevivableModule[]>(userModules: TUserModules | undefined) => readonly (typeof import("../revivables/array-buffer") | typeof import("../revivables/date") | typeof import("../revivables/headers") | typeof import("../revivables/error") | typeof import("../revivables/typed-array") | typeof import("../revivables/transfer") | typeof import("../revivables/message-port") | typeof import("../revivables/promise") | typeof import("../revivables/function") | typeof import("../revivables/readable-stream") | typeof import("../revivables/abort-signal") | typeof import("../revivables/response") | typeof import("../revivables/request") | typeof import("../revivables/identity") | typeof import("../revivables/map") | typeof import("../revivables/set") | typeof import("../revivables/bigint") | typeof import("../revivables/event-target"))[] | readonly [...(typeof import("../revivables/array-buffer") | typeof import("../revivables/date") | typeof import("../revivables/headers") | typeof import("../revivables/error") | typeof import("../revivables/typed-array") | typeof import("../revivables/transfer") | typeof import("../revivables/message-port") | typeof import("../revivables/promise") | typeof import("../revivables/function") | typeof import("../revivables/readable-stream") | typeof import("../revivables/abort-signal") | typeof import("../revivables/response") | typeof import("../revivables/request") | typeof import("../revivables/identity") | typeof import("../revivables/map") | typeof import("../revivables/set") | typeof import("../revivables/bigint") | typeof import("../revivables/event-target"))[], ...TUserModules];
+export type ProtocolEventMap<TModules extends readonly RevivableModule[] = DefaultRevivableModules> = {
+    message: CustomEvent<Message<TModules>>;
+};
+export type ProtocolEventTarget<TModules extends readonly RevivableModule[] = DefaultRevivableModules> = TypedEventTarget<ProtocolEventMap<TModules>>;
+export type ProtocolContext<TModules extends readonly RevivableModule[] = DefaultRevivableModules> = {
+    transport: Transport;
+    value: Capable<TModules>;
+    revivableModules: TModules;
+    connectionContexts: Map<string, ConnectionContext<TModules>>;
+    getUuid: () => Uuid;
+    sendMessage: (message: MessageVariant) => void;
+    protocolEventTarget: ProtocolEventTarget<TModules>;
+    resolveRemoteValue: (value: Capable<TModules>) => void;
+    createConnectionEventTarget: () => TypedEventTarget<MessageEventMap<TModules>>;
+};
+export type StartConnectionsOptions<TUserModules extends readonly RevivableModule[] = readonly []> = {
+    transport: Transport;
+    name?: string;
+    remoteName?: string;
+    key?: string;
+    origin?: string;
+    unregisterSignal?: AbortSignal;
+    revivableModules?: TUserModules;
+};