@replit/river 0.22.0 → 0.23.1

package/dist/router/index.d.cts

@@ -1,9 +1,10 @@
-import { A as AnyServiceSchemaMap, I as InstantiatedServiceSchemaMap, P as PayloadType, b as Result, R as RiverError, S as ServiceContext } from '../services-acbcc441.js';
-export { C as Client, E as Err, O as Ok, B as Output, k as ProcErrors, g as ProcHandler, h as ProcInit, i as ProcInput, j as ProcOutput, l as ProcType, a as Procedure, o as ProcedureMap, d as ProcedureResult, p as RPCProcedure, z as ResultUnwrapErr, y as ResultUnwrapOk, x as RiverErrorSchema, c as RiverUncaughtSchema, n as SerializedServerSchema, e as Service, f as ServiceConfiguration, u as ServiceContextWithState, v as ServiceContextWithTransportInfo, m as ServiceSchema, r as StreamProcedure, q as SubscriptionProcedure, w as UNCAUGHT_ERROR, U as UploadProcedure, V as ValidProcType, t as createClient, s as serializeSchema } from '../services-acbcc441.js';
-import { Static } from '@sinclair/typebox';
+import { A as AnyServiceSchemaMap, I as InstantiatedServiceSchemaMap, P as PayloadType, b as Result, R as RiverError } from '../services-e95a89d6.js';
+export { C as Client, E as Err, O as Ok, x as Output, j as ProcErrors, f as ProcHandler, g as ProcInit, h as ProcInput, i as ProcOutput, k as ProcType, a as Procedure, n as ProcedureMap, d as ProcedureResult, o as RPCProcedure, w as ResultUnwrapErr, v as ResultUnwrapOk, u as RiverErrorSchema, c as RiverUncaughtSchema, m as SerializedServerSchema, S as Service, e as ServiceConfiguration, l as ServiceSchema, q as StreamProcedure, p as SubscriptionProcedure, t as UNCAUGHT_ERROR, U as UploadProcedure, V as ValidProcType, r as createClient, s as serializeSchema } from '../services-e95a89d6.js';
+import { Static, TSchema } from '@sinclair/typebox';
 import { ServerTransport } from '../transport/index.cjs';
 import { Pushable } from 'it-pushable';
-import { C as Connection } from '../index-2ece5234.js';
+import { C as Connection, c as ServerHandshakeOptions, a as ServiceContext } from '../index-a6fe0edd.js';
+export { d as ServiceContextWithState, e as ServiceContextWithTransportInfo } from '../index-a6fe0edd.js';
 import '../types-3e5768ec.js';
 import '@opentelemetry/api';
 
