@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.
147 lines (146 loc) • 6.64 kB
TypeScript
/**
* @module RateLimiter
*/
import { type BackoffPolicy } from "../../../../backoff-policies/contracts/_module.js";
import { type EventBusInput } from "../../../../event-bus/contracts/_module.js";
import { type IExecutionContext } from "../../../../execution-context/contracts/_module.js";
import { type INamespace } from "../../../../namespace/contracts/_module.js";
import { type IRateLimiterFactoryResolver, type IRateLimiterFactory, type IRateLimiterStorageAdapter, type IRateLimiterPolicy } from "../../../../rate-limiter/contracts/_module.js";
import { type RateLimiterFactorySettingsBase } from "../../../../rate-limiter/implementations/derivables/rate-limiter-factory/_module.js";
import { type ErrorPolicy, type WaitUntil } from "../../../../utilities/_module.js";
/**
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
* @group Derivables
*/
export type DatabaseRateLimiterAdapters<TAdapters extends string> = Partial<Record<TAdapters, IRateLimiterStorageAdapter>>;
/**
* Configuration for `DatabaseRateLimiterFactoryResolver`.
* Convenience resolver that wires named {@link IRateLimiterStorageAdapter | `IRateLimiterStorageAdapter`} database adapters
* into rate-limiter logic.
*
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
* @group Derivables
*/
export type DatabaseRateLimiterFactoryResolverSettings<TAdapters extends string> = RateLimiterFactorySettingsBase & {
/**
* Named registry of rate-limiter storage adapters. Each key is an adapter alias and the corresponding value is the adapter instance.
*/
adapters: DatabaseRateLimiterAdapters<TAdapters>;
/**
* The alias of the adapter to use when none is explicitly specified. Must be a key in the `adapters` map.
*/
defaultAdapter?: NoInfer<TAdapters>;
/**
* @default
* ```ts
* import { exponentialBackoff } from "@daiso-tech/core/backoff-policies";
*
* exponentialBackoff();
* ```
*/
backoffPolicy?: BackoffPolicy;
/**
* @default
* ```ts
* import { ConsecutiveBreaker } from "@daiso-tech/core/rate-limiter/policies";
*
* new ConsecutiveBreaker({ failureThreshold: 5 });
* ```
*/
rateLimiterPolicy?: IRateLimiterPolicy;
};
/**
* The `DatabaseRateLimiterFactoryResolver` class is immutable.
*
* IMPORT_PATH: `"@daiso-tech/core/rate-limiter"`
* @group Derivables
*/
export declare class DatabaseRateLimiterFactoryResolver<TAdapters extends string> implements IRateLimiterFactoryResolver<TAdapters> {
private readonly settings;
/**
* @example
* ```ts
* import { RateLimiterFactoryResolver } from "@daiso-tech/core/rate-limiter";
* import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storate-adapter";
* import { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storate-adapter";
* import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-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 rateLimiterFactoryResolver = new RateLimiterFactoryResolver({
* serde,
* adapters: {
* memory: new MemoryRateLimiterStorageAdapter(),
* sqlite: new KyselyRateLimiterStorageAdapter({
* kysely: new Kysely({
* dialect: new SqliteDialect({
* database: new Sqlite("local.db"),
* }),
* }),
* serde,
* }),
* },
* defaultAdapter: "memory",
* });
* ```
*/
constructor(settings: DatabaseRateLimiterFactoryResolverSettings<TAdapters>);
setNamespace(namespace: INamespace): DatabaseRateLimiterFactoryResolver<TAdapters>;
setEventBus(eventBus: EventBusInput): DatabaseRateLimiterFactoryResolver<TAdapters>;
setOnlyError(onlyError?: boolean): DatabaseRateLimiterFactoryResolver<TAdapters>;
setDefaultErrorPolicy(errorPolicy: ErrorPolicy): DatabaseRateLimiterFactoryResolver<TAdapters>;
setBackoffPolicy(backoffPolicy?: BackoffPolicy): DatabaseRateLimiterFactoryResolver<TAdapters>;
setRateLimiterPolicy(rateLimiterPolicy?: IRateLimiterPolicy): DatabaseRateLimiterFactoryResolver<TAdapters>;
setWaitUntil(waitUntil: WaitUntil): DatabaseRateLimiterFactoryResolver<TAdapters>;
setExecutionContext(executionContext: IExecutionContext): DatabaseRateLimiterFactoryResolver<TAdapters>;
/**
* @example
* ```ts
* import { RateLimiterFactoryResolver } from "@daiso-tech/core/rate-limiter";
* import { MemoryRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/memory-rate-limiter-storate-adapter";
* import { KyselyRateLimiterStorageAdapter } from "@daiso-tech/core/rate-limiter/kysely-rate-limiter-storate-adapter";
* import { DatabaseRateLimiterAdapter } from "@daiso-tech/core/rate-limiter/database-rate-limiter-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 rateLimiterFactoryResolver = new RateLimiterFactoryResolver({
* serde,
* adapters: {
* memory: new MemoryRateLimiterStorageAdapter(),
* sqlite: new KyselyRateLimiterStorageAdapter({
* kysely: new Kysely({
* dialect: new SqliteDialect({
* database: new Sqlite("local.db"),
* }),
* }),
* serde,
* }),
* },
* defaultAdapter: "memory",
* });
*
* // Will apply rate limiter logic the default adapter which is MemoryRateLimiterStorageAdapter
* await rateLimiterFactoryResolver
* .use()
* .create("a")
* .runOrFail(async () => {
* // ... code to apply rate limiter logic
* });
*
* // Will apply rate limiter logic the default adapter which is KyselyRateLimiterStorageAdapter
* await rateLimiterFactoryResolver
* .use("sqlite")
* .create("a")
* .runOrFail(async () => {
* // ... code to apply rate limiter logic
* });
* ```
*/
use(adapterName?: TAdapters | undefined): IRateLimiterFactory;
}