@rivetkit/rivetkit-napi 0.0.0-feat-workflows-public-host-apis.1550fe4 → 0.0.0-feat-sqlite-sync.18dce02

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
@@ -44,11 +56,6 @@ export interface JsInspectorSnapshot {
 export interface JsActorRuntimeSocketEndpointInfo {
   path: string
 }
-export interface JsHttpResponse {
-  status?: number
-  headers?: Record<string, string>
-  body?: Buffer
-}
 export interface JsQueueSendResult {
   status: string
   response?: Buffer
@@ -76,11 +83,38 @@ export interface JsInspectorTabEntry {
   /** Set to true for HideBuiltin entries. */
   hidden?: boolean
 }
+/**
+ * Experimental SQLite profiling configuration. This entire configuration
+ * surface is subject to change without notice.
+ */
+export interface JsSqliteProfilingConfig {
+  enabled?: boolean
+  maxTrackedStatementFingerprints?: number
+  maxTrackedTransactionFingerprints?: number
+  maxPrometheusSeries?: number
+  maxStatementsPerTransactionTrace?: number
+  maxGetPagesRequestsPerTrace?: number
+  maxTransactionNameBytes?: number
+  slowOperationThresholdMs?: number
+  baselineSampleRate?: number
+  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
@@ -146,6 +180,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
@@ -189,6 +229,8 @@ export interface JsServeConfig {
   namespace: string
   poolName: string
   engineBinaryPath?: string
+  startServices?: boolean
+  servicesBinaryPath?: string
   engineHost?: string
   enginePort?: number
   handleInspectorHttpInRuntime?: boolean
@@ -223,7 +265,8 @@ export interface JsServerlessResponseHead {
 export interface JsApplicationResponse {
   status: number
   headers: Record<string, string>
-  body: Buffer
+  body?: Buffer
+  stream?: boolean
 }
 export interface JsRegistryRouteResponse {
   status: number
@@ -277,6 +320,13 @@ 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 {
   state(): Buffer
@@ -284,6 +334,22 @@ export declare class ActorContext {
   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
@@ -333,6 +399,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)
 }
@@ -360,20 +462,47 @@ export declare class JsNativeDatabase {
   executeBatch(statements: Array<JsSqliteBatchStatement>): Promise<Array<NativeExecuteResult>>
   exec(sql: string): Promise<QueryResult>
   close(): Promise<void>
-  beginTransaction(timeoutMs?: number | 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>
+  beginTransaction(timeoutMs?: number | undefined | null, name?: string | undefined | null): Promise<JsSqliteTransaction>
 }
 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>
-  exec(sql: string): Promise<QueryResult>
   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>
   put(key: Buffer, value: Buffer): Promise<void>

package/index.js

@@ -310,20 +310,27 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { ActorContext, decodeInspectorRequest, encodeInspectorResponse, NapiActorFactory, CancellationToken, ConnHandle, JsNativeDatabase, JsSqliteTransaction, JsActorStateTransaction, Kv, Queue, QueueMessage, CoreRegistry, Schedule, WebSocket } = nativeBinding
+const { ActorContext, decodeInspectorRequest, encodeInspectorResponse, OutboundCall, WorkflowSpan, WorkflowStepSpan, NapiActorFactory, CancellationToken, 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.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-feat-workflows-public-host-apis.1550fe4",
+	"version": "0.0.0-feat-sqlite-sync.18dce02",
 	"description": "Native N-API addon for RivetKit providing envoy client and SQLite access",
 	"license": "Apache-2.0",
 	"main": "index.js",
@@ -44,19 +44,19 @@
 	},
 	"dependencies": {
 		"@napi-rs/cli": "^2.18.4",
-		"@rivetkit/engine-envoy-protocol": "0.0.0-feat-workflows-public-host-apis.1550fe4"
+		"@rivetkit/engine-envoy-protocol": "0.0.0-feat-sqlite-sync.18dce02"
 	},
 	"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-feat-workflows-public-host-apis.1550fe4",
-		"@rivetkit/rivetkit-napi-darwin-x64": "0.0.0-feat-workflows-public-host-apis.1550fe4",
-		"@rivetkit/rivetkit-napi-linux-arm64-gnu": "0.0.0-feat-workflows-public-host-apis.1550fe4",
-		"@rivetkit/rivetkit-napi-linux-arm64-musl": "0.0.0-feat-workflows-public-host-apis.1550fe4",
-		"@rivetkit/rivetkit-napi-linux-x64-gnu": "0.0.0-feat-workflows-public-host-apis.1550fe4",
-		"@rivetkit/rivetkit-napi-linux-x64-musl": "0.0.0-feat-workflows-public-host-apis.1550fe4"
+		"@rivetkit/rivetkit-napi-darwin-arm64": "0.0.0-feat-sqlite-sync.18dce02",
+		"@rivetkit/rivetkit-napi-darwin-x64": "0.0.0-feat-sqlite-sync.18dce02",
+		"@rivetkit/rivetkit-napi-linux-arm64-gnu": "0.0.0-feat-sqlite-sync.18dce02",
+		"@rivetkit/rivetkit-napi-linux-arm64-musl": "0.0.0-feat-sqlite-sync.18dce02",
+		"@rivetkit/rivetkit-napi-linux-x64-gnu": "0.0.0-feat-sqlite-sync.18dce02",
+		"@rivetkit/rivetkit-napi-linux-x64-musl": "0.0.0-feat-sqlite-sync.18dce02"
 	}
 }