@rapidrest/service-core 1.0.0-beta.6 → 1.0.0-rc.2

package/dist/types/database/MongoRepository.d.ts

@@ -1,4 +1,4 @@
-import type { AggregationCursor, Collection, Db, DeleteResult, Document, UpdateResult } from "mongodb";
+import type { AggregationCursor, Collection, CountDocumentsOptions, Db, DeleteOptions, DeleteResult, Document, Filter, FindCursor, FindOptions, UpdateOptions, UpdateResult } from "mongodb";
 /**
  * Provides a lightweight repository for performing common operations against a single MongoDB collection using the
  * native `mongodb` driver. Instances of this class are obtained via `MongoConnection.getRepository`.
@@ -32,40 +32,44 @@ export declare class MongoRepository<T extends Document = any> {
     /**
      * Returns the number of documents matching the given filter.
      *
-     * @param filter The query filter to match documents against.
+     * @param filter - The filter for the count
+     * @param options - Optional settings for the command
      */
-    count(filter?: any): Promise<number>;
+    count(filter?: Filter<T>, options?: CountDocumentsOptions): Promise<number>;
     /**
      * Deletes all documents matching the given filter.
      *
      * @param filter The query filter to match documents against.
+     * @param options - Optional settings for the command
      */
-    deleteMany(filter: any): Promise<DeleteResult>;
+    deleteMany(filter: Filter<T>, options?: DeleteOptions): Promise<DeleteResult>;
     /**
      * Deletes the first document matching the given filter.
      *
      * @param filter The query filter to match documents against.
+     * @param options - Optional settings for the command
      */
-    deleteOne(filter: any): Promise<DeleteResult>;
+    deleteOne(filter?: Filter<T>, options?: DeleteOptions): Promise<DeleteResult>;
     /**
      * Returns the list of distinct values of the given field for all documents matching the given filter.
      *
      * @param field The name of the document field to return distinct values of.
      * @param filter The query filter to match documents against.
      */
-    distinct(field: string, filter?: any): Promise<any[]>;
+    distinct(field: string, filter?: Filter<T>): Promise<any[]>;
     /**
      * Returns all documents matching the given filter.
      *
      * @param filter The query filter to match documents against.
+     * @param options - Optional settings for the command
      */
-    find(filter?: any): Promise<any[]>;
+    find(filter?: Filter<T>, options?: FindOptions): FindCursor<T>;
     /**
      * Returns the first document matching the given filter.
      *
      * @param filter The query filter to match documents against.
      */
-    findOne(filter: any): Promise<any | null>;
+    findOne(filter: any): Promise<T | null>;
     /**
      * Saves the given document to the collection. If the document has an existing `_id` the stored document is
      * replaced (inserting if missing), otherwise the document is inserted and its newly assigned `_id` is set on
@@ -74,19 +78,21 @@ export declare class MongoRepository<T extends Document = any> {
      * @param doc The document to save.
      * @returns The saved document.
      */
-    save(doc: any): Promise<any>;
+    save(doc: any): Promise<T>;
     /**
      * Updates all documents matching the given filter with the provided update operations.
      *
      * @param filter The query filter to match documents against.
      * @param update The update operations (e.g. `$set`) to apply.
+     * @param options - Optional settings for the command
      */
-    updateMany(filter: any, update: any): Promise<UpdateResult>;
+    updateMany(filter: any, update: any, options?: UpdateOptions): Promise<UpdateResult<T>>;
     /**
      * Updates the first document matching the given filter with the provided update operations.
      *
      * @param filter The query filter to match documents against.
      * @param update The update operations (e.g. `$set`) to apply.
+     * @param options - Optional settings for the command
      */
-    updateOne(filter: any, update: any): Promise<UpdateResult>;
+    updateOne(filter: any, update: any, options?: UpdateOptions): Promise<UpdateResult<T>>;
 }

package/dist/types/database/MongoSchemaSync.d.ts

