@adviser/cement 0.4.59 → 0.4.61

package/esm/timeouted.d.ts

@@ -0,0 +1,45 @@
+export interface PurTimeoutResultSuccess<T> {
+    readonly state: "success";
+    readonly value: T;
+}
+export interface PurTimeoutResultTimeout {
+    readonly state: "timeout";
+}
+export interface PurTimeoutResultAborted {
+    readonly state: "aborted";
+    readonly reason: unknown;
+}
+export interface PurTimeoutResultError {
+    readonly state: "error";
+    readonly error: Error;
+}
+export interface TimeoutState<CTX> {
+    readonly duration: number;
+    readonly ctx: CTX;
+}
+export type TimeoutResultSuccess<T, CTX = unknown> = PurTimeoutResultSuccess<T> & TimeoutState<CTX>;
+export type TimeoutResultTimeout<CTX = unknown> = PurTimeoutResultTimeout & TimeoutState<CTX>;
+export type TimeoutResultAborted<CTX = unknown> = PurTimeoutResultAborted & TimeoutState<CTX>;
+export type TimeoutResultError<CTX = unknown> = PurTimeoutResultError & TimeoutState<CTX>;
+export type TimeoutResult<T, CTX = unknown> = TimeoutResultSuccess<T, CTX> | TimeoutResultTimeout<CTX> | TimeoutResultAborted<CTX> | TimeoutResultError<CTX>;
+export type ActionFunc<T> = (controller: AbortController) => Promise<T>;
+export type ActionItem<T> = ActionFunc<T> | Promise<T>;
+export type TimeoutAction<T> = ActionItem<T>;
+export interface TimeoutActionOptions<CTX> {
+    readonly timeout: number;
+    readonly signal: AbortSignal;
+    readonly controller: AbortController;
+    readonly ctx: CTX;
+    onTimeout: () => void;
+    onAbort: (reason: unknown) => void;
+    onError: (error: Error) => void;
+    onAbortAction: (reason: unknown) => void;
+}
+export declare function isSuccess<T>(result: TimeoutResult<T>): result is TimeoutResultSuccess<T>;
+export declare function isTimeout<T>(result: TimeoutResult<T>): result is TimeoutResultTimeout<T>;
+export declare function isAborted<T>(result: TimeoutResult<T>): result is TimeoutResultAborted<T>;
+export declare function isError<T>(result: TimeoutResult<T>): result is TimeoutResultError<T>;
+export declare function unwrap<T>(result: TimeoutResult<T>): T;
+export declare function unwrapOr<T>(result: TimeoutResult<T>, defaultValue: T): T;
+export declare function timeouted<T, CTX = void>(action: TimeoutAction<T>, options?: Partial<TimeoutActionOptions<CTX>>): Promise<TimeoutResult<T>>;
+//# sourceMappingURL=timeouted.d.ts.map

package/esm/timeouted.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeouted.d.ts","sourceRoot":"","sources":["../../../src/timeouted.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,uBAAuB,CAAC,CAAC;IACxC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC3B;AACD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AACD,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;CACvB;AAED,MAAM,WAAW,YAAY,CAAC,GAAG;IAC/B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;CACnB;AAID,MAAM,MAAM,oBAAoB,CAAC,CAAC,EAAE,GAAG,GAAG,OAAO,IAAI,uBAAuB,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;AACpG,MAAM,MAAM,oBAAoB,CAAC,GAAG,GAAG,OAAO,IAAI,uBAAuB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;AAC9F,MAAM,MAAM,oBAAoB,CAAC,GAAG,GAAG,OAAO,IAAI,uBAAuB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;AAC9F,MAAM,MAAM,kBAAkB,CAAC,GAAG,GAAG,OAAO,IAAI,qBAAqB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;AAE1F,MAAM,MAAM,aAAa,CAAC,CAAC,EAAE,GAAG,GAAG,OAAO,IACtC,oBAAoB,CAAC,CAAC,EAAE,GAAG,CAAC,GAC5B,oBAAoB,CAAC,GAAG,CAAC,GACzB,oBAAoB,CAAC,GAAG,CAAC,GACzB,kBAAkB,CAAC,GAAG,CAAC,CAAC;AAE5B,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;AAGxE,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAGvD,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;AAG7C,MAAM,WAAW,oBAAoB,CAAC,GAAG;IACvC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,UAAU,EAAE,eAAe,CAAC;IACrC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAClB,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB,OAAO,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IAChC,aAAa,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAC;CAC1C;AAMD,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAExF;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAExF;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAExF;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,kBAAkB,CAAC,CAAC,CAAC,CAEpF;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAKrD;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAExE;AAED,wBAAsB,SAAS,CAAC,CAAC,EAAE,GAAG,GAAG,IAAI,EAC3C,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,EACxB,OAAO,GAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAM,GAC/C,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CA4F3B"}

