@rapidrest/service-core 1.0.0-rc.2 → 1.0.0-rc.21

package/dist/lib/routes/{AdminRoute.js → BaseAdminRoute.js}

@@ -16,7 +16,7 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 import { ApiError, ObjectDecorators, UserUtils } from "@rapidrest/core";
 import { Redis } from "ioredis";
 import Transport from "winston-transport";
-import { Auth, ContentType, Get, Route, Socket, User, WebSocket } from "../decorators/RouteDecorators.js";
+import { Auth, ContentType, Get, Socket, User, WebSocket } from "../decorators/RouteDecorators.js";
 import { RedisConnection } from "../decorators/DatabaseDecorators.js";
 import { Description, Returns, Summary } from "../decorators/DocDecorators.js";
 import { ApiErrorMessages, ApiErrors } from "../ApiErrors.js";
@@ -39,29 +39,45 @@ export class RedisTransport extends Transport {
     }
 }
 /**
- * The `AdminRoute` provides a default `/admin` endpoint that gives trusted users the following abilities:
+ * The `BaseAdminRoute` class provides a base set of endpoints that gives trusted users the ability to perform common adminstrative actions
+ * with the server.
  *
- * * Clear cache via `GET /admin/clear-cache`
- * * Live tail the service logs via `GET /admin/logs`
- * * Retrieve service dependencies via `GET /admin/dependencies`
- * * Retrieve service release notes via `GET /admin/release-notes`
- * * Restart the service via `GET /admin/restart`
+ * Exposed endpoints:
+ *
+ * | Name | HTTP Method | What it does |
+ * | --- | --- | --- |
+ * | `clearCache` | `GET /<base_path>/clear-cache` | Clears the Redis-based cache system. |
+ * | `logs` | `UPGRADE /<base_path>/logs` | Live tail the service logs |
+ * | `getReleaseNotes` | `GET /<base_path>/release-notes` | Retrieve the server release notes. |
+ * | `restart` | `GET /<base_path>/restart` | ` Restart the server |
+ *
+ * !!Note!! that the `BaseAdminRoute` is not automatically registered with a server by default. You must create
+ * your own class that extends `AdminRoute` and apply the desired base path with `@Route()`.
+ *
+ * @example
+ * ```ts
+ * import { BaseAdminRoute, RouteDecorators } from "@rapidrest/service-core";
+ * const { Route } = RouteDecorators;
+ *
+ * @Route("/admin")
+ * export class AdminRoute extends BaseAdminRoute {}
+ * ```
  *
  * @author Jean-Philippe Steinmetz
  */
