@jmruthers/pace-core 0.6.2 → 0.6.4

package/docs/api/interfaces/UseResolvedScopeReturn.md

@@ -1,47 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / UseResolvedScopeReturn
-
-# Interface: UseResolvedScopeReturn
-
-## Table of contents
-
-### Properties
-
-- [resolvedScope](UseResolvedScopeReturn.md#resolvedscope)
-- [isLoading](UseResolvedScopeReturn.md#isloading)
-- [error](UseResolvedScopeReturn.md#error)
-
-## Properties
-
-### resolvedScope
-
-• **resolvedScope**: ``null`` \| [`Scope`](../modules.md#scope)
-
-Resolved scope, or null if not yet resolved
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResolvedScope.ts:44](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResolvedScope.ts#L44)
-
-___
-
-### isLoading
-
-• **isLoading**: `boolean`
-
-Whether the scope resolution is in progress
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResolvedScope.ts:46](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResolvedScope.ts#L46)
-
-___
-
-### error
-
-• **error**: ``null`` \| `Error`
-
-Error if scope resolution failed
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResolvedScope.ts:48](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResolvedScope.ts#L48)

package/docs/api/interfaces/UseResourcePermissionsOptions.md

@@ -1,34 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / UseResourcePermissionsOptions
-
-# Interface: UseResourcePermissionsOptions
-
-## Table of contents
-
-### Properties
-
-- [enableRead](UseResourcePermissionsOptions.md#enableread)
-- [requireScope](UseResourcePermissionsOptions.md#requirescope)
-
-## Properties
-
-### enableRead
-
-• `Optional` **enableRead**: `boolean`
-
-Whether to check read permissions (default: false)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResourcePermissions.ts:53](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L53)
-
-___
-
-### requireScope
-
-• `Optional` **requireScope**: `boolean`
-
-Whether scope resolution is required (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/hooks/useResourcePermissions.ts:55](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L55)

package/docs/api/interfaces/UserEventAccess.md

@@ -1,121 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / UserEventAccess
-
-# Interface: UserEventAccess
-
-User event access interface.
-Represents a user's access to a specific event.
-
-## Table of contents
-
-### Properties
-
-- [event\_id](UserEventAccess.md#event_id)
-- [event\_name](UserEventAccess.md#event_name)
-- [event\_description](UserEventAccess.md#event_description)
-- [start\_date](UserEventAccess.md#start_date)
-- [end\_date](UserEventAccess.md#end_date)
-- [event\_status](UserEventAccess.md#event_status)
-- [app\_id](UserEventAccess.md#app_id)
-- [access\_level](UserEventAccess.md#access_level)
-- [granted\_at](UserEventAccess.md#granted_at)
-- [organisation\_id](UserEventAccess.md#organisation_id)
-
-## Properties
-
-### event\_id
-
-• **event\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/providers/services/UnifiedAuthProvider.tsx:35](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L35)
-
-___
-
-### event\_name
-
-• **event\_name**: `string`
-
-#### Defined in
-
-[packages/core/src/providers/services/UnifiedAuthProvider.tsx:36](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L36)
-
-___
-
-### event\_description
-
-• `Optional` **event\_description**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/providers/services/UnifiedAuthProvider.tsx:37](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L37)
-
-___
-
-### start\_date
-
-• **start\_date**: `string`
-
-#### Defined in
-
-[packages/core/src/providers/services/UnifiedAuthProvider.tsx:38](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L38)
-
-___
-
-### end\_date
-
-• **end\_date**: `string`
-
-#### Defined in
-
-[packages/core/src/providers/services/UnifiedAuthProvider.tsx:39](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L39)
-
-___
-
-### event\_status
-
-• **event\_status**: `string`
-
-#### Defined in
-
-[packages/core/src/providers/services/UnifiedAuthProvider.tsx:40](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L40)
-
-___
-
-### app\_id
-
-• **app\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/providers/services/UnifiedAuthProvider.tsx:41](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L41)
-
-___
-
-### access\_level
-
-• **access\_level**: `string`
-
-#### Defined in
-
-[packages/core/src/providers/services/UnifiedAuthProvider.tsx:42](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L42)
-
-___
-
-### granted\_at
-
-• **granted\_at**: `string`
-
-#### Defined in
-
-[packages/core/src/providers/services/UnifiedAuthProvider.tsx:43](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L43)
-
-___
-
-### organisation\_id
-
-• **organisation\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/providers/services/UnifiedAuthProvider.tsx:44](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L44)

package/docs/api/interfaces/UserMenuProps.md

@@ -1,88 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / UserMenuProps
-
-# Interface: UserMenuProps
-
-Props for the UserMenu component.
-
-## Table of contents
-
-### Properties
-
-- [user](UserMenuProps.md#user)
-- [onSignOut](UserMenuProps.md#onsignout)
-- [onChangePassword](UserMenuProps.md#onchangepassword)
-- [className](UserMenuProps.md#classname)
-- [showAvatar](UserMenuProps.md#showavatar)
-
-## Properties
-
-### user
-
-• **user**: ``null`` \| `User`
-
-#### Defined in
-
-[packages/core/src/components/UserMenu/UserMenu.tsx:133](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/UserMenu/UserMenu.tsx#L133)
-
-___
-
-### onSignOut
-
-• `Optional` **onSignOut**: () => `Promise`\<`void`\>
-
-#### Type declaration
-
-▸ (): `Promise`\<`void`\>
-
-##### Returns
-
-`Promise`\<`void`\>
-
-#### Defined in
-
-[packages/core/src/components/UserMenu/UserMenu.tsx:134](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/UserMenu/UserMenu.tsx#L134)
-
-___
-
-### onChangePassword
-
-• `Optional` **onChangePassword**: (`newPassword`: `string`, `confirmPassword`: `string`) => `Promise`\<\{ `error?`: `PasswordChangeFormError`  }\>
-
-#### Type declaration
-
-▸ (`newPassword`, `confirmPassword`): `Promise`\<\{ `error?`: `PasswordChangeFormError`  }\>
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `newPassword` | `string` |
-| `confirmPassword` | `string` |
-
-##### Returns
-
-`Promise`\<\{ `error?`: `PasswordChangeFormError`  }\>
-
-#### Defined in
-
-[packages/core/src/components/UserMenu/UserMenu.tsx:135](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/UserMenu/UserMenu.tsx#L135)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-#### Defined in
-
-[packages/core/src/components/UserMenu/UserMenu.tsx:136](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/UserMenu/UserMenu.tsx#L136)
-
-___
-
-### showAvatar
-
-• `Optional` **showAvatar**: `boolean`
-
-#### Defined in
-
-[packages/core/src/components/UserMenu/UserMenu.tsx:137](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/UserMenu/UserMenu.tsx#L137)

package/docs/api/interfaces/UserProfile.md

@@ -1,63 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / UserProfile
-
-# Interface: UserProfile
-
-## Table of contents
-
-### Properties
-
-- [id](UserProfile.md#id)
-- [email](UserProfile.md#email)
-- [full\_name](UserProfile.md#full_name)
-- [created\_at](UserProfile.md#created_at)
-- [updated\_at](UserProfile.md#updated_at)
-
-## Properties
-
-### id
-
-• **id**: `UserId`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:43](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L43)
-
-___
-
-### email
-
-• **email**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:44](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L44)
-
-___
-
-### full\_name
-
-• `Optional` **full\_name**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:45](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L45)
-
-___
-
-### created\_at
-
-• **created\_at**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:46](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L46)
-
-___
-
-### updated\_at
-
-• **updated\_at**: `string`
-
-#### Defined in
-
-[packages/core/src/types/organisation.ts:47](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L47)