@daiso-tech/core 0.41.1 → 0.43.2

package/dist/circuit-breaker/contracts/circuit-breaker-policy.contract.d.ts

@@ -0,0 +1,114 @@
+/**
+ * @module CircuitBreaker
+ */
+import { type CIRCUIT_BREAKER_STATE } from "../../circuit-breaker/contracts/circuit-breaker-state.contract.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type CircuitBreakerHalfOpenState<TMetrics = unknown> = {
+    type: typeof CIRCUIT_BREAKER_STATE.HALF_OPEN;
+    metrics: TMetrics;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type CircuitBreakerClosedState<TMetrics = unknown> = {
+    type: typeof CIRCUIT_BREAKER_STATE.CLOSED;
+    metrics: TMetrics;
+};
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type CircuitBreakerTrackState<TMetrics = unknown> = CircuitBreakerClosedState<TMetrics> | CircuitBreakerHalfOpenState<TMetrics>;
+/**
+ * The constant represents all available state transition when in closed state
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export declare const CLOSED_TRANSITIONS: {
+    /**
+     * This field indicates that circuit breaker will transition from closed to open state.
+     */
+    readonly TO_OPEN: "TO_OPEN";
+    /**
+     * This field indicates that circuite breaker will stay in closed state and not transition.
+     */
+    readonly NONE: "NONE";
+};
+/**
+ * Indicates all available state transition when in closed state
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type ClosedTransitions = (typeof CLOSED_TRANSITIONS)[keyof typeof CLOSED_TRANSITIONS];
+/**
+ * The constant represents all available state transition when in half open state
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export declare const HALF_OPEN_TRANSITIONS: {
+    /**
+     * This field indicates that circuit breaker will transition from half open to open state.
+     */
+    readonly TO_OPEN: "TO_OPEN";
+    /**
+     * This field indicates that circuit breaker will transition from half openb to closed state.
+     */
+    readonly TO_CLOSED: "TO_CLOSED";
+    /**
+     * This field indicates that circuite breaker will stay in half open state and not transition.
+     */
+    readonly NONE: "NONE";
+};
+/**
+ * Indicates all available state transition when in half open state
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type HalfOpenTransitions = (typeof HALF_OPEN_TRANSITIONS)[keyof typeof HALF_OPEN_TRANSITIONS];
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type CircuitBreakerTrackSettings<TMetrics = unknown> = {
+    currentDate: Date;
+    initialMetrics: TMetrics;
+};
+/**
+ * The `ICircuitBreakerPolicy` contract defines the circuite breaker algorithm.
+ * Note all the methods here are pure functions, meaning they should return copies and not mutate input data.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type ICircuitBreakerPolicy<TMetrics = unknown> = {
+    initialMetrics(): TMetrics;
+    /**
+     * The `whenClosed` method should use `currentMetrics` and if needed `currentDate` to transition to open state or stay in closed state.
+     */
+    whenClosed(currentMetrics: TMetrics, currentDate: Date): ClosedTransitions;
+    /**
+     * The `whenHalfOpened` method should use `currentMetrics` and if needed `currentDate` to transition to open state, closed state or stay in half open state.
+     */
+    whenHalfOpened(currentMetrics: TMetrics, currentDate: Date): HalfOpenTransitions;
+    /**
+     * The `trackFailure` method updates the metrics when failure occurs. The metrics will be used `whenClosed` and `whenHalfOpen` methods.
+     */
+    trackFailure(currentState: CircuitBreakerTrackState<TMetrics>, settings: CircuitBreakerTrackSettings<TMetrics>): TMetrics;
+    /**
+     * The `trackSuccess` method updates the metrics when success occurs.
+     */
+    trackSuccess(currentState: CircuitBreakerTrackState<TMetrics>, settings: CircuitBreakerTrackSettings<TMetrics>): TMetrics;
+    /**
+     * The `isEqual` method should return true only when both metrics are equal.
+     * This method is optional, it is only used for optimization purposes.
+     */
+    isEqual?(metricsA: TMetrics, metricsB: TMetrics): boolean;
+};

package/dist/circuit-breaker/contracts/circuit-breaker-policy.contract.js

