@vireocodedev/sqlite 0.2.0 → 0.2.1

package/dist/offline/status/offlineStatusTypes.d.ts

@@ -0,0 +1,23 @@
+export type OfflineStatusSnapshot = {
+    online: boolean;
+    heartbeatEnabled: boolean;
+    heartbeatConnected: boolean;
+    syncInProgress: boolean;
+    lastHeartbeatAt: number | null;
+};
+export type OfflineStatusRuntimeOptions = {
+    staleAfterMs?: number;
+    bootstrapAssumeOnlineMs?: number;
+    tickMs?: number;
+    now?: () => number;
+};
+export type OfflineStatusRuntime = {
+    start: () => () => void;
+    getSnapshot: () => OfflineStatusSnapshot;
+    setHeartbeatEnabled: (enabled: boolean) => void;
+    markHeartbeatConnected: () => void;
+    markHeartbeatDisconnected: () => void;
+    markHeartbeatReceived: (syncInProgress: boolean) => void;
+    markBackendUnavailable: () => void;
+    markBackendAvailable: () => void;
+};

package/dist/offline-queue/createOfflineQueueCapture.d.ts

@@ -0,0 +1,16 @@
+import { OfflineSyncCommand } from '../offline/queue/queueingTypes';
+export type OfflineQueueCaptureRequest = {
+    method?: string;
+    body?: unknown;
+    headers?: Record<string, unknown>;
+};
+export type CreateOfflineQueueCaptureConfig<TRequest extends OfflineQueueCaptureRequest> = {
+    resolveUrl: (request: TRequest) => string;
+    createCommandId: () => string;
+    now: () => number;
+    enqueue: (command: OfflineSyncCommand) => Promise<void>;
+    markEnqueued: () => void;
+    refreshStatus: () => Promise<void>;
+};
+/** Captures a transport request as a replayable command; transport-specific URL resolution stays injected. */
+export declare function createOfflineQueueCapture<TRequest extends OfflineQueueCaptureRequest>(config: CreateOfflineQueueCaptureConfig<TRequest>): (request: TRequest) => Promise<OfflineSyncCommand>;

package/dist/offline-queue/createOfflineQueueClient.d.ts

@@ -0,0 +1,23 @@
+import { OfflineQueuedCommand, OfflineQueueStatusCounts } from './offlineQueueStateSqlite';
+import { InMemorySqliteStore } from '../runtime/createManagedSqliteRuntime';
+import { SqliteTransport } from '../runtime/createSqliteTransport';
+import { OfflineSyncCommand } from '../offline/queue/queueingTypes';
+export type OfflineQueueClientRuntime = {
+    shouldUseInMemoryFallback: () => boolean;
+    registerInMemoryStore: (store: InMemorySqliteStore) => () => void;
+};
+export type OfflineQueueClient = {
+    enqueue: (command: OfflineSyncCommand) => Promise<void>;
+    getBatch: (batchSize: number) => Promise<OfflineQueuedCommand[]>;
+    delete: (commandIds: string[]) => Promise<void>;
+    markRetryable: (commandIds: string[], lastError: string | null, maxRetryCount: number) => Promise<void>;
+    markPermanentlyFailed: (commandIds: string[], lastError: string | null) => Promise<void>;
+    getSize: () => Promise<number>;
+    getStatusCounts: () => Promise<OfflineQueueStatusCounts>;
+    dispose: () => void;
+};
+export type CreateOfflineQueueClientConfig = {
+    runtime: OfflineQueueClientRuntime;
+    transport: Pick<SqliteTransport, "sendWorkerRequest">;
+};
+export declare function createOfflineQueueClient(config: CreateOfflineQueueClientConfig): OfflineQueueClient;

package/dist/offline-queue/createOfflineQueueStatus.d.ts

@@ -0,0 +1,18 @@
+import { OfflineQueueStatusCounts } from './offlineQueueStateSqlite';
+export type OfflineQueueStatusSnapshot = OfflineQueueStatusCounts & {
+    enqueueTick: number;
+};
+export type OfflineQueueStatusListener = (snapshot: OfflineQueueStatusSnapshot) => void;
+export type OfflineQueueStatus = {
+    getSnapshot: () => OfflineQueueStatusSnapshot;
+    subscribe: (listener: OfflineQueueStatusListener) => () => void;
+    markEnqueued: () => void;
+    refresh: () => Promise<void>;
+    resetCounts: () => void;
+};
+export type CreateOfflineQueueStatusConfig = {
+    readStatusCounts: () => Promise<OfflineQueueStatusCounts>;
+    onReadError?: (error: unknown) => void;
+};
+/** Framework-neutral observable queue status with non-blocking persistence refreshes. */
+export declare function createOfflineQueueStatus(config: CreateOfflineQueueStatusConfig): OfflineQueueStatus;

