npm - @naturalcycles/js-lib - Versions diffs - 14.125.0 → 14.127.0 - Mend

@naturalcycles/js-lib 14.125.0 → 14.127.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

package/dist/http/fetcher.d.ts +1 -138
package/dist/http/fetcher.js +19 -4
package/dist/http/fetcher.model.d.ts +151 -0
package/dist/http/fetcher.model.js +2 -0
package/dist/index.d.ts +1 -0
package/dist/index.js +1 -0
package/dist-esm/http/fetcher.js +19 -4
package/dist-esm/http/fetcher.model.js +1 -0
package/dist-esm/index.js +1 -0
package/package.json +1 -1
package/src/http/fetcher.model.ts +181 -0
package/src/http/fetcher.ts +39 -171
package/src/index.ts +1 -0

package/dist/http/fetcher.d.ts CHANGED Viewed

@@ -1,142 +1,5 @@
 /// <reference lib="dom" />
-import { CommonLogger } from '../log/commonLogger';
-import type { Promisable } from '../typeFest';
-import { Reviver } from '../types';
-import type { HttpMethod, HttpStatusFamily } from './http.model';
-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
-     * properties of hook function arguments.
-     * If you throw an error from the hook - it will be re-thrown as-is.
-     */
-    hooks?: {
-        /**
-         * Allows to mutate req.
-         */
-        beforeRequest?: FetcherBeforeRequestHook[];
-        /**
-         * Allows to mutate res.
-         * If you set `res.err` - it will be thrown.
-         */
-        afterResponse?: FetcherAfterResponseHook[];
-        /**
-         * Allows to mutate res.retryStatus to override retry behavior.
-         */
-        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 {
-    retryAttempt: number;
-    retryTimeout: number;
-    retryStopped: boolean;
-}
-export interface FetcherRetryOptions {
-    count: number;
-    timeout: number;
-    timeoutMax: number;
-    timeoutMultiplier: number;
-}
-export interface FetcherRequest extends Omit<FetcherOptions, 'method' | 'headers'> {
-    url: string;
-    init: RequestInitNormalized;
-    mode: FetcherMode;
-    throwHttpErrors: boolean;
-    timeoutSeconds: number;
-    retry: FetcherRetryOptions;
-    retryPost: boolean;
-    retry4xx: boolean;
-    retry5xx: boolean;
-}
-export interface FetcherOptions {
-    method?: HttpMethod;
-    throwHttpErrors?: boolean;
-    /**
-     * Default: 30.
-     *
-     * Timeout applies to both get the response and retrieve the body (e.g `await res.json()`),
-     * so both should finish within this single timeout (not each).
-     */
-    timeoutSeconds?: number;
-    json?: any;
-    text?: string;
-    /**
-     * Supports all the types that RequestInit.body supports.
-     *
-     * Useful when you want to e.g pass FormData.
-     */
-    body?: Blob | BufferSource | FormData | URLSearchParams | string;
-    credentials?: RequestCredentials;
-    /**
-     * Default to true.
-     */
-    followRedirects?: boolean;
-    headers?: Record<string, any>;
-    mode?: FetcherMode;
-    searchParams?: Record<string, any>;
-    /**
-     * Default is 2 retries (3 tries in total).
-     * Pass `retry: { count: 0 }` to disable retries.
-     */
-    retry?: Partial<FetcherRetryOptions>;
-    /**
-     * Defaults to false.
-     * Set to true to allow retrying `post` requests.
-     */
-    retryPost?: boolean;
-    /**
-     * Defaults to false.
-     */
-    retry4xx?: boolean;
-    /**
-     * Defaults to true.
-     */
-    retry5xx?: boolean;
-    jsonReviver?: Reviver;
-}
-export type RequestInitNormalized = Omit<RequestInit, 'method' | 'headers'> & {
-    method: HttpMethod;
-    headers: Record<string, any>;
-};
-export interface FetcherSuccessResponse<BODY = unknown> extends FetcherResponse<BODY> {
-    err?: undefined;
-    fetchResponse: Response;
-    body: BODY;
-}
-export interface FetcherErrorResponse<BODY = unknown> extends FetcherResponse<BODY> {
-    err: Error;
-}
-export interface FetcherResponse<BODY = unknown> {
-    err?: Error;
-    req: FetcherRequest;
-    fetchResponse?: Response;
-    statusFamily?: HttpStatusFamily;
-    body?: BODY;
-    retryStatus: FetcherRetryStatus;
-}
-export type FetcherMode = 'json' | 'text' | 'void';
+import type { FetcherAfterResponseHook, FetcherBeforeRequestHook, FetcherBeforeRetryHook, FetcherCfg, FetcherNormalizedCfg, FetcherOptions, FetcherResponse } from './fetcher.model';
 /**
  * Experimental wrapper around Fetch.
  * Works in both Browser and Node, using `globalThis.fetch`.

package/dist/http/fetcher.js CHANGED Viewed

@@ -116,7 +116,8 @@ class Fetcher {
                 retryTimeout: req.retry.timeout,
             },
         };
-        const shortUrl = this.getShortUrl(req.url);
+        const fullUrl = new URL(req.url);
+        const shortUrl = this.getShortUrl(fullUrl);
         const signature = [method.toUpperCase(), shortUrl].join(' ');
         /* eslint-disable no-await-in-loop */
         while (!res.retryStatus.retryStopped) {
@@ -132,10 +133,12 @@ class Fetcher {
             }
             try {
                 res.fetchResponse = await globalThis.fetch(req.url, req.init);
+                res.ok = res.fetchResponse.ok;
             }
             catch (err) {
                 // For example, CORS error would result in "TypeError: failed to fetch" here
                 res.err = err;
+                res.ok = false;
             }
             res.statusFamily = this.getStatusFamily(res);
             if (res.fetchResponse?.ok) {
@@ -147,6 +150,7 @@ class Fetcher {
                             res.body = JSON.parse(text, req.jsonReviver);
                         }
                         catch (err) {
+                            res.ok = false;
                             res.err = (0, error_util_1._anyToError)(err, http_error_1.HttpError, (0, object_util_1._filterNullishValues)({
                                 httpStatusCode: 0,
                                 url: req.url,
@@ -280,9 +284,18 @@ class Fetcher {
      */
     getShortUrl(url) {
         const { baseUrl } = this.cfg;
-        if (!baseUrl)
-            return url;
-        return url.split('?')[0].slice(baseUrl.length);
+        if (url.password) {
+            url = new URL(url.toString()); // prevent original url mutation
+            url.password = '[redacted]';
+        }
+        let shortUrl = url.toString();
+        if (!this.cfg.logWithSearchParams) {
+            shortUrl = shortUrl.split('?')[0];
+        }
+        if (!this.cfg.logWithPrefixUrl && baseUrl && shortUrl.startsWith(baseUrl)) {
+            shortUrl = shortUrl.slice(baseUrl.length);
+        }
+        return shortUrl;
     }
     normalizeCfg(cfg) {
         if (cfg.baseUrl?.endsWith('/')) {
@@ -306,6 +319,8 @@ class Fetcher {
             logRequestBody: debug,
             logResponse: debug,
             logResponseBody: debug,
+            logWithPrefixUrl: true,
+            logWithSearchParams: true,
             retry: { ...defRetryOptions },
             init: {
                 method: cfg.method || 'get',

package/dist/http/fetcher.model.d.ts ADDED Viewed

@@ -0,0 +1,151 @@
+import type { CommonLogger } from '../log/commonLogger';
+import type { Promisable } from '../typeFest';
+import type { Reviver } from '../types';
+import type { HttpMethod, HttpStatusFamily } from './http.model';
+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
+     * properties of hook function arguments.
+     * If you throw an error from the hook - it will be re-thrown as-is.
+     */
+    hooks?: {
+        /**
+         * Allows to mutate req.
+         */
+        beforeRequest?: FetcherBeforeRequestHook[];
+        /**
+         * Allows to mutate res.
+         * If you set `res.err` - it will be thrown.
+         */
+        afterResponse?: FetcherAfterResponseHook[];
+        /**
+         * Allows to mutate res.retryStatus to override retry behavior.
+         */
+        beforeRetry?: FetcherBeforeRetryHook[];
+    };
+    /**
+     * If true - enables all possible logging.
+     */
+    debug?: boolean;
+    logRequest?: boolean;
+    logRequestBody?: boolean;
+    logResponse?: boolean;
+    logResponseBody?: boolean;
+    /**
+     * Default to true.
+     * Set to false to exclude `prefixUrl` from logs (both success and error)
+     */
+    logWithPrefixUrl?: boolean;
+    /**
+     * Default to true.
+     * Set to false to strip searchParams from url when logging (both success and error)
+     */
+    logWithSearchParams?: boolean;
+    /**
+     * Defaults to `console`.
+     */
+    logger?: CommonLogger;
+}
+export interface FetcherRetryStatus {
+    retryAttempt: number;
+    retryTimeout: number;
+    retryStopped: boolean;
+}
+export interface FetcherRetryOptions {
+    count: number;
+    timeout: number;
+    timeoutMax: number;
+    timeoutMultiplier: number;
+}
+export interface FetcherRequest extends Omit<FetcherOptions, 'method' | 'headers'> {
+    url: string;
+    init: RequestInitNormalized;
+    mode: FetcherMode;
+    throwHttpErrors: boolean;
+    timeoutSeconds: number;
+    retry: FetcherRetryOptions;
+    retryPost: boolean;
+    retry4xx: boolean;
+    retry5xx: boolean;
+}
+export interface FetcherOptions {
+    method?: HttpMethod;
+    throwHttpErrors?: boolean;
+    /**
+     * Default: 30.
+     *
+     * Timeout applies to both get the response and retrieve the body (e.g `await res.json()`),
+     * so both should finish within this single timeout (not each).
+     */
+    timeoutSeconds?: number;
+    json?: any;
+    text?: string;
+    /**
+     * Supports all the types that RequestInit.body supports.
+     *
+     * Useful when you want to e.g pass FormData.
+     */
+    body?: Blob | BufferSource | FormData | URLSearchParams | string;
+    credentials?: RequestCredentials;
+    /**
+     * Default to true.
+     */
+    followRedirects?: boolean;
+    headers?: Record<string, any>;
+    mode?: FetcherMode;
+    searchParams?: Record<string, any>;
+    /**
+     * Default is 2 retries (3 tries in total).
+     * Pass `retry: { count: 0 }` to disable retries.
+     */
+    retry?: Partial<FetcherRetryOptions>;
+    /**
+     * Defaults to false.
+     * Set to true to allow retrying `post` requests.
+     */
+    retryPost?: boolean;
+    /**
+     * Defaults to false.
+     */
+    retry4xx?: boolean;
+    /**
+     * Defaults to true.
+     */
+    retry5xx?: boolean;
+    jsonReviver?: Reviver;
+}
+export type RequestInitNormalized = Omit<RequestInit, 'method' | 'headers'> & {
+    method: HttpMethod;
+    headers: Record<string, any>;
+};
+export interface FetcherSuccessResponse<BODY = unknown> {
+    ok: true;
+    err: undefined;
+    fetchResponse: Response;
+    body: BODY;
+    req: FetcherRequest;
+    statusFamily?: HttpStatusFamily;
+    retryStatus: FetcherRetryStatus;
+}
+export interface FetcherErrorResponse<BODY = unknown> {
+    ok: false;
+    err: Error;
+    fetchResponse?: Response;
+    body?: BODY;
+    req: FetcherRequest;
+    statusFamily?: HttpStatusFamily;
+    retryStatus: FetcherRetryStatus;
+}
+export type FetcherResponse<BODY = unknown> = FetcherSuccessResponse<BODY> | FetcherErrorResponse<BODY>;
+export type FetcherMode = 'json' | 'text' | 'void';

package/dist/http/fetcher.model.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ "use strict";
2	+ Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts CHANGED Viewed

@@ -76,4 +76,5 @@ export * from './datetime/dateInterval';
 export * from './datetime/timeInterval';
 export * from './http/http.model';
 export * from './http/fetcher';
+export * from './http/fetcher.model';
 export { is };

package/dist/index.js CHANGED Viewed

@@ -81,3 +81,4 @@ tslib_1.__exportStar(require("./datetime/dateInterval"), exports);
 tslib_1.__exportStar(require("./datetime/timeInterval"), exports);
 tslib_1.__exportStar(require("./http/http.model"), exports);
 tslib_1.__exportStar(require("./http/fetcher"), exports);
+tslib_1.__exportStar(require("./http/fetcher.model"), exports);

package/dist-esm/http/fetcher.js CHANGED Viewed

@@ -124,7 +124,8 @@ export class Fetcher {
                 retryTimeout: req.retry.timeout,
             },
         };
-        const shortUrl = this.getShortUrl(req.url);
+        const fullUrl = new URL(req.url);
+        const shortUrl = this.getShortUrl(fullUrl);
         const signature = [method.toUpperCase(), shortUrl].join(' ');
         /* eslint-disable no-await-in-loop */
         while (!res.retryStatus.retryStopped) {
@@ -140,10 +141,12 @@ export class Fetcher {
             }
             try {
                 res.fetchResponse = await globalThis.fetch(req.url, req.init);
+                res.ok = res.fetchResponse.ok;
             }
             catch (err) {
                 // For example, CORS error would result in "TypeError: failed to fetch" here
                 res.err = err;
+                res.ok = false;
             }
             res.statusFamily = this.getStatusFamily(res);
             if ((_g = res.fetchResponse) === null || _g === void 0 ? void 0 : _g.ok) {
@@ -155,6 +158,7 @@ export class Fetcher {
                             res.body = JSON.parse(text, req.jsonReviver);
                         }
                         catch (err) {
+                            res.ok = false;
                             res.err = _anyToError(err, HttpError, _filterNullishValues({
                                 httpStatusCode: 0,
                                 url: req.url,
@@ -320,9 +324,18 @@ export class Fetcher {
      */
     getShortUrl(url) {
         const { baseUrl } = this.cfg;
-        if (!baseUrl)
-            return url;
-        return url.split('?')[0].slice(baseUrl.length);
+        if (url.password) {
+            url = new URL(url.toString()); // prevent original url mutation
+            url.password = '[redacted]';
+        }
+        let shortUrl = url.toString();
+        if (!this.cfg.logWithSearchParams) {
+            shortUrl = shortUrl.split('?')[0];
+        }
+        if (!this.cfg.logWithPrefixUrl && baseUrl && shortUrl.startsWith(baseUrl)) {
+            shortUrl = shortUrl.slice(baseUrl.length);
+        }
+        return shortUrl;
     }
     normalizeCfg(cfg) {
         var _a;
@@ -347,6 +360,8 @@ export class Fetcher {
             logRequestBody: debug,
             logResponse: debug,
             logResponseBody: debug,
+            logWithPrefixUrl: true,
+            logWithSearchParams: true,
             retry: Object.assign({}, defRetryOptions),
             init: {
                 method: cfg.method || 'get',

package/dist-esm/http/fetcher.model.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/dist-esm/index.js CHANGED Viewed

@@ -76,4 +76,5 @@ export * from './datetime/dateInterval';
 export * from './datetime/timeInterval';
 export * from './http/http.model';
 export * from './http/fetcher';
+export * from './http/fetcher.model';
 export { is };

package/package.json CHANGED Viewed

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

package/src/http/fetcher.model.ts ADDED Viewed

@@ -0,0 +1,181 @@
+import type { CommonLogger } from '../log/commonLogger'
+import type { Promisable } from '../typeFest'
+import type { Reviver } from '../types'
+import type { HttpMethod, HttpStatusFamily } from './http.model'
+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
+   * properties of hook function arguments.
+   * If you throw an error from the hook - it will be re-thrown as-is.
+   */
+  hooks?: {
+    /**
+     * Allows to mutate req.
+     */
+    beforeRequest?: FetcherBeforeRequestHook[]
+    /**
+     * Allows to mutate res.
+     * If you set `res.err` - it will be thrown.
+     */
+    afterResponse?: FetcherAfterResponseHook[]
+    /**
+     * Allows to mutate res.retryStatus to override retry behavior.
+     */
+    beforeRetry?: FetcherBeforeRetryHook[]
+  }
+  /**
+   * If true - enables all possible logging.
+   */
+  debug?: boolean
+  logRequest?: boolean
+  logRequestBody?: boolean
+  logResponse?: boolean
+  logResponseBody?: boolean
+  /**
+   * Default to true.
+   * Set to false to exclude `prefixUrl` from logs (both success and error)
+   */
+  logWithPrefixUrl?: boolean
+  /**
+   * Default to true.
+   * Set to false to strip searchParams from url when logging (both success and error)
+   */
+  logWithSearchParams?: boolean
+  /**
+   * Defaults to `console`.
+   */
+  logger?: CommonLogger
+}
+export interface FetcherRetryStatus {
+  retryAttempt: number
+  retryTimeout: number
+  retryStopped: boolean
+}
+export interface FetcherRetryOptions {
+  count: number
+  timeout: number
+  timeoutMax: number
+  timeoutMultiplier: number
+}
+export interface FetcherRequest extends Omit<FetcherOptions, 'method' | 'headers'> {
+  url: string
+  init: RequestInitNormalized
+  mode: FetcherMode
+  throwHttpErrors: boolean
+  timeoutSeconds: number
+  retry: FetcherRetryOptions
+  retryPost: boolean
+  retry4xx: boolean
+  retry5xx: boolean
+}
+export interface FetcherOptions {
+  method?: HttpMethod
+  throwHttpErrors?: boolean
+  /**
+   * Default: 30.
+   *
+   * Timeout applies to both get the response and retrieve the body (e.g `await res.json()`),
+   * so both should finish within this single timeout (not each).
+   */
+  timeoutSeconds?: number
+  json?: any
+  text?: string
+  /**
+   * Supports all the types that RequestInit.body supports.
+   *
+   * Useful when you want to e.g pass FormData.
+   */
+  body?: Blob | BufferSource | FormData | URLSearchParams | string
+  credentials?: RequestCredentials
+  /**
+   * Default to true.
+   */
+  followRedirects?: boolean
+  // 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 'void'
+  searchParams?: Record<string, any>
+  /**
+   * Default is 2 retries (3 tries in total).
+   * Pass `retry: { count: 0 }` to disable retries.
+   */
+  retry?: Partial<FetcherRetryOptions>
+  /**
+   * Defaults to false.
+   * Set to true to allow retrying `post` requests.
+   */
+  retryPost?: boolean
+  /**
+   * Defaults to false.
+   */
+  retry4xx?: boolean
+  /**
+   * Defaults to true.
+   */
+  retry5xx?: boolean
+  jsonReviver?: Reviver
+}
+export type RequestInitNormalized = Omit<RequestInit, 'method' | 'headers'> & {
+  method: HttpMethod
+  headers: Record<string, any>
+}
+export interface FetcherSuccessResponse<BODY = unknown> {
+  ok: true
+  err: undefined
+  fetchResponse: Response
+  body: BODY
+  req: FetcherRequest
+  statusFamily?: HttpStatusFamily
+  retryStatus: FetcherRetryStatus
+}
+export interface FetcherErrorResponse<BODY = unknown> {
+  ok: false
+  err: Error
+  fetchResponse?: Response
+  body?: BODY
+  req: FetcherRequest
+  statusFamily?: HttpStatusFamily
+  retryStatus: FetcherRetryStatus
+}
+export type FetcherResponse<BODY = unknown> =
+  | FetcherSuccessResponse<BODY>
+  | FetcherErrorResponse<BODY>
+export type FetcherMode = 'json' | 'text' | 'void'

package/src/http/fetcher.ts CHANGED Viewed

@@ -3,7 +3,6 @@
 import { ErrorObject } from '../error/error.model'
 import { _anyToError, _anyToErrorObject, _errorToErrorObject } from '../error/error.util'
 import { HttpError } from '../error/http.error'
-import { CommonLogger } from '../log/commonLogger'
 import { _clamp } from '../number/number.util'
 import {
   _filterNullishValues,
@@ -15,170 +14,19 @@ import {
 import { pDelay } from '../promise/pDelay'
 import { _jsonParseIfPossible } from '../string/json.util'
 import { _since } from '../time/time.util'
-import type { Promisable } from '../typeFest'
-import { Reviver } from '../types'
+import type {
+  FetcherAfterResponseHook,
+  FetcherBeforeRequestHook,
+  FetcherBeforeRetryHook,
+  FetcherCfg,
+  FetcherNormalizedCfg,
+  FetcherOptions,
+  FetcherRequest,
+  FetcherResponse,
+  FetcherRetryOptions,
+} from './fetcher.model'
 import { HTTP_METHODS } from './http.model'
-import type { HttpMethod, HttpStatusFamily } from './http.model'
-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
-   * properties of hook function arguments.
-   * If you throw an error from the hook - it will be re-thrown as-is.
-   */
-  hooks?: {
-    /**
-     * Allows to mutate req.
-     */
-    beforeRequest?: FetcherBeforeRequestHook[]
-    /**
-     * Allows to mutate res.
-     * If you set `res.err` - it will be thrown.
-     */
-    afterResponse?: FetcherAfterResponseHook[]
-    /**
-     * Allows to mutate res.retryStatus to override retry behavior.
-     */
-    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 {
-  retryAttempt: number
-  retryTimeout: number
-  retryStopped: boolean
-}
-export interface FetcherRetryOptions {
-  count: number
-  timeout: number
-  timeoutMax: number
-  timeoutMultiplier: number
-}
-export interface FetcherRequest extends Omit<FetcherOptions, 'method' | 'headers'> {
-  url: string
-  init: RequestInitNormalized
-  mode: FetcherMode
-  throwHttpErrors: boolean
-  timeoutSeconds: number
-  retry: FetcherRetryOptions
-  retryPost: boolean
-  retry4xx: boolean
-  retry5xx: boolean
-}
-export interface FetcherOptions {
-  method?: HttpMethod
-  throwHttpErrors?: boolean
-  /**
-   * Default: 30.
-   *
-   * Timeout applies to both get the response and retrieve the body (e.g `await res.json()`),
-   * so both should finish within this single timeout (not each).
-   */
-  timeoutSeconds?: number
-  json?: any
-  text?: string
-  /**
-   * Supports all the types that RequestInit.body supports.
-   *
-   * Useful when you want to e.g pass FormData.
-   */
-  body?: Blob | BufferSource | FormData | URLSearchParams | string
-  credentials?: RequestCredentials
-  /**
-   * Default to true.
-   */
-  followRedirects?: boolean
-  // 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 'void'
-  searchParams?: Record<string, any>
-  /**
-   * Default is 2 retries (3 tries in total).
-   * Pass `retry: { count: 0 }` to disable retries.
-   */
-  retry?: Partial<FetcherRetryOptions>
-  /**
-   * Defaults to false.
-   * Set to true to allow retrying `post` requests.
-   */
-  retryPost?: boolean
-  /**
-   * Defaults to false.
-   */
-  retry4xx?: boolean
-  /**
-   * Defaults to true.
-   */
-  retry5xx?: boolean
-  jsonReviver?: Reviver
-}
-export type RequestInitNormalized = Omit<RequestInit, 'method' | 'headers'> & {
-  method: HttpMethod
-  headers: Record<string, any>
-}
-export interface FetcherSuccessResponse<BODY = unknown> extends FetcherResponse<BODY> {
-  err?: undefined
-  fetchResponse: Response
-  body: BODY
-}
-export interface FetcherErrorResponse<BODY = unknown> extends FetcherResponse<BODY> {
-  err: Error
-}
-export interface FetcherResponse<BODY = unknown> {
-  err?: Error
-  req: FetcherRequest
-  fetchResponse?: Response
-  statusFamily?: HttpStatusFamily
-  body?: BODY
-  retryStatus: FetcherRetryStatus
-}
-export type FetcherMode = 'json' | 'text' | 'void'
+import type { HttpStatusFamily } from './http.model'
 const defRetryOptions: FetcherRetryOptions = {
   count: 2,
@@ -288,7 +136,7 @@ export class Fetcher {
       if (res.req.throwHttpErrors) throw res.err
       return res as any
     }
-    return res.body!
+    return res.body
   }
   /**
@@ -322,16 +170,17 @@ export class Fetcher {
       await hook(req)
     }
-    const res: FetcherResponse<any> = {
+    const res = {
       req,
       retryStatus: {
         retryAttempt: 0,
         retryStopped: false,
         retryTimeout: req.retry.timeout,
       },
-    }
+    } as FetcherResponse<any>
-    const shortUrl = this.getShortUrl(req.url)
+    const fullUrl = new URL(req.url)
+    const shortUrl = this.getShortUrl(fullUrl)
     const signature = [method.toUpperCase(), shortUrl].join(' ')
     /* eslint-disable no-await-in-loop */
@@ -352,9 +201,11 @@ export class Fetcher {
       try {
         res.fetchResponse = await globalThis.fetch(req.url, req.init)
+        res.ok = res.fetchResponse.ok
       } catch (err) {
         // For example, CORS error would result in "TypeError: failed to fetch" here
         res.err = err as Error
+        res.ok = false
       }
       res.statusFamily = this.getStatusFamily(res)
@@ -367,6 +218,7 @@ export class Fetcher {
             try {
               res.body = JSON.parse(text, req.jsonReviver)
             } catch (err) {
+              res.ok = false
               res.err = _anyToError(
                 err,
                 HttpError,
@@ -514,11 +366,25 @@ export class Fetcher {
   /**
    * Returns url without baseUrl and before ?queryString
    */
-  private getShortUrl(url: string): string {
+  private getShortUrl(url: URL): string {
     const { baseUrl } = this.cfg
-    if (!baseUrl) return url
-    return url.split('?')[0]!.slice(baseUrl.length)
+    if (url.password) {
+      url = new URL(url.toString()) // prevent original url mutation
+      url.password = '[redacted]'
+    }
+    let shortUrl = url.toString()
+    if (!this.cfg.logWithSearchParams) {
+      shortUrl = shortUrl.split('?')[0]!
+    }
+    if (!this.cfg.logWithPrefixUrl && baseUrl && shortUrl.startsWith(baseUrl)) {
+      shortUrl = shortUrl.slice(baseUrl.length)
+    }
+    return shortUrl
   }
   private normalizeCfg(cfg: FetcherCfg & FetcherOptions): FetcherNormalizedCfg {
@@ -545,6 +411,8 @@ export class Fetcher {
         logRequestBody: debug,
         logResponse: debug,
         logResponseBody: debug,
+        logWithPrefixUrl: true,
+        logWithSearchParams: true,
         retry: { ...defRetryOptions },
         init: {
           method: cfg.method || 'get',

package/src/index.ts CHANGED Viewed

@@ -76,5 +76,6 @@ export * from './datetime/dateInterval'
 export * from './datetime/timeInterval'
 export * from './http/http.model'
 export * from './http/fetcher'
+export * from './http/fetcher.model'
 export { is }