@@ -0,0 +1,41 @@
+/**
+ * @module CircuitBreaker
+ */
+import {} from "../../circuit-breaker/contracts/circuit-breaker-state.contract.js";
+/**
+ * The constant represents all available state transition when in closed state
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export const CLOSED_TRANSITIONS = {
+    /**
+     * This field indicates that circuit breaker will transition from closed to open state.
+     */
+    TO_OPEN: "TO_OPEN",
+    /**
+     * This field indicates that circuite breaker will stay in closed state and not transition.
+     */
+    NONE: "NONE",
+};
+/**
+ * The constant represents all available state transition when in half open state
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export const HALF_OPEN_TRANSITIONS = {
+    /**
+     * This field indicates that circuit breaker will transition from half open to open state.
+     */
+    TO_OPEN: "TO_OPEN",
+    /**
+     * This field indicates that circuit breaker will transition from half openb to closed state.
+     */
+    TO_CLOSED: "TO_CLOSED",
+    /**
+     * This field indicates that circuite breaker will stay in half open state and not transition.
+     */
+    NONE: "NONE",
+};
+//# sourceMappingURL=circuit-breaker-policy.contract.js.map

package/dist/circuit-breaker/contracts/circuit-breaker-policy.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-breaker-policy.contract.js","sourceRoot":"","sources":["../../../src/circuit-breaker/contracts/circuit-breaker-policy.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAA8B,MAAM,+DAA+D,CAAC;AA4B3G;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAC9B;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM;CACN,CAAC;AAWX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACjC;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,SAAS,EAAE,WAAW;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM;CACN,CAAC"}

package/dist/circuit-breaker/contracts/circuit-breaker-provider-factory.contract.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @module CircuitBreaker
+ */
+import { type ICircuitBreakerProvider } from "../../circuit-breaker/contracts/circuit-breaker-provider.contract.js";
+/**
+ * The `ICircuitBreakerProviderFactory` contract makes it easy to configure and switch between different {@link ICircuitBreakerProvider | `ICircuitBreakerProvider`} dynamically.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type ICircuitBreakerProviderFactory<TAdapters extends string = string> = {
+    /**
+     * The `use` method will throw an error if you provide it unregisted adapter.
+     * If no default adapter is defined an error will be thrown by `use` method.
+     * @throws {UnregisteredAdapterError} {@link UnregisteredAdapterError}
+     * @throws {DefaultAdapterNotDefinedError} {@link DefaultAdapterNotDefinedError}
+     */
+    use(adapterName?: TAdapters): ICircuitBreakerProvider;
+};

package/dist/circuit-breaker/contracts/circuit-breaker-provider-factory.contract.js

@@ -0,0 +1,10 @@
+/**
+ * @module CircuitBreaker
+ */
+import {} from "../../circuit-breaker/contracts/circuit-breaker-provider.contract.js";
+import { 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+UnregisteredAdapterError, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+DefaultAdapterNotDefinedError, } from "../../utilities/_module.js";
+//# sourceMappingURL=circuit-breaker-provider-factory.contract.js.map

package/dist/circuit-breaker/contracts/circuit-breaker-provider-factory.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-breaker-provider-factory.contract.js","sourceRoot":"","sources":["../../../src/circuit-breaker/contracts/circuit-breaker-provider-factory.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAgC,MAAM,kEAAkE,CAAC;AAChH,OAAO;AACH,6DAA6D;AAC7D,wBAAwB;AACxB,6DAA6D;AAC7D,6BAA6B,GAChC,MAAM,wBAAwB,CAAC"}