-let AdminRoute = class AdminRoute {
-    /**
-     * Constructs a new `ReleaseNotesRoute` object with the specified defaults.
-     *
-     * @param releaseNotes The ReleaseNotes specification object to serve.
-     */
-    constructor(releaseNotes) {
+let BaseAdminRoute = class BaseAdminRoute {
+    constructor() {
         /** A map of user uid's to active sockets. */
         this.activeSockets = new Map();
         this.trustedRoles = [];
-        this.releaseNotes = releaseNotes;
     }
     async init() {
+        if (this.cacheClient) {
+            this.logger.info("Cache is enabled and ready.");
+        }
+        else {
+            this.logger.warn("Cache is disabled.");
+        }
         if (this.cacheConnConfig) {
             const adminChannel = this.serviceName || "service_admin";
             this.redisClient = new Redis(this.cacheConnConfig.url, this.cacheConnConfig.options);
@@ -79,12 +95,13 @@ let AdminRoute = class AdminRoute {
             const channelName = this.serviceName + "-logs";
             this.logger.add(new RedisTransport({
                 channelName,
-                redis: new Redis(this.logsConnConfig.url, this.logsConnConfig.options)
+                redis: new Redis(this.logsConnConfig.url, this.logsConnConfig.options),
             }));
         }
         else {
             this.logger.warn("Could not initialize `/admin/logs` route. The `logs` datastore is not not configured.");
         }
+        // Discover the release notes file and load it (if available)
     }
     async clearCache(user) {
         if (!user || !UserUtils.hasRoles(user, this.trustedRoles)) {
@@ -167,7 +184,7 @@ let AdminRoute = class AdminRoute {
             this.activeSockets.set(user.uid, socks);
         }
     }
-    get(user) {
+    getReleaseNotes(user) {
         if (user && user.uid && UserUtils.hasRoles(user, this.trustedRoles)) {
             return this.releaseNotes;
         }
@@ -187,33 +204,33 @@ let AdminRoute = class AdminRoute {
 __decorate([
     RedisConnection("cache"),
     __metadata("design:type", Redis)
-], AdminRoute.prototype, "cacheClient", void 0);
+], BaseAdminRoute.prototype, "cacheClient", void 0);
 __decorate([
     Config("datastores:cache", null),
     __metadata("design:type", Object)
-], AdminRoute.prototype, "cacheConnConfig", void 0);
+], BaseAdminRoute.prototype, "cacheConnConfig", void 0);
 __decorate([
     Logger,
     __metadata("design:type", Object)
-], AdminRoute.prototype, "logger", void 0);
+], BaseAdminRoute.prototype, "logger", void 0);
 __decorate([
     Config("datastores:logs", null),
     __metadata("design:type", Object)
-], AdminRoute.prototype, "logsConnConfig", void 0);
+], BaseAdminRoute.prototype, "logsConnConfig", void 0);
 __decorate([
     Config("service_name"),
     __metadata("design:type", String)
-], AdminRoute.prototype, "serviceName", void 0);
+], BaseAdminRoute.prototype, "serviceName", void 0);
 __decorate([
     Config("trusted_roles"),
     __metadata("design:type", Array)
-], AdminRoute.prototype, "trustedRoles", void 0);
+], BaseAdminRoute.prototype, "trustedRoles", void 0);
 __decorate([
     Init,
     __metadata("design:type", Function),
     __metadata("design:paramtypes", []),
     __metadata("design:returntype", Promise)
-], AdminRoute.prototype, "init", null);
+], BaseAdminRoute.prototype, "init", null);
 __decorate([
     Summary("{{serviceName}} flush second-level cache"),
     Description("Flushes the second-level cache so that subsequent requests will pull directly from the database."),
@@ -224,7 +241,7 @@ __decorate([
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", Promise)
-], AdminRoute.prototype, "clearCache", null);
+], BaseAdminRoute.prototype, "clearCache", null);
 __decorate([
     Summary("{{serviceName}} websocket to view live logs"),
     Description("Establishes a connection to the live log socket."),
@@ -235,7 +252,7 @@ __decorate([
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Function, Object]),
     __metadata("design:returntype", Promise)
-], AdminRoute.prototype, "logs", null);
+], BaseAdminRoute.prototype, "logs", null);
 __decorate([
     Summary("{{serviceName}} release notes"),
     Description("Returns the release notes file for the service."),
@@ -246,8 +263,8 @@ __decorate([
     __param(0, User),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
-    __metadata("design:returntype", String)
-], AdminRoute.prototype, "get", null);
+    __metadata("design:returntype", Object)
+], BaseAdminRoute.prototype, "getReleaseNotes", null);
 __decorate([
     Summary("{{serviceName}} Restart"),
     Description("Immediately restarts the service."),
@@ -258,11 +275,9 @@ __decorate([
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", void 0)
-], AdminRoute.prototype, "restart", null);
-AdminRoute = __decorate([
-    Summary("Admin routes supporting cache-clearing, restarting, logs and release notes"),
-    Route("/admin"),
-    __metadata("design:paramtypes", [String])
-], AdminRoute);
-export { AdminRoute };
-//# sourceMappingURL=AdminRoute.js.map
+], BaseAdminRoute.prototype, "restart", null);
+BaseAdminRoute = __decorate([
+    Summary("Admin routes supporting cache-clearing, restarting, logs and release notes")
+], BaseAdminRoute);
+export { BaseAdminRoute };
+//# sourceMappingURL=BaseAdminRoute.js.map

