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

package/docs/reference/interfaces/ACLRecord.md

@@ -1,96 +0,0 @@
-[**@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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/src/security/AccessControlList.ts#L37)
-
-The unique identifier of the user or role that the record belongs to.

package/docs/reference/interfaces/AccessControlList.md

@@ -1,76 +0,0 @@
-[**@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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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

@@ -1,55 +0,0 @@
-[**@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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/AuthStrategy.ts#L18)
-
-The authenticated user profile, or `undefined` if authentication failed.

package/docs/reference/interfaces/AuthStrategy.md

@@ -1,95 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / AuthStrategy
-
-# Interface: AuthStrategy
-
-Defined in: [src/auth/AuthStrategy.ts:24](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/AuthStrategy.ts#L24)
-
-Describes an interface for implementing strategies that will perform authentication.
-
-## Properties
-
-### name
-
-> `readonly` **name**: `string`
-
-Defined in: [src/auth/AuthStrategy.ts:26](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/AuthStrategy.ts#L26)
-
-The unique name of the strategy used to register with the `AuthMiddleware`.
-
-## Methods
-
-### authenticate()
-
-> **authenticate**(`req`, `res?`, `required?`): `Promise`\<[`AuthResult`](AuthResult.md) \| `undefined`\>
-
-Defined in: [src/auth/AuthStrategy.ts:37](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/AuthStrategy.ts#L37)
-
-Attempts to perform authentication with the given request data. If authentication was successful, returns an
-`AuthResult` containing the authentication details. If authentication fails and `required` is set to `true`
-throws an error, otherwise returns `undefined`.
-
-#### Parameters
-
-##### req
-
-[`HttpRequest`](HttpRequest.md)
-
-The request containing data to attempt authentication with.
-
-##### res?
-
-[`HttpResponse`](HttpResponse.md)
-
-The response to use when writing back directly to the client.
-
-##### required?
-
-`boolean`
-
-Set to `true` to if authentication is required to pass, otherwise set to `false`.
-
-#### Returns
-
-`Promise`\<[`AuthResult`](AuthResult.md) \| `undefined`\>
-
-***
-
-### authenticateSync()
-
-> **authenticateSync**(`req`, `res?`, `required?`): [`AuthResult`](AuthResult.md) \| `undefined`
-
-Defined in: [src/auth/AuthStrategy.ts:50](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/AuthStrategy.ts#L50)
-
-Attempts to perform authentication with the given request data. If authentication was successful, returns an
-`AuthResult` containing the authentication details. If authentication fails and `required` is set to `true`
-throws an error, otherwise returns `undefined`.
-
-This is the synchronous version of `authenticate` that performs blocking based authentication.
-
-#### Parameters
-
-##### req
-
-[`HttpRequest`](HttpRequest.md)
-
-The request containing data to attempt authentication with.
-
-##### res?
-
-[`HttpResponse`](HttpResponse.md)
-
-The response to use when writing back directly to the client.
-
-##### required?
-
-`boolean`
-
-Set to `true` to if authentication is required to pass, otherwise set to `false`.
-
-#### Returns
-
-[`AuthResult`](AuthResult.md) \| `undefined`

package/docs/reference/interfaces/CreateRequestOptions.md

@@ -1,121 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / CreateRequestOptions
-
-# Interface: CreateRequestOptions
-
-Defined in: [src/routes/ModelRoute.ts:35](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L35)
-
-The set of options required by create request handlers.
-
-## Extends
-
-- [`RequestOptions`](RequestOptions.md)
-
-## Properties
-
-### acl?
-
-> `optional` **acl?**: [`AccessControlList`](AccessControlList.md) \| [`AccessControlList`](AccessControlList.md)[]
-
-Defined in: [src/routes/ModelRoute.ts:36](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L36)
-
-***
-
-### ignoreACL?
-
-> `optional` **ignoreACL?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L33)
-
-Set to `true` to ignore the ACL permissions check.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`ignoreACL`](RequestOptions.md#ignoreacl)
-
-***
-
-### pushChannels?
-
-> `optional` **pushChannels?**: `string`[]
-
-Defined in: [src/routes/ModelRoute.ts:38](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L38)
-
-An additional list of channel names to send push notifications to.
-
-#### Overrides
-
-[`RequestOptions`](RequestOptions.md).[`pushChannels`](RequestOptions.md#pushchannels)
-
-***
-
-### recordEvent?
-
-> `optional` **recordEvent?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L37)
-
-Indicates if a telemetry event should be broadcast for the request.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`recordEvent`](RequestOptions.md#recordevent)
-
-***
-
-### req?
-
-> `optional` **req?**: [`HttpRequest`](HttpRequest.md)
-
-Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L27)
-
-The originating client request.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`req`](RequestOptions.md#req)
-
-***
-
-### res?
-
-> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
-
-Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L29)
-
-The outgoing client response.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`res`](RequestOptions.md#res)
-
-***
-
-### skipPush?
-
-> `optional` **skipPush?**: `boolean`
-
-Defined in: [src/routes/ModelRoute.ts:40](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L40)
-
-Set to `true` to not send a push notification.
-
-#### Overrides
-
-[`RequestOptions`](RequestOptions.md).[`skipPush`](RequestOptions.md#skippush)
-
-***
-
-### user?
-
-> `optional` **user?**: `JWTUser`
-
-Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L41)
-
-The authenticated user making the request.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`user`](RequestOptions.md#user)

package/docs/reference/interfaces/DeleteRequestOptions.md

@@ -1,137 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / DeleteRequestOptions
-
-# Interface: DeleteRequestOptions
-
-Defined in: [src/routes/ModelRoute.ts:46](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L46)
-
-The set of options required by delete request handlers.
-
-## Extends
-
-- [`RequestOptions`](RequestOptions.md)
-
-## Extended by
-
-- [`TruncateRequestOptions`](TruncateRequestOptions.md)
-
-## Properties
-
-### ignoreACL?
-
-> `optional` **ignoreACL?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:33](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L33)
-
-Set to `true` to ignore the ACL permissions check.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`ignoreACL`](RequestOptions.md#ignoreacl)
-
-***
-
-### purge?
-
-> `optional` **purge?**: `boolean`
-
-Defined in: [src/routes/ModelRoute.ts:48](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L48)
-
-Set to true to permanently remove the object from the database (if applicable).
-
-***
-
-### pushChannels?
-
-> `optional` **pushChannels?**: `string`[]
-
-Defined in: [src/routes/ModelRoute.ts:50](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L50)
-
-An additional list of channel names to send push notifications to.
-
-#### Overrides
-
-[`RequestOptions`](RequestOptions.md).[`pushChannels`](RequestOptions.md#pushchannels)
-
-***
-
-### recordEvent?
-
-> `optional` **recordEvent?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:37](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L37)
-
-Indicates if a telemetry event should be broadcast for the request.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`recordEvent`](RequestOptions.md#recordevent)
-
-***
-
-### req?
-
-> `optional` **req?**: [`HttpRequest`](HttpRequest.md)
-
-Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L27)
-
-The originating client request.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`req`](RequestOptions.md#req)
-
-***
-
-### res?
-
-> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
-
-Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L29)
-
-The outgoing client response.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`res`](RequestOptions.md#res)
-
-***
-
-### skipPush?
-
-> `optional` **skipPush?**: `boolean`
-
-Defined in: [src/routes/ModelRoute.ts:52](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L52)
-
-Set to `true` to not send a push notification.
-
-#### Overrides
-
-[`RequestOptions`](RequestOptions.md).[`skipPush`](RequestOptions.md#skippush)
-
-***
-
-### user?
-
-> `optional` **user?**: `JWTUser`
-
-Defined in: [src/models/RepoUtils.ts:41](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L41)
-
-The authenticated user making the request.
-
-#### Inherited from
-
-[`RequestOptions`](RequestOptions.md).[`user`](RequestOptions.md#user)
-
-***
-
-### version?
-
-> `optional` **version?**: `string` \| `number`
-
-Defined in: [src/routes/ModelRoute.ts:54](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L54)
-
-The desired version number of the resource to delete.