ts-typed-api 0.2.15 → 0.2.16

package/dist/client.d.ts

@@ -128,6 +128,18 @@ export declare class ApiClient<TActualDef extends BaseApiDefinitionSchema> {
      * @returns The base URL with prefix applied.
      */
     private getBaseUrlWithPrefix;
+    /**
+     * Generates the full URL for a specific route, incorporating path parameters and query parameters.
+     * @template TDomain The domain (controller) of the API.
+     * @template TRouteKey The key of the route within the domain.
+     * @param domain The API domain (e.g., 'user').
+     * @param routeKey The API route key (e.g., 'getUsers').
+     * @param params Optional path parameters to replace in the route path.
+     * @param query Optional query parameters to append to the URL.
+     * @returns The full URL as a string.
+     * @throws Error if the route configuration is invalid.
+     */
+    generateUrl<TDomain extends keyof TActualDef['endpoints'], TRouteKey extends keyof TActualDef['endpoints'][TDomain]>(domain: TDomain, routeKey: TRouteKey, params?: ApiClientParams<TActualDef, TDomain, TRouteKey>, query?: ApiClientQuery<TActualDef, TDomain, TRouteKey>): string;
     /**
      * Makes an API call to a specified domain and route.
      * @template TDomain The domain (controller) of the API.

package/dist/client.js

@@ -88,6 +88,42 @@ class ApiClient {
         }
         return this.baseUrl;
     }
+    /**
+     * Generates the full URL for a specific route, incorporating path parameters and query parameters.
+     * @template TDomain The domain (controller) of the API.
+     * @template TRouteKey The key of the route within the domain.
+     * @param domain The API domain (e.g., 'user').
+     * @param routeKey The API route key (e.g., 'getUsers').
+     * @param params Optional path parameters to replace in the route path.
+     * @param query Optional query parameters to append to the URL.
+     * @returns The full URL as a string.
+     * @throws Error if the route configuration is invalid.
+     */
+    generateUrl(domain, routeKey, params, query) {
+        const routeInfo = this.apiDefinitionObject.endpoints[domain][routeKey];
+        if (!routeInfo || typeof routeInfo.path !== 'string') {
+            throw new Error(`API route configuration ${String(domain)}.${String(routeKey)} not found or invalid.`);
+        }
+        let urlPath = routeInfo.path;
+        if (params) {
+            const paramsRecord = params;
+            for (const key in paramsRecord) {
+                if (Object.prototype.hasOwnProperty.call(paramsRecord, key) && paramsRecord[key] !== undefined) {
+                    urlPath = urlPath.replace(`:${key}`, String(paramsRecord[key]));
+                }
+            }
+        }
+        const url = new URL(this.getBaseUrlWithPrefix() + urlPath);
+        if (query) {
+            const queryRecord = query;
+            for (const key in queryRecord) {
+                if (Object.prototype.hasOwnProperty.call(queryRecord, key) && queryRecord[key] !== undefined) {
+                    url.searchParams.append(key, String(queryRecord[key]));
+                }
+            }
+        }
+        return url.toString();
+    }
     /**
      * Makes an API call to a specified domain and route.
      * @template TDomain The domain (controller) of the API.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-typed-api",
-  "version": "0.2.15",
+  "version": "0.2.16",
   "description": "A lightweight, type-safe RPC library for TypeScript with Zod validation",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/client.ts

@@ -216,6 +216,56 @@ export class ApiClient<TActualDef extends BaseApiDefinitionSchema> { // Made gen
         return this.baseUrl;
     }
 
+    /**
+     * Generates the full URL for a specific route, incorporating path parameters and query parameters.
+     * @template TDomain The domain (controller) of the API.
+     * @template TRouteKey The key of the route within the domain.
+     * @param domain The API domain (e.g., 'user').
+     * @param routeKey The API route key (e.g., 'getUsers').
+     * @param params Optional path parameters to replace in the route path.
+     * @param query Optional query parameters to append to the URL.
+     * @returns The full URL as a string.
+     * @throws Error if the route configuration is invalid.
+     */
+    public generateUrl<
+        TDomain extends keyof TActualDef['endpoints'],
+        TRouteKey extends keyof TActualDef['endpoints'][TDomain]
+    >(
+        domain: TDomain,
+        routeKey: TRouteKey,
+        params?: ApiClientParams<TActualDef, TDomain, TRouteKey>,
+        query?: ApiClientQuery<TActualDef, TDomain, TRouteKey>
+    ): string {
+        const routeInfo = this.apiDefinitionObject.endpoints[domain as string][routeKey as string] as RouteSchema;
+
+        if (!routeInfo || typeof routeInfo.path !== 'string') {
+            throw new Error(`API route configuration ${String(domain)}.${String(routeKey)} not found or invalid.`);
+        }
+
+        let urlPath = routeInfo.path;
+        if (params) {
+            const paramsRecord = params as Record<string, string | number | boolean>;
+            for (const key in paramsRecord) {
+                if (Object.prototype.hasOwnProperty.call(paramsRecord, key) && paramsRecord[key] !== undefined) {
+                    urlPath = urlPath.replace(`:${key}`, String(paramsRecord[key]));
+                }
+            }
+        }
+
+        const url = new URL(this.getBaseUrlWithPrefix() + urlPath);
+
+        if (query) {
+            const queryRecord = query as Record<string, any>;
+            for (const key in queryRecord) {
+                if (Object.prototype.hasOwnProperty.call(queryRecord, key) && queryRecord[key] !== undefined) {
+                    url.searchParams.append(key, String(queryRecord[key]));
+                }
+            }
+        }
+
+        return url.toString();
+    }
+
     /**
      * Makes an API call to a specified domain and route.
      * @template TDomain The domain (controller) of the API.

package/tests/simple-api.test.ts

@@ -107,6 +107,26 @@ describe.each([
             expect(customHeader).toBe('test-value');
             expect(anotherHeader).toBe('another-value');
         });
+
+        test('generateUrl should return correct URL for ping', () => {
+            const url = client.generateUrl('common', 'ping');
+            expect(url).toBe(`${baseUrl}/api/v1/public/ping`);
+        });
+
+        test('generateUrl should return correct URL for probe1 without query', () => {
+            const url = client.generateUrl('status', 'probe1');
+            expect(url).toBe(`${baseUrl}/api/v1/public/status/probe1`);
+        });
+
+        test('generateUrl should return correct URL for probe1 with query', () => {
+            const url = client.generateUrl('status', 'probe1', undefined, { match: true });
+            expect(url).toBe(`${baseUrl}/api/v1/public/status/probe1?match=true`);
+        });
+
+        test('generateUrl should return correct URL for probe2', () => {
+            const url = client.generateUrl('status', 'probe2');
+            expect(url).toBe(`${baseUrl}/api/v1/public/status/probe2`);
+        });
     });
 
     describe('Private API', () => {
@@ -127,6 +147,11 @@ describe.each([
 
             expect(result).toBe('ok');
         });
+
+        test('generateUrl should return correct URL for user get with params', () => {
+            const url = client.generateUrl('user', 'get', { id: 'test-id' });
+            expect(url).toBe(`${baseUrl}/api/v1/private/user/test-id`);
+        });
     });
 
     describe('Strict Validation Tests', () => {