@ddd-ts-kit/aspects 0.0.0-stage → 0.1.1

package/dist/aspect/selector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"selector.js","sourceRoot":"","sources":["../../src/aspect/selector.ts"],"names":[],"mappings":""}

package/dist/aspect/selectors.d.ts

@@ -0,0 +1,14 @@
+import type { AspectKind } from './aspect-kind.js';
+import type { Selector } from './selector.js';
+/** Instances bound with `.as(kind)` to one of the kinds. An instance without kind never matches. */
+export declare function forKinds(...kinds: readonly AspectKind[]): Selector;
+/** Methods by name; `*` stands for any run of characters: `find*`, `*ById`, `get*For*`. */
+export declare function forMethods(...patterns: readonly string[]): Selector;
+/** Instances of one of the bounded contexts. */
+export declare function forContext(...contexts: readonly string[]): Selector;
+/** Instances by class name, with the same `*` as `forMethods`: `Http*`, `*Gateway`. */
+export declare function forClasses(...patterns: readonly string[]): Selector;
+export declare function allOf(...selectors: readonly Selector[]): Selector;
+export declare function anyOf(...selectors: readonly Selector[]): Selector;
+export declare function not(selector: Selector): Selector;
+//# sourceMappingURL=selectors.d.ts.map

package/dist/aspect/selectors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.d.ts","sourceRoot":"","sources":["../../src/aspect/selectors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,oGAAoG;AACpG,wBAAgB,QAAQ,CAAC,GAAG,KAAK,EAAE,SAAS,UAAU,EAAE,GAAG,QAAQ,CAElE;AAED,2FAA2F;AAC3F,wBAAgB,UAAU,CAAC,GAAG,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,QAAQ,CAInE;AAED,gDAAgD;AAChD,wBAAgB,UAAU,CAAC,GAAG,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,QAAQ,CAEnE;AAED,uFAAuF;AACvF,wBAAgB,UAAU,CAAC,GAAG,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,QAAQ,CAInE;AAED,wBAAgB,KAAK,CAAC,GAAG,SAAS,EAAE,SAAS,QAAQ,EAAE,GAAG,QAAQ,CAEjE;AAED,wBAAgB,KAAK,CAAC,GAAG,SAAS,EAAE,SAAS,QAAQ,EAAE,GAAG,QAAQ,CAEjE;AAED,wBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAEhD"}

package/dist/aspect/selectors.js

@@ -0,0 +1,32 @@
+/** Instances bound with `.as(kind)` to one of the kinds. An instance without kind never matches. */
+export function forKinds(...kinds) {
+    return (joinPoint) => joinPoint.kind !== undefined && kinds.includes(joinPoint.kind);
+}
+/** Methods by name; `*` stands for any run of characters: `find*`, `*ById`, `get*For*`. */
+export function forMethods(...patterns) {
+    const expressions = patterns.map(expressionOf);
+    return (joinPoint) => expressions.some((expression) => expression.test(joinPoint.method));
+}
+/** Instances of one of the bounded contexts. */
+export function forContext(...contexts) {
+    return (joinPoint) => joinPoint.context !== undefined && contexts.includes(joinPoint.context);
+}
+/** Instances by class name, with the same `*` as `forMethods`: `Http*`, `*Gateway`. */
+export function forClasses(...patterns) {
+    const expressions = patterns.map(expressionOf);
+    return (joinPoint) => expressions.some((expression) => expression.test(joinPoint.className));
+}
+export function allOf(...selectors) {
+    return (joinPoint) => selectors.every((selector) => selector(joinPoint));
+}
+export function anyOf(...selectors) {
+    return (joinPoint) => selectors.some((selector) => selector(joinPoint));
+}
+export function not(selector) {
+    return (joinPoint) => !selector(joinPoint);
+}
+function expressionOf(pattern) {
+    const literal = pattern.split('*').map((part) => part.replaceAll(/[.+?^${}()|[\]\\]/g, String.raw `\$&`));
+    return new RegExp(`^${literal.join('.*')}$`);
+}
+//# sourceMappingURL=selectors.js.map

package/dist/aspect/selectors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.js","sourceRoot":"","sources":["../../src/aspect/selectors.ts"],"names":[],"mappings":"AAGA,oGAAoG;AACpG,MAAM,UAAU,QAAQ,CAAC,GAAG,KAA4B;IACtD,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;AACvF,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,UAAU,CAAC,GAAG,QAA2B;IACvD,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAE/C,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,gDAAgD;AAChD,MAAM,UAAU,UAAU,CAAC,GAAG,QAA2B;IACvD,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;AAChG,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,UAAU,CAAC,GAAG,QAA2B;IACvD,MAAM,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAE/C,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;AAC/F,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,GAAG,SAA8B;IACrD,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,KAAK,CAAC,GAAG,SAA8B;IACrD,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,QAAkB;IACpC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,YAAY,CAAC,OAAe;IACnC,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,MAAM,CAAC,GAAG,CAAA,KAAK,CAAC,CAAC,CAAC;IAEzG,OAAO,IAAI,MAAM,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC/C,CAAC"}

