@daiso-tech/core
Version:
The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.
96 lines (95 loc) • 3.45 kB
TypeScript
/**
* @module RateLimiter
*/
import { type Kysely } from "kysely";
import { type IRateLimiterData, type IRateLimiterStorageAdapter, type IRateLimiterStorageAdapterTransaction } from "../../../../rate-limiter/contracts/_module.js";
import { type ISerde } from "../../../../serde/contracts/_module.js";
import { type ITimeSpan } from "../../../../time-span/contracts/_module.js";
import { type IDeinitizable, type IInitizable, type InvokableFn, type IPrunable } from "../../../../utilities/_module.js";
/**
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-adapter"`
* @group Adapters
*/
export type KyselyRateLimiterTable = {
key: string;
state: string;
expiration: number | bigint | string;
};
/**
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-adapter"`
* @group Adapters
*/
export type KyselyRateLimiterStorageTables = {
rateLimiter: KyselyRateLimiterTable;
};
/**
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-adapter"`
* @group Adapters
*/
export type KyselyRateLimiterStorageAdapterSettings = {
kysely: Kysely<KyselyRateLimiterStorageTables>;
serde: ISerde<string>;
/**
* @default
* ```ts
* import { TimeSpan } from "@daiso-tech/core/time-span";
*
* TimeSpan.fromMinutes(1)
* ```
*/
expiredKeysRemovalInterval?: ITimeSpan;
/**
* @default true
*/
shouldRemoveExpiredKeys?: boolean;
};
/**
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-adapter"`
* @group Adapters
*/
export declare class KyselyRateLimiterStorageAdapter<TType> implements IRateLimiterStorageAdapter<TType>, IInitizable, IDeinitizable, IPrunable {
private readonly kysely;
private readonly serde;
private readonly expiredKeysRemovalInterval;
private readonly shouldRemoveExpiredKeys;
private intervalId;
/**
* @example
* ```ts
* import { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storage-adapter";
* import { Serde } from "@daiso-tech/core/serde";
* import { SuperJsonSerdeAdapter } from "@daiso-tech/core/serde/super-json-serde-adapter"
* import Sqlite from "better-sqlite3";
* import { Kysely, SqliteDialect } from "kysely";
*
* const serde = new Serde(new SuperJsonSerdeAdapter());
* const rateLimiterStorageAdapter = new KyselyRateLimiterStorageAdapter({
* kysely: new Kysely({
* dialect: new SqliteDialect({
* database: new Sqlite("local.db"),
* }),
* }),
* serde
* });
* // You need initialize the adapter once before using it.
* await rateLimiterStorageAdapter.init();
* ```
*/
constructor(settings: KyselyRateLimiterStorageAdapterSettings);
/**
* Removes all related rate limiter tables and their rows.
* Note all rate limiter data will be removed.
*/
deInit(): Promise<void>;
/**
* Creates all related tables and indexes.
* Note the `init` method needs to be called once before using the adapter.
*/
init(): Promise<void>;
removeAllExpired(): Promise<void>;
transaction<TValue>(fn: InvokableFn<[
transaction: IRateLimiterStorageAdapterTransaction<TType>
], Promise<TValue>>): Promise<TValue>;
find(key: string): Promise<IRateLimiterData<TType> | null>;
remove(key: string): Promise<void>;
}