@rapidrest/service-core 1.0.0-beta.1

package/dist/lib/database/TypeOrmSupport.js

@@ -0,0 +1,146 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz. All rights reserved.
+///////////////////////////////////////////////////////////////////////////////
+// NOTE: This is the only module in the library that is permitted to import the optional `typeorm` package at
+// runtime. It is loaded dynamically by `ConnectionManager` if (and only if) a SQL datastore is configured.
+import * as typeorm from "typeorm";
+import { pendingTypeOrmColumns } from "../decorators/ModelDecorators.js";
+import { ModelUtils } from "../models/ModelUtils.js";
+/**
+ * Bridges framework persistence metadata (declared via the decorators in `PersistenceDecorators`) into TypeORM's
+ * global metadata storage so that entity classes using framework decorators behave identically to entity classes
+ * using TypeORM's own decorators. Registrations are deduplicated so that consumer entities decorated with real
+ * TypeORM decorators are never modified.
+ *
+ * @param entities The list of entity classes to register metadata for.
+ */
+export function registerFrameworkMetadata(entities) {
+    const storage = typeorm.getMetadataArgsStorage();
+    // Drain any pending column registrations (e.g. the `_type` column added by @ChildEntity)
+    for (const column of pendingTypeOrmColumns.splice(0)) {
+        const exists = storage.columns.some((c) => c.target === column.target && c.propertyName === column.propertyName);
+        if (!exists) {
+            storage.columns.push(column);
+        }
+    }
+    for (const entity of entities) {
+        // Register a table for every class in the constructor chain that declares an explicit framework entity
+        // name (the framework's @Entity decorator).
+        for (let c = entity; c && c !== Function.prototype; c = Object.getPrototypeOf(c)) {
+            const entityName = Reflect.getOwnMetadata("rrst:entityName", c);
+            if (entityName && !storage.tables.some((t) => t.target === c)) {
+                storage.tables.push({
+                    target: c,
+                    name: entityName,
+                    type: "regular",
+                    orderBy: undefined,
+                    engine: undefined,
+                    database: undefined,
+                    schema: undefined,
+                    synchronize: undefined,
+                    withoutRowid: undefined,
+                });
+            }
+            // Register class-level (compound) indexes
+            const classIndexes = Reflect.getOwnMetadata("rrst:classIndexes", c) ?? [];
+            for (const index of classIndexes) {
+                registerIndex(storage, c, index);
+            }
+        }
+        // Register columns and property-level indexes for every level of the prototype chain
+        for (let proto = entity.prototype; proto && proto !== Object.prototype; proto = Object.getPrototypeOf(proto)) {
+            const target = proto.constructor;
+            const columns = Reflect.getOwnMetadata("rrst:columns", proto) ?? [];
+            for (const column of columns) {
+                // ObjectId columns are MongoDB-specific and are not bridged
+                if (column.options.isObjectId) {
+                    continue;
+                }
+                const exists = storage.columns.some((c) => c.target === target && c.propertyName === column.propertyName);
+                if (exists || !column.designType) {
+                    continue;
+                }
+                storage.columns.push({
+                    target,
+                    propertyName: column.propertyName,
+                    mode: "regular",
+                    options: {
+                        type: column.designType,
+                        ...(column.options.name !== undefined ? { name: column.options.name } : {}),
+                        ...(column.options.nullable !== undefined ? { nullable: column.options.nullable } : {}),
+                        ...(column.options.primary ? { primary: true } : {}),
+                    },
+                });
+            }
+            const indexes = Reflect.getOwnMetadata("rrst:indexes", proto) ?? [];
+            for (const index of indexes) {
+                registerIndex(storage, target, index);
+            }
+        }
+    }
+}
+/**
+ * Registers a single framework index declaration with TypeORM's metadata storage if an equivalent registration
+ * does not already exist.
+ */
+function registerIndex(storage, target, index) {
+    const exists = storage.indices.some((i) => i.target === target &&
+        i.name === index.name &&
+        JSON.stringify(i.columns) === JSON.stringify(index.columns));
+    if (exists) {
+        return;
+    }
+    storage.indices.push({
+        target,
+        name: index.name,
+        columns: index.columns,
+        synchronize: true,
+        where: undefined,
+        unique: !!index.options.unique,
+        spatial: false,
+        fulltext: false,
+        nullFiltered: false,
+        parser: undefined,
+        sparse: !!index.options.sparse,
+        background: !!index.options.background,
+        concurrent: false,
+        expireAfterSeconds: index.options.expireAfterSeconds,
+    });
+}
+/** Tracks active DataSource instances by datastore name to support reconnection. */
+const dataSources = new Map();
+/**
+ * Establishes a TypeORM connection for the given SQL datastore configuration. If a connection with the given name
+ * already exists it is reused (and reconnected if necessary).
+ *
+ * @param name The name of the datastore to connect to.
+ * @param datastore The datastore configuration to pass to TypeORM.
+ * @param entities The list of entity classes assigned to this connection.
+ * @param url The connection URL of the database.
+ */
+export async function connect(name, datastore, entities, url) {
+    // Make TypeORM's query operators available to query building utilities
+    ModelUtils.setTypeOrm(typeorm);
+    // Bridge framework-declared persistence metadata into TypeORM
+    registerFrameworkMetadata(entities);
+    let connection = dataSources.get(name);
+    if (connection) {
+        if (!connection.isInitialized) {
+            await connection.initialize();
+        }
+    }
+    else {
+        connection = new typeorm.DataSource({
+            ...datastore,
+            entities,
+            url,
+        });
+        await connection.initialize();
+        dataSources.set(name, connection);
+        if (datastore.runMigrations) {
+            await connection.runMigrations();
+        }
+    }
+    return connection;
+}
+//# sourceMappingURL=TypeOrmSupport.js.map

