@dexyn/common-library 1.0.9 → 1.0.10

package/api/apiClientUtils.d.ts

@@ -10,16 +10,19 @@ export interface ApiOptions {
  * 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>;
+    get: <T>(endpoint: string, queryParameters?: Record<string, string | number | boolean | null | undefined>, pathParameters?: Record<string, string>) => Promise<T>;
+    post: <T>(endpoint: string, body?: unknown, pathParameters?: Record<string, string>) => Promise<T>;
+    put: <T>(endpoint: string, body?: unknown, pathParameters?: Record<string, string>) => Promise<T>;
+    delete: <T>(endpoint: string, pathParameters?: Record<string, string>) => Promise<T>;
 };
+declare function resolveUrl(template: string, params: Record<string, string>): string;
 export declare const ApiClientUtils: {
+    resolveUrl: typeof resolveUrl;
     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>;
+        get: <T>(endpoint: string, queryParameters?: Record<string, string | number | boolean | null | undefined>, pathParameters?: Record<string, string>) => Promise<T>;
+        post: <T>(endpoint: string, body?: unknown, pathParameters?: Record<string, string>) => Promise<T>;
+        put: <T>(endpoint: string, body?: unknown, pathParameters?: Record<string, string>) => Promise<T>;
+        delete: <T>(endpoint: string, pathParameters?: Record<string, string>) => Promise<T>;
     };
 };
+export {};

package/api/apiClientUtils.js

@@ -11,8 +11,11 @@ const createApiClient = (basePath) => {
         throw new Error('Base path is required');
     }
     const sanitizedBasePath = basePath.replace(/\/$/, '');
-    const request = async (endpoint, options = {}, queryParameters = {}) => {
+    const request = async (endpoint, options = {}, queryParameters = {}, pathParameters = {} // New parameter for path placeholders
+    ) => {
         const { method = 'GET', headers, body } = options;
+        // Resolve the URL template with path parameters
+        const resolvedEndpoint = resolveUrl(endpoint, pathParameters);
         // Construct query string from queryParameters
         const queryString = new URLSearchParams(Object.entries(queryParameters).reduce((acc, [key, value]) => {
             if (value !== undefined) {
@@ -21,7 +24,7 @@ const createApiClient = (basePath) => {
             return acc;
         }, {})).toString();
         // Append query string to endpoint if queryParameters exist
-        const url = queryString ? `${sanitizedBasePath}/${endpoint}?${queryString}` : `${sanitizedBasePath}/${endpoint}`;
+        const url = queryString ? `${sanitizedBasePath}/${resolvedEndpoint}?${queryString}` : `${sanitizedBasePath}/${resolvedEndpoint}`;
         if (method === 'GET' && body) {
             throw new Error('GET requests cannot have a body');
         }
@@ -45,11 +48,19 @@ const createApiClient = (basePath) => {
         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' }),
+        get: (endpoint, queryParameters = {}, pathParameters = {}) => request(endpoint, { method: 'GET' }, queryParameters, pathParameters),
+        post: (endpoint, body, pathParameters = {}) => request(endpoint, { method: 'POST', body }, pathParameters),
+        put: (endpoint, body, pathParameters = {}) => request(endpoint, { method: 'PUT', body }, pathParameters),
+        delete: (endpoint, pathParameters = {}) => request(endpoint, { method: 'DELETE' }),
     };
 };
 exports.createApiClient = createApiClient;
-exports.ApiClientUtils = { createApiClient: exports.createApiClient };
+function resolveUrl(template, params) {
+    return template.replace(/:([a-zA-Z_]+)/g, (_, key) => {
+        if (!params[key]) {
+            throw new Error(`Missing path parameter: ${key}`);
+        }
+        return params[key];
+    });
+}
+exports.ApiClientUtils = { resolveUrl, createApiClient: exports.createApiClient };

package/package.json

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