package/dist/aspect/when.d.ts

@@ -0,0 +1,8 @@
+import type { Aspect } from './aspect.js';
+import type { Selector } from './selector.js';
+/**
+ * The aspects, for the methods the selector picks only:
+ * `when(allOf(forKinds('external'), forMethods('find*')), cached(...))`.
+ */
+export declare function when(selector: Selector, ...aspects: readonly Aspect[]): Aspect;
+//# sourceMappingURL=when.d.ts.map

package/dist/aspect/when.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"when.d.ts","sourceRoot":"","sources":["../../src/aspect/when.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAG1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C;;;GAGG;AACH,wBAAgB,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAE9E"}

package/dist/aspect/when.js

@@ -0,0 +1,21 @@
+import { aspectOrigins } from './aspect-origins.js';
+import { compose } from './compose.js';
+import { defineAspect } from './define-aspect.js';
+/**
+ * The aspects, for the methods the selector picks only:
+ * `when(allOf(forKinds('external'), forMethods('find*')), cached(...))`.
+ */
+export function when(selector, ...aspects) {
+    return compose(...aspects.map((aspect) => selecting(selector, aspect)));
+}
+function selecting(selector, aspect) {
+    const origin = aspectOrigins.get(aspect);
+    if (origin === undefined) {
+        throw new TypeError('when() selects methods of aspects made by defineAspect, compose or when: this function was not, so filter inside it');
+    }
+    if ('parts' in origin) {
+        return when(selector, ...origin.parts);
+    }
+    return defineAspect((joinPoint) => (selector(joinPoint) ? origin.advise(joinPoint) : undefined));
+}
+//# sourceMappingURL=when.js.map

package/dist/aspect/when.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"when.js","sourceRoot":"","sources":["../../src/aspect/when.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGlD;;;GAGG;AACH,MAAM,UAAU,IAAI,CAAC,QAAkB,EAAE,GAAG,OAA0B;IACpE,OAAO,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;AAC1E,CAAC;AAED,SAAS,SAAS,CAAC,QAAkB,EAAE,MAAc;IACnD,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAEzC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,SAAS,CACjB,qHAAqH,CACtH,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC,QAAQ,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,OAAO,YAAY,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;AACnG,CAAC"}

package/dist/bulkhead/bulkhead-options.d.ts

@@ -0,0 +1,10 @@
+import type { StateScope } from '../state/state-scope.js';
+export interface BulkheadOptions {
+    /** Calls running at once. */
+    readonly maxConcurrent: number;
+    /** Calls waiting for a place, in order. Default 0: beyond `maxConcurrent`, refuse at once. */
+    readonly maxQueued?: number;
+    /** One compartment per method (the default), or one shared by the methods of the instance. */
+    readonly scope?: StateScope;
+}
+//# sourceMappingURL=bulkhead-options.d.ts.map

package/dist/bulkhead/bulkhead-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulkhead-options.d.ts","sourceRoot":"","sources":["../../src/bulkhead/bulkhead-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,MAAM,WAAW,eAAe;IAC9B,6BAA6B;IAC7B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,8FAA8F;IAC9F,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,8FAA8F;IAC9F,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;CAC7B"}

package/dist/bulkhead/bulkhead-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=bulkhead-options.js.map

package/dist/bulkhead/bulkhead-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulkhead-options.js","sourceRoot":"","sources":["../../src/bulkhead/bulkhead-options.ts"],"names":[],"mappings":""}

package/dist/bulkhead/bulkhead.d.ts

@@ -0,0 +1,11 @@
+import type { AdviceFactory } from '../aspect/advice-factory.js';
+import type { Aspect } from '../aspect/aspect.js';
+import type { BulkheadOptions } from './bulkhead-options.js';
+/**
+ * Bounds how many calls run at once, so that one slow dependency cannot take every resource
+ * of the process. A call beyond the bound waits when `maxQueued` allows, otherwise it is
+ * refused with a `BulkheadFullError`.
+ */
+export declare function bulkhead(options: BulkheadOptions): Aspect;
+export declare function bulkheadAdvice(options: BulkheadOptions): AdviceFactory;
+//# sourceMappingURL=bulkhead.d.ts.map