package/dist/lib/database/TypeOrmSupport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TypeOrmSupport.js","sourceRoot":"","sources":["../../../src/database/TypeOrmSupport.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E,6GAA6G;AAC7G,2GAA2G;AAC3G,OAAO,KAAK,OAAO,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAKzE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAErD;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CAAC,QAAe;IACrD,MAAM,OAAO,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAEjD,yFAAyF;IACzF,KAAK,MAAM,MAAM,IAAI,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QACnD,MAAM,MAAM,GAAY,OAAO,CAAC,OAAO,CAAC,IAAI,CACxC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC,YAAY,KAAK,MAAM,CAAC,YAAY,CAC9E,CAAC;QACF,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC;IACL,CAAC;IAED,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;QAC5B,uGAAuG;QACvG,4CAA4C;QAC5C,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,SAAS,EAAE,CAAC,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/E,MAAM,UAAU,GAAuB,OAAO,CAAC,cAAc,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAC;YACpF,IAAI,UAAU,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC5D,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;oBAChB,MAAM,EAAE,CAAC;oBACT,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,SAAS;oBAClB,MAAM,EAAE,SAAS;oBACjB,QAAQ,EAAE,SAAS;oBACnB,MAAM,EAAE,SAAS;oBACjB,WAAW,EAAE,SAAS;oBACtB,YAAY,EAAE,SAAS;iBAC1B,CAAC,CAAC;YACP,CAAC;YAED,0CAA0C;YAC1C,MAAM,YAAY,GAAgB,OAAO,CAAC,cAAc,CAAC,mBAAmB,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACvF,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;gBAC/B,aAAa,CAAC,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;YACrC,CAAC;QACL,CAAC;QAED,qFAAqF;QACrF,KACI,IAAI,KAAK,GAAG,MAAM,CAAC,SAAS,EAC5B,KAAK,IAAI,KAAK,KAAK,MAAM,CAAC,SAAS,EACnC,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EACtC,CAAC;YACC,MAAM,MAAM,GAAQ,KAAK,CAAC,WAAW,CAAC;YAEtC,MAAM,OAAO,GAAiB,OAAO,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YAClF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC3B,4DAA4D;gBAC5D,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;oBAC5B,SAAS;gBACb,CAAC;gBACD,MAAM,MAAM,GAAY,OAAO,CAAC,OAAO,CAAC,IAAI,CACxC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,CAAC,YAAY,KAAK,MAAM,CAAC,YAAY,CACvE,CAAC;gBACF,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;oBAC/B,SAAS;gBACb,CAAC;gBACD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;oBACjB,MAAM;oBACN,YAAY,EAAE,MAAM,CAAC,YAAY;oBACjC,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE;wBACL,IAAI,EAAE,MAAM,CAAC,UAAU;wBACvB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC3E,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;wBACvF,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;qBACvD;iBACJ,CAAC,CAAC;YACP,CAAC;YAED,MAAM,OAAO,GAAgB,OAAO,CAAC,cAAc,CAAC,cAAc,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;YACjF,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;gBAC1B,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YAC1C,CAAC;QACL,CAAC;IACL,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CAAC,OAAY,EAAE,MAAW,EAAE,KAAgB;IAC9D,MAAM,MAAM,GAAY,OAAO,CAAC,OAAO,CAAC,IAAI,CACxC,CAAC,CAAM,EAAE,EAAE,CACP,CAAC,CAAC,MAAM,KAAK,MAAM;QACnB,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI;QACrB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,CAClE,CAAC;IACF,IAAI,MAAM,EAAE,CAAC;QACT,OAAO;IACX,CAAC;IACD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QACjB,MAAM;QACN,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,WAAW,EAAE,IAAI;QACjB,KAAK,EAAE,SAAS;QAChB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM;QAC9B,OAAO,EAAE,KAAK;QACd,QAAQ,EAAE,KAAK;QACf,YAAY,EAAE,KAAK;QACnB,MAAM,EAAE,SAAS;QACjB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM;QAC9B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU;QACtC,UAAU,EAAE,KAAK;QACjB,kBAAkB,EAAE,KAAK,CAAC,OAAO,CAAC,kBAAkB;KACvD,CAAC,CAAC;AACP,CAAC;AAED,oFAAoF;AACpF,MAAM,WAAW,GAAG,IAAI,GAAG,EAA8B,CAAC;AAE1D;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,IAAY,EAAE,SAAc,EAAE,QAAe,EAAE,GAAW;IACpF,uEAAuE;IACvE,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAE/B,8DAA8D;IAC9D,yBAAyB,CAAC,QAAQ,CAAC,CAAC;IAEpC,IAAI,UAAU,GAAmC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAEvE,IAAI,UAAU,EAAE,CAAC;QACb,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC;YAC5B,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;QAClC,CAAC;IACL,CAAC;SAAM,CAAC;QACJ,UAAU,GAAG,IAAI,OAAO,CAAC,UAAU,CAAC;YAChC,GAAG,SAAS;YACZ,QAAQ;YACR,GAAG;SACN,CAAC,CAAC;QACH,MAAM,UAAU,CAAC,UAAU,EAAE,CAAC;QAC9B,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAClC,IAAI,SAAS,CAAC,aAAa,EAAE,CAAC;YAC1B,MAAM,UAAU,CAAC,aAAa,EAAE,CAAC;QACrC,CAAC;IACL,CAAC;IAED,OAAO,UAAU,CAAC;AACtB,CAAC"}