package/dist/circuit-breaker/contracts/circuit-breaker-provider.contract.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @module CircuitBreaker
+ */
+import { type ICircuitBreaker } from "../../circuit-breaker/contracts/circuit-breaker.contract.js";
+import { type CircuitBreakerEventMap } from "../../circuit-breaker/contracts/circuit-breaker.events.js";
+import { type IEventListenable } from "../../event-bus/contracts/_module.js";
+import { type ITimeSpan } from "../../time-span/contracts/time-span.contract.js";
+import { type ErrorPolicySettings } from "../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export declare const CIRCUIT_BREAKER_TRIGGER: {
+    readonly ONLY_ERROR: "ONLY_ERROR";
+    readonly ONLY_SLOW_CALL: "ONLY_SLOW_CALL";
+    readonly BOTH: "BOTH";
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type CircuitBreakerTrigger = (typeof CIRCUIT_BREAKER_TRIGGER)[keyof typeof CIRCUIT_BREAKER_TRIGGER];
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type CircuitBreakerProviderCreateSettings = ErrorPolicySettings & {
+    /**
+     * You can decide to track only errors, only slow calls or both as failures.
+     */
+    trigger?: CircuitBreakerTrigger;
+    /**
+     * You can set slow call threshold.
+     */
+    slowCallTime?: ITimeSpan;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type ICircuitBreakerProviderBase = {
+    /**
+     * The `create` method is used to create an instance of {@link ICircuitBreaker | `ICircuitBreaker`}.
+     */
+    create(key: string, settings?: CircuitBreakerProviderCreateSettings): ICircuitBreaker;
+};
+/**
+ * The `ICircuitBreakerListenable` contract defines a way for listening {@link ICircuitBreaker | `ICircuitBreaker`} operations and state transitions.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type ICircuitBreakerListenable = IEventListenable<CircuitBreakerEventMap>;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type ICircuitBreakerProvider = ICircuitBreakerListenable & ICircuitBreakerProviderBase;

package/dist/circuit-breaker/contracts/circuit-breaker-provider.contract.js

@@ -0,0 +1,19 @@
+/**
+ * @module CircuitBreaker
+ */
+import {} from "../../circuit-breaker/contracts/circuit-breaker.contract.js";
+import {} from "../../circuit-breaker/contracts/circuit-breaker.events.js";
+import {} from "../../event-bus/contracts/_module.js";
+import {} from "../../time-span/contracts/time-span.contract.js";
+import {} from "../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export const CIRCUIT_BREAKER_TRIGGER = {
+    ONLY_ERROR: "ONLY_ERROR",
+    ONLY_SLOW_CALL: "ONLY_SLOW_CALL",
+    BOTH: "BOTH",
+};
+//# sourceMappingURL=circuit-breaker-provider.contract.js.map

package/dist/circuit-breaker/contracts/circuit-breaker-provider.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-breaker-provider.contract.js","sourceRoot":"","sources":["../../../src/circuit-breaker/contracts/circuit-breaker-provider.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAwB,MAAM,yDAAyD,CAAC;AAC/F,OAAO,EAA+B,MAAM,uDAAuD,CAAC;AACpG,OAAO,EAAyB,MAAM,kCAAkC,CAAC;AACzE,OAAO,EAAkB,MAAM,6CAA6C,CAAC;AAC7E,OAAO,EAA4B,MAAM,wBAAwB,CAAC;AAElE;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACnC,UAAU,EAAE,YAAY;IACxB,cAAc,EAAE,gBAAgB;IAChC,IAAI,EAAE,MAAM;CACN,CAAC"}

package/dist/circuit-breaker/contracts/circuit-breaker-state.contract.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @module CircuitBreaker
+ */
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export declare const CIRCUIT_BREAKER_STATE: {
+    readonly OPEN: "OPEN";
+    readonly HALF_OPEN: "HALF_OPEN";
+    readonly CLOSED: "CLOSED";
+    readonly ISOLATED: "ISOLATED";
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type CircuitBreakerState = (typeof CIRCUIT_BREAKER_STATE)[keyof typeof CIRCUIT_BREAKER_STATE];

package/dist/circuit-breaker/contracts/circuit-breaker-state.contract.js

@@ -0,0 +1,15 @@
+/**
+ * @module CircuitBreaker
+ */
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export const CIRCUIT_BREAKER_STATE = {
+    OPEN: "OPEN",
+    HALF_OPEN: "HALF_OPEN",
+    CLOSED: "CLOSED",
+    ISOLATED: "ISOLATED",
+};
+//# sourceMappingURL=circuit-breaker-state.contract.js.map

package/dist/circuit-breaker/contracts/circuit-breaker-state.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-breaker-state.contract.js","sourceRoot":"","sources":["../../../src/circuit-breaker/contracts/circuit-breaker-state.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACjC,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;CACd,CAAC"}

package/dist/circuit-breaker/contracts/circuit-breaker-storage-adapter.contract.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @module CircuitBreaker
+ */
+import { type InvokableFn } from "../../utilities/_module.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type ICircuitBreakerStorageAdapterTransaction<TType = unknown> = {
+    /**
+     * The `upsert` inserts a circuit breaker if it doesnt exist otherwise it will be updated.
+     *
+     * @param key The unique identifier for the circuit breaker.
+     */
+    upsert(key: string, state: TType): Promise<void>;
+    /**
+     * Retrieves the current circuit breaker state for a given key.
+     *
+     * @param key The unique identifier for the cricuit breaker.
+     * @returns Returns the circuit breaker state if found, otherwise `null`.
+     */
+    find(key: string): Promise<TType | null>;
+};
+/**
+ * The `ICircuitBreakerStorageAdapter` contract defines a way for storing circuit breaker state independent of the underlying technology.
+ * This contract simplifies the implementation of circuit breaker adapters with CRUD-based databases, such as SQL databases and ORMs like TypeOrm and MikroOrm.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type ICircuitBreakerStorageAdapter<TType = unknown> = {
+    /**
+     * The `transaction` method runs the `fn` function inside a transaction.
+     * The `fn` function is given a {@link ICircuitBreakerStorageAdapterTransaction | `ICircuitBreakerStorageAdapterTransaction`} object.
+     */
+    transaction<TValue>(fn: InvokableFn<[
+        transaction: ICircuitBreakerStorageAdapterTransaction<TType>
+    ], Promise<TValue>>): Promise<TValue>;
+    /**
+     * Retrieves the current circuit breaker state for a given key.
+     *
+     * @param key The unique identifier for the cricuit breaker.
+     * @returns Returns the circuit breaker state if found, otherwise `null`.
+     */
+    find(key: string): Promise<TType | null>;
+    /**
+     * Removes a circuit breaker from the database.
+     *
+     * @param key The unique identifier for the cricuit breaker to remove.
+     */
+    remove(key: string): Promise<void>;
+};

