@3sixty/api-models 0.20.0-next.0 → 0.20.0-next.1

package/docs/reference/index.md

@@ -8,7 +8,6 @@
 - [HttpHeaderHelper](classes/HttpHeaderHelper.md)
 - [HttpParameterHelper](classes/HttpParameterHelper.md)
 - [HttpUrlHelper](classes/HttpUrlHelper.md)
-- [ScopeHelper](classes/ScopeHelper.md)
 
 ## Interfaces
 
@@ -54,6 +53,7 @@
 - [IRestRouteResponseAttachmentOptions](interfaces/IRestRouteResponseAttachmentOptions.md)
 - [IRestRouteResponseExample](interfaces/IRestRouteResponseExample.md)
 - [IRestRouteResponseOptions](interfaces/IRestRouteResponseOptions.md)
+- [IRouteAuthorization](interfaces/IRouteAuthorization.md)
 - [ISocketRoute](interfaces/ISocketRoute.md)
 - [ITag](interfaces/ITag.md)
 - [IBaseRouteProcessor](interfaces/IBaseRouteProcessor.md)
@@ -79,6 +79,8 @@
 - [ISocketRouteEntryPoint](type-aliases/ISocketRouteEntryPoint.md)
 - [HttpBodyLimit](type-aliases/HttpBodyLimit.md)
 - [HealthApplicationCallback](type-aliases/HealthApplicationCallback.md)
+- [TenantEventCallback](type-aliases/TenantEventCallback.md)
+- [TenantEventType](type-aliases/TenantEventType.md)
 
 ## Variables
 
@@ -90,3 +92,4 @@
 - [HealthStatus](variables/HealthStatus.md)
 - [HttpContextIdKeys](variables/HttpContextIdKeys.md)
 - [HttpBodyLimit](variables/HttpBodyLimit.md)
+- [TenantEventType](variables/TenantEventType.md)

package/docs/reference/interfaces/IBaseRoute.md

@@ -31,6 +31,12 @@ The path to use for routing.
 
 Skips the authentication requirement for this route.
 
+#### Default
+
+```ts
+false
+```
+
 ***
 
 ### skipTenant? {#skiptenant}
@@ -39,13 +45,33 @@ Skips the authentication requirement for this route.
 
 Skips the tenant requirement for this route.
 
+#### Default
+
+```ts
+false
+```
+
 ***
 
-### requiredScope? {#requiredscope}
+### requiresAuthorization? {#requiresauthorization}
 
-> `optional` **requiredScope?**: `string`[]
+> `optional` **requiresAuthorization?**: `boolean`
 
-The user must have one of the specified scopes to access the route.
+Requires authorization for this route.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### defaultAuthorization? {#defaultauthorization}
+
+> `optional` **defaultAuthorization?**: [`IRouteAuthorization`](IRouteAuthorization.md)
+
+The default authorization which can access this route, used to seed the RBAC rules.
 
 ***
 
@@ -54,4 +80,10 @@ The user must have one of the specified scopes to access the route.
 > `optional` **disableTenantOverride?**: `boolean`
 
 Set to true to prevent callers from using the overrideTenant query parameter on this route.
-Tenant override is allowed by default, but you must hold the escalated privilege scope to use it.
+Tenant override is allowed by default, but you must hold the escalated privilege role to use it.
+
+#### Default
+
+```ts
+false
+```

package/docs/reference/interfaces/IBaseRouteEntryPoint.md

@@ -4,7 +4,7 @@ Route entry points are used for exposing the routes from a package.
 
 ## Type Parameters
 
-### T
+### T {#t}
 
 `T`
 

package/docs/reference/interfaces/IBaseRouteProcessor.md

@@ -13,32 +13,16 @@ The definition for a base processor for handling REST routes.
 
 ## Type Parameters
 
-### T
+### T {#t}
 
 `T` = [`IBaseRoute`](IBaseRoute.md)
 
-### R
+### R {#r}
 
 `R` = [`IHttpServerRequest`](IHttpServerRequest.md)
 
 ## Methods
 
