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

package/dist/lib/routes/BaseStaticRoute.js

@@ -0,0 +1,152 @@
+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); }
+};
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+import { Get, Request, Response } from "../decorators/RouteDecorators.js";
+import { Summary } from "../decorators/DocDecorators.js";
+import * as fs from "fs";
+import * as path from "path";
+import { ObjectDecorators } from "@rapidrest/core";
+const { Config, Init } = ObjectDecorators;
+/** MIME types for static file serving. */
+const MIME_TYPES = {
+    ".html": "text/html",
+    ".css": "text/css",
+    ".js": "application/javascript",
+    ".mjs": "application/javascript",
+    ".json": "application/json",
+    ".png": "image/png",
+    ".jpg": "image/jpeg",
+    ".jpeg": "image/jpeg",
+    ".gif": "image/gif",
+    ".svg": "image/svg+xml",
+    ".ico": "image/x-icon",
+    ".woff": "font/woff",
+    ".woff2": "font/woff2",
+    ".ttf": "font/ttf",
+    ".txt": "text/plain",
+    ".map": "application/json",
+};
+/**
+ * The `BaseStaticRoute` class provides a single endpoint for serving static files from a designated path on the filesystem (e.g. `./public`).
+ * Uses the path specified in the project configuration key `static_files`. Default is `public`.
+ *
+ * Exposed endpoints:
+ *
+ * | Name | HTTP Method | What it does |
+ * | --- | --- | --- |
+ * | `get` | `GET /<base_path>/*` | Serves static files from the configured `static_files`. |
+ *
+ * !!Note!! that the `BaseStaticRoute` 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 { BaseStaticRoute, RouteDecorators } from "@rapidrest/service-core";
+ * const { Route } = RouteDecorators;
+ *
+ * @Route("/static")
+ * export class StaticRoute extends BaseStaticRoute {}
+ * ```
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+let BaseStaticRoute = class BaseStaticRoute {
+    constructor() {
+        /**
+         * The URL prefix derived from `@Route` metadata at init time.
+         * E.g. `@Route("/app/*")` → prefix = "/app". Used to strip the prefix from req.path
+         * before resolving app page files, and to scope the dev-reload SSE endpoint.
+         */
+        this.routePrefix = "";
+        /** The location of the static files to serve. Defaults to `./public`. */
+        this.staticDir = "public";
+    }
+    async init() {
+        // Derive the route prefix from @Route metadata so page resolution is prefix-agnostic.
+        // @Route("/app/*") → prefix "/app", @Route("/*") → prefix ""
+        const routePaths = Reflect.getMetadata("rrst:routePaths", Object.getPrototypeOf(this)) || [];
+        this.routePrefix = (routePaths[0] || "")
+            .replace(/\/\*$/, "") // strip trailing /*
+            .replace(/\/$/, ""); // strip trailing /
+    }
+    /**
+     * Resolve a file in the static directory by trying multiple extensions in order.
+     * If the path segment ends in a `/`, `index.html` is automatically appended.
+     *
+     * @returns The full path to the file on disk if exists, otherwise `null`.
+     */
+    resolveFile(segment) {
+        const root = path.resolve(process.cwd(), this.staticDir);
+        let file = path.resolve(root, segment.replace(/^\//, ""));
+        if (file.endsWith("/")) {
+            file += "index.html";
+        }
+        // Reject any path that escapes the configured static directory (e.g. via `../` segments).
+        // Without this check a request path is joined onto `root` and resolved as-is, so a raw
+        // (non-normalizing) HTTP client could read arbitrary files reachable from `root`.
+        if (file !== root && !file.startsWith(root + path.sep)) {
+            return null;
+        }
+        if (fs.existsSync(file)) {
+            return file;
+        }
+        return null;
+    }
+    async get(req, res) {
+        // Strip the route prefix (e.g. "/app" from "/app/pets" → "/pets") so the page
+        // file resolution is independent of where the route is mounted.
+        const subPath = this.routePrefix && req.path.startsWith(this.routePrefix)
+            ? req.path.slice(this.routePrefix.length) || "/"
+            : req.path;
+        const requestedPath = subPath === "/" ? "index.html" : subPath.replace(/^\/+/, "");
+        const filePath = this.resolveFile(requestedPath);
+        if (!filePath) {
+            res.status(404).end();
+            return;
+        }
+        try {
+            const ext = path.extname(filePath);
+            const data = await fs.promises.readFile(filePath);
+            res.setHeader("content-type", MIME_TYPES[ext] || "application/octet-stream");
+            res.end(data);
+        }
+        catch {
+            res.status(404).end();
+        }
+    }
+};
+__decorate([
+    Config("static_files", "public"),
+    __metadata("design:type", String)
+], BaseStaticRoute.prototype, "staticDir", void 0);
+__decorate([
+    Init,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], BaseStaticRoute.prototype, "init", null);
+__decorate([
+    Get("/*"),
+    __param(0, Request),
+    __param(1, Response),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseStaticRoute.prototype, "get", null);
+BaseStaticRoute = __decorate([
+    Summary("Serves static files from the filesystem.")
+], BaseStaticRoute);
+export { BaseStaticRoute };
+//# sourceMappingURL=BaseStaticRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseStaticRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseStaticRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAEzD,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,gBAAgB,CAAC;AAE1C,0CAA0C;AAC1C,MAAM,UAAU,GAA2B;IACvC,OAAO,EAAE,WAAW;IACpB,MAAM,EAAE,UAAU;IAClB,KAAK,EAAE,wBAAwB;IAC/B,MAAM,EAAE,wBAAwB;IAChC,OAAO,EAAE,kBAAkB;IAC3B,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,YAAY;IACpB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,eAAe;IACvB,MAAM,EAAE,cAAc;IACtB,OAAO,EAAE,WAAW;IACpB,QAAQ,EAAE,YAAY;IACtB,MAAM,EAAE,UAAU;IAClB,MAAM,EAAE,YAAY;IACpB,MAAM,EAAE,kBAAkB;CAC7B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEI,IAAM,eAAe,GAArB,MAAM,eAAe;IAArB;QACH;;;;WAIG;QACO,gBAAW,GAAW,EAAE,CAAC;QAEnC,yEAAyE;QAEtD,cAAS,GAAW,QAAQ,CAAC;IAgEpD,CAAC;IA7DmB,AAAN,KAAK,CAAC,IAAI;QAChB,sFAAsF;QACtF,6DAA6D;QAC7D,MAAM,UAAU,GAAa,OAAO,CAAC,WAAW,CAAC,iBAAiB,EAAE,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;QACvG,IAAI,CAAC,WAAW,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACnC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,oBAAoB;aACzC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,mBAAmB;IAChD,CAAC;IAED;;;;;OAKG;IACK,WAAW,CAAC,OAAe;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACzD,IAAI,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;QAC1D,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACrB,IAAI,IAAI,YAAY,CAAC;QACzB,CAAC;QAED,0FAA0F;QAC1F,uFAAuF;QACvF,kFAAkF;QAClF,IAAI,IAAI,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACrD,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAGY,AAAN,KAAK,CAAC,GAAG,CAAU,GAAgB,EAAY,GAAiB;QACnE,8EAA8E;QAC9E,gEAAgE;QAChE,MAAM,OAAO,GACT,IAAI,CAAC,WAAW,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC;YACrD,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,GAAG;YAChD,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;QAEnB,MAAM,aAAa,GAAG,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACnF,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;YACtB,OAAO;QACX,CAAC;QAED,IAAI,CAAC;YACD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACnC,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAClD,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,UAAU,CAAC,GAAG,CAAC,IAAI,0BAA0B,CAAC,CAAC;YAC7E,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QAAC,MAAM,CAAC;YACL,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;QAC1B,CAAC;IACL,CAAC;CACJ,CAAA;AAhEsB;IADlB,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC;;kDACe;AAGhC;IADf,IAAI;;;;2CAQJ;AA8BY;IADZ,GAAG,CAAC,IAAI,CAAC;IACQ,WAAA,OAAO,CAAA;IAAoB,WAAA,QAAQ,CAAA;;;;0CAuBpD;AAzEQ,eAAe;IAD3B,OAAO,CAAC,0CAA0C,CAAC;GACvC,eAAe,CA0E3B"}

package/dist/lib/routes/BaseStatusRoute.js

@@ -0,0 +1,79 @@
+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);
+};
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+import { Get } from "../decorators/RouteDecorators.js";
+import { Description, Returns, Summary } from "../decorators/DocDecorators.js";
+import { ObjectDecorators } from "@rapidrest/core";
+import { StatusExtraData } from "../models/StatusExtraData.js";
+const { Config, Inject } = ObjectDecorators;
+/**
+ * The `BaseStatusRoute` class provides a base set of endpoints exposing status metadata information about the server.
+ *
+ * Included Metadata:
+ * | Name | Description |
+ * | --- | --- |
+ * | `name` | The name of the server (e.g. `petstore_example`) |
+ * | `time` | The current UTC timestamp of the server |
+ * | `version` | The release version of the server. (e.g. `1.0.0`) |
+ *
+ * Exposed endpoints:
+ *
+ * | Name | HTTP Method | What it does |
+ * | --- | --- | --- |
+ * | `get` | `GET /<base_path>` | Returns the server's status metadata |
+ *
+ * !!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 { BaseStatusRoute, RouteDecorators } from "@rapidrest/service-core";
+ * const { Route } = RouteDecorators;
+ *
+ * @Route("/status")
+ * export class StatusRoute extends BaseStatusRoute {}
+ * ```
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export class BaseStatusRoute {
+    get() {
+        return {
+            name: this.serviceName,
+            time: Date.now(),
+            version: this.serviceVersion,
+            ...this.statusExtraData?.data,
+        };
+    }
+}
+__decorate([
+    Config("service_name"),
+    __metadata("design:type", Object)
+], BaseStatusRoute.prototype, "serviceName", void 0);
+__decorate([
+    Config("version"),
+    __metadata("design:type", Object)
+], BaseStatusRoute.prototype, "serviceVersion", void 0);
+__decorate([
+    Inject(StatusExtraData),
+    __metadata("design:type", Object)
+], BaseStatusRoute.prototype, "statusExtraData", void 0);
+__decorate([
+    Summary("Server status"),
+    Description("Returns information about the server and it's operational status."),
+    Get(),
+    Returns([Object]),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Object)
+], BaseStatusRoute.prototype, "get", null);
+//# sourceMappingURL=BaseStatusRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseStatusRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseStatusRoute.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,OAAO,EAAE,GAAG,EAAE,MAAM,kCAAkC,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAC/E,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,OAAO,eAAe;IAajB,GAAG;QACN,OAAO;YACH,IAAI,EAAE,IAAI,CAAC,WAAW;YACtB,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;YAChB,OAAO,EAAE,IAAI,CAAC,cAAc;YAC5B,GAAG,IAAI,CAAC,eAAe,EAAE,IAAI;SAChC,CAAC;IACN,CAAC;CACJ;AAnBa;IADT,MAAM,CAAC,cAAc,CAAC;;oDACI;AAEjB;IADT,MAAM,CAAC,SAAS,CAAC;;uDACY;AAGpB;IADT,MAAM,CAAC,eAAe,CAAC;;wDAC+B;AAMhD;IAJN,OAAO,CAAC,eAAe,CAAC;IACxB,WAAW,CAAC,mEAAmE,CAAC;IAChF,GAAG,EAAE;IACL,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;;;;0CAQjB"}

package/dist/lib/routes/CRUDRoute.js

@@ -0,0 +1,238 @@
+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); }
+};
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz. All rights reserved.
+///////////////////////////////////////////////////////////////////////////////
+import { RepoUtils } from "../models/RepoUtils.js";
+import { Description, Returns, Summary, TypeInfo } from "../decorators/DocDecorators.js";
+import { Delete, Get, Head, Param, Post, Put, Query, Request, Response, User, Validate, } from "../decorators/RouteDecorators.js";
+import { ModelRoute } from "./ModelRoute.js";
+/**
+ * The `CRUDRoute` provides a base implementation of all CRUD endpoint behaviors that `ModelRoute` offers for a given
+ * data model class. This class provides the most common default settings for each route handler. If you desire additional
+ * functionality you may override the handler function and add desired functionality via additional decorators or override
+ * existing decorator behavior.
+ *
+ * The route endpoints provided by this class do not explicitly require authentication. However, if the RBAC system
+ * is enabled these handlers will still validate permissions appropriately.
+ *
+ * Included Endpoints:
+ *
+ * | Name | HTTP Method | What it does |
+ * | --- | --- | --- |
+ * | `count` | `HEAD /` | Counts the number of objects matching the provided set of criteria in the request's query parameters. Returns the count as the value of the `Content-Length` header. |
+ * | `create` | `POST /` | Adds one or more new objects to the datastore. |
+ * | `delete` | `DELETE /:id` | Removes an existing object from the datastore. |
+ * | `exists` | `HEAD /:id` | Checks if the object with the given ID exists in the datastore. Sets `Content-Length` header to `1` if the object exists, otherwise `0`. |
+ * | `find` | `GET /` | Returns all objects matching the provided set of criteria in the request's query parameters. |
+ * | `findById` | `GET /:id` | Returns a single object with a specified unique identifier. |
+ * | `truncate` | `DELETE /` | Removes all objects from the datastore. |
+ * | `update` | `PUT /:id` | Modifies an existing object in the datastore. |
+ * | `updateBulk` | `PUT /` | Modifies multiple existing objects in the datastore. |
+ * | `updateProperty` | `PUT /:id/:property` | Modifies an single property of the given name of an existing object in the datastore. |
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export class CRUDRoute extends ModelRoute {
+    constructor() {
+        super(...arguments);
+        this.repoUtilsClass = RepoUtils;
+    }
+    async count(params, query, res, user) {
+        return super.doCount({ params, query, res, user });
+    }
+    validateCreate(obj, user) {
+        return super.validate(obj, { user });
+    }
+    create(obj, req, user) {
+        return super.doCreate(obj, { req, user });
+    }
+    async delete(id, version, purge, req, user) {
+        return super.doDelete(id, { user, req, version, purge: purge === "true" });
+    }
+    async exists(id, query, res, user) {
+        return super.doExists(id, { query, res, user });
+    }
+    async find(params, query, user) {
+        return super.doFind({ params, query, user });
+    }
+    async findById(id, query, user) {
+        return super.doFindById(id, { query, user });
+    }
+    async truncate(params, query, user) {
+        return super.doTruncate({ params, query, user });
+    }
+    async validateUpdate(id, obj, user) {
+        return this.validate(obj, { user });
+    }
+    async update(id, obj, req, user) {
+        return super.doUpdate(id, obj, { user });
+    }
+    async validateUpdateBulk(objs, user) {
+        return super.validate(objs, { user });
+    }
+    async updateBulk(obj, req, user) {
+        return super.doBulkUpdate(obj, { user, req });
+    }
+    updateProperty(id, propertyName, obj, user) {
+        return super.doUpdateProperty(id, propertyName, obj, { user });
+    }
+}
+__decorate([
+    Summary("Count {{name}}s"),
+    Description("Returns the total count of {{name}}s in the datastore based on the given criteria " +
+        "in the header as `Content-Length`."),
+    Returns([null]),
+    Head(),
+    __param(0, Param()),
+    __param(1, Query()),
+    __param(2, Response),
+    __param(3, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Object, Object, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "count", null);
+__decorate([
+    __param(1, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Object]),
+    __metadata("design:returntype", void 0)
+], CRUDRoute.prototype, "validateCreate", null);
+__decorate([
+    Summary("Create {{model}}(s)"),
+    Description("Create a new {{model}}."),
+    Returns([Object]),
+    Post(),
+    Validate("validateCreate"),
+    __param(1, Request),
+    __param(2, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Object, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "create", null);
+__decorate([
+    Summary("Delete {{name}} by ID"),
+    Description("Deletes the {{name}} from the service."),
+    Returns([null]),
+    Delete("/:id"),
+    __param(0, Param("id")),
+    __param(1, Query("version")),
+    __param(2, Query("purge")),
+    __param(3, Request),
+    __param(4, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object, Object, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "delete", null);
+__decorate([
+    Summary("Exists"),
+    Description("Returns the total count of {{name}}s in the datastore based on the given criteria " +
+        "in the header as `Content-Length`."),
+    Returns([null]),
+    Head("/:id"),
+    __param(0, Param("id")),
+    __param(1, Query()),
+    __param(2, Response),
+    __param(3, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "exists", null);
+__decorate([
+    Summary("Find All {{model}}s"),
+    Description("Returns all {{model}}s from the system that the user has access to."),
+    Returns([[Array, Object]]),
+    Get(),
+    __param(0, Param()),
+    __param(1, Query()),
+    __param(2, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Object, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "find", null);
+__decorate([
+    Summary("Find {{model}} by ID"),
+    Description("Returns a single {{model}} from the system that the user has access to."),
+    Returns([Object]),
+    Get("/:id"),
+    __param(0, Param("id")),
+    __param(1, Query()),
+    __param(2, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "findById", null);
+__decorate([
+    Summary("Truncate {{model}}s"),
+    Description("Deletes all {{model}}s from the datastore that the user has access to."),
+    Returns([null]),
+    Delete(),
+    __param(0, Param()),
+    __param(1, Query()),
+    __param(2, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Object, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "truncate", null);
+__decorate([
+    __param(0, Param("id")),
+    __param(2, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "validateUpdate", null);
+__decorate([
+    Summary("Update {{model}} by ID"),
+    Description("Updates a single {{model}}."),
+    Returns([Object]),
+    Put("/:id"),
+    Validate("validateUpdate"),
+    __param(0, Param("id")),
+    __param(2, Request),
+    __param(3, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "update", null);
+__decorate([
+    __param(1, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "validateUpdateBulk", null);
+__decorate([
+    Summary("Update {{model}}s in bulk"),
+    Description("Updates a collection of existing {{model}}s."),
+    Returns([[Array, Object]]),
+    Put(),
+    Validate("validateUpdateBulk"),
+    __param(1, Request),
+    __param(2, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "updateBulk", null);
+__decorate([
+    Summary("Update {{model}} by ID and property"),
+    Put(":id/:property"),
+    Description("Updates a single property of an existing {{model}}."),
+    TypeInfo([Object]),
+    Returns([Object]),
+    __param(0, Param("id")),
+    __param(1, Param("property")),
+    __param(3, User),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], CRUDRoute.prototype, "updateProperty", null);
+//# sourceMappingURL=CRUDRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CRUDRoute.js","sourceRoot":"","sources":["../../../src/routes/CRUDRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAKnD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AACzF,OAAO,EACH,MAAM,EACN,GAAG,EACH,IAAI,EACJ,KAAK,EACL,IAAI,EACJ,GAAG,EACH,KAAK,EACL,OAAO,EACP,QAAQ,EACR,IAAI,EACJ,QAAQ,GACX,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAgB,MAAM,iBAAiB,CAAC;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAgB,SAA+C,SAAQ,UAAa;IAA1F;;QACuB,mBAAc,GAAQ,SAAS,CAAC;IAiIvD,CAAC;IAxHgB,AAAN,KAAK,CAAC,KAAK,CACL,MAAW,EACX,KAAU,EACT,GAAiB,EACrB,IAAc;QAEpB,OAAO,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IACvD,CAAC;IAES,cAAc,CAAC,GAA8B,EAAQ,IAAc;QACzE,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IAOM,MAAM,CAAC,GAAY,EAAW,GAAgB,EAAQ,IAAc;QACvE,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9C,CAAC;IAMY,AAAN,KAAK,CAAC,MAAM,CACF,EAAU,EACL,OAA2B,EAC7B,KAAyB,EAChC,GAAgB,EACnB,IAAc;QAEpB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,KAAK,MAAM,EAAE,CAAC,CAAC;IAC/E,CAAC;IASY,AAAN,KAAK,CAAC,MAAM,CACF,EAAU,EACd,KAAU,EACT,GAAiB,EACrB,IAAc;QAEpB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IACpD,CAAC;IAMY,AAAN,KAAK,CAAC,IAAI,CAAU,MAAW,EAAW,KAAU,EAAQ,IAAc;QAC7E,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;IAMY,AAAN,KAAK,CAAC,QAAQ,CAAc,EAAU,EAAW,KAAU,EAAQ,IAAc;QACpF,OAAO,KAAK,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACjD,CAAC;IAMY,AAAN,KAAK,CAAC,QAAQ,CAAU,MAAW,EAAW,KAAU,EAAQ,IAAc;QACjF,OAAO,KAAK,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACrD,CAAC;IAEe,AAAN,KAAK,CAAC,cAAc,CAAc,EAAU,EAAE,GAAoB,EAAQ,IAAc;QAC9F,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACxC,CAAC;IAOY,AAAN,KAAK,CAAC,MAAM,CACF,EAAU,EACvB,GAAoB,EACX,GAAgB,EACnB,IAAc;QAEpB,OAAO,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7C,CAAC;IAEe,AAAN,KAAK,CAAC,kBAAkB,CAAC,IAAuB,EAAQ,IAAc;QAC5E,OAAO,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1C,CAAC;IAOY,AAAN,KAAK,CAAC,UAAU,CAAC,GAAsB,EAAW,GAAgB,EAAQ,IAAc;QAC3F,OAAO,KAAK,CAAC,YAAY,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC;IAClD,CAAC;IAOM,cAAc,CACJ,EAAU,EACJ,YAAoB,EACvC,GAAQ,EACF,IAAc;QAEpB,OAAO,KAAK,CAAC,gBAAgB,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACnE,CAAC;CACJ;AAxHgB;IAPZ,OAAO,CAAC,iBAAiB,CAAC;IAC1B,WAAW,CACR,oFAAoF;QAChF,oCAAoC,CAC3C;IACA,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACf,IAAI,EAAE;IAEF,WAAA,KAAK,EAAE,CAAA;IACP,WAAA,KAAK,EAAE,CAAA;IACP,WAAA,QAAQ,CAAA;IACR,WAAA,IAAI,CAAA;;;;sCAGR;AAES;IAAgD,WAAA,IAAI,CAAA;;;;+CAE7D;AAOM;IALN,OAAO,CAAC,qBAAqB,CAAC;IAC9B,WAAW,CAAC,yBAAyB,CAAC;IACtC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IACjB,IAAI,EAAE;IACN,QAAQ,CAAC,gBAAgB,CAAC;IACE,WAAA,OAAO,CAAA;IAAoB,WAAA,IAAI,CAAA;;;;uCAE3D;AAMY;IAJZ,OAAO,CAAC,uBAAuB,CAAC;IAChC,WAAW,CAAC,wCAAwC,CAAC;IACrD,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACf,MAAM,CAAC,MAAM,CAAC;IAEV,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IACX,WAAA,KAAK,CAAC,SAAS,CAAC,CAAA;IAChB,WAAA,KAAK,CAAC,OAAO,CAAC,CAAA;IACd,WAAA,OAAO,CAAA;IACP,WAAA,IAAI,CAAA;;;;uCAGR;AASY;IAPZ,OAAO,CAAC,QAAQ,CAAC;IACjB,WAAW,CACR,oFAAoF;QAChF,oCAAoC,CAC3C;IACA,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACf,IAAI,CAAC,MAAM,CAAC;IAER,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IACX,WAAA,KAAK,EAAE,CAAA;IACP,WAAA,QAAQ,CAAA;IACR,WAAA,IAAI,CAAA;;;;uCAGR;AAMY;IAJZ,OAAO,CAAC,qBAAqB,CAAC;IAC9B,WAAW,CAAC,qEAAqE,CAAC;IAClF,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1B,GAAG,EAAE;IACa,WAAA,KAAK,EAAE,CAAA;IAAe,WAAA,KAAK,EAAE,CAAA;IAAc,WAAA,IAAI,CAAA;;;;qCAEjE;AAMY;IAJZ,OAAO,CAAC,sBAAsB,CAAC;IAC/B,WAAW,CAAC,yEAAyE,CAAC;IACtF,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IACjB,GAAG,CAAC,MAAM,CAAC;IACW,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IAAc,WAAA,KAAK,EAAE,CAAA;IAAc,WAAA,IAAI,CAAA;;;;yCAExE;AAMY;IAJZ,OAAO,CAAC,qBAAqB,CAAC;IAC9B,WAAW,CAAC,wEAAwE,CAAC;IACrF,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC;IACf,MAAM,EAAE;IACc,WAAA,KAAK,EAAE,CAAA;IAAe,WAAA,KAAK,EAAE,CAAA;IAAc,WAAA,IAAI,CAAA;;;;yCAErE;AAEe;IAAgB,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IAAoC,WAAA,IAAI,CAAA;;;;+CAElF;AAOY;IALZ,OAAO,CAAC,wBAAwB,CAAC;IACjC,WAAW,CAAC,6BAA6B,CAAC;IAC1C,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IACjB,GAAG,CAAC,MAAM,CAAC;IACX,QAAQ,CAAC,gBAAgB,CAAC;IAEtB,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IAEX,WAAA,OAAO,CAAA;IACP,WAAA,IAAI,CAAA;;;;uCAGR;AAEe;IAA6C,WAAA,IAAI,CAAA;;;;mDAEhE;AAOY;IALZ,OAAO,CAAC,2BAA2B,CAAC;IACpC,WAAW,CAAC,8CAA8C,CAAC;IAC3D,OAAO,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;IAC1B,GAAG,EAAE;IACL,QAAQ,CAAC,oBAAoB,CAAC;IACkB,WAAA,OAAO,CAAA;IAAoB,WAAA,IAAI,CAAA;;;;2CAE/E;AAOM;IALN,OAAO,CAAC,qCAAqC,CAAC;IAC9C,GAAG,CAAC,eAAe,CAAC;IACpB,WAAW,CAAC,qDAAqD,CAAC;IAClE,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;IAClB,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;IAEb,WAAA,KAAK,CAAC,IAAI,CAAC,CAAA;IACX,WAAA,KAAK,CAAC,UAAU,CAAC,CAAA;IAEjB,WAAA,IAAI,CAAA;;;;+CAGR"}

package/dist/lib/routes/ModelRoute.js

@@ -25,16 +25,23 @@ import { ObjectFactory } from "../ObjectFactory.js";
 const { Config, Init, Inject, Logger } = ObjectDecorators;
 /**
  * The `ModelRoute` is an abstract base class that provides a set of built-in route behavior functions for handling
- * requests for a given data model that is managed by a persistent datastore.
+ * requests for a given data model that is managed by a persistent datastore. This class _does not_ provide route
+ * handlers for the defined behaviors. This class is intended to serve as a base class for you to extend and hook
+ * up your own route handlers that use the included functionality as desired so that you only expose the CRUD
+ * endpoints for your model that you desire. If you desire a fully functional set of route handlers that implements
+ * all of these behaviors you should extend the `CRUDRoute` class instead.
  *
  * Provided behaviors:
- * * `count` - Counts the number of objects matching the provided set of criteria in the request's query parameters.
- * * `create` - Adds a new object to the datastore.
- * * `delete` - Removes an existing object from the datastore.
- * * `find` - Finds all objects matching the provided set of criteria in the request's query parameters.
- * * `findById` - Finds a single object with a specified unique identifier.
- * * `truncate` - Removes all objects from the datastore.
- * * `update` - Modifies an existing object in the datastore.
+ * * `doCount`: Counts the number of objects matching the provided set of criteria in the request's query parameters. Returns the count as the value of the `Content-Length` header.
+ * * `doCreate`: Adds one or more new objects to the datastore.
+ * * `doDelete`: Removes an existing object from the datastore.
+ * * `doExists`: Checks if the object with the given ID exists in the datastore. Sets `Content-Length` header to `1` if the object exists, otherwise `0`.
+ * * `doFind`: Returns all objects matching the provided set of criteria in the request's query parameters.
+ * * `doFindById`: Returns a single object with a specified unique identifier.
+ * * `doTruncate`: Removes all objects from the datastore.
+ * * `doUpdate`: Modifies an existing object in the datastore.
+ * * `doUpdateBulk`: Modifies multiple existing objects in the datastore.
+ * * `doUpdateProperty`: Modifies an single property of the given name of an existing object in the datastore.
  *
  * @author Jean-Philippe Steinmetz
  */
