@rapidrest/service-core 1.0.0-beta.1

package/docs/reference/enumerations/ApiErrorMessages.md

@@ -0,0 +1,123 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / ApiErrorMessages
+
+# Enumeration: ApiErrorMessages
+
+Defined in: [src/ApiErrors.ts:24](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L24)
+
+Defines the default message of all common API errors.
+
+## Enumeration Members
+
+### AUTH\_FAILED
+
+> **AUTH\_FAILED**: `"Invalid or missing authentication token."`
+
+Defined in: [src/ApiErrors.ts:37](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L37)
+
+***
+
+### AUTH\_PERMISSION\_FAILURE
+
+> **AUTH\_PERMISSION\_FAILURE**: `"User does not have permission to perform this action."`
+
+Defined in: [src/ApiErrors.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L38)
+
+***
+
+### AUTH\_REQUIRED
+
+> **AUTH\_REQUIRED**: `"Authorization is required to access this resource."`
+
+Defined in: [src/ApiErrors.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L36)
+
+***
+
+### BULK\_CREATE\_FAILURE
+
+> **BULK\_CREATE\_FAILURE**: `"Failed to create one or more objects."`
+
+Defined in: [src/ApiErrors.ts:34](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L34)
+
+***
+
+### BULK\_UPDATE\_FAILURE
+
+> **BULK\_UPDATE\_FAILURE**: `"Failed to update one or more objects."`
+
+Defined in: [src/ApiErrors.ts:35](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L35)
+
+***
+
+### IDENTIFIER\_EXISTS
+
+> **IDENTIFIER\_EXISTS**: `"A resource with that identifier already exists."`
+
+Defined in: [src/ApiErrors.ts:29](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L29)
+
+***
+
+### INTERNAL\_ERROR
+
+> **INTERNAL\_ERROR**: `"An internal error has occurred. Please contact the adminstrator."`
+
+Defined in: [src/ApiErrors.ts:26](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L26)
+
+***
+
+### INVALID\_OBJECT\_VERSION
+
+> **INVALID\_OBJECT\_VERSION**: `"Invalid object version. Do you have the latest version?"`
+
+Defined in: [src/ApiErrors.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L30)
+
+***
+
+### INVALID\_REQUEST
+
+> **INVALID\_REQUEST**: `"Invalid message or request."`
+
+Defined in: [src/ApiErrors.ts:27](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L27)
+
+***
+
+### NOT\_FOUND
+
+> **NOT\_FOUND**: `"No resource could be found with the specified identifier."`
+
+Defined in: [src/ApiErrors.ts:28](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L28)
+
+***
+
+### OBJECT\_ID\_MISMATCH
+
+> **OBJECT\_ID\_MISMATCH**: `"The object provided does not match the identifier given."`
+
+Defined in: [src/ApiErrors.ts:31](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L31)
+
+***
+
+### SEARCH\_INVALID\_ME\_REFERENCE
+
+> **SEARCH\_INVALID\_ME\_REFERENCE**: `` "Use of the `me` reference requires authentication." ``
+
+Defined in: [src/ApiErrors.ts:33](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L33)
+
+***
+
+### SEARCH\_INVALID\_RANGE
+
+> **SEARCH\_INVALID\_RANGE**: `"Invalid range value: '{{value}}'. Expected 2 arguments, got {{length}}"`
+
+Defined in: [src/ApiErrors.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L32)
+
+***
+
+### UNKNOWN
+
+> **UNKNOWN**: `"An unknown error has occurred. Please try again."`
+
+Defined in: [src/ApiErrors.ts:25](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L25)

package/docs/reference/enumerations/ApiErrors.md

