@jmruthers/pace-core 0.4.1 → 0.5.3

package/docs/api/interfaces/PagePermissionContextType.md

@@ -0,0 +1,140 @@
+[@jmruthers/pace-core - v0.5.3](../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:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L63)
+
+___
+
+### 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:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L66)
+
+___
+
+### isEnabled
+
+• **isEnabled**: `boolean`
+
+Check if page permission checking is enabled
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionProvider.tsx:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L69)
+
+___
+
+### isStrictMode
+
+• **isStrictMode**: `boolean`
+
+Check if strict mode is enabled
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionProvider.tsx:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L72)
+
+___
+
+### isAuditLogEnabled
+
+• **isAuditLogEnabled**: `boolean`
+
+Check if audit logging is enabled
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionProvider.tsx:75](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L75)
+
+___
+
+### 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:78](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L78)
+
+___
+
+### clearPageAccessHistory
+
+• **clearPageAccessHistory**: () => `void`
+
+Clear page access history
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionProvider.tsx:81](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L81)

package/docs/api/interfaces/PagePermissionGuardProps.md

@@ -0,0 +1,153 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / PagePermissionGuardProps
+
+# Interface: PagePermissionGuardProps
+
+## Table of contents
+
+### Properties
+
+- [pageName](PagePermissionGuardProps.md#pagename)
+- [operation](PagePermissionGuardProps.md#operation)
+- [children](PagePermissionGuardProps.md#children)
+- [fallback](PagePermissionGuardProps.md#fallback)
+- [strictMode](PagePermissionGuardProps.md#strictmode)
+- [auditLog](PagePermissionGuardProps.md#auditlog)
+- [pageId](PagePermissionGuardProps.md#pageid)
+- [scope](PagePermissionGuardProps.md#scope)
+- [onDenied](PagePermissionGuardProps.md#ondenied)
+- [loading](PagePermissionGuardProps.md#loading)
+
+## Properties
+
+### pageName
+
+• **pageName**: `string`
+
+Name of the page being protected
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionGuard.tsx:79](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L79)
+
+___
+
+### operation
+
+• **operation**: ``"read"`` \| ``"create"`` \| ``"update"`` \| ``"delete"``
+
+Operation being performed on the page
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionGuard.tsx:82](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L82)
+
+___
+
+### children
+
+• **children**: `ReactNode`
+
+Content to render when user has permission
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionGuard.tsx:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L85)
+
+___
+
+### fallback
+
+• `Optional` **fallback**: `ReactNode`
+
+Content to render when user lacks permission
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionGuard.tsx:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L88)
+
+___
+
+### strictMode
+
+• `Optional` **strictMode**: `boolean`
+
+Enable strict mode to prevent bypassing (default: true)
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionGuard.tsx:91](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L91)
+
+___
+
+### auditLog
+
+• `Optional` **auditLog**: `boolean`
+
+Force audit logging for this page access (default: true)
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionGuard.tsx:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L94)
+
+___
+
+### pageId
+
+• `Optional` **pageId**: `string`
+
+Custom page ID for permission checking
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionGuard.tsx:97](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L97)
+
+___
+
+### scope
+
+• `Optional` **scope**: [`Scope`](../modules.md#scope)
+
+Custom scope for permission checking
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionGuard.tsx:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L100)
+
+___
+
+### onDenied
+
+• `Optional` **onDenied**: (`pageName`: `string`, `operation`: `string`) => `void`
+
+Callback when access is denied
+
+#### Type declaration
+
+▸ (`pageName`, `operation`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `pageName` | `string` |
+| `operation` | `string` |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionGuard.tsx:103](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L103)
+
+___
+
+### loading
+
+• `Optional` **loading**: `ReactNode`
+
+Loading state content
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionGuard.tsx:106](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L106)

package/docs/api/interfaces/PagePermissionProviderProps.md

@@ -0,0 +1,119 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / PagePermissionProviderProps
+
+# Interface: PagePermissionProviderProps
+
+## Table of contents
+
+### Properties
+
+- [children](PagePermissionProviderProps.md#children)
+- [strictMode](PagePermissionProviderProps.md#strictmode)
+- [auditLog](PagePermissionProviderProps.md#auditlog)
+- [onPageAccess](PagePermissionProviderProps.md#onpageaccess)
+- [onStrictModeViolation](PagePermissionProviderProps.md#onstrictmodeviolation)
+- [maxHistorySize](PagePermissionProviderProps.md#maxhistorysize)
+
+## Properties
+
+### children
+
+• **children**: `ReactNode`
+
+Child components
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionProvider.tsx:96](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L96)
+
+___
+
+### strictMode
+
+• `Optional` **strictMode**: `boolean`
+
+Enable strict mode to prevent bypassing (default: true)
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionProvider.tsx:99](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L99)
+
+___
+
+### auditLog
+
+• `Optional` **auditLog**: `boolean`
+
+Enable audit logging (default: true)
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionProvider.tsx:102](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L102)
+
+___
+
+### onPageAccess
+
+• `Optional` **onPageAccess**: (`pageName`: `string`, `operation`: `string`, `allowed`: `boolean`, `record`: [`PageAccessRecord`](PageAccessRecord.md)) => `void`
+
+Callback when page access is attempted
+
+#### Type declaration
+
+▸ (`pageName`, `operation`, `allowed`, `record`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `pageName` | `string` |
+| `operation` | `string` |
+| `allowed` | `boolean` |
+| `record` | [`PageAccessRecord`](PageAccessRecord.md) |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionProvider.tsx:105](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L105)
+
+___
+
+### onStrictModeViolation
+
+• `Optional` **onStrictModeViolation**: (`pageName`: `string`, `operation`: `string`, `record`: [`PageAccessRecord`](PageAccessRecord.md)) => `void`
+
+Callback when strict mode violation occurs
+
+#### Type declaration
+
+▸ (`pageName`, `operation`, `record`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `pageName` | `string` |
+| `operation` | `string` |
+| `record` | [`PageAccessRecord`](PageAccessRecord.md) |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionProvider.tsx:108](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L108)
+
+___
+
+### maxHistorySize
+
+• `Optional` **maxHistorySize**: `number`
+
+Maximum number of access records to keep in history
+
+#### Defined in
+
+[packages/core/src/rbac/components/PagePermissionProvider.tsx:111](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L111)

package/docs/api/interfaces/PaletteData.md

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

package/docs/api/interfaces/PermissionEnforcerProps.md

@@ -0,0 +1,153 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / PermissionEnforcerProps
+
+# Interface: PermissionEnforcerProps
+
+## Table of contents
+
+### Properties
+
+- [permissions](PermissionEnforcerProps.md#permissions)
+- [operation](PermissionEnforcerProps.md#operation)
+- [children](PermissionEnforcerProps.md#children)
+- [fallback](PermissionEnforcerProps.md#fallback)
+- [strictMode](PermissionEnforcerProps.md#strictmode)
+- [auditLog](PermissionEnforcerProps.md#auditlog)
+- [scope](PermissionEnforcerProps.md#scope)
+- [onDenied](PermissionEnforcerProps.md#ondenied)
+- [loading](PermissionEnforcerProps.md#loading)
+- [requireAll](PermissionEnforcerProps.md#requireall)
+
+## Properties
+
+### permissions
+
+• **permissions**: (\`read:$\{string}\` \| \`create:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{string}\` \| \`manage:$\{string}\`)[]
+
+Permissions required for access
+
+#### Defined in
+
+[packages/core/src/rbac/components/PermissionEnforcer.tsx:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L77)
+
+___
+
+### operation
+
+• **operation**: `string`
+
+Operation being performed
+
+#### Defined in
+
+[packages/core/src/rbac/components/PermissionEnforcer.tsx:80](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L80)
+
+___
+
+### children
+
+• **children**: `ReactNode`
+
+Content to render when user has permission
+
+#### Defined in
+
+[packages/core/src/rbac/components/PermissionEnforcer.tsx:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L83)
+
+___
+
+### fallback
+
+• `Optional` **fallback**: `ReactNode`
+
+Content to render when user lacks permission
+
+#### Defined in
+
+[packages/core/src/rbac/components/PermissionEnforcer.tsx:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L86)
+
+___
+
+### strictMode
+
+• `Optional` **strictMode**: `boolean`
+
+Enable strict mode to prevent bypassing (default: true)
+
+#### Defined in
+
+[packages/core/src/rbac/components/PermissionEnforcer.tsx:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L89)
+
+___
+
+### auditLog
+
+• `Optional` **auditLog**: `boolean`
+
+Force audit logging for this operation (default: true)
+
+#### Defined in
+
+[packages/core/src/rbac/components/PermissionEnforcer.tsx:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L92)
+
+___
+
+### scope
+
+• `Optional` **scope**: [`Scope`](../modules.md#scope)
+
+Custom scope for permission checking
+
+#### Defined in
+
+[packages/core/src/rbac/components/PermissionEnforcer.tsx:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L95)
+
+___
+
+### onDenied
+
+• `Optional` **onDenied**: (`permissions`: (\`read:$\{string}\` \| \`create:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{string}\` \| \`manage:$\{string}\`)[], `operation`: `string`) => `void`
+
+Callback when access is denied
+
+#### Type declaration
+
+▸ (`permissions`, `operation`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `permissions` | (\`read:$\{string}\` \| \`create:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{string}\` \| \`manage:$\{string}\`)[] |
+| `operation` | `string` |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/PermissionEnforcer.tsx:98](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L98)
+
+___
+
+### loading
+
+• `Optional` **loading**: `ReactNode`
+
+Loading state content
+
+#### Defined in
+
+[packages/core/src/rbac/components/PermissionEnforcer.tsx:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L101)
+
+___
+
+### requireAll
+
+• `Optional` **requireAll**: `boolean`
+
+Require all permissions (AND) or any permission (OR)
+
+#### Defined in
+
+[packages/core/src/rbac/components/PermissionEnforcer.tsx:104](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L104)

package/docs/api/interfaces/PublicErrorBoundaryProps.md

@@ -0,0 +1,94 @@
+[@jmruthers/pace-core - v0.5.3](../README.md) / [Exports](../modules.md) / PublicErrorBoundaryProps
+
+# Interface: PublicErrorBoundaryProps
+
+## Table of contents
+
+### Properties
+
+- [children](PublicErrorBoundaryProps.md#children)
+- [fallback](PublicErrorBoundaryProps.md#fallback)
+- [className](PublicErrorBoundaryProps.md#classname)
+- [showErrorDetails](PublicErrorBoundaryProps.md#showerrordetails)
+- [customErrorMessage](PublicErrorBoundaryProps.md#customerrormessage)
+- [onRecover](PublicErrorBoundaryProps.md#onrecover)
+
+## Properties
+
+### children
+
+• **children**: `ReactNode`
+
+Child components to wrap
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx:46](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx#L46)
+
+___
+
+### fallback
+
+• `Optional` **fallback**: `ComponentType`\<[`PublicErrorBoundaryState`](PublicErrorBoundaryState.md)\>
+
+Custom error fallback component
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx:48](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx#L48)
+
+___
+
+### className
+
+• `Optional` **className**: `string`
+
+Custom CSS classes for error display
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx:50](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx#L50)
+
+___
+
+### showErrorDetails
+
+• `Optional` **showErrorDetails**: `boolean`
+
+Whether to show error details in development
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx:52](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx#L52)
+
+___
+
+### customErrorMessage
+
+• `Optional` **customErrorMessage**: `string`
+
+Custom error message
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx:54](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx#L54)
+
+___
+
+### onRecover
+
+• `Optional` **onRecover**: () => `void`
+
+Custom recovery action
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx:56](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicErrorBoundary.tsx#L56)