@@ -32,11 +33,15 @@ interface ProcStream {
  * The server tracks the state of each service along with open streams and the extended context object.
  * @param transport - The transport to listen to.
  * @param services - An object containing all the services to be registered on the server.
+ * @param handshakeOptions - An optional object containing additional handshake options to be passed to the transport.
  * @param extendedContext - An optional object containing additional context to be passed to all services.
  * @returns A promise that resolves to a server instance with the registered services.
  */
-declare function createServer<Services extends AnyServiceSchemaMap>(transport: ServerTransport<Connection>, services: Services, extendedContext?: Omit<ServiceContext, 'state'>): Server<Services>;
+declare function createServer<Services extends AnyServiceSchemaMap, MetadataSchema extends TSchema = TSchema>(transport: ServerTransport<Connection, MetadataSchema>, services: Services, providedServerOptions?: Partial<{
+    handshakeOptions?: ServerHandshakeOptions<MetadataSchema>;
+    extendedContext?: Omit<ServiceContext, 'state'>;
+}>): Server<Services>;
 
-var version = "0.22.0";
+var version = "0.23.1";
 
 export { PayloadType, version as RIVER_VERSION, Result, RiverError, Server, ServiceContext, createServer };

package/dist/router/index.d.ts

@@ -1,9 +1,10 @@
-import { A as AnyServiceSchemaMap, I as InstantiatedServiceSchemaMap, P as PayloadType, b as Result, R as RiverError, S as ServiceContext } from '../services-cb01a7a8.js';
-export { C as Client, E as Err, O as Ok, B as Output, k as ProcErrors, g as ProcHandler, h as ProcInit, i as ProcInput, j as ProcOutput, l as ProcType, a as Procedure, o as ProcedureMap, d as ProcedureResult, p as RPCProcedure, z as ResultUnwrapErr, y as ResultUnwrapOk, x as RiverErrorSchema, c as RiverUncaughtSchema, n as SerializedServerSchema, e as Service, f as ServiceConfiguration, u as ServiceContextWithState, v as ServiceContextWithTransportInfo, m as ServiceSchema, r as StreamProcedure, q as SubscriptionProcedure, w as UNCAUGHT_ERROR, U as UploadProcedure, V as ValidProcType, t as createClient, s as serializeSchema } from '../services-cb01a7a8.js';
-import { Static } from '@sinclair/typebox';
+import { A as AnyServiceSchemaMap, I as InstantiatedServiceSchemaMap, P as PayloadType, b as Result, R as RiverError } from '../services-95cb17b9.js';
+export { C as Client, E as Err, O as Ok, x as Output, j as ProcErrors, f as ProcHandler, g as ProcInit, h as ProcInput, i as ProcOutput, k as ProcType, a as Procedure, n as ProcedureMap, d as ProcedureResult, o as RPCProcedure, w as ResultUnwrapErr, v as ResultUnwrapOk, u as RiverErrorSchema, c as RiverUncaughtSchema, m as SerializedServerSchema, S as Service, e as ServiceConfiguration, l as ServiceSchema, q as StreamProcedure, p as SubscriptionProcedure, t as UNCAUGHT_ERROR, U as UploadProcedure, V as ValidProcType, r as createClient, s as serializeSchema } from '../services-95cb17b9.js';
+import { Static, TSchema } from '@sinclair/typebox';
 import { ServerTransport } from '../transport/index.js';
 import { Pushable } from 'it-pushable';
-import { C as Connection } from '../index-2ece5234.js';
+import { C as Connection, c as ServerHandshakeOptions, a as ServiceContext } from '../index-a6fe0edd.js';
+export { d as ServiceContextWithState, e as ServiceContextWithTransportInfo } from '../index-a6fe0edd.js';
 import '../types-3e5768ec.js';
 import '@opentelemetry/api';
 
@@ -32,11 +33,15 @@ interface ProcStream {
  * The server tracks the state of each service along with open streams and the extended context object.
  * @param transport - The transport to listen to.
  * @param services - An object containing all the services to be registered on the server.
+ * @param handshakeOptions - An optional object containing additional handshake options to be passed to the transport.
  * @param extendedContext - An optional object containing additional context to be passed to all services.
  * @returns A promise that resolves to a server instance with the registered services.
  */
-declare function createServer<Services extends AnyServiceSchemaMap>(transport: ServerTransport<Connection>, services: Services, extendedContext?: Omit<ServiceContext, 'state'>): Server<Services>;
+declare function createServer<Services extends AnyServiceSchemaMap, MetadataSchema extends TSchema = TSchema>(transport: ServerTransport<Connection, MetadataSchema>, services: Services, providedServerOptions?: Partial<{
+    handshakeOptions?: ServerHandshakeOptions<MetadataSchema>;
+    extendedContext?: Omit<ServiceContext, 'state'>;
+}>): Server<Services>;
 
-var version = "0.22.0";
+var version = "0.23.1";
 
 export { PayloadType, version as RIVER_VERSION, Result, RiverError, Server, ServiceContext, createServer };

package/dist/router/index.js

@@ -8,10 +8,10 @@ import {
   createClient,
   createServer,
   serializeSchema
-} from "../chunk-GCLEWC26.js";
+} from "../chunk-IKKP6BZG.js";
 import {
   version
-} from "../chunk-3MFX6NXA.js";
+} from "../chunk-RBH47IKH.js";
 import "../chunk-OTQNCLFH.js";
 export {
   Err,

package/dist/{services-cb01a7a8.d.ts → services-95cb17b9.d.ts}

@@ -1,7 +1,7 @@
-import { Static, TObject, TUnion, TString, TSchema, TNever, TLiteral } from '@sinclair/typebox';
+import { TSchema, Static, TObject, TUnion, TString, TNever, TLiteral } from '@sinclair/typebox';
 import { ClientTransport } from './transport/index.js';
 import { Pushable } from 'it-pushable';
-import { C as Connection, T as TransportClientId, a as Session, b as ParsedHandshakeMetadata } from './index-2ece5234.js';
+import { C as Connection, T as TransportClientId, f as ClientHandshakeOptions, e as ServiceContextWithTransportInfo } from './index-a6fe0edd.js';
 
 type AsyncIter<T> = AsyncGenerator<T, T>;
 /**
@@ -63,9 +63,13 @@ interface ClientOptions {
  *
  * @template Srv - The type of the server.
  * @param {Transport} transport - The transport to use for communication.
+ * @param {TransportClientId} serverId - The ID of the server to connect to.
+ * @param {Partial<ClientOptions>} providedClientOptions - The options for the client.
  * @returns The client for the server.
  */
-declare const createClient: <ServiceSchemaMap extends AnyServiceSchemaMap>(transport: ClientTransport<Connection>, serverId: TransportClientId, providedClientOptions?: Partial<ClientOptions>) => Client<ServiceSchemaMap, InstantiatedServiceSchemaMap<ServiceSchemaMap>>;
+declare function createClient<ServiceSchemaMap extends AnyServiceSchemaMap, MetadataSchema extends TSchema = TSchema>(transport: ClientTransport<Connection, MetadataSchema>, serverId: TransportClientId, providedClientOptions?: Partial<ClientOptions & {
+    handshakeOptions: ClientHandshakeOptions<MetadataSchema>;
+}>): Client<ServiceSchemaMap>;
 
 type TLiteralString = TLiteral<string>;
 type RiverErrorSchema = TObject<{
@@ -89,6 +93,8 @@ type Result<T, E> = {
     ok: false;
     payload: E;
 };
+declare function Ok<const T extends Array<unknown>, const E>(p: T): Result<T, E>;
+declare function Ok<const T extends ReadonlyArray<unknown>, const E>(p: T): Result<T, E>;
 declare function Ok<const T, const E>(payload: T): Result<T, E>;
 declare function Err<const T, const E>(error: E): Result<T, E>;
 /**
@@ -127,44 +133,6 @@ type Output<RiverClient, ServiceName extends keyof RiverClient, ProcedureName ex
     infer __SubscriptionCloseHandle
 ] ? SubscriptionOutputMessage : never : never : never : never;
 
-/**
- * The context for services/procedures. This is used only on
- * the server.
- *
- * An important detail is that the state prop is always on
- * this interface and it shouldn't be changed, removed, or
- * extended. This prop is for the state of a service.
- *
- * You should use declaration merging to extend this interface
- * with whatever you need. For example, if you need to access
- * a database, you could do:
- *
- * ```ts
- * declare module '@replit/river' {
- *   interface ServiceContext {
- *     db: Database;
- *   }
- * }
- * ```
- */
-interface ServiceContext {
-}
-/**
- * The {@link ServiceContext} with state. This is what is passed to procedures.
- */
-type ServiceContextWithState<State> = ServiceContext & {
-    state: State;
-};
-type ServiceContextWithTransportInfo<State> = ServiceContext & {
-    state: Omit<State, typeof Symbol.dispose>;
-    to: TransportClientId;
-    from: TransportClientId;
-    streamId: string;
-    session: Session<Connection> & {
-        metadata: ParsedHandshakeMetadata;
-    };
-};
-
 /**
  * Brands a type to prevent it from being directly constructed.
  */
@@ -198,7 +166,7 @@ type ProcedureResult<O extends PayloadType, E extends RiverError> = Result<Stati
  * @template O - The TypeBox schema of the output object.
  * @template E - The TypeBox schema of the error object.
  */
-interface RPCProcedure<State, I extends PayloadType, O extends PayloadType, E extends RiverError> {
+interface RpcProcedure<State, I extends PayloadType, O extends PayloadType, E extends RiverError> {
     type: 'rpc';
     input: I;
     output: O;
@@ -289,22 +257,22 @@ type AnyProcedure<State = object> = Procedure<State, ValidProcType, PayloadType,
  */
 type ProcedureMap<State = object> = Record<string, AnyProcedure<State>>;
 /**
- * Creates an {@link RPCProcedure}.
+ * Creates an {@link RpcProcedure}.
  */
 declare function rpc<State, I extends PayloadType, O extends PayloadType>(def: {
     input: I;
     output: O;
     errors?: never;
     description?: string;
-    handler: RPCProcedure<State, I, O, TNever>['handler'];
-}): Branded<RPCProcedure<State, I, O, TNever>>;
+    handler: RpcProcedure<State, I, O, TNever>['handler'];
+}): Branded<RpcProcedure<State, I, O, TNever>>;
 declare function rpc<State, I extends PayloadType, O extends PayloadType, E extends RiverError>(def: {
     input: I;
     output: O;
     errors: E;
     description?: string;
-    handler: RPCProcedure<State, I, O, E>['handler'];
-}): Branded<RPCProcedure<State, I, O, E>>;
+    handler: RpcProcedure<State, I, O, E>['handler'];
+}): Branded<RpcProcedure<State, I, O, E>>;
 /**
  * Creates an {@link UploadProcedure}, optionally with an initialization message.
  */