package/dist/bulkhead/bulkhead.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulkhead.d.ts","sourceRoot":"","sources":["../../src/bulkhead/bulkhead.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAGlD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAG7D;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,MAAM,CAEzD;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,eAAe,GAAG,aAAa,CAYtE"}

package/dist/bulkhead/bulkhead.js

@@ -0,0 +1,22 @@
+import { defineAspect } from '../aspect/define-aspect.js';
+import { stateFor } from '../state/state-for.js';
+import { Compartment } from './compartment.js';
+/**
+ * Bounds how many calls run at once, so that one slow dependency cannot take every resource
+ * of the process. A call beyond the bound waits when `maxQueued` allows, otherwise it is
+ * refused with a `BulkheadFullError`.
+ */
+export function bulkhead(options) {
+    return defineAspect(bulkheadAdvice(options));
+}
+export function bulkheadAdvice(options) {
+    if (!Number.isSafeInteger(options.maxConcurrent) || options.maxConcurrent < 1) {
+        throw new RangeError('bulkhead: maxConcurrent is an integer of at least 1');
+    }
+    const compartmentOf = stateFor(options.scope, () => new Compartment(options));
+    return (joinPoint) => {
+        const compartment = compartmentOf(joinPoint);
+        return ({ proceed }) => compartment.run(`${joinPoint.className}.${joinPoint.method}`, proceed);
+    };
+}
+//# sourceMappingURL=bulkhead.js.map

package/dist/bulkhead/bulkhead.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bulkhead.js","sourceRoot":"","sources":["../../src/bulkhead/bulkhead.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,OAAwB;IAC/C,OAAO,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,OAAwB;IACrD,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,OAAO,CAAC,aAAa,GAAG,CAAC,EAAE,CAAC;QAC9E,MAAM,IAAI,UAAU,CAAC,qDAAqD,CAAC,CAAC;IAC9E,CAAC;IAED,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;IAE9E,OAAO,CAAC,SAAS,EAAE,EAAE;QACnB,MAAM,WAAW,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;QAE7C,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,SAAS,IAAI,SAAS,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACjG,CAAC,CAAC;AACJ,CAAC"}

package/dist/bulkhead/compartment.d.ts

@@ -0,0 +1,13 @@
+import type { BulkheadOptions } from './bulkhead-options.js';
+/** The calls one bulkhead lets run at once, and those that wait for a place. */
+export declare class Compartment {
+    private readonly options;
+    private readonly waiting;
+    private running;
+    constructor(options: BulkheadOptions);
+    run(operation: string, proceed: () => Promise<unknown>): Promise<unknown>;
+    private enter;
+    /** A waiting call takes the place as it is: the count of running calls does not move. */
+    private leave;
+}
+//# sourceMappingURL=compartment.d.ts.map

package/dist/bulkhead/compartment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compartment.d.ts","sourceRoot":"","sources":["../../src/bulkhead/compartment.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7D,gFAAgF;AAChF,qBAAa,WAAW;IAKV,OAAO,CAAC,QAAQ,CAAC,OAAO;IAJpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAsB;IAE9C,OAAO,CAAC,OAAO,CAAK;IAEpB,YAA6B,OAAO,EAAE,eAAe,EAAI;IAEnD,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAQ9E;YAEa,KAAK;IAcnB,yFAAyF;IACzF,OAAO,CAAC,KAAK;CASd"}

package/dist/bulkhead/compartment.js

@@ -0,0 +1,40 @@
+import { BulkheadFullError } from '../errors/bulkhead-full-error.js';
+/** The calls one bulkhead lets run at once, and those that wait for a place. */
+export class Compartment {
+    options;
+    waiting = [];
+    running = 0;
+    constructor(options) {
+        this.options = options;
+    }
+    async run(operation, proceed) {
+        await this.enter(operation);
+        try {
+            return await proceed();
+        }
+        finally {
+            this.leave();
+        }
+    }
+    async enter(operation) {
+        if (this.running < this.options.maxConcurrent) {
+            this.running += 1;
+            return;
+        }
+        if (this.waiting.length >= (this.options.maxQueued ?? 0)) {
+            throw new BulkheadFullError(operation);
+        }
+        await new Promise((resolve) => this.waiting.push(resolve));
+    }
+    /** A waiting call takes the place as it is: the count of running calls does not move. */
+    leave() {
+        const next = this.waiting.shift();
+        if (next === undefined) {
+            this.running -= 1;
+        }
+        else {
+            next();
+        }
+    }
+}
+//# sourceMappingURL=compartment.js.map