package/dist/offline-queue/offlineQueueStateSqlite.d.ts

@@ -0,0 +1,30 @@
+import { SqliteDatabase } from '../core/sqliteTypes';
+import { OfflineSyncCommandRecord } from '../runtime/contracts';
+export declare const OFFLINE_QUEUE_PENDING = "PENDING";
+export declare const OFFLINE_QUEUE_PERMANENTLY_FAILED = "PERMANENTLY_FAILED";
+export type OfflineQueuedCommandStatus = typeof OFFLINE_QUEUE_PENDING | typeof OFFLINE_QUEUE_PERMANENTLY_FAILED;
+export type OfflineQueuedCommand = OfflineSyncCommandRecord & {
+    status: OfflineQueuedCommandStatus;
+    retryCount: number;
+    lastError: string | null;
+};
+export type OfflineQueueStatusCounts = {
+    pending: number;
+    permanentlyFailed: number;
+};
+export declare function enqueueOfflineCommand(db: SqliteDatabase, command: OfflineSyncCommandRecord): void;
+export declare function getPendingOfflineCommands(db: SqliteDatabase, batchSize: number): OfflineQueuedCommand[];
+export declare function deleteOfflineCommands(db: SqliteDatabase, commandIds: string[]): void;
+export declare function getOfflineQueueSize(db: SqliteDatabase): number;
+export declare function getOfflineQueueStatusCounts(db: SqliteDatabase): OfflineQueueStatusCounts;
+export declare function markOfflineCommandsRetryable(db: SqliteDatabase, commandIds: string[], lastError: string | null, maxRetryCount: number): void;
+export declare function markOfflineCommandsPermanentlyFailed(db: SqliteDatabase, commandIds: string[], lastError: string | null): void;
+export declare const OFFLINE_QUEUE_STATE_SQLITE_REQUEST_HANDLERS: {
+    enqueue: (db: SqliteDatabase, request: import('..').WorkerRequest) => null;
+    getPendingBatch: (db: SqliteDatabase, request: import('..').WorkerRequest) => OfflineQueuedCommand[];
+    deleteCommands: (db: SqliteDatabase, request: import('..').WorkerRequest) => null;
+    getQueueSize: (db: SqliteDatabase) => number;
+    getStatusCounts: (db: SqliteDatabase) => OfflineQueueStatusCounts;
+    markCommandsRetryable: (db: SqliteDatabase, request: import('..').WorkerRequest) => null;
+    markCommandsPermanentlyFailed: (db: SqliteDatabase, request: import('..').WorkerRequest) => null;
+};

package/dist/offline-queue/replayOfflineSyncBatch.d.ts

@@ -0,0 +1,29 @@
+import { OfflineSyncCommand } from '../offline/queue/queueingTypes';
+export type OfflineSyncResultReason = "APPLIED" | "ALREADY_APPLIED" | "RETRYABLE" | "REJECTED" | "RETRY_LIMIT_EXCEEDED";
+export type OfflineSyncCommandResult = {
+    commandId: string;
+    success: boolean;
+    status: number;
+    error: string | null;
+    reason?: OfflineSyncResultReason | null;
+};
+export type OfflineSyncBatchResponse = {
+    accepted: number;
+    failed: number;
+    results: OfflineSyncCommandResult[];
+};
+export type OfflineSyncCommandDto = Pick<OfflineSyncCommand, "commandId" | "method" | "url" | "body" | "headers">;
+export type OfflineSyncReplayDependencies = {
+    getBatch: (batchSize: number) => Promise<OfflineSyncCommand[]>;
+    sendBatch: (commands: OfflineSyncCommandDto[]) => Promise<OfflineSyncBatchResponse>;
+    cleanupSuccessfulCommands: (commands: OfflineSyncCommand[]) => Promise<void>;
+    deleteSuccessful: (commandIds: string[]) => Promise<void>;
+    markPermanentlyFailed: (commandIds: string[], lastError: string | null) => Promise<void>;
+    markRetryable: (commandIds: string[], lastError: string | null, maxAttempts: number) => Promise<void>;
+    refreshStatus: () => Promise<void>;
+};
+export declare function replayOfflineSyncBatch(args: {
+    batchSize: number;
+    maxAttempts: number;
+    dependencies: OfflineSyncReplayDependencies;
+}): Promise<number>;