package/dist/lib/database/index.js

@@ -0,0 +1,7 @@
+export * from "./ConnectionKinds.js";
+export * from "./ConnectionManager.js";
+export * from "./MongoConnection.js";
+export * from "./MongoRepository.js";
+export * from "./MongoSchemaSync.js";
+export * from "./NamingUtils.js";
+//# sourceMappingURL=index.js.map

package/dist/lib/database/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/database/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC"}

package/dist/lib/decorators/DatabaseDecorators.js

@@ -0,0 +1,52 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+/**
+ * Apply this to a property to have the TypeORM `MongoRepository` for the given entity type injected at instantiation.
+ *
+ * @param {any} type The entity type whose repository will be injected.
+ */
+export function MongoRepository(type) {
+    return function (target, propertyKey) {
+        Reflect.defineMetadata("rrst:injectMongoRepo", type, target, propertyKey);
+        const key = `__${String(propertyKey)}`;
+        Object.defineProperty(target, propertyKey, {
+            enumerable: true,
+            writable: true,
+            value: undefined,
+        });
+    };
+}
+/**
+ * Apply this to a property to have the TypeORM `Repository` for the given entity type injected at instantiation.
+ *
+ * @param {any} type The entity type whose repository will be injected.
+ */
+export function Repository(type) {
+    return function (target, propertyKey) {
+        Reflect.defineMetadata("rrst:injectRepo", type, target, propertyKey);
+        const key = `__${String(propertyKey)}`;
+        Object.defineProperty(target, propertyKey, {
+            enumerable: true,
+            writable: true,
+            value: undefined,
+        });
+    };
+}
+/**
+ * Apply this to a property to have the `Redis` connection injected at instantiation.
+ *
+ * @param {string} name The name of the database connection to inject.
+ */
+export function RedisConnection(name) {
+    return function (target, propertyKey) {
+        Reflect.defineMetadata("rrst:injectRedisRepo", name, target, propertyKey);
+        const key = `__${String(propertyKey)}`;
+        Object.defineProperty(target, propertyKey, {
+            enumerable: true,
+            writable: true,
+            value: undefined,
+        });
+    };
+}
+//# sourceMappingURL=DatabaseDecorators.js.map