package/dist/bulkhead/compartment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compartment.js","sourceRoot":"","sources":["../../src/bulkhead/compartment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAGrE,gFAAgF;AAChF,MAAM,OAAO,WAAW;IAKO,OAAO;IAJnB,OAAO,GAAmB,EAAE,CAAC;IAEtC,OAAO,GAAG,CAAC,CAAC;IAEpB,YAA6B,OAAwB;uBAAxB,OAAO;IAAoB,CAAC;IAEzD,KAAK,CAAC,GAAG,CAAC,SAAiB,EAAE,OAA+B;QAC1D,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAE5B,IAAI,CAAC;YACH,OAAO,MAAM,OAAO,EAAE,CAAC;QACzB,CAAC;gBAAS,CAAC;YACT,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,KAAK,CAAC,SAAiB;QACnC,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;YAElB,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,CAAC,EAAE,CAAC;YACzD,MAAM,IAAI,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACzC,CAAC;QAED,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,yFAAyF;IACjF,KAAK;QACX,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QAElC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,IAAI,EAAE,CAAC;QACT,CAAC;IACH,CAAC;CACF"}

package/dist/cached/cached.d.ts

@@ -0,0 +1,26 @@
+import { type Cache } from '@ddd-ts-kit/kernel';
+import type { AdviceFactory } from '../aspect/advice-factory.js';
+import type { AspectKind } from '../aspect/aspect-kind.js';
+import type { Aspect } from '../aspect/aspect.js';
+export interface CachedOptions {
+    /**
+     * The cache key of a call, or `undefined` for a call that is not cached. The only place
+     * arguments are read: build the key from identifiers, never from personal data.
+     */
+    readonly key: (method: string, args: readonly unknown[]) => string | undefined;
+    readonly ttlMs: number;
+    /** Defaults to the cache of the aspect runtime. */
+    readonly cache?: Cache;
+    /** Kinds to wrap although they are refused by default: `repository`, `use-case`. */
+    readonly allowKinds?: readonly AspectKind[];
+}
+/**
+ * Answers a read from the cache when it was made recently. For read methods of gateways and
+ * external adapters: select them with `when(forMethods('find*'), cached(...))`. Refuses to
+ * wrap a repository or a use case unless `allowKinds` says so: an aggregate served from a
+ * cache hides that it is stale. Concurrent identical calls share one underlying call;
+ * failures are not cached; a cache that fails is treated as a miss.
+ */
+export declare function cached(options: CachedOptions): Aspect;
+export declare function cachedAdvice(options: CachedOptions): AdviceFactory;
+//# sourceMappingURL=cached.d.ts.map

package/dist/cached/cached.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cached.d.ts","sourceRoot":"","sources":["../../src/cached/cached.ts"],"names":[],"mappings":"AAAA,OAAO,EAAY,KAAK,KAAK,EAAiB,MAAM,oBAAoB,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAMlD,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,OAAO,EAAE,KAAK,MAAM,GAAG,SAAS,CAAC;IAC/E,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,mDAAmD;IACnD,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,oFAAoF;IACpF,QAAQ,CAAC,UAAU,CAAC,EAAE,SAAS,UAAU,EAAE,CAAC;CAC7C;AAQD;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,MAAM,CAErD;AAED,wBAAgB,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,aAAa,CA2BlE"}

package/dist/cached/cached.js

