@jmruthers/pace-core 0.6.2 → 0.6.4

package/docs/api/interfaces/PublicPageFooterProps.md

@@ -1,112 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / PublicPageFooterProps
-
-# Interface: PublicPageFooterProps
-
-## Table of contents
-
-### Properties
-
-- [event](PublicPageFooterProps.md#event)
-- [companyName](PublicPageFooterProps.md#companyname)
-- [year](PublicPageFooterProps.md#year)
-- [links](PublicPageFooterProps.md#links)
-- [className](PublicPageFooterProps.md#classname)
-- [logo](PublicPageFooterProps.md#logo)
-- [copyright](PublicPageFooterProps.md#copyright)
-- [children](PublicPageFooterProps.md#children)
-
-## Properties
-
-### event
-
-• **event**: `Event`
-
-The event data for this public page
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:214](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L214)
-
-___
-
-### companyName
-
-• `Optional` **companyName**: `string`
-
-Company or organization name
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:216](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L216)
-
-___
-
-### year
-
-• `Optional` **year**: `number`
-
-Current year or custom year for copyright
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:218](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L218)
-
-___
-
-### links
-
-• `Optional` **links**: \{ `label`: `string` ; `href`: `string`  }[]
-
-Optional array of navigation links to display
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:220](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L220)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-Optional CSS class name
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:225](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L225)
-
-___
-
-### logo
-
-• `Optional` **logo**: `string`
-
-Logo image URL
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:227](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L227)
-
-___
-
-### copyright
-
-• `Optional` **copyright**: `string`
-
-Copyright text
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:229](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L229)
-
-___
-
-### children
-
-• `Optional` **children**: `ReactNode`
-
-Footer content - children to render inside footer
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:231](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L231)

package/docs/api/interfaces/PublicPageHeaderProps.md

@@ -1,125 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / PublicPageHeaderProps
-
-# Interface: PublicPageHeaderProps
-
-## Table of contents
-
-### Properties
-
-- [event](PublicPageHeaderProps.md#event)
-- [eventCode](PublicPageHeaderProps.md#eventcode)
-- [title](PublicPageHeaderProps.md#title)
-- [description](PublicPageHeaderProps.md#description)
-- [showEventLogo](PublicPageHeaderProps.md#showeventlogo)
-- [showAppLogo](PublicPageHeaderProps.md#showapplogo)
-- [className](PublicPageHeaderProps.md#classname)
-- [children](PublicPageHeaderProps.md#children)
-- [customEventLogo](PublicPageHeaderProps.md#customeventlogo)
-
-## Properties
-
-### event
-
-• `Optional` **event**: `Event`
-
-The event data for this public page
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:111](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L111)
-
-___
-
-### eventCode
-
-• **eventCode**: `string`
-
-The event code for this public page
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:113](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L113)
-
-___
-
-### title
-
-• `Optional` **title**: `string`
-
-Optional page title
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:115](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L115)
-
-___
-
-### description
-
-• `Optional` **description**: `string`
-
-Optional page description
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:117](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L117)
-
-___
-
-### showEventLogo
-
-• `Optional` **showEventLogo**: `boolean`
-
-Whether to show the event logo (default: true)
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:119](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L119)
-
-___
-
-### showAppLogo
-
-• `Optional` **showAppLogo**: `boolean`
-
-Whether to show the app logo (default: true)
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:121](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L121)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-Custom CSS classes for the header
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:123](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L123)
-
-___
-
-### children
-
-• `Optional` **children**: `ReactNode`
-
-Custom content to display in the header
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:125](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L125)
-
-___
-
-### customEventLogo
-
-• `Optional` **customEventLogo**: `ReactNode`
-
-Custom event logo component
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:127](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L127)

package/docs/api/interfaces/PublicPageLayoutProps.md

