@rapidrest/service-core 1.0.0-rc.9 → 1.0.0

package/dist/types/routes/BaseAdminRoute.d.ts

@@ -0,0 +1,65 @@
+import { type JWTUser } from "@rapidrest/core";
+import type { RedisClientType } from "redis";
+import Transport from "winston-transport";
+import { type IWebSocketShim } from "../http/IWebSocketShim.js";
+/**
+ * Implements a Winston transport that pipes incoming log messages to a configured redis pubsub channel.
+ */
+export declare class RedisTransport extends Transport {
+    private channel;
+    private redis;
+    constructor(opts: any);
+    close(): void;
+    log(info: any, next: Function): any;
+}
+/**
+ * The `BaseAdminRoute` class provides a base set of endpoints that gives trusted users the ability to perform common adminstrative actions
+ * with the server. Note that this route class requires elevated user privileges to perform any action.
+ *
+ * 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
+ */
+export declare class BaseAdminRoute {
+    /** A map of user uid's to active sockets. */
+    protected activeSockets: Map<string, any[]>;
+    protected cacheClient?: RedisClientType;
+    protected cacheConnConfig: any;
+    protected logger: any;
+    protected logsConnConfig: any;
+    protected redisClient?: RedisClientType;
+    /**
+     * A dedicated connection for publishing admin channel messages (e.g. the `RESTART` signal).
+     * `redisClient` issues `SUBSCRIBE` in `init()`, which puts it into subscriber-only mode — Redis
+     * connections in that state can't also run `PUBLISH`, so a separate connection is required.
+     */
+    protected redisPublisher?: RedisClientType;
+    /** The underlying ReleaseNotes specification. */
+    protected releaseNotes?: string;
+    protected serviceName?: string;
+    protected trustedRoles: string[];
+    protected init(): Promise<void>;
+    clearCache(user?: JWTUser): Promise<void>;
+    logs(socket: IWebSocketShim, user: JWTUser): Promise<void>;
+    getReleaseNotes(user?: JWTUser): string | undefined;
+    restart(user?: JWTUser): void;
+}

package/dist/types/routes/BaseMetricsRoute.d.ts

@@ -0,0 +1,37 @@
+import * as prom from "prom-client";
+import { type JWTUser } from "@rapidrest/core";
+/**
+ * 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 {}
+ * ```
+ */
+export declare class BaseMetricsRoute {
+    protected metricsConfig: {
+        authRequired: boolean;
+    };
+    protected registry: prom.Registry;
+    protected trustedRoles: string[];
+    constructor();
+    getMetrics(user?: JWTUser): Promise<string>;
+    getSingleMetric(metric: any, user?: JWTUser): Promise<string>;
+}

package/dist/types/routes/BaseOpenAPIRoute.d.ts

@@ -0,0 +1,33 @@
+import { OpenApiSpec } from "../OpenApiSpec.js";
+/**
+ * The `BaseOpenAPIRoute` class provides a base set of endpoints exposing the server's OpenAPI specification.
+ *
+ * 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
+ */
+export declare class BaseOpenAPIRoute {
+    /** The underlying OpenAPI specification. */
+    protected apiSpec: OpenApiSpec;
+    getHTML(): string;
+    getJSON(): any;
+    getYAML(): string;
+}

package/dist/types/routes/BasePushRoute.d.ts