package/dist/queueingHeaders-B7TBifLV.js

@@ -0,0 +1,20 @@
+//#region src/offline/queue/queueingHeaders.ts
+var e = "X-Offline-Temp-Id", t = "X-Offline-Temp-Product-Id";
+function n(e) {
+	let t = {};
+	if (!e) return t;
+	for (let [n, r] of Object.entries(e)) r != null && (t[n.toLowerCase()] = String(r));
+	return t;
+}
+function r(t) {
+	let r = n(t), i = {}, a = r["idempotency-key"];
+	a && (i["Idempotency-Key"] = a);
+	let o = r["content-type"];
+	o && (i["Content-Type"] = o);
+	let s = r["x-offline-temp-id"] ?? r["x-offline-temp-product-id"];
+	return s && (i[e] = s), i;
+}
+//#endregion
+export { n as i, t as n, r, e as t };
+
+//# sourceMappingURL=queueingHeaders-B7TBifLV.js.map

package/dist/queueingHeaders-B7TBifLV.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"queueingHeaders-B7TBifLV.js","names":[],"sources":["../src/offline/queue/queueingHeaders.ts"],"sourcesContent":["export const OFFLINE_TEMP_ID_HEADER = \"X-Offline-Temp-Id\";\nexport const OFFLINE_TEMP_PRODUCT_ID_LEGACY_HEADER = \"X-Offline-Temp-Product-Id\";\n\nexport function normalizeHeaders(input: Record<string, unknown> | undefined): Record<string, string> {\n  const normalized: Record<string, string> = {};\n\n  if (!input) {\n    return normalized;\n  }\n\n  for (const [key, value] of Object.entries(input)) {\n    if (value == null) {\n      continue;\n    }\n\n    normalized[key.toLowerCase()] = String(value);\n  }\n\n  return normalized;\n}\n\nexport function extractReplayHeaders(headers: Record<string, unknown> | undefined): Record<string, string> {\n  const record = normalizeHeaders(headers);\n  const replay: Record<string, string> = {};\n\n  const idempotencyKey = record[\"idempotency-key\"];\n  if (idempotencyKey) {\n    replay[\"Idempotency-Key\"] = idempotencyKey;\n  }\n\n  const contentType = record[\"content-type\"];\n  if (contentType) {\n    replay[\"Content-Type\"] = contentType;\n  }\n\n  const offlineTempId =\n    record[OFFLINE_TEMP_ID_HEADER.toLowerCase()] ?? record[OFFLINE_TEMP_PRODUCT_ID_LEGACY_HEADER.toLowerCase()];\n  if (offlineTempId) {\n    replay[OFFLINE_TEMP_ID_HEADER] = offlineTempId;\n  }\n\n  return replay;\n}\n"],"mappings":";AAAA,IAAa,IAAyB,qBACzB,IAAwC;AAErD,SAAgB,EAAiB,GAAoE;CACnG,IAAM,IAAqC,CAAC;CAE5C,IAAI,CAAC,GACH,OAAO;CAGT,KAAK,IAAM,CAAC,GAAK,MAAU,OAAO,QAAQ,CAAK,GACzC,KAAS,SAIb,EAAW,EAAI,YAAY,KAAK,OAAO,CAAK;CAG9C,OAAO;AACT;AAEA,SAAgB,EAAqB,GAAsE;CACzG,IAAM,IAAS,EAAiB,CAAO,GACjC,IAAiC,CAAC,GAElC,IAAiB,EAAO;CAC9B,AAAI,MACF,EAAO,qBAAqB;CAG9B,IAAM,IAAc,EAAO;CAC3B,AAAI,MACF,EAAO,kBAAkB;CAG3B,IAAM,IACJ,EAAA,wBAAgD,EAAA;CAKlD,OAJI,MACF,EAAO,KAA0B,IAG5B;AACT"}

