@jmruthers/pace-core 0.6.11 → 0.6.12

package/docs/api/functions/InactivityWarningModal.md

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

package/docs/api/functions/Input.md

@@ -0,0 +1,49 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / Input
+
+# Function: Input()
+
+> **Input**(`props`): `Element`
+
+Defined in: [components/Input/Input.tsx:108](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Input/Input.tsx#L108)
+
+Input component
+A flexible, accessible input component with multiple variants and sizes
+
+## Parameters
+
+### props
+
+[`InputProps`](../interfaces/InputProps.md) & `object`
+
+Input configuration and styling
+
+## Returns
+
+`Element`
+
+JSX.Element - The rendered input element
+
+## Example
+
+```tsx
+// Basic input
+<Input placeholder="Enter your name" />
+
+// Input with error state
+<Input 
+  placeholder="Email" 
+  type="email" 
+  error={true}
+/>
+
+// Large input with destructive variant
+<Input 
+  variant="destructive" 
+  size="lg" 
+  placeholder="Error input" 
+/>
+```

package/docs/api/functions/NavigationGuard.md

@@ -0,0 +1,31 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / NavigationGuard
+
+# Function: NavigationGuard()
+
+> **NavigationGuard**(`props`): `Element`
+
+Defined in: [rbac/components/NavigationGuard.tsx:117](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L117)
+
+NavigationGuard - Enforces navigation-level permissions
+
+This component ensures that users can only access navigation items they have permission for.
+It integrates with the existing RBAC system and provides strict enforcement to
+prevent apps from bypassing navigation permission checks.
+
+## Parameters
+
+### props
+
+[`NavigationGuardProps`](../interfaces/NavigationGuardProps.md)
+
+Component props
+
+## Returns
+
+`Element`
+
+React element with navigation permission enforcement

package/docs/api/functions/OrganisationServiceProvider.md

@@ -0,0 +1,28 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / OrganisationServiceProvider
+
+# Function: OrganisationServiceProvider()
+
+> **OrganisationServiceProvider**(`props`): `Element`
+
+Defined in: [providers/services/OrganisationServiceProvider.tsx:34](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/OrganisationServiceProvider.tsx#L34)
+
+React provider for OrganisationService.
+Provides organisation service instance to React components.
+
+## Parameters
+
+### props
+
+`OrganisationServiceProviderProps`
+
+Organisation service provider configuration
+
+## Returns
+
+`Element`
+
+The organisation service provider

package/docs/api/functions/PaceAppLayout.md

@@ -0,0 +1,169 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / PaceAppLayout
+
+# Function: PaceAppLayout()
+
+> **PaceAppLayout**(`props`): `Element`
+
+Defined in: [components/PaceAppLayout/PaceAppLayout.tsx:426](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PaceAppLayout/PaceAppLayout.tsx#L426)
+
+A consistent layout component for all PACE suite applications that provides a standard
+structure with header, main content area, and footer.
+
+NEW: This component now includes layout-level permission enforcement to ensure
+consuming apps can't forget to implement permission checks on individual pages.
+
+This component is designed to work with React Router's nested routing pattern using
+Outlet to render child routes. It provides integrated authentication, navigation,
+and user management functionality.
+
+**Super Admin Access:** When `enforcePermissions={true}`, PaceAppLayout automatically
+checks if the user is a super admin before enforcing permissions. Super admins bypass
+all permission checks and can access any route without violations. The component extracts
+base page names from route paths (e.g., `/organisation/scouts-victoria` → `"organisation"`)
+for permission checking, which can be overridden using `pageIdMapping`.
+
+**Important:** The appName prop should use an APP_NAME constant declared in your App.tsx
+file. This ensures consistency with public pages (via PublicPageProvider) which should
+also receive the same APP_NAME constant. The logo URL is automatically constructed as
+`/${appName.toLowerCase()}_logo_wide.svg` from the public folder.
+
+Features:
+- React Router v6 integration with nested routing
+- Unified authentication integration
+- Consistent header with navigation and user menu
+- Flexible main content area with Outlet
+- Footer with application branding
+- User sign-out and password change functionality
+- Responsive design and accessibility compliant
+- Layout-level permission enforcement
+- Permission-based navigation filtering
+- Automatic page permission validation
+- Super admin bypass (super admins automatically bypass all permission checks)
+
+## Parameters
+
+### props
+
+[`PaceAppLayoutProps`](../type-aliases/PaceAppLayoutProps.md)
+
+Layout configuration including app name for branding and permission settings
+
+## Returns
+
+`Element`
+
+React element with complete application layout structure and permission enforcement
+
+## Examples
+
+Basic React Router setup with permission enforcement (RECOMMENDED):
+```tsx
+import { BrowserRouter as Router, Routes, Route } from 'react-router-dom';
+import { UnifiedAuthProvider } from '@jmruthers/pace-core/providers';
+import { PaceAppLayout, PaceLoginPage, PublicPageApp } from '@jmruthers/pace-core';
+
+const APP_NAME = 'CORE';
+
+function App() {
+  return (
+    <UnifiedAuthProvider supabaseClient={supabase} appName={APP_NAME}>
+      <Router>
+        <Routes>
+          <Route path="/login" element={<PaceLoginPage appName={APP_NAME} />} />
+          <Route path="/events/*" element={<PublicPageApp appName={APP_NAME} />} />
+          <Route path="/" element={
+            <PaceAppLayout 
+              appName={APP_NAME}
+              enforcePermissions={true}
+              defaultPermission="read"
+            />
+          }>
+            <Route index element={<HomePage />} />
+            <Route path="dashboard" element={<DashboardPage />} />
+            <Route path="meals" element={<MealsPage />} />
+          </Route>
+        </Routes>
+      </Router>
+    </UnifiedAuthProvider>
+  );
+}
+```
+
+Custom navigation items with permission filtering (works independently of route enforcement):
+```tsx
+import { NavigationItem } from '@jmruthers/pace-core';
+
+function App() {
+  const customNavItems: NavigationItem[] = [
+    { id: 'components', label: 'Components', href: '/components', icon: 'Component' },
+    { id: 'styles', label: 'Styles', href: '/styles', icon: 'Palette' },
+    { id: 'meals', label: 'Meals', href: '/meals', icon: 'UtensilsCrossed' }
+  ];
+
+  return (
+    <Router>
+      <Routes>
+        <Route path="/" element={
+          <PaceAppLayout 
+            appName="My Custom App" 
+            navItems={customNavItems}
+            // Permission filtering is always enabled - no prop needed
+            routePermissions={{
+              '/components': 'read',
+              '/styles': 'read',
+              '/meals': 'read'
+            }}
+            // Optionally enable route-level enforcement (separate from navigation filtering)
+            // enforcePermissions={true}
+          />
+        }>
+          <Route path="components" element={<ComponentsPage />} />
+          <Route path="styles" element={<StylesPage />} />
+          <Route path="meals" element={<MealsPage />} />
+        </Route>
+      </Routes>
+    </Router>
+  );
+}
+```
+
+Route-specific permissions with custom page IDs:
+```tsx
+function AdminApp() {
+  return (
+    <Router>
+      <Routes>
+        <Route path="/" element={
+          <PaceAppLayout 
+            appName="Admin Panel"
+            enforcePermissions={true}
+            routePermissions={{
+              '/dashboard': 'read',
+              '/user-management': 'read',
+              '/system-settings': 'update'
+            }}
+            pageIdMapping={{
+              '/dashboard': 'dashboard',
+              '/user-management': 'user-management',
+              '/system-settings': 'system-admin'
+            }}
+            permissionFallback={<AccessDeniedPage />}
+          />
+        }>
+          <Route path="dashboard" element={<DashboardPage />} />
+          <Route path="user-management" element={<UserManagementPage />} />
+          <Route path="system-settings" element={<SystemSettingsPage />} />
+        </Route>
+      </Routes>
+    </Router>
+  );
+}
+```
+
+## Since
+
+0.1.0

package/docs/api/functions/PasswordChangeForm.md

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

package/docs/api/functions/ProtectedRoute.md

@@ -0,0 +1,37 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / ProtectedRoute
+
+# Function: ProtectedRoute()
+
+> **ProtectedRoute**(`props`): `string` \| `number` \| `bigint` \| `boolean` \| `Iterable`\<`ReactNode`, `any`, `any`\> \| `Promise`\<`AwaitedReactNode`\> \| `Element`
+
+Defined in: [components/ProtectedRoute/ProtectedRoute.tsx:125](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/ProtectedRoute/ProtectedRoute.tsx#L125)
+
+ProtectedRoute component that handles authentication and optional event selection.
+
+This component solves the chicken-and-egg problem where apps check for `selectedEvent`
+before rendering, which blocks the event selector (typically in the header) from being visible.
+
+Strategy:
+1. Check authentication first - redirect to login if not authenticated
+2. Allow rendering during event loading - prevents blocking UI
+3. If events exist but none selected - allow rendering so selector is visible
+4. If no events available - show error message
+5. Individual pages should handle "no selected event" state gracefully
+
+## Parameters
+
+### props
+
+[`ProtectedRouteProps`](../interfaces/ProtectedRouteProps.md)
+
+Configuration for route protection
+
+## Returns
+
+`string` \| `number` \| `bigint` \| `boolean` \| `Iterable`\<`ReactNode`, `any`, `any`\> \| `Promise`\<`AwaitedReactNode`\> \| `Element`
+
+React element with route protection logic

package/docs/api/functions/PublicPageFooter.md

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

package/docs/api/functions/PublicPageHeader.md

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

package/docs/api/functions/PublicPageLayout.md

@@ -0,0 +1,33 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / PublicPageLayout
+
+# Function: PublicPageLayout()
+
+> **PublicPageLayout**(`props`): `Element`
+
+Defined in: [components/PublicLayout/PublicPageLayout.tsx:350](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageLayout.tsx#L350)
+
+Layout component for public pages that don't require authentication
+
+This component provides a consistent structure for public event pages
+with event-specific branding, error handling, and loading states.
+
+Automatically applies event colors from the event's event_colours field
+when an event is provided, ensuring consistent theming across public pages.
+
+## Parameters
+
+### props
+
+[`PublicPageLayoutProps`](../interfaces/PublicPageLayoutProps.md)
+
+Layout configuration and content
+
+## Returns
+
+`Element`
+
+React element with complete public page layout

package/docs/api/functions/PublicPageProvider.md

@@ -0,0 +1,30 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / PublicPageProvider
+
+# Function: PublicPageProvider()
+
+> **PublicPageProvider**(`__namedParameters`): `Element`
+
+Defined in: [components/PublicLayout/PublicPageProvider.tsx:60](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/PublicPageProvider.tsx#L60)
+
+Provider for public pages that completely isolates them from authentication context
+
+This provider:
+- Does not initialize any authentication providers
+- Provides environment variables for public data access
+- Includes error boundary for graceful error handling
+- Is completely separate from the main app context
+- Provides appName for consistent logo display
+
+## Parameters
+
+### \_\_namedParameters
+
+`PublicPageProviderProps`
+
+## Returns
+
+`Element`

package/docs/api/functions/Textarea.md

@@ -0,0 +1,49 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / Textarea
+
+# Function: Textarea()
+
+> **Textarea**(`props`): `Element`
+
+Defined in: [components/Textarea/Textarea.tsx:96](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Textarea/Textarea.tsx#L96)
+
+Textarea component
+A flexible, accessible textarea component with multiple variants and sizes.
+Matches the Input component API and styling for consistency.
+
+## Parameters
+
+### props
+
+[`TextareaProps`](../interfaces/TextareaProps.md) & `object`
+
+Textarea configuration and styling
+
+## Returns
+
+`Element`
+
+JSX.Element - The rendered textarea element
+
+## Example
+
+```tsx
+// Basic textarea
+<Textarea placeholder="Enter your message..." />
+
+// Textarea with error state
+<Textarea 
+  placeholder="Comments" 
+  error={true}
+/>
+
+// Large textarea with destructive variant
+<Textarea 
+  variant="destructive" 
+  size="lg" 
+  placeholder="Error textarea" 
+/>
+```

package/docs/api/functions/Toaster.md

@@ -0,0 +1,34 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / Toaster
+
+# Function: Toaster()
+
+> **Toaster**(): `Element`
+
+Defined in: [components/Toast/Toast.tsx:295](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/Toast/Toast.tsx#L295)
+
+Toaster component
+Container component that renders actual toast notifications
+Should be placed at the root of your application
+
+## Returns
+
+`Element`
+
+JSX.Element - The toast provider with viewport and rendered toasts
+
+## Example
+
+```tsx
+function App() {
+  return (
+    <ToastProvider>
+      <YourApp />
+      <Toaster />
+    </ToastProvider>
+  );
+}
+```

package/docs/api/functions/UnifiedAuthProvider.md

@@ -0,0 +1,28 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / UnifiedAuthProvider
+
+# Function: UnifiedAuthProvider()
+
+> **UnifiedAuthProvider**(`props`): `Element`
+
+Defined in: [providers/services/UnifiedAuthProvider.tsx:398](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L398)
+
+Unified authentication provider.
+Provides authentication, organisation, event, and inactivity tracking services.
+
+## Parameters
+
+### props
+
+[`UnifiedAuthProviderProps`](../interfaces/UnifiedAuthProviderProps.md)
+
+Unified auth provider configuration
+
+## Returns
+
+`Element`
+
+The unified auth provider

package/docs/api/functions/applyPalette.md

@@ -0,0 +1,33 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / applyPalette
+
+# Function: applyPalette()
+
+> **applyPalette**(`palette`, `eventName?`): `void`
+
+Defined in: [theming/runtime.ts:133](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/theming/runtime.ts#L133)
+
+Applies a complete palette to the document by setting CSS variables on :root.
+Uses document.documentElement.style.setProperty() for runtime updates.
+When eventName is provided, also sets --print-event-name for print styles.
+
+## Parameters
+
+### palette
+
+[`PaletteData`](../interfaces/PaletteData.md)
+
+Complete palette data with main, sec, and acc palettes
+
+### eventName?
+
+`string`
+
+Optional event name to set as --print-event-name (e.g. for print headers/footers)
+
+## Returns
+
+`void`

package/docs/api/functions/archiveFile.md

@@ -0,0 +1,47 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / archiveFile
+
+# Function: archiveFile()
+
+> **archiveFile**(`supabase`, `path`, `options`): `Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<`void`\>\>
+
+Defined in: [utils/storage/helpers.ts:660](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/helpers.ts#L660)
+
+Move a file to archived location (soft delete).
+
+## Parameters
+
+### supabase
+
+`SupabaseClient`
+
+### path
+
+`string`
+
+### options
+
+#### appName
+
+`string`
+
+#### orgId?
+
+`string`
+
+#### userId?
+
+`string`
+
+#### isPublic?
+
+`boolean`
+
+## Returns
+
+`Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<`void`\>\>
+
+ApiResult<void> on success.