Axios migration (#91)

Author: if0s

.circleci/config.yml

@@ -16,7 +16,7 @@ jobs:
             - ./node_modules
       - run:
           name: Audit Dependencies
-          command: npm run audit
+          command: npm audit --production
       - run:
           name: Running Mocha Tests
           command: npm test

.nsprc

@@ -1,3 +1,17 @@
+## 4.0.0 (August 05, 2025)
+* BREAKING CHANGE – All clients named `*RestClient` have been removed except for `PlatformApiRestClient`. Any removed client logic should now be implemented within components.
+* `PlatformApiRestClient` has been migrated from the `request` library to `axios`.
+* The following libraries have been removed from the main dependencies:
+  * @elastic.io/ntlm-client
+  * async
+  * bunyan-serializers
+  * elasticio-node
+  * better-npm-audit
+  * remove-leading-slash
+  * remove-trailing-slash
+  * request
+* The `axiosReqWithRetryOnServerError` function can now operate without requiring a context.
+
 ## 3.2.2 (March 21, 2025)
 * Updated maester-client to 6.0.0
 

CHANGELOG.md

@@ -4,13 +4,6 @@
 ## Table of Contents
 - [Description](#description)
 - [Available Functions](#Available-Functions)
-  - [REST Clients](#REST-Clients)
-    - [NoAuthRestClient](#NoAuthRestClient)
-    - [BasicAuthRestClient](#BasicAuthRestClient)
-    - [ApiKeyRestClient](#ApiKeyRestClient)
-    - [CookieRestClient](#CookieRestClient)
-    - [OAuth2AuthorizationCodeRestClient](#OAuth2AuthorizationCodeRestClient)
-    - [FacelessRestClient](#FacelessRestClient)
   - [Platform API Clients](#Platform-API-Clients)
     - [PlatformApiRestClient](#PlatformApiRestClient)
     - [PlatformApiLogicClient](#PlatformApiLogicClient)
@@ -32,127 +25,6 @@ npm install @elastic.io/component-commons-library
 
 # Available Functions
 
-## REST Clients
-A number of REST Client classes are available to use and extend to create Clients for a given API.
-
-Each of the REST Clients extends from the `NoAuthRestClient`, overriding the relevant methods. Exception is PlatformApiRestClient and PlatformApiLogicClient.
-
-### NoAuthRestClient
-[NoAuthRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/NoAuthRestClient.ts) class to make rest requests no no auth APIs by provided options.
-
-#### constructor(emitter, cfg)
-- emitter - EIO emitting context.
-- cfg - configuration of EIO component object.
-
-```
-const Client = new NoAuthRestClient(emitter, cfg);
-```
-
-#### async makeRequest(options)
-Makes requests:
-options expects the following sub-variables:
-  - url: Url to call
-  - method: HTTP verb to use
-  - body: Body of the request, if applicable. Defaults to undefined.
-  - headers: Any HTTP headers to add to the request. Defaults to {}
-  - urlIsSegment: Whether to append to the base server url or if the provided URL is an absolute path. Defaults to true
-  - isJson: If the request is in JSON format. Defaults to true
-
-
-Class can be extended to have custom authentication
-
-Example:
-
-```javascript
-const { NoAuthRestClient } = require('@elastic.io/component-commons-library');
-
-class MyClient extends NoAuthRestClient {
-  constructor(emitter, cfg) {
-    super(emitter, cfg);
-    // Other variables go here
-  }
-
-  // Some methods can be overridden
-  addAuthenticationToRequestOptions(requestOptions) {
-    requestOptions.specialField = true;
-  }
-
-
-}
-```
-
-### BasicAuthRestClient
-[BasicAuthRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/BasicAuthRestClient.ts)
-class extends [NoAuthRestClient](#NoAuthRestClient) class.
-Makes requests to resource with basic auth.
-
-#### constructor(emitter, cfg)
-- cfg.username - mandatory cfg parameter contains username for authorization.
-- cfg.password - mandatory cfg parameter contains password for authorization.
-
-```
-const Client = new BasicAuthRestClient(emitter, cfg, user, pass);
-```
-
-
-### ApiKeyRestClient
-[ApiKeyRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/ApiKeyRestClient.ts)
-class extends [NoAuthRestClient](#NoAuthRestClient) class.
-Makes requests to resource with api key (custom header) auth.
-
-#### constructor(emitter, cfg)
-- cfg.apiKeyHeaderName - mandatory cfg parameter contains authorization header name.
-- cfg.apiKeyHeaderValue - mandatory cfg parameter contains authorization header value.
-
-```
-const Client = new BasicAuthRestClient(emitter, cfg, user, pass);
-```
-
-### CookieRestClient
-[CookieRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/CookieRestClient.ts)
-class extends [NoAuthRestClient](#NoAuthRestClient) class.
-
-TBD
-
-### OAuth2AuthorizationCodeRestClient
-[OAuth2RestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/OAuth2AuthorizationCodeRestClient.ts)
-class extends [NoAuthRestClient](#NoAuthRestClient) class.
-Makes requests to resource with oauth2 access token auth.
-
-#### constructor(emitter, cfg)
-- cfg.oauth2 - mandatory cfg parameter contains oauth2 ids, config and tokens.
-```
-const Client = new OAuth2AuthorizationCodeRestClient(emitter, cfg);
-```
-This class can handle, refresh and emit oauth2 EIO configuration.
-
-### FacelessRestClient
-[FacelessRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/FacelessRestClient.ts)
-Makes requests to resource with oauth2 access token auth using ElasticIO [Faceless Service](https://docs.elastic.io/guides/secrets.html).
-
-#### constructor(emitter, cfg, userAgent, msgId)
-
-- cfg - should contain `secretId` parameter or `oauth` object with oauth2 config and tokens.
-- userAgent - optional parameter, used for `User-Agent` header when client retrieve secret from platform
-- msgId - optional parameter, used for `x-request-id` header when client retrieve secret from platform
-```
-const Client = new FacelessRestClient(emitter, cfg, userAgent, msgId);
-```
-
-### NtlmRestClient
-[NtlmRestClient](https://github.com/elasticio/component-commons-library/blob/master/src/authentication/NtlmRestClient.ts)
-class extends [NoAuthRestClient](#NoAuthRestClient) class.
-Makes requests to resource with [NTLM authentication](https://en.wikipedia.org/wiki/NT_LAN_Manager).
-Falls back to basic authentication if NTLM authentication fails.
-Handles both V1 and V2 of the NTLM Protocol.
-
-#### constructor(emitter, cfg)
-- cfg.username - mandatory cfg parameter contains username for authorization.  Domain information should be combined with this field. (e.g. `SOMEDOMAIN\SomeUser`)
-- cfg.password - mandatory cfg parameter contains password for authorization.
-
-```
-const Client = new NtlmRestClient(emitter, cfg);
-```
 
 ## Platform API Clients
 A number of Platform API Client classes are available to use and extend them to create Clients for Platform API.