@quatrain/api-server-express 1.1.8 → 1.1.10

package/dist/adapters/ExpressAdapter.d.ts

@@ -16,14 +16,7 @@ export declare class ExpressAdapter implements ServerAdapter {
     createRouter(path: string): ServerAdapter;
     start(port: number, callback?: () => void): void;
     getNativeInstance(): any;
-    /**
-     * Configures the server to serve static files from a specified folder.
-     * It also sets up a fallback route for SPA (Single Page Application) navigation,
-     * ensuring that non-API routes return the main index.html file.
-     *
-     * @param folderPath The absolute path to the directory containing static files (e.g. built frontend).
-     * @param apiPrefix The prefix used for API routes, which will be ignored by the SPA fallback. Defaults to '/api'.
-     */
     serveStatic(folderPath: string, apiPrefix?: string): void;
     addEndpoint(handler: EndpointHandler, endpointRoot: string, options?: EndpointOptions): void;
 }
+//# sourceMappingURL=ExpressAdapter.d.ts.map

package/dist/adapters/ExpressAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpressAdapter.d.ts","sourceRoot":"","sources":["../../src/adapters/ExpressAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,aAAa,EAAE,UAAU,EAA2B,eAAe,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAMnI,qBAAa,cAAe,YAAW,aAAa;IAE9C,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,MAAM;gBADN,WAAW,GAAE,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,MAAkB,EAC7D,MAAM,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO;IAkB9C,OAAO,CAAC,WAAW;IA6CnB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI;IAU5C,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI;IAU7C,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI;IAU5C,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,IAAI;IAS/C,GAAG,CAAC,UAAU,EAAE,GAAG,GAAG,IAAI;IAS1B,aAAa,CAAC,UAAU,EAAE,aAAa,GAAG,IAAI;IAiD9C,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;IAYzC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI;IAahD,iBAAiB,IAAI,GAAG;IAYxB,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,SAAS,GAAE,MAAe,GAAG,IAAI;IAiBjE,WAAW,CAAC,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,IAAI;CAUlG"}

package/dist/adapters/ExpressAdapter.js

