@jmruthers/pace-core 0.6.11 → 0.6.12

package/docs/api/functions/average.md

@@ -0,0 +1,63 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / average
+
+# Function: average()
+
+> **average**\<`TData`\>(`accessorKey`): \<`TRow`\>(`rows`, `_column`) => `number`
+
+Defined in: [components/DataTable/utils/aggregationUtils.ts:53](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/utils/aggregationUtils.ts#L53)
+
+Creates an average aggregation function for a specific field.
+
+## Type Parameters
+
+### TData
+
+`TData` *extends* [`DataRecord`](../interfaces/DataRecord.md) = [`DataRecord`](../interfaces/DataRecord.md)
+
+## Parameters
+
+### accessorKey
+
+The field key to average (e.g., 'price', 'rating')
+
+`string` | keyof `TData`
+
+## Returns
+
+An aggregation function that calculates the average of the specified field across all rows
+
+> \<`TRow`\>(`rows`, `_column`): `number`
+
+### Type Parameters
+
+#### TRow
+
+`TRow` *extends* [`DataRecord`](../interfaces/DataRecord.md) = `TData`
+
+### Parameters
+
+#### rows
+
+`TRow`[]
+
+#### \_column
+
+[`DataTableColumn`](../interfaces/DataTableColumn.md)\<`TRow`\>
+
+### Returns
+
+`number`
+
+## Example
+
+```tsx
+{
+  accessorKey: 'price',
+  header: 'Avg Price',
+  aggregateFn: average('price'),
+}
+```

package/docs/api/functions/buildAppUrl.md

@@ -0,0 +1,46 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / buildAppUrl
+
+# Function: buildAppUrl()
+
+> **buildAppUrl**(`options`): `string`
+
+Defined in: [utils/app/buildAppUrl.ts:49](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/app/buildAppUrl.ts#L49)
+
+Builds a URL for switching to another pace app.
+
+In development: Uses port-based URLs (e.g., `http://localhost:8091/`)
+In production: Uses subdomain pattern (e.g., `https://cake.example.com/`)
+
+## Parameters
+
+### options
+
+[`BuildAppUrlOptions`](../interfaces/BuildAppUrlOptions.md)
+
+URL building options
+
+## Returns
+
+`string`
+
+The full URL to the app
+
+## Example
+
+```ts
+// Development
+buildAppUrl({ appName: 'CAKE' }); 
+// Returns: 'http://localhost:8091/'
+
+// Production
+buildAppUrl({ appName: 'CAKE' }); 
+// Returns: 'https://cake.example.com/'
+
+// With custom path
+buildAppUrl({ appName: 'TRAC', path: '/dashboard' }); 
+// Returns: 'http://localhost:8092/dashboard' (dev) or 'https://trac.example.com/dashboard' (prod)
+```

package/docs/api/functions/clearInFlightRequests.md

@@ -0,0 +1,17 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / clearInFlightRequests
+
+# Function: clearInFlightRequests()
+
+> **clearInFlightRequests**(): `void`
+
+Defined in: [rbac/request-deduplication.ts:76](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/request-deduplication.ts#L76)
+
+Clear all in-flight requests (useful for testing or cleanup)
+
+## Returns
+
+`void`

package/docs/api/functions/clearPalette.md

@@ -0,0 +1,18 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / clearPalette
+
+# Function: clearPalette()
+
+> **clearPalette**(): `void`
+
+Defined in: [theming/runtime.ts:187](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/theming/runtime.ts#L187)
+
+Clears dynamic theming by removing CSS variables from :root.
+This allows the browser to fall back to static CSS values.
+
+## Returns
+
+`void`

package/docs/api/functions/clearPublicEventCache.md

@@ -0,0 +1,18 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / clearPublicEventCache
+
+# Function: clearPublicEventCache()
+
+> **clearPublicEventCache**(): `void`
+
+Defined in: [hooks/public/usePublicEvent.ts:285](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEvent.ts#L285)
+
+Clear all cached public event data
+Useful for testing or when you need to force refresh all data
+
+## Returns
+
+`void`

package/docs/api/functions/clearPublicFileDisplayCache.md

@@ -0,0 +1,18 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / clearPublicFileDisplayCache
+
+# Function: clearPublicFileDisplayCache()
+
+> **clearPublicFileDisplayCache**(): `void`
+
+Defined in: [components/FileDisplay/usePublicFileDisplay.ts:562](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/usePublicFileDisplay.ts#L562)
+
+Clear all cached public file data
+Useful for testing or when you need to force refresh all data
+
+## Returns
+
+`void`

package/docs/api/functions/clearPublicLogoCache.md

@@ -0,0 +1,18 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / clearPublicLogoCache
+
+# Function: clearPublicLogoCache()
+
+> **clearPublicLogoCache**(): `void`
+
+Defined in: [hooks/public/usePublicEventLogo.ts:285](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L285)
+
+Clear all cached public logo data
+Useful for testing or when you need to force refresh all data
+
+## Returns
+
+`void`

package/docs/api/functions/cn.md

@@ -0,0 +1,21 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / cn
+
+# Function: cn()
+
+> **cn**(...`inputs`): `string`
+
+Defined in: [utils/core/cn.ts:5](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/cn.ts#L5)
+
+## Parameters
+
+### inputs
+
+...`ClassValue`[]
+
+## Returns
+
+`string`

package/docs/api/functions/count.md

@@ -0,0 +1,56 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / count
+
+# Function: count()
+
+> **count**\<`TData`\>(): \<`TRow`\>(`rows`, `_column`) => `number`
+
+Defined in: [components/DataTable/utils/aggregationUtils.ts:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/utils/aggregationUtils.ts#L88)
+
+Creates a count aggregation function.
+Returns the number of rows in the group.
+
+## Type Parameters
+
+### TData
+
+`TData` *extends* [`DataRecord`](../interfaces/DataRecord.md) = [`DataRecord`](../interfaces/DataRecord.md)
+
+## Returns
+
+An aggregation function that counts the number of rows
+
+> \<`TRow`\>(`rows`, `_column`): `number`
+
+### Type Parameters
+
+#### TRow
+
+`TRow` *extends* [`DataRecord`](../interfaces/DataRecord.md) = `TData`
+
+### Parameters
+
+#### rows
+
+`TRow`[]
+
+#### \_column
+
+[`DataTableColumn`](../interfaces/DataTableColumn.md)\<`TRow`\>
+
+### Returns
+
+`number`
+
+## Example
+
+```tsx
+{
+  accessorKey: 'id',
+  header: 'Count',
+  aggregateFn: count(),
+}
+```

package/docs/api/functions/createAuditManager.md

@@ -0,0 +1,45 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / createAuditManager
+
+# Function: createAuditManager()
+
+> **createAuditManager**(`supabase`, `useBatching?`, `batchConfig?`): [`RBACAuditManager`](../classes/RBACAuditManager.md)
+
+Defined in: [rbac/audit.ts:450](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L450)
+
+Create an audit manager instance
+
+## Parameters
+
+### supabase
+
+`SupabaseClient`\<`Database`\>
+
+Supabase client
+
+### useBatching?
+
+`boolean` = `true`
+
+Whether to use batched audit logging (default: true)
+
+### batchConfig?
+
+Optional batch configuration
+
+#### batchWindow?
+
+`number`
+
+#### batchSize?
+
+`number`
+
+## Returns
+
+[`RBACAuditManager`](../classes/RBACAuditManager.md)
+
+RBACAuditManager instance

package/docs/api/functions/createBaseClient.md

@@ -0,0 +1,75 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / createBaseClient
+
+# Function: createBaseClient()
+
+> **createBaseClient**(`supabaseUrl`, `supabaseKey`): `SupabaseClient`\<`Database`\>
+
+Defined in: [utils/supabase/createBaseClient.ts:139](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/supabase/createBaseClient.ts#L139)
+
+Create a base Supabase client for UnifiedAuthProvider
+
+**CRITICAL**: This function can ONLY be called from:
+- `src/main.tsx` (or `main.jsx`)
+- `src/App.tsx` (or `App.jsx`)
+- `src/lib/supabase.ts` (or `supabase.js`)
+- `src/supabase.ts` (or `supabase.js`)
+
+**DO NOT** use this client directly for queries. Always use `useSecureSupabase()` hook instead.
+
+The client is configured with explicit auth options to ensure consistent session persistence:
+- `persistSession: true` - Sessions are saved to localStorage and restored on page load/refresh
+- `autoRefreshToken: true` - Tokens are automatically refreshed before expiry
+- `detectSessionInUrl: true` - Detects and handles OAuth callback URLs
+- `flowType: 'pkce'` - Uses PKCE flow for enhanced security
+
+This configuration ensures that users remain logged in after hard refresh (Cmd+Shift+R)
+and other browser navigation scenarios across all consuming apps.
+
+## Parameters
+
+### supabaseUrl
+
+`string`
+
+Supabase project URL
+
+### supabaseKey
+
+`string`
+
+Supabase publishable key or anon key (accepts both legacy anon keys and modern publishable keys)
+
+## Returns
+
+`SupabaseClient`\<`Database`\>
+
+Supabase client instance with auth configuration
+
+## Throws
+
+If called from an unauthorized file location (development only)
+
+## Example
+
+```tsx
+// main.tsx
+import { createBaseClient } from '@jmruthers/pace-core';
+import { UnifiedAuthProvider } from '@jmruthers/pace-core';
+
+const supabase = createBaseClient(
+  import.meta.env.VITE_SUPABASE_URL,
+  import.meta.env.VITE_SUPABASE_PUBLISHABLE_KEY
+);
+
+function App() {
+  return (
+    <UnifiedAuthProvider supabaseClient={supabase} appName="MyApp">
+      <YourApp />
+    </UnifiedAuthProvider>
+  );
+}
+```

package/docs/api/functions/createLogger.md

@@ -0,0 +1,95 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / createLogger
+
+# Function: createLogger()
+
+> **createLogger**(`component`): `object`
+
+Defined in: [utils/core/logger.ts:183](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L183)
+
+Convenience function to create a scoped logger
+
+## Parameters
+
+### component
+
+`string`
+
+## Returns
+
+`object`
+
+### debug()
+
+> **debug**: (`message`, ...`args`) => `void`
+
+#### Parameters
+
+##### message
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`
+
+### info()
+
+> **info**: (`message`, ...`args`) => `void`
+
+#### Parameters
+
+##### message
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`
+
+### warn()
+
+> **warn**: (`message`, ...`args`) => `void`
+
+#### Parameters
+
+##### message
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`
+
+### error()
+
+> **error**: (`message`, ...`args`) => `void`
+
+#### Parameters
+
+##### message
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`

package/docs/api/functions/createRBACConfig.md

@@ -0,0 +1,21 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / createRBACConfig
+
+# Function: createRBACConfig()
+
+> **createRBACConfig**(`config`): [`RBACConfig`](../type-aliases/RBACConfig.md)
+
+Defined in: [rbac/config.ts:164](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/config.ts#L164)
+
+## Parameters
+
+### config
+
+[`RBACConfig`](../type-aliases/RBACConfig.md)
+
+## Returns
+
+[`RBACConfig`](../type-aliases/RBACConfig.md)

package/docs/api/functions/createRBACEngine.md

@@ -0,0 +1,33 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / createRBACEngine
+
+# Function: createRBACEngine()
+
+> **createRBACEngine**(`supabase`, `securityConfig?`): [`RBACEngine`](../classes/RBACEngine.md)
+
+Defined in: [rbac/engine.ts:702](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/engine.ts#L702)
+
+Create an RBAC engine instance
+
+## Parameters
+
+### supabase
+
+`SupabaseClient`\<`Database`\>
+
+Supabase client
+
+### securityConfig?
+
+`Partial`\<`RBACSecurityConfig`\>
+
+Optional security configuration
+
+## Returns
+
+[`RBACEngine`](../classes/RBACEngine.md)
+
+RBACEngine instance

package/docs/api/functions/createRBACExpressMiddleware.md

@@ -0,0 +1,84 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / createRBACExpressMiddleware
+
+# Function: createRBACExpressMiddleware()
+
+> **createRBACExpressMiddleware**(`config`): (`req`, `res`, `next`) => `Promise`\<`void`\>
+
+Defined in: [rbac/adapters.tsx:368](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/adapters.tsx#L368)
+
+Express Middleware for RBAC
+
+Middleware that checks permissions for Express routes.
+
+## Parameters
+
+### config
+
+Middleware configuration
+
+#### permission
+
+`` `read:${string}` `` \| `` `create:${string}` `` \| `` `update:${string}` `` \| `` `delete:${string}` ``
+
+#### pageId?
+
+`string`
+
+## Returns
+
+Express middleware function
+
+> (`req`, `res`, `next`): `Promise`\<`void`\>
+
+### Parameters
+
+#### req
+
+##### user?
+
+\{ `id`: `string`; \}
+
+##### user.id
+
+`string`
+
+##### organisationId?
+
+`string`
+
+##### eventId?
+
+`string`
+
+##### appId?
+
+`string`
+
+#### res
+
+##### status
+
+(`code`) => `object`
+
+#### next
+
+() => `void`
+
+### Returns
+
+`Promise`\<`void`\>
+
+## Example
+
+```typescript
+import { createRBACExpressMiddleware } from '@jmruthers/pace-core/rbac';
+
+app.use(createRBACExpressMiddleware({
+  permission: 'read:api',
+  pageId: 'api-page-123',
+}));
+```