@jmruthers/pace-core 0.6.2 → 0.6.4

package/docs/api/interfaces/RouteAccessRecord.md

@@ -1,107 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../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:109](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L109)
-
-___
-
-### permissions
-
-• **permissions**: (\`create:$\{string}\` \| \`read:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{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)
-
-___
-
-### userId
-
-• **userId**: `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)
-
-___
-
-### scope
-
-• **scope**: [`Scope`](../modules.md#scope)
-
-#### 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)
-
-___
-
-### allowed
-
-• **allowed**: `boolean`
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:113](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L113)
-
-___
-
-### timestamp
-
-• **timestamp**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:114](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L114)
-
-___
-
-### pageId
-
-• `Optional` **pageId**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:115](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L115)
-
-___
-
-### roles
-
-• `Optional` **roles**: `string`[]
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:116](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L116)
-
-___
-
-### accessLevel
-
-• `Optional` **accessLevel**: [`AccessLevel`](../modules.md#accesslevel)
-
-#### 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)

package/docs/api/interfaces/RouteConfig.md

@@ -1,134 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RouteConfig
-
-# Interface: RouteConfig
-
-## Table of contents
-
-### Properties
-
-- [path](RouteConfig.md#path)
-- [component](RouteConfig.md#component)
-- [permissions](RouteConfig.md#permissions)
-- [public](RouteConfig.md#public)
-- [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:76](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L76)
-
-___
-
-### component
-
-• **component**: `ComponentType`\<{}\>
-
-React component to render
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:79](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L79)
-
-___
-
-### permissions
-
-• **permissions**: (\`create:$\{string}\` \| \`read:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{string}\`)[]
-
-Permissions required for this route
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:82](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L82)
-
-___
-
-### public
-
-• `Optional` **public**: `boolean`
-
-If true, this route is public and doesn't require permission checks
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L85)
-
-___
-
-### roles
-
-• `Optional` **roles**: `string`[]
-
-Roles that can access this route
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L88)
-
-___
-
-### accessLevel
-
-• `Optional` **accessLevel**: [`AccessLevel`](../modules.md#accesslevel)
-
-Minimum access level required
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:91](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L91)
-
-___
-
-### pageId
-
-• `Optional` **pageId**: `string`
-
-Page ID for permission checking
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L94)
-
-___
-
-### strictMode
-
-• `Optional` **strictMode**: `boolean`
-
-Enable strict mode for this route
-
-#### Defined in
-
-[packages/core/src/rbac/components/RoleBasedRouter.tsx:97](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L97)
-
-___
-
-### 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:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/RoleBasedRouter.tsx#L100)

package/docs/api/interfaces/RuntimeComplianceResult.md

@@ -1,55 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / RuntimeComplianceResult
-
-# Interface: RuntimeComplianceResult
-
-## Table of contents
-
-### Properties
-
-- [setup](RuntimeComplianceResult.md#setup)
-- [warnings](RuntimeComplianceResult.md#warnings)
-- [providerContext](RuntimeComplianceResult.md#providercontext)
-
-## Properties
-
-### setup
-
-• **setup**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `isCompliant` | `boolean` |
-| `issues` | [`SetupIssue`](SetupIssue.md)[] |
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/runtime-compliance.ts:14](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/runtime-compliance.ts#L14)
-
-___
-
-### warnings
-
-• **warnings**: `string`[]
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/runtime-compliance.ts:18](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/runtime-compliance.ts#L18)
-
-___
-
-### providerContext
-
-• `Optional` **providerContext**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `available` | `boolean` |
-| `message?` | `string` |
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/runtime-compliance.ts:19](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/runtime-compliance.ts#L19)

package/docs/api/interfaces/SecureDataContextType.md

@@ -1,168 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../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:80](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L80)
-
-___
-
-### 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:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L83)
-
-___
-
-### isEnabled
-
-• **isEnabled**: `boolean`
-
-Check if secure data access 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)
-
-___
-
-### isStrictMode
-
-• **isStrictMode**: `boolean`
-
-Check if strict mode 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)
-
-___
-
-### isAuditLogEnabled
-
-• **isAuditLogEnabled**: `boolean`
-
-Check if audit logging is enabled
-
-#### 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)
-
-___
-
-### 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:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L95)
-
-___
-
-### clearDataAccessHistory
-
-• **clearDataAccessHistory**: () => `void`
-
-Clear data access history
-
-#### Type declaration
-
-▸ (): `void`
-
-##### Returns
-
-`void`
-
-#### 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)
-
-___
-
-### 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:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L101)

package/docs/api/interfaces/SecureDataProviderProps.md

@@ -1,132 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / SecureDataProviderProps
-
-# Interface: SecureDataProviderProps
-
-## Table of contents
-
-### Properties
-
-- [children](SecureDataProviderProps.md#children)
-- [strictMode](SecureDataProviderProps.md#strictmode)
-- [auditLog](SecureDataProviderProps.md#auditlog)
-- [onDataAccess](SecureDataProviderProps.md#ondataaccess)
-- [onStrictModeViolation](SecureDataProviderProps.md#onstrictmodeviolation)
-- [maxHistorySize](SecureDataProviderProps.md#maxhistorysize)
-- [enforceRLS](SecureDataProviderProps.md#enforcerls)
-
-## Properties
-
-### children
-
-• **children**: `ReactNode`
-
-Child components
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:106](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L106)
-
-___
-
-### strictMode
-
-• `Optional` **strictMode**: `boolean`
-
-Enable strict mode to prevent bypassing (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:109](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L109)
-
-___
-
-### auditLog
-
-• `Optional` **auditLog**: `boolean`
-
-Enable audit logging (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:112](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L112)
-
-___
-
-### onDataAccess
-
-• `Optional` **onDataAccess**: (`table`: `string`, `operation`: `string`, `allowed`: `boolean`, `record`: [`DataAccessRecord`](DataAccessRecord.md)) => `void`
-
-Callback when data access is attempted
-
-#### Type declaration
-
-▸ (`table`, `operation`, `allowed`, `record`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `table` | `string` |
-| `operation` | `string` |
-| `allowed` | `boolean` |
-| `record` | [`DataAccessRecord`](DataAccessRecord.md) |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:115](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L115)
-
-___
-
-### onStrictModeViolation
-
-• `Optional` **onStrictModeViolation**: (`table`: `string`, `operation`: `string`, `record`: [`DataAccessRecord`](DataAccessRecord.md)) => `void`
-
-Callback when strict mode violation occurs
-
-#### Type declaration
-
-▸ (`table`, `operation`, `record`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `table` | `string` |
-| `operation` | `string` |
-| `record` | [`DataAccessRecord`](DataAccessRecord.md) |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:118](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L118)
-
-___
-
-### maxHistorySize
-
-• `Optional` **maxHistorySize**: `number`
-
-Maximum number of access records to keep in history
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:121](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L121)
-
-___
-
-### enforceRLS
-
-• `Optional` **enforceRLS**: `boolean`
-
-Enable RLS enforcement (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/SecureDataProvider.tsx:124](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/SecureDataProvider.tsx#L124)

package/docs/api/interfaces/SessionRestorationLoaderProps.md

@@ -1,34 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / SessionRestorationLoaderProps
-
-# Interface: SessionRestorationLoaderProps
-
-## Table of contents
-
-### Properties
-
-- [message](SessionRestorationLoaderProps.md#message)
-- [className](SessionRestorationLoaderProps.md#classname)
-
-## Properties
-
-### message
-
-• `Optional` **message**: `string`
-
-Customise the status message displayed under the spinner
-
-#### Defined in
-
-[packages/core/src/components/SessionRestorationLoader/SessionRestorationLoader.tsx:45](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/SessionRestorationLoader/SessionRestorationLoader.tsx#L45)
-
-___
-
-### className
-
-• `Optional` **className**: `string`
-
-Additional CSS classes for styling
-
-#### Defined in
-
-[packages/core/src/components/SessionRestorationLoader/SessionRestorationLoader.tsx:47](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/SessionRestorationLoader/SessionRestorationLoader.tsx#L47)

package/docs/api/interfaces/SetupIssue.md

@@ -1,41 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / SetupIssue
-
-# Interface: SetupIssue
-
-## Table of contents
-
-### Properties
-
-- [type](SetupIssue.md#type)
-- [message](SetupIssue.md#message)
-- [recommendation](SetupIssue.md#recommendation)
-
-## Properties
-
-### type
-
-• **type**: ``"not-initialized"`` \| ``"missing-config"`` \| ``"invalid-config"`` \| ``"missing-provider-context"``
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/setup-validator.ts:14](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/setup-validator.ts#L14)
-
-___
-
-### message
-
-• **message**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/setup-validator.ts:15](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/setup-validator.ts#L15)
-
-___
-
-### recommendation
-
-• **recommendation**: `string`
-
-#### Defined in
-
-[packages/core/src/rbac/compliance/setup-validator.ts:16](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/compliance/setup-validator.ts#L16)