@@ -394,7 +362,7 @@ declare function stream<State, I extends PayloadType, O extends PayloadType, E e
 }): Branded<StreamProcedure<State, I, O, E>>;
 /**
  * Defines a Procedure type that can be a:
- * - {@link RPCProcedure} for a single message in both directions (1:1)
+ * - {@link RpcProcedure} for a single message in both directions (1:1)
  * - {@link UploadProcedure} for a client-stream (potentially preceded by an
  *   initialization message)
  * - {@link SubscriptionProcedure} for a single message from client, stream from server (1:n)
@@ -409,7 +377,7 @@ declare function stream<State, I extends PayloadType, O extends PayloadType, E e
  */
 type Procedure<State, Ty extends ValidProcType, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null> = {
     type: Ty;
-} & (Init extends PayloadType ? Ty extends 'upload' ? UploadProcedure<State, I, O, E, Init> : Ty extends 'stream' ? StreamProcedure<State, I, O, E, Init> : never : Ty extends 'rpc' ? RPCProcedure<State, I, O, E> : Ty extends 'upload' ? UploadProcedure<State, I, O, E> : Ty extends 'subscription' ? SubscriptionProcedure<State, I, O, E> : Ty extends 'stream' ? StreamProcedure<State, I, O, E> : never);
+} & (Init extends PayloadType ? Ty extends 'upload' ? UploadProcedure<State, I, O, E, Init> : Ty extends 'stream' ? StreamProcedure<State, I, O, E, Init> : never : Ty extends 'rpc' ? RpcProcedure<State, I, O, E> : Ty extends 'upload' ? UploadProcedure<State, I, O, E> : Ty extends 'subscription' ? SubscriptionProcedure<State, I, O, E> : Ty extends 'stream' ? StreamProcedure<State, I, O, E> : never);
 /**
  * Holds the {@link Procedure} creation functions. Use these to create
  * procedures for services. You aren't allowed to create procedures directly.
@@ -518,8 +486,11 @@ interface SerializedServiceSchema {
         init?: PayloadType;
     }>;
 }
-type SerializedServerSchema = Record<string, SerializedServiceSchema>;
-declare function serializeSchema(services: AnyServiceSchemaMap): SerializedServerSchema;
+interface SerializedServerSchema {
+    handshakeSchema?: TSchema;
+    services: Record<string, SerializedServiceSchema>;
+}
+declare function serializeSchema(services: AnyServiceSchemaMap, handshakeSchema?: TSchema): SerializedServerSchema;
 /**
  * The schema for a {@link Service}. This is used to define a service, specifically
  * its initial state and procedures.
@@ -733,4 +704,4 @@ declare class ServiceScaffold<State extends object> {
     }>;
 }
 
-export { AnyServiceSchemaMap as A, Output as B, Client as C, Err as E, InstantiatedServiceSchemaMap as I, Ok as O, PayloadType as P, RiverError as R, ServiceContext as S, UploadProcedure as U, ValidProcType as V, Procedure as a, Result as b, RiverUncaughtSchema as c, ProcedureResult as d, Service as e, ServiceConfiguration as f, ProcHandler as g, ProcInit as h, ProcInput as i, ProcOutput as j, ProcErrors as k, ProcType as l, ServiceSchema as m, SerializedServerSchema as n, ProcedureMap as o, RPCProcedure as p, SubscriptionProcedure as q, StreamProcedure as r, serializeSchema as s, createClient as t, ServiceContextWithState as u, ServiceContextWithTransportInfo as v, UNCAUGHT_ERROR as w, RiverErrorSchema as x, ResultUnwrapOk as y, ResultUnwrapErr as z };
+export { AnyServiceSchemaMap as A, Client as C, Err as E, InstantiatedServiceSchemaMap as I, Ok as O, PayloadType as P, RiverError as R, Service as S, UploadProcedure as U, ValidProcType as V, Procedure as a, Result as b, RiverUncaughtSchema as c, ProcedureResult as d, ServiceConfiguration as e, ProcHandler as f, ProcInit as g, ProcInput as h, ProcOutput as i, ProcErrors as j, ProcType as k, ServiceSchema as l, SerializedServerSchema as m, ProcedureMap as n, RpcProcedure as o, SubscriptionProcedure as p, StreamProcedure as q, createClient as r, serializeSchema as s, UNCAUGHT_ERROR as t, RiverErrorSchema as u, ResultUnwrapOk as v, ResultUnwrapErr as w, Output as x };

package/dist/{services-acbcc441.d.ts → services-e95a89d6.d.ts}

@@ -1,7 +1,7 @@
-import { Static, TObject, TUnion, TString, TSchema, TNever, TLiteral } from '@sinclair/typebox';
+import { TSchema, Static, TObject, TUnion, TString, TNever, TLiteral } from '@sinclair/typebox';
 import { ClientTransport } from './transport/index.cjs';
 import { Pushable } from 'it-pushable';
-import { C as Connection, T as TransportClientId, a as Session, b as ParsedHandshakeMetadata } from './index-2ece5234.js';
+import { C as Connection, T as TransportClientId, f as ClientHandshakeOptions, e as ServiceContextWithTransportInfo } from './index-a6fe0edd.js';
 
 type AsyncIter<T> = AsyncGenerator<T, T>;
 /**
@@ -63,9 +63,13 @@ interface ClientOptions {
  *
  * @template Srv - The type of the server.
  * @param {Transport} transport - The transport to use for communication.
+ * @param {TransportClientId} serverId - The ID of the server to connect to.
+ * @param {Partial<ClientOptions>} providedClientOptions - The options for the client.
  * @returns The client for the server.
  */
