@jmruthers/pace-core 0.6.2 → 0.6.4

package/docs/api/interfaces/PagePermissionGuardProps.md

@@ -1,153 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../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:80](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L80)
-
-___
-
-### operation
-
-• **operation**: ``"create"`` \| ``"read"`` \| ``"update"`` \| ``"delete"``
-
-Operation being performed on the page
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionGuard.tsx:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L83)
-
-___
-
-### children
-
-• **children**: `ReactNode`
-
-Content to render when user has permission
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionGuard.tsx:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L86)
-
-___
-
-### fallback
-
-• `Optional` **fallback**: `ReactNode`
-
-Content to render when user lacks permission
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionGuard.tsx:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L89)
-
-___
-
-### strictMode
-
-• `Optional` **strictMode**: `boolean`
-
-Enable strict mode to prevent bypassing (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionGuard.tsx:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L92)
-
-___
-
-### auditLog
-
-• `Optional` **auditLog**: `boolean`
-
-Force audit logging for this page access (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionGuard.tsx:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L95)
-
-___
-
-### pageId
-
-• `Optional` **pageId**: `string`
-
-Custom page ID for permission checking
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionGuard.tsx:98](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L98)
-
-___
-
-### scope
-
-• `Optional` **scope**: [`Scope`](../modules.md#scope)
-
-Custom scope for permission checking
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionGuard.tsx:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L101)
-
-___
-
-### 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:104](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L104)
-
-___
-
-### loading
-
-• `Optional` **loading**: `ReactNode`
-
-Loading state content
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionGuard.tsx:107](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L107)

package/docs/api/interfaces/PagePermissionProviderProps.md

