@valentinkolb/sync 2.0.5 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valentinkolb/sync",
-  "version": "2.0.5",
+  "version": "2.1.0",
   "description": "Distributed synchronization primitives for Bun and TypeScript",
   "main": "index.js",
   "module": "index.js",

package/src/ephemeral.d.ts

@@ -0,0 +1,101 @@
+import type { z } from "zod";
+export declare class EphemeralCapacityError extends Error {
+    constructor(message?: string);
+}
+export declare class EphemeralPayloadTooLargeError extends Error {
+    constructor(message: string);
+}
+export type EphemeralConfig<TSchema extends z.ZodTypeAny> = {
+    id: string;
+    schema: TSchema;
+    ttlMs: number;
+    tenantId?: string;
+    limits?: {
+        maxEntries?: number;
+        maxPayloadBytes?: number;
+        eventRetentionMs?: number;
+        eventMaxLen?: number;
+    };
+};
+export type EphemeralUpsertConfig<T> = {
+    key: string;
+    value: T;
+    ttlMs?: number;
+    tenantId?: string;
+};
+export type EphemeralTouchConfig = {
+    key: string;
+    ttlMs?: number;
+    tenantId?: string;
+};
+export type EphemeralRemoveConfig = {
+    key: string;
+    reason?: string;
+    tenantId?: string;
+};
+export type EphemeralEntry<T> = {
+    key: string;
+    value: T;
+    version: string;
+    updatedAt: number;
+    expiresAt: number;
+};
+export type EphemeralSnapshot<T> = {
+    entries: EphemeralEntry<T>[];
+    cursor: string;
+};
+export type EphemeralRecvConfig = {
+    wait?: boolean;
+    timeoutMs?: number;
+    signal?: AbortSignal;
+};
+export type EphemeralEvent<T> = {
+    type: "upsert";
+    cursor: string;
+    entry: EphemeralEntry<T>;
+} | {
+    type: "touch";
+    cursor: string;
+    key: string;
+    version: string;
+    expiresAt: number;
+} | {
+    type: "delete";
+    cursor: string;
+    key: string;
+    version: string;
+    deletedAt: number;
+    reason?: string;
+} | {
+    type: "expire";
+    cursor: string;
+    key: string;
+    version: string;
+    expiredAt: number;
+} | {
+    type: "overflow";
+    cursor: string;
+    after: string;
+    firstAvailable: string;
+};
+export type EphemeralReader<T> = {
+    recv(cfg?: EphemeralRecvConfig): Promise<EphemeralEvent<T> | null>;
+    stream(cfg?: EphemeralRecvConfig): AsyncIterable<EphemeralEvent<T>>;
+};
+export type EphemeralStore<T> = {
+    upsert(cfg: EphemeralUpsertConfig<T>): Promise<EphemeralEntry<T>>;
+    touch(cfg: EphemeralTouchConfig): Promise<{
+        ok: boolean;
+        version?: string;
+        expiresAt?: number;
+    }>;
+    remove(cfg: EphemeralRemoveConfig): Promise<boolean>;
+    snapshot(cfg?: {
+        tenantId?: string;
+    }): Promise<EphemeralSnapshot<T>>;
+    reader(cfg?: {
+        after?: string;
+        tenantId?: string;
+    }): EphemeralReader<T>;
+};
+export declare const ephemeral: <TSchema extends z.ZodTypeAny>(config: EphemeralConfig<TSchema>) => EphemeralStore<z.infer<TSchema>>;

package/src/internal/cron.d.ts

@@ -0,0 +1,3 @@
+export type MisfirePolicy = "skip" | "catch_up_one" | "catch_up_all";
+export declare const nextCronTimestamp: (cron: string, tz: string, afterTimestampMs: number) => number;
+export declare const assertValidTimeZone: (tz: string) => void;

package/src/job.d.ts

