@rapidrest/service-core 1.0.0-beta.1 → 1.0.0-beta.2

package/dist/types/auth/BasicStrategy.d.ts

@@ -19,8 +19,10 @@ export declare class BasicStrategyOptions {
      * Referer headers, which permanently exposes credentials outside the application.
      */
     allowQueryParam: boolean;
-    /** You must override this function to perform verification of the login information. */
-    verify(uid: string, secret: string): JWTUser | Promise<JWTUser> | undefined;
+    /** Override this function to handle asynchronous (non-blocking) verification of the login info. */
+    verify(uid: string, secret: string): JWTUser | Promise<JWTUser | undefined> | undefined;
+    /** Override this function to handle synchronous (blocking) verification of the login info. */
+    verifySync(uid: string, secret: string): JWTUser | undefined;
 }
 /**
  * @author Jean-Philippe Steinmetz <rapidrests@gmail.com>
@@ -29,5 +31,7 @@ export declare class BasicStrategy implements AuthStrategy {
     readonly name: string;
     private options;
     constructor(options?: BasicStrategyOptions);
-    authenticate(req: HttpRequest, res: HttpResponse, required?: boolean): AuthResult | Promise<AuthResult> | undefined;
+    private getLoginInfo;
+    authenticate(req: HttpRequest, res: HttpResponse, required?: boolean): Promise<AuthResult | undefined>;
+    authenticateSync(req: HttpRequest, res: HttpResponse, required?: boolean): AuthResult | undefined;
 }

package/dist/types/auth/JWTStrategy.d.ts

@@ -54,8 +54,11 @@ export declare class JWTStrategy {
     private options;
     constructor(options?: JWTStrategyOptions);
     /**
-     * Attempts to authenticate the incoming request by extracting and verifying a JWT token.
-     * Returns a `JWTAuthResult` describing the outcome.
+     * Scans the provided request object for an authentication token this strategy can process.
+     * @param req The request to scan for an auth token.
+     * @returns The auth token if found, otherwise `undefined`.
      */
-    authenticate(req: HttpRequest, res: HttpResponse, required?: boolean): JWTAuthResult | undefined;
+    private getAuthToken;
+    authenticate(req: HttpRequest, res: HttpResponse, required?: boolean): Promise<JWTAuthResult | undefined>;
+    authenticateSync(req: HttpRequest, res: HttpResponse, required?: boolean): JWTAuthResult | undefined;
 }

package/dist/types/index.d.ts

@@ -9,9 +9,10 @@ export * from "./ObjectFactory.js";
 export * from "./OpenApiSpec.js";
 export * from "./Server.js";
 export * from "./Types.js";
+export * from "./auth/index.js";
 export * from "./database/index.js";
 export * from "./decorators/index.js";
+export * from "./http/index.js";
 export * from "./models/index.js";
