fix(client): flatten skipReadyWait option

Author: NathanFlurry

examples/kitchen-sink/scripts/mock-agentic-loop.ts

@@ -55,22 +55,15 @@ export function resolveActorGatewayOptions(
 	};
 }
 
-export interface ActorActionOptions {
-	gateway?: ActorGatewayOptions;
+export interface ActorActionOptions extends ActorGatewayOptions {
 	signal?: AbortSignal;
 }
 
-export interface ActorConnectOptions {
-	gateway?: ActorGatewayOptions;
-}
+export type ActorConnectOptions = ActorGatewayOptions;
 
-export interface ActorFetchInit extends RequestInit {
-	gateway?: ActorGatewayOptions;
-}
+export type ActorFetchInit = RequestInit & ActorGatewayOptions;
 
-export interface ActorWebSocketOptions {
-	gateway?: ActorGatewayOptions;
-}
+export type ActorWebSocketOptions = ActorGatewayOptions;
 
 /**
  * Maps action methods from actor definition to typed function signatures.

rivetkit-typescript/packages/rivetkit/src/client/actor-common.ts

@@ -264,7 +264,7 @@ export class ActorHandleRaw {
 		let useQueryTarget = false;
 		const gatewayOptions = resolveActorGatewayOptions(
 			this.#gatewayOptions,
-			opts.gateway,
+			opts,
 		);
 
 		for (let attempt = 0; attempt < maxAttempts; attempt++) {
@@ -586,7 +586,7 @@ export class ActorHandleRaw {
 			getParams,
 			this.#encoding,
 			this.#actorResolutionState,
-			resolveActorGatewayOptions(this.#gatewayOptions, options.gateway),
+			resolveActorGatewayOptions(this.#gatewayOptions, options),
 		);
 
 		return this.#client[CREATE_ACTOR_CONN_PROXY](
@@ -608,10 +608,10 @@ export class ActorHandleRaw {
 	) {
 		const maxAttempts = this.#getDynamicQueryMaxAttempts();
 		let useQueryTarget = false;
-		const { gateway, ...requestInit } = init ?? {};
+		const { bypassConnectable, skipReadyWait, ...requestInit } = init ?? {};
 		const gatewayOptions = resolveActorGatewayOptions(
 			this.#gatewayOptions,
-			gateway,
+			{ bypassConnectable, skipReadyWait },
 		);
 
 		for (let attempt = 0; attempt < maxAttempts; attempt++) {
@@ -820,7 +820,7 @@ export class ActorHandleRaw {
 		const params = await this.#resolveConnectionParams();
 		const gatewayOptions = resolveActorGatewayOptions(
 			this.#gatewayOptions,
-			options.gateway,
+			options,
 		);
 		const target = gatewayOptions.bypassConnectable
 			? await this.#resolveActionTarget(false)

rivetkit-typescript/packages/rivetkit/src/client/actor-handle.ts

@@ -28,7 +28,7 @@ describeDriverMatrix("Gateway Bypass Client", (driverTestConfig) => {
 			await enabledTracking.action({
 				name: "ping",
 				args: [],
-				gateway: { bypassConnectable: true },
+				bypassConnectable: true,
 			});
 
 			const enabledInfo = await enabledView.getRequestInfo();
@@ -47,7 +47,7 @@ describeDriverMatrix("Gateway Bypass Client", (driverTestConfig) => {
 			await disabledTracking.action({
 				name: "ping",
 				args: [],
-				gateway: { bypassConnectable: false },
+				bypassConnectable: false,
 			});
 
 			const disabledInfo = await disabledView.getRequestInfo();
@@ -87,7 +87,7 @@ describeDriverMatrix("Gateway Bypass Client", (driverTestConfig) => {
 			await overrideTracking.action({
 				name: "ping",
 				args: [],
-				gateway: { bypassConnectable: false },
+				bypassConnectable: false,
 			});
 
 			const overrideInfo = await overrideView.getRequestInfo();
@@ -116,7 +116,7 @@ describeDriverMatrix("Gateway Bypass Client", (driverTestConfig) => {
 					params: { trackRequest: true },
 				})
 				.connect(undefined, {
-					gateway: { bypassConnectable: true },
+					bypassConnectable: true,
 				});
 
 			const bypassInfo = await bypassConn.getRequestInfo();
@@ -148,7 +148,7 @@ describeDriverMatrix("Gateway Bypass Client", (driverTestConfig) => {
 					params: { trackRequest: true },
 				})
 				.connect(undefined, {
-					gateway: { bypassConnectable: false },
+					bypassConnectable: false,
 				});
 
 			const overrideInfo = await overrideConn.getRequestInfo();

rivetkit-typescript/packages/rivetkit/tests/driver/gateway-bypass-client.test.ts

@@ -134,7 +134,7 @@ describe.sequential("RemoteEngineControlClient public token usage", () => {
 		const handle = client.getForId("mockAgenticLoop", "actor-http-bypass");
 
 		const response = await handle.fetch("/bypass", {
-			gateway: { bypassConnectable: true },
+			bypassConnectable: true,
 		});
 
 		expect(response.status).toBe(200);

rivetkit-typescript/packages/rivetkit/tests/remote-engine-client-public-token.test.ts

@@ -763,7 +763,7 @@ curl -X POST \
 
 ### Skip Ready Wait
 
-The gateway normally holds requests until the actor is ready. The actor is not ready during startup (before `onWake` finishes) or during the sleep grace period (while `onSleep` and `waitUntil` are running). Probes and readiness checks can opt out with `gateway.skipReadyWait` to reach the actor's `onRequest` or `onWebSocket` handler in either window.
+The gateway normally holds requests until the actor is ready. The actor is not ready during startup (before `onWake` finishes) or during the sleep grace period (while `onSleep` and `waitUntil` are running). Probes and readiness checks can opt out with `skipReadyWait` to reach the actor's `onRequest` or `onWebSocket` handler in either window.
 
 See [Skip Ready Wait](/docs/clients/javascript#skip-ready-wait) on the JavaScript client page for usage.
 

website/src/content/docs/actors/lifecycle.mdx

@@ -253,7 +253,7 @@ The `onRequest` handler is WinterTC compliant and will work with existing librar
 
 ### Skip Ready Wait
 
-Requests are normally held at the gateway until the actor is ready. Pass `gateway.skipReadyWait: true` on `handle.fetch()` to deliver immediately, including while the actor is still starting or in the [sleep grace period](/docs/actors/lifecycle#shutdown-sequence). See [Skip Ready Wait](/docs/clients/javascript#skip-ready-wait) for details.
+Requests are normally held at the gateway until the actor is ready. Pass `skipReadyWait: true` on `handle.fetch()` to deliver immediately, including while the actor is still starting or in the [sleep grace period](/docs/actors/lifecycle#shutdown-sequence). See [Skip Ready Wait](/docs/clients/javascript#skip-ready-wait) for details.
 
 ## API Reference
 

website/src/content/docs/actors/request-handler.mdx

@@ -297,7 +297,7 @@ const myActor = actor({
 
 ### Skip Ready Wait
 
-Connections are normally held at the gateway until the actor is ready. Pass `gateway.skipReadyWait: true` on `handle.webSocket()` to connect immediately, including while the actor is still starting or in the [sleep grace period](/docs/actors/lifecycle#shutdown-sequence). See [Skip Ready Wait](/docs/clients/javascript#skip-ready-wait) for details.
+Connections are normally held at the gateway until the actor is ready. Pass `skipReadyWait: true` on `handle.webSocket()` to connect immediately, including while the actor is still starting or in the [sleep grace period](/docs/actors/lifecycle#shutdown-sequence). See [Skip Ready Wait](/docs/clients/javascript#skip-ready-wait) for details.
 
 ### Async Handlers
 

website/src/content/docs/actors/websocket-handler.mdx

@@ -259,7 +259,7 @@ You can also pass the endpoint without auth and provide `RIVET_NAMESPACE` and `R
 
 Requests are normally held at the gateway until the actor is ready to accept traffic. An actor is not ready while it's still starting (before `onWake` finishes) or while it's in the [sleep grace period](/docs/actors/lifecycle#shutdown-sequence) (running `onSleep`, `waitUntil`, and pending disconnects).
 
-Pass `gateway.skipReadyWait: true` on the [low-level HTTP and WebSocket APIs](#low-level-http--websocket) to deliver immediately and reach the actor's `onRequest` / `onWebSocket` handler in either window:
+Pass `skipReadyWait: true` on the [low-level HTTP and WebSocket APIs](#low-level-http--websocket) to deliver immediately and reach the actor's `onRequest` / `onWebSocket` handler in either window:
 
 ```ts @nocheck
 import { createClient } from "rivetkit/client";
@@ -268,11 +268,11 @@ const client = createClient();
 const handle = client.chatRoom.getOrCreate(["general"]);
 
 const response = await handle.fetch("/healthz", {
-  gateway: { skipReadyWait: true },
+  skipReadyWait: true,
 });
 
 const ws = await handle.webSocket("probe", undefined, {
-  gateway: { skipReadyWait: true },
+  skipReadyWait: true,
 });
 ```