-### features()? {#features}
-
-> `optional` **features**(): `string`[]
-
-Features supported by this processor.
-If a route has any of these features listed, this processor will be run for that route.
-If this is not implemented, the processor will run for all routes.
-
-#### Returns
-
-`string`[]
-
-The features supported by this processor.
-
-***
-
 ### pre()? {#pre}
 
 > `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
@@ -73,6 +57,8 @@ The context IDs of the request.
 
 ##### processorState
 
+\{\[`id`: `string`\]: `unknown`; \}
+
 The state handed through the processors.
 
 ##### componentTypes?
@@ -127,6 +113,8 @@ The context IDs of the request.
 
 ##### processorState
 
+\{\[`id`: `string`\]: `unknown`; \}
+
 The state handed through the processors.
 
 ##### componentTypes?

package/docs/reference/interfaces/IHttpRequest.md

@@ -9,7 +9,7 @@ Model for the standard parameters for an http request.
 
 ## Type Parameters
 
-### T
+### T {#t}
 
 `T` = `any`
 

package/docs/reference/interfaces/IHttpResponse.md

@@ -4,7 +4,7 @@ Model for the standard parameters for an http response.
 
 ## Type Parameters
 
-### T
+### T {#t}
 
 `T` = `any`
 

package/docs/reference/interfaces/IHttpServerRequest.md

@@ -12,7 +12,7 @@ Model for the standard parameters for an http request.
 
 ## Type Parameters
 
-### T
+### T {#t}
 
 `T` = `any`
 

package/docs/reference/interfaces/IPlatformComponent.md

@@ -63,3 +63,77 @@ The URL to check.
 `Promise`\<`IContextIds` \| `undefined`\>
 
 A promise that resolves to the context IDs if the URL is a local origin, undefined otherwise.
+
+***
+
+### registerTenantEventCallback() {#registertenanteventcallback}
+
+> **registerTenantEventCallback**(`callbackId`, `callback`): `void`
+
+Registers a callback to be invoked when a tenant event occurs.
+
+#### Parameters
+
+##### callbackId
+
+`string`
+
+A unique identifier for the callback.
+
+##### callback
+
+[`TenantEventCallback`](../type-aliases/TenantEventCallback.md)
+
+The callback to invoke when a tenant event occurs.
+
+#### Returns
+
+`void`
+
+***
+
+### unregisterTenantEventCallback() {#unregistertenanteventcallback}
+
+> **unregisterTenantEventCallback**(`callbackId`): `void`
+
+Unregisters a previously registered tenant event callback.
+
+#### Parameters
+
+##### callbackId
+
+`string`
+
+The identifier of the callback to unregister.
+
+#### Returns
+
+`void`
+
+***
+
+### fireTenantEvent() {#firetenantevent}
+
+> **fireTenantEvent**(`tenantId`, `eventType`): `Promise`\<`void`\>
+
+Fires all registered tenant event callbacks.
+
+#### Parameters
+
+##### tenantId
+
+`string`
+
+The ID of the tenant for which the event occurred.
+
+##### eventType
+
+[`TenantEventType`](../type-aliases/TenantEventType.md)
+
+The type of event that occurred.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when all callbacks have been invoked.

package/docs/reference/interfaces/IRestRoute.md

@@ -8,11 +8,11 @@ Interface which defines a REST route.
 
 ## Type Parameters
 
-### T
+### T {#t}
 
 `T` *extends* [`IHttpRequest`](IHttpRequest.md) = `any`
 
-### U
+### U {#u}
 
 `U` *extends* [`IHttpResponse`](IHttpResponse.md) & [`IRestRouteResponseOptions`](IRestRouteResponseOptions.md) = `any`
 
@@ -48,6 +48,12 @@ The path to use for routing.
 
 Skips the authentication requirement for this route.
 
+#### Default
+
+```ts
+false
+```
+
 #### Inherited from
 
 [`IBaseRoute`](IBaseRoute.md).[`skipAuth`](IBaseRoute.md#skipauth)
@@ -60,21 +66,45 @@ Skips the authentication requirement for this route.
 
 Skips the tenant requirement for this route.
 
+#### Default
+
+```ts
+false
+```
+
 #### Inherited from
 
 [`IBaseRoute`](IBaseRoute.md).[`skipTenant`](IBaseRoute.md#skiptenant)
 
 ***
 
-### requiredScope? {#requiredscope}
+### requiresAuthorization? {#requiresauthorization}
+
+> `optional` **requiresAuthorization?**: `boolean`
+
+Requires authorization for this route.
+
+#### Default
+
+```ts
+true
+```
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`requiresAuthorization`](IBaseRoute.md#requiresauthorization)
+
+***
+
+### defaultAuthorization? {#defaultauthorization}
 
-> `optional` **requiredScope?**: `string`[]
+> `optional` **defaultAuthorization?**: [`IRouteAuthorization`](IRouteAuthorization.md)
 
-The user must have one of the specified scopes to access the route.
+The default authorization which can access this route, used to seed the RBAC rules.
 
 #### Inherited from
 
-[`IBaseRoute`](IBaseRoute.md).[`requiredScope`](IBaseRoute.md#requiredscope)
+[`IBaseRoute`](IBaseRoute.md).[`defaultAuthorization`](IBaseRoute.md#defaultauthorization)
 
 ***
 
@@ -83,7 +113,13 @@ The user must have one of the specified scopes to access the route.
 > `optional` **disableTenantOverride?**: `boolean`
 
 Set to true to prevent callers from using the overrideTenant query parameter on this route.
-Tenant override is allowed by default, but you must hold the escalated privilege scope to use it.
+Tenant override is allowed by default, but you must hold the escalated privilege role to use it.
+
+#### Default
+
+```ts
+false
+```
 
 #### Inherited from
 

package/docs/reference/interfaces/IRestRouteProcessor.md

@@ -8,26 +8,6 @@ The definition for a processor for handling REST routes.
 
 ## Methods
 
-### features()? {#features}
-
-> `optional` **features**(): `string`[]
-
-Features supported by this processor.
-If a route has any of these features listed, this processor will be run for that route.
-If this is not implemented, the processor will run for all routes.
-
-#### Returns
-
-`string`[]
-
-The features supported by this processor.
-
-#### Inherited from
-
-[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`features`](IBaseRouteProcessor.md#features)
-
-***
-
 ### pre()? {#pre}
 
 > `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