@@ -0,0 +1,123 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / ApiErrors
+
+# Enumeration: ApiErrors
+
+Defined in: [src/ApiErrors.ts:4](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L4)
+
+Defines the unique codes for all common API errors.
+
+## Enumeration Members
+
+### AUTH\_FAILED
+
+> **AUTH\_FAILED**: `"api-101"`
+
+Defined in: [src/ApiErrors.ts:17](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L17)
+
+***
+
+### AUTH\_PERMISSION\_FAILURE
+
+> **AUTH\_PERMISSION\_FAILURE**: `"api-102"`
+
+Defined in: [src/ApiErrors.ts:18](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L18)
+
+***
+
+### AUTH\_REQUIRED
+
+> **AUTH\_REQUIRED**: `"api-100"`
+
+Defined in: [src/ApiErrors.ts:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L16)
+
+***
+
+### BULK\_CREATE\_FAILURE
+
+> **BULK\_CREATE\_FAILURE**: `"api-021"`
+
+Defined in: [src/ApiErrors.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L14)
+
+***
+
+### BULK\_UPDATE\_FAILURE
+
+> **BULK\_UPDATE\_FAILURE**: `"api-022"`
+
+Defined in: [src/ApiErrors.ts:15](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L15)
+
+***
+
+### IDENTIFIER\_EXISTS
+
+> **IDENTIFIER\_EXISTS**: `"api-011"`
+
+Defined in: [src/ApiErrors.ts:9](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L9)
+
+***
+
+### INTERNAL\_ERROR
+
+> **INTERNAL\_ERROR**: `"api-002"`
+
+Defined in: [src/ApiErrors.ts:6](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L6)
+
+***
+
+### INVALID\_OBJECT\_VERSION
+
+> **INVALID\_OBJECT\_VERSION**: `"api-012"`
+
+Defined in: [src/ApiErrors.ts:10](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L10)
+
+***
+
+### INVALID\_REQUEST
+
+> **INVALID\_REQUEST**: `"api-003"`
+
+Defined in: [src/ApiErrors.ts:7](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L7)
+
+***
+
+### NOT\_FOUND
+
+> **NOT\_FOUND**: `"api-010"`
+
+Defined in: [src/ApiErrors.ts:8](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L8)
+
+***
+
+### OBJECT\_ID\_MISMATCH
+
+> **OBJECT\_ID\_MISMATCH**: `"api-013"`
+
+Defined in: [src/ApiErrors.ts:11](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L11)
+
+***
+
+### SEARCH\_INVALID\_ME\_REFERENCE
+
+> **SEARCH\_INVALID\_ME\_REFERENCE**: `"api-015"`
+
+Defined in: [src/ApiErrors.ts:13](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L13)
+
+***
+
+### SEARCH\_INVALID\_RANGE
+
+> **SEARCH\_INVALID\_RANGE**: `"api-014"`
+
+Defined in: [src/ApiErrors.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L12)
+
+***
+
+### UNKNOWN
+
+> **UNKNOWN**: `"api-001"`
+
+Defined in: [src/ApiErrors.ts:5](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ApiErrors.ts#L5)

package/docs/reference/functions/isSqlDataSource.md

@@ -0,0 +1,26 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / isSqlDataSource
+
+# Function: isSqlDataSource()
+
+> **isSqlDataSource**(`conn`): `boolean`
+
+Defined in: [src/database/ConnectionKinds.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/database/ConnectionKinds.ts#L12)
+
+Determines whether the given connection object is a TypeORM `DataSource` for a SQL database. This check is
+performed without importing the optional `typeorm` package by duck-typing the connection object.
+
+## Parameters
+
+### conn
+
+`any`
+
+The connection object to inspect.
+
+## Returns
+
+`boolean`

package/docs/reference/functions/resolveCollectionName.md

@@ -0,0 +1,33 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / resolveCollectionName
+
+# Function: resolveCollectionName()
+
+> **resolveCollectionName**(`clazz`): `string`
+
+Defined in: [src/database/NamingUtils.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/database/NamingUtils.ts#L38)
+
+Resolves the name of the database collection (or table) that records of the given model class are stored in.
+
+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.
+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, the snake_case form of the class name.
+
+## Parameters
+
+### clazz
+
+`any`
+
+The model class to resolve the collection name for.
+
+## Returns
+
+`string`

package/docs/reference/functions/snakeCase.md

@@ -0,0 +1,28 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / snakeCase
+
+# Function: snakeCase()
+
+> **snakeCase**(`str`): `string`
+
+Defined in: [src/database/NamingUtils.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/database/NamingUtils.ts#L14)
+
+Converts a string into snake_case.
+
+Note: This function is intentionally identical in behavior to TypeORM's `snakeCase` utility so that
+collection/table names derived from class names remain stable for existing deployments.
+
+## Parameters
+
+### str
+
+`string`
+
+The string to convert.
+
+## Returns
+
+`string`

package/docs/reference/globals.md

@@ -0,0 +1,91 @@
+[**@rapidrest/service-core**](README.md)
+
+***
+
+# @rapidrest/service-core
+
+## Namespaces
+
+- [DatabaseDecorators](@rapidrest/namespaces/DatabaseDecorators/README.md)
+- [DocDecorators](@rapidrest/namespaces/DocDecorators/README.md)
+- [EventDecorators](@rapidrest/namespaces/EventDecorators/README.md)
+- [ModelDecorators](@rapidrest/namespaces/ModelDecorators/README.md)
+- [PersistenceDecorators](@rapidrest/namespaces/PersistenceDecorators/README.md)
+- [RouteDecorators](@rapidrest/namespaces/RouteDecorators/README.md)
+
+## Enumerations
+
+- [ACLAction](enumerations/ACLAction.md)
+- [ApiErrorMessages](enumerations/ApiErrorMessages.md)
+- [ApiErrors](enumerations/ApiErrors.md)
+
+## Classes
+
+- [ACLUtils](classes/ACLUtils.md)
+- [AdminRoute](classes/AdminRoute.md)
+- [AuthMiddleware](classes/AuthMiddleware.md)
+- [BackgroundService](classes/BackgroundService.md)
+- [BackgroundServiceManager](classes/BackgroundServiceManager.md)
+- [BaseEntity](classes/BaseEntity.md)
+- [BaseMongoEntity](classes/BaseMongoEntity.md)
+- [BasicStrategy](classes/BasicStrategy.md)
+- [BasicStrategyOptions](classes/BasicStrategyOptions.md)
+- [BulkError](classes/BulkError.md)
+- [ConnectionManager](classes/ConnectionManager.md)
+- [EventListenerManager](classes/EventListenerManager.md)
+- [JWTStrategy](classes/JWTStrategy.md)
+- [JWTStrategyOptions](classes/JWTStrategyOptions.md)
+- [MetricsRoute](classes/MetricsRoute.md)
+- [ModelRoute](classes/ModelRoute.md)
+- [ModelUtils](classes/ModelUtils.md)
+- [MongoConnection](classes/MongoConnection.md)
+- [MongoRepository](classes/MongoRepository.md)
+- [MongoSchemaSync](classes/MongoSchemaSync.md)
+- [NetUtils](classes/NetUtils.md)
+- [NotificationUtils](classes/NotificationUtils.md)
+- [ObjectFactory](classes/ObjectFactory.md)
+- [OpenAPIRoute](classes/OpenAPIRoute.md)
+- [OpenApiSpec](classes/OpenApiSpec.md)
+- [RecoverableBaseEntity](classes/RecoverableBaseEntity.md)
+- [RecoverableBaseMongoEntity](classes/RecoverableBaseMongoEntity.md)
+- [RedisTransport](classes/RedisTransport.md)
+- [RepoUtils](classes/RepoUtils.md)
+- [RouteUtils](classes/RouteUtils.md)
+- [Server](classes/Server.md)
+- [SimpleEntity](classes/SimpleEntity.md)
+- [SimpleMongoEntity](classes/SimpleMongoEntity.md)
+- [StatusExtraData](classes/StatusExtraData.md)
+- [StatusRoute](classes/StatusRoute.md)
+
+## Interfaces
+
+- [AccessControlList](interfaces/AccessControlList.md)
+- [ACLRecord](interfaces/ACLRecord.md)
+- [AuthResult](interfaces/AuthResult.md)
+- [AuthStrategy](interfaces/AuthStrategy.md)
+- [CreateRequestOptions](interfaces/CreateRequestOptions.md)
+- [DeleteRequestOptions](interfaces/DeleteRequestOptions.md)
+- [FindRequestOptions](interfaces/FindRequestOptions.md)
+- [JWTAuthResult](interfaces/JWTAuthResult.md)
+- [RepoCreateOptions](interfaces/RepoCreateOptions.md)
+- [RepoDeleteOptions](interfaces/RepoDeleteOptions.md)
+- [RepoFindOptions](interfaces/RepoFindOptions.md)
+- [RepoOperationOptions](interfaces/RepoOperationOptions.md)
+- [RepoUpdateOptions](interfaces/RepoUpdateOptions.md)
+- [RequestOptions](interfaces/RequestOptions.md)
+- [TruncateRequestOptions](interfaces/TruncateRequestOptions.md)
+- [UpdateRequestOptions](interfaces/UpdateRequestOptions.md)
+
+## Type Aliases
+
+- [OneOrMany](type-aliases/OneOrMany.md)
+- [OneOrNull](type-aliases/OneOrNull.md)
+- [PartialBaseEntity](type-aliases/PartialBaseEntity.md)
+- [PartialSimpleEntity](type-aliases/PartialSimpleEntity.md)
+- [UpdateObject](type-aliases/UpdateObject.md)
+
+## Functions
+
+- [isSqlDataSource](functions/isSqlDataSource.md)
+- [resolveCollectionName](functions/resolveCollectionName.md)
+- [snakeCase](functions/snakeCase.md)

package/docs/reference/interfaces/ACLRecord.md

@@ -0,0 +1,96 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / ACLRecord
+
+# Interface: ACLRecord
+
+Defined in: [src/security/AccessControlList.ts:33](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L33)
+
+The `ACLRecord` interface describes a single permissions entry in an `AccessControlList` that grants or denies
+a set of permissions to a single user or role.
+
+Each permission can be one of the following actions:
+- `Create` - The user or role can create a new record or object.
+- `Read` - The user or role can read the record or object.
+- `Update` - The user or role can modify existing records or objects.
+- `Delete` - The user or role can delete existing records or objects.
+- `Special` - The user or role has special prilieges to edit the ACL permissions.
+- `Full` - The user or role has total control over the record or object and supersedes any of the above.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Properties
+
+### create
+
+> **create**: `boolean` \| `null`
+
+Defined in: [src/security/AccessControlList.ts:42](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L42)
+
+Indicates that the user or role has permission to create new records of the entity.
+
+***
+
+### delete
+
+> **delete**: `boolean` \| `null`
+
+Defined in: [src/security/AccessControlList.ts:57](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L57)
+
+Indicates that the user or role has permission to delete existing records of the entity.
+
+***
+
+### full
+
+> **full**: `boolean` \| `null`
+
+Defined in: [src/security/AccessControlList.ts:69](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L69)
+
+Indicates that the user or role has total control over records of the entity. This supersedes all of the above
+permissions.
+
+***
+
+### read
+
+> **read**: `boolean` \| `null`
+
+Defined in: [src/security/AccessControlList.ts:47](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L47)
+
+Indicates that the user or role has permission to read records of the entity.
+
+***
+
+### special
+
+> **special**: `boolean` \| `null`
+
+Defined in: [src/security/AccessControlList.ts:63](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L63)
+
+Indicates that the user or role has special permission over records of the entity. The exact meaning of this
+may vary by service.
+
+***
+
+### update
+
+> **update**: `boolean` \| `null`
+
+Defined in: [src/security/AccessControlList.ts:52](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L52)
+
+Indicates that the user or role has permission to modify existing records of the entity.
+
+***
+
+### userOrRoleId
+
+> **userOrRoleId**: `string`
+
+Defined in: [src/security/AccessControlList.ts:37](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L37)
+
+The unique identifier of the user or role that the record belongs to.

package/docs/reference/interfaces/AccessControlList.md

@@ -0,0 +1,76 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / AccessControlList
+
+# Interface: AccessControlList
+
+Defined in: [src/security/AccessControlList.ts:97](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L97)
+
+The access control list provides a generic interface for the storage of user and roles permissions. Each ACL object
+represents the permission set for a single entity within the system. The entity is identified generically by its
+universally unique identifier (`uuid`). Each entry in the ACL records the permissions available to a particular user
+or role.
+
+Each permission can be one of the following actions:
+- `Create` - The user or role can create a new record or object.
+- `Read` - The user or role can read the record or object.
+- `Update` - The user or role can modify existing records or objects.
+- `Delete` - The user or role can delete existing records or objects.
+- `Special` - The user or role has special prilieges to edit the ACL permissions.
+- `Full` - The user or role has total control over the record or object and supersedes any of the above.
+
+For each of the above actions the user or role will be granted either an `allow` permission or a `deny` permission.
+If an `allow` is granted, the user or role has permission to perform that action. If a `deny` is set, then the user
+or role is denied that action. If no explicit `allow` or `deny` is set then the user or role will inherit the
+permission from a parent role or ACL.
+
+ACLs can be chained via single inheritance through the specification of the `parentUid`. This allows the ability to
+create complex trees of permissions that can easily inherit control schemes to make the definition of permissions
+easier.
+
+## Author
+
+Jean-Philippe Steinmetz <rapidrests@gmail.com>
+
+## Properties
+
+### parent?
+
+> `optional` **parent?**: `AccessControlList` \| `null`
+
+Defined in: [src/security/AccessControlList.ts:106](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L106)
+
+The parent access control list that this instance inherits permissions from.
+
+***
+
+### parentUid?
+
+> `optional` **parentUid?**: `string`
+
+Defined in: [src/security/AccessControlList.ts:112](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L112)
+
+The universally unique identifier of the parent `AccessControlList` that this object will inherit permissions
+from.
+
+***
+
+### records
+
+> **records**: [`ACLRecord`](ACLRecord.md)[]
+
+Defined in: [src/security/AccessControlList.ts:117](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L117)
+
+The list of all permission records associated with this access control list.
+
+***
+
+### uid
+
+> **uid**: `string`
+
+Defined in: [src/security/AccessControlList.ts:101](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/security/AccessControlList.ts#L101)
+
+The universally unique identifier (`uuid`) of the entity that the access control list belongs to.

package/docs/reference/interfaces/AuthResult.md

@@ -0,0 +1,55 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / AuthResult
+
+# Interface: AuthResult
+
+Defined in: [src/auth/AuthStrategy.ts:10](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L10)
+
+Result returned by `AuthStrategy.authenticate()`.
+
+## Extended by
+
+- [`JWTAuthResult`](JWTAuthResult.md)
+
+## Properties
+
+### data?
+
+> `optional` **data?**: `string`
+
+Defined in: [src/auth/AuthStrategy.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L12)
+
+The raw auth data that was verified.
+
+***
+
+### method
+
+> **method**: `string`
+
+Defined in: [src/auth/AuthStrategy.ts:14](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L14)
+
+The name of the auth strategy that produced this result.
+
+***
+
+### payload?
+
+> `optional` **payload?**: `any`
+
+Defined in: [src/auth/AuthStrategy.ts:16](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L16)
+
+The fully decoded payload from the auth data.
+
+***
+
+### user?
+
+> `optional` **user?**: `JWTUser`
+
+Defined in: [src/auth/AuthStrategy.ts:18](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L18)
+
+The authenticated user profile, or `undefined` if authentication failed.