package/esm/timeouted.js

@@ -0,0 +1,110 @@
+import { Future } from "./future.js";
+import { isPromise } from "./is-promise.js";
+import { sleep } from "./utils/promise-sleep.js";
+export function isSuccess(result) {
+    return result.state === "success";
+}
+export function isTimeout(result) {
+    return result.state === "timeout";
+}
+export function isAborted(result) {
+    return result.state === "aborted";
+}
+export function isError(result) {
+    return result.state === "error";
+}
+export function unwrap(result) {
+    if (isSuccess(result)) {
+        return result.value;
+    }
+    throw new Error(`TimeoutResult is not success: ${result.state}`);
+}
+export function unwrapOr(result, defaultValue) {
+    return isSuccess(result) ? result.value : defaultValue;
+}
+export async function timeouted(action, options = {}) {
+    const { timeout = 30000, signal, controller: externalController, ctx, onTimeout, onAbort, onError, onAbortAction } = options;
+    const controller = externalController || new AbortController();
+    const startTime = Date.now();
+    const toRemoveEventListeners = [];
+    if (signal) {
+        function abortAction() {
+            controller.abort(signal?.reason);
+        }
+        toRemoveEventListeners.push(() => {
+            signal?.removeEventListener("abort", abortAction);
+        });
+        signal.addEventListener("abort", abortAction);
+    }
+    function cleanup(result, skipCleanupAction = false) {
+        for (const evtFn of toRemoveEventListeners) {
+            evtFn();
+        }
+        toRemoveEventListeners.length = 0;
+        if (!skipCleanupAction) {
+            void onAbortAction?.(signal?.reason);
+            controller.abort(new Error("Timeouted Abort Action"));
+        }
+        return {
+            ...result,
+            duration: Date.now() - startTime,
+            ctx: ctx,
+        };
+    }
+    let toAwait;
+    if (isPromise(action)) {
+        toAwait = action;
+    }
+    else {
+        try {
+            toAwait = action(controller);
+        }
+        catch (error) {
+            return cleanup({
+                state: "error",
+                error: error instanceof Error ? error : new Error(error),
+            });
+        }
+    }
+    const abortToAwait = new Future();
+    function onAbortHandler() {
+        abortToAwait.resolve({ state: "aborted", reason: controller.signal.reason });
+    }
+    controller.signal.addEventListener("abort", onAbortHandler);
+    toRemoveEventListeners.push(() => {
+        controller.signal.removeEventListener("abort", onAbortHandler);
+    });
+    const toRace = [
+        toAwait.then((value) => ({ state: "success", value })).catch((error) => ({ state: "error", error })),
+        abortToAwait.asPromise(),
+    ];
+    if (timeout > 0) {
+        toRace.push(sleep(timeout, controller.signal).then((r) => {
+            switch (true) {
+                case r.isOk:
+                    return { state: "timeout" };
+                case r.isErr:
+                    return { state: "error", error: r.error };
+                case r.isAborted:
+                    return { state: "aborted", reason: r.reason };
+            }
+            throw new Error("Unreachable code in timeoutAction");
+        }));
+    }
+    const res = await Promise.race(toRace);
+    switch (true) {
+        case res.state === "success":
+            return cleanup(res, true);
+        case res.state === "aborted":
+            onAbort?.(res.reason);
+            return cleanup(res);
+        case res.state === "error":
+            onError?.(res.error);
+            return cleanup(res);
+        case res.state === "timeout":
+            onTimeout?.();
+            return cleanup(res);
+    }
+    throw new Error("Unreachable code in timeoutAction");
+}
+//# sourceMappingURL=timeouted.js.map

