platform — Public API surface
Types & interfaces
interface ActiveLeadForConversion
- file: src/platform/ce/useActiveLeadsForConversion.ts:14
- kind: interface
- core: platform
- spec: (none)
- summary: Shape of an active lead with joined contact data for conversion selection.
- score: 2
type AgentFormValues
- file: src/platform/cowork/ui/AgentFormSheet.tsx:37
- kind: type
- core: platform
- spec: (none)
- summary: Validated values produced by the agent create/edit form, inferred from. Mirrors the writable subset of a row theadmin UI exposes (name, description, default skill, model-routing hint,agent-principal UUID, and active/paused status) — the parent maps these ontothe create or update mutation.
- score: 2
interface AgentMemoryForgetArgs
- file: src/platform/ai/agentic/agent-memory-types.ts:51
- kind: interface
- core: platform
- spec: (none)
- summary: Hard-delete request (TTL expiry, org/thread purge, consent revocation).
- score: 2
interface AgentMemoryRecallQuery
- file: src/platform/ai/agentic/agent-memory-types.ts:33
- kind: interface
- core: platform
- spec: (none)
- summary: A scoped semantic recall request. Scope keys gate which rows the RPC may return.
- score: 2
interface AgentMemoryRecallRow
- file: src/platform/ai/agentic/agent-memory-types.ts:42
- kind: interface
- core: platform
- spec: (none)
- summary: A recalled, prompt-safe memory row. Carries ONLY the redacted projection — never raw .
- score: 2
interface AgentMemoryWriteEntry
- file: src/platform/ai/agentic/agent-memory-types.ts:14
- kind: interface
- core: platform
- spec: (none)
- summary: A learned-context fact to persist. may carry PHI; the adapter computes its redacted twin.
- score: 2
interface AgentMessageBadgeProps
- file: src/platform/cowork/components/AgentMessageBadge.tsx:27
- kind: interface
- core: platform
- spec: (none)
- summary: Props for — the agent and authorizing human to attribute, plus an optional admin-only principal label. Carries display strings only; never the raw principal UUID.
- score: 2
interface AiFairnessMonitoredSurface
- file: src/platform/ai/constants/ai-fairness-surfaces.ts:33
- kind: interface
- core: platform
- spec: (none)
- summary: A production AI surface tracked under fairness/bias governance.
- score: 2
interface AIMappingSuggestionCellSuggestion
- file: src/platform/ai/components/AIMappingSuggestionCell.tsx:21
- kind: interface
- core: platform
- spec: (none)
- summary: A suggestion to render in the cell.
- score: 2
interface AiOnboardingWizardData
- file: src/platform/ai/constants/ai-onboarding.ts:120
- kind: interface
- core: platform
- spec: (none)
- summary: Wizard form-data shape (see spec Data Model § Wizard form data shape).
- score: 2
type AllowedTable
- file: src/platform/dashboard/hooks/useCustomWidgets.ts:26
- kind: type
- core: platform
- spec: (none)
- summary: Union of table names the custom-widget builder UX offers; the pf_widget_query broker is the authoritative server-side allowlist, so this type is for the picker, not a security boundary.
- score: 2
interface AnalyticsQuerySpec
- file: src/platform/analytics/hooks/useAnalyticsQuery.ts:21
- kind: interface
- core: platform
- spec: (none)
- summary: A no-SQL query spec — registry keys only, never raw SQL (compiled server-side).
- score: 2
interface AnalyticsQuerySpec
- file: src/platform/analytics/semantic-compiler.ts:46
- kind: interface
- core: platform
- spec: (none)
- summary: What the client requests — never raw SQL; only registry keys.
- score: 2
interface AnalyticsRunResult
- file: src/platform/analytics/hooks/useAnalyticsQuery.ts:44
- kind: interface
- core: platform
- spec: (none)
- summary: The Tier-2 RPC envelope ( returns this jsonb).
- score: 2
type AnalyticsSurface
- file: src/platform/analytics/hooks/useAnalyticsQuery.ts:18
- kind: type
- core: platform
- spec: (none)
- summary: Surfaces the audit log distinguishes (FR-9). The in-app builder uses .
- score: 2
interface AnomalyConfig
- file: src/platform/query-performance/anomaly-rules.ts:22
- kind: interface
- core: platform
- spec: (none)
- summary: Configuration for anomaly detection
- score: 2
interface AnomalyDetectionResult
- file: src/platform/query-performance/anomaly-rules.ts:12
- kind: interface
- core: platform
- spec: (none)
- summary: Result of anomaly evaluation
- score: 1
type AnomalyRuleType
- file: src/platform/query-performance/anomaly-rules.ts:9
- kind: type
- core: platform
- spec: (none)
- summary: Anomaly rule types
- score: 1
type AnyPermission
- file: src/platform/permissions/constants.ts:2452
- kind: type
- core: platform
- spec: (none)
- summary: Union of every permission key across all modules.
- score: 2
type ArtifactScreenFn
- file: src/platform/ai/agentic/artifact-prompt-context.ts:59
- kind: type
- core: platform
- spec: (none)
- summary: A screen function: returns the prompt-safe text, or THROWS to fail closed.
- score: 2
interface ArtifactVersionForPrompt
- file: src/platform/ai/agentic/artifact-prompt-context.ts:34
- kind: interface
- core: platform
- spec: (none)
- summary: Minimal projection of a row needed for prompt reuse. Deliberately omitsthe raw PHI — a prompt may only ever see the redacted projection, so it is not even inscope here.
- score: 2
interface AsamContinuumPolicy
- file: src/platform/clinical/loc/asam-continuum.ts:19
- kind: interface
- core: platform
- spec: (none)
- summary: Resolved jurisdiction policy for the ASAM CONTINUUM tool.
- score: 2
interface AsamLocAssessment
- file: src/platform/clinical/blocks/asam-loc-adapter.ts:58
- kind: interface
- core: platform
- spec: (none)
- summary: The asam_loc block’s form-value shape (field_schema keys). Ratings are codedstrings ‘0’–‘4’ (PF-15 ); LOC codes bind to the value set; / are read-only echoes of theunderlying row so renderers can show lifecycle state (never written back).
- score: 2
interface AsyncValidationResult
- file: src/platform/wizards/utils/async-validation.ts:29
- kind: interface
- core: platform
- spec: (none)
- summary: Result of async validation
- score: 1
interface AsyncValidationRule
- file: src/platform/wizards/utils/async-validation.ts:10
- kind: interface
- core: platform
- spec: (none)
- summary: Async validation rule configuration
- score: 2
interface AuthorOrgProfileDraftInput
- file: src/platform/knowledge/hooks/use-seed-org-knowledge.ts:45
- kind: interface
- core: platform
- spec: (none)
- summary: Inputs for the author branch — admin/wizard-supplied narrative, no source document.
- score: 2
type BatchFrequency
- file: src/platform/notifications/utils/retry.ts:111
- kind: type
- core: platform
- spec: (none)
- summary: Batch frequency types.
- score: 1
interface BedCensusSummary
- file: src/platform/census/fetchBedCensusSummary.ts:13
- kind: interface
- core: platform
- spec: (none)
- summary: Aggregate bed counts for an organization, partitioned by state (occupied /available / reserved / maintenance) with as occupied ÷ total.Returned by for dashboard census widgets.
- score: 2
interface BenefitsIntegrationStatus
- file: src/platform/onboarding/integrations/benefitsIntegration.ts:31
- kind: interface
- core: platform
- spec: (none)
- summary: Enhanced benefits status with urgency and actionable recommendations
- score: 2
interface BenefitsOnboardingTask
- file: src/platform/onboarding/integrations/benefitsIntegration.ts:140
- kind: interface
- core: platform
- spec: (none)
- summary: Generate onboarding task for benefits enrollment
- score: 2
type BenefitsUrgency
- file: src/platform/onboarding/integrations/benefitsIntegration.ts:26
- kind: type
- core: platform
- spec: (none)
- summary: Benefits enrollment urgency levels
- score: 2
interface BrandVoice
- file: src/platform/ai/constants/ai-onboarding.ts:111
- kind: interface
- core: platform
- spec: (none)
- summary: Structured brand-voice object stored in pf_module_settings.brand_voice.
- score: 2
interface BundleInstallRow
- file: src/platform/ai/hooks/useBundleInstalls.ts:14
- kind: interface
- core: platform
- spec: (none)
- summary: Matches the pf_bundle_installs columns (partial — governance_decision is JSONB).
- score: 2
interface CalendarEventInput
- file: src/platform/integrations/google-workspace.ts:17
- kind: interface
- core: platform
- spec: (none)
- summary: Input for : the target org and Workspacesubject (whose calendar the event lands on), the calendar id, the event body(summary/description should already be PHI-redacted by the caller), and anoptional Meet-link request plus attendee-notification policy.
- score: 2
interface CalendarEventResult
- file: src/platform/integrations/google-workspace.ts:37
- kind: interface
- core: platform
- spec: (none)
- summary: Result of : the created Google event id,its , an optional Meet join link (when was set), andthe redacted correlation id for tracing the originating sync run.
- score: 2
interface CallMetrics
- file: src/platform/telephony/hooks/useEmbeddableCall.ts:18
- kind: interface
- core: platform
- spec: (none)
- summary: Call connection metrics (T19)
- score: 1
interface CaptureTarget
- file: src/platform/automation/portal/recorder/compile.ts:20
- kind: interface
- core: platform
- spec: (none)
- summary: A captured DOM target — the recorder emits the richest set of identifiers it sees.
- score: 2
interface CcbhcMeasureAggregate
- file: src/platform/clinical/measures/useClinicalMeasureAggregates.ts:27
- kind: interface
- core: platform
- spec: (none)
- summary: One de-identified CCBHC clinic-collected measure result, e.g. , .Counts only — no patient ids or row-level data ever cross the platform boundary.
- score: 2
interface CcbhcMeasureAggregatesInput
- file: src/platform/clinical/measures/useClinicalMeasureAggregates.ts:42
- kind: interface
- core: platform
- spec: (none)
- summary: Input parameters for CCBHC measure aggregate queries.
- score: 2
type CeemBasisType
- file: src/platform/clinical/ceem/disclosure-gate.contract.ts:30
- kind: type
- core: platform
- spec: (none)
- summary: Basis on which a disclosure was permitted (FR-2).
- score: 2
type CeemDenyReason
- file: src/platform/clinical/ceem/disclosure-gate.contract.ts:23
- kind: type
- core: platform
- spec: (none)
- summary: Machine-readable deny reasons (FR-3).
- score: 2
type CeemRecipientKind
- file: src/platform/clinical/ceem/disclosure-gate.contract.ts:20
- kind: type
- core: platform
- spec: (none)
- summary: Permitted recipient classes for a CEEM exemption disclosure (no free-text recipient PHI).
- score: 2
type CEPermission
- file: src/platform/permissions/constants.ts:2439
- kind: type
- core: platform
- spec: (none)
- summary: Union of every Community Engagement (CE) permission key.
- score: 2
interface ChatNotificationInput
- file: src/platform/integrations/google-workspace.ts:216
- kind: interface
- core: platform
- spec: (none)
- summary: Input for : the target org, the approvedPF-10 to render, the identifying the mappedChat space, and optional short (≤256-char) string variable substitutions.There is intentionally no free-text body field — PHI is always blocked in Chat.
- score: 2
interface ChatNotificationResult
- file: src/platform/integrations/google-workspace.ts:227
- kind: interface
- core: platform
- spec: (none)
- summary: Result of : the created Chat messageresource name and the redacted correlation id for the sync run.
- score: 2
interface ClientFilter
- file: src/platform/table-v2/utils/filter/client.ts:14
- kind: interface
- core: platform
- spec: (none)
- summary: A client-side filter predicate.
- score: 2
type CLPermission
- file: src/platform/permissions/constants.ts:2443
- kind: type
- core: platform
- spec: (none)
- summary: Union of every Clinical (CL) permission key.
- score: 2
interface CoCMRegistryResult
- file: src/platform/clinical/cocm-registry.ts:21
- kind: interface
- core: platform
- spec: (none)
- summary: Result shape returned by .When , all other fields are meaningless and the gate enginemust withhold auto-post for CoCM enrollments (graceful degrade per A-1).
- score: 2
interface CompiledQuery
- file: src/platform/analytics/semantic-compiler.ts:82
- kind: interface
- core: platform
- spec: (none)
- summary: The validated, normalized plan. Runtime-agnostic.
- score: 2
interface CompletenessAlertPayload
- file: src/platform/clinical/completeness/completenessAlert.ts:29
- kind: interface
- core: platform
- spec: (none)
- summary: A PHI-free completeness/timeliness alert payload (allow-listed keys only).
- score: 2
interface CompletenessDeps
- file: src/platform/clinical/completeness/getSurfaceDocumentationCompleteness.ts:35
- kind: interface
- core: platform
- spec: (none)
- summary: Injected dependencies (client/registry/clock) so the read path is testable.
- score: 2
type ConditionalClauseFormData
- file: src/platform/field-config/schemas/conditional-rules.schema.ts:48
- kind: type
- core: platform
- spec: (none)
- summary: Inferred type for conditional clause
- score: 2
type ConditionalOperatorFormData
- file: src/platform/field-config/schemas/conditional-rules.schema.ts:43
- kind: type
- core: platform
- spec: (none)
- summary: Inferred type for conditional operator
- score: 2
type ConditionalRulesFormData
- file: src/platform/field-config/schemas/conditional-rules.schema.ts:53
- kind: type
- core: platform
- spec: (none)
- summary: Inferred type for conditional rules configuration
- score: 2
interface ConditionalValidationRule
- file: src/platform/wizards/utils/validation-executor.ts:38
- kind: interface
- core: platform
- spec: (none)
- summary: Conditional validation rule - only applied when conditions are met
- score: 2
type ConfidenceBadgeVariant
- file: src/platform/ai/utils/confidence.ts:13
- kind: type
- core: platform
- spec: (none)
- summary: Badge variant names shared by suggestion surfaces (subset of the Badge variants).
- score: 2
type ConfidenceLevel
- file: src/platform/ai/utils/confidence.ts:10
- kind: type
- core: platform
- spec: (none)
- summary: Shared confidence → presentation helpers for AI suggestions.Centralizes the 0.8 / 0.5 tier thresholds so every AI suggestion surface(cards, table cells) renders confidence consistently. platform/ai/utils/confidence
- score: 2
interface ConvertLeadFromPMInput
- file: src/platform/ce/useConvertLeadFromPM.ts:19
- kind: interface
- core: platform
- spec: (none)
- summary: Input for converting a lead from the PM patient registration flow.
- score: 2
interface CorePrimaryAction
- file: src/platform/modules/module-registry.ts:6
- kind: interface
- core: platform
- spec: (none)
- summary: Primary contextual action per core — derived from the first registry quick action.
- score: 2
interface CoreRailProps
- file: src/platform/navigation/primitives/CoreRail.tsx:79
- kind: interface
- core: platform
- spec: (none)
- summary: Props for the primitive — the left-edge vertical navigationrail that lists the cores a user can access, surfaces pin/reorder controls,and hosts the theme toggle and user menu.
- score: 2
interface CosignOverdueInput
- file: src/platform/clinical/plan/plan-cadence.ts:41
- kind: interface
- core: platform
- spec: (none)
- summary: Inputs to the BHT cosign-overdue determination.
- score: 2
interface CoverageReport
- file: src/platform/import/mapping/auditValueCoverage.ts:19
- kind: interface
- core: platform
- spec: (none)
- summary: The data-quality summary for one source column against one binding.
- score: 2
interface CreateAgentInput
- file: src/platform/cowork/agentsService.ts:27
- kind: interface
- core: platform
- spec: (none)
- summary: Fields an admin may set when creating an agent. organization_id is supplied separately.
- score: 2
interface CreatedProvider
- file: src/platform/auth/sso/useSsoSetup.ts:26
- kind: interface
- core: platform
- spec: (none)
- summary: Result of creating an SSO provider + domain claim: the new provider/claimids plus the verification token and the DNS TXT host the admin must publishto prove domain ownership.
- score: 2
interface CreateOrgProfileDraftFromDocumentInput
- file: src/platform/knowledge/hooks/use-seed-org-knowledge.ts:33
- kind: interface
- core: platform
- spec: (none)
- summary: Inputs for the import branch — content comes from a selection.
- score: 2
interface CreateWorkspaceInput
- file: src/platform/navigation/workspaces/admin/useWorkspaceMutations.ts:116
- kind: interface
- core: platform
- spec: (none)
- summary: Caller-supplied fields for creating a workspace. Excludes (taken from the active org context) and audit columns (/, stamped from the current user); defaults to .
- score: 2
interface CrisisLines
- file: src/platform/clinical/blocks/suicide/crisis-lines.ts:16
- kind: interface
- core: platform
- spec: (none)
- summary: Resolved crisis-line numbers for a safety plan.
- score: 2
interface CrossFieldRule
- file: src/platform/wizards/utils/validation-executor.ts:21
- kind: interface
- core: platform
- spec: (none)
- summary: Cross-field validation rule
- score: 1
type DateFormatPreset
- file: src/platform/formatting/utils.ts:86
- kind: type
- core: platform
- spec: (none)
- summary: Semantic date format presets for consistent display
- score: 2
interface DebouncedFunction
- file: src/platform/wizards/utils/async-validation.ts:97
- kind: interface
- core: platform
- spec: (none)
- summary: Debounced function interface with cancel method
- score: 2
interface DegradationDecision
- file: src/platform/ai/lib/aiDegradation.ts:40
- kind: interface
- core: platform
- spec: (none)
- summary: The outcome of . is only populated when .
- score: 2
type DegradationMode
- file: src/platform/ai/lib/aiDegradation.ts:33
- kind: type
- core: platform
- spec: (none)
- summary: The three degradation modes + a hard-block for PHI / payment guard.- — a real retry queue will replay the request once capacity is restored (use only where the queue exists).- — AI is down; surface the manual workflow so work can continue. Phase-0 default for all clinical/billing callsites.- — serve a cached or rule-based result as a best-effort substitute (use where a plausible cached answer is better than blocking the user).- — do not attempt AI and do not surface a fallback hint (PHI detection, payment gate, or error = null meaning AI was never invoked).
- score: 2
type DeliveryStatus
- file: src/platform/notifications/utils/retry.ts:101
- kind: type
- core: platform
- spec: (none)
- summary: Notification delivery status types.
- score: 2
interface DeviceInfo
- file: src/platform/sessions/utils/deviceFingerprint.ts:6
- kind: interface
- core: platform
- spec: (none)
- summary: PF-49: Device Fingerprinting UtilityGenerates a SHA-256 hash from browser metadata for device identification.
- score: 2
interface DiffLine
- file: src/platform/documents/utils/documentDiff.ts:13
- kind: interface
- core: platform
- spec: (none)
- summary: A single line in a side-by-side diff view
- score: 2
interface DischargeChecklistState
- file: src/platform/clinical/blocks/discharge/discharge-summary-adapter.ts:42
- kind: interface
- core: platform
- spec: (none)
- summary: Read-only composed state of the chart’s discharge checklist (CL-29).
- score: 2
interface DischargeMedication
- file: src/platform/clinical/blocks/discharge/discharge-summary-adapter.ts:35
- kind: interface
- core: platform
- spec: (none)
- summary: One medication ordered at discharge (R9-10-709(G)(1)(d) snapshot entry).
- score: 2
interface DischargeRequiredness
- file: src/platform/clinical/blocks/discharge/requiredness.ts:25
- kind: interface
- core: platform
- spec: (none)
- summary: Which discharge-summary fields are required for the current context.
- score: 2
interface DischargeRequirednessInput
- file: src/platform/clinical/blocks/discharge/requiredness.ts:17
- kind: interface
- core: platform
- spec: (none)
- summary: Inputs that drive the discharge summary’s conditional field requiredness.
- score: 2
interface DischargeSummary
- file: src/platform/clinical/blocks/discharge/discharge-summary-adapter.ts:48
- kind: interface
- core: platform
- spec: (none)
- summary: The discharge_summary block’s form-value shape (field_schema keys).
- score: 2
interface DocumentAnalyticsData
- file: src/platform/documents/hooks/useDocumentAnalytics.ts:18
- kind: interface
- core: platform
- spec: (none)
- summary: Aggregated document analytics data
- score: 2
interface DocumentAnalyticsResult
- file: src/platform/documents/hooks/useDocumentAnalytics.ts:36
- kind: interface
- core: platform
- spec: (none)
- summary: Return type for the analytics hook
- score: 2
type DomainClaimStatus
- file: src/platform/auth/sso/useSsoSetup.ts:19
- kind: type
- core: platform
- spec: (none)
- summary: Lifecycle of an SSO domain-ownership claim: (DNS TXT not yetconfirmed), (ownership proven, provider may be activated), or (verification could not be completed).
- score: 2
interface DriveSyncInput
- file: src/platform/integrations/google-workspace.ts:163
- kind: interface
- core: platform
- spec: (none)
- summary: Input for : the target org, and an optional to scope the sync to a single shared drive’s folders (omit to listall shared drives and their folders).
- score: 2
interface DriveSyncResult
- file: src/platform/integrations/google-workspace.ts:173
- kind: interface
- core: platform
- spec: (none)
- summary: Result of : counts of shared drives andfolders whose metadata was upserted into ,plus the redacted correlation id for the sync run.
- score: 2
interface EdgeApiDeprecationMetricRow
- file: src/platform/health/edge-api-deprecation-metrics.ts:15
- kind: interface
- core: platform
- spec: (none)
- summary: A single row in the Edge API deprecation usage metrics view.Used by PF-36 health dashboard widgets.
- score: 2
type EdgeInvokeFn
- file: src/platform/ai/agentic/intake-model-adapter.ts:27
- kind: type
- core: platform
- spec: (none)
- summary: The injected (narrowed to what we use).
- score: 2
interface EmailSignatureSettings
- file: src/platform/email-signatures/hooks/useEmailSignatureSettings.ts:10
- kind: interface
- core: platform
- spec: (none)
- summary: Email signature-related settings from pf_module_settings
- score: 2
interface EmbeddableMetrics
- file: src/platform/telephony/components/EmbeddableProvider.tsx:72
- kind: interface
- core: platform
- spec: (none)
- summary: Performance metrics for monitoring (T19)
- score: 2
interface EmployeeCreatedPayload
- file: src/platform/hr/useEmployeeEvents.ts:10
- kind: interface
- core: platform
- spec: (none)
- summary: Payload for employee_created: new employee row (minimal).
- score: 2
interface EmployeeTerminatedPayload
- file: src/platform/hr/useEmployeeEvents.ts:18
- kind: interface
- core: platform
- spec: (none)
- summary: Payload for employee_terminated: employee row at termination.
- score: 2
type EncoreTargetTable
- file: src/platform/settings/pages/data-migration/constants.ts:30
- kind: type
- core: platform
- spec: (none)
- summary: Type for valid Encore target table names.
- score: 2
interface EnforceResult
- file: src/platform/ai/phi-two-path-enforcer.ts:54
- kind: interface
- core: platform
- spec: (none)
- summary: The enforcer’s verdict — the text that may be dispatched, and whether it was redacted.
- score: 2
interface EnqueueWorkflowExecutionInput
- file: src/platform/workflow/execution.ts:23
- kind: interface
- core: platform
- spec: (none)
- summary: Input for .
- score: 1
interface EnqueueWorkflowExecutionResult
- file: src/platform/workflow/execution.ts:48
- kind: interface
- core: platform
- spec: (none)
- summary: Result of .
- score: 1
type EntraAppMode
- file: src/platform/integrations/hooks/useEntraSetup.ts:23
- kind: type
- core: platform
- spec: (none)
- summary: Shared Encore app vs bring-your-own Entra app registration.
- score: 2
type EntraConsentStatus
- file: src/platform/integrations/hooks/useEntraSetup.ts:20
- kind: type
- core: platform
- spec: (none)
- summary: Admin-consent state for the org’s Entra connection (from ).
- score: 2
type EntraHealthStatus
- file: src/platform/integrations/entra-health.ts:8
- kind: type
- core: platform
- spec: (none)
- summary: Headline integration status for badges and hub cards.
- score: 2
interface EntraOrgSettings
- file: src/platform/integrations/hooks/useEntraConfig.ts:13
- kind: interface
- core: platform
- spec: (none)
- summary: Org-level settings JSON: Entra and Gmail email sender configuration
- score: 2
interface EntraSetupWizardProps
- file: src/platform/integrations/components/EntraSetupWizard.tsx:60
- kind: interface
- core: platform
- spec: (none)
- summary: Props for .
- score: 1
interface EntraSubscribedSku
- file: src/platform/integrations/entra-skus.ts:12
- kind: interface
- core: platform
- spec: (none)
- summary: PF-63-EN-01 FR-3 — Entra license SKU catalog helpers.The edge function’s action returns thetenant’s subscribed SKUs from Microsoft Graph (). Thesepure helpers normalize that payload for the role-license editor and validateSKU input against the catalog, degrading to a GUID-format check when thecatalog is unavailable (no credentials / consent yet) so configuration isnever dead-ended.
- score: 2
interface EventCatalogEntry
- file: src/platform/events/events-catalog.ts:10
- kind: interface
- core: platform
- spec: (none)
- summary: Domain-event catalog — the SINGLE SOURCE OF TRUTH for known events.Edit here, then run to regenerate the TS union(known-events.generated.ts) and the DB seed (10_fw_workflow_events.sql).Metadata was name-derived at bootstrap; enrich per-spec as needed.owning_core ∈ pf|hr|rh|fa|fw|fm|lo|gr|cl|pm|ce|it; category matches thefw_workflow_events_category_check (lifecycle|financial|operational|form|messaging|interoperability|clinical|platform).
- score: 2
type EventPayloadSchemaJson
- file: src/platform/events/eventPayloadValidation.ts:27
- kind: type
- core: platform
- spec: (none)
- summary: JSON Schema object shape (subset used in event definitions).
- score: 2
interface ExamFinding
- file: src/platform/clinical/blocks/exam-adapter.ts:18
- kind: interface
- core: platform
- spec: (none)
- summary: One row: a body system’s exam status (+ abnormal narrative).
- score: 2
interface ExamOverlayContext
- file: src/platform/clinical/blocks/ros-exam/full-hp-gate.ts:37
- kind: interface
- core: platform
- spec: (none)
- summary: The overlay context that drives the exam gate.
- score: 2
interface ExcelSheet
- file: src/platform/export/utils/excelExport.ts:8
- kind: interface
- core: platform
- spec: (none)
- summary: PF-44: Excel Export UtilityGenerates .xlsx files using wekanteam/exceljs with multi-sheet support.ExcelJS is loaded dynamically to avoid pulling vendor-excel into every consumer.
- score: 2
interface ExemptionAttestation
- file: src/platform/clinical/ceem/disclosure-gate.contract.ts:61
- kind: interface
- core: platform
- spec: (none)
- summary: Minimum-necessary attestation (FR-4). Only a yes/no exemption status plusdates, jurisdiction id, and a verification token leave the gate. Theexemption category is omitted by default (FR-4a, CLAR-1 legal-approved2026-06-03) and present only when the resolved PF-96 profile explicitlypermits it. NEVER carries SUD diagnosis, episode, ASAM/LOCUS, or narrative.
- score: 2
interface ExemptionDisclosureGateRequest
- file: src/platform/clinical/ceem/disclosure-gate.contract.ts:36
- kind: interface
- core: platform
- spec: (none)
- summary: Server-side gate request. points at the CL-70 determination,NOT its content — the gate never receives SUD record bodies.
- score: 2
interface ExemptionDisclosureGateResponse
- file: src/platform/clinical/ceem/disclosure-gate.contract.ts:73
- kind: interface
- core: platform
- spec: (none)
- summary: Gate response. is present only on permit.
- score: 2
interface ExportedJsonSchema
- file: src/platform/forms/utils/schemaExport.ts:40
- kind: interface
- core: platform
- spec: (none)
- summary: Exported JSON Schema result
- score: 1
interface ExternalModelStep
- file: src/platform/ai/phi-two-path-enforcer.ts:41
- kind: interface
- core: platform
- spec: (none)
- summary: A single external-model-reaching step to evaluate.
- score: 2
type ExternalStepType
- file: src/platform/ai/phi-two-path-enforcer.ts:26
- kind: type
- core: platform
- spec: (none)
- summary: Every external-model-reaching step type subject to the two-path rule (FR-9/FR-10).
- score: 2
type FairnessMonitoringStatus
- file: src/platform/ai/constants/ai-fairness-surfaces.ts:26
- kind: type
- core: platform
- spec: (none)
- summary: Whether bias/fairness monitoring is LIVE for a surface.
- score: 2
type FAPermission
- file: src/platform/permissions/constants.ts:2427
- kind: type
- core: platform
- spec: (none)
- summary: Union of every Finance (FA) permission key.
- score: 2
interface FileUploadFieldSettings
- file: src/platform/forms/components/fields/FileUploadField.tsx:28
- kind: interface
- core: platform
- spec: (none)
- summary: Settings that can be configured per-field by form builders.
- score: 2
interface FileUploadFieldValue
- file: src/platform/forms/components/fields/FileUploadField.tsx:19
- kind: interface
- core: platform
- spec: (none)
- summary: Shape of a file upload field value stored in submission_data.
- score: 2
interface FileValidationResult
- file: src/platform/documents/utils/fileValidation.ts:84
- kind: interface
- core: platform
- spec: (none)
- summary: Result of file validation
- score: 1
interface FilterColumnMeta
- file: src/platform/data-lookup/lookupTables.ts:11
- kind: interface
- core: platform
- spec: (none)
- summary: Metadata about a filterable column for the builder UI.
- score: 2
type FilterErrorCode
- file: src/platform/table-v2/utils/filter/errors.ts:10
- kind: type
- core: platform
- spec: (none)
- summary: Error codes for filter operations.
- score: 2
interface FilterPreset
- file: src/platform/data-lookup/lookupTables.ts:96
- kind: interface
- core: platform
- spec: (none)
- summary: Quick-apply presets for common filter combinations.
- score: 2
interface FleetUsageRollupRow
- file: src/platform/fleet/hooks/useFleetUsageRollup.ts:14
- kind: interface
- core: platform
- spec: (none)
- summary: A single row returned by pf_agent_usage_rollup
- score: 2
type FMPermission
- file: src/platform/permissions/constants.ts:2435
- kind: type
- core: platform
- spec: (none)
- summary: Union of every Facilities (FM) permission key.
- score: 2
interface FormCompletionStatus
- file: src/platform/onboarding/integrations/payrollIntegration.ts:20
- kind: interface
- core: platform
- spec: (none)
- summary: Individual form status
- score: 1
interface FreeBusyInput
- file: src/platform/integrations/google-workspace.ts:92
- kind: interface
- core: platform
- spec: (none)
- summary: Input for : the target org and Workspace subject,the RFC3339 window, the calendar ids to probe, and anoptional time zone for the response windows.
- score: 2
type FWPermission
- file: src/platform/permissions/constants.ts:2431
- kind: type
- core: platform
- spec: (none)
- summary: Union of every Forms & Workflow (FW) permission key.
- score: 2
interface GesturePoint
- file: src/platform/gestures/registry/CustomGestureRegistry.ts:6
- kind: interface
- core: platform
- spec: (none)
- summary: PF-37 Phase 3: Custom Gesture Registry In-memory registry for custom gesture patterns using $1 recognizer approach.
- score: 2
interface GetThrottleStatusArgs
- file: src/platform/workflow/execution.ts:111
- kind: interface
- core: platform
- spec: (none)
- summary: Arguments for .
- score: 1
interface GraphPermissionItem
- file: src/platform/integrations/entra-permissions.ts:6
- kind: interface
- core: platform
- spec: (none)
- summary: Shared Microsoft Graph permission metadata for Entra ID integration.Keeps UI (EntraIDSettingsCard) and client/edge logic in sync.
- score: 2
interface GroupedRowsToolbarProps
- file: src/platform/table-v2/components/GroupedRows.tsx:114
- kind: interface
- core: platform
- spec: (none)
- summary: Toolbar controls for expand/collapse all groups.Per CONTEXT: small text links (text-xs text-muted-foreground).
- score: 2
type GRPermission
- file: src/platform/permissions/constants.ts:2437
- kind: type
- core: platform
- spec: (none)
- summary: Union of every Governance (GR) permission key.
- score: 2
type HapticType
- file: src/platform/gestures/utils/haptics.ts:15
- kind: type
- core: platform
- spec: (none)
- summary: PF-37 Phase 8.4: Haptic Feedback UtilitiesCentralized haptic feedback for gesture interactions.Respects reduced motion preferences and device capabilities.SSR-safe: guards against server-side rendering environments.⚠️ PLATFORM LIMITATION: is NOT supported on iOS Safari. All haptic calls silently return on iPhones / iPads. Do NOT rely on haptic feedback as the sole indicator of an action — always pair with a visual cue (animation, color change, etc.). See: https://caniuse.com/vibration
- score: 2
type HRPermission
- file: src/platform/permissions/constants.ts:2425
- kind: type
- core: platform
- spec: (none)
- summary: Union of every HR (HR) permission key.
- score: 2
interface IApiCallTracker
- file: src/platform/quota/api-call-tracker.ts:9
- kind: interface
- core: platform
- spec: (none)
- summary: Interface for tracking API call usage.
- score: 2
type ImportAuditAction
- file: src/platform/import/hooks/useImportAudit.ts:14
- kind: type
- core: platform
- spec: (none)
- summary: Import audit event types.
- score: 1
interface ImportConflict
- file: src/platform/ai/hooks/useImportAISkill.ts:25
- kind: interface
- core: platform
- spec: (none)
- summary: Conflict details when a skill_code already exists.
- score: 2
type ImportConflictResolution
- file: src/platform/ai/hooks/useImportAISkill.ts:19
- kind: type
- core: platform
- spec: (none)
- summary: Conflict resolution strategy.
- score: 1
interface ImportProgress
- file: src/platform/import/hooks/useImportProgress.ts:13
- kind: interface
- core: platform
- spec: (none)
- summary: Progress data returned by the hook.
- score: 2
interface ImportResult
- file: src/platform/ai/hooks/useImportAISkill.ts:37
- kind: interface
- core: platform
- spec: (none)
- summary: Full import result after processing.
- score: 2
type ImportState
- file: src/platform/ai/hooks/useImportAISkill.ts:22
- kind: type
- core: platform
- spec: (none)
- summary: Import state for UI rendering.
- score: 2
type IndustryFilter
- file: src/platform/templates/utils/templateIndustry.ts:6
- kind: type
- core: platform
- spec: (none)
- summary: PF-64: Template Industry Detection UtilityShared logic for detecting industry category from template metadata
- score: 2
type InjectionDirectiveClass
- file: src/platform/ai/prompt-safety.ts:118
- kind: type
- core: platform
- spec: (none)
- summary: A guardrail-override directive class detected by .
- score: 2
interface InjectionScreenResult
- file: src/platform/ai/prompt-safety.ts:127
- kind: interface
- core: platform
- spec: (none)
- summary: Result of the author-time prompt-injection / jailbreak screen.
- score: 2
interface IntakeAuditSurface
- file: src/platform/ai/agentic/intake-audit-surface.ts:63
- kind: interface
- core: platform
- spec: (none)
- summary: The full content-free audit surface for a single intake thread.
- score: 2
interface IntakeGovernanceApproval
- file: src/platform/ai/agentic/intake-audit-surface.ts:32
- kind: interface
- core: platform
- spec: (none)
- summary: One PF-126 governance-approval audit row (payload_digest intentionally NOT surfaced).
- score: 2
interface IntakePhiAccess
- file: src/platform/ai/agentic/intake-audit-surface.ts:48
- kind: interface
- core: platform
- spec: (none)
- summary: One PF-111-EN-01 PHI-access audit row (resource_ref + phi_category are content-free labels).
- score: 2
interface IntakeReadSources
- file: src/platform/ai/agentic/intake-read-tools.ts:21
- kind: interface
- core: platform
- spec: (none)
- summary: The CE/PM read functions the dispatcher calls (production: authenticated reads).
- score: 2
interface IntakeSourcesClient
- file: src/platform/ai/agentic/intake-sources.ts:21
- kind: interface
- core: platform
- spec: (none)
- summary: Structural Supabase surface these reads need (production: the RLS-bounded staff client).
- score: 2
interface IntakeToolInvocation
- file: src/platform/ai/agentic/intake-audit-surface.ts:18
- kind: interface
- core: platform
- spec: (none)
- summary: One PF-127 tool-invocation audit row (content-free).
- score: 2
interface IntakeVerticalDeps
- file: src/platform/ai/agentic/intake-vertical.ts:33
- kind: interface
- core: platform
- spec: (none)
- summary: Dependencies for .
- score: 1
interface IntakeVerticalResult
- file: src/platform/ai/agentic/intake-vertical.ts:50
- kind: interface
- core: platform
- spec: (none)
- summary: Terminal result of the 2b read vertical.
- score: 2
type InvokeExemptionDisclosureGate
- file: src/platform/clinical/ceem/disclosure-gate.contract.ts:84
- kind: type
- core: platform
- spec: (none)
- summary: Server-side invocation signature (service-role / server context only).
- score: 2
type ITPermission
- file: src/platform/permissions/constants.ts:2441
- kind: type
- core: platform
- spec: (none)
- summary: Union of every IT (IT) permission key.
- score: 2
interface JurisdictionProfileOption
- file: src/platform/jurisdiction/hooks/useJurisdictionProfiles.ts:14
- kind: interface
- core: platform
- spec: (none)
- summary: Minimal profile shape for the selector.
- score: 2
type KnownEventName
- file: src/platform/events/known-events.generated.ts:212
- kind: type
- core: platform
- spec: (none)
- summary: Registered (developer-defined) domain-event names. Custom/user events use CustomEventName.
- score: 2
type KpiDirection
- file: src/platform/analytics/serving/kpi-suppression.ts:13
- kind: type
- core: platform
- spec: (none)
- summary: PF-123 Phase 3 — KPI display assembler (AC-018 value/delta/sparkline + direction; AC-019below-threshold value with delta + sparkline blanked). PURE + deterministic (no I/O).IMPORTANT: this is DISPLAY-assembly logic, not a privacy boundary. Server-side suppressionis already enforced upstream by suppressServingPayload/applyCompositeMeasures inside thepf-analytics-query edge fn, which masks every sub-threshold cell to null BEFORE returning.Both inputs here are therefore already suppressed; this helper only ASSEMBLES the display andapplies the KPI cross-component rule: when the headline current value is suppressed, blank thedelta AND the whole sparkline (a visible earlier trend + a known prior could re-identify thehidden latest value by differencing). No raw small-cell value is ever in scope here.
- score: 2
type KpiTone
- file: src/platform/analytics/serving/kpi-suppression.ts:117
- kind: type
- core: platform
- spec: (none)
- summary: Per-metric direction → semantic tone for the delta. Healthcare metrics invert: an increase on a metric (denials, no-shows, turnover) reads as ADVERSE. Returns semantic-tokenclass names only — never raw hex (AC-018).
- score: 2
interface LeadConversionHistoryItem
- file: src/platform/ce/useLeadConversionHistory.ts:17
- kind: interface
- core: platform
- spec: (none)
- summary: Conversion record with optional contact/lead details.
- score: 2
interface LicenseInput
- file: src/platform/integrations/google-workspace.ts:132
- kind: interface
- core: platform
- spec: (none)
- summary: Input for / : thetarget org, the linked user’s , and the Google product/SKU idpair identifying the license to assign or revoke.
- score: 2
interface LoginSsoState
- file: src/platform/auth/sso/useSsoSetup.ts:122
- kind: interface
- core: platform
- spec: (none)
- summary: PF-112-EN-01: the org’s shared-app OIDC login state — whether the tenant isconnected (PF-63 consent recorded a tenant id), which domains Microsoft hasverified, and whether the Login SSO capability is on.
- score: 2
type LOPermission
- file: src/platform/permissions/constants.ts:2433
- kind: type
- core: platform
- spec: (none)
- summary: Union of every Leadership OS (LO) permission key.
- score: 2
interface MappingCandidateTarget
- file: src/platform/ai/hooks/useAIMappingSuggestions.ts:34
- kind: interface
- core: platform
- spec: (none)
- summary: An Encore-side value the model may pick. Constrains output to real targets.
- score: 2
interface MappingExample
- file: src/platform/ai/hooks/useAIMappingSuggestions.ts:42
- kind: interface
- core: platform
- spec: (none)
- summary: An already-accepted mapping supplied as a few-shot example.
- score: 2
interface MappingSourceItem
- file: src/platform/ai/hooks/useAIMappingSuggestions.ts:23
- kind: interface
- core: platform
- spec: (none)
- summary: A single item to map (e.g. a Proliant earning code + its description).
- score: 2
interface MappingSuggestInput
- file: src/platform/ai/hooks/useAIMappingSuggestions.ts:49
- kind: interface
- core: platform
- spec: (none)
- summary: Input for .
- score: 1
interface MappingSuggestion
- file: src/platform/ai/hooks/useAIMappingSuggestions.ts:61
- kind: interface
- core: platform
- spec: (none)
- summary: One suggestion row. is when no candidate fit.
- score: 2
interface MappingSuggestResult
- file: src/platform/ai/hooks/useAIMappingSuggestions.ts:69
- kind: interface
- core: platform
- spec: (none)
- summary: Result returned by the edge function.
- score: 2
interface MarketplaceBundleRow
- file: src/platform/ai/hooks/useBundleMarketplace.ts:15
- kind: interface
- core: platform
- spec: (none)
- summary: Row returned by pf_marketplace_list
- score: 2
interface MarketplaceTag
- file: src/platform/wizards/config/marketplaceTags.ts:7
- kind: interface
- core: platform
- spec: (none)
- summary: PF-41 Phase 3.5: Common Marketplace TagsPredefined tags for marketplace listings to ensure consistency.
- score: 2
interface McpConnection
- file: src/platform/ai/mcp-client.ts:33
- kind: interface
- core: platform
- spec: (none)
- summary: Lightweight connection wrapper for a configured MCP server.
- score: 2
interface McpRejectionContext
- file: src/platform/ai/mcp-rejection-audit.ts:24
- kind: interface
- core: platform
- spec: PF-127
- summary: Non-PHI identity context for a rejection audit row.
- see:
- auditMcpRejections
- score: 5
interface McpServerConfig
- file: src/platform/ai/mcp-client.ts:14
- kind: interface
- core: platform
- spec: (none)
- summary: Configuration for an MCP server endpoint.
- score: 2
interface McpToolInvocationResult
- file: src/platform/ai/mcp-client.ts:26
- kind: interface
- core: platform
- spec: (none)
- summary: Result from invoking a remote MCP tool.
- score: 2
interface MeasurableObjectiveInput
- file: src/platform/clinical/plan/measurable.ts:16
- kind: interface
- core: platform
- spec: (none)
- summary: The bound goal fields the measurability derivation reads.
- score: 2
interface MedListEntry
- file: src/platform/clinical/blocks/meds/med-list-adapter.ts:28
- kind: interface
- core: platform
- spec: (none)
- summary: One row as the med_list block sees it (field_schema keys = columns).
- score: 2
interface MedReconciliation
- file: src/platform/clinical/blocks/meds/med-reconciliation-adapter.ts:28
- kind: interface
- core: platform
- spec: (none)
- summary: The med_reconciliation block’s form-value shape (field_schema keys).
- score: 2
type MemoryScreenFn
- file: src/platform/ai/agentic/agent-memory-types.ts:63
- kind: type
- core: platform
- spec: (none)
- summary: The injectable PF-27-EN-01 two-path screen. Returns the redacted, prompt-safe text on success andTHROWS to fail closed (the caller must then NOT persist / must exclude the row). Defaults to thereal enforcer; tests inject a deterministic stub.
- score: 2
interface MetabolicPanelEntry
- file: src/platform/clinical/blocks/metabolic-adapter.ts:28
- kind: interface
- core: platform
- spec: (none)
- summary: One metabolic panel entry (field_schema keys = cl_metabolic_monitoring_events columns).
- score: 2
interface MetadataChange
- file: src/platform/documents/utils/documentDiff.ts:34
- kind: interface
- core: platform
- spec: (none)
- summary: A single metadata field change
- score: 2
interface MetadataDiffResult
- file: src/platform/documents/utils/documentDiff.ts:44
- kind: interface
- core: platform
- spec: (none)
- summary: Result of comparing two version metadata objects
- score: 2
interface MilestoneTask
- file: src/platform/onboarding/integrations/milestonePresets.ts:15
- kind: interface
- core: platform
- spec: (none)
- summary: Milestone check-in task definition
- score: 2
type ModelLane
- file: src/platform/ai/phi-two-path-enforcer.ts:23
- kind: type
- core: platform
- spec: (none)
- summary: The resolved model lane for a step. = a BAA/ZDR-covered model (cl/pm); = any other.
- score: 2
interface MseExam
- file: src/platform/clinical/blocks/mse-adapter.ts:25
- kind: interface
- core: platform
- spec: (none)
- summary: The structured MSE instance (snake_case = block field_schema keys = DB columns).
- score: 2
interface NameMrnScanResult
- file: src/platform/ai/prompt-safety.ts:187
- kind: interface
- core: platform
- spec: (none)
- summary: Likely raw names / MRN-shaped tokens surfaced by .
- score: 2
type NavEventType
- file: src/platform/navigation/analytics/useNavAnalytics.ts:11
- kind: type
- core: platform
- spec: (none)
- summary: Structural navigation event classes. No free text, no PHI — only the shapeof how the user moves through the app. See migration 20260526210000_nav_events.
- score: 2
interface NeedsAttentionItem
- file: src/platform/navigation/workspaces/useWorkspaceNeedsAttention.ts:5
- kind: interface
- core: platform
- spec: (none)
- summary: A single “needs attention” counter surfaced on a workspace hub.
- score: 2
type NotificationChannel
- file: src/platform/notifications/utils/retry.ts:106
- kind: type
- core: platform
- spec: (none)
- summary: Notification channel types.
- score: 1
interface NotificationDeliveryResponse
- file: src/platform/notifications/hooks/usePushSubscription.ts:13
- kind: interface
- core: platform
- spec: (none)
- summary: Response shape from the send-push-notification edge function
- score: 2
interface OnboardingPreset
- file: src/platform/onboarding/integrations/milestonePresets.ts:32
- kind: interface
- core: platform
- spec: (none)
- summary: Template preset definition
- score: 1
interface OrgAiProfile
- file: src/platform/ai/hooks/useOrgAiProfile.ts:19
- kind: interface
- core: platform
- spec: (none)
- summary: Shape of the AI-onboarding columns on pf_module_settings (additive — PF-UX-22).
- score: 2
interface OrgAiSettingsUpsert
- file: src/platform/ai/hooks/useOrgAiProfileMutation.ts:30
- kind: interface
- core: platform
- spec: (none)
- summary: Partial set of AI columns to upsert. Only provided keys are written (COALESCE-merge).
- score: 2
interface OrgJurisdictionConfig
- file: src/platform/jurisdiction/hooks/useOrgJurisdictionConfig.ts:16
- kind: interface
- core: platform
- spec: (none)
- summary: Org jurisdiction config row with joined profile.
- score: 2
interface OrgProfileArticle
- file: src/platform/knowledge/hooks/use-org-profile-article.ts:30
- kind: interface
- core: platform
- spec: (none)
- summary: The single published-and-indexed org_profile narrative, as returned by. Mirrors the RPC’s columns.
- score: 2
interface OutcomeAssessmentRecordedPayload
- file: src/platform/clinical/outcomes/outcome-assessment.contract.ts:4
- kind: interface
- core: platform
- spec: (none)
- summary: Payload for the domain event (CL-69 → GR-28/GR-30).
- score: 2
interface OutcomeReassessmentGapInput
- file: src/platform/clinical/outcomes/reassessment-cohort.ts:37
- kind: interface
- core: platform
- spec: (none)
- summary: Input for recording an outcome reassessment care gap (CL-69 AC-2.2).
- score: 2
interface OutcomeReassessmentGapResult
- file: src/platform/clinical/outcomes/reassessment-cohort.ts:58
- kind: interface
- core: platform
- spec: (none)
- summary: Result of attempting to record an outcome reassessment gap.
- score: 2
interface OverflowSegment
- file: src/platform/navigation/components/BreadcrumbOverflowMenu.tsx:14
- kind: interface
- core: platform
- spec: (none)
- summary: PF: Shared overflow popover for collapsed breadcrumb parents.Used by both (desktop) and so thecollapsed-segment UI is identical on every viewport.
- score: 2
interface ParseCsvResult
- file: src/platform/csv/parse.ts:7
- kind: interface
- core: platform
- spec: (none)
- summary: Platform CSV parsing utilities for bulk import.Single implementation used by all CSV-based imports (HR, CE, FA, Platform).Constitution §5.10; see docs/guides/use-cases/bulk-import-migration.md.
- score: 2
interface ParseSkillMdResult
- file: src/platform/ai/utils/skill-md-parser.ts:17
- kind: interface
- core: platform
- spec: (none)
- summary: Result returned by .
- score: 1
interface PasskeySignInResult
- file: src/platform/auth/passkey/passkey-utils.ts:25
- kind: interface
- core: platform
- spec: (none)
- summary: Outcome of a passwordless passkey sign-in attempt.
- score: 2
interface PatternBaseline
- file: src/platform/query-performance/anomaly-rules.ts:29
- kind: interface
- core: platform
- spec: (none)
- summary: Summary of a query pattern with baseline metrics
- score: 2
interface PayloadValidationResult
- file: src/platform/events/eventPayloadValidation.ts:19
- kind: interface
- core: platform
- spec: (none)
- summary: Result of payload validation.
- score: 1
interface PayrollIntegrationStatus
- file: src/platform/onboarding/integrations/payrollIntegration.ts:33
- kind: interface
- core: platform
- spec: (none)
- summary: Enhanced payroll status with actionable information
- score: 2
interface PayrollOnboardingTask
- file: src/platform/onboarding/integrations/payrollIntegration.ts:147
- kind: interface
- core: platform
- spec: (none)
- summary: Generate onboarding tasks for payroll setup
- score: 2
type PayrollSetupState
- file: src/platform/onboarding/integrations/payrollIntegration.ts:15
- kind: type
- core: platform
- spec: (none)
- summary: Payroll setup completion state
- score: 2
interface PdfGenerationOptions
- file: src/platform/documents/pdfGenerator.ts:50
- kind: interface
- core: platform
- spec: (none)
- summary: PDF generation options
- score: 1
interface PdfTableConfig
- file: src/platform/documents/pdfGenerator.ts:89
- kind: interface
- core: platform
- spec: (none)
- summary: Table configuration for PdfBuilder
- score: 2
interface PdfTextStyle
- file: src/platform/documents/pdfGenerator.ts:104
- kind: interface
- core: platform
- spec: (none)
- summary: Text style configuration
- score: 1
type PFPermission
- file: src/platform/permissions/constants.ts:2447
- kind: type
- core: platform
- spec: (none)
- summary: Union of every Platform Foundation (PF) permission key.
- score: 2
interface PhiAccessAuditRow
- file: src/platform/fleet/hooks/usePhiAccessAudit.ts:30
- kind: interface
- core: platform
- spec: (none)
- summary: A single row from the pf_agent_phi_access_audit RPC — content-free audit metadatawith the PF-126 governance decision resolved to outcome labels.
- score: 2
interface PHIDetectionResult
- file: src/platform/ai/widgets/utils/sanitizeForAI.ts:9
- kind: interface
- core: platform
- spec: (none)
- summary: PF-28: PHI/PII Sanitization Utility for AICRITICAL: All content sent to external AI services MUST be sanitized.This utility detects and redacts personally identifiable information (PII)and protected health information (PHI) before transmission.
- score: 2
interface PhiScanHit
- file: src/platform/ai/wizards/ai-skill-creation/phi-scan.ts:20
- kind: interface
- core: platform
- spec: (none)
- summary: A single PHI hit found in a prompt field.
- score: 2
interface PhiScanResult
- file: src/platform/ai/wizards/ai-skill-creation/phi-scan.ts:28
- kind: interface
- core: platform
- spec: (none)
- summary: Result of the author-time regex PHI scan over both prompt fields.
- score: 2
interface PicklistItemWithAliases
- file: src/platform/import/mapping/valueMatching.ts:23
- kind: interface
- core: platform
- spec: (none)
- summary: A resolved target option enriched with optional alias metadata.
- score: 2
type PicklistWithCount
- file: src/platform/picklists/hooks/usePicklists.ts:17
- kind: type
- core: platform
- spec: (none)
- summary: Picklist row enriched with its total item count (active + inactive).
- score: 2
interface PlanAmendment
- file: src/platform/clinical/plan/record-amendment.ts:59
- kind: interface
- core: platform
- spec: (none)
- summary: One persisted amendment row (boundary shape).
- score: 2
type PlanElementKind
- file: src/platform/clinical/plan/record-amendment.ts:17
- kind: type
- core: platform
- spec: (none)
- summary: The person-centered-plan element kinds an amendment can target.
- score: 2
interface PlanSignGate
- file: src/platform/clinical/plan/measurable.ts:37
- kind: interface
- core: platform
- spec: (none)
- summary: The result of the sign-time measurable-objective gate.
- score: 2
type PMPermission
- file: src/platform/permissions/constants.ts:2445
- kind: type
- core: platform
- spec: (none)
- summary: Union of every Practice Management (PM) permission key.
- score: 2
type Prefetcher
- file: src/platform/routing/prefetch/registry.ts:30
- kind: type
- core: platform
- spec: (none)
- summary: Fire-and-forget prefetch hook for a route. Errors are swallowed by the caller.
- score: 2
interface PresetDisplayInfo
- file: src/platform/onboarding/integrations/milestonePresets.ts:257
- kind: interface
- core: platform
- spec: (none)
- summary: Format preset for display in UI
- score: 2
interface ProcessDiscoveredPayload
- file: src/platform/events/publishers/processHealthPublisher.ts:27
- kind: interface
- core: platform
- spec: (none)
- summary: Payload for the event.
- score: 1
interface ProcessHealthChangedPayload
- file: src/platform/events/publishers/processHealthPublisher.ts:15
- kind: interface
- core: platform
- spec: (none)
- summary: Payload for the event.
- score: 1
interface ProduceArtifactArgs
- file: src/platform/ai/agentic/intake-artifact.ts:48
- kind: interface
- core: platform
- spec: (none)
- summary: Arguments for .
- score: 1
interface PromptSafetyIssue
- file: src/platform/ai/prompt-safety.ts:26
- kind: interface
- core: platform
- spec: (none)
- summary: A single prompt-safety finding with a human-readable reason.
- score: 2
interface PropsAdapterOptions
- file: src/platform/table-v2/adapter/propsAdapter.ts:145
- kind: interface
- core: platform
- spec: (none)
- summary: Options for the props adapter.
- score: 2
interface PublicAuthRoute
- file: src/platform/auth/public-auth-routes.config.ts:9
- kind: interface
- core: platform
- spec: (none)
- summary: PF-110 — Path-only projection of the public auth routes.Kept in a non-JSX module so exports only the renderedroute fragment and stays Fast Refresh friendly. Tests that must not importReact lazy chunks import these plain string paths instead.
- score: 2
interface PushManagerRegistration
- file: src/platform/notifications/hooks/usePushSubscription.ts:8
- kind: interface
- core: platform
- spec: (none)
- summary: Typed interface for ServiceWorkerRegistration with PushManager (avoids )
- score: 2
interface QueryBudget
- file: src/platform/analytics/semantic-compiler.ts:55
- kind: interface
- core: platform
- spec: (none)
- summary: Row-count + execution-time budgets (FR-12). Defaults inherited from the PM-61 pm_report_run precedent.
- score: 2
interface QueryPersistenceOptions
- file: src/platform/offline/queryPersistence.ts:175
- kind: interface
- core: platform
- spec: (none)
- summary: Query persistence options
- score: 1
interface QueryPlanData
- file: src/platform/query-performance/hooks/useCaptureQueryPlan.ts:22
- kind: interface
- core: platform
- spec: (none)
- summary: Parsed query plan data from custom_fields
- score: 2
type QuickActionsSectionLayout
- file: src/platform/dashboard/components/QuickActionsSection.tsx:43
- kind: type
- core: platform
- spec: (none)
- summary: — overview header + expand/collapse. — buttons only (e.g. embedded in a dashboard widget).
- score: 2
interface RawCaptureEvent
- file: src/platform/automation/portal/recorder/compile.ts:38
- kind: interface
- core: platform
- spec: (none)
- summary: One raw event in a captured session, before compilation.
- score: 2
interface RCAdapter
- file: src/platform/telephony/lib/embeddable-events.ts:249
- kind: interface
- core: platform
- spec: (none)
- summary: Typed interface for the RingCentral Embeddable RCAdapter APIexposed on when the widget is loaded.
- score: 2
interface RecommendationBodyArgs
- file: src/platform/ai/agentic/intake-artifact.ts:21
- kind: interface
- core: platform
- spec: (none)
- summary: Inputs for the human-readable recommendation body.
- score: 2
interface RecommendedSkill
- file: src/platform/ai/hooks/useRecommendedSkills.ts:27
- kind: interface
- core: platform
- spec: (none)
- summary: A single recommended standard skill surfaced for confirm.
- score: 2
interface RecommendedSkill
- file: src/platform/ai/lib/onboarding-logic.ts:41
- kind: interface
- core: platform
- spec: (none)
- summary: A recommended standard skill as surfaced by PF-62-EN-01’s ranking.
- score: 2
interface RecordAmendmentInput
- file: src/platform/clinical/plan/record-amendment.ts:27
- kind: interface
- core: platform
- spec: (none)
- summary: Input to record one plan amendment.
- score: 2
interface RecorderState
- file: src/platform/analytics/sessionRecorder.ts:123
- kind: interface
- core: platform
- spec: (none)
- summary: Recorder state
- score: 1
interface RecordingSession
- file: src/platform/analytics/sessionRecorder.ts:64
- kind: interface
- core: platform
- spec: (none)
- summary: Recording session metadata
- score: 1
type RedactFn
- file: src/platform/ai/phi-two-path-enforcer.ts:38
- kind: type
- core: platform
- spec: (none)
- summary: The injected redactor (the canonical ). MAY throw fail-closed.
- score: 2
interface RedactionContext
- file: src/platform/ai/phi-redaction-core.ts:34
- kind: interface
- core: platform
- spec: (none)
- summary: Caller-supplied literal identifiers to remove (names/MRNs/ids known from context).
- score: 2
interface RedactionResult
- file: src/platform/ai/phi-redaction-core.ts:43
- kind: interface
- core: platform
- spec: (none)
- summary: Result of a redaction: PHI-safe text + per-category match counts (never values).
- score: 2
interface RedirectOrgInfo
- file: src/platform/theming/utils/canonical-redirect.ts:9
- kind: interface
- core: platform
- spec: (none)
- summary: Org fields required for redirect eligibility check.
- score: 2
interface RegisterEntraInput
- file: src/platform/integrations/hooks/useEntraSetup.ts:26
- kind: interface
- core: platform
- spec: (none)
- summary: Step-1 wizard input: primary domain (+ optional tenant, license SKU, BYO app id).
- score: 2
interface RegistryToolDef
- file: src/platform/ai/registry-tool-resolution.ts:23
- kind: interface
- core: platform
- spec: PF-127
- summary: A model tool definition (matches the shape consumed by the agentic loop).
- see:
- resolveRegistryToolDefs
- score: 5
type RejectionAuditRpc
- file: src/platform/ai/mcp-rejection-audit.ts:39
- kind: type
- core: platform
- spec: PF-127
- summary: Minimal Supabase RPC surface (production: ).
- see:
- auditMcpRejections
- score: 5
interface ResolvedInstanceContext
- file: src/platform/clinical/blocks/suicide/chart-resolver.ts:82
- kind: interface
- core: platform
- spec: (none)
- summary: A extended with the resolved chart id.
- score: 2
interface ResolvedSuiteBlockEntry
- file: src/platform/clinical/blocks/suicide/fail-closed.ts:16
- kind: interface
- core: platform
- spec: (none)
- summary: One resolved suite block from the CL-75 result.
- score: 2
interface ResolvedSuiteRequirement
- file: src/platform/clinical/blocks/suicide/fail-closed.ts:27
- kind: interface
- core: platform
- spec: (none)
- summary: The required suite-block set plus whether the floor was applied.
- score: 2
interface ResolvedTargetsWithPolicy
- file: src/platform/ai/mapping-targets/resolveTargets.ts:96
- kind: interface
- core: platform
- spec: (none)
- summary: A binding’s resolved values paired with the strictness policy to enforce.
- score: 2
type ResolveToolsRpc
- file: src/platform/ai/registry-tool-resolution.ts:34
- kind: type
- core: platform
- spec: PF-127
- summary: Minimal Supabase RPC surface (production: ).
- see:
- resolveRegistryToolDefs
- score: 5
type ResourceType
- file: src/platform/quota/constants.ts:14
- kind: type
- core: platform
- spec: (none)
- summary: Type-safe resource type union.
- score: 2
type RHPermission
- file: src/platform/permissions/constants.ts:2429
- kind: type
- core: platform
- spec: (none)
- summary: Union of every Recovery Housing (RH) permission key.
- score: 2
interface RichTextFieldSettings
- file: src/platform/forms/components/fields/RichTextField.tsx:60
- kind: interface
- core: platform
- spec: (none)
- summary: Rich text field settings
- score: 1
interface RoleLicenseMapping
- file: src/platform/integrations/hooks/useEntraRoleLicenseMap.ts:22
- kind: interface
- core: platform
- spec: (none)
- summary: A single role → Microsoft Graph license-SKU mapping from: binds one PF-30 system role () to thelicense SKU that newly-provisioned employees in that role should receive.
- score: 2
interface RosEntry
- file: src/platform/clinical/blocks/ros-adapter.ts:20
- kind: interface
- core: platform
- spec: (none)
- summary: One row: a per-system entry ( set) or the summary header ( null).
- score: 2
type RosExtent
- file: src/platform/clinical/blocks/ros-exam/ros-extent.ts:21
- kind: type
- core: platform
- spec: (none)
- summary: The advisory 1997-DG ROS extent (matches the seeded PF-15 picklist).
- score: 2
interface SafetyPlan
- file: src/platform/clinical/blocks/suicide/safety-plan-adapter.ts:31
- kind: interface
- core: platform
- spec: (none)
- summary: The safety_plan block’s form-value shape (field_schema keys).
- score: 2
interface SanitizationResult
- file: src/platform/wizards/utils/sanitizeAnalyticsEvent.ts:143
- kind: interface
- core: platform
- spec: (none)
- summary: Result of sanitization operation
- score: 2
interface ScalarSettingDef
- file: src/platform/provisioning/lib/moduleOverridesForm.ts:26
- kind: interface
- core: platform
- spec: (none)
- summary: Scalar pf_module_settings a request may tune from the dialog. //mirror the pf_module_settings CHECK constraints + column DEFAULTs in the baseline DDL(00000000000000_baseline_2026_05_28_ddl.sql) so the UI never offers a value the triggeror column constraint would reject. Each key is a member of the edge function’sMODULE_SETTINGS_COLUMNS whitelist, so it lands in a typed column (never custom_fields).
- score: 2
interface SchedulingReadClient
- file: src/platform/scheduling/listIntakeProviderAvailability.ts:13
- kind: interface
- core: platform
- spec: (none)
- summary: A structural subset of the Supabase client this read needs (so it is unit-testable).
- score: 2
interface SchemaDiffEntry
- file: src/platform/events/computeSchemaDiff.ts:6
- kind: interface
- core: platform
- spec: (none)
- summary: Represents a single property change in a schema diff.
- score: 2
interface SchemaDiffResult
- file: src/platform/events/computeSchemaDiff.ts:14
- kind: interface
- core: platform
- spec: (none)
- summary: Full diff result between two schemas.
- score: 2
interface SchemaExportOptions
- file: src/platform/forms/utils/schemaExport.ts:26
- kind: interface
- core: platform
- spec: (none)
- summary: JSON Schema export options
- score: 1
type ScreeningInstrument
- file: src/platform/clinical/blocks/suicide/screening-routing.ts:15
- kind: type
- core: platform
- spec: (none)
- summary: The validated instruments the screen routes between.
- score: 2
interface ScreeningMappingInput
- file: src/platform/ce/screeningToPatientMapping.ts:20
- kind: interface
- core: platform
- spec: (none)
- summary: Input from screening attempt + result for mapping.
- score: 2
interface ScreeningPatientMapping
- file: src/platform/ce/screeningToPatientMapping.ts:6
- kind: interface
- core: platform
- spec: (none)
- summary: Shape of mapped patient fields from screening data.
- score: 2
interface ScreeningRoutingContext
- file: src/platform/clinical/blocks/suicide/screening-routing.ts:18
- kind: interface
- core: platform
- spec: (none)
- summary: Encounter age context + optional PF-96 threshold override.
- score: 2
interface ScreenResultInput
- file: src/platform/clinical/blocks/suicide/screening-routing.ts:46
- kind: interface
- core: platform
- spec: (none)
- summary: The minimal screen result the positivity rule reads.
- score: 2
type SdohDomainStatus
- file: src/platform/clinical/blocks/sdoh-adapter.ts:43
- kind: type
- core: platform
- spec: (none)
- summary: A per-domain screening result (PF-15 value).
- score: 2
interface SdohScreening
- file: src/platform/clinical/blocks/sdoh-adapter.ts:46
- kind: interface
- core: platform
- spec: (none)
- summary: The sdoh_screening block’s form-value shape (field_schema keys).
- score: 2
interface SemanticDefinition
- file: src/platform/analytics/semantic-compiler.ts:26
- kind: interface
- core: platform
- spec: (none)
- summary: A registered semantic definition (subset of pf_analytics_semantic_models needed to compile).
- score: 2
type SemanticModelType
- file: src/platform/analytics/semantic-compiler.ts:23
- kind: type
- core: platform
- spec: (none)
- summary: PF-123 Embedded Analytics Platform — semantic-spec compiler (Tier-2 mediation).The runtime-agnostic heart of the mediation seam: it takes a client-suppliedanalytics query spec + the governed semantic registry allowlist and produces avalidated, normalized plan that a backend (DuckDB-WASM inPhase 1, a SQL target later) compiles to an actual query.It enforces two spec requirements independent of any runtime: - FR-4: only metric/dimension/filter keys present in the registry allowlist are accepted; unknown keys are rejected (the no-free-text-SQL boundary). - FR-12: the row-count budget (default 100k) is enforced at plan time; the execution-time budget (default 30s) is carried in the plan for the runtime to enforce. An over-budget request aborts with QUERY_LIMIT_EXCEEDED (AC-011).It also surfaces whether any selected definition is SUD-derived (FR-15), which theembed path uses to gate external rendering (AC-010) — this module does not itselfmake the consent decision.Pure + deterministic: no I/O, no Supabase, no DuckDB. Fully unit-testable.
- score: 2
type SemanticRegistry
- file: src/platform/analytics/semantic-compiler.ts:34
- kind: type
- core: platform
- spec: (none)
- summary: The governed allowlist: key → definition. Built from pf_analytics_semantic_models.
- score: 2
interface ServeVerdict
- file: src/platform/analytics/serving/kpi-suppression.ts:19
- kind: interface
- core: platform
- spec: (none)
- summary: A pf_analytics_run verdict, loose enough to accept the edge fn’s jsonb passthrough.No index signature — declared properties match AnalyticsRunResult so no cast is needed.
- score: 2
interface ServingVerdict
- file: src/platform/analytics/serving/mart-suppression.ts:123
- kind: interface
- core: platform
- spec: (none)
- summary: A verdict as returned by the RPC: a status envelope carrying RAWaggregate rows (or an empty/pending state). Shape kept loose (index signature) so bothedge functions can pass the RPC’s jsonb result straight through.
- score: 2
interface SessionMetadata
- file: src/platform/analytics/sessionRecorder.ts:77
- kind: interface
- core: platform
- spec: (none)
- summary: Session metadata for analytics
- score: 2
interface SessionRecorderConfig
- file: src/platform/analytics/sessionRecorder.ts:97
- kind: interface
- core: platform
- spec: (none)
- summary: Recorder configuration
- score: 1
type SetupCompleteCheck
- file: src/platform/setup/module-setup-registry.ts:10
- kind: type
- core: platform
- spec: (none)
- summary: Module Guided Setup RegistryCentral registry for per-module guided setup: setup tour ids, setup wizard routes,and how to infer “setup complete” for the Getting Started card.
- see:
- docs/development/MODULE_GUIDED_SETUP.md
- score: 5
type SidebarMode
- file: src/platform/navigation/hooks/useNavigationContext.ts:7
- kind: type
- core: platform
- spec: (none)
- summary: Sidebar display mode
- score: 1
interface SignatureTemplate
- file: src/platform/email-signatures/utils/templates.ts:6
- kind: interface
- core: platform
- spec: (none)
- summary: Signature template definition
- score: 1
interface SkillEnablementOverrideRow
- file: src/platform/ai/lib/onboarding-logic.ts:34
- kind: interface
- core: platform
- spec: (none)
- summary: The org-scoped enablement override row this wizard upserts when a recommendedskill is confirmed. Mirrors the real write shape used by (keyed on , ).Org-profile text is NEVER written here — runtime injection (PF-62-EN-01) carriesit (AC-7).
- score: 2
type SkillRouting
- file: src/platform/ai/wizards/ai-skill-creation/routing.ts:18
- kind: type
- core: platform
- spec: (none)
- summary: Where Step 5 routes the create: self-activate now, or submit for PF-120 approval.
- score: 2
type SkuValidation
- file: src/platform/integrations/entra-skus.ts:24
- kind: type
- core: platform
- spec: (none)
- summary: Result of validating a SKU id against the (possibly unavailable) catalog.
- score: 2
interface SLADashboardStats
- file: src/platform/sla/hooks/useSLADashboard.ts:12
- kind: interface
- core: platform
- spec: (none)
- summary: Dashboard statistics for SLA overview.
- score: 2
type SLAEventType
- file: src/platform/sla/services/sla-notifications.ts:10
- kind: type
- core: platform
- spec: (none)
- summary: SLA event types for notification dispatch.
- score: 2
interface SLAInstanceFilters
- file: src/platform/sla/hooks/useSLAInstances.ts:22
- kind: interface
- core: platform
- spec: (none)
- summary: Filters for SLA instance queries.
- score: 2
interface SLANotificationPayload
- file: src/platform/sla/services/sla-notifications.ts:13
- kind: interface
- core: platform
- spec: (none)
- summary: Payload for SLA notification events (IDs only — no PHI).
- score: 2
interface SLAStatusBadgeProps
- file: src/platform/sla/components/SLAIndicator.tsx:80
- kind: interface
- core: platform
- spec: (none)
- summary: Presentational SLA status badge for shared use across cores.
- score: 2
interface SmallCellResult
- file: src/platform/analytics/suppression.ts:32
- kind: interface
- core: platform
- spec: (none)
- summary: The result of masking a single grouped count. is the true integer count when visible and when suppressed — the smallcount never survives into a payload. is a render-ready token.
- score: 2
type SortErrorCode
- file: src/platform/table-v2/utils/sort/errors.ts:7
- kind: type
- core: platform
- spec: (none)
- summary: PF-57: Sort Configuration ErrorsError types for sort validation.
- score: 2
type SsoGateResult
- file: src/platform/auth/sso/useSsoLogin.ts:32
- kind: type
- core: platform
- spec: (none)
- summary: Outcome of the known-employees-only SSO gate (): - : the active session was not established via SSO, so no gate applies, - : the identity matched a known employee and may proceed, - : no matching employee record — the JIT account was revoked and the user signed out; is a user-safe explanation, - : the match check itself failed; carries a sanitized message.
- score: 2
type SsoLoginMode
- file: src/platform/auth/sso/useSsoLogin.ts:56
- kind: type
- core: platform
- spec: (none)
- summary: How a given email domain signs in: shared-app Entra OIDC (PF-112-EN-01),per-org SAML (PF-112), or not federated at all.
- score: 2
interface SsoSetupWizardProps
- file: src/platform/auth/sso/SsoSetupWizard.tsx:65
- kind: interface
- core: platform
- spec: (none)
- summary: Props for : controlled dialog open state, its change handler, and an optional callback fired once SSO is activated.
- score: 2
interface StorageBinding
- file: src/platform/clinical/blocks/adapter-registry.ts:21
- kind: interface
- core: platform
- spec: (none)
- summary: A block’s JSONB as stored on .
- score: 2
interface SubmitAiSkillInput
- file: src/platform/ai/hooks/useSkillLifecycleMutations.ts:33
- kind: interface
- core: platform
- spec: (none)
- summary: Input for submitting a skill for activation/review.
- score: 2
type SudEmbedGateReason
- file: src/platform/analytics/embed/sud-embed-gate.ts:27
- kind: type
- core: platform
- spec: (none)
- summary: PF-123 — SUD-embed consent gate decision (FR-15 / AC-010 / NFR-priv-3; compliance Cond 1).Fail-closed policy for the external signed-embed path: a metric flagged SUD-derived(42 CFR Part 2) may render on an external embed ONLY when the organization holds anexplicit, standing per-org Part-2-embed authorization — an attestation that the programhas the §2.31 disclosure authorization required to surface SUD-derived aggregates outsidethe Encore app. Absent that authorization, zero SUD-derived values are returned. Non-SUDmetrics always pass.This module is the tested specification of the policy. The authoritative, unbypassableenforcement lives server-side in (the embed branch returns) — the edge function relies on that RPC gate(it does not re-decide). This function exists to (a) pin the fail-closed truth table in aunit test (the SQL gate mirrors it) and (b) let the in-app mint UI, via the consent seam (), warn an admin beforeminting a token for a dashboard that contains SUD-derived metrics.Why fail-closed is correct under every legal reading of “per-recipient Part 2 consentposture” (FR-15): if compliance later rules that aggregate SUD embed is impossible, theauthorization flag is simply never set and SUD stays blocked everywhere — no rework. Ifcompliance ratifies the org-attestation model, the flag is the switch that enables it.Pure + deterministic: no I/O. Fully unit-testable (AC-010).
- score: 2
interface SuggestedWorkspaceCardProps
- file: src/platform/navigation/workspaces/admin/SuggestedWorkspaceCard.tsx:34
- kind: interface
- core: platform
- spec: (none)
- summary: Props for : the recommendation row plus accept/edit/dismiss handlers and an in-flight flag.
- score: 2
interface SuicideAssessment
- file: src/platform/clinical/blocks/suicide/suicide-assessment-adapter.ts:23
- kind: interface
- core: platform
- spec: (none)
- summary: The assessment block’s form-value shape (field_schema keys).
- score: 2
interface SuicideScreen
- file: src/platform/clinical/blocks/suicide/suicide-screen-adapter.ts:24
- kind: interface
- core: platform
- spec: (none)
- summary: The screen block’s form-value shape (field_schema keys).
- score: 2
interface SuiteRequiredness
- file: src/platform/clinical/blocks/suicide/requiredness.ts:35
- kind: interface
- core: platform
- spec: (none)
- summary: Which suite fields are required for the current context.
- score: 2
interface SuiteRequirednessInput
- file: src/platform/clinical/blocks/suicide/requiredness.ts:23
- kind: interface
- core: platform
- spec: (none)
- summary: Inputs that drive the suite’s conditional field requiredness.
- score: 2
interface SuiteResolutionInput
- file: src/platform/clinical/blocks/suicide/fail-closed.ts:22
- kind: interface
- core: platform
- spec: (none)
- summary: The suite resolution payload (a subset of the CL-75 resolved surface).
- score: 2
interface SupabaseRpcClient
- file: src/platform/ai/agentic/intake-rpc-adapters.ts:14
- kind: interface
- core: platform
- spec: (none)
- summary: The narrow Supabase surface these adapters need (production: ).
- score: 2
interface SuppressedCell
- file: src/platform/analytics/complementary-suppression.ts:34
- kind: interface
- core: platform
- spec: (none)
- summary: A masked table cell: plus why it was suppressed.
- score: 2
interface SurfaceCompletenessParams
- file: src/platform/clinical/completeness/getSurfaceDocumentationCompleteness.ts:27
- kind: interface
- core: platform
- spec: (none)
- summary: Parameters identifying the encounter/surface to score.
- score: 2
type SystemPermission
- file: src/platform/permissions/constants.ts:2449
- kind: type
- core: platform
- spec: (none)
- summary: Union of every system-level permission key.
- score: 2
interface TbScreeningIndicator
- file: src/platform/clinical/blocks/ros-exam/tb-screening.ts:26
- kind: interface
- core: platform
- spec: (none)
- summary: The computed TB-screening-due indicator for a residential admission.
- score: 2
interface TbScreeningIndicatorParams
- file: src/platform/clinical/blocks/ros-exam/tb-screening.ts:63
- kind: interface
- core: platform
- spec: (none)
- summary: Parameters identifying the admission to compute the indicator for.
- score: 2
interface TextDiffResult
- file: src/platform/documents/utils/documentDiff.ts:21
- kind: interface
- core: platform
- spec: (none)
- summary: Result of computing a text diff between two strings
- score: 2
interface ThemeDiffMismatch
- file: src/platform/theming/utils/diffTheme.ts:20
- kind: interface
- core: platform
- spec: (none)
- summary: A single drift entry produced by .
- score: 2
interface ThemeDiffResult
- file: src/platform/theming/utils/diffTheme.ts:31
- kind: interface
- core: platform
- spec: (none)
- summary: Result returned by .
- score: 1
interface ThrottleLimitConfig
- file: src/platform/workflow/execution.ts:119
- kind: interface
- core: platform
- spec: (none)
- summary: A single active FW-53 rate-limit configuration.
- score: 2
interface ThrottleStatus
- file: src/platform/workflow/execution.ts:126
- kind: interface
- core: platform
- spec: (none)
- summary: Read-only snapshot of FW-53 throttle posture for an org/workflow.
- score: 2
type TileSpan
- file: src/platform/analytics/dashboard/layout-types.ts:13
- kind: type
- core: platform
- spec: (none)
- summary: Column span on the responsive 4-col canvas (collapses to 1 on mobile).
- score: 2
interface TransformConfig
- file: src/platform/import/mapping/applyTransforms.ts:19
- kind: interface
- core: platform
- spec: (none)
- summary: Configuration for a transform.
- score: 2
interface TransformPreviewProps
- file: src/platform/settings/pages/data-migration/components/TransformPreviewCard.tsx:18
- kind: interface
- core: platform
- spec: (none)
- summary: Props for the component.
- score: 1
interface TransformRules
- file: src/platform/settings/pages/data-migration/components/TransformRulesEditor.tsx:15
- kind: interface
- core: platform
- spec: (none)
- summary: Shape of the transform_rules JSON stored on each mapping.
- score: 2
interface TransformRulesEditorProps
- file: src/platform/settings/pages/data-migration/components/TransformRulesEditor.tsx:23
- kind: interface
- core: platform
- spec: (none)
- summary: Props for the component.
- score: 1
type TransformType
- file: src/platform/import/mapping/applyTransforms.ts:16
- kind: type
- core: platform
- spec: (none)
- summary: Union of the supported field-transform names (see ).
- score: 2
interface UnreadStats
- file: src/platform/messaging/utils/unreadCalculator.ts:5
- kind: interface
- core: platform
- spec: (none)
- summary: Unread count calculation utilities
- score: 2
type UpdateAgentPatch
- file: src/platform/cowork/agentsService.ts:37
- kind: type
- core: platform
- spec: (none)
- summary: Fields an admin may patch on an existing agent.
- score: 2
interface UpdateRecommendationStatusInput
- file: src/platform/navigation/workspaces/admin/useWorkspaceMutations.ts:247
- kind: interface
- core: platform
- spec: (none)
- summary: Arguments for : the recommendation and its new terminal .
- score: 2
interface UpdateWorkspaceInput
- file: src/platform/navigation/workspaces/admin/useWorkspaceMutations.ts:173
- kind: interface
- core: platform
- spec: (none)
- summary: Arguments for : the workspace plus the partial column to apply.
- score: 2
interface UseControlledPaginationOptions
- file: src/platform/table-v2/utils/pagination/hooks.ts:193
- kind: interface
- core: platform
- spec: (none)
- summary: Options for useControlledPagination hook
- score: 2
interface UseCoworkPresenceReturn
- file: src/platform/cowork/useCoworkPresence.ts:25
- kind: interface
- core: platform
- spec: (none)
- summary: Return type for useCoworkPresence.
- score: 2
type UseExemptionDisclosureGate
- file: src/platform/clinical/ceem/disclosure-gate.contract.ts:92
- kind: type
- core: platform
- spec: (none)
- summary: Read-only hook contract for the compliance console. NEVER builds payloadsclient-side — it only surfaces the server gate’s decision state.
- score: 2
interface UsePaginationOptions
- file: src/platform/table-v2/utils/pagination/hooks.ts:17
- kind: interface
- core: platform
- spec: (none)
- summary: Options for usePagination hook
- score: 2
interface UsePaginationReturn
- file: src/platform/table-v2/utils/pagination/hooks.ts:35
- kind: interface
- core: platform
- spec: (none)
- summary: Return type for usePagination hook
- score: 2
type UseWorkflowEnqueueVariables
- file: src/platform/workflow/useWorkflowEnqueue.ts:23
- kind: type
- core: platform
- spec: (none)
- summary: Input to the hook’s mutate function; is optional (defaults to current org).
- score: 2
interface ValidatedShareData
- file: src/platform/dashboard/hooks/useDashboardShares.ts:151
- kind: interface
- core: platform
- spec: (none)
- summary: Share token validation result with proper typing
- score: 2
interface ValidationContext
- file: src/platform/wizards/utils/validationExpressionEvaluator.ts:30
- kind: interface
- core: platform
- spec: (none)
- summary: Context for validation expression evaluation
- score: 2
interface ValidationExpressionResult
- file: src/platform/wizards/utils/validationExpressionEvaluator.ts:20
- kind: interface
- core: platform
- spec: (none)
- summary: Result of a validation expression evaluation
- score: 2
interface ValidationFunctionDoc
- file: src/platform/wizards/utils/validationFunctions.ts:453
- kind: interface
- core: platform
- spec: (none)
- summary: Function metadata for documentation
- score: 2
interface ValidationItem
- file: src/platform/workflow/utils/diagramValidation.ts:27
- kind: interface
- core: platform
- spec: (none)
- summary: A single validation finding.
- score: 1
interface ValidationResult
- file: src/platform/workflow/utils/diagramValidation.ts:35
- kind: interface
- core: platform
- spec: (none)
- summary: Result of diagram validation containing errors and warnings.
- score: 2
type ValueDecision
- file: src/platform/import/components/ValueMappingStep.tsx:57
- kind: type
- core: platform
- spec: (none)
- summary: The user’s decision for a single incoming value on a bound field:- : remap to - : pass through unchanged (may cause a validation error later)
- score: 2
interface ValueMappingStepProps
- file: src/platform/import/components/ValueMappingStep.tsx:65
- kind: interface
- core: platform
- spec: (none)
- summary: Props for : the parsed source data, the current field mappings to reconcile, and completion/back callbacks.
- score: 2
type ValueMatchResult
- file: src/platform/import/mapping/valueMatching.ts:29
- kind: type
- core: platform
- spec: (none)
- summary: The classification result for a single distinct incoming value.
- score: 2
type VendorBaaStatus
- file: src/platform/transcription/admin/lib/deriveBaaStatus.ts:11
- kind: type
- core: platform
- spec: (none)
- summary: PF-100 H2: Derive BAA status from signature, expiry, vault credential,and an explicit revocation flag. Single source of truth used by both thedialog (live preview) and (authoritative write).Mirrors the DB status guard (,auto-expire when ) and adds the credential gatethat enforces at session time.
- score: 2
interface VersionComparisonResult
- file: src/platform/documents/hooks/useDocumentVersionComparison.ts:21
- kind: interface
- core: platform
- spec: (none)
- summary: Result shape for version comparison
- score: 2
interface VitalSigns
- file: src/platform/clinical/blocks/vitals-adapter.ts:28
- kind: interface
- core: platform
- spec: (none)
- summary: The vitals block’s form-value shape (field_schema keys = cl_vital_signs columns).
- score: 2
interface WidgetDataDescriptor
- file: src/platform/dashboard/hooks/useWidgetData.ts:7
- kind: interface
- core: platform
- spec: (none)
- summary: Describes a single widget data read serviced by the pf_widget_query broker. The broker independently re-validates and against its server-side allowlist, so this is a request of intent, not a trust boundary.
- score: 2
interface WorkspaceInsert
- file: src/platform/navigation/workspaces/admin/useWorkspaceMutations.ts:40
- kind: interface
- core: platform
- spec: (none)
- summary: Insert payload shape — mirrors the table schema (id, created_at/updated_at, audit cols are server-defaulted).
- score: 2
interface WorkspaceNavResult
- file: src/platform/navigation/hooks/useWorkspaceNav.ts:16
- kind: interface
- core: platform
- spec: (none)
- summary: Output of : the resolved (or if the id is unknown), its permission-filtered, ordered nav , and an flag that stays true while any referenced core is absent from themodule-registry snapshot.
- score: 2
type WorkspaceOrigin
- file: src/platform/navigation/workspaces/admin/useWorkspaceMutations.ts:37
- kind: type
- core: platform
- spec: (none)
- summary: How a workspace definition came to exist, used for provenance and UI badging: (a tenant edit of a shipped seed workspace), (authored from scratch by an admin), or (materialized from anaccepted suggestion).
- score: 2
type WorkspaceUpdate
- file: src/platform/navigation/workspaces/admin/useWorkspaceMutations.ts:56
- kind: type
- core: platform
- spec: (none)
- summary: Update payload — every column optional EXCEPT the immutable identity (workspace_key is enforced upstream).
- score: 2
Hooks
hook useAccessToken
- file: src/platform/auth/useCurrentUser.ts:111
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to get a fresh access token for API calls.Returns a function that fetches the current access token on demand.This ensures the token is always fresh when making API calls.
- example: | const getAccessToken = useAccessToken();const token = await getAccessToken();if (!token) throw new Error(‘Not authenticated’);
- score: 4
hook useActiveCallContext
- file: src/platform/telephony/hooks/useActiveCallContext.ts:58
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to match a phone number to CRM contacts and partners.Caches results to prevent repeated lookups for the same number.
- params:
- phoneNumber — The phone number to match (will be normalized)
- returns: Contact and partner match results
- example: | const contact, partner, isMatching = useActiveCallContext(activeCall?.from.phoneNumber);if (contact) console.log(‘Call from:’, contact.first_name, contact.last_name);
- score: 4
hook useActiveLeadsForConversion
- file: src/platform/ce/useActiveLeadsForConversion.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches active CE leads (new, contacted, qualified, nurturing) with optionaldebounced search on contact first/last name. For cross-core use by PM.
- score: 4
hook useActiveTheme
- file: src/platform/theming/hooks/useTenantTheme.ts:36
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch the active theme for the current organization.Returns if no theme row exists (empty state).
- score: 4
hook useActiveWizard
- file: src/platform/wizards/hooks/useActiveWizard.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing active wizard.
- score: 1
hook useActivityAwareSessionRefresh
- file: src/platform/auth/useActivityAwareSessionRefresh.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Keeps active users signed in by refreshing the Supabase sessionbefore server-side inactivity timeout elapses.Intentionally does not refresh while idle, so true inactivity canstill expire the session according to Supabase auth policy.
- score: 4
hook useAddEmployeeToSharePoint
- file: src/platform/integrations/hooks/useEmployeeEntraMemberships.ts:199
- kind: hook
- core: platform
- spec: (none)
- summary: Manually add employee to a SharePoint group
- score: 4
hook useAddEmployeeToTeam
- file: src/platform/integrations/hooks/useEmployeeEntraMemberships.ts:112
- kind: hook
- core: platform
- spec: (none)
- summary: Manually add employee to a Team
- score: 4
hook useAddIpAllowlist
- file: src/platform/security/hooks/useIpListMutations.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing add ip allowlist.
- score: 1
hook useAddIpBlocklist
- file: src/platform/security/hooks/useIpListMutations.ts:80
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing add ip blocklist.
- score: 1
hook useAddReportPermission
- file: src/platform/reports/hooks/useReportPermissions.ts:44
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook for adding a report permission.
- score: 4
hook useAddThreadAgent
- file: src/platform/cowork/useThreads.ts:64
- kind: hook
- core: platform
- spec: (none)
- summary: Add an attributed agent participant to a thread.
- score: 4
hook useAggregatedFieldStats
- file: src/platform/forms/hooks/useFieldInteractionStats.ts:86
- kind: hook
- core: platform
- spec: (none)
- summary: Get aggregated field stats across the date range
- score: 4
hook useAIAvailability
- file: src/platform/ai/hooks/useAIAvailability.ts:91
- kind: hook
- core: platform
- spec: (none)
- summary: Monitor AI availability and surface the correct degradation decision.Typical usage in a clinical or billing component:
- params:
- options — Optional .
- score: 3
hook useAIChat
- file: src/platform/ai/hooks/useAIChat.ts:75
- kind: hook
- core: platform
- spec: (none)
- summary: Manages AI chat state and streaming responses from the Lovable AI Gateway.Provides message state, loading/error indicators, and actions to send messages with streaming assistant responses,clear conversation history, stop an in-progress stream, and replace messages. Creates a React hook that:- stores conversation messages and loading/error state,- streams assistant responses incrementally and updates messages as chunks arrive,- authenticates requests using the current Supabase session access token.
- params:
- options — Configuration for the chat hook. - initialMessages: optional initial conversation messages - systemPrompt: optional system prompt to override the generated system prompt - moduleContext: optional module context passed to the AI gateway
- returns: The chat API: - messages: current conversation messages - isLoading: while a response is streaming - error: last encountered Error or - sendMessage(content: string): sends a user message and streams the assistant response - clearMessages(): clears the conversation and error - stopStream(): aborts the current streaming request - setMessages: React state setter for messages
- example: | function ChatComponent() const messages, isLoading, sendMessage, clearMessages, stopStream = useAIChat(); // send a message useEffect(() = sendMessage(‘Hello’); , []); return null;
- score: 4
hook useAIConversation
- file: src/platform/ai/hooks/useAIConversation.ts:46
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing aiconversation.
- score: 1
hook useAIConversations
- file: src/platform/ai/hooks/useAIConversations.ts:44
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing aiconversations.
- score: 1
hook useAIFeedback
- file: src/platform/ai/hooks/useAIFeedback.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing aifeedback.
- score: 1
hook useAIMappingSuggestions
- file: src/platform/ai/hooks/useAIMappingSuggestions.ts:80
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook for AI mapping suggestions. Returns the raw result; consumerskey back to their rows.
- score: 4
hook useAIModuleEnabled
- file: src/platform/ai/hooks/useAIModuleEnabled.ts:42
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing aimodule enabled.
- score: 1
hook useAISkill
- file: src/platform/ai/hooks/useAISkill.ts:48
- kind: hook
- core: platform
- spec: (none)
- summary: Load an AI skill by code, applying organization-specific overrides and falling back to the general assistant when needed. Fetches the active AI skill matching (or the fallback code when is undefined), prefers an organization-specific skill over a system skill, retrieves any organization override, and returns the merged effective skill along with query state and controls.
- params:
- skillCode — string | undefined - The skill code to load; when omitted the is used.
- options — UseAISkillOptions - Optional settings for the hook. Supported option: (default: ) to enable or disable the underlying query.
- returns: UseAISkillReturn - An object containing: - : The EffectiveAISkill (skill merged with organization override) or if no active skill was found. - : Loading state of the underlying query. - : An when the query failed, otherwise . - : Function to manually refetch the skill.
- example: | const skill, isLoading, error, refetch = useAISkill(‘sales_assistant’, enabled: true );
- score: 4
hook useAISkillChat
- file: src/platform/ai/hooks/useAISkillChat.ts:97
- kind: hook
- core: platform
- spec: (none)
- summary: Provides a skill-aware chat hook that manages conversation state, streams assistant responses, and exposes controls to send, clear, and abort messages. Initializes and returns chat state and actions tied to an AI skill (explicit or module default). Handles streaming assistant responses from the platform chat endpoint, incremental message updates, authentication via Supabase, and stream cancellation.
- params:
- options — Configuration for the chat hook: - skillCode?: string — explicit skill code to use; when provided, the hook loads that skill. - moduleContext?: AIModuleContext — module context used to resolve a default skill when no explicit skillCode is provided. - initialMessages?: AIMessage[] — initial conversation messages to preload into the chat state.
- returns: UseAISkillChatReturn - An object containing: - messages: current conversation messages - isLoading: whether an assistant response is currently streaming - error: last error encountered, if any - sendMessage(content: string): send a user message and stream the assistant response - clearMessages(): clear all messages and reset error - stopStream(): abort the active streaming response - setMessages: React state setter for messages - activeSkill: the currently selected EffectiveAISkill or null - isSkillLoading: whether the active skill is loading - setSkillCode(code: string): update the explicit skill code
- example: | const messages, isLoading, sendMessage, stopStream = useAISkillChat( moduleContext, initialMessages: [ id: ‘1’, role: ‘user’, content: ‘Hi’, timestamp: new Date() ]);
- score: 4
hook useAISkills
- file: src/platform/ai/hooks/useAISkills.ts:55
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches and returns the effective AI skills available to the current organization, applying optional filters and organization-specific overrides. Builds a cached query that retrieves skills from the pf_ai_skills table, optionally filters by category/module and activity, merges organization overrides from pf_ai_skill_overrides (when an organization context exists) to produce EffectiveAISkill objects, and filters out skills that are disabled by an override.
- params:
- options — Options to control which skills to fetch and whether the query is enabled - category: Optional category to filter skills by - module: Optional module name to filter skills; skills with a null module are included when a module is provided - includeInactive: If true, include skills where is_active is false; defaults to false - enabled: If false, disables the underlying query; defaults to true
- returns: UseAISkillsReturn - An object containing: - skills: EffectiveAISkill[] — the array of merged, enabled skills (empty array when none) - isLoading: boolean — whether the query is currently loading - error: Error | null — the error encountered when fetching skills, or null - refetch: () = void — function to manually refetch the query
- example: | const skills, isLoading, error, refetch = useAISkills( category: ‘assistant’, includeInactive: false );
- score: 4
hook useAiSkillVersions
- file: src/platform/ai/hooks/useAiSkillVersions.ts:41
- kind: hook
- core: platform
- spec: (none)
- summary: Returns the immutable version snapshots for a skill, ordered by descending.
- params:
- skillId — The whose history to load; when falsy the query is disabled.
- returns: An object with the array (newest first), , , and .
- score: 4
hook useAIStructuredOutput
- file: src/platform/ai/hooks/useAIStructuredOutput.ts:51
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing AI structured output.When every attempt (initial + retries) fails, the hook sets ,surfaces a sanitized error toast (via sonner) so failures are neversilent no-ops, and resolves to .
- score: 1
hook useAISuggestions
- file: src/platform/ai/hooks/useAISuggestions.ts:43
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing aisuggestions.
- score: 1
hook useAITemplateGenEnabled
- file: src/platform/templates/hooks/useAITemplateGenEnabled.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Returns whether AI template generation is enabled for the current organization.
- returns: — is until confirmed from DB.
- score: 4
hook useAIUsageStats
- file: src/platform/ai/hooks/useAIUsageStats.ts:35
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing aiusage stats.
- score: 1
hook useAIWizardGeneration
- file: src/platform/wizards/ai/useAIWizardGeneration.ts:74
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing aiwizard generation.
- score: 1
hook useAlertConfigs
- file: src/platform/health/hooks/useAlertConfigs.ts:32
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing alert configs.
- score: 1
hook useAlertHistory
- file: src/platform/health/hooks/useAlertHistory.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing alert history.
- score: 1
hook useAllModulePermissions
- file: src/platform/permissions/hooks/useAllModulePermissions.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch all permissions grouped by module
- score: 4
hook useAllModuleSettings
- file: src/platform/modules/useAllModuleSettings.ts:36
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing all module settings.
- score: 1
hook useAllRecentActivity
- file: src/platform/modules/useAllRecentActivity.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Batched hook that fetches recent activity for ALL modules in a single query,preventing N+1 API calls on the AppLauncher page.
- score: 4
hook useAllWorkspaces
- file: src/platform/navigation/workspaces/useAllWorkspaces.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Merge code seeds with the org’s DB rows. Strategy: - A DB row whose matches a seed OVERRIDES that seed. - A DB row with HIDES its target (seed or DB-only). - A DB row whose doesn’t match a seed is ADDED as a new workspace. - Seeds without an overriding DB row are preserved verbatim (provisional:true).Order: seeds (in declaration order, minus disabled), then DB-only rows in DB order.
- score: 4
hook useAnalyticsConnectors
- file: src/platform/analytics/hooks/useAnalyticsConnectors.ts:66
- kind: hook
- core: platform
- spec: (none)
- summary: Returns the list of connectors for (RLS-scoped to org members; writes go throughthe approval + credential RPCs). The mutation invalidates the query cache onsuccess so the status badge refreshes immediately.
- score: 4
hook useAnalyticsQuery
- file: src/platform/analytics/hooks/useAnalyticsQuery.ts:79
- kind: hook
- core: platform
- spec: (none)
- summary: Imperative form — run a query on demand (the builder’s “Run” action).
- score: 4
hook useAnalyticsQueryResult
- file: src/platform/analytics/hooks/useAnalyticsQuery.ts:95
- kind: hook
- core: platform
- spec: (none)
- summary: Declarative form — cache a dashboard/widget’s result keyed by org + spec.
- score: 4
hook useAnalyticsTheme
- file: src/platform/analytics/hooks/useAnalyticsTheme.ts:47
- kind: hook
- core: platform
- spec: (none)
- summary: Convenience: the org’s default theme (or the first one), for chart rendering.
- score: 4
hook useAnnouncer
- file: src/platform/a11y/announcer.ts:58
- kind: hook
- core: platform
- spec: (none)
- summary: Provides a function to announce messages to screen readers via aria-live regions.Uses a singleton DOM element per priority level to avoid duplicate announcements.Messages are automatically cleared after 3 seconds.
- returns: Object with function
- score: 4
hook useApiActivityLog
- file: src/platform/api-access/hooks/useApiActivityLog.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches paginated audit logs for API access entities.
- score: 4
hook useApiKeyList
- file: src/platform/api-access/hooks/useApiKeyList.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches API keys for a given service account.
- params:
- serviceAccountId — The service account to list keys for
- score: 4
hook useAppLockState
- file: src/platform/auth/app-lock/useAppLockState.ts:134
- kind: hook
- core: platform
- spec: (none)
- summary: Central app-lock state machine. Manages policy, PIN, lockout, biometric,and lock triggers in a single composable hook.
- score: 4
hook useApplyApprovalChainTemplate
- file: src/platform/templates/hooks/useApplyApprovalChainTemplate.ts:56
- kind: hook
- core: platform
- spec: (none)
- summary: Apply an approval chain template and produce resolved approvers for each step.Provides a mutation to resolve approvers for every step of a given approval chain template.The hook validates the current organization, fetches the template (scoped to the organization or system templates),resolves each step’s approver, increments the template usage count, and returns the resolved configuration.The caller is responsible for persisting any workflow or approval records.
- returns: An object containing: - : a mutation object with methods to trigger the resolution (e.g., , ) and its state, - : when the mutation is pending, otherwise.
- example: | // Resolve approvers and then create workflow records using the returned resolved stepsconst apply, isLoading = useApplyApprovalChainTemplate();apply.mutateAsync( templateId: ‘tpl_123’, entityType: ‘invoice’, entityId: ‘inv_456’, submitterId: ‘user_789’,).then(( templateId, resolvedSteps ) = // create approval workflow records using resolvedSteps);
- score: 4
hook useApplyApprovalTemplateToFWChain
- file: src/platform/templates/hooks/useApplyApprovalTemplateToFWChain.ts:110
- kind: hook
- core: platform
- spec: (none)
- summary: Create an FW approval chain from a PF-64 approval chain template and provide a mutation to apply it.The returned mutation fetches a PF-64 template, resolves dynamic approvers per step, creates a corresponding FW approval chain and its steps, rolls back the created chain if any step insertion fails, and attempts a non-blocking increment of the template usage. On success it invalidates relevant queries and shows a success toast; on failure it shows an error toast with a sanitized message.
- returns: A React Query mutation result () whose mutate function accepts and resolves to .
- score: 4
hook useApplyHolidayTemplate
- file: src/platform/calendar/hooks/use-apply-holiday-template.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Returns a mutation that applies a holiday template to a business calendar.
- params:
- calendarId — UUID of the target calendar.
- organizationId — UUID of the organization.
- returns: React Query mutation object.
- score: 4
hook useApplyModulePreset
- file: src/platform/modules/hooks/useApplyModulePreset.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing apply module preset.
- score: 1
hook useApplyTemplate
- file: src/platform/dashboard/hooks/useApplyTemplate.ts:31
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing apply template.
- score: 1
hook useApprovalChainTemplate
- file: src/platform/templates/hooks/useApprovalChainTemplate.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches a single approval chain template by its ID. Queries the Supabase table for the template with the given .
- params:
- templateId — The UUID of the approval chain template to fetch
- returns: UseQueryResultApprovalChainTemplate, Error containing the fetched template or if not found
- example: | const data, error, isLoading = useApprovalChainTemplate(‘uuid-here’);
- score: 4
hook useApprovalChainTemplateMutation
- file: src/platform/templates/hooks/useApprovalChainTemplateMutation.ts:53
- kind: hook
- core: platform
- spec: (none)
- summary: Provides mutation hooks for creating, updating, deleting, and setting the default approval chain templates scoped to the current organization and user. Returns React Query mutation objects for managing approval chain templates. Each mutation is scoped to the current organization and includes success/error toasts and invalidation of the templates query key.
- returns: An object containing: - : Mutation for inserting a new approval chain template (accepts ). - : Mutation for updating an existing approval chain template (accepts ). - : Mutation for deleting an unused, non-system approval chain template (accepts ). - : Mutation for setting a template as the default for a category (accepts ). - : that is when any of the above mutations are in flight.
- example: | const create, update, remove, setDefault = useApprovalChainTemplateMutation();
- score: 4
hook useApprovalChainTemplates
- file: src/platform/templates/hooks/useApprovalChainTemplate.ts:116
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches approval chain templates for an organization with optional filters and ordering.Prefers organization-specific templates and can optionally include system templates. Supports filtering by category, default status, and text search, and accepts an explicit organizationId to override the current organization context. Fetch approval chain templates for an organization with optional filters.
- params:
- filters — Partial filter set: - organizationId: explicit organization id to query (overrides current organization) - includeSystem: when true, include system templates alongside organization templates - category: filter templates by category - isDefault: filter templates by default flag - search: case-insensitive substring match against template name
- returns: The React Query result containing when available.
- example: | const data: templates = useApprovalChainTemplates( category: ‘policy’, includeSystem: true,);
- score: 4
hook useApprovalInbox
- file: src/platform/approvals/hooks/useApprovalInbox.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing approval inbox (org-scoped pending assignments).
- score: 1
hook useApprovalNotifications
- file: src/platform/documents/hooks/useApprovalNotifications.ts:45
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing approval notifications.
- score: 1
hook useApprovalWorkflow
- file: src/platform/documents/hooks/useApprovalWorkflow.ts:34
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing approval workflow.
- score: 1
hook useApproveAiSkill
- file: src/platform/ai/hooks/useAiSkillLifecycle.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Approve an in_review skill (gates on pf.ai_skills.approve; approver ≠ submitter for regulated).
- score: 4
hook useAppVersion
- file: src/platform/pwa/hooks/useAppVersion.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing app version.
- score: 1
hook useArchiveServiceAccount
- file: src/platform/api-access/hooks/useServiceAccountMutations.ts:107
- kind: hook
- core: platform
- spec: (none)
- summary: Soft-deletes a service account by setting deleted_at.
- score: 4
hook useAssignableRoles
- file: src/platform/users/useAssignableRoles.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: PF-02 Phase B: server-side role catalog.Reads the assignable roles from so platform admins cancurate which system roles tenants may invite users into. Falls back to thestatic list if the table is unreachable so theInvite/Add-Existing dialogs never render an empty role dropdown.
- score: 4
hook useAssignJurisdictionProfile
- file: src/platform/jurisdiction/hooks/useJurisdictionConfigMutation.ts:28
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation to assign a jurisdiction profile to the current org (upsert).
- score: 4
hook useAssignRole
- file: src/platform/permissions/hooks/useRoleAssignments.ts:65
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to assign a role to a user
- score: 4
hook useAssistantThreads
- file: src/platform/ai/hooks/useAssistantThreads.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Query the current user’s assistant conversations from where the is and the user is a member.
- returns: an object with (the Conversation list) and .
- score: 4
hook useAsyncValidation
- file: src/platform/wizards/hooks/useAsyncValidation.ts:36
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing async validation.
- score: 1
hook useAuditLogsList
- file: src/platform/audit/useAuditLogsList.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches paginated audit logs with optional filters.Automatically scoped to the current user’s organization.
- score: 4
hook useAuthorSkillSubmit
- file: src/platform/ai/wizards/ai-skill-creation/hooks/useAuthorSkillSubmit.ts:52
- kind: hook
- core: platform
- spec: (none)
- summary: Create the authored skill and route it through the PF-120 lifecycle in one call.
- returns: plus a combined flag.
- score: 4
hook useAutoJoinChannels
- file: src/platform/messaging/hooks/useAutoJoinChannels.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Checks if user is a member of default channels, auto-joins if not.
- score: 4
hook useAutoRecording
- file: src/platform/analytics/useSessionRecorder.tsx:313
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to automatically record a page/form sessionStarts recording on mount and stops on unmount.
- params:
- options — Recording options
- returns: Recording state and controls
- score: 4
hook useAutoSaveColumnSizes
- file: src/platform/table-v2/features/ColumnResizing.tsx:134
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to auto-save column sizes on change.
- params:
- table — TanStack table instance
- tableId — Unique table ID for storage key
- debounceMs — Debounce delay in milliseconds (default: 500)
- score: 4
hook useAvailableChannels
- file: src/platform/integrations/hooks/useTeamsConfig.ts:211
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch available channels for a specific Team
- score: 4
hook useAvailableFields
- file: src/platform/page-layouts/hooks/useAvailableFields.ts:48
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch available fields for assignment.Combines PF-17 standard fields with PF-16 custom field definitions,then filters out already-assigned fields.
- example: | const availableFields, isLoading = useAvailableFields( objectName: ‘hr_employees’, assignedFieldNames: [‘first_name’, ‘last_name’],);
- score: 4
hook useAvailableGroups
- file: src/platform/integrations/hooks/useSharePointConfig.ts:211
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch available groups for a specific SharePoint site
- score: 4
hook useAvailableRoles
- file: src/platform/data-manager/hooks/useAvailableRoles.ts:94
- kind: hook
- core: platform
- spec: (none)
- summary: Provide available roles (system and future custom) for object permissions configuration. Fetches system roles from the built-in role set and queries organization-scoped custom roles (prepared for future support). Returns a memoized, ordered list of available role entries and related metadata; when custom roles are not yet supported by object permissions they are fetched but not included in the returned roles list.
- returns: An object with: - : an ordered array of AvailableRole entries to use for permissions UI (currently populated with system roles). - : the raw SYSTEM_ROLES array. - : the fetched custom roles for the current organization (may be empty). - : while custom roles are being fetched, otherwise.
- score: 4
hook useAvailableSites
- file: src/platform/integrations/hooks/useSharePointConfig.ts:184
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch available SharePoint sites from Microsoft Graph
- score: 4
hook useAvailableTeams
- file: src/platform/integrations/hooks/useTeamsConfig.ts:184
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch available Teams from Microsoft Graph
- score: 4
hook useBackgroundSync
- file: src/platform/pwa/hooks/useBackgroundSync.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing background sync.
- score: 1
hook useBillingAdapter
- file: src/platform/clinical/billing/useBillingAdapter.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Reactive billing adapter that returns a CPT suggestion for the given input.Re-computes when input changes. Also exposes an imperative getSuggestion function.
- params:
- input — Optional billing input for reactive suggestion
- returns: suggestion and imperative getSuggestion function
- score: 4
hook useBillingOverrides
- file: src/platform/clinical/billing/useBillingOverrides.ts:70
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches active billing override rules for an organization, optionally filtered by payer.
- params:
- orgId — Organization ID
- payerId — Optional payer ID to filter rules
- returns: Query result with BillingOverrideConfig
- score: 4
hook useBillingRules
- file: src/platform/jurisdiction/useJurisdictionProfile.ts:107
- kind: hook
- core: platform
- spec: (none)
- summary: Convenience hook for billing rules from the resolved jurisdiction profile (PF-96).Returns the slice (timed-code thresholds, modifier conventions,filing deadlines, unit calculation rules, etc.) for the active organization,optionally narrowed to a specific site. Resolution follows the standardPF-96 hierarchy: Federal Baseline → State Profile → Org Overrides → Site Overrides.Jurisdiction-neutral by design: callers MUST NOT assume Arizona/AHCCCSsemantics. AHCCCS is only the default profile bundled with PF-96 and may bereplaced by any other state Medicaid program (or a non-Medicaid baseline).Fail-safe behavior:- While is true, or when is (no organization in context, RPC returned no profile, or resolution failed), consumers MUST degrade safely — typically by disabling auto-calculation, hiding billing suggestions, or falling back to manual entry. Do NOT silently substitute AHCCCS defaults at the call site; the absence of rules is itself a signal.- The underlying query throws on RPC error (surfaced via ); callers should sanitize before display via .
- params:
- siteId — Optional site UUID for site-level override resolution.
- returns: Query result whose is the resolved , or when no profile is available (treat as fail-closed for billing math).
- see:
- useJurisdictionProfile
- specs/pf/specs/PF-96-medicaid-state-compliance-configuration.md
- score: 4
hook useBillingWithOverrides
- file: src/platform/clinical/billing/useBillingWithOverrides.ts:31
- kind: hook
- core: platform
- spec: (none)
- summary: Returns a billing suggestion with payer-specific overrides applied.
- params:
- input — Billing input for base CPT suggestion
- orgId — Organization ID for override lookup
- payerId — Optional payer ID for payer-specific rules
- score: 4
hook useBranchConditions
- file: src/platform/wizards/hooks/useBranchConditions.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing branch conditions.
- score: 1
hook useBreadcrumbContext
- file: src/platform/navigation/useBreadcrumbContext.ts:7
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing breadcrumb context.
- score: 1
hook useBreadcrumbLabel
- file: src/platform/navigation/useBreadcrumbLabel.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Sets a custom breadcrumb label for the current route path
- params:
- label — The label to display in the breadcrumb (e.g., entity name)
- score: 4
hook useBulkGenerate
- file: src/platform/templates/hooks/useBulkGenerate.ts:74
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for generating multiple PDFs in batch. Provides functions to generate multiple documents with progresstracking, error handling, and concurrency control.
- example: | const generateBulk, isGenerating, progress, results = useBulkGenerate( onComplete: (results) = console.log(‘All done!’, results),);const handleBulk = async () = await generateBulk( items, (item) = ( content: title: item.data.name, sections: [ name: ‘Details’, content: item.data.details ], , ) );;
- score: 1
hook useBulkKnowledgeOperations
- file: src/platform/knowledge/hooks/use-knowledge-articles.ts:551
- kind: hook
- core: platform
- spec: (none)
- summary: Provides a React Query mutation for performing bulk operations on knowledge articles (publish, archive, delete, add_tags).
- returns: The configured mutation object. Call or with an object: . The mutation resolves to a of shape .
- example: | // Using the hookconst bulkMutation = useBulkKnowledgeOperations();// Trigger a publish operationbulkMutation.mutate( ids: [‘id1’, ‘id2’], operation: ‘publish’ );// Awaitable usageawait bulkMutation.mutateAsync( ids: [‘id1’], operation: ‘add_tags’, tags: [‘faq’] );
- score: 4
hook useBulkOperationProgress
- file: src/platform/bulk-operations/hooks/useBulkOperationProgress.ts:12
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing bulk operation progress.
- score: 1
hook useBulkOperationsList
- file: src/platform/bulk-operations/hooks/useBulkOperationsList.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing bulk operations list.
- score: 1
hook useBulkSyncLeaveRequests
- file: src/platform/integrations/hooks/useCalendarSyncConfig.ts:213
- kind: hook
- core: platform
- spec: (none)
- summary: Trigger bulk sync of all pending leave requests
- score: 4
hook useBulkTaskMutation
- file: src/platform/tasks/hooks/useBulkTaskMutation.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing bulk task mutation.
- score: 1
hook useBundleInstalls
- file: src/platform/ai/hooks/useBundleInstalls.ts:46
- kind: hook
- core: platform
- spec: (none)
- summary: Query hook that returns all pf_bundle_installs rows for the given org,newest first. PF-62-EN-02 AC-2
- params:
- orgId — The organization UUID; query is disabled when undefined.
- returns: data, isLoading, isSuccess, isError, error, fetchStatus, refetch
- score: 4
hook useBundleMarketplace
- file: src/platform/ai/hooks/useBundleMarketplace.ts:50
- kind: hook
- core: platform
- spec: (none)
- summary: Query hook to list all marketplace bundles discoverable to the given org. PF-62-EN-02 AC-2
- params:
- orgId — The organization UUID; query is disabled when undefined.
- returns: data, isLoading, isSuccess, isError, error, fetchStatus, refetch
- score: 4
hook useBusinessCalendar
- file: src/platform/calendar/hooks/use-business-calendar.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches a single business calendar by its ID.
- params:
- calendarId — UUID of the calendar to fetch.
- returns: Query result with .
- score: 4
hook useBusinessCalendars
- file: src/platform/calendar/hooks/use-business-calendars.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches all business calendars for the user’s organization.
- params:
- organizationId — Override org ID; defaults to current user’s org.
- returns: Query result with .
- score: 4
hook useBusinessDays
- file: src/platform/calendar/hooks/use-business-days.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Returns business day utility functions bound to a specific calendar.
- params:
- calendarId — UUID of the business calendar to use.
- returns: Object with (BusinessDayUtils), , and .
- score: 4
hook useBusinessProcess
- file: src/platform/automation/hooks/useBusinessProcess.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches a single business process by ID.
- params:
- processId — UUID of the business process.
- returns: TanStack Query result containing a single .
- score: 4
hook useBusinessProcesses
- file: src/platform/automation/hooks/useBusinessProcesses.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the list of business processes for the current organization.
- params:
- filters — Optional filters for the process list.
- returns: TanStack Query result containing .
- score: 4
hook useByodColumnMapping
- file: src/platform/analytics/hooks/useByodUpload.ts:139
- kind: hook
- core: platform
- spec: (none)
- summary: PATCH each column’s + , then call action:‘register’ to build theper-dataset VIEW and register mart + semantic models.
- score: 4
hook useByodDatasetColumns
- file: src/platform/analytics/hooks/useByodDatasets.ts:90
- kind: hook
- core: platform
- spec: (none)
- summary: List all columns for a given dataset (shown in the mapping wizard).
- score: 4
hook useByodDatasets
- file: src/platform/analytics/hooks/useByodDatasets.ts:68
- kind: hook
- core: platform
- spec: (none)
- summary: List all BYOD datasets for the current org (RLS-gated).
- score: 4
hook useByodUpload
- file: src/platform/analytics/hooks/useByodUpload.ts:53
- kind: hook
- core: platform
- spec: (none)
- summary: Upload a file to the private analytics-byod bucket and trigger the ingest edge function.Returns datasetId, rowCount, and columns on success — callers use this to open the mapping wizard.
- score: 4
hook useCalendarSyncConfig
- file: src/platform/integrations/hooks/useCalendarSyncConfig.ts:41
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch calendar sync configuration for organization
- score: 4
hook useCalendarSyncConfigMutation
- file: src/platform/integrations/hooks/useCalendarSyncConfig.ts:68
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook for updating calendar sync configuration
- score: 4
hook useCalendarSyncStats
- file: src/platform/integrations/hooks/useCalendarSyncConfig.ts:130
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch calendar sync statistics
- score: 4
hook useCallDisposition
- file: src/platform/telephony/hooks/useCallDisposition.ts:48
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that provides mutations and state for updating a call’s disposition and optionally creating/ linking a follow-up PF-29 task.
- params:
- options — Configuration for the hook - organizationId: Identifier of the organization the call belongs to - onSuccess: Optional callback invoked with the updated after a successful disposition save - onError: Optional callback invoked with an when the disposition mutation fails
- returns: An object exposing: - — mutation trigger function accepting a - — promise-based mutation trigger - — boolean flag for mutation pending state - — boolean flag for mutation error state - — error object when mutation failed
- example: | const disposition, isDispositionPending = useCallDisposition( organizationId: ‘org_123’, onSuccess: (call) = console.log(‘Saved’, call.id), onError: (err) = console.error(err),);disposition( callId: ‘call_456’, disposition: ‘no_answer’, notes: ‘Left voicemail’, followUp: required: true, createTask: true, date: ‘2026-02-01’, taskTitle: ‘Follow up’ );
- score: 4
hook useCallLog
- file: src/platform/telephony/hooks/useCallLog.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing call log.
- score: 1
hook useCategoryMutation
- file: src/platform/data-manager/hooks/useCategoryMutation.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing category mutation.
- score: 1
hook useCensusData
- file: src/platform/census/useCensusData.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing census data.
- score: 1
hook useChangeImpact
- file: src/platform/org-data-sync/hooks/useChangeImpact.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing change impact.
- score: 1
hook useChannels
- file: src/platform/messaging/hooks/useChannels.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing channels.
- score: 1
hook useChartIdForPatient
- file: src/platform/clinical/telehealth/useChartIdForPatient.ts:26
- kind: hook
- core: platform
- spec: CL-24
- summary: Returns the active for a PM patient, or ifno chart exists yet. Cached per (orgId, pmPatientId).
- params:
- pmPatientId — of the patient.
- score: 5
hook useChatbotConfig
- file: src/platform/chatbot/hooks/useChatbotConfig.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the chatbot configuration for the current organization.
- score: 4
hook useChatbotSessionMessages
- file: src/platform/chatbot/hooks/useChatbotSessions.ts:57
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches messages for a specific chatbot session.
- score: 4
hook useChatbotSessions
- file: src/platform/chatbot/hooks/useChatbotSessions.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches chatbot sessions for the current organization.
- score: 4
hook useCheckFieldPermissions
- file: src/platform/data-manager/hooks/useCheckPermission.ts:81
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing check field permissions.
- score: 1
hook useChecklistItems
- file: src/platform/tasks/hooks/useChecklistItems.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for listing checklist items belonging to a task.
- score: 1
hook useChecklistMutation
- file: src/platform/tasks/hooks/useChecklistMutation.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Hook returning add / update / toggle / remove mutations for checklist items.
- score: 4
hook useCheckPermission
- file: src/platform/data-manager/hooks/useCheckPermission.ts:27
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing check permission.
- score: 1
hook useCheckSudConsent
- file: src/platform/compliance/hooks/useConsentEnforcement.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Check SUD consent status for a chart via server-side RPC.Fail-closed: returns false when loading or on error.
- score: 4
hook useChildOrganizations
- file: src/platform/templates/hooks/useTemplateSharing.ts:199
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing child organizations.
- score: 1
hook useClearSelection
- file: src/platform/table-v2/features/RowSelection.tsx:181
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to clear all selections.
- params:
- table — TanStack table instance
- returns: Function to clear all selections
- score: 1
hook useClickToCall
- file: src/platform/telephony/hooks/useClickToCall.ts:42
- kind: hook
- core: platform
- spec: (none)
- summary: Initiates a RingCentral RingOut click-to-call flow and exposes initiation state, the latest RingOut ID, and any error encountered.Validates that an organization context is present, invokes the RingOut edge function to ring the user and connect to the target, and surfaces user-facing toasts and callbacks for success or failure. Calls to receive the RingOut ID when available; receives the Error encountered.
- params:
- options — Configuration for the hook - organizationId: The current organization identifier; required to initiate calls - onSuccess: Optional callback invoked with the RingOut ID when a call is successfully initiated - onError: Optional callback invoked with an Error when call initiation fails
- returns: An object with:- — function to start a click-to-call with - — boolean that is while initiation is in progress- — the most recent RingOut ID or if none- — the last Error encountered or
- score: 4
hook useClinicalBedBoard
- file: src/platform/integrations/clinical-bed-board/hooks.ts:60
- kind: hook
- core: platform
- spec: (none)
- summary: Primary board hook. Returns RH-backed rows with CL/PM overlays.Elevated PHI fields require and aresurfaced as ; pass the detailed row genericwhen the caller has that permission.
- score: 4
hook useClinicalMeasureAggregates
- file: src/platform/clinical/measures/useClinicalMeasureAggregates.ts:133
- kind: hook
- core: platform
- spec: (none)
- summary: Hook wrapper for grant-reporting surfaces (GR-28-EN-01). Resolves the currentorg internally and surfaces only de-identified counts.
- score: 4
hook useClinicalNotify
- file: src/platform/clinical/notifications/useClinicalNotify.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: CL-56: Publish a clinical signal to the centralized notification service.
- score: 4
hook useClinicalRules
- file: src/platform/jurisdiction/useJurisdictionProfile.ts:64
- kind: hook
- core: platform
- spec: (none)
- summary: Convenience hook for clinical rules from the resolved jurisdiction profile.
- params:
- siteId — Optional site UUID.
- returns: Query result containing .
- score: 4
hook useCodeCrossMapping
- file: src/platform/terminology/hooks/useCodeCrossMapping.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches cross-code-set mappings for a specific source code.Results ordered by priority (ascending, nulls last).
- score: 4
hook useCodeFavorites
- file: src/platform/codes/useCodeFavorites.ts:27
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing code favorites.
- score: 1
hook useCodeRecent
- file: src/platform/codes/useCodeRecent.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing code recent.
- score: 1
hook useCodeSearch
- file: src/platform/codes/useCodeSearch.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing code search.
- score: 1
hook useCodeSetVersions
- file: src/platform/terminology/hooks/useCodeSetVersions.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches code set versions from pf_code_set_versions.
- score: 4
hook useCollapsedSections
- file: src/platform/navigation/hooks/useCollapsedSections.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing collapsed sections.
- score: 1
hook useColumnPinning
- file: src/platform/table-v2/hooks/useColumnPinning.ts:93
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing column pinning in TanStack Table with persistence
- score: 1
hook useColumnSizePersistence
- file: src/platform/table-v2/features/ColumnResizing.tsx:86
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to persist column sizes to localStorage.
- params:
- table — TanStack table instance
- tableId — Unique table ID for storage key
- returns: Functions to save and reset column sizes
- score: 4
hook useColumnVisibilityPersistence
- file: src/platform/table-v2/features/ColumnVisibility.tsx:200
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to persist column visibility to localStorage.
- params:
- table — TanStack table instance
- tableId — Unique table ID for storage key
- returns: Functions to save and reset visibility
- score: 4
hook useCompareWizardVersions
- file: src/platform/wizards/hooks/useWizardVersionMutation.ts:114
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for comparing two versions (utility for diff generation)Refactored from useMutation to useQuery for proper caching
- score: 1
hook useComplianceContrastValidator
- file: src/platform/compliance/hooks/useComplianceContrastValidator.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Validate a compliance theme’s color pairs against WCAG AA thresholds.Returns a corrected theme where failing pairs fall back to platform defaults.
- score: 4
hook useComplianceDashboard
- file: src/platform/compliance/hooks/useComplianceDashboard.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches compliance dashboard summary for the given organization.
- params:
- organizationId — The organization to fetch checks for.
- score: 4
hook useComplianceEvidenceJobs
- file: src/platform/compliance/hooks/useComplianceEvidence.ts:12
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches evidence jobs for the given organization.Polls every 5s while any job has ‘generating’ status.
- score: 4
hook useComplianceRules
- file: src/platform/jurisdiction/useJurisdictionProfile.ts:122
- kind: hook
- core: platform
- spec: (none)
- summary: Convenience hook for compliance rules from the resolved jurisdiction profile.
- params:
- siteId — Optional site UUID.
- returns: Query result containing .
- score: 4
hook useComplianceTheme
- file: src/platform/compliance/hooks/useComplianceTheme.ts:58
- kind: hook
- core: platform
- spec: (none)
- summary: Resolve the compliance theme for the current organization.- Non-blocking: returns platform defaults while loading (no skeleton dependency).- Applies WCAG AA contrast validation; sets when colors adjusted.
- score: 4
hook useConditionalFieldState
- file: src/platform/conditional-logic/hooks/useConditionalFieldState.ts:50
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that returns all conditional states for a single fieldMerges base field states with conditional evaluation results
- params:
- fieldKey — The field key (for debugging)
- conditionalRules — V1 or V2 conditional rules
- formValues — Current form field values
- options — Configuration options
- returns: ConditionalFieldState - Complete field state
- score: 4
hook useConditionalFieldStates
- file: src/platform/conditional-logic/hooks/useConditionalFieldState.ts:87
- kind: hook
- core: platform
- spec: (none)
- summary: Batch hook that returns conditional states for multiple fieldsMore efficient than calling useConditionalFieldState multiple times
- score: 4
hook useConditionalLogic
- file: src/platform/conditional-logic/hooks/useConditionalLogic.ts:68
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for evaluating conditional field logic
- params:
- fieldConfigs — Array of field configurations with conditional_rules
- formValues — Current form field values
- options — Optional configuration
- returns: Object with evaluation functions and memoized results
- score: 1
hook useConditionalPages
- file: src/platform/forms/hooks/useConditionalPages.ts:69
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing conditional pages.
- score: 1
hook useConditionalRule
- file: src/platform/conditional-logic/hooks/useConditionalLogic.ts:155
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for evaluating a single conditional ruleUseful when you have a rule outside of the field config context
- params:
- rule — The conditional rule to evaluate
- formValues — Current form field values
- returns: ConditionalRuleResult - visibility, required, readonly status
- score: 1
hook useConditionalVisibility
- file: src/platform/field-config/hooks/useConditionalVisibility.ts:10
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing conditional visibility.
- score: 1
hook useConditionBuilder
- file: src/platform/conditional-logic/hooks/useConditionBuilder.ts:293
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing condition builder state
- score: 1
hook useConditionEvaluation
- file: src/platform/conditional-logic/hooks/useConditionEvaluation.ts:83
- kind: hook
- core: platform
- spec: (none)
- summary: Hybrid condition evaluation hook.Evaluates conditional rules client-side for simple formsand server-side for complex forms (above the complexity threshold).Falls back to client-side on any server error.
- params:
- options — Evaluation options
- returns: Evaluation results, method, loading, and error state
- score: 4
hook useConditionPerformance
- file: src/platform/conditional-logic/hooks/useConditionPerformance.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch and aggregate condition evaluation performance metrics.Queries the pf_condition_evaluation_metrics table, computes percentiles,cache hit rate, and method distribution for the dashboard.
- params:
- options — Query options (orgId, formId, time range)
- returns: Aggregated metrics, trends, loading, and error state
- score: 4
hook useConfirmSkills
- file: src/platform/ai/hooks/useRecommendedSkills.ts:165
- kind: hook
- core: platform
- spec: (none)
- summary: Upserts per-org enablement overrides for the explicitly confirmed skills.The enablement-row shape is derived by the pure (one source of truth, unit-tested): only codes in BOTH the recommended andconfirmed sets yield an row; zero confirmed ⇒ zero rows; NOper-module default-skill key and NO org-profile text is ever written (AC-5/AC-6/AC-7).
- returns: and . May be called with no confirmed codes (records the explicit “enable nothing” choice).
- score: 4
hook useConnectionStatus
- file: src/platform/realtime/hooks/useConnectionStatus.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing connection status.
- score: 1
hook useConsentCheck
- file: src/platform/clinical/consent/useConsentCheck.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing consent check.
- score: 1
hook useConsentStatusSummary
- file: src/platform/compliance/hooks/useConsentEnforcement.ts:58
- kind: hook
- core: platform
- spec: (none)
- summary: Aggregate consent status for the compliance dashboard widget.Queries cl_consents (read-only) for org-level stats.
- score: 4
hook useContextAwareActions
- file: src/platform/navigation/hooks/useContextAwareActions.ts:32
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that returns context-aware quick actions based on pending items
- score: 4
hook useContextualAction
- file: src/platform/navigation/hooks/useContextualAction.ts:35
- kind: hook
- core: platform
- spec: (none)
- summary: Returns the primary action based on current module context.Used for the elevated center button in mobile nav and header primary button.
- score: 4
hook useContextualQuickActions
- file: src/platform/navigation/hooks/useContextualQuickActions.ts:274
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that returns context-aware quick actions based on current module
- score: 4
hook useContextualSidebar
- file: src/platform/navigation/contextual-sidebar.tsx:41
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to register contextual sidebar content. Automatically clears on unmount.
- score: 4
hook useContextualSidebarContent
- file: src/platform/navigation/contextual-sidebar.tsx:56
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to read the current contextual sidebar content.
- score: 4
hook useControlledPagination
- file: src/platform/table-v2/utils/pagination/hooks.ts:234
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for controlled pagination (parent manages state)Use this when pagination state needs to be managed externally,such as with URL query parameters or form state.
- params:
- options — Controlled pagination options
- returns: Pagination state and handlers
- score: 1
hook useConversationMembers
- file: src/platform/messaging/hooks/useConversationMembers.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing conversation members.
- score: 1
hook useConversations
- file: src/platform/messaging/hooks/useConversations.ts:31
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing conversations.
- score: 1
hook useConversationSenderMap
- file: src/platform/messaging/hooks/useConversationSenderMap.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches all member profiles for a conversation, returning a map of userId → SenderInfo.
- score: 4
hook useConversationSummarization
- file: src/platform/messaging/hooks/useConversationSummarization.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing conversation summarization.
- score: 1
hook useConversionMetrics
- file: src/platform/ce/useLeadConversionHistory.ts:82
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches aggregated conversion metrics for the organization.Used by PM-41 funnel dashboards via platform integration layer.
- score: 4
hook useConvertLeadFromPM
- file: src/platform/ce/useConvertLeadFromPM.ts:30
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook for converting a CE lead to a patient from the PM side.Mirrors the CE-29 conversion pipeline: updates lead status, inserts auditrecord, publishes event, and invokes event-consumer edge function.
- score: 4
hook useCoreRailOrder
- file: src/platform/navigation/hooks/useCoreRailOrder.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to manage per-user core-rail pin + order with safe merge pattern.Reads from and writes to pf_profiles.preferences.coreRailOrder.Sibling preference keys (e.g. pinnedItems) are never clobbered.
- score: 4
hook useCoworkAgents
- file: src/platform/cowork/useThreads.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: List the org’s agents (all statuses). Used by ParticipantsPane to build theadd-agent affordance and resolve participating agent names from their IDs.
- score: 4
hook useCoworkPresence
- file: src/platform/cowork/useCoworkPresence.ts:48
- kind: hook
- core: platform
- spec: (none)
- summary: useCoworkPresence — presence + live-thread subscription for the Cowork workspace.
- params:
- threadId — The pf_threads.id to subscribe to, or null/undefined when no thread is selected. All subscriptions are disabled when threadId is falsy.
- score: 4
hook useCreateAISkill
- file: src/platform/ai/hooks/useCreateAISkill.ts:43
- kind: hook
- core: platform
- spec: (none)
- summary: Create a mutation hook to create a new AI skill within the current organization.Provides an async function that inserts a new AI skill record into the backend,returns the mutation state, and exposes the last .The created record will include sensible defaults for model preference, temperature, max tokens,RAG settings, and output format when those fields are not provided.
- returns: An object containing: - — async function accepting a and returning the created - — boolean flag indicating an in-progress creation - — the last error encountered or
- example: | const createSkill, isCreating, error = useCreateAISkill();await createSkill( skill_code: ‘summarize’, name: ‘Summarizer’, description: ‘Summarize text’ );
- score: 4
hook useCreateApiKey
- file: src/platform/api-access/hooks/useApiKeyMutations.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Creates a new API key for a service account.Returns the raw secret (shown once) along with key metadata.
- score: 4
hook useCreateByodDataset
- file: src/platform/analytics/hooks/useByodDatasets.ts:109
- kind: hook
- core: platform
- spec: (none)
- summary: Create a skeleton dataset row (status=‘uploaded’, no storage_path yet).
- score: 4
hook useCreateCall
- file: src/platform/telephony/hooks/useCreateCall.ts:36
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing create call.
- score: 1
hook useCreateConversation
- file: src/platform/messaging/hooks/useCreateConversation.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing create conversation.
- score: 1
hook useCreateDiagramVersion
- file: src/platform/workflow/useCreateDiagramVersion.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Creates a new version snapshot row for a swim lane diagram.Automatically determines the next version number with retry on conflict.
- score: 4
hook useCreateEmailSignature
- file: src/platform/email-signatures/hooks/useEmailSignatureMutation.ts:12
- kind: hook
- core: platform
- spec: (none)
- summary: Create a new email signature.
- score: 1
hook useCreateExportRequest
- file: src/platform/export/hooks/useExportRequests.ts:48
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing create export request.
- score: 1
hook useCreateExportTemplate
- file: src/platform/export/hooks/useExportTemplates.ts:50
- kind: hook
- core: platform
- spec: (none)
- summary: Provides create export template queries and mutation actions scoped to the current organization.
- score: 4
hook useCreateHeadshotCampaign
- file: src/platform/headshot/hooks/useHeadshotCampaigns.ts:80
- kind: hook
- core: platform
- spec: (none)
- summary: Creates a new headshot campaign.
- score: 4
hook useCreateHeadshotJob
- file: src/platform/headshot/hooks/useCreateHeadshotJob.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Creates a new headshot job in draft status.
- score: 4
hook useCreateImportBatch
- file: src/platform/import/hooks/useImportBatches.ts:64
- kind: hook
- core: platform
- spec: (none)
- summary: Create a new import batch.
- score: 1
hook useCreateImportRecords
- file: src/platform/import/hooks/useImportRecords.ts:51
- kind: hook
- core: platform
- spec: (none)
- summary: Bulk-insert import records for a batch.
- score: 4
hook useCreateKnowledgeArticle
- file: src/platform/knowledge/hooks/use-knowledge-articles.ts:259
- kind: hook
- core: platform
- spec: (none)
- summary: Creates a new knowledge base article for the current organization.Provides a React Query mutation that inserts an article into the table, invalidates article list caches on success, and shows success/error toasts.
- returns: A React Query mutation object that accepts a and resolves to the created .
- example: | const createArticle = useCreateKnowledgeArticle();await createArticle.mutateAsync( title: ‘How to use the API’, content: ’…’, summary: ‘Quick guide’, category: ‘docs’, tags: [‘api’, ‘guide’],);
- score: 4
hook useCreateLayoutFromTemplate
- file: src/platform/page-layouts/hooks/useCreateLayoutFromTemplate.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing create layout from template.
- score: 1
hook useCreateLayoutVersion
- file: src/platform/page-layouts/hooks/useLayoutVersions.ts:64
- kind: hook
- core: platform
- spec: (none)
- summary: Create a new version snapshot for a layout and prune to last 50.
- score: 4
hook useCreateLegalHold
- file: src/platform/data-retention/hooks/useLegalHolds.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing create legal hold.
- score: 1
hook useCreateMappingTemplate
- file: src/platform/import/hooks/useImportMappingTemplates.ts:46
- kind: hook
- core: platform
- spec: (none)
- summary: Create a new mapping template.
- score: 4
hook useCreateOnboardingSession
- file: src/platform/import/hooks/useOnboardingSessions.ts:63
- kind: hook
- core: platform
- spec: (none)
- summary: Create a new onboarding session.
- score: 4
hook useCreateProvisioningRequest
- file: src/platform/provisioning/hooks/useCreateProvisioningRequest.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing create provisioning request.
- score: 1
hook useCreateQuota
- file: src/platform/quota/hooks/useQuotaMutation.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Create a new resource quota configuration.
- params:
- organizationId — Current org context (for cache invalidation).
- score: 4
hook useCreateReport
- file: src/platform/reports/useReportMutation.ts:35
- kind: hook
- core: platform
- spec: (none)
- summary: Creates a React Query mutation hook to insert a new report into the table.The mutation adds from the current user and returns the inserted row.
- returns: A mutation object configured to insert a report; the mutation function accepts a report object without and resolves to the inserted report row.
- score: 4
hook useCreateRetentionPolicy
- file: src/platform/data-retention/hooks/useRetentionPolicies.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing create retention policy.
- score: 1
hook useCreateRole
- file: src/platform/permissions/hooks/useCustomRoles.ts:63
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to create a new custom role
- score: 4
hook useCreateSecurityAlertConfig
- file: src/platform/security/hooks/useSecurityAlertConfigMutation.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing create security alert config.
- score: 1
hook useCreateServiceAccount
- file: src/platform/api-access/hooks/useServiceAccountMutations.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Creates a new service account for the current organization.
- score: 4
hook useCreateSharePointFolder
- file: src/platform/integrations/hooks/useSharePointDocuments.ts:105
- kind: hook
- core: platform
- spec: (none)
- summary: Provides create share point folder queries and mutation actions scoped to the current organization.
- score: 4
hook useCreateSLADefinition
- file: src/platform/sla/hooks/useSLADefinitions.ts:71
- kind: hook
- core: platform
- spec: (none)
- summary: Creates a new SLA definition.
- score: 1
hook useCreateStepBatch
- file: src/platform/import/hooks/useOnboardingStepBatches.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Create a step-batch junction row.
- score: 4
hook useCreateThread
- file: src/platform/cowork/useThreads.ts:52
- kind: hook
- core: platform
- spec: (none)
- summary: Create a cowork Thread over an existing PF-67 conversation.
- score: 4
hook useCreateValidationRule
- file: src/platform/validation/hooks/useValidationRuleMutation.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Create a new validation rule.
- score: 1
hook useCreateWizardVersion
- file: src/platform/wizards/hooks/useWizardVersionMutation.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for creating a new version of a wizard template
- score: 1
hook useCreateWorkspace
- file: src/platform/navigation/workspaces/admin/useWorkspaceMutations.ts:134
- kind: hook
- core: platform
- spec: (none)
- summary: React Query mutation that inserts a new row forthe active organization, stamping org and audit columns from context. Onsuccess it invalidates the org’s workspace-definitions query and toasts;throws “No active organization” if no org is selected.
- score: 4
hook useCredentialCheck
- file: src/platform/workforce/useCredentialCheck.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for checking employee credentials
- score: 1
hook useCredentialMutation
- file: src/platform/integrations/hooks/useCredentialMutation.ts:27
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing credential mutation.
- score: 1
hook useCredentials
- file: src/platform/integrations/hooks/useCredentials.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing credentials.
- score: 1
hook useCrossFieldValidation
- file: src/platform/conditional-logic/hooks/useCrossFieldValidation.ts:51
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for cross-field validation
- score: 1
hook useCrossModuleWizard
- file: src/platform/wizards/hooks/useCrossModuleWizard.ts:65
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing cross-module wizard functionalityUses useHasPermission for batch permission checking across all modulesthe wizard spans.
- score: 1
hook useCSVImport
- file: src/platform/data-manager/hooks/useCSVImport.ts:28
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing csvimport.
- score: 1
hook useCurrentEmployeeId
- file: src/platform/workforce/getCurrentEmployeeId.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing current employee id.
- score: 1
hook useCurrentOrganizationId
- file: src/platform/cache/org-resolver.ts:9
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for use in React components only. Returns current org id or null.
- score: 1
hook useCurrentOrgSlug
- file: src/platform/organizations/hooks/useCurrentOrgSlug.ts:9
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing current org slug.
- score: 1
hook useCurrentUser
- file: src/platform/auth/useCurrentUser.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing current user.
- score: 1
hook useCurrentWizardVersion
- file: src/platform/wizards/hooks/useWizardVersions.ts:124
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to get the current published version of a template
- score: 4
hook useCustomFieldDefinition
- file: src/platform/custom-fields/hooks/useCustomFieldDefinition.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom field definition.
- score: 1
hook useCustomFieldDefinitions
- file: src/platform/custom-fields/hooks/useCustomFieldDefinitions.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom field definitions.
- score: 1
hook useCustomFieldMutation
- file: src/platform/custom-fields/hooks/useCustomFieldMutation.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom field mutation.
- score: 1
hook useCustomFieldValidation
- file: src/platform/custom-fields/hooks/useCustomFieldValidation.ts:10
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom field validation.
- score: 1
hook useCustomGesture
- file: src/platform/gestures/hooks/useCustomGesture.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom gesture.
- score: 1
hook useCustomGestureRegistry
- file: src/platform/gestures/registry/CustomGestureContext.tsx:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom gesture registry.
- score: 1
hook useCustomMetric
- file: src/platform/health/hooks/useCustomMetric.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom metric.
- score: 1
hook useCustomMetricMutation
- file: src/platform/health/hooks/useCustomMetricMutation.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom metric mutation.
- score: 1
hook useCustomMetrics
- file: src/platform/health/hooks/useCustomMetrics.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom metrics.
- score: 1
hook useCustomMetricsEnabled
- file: src/platform/health/hooks/useCustomMetricsEnabled.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom metrics enabled.
- score: 1
hook useCustomObject
- file: src/platform/data-manager/hooks/useCustomObject.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom object.
- score: 1
hook useCustomObjectFields
- file: src/platform/data-manager/hooks/useCustomObjectFields.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom object fields.
- score: 1
hook useCustomObjectMutation
- file: src/platform/data-manager/hooks/useCustomObjectMutation.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom object mutation.
- score: 1
hook useCustomObjectRecords
- file: src/platform/data-manager/hooks/useCustomObjectRecords.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom object records.
- score: 1
hook useCustomObjects
- file: src/platform/data-manager/hooks/useCustomObjects.ts:12
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom objects.
- score: 1
hook useCustomRole
- file: src/platform/permissions/hooks/useCustomRoles.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch a single custom role by ID
- score: 4
hook useCustomRoles
- file: src/platform/permissions/hooks/useCustomRoles.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch all custom roles for an organization
- score: 4
hook useCustomWidgetData
- file: src/platform/dashboard/hooks/useCustomWidgets.ts:170
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom widget data.
- score: 1
hook useCustomWidgets
- file: src/platform/dashboard/hooks/useCustomWidgets.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing custom widgets.
- score: 1
hook useDashboardPreferences
- file: src/platform/dashboard/hooks/useDashboardPreferences.ts:69
- kind: hook
- core: platform
- spec: (none)
- summary: Manages a user’s dashboard preferences for a given organization and context.
- params:
- options — Configuration options - organizationId: Organization ID used to scope fetched and mutated preferences - dashboardContext: Optional context for module-specific preferences (e.g., ‘hr’, ‘fa’)
- returns: An object with:- : the user’s DashboardPreferences or if none or not loaded- : while the initial preferences query is loading- : function to replace widget preferences- : function to update widget order based on an array of widget IDs- : function to mark a widget as hidden- : function to update a widget’s size- : function to replace quick action preferences- : while a quick-action update is pending
- score: 4
hook useDashboardShares
- file: src/platform/dashboard/hooks/useDashboardShares.ts:27
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing dashboard shares.
- score: 1
hook useDashboardTemplates
- file: src/platform/dashboard/hooks/useDashboardTemplates.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing dashboard templates.
- score: 1
hook useDashboardWidgets
- file: src/platform/dashboard/hooks/useDashboardWidgets.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Returns filtered and ordered widgets based on:1. User preferences (highest priority)2. Organization defaults (fallback)3. Widget registry defaults (final fallback)
- score: 4
hook useDatabaseHealth
- file: src/platform/health/hooks/useDatabaseHealth.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing database health.
- score: 1
hook useDataMigrationConnections
- file: src/platform/settings/pages/data-migration/hooks/useDataMigrationConnections.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing data migration connections.
- score: 1
hook useDataMigrationExplore
- file: src/platform/settings/pages/data-migration/hooks/useDataMigrationExplore.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing data migration explore.
- score: 1
hook useDataMigrationMappings
- file: src/platform/settings/pages/data-migration/hooks/useDataMigrationMappings.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing data migration mappings.
- score: 1
hook useDataMigrationRuns
- file: src/platform/settings/pages/data-migration/hooks/useDataMigrationRuns.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing data migration runs.
- score: 1
hook useDataTable
- file: src/platform/table-v2/hooks/useDataTable.ts:89
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing data table.
- score: 1
hook useDbWorkspaces
- file: src/platform/navigation/workspaces/useDbWorkspaces.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Org-scoped DB workspace rows; sort_order asc then label. The org filter isdefense-in-depth alongside RLS and keeps multi-org admins from seeing otherorgs’ rows under the current org.NOTE: always invoke as a method call. Detaching it() loses the binding — reads and throws at runtime, silentlycollapsing the workspace list to seeds only.
- score: 4
hook useDefaultApprovalChainTemplate
- file: src/platform/templates/hooks/useApprovalChainTemplate.ts:57
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the default approval chain template for a given category, preferring an organization-specific default and falling back to a system default.Attempts to return the organization’s default template for (using or the current organization), and if none exists returns the system default or .
- params:
- category — The approval category to find a default template for
- organizationId — Optional organization ID to scope the search; if omitted the current organization from context is used
- returns: A React Query result resolving to the organization’s default , the system default , or if none exists
- example: | const data = useDefaultApprovalChainTemplate(‘policy’);
- score: 4
hook useDefaultCalendar
- file: src/platform/calendar/hooks/use-default-calendar.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the default business calendar () for the organization.
- params:
- organizationId — Override org ID; defaults to current user’s org.
- returns: Query result with .
- score: 4
hook useDefaultPicklistTemplates
- file: src/platform/picklists/hooks/useDefaultPicklistTemplates.ts:115
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches platform default piclist definitions and items from the DB,groups them into PicklistTemplate objects (one per category).The system-default tables have USING(true) SELECT RLS policies so anyauthenticated user can read them — no org filter required on the definitionsthemselves, but we include orgId in the query key for cache isolation.
- score: 4
hook useDeleteAISkill
- file: src/platform/ai/hooks/useDeleteAISkill.ts:47
- kind: hook
- core: platform
- spec: (none)
- summary: Provides a hook for deleting a custom AI skill scoped to the current organization.Exposes an API to delete a non-system skill from the organization’s table.On successful deletion the query cache is invalidated and a success toast is shown.On failure an error toast is shown.The hook verifies that exactly one row was affected by the delete operation to ensurethe deletion was successful and no unexpected database state occurred.
- returns: UseDeleteAISkillReturn An object with: - - Deletes the skill with the given id for the current organization. - - True while the deletion is in progress. - - The last error encountered by the deletion mutation, if any.
- example: | const deleteSkill, isDeleting = useDeleteAISkill();try await deleteSkill(‘skill-id-123’); catch (err) // handle deletion error
- score: 4
hook useDeleteByodDataset
- file: src/platform/analytics/hooks/useByodDatasets.ts:130
- kind: hook
- core: platform
- spec: (none)
- summary: Delete a dataset row (cascade removes byod_rows and columns via FK ON DELETE CASCADE).
- score: 4
hook useDeleteConnectionMutation
- file: src/platform/settings/pages/data-migration/hooks/useDataMigrationConnections.ts:100
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing delete connection mutation.
- score: 1
hook useDeleteDashboard
- file: src/platform/analytics/hooks/useDashboards.ts:94
- kind: hook
- core: platform
- spec: (none)
- summary: Soft-delete (sets deleted_at); RLS SELECT already filters deleted_at IS NULL.
- score: 4
hook useDeletedRecords
- file: src/platform/admin/hooks/useDeletedRecords.ts:83
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing deleted records.
- score: 1
hook useDeleteEmailSignature
- file: src/platform/email-signatures/hooks/useEmailSignatureMutation.ts:56
- kind: hook
- core: platform
- spec: (none)
- summary: Delete an email signature.
- score: 1
hook useDeleteExportRequest
- file: src/platform/export/hooks/useExportRequests.ts:86
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing delete export request.
- score: 1
hook useDeleteExportTemplate
- file: src/platform/export/hooks/useExportTemplates.ts:116
- kind: hook
- core: platform
- spec: (none)
- summary: Provides delete export template queries and mutation actions scoped to the current organization.
- score: 4
hook useDeleteHeadshot
- file: src/platform/headshot/hooks/useDeleteHeadshot.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: Soft-deletes a headshot result by setting deleted_at.
- score: 4
hook useDeleteImportBatch
- file: src/platform/import-batches/hooks/useImportBatchesList.ts:43
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for deleting an import batch.
- score: 1
hook useDeleteKnowledgeArticle
- file: src/platform/knowledge/hooks/use-knowledge-articles.ts:385
- kind: hook
- core: platform
- spec: (none)
- summary: Provides a React Query mutation that deletes a knowledge article by id. Calls the Supabase backend to remove the pf_knowledge_base row with the given id, invalidates the articles list cache, removes the deleted article’s detail cache, and shows success/error toasts.
- returns: The mutation object returned by configured to accept an article when invoked.
- example: | const deleteArticle = useDeleteKnowledgeArticle();// trigger deletiondeleteArticle.mutate(‘article-id-123’);
- score: 4
hook useDeleteLegalHold
- file: src/platform/data-retention/hooks/useLegalHolds.ts:83
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing delete legal hold.
- score: 1
hook useDeleteMappingTemplate
- file: src/platform/import/hooks/useImportMappingTemplates.ts:97
- kind: hook
- core: platform
- spec: (none)
- summary: Soft-delete a mapping template (sets deleted_at).
- score: 4
hook useDeleteProvisioningRequest
- file: src/platform/provisioning/hooks/useDeleteProvisioningRequest.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing delete provisioning request.
- score: 1
hook useDeleteQuota
- file: src/platform/quota/hooks/useQuotaMutation.ts:95
- kind: hook
- core: platform
- spec: (none)
- summary: Delete a resource quota configuration.
- params:
- organizationId — Current org context (for cache invalidation and tenant isolation).
- score: 4
hook useDeleteReport
- file: src/platform/reports/useReportMutation.ts:135
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing delete report.
- score: 1
hook useDeleteReportPermission
- file: src/platform/reports/hooks/useReportPermissions.ts:100
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook for deleting a report permission.
- score: 4
hook useDeleteRetentionPolicy
- file: src/platform/data-retention/hooks/useRetentionPolicies.ts:81
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing delete retention policy.
- score: 1
hook useDeleteRole
- file: src/platform/permissions/hooks/useCustomRoles.ts:130
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to soft-delete a custom role
- score: 4
hook useDeleteRoleLicenseMapping
- file: src/platform/integrations/hooks/useEntraRoleLicenseMap.ts:120
- kind: hook
- core: platform
- spec: (none)
- summary: Remove a role → SKU mapping.
- score: 1
hook useDeleteSecurityAlertConfig
- file: src/platform/security/hooks/useSecurityAlertConfigMutation.ts:83
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing delete security alert config.
- score: 1
hook useDeleteSLADefinition
- file: src/platform/sla/hooks/useSLADefinitions.ts:123
- kind: hook
- core: platform
- spec: (none)
- summary: Soft-deletes an SLA definition by setting deleted_at.
- score: 4
hook useDeleteTheme
- file: src/platform/theming/hooks/useTenantTheme.ts:218
- kind: hook
- core: platform
- spec: (none)
- summary: Delete a theme row (admin only per RLS).
- score: 4
hook useDeleteValidationRule
- file: src/platform/validation/hooks/useValidationRuleMutation.ts:94
- kind: hook
- core: platform
- spec: (none)
- summary: Delete a validation rule.
- score: 1
hook useDeleteWorkspace
- file: src/platform/navigation/workspaces/admin/useWorkspaceMutations.ts:219
- kind: hook
- core: platform
- spec: (none)
- summary: React Query mutation that deletes a workspace by id, scoped to the activeorganization (org predicate is defense-in-depth alongside RLS). Invalidatesthe org’s workspace query on success; throws “No active organization” if noorg is selected.
- score: 4
hook useDeliveryLogs
- file: src/platform/notifications/hooks/useDeliveryLogs.ts:27
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing delivery logs.
- score: 1
hook useDepartments
- file: src/platform/workforce/useDepartments.ts:34
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for fetching department list for cross-core useReturns simplified department data suitable for dropdowns/selectors
- score: 1
hook useDeployments
- file: src/platform/health/hooks/useDeployments.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Returns the last 5 Vercel deployments, refreshed every 5 minutes.
- score: 4
hook useDevicesList
- file: src/platform/sessions/hooks/useDevicesList.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing devices list.
- score: 1
hook useDiagramBroadcast
- file: src/platform/workflow/useDiagramBroadcast.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Broadcasts and listens for diagram save/update events.
- returns: send function for broadcasting updates
- score: 4
hook useDiagramPresence
- file: src/platform/workflow/useDiagramPresence.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Tracks which users are viewing/editing a specific diagram.
- returns: Presence controls (users, track, untrack, isConnected)
- score: 4
hook useDiagramUndoRedo
- file: src/platform/workflow/useDiagramUndoRedo.ts:28
- kind: hook
- core: platform
- spec: (none)
- summary: In-memory undo/redo stack for swim lane diagram state.
- params:
- state — Current diagram state (lanes, nodes, edges)
- setState — Callback to replace diagram state on undo/redo
- maxSize — Maximum history depth (default 50)
- returns: Undo/redo callbacks and availability flags
- score: 4
hook useDirectorySyncConfig
- file: src/platform/integrations/hooks/useDirectorySyncConfig.ts:68
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch directory sync configuration from organization
- score: 4
hook useDirectorySyncConfigMutation
- file: src/platform/integrations/hooks/useDirectorySyncConfig.ts:99
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook for updating directory sync configuration
- score: 4
hook useDirectorySyncLog
- file: src/platform/integrations/hooks/useDirectorySyncConfig.ts:138
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch recent sync log entries
- score: 1
hook useDirectorySyncStats
- file: src/platform/integrations/hooks/useDirectorySyncConfig.ts:175
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch directory sync statistics
- score: 4
hook useDiscoverObjects
- file: src/platform/data-manager/hooks/useDiscoverObjects.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing discover objects.
- score: 1
hook useDismissEntraUser
- file: src/platform/integrations/hooks/useEntraUnmatchedUsers.ts:172
- kind: hook
- core: platform
- spec: (none)
- summary: Dismiss an unmatched Entra user (admin doesn’t want to link them)
- score: 4
hook useDispatchPortalRun
- file: src/platform/automation/portal/hooks.ts:151
- kind: hook
- core: platform
- spec: (none)
- summary: Dispatch a run through the platform seam (AC-2 / AC-5).
- score: 4
hook useDmParticipants
- file: src/platform/messaging/hooks/useDmParticipants.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Returns a map of DM conversationId → the other participant’s display info.Group/channel/record conversations are ignored.
- score: 4
hook useDocumentAnalytics
- file: src/platform/documents/hooks/useDocumentAnalytics.ts:52
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch aggregated document analytics for the current organization.
- returns: Analytics data gated by the permission
- score: 4
hook useDocumentApprovals
- file: src/platform/documents/hooks/useDocumentApprovals.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing document approvals.
- score: 1
hook useDocumentDetail
- file: src/platform/documents/useDocumentDetail.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing document detail.
- score: 1
hook useDocumentDownload
- file: src/platform/documents/useDocumentDownload.ts:12
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing document download.
- score: 1
hook useDocumentExport
- file: src/platform/clinical/documents/useDocumentExport.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook for initiating document exports with consent verification.
- score: 4
hook useDocumentMutation
- file: src/platform/documents/useDocumentMutation.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Provides mutations for updating, deleting, and changing the status of documents with automatic cache invalidation and user-facing toasts.
- returns: An object with mutation functions and pending-state flags:- - async function accepting to update document metadata and return the updated row.- - async function accepting a document ID string, deletes the file from storage and the document record, and returns the deleted document ID.- - async function accepting to update a document’s status (sets and when publishing) and returns the updated row.- - when an update mutation is pending, otherwise.- - when a delete mutation is pending, otherwise.- - when a status-change mutation is pending, otherwise.
- score: 4
hook useDocumentPermissions
- file: src/platform/documents/useDocumentPermissions.ts:44
- kind: hook
- core: platform
- spec: (none)
- summary: Manage and mutate permissions for a specific document.
- params:
- documentId — Optional ID of the document whose permissions are queried and modified; when omitted the query is disabled.
- returns: An object with: - : the list of permissions for the document (empty array by default), - : whether the permissions query is in progress, - : the query error if one occurred, - : function to add a permission (accepts ), - : function to remove a permission (accepts ), - : whether an add-permission mutation is pending, - : whether a remove-permission mutation is pending
- score: 4
hook useDocumentPreview
- file: src/platform/documents/useDocumentPreview.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing document preview.
- score: 1
hook useDocumentSearch
- file: src/platform/documents/useDocumentSearch.ts:28
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing document search.
- score: 1
hook useDocumentTemplate
- file: src/platform/templates/hooks/useDocumentTemplate.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches a single document template by ID or resolves the default template for a given type.If is provided, returns the matching template (including its letterhead) scoped to the organization or system. If is not provided, attempts to return the organization’s active default for , falling back to the system default. The query is disabled unless sufficient inputs are available.
- params:
- templateId — Optional template UUID to fetch. When provided, the hook returns that exact template.
- organizationId — Optional organization ID to scope the lookup. If omitted, the current organization from context is used.
- templateType — Optional template type to resolve a default for when is not provided.
- returns: The React Query result containing a when found, if no default exists, and query metadata.
- example: | // Get a specific template by IDconst data = useDocumentTemplate(‘uuid-here’); // Get the default policy template for the current organization (falls back to system default)const data = useDocumentTemplate(undefined, undefined, ‘policy’);
- score: 4
hook useDocumentTemplateMutation
- file: src/platform/templates/hooks/useDocumentTemplateMutation.ts:79
- kind: hook
- core: platform
- spec: (none)
- summary: Provides mutation hooks for creating, updating (with optional versioning), deprecating, cloning, setting default, and removing document templates for the current organization. Each returned mutation handles database operations via Supabase, shows user-facing toasts, and invalidates template/document queries on success.
- returns: An object with:- — Mutation for inserting a new document template and its initial version.- — Mutation for updating a template; can optionally create a new template version with change notes.- — Mutation for marking a template as deprecated and clearing its default flag.- — Mutation that invokes a Postgres RPC to clone a template into a target organization and returns the new template ID (accepts optional to attempt immediate activation).- — Mutation for unsetting the current default for a template type and setting the specified template as default.- — Mutation for deleting a non-system, unused template.- — Boolean that is when any of the above mutations is pending.
- example: | const create, update, deprecate, clone = useDocumentTemplateMutation();// Create with auto-versioningawait update.mutateAsync( id: ‘uuid’, data: name: ‘Updated’ , createVersion: true, changeNotes: ‘Updated name’);
- score: 4
hook useDocumentTemplates
- file: src/platform/templates/hooks/useDocumentTemplate.ts:118
- kind: hook
- core: platform
- spec: (none)
- summary: Retrieve document templates for an organization applying optional filters. Fetches document templates scoped to an organization (or system templates when requested), applying optional filters for template type, status, default flag, and name search. The query orders results by template type, default status (defaults first), then name.
- params:
- filters — Partial filters to apply. Supported properties: - organizationId?: string — overrides the current organization id - templateType?: TemplateType — filter by template type - status?: string — filter by template status - isDefault?: boolean — filter by default flag - includeSystem?: boolean — include system-wide templates in results - search?: string — case-insensitive substring match against template name
- returns: The React Query result containing an array of objects.
- example: | const data: templates = useDocumentTemplates( templateType: ‘policy’, status: ‘active’, includeSystem: true,);
- score: 4
hook useDocumentTemplateVersions
- file: src/platform/templates/hooks/useDocumentTemplate.ts:176
- kind: hook
- core: platform
- spec: (none)
- summary: Retrieve the version history for a document template. Fetches all versions for the given , ordered by descending.
- params:
- templateId — The UUID of the document template to fetch versions for
- returns: The React Query result containing an array of objects (or if none)
- example: | const data: versions = useDocumentTemplateVersions(‘template-uuid’);
- score: 4
hook useDocumentUpload
- file: src/platform/documents/useDocumentUpload.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Provides helpers to upload a document to storage and create its database record.
- returns: An object with:- : a function that accepts and uploads the file, creating and returning the created document record.- : when an upload is in progress, otherwise.- : the upload progress as a number (0-100).- : the last upload error, if any.
- score: 4
hook useDocumentVersionComparison
- file: src/platform/documents/hooks/useDocumentVersionComparison.ts:44
- kind: hook
- core: platform
- spec: (none)
- summary: Compare two document versions side-by-side.
- params:
- documentId — The parent document ID
- versionIdA — First version ID to compare
- versionIdB — Second version ID to compare
- returns: Comparison result with metadata and optional text diffs
- score: 4
hook useDocumentVersions
- file: src/platform/documents/useDocumentVersions.ts:43
- kind: hook
- core: platform
- spec: (none)
- summary: Manage and mutate versions for a document identified by .
- returns: An object with the following properties:- : Array of document version records for the document.- : while versions are being fetched, otherwise .- : The fetch error object, if any occurred.- : Function to create a new document version (accepts ).- : while a version creation is pending, otherwise .- : Function to rollback the document to a specific version (accepts ).- : while a rollback is pending, otherwise .
- score: 4
hook useDoubleTap
- file: src/platform/gestures/hooks/useDoubleTap.ts:42
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to detect single and double taps
- score: 4
hook useDraftExpiration
- file: src/platform/forms/hooks/useDraftExpiration.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing draft expiration.
- score: 1
hook useEdgeFunctionHealth
- file: src/platform/health/hooks/useEdgeFunctionHealth.ts:32
- kind: hook
- core: platform
- spec: (none)
- summary: Returns per-function health summaries for the last 24 hours.
- score: 4
hook useEdgeSwipe
- file: src/platform/gestures/hooks/useEdgeSwipe.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing edge swipe.
- score: 1
hook useEditableStandardFields
- file: src/platform/data-manager/utils/rawDataAllowlist.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Returns the list of standard field keys that are editable for a given object,along with the loading state of the underlying settings query.Reads from .
- score: 4
hook useEffectiveLayout
- file: src/platform/page-layouts/hooks/useEffectiveLayout.ts:44
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for determining the effective layout for a given context.Priority:1. Default layout for object + type (is_default = true)2. First layout for object + type3. null if no layouts exist
- example: | const layout, isLoading = useEffectiveLayout( objectName: ‘hr_employees’, layoutType: ‘detail’,);
- score: 1
hook useEmailProviderHealth
- file: src/platform/integrations/hooks/useEmailProviderHealth.ts:66
- kind: hook
- core: platform
- spec: (none)
- summary: React Query wrapper around the edge function.
- score: 4
hook useEmailSignatureSettings
- file: src/platform/email-signatures/hooks/useEmailSignatureSettings.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches email signature settings for the organization.
- score: 4
hook useEmbeddable
- file: src/platform/telephony/hooks/useEmbeddable.ts:73
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for controlling the RingCentral Embeddable widget.Enhanced with OAuth state tracking (T6) for better user feedback.
- example: | const isReady, isLoggedIn, loginStatus, dial, navigate = useEmbeddable();if (isReady && isLoggedIn) dial(‘+15551234567’);// Show different UI based on login statusif (loginStatus === ‘authenticating’) return Spinner message=“Signing in to RingCentral…” /;
- score: 1
hook useEmbeddableCall
- file: src/platform/telephony/hooks/useEmbeddableCall.ts:74
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for tracking and controlling active calls in the Embeddable widget.Enhanced with call connection metrics (T19).
- example: | const activeCall, callMetrics, isRinging, answer, hangup = useEmbeddableCall();if (isRinging) console.log(‘Incoming call from:’, activeCall?.from.phoneNumber);
- score: 1
hook useEmbeddableCallLogger
- file: src/platform/telephony/hooks/useEmbeddableCallLogger.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that automatically logs Embeddable calls to ce_calls when they end.Should be mounted once inside EmbeddableWrapper.
- score: 4
hook useEmbeddableEvents
- file: src/platform/telephony/hooks/useEmbeddableEvents.ts:58
- kind: hook
- core: platform
- spec: (none)
- summary: Generic hook for subscribing to RingCentral Embeddable widget events.Use this when you need specific event callbacks without managing fullwidget state. For widget control, use useEmbeddable instead.
- score: 4
hook useEmbeddableVoicemail
- file: src/platform/telephony/hooks/useEmbeddableVoicemail.ts:70
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for accessing voicemails through the RingCentral Embeddable widget.Note: The Embeddable widget doesn’t provide a direct API to list voicemails.This hook tracks voicemail notifications and provides navigation helpers.
- example: | const unreadCount, navigateToVoicemail = useEmbeddableVoicemail();return ( Badge count=unreadCount Button onClick=navigateToVoicemailVoicemail/Button /Badge);
- score: 1
hook useEmergencyOverride
- file: src/platform/compliance/hooks/useConsentEnforcement.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation to log an emergency override of SUD consent gate.Returns the audit log ID on success.
- score: 4
hook useEmployeeEvents
- file: src/platform/hr/useEmployeeEvents.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Subscribe to employee lifecycle events for cross-core consumers.- INSERT on hr_employees → onEmployeeCreated(EmployeeCreatedPayload)- UPDATE when employment_status transitions to ‘terminated’ → onEmployeeTerminated(EmployeeTerminatedPayload)Requires orgId for tenant scope; events outside the org are ignored.
- score: 4
hook useEmployeeLookup
- file: src/platform/hr/useEmployeeLookup.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch a single employee by ID for cross-core use.Respects RLS; returns null if not in current org or not found.
- score: 4
hook useEmployeeLookup
- file: src/platform/workforce/useEmployeeLookup.ts:27
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for searching and looking up employees across the platform
- score: 1
hook useEmployeeOOOStatus
- file: src/platform/integrations/hooks/useEmployeePresence.ts:90
- kind: hook
- core: platform
- spec: (none)
- summary: Get Out-of-Office status for an employee.
- score: 4
hook useEmployeePresence
- file: src/platform/integrations/hooks/useEmployeePresence.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Get Teams presence for a single employee.Short staleTime since presence changes frequently.
- score: 4
hook useEmployeeSearch
- file: src/platform/hr/useEmployeeSearch.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Search employees with filters for cross-core use.Respects RLS; returns list of EmployeeContext.
- score: 4
hook useEmployeeSharePointMemberships
- file: src/platform/integrations/hooks/useEmployeeEntraMemberships.ts:84
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch SharePoint memberships for an employee
- score: 4
hook useEmployeesPresenceBatch
- file: src/platform/integrations/hooks/useEmployeePresence.ts:64
- kind: hook
- core: platform
- spec: (none)
- summary: Get batch Teams presence for multiple employees.Used in list views for visible employee rows.
- score: 4
hook useEmployeeTeamsMemberships
- file: src/platform/integrations/hooks/useEmployeeEntraMemberships.ts:56
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch Teams memberships for an employee
- score: 4
hook useEncounterContext
- file: src/platform/scheduling/encounter/useEncounterContext.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches encounter context including linked appointment times.
- score: 4
hook useEntityFieldConfig
- file: src/platform/field-config/hooks/useEntityFieldConfig.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing entity field config.
- score: 1
hook useEntityFieldConfigs
- file: src/platform/field-config/hooks/useEntityFieldConfigs.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing entity field configs.
- score: 1
hook useEntraConfig
- file: src/platform/integrations/hooks/useEntraConfig.ts:48
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch organization Entra ID configuration
- score: 4
hook useEntraConfigMutation
- file: src/platform/integrations/hooks/useEntraConfig.ts:131
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook for updating Entra configuration
- score: 4
hook useEntraConnectionTest
- file: src/platform/integrations/hooks/useEntraConfig.ts:177
- kind: hook
- core: platform
- spec: (none)
- summary: Returns a mutation that validates an Entra tenant/domain pair through theplatform registration edge function.
- score: 4
hook useEntraHealth
- file: src/platform/integrations/hooks/useEntraHealth.ts:36
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches live Graph health for the current org via the entra-register-app probe.
- score: 4
hook useEntraRoleLicenseMap
- file: src/platform/integrations/hooks/useEntraRoleLicenseMap.ts:68
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch this org’s role → SKU mappings.
- score: 4
hook useErrorTracking
- file: src/platform/monitoring/useErrorTracking.ts:56
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing error tracking.
- score: 1
hook useExistingStarterRoles
- file: src/platform/permissions/hooks/useStarterRoles.ts:165
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to check if starter roles already exist
- score: 4
hook useExportBundle
- file: src/platform/ai/hooks/useInstallBundle.ts:145
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook to export a bundle via pf_export_bundle.Validates SKILL.md governance (lifecycle_status in approved|published),sha256-hashes the content, and inserts a pf_bundles row. PF-62-EN-02 AC-1
- score: 4
hook useExportRequests
- file: src/platform/export/hooks/useExportRequests.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing export requests.
- score: 1
hook useExportStatus
- file: src/platform/clinical/documents/useExportStatus.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Polls export status by exchange log ID. Stops polling when status is terminal.
- params:
- exportId — The cl_data_exchange_log row ID to poll
- score: 4
hook useExportStatus
- file: src/platform/export/hooks/useExportStatus.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Polls a single export request for status changes.Refetches every 5s while status is pending/processing.
- score: 4
hook useExportTemplates
- file: src/platform/export/hooks/useExportTemplates.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Provides export templates queries and mutation actions scoped to the current organization.
- score: 4
hook useExpressionValidation
- file: src/platform/wizards/hooks/useExpressionValidation.ts:42
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for real-time expression validation
- score: 1
hook useFeaturedListings
- file: src/platform/wizards/hooks/useMarketplace.ts:235
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch featured listings
- score: 4
hook useFeatureFlag
- file: src/platform/feature-flags/useFeatureFlag.ts:36
- kind: hook
- core: platform
- spec: (none)
- summary: Check if a feature flag is enabled for the current user/org.
- example: | const enabled = useFeatureFlag(‘pf.dark_mode’);if (enabled) … const enabled, variant = useFeatureFlag(‘pf.onboarding_experiment’);if (variant === ‘variant_a’) …
- score: 4
hook useFieldAssignmentMutation
- file: src/platform/page-layouts/hooks/useFieldAssignmentMutation.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Hook providing mutations for page layout field assignment operations.
- example: | const assignField, updateFieldAssignment, removeField = useFieldAssignmentMutation();await assignField.mutateAsync( section_id: ‘section-123’, field_name: ‘first_name’,);
- score: 4
hook useFieldConfigMutation
- file: src/platform/field-config/hooks/useFieldConfigMutation.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing field config mutation.
- score: 1
hook useFieldConfigVersions
- file: src/platform/field-config/hooks/useFieldConfigVersions.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing field config versions.
- score: 1
hook useFieldInteractionStats
- file: src/platform/forms/hooks/useFieldInteractionStats.ts:47
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing field interaction stats.
- score: 1
hook useFieldPermissions
- file: src/platform/data-manager/hooks/useFieldPermissions.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing field permissions.
- score: 1
hook useFieldVisibility
- file: src/platform/field-config/hooks/useFieldVisibility.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing field visibility.
- score: 1
hook useFieldVisibility
- file: src/platform/page-layouts/hooks/useFieldVisibility.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to get the current user’s role and provide field visibility filtering.Role fetching can be extended to use PF-30 permissions system.
- score: 4
hook useFieldVisibilityV2
- file: src/platform/conditional-logic/hooks/useConditionalLogic.ts:172
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for checking if a field should be visible based on conditional ruleSimple convenience hook for visibility-only checks
- params:
- rule — The conditional rule
- formValues — Current form field values
- returns: boolean - Whether the field should be visible
- score: 1
hook useFileUpload
- file: src/platform/upload/hooks/useFileUpload.ts:72
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing file uploads with progress, cancellation, and error handling.
- score: 1
hook useFilteredNavGroups
- file: src/platform/navigation/hooks/useFilteredNavGroups.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Filters nav groups by both permission and feature flag settings.
- params:
- moduleId — The parent module ID (e.g., ‘hr’, ‘fa’)
- groups — Array of nav groups to filter
- returns: Filtered array of nav groups
- score: 4
hook useFilteredNavItems
- file: src/platform/navigation/hooks/useNavItemPermission.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Filter an array of nav items based on V2 permissions
- score: 4
hook useFilteredQuickActions
- file: src/platform/navigation/hooks/useFilteredQuickActions.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Filter an array of quick actions based on V2 permissions
- example: | const visibleActions = useFilteredQuickActions(module.quickActions);
- score: 4
hook useFleetUsageRollup
- file: src/platform/fleet/hooks/useFleetUsageRollup.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches agent usage rollup for an organization via pf_agent_usage_rollup RPC.
- params:
- orgId — Organization UUID (query disabled when empty)
- since — Optional ISO-8601 timestamp lower-bound (defaults to server-side 30-day window) PF-130 AC-1
- score: 4
hook useFocusManagement
- file: src/platform/navigation/hooks/useFocusManagement.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing focus management.
- score: 1
hook useFocusRestoration
- file: src/platform/a11y/focus-trap.ts:113
- kind: hook
- core: platform
- spec: (none)
- summary: Saves the currently focused element on mount and restores it on unmount.Useful for panels, drawers, and other overlays that need to returnfocus to the trigger element when dismissed.
- score: 4
hook useFocusTrap
- file: src/platform/a11y/focus-trap.ts:42
- kind: hook
- core: platform
- spec: (none)
- summary: Traps keyboard focus within a container element.Use for custom modals, dropdown panels, and other non-Radix containers.Radix Dialog/Sheet already handles focus trapping — do not double-trap.
- params:
- options — Configuration for the focus trap behavior
- returns: A ref to attach to the container element
- score: 4
hook useForceRefresh
- file: src/platform/pwa/hooks/useForceRefresh.ts:6
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing force refresh.
- score: 1
hook useFormAnalytics
- file: src/platform/forms/hooks/useFormAnalytics.ts:50
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing form analytics.
- score: 1
hook useFormAnalyticsContext
- file: src/platform/forms/components/FormAnalyticsProvider.tsx:48
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing form analytics context.
- score: 1
hook useFormAnalyticsSummary
- file: src/platform/forms/hooks/useFormCompletionMetrics.ts:109
- kind: hook
- core: platform
- spec: (none)
- summary: Get aggregated summary stats across all forms
- score: 4
hook useFormattingPreferences
- file: src/platform/formatting/hooks.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to get organization formatting preferencesReads from pf_module_settings with sensible defaults
- score: 4
hook useFormCompletionMetrics
- file: src/platform/forms/hooks/useFormCompletionMetrics.ts:45
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing form completion metrics.
- score: 1
hook useFormDefinition
- file: src/platform/forms/useFormDefinition.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing form definition.
- score: 1
hook useFormDraft
- file: src/platform/forms/useFormDraft.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing form draft.
- score: 1
hook useFormList
- file: src/platform/forms/useFormList.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing form list.
- score: 1
hook useFormMutation
- file: src/platform/forms/useFormMutation.ts:67
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that provides CRUD-like operations for forms and exposes loading/error state.The returned functions perform form creation, updates, publishing (versioning), archiving, and cloning using Supabase and the current user context. Operations set while in progress and populate on failure.
- returns: An object with: - — creates a new form and its optional fields, returns the created form. - — updates form metadata and replaces its fields, returns on success. - — creates a version snapshot of the form and marks it published, returns . - — marks the form as archived, returns . - — duplicates a form and its fields, returns the newly created form. - — while an operation is in progress. - — the last error encountered or .
- score: 4
hook useFormStats
- file: src/platform/forms/hooks/useFormStats.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing form stats.
- score: 1
hook useFormSubmission
- file: src/platform/forms/useFormSubmission.ts:54
- kind: hook
- core: platform
- spec: (none)
- summary: Provides an imperative API to submit form data and manage submission state for a specific form.The hook handles basic validation, persists the submission to the backend, captures errors,and exposes submission state and a reset function.
- params:
- options — Configuration for the hook: - formId: The identifier of the form to submit to. - organizationId: Optional organization context to include with telemetry. - siteId: Optional site context to include with telemetry.
- returns: An object with: - submit: Function that accepts form data and returns the created . - isSubmitting: while a submission is in progress, otherwise. - error: The last submission or if none. - validationErrors: Array of produced by client-side validation. - reset: Function to clear submission state (, , ).
- score: 4
hook useFormSubmissionPdf
- file: src/platform/forms/hooks/useFormSubmissionPdf.ts:312
- kind: hook
- core: platform
- spec: (none)
- summary: Provide utilities to generate and download a PDF for a form submission using templated document settings. Returns a hook API that formats submission data into PDF sections, resolves letterhead/template settings, and invokes the templated PDF generator to produce a downloadable document.
- returns: An object containing:- - function to generate a PDF for a specific submission; accepts a , , array of , and optional , and returns the result of the PDF generation call.- - boolean loading state while PDF generation is in progress.- - error object if generation failed.- - function to clear the error/loading state.- - convenience function to trigger a file download from a generated PDF URL.
- score: 4
hook useFormTracking
- file: src/platform/analytics/useSessionRecorder.tsx:358
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to track form interactionsProvides helpers for common form analytics events.
- params:
- formId — Form identifier
- returns: Form tracking helpers
- score: 4
hook useGenerateDefaultLayout
- file: src/platform/page-layouts/hooks/useGenerateDefaultLayout.ts:72
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for generating default page layouts.
- example: | const generateLayout, generateAllLayouts, isGenerating = useGenerateDefaultLayout( objectName: ‘hr_employees’,);// Generate a single layoutawait generateLayout(‘detail’);// Generate all four layout typesawait generateAllLayouts();
- score: 1
hook useGenerateEvidence
- file: src/platform/compliance/hooks/useComplianceEvidence.ts:42
- kind: hook
- core: platform
- spec: (none)
- summary: Creates a new evidence generation job and invokes the Edge Function.
- score: 4
hook useGenerateTemplatedPdf
- file: src/platform/templates/hooks/useGenerateTemplatedPdf.ts:85
- kind: hook
- core: platform
- spec: (none)
- summary: Creates a React hook that exposes a mutation to generate a templated PDF for the current organization.
- returns: An object with: - - async function that accepts a and returns a ; - - boolean indicating whether a generation request is pending; - - any error produced by the mutation; - - function to reset the mutation state.
- example: | const generatePdf, isGenerating = useGenerateTemplatedPdf();const handleExport = async () = const result = await generatePdf( letterheadId: selectedLetterhead, content: title: ‘Policy Document’, sections: [ name: ‘Purpose’, content: policy.purpose , name: ‘Scope’, content: policy.scope , ], metadata: documentNumber: policy.policy_number, version: policy.version, , , ); if (result.url) window.open(result.url, ‘_blank’); ;
- score: 4
hook useGenerateTemplateFromDescription
- file: src/platform/templates/hooks/useGenerateTemplateFromDescription.ts:34
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook that generates a document template structure from a description via AI.
- returns: useMutation result with helper and loading/error state.
- score: 4
hook useGestureAnalytics
- file: src/platform/gestures/hooks/useGestureAnalytics.ts:35
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing gesture analytics.
- score: 1
hook useGestureIntegration
- file: src/platform/gestures/hooks/useGestureIntegration.ts:41
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that provides preference-aware, analytics-tracked, haptic-enabledgesture integration. Used internally by Phase 1 gesture hooks.
- score: 4
hook useGesturePreferences
- file: src/platform/gestures/hooks/useGesturePreferences.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing gesture preferences.
- score: 1
hook useGetBundle
- file: src/platform/ai/hooks/useGetBundle.ts:78
- kind: hook
- core: platform
- spec: (none)
- summary: Lazy hook that wraps the pf_get_bundle SECURITY DEFINER RPC.Returns a callback — callers invoke it on demand(e.g. on Install click) rather than on mount. The returned BundlePayloadcarries the real SHA-256 required by pf_install_bundle’sintegrity check.pf_get_bundle (migration 20260702000018) requires an authenticated session;it returns zero rows if the bundle_id is not found. PF-62-EN-02 AC-1
- score: 4
hook useGoogleWorkspaceConnection
- file: src/platform/integrations/hooks/useGoogleWorkspaceConnection.ts:70
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch the active organization’s Google Workspace connection (if any).
- score: 4
hook useGoogleWorkspaceOAuthAuthorize
- file: src/platform/integrations/hooks/useGoogleWorkspaceConnection.ts:216
- kind: hook
- core: platform
- spec: (none)
- summary: Start Google OAuth consent flow for the active org.
- score: 4
hook useGoogleWorkspaceOAuthRevoke
- file: src/platform/integrations/hooks/useGoogleWorkspaceConnection.ts:238
- kind: hook
- core: platform
- spec: (none)
- summary: Revoke OAuth linkage by clearing granted metadata and stored refresh token.
- score: 4
hook useGrantRolePermission
- file: src/platform/permissions/hooks/useRolePermissions.ts:45
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to grant a permission to a role
- score: 4
hook useHandbookComplianceStats
- file: src/platform/governance/handbook/useHandbookComplianceStats.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: Per-policy completion aggregates for the HR-43 compliance dashboard (FR-4).
- score: 4
hook useHandbookPolicies
- file: src/platform/governance/handbook/useHandbookPolicies.ts:10
- kind: hook
- core: platform
- spec: (none)
- summary: List GR-01 policies tagged as workforce handbooks per HR-43 FR-1( AND ).
- score: 4
hook useHapticFeedback
- file: src/platform/gestures/hooks/useHapticFeedback.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing haptic feedback.
- score: 1
hook useHasCredentialForSource
- file: src/platform/credentials/hooks/useHasCredentialForSource.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Checks whether credential-vault metadata exists for an external integrationsource without reading or returning the encrypted secret value.
- score: 4
hook useHasPermission
- file: src/platform/permissions/hooks/useHasPermission.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Check if user has a specific permission
- example: | // Single permission checkconst canView = useHasPermission(‘hr.employees.view’); // Multiple permission checksconst perms = useHasPermission([‘hr.employees.view’, ‘hr.employees.edit’]);if (perms[‘hr.employees.edit’]) …
- score: 4
hook useHasPermissionWithLoading
- file: src/platform/permissions/hooks/useHasPermission.ts:84
- kind: hook
- core: platform
- spec: (none)
- summary: Hook variant that returns loading state
- score: 4
hook useHeadshotCampaignMembers
- file: src/platform/headshot/hooks/useHeadshotCampaigns.ts:52
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches campaign members for a specific campaign.
- score: 4
hook useHeadshotCampaigns
- file: src/platform/headshot/hooks/useHeadshotCampaigns.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches all headshot campaigns for the current organization.
- score: 4
hook useHeadshotJob
- file: src/platform/headshot/hooks/useHeadshotJobs.ts:49
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches a single headshot job by ID.
- score: 4
hook useHeadshotJobsList
- file: src/platform/headshot/hooks/useHeadshotJobs.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches headshot jobs for the current user within their organization.
- score: 4
hook useHeadshotQuota
- file: src/platform/headshot/hooks/useHeadshotQuota.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Returns the current month’s headshot generation quota for the org.
- score: 4
hook useHeadshotResults
- file: src/platform/headshot/hooks/useHeadshotResults.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches headshot results for the current user, optionally filtered by job.
- score: 4
hook useHeadshotSettings
- file: src/platform/headshot/hooks/useHeadshotSettings.ts:34
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches headshot-related settings for the current organization.
- score: 4
hook useHeadshotSignedUrls
- file: src/platform/headshot/hooks/useHeadshotSignedUrls.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Given raw HeadshotResult rows, fetches signed URLs for each and returnsHeadshotResultWithUrl[].
- score: 4
hook useHealthCheck
- file: src/platform/health/hooks/useHealthCheck.ts:54
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing health check.
- score: 1
hook useHealthMetrics
- file: src/platform/health/hooks/useHealthMetrics.ts:273
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for fetching and managing health metrics
- score: 1
hook useHideOnScroll
- file: src/platform/navigation/hooks/useHideOnScroll.ts:34
- kind: hook
- core: platform
- spec: (none)
- summary: Returns when the mobile header should be translated out of view.
- params:
- scrollContainer — Optional explicit scroll container element. Defaults to . Pass to keep the listener detached.
- score: 4
hook useHistoricalMetrics
- file: src/platform/health/hooks/useHistoricalMetrics.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing historical metrics.
- score: 1
hook useHistoryBack
- file: src/platform/navigation/hooks/useHistoryBack.ts:47
- kind: hook
- core: platform
- spec: (none)
- summary: History-aware back hook. See module docs for behavior contract. is a no-op on devices without the Vibration API (includingiOS Safari and all desktop browsers), so it is safe to call unconditionally.
- score: 4
hook useHolidays
- file: src/platform/calendar/hooks/use-holidays.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches holidays for a calendar, optionally filtered by year.
- params:
- calendarId — UUID of the business calendar.
- year — Optional year to filter holidays (e.g., 2026).
- returns: Query result with .
- score: 4
hook useHolidayTemplates
- file: src/platform/calendar/hooks/use-holiday-templates.ts:33
- kind: hook
- core: platform
- spec: (none)
- summary: Returns all available holiday templates, optionally filtered by year.
- params:
- year — Optional year filter.
- returns: Object with array and helper .
- score: 4
hook useHoverBridge
- file: src/platform/navigation/hooks/useHoverBridge.ts:46
- kind: hook
- core: platform
- spec: (none)
- summary: Creates a hover bridge between trigger and flyout elements.The bridge pattern:1. Opening: Delayed to prevent accidental triggers (150ms default)2. Closing: Longer delay (200ms default) to allow mouse travel between elements3. Both trigger and flyout cancel close timers on enter4. Only closes when mouse leaves both elements for the full close delay
- score: 4
hook useICD10Hierarchy
- file: src/platform/terminology/hooks/useICD10Hierarchy.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches ICD-10 codes at a given hierarchy level under a parent code.Use parentCode=null to get top-level chapters.
- score: 4
hook useImportAISkill
- file: src/platform/ai/hooks/useImportAISkill.ts:84
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for importing AI skills from SKILL.md files.Handles file parsing, conflict detection against existing skills,and Rename/Replace resolution before creating the skill.
- returns: Import state and control functions.
- score: 1
hook useImportAudit
- file: src/platform/import/hooks/useImportAudit.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to log import-related audit events.
- params:
- organizationId — Organization context
- returns: logImportEvent callback
- score: 4
hook useImportBatch
- file: src/platform/import/hooks/useImportBatches.ts:41
- kind: hook
- core: platform
- spec: (none)
- summary: Get a single import batch by ID.
- score: 4
hook useImportBatches
- file: src/platform/import/hooks/useImportBatches.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: List import batches for an organization.
- score: 4
hook useImportBatchesList
- file: src/platform/import-batches/hooks/useImportBatchesList.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for listing recent import batches (legacy interface).
- score: 1
hook useImportHolidaysFromCsv
- file: src/platform/calendar/hooks/use-import-holidays-from-csv.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Returns a mutation that imports parsed CSV holidays into a business calendar.
- params:
- calendarId — UUID of the target calendar.
- organizationId — UUID of the organization.
- returns: React Query mutation object.
- score: 4
hook useImportProgress
- file: src/platform/import/hooks/useImportProgress.ts:33
- kind: hook
- core: platform
- spec: (none)
- summary: Poll import batch progress during execution.
- params:
- batchId — Import batch ID to track
- organizationId — Organization context
- score: 4
hook useImportRecords
- file: src/platform/import/hooks/useImportRecords.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: List import records for a given batch.
- score: 4
hook useImportTheme
- file: src/platform/theming/hooks/useTenantTheme.ts:247
- kind: hook
- core: platform
- spec: (none)
- summary: Import a theme from a JSON payload.Creates a new theme row or updates the existing active theme.
- score: 4
hook useInboxCount
- file: src/platform/inbox/hooks/useInboxCount.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing inbox count.
- score: 1
hook useInboxSnoozes
- file: src/platform/inbox/hooks/useInboxSnoozes.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing inbox snoozes.
- score: 1
hook useIncomingCallNotification
- file: src/platform/telephony/hooks/useIncomingCallNotification.ts:49
- kind: hook
- core: platform
- spec: (none)
- summary: Subscribes to realtime inbound call events for the current user, surfaces an enriched incoming call for screen-pop notifications, and exposes controls to dismiss the notification and observe subscription state.
- params:
- options — UseIncomingCallNotificationOptions object configuring the hook - enabled: boolean to enable or disable the realtime subscription (default: true) - onIncomingCall: optional callback invoked with the enriched when a new inbound call for the current user is received
- returns: UseIncomingCallNotificationReturn An object containing: - : the current incoming or if none, - : a function to clear the current incoming call, - : when the Supabase realtime channel is actively subscribed, otherwise.
- score: 4
hook useIndexRecommendations
- file: src/platform/query-performance/hooks/useIndexRecommendations.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch slow query logs and generate index recommendations.
- params:
- timeRange — Time range preset for log window
- enabled — Whether recommendations feature is enabled
- returns: Query result with IndexRecommendation array
- score: 4
hook useInfiniteTemplates
- file: src/platform/templates/hooks/useTemplateLazyLoad.ts:54
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for infinite scrolling template lists
- score: 1
hook useInlineEdit
- file: src/platform/table-v2/hooks/useInlineEdit.ts:87
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing inline cell editing in TanStack Table
- score: 1
hook useInstallBundle
- file: src/platform/ai/hooks/useInstallBundle.ts:79
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook to install a bundle via pf_install_bundle (fail-closed).Invalidates all [‘marketplace’] queries on success. PF-62-EN-02 AC-2
- score: 4
hook useIntegration
- file: src/platform/integrations/hooks/useIntegration.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing integration.
- score: 1
hook useIntegrationMutation
- file: src/platform/integrations/hooks/useIntegrationMutation.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing integration mutation.
- score: 1
hook useIntegrations
- file: src/platform/integrations/hooks/useIntegrations.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing integrations.
- score: 1
hook useInvalidateTemplateCache
- file: src/platform/templates/hooks/useTemplateCache.ts:168
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to invalidate template caches
- score: 4
hook useInvitationAcceptor
- file: src/platform/auth/useInvitationAcceptor.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that auto-accepts pending invitations after login.Place the component version (InvitationAcceptor) in the authenticated layout.
- score: 4
hook useIpAllowlistList
- file: src/platform/security/hooks/useIpListQueries.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing ip allowlist list.
- score: 1
hook useIpBlocklistList
- file: src/platform/security/hooks/useIpListQueries.ts:52
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing ip blocklist list.
- score: 1
hook useJurisdictionProfile
- file: src/platform/jurisdiction/useJurisdictionProfile.ts:33
- kind: hook
- core: platform
- spec: (none)
- summary: Resolves the effective jurisdiction profile for the current org + optional site.
- params:
- siteId — Optional site UUID for site-level override resolution.
- returns: Query result containing the merged .
- score: 4
hook useJurisdictionProfiles
- file: src/platform/jurisdiction/hooks/useJurisdictionProfiles.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches all active jurisdiction profiles for the selector dropdown.
- score: 4
hook useJurisdictionProfiles
- file: src/platform/transcription/admin/hooks/useTranscriptionVendors.ts:115
- kind: hook
- core: platform
- spec: (none)
- summary: Active jurisdiction profiles (used by the routing dialog dropdown).
- score: 4
hook useJurisdictionRoutingRules
- file: src/platform/transcription/admin/hooks/useTranscriptionVendors.ts:90
- kind: hook
- core: platform
- spec: (none)
- summary: Routing rules for the current org.
- score: 4
hook useKeyboardNavigation
- file: src/platform/navigation/hooks/useKeyboardNavigation.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing keyboard navigation.
- score: 1
hook useKeyboardShortcut
- file: src/platform/a11y/keyboard-shortcuts.ts:91
- kind: hook
- core: platform
- spec: (none)
- summary: Registers a keyboard shortcut on mount and unregisters on unmount.
- params:
- id — Unique shortcut identifier
- keys — Key combination string (e.g., “Ctrl+K”, “Alt+Shift+S”)
- handler — Callback invoked when the shortcut fires
- category — Category for grouping in help dialog
- description — Human-readable description
- enabled — Whether the shortcut is active (default: true)
- score: 4
hook useKeyboardShortcutHelp
- file: src/platform/a11y/keyboard-shortcuts.ts:151
- kind: hook
- core: platform
- spec: (none)
- summary: Returns all currently registered keyboard shortcuts, grouped by category.Re-renders when the registry changes (shortcuts added/removed).
- returns: Array of registered shortcut entries
- score: 4
hook useKnowledgeArticle
- file: src/platform/knowledge/hooks/use-knowledge-articles.ts:205
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches a single knowledge article by its id and exposes the query state for consumption.Uses the provided to load the corresponding . When is the hook stays disabled and is .
- params:
- id — The knowledge article’s identifier, or to disable the query
- returns: An object containing: - : the loaded or - : while the query is in-flight - : the error thrown during fetch, or - : a function to re-run the query
- score: 4
hook useKnowledgeArticles
- file: src/platform/knowledge/hooks/use-knowledge-articles.ts:107
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches a paginated, sortable, and filterable list of knowledge base articles scoped to the current organization.Builds and runs a Supabase query for pf_knowledge_base using the current organization context, applying optional filters (category, status, isIndexed, tags, search), sorting, and pagination, and returns the resulting articles and total count with React Query metadata.
- params:
- options — Hook options controlling filtering, pagination, sorting, and whether the query is enabled. - filters: Optional filters to apply: , , , , and (full-text). - pagination: Optional pagination settings: (1-based) and . - sort: Optional sort settings: and (‘asc’ | ‘desc’). Defaults to desc. - enabled: When , disables the query (defaults to ).
- returns: UseKnowledgeArticlesResult - An object containing: - : Array of KnowledgeArticle matching the query. - : Total number of articles for the filtered query. - : Loading state of the query. - : Error encountered while fetching, or . - : Function to refetch the query.
- example: | function ArticlesList() const articles, totalCount, isLoading, refetch = useKnowledgeArticles( filters: status: ‘published’, tags: [‘faq’] , pagination: page: 1, pageSize: 20 , sort: field: ‘updated_at’, direction: ‘desc’ , ); // render articles…
- score: 4
hook useKnowledgeBaseCategories
- file: src/platform/ai/wizards/ai-skill-creation/hooks/useKnowledgeBaseCategories.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Returns the distinct published+indexed knowledge-base categories for the active org.Only eligible (retrievable) articles are counted, so an empty result means RAG has nosource to draw from yet. Cached per (5-min stale / 10-min gc).
- params:
- enabled — When false, the underlying query stays idle (e.g. RAG toggle off).
- returns: Distinct categories with article counts, plus query state.
- score: 4
hook useLayoutEditorState
- file: src/platform/page-layouts/hooks/useLayoutEditorState.ts:51
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing layout editor state.
- score: 1
hook useLayoutVersions
- file: src/platform/page-layouts/hooks/useLayoutVersions.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch version history for a layout, newest first.
- score: 4
hook useLazyTemplate
- file: src/platform/templates/hooks/useTemplateCache.ts:199
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for lazy loading a single template with caching
- score: 1
hook useLazyTemplateSections
- file: src/platform/templates/hooks/useTemplateLazyLoad.ts:219
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for deferred/lazy loading of template sections
- score: 1
hook useLegalHolds
- file: src/platform/data-retention/hooks/useLegalHolds.ts:12
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing legal holds.
- score: 1
hook useLetterhead
- file: src/platform/templates/hooks/useLetterhead.ts:36
- kind: hook
- core: platform
- spec: (none)
- summary: Load a single letterhead by ID or resolve the organization’s default letterhead (falling back to the system default).When is provided, fetches that letterhead while enforcing organization isolation.When is omitted, resolves the default letterhead for (or current organization); if none exists, falls back to the system-wide default.
- params:
- letterheadId — Optional UUID of the letterhead to fetch. If omitted, the hook resolves the organization’s default letterhead.
- organizationId — Optional organization UUID to scope the lookup. If omitted, the current organization from context is used. Required when fetching the default letterhead (i.e., when is not provided).
- returns: A React Query result containing the resolved or if no default exists.
- example: | // Get specific letterheadconst data = useLetterhead(‘uuid-here’); // Get default letterhead for current orgconst data = useLetterhead();
- score: 4
hook useLetterheadMutation
- file: src/platform/templates/hooks/useLetterheadMutation.ts:50
- kind: hook
- core: platform
- spec: (none)
- summary: Provides mutation handlers for creating, updating, deleting, and setting the default letterhead for the current organization. Returns React Query mutation objects configured to operate on the current organization’s letterheads and a composite loading flag.
- returns: An object containing:- : mutation to create a letterhead (call with )- : mutation to update a letterhead (call with )- : mutation to delete a letterhead (call with )- : mutation to mark a letterhead as the default (call with )- : boolean that is if any of the mutations are pending
- example: | const create, update, remove, setDefault = useLetterheadMutation();await create.mutateAsync( data: name: ‘New Letterhead’ );
- score: 4
hook useLifecycleEvents
- file: src/platform/data-retention/hooks/useLifecycleEvents.ts:10
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing lifecycle events.
- score: 1
hook useLineageByDestination
- file: src/platform/org-data-sync/hooks/useLineage.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing lineage by destination.
- score: 1
hook useLineageBySource
- file: src/platform/org-data-sync/hooks/useLineage.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing lineage by source.
- score: 1
hook useLinkEntraUser
- file: src/platform/integrations/hooks/useEntraUnmatchedUsers.ts:100
- kind: hook
- core: platform
- spec: (none)
- summary: Link an unmatched Entra user to an existing employee
- score: 4
hook useListingRatings
- file: src/platform/wizards/hooks/useMarketplace.ts:199
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch ratings for a listing
- score: 4
hook useLoginBrandingBySlug
- file: src/platform/theming/hooks/useLoginBranding.ts:42
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch public login branding by organization slug.Uses the RPC (SECURITY DEFINER, anon-safe).
- score: 4
hook useLoginBrandingBySubdomain
- file: src/platform/theming/hooks/useLoginBranding.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch public login branding by tenant subdomain.Uses the RPC (SECURITY DEFINER, anon-safe).
- score: 4
hook useLogPermissionViolation
- file: src/platform/security/utils/logPermissionViolation.ts:73
- kind: hook
- core: platform
- spec: (none)
- summary: Hook version for use in React components
- score: 4
hook useLongPressEditMode
- file: src/platform/dashboard/hooks/useLongPressEditMode.tsx:38
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing long press edit mode.
- score: 1
hook useLookupValidation
- file: src/platform/forms/hooks/useLookupValidation.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing lookup validation.
- score: 1
hook useMappingTemplates
- file: src/platform/import/hooks/useImportMappingTemplates.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: List mapping templates for an organization, optionally filtered by entity type.
- score: 4
hook useMarkConversationRead
- file: src/platform/messaging/hooks/useMarkConversationRead.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Marks the conversation as read up to the latest loaded message (org-scoped).
- score: 4
hook useMarketplaceListing
- file: src/platform/wizards/hooks/useMarketplace.ts:168
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch a single marketplace listing
- score: 4
hook useMarketplaceListings
- file: src/platform/wizards/hooks/useMarketplace.ts:82
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch marketplace listings with filters and sorting
- score: 4
hook useMarketplaceMutation
- file: src/platform/wizards/hooks/useMarketplaceMutation.ts:80
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing marketplace mutation.
- score: 1
hook useMatrixLayout
- file: src/platform/table-v2/hooks/useMatrixLayout.ts:78
- kind: hook
- core: platform
- spec: (none)
- summary: Transforms flat data into a matrix layout.
- score: 4
hook useMessageActions
- file: src/platform/messaging/hooks/useMessageActions.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing message actions.
- score: 1
hook useMessageAttachmentUrl
- file: src/platform/messaging/hooks/useMessageAttachmentUrl.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Resolves from to a short-lived signed URL when it is a storage path.
- score: 4
hook useMessageReactions
- file: src/platform/messaging/hooks/useMessageReactions.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing message reactions.
- params:
- conversationId — Active thread (for cache invalidation)
- score: 1
hook useMessages
- file: src/platform/messaging/hooks/useMessages.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing messages.
- score: 1
hook useMessageSearch
- file: src/platform/messaging/hooks/useMessageSearch.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing message search.
- score: 1
hook useMessageTranslation
- file: src/platform/messaging/hooks/useMessageTranslation.ts:30
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing message translation.
- score: 1
hook useMessagingShortcuts
- file: src/platform/messaging/hooks/useMessagingShortcuts.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing messaging shortcuts.
- score: 1
hook useMetricExport
- file: src/platform/health/hooks/useMetricExport.ts:32
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing metric export.
- score: 1
hook useMigrationProgress
- file: src/platform/settings/pages/data-migration/hooks/useDataMigrationRuns.ts:99
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing migration progress.
- score: 1
hook useMobileBack
- file: src/platform/navigation/hooks/useMobileBack.ts:52
- kind: hook
- core: platform
- spec: (none)
- summary: History-aware mobile Back hook. See module docs for behavior contract.
- score: 4
hook useMobileNavAllowedShortcuts
- file: src/platform/navigation/hooks/useMobileNavAllowedShortcuts.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Set of shortcut IDs the current user is allowed to use in mobile nav (bar + customize).- Utility shortcuts: always allowed.- Module shortcuts: allowed if the user has access to that module (useModuleAccess).- Sub-module shortcuts: allowed if the user has access to the parent module.
- score: 4
hook useMobileNavPreferences
- file: src/platform/navigation/useMobileNavPreferences.ts:30
- kind: hook
- core: platform
- spec: (none)
- summary: Manage and expose the current user’s mobile navigation shortcuts and elevated index, including fetch, update, and reset operations.Fetches preferences for the current user (disabled until a userId is available) and falls back to defaults when preferences are missing.
- returns: An object with:- — the user’s mobile navigation shortcuts or the default shortcuts.- — the user’s elevated index or the default elevated index.- — while the initial preferences query is loading.- — function to replace shortcuts and elevated index for the current user.- — function to set the user’s shortcuts and elevated index back to the defaults.- — while an update or reset mutation is pending.
- score: 4
hook useModuleAccess
- file: src/platform/modules/useModuleAccess.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing module access.
- score: 1
hook useModuleBottomTabs
- file: src/platform/navigation/hooks/useModuleBottomTabs.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Derives up to 3 bottom-bar tabs from a module’s registry definition.Priority order:1. If the module declares , return those verbatim (capped to 4 entries — the host nav always renders a trailing “More” button).2. Otherwise the module overview () becomes the first tab.3. The first items from each navGroup (up to MAX_MODULE_TABS - 1) fill the remaining slots, preferring over .
- score: 4
hook useModuleDashboard
- file: src/platform/dashboard/hooks/useModuleDashboard.ts:49
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to manage module dashboard state with context detection and widget filtering.Features:- Auto-detects context from URL (e.g., /hr/* → ‘hr’)- Filters widgets to current module + platform widgets- Provides context switching via navigation- Manages module-specific preferences
- score: 4
hook useModuleDefaultSkill
- file: src/platform/ai/hooks/useModuleDefaultSkill.ts:43
- kind: hook
- core: platform
- spec: (none)
- summary: Resolves and returns the default AI skill for a given module, preferring organization-specific settings and falling back to platform defaults.Computes a deterministic default skill code for the provided module (using MODULE_DEFAULT_SKILLS and ‘general_assistant’ as fallback),then retrieves the corresponding skill via useAISkill. The underlying fetch is enabled only when is true and a skill code exists.
- params:
- module — string | undefined - The module code (e.g., “gr”, “hr”, “fa”, “rh”). If falsy, the hook uses “general_assistant”.
- options — UseModuleDefaultSkillOptions - Optional settings for the hook. (boolean) controls whether the underlying skill fetch runs.
- returns: skill: unknown, skillCode: string, isLoading: boolean, error: unknown, refetch: () = Promiseunknown An object containing: - : the fetched AI skill data (or undefined if not loaded), - : the computed default skill code, - : whether the skill fetch is in progress, - : any error from the fetch, - : function to manually re-fetch the skill.
- example: | const skill, skillCode, isLoading = useModuleDefaultSkill(‘hr’, enabled: true );
- score: 4
hook useModuleFeatureFlags
- file: src/platform/modules/useModuleFeatureFlags.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing module feature flags.
- score: 1
hook useModulePermissionCatalog
- file: src/platform/permissions/hooks/useAllModulePermissions.ts:86
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch permissions for a specific module
- score: 4
hook useModulePermissions
- file: src/platform/permissions/hooks/useModulePermissions.ts:33
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch all available permissions for a module
- example: | const data: hrPermissions, isLoading = useModulePermissions(‘hr’); // Render permission listhrPermissions?.map(p = PermissionRow key=p.id permission=p /)
- score: 4
hook useModulePresets
- file: src/platform/modules/hooks/useModulePresets.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing module presets.
- score: 1
hook useModuleRegistry
- file: src/platform/modules/useModuleRegistry.ts:8
- kind: hook
- core: platform
- spec: (none)
- summary: React hook for the loaded module registry (nav trees). May be partial until finishes preloading accessible modules.
- score: 4
hook useModuleRegistrySnapshot
- file: src/platform/modules/useModuleRegistrySnapshot.ts:10
- kind: hook
- core: platform
- spec: (none)
- summary: Subscribe to the on-demand module registry cache. Held in a non-componentmodule so exports only the Provider componentand stays Fast Refresh friendly.
- score: 4
hook useModuleRouting
- file: src/platform/navigation/hooks/useModuleRouting.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to handle route-to-module detection and provide computed routing properties.Separates routing logic from navigation state management.
- score: 4
hook useMultiTouch
- file: src/platform/gestures/hooks/useMultiTouch.ts:34
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing multi touch.
- score: 1
hook useMyEmployee
- file: src/platform/workforce/hooks/useMyEmployee.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Retrieve the authenticated user’s employee record within the current organization.The query runs only when both the current organization ID and the authenticated user ID are available.
- returns: The React Query result containing the employee record (, , ) when found; the result’s will be if no record is available.
- score: 4
hook useMyOnboardingStatus
- file: src/platform/onboarding/useMyOnboardingStatus.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch aggregated onboarding status for the current logged-in employee
- params:
- options — Optional configuration
- returns: Query result with OnboardingStatus for current user
- score: 4
hook useMyTasks
- file: src/platform/tasks/hooks/useMyTasks.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing my tasks.
- score: 1
hook useNavAnalytics
- file: src/platform/navigation/analytics/useNavAnalytics.ts:54
- kind: hook
- core: platform
- spec: (none)
- summary: PHI-safe navigation telemetry. Returns , which inserts astructural nav event into scoped to the current org + user.No-ops when org/user id is unavailable (e.g. before auth resolves).
- score: 4
hook useNavigation
- file: src/platform/navigation/useNavigation.ts:7
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to access navigation context.
- score: 4
hook useNavigationBadges
- file: src/platform/navigation/hooks/useNavigationBadges.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing navigation badges.
- score: 1
hook useNavigationContext
- file: src/platform/navigation/hooks/useNavigationContext.ts:49
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to manage navigation state including:- Sidebar mode (all modules vs in-module view)- Flyout panel state- Recent modules (persisted)NOTE: On desktop, sidebar open/collapsed state is managed by SidebarProvider (from /shared/ui/sidebar) in ResponsiveNav.tsx (cookie persistence, Cmd+B).
- score: 4
hook useNavigationFrequency
- file: src/platform/navigation/hooks/useNavigationFrequency.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Tracks which routes the user visits most frequently on mobile.Stores counts in localStorage with time-decay: entries older than 1 weekhave their counts halved. Returns the top N routes by frequency, whichcan be used for shortcut suggestions.
- score: 4
hook useNavItemVisible
- file: src/platform/navigation/hooks/useNavItemPermission.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Check if a navigation item should be visible based on V2 permissions.
- example: | const isVisible = useNavItemVisible( permission: ‘hr.employees.view’ );
- score: 4
hook useNavMode
- file: src/platform/navigation/NavModeContext.tsx:89
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to read/update sidebar open/collapsed state.
- score: 4
hook useNavTelemetry
- file: src/platform/navigation/telemetry/useNavTelemetry.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the org-scoped navigation summary via the RPC.Disabled when is null (e.g. before org context resolves).Results are considered fresh for 60 s to avoid hammering the RPC on everyrender while still reflecting recent activity.NOTE: always invoke as a method call. Detaching it() loses the binding — reads and throws at runtime.
- score: 4
hook useNetworkStatus
- file: src/platform/pwa/hooks/useNetworkStatus.ts:6
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing network status.
- score: 1
hook useNotificationDelivery
- file: src/platform/notifications/hooks/useNotificationDelivery.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing notification delivery.
- score: 1
hook useNotificationMutation
- file: src/platform/notifications/useNotificationMutation.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing notification mutation.
- score: 1
hook useNotificationPreferences
- file: src/platform/notifications/useNotificationPreferences.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing notification preferences.
- score: 1
hook useNotifications
- file: src/platform/notifications/useNotifications.ts:10
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing notifications.
- score: 1
hook useNotificationTemplates
- file: src/platform/notifications/hooks/useNotificationTemplates.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Lists platform and organization notification templates for the current organization.
- params:
- filters — Optional event/channel/status filters for narrowing the template list.
- returns: Query result containing matching template rows.
- score: 4
hook useNotificationToasts
- file: src/platform/notifications/useNotificationToasts.tsx:25
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing notification toasts.
- score: 1
hook useOAuthFlow
- file: src/platform/integrations/hooks/useOAuthFlow.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing oauth flow.
- score: 1
hook useOAuthProviders
- file: src/platform/integrations/hooks/useOAuthProviders.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing oauth providers.
- score: 1
hook useObjectByApiName
- file: src/platform/data-manager/hooks/useObjectMetadata.ts:83
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing object by api name.
- score: 1
hook useObjectCategories
- file: src/platform/data-manager/hooks/useObjectCategories.ts:12
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing object categories.
- score: 1
hook useObjectFavorites
- file: src/platform/data-manager/hooks/useObjectFavorites.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing object favorites.
- score: 1
hook useObjectMetadata
- file: src/platform/data-manager/hooks/useObjectMetadata.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing object metadata.
- score: 1
hook useObjectMetadataMutation
- file: src/platform/data-manager/hooks/useObjectMetadataMutation.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing object metadata mutation.
- score: 1
hook useObjectPermissions
- file: src/platform/data-manager/hooks/useObjectPermissions.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing object permissions.
- score: 1
hook useOfflineQueue
- file: src/platform/pwa/hooks/useOfflineQueue.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing offline queue.
- score: 1
hook useOnboardingSession
- file: src/platform/import/hooks/useOnboardingSessions.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Get a single onboarding session by ID.
- score: 4
hook useOnboardingSessions
- file: src/platform/import/hooks/useOnboardingSessions.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: List onboarding sessions for an organization.
- score: 4
hook useOnboardingStatus
- file: src/platform/onboarding/useOnboardingStatus.ts:92
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch aggregated onboarding status for a specific employee
- params:
- employeeId — The employee ID to fetch onboarding status for
- options — Optional configuration
- returns: Query result with OnboardingStatus
- score: 4
hook useOnlineStatus
- file: src/platform/messaging/hooks/useOnlineStatus.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing online status.
- score: 1
hook useOptionalRealtimeContext
- file: src/platform/realtime/RealtimeProvider.tsx:43
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing optional realtime context.
- score: 1
hook useOrgAiProfile
- file: src/platform/ai/hooks/useOrgAiProfile.ts:46
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the AI-onboarding profile columns for an organization.
- params:
- organizationId — Target org id. Defaults to the current organization.
- returns: React Query result whose is the (all-null when no settings row exists yet) or while disabled.
- score: 4
hook useOrgAiProfileMutation
- file: src/platform/ai/hooks/useOrgAiProfileMutation.ts:59
- kind: hook
- core: platform
- spec: (none)
- summary: Mutations for the AI-onboarding write path. Both delegate to SECURITY DEFINER RPCsthat assert server-side; the caller MUST also gate the UI on thesame permission (no double-gate divergence — NFR-sec-1).
- returns: / callbacks and per-action pending flags.
- score: 4
hook useOrganization
- file: src/platform/organizations/OrganizationContext.tsx:275
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing organization.
- score: 1
hook useOrganizationEmailSignature
- file: src/platform/email-signatures/hooks/useOrganizationEmailSignature.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the organization’s default email signature (user_id IS NULL, is_default = true).
- score: 4
hook useOrganizationMembers
- file: src/platform/organizations/hooks/useOrganizationMembers.ts:28
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches all members of the current organization by querying through pf_user_role_assignments (V2).This is the CORRECT pattern - do NOT query pf_profiles directly without filtering by org.Automatically filters out expired role assignments.
- score: 4
hook useOrganizationSiteOptions
- file: src/platform/sites/hooks/useOrganizationSiteOptions.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing organization site options.
- score: 1
hook useOrganizationUploadSettings
- file: src/platform/upload/hooks/useOrganizationUploadSettings.ts:87
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for fetching organization upload settings.
- score: 1
hook useOrgBySlug
- file: src/platform/organizations/hooks/useOrgBySlug.ts:10
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing org by slug.
- score: 1
hook useOrgDashboardDefaults
- file: src/platform/dashboard/hooks/useOrgDashboardDefaults.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Manages organization-level dashboard defaults.Org admins can set defaults that apply to all users who haven’t customized their dashboard.
- score: 4
hook useOrgJurisdictionConfig
- file: src/platform/jurisdiction/hooks/useOrgJurisdictionConfig.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the current org’s jurisdiction config with joined profile data.
- score: 4
hook useOrgLetterheads
- file: src/platform/templates/hooks/useLetterhead.ts:108
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches letterheads for an organization with optional filters. Queries pf_letterheads for the specified organization and returns matching letterhead templates. Supports including system-wide templates, filtering by default status, and searching by name. The hook is enabled only when an organization ID can be resolved from the supplied filters or the current organization context.
- params:
- filters — Partial set of LetterheadFilters to constrain the results: - organizationId: optional organization UUID to query (falls back to current organization) - includeSystem: include system-wide templates when true - isDefault: filter by default status when defined - search: case-insensitive name search string
- returns: The React Query result containing an array of objects matching the filters.
- example: | const data: letterheads = useOrgLetterheads( organizationId: ‘uuid’, includeSystem: true,);
- score: 4
hook useOrgMembers
- file: src/platform/messaging/hooks/useOrgMembers.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches all organization members with profiles. Reusable for people directory and people picker.
- score: 4
hook useOrgPath
- file: src/platform/organizations/hooks/useOrgPath.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing org path.
- score: 1
hook useOrgProfileArticle
- file: src/platform/knowledge/hooks/use-org-profile-article.ts:67
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the current published-and-indexed narrative for the active organization.Calls the SECURITY DEFINER RPC scoped to the currentorganization (defense-in-depth: org id from context). The fullpredicate () livesinside the RPC body, so this hook restates no filter. An empty RPC result maps to (no published-and-indexed profile yet — e.g. published but not yet embedded).
- returns: An object containing: - : the single or - : while the query is in-flight - : a sanitized error, or - : re-run the query
- example: | const article, isLoading = useOrgProfileArticle();if (isLoading) return ;if (!article) return No org profile published yet.;
- score: 4
hook useOrgSlugContext
- file: src/platform/organizations/hooks/useOrgSlugContext.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to access org slug context for org-aware navigation.
- score: 4
hook useOrgSudEmbedAuthorization
- file: src/platform/clinical/consent/checkOrgSudEmbedAuthorization.ts:59
- kind: hook
- core: platform
- spec: (none)
- summary: Hook wrapper for the in-app embed-token mint UI: surfaces whether the current org mayexternally embed SUD-derived analytics, so the UI can warn before minting.
- score: 4
hook useOutboundWebhookMutation
- file: src/platform/integrations/hooks/useOutboundWebhookMutation.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing outbound webhook mutation.
- score: 1
hook useOutboundWebhooks
- file: src/platform/integrations/hooks/useOutboundWebhooks.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing outbound webhooks.
- score: 1
hook usePageLayout
- file: src/platform/page-layouts/hooks/usePageLayout.ts:34
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for fetching a single page layout with its sections and fields.
- example: | const layout, isLoading = usePageLayout( layoutId: ‘some-layout-id’,);
- score: 1
hook usePageLayoutMutation
- file: src/platform/page-layouts/hooks/usePageLayoutMutation.ts:27
- kind: hook
- core: platform
- spec: (none)
- summary: Hook providing mutations for page layout CRUD operations.
- example: | const createLayout, updateLayout, deleteLayout = usePageLayoutMutation();await createLayout.mutateAsync( object_name: ‘hr_employees’, layout_type: ‘detail’, layout_name: ‘Default Detail Layout’,);
- score: 4
hook usePageLayouts
- file: src/platform/page-layouts/hooks/usePageLayouts.ts:30
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for fetching page layouts for a specific object.
- example: | const layouts, isLoading = usePageLayouts( objectName: ‘hr_employees’, layoutType: ‘detail’,);
- score: 1
hook usePagePermissions
- file: src/platform/forms/hooks/usePagePermissions.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to manage page-level permissions in multi-page forms
- score: 4
hook usePageTitle
- file: src/platform/navigation/hooks/usePageTitle.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing page title.
- score: 1
hook usePageValidation
- file: src/platform/forms/hooks/usePageValidation.ts:70
- kind: hook
- core: platform
- spec: (none)
- summary: Create a page-level validation helper configured for the provided form fields and current form data.Produces a validatePage function that checks each field on the page for requiredness, type-specific constraints (email, phone, number), signature-field rules (valid base64 PNG signature data and optional required signature date), and configurable custom validation rules (min/max for numbers, minLength/maxLength, pattern with custom message). Validation errors are returned as an array of FormValidationError objects keyed by field_key.
- params:
- fields — Array of form field definitions for the current page (FormField[])
- formData — Current form values keyed by field_key (Recordstring, unknown)
- returns: An object with , a function that returns after running validations
- example: | const validatePage = usePageValidation(fields, formData);const isValid, errors = validatePage();
- score: 4
hook usePaginatedTable
- file: src/platform/table-v2/hooks/usePaginatedTable.ts:118
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing table pagination state with PF-58 compatibility.
- params:
- options — Pagination options
- returns: Pagination state and handlers
- score: 1
hook usePaginatedTemplates
- file: src/platform/templates/hooks/useTemplateLazyLoad.ts:111
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for paginated template lists (traditional pagination)
- score: 1
hook usePagination
- file: src/platform/table-v2/utils/pagination/hooks.ts:95
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing pagination stateProvides complete pagination state management with navigation handlers,page size control, and calculated metadata for display.
- params:
- options — Pagination options
- returns: Pagination state and handlers
- score: 1
hook usePasskeys
- file: src/platform/auth/passkey/usePasskeys.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook exposing the user’s passkeys plus register/rename/delete mutations.The list query is disabled when WebAuthn is unsupported or no user is signed in.
- score: 4
hook usePatientActiveProblems
- file: src/platform/clinical/patient/usePatientActiveProblems.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Active-only problem list (active + chronic) from for shared PM/CL surfaces.Lives in the platform layer to avoid cross-core imports (CL-46).
- params:
- patientId — Patient UUID when querying; omit or pass to leave the query disabled until identity is known.
- score: 4
hook usePatientContext
- file: src/platform/clinical/patient/usePatientContext.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches full patient context for a chart, including demographics, diagnoses,risk screening, and active consent types.
- score: 4
hook usePatientLeadConversionHistory
- file: src/platform/ce/useLeadConversionHistory.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches lead conversion records for a given patient.Used by PM core’s PatientLeadHistory component via platform integration layer.
- score: 4
hook usePayrollJournalEntryStatus
- file: src/platform/finance/hooks/usePayrollJournalEntryStatus.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Read the FA-43 payroll JournalEntry handoff status for a Proliant run.Returns when no JE has been written yet (handoff still in flight).
- score: 4
hook usePendingApprovalCount
- file: src/platform/approvals/hooks/useApprovalInbox.ts:96
- kind: hook
- core: platform
- spec: (none)
- summary: Pending approval count for the current user in the current org (same data as inbox).
- score: 4
hook usePendingApprovalCount
- file: src/platform/documents/hooks/usePendingApprovals.ts:167
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing pending approval count.
- score: 1
hook usePendingApprovals
- file: src/platform/documents/hooks/usePendingApprovals.ts:45
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing pending approvals.
- score: 1
hook usePendingHandbookAcknowledgments
- file: src/platform/governance/handbook/usePendingHandbookAcknowledgments.ts:9
- kind: hook
- core: platform
- spec: (none)
- summary: Pending handbook acknowledgments for an employee (HR-43 US-3/US-5).
- score: 4
hook usePendingSignatures
- file: src/platform/signatures/hooks/usePendingSignatures.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing pending signatures.
- score: 1
hook usePerformanceReport
- file: src/platform/health/hooks/usePerformanceReport.ts:68
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing performance report.
- score: 1
hook usePeriodComparison
- file: src/platform/health/hooks/usePeriodComparison.ts:32
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing period comparison.
- score: 1
hook usePeriodicUpdateCheck
- file: src/platform/pwa/hooks/usePeriodicUpdateCheck.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing periodic update check.
- score: 1
hook usePermanentDelete
- file: src/platform/admin/hooks/useDeletedRecordMutation.ts:98
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing permanent delete.
- score: 1
hook usePermissions
- file: src/platform/permissions/hooks/usePermissions.ts:42
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch user’s effective permissions
- example: | // Get all permissions for current userconst data: permissions, isLoading = usePermissions(); // Get HR module permissions onlyconst data: hrPermissions = usePermissions( moduleId: ‘hr’ );
- score: 4
hook usePersonaNavOrder
- file: src/platform/navigation/hooks/usePersonaNavOrder.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Reorders a module’s visible nav groups according to the user’s persona.The first persona whose has a granted permission wins andits is applied. When no persona matches (or the module declaresnone), the fallback is resolved in priority order: 1. The explicit argument (for call-site overrides). 2. (data-driven, declared on the module definition). 3. (platform default).The sort is stable, so groups within the same section keep their original relative order.
- params:
- module — Module providing the persona rules (id, personas, fallbackSectionOrder).
- groups — The permission-filtered nav groups to reorder.
- fallbackOrder — Optional explicit override for the fallback section order.
- score: 4
hook usePFModuleSettings
- file: src/platform/modules/usePFModuleSettings.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing PF module settings.Uses useCachedQuery (platform cache) for high-read, low-change settings data.
- score: 1
hook usePhiAccessAudit
- file: src/platform/fleet/hooks/usePhiAccessAudit.ts:67
- kind: hook
- core: platform
- spec: (none)
- summary: Reads the compliance PHI-access audit surface for an organization via thepf_agent_phi_access_audit RPC, with an optional time lower-bound.
- params:
- orgId — Organization UUID (query disabled when empty)
- since — Optional ISO-8601 timestamp; the RPC filters occurred_at gte since PF-130 AC-2
- score: 4
hook usePhiClassifications
- file: src/platform/compliance/hooks/usePhiClassifications.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches all PHI classifications for the given organization.
- score: 4
hook usePhiScan
- file: src/platform/ai/wizards/ai-skill-creation/hooks/usePhiScan.ts:53
- kind: hook
- core: platform
- spec: (none)
- summary: Run the three author-time safety screens over the current Step-2 prompt fields.
- params:
- args — The two prompt fields plus the attestation checkbox state.
- returns: A snapshot driving the Step-2 gate + inline messages.
- score: 4
hook usePicklist
- file: src/platform/picklists/hooks/usePicklist.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing picklist.
- score: 1
hook usePicklistBatchResolver
- file: src/platform/picklists/hooks/usePicklistBatchResolver.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Resolves a batch of picklist to their display labels in a single pass. Loads the named picklist once via usePicklistItems, memo-builds avalue→label Map, then dedupes the input and maps each one that has amatching item. Unmatched values are omitted from (omit-on-miss),letting callers distinguish resolved from unresolved values. Empty/undefinedinputs yield an empty map without error.
- params:
- picklistName — The name of the picklist to resolve against.
- values — The stored values to look up (duplicates are de-duplicated).
- returns: A (input value → label, omit-on-miss) and the forwarded flag.
- example: | const labelMap, isLoading = usePicklistBatchResolver(‘employment_status’, rowStatuses);// labelMap[‘on_leave’] === ‘On Leave’; unknown values are absent from labelMap.
- score: 4
hook usePicklistByEnum
- file: src/platform/picklists/hooks/usePicklistByEnum.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that loads picklist items with fallback to enum values
- params:
- picklistName — The name of the picklist to load
- enumFallback — Object mapping enum values to labels (e.g., active: ‘Active’, inactive: ‘Inactive’ )
- returns: Items array, loading state, and source indicator
- example: | const items, isLoading, source = usePicklistByEnum(‘employment_status’, active: ‘Active’, on_leave: ‘On Leave’, terminated: ‘Terminated’,);
- score: 4
hook usePicklistByName
- file: src/platform/picklists/hooks/usePicklistByName.ts:35
- kind: hook
- core: platform
- spec: (none)
- summary: Resolve a picklist by its stable , applying the same precedence as: organization-specific row first, then system-wide(), , limit 1.
- params:
- name — Stable picklist name (e.g. ).
- options — Optional override for organization id.
- returns: React Query result whose is the picklist row, or if no matching active picklist exists for the org/system scope.
- example: | const data: picklist = usePicklistByName(‘gr.policy.category’);if (picklist) navigate(prefixPath());
- score: 4
hook usePicklistExport
- file: src/platform/picklists/hooks/usePicklistExport.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing picklist export.
- score: 1
hook usePicklistImport
- file: src/platform/picklists/hooks/usePicklistImport.ts:35
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing picklist import.
- score: 1
hook usePicklistItems
- file: src/platform/picklists/hooks/usePicklistItems.ts:33
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches active picklist items for a given picklist name scoped to the current organization, falling back to a system-wide picklist when an organization-specific one is not found. Uses useCachedQuery (platform cache + TanStack Query) for 5-minute cache; ideal for high-read, low-change dropdown data.
- params:
- picklistName — The name of the picklist to load; when no request is made and an empty array is returned.
- options — Optional configuration object - organizationId: Override organization ID (defaults to current organization from context) - activeOnly: Filter to active items only (defaults to true)
- returns: The React Query result containing an array of objects (or an empty array when no picklist is found or inputs are missing).
- example: | const data: items = [], isLoading = usePicklistItems(‘country’); const data: items = [], isLoading = usePicklistItems(‘country’, organizationId: orgId );
- score: 4
hook usePicklistMutation
- file: src/platform/picklists/hooks/usePicklistMutation.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing picklist mutation.
- score: 1
hook usePicklists
- file: src/platform/picklists/hooks/usePicklists.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches picklists visible to the current organization with optional filtering. Builds and runs a Supabase query to return picklists that belong to the current organization or are global (organization_id is null). Supports optional filters for category, active status, and case-insensitive search across and . The query is enabled only when a current organization is selected.
- params:
- options — Filtering options for the picklists: - (optional): filter by picklist category. - (optional): filter by flag. - (optional): partial, case-insensitive match against or .
- returns: UseQueryResultPicklistWithCount[], Error - React Query result containing matching picklists, each enriched with its total item count.
- example: | const data: picklists, isLoading, error = usePicklists( category: ‘lead_status’, isActive: true, search: ‘priority’);
- score: 4
hook usePicklistValueLabel
- file: src/platform/picklists/hooks/usePicklistValueLabel.ts:33
- kind: hook
- core: platform
- spec: (none)
- summary: Resolves a single picklist to its display . Loads the named picklist once via usePicklistItems and memo-buildsa value→label Map. A nullish resolves to without error,making it safe to call before a form field has a selection.
- params:
- picklistName — The name of the picklist to resolve against.
- value — The stored value to look up; returns an label.
- returns: The resolved (or ) and the forwarded flag.
- example: | const label, isLoading = usePicklistValueLabel(‘employment_status’, employee.status);// label === ‘On Leave’ when value === ‘on_leave’
- score: 4
hook usePinchToZoom
- file: src/platform/gestures/hooks/usePinchToZoom.ts:47
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing pinch to zoom.
- score: 1
hook usePinnedActions
- file: src/platform/navigation/hooks/usePinnedActions.ts:107
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing pinned quick actions via localStorage.Uses useSyncExternalStore for cross-tab reactivity.
- score: 1
hook usePinnedItems
- file: src/platform/navigation/hooks/usePinnedItems.ts:27
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to manage pinned sidebar items with safe merge pattern.Reads from and writes to pf_profiles.preferences.pinnedItems.
- score: 4
hook usePlaidLink
- file: src/platform/banking/providers/plaid/usePlaidLink.ts:122
- kind: hook
- core: platform
- spec: (none)
- summary: Initializes and manages the Plaid Link connection flow for an organization, including token retrieval, OAuth redirect restoration, SDK lifecycle, token exchange, error handling, and callbacks for single- and multi-account results.Orchestrates fetching and refreshing Plaid link tokens (with OAuth redirect persistence), initializes the Plaid Link SDK, exposes methods to open/exit the Link flow and submit MFA, and surfaces loading / connecting / error / readiness state and callbacks supplied in .
- params:
- options — Configuration and callbacks for the Plaid Link flow. - organizationId: The organization identifier used when creating/exchanging link tokens. - accessToken: Optional existing access token for update flows; forwarded to token creation. - products: Optional list of Plaid products to request (defaults to transactions). - countryCodes: Optional list of country codes for token creation (defaults to US). - onSuccess: Callback invoked for each connected account when a single-account flow completes. - onMultiAccountSuccess: Callback invoked with aggregated results when multiple accounts are connected. - onError: Callback invoked with an Error when token fetch, exchange, or SDK failures occur. - onExit: Callback invoked when the Plaid Link flow is exited (user or error). - onOpen: Callback invoked when the Plaid Link modal opens. - onLoad: Callback invoked when the Plaid Link script successfully loads.
- returns: The hook return object containing:- connect: function to open Plaid Link- isLoading: whether initial token fetch / OAuth restoration is in progress- isConnecting: whether an in-flow connection/exchange is underway- error: current user-facing error message or - ready: true when the SDK is ready, a link token is present, and not loading- isLinkLoaded: true when the Plaid Link script has loaded- clearError: function to clear the current error- resetState: function to clear connection state- exit: function to programmatically exit the Plaid flow (optional force?: boolean )- submitMfa: function to submit MFA data to the Plaid SDK, normalized to return a Promisevoid
- example: | const connect, isLoading, error, ready = usePlaidLink( organizationId: ‘org_123’, onSuccess: (result) = console.log(‘connected’, result), onError: (err) = console.error(err),);
- score: 4
hook usePlaidSync
- file: src/platform/banking/providers/plaid/usePlaidSync.ts:33
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for syncing Plaid transactions
- score: 1
hook usePlatformTelehealthConsentValidity
- file: src/platform/clinical/telehealth/useTelehealthConsentValidity.ts:46
- kind: hook
- core: platform
- spec: CL-24
- summary: Returns the latest telehealth consent (revoked or not) and its derivedvalidity state for a chart. The state is observable here becausethe query does not pre-filter revoked rows.
- score: 5
hook usePlatformTelehealthSettings
- file: src/platform/clinical/telehealth/useTelehealthDocumentationEnabled.ts:35
- kind: hook
- core: platform
- spec: CL-24
- summary: Returns the CL-24 module settings for the current org with safe defaults.
- score: 5
hook usePortalDefinitions
- file: src/platform/automation/portal/hooks.ts:31
- kind: hook
- core: platform
- spec: (none)
- summary: Curated/known portals for the active org (drives the ToS gate).
- score: 4
hook usePortalFlows
- file: src/platform/automation/portal/hooks.ts:52
- kind: hook
- core: platform
- spec: (none)
- summary: The org’s portal-bot flows (templates + recorded).
- score: 4
hook usePortalPatientId
- file: src/platform/portal/usePortalPatientId.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Primary scope hook for portal.
- score: 4
hook usePortalRuns
- file: src/platform/automation/portal/hooks.ts:73
- kind: hook
- core: platform
- spec: (none)
- summary: Run history, optionally scoped to one flow.
- score: 4
hook usePortalRunSteps
- file: src/platform/automation/portal/hooks.ts:97
- kind: hook
- core: platform
- spec: (none)
- summary: Per-step audit trail (screenshots, heal events) for one run.
- score: 4
hook usePostAssistantMessage
- file: src/platform/ai/hooks/usePostAssistantMessage.ts:30
- kind: hook
- core: platform
- spec: (none)
- summary: Call pf_post_assistant_message to persist an AI reply.Returns the new pf_messages.id (uuid).
- score: 4
hook usePreadmissionPrefill
- file: src/platform/preadmission/usePreadmissionPrefill.ts:136
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches preadmission packet completion data for a given appointmentand maps it to a pre-fill shape consumable by CL intake forms.
- params:
- appointmentId — The appointment ID to look up the packet for
- returns: Pre-fill data, loading state, and error
- score: 4
hook usePreferenceForTypeAndChannel
- file: src/platform/notifications/useNotificationPreferences.ts:141
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing preference for type and channel.
- score: 1
hook usePrefersReducedMotion
- file: src/platform/a11y/motion.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Returns when the user prefers reduced motion.Listens to the media query and updates reactively.
- returns: Whether reduced motion is preferred
- score: 4
hook usePrefetchOnIntent
- file: src/platform/routing/prefetch/prefetchOnIntent.ts:58
- kind: hook
- core: platform
- spec: (none)
- summary: Returns event handlers (, , )that prefetch the registered query for on intent.
- score: 4
hook usePrefetchTemplate
- file: src/platform/templates/hooks/useTemplateCache.ts:232
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to prefetch a specific template on hover
- score: 4
hook usePrefetchTemplates
- file: src/platform/templates/hooks/useTemplateCache.ts:117
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to prefetch all template types for an organization
- score: 4
hook usePrefillEngine
- file: src/platform/forms/hooks/usePrefillEngine.ts:33
- kind: hook
- core: platform
- spec: (none)
- summary: Evaluates prefill rules for a form and returns defaults + provenance map.
- score: 4
hook useProcessHealthSettings
- file: src/platform/automation/hooks/useProcessHealthSettings.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches process health settings for the current organization.Falls back to default values when the organization has no custom settings.
- returns: TanStack Query result containing .
- score: 4
hook useProcessHealthTrend
- file: src/platform/automation/hooks/useProcessHealthTrend.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches health trend snapshots for a specific business process.
- params:
- processId — UUID of the business process.
- days — Number of days of history to fetch. Defaults to 30.
- returns: TanStack Query result containing .
- score: 4
hook useProfileManagement
- file: src/platform/users/useProfileManagement.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing profile management.
- score: 1
hook useProvisioningAssignments
- file: src/platform/provisioning/hooks/useProvisioningAssignments.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches template assignment history for an organization.
- score: 4
hook useProvisioningRequestDetail
- file: src/platform/provisioning/hooks/useProvisioningRequestDetail.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing provisioning request detail.
- score: 1
hook useProvisioningRequests
- file: src/platform/provisioning/hooks/useProvisioningRequests.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing provisioning requests.
- score: 1
hook useProvisioningTemplateBundles
- file: src/platform/provisioning/hooks/useProvisioningTemplateBundles.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the bundle composition for a provisioning template.
- score: 4
hook useProvisioningTemplates
- file: src/platform/provisioning/hooks/useProvisioningTemplates.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing provisioning templates.
- score: 1
hook usePublishEvent
- file: src/platform/events/usePublishEvent.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: React hook for publishing domain events.
- example: | // Basic usageconst publish, isPublishing = usePublishEvent();const handleAdmit = async (episode) = await publish( event_name: ‘rh_resident_admitted’, organization_id: episode.organization_id, payload: episode_id: episode.id, resident_id: episode.resident_id, , );; // With callbacksconst publish = usePublishEvent( showSuccessToast: true,);
- score: 4
hook usePublishKnowledgeArticle
- file: src/platform/knowledge/hooks/use-knowledge-articles.ts:437
- kind: hook
- core: platform
- spec: (none)
- summary: Provides a React Query mutation hook to publish a knowledge article. Publishes the specified article by setting its status to , recording publish timestamps and user, updates the cache for lists and detail, and shows success/error toasts.
- returns: The mutation object () whose / should be called with the article ; the mutation resolves to the updated .
- example: | const publishMutation = usePublishKnowledgeArticle();// imperativelypublishMutation.mutate(‘article-id’);// or with async/awaitawait publishMutation.mutateAsync(‘article-id’);
- score: 4
hook usePublishOrgProfileArticle
- file: src/platform/ai/hooks/usePublishOrgProfileArticle.ts:53
- kind: hook
- core: platform
- spec: (none)
- summary: Publishes (or re-publishes) the org_profile narrative article.
- returns: resolving to the published article id, and . Throws (issues preserved) when the PHI/injection scan blocks publish; throws a sanitized Error on a DB failure.
- score: 4
hook usePullToRefresh
- file: src/platform/gestures/hooks/usePullToRefresh.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing pull to refresh.
- score: 1
hook usePushSubscription
- file: src/platform/notifications/hooks/usePushSubscription.ts:30
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing push subscription.
- score: 1
hook useQueryPatterns
- file: src/platform/query-performance/hooks/useQueryPatterns.ts:97
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch slow query logs and aggregate into pattern summaries.
- params:
- timeRange — Time range preset
- enabled — Whether pattern analysis feature is enabled
- score: 4
hook useQueryPerformanceLogs
- file: src/platform/query-performance/hooks/useQueryPerformanceLogs.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing query performance logs.
- score: 1
hook useQueryPerformanceOverview
- file: src/platform/query-performance/hooks/useQueryPerformanceOverview.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing query performance overview.
- score: 1
hook useQueryPerformanceSettings
- file: src/platform/query-performance/useQueryPerformanceSettings.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing query performance settings.
- score: 1
hook useQueryPlan
- file: src/platform/query-performance/hooks/useCaptureQueryPlan.ts:34
- kind: hook
- core: platform
- spec: (none)
- summary: Read the execution plan for a specific log entry (if captured).
- params:
- logId — The ID of the query performance log entry
- enabled — Whether plan capture feature is enabled
- score: 4
hook useQuickActionBadges
- file: src/platform/navigation/hooks/useQuickActionBadges.ts:9
- kind: hook
- core: platform
- spec: (none)
- summary: Maps app routes to pending-item counts for quick-action badges (dashboard, cards, palette).
- returns: Record keyed by from actions
- score: 4
hook useQuickActionPins
- file: src/platform/navigation/hooks/useQuickActionPins.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Returns ordered pinned action keys and mutators, merging dashboard preferences with local fallback.
- score: 4
hook useQuickActionsPalette
- file: src/platform/navigation/hooks/useQuickActionsPalette.ts:49
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that provides state and data for the Quick Actions Command Palette.Registers the global hotkey (guarded against input focus).
- score: 4
hook useQuickDisposition
- file: src/platform/telephony/hooks/useQuickDisposition.ts:74
- kind: hook
- core: platform
- spec: (none)
- summary: Hook managing the Quick Disposition Wizard state machine:3-step flow (disposition → follow-up → notes), keyboard shortcuts, and batch mode.
- score: 4
hook useQuotaList
- file: src/platform/quota/hooks/useQuotaList.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches quota configurations visible to the given organization.
- params:
- organizationId — The organization to query quotas for.
- filters — Optional resource type and active status filters.
- score: 4
hook useRawData
- file: src/platform/data-manager/hooks/useRawData.ts:99
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing raw data.
- score: 1
hook useRawDataBatches
- file: src/platform/data-manager/hooks/useRawDataBatches.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Returns recent raw data batch saves for the given object, grouped by batch_id.
- score: 4
hook useRawDataEdit
- file: src/platform/data-manager/hooks/useRawDataEdit.ts:31
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing raw data edit state with standard + custom field support.
- score: 1
hook useRawDataExport
- file: src/platform/data-manager/hooks/useRawDataExport.ts:46
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing raw data export.
- score: 1
hook useRawDataFields
- file: src/platform/data-manager/hooks/useRawDataFields.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing raw data fields.
- score: 1
hook useRawDataImport
- file: src/platform/data-manager/hooks/useRawDataImport.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing raw data import.
- score: 1
hook useRawDataUndoRedo
- file: src/platform/data-manager/hooks/useRawDataUndoRedo.ts:31
- kind: hook
- core: platform
- spec: (none)
- summary: Manages an undo/redo stack for raw data cell edits.
- score: 4
hook useRealtimeAuditLogs
- file: src/platform/audit/useRealtimeAuditLogs.ts:32
- kind: hook
- core: platform
- spec: (none)
- summary: Subscribes to realtime INSERT events on .Returns a buffer of the most recent events (newest first).Clears the buffer when the active organization changes.
- score: 4
hook useRealtimeBroadcast
- file: src/platform/realtime/hooks/useRealtimeBroadcast.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for sending and receiving broadcast messages on a named channel.⚠️ PHI/PII WARNING: Broadcast payloads are transmitted in cleartext overWebSocket channels. Payloads MUST NOT contain PHI/PII (names, SSNs, DOBs,medical info, etc.). Use reference IDs only (e.g., )and let the consumer fetch sensitive data via authenticated queries.
- see:
- AGENTS.md §Security Requirements
- score: 1
hook useRealtimeContext
- file: src/platform/realtime/RealtimeProvider.tsx:26
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing realtime context.
- score: 1
hook useRealtimePresence
- file: src/platform/realtime/hooks/useRealtimePresence.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing realtime presence.
- score: 1
hook useRealtimeSubscription
- file: src/platform/realtime/hooks/useRealtimeSubscription.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing realtime subscription.
- score: 1
hook useRecentActivity
- file: src/platform/modules/useRecentActivity.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing recent activity.
- score: 1
hook useRecentCalls
- file: src/platform/telephony/hooks/useRecentCalls.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing recent calls.
- score: 1
hook useRecentlyVisited
- file: src/platform/navigation/hooks/useRecentlyVisited.ts:164
- kind: hook
- core: platform
- spec: (none)
- summary: Read-only recently-visited page list.Loads persisted entries from localStorage on mount (and when userId changes).Returns with the current path excluded (user is already there;navigating there is a no-op). Also exposes to wipe the list.Does NOT record — recording is handled by , whichmust be mounted app-wide in an always-on listener.No-ops gracefully when the user is not yet signed in.
- score: 4
hook useRecentPages
- file: src/platform/navigation/hooks/useRecentPages.ts:91
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing recent pages.
- score: 1
hook useRecommendedSkills
- file: src/platform/ai/hooks/useRecommendedSkills.ts:72
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the recommended standard skills for an org (consumes PF-62-EN-01 ranking).
- params:
- organizationId — Target org id.
- options — The org’s (+ jurisdiction pointer) driving the filter.
- returns: React Query result whose is the ranked [].
- score: 4
hook useRecordRecentlyVisited
- file: src/platform/navigation/hooks/useRecentlyVisited.ts:122
- kind: hook
- core: platform
- spec: (none)
- summary: App-wide recording primitive. Writes the current route to the per-userrecently-visited store on every distinct navigation.Mount exactly once in an always-on listener that is present for every route(e.g. NavAnalyticsListener). Returns nothing — side-effect only.No-ops gracefully when the user is not yet signed in.
- score: 4
hook useRecordThread
- file: src/platform/messaging/hooks/useRecordThread.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing record thread.
- score: 1
hook useReferencePicklist
- file: src/platform/picklists/hooks/useReferencePicklist.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches reference picklist items for a given domain with optional jurisdiction filtering. Uses internally (org resolved via OrganizationContext). When is provided, items are filtered to matching jurisdictions and state-specific items are sorted to the top.
- params:
- picklistName — One of the four reference picklist domains.
- options — Optional jurisdiction filter and activeOnly flag.
- returns: Object with (filtered/sorted items), , and .
- example: | const data: bodies, isLoading = useReferencePicklist(‘regulatory_bodies’, jurisdictionFilter: ‘AZ’ );
- score: 4
hook useRejectAiSkill
- file: src/platform/ai/hooks/useAiSkillLifecycle.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Reject an in_review skill back to draft (gates on pf.ai_skills.approve).
- score: 4
hook useRemoveEmployeeFromSharePoint
- file: src/platform/integrations/hooks/useEmployeeEntraMemberships.ts:239
- kind: hook
- core: platform
- spec: (none)
- summary: Manually remove employee from a SharePoint group
- score: 4
hook useRemoveEmployeeFromTeam
- file: src/platform/integrations/hooks/useEmployeeEntraMemberships.ts:160
- kind: hook
- core: platform
- spec: (none)
- summary: Manually remove employee from a Team
- score: 4
hook useRemoveIpAllowlist
- file: src/platform/security/hooks/useIpListMutations.ts:52
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing remove ip allowlist.
- score: 1
hook useRemoveIpBlocklist
- file: src/platform/security/hooks/useIpListMutations.ts:110
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing remove ip blocklist.
- score: 1
hook useRemoveThreadAgent
- file: src/platform/cowork/useThreads.ts:76
- kind: hook
- core: platform
- spec: (none)
- summary: Mark an agent’s participation in a thread as left.
- score: 4
hook useReportDefinition
- file: src/platform/reports/useReportDefinition.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing report definition.
- score: 1
hook useReportExecution
- file: src/platform/reports/useReportExecution.ts:62
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing report execution.
- score: 1
hook useReportExport
- file: src/platform/reports/hooks/useReportExport.ts:82
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for exporting report results.Supports CSV, JSON (client-side), PDF, and Excel (edge function).All exports are uploaded to the reports-exports bucket and theexecution record is updated with the file path and format.
- score: 1
hook useReportHistory
- file: src/platform/reports/useReportHistory.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing report history.
- score: 1
hook useReportList
- file: src/platform/reports/useReportList.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing report list.
- score: 1
hook useReportPermissions
- file: src/platform/reports/hooks/useReportPermissions.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches all permissions for a given report.
- score: 4
hook useReportRunDetails
- file: src/platform/reports/hooks/useReportRuns.ts:53
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing report run details.
- score: 1
hook useReportRuns
- file: src/platform/reports/hooks/useReportRuns.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing report runs.
- score: 1
hook useReportSchedules
- file: src/platform/reports/hooks/useReportSchedules.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing report schedules.
- score: 1
hook useReportTemplateCopy
- file: src/platform/reports/useReportTemplateCopy.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing report template copy.
- score: 1
hook useResetTheme
- file: src/platform/theming/hooks/useTenantTheme.ts:142
- kind: hook
- core: platform
- spec: (none)
- summary: Reset the active theme to spec defaults.
- score: 4
hook useResolvedSurfaceBlocks
- file: src/platform/clinical/blocks/useResolvedSurfaceBlocks.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: React Query hook for a surface’s resolved block set; disabled until org + surface are known.
- score: 4
hook useResolveThread
- file: src/platform/cowork/useThreads.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Resolve a thread’s SoT view (conversation, org, primary agent, active participants).
- score: 4
hook useResolveVendor
- file: src/platform/transcription/admin/hooks/useTranscriptionVendors.ts:199
- kind: hook
- core: platform
- spec: (none)
- summary: Resolver preview — calls so therouting dialog can show the live winning rule.
- score: 4
hook useResourceQuota
- file: src/platform/quota/hooks/useResourceQuota.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Checks a resource quota for the current org via the database RPC.
- params:
- options — Organization, resource type, and optional requested amount.
- returns: Quota state with allowed/remaining and a manual checkQuota function.
- score: 4
hook useResourceUsage
- file: src/platform/quota/hooks/useResourceUsage.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches resource usage records for an organization.
- params:
- organizationId — The organization to query usage for.
- filters — Optional resource type and aggregation period filters.
- score: 4
hook useRestoreLayoutVersion
- file: src/platform/page-layouts/hooks/useRestoreLayoutVersion.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Restore a layout from a version snapshot via edge function.
- score: 4
hook useRestoreRecord
- file: src/platform/admin/hooks/useDeletedRecordMutation.ts:33
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing restore record.
- score: 1
hook useRestoreWizardVersion
- file: src/platform/wizards/hooks/useWizardVersionMutation.ts:70
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for restoring a wizard template to a previous version
- score: 1
hook useRetentionPolicies
- file: src/platform/data-retention/hooks/useRetentionPolicies.ts:12
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing retention policies.
- score: 1
hook useRetrySyncEvent
- file: src/platform/org-data-sync/hooks/useRetrySyncEvent.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing retry sync event.
- score: 1
hook useRevertBatch
- file: src/platform/data-manager/hooks/useRevertBatch.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook to revert a previously saved raw data batch.
- score: 4
hook useRevokeApiKey
- file: src/platform/api-access/hooks/useApiKeyMutations.ts:82
- kind: hook
- core: platform
- spec: (none)
- summary: Revokes an API key by setting status to ‘revoked’ and recording revocation metadata.
- score: 4
hook useRevokeRolePermission
- file: src/platform/permissions/hooks/useRolePermissions.ts:77
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to revoke a permission from a role
- score: 4
hook useRingCentralConfig
- file: src/platform/integrations/hooks/useRingCentralConfig.ts:57
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for accessing RingCentral configuration and extension mappings.
- example: | const config, extensionMappings, isLoading = useRingCentralConfig();
- score: 1
hook useRingCentralExtensions
- file: src/platform/telephony/hooks/useRingCentralExtensions.ts:35
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing RingCentral extension mappings
- score: 1
hook useRingCentralSetup
- file: src/platform/telephony/hooks/useRingCentralSetup.ts:79
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that manages RingCentral webhook subscription lifecycle (status, connect, disconnect, test) for the current organization.
- returns: An object with the current subscription state, status helpers, loading/error state, refetch function, and mutation triggers: - — the current or - — when a subscription exists and its status is - — when a subscription exists and its status is - — while the status query is loading - — query error object if the status query failed - — function to re-run the status query - — function to initiate connection (mutation) - — while the connect mutation is pending - — function to initiate disconnection (mutation) - — while the disconnect mutation is pending - — function to run a credentials test (mutation) - — while the test mutation is pending
- example: | // Usage within a React componentconst subscription, isConnected, isLoading, connect, isConnecting, disconnect, isDisconnecting, testConnection, isTesting, = useRingCentralSetup();
- score: 4
hook useRoleAssignees
- file: src/platform/permissions/hooks/useRoleAssignments.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch users assigned to a custom role
- score: 4
hook useRoleAssignmentActions
- file: src/platform/permissions/hooks/useRoleAssignmentActions.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Utility hook for role assignment actions with toast feedback.
- score: 4
hook useRoleBasedDefaults
- file: src/platform/navigation/hooks/useRoleBasedDefaults.ts:52
- kind: hook
- core: platform
- spec: (none)
- summary: Returns suggested default shortcuts based on the user’s module access.If the user only has access to 1-2 modules, returns a preset that putsthe primary module first. If the user has broad access (3+ modules),returns the standard platform defaults.
- score: 4
hook useRolePermissions
- file: src/platform/permissions/hooks/useRolePermissions.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to fetch permissions for a custom role
- example: | const data: rolePerms, isLoading = useRolePermissions(roleId);
- score: 4
hook useRollbackAiSkill
- file: src/platform/ai/hooks/useAiSkillLifecycle.ts:34
- kind: hook
- core: platform
- spec: (none)
- summary: Roll a skill back to a prior version (writes a new forward version; regulated → re-enters in_review).
- score: 4
hook useRollbackBatch
- file: src/platform/import/hooks/useImportRollback.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Rollback a single import batch — marks batch as rolled_back and records as skipped.
- score: 4
hook useRollbackStep
- file: src/platform/import/hooks/useImportRollback.ts:54
- kind: hook
- core: platform
- spec: (none)
- summary: Rollback all batches linked to a specific onboarding step (by step_number).
- score: 4
hook useRollbackTemplateAssignment
- file: src/platform/provisioning/hooks/useRollbackTemplateAssignment.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Rolls back a template assignment (status → rolled_back).Only available within 24 hours of applied_at.
- score: 4
hook useRotateApiKey
- file: src/platform/api-access/hooks/useApiKeyMutations.ts:125
- kind: hook
- core: platform
- spec: (none)
- summary: Rotates an API key: creates a new key and marks the old key as ‘rotating’with a grace period during which both keys are valid.
- score: 4
hook useRowGrouping
- file: src/platform/table-v2/hooks/useRowGrouping.ts:100
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing row grouping in TanStack Table
- score: 1
hook useRunDeduplication
- file: src/platform/import/hooks/useDeduplication.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook that runs deduplication on a batch’s records.1. Fetches all records for the batch.2. Runs the matching engine.3. Updates flagged records with duplicate_of, duplicate_confidence, status=‘duplicate’.
- params:
- organizationId — Current org ID.
- score: 4
hook useSaveConnectionMutation
- file: src/platform/settings/pages/data-migration/hooks/useDataMigrationConnections.ts:68
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing save connection mutation.
- score: 1
hook useSaveJurisdictionOverrides
- file: src/platform/jurisdiction/hooks/useJurisdictionConfigMutation.ts:70
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation to save overrides on the current org’s jurisdiction config.
- score: 4
hook useSaveMappingMutation
- file: src/platform/settings/pages/data-migration/hooks/useDataMigrationMappings.ts:44
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing save mapping mutation.
- score: 1
hook useScreeningFunnelMetrics
- file: src/platform/ce/useScreeningFunnelMetrics.ts:27
- kind: hook
- core: platform
- spec: (none)
- summary: Aggregates screening funnel metrics for the organization.
- params:
- organizationId — Org scope
- dateRange — Optional date range filter
- score: 4
hook useScreeningQueue
- file: src/platform/ce/useScreeningQueue.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches recent screening attempts for the screening queue.
- params:
- organizationId — Org scope
- options — Optional filters (limit, status)
- score: 4
hook useSearch
- file: src/platform/search/hooks.ts:43
- kind: hook
- core: platform
- spec: (none)
- summary: Generic search hook for querying Supabase tables with debouncing,ILIKE pattern matching, and optional full-text search. T - The expected type of search results
- params:
- options — Search configuration options
- returns: Search results with loading and error states
- example: | // Basic ILIKE searchconst results, isLoading = useSearchUser( query: searchTerm, table: ‘pf_profiles’, fields: [‘first_name’, ‘last_name’, ‘email’], organizationId: currentOrg.id,); // Full-text search with vector columnconst results = useSearchDocument( query: searchTerm, table: ‘pf_documents’, fields: [], useFullTextSearch: true, searchVectorColumn: ‘search_vector’, organizationId: currentOrg.id,);
- score: 4
hook useSearchHistory
- file: src/platform/navigation/useSearchHistory.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing search history.
- score: 1
hook useSearchSharePoint
- file: src/platform/integrations/hooks/useSharePointDocuments.ts:134
- kind: hook
- core: platform
- spec: (none)
- summary: Provides search share point queries and mutation actions scoped to the current organization.
- score: 4
hook useSectionMutation
- file: src/platform/page-layouts/hooks/useSectionMutation.ts:27
- kind: hook
- core: platform
- spec: (none)
- summary: Hook providing mutations for page layout section CRUD operations.
- example: | const createSection, updateSection, deleteSection = useSectionMutation();await createSection.mutateAsync( layout_id: ‘layout-123’, section_name: ‘Basic Information’, columns: 2,);
- score: 4
hook useSecurityAlertConfigList
- file: src/platform/security/hooks/useSecurityAlertConfigList.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing security alert config list.
- score: 1
hook useSecurityEventsList
- file: src/platform/security/hooks/useSecurityEventsList.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing security events list.
- score: 1
hook useSeedOrgKnowledge
- file: src/platform/knowledge/hooks/use-seed-org-knowledge.ts:94
- kind: hook
- core: platform
- spec: (none)
- summary: Guided org-knowledge seeding service.Returns the two org_profile seeding branches (import / author) and the publish helper,composed from the existing knowledge CRUD hooks — no new mutation iswritten here. All writes inherit scoping from the underlying hooks( / use ).
- returns: A with , , , and .
- example: | const createDraftFromDocument, publishOrgProfile = useSeedOrgKnowledge();const draft = await createDraftFromDocument( documentId, content );// …admin edits draft.content…await publishOrgProfile(draft.id);
- score: 4
hook useSeedTranscriptionSession
- file: src/platform/transcription/hooks/useSeedTranscriptionSession.ts:60
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation that creates one synthetic transcription session and transcriptsegment set for the active organization. The generated content is explicitlynon-PHI and intended only for QA/E2E walkthroughs.
- score: 4
hook useSelectedRows
- file: src/platform/table-v2/features/RowSelection.tsx:171
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to get selected rows from a table.
- params:
- table — TanStack table instance
- returns: Array of selected row data
- score: 4
hook useSendMessage
- file: src/platform/messaging/hooks/useSendMessage.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing send message.
- score: 1
hook useServerTable
- file: src/platform/table-v2/features/useServerTable.ts:152
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for server-side table data fetching with TanStack Table.Combines TanStack Table state management with React Query for data fetching.Follows project patterns for staleTime and gcTime. T - Row data type
- params:
- options — Server table options
- returns: Server table state and handlers
- score: 1
hook useServiceAccountList
- file: src/platform/api-access/hooks/useServiceAccountList.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the list of service accounts for the current organization.
- returns: TanStack Query result with service account rows
- score: 4
hook useSessionHeartbeat
- file: src/platform/sessions/hooks/useSessionHeartbeat.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing session heartbeat.
- score: 1
hook useSessionRecorder
- file: src/platform/analytics/useSessionRecorder.tsx:282
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to access session recorder
- returns: Session recorder controls and state
- score: 4
hook useSessionsList
- file: src/platform/sessions/hooks/useSessionsList.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing sessions list.
- score: 1
hook useSetPortalFlowEnabled
- file: src/platform/automation/portal/hooks.ts:123
- kind: hook
- core: platform
- spec: (none)
- summary: Enable (or disable) a flow. Enabling requires the portal ToS to be and stamps the tenant’s acknowledgement (AC-1 / AC-4). Server-side RLS limitsthis to org_admin and the dispatch edge re-checks the gate.
- score: 4
hook useSetProfilePhoto
- file: src/platform/headshot/hooks/useSetProfilePhoto.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Sets a headshot result as the user’s profile photo.Updates the result’s is_profile_photo flag and the user’s pf_profiles.avatar_url.
- score: 4
hook useSetRolePermissions
- file: src/platform/permissions/hooks/useSetRolePermissions.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to batch update permissions for a role
- score: 4
hook useSettingsAudit
- file: src/platform/settings/useSettingsAudit.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing settings audit.
- score: 1
hook useSettingsSaveShortcut
- file: src/platform/settings/hooks/useSettingsSaveShortcut.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Binds Cmd+S / Ctrl+S to when enabled (typically when the settings form is dirty).
- score: 4
hook useSetupStatus
- file: src/platform/setup/hooks/useSetupStatus.ts:59
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing setup status.
- score: 1
hook useSharePointConfig
- file: src/platform/integrations/hooks/useSharePointConfig.ts:61
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch department-to-SharePoint group mappings for organization
- score: 4
hook useSharePointConfigMutation
- file: src/platform/integrations/hooks/useSharePointConfig.ts:94
- kind: hook
- core: platform
- spec: (none)
- summary: CRUD mutations for SharePoint configuration
- score: 4
hook useSharePointDocuments
- file: src/platform/integrations/hooks/useSharePointDocuments.ts:26
- kind: hook
- core: platform
- spec: (none)
- summary: Provides share point documents queries and mutation actions scoped to the current organization.
- score: 4
hook useSharePointDownloadUrl
- file: src/platform/integrations/hooks/useSharePointDocuments.ts:84
- kind: hook
- core: platform
- spec: (none)
- summary: Provides share point download url queries and mutation actions scoped to the current organization.
- score: 4
hook useSidebarGroupState
- file: src/platform/navigation/hooks/useSidebarGroupState.ts:66
- kind: hook
- core: platform
- spec: (none)
- summary: Custom hook for managing sidebar group expansion state with localStorage persistence.Features:- Persists state per module to localStorage- Auto-opens groups containing active routes- Maintains user preferences across sessions
- score: 4
hook useSignature
- file: src/platform/signatures/useSignature.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing signature.
- score: 1
hook useSignatureNotifications
- file: src/platform/signatures/hooks/useSignatureNotifications.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for creating signature-related notifications.In-app notifications are created via database triggers for status changes.This hook provides additional manual notification capabilities.
- score: 1
hook useSignatureRequest
- file: src/platform/signatures/hooks/useSignatureRequest.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing signature request.
- score: 1
hook useSignatureRequests
- file: src/platform/signatures/hooks/useSignatureRequests.ts:27
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing signature requests.
- score: 1
hook useSiteBusinessHours
- file: src/platform/sites/hooks/useSiteBusinessHours.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Read the seven weekday rows for a site, defaulting missing days to “closed”.
- score: 4
hook useSiteCensus
- file: src/platform/census/useCensusData.ts:109
- kind: hook
- core: platform
- spec: (none)
- summary: Get census count for a specific site
- score: 4
hook useSiteList
- file: src/platform/sites/hooks/useSiteList.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing site list.
- score: 1
hook useSiteTimezone
- file: src/platform/timezone/useSiteTimezone.ts:30
- kind: hook
- core: platform
- spec: (none)
- params:
- siteId — Site to resolve; when omitted/unknown the org default (then the platform default) is used.
- score: 1
hook useSkillApprovalQueue
- file: src/platform/ai/hooks/useSkillApprovalQueue.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Returns the current organization’s AI skills awaiting approval (lifecycle_status = ‘in_review’). Queries filtered to the current org’s non-system rows,tagging each with whether its category is regulated (mandatory second-person approval). Returnsan empty list when there is no organization context.
- returns: An object with the array, , , and a callback.
- score: 4
hook useSkillLifecycleMutations
- file: src/platform/ai/hooks/useSkillLifecycleMutations.ts:73
- kind: hook
- core: platform
- spec: (none)
- summary: Provides the four governed AI-skill lifecycle mutations backed by SECURITY DEFINER RPCs.Each mutation sanitizes its error, surfaces a toast, and invalidates the approval-queue,version-history, and skills caches on success so the UI reflects the new lifecycle state.
- returns: Mutation callbacks (///) and per-action pending flags.
- score: 4
hook useSkillTest
- file: src/platform/ai/wizards/ai-skill-creation/hooks/useSkillTest.ts:65
- kind: hook
- core: platform
- spec: (none)
- summary: Author-time test runner for the draft skill prompt (AC-4).
- returns: (one invocation), the latest , and an flag.
- score: 4
hook useSkillUsageStats
- file: src/platform/ai/hooks/useSkillUsageStats.ts:49
- kind: hook
- core: platform
- spec: (none)
- summary: Retrieves aggregated AI skill usage statistics for the active organization over a date range.
- params:
- options — Optional query configuration, including time window (, ),optional module filtering (), and whether the query should run ().
- returns: Aggregated usage data and query state via , includingper-skill stats (), totals/rates (, , ),loading/error flags (, ), and a handler. Values update when queryinputs change and when React Query refetches.
- score: 4
hook useSLA
- file: src/platform/sla/hooks/useSLA.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches active SLA instances for a specific entity (entity-level indicator).
- score: 4
hook useSLAActions
- file: src/platform/sla/hooks/useSLAActions.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Returns mutation functions for SLA instance actions (pause, resume, extend).
- score: 4
hook useSLAComplianceReport
- file: src/platform/health/hooks/useSLAComplianceReport.ts:103
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing slacompliance report.
- score: 1
hook useSLADashboard
- file: src/platform/sla/hooks/useSLADashboard.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches aggregated SLA dashboard statistics.
- score: 4
hook useSLADefinition
- file: src/platform/sla/hooks/useSLADefinitions.ts:48
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches a single SLA definition by ID.
- score: 4
hook useSLADefinitions
- file: src/platform/sla/hooks/useSLADefinitions.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches all SLA definitions for an organization.
- score: 4
hook useSLAInstance
- file: src/platform/sla/hooks/useSLAInstances.ts:68
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches a single SLA instance by ID.
- score: 4
hook useSLAInstances
- file: src/platform/sla/hooks/useSLAInstances.ts:32
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches SLA instances for an organization with optional filters.
- score: 4
hook useSLAThresholds
- file: src/platform/health/hooks/useSLAThresholds.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing slathresholds.
- score: 1
hook useSLAViolations
- file: src/platform/health/hooks/useSLAViolations.ts:19
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing slaviolations.
- score: 1
hook useSnoozeInboxItem
- file: src/platform/inbox/hooks/useInboxSnoozes.ts:66
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing snooze inbox item.
- score: 1
hook useSortableTable
- file: src/platform/table-v2/hooks/useSortableTable.ts:79
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing table sorting state with PF-57 compatibility.
- params:
- options — Sorting options
- returns: Sorting state and handlers
- score: 1
hook useStartAssistantThread
- file: src/platform/ai/hooks/useStartAssistantThread.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Call pf_start_assistant_thread to create a private assistant conversation.Returns the conversation_id and thread_id.
- score: 4
hook useStarterRoles
- file: src/platform/permissions/hooks/useStarterRoles.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to batch create starter roles with permission assignments
- score: 4
hook useStartMigration
- file: src/platform/settings/pages/data-migration/hooks/useDataMigrationRuns.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing start migration.
- score: 1
hook useStepBatches
- file: src/platform/import/hooks/useOnboardingStepBatches.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: List step-batch junction rows for an onboarding session.
- score: 4
hook useStepFieldManager
- file: src/platform/wizards/hooks/useStepFieldManager.ts:65
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing step field manager.
- score: 1
hook useStoreCredential
- file: src/platform/credentials/hooks/useStoreCredential.ts:28
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook that stores a credential in the PF-76 vault for the active org.Returns the new .
- score: 4
hook useSubmitAiSkill
- file: src/platform/ai/hooks/useAiSkillLifecycle.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Submit a skill for activation/review (regulated → in_review; non-regulated, non-import → self-activate).
- score: 4
hook useSubmitApprovalRequest
- file: src/platform/approvals/hooks/useSubmitApprovalRequest.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing submit approval request.When FW-54 routing is enabled for the org, this hook evaluatesrouting rules before insert and may override the provided chainId.
- score: 1
hook useSubscriptionDiagnostics
- file: src/platform/notifications/hooks/useSubscriptionDiagnostics.ts:59
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing subscription diagnostics.
- score: 1
hook useSubtasks
- file: src/platform/tasks/hooks/useSubtasks.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for listing the direct subtasks of a parent task.Returns subtasks ordered by sort_order then created_at.
- score: 1
hook useSuggestSections
- file: src/platform/templates/hooks/useSuggestSections.ts:31
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook that suggests document template sections for a given template type.
- returns: useMutation result with helper and loading/error state.
- score: 4
hook useSwimLaneDiagram
- file: src/platform/workflow/useSwimLaneDiagram.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing swim lane diagram.
- score: 1
hook useSwimLaneDiagramList
- file: src/platform/workflow/useSwimLaneDiagramList.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing swim lane diagram list.
- score: 1
hook useSwimLaneDiagramMutation
- file: src/platform/workflow/useSwimLaneDiagramMutation.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing swim lane diagram mutation.
- score: 1
hook useSwimLaneDiagramVersions
- file: src/platform/workflow/useSwimLaneDiagramVersions.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches version history for a diagram, ordered newest first.
- score: 4
hook useSwimLaneTemplates
- file: src/platform/workflow/useSwimLaneTemplates.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches available diagram templates (platform + org-scoped).
- params:
- organizationId — Current org context
- score: 4
hook useSwipeActions
- file: src/platform/gestures/hooks/useSwipeActions.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing swipe actions.
- score: 1
hook useSwipeToDismiss
- file: src/platform/gestures/hooks/useSwipeToDismiss.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing swipe to dismiss.
- score: 1
hook useSyncEventsList
- file: src/platform/org-data-sync/hooks/useSyncEventsList.ts:12
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing sync events list.
- score: 1
hook useSyncLeaveRequest
- file: src/platform/integrations/hooks/useCalendarSyncConfig.ts:177
- kind: hook
- core: platform
- spec: (none)
- summary: Trigger sync for a single leave request
- score: 4
hook useSyncSharePointMemberships
- file: src/platform/integrations/hooks/useSharePointConfig.ts:239
- kind: hook
- core: platform
- spec: (none)
- summary: Trigger bulk sync of SharePoint memberships
- score: 4
hook useSyncTeamsMemberships
- file: src/platform/integrations/hooks/useTeamsConfig.ts:239
- kind: hook
- core: platform
- spec: (none)
- summary: Trigger bulk sync of Teams memberships
- score: 4
hook useSystemTemplates
- file: src/platform/wizards/hooks/useSystemTemplates.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing system templates.
- score: 1
hook useTableExport
- file: src/platform/table-v2/hooks/useTableExport.ts:142
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for exporting TanStack Table data to CSV or Excel
- score: 1
hook useTableLookup
- file: src/platform/data-lookup/useTableLookup.ts:32
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for dynamically fetching lookup options from database tables.Security features:- Table whitelist enforcement- Automatic organization_id filtering for multi-tenant tables- RLS policy compliance
- example: | const options, isLoading = useTableLookup( table: ‘hr_departments’, organizationId: currentOrgId, filters: is_active: true );
- score: 1
hook useTablePreferences
- file: src/platform/table-v2/hooks/useTablePreferences.ts:122
- kind: hook
- core: platform
- spec: (none)
- summary: Unified table preferences: column order, visibility, and widths.Persists to localStorage under .Debounces writes by 300ms.
- score: 4
hook useTableUrlState
- file: src/platform/router/useTableUrlState.ts:67
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing table url state.
- score: 1
hook useTabUrlState
- file: src/platform/tabs/useTabUrlState.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Returns validated, URL-synced tab state. If the URL param is not in validTabs,returns defaultValue and syncs the URL to the default (via useEffect).
- params:
- paramName — Query param name (e.g. ‘tab’)
- validTabs — Readonly array of allowed tab values
- defaultValue — Tab to use when param is missing or invalid
- returns: [activeTab, setTab] - activeTab is typed as union of validTabs; setTab updates URL
- score: 4
hook useTask
- file: src/platform/tasks/hooks/useTask.ts:22
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task.
- score: 1
hook useTaskAnalytics
- file: src/platform/tasks/hooks/useTaskAnalytics.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task analytics.
- score: 1
hook useTaskAutomationRuleMutation
- file: src/platform/tasks/hooks/useTaskAutomationRuleMutation.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task automation rule mutation.
- score: 1
hook useTaskAutomationRules
- file: src/platform/tasks/hooks/useTaskAutomationRules.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task automation rules.
- score: 1
hook useTaskChildCounts
- file: src/platform/tasks/hooks/useTaskChildCounts.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook returning subtask and checklist item counts for a task.
- score: 4
hook useTaskCommentMutation
- file: src/platform/tasks/hooks/useTaskCommentMutation.ts:25
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task comment mutation.
- score: 1
hook useTaskComments
- file: src/platform/tasks/hooks/useTaskComments.ts:23
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task comments.
- score: 1
hook useTaskCompletionReport
- file: src/platform/tasks/hooks/useTaskCompletionReport.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task completion report.
- score: 1
hook useTaskDependencies
- file: src/platform/tasks/hooks/useTaskDependencies.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task dependencies.
- score: 1
hook useTaskDependencyMutation
- file: src/platform/tasks/hooks/useTaskDependencyMutation.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task dependency mutation.
- score: 1
hook useTaskMutation
- file: src/platform/tasks/hooks/useTaskMutation.ts:24
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task mutation.
- score: 1
hook useTaskOverdueReport
- file: src/platform/tasks/hooks/useTaskOverdueReport.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task overdue report.
- score: 1
hook useTaskReorder
- file: src/platform/tasks/hooks/useTaskReorder.ts:31
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that exposes a mutation for manual task prioritization.
- score: 4
hook useTasks
- file: src/platform/tasks/hooks/useTasks.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing tasks.
- score: 1
hook useTaskTemplateMutation
- file: src/platform/tasks/hooks/useTaskTemplateMutation.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task template mutation.
- score: 1
hook useTaskTemplates
- file: src/platform/tasks/hooks/useTaskTemplates.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task templates.
- score: 1
hook useTaskTimeEntries
- file: src/platform/tasks/hooks/useTaskTimeEntries.ts:11
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task time entries.
- score: 1
hook useTaskTimeEntryMutation
- file: src/platform/tasks/hooks/useTaskTimeEntryMutation.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing task time entry mutation.
- score: 1
hook useTeamsConfig
- file: src/platform/integrations/hooks/useTeamsConfig.ts:61
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch department-to-Teams mappings for organization
- score: 4
hook useTeamsConfigMutation
- file: src/platform/integrations/hooks/useTeamsConfig.ts:94
- kind: hook
- core: platform
- spec: (none)
- summary: CRUD mutations for Teams configuration
- score: 4
hook useTeamsNotificationConfig
- file: src/platform/integrations/hooks/useTeamsNotificationConfig.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing teams notification config.
- score: 1
hook useTeamsNotificationConfigMutation
- file: src/platform/integrations/hooks/useTeamsNotificationConfig.ts:64
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing teams notification config mutation.
- score: 1
hook useTelehealthSessionsByPmIds
- file: src/platform/clinical/telehealth/useTelehealthSessionsByPmIds.ts:32
- kind: hook
- core: platform
- spec: CL-24
- summary: Fetches CL-24 telehealth session summaries for a set of PM telehealthsession ids in one query, keyed by .
- params:
- pmSessionIds — Array of .
- score: 5
hook useTelephonySettings
- file: src/platform/telephony/hooks/useTelephonySettings.ts:46
- kind: hook
- core: platform
- spec: (none)
- summary: Platform hook for accessing telephony-related settings from CE module settings.
- score: 4
hook useTemplateCacheStats
- file: src/platform/templates/hooks/useTemplateCache.ts:142
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to get cache statistics for debugging
- score: 4
hook useTemplateDetail
- file: src/platform/page-layouts/hooks/useTemplates.ts:44
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing template detail.
- score: 1
hook useTemplateList
- file: src/platform/page-layouts/hooks/useTemplates.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing template list.
- score: 1
hook useTemplateSharing
- file: src/platform/templates/hooks/useTemplateSharing.ts:66
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing template sharing.
- score: 1
hook useTerminateAllSessions
- file: src/platform/sessions/hooks/useTerminateSession.ts:51
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing terminate all sessions.
- score: 1
hook useTerminateSession
- file: src/platform/sessions/hooks/useTerminateSession.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing terminate session.
- score: 1
hook useTestConnectionMutation
- file: src/platform/settings/pages/data-migration/hooks/useDataMigrationConnections.ts:124
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing test connection mutation.
- score: 1
hook useTestGoogleWorkspaceConnection
- file: src/platform/integrations/hooks/useGoogleWorkspaceConnection.ts:192
- kind: hook
- core: platform
- spec: (none)
- summary: Invoke the edge function for the active org.
- score: 4
hook useTestIntegration
- file: src/platform/integrations/hooks/useTestIntegration.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing test integration.
- score: 1
hook useTestScenarios
- file: src/platform/conditional-logic/hooks/useTestScenarios.ts:47
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing test scenarios with local storage persistence
- score: 1
hook useTestWebhook
- file: src/platform/integrations/hooks/useTestWebhook.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing test webhook.
- score: 1
hook useThemeList
- file: src/platform/theming/hooks/useTenantTheme.ts:59
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch all themes for the current organization (for theme list / management).
- score: 4
hook useToggleHeadshotFavorite
- file: src/platform/headshot/hooks/useToggleHeadshotFavorite.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Toggles the is_favorite flag on a headshot result with optimistic update.
- score: 4
hook useToggleRolePermission
- file: src/platform/permissions/hooks/useSetRolePermissions.ts:54
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to toggle a single permission for a role
- score: 4
hook useToggleValidationRuleActive
- file: src/platform/validation/hooks/useValidationRuleMutation.ts:70
- kind: hook
- core: platform
- spec: (none)
- summary: Toggle active status of a rule (deactivate/activate).
- score: 4
hook useTour
- file: src/platform/help/useTour.ts:70
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing tour.
- score: 1
hook useTranscriptionModuleSettings
- file: src/platform/transcription/admin/hooks/useTranscriptionVendors.ts:135
- kind: hook
- core: platform
- spec: (none)
- summary: Per-org transcription module settings (single row).
- score: 4
hook useTranscriptionVendorCredentials
- file: src/platform/transcription/admin/hooks/useTranscriptionVendors.ts:164
- kind: hook
- core: platform
- spec: (none)
- summary: Vault credentials available for linking to a vendor BAA. Filters rows whose matches the vendor’s (the existing PF-76 metadata convention). Org-scoped via RLS.Returns an empty list until a vendor is selected.
- score: 4
hook useTranscriptionVendors
- file: src/platform/transcription/admin/hooks/useTranscriptionVendors.ts:45
- kind: hook
- core: platform
- spec: (none)
- summary: Platform-global vendor catalog (STT, LLM, redaction).Cached aggressively (30 min) since it rarely changes.
- score: 4
hook useTransferUI
- file: src/platform/banking/providers/plaid/useTransferUI.ts:46
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for one-time Plaid Transfer UI: create intent, open Link, optionally fetch final status.Flow: createIntentAndOpen(params) → creates transfer intent → fetches link token with intent →opens Plaid Link → onSuccess uses metadata.transfer_status and optionally transfer/intent/getfor transfer_id and final status. - organizationId: Required. Organization ID for tenant isolation. - linkCustomizationName: Optional. Plaid Dashboard Link customization (Account Select one account). - onSuccess: Called with transfer_intent_id, transfer_status, and optional status/transfer_id from intent/get. - onError: Called on intent create, link token, or Link error. - onExit: Called when user exits Link without completing.
- score: 1
hook useTriggerComplianceChecks
- file: src/platform/compliance/hooks/useTriggerScans.ts:35
- kind: hook
- core: platform
- spec: (none)
- summary: Invokes the compliance-run-checks Edge Function for the given organization.
- score: 4
hook useTriggerEmployeeSync
- file: src/platform/integrations/hooks/useDirectorySyncConfig.ts:257
- kind: hook
- core: platform
- spec: (none)
- summary: Trigger sync for a single employee
- score: 4
hook useTriggerFullDirectorySync
- file: src/platform/integrations/hooks/useDirectorySyncConfig.ts:220
- kind: hook
- core: platform
- spec: (none)
- summary: Trigger full directory sync for all employees
- score: 4
hook useTriggerPhiScan
- file: src/platform/compliance/hooks/useTriggerScans.ts:10
- kind: hook
- core: platform
- spec: (none)
- summary: Invokes the compliance-phi-scan Edge Function for the given organization.
- score: 4
hook useTriggerProcessDiscovery
- file: src/platform/automation/hooks/useTriggerProcessDiscovery.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Triggers the edge function for the current organization.Invalidates the business processes list on success.
- returns: TanStack Mutation result containing .
- score: 4
hook useTrustDevice
- file: src/platform/sessions/hooks/useDeviceTrust.ts:14
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing trust device.
- score: 1
hook useTypingIndicator
- file: src/platform/messaging/hooks/useTypingIndicator.ts:28
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing typing indicator.
- score: 1
hook useUnassignRole
- file: src/platform/permissions/hooks/useRoleAssignments.ts:118
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to remove a role assignment from a user
- score: 4
hook useUnifiedInbox
- file: src/platform/inbox/useUnifiedInbox.ts:155
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing unified inbox.
- score: 1
hook useUninstallBundle
- file: src/platform/ai/hooks/useInstallBundle.ts:111
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook to uninstall a bundle via pf_uninstall_bundle.Removes all projected pf_tool_registry rows and flips status → uninstalled.Invalidates all [‘marketplace’] queries on success. PF-62-EN-02 AC-2
- score: 4
hook useUnlinkedEmployees
- file: src/platform/integrations/hooks/useEntraUnmatchedUsers.ts:68
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch unlinked employees that could be matched to an Entra user(employees with no entra_id set)
- score: 4
hook useUnmatchedEntraUsers
- file: src/platform/integrations/hooks/useEntraUnmatchedUsers.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch pending unmatched Entra users for the current organization
- score: 4
hook useUnpublishKnowledgeArticle
- file: src/platform/knowledge/hooks/use-knowledge-articles.ts:492
- kind: hook
- core: platform
- spec: (none)
- summary: Unpublishes a knowledge article by setting its status back to “draft”. Returns a React Query mutation hook that updates a knowledge article’s status to , sets to the current user, and synchronizes related query caches on success.
- returns: UseMutationResultKnowledgeArticle, Error, string A mutation hook where the mutation function accepts the article and resolves to the updated .
- example: | const unpublish = useUnpublishKnowledgeArticle();// Trigger unpublish for article with id ‘abc’unpublish.mutate(‘abc’);
- score: 4
hook useUnreadCount
- file: src/platform/notifications/useNotifications.ts:60
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing unread count.
- score: 1
hook useUnreadCounts
- file: src/platform/messaging/hooks/useUnreadCounts.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing unread counts.
- score: 1
hook useUnsavedChangesGuard
- file: src/platform/settings/hooks/useUnsavedChangesGuard.ts:28
- kind: hook
- core: platform
- spec: (none)
- summary: Registers for browser refresh/close when is true.Note: In-app navigation blocking via requires a data router(). This app uses , so only the guard is active; is always .
- returns: Guard state; pair with .
- score: 4
hook useUntrustDevice
- file: src/platform/sessions/hooks/useDeviceTrust.ts:53
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing untrust device.
- score: 1
hook useUnverifiedPhiClassifications
- file: src/platform/compliance/hooks/useUnverifiedPhiClassifications.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Lists unverified column classifications for the compliance drift detail sheet.
- score: 4
hook useUpdateAISkill
- file: src/platform/ai/hooks/useUpdateAISkill.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to update a custom AI skill within the current organization.Returns an API for performing an update of a non-system AI skill (scoped to the current organization), observing mutation state and any error.
- returns: An object containing:- — updates the skill with using the provided and resolves to the updated .- — while the update mutation is in progress.- — the last error produced by the mutation, or if none.
- example: | const updateSkill, isUpdating = useUpdateAISkill();await updateSkill(‘skill-123’, name: ‘Assistant’, description: ‘Updated desc’ );
- score: 4
hook useUpdateEmailSignature
- file: src/platform/email-signatures/hooks/useEmailSignatureMutation.ts:33
- kind: hook
- core: platform
- spec: (none)
- summary: Update an existing email signature.
- score: 4
hook useUpdateExportTemplate
- file: src/platform/export/hooks/useExportTemplates.ts:82
- kind: hook
- core: platform
- spec: (none)
- summary: Provides update export template queries and mutation actions scoped to the current organization.
- score: 4
hook useUpdateHeadshotCampaign
- file: src/platform/headshot/hooks/useHeadshotCampaigns.ts:114
- kind: hook
- core: platform
- spec: (none)
- summary: Updates a headshot campaign.
- score: 1
hook useUpdateImportBatch
- file: src/platform/import/hooks/useImportBatches.ts:89
- kind: hook
- core: platform
- spec: (none)
- summary: Update an existing import batch.
- score: 4
hook useUpdateKnowledgeArticle
- file: src/platform/knowledge/hooks/use-knowledge-articles.ts:320
- kind: hook
- core: platform
- spec: (none)
- summary: Returns a React Query mutation hook that updates fields of an existing knowledge article.The mutation accepts an object with the article and a partial containing any fields to update.
- returns: A mutation hook that performs the update and, on success, invalidates the article list cache and updates the article detail cache.
- example: | const updateArticle = useUpdateKnowledgeArticle();updateArticle.mutate( id: ‘article-id’, input: title: ‘New title’, tags: [‘tag1’] );
- score: 4
hook useUpdateLegalHold
- file: src/platform/data-retention/hooks/useLegalHolds.ts:58
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing update legal hold.
- score: 1
hook useUpdateMappingTemplate
- file: src/platform/import/hooks/useImportMappingTemplates.ts:72
- kind: hook
- core: platform
- spec: (none)
- summary: Update an existing mapping template.
- score: 4
hook useUpdateOnboardingSession
- file: src/platform/import/hooks/useOnboardingSessions.ts:88
- kind: hook
- core: platform
- spec: (none)
- summary: Update an existing onboarding session.
- score: 4
hook useUpdatePhiClassification
- file: src/platform/compliance/hooks/usePhiClassifications.ts:40
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation to update a PHI classification.
- score: 4
hook useUpdateProcessHealthSettings
- file: src/platform/automation/hooks/useProcessHealthSettings.ts:84
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation to update process health settings.
- returns: TanStack Mutation for updating .
- score: 4
hook useUpdateQuota
- file: src/platform/quota/hooks/useQuotaMutation.ts:59
- kind: hook
- core: platform
- spec: (none)
- summary: Update an existing resource quota.
- params:
- organizationId — Current org context (for cache invalidation).
- score: 4
hook useUpdateRecommendationStatus
- file: src/platform/navigation/workspaces/admin/useWorkspaceMutations.ts:282
- kind: hook
- core: platform
- spec: (none)
- summary: React Query mutation that accepts or dismisses an AI workspace suggestion bysetting its , scoped to the activeorganization. On success it invalidates the org’s recommendationsquery so the actioned row drops off the suggested-workspaces list, and toastsaccept/dismiss accordingly; throws “No active organization” if no org is set.
- score: 4
hook useUpdateReport
- file: src/platform/reports/useReportMutation.ts:82
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing update report.
- score: 1
hook useUpdateReportPermission
- file: src/platform/reports/hooks/useReportPermissions.ts:71
- kind: hook
- core: platform
- spec: (none)
- summary: Mutation hook for updating a report permission.
- score: 4
hook useUpdateRetentionPolicy
- file: src/platform/data-retention/hooks/useRetentionPolicies.ts:58
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing update retention policy.
- score: 1
hook useUpdateRole
- file: src/platform/permissions/hooks/useCustomRoles.ts:101
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to update an existing custom role
- score: 4
hook useUpdateSecurityAlertConfig
- file: src/platform/security/hooks/useSecurityAlertConfigMutation.ts:49
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing update security alert config.
- score: 1
hook useUpdateServiceAccount
- file: src/platform/api-access/hooks/useServiceAccountMutations.ts:61
- kind: hook
- core: platform
- spec: (none)
- summary: Updates an existing service account.
- score: 4
hook useUpdateSkillOverride
- file: src/platform/ai/hooks/useUpdateSkillOverride.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Provides helpers to create or update an organization-scoped AI skill override.The returned API exposes to upsert a row in for the current organization, and reactive state forthe in-flight mutation and last error.
- returns: The hook API:- : upserts and returns the created or updated .- : while the mutation is pending.- : the last mutation or .
- example: | const updateOverride, isUpdating, error = useUpdateSkillOverride();await updateOverride(‘skill-123’, custom_instructions: ‘Be concise’, model_preference: ‘gpt-4’ );
- score: 4
hook useUpdateSLADefinition
- file: src/platform/sla/hooks/useSLADefinitions.ts:96
- kind: hook
- core: platform
- spec: (none)
- summary: Updates an existing SLA definition.
- score: 4
hook useUpdateTemplateSharing
- file: src/platform/templates/hooks/useTemplateSharing.ts:130
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing update template sharing.
- score: 1
hook useUpdateValidationRule
- file: src/platform/validation/hooks/useValidationRuleMutation.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Update an existing validation rule.
- score: 4
hook useUpdateValidationSettings
- file: src/platform/validation/hooks/useValidationSettings.ts:43
- kind: hook
- core: platform
- spec: (none)
- summary: Update validation settings (upsert pattern).
- score: 4
hook useUpdateWorkspace
- file: src/platform/navigation/workspaces/admin/useWorkspaceMutations.ts:184
- kind: hook
- core: platform
- spec: (none)
- summary: React Query mutation that updates a workspace by id, scoped to the activeorganization (the predicate is defense-in-depth alongsideRLS) and re-stamping . Invalidates the org’s workspace query onsuccess; throws “No active organization” if no org is selected.
- score: 4
hook useUploadHeadshotPhoto
- file: src/platform/headshot/hooks/useUploadHeadshotPhotos.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Uploads a single source photo to the headshots bucket and records metadata.
- score: 4
hook useUploadToSharePoint
- file: src/platform/integrations/hooks/useSharePointDocuments.ts:51
- kind: hook
- core: platform
- spec: (none)
- summary: Provides upload to share point queries and mutation actions scoped to the current organization.
- score: 4
hook useUpsertChatbotConfig
- file: src/platform/chatbot/hooks/useChatbotConfig.ts:48
- kind: hook
- core: platform
- spec: (none)
- summary: Creates or updates the chatbot configuration (upsert on org_id unique constraint).
- score: 4
hook useUpsertGoogleWorkspaceConnection
- file: src/platform/integrations/hooks/useGoogleWorkspaceConnection.ts:96
- kind: hook
- core: platform
- spec: (none)
- summary: Create or update the org’s Google Workspace connection.
- score: 4
hook useUpsertRoleLicenseMapping
- file: src/platform/integrations/hooks/useEntraRoleLicenseMap.ts:91
- kind: hook
- core: platform
- spec: (none)
- summary: Upsert (by org+role) a single role → SKU mapping.
- score: 4
hook useUpsertTheme
- file: src/platform/theming/hooks/useTenantTheme.ts:87
- kind: hook
- core: platform
- spec: (none)
- summary: Upsert (create or update) the active theme for an organization.On first use, creates a default theme row; subsequently updates it.
- score: 4
hook useUserEmailSignature
- file: src/platform/email-signatures/hooks/useUserEmailSignature.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches the user’s personal email signature. Falls back to org defaultif no user-specific signature exists.
- score: 4
hook useUserRoleAssignments
- file: src/platform/permissions/hooks/useRoleAssignments.ts:154
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to get role assignments for a user
- score: 4
hook useUserSearch
- file: src/platform/documents/useUserSearch.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing user search.
- score: 1
hook useValidateShareToken
- file: src/platform/dashboard/hooks/useDashboardShares.ts:160
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing validate share token.
- score: 1
hook useValidationAnalyticsReport
- file: src/platform/validation/hooks/useValidationAnalyticsReport.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch aggregated failure counts per rule, sorted by failure count descending.Joins pf_validation_rule_executions with pf_validation_rules for rule name.
- score: 4
hook useValidationRuleDetail
- file: src/platform/validation/hooks/useValidationRuleDetail.ts:15
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch a single validation rule by ID, scoped to the given organization.
- params:
- ruleId — The rule UUID to fetch.
- organizationId — Organization scope for tenant isolation.
- score: 4
hook useValidationRules
- file: src/platform/wizards/hooks/useValidationRules.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing validation rules.
- score: 1
hook useValidationRulesList
- file: src/platform/validation/hooks/useValidationRulesList.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch validation rules for an organization, sorted by updated_at descending.
- score: 4
hook useValidationSettings
- file: src/platform/validation/hooks/useValidationSettings.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Read validation settings for an organization.Returns defaults when no settings row exists.
- score: 4
hook useVendorBaas
- file: src/platform/transcription/admin/hooks/useTranscriptionVendors.ts:65
- kind: hook
- core: platform
- spec: (none)
- summary: BAAs for the current org (joined with vendor display fields for table use).
- score: 4
hook useViolationsList
- file: src/platform/quota/hooks/useViolationsList.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches quota violation records for an organization.
- params:
- organizationId — The organization to query violations for.
- filters — Optional resource type, limit type, and date range filters.
- score: 4
hook useVirtualizedTable
- file: src/platform/table-v2/hooks/useVirtualizedTable.ts:120
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for virtualizing table rows for large datasets.
- score: 1
hook useVisibilityAndInactivityLockTrigger
- file: src/platform/auth/app-lock/useVisibilityAndInactivityLockTrigger.ts:38
- kind: hook
- core: platform
- spec: (none)
- summary: Monitors page visibility changes and user inactivity to determine when theapp should lock.
- score: 4
hook useVisibilityConditions
- file: src/platform/wizards/hooks/useVisibilityConditions.ts:66
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing visibility conditions.
- score: 1
hook useVisibilityRuleMutation
- file: src/platform/page-layouts/hooks/useVisibilityRules.ts:64
- kind: hook
- core: platform
- spec: (none)
- summary: CRUD mutations for visibility rules with 50-rule limit.
- score: 4
hook useVisibilityRules
- file: src/platform/page-layouts/hooks/useVisibilityRules.ts:29
- kind: hook
- core: platform
- spec: (none)
- summary: Fetch visibility rules for a layout.
- score: 4
hook useVisibleSteps
- file: src/platform/forms/hooks/useVisibleSteps.ts:32
- kind: hook
- core: platform
- spec: (none)
- summary: Hook that returns visible step numbers based on page conditions and form data.Steps are 1-indexed (step 1, step 2, etc.) to match user-facing display.
- params:
- pages — Array of form pages with optional conditional visibility
- formData — Current form data used to evaluate conditions
- score: 4
hook useWebhookDeliveries
- file: src/platform/integrations/hooks/useWebhookDeliveries.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing webhook deliveries.
- score: 1
hook useWidgetAnalytics
- file: src/platform/dashboard/hooks/useWidgetAnalytics.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing widget analytics.
- score: 1
hook useWidgetBackgroundSync
- file: src/platform/dashboard/hooks/useWidgetBackgroundSync.ts:32
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing widget background sync.
- score: 1
hook useWidgetCarouselMode
- file: src/platform/dashboard/hooks/useWidgetCarouselMode.tsx:24
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to detect when to use carousel mode vs grid modebased on screen size and optional user preferenceIncludes hydration safety to prevent layout shift during SSR
- score: 4
hook useWidgetData
- file: src/platform/dashboard/hooks/useWidgetData.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Read widget data through the pf_widget_query broker (server allowlist + org-verify + caller-JWT RLS). Plugins/custom widgets use this instead of a direct Supabase query.
- score: 4
hook useWidgetDataWithCache
- file: src/platform/dashboard/hooks/useWidgetDataWithCache.ts:45
- kind: hook
- core: platform
- spec: (none)
- summary: Hook implementing stale-while-revalidate pattern for widget data- Loads cached data instantly on mount- Fetches fresh data in background- Falls back to cache on network errors
- score: 4
hook useWidgetEnablement
- file: src/platform/dashboard/hooks/useWidgetEnablement.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Per-org widget enable/disable map from pf_module_settings.enabled_widgets. Default-ON: an absent key (or absent/malformed column) means the widget is enabled.
- score: 4
hook useWidgetRegistrySnapshot
- file: src/platform/dashboard/useWidgetRegistrySnapshot.ts:6
- kind: hook
- core: platform
- spec: (none)
- summary: Subscribe to the runtime widget registry (built-ins + registered plugins).
- score: 4
hook useWizardAnalytics
- file: src/platform/wizards/hooks/useWizardAnalytics.ts:69
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard analytics.
- score: 1
hook useWizardBuilder
- file: src/platform/wizards/hooks/useWizardBuilder.ts:18
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard builder.
- score: 1
hook useWizardDetail
- file: src/platform/page-layouts/hooks/useWizards.ts:45
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard detail.
- score: 1
hook useWizardDraft
- file: src/platform/forms/hooks/useWizardDraft.ts:62
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard drafts with progress tracking.Extends the standard form draft with wizard_progress column support.
- params:
- formId — The form ID to manage drafts for
- score: 1
hook useWizardDraft
- file: src/platform/wizards/hooks/useWizardDraft.ts:58
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard draft.
- score: 1
hook useWizardExecution
- file: src/platform/wizards/hooks/useWizardExecution.ts:98
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard execution.
- score: 1
hook useWizardFeatureFlags
- file: src/platform/wizards/hooks/useWizardFeatureFlags.ts:75
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to get wizard feature flags for the current organization
- score: 4
hook useWizardList
- file: src/platform/page-layouts/hooks/useWizards.ts:17
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard list.
- score: 1
hook useWizardLock
- file: src/platform/wizards/hooks/useWizardLock.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard lock.
- score: 1
hook useWizardMode
- file: src/platform/wizards/hooks/useWizardMode.ts:80
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to determine which wizard mode to use for a given module.
- params:
- module — The module to check (hr, rh, fw, fa)
- returns: Object with mode, loading state, and setMode function
- score: 4
hook useWizardMutation
- file: src/platform/page-layouts/hooks/useWizards.ts:74
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard mutation.
- score: 1
hook useWizardOrgDefaults
- file: src/platform/wizards/hooks/useWizardOrgDefaults.ts:86
- kind: hook
- core: platform
- spec: (none)
- summary: Fetches org-level wizard defaults for the current organization.Uses raw SQL query since pf_wizard_org_defaults is not in types.ts yet.
- score: 4
hook useWizardPreviewState
- file: src/platform/wizards/hooks/useWizardPreviewState.ts:34
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard preview state.
- score: 1
hook useWizardProgress
- file: src/platform/forms/hooks/useWizardProgress.ts:55
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard progress state and navigation.
- params:
- visibleSteps — Array of visible step numbers (from useVisibleSteps)
- initialProgress — Optional initial progress (for resuming drafts)
- allowStepNavigation — Whether users can freely navigate between steps
- score: 1
hook useWizardProgress
- file: src/platform/wizards/hooks/useWizardProgress.ts:39
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard progress.
- score: 1
hook useWizardSteps
- file: src/platform/field-config/hooks/useWizardSteps.ts:10
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard steps.
- score: 1
hook useWizardTemplateDetail
- file: src/platform/wizards/hooks/useWizardTemplateDetail.ts:13
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard template detail.
- score: 1
hook useWizardTemplateLock
- file: src/platform/wizards/hooks/useWizardTemplateLock.ts:56
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for advisory locking of a wizard template during editing.
- score: 1
hook useWizardTemplateMutation
- file: src/platform/wizards/hooks/useWizardTemplateMutation.ts:16
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard template mutation.
- score: 1
hook useWizardTemplates
- file: src/platform/wizards/hooks/useWizardTemplates.ts:20
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard templates.
- score: 1
hook useWizardVersion
- file: src/platform/wizards/hooks/useWizardVersions.ts:88
- kind: hook
- core: platform
- spec: (none)
- summary: Hook to get a specific version by ID
- score: 4
hook useWizardVersions
- file: src/platform/wizards/hooks/useWizardVersions.ts:50
- kind: hook
- core: platform
- spec: (none)
- summary: Hook for managing wizard versions.
- score: 1
hook useWorkflowEnqueue
- file: src/platform/workflow/useWorkflowEnqueue.ts:37
- kind: hook
- core: platform
- spec: (none)
- summary: Returns a mutation that enqueues an FW workflow execution through the platformseam. The current organization is used unless is supplied.
- score: 4
hook useWorkflowKeyboardShortcuts
- file: src/platform/workflow/useWorkflowKeyboardShortcuts.ts:54
- kind: hook
- core: platform
- spec: (none)
- summary: Keyboard shortcut hook for the swim lane diagram builder.Shortcuts:- Ctrl/Cmd+Z — Undo- Ctrl/Cmd+Shift+Z — Redo- Ctrl/Cmd+C — Copy selected nodes- Ctrl/Cmd+V — Paste copied nodes- Ctrl/Cmd+A — Select all content nodes- Delete/Backspace — Remove selected nodes and connected edges- +/= — Zoom in- - — Zoom out- 0 — Reset zoom to 100%- 1 — Fit view- ? or K — Open shortcut help
- score: 4
hook useWorkspaceNav
- file: src/platform/navigation/hooks/useWorkspaceNav.ts:31
- kind: hook
- core: platform
- spec: (none)
- summary: Resolve a workspace’s cross-core nav into an ordered [].Member cores are loaded on demand from the module-registry cache; while anyreferenced core is missing from the snapshot the hook reports .Group-level permission keys are checked via ; groupswithout a are always allowed (mirrors ‘sboolean/Record normalization for single-key vs array calls).
- score: 4
hook useWorkspaceNeedsAttention
- file: src/platform/navigation/workspaces/useWorkspaceNeedsAttention.ts:21
- kind: hook
- core: platform
- spec: (none)
- summary: Aggregates “needs attention” counters for a workspace hub.Currently returns an empty array — the per-core needs-attention sources(e.g. PM unsigned encounters, CL in-basket, FA denials) are wired inincrementally in a follow-up. This stays a real hook so those per-corehooks can be composed behind it later without changing the call sites.Safe for an undefined workspace (never throws).
- score: 4
Components
component AboutPage
- file: src/platform/settings/AboutPage.tsx:13
- kind: component
- core: platform
- spec: (none)
- summary: Utility for about page.
- score: 1
component AboutPanel
- file: src/platform/pwa/components/AboutPanel.tsx:14
- kind: component
- core: platform
- spec: (none)
- summary: Utility for about panel.
- score: 1
component ActivationRequestsPage
- file: src/platform/settings/ActivationRequestsPage.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Admin page for managing user activation requests.
- score: 2
component ActiveAlertsBanner
- file: src/platform/health/components/ActiveAlertsBanner.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for active alerts banner.
- score: 1
component ActiveEmployeesWidget
- file: src/platform/dashboard/plugins/active-employees/ActiveEmployeesWidget.tsx:14
- kind: component
- core: platform
- spec: (none)
- summary: Example vetted plugin widget. Reads the org’s active-employee count THROUGH thepf_widget_query broker (caller-JWT RLS + server-side allowlist) via useWidgetData —never a direct Supabase query. This is the reference for how a Phase-1 plugin consumesa real org-scoped, RLS’d table without being granted direct table access.
- score: 2
component AddExistingUserDialog
- file: src/platform/users/AddExistingUserDialog.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for add existing user dialog.
- score: 1
component AddFieldDialog
- file: src/platform/data-manager/components/AddFieldDialog.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Utility for add field dialog.
- score: 1
component AddPeopleDialog
- file: src/platform/users/AddPeopleDialog.tsx:47
- kind: component
- core: platform
- spec: (none)
- summary: Unified entry point for adding people to an organization.
- score: 2
component AddTaskButton
- file: src/platform/tasks/components/AddTaskButton.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Compact button that opens a task creation dialog with pre-filled source context.
- score: 2
component AdvancedQueryProfile
- file: src/platform/query-performance/components/AdvancedQueryProfile.tsx:119
- kind: component
- core: platform
- spec: (none)
- summary: Advanced profile section for a selected slow query log entry.
- score: 2
component AgentFormSheet
- file: src/platform/cowork/ui/AgentFormSheet.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Create/edit form for a pf_agents row, rendered in a Sheet.
- score: 2
component AgentRegistryPage
- file: src/platform/cowork/ui/AgentRegistryPage.tsx:94
- kind: component
- core: platform
- spec: (none)
- summary: Agent registry admin page (PF-124 Phase 1A).
- score: 2
component AgentRunStatusBadge
- file: src/platform/agents/components/AgentRunStatusBadge.tsx:46
- kind: component
- core: platform
- spec: (none)
- summary: Render a read-only semantic Badge for an agent Run’s lifecycle state.
- params:
- state — The to display; selects both the semantic Badge variant and the human-readable label. Display-only — the authoritative state lives in the DB enum and is written solely by the governed RPC (PF-125 FR-2).
- returns: A Badge element with the variant and label mapped from .
- score: 2
component AIAssistantInlineSkeleton
- file: src/platform/ai/widgets/skeletons/AIAssistantInlineSkeleton.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aiassistant inline skeleton.
- score: 1
component AIAssistantPanel
- file: src/platform/ai/components/AIAssistantPanel.tsx:112
- kind: component
- core: platform
- spec: (none)
- summary: Collapsible AI assistant panel with conversation history, skill selection, and message composer.Renders a sheet that displays a skill-aware chat UI with persisted conversations, auto-scrolling,and optional suggested prompts. Supports controlled or uncontrolled open state and lets userscreate/select/delete conversations and switch AI skills.Accessibility:- The trigger is a focusable button with an icon and label.- Conversation actions and message controls are keyboard-accessible.
- params:
- moduleContext — Optional module-scoped context used for conversation scoping and feature flags.
- systemPrompt — Deprecated legacy system prompt for backward compatibility; prefer skills instead.
- defaultSkillCode — Initial AI skill code to load into the skill-aware chat.
- title — Panel title shown in the header.
- triggerVariant — Visual variant for the trigger button (e.g., “outline”, “ghost”).
- triggerClassName — Additional CSS classes applied to the trigger button.
- placeholder — Placeholder text for the message input.
- suggestedPrompts — Optional list of prompt strings shown in the empty state for quick insertion.
- open — Controlled open state for the sheet; when provided the component operates in controlled mode.
- onOpenChange — Handler called when the open state should change (controlled mode).
- hideSkillSelector — When true, hides the skill selector in the header.
- returns: The rendered AI assistant panel React element.
- example: | AIAssistantPanel moduleContext= module: ‘editor’, feature: ‘code-assist’ defaultSkillCode=“code-helper” suggestedPrompts=[‘Explain this code’, ‘Refactor to be more readable’]/
- score: 4
component AICategorizer
- file: src/platform/ai/widgets/AICategorizer.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aicategorizer.
- score: 1
component AICategorizerSkeleton
- file: src/platform/ai/widgets/skeletons/AICategorizerSkeleton.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aicategorizer skeleton.
- score: 1
component AIDocumentAnalyzer
- file: src/platform/ai/widgets/AIDocumentAnalyzer.tsx:42
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aidocument analyzer.
- score: 1
component AIDocumentAnalyzerSkeleton
- file: src/platform/ai/widgets/skeletons/AIDocumentAnalyzerSkeleton.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aidocument analyzer skeleton.
- score: 1
component AIFeedbackButtons
- file: src/platform/ai/components/AIFeedbackButtons.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aifeedback buttons.
- score: 1
component AIGeneratedStepPreview
- file: src/platform/wizards/components/ai/AIGeneratedStepPreview.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aigenerated step preview.
- score: 1
component AIGeneratedWizardPreview
- file: src/platform/wizards/components/ai/AIGeneratedWizardPreview.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aigenerated wizard preview.
- score: 1
component AILoadingState
- file: src/platform/ai/components/AILoadingState.tsx:16
- kind: component
- core: platform
- spec: (none)
- summary: Utility for ailoading state.
- score: 1
component AIMappingSuggestionCell
- file: src/platform/ai/components/AIMappingSuggestionCell.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Render an AI mapping suggestion with confidence + rationale and an Accept button.Renders nothing when there is no suggested value (model declined).
- score: 2
component AIMessageBubble
- file: src/platform/ai/components/AIMessageBubble.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aimessage bubble.
- score: 1
component AiOnboardingLaunchCard
- file: src/platform/ai/components/onboarding/AiOnboardingLaunchCard.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Renders the AI onboarding launch card, or null when the admin lacks the permission orthe feature flag is off.
- score: 2
component AiOnboardingStepPlaceholder
- file: src/platform/ai/components/onboarding/AiOnboardingStepPlaceholder.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Informational placeholder shown when an AI-onboarding step is rendered by the generictemplate renderer (rather than the dedicated page).
- score: 2
component AiOnboardingWizardPage
- file: src/platform/ai/pages/AiOnboardingWizardPage.tsx:74
- kind: component
- core: platform
- spec: (none)
- summary: The org AI onboarding wizard page. Gated on permission + feature flag; renders the7-step WizardShell.
- score: 2
component AIQuickAction
- file: src/platform/ai/widgets/AIQuickAction.tsx:52
- kind: component
- core: platform
- spec: (none)
- summary: A single-click AI action button that sends a prompt to the serverless AI assistant and delivers the result callback.Sends a non-streaming POST to the AI endpoint using the current Supabase session access token, manages request timeout/abort, parses both JSON and SSE-style responses, and exposes simple loading/error/success UI states. - prompt: The prompt to send to the assistant. Can be a string or a function that returns a string. - label: Visible button label. - onResult: Callback invoked with the assistant’s aggregated text response when the request succeeds. - onError: Optional callback invoked with errors encountered during the request. - variant: Visual variant passed to the underlying Button (defaults to ‘default’). - size: Visual size passed to the underlying Button (defaults to ‘default’). - icon: Optional icon element displayed alongside the label when not loading. - disabled: If true, disables the button (defaults to false). - moduleContext: Optional contextual information included in the system prompt sent to the assistant. - loadingText: Text displayed while the request is in progress (defaults to ‘Processing…’). - className: Optional className passed to the Button for additional styling. - modelOverride: Optional model identifier to override the default model used by the AI endpoint.
- returns: The rendered Button element for triggering the AI quick action.
- example: | AIQuickAction prompt=“Summarize the following text…” label=“Summarize” onResult=(text) = console.log(text)/Accessibility:- The button sets aria-busy while a request is in progress.- Loading state replaces the label with a spinner and loading text; provide a clear for screen reader users.
- score: 5
component AIQuickActionSkeleton
- file: src/platform/ai/widgets/skeletons/AIQuickActionSkeleton.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aiquick action skeleton.
- score: 1
component AISkillCard
- file: src/platform/ai/components/AISkillCard.tsx:99
- kind: component
- core: platform
- spec: (none)
- summary: Renders a compact AI Skill card showing name, module, description, category, model, RAG and enabled state, and an action to configure or edit the skill.Displays a “Customized” indicator when the skill is overridden, a “Disabled” badge when the skill is disabled, and conditionally shows the module label and RAG badge. The action button text is “Edit” for custom skills and “Configure” otherwise.
- params:
- props — Component props - skill: The AISkill data to render (name, description, category, effective_model, module, is_enabled, is_overridden, use_rag, etc.) - onConfigure: Callback invoked when the Configure/Edit button is clicked - isCustom: When true, adjusts iconography and action label for custom skills
- example: | AISkillCard skill=skill onConfigure=() = openSkillEditor(skill.id) isCustom=true/Accessibility considerations:- The component presents interactive action via a Button element for keyboard and screen-reader access.- Visual badges convey status; ensure sufficient color contrast in themes for users with low vision.
- score: 4
component AISkillsListPage
- file: src/platform/ai/pages/AISkillsListPage.tsx:75
- kind: component
- core: platform
- spec: (none)
- summary: Renders the AI Skills settings page for browsing, searching, filtering, configuring,creating, editing, importing, and exporting AI skills.
- returns: The React element for the AI Skills management page.
- score: 2
component AISuggestionCard
- file: src/platform/ai/components/AISuggestionCard.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aisuggestion card.
- score: 1
component AISummarizer
- file: src/platform/ai/widgets/AISummarizer.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aisummarizer.
- score: 1
component AISummarizerSkeleton
- file: src/platform/ai/widgets/skeletons/AISummarizerSkeleton.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aisummarizer skeleton.
- score: 1
component AITemplateSuggestionSheet
- file: src/platform/templates/components/AITemplateSuggestionSheet.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Sheet component for AI-powered template generation from a natural language description. - children: Trigger element (button) to open the sheet.
- score: 2
component AIToolChain
- file: src/platform/ai/widgets/AIToolChain.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aitool chain.
- score: 1
component AIToolChainSkeleton
- file: src/platform/ai/widgets/skeletons/AIToolChainSkeleton.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aitool chain skeleton.
- score: 1
component AIUnavailableBanner
- file: src/platform/ai/components/AIUnavailableBanner.tsx:69
- kind: component
- core: platform
- spec: (none)
- summary: Semantic banner shown when AI is unavailable or degraded.Adapts its icon, colour token, and CTA to the from .
- score: 5
component AIWizardGenerator
- file: src/platform/wizards/components/AIWizardGenerator.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Utility for aiwizard generator.
- score: 1
component AlertConfigForm
- file: src/platform/health/components/AlertConfigForm.tsx:66
- kind: component
- core: platform
- spec: (none)
- summary: Utility for alert config form.
- score: 1
component AlertConfigList
- file: src/platform/health/components/AlertConfigList.tsx:59
- kind: component
- core: platform
- spec: (none)
- summary: Utility for alert config list.
- score: 1
component AlertConfigPage
- file: src/platform/health/pages/AlertConfigPage.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for alert config page.
- score: 1
component AlertHistoryList
- file: src/platform/health/components/AlertHistoryList.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Utility for alert history list.
- score: 1
component AlertHistoryPage
- file: src/platform/health/pages/AlertHistoryPage.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for alert history page.
- score: 1
component AnalyticsStatCards
- file: src/platform/wizards/components/analytics/AnalyticsStatCards.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for analytics stat cards.
- score: 1
component AnomalyAlertsSettingsSection
- file: src/platform/query-performance/components/AnomalyAlertsSettingsSection.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Anomaly detection configuration section for query performance settings.
- score: 2
component ApiAccessPage
- file: src/platform/api-access/pages/ApiAccessPage.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Main API Access settings page with Service Accounts tab.
- score: 2
component ApiActivityTab
- file: src/platform/api-access/components/ApiActivityTab.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: Renders paginated audit trail table for API access events.
- score: 2
component ApiKeySecretDialog
- file: src/platform/api-access/components/ApiKeySecretDialog.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Confirmation dialog showing the raw secret after key creation.
- score: 2
component ApiKeyTable
- file: src/platform/api-access/components/ApiKeyTable.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Table of API keys for a service account.
- score: 2
component AppLauncher
- file: src/platform/modules/AppLauncher.tsx:13
- kind: component
- core: platform
- spec: (none)
- summary: Utility for app launcher.
- score: 1
component AppLockGate
- file: src/platform/auth/app-lock/AppLockGate.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Gate component that overlays the lock screen when the app is locked.Reads lock state from AppLockContext.
- score: 2
component AppLockProvider
- file: src/platform/auth/app-lock/AppLockContext.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Provides shared app-lock state to descendants.Must be placed in above both and route outlet.
- score: 2
component AppLockSettingsSection
- file: src/platform/auth/app-lock/AppLockSettingsSection.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: App lock settings card for the Security Settings page.
- score: 2
component ApprovalChainTemplateCard
- file: src/platform/templates/components/ApprovalChainTemplateCard.tsx:101
- kind: component
- core: platform
- spec: (none)
- summary: Renders a card summarizing an approval chain template, including category, status badges,description, step count and a compact step-flow preview, with optional management actions.The card highlights default templates, indicates system templates, and conditionally showsEdit / Clone / Set as Default / Delete actions based on template properties and provided callbacks.
- params:
- props — Component props - template: The approval chain template to display (name, description, category, steps, is_system, is_default, usage_count, id) - onEdit: Callback invoked with the template id when the Edit action is selected - onDelete: Callback invoked with the template id when the Delete action is selected - onSetDefault: Callback invoked with the template id when Set as Default is selected - onClone: Callback invoked with the template id when Clone is selected - canManage: If true, shows the actions dropdown; defaults to Accessibility:- Action trigger button includes an accessible label (“Template actions”).- Visual status is expressed with badges and text; ensure color contrast for category badges.
- returns: The rendered card element for the provided approval chain template
- example: | ApprovalChainTemplateCard template=template onEdit=(id) = openEditModal(id) onDelete=(id) = confirmDelete(id) onSetDefault=(id) = setAsDefault(id) onClone=(id) = cloneTemplate(id) canManage=true/
- score: 4
component ApprovalChainTemplateEditor
- file: src/platform/templates/pages/ApprovalChainTemplateEditor.tsx:90
- kind: component
- core: platform
- spec: (none)
- summary: Renders the Approval Chain Template Editor UI for creating, editing, or cloning an approval chain template.The component presents a validated form to manage basic template metadata (name, description, category)and a multi-step approval workflow. It supports three modes determined by route parameters:create (new), edit (existing), and clone (duplicate an existing template). On successful submit thecomponent navigates back to the approvals templates list and shows success feedback; on failure it shows an error.
- params:
- props — Component props (none)
- example: | // Routed usage (no props required)Route path=“/settings/templates/:id” element=ApprovalChainTemplateEditor / /Accessibility considerations:- Form fields include visible labels and messages for assistive technologies.- The header back button includes an for screen reader users.
- score: 4
component ApprovalChainTemplateListPage
- file: src/platform/templates/pages/ApprovalChainTemplateListPage.tsx:53
- kind: component
- core: platform
- spec: (none)
- summary: Lists approval chain templates and exposes actions to view, create, edit, clone, delete, and set defaults.Renders separate sections for organization and system templates, provides category filtering via tabs, and shows loading, empty, and error states. Management actions are gated by permissions; delete uses a focus-trapping confirmation dialog.
- params:
- props — Component props (none)
- example: | // Route-mounted usageRoute path=“/settings/templates/approvals” element=ApprovalChainTemplateListPage / /Accessibility:- Tabs expose the current category and are keyboard navigable.- Action buttons include visible labels and meet touch target size recommendations.- The delete confirmation uses a focus-trapping modal dialog.
- score: 4
component ApprovalInbox
- file: src/platform/approvals/components/ApprovalInbox.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Pending approvals inbox (shared across FA, FW, and other surfaces).
- score: 2
component ApprovalInboxCard
- file: src/platform/approvals/components/ApprovalInboxCard.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Single pending approval row for the inbox list.
- score: 2
component ApprovalInboxEmptyState
- file: src/platform/approvals/components/ApprovalInboxEmptyState.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Empty state for the approval inbox list.
- score: 2
component ApprovalStepEditor
- file: src/platform/templates/components/ApprovalStepEditor.tsx:343
- kind: component
- core: platform
- spec: (none)
- summary: Renders an editable, drag-and-drop list for configuring an ordered approval step chain.Displays each step with controls for name, approver type and type-specific configuration,timeout/reminder and parallel mode; supports reordering via drag-and-drop, adding new steps,updating individual steps, and removing steps. Calls with the updated steps arraywhenever the list is mutated (add, update, remove, or reorder).
- params:
- props — Component props - value: Current ordered array of approval steps (1-based is preserved). - onChange: Called with the new array of steps after any change. - disabled: When true, disables interactive controls and prevents adding/removing/reordering. - className: Optional additional CSS class names applied to the root container.
- returns: The Approval Step Editor React element.
- example: | ApprovalStepEditor value=steps onChange=(newSteps) = setSteps(newSteps)/Accessibility:- Drag handle and form controls are focusable and keyboard-draggable via provided keyboard sensors.- When rendered, ensure surrounding layout provides sufficient contrast and spacing for form controls.
- score: 4
component ApprovalTimeline
- file: src/platform/documents/components/ApprovalTimeline.tsx:59
- kind: component
- core: platform
- spec: (none)
- summary: Utility for approval timeline.
- score: 1
component ApprovalWorkflowSetup
- file: src/platform/documents/components/ApprovalWorkflowSetup.tsx:140
- kind: component
- core: platform
- spec: (none)
- summary: Utility for approval workflow setup.
- score: 1
component ApproverSelector
- file: src/platform/documents/components/ApproverSelector.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Utility for approver selector.
- score: 1
component AppSidebar
- file: src/platform/navigation/AppSidebar.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Collapsible contextual panel — the right pane of the dual-pane sidebar layout(Phase 2, Task 5). The persistent CoreRail (rendered as a fixed sibling inResponsiveNav) handles module switching and user identity; this component ispurely the collapsible wrapping .⌘B (SidebarProvider toggle) hides/shows this panel while the CoreRail staysvisible. Props are accepted for call-site compatibility but are not consumedinternally — identity and sign-out live in CoreRail now.Accessibility:- Main navigation region uses role=“navigation” aria-label=“Main sidebar navigation”.- The primary toggle is the SidebarTrigger in DesktopHeader (z-50). The SidebarRail is intentionally omitted to avoid click interception when the panel is collapsed offcanvas behind the CoreRail (z-30).
- score: 2
component AppVersionInfo
- file: src/platform/pwa/components/AppVersionInfo.tsx:13
- kind: component
- core: platform
- spec: (none)
- summary: Utility for app version info.
- score: 1
component ARAgingSummaryWidget
- file: src/platform/dashboard/widgets/ARAgingSummaryWidget.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Utility for araging summary widget.
- score: 1
component AreaChartView
- file: src/platform/reports/components/charts/AreaChartView.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for area chart view.
- score: 1
component AttributionBadge
- file: src/platform/wizards/components/marketplace/AttributionBadge.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for attribution badge.
- score: 1
component AuditAnalyticsDashboard
- file: src/platform/audit/AuditAnalyticsDashboard.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Audit Analytics Dashboard page component.
- score: 2
component AuditLogDetailDialog
- file: src/platform/audit/AuditLogDetailDialog.tsx:77
- kind: component
- core: platform
- spec: (none)
- summary: Dialog showing audit log detail with before/after diff.
- score: 2
component AuthenticatedShellProviders
- file: src/platform/navigation/AuthenticatedShellProviders.tsx:12
- kind: component
- core: platform
- spec: (none)
- summary: Wires module registry preload + route prefetch to org-enabled modules.
- score: 2
component AvatarUpload
- file: src/platform/users/AvatarUpload.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for avatar upload.
- score: 1
component BaseTable
- file: src/platform/table-v2/components/BaseTable.tsx:106
- kind: component
- core: platform
- spec: (none)
- summary: BaseTable component that renders a TanStack Table using shadcn/ui components. T - Row data type
- score: 5
component BedCensusWidget
- file: src/platform/dashboard/widgets/BedCensusWidget.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Render a Bed Census dashboard widget showing occupancy and bed counts.Uses the same residence/bed scoping as the RH Bed Board (not IndexedDB widget cache).
- score: 2
component BottomTabBar
- file: src/platform/navigation/components/BottomTabBar.tsx:72
- kind: component
- core: platform
- spec: (none)
- summary: Reusable mobile bottom tab bar for module-scoped navigation.Visual contract: - 56 px fixed height + safe-area-bottom inset - 44 × 44 px minimum touch target per tab - Active tab: accent text + 2 px top border accent + - Inactive tab: muted text + hover:foreground transition - Hidden on (≥ 768 px)Permission filter: - Tabs without a always show. - Tabs with a show only if returns true. - Returns null if no tabs are visible.
- score: 2
component BranchConditionRow
- file: src/platform/wizards/components/branch/BranchConditionRow.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Utility for branch condition row.
- score: 1
component BranchEditor
- file: src/platform/wizards/components/BranchEditor.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Utility for branch editor.
- score: 1
component BranchStep
- file: src/platform/wizards/components/steps/BranchStep.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for branch step.
- score: 1
component BrandingSettingsPage
- file: src/platform/theming/pages/BrandingSettingsPage.tsx:52
- kind: component
- core: platform
- spec: (none)
- summary: Main branding settings page — wraps content in PermissionGate.
- score: 2
component BreadcrumbProvider
- file: src/platform/navigation/BreadcrumbContext.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Utility for breadcrumb provider.
- score: 1
component Breadcrumbs
- file: src/platform/navigation/Breadcrumbs.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: Renders a desktop breadcrumb trail derived from the current route and module/sub-module context.Builds breadcrumb segments from dynamic breadcrumb context, explicit route labels, and module metadata; hides itself when module-level navigation is handled elsewhere. Shows a home icon when not inside a module, or a module icon prefix when inside a module. The last segment is rendered as a page title and earlier segments are links.Accessibility: icons used for decoration include aria-hidden; links are focusable and label text is visible to assistive technologies. Truncated labels preserve their full accessible names.
- example: | Breadcrumbs /
- score: 5
component BulkActionToolbar
- file: src/platform/notifications/components/BulkActionToolbar.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for bulk action toolbar.
- score: 1
component BulkGenerationDialog
- file: src/platform/templates/components/BulkGenerationDialog.tsx:96
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for bulk document generation from CSV data. Allows users to upload a CSV file, preview the data,select a letterhead, and generate multiple PDFs in batch.
- score: 2
component BulkOperationForm
- file: src/platform/bulk-operations/components/BulkOperationForm.tsx:48
- kind: component
- core: platform
- spec: (none)
- summary: Utility for bulk operation form.
- score: 1
component BulkOperationsList
- file: src/platform/bulk-operations/components/BulkOperationsList.tsx:47
- kind: component
- core: platform
- spec: (none)
- summary: Utility for bulk operations list.
- score: 1
component BulkOperationsPage
- file: src/platform/bulk-operations/components/BulkOperationsPage.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for bulk operations page.
- score: 1
component BulkPermissionActions
- file: src/platform/permissions/components/BulkPermissionActions.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Utility for bulk permission actions.
- score: 1
component BulkTaskActions
- file: src/platform/tasks/components/BulkTaskActions.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for bulk task actions.
- score: 1
component BulkTaskConfirmDialog
- file: src/platform/tasks/components/BulkTaskConfirmDialog.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for bulk task confirm dialog.
- score: 1
component BundleMarketplacePage
- file: src/platform/ai/pages/BundleMarketplacePage.tsx:159
- kind: component
- core: platform
- spec: (none)
- summary: Marketplace listing page — renders all discoverable bundles and providesInstall / Uninstall actions with an explicit governance-decision gate.Route: /settings/platform/marketplace (flag-gated pf.agents.marketplace_enabled)Permission: pf.ai_skills.manage (route-level RequirePermission) PF-62-EN-02 AC-2
- score: 2
component BusinessProcessCatalogPage
- file: src/platform/automation/pages/BusinessProcessCatalogPage.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Main catalog page for business processes.
- score: 2
component BusinessProcessDetailPage
- file: src/platform/automation/pages/BusinessProcessDetailPage.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Detail page for a single business process.
- score: 2
component BusinessProcessFilters
- file: src/platform/automation/components/BusinessProcessFilters.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Filter controls for the business process catalog.
- score: 2
component CacheStatusBadge
- file: src/platform/reports/components/CacheStatusBadge.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Displays cache status for report results.
- score: 2
component CalendarSyncConfigCard
- file: src/platform/settings/components/CalendarSyncConfigCard.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Utility for calendar sync config card.
- score: 1
component CallDispositionDialog
- file: src/platform/telephony/components/CallDispositionDialog.tsx:51
- kind: component
- core: platform
- spec: (none)
- summary: Utility for call disposition dialog.
- score: 1
component CallDispositionQuickWizard
- file: src/platform/telephony/components/CallDispositionQuickWizard.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Compact 3-step dialog wizard for rapid call disposition.Supports keyboard shortcuts (1-9) for disposition selection,optional follow-up scheduling, and quick note snippets.
- score: 2
component CallLogWidget
- file: src/platform/telephony/components/CallLogWidget.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for call log widget.
- score: 1
component CallRecordingPlayer
- file: src/platform/telephony/components/CallRecordingPlayer.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Renders call recording status UI and playback controls.Handles various recording states: not_recorded, processing, error, deleted, available.When available, displays an audio player with recording duration.
- score: 2
component CampaignCreateForm
- file: src/platform/headshot/components/CampaignCreateForm.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Dialog form for creating a headshot campaign.
- score: 2
component CampaignDashboard
- file: src/platform/headshot/components/CampaignDashboard.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Campaign list and dashboard.
- score: 1
component CategoriesPage
- file: src/platform/data-manager/pages/CategoriesPage.tsx:12
- kind: component
- core: platform
- spec: (none)
- summary: Utility for categories page.
- score: 1
component CategoryDialog
- file: src/platform/data-manager/components/CategoryDialog.tsx:64
- kind: component
- core: platform
- spec: (none)
- summary: Utility for category dialog.
- score: 1
component CategoryFilter
- file: src/platform/data-manager/components/CategoryFilter.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for category filter.
- score: 1
component CategoryManager
- file: src/platform/data-manager/components/CategoryManager.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for category manager.
- score: 1
component ChangeImpactPreview
- file: src/platform/org-data-sync/components/ChangeImpactPreview.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for change impact preview.
- score: 1
component ChannelBrowserDialog
- file: src/platform/messaging/components/ChannelBrowserDialog.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for channel browser dialog.
- score: 1
component ChartConfigPanel
- file: src/platform/reports/components/charts/ChartConfigPanel.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for chart config panel.
- score: 1
component ChatAvatar
- file: src/platform/messaging/components/ChatAvatar.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for chat avatar.
- score: 1
component ChatbotEmbedCodeTab
- file: src/platform/chatbot/components/ChatbotEmbedCodeTab.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Embed code snippet generator for external website integration.
- score: 2
component ChatbotGeneralTab
- file: src/platform/chatbot/components/ChatbotGeneralTab.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: General chatbot settings: title, welcome message, color, position, enabled state.
- score: 2
component ChatbotKnowledgeTab
- file: src/platform/chatbot/components/ChatbotKnowledgeTab.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Knowledge base settings: AI prompt and suggested visitor questions.
- score: 2
component ChatbotLeadCaptureTab
- file: src/platform/chatbot/components/ChatbotLeadCaptureTab.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Lead capture and domain restriction settings.
- score: 2
component ChatbotSettingsPage
- file: src/platform/chatbot/pages/ChatbotSettingsPage.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Admin page for managing chatbot widget settings.
- score: 2
component ChatbotWidgetPage
- file: src/platform/chatbot/widget/ChatbotWidgetPage.tsx:14
- kind: component
- core: platform
- spec: (none)
- summary: Lightweight widget page for iframe embedding.
- score: 2
component ChatNotificationBadge
- file: src/platform/messaging/components/ChatNotificationBadge.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Utility for chat notification badge.
- score: 1
component ChatPanel
- file: src/platform/messaging/components/ChatPanel.tsx:61
- kind: component
- core: platform
- spec: (none)
- summary: Utility for chat panel.
- score: 1
component ChatWindow
- file: src/platform/chatbot/widget/components/ChatWindow.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Full chat window with header, message thread, and composer.
- score: 2
component CheckboxField
- file: src/platform/forms/components/fields/CheckboxField.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for checkbox field.
- score: 1
component ClearCacheButton
- file: src/platform/pwa/components/ClearCacheButton.tsx:12
- kind: component
- core: platform
- spec: (none)
- summary: Utility for clear cache button.
- score: 1
component ClGroupBackLink
- file: src/platform/navigation/components/ClGroupBackLink.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Inline back-link that points at the owning CL nav group for the active route.
- score: 2
component ClickToCallButton
- file: src/platform/telephony/components/ClickToCallButton.tsx:72
- kind: component
- core: platform
- spec: (none)
- summary: Click-to-call UI control that initiates calls via RingCentral.CE-14 Enhancement: When Embeddable is enabled and preferred, uses WebRTCfor in-browser calling. Otherwise falls back to RingOut (rings your phone first).Renders one of three variants — icon, button, or inline link — and managesdisabled and loading states based on phone validity, organization availability,and ongoing initiation.
- params:
- props — Component props - phoneNumber: Phone number to call; normalized to E.164 format - contactId: Optional contact identifier associated with the call - partnerId: Optional partner identifier associated with the call - variant: Visual variant: , , or . Defaults to - size: Size: , , or . Defaults to - className: Optional additional CSS class names - onSuccess: Optional callback with RingOut ID on success - onError: Optional callback with Error on failure - disabled: If true, the control is disabled
- score: 4
component CloneFromMarketplaceDialog
- file: src/platform/wizards/components/marketplace/CloneFromMarketplaceDialog.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Utility for clone from marketplace dialog.
- score: 1
component CloneTemplateDialog
- file: src/platform/wizards/components/CloneTemplateDialog.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for clone template dialog.
- score: 1
component CodeMappingManager
- file: src/platform/terminology/components/CodeMappingManager.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: CodeMappingManager — displays cross-code-set mappingsand allows CRUD of org-scoped custom mappings.
- score: 2
component CodeSetVersionManager
- file: src/platform/terminology/components/CodeSetVersionManager.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: CodeSetVersionManager — lists and manages code set versions.
- score: 2
component CollapsibleSection
- file: src/platform/navigation/components/CollapsibleSection.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Utility for collapsible section.
- score: 1
component ColorsTab
- file: src/platform/theming/components/ColorsTab.tsx:206
- kind: component
- core: platform
- spec: (none)
- summary: Color editor tab with grouped sections, inline preview, and WCAG AA validation.
- score: 2
component ColumnManager
- file: src/platform/table-v2/components/ColumnManager.tsx:137
- kind: component
- core: platform
- spec: (none)
- summary: Popover-based column visibility and reorder manager.
- score: 5
component ColumnResizeHandle
- file: src/platform/table-v2/features/ColumnResizing.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Draggable handle for resizing columns.
- score: 5
component ColumnSelector
- file: src/platform/reports/components/ColumnSelector.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for column selector.
- score: 1
component ColumnVisibilityPanel
- file: src/platform/table-v2/features/ColumnVisibility.tsx:119
- kind: component
- core: platform
- spec: (none)
- summary: Panel for managing column visibility with checkboxes.
- score: 2
component ColumnVisibilityToggle
- file: src/platform/table-v2/features/ColumnVisibility.tsx:62
- kind: component
- core: platform
- spec: (none)
- summary: Dropdown menu for toggling column visibility.
- score: 5
component ComparisonCard
- file: src/platform/health/components/ComparisonCard.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for comparison card.
- score: 1
component ComplianceCheckDetailSheet
- file: src/platform/compliance/components/ComplianceCheckDetailSheet.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: Drill-down sheet for a single compliance check type (warnings, failures, and latest pass).
- score: 2
component ComplianceReportExport
- file: src/platform/audit/ComplianceReportExport.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Compliance export form for audit logs.
- score: 2
component ComplianceReportExportDialog
- file: src/platform/health/components/ComplianceReportExportDialog.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for compliance report export dialog.
- score: 1
component ComplianceScoreWidget
- file: src/platform/dashboard/widgets/ComplianceScoreWidget.tsx:54
- kind: component
- core: platform
- spec: (none)
- summary: Utility for compliance score widget.
- score: 1
component ComposedChartView
- file: src/platform/reports/components/charts/ComposedChartView.tsx:38
- kind: component
- core: platform
- spec: (none)
- summary: Utility for composed chart view.
- score: 1
component ConditionalRequiredIndicator
- file: src/platform/conditional-logic/components/ConditionalValidationError.tsx:74
- kind: component
- core: platform
- spec: (none)
- summary: Utility for conditional required indicator.
- score: 1
component ConditionalRuleBuilder
- file: src/platform/field-config/components/ConditionalRuleBuilder.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Utility for conditional rule builder.
- score: 1
component ConditionalValidationError
- file: src/platform/conditional-logic/components/ConditionalValidationError.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Display validation error with optional conditional contextShows a tooltip explaining why the field became required
- score: 5
component ConditionBuilder
- file: src/platform/conditional-logic/components/builder/ConditionBuilder.tsx:59
- kind: component
- core: platform
- spec: (none)
- summary: Utility for condition builder.
- score: 1
component ConditionBuilderDialog
- file: src/platform/conditional-logic/components/builder/ConditionBuilderDialog.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for condition builder dialog.
- score: 1
component ConditionBuilderSkeleton
- file: src/platform/conditional-logic/components/builder/ConditionBuilderSkeleton.tsx:8
- kind: component
- core: platform
- spec: (none)
- summary: Utility for condition builder skeleton.
- score: 1
component ConditionEvaluationTree
- file: src/platform/conditional-logic/components/builder/ConditionEvaluationTree.tsx:84
- kind: component
- core: platform
- spec: (none)
- summary: Utility for condition evaluation tree.
- score: 1
component ConditionGroupEditor
- file: src/platform/conditional-logic/components/builder/ConditionGroupEditor.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for condition group editor.
- score: 1
component ConditionPerformanceDashboard
- file: src/platform/conditional-logic/pages/ConditionPerformanceDashboard.tsx:230
- kind: component
- core: platform
- spec: (none)
- summary: Condition Performance Dashboard page, gated by permission.
- score: 2
component ConditionPreview
- file: src/platform/conditional-logic/components/builder/ConditionPreview.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for condition preview.
- score: 1
component ConditionRow
- file: src/platform/conditional-logic/components/builder/ConditionRow.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for condition row.
- score: 1
component ConfigurableDetailView
- file: src/platform/field-config/components/ConfigurableDetailView.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for configurable detail view.
- score: 1
component ConfigurableForm
- file: src/platform/field-config/components/ConfigurableForm.tsx:87
- kind: component
- core: platform
- spec: (none)
- summary: Utility for configurable form.
- score: 1
component ConnectionFormDialog
- file: src/platform/settings/pages/data-migration/components/ConnectionFormDialog.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Utility for connection form dialog.
- score: 1
component ConnectionsTab
- file: src/platform/settings/pages/data-migration/components/ConnectionsTab.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Utility for connections tab.
- score: 1
component ConnectionTestButton
- file: src/platform/integrations/components/ConnectionTestButton.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for connection test button.
- score: 1
component ConnectorApprovalPanel
- file: src/platform/analytics/components/ConnectorApprovalPanel.tsx:64
- kind: component
- core: platform
- spec: (none)
- summary: Renders nothing when the caller lacks .
- score: 2
component ConsentStatusDetailSheet
- file: src/platform/compliance/components/ConsentStatusDetailSheet.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Drill-down for Part 2 consent status on the compliance dashboard.
- score: 2
component ContextualPanel
- file: src/platform/navigation/components/ContextualPanel.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: ContextualPanel — the right pane of the dual-pane sidebar layout.Routing logic (priority order): 1. Active workspace ( set, user not inside a core) → render with composed cross-core groups and an “Exit workspace” affordance. 2. Inside a core module () → render for that module (NO back button; the CoreRail provides the module-switching affordance). 3. Platform-home fallback → render (Dashboard / Inbox / Reports / Documents + Settings + workspace lenses switcher).Badge data is computed here so it doesn’t need to be threaded throughmultiple ancestors — same approach as AppSidebar today.
- score: 2
component ContextualSidebarProvider
- file: src/platform/navigation/contextual-sidebar.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for contextual sidebar provider.
- score: 1
component ContrastFallbackIndicator
- file: src/platform/compliance/components/ContrastFallbackIndicator.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Renders a small info icon with tooltip when the compliance theme had tofall back to safe colors for WCAG AA contrast.
- score: 2
component ConversationCreateDialog
- file: src/platform/messaging/components/ConversationCreateDialog.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Create DM, group, or channel via people picker (no email typing needed).
- score: 2
component ConversationList
- file: src/platform/messaging/components/ConversationList.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Grouped conversation sidebar with Channels, DMs, Groups sections.
- score: 2
component ConversationPane
- file: src/platform/cowork/components/ConversationPane.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: ConversationPane — real-time message history + send composer for the center column.Consumes PF-67 useMessages (paginated + realtime) and useSendMessage.
- score: 2
component CoreRail
- file: src/platform/navigation/primitives/CoreRail.tsx:285
- kind: component
- core: platform
- spec: (none)
- summary: Persistent left core rail. Always visible; the secondary panel beside itmay collapse but the rail itself never does.
- score: 2
component CoworkPage
- file: src/platform/cowork/pages/CoworkPage.tsx:94
- kind: component
- core: platform
- spec: (none)
- summary: CoworkPage — the /cowork shell scaffold.Self-gated by the feature flag. When the flagis OFF the page renders a polite “unavailable” placeholder so the routeremains navigable without exposing an empty frame. When ON it renders theresponsive 3-column layout (thread-list | conversation | participants).The outer RequirePermission(‘pf.cowork.participate’) guard lives inplatform.tsx — this component only handles the flag gate.selectedConversationId is lifted here so ThreadListPane selection drivesboth ConversationPane (center) and ParticipantsPane (right).CoworkPage also holds the conversations list so it can resolve the selectedconversation’s agent_thread_id (= pf_threads.id) and pass it toParticipantsPane — which calls useResolveThread keyed on that id.The TanStack Query call here deduplicates with ThreadListPane’s identical call.
- score: 2
component CreateApiKeyDialog
- file: src/platform/api-access/components/CreateApiKeyDialog.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Dialog to create a new API key with name + scope selection.
- score: 2
component CreateCustomObjectDialog
- file: src/platform/data-manager/components/CreateCustomObjectDialog.tsx:77
- kind: component
- core: platform
- spec: (none)
- summary: Utility for create custom object dialog.
- score: 1
component CreateDiagramWizard
- file: src/platform/workflow/components/CreateDiagramWizard.tsx:58
- kind: component
- core: platform
- spec: (none)
- summary: Guided 3-step wizard for creating swim lane diagrams.
- score: 2
component CreateFromTemplateSheet
- file: src/platform/page-layouts/components/CreateFromTemplateSheet.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for create from template sheet.
- score: 1
component CreateLayoutDialog
- file: src/platform/page-layouts/components/data-manager/CreateLayoutDialog.tsx:48
- kind: component
- core: platform
- spec: (none)
- summary: Utility for create layout dialog.
- score: 1
component CreateRolePage
- file: src/platform/roles/pages/CreateRolePage.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for create role page.
- score: 1
component CreateServiceAccountDialog
- file: src/platform/api-access/components/CreateServiceAccountDialog.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Dialog to create a new service account.
- score: 2
component CreateSkillDialog
- file: src/platform/ai/components/CreateSkillDialog.tsx:109
- kind: component
- core: platform
- spec: (none)
- summary: Modal dialog for creating a custom organization AI skill.Supports “Create from Template” (T20/T21) which pre-fills the form.
- score: 2
component CreateSkillWizard
- file: src/platform/ai/components/CreateSkillWizard.tsx:124
- kind: component
- core: platform
- spec: (none)
- summary: Multi-step wizard dialog for authoring (or editing) a custom AI skill (PF-UX-13).
- params:
- props — open / onOpenChange / optional editSkill.
- score: 2
component CreateUserDirectDialog
- file: src/platform/users/CreateUserDirectDialog.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for create user direct dialog.
- score: 1
component CredentialBadge
- file: src/platform/integrations/components/CredentialBadge.tsx:16
- kind: component
- core: platform
- spec: (none)
- summary: Utility for credential badge.
- score: 1
component CredentialBadge
- file: src/platform/workforce/CredentialBadge.tsx:12
- kind: component
- core: platform
- spec: (none)
- summary: Visual badge showing credential status
- score: 2
component CredentialForm
- file: src/platform/integrations/components/CredentialForm.tsx:66
- kind: component
- core: platform
- spec: (none)
- summary: Utility for credential form.
- score: 1
component CredentialList
- file: src/platform/integrations/components/CredentialList.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for credential list.
- score: 1
component CrossFieldValidationBuilder
- file: src/platform/conditional-logic/components/builder/CrossFieldValidationBuilder.tsx:218
- kind: component
- core: platform
- spec: (none)
- summary: Visual builder for cross-field validations
- score: 2
component CrossFieldValidationErrorDisplay
- file: src/platform/conditional-logic/components/CrossFieldValidationErrors.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Display a single cross-field validation errorShows the error message with links to both related fields
- score: 2
component CrossFieldValidationErrorList
- file: src/platform/conditional-logic/components/CrossFieldValidationErrors.tsx:77
- kind: component
- core: platform
- spec: (none)
- summary: Display a list of cross-field validation errors
- score: 2
component CrossModuleBadge
- file: src/platform/wizards/components/CrossModuleBadge.tsx:42
- kind: component
- core: platform
- spec: (none)
- summary: Utility for cross module badge.
- score: 1
component CSVExportButton
- file: src/platform/data-manager/components/CSVExportButton.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for csvexport button.
- score: 1
component CSVImportWizard
- file: src/platform/data-manager/components/CSVImportWizard.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: Utility for csvimport wizard.
- score: 1
component CustomFieldDefinitionForm
- file: src/platform/custom-fields/components/CustomFieldDefinitionForm.tsx:81
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom field definition form.
- score: 1
component CustomFieldDefinitionsTable
- file: src/platform/custom-fields/components/CustomFieldDefinitionsTable.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom field definitions table.
- score: 1
component CustomFieldDetailPage
- file: src/platform/custom-fields/pages/CustomFieldDetailPage.tsx:15
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom field detail page.
- score: 1
component CustomFieldInput
- file: src/platform/custom-fields/components/CustomFieldInput.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom field input.
- score: 1
component CustomFieldRenderer
- file: src/platform/custom-fields/components/CustomFieldRenderer.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom field renderer.
- score: 1
component CustomFieldsPage
- file: src/platform/custom-fields/pages/CustomFieldsPage.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom fields page.
- score: 1
component CustomFieldsSection
- file: src/platform/custom-fields/components/CustomFieldsSection.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom fields section.
- score: 1
component CustomGestureProvider
- file: src/platform/gestures/registry/CustomGestureContext.tsx:14
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom gesture provider.
- score: 1
component CustomizeNavDialog
- file: src/platform/navigation/CustomizeNavDialog.tsx:121
- kind: component
- core: platform
- spec: (none)
- summary: Utility for customize nav dialog.
- score: 1
component CustomMetricDetailPage
- file: src/platform/health/pages/CustomMetricDetailPage.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom metric detail page.
- score: 1
component CustomMetricForm
- file: src/platform/health/components/CustomMetricForm.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom metric form.
- score: 1
component CustomMetricsPage
- file: src/platform/health/pages/CustomMetricsPage.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom metrics page.
- score: 1
component CustomMetricWidget
- file: src/platform/health/components/CustomMetricWidget.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom metric widget.
- score: 1
component CustomObjectDetailPage
- file: src/platform/data-manager/pages/CustomObjectDetailPage.tsx:63
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom object detail page.
- score: 1
component CustomObjectFieldManager
- file: src/platform/data-manager/components/CustomObjectFieldManager.tsx:142
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom object field manager.
- score: 1
component CustomObjectRecordDialog
- file: src/platform/data-manager/components/CustomObjectRecordDialog.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom object record dialog.
- score: 1
component CustomObjectRecordsTable
- file: src/platform/data-manager/components/CustomObjectRecordsTable.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom object records table.
- score: 1
component CustomStep
- file: src/platform/wizards/components/steps/CustomStep.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom step.
- score: 1
component CustomWidgetBuilder
- file: src/platform/dashboard/components/CustomWidgetBuilder.tsx:85
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom widget builder.
- score: 1
component CustomWidgetRenderer
- file: src/platform/dashboard/components/CustomWidgetRenderer.tsx:58
- kind: component
- core: platform
- spec: (none)
- summary: Utility for custom widget renderer.
- score: 1
component DailyTrendChart
- file: src/platform/wizards/components/analytics/DailyTrendChart.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for daily trend chart.
- score: 1
component DashboardContextSwitcher
- file: src/platform/dashboard/components/DashboardContextSwitcher.tsx:51
- kind: component
- core: platform
- spec: (none)
- summary: Utility for dashboard context switcher.
- score: 1
component DashboardEmptyState
- file: src/platform/dashboard/components/DashboardEmptyState.tsx:11
- kind: component
- core: platform
- spec: (none)
- summary: Utility for dashboard empty state.
- score: 1
component DashboardHeader
- file: src/platform/dashboard/components/DashboardHeader.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for dashboard header.
- score: 1
component DashboardSettingsDialog
- file: src/platform/dashboard/components/DashboardSettingsDialog.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for dashboard settings dialog.
- score: 1
component DashboardShareDialog
- file: src/platform/dashboard/components/DashboardShareDialog.tsx:46
- kind: component
- core: platform
- spec: (none)
- summary: Utility for dashboard share dialog.
- score: 1
component DashboardTemplatesAdmin
- file: src/platform/dashboard/pages/DashboardTemplatesAdmin.tsx:345
- kind: component
- core: platform
- spec: (none)
- summary: Dashboard Templates Admin page with permission guardRequires pf.dashboard.admin permission to access
- score: 2
component DashboardTemplateSelector
- file: src/platform/dashboard/components/DashboardTemplateSelector.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for dashboard template selector.
- score: 1
component DatabaseHealthOverviewCard
- file: src/platform/health/components/DatabaseHealthOverviewCard.tsx:50
- kind: component
- core: platform
- spec: (none)
- summary: Utility for database health overview card.
- score: 1
component DatabaseHealthPage
- file: src/platform/health/pages/DatabaseHealthPage.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for database health page.
- score: 1
component DataImportPage
- file: src/platform/settings/pages/DataImportPage.tsx:72
- kind: component
- core: platform
- spec: (none)
- summary: Utility for data import page.
- score: 1
component DataManagerPage
- file: src/platform/data-manager/pages/DataManagerPage.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for data manager page.
- score: 1
component DataMigrationPage
- file: src/platform/settings/pages/data-migration/DataMigrationPage.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Data migration page with guided stepper workflow.
- score: 2
component DataRetentionPage
- file: src/platform/data-retention/pages/DataRetentionPage.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for data retention page.
- score: 1
component DataTableDemoPage
- file: src/platform/table-v2/pages/DataTableDemoPage.tsx:102
- kind: component
- core: platform
- spec: (none)
- summary: Utility for data table demo page.
- score: 1
component DateField
- file: src/platform/forms/components/fields/DateField.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for date field.
- score: 1
component DateTimeField
- file: src/platform/forms/components/fields/DateTimeField.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for date time field.
- score: 1
component DbHealthIssuesList
- file: src/platform/health/components/DbHealthIssuesList.tsx:71
- kind: component
- core: platform
- spec: (none)
- summary: Utility for db health issues list.
- score: 1
component DecisionNode
- file: src/platform/workflow/components/swim-lane-nodes/DecisionNode.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Decision node — diamond (rotated square) with condition label.
- score: 2
component DefaultOrgSelector
- file: src/platform/users/DefaultOrgSelector.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for default org selector.
- score: 1
component DeletedRecordActions
- file: src/platform/admin/components/DeletedRecordActions.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for deleted record actions.
- score: 1
component DeletedRecordsPage
- file: src/platform/admin/pages/DeletedRecordsPage.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Utility for deleted records page.
- score: 1
component DeletedRecordsTable
- file: src/platform/admin/components/DeletedRecordsTable.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Utility for deleted records table.
- score: 1
component DeleteRetentionPolicyDialog
- file: src/platform/data-retention/components/DeleteRetentionPolicyDialog.tsx:15
- kind: component
- core: platform
- spec: (none)
- summary: Utility for delete retention policy dialog.
- score: 1
component DeleteRoleDialog
- file: src/platform/roles/components/DeleteRoleDialog.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for delete role dialog.
- score: 1
component DeliveryLogViewer
- file: src/platform/notifications/components/testing/DeliveryLogViewer.tsx:79
- kind: component
- core: platform
- spec: (none)
- summary: Utility for delivery log viewer.
- score: 1
component DeliveryStatus
- file: src/platform/messaging/components/DeliveryStatus.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Delivery status indicator for sent messages.
- score: 2
component DeploymentCard
- file: src/platform/health/components/DeploymentCard.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Card showing the most recent Vercel deployment.
- score: 2
component DesktopHeader
- file: src/platform/navigation/DesktopHeader.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Utility for desktop header.
- score: 1
component DiagnosticsPanel
- file: src/platform/notifications/components/testing/DiagnosticsPanel.tsx:15
- kind: component
- core: platform
- spec: (none)
- summary: Utility for diagnostics panel.
- score: 1
component DiagramPresenceIndicator
- file: src/platform/workflow/components/DiagramPresenceIndicator.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Renders an overlapping avatar stack of users with presence on the diagram.
- score: 2
component DiagramValidationPanel
- file: src/platform/workflow/components/DiagramValidationPanel.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Sheet panel showing diagram validation errors and warnings.
- score: 2
component DiagramVersionHistory
- file: src/platform/workflow/components/DiagramVersionHistory.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Collapsible panel listing diagram versions with preview and rollback.
- score: 2
component DialogWizardShell
- file: src/platform/wizards/components/DialogWizardShell.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Utility for dialog wizard shell.
- score: 1
component DirectorySyncCard
- file: src/platform/settings/components/DirectorySyncCard.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: Utility for directory sync card.
- score: 1
component DisclaimerSection
- file: src/platform/email-signatures/components/DisclaimerSection.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Disclaimer textarea for compliance disclaimers appended to email signatures.
- score: 2
component DispositionSelectStep
- file: src/platform/telephony/components/quick-disposition-steps/DispositionSelectStep.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: 3×3 grid of disposition tiles for quick keyboard-first selection.Each tile shows the disposition label and a key hint badge (1-9).The disposition is intentionally excluded to fit the 1-9 keyboard map.
- score: 2
component DocsLink
- file: src/platform/docs/DocsLink.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for docs link.
- score: 1
component DocumentAnalyticsDashboard
- file: src/platform/documents/pages/DocumentAnalyticsDashboard.tsx:42
- kind: component
- core: platform
- spec: (none)
- summary: Analytics dashboard page for document metrics.
- score: 2
component DocumentApprovalDecisionDialog
- file: src/platform/documents/components/DocumentApprovalDecisionDialog.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for document approval decision dialog.
- score: 1
component DocumentBulkActionToolbar
- file: src/platform/documents/components/DocumentBulkActionToolbar.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Utility for document bulk action toolbar.
- score: 1
component DocumentCard
- file: src/platform/documents/DocumentCard.tsx:54
- kind: component
- core: platform
- spec: (none)
- summary: Utility for document card.
- score: 1
component DocumentDetailPage
- file: src/platform/documents/DocumentDetailPage.tsx:55
- kind: component
- core: platform
- spec: (none)
- summary: Utility for document detail page.
- score: 1
component DocumentImportDialog
- file: src/platform/knowledge/components/DocumentImportDialog.tsx:53
- kind: component
- core: platform
- spec: (none)
- summary: Dialog UI that lets users search organization documents with extractable text and import a selected document’s content into a knowledge article.Renders a searchable list of documents (title, file name, type, date, and content snippet), allows selecting a single document, and invokes the supplied import callback with the document id, name, and extracted text.Accessibility: the dialog and interactive list items are keyboard-focusable and provide visible focus rings; ensure the dialog is reachable via keyboard and that screen readers can access the dialog title and description. - open: Whether the import dialog is open. - onOpenChange: Callback invoked with the new open state (use to close the dialog). - onImport: Callback invoked when the user confirms import with an object containing , , and of the selected document.
- example: | DocumentImportDialog open=isDialogOpen onOpenChange=(open) = setIsDialogOpen(open) onImport=( id, name, content ) = handleImportDocument( id, name, content )/
- score: 5
component DocumentLibrary
- file: src/platform/documents/DocumentLibrary.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Utility for document library.
- score: 1
component DocumentPreview
- file: src/platform/documents/DocumentPreview.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Document preview component that supports multiple file formats.Heavy viewers (PDF, Excel, DOCX) are lazy-loaded to reduce initial bundle size.Bundle savings:- react-pdf: ~1.6MB (loads only when viewing PDFs)- exceljs: ~937KB (loads only when viewing Excel files)- mammoth: ~100KB (loads only when viewing DOCX files)
- score: 2
component DocumentPreviewDialog
- file: src/platform/documents/DocumentPreviewDialog.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for document preview dialog.
- score: 1
component DocumentSortOptions
- file: src/platform/documents/components/DocumentSortOptions.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for document sort options.
- score: 1
component DocumentTemplateCard
- file: src/platform/templates/components/DocumentTemplateCard.tsx:66
- kind: component
- core: platform
- spec: (none)
- summary: Renders a document template card showing name, status, type, version, usage and optional management actions.Displays visual indicators for default and system templates, an optional description and letterhead, and a contextual action menu when management callbacks are provided. Action availability is governed by template state (system, default, status, usage_count) and the corresponding callback props.
- params:
- props — Component props - template: The DocumentTemplate to display (required). Used for name, description, type, status, version, usage, and system/default flags. - letterheadName: Optional display name of an associated letterhead. - onEdit: Optional callback invoked with the template id when Edit is selected. - onDelete: Optional callback invoked with the template id when Delete is selected (only shown if template is not system and usage_count is 0). - onSetDefault: Optional callback invoked with the template id to mark this template as the default (only shown if template is active, not system, and not already default). - onClone: Optional callback invoked with the template id when Clone is selected. - onDeprecate: Optional callback invoked with the template id to deprecate the template (only shown if template is not system and not already deprecated). - onViewVersions: Optional callback invoked with the template id to view version history. - canManage: When true, shows the action menu; defaults to false.
- returns: The JSX element for the template card.The action menu trigger includes an aria-label (“Template actions”) and all menu items are keyboard navigable via the DropdownMenu primitive.
- example: | DocumentTemplateCard template=template letterheadName=“Acme Corp” canManage onEdit=(id) = openEditor(id) onDelete=(id) = confirmDelete(id)/
- score: 4
component DocumentTemplateEditor
- file: src/platform/templates/pages/DocumentTemplateEditor.tsx:114
- kind: component
- core: platform
- spec: (none)
- summary: Full editor interface for creating, editing, or cloning document templates with sections, configuration, and versioning.Renders a form bound to validation schema for template metadata, sections, and template configuration; supports loading existing templates for edit or clone, creating new templates, updating templates (optionally creating a new version when change notes are provided), and viewing version history.Accessibility considerations:- Back button includes an aria-label of “Go back”.- Form controls use semantic labels and form messages for validation feedback.
- params:
- props — No props; this component reads routing and organization context internally.
- example: | DocumentTemplateEditor /
- score: 4
component DocumentTemplateListPage
- file: src/platform/templates/pages/DocumentTemplateListPage.tsx:63
- kind: component
- core: platform
- spec: (none)
- summary: Page that lists document templates with type and status filters, grouped intoOrganization Templates and System Templates, and provides template actions.Renders filter controls for template type and status, shows loading and errorstates, displays an empty state when no templates exist, and exposes actionsfor creating, editing, deleting (with confirmation), cloning, deprecating,viewing versions, and setting a default template where permitted.
- example: | DocumentTemplateListPage /Accessibility considerations:- Filter controls and action buttons are keyboard-focusable and labeled via their visible text; ensure any additional interactive child components (cards, dialogs) also provide accessible names and focus management.
- score: 5
component DocumentTemplateVersionDiff
- file: src/platform/templates/components/DocumentTemplateVersionDiff.tsx:195
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for comparing two document template versions side-by-side. - versions: All available versions (ordered by version_number DESC) - open: Whether the dialog is open - onOpenChange: Callback to toggle dialog open state - initialVersionA: Optional initial version ID for the left (older) side - initialVersionB: Optional initial version ID for the right (newer) side
- score: 2
component DocumentUploadDialog
- file: src/platform/documents/DocumentUploadDialog.tsx:74
- kind: component
- core: platform
- spec: (none)
- summary: Utility for document upload dialog.
- score: 1
component DocxViewer
- file: src/platform/documents/DocxViewer.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for docx viewer.
- score: 1
component DraftCard
- file: src/platform/forms/components/DraftCard.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Utility for draft card.
- score: 1
component DraftCardSwipeable
- file: src/platform/forms/components/DraftCardSwipeable.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Renders a wrapped with a mobile swipe-to-delete action.
- score: 2
component DraftIndicator
- file: src/platform/wizards/components/DraftIndicator.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for draft indicator.
- score: 1
component DraftListPage
- file: src/platform/forms/pages/DraftListPage.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for draft list page.
- score: 1
component DraftListView
- file: src/platform/forms/components/DraftListView.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for draft list view.
- score: 1
component DraftResumeDialog
- file: src/platform/wizards/components/DraftResumeDialog.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: Utility for draft resume dialog.
- score: 1
component DraftResumePrompt
- file: src/platform/forms/components/DraftResumePrompt.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for draft resume prompt.
- score: 1
component DraftStatusIndicator
- file: src/platform/wizards/components/DraftStatusIndicator.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for draft status indicator.
- score: 1
component DraggableHeader
- file: src/platform/table-v2/components/DraggableHeader.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: A column header cell that supports drag-and-drop reordering.Uses dnd-kit/sortable for drag interactions. Shows a grip handleon hover for desktop users. Disabled on touch devices.
- score: 5
component DropOffAnalysis
- file: src/platform/wizards/components/analytics/DropOffAnalysis.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for drop off analysis.
- score: 1
component DropZone
- file: src/platform/upload/components/DropZone.tsx:61
- kind: component
- core: platform
- spec: (none)
- summary: Drag-and-drop file upload zone with visual feedback.
- score: 2
component DuplicateExportButton
- file: src/platform/import/components/DuplicateExportButton.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Exports duplicate-flagged records as a CSV file for audit purposes.
- score: 2
component DuplicateReviewDialog
- file: src/platform/import/components/DuplicateReviewDialog.tsx:36
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for reviewing and resolving duplicate import records.
- score: 2
component DynamicFormRenderer
- file: src/platform/field-config/components/DynamicFormRenderer.tsx:308
- kind: component
- core: platform
- spec: (none)
- summary: Utility for dynamic form renderer.
- score: 1
component DynamicRecordField
- file: src/platform/data-manager/components/DynamicRecordField.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for dynamic record field.
- score: 1
component EdgeFunctionHealthCard
- file: src/platform/health/components/EdgeFunctionHealthCard.tsx:14
- kind: component
- core: platform
- spec: (none)
- summary: Card showing edge function error rates for the last 24h.
- score: 2
component EditableCell
- file: src/platform/data-manager/components/EditableCell.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for editable cell.
- score: 1
component EditCustomObjectDialog
- file: src/platform/data-manager/components/EditCustomObjectDialog.tsx:67
- kind: component
- core: platform
- spec: (none)
- summary: Utility for edit custom object dialog.
- score: 1
component EditObjectMetadataDialog
- file: src/platform/data-manager/components/EditObjectMetadataDialog.tsx:52
- kind: component
- core: platform
- spec: (none)
- summary: Utility for edit object metadata dialog.
- score: 1
component EditReportPage
- file: src/platform/reports/EditReportPage.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for editing an existing report.
- score: 1
component EditRolePage
- file: src/platform/roles/pages/EditRolePage.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for edit role page.
- score: 1
component EmailField
- file: src/platform/forms/components/fields/EmailField.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for email field.
- score: 1
component EmailProviderHealthBanner
- file: src/platform/users/components/EmailProviderHealthBanner.tsx:36
- kind: component
- core: platform
- spec: (none)
- summary: Renders the email-provider health snapshot for org admins.
- score: 2
component EmailTemplateEditor
- file: src/platform/forms/components/fields/RichTextField.tsx:556
- kind: component
- core: platform
- spec: (none)
- summary: Email template editor with full formatting
- score: 2
component EmailTemplateEditor
- file: src/platform/templates/components/EmailTemplateEditor.tsx:193
- kind: component
- core: platform
- spec: (none)
- summary: Utility for email template editor.
- score: 1
component EmailTestCard
- file: src/platform/notifications/components/testing/ChannelTestCards.tsx:387
- kind: component
- core: platform
- spec: (none)
- summary: Renders the email test card interface.
- score: 2
component EmbeddableProvider
- file: src/platform/telephony/components/EmbeddableProvider.tsx:121
- kind: component
- core: platform
- spec: (none)
- summary: Provider component that loads and configures the RingCentral Embeddable widget.
- score: 2
component EmbeddableWrapper
- file: src/platform/telephony/components/EmbeddableWrapper.tsx:50
- kind: component
- core: platform
- spec: (none)
- summary: Utility for embeddable wrapper.
- score: 1
component EmojiReactionPicker
- file: src/platform/messaging/components/EmojiReactionPicker.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for emoji reaction picker.
- score: 1
component EmployeeCountWidget
- file: src/platform/dashboard/widgets/EmployeeCountWidget.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for employee count widget.
- score: 1
component EmployeeSelector
- file: src/platform/workforce/EmployeeSelector.tsx:14
- kind: component
- core: platform
- spec: (none)
- summary: Reusable employee selector component with search
- score: 2
component EncryptedTextField
- file: src/platform/forms/components/fields/EncryptedTextField.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Utility for encrypted text field.
- score: 1
component EndEventNode
- file: src/platform/workflow/components/swim-lane-nodes/EndEventNode.tsx:13
- kind: component
- core: platform
- spec: (none)
- summary: End event node — red circle with stop icon.
- score: 2
component EntityFieldConfigPage
- file: src/platform/field-config/pages/EntityFieldConfigPage.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for entity field config page.
- score: 1
component EntraFieldMappingEditor
- file: src/platform/integrations/components/EntraFieldMappingEditor.tsx:63
- kind: component
- core: platform
- spec: (none)
- summary: Utility for entra field mapping editor.
- score: 1
component EntraIDSettingsCard
- file: src/platform/settings/components/EntraIDSettingsCard.tsx:305
- kind: component
- core: platform
- spec: (none)
- summary: Utility for entra idsettings card.
- score: 1
component EntraIDSettingsPage
- file: src/platform/settings/pages/EntraIDSettingsPage.tsx:78
- kind: component
- core: platform
- spec: (none)
- summary: Utility for entra idsettings page.
- score: 1
component EntraPendingChangesReview
- file: src/platform/integrations/components/EntraPendingChangesReview.tsx:56
- kind: component
- core: platform
- spec: (none)
- summary: Utility for entra pending changes review.
- score: 1
component EntraPermissionsList
- file: src/platform/integrations/components/EntraPermissionsList.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Renders granted vs missing Graph application permissions from a live token probe.
- score: 2
component EntraRoleLicenseMapCard
- file: src/platform/integrations/components/EntraRoleLicenseMapCard.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Settings card mapping PF-30 system roles to Office 365 license SKUs(PF-63-EN-01). Offers a picker over the tenant’s live subscribed SKUs whenfetchable, with validated free-form GUID entry as the fallback (FR-3).
- score: 2
component EntraUnmatchedUsersCard
- file: src/platform/integrations/components/EntraUnmatchedUsersCard.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Utility for entra unmatched users card.
- score: 1
component ErrorFallback
- file: src/platform/monitoring/ErrorFallback.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for error fallback.
- score: 1
component ExcelViewer
- file: src/platform/documents/ExcelViewer.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Utility for excel viewer.
- score: 1
component ExecutiveDashboardPage
- file: src/platform/dashboard/pages/ExecutiveDashboardPage.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for executive dashboard page.
- score: 1
component ExportDiagramDropdown
- file: src/platform/workflow/components/ExportDiagramDropdown.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Export dropdown with PDF, PNG, and BPMN options.
- score: 2
component ExportHistoryPage
- file: src/platform/export/pages/ExportHistoryPage.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Utility for export history page.
- score: 1
component ExportMenu
- file: src/platform/table-v2/components/ExportMenu.tsx:74
- kind: component
- core: platform
- spec: (none)
- summary: Export dropdown with CSV and Excel options.
- score: 2
component ExportMetricsDialog
- file: src/platform/health/components/ExportMetricsDialog.tsx:46
- kind: component
- core: platform
- spec: (none)
- summary: Utility for export metrics dialog.
- score: 1
component ExportRequestForm
- file: src/platform/export/components/ExportRequestForm.tsx:50
- kind: component
- core: platform
- spec: (none)
- summary: Utility for export request form.
- score: 1
component ExportTemplateFormDialog
- file: src/platform/export/components/ExportTemplateFormDialog.tsx:56
- kind: component
- core: platform
- spec: (none)
- summary: Utility for export template form dialog.
- score: 1
component ExportTemplatesPage
- file: src/platform/export/pages/ExportTemplatesPage.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for export templates page.
- score: 1
component ExpressionEditor
- file: src/platform/wizards/components/ExpressionEditor.tsx:38
- kind: component
- core: platform
- spec: (none)
- summary: Utility for expression editor.
- score: 1
component ExpressionFunctionDocs
- file: src/platform/wizards/components/ExpressionFunctionDocs.tsx:46
- kind: component
- core: platform
- spec: (none)
- summary: Utility for expression function docs.
- score: 1
component ExpressionRuleBuilder
- file: src/platform/wizards/components/ExpressionRuleBuilder.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Utility for expression rule builder.
- score: 1
component ExpressionTestRunner
- file: src/platform/wizards/components/ExpressionTestRunner.tsx:38
- kind: component
- core: platform
- spec: (none)
- summary: Utility for expression test runner.
- score: 1
component FavoriteToggle
- file: src/platform/data-manager/components/FavoriteToggle.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for favorite toggle.
- score: 1
component FeatureFlagFormDialog
- file: src/platform/feature-flags/components/FeatureFlagFormDialog.tsx:136
- kind: component
- core: platform
- spec: (none)
- summary: Feature flag create/edit dialog with variant editor and delete support.
- score: 2
component FeatureFlagsPage
- file: src/platform/feature-flags/pages/FeatureFlagsPage.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Feature flags admin page with list, toggle, edit, and delete.
- score: 2
component FieldAssignmentPanel
- file: src/platform/page-layouts/components/FieldAssignmentPanel.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field assignment panel.
- score: 1
component FieldConfigDialog
- file: src/platform/page-layouts/components/FieldConfigDialog.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field config dialog.
- score: 1
component FieldConfigForm
- file: src/platform/field-config/components/FieldConfigForm.tsx:70
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field config form.
- score: 1
component FieldConfigLayoutEditor
- file: src/platform/field-config/components/FieldConfigLayoutEditor.tsx:78
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field config layout editor.
- score: 1
component FieldConfigPreview
- file: src/platform/field-config/components/FieldConfigPreview.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field config preview.
- score: 1
component FieldConfigTable
- file: src/platform/field-config/components/FieldConfigTable.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field config table.
- score: 1
component FieldConfigVersionHistory
- file: src/platform/field-config/components/FieldConfigVersionHistory.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field config version history.
- score: 1
component FieldCrossValidationError
- file: src/platform/conditional-logic/components/CrossFieldValidationErrors.tsx:123
- kind: component
- core: platform
- spec: (none)
- summary: Display cross-field validation errors for a specific fieldFilters errors to only show those involving the specified field
- score: 2
component FieldEditorDialog
- file: src/platform/wizards/components/FieldEditorDialog.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field editor dialog.
- score: 1
component FieldFormInput
- file: src/platform/page-layouts/components/rendering/FieldFormInput.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field form input.
- score: 1
component FieldListItem
- file: src/platform/wizards/components/FieldListItem.tsx:70
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field list item.
- score: 1
component FieldListPanel
- file: src/platform/wizards/components/FieldListPanel.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field list panel.
- score: 1
component FieldMappingEditor
- file: src/platform/import/components/FieldMappingEditor.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Field mapping editor component.Shows target fields with dropdowns to pick the source column.
- score: 2
component FieldPermissionsSection
- file: src/platform/data-manager/components/FieldPermissionsSection.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Renders a searchable table for configuring field-level visibility and edit permissions for custom fields.Displays only fields sourced as , allows filtering by field name or label, and provides a permissionselector per editable system role. User changes are reported via the callback. - fields: Array of field metadata; only fields with are shown. - permissions: Current field-permission records used to derive each selector’s initial value. - onPermissionChange: Callback invoked when a permission is changed: (fieldName, role, level) = void. - disabled: If true, all permission controls are disabled (defaults to ).
- example: | FieldPermissionsSection fields=[ name: ‘favorite_color’, label: ‘Favorite Color’, source: ‘custom’ ] permissions=[ field_name: ‘favorite_color’, role: ‘member’, permission_level: ‘read’ ] onPermissionChange=(field, role, level) = handleChange(field, role, level)/
- score: 5
component FieldRenderer
- file: src/platform/page-layouts/components/rendering/FieldRenderer.tsx:48
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field renderer.
- score: 1
component FieldSelector
- file: src/platform/conditional-logic/components/builder/FieldSelector.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field selector.
- score: 1
component FieldValidationSection
- file: src/platform/wizards/components/FieldValidationSection.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field validation section.
- score: 1
component FieldValueDisplay
- file: src/platform/page-layouts/components/rendering/FieldValueDisplay.tsx:129
- kind: component
- core: platform
- spec: (none)
- summary: Utility for field value display.
- score: 1
component FilePreview
- file: src/platform/messaging/components/FileUploadButton.tsx:166
- kind: component
- core: platform
- spec: (none)
- summary: Utility for file preview.
- score: 1
component FileUploadButton
- file: src/platform/messaging/components/FileUploadButton.tsx:53
- kind: component
- core: platform
- spec: (none)
- summary: Utility for file upload button.
- score: 1
component FileUploadButton
- file: src/platform/upload/components/FileUploadButton.tsx:62
- kind: component
- core: platform
- spec: (none)
- summary: Button that triggers file upload with inline progress.
- score: 5
component FileUploadDialog
- file: src/platform/upload/components/FileUploadDialog.tsx:70
- kind: component
- core: platform
- spec: (none)
- summary: Modal dialog for file uploads with drag-and-drop support.
- score: 5
component FileUploadField
- file: src/platform/forms/components/fields/FileUploadField.tsx:55
- kind: component
- core: platform
- spec: (none)
- summary: File upload field with drag-and-drop, progress tracking, and preview.
- score: 2
component FilterBuilder
- file: src/platform/reports/components/FilterBuilder.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Utility for filter builder.
- score: 1
component FleetAuditPage
- file: src/platform/fleet/pages/FleetAuditPage.tsx:81
- kind: component
- core: platform
- spec: (none)
- summary: Fleet Compliance PHI-Access Audit page.Designed for compliance officers: shows who (agent + authorizer), what(resource_table + operation), the governance approval reference, PHIcategory, and when — content-free by design. No PHI values are rendered.Route: /settings/platform/fleet/audit (flag-gated pf.agents.fleet_enabled)Permission: pf.audit.phi_access.view (enforced server-side by RLS)
- score: 2
component FleetControlTowerPage
- file: src/platform/fleet/pages/FleetControlTowerPage.tsx:51
- kind: component
- core: platform
- spec: (none)
- summary: Fleet Control Tower — agent usage overview dashboard.Renders aggregate StatCards (total calls, cost, PHI touches) and aper-agent/session detail table. All columns are metadata/cost only —no prompt bodies, response text, or PHI content is ever rendered here.Route: /settings/platform/fleet (flag-gated pf.agents.fleet_enabled)Permission: pf.audit.phi_access.view (enforced server-side on the RPC)
- score: 2
component FollowUpStep
- file: src/platform/telephony/components/quick-disposition-steps/FollowUpStep.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Follow-up scheduling step. Toggle enables date picker;if toggled on, a future date is required to advance. Optional task creation checkbox.
- score: 2
component FormAnalyticsProvider
- file: src/platform/forms/components/FormAnalyticsProvider.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for form analytics provider.
- score: 1
component FormattedBytes
- file: src/platform/formatting/components.tsx:141
- kind: component
- core: platform
- spec: (none)
- summary: Display file size in human-readable format
- score: 2
component FormattedCurrency
- file: src/platform/formatting/components.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Display currency with organization preferences
- score: 2
component FormattedDate
- file: src/platform/formatting/components.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Display date with organization preferences
- score: 2
component FormattedDateTime
- file: src/platform/formatting/components.tsx:66
- kind: component
- core: platform
- spec: (none)
- summary: Display date and time with organization preferences
- score: 2
component FormattedNumber
- file: src/platform/formatting/components.tsx:86
- kind: component
- core: platform
- spec: (none)
- summary: Display number with organization preferences
- score: 2
component FormattedPercent
- file: src/platform/formatting/components.tsx:109
- kind: component
- core: platform
- spec: (none)
- summary: Display percentage with organization preferences
- score: 2
component FormattedPhone
- file: src/platform/formatting/components.tsx:126
- kind: component
- core: platform
- spec: (none)
- summary: Display formatted phone number
- score: 2
component FormattingSettings
- file: src/platform/organizations/components/FormattingSettings.tsx:53
- kind: component
- core: platform
- spec: (none)
- summary: Utility for formatting settings.
- score: 1
component FormattingToolbar
- file: src/platform/messaging/components/FormattingToolbar.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Markdown formatting toolbar for the message composer.
- score: 2
component FormEmbed
- file: src/platform/forms/FormEmbed.tsx:50
- kind: component
- core: platform
- spec: (none)
- summary: Utility for form embed.
- score: 1
component FormFieldWithHelp
- file: src/platform/help/FormFieldWithHelp.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: Utility for form field with help.
- score: 1
component FormProgressIndicator
- file: src/platform/forms/components/FormProgressIndicator.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for form progress indicator.
- score: 1
component FormRendererRHF
- file: src/platform/forms/FormRendererRHF.tsx:119
- kind: component
- core: platform
- spec: (none)
- summary: React Hook Form based form rendererKey improvements over FormRenderer:- Uses react-hook-form for state management (less re-renders)- Zod schema validation via zodResolver- Better TypeScript integration- Controller-based field registration
- score: 2
component FormSelector
- file: src/platform/forms/FormSelector.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for form selector.
- score: 1
component FormStep
- file: src/platform/wizards/components/steps/FormStep.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for form step.
- score: 1
component FormStepField
- file: src/platform/wizards/components/steps/FormStepField.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for form step field.
- score: 1
component GenerateFromPolicyDialog
- file: src/platform/workflow/components/GenerateFromPolicyDialog.tsx:83
- kind: component
- core: platform
- spec: (none)
- summary: Utility for generate from policy dialog.
- score: 1
component GenerateFromProcedureDialog
- file: src/platform/workflow/components/GenerateFromProcedureDialog.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: Utility for generate from procedure dialog.
- score: 1
component GenerateLayoutsButton
- file: src/platform/page-layouts/components/data-manager/GenerateLayoutsButton.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for generate layouts button.
- score: 1
component GenerateSimilarDialog
- file: src/platform/wizards/components/GenerateSimilarDialog.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Utility for generate similar dialog.
- score: 1
component GestureAnalyticsPage
- file: src/platform/settings/pages/GestureAnalyticsPage.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Utility for gesture analytics page.
- score: 1
component GesturePreferencesPage
- file: src/platform/settings/pages/GesturePreferencesPage.tsx:47
- kind: component
- core: platform
- spec: (none)
- summary: Utility for gesture preferences page.
- score: 1
component GettingStartedCard
- file: src/platform/setup/components/GettingStartedCard.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for getting started card.
- score: 1
component GettingStartedPage
- file: src/platform/settings/pages/GettingStartedPage.tsx:13
- kind: component
- core: platform
- spec: (none)
- summary: Utility for getting started page.
- score: 1
component GlobalSearch
- file: src/platform/navigation/GlobalSearch.tsx:117
- kind: component
- core: platform
- spec: (none)
- summary: Utility for global search.
- score: 1
component GoogleWorkspaceSettingsPage
- file: src/platform/settings/pages/GoogleWorkspaceSettingsPage.tsx:230
- kind: component
- core: platform
- spec: (none)
- summary: Google Workspace Settings page (PF-101).
- score: 2
component GoogleWorkspaceSetupDialog
- file: src/platform/settings/components/GoogleWorkspaceSetupDialog.tsx:108
- kind: component
- core: platform
- spec: (none)
- summary: Renders the PF-101 setup wizard for Google Workspace connection metadata,capability gates, service-account credentials, and OAuth authorization.
- score: 2
component GroupedRows
- file: src/platform/table-v2/components/GroupedRows.tsx:56
- kind: component
- core: platform
- spec: (none)
- summary: Renders a collapsible group header row for TanStack Table grouped data.
- score: 5
component GuidedKnowledgeSeedingEntry
- file: src/platform/knowledge/components/GuidedKnowledgeSeedingEntry.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Standalone guided org-knowledge seeding entry.Frames as an admin entry point. All branching (import vs author)and the publish path are owned by ; this component adds only the entryheading/context. Reuses existing knowledge write permission — no new permission key.
- params:
- props —
- score: 2
component HeaderBackButton
- file: src/platform/navigation/components/HeaderBackButton.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Renders the canonical app-chrome back button. Returns on root /module-dashboard routes so the chrome doesn’t reserve dead space.
- score: 2
component HeaderQuickActions
- file: src/platform/navigation/components/HeaderQuickActions.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Renders pinned quick actions as inline header buttons (up to 3),plus a palette trigger button. Press Q to open the full searchable command palette.
- score: 2
component HeadshotConsentDialog
- file: src/platform/headshot/components/HeadshotConsentDialog.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Biometric consent dialog for headshot generation.
- score: 2
component HeadshotGallery
- file: src/platform/headshot/components/HeadshotGallery.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Gallery grid for generated headshots.
- score: 2
component HeadshotLightbox
- file: src/platform/headshot/components/HeadshotLightbox.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Full-size image lightbox with navigation.
- score: 2
component HeadshotStatusBanner
- file: src/platform/headshot/components/HeadshotStatusBanner.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Banner showing status of in-progress headshot generation jobs.
- score: 2
component HeadshotUploadWizard
- file: src/platform/headshot/components/HeadshotUploadWizard.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Upload wizard dialog for headshot generation.
- score: 2
component HealthOverviewCard
- file: src/platform/health/components/HealthOverviewCard.tsx:88
- kind: component
- core: platform
- spec: (none)
- summary: Utility for health overview card.
- score: 1
component HelpButton
- file: src/platform/help/HelpPanel.tsx:140
- kind: component
- core: platform
- spec: (none)
- summary: Simple help button that opens the panel.Use when you just need the trigger without configuration.
- score: 2
component HelpPage
- file: src/platform/help/HelpPage.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for help page.
- score: 1
component HelpPanel
- file: src/platform/help/HelpPanel.tsx:73
- kind: component
- core: platform
- spec: (none)
- summary: Utility for help panel.
- score: 1
component HistoricalAnalysisPage
- file: src/platform/health/pages/HistoricalAnalysisPage.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for historical analysis page.
- score: 1
component HolidayImportDialog
- file: src/platform/calendar/components/HolidayImportDialog.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for importing holidays from a CSV file.
- score: 2
component HolidayPreviewTable
- file: src/platform/calendar/components/HolidayPreviewTable.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Renders a preview table of parsed holiday rows.
- score: 2
component HolidayTemplateSelector
- file: src/platform/calendar/components/HolidayTemplateSelector.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for selecting and applying holiday templates to a business calendar.
- score: 2
component ICD10HierarchyNavigator
- file: src/platform/terminology/components/ICD10HierarchyNavigator.tsx:36
- kind: component
- core: platform
- spec: (none)
- summary: ICD10HierarchyNavigator — navigates the ICD-10 hierarchyfrom chapters down to individual codes.
- score: 2
component IdentityBrandVoiceStep
- file: src/platform/ai/components/onboarding/IdentityBrandVoiceStep.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Renders the Identity & Brand Voice step.
- params:
- props — .
- score: 2
component IdentityStep
- file: src/platform/ai/wizards/ai-skill-creation/steps/IdentityStep.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: Renders Step 1 (Identity & Use Case).
- params:
- props — The shared form instance.
- score: 2
component ImportBatchDetailSheet
- file: src/platform/import/components/ImportBatchDetailSheet.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Detail sheet for a single import batch.
- score: 2
component ImportBpmnDialog
- file: src/platform/workflow/components/ImportBpmnDialog.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for importing BPMN XML files into swim lane diagrams.
- score: 2
component ImportFilePreview
- file: src/platform/import/components/ImportFilePreview.tsx:47
- kind: component
- core: platform
- spec: (none)
- summary: Table preview of parsed import data with automatic PHI masking.
- score: 2
component ImportHistoryPage
- file: src/platform/import/pages/ImportHistoryPage.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Import history page showing all batches with detail drill-down.
- score: 2
component ImportProgressCard
- file: src/platform/import/components/ImportProgressCard.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Displays import execution progress with a determinate progress bar.
- score: 2
component ImportSkillDialog
- file: src/platform/ai/components/ImportSkillDialog.tsx:36
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for importing AI skills from SKILL.md files.Provides a file picker, parsed preview, conflict detection withRename/Replace options, and a final import action.
- params:
- props — Component props. - open: Whether the dialog is open. - onOpenChange: Callback when open state changes.
- score: 2
component ImportUploadPage
- file: src/platform/import/pages/ImportUploadPage.tsx:47
- kind: component
- core: platform
- spec: (none)
- summary: Upload page for the PF-88 import framework.
- score: 2
component InAppTestCard
- file: src/platform/notifications/components/testing/ChannelTestCards.tsx:213
- kind: component
- core: platform
- spec: (none)
- summary: Renders the in app test card interface.
- score: 2
component IncomingCallProvider
- file: src/platform/telephony/components/IncomingCallProvider.tsx:51
- kind: component
- core: platform
- spec: (none)
- summary: Wraps application content to subscribe to incoming call events and display a screen-pop toast.Renders its children and, when subscription is active and an incoming call exists, shows an IncomingCallToast that can be dismissed or auto-dismissed. - children: React node(s) to render inside the provider. - enabled: When , enables subscription to incoming call notifications; set to to disable screen pops while still rendering children. Defaults to . - autoDismissSeconds: Number of seconds before the incoming call toast auto-dismisses. Set to to disable auto-dismiss. Defaults to . - onIncomingCall: Optional callback invoked with the incoming when a new incoming call is detected.Accessibility considerations: the IncomingCallToast should manage focus and ARIA attributes so screen-reader users are notified of incoming call events; ensure the provider is placed where toast context and focus management are available.
- score: 5
component IncomingCallToast
- file: src/platform/telephony/components/IncomingCallToast.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Renders a screen-pop toast for an incoming call with quick actions.Displays the caller name when a contact or partner is matched, falls back to a masked phone number for unknown callers, auto-dismisses after a configurable timeout, and can navigate to the related contact or partner record.Accessibility: the toast uses role=“alert” and aria-live=“polite” to announce incoming calls, and the dismiss button includes an accessible label.
- params:
- call — Incoming call data including related contact or partner entities (used to derive display name and navigation targets)
- onDismiss — Callback invoked when the toast is dismissed (via timer, Escape key, dismiss button, or after navigation)
- autoDismissSeconds — Number of seconds before the toast auto-dismisses; a value = 0 disables auto-dismiss (default: 30)
- className — Optional additional CSS class names applied to the toast container
- returns: The rendered incoming-call toast element
- score: 4
component IndexRecommendationsList
- file: src/platform/query-performance/components/IndexRecommendationsList.tsx:119
- kind: component
- core: platform
- spec: (none)
- summary: Renders the index recommendations list with Apply/Copy DDL actions.
- score: 2
component InfoTooltip
- file: src/platform/help/InfoTooltip.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: Utility for info tooltip.
- score: 1
component InlineCreatePicklistOption
- file: src/platform/import/components/InlineCreatePicklistOption.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Permission-gated button that opens the shared to addan option to the current org’s copy of . No-ops (disabled) whenthe org has no own copy of the picklist.
- score: 2
component InlineEditCell
- file: src/platform/table-v2/components/InlineEditCell.tsx:69
- kind: component
- core: platform
- spec: (none)
- summary: Cell wrapper that toggles between read mode and edit mode.
- score: 5
component InModuleSidebar
- file: src/platform/navigation/components/InModuleSidebar.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: In-module sidebar view showing module overview, grouped nav items, and settings.Displayed when user is inside a specific module.Enhanced with smooth transitions, staggered animations, and keyboard navigation.
- score: 2
component IntegrationCard
- file: src/platform/integrations/components/IntegrationCard.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Utility for integration card.
- score: 1
component IntegrationDetail
- file: src/platform/integrations/components/IntegrationDetail.tsx:52
- kind: component
- core: platform
- spec: (none)
- summary: Utility for integration detail.
- score: 1
component IntegrationDetailPage
- file: src/platform/settings/pages/IntegrationDetailPage.tsx:14
- kind: component
- core: platform
- spec: (none)
- summary: Utility for integration detail page.
- score: 1
component IntegrationDetailSkeleton
- file: src/platform/integrations/components/skeletons/IntegrationDetailSkeleton.tsx:11
- kind: component
- core: platform
- spec: (none)
- summary: Utility for integration detail skeleton.
- score: 1
component IntegrationForm
- file: src/platform/integrations/components/IntegrationForm.tsx:36
- kind: component
- core: platform
- spec: (none)
- summary: Utility for integration form.
- score: 1
component IntegrationList
- file: src/platform/integrations/components/IntegrationList.tsx:59
- kind: component
- core: platform
- spec: (none)
- summary: Utility for integration list.
- score: 1
component IntegrationListSkeleton
- file: src/platform/integrations/components/skeletons/IntegrationListSkeleton.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for integration list skeleton.
- score: 1
component IntegrationsPage
- file: src/platform/settings/pages/IntegrationsPage.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for integrations page.
- score: 1
component IntegrationStatusBadge
- file: src/platform/integrations/components/StatusBadge.tsx:38
- kind: component
- core: platform
- spec: (none)
- summary: Integration status badge. Composes the shared so visualconventions stay consistent across the platform.
- score: 2
component InvitationActivityFeed
- file: src/platform/users/InvitationActivityFeed.tsx:83
- kind: component
- core: platform
- spec: (none)
- summary: Activity timeline of invitation lifecycle events for the active org.
- score: 2
component InviteUserDialog
- file: src/platform/users/InviteUserDialog.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for invite user dialog.
- score: 1
component IpListsPage
- file: src/platform/security/pages/IpListsPage.tsx:51
- kind: component
- core: platform
- spec: (none)
- summary: Utility for ip lists page.
- score: 1
component JoinBuilder
- file: src/platform/reports/components/JoinBuilder.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for join builder.
- score: 1
component JurisdictionSettingsSection
- file: src/platform/jurisdiction/components/JurisdictionSettingsSection.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Jurisdiction settings section for the org settings page.
- score: 2
component JurisdictionStep
- file: src/platform/ai/components/onboarding/JurisdictionStep.tsx:53
- kind: component
- core: platform
- spec: (none)
- summary: Renders the State & Medicaid Program step.
- params:
- props — .
- score: 2
component KeyboardShortcutsDialog
- file: src/platform/navigation/KeyboardShortcutsDialog.tsx:66
- kind: component
- core: platform
- spec: (none)
- summary: Utility for keyboard shortcuts dialog.
- score: 1
component KnowledgeArticleCard
- file: src/platform/knowledge/components/KnowledgeArticleCard.tsx:62
- kind: component
- core: platform
- spec: (none)
- summary: Renders a card representing a knowledge article with title, metadata, badges, tags, and contextual actions.Displays the article title and optional summary, status and category badges, an “Indexed” indicator when applicable,up to three tag badges with an overflow counter, and a footer showing relative update time and embedding count.Optionally shows a selection checkbox and a dropdown menu with Edit, Publish, Archive, and Delete actions dependingon article state and provided handlers.Accessibility:- The selection checkbox includes an aria-label “Select article.title” for screen readers.- The actions button includes a visually hidden label (“Actions”) for screen readers.
- params:
- props — Component props - article: KnowledgeArticle object to render (title, summary, status, category, tags, indexing and counts) - selected: Whether the article is selected; controls the checkbox checked state (default: false) - onSelect: Callback fired with the new checked state when the checkbox changes - onEdit: Callback invoked when the Edit action is chosen - onPublish: Callback invoked when Publish is chosen (shown only for draft articles) - onArchive: Callback invoked when Archive is chosen (shown only for published articles) - onDelete: Callback invoked when Delete is chosen - showCheckbox: Whether to render the selection checkbox (default: false)
- example: | KnowledgeArticleCard article=article selected=isSelected onSelect=(checked) = setSelected(checked) onEdit=() = openEditor(article.id) onPublish=() = publishArticle(article.id) onDelete=() = deleteArticle(article.id) showCheckbox/
- score: 4
component KnowledgeArticleEditor
- file: src/platform/knowledge/components/KnowledgeArticleEditor.tsx:111
- kind: component
- core: platform
- spec: (none)
- summary: Form UI for creating or editing a knowledge article, including draft save, optional publish,document import, category and tag management, and validation.Renders a full editor with title, summary, category, tags, and content fields; supports importingcontent from an existing document, saving as draft, and publishing (with confirmation). - article: Existing article to edit; when omitted the editor operates in create mode. - onSave: Callback invoked to save the article payload (draft or create/update). - onPublish: Optional callback invoked when the user confirms publishing. - onCancel: Callback invoked when the user cancels editing/creation. - isLoading: Optional flag to disable inputs and show loading indicators.
- example: | KnowledgeArticleEditor article=existingArticle onSave=async (payload) = await api.saveArticle(payload); onPublish=async (payload) = await api.publishArticle(payload); onCancel=() = navigateBack() isLoading=false/Accessibility- Form fields include labels and id attributes for screen reader association.- Actions are standard buttons and dialogs that follow native keyboard interaction (focusable, dismissible).
- score: 5
component KnowledgeArticleEditPage
- file: src/platform/knowledge/pages/KnowledgeArticleEditPage.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Page for creating a new knowledge article or editing an existing one.Renders an editor wrapped in the application page container, manages create/update/publish flows,and navigates to the article list or detail page after actions. In “new” mode the editor isinitialized empty; in edit mode it loads the article and shows loading and not-found states as needed.Accessibility: breadcrumbs are provided for orientation. The editor exposes save, publish, and cancelactions; ensure keyboard and screen-reader support is provided by the underlying editor component.
- example: | import KnowledgeArticleEditPage from ‘src/platform/knowledge/pages/KnowledgeArticleEditPage’;// Used directly as a route component:Route path=“/settings/knowledge-base/:id” element=KnowledgeArticleEditPage / /
- score: 5
component KnowledgeBaseListPage
- file: src/platform/knowledge/pages/KnowledgeBaseListPage.tsx:46
- kind: component
- core: platform
- spec: (none)
- summary: Renders and manages the Knowledge Base list page with search, filters, selection, bulk actions, and CRUD workflows.This component synchronizes search, status, and category filters with the URL query string (debounced for search),fetches and displays knowledge articles, and exposes per-item and bulk operations (publish, archive, delete).It also provides navigation to create and edit pages and shows a confirmation dialog for deletions.Accessibility:- Uses standard form controls and semantic headings for screen-reader navigation.- Dialogs and interactive controls use accessible primitives (ConfirmationDialog, Select, Button); ensure focus management is retained when composing into pages.
- returns: The rendered Knowledge Base list page UI.
- example: | KnowledgeBaseListPage /
- score: 5
component KnowledgeSourcesStep
- file: src/platform/ai/components/onboarding/KnowledgeSourcesStep.tsx:42
- kind: component
- core: platform
- spec: (none)
- summary: Renders the Knowledge Sources step.
- params:
- props — .
- score: 2
component KnowledgeSourcesStep
- file: src/platform/ai/wizards/ai-skill-creation/steps/KnowledgeSourcesStep.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Renders Step 3 (column-based RAG configuration over published PF-61 categories).
- params:
- props — The shared form instance.
- score: 2
component KnowledgeStatusBadge
- file: src/platform/knowledge/components/KnowledgeStatusBadge.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: Renders a status badge for a knowledge article, optionally including a status icon.Renders a Badge whose variant and label are derived from STATUS_CONFIG for the provided . When is true, the corresponding status icon is shown to the left of the label.
- params:
- props — Component props - status: The knowledge article status (controls badge color and label) - showIcon: Whether to render the status icon next to the label (defaults to ) - className: Optional additional CSS class names applied to the Badge
- returns: A JSX element rendering the status Badge for the given .
- example: | KnowledgeStatusBadge status=“published” /Accessibility:The component relies on the Badge component for semantic markup and accessibility. Ensure Badge is implemented with appropriate semantic role and focus handling if the status needs to be announced to assistive technologies.
- score: 4
component LaneHeaderNode
- file: src/platform/workflow/components/swim-lane-nodes/LaneHeaderNode.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Custom node type rendering a visible lane header with label, role, and color stripe.
- score: 2
component LayoutBuilderPage
- file: src/platform/field-config/pages/LayoutBuilderPage.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for layout builder page.
- score: 1
component LayoutCard
- file: src/platform/page-layouts/components/data-manager/LayoutCard.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for layout card.
- score: 1
component LayoutEditor
- file: src/platform/page-layouts/components/LayoutEditor.tsx:46
- kind: component
- core: platform
- spec: (none)
- summary: Utility for layout editor.
- score: 1
component LayoutEditorPage
- file: src/platform/page-layouts/components/data-manager/LayoutEditorPage.tsx:16
- kind: component
- core: platform
- spec: (none)
- summary: Utility for layout editor page.
- score: 1
component LayoutEditorSkeleton
- file: src/platform/page-layouts/components/LayoutEditorSkeleton.tsx:13
- kind: component
- core: platform
- spec: (none)
- summary: Utility for layout editor skeleton.
- score: 1
component LayoutPreview
- file: src/platform/page-layouts/components/LayoutPreview.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for layout preview.
- score: 1
component LayoutRenderer
- file: src/platform/page-layouts/components/rendering/LayoutRenderer.tsx:52
- kind: component
- core: platform
- spec: (none)
- summary: Utility for layout renderer.
- score: 1
component LayoutRendererSkeleton
- file: src/platform/page-layouts/components/rendering/LayoutRendererSkeleton.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for layout renderer skeleton.
- score: 1
component LayoutsTab
- file: src/platform/page-layouts/components/data-manager/LayoutsTab.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for layouts tab.
- score: 1
component LayoutsTable
- file: src/platform/page-layouts/components/data-manager/LayoutsTable.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Utility for layouts table.
- score: 1
component LayoutVersionHistory
- file: src/platform/page-layouts/components/LayoutVersionHistory.tsx:38
- kind: component
- core: platform
- spec: (none)
- summary: Utility for layout version history.
- score: 1
component LazyWidget
- file: src/platform/dashboard/components/LazyWidget.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for lazy widget.
- score: 1
component LegalHoldDialog
- file: src/platform/data-retention/components/LegalHoldDialog.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Utility for legal hold dialog.
- score: 1
component LetterheadCard
- file: src/platform/templates/components/LetterheadCard.tsx:56
- kind: component
- core: platform
- spec: (none)
- summary: Render a card for a letterhead item showing its preview, metadata, and optional management actions.Displays the letterhead name, optional description, default and system badges, a compact preview, and theorganization display name when present. When is true, an accessible action menu exposes Edit,Clone, Set as Default, and Delete actions depending on the letterhead’s state and provided callbacks.Accessibility:- The action menu trigger includes an (“Letterhead actions”) to describe the button.- The preview includes an appropriate attribute derived from the letterhead name.
- params:
- props — Component props - letterhead: Letterhead data to display (id, name, description, logo_url, is_system, is_default, org_name_display). - onEdit: Optional callback invoked with the letterhead id when “Edit” is selected. Not shown for system letterheads. - onDelete: Optional callback invoked with the letterhead id when “Delete” is selected. Not shown for system letterheads. - onSetDefault: Optional callback invoked with the letterhead id when “Set as Default” is selected. Shown only for non-system, non-default letterheads. - onClone: Optional callback invoked with the letterhead id when “Clone” is selected. - canManage: When true, shows the action dropdown; defaults to .
- returns: The rendered JSX element for the letterhead card.
- example: | LetterheadCard letterhead=letterhead canManage onEdit=(id) = openEditModal(id) onDelete=(id) = confirmDelete(id) onSetDefault=(id) = setDefault(id) onClone=(id) = cloneLetterhead(id)/
- score: 4
component LetterheadEditor
- file: src/platform/templates/pages/LetterheadEditor.tsx:115
- kind: component
- core: platform
- spec: (none)
- summary: Page for creating, editing, or cloning an organization’s letterhead configuration.Renders a multi-section form (Basic Information, Organization Details, Logo, Header Options, Footer Options)with validation and live preview. Supports three modes determined by route and query parameters:create (no ), edit ( present and not ), and clone (). On submit the formwill create or update the letterhead and navigate back to the letterheads settings tab.Accessibility:- Form controls use proper labels and role semantics provided by the shared Form primitives.- Back and Cancel buttons include descriptive aria-labels where appropriate.
- example: | LetterheadEditor /
- score: 5
component LetterheadListPage
- file: src/platform/templates/pages/LetterheadListPage.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Page that lists an organization’s letterheads (including system templates) and provides UI to create, edit, clone, set a default, and delete letterheads when permitted.Renders responsive sections for organization-specific letterheads and system templates, handles loading and error states, and shows a confirmation dialog for deletions. Actions that modify data display success or error toasts.Accessibility:- Dialogs and buttons use accessible primitives; the delete confirmation is presented in a modal dialog to prevent accidental deletion.- Interactive controls include visible labels and focusable targets.
- returns: The page UI for viewing and managing letterheads as a React element.
- example: | LetterheadListPage /
- score: 5
component LetterheadMiniPreview
- file: src/platform/templates/components/LetterheadMiniPreview.tsx:54
- kind: component
- core: platform
- spec: (none)
- summary: Render a compact visual preview of a letterhead layout configuration.Renders a miniature document showing configured logo placement, header elements (organization name, address, contact),an optional header color bar, placeholder content lines, and a compact footer that can include confidentiality textand page numbers. The preview reflects runtime header_config and footer_config with sensible defaults.
- params:
- props — Component props - letterhead: Letterhead data object containing layout and display configuration (header_config, footer_config, logo_position, logo_url, etc.). - className: Optional utility class names to apply to the outer preview container.
- returns: A JSX element representing the small visual letterhead preview.
- example: | LetterheadMiniPreview letterhead= header_config: showLogo: true, barColor: ‘#1e90ff’ , footer_config: showPageNumbers: true , logo_position: ‘left’, logo_url: ‘https://example.com/logo.png’ /Accessibility considerations: The component is decorative and uses visual placeholders; the logo image uses an empty attribute to indicate it’s non-informative. If the preview conveys semantic meaning in your UI, provide appropriate accessible labeling on the surrounding container (e.g., ) when used in interactive or informative contexts.
- score: 4
component LetterheadPreview
- file: src/platform/templates/components/LetterheadPreview.tsx:96
- kind: component
- core: platform
- spec: (none)
- summary: Render a scalable preview of a letterhead using the provided partial letterhead configuration.Renders an 8.5x11 preview including an optional top color bar, header (logo, organization name,address, contact), content placeholder (editable or read-only skeleton), and footer (confidentialitytext and page number). Sections render only when their corresponding configuration flags are notexplicitly set to , and missing data is handled gracefully.
- params:
- props — Component props - letterhead: Partial letterhead data that drives the preview (header/footer configs, logo, organization text, address, contact info, logo sizing/position). Missing fields are ignored. - scale: Scale factor applied to the preview container (default: 1). - className: Additional CSS classes applied to the outer preview container. - isEditing: When , shows an editing placeholder in the content area; otherwise shows a read-only skeleton (default: ).
- returns: A React element containing the rendered letterhead preview.
- example: | LetterheadPreview letterhead= org_name_display: ‘Acme Corp’, logo_url: ‘/logo.png’ scale=0.8 isEditing=true/Accessibility considerations:- The logo image includes an attribute and the organization name is rendered as a heading to assist screen reader navigation.
- score: 4
component LineageVisualization
- file: src/platform/org-data-sync/components/LineageVisualization.tsx:47
- kind: component
- core: platform
- spec: (none)
- summary: Utility for lineage visualization.
- score: 1
component LinkPreview
- file: src/platform/messaging/components/LinkPreview.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Compact link preview card for messaging.
- score: 2
component LivePreviewPanel
- file: src/platform/email-signatures/components/LivePreviewPanel.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Inline real-time preview of the rendered signature with sample data.
- score: 2
component LoadDefaultMappingsButton
- file: src/platform/settings/pages/data-migration/components/LoadDefaultMappingsButton.tsx:213
- kind: component
- core: platform
- spec: (none)
- summary: Utility for load default mappings button.
- score: 1
component LockConflictDialog
- file: src/platform/wizards/components/LockConflictDialog.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for lock conflict dialog.
- score: 1
component LockScreenOverlay
- file: src/platform/auth/app-lock/LockScreenOverlay.tsx:42
- kind: component
- core: platform
- spec: (none)
- summary: Full-screen lock overlay displayed when the app is locked.Covers all content to prevent PHI exposure.
- score: 2
component LoginAssetsTab
- file: src/platform/theming/components/LoginAssetsTab.tsx:71
- kind: component
- core: platform
- spec: (none)
- summary: Login branding assets tab with import/export functionality.
- score: 2
component LoginBrandPanel
- file: src/platform/auth/components/LoginBrandPanel.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Renders the logo, wordmark, tagline, and capability pillars for the loginpage. Desktop variant includes the real ; mobile variant is wrapped in so assistive technology reads only the card heading.Accepts optional PF-95 tenant branding to override the default Encore OSpresentation (logo image, welcome text).
- score: 2
component LogoUpload
- file: src/platform/templates/components/LogoUpload.tsx:67
- kind: component
- core: platform
- spec: (none)
- summary: Utility for logo upload.
- score: 1
component LogoUpload
- file: src/platform/templates/components/LogoUploadEnhanced.tsx:121
- kind: component
- core: platform
- spec: (none)
- summary: Enhanced logo upload component with validation and preview. Provides drag-and-drop upload for letterhead logos withformat validation (PNG/JPG only), dimension warnings, and size preview.SVG files are explicitly rejected with helpful messaging.
- score: 2
component LogoUploadSection
- file: src/platform/email-signatures/components/LogoUploadSection.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Drag-and-drop or click-to-upload logo with preview and remove.
- score: 2
component LookupFieldRenderer
- file: src/platform/field-config/components/LookupFieldRenderer.tsx:91
- kind: component
- core: platform
- spec: (none)
- summary: Utility for lookup field renderer.
- score: 1
component LookupMultiselectField
- file: src/platform/forms/components/LookupMultiselectField.tsx:36
- kind: component
- core: platform
- spec: (none)
- summary: Lookup-backed multi-select field for form rendering.
- score: 2
component LookupSelectField
- file: src/platform/forms/components/LookupSelectField.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Lookup-backed single-select field for form rendering.
- score: 2
component MappingEditorDialog
- file: src/platform/settings/pages/data-migration/components/MappingEditorDialog.tsx:232
- kind: component
- core: platform
- spec: (none)
- summary: Utility for mapping editor dialog.
- score: 1
component MappingsTab
- file: src/platform/settings/pages/data-migration/components/MappingsTab.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for mappings tab.
- score: 1
component MappingTemplateDialog
- file: src/platform/import/components/MappingTemplateDialog.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for saving/loading/deleting mapping templates.
- score: 2
component MarketplaceEmptyState
- file: src/platform/wizards/components/marketplace/MarketplaceEmptyState.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Utility for marketplace empty state.
- score: 1
component MarketplaceFilters
- file: src/platform/wizards/components/marketplace/MarketplaceFilters.tsx:59
- kind: component
- core: platform
- spec: (none)
- summary: Utility for marketplace filters.
- score: 1
component MarketplaceListingCard
- file: src/platform/wizards/components/marketplace/MarketplaceListingCard.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for marketplace listing card.
- score: 1
component MarketplaceListingDetailPage
- file: src/platform/wizards/pages/MarketplaceListingDetailPage.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for marketplace listing detail page.
- score: 1
component MarketplacePage
- file: src/platform/wizards/pages/MarketplacePage.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for marketplace page.
- score: 1
component MarketplacePreviewDialog
- file: src/platform/wizards/components/marketplace/MarketplacePreviewDialog.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for marketplace preview dialog.
- score: 1
component MarketplaceRatingStars
- file: src/platform/wizards/components/marketplace/MarketplaceRatingStars.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Utility for marketplace rating stars.
- score: 1
component MarketplaceReviewsList
- file: src/platform/wizards/components/marketplace/MarketplaceReviewsList.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for marketplace reviews list.
- score: 1
component MatrixTable
- file: src/platform/table-v2/components/MatrixTable.tsx:74
- kind: component
- core: platform
- spec: (none)
- summary: Standalone matrix/pivot table with sticky row headers.
- score: 5
component MemberManageSheet
- file: src/platform/messaging/components/MemberManageSheet.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Utility for member manage sheet.
- score: 1
component MessageAttachment
- file: src/platform/messaging/components/MessageAttachment.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Renders attachment preview or download link for non-text messages with a file.
- score: 2
component MessageBubble
- file: src/platform/messaging/components/MessageBubble.tsx:46
- kind: component
- core: platform
- spec: (none)
- summary: Utility for message bubble.
- score: 1
component MessageComposer
- file: src/platform/messaging/components/MessageComposer.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Utility for message composer.
- score: 1
component MessageContent
- file: src/platform/messaging/components/MessageContent.tsx:102
- kind: component
- core: platform
- spec: (none)
- summary: Utility for message content.
- score: 1
component MessageSearchDialog
- file: src/platform/messaging/components/MessageSearchDialog.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for message search dialog.
- score: 1
component MessageThread
- file: src/platform/messaging/components/MessageThread.tsx:68
- kind: component
- core: platform
- spec: (none)
- summary: Utility for message thread.
- score: 1
component MessagingPage
- file: src/platform/messaging/pages/MessagingPage.tsx:12
- kind: component
- core: platform
- spec: (none)
- summary: Utility for messaging page.
- score: 1
component MetricChart
- file: src/platform/health/components/MetricChart.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Utility for metric chart.
- score: 1
component MfaChallenge
- file: src/platform/auth/components/MfaChallenge.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: MFA challenge at login. Supports TOTP code entry and WebAuthn passkeyverification, depending on which verified factors the account has.
- score: 2
component MfaEnrollment
- file: src/platform/auth/components/MfaEnrollment.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: MFA enrollment surface: TOTP authenticator app + WebAuthn passkeys.
- score: 2
component MigrateWizardDialog
- file: src/platform/wizards/components/MigrateWizardDialog.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Utility for migrate wizard dialog.
- score: 1
component MigrationStepper
- file: src/platform/settings/pages/data-migration/components/MigrationStepper.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Guided stepper banner for data migration workflow.
- score: 2
component MinimalRichTextField
- file: src/platform/forms/components/fields/RichTextField.tsx:540
- kind: component
- core: platform
- spec: (none)
- summary: Minimal rich text field without toolbarUseful for simple formatting needs
- score: 2
component MobileBreadcrumbs
- file: src/platform/navigation/MobileBreadcrumbs.tsx:69
- kind: component
- core: platform
- spec: (none)
- summary: Utility for mobile breadcrumbs.
- score: 1
component MobileCarouselSkeleton
- file: src/platform/dashboard/components/MobileCarouselSkeleton.tsx:6
- kind: component
- core: platform
- spec: (none)
- summary: Loading skeleton that matches the carousel layout on mobile
- score: 2
component MobileHomeHero
- file: src/platform/dashboard/components/mobile/MobileHomeHero.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: Renders the mobile-only Focus Bento hero for the platform Home dashboard.
- score: 2
component MobileModuleIcon
- file: src/platform/modules/MobileModuleIcon.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for mobile module icon.
- score: 1
component MobileModuleLauncherButton
- file: src/platform/navigation/components/MobileModuleLauncherButton.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for mobile module launcher button.
- score: 1
component MobileModuleNavStrip
- file: src/platform/navigation/components/MobileModuleNavStripImpl.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Horizontally scrollable strip of module section chips below MobileHeader.Auto-scrolls to keep the active chip visible.
- score: 2
component MobileModuleSwitcher
- file: src/platform/modules/MobileModuleSwitcher.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for mobile module switcher.
- score: 1
component MobileNav
- file: src/platform/navigation/MobileNav.tsx:53
- kind: component
- core: platform
- spec: (none)
- summary: Utility for mobile nav.
- score: 1
component MobileNavDockSheetContent
- file: src/platform/navigation/MobileNavDockSheetContent.tsx:178
- kind: component
- core: platform
- spec: (none)
- summary: Utility for mobile nav dock sheet content.
- score: 1
component MobileOrgSwitcher
- file: src/platform/navigation/MobileOrgSwitcher.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for mobile org switcher.
- score: 1
component MobilePullToRefresh
- file: src/platform/gestures/components/MobilePullToRefresh.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: MobilePullToRefresh wraps content with pull-to-refresh only on mobile/touch devices
- score: 5
component MobileSizeSelector
- file: src/platform/dashboard/components/MobileSizeSelector.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for mobile size selector.
- score: 1
component MobileWidgetCarousel
- file: src/platform/dashboard/components/MobileWidgetCarousel.tsx:85
- kind: component
- core: platform
- spec: (none)
- summary: Swipeable widget carousel for mobile devicesShows one widget at a time with dot indicatorsSupports half-width widgets (2 per slide) and edit mode gestures
- score: 2
component ModuleCard
- file: src/platform/modules/ModuleCard.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for module card.
- score: 1
component ModuleConfigurationSection
- file: src/platform/settings/components/ModuleConfigurationSection.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for module configuration section.
- score: 1
component ModuleCoverageTable
- file: src/platform/health/components/ModuleCoverageTable.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Utility for module coverage table.
- score: 1
component ModuleDashboard
- file: src/platform/dashboard/components/ModuleDashboard.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: Utility for module dashboard.
- score: 1
component ModuleFormsPage
- file: src/platform/forms/ModuleFormsPage.tsx:46
- kind: component
- core: platform
- spec: (none)
- summary: Utility for module forms page.
- score: 1
component ModuleHeader
- file: src/platform/navigation/components/shared/ModuleHeader.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for module header.
- score: 1
component ModuleList
- file: src/platform/navigation/components/ModuleList.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Lists all accessible modules in the sidebar.Groups modules into “Modules” (domain cores) and “Platform” sections.
- score: 2
component ModuleOverridesSection
- file: src/platform/provisioning/components/ModuleOverridesSection.tsx:42
- kind: component
- core: platform
- spec: (none)
- summary: Collapsible module/settings override controls. Self-contained: holds the workingselection state and reports the diff-from-template payload upward via .
- score: 2
component ModulePermissionGroup
- file: src/platform/permissions/components/ModulePermissionGroup.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for module permission group.
- score: 1
component ModulePermissionsPage
- file: src/platform/permissions/pages/ModulePermissionsPage.tsx:99
- kind: component
- core: platform
- spec: (none)
- summary: Utility for module permissions page.
- score: 1
component ModulePresetsManager
- file: src/platform/settings/components/ModulePresetsManager.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for module presets manager.
- score: 1
component ModuleSettingsCard
- file: src/platform/settings/components/ModuleSettingsCard.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: Utility for module settings card.
- score: 1
component ModuleSwitcher
- file: src/platform/navigation/components/ModuleSwitcher.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Renders a module switcher dropdown that shows the current module (and sub-module when applicable) and lets the user navigate between modules and sibling sub-modules.Displays the current module icon and name in the trigger; when the app is on a sub-module route it shows a sub-module indicator and a quick-switch list of sibling sub-modules. The menu groups available modules into “Modules” (domain) and “Platform” sections and highlights the active selection.
- params:
- props — This component does not accept any props; it reads navigation and module access from hooks.
- example: | ModuleSwitcher /Accessibility:- The dropdown trigger is a focusable button and the dropdown content is keyboard navigable via the underlying DropdownMenu components.- Visual active and focus styles are provided; ensure color contrast remains sufficient for the applied design tokens.
- score: 4
component ModuleWizardRenderer
- file: src/platform/wizards/components/ModuleWizardRenderer.tsx:73
- kind: component
- core: platform
- spec: (none)
- summary: Utility for module wizard renderer.
- score: 1
component MultiPageFormRenderer
- file: src/platform/forms/MultiPageFormRenderer.tsx:38
- kind: component
- core: platform
- spec: (none)
- summary: Utility for multi page form renderer.
- score: 1
component MyTasksPage
- file: src/platform/tasks/pages/MyTasksPage.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Utility for my tasks page.
- score: 1
component NavGroup
- file: src/platform/navigation/primitives/NavGroup.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Canonical collapsible nav group: an optional overview link plus a list ofNavRow items, with controlled/uncontrolled open state, show-moretruncation, and keyboard support. Used across the sidebar surfaces.
- score: 2
component NavGroupSection
- file: src/platform/navigation/components/NavGroupSection.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Renders a section header divider in the sidebar navigation.Used to visually group related nav groups.
- score: 2
component NavigationProvider
- file: src/platform/navigation/NavigationProvider.tsx:14
- kind: component
- core: platform
- spec: (none)
- summary: Provides navigation context to the entire app.Combines navigation state management with route-based module detection.
- score: 2
component NavItem
- file: src/platform/navigation/components/shared/NavItem.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for nav item.
- score: 1
component NavModeProvider
- file: src/platform/navigation/NavModeContext.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Provider for sidebar open/collapsed state.
- score: 2
component NavRow
- file: src/platform/navigation/primitives/NavRow.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Canonical desktop nav-item row. The single source of truth for nav rowgeometry, focus ring, touch target, active state, and badge. This is thecanonical row primitive and applies the unified active state via; other sidebar surfaces are migrated to it in later phases.
- score: 2
component NavSkeleton
- file: src/platform/navigation/components/NavSkeleton.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for nav skeleton.
- score: 1
component NavTelemetryPage
- file: src/platform/navigation/telemetry/NavTelemetryPage.tsx:267
- kind: component
- core: platform
- spec: (none)
- summary: NavTelemetryPage — org-admin entry point for navigation analytics.Wrapped in ; non-admins seethe standard access-denied screen.
- score: 2
component NestedCellRenderer
- file: src/platform/table-v2/components/NestedCellRenderer.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Renders nested cell values: arrays as badges, objects as key-value lists.
- score: 5
component NewProvisioningRequestDialog
- file: src/platform/provisioning/components/NewProvisioningRequestDialog.tsx:52
- kind: component
- core: platform
- spec: (none)
- summary: Utility for new provisioning request dialog.
- score: 1
component NodePalette
- file: src/platform/workflow/components/NodePalette.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Collapsible sidebar with draggable node types for the diagram builder.
- score: 2
component NoOrganizationState
- file: src/platform/dashboard/components/NoOrganizationState.tsx:15
- kind: component
- core: platform
- spec: (none)
- summary: Renders a prompt to select or create an organization when none is active.
- score: 2
component NotesStep
- file: src/platform/telephony/components/quick-disposition-steps/NotesStep.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Optional notes step with snippet chips for common phrases.Clicking a chip appends text to the textarea.
- score: 2
component NotificationCenter
- file: src/platform/notifications/NotificationCenter.tsx:166
- kind: component
- core: platform
- spec: (none)
- summary: Utility for notification center.
- score: 1
component NotificationFilters
- file: src/platform/notifications/components/NotificationFilters.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for notification filters.
- score: 1
component NotificationGroupItem
- file: src/platform/notifications/components/NotificationGroup.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for notification group item.
- score: 1
component NotificationItem
- file: src/platform/notifications/NotificationItem.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for notification item.
- score: 1
component NotificationItemSwipeable
- file: src/platform/notifications/components/NotificationItemSwipeable.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Renders a wrapped with mobile swipe actions:left → toggle read/unread, right → delete.
- score: 2
component NotificationPreferencesPage
- file: src/platform/notifications/NotificationPreferencesPage.tsx:114
- kind: component
- core: platform
- spec: (none)
- summary: Utility for notification preferences page.
- score: 1
component NotificationsPage
- file: src/platform/notifications/NotificationsPage.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for notifications page.
- score: 1
component NotificationTestPage
- file: src/platform/notifications/NotificationTestPage.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for notification test page.
- score: 1
component NumberField
- file: src/platform/forms/components/fields/NumberField.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for number field.
- score: 1
component OAuthConnectButton
- file: src/platform/integrations/components/OAuthConnectButton.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for oauth connect button.
- score: 1
component OAuthProviderList
- file: src/platform/integrations/components/OAuthProviderList.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Utility for oauth provider list.
- score: 1
component OAuthStatusBadge
- file: src/platform/integrations/components/OAuthStatusBadge.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for oauth status badge.
- score: 1
component ObjectCard
- file: src/platform/data-manager/components/ObjectCard.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for object card.
- score: 1
component ObjectDetailPage
- file: src/platform/data-manager/pages/ObjectDetailPage.tsx:58
- kind: component
- core: platform
- spec: (none)
- summary: Utility for object detail page.
- score: 1
component ObjectPermissionMatrix
- file: src/platform/data-manager/components/ObjectPermissionMatrix.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Renders a permissions matrix table that displays role labels, CRUD checkboxes, and a site-scope selector for each role.The component expects rows to be pre-ordered by the parent; it does not perform internal sorting. System roles (determined by or ) are marked with a “System” badge and all controls for those rows are disabled.
- params:
- props — Component props - permissions: Array of permission rows to render; each row must include role, roleLabel, isSystemRole (optional), boolean flags (, , , ) and . - onPermissionChange: Callback invoked when a permission field or site scope changes. Called with where is one of . - disabled: When , disables all interactive controls in the matrix (default: ).Accessibility considerations:- Controls are standard form elements (Checkbox, Select) and rely on their underlying accessible implementations.- System roles are indicated with a visual badge and have their inputs disabled to prevent interaction.
- returns: A table-like JSX element showing roles, CRUD permission checkboxes, and a site-scope dropdown for each provided permission row.
- example: | ObjectPermissionMatrix permissions=[ role: ‘editor’, roleLabel: ‘Editor’, can_view: true, can_create: false, can_edit: true, can_delete: false, site_scope: ‘assigned’ ] onPermissionChange=(role, field, value) = handleChange(role, field, value)/
- score: 4
component ObjectPermissionsTab
- file: src/platform/data-manager/components/ObjectPermissionsTab.tsx:87
- kind: component
- core: platform
- spec: (none)
- summary: Renders the Object Permissions tab allowing administrators to view, edit, reset, and save object- and field-level permissions for a given object.Displays an object-level permission matrix and a field-level permissions section populated from dynamic role and field data; exposes controls to reset unsaved edits or persist changes.
- params:
- props — Component props - objectApiName: The API name of the object whose permissions are being managed (used for loading and saving permission records). - objectDisplayName: Human-readable object name used in UI text and descriptions.
- example: | ObjectPermissionsTab objectApiName=“invoice” objectDisplayName=“Invoice”/Accessibility considerations:- Interactive controls provided by the permission matrix and field section should be reachable via keyboard and announce their state to assistive technologies.- Ensure any custom cell controls used inside the matrix or field list include appropriate ARIA labels and focus outlines.
- score: 4
component ObjectsTable
- file: src/platform/data-manager/components/ObjectsTable.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Utility for objects table.
- score: 1
component OccupancyRateWidget
- file: src/platform/dashboard/widgets/OccupancyRateWidget.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Utility for occupancy rate widget.
- score: 1
component OnboardingStepContent
- file: src/platform/import/components/OnboardingStepContent.tsx:38
- kind: component
- core: platform
- spec: (none)
- summary: Self-contained import flow for a single onboarding step.
- score: 2
component OnboardingVocabularyStep
- file: src/platform/import/components/OnboardingVocabularyStep.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Renders the “Review Vocabularies” onboarding step.Read-only — links out to the full picklist settings page for editing.
- score: 2
component OnboardingWizardPage
- file: src/platform/import/pages/OnboardingWizardPage.tsx:70
- kind: component
- core: platform
- spec: (none)
- summary: Onboarding wizard page with timeline layout and session persistence.
- score: 2
component OnlineStatusBadge
- file: src/platform/messaging/components/OnlineStatusBadge.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Utility for online status badge.
- score: 1
component OOOBadge
- file: src/platform/integrations/components/OOOBadge.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for ooobadge.
- score: 1
component OperatorSelect
- file: src/platform/conditional-logic/components/builder/OperatorSelect.tsx:47
- kind: component
- core: platform
- spec: (none)
- summary: Utility for operator select.
- score: 1
component OrganizationBrandingSettings
- file: src/platform/organizations/components/OrganizationBrandingSettings.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for organization branding settings.
- score: 1
component OrganizationProvider
- file: src/platform/organizations/OrganizationContext.tsx:109
- kind: component
- core: platform
- spec: (none)
- summary: Utility for organization provider.
- score: 1
component OrganizationSelector
- file: src/platform/wizards/components/marketplace/OrganizationSelector.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for organization selector.
- score: 1
component OrganizationSettings
- file: src/platform/organizations/OrganizationSettings.tsx:50
- kind: component
- core: platform
- spec: (none)
- summary: Utility for organization settings.
- score: 1
component OrganizationSetupWizardPage
- file: src/platform/setup/components/OrganizationSetupWizardPage.tsx:1050
- kind: component
- core: platform
- spec: (none)
- summary: Utility for organization setup wizard page.
- score: 1
component OrganizationSignatureEditor
- file: src/platform/email-signatures/components/OrganizationSignatureEditor.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Full editor for the organization’s default email signature.
- score: 2
component OrganizationSignatureSettingsPage
- file: src/platform/email-signatures/pages/OrganizationSignatureSettingsPage.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Admin settings page for managing the organization’s default email signature.
- score: 2
component OrgDashboardDefaultsDialog
- file: src/platform/dashboard/components/OrgDashboardDefaultsDialog.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Org admin dialog for default dashboard widgets and quick action visibility (JSON on ).
- score: 2
component OrgProfileSeeder
- file: src/platform/knowledge/components/OrgProfileSeeder.tsx:61
- kind: component
- core: platform
- spec: (none)
- summary: Guided org_profile authoring surface (import-or-author → edit → publish).Renders the current published org_profile narrative (if any) plus a two-branch authoringflow. The import branch opens and seeds a draft linked by; the author branch starts from blank (or ). Eitherway the admin edits the title/summary/content, then publishes — at which point theserver-side supersede trigger archives the prior published profile and PF-60 embeds thenew one. The category is fixed; no category picker is shown.
- params:
- props —
- score: 2
component OrgSiteSwitcher
- file: src/platform/organizations/OrgSiteSwitcher.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for org site switcher.
- score: 1
component OrgSlugProvider
- file: src/platform/organizations/hooks/OrgSlugProvider.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Provider that wraps children inside OrgSlugRoute to enable org-aware links.
- score: 2
component OrgSlugRoute
- file: src/platform/organizations/routing/OrgSlugRoute.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for org slug route.
- score: 1
component OrgSwitcherContent
- file: src/platform/navigation/components/SidebarOrgSwitcher.tsx:128
- kind: component
- core: platform
- spec: (none)
- summary: Utility for org switcher content.
- score: 1
component OutboundWebhookCard
- file: src/platform/integrations/components/OutboundWebhookCard.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for outbound webhook card.
- score: 1
component OutboundWebhookForm
- file: src/platform/integrations/components/OutboundWebhookForm.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for outbound webhook form.
- score: 1
component OutboundWebhookList
- file: src/platform/integrations/components/OutboundWebhookList.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for outbound webhook list.
- score: 1
component OverrideEditor
- file: src/platform/jurisdiction/components/OverrideEditor.tsx:123
- kind: component
- core: platform
- spec: (none)
- summary: Rule pack override editor with tabs (desktop) and accordion (mobile).
- score: 2
component OverrideEditorSkeleton
- file: src/platform/jurisdiction/components/OverrideEditor.tsx:235
- kind: component
- core: platform
- spec: (none)
- summary: Skeleton loading state for the override editor (3 rows per section).
- score: 2
component PageAccessDenied
- file: src/platform/forms/components/PageAccessDenied.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Displays a user-friendly message when access to a form page is denied.
- score: 2
component PageNavigationControls
- file: src/platform/forms/components/PageNavigationControls.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for page navigation controls.
- score: 1
component PageSelector
- file: src/platform/forms/components/PageSelector.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for page selector.
- score: 1
component ParticipantsPane
- file: src/platform/cowork/components/ParticipantsPane.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: ParticipantsPane — right column of the Cowork workspace showing who ispresent, which agents are participating, and (for manage holders) controlsto add or remove agent participants.
- score: 2
component PasskeyManagementSection
- file: src/platform/auth/passkey/PasskeyManagementSection.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Settings card for managing passwordless sign-in passkeys.
- score: 2
component PasskeySignInButton
- file: src/platform/auth/passkey/PasskeySignInButton.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Passwordless passkey sign-in trigger.
- score: 2
component PasswordStrengthIndicator
- file: src/platform/auth/components/PasswordStrengthIndicator.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Visual password strength indicator with requirement checklist.
- score: 2
component PdfPreviewPanel
- file: src/platform/templates/components/PdfPreviewPanel.tsx:161
- kind: component
- core: platform
- spec: (none)
- summary: Renders a preview of a document with letterhead styling.
- score: 2
component PDFViewer
- file: src/platform/documents/viewers/PDFViewer.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: PDF Viewer component using react-pdf.This component is lazy-loaded to reduce initial bundle size.The react-pdf library (~1.6MB) only loads when viewing PDFs.
- score: 2
component PeakUsageCard
- file: src/platform/health/components/PeakUsageCard.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for peak usage card.
- score: 1
component PendingActionsWidget
- file: src/platform/dashboard/widgets/PendingActionsWidget.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Render the Pending Actions dashboard widget using the unified inbox countsso totals always match the inbox page.
- score: 2
component PendingActivationPage
- file: src/platform/auth/PendingActivationPage.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Full-page view for users awaiting admin activation approval.
- score: 2
component PendingApprovalsCard
- file: src/platform/documents/components/PendingApprovalsCard.tsx:15
- kind: component
- core: platform
- spec: (none)
- summary: Utility for pending approvals card.
- score: 1
component PendingApprovalsPage
- file: src/platform/documents/pages/PendingApprovalsPage.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for pending approvals page.
- score: 1
component PendingSubmissionsWidget
- file: src/platform/dashboard/widgets/PendingSubmissionsWidget.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for pending submissions widget.
- score: 1
component PeopleDirectoryDialog
- file: src/platform/messaging/components/PeopleDirectoryDialog.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Searchable directory showing all org members with online status and DM action.
- score: 2
component PeoplePicker
- file: src/platform/messaging/components/PeoplePicker.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Search-as-you-type people picker with avatar, status, and chip display.
- score: 2
component PerformanceReportCard
- file: src/platform/health/components/PerformanceReportCard.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Utility for performance report card.
- score: 1
component PeriodComparisonSelector
- file: src/platform/health/components/PeriodComparisonSelector.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for period comparison selector.
- score: 1
component PermanentDeleteDialog
- file: src/platform/admin/components/PermanentDeleteDialog.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for permanent delete dialog.
- score: 1
component PermissionAssignmentMatrix
- file: src/platform/permissions/components/PermissionAssignmentMatrix.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for permission assignment matrix.
- score: 1
component PermissionGate
- file: src/platform/permissions/components/PermissionGate.tsx:66
- kind: component
- core: platform
- spec: (none)
- summary: Gate component for conditionally rendering UI based on permissions
- example: | // Single permissionPermissionGate permission=“hr.employees.view” EmployeeList //PermissionGate // Multiple permissions (any)PermissionGate permission=[“hr.employees.view”, “hr.employees.manage”] EmployeeActions //PermissionGate // Multiple permissions (all required)PermissionGate permission=[“hr.employees.view”, “hr.employees.edit”] requireAll fallback=DisabledButtonNo Access/DisabledButton EditButton //PermissionGate
- score: 5
component PermissionGateSkeleton
- file: src/platform/permissions/components/PermissionGate.tsx:102
- kind: component
- core: platform
- spec: (none)
- summary: Skeleton loading state for permission-gated content
- score: 2
component PermissionMatrix
- file: src/platform/users/PermissionMatrix.tsx:122
- kind: component
- core: platform
- spec: (none)
- summary: Utility for permission matrix.
- score: 1
component PermissionRow
- file: src/platform/permissions/components/PermissionRow.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for permission row.
- score: 1
component PermissionSearch
- file: src/platform/permissions/components/PermissionSearch.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for permission search.
- score: 1
component PermissionsManager
- file: src/platform/documents/PermissionsManager.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Utility for permissions manager.
- score: 1
component PermissionsOverviewPage
- file: src/platform/permissions/pages/PermissionsOverviewPage.tsx:195
- kind: component
- core: platform
- spec: (none)
- summary: Utility for permissions overview page.
- score: 1
component PermissionsV2Toggle
- file: src/platform/organizations/components/PermissionsV2Toggle.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for permissions v2 toggle.
- score: 1
component PhoneField
- file: src/platform/forms/components/fields/PhoneField.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for phone field.
- score: 1
component PhoneVerification
- file: src/platform/auth/components/PhoneVerification.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for phone verification.
- score: 1
component PicklistBadge
- file: src/platform/picklists/components/PicklistBadge.tsx:74
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklist badge.
- score: 1
component PicklistColorPicker
- file: src/platform/picklists/components/PicklistColorPicker.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklist color picker.
- score: 1
component PicklistDetailPage
- file: src/platform/picklists/pages/PicklistDetailPage.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklist detail page.
- score: 1
component PicklistExportDialog
- file: src/platform/picklists/components/PicklistExportDialog.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklist export dialog.
- score: 1
component PicklistForm
- file: src/platform/picklists/components/PicklistForm.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklist form.
- score: 1
component PicklistImportDialog
- file: src/platform/picklists/components/PicklistImportDialog.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklist import dialog.
- score: 1
component PicklistItemForm
- file: src/platform/picklists/components/PicklistItemForm.tsx:78
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklist item form.
- score: 1
component PicklistItemsEditor
- file: src/platform/picklists/components/PicklistItemsEditor.tsx:108
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklist items editor.
- score: 1
component PicklistMultiselectField
- file: src/platform/forms/components/fields/PicklistMultiselectField.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Picklist-backed multi-select field for form rendering.
- score: 2
component PicklistRadioField
- file: src/platform/forms/components/fields/PicklistRadioField.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Picklist-backed radio field for form rendering.
- score: 2
component PicklistSelector
- file: src/platform/picklists/components/PicklistSelector.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklist selector.
- score: 1
component PicklistSelectRenderer
- file: src/platform/field-config/components/PicklistSelectRenderer.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklist select renderer.
- score: 1
component PicklistsGroupedTable
- file: src/platform/picklists/components/PicklistsGroupedTable.tsx:36
- kind: component
- core: platform
- spec: (none)
- summary: Renders picklists grouped by category with collapsible sections. Fetches the org’s picklists via the shared hook(optionally narrowed by a client-side search box), groups them by in order, and renders each non-empty group as acollapsible section. Each picklist row links to its detail page.
- score: 2
component PicklistsPage
- file: src/platform/picklists/pages/PicklistsPage.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklists page.
- score: 1
component PicklistsTable
- file: src/platform/picklists/components/PicklistsTable.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklists table.
- score: 1
component PicklistTemplateLibrary
- file: src/platform/picklists/components/PicklistTemplateLibrary.tsx:97
- kind: component
- core: platform
- spec: (none)
- summary: Picklist template library with DB-driven platform defaults and static starter examples.
- score: 2
component PicklistTemplatePreviewDialog
- file: src/platform/picklists/components/PicklistTemplatePreviewDialog.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for picklist template preview dialog.
- score: 1
component PieChartView
- file: src/platform/reports/components/charts/PieChartView.tsx:59
- kind: component
- core: platform
- spec: (none)
- summary: Utility for pie chart view.
- score: 1
component PinnedSection
- file: src/platform/navigation/components/PinnedSection.tsx:105
- kind: component
- core: platform
- spec: (none)
- summary: Utility for pinned section.
- score: 1
component PinSetupDialog
- file: src/platform/auth/app-lock/PinSetupDialog.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for setting or changing the app lock PIN.
- score: 2
component PlatformHomePanel
- file: src/platform/navigation/components/PlatformHomePanel.tsx:61
- kind: component
- core: platform
- spec: (none)
- summary: Platform-home panel: shown in ContextualPanel when the user is NOT inside acore module. Renders the top-level platform routes (Dashboard, Inbox, Reports,Documents) plus the Settings section with admin-gated groups.Data is ported faithfully from the useMemo in AppSidebar(lines ~177–339). Task 5 will delete that copy once ContextualPanel is wiredinto AppSidebar.
- score: 2
component PlatformModulesPage
- file: src/platform/settings/pages/PlatformModulesPage.tsx:16
- kind: component
- core: platform
- spec: (none)
- summary: Utility for platform modules page.
- score: 1
component PreferencesForm
- file: src/platform/users/PreferencesForm.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for preferences form.
- score: 1
component PrefillSummary
- file: src/platform/forms/components/prefill/PrefillSummary.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Collapsible summary panel showing all prefilled fields and their sources.
- score: 2
component PresenceAvatars
- file: src/platform/realtime/components/PresenceAvatars.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Utility for presence avatars.
- score: 1
component PresenceBadge
- file: src/platform/integrations/components/PresenceBadge.tsx:71
- kind: component
- core: platform
- spec: (none)
- summary: Renders a Teams presence indicator dot, with optional tooltip details.
- score: 2
component PresetCard
- file: src/platform/settings/components/PresetCard.tsx:42
- kind: component
- core: platform
- spec: (none)
- summary: Utility for preset card.
- score: 1
component PresetEditorDialog
- file: src/platform/settings/components/PresetEditorDialog.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Utility for preset editor dialog.
- score: 1
component PrioritySummaryCard
- file: src/platform/dashboard/components/PrioritySummaryCard.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for priority summary card.
- score: 1
component ProcessCard
- file: src/platform/automation/components/ProcessCard.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Renders a card for a business process with health gauge and metadata.
- score: 2
component ProcessHealthBreakdown
- file: src/platform/automation/components/ProcessHealthBreakdown.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Renders a breakdown of the 4 health score components.
- score: 2
component ProcessHealthGauge
- file: src/platform/automation/components/ProcessHealthGauge.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Renders a circular health score gauge with semantic color coding.
- score: 2
component ProcessHealthTrendChart
- file: src/platform/automation/components/ProcessHealthTrendChart.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Displays a line chart of health scores over the past 30 days.
- score: 2
component ProcessImpactGraph
- file: src/platform/automation/components/ProcessImpactGraph.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: Visual impact graph for a business process.Shows the process as a central node connected to linked rules and workflows.
- score: 2
component ProcessLinkedRules
- file: src/platform/automation/components/ProcessLinkedRules.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Displays linked automation rules count and metadata.
- score: 2
component ProcessLinkedWorkflows
- file: src/platform/automation/components/ProcessLinkedWorkflows.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Displays linked workflow definitions count and metadata.
- score: 2
component ProcessTableView
- file: src/platform/automation/components/ProcessTableView.tsx:38
- kind: component
- core: platform
- spec: (none)
- summary: Renders business processes as a sortable data table with health, execution, and core columns.
- score: 2
component ProfileComparison
- file: src/platform/jurisdiction/components/ProfileComparison.tsx:119
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for comparing two jurisdiction profiles side-by-side.
- score: 2
component ProfileForm
- file: src/platform/users/ProfileForm.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for profile form.
- score: 1
component ProfilePage
- file: src/platform/users/ProfilePage.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Renders the user profile settings page and redirects to the authentication route when no user is present.Displays a loading skeleton while user or profile data is loading, shows avatar upload, profile edit, and preferences sections when data is available, and exposes created/updated timestamps.
- returns: The profile settings UI as a JSX element
- score: 2
component ProfileSelector
- file: src/platform/jurisdiction/components/ProfileSelector.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Profile selector dropdown grouped by state.
- score: 2
component ProgressChecklist
- file: src/platform/help/ProgressChecklist.tsx:52
- kind: component
- core: platform
- spec: (none)
- summary: Progress Checklist for tracking completion of setup/onboarding tasks
- score: 2
component ProgressGauge
- file: src/platform/reports/components/charts/RadialBarChartView.tsx:101
- kind: component
- core: platform
- spec: (none)
- summary: Utility for progress gauge.
- score: 1
component PromptTemplateStep
- file: src/platform/ai/wizards/ai-skill-creation/steps/PromptTemplateStep.tsx:51
- kind: component
- core: platform
- spec: (none)
- summary: Renders Step 2 (Prompt Template) with the wired author-time safety harness.
- params:
- props — The shared form instance + analytics callbacks.
- score: 2
component PropagationStatus
- file: src/platform/org-data-sync/components/PropagationStatus.tsx:54
- kind: component
- core: platform
- spec: (none)
- summary: Utility for propagation status.
- score: 1
component ProviderSelectionDialog
- file: src/platform/banking/components/ProviderSelectionDialog.tsx:101
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for connecting a bank account via Plaid.
- score: 2
component ProvisioningDashboardPage
- file: src/platform/provisioning/pages/ProvisioningDashboardPage.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Utility for provisioning dashboard page.
- score: 1
component ProvisioningRequestDetailSheet
- file: src/platform/provisioning/components/ProvisioningRequestDetailSheet.tsx:51
- kind: component
- core: platform
- spec: (none)
- summary: Utility for provisioning request detail sheet.
- score: 1
component ProvisioningTemplatesPage
- file: src/platform/provisioning/pages/ProvisioningTemplatesPage.tsx:48
- kind: component
- core: platform
- spec: (none)
- summary: Utility for provisioning templates page.
- score: 1
component PublishToMarketplaceDialog
- file: src/platform/wizards/components/marketplace/PublishToMarketplaceDialog.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Utility for publish to marketplace dialog.
- score: 1
component PublishVersionDialog
- file: src/platform/wizards/components/PublishVersionDialog.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for publish version dialog.
- score: 1
component PullToRefresh
- file: src/platform/gestures/components/PullToRefresh.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: PullToRefresh wraps scrollable content with pull-down refresh
- score: 5
component PushNotificationSettings
- file: src/platform/notifications/components/PushNotificationSettings.tsx:52
- kind: component
- core: platform
- spec: (none)
- summary: Utility for push notification settings.
- score: 1
component PushTestCard
- file: src/platform/notifications/components/testing/ChannelTestCards.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Renders the push test card interface.
- score: 2
component PwaUpdateBanner
- file: src/platform/pwa/components/PwaUpdateBanner.tsx:14
- kind: component
- core: platform
- spec: (none)
- summary: Utility for pwa update banner.
- score: 1
component PwaUpdatePrompt
- file: src/platform/pwa/PwaUpdatePrompt.tsx:13
- kind: component
- core: platform
- spec: (none)
- summary: Utility for pwa update prompt.
- score: 1
component QueryPatternsList
- file: src/platform/query-performance/components/QueryPatternsList.tsx:108
- kind: component
- core: platform
- spec: (none)
- summary: Renders the query patterns table with drill-down to Slow Queries.
- score: 2
component QueryPerformanceSettingsForm
- file: src/platform/query-performance/components/QueryPerformanceSettingsForm.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for query performance settings form.
- score: 1
component QuickActionButton
- file: src/platform/dashboard/components/QuickActionButton.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Shared quick-action control for dashboard section, cards, and similar surfaces.
- score: 2
component QuickActionGrid
- file: src/platform/navigation/components/QuickActionGrid.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for quick action grid.
- score: 1
component QuickActionsCard
- file: src/platform/dashboard/components/QuickActionsCard.tsx:58
- kind: component
- core: platform
- spec: (none)
- summary: Renders a card of quick navigation/action buttons with optional badges.
- score: 2
component QuickActionsEditDialog
- file: src/platform/dashboard/components/QuickActionsEditDialog.tsx:182
- kind: component
- core: platform
- spec: (none)
- summary: Utility for quick actions edit dialog.
- score: 1
component QuickActionsSection
- file: src/platform/dashboard/components/QuickActionsSection.tsx:67
- kind: component
- core: platform
- spec: (none)
- summary: Utility for quick actions section.
- score: 1
component QuickDialDialog
- file: src/platform/telephony/components/QuickDialDialog.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Quick Dial dialog for initiating click-to-call from any screen.Uses RingCentral RingOut to ring user’s phone first, then connect.Validates that the current user has an extension mapping beforeallowing call initiation.
- score: 2
component QuickTip
- file: src/platform/help/QuickTip.tsx:69
- kind: component
- core: platform
- spec: (none)
- summary: Utility for quick tip.
- score: 1
component QuotaConfigTab
- file: src/platform/quota/components/QuotaConfigTab.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Configuration tab displaying quota rules with create/edit capabilities.
- score: 2
component QuotaFormDialog
- file: src/platform/quota/components/QuotaFormDialog.tsx:58
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for creating or editing a resource quota rule.
- score: 2
component QuotaManagementPage
- file: src/platform/quota/pages/QuotaManagementPage.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Quota management page with tabbed interface for configuration, usage monitoring, and violation tracking.
- score: 2
component RadialBarChartView
- file: src/platform/reports/components/charts/RadialBarChartView.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for radial bar chart view.
- score: 1
component RawDataExportButton
- file: src/platform/data-manager/components/RawDataExportButton.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for raw data export button.
- score: 1
component RawDataImportWizard
- file: src/platform/data-manager/components/RawDataImportWizard.tsx:63
- kind: component
- core: platform
- spec: (none)
- summary: Utility for raw data import wizard.
- score: 1
component RawDataPartialFailureSheet
- file: src/platform/data-manager/components/RawDataPartialFailureSheet.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Displays partial failure details from a batch save operation.
- score: 2
component RawDataRevertSheet
- file: src/platform/data-manager/components/RawDataRevertSheet.tsx:42
- kind: component
- core: platform
- spec: (none)
- summary: Sheet displaying recent batch saves with revert capability.
- score: 2
component RawDataTab
- file: src/platform/data-manager/components/RawDataTab.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Main container for the Raw Data tab with inline editing, undo/redo, and revert.
- score: 2
component RawDataTable
- file: src/platform/data-manager/components/RawDataTable.tsx:90
- kind: component
- core: platform
- spec: (none)
- summary: Renders editable raw data records with custom-field edit highlighting.
- score: 2
component RawDataToolbar
- file: src/platform/data-manager/components/RawDataToolbar.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Toolbar with search, record count, export/import, undo/redo, and recent saves.
- score: 2
component RealtimeConnectionBadge
- file: src/platform/realtime/components/RealtimeConnectionBadge.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for realtime connection badge.
- score: 1
component RealtimeProvider
- file: src/platform/realtime/RealtimeProvider.tsx:82
- kind: component
- core: platform
- spec: (none)
- summary: Utility for realtime provider.
- score: 1
component RecentCallsList
- file: src/platform/telephony/components/RecentCallsList.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Utility for recent calls list.
- score: 1
component RecentlyVisitedSection
- file: src/platform/dashboard/components/RecentlyVisitedSection.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for recently visited section.
- score: 1
component RecipientManager
- file: src/platform/reports/components/RecipientManager.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for recipient manager.
- score: 1
component RecordMetricValueDialog
- file: src/platform/health/components/RecordMetricValueDialog.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for record metric value dialog.
- score: 1
component RegenerateFromProcedureDialog
- file: src/platform/workflow/components/RegenerateFromProcedureDialog.tsx:38
- kind: component
- core: platform
- spec: (none)
- summary: Utility for regenerate from procedure dialog.
- score: 1
component RemoveLegalHoldDialog
- file: src/platform/data-retention/components/RemoveLegalHoldDialog.tsx:15
- kind: component
- core: platform
- spec: (none)
- summary: Utility for remove legal hold dialog.
- score: 1
component ReplyPreview
- file: src/platform/messaging/components/ReplyPreview.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for reply preview.
- score: 1
component ReportBuilder
- file: src/platform/reports/ReportBuilder.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for report builder.
- score: 1
component ReportHistory
- file: src/platform/reports/ReportHistory.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Utility for report history.
- score: 1
component ReportLibrary
- file: src/platform/reports/ReportLibrary.tsx:68
- kind: component
- core: platform
- spec: (none)
- summary: Utility for report library.
- score: 1
component ReportParameters
- file: src/platform/reports/ReportParameters.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Utility for report parameters.
- score: 1
component ReportPermissionsForm
- file: src/platform/reports/components/ReportPermissionsForm.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Form for managing report permissions (add/update/remove grants).
- score: 2
component ReportResultTable
- file: src/platform/reports/components/ReportResultTable.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Report result table using the platform DataTable (TanStack Table v8).Derives column definitions from column keys and enables sorting + filtering.
- score: 2
component ReportRunHistory
- file: src/platform/reports/components/ReportRunHistory.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Utility for report run history.
- score: 1
component ReportScheduleDialog
- file: src/platform/reports/components/ReportScheduleDialog.tsx:79
- kind: component
- core: platform
- spec: (none)
- summary: Utility for report schedule dialog.
- score: 1
component ReportScheduleList
- file: src/platform/reports/components/ReportScheduleList.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Utility for report schedule list.
- score: 1
component ReportsPage
- file: src/platform/reports/ReportsPage.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Utility for reports page.
- score: 1
component ReportViewer
- file: src/platform/reports/ReportViewer.tsx:82
- kind: component
- core: platform
- spec: (none)
- summary: Utility for report viewer.
- score: 1
component RequirePermission
- file: src/platform/permissions/components/RequirePermission.tsx:164
- kind: component
- core: platform
- spec: (none)
- summary: Guard component for protecting entire pages or sections
- example: | // Redirect on deniedRequirePermission permission=“fa.bills.approve” redirectTo=“/fa/bills” BillApprovalPage //RequirePermission // Show access deniedRequirePermission permission=“system.admin.manage” AdminPanel //RequirePermission // Custom fallbackRequirePermission permission=“hr.payroll.view” fallback=UpgradePrompt feature=“Payroll” / PayrollDashboard //RequirePermission
- score: 5
component ResetPasswordDialog
- file: src/platform/users/ResetPasswordDialog.tsx:50
- kind: component
- core: platform
- spec: (none)
- summary: Utility for reset password dialog.
- score: 1
component ResponsiveAppLauncher
- file: src/platform/modules/ResponsiveAppLauncher.tsx:13
- kind: component
- core: platform
- spec: (none)
- summary: Utility for responsive app launcher.
- score: 1
component ResponsiveNav
- file: src/platform/navigation/ResponsiveNav.tsx:61
- kind: component
- core: platform
- spec: (none)
- summary: Utility for responsive nav.
- score: 1
component ResponsiveSizeSelector
- file: src/platform/dashboard/components/ResponsiveSizeSelector.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for responsive size selector.
- score: 1
component RestoreRecordDialog
- file: src/platform/admin/components/RestoreRecordDialog.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for restore record dialog.
- score: 1
component RetentionPolicyDialog
- file: src/platform/data-retention/components/RetentionPolicyDialog.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for retention policy dialog.
- score: 1
component ReviewActivateStep
- file: src/platform/ai/components/onboarding/ReviewActivateStep.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Renders the Review & Activate summary.
- params:
- props — .
- score: 2
component ReviewField
- file: src/platform/wizards/components/review/ReviewField.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: ReviewFieldStandard label/value row for use inside . Handlesempty values consistently (em-dash fallback) and supports both inline andstacked layouts.
- score: 5
component ReviewSection
- file: src/platform/wizards/components/steps/ReviewSection.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for review section.
- score: 1
component ReviewStep
- file: src/platform/ai/wizards/ai-skill-creation/steps/ReviewStep.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Renders Step 5 (Review) with the category-driven action summary.
- params:
- props — The shared form instance.
- score: 2
component ReviewStep
- file: src/platform/wizards/components/steps/ReviewStep.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for review step.
- score: 1
component RevokeConfirmDialog
- file: src/platform/signatures/components/RevokeConfirmDialog.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for revoke confirm dialog.
- score: 1
component RevokeKeyDialog
- file: src/platform/api-access/components/RevokeKeyDialog.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Destructive confirmation to revoke an API key.
- score: 2
component RichTextField
- file: src/platform/forms/components/fields/RichTextField.tsx:431
- kind: component
- core: platform
- spec: (none)
- summary: Rich text field component using Tiptap editor
- score: 2
component RichTextSection
- file: src/platform/templates/components/RichTextSection.tsx:200
- kind: component
- core: platform
- spec: (none)
- summary: Rich text section editor with Markdown support. Provides a textarea with formatting toolbar for bold, italic,and lists. Includes live preview toggle to see rendered Markdown.Supports template variable insertion.
- score: 2
component RingCentralExtensionsManager
- file: src/platform/settings/components/RingCentralExtensionsManager.tsx:63
- kind: component
- core: platform
- spec: (none)
- summary: Utility for ring central extensions manager.
- score: 1
component RingCentralQuickSetup
- file: src/platform/settings/components/RingCentralQuickSetup.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for ring central quick setup.
- score: 1
component RingCentralSettingsPage
- file: src/platform/settings/pages/RingCentralSettingsPage.tsx:664
- kind: component
- core: platform
- spec: (none)
- summary: Page that consolidates RingCentral telephony configuration into a tabbed settings UI.Renders a guarded settings container that shows a loading skeleton while configuration loads,then displays connection status, extension mappings, feature toggles, and embeddable widget settingsacross four accessible tabs. Access is gated by the permission.Accessibility notes:- Tabs are keyboard-navigable and provide clear visual focus; ensure assistive labels remain visible.- The page content is permission-protected and will not render to users without the required permission.
- params:
- props — Component props (none).
- example: | RingCentralSettingsPage /
- score: 4
component RoleActionsMenu
- file: src/platform/roles/components/RoleActionsMenu.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for role actions menu.
- score: 1
component RoleAssignmentDialog
- file: src/platform/roles/components/RoleAssignmentDialog.tsx:72
- kind: component
- core: platform
- spec: (none)
- summary: Utility for role assignment dialog.
- score: 1
component RoleAssignmentDialog
- file: src/platform/users/RoleAssignmentDialog.tsx:50
- kind: component
- core: platform
- spec: (none)
- summary: Utility for role assignment dialog.
- score: 1
component RoleForm
- file: src/platform/roles/components/RoleForm.tsx:66
- kind: component
- core: platform
- spec: (none)
- summary: Utility for role form.
- score: 1
component RoleList
- file: src/platform/roles/components/RoleList.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Utility for role list.
- score: 1
component RolePermissionPreview
- file: src/platform/users/RolePermissionPreview.tsx:87
- kind: component
- core: platform
- spec: (none)
- summary: Inline summary of what a role can do, shown beneath the role selector.
- score: 2
component RoleSelector
- file: src/platform/permissions/components/RoleSelector.tsx:169
- kind: component
- core: platform
- spec: (none)
- summary: Unified role selector that displays both system roles and custom roles.Custom roles are fetched from the current organization.
- score: 2
component RolesPage
- file: src/platform/roles/pages/RolesPage.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for roles page.
- score: 1
component RollbackConfirmDialog
- file: src/platform/import/components/RollbackConfirmDialog.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Destructive confirmation dialog for rolling back import batches.
- score: 2
component RouteErrorBoundary
- file: src/platform/navigation/components/RouteErrorBoundary.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Route-level error boundary that wraps route groups.Usage in App.tsx:
- score: 2
component RunDetailPanel
- file: src/platform/settings/pages/data-migration/components/RunDetailPanel.tsx:52
- kind: component
- core: platform
- spec: (none)
- summary: Expandable detail panel for migration run diagnostics.
- score: 2
component RunsTab
- file: src/platform/settings/pages/data-migration/components/RunsTab.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Runs tab with expandable error detail panel.
- score: 2
component RunTimelinePage
- file: src/platform/agents/ui/RunTimelinePage.tsx:129
- kind: component
- core: platform
- spec: (none)
- summary: Read-only Run Timeline page (PF-125 Phase 1).
- score: 2
component SaveAsDocumentDialog
- file: src/platform/workflow/components/SaveAsDocumentDialog.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for save as document dialog.
- score: 1
component ScheduledMessagesPanel
- file: src/platform/messaging/components/ScheduledMessagesPanel.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Side panel showing pending scheduled messages for a conversation.
- score: 2
component ScopeSelector
- file: src/platform/api-access/components/ScopeSelector.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Grouped scope selector with “select all” per module, accordion on mobile.
- score: 2
component ScrollAreaWithShadows
- file: src/platform/navigation/components/ScrollAreaWithShadows.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for scroll area with shadows.
- score: 1
component SearchableCombobox
- file: src/platform/forms/components/SearchableCombobox.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Utility for searchable combobox.
- score: 1
component SectionConfigDialog
- file: src/platform/page-layouts/components/SectionConfigDialog.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Utility for section config dialog.
- score: 1
component SectionEditor
- file: src/platform/page-layouts/components/SectionEditor.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: Utility for section editor.
- score: 1
component SectionEditor
- file: src/platform/templates/components/SectionEditor.tsx:220
- kind: component
- core: platform
- spec: (none)
- summary: Renders an editable, reorderable list of template sections with controls to add, update, remove, and reorder sections.Renders each section as a draggable card with inline name editing, a required toggle, and an expandable area for help text and default content. Provides an input to add a new section by name and a quick-add row for common section names. All mutations are propagated through the callback; when is true the UI disables editing, adding, and reordering.Accessibility considerations:- Drag handle exposes standard DnD keyboard and pointer interactions (keyboard sensor + sortable keyboard coordinates).- Inputs and buttons include visible focusable controls; ensure surrounding page provides context for the editor when used in complex layouts.
- params:
- props — Component props - value: Array of TemplateSection representing the current ordered sections. Each section’s is used as the stable drag id. - onChange: Callback invoked with the new sections array whenever sections are added, removed, updated, or reordered. - disabled: If true, disables all interactive controls (default: false). - className: Optional additional className applied to the root container.
- example: | SectionEditor value=sections onChange=(next) = setSections(next)/
- score: 4
component SectionRenderer
- file: src/platform/page-layouts/components/rendering/SectionRenderer.tsx:48
- kind: component
- core: platform
- spec: (none)
- summary: Utility for section renderer.
- score: 1
component SectionSuggester
- file: src/platform/templates/components/SectionSuggester.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for AI-powered section suggestions. User can select which sections to apply.
- score: 2
component SecurityAlertConfigPage
- file: src/platform/security/pages/SecurityAlertConfigPage.tsx:296
- kind: component
- core: platform
- spec: (none)
- summary: Utility for security alert config page.
- score: 1
component SecurityEventsPage
- file: src/platform/security/pages/SecurityEventsPage.tsx:53
- kind: component
- core: platform
- spec: (none)
- summary: Utility for security events page.
- score: 1
component SecuritySettingsPage
- file: src/platform/settings/SecuritySettingsPage.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Security settings page — consumes shared AppLockContext.
- score: 2
component SeedOrgProfilePage
- file: src/platform/knowledge/pages/SeedOrgProfilePage.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Renders the guided org-knowledge seeding entry as a standalone settings page.On a successful publish the user is returned to the Knowledge Base list so thenewly published article is visible alongside the rest of the catalog.Mounted at (guarded by ).
- score: 2
component SelectAllCheckbox
- file: src/platform/table-v2/features/RowSelection.tsx:72
- kind: component
- core: platform
- spec: (none)
- summary: Checkbox for selecting/deselecting all rows on the current page.
- score: 2
component SelectField
- file: src/platform/forms/components/fields/SelectField.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Utility for select field.
- score: 1
component SelectionActions
- file: src/platform/table-v2/features/RowSelection.tsx:151
- kind: component
- core: platform
- spec: (none)
- summary: Container that only renders children when rows are selected.
- score: 2
component SelectionInfo
- file: src/platform/table-v2/features/RowSelection.tsx:124
- kind: component
- core: platform
- spec: (none)
- summary: Displays information about the current selection.
- score: 2
component SelectRowCheckbox
- file: src/platform/table-v2/features/RowSelection.tsx:99
- kind: component
- core: platform
- spec: (none)
- summary: Checkbox for selecting/deselecting a single row.
- score: 2
component ServiceAccountCard
- file: src/platform/api-access/components/ServiceAccountCard.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Card component for a single service account.
- score: 2
component ServiceAccountCardSkeleton
- file: src/platform/api-access/components/ServiceAccountCard.tsx:100
- kind: component
- core: platform
- spec: (none)
- summary: Skeleton card for loading state (renders 3 per CONTEXT.md).
- score: 2
component ServiceAccountDetailPage
- file: src/platform/api-access/pages/ServiceAccountDetailPage.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Detail view for a service account showing its API keys.
- score: 2
component ServiceLinesStep
- file: src/platform/ai/components/onboarding/ServiceLinesStep.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Renders the Service Lines & Programs step.
- params:
- props — .
- score: 2
component SessionManagementPage
- file: src/platform/sessions/pages/SessionManagementPage.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for session management page.
- score: 1
component SessionRecorderProvider
- file: src/platform/analytics/useSessionRecorder.tsx:139
- kind: component
- core: platform
- spec: (none)
- summary: Session recorder context providerProvides session recording capabilities to child components.Automatically handles consent and privacy controls.
- score: 5
component SetProfilePhotoDialog
- file: src/platform/headshot/components/SetProfilePhotoDialog.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Confirmation dialog for setting a generated headshot as profile photo.
- score: 2
component SettingsAuditLog
- file: src/platform/settings/components/SettingsAuditLog.tsx:36
- kind: component
- core: platform
- spec: (none)
- summary: Utility for settings audit log.
- score: 1
component SettingsErrorState
- file: src/platform/settings/components/SettingsErrorState.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Render an error state card for settings pages with optional retry functionality.Displays a centered card with an alert icon, title, error details, and a retry button.If a custom description is not provided, the error’s message is displayed.
- params:
- error — The error object to display
- onRetry — Optional callback triggered when the retry button is clicked
- title — Optional custom title (defaults to “Failed to load settings”)
- description — Optional custom description (defaults to error.message)
- score: 2
component SettingsHub
- file: src/platform/settings/SettingsHub.tsx:116
- kind: component
- core: platform
- spec: (none)
- summary: Settings hub page that organizes and navigates to account, organization, and configuration settings.Renders a header and a tabbed interface containing responsive grids of settings cards. The “My Account”tab is available to all users; the “Organization”, “Configuration”, and “Module Settings” tabs are shownonly for users with the organization admin permission.
- score: 2
component SettingsLoadingSkeleton
- file: src/platform/settings/components/SettingsLoadingSkeleton.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for settings loading skeleton.
- score: 1
component SettingsOverviewPage
- file: src/platform/settings/pages/SettingsOverviewPage.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for settings overview page.
- score: 1
component SettingsPageHeader
- file: src/platform/settings/components/SettingsPageHeader.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for settings page header.
- score: 1
component SettingsPageLayout
- file: src/platform/settings/components/SettingsPageLayout.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Standard shell for settings pages: container, loading/error gates, unsaved navigation guard.
- score: 2
component SettingsTabs
- file: src/platform/settings/components/SettingsTabs.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Settings tabs with horizontally scrollable triggers (mobile-friendly).
- score: 2
component SetupCompletionDashboard
- file: src/platform/setup/components/SetupCompletionDashboard.tsx:141
- kind: component
- core: platform
- spec: (none)
- summary: Utility for setup completion dashboard.
- score: 1
component SharedDashboardPage
- file: src/platform/dashboard/pages/SharedDashboardPage.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Utility for shared dashboard page.
- score: 1
component SharePointConfigurationCard
- file: src/platform/settings/components/SharePointConfigurationCard.tsx:50
- kind: component
- core: platform
- spec: (none)
- summary: Utility for share point configuration card.
- score: 1
component SharePointDocumentBrowser
- file: src/platform/integrations/components/SharePointDocumentBrowser.tsx:71
- kind: component
- core: platform
- spec: (none)
- summary: Utility for share point document browser.
- score: 1
component SharePointDocumentsPage
- file: src/platform/documents/pages/SharePointDocumentsPage.tsx:116
- kind: component
- core: platform
- spec: (none)
- summary: Utility for share point documents page.
- score: 1
component ShortcutHelpPanel
- file: src/platform/workflow/components/ShortcutHelpPanel.tsx:38
- kind: component
- core: platform
- spec: (none)
- summary: Dialog listing all keyboard shortcuts for the diagram builder.
- score: 2
component SidebarOrgSwitcher
- file: src/platform/navigation/components/SidebarOrgSwitcher.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for sidebar org switcher.
- score: 1
component SidebarSearch
- file: src/platform/navigation/components/SidebarSearch.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Inline search input for filtering sidebar modules.Shows as an icon button when collapsed, expands to full input when not collapsed.
- score: 2
component SidebarSkeleton
- file: src/platform/navigation/components/NavSkeleton.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Sidebar Skeleton for full sidebar loading state
- score: 2
component SignatureBulkActions
- file: src/platform/signatures/components/SignatureBulkActions.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for signature bulk actions.
- score: 1
component SignatureCanvas
- file: src/platform/signatures/SignatureCanvas.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for signature canvas.
- score: 1
component SignatureDashboard
- file: src/platform/signatures/SignatureDashboard.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for signature dashboard.
- score: 1
component SignatureDialog
- file: src/platform/signatures/SignatureDialog.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for signature dialog.
- score: 1
component SignatureField
- file: src/platform/forms/components/fields/SignatureField.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Utility for signature field.
- score: 1
component SignatureFilters
- file: src/platform/signatures/components/SignatureFilters.tsx:52
- kind: component
- core: platform
- spec: (none)
- summary: Utility for signature filters.
- score: 1
component SignaturePreviewDialog
- file: src/platform/email-signatures/components/SignaturePreviewDialog.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Dialog displaying HTML and plain text preview of a rendered signature.
- score: 2
component SignatureRequestDialog
- file: src/platform/signatures/SignatureRequestDialog.tsx:56
- kind: component
- core: platform
- spec: (none)
- summary: Utility for signature request dialog.
- score: 1
component SignatureRequestsTable
- file: src/platform/signatures/components/SignatureRequestsTable.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for signature requests table.
- score: 1
component SignatureStatusBadge
- file: src/platform/signatures/SignatureStatusBadge.tsx:64
- kind: component
- core: platform
- spec: (none)
- summary: Utility for signature status badge.
- score: 1
component SkillApprovalQueuePage
- file: src/platform/ai/pages/SkillApprovalQueuePage.tsx:106
- kind: component
- core: platform
- spec: (none)
- summary: Renders the AI skill approval queue: org-authored skills awaiting review withapprove/reject actions gated on .
- returns: The React element for the approval-queue page.
- score: 2
component SkillConfigurationDialog
- file: src/platform/ai/components/SkillConfigurationDialog.tsx:58
- kind: component
- core: platform
- spec: (none)
- summary: Renders a dialog for viewing and editing an AI skill’s configuration and overrides.The dialog lets an administrator enable/disable the skill, edit organization-levelcustom instructions, choose a model override, adjust temperature, toggle RAG usage,reset overridden values to defaults, and delete non-system (custom) skills.Accessibility:- Dialog, form controls, and action buttons include accessible labels and descriptions.- Ensure keyboard and screen-reader access for modal focus management provided by the Dialog and ConfirmationDialog components.
- params:
- props — Component props - skill: The skill to configure; when the dialog is closed. The component reads current values and override state from this object to initialize form fields. - onOpenChange: Callback invoked when the dialog open state should change (e.g., close the dialog after save/delete). Receives the new open state.
- returns: A JSX element rendering the skill configuration dialog UI.
- example: | SkillConfigurationDialog skill=selectedSkill onOpenChange=(open) = setSelectedSkill(open ? selectedSkill : null)/
- score: 4
component SkillLifecycleBadge
- file: src/platform/ai/components/SkillLifecycleBadge.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Renders the governance lifecycle status of a skill as a semantic badge.
- params:
- status — The skill’s .
- score: 2
component SkillRecommendationStep
- file: src/platform/ai/components/onboarding/SkillRecommendationStep.tsx:42
- kind: component
- core: platform
- spec: (none)
- summary: Renders the Skill Recommendation & Enablement step.
- params:
- props — .
- score: 2
component SkillSelector
- file: src/platform/ai/components/SkillSelector.tsx:91
- kind: component
- core: platform
- spec: (none)
- summary: Renders a categorized dropdown for selecting an AI skill.Displays grouped AI skills fetched for the provided module, shows loading and error states,and renders each skill with its icon, name, optional description, and optional RAG indicator.The component respects and props to adjust interactivity and visual detail.Accessibility: the trigger has an and the Select primitives providekeyboard navigation and proper ARIA semantics for the dropdown and list items.
- params:
- props — Component props - value: Currently selected skill code (string) or empty string for none - onChange: Callback invoked with the chosen when selection changes - module: Optional module filter used when fetching skills - placeholder: Placeholder text shown when no skill is selected (default: “Select AI skill…”) - className: Optional CSS class name applied to top-level elements for styling - disabled: When true, the control is non-interactive (default: false) - compact: When true, renders a condensed view without descriptions or some badges (default: false)
- example: | SkillSelector value=selectedSkillCode onChange=(code) = setSelectedSkillCode(code) module=“chat” placeholder=“Choose a skill…”/
- score: 4
component SkillVersionHistoryDrawer
- file: src/platform/ai/components/SkillVersionHistoryDrawer.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Drawer presenting a skill’s chronological version snapshots with a forward-only rollback.The prop (id + name + regulated flag) drives the drawer; a skill keeps it closed. is the open-state callback; gates the rollback action on the permission.
- score: 2
component SLADefinitionForm
- file: src/platform/sla/components/SLADefinitionForm.tsx:46
- kind: component
- core: platform
- spec: (none)
- summary: SLA Definition create/edit form dialog.
- score: 2
component SLAIndicator
- file: src/platform/sla/components/SLAIndicator.tsx:115
- kind: component
- core: platform
- spec: (none)
- summary: SLA badge indicator for entity pages using platform SLA data.
- score: 2
component SLAInstanceActionDialog
- file: src/platform/sla/components/SLAInstanceActionDialog.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for performing actions on an SLA instance.
- score: 2
component SLAStatusBadge
- file: src/platform/sla/components/SLAIndicator.tsx:92
- kind: component
- core: platform
- spec: (none)
- summary: SLA status badge presenter with optional compact formatting.
- score: 2
component SLAViolationsList
- file: src/platform/health/components/SLAViolationsList.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for slaviolations list.
- score: 1
component SlugNestedContent
- file: src/platform/router/SlugNestedContent.tsx:58
- kind: component
- core: platform
- spec: (none)
- summary: Renders the correct module for org-scoped routes.Mirrors RouteLoader logic but uses the splat param instead of location.pathname.
- score: 2
component SmallCellFootnote
- file: src/platform/analytics/components/SuppressionBadge.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Disclosure footnote to place beneath any table/chart that may contain suppressed cells.
- score: 2
component SMSTestCard
- file: src/platform/notifications/components/testing/ChannelTestCards.tsx:410
- kind: component
- core: platform
- spec: (none)
- summary: Renders the smstest card interface.
- score: 2
component SnoozeMenu
- file: src/platform/inbox/components/SnoozeMenu.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for snooze menu.
- score: 1
component SortableField
- file: src/platform/page-layouts/components/SortableField.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for sortable field.
- score: 1
component SortableSection
- file: src/platform/page-layouts/components/SortableSection.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for sortable section.
- score: 1
component SortableWidget
- file: src/platform/dashboard/components/SortableWidget.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for sortable widget.
- score: 1
component SourceExplorer
- file: src/platform/settings/pages/data-migration/components/SourceExplorer.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for source explorer.
- score: 1
component SourceTasksPanel
- file: src/platform/tasks/components/SourceTasksPanel.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Displays tasks linked to a specific source entity with add/complete functionality.
- score: 2
component SQLPreview
- file: src/platform/reports/components/SQLPreview.tsx:13
- kind: component
- core: platform
- spec: (none)
- summary: Utility for sqlpreview.
- score: 1
component SsoSetupWizard
- file: src/platform/auth/sso/SsoSetupWizard.tsx:76
- kind: component
- core: platform
- spec: (none)
- summary: Multi-step dialog guiding an org admin through SAML single sign-on againstMicrosoft Entra: claim a domain, verify ownership via a DNS TXT record, supplythe IdP metadata URL/entity ID, then test and activate the connection.
- score: 2
component StaleDataIndicator
- file: src/platform/dashboard/components/StaleDataIndicator.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Shows data freshness status with optional refresh button- Green/muted when fresh- Yellow/warning when stale (5 min)
- score: 2
component StarterRolesWizard
- file: src/platform/roles/components/StarterRolesWizard.tsx:45
- kind: component
- core: platform
- spec: (none)
- summary: Utility for starter roles wizard.
- score: 1
component StarterTemplatesBrowser
- file: src/platform/templates/pages/StarterTemplatesBrowser.tsx:64
- kind: component
- core: platform
- spec: (none)
- summary: Browser UI to discover and clone system “starter” document and approval templates.Renders searchable and industry-filterable lists of system document templates and approval chains,shows empty and loading states, and—when the current user has template management permission—allows cloning a selected template into the current organization via a preview dialog.
- params:
- props — This component does not accept any props; it reads organization, permissions, and templates from hooks.
- example: | StarterTemplatesBrowser /Accessibility:- Search, filter, and actionable buttons are focusable and keyboard operable.- Clone flows open a preview dialog; the dialog should trap focus and return focus to the triggering control when closed.
- score: 4
component StartEventNode
- file: src/platform/workflow/components/swim-lane-nodes/StartEventNode.tsx:13
- kind: component
- core: platform
- spec: (none)
- summary: Start event node — green circle with play icon.
- score: 2
component StartMigrationDialog
- file: src/platform/settings/pages/data-migration/components/StartMigrationDialog.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for starting a new migration run with optional mapping auto-fill.
- score: 2
component StepConfigPanel
- file: src/platform/wizards/components/StepConfigPanel.tsx:61
- kind: component
- core: platform
- spec: (none)
- summary: Utility for step config panel.
- score: 1
component StepFunnelChart
- file: src/platform/wizards/components/analytics/StepFunnelChart.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for step funnel chart.
- score: 1
component StepIntro
- file: src/platform/headshot/components/wizard/StepIntro.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Upload wizard intro step.
- score: 1
component StepListItem
- file: src/platform/wizards/components/StepListItem.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Utility for step list item.
- score: 1
component StepReview
- file: src/platform/headshot/components/wizard/StepReview.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Review step showing summary before generation.
- score: 2
component StepSkeleton
- file: src/platform/wizards/components/steps/StepSkeleton.tsx:10
- kind: component
- core: platform
- spec: (none)
- summary: Utility for step skeleton.
- score: 1
component StepStyles
- file: src/platform/headshot/components/wizard/StepStyles.tsx:63
- kind: component
- core: platform
- spec: (none)
- summary: Style selection step with card grid.
- score: 2
component StepTransition
- file: src/platform/wizards/components/StepTransition.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for step transition.
- score: 1
component StepUpload
- file: src/platform/headshot/components/wizard/StepUpload.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Upload step with drag-and-drop zone and file list.
- score: 2
component StepValidationPanel
- file: src/platform/wizards/components/StepValidationPanel.tsx:64
- kind: component
- core: platform
- spec: (none)
- summary: Utility for step validation panel.
- score: 1
component StepVisibilityPanel
- file: src/platform/wizards/components/StepVisibilityPanel.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for step visibility panel.
- score: 1
component SubdomainTab
- file: src/platform/theming/components/SubdomainTab.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Subdomain configuration tab for organization branding.
- score: 2
component SubscriptionStatusPanel
- file: src/platform/notifications/components/testing/SubscriptionStatusPanel.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Utility for subscription status panel.
- score: 1
component SuggestedWorkspaceCard
- file: src/platform/navigation/workspaces/admin/SuggestedWorkspaceCard.tsx:48
- kind: component
- core: platform
- spec: (none)
- summary: Card presenting a single AI-proposed workspace recommendation with itsresolved core/group display labels and accept / edit-before-accepting /dismiss actions; all actions disable while is set.
- score: 2
component SuppressionBadge
- file: src/platform/analytics/components/SuppressionBadge.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: A privacy-suppression indicator. When is omitted it shows (aprimary-suppressed small count); pass a neutral mark (e.g. ”—”) for a complementarysuppression, where the true value may be ≥ threshold and must not be implied.
- score: 2
component SwimLaneCanvas
- file: src/platform/workflow/SwimLaneCanvas.tsx:284
- kind: component
- core: platform
- spec: (none)
- summary: Swim lane-aware workflow canvas.Lanes render as React Flow group nodes with visible headers.Supports drag-and-drop node creation from NodePalette.When used inside an existing ReactFlowProvider (e.g. the builder page),set to true to avoid nesting providers.
- score: 2
component SwimLaneDiagramBuilderPage
- file: src/platform/workflow/pages/SwimLaneDiagramBuilderPage.tsx:532
- kind: component
- core: platform
- spec: (none)
- summary: Swim lane diagram builder with toolbar, node palette, and canvas.Wrapped in ReactFlowProvider so inner component can use useReactFlow.
- score: 2
component SwimLaneDiagramListPage
- file: src/platform/workflow/pages/SwimLaneDiagramListPage.tsx:86
- kind: component
- core: platform
- spec: (none)
- summary: List page for swim lane diagrams with guided creation wizard.
- score: 2
component SwimLaneTemplateList
- file: src/platform/workflow/components/SwimLaneTemplateList.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Grid of swim lane diagram templates with “Use template” action.
- score: 2
component SwimLaneTemplatesPage
- file: src/platform/workflow/pages/SwimLaneTemplatesPage.tsx:15
- kind: component
- core: platform
- spec: (none)
- summary: Page for browsing swim lane diagram templates.
- score: 2
component SwipeableCardShell
- file: src/platform/gestures/components/SwipeableCardShell.tsx:48
- kind: component
- core: platform
- spec: (none)
- summary: Auto-mobile-detecting swipeable card shell. Prefer this over for any list/card row across cores; falls back to plain children on non-touch.
- score: 2
component SwipeableListItem
- file: src/platform/gestures/components/SwipeableListItem.tsx:42
- kind: component
- core: platform
- spec: (none)
- summary: SwipeableListItem wraps list items with reveal actions
- score: 5
component SwipeableSheet
- file: src/platform/gestures/components/SwipeableSheet.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: SwipeableSheet wraps content with swipe-to-dismiss capability
- score: 5
component SwipeableWidget
- file: src/platform/dashboard/components/SwipeableWidget.tsx:33
- kind: component
- core: platform
- spec: (none)
- summary: Renders a widget wrapped with mobile swipe actions only when in edit mode:left → hide, right → resize.
- score: 2
component SyncStatusPage
- file: src/platform/org-data-sync/pages/SyncStatusPage.tsx:14
- kind: component
- core: platform
- spec: (none)
- summary: Utility for sync status page.
- score: 1
component SystemHealthDashboard
- file: src/platform/health/pages/SystemHealthDashboard.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: Utility for system health dashboard.
- score: 1
component SystemHealthWidget
- file: src/platform/dashboard/widgets/SystemHealthWidget.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for system health widget.
- score: 1
component SystemPicklistBanner
- file: src/platform/picklists/components/SystemPicklistBanner.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for system picklist banner.
- score: 1
component SystemRolesList
- file: src/platform/roles/components/SystemRolesList.tsx:171
- kind: component
- core: platform
- spec: (none)
- summary: Utility for system roles list.
- score: 1
component SystemTemplateCard
- file: src/platform/wizards/components/SystemTemplateCard.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for system template card.
- score: 1
component SystemTemplatesSection
- file: src/platform/wizards/components/SystemTemplatesSection.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Utility for system templates section.
- score: 1
component TableFilters
- file: src/platform/table-v2/components/TableFilters.tsx:34
- kind: component
- core: platform
- spec: (none)
- summary: Utility for table filters.
- score: 1
component TablePagination
- file: src/platform/table-v2/components/LegacyTablePagination.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Utility for table pagination.
- score: 1
component TablePagination
- file: src/platform/table-v2/components/TablePagination.tsx:85
- kind: component
- core: platform
- spec: (none)
- summary: TablePagination component for navigating paginated table data.
- score: 5
component TableSelector
- file: src/platform/reports/components/TableSelector.tsx:113
- kind: component
- core: platform
- spec: (none)
- summary: Utility for table selector.
- score: 1
component TagInput
- file: src/platform/knowledge/components/TagInput.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Renders an editable tag input control that lets users add, remove, and view a list of tags.The component normalizes added tags to lowercase, enforces uniqueness and a maximum tag count,and calls with the updated tags array whenever tags are added or removed.
- params:
- props — Component props - tags: Current list of tags to display. - onChange: Callback invoked with the new tags array when tags change. - placeholder: Placeholder text shown in the input when empty (default: “Add tag…”). - maxTags: Maximum number of tags allowed; when reached the input is hidden and a notice is shown (default: 10). - className: Optional additional CSS class names applied to the component container. - disabled: When true, prevents adding or removing tags and disables the input (default: false).Accessibility:- Each tag includes a remove button with an of for screen readers.- The input element receives standard keyboard focus and supports Enter or comma to commit a tag and Backspace to remove the last tag when the input is empty.
- returns: The rendered TagInput React element.
- example: | TagInput tags=[‘react’, ‘typescript’] onChange=(next) = setTags(next) placeholder=“Add a topic…”/
- score: 4
component TanStackDataTable
- file: src/platform/table-v2/components/TanStackDataTable.tsx:161
- kind: component
- core: platform
- spec: (none)
- summary: TanStackDataTable - Backward-compatible DataTable using TanStack Table.This component accepts the same props as the PF-58 DataTable and rendersusing TanStack Table internally. Use this as a drop-in replacement duringmigration.Supports optional virtualization for large datasets:- Auto-enables for 500+ rows (configurable via virtualAutoThreshold)- Disabled automatically for expandable rows- Uses keyboard navigation (Home/End/PageUp/PageDown) T - Row data type, must have an ‘id’ field
- score: 5
component TaskAnalyticsPage
- file: src/platform/tasks/pages/TaskAnalyticsPage.tsx:179
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task analytics page.
- score: 1
component TaskAutomationPage
- file: src/platform/tasks/pages/TaskAutomationPage.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task automation page.
- score: 1
component TaskAutomationRuleFormDialog
- file: src/platform/tasks/components/TaskAutomationRuleFormDialog.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task automation rule form dialog.
- score: 1
component TaskCard
- file: src/platform/tasks/components/TaskCard.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task card.
- score: 1
component TaskChecklistSection
- file: src/platform/tasks/components/TaskChecklistSection.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Inline checklist editor — list items, toggle complete, add new, remove.
- score: 2
component TaskCommentThread
- file: src/platform/tasks/components/TaskCommentThread.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task comment thread.
- score: 1
component TaskDashboardWidget
- file: src/platform/tasks/components/TaskDashboardWidget.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task dashboard widget.
- score: 1
component TaskDependencyEditor
- file: src/platform/tasks/components/TaskDependencyEditor.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task dependency editor.
- score: 1
component TaskDetailPage
- file: src/platform/tasks/pages/TaskDetailPage.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task detail page.
- score: 1
component TaskDiscussionThread
- file: src/platform/tasks/components/TaskDiscussionThread.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task discussion thread.
- score: 1
component TaskFormDialog
- file: src/platform/tasks/components/TaskFormDialog.tsx:58
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task form dialog.
- score: 1
component TaskList
- file: src/platform/tasks/components/TaskList.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task list.
- score: 1
component TaskNode
- file: src/platform/workflow/components/swim-lane-nodes/TaskNode.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Task node — rounded card with label text.
- score: 2
component TaskReportsPage
- file: src/platform/tasks/pages/TaskReportsPage.tsx:225
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task reports page.
- score: 1
component TaskTemplateFormDialog
- file: src/platform/tasks/components/TaskTemplateFormDialog.tsx:38
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task template form dialog.
- score: 1
component TaskTemplatePickerDialog
- file: src/platform/tasks/components/TaskTemplatePickerDialog.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task template picker dialog.
- score: 1
component TaskTemplatesPage
- file: src/platform/tasks/pages/TaskTemplatesPage.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task templates page.
- score: 1
component TaskTimeEntrySheet
- file: src/platform/tasks/components/TaskTimeEntrySheet.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task time entry sheet.
- score: 1
component TaskTimeSection
- file: src/platform/tasks/components/TaskTimeSection.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for task time section.
- score: 1
component TeamsConfigurationCard
- file: src/platform/settings/components/TeamsConfigurationCard.tsx:50
- kind: component
- core: platform
- spec: (none)
- summary: Utility for teams configuration card.
- score: 1
component TeamsNotificationConfig
- file: src/platform/settings/components/TeamsNotificationConfig.tsx:47
- kind: component
- core: platform
- spec: (none)
- summary: Utility for teams notification config.
- score: 1
component TemplateCard
- file: src/platform/reports/components/TemplateCard.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for template card.
- score: 1
component TemplateClonePreviewDialog
- file: src/platform/templates/components/TemplateClonePreviewDialog.tsx:81
- kind: component
- core: platform
- spec: (none)
- summary: Presents a modal dialog that previews a document or approval template’s metadata and structure,lets the user edit a new name (and optionally mark a document template as active), and confirms cloning.
- params:
- open — Whether the dialog is visible
- onOpenChange — Callback invoked when the dialog open state should change; receives the new open boolean
- template — The template being previewed; null hides the dialog
- templateType — Either or , controls which template details and structure are shown
- onClone — Callback invoked when the user confirms cloning. Called with
- isCloning — Optional flag indicating an in-progress clone operation (disables inputs and shows loading state). Defaults to Accessibility considerations:- The dialog uses a modal pattern and provides labeled controls for the template name and clone-as-active checkbox.- Structure lists include clear headings and ordinal badges to help screen reader users understand ordering.
- example: | TemplateClonePreviewDialog open=isOpen onOpenChange=setIsOpen template=selectedTemplate templateType=“document” onClone=(name, cloneAsActive) = handleCloneTemplate(name, cloneAsActive) isCloning=isSubmitting/
- score: 4
component TemplateEditorDialog
- file: src/platform/dashboard/components/TemplateEditorDialog.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Utility for template editor dialog.
- score: 1
component TemplateFormDialog
- file: src/platform/provisioning/components/TemplateFormDialog.tsx:65
- kind: component
- core: platform
- spec: (none)
- summary: Utility for template form dialog.
- score: 1
component TemplateGalleryDialog
- file: src/platform/email-signatures/components/TemplateGalleryDialog.tsx:22
- kind: component
- core: platform
- spec: (none)
- summary: Dialog presenting pre-built signature templates for quick start.
- score: 2
component TemplateImportExportDialog
- file: src/platform/templates/components/TemplateImportExportDialog.tsx:164
- kind: component
- core: platform
- spec: (none)
- summary: Utility for template import export dialog.
- score: 1
component TemplateLibraryBrowser
- file: src/platform/templates/components/TemplateLibraryBrowser.tsx:189
- kind: component
- core: platform
- spec: (none)
- summary: Renders a category-based, searchable template library with optional preview and clone workflows.Displays templates grouped into System and Organization sections, supports category and industryfiltering, text search, grid/list view modes, and cloning system templates into the current organization.
- params:
- props — Component props - filterTypes: Optional list of template types to restrict which templates are shown. - onTemplateSelect: Optional callback invoked with a template when the user selects or successfully clones a template. - showPreview: Whether the preview panel and preview actions should be available (default: ). - className: Additional CSS class names to apply to the root container.Accessibility considerations:- Search, filter, and view mode controls are operable via keyboard.- Dialogs (preview and clone) trap focus while open and return focus on close.- Ensure sufficient color contrast for badges and buttons in custom themes.
- example: | TemplateLibraryBrowser filterTypes=[‘policy’, ‘report’] onTemplateSelect=(t) = console.log(‘selected’, t.id) showPreview=true/
- score: 4
component TemplatePreviewDialog
- file: src/platform/dashboard/components/TemplatePreviewDialog.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for template preview dialog.
- score: 1
component TemplatePreviewSwitcher
- file: src/platform/templates/components/TemplatePreviewSwitcher.tsx:168
- kind: component
- core: platform
- spec: (none)
- summary: Enhanced preview panel that lets users switch letterheads and document templates,toggle page orientation, and preview using sample or real document data.Renders controls for selecting an organization or system letterhead (with loadingand “No letterhead” options), an optional template selector, an optional orientationtoggle, and an optional sample-data switch. The selected options are propagated viacallbacks and the resolved content is passed to an embedded PDF preview panel. - sections: Array of PDF sections to render in the preview. - title: Document title shown in the preview. - subtitle: Document subtitle shown in the preview. - metadata: Document metadata (author, dates, version, number). - showApprovalBlock: When true, include an approval block in the preview. - selectedLetterheadId: Currently selected letterhead id, or / for none. - onLetterheadChange: Callback invoked with the new letterhead id or when selection changes. - documentTemplates: Optional list of document templates available for selection. - selectedTemplateId: Currently selected template id, or / for default. - onTemplateChange: Callback invoked with the new template id or when selection changes. - enableSampleData: When true, show a toggle to switch between sample and real data. - sampleSections: Sections to use when sample data mode is enabled (defaults provided). - sampleMetadata: Optional metadata to use in sample mode; if omitted a default with the current date is created. - showOrientationToggle: When true, show a control to toggle between portrait and landscape. - initialOrientation: Initial orientation, either or (used only on mount). - onOrientationChange: Callback invoked with the new orientation when toggled. - className: Optional additional container CSS class names.
- example: | TemplatePreviewSwitcher sections=sections title=“Policy” subtitle=“Draft” metadata=metadata selectedLetterheadId=letterheadId onLetterheadChange=(id) = setLetterheadId(id) documentTemplates=templates selectedTemplateId=templateId onTemplateChange=(id) = setTemplateId(id) enableSampleData showOrientationToggle/Accessibility:- Select, switch, and button controls include labels and ids to support assistive technologies.- Ensure any custom styling preserves focus outlines and keyboard operability for all interactive controls.
- score: 5
component TemplateSandbox
- file: src/platform/templates/components/TemplateSandbox.tsx:98
- kind: component
- core: platform
- spec: (none)
- summary: Utility for template sandbox.
- score: 1
component TemplateSharingDialog
- file: src/platform/templates/components/TemplateSharingDialog.tsx:92
- kind: component
- core: platform
- spec: (none)
- summary: Utility for template sharing dialog.
- score: 1
component TemplatesHubPage
- file: src/platform/templates/pages/TemplatesHubPage.tsx:233
- kind: component
- core: platform
- spec: (none)
- summary: Renders the Templates Hub page that centralizes access to Document, Form, Workflow, and Wizard templates.Presents a decision helper table to guide users to the appropriate template type, a responsive grid of templatecards with navigation controls, and a footer help alert linking to letterhead configuration. Navigation is handledvia react-router’s navigation hooks and each interactive control routes to the corresponding management page.
- params:
- props — None. This component does not accept props.
- example: | TemplatesHubPage /Accessibility considerations:- Table uses semantic table, thead, and tbody elements for assistive technology.- All actions (row “Go” buttons, card “Manage” buttons, and clickable cards) are keyboard-focusable and provide clear text labels for screen readers.
- score: 4
component TemplatesLibraryPage
- file: src/platform/page-layouts/pages/TemplatesLibraryPage.tsx:82
- kind: component
- core: platform
- spec: (none)
- summary: Utility for templates library page.
- score: 1
component TemplatesSettingsPage
- file: src/platform/templates/pages/TemplatesSettingsPage.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: Page component that provides a tabbed interface for managing letterheads, document templates,approval workflows, and starter templates. The active tab is synchronized with the query parameter in the URL and access is restricted to users with the permission.Accessibility: Tabs are keyboard-navigable through the underlying Tabs component; ensure theTabs implementation exposes appropriate ARIA roles and focus management for screen readers.
- params:
- props — Component props (none required)
- returns: The page’s JSX element representing the templates settings UI
- example: | // Render inside application routing or a layoutTemplatesSettingsPage /
- score: 4
component TemplateStatusBadge
- file: src/platform/templates/components/TemplateStatusBadge.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for template status badge.
- score: 1
component TenantThemeProvider
- file: src/platform/theming/components/TenantThemeProvider.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Provides tenant-specific CSS custom properties on .Must be rendered inside (authenticated shell).Does NOT block rendering while theme loads — children render immediatelywith platform defaults, then tenant overrides apply once fetched.
- score: 2
component TerminologyManagementPage
- file: src/platform/terminology/pages/TerminologyManagementPage.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: PF-70-EN-01: Terminology management page.Provides ICD-10 hierarchy navigation, code set version management,and cross-code-set mapping administration.
- score: 2
component TerminologyStep
- file: src/platform/ai/components/onboarding/TerminologyStep.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Renders the Terminology & Voice step (optional).
- params:
- props — .
- score: 2
component TestCallDialog
- file: src/platform/settings/components/TestCallDialog.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Modal dialog that lets the user initiate a RingCentral Embeddable softphone test call.Presents the test phone number, shows widget readiness/login status, and starts a test call(expands the widget and dials the preset test number) when the primary action is confirmed.Accessibility: the dialog uses standard Dialog semantics; ensure focus is managed by the parentDialog component and that visual status text (e.g., “Loading…”, “Not Logged In”, “Ready”)is perceivable by screen readers.
- params:
- props — Component props - open: Whether the dialog is open - onOpenChange: Callback invoked with the new open state when the dialog is requested to open or close
- example: | TestCallDialog open=isDialogOpen onOpenChange=(open) = setDialogOpen(open) /
- score: 4
component TestScenarioManager
- file: src/platform/conditional-logic/components/builder/TestScenarioManager.tsx:46
- kind: component
- core: platform
- spec: (none)
- summary: Utility for test scenario manager.
- score: 1
component TestStep
- file: src/platform/ai/wizards/ai-skill-creation/steps/TestStep.tsx:36
- kind: component
- core: platform
- spec: (none)
- summary: Renders Step 4 (Test & Tune) with the mandatory test-run gate.
- params:
- props — The shared form instance + analytics callback.
- score: 2
component TextareaField
- file: src/platform/forms/components/fields/TextareaField.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for textarea field.
- score: 1
component TextField
- file: src/platform/forms/components/fields/TextField.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for text field.
- score: 1
component TextViewer
- file: src/platform/documents/TextViewer.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for text viewer.
- score: 1
component ThemePreview
- file: src/platform/theming/components/ThemePreview.tsx:106
- kind: component
- core: platform
- spec: (none)
- summary: Inline preview that applies draft theme colors to a scoped subtree.
- score: 2
component ThreadListPane
- file: src/platform/cowork/components/ThreadListPane.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: ThreadListPane — selectable conversation list for the Cowork workspace left column.Consumes PF-67 useConversations; realtime-backed via the hook’s built-in subscription.
- score: 2
component TimeMetricsChart
- file: src/platform/wizards/components/analytics/TimeMetricsChart.tsx:26
- kind: component
- core: platform
- spec: (none)
- summary: Utility for time metrics chart.
- score: 1
component TimeRangeSelector
- file: src/platform/health/components/TimeRangeSelector.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for time range selector.
- score: 1
component TransformPreviewCard
- file: src/platform/settings/pages/data-migration/components/TransformPreviewCard.tsx:81
- kind: component
- core: platform
- spec: (none)
- summary: Preview card for dry-run transformation of source data.
- score: 2
component TransformRulesEditor
- file: src/platform/settings/pages/data-migration/components/TransformRulesEditor.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Collapsible editor for transform rules on a mapping.
- score: 2
component TrendChart
- file: src/platform/health/components/TrendChart.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for trend chart.
- score: 1
component TrustRow
- file: src/platform/auth/components/LoginBrandPanel.tsx:118
- kind: component
- core: platform
- spec: (none)
- summary: Renders HIPAA / SOC 2 / Encryption trust badges.Used in both the desktop left panel and below the mobile card.
- score: 2
component TypingIndicator
- file: src/platform/messaging/components/TypingIndicator.tsx:18
- kind: component
- core: platform
- spec: (none)
- summary: Utility for typing indicator.
- score: 1
component TypographyTab
- file: src/platform/theming/components/TypographyTab.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Typography settings tab for font family and heading font selection.
- score: 2
component UnifiedInboxPage
- file: src/platform/inbox/UnifiedInboxPage.tsx:296
- kind: component
- core: platform
- spec: (none)
- summary: Utility for unified inbox page.
- score: 1
component UnreadSeparator
- file: src/platform/messaging/components/UnreadSeparator.tsx:9
- kind: component
- core: platform
- spec: (none)
- summary: Visual separator indicating the start of unread messages.
- score: 2
component UnsavedChangesBar
- file: src/platform/data-manager/components/UnsavedChangesBar.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for unsaved changes bar.
- score: 1
component UnsavedChangesDialog
- file: src/platform/settings/components/UnsavedChangesDialog.tsx:12
- kind: component
- core: platform
- spec: (none)
- summary: Confirmation when leaving a settings page with unsaved edits.
- score: 2
component UploadVersionDialog
- file: src/platform/documents/UploadVersionDialog.tsx:21
- kind: component
- core: platform
- spec: (none)
- summary: Utility for upload version dialog.
- score: 1
component UsageDashboardTab
- file: src/platform/quota/components/UsageDashboardTab.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Usage dashboard tab showing current resource consumption against quota limits.
- score: 2
component UserManagement
- file: src/platform/users/UserManagement.tsx:60
- kind: component
- core: platform
- spec: (none)
- summary: Utility for user management.
- score: 1
component UserMenu
- file: src/platform/navigation/UserMenu.tsx:51
- kind: component
- core: platform
- spec: (none)
- summary: Utility for user menu.
- score: 1
component UserProfileCard
- file: src/platform/navigation/UserProfileCard.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for user profile card.
- score: 1
component UserSignatureEditor
- file: src/platform/email-signatures/components/UserSignatureEditor.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Editor for a user’s personal email signature, showing inherited org template.
- score: 2
component UserSignatureSettingsPage
- file: src/platform/email-signatures/pages/UserSignatureSettingsPage.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: User settings page for customizing personal email signature.
- score: 2
component ValidationAnalyticsReport
- file: src/platform/validation/components/ValidationAnalyticsReport.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Simple table showing failure count per rule, sorted by count descending.
- score: 2
component ValidationRuleBuilder
- file: src/platform/wizards/components/ValidationRuleBuilder.tsx:107
- kind: component
- core: platform
- spec: (none)
- summary: Utility for validation rule builder.
- score: 1
component ValidationRuleFormDialog
- file: src/platform/validation/components/ValidationRuleFormDialog.tsx:43
- kind: component
- core: platform
- spec: (none)
- summary: Dialog for creating or editing a validation rule.
- score: 2
component ValidationRulesListPage
- file: src/platform/validation/components/ValidationRulesListPage.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Table listing all validation rules for the organization.
- score: 2
component ValidationRulesPage
- file: src/platform/validation/pages/ValidationRulesPage.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Validation Rules hub page with three tabs: Rules, Analytics, Settings.
- score: 2
component ValidationSettingsSection
- file: src/platform/validation/components/ValidationSettingsSection.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Settings section for validation configuration: async timeout and default phone format.
- score: 2
component ValueEditor
- file: src/platform/conditional-logic/components/builder/ValueEditor.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Utility for value editor.
- score: 1
component ValueMappingStep
- file: src/platform/import/components/ValueMappingStep.tsx:104
- kind: component
- core: platform
- spec: (none)
- summary: Value mapping reconciliation step for the PF-88 import flow.
- score: 2
component VariableBadge
- file: src/platform/templates/components/VariableInserter.tsx:205
- kind: component
- core: platform
- spec: (none)
- summary: Inline badge for displaying a variable in content
- score: 2
component VariableHelpSection
- file: src/platform/email-signatures/components/VariableHelpSection.tsx:16
- kind: component
- core: platform
- spec: (none)
- summary: Displays available template variables with copy-to-clipboard buttons.
- score: 2
component VariableInserter
- file: src/platform/templates/components/VariableInserter.tsx:44
- kind: component
- core: platform
- spec: (none)
- summary: Dropdown component for inserting template variables.
- score: 2
component VersionBadge
- file: src/platform/pwa/components/VersionBadge.tsx:12
- kind: component
- core: platform
- spec: (none)
- summary: Utility for version badge.
- score: 1
component VersionCheck
- file: src/platform/pwa/components/VersionCheck.tsx:20
- kind: component
- core: platform
- spec: (none)
- summary: Checks the deployed app version periodically and shows an update banner when a new version is detected.Schedules an initial deferred version check (using requestIdleCallback with a timeout or a timeout fallback),then polls /version.json every 5 minutes. When the fetched version differs from the cached version inlocalStorage, displays a PWA update banner that allows the user to reload or snooze the update.Accessibility: the rendered update banner (PwaUpdateBanner) should provide clear focus management andaccessible labels; this component renders nothing when no update is available.
- returns: The update banner element when a new version is detected, or when no update is needed.
- example: | VersionCheck /
- score: 5
component VersionComparisonView
- file: src/platform/documents/pages/VersionComparisonView.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Page component for comparing two document versions side-by-side.
- score: 2
component ViewerLoadingSkeleton
- file: src/platform/documents/components/ViewerLoadingSkeleton.tsx:13
- kind: component
- core: platform
- spec: (none)
- summary: Loading skeleton for document viewers.Displays appropriate skeleton UI based on the document type being loaded.
- score: 2
component ViolationsTab
- file: src/platform/quota/components/ViolationsTab.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Violations tab listing quota breaches with filtering and export.
- score: 2
component VirtualizedTable
- file: src/platform/table-v2/components/VirtualizedTable.tsx:107
- kind: component
- core: platform
- spec: (none)
- summary: VirtualizedTable component for rendering large datasets efficiently.
- score: 5
component VirtualizedTableBody
- file: src/platform/table-v2/components/VirtualizedTableBody.tsx:47
- kind: component
- core: platform
- spec: (none)
- summary: Virtualized table body that only renders visible rows.Uses absolute positioning to place rows within a fixed-height container,enabling smooth scrolling for large datasets.
- score: 2
component VisibilityConditionRow
- file: src/platform/wizards/components/VisibilityConditionRow.tsx:36
- kind: component
- core: platform
- spec: (none)
- summary: Utility for visibility condition row.
- score: 1
component VisibilityRuleEditor
- file: src/platform/page-layouts/components/VisibilityRuleEditor.tsx:51
- kind: component
- core: platform
- spec: (none)
- summary: Utility for visibility rule editor.
- score: 1
component WebhookDeliveryDetail
- file: src/platform/integrations/components/WebhookDeliveryDetail.tsx:55
- kind: component
- core: platform
- spec: (none)
- summary: Utility for webhook delivery detail.
- score: 1
component WebhookDeliveryLog
- file: src/platform/integrations/components/WebhookDeliveryLog.tsx:35
- kind: component
- core: platform
- spec: (none)
- summary: Utility for webhook delivery log.
- score: 1
component WebVitalsCard
- file: src/platform/health/components/WebVitalsCard.tsx:120
- kind: component
- core: platform
- spec: (none)
- summary: Utility for web vitals card.
- score: 1
component WelcomeHub
- file: src/platform/auth/WelcomeHub.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Employee Welcome Hub with onboarding soft checklist.
- score: 2
component WidgetConfigDialog
- file: src/platform/analytics/dashboard/WidgetConfigDialog.tsx:59
- kind: component
- core: platform
- spec: (none)
- summary: Modal dialog for adding or editing a single analytics canvas tile.Renders a two-panel layout: a left form panel (registry pickers, chart-type select, span select,optional title) and a right live-preview panel (stubbed in unit tests; real in production).Validates on submit — calls onSubmit only when the zod schema passes.
- score: 2
component WidgetDrawer
- file: src/platform/dashboard/components/WidgetDrawer.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for widget drawer.
- score: 1
component WidgetErrorBoundary
- file: src/platform/dashboard/components/WidgetErrorBoundary.tsx:48
- kind: component
- core: platform
- spec: (none)
- summary: Utility for widget error boundary.
- score: 1
component WidgetExpandedDialog
- file: src/platform/dashboard/components/WidgetExpandedDialog.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for widget expanded dialog.
- score: 1
component WidgetGrid
- file: src/platform/dashboard/components/WidgetGrid.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Utility for widget grid.
- score: 1
component WidgetLastUpdated
- file: src/platform/dashboard/components/WidgetLastUpdated.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Display when widget data was last updatedShows warning color when data is stale (older than maxAge)Optionally includes a manual refresh buttonNote: This component expects a TooltipProvider to be present in the component tree.The app-level TooltipProvider should be used; do not wrap with nested providers.
- score: 2
component WidgetSection
- file: src/platform/dashboard/components/WidgetSection.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for widget section.
- score: 1
component WidgetSizeSelector
- file: src/platform/dashboard/components/WidgetSizeSelector.tsx:23
- kind: component
- core: platform
- spec: (none)
- summary: Utility for widget size selector.
- score: 1
component WidgetSkeleton
- file: src/platform/dashboard/components/WidgetSkeleton.tsx:16
- kind: component
- core: platform
- spec: (none)
- summary: Utility for widget skeleton.
- score: 1
component WidgetWrapper
- file: src/platform/dashboard/components/WidgetWrapper.tsx:41
- kind: component
- core: platform
- spec: (none)
- summary: Utility for widget wrapper.
- score: 1
component WizardAnalyticsDashboard
- file: src/platform/wizards/components/WizardAnalyticsDashboard.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard analytics dashboard.
- score: 1
component WizardAnalyticsPage
- file: src/platform/wizards/pages/WizardAnalyticsPage.tsx:40
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard analytics page.
- score: 1
component WizardBuilder
- file: src/platform/wizards/components/WizardBuilder.tsx:47
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard builder.
- score: 1
component WizardBuilderPage
- file: src/platform/wizards/pages/WizardBuilderPage.tsx:113
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard builder page.
- score: 1
component WizardCompleteStep
- file: src/platform/wizards/components/WizardCompleteStep.tsx:37
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard complete step.
- score: 1
component WizardCreatePage
- file: src/platform/wizards/pages/WizardCreatePage.tsx:180
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard create page.
- score: 1
component WizardFormDialog
- file: src/platform/page-layouts/components/wizards/WizardFormDialog.tsx:46
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard form dialog.
- score: 1
component WizardIconAuditPage
- file: src/platform/wizards/pages/WizardIconAuditPage.tsx:60
- kind: component
- core: platform
- spec: (none)
- summary: Wizard step icon audit page.
- score: 1
component WizardList
- file: src/platform/page-layouts/components/wizards/WizardList.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard list.
- score: 1
component WizardListPage
- file: src/platform/wizards/pages/WizardListPage.tsx:25
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard list page.
- score: 1
component WizardMigrationSection
- file: src/platform/wizards/components/WizardMigrationSection.tsx:165
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard migration section.
- score: 1
component WizardNavigation
- file: src/platform/forms/components/wizard/WizardNavigation.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard navigation.
- score: 1
component WizardPageShell
- file: src/platform/wizards/components/WizardPageShell.tsx:71
- kind: component
- core: platform
- spec: (none)
- summary: Full-height flex wrapper that gives a route-level wizard the vertical context itneeds without claiming any layout concern the wizard or app shell already owns.
- score: 2
component WizardPreview
- file: src/platform/wizards/components/WizardPreview.tsx:32
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard preview.
- score: 1
component WizardPreviewField
- file: src/platform/wizards/components/WizardPreviewField.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard preview field.
- score: 1
component WizardPreviewForm
- file: src/platform/wizards/components/WizardPreviewForm.tsx:19
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard preview form.
- score: 1
component WizardReviewLayout
- file: src/platform/wizards/components/review/WizardReviewLayout.tsx:39
- kind: component
- core: platform
- spec: (none)
- summary: WizardReviewLayoutOuter container for a wizard’s “Review & Submit” step. Provides thestandard shell so each wizard’s ReviewStep justneeds to drop in children.
- score: 5
component WizardReviewSection
- file: src/platform/wizards/components/review/WizardReviewSection.tsx:50
- kind: component
- core: platform
- spec: (none)
- summary: WizardReviewSectionOne section card on a wizard’s “Review & Submit” step. Provides thestandard shell so per-wizard ReviewStep files don’t have to recreate it.- 44px touch target on the Edit button (a11y)- for screen-reader clarity- Edit button is omitted when is not providedRecommended composition: pair with for label/value rowsinside the section.Replaces the duplicated section pattern across CE / GR / HR wizards(CCR R-T2.1).
- score: 2
component WizardRun
- file: src/platform/page-layouts/components/wizards/WizardRun.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard run.
- score: 1
component WizardSettingsDialog
- file: src/platform/wizards/components/WizardSettingsDialog.tsx:29
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard settings dialog.
- score: 1
component WizardShell
- file: src/platform/wizards/components/WizardShell/WizardShell.tsx:91
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard shell.
- score: 1
component WizardStepContent
- file: src/platform/forms/components/wizard/WizardStepContent.tsx:17
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard step content.
- score: 1
component WizardStepper
- file: src/platform/forms/components/wizard/WizardStepper.tsx:285
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard stepper.
- score: 1
component WizardVersionDiff
- file: src/platform/wizards/components/WizardVersionDiff.tsx:31
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard version diff.
- score: 1
component WizardVersionHistory
- file: src/platform/wizards/components/WizardVersionHistory.tsx:28
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard version history.
- score: 1
component WizardVersionPreview
- file: src/platform/wizards/components/WizardVersionPreview.tsx:27
- kind: component
- core: platform
- spec: (none)
- summary: Utility for wizard version preview.
- score: 1
component WorkflowCanvas
- file: src/platform/workflow/WorkflowCanvas.tsx:68
- kind: component
- core: platform
- spec: (none)
- summary: Render a configurable workflow canvas backed by ReactFlow for interactive graph visualization.Renders nodes and edges from provided initial data, manages internal state, and forwards user interactions(node/edge changes, connections, clicks) to optional callbacks. Supports a read-only mode that disablesediting and restricts allowed node changes, and exposes options for grid snapping, auto fit, minimap and controls.
- params:
- props — Component props - initialNodes: Initial array of nodes to display on the canvas - initialEdges: Initial array of edges to display on the canvas - nodeTypes: Mapping of custom node type keys to React component renderers - snapToGrid: Whether node dragging snaps to a grid (default: true) - snapGrid: Grid size used when snapping (default: [20, 20]) - fitView: Whether the view should automatically fit the graph on load (default: true) - showMiniMap: Show a MiniMap overview (default: true) - showControls: Show the standard ReactFlow controls (default: true) - readOnly: Disable interactive editing and connecting when true (default: false) - onNodesChange: Optional callback invoked with the latest nodes after user-driven changes - onEdgesChange: Optional callback invoked with the latest edges after user-driven changes - onNodeClick: Optional callback invoked when a node is clicked; receives the clicked node - onPaneClick: Optional callback invoked when the canvas background is clicked - onConnect: Optional callback invoked when a new connection is established; receives - className: Optional additional CSS classes applied to the canvas containerAccessibility considerations:- When used interactively, ensure keyboard and screen-reader access to any custom node content provided via .- In read-only mode the component disables drag/connect interactions but still exposes click events for assistive technologies.
- score: 4
component WorkOrderSummaryWidget
- file: src/platform/dashboard/widgets/WorkOrderSummaryWidget.tsx:49
- kind: component
- core: platform
- spec: (none)
- summary: Utility for work order summary widget.
- score: 1
component WorkspaceBuilderPage
- file: src/platform/navigation/workspaces/admin/WorkspaceBuilderPage.tsx:542
- kind: component
- core: platform
- spec: (none)
- summary: Route entry point for the admin workspace builder. Gates the page body behindthe permission via .
- score: 2
component WorkspaceHubPage
- file: src/platform/navigation/workspaces/WorkspaceHubPage.tsx:16
- kind: component
- core: platform
- spec: (none)
- summary: Orientation hub for a workspace lens ().The composed navigation for a workspace lives in the sidebar; this page is alightweight landing surface that names the workspace and surfaces any”needs attention” counters once those per-core sources are wired in.
- score: 2
component WorkspaceList
- file: src/platform/navigation/components/WorkspaceList.tsx:24
- kind: component
- core: platform
- spec: (none)
- summary: “Workspaces” switcher section for the all-modules sidebar view.Lists provisional role-based workspace lenses the user can jump into.Visibility is gated only on each workspace’s own top-level field (if present); per-group permission filtering happens inside theworkspace via useWorkspaceNav. Renders nothing when no workspace is visible.
- score: 2
component WorkspaceNav
- file: src/platform/navigation/components/WorkspaceNav.tsx:30
- kind: component
- core: platform
- spec: (none)
- summary: Composed cross-core nav for an active workspace lens.Renders the workspace’s permission-filtered NavSubGroups (from) using the shared primitive, plus an”Exit workspace” affordance that calls .Shown in whenever is set.
- score: 2
Functions & utilities
function __getBaselineForTests
- file: src/platform/theming/devChecks/verifyDefaultsRestored.ts:117
- kind: function
- core: platform
- spec: (none)
- summary: Test-only accessor.
- score: 1
function __resetBaselineForTests
- file: src/platform/theming/devChecks/verifyDefaultsRestored.ts:111
- kind: function
- core: platform
- spec: (none)
- summary: Test-only: forget the captured baseline so the next call re-reads . Not exported from the package barrel.
- score: 4
function _flushForTesting
- file: src/platform/gestures/utils/trackGestureEvent.ts:117
- kind: function
- core: platform
- spec: (none)
- summary: Exposed for testing — force immediate flush
- score: 4
function _getQueueLength
- file: src/platform/gestures/utils/trackGestureEvent.ts:122
- kind: function
- core: platform
- spec: (none)
- summary: Exposed for testing — get current queue length
- score: 4
function _resetAllowlistCache
- file: src/platform/ai/mcp-config.ts:55
- kind: function
- core: platform
- spec: (none)
- summary: Reset the cached allowlist for tests that mutate .
- score: 4
function _resetForTesting
- file: src/platform/gestures/utils/trackGestureEvent.ts:127
- kind: function
- core: platform
- spec: (none)
- summary: Cleanup for testing
- score: 1
function _resetPrefetchRegistry
- file: src/platform/routing/prefetch/registry.ts:89
- kind: function
- core: platform
- spec: (none)
- summary: Test-only: drop all registered prefetchers.
- score: 4
function activateEntraProvisioning
- file: src/platform/integrations/hooks/useEntraSetup.ts:151
- kind: function
- core: platform
- spec: (none)
- summary: Step 4: enable provisioning for the org (mirrors the flat card’s enable toggle).
- score: 4
function activateSsoProvider
- file: src/platform/auth/sso/useSsoSetup.ts:110
- kind: function
- core: platform
- spec: (none)
- summary: Step 4: register the SAML provider with Supabase Auth and activate it.
- score: 4
function addBusinessDays
- file: src/platform/calendar/lib/business-day-utils.ts:76
- kind: function
- core: platform
- spec: (none)
- summary: Adds N business days to a date, skipping non-working days and holidays.
- params:
- date — Starting date.
- days — Number of business days to add (must be = 0).
- businessHours — Business hours configuration map.
- holidays — List of calendar holidays.
- returns: The resulting date after adding business days.
- score: 4
function addConditionToGroup
- file: src/platform/conditional-logic/builder/utils.ts:266
- kind: function
- core: platform
- spec: (none)
- summary: Add a condition to a group
- score: 1
function addCustomTab
- file: src/platform/telephony/lib/embeddable-tabs.ts:120
- kind: function
- core: platform
- spec: (none)
- summary: Add a custom tab to the widget.The tab will be registered and content set.
- score: 4
function addGroupToGroup
- file: src/platform/conditional-logic/builder/utils.ts:290
- kind: function
- core: platform
- spec: (none)
- summary: Add a nested group
- score: 1
function addThreadAgent
- file: src/platform/cowork/threadsService.ts:44
- kind: function
- core: platform
- spec: (none)
- summary: Register an agent as an attributed thread participant. The RPC resolves the agent’sPF-30-EN-01 scoped principal, asserts same-org, and requires a LIVE pf.cowork.participatedelegation (via pf_agent_can) plus that currently holds pf.cowork.participate.Returns the new pf_thread_agents id.
- score: 4
function AgentMessageBadge
- file: src/platform/cowork/components/AgentMessageBadge.tsx:44
- kind: function
- core: platform
- spec: (none)
- summary: Agent participation badge (PF-124 Phase 2). Compact form: the agent name in the mode-aware / pair (UX-9 semantic tokens — never ).
- score: 4
function aggregatePatterns
- file: src/platform/query-performance/hooks/useQueryPatterns.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Aggregate query logs by fingerprint into pattern summaries.
- params:
- logs — Raw log rows
- returns: Sorted array of QueryPatternSummary (by total time descending)
- score: 4
function AIAssistantInline
- file: src/platform/ai/widgets/AIAssistantInline.tsx:25
- kind: function
- core: platform
- spec: (none)
- summary: Utility for aiassistant inline.
- score: 1
function aiToUIMessage
- file: src/platform/ai/utils/messageConversion.ts:36
- kind: function
- core: platform
- spec: (none)
- summary: Maps an to a with a single text part and metadata for timestamp round-trip.
- score: 4
function applyBillingOverrides
- file: src/platform/clinical/billing/applyBillingOverrides.ts:22
- kind: function
- core: platform
- spec: (none)
- summary: Applies billing overrides to a single suggestion.
- params:
- suggestion — The base billing suggestion (or null)
- overrides — The aggregated override config for the current payer/org
- returns: The modified suggestion, or null if suppressed
- score: 4
function applyClientFilters
- file: src/platform/table-v2/utils/filter/client.ts:35
- kind: function
- core: platform
- spec: (none)
- summary: Apply multiple filter predicates to an in-memory array.All predicates must pass (AND logic).
- params:
- items — Array of items to filter
- filters — Array of filter predicates
- returns: Filtered array
- example: | const users = [ name: ‘John’, age: 30 , name: ‘Jane’, age: 25 ];const filters = [ predicate: (u) = u.age 20 , predicate: (u) = u.name.startsWith(‘J’) ,];const result = applyClientFilters(users, filters);// [ name: ‘John’, age: 30 , name: ‘Jane’, age: 25 ]
- score: 4
function applyComplementarySuppression
- file: src/platform/analytics/complementary-suppression.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: Apply primary + complementary small-cell suppression to a 2-D count table.
- score: 4
function applyCompositeMeasures
- file: src/platform/analytics/serving/composite.ts:100
- kind: function
- core: platform
- spec: (none)
- summary: Combine the plan’s measures over (already grouped by ).Returns flat rows, each carrying the row-dimension key, every measure value (or null whensuppressed), and a field for derived measures.
- score: 4
function applyConditionalLogic
- file: src/platform/forms/validationV2.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: Filter and transform fields based on conditional logic
- params:
- fields — All form fields
- formData — Current form data
- returns: Visible fields with updated required/readonly status
- score: 4
function applyFilterGroup
- file: src/platform/table-v2/utils/filter/client.ts:182
- kind: function
- core: platform
- spec: (none)
- summary: Apply a FilterGroup to an in-memory array.Supports the same filter structure as applyFilters for Supabase.
- params:
- items — Array of items to filter
- filterGroup — Filter group to apply
- returns: Filtered array
- example: | const filters: FilterGroup = operator: ‘AND’, filters: [ field: ‘status’, operator: ‘equals’, value: ‘active’ , field: ‘age’, operator: ‘gte’, value: 21 , ],;const result = applyFilterGroup(users, filters);
- score: 4
function applyFilters
- file: src/platform/table-v2/utils/filter/builder.ts:187
- kind: function
- core: platform
- spec: (none)
- summary: Apply filters to a Supabase query builder.
- params:
- builder — Supabase PostgrestFilterBuilder
- filterGroup — Filter group containing filters and logical operator
- options — Optional configuration
- returns: Modified query builder
- example: | const filters: FilterGroup = operator: ‘AND’, filters: [ field: ‘status’, operator: ‘equals’, value: ‘active’ , field: ‘name’, operator: ‘contains’, value: ‘john’ , ],;const query = supabase.from(‘users’).select(’*’);const filteredQuery = applyFilters(query, filters);
- score: 4
function applyFullHpExamGate
- file: src/platform/clinical/blocks/ros-exam/full-hp-gate.ts:58
- kind: function
- core: platform
- spec: (none)
- summary: Apply the TJC full-H&P gate to a resolved surface (pure).When the TJC overlay is active AND the encounter meets ,the block is marked required (source), being appended if the surface did not already compose it.In every other case — CARF-only, no overlay, or condition unmet — theresolution is returned unchanged, so the exam block keeps whatever advisory() composition it had.
- params:
- resolved — the CL-75 resolved surface to gate.
- context — the org/encounter overlay context.
- returns: a new resolved surface (never mutates the input).
- score: 4
function applyPiiPhiFilter
- file: src/platform/export/utils/filterPiiPhi.ts:54
- kind: function
- core: platform
- spec: (none)
- summary: Apply PII/PHI filter to a single row based on entity config.
- params:
- row — Data row (will NOT be mutated; returns a new object)
- config — Field-level filter configuration for this entity type
- returns: Filtered copy of the row
- score: 4
function applyPrimarySuppressionWithThreshold
- file: src/platform/analytics/suppression.ts:50
- kind: function
- core: platform
- spec: (none)
- summary: Mask a single grouped count against a minimum-cell-size threshold.Suppresses when is below (strict ), or is negative / non-finite.A suppressed result carries (the count is dropped, not rounded) and a display token (the standard HIPAA small-cell presentation for a singlevalue). A visible result truncates to an integer.
- params:
- count — the raw group population.
- threshold — minimum cell size; defaults to the CL-35 parity value (5). PF-123 passes the PF-96-resolved value (federal baseline ).
- score: 4
function applyRailOrder
- file: src/platform/navigation/utils/apply-rail-order.ts:18
- kind: function
- core: platform
- spec: (none)
- summary: Partition accessible modules into pinned (in order) + unpinned(in , with any not-yet-ordered ids appended in their accessible order).Ids in prefs that are NOT in (lost access) are dropped silently.
- score: 4
function applyServingSuppression
- file: src/platform/analytics/serving/mart-suppression.ts:81
- kind: function
- core: platform
- spec: (none)
- summary: Reshape grouped mart rows into a count matrix, apply primary + complementary suppressionat the resolved minimum cell size, and return labeled masked cells.
- score: 4
function applySorting
- file: src/platform/table-v2/utils/sort/config.ts:102
- kind: function
- core: platform
- spec: (none)
- summary: Apply sorting to a Supabase query builderSupports single field sorting or multi-field sorting with priority.First field in the array has highest priority.
- params:
- builder — Supabase query builder
- sortInput — Sort configuration (single or multi-field)
- options — Optional configuration
- returns: Modified query builder
- example: | // Single field sortconst query = applySorting( supabase.from(‘users’).select(''), field: ‘created_at’, direction: ‘desc’ ); // Multi-field sortconst query = applySorting( supabase.from(‘users’).select(''), sorts: [ field: ‘status’, direction: ‘asc’ , field: ‘created_at’, direction: ‘desc’ ] );
- score: 4
function applyTransform
- file: src/platform/import/mapping/applyTransforms.ts:46
- kind: function
- core: platform
- spec: (none)
- summary: Apply a transform to a single cell value.
- score: 4
function applyTransformsToRows
- file: src/platform/import/mapping/applyTransforms.ts:86
- kind: function
- core: platform
- spec: (none)
- summary: Apply transforms to all rows for mapped fields.
- score: 4
function applyWidgetOrder
- file: src/platform/dashboard/utils/widget-preferences.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Apply a new visible-widget order while preserving hidden widgets and metadata.
- score: 4
function approveAgentAction
- file: src/platform/ai/agentic/intake-write-rpc-adapters.ts:115
- kind: function
- core: platform
- spec: (none)
- summary: PF-126 approve wrapper (test/UI only — staff path). Returns the single-use grant token ONCE.
- score: 4
function approveConnector
- file: src/platform/analytics/hooks/useAnalyticsConnectors.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Calls the perm-gated SECURITY DEFINER RPC.Records server-side — never auto-approved.
- score: 4
function archiveAgent
- file: src/platform/cowork/agentsService.ts:87
- kind: function
- core: platform
- spec: (none)
- summary: Soft-archive an agent (status → ‘archived’). RLS scopes the row to the caller’s org.
- score: 4
function asamLocRowToFormValues
- file: src/platform/clinical/blocks/asam-loc-adapter.ts:129
- kind: function
- core: platform
- spec: (none)
- summary: Map a persisted cl_loc_assessments row back to the block’s form values.
- score: 4
function assembleArtifactPromptContext
- file: src/platform/ai/agentic/artifact-prompt-context.ts:110
- kind: function
- core: platform
- spec: (none)
- summary: Assemble prompt-safe context from one or more PF-128 artifact versions. EVERY version must pass; the FIRST failure throws andblocks the whole assembly (fail-closed) — so a single poisoned/unscreened artifact prevents thedownstream prompt from being built at all. Returns the joined prompt-safe text.
- score: 4
function assessmentRowToFormValues
- file: src/platform/clinical/blocks/suicide/suicide-assessment-adapter.ts:95
- kind: function
- core: platform
- spec: (none)
- summary: Map a persisted assessment row back to the block’s form values.
- score: 4
function assignGoogleLicense
- file: src/platform/integrations/google-workspace.ts:142
- kind: function
- core: platform
- spec: (none)
- summary: Assigns a Google Workspace product/SKU license through the PF-101 license edge function.
- score: 4
function assignPageToField
- file: src/platform/forms/utils/sectionPageMapping.ts:59
- kind: function
- core: platform
- spec: (none)
- summary: Assign a page ID to a field configuration based on section
- score: 4
function auditAllWizards
- file: src/platform/wizards/audit/orchestrator.ts:50
- kind: function
- core: platform
- spec: (none)
- summary: Run all static checks across the registry (template from migrations, columns/enums from types.ts). Throws nothing — source errors become findings.
- score: 4
function auditAllWizardsLive
- file: src/platform/wizards/audit/orchestrator.ts:132
- kind: function
- core: platform
- spec: (none)
- summary: Live-lane audit: runs the same checks as the static lane but sourced from therunning stack (authoritative), and additionally emits migration↔live-DB findings. Async; callers obtain a from .
- score: 4
function auditMcpRejections
- file: src/platform/ai/mcp-rejection-audit.ts:66
- kind: function
- core: platform
- spec: PF-127
- summary: Write a denied/not_allowlisted row for each rejected MCP server.Returns the count successfully written. FAIL-SOFT: an individual audit error (returned orthrown) is swallowed so a logging failure never breaks the agent run.
- score: 5
function auditValueCoverage
- file: src/platform/import/mapping/auditValueCoverage.ts:51
- kind: function
- core: platform
- spec: (none)
- summary: Audit how completely a set of source values maps onto the resolved targets.Contract:- Empty / whitespace-only source values are ignored.- Source values are de-duplicated; a value appearing N times counts once.- Each distinct value is classified via ; counts as mapped, anything else () is unmapped.- is the number of distinct values that matched.- lists the distinct misses in original casing, stable first-seen order.- is , or when there are no distinct source values (nothing to map ⇒ full coverage).- is for (fail-open default), and for only when there are zero unmapped values (100% coverage).
- params:
- sourceValues — Raw values observed in an import column (may contain dups / blanks).
- targets — Resolved target options (value + label + optional aliases).
- strictness — The binding’s enforcement policy.
- returns: A summarising mapped/unmapped coverage.
- score: 4
function autoMapColumns
- file: src/platform/data-manager/utils/csvUtils.ts:92
- kind: function
- core: platform
- spec: (none)
- summary: Auto-detect column mappings based on header similarity
- score: 4
function autoMapRawDataColumns
- file: src/platform/data-manager/utils/rawDataImportUtils.ts:24
- kind: function
- core: platform
- spec: (none)
- summary: Auto-detect column mappings based on header similarity
- score: 4
function boolToCoded
- file: src/platform/clinical/blocks/suicide/mapping.ts:21
- kind: function
- core: platform
- spec: (none)
- summary: Coerce a boolean column back to its code.
- score: 4
function buildAmendmentRow
- file: src/platform/clinical/plan/record-amendment.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Build the sanitized cl_treatment_plan_amendments insert row (amended_by → DB default auth.uid()).
- score: 4
function buildAsamDimensionScores
- file: src/platform/clinical/blocks/asam-loc-adapter.ts:98
- kind: function
- core: platform
- spec: (none)
- summary: Build the CL-49 JSONB from the block’s flat rating/notesfields. Dimensions without a valid 0–4 rating are omitted entirely (a notewithout a rating has no home in ).
- score: 4
function buildAsamLocRow
- file: src/platform/clinical/blocks/asam-loc-adapter.ts:154
- kind: function
- core: platform
- spec: (none)
- summary: Build a sanitized cl_loc_assessments row: tenant/chart from resolved context,dimension scores composed from flat fields, block linkage in custom_fields(merged over any existing custom_fields so foreign keys other writers putthere survive).
- score: 4
function buildAssessmentRow
- file: src/platform/clinical/blocks/suicide/suicide-assessment-adapter.ts:70
- kind: function
- core: platform
- spec: (none)
- summary: Build the sanitized cl_risk_screenings upsert row for an assessment instance.
- score: 4
function buildCategorizePrompt
- file: src/platform/ai/utils/aiPromptBuilder.ts:122
- kind: function
- core: platform
- spec: (none)
- summary: Build a categorization prompt
- score: 1
function buildChannelName
- file: src/platform/realtime/utils/channelNaming.ts:41
- kind: function
- core: platform
- spec: (none)
- summary: Build a deterministic channel name.
- params:
- type — | |
- resource — Table name (db) or logical channel name (broadcast/presence)
- discriminator — Optional filter string or extra key to distinguish channels on the same resource but with different filters.
- orgId — Optional organization ID. When provided for or channels, the name is prefixed with to enforce tenant isolation at the topic level. Ignored for channels.
- returns: A stable string suitable as a Supabase channel name.
- score: 4
function buildCompletenessAlert
- file: src/platform/clinical/completeness/completenessAlert.ts:48
- kind: function
- core: platform
- spec: (none)
- summary: Shape a PHI-free alert payload from a completeness result.
- params:
- result — the computed surface completeness.
- ctx — the encounter reference the alert is about.
- returns: a payload containing only allow-listed non-PHI fields.
- score: 4
function buildConfirmedSkillOverrides
- file: src/platform/ai/lib/onboarding-logic.ts:100
- kind: function
- core: platform
- spec: (none)
- summary: Map an admin’s confirmed selection to the override rows to upsert.Recommend-and-confirm contract (AC-5 / AC-6): - Only codes present in BOTH the recommended set and the confirmed set yield a row (a confirmed code that isn’t a current recommendation is ignored — the wizard only enables what it actually recommended). - Each row is , org-scoped, keyed by the catalog . - Zero confirmed codes ⇒ zero rows (a valid, explicit “enable nothing” choice). - The result NEVER contains an key/column — module defaults remain the MODULE_DEFAULT_SKILLS TS constant (out of scope for v1).
- score: 4
function buildContactTabContent
- file: src/platform/telephony/lib/embeddable-tabs.ts:272
- kind: function
- core: platform
- spec: (none)
- summary: Build HTML content for contact info tab
- score: 4
function buildDischargeSummaryRow
- file: src/platform/clinical/blocks/discharge/discharge-summary-adapter.ts:111
- kind: function
- core: platform
- spec: (none)
- summary: Build the sanitized column row for a discharge summary:tenant/chart/encounter/version injected from context, unknown keys dropped, omitted (partial-update semantics on the update path).
- score: 4
function buildDockModules
- file: src/platform/navigation/dock-modules.ts:165
- kind: function
- core: platform
- spec: (none)
- summary: Build dock modules from the loaded registry snapshot (may grow as chunks load).
- score: 4
function builderStateToRule
- file: src/platform/conditional-logic/builder/utils.ts:115
- kind: function
- core: platform
- spec: (none)
- summary: Convert ConditionBuilderState to ConditionalRuleV2
- score: 4
function buildExamFindingRow
- file: src/platform/clinical/blocks/exam-adapter.ts:39
- kind: function
- core: platform
- spec: (none)
- summary: Build a sanitized exam-finding row: tenant/encounter/version from context, unknown columns dropped, undefined omitted.
- score: 4
function buildILikeOrConditions
- file: src/platform/search/utils.ts:87
- kind: function
- core: platform
- spec: (none)
- summary: Build ILIKE OR conditions for multi-field search.
- params:
- fields — Array of field names to search
- escapedQuery — The escaped search query
- returns: Supabase OR filter string
- example: | buildILikeOrConditions([‘name’, ‘email’], ‘john’)// Returns ‘name.ilike.%john%,email.ilike.%john%’
- score: 4
function buildImportStoragePath
- file: src/platform/import/storage.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Build a tenant-scoped storage path for an import file.
- example: | buildImportStoragePath(‘org-uuid’, ‘batch-uuid’, ‘employees.csv’)// → ‘imports/org-uuid/batch-uuid/employees.csv’
- score: 4
function buildLegacyLabelPreferenceKeyMap
- file: src/platform/navigation/quick-action-catalog.ts:135
- kind: function
- core: platform
- spec: (none)
- summary: Builds a lookup from legacy dashboard preference id () to action_key.
- score: 4
function buildLoadingContent
- file: src/platform/telephony/lib/embeddable-tabs.ts:344
- kind: function
- core: platform
- spec: (none)
- summary: Build loading state content
- score: 1
function buildMcpRejectionLog
- file: src/platform/ai/mcp-rejection-audit.ts:45
- kind: function
- core: platform
- spec: PF-127
- summary: Build the params for one rejected MCP server (keys + decision only — PHI-free).
- score: 5
function buildMedicationRow
- file: src/platform/clinical/blocks/meds/med-list-adapter.ts:82
- kind: function
- core: platform
- spec: (none)
- summary: Build a sanitized cl_medications insert row for a NEW block-added entry:tenant/chart/encounter/version stamped from context, defaulting to’reported’ and to ‘active’ (CHECK-safe defaults, spec Assumption 3).
- score: 4
function buildMetabolicEntryRow
- file: src/platform/clinical/blocks/metabolic-adapter.ts:59
- kind: function
- core: platform
- spec: (none)
- summary: Build a sanitized panel-entry row: tenant/chart/encounter/version keys come fromcontext (a client cannot spoof them), NOT NULL floors at ‘due’, NOT NULL floors at (a PostgREST multi-row insert null-fills keys theother rows carry, so it must always be present), and empty-string timestamps arenullified (never to a timestamptz column).
- score: 4
function buildModuleOverridesPayload
- file: src/platform/provisioning/lib/moduleOverridesForm.ts:156
- kind: function
- core: platform
- spec: (none)
- summary: Build the flat payload as a diff against the template defaults: - carries only modules whose checkbox differs from the template (explicit when unchecked, when re-checked); unchanged modules are omitted. - Each scalar key is included only when it is a valid in-range number that differs from the template default; blank/out-of-range/unchanged values are omitted.Returns when nothing was customized, so the caller sends no override at alland provisioning uses pure template defaults.
- score: 4
function buildModuleRoute
- file: src/platform/navigation/utils/navigation-utils.ts:83
- kind: function
- core: platform
- spec: (none)
- summary: Build a module route with optional sub-route
- score: 4
function buildMseUpsertRow
- file: src/platform/clinical/blocks/mse-adapter.ts:108
- kind: function
- core: platform
- spec: (none)
- summary: Build the sanitized upsert row for an MSE instance: tenant/encounter/version keyscome from context (a client cannot spoof them), unknown columns are dropped, and fields are omitted so an upsert never nulls existing values.
- score: 4
function buildNavGroupPageEntries
- file: src/platform/navigation/search-catalog.ts:81
- kind: function
- core: platform
- spec: (none)
- summary: Build page entries from ALL nav groups on accessible modules.Covers both regular nav groups ( absent/false) and sub-modulegroups (), replacing the previous split that only indexedsub-module items and omitted everything in regular nav groups (e.g. Finance’s”General Ledger”, “Accounts Receivable”, “Reports & Analytics” sections).- Group-level gates the entire group.- Item-level gates individual items within the group.- Items are deduplicated per-module by route to avoid double-entries where the same route appears in both and a navGroup.
- params:
- modules — Accessible module definitions from .
- userPermissions — All permissions held by the current user.
- score: 4
function buildNoMatchContent
- file: src/platform/telephony/lib/embeddable-tabs.ts:355
- kind: function
- core: platform
- spec: (none)
- summary: Build empty/no match state content
- score: 4
function buildPartnerTabContent
- file: src/platform/telephony/lib/embeddable-tabs.ts:315
- kind: function
- core: platform
- spec: (none)
- summary: Build HTML content for partner info tab
- score: 4
function buildPayrollForms
- file: src/platform/onboarding/integrations/payrollIntegration.ts:57
- kind: function
- core: platform
- spec: (none)
- summary: Build the list of payroll forms with completion status
- score: 4
function buildProcessDiscoveredPayload
- file: src/platform/events/publishers/processHealthPublisher.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: Creates a event payload.
- params:
- params — The discovery parameters.
- returns: A typed event payload ready for publishing.
- score: 1
function buildProcessHealthChangedPayload
- file: src/platform/events/publishers/processHealthPublisher.ts:48
- kind: function
- core: platform
- spec: (none)
- summary: Creates a event payload.
- params:
- params — The health change parameters.
- returns: A typed event payload ready for publishing.
- score: 1
function buildPrompt
- file: src/platform/ai/utils/aiPromptBuilder.ts:53
- kind: function
- core: platform
- spec: (none)
- summary: Build a structured prompt from configuration
- score: 4
function buildQuickActionsPool
- file: src/platform/dashboard/lib/quickActionsPool.ts:116
- kind: function
- core: platform
- spec: (none)
- summary: Returns every quick action the user may customize or see, merged with preferences.
- score: 4
function buildRecommendationBody
- file: src/platform/ai/agentic/intake-artifact.ts:29
- kind: function
- core: platform
- spec: (none)
- summary: Render the recommendation + proposed appointment as markdown (the artifact body).
- score: 4
function buildReconciliationRow
- file: src/platform/clinical/blocks/meds/med-reconciliation-adapter.ts:69
- kind: function
- core: platform
- spec: (none)
- summary: Build the sanitized cl_medication_reconciliations row (tenant keys from context).
- score: 4
function buildRegistry
- file: src/platform/analytics/semantic-compiler.ts:94
- kind: function
- core: platform
- spec: (none)
- summary: Build a from a list of definitions (e.g. pf_analytics_semantic_models rows).
- score: 4
function buildRosEntryRow
- file: src/platform/clinical/blocks/ros-adapter.ts:68
- kind: function
- core: platform
- spec: (none)
- summary: Build a sanitized ROS row: tenant/encounter/version from context, unknown columns dropped, undefined omitted.
- score: 4
function buildSafetyPlanRow
- file: src/platform/clinical/blocks/suicide/safety-plan-adapter.ts:49
- kind: function
- core: platform
- spec: (none)
- summary: Build the cl_safety_plans column row for a safety plan (Stanley-Brown six + attestation).
- score: 4
function buildScreenRow
- file: src/platform/clinical/blocks/suicide/suicide-screen-adapter.ts:51
- kind: function
- core: platform
- spec: (none)
- summary: Build the sanitized cl_risk_screenings upsert row for a screen instance (tenant keys from context).
- score: 4
function buildSdohScreeningRow
- file: src/platform/clinical/blocks/sdoh-adapter.ts:73
- kind: function
- core: platform
- spec: (none)
- summary: Build the sanitized cl_sdoh_screenings upsert row for a screening instance (tenant keys from context).
- score: 4
function buildSLANotificationPayload
- file: src/platform/sla/services/sla-notifications.ts:30
- kind: function
- core: platform
- spec: (none)
- summary: Builds a notification payload from an SLA instance.Ensures no PHI is included — IDs only.
- score: 4
function buildSuggestPrompt
- file: src/platform/ai/utils/aiPromptBuilder.ts:141
- kind: function
- core: platform
- spec: (none)
- summary: Build a suggestion prompt
- score: 1
function buildSummarizePrompt
- file: src/platform/ai/utils/aiPromptBuilder.ts:93
- kind: function
- core: platform
- spec: (none)
- summary: Build a summarization prompt
- score: 1
function buildSystemPrompt
- file: src/platform/ai/utils/aiPromptBuilder.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Build a system prompt based on module context
- score: 4
function buildVitalSignsRow
- file: src/platform/clinical/blocks/vitals-adapter.ts:78
- kind: function
- core: platform
- spec: (none)
- summary: Build the sanitized cl_vital_signs upsert row: tenant/chart/encounter/versionkeys come from context (a client cannot spoof them), numeric axes are coerced, fields are omitted so an upsert never nulls existing values, andNOT NULL defaults to now.
- score: 4
function buildWizardCreateSpecs
- file: src/platform/wizards/audit/wizard-create-specs-bridge.ts:19
- kind: function
- core: platform
- spec: (none)
- summary: Build the spec→wizard bridge consumed by tools/eos-spec (a separate workspacethat cannot import src/). Keyed by upper-cased specId; includes every registryentry that declares a . The committed JSON(docs/reports/wizard-create-specs.json) is generated from this by and drift-guarded by a unit test (Task 3).
- score: 4
function buildWizardGenerationPrompt
- file: src/platform/wizards/ai/prompts.ts:65
- kind: function
- core: platform
- spec: (none)
- summary: Build a user prompt for wizard generation
- score: 4
function buildWizardModificationPrompt
- file: src/platform/wizards/ai/prompts.ts:80
- kind: function
- core: platform
- spec: (none)
- summary: Build a user prompt for modifying an existing wizard
- score: 4
function calculateEnrollmentDeadline
- file: src/platform/onboarding/integrations/benefitsIntegration.ts:41
- kind: function
- core: platform
- spec: (none)
- summary: Calculate enrollment deadline from hire date
- score: 4
function calculateGlobalUnreadCount
- file: src/platform/messaging/utils/unreadCalculator.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Calculate total unread count across all conversations
- score: 4
function calculateImpactGraphLayout
- file: src/platform/automation/components/impact-graph/impactGraphLayout.ts:23
- kind: function
- core: platform
- spec: (none)
- summary: Calculate layout for the process impact graph.Process at top center, rules below-left, workflows below-right.
- score: 4
function calculateMilestoneDates
- file: src/platform/onboarding/integrations/milestonePresets.ts:244
- kind: function
- core: platform
- spec: (none)
- summary: Calculate milestone due dates from start date
- score: 4
function calculateNextRetry
- file: src/platform/notifications/utils/retry.ts:34
- kind: function
- core: platform
- spec: (none)
- summary: Calculates the next retry time based on the current attempt number.
- params:
- attemptNumber — Current attempt number (0-based)
- returns: Next retry Date, or null if max retries exceeded
- score: 4
function calculatePagination
- file: src/platform/table-v2/utils/pagination/utils.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Calculate pagination metadata from configurationHandles edge cases:- Page 0 or negative → normalized to 1- Page beyond total → clamped to last page- Empty results (total=0) → from=0, to=0, totalPages=1- pageSize 0 or negative → normalized to 1
- params:
- config — Pagination configuration
- returns: Pagination result with offset, limit, and metadata
- score: 4
function calculateRange
- file: src/platform/table-v2/utils/pagination/utils.ts:97
- kind: function
- core: platform
- spec: (none)
- summary: Calculate the range parameters for Supabase .range() methodSupabase uses inclusive start and end indexes (0-indexed)
- params:
- config — Pagination configuration
- returns: Tuple of [start, end] for Supabase .range()
- score: 4
function calculateReorderItems
- file: src/platform/page-layouts/utils.ts:155
- kind: function
- core: platform
- spec: (none)
- summary: Calculate new display_order values after reorderingReturns items with updated display_order based on new position
- score: 4
function calculateResizeDimensions
- file: src/platform/upload/image-utils.ts:171
- kind: function
- core: platform
- spec: (none)
- summary: Calculate new dimensions maintaining aspect ratio.
- score: 4
function cancelAgentRun
- file: src/platform/agents/runsService.ts:63
- kind: function
- core: platform
- spec: (none)
- summary: Operator cancel: advance a non-terminal run to via the governed RPC.The RPC re-validates the transition graph and the caller’s permission server-side; this wrapper never writes lifecycle_state directly.
- score: 4
function canEditField
- file: src/platform/field-config/utils.ts:26
- kind: function
- core: platform
- spec: (none)
- summary: Check if user role can edit field
- score: 4
function canReceivePushNotifications
- file: src/platform/pwa/utils/platformDetection.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Check if the current platform/context can receive push notifications.
- score: 4
function canViewField
- file: src/platform/field-config/utils.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Check if user role can view field
- score: 4
function canViewLayoutField
- file: src/platform/page-layouts/utils/visibilityUtils.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Check if a field is visible to the current user based on their role.Logic:- If visibility_roles is empty/null → visible to all- If visibility_roles has values → user role must be in array- If userRole is null → show all fields (unauthenticated fallback)
- score: 4
function captureBaselineFallbacks
- file: src/platform/theming/devChecks/verifyDefaultsRestored.ts:96
- kind: function
- core: platform
- spec: (none)
- summary: Capture the platform fallback resolved value for every entry. Must be called once at app start, BEFORE any tenant theme has beenapplied — once an override is in place, returns theoverridden value and the platform fallback is unrecoverable.Idempotent: subsequent calls are no-ops.
- score: 4
function checkEntraConsent
- file: src/platform/integrations/hooks/useEntraSetup.ts:97
- kind: function
- core: platform
- spec: (none)
- summary: Step 2 gate: poll admin-consent status. Reads entra_consent_granted_at via theorg_admin-gated RPC (set by the entra-oauth callback once consent completes).
- score: 4
function checkEnumOptions
- file: src/platform/wizards/audit/checks.ts:119
- kind: function
- core: platform
- spec: (none)
- summary: Check 2: every template option must be a member of the target column’sDB enum. Keyed on field == column name (the common convention; the livelane is the authoritative cross-check for any mapper-renamed field). Fields whosename is not an enum column on the target table are skipped — no false positives.
- score: 4
function checkFieldCoverage
- file: src/platform/wizards/audit/checks.ts:16
- kind: function
- core: platform
- spec: (none)
- summary: Check 1: template fields must be accepted by the schema; schema-required fields must be in the template.
- score: 4
function checkMapperSink
- file: src/platform/wizards/audit/checks.ts:89
- kind: function
- core: platform
- spec: (none)
- summary: Check 4: every key the mapper emits must be a real column on the target table.
- score: 4
function checkMicrophonePermission
- file: src/platform/telephony/lib/embeddable-utils.ts:192
- kind: function
- core: platform
- spec: (none)
- summary: Check current microphone permission stateReturns null if permission API not available
- score: 4
function checkNotNullCoverage
- file: src/platform/wizards/audit/checks.ts:62
- kind: function
- core: platform
- spec: (none)
- summary: Check 3: every NOT-NULL-no-default column must be template-required or mapper-defaulted.
- score: 4
function checkOrgSudEmbedAuthorization
- file: src/platform/clinical/consent/checkOrgSudEmbedAuthorization.ts:36
- kind: function
- core: platform
- spec: (none)
- summary: Resolve whether an organization holds a standing Part-2-embed authorization.Fail-closed: returns on any error or missing config. Delegates to the SECURITY DEFINER resolver so the same fail-closedread backs both this app surface and the serving RPC.
- params:
- organizationId — the org to check.
- client — Supabase client (defaults to the app singleton); injectable for tests.
- score: 4
function classifyAIUnavailability
- file: src/platform/ai/lib/aiDegradation.ts:86
- kind: function
- core: platform
- spec: (none)
- summary: Classify an AI error and decide the appropriate degradation mode.This is the single decision point for all client-side AI degradation.Callers pass the error from their AI hook; they receive back a telling them which UX path to show.Rules (evaluated in order):1. → (AI was never attempted / state not initialised).2. → with from the error.3. → (gateway down, try again later).4. → (client connectivity issue).5. → (response corrupt; retry unlikely to help).6. → (admin action required, not a user retry).7. → (PHI guard; never surface AI output).8. Unknown / raw Error → (safe default).
- params:
- error — The AIError from a hook, a raw Error, or null.
- returns: A the caller should act on.
- score: 4
function classifyDistinctValues
- file: src/platform/import/mapping/valueMatching.ts:178
- kind: function
- core: platform
- spec: (none)
- summary: Classify all distinct values for a source column against the target options.
- params:
- distinctValues — Map of for a source column.
- options — Resolved target options with optional aliases.
- returns: An array of , one per distinct value.
- score: 4
function classifySkillRouting
- file: src/platform/ai/wizards/ai-skill-creation/routing.ts:30
- kind: function
- core: platform
- spec: (none)
- summary: Classify a skill category into its Step-5 governance route (AC-5).Note: enforces the same routing server-side (and additionallyforces to regardless of category). This clientclassifier only drives the primary-action label / confirmation copy.
- params:
- category — The skill’s category.
- returns: for regulated categories, else .
- score: 4
function classifyValue
- file: src/platform/import/mapping/valueMatching.ts:87
- kind: function
- core: platform
- spec: (none)
- summary: Classify a single distinct incoming value against the resolved target options.
- params:
- incomingValue — The raw string value found in the import file.
- rowCount — How many rows contain this value.
- options — Resolved target options (value + label + optional aliases).
- returns: A describing whether the value matched and how.
- score: 4
function clear
- file: src/platform/cache/store.ts:48
- kind: function
- core: platform
- spec: (none)
- summary: Prefix match: remove all keys that start with pattern.
- score: 4
function clearAllRegisteredCaches
- file: src/platform/cache/registry.ts:23
- kind: function
- core: platform
- spec: (none)
- summary: Invoke all registered cache-clear handlers (best-effort, failures swallowed).
- score: 4
function clearAllTabs
- file: src/platform/telephony/lib/embeddable-tabs.ts:238
- kind: function
- core: platform
- spec: (none)
- summary: Remove all custom tabs and reset service registration
- score: 4
function clearBiometricCredential
- file: src/platform/auth/app-lock/biometric-utils.ts:168
- kind: function
- core: platform
- spec: (none)
- summary: Clear the stored biometric credential.
- score: 4
function clearClientCachesOnSignOut
- file: src/platform/auth/clearClientCachesOnSignOut.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Best-effort cache wipe; failures are swallowed (sign-out must still proceed).
- score: 4
function clearInstanceId
- file: src/platform/wizards/utils/trackWizardEvent.ts:60
- kind: function
- core: platform
- spec: (none)
- summary: Clear the current instance ID (on wizard completion or cancel)
- score: 4
function clearOrganizationSetupDraft
- file: src/platform/setup/hooks/organizationSetupUtils.ts:103
- kind: function
- core: platform
- spec: (none)
- summary: Clear draft (e.g. after completion or cancel).
- score: 4
function clearQueryCache
- file: src/platform/offline/queryPersistence.ts:313
- kind: function
- core: platform
- spec: (none)
- summary: Clear all persisted query data (localforage clear + dropInstance).Best-effort: errors are ignored so sign-out always proceeds; generation guard prevents stale async reloads.
- score: 4
function clearSchemaCache
- file: src/platform/forms/validation.ts:76
- kind: function
- core: platform
- spec: (none)
- summary: Clear the schema cache (useful for testing or memory management)
- score: 4
function clearSentryUser
- file: src/platform/monitoring/sentry-context.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Clear Sentry user context on logout. Also clears tenant tags.
- score: 4
function clearStoredPin
- file: src/platform/auth/app-lock/pin-utils.ts:117
- kind: function
- core: platform
- spec: (none)
- summary: Remove the stored PIN data from sessionStorage.
- score: 4
function clearStoredSessions
- file: src/platform/analytics/sessionRecorder.ts:481
- kind: function
- core: platform
- spec: (none)
- summary: Clear stored sessions
- score: 1
function clearTenantInlineStyles
- file: src/platform/theming/utils/tenantInlineStyles.ts:8
- kind: function
- core: platform
- spec: (none)
- summary: Remove every inline tenant override written by theming flows from .Exposed for both the provider lifecycle cleanup and synchronous reset flows.
- score: 4
function clearUserCache
- file: src/platform/auth/useCurrentUser.ts:130
- kind: function
- core: platform
- spec: (none)
- summary: Utility for clear user cache.
- score: 1
function clearValidationCache
- file: src/platform/events/eventPayloadValidation.ts:187
- kind: function
- core: platform
- spec: (none)
- summary: Clear the compiled schema cache. Useful for testing.
- score: 4
variable clearWidgetCache
- file: src/platform/dashboard/utils/widgetCache.ts:131
- kind: variable
- core: platform
- spec: (none)
- summary: Clear widget cache - specific widget or all for an organizationorganizationId is required when clearing specific widgets
- score: 2
function cloneGroup
- file: src/platform/conditional-logic/builder/utils.ts:230
- kind: function
- core: platform
- spec: (none)
- summary: Clone a group deeply
- score: 1
function codedToBool
- file: src/platform/clinical/blocks/suicide/mapping.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Coerce a code to a boolean; unknown/blank → null.
- score: 4
function coerceToArray
- file: src/platform/conditional-logic/utils/operators.ts:50
- kind: function
- core: platform
- spec: (none)
- summary: Coerce value to array for array comparisons
- score: 4
function coerceToDate
- file: src/platform/conditional-logic/utils/operators.ts:25
- kind: function
- core: platform
- spec: (none)
- summary: Coerce value to Date for date comparisons
- score: 4
function coerceToDate
- file: src/platform/conditional-logic/validation/crossFieldEvaluator.ts:15
- kind: function
- core: platform
- spec: (none)
- summary: Coerce a value to a Date object
- score: 4
function coerceToNumber
- file: src/platform/conditional-logic/utils/operators.ts:13
- kind: function
- core: platform
- spec: (none)
- summary: Coerce value to number for numeric comparisons
- score: 4
function coerceToNumber
- file: src/platform/conditional-logic/validation/crossFieldEvaluator.ts:40
- kind: function
- core: platform
- spec: (none)
- summary: Coerce a value to a number
- score: 1
function coerceToString
- file: src/platform/conditional-logic/utils/operators.ts:41
- kind: function
- core: platform
- spec: (none)
- summary: Coerce value to string for text comparisons
- score: 4
function colorToHslTriplet
- file: src/platform/theming/utils/contrast.ts:136
- kind: function
- core: platform
- spec: (none)
- summary: Convert any color string (hex, rgb(), hsl()) to a triplet(no wrapper) for use as a CSS custom property value that can becomposed via or .Returns if the input cannot be parsed.
- score: 4
function combineFieldGroups
- file: src/platform/page-layouts/generators/fieldGroupingRules.ts:315
- kind: function
- core: platform
- spec: (none)
- summary: Combine standard and custom field groups into a complete layout structure.
- score: 4
function combineSectionsWithFields
- file: src/platform/page-layouts/utils.ts:60
- kind: function
- core: platform
- spec: (none)
- summary: Combine sections with their fields, sorted by display_order
- score: 4
function combineValidationErrors
- file: src/platform/wizards/hooks/useExpressionValidation.ts:183
- kind: function
- core: platform
- spec: (none)
- summary: Utility to combine expression validation with simple validation.Expression errors are aggregated under the reserved key,which contains an array of error messages from expression-based rules.Consumers should merge this with field-level errors for display.
- score: 4
function compareDates
- file: src/platform/conditional-logic/validation/crossFieldEvaluator.ts:60
- kind: function
- core: platform
- spec: (none)
- summary: Compare two dates
- score: 1
function compareMetadata
- file: src/platform/documents/utils/documentDiff.ts:118
- kind: function
- core: platform
- spec: (none)
- summary: Compare metadata objects from two document versions.
- params:
- metadataA — Metadata from version A
- metadataB — Metadata from version B
- returns: List of field-level changes
- score: 4
function compareNumbers
- file: src/platform/conditional-logic/validation/crossFieldEvaluator.ts:94
- kind: function
- core: platform
- spec: (none)
- summary: Compare two numbers
- score: 1
function compareValues
- file: src/platform/reports/utils/exportUtils.ts:310
- kind: function
- core: platform
- spec: (none)
- summary: Sort comparison function that handles various types
- score: 4
function compileAnalyticsQuery
- file: src/platform/analytics/semantic-compiler.ts:121
- kind: function
- core: platform
- spec: (none)
- summary: Compile + validate an analytics query spec against the registry allowlist and budget.Throws on any violation; returns a otherwise.
- score: 4
function compileCaptureTrace
- file: src/platform/automation/portal/recorder/compile.ts:106
- kind: function
- core: platform
- spec: (none)
- summary: Compile a raw capture trace into the canonical, worker-executable flow definition.Pure and deterministic; emits no captured values.
- score: 4
function compressImage
- file: src/platform/upload/image-utils.ts:277
- kind: function
- core: platform
- spec: (none)
- summary: Compress an image by reducing quality.Optionally converts to WebP if supported and smaller.Returns original file if animated GIF.
- score: 4
function computeBenefitsStatus
- file: src/platform/onboarding/computeOnboardingProgress.ts:115
- kind: function
- core: platform
- spec: (none)
- summary: Calculate benefits section status
- score: 4
function computeChecklistStatus
- file: src/platform/onboarding/computeOnboardingProgress.ts:49
- kind: function
- core: platform
- spec: (none)
- summary: Calculate checklist section status
- score: 4
function computeCompleteness
- file: src/platform/clinical/completeness/computeCompleteness.ts:23
- kind: function
- core: platform
- spec: (none)
- summary: Compute an encounter/surface’s documentation completeness from the resolvedrequired set and each block’s satisfaction.
- params:
- input — the surface, resolution status, required blocks, and per-block satisfaction.
- returns: the completeness score + source-tagged missing-required list (fail-closed when unresolved).
- score: 4
function computeCredentialStatus
- file: src/platform/onboarding/computeOnboardingProgress.ts:80
- kind: function
- core: platform
- spec: (none)
- summary: Calculate credentials section status
- score: 4
function computeDeviceFingerprint
- file: src/platform/sessions/utils/deviceFingerprint.ts:59
- kind: function
- core: platform
- spec: (none)
- summary: Compute a SHA-256 fingerprint from device metadata.Uses Web Crypto API (available in all modern browsers).
- score: 4
function computeDischargeSummaryDue
- file: src/platform/clinical/blocks/discharge/timeliness.ts:64
- kind: function
- core: platform
- spec: (none)
- summary: The due date = the Nth working day (Mon–Fri) after the discharge date, as a string. Deterministic UTC date math (no clock/timezone input).A corrupt discharge date or non-positive window → (nothing can bescheduled from corrupt input; callers treat null as “window unresolved”).
- score: 4
function computeJobDescriptionStatus
- file: src/platform/onboarding/computeOnboardingProgress.ts:191
- kind: function
- core: platform
- spec: (none)
- summary: Calculate job description section status
- score: 4
function computeLogicalParent
- file: src/platform/navigation/utils/navigation-utils.ts:144
- kind: function
- core: platform
- spec: (none)
- summary: PF-37: Compute the logical parent path for a given pathname.Used as a fallback when there’s no in-app history (deep link / refresh) sothe mobile Back button still lands the user somewhere sensible instead ofa 404 mid-segment.Behavior: 1. Strip the prefix (PF-74) before slicing, then re-prefix so org context is preserved. 2. Walk up one segment at a time, stopping at the first ancestor that exists in . If none match, fall back to walking up one segment. 3. Root () returns .
- example: | computeLogicalParent(‘/hr/employees/123/edit’, knownRoutes) → ‘/hr/employees/123’ computeLogicalParent(‘/o/acme/hr/employees/123’, knownRoutes) → ‘/o/acme/hr/employees’
- score: 4
function computeMilestoneStatus
- file: src/platform/onboarding/computeOnboardingProgress.ts:205
- kind: function
- core: platform
- spec: (none)
- summary: Calculate milestone status based on days elapsed
- score: 4
function computeOnboardingProgress
- file: src/platform/onboarding/computeOnboardingProgress.ts:308
- kind: function
- core: platform
- spec: (none)
- summary: Main computation function: transforms raw data into OnboardingStatus
- score: 4
function computePersonaSectionOrder
- file: src/platform/navigation/persona/computePersonaSectionOrder.ts:6
- kind: function
- core: platform
- spec: (none)
- summary: First persona whose has a granted key wins; else default order. Pure.
- score: 4
function computeQuickActionKey
- file: src/platform/navigation/quick-action-catalog.ts:46
- kind: function
- core: platform
- spec: (none)
- summary: Computes a stable action key from module scope, optional nav group, and route.
- params:
- moduleId — Module id (, , …)
- navGroupId — Optional when the action is defined on a subgroup
- route — Target route for the action
- score: 4
function computeReassessmentDue
- file: src/platform/clinical/blocks/suicide/reassessment.ts:23
- kind: function
- core: platform
- spec: (none)
- summary: The reassessment due timestamp = last-assessed + cadence days (ISO 8601). Acorrupt (or non-finite ) would otherwisepropagate to , which throws on thissafety-critical path. Fail safe instead — consistent with’s treatment of a corrupt due date — by returningthe epoch so the computed due date reads as immediately overdue rather thancrashing the crisis surface.
- score: 4
function computeReorder
- file: src/platform/navigation/utils/rail-dnd.ts:15
- kind: function
- core: platform
- spec: (none)
- summary: Given a current ordered list of ids and the active/over ids from adnd-kit , compute the new ordered list after the move.Returns when the drag is a no-op (active === over, or either isnot found in ).
- score: 4
function computeReviewDueDate
- file: src/platform/clinical/plan/plan-cadence.ts:35
- kind: function
- core: platform
- spec: (none)
- summary: The review due date = effective date + cadence days (ISO date, ).
- score: 4
function computeRosExtent
- file: src/platform/clinical/blocks/ros-exam/ros-extent.ts:49
- kind: function
- core: platform
- spec: (none)
- summary: Compute the advisory ROS extent for one encounter’s ROS entry collection(per-system rows + optional summary header row, the shape theCL-77 adapter reads/writes).- — nothing documented (or the header marks the ROS not performed).- — exactly 1 distinct system documented.- — 2–9 distinct systems documented.- — ≥10 distinct systems documented, or ≥1 documented system plus the header’s all-other-systems-negative attestation (1997-DG complete-ROS notation).
- params:
- entries — the encounter’s ROS rows; null/undefined reads as .
- returns: the advisory extent — display/PM-78 input only, never a sign gate.
- score: 4
function computeSchemaDiff
- file: src/platform/events/computeSchemaDiff.ts:27
- kind: function
- core: platform
- spec: (none)
- summary: Compute a diff between two JSON Schema objects.
- score: 4
function computeSkillsStatus
- file: src/platform/onboarding/computeOnboardingProgress.ts:172
- kind: function
- core: platform
- spec: (none)
- summary: Calculate skills section status
- score: 4
function computeTaxStatus
- file: src/platform/onboarding/computeOnboardingProgress.ts:145
- kind: function
- core: platform
- spec: (none)
- summary: Calculate tax forms section status
- score: 4
function computeTbScreeningDue
- file: src/platform/clinical/blocks/ros-exam/tb-screening.ts:52
- kind: function
- core: platform
- spec: (none)
- summary: Compute the TB-screening-due indicator from an admission date + resolvedwindow (pure). A corrupt admission date fails safe: due immediately (epoch)rather than silently reading “not due”.
- score: 4
function computeTextDiff
- file: src/platform/documents/utils/documentDiff.ts:58
- kind: function
- core: platform
- spec: (none)
- summary: Compute a text diff between two strings.
- params:
- textA — The “before” text
- textB — The “after” text
- returns: Unified and side-by-side diff results
- score: 4
function computeTimeliness
- file: src/platform/clinical/completeness/timeliness.ts:24
- kind: function
- core: platform
- spec: (none)
- summary: Compute the timeliness status for an encounter’s documentation.
- params:
- encounterDate — the encounter’s date/time (ISO).
- timelinessHours — PF-96 for the surface, or null when unset.
- now — the current time (injected for determinism).
- hasMissingRequired — whether a required element is still unsatisfied.
- returns: the deadline and whether the documentation is overdue.
- score: 4
function computeWeightedProgress
- file: src/platform/onboarding/computeOnboardingProgress.ts:249
- kind: function
- core: platform
- spec: (none)
- summary: Calculate weighted overall progress with automatic redistribution
- score: 4
function confidenceToBadgeVariant
- file: src/platform/ai/utils/confidence.ts:24
- kind: function
- core: platform
- spec: (none)
- summary: Map a 0–1 confidence score to a Badge variant (high=default, medium=secondary, low=outline).
- score: 4
function confidenceToLevel
- file: src/platform/ai/utils/confidence.ts:16
- kind: function
- core: platform
- spec: (none)
- summary: Bucket a 0–1 confidence score into a tier: 0.8+ is high, 0.5+ is medium, else low.
- score: 4
function confidenceToPercent
- file: src/platform/ai/utils/confidence.ts:30
- kind: function
- core: platform
- spec: (none)
- summary: Render a 0–1 confidence score as a rounded percentage string, e.g. .
- score: 4
function connectLive
- file: src/platform/wizards/audit/sources/live-source.ts:20
- kind: function
- core: platform
- spec: (none)
- summary: Connect to the local stack, or return when it is unreachable (connectionrefused / not found / timed out) so callers skip cleanly. Any OTHER error(e.g. auth failure against a reachable server) is thrown — a reachable stackwith a broken query must fail loudly, never skip.
- score: 4
function containsInjection
- file: src/platform/notifications/utils/templateValidation.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Check if a template body contains potential script injection patterns
- score: 4
function containsPHI
- file: src/platform/ai/widgets/utils/sanitizeForAI.ts:115
- kind: function
- core: platform
- spec: (none)
- summary: Quick check if text contains PHI/PII
- score: 4
function containsUnredactedPhi
- file: src/platform/ai/phi-redaction-core.ts:196
- kind: function
- core: platform
- spec: (none)
- summary: True when redacted text still contains a recognizable identifier (a residual-PHI tripwire).
- score: 4
function containsUnsafeContent
- file: src/platform/table-v2/utils/sanitize.ts:29
- kind: function
- core: platform
- spec: (none)
- summary: Utility for contains unsafe content.
- score: 1
function contrastRatio
- file: src/platform/dev/pages/brandingContrast.ts:72
- kind: function
- core: platform
- spec: (none)
- summary: WCAG 2.1 contrast ratio between two RGB triplets. Returns a value in. Used by the swatch tile to flag AA failures.
- score: 4
function contrastRatio
- file: src/platform/theming/utils/contrast.ts:93
- kind: function
- core: platform
- spec: (none)
- summary: Calculate contrast ratio between two color strings (hex, rgb, or hsl).Returns a value between 1 and 21.
- score: 4
function convertColumn
- file: src/platform/table-v2/adapter/columnConverter.ts:84
- kind: function
- core: platform
- spec: (none)
- summary: Converts a single PF-58 Column to a TanStack ColumnDef.
- params:
- column — PF-58 column definition
- options — Conversion options
- returns: TanStack column definition
- score: 4
function convertColumns
- file: src/platform/table-v2/adapter/columnConverter.ts:148
- kind: function
- core: platform
- spec: (none)
- summary: Converts an array of PF-58 Columns to TanStack ColumnDefs.
- params:
- columns — Array of PF-58 column definitions
- options — Conversion options
- returns: Conversion result with columns and metadata
- score: 4
function convertColumnVisibility
- file: src/platform/table-v2/adapter/propsAdapter.ts:111
- kind: function
- core: platform
- spec: (none)
- summary: Converts column visibility settings to TanStack VisibilityState.
- score: 4
function convertGroupBy
- file: src/platform/table-v2/adapter/propsAdapter.ts:133
- kind: function
- core: platform
- spec: (none)
- summary: Converts groupBy prop to TanStack GroupingState.
- score: 4
function convertPaginationConfig
- file: src/platform/table-v2/adapter/propsAdapter.ts:69
- kind: function
- core: platform
- spec: (none)
- summary: Converts PF-58 PaginationConfig to TanStack PaginationState.
- score: 4
function convertRowSelectionState
- file: src/platform/table-v2/adapter/propsAdapter.ts:100
- kind: function
- core: platform
- spec: (none)
- summary: Converts TanStack RowSelectionState back to selected rows array.
- score: 4
function convertSelectionConfig
- file: src/platform/table-v2/adapter/propsAdapter.ts:83
- kind: function
- core: platform
- spec: (none)
- summary: Converts PF-58 SelectionConfig to TanStack RowSelectionState.
- score: 4
function convertSortConfig
- file: src/platform/table-v2/adapter/propsAdapter.ts:41
- kind: function
- core: platform
- spec: (none)
- summary: Converts PF-57 SortConfig to TanStack SortingState.
- score: 4
function convertSortingState
- file: src/platform/table-v2/adapter/propsAdapter.ts:55
- kind: function
- core: platform
- spec: (none)
- summary: Converts TanStack SortingState to PF-57 SortConfig.
- score: 4
function convertStickyColumns
- file: src/platform/table-v2/adapter/propsAdapter.ts:118
- kind: function
- core: platform
- spec: (none)
- summary: Converts sticky columns to TanStack ColumnPinningState.
- score: 4
function createA4OnboardingTask
- file: src/platform/onboarding/integrations/payrollIntegration.ts:199
- kind: function
- core: platform
- spec: (none)
- summary: Create Arizona A-4 onboarding task configuration (for AZ employees)
- score: 4
function createAgent
- file: src/platform/cowork/agentsService.ts:59
- kind: function
- core: platform
- spec: (none)
- summary: Create an agent. organization_id is forced from the caller, never trusted from input.
- score: 4
function createApiCallTracker
- file: src/platform/quota/api-call-tracker.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Factory to create the API call tracker instance.
- score: 4
function createAsyncValidator
- file: src/platform/wizards/utils/async-validation.ts:37
- kind: function
- core: platform
- spec: (none)
- summary: Create an async validator function from a rule
- score: 4
function createBenefitsOnboardingTask
- file: src/platform/onboarding/integrations/benefitsIntegration.ts:157
- kind: function
- core: platform
- spec: (none)
- summary: Create benefits enrollment onboarding task configuration
- score: 4
function createBlockAdapterRegistry
- file: src/platform/clinical/blocks/adapter-registry.ts:39
- kind: function
- core: platform
- spec: (none)
- summary: Create an isolated registry instance (the app uses the singleton).
- score: 4
function createBulkOperation
- file: src/platform/bulk-operations/api.ts:15
- kind: function
- core: platform
- spec: (none)
- summary: Create a new bulk operation with individual item tracking.Enforces one-at-a-time guard per organization.
- score: 4
function createCacheKey
- file: src/platform/cache/key-builder.ts:5
- kind: function
- core: platform
- spec: (none)
- summary: PF-51: Cache key format org-orgId:namespace:key. Per CONTEXT: validate/throw if no org.
- score: 4
function createCapabilityValidator
- file: src/platform/ai/agentic/intake-rpc-adapters.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: PF-30-EN-01 capability-token validation (the resolver’s injected ; unused for ungated reads).
- score: 4
function createComparisonValidation
- file: src/platform/conditional-logic/validation/utils.ts:63
- kind: function
- core: platform
- spec: (none)
- summary: Create a general comparison validation rule
- score: 4
function createConnectorMediator
- file: src/platform/ai/agentic/connector-mediator.ts:31
- kind: function
- core: platform
- spec: PF-127
- summary: Build a connector mediator bound to one acting principal.
- score: 5
function createDateRangeValidation
- file: src/platform/conditional-logic/validation/utils.ts:15
- kind: function
- core: platform
- spec: (none)
- summary: Create a date range validation rule
- score: 4
function createDebouncedAsyncValidator
- file: src/platform/wizards/utils/async-validation.ts:134
- kind: function
- core: platform
- spec: (none)
- summary: Create a debounced async validator
- score: 4
function createDefaultBusinessHours
- file: src/platform/calendar/lib/business-day-utils.ts:132
- kind: function
- core: platform
- spec: (none)
- summary: Creates a default business hours map (Mon–Fri 09:00–17:00).Useful as a fallback when no calendar is configured.
- score: 4
function createDirectDepositTask
- file: src/platform/onboarding/integrations/payrollIntegration.ts:181
- kind: function
- core: platform
- spec: (none)
- summary: Create direct deposit onboarding task configuration
- score: 4
function createEdgeModelAdapter
- file: src/platform/ai/agentic/intake-model-adapter.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Build the single-turn model adapter.
- score: 4
function createEmptyCondition
- file: src/platform/conditional-logic/builder/utils.ts:462
- kind: function
- core: platform
- spec: (none)
- summary: Create an empty condition
- score: 1
function createEmptyGroup
- file: src/platform/conditional-logic/builder/utils.ts:474
- kind: function
- core: platform
- spec: (none)
- summary: Create an empty group
- score: 1
function createEmptyV2Rule
- file: src/platform/conditional-logic/utils/migration.ts:124
- kind: function
- core: platform
- spec: (none)
- summary: Create an empty V2 rule
- score: 1
function createEncoreOpenAiSseTransport
- file: src/platform/ai/utils/encoreOpenAiSseChatTransport.ts:115
- kind: function
- core: platform
- spec: (none)
- summary: that POSTs JSON to a Supabase edge function and maps the SSE response to UI chunks.
- score: 4
function createEncoreSkillChatTransport
- file: src/platform/ai/utils/encoreOpenAiSseChatTransport.ts:181
- kind: function
- core: platform
- spec: (none)
- summary: Skill-aware transport: tries when a skill is active, then matches legacy fallbacks to .
- score: 4
function createExpandColumn
- file: src/platform/table-v2/adapter/columnConverter.ts:227
- kind: function
- core: platform
- spec: (none)
- summary: Creates an expand column for expandable rows.
- returns: TanStack column definition for expand button
- score: 4
function createExportSignedUrl
- file: src/platform/reports/hooks/useReportExport.ts:68
- kind: function
- core: platform
- spec: (none)
- summary: Creates a signed URL for a file in the reports-exports bucket.
- score: 4
function createFieldFilter
- file: src/platform/table-v2/utils/filter/client.ts:53
- kind: function
- core: platform
- spec: (none)
- summary: Create a client filter from a field comparison.
- params:
- field — Field name to compare
- operator — Comparison operator
- value — Value to compare against
- returns: ClientFilter object
- example: | const ageFilter = createFieldFilterUser(‘age’, ‘gt’, 21);const adults = applyClientFilters(users, [ageFilter]);
- score: 4
function createFilter
- file: src/platform/table-v2/utils/filter/builder.ts:255
- kind: function
- core: platform
- spec: (none)
- summary: Create a simple filter object.Helper function for building filters programmatically.
- score: 4
function createFilterGroup
- file: src/platform/table-v2/utils/filter/builder.ts:263
- kind: function
- core: platform
- spec: (none)
- summary: Create a filter group.Helper function for building filter groups programmatically.
- score: 4
function createFlagCheck
- file: src/platform/ai/agentic/intake-rpc-adapters.ts:86
- kind: function
- core: platform
- spec: (none)
- summary: PF-45 flag check for (the loop’s injected ).
- score: 4
function createGoogleCalendarEvent
- file: src/platform/integrations/google-workspace.ts:50
- kind: function
- core: platform
- spec: (none)
- summary: Create a Google Calendar event (with optional Meet) via PF-101.Throws when the org lacks a connection, capability is disabled, or domainmismatch is detected. Consumers should surface the error through theirstandard toast pipeline.
- score: 4
function createGovernanceGate
- file: src/platform/ai/agentic/intake-write-rpc-adapters.ts:85
- kind: function
- core: platform
- spec: (none)
- summary: PF-126 gate wrapper (the GovernedWriteDeps.gate). Org is resolved server-side from the run.
- score: 4
function createInitialBuilderState
- file: src/platform/conditional-logic/builder/utils.ts:485
- kind: function
- core: platform
- spec: (none)
- summary: Create initial state for the builder
- score: 4
function createInitialState
- file: src/platform/table-v2/adapter/propsAdapter.ts:312
- kind: function
- core: platform
- spec: (none)
- summary: Creates initial adapter state from PF-58 props.
- score: 4
function createIntakeReadExecutor
- file: src/platform/ai/agentic/intake-read-tools.ts:88
- kind: function
- core: platform
- spec: (none)
- summary: Build the read dispatcher (the injected ).
- score: 4
function createIntakeReadSources
- file: src/platform/ai/agentic/intake-sources.ts:27
- kind: function
- core: platform
- spec: (none)
- summary: Build the production read sources bound to one org + authenticated client.
- score: 4
function createIntakeToolResolver
- file: src/platform/ai/agentic/tool-resolver.ts:16
- kind: function
- core: platform
- spec: (none)
- summary: Build a read-only tool resolver bound to one org + principal.
- score: 4
function createIntakeWriteExecutor
- file: src/platform/ai/agentic/intake-write-tools.ts:71
- kind: function
- core: platform
- spec: (none)
- summary: Build the post-approval write executor (used ONLY by the governed-writes orchestrator).
- score: 4
function createIntakeWriteRpcs
- file: src/platform/ai/agentic/intake-write-rpc-adapters.ts:22
- kind: function
- core: platform
- spec: (none)
- summary: The two governed write-RPC callers (match IntakeWriteExecutorDeps.createAppointment/advanceIntakeStatus).
- score: 4
function createMarketplaceSnapshot
- file: src/platform/wizards/utils/createMarketplaceSnapshot.ts:24
- kind: function
- core: platform
- spec: (none)
- summary: Creates a sanitized snapshot of a wizard template for marketplace.Strips organization-specific data and sensitive configuration.
- score: 4
function createMcpConnection
- file: src/platform/ai/mcp-client.ts:44
- kind: function
- core: platform
- spec: (none)
- summary: Creates a lightweight MCP connection descriptor.
- params:
- config — MCP server configuration.
- returns: Connection descriptor used by .
- score: 4
function createMessagePreview
- file: src/platform/messaging/utils/messageFormatter.ts:45
- kind: function
- core: platform
- spec: (none)
- summary: Create message preview (truncate + remove newlines).
- score: 4
function createMultiSortConfig
- file: src/platform/table-v2/utils/sort/config.ts:160
- kind: function
- core: platform
- spec: (none)
- summary: Helper to create a MultiSortConfig
- score: 4
function createNumericComparisonValidation
- file: src/platform/conditional-logic/validation/utils.ts:42
- kind: function
- core: platform
- spec: (none)
- summary: Create a numeric comparison validation rule
- score: 4
function createOfflineQueryClient
- file: src/platform/offline/queryPersistence.ts:214
- kind: function
- core: platform
- spec: (none)
- summary: Default QueryClient configuration for offline support
- score: 4
function createPersistedQueryClient
- file: src/platform/offline/queryPersistence.ts:262
- kind: function
- core: platform
- spec: (none)
- summary: Create a complete persisted query client setup
- params:
- options — Persistence options
- returns: QueryClient and persistence configuration
- score: 4
function createPreviewSignature
- file: src/platform/email-signatures/utils/variables.ts:73
- kind: function
- core: platform
- spec: (none)
- summary: Creates a typed EmailSignature stub for preview rendering.Fills all required Row fields with safe defaults so no is needed.
- score: 4
function createQueryPersister
- file: src/platform/offline/queryPersistence.ts:199
- kind: function
- core: platform
- spec: (none)
- summary: Create a persister for TanStack Query
- score: 4
function createRunRpcs
- file: src/platform/ai/agentic/intake-rpc-adapters.ts:26
- kind: function
- core: platform
- spec: (none)
- summary: PF-125 lifecycle + checkpoint writers (the loop’s injected ).
- score: 4
function createSelectionColumn
- file: src/platform/table-v2/adapter/columnConverter.ts:191
- kind: function
- core: platform
- spec: (none)
- summary: Creates a selection column for row selection.
- returns: TanStack column definition for selection checkbox
- score: 4
function createSelectionColumnDef
- file: src/platform/table-v2/features/RowSelection.tsx:35
- kind: function
- core: platform
- spec: (none)
- summary: Creates a selection column definition for row selection. T - Row data type
- params:
- options — Selection options
- returns: Column definition for selection
- score: 4
function createSessionRecord
- file: src/platform/sessions/hooks/useCreateSession.ts:20
- kind: function
- core: platform
- spec: (none)
- summary: Creates a session record and upserts the device record.Called after successful sign-in (post-MFA if applicable).
- score: 4
function createSessionRecorder
- file: src/platform/analytics/sessionRecorder.ts:376
- kind: function
- core: platform
- spec: (none)
- summary: Create a new session recorder instance
- params:
- config — Recorder configuration
- returns: Session recorder instance
- score: 4
function createSettingsTransform
- file: src/platform/settings/utils/settings-transform.ts:73
- kind: function
- core: platform
- spec: (none)
- summary: Creates a typed transform function for a specific settings type.Useful when you need to ensure type safety for specific settings.
- returns: Typed transform function for the specified settings type
- example: | type FASettings = invoice_prefix: string | null; due_days: number | null ;const transformFA = createSettingsTransformFASettings();const formValues = transformFA(settings);
- score: 4
function createSimpleRequiredRule
- file: src/platform/conditional-logic/utils/migration.ts:148
- kind: function
- core: platform
- spec: (none)
- summary: Create a V2 rule with simple required condition
- score: 4
function createSimpleVisibilityRule
- file: src/platform/conditional-logic/utils/migration.ts:131
- kind: function
- core: platform
- spec: (none)
- summary: Create a V2 rule with simple visibility condition
- score: 4
function createSortConfig
- file: src/platform/table-v2/utils/sort/config.ts:149
- kind: function
- core: platform
- spec: (none)
- summary: Helper to create a SortConfig
- score: 1
function createSsoProviderWithDomain
- file: src/platform/auth/sso/useSsoSetup.ts:57
- kind: function
- core: platform
- spec: (none)
- summary: Step 1: create the provider (pending) + a domain-ownership claim with a freshverification token. Returns the IDs and the DNS TXT value to publish.
- score: 4
function createTableOptions
- file: src/platform/table-v2/adapter/propsAdapter.ts:169
- kind: function
- core: platform
- spec: (none)
- summary: Creates TanStack Table options from PF-58 DataTableProps.
- params:
- props — PF-58 DataTable props
- options — Adapter options with state and callbacks
- returns: Partial TanStack table options
- score: 4
function createThread
- file: src/platform/cowork/threadsService.ts:25
- kind: function
- core: platform
- spec: (none)
- summary: Create a cowork Thread (pf_threads) over an existing PF-67 conversation. Returns the new thread id.
- score: 4
function createToolAudit
- file: src/platform/ai/agentic/intake-rpc-adapters.ts:52
- kind: function
- core: platform
- spec: (none)
- summary: PF-127 content-free invocation audit (the resolver’s injected ). Thread-bound for the 2d surface.
- score: 4
function createTrackedFetch
- file: src/platform/monitoring/api-metrics.ts:199
- kind: function
- core: platform
- spec: (none)
- summary: Create a wrapped fetch function that tracks metrics
- score: 4
function createW4OnboardingTask
- file: src/platform/onboarding/integrations/payrollIntegration.ts:163
- kind: function
- core: platform
- spec: (none)
- summary: Create W-4 onboarding task configuration
- score: 4
function createZodSchemaFromJsonSchema
- file: src/platform/forms/utils/schemaExport.ts:237
- kind: function
- core: platform
- spec: (none)
- summary: Create a Zod schema from JSON Schema (placeholder)Note: Full JSON Schema to Zod conversion is complex.For now, this returns a passthrough schema.Consider using ‘json-schema-to-zod’ package for full conversion.
- params:
- _jsonSchema — JSON Schema object (currently unused)
- returns: A passthrough Zod schema (z.unknown())
- score: 4
function crossModuleSubmit
- file: src/platform/wizards/utils/crossModuleSubmit.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: Submit wizard data to multiple module tables.
- params:
- values — The collected wizard form values
- targets — Array of module targets with table and field mappings
- organizationId — Current organization ID
- userId — Current user ID
- returns: Result object with success status and any errors
- score: 4
function csvRowToCustomFields
- file: src/platform/data-manager/utils/rawDataImportUtils.ts:145
- kind: function
- core: platform
- spec: (none)
- summary: Convert CSV row to custom_fields partial object
- score: 4
function customConfigToWidgetDefinition
- file: src/platform/dashboard/utils/custom-widget-adapter.tsx:30
- kind: function
- core: platform
- spec: (none)
- summary: Synthesize a WidgetDefinition for a custom (no-code) widget config so it flows through the normal grid render path. Component identity is stable per config.id; content stays fresh.
- score: 4
function dbWorkspaceToDefinition
- file: src/platform/navigation/workspaces/dbWorkspaceToDefinition.ts:23
- kind: function
- core: platform
- spec: (none)
- summary: Pure: DB row → WorkspaceDefinition. Resolves the icon name to a LucideIcon (fallback LayoutGrid).
- score: 4
function debounce
- file: src/platform/wizards/utils/async-validation.ts:105
- kind: function
- core: platform
- spec: (none)
- summary: Debounce helper for async validation with cancel support
- score: 4
function decideSudEmbedGate
- file: src/platform/analytics/embed/sud-embed-gate.ts:48
- kind: function
- core: platform
- spec: (none)
- summary: Decide whether SUD-derived values may be served on the external-embed path.Fail-closed: only SUD-derived content is gated, and it is blocked unless the org isexplicitly Part-2-embed authorized. Everything non-SUD passes unconditionally.
- score: 4
function deepTransformSettingsForForm
- file: src/platform/settings/utils/settings-transform.ts:94
- kind: function
- core: platform
- spec: (none)
- summary: Deep transform for nested settings objects.Recursively converts null to undefined at all levels.
- params:
- settings — Settings object with potential nested objects
- returns: Deep transformed settings object
- example: | const settings = general: name: null, active: true , advanced: timeout: null ;const result = deepTransformSettingsForForm(settings);// general: name: undefined, active: true , advanced: timeout: undefined
- score: 4
function defaultArtifactScreen
- file: src/platform/ai/agentic/artifact-prompt-context.ts:66
- kind: function
- core: platform
- spec: (none)
- summary: The default PF-27-EN-01 screen: re-run the (already-redacted) projection through the two-pathenforcer on the standard lane. Returns the prompt-safe text; throws ifthe content cannot be safely dispatched (propagated as a block, fail-closed).
- score: 4
function defaultMemoryScreen
- file: src/platform/ai/agentic/agent-memory-adapters.ts:35
- kind: function
- core: platform
- spec: (none)
- summary: The default PF-27-EN-01 two-path screen: run the content through the enforcer as a standard-lane step. On the standard lane it returns the redacted, prompt-safe text (the value we storeas and the gate for recalled rows). A misconfigured step that would requireunredacted PHI on a non-PHI lane throws — propagated to fail closed.
- score: 4
function deleteFile
- file: src/platform/upload/service.ts:331
- kind: function
- core: platform
- spec: (none)
- summary: Delete a file from storage with tenant isolation check.
- score: 4
function deletePasskey
- file: src/platform/auth/passkey/passkey-utils.ts:179
- kind: function
- core: platform
- spec: (none)
- summary: Delete a passkey.
- score: 1
function deriveAssessmentRiskLevel
- file: src/platform/clinical/blocks/suicide/suicide-assessment-adapter.ts:63
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the assessment’s NOT NULL risk_level: an explicit level wins; else a conservative moderate floor.
- score: 4
function deriveForegroundHex
- file: src/platform/theming/utils/derive-foreground.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Convenience wrapper that returns the chosen foreground as / for callers (like the live-preview wrapper) that compose inline values rather than CSS custom properties.
- score: 4
function deriveForegroundTriplet
- file: src/platform/theming/utils/derive-foreground.ts:31
- kind: function
- core: platform
- spec: (none)
- summary: Derive the WCAG-AA-safe foreground for a given surface color.
- params:
- surface — Any color string accepted by (hex, , ). Invalid input falls back to which yields the white foreground triplet.
- returns: A CSS triplet (no wrapper) suitable for direct assignment to a CSS variable.
- example: | deriveForegroundTriplet(‘#FFD700’); // ‘0 0% 0%’ (near-black for yellow)deriveForegroundTriplet(‘#1e3a8a’); // ‘0 0% 100%’ (white for dark blue)
- score: 4
function deriveInputSchema
- file: src/platform/automation/portal/recorder/compile.ts:163
- kind: function
- core: platform
- spec: (none)
- summary: JSON-schema () built from a definition’s parameterized fill steps.
- score: 4
function deriveNeedsIdentified
- file: src/platform/clinical/blocks/sdoh-adapter.ts:67
- kind: function
- core: platform
- spec: (none)
- summary: Derive for the row: an explicit array wins; otherwise thedomain keys answered (so the parent CL-18 referral/event flowkeeps working for block-created screenings).
- score: 4
function derivePin
- file: src/platform/auth/app-lock/pin-utils.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Derive a 256-bit key from and using PBKDF2-SHA256.Returns a 64-character lowercase hex string.
- score: 4
function deriveProviderWritableVars
- file: src/platform/theming/devChecks/auditTenantVars.ts:66
- kind: function
- core: platform
- spec: (none)
- summary: Re-derive the full set of provider-writable vars from the same constants uses.
- score: 4
function deriveReconciliationStatus
- file: src/platform/clinical/blocks/meds/med-reconciliation-adapter.ts:59
- kind: function
- core: platform
- spec: (none)
- summary: Derive the CHECK-safe workflow status: an explicit valid status wins; otherwisea recorded outcome marks the reconciliation ‘completed’, else ‘in_progress’.
- score: 4
function deriveScreenRiskLevel
- file: src/platform/clinical/blocks/suicide/suicide-screen-adapter.ts:44
- kind: function
- core: platform
- spec: (none)
- summary: Derive a NOT NULL risk level for a screen. An explicit level wins; otherwiseONLY an explicit result maps to . A , ,, or any other/unset result floors at so arefused or incomplete suicide screen is never recorded as explicitly low risk(the conservative floor also used by the assessment adapter).
- score: 4
function deriveTemplateModuleDefaults
- file: src/platform/provisioning/lib/moduleOverridesForm.ts:100
- kind: function
- core: platform
- spec: (none)
- summary: Effective module on/off defaults for a template: the platform default map (all knownmodules) overlaid with any map the template_config or the state-awarebundle’s baseline_settings declares. The bundle wins last because Step 4b actually writesits baseline to the column, superseding template_config.
- score: 4
function deriveTemplateScalarDefaults
- file: src/platform/provisioning/lib/moduleOverridesForm.ts:120
- kind: function
- core: platform
- spec: (none)
- summary: Effective scalar setting defaults: each setting’s column DEFAULT overlaid with the valuethe bundle baseline (then template_config) specifies, when a finite number. Bundle winsover template_config for the same reason as modules.
- score: 4
function destroyGlobalRecorder
- file: src/platform/analytics/sessionRecorder.ts:406
- kind: function
- core: platform
- spec: (none)
- summary: Destroy global recorder (for consent revocation)
- score: 4
function detectConflicts
- file: src/platform/picklists/utils/importValidation.ts:140
- kind: function
- core: platform
- spec: (none)
- summary: Compare import records against existing org picklists to detect conflicts
- score: 4
function detectExecutionSpikes
- file: src/platform/query-performance/anomaly-rules.ts:76
- kind: function
- core: platform
- spec: (none)
- summary: Detect execution time spikes by comparing current p95 against baseline.
- params:
- currentMetrics — Map of fingerprint → current p95 execution time (ms)
- baselines — Array of established baselines with p95 values
- spikeThresholdPercent — Percentage increase that triggers a spike (e.g. 50 means 50% above baseline)
- returns: Array of anomaly results for execution spikes
- score: 4
function detectNewPatterns
- file: src/platform/query-performance/anomaly-rules.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Detect new query patterns by comparing current fingerprints against known baselines.
- params:
- currentFingerprints — Set of fingerprints observed in the current window
- knownBaselines — Array of previously established baselines
- returns: Array of anomaly results for new patterns
- score: 4
function detectPhi
- file: src/platform/ai/phi-redaction-core.ts:185
- kind: function
- core: platform
- spec: (none)
- summary: Detect (do not redact) PHI: returns the category tokens present, or an empty array.
- score: 4
function dialNumber
- file: src/platform/telephony/lib/embeddable-events.ts:223
- kind: function
- core: platform
- spec: (none)
- summary: Initiate a new call via the Embeddable widget
- score: 4
function diffRecommendedAgainstEnabled
- file: src/platform/ai/lib/onboarding-logic.ts:127
- kind: function
- core: platform
- spec: (none)
- summary: Diff the recommended set against the currently-enabled set for the edit-profilere-run mode (Decisions §“Re-run behavior”): when isalready set, Step 6 asks the admin to confirm CHANGES rather than running blind.Returns the codes newly recommended (not yet enabled) and the enabled codes nolonger recommended — the wizard renders both for explicit confirmation.
- score: 4
function diffThemeRoundTrip
- file: src/platform/theming/utils/diffTheme.ts:87
- kind: function
- core: platform
- spec: (none)
- summary: Compare an imported payload to the current active theme.
- params:
- imported — Parsed JSON payload produced by export.
- current — Active row to round-trip against.
- options — Strict mode flags. When is , missing PF-95 deep-theming fields fall back to the current theme’s value and are reported as rather than .
- score: 4
function dischargeSummaryRowToFormValues
- file: src/platform/clinical/blocks/discharge/discharge-summary-adapter.ts:135
- kind: function
- core: platform
- spec: (none)
- summary: Map a persisted row back to the block’s form values.
- score: 4
function dispatchPortalRun
- file: src/platform/automation/portal/seam.ts:48
- kind: function
- core: platform
- spec: (none)
- summary: Dispatch a portal-bot run through the platform automation seam. Returns therun id and (when the runner completed synchronously, e.g. fixture transport oran inline run) its terminal status + result.
- score: 4
function domainFromEmail
- file: src/platform/auth/sso/useSsoLogin.ts:47
- kind: function
- core: platform
- spec: (none)
- summary: Derive the email domain (lowercased) or null.
- score: 4
function downloadCSV
- file: src/platform/data-manager/utils/rawDataCsvUtils.ts:121
- kind: function
- core: platform
- spec: (none)
- summary: Trigger a file download in the browser
- score: 4
function downloadCSV
- file: src/platform/signatures/utils/csvExport.ts:82
- kind: function
- core: platform
- spec: (none)
- summary: Download data as a CSV file.
- score: 1
function downloadExport
- file: src/platform/picklists/utils/exportSerialization.ts:77
- kind: function
- core: platform
- spec: (none)
- summary: Trigger browser download of export content
- score: 4
function downloadPdf
- file: src/platform/documents/pdfGenerator.ts:273
- kind: function
- core: platform
- spec: (none)
- summary: Generate and download PDF from element
- score: 4
function downloadPdf
- file: src/platform/templates/hooks/useGenerateTemplatedPdf.ts:132
- kind: function
- core: platform
- spec: (none)
- summary: Initiates a download of a PDF by creating and programmatically clicking a temporary anchor element.
- params:
- url — The URL of the PDF to download.
- fileName — The file name to suggest for the downloaded file.
- returns: void
- example: | // Start download of a PDF located at a remote URLdownloadPdf(‘https://cdn.example.com/reports/annual.pdf’, ‘annual-report.pdf’);
- score: 4
function downloadSchemaAsJson
- file: src/platform/forms/utils/schemaExport.ts:205
- kind: function
- core: platform
- spec: (none)
- summary: Create a downloadable JSON file from schema
- params:
- schema — JSON Schema object
- filename — Download filename
- score: 4
function driftFindings
- file: src/platform/wizards/audit/orchestrator.ts:74
- kind: function
- core: platform
- spec: (none)
- summary: Diff static (migration / types.ts) vs live (DB) contracts into findings.Compares template field NAMES and table COLUMN names only (not option values),so an intentional option-only fix (e.g. 20260613050000) does not register asdrift. — drift is informational, ratchetable via baseline.
- score: 4
function EmbeddableCustomTabs
- file: src/platform/telephony/components/EmbeddableCustomTabs.tsx:59
- kind: function
- core: platform
- spec: (none)
- summary: Component that manages custom tabs in the RingCentral Embeddable widget.Automatically:- Shows contact tab when call matches a CRM contact- Shows partner tab when call matches a CRM partner- Removes tabs when call ends- Tracks performance metrics for matching and rendering (T19)
- example: | // In EmbeddableWrapper.tsxEmbeddableCustomTabs enabled=embeddableCustomTabsEnabled /
- score: 4
function emitOnboardingEvent
- file: src/platform/ai/utils/aiOnboardingAnalytics.ts:54
- kind: function
- core: platform
- spec: (none)
- summary: Emit one onboarding analytics event (fire-and-forget).PF-135 Wave 2-0: this is a bespoke wizard (no row), so eventscarry a stable slug. The previous was alabel, not a UUID, so ‘s UUID guard silently dropped every event.
- params:
- params — The event name, identifiers, and a PHI-free payload.
- score: 4
function emitSkillWizardEvent
- file: src/platform/ai/wizards/ai-skill-creation/analytics.ts:45
- kind: function
- core: platform
- spec: (none)
- summary: Emit one skill-wizard analytics event (fire-and-forget).
- params:
- params — The event name, identifiers, and a PHI-free payload.
- score: 4
function encoreUiMessagesToChatPayload
- file: src/platform/ai/utils/encoreOpenAiSseChatTransport.ts:18
- kind: function
- core: platform
- spec: (none)
- summary: Map UI messages (text parts only) to for / .
- score: 4
function endApiCall
- file: src/platform/monitoring/api-metrics.ts:116
- kind: function
- core: platform
- spec: (none)
- summary: End tracking an API call and record metrics
- score: 4
function enforceExternalModelStep
- file: src/platform/ai/phi-two-path-enforcer.ts:74
- kind: function
- core: platform
- spec: (none)
- summary: Apply the two-path rule to one external-model-reaching step (FR-8). Exactly one path is legal: - local embedding (no egress) → exempt: dispatch raw. - Path (i) — PHI lane (BAA/ZDR, cl/pm): PHI is permitted; is NOT applied. - Path (ii) — non-PHI lane: is MANDATORY and fail-closed; a step that declares it needs unredacted PHI on a non-PHI lane throws (rejected, not degraded).Fail-closed: if throws (the PM-64 contract on bad input or an internal error), the throwpropagates and the caller MUST skip the model call, forwarding zero original text.
- params:
- step — The step to evaluate (lane already resolved by the caller via resolveModels).
- redact — The canonical redactor (injected). MAY throw fail-closed.
- score: 4
function enforceSsoGate
- file: src/platform/auth/sso/useSsoLogin.ts:136
- kind: function
- core: platform
- spec: (none)
- summary: Apply the known-employees-only gate to the current session. Call once after asession is detected on load (e.g. returning from the IdP).
- score: 4
function enhanceBenefitsStatus
- file: src/platform/onboarding/integrations/benefitsIntegration.ts:115
- kind: function
- core: platform
- spec: (none)
- summary: Enhance benefits status with integration-specific fields
- score: 4
function enhancePayrollStatus
- file: src/platform/onboarding/integrations/payrollIntegration.ts:129
- kind: function
- core: platform
- spec: (none)
- summary: Enhance tax status with integration-specific fields
- score: 4
function enqueueWorkflowExecution
- file: src/platform/workflow/execution.ts:80
- kind: function
- core: platform
- spec: (none)
- summary: Enqueue an FW workflow execution through the platform seam.
- score: 4
function enrollBiometric
- file: src/platform/auth/app-lock/biometric-utils.ts:78
- kind: function
- core: platform
- spec: (none)
- summary: Enroll a biometric credential using the platform authenticator.Requires a user gesture (e.g. button click).
- params:
- userId — The current user’s UUID, used as the WebAuthn user handle.
- returns: The enrolled credential reference to persist.
- score: 4
function entraHealthBadgeLabel
- file: src/platform/integrations/entra-health.ts:102
- kind: function
- core: platform
- spec: (none)
- summary: User-facing badge label for each health status.
- score: 4
function escapeILikePattern
- file: src/platform/search/utils.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Escape special characters in ILIKE patterns to prevent injection.Characters %, _, and have special meaning in LIKE/ILIKE patterns.
- params:
- pattern — The search pattern to escape
- returns: The escaped pattern safe for ILIKE queries
- example: | escapeILikePattern(‘50%’) // Returns ‘50’escapeILikePattern(‘test_value’) // Returns
- score: 4
function evaluateAnomalyRules
- file: src/platform/query-performance/anomaly-rules.ts:123
- kind: function
- core: platform
- spec: (none)
- summary: Run all anomaly detection rules and return combined results.
- params:
- config — Anomaly detection configuration (which rules are enabled)
- currentFingerprints — Fingerprints observed in current window
- currentMetrics — Map of fingerprint → current p95 execution time
- baselines — Known baseline patterns
- returns: Combined array of anomaly detection results
- score: 4
function evaluateBranchConfig
- file: src/platform/wizards/utils/evaluateBranchCondition.ts:111
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a branch configuration and return the target step IDEvaluates conditions in order, returns first match or default
- score: 4
function evaluateComparison
- file: src/platform/conditional-logic/validation/crossFieldEvaluator.ts:116
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate comparison based on type
- score: 4
function evaluateCondition
- file: src/platform/approvals/evaluateRoutingRules.ts:34
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a single FW-17 condition against the entity payload.
- score: 4
function evaluateCondition
- file: src/platform/conditional-logic/utils/evaluator.ts:29
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a single condition against form values
- params:
- condition — The condition to evaluate
- formValues — Current form field values
- returns: boolean - Whether the condition is met
- score: 4
function evaluateCondition
- file: src/platform/page-layouts/utils/evaluateVisibility.ts:12
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a single visibility condition against form values.
- score: 4
function evaluateCondition
- file: src/platform/wizards/utils/evaluateBranchCondition.ts:18
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a single branch condition against form values
- score: 4
function evaluateConditionalLogic
- file: src/platform/forms/validation.ts:280
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate conditional logic for a fieldReturns true if field should be shown, false if hidden
- score: 4
function evaluateConditionalLogicV2
- file: src/platform/forms/validationV2.ts:40
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate conditional logic for a field using V2 engineSupports both V1 (show_if/hide_if) and V2 (visibility/requiredIf/readonlyIf) formats
- params:
- field — Form field definition
- formData — Current form data
- returns: Conditional evaluation result
- score: 4
function evaluateConditionalRule
- file: src/platform/field-config/utils.ts:36
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate conditional visibility rule
- score: 4
function evaluateConditionalRuleV2
- file: src/platform/conditional-logic/utils/evaluator.ts:139
- kind: function
- core: platform
- spec: (none)
- summary: Main entry point - evaluate any conditional rule (V1 or V2)Automatically migrates V1 rules to V2 format for evaluation
- params:
- rule — V1 or V2 conditional rule
- formValues — Current form field values
- returns: ConditionalRuleResult - visibility, required, readonly status
- score: 4
function evaluateConditionGroup
- file: src/platform/conditional-logic/utils/evaluator.ts:52
- kind: function
- core: platform
- spec: (none)
- summary: Recursively evaluate a condition group (AND/OR)
- params:
- group — The condition group to evaluate
- formValues — Current form field values
- depth — Current nesting depth (for safety limit)
- returns: boolean - Whether the group condition is met
- score: 4
function evaluateCrossFieldValidation
- file: src/platform/conditional-logic/validation/crossFieldEvaluator.ts:216
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a single cross-field validation
- score: 4
function evaluateCrossFieldValidations
- file: src/platform/conditional-logic/validation/crossFieldEvaluator.ts:251
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate all cross-field validations
- score: 4
function evaluateCrossTimezoneConflict
- file: src/platform/timezone/cross-timezone-conflict.ts:152
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a candidate cross-site booking against one existing booking, returningboth the overlap verdict and the dual-timezone labels needed to explain it.Pure and side-effect free; the consumer decides how to surface the result.
- score: 4
function evaluateFieldRules
- file: src/platform/conditional-logic/utils/evaluator.ts:176
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate multiple fields at once for efficiency
- params:
- fieldRules — Map of field keys to their conditional rules
- formValues — Current form field values
- returns: Map of field keys to their evaluation results
- score: 4
function evaluateFieldVisibility
- file: src/platform/page-layouts/utils/evaluateVisibility.ts:44
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate whether a field should be visible based on visibility rules.If no rules target the field → visible.If any rule targeting the field evaluates to false → hidden.All rules for a field must pass for it to be visible.
- score: 4
function evaluateNarrativePublish
- file: src/platform/ai/lib/onboarding-logic.ts:158
- kind: function
- core: platform
- spec: (none)
- summary: Author-time PHI gate for the Step-5 narrative publish (AC-4 / NFR-phi-1).The org-profile narrative is meant to be organizational facts only. Beforepublishing the PF-61 article we run the static PHI scan; if itdetects any identifier (SSN, MRN, phone, email, DOB-style date, address, ZIP,or caller-supplied names/ids), publish is blocked with a PHI-free reason so theadmin can edit. The draft is preserved (the caller does not upsert on a block).
- params:
- narrative — The “About ” markdown the admin authored.
- ctx — Optional caller-known identifiers (e.g. provider names) to literal-match.
- score: 4
function evaluateOperator
- file: src/platform/conditional-logic/utils/operators.ts:127
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a single operator with field value and compare value
- score: 4
function evaluatePayerMix
- file: src/platform/ai/lib/onboarding-logic.ts:67
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a payer-mix object for the SOFT, non-blocking sum-to-~100 warning.Step 3 keeps onboarding low-friction for rough estimates: an out-of-band totalsurfaces a warning but never blocks advancing. An empty/all-zero mix is treatedas “not yet entered” → no warning (the field is optional).
- score: 4
function evaluatePlanSignGate
- file: src/platform/clinical/plan/measurable.ts:47
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate the sign-time measurable-objective gate. Under an active TJC overlay,any non-measurable objective blocks sign-off and is surfaced; without theoverlay the plan signs unimpeded.
- score: 4
function evaluatePrefill
- file: src/platform/forms/prefill/engine.ts:83
- kind: function
- core: platform
- spec: (none)
- summary: Evaluates all active prefill rules for a form and returns merged defaultsand a provenance map.Rules are evaluated in priority order (ascending). For each field, the firstrule that successfully resolves a non-undefined value wins (“first-win”).
- score: 4
function evaluateRule
- file: src/platform/validation/validators.ts:36
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a single value against a rule type and params.
- score: 4
function evaluateSatisfaction
- file: src/platform/clinical/completeness/satisfaction.ts:62
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a loaded block instance for completeness satisfaction.Handles both single-row typed blocks (e.g. MSE → one flat object), a flattenedgeneric object, and collection-shaped typed blocks (CL-77 ROS/examadapters return an array): a non-empty collection counts as satisfied only whenat least one row carries real (non-structural) content — a collection of stubheader / rows does NOT (so a required ROS/exam block never readsfalsely-complete).
- params:
- row — the instance row, an array of rows, or null/undefined when none exists.
- returns: whether the block is present and whether it is satisfied.
- score: 4
function evaluateStoredRules
- file: src/platform/validation/evaluateStoredRules.ts:36
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate all active stored rules for an org (optionally filtered by entity/field)against a given value.
- params:
- organizationId — Organization scope
- value — The value to validate
- options — Optional entity/field filters and field label
- returns: Combined result: valid only if all rules pass
- score: 4
function evaluateV2Rule
- file: src/platform/conditional-logic/utils/evaluator.ts:104
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a V2 conditional rule
- params:
- rule — V2 rule to evaluate
- formValues — Current form field values
- returns: ConditionalRuleResult - visibility, required, readonly status
- score: 4
function evaluateValidationExpression
- file: src/platform/wizards/utils/validationExpressionEvaluator.ts:464
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate a validation expression
- score: 4
function evaluateVisibilityConditions
- file: src/platform/wizards/utils/validation-executor.ts:342
- kind: function
- core: platform
- spec: (none)
- summary: Evaluate visibility conditions
- score: 1
variable exactRouteMatcher
- file: src/platform/navigation/utils/active-nav-item.ts:115
- kind: variable
- core: platform
- spec: (none)
- summary: Exact path equality — used by desktop ().
- score: 2
function executeValidation
- file: src/platform/wizards/utils/validation-executor.ts:45
- kind: function
- core: platform
- spec: (none)
- summary: Execute all validation rules and return field errors
- score: 4
function explainBaaStatus
- file: src/platform/transcription/admin/lib/deriveBaaStatus.ts:35
- kind: function
- core: platform
- spec: (none)
- summary: Human-readable explainer for the dialog’s computed-status badge.
- score: 4
function exportAnalyticsToCSV
- file: src/platform/wizards/utils/exportAnalytics.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Export wizard analytics to CSV format
- score: 4
function exportFieldAsJsonSchema
- file: src/platform/forms/utils/schemaExport.ts:136
- kind: function
- core: platform
- spec: (none)
- summary: Export a single field as JSON Schema
- params:
- field — Form field definition
- options — Export options
- returns: JSON Schema representation of the field
- score: 4
function exportFormAsJsonSchema
- file: src/platform/forms/utils/schemaExport.ts:104
- kind: function
- core: platform
- spec: (none)
- summary: Export a complete form definition as JSON Schema
- params:
- fields — Array of form field definitions
- options — Export options
- returns: JSON Schema representation of the form
- score: 4
function exportFormAsOpenApiSchema
- file: src/platform/forms/utils/schemaExport.ts:195
- kind: function
- core: platform
- spec: (none)
- summary: Generate OpenAPI 3.0 compatible schema from form fieldsNote: Zod v4’s native JSON Schema uses draft-2020-12.For strict OpenAPI 3.0 compatibility, post-processing may be needed.
- params:
- fields — Form field definitions
- options — Export options
- returns: OpenAPI 3.0 compatible schema
- score: 4
function exportLineageCsv
- file: src/platform/org-data-sync/utils/lineage-export.ts:34
- kind: function
- core: platform
- spec: (none)
- summary: Provides export lineage csv functionality.
- score: 4
function exportLineageJson
- file: src/platform/org-data-sync/utils/lineage-export.ts:27
- kind: function
- core: platform
- spec: (none)
- summary: Provides export lineage json functionality.
- score: 4
function exportRecordsToCsv
- file: src/platform/picklists/utils/exportSerialization.ts:52
- kind: function
- core: platform
- spec: (none)
- summary: Serialize export records to CSV string (one row per item)
- score: 4
function exportRecordsToJson
- file: src/platform/picklists/utils/exportSerialization.ts:35
- kind: function
- core: platform
- spec: (none)
- summary: Serialize export records to JSON string
- score: 4
function exportSession
- file: src/platform/analytics/sessionRecorder.ts:488
- kind: function
- core: platform
- spec: (none)
- summary: Export session as JSON file
- score: 1
function exportSignatureRequestsToCSV
- file: src/platform/signatures/utils/csvExport.ts:101
- kind: function
- core: platform
- spec: (none)
- summary: Export signature requests to CSV and trigger download.
- score: 4
function exportToCSV
- file: src/platform/reports/utils/exportUtils.ts:108
- kind: function
- core: platform
- spec: (none)
- summary: Export data to CSV format
- score: 1
function exportToExcel
- file: src/platform/reports/utils/exportUtils.ts:127
- kind: function
- core: platform
- spec: (none)
- summary: Export data to Excel format using wekanteam/exceljs
- score: 4
function exportToJSON
- file: src/platform/reports/utils/exportUtils.ts:172
- kind: function
- core: platform
- spec: (none)
- summary: Export data to JSON format
- score: 1
function exportToPDF
- file: src/platform/reports/utils/exportUtils.ts:188
- kind: function
- core: platform
- spec: (none)
- summary: Export data to PDF format using jspdf with tenant branding.
- score: 4
function exportZodSchemaAsJsonSchema
- file: src/platform/forms/utils/schemaExport.ts:170
- kind: function
- core: platform
- spec: (none)
- summary: Export any Zod schema as JSON Schema
- params:
- schema — Any Zod schema
- options — Export options
- returns: JSON Schema representation
- score: 4
function extractDistinctValues
- file: src/platform/import/mapping/valueMatching.ts:197
- kind: function
- core: platform
- spec: (none)
- summary: Extract distinct non-empty values and their row counts from a column in theparsed import rows.
- params:
- rows — All parsed rows from the import file.
- sourceColumn — The column name to extract values from.
- returns: A of distinct non-empty values.
- score: 4
function extractMentionedUserIds
- file: src/platform/messaging/utils/mentionParser.ts:62
- kind: function
- core: platform
- spec: (none)
- summary: Extract mentioned user IDs from rich mention syntax.
- score: 4
function extractSubdomain
- file: src/platform/theming/utils/subdomain.ts:105
- kind: function
- core: platform
- spec: (none)
- summary: Extract a tenant subdomain label from a browser host string.Returns the leading label (e.g. from ) whenthe host is a proper tenant subdomain, or in any other case:- Host equals the apex domain itself (no subdomain).- Host equals a known platform-level primary host (e.g. ).- The leading label is in the set.- The host does not appear to be a subdomain of at all.- is not provided (pre-auth page running in a dev env without the env var).
- params:
- host — (includes port if non-standard).
- apex — Value of (e.g. ). Pass to always return .
- score: 4
function extractTemplateVariables
- file: src/platform/notifications/utils/templateValidation.ts:9
- kind: function
- core: platform
- spec: (none)
- summary: Extract all variable_key placeholders from a template string
- score: 4
function extractVariables
- file: src/platform/templates/utils/variableResolver.ts:222
- kind: function
- core: platform
- spec: (none)
- summary: Extract all variable keys from a template string
- score: 4
function fetchBedCensusSummary
- file: src/platform/census/fetchBedCensusSummary.ts:25
- kind: function
- core: platform
- spec: (none)
- summary: Fetch org-scoped bed census totals aligned with visibility.
- score: 4
function fetchEntraPlatformSsoReady
- file: src/platform/auth/sso/useSsoSetup.ts:130
- kind: function
- core: platform
- spec: (none)
- summary: Platform-level SSO readiness (Supabase Azure provider configured by Encore ops).
- score: 4
function fetchEntraTenantId
- file: src/platform/integrations/hooks/useEntraSetup.ts:140
- kind: function
- core: platform
- spec: (none)
- summary: Load the org’s configured Entra tenant id after admin consent.
- score: 4
function fetchIntakeAuditSurface
- file: src/platform/ai/agentic/intake-audit-surface.ts:172
- kind: function
- core: platform
- spec: (none)
- summary: Fetch the content-free audit surface for one intake thread. Throws (fail-closed) on any Supabaseerror — including the RPC’s own when the caller lacks .Empty audit sets map to empty arrays (the RPC already returns , never null).
- score: 4
function filterByAllowlist
- file: src/platform/ai/mcp-config.ts:35
- kind: function
- core: platform
- spec: (none)
- summary: Filter requested MCP server IDs against the configured allowlist.
- score: 4
function filterByIndustry
- file: src/platform/templates/utils/templateIndustry.ts:93
- kind: function
- core: platform
- spec: (none)
- summary: Filter templates to those that belong to the specified industry. Returns the input array unchanged when is . Otherwise, returns only templates whose detected industry matches .
- params:
- templates — Array of templates (each must have a and may have a ) to filter
- industry — Industry to filter by; use to skip filtering
- returns: The filtered array of templates whose detected industry equals
- score: 4
function filterByJurisdiction
- file: src/platform/picklists/utils/referencePicklistUtils.ts:28
- kind: function
- core: platform
- spec: (none)
- summary: Filters picklist items by jurisdiction (state code). Items with (national) always pass. Items with no jurisdiction tag also pass. When is null/undefined, all items are returned.
- params:
- items — Array of picklist items to filter.
- stateCode — Two-letter state code (e.g. “AZ”), or null/undefined to skip filtering.
- returns: Filtered array of picklist items matching the jurisdiction.
- score: 4
function filterExpiredDrafts
- file: src/platform/forms/hooks/useDraftExpiration.ts:42
- kind: function
- core: platform
- spec: (none)
- summary: Filter expired drafts from a list
- score: 4
function filterFieldsForLayoutType
- file: src/platform/page-layouts/generators/fieldGroupingRules.ts:339
- kind: function
- core: platform
- spec: (none)
- summary: Get layout-type-specific field filtering.- List layouts: Only show primary/identifying fields- Create layouts: Exclude readonly/system fields- Edit layouts: Include all editable fields- Detail layouts: Include all viewable fields
- score: 4
function filterVisibleFields
- file: src/platform/page-layouts/utils/visibilityUtils.ts:35
- kind: function
- core: platform
- spec: (none)
- summary: Filter an array of fields by visibility for the current user role.
- score: 4
function filterWidgetsByModuleAccess
- file: src/platform/dashboard/utils/widget-access.ts:4
- kind: function
- core: platform
- spec: (none)
- summary: The single module-access filter (was duplicated in useDashboardWidgets + Dashboard.tsx).
- score: 4
function findActiveGroupItem
- file: src/platform/navigation/utils/active-nav-item.ts:155
- kind: function
- core: platform
- spec: (none)
- summary: Find the active item inside a single nav group.Resolution order: (if defined) → in declared order.
- score: 4
function findActiveModuleItem
- file: src/platform/navigation/utils/active-nav-item.ts:202
- kind: function
- core: platform
- spec: (none)
- summary: Module-aware active resolution used by ‘s collapsed rail.Search order: 1. → Overview chip 2. → Settings chip 3. flat 4. group s 5. group items
- score: 4
function findActiveNavItem
- file: src/platform/navigation/utils/active-nav-item.ts:127
- kind: function
- core: platform
- spec: (none)
- summary: Find the first item in a flat list whose route matches.
- score: 4
function findDuplicates
- file: src/platform/import/dedupe/matchCandidates.ts:125
- kind: function
- core: platform
- spec: (none)
- summary: Run deduplication across import records (intra-batch).
- params:
- records — Import records with and JSON.
- config — Deduplication configuration.
- returns: Deduplication result with candidates.
- score: 4
function findInvalidStepIcons
- file: src/platform/wizards/utils/auditStepIcons.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: Find every step across the supplied templates whose key is invalid.
- score: 4
function findItemById
- file: src/platform/conditional-logic/builder/utils.ts:139
- kind: function
- core: platform
- spec: (none)
- summary: Find an item by ID in the builder tree
- score: 4
function findParentGroup
- file: src/platform/conditional-logic/builder/utils.ts:159
- kind: function
- core: platform
- spec: (none)
- summary: Find the parent group of an item by ID
- score: 4
function findScopeDefinition
- file: src/platform/api-access/utils/key-utils.ts:184
- kind: function
- core: platform
- spec: (none)
- summary: Finds a scope definition by its scope string.
- score: 4
function findSectionForField
- file: src/platform/page-layouts/generators/fieldGroupingRules.ts:220
- kind: function
- core: platform
- spec: (none)
- summary: Find the appropriate section for a field based on grouping rules.
- score: 4
function findSubModuleByRoute
- file: src/platform/navigation/utils/sub-module-utils.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Find a sub-module by route within any module.Returns the first matching sub-module encountered (searching modules and theirnavGroups in registration order). When multiple sub-modules could match a pathname,the earliest match is returned.
- params:
- modules — Array of module definitions to search
- pathname — Current URL pathname to match
- returns: SubModuleMatch or null if no match found
- score: 4
function findUnsupportedVariables
- file: src/platform/notifications/utils/templateValidation.ts:23
- kind: function
- core: platform
- spec: (none)
- summary: Validate template variables against list of supported variable keys
- score: 4
function forgetAgentMemory
- file: src/platform/ai/agentic/agent-memory-adapters.ts:116
- kind: function
- core: platform
- spec: (none)
- summary: Hard-delete memory rows (TTL/purge/consent). Returns the count deleted.
- score: 4
variable formatBadgeCount
- file: src/platform/navigation/utils/badges.ts:12
- kind: variable
- core: platform
- spec: (none)
- summary: Format badge count with truncation for large numbers
- params:
- count — The badge count to format
- returns: Formatted badge string (e.g., “99+” for counts 99)
- score: 2
function formatBenefitsDeadline
- file: src/platform/onboarding/integrations/benefitsIntegration.ts:179
- kind: function
- core: platform
- spec: (none)
- summary: Format benefits deadline for display
- score: 4
function formatBoolean
- file: src/platform/table-v2/utils/formatters.ts:79
- kind: function
- core: platform
- spec: (none)
- summary: Formats boolean values for display.
- score: 4
function formatBytes
- file: src/platform/formatting/utils.ts:223
- kind: function
- core: platform
- spec: (none)
- summary: Format bytes into human-readable file size
- score: 4
variable formatCacheAge
- file: src/platform/dashboard/utils/widgetCache.ts:158
- kind: variable
- core: platform
- spec: (none)
- summary: Format cache age for display
- score: 1
function formatCellValue
- file: src/platform/reports/utils/exportUtils.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Format a cell value based on its type
- score: 4
function formatCellValue
- file: src/platform/table-v2/utils/formatters.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Formats cell values for display.
- score: 4
function formatColumnLabel
- file: src/platform/reports/utils/exportUtils.ts:18
- kind: function
- core: platform
- spec: (none)
- summary: Format a column label for display (capitalize, remove underscores)
- score: 4
function formatCompactNumber
- file: src/platform/formatting/utils.ts:197
- kind: function
- core: platform
- spec: (none)
- summary: Format a number with compact notation (K, M, B)Useful for dashboards and summary displays
- score: 4
function formatConversationName
- file: src/platform/messaging/utils/messageFormatter.ts:58
- kind: function
- core: platform
- spec: (none)
- summary: Format conversation display name.Public API for messaging integration — consumed by ConversationList and downstream cores.
- params:
- otherParticipantName — For DMs, the name of the other participant (not the current user)
- score: 4
function formatCsvValue
- file: src/platform/csv/parse.ts:76
- kind: function
- core: platform
- spec: (none)
- summary: Escape a string for use as a CSV field (e.g. for template generation).Wraps in quotes and doubles internal quotes when value contains comma, quote, or newline.
- score: 4
function formatCurrency
- file: src/platform/formatting/utils.ts:25
- kind: function
- core: platform
- spec: (none)
- summary: Format a number as currency
- score: 1
function formatCurrency
- file: src/platform/table-v2/utils/formatters.ts:64
- kind: function
- core: platform
- spec: (none)
- summary: Formats currency values for display.
- score: 4
function formatCustomFieldValue
- file: src/platform/custom-fields/utils.ts:176
- kind: function
- core: platform
- spec: (none)
- summary: Format a custom field value for display
- score: 4
function formatDate
- file: src/platform/formatting/utils.ts:46
- kind: function
- core: platform
- spec: (none)
- summary: Format a date according to the specified format
- score: 4
function formatDate
- file: src/platform/table-v2/utils/formatters.ts:46
- kind: function
- core: platform
- spec: (none)
- summary: Formats date values for display.
- score: 4
function formatDateRange
- file: src/platform/formatting/timezone.ts:219
- kind: function
- core: platform
- spec: (none)
- summary: Format date range with timezone
- params:
- startDate — Start date
- endDate — End date
- timeZone — IANA timezone identifier
- returns: Formatted date range string
- score: 4
function formatDateSemantic
- file: src/platform/formatting/utils.ts:102
- kind: function
- core: platform
- spec: (none)
- summary: Format a date using semantic presets (short, medium, long)
- example: | formatDateSemantic(new Date(), ‘short’) // “2/4/26”formatDateSemantic(new Date(), ‘medium’) // “Feb 4, 2026”formatDateSemantic(new Date(), ‘long’) // “Tuesday, February 4, 2026”
- score: 4
function formatDateSeparator
- file: src/platform/messaging/utils/messageFormatter.ts:27
- kind: function
- core: platform
- spec: (none)
- summary: Format a date for the date separator in message threads.Returns “Today”, “Yesterday”, or “Mon, Apr 7” for older dates.
- score: 4
function formatDateTime
- file: src/platform/formatting/utils.ts:66
- kind: function
- core: platform
- spec: (none)
- summary: Format a date with time
- score: 1
function formatDualLabel
- file: src/platform/timezone/cross-timezone-conflict.ts:125
- kind: function
- core: platform
- spec: (none)
- summary: Render an instant in both the source and destination site timezones so ascheduler sees, e.g., “Mar 3, 2:00 PM EST” and “Mar 3, 11:00 AM PST” for thesame moment (AC-5/AC-6 dual labels).
- score: 4
function formatDuration
- file: src/platform/formatting/utils.ts:241
- kind: function
- core: platform
- spec: (none)
- summary: Format a duration in milliseconds to human-readable string
- score: 4
function formatDuration
- file: src/platform/wizards/utils/formatDuration.ts:10
- kind: function
- core: platform
- spec: (none)
- summary: Formats seconds into a human-readable duration string
- params:
- seconds — Total seconds
- returns: Formatted string like “4m 32s” or “1h 23m”
- score: 4
function formatDurationCompact
- file: src/platform/wizards/utils/formatDuration.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Formats seconds into a compact string for charts
- params:
- seconds — Total seconds
- returns: Formatted string like “4:32” or “1:23:45”
- score: 4
function formatFieldValue
- file: src/platform/wizards/utils/value-formatters.ts:30
- kind: function
- core: platform
- spec: (none)
- summary: Format a field value based on field type
- score: 4
function formatFileSize
- file: src/platform/documents/utils/fileValidation.ts:113
- kind: function
- core: platform
- spec: (none)
- summary: Format file size in human-readable format
- score: 4
function formatFullTimestamp
- file: src/platform/messaging/utils/messageFormatter.ts:37
- kind: function
- core: platform
- spec: (none)
- summary: Format a full timestamp for tooltip display.
- score: 4
function formatInTimeZone
- file: src/platform/formatting/timezone.ts:89
- kind: function
- core: platform
- spec: (none)
- summary: Format a date in a specific timezone
- params:
- date — Date to format (Date object, ISO string, or timestamp)
- timeZone — IANA timezone identifier
- formatStr — date-fns format string
- returns: Formatted date string
- score: 4
function formatInUserTimeZone
- file: src/platform/formatting/timezone.ts:163
- kind: function
- core: platform
- spec: (none)
- summary: Format a date in the user’s local timezone
- params:
- date — Date to format
- formatStr — date-fns format string
- returns: Formatted date string in user’s timezone
- score: 4
function formatKpiValue
- file: src/platform/formatting/utils.ts:344
- kind: function
- core: platform
- spec: (none)
- summary: Format a KPI value for display when the value may be missing or not applicable.Use ”—” (em dash) instead of “0” or blank when there is no data yet or the metric does not apply.See UI_UX_STANDARDS.md § N/A and Zero States.
- score: 4
function formatLastUpdated
- file: src/platform/realtime/utils/formatLastUpdated.ts:9
- kind: function
- core: platform
- spec: (none)
- summary: PF-66: Shared time-ago formatter for realtime connection badges.
- example: | formatLastUpdated(new Date()) // → ‘Just now’formatLastUpdated(null) // → ‘Never’formatLastUpdated(new Date(Date.now() - 45_000)) // → ’45s ago’
- score: 4
function formatMessageRelativeTime
- file: src/platform/messaging/utils/messageFormatter.ts:18
- kind: function
- core: platform
- spec: (none)
- summary: Format timestamp as relative time.
- score: 4
function formatMessageTime
- file: src/platform/messaging/utils/messageFormatter.ts:11
- kind: function
- core: platform
- spec: (none)
- summary: Format timestamp for message display (time only).
- score: 4
function formatMultiSelectValue
- file: src/platform/wizards/utils/value-formatters.ts:92
- kind: function
- core: platform
- spec: (none)
- summary: Format multiselect values by looking up labels from options
- score: 4
function formatNumber
- file: src/platform/formatting/utils.ts:132
- kind: function
- core: platform
- spec: (none)
- summary: Format a number with locale-aware formatting
- score: 4
function formatNumber
- file: src/platform/table-v2/utils/formatters.ts:36
- kind: function
- core: platform
- spec: (none)
- summary: Formats number values for display.
- score: 4
function formatPercent
- file: src/platform/formatting/utils.ts:150
- kind: function
- core: platform
- spec: (none)
- summary: Format a number as percentage
- score: 1
function formatPhone
- file: src/platform/formatting/utils.ts:168
- kind: function
- core: platform
- spec: (none)
- summary: Format a phone number
- score: 1
function formatPhoneAsUserTypes
- file: src/platform/telephony/lib/phoneUtils.ts:133
- kind: function
- core: platform
- spec: (none)
- summary: Format phone number as user types: (XXX) XXX-XXXX (US 10-digit).
- score: 4
function formatPhoneDisplay
- file: src/platform/telephony/lib/phoneUtils.ts:72
- kind: function
- core: platform
- spec: (none)
- summary: Format phone number for display.Supports US format: (XXX) XXX-XXXX
- score: 4
function formatRawDataValue
- file: src/platform/data-manager/utils/rawDataCsvUtils.ts:11
- kind: function
- core: platform
- spec: (none)
- summary: Format a field value for CSV export
- score: 4
function formatSelectValue
- file: src/platform/wizards/utils/value-formatters.ts:81
- kind: function
- core: platform
- spec: (none)
- summary: Format a select value by looking up the label from options
- score: 4
function formatSignatureRequestsForCSV
- file: src/platform/signatures/utils/csvExport.ts:37
- kind: function
- core: platform
- spec: (none)
- summary: Convert signature requests to CSV string format.
- score: 4
function formatTableName
- file: src/platform/formatting/formatTableName.ts:13
- kind: function
- core: platform
- spec: (none)
- summary: Formats a table name by removing the core module prefix.
- params:
- tableName — The raw table name (e.g., ‘hr_employees’)
- returns: The formatted name (e.g., ‘employees’) or the original if null
- score: 4
function formatTime
- file: src/platform/formatting/utils.ts:112
- kind: function
- core: platform
- spec: (none)
- summary: Format time only
- score: 1
function formatUTCString
- file: src/platform/formatting/timezone.ts:183
- kind: function
- core: platform
- spec: (none)
- summary: Format a UTC date string for display in user’s timezoneConvenience function for displaying database timestamps.
- params:
- isoString — ISO 8601 date string from database
- formatStr — date-fns format string (default: ‘PPp’)
- returns: Formatted date string in user’s timezone
- score: 4
function fromZonedTime
- file: src/platform/formatting/timezone.ts:134
- kind: function
- core: platform
- spec: (none)
- summary: Convert a zoned date back to UTCTakes a date that represents local time in a timezoneand converts it to the equivalent UTC time.
- params:
- date — Date in local timezone
- timeZone — Source timezone
- returns: UTC Date object
- score: 4
function generateAllDefaultLayouts
- file: src/platform/page-layouts/generators/defaultLayoutGenerator.ts:235
- kind: function
- core: platform
- spec: (none)
- summary: Generate all four layout types for an object at once.
- score: 4
function generateApiSecret
- file: src/platform/api-access/utils/key-utils.ts:29
- kind: function
- core: platform
- spec: (none)
- summary: Generates a cryptographically random API secret.Format: pf_prefix_random40chars
- score: 4
function generateConditionId
- file: src/platform/conditional-logic/builder/utils.ts:24
- kind: function
- core: platform
- spec: (none)
- summary: Generate a unique ID for conditions
- score: 4
function generateCsv
- file: src/platform/export/utils/csvExport.ts:26
- kind: function
- core: platform
- spec: (none)
- summary: Generate CSV string from rows and column definitions.
- params:
- rows — Array of data objects
- columns — Column keys to include (order preserved). If omitted, uses keys from first row.
- returns: UTF-8 CSV string with headers
- score: 4
function generateCSV
- file: src/platform/data-manager/utils/csvUtils.ts:37
- kind: function
- core: platform
- spec: (none)
- summary: Generate CSV content from records
- score: 4
function generateDefaultLayout
- file: src/platform/page-layouts/generators/defaultLayoutGenerator.ts:130
- kind: function
- core: platform
- spec: (none)
- summary: Generate a complete default layout for an object/type combination.
- score: 4
function generateExcel
- file: src/platform/export/utils/excelExport.ts:20
- kind: function
- core: platform
- spec: (none)
- summary: Generate an Excel workbook buffer from one or more sheets.
- params:
- sheets — Array of sheet definitions
- returns: ArrayBuffer containing the .xlsx file
- score: 4
function generateFieldSchema
- file: src/platform/forms/validation.ts:83
- kind: function
- core: platform
- spec: (none)
- summary: Generate Zod schema from form field definition
- score: 4
function generateFormSchema
- file: src/platform/forms/validation.ts:246
- kind: function
- core: platform
- spec: (none)
- summary: Generate complete Zod schema from form definitionUses memoization to avoid regenerating schemas for unchanged field configurations
- score: 4
function generateGroupId
- file: src/platform/conditional-logic/builder/utils.ts:31
- kind: function
- core: platform
- spec: (none)
- summary: Generate a unique ID for groups
- score: 4
function generateInstanceId
- file: src/platform/wizards/utils/trackWizardEvent.ts:45
- kind: function
- core: platform
- spec: (none)
- summary: Generate a new instance ID for a wizard session
- score: 4
function generateJson
- file: src/platform/export/utils/jsonExport.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Generate JSON string from rows.
- params:
- rows — Array of data objects
- returns: Pretty-printed JSON string (2-space indent)
- score: 4
function generateKeyPrefix
- file: src/platform/api-access/utils/key-utils.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Generates a random 8-character key prefix (alphanumeric, lowercase).Used to identify keys without exposing the secret.
- score: 4
function generatePdf
- file: src/platform/documents/pdfGenerator.ts:155
- kind: function
- core: platform
- spec: (none)
- summary: Generate PDF from HTML element
- params:
- element — HTML element to convert
- options — Generation options
- returns: jsPDF instance
- score: 4
function generateRawDataCSV
- file: src/platform/data-manager/utils/rawDataCsvUtils.ts:73
- kind: function
- core: platform
- spec: (none)
- summary: Generate CSV content from raw data records
- score: 4
function generateRecommendations
- file: src/platform/query-performance/recommendation-engine.ts:73
- kind: function
- core: platform
- spec: (none)
- summary: Analyze slow query logs and produce index recommendations.Groups logs by , computes frequency and averageexecution time, and generates recommendations for the most impactfulpatterns.
- params:
- logs — Array of slow query performance log rows
- returns: Array of index recommendations sorted by impact (descending)
- score: 4
function generateRouteBreadcrumbSegments
- file: src/platform/navigation/utils/generate-route-breadcrumb-segments.ts:103
- kind: function
- core: platform
- spec: (none)
- summary: Build breadcrumb segments from a stripped pathname (no org prefix), module id, dynamic labels, and optional sub-module.
- score: 4
function generateSalt
- file: src/platform/auth/app-lock/pin-utils.ts:34
- kind: function
- core: platform
- spec: (none)
- summary: Generate a cryptographically random salt and return it as hex.
- score: 4
function generateSectionKey
- file: src/platform/page-layouts/utils.ts:209
- kind: function
- core: platform
- spec: (none)
- summary: Generate a unique section key from section_name
- score: 4
function generateSkillCode
- file: src/platform/ai/constants/skill-form.ts:145
- kind: function
- core: platform
- spec: (none)
- summary: Generate a normalized skill code from a human-readable name.Converts the name to lowercase, strips non-alphanumeric characters,replaces whitespace with underscores, and prefixes with if theresult starts with a digit.
- params:
- name — The human-readable skill name to convert.
- returns: A valid skill code string (max 50 characters).
- score: 4
function generateStoragePath
- file: src/platform/upload/service.ts:37
- kind: function
- core: platform
- spec: (none)
- summary: Generate storage path with tenant isolation.Pattern: orgId/entityType/entityId/timestamp_filename
- score: 4
function generateThumbnail
- file: src/platform/upload/image-utils.ts:348
- kind: function
- core: platform
- spec: (none)
- summary: Generate a thumbnail from an image.Uses cover mode by default (crop to fill).
- score: 4
function generateValidationId
- file: src/platform/conditional-logic/validation/utils.ts:8
- kind: function
- core: platform
- spec: (none)
- summary: Generate a unique validation ID
- score: 4
variable getActiveIconClasses
- file: src/platform/navigation/utils/active-state.ts:45
- kind: variable
- core: platform
- spec: (none)
- summary: Get active icon classes for navigation items
- params:
- isActive — Whether the navigation item is currently active
- returns: CSS classes for icon styling based on active state
- score: 2
variable getActiveIconSvgProps
- file: src/platform/navigation/utils/active-state.ts:54
- kind: variable
- core: platform
- spec: (none)
- summary: Keep icon geometry neutral for active state.Row background and rail provide active affordance, so icons should notvisually jump via stroke-width changes.
- score: 2
variable getActiveStateClasses
- file: src/platform/navigation/utils/active-state.ts:30
- kind: variable
- core: platform
- spec: (none)
- summary: Compatibility alias used throughout existing nav code.
- score: 2
function getAllFieldTypes
- file: src/platform/field-config/fieldTypes.ts:235
- kind: function
- core: platform
- spec: (none)
- summary: Get all field types for PF-17 DynamicFormRenderer
- score: 4
function getAllModuleSetupConfigs
- file: src/platform/setup/module-setup-registry.ts:90
- kind: function
- core: platform
- spec: (none)
- summary: All module setup configs (for Getting Started card).
- score: 4
function getAllowedExtensionsList
- file: src/platform/documents/utils/fileValidation.ts:102
- kind: function
- core: platform
- spec: (none)
- summary: Get a human-readable list of allowed extensions
- score: 4
function getAllowedMetadataKeys
- file: src/platform/wizards/utils/sanitizeAnalyticsEvent.ts:328
- kind: function
- core: platform
- spec: (none)
- summary: Gets a list of all allowed metadata keys (for documentation/testing)
- score: 4
function getAllowedTables
- file: src/platform/wizards/utils/crossModuleSubmit.ts:250
- kind: function
- core: platform
- spec: (none)
- summary: Get list of allowed tables for cross-module submission
- score: 4
function getAllowlistedMcpServers
- file: src/platform/ai/mcp-config.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Parse and return the list of allowlisted MCP server identifiers.Reads from the Deno edge-function environment and caches theparsed comma-separated server IDs.
- score: 4
function getAllRegisteredSteps
- file: src/platform/wizards/registry/utils.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Get all available step components (for builder UI)
- score: 4
function getAllScopes
- file: src/platform/api-access/utils/key-utils.ts:168
- kind: function
- core: platform
- spec: (none)
- summary: Returns all available scope strings from the registry.
- score: 4
function getAvailableFields
- file: src/platform/field-config/utils.ts:217
- kind: function
- core: platform
- spec: (none)
- summary: Get available field keys for entity type (standard + custom)
- score: 4
function getAvailableFunctions
- file: src/platform/wizards/utils/validationExpressionEvaluator.ts:582
- kind: function
- core: platform
- spec: (none)
- summary: Get available functions for autocomplete
- score: 4
function getAvailableLookupTables
- file: src/platform/data-lookup/lookupTables.ts:120
- kind: function
- core: platform
- spec: (none)
- summary: Get all available lookup tables
- score: 4
variable getBadgeClasses
- file: src/platform/navigation/utils/badges.ts:21
- kind: variable
- core: platform
- spec: (none)
- summary: Get badge CSS classes based on variant
- params:
- variant — Badge display variant (“dot” for collapsed sidebar, “badge” for expanded)
- returns: CSS classes for the badge
- score: 2
function getBenefitsUrgency
- file: src/platform/onboarding/integrations/benefitsIntegration.ts:52
- kind: function
- core: platform
- spec: (none)
- summary: Determine urgency level based on days until deadline
- score: 4
function getBindingStrictness
- file: src/platform/ai/mapping-targets/resolveTargets.ts:19
- kind: function
- core: platform
- spec: (none)
- summary: Read a binding’s enforcement policy, applying the default when itis unset. Use this instead of so the fail-open defaultlives in exactly one place (PF-15 PR9).
- score: 4
function getBlockAdapter
- file: src/platform/clinical/blocks/adapter-registry.ts:74
- kind: function
- core: platform
- spec: (none)
- summary: Resolve a typed-block adapter from the app singleton by any declared key.
- score: 4
function getBrowserCompatibility
- file: src/platform/telephony/lib/embeddable-utils.ts:264
- kind: function
- core: platform
- spec: (none)
- summary: Get comprehensive browser compatibility information
- score: 4
variable getCacheAge
- file: src/platform/dashboard/utils/widgetCache.ts:151
- kind: variable
- core: platform
- spec: (none)
- summary: Get age of cached data in milliseconds
- score: 2
variable getCachedWidgetData
- file: src/platform/dashboard/utils/widgetCache.ts:36
- kind: variable
- core: platform
- spec: (none)
- summary: Get cached widget data from IndexedDBValidates that cached data belongs to the requesting organization
- score: 2
variable getCacheKey
- file: src/platform/dashboard/utils/widgetCache.ts:21
- kind: variable
- core: platform
- spec: (none)
- summary: Generate a cache key scoped to organizationorganizationId is required for multi-tenant security
- score: 2
function getCacheStats
- file: src/platform/cache/monitoring.ts:15
- kind: function
- core: platform
- spec: (none)
- summary: Returns cache hit/miss counts and hit rate. Stats are global (all tenants) in Phase 1.
- score: 4
function getCanonicalRedirectUrl
- file: src/platform/theming/utils/canonical-redirect.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Determine if a canonical redirect is needed per the PF-95 redirect matrix.
- params:
- org — Organization record with subdomain fields
- currentHost — Current (e.g. )
- platformApex — Platform apex domain (e.g. )
- currentPathname — Current pathname (e.g. )
- currentSearch — Current search string (e.g. )
- returns: Redirect URL or if no redirect neededMatrix rules:- R1: Primary host + + eligible → 308 to - R2: Already on tenant subdomain host → no redirect- R3: Primary host, no path → no redirect (not applicable in OrgSlugRoute)- R4: Unknown subdomain host → no redirect- R5: Wrong subdomain for resolved org → deferred for MVP
- score: 4
function getCategoriesSorted
- file: src/platform/dashboard/widget-categories.ts:109
- kind: function
- core: platform
- spec: (none)
- summary: Get all categories sorted by order
- score: 4
function getCategoryConfig
- file: src/platform/dashboard/widget-categories.ts:102
- kind: function
- core: platform
- spec: (none)
- summary: Get category configuration by ID
- score: 4
function getCcbhcMeasureAggregates
- file: src/platform/clinical/measures/useClinicalMeasureAggregates.ts:67
- kind: function
- core: platform
- spec: (none)
- summary: Fetch de-identified CCBHC measure aggregates for an org/period.Delegates to the CL-owned SECURITY DEFINER RPC soPF-96 small-cell suppression runs server-side. Fail-closed: returns on anyerror, absent org, or empty measureCodes list. is injectable for tests.
- score: 4
function getChangeImpact
- file: src/platform/org-data-sync/api/change-impact.ts:26
- kind: function
- core: platform
- spec: (none)
- summary: Provides get change impact functionality.
- score: 4
function getClGroupBreadcrumbForPath
- file: src/platform/navigation/utils/cl-group-breadcrumbs.ts:55
- kind: function
- core: platform
- spec: (none)
- summary: Like , but also matches deeper CL routes by theirtop-level CL segment (e.g. resolves to the samegroup as ). Used to surface the parent nav group on detailand nested pages so users have a back-link to the correct section.
- score: 4
function getCoCMRegistryMembership
- file: src/platform/clinical/cocm-registry.ts:54
- kind: function
- core: platform
- spec: (none)
- summary: Look up the CoCM registry membership for a given enrollment.Stub: CL-54-EN-01 is not yet built. Returns so the gate engine gracefully degrades — CoCM billing periods land on theworklist rather than auto-posting (PM-75 AC-7.3).
- params:
- _enrollmentId — The UUID (unused in stub).
- returns: A with .
- score: 4
function getCompletedTours
- file: src/platform/help/useTour.ts:195
- kind: function
- core: platform
- spec: (none)
- summary: Get IDs of all completed tours.
- score: 4
function getConditionSummary
- file: src/platform/page-layouts/utils/evaluateVisibility.ts:60
- kind: function
- core: platform
- spec: (none)
- summary: Get a human-readable summary of a visibility condition.
- score: 4
function getCorePrimaryActionMap
- file: src/platform/modules/module-registry.ts:58
- kind: function
- core: platform
- spec: (none)
- summary: Returns the primary quick action for each module (first entry in ).
- score: 4
function getCrossModuleCompatibleSteps
- file: src/platform/wizards/registry/utils.ts:40
- kind: function
- core: platform
- spec: (none)
- summary: Get steps that are compatible with cross-module use
- score: 4
function getCurrentEmployeeId
- file: src/platform/workforce/getCurrentEmployeeId.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Get the current user’s employee ID for a given organizationUses an RPC call that bypasses RLS via SECURITY DEFINER
- score: 4
function getCurrentInstanceId
- file: src/platform/wizards/utils/trackWizardEvent.ts:53
- kind: function
- core: platform
- spec: (none)
- summary: Get the current wizard session instance ID
- score: 4
function getCurrentOrganizationIdSync
- file: src/platform/cache/org-resolver.ts:15
- kind: function
- core: platform
- spec: (none)
- summary: Sync getter for use outside React (e.g. in queryFn). Requires org to be passed or set elsewhere.
- score: 4
function getCustomFieldValue
- file: src/platform/custom-fields/utils.ts:12
- kind: function
- core: platform
- spec: (none)
- summary: Get a custom field value from an entity’s custom_fields JSONB
- score: 4
function getDefaultCustomFieldValues
- file: src/platform/custom-fields/utils.ts:159
- kind: function
- core: platform
- spec: (none)
- summary: Get default values for all custom fields
- score: 4
function getDefaultFieldConfigs
- file: src/platform/field-config/utils.ts:162
- kind: function
- core: platform
- spec: (none)
- summary: Get default configs for entity type (all standard + custom fields)
- score: 4
function getDefaultHeight
- file: src/platform/dashboard/utils/widget-heights.ts:63
- kind: function
- core: platform
- spec: (none)
- summary: Get default height in pixels for a widget size
- score: 4
function getDefaultPayrollTasks
- file: src/platform/onboarding/integrations/payrollIntegration.ts:217
- kind: function
- core: platform
- spec: (none)
- summary: Get all default payroll tasks for onboarding templates
- score: 4
function getDefaultWizardFeatureFlags
- file: src/platform/wizards/hooks/useWizardFeatureFlags.ts:102
- kind: function
- core: platform
- spec: (none)
- summary: Get default feature flags (for use in tests or when org context not available)
- score: 4
function getDisplayNameFromData
- file: src/platform/data-manager/utils/csvUtils.ts:241
- kind: function
- core: platform
- spec: (none)
- summary: Get display name from record data
- score: 4
function getDropzoneErrorMessage
- file: src/platform/documents/utils/fileValidation.ts:193
- kind: function
- core: platform
- spec: (none)
- summary: Get a user-friendly error message from dropzone rejection
- score: 4
function getEffectiveMobileSize
- file: src/platform/dashboard/utils/sizing.ts:148
- kind: function
- core: platform
- spec: (none)
- summary: Get effective mobile size for a widget
- score: 4
function getEffectiveSize
- file: src/platform/dashboard/utils/sizing.ts:78
- kind: function
- core: platform
- spec: (none)
- summary: Get the effective size for a widget, ensuring it’s valid
- score: 4
function getEmbeddableErrorMessage
- file: src/platform/telephony/lib/embeddable-utils.ts:396
- kind: function
- core: platform
- spec: (none)
- summary: Get user-friendly error message for embeddable errors
- score: 4
function getEventDefinition
- file: src/platform/events/eventDefinitionCache.ts:57
- kind: function
- core: platform
- spec: (none)
- summary: Fetch an event definition by name, using the shared query cache.Returns if the event is not registered.
- score: 4
function getEventGovernanceSettings
- file: src/platform/events/eventDefinitionCache.ts:89
- kind: function
- core: platform
- spec: (none)
- summary: Fetch event governance settings for an organization.Returns the validation mode and deprecation grace days.
- score: 4
function getExamOverlayContext
- file: src/platform/clinical/blocks/ros-exam/full-hp-gate.ts:96
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the exam-gate overlay context for an org + encounter.Fail-safe on the advisory side is wrong for an accreditation requirement, soeach lookup errs toward the raised requirement only when the data actuallysays so: a missing/unreadable election or chart flag reads (the orgsimply has no TJC gate), matching the additive-overlay semantics — this gatecan only ever add a requirement that is provably elected + indicated.
- params:
- ctx — tenant + encounter identifying the documentation instance.
- client — injectable Supabase-shaped client (defaults to the app client).
- returns: the overlay context driving .
- score: 4
function getFairnessMonitoredSurface
- file: src/platform/ai/constants/ai-fairness-surfaces.ts:91
- kind: function
- core: platform
- spec: (none)
- summary: Look up a monitored surface by its DSI feature key.
- score: 4
function getFieldDependents
- file: src/platform/conditional-logic/utils/evaluator.ts:197
- kind: function
- core: platform
- spec: (none)
- summary: Get list of fields that depend on a specific fieldUseful for determining which fields to re-evaluate when a field changes
- params:
- rules — Map of field keys to their conditional rules
- fieldKey — The field key that changed
- returns: Array of field keys that depend on the changed field
- score: 4
function getFieldValidationState
- file: src/platform/forms/validationV2.ts:155
- kind: function
- core: platform
- spec: (none)
- summary: Get validation state for a specific field
- params:
- field — Field definition
- formData — Current form data
- fieldValue — Current field value
- returns: Field validation state
- score: 4
variable getFlyoutOpenStateClasses
- file: src/platform/navigation/utils/active-state.ts:36
- kind: variable
- core: platform
- spec: (none)
- summary: Subtle open-state treatment for flyout triggers.Keep this lower-emphasis than true route-active rows.
- score: 2
function getFormPages
- file: src/platform/forms/utils/pdfExportSettingsAccessor.ts:90
- kind: function
- core: platform
- spec: (none)
- summary: Retrieves the pages array from a form’s settings if present and valid. Safely extracts the array from when conform to .
- params:
- form — The form definition to read settings from
- returns: The array from the form’s settings, or if settings are missing or invalid
- score: 4
function getFWFieldTypes
- file: src/platform/field-config/fieldTypes.ts:228
- kind: function
- core: platform
- spec: (none)
- summary: Get field types available for FW Form BuilderExcludes PF-17 only types
- score: 4
function getGlobalRecorderState
- file: src/platform/analytics/sessionRecorder.ts:431
- kind: function
- core: platform
- spec: (none)
- summary: Get global recorder state
- score: 1
function getGroupDepth
- file: src/platform/conditional-logic/builder/utils.ts:173
- kind: function
- core: platform
- spec: (none)
- summary: Get the depth of a group in the tree
- score: 4
function getHandler
- file: src/platform/bulk-operations/processor.ts:26
- kind: function
- core: platform
- spec: (none)
- summary: Get a registered handler for an entity type.
- score: 4
function getHiddenFields
- file: src/platform/page-layouts/utils/evaluateVisibility.ts:86
- kind: function
- core: platform
- spec: (none)
- summary: Get all fields that are hidden by visibility rules for the given form values.Useful for excluding hidden fields from form submission.
- score: 4
function getHighestUnreadPriority
- file: src/platform/notifications/utils/groupNotifications.ts:78
- kind: function
- core: platform
- spec: (none)
- summary: Returns the highest priority level from all unread notifications.
- score: 4
function getHubTabLabel
- file: src/platform/navigation/hub-tab-labels.ts:154
- kind: function
- core: platform
- spec: (none)
- summary: Returns the display label for the active tab when on a hub route with ?tab=, or null.Supports both literal hub paths (e.g. ) and parameterized hub paths(e.g. ) via single-segment wildcard matching.
- score: 4
function getIdentifierOptions
- file: src/platform/data-manager/utils/rawDataImportUtils.ts:187
- kind: function
- core: platform
- spec: (none)
- summary: Get identifier column options from existing records
- score: 4
function getImageDimensions
- file: src/platform/upload/image-utils.ts:160
- kind: function
- core: platform
- spec: (none)
- summary: Get dimensions of an image file.
- score: 4
function getIndustryFromTemplate
- file: src/platform/templates/utils/templateIndustry.ts:34
- kind: function
- core: platform
- spec: (none)
- summary: Classifies a template into an industry category based on its name and description.Checks the combined lowercase name and description against prioritized keyword sets:healthcare → hr → compliance → general (fallback). The first matching category is returned.
- params:
- template — name: string; description?: string | null Object with the template and optional to inspect for keywords.
- returns: ‘healthcare’ | ‘hr’ | ‘compliance’ | ‘general’ — The detected industry category.
- example: | // returns ‘hr’getIndustryFromTemplate( name: ‘Employee Onboarding Checklist’, description: ” );
- score: 4
function getInstallHelpUrl
- file: src/platform/pwa/utils/platformDetection.ts:71
- kind: function
- core: platform
- spec: (none)
- summary: Returns the appropriate “Learn more about installing” URLbased on the current platform.
- score: 4
function getLayoutedDiagram
- file: src/platform/workflow/utils/dagreLayout.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Applies Dagre-based automatic layout to diagram content nodes.Structural nodes (groups, lane headers) are passed through unchanged.Content nodes receive updated values from the Dagre algorithm.The Dagre graph uses center-based positioning, which is converted toReact Flow’s top-left origin.
- params:
- nodes — All diagram nodes
- edges — All diagram edges
- direction — Layout direction: ‘TB’ (top-to-bottom) or ‘LR’ (left-to-right)
- returns: Object with repositioned nodes and unchanged edges
- score: 4
function getLineageByDestination
- file: src/platform/org-data-sync/api/lineage.ts:72
- kind: function
- core: platform
- spec: (none)
- summary: Provides get lineage by destination functionality.
- score: 4
function getLineageBySource
- file: src/platform/org-data-sync/api/lineage.ts:51
- kind: function
- core: platform
- spec: (none)
- summary: Provides get lineage by source functionality.
- score: 4
function getLoginSsoState
- file: src/platform/auth/sso/useSsoSetup.ts:139
- kind: function
- core: platform
- spec: (none)
- summary: Read the org’s Login SSO state for the settings surface.
- score: 4
function getLookupFilterableColumns
- file: src/platform/data-lookup/lookupTables.ts:135
- kind: function
- core: platform
- spec: (none)
- summary: Get filterable column metadata for a lookup table.Returns an empty array if the table has no filterable columns.
- score: 4
function getLookupFilterPresets
- file: src/platform/data-lookup/lookupTables.ts:142
- kind: function
- core: platform
- spec: (none)
- summary: Get quick-apply filter presets for a lookup table.
- score: 4
function getLookupTableConfig
- file: src/platform/data-lookup/lookupTables.ts:113
- kind: function
- core: platform
- spec: (none)
- summary: Get lookup table configuration
- score: 4
function getMaxDepth
- file: src/platform/conditional-logic/builder/utils.ts:211
- kind: function
- core: platform
- spec: (none)
- summary: Get the maximum depth in a group tree
- score: 4
function getMaxHeight
- file: src/platform/dashboard/utils/widget-heights.ts:70
- kind: function
- core: platform
- spec: (none)
- summary: Get maximum height in pixels for a widget size
- score: 4
function getMinHeight
- file: src/platform/dashboard/utils/widget-heights.ts:56
- kind: function
- core: platform
- spec: (none)
- summary: Get minimum height in pixels for a widget size
- score: 4
function getMobileSizeFromDesktop
- file: src/platform/dashboard/utils/sizing.ts:141
- kind: function
- core: platform
- spec: (none)
- summary: Get mobile size from desktop size (for auto-mapping)
- score: 4
function getMobileWidgetClasses
- file: src/platform/dashboard/utils/sizing.ts:183
- kind: function
- core: platform
- spec: (none)
- summary: Get Tailwind classes for mobile widget size
- score: 4
function getModuleDisplayName
- file: src/platform/wizards/hooks/useCrossModuleWizard.ts:174
- kind: function
- core: platform
- spec: (none)
- summary: Get display name for a module
- score: 1
function getModuleDocsUrl
- file: src/platform/docs/module-docs-map.ts:97
- kind: function
- core: platform
- spec: (none)
- summary: Provides get module docs url functionality.
- score: 4
function getModuleFromPathname
- file: src/platform/navigation/utils/navigation-utils.ts:31
- kind: function
- core: platform
- spec: (none)
- summary: Get module definition from pathname.Strips org prefix before matching so /o/:slug/ce/… resolves correctly.
- score: 4
function getModuleIcon
- file: src/platform/wizards/utils/moduleIcons.ts:47
- kind: function
- core: platform
- spec: (none)
- summary: Get the icon for a module, with fallback
- score: 4
function getModulePrefix
- file: src/platform/navigation/utils/navigation-utils.ts:53
- kind: function
- core: platform
- spec: (none)
- summary: Get the module prefix from a route (e.g., “/fw/dashboard” - “/fw”)
- score: 4
function getModuleRegistry
- file: src/platform/modules/module-registry.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Full module definitions populated asynchronously by .Before preload completes this array may be empty — prefer or in React / after preload.
- score: 4
function getModuleSetupConfig
- file: src/platform/setup/module-setup-registry.ts:85
- kind: function
- core: platform
- spec: (none)
- summary: Get setup config for a module by id. Returns undefined if not in registry.
- score: 4
function getModuleSubRoute
- file: src/platform/navigation/utils/navigation-utils.ts:73
- kind: function
- core: platform
- spec: (none)
- summary: Get the sub-route within a module (e.g., “/hr/employees/123” - “employees/123”)
- score: 4
function getModuleTooltipKeys
- file: src/platform/help/tooltip-content.ts:638
- kind: function
- core: platform
- spec: (none)
- summary: Get all tooltip keys for a module.
- score: 4
variable getNavRowStateClasses
- file: src/platform/navigation/utils/active-state.ts:23
- kind: variable
- core: platform
- spec: (none)
- summary: Unified row-state classes for navigation surfaces.This keeps hover/active parity across sidebar, module, sub-module, and flyout rows.
- score: 2
function getNextDisplayOrder
- file: src/platform/page-layouts/utils.ts:179
- kind: function
- core: platform
- spec: (none)
- summary: Get the next display_order value for a new item
- score: 4
function getNextPayrollAction
- file: src/platform/onboarding/integrations/payrollIntegration.ts:92
- kind: function
- core: platform
- spec: (none)
- summary: Get the next action for payroll setup
- score: 4
variable getNotificationCategory
- file: src/platform/notifications/utils/notificationTypes.ts:262
- kind: variable
- core: platform
- spec: (none)
- summary: Provides get notification category functionality.
- score: 2
variable getNotificationConfig
- file: src/platform/notifications/utils/notificationTypes.ts:241
- kind: variable
- core: platform
- spec: (none)
- summary: Provides get notification config functionality.
- score: 2
variable getNotificationIcon
- file: src/platform/notifications/utils/notificationTypes.ts:255
- kind: variable
- core: platform
- spec: (none)
- summary: Provides get notification icon functionality.
- score: 2
function getOperatorLabel
- file: src/platform/wizards/utils/evaluateBranchCondition.ts:126
- kind: function
- core: platform
- spec: (none)
- summary: Get operator label for display
- score: 4
function getOperatorsForFieldType
- file: src/platform/wizards/utils/evaluateBranchCondition.ts:150
- kind: function
- core: platform
- spec: (none)
- summary: Get operators available for a field type
- score: 4
function getOptionFieldTypes
- file: src/platform/field-config/fieldTypes.ts:242
- kind: function
- core: platform
- spec: (none)
- summary: Get field types that support options/choices
- score: 4
function getOrganizationUploadSettings
- file: src/platform/upload/validation.ts:65
- kind: function
- core: platform
- spec: (none)
- summary: Fetch organization upload settings from pf_module_settings.Falls back to defaults if settings not found.
- score: 4
function getPageNumbers
- file: src/platform/table-v2/utils/pagination/utils.ts:137
- kind: function
- core: platform
- spec: (none)
- summary: Get an array of page numbers for pagination UIReturns a smart range of page numbers with ellipsis indicators (-1)
- params:
- currentPage — Current page number
- totalPages — Total number of pages
- maxVisible — Maximum visible page numbers (default 7)
- returns: Array of page numbers (-1 indicates ellipsis)
- score: 4
function getPayrollCompletionMessage
- file: src/platform/onboarding/integrations/payrollIntegration.ts:105
- kind: function
- core: platform
- spec: (none)
- summary: Get completion message for payroll section
- score: 4
function getPayrollSetupState
- file: src/platform/onboarding/integrations/payrollIntegration.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Get the overall payroll setup state
- score: 4
function getPdfExportSettings
- file: src/platform/forms/utils/pdfExportSettingsAccessor.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: Extracts the PDF export settings from a form’s settings. Validates the form’s settings and returns the configuration when present and well-formed; returns if the settings or are missing or invalid.
- params:
- form — The form definition to read settings from
- returns: The object when present and valid, otherwise
- score: 4
function getPicklistCategoryLabel
- file: src/platform/picklists/constants.ts:35
- kind: function
- core: platform
- spec: (none)
- summary: Display label for a category value (falls back to the raw value).
- score: 4
function getPicklistItemStyle
- file: src/platform/picklists/utils/referencePicklistUtils.ts:61
- kind: function
- core: platform
- spec: (none)
- summary: Extracts style information (color, icon) from a picklist item’s metadata.
- params:
- item — The picklist item to extract style from.
- returns: A with color and icon strings. Falls back to gray/circle defaults.
- score: 4
function getPinnableIcon
- file: src/platform/navigation/pinnable-icons.ts:62
- kind: function
- core: platform
- spec: (none)
- summary: Resolve stored icon name to LucideIcon; returns fallback if invalid.
- score: 4
function getPinnedActionKeysFromPreferences
- file: src/platform/dashboard/utils/normalize-quick-action-preferences.ts:79
- kind: function
- core: platform
- spec: (none)
- summary: Returns ordered pinned action keys from preferences (stable order field).
- score: 4
function getPlanAmendments
- file: src/platform/clinical/plan/record-amendment.ts:107
- kind: function
- core: platform
- spec: (none)
- summary: Read a plan’s amendment trail (newest first), org-scoped.Throws on failure instead of collapsing to — an empty array isindistinguishable from “no amendments exist” and would let a read failureon the regulatory amendment trail masquerade as a clean history.
- score: 4
function getPortalRunStatus
- file: src/platform/automation/portal/seam.ts:82
- kind: function
- core: platform
- spec: (none)
- summary: Fetch a run’s terminal status + per-step audit trail (RLS-scoped to the org).
- score: 4
function getPresetById
- file: src/platform/onboarding/integrations/milestonePresets.ts:196
- kind: function
- core: platform
- spec: (none)
- summary: Get preset by ID
- score: 1
function getPresetDisplayInfo
- file: src/platform/onboarding/integrations/milestonePresets.ts:269
- kind: function
- core: platform
- spec: (none)
- summary: Get display info for a preset
- score: 1
function getProhibitedKeys
- file: src/platform/wizards/utils/sanitizeAnalyticsEvent.ts:321
- kind: function
- core: platform
- spec: (none)
- summary: Gets a list of all prohibited keys (for documentation/testing)
- score: 4
function getPushPlatformName
- file: src/platform/pwa/utils/platformDetection.ts:48
- kind: function
- core: platform
- spec: (none)
- summary: Returns a user-friendly platform name string.Useful for diagnostics and platform-aware UI.
- score: 4
function getQueryCacheStats
- file: src/platform/offline/queryPersistence.ts:330
- kind: function
- core: platform
- spec: (none)
- summary: Get storage statistics
- score: 1
function getQuickActionKey
- file: src/platform/navigation/quick-action-catalog.ts:59
- kind: function
- core: platform
- spec: (none)
- summary: Returns the explicit action key from a registry action, or a computed default.
- params:
- moduleId — Owning module id
- navGroupId — Optional nav subgroup id
- route — Navigation route
- action — Registry quick action (optional override)
- score: 4
function getRawDataCSVFilename
- file: src/platform/data-manager/utils/rawDataCsvUtils.ts:112
- kind: function
- core: platform
- spec: (none)
- summary: Generate a filename for the CSV export
- score: 4
function getRecommendedAction
- file: src/platform/onboarding/integrations/benefitsIntegration.ts:84
- kind: function
- core: platform
- spec: (none)
- summary: Get recommended action based on benefits status
- score: 4
function getRegisteredPluginDataScopes
- file: src/platform/dashboard/plugins/index.ts:18
- kind: function
- core: platform
- spec: (none)
- summary: All data scopes declared by registered plugins — the client-side mirror of what the broker must server-side allowlist. Surfaced for governance/audit (drift between the two is a finding).
- score: 4
function getReproducibleMeasureAggregates
- file: src/platform/clinical/measures/useClinicalMeasureAggregates.ts:105
- kind: function
- core: platform
- spec: (none)
- summary: Engine-backed, REPRODUCIBLE counterpart of .Reads de-identified, PF-96-suppressed numerator/denominator counts from the CL-51engine’s immutable result snapshots () rather than alive re-compute, so a published rate re-derives deterministically (CL-51NFR-reliability-1 / CL-51-EN-01). Same de-identified, fail-closed contract.
- score: 4
function getResolvedSurfaceBlocks
- file: src/platform/clinical/blocks/getResolvedSurfaceBlocks.ts:41
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the ordered, source-tagged block set for a documentation surface.
- params:
- params — the surface + tenant/site/encounter to resolve for.
- client — injectable Supabase-shaped client (defaults to the app client; overridden in tests).
- returns: the resolved surface; an empty array on any error (fail-closed).
- score: 4
function getRetryStatus
- file: src/platform/notifications/utils/retry.ts:68
- kind: function
- core: platform
- spec: (none)
- summary: Gets human-readable retry status message.
- params:
- retryCount — Current retry count
- lastAttempt — Date of last attempt (optional)
- returns: Status message
- score: 4
function getRoleLabel
- file: src/platform/data-manager/hooks/useAvailableRoles.ts:164
- kind: function
- core: platform
- spec: (none)
- summary: Provides the user-facing label for a role identifier.Maps a system role to its configured display label; for non-system roles the input string is returned as a fallback.
- params:
- role — The role identifier, either an AppRole (system role) or a custom role string
- returns: The display label for the given role; if the role is not a known system role, returns the role string itself
- score: 4
function getRoleOrder
- file: src/platform/data-manager/hooks/useAvailableRoles.ts:178
- kind: function
- core: platform
- spec: (none)
- summary: Determine the display sort order for a role. Returns the configured order for known system roles; custom or unknown roles receive a high default order so they appear after system roles.
- params:
- role — (AppRole | string) Role identifier: a system AppRole or a custom role ID
- returns: number - The numeric order for sorting: the system role’s configured order, or 999 for custom/unknown roles
- score: 4
function getRuleVersion
- file: src/platform/conditional-logic/utils/migration.ts:16
- kind: function
- core: platform
- spec: (none)
- summary: Detect the version of a conditional rule
- params:
- rule — The rule to check
- returns: 1 for V1 rules, 2 for V2 rules
- score: 4
function getSampleContentForSection
- file: src/platform/templates/lib/template-sample-data.ts:59
- kind: function
- core: platform
- spec: (none)
- summary: Return realistic sample content for a document template section.Matches the section name (case-insensitive, partial match) against a libraryof healthcare-relevant sample paragraphs. Falls back to a generic paragraphwhen no match is found.
- params:
- sectionName — The name of the template section (e.g., “Purpose”, “Scope”).
- _templateType — Reserved for future per-type customization.
- returns: A multi-line sample string suitable for PDF preview rendering.
- score: 4
function getSampleMetadata
- file: src/platform/templates/lib/template-sample-data.ts:86
- kind: function
- core: platform
- spec: (none)
- summary: Generate sample metadata for document template preview.Returns realistic placeholder values for author, version, document number,and effective date fields typically shown in templated PDF output.
- returns: An object with sample metadata fields.
- score: 4
function getSentry
- file: src/platform/monitoring/sentry.ts:31
- kind: function
- core: platform
- spec: (none)
- summary: Returns the cached Sentry module after initialization, or null if init has not run.
- score: 4
function getSessionRecorder
- file: src/platform/analytics/sessionRecorder.ts:386
- kind: function
- core: platform
- spec: (none)
- summary: Get or create global session recorder
- params:
- config — Configuration (only used on first call)
- returns: Global session recorder instance
- score: 4
function getSiblingSubModules
- file: src/platform/navigation/utils/sub-module-utils.ts:88
- kind: function
- core: platform
- spec: (none)
- summary: Get sibling sub-modules (all sub-modules in the same parent module).Returns all sub-modules including the current one for display purposes.
- params:
- module — Parent module definition
- returns: Array of sub-modules in the parent module
- score: 4
function getStepComponent
- file: src/platform/wizards/registry/utils.ts:12
- kind: function
- core: platform
- spec: (none)
- summary: Get a step component by its ID
- score: 4
function getStepsByModulesForCrossModule
- file: src/platform/wizards/registry/utils.ts:47
- kind: function
- core: platform
- spec: (none)
- summary: Get steps available for a set of modules (for cross-module wizards)
- score: 4
function getStepsForModule
- file: src/platform/wizards/registry/utils.ts:19
- kind: function
- core: platform
- spec: (none)
- summary: Get all registered steps for a specific module
- score: 4
function getStorageValue
- file: src/platform/navigation/utils/navigation-utils.ts:94
- kind: function
- core: platform
- spec: (none)
- summary: Safe localStorage getter with JSON parsing
- score: 4
function getStoredBiometricCredential
- file: src/platform/auth/app-lock/biometric-utils.ts:157
- kind: function
- core: platform
- spec: (none)
- summary: Get the stored biometric credential reference, or null.
- score: 4
function getStoredPinDerived
- file: src/platform/auth/app-lock/pin-utils.ts:102
- kind: function
- core: platform
- spec: (none)
- summary: Retrieve the stored derived PIN + salt, or if not set.
- score: 4
function getStoredSessions
- file: src/platform/analytics/sessionRecorder.ts:469
- kind: function
- core: platform
- spec: (none)
- summary: Get stored sessions
- score: 1
function getSubModuleDefaultRoute
- file: src/platform/navigation/utils/route-utils.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Get the default navigable route for a sub-module.Falls back through: overviewRoute - first item route - fallback module route - ”/”
- params:
- subModule — The sub-module to get the route for
- fallbackModule — Optional parent module for fallback route
- returns: The best available route for navigation
- score: 4
function getSubModuleForPath
- file: src/platform/navigation/utils/generate-route-breadcrumb-segments.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: Detect if current path is within a known sub-module.Returns the sub-module if found, null otherwise.
- score: 4
function getSubModulePrefix
- file: src/platform/navigation/utils/sub-module-utils.ts:60
- kind: function
- core: platform
- spec: (none)
- summary: Get the route prefix for a sub-module (e.g., “/hr/ats”)
- score: 4
function getSubModules
- file: src/platform/navigation/utils/sub-module-utils.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Get all sub-modules for a specific module
- score: 4
function getSurfaceDocumentationCompleteness
- file: src/platform/clinical/completeness/getSurfaceDocumentationCompleteness.ts:105
- kind: function
- core: platform
- spec: (none)
- summary: Compute an encounter/surface’s documentation completeness from the CL-75resolved required set.
- params:
- params — the surface + tenant/encounter to score.
- deps — injectable client/registry/clock (defaults to the app singletons).
- returns: the completeness result; fail-closed (incomplete) on resolution failure.
- score: 4
function getSystemRolesByCategory
- file: src/platform/permissions/components/RoleSelector.tsx:277
- kind: function
- core: platform
- spec: (none)
- summary: Get system role options grouped by category
- score: 4
function getTableContract
- file: src/platform/wizards/audit/sources/types-source.ts:37
- kind: function
- core: platform
- spec: (none)
- summary: Parse a table’s Insert block from the generated types.ts.A column without a trailing on its Insert line is NOT NULL with no default(required on insert); a column with is nullable or defaulted (optional).
- score: 4
function getTableContractLive
- file: src/platform/wizards/audit/sources/live-source.ts:58
- kind: function
- core: platform
- spec: (none)
- summary: Live table contract from information_schema (NOT NULL with no default = required).GENERATED ALWAYS / identity columns also present as + no, but they are NOT insertable, so they are excluded from (via /) while still appearing in thefull list. The static types.ts lane gets this for free: Supabase marksthose columns optional () in the generated Insert type.
- score: 4
function getTableEnums
- file: src/platform/wizards/audit/sources/types-source.ts:98
- kind: function
- core: platform
- spec: (none)
- summary: Map each enum-typed Insert column of to its DB enum’s member values,read entirely from the generated types.ts (the annotation + the top-level map). Non-enum columns are omitted. Returns for a table with noInsert block or no enum columns.Fully static — no live stack required (issue #1183: the linkage IS in types.ts).
- score: 4
function getTableEnumsLive
- file: src/platform/wizards/audit/sources/live-source.ts:87
- kind: function
- core: platform
- spec: (none)
- summary: Live column to enum-members map (USER-DEFINED columns joined to pg_enum).
- score: 4
function getTagLabel
- file: src/platform/wizards/config/marketplaceTags.ts:65
- kind: function
- core: platform
- spec: (none)
- summary: Get tag label by value.Function is case-insensitive. If the tag value is not found,a warning is logged in non-production environments and theraw value is returned as a fallback.
- params:
- value — The tag value to look up
- returns: The label for the tag, or the raw value if not found
- score: 4
function getTagsByCategory
- file: src/platform/wizards/config/marketplaceTags.ts:51
- kind: function
- core: platform
- spec: (none)
- summary: Get tags filtered by category.
- score: 4
function getTargetSchema
- file: src/platform/import/mapping/targetSchemas.ts:112
- kind: function
- core: platform
- spec: (none)
- summary: Get target field definitions for an entity type.Returns an empty array for unknown/custom types.
- score: 4
function getTaskPrefillFromTemplate
- file: src/platform/tasks/hooks/useTaskTemplateMutation.ts:93
- kind: function
- core: platform
- spec: (none)
- summary: Generate a task prefill payload from a template
- score: 4
function getTbScreeningIndicator
- file: src/platform/clinical/blocks/ros-exam/tb-screening.ts:83
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the TB-screening-due indicator for a residential admission from theorg’s PF-96 jurisdiction profile.
- params:
- params — the org/site + admission date.
- client — injectable Supabase-shaped client (defaults to the app client).
- returns: the indicator, or when the resolved profile carries no TB-screening window (never a hardcoded default).
- score: 4
function getTemplateById
- file: src/platform/reports/templates/reportTemplates.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Provides get template by id functionality.
- score: 4
function getTemplateById
- file: src/platform/roles/components/starter-role-templates.ts:619
- kind: function
- core: platform
- spec: (none)
- summary: Provides get template by id functionality.
- score: 4
function getTemplateContractLive
- file: src/platform/wizards/audit/sources/live-source.ts:34
- kind: function
- core: platform
- spec: (none)
- summary: The live seeded template for a wizard_type (prefers the global/system row).
- score: 4
function getTemplatesByCategory
- file: src/platform/picklists/data/picklistTemplates.ts:138
- kind: function
- core: platform
- spec: (none)
- summary: Group templates by category
- score: 1
function getTemplatesByCategory
- file: src/platform/reports/templates/reportTemplates.ts:25
- kind: function
- core: platform
- spec: (none)
- summary: Provides get templates by category functionality.
- score: 4
function getThrottleStatus
- file: src/platform/workflow/execution.ts:152
- kind: function
- core: platform
- spec: (none)
- summary: Read FW-53 rate-limit configs + the latest execution counters for an org(optionally scoped to a workflow definition) and compute an advisory throttlesnapshot. Does NOT mutate or block — pairs with the accept-and-hold model.Reads are org-scoped (RLS-enforced for authenticated callers).
- score: 4
function getTimeZoneAbbreviation
- file: src/platform/formatting/timezone.ts:195
- kind: function
- core: platform
- spec: (none)
- summary: Get timezone abbreviation for a date
- params:
- date — Date to check
- timeZone — IANA timezone identifier
- returns: Timezone abbreviation (e.g., ‘EST’, ‘PDT’)
- score: 4
function getTimeZoneOffset
- file: src/platform/formatting/timezone.ts:152
- kind: function
- core: platform
- spec: (none)
- summary: Get the UTC offset in minutes for a timezone at a specific date
- params:
- timeZone — IANA timezone identifier
- date — Date to check (defaults to now)
- returns: Offset in minutes (positive = ahead of UTC)
- score: 4
function getTimezoneOptions
- file: src/platform/formatting/timezone.ts:243
- kind: function
- core: platform
- spec: (none)
- summary: Get list of common timezones with labels
- returns: Array of timezone options for select inputs
- score: 4
function getTooltipContent
- file: src/platform/help/tooltip-content.ts:613
- kind: function
- core: platform
- spec: (none)
- summary: Get tooltip content for a specific field in a module.Returns undefined if not found.
- score: 4
variable getTypesByCategory
- file: src/platform/notifications/utils/notificationTypes.ts:269
- kind: variable
- core: platform
- spec: (none)
- summary: Provides get types by category functionality.
- score: 2
function getUniqueSections
- file: src/platform/forms/utils/sectionPageMapping.ts:48
- kind: function
- core: platform
- spec: (none)
- summary: Get unique sections from field configurations
- score: 4
function getUserMediaPermission
- file: src/platform/telephony/lib/embeddable-utils.ts:232
- kind: function
- core: platform
- spec: (none)
- summary: Get microphone access status (cached check)
- score: 4
function getUserTimeZone
- file: src/platform/formatting/timezone.ts:66
- kind: function
- core: platform
- spec: (none)
- summary: Get the user’s current timezone
- returns: IANA timezone identifier (e.g., ‘America/New_York’)
- score: 4
function getValidationDependencies
- file: src/platform/conditional-logic/validation/utils.ts:84
- kind: function
- core: platform
- spec: (none)
- summary: Get all fields involved in validations (for dependency tracking)
- score: 4
function getValidationFunction
- file: src/platform/wizards/utils/validationFunctions.ts:437
- kind: function
- core: platform
- spec: (none)
- summary: Get a validation function by name.Function lookup is case-insensitive - the name is normalized to lowercase.
- params:
- name — Function name (any case accepted)
- returns: The validation function or undefined if not found
- score: 4
function getValidationFunctionNames
- file: src/platform/wizards/utils/validationFunctions.ts:427
- kind: function
- core: platform
- spec: (none)
- summary: Get all available validation function names.Returns canonical lowercase names as defined in the validationFunctions object.
- score: 4
function getValidOperators
- file: src/platform/table-v2/utils/filter/utils.ts:61
- kind: function
- core: platform
- spec: (none)
- summary: Get list of valid operators for error messages.Returns a shallow copy to prevent mutation of the internal list.
- score: 4
function getWidgetContentClasses
- file: src/platform/dashboard/utils/sizing.ts:55
- kind: function
- core: platform
- spec: (none)
- summary: Get size-specific Tailwind classes for widget content
- params:
- size — The widget size
- isMobile — Whether to use mobile-optimized sizing
- score: 4
function getWidgetGridSpan
- file: src/platform/dashboard/utils/sizing.ts:42
- kind: function
- core: platform
- spec: (none)
- summary: Get CSS Grid span styles for a widget size
- score: 4
function getWidgetHeights
- file: src/platform/dashboard/utils/widget-heights.ts:49
- kind: function
- core: platform
- spec: (none)
- summary: Get height configuration for a widget size
- score: 4
function getWidgetRegistrySnapshot
- file: src/platform/dashboard/widget-registry-cache.ts:18
- kind: function
- core: platform
- spec: (none)
- summary: Stable reference for useSyncExternalStore — mergeWidgetDefinitions assigns a fresh array on mutation.
- score: 4
function groupCustomFields
- file: src/platform/page-layouts/generators/fieldGroupingRules.ts:294
- kind: function
- core: platform
- spec: (none)
- summary: Group custom fields into sections.Custom fields go into a dedicated “Custom Fields” section.
- score: 4
function groupDefaultsIntoTemplates
- file: src/platform/picklists/hooks/useDefaultPicklistTemplates.ts:46
- kind: function
- core: platform
- spec: (none)
- summary: Group default definitions by category into PicklistTemplate objects.One template per category containing all picklists under that category.Exported for unit testing.
- score: 4
function groupFieldsBySection
- file: src/platform/field-config/utils.ts:145
- kind: function
- core: platform
- spec: (none)
- summary: Group fields by section
- score: 1
function groupFieldsBySectionId
- file: src/platform/page-layouts/utils.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Group fields by their section_id
- score: 4
function groupNotifications
- file: src/platform/notifications/utils/groupNotifications.ts:26
- kind: function
- core: platform
- spec: (none)
- summary: Groups notifications by type + action_url.Notifications with the same type and action_url are collapsedinto a single group with a count badge.The field always points to the most recent notification by .
- score: 4
function groupStandardFields
- file: src/platform/page-layouts/generators/fieldGroupingRules.ts:240
- kind: function
- core: platform
- spec: (none)
- summary: Group standard fields into sections based on grouping rules.
- score: 4
function GuidedTour
- file: src/platform/help/GuidedTour.tsx:47
- kind: function
- core: platform
- spec: (none)
- summary: Utility for guided tour.
- score: 1
function handleAIError
- file: src/platform/ai/widgets/utils/handleAIError.ts:110
- kind: function
- core: platform
- spec: (none)
- summary: Handle AI error with toast and optional callback
- score: 4
function hapticError
- file: src/platform/gestures/utils/haptics.ts:109
- kind: function
- core: platform
- spec: (none)
- summary: Trigger an error haptic
- score: 1
function hapticLongPress
- file: src/platform/gestures/utils/haptics.ts:123
- kind: function
- core: platform
- spec: (none)
- summary: Trigger a long press haptic
- score: 1
function hapticNavigate
- file: src/platform/gestures/utils/haptics.ts:130
- kind: function
- core: platform
- spec: (none)
- summary: Trigger a navigation haptic (lighter than tap, used for section/module switching)
- score: 4
function hapticSelection
- file: src/platform/gestures/utils/haptics.ts:116
- kind: function
- core: platform
- spec: (none)
- summary: Trigger a selection haptic
- score: 1
function hapticSuccess
- file: src/platform/gestures/utils/haptics.ts:95
- kind: function
- core: platform
- spec: (none)
- summary: Trigger a success haptic
- score: 1
function hapticTap
- file: src/platform/gestures/utils/haptics.ts:88
- kind: function
- core: platform
- spec: (none)
- summary: Trigger a simple tap haptic
- score: 1
function hapticWarning
- file: src/platform/gestures/utils/haptics.ts:102
- kind: function
- core: platform
- spec: (none)
- summary: Trigger a warning haptic
- score: 1
function hasBlockAdapter
- file: src/platform/clinical/blocks/adapter-registry.ts:79
- kind: function
- core: platform
- spec: (none)
- summary: Whether a typed-block adapter is registered under in the app singleton.
- score: 4
function hasDaylightSavingTime
- file: src/platform/formatting/timezone.ts:205
- kind: function
- core: platform
- spec: (none)
- summary: Check if a timezone observes daylight saving time
- params:
- timeZone — IANA timezone identifier
- returns: True if timezone has DST
- score: 4
function hasDefaultLayouts
- file: src/platform/page-layouts/generators/defaultLayoutGenerator.ts:267
- kind: function
- core: platform
- spec: (none)
- summary: Check if default layouts exist for an object.
- score: 4
function hashSecret
- file: src/platform/api-access/utils/key-utils.ts:41
- kind: function
- core: platform
- spec: (none)
- summary: Hashes an API secret using SHA-256 for storage.The raw secret is never persisted.
- score: 4
function hashSessionToken
- file: src/platform/sessions/utils/deviceFingerprint.ts:77
- kind: function
- core: platform
- spec: (none)
- summary: Hash a session token (refresh token) using SHA-256.Never stores plaintext tokens.
- score: 4
function hasMentions
- file: src/platform/messaging/utils/mentionParser.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: Check if content contains mentions
- score: 4
function hasRecentSuccessfulTest
- file: src/platform/ai/wizards/ai-skill-creation/test-freshness.ts:21
- kind: function
- core: platform
- spec: (none)
- summary: Returns true when there is a successful test run within the freshness window (AC-4).
- params:
- lastTestAt — ISO timestamp of the most recent test attempt, or null.
- lastTestOk — Whether that most recent attempt succeeded.
- now — Current time in ms (injected for deterministic tests; defaults to Date.now()).
- returns: True only when a successful test ran no more than ago.
- score: 4
function hasTooltipContent
- file: src/platform/help/tooltip-content.ts:631
- kind: function
- core: platform
- spec: (none)
- summary: Check if tooltip content exists for a field.
- score: 4
function hasUnreadMessages
- file: src/platform/messaging/utils/unreadCalculator.ts:21
- kind: function
- core: platform
- spec: (none)
- summary: Check if user has any unread messages (short-circuits on first positive)
- score: 4
function hasV1Conditions
- file: src/platform/conditional-logic/utils/migration.ts:117
- kind: function
- core: platform
- spec: (none)
- summary: Check if a V1 rule has any actual conditions
- score: 4
function hasValidationFunction
- file: src/platform/wizards/utils/validationFunctions.ts:446
- kind: function
- core: platform
- spec: (none)
- summary: Check if a validation function exists.Lookup is case-insensitive.
- params:
- name — Function name (any case accepted)
- score: 4
function heuristicNameMrnScan
- file: src/platform/ai/prompt-safety.ts:224
- kind: function
- core: platform
- spec: (none)
- summary: Author-time name / MRN heuristic (AC-2 author-time gap).The regex cannot catch free-text patient names or short MRN tokenswithout a (a real patient), which does not exist at author time.This heuristic WARNS on capitalized bigrams (likely raw names) and MRN-shaped tokensso the wizard can require substitution plus a no-raw-PHI attestation.It deliberately errs toward warning; the author resolves it with placeholders.
- params:
- prompt — The prompt text to scan.
- returns: A listing likely names and MRN tokens (deduped).
- score: 4
function hexToRgb
- file: src/platform/theming/utils/contrast.ts:65
- kind: function
- core: platform
- spec: (none)
- summary: Parse a hex color string to [r, g, b] in 0–255.Accepts or (alpha is discarded).
- score: 4
function highlightVariables
- file: src/platform/templates/utils/variableResolver.ts:258
- kind: function
- core: platform
- spec: (none)
- summary: Highlight variables in a string for preview display
- score: 4
function htmlToPlainText
- file: src/platform/email-signatures/utils/render.ts:42
- kind: function
- core: platform
- spec: (none)
- summary: Convert HTML to plain text by stripping tags and converting common elements.
- score: 4
function ImageViewer
- file: src/platform/documents/ImageViewer.tsx:14
- kind: function
- core: platform
- spec: (none)
- summary: Utility for image viewer.
- score: 1
function inferColumnType
- file: src/platform/analytics/byod/sanitize.ts:37
- kind: function
- core: platform
- spec: (none)
- summary: Infer a column type from non-empty samples (all must match for a non-text verdict).
- score: 4
function initSentry
- file: src/platform/monitoring/sentry.ts:40
- kind: function
- core: platform
- spec: (none)
- summary: Initialize Sentry SDK. Call once before React renders (via ).Requires VITE_SENTRY_DSN in env; if unset, Sentry is disabled (no events sent).Guarded against double-init to prevent “Multiple Sentry Session Replay instances”.
- score: 4
function instantsOverlap
- file: src/platform/timezone/cross-timezone-conflict.ts:84
- kind: function
- core: platform
- spec: (none)
- summary: Absolute-instant overlap test: .Operates on UTC instants, so it is timezone-agnostic and correct across zones.
- score: 4
function introspectSchema
- file: src/platform/wizards/audit/sources/schema-introspect.ts:5
- kind: function
- core: platform
- spec: (none)
- summary: Extract known + required keys from a zod object schema (unwraps optional/default/nullable).
- score: 4
function invalidateInbox
- file: src/platform/inbox/invalidateInbox.ts:12
- kind: function
- core: platform
- spec: (none)
- summary: Utility for invalidate inbox.
- score: 1
function invertOperator
- file: src/platform/conditional-logic/utils/migration.ts:44
- kind: function
- core: platform
- spec: (none)
- summary: Invert an operator for hideIf → visibility conversion
- params:
- operator — The original operator
- returns: The inverted operator
- score: 4
function invokeMcpTool
- file: src/platform/ai/mcp-client.ts:56
- kind: function
- core: platform
- spec: (none)
- summary: Invokes an MCP tool using JSON-RPC over HTTP with bounded retries.
- params:
- connection — Active MCP connection descriptor.
- toolName — Name of the MCP tool to invoke.
- args — Tool arguments serialized into the JSON-RPC payload.
- returns: Normalized invocation result.
- score: 4
function isAllowedEntityTable
- file: src/platform/forms/prefill/allowlist.ts:41
- kind: function
- core: platform
- spec: (none)
- summary: Checks whether a table name is allowed for entity_record prefill.
- score: 4
function isAndroidDevice
- file: src/platform/telephony/lib/embeddable-utils.ts:134
- kind: function
- core: platform
- spec: (none)
- summary: Check if device is Android
- score: 4
function isAnimatedImage
- file: src/platform/upload/image-utils.ts:153
- kind: function
- core: platform
- spec: (none)
- summary: Check if file is an animated image (GIF).Animated GIFs should not be processed to preserve animation.
- score: 4
function isAsamContinuumRequired
- file: src/platform/clinical/loc/asam-continuum.ts:49
- kind: function
- core: platform
- spec: (none)
- summary: Whether the mandate applies to a given delivery system under the resolved policy.
- score: 4
function isAttachmentStoragePath
- file: src/platform/messaging/utils/attachmentUrl.ts:8
- kind: function
- core: platform
- spec: (none)
- summary: Returns true when the value should be resolved via Storage (path in bucket).
- score: 4
function isBiometricSupported
- file: src/platform/auth/app-lock/biometric-utils.ts:52
- kind: function
- core: platform
- spec: (none)
- summary: Check whether the current environment supports platform biometricauthentication via WebAuthn.
- returns: Promise resolving to when a platform authenticator (Face ID, Touch ID, Windows Hello) is available.
- score: 4
function isBusinessDay
- file: src/platform/calendar/lib/business-day-utils.ts:44
- kind: function
- core: platform
- spec: (none)
- summary: Checks if a date is a business day (working day and not a full-day holiday).
- params:
- date — The date to check.
- businessHours — Business hours configuration map.
- holidays — List of calendar holidays.
- returns: if the date is a business day.
- score: 4
function isCosignOverdue
- file: src/platform/clinical/plan/plan-cadence.ts:57
- kind: function
- core: platform
- spec: (none)
- summary: Whether a BHT-authored plan is cosign-overdue: only a BHT-authored plan with nocosignature whose window has elapsed is overdue.
- score: 4
function isDischargeSummaryOverdue
- file: src/platform/clinical/blocks/discharge/timeliness.ts:84
- kind: function
- core: platform
- spec: (none)
- summary: Whether the summary is overdue as of : not yet entered and is pastthe END of the due date. An entered summary is never “overdue” (the action isno longer outstanding — late entry is ‘sconcern). No due date → not overdue (no window resolved). A present-but-unparseable due date is corrupt compliance data → fail-safe overdue.
- score: 4
function isEligibleForRetry
- file: src/platform/notifications/utils/retry.ts:50
- kind: function
- core: platform
- spec: (none)
- summary: Checks if a notification is eligible for retry.
- params:
- retryCount — Current retry count
- lastAttempt — Date of last attempt
- returns: true if eligible for retry
- score: 4
function isEmpty
- file: src/platform/conditional-logic/utils/operators.ts:116
- kind: function
- core: platform
- spec: (none)
- summary: Check if a value is considered empty
- score: 4
function isFairnessMonitored
- file: src/platform/ai/constants/ai-fairness-surfaces.ts:96
- kind: function
- core: platform
- spec: (none)
- summary: True when the surface is registered AND has a LIVE monitor.
- score: 4
function isFairnessRegistered
- file: src/platform/ai/constants/ai-fairness-surfaces.ts:101
- kind: function
- core: platform
- spec: (none)
- summary: True when the surface is registered under fairness governance (any status).
- score: 4
function isFieldNameInLayout
- file: src/platform/page-layouts/utils.ts:191
- kind: function
- core: platform
- spec: (none)
- summary: Check if a field_name already exists in a layout’s sections
- score: 4
function isFieldNameSafe
- file: src/platform/wizards/utils/sanitizeAnalyticsEvent.ts:314
- kind: function
- core: platform
- spec: (none)
- summary: Validates that a field name is safe for analytics tracking.Use this before including field names in analytics events.
- score: 4
function isFileUploadValue
- file: src/platform/forms/components/fields/fileUploadValue.ts:11
- kind: function
- core: platform
- spec: (none)
- summary: Checks whether a value is a FileUploadFieldValue JSON object.
- score: 4
function isFilterGroup
- file: src/platform/table-v2/utils/filter/builder.ts:38
- kind: function
- core: platform
- spec: (none)
- summary: Type guard to check if a filter is a FilterGroup.
- score: 4
function isFormPagesConfig
- file: src/platform/forms/utils/pdfExportSettingsAccessor.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Determine whether a value is a FormPagesConfig by checking for a array. Runtime type guard that returns when is an object containing a property that is an array.
- params:
- obj — unknown - The value to test
- returns: boolean - if is a FormPagesConfig (has a array), otherwise
- score: 4
function isFormPdfExportSettings
- file: src/platform/forms/utils/pdfExportSettingsAccessor.ts:30
- kind: function
- core: platform
- spec: (none)
- summary: Validate whether a value conforms to the optional fields of FormPdfExportSettings. Checks that when present, and are strings and is either or .
- params:
- obj — The value to validate as
- returns: if is an object whose present fields match the expected types, otherwise
- score: 4
function isHapticAvailable
- file: src/platform/gestures/utils/haptics.ts:41
- kind: function
- core: platform
- spec: (none)
- summary: Check if haptic feedback is availableReturns false on iOS Safari (no Vibration API support)
- score: 4
function isHighRisk
- file: src/platform/clinical/blocks/suicide/requiredness.ts:18
- kind: function
- core: platform
- spec: (none)
- summary: Whether a risk level is high or imminent (the informed-refusal / caring-contacts trigger).
- score: 4
function isHoliday
- file: src/platform/calendar/lib/business-day-utils.ts:31
- kind: function
- core: platform
- spec: (none)
- summary: Checks if a date falls on a holiday.
- params:
- date — The date to check.
- holidays — List of calendar holidays.
- returns: if the date is a full-day holiday.
- score: 4
function isImageFile
- file: src/platform/upload/image-utils.ts:144
- kind: function
- core: platform
- spec: (none)
- summary: Check if file is a supported image type.
- score: 4
function isInSubModule
- file: src/platform/navigation/utils/sub-module-utils.ts:53
- kind: function
- core: platform
- spec: (none)
- summary: Check if we’re currently in a sub-module context
- score: 4
function isInvalidIconKey
- file: src/platform/wizards/utils/auditStepIcons.ts:62
- kind: function
- core: platform
- spec: (none)
- summary: Detect whether a step icon key would route through the fallbackinside .
- returns: when the key is a non-empty string that doesn’t match AND doesn’t resolve to a known module icon.
- score: 4
function isIOS
- file: src/platform/pwa/utils/platformDetection.ts:10
- kind: function
- core: platform
- spec: (none)
- summary: Check if the device is running iOS (iPhone, iPad, iPod).
- score: 4
function isIOSDevice
- file: src/platform/telephony/lib/embeddable-utils.ts:112
- kind: function
- core: platform
- spec: (none)
- summary: Check if device is iOSUses modern userAgentData API with fallback to navigator.platform
- score: 4
function isIOSSafariInBrowser
- file: src/platform/pwa/utils/platformDetection.ts:27
- kind: function
- core: platform
- spec: (none)
- summary: iOS Safari in-browser (not installed to Home Screen).
- score: 4
function isMcpEnabled
- file: src/platform/ai/mcp-config.ts:29
- kind: function
- core: platform
- spec: (none)
- summary: Return whether MCP edge-function integrations are enabled.
- score: 4
function isMobileBackVisible
- file: src/platform/navigation/hooks/useMobileBack.ts:39
- kind: function
- core: platform
- spec: (none)
- summary: Decide whether the mobile Back button should be visible for a path.Exported separately so tests and other navigation surfaces (including thedesktop header back button) can reuse the exact same allow-list logic.
- score: 4
function isMobileDevice
- file: src/platform/telephony/lib/embeddable-utils.ts:102
- kind: function
- core: platform
- spec: (none)
- summary: Check if device is mobile
- score: 4
function isModuleDashboardRoute
- file: src/platform/navigation/utils/navigation-utils.ts:61
- kind: function
- core: platform
- spec: (none)
- summary: Check if the current route is a module dashboard
- score: 4
function isMultiSortConfig
- file: src/platform/table-v2/utils/sort/config.ts:41
- kind: function
- core: platform
- spec: (none)
- summary: Check if sort input is a MultiSortConfig
- score: 4
function isObjectiveMeasurable
- file: src/platform/clinical/plan/measurable.ts:30
- kind: function
- core: platform
- spec: (none)
- summary: Whether an objective is measurable: criteria + target date + frequency + duration all present.
- score: 4
function isOrganizationSetupComplete
- file: src/platform/setup/hooks/organizationSetupUtils.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Check if organization setup has been marked complete (for Getting Started card).
- score: 4
function isPasskeySupported
- file: src/platform/auth/passkey/passkey-utils.ts:97
- kind: function
- core: platform
- spec: (none)
- summary: Whether the current environment exposes the WebAuthn API. Gates the”Sign in with a passkey” / “Add a passkey” affordances so they never renderon unsupported browsers.
- score: 4
function isPhiKey
- file: src/platform/ai/phi-redaction-core.ts:201
- kind: function
- core: platform
- spec: (none)
- summary: True when a key name is PHI-bearing (its normalized form contains a stem).
- score: 4
function isPinnableIconName
- file: src/platform/navigation/pinnable-icons.ts:57
- kind: function
- core: platform
- spec: (none)
- summary: Returns true if the given name is a valid pinnable icon name (for validation on pin).
- score: 4
function isPositiveScreen
- file: src/platform/clinical/blocks/suicide/screening-routing.ts:59
- kind: function
- core: platform
- spec: (none)
- summary: Whether a completed screen routes the required assessment (FR-3). True when thecoded result is above-threshold or a decline/incompletion that warrants follow-up(), or — as a safety net against amis-coded result — when the screen carries any risk level other than .
- score: 4
function isRCEmbeddableEvent
- file: src/platform/telephony/lib/embeddable-events.ts:195
- kind: function
- core: platform
- spec: (none)
- summary: Type guard for RingCentral Embeddable events
- score: 4
function isReassessmentOverdue
- file: src/platform/clinical/blocks/suicide/reassessment.ts:42
- kind: function
- core: platform
- spec: (none)
- summary: Whether a reassessment is overdue as of . No due date → not overdue (nonescheduled). A present-but-unparseable due date is a corrupt safety-criticalvalue and is treated as overdue (fail-safe surface) rather than silently readingas “not overdue”.NOTE (FR-13 / EP6): auto-computing from the PF-96 cadence onan open elevated risk level, and the overdue alert itself, are part of thebespoke crisis-surface workflow (deferred follow-up). + expose the cadence-bound helper for that surface.
- score: 4
function isRegexSafe
- file: src/platform/validation/validators.ts:19
- kind: function
- core: platform
- spec: (none)
- summary: Checks whether a regex pattern is safe from catastrophic backtracking (ReDoS).
- score: 4
function isRegisteredStep
- file: src/platform/wizards/registry/utils.ts:26
- kind: function
- core: platform
- spec: (none)
- summary: Check if a step is registered
- score: 4
function isReservedSlug
- file: src/platform/organizations/slug.ts:25
- kind: function
- core: platform
- spec: (none)
- summary: Check if a slug is in the reserved words blocklist.
- score: 4
function isRouteActive
- file: src/platform/navigation/utils/navigation-utils.ts:118
- kind: function
- core: platform
- spec: (none)
- summary: Check if a route is active (exact or prefix match)
- score: 4
function isSafeForAI
- file: src/platform/ai/widgets/utils/sanitizeForAI.ts:132
- kind: function
- core: platform
- spec: (none)
- summary: Check if text is safe to send to AIReturns true only if no PHI/PII is detected
- score: 4
function isSensitiveField
- file: src/platform/wizards/utils/format-sensitive.ts:37
- kind: function
- core: platform
- spec: (none)
- summary: Checks if a field should be masked in UI
- score: 4
variable isStale
- file: src/platform/dashboard/utils/widgetCache.ts:28
- kind: variable
- core: platform
- spec: (none)
- summary: Check if cached data is stale
- score: 1
function isStandalonePWA
- file: src/platform/pwa/utils/platformDetection.ts:18
- kind: function
- core: platform
- spec: (none)
- summary: Check if the app is running as an installed standalone PWA.
- score: 4
function isSystemRole
- file: src/platform/permissions/components/RoleSelector.tsx:270
- kind: function
- core: platform
- spec: (none)
- summary: Check if a role value is a system role (enum) vs custom role (UUID)
- score: 4
function isTableAllowed
- file: src/platform/data-lookup/lookupTables.ts:127
- kind: function
- core: platform
- spec: (none)
- summary: Check if a table is allowed for lookups
- score: 4
function isTableSupported
- file: src/platform/data-manager/hooks/useRawData.ts:131
- kind: function
- core: platform
- spec: (none)
- summary: Checks whether is table supported.
- score: 4
function isThemeAlreadyDefault
- file: src/platform/theming/devChecks/verifyDefaultsRestored.ts:203
- kind: function
- core: platform
- spec: (none)
- summary: Returns when the active theme has no overrides relative to platformdefaults: every core color matches , every nullableextended/login/typography override is , and the heading font is unset.
- score: 4
function isValidE164
- file: src/platform/telephony/lib/phoneUtils.ts:105
- kind: function
- core: platform
- spec: (none)
- summary: Determines whether a phone string represents a valid E.164 number. Validates that the input, when normalized to E.164, matches followed by 10–15 digits.
- params:
- phone — The phone number to validate; may be provided in any common format.
- returns: boolean if normalizes to a valid E.164 string ( followed by 10–15 digits), otherwise.
- score: 4
function isValidOperatorForField
- file: src/platform/conditional-logic/builder/utils.ts:368
- kind: function
- core: platform
- spec: (none)
- summary: Check if an operator is valid for a field type
- score: 4
function isValidPage
- file: src/platform/table-v2/utils/pagination/utils.ts:112
- kind: function
- core: platform
- spec: (none)
- summary: Check if a page number is valid for given total and page size
- params:
- page — Page number to check
- total — Total number of items
- pageSize — Items per page
- returns: Whether the page number is valid
- score: 4
function isValidPhoneNumber
- file: src/platform/telephony/lib/phoneUtils.ts:93
- kind: function
- core: platform
- spec: (none)
- summary: Determine whether a phone string contains a valid number of digits for storage or E.164 use. Normalizes the input to digits and checks that the resulting digit count is between 10 and 15 inclusive.
- params:
- phone — The phone string to validate (may include formatting characters)
- returns: if the normalized phone contains between 10 and 15 digits, otherwise
- score: 4
function isValidPinFormat
- file: src/platform/auth/app-lock/pin-utils.ts:79
- kind: function
- core: platform
- spec: (none)
- summary: Validate that matches the expected format (digits-only, correct length).
- score: 4
function isValidSizeForWidget
- file: src/platform/dashboard/utils/sizing.ts:68
- kind: function
- core: platform
- spec: (none)
- summary: Check if a size is valid for a widget based on its available sizes
- score: 4
function isValidSlugFormat
- file: src/platform/organizations/slug.ts:18
- kind: function
- core: platform
- spec: (none)
- summary: Check if a slug matches the required format:- 3–50 characters- lowercase alphanumeric and hyphens only- no leading/trailing hyphens
- score: 4
function isWebAuthnSupported
- file: src/platform/auth/components/webauthn-mfa.ts:25
- kind: function
- core: platform
- spec: (none)
- summary: Whether the current environment exposes the WebAuthn API. Used to gate the”Add a passkey” / “Use a passkey” affordances so they never render onunsupported browsers (e.g. iOS Safari PWA standalone — see spec FR-3.1).
- score: 4
function isWebRTCSupported
- file: src/platform/telephony/lib/embeddable-utils.ts:147
- kind: function
- core: platform
- spec: (none)
- summary: Check if WebRTC is supported in this browser
- score: 4
function isWithinLocalWindow
- file: src/platform/timezone/cross-timezone-conflict.ts:70
- kind: function
- core: platform
- spec: (none)
- summary: True when an instant’s site-local time falls within an [open, close] window.Times are compared in the site timezone, so cross-timezone bookings evaluateagainst the destination site’s real operating window (FR-4).
- score: 4
function isWizardComplete
- file: src/platform/setup/hooks/organizationSetupUtils.ts:114
- kind: function
- core: platform
- spec: (none)
- summary: Check if a module’s setup wizard has been marked complete (scoped by organization).
- score: 4
function jsonbArrayToText
- file: src/platform/clinical/blocks/suicide/mapping.ts:37
- kind: function
- core: platform
- spec: (none)
- summary: Join a jsonb string array back to a multiline textarea value; non-arrays → ”.
- score: 4
function jsonbToNarrative
- file: src/platform/clinical/blocks/suicide/mapping.ts:64
- kind: function
- core: platform
- spec: (none)
- summary: Read a jsonb object back to its narrative string, else ”.
- score: 4
function levenshtein
- file: src/platform/import/mapping/suggestMappings.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Simple Levenshtein distance. Exported for reuse in value matching.
- score: 4
function levenshteinDistance
- file: src/platform/import/dedupe/levenshtein.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Compute the Levenshtein edit distance between two strings.
- params:
- a — First string
- b — Second string
- returns: Number of single-character edits (insert, delete, replace)
- score: 4
function levenshteinSimilarity
- file: src/platform/import/dedupe/levenshtein.ts:48
- kind: function
- core: platform
- spec: (none)
- summary: Compute a normalised similarity score between two strings.
- params:
- a — First string
- b — Second string
- returns: Value between 0 (completely different) and 1 (identical)
- score: 4
function listAgentRunEvents
- file: src/platform/agents/runsService.ts:46
- kind: function
- core: platform
- spec: (none)
- summary: Lifecycle audit trail for a single run, oldest first (the timeline).
- score: 4
function listAgentRuns
- file: src/platform/agents/runsService.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: List the org’s runs, newest first. Caller passes the resolved org id (never client-supplied).
- score: 4
function listAgents
- file: src/platform/cowork/agentsService.ts:47
- kind: function
- core: platform
- spec: (none)
- summary: List the org’s agents, oldest first. Caller passes the resolved org id (never client-supplied).
- score: 4
function listAllRegistryQuickActions
- file: src/platform/navigation/quick-action-catalog.ts:74
- kind: function
- core: platform
- spec: (none)
- summary: Iterates all quick actions from MODULE_REGISTRY (module + nav group) with deduplicationmatching the command palette (same module + route only listed once; first registration wins).
- returns: Flat list with stable keys for org defaults UI and audits
- score: 4
function listEntraSkus
- file: src/platform/integrations/hooks/useEntraSetup.ts:131
- kind: function
- core: platform
- spec: (none)
- summary: PF-63-EN-01 FR-3: fetch the tenant’s subscribed license SKUs (Graph/subscribedSkus via the list-skus action). Returns an empty list — never anerror the caller must branch on — when the fetch is unavailable (missingcredentials/consent), so SKU pickers degrade to free-form entry.
- score: 4
function listIntakeProviderAvailability
- file: src/platform/scheduling/listIntakeProviderAvailability.ts:54
- kind: function
- core: platform
- spec: (none)
- summary: Read caseloads + appointment schedule blocks, rank lowest-utilization-first.
- score: 4
function listPasskeys
- file: src/platform/auth/passkey/passkey-utils.ts:161
- kind: function
- core: platform
- spec: (none)
- summary: List the signed-in user’s registered passkeys.
- score: 4
function listPendingApprovals
- file: src/platform/ai/governance/approvalsService.ts:78
- kind: function
- core: platform
- spec: (none)
- summary: List the pending agent-action approvals for an org (the approval queue). RLS requires; the filter is defense-in-depth on top of RLS.
- score: 4
function listRiskRules
- file: src/platform/ai/governance/approvalsService.ts:93
- kind: function
- core: platform
- spec: (none)
- summary: List the risk rules visible to an org — the platform defaults ()plus the org’s own additive overrides (RLS hybrid scope). Read-only; CRUD is Phase 3.
- score: 4
function liveDbUrl
- file: src/platform/wizards/audit/sources/live-source.ts:10
- kind: function
- core: platform
- spec: (none)
- summary: Local-stack Postgres connection string (override via env; defaults to the standard Supabase local DB port).
- score: 4
function loadAllModuleDefinitions
- file: src/platform/modules/module-registry-loaders.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Load every registered module definition (dev prewarm / admin tooling).
- score: 4
function loadModuleDefinitions
- file: src/platform/modules/module-registry-loaders.ts:23
- kind: function
- core: platform
- spec: (none)
- summary: Load one or more full module definitions (nav trees + Lucide icons).
- score: 4
function loadOrganizationSetupDraft
- file: src/platform/setup/hooks/organizationSetupUtils.ts:60
- kind: function
- core: platform
- spec: (none)
- summary: Load draft for the organization. Returns null if none or expired.
- score: 4
function loadPrefillRules
- file: src/platform/forms/prefill/engine.ts:28
- kind: function
- core: platform
- spec: (none)
- summary: Fetches active prefill rules for a form, ordered by priority ascending.
- score: 4
function localDateInZone
- file: src/platform/timezone/cross-timezone-conflict.ts:51
- kind: function
- core: platform
- spec: (none)
- summary: Calendar date (‘yyyy-MM-dd’) of an absolute instant in a given timezone.
- score: 4
function localDayOfWeekInZone
- file: src/platform/timezone/cross-timezone-conflict.ts:61
- kind: function
- core: platform
- spec: (none)
- summary: Day-of-week (0 = Sunday … 6 = Saturday) of an absolute instant in a giventimezone. Computed from the zone-local calendar date so it never drifts to thebrowser/UTC day near midnight — the bug class that made provider-availabilitylookups pick the wrong weekday for non-UTC sites.
- score: 4
function localTimeOfDayInZone
- file: src/platform/timezone/cross-timezone-conflict.ts:46
- kind: function
- core: platform
- spec: (none)
- summary: Wall-clock time-of-day (‘HH:mm:ss’) of an absolute instant in a given timezone.This is the value that must be compared against site-local availability /business-hour windows — comparing a raw UTC slice (as the pre-PF-94 bookingcheck did) is wrong whenever the site timezone is not UTC.
- score: 4
function logAuditEvent
- file: src/platform/audit/index.ts:54
- kind: function
- core: platform
- spec: (none)
- summary: Log an audit event to . Fire-and-forget; errors aresilently caught and reported to Sentry.If no or is provided, the function attemptsto read them from the current Supabase session. If no session exists,the call is silently skipped.
- score: 4
function logExportEvent
- file: src/platform/table-v2/utils/exportAudit.ts:26
- kind: function
- core: platform
- spec: (none)
- summary: Logs a table export event for audit purposes.Records only non-PHI metadata: table ID, format, row count, timestamp.Fire-and-forget — never throws.
- score: 4
function logPermissionViolation
- file: src/platform/security/utils/logPermissionViolation.ts:42
- kind: function
- core: platform
- spec: (none)
- summary: Log a permission violation asynchronously.Does not throw; logs errors and returns silently on failure.This is intentional to avoid disrupting user experience with logging errors.
- params:
- params — Violation details (userId, resource, action, optional ipAddress/organizationId)
- score: 4
function logSlowQuery
- file: src/platform/query-performance/log-slow-query.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Log a slow query. Fire-and-forget — errors are silently ignored.Only call when executionTimeMs = threshold (caller responsibility).
- score: 4
variable logSWActivation
- file: src/platform/pwa/utils/swLifecycleLogger.ts:80
- kind: variable
- core: platform
- spec: (none)
- summary: Logs swactivation lifecycle details for diagnostics.
- score: 2
variable logSWError
- file: src/platform/pwa/utils/swLifecycleLogger.ts:85
- kind: variable
- core: platform
- spec: (none)
- summary: Logs swerror lifecycle details for diagnostics.
- score: 2
variable logSWRegistration
- file: src/platform/pwa/utils/swLifecycleLogger.ts:70
- kind: variable
- core: platform
- spec: (none)
- summary: Logs swregistration lifecycle details for diagnostics.
- score: 2
variable logSWUpdate
- file: src/platform/pwa/utils/swLifecycleLogger.ts:75
- kind: variable
- core: platform
- spec: (none)
- summary: Logs swupdate lifecycle details for diagnostics.
- score: 2
variable logSWUpdateApplied
- file: src/platform/pwa/utils/swLifecycleLogger.ts:90
- kind: variable
- core: platform
- spec: (none)
- summary: Logs swupdate applied lifecycle details for diagnostics.
- score: 2
function lookupPeerServiceHcpcsCodes
- file: src/platform/codes/searchCodes.ts:92
- kind: function
- core: platform
- spec: (none)
- summary: Loads peer-related HCPCS rows from (PF-70) for a fixed allow-list used by CL-19.Falls back to when the code set or rows are missing.
- score: 4
function manifestEntryToStub
- file: src/platform/modules/manifest-module-stub.ts:6
- kind: function
- core: platform
- spec: (none)
- summary: Lightweight module shell used until the full registry chunk loads.
- score: 4
function mapKeyToDisposition
- file: src/platform/telephony/hooks/useQuickDisposition.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Maps a keyboard key (1-9) to a CallDisposition code.Returns null if key is not in the 1-9 range.
- score: 4
function mapPagesToSections
- file: src/platform/forms/utils/sectionPageMapping.ts:41
- kind: function
- core: platform
- spec: (none)
- summary: Extract section names from form pages
- score: 4
function mapScreeningToPatient
- file: src/platform/ce/screeningToPatientMapping.ts:36
- kind: function
- core: platform
- spec: (none)
- summary: Maps screening result fields to the patient pre-population shape.
- score: 4
function mapSectionsToPages
- file: src/platform/forms/utils/sectionPageMapping.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Convert PF-17 field configurations grouped by section into FW-05 form pages
- score: 4
function maskPhoneNumber
- file: src/platform/telephony/lib/phoneUtils.ts:123
- kind: function
- core: platform
- spec: (none)
- summary: Produce a privacy-masked phone number that shows only the last four digits. Normalize the input to digits and return a masked representation for display. If the normalized number has fewer than four digits, a fixed mask of is returned; otherwise the format is returned where are the last four digits.
- params:
- phone — The phone number string to mask (may contain non-digit characters)
- returns: The masked phone string; when fewer than four digits are present, or with the last four digits revealed.
- example: | // returns ‘--1234’maskPhoneNumber(‘(555) 867-1234’)
- score: 4
function maskSensitiveValue
- file: src/platform/wizards/utils/format-sensitive.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Masks sensitive values based on their sensitivity level
- params:
- value — The value to potentially mask
- sensitivity — The sensitivity level of the field
- returns: The masked or original value as a string
- score: 4
function matchRecordsToCSVRows
- file: src/platform/data-manager/utils/rawDataImportUtils.ts:60
- kind: function
- core: platform
- spec: (none)
- summary: Match CSV rows to existing records
- score: 4
function medicationDedupKey
- file: src/platform/clinical/blocks/meds/med-list-adapter.ts:68
- kind: function
- core: platform
- spec: (none)
- summary: Normalized duplicate-identity key for a medication entry (FR-4 / specAssumption 2): case-folded drug name + (strength, or dose amount+unit whenstrength is absent) + route. Same drug at a different strength or route is alegitimate distinct row.
- score: 4
function meetsContrastAA
- file: src/platform/theming/utils/contrast.ts:114
- kind: function
- core: platform
- spec: (none)
- summary: Check if two hex colors meet WCAG AA contrast for normal text.
- score: 4
function meetsContrastAALarge
- file: src/platform/theming/utils/contrast.ts:121
- kind: function
- core: platform
- spec: (none)
- summary: Check if two hex colors meet WCAG AA contrast for large text / UI.
- score: 4
function mergeFieldDefinitions
- file: src/platform/field-config/utils.ts:103
- kind: function
- core: platform
- spec: (none)
- summary: Merge standard fields with custom field definitions
- score: 4
function mergeOrgDefaultsWithConfig
- file: src/platform/wizards/hooks/useWizardOrgDefaults.ts:62
- kind: function
- core: platform
- spec: (none)
- summary: Merges org defaults with template config. Template values take precedence when present.Preserves any future keys on templateConfig.
- score: 4
function mergeQuickActionPin
- file: src/platform/dashboard/utils/normalize-quick-action-preferences.ts:48
- kind: function
- core: platform
- spec: (none)
- summary: Merges pin state for a single action into existing preferences (upsert by action_key).
- score: 4
function mergeSkillWithOverride
- file: src/platform/ai/utils/merge-skill-override.ts:36
- kind: function
- core: platform
- spec: (none)
- summary: Create an EffectiveAISkill by applying an optional organization override to a base AISkill. Combines a base skill with an optional override to produce the effectiveskill configuration used by the application. The result contains:- Overridden RAG settings and temperature when provided- An effective prompt that appends organization-specific custom instructions- The chosen effective model- Enablement status- Metadata indicating whether an override was applied
- params:
- skill — AISkill base record from the pf_ai_skills table
- override — AISkillOverride from pf_ai_skill_overrides for an organization, or / if none
- returns: EffectiveAISkill - the merged skill object including , , , , and the applied (or )
- example: | import mergeSkillWithOverride from ‘/platform/ai/utils/merge-skill-override’;const effective = mergeSkillWithOverride(skillRecord, orgOverride);console.log(effective.effective_prompt);console.log(effective.is_overridden); // true if override was applied
- score: 4
function mergeWidgetDefinitions
- file: src/platform/dashboard/widget-registry-cache.ts:23
- kind: function
- core: platform
- spec: (none)
- summary: Id-keyed upsert preserving insertion order; assigns a fresh array and notifies.
- score: 4
function migrateLegacyPaletteIdToActionKey
- file: src/platform/navigation/quick-action-catalog.ts:121
- kind: function
- core: platform
- spec: (none)
- summary: Maps legacy palette / pinned ids () to stable action keys.
- score: 4
function migrateLegacyPinnedIdsToActionKeys
- file: src/platform/dashboard/utils/normalize-quick-action-preferences.ts:90
- kind: function
- core: platform
- spec: (none)
- summary: Migrates legacy localStorage pinned ids to action_key values (deduped, preserves order).
- score: 4
function migrateRulesToV2
- file: src/platform/conditional-logic/utils/migration.ts:172
- kind: function
- core: platform
- spec: (none)
- summary: Migrate multiple V1 rules to V2 format
- params:
- rules — Record of field keys to V1 rules
- returns: Record of field keys to V2 rules
- score: 4
function migrateV1ToV2
- file: src/platform/conditional-logic/utils/migration.ts:82
- kind: function
- core: platform
- spec: (none)
- summary: Migrate a V1 ConditionalRule to V2 formatV1 Rules:- showIf: field, operator, value → Show field when condition is true- hideIf: field, operator, value → Hide field when condition is trueV2 Conversion:- showIf directly maps to visibility group- hideIf is inverted and combined with showIf if present
- params:
- v1Rule — The V1 rule to migrate
- returns: ConditionalRuleV2 - The migrated V2 rule
- score: 4
function mintAdminConsentUrl
- file: src/platform/integrations/hooks/useEntraSetup.ts:61
- kind: function
- core: platform
- spec: (none)
- summary: Mint a fresh v2 admin-consent URL (organizations tenant when tenant unknown).
- score: 4
function missingRequiredScopes
- file: src/platform/integrations/entra-health.ts:46
- kind: function
- core: platform
- spec: (none)
- summary: Scopes catalogued as required that are absent from the app token.
- score: 4
function modelDirection
- file: src/platform/analytics/hooks/useSemanticModels.ts:70
- kind: function
- core: platform
- spec: (none)
- summary: PF-123: read the governed per-metric KPI direction from the model definition (default neutral).
- score: 4
function ModuleFlyout
- file: src/platform/navigation/components/ModuleFlyout.tsx:54
- kind: function
- core: platform
- spec: (none)
- summary: Flyout panel that appears when hovering/clicking a module in the sidebar.Shows module overview, grouped nav items, and settings.Uses React Portal for proper positioning outside sidebar overflow.
- score: 4
function ModuleRegistryProvider
- file: src/platform/modules/ModuleRegistryProvider.tsx:16
- kind: function
- core: platform
- spec: (none)
- summary: Loads full MODULE_REGISTRY entries on demand for accessible modules and thecurrent route’s module so the initial shell does not import every nav tree.
- score: 4
function narrativeToJsonb
- file: src/platform/clinical/blocks/suicide/mapping.ts:58
- kind: function
- core: platform
- spec: (none)
- summary: Wrap a non-empty narrative as a jsonb object , else null.
- score: 4
function NavAnalyticsListener
- file: src/platform/navigation/analytics/NavAnalyticsListener.tsx:19
- kind: function
- core: platform
- spec: (none)
- summary: Emits a PHI-safe nav event on every distinct location change,and records the route into the per-user recently-visited store.Mount exactly once inside the router AND inside (so, , and resolve).Renders nothing. Identical consecutive urls are deduped so React StrictModedouble-invokes and no-op re-renders don’t double-log.Recently-visited recording lives here (not in the display component) so thatnavigations into any core — e.g. , — arecaptured even when the home panel is not mounted.
- score: 4
function navigateToTab
- file: src/platform/telephony/lib/embeddable-tabs.ts:226
- kind: function
- core: platform
- spec: (none)
- summary: Navigate widget to a specific custom tab
- score: 4
function navigateWidget
- file: src/platform/telephony/lib/embeddable-events.ts:234
- kind: function
- core: platform
- spec: (none)
- summary: Navigate the widget to a specific path
- score: 4
function neutralizeCell
- file: src/platform/analytics/byod/sanitize.ts:27
- kind: function
- core: platform
- spec: (none)
- summary: Neutralize a single cell: prefix a single quote so spreadsheets treat it as literal text.Well-formed numbers are exempt FIRST: a legitimate negative number’s leading (e.g. ) isnot a formula-injection vector, but neutralizing it to would make the typed VIEW’s cast throw and abort the whole dataset’s serve. Genuineformula injection (, , , , a leading ) never matchesNUMERIC_RE, so it is still neutralized below.
- score: 4
function nextBusinessDay
- file: src/platform/calendar/lib/business-day-utils.ts:58
- kind: function
- core: platform
- spec: (none)
- summary: Returns the next business day on or after the given date.
- params:
- date — Starting date.
- businessHours — Business hours configuration map.
- holidays — List of calendar holidays.
- returns: The next business day.
- score: 4
function nonEmptyOrNull
- file: src/platform/clinical/blocks/suicide/mapping.ts:53
- kind: function
- core: platform
- spec: (none)
- summary: Return a non-empty string, else null (never emits to a typed column).
- score: 4
function normalizeAccountType
- file: src/platform/banking/components/accountType.ts:8
- kind: function
- core: platform
- spec: (none)
- summary: Safely normalizes provider account type values to supported platform account types.
- score: 4
function normalizePhone
- file: src/platform/telephony/lib/phoneUtils.ts:15
- kind: function
- core: platform
- spec: (none)
- summary: Normalize a phone string by removing all non-digit characters for storage and comparison. Returns an empty string when is , , or contains only whitespace. Otherwise returns the input with every non-digit character removed.
- params:
- phone — — The phone value to normalize.
- returns: — Digits-only phone string, or an empty string for missing/blank input.
- score: 4
function normalizeQuickActionPreferences
- file: src/platform/dashboard/utils/normalize-quick-action-preferences.ts:18
- kind: function
- core: platform
- spec: (none)
- summary: Normalizes quick action preferences loaded from JSONB: migrates legacy (label)to stable , preserves pins and ordering.
- score: 4
function normalizeQuickActionPreferencesForSave
- file: src/platform/dashboard/lib/quickActionsPool.ts:199
- kind: function
- core: platform
- spec: (none)
- summary: Normalizes preferences on save for global dashboard context.
- score: 4
function normalizeRouteForActionKey
- file: src/platform/navigation/quick-action-catalog.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Normalizes a route segment for use inside an action key (ASCII, URL-safe-ish).
- params:
- route — Absolute app route (e.g. )
- returns: Slug safe for embedding in
- score: 4
function normalizeSubdomain
- file: src/platform/theming/utils/subdomain.ts:85
- kind: function
- core: platform
- spec: (none)
- summary: Normalize a subdomain input for submission.
- score: 4
function normalizeSubscribedSkus
- file: src/platform/integrations/entra-skus.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Normalize the raw list-skus payload: keep only assignable entries (an id ispresent and the subscription is enabled), sorted by part number for stabledropdown ordering.
- score: 4
function normalizeToE164
- file: src/platform/telephony/lib/phoneUtils.ts:39
- kind: function
- core: platform
- spec: (none)
- summary: Convert a phone string into E.164 format for API use. Normalizes the input by removing non-digit characters and returns an E.164-style string. If is falsy, an empty string is returned. Ten-digit inputs are treated as national numbers and prefixed with (US by default); inputs whose length matches + 10 digits and that start with are prefixed with ; all other digit sequences are returned with a leading .
- params:
- phone — string | null | undefined — Phone number in any format
- defaultCountryCode — string — Country calling code (digits only, no ) applied to bare national-length numbers. Defaults to (US/NANP). Configure for international deployments.
- returns: string — Normalized E.164 phone number (for example ), or an empty string if is falsy or fails E.164 length validation
- score: 4
function normalizeToHex
- file: src/platform/theming/utils/contrast.ts:16
- kind: function
- core: platform
- spec: (none)
- summary: Normalize a color string (hex, rgb(), hsl()) to .Falls back to if parsing fails.
- score: 4
function NotificationDeliveryStatus
- file: src/platform/notifications/components/NotificationDeliveryStatus.tsx:12
- kind: function
- core: platform
- spec: (none)
- summary: Utility for notification delivery status.
- score: 1
function NotificationToastProvider
- file: src/platform/notifications/NotificationToastProvider.tsx:7
- kind: function
- core: platform
- spec: (none)
- summary: Provider component that sets up realtime toast notifications.Must be rendered inside QueryClientProvider.
- score: 4
function openAiSseBodyToUiMessageChunkStream
- file: src/platform/ai/utils/encoreOpenAiSseChatTransport.ts:28
- kind: function
- core: platform
- spec: (none)
- summary: Parse an OpenAI-style SSE body into AI SDK UI chunks for the assistant text block.
- score: 4
function openPdf
- file: src/platform/documents/pdfGenerator.ts:282
- kind: function
- core: platform
- spec: (none)
- summary: Generate and open PDF in new windowFalls back to download if popup is blocked
- score: 4
function openPdfInNewTab
- file: src/platform/templates/hooks/useGenerateTemplatedPdf.ts:151
- kind: function
- core: platform
- spec: (none)
- summary: Opens a PDF URL in a new browser tab with security restrictions. Opens the provided PDF in a new tab and applies and to prevent the opened page from accessing the opener.
- params:
- url — The URL of the PDF to open.
- returns: void No return value.
- example: | openPdfInNewTab(‘https://cdn.example.com/docs/sample.pdf’);
- score: 4
function operatorNeedsValue
- file: src/platform/wizards/utils/evaluateBranchCondition.ts:203
- kind: function
- core: platform
- spec: (none)
- summary: Check if an operator requires a value input
- score: 4
function operatorRequiresValue
- file: src/platform/conditional-logic/builder/utils.ts:361
- kind: function
- core: platform
- spec: (none)
- summary: Check if an operator requires a value
- score: 4
function orderGroupsBySection
- file: src/platform/navigation/persona/computePersonaSectionOrder.ts:26
- kind: function
- core: platform
- spec: (none)
- summary: Stable-sort nav groups by the given section order.A group with no is treated as (preserves thehistorical HR sidebar default). If a group’s section is not present in, it sorts after all ordered sections, keeping its originalrelative position (stable).
- score: 4
function orgPath
- file: src/platform/organizations/slug.ts:77
- kind: function
- core: platform
- spec: (none)
- summary: PF-74: Build an org-scoped URL path.Validates slug format, rejects path traversal and null bytes in path, normalizes path.
- example: | orgPath(‘acme-health’, ‘/hr’) → ‘/o/acme-health/hr’ orgPath(‘acme-health’, ”) → ‘/o/acme-health/’
- score: 4
function pagesToSectionAssignments
- file: src/platform/forms/utils/sectionPageMapping.ts:68
- kind: function
- core: platform
- spec: (none)
- summary: Convert form pages back to section assignments for field configs
- score: 4
function parseAIError
- file: src/platform/ai/widgets/utils/handleAIError.ts:13
- kind: function
- core: platform
- spec: (none)
- summary: Parse an error response and convert to AIError type
- score: 4
function parseAliases
- file: src/platform/picklists/components/PicklistItemForm.tsx:55
- kind: function
- core: platform
- spec: (none)
- summary: Parse comma-separated alias string into a deduped, trimmed, non-empty array.Exported for unit testing.
- score: 4
function parseAsamRating
- file: src/platform/clinical/blocks/asam-loc-adapter.ts:87
- kind: function
- core: platform
- spec: (none)
- summary: Parse a coded severity rating into an integer 0–4; null when absent/invalid.
- score: 4
function parseBpmnToSwimLane
- file: src/platform/workflow/utils/parseBpmnToSwimLane.ts:24
- kind: function
- core: platform
- spec: (none)
- summary: Parses BPMN 2.0 XML string into a SwimLaneDiagramState.
- params:
- xml — Valid BPMN 2.0 XML string
- returns: Parsed swim lane diagram state
- score: 4
function parseCsv
- file: src/platform/csv/parse.ts:50
- kind: function
- core: platform
- spec: (none)
- summary: Parse CSV text into headers and data rows. Normalizes line endings to .Row length mismatches are reported in errors but rows are still included.
- score: 4
function parseCSV
- file: src/platform/data-manager/utils/csvUtils.ts:30
- kind: function
- core: platform
- spec: (none)
- summary: Parse CSV string into headers and rows (uses /platform/csv).
- score: 4
function parseCSVContent
- file: src/platform/data-manager/utils/rawDataImportUtils.ts:13
- kind: function
- core: platform
- spec: (none)
- summary: Parse CSV string into headers and rows (uses /platform/csv).
- score: 4
function parseCsvLine
- file: src/platform/csv/parse.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Parse a single CSV line, handling quoted fields and escaped quotes (RFC 4180-style).Commas inside double-quoted fields are preserved; "" inside quotes becomes ”.
- score: 4
function parseDashboardLayout
- file: src/platform/analytics/dashboard/layout-types.ts:80
- kind: function
- core: platform
- spec: (none)
- summary: Safe-parse the jsonb column into a typed layout; any malformed value → EMPTY_LAYOUT.
- score: 4
function parseDeviceInfo
- file: src/platform/sessions/utils/deviceFingerprint.ts:16
- kind: function
- core: platform
- spec: (none)
- summary: Parse basic device info from the user agent string.
- score: 4
function parseDuration
- file: src/platform/formatting/utils.ts:308
- kind: function
- core: platform
- spec: (none)
- summary: Parse a human-readable duration string into milliseconds.The inverse of : accepts a numeric value followed by asingle unit suffix and returns the equivalent number of milliseconds.Supported units (case-insensitive):- — seconds- — minutes- — hours- — daysDecimal values are supported (e.g. → ).
- params:
- input — A duration string such as , , , or .
- returns: The duration expressed in milliseconds.
- example: | parseDuration(’30s’) // 30000parseDuration(‘15m’) // 900000parseDuration(‘1.5h’) // 5400000
- score: 4
function parseExpectedTenantVarsFromCss
- file: src/platform/theming/devChecks/auditTenantVars.ts:38
- kind: function
- core: platform
- spec: (none)
- summary: Extract every variable referenced via inthe supplied CSS text.
- score: 4
function parseExpressionFields
- file: src/platform/wizards/utils/validationExpressionEvaluator.ts:508
- kind: function
- core: platform
- spec: (none)
- summary: Parse an expression and return field references without evaluating
- score: 4
function parseFieldConfiguration
- file: src/platform/page-layouts/utils.ts:115
- kind: function
- core: platform
- spec: (none)
- summary: Parse and merge field configuration with defaults
- score: 4
function parseFilter
- file: src/platform/realtime/utils/filterBuilder.ts:69
- kind: function
- core: platform
- spec: (none)
- summary: Parse a legacy filter string () back into a record.Useful for migrating existing hooks that stored filters as strings.
- example: | parseFilter(‘organization_id=eq.abc’)// → organization_id: ‘abc’
- score: 4
function parseHolidayCsv
- file: src/platform/calendar/lib/csv-import.ts:65
- kind: function
- core: platform
- spec: (none)
- summary: Parses a CSV string into validated holiday rows.
- params:
- csvText — Raw CSV content (with or without BOM).
- returns: Parsed result with valid and invalid rows.
- score: 4
function parseHslTripletToRgb
- file: src/platform/dev/pages/brandingContrast.ts:12
- kind: function
- core: platform
- spec: (none)
- summary: Parse an HSL triplet (the format CSS variables resolve to inthis project) into an 0-255 array. Returns if parsingfails (e.g. token not defined / empty string).
- score: 4
function parseImportFile
- file: src/platform/picklists/utils/importValidation.ts:12
- kind: function
- core: platform
- spec: (none)
- summary: Parse an uploaded file (JSON or CSV) into PicklistExportRecord[]
- score: 4
function parseLayoutConfiguration
- file: src/platform/page-layouts/utils.ts:95
- kind: function
- core: platform
- spec: (none)
- summary: Parse and merge layout configuration with defaults
- score: 4
function parseMentions
- file: src/platform/messaging/utils/mentionParser.ts:28
- kind: function
- core: platform
- spec: (none)
- summary: Extract mentions from message content.Rich mentions (
\[Name\](userId)) are preferred; simple mentions (word) are also returned. - score: 4
function parseNumericOrNull
- file: src/platform/clinical/blocks/suicide/mapping.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Parse a form string to a finite number, else null (never emits to a numeric column).
- score: 4
function parseSectionConfiguration
- file: src/platform/page-layouts/utils.ts:105
- kind: function
- core: platform
- spec: (none)
- summary: Parse and merge section configuration with defaults
- score: 4
function parseSkillMd
- file: src/platform/ai/utils/skill-md-parser.ts:123
- kind: function
- core: platform
- spec: (none)
- summary: Parse a SKILL.md file content into a partial CreateAISkillInput.The file must have YAML frontmatter delimited by lines at the top,followed by Markdown body containing at minimum a section.
- params:
- content — Raw SKILL.md file content.
- returns: An object with parsed and any encountered.
- score: 4
function partitionSemanticModels
- file: src/platform/analytics/hooks/useSemanticModels.ts:60
- kind: function
- core: platform
- spec: (none)
- summary: Split the registry into the picker buckets the builder needs.
- score: 4
function pickAccessibleForegroundTriplet
- file: src/platform/theming/utils/contrast.ts:175
- kind: function
- core: platform
- spec: (none)
- summary: Pick the WCAG-safe foreground ( or ) for a givenbackground color. Defaults to the higher-contrast option, with a smalltie-break preference for white when both meet AA.Returns the foreground as an triplet so it can be writtendirectly to a CSS variable consumed via .
- score: 4
function picklistsToExportRecords
- file: src/platform/picklists/utils/exportSerialization.ts:11
- kind: function
- core: platform
- spec: (none)
- summary: Map DB picklists (with items) to portable export records (no internal IDs)
- score: 4
function PlatformTelehealthConsentBadge
- file: src/platform/clinical/telehealth/TelehealthConsentBadge.tsx:35
- kind: function
- core: platform
- spec: CL-24
- summary: Renders a telehealth-consent status pill for a chart, gated on the CL-24org flag. Safe to mount unconditionally.
- params:
- props — is the to inspect; selects the consent kind and defaults to .
- score: 5
function prefersReducedMotion
- file: src/platform/gestures/utils/haptics.ts:49
- kind: function
- core: platform
- spec: (none)
- summary: Check if reduced motion is preferred
- score: 4
variable prefixRouteMatcher
- file: src/platform/navigation/utils/active-nav-item.ts:121
- kind: variable
- core: platform
- spec: (none)
- summary: Path equals route OR is a child segment — used by mobile ( and ).
- score: 2
function preloadQueryCache
- file: src/platform/offline/queryPersistence.ts:305
- kind: function
- core: platform
- spec: (none)
- summary: Pre-load the storage cache (call during app initialization)This ensures cached data is available immediately
- score: 4
function printElement
- file: src/platform/documents/pdfGenerator.ts:306
- kind: function
- core: platform
- spec: (none)
- summary: Print element (opens print dialog)Uses DOMPurify to sanitize HTML content for XSS prevention
- score: 4
function processBulkOperation
- file: src/platform/bulk-operations/processor.ts:34
- kind: function
- core: platform
- spec: (none)
- summary: Process a single bulk operation.Called by the UI or a background job.
- score: 4
function processImage
- file: src/platform/upload/image-utils.ts:415
- kind: function
- core: platform
- spec: (none)
- summary: Process an image: resize and/or compress in one step.Convenience function that combines resize + compress.
- score: 4
function produceIntakeArtifact
- file: src/platform/ai/agentic/intake-artifact.ts:66
- kind: function
- core: platform
- spec: (none)
- summary: Create a draft intake-recommendation artifact + its first immutable version. Returns the new ids.SINGLE-USER GOVERNANCE: the artifact is -tier so one staffer can verify it viapf_verify_artifact with no PF-126 governance approval (the appointment write is still governed atapproval_required inside execute_writes). True clinical dual-signoff (clinical_gated, distinctapprover) is a future enhancement. Mirrors the Deno runtime (run-intake.ts) for parity.
- score: 4
function publicResultEnvelope
- file: src/platform/analytics/serving/mart-suppression.ts:214
- kind: function
- core: platform
- spec: (none)
- summary: PF-123 #1791 (data minimization): allowlist the per-widget result returned to the ANONYMOUSembed surface. A suppressed verdict still carries internal metadata the public renderer neverreads and an unauthenticated client should not see — (the org’s internal martrelation name → schema disclosure), (the serving plan: numerator/denominator/current/prior/ names → internal semantic structure), (a 42 CFR Part 2data-category signal), and any other RPC passthrough. This returns ONLY the fields consumes — , , , — plus the twogeneric gate sentinels it keys on ( and the no-data marker with the real relation name collapsed away).Used only by (anonymous). The authenticated surface returns the full verdict, since an org user is authorized to see the mart/plan metadata.
- score: 4
function publishEvent
- file: src/platform/events/publishEvent.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: Publish a domain event to trigger workflows.This function inserts an event into the fw_domain_events table,which triggers the fw_process_domain_event() database functionto find and execute matching automation rules.FW-16-P2 enhancements:- Generates and returns a for process tracing- Checks deprecation status and logs Sentry breadcrumbs- Validates payload against registered JSON Schema (warn/strict/off)
- example: | // HR Core: Publishing employee hired eventawait publishEvent( event_name: ‘hr_employee_hired’, organization_id: employee.organization_id, payload: employee_id: employee.id, department_id: employee.department_id, organization_id: employee.organization_id, hire_date: employee.start_date, ,); // With correlation_id for process tracingconst result = await publishEvent( event_name: ‘rh_resident_admitted’, organization_id: episode.organization_id, correlation_id: existingCorrelationId, // optional, auto-generated if omitted payload: episode_id: episode.id, … ,);// result.correlation_id is available for downstream events
- score: 4
function queryGoogleFreeBusy
- file: src/platform/integrations/google-workspace.ts:107
- kind: function
- core: platform
- spec: (none)
- summary: Query free/busy for calendars. Reserved for CE-21 scheduling assistant.Backed by the edge function, whichenforces org access, the PF-101 calendar capability flag, and the subjectdomain allowlist. Returns the per-calendar busy windows keyed by calendar id.
- score: 4
function RawDataCell
- file: src/platform/data-manager/components/RawDataCell.tsx:19
- kind: function
- core: platform
- spec: (none)
- summary: Utility for raw data cell.
- score: 1
function readResolvedTenantVars
- file: src/platform/theming/devChecks/auditTenantVars.ts:93
- kind: function
- core: platform
- spec: (none)
- summary: Read every variable currently present (inline) on thesupplied root element. Empty values are filtered out.
- score: 4
function readTypesText
- file: src/platform/wizards/audit/sources/types-source.ts:13
- kind: function
- core: platform
- spec: (none)
- summary: Read the generated types.ts once. Callers that resolve many tables/enums in aloop (e.g. the orchestrator) should read once and pass the text into / rather than letting each call re-read the(multi-MB) file via its default.
- score: 4
function recallAgentMemory
- file: src/platform/ai/agentic/agent-memory-adapters.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: Scoped semantic recall. The RPC returns only ; each candidate is re-screenedhere before it could re-enter a model prompt, and any row that fails the screen is EXCLUDED(fail-closed, FR-5). Returns the prompt-safe rows; never exposes raw .
- score: 4
function recommendPreset
- file: src/platform/onboarding/integrations/milestonePresets.ts:203
- kind: function
- core: platform
- spec: (none)
- summary: Recommend preset based on job title
- score: 4
function reconciliationRowToFormValues
- file: src/platform/clinical/blocks/meds/med-reconciliation-adapter.ts:88
- kind: function
- core: platform
- spec: (none)
- summary: Map a persisted cl_medication_reconciliations row back to the block’s form values.
- score: 4
function recordImportBatch
- file: src/platform/import-batches/recordBatch.ts:24
- kind: function
- core: platform
- spec: (none)
- summary: Inserts one row into pf_import_batches.Throws on error — callers should catch and handle (e.g., log without blocking the import flow).
- score: 4
function recordOutcomeReassessmentGap
- file: src/platform/clinical/outcomes/reassessment-cohort.ts:74
- kind: function
- core: platform
- spec: (none)
- summary: Record an outcome reassessment care gap in cl_care_gaps.Idempotent: if an open gap already exists for the (org, chart, gap_type)combination, it is escalated to urgent if needed, or skipped. A new gapis inserted only when none is open.
- params:
- db — Supabase client (service-role for cron; caller’s RLS in tests).
- input — Typed gap input conforming to the platform/clinical contract.
- score: 4
function recordPlanAmendment
- file: src/platform/clinical/plan/record-amendment.ts:86
- kind: function
- core: platform
- spec: (none)
- summary: Append an immutable amendment record; returns the persisted row.Throws on failure instead of collapsing to — this is a regulatoryamendment trail (FR-9/FR-10; HIPAA 45 CFR 164.312(b)), so a write failuremust surface to the caller (and its error boundary/toast), never besilently swallowed as if the amendment had been recorded.
- score: 4
function recordRunUsage
- file: src/platform/ai/agentic/intake-rpc-adapters.ts:103
- kind: function
- core: platform
- spec: (none)
- summary: PF-125/PF-111: persist run token/step usage (Task 1 RPC).
- score: 4
function RecordValueDisplay
- file: src/platform/data-manager/components/RecordValueDisplay.tsx:19
- kind: function
- core: platform
- spec: (none)
- summary: Utility for record value display.
- score: 1
function redactObject
- file: src/platform/ai/phi-redaction-core.ts:212
- kind: function
- core: platform
- spec: (none)
- summary: Key-based object scrub (folds + widens CE-69’s ): recursively replaces thevalue of any key that matches (by stem, so variants like / / are caught) with . Non-PHI keys are traversed butunchanged. Used for structured snapshots (audit logs) where regex scrubbing of free text does not apply.
- score: 4
function redactPhi
- file: src/platform/ai/phi-redaction-core.ts:143
- kind: function
- core: platform
- spec: (none)
- summary: Redact PHI from free text using the canonical Safe-Harbor catalog + caller literals.Fail-closed: throws on non-string / empty input. Returns PHI-safetext and per-category match counts (never the matched values).
- params:
- input — The free text to scrub.
- ctx — Caller-known literal identifiers to remove in addition to the patterns.
- score: 4
function refreshEntraConsentUrl
- file: src/platform/integrations/hooks/useEntraSetup.ts:81
- kind: function
- core: platform
- spec: (none)
- summary: Mint a fresh admin-consent URL (new OAuth state TTL) for an already-registered org.
- score: 4
function registerAiOnboardingSteps
- file: src/platform/ai/components/onboarding/registerSteps.ts:29
- kind: function
- core: platform
- spec: (none)
- summary: Register the four PF-UX-22 custom step components. Idempotent.
- score: 4
function registerBlockAdapter
- file: src/platform/clinical/blocks/adapter-registry.ts:69
- kind: function
- core: platform
- spec: (none)
- summary: Register a typed-block adapter into the app singleton.
- score: 4
function registerBulkOperationHandler
- file: src/platform/bulk-operations/processor.ts:19
- kind: function
- core: platform
- spec: (none)
- summary: Register a handler for a specific entity type.Cores call this to provide delete/update/assign implementations.
- score: 4
function registerCacheClearHandler
- file: src/platform/cache/registry.ts:16
- kind: function
- core: platform
- spec: (none)
- summary: Register a cache-clear handler to be invoked on sign-out.Cores call this during initialization to register their cleanup logic.
- score: 4
function registerEntraApp
- file: src/platform/integrations/hooks/useEntraSetup.ts:40
- kind: function
- core: platform
- spec: (none)
- summary: Step 1: persist domain (and BYO app id when applicable), mint an admin-consentURL. For shared mode without a known tenant, uses tenant=organizations so aMicrosoft admin can sign in and consent for the whole directory.
- score: 4
function registerModuleSetupConfig
- file: src/platform/setup/module-setup-registry.ts:103
- kind: function
- core: platform
- spec: (none)
- summary: Registers or updates a module’s setup config.Mutates global state (the module registry). Must only be called at moduleinitialization (top-level side-effect) and never from component render bodiesor hooks without useEffect. Callers should perform registration in modulescope or inside useEffect/initializer to preserve thread-safety with Reactconcurrent re-renders.
- score: 4
function registerPasskey
- file: src/platform/auth/passkey/passkey-utils.ts:125
- kind: function
- core: platform
- spec: (none)
- summary: Register a passkey for the signed-in user. Runs the full WebAuthnregistration ceremony (challenge → navigator.credentials.create → verify).
- score: 4
function registerPrefetch
- file: src/platform/routing/prefetch/registry.ts:73
- kind: function
- core: platform
- spec: (none)
- summary: Register a prefetcher for a route pattern. Call at module load time(the per-core files import for side effects).
- score: 4
function registerTabService
- file: src/platform/telephony/lib/embeddable-tabs.ts:101
- kind: function
- core: platform
- spec: (none)
- summary: Register the third-party service with all tabs.Must be called before adding tabs.
- score: 4
function registerWidgetPlugins
- file: src/platform/dashboard/plugins/index.ts:12
- kind: function
- core: platform
- spec: (none)
- summary: Merge every registered plugin’s widget into the runtime registry (idempotent, id-keyed).
- score: 4
function registerWizardStep
- file: src/platform/wizards/registry/WizardStepRegistry.ts:50
- kind: function
- core: platform
- spec: (none)
- summary: Register a custom wizard step component at runtime.Modules should call this during their initialization to registercustom step components without creating direct import dependencies.
- params:
- entry — The step registry entry to register
- example: | // In /cores/hr/init.ts or module entry point:import registerWizardStep from ‘/platform/wizards’;import lazy from ‘react’;registerWizardStep( id: ‘hr-personal-info’, module: ‘hr’, name: ‘Personal Information’, description: ‘Employee personal information entry’, component: HRPersonalInfoStep,);
- score: 4
function relativeLuminance
- file: src/platform/theming/utils/contrast.ts:77
- kind: function
- core: platform
- spec: (none)
- summary: Compute relative luminance per WCAG 2.1 §1.4.3.
- see:
- score: 4
function removeCustomFieldValue
- file: src/platform/custom-fields/utils.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Remove a custom field from an entity’s custom_fields JSONB
- score: 4
function removeCustomTab
- file: src/platform/telephony/lib/embeddable-tabs.ts:203
- kind: function
- core: platform
- spec: (none)
- summary: Remove a custom tab from the widget
- score: 4
function removeItemFromGroup
- file: src/platform/conditional-logic/builder/utils.ts:245
- kind: function
- core: platform
- spec: (none)
- summary: Remove an item from a group (mutates the group)
- score: 4
function removeThreadAgent
- file: src/platform/cowork/threadsService.ts:55
- kind: function
- core: platform
- spec: (none)
- summary: Mark an agent’s active participation in a thread as left (left_at).
- score: 4
function renamePasskey
- file: src/platform/auth/passkey/passkey-utils.ts:169
- kind: function
- core: platform
- spec: (none)
- summary: Rename a passkey.
- score: 1
function renderEmailSignature
- file: src/platform/email-signatures/utils/render.ts:66
- kind: function
- core: platform
- spec: (none)
- summary: Render an email signature with variable substitution and sanitization.
- returns: Rendered and sanitized signature with HTML and plain text versions.
- score: 4
function renderMentionText
- file: src/platform/messaging/utils/mentionParser.ts:82
- kind: function
- core: platform
- spec: (none)
- summary: Render mention text for display — converts
\[Name\](userId)to Name - score: 4
function renderTemplatePreview
- file: src/platform/notifications/utils/templateValidation.ts:31
- kind: function
- core: platform
- spec: (none)
- summary: Render a template by substituting variables, then strip remaining placeholders.Client-side preview only — server uses pf_render_notification_template.
- score: 4
function reorderTiles
- file: src/platform/analytics/dashboard/layout-types.ts:101
- kind: function
- core: platform
- spec: (none)
- summary: Move to the slot currently held by (dnd-kit reorder semantics).
- score: 4
function requestMicrophonePermission
- file: src/platform/telephony/lib/embeddable-utils.ts:210
- kind: function
- core: platform
- spec: (none)
- summary: Request microphone permissionReturns true if granted, false if denied
- score: 4
function resetAllQuickTips
- file: src/platform/help/QuickTip.tsx:145
- kind: function
- core: platform
- spec: (none)
- summary: Reset all dismissed QuickTips.
- score: 4
function resetAllTours
- file: src/platform/help/useTour.ts:184
- kind: function
- core: platform
- spec: (none)
- summary: Reset all tour states (useful for testing or user preference reset).
- score: 4
function resetQuickTip
- file: src/platform/help/QuickTip.tsx:134
- kind: function
- core: platform
- spec: (none)
- summary: Reset a dismissed QuickTip by its key.
- score: 4
function resetStats
- file: src/platform/cache/store.ts:67
- kind: function
- core: platform
- spec: (none)
- summary: Reset stats — useful for tests
- score: 4
function resetWidgetRegistryForTests
- file: src/platform/dashboard/widget-registry-cache.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Test-only: clear the store between specs (module state otherwise leaks across tests).
- score: 4
function resizeImage
- file: src/platform/upload/image-utils.ts:191
- kind: function
- core: platform
- spec: (none)
- summary: Resize an image to fit within max dimensions.Returns original file if no resize needed or if animated GIF.
- score: 4
function resolveAdapterForBinding
- file: src/platform/clinical/blocks/adapter-registry.ts:84
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the typed adapter a points at (app singleton); undefined for generic.
- score: 4
function resolveAsamContinuumPolicy
- file: src/platform/clinical/loc/asam-continuum.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the ASAM-CONTINUUM policy from PF-96 clinical rules (fail-closed: not mandated).
- score: 4
function resolveBhtCosignWindowHours
- file: src/platform/clinical/plan/plan-cadence.ts:29
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the BHT cosign window (hours) from PF-96, else the supplied fallback.
- score: 4
function resolveChartIdForEncounter
- file: src/platform/clinical/blocks/suicide/chart-resolver.ts:25
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the patient chart id for an encounter; null when none resolves.
- score: 4
function resolveContext
- file: src/platform/forms/prefill/resolvers.ts:137
- kind: function
- core: platform
- spec: (none)
- summary: Resolves a value from the user session / platform context.
- score: 4
function resolveCrisisLines
- file: src/platform/clinical/blocks/suicide/crisis-lines.ts:34
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the national + regional crisis lines from PF-96 clinical rules (988 floor).
- score: 4
function resolveDischargeFieldRequiredness
- file: src/platform/clinical/blocks/discharge/requiredness.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the discharge summary’s conditional field requiredness for one context.
- score: 4
function resolveDischargeSummaryWorkingDays
- file: src/platform/clinical/blocks/discharge/timeliness.ts:46
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the discharge-summary working-day window from PF-96 clinical rules.Reads the flattened top-level key first (the 3-arg flattens over the merged clinical block), then falls back to the raw path when a subclass is supplied and the rules were notpre-flattened. Unresolved → (never a hardcoded default).
- params:
- clinicalRules — the resolved profile’s JSONB.
- licenseSubclass — optional subclass for unflattened rules.
- returns: the window in working days, or null when the profile carries none.
- score: 4
function resolveDynamicApprover
- file: src/platform/templates/utils/resolvers.ts:26
- kind: function
- core: platform
- spec: (none)
- summary: Resolve a dynamic approver for a submitter within an organization. Resolves an approver ID based on the provided resolver type. Supported resolver types:- : returns the submitter’s manager ID from .- : attempts to resolve by department, falling back to the submitter’s manager when department-based resolution is not available.
- params:
- resolverType — (‘manager’ | ‘department_head’): the resolution strategy to use
- userId — : the submitter’s profile ID to resolve an approver for
- organizationId — : the organization ID used to scope HR lookups
- returns: — the resolved approver’s profile ID, or if resolution is not possible
- example: | const approver = await resolveDynamicApprover(‘manager’, ‘user_123’, ‘org_abc’);
- score: 4
function resolveEntityRecord
- file: src/platform/forms/prefill/resolvers.ts:40
- kind: function
- core: platform
- spec: (none)
- summary: Resolves a value from an allowlisted database table.Looks up the entity ID from URL params or entityContext using .
- score: 4
function resolveEntraHealthStatus
- file: src/platform/integrations/entra-health.ts:55
- kind: function
- core: platform
- spec: (none)
- summary: Derive headline status from stored org config and an optional live Graph probe.When is null (not yet fetched), falls back to config-only inference.
- score: 4
function resolvePlanReviewCadenceDays
- file: src/platform/clinical/plan/plan-cadence.ts:23
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the plan-review cadence (days) from PF-96, else the supplied fallback.
- score: 4
function resolvePlatformCodeSetId
- file: src/platform/codes/searchCodes.ts:16
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the platform-managed code_set_id for a given code set label.
- score: 4
function resolvePrefetch
- file: src/platform/routing/prefetch/registry.ts:78
- kind: function
- core: platform
- spec: (none)
- summary: Look up the prefetcher for a concrete pathname; returns on miss.
- score: 4
function resolvePreviousSubmission
- file: src/platform/forms/prefill/resolvers.ts:75
- kind: function
- core: platform
- spec: (none)
- summary: Resolves a field value from the most recent prior submission for the same entity.
- score: 4
function resolveQuickActionScope
- file: src/platform/dashboard/lib/quickActionsPool.ts:68
- kind: function
- core: platform
- spec: (none)
- summary: Resolves effective scope for display. On the main (global) dashboard, a visibleaction must use global scope or it will not render.
- score: 4
function resolveReassessmentCadenceDays
- file: src/platform/clinical/blocks/suicide/crisis-lines.ts:42
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the reassessment cadence (days) from PF-96, else the supplied fallback.
- score: 4
function resolveRegistryToolDefs
- file: src/platform/ai/registry-tool-resolution.ts:94
- kind: function
- core: platform
- spec: PF-127
- summary: Resolve the registry-driven tool set for an org. Throws (does not silently return ) on anRPC error so the caller can fall back to the legacy static resolution.
- score: 5
function resolveRequiredSuiteBlocks
- file: src/platform/clinical/blocks/suicide/fail-closed.ts:55
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the required suite-block set. A null/malformed resolution — including a array containing an entry with a non-string or anon-boolean — fails closed to with anerror; only a fully well-formed resolution returns its own required set. Asingle malformed entry must not silently out under truthiness and produce an under-required set (NFR-safety-1 / AC-10).
- score: 4
function resolveRouteLabel
- file: src/platform/navigation/hooks/useRecentlyVisited.ts:74
- kind: function
- core: platform
- spec: (none)
- summary: Resolve a human-readable label for the given (org-prefix-stripped) route path.Priority:1. Exact match in ROUTE_LABELS2. Route-template match (UUIDs/ids/slugs replaced with “:id”) in ROUTE_LABELS3. Kebab-case last path segment → Title Case fallback
- score: 4
function resolveSsoLoginMode
- file: src/platform/auth/sso/useSsoLogin.ts:66
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the sign-in mode for the email’s domain via the anon RPC. The server enforces that ‘oidc’ is returned only fororgs with the Login SSO capability enabled AND the domain Graph-verified(anti-hijack without DNS TXT). Fails CLOSED: any error, invalid email, orunexpected value resolves to ‘none’ so the caller falls back to the existingSAML/password path.
- score: 4
function resolveStepApprover
- file: src/platform/templates/utils/resolvers.ts:82
- kind: function
- core: platform
- spec: (none)
- summary: Determine the approver ID for a single approval step. Resolves the approver for the provided step configuration. For steps returns the configured user ID; for steps uses the step’s configured resolver and the submitter/organization context to compute an approver; for and steps logs a warning and returns ; for any other type returns .
- params:
- step — The approval step containing and
- submitterId — The ID of the submitter used when resolving dynamic approvers
- organizationId — The organization ID used to scope dynamic resolution
- returns: The resolved approver user ID, or if no approver could be determined
- score: 4
function resolveStepIcon
- file: src/platform/wizards/utils/stepIcons.ts:199
- kind: function
- core: platform
- spec: (none)
- summary: Resolve an icon name string to a Lucide icon component.Resolution order: 1. Direct match in WIZARD_STEP_ICONS catalog 2. Module code match via getModuleIcon (e.g. ‘hr’ → Users) 3. Empty / undefined input → undefined (caller intentionally renders the step number) 4. Unknown explicit key → FALLBACK_STEP_ICON (CircleHelp) + one-time dev console warningThe dev warning fires once per unique unknown key (per page load) so authorsnotice typos without flooding the console on every React re-render. Productionbuilds skip the warning entirely ().
- params:
- iconName — The icon key from WizardStep.icon (e.g. ‘user’, ‘calendar’, ‘review’)
- returns: A Lucide icon component. Returns only when is empty/undefined (intentional “show step number” mode); unknown explicit keys resolve to so the UI never breaks.
- score: 4
function resolveSuiteFieldRequiredness
- file: src/platform/clinical/blocks/suicide/requiredness.ts:42
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the suite’s conditional field requiredness for one assessment context.
- score: 4
function resolveTargets
- file: src/platform/ai/mapping-targets/resolveTargets.ts:45
- kind: function
- core: platform
- spec: (none)
- summary: Resolve a to the concrete, org-scoped Encore values itallows. Always resolves to an array — returns on any error so thecaller’s manual/empty path keeps working (AI is strictly additive). For thebinding’s enforcement policy too, see .
- score: 4
function resolveTargetsWithPolicy
- file: src/platform/ai/mapping-targets/resolveTargets.ts:110
- kind: function
- core: platform
- spec: (none)
- summary: Resolve a binding to its targets and its enforcement policy in one call,so callers that need to gate on coverage (e.g. the import value-mapping stepvia ) don’t have to read separately.Additive over : same org-scoped resolution, samefail-open -on-error behaviour, plus the (defaultedto when the binding leaves it unset).
- score: 4
function resolveTbScreeningWindowDays
- file: src/platform/clinical/blocks/ros-exam/tb-screening.ts:42
- kind: function
- core: platform
- spec: (none)
- summary: Read the TB-screening window from PF-96 clinical rules; when theprofile does not configure one (no hardcoded fallback — AC-12).
- score: 4
function resolveTemplateVariables
- file: src/platform/templates/utils/variableResolver.ts:209
- kind: function
- core: platform
- spec: (none)
- summary: Resolve all template variables in a string
- score: 4
function resolveThread
- file: src/platform/cowork/threadsService.ts:68
- kind: function
- core: platform
- spec: (none)
- summary: Resolve a thread to its SoT view: backing conversation, org (server-read), primary agent,and the ids of currently-active participating agents. Returns null if the resolver yieldsno row (caller lacks access / thread absent — the RPC raises, surfaced as a thrown error).
- score: 4
function resolveTimezone
- file: src/platform/timezone/cross-timezone-conflict.ts:25
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the effective IANA timezone from the site → org → platform-default chain.Mirrors the server-side resolver so client and server agree.
- score: 4
function resolveUrlParameter
- file: src/platform/forms/prefill/resolvers.ts:116
- kind: function
- core: platform
- spec: (none)
- summary: Resolves a value from the current URL query string.
- score: 4
function resolveWorkspaceNav
- file: src/platform/navigation/workspaces/resolveWorkspaceNav.ts:10
- kind: function
- core: platform
- spec: (none)
- summary: Compose a workspace’s section refs into an ordered NavSubGroup[]. Pure.
- params:
- defsByCore — loaded ModuleDefinitions keyed by core id.
- hasGroupAccess — permission predicate; return false to omit a group.Missing groups (not in the core’s navGroups) and absent cores are skipped (resilient).
- score: 4
function resumeAgentRun
- file: src/platform/agents/runsService.ts:78
- kind: function
- core: platform
- spec: (none)
- summary: Operator resume: rehydrate a paused run via the governed RPC (paused → resuming).Returns the resume envelope (lifecycle_state, from_seq, snapshot, cursor). The actualloop continuation is the durable wrapper’s job (edge runtime); the UI only triggersthe transition.
- score: 4
function revokeGoogleLicense
- file: src/platform/integrations/google-workspace.ts:267
- kind: function
- core: platform
- spec: (none)
- summary: Revokes a Google Workspace product/SKU license through the PF-101 license edge function.
- score: 4
function rollbackBulkOperation
- file: src/platform/bulk-operations/rollback.ts:14
- kind: function
- core: platform
- spec: (none)
- summary: Rollback a bulk operation within the rollback window.Restores items from their snapshots.
- score: 4
function RouteLoadingSkeleton
- file: src/platform/navigation/components/RouteLoadingSkeleton.tsx:9
- kind: function
- core: platform
- spec: (none)
- summary: Suspense fallback for route-level code-split boundaries.Intentionally renders nothing — the GlobalQueryProgress bar at the top ofthe viewport is the sole loading affordance during navigation. Returningnull avoids the hex-spinner + skeleton bars that previously appeared in themain content area and could be confused with the product logo.
- score: 4
function rowToRecordData
- file: src/platform/data-manager/utils/csvUtils.ts:197
- kind: function
- core: platform
- spec: (none)
- summary: Convert a CSV row to a record data object
- score: 4
function ruleToBuilderState
- file: src/platform/conditional-logic/builder/utils.ts:91
- kind: function
- core: platform
- spec: (none)
- summary: Convert ConditionalRuleV2 to ConditionBuilderState
- score: 4
function runIntakeAgent
- file: src/platform/ai/agentic/agentic-loop.ts:34
- kind: function
- core: platform
- spec: (none)
- summary: Run the read-only intake screening agent for one PF-125 run.
- params:
- input — run id, referral id, scoped principal.
- deps — injected model gateway, tool resolver, PF-125 RPCs, flag check, budget, prompts.
- returns: the terminal (PHI-free control-plane labels + the screening text).
- score: 4
function runIntakeGovernedWrites
- file: src/platform/ai/agentic/intake-governed-writes.ts:23
- kind: function
- core: platform
- spec: (none)
- summary: Run the governed writes for one approved intake.
- score: 4
function runIntakeReadVertical
- file: src/platform/ai/agentic/intake-vertical.ts:56
- kind: function
- core: platform
- spec: (none)
- summary: Run the read-only intake vertical: screen → triage → provider-match → draft artifact.
- score: 4
function runTenantVarsAuditAndReport
- file: src/platform/theming/devChecks/auditTenantVars.ts:186
- kind: function
- core: platform
- spec: (none)
- summary: Run the audit against (and a detached probeto catch dark-mode-only drift), and emit a single groupper unique drift signature per page session.
- score: 4
function runWizardChecks
- file: src/platform/wizards/audit/orchestrator.ts:19
- kind: function
- core: platform
- spec: (none)
- summary: Run every applicable check for one wizard against already-fetched contracts.Pure (no I/O) so the static and live lanes share identical check logic.Each check runs only when its source is present:- field-coverage requires ,- enum-options runs whenever the target table has enum columns (),- notnull-coverage and mapper-sink require .
- score: 4
function safeRegexTest
- file: src/platform/conditional-logic/utils/operators.ts:97
- kind: function
- core: platform
- spec: (none)
- summary: Safely test a regex pattern with timeout protection
- score: 4
function safetyPlanRowToFormValues
- file: src/platform/clinical/blocks/suicide/safety-plan-adapter.ts:69
- kind: function
- core: platform
- spec: (none)
- summary: Map a persisted cl_safety_plans row back to the safety_plan block’s form values.
- score: 4
function sanitizeAnalyticsEvent
- file: src/platform/wizards/utils/sanitizeAnalyticsEvent.ts:297
- kind: function
- core: platform
- spec: (none)
- summary: Complete analytics event sanitization.Combines validation error and metadata sanitization.
- params:
- event — Raw analytics event data
- returns: Sanitized event safe for storage
- score: 4
function sanitizeCellValue
- file: src/platform/table-v2/utils/sanitize.ts:13
- kind: function
- core: platform
- spec: (none)
- summary: Utility for sanitize cell value.
- score: 1
function sanitizeContent
- file: src/platform/messaging/utils/mentionParser.ts:89
- kind: function
- core: platform
- spec: (none)
- summary: Sanitize content for storage (remove extra whitespace, trim)
- score: 4
function sanitizeContentForAI
- file: src/platform/ai/widgets/utils/sanitizeForAI.ts:140
- kind: function
- core: platform
- spec: (none)
- summary: Sanitize content and return only the clean textUse this for simple sanitization without detection details
- score: 4
function sanitizeDischargeMedications
- file: src/platform/clinical/blocks/discharge/discharge-summary-adapter.ts:93
- kind: function
- core: platform
- spec: (none)
- summary: Sanitize a medications snapshot: keep entries with at least one non-empty part.
- score: 4
function sanitizeFilename
- file: src/platform/upload/service.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Sanitize filename to prevent path traversal and special characters.
- score: 4
function sanitizeHeader
- file: src/platform/table-v2/utils/sanitize.ts:21
- kind: function
- core: platform
- spec: (none)
- summary: Utility for sanitize header.
- score: 1
function sanitizeLookupFilters
- file: src/platform/data-lookup/lookupTables.ts:150
- kind: function
- core: platform
- spec: (none)
- summary: Strip any filter keys that are not in the table’s allowlist.Returns a sanitized copy.
- score: 4
function sanitizeMetadata
- file: src/platform/wizards/utils/sanitizeAnalyticsEvent.ts:263
- kind: function
- core: platform
- spec: (none)
- summary: Sanitizes metadata for analytics storage using an allowlist approach.Only explicitly allowed keys are preserved.
- params:
- metadata — Raw metadata object
- returns: Sanitized metadata with only allowed keys
- score: 4
function sanitizeModuleError
- file: src/platform/modules/utils/errorSanitizer.ts:69
- kind: function
- core: platform
- spec: (none)
- summary: Sanitizes general module errors.Harmonized with sanitizePresetError to cover all common error patterns.
- score: 4
function sanitizePresetError
- file: src/platform/modules/utils/errorSanitizer.ts:53
- kind: function
- core: platform
- spec: (none)
- summary: Sanitizes module preset errors into user-friendly messages.Never exposes raw error messages to users.IMPORTANT: Callers should log the original error via the project loggerbefore calling this function to preserve debugging information.
- score: 4
function sanitizePrompt
- file: src/platform/ai/widgets/utils/sanitizeForAI.ts:85
- kind: function
- core: platform
- spec: (none)
- summary: Detect and sanitize PHI/PII from text
- score: 4
function sanitizeQueryText
- file: src/platform/query-performance/sanitize-query-text.ts:31
- kind: function
- core: platform
- spec: (none)
- summary: Sanitize raw SQL text by redacting PII/PHI patterns.Returns the redacted text and a fingerprint hash.
- score: 4
function sanitizeQueryTextSync
- file: src/platform/query-performance/sanitize-query-text.ts:58
- kind: function
- core: platform
- spec: (none)
- summary: Synchronous version for non-critical paths (uses simple hash).
- score: 4
function sanitizeSearchError
- file: src/platform/search/utils.ts:50
- kind: function
- core: platform
- spec: (none)
- summary: Sanitize error messages for user display.Removes technical details that could expose internal implementationor database structure.
- params:
- error — The error to sanitize
- messages — Optional custom error messages
- returns: A user-friendly error message
- example: | sanitizeSearchError(new Error(‘relation “users” does not exist’))// Returns ‘Search configuration error. Please contact support.’
- score: 4
function sanitizeTriggerEvent
- file: src/platform/clinical/blocks/meds/med-reconciliation-adapter.ts:51
- kind: function
- core: platform
- spec: (none)
- summary: Coerce a form trigger to a CHECK-safe value; unknown/blank → ‘manual’ (spec Assumption 5).
- score: 4
function sanitizeValidationErrors
- file: src/platform/wizards/utils/sanitizeAnalyticsEvent.ts:194
- kind: function
- core: platform
- spec: (none)
- summary: Sanitizes validation errors for analytics storage.CRITICAL: Only stores the field name and error type/message, NEVER the actual value.If a prohibited key is detected, throws PHIDetectedError.
- params:
- errors — Validation errors object (field - error message)
- throwOnPHI — If true, throws error when PHI detected. If false, filters it out.
- returns: Sanitized validation errors or null if empty
- score: 4
function saveIdpMetadata
- file: src/platform/auth/sso/useSsoSetup.ts:98
- kind: function
- core: platform
- spec: (none)
- summary: Step 3: persist the IdP SAML metadata URL + entity id on the provider.
- score: 4
function saveOrganizationSetupDraft
- file: src/platform/setup/hooks/organizationSetupUtils.ts:84
- kind: function
- core: platform
- spec: (none)
- summary: Save draft for the organization.
- score: 4
function saveSessionLocally
- file: src/platform/analytics/sessionRecorder.ts:446
- kind: function
- core: platform
- spec: (none)
- summary: Save session to local storage
- returns: Result object indicating success/failure with optional error message
- score: 1
function scanPromptForPhi
- file: src/platform/ai/wizards/ai-skill-creation/phi-scan.ts:46
- kind: function
- core: platform
- spec: (none)
- summary: Scan the Step-2 prompt fields for pattern-detectable PHI (AC-2).
- params:
- input — The and to scan.
- returns: A ; means the step MUST block advance.
- score: 4
function screenArtifactForPrompt
- file: src/platform/ai/agentic/artifact-prompt-context.ts:79
- kind: function
- core: platform
- spec: (none)
- summary: Screen ONE artifact version for prompt reuse. Returns its prompt-safe text, or throws when the version is not safe to include: - — the persisted PF-27-EN-01 screen did not pass (fail-closed); - is null/empty — there is no prompt-safe projection to include; - the fresh re-screen throws — defense-in-depth against a poisoned/unscreened projection.
- score: 4
function screenForInjection
- file: src/platform/ai/prompt-safety.ts:176
- kind: function
- core: platform
- spec: (none)
- summary: Author-time prompt-injection / jailbreak screen for a skill (AC-3).Heuristic and pattern-based only — flags guardrail-override directive classes suchas instruction override, role reassignment, safety-policy override, privilegeescalation, embedded system prompt, and prompt exfiltration. Returns the firstmatched class so the wizard can name the detected directive class inline. This isNOT a full LLM-judge evaluation.
- params:
- prompt — The prompt text the author is about to save / activate.
- returns: An ; means the step MUST block.
- score: 4
function screenOrgNarrative
- file: src/platform/ai/prompt-safety.ts:62
- kind: function
- core: platform
- spec: (none)
- summary: Screen org-authored narrative text before it is published / injected.
- params:
- text — The narrative markdown the admin wants to publish.
- returns: A . (i.e. ) means publish MUST be blocked; surface each inline.
- score: 4
function screenRowToFormValues
- file: src/platform/clinical/blocks/suicide/suicide-screen-adapter.ts:70
- kind: function
- core: platform
- spec: (none)
- summary: Map a persisted cl_risk_screenings screen row back to the block’s form values.
- score: 4
function sdohRowToFormValues
- file: src/platform/clinical/blocks/sdoh-adapter.ts:96
- kind: function
- core: platform
- spec: (none)
- summary: Map a persisted cl_sdoh_screenings row back to the block’s form values.
- score: 4
function searchCodes
- file: src/platform/codes/searchCodes.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Utility for search codes.
- score: 1
function sectionHasVisibleFields
- file: src/platform/page-layouts/utils/visibilityUtils.ts:43
- kind: function
- core: platform
- spec: (none)
- summary: Check if a section has any visible fields for the current user role.Useful for hiding entire sections when all their fields are hidden.
- score: 4
function seedBuiltInWidgets
- file: src/platform/dashboard/widget-registry.ts:549
- kind: function
- core: platform
- spec: (none)
- summary: Seed the runtime registry with the built-in widgets (idempotent, array-order preserving).
- score: 4
function selectChainFromRules
- file: src/platform/approvals/evaluateRoutingRules.ts:132
- kind: function
- core: platform
- spec: (none)
- summary: Select the approval chain for a submission based on routing rules.
- score: 4
function selectScreeningInstrument
- file: src/platform/clinical/blocks/suicide/screening-routing.ts:31
- kind: function
- core: platform
- spec: (none)
- summary: Select the age-appropriate suicide-screen instrument. Below the threshold →the ASQ (validated for pediatrics); at/above → the C-SSRS. When age is unknownthe routing fails safe to the C-SSRS, which is validated across ages, ratherthan defaulting a pediatric instrument onto a possibly-adult patient.
- score: 4
function sendBroadcast
- file: src/platform/realtime/utils/sendBroadcast.ts:33
- kind: function
- core: platform
- spec: (none)
- summary: Send a one-shot broadcast event on a Supabase Realtime channel.Creates a temporary channel, subscribes, sends the payload, then cleans up.Suitable for fire-and-forget event publishing from non-hook code.Tenant scoping (security): is required so the channelname is prefixed with and matches what subscribes to on the client. This is the compensating control for theinability to add RLS policies to (Supabase’s reservedschema is off-limits per project policy). See.
- params:
- organizationId — Active organization id (required for tenant isolation)
- channel — Channel name (e.g., ‘hr_events’, ‘fa_events’)
- event — Event name (e.g., ‘hr.employer_tax_liability.calculated’)
- payload — Event payload (must NOT contain PHI/PII)
- score: 4
function sendGoogleChatNotification
- file: src/platform/integrations/google-workspace.ts:239
- kind: function
- core: platform
- spec: (none)
- summary: Send a Google Chat notification by rendering an APPROVED PF-10 notificationtemplate into a mapped Chat space, via the edge function. PHI is always blocked in Chat: there is intentionally nofree-text message parameter — only an approved plus short(≤256 char) string variable substitutions, enforced fail-closed server-side.
- score: 4
function sendRCCommand
- file: src/platform/telephony/lib/embeddable-events.ts:213
- kind: function
- core: platform
- spec: (none)
- summary: Send a command to the Embeddable widget
- score: 4
function serializeAliases
- file: src/platform/picklists/components/PicklistItemForm.tsx:71
- kind: function
- core: platform
- spec: (none)
- summary: Serialize an aliases array back to a display string.Exported for unit testing.
- score: 4
function serializeParams
- file: src/platform/validation/hooks/useValidationRuleMutation.ts:118
- kind: function
- core: platform
- spec: (none)
- summary: Helper to serialize RuleParams to Json for Supabase.
- score: 4
function serializeSwimLaneToBpmn
- file: src/platform/workflow/utils/serializeSwimLaneToBpmn.ts:49
- kind: function
- core: platform
- spec: (none)
- summary: Serializes a swim lane diagram state into a BPMN 2.0 XML string.
- params:
- input — Diagram state containing lanes, nodes, and edges
- returns: Valid BPMN 2.0 XML string
- score: 4
variable setCachedWidgetData
- file: src/platform/dashboard/utils/widgetCache.ts:105
- kind: variable
- core: platform
- spec: (none)
- summary: Store widget data in IndexedDB cacheorganizationId is required for multi-tenant security
- score: 2
function setConnectorCredential
- file: src/platform/analytics/hooks/useAnalyticsConnectors.ts:53
- kind: function
- core: platform
- spec: (none)
- summary: Calls the perm-gated SECURITY DEFINER RPC.The is stored in Vault — the return value is only the Vault secret id (uuid);the caller never sees the secret again.
- score: 4
function setCustomFieldValue
- file: src/platform/custom-fields/utils.ts:20
- kind: function
- core: platform
- spec: (none)
- summary: Set a custom field value in an entity’s custom_fields JSONB
- score: 4
function setEventQueryClient
- file: src/platform/events/eventDefinitionCache.ts:29
- kind: function
- core: platform
- spec: (none)
- summary: Register the app’s QueryClient so non-hook functions can share the same cache.Call this once during app initialization (e.g., in main.tsx or a provider).
- score: 4
function setLoginSsoEnabled
- file: src/platform/auth/sso/useSsoSetup.ts:172
- kind: function
- core: platform
- spec: (none)
- summary: PF-112-EN-01: flip the Login SSO capability (staff sign in with Microsoft viathe shared Entra app). Audited server-side by the pf.sso.oidc_enabled/disabledtrigger; routing only takes effect for Graph-verified domains.
- score: 4
function setOrganizationSetupComplete
- file: src/platform/setup/hooks/organizationSetupUtils.ts:51
- kind: function
- core: platform
- spec: (none)
- summary: Mark organization setup as complete. Call after wizard completion.
- score: 4
function setSentryUser
- file: src/platform/monitoring/sentry-context.ts:24
- kind: function
- core: platform
- spec: (none)
- summary: Set Sentry user context on login. Only UUIDs — never PHI.Clears stale tags from a previous session before setting new ones.
- score: 4
function setStorageValue
- file: src/platform/navigation/utils/navigation-utils.ts:107
- kind: function
- core: platform
- spec: (none)
- summary: Safe localStorage setter with JSON stringify
- score: 4
function setStoredPinDerived
- file: src/platform/auth/app-lock/pin-utils.ts:96
- kind: function
- core: platform
- spec: (none)
- summary: Persist the derived PIN + salt to sessionStorage.Data is lost when the tab closes — this is intentional (Phase 1).
- score: 4
function setTabVisibility
- file: src/platform/telephony/lib/embeddable-tabs.ts:177
- kind: function
- core: platform
- spec: (none)
- summary: Show or hide a custom tab
- score: 1
function setWizardComplete
- file: src/platform/setup/hooks/organizationSetupUtils.ts:123
- kind: function
- core: platform
- spec: (none)
- summary: Mark a module’s setup wizard as complete (scoped by organization).
- score: 4
function shouldApplyRule
- file: src/platform/wizards/utils/validation-executor.ts:332
- kind: function
- core: platform
- spec: (none)
- summary: Check if a conditional rule should be applied based on its conditions
- score: 4
function shouldEnableEmbeddable
- file: src/platform/telephony/lib/embeddable-utils.ts:310
- kind: function
- core: platform
- spec: (none)
- summary: Determine if Embeddable should be enabled based on all factors
- score: 4
function shouldSendReminder
- file: src/platform/onboarding/integrations/benefitsIntegration.ts:65
- kind: function
- core: platform
- spec: (none)
- summary: Check if a reminder notification should be sent
- score: 4
function shouldShowBreadcrumbs
- file: src/platform/navigation/utils/breadcrumb-visibility.ts:40
- kind: function
- core: platform
- spec: (none)
- summary: Returns true if breadcrumbs should be shown for the given pathname.
- score: 4
function shouldShowMobileHeaderContextRow
- file: src/platform/navigation/utils/breadcrumb-visibility.ts:95
- kind: function
- core: platform
- spec: (none)
- summary: Whether the mobile shell should render the secondary header row (org switcher + breadcrumbs row).Must stay aligned with — use this in for main content top padding.
- score: 4
function showAIErrorToast
- file: src/platform/ai/widgets/utils/handleAIError.ts:70
- kind: function
- core: platform
- spec: (none)
- summary: Show toast notification for AI error
- score: 4
function signInWithPasskey
- file: src/platform/auth/passkey/passkey-utils.ts:141
- kind: function
- core: platform
- spec: (none)
- summary: Sign in with a passkey (passwordless, discoverable credential). On success,the new session is handed to the canonical client so the rest of the appsees the user as authenticated.
- score: 4
function skillToSkillMd
- file: src/platform/ai/utils/skill-md-serializer.ts:67
- kind: function
- core: platform
- spec: (none)
- summary: Serialize an AISkill to SKILL.md format.The output consists of YAML frontmatter (delimited by ) containingskill metadata, followed by the system prompt as the Markdown body undera heading.
- params:
- skill — The AI skill to serialize.
- returns: A string in SKILL.md format.
- score: 4
function skuOptionLabel
- file: src/platform/integrations/entra-skus.ts:64
- kind: function
- core: platform
- spec: (none)
- summary: Display label for a catalog SKU: part number plus seat usage when known.
- score: 4
function slugFromOrganizationName
- file: src/platform/organizations/slug.ts:59
- kind: function
- core: platform
- spec: (none)
- summary: Generate a URL-safe slug from an organization name.- Lowercases- Replaces non-alphanumeric with hyphens- Collapses consecutive hyphens- Trims leading/trailing hyphens- Truncates to 50 characters
- score: 4
function sortByJurisdictionPriority
- file: src/platform/picklists/utils/referencePicklistUtils.ts:40
- kind: function
- core: platform
- spec: (none)
- summary: Sorts picklist items with state-specific matches first, then by display_order.
- params:
- items — Array of picklist items to sort.
- stateCode — Two-letter state code for priority sorting, or null/undefined to sort by display_order only.
- returns: A new sorted array (does not mutate the input).
- score: 4
function sortByUnreadStatus
- file: src/platform/messaging/utils/unreadCalculator.ts:31
- kind: function
- core: platform
- spec: (none)
- summary: Get conversations sorted by unread status
- score: 4
function sortFieldsByOrder
- file: src/platform/field-config/utils.ts:210
- kind: function
- core: platform
- spec: (none)
- summary: Sort fields by display_order
- score: 1
function sortFieldsByOrder
- file: src/platform/page-layouts/utils.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Sort fields by display_order ascending
- score: 4
function sortSectionsByOrder
- file: src/platform/page-layouts/utils.ts:25
- kind: function
- core: platform
- spec: (none)
- summary: Sort sections by display_order ascending
- score: 4
function startApiCall
- file: src/platform/monitoring/api-metrics.ts:103
- kind: function
- core: platform
- spec: (none)
- summary: Start tracking an API call
- score: 1
function startGlobalRecording
- file: src/platform/analytics/sessionRecorder.ts:416
- kind: function
- core: platform
- spec: (none)
- summary: Start global recording
- score: 1
function startOidcSignIn
- file: src/platform/auth/sso/useSsoLogin.ts:85
- kind: function
- core: platform
- spec: (none)
- summary: Begin the shared-app Entra OIDC sign-in for the given work email(PF-112-EN-01). Resolves to an error message on failure, or redirects thebrowser to Microsoft on success. The post-return gate (enforceSsoGate) ownstenant binding and the known-employees check.
- score: 4
function startRecorderCapture
- file: src/platform/automation/portal/recorder/seam.ts:46
- kind: function
- core: platform
- spec: (none)
- summary: Begin a guided capture session for a portal; returns its (possibly inline) trace.
- score: 4
function startSsoSignIn
- file: src/platform/auth/sso/useSsoLogin.ts:114
- kind: function
- core: platform
- spec: (none)
- summary: Begin SP-initiated SSO for the given work email. Resolves to an error messageon failure, or redirects the browser to the IdP on success.
- score: 4
function stepsToFields
- file: src/platform/wizards/audit/sources/migration-source.ts:85
- kind: function
- core: platform
- spec: (none)
- summary: Flatten JSONB into a normalized field list. Sharedby the static (migration) and live (DB) sources so both produce the same shape. A field is required when it carries OR a step entry of .
- score: 4
function stopGlobalRecording
- file: src/platform/analytics/sessionRecorder.ts:424
- kind: function
- core: platform
- spec: (none)
- summary: Stop global recording
- score: 1
function stripOrgPrefix
- file: src/platform/navigation/utils/navigation-utils.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Strip the /o/slug/ prefix from a pathname, returning a flat path.If no org prefix is present, returns the pathname unchanged.
- example: | stripOrgPrefix(‘/o/acme/ce/contacts’) → ‘/ce/contacts’ stripOrgPrefix(‘/ce/contacts’) → ‘/ce/contacts’
- score: 4
function stripToRouteTemplate
- file: src/platform/navigation/analytics/stripToRouteTemplate.ts:44
- kind: function
- core: platform
- spec: (none)
- summary: Convert a concrete URL to a PHI-safe route template.- Replaces UUID/numeric/opaque id segments with “:id”.- Drops the query string entirely EXCEPT a single key (UI state, never PHI).This is the logging boundary — nothing else from the URL is persisted.
- score: 4
function substituteVariables
- file: src/platform/email-signatures/utils/render.ts:31
- kind: function
- core: platform
- spec: (none)
- summary: Replace all tokens in a string using the provided map.
- score: 4
function subtractBusinessDays
- file: src/platform/calendar/lib/business-day-utils.ts:107
- kind: function
- core: platform
- spec: (none)
- summary: Subtracts N business days from a date.
- params:
- date — Starting date.
- days — Number of business days to subtract (must be = 0).
- businessHours — Business hours configuration map.
- holidays — List of calendar holidays.
- returns: The resulting date after subtracting business days.
- score: 4
function suggestCptCode
- file: src/platform/clinical/billing/billing-rules.ts:40
- kind: function
- core: platform
- spec: (none)
- summary: Maps a billing input (note type + duration) to a suggested CPT code.
- params:
- input — The billing input with noteType and durationMinutes
- returns: A billing suggestion with CPT code, modifiers, and confidence
- score: 4
function suggestIconKey
- file: src/platform/wizards/utils/auditStepIcons.ts:38
- kind: function
- core: platform
- spec: (none)
- summary: Suggest the closest valid icon key for a bad input via simple substring matchagainst keys (lowercased, normalized).
- score: 4
function suggestionsToMappings
- file: src/platform/import/mapping/suggestMappings.ts:129
- kind: function
- core: platform
- spec: (none)
- summary: Convert suggested mappings to FieldMapping array.
- score: 4
function suggestMappings
- file: src/platform/import/mapping/suggestMappings.ts:89
- kind: function
- core: platform
- spec: (none)
- summary: Suggest mappings from source headers to target fields.Returns only suggestions with confidence threshold.
- score: 4
function summarizeAudit
- file: src/platform/wizards/utils/auditStepIcons.ts:106
- kind: function
- core: platform
- spec: (none)
- summary: Aggregate summary counts for the audit page header strip.
- score: 4
function summarizeWizardForPrompt
- file: src/platform/wizards/ai/prompts.ts:95
- kind: function
- core: platform
- spec: (none)
- summary: Generate a summary of wizard structure for modification prompts
- score: 4
function supportsDataSource
- file: src/platform/field-config/fieldTypes.ts:251
- kind: function
- core: platform
- spec: (none)
- summary: Check if a field type supports a specific data source
- score: 4
function supportsWebP
- file: src/platform/upload/image-utils.ts:126
- kind: function
- core: platform
- spec: (none)
- summary: Detect if browser supports WebP image encoding.
- score: 4
function suppressServingPayload
- file: src/platform/analytics/serving/mart-suppression.ts:156
- kind: function
- core: platform
- spec: (none)
- summary: Apply min-cell + complementary suppression to a pf_analytics_run verdict’s RAW rows,returning a verdict whose are flat, suppressed display rows. FAIL-CLOSED: anyok+served verdict whose rows cannot be suppressed (no measure) returns empty rows, neverraw rows. Non-ok / pending_mart verdicts pass through unchanged (they carry no real rows).This is the single guardrail both Tier-2 HTTP surfaces ( authenticated, anonymous) call before returning, so neither can leak anunsuppressed small-cell count.
- score: 4
function syncGoogleDriveMappings
- file: src/platform/integrations/google-workspace.ts:185
- kind: function
- core: platform
- spec: (none)
- summary: Sync Google shared-drive and folder METADATA (ids + names only) into (mapping_type ‘drive_folder’) via the edge function. File contents are never read —PF-11 document export/import remains an explicit per-document action.
- score: 4
function testEntraConnection
- file: src/platform/integrations/hooks/useEntraSetup.ts:108
- kind: function
- core: platform
- spec: (none)
- summary: Step 3: verify the shared app can acquire a token and reach Graph for this tenant.
- score: 4
function textToJsonbArray
- file: src/platform/clinical/blocks/suicide/mapping.ts:28
- kind: function
- core: platform
- spec: (none)
- summary: Split a multiline textarea value into a trimmed, non-empty string array (jsonb).
- score: 4
function tilesToWidgetRows
- file: src/platform/analytics/dashboard/useDashboardLayout.ts:44
- kind: function
- core: platform
- spec: (none)
- summary: Pure: project layout tiles to org-scoped pf_analytics_widgets rows (exported for tests + reuse).
- score: 4
function timezoneDifferenceHours
- file: src/platform/timezone/cross-timezone-conflict.ts:103
- kind: function
- core: platform
- spec: (none)
- summary: Signed offset difference between two timezones at a given instant, in hours(positive = is ahead of ). DST-correct because theoffset is sampled at . Use the magnitude for “highlights the N-hourdifference” warnings (AC-5).
- score: 4
function toEmployeeContext
- file: src/platform/hr/_internal/mappers.ts:28
- kind: function
- core: platform
- spec: (none)
- summary: Utility for to employee context.
- score: 1
function tokenFor
- file: src/platform/analytics/components/AnalyticsChart.tsx:40
- kind: function
- core: platform
- spec: (none)
- summary: Resolve the Nth series to a semantic palette token (wraps after 8). Exported for theAC-012 test that proves series colours come from , never hex.
- score: 4
function toolRegistryEnabled
- file: src/platform/ai/registry-tool-resolution.ts:55
- kind: function
- core: platform
- spec: PF-127
- summary: Fail-safe read of the PF-127 registry flag via . Any error → (registry path stays off → legacy static resolution). The sentinel is neverpassed as a uuid (edge-function caller pitfall).
- score: 5
function toRelativeTime
- file: src/platform/inbox/useUnifiedInbox.ts:76
- kind: function
- core: platform
- spec: (none)
- summary: Utility for to relative time.
- score: 1
function toSafeColumnKey
- file: src/platform/analytics/byod/sanitize.ts:56
- kind: function
- core: platform
- spec: (none)
- summary: Snake-case a header to a safe, bare snake_case identifier; positional fallback otherwise.Security (NFR-sec-4): the derived key MUST begin with a letter. Trailing separators arestripped, but a leading non-letter — every OWASP formula trigger (), a digit,or a leading underscore — yields no derived key and falls back to a positional .This guarantees no attacker-controlled, formula-trigger header is ever turned into anidentifier (e.g. → , never ), while staying a strict subset of theregister bridge’s downstream re-validation.
- score: 4
function toZonedTime
- file: src/platform/formatting/timezone.ts:111
- kind: function
- core: platform
- spec: (none)
- summary: Convert a UTC date to a specific timezoneReturns a Date object that, when formatted with date-fns,will show the correct time for the specified timezone.
- params:
- date — UTC date
- timeZone — Target timezone
- returns: Date object representing the time in the target timezone
- score: 4
function trackDatabaseQuery
- file: src/platform/monitoring/api-metrics.ts:167
- kind: function
- core: platform
- spec: (none)
- summary: Track a database query
- score: 1
function trackGestureEvent
- file: src/platform/gestures/utils/trackGestureEvent.ts:92
- kind: function
- core: platform
- spec: (none)
- summary: Queue a gesture analytics event for batched insertion.Callers pass userId and orgId from useCurrentUser() — this is NOT a hook.
- score: 4
function transformSettingsForDb
- file: src/platform/settings/utils/settings-transform.ts:54
- kind: function
- core: platform
- spec: (none)
- summary: Transforms form values back to database format.Converts undefined values to null for database storage.
- params:
- formValues — Form values (may contain undefined)
- returns: Values ready for database upsert (undefined → null)
- example: | const handleSubmit = (values: FormValues) = const dbValues = transformSettingsForDb(values); upsert(dbValues);;
- score: 4
function transformSettingsForForm
- file: src/platform/settings/utils/settings-transform.ts:31
- kind: function
- core: platform
- spec: (none)
- summary: Generic settings transform that converts null values to undefinedfor form compatibility with React Hook Form and Zod.Use this instead of creating per-module transformSettings functions.
- params:
- settings — Settings object from database (may contain null values)
- returns: Settings object with null values converted to undefined
- example: | // In a settings pageconst formValues = transformSettingsForForm(settings);// In a settings formSettingsForm initialValues=transformSettingsForForm(settings ?? null) onSubmit=handleSubmit/
- score: 4
function triggerHaptic
- file: src/platform/gestures/utils/haptics.ts:60
- kind: function
- core: platform
- spec: (none)
- summary: Trigger haptic feedback with a specific type
- params:
- type — The type of haptic feedback
- returns: true if haptic was triggered, false otherwise (including iOS Safari)
- score: 4
function uiToAIMessage
- file: src/platform/ai/utils/messageConversion.ts:50
- kind: function
- core: platform
- spec: (none)
- summary: Maps a back to , concatenating text parts and preserving timestamp when available.
- score: 4
function updateAgent
- file: src/platform/cowork/agentsService.ts:79
- kind: function
- core: platform
- spec: (none)
- summary: Patch an agent by id. RLS scopes the row to the caller’s org; we never widen organization_id.
- score: 4
function updateConditionInGroup
- file: src/platform/conditional-logic/builder/utils.ts:314
- kind: function
- core: platform
- spec: (none)
- summary: Update a condition by ID
- score: 1
function updateCustomTabContent
- file: src/platform/telephony/lib/embeddable-tabs.ts:156
- kind: function
- core: platform
- spec: (none)
- summary: Update the content of an existing custom tab
- score: 4
function updateGroupLogic
- file: src/platform/conditional-logic/builder/utils.ts:337
- kind: function
- core: platform
- spec: (none)
- summary: Update a group’s logic
- score: 1
function uploadFile
- file: src/platform/upload/service.ts:216
- kind: function
- core: platform
- spec: (none)
- summary: Upload a file to storage with full validation, progress tracking,error handling, tenant isolation, and optional image processing.
- score: 4
function userHasPermission
- file: src/platform/navigation/search-catalog.ts:50
- kind: function
- core: platform
- spec: (none)
- summary: Returns true when the user holds , or always true when is absent (open access within the module).
- score: 4
function userScopePrefix
- file: src/platform/cache/key-builder.ts:27
- kind: function
- core: platform
- spec: (none)
- summary: Prefix for user-scoped invalidation: org-orgId:user-userId:
- score: 4
function validateAllCustomFields
- file: src/platform/custom-fields/utils.ts:133
- kind: function
- core: platform
- spec: (none)
- summary: Validate all custom fields for an entity
- score: 4
function validateApprovalChain
- file: src/platform/templates/utils/resolvers.ts:123
- kind: function
- core: platform
- spec: (none)
- summary: Validates that each approval step can be resolved and collects resolved approvers. Iterates the provided approval steps, attempts to resolve an approver for each step, stores resolved approvers keyed by , and records values for dynamic steps that could not be resolved.
- params:
- steps — The array of approval step configurations to validate.
- submitterId — The ID of the user submitting the approval request; used by dynamic resolver logic.
- organizationId — The organization ID used when resolving dynamic approvers.
- returns: An object with: - : if all dynamic steps were resolved, otherwise. - : an array of numbers for dynamic steps that could not be resolved. - : a Map from to the resolved approver ID.
- example: | const isValid, unresolvedSteps, resolvedApprovers = await validateApprovalChain(steps, ‘user_123’, ‘org_abc’);
- score: 4
function validateAsamOverride
- file: src/platform/clinical/blocks/asam-loc-adapter.ts:117
- kind: function
- core: platform
- spec: (none)
- summary: Validate the CL-49 override invariant before hitting the DB CHECK: when bothLOC codes are present and differ, an override reason code plus a rationale ofat least chars are required.Returns an error message, or null when valid.
- score: 4
function validateBody
- file: src/platform/notifications/utils/templateValidation.ts:57
- kind: function
- core: platform
- spec: (none)
- summary: Validate body template constraints
- score: 4
function validateBranchConfig
- file: src/platform/wizards/utils/validateBranchPaths.ts:120
- kind: function
- core: platform
- spec: (none)
- summary: Validate a single branch configuration
- score: 4
function validateBuilderState
- file: src/platform/conditional-logic/builder/utils.ts:436
- kind: function
- core: platform
- spec: (none)
- summary: Validate the entire builder state
- score: 4
function validateCode
- file: src/platform/codes/validateCode.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Utility for validate code.
- score: 1
function validateCrossFieldRule
- file: src/platform/conditional-logic/validation/utils.ts:111
- kind: function
- core: platform
- spec: (none)
- summary: Validate a cross-field validation rule structure
- score: 4
function validateCrossFieldRules
- file: src/platform/wizards/utils/validation-executor.ts:276
- kind: function
- core: platform
- spec: (none)
- summary: Validate cross-field rules
- score: 1
function validateCrossModuleAccess
- file: src/platform/wizards/hooks/useCrossModuleWizard.ts:152
- kind: function
- core: platform
- spec: (none)
- summary: Check if a user has access to all modules in a cross-module wizard
- score: 4
function validateCrossModuleTargets
- file: src/platform/wizards/utils/crossModuleSubmit.ts:215
- kind: function
- core: platform
- spec: (none)
- summary: Validate that all target tables exist and user has insert permissions
- score: 4
function validateCustomField
- file: src/platform/custom-fields/utils.ts:44
- kind: function
- core: platform
- spec: (none)
- summary: Validate a single custom field value against its definition
- score: 4
function validateDateRange
- file: src/platform/conditional-logic/validation/crossFieldEvaluator.ts:187
- kind: function
- core: platform
- spec: (none)
- summary: Validate a date range (start must be before end)
- score: 4
function validateDiagram
- file: src/platform/workflow/utils/diagramValidation.ts:55
- kind: function
- core: platform
- spec: (none)
- summary: Validates a swim lane diagram for structural issues.Errors (blocking):- No start event- No end eventWarnings (advisory):- Orphan content nodes (no incoming AND no outgoing edges)- Decision nodes with fewer than 2 outgoing edges
- params:
- nodes — All diagram nodes (including structural)
- edges — All diagram edges
- returns: Validation result with errors and warnings
- score: 4
function validateDirection
- file: src/platform/table-v2/utils/sort/config.ts:34
- kind: function
- core: platform
- spec: (none)
- summary: Validate sort direction
- score: 1
function validateEventPayload
- file: src/platform/events/eventPayloadValidation.ts:145
- kind: function
- core: platform
- spec: (none)
- summary: Validate an event payload against its registered JSON Schema.This is a pure function — it has no side-effects, does not read fromthe database, and is safe to call from any context.
- params:
- payload — The event payload object to validate.
- schema — The JSON Schema to validate against (from ).
- returns: Validation result with flag and any error messages.
- score: 4
function validateExpressionSyntax
- file: src/platform/wizards/utils/validationExpressionEvaluator.ts:543
- kind: function
- core: platform
- spec: (none)
- summary: Validate expression syntax without evaluating
- score: 4
function validateField
- file: src/platform/wizards/utils/validation-executor.ts:69
- kind: function
- core: platform
- spec: (none)
- summary: Validate a single field against all its rules
- score: 4
function validateFieldName
- file: src/platform/table-v2/utils/filter/utils.ts:42
- kind: function
- core: platform
- spec: (none)
- summary: Validate field name to prevent SQL injection.Only allows alphanumeric characters and underscores, must start with letter or underscore.
- params:
- field — Field name to validate
- returns: True if valid, false otherwise
- example: | validateFieldName(‘user_id’) // truevalidateFieldName(‘firstName’) // truevalidateFieldName(‘123field’) // falsevalidateFieldName(‘field-name’) // false
- score: 4
function validateFieldName
- file: src/platform/table-v2/utils/sort/config.ts:27
- kind: function
- core: platform
- spec: (none)
- summary: Validate field name to prevent injectionOnly allows alphanumeric characters and underscores, starting with letter or underscore
- score: 4
function validateFieldValue
- file: src/platform/data-manager/utils/rawDataValidation.ts:15
- kind: function
- core: platform
- spec: (none)
- summary: Validate a field value against its definition
- score: 4
function validateFile
- file: src/platform/documents/utils/fileValidation.ts:124
- kind: function
- core: platform
- spec: (none)
- summary: Validate a single file
- score: 1
function validateFile
- file: src/platform/upload/validation.ts:93
- kind: function
- core: platform
- spec: (none)
- summary: Validate a file against organization settings or provided overrides.
- score: 4
function validateFiles
- file: src/platform/documents/utils/fileValidation.ts:167
- kind: function
- core: platform
- spec: (none)
- summary: Validate multiple files and separate valid from invalid
- score: 4
function validateFileSize
- file: src/platform/upload/validation.ts:48
- kind: function
- core: platform
- spec: (none)
- summary: Validate file size against maximum allowed.
- score: 4
function validateFileType
- file: src/platform/upload/validation.ts:22
- kind: function
- core: platform
- spec: (none)
- summary: Validate file type against allowed MIME types.Also validates that extension matches MIME type for defense in depth.
- score: 4
function validateFormData
- file: src/platform/forms/validation.ts:376
- kind: function
- core: platform
- spec: (none)
- summary: Validate form data against form schema
- score: 4
function validateFormDataV2
- file: src/platform/forms/validationV2.ts:104
- kind: function
- core: platform
- spec: (none)
- summary: Validate form data with V2 conditional logic support
- params:
- fields — Form field definitions
- data — Form data to validate
- returns: Validation result with detailed error information
- score: 4
function validateImportRecords
- file: src/platform/picklists/utils/importValidation.ts:85
- kind: function
- core: platform
- spec: (none)
- summary: Validate parsed records for required fields, duplicates, and limits
- score: 4
function validateImportRow
- file: src/platform/data-manager/utils/rawDataImportUtils.ts:117
- kind: function
- core: platform
- spec: (none)
- summary: Validate a row against field definitions
- score: 4
function validateLayoutConfiguration
- file: src/platform/page-layouts/utils.ts:125
- kind: function
- core: platform
- spec: (none)
- summary: Validate layout configuration structure
- score: 4
function validateLookupValuesAgainstOptions
- file: src/platform/data-lookup/validateLookupSelection.ts:22
- kind: function
- core: platform
- spec: (none)
- summary: Validate one or more lookup values against the loaded options.Returns an error message string if any value is invalid, or if all are valid.
- params:
- fieldLabel — Human-readable field name for the error message.
- score: 4
function validateNestingDepth
- file: src/platform/conditional-logic/builder/utils.ts:190
- kind: function
- core: platform
- spec: (none)
- summary: Validate nesting depth doesn’t exceed maximum
- score: 4
function validateOperator
- file: src/platform/table-v2/utils/filter/utils.ts:53
- kind: function
- core: platform
- spec: (none)
- summary: Validate filter operator.
- params:
- operator — Operator to validate
- returns: True if valid, false otherwise
- score: 1
function validatePattern
- file: src/platform/conditional-logic/utils/operators.ts:73
- kind: function
- core: platform
- spec: (none)
- summary: Validate regex pattern for safetyReturns null if safe, error message if dangerous
- score: 4
function validatePhoto
- file: src/platform/headshot/utils/photo-validation.ts:17
- kind: function
- core: platform
- spec: (none)
- summary: Validates a photo file for headshot upload.
- score: 4
function validateRow
- file: src/platform/data-manager/utils/csvUtils.ts:122
- kind: function
- core: platform
- spec: (none)
- summary: Validate a single row against field definitions
- score: 4
function validateScopes
- file: src/platform/api-access/utils/key-utils.ts:175
- kind: function
- core: platform
- spec: (none)
- summary: Validates that all provided scopes exist in the registry.
- score: 4
function validateSingleRule
- file: src/platform/wizards/utils/validation-executor.ts:96
- kind: function
- core: platform
- spec: (none)
- summary: Validate a value against a single rule
- score: 4
function validateSkuAgainstCatalog
- file: src/platform/integrations/entra-skus.ts:55
- kind: function
- core: platform
- spec: (none)
- summary: Validate a SKU id the admin entered/selected. With a live catalog the id mustbelong to the tenant; without one (fetch failed — credentials or consentmissing) only the GUID format is enforced so setup can proceed.
- score: 4
function validateSlug
- file: src/platform/organizations/slug.ts:32
- kind: function
- core: platform
- spec: (none)
- summary: Validate a slug and return an error message if invalid.
- score: 4
function validateSubdomain
- file: src/platform/theming/utils/subdomain.ts:54
- kind: function
- core: platform
- spec: (none)
- summary: Validate a subdomain label client-side.Rules:1. Must match (lowercase, starts/ends alphanumeric)2. Must be ≥ 3 characters and ≤ 63 characters (DNS label limit)3. Must not be in the reserved list
- score: 4
function validateSubject
- file: src/platform/notifications/utils/templateValidation.ts:50
- kind: function
- core: platform
- spec: (none)
- summary: Validate subject line constraints
- score: 4
function validateThemeContrast
- file: src/platform/theming/utils/contrast.ts:209
- kind: function
- core: platform
- spec: (none)
- summary: Validate critical contrast pairs for a theme’s colors.Returns an array of issues; empty means all checks pass.Pairs checked (per spec §NFR-3):- text on background- text on surface- textMuted on background- textMuted on surface- primary on background (large text threshold)- destructive on background (large text threshold)
- score: 4
function validateVariables
- file: src/platform/templates/utils/variableResolver.ts:237
- kind: function
- core: platform
- spec: (none)
- summary: Validate that all variables in a template have corresponding context values
- score: 4
function validateWeightsSum
- file: src/platform/settings/validators/processHealthSettings.ts:56
- kind: function
- core: platform
- spec: (none)
- summary: Validates that health weights sum to 100.
- params:
- weights — Object with the four weight values.
- returns: if the sum equals 100.
- score: 4
function validateWizardPaths
- file: src/platform/wizards/utils/validateBranchPaths.ts:21
- kind: function
- core: platform
- spec: (none)
- summary: Validate all paths through a wizard to detect:- Unreachable steps (orphans)- Infinite loops (cycles)- Invalid branch targets
- score: 4
function validationsFromBuilderFormat
- file: src/platform/conditional-logic/validation/utils.ts:171
- kind: function
- core: platform
- spec: (none)
- summary: Strip builder-only fields from validations for export(currently just ensures clean structure)
- score: 4
function validationsToBuilderFormat
- file: src/platform/conditional-logic/validation/utils.ts:160
- kind: function
- core: platform
- spec: (none)
- summary: Convert validations to builder format (ensure IDs)
- score: 4
function valueExistsInLookupOptions
- file: src/platform/data-lookup/validateLookupSelection.ts:12
- kind: function
- core: platform
- spec: (none)
- summary: Check whether a single value exists in the loaded lookup options.
- score: 4
function verifyBiometric
- file: src/platform/auth/app-lock/biometric-utils.ts:123
- kind: function
- core: platform
- spec: (none)
- summary: Verify biometric identity using a previously enrolled credential.
- returns: if verification succeeded, otherwise.
- score: 4
function verifyDefaultsRestored
- file: src/platform/theming/devChecks/verifyDefaultsRestored.ts:164
- kind: function
- core: platform
- spec: (none)
- summary: Verify that the DOM has fully returned to platform defaults after a reset: - No inline overrides remain on . - Every semantic var resolves to its captured baseline value.
- score: 4
function verifyDomainNow
- file: src/platform/auth/sso/useSsoSetup.ts:90
- kind: function
- core: platform
- spec: (none)
- summary: Step 2: ask the backend to check DNS TXT now; returns the resulting status.
- score: 4
function verifyPin
- file: src/platform/auth/app-lock/pin-utils.ts:67
- kind: function
- core: platform
- spec: (none)
- summary: Verify a candidate PIN against a previously derived value.Returns when the candidate, combined with the same salt, producesthe same derived hex.
- score: 4
function wasDischargeSummaryTimely
- file: src/platform/clinical/blocks/discharge/timeliness.ts:101
- kind: function
- core: platform
- spec: (none)
- summary: Whether an entered summary met the window: entered on or before the end ofthe due date. when it cannot be judged (no due date or no entry yet,or corrupt timestamps) — reporting must not count unknowns as either bucket.
- score: 4
function withDbMetrics
- file: src/platform/monitoring/api-metrics.ts:220
- kind: function
- core: platform
- spec: (none)
- summary: Wrapper for Supabase client calls to track metrics
- score: 4
function withErrorBoundary
- file: src/platform/monitoring/withErrorBoundary.tsx:15
- kind: function
- core: platform
- spec: (none)
- summary: Higher-order component to wrap any component with error boundary.Usage: const SafeComponent = withErrorBoundary(MyComponent, level: ‘feature’ );
- score: 4
function withErrorCapture
- file: src/platform/monitoring/useErrorTracking.ts:139
- kind: function
- core: platform
- spec: (none)
- summary: Helper to wrap async functions with automatic error logging and Sentry capture.Usage: const handleSubmit = withErrorCapture(async () = await saveForm(data); , module: ‘fw’, action: ‘save_form’ );
- score: 4
function WizardPreviewStepContent
- file: src/platform/wizards/components/WizardPreviewStepContent.tsx:21
- kind: function
- core: platform
- spec: (none)
- summary: Utility for wizard preview step content.
- score: 1
function WizardProgress
- file: src/platform/wizards/components/WizardShell/progress/WizardProgress.tsx:32
- kind: function
- core: platform
- spec: (none)
- summary: Utility for wizard progress.
- score: 1
function writeAgentMemory
- file: src/platform/ai/agentic/agent-memory-adapters.ts:45
- kind: function
- core: platform
- spec: (none)
- summary: Persist a learned-context fact. Runs the two-path screen FIRST (fail-closed: if it throws, the RPCis never called and nothing is stored), then calls the screened-write RPC with raw +its redacted twin + .
- score: 4
function zodToToolSchema
- file: src/platform/ai/widgets/utils/zodToToolSchema.ts:24
- kind: function
- core: platform
- spec: (none)
- summary: Convert a Zod schema to an AI tool function schema.
- score: 4
Classes
class AnalyticsCompileError
- file: src/platform/analytics/semantic-compiler.ts:70
- kind: class
- core: platform
- spec: (none)
- summary: Structured compile failure. maps to the FR/AC the request violated.
- score: 4
class ArtifactScreenBlockedError
- file: src/platform/ai/agentic/artifact-prompt-context.ts:48
- kind: class
- core: platform
- spec: (none)
- summary: Thrown when an artifact version cannot be safely included in a prompt. Surfacing this (ratherthan degrading to raw/empty content) is the fail-closed contract: the caller assembling theprompt is expected to let it propagate so the model call never proceeds on unscreened content.
- score: 4
class ChannelManager
- file: src/platform/realtime/utils/ChannelManager.ts:23
- kind: class
- core: platform
- spec: (none)
- summary: Represents channel manager.
- score: 1
class CustomGestureRegistry
- file: src/platform/gestures/registry/CustomGestureRegistry.ts:38
- kind: class
- core: platform
- spec: (none)
- summary: Simple 1 unistroke recognition.
- score: 4
class ErrorBoundary
- file: src/platform/monitoring/ErrorBoundary.tsx:39
- kind: class
- core: platform
- spec: (none)
- summary: Represents error boundary.
- score: 1
class FilterError
- file: src/platform/table-v2/utils/filter/errors.ts:21
- kind: class
- core: platform
- spec: (none)
- summary: Custom error class for filter operations.Provides specific error codes and field path information.
- score: 4
class NoActiveVendorBaaError
- file: src/platform/transcription/hooks/useTranscriptionMutations.ts:52
- kind: class
- core: platform
- spec: (none)
- summary: Error thrown when returns 422. Calling pages should surface this via an linking to .
- score: 4
class OrgProfilePhiBlockedError
- file: src/platform/ai/hooks/usePublishOrgProfileArticle.ts:37
- kind: class
- core: platform
- spec: (none)
- summary: Thrown when the author-time scan detects PHI / injection — publish is blocked.
- score: 4
class PdfBuilder
- file: src/platform/documents/pdfGenerator.ts:416
- kind: class
- core: platform
- spec: (none)
- summary: Fluent PDF builder for complex documents.Uses an async factory () so that jsPDF is loadeddynamically only when a PDF is actually being built.
- score: 4
class PHIDetectedError
- file: src/platform/wizards/utils/sanitizeAnalyticsEvent.ts:152
- kind: class
- core: platform
- spec: (none)
- summary: Error thrown when PHI/PII is detected in data that should not contain it
- score: 4
class PhiRedactionError
- file: src/platform/ai/phi-redaction-core.ts:26
- kind: class
- core: platform
- spec: (none)
- summary: Thrown by on invalid input. Fail-closed: callers MUST skip the LLM call.
- score: 4
class ServiceWorkerLogger
- file: src/platform/pwa/utils/swLifecycleLogger.ts:19
- kind: class
- core: platform
- spec: (none)
- summary: Represents service worker logger.
- score: 4
class SortError
- file: src/platform/table-v2/utils/sort/errors.ts:12
- kind: class
- core: platform
- spec: (none)
- summary: Error thrown when sort configuration is invalid
- score: 4
class StepErrorBoundary
- file: src/platform/wizards/components/steps/StepErrorBoundary.tsx:26
- kind: class
- core: platform
- spec: (none)
- summary: Represents step error boundary.
- score: 4
class TwoPathViolationError
- file: src/platform/ai/phi-two-path-enforcer.ts:29
- kind: class
- core: platform
- spec: (none)
- summary: Raised when a step needs unredacted PHI on a non-PHI-lane model — rejected, never sent degraded.
- score: 4