-declare const createClient: <ServiceSchemaMap extends AnyServiceSchemaMap>(transport: ClientTransport<Connection>, serverId: TransportClientId, providedClientOptions?: Partial<ClientOptions>) => Client<ServiceSchemaMap, InstantiatedServiceSchemaMap<ServiceSchemaMap>>;
+declare function createClient<ServiceSchemaMap extends AnyServiceSchemaMap, MetadataSchema extends TSchema = TSchema>(transport: ClientTransport<Connection, MetadataSchema>, serverId: TransportClientId, providedClientOptions?: Partial<ClientOptions & {
+    handshakeOptions: ClientHandshakeOptions<MetadataSchema>;
+}>): Client<ServiceSchemaMap>;
 
 type TLiteralString = TLiteral<string>;
 type RiverErrorSchema = TObject<{
@@ -89,6 +93,8 @@ type Result<T, E> = {
     ok: false;
     payload: E;
 };
+declare function Ok<const T extends Array<unknown>, const E>(p: T): Result<T, E>;
+declare function Ok<const T extends ReadonlyArray<unknown>, const E>(p: T): Result<T, E>;
 declare function Ok<const T, const E>(payload: T): Result<T, E>;
 declare function Err<const T, const E>(error: E): Result<T, E>;
 /**
@@ -127,44 +133,6 @@ type Output<RiverClient, ServiceName extends keyof RiverClient, ProcedureName ex
     infer __SubscriptionCloseHandle
 ] ? SubscriptionOutputMessage : never : never : never : never;
 
-/**
- * The context for services/procedures. This is used only on
- * the server.
- *
- * An important detail is that the state prop is always on
- * this interface and it shouldn't be changed, removed, or
- * extended. This prop is for the state of a service.
- *
- * You should use declaration merging to extend this interface
- * with whatever you need. For example, if you need to access
- * a database, you could do:
- *
- * ```ts
- * declare module '@replit/river' {
- *   interface ServiceContext {
- *     db: Database;
- *   }
- * }
- * ```
- */
-interface ServiceContext {
-}
-/**
- * The {@link ServiceContext} with state. This is what is passed to procedures.
- */
-type ServiceContextWithState<State> = ServiceContext & {
-    state: State;
-};
-type ServiceContextWithTransportInfo<State> = ServiceContext & {
-    state: Omit<State, typeof Symbol.dispose>;
-    to: TransportClientId;
-    from: TransportClientId;
-    streamId: string;
-    session: Session<Connection> & {
-        metadata: ParsedHandshakeMetadata;
-    };
-};
-
 /**
  * Brands a type to prevent it from being directly constructed.
  */
@@ -198,7 +166,7 @@ type ProcedureResult<O extends PayloadType, E extends RiverError> = Result<Stati
  * @template O - The TypeBox schema of the output object.
  * @template E - The TypeBox schema of the error object.
  */
-interface RPCProcedure<State, I extends PayloadType, O extends PayloadType, E extends RiverError> {
+interface RpcProcedure<State, I extends PayloadType, O extends PayloadType, E extends RiverError> {
     type: 'rpc';
     input: I;
     output: O;
@@ -289,22 +257,22 @@ type AnyProcedure<State = object> = Procedure<State, ValidProcType, PayloadType,
  */
 type ProcedureMap<State = object> = Record<string, AnyProcedure<State>>;
 /**
- * Creates an {@link RPCProcedure}.
+ * Creates an {@link RpcProcedure}.
  */
 declare function rpc<State, I extends PayloadType, O extends PayloadType>(def: {
     input: I;
     output: O;
     errors?: never;
     description?: string;
-    handler: RPCProcedure<State, I, O, TNever>['handler'];
-}): Branded<RPCProcedure<State, I, O, TNever>>;
+    handler: RpcProcedure<State, I, O, TNever>['handler'];
+}): Branded<RpcProcedure<State, I, O, TNever>>;
 declare function rpc<State, I extends PayloadType, O extends PayloadType, E extends RiverError>(def: {
     input: I;
     output: O;
     errors: E;
     description?: string;
-    handler: RPCProcedure<State, I, O, E>['handler'];
-}): Branded<RPCProcedure<State, I, O, E>>;
+    handler: RpcProcedure<State, I, O, E>['handler'];
+}): Branded<RpcProcedure<State, I, O, E>>;
 /**
  * Creates an {@link UploadProcedure}, optionally with an initialization message.
  */