-export * from "./auth/index.js";
 export * from "./routes/index.js";
 export * from "./security/index.js";

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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DatabaseDecorators.ts#L10)
+Defined in: [src/decorators/DatabaseDecorators.ts:10](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DatabaseDecorators.ts#L44)
+Defined in: [src/decorators/DatabaseDecorators.ts:44](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DatabaseDecorators.ts#L27)
+Defined in: [src/decorators/DatabaseDecorators.ts:27](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L40)
+Defined in: [src/decorators/DocDecorators.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L51)
+Defined in: [src/decorators/DocDecorators.ts:51](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L20)
+Defined in: [src/decorators/DocDecorators.ts:20](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L62)
+Defined in: [src/decorators/DocDecorators.ts:62](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L73)
+Defined in: [src/decorators/DocDecorators.ts:73](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L109)
+Defined in: [src/decorators/DocDecorators.ts:109](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L84)
+Defined in: [src/decorators/DocDecorators.ts:84](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L95)
+Defined in: [src/decorators/DocDecorators.ts:95](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L128)
+Defined in: [src/decorators/DocDecorators.ts:128](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L6)
+Defined in: [src/decorators/DocDecorators.ts:6](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L7)
+Defined in: [src/decorators/DocDecorators.ts:7](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L8)
+Defined in: [src/decorators/DocDecorators.ts:8](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L9)
+Defined in: [src/decorators/DocDecorators.ts:9](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L10)
+Defined in: [src/decorators/DocDecorators.ts:10](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L11)
+Defined in: [src/decorators/DocDecorators.ts:11](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/DocDecorators.ts#L12)
+Defined in: [src/decorators/DocDecorators.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/EventDecorators.ts#L21)
+Defined in: [src/decorators/EventDecorators.ts:21](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/EventDecorators.ts#L12)
+Defined in: [src/decorators/EventDecorators.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L30)
+Defined in: [src/decorators/ModelDecorators.ts:30](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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,7 +8,7 @@
 
 > **ChildEntity**(): \<`T`\>(`constructor`) => \{(...`args`): `child`\<`T`\>; `prototype`: `child`\<`any`\>; \} & `T`
 
-Defined in: [src/decorators/ModelDecorators.ts:45](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L45)
+Defined in: [src/decorators/ModelDecorators.ts:45](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/ModelDecorators.ts#L45)
 
 Indicates that a class is a child entity to some parent. Child entities will inherit all datastore configuration
 of the parent, including cache settings.

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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L73)
+Defined in: [src/decorators/ModelDecorators.ts:73](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L87)
+Defined in: [src/decorators/ModelDecorators.ts:87](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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,7 +8,7 @@
 
 > **Protect**(`classACL?`, `recordACL?`): (`target`) => `void`
 
-Defined in: [src/decorators/ModelDecorators.ts:109](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L109)
+Defined in: [src/decorators/ModelDecorators.ts:109](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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

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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L160)
+Defined in: [src/decorators/ModelDecorators.ts:160](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L173)
+Defined in: [src/decorators/ModelDecorators.ts:173](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L190)
+Defined in: [src/decorators/ModelDecorators.ts:190](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/ModelDecorators.ts#L190)
 
 Indicates that the class will track changes for each document update limited to the specified number of versions.
 

package/docs/reference/@rapidrest/namespaces/ModelDecorators/interfaces/PendingTypeOrmColumn.md

@@ -6,7 +6,7 @@
 
 # Interface: PendingTypeOrmColumn
 
-Defined in: [src/decorators/ModelDecorators.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L12)
+Defined in: [src/decorators/ModelDecorators.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/ModelDecorators.ts#L12)
 
 Describes a column registration that must be bridged into TypeORM's metadata storage when (and only when) a SQL
 connection is established. Entries are queued here by decorators so that this module does not depend on the
@@ -18,7 +18,7 @@ optional `typeorm` package.
 
 > **mode**: `"regular"`
 
-Defined in: [src/decorators/ModelDecorators.ts:15](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L15)
+Defined in: [src/decorators/ModelDecorators.ts:15](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/ModelDecorators.ts#L15)
 
 ***
 
@@ -26,7 +26,7 @@ Defined in: [src/decorators/ModelDecorators.ts:15](https://github.com/rapidrest/
 
 > **options**: `any`
 
-Defined in: [src/decorators/ModelDecorators.ts:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L16)
+Defined in: [src/decorators/ModelDecorators.ts:16](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/ModelDecorators.ts#L16)
 
 ***
 
@@ -34,7 +34,7 @@ Defined in: [src/decorators/ModelDecorators.ts:16](https://github.com/rapidrest/
 
 > **propertyName**: `string`
 
-Defined in: [src/decorators/ModelDecorators.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L14)
+Defined in: [src/decorators/ModelDecorators.ts:14](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/ModelDecorators.ts#L14)
 
 ***
 
@@ -42,4 +42,4 @@ Defined in: [src/decorators/ModelDecorators.ts:14](https://github.com/rapidrest/
 
 > **target**: `any`
 
-Defined in: [src/decorators/ModelDecorators.ts:13](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L13)
+Defined in: [src/decorators/ModelDecorators.ts:13](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/ModelDecorators.ts#L13)

package/docs/reference/@rapidrest/namespaces/ModelDecorators/variables/pendingTypeOrmColumns.md

@@ -8,7 +8,7 @@
 
 > `const` **pendingTypeOrmColumns**: [`PendingTypeOrmColumn`](../interfaces/PendingTypeOrmColumn.md)[] = `[]`
 
-Defined in: [src/decorators/ModelDecorators.ts:23](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/ModelDecorators.ts#L23)
+Defined in: [src/decorators/ModelDecorators.ts:23](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/ModelDecorators.ts#L23)
 
 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.

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Column.md

@@ -8,7 +8,7 @@
 
 > **Column**(`options?`): (`target`, `propertyKey`) => `void`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:95](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L95)
+Defined in: [src/decorators/PersistenceDecorators.ts:95](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L95)
 
 Indicates that the decorated property will be persisted as a column/property in the datastore.
 

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Entity.md

@@ -8,7 +8,7 @@
 
 > **Entity**(`name?`): (`target`) => `void`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:198](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L198)
+Defined in: [src/decorators/PersistenceDecorators.ts:198](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L198)
 
 Indicates that the class describes an entity that is persisted to a datastore.
 

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Index.md

@@ -10,7 +10,7 @@
 
 > **Index**(`nameOrOptions?`, `options?`): `PropertyDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:133](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L133)
+Defined in: [src/decorators/PersistenceDecorators.ts:133](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L133)
 
 Declares a database index.
 
@@ -46,7 +46,7 @@ When applied to a class, creates a compound index across the given properties:
 
 > **Index**(`fields`, `options?`): `ClassDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:134](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L134)
+Defined in: [src/decorators/PersistenceDecorators.ts:134](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L134)
 
 Declares a database index.
 
@@ -82,7 +82,7 @@ When applied to a class, creates a compound index across the given properties:
 
 > **Index**(`name`, `fields`, `options?`): `ClassDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:135](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L135)
+Defined in: [src/decorators/PersistenceDecorators.ts:135](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L135)
 
 Declares a database index.
 

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/PrimaryColumn.md

@@ -8,7 +8,7 @@
 
 > **PrimaryColumn**(`options?`): (`target`, `propertyKey`) => `void`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:111](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L111)
+Defined in: [src/decorators/PersistenceDecorators.ts:111](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L111)
 
 Indicates that the decorated property is a primary key column in the datastore.
 

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/Unique.md

@@ -10,7 +10,7 @@
 
 > **Unique**(`name?`): `PropertyDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:179](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L179)
+Defined in: [src/decorators/PersistenceDecorators.ts:179](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L179)
 
 Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
 applied to a property (single-column constraint) or a class (compound constraint).
@@ -29,7 +29,7 @@ applied to a property (single-column constraint) or a class (compound constraint
 
 > **Unique**(`fields`): `ClassDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:180](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L180)
+Defined in: [src/decorators/PersistenceDecorators.ts:180](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L180)
 
 Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
 applied to a property (single-column constraint) or a class (compound constraint).
@@ -48,7 +48,7 @@ applied to a property (single-column constraint) or a class (compound constraint
 
 > **Unique**(`name`, `fields`): `ClassDecorator`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:181](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L181)
+Defined in: [src/decorators/PersistenceDecorators.ts:181](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L181)
 
 Declares a unique constraint. This is shorthand for `@Index` with the `unique` option set to `true` and may be
 applied to a property (single-column constraint) or a class (compound constraint).

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getColumnMetadata.md

@@ -8,7 +8,7 @@
 
 > **getColumnMetadata**(`clazz`): [`ColumnInfo`](../interfaces/ColumnInfo.md)[]
 
-Defined in: [src/decorators/PersistenceDecorators.ts:216](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L216)
+Defined in: [src/decorators/PersistenceDecorators.ts:216](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L216)
 
 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/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getEntityName.md

@@ -8,7 +8,7 @@
 
 > **getEntityName**(`clazz`): `string` \| `undefined`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:261](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L261)
+Defined in: [src/decorators/PersistenceDecorators.ts:261](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L261)
 
 Returns the explicit entity name declared via `@Entity(name)` on the given class or the nearest ancestor that
 declares one, otherwise `undefined`.

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/functions/getIndexMetadata.md

@@ -8,7 +8,7 @@
 
 > **getIndexMetadata**(`clazz`): [`IndexInfo`](../interfaces/IndexInfo.md)[]
 
-Defined in: [src/decorators/PersistenceDecorators.ts:236](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L236)
+Defined in: [src/decorators/PersistenceDecorators.ts:236](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L236)
 
 Returns the merged list of indexes declared across the entire class hierarchy of the given model class,
 including both property-level and class-level (compound) indexes. Indexes declared in subclasses override

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnInfo.md

@@ -6,7 +6,7 @@
 
 # Interface: ColumnInfo
 
-Defined in: [src/decorators/PersistenceDecorators.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L38)
+Defined in: [src/decorators/PersistenceDecorators.ts:38](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L38)
 
 Describes a single persisted column/property of a model class.
 
@@ -16,7 +16,7 @@ Describes a single persisted column/property of a model class.
 
 > `optional` **designType?**: `any`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:42](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L42)
+Defined in: [src/decorators/PersistenceDecorators.ts:42](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L42)
 
 The design type of the property as captured at decoration time.
 
@@ -26,7 +26,7 @@ The design type of the property as captured at decoration time.
 
 > **options**: [`ColumnOptions`](ColumnOptions.md)
 
-Defined in: [src/decorators/PersistenceDecorators.ts:44](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L44)
+Defined in: [src/decorators/PersistenceDecorators.ts:44](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L44)
 
 The options that the column was declared with.
 
@@ -36,6 +36,6 @@ The options that the column was declared with.
 
 > **propertyName**: `string`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L40)
+Defined in: [src/decorators/PersistenceDecorators.ts:40](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L40)
 
 The name of the class property.

package/docs/reference/@rapidrest/namespaces/PersistenceDecorators/interfaces/ColumnOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: ColumnOptions
 
-Defined in: [src/decorators/PersistenceDecorators.ts:10](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L10)
+Defined in: [src/decorators/PersistenceDecorators.ts:10](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L10)
 
 The set of options available when declaring a persisted column/property via the `@Column` decorator.
 
@@ -16,7 +16,7 @@ The set of options available when declaring a persisted column/property via the
 
 > `optional` **isObjectId?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:18](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L18)
+Defined in: [src/decorators/PersistenceDecorators.ts:18](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L18)
 
 Set to `true` if the column stores a MongoDB `ObjectId` value.
 
@@ -26,7 +26,7 @@ Set to `true` if the column stores a MongoDB `ObjectId` value.
 
 > `optional` **name?**: `string`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L12)
+Defined in: [src/decorators/PersistenceDecorators.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L12)
 
 The name of the column in the datastore. Defaults to the property name.
 
@@ -36,7 +36,7 @@ The name of the column in the datastore. Defaults to the property name.
 
 > `optional` **nullable?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L14)
+Defined in: [src/decorators/PersistenceDecorators.ts:14](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L14)
 
 Set to `true` if the column may store `null`/`undefined` values.
 
@@ -46,6 +46,6 @@ Set to `true` if the column may store `null`/`undefined` values.
 
 > `optional` **primary?**: `boolean`
 
-Defined in: [src/decorators/PersistenceDecorators.ts:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/decorators/PersistenceDecorators.ts#L16)
+Defined in: [src/decorators/PersistenceDecorators.ts:16](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/decorators/PersistenceDecorators.ts#L16)
 
 Set to `true` if the column is a primary key.