@@ -0,0 +1,64 @@
+import { cacheKey } from '@ddd-ts-kit/kernel';
+import { defineAspect } from '../aspect/define-aspect.js';
+import { AspectNotAllowedError } from '../errors/aspect-not-allowed-error.js';
+import { cacheOr } from '../runtime/cache-or.js';
+const REFUSED_KINDS = ['repository', 'use-case'];
+/**
+ * Answers a read from the cache when it was made recently. For read methods of gateways and
+ * external adapters: select them with `when(forMethods('find*'), cached(...))`. Refuses to
+ * wrap a repository or a use case unless `allowKinds` says so: an aggregate served from a
+ * cache hides that it is stale. Concurrent identical calls share one underlying call;
+ * failures are not cached; a cache that fails is treated as a miss.
+ */
+export function cached(options) {
+    return defineAspect(cachedAdvice(options));
+}
+export function cachedAdvice(options) {
+    return (joinPoint) => {
+        assertAllowed(joinPoint, options);
+        const inFlight = new Map();
+        return async ({ args, proceed }) => {
+            const id = options.key(joinPoint.method, args);
+            if (id === undefined) {
+                return proceed();
+            }
+            const entry = { cache: cacheOr(options.cache), key: keyOf(joinPoint, id), ttlMs: options.ttlMs };
+            const hit = await read(entry);
+            if (hit !== undefined) {
+                return hit.value;
+            }
+            const pending = inFlight.get(id) ?? loading(entry, proceed).finally(() => inFlight.delete(id));
+            inFlight.set(id, pending);
+            return pending;
+        };
+    };
+}
+function assertAllowed(joinPoint, options) {
+    const { kind } = joinPoint;
+    if (kind === undefined || !REFUSED_KINDS.includes(kind) || options.allowKinds?.includes(kind) === true) {
+        return;
+    }
+    throw new AspectNotAllowedError(`cached refuses to wrap ${joinPoint.className}.${joinPoint.method}, bound as ${kind}: what it would serve may be stale. Select gateways and external adapters with when(forKinds(...)), or pass allowKinds: ['${kind}'] to take the decision.`);
+}
+function keyOf(joinPoint, id) {
+    return cacheKey('aspect', joinPoint.className, joinPoint.method, id);
+}
+async function read({ cache, key }) {
+    try {
+        return await cache.get(key);
+    }
+    catch {
+        return undefined;
+    }
+}
+async function loading({ cache, key, ttlMs }, proceed) {
+    const value = await proceed();
+    try {
+        await cache.set(key, { value }, { ttlMs });
+    }
+    catch {
+        return value;
+    }
+    return value;
+}
+//# sourceMappingURL=cached.js.map

package/dist/cached/cached.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cached.js","sourceRoot":"","sources":["../../src/cached/cached.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAA6B,MAAM,oBAAoB,CAAC;AAIzE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAmBjD,MAAM,aAAa,GAA0B,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,OAAsB;IAC3C,OAAO,YAAY,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,OAAsB;IACjD,OAAO,CAAC,SAAS,EAAE,EAAE;QACnB,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAElC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAA4B,CAAC;QAErD,OAAO,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;YACjC,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YAE/C,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;gBACrB,OAAO,OAAO,EAAE,CAAC;YACnB,CAAC;YAED,MAAM,KAAK,GAAU,EAAE,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;YACxG,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;YAE9B,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACtB,OAAO,GAAG,CAAC,KAAK,CAAC;YACnB,CAAC;YAED,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;YAE/F,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;YAE1B,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,SAAoB,EAAE,OAAsB;IACjE,MAAM,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;IAE3B,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACvG,OAAO;IACT,CAAC;IAED,MAAM,IAAI,qBAAqB,CAC7B,0BAA0B,SAAS,CAAC,SAAS,IAAI,SAAS,CAAC,MAAM,cAAc,IAAI,6HAA6H,IAAI,0BAA0B,CAC/O,CAAC;AACJ,CAAC;AAQD,SAAS,KAAK,CAAC,SAAoB,EAAE,EAAU;IAC7C,OAAO,QAAQ,CAAS,QAAQ,EAAE,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAC/E,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,EAAS;IACvC,IAAI,CAAC;QACH,OAAO,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,KAAK,UAAU,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAS,EAAE,OAA+B;IAClF,MAAM,KAAK,GAAG,MAAM,OAAO,EAAE,CAAC;IAE9B,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/circuit-breaker/circuit-breaker-options.d.ts

@@ -0,0 +1,20 @@
+import type { Clock } from '@ddd-ts-kit/kernel';
+import type { StateScope } from '../state/state-scope.js';
+import type { CircuitStateChange } from './circuit-state-change.js';
+export interface CircuitBreakerOptions {
+    /** Consecutive failures that open the circuit. */
+    readonly failureThreshold: number;
+    /** Time the circuit stays open before a trial call is let through. */
+    readonly resetAfterMs: number;
+    /** Trial calls let through at once while half-open. Default 1. */
+    readonly halfOpenMax?: number;
+    /** Defaults to the clock of the aspect runtime. */
+    readonly clock?: Clock;
+    /** One circuit per method (the default), or one shared by the methods of the instance. */
+    readonly scope?: StateScope;
+    /** Default: everything but a business refusal, which proves the dependency answers. */
+    readonly isFailure?: (error: unknown) => boolean;
+    /** Told every transition: see `circuitStateGauge`. */
+    readonly onStateChange?: (change: CircuitStateChange) => void;
+}
+//# sourceMappingURL=circuit-breaker-options.d.ts.map