package/dist/lib/decorators/DatabaseDecorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DatabaseDecorators.js","sourceRoot":"","sources":["../../../src/decorators/DatabaseDecorators.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAE/E;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,IAAS;IACrC,OAAO,UAAU,MAAW,EAAE,WAA4B;QACtD,OAAO,CAAC,cAAc,CAAC,sBAAsB,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QAC1E,MAAM,GAAG,GAAG,KAAK,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;QACvC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE;YACvC,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,SAAS;SACnB,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,IAAS;IAChC,OAAO,UAAU,MAAW,EAAE,WAA4B;QACtD,OAAO,CAAC,cAAc,CAAC,iBAAiB,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QACrE,MAAM,GAAG,GAAG,KAAK,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;QACvC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE;YACvC,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,SAAS;SACnB,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IACxC,OAAO,UAAU,MAAW,EAAE,WAA4B;QACtD,OAAO,CAAC,cAAc,CAAC,sBAAsB,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QAC1E,MAAM,GAAG,GAAG,KAAK,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;QACvC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE;YACvC,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,SAAS;SACnB,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC"}

package/dist/lib/decorators/DocDecorators.js

@@ -0,0 +1,120 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+import "reflect-metadata";
+/**
+ * Provides a set of documentation data for a given class, property or function.
+ *
+ * @param value The default value.
+ */
+export function Document(value) {
+    return function (target, propertyKey) {
+        const docs = {
+            ...(propertyKey ? Reflect.getMetadata("rrst:docs", target, propertyKey) : Reflect.getMetadata("rrst:docs", target)),
+            ...value
+        };
+        if (propertyKey) {
+            Reflect.defineMetadata("rrst:docs", docs, target, propertyKey);
+        }
+        else {
+            Reflect.defineMetadata("rrst:docs", docs, target);
+        }
+    };
+}
+/**
+ * Provides a default value for property of a class.
+ *
+ * @param value The default value.
+ */
+export function Default(value) {
+    return Document({
+        default: value
+    });
+}
+/**
+ * Provides a detailed describing the class, property or function.
+ *
+ * @param value The description of the class, property or function.
+ */
+export function Description(value) {
+    return Document({
+        description: value
+    });
+}
+/**
+ * Provides a example representation of the property or function return value.
+ *
+ * @param value The example value.
+ */
+export function Example(value) {
+    return Document({
+        example: value
+    });
+}
+/**
+ * Describes the underlying format of a class's property.
+ *
+ * @param value The format of the property's property.
+ */
+export function Format(value) {
+    return Document({
+        format: value
+    });
+}
+/**
+ * Provides a brief summary about the class, property or function.
+ *
+ * @param value The summary of the class, property or function.
+ */
+export function Summary(value) {
+    return Document({
+        summary: value
+    });
+}
+/**
+ * Provides a list of searchable tags associated with the property or function.
+ *
+ * @param value The list of searchable tags.
+ */
+export function Tags(value) {
+    return Document({
+        tags: value
+    });
+}
+/**
+ * Stores runtime metadata about the typing information of a function's return value.
+ *
+ * @param types The optional return type(s) of the function. Can represent a single type (e.g. `MyClass`) or a union
+ * of types (e.g. `string | number | null`). When describing a generic type such as a collection this
+ * should be encoded as an array with the templated type as additional elements (e.g. `Array<MyClass>`
+ * becomes `[[Array, MyClass]]`).
+ */
+export function Returns(types) {
+    return function (target, propertyKey) {
+        const designInfo = Reflect.getMetadata("design:type", target, propertyKey);
+        if (types) {
+            // Make sure we always store an array
+            types = Array.isArray(types) ? types : [types];
+        }
+        Reflect.defineMetadata("design:returntype", types !== undefined ? types : [designInfo], target, propertyKey);
+    };
+}
+/**
+ * Stores runtime metadata about the typing information of a class property.
+ *
+ * @param types The optional primary type(s) of the property. Can represent a single type (e.g. `MyClass`) or a union
+ * of types (e.g. `string | number | null`). When describing a generic type such as a collection this
+ * should be encoded as an array with the templated type as additional elements (e.g. `Array<MyClass>`
+ * becomes `[[Array, MyClass]]`).
+ */
+export function TypeInfo(types) {
+    return function (target, propertyKey) {
+        const designInfo = Reflect.getMetadata("design:type", target, propertyKey);
+        if (types) {
+            // Make sure we always store an array
+            types = Array.isArray(types) ? types : [types];
+        }
+        Reflect.defineMetadata("design:type", types !== undefined ? types : [designInfo], target, propertyKey);
+    };
+}
+//# sourceMappingURL=DocDecorators.js.map

