@rivetkit/rivetkit-napi 0.0.0-sqlite-profiling-compat.4a9a623 → 0.0.0-sqlite-sync-3x-release.a00b07f

package/index.d.ts

@@ -8,6 +8,18 @@ export interface JsActorKeySegment {
   stringValue?: string
   numberValue?: number
 }
+/** Active actor invocation correlation exposed to the TypeScript runtime adapter. */
+export interface JsActorInvocationTraceContext {
+  rayId?: string
+  span?: JsActorInvocationSpanContext
+}
+/** W3C span context of the current invocation span, present only when tracing is active. */
+export interface JsActorInvocationSpanContext {
+  traceId: string
+  spanId: string
+  traceFlags: number
+  tracestate?: string
+}
 export interface JsHttpRequest {
   method: string
   uri: string
@@ -23,10 +35,16 @@ export interface StateDeltaPayload {
   connHibernation: Array<StateDeltaConnHibernationEntry>
   connHibernationRemoved: Array<string>
 }
+export interface WorkflowKvWritePayload {
+  key: Buffer
+  value: Buffer
+}
 export interface JsRequestSaveOpts {
   immediate?: boolean
   maxWaitMs?: number
 }
+export declare function decodeInspectorRequest(bytes: Buffer, advertisedVersion: number): Buffer
+export declare function encodeInspectorResponse(bytes: Buffer, targetVersion: number): Buffer
 export interface JsInspectorSnapshot {
   stateRevision: number
   connectionsRevision: number
@@ -35,10 +53,8 @@ export interface JsInspectorSnapshot {
   queueSize: number
   connectedClients: number
 }
-export interface JsHttpResponse {
-  status?: number
-  headers?: Record<string, string>
-  body?: Buffer
+export interface JsActorRuntimeSocketEndpointInfo {
+  path: string
 }
 export interface JsQueueSendResult {
   status: string
@@ -72,7 +88,8 @@ export interface JsInspectorTabEntry {
  * surface is subject to change without notice.
  */
 export interface JsSqliteProfilingConfig {
-  enabled?: boolean
+  queries?: Array<string>
+  fingerprints?: Array<string>
   maxTrackedStatementFingerprints?: number
   maxTrackedTransactionFingerprints?: number
   maxPrometheusSeries?: number
@@ -84,12 +101,22 @@ export interface JsSqliteProfilingConfig {
   maxDiagnosticEventsPerMinute?: number
   diagnosticEventQueueCapacity?: number
 }
+/** Per-actor trace sample rates, from 0 to 1. */
+export interface JsActorTracingConfig {
+  sampler?: number
+  /** Keyed by flattened, dot-separated action name. */
+  actions?: Record<string, number>
+}
 export interface JsActorConfig {
   name?: string
   icon?: string
   hasDatabase?: boolean
   remoteSqlite?: boolean
+  /** Internal. Set by rivetkit when the actor's database provider opts into deferred commits. */
+  sqliteDeferredCommits?: boolean
   sqliteProfiling?: JsSqliteProfilingConfig
+  tracing?: JsActorTracingConfig
+  enableActorRuntimeSocket?: boolean
   hasState?: boolean
   canHibernateWebsocket?: boolean
   stateSaveIntervalMs?: number
@@ -110,11 +137,10 @@ export interface JsActorConfig {
   connectionLivenessTimeoutMs?: number
   connectionLivenessIntervalMs?: number
   maxQueueSize?: number
+  maxSchedules?: number
   maxQueueMessageSize?: number
   maxIncomingMessageSize?: number
   maxOutgoingMessageSize?: number
-  preloadMaxWorkflowBytes?: number
-  preloadMaxConnectionsBytes?: number
   actions?: Array<JsActionDefinition>
   inspectorTabs?: Array<JsInspectorTabEntry>
 }
@@ -138,6 +164,10 @@ export interface NativeExecuteResult {
   changes: number
   lastInsertRowId?: number
 }
+export interface JsSqliteBatchStatement {
+  sql: string
+  params?: Array<JsBindParam>
+}
 export interface JsSqliteVfsMetrics {
   requestBuildNs: number
   serializeNs: number
@@ -151,6 +181,12 @@ export interface JsSqliteVfsMetrics {
   writeBufferDirtyPages: number
   dbSizePages: number
 }
+export interface JsHttpResponse {
+  status?: number
+  headers?: Record<string, string>
+  body?: Buffer
+  stream?: boolean
+}
 export interface JsQueueNextOptions {
   names?: Array<string>
   timeoutMs?: number
@@ -194,6 +230,9 @@ export interface JsServeConfig {
   namespace: string
   poolName: string
   engineBinaryPath?: string
+  startServices?: boolean
+  servicesBinaryPath?: string
+  engineSpawn?: boolean
   engineHost?: string
   enginePort?: number
   handleInspectorHttpInRuntime?: boolean
@@ -225,6 +264,12 @@ export interface JsServerlessResponseHead {
   status: number
   headers: Record<string, string>
 }
+export interface JsApplicationResponse {
+  status: number
+  headers: Record<string, string>
+  body?: Buffer
+  stream?: boolean
+}
 export interface JsRegistryRouteResponse {
   status: number
   headers: Record<string, string>
@@ -235,6 +280,38 @@ export interface JsServerlessStreamError {
   code: string
   message: string
 }
+export interface JsScheduledEventInfo {
+  id: string
+  action: string
+  args: Buffer
+  runAt: number
+}
+export interface JsCronJobInfo {
+  name: string
+  kind: string
+  action: string
+  args: Buffer
+  nextRunAt: number
+  lastRunAt?: number
+  expression?: string
+  timezone?: string
+  intervalMs?: number
+  maxHistory: number
+}
+export interface JsScheduleErrorInfo {
+  group: string
+  code: string
+  message: string
+  metadata?: any
+}
+export interface JsCronFire {
+  action: string
+  scheduledAt: number
+  firedAt: number
+  finishedAt?: number
+  result: string
+  error?: JsScheduleErrorInfo
+}
 /** Options for KV list operations. */
 export interface JsKvListOptions {
   reverse?: boolean
@@ -245,14 +322,37 @@ export interface JsKvEntry {
   key: Buffer
   value: Buffer
 }
+/**
+ * Routes the OpenTelemetry SDK's own warnings, such as dropped spans, to the
+ * JavaScript logger. Each call replaces the previous sink. The sink is
+ * released by `shutdownTelemetry`.
+ */
+export declare function setTelemetryLogSink(callback: (...args: any[]) => any): void
+export declare function shutdownTelemetry(): Promise<void>
 /** N-API wrapper around `rivetkit-core::ActorContext`. */
 export declare class ActorContext {
-  constructor(actorId: string, name: string, region: string)
   state(): Buffer
   beginOnStateChange(): void
   endOnStateChange(): void
   kv(): Kv
   sql(): JsNativeDatabase
+  sameActorInstance(other: ActorContext): boolean
+  /**
+   * Returns a handle for the same invocation whose Core spans parent to the
+   * application span active in JavaScript, given as W3C headers.
+   */
+  withApplicationSpan(traceparent?: string | undefined | null, tracestate?: string | undefined | null): ActorContext
+  invocationTraceContext(): JsActorInvocationTraceContext | null
+  /**
+   * Opens the span covering one call out to another actor. Returns nothing
+   * when this handle serves no invocation or tracing is disabled, in which
+   * case the caller sends its own context as before.
+   */
+  startCallSpan(actorName: string, actionName: string): OutboundCall | null
+  startWorkflowSpan(): Promise<WorkflowSpan>
+  /** Returns nothing outside a workflow run or when tracing is off. */
+  startWorkflowStepSpan(stepName: string, attempt: number): WorkflowStepSpan | null
+  provisionActorRuntimeSocket(): Promise<JsActorRuntimeSocketEndpointInfo>
   schedule(): Schedule
   queue(): Queue
   setAlarm(timestampMs?: number | undefined | null): void
@@ -267,6 +367,8 @@ export declare class ActorContext {
   takePendingHibernationChanges(): Array<string>
   dirtyHibernatableConns(): Array<ConnHandle>
   saveState(payload: StateDeltaPayload): Promise<void>
+  beginStateTransaction(timeoutMs?: number | undefined | null): Promise<JsActorStateTransaction>
+  saveStateAndWorkflowBatch(writes: Array<WorkflowKvWritePayload>): Promise<void>
   actorId(): string
   name(): string
   key(): Array<JsActorKeySegment>
@@ -280,6 +382,7 @@ export declare class ActorContext {
   aborted(): boolean
   runHandlerActive(): boolean
   restartRunHandler(): void
+  setRunWakeAt(timestampMs?: number | undefined | null): Promise<void>
   beginKeepAwake(): number
   endKeepAwake(regionId: number): void
   keepAwake(promise: Promise<any>): void
@@ -298,6 +401,42 @@ export declare class ActorContext {
   runtimeState(): object
   clearRuntimeState(): void
 }
+/**
+ * One open call out to another actor.
+ *
+ * The call spans a request made by the host runtime, so it is opened and closed
+ * by two separate calls. Letting this be collected without finishing records
+ * the call as cancelled rather than silently losing it.
+ */
+export declare class OutboundCall {
+  /**
+   * W3C context of this call's span, to send to the callee so it parents to
+   * the call rather than to the invocation that made it.
+   */
+  spanContext(): JsActorInvocationSpanContext | null
+  /**
+   * Records the call's outcome. `error` is the failure as the bridge encodes
+   * it, so a structured error keeps its group and code while anything else
+   * stays unstructured for Core to classify.
+   */
+  finish(error?: string | undefined | null): void
+}
+/**
+ * One open workflow run. Collecting it without `finish` records the run as
+ * abandoned.
+ */
+export declare class WorkflowSpan {
+  /** The context workflow code runs under. */
+  ctx(): ActorContext
+  finish(outcome: string): Promise<void>
+}
+/** One open attempt at one workflow step. */
+export declare class WorkflowStepSpan {
+  /** The context the step's callback runs under. */
+  ctx(): ActorContext
+  /** `error` is what the step threw, as the bridge encodes it. */
+  finish(outcome: string, error?: string | undefined | null): void
+}
 export declare class NapiActorFactory {
   constructor(callbacks: object, config?: JsActorConfig | undefined | null)
 }
@@ -305,7 +444,28 @@ export declare class CancellationToken {
   constructor()
   aborted(): boolean
   cancel(): void
-  onCancelled(callback: (...args: any[]) => any): void
+  /**
+   * Calls `callback` once when the token is cancelled.
+   *
+   * The returned listener must be released when the caller stops caring
+   * about cancellation. Releasing ends the waiting task and frees the
+   * threadsafe function, which otherwise stays alive (with its libuv handle
+   * and JS closure) until the token is cancelled.
+   */
+  onCancelled(callback: (...args: any[]) => any): CancellationListener
+}
+/**
+ * Registration returned by `CancellationToken.onCancelled`.
+ *
+ * Dropping the JS object does not release the listener, because the callback
+ * must still fire if the caller keeps no reference to the registration.
+ */
+export declare class CancellationListener {
+  /**
+   * Stops waiting for cancellation without calling the callback.
+   * Idempotent, and a no-op after the callback has fired.
+   */
+  release(): void
 }
 export declare class ConnHandle {
   id(): string
@@ -322,8 +482,49 @@ export declare class JsNativeDatabase {
   run(sql: string, params?: Array<JsBindParam> | undefined | null): Promise<ExecuteResult>
   query(sql: string, params?: Array<JsBindParam> | undefined | null): Promise<QueryResult>
   execute(sql: string, params?: Array<JsBindParam> | undefined | null): Promise<NativeExecuteResult>
+  executeBatch(statements: Array<JsSqliteBatchStatement>): Promise<Array<NativeExecuteResult>>
   exec(sql: string): Promise<QueryResult>
   close(): Promise<void>
+  beginTransaction(timeoutMs?: number | undefined | null, name?: string | undefined | null): Promise<JsSqliteTransaction>
+  /** Opens the database so later synchronous calls never fetch its first pages. */
+  open(): Promise<void>
+  executeSync(sql: string, params?: Array<JsBindParam> | undefined | null): NativeExecuteResult
+  execSync(sql: string): QueryResult
+  beginTransactionSync(timeoutMs?: number | undefined | null, name?: string | undefined | null): JsSqliteTransaction
+  /**
+   * Returns the latest local commit as a ticket. Tickets stay below 2^53 for any realistic
+   * generation, so they cross to JavaScript as numbers.
+   */
+  commitTicket(): number
+  abortGeneration(reason: string): void
+  whenDurable(ticket: number): Promise<void>
+}
+export declare class JsSqliteTransaction {
+  execute(sql: string, params?: Array<JsBindParam> | undefined | null): Promise<NativeExecuteResult>
+  exec(sql: string): Promise<QueryResult>
+  commit(): Promise<void>
+  rollback(): Promise<void>
+  executeSync(sql: string, params?: Array<JsBindParam> | undefined | null): NativeExecuteResult
+  execSync(sql: string): QueryResult
+  commitSync(): void
+  rollbackSync(): void
+}
+export declare class JsActorStateTransaction {
+  execute(sql: string, params?: Array<JsBindParam> | undefined | null): Promise<NativeExecuteResult>
+  commit(payload: StateDeltaPayload): Promise<void>
+  rollback(): Promise<void>
+}
+/** JavaScript-facing writer for a streaming actor HTTP response. */
+export declare class HttpResponseBodyStream {
+  cancelled(): Promise<void>
+  write(chunk: Buffer): Promise<void>
+  end(): Promise<void>
+  error(message: string): Promise<void>
+}
+/** JavaScript-facing reader for a streaming actor HTTP request. */
+export declare class HttpRequestBodyStream {
+  read(): Promise<Buffer | null>
+  cancel(): Promise<void>
 }
 export declare class Kv {
   get(key: Buffer): Promise<Buffer | null>
@@ -342,10 +543,12 @@ export declare class Queue {
   nextBatch(options?: JsQueueNextBatchOptions | undefined | null, signal?: CancellationToken | undefined | null): Promise<Array<QueueMessage>>
   waitForNames(names: Array<string>, options?: JsQueueWaitOptions | undefined | null, signal?: CancellationToken | undefined | null): Promise<QueueMessage>
   waitForNamesAvailable(names: Array<string>, options?: JsQueueWaitOptions | undefined | null, signal?: CancellationToken | undefined | null): Promise<void>
+  completePersisted(messageId: bigint, expectedName: string, response?: Buffer | undefined | null): Promise<boolean>
   enqueueAndWait(name: string, body: Buffer, options?: JsQueueEnqueueAndWaitOptions | undefined | null, signal?: CancellationToken | undefined | null): Promise<Buffer | null>
   tryNext(options?: JsQueueTryNextOptions | undefined | null): QueueMessage | null
   tryNextBatch(options?: JsQueueTryNextBatchOptions | undefined | null): Array<QueueMessage>
   maxSize(): number
+  reset(): Promise<void>
   inspectMessages(): Promise<Array<JsQueueInspectMessage>>
 }
 export declare class QueueMessage {
@@ -360,6 +563,13 @@ export declare class CoreRegistry {
   constructor()
   register(name: string, factory: NapiActorFactory): void
   serve(config: JsServeConfig): Promise<void>
+  /**
+   * Wait until the serverful envoy has completed its Engine registration.
+   *
+   * Readiness is the envoy client's `ToEnvoyInit` signal, not HTTP health or
+   * merely constructing the envoy handle.
+   */
+  waitReady(): Promise<void>
   /**
    * Trip the shutdown token and tear down any live serverless runtime.
    *
@@ -372,12 +582,22 @@ export declare class CoreRegistry {
   health(): Promise<JsRegistryRouteResponse>
   metadata(): JsRegistryRouteResponse
   metrics(): JsRegistryRouteResponse
-  serveListener(listener: JsListenerConfig, config: JsServeConfig): Promise<void>
+  serveApplicationListener(listener: JsListenerConfig, application: (...args: any[]) => any, config: JsServeConfig): Promise<void>
+  serveListener(listener: JsListenerConfig, config: JsServeConfig, application?: (...args: any[]) => any | undefined | null): Promise<void>
   handleServerlessRequest(req: JsServerlessRequest, onStreamEvent: (...args: any[]) => any, cancelToken: CancellationToken, config: JsServeConfig): Promise<JsServerlessResponseHead>
 }
 export declare class Schedule {
-  after(durationMs: number, actionName: string, args: Buffer): void
-  at(timestampMs: number, actionName: string, args: Buffer): void
+  after(durationMs: number, actionName: string, args: Buffer): Promise<string>
+  at(timestampMs: number, actionName: string, args: Buffer): Promise<string>
+  cancel(id: string): Promise<boolean>
+  get(id: string): Promise<JsScheduledEventInfo | null>
+  list(): Promise<Array<JsScheduledEventInfo>>
+  cronSet(name: string, expression: string, timezone: string | undefined | null, actionName: string, args: Buffer, maxHistory?: number | undefined | null): Promise<void>
+  cronEvery(name: string, intervalMs: number, actionName: string, args: Buffer, maxHistory?: number | undefined | null): Promise<void>
+  cronGet(name: string): Promise<JsCronJobInfo | null>
+  cronList(): Promise<Array<JsCronJobInfo>>
+  cronDelete(name: string): Promise<boolean>
+  cronHistory(name: string, limit?: number | undefined | null): Promise<Array<JsCronFire>>
 }
 export declare class WebSocket {
   send(data: Buffer, binary: boolean): void

package/index.js

@@ -310,16 +310,28 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { ActorContext, NapiActorFactory, CancellationToken, ConnHandle, JsNativeDatabase, Kv, Queue, QueueMessage, CoreRegistry, Schedule, WebSocket } = nativeBinding
+const { ActorContext, decodeInspectorRequest, encodeInspectorResponse, OutboundCall, WorkflowSpan, WorkflowStepSpan, NapiActorFactory, CancellationToken, CancellationListener, ConnHandle, JsNativeDatabase, JsSqliteTransaction, JsActorStateTransaction, HttpResponseBodyStream, HttpRequestBodyStream, Kv, Queue, QueueMessage, CoreRegistry, Schedule, WebSocket, setTelemetryLogSink, shutdownTelemetry } = nativeBinding
 
 module.exports.ActorContext = ActorContext
+module.exports.decodeInspectorRequest = decodeInspectorRequest
+module.exports.encodeInspectorResponse = encodeInspectorResponse
+module.exports.OutboundCall = OutboundCall
+module.exports.WorkflowSpan = WorkflowSpan
+module.exports.WorkflowStepSpan = WorkflowStepSpan
 module.exports.NapiActorFactory = NapiActorFactory
 module.exports.CancellationToken = CancellationToken
+module.exports.CancellationListener = CancellationListener
 module.exports.ConnHandle = ConnHandle
 module.exports.JsNativeDatabase = JsNativeDatabase
+module.exports.JsSqliteTransaction = JsSqliteTransaction
+module.exports.JsActorStateTransaction = JsActorStateTransaction
+module.exports.HttpResponseBodyStream = HttpResponseBodyStream
+module.exports.HttpRequestBodyStream = HttpRequestBodyStream
 module.exports.Kv = Kv
 module.exports.Queue = Queue
 module.exports.QueueMessage = QueueMessage
 module.exports.CoreRegistry = CoreRegistry
 module.exports.Schedule = Schedule
 module.exports.WebSocket = WebSocket
+module.exports.setTelemetryLogSink = setTelemetryLogSink
+module.exports.shutdownTelemetry = shutdownTelemetry

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rivetkit/rivetkit-napi",
-	"version": "0.0.0-sqlite-profiling-compat.4a9a623",
+	"version": "0.0.0-sqlite-sync-3x-release.a00b07f",
 	"description": "Native N-API addon for RivetKit providing envoy client and SQLite access",
 	"license": "Apache-2.0",
 	"main": "index.js",
@@ -43,20 +43,22 @@
 		"build:embed": "node scripts/build.mjs"
 	},
 	"dependencies": {
-		"@napi-rs/cli": "^2.18.4",
-		"@rivetkit/engine-envoy-protocol": "0.0.0-sqlite-profiling-compat.4a9a623"
+		"@rivetkit/engine-envoy-protocol": "0.0.0-sqlite-sync-3x-release.a00b07f"
+	},
+	"devDependencies": {
+		"@napi-rs/cli": "^2.18.4"
 	},
 	"repository": {
 		"type": "git",
-		"url": "https://github.com/rivet-dev/actors.git",
+		"url": "https://github.com/rivet-dev/rivet.git",
 		"directory": "rivetkit-typescript/packages/rivetkit-napi"
 	},
 	"optionalDependencies": {
-		"@rivetkit/rivetkit-napi-darwin-arm64": "0.0.0-sqlite-profiling-compat.4a9a623",
-		"@rivetkit/rivetkit-napi-darwin-x64": "0.0.0-sqlite-profiling-compat.4a9a623",
-		"@rivetkit/rivetkit-napi-linux-arm64-gnu": "0.0.0-sqlite-profiling-compat.4a9a623",
-		"@rivetkit/rivetkit-napi-linux-arm64-musl": "0.0.0-sqlite-profiling-compat.4a9a623",
-		"@rivetkit/rivetkit-napi-linux-x64-gnu": "0.0.0-sqlite-profiling-compat.4a9a623",
-		"@rivetkit/rivetkit-napi-linux-x64-musl": "0.0.0-sqlite-profiling-compat.4a9a623"
+		"@rivetkit/rivetkit-napi-darwin-arm64": "0.0.0-sqlite-sync-3x-release.a00b07f",
+		"@rivetkit/rivetkit-napi-darwin-x64": "0.0.0-sqlite-sync-3x-release.a00b07f",
+		"@rivetkit/rivetkit-napi-linux-arm64-gnu": "0.0.0-sqlite-sync-3x-release.a00b07f",
+		"@rivetkit/rivetkit-napi-linux-arm64-musl": "0.0.0-sqlite-sync-3x-release.a00b07f",
+		"@rivetkit/rivetkit-napi-linux-x64-gnu": "0.0.0-sqlite-sync-3x-release.a00b07f",
+		"@rivetkit/rivetkit-napi-linux-x64-musl": "0.0.0-sqlite-sync-3x-release.a00b07f"
 	}
 }