package/dist/circuit-breaker/contracts/circuit-breaker-storage-adapter.contract.js

@@ -0,0 +1,5 @@
+/**
+ * @module CircuitBreaker
+ */
+import {} from "../../utilities/_module.js";
+//# sourceMappingURL=circuit-breaker-storage-adapter.contract.js.map

package/dist/circuit-breaker/contracts/circuit-breaker-storage-adapter.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-breaker-storage-adapter.contract.js","sourceRoot":"","sources":["../../../src/circuit-breaker/contracts/circuit-breaker-storage-adapter.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAoB,MAAM,wBAAwB,CAAC"}

package/dist/circuit-breaker/contracts/circuit-breaker.contract.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @module CircuitBreaker
+ */
+import { type CircuitBreakerState } from "../../circuit-breaker/contracts/circuit-breaker-state.contract.js";
+import { type ITask } from "../../task/contracts/_module.js";
+import { type AsyncLazy } from "../../utilities/_module.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type ICircuitBreakerStateMethods = {
+    getState(): ITask<CircuitBreakerState>;
+    /**
+     * The `key` of the `ICircuitBreaker` instance.
+     */
+    readonly key: string;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Contracts
+ */
+export type ICircuitBreaker = ICircuitBreakerStateMethods & {
+    /**
+     * The `runOrFail` method runs `asyncFn` in when the circuit breaker is in closed state and half opend state.
+     * Throws an error when in opend state.
+     *
+     * @throws {OpenCircuitBreakerError} {@link OpenCircuitBreakerError}
+     */
+    runOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): ITask<TValue>;
+    /**
+     * The `isolate` method will transition the circuit breaker to isolated state, meaning the circuit breaker will reject all attempts untill it is manually reset.
+     */
+    isolate(): ITask<void>;
+    /**
+     * The `reset` method resets circuit breaker to its initial state regardless of the current state.
+     */
+    reset(): ITask<void>;
+};

package/dist/circuit-breaker/contracts/circuit-breaker.contract.js

@@ -0,0 +1,9 @@
+/**
+ * @module CircuitBreaker
+ */
+import {} from "../../circuit-breaker/contracts/circuit-breaker-state.contract.js";
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import {} from "../../circuit-breaker/contracts/circuit-breaker.errors.js";
+import {} from "../../task/contracts/_module.js";
+import {} from "../../utilities/_module.js";
+//# sourceMappingURL=circuit-breaker.contract.js.map

package/dist/circuit-breaker/contracts/circuit-breaker.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-breaker.contract.js","sourceRoot":"","sources":["../../../src/circuit-breaker/contracts/circuit-breaker.contract.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAA4B,MAAM,+DAA+D,CAAC;AACzG,6DAA6D;AAC7D,OAAO,EAAgC,MAAM,uDAAuD,CAAC;AACrG,OAAO,EAAc,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAkB,MAAM,wBAAwB,CAAC"}

