@supalive/core 1.2.1 → 1.3.0

package/dist/types_server-C9owgeSs.d.ts

@@ -0,0 +1,302 @@
+import { Bt as SupaliveDb, Ft as JobScheduler, Sr as MutationResult, nt as RegisteredProcedure, qn as CacheLayer } from "./index-DDK9ZIYb.js";
+import { r as ObjectStorage } from "./object-storage-4t7JvpuK.js";
+import z from "zod";
+import { IncomingMessage } from "http";
+import { WebSocket } from "ws";
+import { Level } from "pino";
+import { Redis } from "ioredis";
+
+//#region src/config.d.ts
+/** CORS policy for the HTTP RPC endpoint. */
+interface RpcCorsConfig {
+  /**
+   * Allowed origins. `"*"` sends `Access-Control-Allow-Origin: *`; a list
+   * echoes back a request's `Origin` only when it matches (and sets `Vary`).
+   * Omit `cors` entirely to send no CORS headers (same-origin only).
+   */
+  origins: string[] | "*";
+}
+/** Rate-limit policy for the HTTP RPC endpoint (fixed window, per instance). */
+interface RpcRateLimitConfig {
+  /** Window length in ms. Default 60000. */
+  windowMs?: number;
+  /** Max requests per window per key. Default 120. */
+  max?: number;
+  /**
+   * Derive the limiter key from the request. Default: client IP
+   * (`X-Forwarded-For` first hop, else socket address). Return a stable string.
+   */
+  keyBy?: (req: IncomingMessage) => string;
+}
+/**
+ * Enables a one-shot HTTP RPC transport for `query`/`mutation`/`action`
+ * (no subscriptions — those stay WebSocket-only). Lets clients that don't need
+ * live queries call procedures without holding a socket open. Omit to disable
+ * the endpoint entirely.
+ */
+interface RpcConfig<TContext = unknown> {
+  /**
+   * URL path prefix. Default `/_rpc`. A procedure `foo` is called as
+   * `POST {path}/foo`. Keep this distinct from `jobPath`.
+   */
+  path?: string;
+  /**
+   * Map an HTTP request to the auth `data` handed to `verifyAuth` (the same
+   * callback the WebSocket path uses). Default: `Authorization: Bearer <token>`
+   * → `{ token }`. Return `undefined` for an anonymous request.
+   */
+  auth?: (req: IncomingMessage) => Record<string, unknown> | undefined;
+  /** CORS policy. Omit for same-origin only (no CORS headers). */
+  cors?: RpcCorsConfig;
+  /** Rate limiting. Omit for defaults (120/min per IP); set `false` to disable. */
+  rateLimit?: RpcRateLimitConfig | false;
+}
+interface UpstashConfig {
+  url: string;
+  token: string;
+  redisUrl: string;
+}
+/** Database configuration for PostgreSQL */
+interface PostgresConfig {
+  type: "postgres";
+  connectionString: string;
+  /** Optional max connections for the Postgres connection pool. Defaults to 10.*/
+  maxConnections?: number;
+  /** Optional min connections for the Postgres connection pool. Defaults to 1.*/
+  minConnections?: number;
+  /** Optional idle timeout for Postgres connections in milliseconds. Defaults to 30000 (30 seconds). */
+  idleTimeoutMillis?: number;
+  /** Optional connection timeout for acquiring Postgres connections in milliseconds. Defaults to 7000 (7 seconds). */
+  connectionTimeoutMillis?: number;
+}
+/** Database configuration for MySQL */
+interface MySQLConfig {
+  type: "mysql";
+  connectionString: string;
+  /** Optional max connections for the MySQL connection pool. Defaults to 20.*/
+  maxConnections?: number;
+  /** Optional min connections for the MySQL connection pool. Defaults to 1.*/
+  minConnections?: number;
+  /** Optional idle timeout for MySQL connections in milliseconds. Defaults to 30000 (30 seconds). */
+  idleTimeoutMillis?: number;
+  /** Optional connection timeout for acquiring MySQL connections in milliseconds. Defaults to 7000 (7 seconds). */
+  connectionTimeoutMillis?: number;
+  /** Optional flag to queue connection requests when pool is exhausted. Defaults to true (queue requests). */
+  queueLimit?: number;
+}
+type DatabaseConfig = PostgresConfig | MySQLConfig;
+/**
+ * Configuration for the Supalive WebSocket server.
+ */
+interface SupaliveServerConfig<TContext = Record<string, unknown>> {
+  /** Server port (default: 3000) */
+  port?: number;
+  /** Server host (default: "0.0.0.0") */
+  host?: string;
+  cacheLayer: CacheLayer;
+  redisSubClient: Redis;
+  /**
+   * Subscription Manager WebSocket URL for RPC communication.
+   * A single sub-manager process owns all subscription state for this
+   * deployment. Internally it spawns N logical workers (configured on the
+   * sub-manager side) and routes by hash(subId) to spread CPU across them.
+   */
+  subManagerUrl: string;
+  /** Database instance */
+  database: SupaliveDb;
+  /**
+   * Optional authentication callback.
+   * Called when client sends auth message.
+   * Return null to reject authentication.
+   */
+  verifyAuth?: (data: Record<string, unknown>, sessionId: string) => Promise<TContext | null>;
+  /**
+   * Server context name for procedure routing.
+   * Must match the router's contextName.
+   */
+  contextName?: string;
+  /**
+   * Session TTL in seconds (default: 3600 = 1 hour).
+   * Sessions are kept alive while connected and expire after disconnect.
+   */
+  sessionTtlSeconds?: number;
+  /**
+   * Enable detailed logging.
+   */
+  logLevel?: Level;
+  /**
+   * Extract user ID from context for cache key generation.
+   * If not provided, caching is disabled (each sub recomputes independently).
+   */
+  getUserId?: (ctx: TContext | undefined) => string | null;
+  /**
+   * Cache TTL in seconds (default: 3600).
+   * How long query results are cached in Redis.
+   */
+  cacheTtlSeconds?: number;
+  /**
+   * Scheduler backing the job system. When provided, the server exposes an
+   * HTTP endpoint (`{jobPath}/<jobName>`) that the scheduler POSTs to, and
+   * syncs every registered recurring (cron) job at startup. Omit to disable
+   * jobs entirely. Use `DevScheduler` locally and `QStashScheduler` in prod.
+   */
+  scheduler: JobScheduler;
+  /**
+   * Builds the system server context handed to a job handler's `serverCtx`.
+   * Jobs run without a client, so this is where a deployment injects its
+   * "system"/service identity. Called per job invocation.
+   */
+  jobContext?: () => TContext | Promise<TContext>;
+  /**
+   * Absolute, externally-reachable base URL of this server (no trailing
+   * slash), e.g. `https://api.example.com` in prod or `http://127.0.0.1:3000`
+   * in dev. Used to build the job endpoint the scheduler calls. Required when
+   * `scheduler` is set.
+   */
+  publicUrl?: string;
+  /**
+   * URL path prefix for the job webhook endpoint. Default `/_jobs`. The full
+   * endpoint for a job is `{publicUrl}{jobPath}/<jobName>`.
+   */
+  jobPath?: string;
+  /**
+   * Enable the one-shot HTTP RPC transport (query/mutation/action over
+   * `POST {rpc.path}/<name>`). Uses the same `verifyAuth` as the WebSocket
+   * path. Omit to disable. See {@link RpcConfig}.
+   */
+  rpc?: RpcConfig<TContext>;
+  /**
+   * Object storage, exposed to every procedure as `ctx.storage`. When set,
+   * query/mutation/action/job handlers can presign uploads/downloads and
+   * resolve public URLs without reaching for a module-level singleton. Omit
+   * to leave `ctx.storage` undefined (handlers should treat uploads as
+   * unconfigured). Build one with `S3CompatibleStorage` from
+   * `@supalive/core/storage`.
+   */
+  storage: ObjectStorage;
+}
+interface SubscriptionManagerConfig {
+  port: number;
+  upstash: {
+    url: string;
+    token: string;
+    redisUrl: string;
+  };
+  database: DatabaseConfig;
+  cacheTTLSeconds: number;
+  /**
+   * Number of logical workers inside the sub-manager process.
+   *
+   * Subscriptions are routed by FNV-1a(subId) % workers so that all operations
+   * for a given subId always land on the same worker (preserving the existing
+   * `instances: Set<string>` dedup). Each worker owns an independent
+   * subscriptions Map; on invalidate, all workers scan their own slice in
+   * parallel (logically — JS still runs one at a time inside one event loop,
+   * but per-worker scans are smaller so total work is split N ways).
+   *
+   * Defaults to `SUPALIVE_SUB_MANAGER_WORKERS` env var if set, else 1.
+   */
+  workers?: number;
+  /**
+   * Connection pool size *per worker*. If omitted, falls back to
+   * `floor(database.maxConnections / workers)` (min 1) so the total pool
+   * size stays close to the legacy single-worker configuration.
+   */
+  maxConnectionsPerWorker?: number;
+}
+//#endregion
+//#region src/server/types_server.d.ts
+type InstanceId = string;
+type SubId = string;
+/** Local tracking of an active subscription (per-session) */
+interface SubscriptionEntry {
+  subId: SubId;
+  cacheKey: string;
+  subscribedTimes: number;
+}
+/**
+ * A mutation that has been validated and parked on the per-session FIFO
+ * queue, waiting for the in-flight mutation on this socket to finish. Each
+ * `handleCall` for a mutation owns one of these and awaits its own
+ * resolve/reject so it can send the response.
+ */
+interface PendingMutation<TContext = Record<string, unknown>> {
+  procedure: RegisteredProcedure<TContext>;
+  validatedInput: unknown;
+  resolve: (result: MutationResult<unknown>) => void;
+  reject: (err: unknown) => void;
+}
+/** WebSocket session (runtime, with WebSocket) */
+interface Session<TContext = Record<string, unknown>> {
+  id: string;
+  ws: WebSocket;
+  /** Auth context from verifyAuth callback */
+  serverCtx?: TContext;
+  subIds: Set<string>;
+  /**
+   * Per-socket FIFO mutation queue. at most one mutation
+   * drains at a time so a single client cannot saturate the OCC retry
+   * loop or fan out concurrent commits that race the same rows.
+   */
+  mutationQueue: PendingMutation<TContext>[];
+  mutationInFlight: boolean;
+  /** Per-socket count of currently executing actions. */
+  actionInFlight: number;
+  /**
+   * Wall-clock of the last inbound frame (text message, ws-ping, or ws-pong).
+   * Used by the per-session heartbeat to terminate sockets that have gone
+   * silent past `CLIENT_TIMEOUT_MS`.
+   */
+  lastReceivedAt: number;
+  /**
+   * Wall-clock of the last outbound frame. Gates the idle-only app-level
+   * ping so a busy session (frequent sub:updates etc.) doesn't emit a
+   * redundant `{type:"ping"}` on every heartbeat tick.
+   */
+  lastSentAt: number;
+  /**
+   * Per-session combined heartbeat. Single `setInterval` that handles
+   * both dead-TCP detection (ws-ping or terminate) and client-watchdog
+   * refresh (idle-only app-level ping) on each tick.
+   */
+  heartbeatTimer: ReturnType<typeof setInterval> | null;
+}
+declare const RemoteSubscriptionUpdateSchema: z.ZodObject<{
+  type: z.ZodLiteral<"update">;
+  subId: z.ZodString;
+  data: z.ZodUnknown;
+  dataHash: z.ZodString;
+  originInstance: z.ZodString;
+}, z.core.$strip>;
+type RemoteSubscriptionUpdate = z.infer<typeof RemoteSubscriptionUpdateSchema>;
+declare const RemoteRecomputeRaceSchema: z.ZodObject<{
+  type: z.ZodLiteral<"recompute-race">;
+  subId: z.ZodString;
+  cacheKey: z.ZodString;
+  queryName: z.ZodString;
+  args: z.ZodUnknown;
+  notifyInstances: z.ZodArray<z.ZodString>;
+  commitTs: z.ZodString;
+  originInstance: z.ZodString;
+}, z.core.$strip>;
+type RemoteRecomputeRace = z.infer<typeof RemoteRecomputeRaceSchema>;
+declare const RemoteSubscriptionMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+  type: z.ZodLiteral<"update">;
+  subId: z.ZodString;
+  data: z.ZodUnknown;
+  dataHash: z.ZodString;
+  originInstance: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+  type: z.ZodLiteral<"recompute-race">;
+  subId: z.ZodString;
+  cacheKey: z.ZodString;
+  queryName: z.ZodString;
+  args: z.ZodUnknown;
+  notifyInstances: z.ZodArray<z.ZodString>;
+  commitTs: z.ZodString;
+  originInstance: z.ZodString;
+}, z.core.$strip>], "type">;
+type RemoteSubscriptionMessage = z.infer<typeof RemoteSubscriptionMessageSchema>;
+//#endregion
+export { RpcRateLimitConfig as _, RemoteSubscriptionMessage as a, UpstashConfig as b, RemoteSubscriptionUpdateSchema as c, SubscriptionEntry as d, DatabaseConfig as f, RpcCorsConfig as g, RpcConfig as h, RemoteRecomputeRaceSchema as i, Session as l, PostgresConfig as m, PendingMutation as n, RemoteSubscriptionMessageSchema as o, MySQLConfig as p, RemoteRecomputeRace as r, RemoteSubscriptionUpdate as s, InstanceId as t, SubId as u, SubscriptionManagerConfig as v, SupaliveServerConfig as y };
+//# sourceMappingURL=types_server-C9owgeSs.d.ts.map