package/dist/lib/decorators/DocDecorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DocDecorators.js","sourceRoot":"","sources":["../../../src/decorators/DocDecorators.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,OAAO,kBAAkB,CAAC;AAW1B;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAoB;IACzC,OAAO,UAAU,MAAW,EAAE,WAAoB;QAC9C,MAAM,IAAI,GAAQ;YACd,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YACnH,GAAG,KAAK;SACX,CAAC;QAEF,IAAI,WAAW,EAAE,CAAC;YACd,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QACnE,CAAC;aAAM,CAAC;YACJ,OAAO,CAAC,cAAc,CAAC,WAAW,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACtD,CAAC;IACL,CAAC,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAC,KAAa;IACjC,OAAO,QAAQ,CAAC;QACZ,OAAO,EAAE,KAAK;KACjB,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa;IACrC,OAAO,QAAQ,CAAC;QACZ,WAAW,EAAE,KAAK;KACrB,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAC,KAAU;IAC9B,OAAO,QAAQ,CAAC;QACZ,OAAO,EAAE,KAAK;KACjB,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,KAA8G;IACjI,OAAO,QAAQ,CAAC;QACZ,MAAM,EAAE,KAAK;KAChB,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,OAAO,CAAC,KAAa;IACjC,OAAO,QAAQ,CAAC;QACZ,OAAO,EAAE,KAAK;KACjB,CAAC,CAAC;AACP,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,IAAI,CAAC,KAAe;IAChC,OAAO,QAAQ,CAAC;QACZ,IAAI,EAAE,KAAK;KACd,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,OAAO,CAAC,KAAmB;IACvC,OAAO,UAAU,MAAW,EAAE,WAAmB;QAC7C,MAAM,UAAU,GAAQ,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QAChF,IAAI,KAAK,EAAE,CAAC;YACR,qCAAqC;YACrC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,CAAC,cAAc,CAAC,mBAAmB,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACjH,CAAC,CAAC;AACN,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAmB;IACxC,OAAO,UAAU,MAAW,EAAE,WAAmB;QAC7C,MAAM,UAAU,GAAQ,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QAChF,IAAI,KAAK,EAAE,CAAC;YACR,qCAAqC;YACrC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAC3G,CAAC,CAAC;AACN,CAAC"}

