@jmruthers/pace-core 0.5.1 → 0.5.4

package/docs/api/interfaces/RoleBasedRouterContextType.md

@@ -0,0 +1,151 @@
+[@jmruthers/pace-core - v0.5.4](../README.md) / [Exports](../modules.md) / RoleBasedRouterContextType
+
+# Interface: RoleBasedRouterContextType
+
+## Table of contents
+
+### Properties
+
+- [getAccessibleRoutes](RoleBasedRouterContextType.md#getaccessibleroutes)
+- [canAccessRoute](RoleBasedRouterContextType.md#canaccessroute)
+- [getRouteConfig](RoleBasedRouterContextType.md#getrouteconfig)
+- [getRouteAccessHistory](RoleBasedRouterContextType.md#getrouteaccesshistory)
+- [clearRouteAccessHistory](RoleBasedRouterContextType.md#clearrouteaccesshistory)
+- [isStrictMode](RoleBasedRouterContextType.md#isstrictmode)
+- [isAuditLogEnabled](RoleBasedRouterContextType.md#isauditlogenabled)
+
+## Properties
+
+### getAccessibleRoutes
+
+• **getAccessibleRoutes**: () => [`RouteConfig`](RouteConfig.md)[]
+
+Get all accessible routes for current user
+
+#### Type declaration
+
+▸ (): [`RouteConfig`](RouteConfig.md)[]
+
+##### Returns
+
+[`RouteConfig`](RouteConfig.md)[]
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:117](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L117)
+
+___
+
+### canAccessRoute
+
+• **canAccessRoute**: (`path`: `string`) => `boolean`
+
+Check if user can access a specific route
+
+#### Type declaration
+
+▸ (`path`): `boolean`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+
+##### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:120](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L120)
+
+___
+
+### getRouteConfig
+
+• **getRouteConfig**: (`path`: `string`) => ``null`` \| [`RouteConfig`](RouteConfig.md)
+
+Get route configuration for a path
+
+#### Type declaration
+
+▸ (`path`): ``null`` \| [`RouteConfig`](RouteConfig.md)
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `path` | `string` |
+
+##### Returns
+
+``null`` \| [`RouteConfig`](RouteConfig.md)
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:123](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L123)
+
+___
+
+### getRouteAccessHistory
+
+• **getRouteAccessHistory**: () => [`RouteAccessRecord`](RouteAccessRecord.md)[]
+
+Get route access history
+
+#### Type declaration
+
+▸ (): [`RouteAccessRecord`](RouteAccessRecord.md)[]
+
+##### Returns
+
+[`RouteAccessRecord`](RouteAccessRecord.md)[]
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:126](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L126)
+
+___
+
+### clearRouteAccessHistory
+
+• **clearRouteAccessHistory**: () => `void`
+
+Clear route access history
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:129](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L129)
+
+___
+
+### isStrictMode
+
+• **isStrictMode**: `boolean`
+
+Check if strict mode is enabled
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:132](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L132)
+
+___
+
+### isAuditLogEnabled
+
+• **isAuditLogEnabled**: `boolean`
+
+Check if audit logging is enabled
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:135](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L135)

package/docs/api/interfaces/RoleBasedRouterProps.md

@@ -0,0 +1,156 @@
+[@jmruthers/pace-core - v0.5.4](../README.md) / [Exports](../modules.md) / RoleBasedRouterProps
+
+# Interface: RoleBasedRouterProps
+
+## Table of contents
+
+### Properties
+
+- [routes](RoleBasedRouterProps.md#routes)
+- [fallbackRoute](RoleBasedRouterProps.md#fallbackroute)
+- [children](RoleBasedRouterProps.md#children)
+- [strictMode](RoleBasedRouterProps.md#strictmode)
+- [auditLog](RoleBasedRouterProps.md#auditlog)
+- [onRouteAccess](RoleBasedRouterProps.md#onrouteaccess)
+- [onStrictModeViolation](RoleBasedRouterProps.md#onstrictmodeviolation)
+- [maxHistorySize](RoleBasedRouterProps.md#maxhistorysize)
+- [unauthorizedComponent](RoleBasedRouterProps.md#unauthorizedcomponent)
+
+## Properties
+
+### routes
+
+• **routes**: [`RouteConfig`](RouteConfig.md)[]
+
+Route configuration
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:140](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L140)
+
+___
+
+### fallbackRoute
+
+• `Optional` **fallbackRoute**: `string`
+
+Fallback route for unauthorized access
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:143](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L143)
+
+___
+
+### children
+
+• **children**: `ReactNode`
+
+Child components
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:146](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L146)
+
+___
+
+### strictMode
+
+• `Optional` **strictMode**: `boolean`
+
+Enable strict mode to prevent bypassing (default: true)
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:149](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L149)
+
+___
+
+### auditLog
+
+• `Optional` **auditLog**: `boolean`
+
+Enable audit logging (default: true)
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:152](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L152)
+
+___
+
+### onRouteAccess
+
+• `Optional` **onRouteAccess**: (`route`: `string`, `allowed`: `boolean`, `record`: [`RouteAccessRecord`](RouteAccessRecord.md)) => `void`
+
+Callback when route access is attempted
+
+#### Type declaration
+
+▸ (`route`, `allowed`, `record`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `route` | `string` |
+| `allowed` | `boolean` |
+| `record` | [`RouteAccessRecord`](RouteAccessRecord.md) |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:155](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L155)
+
+___
+
+### onStrictModeViolation
+
+• `Optional` **onStrictModeViolation**: (`route`: `string`, `record`: [`RouteAccessRecord`](RouteAccessRecord.md)) => `void`
+
+Callback when strict mode violation occurs
+
+#### Type declaration
+
+▸ (`route`, `record`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `route` | `string` |
+| `record` | [`RouteAccessRecord`](RouteAccessRecord.md) |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:158](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L158)
+
+___
+
+### maxHistorySize
+
+• `Optional` **maxHistorySize**: `number`
+
+Maximum number of access records to keep in history
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:161](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L161)
+
+___
+
+### unauthorizedComponent
+
+• `Optional` **unauthorizedComponent**: `ComponentType`\<\{ `route`: `string` ; `reason`: `string`  }\>
+
+Custom unauthorized component
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:164](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L164)

package/docs/api/interfaces/RouteAccessRecord.md

@@ -0,0 +1,107 @@
+[@jmruthers/pace-core - v0.5.4](../README.md) / [Exports](../modules.md) / RouteAccessRecord
+
+# Interface: RouteAccessRecord
+
+## Table of contents
+
+### Properties
+
+- [route](RouteAccessRecord.md#route)
+- [permissions](RouteAccessRecord.md#permissions)
+- [userId](RouteAccessRecord.md#userid)
+- [scope](RouteAccessRecord.md#scope)
+- [allowed](RouteAccessRecord.md#allowed)
+- [timestamp](RouteAccessRecord.md#timestamp)
+- [pageId](RouteAccessRecord.md#pageid)
+- [roles](RouteAccessRecord.md#roles)
+- [accessLevel](RouteAccessRecord.md#accesslevel)
+
+## Properties
+
+### route
+
+• **route**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:104](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L104)
+
+___
+
+### permissions
+
+• **permissions**: (\`read:$\{string}\` \| \`create:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{string}\` \| \`manage:$\{string}\`)[]
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:105](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L105)
+
+___
+
+### userId
+
+• **userId**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:106](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L106)
+
+___
+
+### scope
+
+• **scope**: [`Scope`](../modules.md#scope)
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:107](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L107)
+
+___
+
+### allowed
+
+• **allowed**: `boolean`
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:108](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L108)
+
+___
+
+### timestamp
+
+• **timestamp**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:109](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L109)
+
+___
+
+### pageId
+
+• `Optional` **pageId**: `string`
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:110](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L110)
+
+___
+
+### roles
+
+• `Optional` **roles**: `string`[]
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:111](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L111)
+
+___
+
+### accessLevel
+
+• `Optional` **accessLevel**: [`AccessLevel`](../modules.md#accesslevel)
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:112](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L112)

package/docs/api/interfaces/RouteConfig.md

@@ -0,0 +1,121 @@
+[@jmruthers/pace-core - v0.5.4](../README.md) / [Exports](../modules.md) / RouteConfig
+
+# Interface: RouteConfig
+
+## Table of contents
+
+### Properties
+
+- [path](RouteConfig.md#path)
+- [component](RouteConfig.md#component)
+- [permissions](RouteConfig.md#permissions)
+- [roles](RouteConfig.md#roles)
+- [accessLevel](RouteConfig.md#accesslevel)
+- [pageId](RouteConfig.md#pageid)
+- [strictMode](RouteConfig.md#strictmode)
+- [meta](RouteConfig.md#meta)
+
+## Properties
+
+### path
+
+• **path**: `string`
+
+Route path
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:74](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L74)
+
+___
+
+### component
+
+• **component**: `ComponentType`\<{}\>
+
+React component to render
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L77)
+
+___
+
+### permissions
+
+• **permissions**: (\`read:$\{string}\` \| \`create:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{string}\` \| \`manage:$\{string}\`)[]
+
+Permissions required for this route
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:80](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L80)
+
+___
+
+### roles
+
+• `Optional` **roles**: `string`[]
+
+Roles that can access this route
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L83)
+
+___
+
+### accessLevel
+
+• `Optional` **accessLevel**: [`AccessLevel`](../modules.md#accesslevel)
+
+Minimum access level required
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L86)
+
+___
+
+### pageId
+
+• `Optional` **pageId**: `string`
+
+Page ID for permission checking
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L89)
+
+___
+
+### strictMode
+
+• `Optional` **strictMode**: `boolean`
+
+Enable strict mode for this route
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L92)
+
+___
+
+### meta
+
+• `Optional` **meta**: `Object`
+
+Route metadata
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `title?` | `string` |
+| `description?` | `string` |
+| `requiresAuth?` | `boolean` |
+| `hidden?` | `boolean` |
+
+#### Defined in
+
+[packages/core/src/rbac/components/RoleBasedRouter.tsx:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L95)

package/docs/api/interfaces/SecureDataContextType.md

@@ -0,0 +1,168 @@
+[@jmruthers/pace-core - v0.5.4](../README.md) / [Exports](../modules.md) / SecureDataContextType
+
+# Interface: SecureDataContextType
+
+## Table of contents
+
+### Properties
+
+- [isDataAccessAllowed](SecureDataContextType.md#isdataaccessallowed)
+- [getDataAccessPermissions](SecureDataContextType.md#getdataaccesspermissions)
+- [isEnabled](SecureDataContextType.md#isenabled)
+- [isStrictMode](SecureDataContextType.md#isstrictmode)
+- [isAuditLogEnabled](SecureDataContextType.md#isauditlogenabled)
+- [getDataAccessHistory](SecureDataContextType.md#getdataaccesshistory)
+- [clearDataAccessHistory](SecureDataContextType.md#cleardataaccesshistory)
+- [validateDataAccess](SecureDataContextType.md#validatedataaccess)
+
+## Properties
+
+### isDataAccessAllowed
+
+• **isDataAccessAllowed**: (`table`: `string`, `operation`: `string`, `scope?`: [`Scope`](../modules.md#scope)) => `boolean`
+
+Check if data access is allowed for a table and operation
+
+#### Type declaration
+
+▸ (`table`, `operation`, `scope?`): `boolean`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `table` | `string` |
+| `operation` | `string` |
+| `scope?` | [`Scope`](../modules.md#scope) |
+
+##### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L77)
+
+___
+
+### getDataAccessPermissions
+
+• **getDataAccessPermissions**: () => `Record`\<`string`, `string`[]\>
+
+Get all data access permissions for current user
+
+#### Type declaration
+
+▸ (): `Record`\<`string`, `string`[]\>
+
+##### Returns
+
+`Record`\<`string`, `string`[]\>
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:80](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L80)
+
+___
+
+### isEnabled
+
+• **isEnabled**: `boolean`
+
+Check if secure data access is enabled
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L83)
+
+___
+
+### isStrictMode
+
+• **isStrictMode**: `boolean`
+
+Check if strict mode is enabled
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L86)
+
+___
+
+### isAuditLogEnabled
+
+• **isAuditLogEnabled**: `boolean`
+
+Check if audit logging is enabled
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L89)
+
+___
+
+### getDataAccessHistory
+
+• **getDataAccessHistory**: () => [`DataAccessRecord`](DataAccessRecord.md)[]
+
+Get data access history
+
+#### Type declaration
+
+▸ (): [`DataAccessRecord`](DataAccessRecord.md)[]
+
+##### Returns
+
+[`DataAccessRecord`](DataAccessRecord.md)[]
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L92)
+
+___
+
+### clearDataAccessHistory
+
+• **clearDataAccessHistory**: () => `void`
+
+Clear data access history
+
+#### Type declaration
+
+▸ (): `void`
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L95)
+
+___
+
+### validateDataAccess
+
+• **validateDataAccess**: (`table`: `string`, `operation`: `string`, `scope?`: [`Scope`](../modules.md#scope)) => `boolean`
+
+Validate data access attempt
+
+#### Type declaration
+
+▸ (`table`, `operation`, `scope?`): `boolean`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `table` | `string` |
+| `operation` | `string` |
+| `scope?` | [`Scope`](../modules.md#scope) |
+
+##### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/core/src/rbac/components/SecureDataProvider.tsx:98](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L98)