@@ -1,4 +1,9 @@
-import type { Db } from "mongodb";
+import type { CreateCollectionOptions, Db } from "mongodb";
+interface CollectionInfo {
+    name: string;
+    classes: any[];
+    options?: CreateCollectionOptions;
+}
 /**
  * Performs structure synchronization of MongoDB collections based on the persistence metadata of model classes.
  *
@@ -16,6 +21,20 @@ export declare class MongoSchemaSync {
     private db;
     private logger;
     constructor(db: Db, logger?: any);
+    /**
+     * Resolves the entity info of the database collection (or table) that records of the given model class are stored in.
+     *
+     * The entity info is resolved using the following rules:
+     * 1. The nearest class in the inheritance chain (starting with `clazz` itself) that specifies an explicit
+     * entity info via the `@Entity(info)` decorator.
+     * 2. Otherwise, the most ancestral class in the inheritance chain that declares its own `@DataStore` binding.
+     * This ensures that `@ChildEntity` subclasses are stored in the same collection as their parent entity
+     * (single collection inheritance).
+     * 3. Otherwise, a new info object containing the snake_case form of the class name.
+     *
+     * @param clazz The model class to resolve the collection name for.
+     */
+    resolveCollectionInfo(clazz: any): CollectionInfo;
     /**
      * Synchronizes the structure of all collections associated with the given model classes.
      *
@@ -25,8 +44,7 @@ export declare class MongoSchemaSync {
     /**
      * Synchronizes the structure of a single collection.
      *
-     * @param name The name of the collection to synchronize.
-     * @param classes The list of model classes whose records are stored in the collection.
+     * @param info The information about the collection to synchronize.
      */
     private syncCollection;
     /**
@@ -36,6 +54,10 @@ export declare class MongoSchemaSync {
     /**
      * Determines whether an existing index satisfies the desired index specification. The `background` option is
      * a build-time hint and is intentionally excluded from the comparison.
+     *
+     * Collation is compared by `locale` and `strength` only — MongoDB adds default values for all other fields
+     * when storing the index, which would cause spurious mismatches if we compared the full object.
      */
     private optionsMatch;
 }
+export {};

package/dist/types/database/NamingUtils.d.ts

@@ -13,7 +13,7 @@ export declare function snakeCase(str: string): string;
  *
  * The name is resolved using the following rules:
  * 1. The nearest class in the inheritance chain (starting with `clazz` itself) that specifies an explicit
- * entity name via the `@Entity(name)` decorator.
+ * entity name via the `@Entity(options)` decorator.
  * 2. Otherwise, the most ancestral class in the inheritance chain that declares its own `@DataStore` binding.
  * This ensures that `@ChildEntity` subclasses are stored in the same collection as their parent entity
  * (single collection inheritance).

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

@@ -1,4 +1,19 @@
 import "reflect-metadata";
+/**
+ * The language-specific rules to use for string comparison in MongoDB collections.
+ *
+ * @see https://www.mongodb.com/docs/v7.0/reference/collation/#std-label-collation
+ */
+export interface CollationOptions {
+    locale: string;
+    caseLevel?: boolean;
+    caseFirst?: string;
+    strength?: number;
+    numericOrdering?: boolean;
+    alternate?: string;
+    maxVariable?: string;
+    backwards?: boolean;
+}
 /**
  * The set of options available when declaring a persisted column/property via the `@Column` decorator.
  */
@@ -12,6 +27,16 @@ export interface ColumnOptions {
     /** Set to `true` if the column stores a MongoDB `ObjectId` value. */
     isObjectId?: boolean;
 }
+/**
+ * The set of options to use when declaring a persistent class type via the `@Entity` decorator.
+ */
+export interface EntityOptions {
+    /** The name of the collection (or table) that records will be stored in. Defaults to the snake_case
+     * form of the class name. */
+    name?: string;
+    /** The language-specific collation rules to apply to the collection. (MongoDB only) */
+    collation?: CollationOptions;
+}
 /**
  * The set of options available when declaring a database index via the `@Index` decorator.
  */
@@ -24,6 +49,8 @@ export interface IndexOptions {
     background?: boolean;
     /** The time, in seconds, after which indexed documents will be automatically deleted. (MongoDB only) */
     expireAfterSeconds?: number;
+    /** The language-specific collation rules to apply to the index. (MongoDB only) */
+    collation?: CollationOptions;
 }
 /**
  * Describes a single persisted column/property of a model class.
@@ -89,10 +116,9 @@ export declare function Unique(name: string, fields: string[]): ClassDecorator;
 /**
  * Indicates that the class describes an entity that is persisted to a datastore.
  *
- * @param name The name of the collection (or table) that records will be stored in. Defaults to the snake_case
- * form of the class name.
+ * @param options The options to set.
  */
