@rapidrest/service-core 1.0.0-beta.1

package/docs/reference/interfaces/AuthStrategy.md

@@ -0,0 +1,57 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/AuthStrategy.ts#L26)
+
+The unique name of the strategy used to register with the `AuthMiddleware`.
+
+## Methods
+
+### authenticate()
+
+> **authenticate**(`req`, `res?`, `required?`): [`AuthResult`](AuthResult.md) \| `Promise`\<[`AuthResult`](AuthResult.md)\> \| `undefined`
+
+Defined in: [src/auth/AuthStrategy.ts:37](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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`
+
+The request containing data to attempt authentication with.
+
+##### res?
+
+`HttpResponse`
+
+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) \| `Promise`\<[`AuthResult`](AuthResult.md)\> \| `undefined`

package/docs/reference/interfaces/CreateRequestOptions.md

@@ -0,0 +1,121 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L36)
+
+***
+
+### ignoreACL?
+
+> `optional` **ignoreACL?**: `boolean`
+
+Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L32)
+
+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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L36)
+
+Indicates if a telemetry event should be broadcast for the request.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`recordEvent`](RequestOptions.md#recordevent)
+
+***
+
+### req?
+
+> `optional` **req?**: `HttpRequest`
+
+Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L27)
+
+The originating client request.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`req`](RequestOptions.md#req)
+
+***
+
+### res?
+
+> `optional` **res?**: `HttpResponse`
+
+Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+
+The authenticated user making the request.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`user`](RequestOptions.md#user)

package/docs/reference/interfaces/DeleteRequestOptions.md

@@ -0,0 +1,147 @@
+[**@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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L32)
+
+Set to `true` to ignore the ACL permissions check.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`ignoreACL`](RequestOptions.md#ignoreacl)
+
+***
+
+### productUid?
+
+> `optional` **productUid?**: `string`
+
+Defined in: [src/routes/ModelRoute.ts:48](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L48)
+
+The desired product uid of the resource to delete.
+
+***
+
+### purge?
+
+> `optional` **purge?**: `boolean`
+
+Defined in: [src/routes/ModelRoute.ts:50](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L50)
+
+Set to true to permanently remove the object from the database (if applicable).
+
+***
+
+### pushChannels?
+
+> `optional` **pushChannels?**: `string`[]
+
+Defined in: [src/routes/ModelRoute.ts:52](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L52)
+
+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:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L36)
+
+Indicates if a telemetry event should be broadcast for the request.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`recordEvent`](RequestOptions.md#recordevent)
+
+***
+
+### req?
+
+> `optional` **req?**: `HttpRequest`
+
+Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L27)
+
+The originating client request.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`req`](RequestOptions.md#req)
+
+***
+
+### res?
+
+> `optional` **res?**: `HttpResponse`
+
+Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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:54](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L54)
+
+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:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+
+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:56](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L56)
+
+The desired version number of the resource to delete.

package/docs/reference/interfaces/FindRequestOptions.md

@@ -0,0 +1,133 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / FindRequestOptions
+
+# Interface: FindRequestOptions
+
+Defined in: [src/routes/ModelRoute.ts:62](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L62)
+
+The set of options required by search request handlers.
+
+## Extends
+
+- [`RequestOptions`](RequestOptions.md)
+
+## Properties
+
+### ignoreACL?
+
+> `optional` **ignoreACL?**: `boolean`
+
+Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L32)
+
+Set to `true` to ignore the ACL permissions check.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`ignoreACL`](RequestOptions.md#ignoreacl)
+
+***
+
+### params?
+
+> `optional` **params?**: `any`
+
+Defined in: [src/routes/ModelRoute.ts:64](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L64)
+
+The list of URL parameters to use in the search.
+
+***
+
+### pushChannels?
+
+> `optional` **pushChannels?**: `string`[]
+
+Defined in: [src/models/RepoUtils.ts:34](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L34)
+
+An additional list of channel names to send push notifications to.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`pushChannels`](RequestOptions.md#pushchannels)
+
+***
+
+### query
+
+> **query**: `any`
+
+Defined in: [src/routes/ModelRoute.ts:66](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L66)
+
+The list of query parameters to use in the search.
+
+***
+
+### recordEvent?
+
+> `optional` **recordEvent?**: `boolean`
+
+Defined in: [src/models/RepoUtils.ts:36](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L36)
+
+Indicates if a telemetry event should be broadcast for the request.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`recordEvent`](RequestOptions.md#recordevent)
+
+***
+
+### req?
+
+> `optional` **req?**: `HttpRequest`
+
+Defined in: [src/routes/ModelRoute.ts:27](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/ModelRoute.ts#L27)
+
+The originating client request.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`req`](RequestOptions.md#req)
+
+***
+
+### res?
+
+> `optional` **res?**: `HttpResponse`
+
+Defined in: [src/routes/ModelRoute.ts:29](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/models/RepoUtils.ts:38](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L38)
+
+Set to `true` to not send a push notification.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`skipPush`](RequestOptions.md#skippush)
+
+***
+
+### user?
+
+> `optional` **user?**: `JWTUser`
+
+Defined in: [src/models/RepoUtils.ts:40](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+
+The authenticated user making the request.
+
+#### Inherited from
+
+[`RequestOptions`](RequestOptions.md).[`user`](RequestOptions.md#user)

package/docs/reference/interfaces/JWTAuthResult.md

@@ -0,0 +1,84 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / JWTAuthResult
+
+# Interface: JWTAuthResult
+
+Defined in: [src/auth/JWTStrategy.ts:42](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L42)
+
+Result returned by `JWTStrategy.authenticate()`.
+
+## Extends
+
+- [`AuthResult`](AuthResult.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.
+
+#### Inherited from
+
+[`AuthResult`](AuthResult.md).[`data`](AuthResult.md#data)
+
+***
+
+### 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.
+
+#### Inherited from
+
+[`AuthResult`](AuthResult.md).[`method`](AuthResult.md#method)
+
+***
+
+### 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.
+
+#### Inherited from
+
+[`AuthResult`](AuthResult.md).[`payload`](AuthResult.md#payload)
+
+***
+
+### tokenFound?
+
+> `optional` **tokenFound?**: `boolean`
+
+Defined in: [src/auth/JWTStrategy.ts:49](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/auth/JWTStrategy.ts#L49)
+
+`true` when at least one credential (header, query param, or cookie) was present in
+the request, even if it was ultimately invalid. Distinguishes "no token submitted" from
+"bad token submitted" — useful for deciding whether to reject early vs. fall through to
+an alternative auth path (e.g. WebSocket message-based LOGIN).
+
+***
+
+### 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.
+
+#### Inherited from
+
+[`AuthResult`](AuthResult.md).[`user`](AuthResult.md#user)

package/docs/reference/interfaces/RepoCreateOptions.md

@@ -0,0 +1,95 @@
+[**@rapidrest/service-core**](../README.md)
+
+***
+
+[@rapidrest/service-core](../globals.md) / RepoCreateOptions
+
+# Interface: RepoCreateOptions
+
+Defined in: [src/models/RepoUtils.ts:46](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L46)
+
+The available options for the `RepoUtils.create()` operation.
+
+## Extends
+
+- [`RepoOperationOptions`](RepoOperationOptions.md)
+
+## Properties
+
+### acl?
+
+> `optional` **acl?**: [`AccessControlList`](AccessControlList.md)
+
+Defined in: [src/models/RepoUtils.ts:48](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L48)
+
+The AccessControlList to use when creating a new object.
+
+***
+
+### ignoreACL?
+
+> `optional` **ignoreACL?**: `boolean`
+
+Defined in: [src/models/RepoUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/models/RepoUtils.ts#L40)
+
+The authenticated user making the request.
+
+#### Inherited from
+
+[`RepoOperationOptions`](RepoOperationOptions.md).[`user`](RepoOperationOptions.md#user)