package/dist/lib/routes/BaseAdminRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseAdminRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseAdminRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,OAAO,EAAE,QAAQ,EAAW,gBAAgB,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjF,OAAO,EAAE,KAAK,EAAc,MAAM,SAAS,CAAC;AAC5C,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AACnG,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AAEtE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC9D,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;AAElD;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,SAAS;IAIzC,YAAY,IAAS;QACjB,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IAC5B,CAAC;IAEM,KAAK;QACR,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;IAC5B,CAAC;IAEM,GAAG,CAAC,IAAS,EAAE,IAAc;QAChC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5D,IAAI,EAAE,CAAC;IACX,CAAC;CACJ;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEI,IAAM,cAAc,GAApB,MAAM,cAAc;IAApB;QACH,6CAA6C;QACnC,kBAAa,GAAuB,IAAI,GAAG,EAAE,CAAC;QAuB9C,iBAAY,GAAa,EAAE,CAAC;IAqK1C,CAAC;IAlKmB,AAAN,KAAK,CAAC,IAAI;QAChB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QACpD,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC3C,CAAC;QAED,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACvB,MAAM,YAAY,GAAW,IAAI,CAAC,WAAW,IAAI,eAAe,CAAC;YACjE,IAAI,CAAC,WAAW,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YACrF,KAAK,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAC9C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAe,EAAE,OAAe,EAAE,EAAE;gBAChE,IAAI,OAAO,KAAK,YAAY,EAAE,CAAC;oBAC3B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;wBACxB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gDAAgD,CAAC,CAAC;wBACnE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;oBACxC,CAAC;gBACL,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC;QAED,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACtB,MAAM,WAAW,GAAW,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;YACvD,IAAI,CAAC,MAAM,CAAC,GAAG,CACX,IAAI,cAAc,CAAC;gBACf,WAAW;gBACX,KAAK,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC;aACzE,CAAC,CACL,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,uFAAuF,CAAC,CAAC;QAC9G,CAAC;QAED,6DAA6D;IACjE,CAAC;IAOY,AAAN,KAAK,CAAC,UAAU,CAAO,IAAc;QACxC,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,QAAQ,CAAC,SAAS,CAAC,uBAAuB,EAAE,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QACzG,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,MAAM,IAAI,GAAkB,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACxD,MAAM,MAAM,GAA2B,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;gBAC7F,IAAI,CAAC,MAAM,EAAE,CAAC;oBACV,OAAO,EAAE,CAAC;oBACV,OAAO;gBACX,CAAC;gBACD,IAAI,IAAI,GAAa,EAAE,CAAC;gBACxB,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,CAAW,EAAE,EAAE;oBAC9B,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAC1B,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;oBAClB,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;yBACjE,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;yBACrB,KAAK,CAAC,MAAM,CAAC,CAAC;gBACvB,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC/B,CAAC,CAAC,CAAC;YACH,MAAM,IAAI,CAAC;QACf,CAAC;IACL,CAAC;IAMY,AAAN,KAAK,CAAC,IAAI,CAAS,MAAwB,EAAQ,IAAa;QACnE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YAC/C,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,uBAAuB,CAAC,CAAC;YACtD,OAAO;QACX,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACvB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2EAA2E,CAAC,CAAC;YAC/F,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;YAC7C,OAAO;QACX,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACpB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,8DAA8D,CAAC,CAAC;YAClF,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,cAAc,CAAC,CAAC;YAC7C,OAAO;QACX,CAAC;QAED,gDAAgD;QAChD,MAAM,KAAK,GAAU,IAAI,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAErF,MAAM,WAAW,GAAW,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC;QACvD,IAAI,CAAC;YACD,MAAM,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YACnC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,GAAG,8CAA8C,CAAC,CAAC;YACjF,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAe,EAAE,OAAe,EAAE,EAAE;gBACrD,oCAAoC;gBACpC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;oBACzB,IAAI,GAAG,EAAE,CAAC;wBACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,uCAAuC,IAAI,CAAC,GAAG,aAAa,OAAO,GAAG,CAAC,CAAC;wBAC1F,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;oBAC3B,CAAC;gBACL,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;YAE7F,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,IAAY,EAAE,MAAc,EAAE,EAAE;gBACtD,8CAA8C;gBAC9C,MAAM,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;gBACrC,8BAA8B;gBAC9B,KAAK,CAAC,UAAU,EAAE,CAAC;gBAEnB,0CAA0C;gBAC1C,MAAM,KAAK,GAAU,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;gBAC5D,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;gBACvC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;YAEH,qCAAqC;YACrC,MAAM,KAAK,GAAU,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAC5D,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACnB,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,GAAG,0CAA0C,CAAC,CAAC;YAC9E,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACvB,MAAM,CAAC,KAAK,EAAE,CAAC;YAEf,0CAA0C;YAC1C,MAAM,KAAK,GAAU,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAC5D,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;YACvC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC5C,CAAC;IACL,CAAC;IAQM,eAAe,CAAO,IAAc;QACvC,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YAClE,OAAO,IAAI,CAAC,YAAY,CAAC;QAC7B,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,QAAQ,CAAC,SAAS,CAAC,uBAAuB,EAAE,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QACzG,CAAC;IACL,CAAC;IAOM,OAAO,CAAO,IAAc;QAC/B,IAAI,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,QAAQ,CAAC,SAAS,CAAC,uBAAuB,EAAE,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QACzG,CAAC;QAED,2CAA2C;QAC3C,MAAM,WAAW,GAAW,IAAI,CAAC,WAAW,IAAI,eAAe,CAAC;QAChE,KAAK,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IAC3D,CAAC;CACJ,CAAA;AAzLa;IADT,eAAe,CAAC,OAAO,CAAC;8BACD,KAAK;mDAAC;AAGpB;IADT,MAAM,CAAC,kBAAkB,EAAE,IAAI,CAAC;;uDACF;AAGrB;IADT,MAAM;;8CACe;AAGZ;IADT,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC;;sDACF;AAQpB;IADT,MAAM,CAAC,cAAc,CAAC;;mDACQ;AAGrB;IADT,MAAM,CAAC,eAAe,CAAC;;oDACc;AAGtB;IADf,IAAI;;;;0CAmCJ;AAOY;IALZ,OAAO,CAAC,0CAA0C,CAAC;IACnD,WAAW,CAAC,kGAAkG,CAAC;IAC/G,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;IACb,GAAG,CAAC,cAAc,CAAC;IACnB,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACS,WAAA,IAAI,CAAA;;;;gDAyB5B;AAMY;IAJZ,OAAO,CAAC,6CAA6C,CAAC;IACtD,WAAW,CAAC,kDAAkD,CAAC;IAC/D,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;IACb,SAAS,CAAC,OAAO,CAAC;IACA,WAAA,MAAM,CAAA;IAA4B,WAAA,IAAI,CAAA;;;;0CA4DxD;AAQM;IANN,OAAO,CAAC,+BAA+B,CAAC;IACxC,WAAW,CAAC,iDAAiD,CAAC;IAC9D,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;IACb,GAAG,CAAC,gBAAgB,CAAC;IACrB,WAAW,CAAC,YAAY,CAAC;IACzB,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IACM,WAAA,IAAI,CAAA;;;;qDAM3B;AAOM;IALN,OAAO,CAAC,yBAAyB,CAAC;IAClC,WAAW,CAAC,mCAAmC,CAAC;IAChD,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;IACb,GAAG,CAAC,UAAU,CAAC;IACf,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACA,WAAA,IAAI,CAAA;;;;6CAQnB;AA7LQ,cAAc;IAD1B,OAAO,CAAC,4EAA4E,CAAC;GACzE,cAAc,CA8L1B"}