-export declare function Entity(name?: string): (target: any) => void;
+export declare function Entity(options?: EntityOptions): (target: any) => void;
 /**
  * Returns the merged list of persisted columns declared across the entire class hierarchy of the given model
  * class. Columns declared in subclasses override columns of the same property name declared in parent classes.

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

@@ -35,10 +35,9 @@ export declare class ModelUtils {
      * @param modelClass The class definition of the data model to build a search query for.
      * @param id The unique identifier to search for.
      * @param version The version number of the document to search for.
-     * @param productUid The optional product uid that is associated with the uid (when a compound key is used).
      * @returns An object that can be passed to a TypeORM `find` function.
      */
-    static buildIdSearchQuery<T extends {}>(repo: Repository<T> | MongoRepository<T> | undefined, modelClass: any, id: any | any[], version?: number, productUid?: string): any;
+    static buildIdSearchQuery<T extends {}>(repo: Repository<T> | MongoRepository<T> | undefined, modelClass: any, id: any | any[], version?: number): any;
     /**
      * Builds a TypeORM compatible query object for use in `find` functions for retrieving objects matching the
      * specified unique identifier.
@@ -46,10 +45,9 @@ export declare class ModelUtils {
      * @param modelClass The class definition of the data model to build a search query for.
      * @param id The unique identifier to search for.
      * @param version The version number of the document to search for.
-     * @param productUid The optional product uid that is associated with the uid (when a compound key is used).
      * @returns An object that can be passed to a TypeORM `find` function.
      */
-    static buildIdSearchQuerySQL(modelClass: any, id: any | any[], version?: number, productUid?: string): any;
+    static buildIdSearchQuerySQL(modelClass: any, id: any | any[], version?: number): any;
     /**
      * Builds a MongoDB compatible query object for use in `find` functions for retrieving objects matching the
      * specified unique identifier.
@@ -57,10 +55,9 @@ export declare class ModelUtils {
      * @param modelClass The class definition of the data model to build a search query for.
      * @param id The unique identifier to search for.
      * @param version The version number of the document to search for.
-     * @param productUid The optional product uid that is associated with the uid (when a compound key is used).
      * @returns An object that can be passed to a MongoDB `find` function.
      */
