@jmruthers/pace-core 0.6.11 → 0.6.12

package/docs/api/interfaces/RBACRolesListParams.md

@@ -0,0 +1,41 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / RBACRolesListParams
+
+# Interface: RBACRolesListParams
+
+Defined in: [rbac/types/functions.ts:106](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L106)
+
+## Properties
+
+### p\_user\_id?
+
+> `optional` **p\_user\_id**: `string`
+
+Defined in: [rbac/types/functions.ts:107](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L107)
+
+***
+
+### p\_organisation\_id?
+
+> `optional` **p\_organisation\_id**: `string`
+
+Defined in: [rbac/types/functions.ts:108](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L108)
+
+***
+
+### p\_event\_id?
+
+> `optional` **p\_event\_id**: `string`
+
+Defined in: [rbac/types/functions.ts:109](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L109)
+
+***
+
+### p\_app\_id?
+
+> `optional` **p\_app\_id**: `string` \| `AppId`
+
+Defined in: [rbac/types/functions.ts:110](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L110)

package/docs/api/interfaces/RBACRolesListResult.md

@@ -0,0 +1,57 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / RBACRolesListResult
+
+# Interface: RBACRolesListResult
+
+Defined in: [rbac/types/functions.ts:113](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L113)
+
+## Properties
+
+### role\_type
+
+> **role\_type**: `"global"` \| `"organisation"` \| `"event_app"`
+
+Defined in: [rbac/types/functions.ts:114](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L114)
+
+***
+
+### role\_name
+
+> **role\_name**: `string`
+
+Defined in: [rbac/types/functions.ts:115](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L115)
+
+***
+
+### context\_id
+
+> **context\_id**: `string`
+
+Defined in: [rbac/types/functions.ts:116](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L116)
+
+***
+
+### granted\_at
+
+> **granted\_at**: `string`
+
+Defined in: [rbac/types/functions.ts:117](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L117)
+
+***
+
+### status
+
+> **status**: `"active"` \| `"inactive"` \| `"expired"`
+
+Defined in: [rbac/types/functions.ts:118](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L118)
+
+***
+
+### granted\_by
+
+> **granted\_by**: `string` \| `null`
+
+Defined in: [rbac/types/functions.ts:119](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L119)

package/docs/api/interfaces/RBACSessionTrackParams.md

@@ -0,0 +1,57 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / RBACSessionTrackParams
+
+# Interface: RBACSessionTrackParams
+
+Defined in: [rbac/types/functions.ts:141](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L141)
+
+## Properties
+
+### p\_user\_id?
+
+> `optional` **p\_user\_id**: `string`
+
+Defined in: [rbac/types/functions.ts:142](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L142)
+
+***
+
+### p\_session\_type?
+
+> `optional` **p\_session\_type**: `"admin"` \| `"api"` \| `"web"` \| `"mobile"`
+
+Defined in: [rbac/types/functions.ts:143](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L143)
+
+***
+
+### p\_event\_id?
+
+> `optional` **p\_event\_id**: `string`
+
+Defined in: [rbac/types/functions.ts:144](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L144)
+
+***
+
+### p\_app\_id?
+
+> `optional` **p\_app\_id**: `string` \| `AppId`
+
+Defined in: [rbac/types/functions.ts:145](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L145)
+
+***
+
+### p\_ip\_address?
+
+> `optional` **p\_ip\_address**: `string`
+
+Defined in: [rbac/types/functions.ts:146](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L146)
+
+***
+
+### p\_user\_agent?
+
+> `optional` **p\_user\_agent**: `string`
+
+Defined in: [rbac/types/functions.ts:147](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L147)

package/docs/api/interfaces/RBACSessionTrackResult.md

@@ -0,0 +1,41 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / RBACSessionTrackResult
+
+# Interface: RBACSessionTrackResult
+
+Defined in: [rbac/types/functions.ts:150](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L150)
+
+## Properties
+
+### success
+
+> **success**: `boolean`
+
+Defined in: [rbac/types/functions.ts:151](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L151)
+
+***
+
+### session\_id
+
+> **session\_id**: `string` \| `null`
+
+Defined in: [rbac/types/functions.ts:152](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L152)
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: [rbac/types/functions.ts:153](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L153)
+
+***
+
+### error\_code
+
+> **error\_code**: `string` \| `null`
+
+Defined in: [rbac/types/functions.ts:154](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L154)

package/docs/api/interfaces/ResourcePermissions.md