package/dist/lib/routes/{MetricsRoute.js → BaseMetricsRoute.js}

@@ -15,18 +15,36 @@ var __param = (this && this.__param) || function (paramIndex, decorator) {
 ///////////////////////////////////////////////////////////////////////////////
 import * as prom from "prom-client";
 import { ApiError, UserUtils, ObjectDecorators } from "@rapidrest/core";
-import { Get, Param, Route, ContentType, User } from "../decorators/RouteDecorators.js";
+import { Get, Param, ContentType, User } from "../decorators/RouteDecorators.js";
 import { Description, Returns, Summary } from "../decorators/DocDecorators.js";
 import { ApiErrorMessages, ApiErrors } from "../ApiErrors.js";
 const { Config } = ObjectDecorators;
 /**
- * Handles all REST API requests for the endpoint `/metrics'. This route handler produces Prometheus compatible metrics
- * for use with a Prometheus based server.
+ * The `BaseMetricsRoute` class provides a base set of endpoints for exposing Prometheus metrics.
+ *
+ * Exposed endpoints:
+ *
+ * | Name | HTTP Method | What it does |
+ * | --- | --- | --- |
+ * | `getMetrics` | `GET /<base_path>` | Returns all Prometheus metrics gathered by the system |
+ * | `getSingleMetric` | `GET /<base_path>/:metric` | Returns a single Prometheus metric with the given name |
  *
  * Services that wish to provide metrics to be exposed via this route can register them using the global registry
  * from the provided `prom-client` dependency. See the `prom-client` documentation for more details.
+ *
+ * !!Note!! that the `BaseMetricsRoute` is not automatically registered with a server by default. You must create
+ * your own class that extends `AdminRoute` and apply the desired base path with `@Route()`.
+ *
+ * @example
+ * ```ts
+ * import { BaseMetricsRoute, RouteDecorators } from "@rapidrest/service-core";
+ * const { Route } = RouteDecorators;
+ *
+ * @Route("/metrics")
+ * export class MetricsRoute extends BaseMetricsRoute {}
+ * ```
  */
-let MetricsRoute = class MetricsRoute {
+export class BaseMetricsRoute {
     constructor() {
         this.metricsConfig = {
             authRequired: true,
@@ -46,15 +64,15 @@ let MetricsRoute = class MetricsRoute {
         }
         return await this.registry.getSingleMetricAsString(metric);
     }
-};
+}
 __decorate([
     Config("metrics", { authRequired: true }),
     __metadata("design:type", Object)
-], MetricsRoute.prototype, "metricsConfig", void 0);
+], BaseMetricsRoute.prototype, "metricsConfig", void 0);
 __decorate([
     Config("trusted_roles"),
     __metadata("design:type", Array)
-], MetricsRoute.prototype, "trustedRoles", void 0);
+], BaseMetricsRoute.prototype, "trustedRoles", void 0);
 __decorate([
     Summary("{{serviceName}} all Prometheus metrics"),
     Description("Returns all Prometheus metrics emitted by this service."),
@@ -65,7 +83,7 @@ __decorate([
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object]),
     __metadata("design:returntype", Promise)
-], MetricsRoute.prototype, "getMetrics", null);
+], BaseMetricsRoute.prototype, "getMetrics", null);
 __decorate([
     Summary("{{serviceName}} Prometheus metrics by name"),
     Description("Returns the Prometheus metric emitted by this service with the given name."),
@@ -77,10 +95,5 @@ __decorate([
     __metadata("design:type", Function),
     __metadata("design:paramtypes", [Object, Object]),
     __metadata("design:returntype", Promise)
-], MetricsRoute.prototype, "getSingleMetric", null);
-MetricsRoute = __decorate([
-    Route("/metrics"),
-    __metadata("design:paramtypes", [])
-], MetricsRoute);
-export { MetricsRoute };
-//# sourceMappingURL=MetricsRoute.js.map
+], BaseMetricsRoute.prototype, "getSingleMetric", null);
+//# sourceMappingURL=BaseMetricsRoute.js.map

