/** * @module SharedLock */ import { type Kysely } from "kysely"; import { type IReadableContext } from "../../../../execution-context/contracts/_module.js"; import { type ISharedLockAdapter, type ISharedLockAdapterState, type SharedLockAcquireSettings } from "../../../../shared-lock/contracts/_module.js"; import { type TimeSpan } from "../../../../time-span/implementations/_module.js"; import { type IDeinitizable, type IInitizable, type IPrunable } from "../../../../utilities/_module.js"; /** * IMPORT_PATH: `"@daiso-tech/core/shared-lock/kysely-shared-lock-adapter"` * @group Adapters */ export type KyselyWriterLockTable = { key: string; owner: string; expiration: number | bigint | string | null; }; /** * IMPORT_PATH: `"@daiso-tech/core/shared-lock/kysely-shared-lock-adapter"` * @group Adapters */ export type KyselyReaderSemaphoreTable = { key: string; limit: number; }; /** * IMPORT_PATH: `"@daiso-tech/core/shared-lock/kysely-shared-lock-adapter"` * @group Adapters */ export type KyselyReaderSemaphoreSlotTable = { id: string; key: string; expiration: number | string | null; }; /** * IMPORT_PATH: `"@daiso-tech/core/shared-lock/kysely-shared-lock-adapter"` * @group Adapters */ export type KyselySharedLockTables = { writerLock: KyselyWriterLockTable; readerSemaphore: KyselyReaderSemaphoreTable; readerSemaphoreSlot: KyselyReaderSemaphoreSlotTable; }; /** * Configuration for `KyselySharedLockAdapter`. * Requires a Kysely database instance with the shared-lock schema applied. * * IMPORT_PATH: `"@daiso-tech/core/shared-lock/kysely-shared-lock-adapter"` * @group Adapters */ export type KyselySharedLockAdapterSettings = { /** * The Kysely database instance with the required shared-lock schema tables applied. */ kysely: Kysely; /** * @default * ```ts * () => new Date() * ``` */ currentDate?: () => Date; }; /** * To utilize the `KyselySharedLockAdapter`, you must install the [`"kysely"`](https://www.npmjs.com/package/kysely) package and configure a `Kysely` class instance. * * Note in order to use `KyselySharedLockAdapter` correctly, ensure you use a single, consistent database across all server instances and use a database that has support for transactions. * The adapter have been tested with `sqlite`, `postgres` and `mysql` databases. * * IMPORT_PATH: `"@daiso-tech/core/shared-lock/kysely-shared-lock-adapter"` * @group Adapters */ export declare class KyselySharedLockAdapter implements ISharedLockAdapter, IDeinitizable, IInitizable, IPrunable { private readonly kysely; private readonly isMysql; private readonly currentDate; /** * @example * ```ts * import { KyselySharedLockAdapter } from "@daiso-tech/core/shared-lock/kysely-shared-lock-adapter"; * import Sqlite from "better-sqlite3"; * import { Kysely, SqliteDialect } from "kysely"; * * const sharedLockAdapter = new KyselySharedLockAdapter({ * kysely: new Kysely({ * dialect: new SqliteDialect({ * database: new Sqlite("local.db"), * }), * }), * }); * // You need initialize the adapter once before using it. * await sharedLockAdapter.init(); * ``` */ constructor(settings: KyselySharedLockAdapterSettings); private _transaction; init(): Promise; /** * Removes all related shared-lock tables and their rows. * Note all shared-lock data will be removed. */ deInit(): Promise; private removeAllExpiredReaders; private removeAllExpiredWriters; removeAllExpired(): Promise; acquireWriter(key: string, lockId: string, ttl: TimeSpan | null, _context: IReadableContext): Promise; releaseWriter(key: string, lockId: string, _context: IReadableContext): Promise; forceReleaseWriter(key: string, _context: IReadableContext): Promise; refreshWriter(key: string, lockId: string, ttl: TimeSpan, _context: IReadableContext): Promise; private checkWriterInTransaction; private ensureReaderSemaphore; private countActiveReaderSlots; private upsertReaderSlot; acquireReader(settings: SharedLockAcquireSettings): Promise; releaseReader(key: string, slotId: string, _context: IReadableContext): Promise; forceReleaseAllReaders(key: string, _context: IReadableContext): Promise; refreshReader(key: string, slotId: string, ttl: TimeSpan, _context: IReadableContext): Promise; private deleteNonExpiredWriter; private deleteNonExpiredReaderSlots; forceRelease(key: string, _context: IReadableContext): Promise; private getWriterState; private getReaderState; getState(key: string, _context: IReadableContext): Promise; }