@dexyn/common-library 1.0.7 → 1.0.9

package/api/apiClientUtils.d.ts

@@ -0,0 +1,25 @@
+export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE';
+export interface ApiOptions {
+    method?: HttpMethod;
+    headers?: Record<string, string>;
+    body?: unknown;
+}
+/**
+ * A functional API client that requires a base URL upon creation.
+ * Provides utility functions for making HTTP requests with query parameters,
+ * custom HTTP methods, headers, and request bodies.
+ */
+export declare const createApiClient: (basePath: string) => {
+    get: <T>(endpoint: string, queryParameters?: Record<string, string | number | boolean | null | undefined>) => Promise<T>;
+    post: <T>(endpoint: string, body?: unknown) => Promise<T>;
+    put: <T>(endpoint: string, body?: unknown) => Promise<T>;
+    delete: <T>(endpoint: string) => Promise<T>;
+};
+export declare const ApiClientUtils: {
+    createApiClient: (basePath: string) => {
+        get: <T>(endpoint: string, queryParameters?: Record<string, string | number | boolean | null | undefined>) => Promise<T>;
+        post: <T>(endpoint: string, body?: unknown) => Promise<T>;
+        put: <T>(endpoint: string, body?: unknown) => Promise<T>;
+        delete: <T>(endpoint: string) => Promise<T>;
+    };
+};

package/api/apiClientUtils.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiClientUtils = exports.createApiClient = void 0;
+/**
+ * A functional API client that requires a base URL upon creation.
+ * Provides utility functions for making HTTP requests with query parameters,
+ * custom HTTP methods, headers, and request bodies.
+ */
+const createApiClient = (basePath) => {
+    if (!basePath) {
+        throw new Error('Base path is required');
+    }
+    const sanitizedBasePath = basePath.replace(/\/$/, '');
+    const request = async (endpoint, options = {}, queryParameters = {}) => {
+        const { method = 'GET', headers, body } = options;
+        // Construct query string from queryParameters
+        const queryString = new URLSearchParams(Object.entries(queryParameters).reduce((acc, [key, value]) => {
+            if (value !== undefined) {
+                acc[key] = String(value);
+            }
+            return acc;
+        }, {})).toString();
+        // Append query string to endpoint if queryParameters exist
+        const url = queryString ? `${sanitizedBasePath}/${endpoint}?${queryString}` : `${sanitizedBasePath}/${endpoint}`;
+        if (method === 'GET' && body) {
+            throw new Error('GET requests cannot have a body');
+        }
+        const requestBody = body ? JSON.stringify(body) : undefined;
+        const response = await fetch(url, {
+            method,
+            headers: {
+                'Content-Type': 'application/json',
+                ...headers,
+            },
+            body: requestBody,
+        });
+        if (!response.ok) {
+            const errorData = await response.json();
+            throw new Error(`Request failed with status ${response.status}: ${JSON.stringify(errorData)}`);
+        }
+        // Handle no content for 202 or other no-body status codes
+        if (response.status === 202 || response.status === 204 || !response.headers.get('Content-Type')) {
+            return {};
+        }
+        return await response.json();
+    };
+    return {
+        get: (endpoint, queryParameters = {}) => request(endpoint, { method: 'GET' }, queryParameters),
+        post: (endpoint, body) => request(endpoint, { method: 'POST', body }),
+        put: (endpoint, body) => request(endpoint, { method: 'PUT', body }),
+        delete: (endpoint) => request(endpoint, { method: 'DELETE' }),
+    };
+};
+exports.createApiClient = createApiClient;
+exports.ApiClientUtils = { createApiClient: exports.createApiClient };

package/index.d.ts

@@ -3,4 +3,5 @@ export { ResultUtils } from "./result/resultUtils";
 export { HttpResultUtils } from "./result/httpResultUtils";
 export { DateUtils } from "./date/dateUtils";
 export { ValidationUtils } from "./validation/validationUtils";
+export { ApiClientUtils } from "./api/apiClientUtils";
 export type { ErrorResult, StandardError, Result, ErrorName };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ValidationUtils = exports.DateUtils = exports.HttpResultUtils = exports.ResultUtils = void 0;
+exports.ApiClientUtils = exports.ValidationUtils = exports.DateUtils = exports.HttpResultUtils = exports.ResultUtils = void 0;
 var resultUtils_1 = require("./result/resultUtils");
 Object.defineProperty(exports, "ResultUtils", { enumerable: true, get: function () { return resultUtils_1.ResultUtils; } });
 var httpResultUtils_1 = require("./result/httpResultUtils");
@@ -9,3 +9,5 @@ var dateUtils_1 = require("./date/dateUtils");
 Object.defineProperty(exports, "DateUtils", { enumerable: true, get: function () { return dateUtils_1.DateUtils; } });
 var validationUtils_1 = require("./validation/validationUtils");
 Object.defineProperty(exports, "ValidationUtils", { enumerable: true, get: function () { return validationUtils_1.ValidationUtils; } });
+var apiClientUtils_1 = require("./api/apiClientUtils");
+Object.defineProperty(exports, "ApiClientUtils", { enumerable: true, get: function () { return apiClientUtils_1.ApiClientUtils; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dexyn/common-library",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "main": "index.js",
   "repository": {
     "type": "git",