@@ -1,185 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / PublicPageLayoutProps
-
-# Interface: PublicPageLayoutProps
-
-## Table of contents
-
-### Properties
-
-- [eventCode](PublicPageLayoutProps.md#eventcode)
-- [children](PublicPageLayoutProps.md#children)
-- [event](PublicPageLayoutProps.md#event)
-- [isLoading](PublicPageLayoutProps.md#isloading)
-- [error](PublicPageLayoutProps.md#error)
-- [refetch](PublicPageLayoutProps.md#refetch)
-- [showFooter](PublicPageLayoutProps.md#showfooter)
-- [errorFallback](PublicPageLayoutProps.md#errorfallback)
-- [loadingFallback](PublicPageLayoutProps.md#loadingfallback)
-- [customHeader](PublicPageLayoutProps.md#customheader)
-- [customFooter](PublicPageLayoutProps.md#customfooter)
-- [showValidationErrors](PublicPageLayoutProps.md#showvalidationerrors)
-- [loadingMessage](PublicPageLayoutProps.md#loadingmessage)
-
-## Properties
-
-### eventCode
-
-• **eventCode**: `string`
-
-The event code for this public page
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:80](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L80)
-
-___
-
-### children
-
-• **children**: `ReactNode`
-
-Child components to render
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:82](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L82)
-
-___
-
-### event
-
-• `Optional` **event**: ``null`` \| `Event`
-
-Optional event data - if not provided, will be fetched by parent component
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:84](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L84)
-
-___
-
-### isLoading
-
-• `Optional` **isLoading**: `boolean`
-
-Loading state - if true, shows loading spinner
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L86)
-
-___
-
-### error
-
-• `Optional` **error**: ``null`` \| `Error`
-
-Error state - if provided, shows error message
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L88)
-
-___
-
-### refetch
-
-• `Optional` **refetch**: () => `void` \| `Promise`\<`void`\>
-
-Function to retry loading event data
-
-#### Type declaration
-
-▸ (): `void` \| `Promise`\<`void`\>
-
-##### Returns
-
-`void` \| `Promise`\<`void`\>
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:90](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L90)
-
-___
-
-### showFooter
-
-• `Optional` **showFooter**: `boolean`
-
-Whether to show the footer (default: true)
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L92)
-
-___
-
-### errorFallback
-
-• `Optional` **errorFallback**: `ComponentType`\<\{ `error`: `Error` ; `retry`: () => `void`  }\>
-
-Custom error fallback component
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L94)
-
-___
-
-### loadingFallback
-
-• `Optional` **loadingFallback**: `ComponentType`\<{}\>
-
-Custom loading fallback component
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:96](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L96)
-
-___
-
-### customHeader
-
-• `Optional` **customHeader**: `ReactNode`
-
-Custom header component
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:98](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L98)
-
-___
-
-### customFooter
-
-• `Optional` **customFooter**: `ReactNode`
-
-Custom footer component
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L100)
-
-___
-
-### showValidationErrors
-
-• `Optional` **showValidationErrors**: `boolean`
-
-Whether to show event validation errors (default: true)
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:102](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L102)
-
-___
-
-### loadingMessage
-
-• `Optional` **loadingMessage**: `string`
-
-Custom loading message
-
-#### Defined in
-
-[packages/core/src/components/PublicLayout/PublicPageLayout.tsx:104](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L104)

package/docs/api/interfaces/QuickFix.md

@@ -1,52 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / QuickFix
-
-# Interface: QuickFix
-
-## Table of contents
-
-### Properties
-
-- [issue](QuickFix.md#issue)
-- [suggestion](QuickFix.md#suggestion)
-- [codeExample](QuickFix.md#codeexample)
-- [migrationSteps](QuickFix.md#migrationsteps)
-
-## Properties
-
-### issue
-
-• **issue**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/quick-fix-suggestions.ts:11](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/quick-fix-suggestions.ts#L11)
-
-___
-
-### suggestion
-
-• **suggestion**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/quick-fix-suggestions.ts:12](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/quick-fix-suggestions.ts#L12)
-
-___
-
-### codeExample
-
-• `Optional` **codeExample**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/quick-fix-suggestions.ts:13](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/quick-fix-suggestions.ts#L13)
-
-___
-
-### migrationSteps
-
-• `Optional` **migrationSteps**: `string`[]
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/quick-fix-suggestions.ts:14](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/quick-fix-suggestions.ts#L14)

package/docs/api/interfaces/RBACAccessValidateParams.md

@@ -1,52 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACAccessValidateParams
-
-# Interface: RBACAccessValidateParams
-
-## Table of contents
-
-### Properties
-
-- [p\_resource\_type](RBACAccessValidateParams.md#p_resource_type)
-- [p\_resource\_id](RBACAccessValidateParams.md#p_resource_id)
-- [p\_user\_id](RBACAccessValidateParams.md#p_user_id)
-- [p\_operation](RBACAccessValidateParams.md#p_operation)
-
-## Properties
-
-### p\_resource\_type
-
-• **p\_resource\_type**: ``"organisation"`` \| ``"event"``
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:51](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L51)
-
-___
-
-### p\_resource\_id
-
-• **p\_resource\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:52](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L52)
-
-___
-
-### p\_user\_id
-
-• `Optional` **p\_user\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:53](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L53)
-
-___
-
-### p\_operation
-
-• `Optional` **p\_operation**: [`Operation`](../modules.md#operation)
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:54](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L54)

package/docs/api/interfaces/RBACAccessValidateResult.md

@@ -1,41 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACAccessValidateResult
-
-# Interface: RBACAccessValidateResult
-
-## Table of contents
-
-### Properties
-
-- [has\_access](RBACAccessValidateResult.md#has_access)
-- [access\_level](RBACAccessValidateResult.md#access_level)
-- [context\_id](RBACAccessValidateResult.md#context_id)
-
-## Properties
-
-### has\_access
-
-• **has\_access**: `boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:58](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L58)
-
-___
-
-### access\_level
-
-• **access\_level**: [`AccessLevelContext`](../modules.md#accesslevelcontext)
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:59](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L59)
-
-___
-
-### context\_id
-
-• **context\_id**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:60](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L60)

package/docs/api/interfaces/RBACAuditLogParams.md

@@ -1,85 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RBACAuditLogParams
-
-# Interface: RBACAuditLogParams
-
-## Table of contents
-
-### Properties
-
-- [p\_event\_type](RBACAuditLogParams.md#p_event_type)
-- [p\_user\_id](RBACAuditLogParams.md#p_user_id)
-- [p\_organisation\_id](RBACAuditLogParams.md#p_organisation_id)
-- [p\_permission](RBACAuditLogParams.md#p_permission)
-- [p\_metadata](RBACAuditLogParams.md#p_metadata)
-- [p\_ip\_address](RBACAuditLogParams.md#p_ip_address)
-- [p\_user\_agent](RBACAuditLogParams.md#p_user_agent)
-
-## Properties
-
-### p\_event\_type
-
-• **p\_event\_type**: ``"login"`` \| ``"logout"`` \| ``"organisation_switched"`` \| ``"role_granted"`` \| ``"role_revoked"`` \| ``"permission_checked"`` \| ``"access_granted"`` \| ``"access_denied"`` \| ``"session_started"`` \| ``"session_ended"`` \| ``"event_switched"`` \| ``"app_switched"``
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:158](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L158)
-
-___
-
-### p\_user\_id
-
-• `Optional` **p\_user\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:159](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L159)
-
-___
-
-### p\_organisation\_id
-
-• `Optional` **p\_organisation\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:160](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L160)
-
-___
-
-### p\_permission
-
-• `Optional` **p\_permission**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:161](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L161)
-
-___
-
-### p\_metadata
-
-• `Optional` **p\_metadata**: `Record`\<`string`, `unknown`\>
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:162](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L162)
-
-___
-
-### p\_ip\_address
-
-• `Optional` **p\_ip\_address**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:163](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L163)
-
-___
-
-### p\_user\_agent
-
-• `Optional` **p\_user\_agent**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/types/functions.ts:164](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L164)