@jmruthers/pace-core 0.6.11 → 0.6.12

package/docs/api/enumerations/RPCFunction.md

@@ -0,0 +1,89 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / RPCFunction
+
+# Enumeration: RPCFunction
+
+Defined in: [rbac/types/functions.ts:178](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L178)
+
+## Enumeration Members
+
+### RBAC\_PERMISSION\_CHECK
+
+> **RBAC\_PERMISSION\_CHECK**: `"rbac_permission_check"`
+
+Defined in: [rbac/types/functions.ts:180](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L180)
+
+***
+
+### RBAC\_PERMISSIONS\_GET
+
+> **RBAC\_PERMISSIONS\_GET**: `"rbac_permissions_get"`
+
+Defined in: [rbac/types/functions.ts:181](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L181)
+
+***
+
+### RBAC\_ACCESS\_VALIDATE
+
+> **RBAC\_ACCESS\_VALIDATE**: `"rbac_access_validate"`
+
+Defined in: [rbac/types/functions.ts:182](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L182)
+
+***
+
+### RBAC\_PAGE\_ACCESS\_CHECK
+
+> **RBAC\_PAGE\_ACCESS\_CHECK**: `"rbac_page_access_check"`
+
+Defined in: [rbac/types/functions.ts:183](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L183)
+
+***
+
+### RBAC\_ROLE\_GRANT
+
+> **RBAC\_ROLE\_GRANT**: `"rbac_role_grant"`
+
+Defined in: [rbac/types/functions.ts:186](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L186)
+
+***
+
+### RBAC\_ROLE\_REVOKE
+
+> **RBAC\_ROLE\_REVOKE**: `"rbac_role_revoke"`
+
+Defined in: [rbac/types/functions.ts:187](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L187)
+
+***
+
+### RBAC\_ROLES\_LIST
+
+> **RBAC\_ROLES\_LIST**: `"data_rbac_roles_list"`
+
+Defined in: [rbac/types/functions.ts:188](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L188)
+
+***
+
+### RBAC\_ROLE\_VALIDATE
+
+> **RBAC\_ROLE\_VALIDATE**: `"rbac_role_validate"`
+
+Defined in: [rbac/types/functions.ts:189](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L189)
+
+***
+
+### RBAC\_SESSION\_TRACK
+
+> **RBAC\_SESSION\_TRACK**: `"rbac_session_track"`
+
+Defined in: [rbac/types/functions.ts:192](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L192)
+
+***
+
+### RBAC\_AUDIT\_LOG
+
+> **RBAC\_AUDIT\_LOG**: `"rbac_audit_log"`
+
+Defined in: [rbac/types/functions.ts:193](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/types/functions.ts#L193)

package/docs/api/functions/AccessDenied.md

@@ -0,0 +1,30 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / AccessDenied
+
+# Function: AccessDenied()
+
+> **AccessDenied**(`props`): `Element`
+
+Defined in: [rbac/components/AccessDenied.tsx:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/AccessDenied.tsx#L85)
+
+Standard access denied component
+
+This component is displayed when users lack the necessary permissions.
+It provides clear messaging and actionable next steps.
+
+## Parameters
+
+### props
+
+[`AccessDeniedProps`](../interfaces/AccessDeniedProps.md)
+
+Component configuration
+
+## Returns
+
+`Element`
+
+JSX.Element - The rendered access denied page

package/docs/api/functions/AppSwitcher.md

@@ -0,0 +1,21 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / AppSwitcher
+
+# Function: AppSwitcher()
+
+> **AppSwitcher**(`__namedParameters`): `Element` \| `null`
+
+Defined in: [components/AppSwitcher/AppSwitcher.tsx:155](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/AppSwitcher/AppSwitcher.tsx#L155)
+
+## Parameters
+
+### \_\_namedParameters
+
+[`AppSwitcherProps`](../interfaces/AppSwitcherProps.md)
+
+## Returns
+
+`Element` \| `null`

package/docs/api/functions/Badge.md

@@ -0,0 +1,42 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / Badge
+
+# Function: Badge()
+
+> **Badge**(`__namedParameters`): `Element`
+
+Defined in: [components/Badge/Badge.tsx:268](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Badge/Badge.tsx#L268)
+
+Badge Component
+A small, non-interactive visual label for displaying concise information.
+
+## Parameters
+
+### \_\_namedParameters
+
+[`BadgeProps`](../interfaces/BadgeProps.md) & `object`
+
+## Returns
+
+`Element`
+
+## Component
+
+## Example
+
+```tsx
+// Default variant
+<Badge>New</Badge>
+
+// Specific variant
+<Badge variant="solid-main-normal">Active</Badge>
+
+// Outline variant
+<Badge variant="outline-sec-muted">Pending</Badge>
+
+// Soft variant
+<Badge variant="soft-acc-strong">Featured</Badge>
+```

package/docs/api/functions/ContextSelector.md

@@ -0,0 +1,43 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / ContextSelector
+
+# Function: ContextSelector()
+
+> **ContextSelector**(`__namedParameters`): `Element` \| `null`
+
+Defined in: [components/ContextSelector/ContextSelector.tsx:81](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ContextSelector/ContextSelector.tsx#L81)
+
+ContextSelector component for selecting organisations or events
+
+This is the unified intelligent selector that shows all organisations and events
+a user can access. It automatically determines what to show based on the user's
+roles and permissions - no need to configure separate org/event selectors.
+
+The selector intelligently shows:
+- All organisations the user has access to (via organisation roles)
+- All events the user has access to (via event-app roles or organisation membership)
+- Everything for super admins
+
+## Parameters
+
+### \_\_namedParameters
+
+[`ContextSelectorProps`](../interfaces/ContextSelectorProps.md)
+
+## Returns
+
+`Element` \| `null`
+
+## Component
+
+## Example
+
+```ts
+<ContextSelector
+  onOrganisationSelect={(org) => switchOrganisation(org)}
+  onEventSelect={(event) => setSelectedEvent(event)}
+/>
+```

package/docs/api/functions/DataTable.md

@@ -0,0 +1,36 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / DataTable
+
+# Function: DataTable()
+
+> **DataTable**\<`TData`\>(`props`): `Element`
+
+Defined in: [components/DataTable/DataTable.tsx:479](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L479)
+
+Comprehensive, feature-rich data table component built on top of TanStack Table.
+Provides advanced data management capabilities with a clean, accessible interface.
+
+## Type Parameters
+
+### TData
+
+`TData` *extends* [`DataRecord`](../interfaces/DataRecord.md)
+
+The type of data records in the table
+
+## Parameters
+
+### props
+
+[`DataTableProps`](../interfaces/DataTableProps.md)\<`TData`\>
+
+DataTable configuration and props
+
+## Returns
+
+`Element`
+
+The rendered DataTable component

package/docs/api/functions/DatePickerWithTimezone.md

@@ -0,0 +1,28 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / DatePickerWithTimezone
+
+# Function: DatePickerWithTimezone()
+
+> **DatePickerWithTimezone**(`props`): `Element`
+
+Defined in: [components/DatePickerWithTimezone/DatePickerWithTimezone.tsx:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DatePickerWithTimezone/DatePickerWithTimezone.tsx#L85)
+
+DatePickerWithTimezone component
+Date picker with timezone information display
+
+## Parameters
+
+### props
+
+[`DatePickerWithTimezoneProps`](../interfaces/DatePickerWithTimezoneProps.md)
+
+DatePickerWithTimezone configuration
+
+## Returns
+
+`Element`
+
+JSX.Element - The rendered date picker with timezone

package/docs/api/functions/DialogBody.md

@@ -0,0 +1,24 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / DialogBody
+
+# Function: DialogBody()
+
+> **DialogBody**(`__namedParameters`): `Element`
+
+Defined in: [components/Dialog/Dialog.tsx:650](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Dialog/Dialog.tsx#L650)
+
+DialogBody component
+Semantic main content area for dialog body content with scrollable functionality
+
+## Parameters
+
+### \_\_namedParameters
+
+[`DialogBodyProps`](../interfaces/DialogBodyProps.md)
+
+## Returns
+
+`Element`

package/docs/api/functions/DialogFooter.md

@@ -0,0 +1,24 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / DialogFooter
+
+# Function: DialogFooter()
+
+> **DialogFooter**(`__namedParameters`): `Element`
+
+Defined in: [components/Dialog/Dialog.tsx:751](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Dialog/Dialog.tsx#L751)
+
+DialogFooter component
+Semantic footer container for dialog action buttons with optional sticky behavior
+
+## Parameters
+
+### \_\_namedParameters
+
+[`DialogFooterProps`](../interfaces/DialogFooterProps.md)
+
+## Returns
+
+`Element`

package/docs/api/functions/DialogHeader.md

@@ -0,0 +1,24 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / DialogHeader
+
+# Function: DialogHeader()
+
+> **DialogHeader**(`__namedParameters`): `Element`
+
+Defined in: [components/Dialog/Dialog.tsx:634](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Dialog/Dialog.tsx#L634)
+
+DialogHeader component
+Semantic header container for dialog title and description with optional sticky behavior
+
+## Parameters
+
+### \_\_namedParameters
+
+[`DialogHeaderProps`](../interfaces/DialogHeaderProps.md)
+
+## Returns
+
+`Element`

package/docs/api/functions/ErrorBoundaryProvider.md

@@ -0,0 +1,28 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / ErrorBoundaryProvider
+
+# Function: ErrorBoundaryProvider()
+
+> **ErrorBoundaryProvider**(`props`): `Element`
+
+Defined in: [components/ErrorBoundary/ErrorBoundaryContext.tsx:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ErrorBoundary/ErrorBoundaryContext.tsx#L71)
+
+Error boundary provider component.
+Provides global error handling configuration to child ErrorBoundary components.
+
+## Parameters
+
+### props
+
+[`ErrorBoundaryProviderProps`](../interfaces/ErrorBoundaryProviderProps.md)
+
+Error boundary provider configuration
+
+## Returns
+
+`Element`
+
+The error boundary provider

package/docs/api/functions/EventServiceProvider.md

@@ -0,0 +1,28 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / EventServiceProvider
+
+# Function: EventServiceProvider()
+
+> **EventServiceProvider**(`props`): `Element`
+
+Defined in: [providers/services/EventServiceProvider.tsx:38](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/EventServiceProvider.tsx#L38)
+
+React provider for EventService.
+Provides event service instance to React components.
+
+## Parameters
+
+### props
+
+`EventServiceProviderProps`
+
+Event service provider configuration
+
+## Returns
+
+`Element`
+
+The event service provider

package/docs/api/functions/FileDisplay.md

@@ -0,0 +1,25 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / FileDisplay
+
+# Function: FileDisplay()
+
+> **FileDisplay**(`__namedParameters`): `Element`
+
+Defined in: [components/FileDisplay/FileDisplay.tsx:335](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L335)
+
+File display component.
+Renders files from the file reference system with support for previews, downloads, and public/private access.
+Context-aware: uses PublicPageProvider for public pages and UnifiedAuthProvider for authenticated pages.
+
+## Parameters
+
+### \_\_namedParameters
+
+[`FileDisplayProps`](../interfaces/FileDisplayProps.md)
+
+## Returns
+
+`Element`

package/docs/api/functions/FileUpload.md

@@ -0,0 +1,21 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / FileUpload
+
+# Function: FileUpload()
+
+> **FileUpload**(`__namedParameters`): `Element`
+
+Defined in: [components/FileUpload/FileUpload.tsx:74](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileUpload/FileUpload.tsx#L74)
+
+## Parameters
+
+### \_\_namedParameters
+
+[`FileUploadProps`](../type-aliases/FileUploadProps.md)
+
+## Returns
+
+`Element`

package/docs/api/functions/Form.md

@@ -0,0 +1,50 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / Form
+
+# Function: Form()
+
+> **Form**\<`TFieldValues`\>(`props`): `Element`
+
+Defined in: [components/Form/Form.tsx:156](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L156)
+
+Form component with validation and React Hook Form integration
+
+## Type Parameters
+
+### TFieldValues
+
+`TFieldValues` *extends* `FieldValues` = `FieldValues`
+
+The type of form field values
+
+## Parameters
+
+### props
+
+[`FormProps`](../interfaces/FormProps.md)\<`TFieldValues`\>
+
+Form configuration and handlers
+
+## Returns
+
+`Element`
+
+JSX.Element - The rendered form with FormProvider context
+
+## Example
+
+```tsx
+<Form
+  schema={userSchema}
+  defaultValues={{ name: "", email: "" }}
+  onSubmit={handleSubmit}
+  mode="onBlur"
+>
+  <FormField name="name" label="Name" />
+  <FormField name="email" label="Email" />
+  <Button type="submit">Submit</Button>
+</Form>
+```

package/docs/api/functions/FormField.md

@@ -0,0 +1,102 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / FormField
+
+# Function: FormField()
+
+> **FormField**\<`TFieldValues`, `TName`\>(`props`): `Element`
+
+Defined in: [components/Form/Form.tsx:468](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Form/Form.tsx#L468)
+
+FormField component for React Hook Form integration
+
+A flexible form field component that integrates with React Hook Form and provides
+built-in validation, error handling, and accessibility features.
+
+Features:
+- React Hook Form integration with Controller
+- Built-in validation with error display
+- Accessible labels and error messages
+- Custom render function support
+- TypeScript support with generic field paths
+- Consistent styling with error states
+- Test ID support for testing
+- Flexible input types and props
+
+## Type Parameters
+
+### TFieldValues
+
+`TFieldValues` *extends* `FieldValues` = `FieldValues`
+
+The type of form field values
+
+### TName
+
+`TName` *extends* `string` = `FieldPath`\<`TFieldValues`\>
+
+The type of the field name (must be a valid field path)
+
+## Parameters
+
+### props
+
+[`FormFieldProps`](../interfaces/FormFieldProps.md)\<`TFieldValues`, `TName`\>
+
+Form field configuration and validation
+
+## Returns
+
+`Element`
+
+JSX.Element - The rendered form field with validation
+
+## Example
+
+```tsx
+// Basic text field
+<FormField
+  name="username"
+  label="Username"
+  placeholder="Enter your username"
+  validation={{ required: true }}
+/>
+
+// Email field with custom validation
+<FormField
+  name="email"
+  label="Email Address"
+  type="email"
+  validation={{
+    required: true,
+    pattern: {
+      value: /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}$/i,
+      message: "Invalid email address"
+    }
+  }}
+/>
+
+// Custom render function
+<FormField
+  name="avatar"
+  label="Profile Picture"
+  render={({ field }) => (
+    <input
+      {...field}
+      type="file"
+      accept="image/*"
+    />
+  )}
+/>
+```
+
+## Accessibility
+
+- Proper label association with htmlFor
+- Error messages with role="alert"
+- Required field indicators
+- Focus management
+- Screen reader friendly error announcements
+- Keyboard navigation support

package/docs/api/functions/Header.md

@@ -0,0 +1,21 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / Header
+
+# Function: Header()
+
+> **Header**(`__namedParameters`): `Element`
+
+Defined in: [components/Header/Header.tsx:252](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Header/Header.tsx#L252)
+
+## Parameters
+
+### \_\_namedParameters
+
+`HeaderProps`
+
+## Returns
+
+`Element`

package/docs/api/functions/InactivityServiceProvider.md

@@ -0,0 +1,28 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / InactivityServiceProvider
+
+# Function: InactivityServiceProvider()
+
+> **InactivityServiceProvider**(`props`): `Element`
+
+Defined in: [providers/services/InactivityServiceProvider.tsx:37](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/InactivityServiceProvider.tsx#L37)
+
+React provider for InactivityService.
+Provides inactivity service instance to React components.
+
+## Parameters
+
+### props
+
+`InactivityServiceProviderProps`
+
+Inactivity service provider configuration
+
+## Returns
+
+`Element`
+
+The inactivity service provider