package/dist/lib/decorators/EventDecorators.js

@@ -0,0 +1,24 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz. All rights reserved.
+///////////////////////////////////////////////////////////////////////////////
+import "reflect-metadata";
+/**
+ * Apply this to a function that will be called when events arrive for the specified type(s). If no event type is
+ * specified, then the function will be called upon each event that arrives.
+ *
+ * @param type The name or list of names corresponding to events that the function will handle.
+ */
+export function OnEvent(type) {
+    return function (target, propertyKey, descriptor) {
+        Reflect.defineMetadata("rrst:events", type ? type : ".*", target, propertyKey);
+    };
+}
+/**
+ * Apply this optionally to a abitary class, that has a no argument constructor, to auto register it as an event listener. Will still require add `@OnEvent` to methods
+ */
+export function EventListener() {
+    return function (target) {
+        Reflect.defineMetadata("rrst:eventListeners", true, target);
+    };
+}
+//# sourceMappingURL=EventDecorators.js.map

package/dist/lib/decorators/EventDecorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventDecorators.js","sourceRoot":"","sources":["../../../src/decorators/EventDecorators.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E,OAAO,kBAAkB,CAAC;AAE1B;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,IAAwB;IAC5C,OAAO,UAAU,MAAW,EAAE,WAAmB,EAAE,UAA8B;QAC7E,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACnF,CAAC,CAAC;AACN,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa;IACzB,OAAO,UAAU,MAAW;QACxB,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC,CAAC;AACN,CAAC"}

package/dist/lib/decorators/ModelDecorators.js

