@jmruthers/pace-core 0.6.11 → 0.6.12

package/docs/api/functions/toZonedTime.md

@@ -0,0 +1,41 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / toZonedTime
+
+# Function: toZonedTime()
+
+> **toZonedTime**(`date`, `timezone`): `Date`
+
+Defined in: [utils/timezone/timezone.ts:171](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/timezone/timezone.ts#L171)
+
+Convert a UTC date to a specific timezone's local time representation
+
+## Parameters
+
+### date
+
+`Date`
+
+UTC date to convert
+
+### timezone
+
+`string`
+
+IANA timezone string
+
+## Returns
+
+`Date`
+
+Date object representing local time in the timezone
+
+## Example
+
+```ts
+const utcDate = new Date('2024-01-15T10:00:00Z');
+const localDate = toZonedTime(utcDate, 'America/New_York');
+// Returns Date object representing 5:00 AM in New York
+```

package/docs/api/functions/uploadFile.md

@@ -0,0 +1,32 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / uploadFile
+
+# Function: uploadFile()
+
+> **uploadFile**(`supabase`, `file`, `options`): `Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<[`StorageUploadSuccess`](../interfaces/StorageUploadSuccess.md)\>\>
+
+Defined in: [utils/storage/helpers.ts:230](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/storage/helpers.ts#L230)
+
+Upload a file to Supabase storage with app segregation.
+Returns ApiResult with path, optional publicUrl and metadata on success.
+
+## Parameters
+
+### supabase
+
+`SupabaseClient`
+
+### file
+
+`File`
+
+### options
+
+[`StorageUploadOptions`](../interfaces/StorageUploadOptions.md)
+
+## Returns
+
+`Promise`\<[`ApiResult`](../type-aliases/ApiResult.md)\<[`StorageUploadSuccess`](../interfaces/StorageUploadSuccess.md)\>\>

package/docs/api/functions/useAccessLevel.md

@@ -0,0 +1,71 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useAccessLevel
+
+# Function: useAccessLevel()
+
+> **useAccessLevel**(`userId`, `scope`): `object`
+
+Defined in: [rbac/hooks/permissions/useAccessLevel.ts:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/permissions/useAccessLevel.ts#L31)
+
+Hook to get user's access level in a scope
+
+## Parameters
+
+### userId
+
+`string`
+
+User ID
+
+### scope
+
+[`Scope`](../type-aliases/Scope.md)
+
+Scope for access level checking
+
+## Returns
+
+`object`
+
+Access level state and methods
+
+### accessLevel
+
+> **accessLevel**: [`AccessLevel`](../type-aliases/AccessLevel.md)
+
+### isLoading
+
+> **isLoading**: `boolean`
+
+### error
+
+> **error**: `Error` \| `null`
+
+### refetch()
+
+> **refetch**: () => `Promise`\<`void`\>
+
+#### Returns
+
+`Promise`\<`void`\>
+
+## Example
+
+```tsx
+function MyComponent() {
+  const { accessLevel, isLoading, error } = useAccessLevel(userId, scope);
+
+  if (isLoading) return null; // or use a loading component
+  if (error) return <Alert variant="destructive"><AlertDescription>Error: {error.message}</AlertDescription></Alert>;
+
+  return (
+    <>
+      <p>Access Level: {accessLevel}</p>
+      {accessLevel >= AccessLevel.ADMIN && <AdminPanel />}
+    </>
+  );
+}
+```

package/docs/api/functions/useAccessibleApps.md

@@ -0,0 +1,55 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useAccessibleApps
+
+# Function: useAccessibleApps()
+
+> **useAccessibleApps**(`currentAppName?`): [`UseAccessibleAppsReturn`](../interfaces/UseAccessibleAppsReturn.md)
+
+Defined in: [hooks/useAccessibleApps.ts:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useAccessibleApps.ts#L77)
+
+Hook to fetch all apps the current user has access to.
+
+Queries rbac_event_app_roles to find all apps where the user has active roles,
+then joins with rbac_apps to get app details. Excludes the current app.
+
+## Parameters
+
+### currentAppName?
+
+`string`
+
+The name of the current app to exclude from results
+
+## Returns
+
+[`UseAccessibleAppsReturn`](../interfaces/UseAccessibleAppsReturn.md)
+
+Object with apps array, loading state, error, and refetch function
+
+## Example
+
+```tsx
+import { useAccessibleApps } from '@jmruthers/pace-core';
+import { useUnifiedAuth } from '@jmruthers/pace-core/providers';
+
+function AppSwitcher() {
+  const { appName } = useUnifiedAuth();
+  const { apps, loading, error } = useAccessibleApps(appName);
+
+  if (loading) return <div>Loading apps...</div>;
+  if (error) return <div>Error: {error.message}</div>;
+
+  return (
+    <select>
+      {apps.map(app => (
+        <option key={app.id} value={app.name}>
+          {app.displayName}
+        </option>
+      ))}
+    </select>
+  );
+}
+```

package/docs/api/functions/useAppConfig.md

@@ -0,0 +1,20 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useAppConfig
+
+# Function: useAppConfig()
+
+> **useAppConfig**(): `UseAppConfigReturn`
+
+Defined in: [hooks/useAppConfig.ts:39](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useAppConfig.ts#L39)
+
+Hook to access app configuration
+Works in both authenticated and public contexts
+
+## Returns
+
+`UseAppConfigReturn`
+
+App configuration and loading state

package/docs/api/functions/useAuthService.md

@@ -0,0 +1,15 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useAuthService
+
+# Function: useAuthService()
+
+> **useAuthService**(): `AuthService`
+
+Defined in: [hooks/services/useAuthService.ts:15](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/services/useAuthService.ts#L15)
+
+## Returns
+
+`AuthService`

package/docs/api/functions/useCan.md

@@ -0,0 +1,99 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useCan
+
+# Function: useCan()
+
+> **useCan**(`userId`, `scope`, `permission`, `pageId?`, `useCache?`, `precomputedSuperAdmin?`, `appName?`): `object`
+
+Defined in: [rbac/hooks/permissions/useCan.ts:109](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/permissions/useCan.ts#L109)
+
+Hook to check if user can perform an action
+
+## Parameters
+
+### userId
+
+`string`
+
+User ID
+
+### scope
+
+Scope for permission checking; null means scope not yet resolved — permission check stays in loading, no RPC is called
+
+[`Scope`](../type-aliases/Scope.md) | `null`
+
+### permission
+
+Permission to check
+
+`` `read:${string}` `` | `` `create:${string}` `` | `` `update:${string}` `` | `` `delete:${string}` ``
+
+### pageId?
+
+`string`
+
+Optional page ID
+
+### useCache?
+
+`boolean` = `true`
+
+Whether to use cached results
+
+### precomputedSuperAdmin?
+
+Pre-computed super admin flag to avoid duplicate super admin checks.
+Callers should check super admin once and pass the result to all useCan hooks.
+Pass null if not checked yet, false/true if checked.
+Defaults to null (not checked yet) - hook will check if needed.
+
+`boolean` | `null`
+
+### appName?
+
+`string`
+
+Optional app name (for PORTAL/ADMIN special case)
+
+## Returns
+
+`object`
+
+Permission check state and methods
+
+### can
+
+> **can**: `boolean`
+
+### isLoading
+
+> **isLoading**: `boolean`
+
+### error
+
+> **error**: `Error` \| `null`
+
+### refetch()
+
+> **refetch**: () => `Promise`\<`void`\>
+
+#### Returns
+
+`Promise`\<`void`\>
+
+## Example
+
+```tsx
+function MyComponent() {
+  const { can, isLoading, error } = useCan(userId, scope, 'read:users');
+
+  if (isLoading) return null; // or use a loading component
+  if (error) return <Alert variant="destructive"><AlertDescription>Error: {error.message}</AlertDescription></Alert>;
+
+  return can ? <UserList /> : <AccessDenied />;
+}
+```

package/docs/api/functions/useEventService.md

@@ -0,0 +1,15 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useEventService
+
+# Function: useEventService()
+
+> **useEventService**(): `EventService`
+
+Defined in: [hooks/services/useEventService.ts:15](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/services/useEventService.ts#L15)
+
+## Returns
+
+`EventService`

package/docs/api/functions/useEventTheme.md

@@ -0,0 +1,26 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useEventTheme
+
+# Function: useEventTheme()
+
+> **useEventTheme**(`event?`): `void`
+
+Defined in: [hooks/useEventTheme.ts:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useEventTheme.ts#L101)
+
+Hook that automatically applies event-specific theming.
+Works in authenticated mode (via EventProvider) or public page mode (via event prop).
+
+## Parameters
+
+### event?
+
+Optional event object for public page mode. If not provided, uses EventProvider context.
+
+`Event` | `null`
+
+## Returns
+
+`void`

package/docs/api/functions/useEvents.md

@@ -0,0 +1,45 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useEvents
+
+# Function: useEvents()
+
+> **useEvents**(): `EventContextType`
+
+Defined in: [hooks/useEvents.ts:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useEvents.ts#L95)
+
+Hook to access event context
+
+## Returns
+
+`EventContextType`
+
+Event context with events, selected event, and helper methods
+
+## Throws
+
+If used outside EventServiceProvider
+
+## Example
+
+```tsx
+function MyComponent() {
+  const { events, selectedEvent, setSelectedEvent } = useEvents();
+  
+  return (
+    <nav>
+      <ul>
+        {events.map(event => (
+          <li key={event.id}>
+            <button onClick={() => setSelectedEvent(event)}>
+              {event.event_name}
+            </button>
+          </li>
+        ))}
+      </ul>
+    </nav>
+  );
+}
+```

package/docs/api/functions/useFileReference.md

@@ -0,0 +1,264 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useFileReference
+
+# Function: useFileReference()
+
+> **useFileReference**(`supabase`): `object`
+
+Defined in: [hooks/useFileReference.ts:91](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFileReference.ts#L91)
+
+Hook for managing file references.
+Provides file upload, retrieval, and URL generation functionality.
+
+## Parameters
+
+### supabase
+
+`SupabaseClient`
+
+Supabase client instance
+
+## Returns
+
+`object`
+
+File reference service with upload, get, and URL methods
+
+### isLoading
+
+> **isLoading**: `boolean`
+
+### error
+
+> **error**: `string` \| `null`
+
+### uploadFile()
+
+> **uploadFile**: (`options`, `file`) => `Promise`\<`FileUploadResult` \| `null`\>
+
+#### Parameters
+
+##### options
+
+[`FileUploadOptions`](../interfaces/FileUploadOptions.md)
+
+##### file
+
+`File`
+
+#### Returns
+
+`Promise`\<`FileUploadResult` \| `null`\>
+
+### getFileReference()
+
+> **getFileReference**: (`table_name`, `record_id`, `organisation_id`) => `Promise`\<[`FileReference`](../interfaces/FileReference.md) \| `null`\>
+
+#### Parameters
+
+##### table\_name
+
+`string`
+
+##### record\_id
+
+`string`
+
+##### organisation\_id
+
+`string`
+
+#### Returns
+
+`Promise`\<[`FileReference`](../interfaces/FileReference.md) \| `null`\>
+
+### getFileReferenceById()
+
+> **getFileReferenceById**: (`id`, `organisation_id`) => `Promise`\<[`FileReference`](../interfaces/FileReference.md) \| `null`\>
+
+#### Parameters
+
+##### id
+
+`string`
+
+##### organisation\_id
+
+`string`
+
+#### Returns
+
+`Promise`\<[`FileReference`](../interfaces/FileReference.md) \| `null`\>
+
+### getFileUrl()
+
+> **getFileUrl**: (`table_name`, `record_id`, `organisation_id`) => `Promise`\<`string` \| `null`\>
+
+#### Parameters
+
+##### table\_name
+
+`string`
+
+##### record\_id
+
+`string`
+
+##### organisation\_id
+
+`string`
+
+#### Returns
+
+`Promise`\<`string` \| `null`\>
+
+### getSignedUrl()
+
+> **getSignedUrl**: (`table_name`, `record_id`, `organisation_id`, `expires_in?`) => `Promise`\<`string` \| `null`\>
+
+#### Parameters
+
+##### table\_name
+
+`string`
+
+##### record\_id
+
+`string`
+
+##### organisation\_id
+
+`string`
+
+##### expires\_in?
+
+`number`
+
+#### Returns
+
+`Promise`\<`string` \| `null`\>
+
+### updateFileReference()
+
+> **updateFileReference**: (`id`, `updates`) => `Promise`\<[`FileReference`](../interfaces/FileReference.md) \| `null`\>
+
+#### Parameters
+
+##### id
+
+`string`
+
+##### updates
+
+`Partial`\<[`FileReference`](../interfaces/FileReference.md)\>
+
+#### Returns
+
+`Promise`\<[`FileReference`](../interfaces/FileReference.md) \| `null`\>
+
+### deleteFileReference()
+
+> **deleteFileReference**: (`table_name`, `record_id`, `organisation_id`, `delete_file?`) => `Promise`\<`boolean`\>
+
+#### Parameters
+
+##### table\_name
+
+`string`
+
+##### record\_id
+
+`string`
+
+##### organisation\_id
+
+`string`
+
+##### delete\_file?
+
+`boolean`
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+### listFileReferences()
+
+> **listFileReferences**: (`table_name`, `record_id`, `organisation_id`) => `Promise`\<[`FileReference`](../interfaces/FileReference.md)[]\>
+
+#### Parameters
+
+##### table\_name
+
+`string`
+
+##### record\_id
+
+`string`
+
+##### organisation\_id
+
+`string`
+
+#### Returns
+
+`Promise`\<[`FileReference`](../interfaces/FileReference.md)[]\>
+
+### getFilesByCategory()
+
+> **getFilesByCategory**: (`table_name`, `record_id`, `category`, `organisation_id`) => `Promise`\<[`FileReference`](../interfaces/FileReference.md)[]\>
+
+#### Parameters
+
+##### table\_name
+
+`string`
+
+##### record\_id
+
+`string`
+
+##### category
+
+[`FileCategory`](../enumerations/FileCategory.md)
+
+##### organisation\_id
+
+`string`
+
+#### Returns
+
+`Promise`\<[`FileReference`](../interfaces/FileReference.md)[]\>
+
+### getFileCount()
+
+> **getFileCount**: (`table_name`, `record_id`, `organisation_id`) => `Promise`\<`number`\>
+
+#### Parameters
+
+##### table\_name
+
+`string`
+
+##### record\_id
+
+`string`
+
+##### organisation\_id
+
+`string`
+
+#### Returns
+
+`Promise`\<`number`\>
+
+### clearError()
+
+> **clearError**: () => `void`
+
+#### Returns
+
+`void`