@daiso-tech/core 0.37.3 → 0.38.0

package/dist/async/middlewares/observe/_module.js

@@ -1,2 +1,3 @@
 export * from "../../../async/middlewares/observe/observe.middleware.js";
+export * from "../../../async/middlewares/observe/observe.types.js";
 //# sourceMappingURL=_module.js.map

package/dist/async/middlewares/observe/_module.js.map

@@ -1 +1 @@
-{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/async/middlewares/observe/_module.ts"],"names":[],"mappings":"AAAA,cAAc,mDAAmD,CAAC"}
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/async/middlewares/observe/_module.ts"],"names":[],"mappings":"AAAA,cAAc,mDAAmD,CAAC;AAClE,cAAc,8CAA8C,CAAC"}

package/dist/async/middlewares/observe/observe.middleware.d.ts

@@ -1,93 +1,9 @@
 /**
  * @module Async
  */
-import { TimeSpan, type HookContext } from "../../../utilities/_module-exports.js";
-import { type AsyncMiddlewareFn, type Invokable } from "../../../utilities/_module-exports.js";
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnObserveStartData<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = {
-    args: TParameters;
-    context: TContext;
-};
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnObserveStart<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = Invokable<[data: OnObserveStartData<TParameters, TContext>]>;
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnObserveSuccessData<TParameters extends unknown[] = unknown[], TReturn = unknown, TContext extends HookContext = HookContext> = {
-    returnValue: TReturn;
-    args: TParameters;
-    context: TContext;
-};
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnObserveSuccess<TParameters extends unknown[] = unknown[], TReturn = unknown, TContext extends HookContext = HookContext> = Invokable<[data: OnObserveSuccessData<TParameters, TReturn, TContext>]>;
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnObserveErrorData<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = {
-    error: unknown;
-    args: TParameters;
-    context: TContext;
-};
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnObserveFinallyData<TContext extends HookContext = HookContext> = {
-    executionTime: TimeSpan;
-    context: TContext;
-};
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnObserveError<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = Invokable<[data: OnObserveErrorData<TParameters, TContext>]>;
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnObserveFinally<TContext extends HookContext = HookContext> = Invokable<[data: OnObserveFinallyData<TContext>]>;
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type ObserveCallbacks<TParameters extends unknown[] = unknown[], TReturn = unknown, TContext extends HookContext = HookContext> = {
-    /**
-     * Callback {@link Invokable | `Invokable`} that will be called when before the underlying {@link Invokable | `Invokable`} is called.
-     */
-    onStart?: OnObserveStart<TParameters, TContext>;
-    /**
-     * Callback {@link Invokable | `Invokable`} that will be called when the underlying {@link Invokable | `Invokable`} is successfully called.
-     */
-    onSuccess?: OnObserveSuccess<TParameters, TReturn, TContext>;
-    /**
-     * Callback {@link Invokable | `Invokable`} that will be called when the underlying {@link Invokable | `Invokable`} throws an error.
-     */
-    onError?: OnObserveError<TParameters, TContext>;
-    /**
-     * Callback {@link Invokable | `Invokable`} that will be called when the underlying {@link Invokable | `Invokable`} throws an error or is successfully called.
-     */
-    onFinally?: OnObserveFinally<TContext>;
-};
+import { type HookContext } from "../../../utilities/_module-exports.js";
+import { type AsyncMiddlewareFn } from "../../../utilities/_module-exports.js";
+import type { ObserveCallbacks } from "../../../async/middlewares/observe/observe.types.js";
 /**
  * The `observe` middleware tracks an async function's state and runs callbacks when it fails with an error or succeeds.
  *
@@ -126,5 +42,39 @@ export type ObserveCallbacks<TParameters extends unknown[] = unknown[], TReturn
  * // Will log if the function errored, arguments and the error.
  * // Will log the execution time and arguments
  * ```
+ *
+ * The middleware works also when the function returns a {@link Result | `Result`} type.
+ * @example
+ * ```ts
+ * import { observe, LazyPromise } from "@daiso-tech/core/async";
+ * import { AsyncHooks, TimeSpan, Result, resultFailure, resultSuccess } from "@daiso-tech/core/utilities";
+ *
+ * await new AsyncHooks(
+ *   // Lets pretend this function can throw and takes time to execute.
+ *   async (a: number, b: number): Promise<Result<number, Error>> => {
+ *      const shouldThrow1 = Math.round(Math.random() * 100);
+ *      if (shouldThrow1 > 50) {
+ *        return resultFailure(new Error("Unexpected error occured"));
+ *      }
+ *      await LazyPromise.delay(TimeSpan.fromMilliseconds(Math.random() * 1000));
+ *      const shouldThrow2 = Math.round(Math.random() * 100);
+ *      if (shouldThrow2 > 50) {
+ *        return resultFailure(new Error("Unexpected error occured"));
+ *      }
+ *      return resultSuccess(a / b);
+ *   },
+ *   observe({
+ *     onStart: (data) => console.log("START:", data),
+ *     onSuccess: (data) => console.log("SUCCESS:", data),
+ *     onError: (data) => console.error("ERROR:", data),
+ *     onFinally: (data) => console.log("FINALLY:", data),
+ *   })
+ * )
+ * .invoke(20, 10);
+ * // Will log when the function execution has started and the arguments.
+ * // Will log if the function succeded, the arguments and the return value.
+ * // Will log if the function errored, arguments and the error.
+ * // Will log the execution time and arguments
+ * ```
  */
 export declare function observe<TParameters extends unknown[], TReturn, TContext extends HookContext>(settings: NoInfer<ObserveCallbacks<TParameters, TReturn, TContext>>): AsyncMiddlewareFn<TParameters, TReturn, TContext>;

package/dist/async/middlewares/observe/observe.middleware.js

@@ -1,7 +1,7 @@
 /**
  * @module Async
  */
-import { TimeSpan } from "../../../utilities/_module-exports.js";
+import { isResult, RESULT, TimeSpan, } from "../../../utilities/_module-exports.js";
 import { callInvokable, } from "../../../utilities/_module-exports.js";
 /**
  * The `observe` middleware tracks an async function's state and runs callbacks when it fails with an error or succeeds.
@@ -41,6 +41,40 @@ import { callInvokable, } from "../../../utilities/_module-exports.js";
  * // Will log if the function errored, arguments and the error.
  * // Will log the execution time and arguments
  * ```
+ *
+ * The middleware works also when the function returns a {@link Result | `Result`} type.
+ * @example
+ * ```ts
+ * import { observe, LazyPromise } from "@daiso-tech/core/async";
+ * import { AsyncHooks, TimeSpan, Result, resultFailure, resultSuccess } from "@daiso-tech/core/utilities";
+ *
+ * await new AsyncHooks(
+ *   // Lets pretend this function can throw and takes time to execute.
+ *   async (a: number, b: number): Promise<Result<number, Error>> => {
+ *      const shouldThrow1 = Math.round(Math.random() * 100);
+ *      if (shouldThrow1 > 50) {
+ *        return resultFailure(new Error("Unexpected error occured"));
+ *      }
+ *      await LazyPromise.delay(TimeSpan.fromMilliseconds(Math.random() * 1000));
+ *      const shouldThrow2 = Math.round(Math.random() * 100);
+ *      if (shouldThrow2 > 50) {
+ *        return resultFailure(new Error("Unexpected error occured"));
+ *      }
+ *      return resultSuccess(a / b);
+ *   },
+ *   observe({
+ *     onStart: (data) => console.log("START:", data),
+ *     onSuccess: (data) => console.log("SUCCESS:", data),
+ *     onError: (data) => console.error("ERROR:", data),
+ *     onFinally: (data) => console.log("FINALLY:", data),
+ *   })
+ * )
+ * .invoke(20, 10);
+ * // Will log when the function execution has started and the arguments.
+ * // Will log if the function succeded, the arguments and the return value.
+ * // Will log if the function errored, arguments and the error.
+ * // Will log the execution time and arguments
+ * ```
  */
 export function observe(settings) {
     const { onStart = () => { }, onSuccess = () => { }, onError = () => { }, onFinally = () => { }, } = settings;
@@ -52,10 +86,27 @@ export function observe(settings) {
                 context,
             });
             const returnValue = await next(...args);
+            // Should handle when Result type is returned
+            if (isResult(returnValue)) {
+                if (returnValue.type === RESULT.SUCCESS) {
+                    callInvokable(onSuccess, {
+                        args,
+                        context,
+                        returnValue: returnValue.value,
+                    });
+                    return returnValue;
+                }
+                callInvokable(onError, {
+                    args,
+                    context,
+                    error: returnValue.error,
+                });
+                return returnValue;
+            }
             callInvokable(onSuccess, {
                 args,
                 context,
-                returnValue,
+                returnValue: returnValue,
             });
             return returnValue;
         }

