@rapidrest/service-core 1.0.0-rc.7 → 1.0.0

package/docs/reference/interfaces/RepoDeleteOptions.md

@@ -1,105 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / RepoDeleteOptions
-
-# Interface: RepoDeleteOptions
-
-Defined in: [src/models/RepoUtils.ts:54](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L54)
-
-The available options for the `RepoUtils.delete()` operation.
-
-## Extends
-
-- [`RepoOperationOptions`](RepoOperationOptions.md)
-
-## Properties
-
-### ignoreACL?
-
-> `optional` **ignoreACL?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L32)
-
-Set to `true` to ignore the ACL permissions check.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`ignoreACL`](RepoOperationOptions.md#ignoreacl)
-
-***
-
-### purge?
-
-> `optional` **purge?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:56](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L56)
-
-Set to true to permanently remove the object from the database (if applicable).
-
-***
-
-### pushChannels?
-
-> `optional` **pushChannels?**: `string`[]
-
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L34)
-
-An additional list of channel names to send push notifications to.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`pushChannels`](RepoOperationOptions.md#pushchannels)
-
-***
-
-### recordEvent?
-
-> `optional` **recordEvent?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L36)
-
-Indicates if a telemetry event should be broadcast for the request.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`recordEvent`](RepoOperationOptions.md#recordevent)
-
-***
-
-### skipPush?
-
-> `optional` **skipPush?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L38)
-
-Set to `true` to not send a push notification.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`skipPush`](RepoOperationOptions.md#skippush)
-
-***
-
-### user?
-
-> `optional` **user?**: `JWTUser`
-
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L40)
-
-The authenticated user making the request.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`user`](RepoOperationOptions.md#user)
-
-***
-
-### version?
-
-> `optional` **version?**: `string` \| `number`
-
-Defined in: [src/models/RepoUtils.ts:58](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L58)
-
-The desired version number of the resource to delete.

package/docs/reference/interfaces/RepoFindOptions.md

@@ -1,125 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / RepoFindOptions
-
-# Interface: RepoFindOptions
-
-Defined in: [src/models/RepoUtils.ts:61](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L61)
-
-The available options used for `RepoUtils` operations.
-
-## Extends
-
-- [`RepoOperationOptions`](RepoOperationOptions.md)
-
-## Properties
-
-### ignoreACL?
-
-> `optional` **ignoreACL?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L32)
-
-Set to `true` to ignore the ACL permissions check.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`ignoreACL`](RepoOperationOptions.md#ignoreacl)
-
-***
-
-### limit?
-
-> `optional` **limit?**: `number`
-
-Defined in: [src/models/RepoUtils.ts:63](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L63)
-
-The total number of resources to retrieve.
-
-***
-
-### page?
-
-> `optional` **page?**: `number`
-
-Defined in: [src/models/RepoUtils.ts:65](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L65)
-
-The page number of the paginated results to retrieve.
-
-***
-
-### pushChannels?
-
-> `optional` **pushChannels?**: `string`[]
-
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L34)
-
-An additional list of channel names to send push notifications to.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`pushChannels`](RepoOperationOptions.md#pushchannels)
-
-***
-
-### recordEvent?
-
-> `optional` **recordEvent?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L36)
-
-Indicates if a telemetry event should be broadcast for the request.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`recordEvent`](RepoOperationOptions.md#recordevent)
-
-***
-
-### skipCache?
-
-> `optional` **skipCache?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:67](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L67)
-
-Set to `true` to skip retrieval from the cache. Default is `false`.
-
-***
-
-### skipPush?
-
-> `optional` **skipPush?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L38)
-
-Set to `true` to not send a push notification.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`skipPush`](RepoOperationOptions.md#skippush)
-
-***
-
-### user?
-
-> `optional` **user?**: `JWTUser`
-
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L40)
-
-The authenticated user making the request.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`user`](RepoOperationOptions.md#user)
-
-***
-
-### version?
-
-> `optional` **version?**: `string` \| `number`
-
-Defined in: [src/models/RepoUtils.ts:69](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L69)
-
-The desired version number of the resources to retrieve.

package/docs/reference/interfaces/RepoOperationOptions.md

@@ -1,69 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / RepoOperationOptions
-
-# Interface: RepoOperationOptions
-
-Defined in: [src/models/RepoUtils.ts:30](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L30)
-
-The available options used for `RepoUtils` operations.
-
-## Extended by
-
-- [`RepoCreateOptions`](RepoCreateOptions.md)
-- [`RepoDeleteOptions`](RepoDeleteOptions.md)
-- [`RepoFindOptions`](RepoFindOptions.md)
-- [`RepoUpdateOptions`](RepoUpdateOptions.md)
-- [`RequestOptions`](RequestOptions.md)
-
-## Properties
-
-### ignoreACL?
-
-> `optional` **ignoreACL?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L32)
-
-Set to `true` to ignore the ACL permissions check.
-
-***
-
-### pushChannels?
-
-> `optional` **pushChannels?**: `string`[]
-
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L34)
-
-An additional list of channel names to send push notifications to.
-
-***
-
-### recordEvent?
-
-> `optional` **recordEvent?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L36)
-
-Indicates if a telemetry event should be broadcast for the request.
-
-***
-
-### skipPush?
-
-> `optional` **skipPush?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L38)
-
-Set to `true` to not send a push notification.
-
-***
-
-### user?
-
-> `optional` **user?**: `JWTUser`
-
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L40)
-
-The authenticated user making the request.

