@naturalcycles/js-lib 14.119.1 → 14.120.0

package/dist/http/fetcher.d.ts

@@ -2,11 +2,17 @@
 import { CommonLogger } from '../log/commonLogger';
 import type { Promisable } from '../typeFest';
 import type { HttpMethod, HttpStatusFamily } from './http.model';
-export interface FetcherNormalizedCfg extends FetcherCfg, FetcherRequest {
+export interface FetcherNormalizedCfg extends Required<FetcherCfg>, FetcherRequest {
     logger: CommonLogger;
     searchParams: Record<string, any>;
 }
+export type FetcherBeforeRequestHook = (req: FetcherRequest) => Promisable<void>;
+export type FetcherAfterResponseHook = (res: FetcherResponse) => Promisable<void>;
+export type FetcherBeforeRetryHook = (res: FetcherResponse) => Promisable<void>;
 export interface FetcherCfg {
+    /**
+     * Should **not** contain trailing slash.
+     */
     baseUrl?: string;
     /**
      * Default rule is that you **are allowed** to mutate req, res, res.retryStatus
@@ -17,22 +23,28 @@ export interface FetcherCfg {
         /**
          * Allows to mutate req.
          */
-        beforeRequest?(req: FetcherRequest): Promisable<void>;
+        beforeRequest?: FetcherBeforeRequestHook[];
         /**
          * Allows to mutate res.
          * If you set `res.err` - it will be thrown.
          */
-        beforeResponse?(res: FetcherResponse): Promisable<void>;
+        afterResponse?: FetcherAfterResponseHook[];
         /**
          * Allows to mutate res.retryStatus to override retry behavior.
          */
-        beforeRetry?(res: FetcherResponse): Promisable<void>;
+        beforeRetry?: FetcherBeforeRetryHook[];
     };
+    /**
+     * If true - enables all possible logging.
+     */
     debug?: boolean;
     logRequest?: boolean;
     logRequestBody?: boolean;
     logResponse?: boolean;
     logResponseBody?: boolean;
+    /**
+     * Defaults to `console`.
+     */
     logger?: CommonLogger;
 }
 export interface FetcherRetryStatus {
@@ -68,7 +80,7 @@ export interface FetcherOptions {
     timeoutSeconds?: number;
     json?: any;
     text?: string;
-    init?: Partial<RequestInitNormalized>;
+    credentials?: RequestCredentials;
     headers?: Record<string, any>;
     mode?: FetcherMode;
     searchParams?: Record<string, any>;
@@ -120,6 +132,12 @@ export type FetcherMode = 'json' | 'text';
  */
 export declare class Fetcher {
     private constructor();
+    /**
+     * Add BeforeRequest hook at the end of the hooks list.
+     */
+    onBeforeRequest(hook: FetcherBeforeRequestHook): this;
+    onAfterResponse(hook: FetcherAfterResponseHook): this;
+    onBeforeRetry(hook: FetcherBeforeRetryHook): this;
     cfg: FetcherNormalizedCfg;
     static create(cfg?: FetcherCfg & FetcherOptions): Fetcher;
     getJson<T = unknown>(url: string, opt?: FetcherOptions): Promise<T>;

package/dist/http/fetcher.js

@@ -25,6 +25,24 @@ class Fetcher {
     constructor(cfg = {}) {
         this.cfg = this.normalizeCfg(cfg);
     }
+    /**
+     * Add BeforeRequest hook at the end of the hooks list.
+     */
+    onBeforeRequest(hook) {
+        ;
+        (this.cfg.hooks.beforeRequest ||= []).push(hook);
+        return this;
+    }
+    onAfterResponse(hook) {
+        ;
+        (this.cfg.hooks.afterResponse ||= []).push(hook);
+        return this;
+    }
+    onBeforeRetry(hook) {
+        ;
+        (this.cfg.hooks.beforeRetry ||= []).push(hook);
+        return this;
+    }
     static create(cfg = {}) {
         return new Fetcher(cfg);
     }
@@ -90,7 +108,9 @@ class Fetcher {
                 abortController.abort(`timeout of ${timeoutSeconds} sec`);
             }, timeoutSeconds * 1000);
         }
-        await this.cfg.hooks?.beforeRequest?.(req);
+        for await (const hook of this.cfg.hooks.beforeRequest || []) {
+            await hook(req);
+        }
         const res = {
             req,
             retryStatus: {
@@ -159,29 +179,12 @@ class Fetcher {
                     url: req.url,
                     // tryCount: req.tryCount,
                 }));
-                // We don't log errors when they are also thrown,
-                // otherwise it gets logged twice: here, and upstream
-                // if (this.cfg.logResponse) {
-                //   const { retryAttempt } = res.retryStatus
-                //   logger.error(
-                //     [
-                //       [
-                //         ' <<',
-                //         res.fetchResponse.status,
-                //         signature,
-                //         retryAttempt && `try#${retryAttempt + 1}/${req.retry.count}`,
-                //         _since(started),
-                //       ]
-                //         .filter(Boolean)
-                //         .join(' '),
-                //       _stringifyAny(body),
-                //     ].join('\n'),
-                //   )
-                // }
                 await this.processRetry(res);
             }
         }