@@ -12,7 +12,6 @@ class ExpressAdapter {
         this.appOrRouter = appOrRouter;
         this.config = config;
         if ('listen' in this.appOrRouter && typeof this.appOrRouter.listen === 'function') {
-            // Default global middlewares for top-level application
             this.appOrRouter.disable('x-powered-by');
             this.appOrRouter.use(express_1.default.json());
             this.appOrRouter.use((req, res, next) => {
@@ -135,14 +134,6 @@ class ExpressAdapter {
     getNativeInstance() {
         return this.appOrRouter;
     }
-    /**
-     * Configures the server to serve static files from a specified folder.
-     * It also sets up a fallback route for SPA (Single Page Application) navigation,
-     * ensuring that non-API routes return the main index.html file.
-     *
-     * @param folderPath The absolute path to the directory containing static files (e.g. built frontend).
-     * @param apiPrefix The prefix used for API routes, which will be ignored by the SPA fallback. Defaults to '/api'.
-     */
     serveStatic(folderPath, apiPrefix = '/api') {
         const path = require('node:path');
         this.use(express_1.default.static(folderPath));
@@ -162,3 +153,4 @@ class ExpressAdapter {
     }
 }
 exports.ExpressAdapter = ExpressAdapter;
+//# sourceMappingURL=ExpressAdapter.js.map

package/dist/adapters/ExpressAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExpressAdapter.js","sourceRoot":"","sources":["../../src/adapters/ExpressAdapter.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA6B;AAO7B,MAAa,cAAc;IAEb;IACA;IAFX,YACW,cAAoD,IAAA,iBAAO,GAAE,EAC7D,SAAiC,EAAE;QADnC,gBAAW,GAAX,WAAW,CAAkD;QAC7D,WAAM,GAAN,MAAM,CAA6B;QAE3C,IAAI,QAAQ,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAEhF,IAAI,CAAC,WAAmC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;YACjE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,iBAAO,CAAC,IAAI,EAAE,CAAC,CAAA;YACpC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;gBACrC,GAAG,CAAC,MAAM,CAAC,6BAA6B,EAAE,GAAG,CAAC,CAAA;gBAC9C,GAAG,CAAC,MAAM,CAAC,8BAA8B,EAAE,iCAAiC,CAAC,CAAA;gBAC7E,GAAG,CAAC,MAAM,CAAC,8BAA8B,EAAE,GAAG,CAAC,CAAA;gBAC/C,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;oBAC5B,OAAO,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAA;gBAC7B,CAAC;gBACD,IAAI,EAAE,CAAA;YACT,CAAC,CAAC,CAAA;QACL,CAAC;IACJ,CAAC;IAEO,WAAW,CAAC,OAAmB;QACpC,OAAO,KAAK,EAAE,GAAoB,EAAE,GAAqB,EAAE,IAA0B,EAAE,EAAE;YACtF,IAAI,CAAC;gBACF,MAAM,MAAM,GAAe;oBACxB,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,GAAG,CAAC,MAAM;oBAClB,KAAK,EAAE,GAAG,CAAC,KAAK;oBAChB,OAAO,EAAE,GAAG,CAAC,OAAwD;iBACvE,CAAA;gBAED,MAAM,MAAM,GAAgB;oBACzB,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;wBACtB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;wBAChB,OAAO,MAAM,CAAA;oBAChB,CAAC;oBACD,IAAI,EAAE,CAAC,IAAS,EAAE,EAAE;wBACjB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBACjB,CAAC;oBACD,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE;wBACpB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;oBACjB,CAAC;oBACD,SAAS,EAAE,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE;wBACxC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;oBAC7B,CAAC;oBACD,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE;wBACrB,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;oBAClB,CAAC;oBACD,GAAG,EAAE,GAAG,EAAE;wBACP,GAAG,CAAC,GAAG,EAAE,CAAA;oBACZ,CAAC;iBACH,CAAA;gBAED,MAAM,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;YAChC,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACZ,IAAI,CAAC,GAAG,CAAC,CAAA;YACZ,CAAC;QACJ,CAAC,CAAA;IACJ,CAAC;IAQD,GAAG,CAAC,IAAY,EAAE,OAAmB;QACjC,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5E,CAAC;IAQD,IAAI,CAAC,IAAY,EAAE,OAAmB;QAClC,IAAI,CAAC,WAA8B,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;IAC7E,CAAC;IAQD,GAAG,CAAC,IAAY,EAAE,OAAmB;QACjC,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5E,CAAC;IAQD,MAAM,CAAC,IAAY,EAAE,OAAmB;QACpC,IAAI,CAAC,WAA8B,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAA;IAC/E,CAAC;IAOD,GAAG,CAAC,UAAe;QACf,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;IACvD,CAAC;IAOD,aAAa,CAAC,UAAyB;QACpC,MAAM,iBAAiB,GAAG,KAAK,EAAE,GAAoB,EAAE,GAAqB,EAAE,IAA0B,EAAE,EAAE;YACzG,MAAM,MAAM,GAAe;gBACxB,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,KAAK,EAAE,GAAG,CAAC,KAAK;gBAChB,OAAO,EAAE,GAAG,CAAC,OAAwD;aACvE,CAAA;YAED,MAAM,MAAM,GAAgB;gBACzB,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;oBACtB,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;oBAChB,OAAO,MAAM,CAAA;gBAChB,CAAC;gBACD,IAAI,EAAE,CAAC,IAAS,EAAE,EAAE;oBACjB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACjB,CAAC;gBACD,IAAI,EAAE,CAAC,IAAY,EAAE,EAAE;oBACpB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACjB,CAAC;gBACD,SAAS,EAAE,CAAC,IAAY,EAAE,KAAa,EAAE,EAAE;oBACxC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAA;gBAC7B,CAAC;gBACD,KAAK,EAAE,CAAC,IAAY,EAAE,EAAE;oBACrB,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;gBAClB,CAAC;gBACD,GAAG,EAAE,GAAG,EAAE;oBACP,GAAG,CAAC,GAAG,EAAE,CAAA;gBACZ,CAAC;aACH,CAAA;YAED,IAAI,CAAC;gBACF,MAAM,cAAc,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;gBACvD,IAAI,cAAc,EAAE,CAAC;oBAClB,IAAI,EAAE,CAAA;gBACT,CAAC;YACJ,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACZ,IAAI,CAAC,GAAG,CAAC,CAAA;YACZ,CAAC;QACJ,CAAC,CAAA;QACA,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;IAC9D,CAAC;IAQD,YAAY,CAAC,IAAY;QACtB,MAAM,MAAM,GAAG,iBAAO,CAAC,MAAM,EAAE,CAC9B;QAAC,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QACvD,OAAO,IAAI,cAAc,CAAC,MAAM,CAAC,CAAA;IACpC,CAAC;IAQD,KAAK,CAAC,IAAY,EAAE,QAAqB;QACtC,IAAI,QAAQ,IAAI,IAAI,CAAC,WAAW,IAAI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACjF,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAC1C,CAAC;aAAM,CAAC;YACL,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;QACjE,CAAC;IACJ,CAAC;IAOD,iBAAiB;QACd,OAAO,IAAI,CAAC,WAAW,CAAA;IAC1B,CAAC;IAUD,WAAW,CAAC,UAAkB,EAAE,YAAoB,MAAM;QACvD,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;QACjC,IAAI,CAAC,GAAG,CAAC,iBAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAEnC;QAAC,IAAI,CAAC,WAA8B,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAoB,EAAE,GAAqB,EAAE,IAA0B,EAAE,EAAE;YACxH,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;gBAAE,OAAO,IAAI,EAAE,CAAA;YACjD,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAA;QACpD,CAAC,CAAC,CAAA;IACL,CAAC;IASD,WAAW,CAAC,OAAwB,EAAE,YAAoB,EAAE,UAA2B,EAAE;QACtF,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,YAAY,EAAE,CAAC,CAAC,CAAC,YAAY,CAAA;QACjG,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QAE1C,IAAI,OAAO,CAAC,WAAW,IAAI,OAAO,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzD,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAA;QACtD,CAAC;QAED,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;IAChC,CAAC;CACH;AAnOD,wCAmOC"}

package/dist/index.d.ts

@@ -1 +1,2 @@
 export { ExpressAdapter } from './adapters/ExpressAdapter';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA"}

package/dist/index.js

@@ -3,3 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExpressAdapter = void 0;
 var ExpressAdapter_1 = require("./adapters/ExpressAdapter");
 Object.defineProperty(exports, "ExpressAdapter", { enumerable: true, get: function () { return ExpressAdapter_1.ExpressAdapter; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,4DAA0D;AAAjD,gHAAA,cAAc,OAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/api-server-express",
-  "version": "1.1.8",
+  "version": "1.1.10",
   "description": "Express Adapter for Quatrain API Server",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,8 +29,8 @@
     "typescript": "^5.2.2"
   },
   "dependencies": {
-    "@quatrain/api": "^1.1.4",
-    "@quatrain/api-server": "^1.1.8",
+    "@quatrain/api": "^1.1.5",
+    "@quatrain/api-server": "^1.1.9",
     "express": "^4.19.2"
   },
   "scripts": {

package/src/adapters/ExpressAdapter.ts

@@ -1,6 +1,10 @@
 import express from 'express'
 import { ServerAdapter, ApiHandler, ApiRequest, ApiResponse, EndpointHandler, EndpointOptions, ApiMiddleware } from '@quatrain/api'
 
+/**
+ * Api Server adapter wrapping the `express` framework.
+ * Maps Quatrain's standardized `ServerAdapter` interfaces to native Express mechanisms.
+ */
 export class ExpressAdapter implements ServerAdapter {
    constructor(
       private appOrRouter: express.Application | express.Router = express(),
@@ -61,26 +65,60 @@ export class ExpressAdapter implements ServerAdapter {
       }
    }
 
+   /**
+    * Registers a GET endpoint.
+    * 
+    * @param path - The URI path.
+    * @param handler - The standard Quatrain ApiHandler.
+    */
    get(path: string, handler: ApiHandler): void {
       (this.appOrRouter as express.Router).get(path, this.wrapHandler(handler))
    }
 
+   /**
+    * Registers a POST endpoint.
+    * 
+    * @param path - The URI path.
+    * @param handler - The standard Quatrain ApiHandler.
+    */
    post(path: string, handler: ApiHandler): void {
       (this.appOrRouter as express.Router).post(path, this.wrapHandler(handler))
    }
 
+   /**
+    * Registers a PUT endpoint.
+    * 
+    * @param path - The URI path.
+    * @param handler - The standard Quatrain ApiHandler.
+    */
    put(path: string, handler: ApiHandler): void {
       (this.appOrRouter as express.Router).put(path, this.wrapHandler(handler))
    }
 
+   /**
+    * Registers a DELETE endpoint.
+    * 
+    * @param path - The URI path.
+    * @param handler - The standard Quatrain ApiHandler.
+    */
    delete(path: string, handler: ApiHandler): void {
       (this.appOrRouter as express.Router).delete(path, this.wrapHandler(handler))
    }
 
+   /**
+    * Attaches a native Express middleware or sub-router.
+    * 
+    * @param middleware - The Express RequestHandler or Router.
+    */
    use(middleware: any): void {
       (this.appOrRouter as express.Router).use(middleware)
    }
 
+   /**
+    * Injects a Quatrain-compatible API middleware into the flow.
+    * 
+    * @param middleware - The Quatrain ApiMiddleware function.
+    */
    addMiddleware(middleware: ApiMiddleware): void {
       const expressMiddleware = async (req: express.Request, res: express.Response, next: express.NextFunction) => {
          const apiReq: ApiRequest = {
@@ -124,12 +162,24 @@ export class ExpressAdapter implements ServerAdapter {
       (this.appOrRouter as express.Router).use(expressMiddleware)
    }
 
+   /**
+    * Spawns an isolated routing scope (sub-router).
+    * 
+    * @param path - The prefix path for the router.
+    * @returns A new ExpressAdapter instance controlling the sub-router.
+    */
    createRouter(path: string): ServerAdapter {
       const router = express.Router()
       ;(this.appOrRouter as express.Router).use(path, router)
       return new ExpressAdapter(router)
    }
 
+   /**
+    * Binds the server to the network and starts listening.
+    * 
+    * @param port - The network port.
+    * @param callback - Optional completion callback.
+    */
    start(port: number, callback?: () => void): void {
       if ('listen' in this.appOrRouter && typeof this.appOrRouter.listen === 'function') {
          this.appOrRouter.listen(port, callback)
@@ -138,6 +188,11 @@ export class ExpressAdapter implements ServerAdapter {
       }
    }
 
+   /**
+    * Retrieves the underlying native framework instance.
+    * 
+    * @returns The raw Express Application or Router instance.
+    */
    getNativeInstance(): any {
       return this.appOrRouter
    }
@@ -160,6 +215,13 @@ export class ExpressAdapter implements ServerAdapter {
       })
    }
 
+   /**
+    * Composes and mounts a full EndpointHandler block at a specific root.
+    * 
+    * @param handler - The endpoint initialization logic.
+    * @param endpointRoot - The base URI.
+    * @param options - Middlewares and operational options.
+    */
    addEndpoint(handler: EndpointHandler, endpointRoot: string, options: EndpointOptions = {}): void {
       const fullPath = this.config.apiPrefix ? `${this.config.apiPrefix}${endpointRoot}` : endpointRoot
       const router = this.createRouter(fullPath)