@jmruthers/pace-core 0.6.11 → 0.6.12

package/docs/api/interfaces/PaceAppLayoutRoutingConfig.md

@@ -0,0 +1,79 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / PaceAppLayoutRoutingConfig
+
+# Interface: PaceAppLayoutRoutingConfig
+
+Defined in: [components/PaceAppLayout/PaceAppLayout.tsx:158](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L158)
+
+Optional grouped routing options. When provided, overrides flat routing props.
+
+## Properties
+
+### roleBasedRouting?
+
+> `optional` **roleBasedRouting**: `boolean`
+
+Defined in: [components/PaceAppLayout/PaceAppLayout.tsx:159](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L159)
+
+***
+
+### routeConfig?
+
+> `optional` **routeConfig**: [`PaceAppLayoutRouteConfigItem`](PaceAppLayoutRouteConfigItem.md)[]
+
+Defined in: [components/PaceAppLayout/PaceAppLayout.tsx:160](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L160)
+
+***
+
+### fallbackRoute?
+
+> `optional` **fallbackRoute**: `string`
+
+Defined in: [components/PaceAppLayout/PaceAppLayout.tsx:161](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L161)
+
+***
+
+### onRouteAccessDenied()?
+
+> `optional` **onRouteAccessDenied**: (`route`, `reason`) => `void`
+
+Defined in: [components/PaceAppLayout/PaceAppLayout.tsx:162](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L162)
+
+#### Parameters
+
+##### route
+
+`string`
+
+##### reason
+
+`string`
+
+#### Returns
+
+`void`
+
+***
+
+### onRouteStrictModeViolation()?
+
+> `optional` **onRouteStrictModeViolation**: (`route`, `reason`) => `void`
+
+Defined in: [components/PaceAppLayout/PaceAppLayout.tsx:163](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L163)
+
+#### Parameters
+
+##### route
+
+`string`
+
+##### reason
+
+`string`
+
+#### Returns
+
+`void`

package/docs/api/interfaces/PaceLoginPageProps.md

