@naturalcycles/js-lib 14.120.0 → 14.122.0

package/dist/http/fetcher.d.ts

@@ -80,6 +80,12 @@ export interface FetcherOptions {
     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;
     headers?: Record<string, any>;
     mode?: FetcherMode;
@@ -140,12 +146,22 @@ export declare class Fetcher {
     onBeforeRetry(hook: FetcherBeforeRetryHook): this;
     cfg: FetcherNormalizedCfg;
     static create(cfg?: FetcherCfg & FetcherOptions): Fetcher;
-    getJson<T = unknown>(url: string, opt?: FetcherOptions): Promise<T>;
-    postJson<T = unknown>(url: string, opt?: FetcherOptions): Promise<T>;
-    putJson<T = unknown>(url: string, opt?: FetcherOptions): Promise<T>;
-    patchJson<T = unknown>(url: string, opt?: FetcherOptions): Promise<T>;
-    deleteJson<T = unknown>(url: string, opt?: FetcherOptions): Promise<T>;
-    getText(url: string, opt?: FetcherOptions): Promise<string>;
+    get: (url: string, opt?: FetcherOptions) => Promise<void>;
+    post: (url: string, opt?: FetcherOptions) => Promise<void>;
+    put: (url: string, opt?: FetcherOptions) => Promise<void>;
+    patch: (url: string, opt?: FetcherOptions) => Promise<void>;
+    delete: (url: string, opt?: FetcherOptions) => Promise<void>;
+    head: (url: string, opt?: FetcherOptions) => Promise<void>;
+    getText: (url: string, opt?: FetcherOptions) => Promise<string>;
+    postText: (url: string, opt?: FetcherOptions) => Promise<string>;
+    putText: (url: string, opt?: FetcherOptions) => Promise<string>;
+    patchText: (url: string, opt?: FetcherOptions) => Promise<string>;
+    deleteText: (url: string, opt?: FetcherOptions) => Promise<string>;
+    getJson: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>;
+    postJson: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>;
+    putJson: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>;
+    patchJson: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>;
+    deleteJson: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>;
     fetch<T = unknown>(url: string, opt?: FetcherOptions): Promise<T>;
     rawFetch<T = unknown>(url: string, rawOpt?: FetcherOptions): Promise<FetcherResponse<T>>;
     private processRetry;

package/dist/http/fetcher.js

@@ -9,6 +9,7 @@ const object_util_1 = require("../object/object.util");
 const pDelay_1 = require("../promise/pDelay");
 const json_util_1 = require("../string/json.util");
 const time_util_1 = require("../time/time.util");
+const http_model_1 = require("./http.model");
 const defRetryOptions = {
     count: 2,
     timeout: 500,
@@ -24,6 +25,30 @@ const defRetryOptions = {
 class Fetcher {
     constructor(cfg = {}) {
         this.cfg = this.normalizeCfg(cfg);
+        // Dynamically create all helper methods
+        http_model_1.HTTP_METHODS.forEach(method => {
+            // mode=void
+            this[method] = async (url, opt) => {
+                return await this.fetch(url, {
+                    ...opt,
+                    method,
+                });
+            };
+            this[`${method}Text`] = async (url, opt) => {
+                return await this.fetch(url, {
+                    ...opt,
+                    method,
+                    mode: 'text',
+                });
+            };
+            this[`${method}Json`] = async (url, opt) => {
+                return await this.fetch(url, {
+                    ...opt,
+                    method,
+                    mode: 'json',
+                });
+            };
+        });
     }
     /**
      * Add BeforeRequest hook at the end of the hooks list.
@@ -46,46 +71,7 @@ class Fetcher {
     static create(cfg = {}) {
         return new Fetcher(cfg);
     }
-    async getJson(url, opt) {
-        return await this.fetch(url, {
-            ...opt,
-            mode: 'json',
-        });
-    }
-    async postJson(url, opt) {
-        return await this.fetch(url, {
-            ...opt,
-            method: 'post',
-            mode: 'json',
-        });
-    }
-    async putJson(url, opt) {
-        return await this.fetch(url, {
-            ...opt,
-            method: 'put',
-            mode: 'json',
-        });
-    }
-    async patchJson(url, opt) {
-        return await this.fetch(url, {
-            ...opt,
-            method: 'patch',
-            mode: 'json',
-        });
-    }
-    async deleteJson(url, opt) {
-        return await this.fetch(url, {
-            ...opt,
-            method: 'delete',
-            mode: 'json',
-        });
-    }
-    async getText(url, opt) {
-        return await this.fetch(url, {
-            ...opt,
-            mode: 'text',
-        });
-    }
+    // headJson!: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>
     async fetch(url, opt) {
         const res = await this.rawFetch(url, opt);
         if (res.err) {
@@ -215,9 +201,9 @@ class Fetcher {
         if (method === 'post' && !retryPost)
             return false;
         const { statusFamily } = res;
-        if (statusFamily === '5xx' && !retry5xx)
+        if (statusFamily === 5 && !retry5xx)
             return false;
-        if (statusFamily === '4xx' && !retry4xx)
+        if (statusFamily === 4 && !retry4xx)
             return false;
         return true; // default is true
     }
@@ -226,15 +212,15 @@ class Fetcher {
         if (!status)
             return;
         if (status >= 500)
-            return '5xx';
+            return 5;
         if (status >= 400)
-            return '4xx';
+            return 4;
         if (status >= 300)
-            return '3xx';
+            return 3;
         if (status >= 200)
-            return '2xx';
+            return 2;
         if (status >= 100)
-            return '1xx';
+            return 1;
     }
     /**
      * Returns url without baseUrl and before ?queryString
@@ -323,6 +309,9 @@ class Fetcher {
             req.init.body = opt.text;
             req.init.headers['content-type'] = 'text/plain';
         }
+        else if (opt.body !== undefined) {
+            req.init.body = opt.body;
+        }
         return req;
     }
 }

package/dist/http/http.model.d.ts

@@ -1,2 +1,3 @@
 export type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head';
-export type HttpStatusFamily = '5xx' | '4xx' | '3xx' | '2xx' | '1xx';
+export type HttpStatusFamily = 5 | 4 | 3 | 2 | 1;
+export declare const HTTP_METHODS: HttpMethod[];

package/dist/http/http.model.js

@@ -1,2 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.HTTP_METHODS = void 0;
+exports.HTTP_METHODS = ['get', 'post', 'put', 'patch', 'delete', 'head'];

package/dist-esm/http/fetcher.js

@@ -7,6 +7,7 @@ import { _filterNullishValues, _filterUndefinedValues, _mapKeys, _merge, _omit,
 import { pDelay } from '../promise/pDelay';
 import { _jsonParseIfPossible } from '../string/json.util';
 import { _since } from '../time/time.util';
+import { HTTP_METHODS } from './http.model';
 const defRetryOptions = {
     count: 2,
     timeout: 500,
@@ -22,6 +23,19 @@ const defRetryOptions = {
 export class Fetcher {
     constructor(cfg = {}) {
         this.cfg = this.normalizeCfg(cfg);
+        // Dynamically create all helper methods
+        HTTP_METHODS.forEach(method => {
+            // mode=void
+            this[method] = async (url, opt) => {
+                return await this.fetch(url, Object.assign(Object.assign({}, opt), { method }));
+            };
+            this[`${method}Text`] = async (url, opt) => {
+                return await this.fetch(url, Object.assign(Object.assign({}, opt), { method, mode: 'text' }));
+            };
+            this[`${method}Json`] = async (url, opt) => {
+                return await this.fetch(url, Object.assign(Object.assign({}, opt), { method, mode: 'json' }));
+            };
+        });
     }
     /**
      * Add BeforeRequest hook at the end of the hooks list.
@@ -47,24 +61,7 @@ export class Fetcher {
     static create(cfg = {}) {
         return new Fetcher(cfg);
     }
-    async getJson(url, opt) {
-        return await this.fetch(url, Object.assign(Object.assign({}, opt), { mode: 'json' }));
-    }
-    async postJson(url, opt) {
-        return await this.fetch(url, Object.assign(Object.assign({}, opt), { method: 'post', mode: 'json' }));
-    }
-    async putJson(url, opt) {
-        return await this.fetch(url, Object.assign(Object.assign({}, opt), { method: 'put', mode: 'json' }));
-    }
-    async patchJson(url, opt) {
-        return await this.fetch(url, Object.assign(Object.assign({}, opt), { method: 'patch', mode: 'json' }));
-    }
-    async deleteJson(url, opt) {
-        return await this.fetch(url, Object.assign(Object.assign({}, opt), { method: 'delete', mode: 'json' }));
-    }
-    async getText(url, opt) {
-        return await this.fetch(url, Object.assign(Object.assign({}, opt), { mode: 'text' }));
-    }
+    // headJson!: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>
     async fetch(url, opt) {
         const res = await this.rawFetch(url, opt);
         if (res.err) {
@@ -242,9 +239,9 @@ export class Fetcher {
         if (method === 'post' && !retryPost)
             return false;
         const { statusFamily } = res;
-        if (statusFamily === '5xx' && !retry5xx)
+        if (statusFamily === 5 && !retry5xx)
             return false;
-        if (statusFamily === '4xx' && !retry4xx)
+        if (statusFamily === 4 && !retry4xx)
             return false;
         return true; // default is true
     }
@@ -254,15 +251,15 @@ export class Fetcher {
         if (!status)
             return;
         if (status >= 500)
-            return '5xx';
+            return 5;
         if (status >= 400)
-            return '4xx';
+            return 4;
         if (status >= 300)
-            return '3xx';
+            return 3;
         if (status >= 200)
-            return '2xx';
+            return 2;
         if (status >= 100)
-            return '1xx';
+            return 1;
     }
     /**
      * Returns url without baseUrl and before ?queryString
@@ -341,6 +338,9 @@ export class Fetcher {
             req.init.body = opt.text;
             req.init.headers['content-type'] = 'text/plain';
         }
+        else if (opt.body !== undefined) {
+            req.init.body = opt.body;
+        }
         return req;
     }
 }

package/dist-esm/http/http.model.js

@@ -1 +1 @@
-export {};
+export const HTTP_METHODS = ['get', 'post', 'put', 'patch', 'delete', 'head'];

package/package.json

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

package/src/http/fetcher.ts

@@ -15,6 +15,7 @@ import { pDelay } from '../promise/pDelay'
 import { _jsonParseIfPossible } from '../string/json.util'
 import { _since } from '../time/time.util'
 import type { Promisable } from '../typeFest'
+import { HTTP_METHODS } from './http.model'
 import type { HttpMethod, HttpStatusFamily } from './http.model'
 
 export interface FetcherNormalizedCfg extends Required<FetcherCfg>, FetcherRequest {
@@ -102,8 +103,15 @@ export interface FetcherOptions {
    * 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
 
@@ -179,6 +187,41 @@ const defRetryOptions: FetcherRetryOptions = {
 export class Fetcher {
   private constructor(cfg: FetcherCfg & FetcherOptions = {}) {
     this.cfg = this.normalizeCfg(cfg)
+
+    // Dynamically create all helper methods
+    HTTP_METHODS.forEach(method => {
+      // mode=void
+      this[method] = async (url: string, opt?: FetcherOptions): Promise<void> => {
+        return await this.fetch<void>(url, {
+          ...opt,
+          method,
+        })
+      }
+
+      // mode=text
+      ;(this as any)[`${method}Text`] = async (
+        url: string,
+        opt?: FetcherOptions,
+      ): Promise<string> => {
+        return await this.fetch<string>(url, {
+          ...opt,
+          method,
+          mode: 'text',
+        })
+      }
+
+      // mode=json
+      ;(this as any)[`${method}Json`] = async <T = unknown>(
+        url: string,
+        opt?: FetcherOptions,
+      ): Promise<T> => {
+        return await this.fetch<T>(url, {
+          ...opt,
+          method,
+          mode: 'json',
+        })
+      }
+    })
   }
 
   /**
@@ -205,47 +248,26 @@ export class Fetcher {
     return new Fetcher(cfg)
   }
 
-  async getJson<T = unknown>(url: string, opt?: FetcherOptions): Promise<T> {
-    return await this.fetch<T>(url, {
-      ...opt,
-      mode: 'json',
-    })
-  }
-  async postJson<T = unknown>(url: string, opt?: FetcherOptions): Promise<T> {
-    return await this.fetch<T>(url, {
-      ...opt,
-      method: 'post',
-      mode: 'json',
-    })
-  }
-  async putJson<T = unknown>(url: string, opt?: FetcherOptions): Promise<T> {
-    return await this.fetch<T>(url, {
-      ...opt,
-      method: 'put',
-      mode: 'json',
-    })
-  }
-  async patchJson<T = unknown>(url: string, opt?: FetcherOptions): Promise<T> {
-    return await this.fetch<T>(url, {
-      ...opt,
-      method: 'patch',
-      mode: 'json',
-    })
-  }
-  async deleteJson<T = unknown>(url: string, opt?: FetcherOptions): Promise<T> {
-    return await this.fetch<T>(url, {
-      ...opt,
-      method: 'delete',
-      mode: 'json',
-    })
-  }
-
-  async getText(url: string, opt?: FetcherOptions): Promise<string> {
-    return await this.fetch<string>(url, {
-      ...opt,
-      mode: 'text',
-    })
-  }
+  // These methods are generated dynamically in the constructor
+  get!: (url: string, opt?: FetcherOptions) => Promise<void>
+  post!: (url: string, opt?: FetcherOptions) => Promise<void>
+  put!: (url: string, opt?: FetcherOptions) => Promise<void>
+  patch!: (url: string, opt?: FetcherOptions) => Promise<void>
+  delete!: (url: string, opt?: FetcherOptions) => Promise<void>
+  head!: (url: string, opt?: FetcherOptions) => Promise<void>
+
+  getText!: (url: string, opt?: FetcherOptions) => Promise<string>
+  postText!: (url: string, opt?: FetcherOptions) => Promise<string>
+  putText!: (url: string, opt?: FetcherOptions) => Promise<string>
+  patchText!: (url: string, opt?: FetcherOptions) => Promise<string>
+  deleteText!: (url: string, opt?: FetcherOptions) => Promise<string>
+
+  getJson!: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>
+  postJson!: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>
+  putJson!: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>
+  patchJson!: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>
+  deleteJson!: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>
+  // headJson!: <T = unknown>(url: string, opt?: FetcherOptions) => Promise<T>
 
   async fetch<T = unknown>(url: string, opt?: FetcherOptions): Promise<T> {
     const res = await this.rawFetch<T>(url, opt)
@@ -415,19 +437,19 @@ export class Fetcher {
     const { method } = res.req.init
     if (method === 'post' && !retryPost) return false
     const { statusFamily } = res
-    if (statusFamily === '5xx' && !retry5xx) return false
-    if (statusFamily === '4xx' && !retry4xx) return false
+    if (statusFamily === 5 && !retry5xx) return false
+    if (statusFamily === 4 && !retry4xx) return false
     return true // default is true
   }
 
   private getStatusFamily(res: FetcherResponse): HttpStatusFamily | undefined {
     const status = res.fetchResponse?.status
     if (!status) return
-    if (status >= 500) return '5xx'
-    if (status >= 400) return '4xx'
-    if (status >= 300) return '3xx'
-    if (status >= 200) return '2xx'
-    if (status >= 100) return '1xx'
+    if (status >= 500) return 5
+    if (status >= 400) return 4
+    if (status >= 300) return 3
+    if (status >= 200) return 2
+    if (status >= 100) return 1
   }
 
   /**
@@ -531,6 +553,8 @@ export class Fetcher {
     } else if (opt.text !== undefined) {
       req.init.body = opt.text
       req.init.headers['content-type'] = 'text/plain'
+    } else if (opt.body !== undefined) {
+      req.init.body = opt.body
     }
 
     return req

package/src/http/http.model.ts

@@ -1,3 +1,5 @@
 export type HttpMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head'
 
-export type HttpStatusFamily = '5xx' | '4xx' | '3xx' | '2xx' | '1xx'
+export type HttpStatusFamily = 5 | 4 | 3 | 2 | 1
+
+export const HTTP_METHODS: HttpMethod[] = ['get', 'post', 'put', 'patch', 'delete', 'head']