Rework packaging and use native fetch

Author: laurentpellegrino

CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.0.0]
+### Changed
+- Modify the library packaging to make ECMAScript modules (ESM) optional.
+- Substitute the 'ky' dependency with native fetch API.
+- Reduce the default timeout setting to 5 seconds.
+- Implement retries, up to two times, with exponential backoff in the event of a timeout.
+
 ## [5.0.2] - 2024-03-27
 ### Added
 - Add missing fields `size` and `status` to type _AutonomousSystemPrefix_.
@@ -165,7 +172,8 @@ https://github.com/ipregistry/ipregistry-javascript#configuring-cache-max-age
 ## [0.9.1] - 2019-07-23
 - First public release.
 
-[Unreleased]: https://github.com/ipregistry/ipregistry-javascript/compare/5.0.2...HEAD
+[Unreleased]: https://github.com/ipregistry/ipregistry-javascript/compare/6.0.0...HEAD
+[6.0.0]: https://github.com/ipregistry/ipregistry-javascript/compare/6.0.0...5.0.2
 [5.0.2]: https://github.com/ipregistry/ipregistry-javascript/compare/5.0.1...5.0.2
 [5.0.1]: https://github.com/ipregistry/ipregistry-javascript/compare/5.0.0...5.0.1
 [5.0.0]: https://github.com/ipregistry/ipregistry-javascript/compare/4.5.0...5.0.0

integration_test/ipregistry.ts

@@ -25,7 +25,7 @@ import {
     IpregistryOptions,
     LookupError,
     NoCache,
-} from '../src/index.js'
+} from '../dist/index.mjs'
 
 import { describe, it } from 'node:test'
 import { expect } from 'chai'

integration_test/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package.json

@@ -1,14 +1,17 @@
 {
     "name": "@ipregistry/client",
     "description": "Official Ipregistry Javascript Library.",
-    "version": "5.0.2",
-    "type": "module",
+    "version": "6.0.0",
+    "browser": "./dist/index.global.js",
     "main": "./dist/index.js",
-    "module": "./dist/esm/index.js",
+    "module": "./dist/index.mjs",
     "types": "./dist/index.d.ts",
     "exports": {
-        "import": "./dist/esm/index.js",
-        "require": "./dist/index.js"
+        ".": {
+            "import": "./dist/index.mjs",
+            "require": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        }
     },
     "homepage": "https://ipregistry.co",
     "license": "Apache-2.0",
@@ -43,10 +46,7 @@
         "url": "https://github.com/ipregistry/ipregistry-javascript/issues"
     },
     "scripts": {
-        "build:browser": "rollup -c",
-        "build:cjs": "./node_modules/.bin/tsc -p tsconfig.cjs.json",
-        "build:mjs": "./node_modules/.bin/tsc -d --outDir dist/esm",
-        "build": "npm run lint && npm run format && npm run build:mjs && npm run build:cjs && npm run build:browser",
+        "build": "tsup",
         "clean": "rm -rf dist/",
         "format": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\"",
         "lint": "./node_modules/.bin/eslint src/*",
@@ -57,26 +57,20 @@
     },
     "author": "Ipregistry <support@ipregistry.co>",
     "devDependencies": {
-        "@rollup/plugin-commonjs": "^25.0.7",
-        "@rollup/plugin-node-resolve": "^15.2.3",
-        "@rollup/plugin-terser": "^0.4.4",
-        "@rollup/plugin-typescript": "^11.1.6",
-        "@typescript-eslint/eslint-plugin": "^7.4.0",
-        "@typescript-eslint/parser": "^7.4.0",
-        "chai": "^5.1.0",
-        "eslint": "^8.57.0",
-        "eslint-config-prettier": "^9.1.0",
-        "prettier": "^3.2.5",
-        "rollup": "^4.13.0",
+        "@typescript-eslint/eslint-plugin": "^7.12.0",
+        "@typescript-eslint/parser": "^7.12.0",
+        "chai": "^5.1.1",
+        "prettier": "^3.3.0",
+        "terser": "^5.31.0",
         "ts-node": "^10.9.2",
         "tsdoc": "^0.0.4",
         "tslib": "^2.6.2",
-        "typedoc": "^0.25.12",
-        "typescript": "^5.4.3"
+        "tsup": "^8.1.0",
+        "typedoc": "^0.25.13",
+        "typescript": "^5.4.5"
     },
     "dependencies": {
-        "ky": "^1.2.3",
-        "lru-cache": "^10.2.0"
+        "lru-cache": "^10.2.2"
     },
     "files": [
         "dist/**"

rollup.config.js

@@ -0,0 +1,60 @@
+import { ApiError, ClientError } from './errors.js'
+
+interface Options extends RequestInit {
+    retry?: {
+        backoffLimit: number,
+        delay: (attemptCount: number) => number,
+        limit: number
+    }
+    timeout?: number
+}
+
+const DEFAULT_OPTIONS = {
+    retry: {
+        backoffLimit: 5000,
+        delay: (attemptCount: number) => 0.3 * (2 ** (attemptCount - 1)) * 500,
+        limit: 2
+    },
+    timeout: 5000
+}
+
+export async function customFetch(url: string, providedOptions: Options): Promise<Response> {
+    let options ={
+        ...DEFAULT_OPTIONS,
+        ...providedOptions
+    }
+
+    let retryCount = 0;
+
+    while (retryCount <= options.retry.limit) {
+        const controller = new AbortController();
+        const timeoutId = setTimeout(() => controller.abort(), options.timeout);
+
+        try {
+            const response = await fetch(url, {
+                ...options,
+                signal: controller.signal
+            });
+
+            if (!response.ok) {
+                const data = await response.json();
+                throw new ApiError(data.code, data.message, data.resolution);
+            }
+
+            return response;
+
+        } catch (error: any) {
+            if (error?.name === 'AbortError') {
+                retryCount++;
+                const retryDelay = Math.min(options.retry.delay(retryCount), options.retry.backoffLimit);
+                await new Promise(resolve => setTimeout(resolve, retryDelay));
+            } else {
+                throw error;
+            }
+        } finally {
+            clearTimeout(timeoutId);
+        }
+    }
+
+    throw new ClientError(`Request failed after ${options.retry.limit} retries`);
+}

src/fetch.ts

@@ -48,9 +48,9 @@ export class IpregistryConfig {
     public readonly baseUrl: string = 'https://api.ipregistry.co'
 
     /**
-     * The timeout (in milliseconds) for API requests. Defaults to 15000.
+     * The timeout (in milliseconds) for API requests. Defaults to 5000.
      */
-    public readonly timeout: number = 15000
+    public readonly timeout: number = 5000
 
     /**
      * Constructs a new `IpregistryConfig` instance.
@@ -81,7 +81,7 @@ export class IpregistryConfigBuilder {
 
     private baseUrl: string = 'https://api.ipregistry.co'
 
-    private timeout: number = 15000
+    private timeout: number = 5000
 
     constructor(apiKey: string) {
         this.apiKey = apiKey