@anfenn/dync 1.0.32 → 1.1.0

package/dist/react/index.d.cts

@@ -1,4 +1,4 @@
-import { a as SyncApi, k as SyncState } from '../types-BszcepJK.cjs';
+import { a as SyncApi, k as SyncState } from '../types-DhCTdAep.cjs';
 import '../dexie-3VOQSn1s.cjs';
 import 'dexie';
 import '../types-6-NyRQ0D.cjs';

package/dist/react/index.d.ts

@@ -1,4 +1,4 @@
-import { a as SyncApi, k as SyncState } from '../types-Dhx9MuUp.js';
+import { a as SyncApi, k as SyncState } from '../types-BIJhsSOf.js';
 import '../dexie-D85rTx4g.js';
 import 'dexie';
 import '../types-6-NyRQ0D.js';

package/dist/{types-Dhx9MuUp.d.ts → types-BIJhsSOf.d.ts}

@@ -19,11 +19,12 @@ interface SyncedRecord {
     updated_at: string;
     [k: string]: any;
 }
-interface ApiFunctions {
+interface CrudSyncApi {
     add: (item: any) => Promise<any | undefined>;
     update: (id: any, changes: any, item: any) => Promise<boolean>;
     remove: (id: any) => Promise<void>;
     list: (lastUpdatedAt: Date) => Promise<any[]>;
+    listExtraIntervalMs?: number;
     firstLoad?: (lastId: any) => Promise<any[]>;
 }
 /**
@@ -86,7 +87,7 @@ type ConflictResolutionStrategy = 'local-wins' | 'remote-wins' | 'try-shallow-me
 type AfterRemoteAddCallback = (tableName: string, item: SyncedRecord) => void;
 type MissingRemoteRecordDuringUpdateCallback = (strategy: MissingRemoteRecordStrategy, item: SyncedRecord) => void;
 interface SyncOptions {
-    syncInterval?: number;
+    syncIntervalMs?: number;
     logger?: Logger;
     minLogLevel?: LogLevel;
     onAfterRemoteAdd?: AfterRemoteAddCallback;
@@ -97,7 +98,7 @@ interface SyncOptions {
 interface DyncOptions<TStoreMap extends Record<string, any> = Record<string, any>> {
     databaseName: string;
     storageAdapter: StorageAdapter;
-    sync?: Partial<Record<keyof TStoreMap, ApiFunctions>> | BatchSync;
+    sync?: Partial<Record<keyof TStoreMap, CrudSyncApi>> | BatchSync;
     options?: SyncOptions;
 }
 interface FirstLoadProgress {
@@ -123,7 +124,8 @@ interface MutationEvent {
 interface PersistedSyncState {
     firstLoadDone: boolean;
     pendingChanges: PendingChange[];
-    lastPulled: Record<string, string>;
+    newestServerUpdatedAt: Record<string, string>;
+    lastPulledAt?: Record<string, number>;
     conflicts?: Record<string, Conflict>;
 }
 type SyncStatus = 'disabled' | 'disabling' | 'idle' | 'syncing' | 'error';
@@ -160,4 +162,4 @@ type TableMap<TStoreMap extends Record<string, any>> = {
     [K in keyof TStoreMap]: StorageTable<TStoreMap[K]>;
 };
 
-export { type AfterRemoteAddCallback as A, type BatchSync as B, type ConflictResolutionStrategy as C, type DyncOptions as D, type FirstLoadProgress as F, type MissingRemoteRecordStrategy as M, type SyncStatus as S, type TableMap as T, type SyncApi as a, SyncAction as b, type ApiFunctions as c, type BatchPushPayload as d, type BatchPushResult as e, type BatchFirstLoadResult as f, type FirstLoadProgressCallback as g, type MissingRemoteRecordDuringUpdateCallback as h, type MutationEvent as i, type SyncOptions as j, type SyncState as k, type SyncedRecord as l };
+export { type AfterRemoteAddCallback as A, type BatchSync as B, type CrudSyncApi as C, type DyncOptions as D, type FirstLoadProgress as F, type MissingRemoteRecordStrategy as M, type SyncStatus as S, type TableMap as T, type SyncApi as a, SyncAction as b, type BatchPushPayload as c, type BatchPushResult as d, type BatchFirstLoadResult as e, type ConflictResolutionStrategy as f, type FirstLoadProgressCallback as g, type MissingRemoteRecordDuringUpdateCallback as h, type MutationEvent as i, type SyncOptions as j, type SyncState as k, type SyncedRecord as l };

package/dist/{types-BszcepJK.d.cts → types-DhCTdAep.d.cts}

@@ -19,11 +19,12 @@ interface SyncedRecord {
     updated_at: string;
     [k: string]: any;
 }
-interface ApiFunctions {
+interface CrudSyncApi {
     add: (item: any) => Promise<any | undefined>;
     update: (id: any, changes: any, item: any) => Promise<boolean>;
     remove: (id: any) => Promise<void>;
     list: (lastUpdatedAt: Date) => Promise<any[]>;
+    listExtraIntervalMs?: number;
     firstLoad?: (lastId: any) => Promise<any[]>;
 }
 /**
@@ -86,7 +87,7 @@ type ConflictResolutionStrategy = 'local-wins' | 'remote-wins' | 'try-shallow-me
 type AfterRemoteAddCallback = (tableName: string, item: SyncedRecord) => void;
 type MissingRemoteRecordDuringUpdateCallback = (strategy: MissingRemoteRecordStrategy, item: SyncedRecord) => void;
 interface SyncOptions {
-    syncInterval?: number;
+    syncIntervalMs?: number;
     logger?: Logger;
     minLogLevel?: LogLevel;
     onAfterRemoteAdd?: AfterRemoteAddCallback;
@@ -97,7 +98,7 @@ interface SyncOptions {
 interface DyncOptions<TStoreMap extends Record<string, any> = Record<string, any>> {
     databaseName: string;
     storageAdapter: StorageAdapter;
-    sync?: Partial<Record<keyof TStoreMap, ApiFunctions>> | BatchSync;
+    sync?: Partial<Record<keyof TStoreMap, CrudSyncApi>> | BatchSync;
     options?: SyncOptions;
 }
 interface FirstLoadProgress {
@@ -123,7 +124,8 @@ interface MutationEvent {
 interface PersistedSyncState {
     firstLoadDone: boolean;
     pendingChanges: PendingChange[];
-    lastPulled: Record<string, string>;
+    newestServerUpdatedAt: Record<string, string>;
+    lastPulledAt?: Record<string, number>;
     conflicts?: Record<string, Conflict>;
 }
 type SyncStatus = 'disabled' | 'disabling' | 'idle' | 'syncing' | 'error';
@@ -160,4 +162,4 @@ type TableMap<TStoreMap extends Record<string, any>> = {
     [K in keyof TStoreMap]: StorageTable<TStoreMap[K]>;
 };
 
-export { type AfterRemoteAddCallback as A, type BatchSync as B, type ConflictResolutionStrategy as C, type DyncOptions as D, type FirstLoadProgress as F, type MissingRemoteRecordStrategy as M, type SyncStatus as S, type TableMap as T, type SyncApi as a, SyncAction as b, type ApiFunctions as c, type BatchPushPayload as d, type BatchPushResult as e, type BatchFirstLoadResult as f, type FirstLoadProgressCallback as g, type MissingRemoteRecordDuringUpdateCallback as h, type MutationEvent as i, type SyncOptions as j, type SyncState as k, type SyncedRecord as l };
+export { type AfterRemoteAddCallback as A, type BatchSync as B, type CrudSyncApi as C, type DyncOptions as D, type FirstLoadProgress as F, type MissingRemoteRecordStrategy as M, type SyncStatus as S, type TableMap as T, type SyncApi as a, SyncAction as b, type BatchPushPayload as c, type BatchPushResult as d, type BatchFirstLoadResult as e, type ConflictResolutionStrategy as f, type FirstLoadProgressCallback as g, type MissingRemoteRecordDuringUpdateCallback as h, type MutationEvent as i, type SyncOptions as j, type SyncState as k, type SyncedRecord as l };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anfenn/dync",
-  "version": "1.0.32",
+  "version": "1.1.0",
   "private": false,
   "description": "Write once, run IndexedDB & SQLite with sync anywhere - React, React Native, Expo, Capacitor, Electron & Node.js",
   "keywords": [
@@ -144,7 +144,7 @@
     "test:browser:full": "pnpm --filter tests test:browser:full",
     "reinstall": "find . -name node_modules -type d -prune -exec rm -rf {} + && pnpm install",
     "push": "bash -c '[ -n \"$1\" ] && git add . && git commit -m \"$1\" && git push' --",
-    "release": "bash -c '[ -n \"$1\" ] || { echo \"Usage: pnpm release <commit-message>\"; exit 1; } && pnpm build:all && pnpm test:all && pnpm test:browser:full && git add . && git commit -m \"$1\" && npm version patch && git push && npm login && npm publish' --"
+    "release": "bash -c '[ -n \"$1\" ] || { echo \"Usage: pnpm release <commit-message> [--no-patch]\"; exit 1; } && pnpm build:all && pnpm test:all && pnpm test:browser:full && git add . && git commit -m \"$1\" && { [ \"$2\" = \"--no-patch\" ] || npm version patch; } && git push && npm login && npm publish' --"
   },
   "devDependencies": {
     "@capacitor-community/sqlite": "7.0.2",

package/src/core/StateManager.ts

@@ -16,7 +16,7 @@ interface StateRow {
 const DEFAULT_STATE: PersistedSyncState = {
     firstLoadDone: false,
     pendingChanges: [],
-    lastPulled: {},
+    newestServerUpdatedAt: {},
 };
 
 interface StateContext {
@@ -247,7 +247,8 @@ function clonePersistedState(state: PersistedSyncState): PersistedSyncState {
             before: cloneRecord(change.before),
             after: cloneRecord(change.after),
         })),
-        lastPulled: { ...state.lastPulled },
+        newestServerUpdatedAt: { ...state.newestServerUpdatedAt },
+        lastPulledAt: state.lastPulledAt ? { ...state.lastPulledAt } : undefined,
         conflicts: cloneConflicts(state.conflicts),
     };
 }

package/src/core/firstLoad.ts

@@ -1,6 +1,6 @@
 import { createLocalId, sleep } from '../helpers';
 import type { Logger } from '../logger';
-import type { ApiFunctions, BatchFirstLoadResult, BatchSync, FirstLoadProgressCallback } from '../types';
+import type { CrudSyncApi, BatchFirstLoadResult, BatchSync, FirstLoadProgressCallback } from '../types';
 import type { StorageTable } from '../storage/types';
 import { DYNC_STATE_TABLE, type StateHelpers } from './StateManager';
 import type { WithTransaction } from './types';
@@ -14,7 +14,7 @@ export interface FirstLoadBaseContext {
 }
 
 export interface FirstLoadContext extends FirstLoadBaseContext {
-    syncApis: Record<string, ApiFunctions>;
+    syncApis: Record<string, CrudSyncApi>;
 }
 
 export interface FirstLoadBatchContext extends FirstLoadBaseContext {
@@ -125,7 +125,7 @@ async function processBatchInChunks(
     isEmptyTable: boolean,
     isFirstBatch: boolean,
 ): Promise<BatchResult> {
-    let newest = new Date(ctx.state.getState().lastPulled[tableName] || 0);
+    let newest = new Date(ctx.state.getState().newestServerUpdatedAt[tableName] || 0);
 
     return ctx.withTransaction('rw', [tableName, DYNC_STATE_TABLE], async (tables) => {
         const txTable = tables[tableName]!;
@@ -174,8 +174,8 @@ async function processBatchInChunks(
 
         await ctx.state.setState((syncState) => ({
             ...syncState,
-            lastPulled: {
-                ...syncState.lastPulled,
+            newestServerUpdatedAt: {
+                ...syncState.newestServerUpdatedAt,
                 [tableName]: newest.toISOString(),
             },
         }));

package/src/core/pullOperations.ts

@@ -1,6 +1,6 @@
 import { createLocalId } from '../helpers';
 import type { Logger } from '../logger';
-import type { ApiFunctions, BatchSync, ConflictResolutionStrategy, FieldConflict, SyncedRecord } from '../types';
+import type { CrudSyncApi, BatchSync, ConflictResolutionStrategy, FieldConflict, SyncedRecord } from '../types';
 import { SyncAction } from '../types';
 import type { StorageTable } from '../storage/types';
 import { DYNC_STATE_TABLE, type StateHelpers } from './StateManager';
@@ -15,7 +15,8 @@ export interface PullContext {
 }
 
 export interface PullAllContext extends PullContext {
-    syncApis: Record<string, ApiFunctions>;
+    syncApis: Record<string, CrudSyncApi>;
+    syncIntervalMs: number;
 }
 
 export interface PullAllBatchContext extends PullContext {
@@ -27,14 +28,33 @@ export async function pullAll(ctx: PullAllContext): Promise<{ error?: Error; cha
     const changedTables: string[] = [];
     for (const [tableName, api] of Object.entries(ctx.syncApis)) {
         try {
-            const lastPulled = ctx.state.getState().lastPulled[tableName];
-            const since = lastPulled ? new Date(lastPulled) : new Date(0);
+            const now = Date.now();
+
+            // Skip pull if within listExtraIntervalMs
+            if (beforeListExtraInterval(api, tableName, ctx, now)) {
+                continue;
+            }
+
+            const newestServerUpdatedAt = ctx.state.getState().newestServerUpdatedAt[tableName];
+            const since = newestServerUpdatedAt ? new Date(newestServerUpdatedAt) : new Date(0);
 
             ctx.logger.debug(`[dync] pull:start tableName=${tableName} since=${since.toISOString()}`);
 
             const serverData = (await api.list(since)) as SyncedRecord[];
             const changed = await processPullData(tableName, serverData, since, ctx);
             if (changed) changedTables.push(tableName);
+
+            // Track when api.list() was called for this table (for listExtraIntervalMs feature)
+            // but only if listExtraIntervalMs is set, to reduce storage calls
+            if (hasListExtraInterval(api)) {
+                await ctx.state.setState((syncState) => ({
+                    ...syncState,
+                    lastPulledAt: {
+                        ...syncState.lastPulledAt,
+                        [tableName]: now,
+                    },
+                }));
+            }
         } catch (err) {
             firstSyncError = firstSyncError ?? (err as Error);
             ctx.logger.error(`[dync] pull:error tableName=${tableName}`, err);
@@ -43,6 +63,24 @@ export async function pullAll(ctx: PullAllContext): Promise<{ error?: Error; cha
     return { error: firstSyncError, changedTables };
 }
 
+function hasListExtraInterval(api: CrudSyncApi): boolean {
+    return Number.isFinite(api.listExtraIntervalMs) && api.listExtraIntervalMs! > 0;
+}
+
+function beforeListExtraInterval(api: CrudSyncApi, tableName: string, ctx: PullAllContext, now: number): boolean {
+    if (!hasListExtraInterval(api)) {
+        return false;
+    }
+    const lastPulledAt = ctx.state.getState().lastPulledAt?.[tableName] ?? 0;
+    if (now - lastPulledAt < api.listExtraIntervalMs!) {
+        ctx.logger.debug(
+            `[dync] pull:skip-interval tableName=${tableName} lastPulledAt=${new Date(lastPulledAt).toISOString()} nextAllowed=${new Date(lastPulledAt + api.listExtraIntervalMs!).toISOString()}`,
+        );
+        return true;
+    }
+    return false;
+}
+
 async function handleRemoteItemUpdate(table: StorageTable<any>, tableName: string, localItem: any, remote: any, ctx: PullContext): Promise<void> {
     const pendingChange = ctx.state.getState().pendingChanges.find((p) => p.tableName === tableName && p.localId === localItem._localId);
     const conflictStrategy = ctx.conflictResolutionStrategy;
@@ -117,8 +155,8 @@ export async function pullAllBatch(ctx: PullAllBatchContext): Promise<{ error?:
         // Build since map for all synced tables
         const sinceMap: Record<string, Date> = {};
         for (const tableName of ctx.batchSync.syncTables) {
-            const lastPulled = ctx.state.getState().lastPulled[tableName];
-            sinceMap[tableName] = lastPulled ? new Date(lastPulled) : new Date(0);
+            const newestServerUpdatedAt = ctx.state.getState().newestServerUpdatedAt[tableName];
+            sinceMap[tableName] = newestServerUpdatedAt ? new Date(newestServerUpdatedAt) : new Date(0);
         }
 
         ctx.logger.debug(`[dync] pull:batch:start tables=${[...ctx.batchSync.syncTables].join(',')}`, sinceMap);
@@ -201,8 +239,8 @@ async function processPullData(tableName: string, serverData: SyncedRecord[], si
 
         await ctx.state.setState((syncState) => ({
             ...syncState,
-            lastPulled: {
-                ...syncState.lastPulled,
+            newestServerUpdatedAt: {
+                ...syncState.newestServerUpdatedAt,
                 [tableName]: newest.toISOString(),
             },
         }));

package/src/core/pushOperations.ts

@@ -1,6 +1,6 @@
 import { createLocalId, orderFor } from '../helpers';
 import type { Logger } from '../logger';
-import type { ApiFunctions, BatchPushPayload, BatchPushResult, BatchSync, PendingChange, SyncOptions } from '../types';
+import type { CrudSyncApi, BatchPushPayload, BatchPushResult, BatchSync, PendingChange, SyncOptions } from '../types';
 import { SyncAction } from '../types';
 import type { StorageTable } from '../storage/types';
 import { DYNC_STATE_TABLE, type StateHelpers } from './StateManager';
@@ -15,7 +15,7 @@ export interface PushContext {
 }
 
 export interface PushAllContext extends PushContext {
-    syncApis: Record<string, ApiFunctions>;
+    syncApis: Record<string, CrudSyncApi>;
 }
 
 export interface PushAllBatchContext extends PushContext {

package/src/index.native.ts

@@ -10,7 +10,7 @@ export { createLocalId } from './helpers';
 
 export type {
     AfterRemoteAddCallback,
-    ApiFunctions,
+    CrudSyncApi,
     BatchSync,
     BatchPushPayload,
     BatchPushResult,

package/src/index.shared.ts

@@ -1,7 +1,7 @@
 import { newLogger, type Logger, type LogLevel } from './logger';
 import { sleep } from './helpers';
 import {
-    type ApiFunctions,
+    type CrudSyncApi,
     type BatchSync,
     type DyncOptions,
     type SyncOptions,
@@ -50,7 +50,7 @@ class DyncBase<_TStoreMap extends Record<string, any> = Record<string, any>> {
     private sleepAbortController?: AbortController;
     private closing = false;
     // Per-table sync mode
-    private syncApis: Record<string, ApiFunctions> = {};
+    private syncApis: Record<string, CrudSyncApi> = {};
     // Batch sync mode
     private batchSync?: BatchSync;
     private syncedTables: Set<string> = new Set();
@@ -93,7 +93,7 @@ class DyncBase<_TStoreMap extends Record<string, any> = Record<string, any>> {
                 this.batchSync = syncConfig as BatchSync;
                 this.syncedTables = new Set(this.batchSync.syncTables);
             } else {
-                this.syncApis = syncConfig as Record<string, ApiFunctions>;
+                this.syncApis = syncConfig as Record<string, CrudSyncApi>;
                 this.syncedTables = new Set(Object.keys(this.syncApis));
             }
         }
@@ -101,7 +101,7 @@ class DyncBase<_TStoreMap extends Record<string, any> = Record<string, any>> {
         this.adapter = storageAdapter;
         this.name = databaseName;
         this.syncOptions = {
-            syncInterval: DEFAULT_SYNC_INTERVAL_MILLIS,
+            syncIntervalMs: DEFAULT_SYNC_INTERVAL_MILLIS,
             logger: DEFAULT_LOGGER,
             minLogLevel: DEFAULT_MIN_LOG_LEVEL,
             missingRemoteRecordDuringUpdateStrategy: DEFAULT_MISSING_REMOTE_RECORD_STRATEGY,
@@ -430,6 +430,7 @@ class DyncBase<_TStoreMap extends Record<string, any> = Record<string, any>> {
         return runPullAll({
             ...baseContext,
             syncApis: this.syncApis,
+            syncIntervalMs: this.syncOptions.syncIntervalMs!,
         });
     }
 
@@ -470,7 +471,7 @@ class DyncBase<_TStoreMap extends Record<string, any> = Record<string, any>> {
         while (this.syncTimerStarted) {
             this.sleepAbortController = new AbortController();
             await this.syncOnce();
-            await sleep(this.syncOptions.syncInterval!, this.sleepAbortController.signal);
+            await sleep(this.syncOptions.syncIntervalMs!, this.sleepAbortController.signal);
         }
 
         this.syncStatus = 'disabled';

package/src/index.ts

@@ -10,7 +10,7 @@ export { createLocalId } from './helpers';
 
 export type {
     AfterRemoteAddCallback,
-    ApiFunctions,
+    CrudSyncApi,
     BatchSync,
     BatchPushPayload,
     BatchPushResult,

package/src/types.ts

@@ -24,11 +24,13 @@ export interface SyncedRecord {
     [k: string]: any;
 }
 
-export interface ApiFunctions {
+export interface CrudSyncApi {
     add: (item: any) => Promise<any | undefined>;
     update: (id: any, changes: any, item: any) => Promise<boolean>;
     remove: (id: any) => Promise<void>;
     list: (lastUpdatedAt: Date) => Promise<any[]>;
+    // Optional: Extend `SyncOptions.syncIntervalMs` for this table's pull sync
+    listExtraIntervalMs?: number;
     firstLoad?: (lastId: any) => Promise<any[]>;
 }
 
@@ -113,7 +115,7 @@ export type AfterRemoteAddCallback = (tableName: string, item: SyncedRecord) =>
 export type MissingRemoteRecordDuringUpdateCallback = (strategy: MissingRemoteRecordStrategy, item: SyncedRecord) => void;
 
 export interface SyncOptions {
-    syncInterval?: number;
+    syncIntervalMs?: number;
     logger?: Logger;
     minLogLevel?: LogLevel;
     onAfterRemoteAdd?: AfterRemoteAddCallback;
@@ -125,7 +127,7 @@ export interface SyncOptions {
 export interface DyncOptions<TStoreMap extends Record<string, any> = Record<string, any>> {
     databaseName: string;
     storageAdapter: StorageAdapter;
-    sync?: Partial<Record<keyof TStoreMap, ApiFunctions>> | BatchSync;
+    sync?: Partial<Record<keyof TStoreMap, CrudSyncApi>> | BatchSync;
     options?: SyncOptions;
 }
 
@@ -157,7 +159,8 @@ export interface MutationEvent {
 export interface PersistedSyncState {
     firstLoadDone: boolean;
     pendingChanges: PendingChange[];
-    lastPulled: Record<string, string>;
+    newestServerUpdatedAt: Record<string, string>;
+    lastPulledAt?: Record<string, number>;
     conflicts?: Record<string, Conflict>;
 }