package/dist/lib/routes/BaseMetricsRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseMetricsRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseMetricsRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,OAAO,KAAK,IAAI,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAW,SAAS,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACjF,OAAO,EAAQ,GAAG,EAAE,KAAK,EAAS,WAAW,EAAE,IAAI,EAAE,MAAM,kCAAkC,CAAC;AAC9F,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC9D,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,gBAAgB;IAWzB;QATU,kBAAa,GAAG;YACtB,YAAY,EAAE,IAAI;SACrB,CAAC;QAKQ,iBAAY,GAAa,EAAE,CAAC;QAGlC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;IAClC,CAAC;IAOY,AAAN,KAAK,CAAC,UAAU,CAAO,IAAc;QACxC,IAAI,IAAI,CAAC,aAAa,CAAC,YAAY,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;YAC7F,MAAM,IAAI,QAAQ,CAAC,SAAS,CAAC,uBAAuB,EAAE,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QACzG,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IACzC,CAAC;IAOY,AAAN,KAAK,CAAC,eAAe,CAAkB,MAAW,EAAQ,IAAc;QAC3E,IAAI,IAAI,CAAC,aAAa,CAAC,YAAY,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;YAC7F,MAAM,IAAI,QAAQ,CAAC,SAAS,CAAC,uBAAuB,EAAE,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QACzG,CAAC;QACD,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC/D,CAAC;CACJ;AApCa;IADT,MAAM,CAAC,SAAS,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;;uDAGxC;AAKQ;IADT,MAAM,CAAC,eAAe,CAAC;;sDACc;AAWzB;IALZ,OAAO,CAAC,wCAAwC,CAAC;IACjD,WAAW,CAAC,yDAAyD,CAAC;IACtE,GAAG,EAAE;IACL,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;IACtC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IACO,WAAA,IAAI,CAAA;;;;kDAK5B;AAOY;IALZ,OAAO,CAAC,4CAA4C,CAAC;IACrD,WAAW,CAAC,4EAA4E,CAAC;IACzF,GAAG,CAAC,UAAU,CAAC;IACf,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;IACtC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IACY,WAAA,KAAK,CAAC,QAAQ,CAAC,CAAA;IAAe,WAAA,IAAI,CAAA;;;;uDAK/D"}

package/dist/lib/routes/{OpenAPIRoute.js → BaseOpenAPIRoute.js}

@@ -13,7 +13,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 import { ObjectDecorators } from "@rapidrest/core";
 import { OpenApiSpec } from "../OpenApiSpec.js";
 import { Description, Returns, Summary } from "../decorators/DocDecorators.js";
