npm - @rapidrest/service-core - Versions diffs - 1.0.0-rc.2 → 1.0.0-rc.21 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (250) hide show

package/docs/reference/interfaces/FindRequestOptions.md DELETED Viewed

@@ -1,133 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / FindRequestOptions
-# Interface: FindRequestOptions
-Defined in: [src/routes/ModelRoute.ts:60](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L60)
-The set of options required by search request handlers.
-## Extends
-- [`RequestOptions`](RequestOptions.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)
-***
-### params?
-> `optional` **params?**: `any`
-Defined in: [src/routes/ModelRoute.ts:62](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L62)
-The list of URL parameters to use in the search.
-***
-### pushChannels?
-> `optional` **pushChannels?**: `string`[]
-Defined in: [src/models/RepoUtils.ts:35](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L35)
-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:64](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/routes/ModelRoute.ts#L64)
-The list of query parameters to use in the search.
-***
-### 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/models/RepoUtils.ts:39](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L39)
-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: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/HttpRequest.md DELETED Viewed

@@ -1,147 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / HttpRequest
-# Interface: HttpRequest
-Defined in: [src/http/types.ts:10](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L10)
-Framework-agnostic HTTP request interface. Mirrors the Express `Request` surface used throughout
-this codebase so that route handlers, middleware, and utilities require no changes when the
-underlying HTTP server changes.
-## Extended by
-- [`RequestWS`](RequestWS.md)
-## Indexable
-> \[`key`: `string`\]: `any`
-Allow arbitrary per-request properties (e.g. req.websocket, req.wsHandled).
-## Properties
-### authPayload?
-> `optional` **authPayload?**: `any`
-Defined in: [src/http/types.ts:26](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L26)
-Full decoded JWT payload, set by JWT auth middleware.
-***
-### authToken?
-> `optional` **authToken?**: `string`
-Defined in: [src/http/types.ts:28](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L28)
-Raw JWT token string, set by JWT auth middleware.
-***
-### body
-> **body**: `any`
-Defined in: [src/http/types.ts:17](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L17)
-***
-### cookies
-> **cookies**: `Record`\<`string`, `string`\>
-Defined in: [src/http/types.ts:19](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L19)
-***
-### headers
-> **headers**: `Record`\<`string`, `string` \| `string`[] \| `undefined`\>
-Defined in: [src/http/types.ts:14](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L14)
-***
-### method
-> **method**: `string`
-Defined in: [src/http/types.ts:11](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L11)
-***
-### params
-> **params**: `Record`\<`string`, `string`\>
-Defined in: [src/http/types.ts:15](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L15)
-***
-### path
-> **path**: `string`
-Defined in: [src/http/types.ts:12](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L12)
-***
-### query
-> **query**: `Record`\<`string`, `string` \| `string`[]\>
-Defined in: [src/http/types.ts:16](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L16)
-***
-### rawBody?
-> `optional` **rawBody?**: `Buffer`\<`ArrayBufferLike`\>
-Defined in: [src/http/types.ts:18](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L18)
-***
-### signedCookies
-> **signedCookies**: `Record`\<`string`, `string`\>
-Defined in: [src/http/types.ts:20](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L20)
-***
-### socket
-> **socket**: `object`
-Defined in: [src/http/types.ts:22](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L22)
-Minimal socket interface; populated with remote address for IP extraction.
-#### remoteAddress?
-> `optional` **remoteAddress?**: `string`
-***
-### url
-> **url**: `string`
-Defined in: [src/http/types.ts:13](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L13)
-***
-### user?
-> `optional` **user?**: `any`
-Defined in: [src/http/types.ts:24](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L24)
-Set by JWT auth middleware after successful token verification.

package/docs/reference/interfaces/HttpResponse.md DELETED Viewed

@@ -1,164 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / HttpResponse
-# Interface: HttpResponse
-Defined in: [src/http/types.ts:37](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L37)
-Framework-agnostic HTTP response interface. Mirrors the Express `Response` surface used
-throughout this codebase.
-## Indexable
-> \[`key`: `string`\]: `any`
-Allow arbitrary per-response properties.
-## Properties
-### headersSent
-> **headersSent**: `boolean`
-Defined in: [src/http/types.ts:39](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L39)
-***
-### result?
-> `optional` **result?**: `any`
-Defined in: [src/http/types.ts:42](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L42)
-Intermediate result passed between middleware via res.result.
-***
-### statusCode
-> **statusCode**: `number`
-Defined in: [src/http/types.ts:38](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L38)
-***
-### writableEnded
-> **writableEnded**: `boolean`
-Defined in: [src/http/types.ts:40](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L40)
-## Methods
-### end()
-> **end**(`data?`): `void`
-Defined in: [src/http/types.ts:48](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L48)
-#### Parameters
-##### data?
-`any`
-#### Returns
-`void`
-***
-### getHeader()
-> **getHeader**(`key`): `string` \| `undefined`
-Defined in: [src/http/types.ts:45](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L45)
-#### Parameters
-##### key
-`string`
-#### Returns
-`string` \| `undefined`
-***
-### json()
-> **json**(`data`): `void`
-Defined in: [src/http/types.ts:46](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L46)
-#### Parameters
-##### data
-`any`
-#### Returns
-`void`
-***
-### send()
-> **send**(`data?`): `void`
-Defined in: [src/http/types.ts:47](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L47)
-#### Parameters
-##### data?
-`any`
-#### Returns
-`void`
-***
-### setHeader()
-> **setHeader**(`key`, `value`): `this`
-Defined in: [src/http/types.ts:44](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L44)
-#### Parameters
-##### key
-`string`
-##### value
-`string` \| `number`
-#### Returns
-`this`
-***
-### status()
-> **status**(`code`): `this`
-Defined in: [src/http/types.ts:43](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/http/types.ts#L43)
-#### Parameters
-##### code
-`number`
-#### Returns
-`this`

package/docs/reference/interfaces/JWTAuthResult.md DELETED Viewed

@@ -1,84 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / JWTAuthResult
-# Interface: JWTAuthResult
-Defined in: [src/auth/JWTStrategy.ts:41](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/JWTStrategy.ts#L41)
-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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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/33d3655fa6883713f33f0fe6f330eb205671fea1/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:48](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/auth/JWTStrategy.ts#L48)
-`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/33d3655fa6883713f33f0fe6f330eb205671fea1/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 DELETED Viewed

@@ -1,95 +0,0 @@
-[**@rapidrest/service-core**](../README.md)
-***
-[@rapidrest/service-core](../globals.md) / RepoCreateOptions
-# Interface: RepoCreateOptions
-Defined in: [src/models/RepoUtils.ts:47](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L47)
-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:49](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L49)
-The AccessControlList to use when creating a new object.
-***
-### 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
-[`RepoOperationOptions`](RepoOperationOptions.md).[`ignoreACL`](RepoOperationOptions.md#ignoreacl)
-***
-### pushChannels?
-> `optional` **pushChannels?**: `string`[]
-Defined in: [src/models/RepoUtils.ts:35](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L35)
-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: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
-[`RepoOperationOptions`](RepoOperationOptions.md).[`recordEvent`](RepoOperationOptions.md#recordevent)
-***
-### skipPush?
-> `optional` **skipPush?**: `boolean`
-Defined in: [src/models/RepoUtils.ts:39](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L39)
-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:41](https://github.com/rapidrest/service-core/blob/33d3655fa6883713f33f0fe6f330eb205671fea1/src/models/RepoUtils.ts#L41)
-The authenticated user making the request.
-#### Inherited from
-[`RepoOperationOptions`](RepoOperationOptions.md).[`user`](RepoOperationOptions.md#user)