rivetkit 2.0.2 → 2.0.4-rc.1

package/src/actor/contexts/base/conn.ts

@@ -0,0 +1,73 @@
+import type { Conn } from "../../conn/mod";
+import type { AnyDatabaseProvider } from "../../database";
+import type { ActorDefinition, AnyActorDefinition } from "../../definition";
+import type { ActorInstance } from "../../instance/mod";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../../schema";
+import { ActorContext } from "./actor";
+
+/**
+ * Base context for connection-based handlers.
+ * Extends ActorContext with connection-specific functionality.
+ */
+export abstract class ConnContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ActorContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {
+	/**
+	 * @internal
+	 */
+	constructor(
+		actor: ActorInstance<
+			TState,
+			TConnParams,
+			TConnState,
+			TVars,
+			TInput,
+			TDatabase,
+			TEvents,
+			TQueues
+		>,
+		public readonly conn: Conn<
+			TState,
+			TConnParams,
+			TConnState,
+			TVars,
+			TInput,
+			TDatabase,
+			TEvents,
+			TQueues
+		>,
+	) {
+		super(actor);
+	}
+}
+
+export type ConnContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		infer CP,
+		infer CS,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? ConnContext<S, CP, CS, V, I, DB, E, Q>
+		: never;

package/src/actor/contexts/before-action-response.ts

@@ -0,0 +1,42 @@
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ActorContext } from "./base/actor";
+
+/**
+ * Context for the onBeforeActionResponse lifecycle hook.
+ */
+export class BeforeActionResponseContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ActorContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {}
+
+export type BeforeActionResponseContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		infer CP,
+		infer CS,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? BeforeActionResponseContext<S, CP, CS, V, I, DB, E, Q>
+		: never;

package/src/actor/contexts/before-connect.ts

@@ -0,0 +1,31 @@
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ConnInitContext } from "./base/conn-init";
+
+/**
+ * Context for the onBeforeConnect lifecycle hook.
+ */
+export class BeforeConnectContext<
+	TState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ConnInitContext<TState, TVars, TInput, TDatabase, TEvents, TQueues> {}
+
+export type BeforeConnectContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		any,
+		any,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? BeforeConnectContext<S, V, I, DB, E, Q>
+		: never;

package/src/actor/contexts/connect.ts

@@ -0,0 +1,42 @@
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ConnContext } from "./base/conn";
+
+/**
+ * Context for the onConnect lifecycle hook.
+ */
+export class ConnectContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ConnContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {}
+
+export type ConnectContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		infer CP,
+		infer CS,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? ConnectContext<S, CP, CS, V, I, DB, E, Q>
+		: never;

package/src/actor/contexts/create-conn-state.ts

@@ -0,0 +1,32 @@
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ConnInitContext } from "./base/conn-init";
+
+/**
+ * Context for the createConnState lifecycle hook.
+ * Called to initialize connection-specific state when a connection is created.
+ */
+export class CreateConnStateContext<
+	TState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ConnInitContext<TState, TVars, TInput, TDatabase, TEvents, TQueues> {}
+
+export type CreateConnStateContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		any,
+		any,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? CreateConnStateContext<S, V, I, DB, E, Q>
+		: never;

package/src/actor/contexts/create-vars.ts

@@ -0,0 +1,39 @@
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ActorContext } from "./base/actor";
+
+/**
+ * Context for the createVars lifecycle hook.
+ */
+export class CreateVarsContext<
+	TState,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ActorContext<
+	TState,
+	never,
+	never,
+	never,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {}
+
+export type CreateVarsContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		any,
+		any,
+		any,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? CreateVarsContext<S, I, DB, E, Q>
+		: never;

package/src/actor/contexts/create.ts

@@ -0,0 +1,39 @@
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ActorContext } from "./base/actor";
+
+/**
+ * Context for the onCreate lifecycle hook.
+ */
+export class CreateContext<
+	TState,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ActorContext<
+	TState,
+	never,
+	never,
+	never,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {}
+
+export type CreateContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		any,
+		any,
+		any,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? CreateContext<S, I, DB, E, Q>
+		: never;

package/src/actor/contexts/destroy.ts

@@ -0,0 +1,42 @@
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ActorContext } from "./base/actor";
+
+/**
+ * Context for the onDestroy lifecycle hook.
+ */
+export class DestroyContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ActorContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {}
+
+export type DestroyContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		infer CP,
+		infer CS,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? DestroyContext<S, CP, CS, V, I, DB, E, Q>
+		: never;

package/src/actor/contexts/disconnect.ts

@@ -0,0 +1,43 @@
+import type { Conn } from "../conn/mod";
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ActorContext } from "./base/actor";
+
+/**
+ * Context for the onDisconnect lifecycle hook.
+ */
+export class DisconnectContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ActorContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {}
+
+export type DisconnectContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		infer CP,
+		infer CS,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? DisconnectContext<S, CP, CS, V, I, DB, E, Q>
+		: never;

package/src/actor/contexts/index.ts