package/esm/timeouted.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeouted.js","sourceRoot":"","sources":["../../../src/timeouted.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AA6DjD,MAAM,UAAU,SAAS,CAAI,MAAwB,EAAqC;IACxF,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC;AAAA,CACnC;AAED,MAAM,UAAU,SAAS,CAAI,MAAwB,EAAqC;IACxF,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC;AAAA,CACnC;AAED,MAAM,UAAU,SAAS,CAAI,MAAwB,EAAqC;IACxF,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC;AAAA,CACnC;AAED,MAAM,UAAU,OAAO,CAAI,MAAwB,EAAmC;IACpF,OAAO,MAAM,CAAC,KAAK,KAAK,OAAO,CAAC;AAAA,CACjC;AAED,MAAM,UAAU,MAAM,CAAI,MAAwB,EAAK;IACrD,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,iCAAiC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;AAAA,CAClE;AAED,MAAM,UAAU,QAAQ,CAAI,MAAwB,EAAE,YAAe,EAAK;IACxE,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC;AAAA,CACxD;AAED,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,MAAwB,EACxB,OAAO,GAAuC,EAAE,EACrB;IAC3B,MAAM,EAAE,OAAO,GAAG,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC;IAE7H,MAAM,UAAU,GAAG,kBAAkB,IAAI,IAAI,eAAe,EAAE,CAAC;IAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAE7B,MAAM,sBAAsB,GAAmB,EAAE,CAAC;IAGlD,IAAI,MAAM,EAAE,CAAC;QACX,SAAS,WAAW,GAAS;YAC3B,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAA,CAClC;QACD,sBAAsB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YAChC,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAAA,CACnD,CAAC,CAAC;QACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAChD,CAAC;IACD,SAAS,OAAO,CAAgC,MAAS,EAAE,iBAAiB,GAAG,KAAK,EAAyB;QAC3G,KAAK,MAAM,KAAK,IAAI,sBAAsB,EAAE,CAAC;YAC3C,KAAK,EAAE,CAAC;QACV,CAAC;QACD,sBAAsB,CAAC,MAAM,GAAG,CAAC,CAAC;QAClC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,KAAK,aAAa,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACrC,UAAU,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC;QACxD,CAAC;QACD,OAAO;YACL,GAAG,MAAM;YACT,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;YAChC,GAAG,EAAE,GAAU;SACS,CAAC;IAAA,CAC5B;IAED,IAAI,OAAmB,CAAC;IACxB,IAAI,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,OAAO,GAAG,MAAM,CAAC;IACnB,CAAC;SAAM,CAAC;QACN,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,OAAO,CAAC;gBACb,KAAK,EAAE,OAAO;gBACd,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,KAAe,CAAC;aACnE,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,MAAM,EAA2B,CAAC;IAC3D,SAAS,cAAc,GAAS;QAC9B,YAAY,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAkB,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,MAAiB,EAAE,CAAC,CAAC;IAAA,CAClG;IACD,UAAU,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IAC5D,sBAAsB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAChC,UAAU,CAAC,MAAM,CAAC,mBAAmB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IAAA,CAChE,CAAC,CAAC;IAEH,MAAM,MAAM,GAAmC;QAC7C,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,SAAkB,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,OAAgB,EAAE,KAAK,EAAE,CAAC,CAAC;QAC7H,YAAY,CAAC,SAAS,EAAE;KACzB,CAAC;IACF,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;QAChB,MAAM,CAAC,IAAI,CACT,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAuB,EAAE,CAAC;YACjE,QAAQ,IAAI,EAAE,CAAC;gBACb,KAAK,CAAC,CAAC,IAAI;oBACT,OAAO,EAAE,KAAK,EAAE,SAAkB,EAAE,CAAC;gBACvC,KAAK,CAAC,CAAC,KAAK;oBACV,OAAO,EAAE,KAAK,EAAE,OAAgB,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;gBACrD,KAAK,CAAC,CAAC,SAAS;oBACd,OAAO,EAAE,KAAK,EAAE,SAAkB,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YAC3D,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAAA,CACtD,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,GAAG,CAAC,KAAK,KAAK,SAAS;YAC1B,OAAO,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAC5B,KAAK,GAAG,CAAC,KAAK,KAAK,SAAS;YAC1B,OAAO,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACtB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;QACtB,KAAK,GAAG,CAAC,KAAK,KAAK,OAAO;YACxB,OAAO,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;QACtB,KAAK,GAAG,CAAC,KAAK,KAAK,SAAS;YAC1B,SAAS,EAAE,EAAE,CAAC;YACd,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;IACxB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;AAAA,CACtD"}

package/esm/timeouted.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=timeouted.test.d.ts.map

package/esm/timeouted.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeouted.test.d.ts","sourceRoot":"","sources":["../../../src/timeouted.test.ts"],"names":[],"mappings":""}