@jmruthers/pace-core 0.5.1 → 0.5.3

package/docs/api/interfaces/EnhancedNavigationMenuProps.md

@@ -0,0 +1,235 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / EnhancedNavigationMenuProps
+
+# Interface: EnhancedNavigationMenuProps
+
+## Table of contents
+
+### Properties
+
+- [items](EnhancedNavigationMenuProps.md#items)
+- [strictMode](EnhancedNavigationMenuProps.md#strictmode)
+- [auditLog](EnhancedNavigationMenuProps.md#auditlog)
+- [onNavigationAccess](EnhancedNavigationMenuProps.md#onnavigationaccess)
+- [onStrictModeViolation](EnhancedNavigationMenuProps.md#onstrictmodeviolation)
+- [className](EnhancedNavigationMenuProps.md#classname)
+- [itemClassName](EnhancedNavigationMenuProps.md#itemclassname)
+- [activeItemClassName](EnhancedNavigationMenuProps.md#activeitemclassname)
+- [disabledItemClassName](EnhancedNavigationMenuProps.md#disableditemclassname)
+- [hideUnauthorizedItems](EnhancedNavigationMenuProps.md#hideunauthorizeditems)
+- [renderItem](EnhancedNavigationMenuProps.md#renderitem)
+- [activePath](EnhancedNavigationMenuProps.md#activepath)
+- [onItemClick](EnhancedNavigationMenuProps.md#onitemclick)
+
+## Properties
+
+### items
+
+• **items**: `NavigationItem`[]
+
+Navigation items to display
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:64](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L64)
+
+___
+
+### strictMode
+
+• `Optional` **strictMode**: `boolean`
+
+Enable strict mode to prevent bypassing (default: true)
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L67)
+
+___
+
+### auditLog
+
+• `Optional` **auditLog**: `boolean`
+
+Enable audit logging (default: true)
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L70)
+
+___
+
+### onNavigationAccess
+
+• `Optional` **onNavigationAccess**: (`item`: `NavigationItem`, `allowed`: `boolean`) => `void`
+
+Callback when navigation access is attempted
+
+#### Type declaration
+
+▸ (`item`, `allowed`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `item` | `NavigationItem` |
+| `allowed` | `boolean` |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L73)
+
+___
+
+### onStrictModeViolation
+
+• `Optional` **onStrictModeViolation**: (`item`: `NavigationItem`) => `void`
+
+Callback when strict mode violation occurs
+
+#### Type declaration
+
+▸ (`item`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `item` | `NavigationItem` |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:76](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L76)
+
+___
+
+### className
+
+• `Optional` **className**: `string`
+
+Custom className for the navigation menu
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:79](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L79)
+
+___
+
+### itemClassName
+
+• `Optional` **itemClassName**: `string`
+
+Custom className for navigation items
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:82](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L82)
+
+___
+
+### activeItemClassName
+
+• `Optional` **activeItemClassName**: `string`
+
+Custom className for active navigation items
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L85)
+
+___
+
+### disabledItemClassName
+
+• `Optional` **disabledItemClassName**: `string`
+
+Custom className for disabled navigation items
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L88)
+
+___
+
+### hideUnauthorizedItems
+
+• `Optional` **hideUnauthorizedItems**: `boolean`
+
+Show/hide navigation items that user doesn't have permission for
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:91](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L91)
+
+___
+
+### renderItem
+
+• `Optional` **renderItem**: (`item`: `NavigationItem`, `isAuthorized`: `boolean`) => `ReactNode`
+
+Custom render function for navigation items
+
+#### Type declaration
+
+▸ (`item`, `isAuthorized`): `ReactNode`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `item` | `NavigationItem` |
+| `isAuthorized` | `boolean` |
+
+##### Returns
+
+`ReactNode`
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L94)
+
+___
+
+### activePath
+
+• `Optional` **activePath**: `string`
+
+Current active path for highlighting
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:97](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L97)
+
+___
+
+### onItemClick
+
+• `Optional` **onItemClick**: (`item`: `NavigationItem`) => `void`
+
+Navigation item click handler
+
+#### Type declaration
+
+▸ (`item`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `item` | `NavigationItem` |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/EnhancedNavigationMenu.tsx:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/EnhancedNavigationMenu.tsx#L100)

package/docs/api/interfaces/EventContextType.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / EventContextType
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / EventContextType
 
 # Interface: EventContextType
 

package/docs/api/interfaces/EventLogoProps.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / EventLogoProps
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / EventLogoProps
 
 # Interface: EventLogoProps
 

package/docs/api/interfaces/EventProviderProps.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / EventProviderProps
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / EventProviderProps
 
 # Interface: EventProviderProps
 

package/docs/api/interfaces/FileSizeLimits.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / FileSizeLimits
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / FileSizeLimits
 
 # Interface: FileSizeLimits
 

package/docs/api/interfaces/FileUploadProps.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / FileUploadProps
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / FileUploadProps
 
 # Interface: FileUploadProps
 

package/docs/api/interfaces/FooterProps.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / FooterProps
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / FooterProps
 
 # Interface: FooterProps
 

package/docs/api/interfaces/InactivityWarningModalProps.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / InactivityWarningModalProps
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / InactivityWarningModalProps
 
 # Interface: InactivityWarningModalProps
 

package/docs/api/interfaces/InputProps.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / InputProps
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / InputProps
 
 # Interface: InputProps
 

package/docs/api/interfaces/LabelProps.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / LabelProps
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / LabelProps
 
 # Interface: LabelProps
 

package/docs/api/interfaces/LoginFormProps.md

@@ -1,4 +1,4 @@
-[@jmruthers/pace-core - v0.5.1](../README.md) / [Exports](../modules.md) / LoginFormProps
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / LoginFormProps
 
 # Interface: LoginFormProps
 

package/docs/api/interfaces/NavigationAccessRecord.md

@@ -0,0 +1,107 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / NavigationAccessRecord
+
+# Interface: NavigationAccessRecord
+
+## Table of contents
+
+### Properties
+
+- [navigationItem](NavigationAccessRecord.md#navigationitem)
+- [permissions](NavigationAccessRecord.md#permissions)
+- [userId](NavigationAccessRecord.md#userid)
+- [scope](NavigationAccessRecord.md#scope)
+- [allowed](NavigationAccessRecord.md#allowed)
+- [timestamp](NavigationAccessRecord.md#timestamp)
+- [pageId](NavigationAccessRecord.md#pageid)
+- [roles](NavigationAccessRecord.md#roles)
+- [accessLevel](NavigationAccessRecord.md#accesslevel)
+
+## Properties
+
+### navigationItem
+
+• **navigationItem**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:96](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L96)
+
+___
+
+### permissions
+
+• **permissions**: (\`read:$\{string}\` \| \`create:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{string}\` \| \`manage:$\{string}\`)[]
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:97](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L97)
+
+___
+
+### userId
+
+• **userId**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:98](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L98)
+
+___
+
+### scope
+
+• **scope**: [`Scope`](../modules.md#scope)
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:99](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L99)
+
+___
+
+### allowed
+
+• **allowed**: `boolean`
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L100)
+
+___
+
+### timestamp
+
+• **timestamp**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L101)
+
+___
+
+### pageId
+
+• `Optional` **pageId**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:102](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L102)
+
+___
+
+### roles
+
+• `Optional` **roles**: `string`[]
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:103](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L103)
+
+___
+
+### accessLevel
+
+• `Optional` **accessLevel**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:104](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L104)

package/docs/api/interfaces/NavigationContextType.md

@@ -0,0 +1,164 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / NavigationContextType
+
+# Interface: NavigationContextType
+
+## Table of contents
+
+### Properties
+
+- [hasNavigationPermission](NavigationContextType.md#hasnavigationpermission)
+- [getNavigationPermissions](NavigationContextType.md#getnavigationpermissions)
+- [getFilteredNavigationItems](NavigationContextType.md#getfilterednavigationitems)
+- [isEnabled](NavigationContextType.md#isenabled)
+- [isStrictMode](NavigationContextType.md#isstrictmode)
+- [isAuditLogEnabled](NavigationContextType.md#isauditlogenabled)
+- [getNavigationAccessHistory](NavigationContextType.md#getnavigationaccesshistory)
+- [clearNavigationAccessHistory](NavigationContextType.md#clearnavigationaccesshistory)
+
+## Properties
+
+### hasNavigationPermission
+
+• **hasNavigationPermission**: (`item`: `NavigationItem`) => `boolean`
+
+Check if user has permission for a navigation item
+
+#### Type declaration
+
+▸ (`item`): `boolean`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `item` | `NavigationItem` |
+
+##### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:109](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L109)
+
+___
+
+### getNavigationPermissions
+
+• **getNavigationPermissions**: () => `Record`\<`string`, `string`[]\>
+
+Get all navigation permissions for current user
+
+#### Type declaration
+
+▸ (): `Record`\<`string`, `string`[]\>
+
+##### Returns
+
+`Record`\<`string`, `string`[]\>
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:112](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L112)
+
+___
+
+### getFilteredNavigationItems
+
+• **getFilteredNavigationItems**: (`items`: `NavigationItem`[]) => `NavigationItem`[]
+
+Get filtered navigation items based on permissions
+
+#### Type declaration
+
+▸ (`items`): `NavigationItem`[]
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `items` | `NavigationItem`[] |
+
+##### Returns
+
+`NavigationItem`[]
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:115](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L115)
+
+___
+
+### isEnabled
+
+• **isEnabled**: `boolean`
+
+Check if navigation permission checking is enabled
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:118](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L118)
+
+___
+
+### isStrictMode
+
+• **isStrictMode**: `boolean`
+
+Check if strict mode is enabled
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:121](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L121)
+
+___
+
+### isAuditLogEnabled
+
+• **isAuditLogEnabled**: `boolean`
+
+Check if audit logging is enabled
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:124](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L124)
+
+___
+
+### getNavigationAccessHistory
+
+• **getNavigationAccessHistory**: () => [`NavigationAccessRecord`](NavigationAccessRecord.md)[]
+
+Get navigation access history
+
+#### Type declaration
+
+▸ (): [`NavigationAccessRecord`](NavigationAccessRecord.md)[]
+
+##### Returns
+
+[`NavigationAccessRecord`](NavigationAccessRecord.md)[]
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:127](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L127)
+
+___
+
+### clearNavigationAccessHistory
+
+• **clearNavigationAccessHistory**: () => `void`
+
+Clear navigation access history
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/NavigationProvider.tsx:130](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L130)