@@ -0,0 +1,41 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / PaceLoginPageProps
+
+# Interface: PaceLoginPageProps
+
+Defined in: [components/PaceLoginPage/PaceLoginPage.tsx:136](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceLoginPage/PaceLoginPage.tsx#L136)
+
+Props for the PaceLoginPage component.
+
+## Properties
+
+### appName
+
+> **appName**: `string`
+
+Defined in: [components/PaceLoginPage/PaceLoginPage.tsx:138](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceLoginPage/PaceLoginPage.tsx#L138)
+
+The name of the application to be displayed on the login form.
+
+***
+
+### onSuccessRedirectPath?
+
+> `optional` **onSuccessRedirectPath**: `string`
+
+Defined in: [components/PaceLoginPage/PaceLoginPage.tsx:140](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceLoginPage/PaceLoginPage.tsx#L140)
+
+The path to redirect to upon successful login. Defaults to `/`.
+
+***
+
+### requireAppAccess?
+
+> `optional` **requireAppAccess**: `boolean`
+
+Defined in: [components/PaceLoginPage/PaceLoginPage.tsx:142](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceLoginPage/PaceLoginPage.tsx#L142)
+
+Whether to check app access using RBAC. Defaults to false.

package/docs/api/interfaces/PagePermissionGuardProps.md

@@ -0,0 +1,143 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / PagePermissionGuardProps
+
+# Interface: PagePermissionGuardProps
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L83)
+
+## Properties
+
+### pageName
+
+> **pageName**: `string`
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L85)
+
+Name of the page being protected
+
+***
+
+### operation
+
+> **operation**: `"read"` \| `"create"` \| `"update"` \| `"delete"`
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L88)
+
+Operation being performed on the page
+
+***
+
+### children
+
+> **children**: `ReactNode`
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:91](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L91)
+
+Content to render when user has permission
+
+***
+
+### fallback?
+
+> `optional` **fallback**: `ReactNode`
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L94)
+
+Content to render when user lacks permission
+
+***
+
+### strictMode?
+
+> `optional` **strictMode**: `boolean`
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:97](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L97)
+
+Enable strict mode to prevent bypassing (default: true)
+
+***
+
+### auditLog?
+
+> `optional` **auditLog**: `boolean`
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L100)
+
+Force audit logging for this page access (default: true)
+
+***
+
+### pageId?
+
+> `optional` **pageId**: `string`
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:103](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L103)
+
+Custom page ID for permission checking
+
+***
+
+### scope?
+
+> `optional` **scope**: [`Scope`](../type-aliases/Scope.md)
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:106](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L106)
+
+Custom scope for permission checking
+
+***
+
+### onDenied()?
+
+> `optional` **onDenied**: (`pageName`, `operation`) => `void`
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:109](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L109)
+
+Callback when access is denied
+
+#### Parameters
+
+##### pageName
+
+`string`
+
+##### operation
+
+`string`
+
+#### Returns
+
+`void`
+
+***
+
+### loading?
+
+> `optional` **loading**: `ReactNode`
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:112](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L112)
+
+Loading state content
+
+***
+
+### printPageOrientation?
+
+> `optional` **printPageOrientation**: `"portrait"` \| `"landscape"`
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:115](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L115)
+
+Print page orientation for this page (default: 'portrait')
+
+***
+
+### printTitle?
+
+> `optional` **printTitle**: `string`
+
+Defined in: [rbac/components/PagePermissionGuard.tsx:118](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/PagePermissionGuard.tsx#L118)
+
+Title used in print headers/margin-box (sets --print-title).

package/docs/api/interfaces/PaletteData.md

@@ -0,0 +1,33 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / PaletteData
+
+# Interface: PaletteData
+
+Defined in: [theming/runtime.ts:51](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/theming/runtime.ts#L51)
+
+## Properties
+
+### main
+
+> **main**: [`ColorPalette`](ColorPalette.md)
+
+Defined in: [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: [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: [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

@@ -0,0 +1,91 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / ParsedAddress
+
+# Interface: ParsedAddress
+
+Defined in: [utils/google-places/types.ts:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/google-places/types.ts#L66)
+
+Parsed address matching core_address table structure
+
+## Properties
+
+### place\_id
+
+> **place\_id**: `string`
+
+Defined in: [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**: `string` \| `null`
+
+Defined in: [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**: `string` \| `null`
+
+Defined in: [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**: `string` \| `null`
+
+Defined in: [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**: `string` \| `null`
+
+Defined in: [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**: `string` \| `null`
+
+Defined in: [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**: `string` \| `null`
+
+Defined in: [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**: `string` \| `null`
+
+Defined in: [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**: `number` \| `null`
+
+Defined in: [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**: `number` \| `null`
+
+Defined in: [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/PermissionDeniedError.md

@@ -0,0 +1,37 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / PermissionDeniedError
+
+# Interface: PermissionDeniedError
+
+Defined in: [rbac/types.ts:318](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L318)
+
+## Extends
+
+- [`RBACError`](RBACError.md)
+
+## Properties
+
+### code
+
+> **code**: `string`
+
+Defined in: [rbac/types.ts:310](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L310)
+
+#### Inherited from
+
+[`RBACError`](RBACError.md).[`code`](RBACError.md#code)
+
+***
+
+### context?
+
+> `optional` **context**: `Record`\<`string`, `unknown`\>
+
+Defined in: [rbac/types.ts:311](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types.ts#L311)
+
+#### Inherited from
+
+[`RBACError`](RBACError.md).[`context`](RBACError.md#context)

package/docs/api/interfaces/ProgressProps.md

@@ -0,0 +1,35 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / ProgressProps
+
+# Interface: ProgressProps
+
+Defined in: [components/Progress/Progress.tsx:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Progress/Progress.tsx#L70)
+
+Props for the Progress component
+
+## Extends
+
+- `HTMLAttributes`\<`HTMLProgressElement`\>
+
+## Properties
+
+### value?
+
+> `optional` **value**: `number`
+
+Defined in: [components/Progress/Progress.tsx:72](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Progress/Progress.tsx#L72)
+
+Current progress value (0 to max). Omit for indeterminate state.
+
+***
+
+### max?
+
+> `optional` **max**: `number`
+
+Defined in: [components/Progress/Progress.tsx:74](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Progress/Progress.tsx#L74)
+
+Maximum progress value (default: 100)

package/docs/api/interfaces/ProtectedRouteProps.md

@@ -0,0 +1,67 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / ProtectedRouteProps
+
+# Interface: ProtectedRouteProps
+
+Defined in: [components/ProtectedRoute/ProtectedRoute.tsx:81](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx#L81)
+
+Props for the ProtectedRoute component.
+
+## Properties
+
+### requireEvent?
+
+> `optional` **requireEvent**: `boolean`
+
+Defined in: [components/ProtectedRoute/ProtectedRoute.tsx:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx#L88)
+
+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
+```
+
+***
+
+### noEventsFallback?
+
+> `optional` **noEventsFallback**: `ReactNode`
+
+Defined in: [components/ProtectedRoute/ProtectedRoute.tsx:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx#L94)
+
+Custom component to render when no events are available.
+If not provided, a default message is shown.
+
+***
+
+### loadingFallback?
+
+> `optional` **loadingFallback**: `ReactNode`
+
+Defined in: [components/ProtectedRoute/ProtectedRoute.tsx:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx#L100)
+
+Custom component to render while events are loading.
+If not provided, a default loading spinner is shown.
+
+***
+
+### loginPath?
+
+> `optional` **loginPath**: `string`
+
+Defined in: [components/ProtectedRoute/ProtectedRoute.tsx:106](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx#L106)
+
+Login redirect path when user is not authenticated.
+
+#### Default
+
+```ts
+'/login'
+```

package/docs/api/interfaces/PublicPageFooterProps.md

@@ -0,0 +1,97 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / PublicPageFooterProps
+
+# Interface: PublicPageFooterProps
+
+Defined in: [components/PublicLayout/PublicPageLayout.tsx:215](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L215)
+
+## Properties
+
+### event
+
+> **event**: `Event`
+
+Defined in: [components/PublicLayout/PublicPageLayout.tsx:217](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L217)
+
+The event data for this public page
+
+***
+
+### companyName?
+
+> `optional` **companyName**: `string`
+
+Defined in: [components/PublicLayout/PublicPageLayout.tsx:219](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L219)
+
+Company or organization name
+
+***
+
+### year?
+
+> `optional` **year**: `number`
+
+Defined in: [components/PublicLayout/PublicPageLayout.tsx:221](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L221)
+
+Current year or custom year for copyright
+
+***
+
+### links?
+
+> `optional` **links**: `object`[]
+
+Defined in: [components/PublicLayout/PublicPageLayout.tsx:223](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L223)
+
+Optional array of navigation links to display
+
+#### label
+
+> **label**: `string`
+
+#### href
+
+> **href**: `string`
+
+***
+
+### className?
+
+> `optional` **className**: `string`
+
+Defined in: [components/PublicLayout/PublicPageLayout.tsx:228](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L228)
+
+Optional CSS class name
+
+***
+
+### logo?
+
+> `optional` **logo**: `string`
+
+Defined in: [components/PublicLayout/PublicPageLayout.tsx:230](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L230)
+
+Logo image URL
+
+***
+
+### copyright?
+
+> `optional` **copyright**: `string`
+
+Defined in: [components/PublicLayout/PublicPageLayout.tsx:232](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L232)
+
+Copyright text
+
+***
+
+### children?
+
+> `optional` **children**: `ReactNode`
+
+Defined in: [components/PublicLayout/PublicPageLayout.tsx:234](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L234)
+
+Footer content - children to render inside footer