package/dist/types_server-C9owgeSs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types_server-C9owgeSs.d.ts","names":[],"sources":["../src/config.ts","../src/server/types_server.ts"],"mappings":";;;;;;;;;;UASiB,aAAA;EAAA;;;;AAMR;EAAP,OAAO;AAAA;;UAIQ,kBAAA;EAEf;EAAA,QAAA;EAOA;EALA,GAAA;EAKS;;AAAoB;AAS/B;EATE,KAAA,IAAS,GAAA,EAAK,eAAe;AAAA;;;;;;;UASd,SAAA;EAKf;;;;EAAA,IAAA;EAQA;;;;;EAFA,IAAA,IAAQ,GAAA,EAAK,eAAA,KAAoB,MAAA;EAOlB;EALf,IAAA,GAAO,aAAA;;EAEP,SAAA,GAAY,kBAAA;AAAA;AAAA,UAGG,aAAA;EACb,GAAA;EACA,KAAA;EACA,QAAA;AAAA;;UAIa,cAAA;EACb,IAAA;EACA,gBAAA;EAAA;EAEA,cAAA;EAGA;EAAA,cAAA;EAMA;EAHA,iBAAA;EAGuB;EAAvB,uBAAA;AAAA;;UAIa,WAAA;EACb,IAAA;EACA,gBAAA;EAEA;EAAA,cAAA;EAMA;EAHA,cAAA;EASA;EANA,iBAAA;EAMU;EAHV,uBAAA;EAMsB;EAHtB,UAAA;AAAA;AAAA,KAGQ,cAAA,GAAiB,cAAA,GAAiB,WAAW;AAKzD;;;AAAA,UAAiB,oBAAA,YAAgC,MAAA;EAUjC;EARZ,IAAA;EAuBU;EApBV,IAAA;EAKA,UAAA,EAAY,UAAA;EAIZ,cAAA,EAAgB,KAAA;EAsCL;;;;;;EA9BX,aAAA;EA8EM;EA3EN,QAAA,EAAU,UAAA;EAqFY;;;;;EA9EtB,UAAA,IACI,IAAA,EAAM,MAAA,mBACN,SAAA,aACC,OAAA,CAAQ,QAAA;EAzBb;;;;EA+BA,WAAA;EAhBA;;;;EAsBA,iBAAA;EAbI;;;EAkBJ,QAAA,GAAW,KAAA;EALX;;;;EAWA,SAAA,IAAa,GAAA,EAAK,QAAA;EAAL;;;;EAMb,eAAA;EAemB;;;;;;EAPnB,SAAA,EAAW,YAAA;EA4BK;;;;AAUM;EA/BtB,UAAA,SAAmB,QAAA,GAAW,OAAA,CAAQ,QAAA;EAkCA;;;;;;EA1BtC,SAAA;EA4BuC;;;;EAtBvC,OAAA;EA2CA;;AAAuB;;;EApCvB,GAAA,GAAM,SAAA,CAAU,QAAA;ECpMR;;;;AAAU;AAEtB;;;ED4MI,OAAA,EAAS,aAAA;AAAA;AAAA,UAGI,yBAAA;EACb,IAAA;EACA,OAAA;IAAW,GAAA;IAAa,KAAA;IAAe,QAAA;EAAA;EACvC,QAAA,EAAU,cAAc;EACxB,eAAA;EC7Ma;AASjB;;;;;;;;;;;EDiNI,OAAA;EChNS;;;;;EDsNT,uBAAA;AAAA;;;KCxOQ,UAAA;AAAA,KAEA,KAAA;;UAGK,iBAAA;EACf,KAAA,EAAO,KAAK;EACZ,QAAA;EACA,eAAA;AAAA;;ADAO;AAIT;;;;UCKiB,eAAA,YAA2B,MAAA;EAC1C,SAAA,EAAW,mBAAA,CAAoB,QAAA;EAC/B,cAAA;EACA,OAAA,GAAU,MAAA,EAAQ,cAAA;EAClB,MAAA,GAAS,GAAA;AAAA;ADAoB;AAAA,UCId,OAAA,YAAmB,MAAA;EAClC,EAAA;EACA,EAAA,EAAI,SAAA;EDcS;ECZb,SAAA,GAAY,QAAA;EACZ,MAAA,EAAQ,GAAA;EDeI;;;;;ECTZ,aAAA,EAAe,eAAA,CAAgB,QAAA;EAC/B,gBAAA;EDIQ;ECFR,cAAA;EDIA;;;;;ECEA,cAAA;EDGe;;;;;ECGf,UAAA;EDAE;;AAAQ;AAIZ;;ECEE,cAAA,EAAgB,UAAA,QAAkB,WAAA;AAAA;AAAA,cAgBvB,8BAAA,EAA8B,CAAA,CAAA,SAAA;;;;;;;KAO/B,wBAAA,GAA2B,CAAA,CAAE,KAAK,QAAQ,8BAAA;AAAA,cAEzC,yBAAA,EAAyB,CAAA,CAAA,SAAA;;;;;;;;;;KAU1B,mBAAA,GAAsB,CAAA,CAAE,KAAK,QAAQ,yBAAA;AAAA,cAEpC,+BAAA,EAA+B,CAAA,CAAA,qBAAA,EAAA,CAAA,CAAA,SAAA;;;;;;;;;;;;;;;;KAIhC,yBAAA,GAA4B,CAAA,CAAE,KAAK,QAAQ,+BAAA"}