@@ -0,0 +1,33 @@
+// Base contexts
+
+// Lifecycle contexts
+export { ActionContext, type ActionContextOf } from "./action";
+export { ActorContext, type ActorContextOf } from "./base/actor";
+export { ConnContext, type ConnContextOf } from "./base/conn";
+export { ConnInitContext, type ConnInitContextOf } from "./base/conn-init";
+export {
+	BeforeActionResponseContext,
+	type BeforeActionResponseContextOf,
+} from "./before-action-response";
+export {
+	BeforeConnectContext,
+	type BeforeConnectContextOf,
+} from "./before-connect";
+export { ConnectContext, type ConnectContextOf } from "./connect";
+export { CreateContext, type CreateContextOf } from "./create";
+export {
+	CreateConnStateContext,
+	type CreateConnStateContextOf,
+} from "./create-conn-state";
+export { CreateVarsContext, type CreateVarsContextOf } from "./create-vars";
+export { DestroyContext, type DestroyContextOf } from "./destroy";
+export { DisconnectContext, type DisconnectContextOf } from "./disconnect";
+export { RequestContext, type RequestContextOf } from "./request";
+export { RunContext, type RunContextOf } from "./run";
+export { SleepContext, type SleepContextOf } from "./sleep";
+export {
+	StateChangeContext,
+	type StateChangeContextOf,
+} from "./state-change";
+export { WakeContext, type WakeContextOf } from "./wake";
+export { WebSocketContext, type WebSocketContextOf } from "./websocket";

package/src/actor/contexts/request.ts

@@ -0,0 +1,80 @@
+import type { Conn } from "../conn/mod";
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { ActorInstance } from "../instance/mod";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ConnContext } from "./base/conn";
+
+/**
+ * Context for raw HTTP request handlers (onRequest).
+ */
+export class RequestContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ConnContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {
+	/**
+	 * The incoming HTTP request.
+	 * May be undefined for request contexts initiated without a direct HTTP request.
+	 */
+	public readonly request: Request | undefined;
+
+	/**
+	 * @internal
+	 */
+	constructor(
+		actor: ActorInstance<
+			TState,
+			TConnParams,
+			TConnState,
+			TVars,
+			TInput,
+			TDatabase,
+			TEvents,
+			TQueues
+		>,
+		conn: Conn<
+			TState,
+			TConnParams,
+			TConnState,
+			TVars,
+			TInput,
+			TDatabase,
+			TEvents,
+			TQueues
+		>,
+		request?: Request,
+	) {
+		super(actor, conn);
+		this.request = request;
+	}
+}
+
+export type RequestContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		infer CP,
+		infer CS,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? RequestContext<S, CP, CS, V, I, DB, E, Q>
+		: never;

package/src/actor/contexts/run.ts

@@ -0,0 +1,47 @@
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ActorContext } from "./base/actor";
+
+/**
+ * Context for the run lifecycle hook.
+ *
+ * This context is passed to the `run` handler which executes after the actor
+ * starts. It does not block actor startup and is intended for background tasks.
+ *
+ * Use `c.aborted` to detect when the actor is stopping and gracefully exit.
+ */
+export class RunContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ActorContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {}
+
+export type RunContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		infer CP,
+		infer CS,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? RunContext<S, CP, CS, V, I, DB, E, Q>
+		: never;

package/src/actor/contexts/sleep.ts

@@ -0,0 +1,42 @@
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ActorContext } from "./base/actor";
+
+/**
+ * Context for the onSleep lifecycle hook.
+ */
+export class SleepContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ActorContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {}
+
+export type SleepContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		infer CP,
+		infer CS,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? SleepContext<S, CP, CS, V, I, DB, E, Q>
+		: never;

package/src/actor/contexts/state-change.ts

@@ -0,0 +1,42 @@
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ActorContext } from "./base/actor";
+
+/**
+ * Context for the onStateChange lifecycle hook.
+ */
+export class StateChangeContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ActorContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {}
+
+export type StateChangeContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		infer CP,
+		infer CS,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? StateChangeContext<S, CP, CS, V, I, DB, E, Q>
+		: never;

package/src/actor/contexts/wake.ts

@@ -0,0 +1,42 @@
+import type { AnyDatabaseProvider } from "../database";
+import type { ActorDefinition, AnyActorDefinition } from "../definition";
+import type { EventSchemaConfig, QueueSchemaConfig } from "../schema";
+import { ActorContext } from "./base/actor";
+
+/**
+ * Context for the onWake lifecycle hook.
+ */
+export class WakeContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase extends AnyDatabaseProvider,
+	TEvents extends EventSchemaConfig = Record<never, never>,
+	TQueues extends QueueSchemaConfig = Record<never, never>,
+> extends ActorContext<
+	TState,
+	TConnParams,
+	TConnState,
+	TVars,
+	TInput,
+	TDatabase,
+	TEvents,
+	TQueues
+> {}
+
+export type WakeContextOf<AD extends AnyActorDefinition> =
+	AD extends ActorDefinition<
+		infer S,
+		infer CP,
+		infer CS,
+		infer V,
+		infer I,
+		infer DB extends AnyDatabaseProvider,
+		infer E extends EventSchemaConfig,
+		infer Q extends QueueSchemaConfig,
+		any
+	>
+		? WakeContext<S, CP, CS, V, I, DB, E, Q>
+		: never;