@jmruthers/pace-core 0.6.11 → 0.6.12

package/docs/api/functions/max.md

@@ -0,0 +1,63 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / max
+
+# Function: max()
+
+> **max**\<`TData`\>(`accessorKey`): \<`TRow`\>(`rows`, `_column`) => `number` \| `null`
+
+Defined in: [components/DataTable/utils/aggregationUtils.ts:143](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/utils/aggregationUtils.ts#L143)
+
+Creates a maximum 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 find the maximum of (e.g., 'price', 'date')
+
+`string` | keyof `TData`
+
+## Returns
+
+An aggregation function that returns the maximum value of the specified field
+
+> \<`TRow`\>(`rows`, `_column`): `number` \| `null`
+
+### Type Parameters
+
+#### TRow
+
+`TRow` *extends* [`DataRecord`](../interfaces/DataRecord.md) = `TData`
+
+### Parameters
+
+#### rows
+
+`TRow`[]
+
+#### \_column
+
+[`DataTableColumn`](../interfaces/DataTableColumn.md)\<`TRow`\>
+
+### Returns
+
+`number` \| `null`
+
+## Example
+
+```tsx
+{
+  accessorKey: 'price',
+  header: 'Max Price',
+  aggregateFn: max('price'),
+}
+```

package/docs/api/functions/min.md

@@ -0,0 +1,63 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / min
+
+# Function: min()
+
+> **min**\<`TData`\>(`accessorKey`): \<`TRow`\>(`rows`, `_column`) => `number` \| `null`
+
+Defined in: [components/DataTable/utils/aggregationUtils.ts:109](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/utils/aggregationUtils.ts#L109)
+
+Creates a minimum 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 find the minimum of (e.g., 'price', 'date')
+
+`string` | keyof `TData`
+
+## Returns
+
+An aggregation function that returns the minimum value of the specified field
+
+> \<`TRow`\>(`rows`, `_column`): `number` \| `null`
+
+### Type Parameters
+
+#### TRow
+
+`TRow` *extends* [`DataRecord`](../interfaces/DataRecord.md) = `TData`
+
+### Parameters
+
+#### rows
+
+`TRow`[]
+
+#### \_column
+
+[`DataTableColumn`](../interfaces/DataTableColumn.md)\<`TRow`\>
+
+### Returns
+
+`number` \| `null`
+
+## Example
+
+```tsx
+{
+  accessorKey: 'price',
+  header: 'Min Price',
+  aggregateFn: min('price'),
+}
+```

package/docs/api/functions/ok.md

@@ -0,0 +1,29 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / ok
+
+# Function: ok()
+
+> **ok**\<`T`\>(`data`): [`ApiResult`](../type-aliases/ApiResult.md)\<`T`\>
+
+Defined in: [types/api-result.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/api-result.ts#L30)
+
+Creates a successful ApiResult.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### data
+
+`T`
+
+## Returns
+
+[`ApiResult`](../type-aliases/ApiResult.md)\<`T`\>

package/docs/api/functions/parseAndNormalizeEventColours.md

@@ -0,0 +1,105 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / parseAndNormalizeEventColours
+
+# Function: parseAndNormalizeEventColours()
+
+> **parseAndNormalizeEventColours**(`input`): \{ `main`: `ColorPalette`; `sec`: `ColorPalette`; `acc`: `ColorPalette`; \} \| `null`
+
+Defined in: [theming/parseEventColours.ts:107](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/theming/parseEventColours.ts#L107)
+
+Parse and normalize event_colours to PaletteData
+
+Supports input formats:
+- Object with 'main', 'sec', 'acc' keys (standard format)
+- Object with 'ev-main', 'ev-sec', 'ev-acc' keys (database format with prefix)
+- Shade names with 'ev-' prefix (e.g., 'ev-acc-500' -> 'acc-500', 'ev-main-raw' -> 'main-raw')
+- JSON string that will be parsed
+
+Only includes explicitly defined color values. Does not fill
+missing shades - only shades that are present in the input will
+be included in the output.
+
+The parser automatically strips 'ev-' prefixes from BOTH palette keys and shade names
+for future-proofing, allowing distinction between event colors and organization colors
+(org colors not yet implemented).
+
+Normalization rules:
+- Palette keys: 'ev-main' -> 'main', 'ev-sec' -> 'sec', 'ev-acc' -> 'acc'
+- Shade names: 'ev-main-raw' -> 'main-raw', 'ev-sec-200' -> 'sec-200', 'ev-acc-800' -> 'acc-800'
+
+## Parameters
+
+### input
+
+`unknown`
+
+Event colours from database (JSONB field)
+
+## Returns
+
+\{ `main`: `ColorPalette`; `sec`: `ColorPalette`; `acc`: `ColorPalette`; \} \| `null`
+
+Normalized palette data with main, sec, acc palettes, or null if invalid
+
+## Examples
+
+```ts
+// Standard format
+const colours = {
+  main: { 500: { L: 0.5, C: 0.2, H: 0 }, raw: { L: 0.5, C: 0.2, H: 0 } },
+  sec: { 500: { L: 0.5, C: 0.2, H: 120 } },
+  acc: { 500: { L: 0.5, C: 0.2, H: 240 } }
+};
+const palette = parseAndNormalizeEventColours(colours);
+// Returns: { main: { 500: {...}, raw: {...} }, sec: { 500: {...} }, acc: { 500: {...} } }
+```
+
+```ts
+// Database format with ev- prefix on palette keys
+const colours = {
+  'ev-main': { 500: { L: 0.5, C: 0.2, H: 0 } },
+  'ev-sec': { 500: { L: 0.5, C: 0.2, H: 120 } },
+  'ev-acc': { 500: { L: 0.5, C: 0.2, H: 240 } }
+};
+const palette = parseAndNormalizeEventColours(colours);
+// Returns: { main: { 500: {...} }, sec: { 500: {...} }, acc: { 500: {...} } }
+```
+
+```ts
+// Future-proofing: ev- prefix on shade names
+const colours = {
+  main: { 
+    'ev-main-500': { L: 0.5, C: 0.2, H: 0 },
+    'ev-main-raw': { L: 0.55, C: 0.25, H: 5 }
+  },
+  sec: {
+    'ev-sec-200': { L: 0.8, C: 0.15, H: 120 }
+  },
+  acc: { 
+    'ev-acc-800': { L: 0.3, C: 0.2, H: 240 }
+  }
+};
+const palette = parseAndNormalizeEventColours(colours);
+// Returns: { main: { 'main-500': {...}, 'main-raw': {...} }, sec: { 'sec-200': {...} }, acc: { 'acc-800': {...} } }
+```
+
+```ts
+// Both palette keys and shade names with ev- prefix
+const colours = {
+  'ev-main': { 
+    'ev-main-raw': { L: 0.55, C: 0.25, H: 5 },
+    'ev-main-200': { L: 0.8, C: 0.15, H: 0 }
+  },
+  'ev-sec': {
+    'ev-sec-500': { L: 0.5, C: 0.2, H: 120 }
+  },
+  'ev-acc': { 
+    'ev-acc-800': { L: 0.3, C: 0.2, H: 240 }
+  }
+};
+const palette = parseAndNormalizeEventColours(colours);
+// Returns: { main: { 'main-raw': {...}, 'main-200': {...} }, sec: { 'sec-500': {...} }, acc: { 'acc-800': {...} } }
+```

package/docs/api/functions/recordAuditEvent.md

@@ -0,0 +1,23 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / recordAuditEvent
+
+# Function: recordAuditEvent()
+
+> **recordAuditEvent**(`batched`): `void`
+
+Defined in: [rbac/performance.ts:186](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L186)
+
+Record an audit event
+
+## Parameters
+
+### batched
+
+`boolean`
+
+## Returns
+
+`void`

package/docs/api/functions/recordPermissionCheck.md

@@ -0,0 +1,31 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / recordPermissionCheck
+
+# Function: recordPermissionCheck()
+
+> **recordPermissionCheck**(`cacheHit`, `responseTime`, `wasDeduplicated?`): `void`
+
+Defined in: [rbac/performance.ts:175](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L175)
+
+Record a permission check
+
+## Parameters
+
+### cacheHit
+
+`boolean`
+
+### responseTime
+
+`number`
+
+### wasDeduplicated?
+
+`boolean` = `false`
+
+## Returns
+
+`void`

package/docs/api/functions/resetPerformanceMetrics.md

@@ -0,0 +1,17 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / resetPerformanceMetrics
+
+# Function: resetPerformanceMetrics()
+
+> **resetPerformanceMetrics**(): `void`
+
+Defined in: [rbac/performance.ts:200](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/performance.ts#L200)
+
+Reset performance metrics
+
+## Returns
+
+`void`

package/docs/api/functions/resolveAppContext.md

@@ -0,0 +1,27 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / resolveAppContext
+
+# Function: resolveAppContext()
+
+> **resolveAppContext**(`input`): `Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<`RBACAppContext` \| `null`\>\>
+
+Defined in: [rbac/api.ts:258](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/api.ts#L258)
+
+## Parameters
+
+### input
+
+#### userId
+
+`string`
+
+#### appName
+
+`string`
+
+## Returns
+
+`Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<`RBACAppContext` \| `null`\>\>

package/docs/api/functions/roundToNearestMinutes.md

@@ -0,0 +1,41 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / roundToNearestMinutes
+
+# Function: roundToNearestMinutes()
+
+> **roundToNearestMinutes**(`date`, `minutesStep?`): `Date`
+
+Defined in: [utils/timezone/timezone.ts:231](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/timezone/timezone.ts#L231)
+
+Round a date to the nearest X minutes
+
+## Parameters
+
+### date
+
+`Date`
+
+Date to round
+
+### minutesStep?
+
+`number` = `5`
+
+Number of minutes to round to (default: 5)
+
+## Returns
+
+`Date`
+
+Rounded date
+
+## Example
+
+```ts
+const date = new Date('2024-01-15T10:23:00Z');
+roundToNearestMinutes(date, 5);
+// Returns Date object for 10:25:00
+```

package/docs/api/functions/sanitizeFormData.md

@@ -0,0 +1,49 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / sanitizeFormData
+
+# Function: sanitizeFormData()
+
+> **sanitizeFormData**\<`T`\>(`data`, `schema`, `sanitizationRules?`): `object`
+
+Defined in: [utils/validation/sanitization.ts:170](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/validation/sanitization.ts#L170)
+
+Validates and sanitizes form data using Zod schemas
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### data
+
+`unknown`
+
+### schema
+
+`ZodType`\<`T`\>
+
+### sanitizationRules?
+
+`Record`\<`string`, `SanitizationOptions`\>
+
+## Returns
+
+`object`
+
+### success
+
+> **success**: `boolean`
+
+### data?
+
+> `optional` **data**: `T`
+
+### error?
+
+> `optional` **error**: `string`

package/docs/api/functions/sanitizeHtml.md

@@ -0,0 +1,39 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / sanitizeHtml
+
+# Function: sanitizeHtml()
+
+> **sanitizeHtml**(`html`): `string`
+
+Defined in: [utils/validation/htmlSanitization.ts:52](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/validation/htmlSanitization.ts#L52)
+
+Basic HTML sanitization function using regex-based approach
+Removes potentially dangerous elements and attributes while preserving basic formatting
+This approach is more reliable in SSR environments and doesn't require DOM manipulation
+
+## Parameters
+
+### html
+
+`string`
+
+The HTML string to sanitize
+
+## Returns
+
+`string`
+
+Sanitized HTML string safe for rendering
+
+## Example
+
+```tsx
+const safeHtml = sanitizeHtml('<p>Hello <strong>world</strong>!</p>');
+// Returns: '<p>Hello <strong>world</strong>!</p>'
+
+const dangerousHtml = sanitizeHtml('<script>alert("xss")</script><p>Safe content</p>');
+// Returns: '<p>Safe content</p>'
+```

package/docs/api/functions/sanitizeUserInput.md

@@ -0,0 +1,27 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / sanitizeUserInput
+
+# Function: sanitizeUserInput()
+
+> **sanitizeUserInput**(`input`, `options?`): `string`
+
+Defined in: [utils/validation/sanitization.ts:40](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/validation/sanitization.ts#L40)
+
+Sanitizes user input by removing potentially dangerous characters and patterns
+
+## Parameters
+
+### input
+
+`string`
+
+### options?
+
+`SanitizationOptions` = `{}`
+
+## Returns
+
+`string`

package/docs/api/functions/setAppConfig.md

@@ -0,0 +1,23 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / setAppConfig
+
+# Function: setAppConfig()
+
+> **setAppConfig**(`config`): `void`
+
+Defined in: [utils/app/appConfig.ts:16](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/app/appConfig.ts#L16)
+
+Set the current application configuration
+
+## Parameters
+
+### config
+
+`AppConfig`
+
+## Returns
+
+`void`

package/docs/api/functions/setGlobalAuditManager.md

@@ -0,0 +1,25 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / setGlobalAuditManager
+
+# Function: setGlobalAuditManager()
+
+> **setGlobalAuditManager**(`manager`): `void`
+
+Defined in: [rbac/audit.ts:470](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/audit.ts#L470)
+
+Set the global audit manager
+
+## Parameters
+
+### manager
+
+[`RBACAuditManager`](../classes/RBACAuditManager.md)
+
+Audit manager instance
+
+## Returns
+
+`void`

package/docs/api/functions/setupRBAC.md

@@ -0,0 +1,31 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / setupRBAC
+
+# Function: setupRBAC()
+
+> **setupRBAC**(`supabase`, `config?`): `void`
+
+Defined in: [rbac/api.ts:78](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/api.ts#L78)
+
+Setup RBAC system
+
+## Parameters
+
+### supabase
+
+`SupabaseClient`\<`Database`\>
+
+Supabase client
+
+### config?
+
+`Partial`\<[`RBACConfig`](../type-aliases/RBACConfig.md)\>
+
+Optional configuration
+
+## Returns
+
+`void`

package/docs/api/functions/sum.md

@@ -0,0 +1,63 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / sum
+
+# Function: sum()
+
+> **sum**\<`TData`\>(`accessorKey`): \<`TRow`\>(`rows`, `_column`) => `number`
+
+Defined in: [components/DataTable/utils/aggregationUtils.ts:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/utils/aggregationUtils.ts#L28)
+
+Creates a sum 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 sum (e.g., 'cost', 'quantity')
+
+`string` | keyof `TData`
+
+## Returns
+
+An aggregation function that sums 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: 'cost',
+  header: 'Total Cost',
+  aggregateFn: sum('cost'),
+}
+```