@@ -62,6 +42,8 @@ The context IDs of the request.
 
 ##### processorState
 
+\{\[`id`: `string`\]: `unknown`; \}
+
 The state handed through the processors.
 
 ##### componentTypes?
@@ -120,6 +102,8 @@ The context IDs of the request.
 
 ##### processorState
 
+\{\[`id`: `string`\]: `unknown`; \}
+
 The state handed through the processors.
 
 ##### componentTypes?
@@ -172,6 +156,8 @@ The route being requested, if a matching one was found.
 
 ##### processorState
 
+\{\[`id`: `string`\]: `unknown`; \}
+
 The state handed through the processors.
 
 ##### componentTypes?

package/docs/reference/interfaces/IRestRouteRequestExample.md

@@ -8,7 +8,7 @@ Interface which defines a REST route request example.
 
 ## Type Parameters
 
-### T
+### T {#t}
 
 `T`
 

package/docs/reference/interfaces/IRestRouteResponseExample.md

@@ -8,7 +8,7 @@ Interface which defines a REST route response example.
 
 ## Type Parameters
 
-### T
+### T {#t}
 
 `T`
 

package/docs/reference/interfaces/IRouteAuthorization.md

@@ -0,0 +1,27 @@
+# Interface: IRouteAuthorization
+
+Interface which defines the default authorization permission for a route used to seed the RBAC rules.
+
+## Properties
+
+### permission {#permission}
+
+> **permission**: `string`
+
+The permission string for the route.
+
+***
+
+### role? {#role}
+
+> `optional` **role?**: `string`
+
+The optional role string for the route.
+
+***
+
+### inherits? {#inherits}
+
+> `optional` **inherits?**: `string`[]
+
+The optional array of inherited permissions for the route.

package/docs/reference/interfaces/ISocketRoute.md

@@ -8,11 +8,11 @@ Interface which defines a socket route.
 
 ## Type Parameters
 
-### T
+### T {#t}
 
 `T` *extends* [`IHttpRequest`](IHttpRequest.md) = `any`
 
-### U
+### U {#u}
 
 `U` *extends* [`IHttpResponse`](IHttpResponse.md) = `any`
 
@@ -48,6 +48,12 @@ The path to use for routing.
 
 Skips the authentication requirement for this route.
 