package/dist/async/middlewares/observe/observe.middleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"observe.middleware.js","sourceRoot":"","sources":["../../../../src/async/middlewares/observe/observe.middleware.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAoB,MAAM,gCAAgC,CAAC;AAC5E,OAAO,EACH,aAAa,GAGhB,MAAM,gCAAgC,CAAC;AA4HxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,UAAU,OAAO,CAKnB,QAAmE;IAEnE,MAAM,EACF,OAAO,GAAG,GAAG,EAAE,GAAE,CAAC,EAClB,SAAS,GAAG,GAAG,EAAE,GAAE,CAAC,EACpB,OAAO,GAAG,GAAG,EAAE,GAAE,CAAC,EAClB,SAAS,GAAG,GAAG,EAAE,GAAE,CAAC,GACvB,GAAG,QAAQ,CAAC;IACb,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACrC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAChC,IAAI,CAAC;YACD,aAAa,CAAC,OAAO,EAAE;gBACnB,IAAI;gBACJ,OAAO;aACV,CAAC,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;YACxC,aAAa,CAAC,SAAS,EAAE;gBACrB,IAAI;gBACJ,OAAO;gBACP,WAAW;aACd,CAAC,CAAC;YACH,OAAO,WAAW,CAAC;QACvB,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,aAAa,CAAC,OAAO,EAAE;gBACnB,IAAI;gBACJ,OAAO;gBACP,KAAK;aACR,CAAC,CAAC;YACH,MAAM,KAAK,CAAC;QAChB,CAAC;gBAAS,CAAC;YACP,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAC9B,MAAM,IAAI,GAAG,GAAG,GAAG,KAAK,CAAC;YACzB,aAAa,CAAC,SAAS,EAAE;gBACrB,OAAO;gBACP,aAAa,EAAE,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC;aACjD,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC;AACN,CAAC"}
+{"version":3,"file":"observe.middleware.js","sourceRoot":"","sources":["../../../../src/async/middlewares/observe/observe.middleware.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACH,QAAQ,EACR,MAAM,EACN,QAAQ,GAGX,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACH,aAAa,GAEhB,MAAM,gCAAgC,CAAC;AAGxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH,MAAM,UAAU,OAAO,CAKnB,QAAmE;IAEnE,MAAM,EACF,OAAO,GAAG,GAAG,EAAE,GAAE,CAAC,EAClB,SAAS,GAAG,GAAG,EAAE,GAAE,CAAC,EACpB,OAAO,GAAG,GAAG,EAAE,GAAE,CAAC,EAClB,SAAS,GAAG,GAAG,EAAE,GAAE,CAAC,GACvB,GAAG,QAAQ,CAAC;IACb,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;QACrC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAChC,IAAI,CAAC;YACD,aAAa,CAAC,OAAO,EAAE;gBACnB,IAAI;gBACJ,OAAO;aACV,CAAC,CAAC;YACH,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;YAExC,6CAA6C;YAC7C,IAAI,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;gBACxB,IAAI,WAAW,CAAC,IAAI,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC;oBACtC,aAAa,CAAC,SAAS,EAAE;wBACrB,IAAI;wBACJ,OAAO;wBACP,WAAW,EACP,WAAW,CAAC,KAAoC;qBACvD,CAAC,CAAC;oBACH,OAAO,WAAW,CAAC;gBACvB,CAAC;gBAED,aAAa,CAAC,OAAO,EAAE;oBACnB,IAAI;oBACJ,OAAO;oBACP,KAAK,EAAE,WAAW,CAAC,KAAK;iBAC3B,CAAC,CAAC;gBACH,OAAO,WAAW,CAAC;YACvB,CAAC;YAED,aAAa,CAAC,SAAS,EAAE;gBACrB,IAAI;gBACJ,OAAO;gBACP,WAAW,EAAE,WAA0C;aAC1D,CAAC,CAAC;YACH,OAAO,WAAW,CAAC;QACvB,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACtB,aAAa,CAAC,OAAO,EAAE;gBACnB,IAAI;gBACJ,OAAO;gBACP,KAAK;aACR,CAAC,CAAC;YACH,MAAM,KAAK,CAAC;QAChB,CAAC;gBAAS,CAAC;YACP,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAC9B,MAAM,IAAI,GAAG,GAAG,GAAG,KAAK,CAAC;YACzB,aAAa,CAAC,SAAS,EAAE;gBACrB,OAAO;gBACP,aAAa,EAAE,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC;aACjD,CAAC,CAAC;QACP,CAAC;IACL,CAAC,CAAC;AACN,CAAC"}

package/dist/async/middlewares/observe/observe.types.d.ts

@@ -0,0 +1,91 @@
+/**
+ * @module Async
+ */
+import type { InferResultSuccess, TimeSpan } from "../../../utilities/_module-exports.js";
+import { type HookContext } from "../../../utilities/_module-exports.js";
+import { type Invokable } from "../../../utilities/_module-exports.js";
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/async"`
+ * @group Middlewares
+ */
+export type OnObserveStartData<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = {
+    args: TParameters;
+    context: TContext;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/async"`
+ * @group Middlewares
+ */
+export type OnObserveStart<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = Invokable<[data: OnObserveStartData<TParameters, TContext>]>;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/async"`
+ * @group Middlewares
+ */
+export type OnObserveSuccessData<TParameters extends unknown[] = unknown[], TReturn = unknown, TContext extends HookContext = HookContext> = {
+    returnValue: InferResultSuccess<TReturn>;
+    args: TParameters;
+    context: TContext;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/async"`
+ * @group Middlewares
+ */
+export type OnObserveSuccess<TParameters extends unknown[] = unknown[], TReturn = unknown, TContext extends HookContext = HookContext> = Invokable<[data: OnObserveSuccessData<TParameters, TReturn, TContext>]>;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/async"`
+ * @group Middlewares
+ */
+export type OnObserveErrorData<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = {
+    error: unknown;
+    args: TParameters;
+    context: TContext;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/async"`
+ * @group Middlewares
+ */
+export type OnObserveFinallyData<TContext extends HookContext = HookContext> = {
+    executionTime: TimeSpan;
+    context: TContext;
+};
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/async"`
+ * @group Middlewares
+ */
+export type OnObserveError<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = Invokable<[data: OnObserveErrorData<TParameters, TContext>]>;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/async"`
+ * @group Middlewares
+ */
+export type OnObserveFinally<TContext extends HookContext = HookContext> = Invokable<[data: OnObserveFinallyData<TContext>]>;
+/**
+ *
+ * IMPORT_PATH: `"@daiso-tech/core/async"`
+ * @group Middlewares
+ */
+export type ObserveCallbacks<TParameters extends unknown[] = unknown[], TReturn = unknown, TContext extends HookContext = HookContext> = {
+    /**
+     * Callback {@link Invokable | `Invokable`} that will be called when before the underlying {@link Invokable | `Invokable`} is called.
+     */
+    onStart?: OnObserveStart<TParameters, TContext>;
+    /**
+     * Callback {@link Invokable | `Invokable`} that will be called when the underlying {@link Invokable | `Invokable`} is successfully called.
+     */
+    onSuccess?: OnObserveSuccess<TParameters, TReturn, TContext>;
+    /**
+     * Callback {@link Invokable | `Invokable`} that will be called when the underlying {@link Invokable | `Invokable`} throws an error.
+     */
+    onError?: OnObserveError<TParameters, TContext>;
+    /**
+     * Callback {@link Invokable | `Invokable`} that will be called when the underlying {@link Invokable | `Invokable`} throws an error or is successfully called.
+     */
+    onFinally?: OnObserveFinally<TContext>;
+};

package/dist/async/middlewares/observe/observe.types.js

@@ -0,0 +1,6 @@
+/**
+ * @module Async
+ */
+import {} from "../../../utilities/_module-exports.js";
+import {} from "../../../utilities/_module-exports.js";
+//# sourceMappingURL=observe.types.js.map

package/dist/async/middlewares/observe/observe.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"observe.types.js","sourceRoot":"","sources":["../../../../src/async/middlewares/observe/observe.types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH,OAAO,EAAoB,MAAM,gCAAgC,CAAC;AAClE,OAAO,EAAkB,MAAM,gCAAgC,CAAC"}

package/dist/async/middlewares/retry/_module.d.ts

@@ -1 +1,2 @@
 export * from "../../../async/middlewares/retry/retry.middleware.js";
+export * from "../../../async/middlewares/retry/retry.types.js";

package/dist/async/middlewares/retry/_module.js

@@ -1,2 +1,3 @@
 export * from "../../../async/middlewares/retry/retry.middleware.js";
+export * from "../../../async/middlewares/retry/retry.types.js";
 //# sourceMappingURL=_module.js.map

package/dist/async/middlewares/retry/_module.js.map

@@ -1 +1 @@
-{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/async/middlewares/retry/_module.ts"],"names":[],"mappings":"AAAA,cAAc,+CAA+C,CAAC"}
+{"version":3,"file":"_module.js","sourceRoot":"","sources":["../../../../src/async/middlewares/retry/_module.ts"],"names":[],"mappings":"AAAA,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0CAA0C,CAAC"}

package/dist/async/middlewares/retry/retry.middleware.d.ts

@@ -1,96 +1,14 @@
 /**
  * @module Async
  */
-import type { TimeSpan } from "../../../utilities/_module-exports.js";
-import { type Invokable, type HookContext, type AsyncMiddlewareFn } from "../../../utilities/_module-exports.js";
-import { type BackoffPolicy } from "../../../async/backof-policies/_module.js";
-import { type ErrorPolicy } from "../../../async/middlewares/_shared.js";
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnRetryAttemptData<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = {
-    attempt: number;
-    args: TParameters;
-    context: TContext;
-};
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnRetryAttempt<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = Invokable<[data: OnRetryAttemptData<TParameters, TContext>]>;
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnRetryDelayData<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = {
-    error: unknown;
-    attempt: number;
-    waitTime: TimeSpan;
-    args: TParameters;
-    context: TContext;
-};
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type OnRetryDelay<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = Invokable<[data: OnRetryDelayData<TParameters, TContext>]>;
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type RetryCallbacks<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = {
-    /**
-     * Callback {@link Invokable | `Invokable`} that will be called before execution attempt.
-     */
-    onExecutionAttempt?: OnRetryAttempt<TParameters, TContext>;
-    /**
-     * Callback {@link Invokable | `Invokable`} that will be called before the retry delay starts.
-     */
-    onRetryDelay?: OnRetryDelay<TParameters, TContext>;
-};
-/**
- *
- * IMPORT_PATH: `"@daiso-tech/core/async"`
- * @group Middlewares
- */
-export type RetrySettings<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = RetryCallbacks<TParameters, TContext> & {
-    /**
-     * You can decide maximal times you can retry.
-     * @default {4}
-     */
-    maxAttempts?: number;
-    /**
-     * @default
-     * ```ts
-     * import { exponentialBackoffPolicy } from "@daiso-tech/core/async";
-     *
-     * exponentialBackoffPolicy();
-     * ```
-     */
-    backoffPolicy?: BackoffPolicy;
-    /**
-     * You can choose what errors you want to retry. By default all erros will be retried.
-     *
-     * @default
-     * ```ts
-     * (_error: unknown) => true
-     * ```
-     */
-    errorPolicy?: ErrorPolicy;
-};
+import { type HookContext, type AsyncMiddlewareFn } from "../../../utilities/_module-exports.js";
+import type { RetrySettings } from "../../../async/middlewares/retry/retry.types.js";
 /**
  * The `retry` middleware enables automatic retries for all errors or specific errors, with configurable backoff policies.
  * An error will be thrown when all retry attempts fail.
  *
  * IMPORT_PATH: `"@daiso-tech/core/async"`
  * @group Middleware
- * @throws {RetryAsyncError} {@link RetryAsyncError}
  *
  * @example
  * ```ts
@@ -100,7 +18,39 @@ export type RetrySettings<TParameters extends unknown[] = unknown[], TContext ex
  * const data = await new AsyncHooks(
  *   async (url: string, signal?: AbortSignal): Promise<unknown> => {
  *     const response = await fetch(url, { signal });
- *     return await response.json();
+ *     const json = await response.json();
+ *     if (!response.ok) {
+ *       return json;
+ *     }
+ *     return json;
+ *   },
+ *   [retry()],
+ *   {
+ *     signalBinder: {
+ *       getSignal: (args) => args[1],
+ *       forwardSignal: (args, signal) => {
+ *         args[1] = signal;
+ *       }
+ *     }
+ *   }
+ * )
+ * .invoke("URL");
+ * ```
+ *
+ * The middleware works also when the function returns a {@link Result | `Result`} type.
+ * @example
+ * ```ts
+ * import { retry } from "@daiso-tech/core/async";
+ * import { AsyncHooks, TimeSpan, Result, resultFailure, resultSuccess } from "@daiso-tech/core/utilities";
+ *
+ * const data = await new AsyncHooks(
+ *   async (url: string, signal?: AbortSignal): Promise<Result> => {
+ *     const response = await fetch(url, { signal });
+ *     const json = await response.json();
+ *     if (!response.ok) {
+ *       return resultFailure(json);
+ *     }
+ *     return resultSuccess(json);
  *   },
  *   [retry()],
  *   {
@@ -115,4 +65,4 @@ export type RetrySettings<TParameters extends unknown[] = unknown[], TContext ex
  * .invoke("URL");
  * ```
  */
-export declare function retry<TParameters extends unknown[], TReturn, TContext extends HookContext>(settings?: NoInfer<RetrySettings<TParameters, TContext>>): AsyncMiddlewareFn<TParameters, TReturn, TContext>;
+export declare function retry<TParameters extends unknown[], TReturn, TContext extends HookContext>(settings?: NoInfer<RetrySettings<TParameters, TContext, TReturn>>): AsyncMiddlewareFn<TParameters, TReturn, TContext>;

package/dist/async/middlewares/retry/retry.middleware.js

@@ -1,18 +1,16 @@
 /**
  * @module Async
  */
-import { callInvokable, } from "../../../utilities/_module-exports.js";
-import { exponentialBackoffPolicy, } from "../../../async/backof-policies/_module.js";
-import { RetryAsyncError } from "../../../async/async.errors.js";
-import { LazyPromise } from "../../../async/utilities/_module.js";
-import { callErrorPolicy, } from "../../../async/middlewares/_shared.js";
+import { callInvokable, optionNone, optionSome, OPTION, } from "../../../utilities/_module-exports.js";
+import { exponentialBackoffPolicy } from "../../../async/backof-policies/_module.js";
+import { callErrorPolicyOnThrow, callErrorPolicyOnValue, } from "../../../utilities/_module-exports.js";
+import { LazyPromise } from "../../../async/utilities/lazy-promise/_module.js";
 /**
  * The `retry` middleware enables automatic retries for all errors or specific errors, with configurable backoff policies.
  * An error will be thrown when all retry attempts fail.
  *
  * IMPORT_PATH: `"@daiso-tech/core/async"`
  * @group Middleware
- * @throws {RetryAsyncError} {@link RetryAsyncError}
  *
  * @example
  * ```ts
@@ -22,7 +20,39 @@ import { callErrorPolicy, } from "../../../async/middlewares/_shared.js";
  * const data = await new AsyncHooks(
  *   async (url: string, signal?: AbortSignal): Promise<unknown> => {
  *     const response = await fetch(url, { signal });
- *     return await response.json();
+ *     const json = await response.json();
+ *     if (!response.ok) {
+ *       return json;
+ *     }
+ *     return json;
+ *   },
+ *   [retry()],
+ *   {
+ *     signalBinder: {
+ *       getSignal: (args) => args[1],
+ *       forwardSignal: (args, signal) => {
+ *         args[1] = signal;
+ *       }
+ *     }
+ *   }
+ * )
+ * .invoke("URL");
+ * ```
+ *
+ * The middleware works also when the function returns a {@link Result | `Result`} type.
+ * @example
+ * ```ts
+ * import { retry } from "@daiso-tech/core/async";
+ * import { AsyncHooks, TimeSpan, Result, resultFailure, resultSuccess } from "@daiso-tech/core/utilities";
+ *
+ * const data = await new AsyncHooks(
+ *   async (url: string, signal?: AbortSignal): Promise<Result> => {
+ *     const response = await fetch(url, { signal });
+ *     const json = await response.json();
+ *     if (!response.ok) {
+ *       return resultFailure(json);
+ *     }
+ *     return resultSuccess(json);
  *   },
  *   [retry()],
  *   {
@@ -38,27 +68,48 @@ import { callErrorPolicy, } from "../../../async/middlewares/_shared.js";
  * ```
  */
 export function retry(settings = {}) {
-    const { maxAttempts = 4, backoffPolicy = exponentialBackoffPolicy(), errorPolicy = () => true, onRetryDelay = () => { }, onExecutionAttempt = () => { }, } = settings;
+    const { maxAttempts = 4, backoffPolicy = exponentialBackoffPolicy(), errorPolicy, onRetryDelay = () => { }, onExecutionAttempt = () => { }, } = settings;
     return async (args, next, { context, signal }) => {
-        const errors = [];
+        let result = optionNone();
+        let error_ = optionNone();
         for (let attempt = 1; attempt <= maxAttempts; attempt++) {
             try {
                 callInvokable(onExecutionAttempt, { attempt, args, context });
-                return await next(...args);
+                const value = await next(...args);
+                // Handle retrying if an Result type is returned
+                result = optionSome(value);
+                if (!(await callErrorPolicyOnValue(errorPolicy, value))) {
+                    return value;
+                }
+                // We can cast type here because callErrorPolicyOnValue ensures the value is a ResultFailure
+                const resultFailure = value;
+                if (signal.aborted) {
+                    break;
+                }
+                const waitTime = callInvokable(backoffPolicy, attempt, resultFailure.error);
+                callInvokable(onRetryDelay, {
+                    error: resultFailure.error,
+                    waitTime,
+                    attempt,
+                    args,
+                    context,
+                });
+                await LazyPromise.delay(waitTime, signal);
+                // Handle retrying if an error is thrown
             }
             catch (error) {
                 if (signal.aborted) {
                     break;
                 }
-                if (await callErrorPolicy(errorPolicy, error)) {
-                    errors.push(error);
+                if (await callErrorPolicyOnThrow(errorPolicy, error)) {
+                    error_ = optionSome(error);
                 }
                 else {
                     throw error;
                 }
                 const waitTime = callInvokable(backoffPolicy, attempt, error);
                 callInvokable(onRetryDelay, {
-                    error,
+                    error: error,
                     waitTime,
                     attempt,
                     args,
@@ -67,16 +118,13 @@ export function retry(settings = {}) {
                 await LazyPromise.delay(waitTime, signal);
             }
         }
-        let errorMessage = `Promise was failed after retried ${String(maxAttempts)} times`;
-        const lastError = errors[errors.length - 1];
-        if (lastError) {
-            // eslint-disable-next-line @typescript-eslint/no-base-to-string
-            errorMessage = `${errorMessage} and last thrown error was "${String(lastError)}"`;
+        if (error_.type === OPTION.SOME) {
+            throw error_.value;
+        }
+        if (result.type === OPTION.SOME) {
+            return result.value;
         }
-        throw new RetryAsyncError(errorMessage, {
-            errors,
-            maxAttempts,
-        });
+        throw new Error("!!__MESSAGE__!!");
     };
 }
 //# sourceMappingURL=retry.middleware.js.map

package/dist/async/middlewares/retry/retry.middleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"retry.middleware.js","sourceRoot":"","sources":["../../../../src/async/middlewares/retry/retry.middleware.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EACH,aAAa,GAIhB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACH,wBAAwB,GAE3B,MAAM,oCAAoC,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAEH,eAAe,GAClB,MAAM,gCAAgC,CAAC;AA4GxC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,KAAK,CAKjB,WAA0D,EAAE;IAE5D,MAAM,EACF,WAAW,GAAG,CAAC,EACf,aAAa,GAAG,wBAAwB,EAAE,EAC1C,WAAW,GAAG,GAAG,EAAE,CAAC,IAAI,EACxB,YAAY,GAAG,GAAG,EAAE,GAAE,CAAC,EACvB,kBAAkB,GAAG,GAAG,EAAE,GAAE,CAAC,GAChC,GAAG,QAAQ,CAAC;IACb,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE;QAC7C,MAAM,MAAM,GAAc,EAAE,CAAC;QAC7B,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC;gBACD,aAAa,CAAC,kBAAkB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC9D,OAAO,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;YAC/B,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACtB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACjB,MAAM;gBACV,CAAC;gBAED,IAAI,MAAM,eAAe,CAAC,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC;oBAC5C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;qBAAM,CAAC;oBACJ,MAAM,KAAK,CAAC;gBAChB,CAAC;gBAED,MAAM,QAAQ,GAAG,aAAa,CAAC,aAAa,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;gBAE9D,aAAa,CAAC,YAAY,EAAE;oBACxB,KAAK;oBACL,QAAQ;oBACR,OAAO;oBACP,IAAI;oBACJ,OAAO;iBACV,CAAC,CAAC;gBACH,MAAM,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC9C,CAAC;QACL,CAAC;QAED,IAAI,YAAY,GAAG,oCAAoC,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;QACnF,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5C,IAAI,SAAS,EAAE,CAAC;YACZ,gEAAgE;YAChE,YAAY,GAAG,GAAG,YAAY,+BAA+B,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;QACtF,CAAC;QACD,MAAM,IAAI,eAAe,CAAC,YAAY,EAAE;YACpC,MAAM;YACN,WAAW;SACd,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC"}
+{"version":3,"file":"retry.middleware.js","sourceRoot":"","sources":["../../../../src/async/middlewares/retry/retry.middleware.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAGH,aAAa,EACb,UAAU,EACV,UAAU,EACV,MAAM,GACT,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAE9E,OAAO,EACH,sBAAsB,EACtB,sBAAsB,GACzB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6DG;AACH,MAAM,UAAU,KAAK,CAKjB,WAAmE,EAAE;IAErE,MAAM,EACF,WAAW,GAAG,CAAC,EACf,aAAa,GAAG,wBAAwB,EAAE,EAC1C,WAAW,EACX,YAAY,GAAG,GAAG,EAAE,GAAE,CAAC,EACvB,kBAAkB,GAAG,GAAG,EAAE,GAAE,CAAC,GAChC,GAAG,QAAQ,CAAC;IACb,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE;QAC7C,IAAI,MAAM,GAAoB,UAAU,EAAE,CAAC;QAC3C,IAAI,MAAM,GAAW,UAAU,EAAE,CAAC;QAClC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC;gBACD,aAAa,CAAC,kBAAkB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;gBAC9D,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;gBAElC,gDAAgD;gBAChD,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC3B,IAAI,CAAC,CAAC,MAAM,sBAAsB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;oBACtD,OAAO,KAAK,CAAC;gBACjB,CAAC;gBACD,4FAA4F;gBAC5F,MAAM,aAAa,GAAG,KAAsB,CAAC;gBAE7C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACjB,MAAM;gBACV,CAAC;gBAED,MAAM,QAAQ,GAAG,aAAa,CAC1B,aAAa,EACb,OAAO,EACP,aAAa,CAAC,KAAK,CACtB,CAAC;gBAEF,aAAa,CAAC,YAAY,EAAE;oBACxB,KAAK,EAAE,aAAa,CAAC,KAAK;oBAC1B,QAAQ;oBACR,OAAO;oBACP,IAAI;oBACJ,OAAO;iBACV,CAAC,CAAC;gBACH,MAAM,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAE1C,wCAAwC;YAC5C,CAAC;YAAC,OAAO,KAAc,EAAE,CAAC;gBACtB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACjB,MAAM;gBACV,CAAC;gBAED,IAAI,MAAM,sBAAsB,CAAM,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC;oBACxD,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC/B,CAAC;qBAAM,CAAC;oBACJ,MAAM,KAAK,CAAC;gBAChB,CAAC;gBAED,MAAM,QAAQ,GAAG,aAAa,CAAC,aAAa,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;gBAE9D,aAAa,CAAC,YAAY,EAAE;oBACxB,KAAK,EAAE,KAAK;oBACZ,QAAQ;oBACR,OAAO;oBACP,IAAI;oBACJ,OAAO;iBACV,CAAC,CAAC;gBACH,MAAM,WAAW,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC9C,CAAC;QACL,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;YAC9B,MAAM,MAAM,CAAC,KAAK,CAAC;QACvB,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;YAC9B,OAAO,MAAM,CAAC,KAAK,CAAC;QACxB,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;IACvC,CAAC,CAAC;AACN,CAAC"}