package/docs/reference/interfaces/RepoUpdateOptions.md

@@ -1,101 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / RepoUpdateOptions
-
-# Interface: RepoUpdateOptions\<T\>
-
-Defined in: [src/models/RepoUtils.ts:75](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L75)
-
-The available options for the `RepoUtils.update()` operation.
-
-## Extends
-
-- [`RepoOperationOptions`](RepoOperationOptions.md)
-
-## Type Parameters
-
-### T
-
-`T` *extends* [`BaseEntity`](../classes/BaseEntity.md) \| [`SimpleEntity`](../classes/SimpleEntity.md)
-
-## Properties
-
-### ignoreACL?
-
-> `optional` **ignoreACL?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L32)
-
-Set to `true` to ignore the ACL permissions check.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`ignoreACL`](RepoOperationOptions.md#ignoreacl)
-
-***
-
-### pushChannels?
-
-> `optional` **pushChannels?**: `string`[]
-
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L34)
-
-An additional list of channel names to send push notifications to.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`pushChannels`](RepoOperationOptions.md#pushchannels)
-
-***
-
-### recordEvent?
-
-> `optional` **recordEvent?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L36)
-
-Indicates if a telemetry event should be broadcast for the request.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`recordEvent`](RepoOperationOptions.md#recordevent)
-
-***
-
-### skipPush?
-
-> `optional` **skipPush?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L38)
-
-Set to `true` to not send a push notification.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`skipPush`](RepoOperationOptions.md#skippush)
-
-***
-
-### user?
-
-> `optional` **user?**: `JWTUser`
-
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L40)
-
-The authenticated user making the request.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`user`](RepoOperationOptions.md#user)
-
-***
-
-### version?
-
-> `optional` **version?**: `string` \| `number`
-
-Defined in: [src/models/RepoUtils.ts:77](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L77)
-
-The desired version number of the resource to update.

package/docs/reference/interfaces/RequestOptions.md

@@ -1,112 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-
-***
-
-[@rapidrest/service-core](../globals.md) / RequestOptions
-
-# Interface: RequestOptions
-
-Defined in: [src/routes/ModelRoute.ts:25](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L25)
-
-The set of options required by all request handlers.
-
-## Extends
-
-- [`RepoOperationOptions`](RepoOperationOptions.md)
-
-## Extended by
-
-- [`CreateRequestOptions`](CreateRequestOptions.md)
-- [`DeleteRequestOptions`](DeleteRequestOptions.md)
-- [`FindRequestOptions`](FindRequestOptions.md)
-- [`UpdateRequestOptions`](UpdateRequestOptions.md)
-
-## Properties
-
-### ignoreACL?
-
-> `optional` **ignoreACL?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L32)
-
-Set to `true` to ignore the ACL permissions check.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`ignoreACL`](RepoOperationOptions.md#ignoreacl)
-
-***
-
-### pushChannels?
-
-> `optional` **pushChannels?**: `string`[]
-
-Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L34)
-
-An additional list of channel names to send push notifications to.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`pushChannels`](RepoOperationOptions.md#pushchannels)
-
-***
-
-### recordEvent?
-
-> `optional` **recordEvent?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L36)
-
-Indicates if a telemetry event should be broadcast for the request.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`recordEvent`](RepoOperationOptions.md#recordevent)
-
-***
-
-### req?
-
-> `optional` **req?**: [`HttpRequest`](HttpRequest.md)
-
-Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L27)
-
-The originating client request.
-
-***
-
-### res?
-
-> `optional` **res?**: [`HttpResponse`](HttpResponse.md)
-
-Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/routes/ModelRoute.ts#L29)
-
-The outgoing client response.
-
-***
-
-### skipPush?
-
-> `optional` **skipPush?**: `boolean`
-
-Defined in: [src/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L38)
-
-Set to `true` to not send a push notification.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`skipPush`](RepoOperationOptions.md#skippush)
-
-***
-
-### user?
-
-> `optional` **user?**: `JWTUser`
-
-Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/0879470e308cd5828ebcf6efdbdba1cd0178007b/src/models/RepoUtils.ts#L40)
-
-The authenticated user making the request.
-
-#### Inherited from
-
-[`RepoOperationOptions`](RepoOperationOptions.md).[`user`](RepoOperationOptions.md#user)