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

package/dist/types/BackgroundService.d.ts

@@ -5,11 +5,6 @@
  * @author Jean-Philippe Steinmetz <rapidrests@gmail.com>
  */
 export declare abstract class BackgroundService {
-    /** The global application configuration that the service can reference. */
-    protected config: any;
-    /** The logging utility to use. */
-    protected logger: any;
-    constructor(config: any, logger: any);
     /**
      * Returns the desired execution interval that this service should be scheduled with. If `undefined` is returned
      * the service is executed only once.

package/dist/types/BackgroundServiceManager.d.ts

@@ -34,7 +34,7 @@ export declare class BackgroundServiceManager {
     private readonly logger;
     private objectFactory;
     private services;
-    constructor(objectFactory: ObjectFactory, classes: {}, config: any, logger: any);
+    constructor(objectFactory: ObjectFactory, classes: {});
     /**
      * Returns the service instance with the given name.
      *

package/dist/types/EventListenerManager.d.ts

@@ -10,11 +10,11 @@ import { ObjectFactory } from "./ObjectFactory.js";
  * @author Jean-Philippe Steinmetz <rapidrests@gmail.com>
  */
 export declare class EventListenerManager {
-    private channels;
-    private logger;
-    private objectFactory;
+    private readonly channels;
+    private readonly logger;
+    private readonly objectFactory;
     private handlers;
-    private redis;
+    private readonly redis;
     constructor(objectFactory: ObjectFactory, redis: Redis);
     init(): Promise<void>;
     destroy(): Promise<void>;

package/dist/types/Server.d.ts

@@ -1,12 +1,28 @@
 import * as prom from "prom-client";
 import "reflect-metadata";
 import { ConnectionManager } from "./database/ConnectionManager.js";
+import { ClassLoader } from "@rapidrest/core";
 import { ObjectFactory } from "./ObjectFactory.js";
 import { BackgroundServiceManager } from "./BackgroundServiceManager.js";
 import { RouteUtils } from "./routes/RouteUtils.js";
 import { OpenApiSpec } from "./OpenApiSpec.js";
 import { EventListenerManager } from "./EventListenerManager.js";
 import { HttpRouter } from "./http/Router.js";
+/**
+ * The configuration options to use when constructing a new Server instance.
+ */
+export interface ServerOptions {
+    /** The nconf-compatible configuration object to initialize the server with. */
+    config: any;
+    /** The base file system path that models and routes will be searched from. Default is `.` */
+    basePath?: string;
+    /** The logging utility to use for outputing to console/file. Default is `Logger()` from `@rapidrest/core`. */
+    logger?: any;
+    /** The ClassLoader used to scan the source for all exported classes. */
+    classLoader?: ClassLoader;
+    /** The object factory to use for automatic dependency injection (IOC). */
+    objectFactory?: ObjectFactory;
+}
 /**
  * Provides an HTTP server utilizing uWebSockets.js. The server automatically registers all routes, and
  * establishes database connections for all configured data stores. Additionally provides automatic authentication
@@ -124,6 +140,8 @@ export declare class Server {
     protected readonly config?: any;
     /** The manager for handling database connections. */
     protected connectionManager?: ConnectionManager;
+    /** The ClassLoader used to scan the source for all exported classes. */
+    protected classLoader: ClassLoader;
     /** The manager for handling events. */
     protected eventListenerManager?: EventListenerManager;
     /** The logging utility to use when outputing to console/file. */
@@ -141,14 +159,11 @@ export declare class Server {
     protected metricFailedRequests: prom.Counter<string>;
     protected metricTotalRequests: prom.Counter<string>;
     /**
-     * Creates a new instance of Server with the specified defaults.
+     * Creates a new instance of Server with the specified default options.
      *
-     * @param {any} config The nconf-compatible configuration object to initialize the server with.
-     * @param {string} basePath The base file system path that models and routes will be searched from.
-     * @param {Logger} logger The logging utility to use for outputing to console/file.
-     * @param objectFactory The object factory to use for automatic dependency injection (IOC).
+     * @param options The configuration options to apply for this server.
      */
-    constructor(config: any, basePath?: string, logger?: any, objectFactory?: ObjectFactory);
+    constructor(options: ServerOptions);
     /**
      * Returns the HTTP router instance.
      */

package/dist/types/decorators/DocDecorators.d.ts

@@ -67,3 +67,12 @@ export declare function Returns(types?: any | any[]): (target: any, propertyKey:
  * becomes `[[Array, MyClass]]`).
  */
 export declare function TypeInfo(types?: any | any[]): (target: any, propertyKey: string) => void;
+/**
+ * Retrieves the typing information of a class property or function, preferring the richer description provided by
+ * `@TypeInfo` and falling back to TypeScript's own `design:type` reflection metadata when `@TypeInfo` was not
+ * applied.
+ *
+ * @param target The class prototype (or class, for static members) to retrieve type information for.
+ * @param propertyKey The name of the property or function to retrieve type information for.
+ */
+export declare function getTypeInfo(target: any, propertyKey: string): any;

package/dist/types/decorators/PersistenceDecorators.d.ts

@@ -26,6 +26,13 @@ export interface ColumnOptions {
     primary?: boolean;
     /** Set to `true` if the column stores a MongoDB `ObjectId` value. */
     isObjectId?: boolean;
+    /**
+     * Explicitly declares the SQL column type, overriding the type that would otherwise be inferred from
+     * TypeScript's reflected property type. Required whenever the design-time type cannot be reliably inferred,
+     * such as nullable/union-typed properties (which TypeScript reflects as `Object`) or properties whose value is
+     * a complex/nested structure that has no direct SQL column equivalent (e.g. `"simple-json"`).
+     */
+    type?: string | Function;
 }
 /**
  * The set of options to use when declaring a persistent class type via the `@Entity` decorator.

package/dist/types/decorators/RouteDecorators.d.ts

@@ -8,10 +8,19 @@ import { AccessControlList } from "../security/AccessControlList.js";
  */
 export declare function After(func: Function | string | (Function | string)[]): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
 /**
- * Applies PassportJS authentication to the decorated route or method for the provided strategy or list of strategies
+ * Indicates that the decorated class contains route definitions. This prepends `/api` or `/api/v{version}` to
+ * all provided path(s). e.g. `@ApiRoute('my-api')` results in `/api/my-api`. `@ApiRoute('my-api',2) results in
+ * `/api/v2/my-api`.
+ *
+ * @param paths The base path(s) that all route definitions will use.
+ * @param version The optional version number to prepend the path with. Prefixes the provided version with `v` in the path.
+ */
+export declare function ApiRoute(paths: string | string[], version?: string | number): (target: Function) => void;
+/**
+ * Applies authentication to the decorated route or method for the provided strategy or list of strategies
  * should be attempted before processing the route.
  *
- * @param strategies The PassportJS strategies that will be applied when incoming requests are processed.
+ * @param strategies The strategies that will be applied when incoming requests are processed.
  * @param require Set to `true` to indicate that at least one of the specified authentication strategies must pass to
  * proceed, otherwise set to `false`. Default is `true`.
  */
@@ -127,11 +136,11 @@ export declare function Protect(acl?: PartialACL): (target: any, propertyKey?: s
  */
 export declare function Query(name?: string | undefined): (target: any, propertyKey: string, index: number) => void;
 /**
- * Injects the Express request object as the value of the decorated argument.
+ * Injects the HTTP request object as the value of the decorated argument.
  */
 export declare function Request(target: any, propertyKey: string, index: number): void;
 /**
- * Injects the Express response object as the value of the decorated argument.
+ * Injects the HTTP response object as the value of the decorated argument.
  */
 export declare function Response(target: any, propertyKey: string, index: number): void;
 /**
@@ -142,7 +151,7 @@ export declare function Response(target: any, propertyKey: string, index: number
  */
 export declare function RequiresRole(roles: string | string[]): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
 /**
- * Indicates that the decorated class contains Express route definitions.
+ * Indicates that the decorated class contains route definitions.
  *
  * @param paths The base path(s) that all route definitions will use.
  */

package/dist/types/http/Adapters.d.ts

@@ -40,7 +40,9 @@ export declare class UWSResponse implements HttpResponse {
     private _headers;
     private _headersSent;
     private _writableEnded;
+    private _streaming;
     private _aborted;
+    private _abortHandlers;
     /** Set to true for HEAD requests — body bytes must not be sent. */
     isHead: boolean;
     /** Intermediate result passed between middleware. */
@@ -57,6 +59,23 @@ export declare class UWSResponse implements HttpResponse {
     json(data: any): void;
     send(data?: any): void;
     end(data?: any): void;
+    /**
+     * Flushes status and headers to the wire immediately without ending the response.
+     * Required before streaming data (e.g. SSE). Safe to call multiple times — only
+     * acts on the first call.
+     */
+    flushHeaders(): void;
+    /**
+     * Writes a chunk to the response without ending it (streaming / SSE).
+     * Flushes headers on the first call if they haven't been sent yet.
+     */
+    write(data: string | Buffer): void;
+    /**
+     * Registers a callback to run when the client aborts the connection.
+     * Safe to call multiple times — all registered callbacks are invoked on abort.
+     * Uses the single uWS `onAborted` slot registered in the constructor.
+     */
+    onAbort(callback: () => void): void;
     /** Converts a numeric status code to the "200 OK" string format uWS expects. */
     private _statusToString;
 }

package/dist/types/http/Router.d.ts

@@ -38,7 +38,6 @@ export type WsUpgradeAuth = (req: HttpRequest) => WsUpgradeAuthResult;
  *
  * Also supports:
  * - `ws(path, handlers)` — native uWS WebSocket routing
- * - `static(basePath)` — basic static file serving
  * - `listen(host, port)` / `close()` — server lifecycle
  */
 export declare class HttpRouter {
@@ -52,6 +51,12 @@ export declare class HttpRouter {
     private preRouteCount;
     /** The port the server is currently listening on (set after a successful `listen()` call). */
     listenPort: number;
+    /**
+     * HTTP verbs for which the application has already registered its own literal `/*` route
+     * (e.g. a `BaseStaticRoute` mounted at the site root via `@Route("/")`). Used by `listen()` to
+     * avoid clobbering an app-defined root catch-all with the default JSON 404 fallback.
+     */
+    private readonly rootWildcardVerbs;
     constructor(uwsApp: uWS.TemplatedApp);
     /** Returns `true` if the server is currently listening. */
     get isListening(): boolean;
@@ -83,11 +88,6 @@ export declare class HttpRouter {
      * Both `path` and `path + "/"` are registered to avoid trailing-slash mismatch.
      */
     ws(routePath: string, handlers: RequestHandler[], wsOptions?: Partial<uWS.WebSocketBehavior<any>>, upgradeAuth?: WsUpgradeAuth): this;
-    /**
-     * Serves static files from a directory via a wildcard GET route.
-     * Files not found on disk return 404.
-     */
-    static(basePath: string): this;
     /**
      * Starts listening on the given host and port.
      * Resolves when the server is ready; rejects if the port cannot be bound.

package/dist/types/models/ModelUtils.d.ts

@@ -9,6 +9,7 @@ import "reflect-metadata";
 export declare class ModelUtils {
     /** The `typeorm` module containing the query operators used to build SQL queries. */
     private static typeOrm;
+    private static idPropertyCache;
     /**
      * Provides the `typeorm` module to use when building SQL queries. This is called automatically when a SQL
      * datastore connection is established.
@@ -19,7 +20,7 @@ export declare class ModelUtils {
     /**
      * Returns the `typeorm` module, throwing an error if it has not been provided.
      */
-    private static get orm();
+    static get orm(): any;
     /**
      * Retrieves a list of all of the specified class's properties that have the @Identifier decorator applied.
      *

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

@@ -0,0 +1,59 @@
+import { JWTUser } from "@rapidrest/core";
+import { Redis } from "ioredis";
+import Transport from "winston-transport";
+import { type UWSWebSocketShim } from "../http/WebSocket.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.
+ *
+ * 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?: Redis;
+    protected cacheConnConfig: any;
+    protected logger: any;
+    protected logsConnConfig: any;
+    protected redisClient?: Redis;
+    /** The underlying ReleaseNotes specification. */
+    protected releaseNotes?: string;
+    protected serviceName?: string;
+    protected trustedRoles: string[];
+    protected init(): Promise<void>;
+    clearCache(user?: JWTUser): Promise<void>;
+    logs(socket: UWSWebSocketShim, 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 { 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,39 @@
+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;
+    private logger;
+    private redisConfig;
+    /** A persistent redis client used to publish outgoing push messages. */
+    private redisPub?;
+    private init;
+    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 { 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,47 @@
+import { BaseEntity } from "../models/BaseEntity.js";
+import type { HttpRequest, HttpResponse } from "../http/index.js";
+import { SimpleEntity } from "../models/SimpleEntity.js";
+import { JWTUser } from "@rapidrest/core";
+import { ModelRoute, 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 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 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>;
+    protected validateCreate(obj: Partial<T> | Partial<T>[], user?: JWTUser): Promise<void>;
+    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>;
+    protected validateUpdate(id: string, obj: UpdateObject<T>, user?: JWTUser): Promise<void>;
+    update(id: string, obj: UpdateObject<T>, req: HttpRequest, user?: JWTUser): Promise<T>;
+    protected validateUpdateBulk(objs: UpdateObject<T>[], user?: JWTUser): Promise<void>;
+    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,7 +1,7 @@
 import { RepoOperationOptions, RepoUtils } 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 { ACLUtils } from "../security/ACLUtils.js";
@@ -12,9 +12,9 @@ import { ObjectFactory } from "../ObjectFactory.js";
  */
 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.
@@ -78,16 +78,23 @@ 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 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
  */
@@ -103,7 +110,7 @@ export declare abstract class ModelRoute<T extends BaseEntity | SimpleEntity> {
     protected notificationUtils?: NotificationUtils;
     protected objectFactory?: ObjectFactory;
     /** The class of the RepoUtils to use when instantiating the utility. */
-    protected readonly abstract repoUtilsClass: any;
+    protected abstract readonly repoUtilsClass: any;
     /** The repository utility class to use for common operations. */
     protected repoUtils?: RepoUtils<T>;
     /**
@@ -115,7 +122,7 @@ export declare abstract class ModelRoute<T extends BaseEntity | SimpleEntity> {
     /**
      * The class type of the model this route is associated with.
      */
-    protected get modelClass(): any;
+    get modelClass(): any;
     /**
      * Called on server startup to initialize the route with any defaults.
      */
@@ -126,7 +133,7 @@ export declare abstract class ModelRoute<T extends BaseEntity | SimpleEntity> {
      *
      * @param options The options to process the request using.
      */
-    protected 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
      * object(s) to the `result` property of the `options.res` argument, otherwise sends a `400 BAD REQUEST` response to the
@@ -176,7 +183,7 @@ export declare abstract class ModelRoute<T extends BaseEntity | SimpleEntity> {
      *
      * @param options The options to process the request using.
      */
-    protected 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.
      *
@@ -218,5 +225,5 @@ export declare abstract class ModelRoute<T extends BaseEntity | SimpleEntity> {
     /**
      * Calls `repoUtils.validate()` to validate the object(s) provided.
      */
-    protected doValidate(objs: Partial<T> | Partial<T>[], options?: CreateRequestOptions | UpdateRequestOptions<T>): Promise<void>;
+    validate(objs: Partial<T> | Partial<T>[], options?: CreateRequestOptions | UpdateRequestOptions<T>): Promise<void>;
 }