-        await this.cfg.hooks?.beforeResponse?.(res);
+        for await (const hook of this.cfg.hooks.afterResponse || []) {
+            await hook(res);
+        }
         return res;
     }
     async processRetry(res) {
@@ -189,7 +192,9 @@ class Fetcher {
         if (!this.shouldRetry(res)) {
             retryStatus.retryStopped = true;
         }
-        await this.cfg.hooks?.beforeRetry?.(res);
+        for await (const hook of this.cfg.hooks.beforeRetry || []) {
+            await hook(res);
+        }
         const { count, timeoutMultiplier, timeoutMax } = res.req.retry;
         if (retryStatus.retryAttempt >= count) {
             retryStatus.retryStopped = true;
@@ -245,8 +250,9 @@ class Fetcher {
             console.warn(`Fetcher: baseUrl should not end with /`);
             cfg.baseUrl = cfg.baseUrl.slice(0, cfg.baseUrl.length - 1);
         }
-        const { debug } = cfg;
+        const { debug = false } = cfg;
         const norm = (0, object_util_1._merge)({
+            baseUrl: '',
             url: '',
             searchParams: {},
             timeoutSeconds: 30,
@@ -255,6 +261,7 @@ class Fetcher {
             retry4xx: false,
             retry5xx: true,
             logger: console,
+            debug,
             logRequest: debug,
             logRequestBody: debug,
             logResponse: debug,
@@ -264,6 +271,7 @@ class Fetcher {
                 method: 'get',
                 headers: {},
             },
+            hooks: {},
         }, cfg);
         norm.init.headers = (0, object_util_1._mapKeys)(norm.init.headers, k => k.toLowerCase());
         return norm;
@@ -282,8 +290,11 @@ class Fetcher {
                 ...retry,
                 ...(0, object_util_1._filterUndefinedValues)(opt.retry || {}),
             },
-            init: (0, object_util_1._merge)({ ...this.cfg.init }, opt.init, (0, object_util_1._filterUndefinedValues)({
+            init: (0, object_util_1._merge)({ ...this.cfg.init }, 
+            // opt.init,
+            (0, object_util_1._filterUndefinedValues)({
                 method: opt.method,
+                credentials: opt.credentials,
                 headers: (0, object_util_1._mapKeys)(opt.headers || {}, k => k.toLowerCase()),
             })),
         };

package/dist-esm/http/fetcher.js

@@ -1,4 +1,5 @@
 /// <reference lib="dom"/>
+import { __asyncValues } from "tslib";
 import { _anyToErrorObject } from '../error/error.util';
 import { HttpError } from '../error/http.error';
 import { _clamp } from '../number/number.util';
@@ -22,6 +23,27 @@ export class Fetcher {
     constructor(cfg = {}) {
         this.cfg = this.normalizeCfg(cfg);
     }
+    /**
+     * Add BeforeRequest hook at the end of the hooks list.
+     */
+    onBeforeRequest(hook) {
+        var _a;
+        ;
+        ((_a = this.cfg.hooks).beforeRequest || (_a.beforeRequest = [])).push(hook);
+        return this;
+    }
+    onAfterResponse(hook) {
+        var _a;
+        ;
+        ((_a = this.cfg.hooks).afterResponse || (_a.afterResponse = [])).push(hook);
+        return this;
+    }
+    onBeforeRetry(hook) {
+        var _a;
+        ;
+        ((_a = this.cfg.hooks).beforeRetry || (_a.beforeRetry = [])).push(hook);
+        return this;
+    }
     static create(cfg = {}) {
         return new Fetcher(cfg);
     }
@@ -53,7 +75,7 @@ export class Fetcher {
         return res.body;
     }
     async rawFetch(url, rawOpt = {}) {
-        var _a, _b, _c, _d;
+        var _a, e_1, _b, _c, _d, e_2, _e, _f;
         const { logger } = this.cfg;
         const req = this.normalizeOptions(url, rawOpt);
         const { timeoutSeconds, mode, init: { method }, } = req;
@@ -66,7 +88,26 @@ export class Fetcher {
                 abortController.abort(`timeout of ${timeoutSeconds} sec`);
             }, timeoutSeconds * 1000);
         }
-        await ((_b = (_a = this.cfg.hooks) === null || _a === void 0 ? void 0 : _a.beforeRequest) === null || _b === void 0 ? void 0 : _b.call(_a, req));
+        try {
+            for (var _g = true, _h = __asyncValues(this.cfg.hooks.beforeRequest || []), _j; _j = await _h.next(), _a = _j.done, !_a;) {
+                _c = _j.value;
+                _g = false;
+                try {
+                    const hook = _c;
+                    await hook(req);
+                }
+                finally {
+                    _g = true;
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_g && !_a && (_b = _h.return)) await _b.call(_h);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
         const res = {
             req,
             retryStatus: {
@@ -130,38 +171,57 @@ export class Fetcher {
                     // Enabled, cause `data` is not printed by default when error is HttpError
                     // method: req.method,
                     url: req.url })));
-                // We don't log errors when they are also thrown,
-                // otherwise it gets logged twice: here, and upstream
-                // if (this.cfg.logResponse) {
-                //   const { retryAttempt } = res.retryStatus
-                //   logger.error(
-                //     [
-                //       [
-                //         ' <<',
-                //         res.fetchResponse.status,
-                //         signature,
-                //         retryAttempt && `try#${retryAttempt + 1}/${req.retry.count}`,
-                //         _since(started),
-                //       ]
-                //         .filter(Boolean)
-                //         .join(' '),
-                //       _stringifyAny(body),
-                //     ].join('\n'),
-                //   )
-                // }
                 await this.processRetry(res);
             }
         }
-        await ((_d = (_c = this.cfg.hooks) === null || _c === void 0 ? void 0 : _c.beforeResponse) === null || _d === void 0 ? void 0 : _d.call(_c, res));
+        try {
+            for (var _k = true, _l = __asyncValues(this.cfg.hooks.afterResponse || []), _m; _m = await _l.next(), _d = _m.done, !_d;) {
+                _f = _m.value;
+                _k = false;
+                try {
+                    const hook = _f;
+                    await hook(res);
+                }
+                finally {
+                    _k = true;
+                }
+            }
+        }
+        catch (e_2_1) { e_2 = { error: e_2_1 }; }
+        finally {
+            try {
+                if (!_k && !_d && (_e = _l.return)) await _e.call(_l);
+            }
+            finally { if (e_2) throw e_2.error; }
+        }
         return res;
     }
     async processRetry(res) {
-        var _a, _b;
+        var _a, e_3, _b, _c;
         const { retryStatus } = res;
         if (!this.shouldRetry(res)) {
             retryStatus.retryStopped = true;
         }
-        await ((_b = (_a = this.cfg.hooks) === null || _a === void 0 ? void 0 : _a.beforeRetry) === null || _b === void 0 ? void 0 : _b.call(_a, res));
+        try {
+            for (var _d = true, _e = __asyncValues(this.cfg.hooks.beforeRetry || []), _f; _f = await _e.next(), _a = _f.done, !_a;) {
+                _c = _f.value;
+                _d = false;
+                try {
+                    const hook = _c;
+                    await hook(res);
+                }
+                finally {
+                    _d = true;
+                }
+            }
+        }
+        catch (e_3_1) { e_3 = { error: e_3_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = _e.return)) await _b.call(_e);
+            }
+            finally { if (e_3) throw e_3.error; }
+        }
         const { count, timeoutMultiplier, timeoutMax } = res.req.retry;
         if (retryStatus.retryAttempt >= count) {
             retryStatus.retryStopped = true;
@@ -219,8 +279,9 @@ export class Fetcher {
             console.warn(`Fetcher: baseUrl should not end with /`);
             cfg.baseUrl = cfg.baseUrl.slice(0, cfg.baseUrl.length - 1);
         }
-        const { debug } = cfg;
+        const { debug = false } = cfg;
         const norm = _merge({
+            baseUrl: '',
             url: '',
             searchParams: {},
             timeoutSeconds: 30,
@@ -229,6 +290,7 @@ export class Fetcher {
             retry4xx: false,
             retry5xx: true,
             logger: console,
+            debug,
             logRequest: debug,
             logRequestBody: debug,
             logResponse: debug,
@@ -238,6 +300,7 @@ export class Fetcher {
                 method: 'get',
                 headers: {},
             },
+            hooks: {},
         }, cfg);
         norm.init.headers = _mapKeys(norm.init.headers, k => k.toLowerCase());
         return norm;
@@ -249,8 +312,11 @@ export class Fetcher {
             throwHttpErrors,
             retryPost,
             retry4xx,
-            retry5xx }, _omit(opt, ['method', 'headers'])), { retry: Object.assign(Object.assign({}, retry), _filterUndefinedValues(opt.retry || {})), init: _merge(Object.assign({}, this.cfg.init), opt.init, _filterUndefinedValues({
+            retry5xx }, _omit(opt, ['method', 'headers'])), { retry: Object.assign(Object.assign({}, retry), _filterUndefinedValues(opt.retry || {})), init: _merge(Object.assign({}, this.cfg.init), 
+            // opt.init,
+            _filterUndefinedValues({
                 method: opt.method,
+                credentials: opt.credentials,
                 headers: _mapKeys(opt.headers || {}, k => k.toLowerCase()),
             })) });
         // setup url

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.119.1",
+  "version": "14.120.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/http/fetcher.ts

@@ -17,12 +17,19 @@ import { _since } from '../time/time.util'
 import type { Promisable } from '../typeFest'
 import type { HttpMethod, HttpStatusFamily } from './http.model'
 
-export interface FetcherNormalizedCfg extends FetcherCfg, FetcherRequest {
+export interface FetcherNormalizedCfg extends Required<FetcherCfg>, FetcherRequest {
   logger: CommonLogger
   searchParams: Record<string, any>
 }
 
+export type FetcherBeforeRequestHook = (req: FetcherRequest) => Promisable<void>
+export type FetcherAfterResponseHook = (res: FetcherResponse) => Promisable<void>
+export type FetcherBeforeRetryHook = (res: FetcherResponse) => Promisable<void>
+
 export interface FetcherCfg {
+  /**
+   * Should **not** contain trailing slash.
+   */
   baseUrl?: string
 
   /**
@@ -34,23 +41,30 @@ export interface FetcherCfg {
     /**
      * Allows to mutate req.
      */
-    beforeRequest?(req: FetcherRequest): Promisable<void>
+    beforeRequest?: FetcherBeforeRequestHook[]
     /**
      * Allows to mutate res.
      * If you set `res.err` - it will be thrown.
      */
-    beforeResponse?(res: FetcherResponse): Promisable<void>
+    afterResponse?: FetcherAfterResponseHook[]
     /**
      * Allows to mutate res.retryStatus to override retry behavior.
      */
-    beforeRetry?(res: FetcherResponse): Promisable<void>
+    beforeRetry?: FetcherBeforeRetryHook[]
   }
 
+  /**
+   * If true - enables all possible logging.
+   */
   debug?: boolean
   logRequest?: boolean
   logRequestBody?: boolean
   logResponse?: boolean
   logResponseBody?: boolean
+
+  /**
+   * Defaults to `console`.
+   */
   logger?: CommonLogger
 }
 
@@ -90,7 +104,13 @@ export interface FetcherOptions {
   timeoutSeconds?: number
   json?: any
   text?: string
-  init?: Partial<RequestInitNormalized>
+
+  credentials?: RequestCredentials
+
+  // Removing RequestInit from options to simplify FetcherOptions interface.
+  // Will instead only add hand-picked useful options, such as `credentials`.
+  // init?: Partial<RequestInitNormalized>
+
   headers?: Record<string, any>
   mode?: FetcherMode // default to undefined (void response)
 
@@ -161,6 +181,24 @@ export class Fetcher {
     this.cfg = this.normalizeCfg(cfg)
   }
 
+  /**
+   * Add BeforeRequest hook at the end of the hooks list.
+   */
+  onBeforeRequest(hook: FetcherBeforeRequestHook): this {
+    ;(this.cfg.hooks.beforeRequest ||= []).push(hook)
+    return this
+  }
+
+  onAfterResponse(hook: FetcherAfterResponseHook): this {
+    ;(this.cfg.hooks.afterResponse ||= []).push(hook)
+    return this
+  }
+
+  onBeforeRetry(hook: FetcherBeforeRetryHook): this {
+    ;(this.cfg.hooks.beforeRetry ||= []).push(hook)
+    return this
+  }
+
   public cfg: FetcherNormalizedCfg
 
   static create(cfg: FetcherCfg & FetcherOptions = {}): Fetcher {
@@ -241,7 +279,9 @@ export class Fetcher {
       }, timeoutSeconds * 1000) as any as number
     }
 
-    await this.cfg.hooks?.beforeRequest?.(req)
+    for await (const hook of this.cfg.hooks.beforeRequest || []) {
+      await hook(req)
+    }
 
     const res: FetcherResponse<any> = {
       req,
@@ -330,31 +370,13 @@ export class Fetcher {
           }),
         )
 
-        // We don't log errors when they are also thrown,
-        // otherwise it gets logged twice: here, and upstream
-        // if (this.cfg.logResponse) {
-        //   const { retryAttempt } = res.retryStatus
-        //   logger.error(
-        //     [
-        //       [
-        //         ' <<',
-        //         res.fetchResponse.status,
-        //         signature,
-        //         retryAttempt && `try#${retryAttempt + 1}/${req.retry.count}`,
-        //         _since(started),
-        //       ]
-        //         .filter(Boolean)
-        //         .join(' '),
-        //       _stringifyAny(body),
-        //     ].join('\n'),
-        //   )
-        // }
-
         await this.processRetry(res)
       }
     }
 
-    await this.cfg.hooks?.beforeResponse?.(res)
+    for await (const hook of this.cfg.hooks.afterResponse || []) {
+      await hook(res)
+    }
 
     return res
   }
@@ -366,7 +388,9 @@ export class Fetcher {
       retryStatus.retryStopped = true
     }
 
-    await this.cfg.hooks?.beforeRetry?.(res)
+    for await (const hook of this.cfg.hooks.beforeRetry || []) {
+      await hook(res)
+    }
 
     const { count, timeoutMultiplier, timeoutMax } = res.req.retry
 
@@ -421,10 +445,11 @@ export class Fetcher {
       console.warn(`Fetcher: baseUrl should not end with /`)
       cfg.baseUrl = cfg.baseUrl.slice(0, cfg.baseUrl.length - 1)
     }
-    const { debug } = cfg
+    const { debug = false } = cfg
 
     const norm: FetcherNormalizedCfg = _merge(
       {
+        baseUrl: '',
         url: '',
         searchParams: {},
         timeoutSeconds: 30,
@@ -433,6 +458,7 @@ export class Fetcher {
         retry4xx: false,
         retry5xx: true,
         logger: console,
+        debug,
         logRequest: debug,
         logRequestBody: debug,
         logResponse: debug,
@@ -442,6 +468,7 @@ export class Fetcher {
           method: 'get',
           headers: {},
         },
+        hooks: {},
       },
       cfg,
     )
@@ -469,11 +496,12 @@ export class Fetcher {
       },
       init: _merge(
         { ...this.cfg.init },
-        opt.init,
+        // opt.init,
         _filterUndefinedValues({
           method: opt.method,
+          credentials: opt.credentials,
           headers: _mapKeys(opt.headers || {}, k => k.toLowerCase()),
-        }),
+        } as RequestInit),
       ),
     }