@@ -394,7 +362,7 @@ declare function stream<State, I extends PayloadType, O extends PayloadType, E e
 }): Branded<StreamProcedure<State, I, O, E>>;
 /**
  * Defines a Procedure type that can be a:
- * - {@link RPCProcedure} for a single message in both directions (1:1)
+ * - {@link RpcProcedure} for a single message in both directions (1:1)
  * - {@link UploadProcedure} for a client-stream (potentially preceded by an
  *   initialization message)
  * - {@link SubscriptionProcedure} for a single message from client, stream from server (1:n)
@@ -409,7 +377,7 @@ declare function stream<State, I extends PayloadType, O extends PayloadType, E e
  */
 type Procedure<State, Ty extends ValidProcType, I extends PayloadType, O extends PayloadType, E extends RiverError, Init extends PayloadType | null = null> = {
     type: Ty;
-} & (Init extends PayloadType ? Ty extends 'upload' ? UploadProcedure<State, I, O, E, Init> : Ty extends 'stream' ? StreamProcedure<State, I, O, E, Init> : never : Ty extends 'rpc' ? RPCProcedure<State, I, O, E> : Ty extends 'upload' ? UploadProcedure<State, I, O, E> : Ty extends 'subscription' ? SubscriptionProcedure<State, I, O, E> : Ty extends 'stream' ? StreamProcedure<State, I, O, E> : never);
+} & (Init extends PayloadType ? Ty extends 'upload' ? UploadProcedure<State, I, O, E, Init> : Ty extends 'stream' ? StreamProcedure<State, I, O, E, Init> : never : Ty extends 'rpc' ? RpcProcedure<State, I, O, E> : Ty extends 'upload' ? UploadProcedure<State, I, O, E> : Ty extends 'subscription' ? SubscriptionProcedure<State, I, O, E> : Ty extends 'stream' ? StreamProcedure<State, I, O, E> : never);
 /**
  * Holds the {@link Procedure} creation functions. Use these to create
  * procedures for services. You aren't allowed to create procedures directly.
@@ -518,8 +486,11 @@ interface SerializedServiceSchema {
         init?: PayloadType;
     }>;
 }
-type SerializedServerSchema = Record<string, SerializedServiceSchema>;
-declare function serializeSchema(services: AnyServiceSchemaMap): SerializedServerSchema;
+interface SerializedServerSchema {
+    handshakeSchema?: TSchema;
+    services: Record<string, SerializedServiceSchema>;
+}
+declare function serializeSchema(services: AnyServiceSchemaMap, handshakeSchema?: TSchema): SerializedServerSchema;
 /**
  * The schema for a {@link Service}. This is used to define a service, specifically
  * its initial state and procedures.
@@ -733,4 +704,4 @@ declare class ServiceScaffold<State extends object> {
     }>;
 }
 
-export { AnyServiceSchemaMap as A, Output as B, Client as C, Err as E, InstantiatedServiceSchemaMap as I, Ok as O, PayloadType as P, RiverError as R, ServiceContext as S, UploadProcedure as U, ValidProcType as V, Procedure as a, Result as b, RiverUncaughtSchema as c, ProcedureResult as d, Service as e, ServiceConfiguration as f, ProcHandler as g, ProcInit as h, ProcInput as i, ProcOutput as j, ProcErrors as k, ProcType as l, ServiceSchema as m, SerializedServerSchema as n, ProcedureMap as o, RPCProcedure as p, SubscriptionProcedure as q, StreamProcedure as r, serializeSchema as s, createClient as t, ServiceContextWithState as u, ServiceContextWithTransportInfo as v, UNCAUGHT_ERROR as w, RiverErrorSchema as x, ResultUnwrapOk as y, ResultUnwrapErr as z };
+export { AnyServiceSchemaMap as A, Client as C, Err as E, InstantiatedServiceSchemaMap as I, Ok as O, PayloadType as P, RiverError as R, Service as S, UploadProcedure as U, ValidProcType as V, Procedure as a, Result as b, RiverUncaughtSchema as c, ProcedureResult as d, ServiceConfiguration as e, ProcHandler as f, ProcInit as g, ProcInput as h, ProcOutput as i, ProcErrors as j, ProcType as k, ServiceSchema as l, SerializedServerSchema as m, ProcedureMap as n, RpcProcedure as o, SubscriptionProcedure as p, StreamProcedure as q, createClient as r, serializeSchema as s, UNCAUGHT_ERROR as t, RiverErrorSchema as u, ResultUnwrapOk as v, ResultUnwrapErr as w, Output as x };

package/dist/transport/impls/uds/client.cjs

@@ -113,7 +113,7 @@ function isAck(controlFlag) {
 var import_api = require("@opentelemetry/api");
 
 // package.json
-var version = "0.22.0";
+var version = "0.23.1";
 
 // tracing/index.ts
 function getPropagationContext(ctx) {
@@ -192,12 +192,6 @@ var Session = class {
    * for this session.
    */
   advertisedSessionId;