package/dist/runtime/contracts.d.ts

@@ -0,0 +1,54 @@
+import { SqliteRequestHandlers } from '../core/sqliteRequestHandlers';
+import { SqliteMigration } from '../core/sqliteTypes';
+export type OfflineSyncCommandRecord = {
+    commandId: string;
+    method: string;
+    url: string;
+    body: unknown | null;
+    headers: Record<string, string>;
+    createdAt: number;
+};
+export type SqliteHydrationEntityStateRecord = {
+    entityKey: string;
+    appliedRevision: number;
+    isStale: boolean;
+    lastHydratedAt: number | null;
+    lastRowCount: number | null;
+    lastError: string | null;
+};
+export type SqlExecutionStatementResult = {
+    statement: string;
+    columns: string[];
+    rows: unknown[][];
+    rowsAffected: number;
+};
+export type SqlExecutionResult = {
+    statements: SqlExecutionStatementResult[];
+};
+export type SqlPagedQueryRequest = {
+    selectSql: string;
+    fromSql: string;
+    whereSql: string;
+    orderBySql: string;
+    limit: number | null;
+    offset: number | null;
+    includeTotalCount?: boolean;
+    clientSentAtMs?: number;
+};
+export type SqlPagedQueryResult = {
+    columns: string[];
+    rows: unknown[][];
+    totalElements: number | null;
+    queueWaitMs?: number;
+    workerExecMs?: number;
+};
+export type SqliteWorkerEntityBundleConfig = {
+    requestHandlers: SqliteRequestHandlers;
+};
+export type CreateSqliteWorkerRuntimeConfigInput = {
+    dbFile: string;
+    migrations: SqliteMigration[];
+    entityBundles: SqliteWorkerEntityBundleConfig[];
+    debug?: boolean;
+    extraRequestHandlers?: SqliteRequestHandlers[];
+};

package/dist/runtime/createManagedSqliteRuntime.d.ts

@@ -0,0 +1,23 @@
+import { WorkerRequestInput, WorkerResponseResult } from '../core/sqliteWorkerProtocol';
+export type InMemorySqliteStore = {
+    clear: () => void;
+};
+export type ManagedSqliteRuntimeConfig = {
+    workerFactory: () => Worker;
+    shouldUseInMemoryFallback?: () => boolean;
+    debug?: boolean;
+    bootLogPrefix?: string;
+    now?: () => number;
+};
+export type ManagedSqliteRuntime = {
+    registerInMemoryStore: (store: InMemorySqliteStore) => () => void;
+    clearInMemoryStores: () => void;
+    shouldUseInMemoryFallback: () => boolean;
+    send: <T extends WorkerResponseResult>(payload: WorkerRequestInput) => Promise<T>;
+    ensureInitialized: () => Promise<void>;
+    warmup: () => Promise<void>;
+    reset: () => void;
+    dispose: () => void;
+};
+/** Owns worker lifecycle, initialization, pending requests, fallback stores and deterministic teardown. */
+export declare function createManagedSqliteRuntime(config: ManagedSqliteRuntimeConfig): ManagedSqliteRuntime;

package/dist/runtime/createSqliteEntityClient.d.ts

@@ -0,0 +1,32 @@
+import { InMemorySqliteStore } from './createManagedSqliteRuntime';
+import { SqliteTransport } from './createSqliteTransport';
+type SqliteEntityClientRequest = {
+    type: string;
+    payloadKey: string;
+};
+export type SqliteEntityClient<TRecord, TKey> = {
+    replace: (records: TRecord[]) => Promise<void>;
+    upsert: (record: TRecord) => Promise<void>;
+    list: () => Promise<TRecord[]>;
+    delete: (keys: TKey[]) => Promise<void>;
+};
+export type SqliteEntityClientRuntime = {
+    shouldUseInMemoryFallback: () => boolean;
+    registerInMemoryStore: (store: InMemorySqliteStore) => () => void;
+};
+export type SqliteEntityClientConfig<TRecord, TKey> = {
+    runtime: SqliteEntityClientRuntime;
+    transport: Pick<SqliteTransport, "sendWorkerRequest">;
+    getKey: (record: TRecord) => TKey;
+    compare: (left: TRecord, right: TRecord) => number;
+    requests: {
+        replace: SqliteEntityClientRequest;
+        upsert: SqliteEntityClientRequest;
+        list: {
+            type: string;
+        };
+        delete: SqliteEntityClientRequest;
+    };
+};
+export declare function createSqliteEntityClient<TRecord, TKey>(config: SqliteEntityClientConfig<TRecord, TKey>): SqliteEntityClient<TRecord, TKey>;
+export {};