@@ -0,0 +1,119 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / ResourcePermissions
+
+# Interface: ResourcePermissions
+
+Defined in: [rbac/hooks/useResourcePermissions.ts:60](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L60)
+
+## Properties
+
+### canCreate()
+
+> **canCreate**: (`resource`) => `boolean`
+
+Defined in: [rbac/hooks/useResourcePermissions.ts:62](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L62)
+
+Check if user can create resources of this type
+
+#### Parameters
+
+##### resource
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### canUpdate()
+
+> **canUpdate**: (`resource`) => `boolean`
+
+Defined in: [rbac/hooks/useResourcePermissions.ts:64](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L64)
+
+Check if user can update resources of this type
+
+#### Parameters
+
+##### resource
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### canDelete()
+
+> **canDelete**: (`resource`) => `boolean`
+
+Defined in: [rbac/hooks/useResourcePermissions.ts:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L66)
+
+Check if user can delete resources of this type
+
+#### Parameters
+
+##### resource
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### canRead()
+
+> **canRead**: (`resource`) => `boolean`
+
+Defined in: [rbac/hooks/useResourcePermissions.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L68)
+
+Check if user can read resources of this type
+
+#### Parameters
+
+##### resource
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### scope
+
+> **scope**: [`Scope`](../type-aliases/Scope.md) \| `null`
+
+Defined in: [rbac/hooks/useResourcePermissions.ts:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L70)
+
+The resolved scope object (for advanced use cases); null when not yet resolved.
+
+***
+
+### isLoading
+
+> **isLoading**: `boolean`
+
+Defined in: [rbac/hooks/useResourcePermissions.ts:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L72)
+
+Whether any permission check is currently loading
+
+***
+
+### error
+
+> **error**: `Error` \| `null`
+
+Defined in: [rbac/hooks/useResourcePermissions.ts:74](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useResourcePermissions.ts#L74)
+
+Error from any permission check or scope resolution

package/docs/api/interfaces/RevokeEventAppRoleParams.md

@@ -0,0 +1,81 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / RevokeEventAppRoleParams
+
+# Interface: RevokeEventAppRoleParams
+
+Defined in: [rbac/types/roleManagement.ts:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L31)
+
+## Extends
+
+- [`EventAppRoleData`](EventAppRoleData.md)
+
+## Properties
+
+### user\_id
+
+> **user\_id**: `string`
+
+Defined in: [rbac/types/roleManagement.ts:13](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L13)
+
+#### Inherited from
+
+[`EventAppRoleData`](EventAppRoleData.md).[`user_id`](EventAppRoleData.md#user_id)
+
+***
+
+### organisation\_id
+
+> **organisation\_id**: `string`
+
+Defined in: [rbac/types/roleManagement.ts:14](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L14)
+
+#### Inherited from
+
+[`EventAppRoleData`](EventAppRoleData.md).[`organisation_id`](EventAppRoleData.md#organisation_id)
+
+***
+
+### event\_id
+
+> **event\_id**: `string`
+
+Defined in: [rbac/types/roleManagement.ts:15](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L15)
+
+#### Inherited from
+
+[`EventAppRoleData`](EventAppRoleData.md).[`event_id`](EventAppRoleData.md#event_id)
+
+***
+
+### app\_id
+
+> **app\_id**: `string`
+
+Defined in: [rbac/types/roleManagement.ts:16](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L16)
+
+#### Inherited from
+
+[`EventAppRoleData`](EventAppRoleData.md).[`app_id`](EventAppRoleData.md#app_id)
+
+***
+
+### role
+
+> **role**: `"viewer"` \| `"participant"` \| `"planner"` \| `"event_admin"`
+
+Defined in: [rbac/types/roleManagement.ts:17](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L17)
+
+#### Inherited from
+
+[`EventAppRoleData`](EventAppRoleData.md).[`role`](EventAppRoleData.md#role)
+
+***
+
+### revoked\_by?
+
+> `optional` **revoked\_by**: `string`
+
+Defined in: [rbac/types/roleManagement.ts:32](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L32)

package/docs/api/interfaces/RoleManagementResult.md

@@ -0,0 +1,41 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / RoleManagementResult
+
+# Interface: RoleManagementResult
+
+Defined in: [rbac/types/roleManagement.ts:61](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L61)
+
+## Properties
+
+### success
+
+> **success**: `boolean`
+
+Defined in: [rbac/types/roleManagement.ts:62](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L62)
+
+***
+
+### message?
+
+> `optional` **message**: `string`
+
+Defined in: [rbac/types/roleManagement.ts:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L63)
+
+***
+
+### error?
+
+> `optional` **error**: `string`
+
+Defined in: [rbac/types/roleManagement.ts:64](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L64)
+
+***
+
+### roleId?
+
+> `optional` **roleId**: `string`
+
+Defined in: [rbac/types/roleManagement.ts:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/roleManagement.ts#L65)

package/docs/api/interfaces/SessionRestorationLoaderProps.md

@@ -0,0 +1,29 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / SessionRestorationLoaderProps
+
+# Interface: SessionRestorationLoaderProps
+
+Defined in: [components/SessionRestorationLoader/SessionRestorationLoader.tsx:43](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/SessionRestorationLoader/SessionRestorationLoader.tsx#L43)
+
+## Properties
+
+### message?
+
+> `optional` **message**: `string`
+
+Defined in: [components/SessionRestorationLoader/SessionRestorationLoader.tsx:45](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/SessionRestorationLoader/SessionRestorationLoader.tsx#L45)
+
+Customise the status message displayed under the spinner
+
+***
+
+### className?
+
+> `optional` **className**: `string`
+
+Defined in: [components/SessionRestorationLoader/SessionRestorationLoader.tsx:47](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/SessionRestorationLoader/SessionRestorationLoader.tsx#L47)
+
+Additional CSS classes for styling

package/docs/api/interfaces/StorageConfig.md

@@ -0,0 +1,33 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / StorageConfig
+
+# Interface: StorageConfig
+
+Defined in: [utils/storage/types.ts:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L100)
+
+## Properties
+
+### bucketName
+
+> **bucketName**: `string`
+
+Defined in: [utils/storage/types.ts:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L101)
+
+***
+
+### fileSizeLimits
+
+> **fileSizeLimits**: [`FileSizeLimits`](FileSizeLimits.md)
+
+Defined in: [utils/storage/types.ts:102](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L102)
+
+***
+
+### defaultFileSizeLimit
+
+> **defaultFileSizeLimit**: `number`
+
+Defined in: [utils/storage/types.ts:103](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L103)

package/docs/api/interfaces/StorageFileInfo.md

@@ -0,0 +1,57 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / StorageFileInfo
+
+# Interface: StorageFileInfo
+
+Defined in: [utils/storage/types.ts:81](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L81)
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+Defined in: [utils/storage/types.ts:82](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L82)
+
+***
+
+### path
+
+> **path**: `string`
+
+Defined in: [utils/storage/types.ts:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L83)
+
+***
+
+### size
+
+> **size**: `number`
+
+Defined in: [utils/storage/types.ts:84](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L84)
+
+***
+
+### mimeType
+
+> **mimeType**: `string`
+
+Defined in: [utils/storage/types.ts:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L85)
+
+***
+
+### lastModified
+
+> **lastModified**: `string`
+
+Defined in: [utils/storage/types.ts:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L86)
+
+***
+
+### metadata
+
+> **metadata**: [`StorageFileMetadata`](StorageFileMetadata.md)
+
+Defined in: [utils/storage/types.ts:87](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L87)

package/docs/api/interfaces/StorageFileMetadata.md

@@ -0,0 +1,113 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / StorageFileMetadata
+
+# Interface: StorageFileMetadata
+
+Defined in: [utils/storage/types.ts:22](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L22)
+
+## Properties
+
+### mimeType
+
+> **mimeType**: `string`
+
+Defined in: [utils/storage/types.ts:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L23)
+
+***
+
+### size
+
+> **size**: `number`
+
+Defined in: [utils/storage/types.ts:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L24)
+
+***
+
+### width?
+
+> `optional` **width**: `number`
+
+Defined in: [utils/storage/types.ts:25](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L25)
+
+***
+
+### height?
+
+> `optional` **height**: `number`
+
+Defined in: [utils/storage/types.ts:26](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L26)
+
+***
+
+### hash?
+
+> `optional` **hash**: `string`
+
+Defined in: [utils/storage/types.ts:27](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L27)
+
+***
+
+### orgId?
+
+> `optional` **orgId**: `string`
+
+Defined in: [utils/storage/types.ts:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L28)
+
+***
+
+### userId?
+
+> `optional` **userId**: `string`
+
+Defined in: [utils/storage/types.ts:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L29)
+
+***
+
+### appName
+
+> **appName**: `string`
+
+Defined in: [utils/storage/types.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L30)
+
+***
+
+### uploadedBy
+
+> **uploadedBy**: `string`
+
+Defined in: [utils/storage/types.ts:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L31)
+
+***
+
+### uploadedAt
+
+> **uploadedAt**: `string`
+
+Defined in: [utils/storage/types.ts:32](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L32)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string`[]
+
+Defined in: [utils/storage/types.ts:33](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L33)
+
+***
+
+### isPublic
+
+> **isPublic**: `boolean`
+
+Defined in: [utils/storage/types.ts:34](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L34)
+
+***
+
+### customMetadata?
+
+> `optional` **customMetadata**: `Record`\<`string`, `unknown`\>
+
+Defined in: [utils/storage/types.ts:35](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/types.ts#L35)