@alwatr/fetch 0.6.0

package/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [0.6.0](https://github.com/AliMD/alwatr/compare/v0.5.0...v0.6.0) (2022-03-11)
+
+
+### Bug Fixes
+
+* alalwatr ([898aa6e](https://github.com/AliMD/alwatr/commit/898aa6ed0888eab9265c83b96a50f1b8c216d143))
+* **packages:** duplicate alwatr keyword ([77d4aa2](https://github.com/AliMD/alwatr/commit/77d4aa2105ad47515c3eee251fd6b8c281d0d1fc))
+
+
+
+
+
+# [0.5.0](https://github.com/AliMD/alwatr/compare/v0.4.0...v0.5.0) (2022-03-11)
+
+**Note:** Version bump only for package @alwatr/fetch
+
+# [0.4.0](https://github.com/AliMD/alwatr/compare/v0.3.0...v0.4.0) (2022-03-11)
+
+### Bug Fixes
+
+* **fetch:** build issue [#73](https://github.com/AliMD/alwatr/issues/73) ([fb74463](https://github.com/AliMD/alwatr/commit/fb74463d367393706d16e482488a565bdfef70a1))
+
+# [0.3.0](https://github.com/AliMD/alwatr/compare/v0.2.1...v0.3.0) (2022-03-06)
+
+**Note:** Version bump only for package @alwatr/fetch
+
+## [0.2.1](https://github.com/AliMD/alwatr/compare/v0.2.0...v0.2.1) (2022-03-05)
+
+**Note:** Version bump only for package @alwatr/fetch
+
+# [0.2.0](https://github.com/AliMD/alwatr/compare/v0.1.2...v0.2.0) (2022-03-05)
+
+### Bug Fixes
+
+* **fetch:** error codes ([4e0be80](https://github.com/AliMD/alwatr/commit/4e0be80786b6667035ae82750f2351bd2da4f341))
+
+### Features
+
+* **fetch:** add getData ([4a627c4](https://github.com/AliMD/alwatr/commit/4a627c43d2ad07acb340f058f02d41ce57288405))
+* **fetch:** add postData and fetchJson ([b0262b8](https://github.com/AliMD/alwatr/commit/b0262b83b5b7d8b7c376dce68aae3e16bd8e2610))
+* **fetch:** base fetch api ([925cdab](https://github.com/AliMD/alwatr/commit/925cdab8700ffb801e1d836ffc5d3245b66815cf))
+* **fetch:** FetchOptions type ([dd2d141](https://github.com/AliMD/alwatr/commit/dd2d1418d090387e1afa8277f78ae88ace17fd17))
+* **fetch:** new enhanced fetch package ([7e90472](https://github.com/AliMD/alwatr/commit/7e904720c983372317358ce107f6ad0f79c65647))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 S. Ali Mihandoost
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,20 @@
+# @alwatr/fetch
+
+Enhanced fetch API with the timeout, helper methods, and types written in tiny TypeScript, ES module.
+
+## Options
+
+`Options` inherited from the `RequestInit`. you can watch all documents of the parameters RequestInit in [`fetch init parameters`](https://developer.mozilla.org/en-US/docs/Web/API/fetch#parameters)
+
+Options have two other parameters:
+
+- `bodyObject`: a JSON object that converts to string and put on the body.
+- `queryParameters`: a JSON object that converts to URL query params
+
+## Example usage
+
+```js
+import {getJson} from 'https://esm.run/@alwatr/fetch';
+
+const productList = await getJson('/api/products', {limit: 10}, {timeout: 5_000});
+```

package/fetch.d.ts

@@ -0,0 +1,40 @@
+declare global {
+    interface AbortController {
+        abort(reason?: string): void;
+    }
+    interface AbortSignal {
+        reason?: string;
+    }
+}
+export interface FetchOptions extends RequestInit {
+    /**
+     * @default 10_000 ms
+     */
+    timeout?: number;
+    bodyObject?: Record<string | number, unknown>;
+    queryParameters?: Record<string, string | number | boolean>;
+}
+/**
+ * Enhanced base fetch API.
+ * @example const response = await fetch(url, {jsonResponse: false});
+ */
+export declare function fetch(url: string, options?: FetchOptions): Promise<Response>;
+/**
+ * Enhanced get data.
+ * @example
+ * const response = await postData('/api/products', {limit: 10}, {timeout: 5_000});
+ */
+export declare function getData(url: string, queryParameters?: Record<string | number, string | number | boolean>, options?: FetchOptions): Promise<Response>;
+/**
+ * Enhanced fetch JSON.
+ * @example
+ * const productList = await getJson('/api/products', {limit: 10}, {timeout: 5_000});
+ */
+export declare function getJson<ResponseType extends Record<string | number, unknown>>(url: string, queryParameters?: Record<string | number, string | number | boolean>, options?: FetchOptions): Promise<ResponseType>;
+/**
+ * Enhanced post json data.
+ * @example
+ * const response = await postData('/api/product/new', {name: 'foo', ...});
+ */
+export declare function postData(url: string, body: Record<string | number, unknown>, options?: FetchOptions): Promise<Response>;
+//# sourceMappingURL=fetch.d.ts.map

package/fetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["src/fetch.ts"],"names":[],"mappings":"AASA,OAAO,CAAC,MAAM,CAAC;IAEb,UAAU,eAAe;QACvB,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B;IACD,UAAU,WAAW;QACnB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB;CACF;AAGD,MAAM,WAAW,YAAa,SAAQ,WAAW;IAE/C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;CAC7D;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,CAsD5E;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CACnB,GAAG,EAAE,MAAM,EACX,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EACpE,OAAO,CAAC,EAAE,YAAY,GACvB,OAAO,CAAC,QAAQ,CAAC,CAMnB;AAED;;;;GAIG;AACH,wBAAsB,OAAO,CAAC,YAAY,SAAS,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAC/E,GAAG,EAAE,MAAM,EACX,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EACpE,OAAO,CAAC,EAAE,YAAY,GACvB,OAAO,CAAC,YAAY,CAAC,CASvB;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CACpB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EACtC,OAAO,CAAC,EAAE,YAAY,GACvB,OAAO,CAAC,QAAQ,CAAC,CAOnB"}

package/fetch.js

@@ -0,0 +1,96 @@
+import { createLogger, alwatrRegisteredList } from '@alwatr/logger';
+const logger = createLogger('alwatr/fetch');
+alwatrRegisteredList.push({
+    name: '@alwatr/fetch',
+    version: '{{ALWATR_VERSION}}',
+});
+/**
+ * Enhanced base fetch API.
+ * @example const response = await fetch(url, {jsonResponse: false});
+ */
+export function fetch(url, options) {
+    logger.logMethodArgs('fetch', { url, options });
+    if (!navigator.onLine) {
+        logger.accident('fetch', 'abort_signal', 'abort signal received', { url });
+        throw new Error('fetch_offline');
+    }
+    options = {
+        method: 'GET',
+        timeout: 15000,
+        window: null,
+        ...options,
+    };
+    if (options.queryParameters != null) {
+        const queryArray = Object
+            .keys(options.queryParameters)
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            .map((key) => `${key}=${String(options.queryParameters[key])}`);
+        if (queryArray.length > 0) {
+            url += '?' + queryArray.join('&');
+        }
+    }
+    if (options.bodyObject != null) {
+        options.body = JSON.stringify(options.bodyObject);
+        options.headers = {
+            ...options.headers,
+            'Content-Type': 'application/json',
+        };
+    }
+    // @TODO: AbortController polyfill
+    const abortController = new AbortController();
+    const externalAbortSignal = options.signal;
+    if (externalAbortSignal != null) {
+        // Respect external abort signal
+        externalAbortSignal.addEventListener('abort', () => {
+            abortController.abort(`external abort signal: ${externalAbortSignal.reason}`);
+        });
+    }
+    abortController.signal.addEventListener('abort', () => {
+        logger.incident('fetch', 'abort_signal', 'abort signal received', { url, reason: abortController.signal.reason });
+    });
+    options.signal = abortController.signal;
+    const timeoutId = setTimeout(() => abortController.abort('fetch_timeout'), options.timeout);
+    // @TODO: browser fetch polyfill
+    const response = window.fetch(url, options);
+    response.then(() => clearTimeout(timeoutId));
+    return response;
+}
+/**
+ * Enhanced get data.
+ * @example
+ * const response = await postData('/api/products', {limit: 10}, {timeout: 5_000});
+ */
+export function getData(url, queryParameters, options) {
+    logger.logMethodArgs('getData', { url, queryParameters, options });
+    return fetch(url, {
+        queryParameters,
+        ...options,
+    });
+}
+/**
+ * Enhanced fetch JSON.
+ * @example
+ * const productList = await getJson('/api/products', {limit: 10}, {timeout: 5_000});
+ */
+export async function getJson(url, queryParameters, options) {
+    logger.logMethodArgs('getJson', { url, queryParameters, options });
+    const response = await getData(url, queryParameters, options);
+    if (!response.ok) {
+        throw new Error('fetch_nok');
+    }
+    return response.json();
+}
+/**
+ * Enhanced post json data.
+ * @example
+ * const response = await postData('/api/product/new', {name: 'foo', ...});
+ */
+export function postData(url, body, options) {
+    logger.logMethodArgs('postData', { url, body, options });
+    return fetch(url, {
+        method: 'POST',
+        bodyObject: body,
+        ...options,
+    });
+}
+//# sourceMappingURL=fetch.js.map

package/fetch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.js","sourceRoot":"","sources":["src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,oBAAoB,EAAC,MAAM,gBAAgB,CAAC;AAElE,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;AAE5C,oBAAoB,CAAC,IAAI,CAAC;IACxB,IAAI,EAAE,eAAe;IACrB,OAAO,EAAE,oBAAoB;CAC9B,CAAC,CAAC;AAuBH;;;GAGG;AACH,MAAM,UAAU,KAAK,CAAC,GAAW,EAAE,OAAsB;IACvD,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,EAAC,GAAG,EAAE,OAAO,EAAC,CAAC,CAAC;IAE9C,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;QACrB,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,EAAC,GAAG,EAAC,CAAC,CAAC;QACzE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;KAClC;IAED,OAAO,GAAG;QACR,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,KAAM;QACf,MAAM,EAAE,IAAI;QACZ,GAAG,OAAO;KACX,CAAC;IAEF,IAAI,OAAO,CAAC,eAAe,IAAI,IAAI,EAAE;QACnC,MAAM,UAAU,GAAG,MAAM;aACpB,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;YAC9B,oEAAoE;aACnE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,OAAQ,CAAC,eAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CACpE;QACD,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,GAAG,IAAI,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACnC;KACF;IAED,IAAI,OAAO,CAAC,UAAU,IAAI,IAAI,EAAE;QAC9B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAClD,OAAO,CAAC,OAAO,GAAG;YAChB,GAAG,OAAO,CAAC,OAAO;YAClB,cAAc,EAAE,kBAAkB;SACnC,CAAC;KACH;IAED,kCAAkC;IAClC,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;IAC9C,MAAM,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAC3C,IAAI,mBAAmB,IAAI,IAAI,EAAE;QAC/B,gCAAgC;QAChC,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;YACjD,eAAe,CAAC,KAAK,CAAC,0BAA0B,mBAAmB,CAAC,MAAM,EAAE,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;KACJ;IACD,eAAe,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;QACpD,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,EAAC,GAAG,EAAE,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC,MAAM,EAAC,CAAC,CAAC;IAClH,CAAC,CAAC,CAAC;IACH,OAAO,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAAC;IAExC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5F,gCAAgC;IAChC,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAC5C,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7C,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CACnB,GAAW,EACX,eAAoE,EACpE,OAAsB;IAExB,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,EAAC,GAAG,EAAE,eAAe,EAAE,OAAO,EAAC,CAAC,CAAC;IACjE,OAAO,KAAK,CAAC,GAAG,EAAE;QAChB,eAAe;QACf,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CACzB,GAAW,EACX,eAAoE,EACpE,OAAsB;IAExB,MAAM,CAAC,aAAa,CAAC,SAAS,EAAE,EAAC,GAAG,EAAE,eAAe,EAAE,OAAO,EAAC,CAAC,CAAC;IACjE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IAE9D,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;KAC9B;IAED,OAAO,QAAQ,CAAC,IAAI,EAA2B,CAAC;AAClD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CACpB,GAAW,EACX,IAAsC,EACtC,OAAsB;IAExB,MAAM,CAAC,aAAa,CAAC,UAAU,EAAE,EAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAC,CAAC,CAAC;IACvD,OAAO,KAAK,CAAC,GAAG,EAAE;QAChB,MAAM,EAAE,MAAM;QACd,UAAU,EAAE,IAAI;QAChB,GAAG,OAAO;KACX,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@alwatr/fetch",
+  "version": "0.6.0",
+  "description": "Enhanced fetch api with timeout, helper methods and types written in tiny TypeScript module.",
+  "keywords": [
+    "fetch",
+    "request",
+    "api",
+    "timeout",
+    "typescript",
+    "esm",
+    "alwatr"
+  ],
+  "main": "fetch.js",
+  "type": "module",
+  "types": "fetch.d.ts",
+  "author": "S. Ali Mihandoost <ali.mihandoost@gmail.com> (https://ali.mihandoost.com)",
+  "license": "MIT",
+  "files": [
+    "**/*.js",
+    "**/*.d.ts",
+    "**/*.map",
+    "**/*.html",
+    "**/*.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/AliMD/alwatr",
+    "directory": "package/fetch"
+  },
+  "homepage": "https://github.com/AliMD/alwatr/tree/main/package/fetch#readme",
+  "bugs": {
+    "url": "https://github.com/AliMD/alwatr/issues"
+  },
+  "dependencies": {
+    "@alwatr/logger": "^0.6.0",
+    "tslib": "^2.3.1"
+  },
+  "gitHead": "8ed13adce22d7bb0cc24eb17c9f8ecfb6bbe8553"
+}