@daiso-tech/core/dist/circuit-breaker/implementations/derivables/circuit-breaker-factory-resolver/database-circuit-breaker-factory-resolver.d.ts

The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.

/**
 * @module CircuitBreaker
 */
import { type BackoffPolicy } from "../../../../backoff-policies/contracts/_module.js";
import { type ICircuitBreakerFactoryResolver, type CircuitBreakerTrigger, type ICircuitBreakerFactory, type ICircuitBreakerStorageAdapter, type ICircuitBreakerPolicy } from "../../../../circuit-breaker/contracts/_module.js";
import { type CircuitBreakerFactorySettingsBase } from "../../../../circuit-breaker/implementations/derivables/circuit-breaker-factory/_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 ITimeSpan } from "../../../../time-span/contracts/_module.js";
import { type ErrorPolicy, type WaitUntil } from "../../../../utilities/_module.js";
/**
 * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker"`
 * @group Derivables
 */
export type DatabaseCircuitBreakerAdapters<TAdapters extends string> = Partial<Record<TAdapters, ICircuitBreakerStorageAdapter>>;
/**
 * Configuration for `DatabaseCircuitBreakerFactoryResolver`.
 * Convenience resolver that wires a {@link ICircuitBreakerStorageAdapter | `ICircuitBreakerStorageAdapter`} database adapter
 * with circuit-breaker logic and registers it as the sole named adapter.
 *
 * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker"`
 * @group Derivables
 */
export type DatabaseCircuitBreakerFactoryResolverSettings<TAdapters extends string> = CircuitBreakerFactorySettingsBase & {
    /**
     * Named registry of circuit-breaker storage adapters. Each key is an adapter alias and the corresponding value is the adapter instance.
     */
    adapters: DatabaseCircuitBreakerAdapters<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/circuit-breaker/policies";
     *
     * new ConsecutiveBreaker();
     * ```
     */
    circuitBreakerPolicy?: ICircuitBreakerPolicy;
};
/**
 * The `DatabaseCircuitBreakerFactoryResolver` class is immutable.
 *
 * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker"`
 * @group Derivables
 */
export declare class DatabaseCircuitBreakerFactoryResolver<TAdapters extends string> implements ICircuitBreakerFactoryResolver<TAdapters> {
    private readonly settings;
    /**
     * @example
     * ```ts
     * import { DatabaseCircuitBreakerFactoryResolver } from "@daiso-tech/core/circuit-breaker";
     * import { MemoryCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/memory-circuit-breaker-storate-adapter";
     * import { KyselyCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/kysely-circuit-breaker-storate-adapter";
     * import { DatabaseCircuitBreakerAdapter } from "@daiso-tech/core/circuit-breaker/database-circuit-breaker-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 circuitBreakerFactoryResolver = new DatabaseCircuitBreakerFactoryResolver({
     *   serde,
     *   adapters: {
     *     memory: new MemoryCircuitBreakerStorageAdapter(),
     *     sqlite: new KyselyCircuitBreakerStorageAdapter({
     *       kysely: new Kysely({
     *         dialect: new SqliteDialect({
     *           database: new Sqlite("local.db"),
     *         }),
     *       }),
     *       serde,
     *     }),
     *   },
     *   defaultAdapter: "memory",
     * });
     * ```
     */
    constructor(settings: DatabaseCircuitBreakerFactoryResolverSettings<TAdapters>);
    setNamespace(namespace: INamespace): DatabaseCircuitBreakerFactoryResolver<TAdapters>;
    setEventBus(eventBus: EventBusInput): DatabaseCircuitBreakerFactoryResolver<TAdapters>;
    setSlowCallTime(slowCallTime?: ITimeSpan): DatabaseCircuitBreakerFactoryResolver<TAdapters>;
    setTrigger(trigger?: CircuitBreakerTrigger): DatabaseCircuitBreakerFactoryResolver<TAdapters>;
    setDefaultErrorPolicy(defaultErrorPolicy: ErrorPolicy): DatabaseCircuitBreakerFactoryResolver<TAdapters>;
    setDefaultBackoffPolicy(backoffPolicy?: BackoffPolicy): DatabaseCircuitBreakerFactoryResolver<TAdapters>;
    setDefaultCircuitBreakerPolicy(circuitBreakerPolicy?: ICircuitBreakerPolicy): DatabaseCircuitBreakerFactoryResolver<TAdapters>;
    setWaitUntil(waitUntil: WaitUntil): DatabaseCircuitBreakerFactoryResolver<TAdapters>;
    setExecutionContext(executionContext: IExecutionContext): DatabaseCircuitBreakerFactoryResolver<TAdapters>;
    /**
     * @example
     * ```ts
     * import { DatabaseCircuitBreakerFactoryResolver } from "@daiso-tech/core/circuit-breaker";
     * import { MemoryCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/memory-circuit-breaker-storate-adapter";
     * import { KyselyCircuitBreakerStorageAdapter } from "@daiso-tech/core/circuit-breaker/kysely-circuit-breaker-storate-adapter";
     * import { DatabaseCircuitBreakerAdapter } from "@daiso-tech/core/circuit-breaker/database-circuit-breaker-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 circuitBreakerFactoryResolver = new DatabaseCircuitBreakerFactoryResolver({
     *   serde,
     *   adapters: {
     *     memory: new MemoryCircuitBreakerStorageAdapter(),
     *     sqlite: new KyselyCircuitBreakerStorageAdapter({
     *       kysely: new Kysely({
     *         dialect: new SqliteDialect({
     *           database: new Sqlite("local.db"),
     *         }),
     *       }),
     *       serde,
     *     }),
     *   },
     *   defaultAdapter: "memory",
     * });
     *
     * // Will apply circuit breaker logic the default adapter which is MemoryCircuitBreakerStorageAdapter
     * await circuitBreakerFactoryResolver
     *   .use()
     *   .create("a")
     *   .runOrFail(async () => {
     *     // ... code to apply circuit breaker logic
     *   });
     *
     * // Will apply circuit breaker logic using the KyselyCircuitBreakerStorageAdapter
     * await circuitBreakerFactoryResolver
     *   .use("sqlite")
     *   .create("a")
     *   .runOrFail(async () => {
     *     // ... code to apply circuit breaker logic
     *   });
     * ```
     */
    use(adapterName?: TAdapters | undefined): ICircuitBreakerFactory;
}