package/dist/circuit-breaker/circuit-breaker-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-breaker-options.d.ts","sourceRoot":"","sources":["../../src/circuit-breaker/circuit-breaker-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAEpE,MAAM,WAAW,qBAAqB;IACpC,kDAAkD;IAClD,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,sEAAsE;IACtE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,kEAAkE;IAClE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,mDAAmD;IACnD,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC;IACvB,0FAA0F;IAC1F,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IAC5B,uFAAuF;IACvF,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC;IACjD,sDAAsD;IACtD,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;CAC/D"}

package/dist/circuit-breaker/circuit-breaker-options.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=circuit-breaker-options.js.map

package/dist/circuit-breaker/circuit-breaker-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-breaker-options.js","sourceRoot":"","sources":["../../src/circuit-breaker/circuit-breaker-options.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,11 @@
+import type { AdviceFactory } from '../aspect/advice-factory.js';
+import type { Aspect } from '../aspect/aspect.js';
+import type { CircuitBreakerOptions } from './circuit-breaker-options.js';
+/**
+ * Stops calling a dependency that keeps failing: after `failureThreshold` consecutive failures
+ * the calls are refused with a `CircuitOpenError` for `resetAfterMs`, then a trial call
+ * decides whether the circuit closes again.
+ */
+export declare function circuitBreaker(options: CircuitBreakerOptions): Aspect;
+export declare function circuitBreakerAdvice(options: CircuitBreakerOptions): AdviceFactory;
+//# sourceMappingURL=circuit-breaker.d.ts.map

package/dist/circuit-breaker/circuit-breaker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-breaker.d.ts","sourceRoot":"","sources":["../../src/circuit-breaker/circuit-breaker.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAKlD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAG1E;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,MAAM,CAErE;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,qBAAqB,GAAG,aAAa,CAQlF"}

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

@@ -0,0 +1,27 @@
+import { defineAspect } from '../aspect/define-aspect.js';
+import { clockOr } from '../runtime/clock-or.js';
+import { stateFor } from '../state/state-for.js';
+import { Circuit } from './circuit.js';
+/**
+ * Stops calling a dependency that keeps failing: after `failureThreshold` consecutive failures
+ * the calls are refused with a `CircuitOpenError` for `resetAfterMs`, then a trial call
+ * decides whether the circuit closes again.
+ */
+export function circuitBreaker(options) {
+    return defineAspect(circuitBreakerAdvice(options));
+}
+export function circuitBreakerAdvice(options) {
+    const circuitOf = stateFor(options.scope, (joinPoint) => new Circuit(options, subjectOf(joinPoint, options)));
+    return (joinPoint) => {
+        const circuit = circuitOf(joinPoint);
+        return ({ proceed }) => circuit.run(clockOr(options.clock), proceed);
+    };
+}
+function subjectOf(joinPoint, options) {
+    return {
+        className: joinPoint.className,
+        ...(options.scope === 'instance' ? {} : { method: joinPoint.method }),
+        ...(joinPoint.context === undefined ? {} : { context: joinPoint.context }),
+    };
+}
+//# sourceMappingURL=circuit-breaker.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-breaker.js","sourceRoot":"","sources":["../../src/circuit-breaker/circuit-breaker.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD,OAAO,EAAE,OAAO,EAAuB,MAAM,cAAc,CAAC;AAE5D;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,OAA8B;IAC3D,OAAO,YAAY,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,OAA8B;IACjE,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAE9G,OAAO,CAAC,SAAS,EAAE,EAAE;QACnB,MAAM,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;QAErC,OAAO,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,SAAoB,EAAE,OAA8B;IACrE,OAAO;QACL,SAAS,EAAE,SAAS,CAAC,SAAS;QAC9B,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,EAAE,CAAC;QACrE,GAAG,CAAC,SAAS,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC;KAC3E,CAAC;AACJ,CAAC"}

package/dist/circuit-breaker/circuit-state-change.d.ts

@@ -0,0 +1,10 @@
+import type { CircuitState } from './circuit-state.js';
+export interface CircuitStateChange {
+    readonly className: string;
+    /** Absent when the circuit is shared by the methods of the instance. */
+    readonly method?: string;
+    readonly context?: string;
+    readonly from: CircuitState;
+    readonly to: CircuitState;
+}
+//# sourceMappingURL=circuit-state-change.d.ts.map

package/dist/circuit-breaker/circuit-state-change.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-state-change.d.ts","sourceRoot":"","sources":["../../src/circuit-breaker/circuit-state-change.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,wEAAwE;IACxE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,EAAE,EAAE,YAAY,CAAC;CAC3B"}

package/dist/circuit-breaker/circuit-state-change.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=circuit-state-change.js.map