+#### Default
+
+```ts
+false
+```
+
 #### Inherited from
 
 [`IBaseRoute`](IBaseRoute.md).[`skipAuth`](IBaseRoute.md#skipauth)
@@ -60,21 +66,45 @@ Skips the authentication requirement for this route.
 
 Skips the tenant requirement for this route.
 
+#### Default
+
+```ts
+false
+```
+
 #### Inherited from
 
 [`IBaseRoute`](IBaseRoute.md).[`skipTenant`](IBaseRoute.md#skiptenant)
 
 ***
 
-### requiredScope? {#requiredscope}
+### requiresAuthorization? {#requiresauthorization}
+
+> `optional` **requiresAuthorization?**: `boolean`
+
+Requires authorization for this route.
+
+#### Default
+
+```ts
+true
+```
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`requiresAuthorization`](IBaseRoute.md#requiresauthorization)
+
+***
+
+### defaultAuthorization? {#defaultauthorization}
 
-> `optional` **requiredScope?**: `string`[]
+> `optional` **defaultAuthorization?**: [`IRouteAuthorization`](IRouteAuthorization.md)
 
-The user must have one of the specified scopes to access the route.
+The default authorization which can access this route, used to seed the RBAC rules.
 
 #### Inherited from
 
-[`IBaseRoute`](IBaseRoute.md).[`requiredScope`](IBaseRoute.md#requiredscope)
+[`IBaseRoute`](IBaseRoute.md).[`defaultAuthorization`](IBaseRoute.md#defaultauthorization)
 
 ***
 
@@ -83,7 +113,13 @@ The user must have one of the specified scopes to access the route.
 > `optional` **disableTenantOverride?**: `boolean`
 
 Set to true to prevent callers from using the overrideTenant query parameter on this route.
-Tenant override is allowed by default, but you must hold the escalated privilege scope to use it.
+Tenant override is allowed by default, but you must hold the escalated privilege role to use it.
+
+#### Default
+
+```ts
+false
+```
 
 #### Inherited from
 

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -8,26 +8,6 @@ The definition for a processor for handling socket routes.
 
 ## Methods
 
-### features()? {#features}
-
-> `optional` **features**(): `string`[]
-
-Features supported by this processor.
-If a route has any of these features listed, this processor will be run for that route.
-If this is not implemented, the processor will run for all routes.
-
-#### Returns
-
-`string`[]
-
-The features supported by this processor.
-
-#### Inherited from
-
-[`IBaseRouteProcessor`](IBaseRouteProcessor.md).[`features`](IBaseRouteProcessor.md#features)
-
-***
-
 ### pre()? {#pre}
 
 > `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
@@ -62,6 +42,8 @@ The context IDs of the request.
 
 ##### processorState
 
+\{\[`id`: `string`\]: `unknown`; \}
+
 The state handed through the processors.
 
 ##### componentTypes?
@@ -120,6 +102,8 @@ The context IDs of the request.
 
 ##### processorState
 
+\{\[`id`: `string`\]: `unknown`; \}
+
 The state handed through the processors.
 
 ##### componentTypes?
@@ -240,6 +224,8 @@ The route being requested, if a matching one was found.
 
 ##### processorState
 
+\{\[`id`: `string`\]: `unknown`; \}
+
 The state handed through the processors.
 
 ##### responseEmitter

package/docs/reference/interfaces/ISocketServerRequest.md

@@ -8,7 +8,7 @@ Model for the standard parameters for an http request.
 
 ## Type Parameters
 
-### T
+### T {#t}
 
 `T` = `any`
 

package/docs/reference/interfaces/ITenantAdminComponent.md

@@ -204,7 +204,7 @@ The conditions to filter the tenants.
 
 ##### properties?
 
-keyof [`ITenant`](ITenant.md)[]
+(keyof [`ITenant`](ITenant.md))[]
 
 The properties to include in the returned tenants.
 

package/docs/reference/interfaces/IWebServer.md

@@ -8,7 +8,7 @@ Interface describing a web server.
 
 ## Type Parameters
 
-### T
+### T {#t}
 
 `T`
 

package/docs/reference/type-aliases/TenantEventCallback.md

@@ -0,0 +1,20 @@
+# Type Alias: TenantEventCallback
+
+> **TenantEventCallback** = (`tenantId`, `eventType`) => `Promise`\<`void`\>
+
+Callback invoked when a tenant event occurs.
+Failures in the callback will be logged but will not prevent other callbacks from being invoked.
+
+## Parameters
+
+### tenantId
+
+`string`
+
+### eventType
+
+[`TenantEventType`](TenantEventType.md)
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/type-aliases/TenantEventType.md

@@ -0,0 +1,5 @@
+# Type Alias: TenantEventType
+
+> **TenantEventType** = *typeof* [`TenantEventType`](../variables/TenantEventType.md)\[keyof *typeof* [`TenantEventType`](../variables/TenantEventType.md)\]
+
+The type of event that occurred for a tenant.

package/docs/reference/variables/HttpContextIdKeys.md

@@ -42,12 +42,6 @@ Public Origin of the request.
 
 Local Origin of the request.
 
-### Scope {#scope}
-
-> `readonly` **Scope**: `"scope"` = `"scope"`
-
-The comma-separated scope claim from the verified JWT for the current request.
-
 ### OriginalTenant {#originaltenant}
 
 > `readonly` **OriginalTenant**: `"originalTenant"` = `"originalTenant"`

package/docs/reference/variables/TenantEventType.md

@@ -0,0 +1,25 @@
+# Variable: TenantEventType
+
+> `const` **TenantEventType**: `object`
+
+The type of event that occurred for a tenant.
+
+## Type Declaration
+
+### Created {#created}
+
+> `readonly` **Created**: `"created"` = `"created"`
+
+The tenant was created.
+
+### Updated {#updated}
+
+> `readonly` **Updated**: `"updated"` = `"updated"`
+
+The tenant was updated.
+
+### Deleted {#deleted}
+
+> `readonly` **Deleted**: `"deleted"` = `"deleted"`
+
+The tenant was deleted.