@jmruthers/pace-core 0.6.11 → 0.6.12

package/docs/api/functions/useFileReferenceById.md

@@ -0,0 +1,63 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useFileReferenceById
+
+# Function: useFileReferenceById()
+
+> **useFileReferenceById**(`supabase`, `fileReferenceId`, `organisationId`): `object`
+
+Defined in: [hooks/useFileReference.ts:347](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFileReference.ts#L347)
+
+Hook for getting a file reference by ID
+
+## Parameters
+
+### supabase
+
+`SupabaseClient`
+
+### fileReferenceId
+
+`string` | `null`
+
+### organisationId
+
+`string` | `null`
+
+## Returns
+
+`object`
+
+### isLoading
+
+> **isLoading**: `boolean`
+
+### error
+
+> **error**: `string` \| `null`
+
+### fileReference
+
+> **fileReference**: [`FileReference`](../interfaces/FileReference.md) \| `null`
+
+### fileUrl
+
+> **fileUrl**: `string` \| `null`
+
+### loadFileReference()
+
+> **loadFileReference**: () => `Promise`\<[`FileReference`](../interfaces/FileReference.md) \| `null`\>
+
+#### Returns
+
+`Promise`\<[`FileReference`](../interfaces/FileReference.md) \| `null`\>
+
+### clearError()
+
+> **clearError**: () => `void`
+
+#### Returns
+
+`void`

package/docs/api/functions/useFileReferenceForRecord.md

@@ -0,0 +1,129 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useFileReferenceForRecord
+
+# Function: useFileReferenceForRecord()
+
+> **useFileReferenceForRecord**(`supabase`, `table_name`, `record_id`, `organisation_id`): `object`
+
+Defined in: [hooks/useFileReference.ts:243](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFileReference.ts#L243)
+
+## Parameters
+
+### supabase
+
+`SupabaseClient`
+
+### table\_name
+
+`string`
+
+### record\_id
+
+`string`
+
+### organisation\_id
+
+`string`
+
+## Returns
+
+`object`
+
+### isLoading
+
+> **isLoading**: `boolean`
+
+### error
+
+> **error**: `string` \| `null`
+
+### fileUrl
+
+> **fileUrl**: `string` \| `null`
+
+### fileReference
+
+> **fileReference**: [`FileReference`](../interfaces/FileReference.md) \| `null`
+
+### fileReferences
+
+> **fileReferences**: [`FileReference`](../interfaces/FileReference.md)[]
+
+### fileCount
+
+> **fileCount**: `number`
+
+### loadFileReference()
+
+> **loadFileReference**: () => `Promise`\<[`FileReference`](../interfaces/FileReference.md) \| `null`\>
+
+#### Returns
+
+`Promise`\<[`FileReference`](../interfaces/FileReference.md) \| `null`\>
+
+### loadFileUrl()
+
+> **loadFileUrl**: () => `Promise`\<`string` \| `null`\>
+
+#### Returns
+
+`Promise`\<`string` \| `null`\>
+
+### loadFileReferences()
+
+> **loadFileReferences**: () => `Promise`\<[`FileReference`](../interfaces/FileReference.md)[]\>
+
+#### Returns
+
+`Promise`\<[`FileReference`](../interfaces/FileReference.md)[]\>
+
+### loadFileCount()
+
+> **loadFileCount**: () => `Promise`\<`number`\>
+
+#### Returns
+
+`Promise`\<`number`\>
+
+### deleteFile()
+
+> **deleteFile**: (`delete_file?`) => `Promise`\<`boolean`\>
+
+#### Parameters
+
+##### delete\_file?
+
+`boolean`
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+### 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`\>
+
+### clearError()
+
+> **clearError**: () => `void`
+
+#### Returns
+
+`void`

package/docs/api/functions/useFilesByCategory.md

@@ -0,0 +1,80 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useFilesByCategory
+
+# Function: useFilesByCategory()
+
+> **useFilesByCategory**(`supabase`, `table_name`, `record_id`, `category`, `organisation_id`): `object`
+
+Defined in: [hooks/useFileReference.ts:424](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFileReference.ts#L424)
+
+Convenience hook for getting files by category with automatic URL loading.
+
+This hook wraps useFileReference().getFilesByCategory and automatically:
+- Loads file references filtered by category
+- Generates URLs for all files (public URLs for public files, signed URLs for private files)
+- Manages state for fileReferences and fileUrls
+- Auto-refetches when table_name, record_id, category, or organisation_id changes
+
+Use this hook when you need files by category with their URLs ready to display.
+For more control, use useFileReference() directly and manage URLs yourself.
+
+## Parameters
+
+### supabase
+
+`SupabaseClient`
+
+### table\_name
+
+`string`
+
+### record\_id
+
+`string`
+
+### category
+
+[`FileCategory`](../enumerations/FileCategory.md) | `null`
+
+### organisation\_id
+
+`string` | `null`
+
+## Returns
+
+`object`
+
+### isLoading
+
+> **isLoading**: `boolean`
+
+### error
+
+> **error**: `string` \| `null`
+
+### fileReferences
+
+> **fileReferences**: [`FileReference`](../interfaces/FileReference.md)[]
+
+### fileUrls
+
+> **fileUrls**: `Map`\<`string`, `string`\>
+
+### loadFiles()
+
+> **loadFiles**: () => `Promise`\<[`FileReference`](../interfaces/FileReference.md)[]\>
+
+#### Returns
+
+`Promise`\<[`FileReference`](../interfaces/FileReference.md)[]\>
+
+### clearError()
+
+> **clearError**: () => `void`
+
+#### Returns
+
+`void`

package/docs/api/functions/useFormDialog.md

@@ -0,0 +1,62 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useFormDialog
+
+# Function: useFormDialog()
+
+> **useFormDialog**\<`T`\>(`options?`): [`UseFormDialogReturn`](../interfaces/UseFormDialogReturn.md)\<`T`\>
+
+Defined in: [hooks/useFormDialog.ts:111](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L111)
+
+Generic React hook for managing form dialog state.
+
+Provides state management for form dialogs including:
+- Open/close state
+- Form data management
+- Automatic reset on close (configurable)
+- Controlled and uncontrolled usage patterns
+
+## Type Parameters
+
+### T
+
+`T` = `unknown`
+
+## Parameters
+
+### options?
+
+[`UseFormDialogOptions`](../interfaces/UseFormDialogOptions.md) = `{}`
+
+Configuration options for the hook
+
+## Returns
+
+[`UseFormDialogReturn`](../interfaces/UseFormDialogReturn.md)\<`T`\>
+
+Object containing dialog state and control functions
+
+## Example
+
+```ts
+// Basic usage
+const { isOpen, openDialog, closeDialog } = useFormDialog();
+
+// With form data
+interface UserData {
+  id: string;
+  name: string;
+}
+const { isOpen, formData, openDialog } = useFormDialog<UserData>();
+
+// Open with data
+openDialog({ id: '1', name: 'John' });
+
+// Controlled usage with callback
+const { handleOpenChange, isOpen } = useFormDialog({
+  onOpenChange: (open) => console.log('Dialog state:', open),
+  resetOnClose: false
+});
+```

package/docs/api/functions/useInactivityService.md

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

package/docs/api/functions/useInactivityTracker.md

@@ -0,0 +1,21 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useInactivityTracker
+
+# Function: useInactivityTracker()
+
+> **useInactivityTracker**(`__namedParameters?`): [`UseInactivityTrackerReturn`](../interfaces/UseInactivityTrackerReturn.md)
+
+Defined in: [hooks/useInactivityTracker.ts:218](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L218)
+
+## Parameters
+
+### \_\_namedParameters?
+
+[`UseInactivityTrackerOptions`](../interfaces/UseInactivityTrackerOptions.md) = `{}`
+
+## Returns
+
+[`UseInactivityTrackerReturn`](../interfaces/UseInactivityTrackerReturn.md)

package/docs/api/functions/useIsPublicPage.md

@@ -0,0 +1,19 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useIsPublicPage
+
+# Function: useIsPublicPage()
+
+> **useIsPublicPage**(): `boolean`
+
+Defined in: [components/PublicLayout/usePublicPageContext.ts:33](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/PublicLayout/usePublicPageContext.ts#L33)
+
+Hook to check if we're in a public page context
+
+## Returns
+
+`boolean`
+
+True if we're in a public page context

package/docs/api/functions/useMultiplePermissions.md

@@ -0,0 +1,88 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useMultiplePermissions
+
+# Function: useMultiplePermissions()
+
+> **useMultiplePermissions**(`userId`, `scope`, `permissions`, `useCache?`): `object`
+
+Defined in: [rbac/hooks/permissions/useMultiplePermissions.ts:37](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/permissions/useMultiplePermissions.ts#L37)
+
+Hook to check multiple permissions at once
+
+## Parameters
+
+### userId
+
+`string`
+
+User ID
+
+### scope
+
+Scope for permission checking; null means scope not yet resolved — stays loading, no API call
+
+[`Scope`](../type-aliases/Scope.md) | `null`
+
+### permissions
+
+(`` `read:${string}` `` \| `` `create:${string}` `` \| `` `update:${string}` `` \| `` `delete:${string}` ``)[]
+
+Array of permissions to check
+
+### useCache?
+
+`boolean` = `true`
+
+Whether to use cached results
+
+## Returns
+
+`object`
+
+Multiple permission check results
+
+### results
+
+> **results**: `Record`\<[`Permission`](../type-aliases/Permission.md), `boolean`\>
+
+### isLoading
+
+> **isLoading**: `boolean`
+
+### error
+
+> **error**: `Error` \| `null`
+
+### refetch()
+
+> **refetch**: () => `Promise`\<`void`\>
+
+#### Returns
+
+`Promise`\<`void`\>
+
+## Example
+
+```tsx
+function MyComponent() {
+  const { results, isLoading, error } = useMultiplePermissions(
+    userId,
+    scope,
+    ['read:users', 'create:users', 'update:users']
+  );
+
+  if (isLoading) return null; // or use a loading component
+  if (error) return <Alert variant="destructive"><AlertDescription>Error: {error.message}</AlertDescription></Alert>;
+
+  return (
+    <>
+      {results['read:users'] && <UserList />}
+      {results['create:users'] && <CreateUserButton />}
+      {results['update:users'] && <EditUserButton />}
+    </>
+  );
+}
+```

package/docs/api/functions/useOptionalEvents.md

@@ -0,0 +1,31 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useOptionalEvents
+
+# Function: useOptionalEvents()
+
+> **useOptionalEvents**(): `object`
+
+Defined in: [hooks/useEvents.ts:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useEvents.ts#L31)
+
+Optional event context hook that never throws.
+Use when a component must work with or without EventServiceProvider (e.g. PaceAppLayout).
+
+## Returns
+
+`object`
+
+`{ selectedEvent: Event | null }` — when provider is absent, `selectedEvent` is always null.
+
+### selectedEvent
+
+> **selectedEvent**: `Event` \| `null`
+
+## Example
+
+```ts
+const { selectedEvent } = useOptionalEvents();
+// selectedEvent is null when outside EventServiceProvider; otherwise the current selected event.
+```

package/docs/api/functions/useOrganisationPermissions.md

@@ -0,0 +1,27 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useOrganisationPermissions
+
+# Function: useOrganisationPermissions()
+
+> **useOrganisationPermissions**(`orgId?`): `UseOrganisationPermissionsReturn`
+
+Defined in: [hooks/useOrganisationPermissions.ts:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useOrganisationPermissions.ts#L101)
+
+Hook to access organisation-specific permissions and roles
+
+## Parameters
+
+### orgId?
+
+`string`
+
+Optional organisation ID. Defaults to currently selected organisation
+
+## Returns
+
+`UseOrganisationPermissionsReturn`
+
+Organisation permissions and role information

package/docs/api/functions/useOrganisationSecurity.md

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

package/docs/api/functions/useOrganisationService.md

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

package/docs/api/functions/useOrganisations.md

@@ -0,0 +1,48 @@
+[**@jmruthers/pace-core v0.6.12**](../README.md)
+
+***
+
+[@jmruthers/pace-core](../globals.md) / useOrganisations
+
+# Function: useOrganisations()
+
+> **useOrganisations**(): [`OrganisationContextType`](../type-aliases/OrganisationContextType.md)
+
+Defined in: [hooks/useOrganisations.ts:47](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useOrganisations.ts#L47)
+
+Hook to access organisation context
+
+## Returns
+
+[`OrganisationContextType`](../type-aliases/OrganisationContextType.md)
+
+Organisation context with selected organisation, organisations list, and helper methods
+
+## Throws
+
+If used outside OrganisationServiceProvider
+
+## Example
+
+```tsx
+function MyComponent() {
+  const { selectedOrganisation, organisations, switchOrganisation } = useOrganisations();
+  
+  return (
+    <main>
+      <h1>Current Organisation: {selectedOrganisation.display_name}</h1>
+      <nav>
+        <ul>
+          {organisations.map(org => (
+            <li key={org.id}>
+              <button onClick={() => switchOrganisation(org.id)}>
+                {org.display_name}
+              </button>
+            </li>
+          ))}
+        </ul>
+      </nav>
+    </main>
+  );
+}
+```