@@ -197,6 +204,7 @@ export class ModelRoute {
         }
         const existing = await this.repoUtils.findOne(id, {
             version: options.version,
+            user: options.user,
         });
         if (!existing) {
             throw new ApiError(ApiErrors.NOT_FOUND, 404, ApiErrorMessages.NOT_FOUND);
@@ -233,12 +241,6 @@ export class ModelRoute {
                 throw new ApiError(ApiErrors.SEARCH_INVALID_ME_REFERENCE, 403, ApiErrorMessages.SEARCH_INVALID_ME_REFERENCE);
             }
         }
-        // Check user permissions
-        if (this.aclUtils?.enabled && !options.ignoreACL) {
-            if (!(await this.aclUtils.hasPermission(options.user, this.defaultACLUid, ACLAction.READ))) {
-                throw new ApiError(ApiErrors.AUTH_PERMISSION_FAILURE, 403, ApiErrorMessages.AUTH_PERMISSION_FAILURE);
-            }
-        }
         const query = this.repoUtils.searchIdQuery(id, options.query.version);
         const result = await this.repoUtils.count(query);
         if (result > 0) {
@@ -255,16 +257,10 @@ export class ModelRoute {
      *
      * @param options The options to process the request using.
      */
-    async doFindAll(options) {
+    async doFind(options) {
         if (!this.repoUtils) {
             throw new ApiError(ApiErrors.INTERNAL_ERROR, 500, ApiErrorMessages.INTERNAL_ERROR);
         }
-        // Check user permissions
-        if (this.aclUtils?.enabled && !options.ignoreACL) {
-            if (!(await this.aclUtils.hasPermission(options.user, this.defaultACLUid, ACLAction.READ))) {
-                throw new ApiError(ApiErrors.AUTH_PERMISSION_FAILURE, 403, ApiErrorMessages.AUTH_PERMISSION_FAILURE);
-            }
-        }
         const searchQuery = ModelUtils.buildSearchQuery(this.modelClass, this.repoUtils.repo, options.params, options.query, true, options.user);
         return await this.repoUtils.find(searchQuery, {
             limit: options.query?.limit,
@@ -293,16 +289,11 @@ export class ModelRoute {
         }
         const result = await this.repoUtils.findOne(id, {
             version: options.params?.version || options.query?.version,
+            user: options.user,
         });
         if (!result) {
             throw new ApiError(ApiErrors.NOT_FOUND, 404, ApiErrorMessages.NOT_FOUND);
         }
-        if (this.aclUtils?.enabled && !options.ignoreACL) {
-            const acl = await this.aclUtils.findACL(result.uid);
-            if (!(await this.aclUtils.hasPermission(options.user, acl ? acl : this.defaultACLUid, ACLAction.READ))) {
-                throw new ApiError(ApiErrors.AUTH_PERMISSION_FAILURE, 403, ApiErrorMessages.AUTH_PERMISSION_FAILURE);
-            }
-        }
         return result;
     }
     /**
@@ -379,6 +370,7 @@ export class ModelRoute {
         }
         const existing = await this.repoUtils.findOne(id, {
             skipCache: true,
+            user: options.user,
         });
         if (!existing) {
             throw new ApiError(ApiErrors.NOT_FOUND, 404, ApiErrorMessages.NOT_FOUND);
@@ -431,7 +423,7 @@ export class ModelRoute {
     /**
      * Calls `repoUtils.validate()` to validate the object(s) provided.
      */
-    async doValidate(objs, options) {
+    async validate(objs, options) {
         await this.repoUtils?.validate(objs, options);
     }
 }