@abtnode/db-cache 1.16.45-beta-20250609-025419-7fd1f86c

package/dist/index.d.cts

@@ -0,0 +1,128 @@
+type ForceType = 'redis' | 'sqlite';
+interface BaseDBCacheParams {
+    /** Required non-empty prefix for all stored keys */
+    prefix: string;
+    /** Filesystem path for SQLite DB (also used to derive LMDB path) */
+    sqlitePath: string;
+    /** Default TTL (ms) */
+    ttl: number;
+    /** Cleanup interval (ms) for expired rows in SQLite */
+    cleanupInterval?: number;
+    /** URL for Redis (falls back to process.env.REDIS_URL if undefined) */
+    redisUrl?: string;
+    forceType?: ForceType;
+}
+type BaseDBCacheOptions = () => BaseDBCacheParams;
+interface IDBAdapter {
+    opts: BaseDBCacheParams;
+    ensure(): Promise<void>;
+    set(key: string, value: unknown, opts: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<boolean>;
+    get(key: string): Promise<unknown>;
+    del(key: string): Promise<void>;
+    has(key: string): Promise<boolean>;
+    groupSet(key: string, subKey: string, value: unknown, opts: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<void>;
+    groupGet(key: string, subKey: string): Promise<unknown>;
+    groupHas(key: string, subKey: string): Promise<boolean>;
+    groupDel(key: string, subKey: string): Promise<void>;
+    serialize(value: unknown): string;
+    deserialize(raw: string | null | undefined): unknown;
+    close(): Promise<void>;
+    flushAll(): Promise<void>;
+}
+
+declare class BaseDBCache {
+    private adapter;
+    prefix: string;
+    type: string;
+    defaultTtl: number;
+    private getOpts;
+    private _initdAdapter;
+    constructor(opts: BaseDBCacheOptions);
+    protected initAdapter(): void;
+    static randomKey(): string;
+    set(key: string, value: unknown, opts?: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<boolean>;
+    get(key: string): Promise<unknown>;
+    del(key: string): Promise<void>;
+    has(key: string): Promise<boolean>;
+    groupSet(key: string, subKey: string, value: unknown, opts?: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<void>;
+    groupGet(key: string, subKey: string): Promise<unknown>;
+    groupHas(key: string, subKey: string): Promise<boolean>;
+    groupDel(key: string, subKey: string): Promise<void>;
+    close(): Promise<void>;
+    flushAll(): Promise<void>;
+}
+
+declare class SingleFlightDBCache extends BaseDBCache {
+    private _pending;
+    constructor(opts: BaseDBCacheOptions);
+    /**
+     * If a request for the same key is already in flight, reuse it.
+     * Otherwise, fetch, cache, and return the value.
+     */
+    autoCache<T>(key: string, fn: () => Promise<T>, { ttl }?: {
+        ttl?: number;
+    }): Promise<T>;
+    /**
+     * Same logic as autoCache, but for group fields (hash).
+     */
+    autoCacheGroup<T>(key: string, subKey: string, fn: () => Promise<T>, { ttl }?: {
+        ttl?: number;
+    }): Promise<T>;
+}
+
+declare class LockDBCache extends SingleFlightDBCache {
+    private _inFlight;
+    createLock(lockName: string): Promise<boolean>;
+    /**
+     * 检查锁是否已经过期：只要缓存层面已经没有该 key，就代表已过期或从未创建。
+     *
+     * @param lockName    锁的名称
+     * @returns           如果锁不存在或已过期，返回 true；否则返回 false
+     */
+    isExpired(lockName: string): Promise<boolean>;
+    /**
+     * 主动释放锁：删除对应的缓存 key
+     *
+     * @param lockName    锁的名称
+     */
+    releaseLock(lockName: string): Promise<void>;
+    /**
+     * 等待锁释放或超时。每隔 100ms 检查一次缓存层面是否仍存在该锁 key。
+     * 如果在 timeoutMs 毫秒内 key 不再存在，则 resolve(true)。否则 resolve(false)。
+     *
+     * @param lockName     锁的名称
+     * @param timeoutMs    等待超时时间（毫秒），默认使用构造时传入的 this._timeout
+     * @returns            如果锁被释放或过期，resolve(true)；等待到超时还没释放，则 resolve(false)
+     */
+    waitUnLock(lockName: string, timeoutMs?: number): Promise<boolean>;
+    /**
+     * 获取锁的流程：
+     *  1. 先尝试 createLock(lockName)：
+     *     - 如果立刻拿到（createLock 返回 true），直接返回；
+     *     - 如果没拿到，就等待 waitUnLock(lockName)。
+     *  2. 等待到释放/过期后，再次尝试 createLock(lockName)。
+     *
+     * @param lockName    锁的名称
+     */
+    acquire(lockName: string): Promise<void>;
+    private _formatLockKey;
+}
+
+declare const getAbtNodeRedisAndSQLiteUrl: () => {
+    redisUrl: string | undefined;
+    sqlitePath: string | undefined;
+};
+
+export { type BaseDBCacheOptions, LockDBCache as DBCache, type IDBAdapter, getAbtNodeRedisAndSQLiteUrl };

package/dist/index.d.mts

@@ -0,0 +1,128 @@
+type ForceType = 'redis' | 'sqlite';
+interface BaseDBCacheParams {
+    /** Required non-empty prefix for all stored keys */
+    prefix: string;
+    /** Filesystem path for SQLite DB (also used to derive LMDB path) */
+    sqlitePath: string;
+    /** Default TTL (ms) */
+    ttl: number;
+    /** Cleanup interval (ms) for expired rows in SQLite */
+    cleanupInterval?: number;
+    /** URL for Redis (falls back to process.env.REDIS_URL if undefined) */
+    redisUrl?: string;
+    forceType?: ForceType;
+}
+type BaseDBCacheOptions = () => BaseDBCacheParams;
+interface IDBAdapter {
+    opts: BaseDBCacheParams;
+    ensure(): Promise<void>;
+    set(key: string, value: unknown, opts: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<boolean>;
+    get(key: string): Promise<unknown>;
+    del(key: string): Promise<void>;
+    has(key: string): Promise<boolean>;
+    groupSet(key: string, subKey: string, value: unknown, opts: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<void>;
+    groupGet(key: string, subKey: string): Promise<unknown>;
+    groupHas(key: string, subKey: string): Promise<boolean>;
+    groupDel(key: string, subKey: string): Promise<void>;
+    serialize(value: unknown): string;
+    deserialize(raw: string | null | undefined): unknown;
+    close(): Promise<void>;
+    flushAll(): Promise<void>;
+}
+
+declare class BaseDBCache {
+    private adapter;
+    prefix: string;
+    type: string;
+    defaultTtl: number;
+    private getOpts;
+    private _initdAdapter;
+    constructor(opts: BaseDBCacheOptions);
+    protected initAdapter(): void;
+    static randomKey(): string;
+    set(key: string, value: unknown, opts?: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<boolean>;
+    get(key: string): Promise<unknown>;
+    del(key: string): Promise<void>;
+    has(key: string): Promise<boolean>;
+    groupSet(key: string, subKey: string, value: unknown, opts?: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<void>;
+    groupGet(key: string, subKey: string): Promise<unknown>;
+    groupHas(key: string, subKey: string): Promise<boolean>;
+    groupDel(key: string, subKey: string): Promise<void>;
+    close(): Promise<void>;
+    flushAll(): Promise<void>;
+}
+
+declare class SingleFlightDBCache extends BaseDBCache {
+    private _pending;
+    constructor(opts: BaseDBCacheOptions);
+    /**
+     * If a request for the same key is already in flight, reuse it.
+     * Otherwise, fetch, cache, and return the value.
+     */
+    autoCache<T>(key: string, fn: () => Promise<T>, { ttl }?: {
+        ttl?: number;
+    }): Promise<T>;
+    /**
+     * Same logic as autoCache, but for group fields (hash).
+     */
+    autoCacheGroup<T>(key: string, subKey: string, fn: () => Promise<T>, { ttl }?: {
+        ttl?: number;
+    }): Promise<T>;
+}
+
+declare class LockDBCache extends SingleFlightDBCache {
+    private _inFlight;
+    createLock(lockName: string): Promise<boolean>;
+    /**
+     * 检查锁是否已经过期：只要缓存层面已经没有该 key，就代表已过期或从未创建。
+     *
+     * @param lockName    锁的名称
+     * @returns           如果锁不存在或已过期，返回 true；否则返回 false
+     */
+    isExpired(lockName: string): Promise<boolean>;
+    /**
+     * 主动释放锁：删除对应的缓存 key
+     *
+     * @param lockName    锁的名称
+     */
+    releaseLock(lockName: string): Promise<void>;
+    /**
+     * 等待锁释放或超时。每隔 100ms 检查一次缓存层面是否仍存在该锁 key。
+     * 如果在 timeoutMs 毫秒内 key 不再存在，则 resolve(true)。否则 resolve(false)。
+     *
+     * @param lockName     锁的名称
+     * @param timeoutMs    等待超时时间（毫秒），默认使用构造时传入的 this._timeout
+     * @returns            如果锁被释放或过期，resolve(true)；等待到超时还没释放，则 resolve(false)
+     */
+    waitUnLock(lockName: string, timeoutMs?: number): Promise<boolean>;
+    /**
+     * 获取锁的流程：
+     *  1. 先尝试 createLock(lockName)：
+     *     - 如果立刻拿到（createLock 返回 true），直接返回；
+     *     - 如果没拿到，就等待 waitUnLock(lockName)。
+     *  2. 等待到释放/过期后，再次尝试 createLock(lockName)。
+     *
+     * @param lockName    锁的名称
+     */
+    acquire(lockName: string): Promise<void>;
+    private _formatLockKey;
+}
+
+declare const getAbtNodeRedisAndSQLiteUrl: () => {
+    redisUrl: string | undefined;
+    sqlitePath: string | undefined;
+};
+
+export { type BaseDBCacheOptions, LockDBCache as DBCache, type IDBAdapter, getAbtNodeRedisAndSQLiteUrl };

package/dist/index.d.ts

@@ -0,0 +1,128 @@
+type ForceType = 'redis' | 'sqlite';
+interface BaseDBCacheParams {
+    /** Required non-empty prefix for all stored keys */
+    prefix: string;
+    /** Filesystem path for SQLite DB (also used to derive LMDB path) */
+    sqlitePath: string;
+    /** Default TTL (ms) */
+    ttl: number;
+    /** Cleanup interval (ms) for expired rows in SQLite */
+    cleanupInterval?: number;
+    /** URL for Redis (falls back to process.env.REDIS_URL if undefined) */
+    redisUrl?: string;
+    forceType?: ForceType;
+}
+type BaseDBCacheOptions = () => BaseDBCacheParams;
+interface IDBAdapter {
+    opts: BaseDBCacheParams;
+    ensure(): Promise<void>;
+    set(key: string, value: unknown, opts: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<boolean>;
+    get(key: string): Promise<unknown>;
+    del(key: string): Promise<void>;
+    has(key: string): Promise<boolean>;
+    groupSet(key: string, subKey: string, value: unknown, opts: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<void>;
+    groupGet(key: string, subKey: string): Promise<unknown>;
+    groupHas(key: string, subKey: string): Promise<boolean>;
+    groupDel(key: string, subKey: string): Promise<void>;
+    serialize(value: unknown): string;
+    deserialize(raw: string | null | undefined): unknown;
+    close(): Promise<void>;
+    flushAll(): Promise<void>;
+}
+
+declare class BaseDBCache {
+    private adapter;
+    prefix: string;
+    type: string;
+    defaultTtl: number;
+    private getOpts;
+    private _initdAdapter;
+    constructor(opts: BaseDBCacheOptions);
+    protected initAdapter(): void;
+    static randomKey(): string;
+    set(key: string, value: unknown, opts?: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<boolean>;
+    get(key: string): Promise<unknown>;
+    del(key: string): Promise<void>;
+    has(key: string): Promise<boolean>;
+    groupSet(key: string, subKey: string, value: unknown, opts?: {
+        ttl?: number;
+        nx?: boolean;
+    }): Promise<void>;
+    groupGet(key: string, subKey: string): Promise<unknown>;
+    groupHas(key: string, subKey: string): Promise<boolean>;
+    groupDel(key: string, subKey: string): Promise<void>;
+    close(): Promise<void>;
+    flushAll(): Promise<void>;
+}
+
+declare class SingleFlightDBCache extends BaseDBCache {
+    private _pending;
+    constructor(opts: BaseDBCacheOptions);
+    /**
+     * If a request for the same key is already in flight, reuse it.
+     * Otherwise, fetch, cache, and return the value.
+     */
+    autoCache<T>(key: string, fn: () => Promise<T>, { ttl }?: {
+        ttl?: number;
+    }): Promise<T>;
+    /**
+     * Same logic as autoCache, but for group fields (hash).
+     */
+    autoCacheGroup<T>(key: string, subKey: string, fn: () => Promise<T>, { ttl }?: {
+        ttl?: number;
+    }): Promise<T>;
+}
+
+declare class LockDBCache extends SingleFlightDBCache {
+    private _inFlight;
+    createLock(lockName: string): Promise<boolean>;
+    /**
+     * 检查锁是否已经过期：只要缓存层面已经没有该 key，就代表已过期或从未创建。
+     *
+     * @param lockName    锁的名称
+     * @returns           如果锁不存在或已过期，返回 true；否则返回 false
+     */
+    isExpired(lockName: string): Promise<boolean>;
+    /**
+     * 主动释放锁：删除对应的缓存 key
+     *
+     * @param lockName    锁的名称
+     */
+    releaseLock(lockName: string): Promise<void>;
+    /**
+     * 等待锁释放或超时。每隔 100ms 检查一次缓存层面是否仍存在该锁 key。
+     * 如果在 timeoutMs 毫秒内 key 不再存在，则 resolve(true)。否则 resolve(false)。
+     *
+     * @param lockName     锁的名称
+     * @param timeoutMs    等待超时时间（毫秒），默认使用构造时传入的 this._timeout
+     * @returns            如果锁被释放或过期，resolve(true)；等待到超时还没释放，则 resolve(false)
+     */
+    waitUnLock(lockName: string, timeoutMs?: number): Promise<boolean>;
+    /**
+     * 获取锁的流程：
+     *  1. 先尝试 createLock(lockName)：
+     *     - 如果立刻拿到（createLock 返回 true），直接返回；
+     *     - 如果没拿到，就等待 waitUnLock(lockName)。
+     *  2. 等待到释放/过期后，再次尝试 createLock(lockName)。
+     *
+     * @param lockName    锁的名称
+     */
+    acquire(lockName: string): Promise<void>;
+    private _formatLockKey;
+}
+
+declare const getAbtNodeRedisAndSQLiteUrl: () => {
+    redisUrl: string | undefined;
+    sqlitePath: string | undefined;
+};
+
+export { type BaseDBCacheOptions, LockDBCache as DBCache, type IDBAdapter, getAbtNodeRedisAndSQLiteUrl };