ts-procedures 2.0.1 → 2.1.1

package/build/implementations/http/express-rpc/index.d.ts

@@ -3,6 +3,20 @@ import { TProcedureRegistration } from '../../../index.js';
 import { RPCConfig, RPCHttpRouteDoc } from '../../types.js';
 import { ExtractContext, ProceduresFactory } from './types.js';
 export type { RPCConfig, RPCHttpRouteDoc };
+export type ExpressRPCAppBuilderConfig = {
+    /**
+     * An existing Express application instance to use.
+     * When provided, ensure to set up necessary middleware (e.g., json/body parser) beforehand.
+     * If not provided, a new instance will be created.
+     */
+    app?: express.Express;
+    /** Optional path prefix for all RPC routes. */
+    pathPrefix?: string;
+    onRequestStart?: (req: express.Request) => void;
+    onRequestEnd?: (req: express.Request, res: express.Response) => void;
+    onSuccess?: (procedure: TProcedureRegistration, req: express.Request, res: express.Response) => void;
+    error?: (procedure: TProcedureRegistration, req: express.Request, res: express.Response, error: Error) => void;
+};
 /**
  * Builder class for creating an Express application with RPC routes.
  *
@@ -19,46 +33,43 @@ export type { RPCConfig, RPCHttpRouteDoc };
  *   const docs = rpcApp.docs; // RPC route documentation
  */
 export declare class ExpressRPCAppBuilder {
-    readonly config?: {
-        /**
-         * An existing Express application instance to use.
-         * When provided, ensure to set up necessary middleware (e.g., json/body parser) beforehand.
-         * If not provided, a new instance will be created.
-         */
-        app?: express.Express;
-        onRequestStart?: (req: express.Request) => void;
-        onRequestEnd?: (req: express.Request, res: express.Response) => void;
-        onSuccess?: (procedure: TProcedureRegistration, req: express.Request, res: express.Response) => void;
-        error?: (procedure: TProcedureRegistration, req: express.Request, res: express.Response, error: Error) => void;
-    } | undefined;
+    readonly config?: ExpressRPCAppBuilderConfig | undefined;
     /**
      * Constructor for ExpressRPCAppBuilder.
      *
      * @param config
      */
-    constructor(config?: {
-        /**
-         * An existing Express application instance to use.
-         * When provided, ensure to set up necessary middleware (e.g., json/body parser) beforehand.
-         * If not provided, a new instance will be created.
-         */
-        app?: express.Express;
-        onRequestStart?: (req: express.Request) => void;
-        onRequestEnd?: (req: express.Request, res: express.Response) => void;
-        onSuccess?: (procedure: TProcedureRegistration, req: express.Request, res: express.Response) => void;
-        error?: (procedure: TProcedureRegistration, req: express.Request, res: express.Response, error: Error) => void;
-    } | undefined);
+    constructor(config?: ExpressRPCAppBuilderConfig | undefined);
+    /**
+     * Generates the RPC route path based on the RPC configuration.
+     * The RPCConfig name can be a string or an array of strings to form nested paths.
+     *
+     * Example
+     *  name: ['string', 'string-string', 'string']
+     *  path: /string/string-string/string/version
+     * @param config
+     */
+    static makeRPCHttpRoutePath({ config, prefix }: {
+        prefix?: string;
+        config: RPCConfig;
+    }): string;
+    /**
+     * Instance method wrapper for makeRPCHttpRoutePath that uses the builder's pathPrefix.
+     * @param config - The RPC configuration
+     */
+    makeRPCHttpRoutePath(config: RPCConfig): string;
     private factories;
     private _app;
     private _docs;
     get app(): express.Express;
     get docs(): RPCHttpRouteDoc[];
     /**
-     * Registers a procedure factory with its context resolver.
-     * @param factory
-     * @param contextResolver
+     * Registers a procedure factory with its context.
+     * @param factory - The procedure factory created by Procedures<Context, RPCConfig>()
+     * @param factoryContext - The context for procedure handlers. Can be a direct value,
+     *                         a sync function (req) => Context, or an async function (req) => Promise<Context>
      */
-    register<TFactory extends ProceduresFactory>(factory: TFactory, contextResolver: (req: express.Request) => ExtractContext<TFactory>): this;
+    register<TFactory extends ProceduresFactory>(factory: TFactory, factoryContext: ExtractContext<TFactory> | ((req: express.Request) => ExtractContext<TFactory> | Promise<ExtractContext<TFactory>>)): this;
     /**
      * Builds and returns the Express application with registered RPC routes.
      * @return express.Application
@@ -68,15 +79,5 @@ export declare class ExpressRPCAppBuilder {
      * Generates the RPC HTTP route for the given procedure.
      * @param procedure
      */
-    buildRpcHttpRouteDoc(procedure: TProcedureRegistration<any, RPCConfig>): RPCHttpRouteDoc;
-    /**
-     * Generates the RPC route path based on the RPC configuration.
-     * The RPCConfig name can be a string or an array of strings to form nested paths.
-     *
-     * Example
-     *  name: ['string', 'string-string', 'string']
-     *  path: /rpc/string/string-string/string/version
-     * @param config
-     */
-    makeRPCHttpRoutePath(config: RPCConfig): string;
+    private buildRpcHttpRouteDoc;
 }