@@ -0,0 +1,173 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz. All rights reserved.
+///////////////////////////////////////////////////////////////////////////////
+import "reflect-metadata";
+/**
+ * The list of column registrations waiting to be bridged into TypeORM's metadata storage. This list is drained by
+ * the TypeORM support module when a SQL connection is created.
+ */
+export const pendingTypeOrmColumns = [];
+/**
+ * Indicates that the class is cacheable with the specified TTL.
+ *
+ * @param ttl The time, in seconds, that an object will be cached before being invalidated.
+ */
+export function Cache(ttl = 30) {
+    return function (target) {
+        Reflect.defineMetadata("rrst:cacheTTL", ttl, target);
+        Object.defineProperty(target, "cacheTTL", {
+            enumerable: true,
+            writable: true,
+            value: ttl,
+        });
+    };
+}
+/**
+ * Indicates that a class is a child entity to some parent. Child entities will inherit all datastore configuration
+ * of the parent, including cache settings.
+ */
+export function ChildEntity() {
+    return function (constructor) {
+        // Queue the `_type` property registration so that it gets bridged to TypeORM if a SQL connection is
+        // created. MongoDB connections store the `_type` instance property natively and need no registration.
+        pendingTypeOrmColumns.push({
+            target: constructor,
+            propertyName: "_type",
+            mode: "regular",
+            options: {},
+        });
+        Reflect.defineMetadata("rrst:childEntity", true, constructor);
+        // Add the property so that it becomes an instance member
+        const child = class extends constructor {
+            constructor() {
+                super(...arguments);
+                /** The class type of the instance. */
+                this._type = constructor.name;
+            }
+        };
+        Reflect.defineMetadata("rrst:childEntity", true, child);
+        return child;
+    };
+}
+/**
+ * Indicates that the class describes an entity that will be persisted in the datastore with the given name.
+ *
+ * @param datastore The name of the datastore to store records of the decorated class.
+ */
+export function DataStore(datastore) {
+    return function (target) {
+        Reflect.defineMetadata("rrst:datastore", datastore, target);
+        Object.defineProperty(target, "datastore", {
+            enumerable: true,
+            writable: true,
+            value: datastore,
+        });
+    };
+}
+/**
+ * Apply this to a property that is considered a unique identifier.
+ */
+export function Identifier(target, propertyKey) {
+    Reflect.defineMetadata("rrst:isIdentifier", true, target, propertyKey);
+    const key = `__${String(propertyKey)}`;
+    Object.defineProperty(target, propertyKey, {
+        enumerable: true,
+        writable: true,
+        value: undefined,
+    });
+}
+/**
+ * Apply this to a model class to indicate that it should be protected by the AccessControlList security system.
+ * The `classACL` parameter specifies the default ACL governing access to general operations against the model class
+ * (e.g. create, truncate, find). The `recordACL` parameter indicates whether or not per-record ACLs should be created
+ * for this type in order to govern access to individual record operations (e.g. delete, update, find).
+ *
+ * @param classACL The default access control list to limit access to general class operations.
+ * @param recordACL Set to `true` to create an ACL for each new record of the given type, otherwise set to false. Default
+ * is `false`.
+ */
+export function Protect(classACL = {
+    uid: "<ClassName>",
+    records: [
+        {
+            userOrRoleId: "anonymous",
+            create: false,
+            read: true,
+            update: false,
+            delete: false,
+            special: false,
+            full: false,
+        },
+        {
+            userOrRoleId: ".*",
+            create: false,
+            read: true,
+            update: false,
+            delete: false,
+            special: false,
+            full: false,
+        },
+    ],
+}, recordACL = false) {
+    return function (target) {
+        if (!classACL.uid || classACL.uid === "<ClassName>") {
+            classACL.uid = target.name;
+        }
+        Reflect.defineMetadata("rrst:classACL", classACL, target);
+        Object.defineProperty(target, "classACL", {
+            enumerable: true,
+            writable: false,
+            value: classACL,
+        });
+        Reflect.defineMetadata("rrst:recordACL", recordACL, target);
+        Object.defineProperty(target, "recordACL", {
+            enumerable: true,
+            writable: false,
+            value: recordACL,
+        });
+    };
+}
+/**
+ * Apply this to a property to indicate that the value is a reference to another stored entity.
+ *
+ * @param clazz The class type of the referenced object.
+ */
+export function Reference(clazz) {
+    return function (target, propertyKey) {
+        Reflect.defineMetadata("rrst:reference", clazz, target, propertyKey);
+    };
+}
+/**
+ * Indicates that the class describes an entity that will be persisted in a sharded database collection.
+ *
+ * Note: Only supported by MongoDB.
+ *
+ * @param config The sharding configuration to pass to the database server. Default value is `{ key: { uid: 1 }, unique: false, options: {} }`.
+ */
+export function Shard(config = { key: { uid: 1 }, unique: false, options: {} }) {
+    return function (target) {
+        Reflect.defineMetadata("rrst:shardConfig", config, target);
+        Object.defineProperty(target, "shardConfig", {
+            enumerable: true,
+            writable: true,
+            value: config,
+        });
+    };
+}
+/**
+ * Indicates that the class will track changes for each document update limited to the specified number of versions.
+ *
+ * @param versions The number of versions that will be tracked for each document change. Set to `-1` to store all
+ * versions. Default value is `-1`.
+ */
+export function TrackChanges(versions = -1) {
+    return function (target) {
+        Reflect.defineMetadata("rrst:trackChanges", versions, target);
+        Object.defineProperty(target, "trackChanges", {
+            enumerable: true,
+            writable: true,
+            value: versions,
+        });
+    };
+}
+//# sourceMappingURL=ModelDecorators.js.map

