@holo-js/broadcast 0.1.3

package/dist/index.d.ts

@@ -0,0 +1,177 @@
+import { BroadcastChannelAuthRuntimeBindings, BroadcastRuntimeBindings, BroadcastDriver, RegisteredBroadcastDriver, RegisterBroadcastDriverOptions, channel, defineBroadcast, defineChannel, presenceChannel, privateChannel } from './contracts.js';
+export { BroadcastAuthEndpointBody, BroadcastAuthEndpointErrorBody, BroadcastAuthEndpointOptions, BroadcastAuthEndpointPayload, BroadcastAuthEndpointSuccessBody, BroadcastAuthorizeResult, BroadcastChannelAuthFailure, BroadcastChannelAuthRequest, BroadcastChannelAuthResult, BroadcastChannelAuthSuccess, BroadcastChannelTarget, BroadcastChannelType, BroadcastChannelsFor, BroadcastDefinition, BroadcastDefinitionInput, BroadcastDelayValue, BroadcastDispatchOptions, BroadcastDriverExecutionContext, BroadcastDriverName, BroadcastJsonObject, BroadcastJsonPrimitive, BroadcastJsonValue, BroadcastPayloadFor, BroadcastQueueOptions, BroadcastRuntimeFacade, BroadcastSendInput, BroadcastSendResult, BroadcastTargetParamInput, BroadcastWhisperDefinitions, BroadcastWhisperSchema, BroadcastWhisperValidationResult, BuiltInBroadcastDriverRegistry, ChannelDefinition, ChannelDefinitionFor, ChannelDefinitionInput, ChannelPatternParams, ChannelPresenceMemberFor, ChannelWhisperPayloadFor, ExportedBroadcastDefinition, ExportedChannelDefinition, GeneratedBroadcastManifest, GeneratedBroadcastManifestChannel, GeneratedBroadcastManifestEvent, GeneratedChannelAuthRegistryEntry, HoloBroadcastDriverRegistry, HoloBroadcastRegistry, HoloChannelRegistry, InferBroadcastWhisperPayload, InferChannelPresenceMember, InferChannelWhisperPayload, InferSchemaOutput, PendingBroadcastDispatch, RawBroadcastSendInput, ResolvedRawBroadcastSendInput, broadcastInternals, isBroadcastDefinition, isChannelDefinition } from './contracts.js';
+import { authorizeBroadcastChannel, parseBroadcastAuthEndpointPayload, renderBroadcastAuthResponse, resolveBroadcastWhisperSchema, validateBroadcastWhisperPayload } from './auth.js';
+export { broadcastAuthInternals } from './auth.js';
+import { NormalizedHoloBroadcastConfig, NormalizedHoloQueueConfig, NormalizedHoloRedisConfig } from '@holo-js/config';
+export { HoloBroadcastConfig, NormalizedHoloBroadcastConfig, defineBroadcastConfig } from '@holo-js/config';
+import { broadcast, broadcastRaw, configureBroadcastRuntime, getBroadcastRuntime, getBroadcastRuntimeBindings, resetBroadcastRuntime } from './runtime.js';
+export { broadcastRuntimeInternals } from './runtime.js';
+import '@holo-js/validation';
+
+type WorkerConnectionInfo = {
+    readonly socketId: string;
+    readonly app: BroadcastWorkerApp;
+    readonly headers: Headers;
+};
+type WorkerWebSocketConnection = WorkerConnectionInfo & {
+    readonly send: (payload: string) => void;
+    readonly close: (code?: number, reason?: string) => void;
+};
+type PublishBody = {
+    readonly name: string;
+    readonly channels: readonly string[];
+    readonly data: string;
+    readonly socket_id?: string;
+};
+type BroadcastWorkerApp = {
+    readonly connection: string;
+    readonly appId: string;
+    readonly key: string;
+    readonly secret: string;
+    readonly authEndpoint?: string;
+};
+type PresenceMember = Readonly<Record<string, unknown>>;
+type WorkerRuntimeOptions = {
+    readonly config: NormalizedHoloBroadcastConfig;
+    readonly channelAuth?: BroadcastChannelAuthRuntimeBindings;
+    readonly fetch?: typeof fetch;
+    readonly now?: () => number;
+    readonly scaling?: BroadcastWorkerScalingRuntime;
+    readonly scalingAutoSubscribe?: boolean;
+    readonly scalingUnsubscribe?: () => Promise<void> | void;
+};
+interface BroadcastWorkerRuntime {
+    readonly fetch: (request: Request) => Promise<Response>;
+    readonly connectWebSocket: (connection: WorkerWebSocketConnection) => void;
+    readonly receiveWebSocketMessage: (socketId: string, rawMessage: string) => Promise<void>;
+    readonly receiveScalingMessage: (payload: string) => Promise<void>;
+    readonly disconnectWebSocket: (socketId: string) => void;
+    readonly getStats: () => BroadcastWorkerStats;
+    readonly close: () => Promise<void>;
+}
+interface BroadcastWorkerStats {
+    readonly nodeId: string;
+    readonly uptimeMs: number;
+    readonly apps: readonly string[];
+    readonly appScopes: readonly {
+        readonly connection: string;
+        readonly appId: string;
+        readonly key: string;
+    }[];
+    readonly connectionCount: number;
+    readonly subscribedChannelCount: number;
+    readonly presenceChannelCount: number;
+    readonly scaling: false | {
+        readonly driver: 'redis';
+        readonly connection: string;
+        readonly eventChannel: string;
+    };
+}
+interface StartedBroadcastWorker {
+    readonly host: string;
+    readonly port: number;
+    readonly stop: () => Promise<void>;
+}
+type BroadcastRedisScalingConnection = {
+    readonly url?: string;
+    readonly clusters?: readonly {
+        readonly url?: string;
+        readonly host: string;
+        readonly port: number;
+    }[];
+    readonly host: string;
+    readonly port: number;
+    readonly username?: string;
+    readonly password?: string;
+    readonly db: number;
+};
+type BroadcastScalingAdapter = {
+    publish(channel: string, payload: string): Promise<void>;
+    subscribe(channel: string, onMessage: (payload: string) => void): Promise<() => Promise<void> | void>;
+    hashSet(key: string, field: string, value: string): Promise<void>;
+    hashDelete(key: string, field: string): Promise<void>;
+    hashGetAll(key: string): Promise<Readonly<Record<string, string>>>;
+    close(): Promise<void>;
+};
+type BroadcastWorkerScalingRuntime = {
+    readonly driver: 'redis';
+    readonly connection: string;
+    readonly nodeId: string;
+    readonly eventChannel: string;
+    readonly adapter: BroadcastScalingAdapter;
+};
+declare function parseSocketMessage(rawMessage: string): {
+    readonly event: string;
+    readonly channel?: string;
+    readonly data: Record<string, unknown>;
+};
+declare function normalizePublishBody(value: unknown): PublishBody;
+declare function createPusherSignature(secret: string, method: string, pathname: string, params: URLSearchParams): string;
+declare function parseChannelKind(channel: string): {
+    readonly kind: 'public' | 'private' | 'presence';
+    readonly canonical: string;
+};
+declare function createSocketId(): string;
+declare function createScalingNodeId(): string;
+declare function resolveScalingEventChannel(connection: string): string;
+declare function parsePresenceHashMembers(values: Readonly<Record<string, string>>): Map<string, PresenceMember>;
+declare function resolveRedisScalingConnection(queueConfig: NormalizedHoloQueueConfig | undefined, connectionName: string, redisConfig?: NormalizedHoloRedisConfig): BroadcastRedisScalingConnection;
+declare function createRedisScalingAdapter(connection: BroadcastRedisScalingConnection, dependencies?: {
+    readonly loadRedisModule?: () => Promise<unknown>;
+}): Promise<BroadcastScalingAdapter>;
+declare function buildWorkerApps(config: NormalizedHoloBroadcastConfig): Readonly<Record<string, BroadcastWorkerApp>>;
+declare function createBroadcastWorkerRuntime(options: WorkerRuntimeOptions): BroadcastWorkerRuntime;
+declare function startBroadcastWorker(runtimeBindings: Pick<BroadcastRuntimeBindings, 'config' | 'channelAuth'> & {
+    readonly queue?: NormalizedHoloQueueConfig;
+    readonly redis?: NormalizedHoloRedisConfig;
+    readonly nodeId?: string;
+    readonly fetch?: typeof fetch;
+    readonly createScalingAdapter?: (connection: BroadcastRedisScalingConnection) => Promise<BroadcastScalingAdapter>;
+    readonly loadRedisModule?: () => Promise<unknown>;
+    readonly loadWebSocketModule?: () => Promise<unknown>;
+}): Promise<StartedBroadcastWorker>;
+declare const workerInternals: {
+    buildWorkerApps: typeof buildWorkerApps;
+    createScalingNodeId: typeof createScalingNodeId;
+    createRedisScalingAdapter: typeof createRedisScalingAdapter;
+    createPusherSignature: typeof createPusherSignature;
+    createSocketId: typeof createSocketId;
+    resolveRedisScalingConnection: typeof resolveRedisScalingConnection;
+    resolveScalingEventChannel: typeof resolveScalingEventChannel;
+    normalizePublishBody: typeof normalizePublishBody;
+    parseChannelKind: typeof parseChannelKind;
+    parsePresenceHashMembers: typeof parsePresenceHashMembers;
+    parseSocketMessage: typeof parseSocketMessage;
+};
+
+declare function normalizeDriverName(name: string): string;
+declare function registerBroadcastDriver(name: string, driver: BroadcastDriver, options?: RegisterBroadcastDriverOptions): RegisteredBroadcastDriver;
+declare function getRegisteredBroadcastDriver(name: string): BroadcastDriver | undefined;
+declare function listRegisteredBroadcastDrivers(): readonly RegisteredBroadcastDriver[];
+declare function resetBroadcastDriverRegistry(): void;
+declare const broadcastRegistryInternals: {
+    normalizeDriverName: typeof normalizeDriverName;
+};
+
+declare const broadcastPackage: Readonly<{
+    authorizeBroadcastChannel: typeof authorizeBroadcastChannel;
+    broadcast: typeof broadcast;
+    broadcastRaw: typeof broadcastRaw;
+    channel: typeof channel;
+    configureBroadcastRuntime: typeof configureBroadcastRuntime;
+    defineBroadcast: typeof defineBroadcast;
+    defineChannel: typeof defineChannel;
+    getBroadcastRuntime: typeof getBroadcastRuntime;
+    getBroadcastRuntimeBindings: typeof getBroadcastRuntimeBindings;
+    parseBroadcastAuthEndpointPayload: typeof parseBroadcastAuthEndpointPayload;
+    presenceChannel: typeof presenceChannel;
+    privateChannel: typeof privateChannel;
+    renderBroadcastAuthResponse: typeof renderBroadcastAuthResponse;
+    resetBroadcastRuntime: typeof resetBroadcastRuntime;
+    resolveBroadcastWhisperSchema: typeof resolveBroadcastWhisperSchema;
+    startBroadcastWorker: typeof startBroadcastWorker;
+    validateBroadcastWhisperPayload: typeof validateBroadcastWhisperPayload;
+    createBroadcastWorkerRuntime: typeof createBroadcastWorkerRuntime;
+}>;
+
+export { BroadcastChannelAuthRuntimeBindings, BroadcastDriver, BroadcastRuntimeBindings, type BroadcastWorkerRuntime, type BroadcastWorkerStats, RegisterBroadcastDriverOptions, RegisteredBroadcastDriver, type StartedBroadcastWorker, authorizeBroadcastChannel, broadcast, broadcastRaw, broadcastRegistryInternals, channel, configureBroadcastRuntime, createBroadcastWorkerRuntime, broadcastPackage as default, defineBroadcast, defineChannel, getBroadcastRuntime, getBroadcastRuntimeBindings, getRegisteredBroadcastDriver, listRegisteredBroadcastDrivers, parseBroadcastAuthEndpointPayload, presenceChannel, privateChannel, registerBroadcastDriver, renderBroadcastAuthResponse, resetBroadcastDriverRegistry, resetBroadcastRuntime, resolveBroadcastWhisperSchema, startBroadcastWorker, validateBroadcastWhisperPayload, workerInternals };