package/build/implementations/http/express-rpc/index.js

@@ -47,6 +47,31 @@ export class ExpressRPCAppBuilder {
             });
         }
     }
+    /**
+     * Generates the RPC route path based on the RPC configuration.
+     * The RPCConfig name can be a string or an array of strings to form nested paths.
+     *
+     * Example
+     *  name: ['string', 'string-string', 'string']
+     *  path: /string/string-string/string/version
+     * @param config
+     */
+    static makeRPCHttpRoutePath({ config, prefix }) {
+        const normalizedPrefix = prefix
+            ? (prefix.startsWith('/') ? prefix : `/${prefix}`)
+            : '';
+        return `${normalizedPrefix}/${castArray(config.name).map(kebabCase).join('/')}/${String(config.version).trim()}`;
+    }
+    /**
+     * Instance method wrapper for makeRPCHttpRoutePath that uses the builder's pathPrefix.
+     * @param config - The RPC configuration
+     */
+    makeRPCHttpRoutePath(config) {
+        return ExpressRPCAppBuilder.makeRPCHttpRoutePath({
+            config,
+            prefix: this.config?.pathPrefix,
+        });
+    }
     factories = [];
     _app = express();
     _docs = [];
@@ -57,12 +82,13 @@ export class ExpressRPCAppBuilder {
         return this._docs;
     }
     /**
-     * Registers a procedure factory with its context resolver.
-     * @param factory
-     * @param contextResolver
+     * Registers a procedure factory with its context.
+     * @param factory - The procedure factory created by Procedures<Context, RPCConfig>()
+     * @param factoryContext - The context for procedure handlers. Can be a direct value,
+     *                         a sync function (req) => Context, or an async function (req) => Promise<Context>
      */