package/dist/lib/decorators/ModelDecorators.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModelDecorators.js","sourceRoot":"","sources":["../../../src/decorators/ModelDecorators.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,wEAAwE;AACxE,+EAA+E;AAC/E,OAAO,kBAAkB,CAAC;AAe1B;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAA2B,EAAE,CAAC;AAEhE;;;;GAIG;AACH,MAAM,UAAU,KAAK,CAAC,MAAc,EAAE;IAClC,OAAO,UAAU,MAAW;QACxB,OAAO,CAAC,cAAc,CAAC,eAAe,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;QACrD,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,EAAE;YACtC,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,GAAG;SACb,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW;IACvB,OAAO,UAAkD,WAAc;QACnE,oGAAoG;QACpG,sGAAsG;QACtG,qBAAqB,CAAC,IAAI,CAAC;YACvB,MAAM,EAAE,WAAW;YACnB,YAAY,EAAE,OAAO;YACrB,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,EAAE;SACd,CAAC,CAAC;QAEH,OAAO,CAAC,cAAc,CAAC,kBAAkB,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QAE9D,yDAAyD;QACzD,MAAM,KAAK,GAAG,KAAM,SAAQ,WAAW;YAAzB;;gBACV,sCAAsC;gBACtB,UAAK,GAAW,WAAW,CAAC,IAAI,CAAC;YACrD,CAAC;SAAA,CAAC;QACF,OAAO,CAAC,cAAc,CAAC,kBAAkB,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QACxD,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,SAAiB;IACvC,OAAO,UAAU,MAAW;QACxB,OAAO,CAAC,cAAc,CAAC,gBAAgB,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAC5D,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE;YACvC,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,SAAS;SACnB,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,MAAW,EAAE,WAA4B;IAChE,OAAO,CAAC,cAAc,CAAC,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACvE,MAAM,GAAG,GAAG,KAAK,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;IACvC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE;QACvC,UAAU,EAAE,IAAI;QAChB,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,SAAS;KACnB,CAAC,CAAC;AACP,CAAC;AAID;;;;;;;;;GASG;AACH,MAAM,UAAU,OAAO,CACnB,WAAuB;IACnB,GAAG,EAAE,aAAa;IAClB,OAAO,EAAE;QACL;YACI,YAAY,EAAE,WAAW;YACzB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,KAAK;SACd;QACD;YACI,YAAY,EAAE,IAAI;YAClB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,KAAK;SACd;KACJ;CACJ,EACD,YAAqB,KAAK;IAE1B,OAAO,UAAU,MAAW;QACxB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,QAAQ,CAAC,GAAG,KAAK,aAAa,EAAE,CAAC;YAClD,QAAQ,CAAC,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC;QAC/B,CAAC;QAED,OAAO,CAAC,cAAc,CAAC,eAAe,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC1D,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,EAAE;YACtC,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,QAAQ;SAClB,CAAC,CAAC;QACH,OAAO,CAAC,cAAc,CAAC,gBAAgB,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAC5D,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,EAAE;YACvC,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,SAAS;SACnB,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,KAAU;IAChC,OAAO,UAAU,MAAW,EAAE,WAA4B;QACtD,OAAO,CAAC,cAAc,CAAC,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IACzE,CAAC,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,KAAK,CAAC,SAAc,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE;IAC/E,OAAO,UAAU,MAAW;QACxB,OAAO,CAAC,cAAc,CAAC,kBAAkB,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAC3D,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,aAAa,EAAE;YACzC,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,MAAM;SAChB,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,WAAmB,CAAC,CAAC;IAC9C,OAAO,UAAU,MAAW;QACxB,OAAO,CAAC,cAAc,CAAC,mBAAmB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC9D,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE;YAC1C,UAAU,EAAE,IAAI;YAChB,QAAQ,EAAE,IAAI;YACd,KAAK,EAAE,QAAQ;SAClB,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC"}