-  /**
-   * The metadata for this session, as parsed from the handshake.
-   *
-   * Will only ever be populated on the server side.
-   */
-  metadata;
   /**
    * Number of messages we've sent along this session (excluding handshake and acks)
    */
@@ -355,8 +349,8 @@ var Session = class {
   replaceWithNewConnection(newConn) {
     this.closeStaleConnection(newConn);
     this.cancelGrace();
-    this.connection = newConn;
     this.sendBufferedMessages(newConn);
+    this.connection = newConn;
   }
   beginGrace(cb) {
     log?.info(
@@ -1002,6 +996,10 @@ var ClientTransport = class extends Transport {
    * tests or a special case where you don't want to reconnect.
    */
   reconnectOnConnectionDrop = true;
+  /**
+   * Optional handshake options for this client.
+   */
+  handshakeExtensions;
   constructor(clientId, providedOptions) {
     super(clientId, providedOptions);
     this.options = {
@@ -1011,6 +1009,9 @@ var ClientTransport = class extends Transport {
     this.inflightConnectionPromises = /* @__PURE__ */ new Map();
     this.retryBudget = new LeakyBucketRateLimit(this.options);
   }
+  extendHandshake(options) {
+    this.handshakeExtensions = options;
+  }
   handleConnection(conn, to) {
     if (this.state !== "open")
       return;
@@ -1234,10 +1235,10 @@ var ClientTransport = class extends Transport {
   }
   async sendHandshake(to, conn) {
     let metadata;
-    if (this.options.handshake) {
-      metadata = await this.options.handshake.get();
-      if (!import_value.Value.Check(this.options.handshake.schema, metadata)) {
-        log?.error(`handshake metadata did not match schema`, {
+    if (this.handshakeExtensions) {
+      metadata = await this.handshakeExtensions.construct();
+      if (!import_value.Value.Check(this.handshakeExtensions.schema, metadata)) {
+        log?.error(`constructed handshake metadata did not match schema`, {
           clientId: this.clientId,
           connectedTo: to,
           tags: ["invariant-violation"]
@@ -1253,7 +1254,7 @@ var ClientTransport = class extends Transport {
         return false;
       }
     }
-    const { session } = this.getOrCreateSession(to, conn);
+    const { session } = this.getOrCreateSession(to);
     const requestMsg = handshakeRequestMessage(
       this.clientId,
       to,