-    static buildIdSearchQueryMongo(modelClass: any, id: any | any[], version?: number, productUid?: string): any;
+    static buildIdSearchQueryMongo(modelClass: any, id: any | any[], version?: number): any;
     /**
      * Given a string containing a parameter value and/or a comparison operation return a TypeORM compatible find value.
      * e.g.

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

@@ -35,8 +35,6 @@ export interface RepoCreateOptions extends RepoOperationOptions {
  * The available options for the `RepoUtils.delete()` operation.
  */
 export interface RepoDeleteOptions extends RepoOperationOptions {
-    /** The desired product uid of the resource to delete. */
-    productUid?: string;
     /** Set to true to permanently remove the object from the database (if applicable). */
     purge?: boolean;
     /** The desired version number of the resource to delete. */
@@ -47,8 +45,6 @@ export interface RepoFindOptions extends RepoOperationOptions {
     limit?: number;
     /** The page number of the paginated results to retrieve. */
     page?: number;
-    /** The desired product uid of the resources to retrieve. */
-    productUid?: string;
     /** Set to `true` to skip retrieval from the cache. Default is `false`. */
     skipCache?: boolean;
     /** The desired version number of the resources to retrieve. */
@@ -58,8 +54,6 @@ export interface RepoFindOptions extends RepoOperationOptions {
  * The available options for the `RepoUtils.update()` operation.
  */
 export interface RepoUpdateOptions<T extends BaseEntity | SimpleEntity> extends RepoOperationOptions {
-    /** The desired product uid of the resource to update. */
-    productUid?: string;
     /** The desired version number of the resource to update. */
     version?: number | string;
 }
@@ -140,7 +134,7 @@ export declare class RepoUtils<T extends BaseEntity | SimpleEntity> {
      *
      * The result of this function is compatible with all `Repository.find()` functions.
      */
-    searchIdQuery(id: string, version?: number | string, productUid?: string): any;
+    searchIdQuery(id: string, version?: number | string): any;
     truncate(query: any, options: RepoFindOptions): Promise<void>;
     update(obj: Partial<T>, existing: T, options?: RepoUpdateOptions<T>): Promise<T>;
     /**

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

@@ -30,8 +30,6 @@ export interface CreateRequestOptions extends RequestOptions {
  * The set of options required by delete request handlers.
  */
 export interface DeleteRequestOptions extends RequestOptions {
-    /** The desired product uid of the resource to delete. */
-    productUid?: string;
     /** Set to true to permanently remove the object from the database (if applicable). */
     purge?: boolean;
     /** An additional list of channel names to send push notifications to. */
@@ -71,8 +69,6 @@ export type UpdateObject<T extends BaseEntity | SimpleEntity> = Partial<T> & Pic
 export interface UpdateRequestOptions<T extends BaseEntity | SimpleEntity> extends RequestOptions {
     /** The existing object that has already been recently pulled from the datastore. */
     existing?: T | null;
-    /** The desired product uid of the resource to update. */
-    productUid?: string;
     /** An additional list of channel names to send push notifications to. */
     pushChannels?: string[];
     /** Set to `true` to not send a push notification. */

package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/MongoRepository.md

@@ -8,7 +8,7 @@
 
 > **MongoRepository**(`type`): (`target`, `propertyKey`) => `void`
 
-Defined in: [src/decorators/DatabaseDecorators.ts:10](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DatabaseDecorators.ts#L10)
+Defined in: [src/decorators/DatabaseDecorators.ts:10](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DatabaseDecorators.ts#L10)
 
 Apply this to a property to have the TypeORM `MongoRepository` for the given entity type injected at instantiation.
 

package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/RedisConnection.md

@@ -8,7 +8,7 @@
 
 > **RedisConnection**(`name`): (`target`, `propertyKey`) => `void`
 
-Defined in: [src/decorators/DatabaseDecorators.ts:44](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DatabaseDecorators.ts#L44)
+Defined in: [src/decorators/DatabaseDecorators.ts:44](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DatabaseDecorators.ts#L44)
 
 Apply this to a property to have the `Redis` connection injected at instantiation.
 

package/docs/reference/@rapidrest/namespaces/DatabaseDecorators/functions/Repository.md

@@ -8,7 +8,7 @@
 
 > **Repository**(`type`): (`target`, `propertyKey`) => `void`
 
-Defined in: [src/decorators/DatabaseDecorators.ts:27](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DatabaseDecorators.ts#L27)
+Defined in: [src/decorators/DatabaseDecorators.ts:27](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DatabaseDecorators.ts#L27)
 
 Apply this to a property to have the TypeORM `Repository` for the given entity type injected at instantiation.
 

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Default.md

@@ -8,7 +8,7 @@
 
 > **Default**(`value`): (`target`, `propertyKey?`) => `void`
 
-Defined in: [src/decorators/DocDecorators.ts:40](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L40)
+Defined in: [src/decorators/DocDecorators.ts:40](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L40)
 
 Provides a default value for property of a class.
 

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Description.md

@@ -8,7 +8,7 @@
 
 > **Description**(`value`): (`target`, `propertyKey?`) => `void`
 
-Defined in: [src/decorators/DocDecorators.ts:51](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L51)
+Defined in: [src/decorators/DocDecorators.ts:51](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L51)
 
 Provides a detailed describing the class, property or function.
 

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Document.md

@@ -8,7 +8,7 @@
 
 > **Document**(`value`): (`target`, `propertyKey?`) => `void`
 
-Defined in: [src/decorators/DocDecorators.ts:20](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L20)
+Defined in: [src/decorators/DocDecorators.ts:20](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L20)
 
 Provides a set of documentation data for a given class, property or function.
 

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Example.md

@@ -8,7 +8,7 @@
 
 > **Example**(`value`): (`target`, `propertyKey?`) => `void`
 
-Defined in: [src/decorators/DocDecorators.ts:62](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L62)
+Defined in: [src/decorators/DocDecorators.ts:62](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L62)
 
 Provides a example representation of the property or function return value.
 

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Format.md

@@ -8,7 +8,7 @@
 
 > **Format**(`value`): (`target`, `propertyKey?`) => `void`
 
-Defined in: [src/decorators/DocDecorators.ts:73](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L73)
+Defined in: [src/decorators/DocDecorators.ts:73](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L73)
 
 Describes the underlying format of a class's property.
 

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Returns.md

@@ -8,7 +8,7 @@
 
 > **Returns**(`types?`): (`target`, `propertyKey`) => `void`
 
-Defined in: [src/decorators/DocDecorators.ts:109](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L109)
+Defined in: [src/decorators/DocDecorators.ts:109](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L109)
 
 Stores runtime metadata about the typing information of a function's return value.
 

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Summary.md

@@ -8,7 +8,7 @@
 
 > **Summary**(`value`): (`target`, `propertyKey?`) => `void`
 
-Defined in: [src/decorators/DocDecorators.ts:84](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L84)
+Defined in: [src/decorators/DocDecorators.ts:84](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L84)
 
 Provides a brief summary about the class, property or function.
 

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/Tags.md

@@ -8,7 +8,7 @@
 
 > **Tags**(`value`): (`target`, `propertyKey?`) => `void`
 
-Defined in: [src/decorators/DocDecorators.ts:95](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L95)
+Defined in: [src/decorators/DocDecorators.ts:95](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L95)
 
 Provides a list of searchable tags associated with the property or function.
 

package/docs/reference/@rapidrest/namespaces/DocDecorators/functions/TypeInfo.md

@@ -8,7 +8,7 @@
 
 > **TypeInfo**(`types?`): (`target`, `propertyKey`) => `void`
 
-Defined in: [src/decorators/DocDecorators.ts:128](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L128)
+Defined in: [src/decorators/DocDecorators.ts:128](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L128)
 
 Stores runtime metadata about the typing information of a class property.
 

package/docs/reference/@rapidrest/namespaces/DocDecorators/interfaces/DocumentsData.md

@@ -6,7 +6,7 @@
 
 # Interface: DocumentsData
 
-Defined in: [src/decorators/DocDecorators.ts:6](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L6)
+Defined in: [src/decorators/DocDecorators.ts:6](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L6)
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: [src/decorators/DocDecorators.ts:6](https://github.com/rapidrest/ser
 
 > `optional` **default?**: `any`
 
-Defined in: [src/decorators/DocDecorators.ts:7](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L7)
+Defined in: [src/decorators/DocDecorators.ts:7](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L7)
 
 ***
 
@@ -22,7 +22,7 @@ Defined in: [src/decorators/DocDecorators.ts:7](https://github.com/rapidrest/ser
 
 > `optional` **description?**: `string`
 
-Defined in: [src/decorators/DocDecorators.ts:8](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L8)
+Defined in: [src/decorators/DocDecorators.ts:8](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L8)
 
 ***
 
@@ -30,7 +30,7 @@ Defined in: [src/decorators/DocDecorators.ts:8](https://github.com/rapidrest/ser
 
 > `optional` **example?**: `any`
 
-Defined in: [src/decorators/DocDecorators.ts:9](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L9)
+Defined in: [src/decorators/DocDecorators.ts:9](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L9)
 
 ***
 
@@ -38,7 +38,7 @@ Defined in: [src/decorators/DocDecorators.ts:9](https://github.com/rapidrest/ser
 
 > `optional` **format?**: `string`
 
-Defined in: [src/decorators/DocDecorators.ts:10](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L10)
+Defined in: [src/decorators/DocDecorators.ts:10](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L10)
 
 ***
 
@@ -46,7 +46,7 @@ Defined in: [src/decorators/DocDecorators.ts:10](https://github.com/rapidrest/se
 
 > `optional` **summary?**: `string`
 
-Defined in: [src/decorators/DocDecorators.ts:11](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L11)
+Defined in: [src/decorators/DocDecorators.ts:11](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L11)
 
 ***
 
@@ -54,4 +54,4 @@ Defined in: [src/decorators/DocDecorators.ts:11](https://github.com/rapidrest/se
 
 > `optional` **tags?**: `string`[]
 
-Defined in: [src/decorators/DocDecorators.ts:12](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/DocDecorators.ts#L12)
+Defined in: [src/decorators/DocDecorators.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/DocDecorators.ts#L12)

package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/EventListener.md

@@ -8,7 +8,7 @@
 
 > **EventListener**(): (`target`) => `void`
 
-Defined in: [src/decorators/EventDecorators.ts:21](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/EventDecorators.ts#L21)
+Defined in: [src/decorators/EventDecorators.ts:21](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/EventDecorators.ts#L21)
 
 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
 

package/docs/reference/@rapidrest/namespaces/EventDecorators/functions/OnEvent.md

@@ -8,7 +8,7 @@
 
 > **OnEvent**(`type?`): (`target`, `propertyKey`, `descriptor`) => `void`
 
-Defined in: [src/decorators/EventDecorators.ts:12](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/EventDecorators.ts#L12)
+Defined in: [src/decorators/EventDecorators.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/EventDecorators.ts#L12)
 
 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.

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Cache.md

@@ -8,7 +8,7 @@
 
 > **Cache**(`ttl?`): (`target`) => `void`
 
-Defined in: [src/decorators/ModelDecorators.ts:30](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L30)
+Defined in: [src/decorators/ModelDecorators.ts:30](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L30)
 
 Indicates that the class is cacheable with the specified TTL.
 

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/ChildEntity.md

@@ -8,9 +8,9 @@
 
 > **ChildEntity**(): \<`T`\>(`constructor`) => \{(...`args`): `child`\<`T`\>; `prototype`: `child`\<`any`\>; \} & `T`
 
-Defined in: [src/decorators/ModelDecorators.ts:45](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L45)
+Defined in: [src/decorators/ModelDecorators.ts:45](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L45)
 
-Indicates that a class is a child entity to some parent. Child entities will inherit all datastore configuration
+Indicates that a class is a child entity to some parent. Child entities will inherit all datastore configuration
 of the parent, including cache settings.
 
 ## Returns

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/DataStore.md

@@ -8,7 +8,7 @@
 
 > **DataStore**(`datastore`): (`target`) => `void`
 
-Defined in: [src/decorators/ModelDecorators.ts:73](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L73)
+Defined in: [src/decorators/ModelDecorators.ts:73](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L73)
 
 Indicates that the class describes an entity that will be persisted in the datastore with the given name.
 

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Identifier.md

@@ -8,7 +8,7 @@
 
 > **Identifier**(`target`, `propertyKey`): `void`
 
-Defined in: [src/decorators/ModelDecorators.ts:87](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L87)
+Defined in: [src/decorators/ModelDecorators.ts:87](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L87)
 
 Apply this to a property that is considered a unique identifier.
 

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Protect.md

@@ -8,11 +8,11 @@
 
 > **Protect**(`classACL?`, `recordACL?`): (`target`) => `void`
 
-Defined in: [src/decorators/ModelDecorators.ts:109](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L109)
+Defined in: [src/decorators/ModelDecorators.ts:109](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L109)
 
-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
+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).
 
 ## Parameters
@@ -27,7 +27,7 @@ The default access control list to limit access to general class operations.
 
 `boolean` = `false`
 
-Set to `true` to create an ACL for each new record of the given type, otherwise set to false. Default
+Set to `true` to create an ACL for each new record of the given type, otherwise set to false. Default
 is `false`.
 
 ## Returns

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Reference.md

@@ -8,7 +8,7 @@
 
 > **Reference**(`clazz`): (`target`, `propertyKey`) => `void`
 
-Defined in: [src/decorators/ModelDecorators.ts:160](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L160)
+Defined in: [src/decorators/ModelDecorators.ts:160](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L160)
 
 Apply this to a property to indicate that the value is a reference to another stored entity.
 

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/Shard.md

@@ -8,7 +8,7 @@
 
 > **Shard**(`config?`): (`target`) => `void`
 
-Defined in: [src/decorators/ModelDecorators.ts:173](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L173)
+Defined in: [src/decorators/ModelDecorators.ts:173](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L173)
 
 Indicates that the class describes an entity that will be persisted in a sharded database collection.
 

package/docs/reference/@rapidrest/namespaces/ModelDecorators/functions/TrackChanges.md

@@ -8,7 +8,7 @@
 
 > **TrackChanges**(`versions?`): (`target`) => `void`
 
-Defined in: [src/decorators/ModelDecorators.ts:190](https://github.com/rapidrest/service-core/blob/1525696e01ca0eceb33d14e93f096bae8fe233b3/src/decorators/ModelDecorators.ts#L190)
+Defined in: [src/decorators/ModelDecorators.ts:190](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/decorators/ModelDecorators.ts#L190)
 
 Indicates that the class will track changes for each document update limited to the specified number of versions.
 
@@ -18,7 +18,7 @@ Indicates that the class will track changes for each document update limited to
 
 `number` = `-1`
 
-The number of versions that will be tracked for each document change. Set to `-1` to store all
+The number of versions that will be tracked for each document change. Set to `-1` to store all
 versions. Default value is `-1`.
 
 ## Returns