-    register(factory, contextResolver) {
-        this.factories.push({ factory, contextResolver });
+    register(factory, factoryContext) {
+        this.factories.push({ factory, factoryContext });
         return this;
     }
     /**
@@ -70,13 +96,16 @@ export class ExpressRPCAppBuilder {
      * @return express.Application
      */
     build() {
-        this.factories.forEach(({ factory, contextResolver }) => {
+        this.factories.forEach(({ factory, factoryContext }) => {
             factory.getProcedures().map((procedure) => {
                 const route = this.buildRpcHttpRouteDoc(procedure);
                 this._docs.push(route);
                 this._app[route.method](route.path, async (req, res) => {
                     try {
-                        res.json(await procedure.handler(contextResolver(req), req.body));
+                        const context = typeof factoryContext === 'function'
+                            ? await factoryContext(req)
+                            : factoryContext;
+                        res.json(await procedure.handler(context, req.body));
                         if (this.config?.onSuccess) {
                             this.config.onSuccess(procedure, req, res);
                         }
@@ -109,7 +138,10 @@ export class ExpressRPCAppBuilder {
      */
     buildRpcHttpRouteDoc(procedure) {
         const { config } = procedure;
-        const path = this.makeRPCHttpRoutePath(config);
+        const path = ExpressRPCAppBuilder.makeRPCHttpRoutePath({
+            config,
+            prefix: this.config?.pathPrefix,
+        });
         const method = 'post'; // RPCs use POST method
         const jsonSchema = {};
         if (config.schema?.params) {
@@ -124,17 +156,5 @@ export class ExpressRPCAppBuilder {
             jsonSchema,
         };
     }
-    /**
-     * Generates the RPC route path based on the RPC configuration.
-     * The RPCConfig name can be a string or an array of strings to form nested paths.
-     *
-     * Example
-     *  name: ['string', 'string-string', 'string']
-     *  path: /rpc/string/string-string/string/version
-     * @param config
-     */
-    makeRPCHttpRoutePath(config) {
-        return `/rpc/${castArray(config.name).map(kebabCase).join('/')}/${String(config.version).trim()}`;
-    }
 }
 //# sourceMappingURL=index.js.map

package/build/implementations/http/express-rpc/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/implementations/http/express-rpc/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAG7C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAI7C;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,oBAAoB;IAOpB;IANX;;;;OAIG;IACH,YACW,MAoBR;QApBQ,WAAM,GAAN,MAAM,CAoBd;QAED,IAAI,MAAM,EAAE,GAAG,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,GAAG,CAAA;QACxB,CAAC;aAAM,CAAC;YACN,2CAA2C;YAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;QAC/B,CAAC;QAED,IAAI,MAAM,EAAE,cAAc,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;gBAC/B,MAAM,CAAC,cAAe,CAAC,GAAG,CAAC,CAAA;gBAC3B,IAAI,EAAE,CAAA;YACR,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,MAAM,EAAE,YAAY,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;gBAC/B,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;oBACpB,MAAM,CAAC,YAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;gBAChC,CAAC,CAAC,CAAA;gBACF,IAAI,EAAE,CAAA;YACR,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAEO,SAAS,GAA8B,EAAE,CAAA;IAEzC,IAAI,GAAoB,OAAO,EAAE,CAAA;IACjC,KAAK,GAAsB,EAAE,CAAA;IAErC,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED;;;;OAIG;IACH,QAAQ,CACN,OAAiB,EACjB,eAAmE;QAEnE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,eAAe,EAA6B,CAAC,CAAA;QAC5E,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,EAAE,EAAE;YACtD,OAAO,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,SAAiD,EAAE,EAAE;gBAChF,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAA;gBAElD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;gBAEtB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;oBACrD,IAAI,CAAC;wBACH,GAAG,CAAC,IAAI,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;wBACjE,IAAI,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC;4BAC3B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;wBAC5C,CAAC;wBACD,gCAAgC;wBAChC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;4BAChB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;wBACjB,CAAC;oBACH,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,IAAI,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;4BACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,KAAc,CAAC,CAAA;4BACtD,OAAM;wBACR,CAAC;wBACD,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;4BAChB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;wBACjB,CAAC;wBACD,gDAAgD;wBAChD,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;4BACrB,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAG,KAAe,CAAC,OAAO,EAAE,CAAC,CAAA;wBAC/C,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED;;;OAGG;IACH,oBAAoB,CAAC,SAAiD;QACpE,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAA;QAC9C,MAAM,MAAM,GAAG,MAAM,CAAA,CAAC,uBAAuB;QAC7C,MAAM,UAAU,GAAyC,EAAE,CAAA;QAE3D,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;YAC1B,UAAU,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAA;QACxC,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC;YAC9B,UAAU,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAA;QAChD,CAAC;QAED,OAAO;YACL,IAAI;YACJ,MAAM;YACN,UAAU;SACX,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,oBAAoB,CAAC,MAAiB;QACpC,OAAO,QAAQ,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAA;IACnG,CAAC;CACF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/implementations/http/express-rpc/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAG7C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AA6B7C;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,oBAAoB;IAMV;IALrB;;;;OAIG;IACH,YAAqB,MAAmC;QAAnC,WAAM,GAAN,MAAM,CAA6B;QACtD,IAAI,MAAM,EAAE,GAAG,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,GAAG,CAAA;QACxB,CAAC;aAAM,CAAC;YACN,2CAA2C;YAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;QAC/B,CAAC;QAED,IAAI,MAAM,EAAE,cAAc,EAAE,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;gBAC/B,MAAM,CAAC,cAAe,CAAC,GAAG,CAAC,CAAA;gBAC3B,IAAI,EAAE,CAAA;YACR,CAAC,CAAC,CAAA;QACJ,CAAC;QAED,IAAI,MAAM,EAAE,YAAY,EAAE,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;gBAC/B,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;oBACpB,MAAM,CAAC,YAAa,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;gBAChC,CAAC,CAAC,CAAA;gBACF,IAAI,EAAE,CAAA;YACR,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE,MAAM,EAA0C;QACpF,MAAM,gBAAgB,GAAG,MAAM;YAC7B,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;YAClD,CAAC,CAAC,EAAE,CAAA;QAEN,OAAO,GAAG,gBAAgB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAA;IAClH,CAAC;IAED;;;OAGG;IACH,oBAAoB,CAAC,MAAiB;QACpC,OAAO,oBAAoB,CAAC,oBAAoB,CAAC;YAC/C,MAAM;YACN,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,UAAU;SAChC,CAAC,CAAA;IACJ,CAAC;IAEO,SAAS,GAA8B,EAAE,CAAA;IAEzC,IAAI,GAAoB,OAAO,EAAE,CAAA;IACjC,KAAK,GAAsB,EAAE,CAAA;IAErC,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAA;IACnB,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CACN,OAAiB,EACjB,cAE4F;QAE5F,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,cAAc,EAA6B,CAAC,CAAA;QAC3E,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,EAAE,EAAE;YACrD,OAAO,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,SAAiD,EAAE,EAAE;gBAChF,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAA;gBAElD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;gBAEtB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;oBACrD,IAAI,CAAC;wBACH,MAAM,OAAO,GACX,OAAO,cAAc,KAAK,UAAU;4BAClC,CAAC,CAAC,MAAM,cAAc,CAAC,GAAG,CAAC;4BAC3B,CAAC,CAAE,cAAiD,CAAA;wBAExD,GAAG,CAAC,IAAI,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;wBACpD,IAAI,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC;4BAC3B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;wBAC5C,CAAC;wBACD,gCAAgC;wBAChC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;4BAChB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;wBACjB,CAAC;oBACH,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,IAAI,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;4BACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,KAAc,CAAC,CAAA;4BACtD,OAAM;wBACR,CAAC;wBACD,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;4BAChB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;wBACjB,CAAC;wBACD,gDAAgD;wBAChD,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;4BACrB,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,EAAG,KAAe,CAAC,OAAO,EAAE,CAAC,CAAA;wBAC/C,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED;;;OAGG;IACK,oBAAoB,CAAC,SAAiD;QAC5E,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,CAAA;QAC5B,MAAM,IAAI,GAAG,oBAAoB,CAAC,oBAAoB,CAAC;YACrD,MAAM;YACN,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,UAAU;SAChC,CAAC,CAAA;QACF,MAAM,MAAM,GAAG,MAAM,CAAA,CAAC,uBAAuB;QAC7C,MAAM,UAAU,GAAyC,EAAE,CAAA;QAE3D,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;YAC1B,UAAU,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAA;QACxC,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC;YAC9B,UAAU,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,CAAA;QAChD,CAAC;QAED,OAAO;YACL,IAAI;YACJ,MAAM;YACN,UAAU;SACX,CAAA;IACH,CAAC;CACF"}

package/build/implementations/http/express-rpc/index.test.js

@@ -8,7 +8,7 @@ import { ExpressRPCAppBuilder } from './index.js';
  * ExpressRPCAppBuilder Test Suite
  *
  * Tests the RPC-style Express integration for ts-procedures.
- * This builder creates POST routes at `/rpc/{name}/{version}` paths.
+ * This builder creates POST routes at `/{name}/{version}` paths (with optional pathPrefix).
  */
 describe('ExpressRPCAppBuilder', () => {
     // --------------------------------------------------------------------------
@@ -22,7 +22,7 @@ describe('ExpressRPCAppBuilder', () => {
             builder.register(RPC, () => ({ userId: '123' }));
             const app = builder.build();
             // JSON body should be parsed automatically
-            const res = await request(app).post('/rpc/echo/1').send({ message: 'hello' });
+            const res = await request(app).post('/echo/1').send({ message: 'hello' });
             expect(res.status).toBe(200);
             expect(res.body).toEqual({ message: 'hello' });
         });
@@ -36,7 +36,7 @@ describe('ExpressRPCAppBuilder', () => {
             const app = builder.build();
             // Without json middleware, body won't be parsed (req.body is undefined)
             const res = await request(app)
-                .post('/rpc/echo/1')
+                .post('/echo/1')
                 .set('Content-Type', 'application/json')
                 .send(JSON.stringify({ message: 'hello' }));
             // Request body is undefined since json middleware wasn't added
@@ -55,6 +55,57 @@ describe('ExpressRPCAppBuilder', () => {
         });
     });
     // --------------------------------------------------------------------------
+    // pathPrefix Option Tests
+    // --------------------------------------------------------------------------
+    describe('pathPrefix option', () => {
+        test('uses custom pathPrefix for all routes', async () => {
+            const builder = new ExpressRPCAppBuilder({ pathPrefix: '/api/v1' });
+            const RPC = Procedures();
+            RPC.Create('Test', { name: 'test', version: 1 }, async () => ({ ok: true }));
+            builder.register(RPC, () => ({}));
+            const app = builder.build();
+            const res = await request(app).post('/api/v1/test/1').send({});
+            expect(res.status).toBe(200);
+            expect(res.body).toEqual({ ok: true });
+        });
+        test('pathPrefix without leading slash gets normalized', async () => {
+            const builder = new ExpressRPCAppBuilder({ pathPrefix: 'custom' });
+            const RPC = Procedures();
+            RPC.Create('Test', { name: 'test', version: 1 }, async () => ({ ok: true }));
+            builder.register(RPC, () => ({}));
+            const app = builder.build();
+            const res = await request(app).post('/custom/test/1').send({});
+            expect(res.status).toBe(200);
+        });
+        test('no prefix when pathPrefix not specified', async () => {
+            const builder = new ExpressRPCAppBuilder();
+            const RPC = Procedures();
+            RPC.Create('Test', { name: 'test', version: 1 }, async () => ({ ok: true }));
+            builder.register(RPC, () => ({}));
+            const app = builder.build();
+            const res = await request(app).post('/test/1').send({});
+            expect(res.status).toBe(200);
+        });
+        test('pathPrefix appears in generated docs', () => {
+            const builder = new ExpressRPCAppBuilder({ pathPrefix: '/api' });
+            const RPC = Procedures();
+            RPC.Create('Test', { name: 'test', version: 1 }, async () => ({}));
+            builder.register(RPC, () => ({}));
+            builder.build();
+            expect(builder.docs[0].path).toBe('/api/test/1');
+        });
+        test('pathPrefix /rpc restores original behavior', async () => {
+            const builder = new ExpressRPCAppBuilder({ pathPrefix: '/rpc' });
+            const RPC = Procedures();
+            RPC.Create('Users', { name: 'users', version: 1 }, async () => ({ users: [] }));
+            builder.register(RPC, () => ({}));
+            const app = builder.build();
+            const res = await request(app).post('/rpc/users/1').send({});
+            expect(res.status).toBe(200);
+            expect(builder.docs[0].path).toBe('/rpc/users/1');
+        });
+    });
+    // --------------------------------------------------------------------------
     // Lifecycle Hooks Tests
     // --------------------------------------------------------------------------
     describe('lifecycle hooks', () => {
@@ -65,10 +116,10 @@ describe('ExpressRPCAppBuilder', () => {
             RPC.Create('Test', { name: 'test', version: 1 }, async () => ({ ok: true }));
             builder.register(RPC, () => ({}));
             const app = builder.build();
-            await request(app).post('/rpc/test/1').send({});
+            await request(app).post('/test/1').send({});
             expect(onRequestStart).toHaveBeenCalledTimes(1);
             expect(onRequestStart.mock.calls[0][0]).toHaveProperty('method', 'POST');
-            expect(onRequestStart.mock.calls[0][0]).toHaveProperty('path', '/rpc/test/1');
+            expect(onRequestStart.mock.calls[0][0]).toHaveProperty('path', '/test/1');
         });
         test('onRequestEnd is called after response finishes', async () => {
             const onRequestEnd = vi.fn();
@@ -77,7 +128,7 @@ describe('ExpressRPCAppBuilder', () => {
             RPC.Create('Test', { name: 'test', version: 1 }, async () => ({ ok: true }));
             builder.register(RPC, () => ({}));
             const app = builder.build();
-            await request(app).post('/rpc/test/1').send({});
+            await request(app).post('/test/1').send({});
             expect(onRequestEnd).toHaveBeenCalledTimes(1);
             expect(onRequestEnd.mock.calls[0][0]).toHaveProperty('method', 'POST');
             expect(onRequestEnd.mock.calls[0][1]).toHaveProperty('statusCode', 200);
@@ -89,7 +140,7 @@ describe('ExpressRPCAppBuilder', () => {
             RPC.Create('Test', { name: 'test', version: 1 }, async () => ({ ok: true }));
             builder.register(RPC, () => ({}));
             const app = builder.build();
-            await request(app).post('/rpc/test/1').send({});
+            await request(app).post('/test/1').send({});
             expect(onSuccess).toHaveBeenCalledTimes(1);
             expect(onSuccess.mock.calls[0][0]).toHaveProperty('name', 'Test');
         });
@@ -102,7 +153,7 @@ describe('ExpressRPCAppBuilder', () => {
             });
             builder.register(RPC, () => ({}));
             const app = builder.build();
-            await request(app).post('/rpc/test/1').send({});
+            await request(app).post('/test/1').send({});
             expect(onSuccess).not.toHaveBeenCalled();
         });
         test('hooks execute in correct order: start → handler → success → end', async () => {
@@ -119,7 +170,7 @@ describe('ExpressRPCAppBuilder', () => {
             });
             builder.register(RPC, () => ({}));
             const app = builder.build();
-            await request(app).post('/rpc/test/1').send({});
+            await request(app).post('/test/1').send({});
             expect(order).toEqual(['start', 'handler', 'success', 'end']);
         });
     });
@@ -138,7 +189,7 @@ describe('ExpressRPCAppBuilder', () => {
             });
             builder.register(RPC, () => ({}));
             const app = builder.build();
-            const res = await request(app).post('/rpc/test/1').send({});
+            const res = await request(app).post('/test/1').send({});
             expect(errorHandler).toHaveBeenCalledTimes(1);
             expect(errorHandler.mock.calls[0][0]).toHaveProperty('name', 'Test');
             expect(errorHandler.mock.calls[0][3]).toBeInstanceOf(Error);
@@ -154,7 +205,7 @@ describe('ExpressRPCAppBuilder', () => {
             });
             builder.register(RPC, () => ({}));
             const app = builder.build();
-            const res = await request(app).post('/rpc/test/1').send({});
+            const res = await request(app).post('/test/1').send({});
             // Default error handler returns error message in JSON body
             expect(res.body).toHaveProperty('error');
             expect(res.body.error).toContain('Something went wrong');
@@ -169,7 +220,7 @@ describe('ExpressRPCAppBuilder', () => {
             });
             builder.register(RPC, () => ({}));
             const app = builder.build();
-            const res = await request(app).post('/rpc/test/1').send({});
+            const res = await request(app).post('/test/1').send({});
             // Unhandled exceptions are caught and returned as error response
             expect(res.body).toHaveProperty('error');
         });
@@ -202,13 +253,39 @@ describe('ExpressRPCAppBuilder', () => {
                 .register(PublicRPC, () => ({ public: true }))
                 .register(PrivateRPC, () => ({ private: true }));
             const app = builder.build();
-            const publicRes = await request(app).post('/rpc/public/1').send({});
-            const privateRes = await request(app).post('/rpc/private/1').send({});
+            const publicRes = await request(app).post('/public/1').send({});
+            const privateRes = await request(app).post('/private/1').send({});
             expect(publicRes.body).toEqual({ isPublic: true });
             expect(privateRes.body).toEqual({ isPrivate: true });
         });
-        test('context resolver receives Express request object', async () => {
-            const contextResolver = vi.fn((req) => ({
+        test('context can be a static object', async () => {
+            const factoryContext = { requestId: 'req-123' };
+            const builder = new ExpressRPCAppBuilder();
+            const RPC = Procedures();
+            RPC.Create('GetRequestId', { name: 'get-request-id', version: 1 }, async (ctx) => ({
+                id: ctx.requestId,
+            }));
+            builder.register(RPC, factoryContext);
+            const app = builder.build();
+            const res = await request(app).post('/get-request-id/1').send({});
+            expect(res.body).toEqual({ id: 'req-123' });
+        });
+        test('factoryContext can be async function', async () => {
+            const factoryContext = vi.fn(async () => {
+                return { requestId: 'req-456' };
+            });
+            const builder = new ExpressRPCAppBuilder();
+            const RPC = Procedures();
+            RPC.Create('GetRequestId', { name: 'get-request-id', version: 1 }, async (ctx) => ({
+                id: ctx.requestId,
+            }));
+            builder.register(RPC, factoryContext);
+            const app = builder.build();
+            await request(app).post('/get-request-id/1').send({});
+            expect(factoryContext).toHaveBeenCalledTimes(1);
+        });
+        test('factoryContext function receives Express request object', async () => {
+            const factoryContext = vi.fn((req) => ({
                 authHeader: req.headers.authorization,
             }));
             const builder = new ExpressRPCAppBuilder();
@@ -216,12 +293,12 @@ describe('ExpressRPCAppBuilder', () => {
             RPC.Create('GetAuth', { name: 'get-auth', version: 1 }, async (ctx) => ({
                 auth: ctx.authHeader,
             }));
-            builder.register(RPC, contextResolver);
+            builder.register(RPC, factoryContext);
             const app = builder.build();
-            await request(app).post('/rpc/get-auth/1').set('Authorization', 'Bearer token123').send({});
-            expect(contextResolver).toHaveBeenCalledTimes(1);
-            expect(contextResolver.mock.calls[0][0]).toHaveProperty('headers');
-            expect(contextResolver.mock.calls[0][0].headers).toHaveProperty('authorization', 'Bearer token123');
+            await request(app).post('/get-auth/1').set('Authorization', 'Bearer token123').send({});
+            expect(factoryContext).toHaveBeenCalledTimes(1);
+            expect(factoryContext.mock.calls[0][0]).toHaveProperty('headers');
+            expect(factoryContext.mock.calls[0][0].headers).toHaveProperty('authorization', 'Bearer token123');
         });
     });
     // --------------------------------------------------------------------------
@@ -235,8 +312,8 @@ describe('ExpressRPCAppBuilder', () => {
             RPC.Create('MethodTwo', { name: 'method-two', version: 2 }, async () => ({ m: 2 }));
             builder.register(RPC, () => ({}));
             const app = builder.build();
-            const res1 = await request(app).post('/rpc/method-one/1').send({});
-            const res2 = await request(app).post('/rpc/method-two/2').send({});
+            const res1 = await request(app).post('/method-one/1').send({});
+            const res2 = await request(app).post('/method-two/2').send({});
             expect(res1.status).toBe(200);
             expect(res2.status).toBe(200);
             expect(res1.body).toEqual({ m: 1 });
@@ -257,8 +334,8 @@ describe('ExpressRPCAppBuilder', () => {
             builder.register(RPC, () => ({}));
             builder.build();
             expect(builder.docs).toHaveLength(2);
-            expect(builder.docs[0].path).toBe('/rpc/method-one/1');
-            expect(builder.docs[1].path).toBe('/rpc/nested/method/2');
+            expect(builder.docs[0].path).toBe('/method-one/1');
+            expect(builder.docs[1].path).toBe('/nested/method/2');
         });
         test('passes request body to handler as params', async () => {
             const builder = new ExpressRPCAppBuilder();
@@ -266,7 +343,7 @@ describe('ExpressRPCAppBuilder', () => {
             RPC.Create('Echo', { name: 'echo', version: 1, schema: { params: v.object({ data: v.string() }) } }, async (ctx, params) => ({ received: params.data }));
             builder.register(RPC, () => ({}));
             const app = builder.build();
-            const res = await request(app).post('/rpc/echo/1').send({ data: 'test-data' });
+            const res = await request(app).post('/echo/1').send({ data: 'test-data' });
             expect(res.body).toEqual({ received: 'test-data' });
         });
         test('GET requests return 404 (RPC uses POST only)', async () => {
@@ -275,7 +352,7 @@ describe('ExpressRPCAppBuilder', () => {
             RPC.Create('Test', { name: 'test', version: 1 }, async () => ({ ok: true }));
             builder.register(RPC, () => ({}));
             const app = builder.build();
-            const res = await request(app).get('/rpc/test/1');
+            const res = await request(app).get('/test/1');
             expect(res.status).toBe(404);
         });
     });
@@ -287,36 +364,36 @@ describe('ExpressRPCAppBuilder', () => {
         beforeEach(() => {
             builder = new ExpressRPCAppBuilder();
         });
-        test("simple string: 'users' → /rpc/users/1", () => {
+        test("simple string: 'users' → /users/1", () => {
             const path = builder.makeRPCHttpRoutePath({ name: 'users', version: 1 });
-            expect(path).toBe('/rpc/users/1');
+            expect(path).toBe('/users/1');
         });
-        test("array name: ['users', 'get-by-id'] → /rpc/users/get-by-id/1", () => {
+        test("array name: ['users', 'get-by-id'] → /users/get-by-id/1", () => {
             const path = builder.makeRPCHttpRoutePath({ name: ['users', 'get-by-id'], version: 1 });
-            expect(path).toBe('/rpc/users/get-by-id/1');
+            expect(path).toBe('/users/get-by-id/1');
         });
-        test("camelCase: 'getUserById' → /rpc/get-user-by-id/1", () => {
+        test("camelCase: 'getUserById' → /get-user-by-id/1", () => {
             const path = builder.makeRPCHttpRoutePath({ name: 'getUserById', version: 1 });
-            expect(path).toBe('/rpc/get-user-by-id/1');
+            expect(path).toBe('/get-user-by-id/1');
         });
-        test("PascalCase: 'GetUserById' → /rpc/get-user-by-id/1", () => {
+        test("PascalCase: 'GetUserById' → /get-user-by-id/1", () => {
             const path = builder.makeRPCHttpRoutePath({ name: 'GetUserById', version: 1 });
-            expect(path).toBe('/rpc/get-user-by-id/1');
+            expect(path).toBe('/get-user-by-id/1');
         });
         test('version number included in path', () => {
             const pathV1 = builder.makeRPCHttpRoutePath({ name: 'test', version: 1 });
             const pathV2 = builder.makeRPCHttpRoutePath({ name: 'test', version: 2 });
             const pathV99 = builder.makeRPCHttpRoutePath({ name: 'test', version: 99 });
-            expect(pathV1).toBe('/rpc/test/1');
-            expect(pathV2).toBe('/rpc/test/2');
-            expect(pathV99).toBe('/rpc/test/99');
+            expect(pathV1).toBe('/test/1');
+            expect(pathV2).toBe('/test/2');
+            expect(pathV99).toBe('/test/99');
         });
         test('handles mixed case in array segments', () => {
             const path = builder.makeRPCHttpRoutePath({
                 name: ['UserModule', 'getActiveUsers'],
                 version: 1,
             });
-            expect(path).toBe('/rpc/user-module/get-active-users/1');
+            expect(path).toBe('/user-module/get-active-users/1');
         });
     });
     // --------------------------------------------------------------------------
@@ -331,10 +408,11 @@ describe('ExpressRPCAppBuilder', () => {
             const paramsSchema = v.object({ id: v.string() });
             const returnSchema = v.object({ name: v.string() });
             const RPC = Procedures();
-            const { info } = RPC.Create('GetUser', { name: 'users', version: 1, schema: { params: paramsSchema, returnType: returnSchema } }, async () => ({ name: 'test' }));
-            const procedure = RPC.getProcedures()[0];
-            const doc = builder.buildRpcHttpRouteDoc(procedure);
-            expect(doc.path).toBe('/rpc/users/1');
+            RPC.Create('GetUser', { name: 'users', version: 1, schema: { params: paramsSchema, returnType: returnSchema } }, async () => ({ name: 'test' }));
+            builder.register(RPC, () => ({}));
+            builder.build();
+            const doc = builder.docs[0];
+            expect(doc.path).toBe('/users/1');
             expect(doc.method).toBe('post');
             expect(doc.jsonSchema.body).toBeDefined();
             expect(doc.jsonSchema.response).toBeDefined();
@@ -342,15 +420,17 @@ describe('ExpressRPCAppBuilder', () => {
         test('omits body schema when no params defined', () => {
             const RPC = Procedures();
             RPC.Create('NoParams', { name: 'no-params', version: 1 }, async () => ({ ok: true }));
-            const procedure = RPC.getProcedures()[0];
-            const doc = builder.buildRpcHttpRouteDoc(procedure);
+            builder.register(RPC, () => ({}));
+            builder.build();
+            const doc = builder.docs[0];
             expect(doc.jsonSchema.body).toBeUndefined();
         });
         test('omits response schema when no returnType defined', () => {
             const RPC = Procedures();
             RPC.Create('NoReturn', { name: 'no-return', version: 1, schema: { params: v.object({ x: v.number() }) } }, async () => ({}));
-            const procedure = RPC.getProcedures()[0];
-            const doc = builder.buildRpcHttpRouteDoc(procedure);
+            builder.register(RPC, () => ({}));
+            builder.build();
+            const doc = builder.docs[0];
             expect(doc.jsonSchema.body).toBeDefined();
             expect(doc.jsonSchema.response).toBeUndefined();
         });
@@ -358,9 +438,9 @@ describe('ExpressRPCAppBuilder', () => {
             const RPC = Procedures();
             RPC.Create('Test1', { name: 't1', version: 1 }, async () => ({}));
             RPC.Create('Test2', { name: 't2', version: 2 }, async () => ({}));
-            const procedures = RPC.getProcedures();
-            procedures.forEach((proc) => {
-                const doc = builder.buildRpcHttpRouteDoc(proc);
+            builder.register(RPC, () => ({}));
+            builder.build();
+            builder.docs.forEach((doc) => {
                 expect(doc.method).toBe('post');
             });
         });
@@ -406,21 +486,21 @@ describe('ExpressRPCAppBuilder', () => {
             }));
             const app = builder.build();
             // Test public endpoints
-            const versionRes = await request(app).post('/rpc/system/version/1').send({});
+            const versionRes = await request(app).post('/system/version/1').send({});
             expect(versionRes.status).toBe(200);
             expect(versionRes.body).toEqual({ version: '1.0.0' });
-            const healthRes = await request(app).post('/rpc/health/1').send({});
+            const healthRes = await request(app).post('/health/1').send({});
             expect(healthRes.status).toBe(200);
             expect(healthRes.body).toEqual({ status: 'ok' });
             // Test authenticated endpoints
             const profileRes = await request(app)
-                .post('/rpc/users/profile/1')
+                .post('/users/profile/1')
                 .set('X-User-Id', 'user-123')
                 .send({});
             expect(profileRes.status).toBe(200);
             expect(profileRes.body).toEqual({ userId: 'user-123', source: 'auth' });
             const updateRes = await request(app)
-                .post('/rpc/users/profile/2')
+                .post('/users/profile/2')
                 .set('X-User-Id', 'user-456')
                 .send({ name: 'John Doe' });
             expect(updateRes.status).toBe(200);
@@ -428,10 +508,10 @@ describe('ExpressRPCAppBuilder', () => {
             // Verify documentation
             expect(builder.docs).toHaveLength(4);
             const paths = builder.docs.map((d) => d.path);
-            expect(paths).toContain('/rpc/system/version/1');
-            expect(paths).toContain('/rpc/health/1');
-            expect(paths).toContain('/rpc/users/profile/1');
-            expect(paths).toContain('/rpc/users/profile/2');
+            expect(paths).toContain('/system/version/1');
+            expect(paths).toContain('/health/1');
+            expect(paths).toContain('/users/profile/1');
+            expect(paths).toContain('/users/profile/2');
             // Verify hooks were called
             expect(events).toContain('request-start');
             expect(events).toContain('success:GetVersion');