@@ -1,119 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../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:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L100)
-
-___
-
-### strictMode
-
-• `Optional` **strictMode**: `boolean`
-
-Enable strict mode to prevent bypassing (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:103](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L103)
-
-___
-
-### auditLog
-
-• `Optional` **auditLog**: `boolean`
-
-Enable audit logging (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:106](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L106)
-
-___
-
-### 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:109](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L109)
-
-___
-
-### 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:112](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L112)
-
-___
-
-### maxHistorySize
-
-• `Optional` **maxHistorySize**: `number`
-
-Maximum number of access records to keep in history
-
-#### Defined in
-
-[packages/core/src/rbac/components/PagePermissionProvider.tsx:115](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionProvider.tsx#L115)

package/docs/api/interfaces/PaletteData.md

@@ -1,41 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / PaletteData
-
-# Interface: PaletteData
-
-## Table of contents
-
-### Properties
-
-- [main](PaletteData.md#main)
-- [sec](PaletteData.md#sec)
-- [acc](PaletteData.md#acc)
-
-## Properties
-
-### main
-
-• **main**: [`ColorPalette`](ColorPalette.md)
-
-#### Defined in
-
-[packages/core/src/theming/runtime.ts:52](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/theming/runtime.ts#L52)
-
-___
-
-### sec
-
-• **sec**: [`ColorPalette`](ColorPalette.md)
-
-#### Defined in
-
-[packages/core/src/theming/runtime.ts:53](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/theming/runtime.ts#L53)
-
-___
-
-### acc
-
-• **acc**: [`ColorPalette`](ColorPalette.md)
-
-#### Defined in
-
-[packages/core/src/theming/runtime.ts:54](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/theming/runtime.ts#L54)

package/docs/api/interfaces/ParsedAddress.md

@@ -1,120 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / ParsedAddress
-
-# Interface: ParsedAddress
-
-Parsed address matching core_address table structure
-
-## Table of contents
-
-### Properties
-
-- [place\_id](ParsedAddress.md#place_id)
-- [full\_address](ParsedAddress.md#full_address)
-- [street\_number](ParsedAddress.md#street_number)
-- [route](ParsedAddress.md#route)
-- [suburb](ParsedAddress.md#suburb)
-- [state](ParsedAddress.md#state)
-- [postcode](ParsedAddress.md#postcode)
-- [country](ParsedAddress.md#country)
-- [lat](ParsedAddress.md#lat)
-- [lng](ParsedAddress.md#lng)
-
-## Properties
-
-### place\_id
-
-• **place\_id**: `string`
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L67)
-
-___
-
-### full\_address
-
-• **full\_address**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L68)
-
-___
-
-### street\_number
-
-• **street\_number**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L69)
-
-___
-
-### route
-
-• **route**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L70)
-
-___
-
-### suburb
-
-• **suburb**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L71)
-
-___
-
-### state
-
-• **state**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L72)
-
-___
-
-### postcode
-
-• **postcode**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L73)
-
-___
-
-### country
-
-• **country**: ``null`` \| `string`
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:74](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L74)
-
-___
-
-### lat
-
-• **lat**: ``null`` \| `number`
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:75](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L75)
-
-___
-
-### lng
-
-• **lng**: ``null`` \| `number`
-
-#### Defined in
-
-[packages/core/src/utils/google-places/types.ts:76](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L76)

package/docs/api/interfaces/PermissionEnforcerProps.md

@@ -1,153 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../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**: (\`create:$\{string}\` \| \`read:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{string}\`)[]
-
-Permissions required for access
-
-#### Defined in
-
-[packages/core/src/rbac/components/PermissionEnforcer.tsx:81](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L81)
-
-___
-
-### operation
-
-• **operation**: `string`
-
-Operation being performed
-
-#### Defined in
-
-[packages/core/src/rbac/components/PermissionEnforcer.tsx:84](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L84)
-
-___
-
-### children
-
-• **children**: `ReactNode`
-
-Content to render when user has permission
-
-#### Defined in
-
-[packages/core/src/rbac/components/PermissionEnforcer.tsx:87](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L87)
-
-___
-
-### fallback
-
-• `Optional` **fallback**: `ReactNode`
-
-Content to render when user lacks permission
-
-#### Defined in
-
-[packages/core/src/rbac/components/PermissionEnforcer.tsx:90](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L90)
-
-___
-
-### strictMode
-
-• `Optional` **strictMode**: `boolean`
-
-Enable strict mode to prevent bypassing (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/PermissionEnforcer.tsx:93](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L93)
-
-___
-
-### auditLog
-
-• `Optional` **auditLog**: `boolean`
-
-Force audit logging for this operation (default: true)
-
-#### Defined in
-
-[packages/core/src/rbac/components/PermissionEnforcer.tsx:96](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L96)
-
-___
-
-### scope
-
-• `Optional` **scope**: [`Scope`](../modules.md#scope)
-
-Custom scope for permission checking
-
-#### Defined in
-
-[packages/core/src/rbac/components/PermissionEnforcer.tsx:99](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L99)
-
-___
-
-### onDenied
-
-• `Optional` **onDenied**: (`permissions`: (\`create:$\{string}\` \| \`read:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{string}\`)[], `operation`: `string`) => `void`
-
-Callback when access is denied
-
-#### Type declaration
-
-▸ (`permissions`, `operation`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `permissions` | (\`create:$\{string}\` \| \`read:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{string}\`)[] |
-| `operation` | `string` |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[packages/core/src/rbac/components/PermissionEnforcer.tsx:102](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L102)
-
-___
-
-### loading
-
-• `Optional` **loading**: `ReactNode`
-
-Loading state content
-
-#### Defined in
-
-[packages/core/src/rbac/components/PermissionEnforcer.tsx:105](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L105)
-
-___
-
-### requireAll
-
-• `Optional` **requireAll**: `boolean`
-
-Require all permissions (AND) or any permission (OR)
-
-#### Defined in
-
-[packages/core/src/rbac/components/PermissionEnforcer.tsx:108](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PermissionEnforcer.tsx#L108)

package/docs/api/interfaces/ProgressProps.md

@@ -1,42 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / ProgressProps
-
-# Interface: ProgressProps
-
-Props for the Progress component
-
-## Hierarchy
-
-- `HTMLAttributes`\<`HTMLProgressElement`\>
-
-  ↳ **`ProgressProps`**
-
-## Table of contents
-
-### Properties
-
-- [value](ProgressProps.md#value)
-- [max](ProgressProps.md#max)
-
-## Properties
-
-### value
-
-• `Optional` **value**: `number`
-
-Current progress value (0 to max). Omit for indeterminate state.
-
-#### Defined in
-
-[packages/core/src/components/Progress/Progress.tsx:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Progress/Progress.tsx#L72)
-
-___
-
-### max
-
-• `Optional` **max**: `number`
-
-Maximum progress value (default: 100)
-
-#### Defined in
-
-[packages/core/src/components/Progress/Progress.tsx:74](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Progress/Progress.tsx#L74)

package/docs/api/interfaces/ProtectedRouteProps.md

@@ -1,78 +0,0 @@
-[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / ProtectedRouteProps
-
-# Interface: ProtectedRouteProps
-
-Props for the ProtectedRoute component.
-
-## Table of contents
-
-### Properties
-
-- [requireEvent](ProtectedRouteProps.md#requireevent)
-- [noEventsFallback](ProtectedRouteProps.md#noeventsfallback)
-- [loadingFallback](ProtectedRouteProps.md#loadingfallback)
-- [loginPath](ProtectedRouteProps.md#loginpath)
-
-## Properties
-
-### requireEvent
-
-• `Optional` **requireEvent**: `boolean`
-
-Whether an event is required for routes inside this component.
-When true, routes will only render if an event is selected or can be selected.
-When false, routes render regardless of event state.
-
-**`Default`**
-
-```ts
-true
-```
-
-#### Defined in
-
-[packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx#L92)
-
-___
-
-### noEventsFallback
-
-• `Optional` **noEventsFallback**: `ReactNode`
-
-Custom component to render when no events are available.
-If not provided, a default message is shown.
-
-#### Defined in
-
-[packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx:98](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx#L98)
-
-___
-
-### loadingFallback
-
-• `Optional` **loadingFallback**: `ReactNode`
-
-Custom component to render while events are loading.
-If not provided, a default loading spinner is shown.
-
-#### Defined in
-
-[packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx:104](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx#L104)
-
-___
-
-### loginPath
-
-• `Optional` **loginPath**: `string`
-
-Login redirect path when user is not authenticated.
-
-**`Default`**
-
-```ts
-'/login'
-```
-
-#### Defined in
-
-[packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx:110](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx#L110)