@jmruthers/pace-core 0.6.2 → 0.6.3

package/docs/api/interfaces/RBACContext.md

@@ -1,52 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACContext
-
-# Interface: RBACContext
-
-## Table of contents
-
-### Properties
-
-- [user\_id](RBACContext.md#user_id)
-- [organisation\_id](RBACContext.md#organisation_id)
-- [event\_id](RBACContext.md#event_id)
-- [app\_id](RBACContext.md#app_id)
-
-## Properties
-
-### user\_id
-
-• **user\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:267](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L267)
-
-___
-
-### organisation\_id
-
-• `Optional` **organisation\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:268](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L268)
-
-___
-
-### event\_id
-
-• `Optional` **event\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:269](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L269)
-
-___
-
-### app\_id
-
-• `Optional` **app\_id**: `string` \| `AppId`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:270](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L270)

package/docs/api/interfaces/RBACLogger.md

@@ -1,112 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACLogger
-
-# Interface: RBACLogger
-
-## Table of contents
-
-### Properties
-
-- [error](RBACLogger.md#error)
-- [warn](RBACLogger.md#warn)
-- [info](RBACLogger.md#info)
-- [debug](RBACLogger.md#debug)
-
-## Properties
-
-### error
-
-• **error**: (`message`: `string`, ...`args`: `unknown`[]) => `void`
-
-#### Type declaration
-
-▸ (`message`, `...args`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `message` | `string` |
-| `...args` | `unknown`[] |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/config.ts:43](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/config.ts#L43)
-
-___
-
-### warn
-
-• **warn**: (`message`: `string`, ...`args`: `unknown`[]) => `void`
-
-#### Type declaration
-
-▸ (`message`, `...args`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `message` | `string` |
-| `...args` | `unknown`[] |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/config.ts:44](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/config.ts#L44)
-
-___
-
-### info
-
-• **info**: (`message`: `string`, ...`args`: `unknown`[]) => `void`
-
-#### Type declaration
-
-▸ (`message`, `...args`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `message` | `string` |
-| `...args` | `unknown`[] |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/config.ts:45](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/config.ts#L45)
-
-___
-
-### debug
-
-• **debug**: (`message`: `string`, ...`args`: `unknown`[]) => `void`
-
-#### Type declaration
-
-▸ (`message`, `...args`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `message` | `string` |
-| `...args` | `unknown`[] |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/config.ts:46](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/config.ts#L46)

package/docs/api/interfaces/RBACPageAccessCheckParams.md

@@ -1,74 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACPageAccessCheckParams
-
-# Interface: RBACPageAccessCheckParams
-
-## Table of contents
-
-### Properties
-
-- [p\_app\_id](RBACPageAccessCheckParams.md#p_app_id)
-- [p\_page\_id](RBACPageAccessCheckParams.md#p_page_id)
-- [p\_operation](RBACPageAccessCheckParams.md#p_operation)
-- [p\_user\_id](RBACPageAccessCheckParams.md#p_user_id)
-- [p\_event\_id](RBACPageAccessCheckParams.md#p_event_id)
-- [p\_organisation\_id](RBACPageAccessCheckParams.md#p_organisation_id)
-
-## Properties
-
-### p\_app\_id
-
-• **p\_app\_id**: `string` \| `AppId`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:64](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L64)
-
-___
-
-### p\_page\_id
-
-• **p\_page\_id**: `string` \| `PageId`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L65)
-
-___
-
-### p\_operation
-
-• **p\_operation**: [`Operation`](../modules.md#operation)
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L66)
-
-___
-
-### p\_user\_id
-
-• `Optional` **p\_user\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L67)
-
-___
-
-### p\_event\_id
-
-• `Optional` **p\_event\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L68)
-
-___
-
-### p\_organisation\_id
-
-• `Optional` **p\_organisation\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L69)

package/docs/api/interfaces/RBACPerformanceMetrics.md

@@ -1,138 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACPerformanceMetrics
-
-# Interface: RBACPerformanceMetrics
-
-## Table of contents
-
-### Properties
-
-- [totalChecks](RBACPerformanceMetrics.md#totalchecks)
-- [cacheHits](RBACPerformanceMetrics.md#cachehits)
-- [cacheMisses](RBACPerformanceMetrics.md#cachemisses)
-- [cacheHitRate](RBACPerformanceMetrics.md#cachehitrate)
-- [deduplicatedRequests](RBACPerformanceMetrics.md#deduplicatedrequests)
-- [networkRequests](RBACPerformanceMetrics.md#networkrequests)
-- [averageResponseTime](RBACPerformanceMetrics.md#averageresponsetime)
-- [totalResponseTime](RBACPerformanceMetrics.md#totalresponsetime)
-- [batchedAuditEvents](RBACPerformanceMetrics.md#batchedauditevents)
-- [individualAuditEvents](RBACPerformanceMetrics.md#individualauditevents)
-
-## Properties
-
-### totalChecks
-
-• **totalChecks**: `number`
-
-Total number of permission checks
-
-#### Defined in
-
-[packages/core/src/rbac/performance.ts:12](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L12)
-
-___
-
-### cacheHits
-
-• **cacheHits**: `number`
-
-Number of cache hits
-
-#### Defined in
-
-[packages/core/src/rbac/performance.ts:14](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L14)
-
-___
-
-### cacheMisses
-
-• **cacheMisses**: `number`
-
-Number of cache misses
-
-#### Defined in
-
-[packages/core/src/rbac/performance.ts:16](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L16)
-
-___
-
-### cacheHitRate
-
-• **cacheHitRate**: `number`
-
-Cache hit rate (0-1)
-
-#### Defined in
-
-[packages/core/src/rbac/performance.ts:18](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L18)
-
-___
-
-### deduplicatedRequests
-
-• **deduplicatedRequests**: `number`
-
-Number of deduplicated requests
-
-#### Defined in
-
-[packages/core/src/rbac/performance.ts:20](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L20)
-
-___
-
-### networkRequests
-
-• **networkRequests**: `number`
-
-Total number of network requests made
-
-#### Defined in
-
-[packages/core/src/rbac/performance.ts:22](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L22)
-
-___
-
-### averageResponseTime
-
-• **averageResponseTime**: `number`
-
-Average response time in milliseconds
-
-#### Defined in
-
-[packages/core/src/rbac/performance.ts:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L24)
-
-___
-
-### totalResponseTime
-
-• **totalResponseTime**: `number`
-
-Total response time in milliseconds
-
-#### Defined in
-
-[packages/core/src/rbac/performance.ts:26](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L26)
-
-___
-
-### batchedAuditEvents
-
-• **batchedAuditEvents**: `number`
-
-Number of batched audit events
-
-#### Defined in
-
-[packages/core/src/rbac/performance.ts:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L28)
-
-___
-
-### individualAuditEvents
-
-• **individualAuditEvents**: `number`
-
-Number of individual audit events
-
-#### Defined in
-
-[packages/core/src/rbac/performance.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L30)

package/docs/api/interfaces/RBACPermissionCheckParams.md

@@ -1,74 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACPermissionCheckParams
-
-# Interface: RBACPermissionCheckParams
-
-## Table of contents
-
-### Properties
-
-- [p\_operation](RBACPermissionCheckParams.md#p_operation)
-- [p\_page\_name](RBACPermissionCheckParams.md#p_page_name)
-- [p\_user\_id](RBACPermissionCheckParams.md#p_user_id)
-- [p\_organisation\_id](RBACPermissionCheckParams.md#p_organisation_id)
-- [p\_event\_id](RBACPermissionCheckParams.md#p_event_id)
-- [p\_app\_id](RBACPermissionCheckParams.md#p_app_id)
-
-## Properties
-
-### p\_operation
-
-• **p\_operation**: [`Operation`](../modules.md#operation)
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:19](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L19)
-
-___
-
-### p\_page\_name
-
-• **p\_page\_name**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:20](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L20)
-
-___
-
-### p\_user\_id
-
-• `Optional` **p\_user\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:21](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L21)
-
-___
-
-### p\_organisation\_id
-
-• `Optional` **p\_organisation\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:22](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L22)
-
-___
-
-### p\_event\_id
-
-• `Optional` **p\_event\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L23)
-
-___
-
-### p\_app\_id
-
-• `Optional` **p\_app\_id**: `string` \| `AppId`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L24)

package/docs/api/interfaces/RBACPermissionCheckResult.md

@@ -1,52 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACPermissionCheckResult
-
-# Interface: RBACPermissionCheckResult
-
-## Table of contents
-
-### Properties
-
-- [has\_permission](RBACPermissionCheckResult.md#has_permission)
-- [role\_name](RBACPermissionCheckResult.md#role_name)
-- [permission\_source](RBACPermissionCheckResult.md#permission_source)
-- [granted\_at](RBACPermissionCheckResult.md#granted_at)
-
-## Properties
-
-### has\_permission
-
-• **has\_permission**: `boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L28)
-
-___
-
-### role\_name
-
-• **role\_name**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L29)
-
-___
-
-### permission\_source
-
-• **permission\_source**: ``"global"`` \| ``"organisation"`` \| ``"event_app"`` \| ``"default"`` \| ``"none"``
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L30)
-
-___
-
-### granted\_at
-
-• **granted\_at**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L31)

package/docs/api/interfaces/RBACPermissionsGetParams.md

@@ -1,63 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACPermissionsGetParams
-
-# Interface: RBACPermissionsGetParams
-
-## Table of contents
-
-### Properties
-
-- [p\_user\_id](RBACPermissionsGetParams.md#p_user_id)
-- [p\_organisation\_id](RBACPermissionsGetParams.md#p_organisation_id)
-- [p\_event\_id](RBACPermissionsGetParams.md#p_event_id)
-- [p\_app\_id](RBACPermissionsGetParams.md#p_app_id)
-- [p\_page\_id](RBACPermissionsGetParams.md#p_page_id)
-
-## Properties
-
-### p\_user\_id
-
-• **p\_user\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:35](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L35)
-
-___
-
-### p\_organisation\_id
-
-• `Optional` **p\_organisation\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:36](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L36)
-
-___
-
-### p\_event\_id
-
-• `Optional` **p\_event\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:37](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L37)
-
-___
-
-### p\_app\_id
-
-• `Optional` **p\_app\_id**: `string` \| `AppId`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:38](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L38)
-
-___
-
-### p\_page\_id
-
-• `Optional` **p\_page\_id**: `string` \| `PageId`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:39](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L39)

package/docs/api/interfaces/RBACPermissionsGetResult.md

@@ -1,63 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACPermissionsGetResult
-
-# Interface: RBACPermissionsGetResult
-
-## Table of contents
-
-### Properties
-
-- [permission\_type](RBACPermissionsGetResult.md#permission_type)
-- [role\_name](RBACPermissionsGetResult.md#role_name)
-- [has\_permission](RBACPermissionsGetResult.md#has_permission)
-- [granted\_at](RBACPermissionsGetResult.md#granted_at)
-- [context\_id](RBACPermissionsGetResult.md#context_id)
-
-## Properties
-
-### permission\_type
-
-• **permission\_type**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:43](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L43)
-
-___
-
-### role\_name
-
-• **role\_name**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:44](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L44)
-
-___
-
-### has\_permission
-
-• **has\_permission**: `boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:45](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L45)
-
-___
-
-### granted\_at
-
-• **granted\_at**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:46](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L46)
-
-___
-
-### context\_id
-
-• **context\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:47](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L47)

package/docs/api/interfaces/RBACResult.md

@@ -1,58 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACResult
-
-# Interface: RBACResult\<T\>
-
-## Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `T` | `unknown` |
-
-## Table of contents
-
-### Properties
-
-- [success](RBACResult.md#success)
-- [data](RBACResult.md#data)
-- [error](RBACResult.md#error)
-- [error\_code](RBACResult.md#error_code)
-
-## Properties
-
-### success
-
-• **success**: `boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:274](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L274)
-
-___
-
-### data
-
-• `Optional` **data**: `T`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:275](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L275)
-
-___
-
-### error
-
-• `Optional` **error**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:276](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L276)
-
-___
-
-### error\_code
-
-• `Optional` **error\_code**: [`RBACErrorCode`](../enums/RBACErrorCode.md)
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:277](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L277)