@jmruthers/pace-core 0.6.2 → 0.6.3

package/docs/api/interfaces/ResourcePermissions.md

@@ -1,155 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / ResourcePermissions
-
-# Interface: ResourcePermissions
-
-## Table of contents
-
-### Properties
-
-- [canCreate](ResourcePermissions.md#cancreate)
-- [canUpdate](ResourcePermissions.md#canupdate)
-- [canDelete](ResourcePermissions.md#candelete)
-- [canRead](ResourcePermissions.md#canread)
-- [scope](ResourcePermissions.md#scope)
-- [isLoading](ResourcePermissions.md#isloading)
-- [error](ResourcePermissions.md#error)
-
-## Properties
-
-### canCreate
-
-• **canCreate**: (`resource`: `string`) => `boolean`
-
-Check if user can create resources of this type
-
-#### Type declaration
-
-▸ (`resource`): `boolean`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `resource` | `string` |
-
-##### Returns
-
-`boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResourcePermissions.ts:60](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L60)
-
-___
-
-### canUpdate
-
-• **canUpdate**: (`resource`: `string`) => `boolean`
-
-Check if user can update resources of this type
-
-#### Type declaration
-
-▸ (`resource`): `boolean`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `resource` | `string` |
-
-##### Returns
-
-`boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResourcePermissions.ts:62](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L62)
-
-___
-
-### canDelete
-
-• **canDelete**: (`resource`: `string`) => `boolean`
-
-Check if user can delete resources of this type
-
-#### Type declaration
-
-▸ (`resource`): `boolean`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `resource` | `string` |
-
-##### Returns
-
-`boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResourcePermissions.ts:64](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L64)
-
-___
-
-### canRead
-
-• **canRead**: (`resource`: `string`) => `boolean`
-
-Check if user can read resources of this type
-
-#### Type declaration
-
-▸ (`resource`): `boolean`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `resource` | `string` |
-
-##### Returns
-
-`boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResourcePermissions.ts:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L66)
-
-___
-
-### scope
-
-• **scope**: [`Scope`](../modules.md#scope)
-
-The resolved scope object (for advanced use cases)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResourcePermissions.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L68)
-
-___
-
-### isLoading
-
-• **isLoading**: `boolean`
-
-Whether any permission check is currently loading
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResourcePermissions.ts:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L70)
-
-___
-
-### error
-
-• **error**: ``null`` \| `Error`
-
-Error from any permission check or scope resolution
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResourcePermissions.ts:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L72)

package/docs/api/interfaces/RevokeEventAppRoleParams.md

@@ -1,100 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RevokeEventAppRoleParams
-
-# Interface: RevokeEventAppRoleParams
-
-## Hierarchy
-
-- [`EventAppRoleData`](EventAppRoleData.md)
-
-  ↳ **`RevokeEventAppRoleParams`**
-
-## Table of contents
-
-### Properties
-
-- [user\_id](RevokeEventAppRoleParams.md#user_id)
-- [organisation\_id](RevokeEventAppRoleParams.md#organisation_id)
-- [event\_id](RevokeEventAppRoleParams.md#event_id)
-- [app\_id](RevokeEventAppRoleParams.md#app_id)
-- [role](RevokeEventAppRoleParams.md#role)
-- [revoked\_by](RevokeEventAppRoleParams.md#revoked_by)
-
-## Properties
-
-### user\_id
-
-• **user\_id**: `string`
-
-#### Inherited from
-
-[EventAppRoleData](EventAppRoleData.md).[user_id](EventAppRoleData.md#user_id)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L65)
-
-___
-
-### organisation\_id
-
-• **organisation\_id**: `string`
-
-#### Inherited from
-
-[EventAppRoleData](EventAppRoleData.md).[organisation_id](EventAppRoleData.md#organisation_id)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L66)
-
-___
-
-### event\_id
-
-• **event\_id**: `string`
-
-#### Inherited from
-
-[EventAppRoleData](EventAppRoleData.md).[event_id](EventAppRoleData.md#event_id)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L67)
-
-___
-
-### app\_id
-
-• **app\_id**: `string`
-
-#### Inherited from
-
-[EventAppRoleData](EventAppRoleData.md).[app_id](EventAppRoleData.md#app_id)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L68)
-
-___
-
-### role
-
-• **role**: ``"viewer"`` \| ``"participant"`` \| ``"planner"`` \| ``"event_admin"``
-
-#### Inherited from
-
-[EventAppRoleData](EventAppRoleData.md).[role](EventAppRoleData.md#role)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L69)
-
-___
-
-### revoked\_by
-
-• `Optional` **revoked\_by**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:84](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L84)

package/docs/api/interfaces/RoleBasedRouterContextType.md

@@ -1,151 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RoleBasedRouterContextType
-
-# Interface: RoleBasedRouterContextType
-
-## Table of contents
-
-### Properties
-
-- [getAccessibleRoutes](RoleBasedRouterContextType.md#getaccessibleroutes)
-- [canAccessRoute](RoleBasedRouterContextType.md#canaccessroute)
-- [getRouteConfig](RoleBasedRouterContextType.md#getrouteconfig)
-- [getRouteAccessHistory](RoleBasedRouterContextType.md#getrouteaccesshistory)
-- [clearRouteAccessHistory](RoleBasedRouterContextType.md#clearrouteaccesshistory)
-- [isStrictMode](RoleBasedRouterContextType.md#isstrictmode)
-- [isAuditLogEnabled](RoleBasedRouterContextType.md#isauditlogenabled)
-
-## Properties
-
-### getAccessibleRoutes
-
-• **getAccessibleRoutes**: () => [`RouteConfig`](RouteConfig.md)[]
-
-Get all accessible routes for current user
-
-#### Type declaration
-
-▸ (): [`RouteConfig`](RouteConfig.md)[]
-
-##### Returns
-
-[`RouteConfig`](RouteConfig.md)[]
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:122](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L122)
-
-___
-
-### canAccessRoute
-
-• **canAccessRoute**: (`path`: `string`) => `boolean`
-
-Check if user can access a specific route
-
-#### Type declaration
-
-▸ (`path`): `boolean`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-
-##### Returns
-
-`boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:125](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L125)
-
-___
-
-### getRouteConfig
-
-• **getRouteConfig**: (`path`: `string`) => ``null`` \| [`RouteConfig`](RouteConfig.md)
-
-Get route configuration for a path
-
-#### Type declaration
-
-▸ (`path`): ``null`` \| [`RouteConfig`](RouteConfig.md)
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-
-##### Returns
-
-``null`` \| [`RouteConfig`](RouteConfig.md)
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:128](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L128)
-
-___
-
-### getRouteAccessHistory
-
-• **getRouteAccessHistory**: () => [`RouteAccessRecord`](RouteAccessRecord.md)[]
-
-Get route access history
-
-#### Type declaration
-
-▸ (): [`RouteAccessRecord`](RouteAccessRecord.md)[]
-
-##### Returns
-
-[`RouteAccessRecord`](RouteAccessRecord.md)[]
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:131](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L131)
-
-___
-
-### clearRouteAccessHistory
-
-• **clearRouteAccessHistory**: () => `void`
-
-Clear route access history
-
-#### Type declaration
-
-▸ (): `void`
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:134](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L134)
-
-___
-
-### isStrictMode
-
-• **isStrictMode**: `boolean`
-
-Check if strict mode is enabled
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:137](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L137)
-
-___
-
-### isAuditLogEnabled
-
-• **isAuditLogEnabled**: `boolean`
-
-Check if audit logging is enabled
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:140](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L140)

package/docs/api/interfaces/RoleBasedRouterProps.md

@@ -1,156 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RoleBasedRouterProps
-
-# Interface: RoleBasedRouterProps
-
-## Table of contents
-
-### Properties
-
-- [routes](RoleBasedRouterProps.md#routes)
-- [fallbackRoute](RoleBasedRouterProps.md#fallbackroute)
-- [children](RoleBasedRouterProps.md#children)
-- [strictMode](RoleBasedRouterProps.md#strictmode)
-- [auditLog](RoleBasedRouterProps.md#auditlog)
-- [onRouteAccess](RoleBasedRouterProps.md#onrouteaccess)
-- [onStrictModeViolation](RoleBasedRouterProps.md#onstrictmodeviolation)
-- [maxHistorySize](RoleBasedRouterProps.md#maxhistorysize)
-- [unauthorizedComponent](RoleBasedRouterProps.md#unauthorizedcomponent)
-
-## Properties
-
-### routes
-
-• **routes**: [`RouteConfig`](RouteConfig.md)[]
-
-Route configuration
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:145](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L145)
-
-___
-
-### fallbackRoute
-
-• `Optional` **fallbackRoute**: `string`
-
-Fallback route for unauthorized access
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:148](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L148)
-
-___
-
-### children
-
-• **children**: `ReactNode`
-
-Child components
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:151](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L151)
-
-___
-
-### strictMode
-
-• `Optional` **strictMode**: `boolean`
-
-Enable strict mode to prevent bypassing (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:154](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L154)
-
-___
-
-### auditLog
-
-• `Optional` **auditLog**: `boolean`
-
-Enable audit logging (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:157](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L157)
-
-___
-
-### onRouteAccess
-
-• `Optional` **onRouteAccess**: (`route`: `string`, `allowed`: `boolean`, `record`: [`RouteAccessRecord`](RouteAccessRecord.md)) => `void`
-
-Callback when route access is attempted
-
-#### Type declaration
-
-▸ (`route`, `allowed`, `record`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `route` | `string` |
-| `allowed` | `boolean` |
-| `record` | [`RouteAccessRecord`](RouteAccessRecord.md) |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:160](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L160)
-
-___
-
-### onStrictModeViolation
-
-• `Optional` **onStrictModeViolation**: (`route`: `string`, `record`: [`RouteAccessRecord`](RouteAccessRecord.md)) => `void`
-
-Callback when strict mode violation occurs
-
-#### Type declaration
-
-▸ (`route`, `record`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `route` | `string` |
-| `record` | [`RouteAccessRecord`](RouteAccessRecord.md) |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:163](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L163)
-
-___
-
-### maxHistorySize
-
-• `Optional` **maxHistorySize**: `number`
-
-Maximum number of access records to keep in history
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:166](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L166)
-
-___
-
-### unauthorizedComponent
-
-• `Optional` **unauthorizedComponent**: `ComponentType`\<\{ `route`: `string` ; `reason`: `string`  }\>
-
-Custom unauthorized component
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:169](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L169)

package/docs/api/interfaces/RoleManagementResult.md

@@ -1,52 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RoleManagementResult
-
-# Interface: RoleManagementResult
-
-## Table of contents
-
-### Properties
-
-- [success](RoleManagementResult.md#success)
-- [message](RoleManagementResult.md#message)
-- [error](RoleManagementResult.md#error)
-- [roleId](RoleManagementResult.md#roleid)
-
-## Properties
-
-### success
-
-• **success**: `boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:114](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L114)
-
-___
-
-### message
-
-• `Optional` **message**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:115](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L115)
-
-___
-
-### error
-
-• `Optional` **error**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:116](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L116)
-
-___
-
-### roleId
-
-• `Optional` **roleId**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useRoleManagement.ts:117](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L117)