@dev-coindcx/network 1.0.2-test → 1.0.3

package/README.md

@@ -0,0 +1,85 @@
+# @dev-coindcx/network
+
+Lightweight HTTP helpers built on [axios](https://github.com/axios/axios): a configurable `AxiosServiceClass` and an `ApiServiceProWrapper` that delegates to any `ApiServiceInterface` implementation.
+
+## Install
+
+```bash
+npm install @dev-coindcx/network
+```
+
+Peer consumers should use a compatible axios major; this package pins axios for consistent installs.
+
+## Exports
+
+| Export                 | Description                                                                 |
+| ---------------------- | --------------------------------------------------------------------------- |
+| `AxiosServiceClass`    | Creates an axios instance with optional timeout and HTTP verb helpers.   |
+| `ApiServiceProWrapper` | Wraps an `ApiServiceInterface` (e.g. for layering or swapping backends). |
+
+## `AxiosServiceClass`
+
+Construct with optional `ApiServiceOptions` (`timeout` in ms, default `30000`). Use standard axios request config on each call.
+
+```ts
+import { AxiosServiceClass } from '@dev-coindcx/network';
+
+const api = new AxiosServiceClass({ timeout: 15000 });
+
+// GET
+const users = await api.get('https://api.example.com/users', {
+  params: { page: 1 },
+});
+
+// POST — put the body in `data`
+const created = await api.post('https://api.example.com/users', {
+  data: { name: 'Ada' },
+  headers: { 'Content-Type': 'application/json' },
+});
+
+// PATCH / PUT — same pattern: `data` for body
+await api.patch('https://api.example.com/users/1', {
+  data: { name: 'Grace' },
+});
+
+// DELETE
+await api.delete('https://api.example.com/users/1', {});
+```
+
+Access the underlying axios instance (e.g. for interceptors or defaults):
+
+```ts
+const client = api.getInstance();
+client.defaults.headers.common['Authorization'] = 'Bearer …';
+```
+
+## `ApiServiceProWrapper`
+
+Wraps any object that implements `ApiServiceInterface` and forwards `get`, `post`, `patch`, `put`, `delete`, and `getInstance`.
+
+```ts
+import { AxiosServiceClass, ApiServiceProWrapper } from '@dev-coindcx/network';
+
+const inner = new AxiosServiceClass();
+const api = new ApiServiceProWrapper(inner);
+
+const res = await api.get('https://api.example.com/health', {});
+```
+
+## Types
+
+Relevant shapes match axios where possible:
+
+- `ApiServiceOptions` — `{ timeout?: number }`
+- `ApiServiceConfig` — extends axios `AxiosRequestConfig`
+- `ApiServiceResponse` — extends axios `AxiosResponse`
+
+## Build (contributors)
+
+From this package directory:
+
+```bash
+npm run build
+```
+
+Output is emitted to `dist/` (`index.js`, `index.cjs`, and declaration files).

package/dist/services/axios.service.d.ts

@@ -1,12 +1,12 @@
-import { AxiosInstance } from 'axios';
-import { ApiServiceInterface, ApiServiceConfig, ApiServiceResponse, ApiServiceOptions } from '../utils/api.interface';
+import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+import { ApiServiceInterface, ApiServiceOptions } from '../utils/api.interface';
 export declare class AxiosServiceClass implements ApiServiceInterface {
     private axiosInstance;
-    constructor(options: ApiServiceOptions);
-    get(url: string, config: ApiServiceConfig): Promise<ApiServiceResponse>;
-    post(url: string, config: ApiServiceConfig): Promise<ApiServiceResponse>;
-    patch(url: string, config: ApiServiceConfig): Promise<ApiServiceResponse>;
-    put(url: string, config: ApiServiceConfig): Promise<ApiServiceResponse>;
-    delete(url: string, config: ApiServiceConfig): Promise<ApiServiceResponse>;
+    constructor(options?: ApiServiceOptions);
+    get(url: string, config: AxiosRequestConfig): Promise<AxiosResponse>;
+    post(url: string, config: AxiosRequestConfig): Promise<AxiosResponse>;
+    patch(url: string, config: AxiosRequestConfig): Promise<AxiosResponse>;
+    put(url: string, config: AxiosRequestConfig): Promise<AxiosResponse>;
+    delete(url: string, config: AxiosRequestConfig): Promise<AxiosResponse>;
     getInstance(): AxiosInstance;
 }

package/dist/utils/api.interface.d.ts

@@ -1,4 +1,4 @@
-import { AxiosRequestConfig, AxiosResponse } from "axios";
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
 export interface ApiServiceInterface {
     get(url: string, config: ApiServiceConfig): Promise<ApiServiceResponse>;
     post(url: string, config: ApiServiceConfig): Promise<ApiServiceResponse>;

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@dev-coindcx/network",
-  "version": "1.0.2-test",
+  "version": "1.0.3",
   "private": false,
   "description": "A networking library for seamless API calls and efficient data handling",
   "type": "module",
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -22,6 +23,6 @@
   },
   "author": "Manushivam Maheshwari",
   "dependencies": {
-    "axios": "^1.7.4"
+    "axios": "1.7.4"
   }
 }