refactor: use brackets [] to define path params instead of :

Author: minosss

packages/api/src/client/middleware/replacePathParams.ts

@@ -29,14 +29,15 @@ export function replacePathParams(
     };
     const { excludePathParams = true } = options;
     // replace url params with input
-    const params = req.url.match(/:\w+/g);
+    const params = req.url.match(/\[\w+\]/g);
 
     if (params) {
       req.rawUrl = req.url;
 
       let nextUrl = req.url;
       for (const param of params) {
-        const key = param.slice(1);
+        // remove brackets
+        const key = param.slice(1, -1);
         if (isObject(req.input)) {
           const value = req.input[key];
           if (typeof value === 'number' || typeof value === 'string') {

packages/api/src/types.ts

@@ -45,17 +45,33 @@ export type AnyObject = Record<string, any>;
 export type AnyAsyncFn<R = any> = (...args: any[]) => Promise<R>;
 
 export type ApiRequest = {
+  /**
+   * input of the api
+   */
   input: unknown;
+
+  /**
+   * parsed input, should be set after validation
+   */
   parsedInput: unknown;
 };
 
 export type ApiResponse = {
+  /**
+   * output of the api, can be anything except `undefined`.
+   */
   output: unknown;
-  ok: boolean;
 };
 
 export type HttpRequest = {
+  /**
+   * http method, e.g. 'GET', 'POST', 'PUT', 'DELETE'
+   */
   method: string;
+
+  /**
+   * http url
+   */
   url: string;
 };
 
@@ -78,12 +94,10 @@ export type Options = {
 };
 
 /**
- * convert 'users/:id' to { id: string }
+ * convert 'users/[id]' to { id: string }
  */
 export type ExtractPathParams<U extends string> =
-  U extends `${string}:${infer P}/${infer R}`
+  U extends `${string}[${infer P}]${infer R}`
     ? { [K in P | keyof ExtractPathParams<R>]: string | number }
-    : U extends `${string}:${infer P}`
-      ? { [K in P]: string | number }
-      : // biome-ignore lint/suspicious/noConfusingVoidType: <explanation>
-        void;
+    : // biome-ignore lint/suspicious/noConfusingVoidType: <explanation>
+      void;

readme.md

@@ -37,7 +37,7 @@ const api = new ApiClient({
   },
   middlewares: [
     logger(),
-    // replace path params from input. e.g. /users/:id to /users/1
+    // replace path params from input. e.g. /users/[id] to /users/1
     replacePathParams(),
   ],
 });