package/dist/runtime/createSqliteTransport.d.ts

@@ -0,0 +1,17 @@
+import { WorkerRequestInput, WorkerResponseResult } from '../core/sqliteWorkerProtocol';
+export type SqliteTransportRuntime = {
+    shouldUseInMemoryFallback: () => boolean;
+    ensureInitialized: () => Promise<void>;
+    send: <T extends WorkerResponseResult>(payload: WorkerRequestInput) => Promise<T>;
+};
+export type SqliteTransport = {
+    sendRequest: <TResponse = unknown>(type: string, payload?: Record<string, unknown>) => Promise<TResponse>;
+    sendWorkerRequest: <T extends WorkerResponseResult>(payload: {
+        type: string;
+    } & Record<string, unknown>) => Promise<T>;
+};
+export type CreateSqliteTransportConfig = {
+    runtime: SqliteTransportRuntime;
+    createUnavailableError?: (requestType: string) => Error;
+};
+export declare function createSqliteTransport({ runtime, createUnavailableError, }: CreateSqliteTransportConfig): SqliteTransport;

package/dist/runtime/hydrationEntityStateSqlite.d.ts

@@ -0,0 +1,20 @@
+import { SqliteDatabase } from '../core/sqliteTypes';
+import { SqliteHydrationEntityStateRecord } from './contracts';
+export type HydrationEntityStateSqliteOperationMap = {
+    listHydrationEntityStates: {
+        request: Record<string, never>;
+        response: SqliteHydrationEntityStateRecord[];
+    };
+    upsertHydrationEntityState: {
+        request: {
+            state: SqliteHydrationEntityStateRecord;
+        };
+        response: null;
+    };
+};
+export declare function listHydrationEntityStates(db: SqliteDatabase): SqliteHydrationEntityStateRecord[];
+export declare function upsertHydrationEntityState(db: SqliteDatabase, state: SqliteHydrationEntityStateRecord): void;
+export declare const HYDRATION_ENTITY_STATE_SQLITE_REQUEST_HANDLERS: {
+    listHydrationEntityStates: (db: SqliteDatabase) => SqliteHydrationEntityStateRecord[];
+    upsertHydrationEntityState: (db: SqliteDatabase, request: import('..').WorkerRequest) => null;
+};

package/dist/runtime/sqlConsoleSqlite.d.ts

@@ -0,0 +1,20 @@
+import { SqliteDatabase } from '../core/sqliteTypes';
+import { SqlExecutionResult, SqlPagedQueryRequest, SqlPagedQueryResult } from './contracts';
+export type SqlConsoleSqliteOperationMap = {
+    executeSqlScript: {
+        request: {
+            script: string;
+        };
+        response: SqlExecutionResult;
+    };
+    executePagedQuery: {
+        request: SqlPagedQueryRequest;
+        response: SqlPagedQueryResult;
+    };
+};
+export declare function executeSqlScript(db: SqliteDatabase, script: string): SqlExecutionResult;
+export declare function executePagedQuery(db: SqliteDatabase, request: SqlPagedQueryRequest): SqlPagedQueryResult;
+export declare const SQL_CONSOLE_SQLITE_REQUEST_HANDLERS: {
+    executeSqlScript: (db: SqliteDatabase, request: import('..').WorkerRequest) => SqlExecutionResult;
+    executePagedQuery: (db: SqliteDatabase, request: import('..').WorkerRequest) => SqlPagedQueryResult;
+};

package/dist/sqliteWorkerConfig.d.ts

@@ -0,0 +1,3 @@
+import { SqliteWorkerRuntimeConfig } from './core/sqliteWorkerRuntime';
+import { CreateSqliteWorkerRuntimeConfigInput } from './runtime/contracts';
+export declare function createSqliteWorkerRuntimeConfig(input: CreateSqliteWorkerRuntimeConfigInput): SqliteWorkerRuntimeConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vireocodedev/sqlite",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Reusable SQLite worker/client runtime primitives for the vireocodedev starter product.",
   "type": "module",
   "sideEffects": false,