@veloxts/client 0.6.84 → 0.6.86

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @veloxts/client
 
+## 0.6.86
+
+### Patch Changes
+
+- updated documentation
+
+## 0.6.85
+
+### Patch Changes
+
+- implement missing features from original requirements
+
 ## 0.6.84
 
 ### Patch Changes

package/dist/client.js

@@ -208,7 +208,67 @@ function extractPathParams(path) {
 // Request Building
 // ============================================================================
 /**
- * Resolves both method and path for a procedure call
+ * Detects client mode from configuration
+ *
+ * Auto-detects 'trpc' mode if baseUrl ends with '/trpc'
+ *
+ * @internal
+ */
+function detectMode(config) {
+    if (config.mode) {
+        return config.mode;
+    }
+    // Auto-detect: if baseUrl ends with /trpc, use tRPC mode
+    return config.baseUrl.endsWith('/trpc') ? 'trpc' : 'rest';
+}
+/**
+ * Determines if a procedure is a query based on naming convention
+ *
+ * @internal
+ */
+function isQueryProcedure(procedureName) {
+    return (procedureName.startsWith('get') ||
+        procedureName.startsWith('list') ||
+        procedureName.startsWith('find'));
+}
+/**
+ * Builds a tRPC-compatible request
+ *
+ * - Queries: GET /trpc/namespace.procedure?input={encoded json}
+ * - Mutations: POST /trpc/namespace.procedure with JSON body
+ *
+ * @internal
+ */
+function buildTrpcRequest(call, baseUrl, headers) {
+    const procedurePath = `${call.namespace}.${call.procedureName}`;
+    const isQuery = isQueryProcedure(call.procedureName);
+    if (isQuery) {
+        // GET request with input as query parameter
+        let url = `${baseUrl}/${procedurePath}`;
+        if (call.input != null) {
+            const inputParam = encodeURIComponent(JSON.stringify(call.input));
+            url = `${url}?input=${inputParam}`;
+        }
+        return {
+            url,
+            options: {
+                method: 'GET',
+                headers,
+            },
+        };
+    }
+    // POST request with input as JSON body
+    return {
+        url: `${baseUrl}/${procedurePath}`,
+        options: {
+            method: 'POST',
+            headers,
+            body: call.input != null ? JSON.stringify(call.input) : undefined,
+        },
+    };
+}
+/**
+ * Resolves both method and path for a procedure call (REST mode)
  *
  * Uses explicit route mapping if available, otherwise falls back to naming convention.
  *
@@ -228,16 +288,26 @@ function resolveMethodAndPath(namespace, procedureName, routes) {
 /**
  * Builds the full URL and request options for a procedure call
  *
+ * Supports two modes:
+ * - REST: RESTful paths based on naming conventions
+ * - tRPC: tRPC-compatible paths with namespace.procedure format
+ *
  * @internal
  */
 function buildRequest(call, baseUrl, config) {
-    const { method, path } = resolveMethodAndPath(call.namespace, call.procedureName, config.routes);
     // Prepare headers - support both static object and dynamic function
     const customHeaders = typeof config.headers === 'function' ? config.headers() : (config.headers ?? {});
     const headers = {
         'Content-Type': 'application/json',
         ...customHeaders,
     };
+    // Detect mode and route accordingly
+    const mode = detectMode(config);
+    if (mode === 'trpc') {
+        return buildTrpcRequest(call, baseUrl, headers);
+    }
+    // REST mode
+    const { method, path } = resolveMethodAndPath(call.namespace, call.procedureName, config.routes);
     let finalPath = path;
     let body;
     // Handle input based on method

package/dist/index.d.ts

@@ -21,7 +21,7 @@
  * @module @veloxts/client
  */
 export { createClient } from './client.js';
-export type { ClientConfig, ClientError, ClientFromCollection, ClientFromRouter, ClientProcedure, HttpMethod, InferProcedureInput, InferProcedureOutput, ProcedureCall, ProcedureCollection, ProcedureRecord, } from './types.js';
+export type { ClientConfig, ClientError, ClientFromCollection, ClientFromRouter, ClientMode, ClientProcedure, HttpMethod, InferProcedureInput, InferProcedureOutput, ProcedureCall, ProcedureCollection, ProcedureRecord, } from './types.js';
 export { ClientNotFoundError, ClientValidationError, NetworkError, ServerError, VeloxClientError, } from './errors.js';
 export { isClientNotFoundError, isClientValidationError, isNetworkError, isNotFoundErrorResponse, isServerError, isValidationErrorResponse, isVeloxClientError, } from './errors.js';
 export type { ErrorResponse } from './errors.js';

package/dist/types.d.ts

@@ -173,12 +173,34 @@ export interface RouteEntry {
  * ```
  */
 export type RouteMap = Record<string, Record<string, RouteEntry | string>>;
+/**
+ * Client mode determines how URLs are generated
+ *
+ * - `'rest'` - RESTful URLs based on naming conventions (e.g., GET /users/:id)
+ * - `'trpc'` - tRPC-compatible URLs (e.g., GET /trpc/users.getUser?input={...})
+ */
+export type ClientMode = 'rest' | 'trpc';
 /**
  * Configuration for creating a client instance
  */
 export interface ClientConfig {
     /** Base URL for API requests (e.g., 'https://api.example.com' or '/api') */
     baseUrl: string;
+    /**
+     * Client mode: 'rest' or 'trpc'
+     *
+     * - `'rest'` - Generates RESTful paths based on naming conventions
+     *   e.g., `getUser` → `GET /users/:id`, `createUser` → `POST /users`
+     *
+     * - `'trpc'` - Generates tRPC-compatible paths
+     *   e.g., `getUser` → `GET /trpc/users.getUser?input={...}`
+     *   e.g., `createUser` → `POST /trpc/users.createUser` with JSON body
+     *
+     * Auto-detected if not specified:
+     * - If `baseUrl` ends with '/trpc', defaults to 'trpc'
+     * - Otherwise defaults to 'rest'
+     */
+    mode?: ClientMode;
     /**
      * Optional custom headers to include in all requests
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veloxts/client",
-  "version": "0.6.84",
+  "version": "0.6.86",
   "description": "Type-safe frontend API client for VeloxTS framework",
   "type": "module",
   "main": "dist/index.js",