@@ -14,6 +14,7 @@ export type JobTerminal<Result = unknown> = {
 };
 export type SubmitOptions = {
     key?: string;
+    keyTtlMs?: number;
     delayMs?: number;
     at?: number;
     maxAttempts?: number;
@@ -84,6 +85,7 @@ export type JobHandle<Input, Result = unknown> = {
     submit(cfg: {
         input: Input;
     } & SubmitOptions): Promise<JobId>;
+    validateInput(input: unknown): void;
     join(cfg: {
         id: JobId;
     } & JoinOptions): Promise<JobTerminal<Result>>;

package/src/retry.d.ts

@@ -0,0 +1,19 @@
+export type RetryOptions = {
+    attempts?: number;
+    minDelayMs?: number;
+    maxDelayMs?: number;
+    factor?: number;
+    jitter?: number;
+    signal?: AbortSignal;
+    retryIf?: (error: unknown) => boolean;
+};
+export declare const isRetryableTransportError: (error: unknown) => boolean;
+export declare const DEFAULT_RETRY_OPTIONS: {
+    readonly attempts: 8;
+    readonly minDelayMs: 100;
+    readonly maxDelayMs: 2000;
+    readonly factor: 2;
+    readonly jitter: 0.2;
+    readonly retryIf: (error: unknown) => boolean;
+};
+export declare const retry: <T>(fn: (attempt: number) => Promise<T> | T, opts?: RetryOptions) => Promise<T>;

package/src/scheduler.d.ts

@@ -0,0 +1,141 @@
+import { type MisfirePolicy } from "./internal/cron";
+type JobSubmitter = {
+    id: string;
+    submit(cfg: {
+        input: unknown;
+        key?: string;
+        keyTtlMs?: number;
+        at?: number;
+        delayMs?: number;
+        meta?: Record<string, unknown>;
+    }): Promise<string>;
+    validateInput?(input: unknown): void;
+};
+export type SchedulerMetric = {
+    type: "leader_acquired";
+    ts: number;
+} | {
+    type: "leader_lost";
+    ts: number;
+    reason: "extend_failed" | "stop";
+} | {
+    type: "tick_error";
+    ts: number;
+    message: string;
+} | {
+    type: "schedule_registered";
+    ts: number;
+    scheduleId: string;
+    created: boolean;
+} | {
+    type: "schedule_updated";
+    ts: number;
+    scheduleId: string;
+} | {
+    type: "schedule_unregistered";
+    ts: number;
+    scheduleId: string;
+} | {
+    type: "dispatch_submitted";
+    ts: number;
+    scheduleId: string;
+    slotTs: number;
+    jobId: string;
+} | {
+    type: "dispatch_skipped";
+    ts: number;
+    scheduleId: string;
+    reason: "missing_handler" | "cas_stale";
+} | {
+    type: "dispatch_failed";
+    ts: number;
+    scheduleId: string;
+    message: string;
+} | {
+    type: "dispatch_dlq";
+    ts: number;
+    scheduleId: string;
+    slotTs: number;
+    message: string;
+} | {
+    type: "dispatch_advanced_after_failures";
+    ts: number;
+    scheduleId: string;
+    slotTs: number;
+    failures: number;
+};
+export type SchedulerConfig = {
+    id: string;
+    prefix?: string;
+    leader?: {
+        leaseMs?: number;
+        heartbeatMs?: number;
+    };
+    dispatch?: {
+        tickMs?: number;
+        batchSize?: number;
+        maxSubmitsPerTick?: number;
+        submitRetries?: number;
+        submitBackoffBaseMs?: number;
+        submitBackoffMaxMs?: number;
+        scheduledJobKeyTtlMs?: number;
+        dlqMaxEntries?: number;
+        maxConsecutiveDispatchFailures?: number;
+    };
+    strictHandlers?: boolean;
+    onMetric?: (metric: SchedulerMetric) => void;
+};
+export type SchedulerRegisterConfig = {
+    id: string;
+    cron: string;
+    tz?: string;
+    job: JobSubmitter;
+    input: unknown;
+    misfire?: MisfirePolicy;
+    maxCatchUpRuns?: number;
+    meta?: Record<string, unknown>;
+};
+export type SchedulerUnregisterConfig = {
+    id: string;
+};
+export type SchedulerGetConfig = {
+    id: string;
+};
+export type SchedulerInfo = {
+    id: string;
+    cron: string;
+    tz: string;
+    misfire: MisfirePolicy;
+    maxCatchUpRuns: number;
+    jobId: string;
+    nextRunAt: number;
+    createdAt: number;
+    updatedAt: number;
+};
+export type SchedulerMetricsSnapshot = {
+    isLeader: boolean;
+    leaderEpoch: number;
+    leaderChanges: number;
+    dispatchSubmitted: number;
+    dispatchFailed: number;
+    dispatchRetried: number;
+    dispatchSkipped: number;
+    dispatchDlq: number;
+    tickErrors: number;
+    lastTickAt: number | null;
+};
+export type Scheduler = {
+    id: string;
+    start(): void;
+    stop(): Promise<void>;
+    register(cfg: SchedulerRegisterConfig): Promise<{
+        created: boolean;
+        updated: boolean;
+    }>;
+    unregister(cfg: SchedulerUnregisterConfig): Promise<void>;
+    get(cfg: SchedulerGetConfig): Promise<SchedulerInfo | null>;
+    list(): Promise<SchedulerInfo[]>;
+    metrics(): SchedulerMetricsSnapshot;
+};
+export declare const scheduler: (config: SchedulerConfig) => Scheduler;
+export {};