package/dist/circuit-breaker/circuit-state-change.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-state-change.js","sourceRoot":"","sources":["../../src/circuit-breaker/circuit-state-change.ts"],"names":[],"mappings":""}

package/dist/circuit-breaker/circuit-state-gauge.d.ts

@@ -0,0 +1,8 @@
+import type { Metrics } from '@ddd-ts-kit/kernel';
+import type { CircuitStateChange } from './circuit-state-change.js';
+/**
+ * An `onStateChange` that publishes the state as a gauge: 0 closed, 1 half-open, 2 open,
+ * labelled `class`, `method` and `context`. The metrics default to those of the aspect runtime.
+ */
+export declare function circuitStateGauge(metrics?: Metrics, name?: string): (change: CircuitStateChange) => void;
+//# sourceMappingURL=circuit-state-gauge.d.ts.map

package/dist/circuit-breaker/circuit-state-gauge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-state-gauge.d.ts","sourceRoot":"","sources":["../../src/circuit-breaker/circuit-state-gauge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAKpE;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,CAAC,EAAE,OAAO,EACjB,IAAI,SAA0B,GAC7B,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAMtC"}

package/dist/circuit-breaker/circuit-state-gauge.js

@@ -0,0 +1,14 @@
+import { metricsOr } from '../runtime/metrics-or.js';
+const STATE_VALUES = { closed: 0, 'half-open': 1, open: 2 };
+/**
+ * An `onStateChange` that publishes the state as a gauge: 0 closed, 1 half-open, 2 open,
+ * labelled `class`, `method` and `context`. The metrics default to those of the aspect runtime.
+ */
+export function circuitStateGauge(metrics, name = 'circuit_breaker_state') {
+    return (change) => {
+        metricsOr(metrics)
+            .gauge(name)
+            .set(STATE_VALUES[change.to], { class: change.className, method: change.method, context: change.context });
+    };
+}
+//# sourceMappingURL=circuit-state-gauge.js.map

package/dist/circuit-breaker/circuit-state-gauge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-state-gauge.js","sourceRoot":"","sources":["../../src/circuit-breaker/circuit-state-gauge.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAIrD,MAAM,YAAY,GAA2C,EAAE,MAAM,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;AAEpG;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAiB,EACjB,IAAI,GAAG,uBAAuB;IAE9B,OAAO,CAAC,MAAM,EAAE,EAAE;QAChB,SAAS,CAAC,OAAO,CAAC;aACf,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC/G,CAAC,CAAC;AACJ,CAAC"}

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

@@ -0,0 +1,2 @@
+export type CircuitState = 'closed' | 'open' | 'half-open';
+//# sourceMappingURL=circuit-state.d.ts.map

