@iamnnort/request 1.12.2 → 2.0.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 mingchuno
+Copyright (c) 2026 Nikita Pavets
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ 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.
+SOFTWARE.

package/README.md

@@ -1,44 +1,127 @@
-## Info
+# @iamnnort/request
 
 Request handler for Node.js - Fast - Interactive - Simple
 
 ## Installation
 
 ```bash
+npm install @iamnnort/request
+# or
 yarn add @iamnnort/request
 ```
 
 ## Usage
 
-```javascript
-import { RequestDataSource, HttpMethods } from '@iamnnort/request';
+```typescript
+import { RequestDataSource } from '@iamnnort/request';
 
 const dataSource = new RequestDataSource({
-  baseUrl: '...',
-  url: '/users'
+  name: 'Todo Api',
+  baseUrl: 'https://dummyjson.com',
+  url: '/todos',
 });
 
-const users = await dataSource.search();
+// Search
+const todos = await dataSource.search({
+  params: {
+    page: 1,
+  },
+});
+
+// Get by id
+const todo = await dataSource.get(1);
+
+// Create
+const newTodo = await dataSource.create({
+  data: {
+    todo: 'Test todo',
+    completed: false,
+    userId: 1,
+  },
+});
+
+// Update
+const updatedTodo = await dataSource.update(1, {
+  data: {
+    completed: true,
+  },
+});
+
+// Delete
+await dataSource.remove(1);
+```
+
+## Logging
+
+Set the `logLevel` option to enable it.
+
+```typescript
+const dataSource = new RequestDataSource({
+  name: 'Todo Api',
+  baseUrl: 'https://dummyjson.com',
+  url: '/todos',
+  logLevel: 'debug',
+});
+```
+
+Log levels: `trace`, `debug`, `info`, `warn`, `error`, `fatal`.
 
-const user = await dataSource.get();
+Logs include the HTTP method, full URL with query parameters, request body, status code, and duration.
+
+When the log level is `trace` or `debug`, response body data is also included in the output.
+
+```
+DEBUG (Todo Api): GET https://dummyjson.com/todos?page=1
+INFO (Todo Api): GET https://dummyjson.com/todos?page=1 200 OK (150ms)
 ```
 
-## Parameters
-
-| Parameter          | Description                                                                |
-| ------------------ | -------------------------------------------------------------------------- |
-| `baseUrl`          | Main part of the server URL that will be used for the request              |
-| `url`              | Server URL that will be used for the request                               |
-| `urlParts`         | Additional parts of URL that will be used for the request                  |
-| `method`           | Request method to be used when making the request                          |
-| `params`           | URL parameters to be sent with the request                                 |
-| `data`             | Data to be sent as the request body                                        |
-| `headers`          | Custom headers to be sent                                                  |
-| `serializer`       | Config that allows you to customize serializing                            |
-| `serializer.array` | Array element separator (`"indices"`, `"brackets"`, `"repeat"`, `"comma"`) |
-| `logger`           | Enable a logger                                                            |
-| `debug`            | Enable a debug mode                                                        |
+## Configuration
+
+### Base Config
+
+| Parameter          | Type     | Description                                                                |
+| ------------------ | -------- | -------------------------------------------------------------------------- |
+| `name`             | `string` | Name used as the logger label                                              |
+| `baseUrl`          | `string` | Main part of the server URL that will be used for the request              |
+| `url`              | `string \| number` | Server URL that will be used for the request                     |
+| `urlParts`         | `(string \| number)[]` | Additional parts of URL that will be used for the request      |
+| `baseUrlName`      | `string` | Key to look up the base URL from `baseUrlMap`                              |
+| `baseUrlMap`       | `Record<string, string>` | Map of named base URLs                                       |
+| `headers`          | `object` | Custom headers to be sent                                                  |
+| `auth`             | `object` | HTTP Basic auth credentials                                                |
+| `bearerToken`      | `string` | Bearer token for Authorization header                                      |
+| `apiKey`           | `string` | API key sent via `x-api-key` header                                        |
+| `timeout`          | `number` | Request timeout in milliseconds                                            |
+| `responseType`     | `string` | Response type (e.g. `json`, `text`, `stream`)                              |
+| `logLevel`         | `string` | Log level (`trace`, `debug`, `info`, `warn`, `error`, `fatal`)             |
+| `serializer`       | `object` | Config that allows you to customize serializing                            |
+| `serializer.array` | `string` | Array element separator (`indices`, `brackets`, `repeat`, `comma`)         |
+
+### Request Config
+
+| Parameter     | Type      | Description                                       |
+| ------------- | --------- | ------------------------------------------------- |
+| `params`      | `object`  | URL parameters to be sent with the request        |
+| `data`        | `object`  | Data to be sent as the request body               |
+| `urlencoded`  | `boolean` | Send data as `application/x-www-form-urlencoded`  |
+| `multipart`   | `boolean` | Send data as `multipart/form-data`                |
+| `xml`         | `boolean` | Send data as `text/xml`                           |
+
+## Methods
+
+| Method       | HTTP Method | Description                              |
+| ------------ | ----------- | ---------------------------------------- |
+| `search`     | `GET`       | Search for entities                      |
+| `searchOne`  | `GET`       | Search for a single entity               |
+| `bulkSearch` | `GET`       | Paginated search returning async generator |
+| `get`        | `GET`       | Get entity by id                         |
+| `create`     | `POST`      | Create entity                            |
+| `bulkCreate` | `POST`      | Create multiple entities                 |
+| `update`     | `PUT`       | Update entity by id                      |
+| `bulkUpdate` | `PUT`       | Update multiple entities                 |
+| `remove`     | `DELETE`    | Remove entity by id                      |
+| `common`     | any         | Execute a custom request                 |
 
 ## License
 
-This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.
+MIT © [Nikita Pavets](https://github.com/iamnnort)

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { AxiosRequestConfig } from 'axios';
+import { AxiosRequestConfig, AxiosResponse, AxiosError } from 'axios';
 
 type RequestParams = Pick<AxiosRequestConfig, 'params' | 'data'>;
 type RequestConfigParams = Pick<AxiosRequestConfig, 'params' | 'data'>;
@@ -23,8 +23,7 @@ type BaseRequestConfig = Pick<AxiosRequestConfig, 'auth' | 'headers' | 'timeout'
     urlParts?: (number | string)[];
     bearerToken?: string;
     apiKey?: string;
-    debug?: boolean;
-    logger?: boolean;
+    logLevel?: 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace';
     serializer?: {
         array?: 'indices' | 'brackets' | 'repeat' | 'comma';
     };
@@ -120,27 +119,32 @@ type PaginationResponse<T = unknown> = {
     pagination: Pagination;
 };
 
-declare class RequestBuilder {
-    baseConfig: BaseRequestConfig;
-    requestConfig: RequestConfig;
-    config: AxiosRequestConfig;
-    constructor(params: {
-        baseConfig: BaseRequestConfig;
-        requestConfig: RequestConfig;
-    });
-    makeContentType(): this;
-    makeAuth(): this;
-    makeUrl(): this;
-    makeMethod(): this;
-    makeData(): this;
-    makeParams(): this;
-    makeSerializer(): this;
-    build(): AxiosRequestConfig<any>;
+declare class Logger {
+    private config;
+    private logger;
+    private level;
+    constructor(config: BaseRequestConfig);
+    logRequest(request: AxiosRequestConfig): void;
+    logResponse(response: AxiosResponse, duration: number): void;
+    logError(error: AxiosError, duration: number): void;
+    makeResponse<T>(response: AxiosResponse): {
+        success: boolean;
+        status: HttpStatuses;
+        method: HttpMethods;
+        data: T;
+    };
+    makeErrorResponse<T>(error: AxiosError): {
+        success: boolean;
+        status: HttpStatuses;
+        method: HttpMethods;
+        data: T;
+    };
 }
 
 declare class RequestDataSource<Entity extends Record<string, any> = any, SearchParams extends RequestConfigParams = any, SearchResponse extends Record<string, any> = any, CreateParams extends RequestConfigParams = any, UpdateParams extends RequestConfigParams = any> {
-    baseRequestConfig: BaseRequestConfig;
-    constructor(baseRequestConfig: BaseRequestConfig);
+    config: BaseRequestConfig;
+    logger: Logger;
+    constructor(config: BaseRequestConfig);
     common<T>(requestConfig: RequestConfig, responseConfig?: ResponseConfig): Promise<T>;
     common<T>(requestConfig: RequestConfig, responseConfig: ResponseConfig & {
         raw: true;
@@ -150,7 +154,7 @@ declare class RequestDataSource<Entity extends Record<string, any> = any, Search
         raw: true;
     }): AsyncGenerator<PaginationResponse<T>>;
     search(config?: SearchParams): Promise<SearchResponse>;
-    bulkSearch(config?: SearchParams): AsyncGenerator<Entity[], any, unknown>;
+    bulkSearch(config?: SearchParams): AsyncGenerator<Entity[], any, any>;
     searchOne(config?: SearchParams): Promise<Entity>;
     get(id: number | string, config?: SearchParams): Promise<Entity>;
     create(config: CreateParams): Promise<Entity>;
@@ -168,4 +172,4 @@ declare class RequestHelper {
     static sleep(seconds: number): Promise<unknown>;
 }
 
-export { type BaseRequestConfig, HttpMethods, HttpStatuses, type Pagination, type PaginationDto, type PaginationResponse, type RawResponse, RequestBuilder, type RequestConfig, type RequestConfigParams, RequestDataSource, RequestHelper, type RequestParams, type Response, type ResponseConfig };
+export { type BaseRequestConfig, HttpMethods, HttpStatuses, type Pagination, type PaginationDto, type PaginationResponse, type RawResponse, type RequestConfig, type RequestConfigParams, RequestDataSource, RequestHelper, type RequestParams, type Response, type ResponseConfig };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AxiosRequestConfig } from 'axios';
+import { AxiosRequestConfig, AxiosResponse, AxiosError } from 'axios';
 
 type RequestParams = Pick<AxiosRequestConfig, 'params' | 'data'>;
 type RequestConfigParams = Pick<AxiosRequestConfig, 'params' | 'data'>;
@@ -23,8 +23,7 @@ type BaseRequestConfig = Pick<AxiosRequestConfig, 'auth' | 'headers' | 'timeout'
     urlParts?: (number | string)[];
     bearerToken?: string;
     apiKey?: string;
-    debug?: boolean;
-    logger?: boolean;
+    logLevel?: 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace';
     serializer?: {
         array?: 'indices' | 'brackets' | 'repeat' | 'comma';
     };
@@ -120,27 +119,32 @@ type PaginationResponse<T = unknown> = {
     pagination: Pagination;
 };
 
-declare class RequestBuilder {
-    baseConfig: BaseRequestConfig;
-    requestConfig: RequestConfig;
-    config: AxiosRequestConfig;
-    constructor(params: {
-        baseConfig: BaseRequestConfig;
-        requestConfig: RequestConfig;
-    });
-    makeContentType(): this;
-    makeAuth(): this;
-    makeUrl(): this;
-    makeMethod(): this;
-    makeData(): this;
-    makeParams(): this;
-    makeSerializer(): this;
-    build(): AxiosRequestConfig<any>;
+declare class Logger {
+    private config;
+    private logger;
+    private level;
+    constructor(config: BaseRequestConfig);
+    logRequest(request: AxiosRequestConfig): void;
+    logResponse(response: AxiosResponse, duration: number): void;
+    logError(error: AxiosError, duration: number): void;
+    makeResponse<T>(response: AxiosResponse): {
+        success: boolean;
+        status: HttpStatuses;
+        method: HttpMethods;
+        data: T;
+    };
+    makeErrorResponse<T>(error: AxiosError): {
+        success: boolean;
+        status: HttpStatuses;
+        method: HttpMethods;
+        data: T;
+    };
 }
 
 declare class RequestDataSource<Entity extends Record<string, any> = any, SearchParams extends RequestConfigParams = any, SearchResponse extends Record<string, any> = any, CreateParams extends RequestConfigParams = any, UpdateParams extends RequestConfigParams = any> {
-    baseRequestConfig: BaseRequestConfig;
-    constructor(baseRequestConfig: BaseRequestConfig);
+    config: BaseRequestConfig;
+    logger: Logger;
+    constructor(config: BaseRequestConfig);
     common<T>(requestConfig: RequestConfig, responseConfig?: ResponseConfig): Promise<T>;
     common<T>(requestConfig: RequestConfig, responseConfig: ResponseConfig & {
         raw: true;
@@ -150,7 +154,7 @@ declare class RequestDataSource<Entity extends Record<string, any> = any, Search
         raw: true;
     }): AsyncGenerator<PaginationResponse<T>>;
     search(config?: SearchParams): Promise<SearchResponse>;
-    bulkSearch(config?: SearchParams): AsyncGenerator<Entity[], any, unknown>;
+    bulkSearch(config?: SearchParams): AsyncGenerator<Entity[], any, any>;
     searchOne(config?: SearchParams): Promise<Entity>;
     get(id: number | string, config?: SearchParams): Promise<Entity>;
     create(config: CreateParams): Promise<Entity>;
@@ -168,4 +172,4 @@ declare class RequestHelper {
     static sleep(seconds: number): Promise<unknown>;
 }
 
-export { type BaseRequestConfig, HttpMethods, HttpStatuses, type Pagination, type PaginationDto, type PaginationResponse, type RawResponse, RequestBuilder, type RequestConfig, type RequestConfigParams, RequestDataSource, RequestHelper, type RequestParams, type Response, type ResponseConfig };
+export { type BaseRequestConfig, HttpMethods, HttpStatuses, type Pagination, type PaginationDto, type PaginationResponse, type RawResponse, type RequestConfig, type RequestConfigParams, RequestDataSource, RequestHelper, type RequestParams, type Response, type ResponseConfig };