@jmruthers/pace-core 0.6.2 → 0.6.3

package/docs/api/interfaces/PaceAppLayoutProps.md

@@ -1,409 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / PaceAppLayoutProps
-
-# Interface: PaceAppLayoutProps
-
-Props for the PaceAppLayout component.
-Configures the application layout including navigation, header, and footer.
-
-## Table of contents
-
-### Properties
-
-- [appName](PaceAppLayoutProps.md#appname)
-- [navItems](PaceAppLayoutProps.md#navitems)
-- [showEventSelector](PaceAppLayoutProps.md#showeventselector)
-- [showOrgSelector](PaceAppLayoutProps.md#showorgselector)
-- [headerActions](PaceAppLayoutProps.md#headeractions)
-- [customLogo](PaceAppLayoutProps.md#customlogo)
-- [logoHref](PaceAppLayoutProps.md#logohref)
-- [customUserMenu](PaceAppLayoutProps.md#customusermenu)
-- [headerClassName](PaceAppLayoutProps.md#headerclassname)
-- [showUserMenu](PaceAppLayoutProps.md#showusermenu)
-- [enforcePermissions](PaceAppLayoutProps.md#enforcepermissions)
-- [defaultPermission](PaceAppLayoutProps.md#defaultpermission)
-- [routePermissions](PaceAppLayoutProps.md#routepermissions)
-- [permissionFallback](PaceAppLayoutProps.md#permissionfallback)
-- [pageIdMapping](PaceAppLayoutProps.md#pageidmapping)
-- [strictMode](PaceAppLayoutProps.md#strictmode)
-- [enforcePagePermissions](PaceAppLayoutProps.md#enforcepagepermissions)
-- [pagePermissionFallback](PaceAppLayoutProps.md#pagepermissionfallback)
-- [auditLog](PaceAppLayoutProps.md#auditlog)
-- [onPageAccessDenied](PaceAppLayoutProps.md#onpageaccessdenied)
-- [onStrictModeViolation](PaceAppLayoutProps.md#onstrictmodeviolation)
-- [roleBasedRouting](PaceAppLayoutProps.md#rolebasedrouting)
-- [routeConfig](PaceAppLayoutProps.md#routeconfig)
-- [fallbackRoute](PaceAppLayoutProps.md#fallbackroute)
-- [onRouteAccessDenied](PaceAppLayoutProps.md#onrouteaccessdenied)
-- [onRouteStrictModeViolation](PaceAppLayoutProps.md#onroutestrictmodeviolation)
-
-## Properties
-
-### appName
-
-• **appName**: `string`
-
-The name of the application to be displayed in the header.
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:130](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L130)
-
-___
-
-### navItems
-
-• `Optional` **navItems**: [`NavigationItem`](NavigationItem.md)[]
-
-Optional navigation items for the header menu. If not provided, uses default navigation.
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:132](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L132)
-
-___
-
-### showEventSelector
-
-• `Optional` **showEventSelector**: `boolean`
-
-Show/hide event selector in the header
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:134](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L134)
-
-___
-
-### showOrgSelector
-
-• `Optional` **showOrgSelector**: `boolean`
-
-Show/hide organisation selector in the header
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:136](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L136)
-
-___
-
-### headerActions
-
-• `Optional` **headerActions**: `ReactNode`
-
-Custom actions to display in the header (between event selector and user menu)
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:138](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L138)
-
-___
-
-### customLogo
-
-• `Optional` **customLogo**: `ReactNode`
-
-Custom logo component (overrides default logo)
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:140](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L140)
-
-___
-
-### logoHref
-
-• `Optional` **logoHref**: `string`
-
-URL to navigate to when logo is clicked (defaults to '/dashboard')
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:142](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L142)
-
-___
-
-### customUserMenu
-
-• `Optional` **customUserMenu**: `ReactNode`
-
-Custom user menu component (overrides default user menu)
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:144](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L144)
-
-___
-
-### headerClassName
-
-• `Optional` **headerClassName**: `string`
-
-Custom className for the header
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:146](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L146)
-
-___
-
-### showUserMenu
-
-• `Optional` **showUserMenu**: `boolean`
-
-Show/hide user menu
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:148](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L148)
-
-___
-
-### enforcePermissions
-
-• `Optional` **enforcePermissions**: `boolean`
-
-Enable layout-level permission enforcement
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:150](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L150)
-
-___
-
-### defaultPermission
-
-• `Optional` **defaultPermission**: `Operation`
-
-Default permission to check for all routes (when enforcePermissions is true)
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:152](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L152)
-
-___
-
-### routePermissions
-
-• `Optional` **routePermissions**: `Record`\<`string`, `Operation`\>
-
-Route-specific permissions mapping
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:154](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L154)
-
-___
-
-### permissionFallback
-
-• `Optional` **permissionFallback**: `ReactNode`
-
-Fallback component to show when user lacks permission
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:156](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L156)
-
-___
-
-### pageIdMapping
-
-• `Optional` **pageIdMapping**: `Record`\<`string`, `string`\>
-
-Custom permission page ID mapping
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:158](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L158)
-
-___
-
-### strictMode
-
-• `Optional` **strictMode**: `boolean`
-
-Enable strict mode to prevent bypassing permission checks (default: true)
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:162](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L162)
-
-___
-
-### enforcePagePermissions
-
-• `Optional` **enforcePagePermissions**: `boolean`
-
-Enable page-level permission enforcement (default: false)
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:164](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L164)
-
-___
-
-### pagePermissionFallback
-
-• `Optional` **pagePermissionFallback**: `ReactNode`
-
-Default page permission fallback component
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:166](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L166)
-
-___
-
-### auditLog
-
-• `Optional` **auditLog**: `boolean`
-
-Enable audit logging for all permission checks (default: true)
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:168](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L168)
-
-___
-
-### onPageAccessDenied
-
-• `Optional` **onPageAccessDenied**: (`pageName`: `string`, `operation`: `string`) => `void`
-
-Callback when page access is denied
-
-#### Type declaration
-
-▸ (`pageName`, `operation`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `pageName` | `string` |
-| `operation` | `string` |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:170](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L170)
-
-___
-
-### onStrictModeViolation
-
-• `Optional` **onStrictModeViolation**: (`pageName`: `string`, `operation`: `string`) => `void`
-
-Callback when strict mode violation occurs
-
-#### Type declaration
-
-▸ (`pageName`, `operation`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `pageName` | `string` |
-| `operation` | `string` |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:172](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L172)
-
-___
-
-### roleBasedRouting
-
-• `Optional` **roleBasedRouting**: `boolean`
-
-Enable role-based routing (default: false)
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:176](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L176)
-
-___
-
-### routeConfig
-
-• `Optional` **routeConfig**: \{ `path`: `string` ; `component`: `ComponentType`\<{}\> ; `permissions`: `string`[] ; `roles?`: `string`[] ; `accessLevel?`: `string` ; `pageId?`: `string` ; `strictMode?`: `boolean` ; `meta?`: \{ `title?`: `string` ; `description?`: `string` ; `requiresAuth?`: `boolean` ; `hidden?`: `boolean`  }  }[]
-
-Route configuration for role-based routing
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:178](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L178)
-
-___
-
-### fallbackRoute
-
-• `Optional` **fallbackRoute**: `string`
-
-Fallback route for unauthorized access
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:194](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L194)
-
-___
-
-### onRouteAccessDenied
-
-• `Optional` **onRouteAccessDenied**: (`route`: `string`, `reason`: `string`) => `void`
-
-Callback when route access is denied
-
-#### Type declaration
-
-▸ (`route`, `reason`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `route` | `string` |
-| `reason` | `string` |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:196](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L196)
-
-___
-
-### onRouteStrictModeViolation
-
-• `Optional` **onRouteStrictModeViolation**: (`route`: `string`, `reason`: `string`) => `void`
-
-Callback when route strict mode violation occurs
-
-#### Type declaration
-
-▸ (`route`, `reason`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `route` | `string` |
-| `reason` | `string` |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx:198](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L198)

package/docs/api/interfaces/PaceLoginPageProps.md

@@ -1,49 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / PaceLoginPageProps
-
-# Interface: PaceLoginPageProps
-
-Props for the PaceLoginPage component.
-
-## Table of contents
-
-### Properties
-
-- [appName](PaceLoginPageProps.md#appname)
-- [onSuccessRedirectPath](PaceLoginPageProps.md#onsuccessredirectpath)
-- [requireAppAccess](PaceLoginPageProps.md#requireappaccess)
-
-## Properties
-
-### appName
-
-• **appName**: `string`
-
-The name of the application to be displayed on the login form.
-
-#### Defined in
-
-[packages/core/src/components/PaceLoginPage/PaceLoginPage.tsx:139](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceLoginPage/PaceLoginPage.tsx#L139)
-
-___
-
-### onSuccessRedirectPath
-
-• `Optional` **onSuccessRedirectPath**: `string`
-
-The path to redirect to upon successful login. Defaults to `/`.
-
-#### Defined in
-
-[packages/core/src/components/PaceLoginPage/PaceLoginPage.tsx:141](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceLoginPage/PaceLoginPage.tsx#L141)
-
-___
-
-### requireAppAccess
-
-• `Optional` **requireAppAccess**: `boolean`
-
-Whether to check app access using RBAC. Defaults to false.
-
-#### Defined in
-
-[packages/core/src/components/PaceLoginPage/PaceLoginPage.tsx:143](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceLoginPage/PaceLoginPage.tsx#L143)

package/docs/api/interfaces/PageAccessRecord.md

@@ -1,85 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / PageAccessRecord
-
-# Interface: PageAccessRecord
-
-## Table of contents
-
-### Properties
-
-- [pageName](PageAccessRecord.md#pagename)
-- [operation](PageAccessRecord.md#operation)
-- [userId](PageAccessRecord.md#userid)
-- [scope](PageAccessRecord.md#scope)
-- [allowed](PageAccessRecord.md#allowed)
-- [timestamp](PageAccessRecord.md#timestamp)
-- [pageId](PageAccessRecord.md#pageid)
-
-## Properties
-
-### pageName
-
-• **pageName**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L89)
-
-___
-
-### operation
-
-• **operation**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:90](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L90)
-
-___
-
-### userId
-
-• **userId**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:91](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L91)
-
-___
-
-### scope
-
-• **scope**: [`Scope`](../modules.md#scope)
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L92)
-
-___
-
-### allowed
-
-• **allowed**: `boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:93](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L93)
-
-___
-
-### timestamp
-
-• **timestamp**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L94)
-
-___
-
-### pageId
-
-• `Optional` **pageId**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L95)

package/docs/api/interfaces/PagePermissionContextType.md

@@ -1,140 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / PagePermissionContextType
-
-# Interface: PagePermissionContextType
-
-## Table of contents
-
-### Properties
-
-- [hasPagePermission](PagePermissionContextType.md#haspagepermission)
-- [getPagePermissions](PagePermissionContextType.md#getpagepermissions)
-- [isEnabled](PagePermissionContextType.md#isenabled)
-- [isStrictMode](PagePermissionContextType.md#isstrictmode)
-- [isAuditLogEnabled](PagePermissionContextType.md#isauditlogenabled)
-- [getPageAccessHistory](PagePermissionContextType.md#getpageaccesshistory)
-- [clearPageAccessHistory](PagePermissionContextType.md#clearpageaccesshistory)
-
-## Properties
-
-### hasPagePermission
-
-• **hasPagePermission**: (`pageName`: `string`, `operation`: `string`, `pageId?`: `string`, `scope?`: [`Scope`](../modules.md#scope)) => `boolean`
-
-Check if user has permission for a page
-
-#### Type declaration
-
-▸ (`pageName`, `operation`, `pageId?`, `scope?`): `boolean`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `pageName` | `string` |
-| `operation` | `string` |
-| `pageId?` | `string` |
-| `scope?` | [`Scope`](../modules.md#scope) |
-
-##### Returns
-
-`boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L67)
-
-___
-
-### getPagePermissions
-
-• **getPagePermissions**: () => `Record`\<`string`, `string`[]\>
-
-Get all page permissions for current user
-
-#### Type declaration
-
-▸ (): `Record`\<`string`, `string`[]\>
-
-##### Returns
-
-`Record`\<`string`, `string`[]\>
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L70)
-
-___
-
-### isEnabled
-
-• **isEnabled**: `boolean`
-
-Check if page permission checking is enabled
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L73)
-
-___
-
-### isStrictMode
-
-• **isStrictMode**: `boolean`
-
-Check if strict mode is enabled
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:76](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L76)
-
-___
-
-### isAuditLogEnabled
-
-• **isAuditLogEnabled**: `boolean`
-
-Check if audit logging is enabled
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:79](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L79)
-
-___
-
-### getPageAccessHistory
-
-• **getPageAccessHistory**: () => [`PageAccessRecord`](PageAccessRecord.md)[]
-
-Get page access history
-
-#### Type declaration
-
-▸ (): [`PageAccessRecord`](PageAccessRecord.md)[]
-
-##### Returns
-
-[`PageAccessRecord`](PageAccessRecord.md)[]
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:82](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L82)
-
-___
-
-### clearPageAccessHistory
-
-• **clearPageAccessHistory**: () => `void`
-
-Clear page access history
-
-#### Type declaration
-
-▸ (): `void`
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L85)