@@ -0,0 +1,53 @@
+import ws from "ws";
+/**
+ * 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 declare class BasePushRoute {
+    private aclUtils?;
+    /** A map of active socket connections to users.  */
+    private activeSocks;
+    /** A map of active subscription uids to users. */
+    private activeSubs;
+    /** Per-user in-process locks (see `runExclusive`) guarding read-modify-write access to `activeSubs`. */
+    private subLocks;
+    private logger;
+    private redisConfig;
+    /** The maximum number of concurrent sockets a single user may hold open at once. */
+    private maxSocketsPerUser;
+    /** The maximum number of channels a single user may be subscribed to at once. */
+    private maxSubscriptionsPerUser;
+    /** A persistent redis client used to publish outgoing push messages. */
+    private redisPub?;
+    private init;
+    /**
+     * Runs `fn` exclusively with respect to any other call currently queued under the same `key` on this
+     * instance — a call only starts once every call queued ahead of it under that key has fully settled. Used
+     * to serialize SUBSCRIBE/UNSUBSCRIBE handling per user so two messages arriving close together (on the same
+     * or different concurrent sockets for that user) can't both read the same stale `activeSubs` snapshot and
+     * clobber (or exceed the cap on) each other's committed subscription list.
+     */
+    private runExclusive;
+    connect(sock: ws, user: any): Promise<void>;
+    send(id: string, msg: any, user: any): Promise<void>;
+}

package/dist/types/routes/BaseStaticRoute.d.ts

@@ -0,0 +1,44 @@
+import type { HttpRequest, HttpResponse } from "../http/types.js";
+/**
+ * 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
+ */
+export declare class BaseStaticRoute {
+    /**
+     * 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.
+     */
+    protected routePrefix: string;
+    /** The location of the static files to serve. Defaults to `./public`. */
+    protected readonly staticDir: string;
+    protected init(): Promise<void>;
+    /**
+     * 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`.
+     */
+    private resolveFile;
+    get(req: HttpRequest, res: HttpResponse): Promise<any>;
+}

package/dist/types/routes/BaseStatusRoute.d.ts

@@ -0,0 +1,37 @@
+import { StatusExtraData } from "../models/StatusExtraData.js";
+/**
+ * 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 declare class BaseStatusRoute {
+    protected serviceName: any;
+    protected serviceVersion: any;
+    protected statusExtraData: StatusExtraData | undefined;
+    get(): any;
+}

package/dist/types/routes/CRUDRoute.d.ts

@@ -0,0 +1,57 @@
+import { BaseEntity } from "../models/BaseEntity.js";
+import type { HttpRequest, HttpResponse } from "../http/index.js";
+import { SimpleEntity } from "../models/SimpleEntity.js";
+import { type JWTUser } from "@rapidrest/core";
+import { ModelRoute, type UpdateObject } 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 datasource. |
+ * | `delete` | `DELETE /:id` | Removes an existing object from the datasource. |
+ * | `exists` | `HEAD /:id` | Checks if the object with the given ID exists in the datasource. 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 datasource. |
+ * | `update` | `PUT /:id` | Modifies an existing object in the datasource. |
+ * | `updateBulk` | `PUT /` | Modifies multiple existing objects in the datasource. |
+ * | `updateProperty` | `PUT /:id/:property` | Modifies an single property of the given name of an existing object in the datasource. |
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export declare abstract class CRUDRoute<T extends BaseEntity | SimpleEntity> extends ModelRoute<T> {
+    protected readonly repoUtilsClass: any;
+    count(params: any, query: any, res: HttpResponse, user?: JWTUser): Promise<any>;
+    /**
+     * Override this function to perform additional custom validation of object creation. This is called
+     * for each object passed to the `create()` operation.
+     */
+    protected validateCreate(obj: Partial<T>, user?: JWTUser): Promise<void>;
+    private validateCreateBulk;
+    create(obj: T | T[], req: HttpRequest, user?: JWTUser): Promise<T | Array<T>>;
+    delete(id: string, version: string | undefined, purge: string | undefined, req: HttpRequest, user?: JWTUser): Promise<void>;
+    exists(id: string, query: any, res: HttpResponse, user?: JWTUser): Promise<any>;
+    find(params: any, query: any, user?: JWTUser): Promise<Array<T>>;
+    findById(id: string, query: any, user?: JWTUser): Promise<T | null>;
+    truncate(params: any, query: any, user?: JWTUser): Promise<void>;
+    /**
+     * Override this function to perform additional custom validation of object updates. This is called
+     * for `update()` and `updateBulk()` operations. `updateBulk()` calls this function for each update
+     * object.
+     */
+    protected validateUpdate(id: string, obj: UpdateObject<T>, user?: JWTUser): Promise<void>;
+    update(id: string, obj: UpdateObject<T>, req: HttpRequest, user?: JWTUser): Promise<T>;
+    private validateUpdateBulk;
+    updateBulk(obj: UpdateObject<T>[], req: HttpRequest, user?: JWTUser): Promise<T[]>;
+    updateProperty(id: string, propertyName: string, obj: any, user?: JWTUser): Promise<T>;
+}