-import { Get, Route, ContentType } from "../decorators/RouteDecorators.js";
+import { Get, ContentType } from "../decorators/RouteDecorators.js";
 const { Inject } = ObjectDecorators;
 /** Inline Swagger UI HTML page — loads swagger-ui-dist from CDN so there is no npm dependency. */
 function swaggerHtml(specUrl) {
@@ -39,15 +39,31 @@ function swaggerHtml(specUrl) {
 </html>`;
 }
 /**
- * The `OpenAPIRoute` provides default routes to expose the service's OpenAPI specification.
+ * The `BaseOpenAPIRoute` class provides a base set of endpoints exposing the server's OpenAPI specification.
  *
- * - `GET /` — Swagger UI HTML (loads swagger-ui-dist from CDN)
- * - `GET /openapi.json` — raw OpenAPI specification as JSON
- * - `GET /openapi.yaml` — raw OpenAPI specification as YAML
+ * Exposed endpoints:
+ *
+ * | Name | HTTP Method | What it does |
+ * | --- | --- | --- |
+ * | `getHTML` | `GET /<base_path>` | Swagger UI HTML (loads swagger-ui-dist from CDN) |
+ * | `getJSON` | `GET /<base_path>/json` | raw OpenAPI specification as JSON |
+ * | `getYAML` | `GET /<base_path>/yaml` | raw OpenAPI specification as YAML |
+ *
+ * !!Note!! that the `BaseAdminRoute` is not automatically registered with a server by default. You must create
+ * your own class that extends `AdminRoute` and apply the desired base path with `@Route()`.
+ *
+ * @example
+ * ```ts
+ * import { BaseOpenAPIRoute, RouteDecorators } from "@rapidrest/service-core";
+ * const { Route } = RouteDecorators;
+ *
+ * @Route("/openapi")
+ * export class OpenAPIRoute extends BaseOpenAPIRoute {}
+ * ```
  *
  * @author Jean-Philippe Steinmetz
  */
-let OpenAPIRoute = class OpenAPIRoute {
+export class BaseOpenAPIRoute {
     constructor() {
         /** The underlying OpenAPI specification. */
         this.apiSpec = new OpenApiSpec();
@@ -55,61 +71,44 @@ let OpenAPIRoute = class OpenAPIRoute {
     getHTML() {
         return swaggerHtml("/openapi.json");
     }
-    getAPIDocs() {
-        return swaggerHtml("/openapi.json");
-    }
     getJSON() {
         return this.apiSpec.getSpec();
     }
     getYAML() {
         return this.apiSpec.getSpecAsYaml();
     }
-};
+}
 __decorate([
     Inject(OpenApiSpec),
     __metadata("design:type", OpenApiSpec)
-], OpenAPIRoute.prototype, "apiSpec", void 0);
-__decorate([
-    Summary("{{serviceName}} OpenAPI, HTLM format"),
-    Description("Returns the OpenAPI specification for the service in HTML format."),
-    Get(),
-    ContentType("text/html"),
-    Returns([String]),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", []),
-    __metadata("design:returntype", String)
-], OpenAPIRoute.prototype, "getHTML", null);
+], BaseOpenAPIRoute.prototype, "apiSpec", void 0);
 __decorate([
     Summary("{{serviceName}} API docs"),
     Description("Returns the OpenAPI specification for the service in HTML format."),
-    Get("api-docs"),
+    Get(),
     ContentType("text/html"),
     Returns([String]),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", []),
     __metadata("design:returntype", String)
-], OpenAPIRoute.prototype, "getAPIDocs", null);
+], BaseOpenAPIRoute.prototype, "getHTML", null);
 __decorate([
     Summary("{{serviceName}} OpenAPI, JSON format"),
     Description("Returns the OpenAPI specification for the service in JSON format."),
-    Get("openapi.json"),
+    Get("json"),
     Returns([String]),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", []),
     __metadata("design:returntype", Object)
-], OpenAPIRoute.prototype, "getJSON", null);
+], BaseOpenAPIRoute.prototype, "getJSON", null);
 __decorate([
     Summary("{{serviceName}} OpenAPI, YAML format"),
     Description("Returns the OpenAPI specification for the service in YAML format."),
-    Get("openapi.yaml"),
+    Get("yaml"),
     ContentType("text/yaml"),
     Returns([String]),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", []),
     __metadata("design:returntype", String)
-], OpenAPIRoute.prototype, "getYAML", null);
-OpenAPIRoute = __decorate([
-    Route("/")
-], OpenAPIRoute);
-export { OpenAPIRoute };
-//# sourceMappingURL=OpenAPIRoute.js.map
+], BaseOpenAPIRoute.prototype, "getYAML", null);
+//# sourceMappingURL=BaseOpenAPIRoute.js.map

package/dist/lib/routes/BaseOpenAPIRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseOpenAPIRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseOpenAPIRoute.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AACpE,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;AAEpC,kGAAkG;AAClG,SAAS,WAAW,CAAC,OAAe;IAChC,OAAO;;;;;;;;;;;;cAYG,OAAO;;;;;;;QAOb,CAAC;AACT,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,gBAAgB;IAA7B;QACI,4CAA4C;QAElC,YAAO,GAAgB,IAAI,WAAW,EAAE,CAAC;IA2BvD,CAAC;IApBU,OAAO;QACV,OAAO,WAAW,CAAC,eAAe,CAAC,CAAC;IACxC,CAAC;IAMM,OAAO;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;IAClC,CAAC;IAOM,OAAO;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;IACxC,CAAC;CACJ;AA3Ba;IADT,MAAM,CAAC,WAAW,CAAC;8BACD,WAAW;iDAAqB;AAO5C;IALN,OAAO,CAAC,0BAA0B,CAAC;IACnC,WAAW,CAAC,mEAAmE,CAAC;IAChF,GAAG,EAAE;IACL,WAAW,CAAC,WAAW,CAAC;IACxB,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;;;;+CAGjB;AAMM;IAJN,OAAO,CAAC,sCAAsC,CAAC;IAC/C,WAAW,CAAC,mEAAmE,CAAC;IAChF,GAAG,CAAC,MAAM,CAAC;IACX,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;;;;+CAGjB;AAOM;IALN,OAAO,CAAC,sCAAsC,CAAC;IAC/C,WAAW,CAAC,mEAAmE,CAAC;IAChF,GAAG,CAAC,MAAM,CAAC;IACX,WAAW,CAAC,WAAW,CAAC;IACxB,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;;;;+CAGjB"}

package/dist/lib/routes/BasePushRoute.js

@@ -0,0 +1,193 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+import { ApiError, ObjectDecorators } from "@rapidrest/core";
+import { Auth, Param, Post, Socket, User, WebSocket } from "../decorators/RouteDecorators.js";
+import { ACLUtils } from "../security/ACLUtils.js";
+import ws from "ws";
+import { Redis } from "ioredis";
+import { Description, Summary } from "../decorators/DocDecorators.js";
+import { ACLAction } from "../security/AccessControlList.js";
+import { ApiErrorMessages, ApiErrors } from "../ApiErrors.js";
+const { Config, Init, Inject, Logger } = ObjectDecorators;
+/**
+ * The `BasePushRoute` class provides a base set of endpoints for implement client push notifications.
+ *
+ * Exposed endpoints:
+ *
+ * | Name | HTTP Method | What it does |
+ * | --- | --- | --- |
+ * | `connect` | `UPGRADE /<base_path>/connect` | Establishes a connection to the push notification system. |
+ * | `send` | `POST /<base_path>/:id` | Sends a push notification message to the channel with the given id |
+ *
+ * !!Note!! that the `BasePushRoute` is not automatically registered with a server by default. You must create
+ * your own class that extends `AdminRoute` and apply the desired base path with `@Route()`.
+ *
+ * @example
+ * ```ts
+ * import { BasePushRoute, RouteDecorators } from "@rapidrest/service-core";
+ * const { Route } = RouteDecorators;
+ *
+ * @Route("/push")
+ * export class PushRoute extends BasePushRoute {}
+ * ```
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export class BasePushRoute {
+    constructor() {
+        /** A map of active socket connections to users.  */
+        this.activeSocks = new Map();
+        /** A map of active subscription uids to users. */
+        this.activeSubs = new Map();
+    }
+    init() {
+        if (this.redisConfig) {
+            this.redisPub = new Redis(this.redisConfig.url, this.redisConfig.options);
+        }
+        else {
+            this.logger.warn("Could not initialize the push notification publisher. The `events` datastore is not configured.");
+        }
+    }
+    async connect(sock, user) {
+        // Establish a new redis pub/sub client for this connection
+        const redis = new Redis(this.redisConfig.url, this.redisConfig.options);
+        const subs = this.activeSubs.get(user.uid) ?? [user.uid];
+        try {
+            await redis.subscribe(...subs);
+            this.logger.info(`User ${user.uid} successfully subscribed to push channels: ${subs}`);
+            sock.send(JSON.stringify({ id: 0, type: "SUBSCRIBED", success: true, data: subs }));
+            this.activeSubs.set(user.uid, subs);
+        }
+        catch (err) {
+            this.logger.error(`Failed to subscribe to push channels: user: ${user.uid}, subs: ${subs}`);
+            this.logger.debug(err);
+        }
+        // Track the socket so it doesn't get automatically cleaned up
+        const socks = this.activeSocks.get(user.uid) || [];
+        socks.push(sock);
+        this.activeSocks.set(user.uid, socks);
+        // Set up the outgoing message forwarding handler to the client
+        redis.on("message", (channel, message) => {
+            this.logger.debug(`Forwarding message to ${user.uid}`);
+            sock.send(message, (err) => {
+                if (err) {
+                    this.logger.debug(`Failed to forward message to ${user.uid}`);
+                }
+            });
+        });
+        // Set up the incoming message handler from the client
+        sock.on("message", async (data, isBinary) => {
+            if (!isBinary) {
+                try {
+                    // Decode the incoming message
+                    const message = JSON.parse(data);
+                    const origSubs = this.activeSubs.get(user.uid) ?? [user.uid];
+                    if (message.type === "SUBSCRIBE") {
+                        const subs = Array.isArray(message.data) ? message.data : [message.data];
+                        const subd = [];
+                        // Check that the user has permission for each requested channel
+                        for (const channel of subs) {
+                            if (await this.aclUtils?.hasPermission(user, channel, ACLAction.READ)) {
+                                subd.push(channel);
+                            }
+                        }
+                        // Subscribe to all approved channels
+                        await redis.subscribe(...subd);
+                        this.activeSubs.set(user.uid, origSubs.concat(subd));
+                        sock.send(JSON.stringify({ id: message.id, type: "SUBSCRIBED", success: true, data: subd }));
+                    }
+                    if (message.type === "UNSUBSCRIBE") {
+                        const subs = Array.isArray(message.data) ? message.data : [message.data];
+                        await redis.unsubscribe(...subs);
+                        for (const channel of subs) {
+                            origSubs.splice(origSubs.indexOf(channel), 1);
+                        }
+                        this.activeSubs.set(user.uid, origSubs);
+                        sock.send(JSON.stringify({ id: message.id, type: "UNSUBSCRIBED", success: true, data: subs }));
+                    }
+                    else {
+                        this.logger.debug(`Received invalid message from user ${user.uid}.`);
+                    }
+                }
+                catch (err) {
+                    this.logger.debug(`Received invalid message from user ${user.uid}.`);
+                }
+            }
+        });
+        // Set up the close connection handler
+        sock.on("close", async (code, reason) => {
+            // Unsubscribe from all redis pub/sub channels
+            const subs = this.activeSubs.get(user.uid);
+            if (subs) {
+                await redis.unsubscribe(...subs);
+            }
+            // Disconnect the redis client
+            redis.disconnect();
+            // Remove the socket from our tracked list
+            const socks = this.activeSocks.get(user.uid) || [];
+            socks.splice(socks.indexOf(sock), 1);
+            this.activeSocks.set(user.uid, socks);
+        });
+    }
+    async send(id, msg, user) {
+        if (!(await this.aclUtils?.hasPermission(user, id, ACLAction.CREATE))) {
+            throw new ApiError(ApiErrors.AUTH_PERMISSION_FAILURE, 403, ApiErrorMessages.AUTH_PERMISSION_FAILURE);
+        }
+        if (!this.redisPub) {
+            this.logger.error(`Failed to send push message to channel ${id}. The \`events\` datastore is not configured.`);
+            throw new ApiError(ApiErrors.INTERNAL_ERROR, 500, ApiErrorMessages.INTERNAL_ERROR);
+        }
+        await this.redisPub.publish(id, JSON.stringify({ type: "MESSAGE", channel: id, data: msg }));
+    }
+}
+__decorate([
+    Inject(ACLUtils),
+    __metadata("design:type", ACLUtils)
+], BasePushRoute.prototype, "aclUtils", void 0);
+__decorate([
+    Logger,
+    __metadata("design:type", Object)
+], BasePushRoute.prototype, "logger", void 0);
+__decorate([
+    Config("datastores:events"),
+    __metadata("design:type", Object)
+], BasePushRoute.prototype, "redisConfig", void 0);
+__decorate([
+    Init,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], BasePushRoute.prototype, "init", null);
+__decorate([
+    Summary("Push connect"),
+    Description("Establishes a connection to the push notification system."),
+    Auth(["jwt"]),
+    WebSocket(),
+    __param(0, Socket),
+    __param(1, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [ws, Object]),
+    __metadata("design:returntype", Promise)
+], BasePushRoute.prototype, "connect", null);
+__decorate([
+    Summary("Send push"),
+    Description("Sends a push notification message to the channel with the given id."),
+    Auth(["jwt"]),
+    Post("/:id"),
+    __param(0, Param("id")),
+    __param(2, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], BasePushRoute.prototype, "send", null);
+//# sourceMappingURL=BasePushRoute.js.map

package/dist/lib/routes/BasePushRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BasePushRoute.js","sourceRoot":"","sources":["../../../src/routes/BasePushRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC9F,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC9D,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,OAAO,aAAa;IAA1B;QAII,oDAAoD;QAC5C,gBAAW,GAAsB,IAAI,GAAG,EAAE,CAAC;QAEnD,kDAAkD;QAC1C,eAAU,GAA0B,IAAI,GAAG,EAAE,CAAC;IA+H1D,CAAC;IAnHW,IAAI;QACR,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC9E,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iGAAiG,CAAC,CAAC;QACxH,CAAC;IACL,CAAC;IAMY,AAAN,KAAK,CAAC,OAAO,CAAS,IAAQ,EAAQ,IAAS;QAClD,2DAA2D;QAC3D,MAAM,KAAK,GAAU,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAC/E,MAAM,IAAI,GAAa,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnE,IAAI,CAAC;YACD,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;YAC/B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,GAAG,8CAA8C,IAAI,EAAE,CAAC,CAAC;YACvF,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACpF,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+CAA+C,IAAI,CAAC,GAAG,WAAW,IAAI,EAAE,CAAC,CAAC;YAC5F,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAED,8DAA8D;QAC9D,MAAM,KAAK,GAAS,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACzD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAEtC,+DAA+D;QAC/D,KAAK,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,OAAe,EAAE,OAAe,EAAE,EAAE;YACrD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,yBAAyB,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YACvD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;gBACvB,IAAI,GAAG,EAAE,CAAC;oBACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gCAAgC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;gBAClE,CAAC;YACL,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,sDAAsD;QACtD,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,IAAS,EAAE,QAAiB,EAAE,EAAE;YACtD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACZ,IAAI,CAAC;oBACD,8BAA8B;oBAC9B,MAAM,OAAO,GAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;oBACtC,MAAM,QAAQ,GAAa,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAEvE,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;wBAC/B,MAAM,IAAI,GAAa,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;wBACnF,MAAM,IAAI,GAAa,EAAE,CAAC;wBAC1B,gEAAgE;wBAChE,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE,CAAC;4BACzB,IAAI,MAAM,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;gCACpE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;4BACvB,CAAC;wBACL,CAAC;wBAED,qCAAqC;wBACrC,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;wBAC/B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;wBACrD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;oBACjG,CAAC;oBACD,IAAI,OAAO,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;wBACjC,MAAM,IAAI,GAAa,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;wBACnF,MAAM,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;wBACjC,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE,CAAC;4BACzB,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;wBAClD,CAAC;wBACD,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;wBACxC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;oBACnG,CAAC;yBAAM,CAAC;wBACJ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sCAAsC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;oBACzE,CAAC;gBACL,CAAC;gBAAC,OAAO,GAAQ,EAAE,CAAC;oBAChB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sCAAsC,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;gBACzE,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,sCAAsC;QACtC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,IAAY,EAAE,MAAc,EAAE,EAAE;YACpD,8CAA8C;YAC9C,MAAM,IAAI,GAAyB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACjE,IAAI,IAAI,EAAE,CAAC;gBACP,MAAM,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC;YACrC,CAAC;YAED,8BAA8B;YAC9B,KAAK,CAAC,UAAU,EAAE,CAAC;YAEnB,0CAA0C;YAC1C,MAAM,KAAK,GAAS,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YACzD,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACrC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACP,CAAC;IAMY,AAAN,KAAK,CAAC,IAAI,CAAc,EAAU,EAAE,GAAQ,EAAQ,IAAS;QAChE,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YACpE,MAAM,IAAI,QAAQ,CAAC,SAAS,CAAC,uBAAuB,EAAE,GAAG,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;QACzG,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACjB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0CAA0C,EAAE,+CAA+C,CAAC,CAAC;YAC/G,MAAM,IAAI,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,GAAG,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;QACvF,CAAC;QAED,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IACjG,CAAC;CACJ;AArIW;IADP,MAAM,CAAC,QAAQ,CAAC;8BACE,QAAQ;+CAAC;AASpB;IADP,MAAM;;6CACa;AAGZ;IADP,MAAM,CAAC,mBAAmB,CAAC;;kDACH;AAMjB;IADP,IAAI;;;;yCAOJ;AAMY;IAJZ,OAAO,CAAC,cAAc,CAAC;IACvB,WAAW,CAAC,2DAA2D,CAAC;IACxE,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;IACb,SAAS,EAAE;IACU,WAAA,MAAM,CAAA;IAAY,WAAA,IAAI,CAAA;;qCAAT,EAAE;;4CAqFpC;AAMY;IAJZ,OAAO,CAAC,WAAW,CAAC;IACpB,WAAW,CAAC,qEAAqE,CAAC;IAClF,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;IACb,IAAI,CAAC,MAAM,CAAC;IACM,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IAAwB,WAAA,IAAI,CAAA;;;;yCAWzD"}