package/dist/circuit-breaker/contracts/circuit-breaker.errors.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @module CircuitBreaker
+ */
+import { type Key } from "../../namespace/_module.js";
+/**
+ * The error is thrown when circuit breaker is in open state and will not allow any attempts.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Errors
+ */
+export declare class OpenCircuitBreakerError extends Error {
+    static create(key: Key, cause?: unknown): OpenCircuitBreakerError;
+    /**
+     * Note: Do not instantiate `OpenCircuitBreakerError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message: string, cause?: unknown);
+}
+export declare class IsolatedCircuitBreakerError extends Error {
+    static create(key: Key, cause?: unknown): IsolatedCircuitBreakerError;
+    /**
+     * Note: Do not instantiate `IsolatedCircuitBreakerError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message: string, cause?: unknown);
+}
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Errors
+ */
+export declare const CIRCUIT_BREAKER_ERRORS: {
+    readonly Open: typeof OpenCircuitBreakerError;
+    readonly Isolated: typeof IsolatedCircuitBreakerError;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Errors
+ */
+export type AllCircuitBreakerErrors = OpenCircuitBreakerError;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Errors
+ */
+export declare function isCircuitBreakerError(value: unknown): value is AllCircuitBreakerErrors;

package/dist/circuit-breaker/contracts/circuit-breaker.errors.js

@@ -0,0 +1,61 @@
+/**
+ * @module CircuitBreaker
+ */
+import {} from "../../namespace/_module.js";
+/**
+ * The error is thrown when circuit breaker is in open state and will not allow any attempts.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Errors
+ */
+export class OpenCircuitBreakerError extends Error {
+    static create(key, cause) {
+        return new OpenCircuitBreakerError(`Circuit breaker for key "${key.get()}" in opened state. All calls are being blocked until transitioned to half opened state.`, cause);
+    }
+    /**
+     * Note: Do not instantiate `OpenCircuitBreakerError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = OpenCircuitBreakerError.name;
+    }
+}
+export class IsolatedCircuitBreakerError extends Error {
+    static create(key, cause) {
+        return new IsolatedCircuitBreakerError(`Circuit breaker for key "${key.get()}" is manually isolated. All calls are being blocked until reseted.`, cause);
+    }
+    /**
+     * Note: Do not instantiate `IsolatedCircuitBreakerError` directly via the constructor. Use the static `create()` factory method instead.
+     * The constructor remains public only to maintain compatibility with errorPolicy types and prevent type errors.
+     * @internal
+     */
+    constructor(message, cause) {
+        super(message, { cause });
+        this.name = IsolatedCircuitBreakerError.name;
+    }
+}
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Errors
+ */
+export const CIRCUIT_BREAKER_ERRORS = {
+    Open: OpenCircuitBreakerError,
+    Isolated: IsolatedCircuitBreakerError,
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Errors
+ */
+export function isCircuitBreakerError(value) {
+    for (const ErrorClass of Object.values(CIRCUIT_BREAKER_ERRORS)) {
+        if (!(value instanceof ErrorClass)) {
+            return false;
+        }
+    }
+    return true;
+}
+//# sourceMappingURL=circuit-breaker.errors.js.map

package/dist/circuit-breaker/contracts/circuit-breaker.errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-breaker.errors.js","sourceRoot":"","sources":["../../../src/circuit-breaker/contracts/circuit-breaker.errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAY,MAAM,wBAAwB,CAAC;AAElD;;;;;GAKG;AACH,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IAC9C,MAAM,CAAC,MAAM,CAAC,GAAQ,EAAE,KAAe;QACnC,OAAO,IAAI,uBAAuB,CAC9B,4BAA4B,GAAG,CAAC,GAAG,EAAE,yFAAyF,EAC9H,KAAK,CACR,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC,IAAI,CAAC;IAC7C,CAAC;CACJ;AAED,MAAM,OAAO,2BAA4B,SAAQ,KAAK;IAClD,MAAM,CAAC,MAAM,CAAC,GAAQ,EAAE,KAAe;QACnC,OAAO,IAAI,2BAA2B,CAClC,4BAA4B,GAAG,CAAC,GAAG,EAAE,oEAAoE,EACzG,KAAK,CAER,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,YAAY,OAAe,EAAE,KAAe;QACxC,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1B,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC,IAAI,CAAC;IACjD,CAAC;CACJ;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IAClC,IAAI,EAAE,uBAAuB;IAC7B,QAAQ,EAAE,2BAA2B;CAC/B,CAAC;AASX;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CACjC,KAAc;IAEd,KAAK,MAAM,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,EAAE,CAAC;QAC7D,IAAI,CAAC,CAAC,KAAK,YAAY,UAAU,CAAC,EAAE,CAAC;YACjC,OAAO,KAAK,CAAC;QACjB,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/dist/circuit-breaker/contracts/circuit-breaker.events.d.ts

@@ -0,0 +1,96 @@
+/**
+ * @module CircuitBreaker
+ */
+import { type CircuitBreakerState } from "../../circuit-breaker/contracts/circuit-breaker-state.contract.js";
+import { type ICircuitBreakerStateMethods } from "../../circuit-breaker/contracts/circuit-breaker.contract.js";
+/**
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Events
+ */
+export type CircuitBreakerEventBase = {
+    circuitBreaker: ICircuitBreakerStateMethods;
+};
+/**
+ * The event is dispatched when a circuit breaker has transitioned state.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Events
+ */
+export type StateTransitionCircuitBreakerEvent = CircuitBreakerEventBase & {
+    from: CircuitBreakerState;
+    to: CircuitBreakerState;
+};
+/**
+ * The event is dispatched when a circuit breaker has tracked failure.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Events
+ */
+export type TrackedFailureCircuitBreakerEvent = CircuitBreakerEventBase & {
+    error: unknown;
+};
+/**
+ * The event is dispatched when a circuit breaker has untracked failure.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Events
+ */
+export type UntrackedFailureCircuitBreakerEvent = CircuitBreakerEventBase & {
+    error: unknown;
+};
+/**
+ * The event is dispatched when a circuit breaker has tracked slow call.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Events
+ */
+export type TrackedSlowCallCircuitBreakerEvent = CircuitBreakerEventBase;
+/**
+ * The event is dispatched when a circuit breaker has tracked successful call.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Events
+ */
+export type TrackedSuccessCircuitBreakerEvent = CircuitBreakerEventBase;
+/**
+ * The event is dispatched when circuit breaker has been reseted.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Events
+ */
+export type ResetedCircuitBreakerEvent = CircuitBreakerEventBase;
+/**
+ * The event is dispatched when circuit breaker has been reseted.
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Events
+ */
+export type IsolatedCircuitBreakerEvent = CircuitBreakerEventBase;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Events
+ */
+export declare const CIRCUIT_BREAKER_EVENTS: {
+    readonly STATE_TRANSITIONED: "STATE_TRANSITIONED";
+    readonly RESETED: "RESETED";
+    readonly UNTRACKED_FAILURE: "IGNORED_ERRROR";
+    readonly TRACKED_SUCCESS: "TRACKED_SUCCESS";
+    readonly TRACKED_FAILURE: "TRACKED_FAILURE";
+    readonly TRACKED_SLOW_CALL: "TRACKED_SLOW_CALL";
+    readonly ISOLATED: "ISOLATED";
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/circuit-breaker/contracts"`
+ * @group Events
+ */
+export type CircuitBreakerEventMap = {
+    [CIRCUIT_BREAKER_EVENTS.STATE_TRANSITIONED]: StateTransitionCircuitBreakerEvent;
+    [CIRCUIT_BREAKER_EVENTS.TRACKED_FAILURE]: TrackedFailureCircuitBreakerEvent;
+    [CIRCUIT_BREAKER_EVENTS.UNTRACKED_FAILURE]: UntrackedFailureCircuitBreakerEvent;
+    [CIRCUIT_BREAKER_EVENTS.TRACKED_SLOW_CALL]: TrackedSlowCallCircuitBreakerEvent;
+    [CIRCUIT_BREAKER_EVENTS.TRACKED_SUCCESS]: TrackedSuccessCircuitBreakerEvent;
+    [CIRCUIT_BREAKER_EVENTS.RESETED]: ResetedCircuitBreakerEvent;
+    [CIRCUIT_BREAKER_EVENTS.ISOLATED]: IsolatedCircuitBreakerEvent;
+};