package/dist/types/routes/ModelRoute.d.ts

@@ -1,20 +1,18 @@
-import { RepoOperationOptions, RepoUtils } from "../models/RepoUtils.js";
+import { RepoUtils, type RepoOperationOptions } from "../models/RepoUtils.js";
 import { BaseEntity } from "../models/BaseEntity.js";
-import { Redis } from "ioredis";
-import type { HttpRequest as XRequest, HttpResponse as XResponse } from "../http/index.js";
+import type { HttpRequest, HttpResponse } from "../http/index.js";
 import { SimpleEntity } from "../models/SimpleEntity.js";
-import { AccessControlList } from "../security/AccessControlList.js";
+import { type AccessControlList } from "../security/AccessControlList.js";
 import { ACLUtils } from "../security/ACLUtils.js";
 import { NotificationUtils } from "../NotificationUtils.js";
-import { ObjectFactory } from "../ObjectFactory.js";
 /**
  * The set of options required by all request handlers.
  */
 export interface RequestOptions extends RepoOperationOptions {
     /** The originating client request. */
-    req?: XRequest;
+    req?: HttpRequest;
     /** The outgoing client response. */
-    res?: XResponse;
+    res?: HttpResponse;
 }
 /**
  * The set of options required by create request handlers.
@@ -67,7 +65,7 @@ export type UpdateObject<T extends BaseEntity | SimpleEntity> = Partial<T> & Pic
  * The set of options required by update request handlers.
  */
 export interface UpdateRequestOptions<T extends BaseEntity | SimpleEntity> extends RequestOptions {
-    /** The existing object that has already been recently pulled from the datastore. */
+    /** The existing object that has already been recently pulled from the datasource. */
     existing?: T | null;
     /** An additional list of channel names to send push notifications to. */
     pushChannels?: string[];
@@ -78,30 +76,35 @@ export interface UpdateRequestOptions<T extends BaseEntity | SimpleEntity> exten
 }
 /**
  * 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 datasource. 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 datasource.
+ * * `doDelete`: Removes an existing object from the datasource.
+ * * `doExists`: Checks if the object with the given ID exists in the datasource. 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 datasource.
+ * * `doUpdate`: Modifies an existing object in the datasource.
+ * * `doUpdateBulk`: Modifies multiple existing objects in the datasource.
+ * * `doUpdateProperty`: Modifies an single property of the given name of an existing object in the datasource.
  *
  * @author Jean-Philippe Steinmetz
  */
 export declare abstract class ModelRoute<T extends BaseEntity | SimpleEntity> {
+    private _objectFactory?;
     protected aclUtils?: ACLUtils;
-    /** The redis client that will be used as a 2nd level cache for all cacheable models. */
-    protected cacheClient?: Redis;
     /** The global application configuration. */
     protected config?: any;
     /** The unique identifier of the default ACL for the model type. */
     protected defaultACLUid: string;
     protected logger: any;
     protected notificationUtils?: NotificationUtils;
-    protected objectFactory?: ObjectFactory;
     /** The class of the RepoUtils to use when instantiating the utility. */
     protected abstract readonly repoUtilsClass: any;
     /** The repository utility class to use for common operations. */
@@ -126,34 +129,34 @@ export declare abstract class ModelRoute<T extends BaseEntity | SimpleEntity> {
      *
      * @param options The options to process the request using.
      */
-    doCount(options: FindRequestOptions): Promise<XResponse>;
+    protected doCount(options: FindRequestOptions): Promise<HttpResponse>;
     /**
-     * Attempts to store an object provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
+     * Attempts to store an object provided in `options.req.body` into the datasource. Upon success, sets the newly persisted
      * object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
      * client.
      *
      * @param obj The object to store in the database.
      * @param options The options to process the request using.
      */
-    doCreateObject(obj: Partial<T>, options: CreateRequestOptions): Promise<T>;
+    protected doCreateObject(obj: Partial<T>, options: CreateRequestOptions): Promise<T>;
     /**
-     * Attempts to store a collection of objects provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
+     * Attempts to store a collection of objects provided in `options.req.body` into the datasource. Upon success, sets the newly persisted
      * object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
      * client.
      *
      * @param objs The object(s) to store in the database.
      * @param options The options to process the request using.
      */
-    doBulkCreate(objs: Partial<T>[], options: CreateRequestOptions): Promise<T[]>;
+    protected doBulkCreate(objs: Partial<T>[], options: CreateRequestOptions): Promise<T[]>;
     /**
-     * Attempts to store one or more objects provided in `options.req.body` into the datastore. Upon success, sets the newly persisted
+     * Attempts to store one or more objects provided in `options.req.body` into the datasource. Upon success, sets the newly persisted
      * object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
      * client.
      *
      * @param obj The object(s) to store in the database.
      * @param options The options to process the request using.
      */
-    doCreate(obj: Partial<T> | Partial<T>[], options: CreateRequestOptions): Promise<T | T[]>;
+    protected doCreate(obj: Partial<T> | Partial<T>[], options: CreateRequestOptions): Promise<T | T[]>;
     /**
      * Attempts to delete an existing data model object with a given unique identifier encoded by the URI parameter
      * `id`.
@@ -161,14 +164,14 @@ export declare abstract class ModelRoute<T extends BaseEntity | SimpleEntity> {
      * @param id The unique identifier of the object to delete.
      * @param options The options to process the request using.
      */
-    doDelete(id: string, options: DeleteRequestOptions): Promise<void>;
+    protected doDelete(id: string, options: DeleteRequestOptions): Promise<void>;
     /**
      * Attempts to determine if an existing object with the given unique identifier exists.
      *
      * @param id The unique identifier of the object to verify exists.
      * @param options The options to process the request using.
      */
-    doExists(id: string, options: FindRequestOptions): Promise<any>;
+    protected doExists(id: string, options: FindRequestOptions): Promise<any>;
     /**
      * Attempts to retrieve all data model objects matching the given set of criteria as specified in the request
      * `query`. Any results that have been found are set to the `result` property of the `res` argument. `result` is
@@ -176,34 +179,34 @@ export declare abstract class ModelRoute<T extends BaseEntity | SimpleEntity> {
      *
      * @param options The options to process the request using.
      */
-    doFindAll(options: FindRequestOptions): Promise<T[]>;
+    protected doFind(options: FindRequestOptions): Promise<T[]>;
     /**
      * Attempts to retrieve a single data model object as identified by the `id` parameter in the URI.
      *
      * @param options The options to process the request using.
      */
-    doFindById(id: string, options: FindRequestOptions): Promise<T | null>;
+    protected doFindById(id: string, options: FindRequestOptions): Promise<T | null>;
     /**
-     * Attempts to remove all entries of the data model type from the datastore matching the given
+     * Attempts to remove all entries of the data model type from the datasource matching the given
      * parameters and query.
      *
      * @param options The options to process the request using.
      */
-    doTruncate(options: TruncateRequestOptions): Promise<void>;
+    protected doTruncate(options: TruncateRequestOptions): Promise<void>;
     /**
      * Attempts to modify a collection of existing data model objects.
      *
      * @param objs The object(s) to bulk update in the database.
      * @param options The options to process the request using.
      */
-    doBulkUpdate(objs: UpdateObject<T>[], options: UpdateRequestOptions<T>): Promise<T[]>;
+    protected doBulkUpdate(objs: UpdateObject<T>[], options: UpdateRequestOptions<T>): Promise<T[]>;
     /**
      * Attempts to modify an existing data model object as identified by the `id` parameter in the URI.
      *
      * @param obj The object to update in the database
      * @param options The options to process the request using.
      */
-    doUpdate(id: string, obj: UpdateObject<T>, options: UpdateRequestOptions<T>): Promise<T>;
+    protected doUpdate(id: string, obj: UpdateObject<T>, options: UpdateRequestOptions<T>): Promise<T>;
     /**
      * Attempts to modify a single property of an existing data model object as identified by the `id` parameter in the URI.
      *
@@ -214,9 +217,9 @@ export declare abstract class ModelRoute<T extends BaseEntity | SimpleEntity> {
      * @param value The value of the property to set.
      * @param options The options to process the request using.
      */
-    doUpdateProperty(id: string, propertyName: string, value: any, options: UpdateRequestOptions<T>): Promise<T>;
+    protected doUpdateProperty(id: string, propertyName: string, value: any, options: UpdateRequestOptions<T>): Promise<T>;
     /**
      * Calls `repoUtils.validate()` to validate the object(s) provided.
      */
-    doValidate(objs: Partial<T> | Partial<T>[], options?: CreateRequestOptions | UpdateRequestOptions<T>): Promise<void>;
+    validate(objs: Partial<T> | Partial<T>[], options?: CreateRequestOptions | UpdateRequestOptions<T>): Promise<void>;
 }

package/dist/types/routes/RouteUtils.d.ts

@@ -9,6 +9,12 @@ export declare class RouteUtils {
     private apiSpec;
     private authMiddleware?;
     private logger?;
+    protected trustedRoles: string[];
+    /**
+     * Creates a middleware function that checks if the user has elevated privileges and if not
+     * throws the `AUTH_REQUIRES_ELEVATION` error.
+     */
+    checkElevation(lastStart?: number): RequestHandler;
     /**
      * Creates a middleware function that verifies the incoming request is from a valid user with at least
      * one of the specified roles.
@@ -21,6 +27,19 @@ export declare class RouteUtils {
      * @param requiredRoles The list of roles that the authenticated user must have.
      */
     checkRequiredRoles(requiredRoles: string[]): RequestHandler;
+    /**
+     * Creates a middleware function that verifies the incoming request is from a valid user with at least
+     * one of the trusted roles.
+     */
+    checkTrusedRoles(): RequestHandler;
+    /**
+     * Creates a middleware function that verifies the incoming request's token carries at least one of the
+     * specified scopes. This is a coarse, token-level pre-check that runs before the per-resource ACL check —
+     * see `RequiresScope`.
+     *
+     * @param requiredScopes The list of scopes of which the authenticated user's token must carry at least one.
+     */
+    checkRequiredScopes(requiredScopes: string[]): RequestHandler;
     /**
      * Converts the given array of string or Function objects to functions bound to the given route object.
      *

package/dist/types/routes/index.d.ts

@@ -1,6 +1,9 @@
-export * from "./AdminRoute.js";
-export * from "./MetricsRoute.js";
+export * from "./BaseAdminRoute.js";
+export * from "./BaseMetricsRoute.js";
+export * from "./BaseOpenAPIRoute.js";
+export * from "./BasePushRoute.js";
+export * from "./BaseStaticRoute.js";
+export * from "./BaseStatusRoute.js";
+export * from "./CRUDRoute.js";
 export * from "./ModelRoute.js";
-export * from "./OpenAPIRoute.js";
 export * from "./RouteUtils.js";
-export * from "./StatusRoute.js";