package/dist/circuit-breaker/circuit-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-state.d.ts","sourceRoot":"","sources":["../../src/circuit-breaker/circuit-state.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=circuit-state.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"circuit-state.js","sourceRoot":"","sources":["../../src/circuit-breaker/circuit-state.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,22 @@
+import type { Clock } from '@ddd-ts-kit/kernel';
+import type { CircuitBreakerOptions } from './circuit-breaker-options.js';
+import type { CircuitStateChange } from './circuit-state-change.js';
+/** What a circuit protects, as its transitions name it. */
+export type CircuitSubject = Omit<CircuitStateChange, 'from' | 'to'>;
+/** The state of one circuit: counts the consecutive failures, refuses while open, lets trial calls through after. */
+export declare class Circuit {
+    private readonly options;
+    private readonly subject;
+    private state;
+    private failures;
+    private openedAt;
+    private trials;
+    constructor(options: CircuitBreakerOptions, subject: CircuitSubject);
+    run(clock: Clock, proceed: () => Promise<unknown>): Promise<unknown>;
+    private admit;
+    private become;
+    private operation;
+    private answered;
+    private failed;
+}
+//# sourceMappingURL=circuit.d.ts.map

package/dist/circuit-breaker/circuit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"circuit.d.ts","sourceRoot":"","sources":["../../src/circuit-breaker/circuit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAIhD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAGpE,2DAA2D;AAC3D,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;AAErE,qHAAqH;AACrH,qBAAa,OAAO;IAUhB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,OAAO;IAV1B,OAAO,CAAC,KAAK,CAA0B;IAEvC,OAAO,CAAC,QAAQ,CAAK;IAErB,OAAO,CAAC,QAAQ,CAAK;IAErB,OAAO,CAAC,MAAM,CAAK;IAEnB,YACmB,OAAO,EAAE,qBAAqB,EAC9B,OAAO,EAAE,cAAc,EACtC;IAEE,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAkBzE;IAED,OAAO,CAAC,KAAK;IAkBb,OAAO,CAAC,MAAM;IAad,OAAO,CAAC,SAAS;IAMjB,OAAO,CAAC,QAAQ;IAQhB,OAAO,CAAC,MAAM;CAYf"}

package/dist/circuit-breaker/circuit.js

@@ -0,0 +1,79 @@
+import { CircuitOpenError } from '../errors/circuit-open-error.js';
+import { isBusinessRefusal } from '../errors/is-business-refusal.js';
+import { safely } from '../observability/safely.js';
+/** The state of one circuit: counts the consecutive failures, refuses while open, lets trial calls through after. */
+export class Circuit {
+    options;
+    subject;
+    state = 'closed';
+    failures = 0;
+    openedAt = 0;
+    trials = 0;
+    constructor(options, subject) {
+        this.options = options;
+        this.subject = subject;
+    }
+    async run(clock, proceed) {
+        this.admit(clock);
+        try {
+            const result = await proceed();
+            this.answered();
+            return result;
+        }
+        catch (error) {
+            if ((this.options.isFailure ?? isFault)(error)) {
+                this.failed(clock);
+            }
+            else {
+                this.answered();
+            }
+            throw error;
+        }
+    }
+    admit(clock) {
+        if (this.state === 'closed') {
+            return;
+        }
+        const retryAt = this.openedAt + this.options.resetAfterMs;
+        if (this.state === 'open' && clock.now().getTime() >= retryAt) {
+            this.become('half-open');
+        }
+        if (this.state === 'open' || this.trials >= (this.options.halfOpenMax ?? 1)) {
+            throw new CircuitOpenError(this.operation(), new Date(retryAt));
+        }
+        this.trials += 1;
+    }
+    become(state) {
+        const change = { ...this.subject, from: this.state, to: state };
+        this.state = state;
+        this.trials = 0;
+        if (state === 'closed') {
+            this.failures = 0;
+        }
+        safely(() => this.options.onStateChange?.(change));
+    }
+    operation() {
+        const { className, method } = this.subject;
+        return method === undefined ? className : `${className}.${method}`;
+    }
+    answered() {
+        this.failures = 0;
+        if (this.state === 'half-open') {
+            this.become('closed');
+        }
+    }
+    failed(clock) {
+        if (this.state === 'open') {
+            return;
+        }
+        this.failures += 1;
+        if (this.state === 'half-open' || this.failures >= this.options.failureThreshold) {
+            this.openedAt = clock.now().getTime();
+            this.become('open');
+        }
+    }
+}
+function isFault(error) {
+    return !isBusinessRefusal(error);
+}
+//# sourceMappingURL=circuit.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"circuit.js","sourceRoot":"","sources":["../../src/circuit-breaker/circuit.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAQpD,qHAAqH;AACrH,MAAM,OAAO,OAAO;IAUC,OAAO;IACP,OAAO;IAVlB,KAAK,GAAiB,QAAQ,CAAC;IAE/B,QAAQ,GAAG,CAAC,CAAC;IAEb,QAAQ,GAAG,CAAC,CAAC;IAEb,MAAM,GAAG,CAAC,CAAC;IAEnB,YACmB,OAA8B,EAC9B,OAAuB;uBADvB,OAAO;uBACP,OAAO;IACvB,CAAC;IAEJ,KAAK,CAAC,GAAG,CAAC,KAAY,EAAE,OAA+B;QACrD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAElB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,EAAE,CAAC;YAE/B,IAAI,CAAC,QAAQ,EAAE,CAAC;YAEhB,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACrB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,CAAC;YAED,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,KAAY;QACxB,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC;QAE1D,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,IAAI,OAAO,EAAE,CAAC;YAC9D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,CAAC,CAAC,EAAE,CAAC;YAC5E,MAAM,IAAI,gBAAgB,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;IACnB,CAAC;IAEO,MAAM,CAAC,KAAmB;QAChC,MAAM,MAAM,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;QAEhE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAEhB,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QACpB,CAAC;QAED,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IACrD,CAAC;IAEO,SAAS;QACf,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAE3C,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,MAAM,EAAE,CAAC;IACrE,CAAC;IAEO,QAAQ;QACd,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAElB,IAAI,IAAI,CAAC,KAAK,KAAK,WAAW,EAAE,CAAC;YAC/B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,KAAY;QACzB,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;QAEnB,IAAI,IAAI,CAAC,KAAK,KAAK,WAAW,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YACjF,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACtB,CAAC;IACH,CAAC;CACF;AAED,SAAS,OAAO,CAAC,KAAc;IAC7B,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;AACnC,CAAC"}