chore: update .gitignore and improve type imports; add notes for Node.js-only functionality in BaseRestClient

Author: JJ-Cro

.gitignore

@@ -20,6 +20,8 @@ node_modules/
 .env.test
 .cache
 lib
+dist
+doc
 bundleReport.html
 .history/
 rawReq.ts

src/types/websockets/ws-general.ts

@@ -1,4 +1,4 @@
-import { ClientRequestArgs } from 'http';
+import type { ClientRequestArgs } from 'http';
 import WebSocket from 'isomorphic-ws';
 
 import { RestClientOptions, WS_KEY_MAP } from '../../util';

src/util/BaseRestClient.ts

@@ -1,5 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import axios, { AxiosRequestConfig, AxiosResponse, Method } from 'axios';
+// NOTE: https.Agent is Node.js-only and not available in browser environments
+// Browser builds (via webpack) exclude this module - see webpack.config.js fallback settings
 import https from 'https';
 
 import {
@@ -149,6 +151,9 @@ export default abstract class BaseRestClient {
     };
 
     // If enabled, configure a https agent with keepAlive enabled
+    // NOTE: This is Node.js-only functionality. In browser environments, this code is skipped
+    // as the 'https' module is excluded via webpack fallback configuration.
+    // Browser connection pooling is handled automatically by the browser itself.
     if (this.options.keepAlive) {
       // Extract existing https agent parameters, if provided, to prevent the keepAlive flag from overwriting
       // an existing https agent completely

webpack/webpack.config.js

@@ -20,6 +20,12 @@ function generateConfig(name) {
       extensions: [".webpack.js", ".web.js", ".ts", ".tsx", ".js"],
       alias: {
         process: "process/browser",
+      },
+      fallback: {
+        // Node.js core modules not available in browsers
+        // The REST client's https.Agent (for keepAlive) is Node.js-only and won't work in browsers
+        "http": false,
+        "https": false,
       }
     },