@jmruthers/pace-core 0.6.11 → 0.6.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{DataTable-EFYP2QLE.js → DataTable-AQAHSFLM.js} +7 -6
- package/dist/{api-BZR2CYXL.js → api-6OQXYT67.js} +2 -1
- package/dist/{chunk-L5LFKKLJ.js → chunk-2GBDPPUC.js} +1 -1
- package/dist/{chunk-J2KQK6DG.js → chunk-AP5FG7W4.js} +2 -2
- package/dist/{chunk-UZNAFKGW.js → chunk-GHCUP64P.js} +1 -21
- package/dist/{chunk-V7FTM2LU.js → chunk-H6RTU4DZ.js} +37 -19
- package/dist/{chunk-KJXRL3XE.js → chunk-HQTYP6BX.js} +79 -45
- package/dist/{chunk-YFTFFJIV.js → chunk-M7QE7XOA.js} +3 -3
- package/dist/{chunk-YYTWKVHO.js → chunk-MVVWZ7JV.js} +25 -30
- package/dist/{chunk-PCSHBLPB.js → chunk-NJ7FGQWB.js} +5 -5
- package/dist/{chunk-WY6Y7KC3.js → chunk-QWIG36BZ.js} +3 -3
- package/dist/{chunk-4R3T5ENU.js → chunk-S57OLCLO.js} +9 -6
- package/dist/chunk-VFLR5K2H.js +23 -0
- package/dist/{chunk-2OEVOGGR.js → chunk-Y2LWSLLB.js} +41 -25
- package/dist/{chunk-7A6IMHH2.js → chunk-YFGNMB67.js} +75 -6
- package/dist/components.d.ts +3 -3
- package/dist/components.js +13 -12
- package/dist/{functions-DH45k8ec.d.ts → functions-hF5ImHCr.d.ts} +1 -1
- package/dist/hooks.js +8 -7
- package/dist/index.d.ts +5 -5
- package/dist/index.js +17 -16
- package/dist/providers.js +3 -2
- package/dist/rbac/index.d.ts +10 -10
- package/dist/rbac/index.js +9 -8
- package/dist/{types-BE2sEHKd.d.ts → types-Besvoyzb.d.ts} +1 -1
- package/dist/{types-CvOPXWWZ.d.ts → types-CGHrxfqc.d.ts} +3 -0
- package/dist/types.d.ts +2 -2
- package/dist/{usePublicPageContext-B91dGYW1.d.ts → usePublicPageContext-BQrHf95t.d.ts} +1 -1
- package/dist/utils.js +4 -3
- package/docs/api/@jmruthers/namespaces/DialogPortal/README.md +14 -0
- package/docs/api/@jmruthers/namespaces/DialogPortal/variables/displayName.md +11 -0
- package/docs/api/README.md +6 -2
- package/docs/api/_media/README.md +186 -0
- package/docs/api/classes/ColumnFactory.md +225 -0
- package/docs/api/classes/Logger.md +246 -0
- package/docs/api/classes/RBACAuditManager.md +299 -0
- package/docs/api/classes/RBACCache.md +389 -0
- package/docs/api/classes/RBACEngine.md +181 -0
- package/docs/api/classes/SecureSupabaseClient.md +168 -0
- package/docs/api/classes/StorageUtils.md +324 -0
- package/docs/api/enumerations/FileCategory.md +137 -0
- package/docs/api/enumerations/LogLevel.md +43 -0
- package/docs/api/enumerations/RBACErrorCode.md +169 -0
- package/docs/api/enumerations/RPCFunction.md +89 -0
- package/docs/api/functions/AccessDenied.md +30 -0
- package/docs/api/functions/AppSwitcher.md +21 -0
- package/docs/api/functions/Badge.md +42 -0
- package/docs/api/functions/ContextSelector.md +43 -0
- package/docs/api/functions/DataTable.md +36 -0
- package/docs/api/functions/DatePickerWithTimezone.md +28 -0
- package/docs/api/functions/DialogBody.md +24 -0
- package/docs/api/functions/DialogFooter.md +24 -0
- package/docs/api/functions/DialogHeader.md +24 -0
- package/docs/api/functions/ErrorBoundaryProvider.md +28 -0
- package/docs/api/functions/EventServiceProvider.md +28 -0
- package/docs/api/functions/FileDisplay.md +25 -0
- package/docs/api/functions/FileUpload.md +21 -0
- package/docs/api/functions/Form.md +50 -0
- package/docs/api/functions/FormField.md +102 -0
- package/docs/api/functions/Header.md +21 -0
- package/docs/api/functions/InactivityServiceProvider.md +28 -0
- package/docs/api/functions/InactivityWarningModal.md +21 -0
- package/docs/api/functions/Input.md +49 -0
- package/docs/api/functions/NavigationGuard.md +31 -0
- package/docs/api/functions/OrganisationServiceProvider.md +28 -0
- package/docs/api/functions/PaceAppLayout.md +169 -0
- package/docs/api/functions/PasswordChangeForm.md +21 -0
- package/docs/api/functions/ProtectedRoute.md +37 -0
- package/docs/api/functions/PublicPageFooter.md +21 -0
- package/docs/api/functions/PublicPageHeader.md +21 -0
- package/docs/api/functions/PublicPageLayout.md +33 -0
- package/docs/api/functions/PublicPageProvider.md +30 -0
- package/docs/api/functions/Textarea.md +49 -0
- package/docs/api/functions/Toaster.md +34 -0
- package/docs/api/functions/UnifiedAuthProvider.md +28 -0
- package/docs/api/functions/applyPalette.md +33 -0
- package/docs/api/functions/archiveFile.md +47 -0
- package/docs/api/functions/average.md +63 -0
- package/docs/api/functions/buildAppUrl.md +46 -0
- package/docs/api/functions/clearInFlightRequests.md +17 -0
- package/docs/api/functions/clearPalette.md +18 -0
- package/docs/api/functions/clearPublicEventCache.md +18 -0
- package/docs/api/functions/clearPublicFileDisplayCache.md +18 -0
- package/docs/api/functions/clearPublicLogoCache.md +18 -0
- package/docs/api/functions/cn.md +21 -0
- package/docs/api/functions/count.md +56 -0
- package/docs/api/functions/createAuditManager.md +45 -0
- package/docs/api/functions/createBaseClient.md +75 -0
- package/docs/api/functions/createLogger.md +95 -0
- package/docs/api/functions/createRBACConfig.md +21 -0
- package/docs/api/functions/createRBACEngine.md +33 -0
- package/docs/api/functions/createRBACExpressMiddleware.md +84 -0
- package/docs/api/functions/createRBACMiddleware.md +88 -0
- package/docs/api/functions/createSecureClient.md +80 -0
- package/docs/api/functions/createSecureDataAccess.md +39 -0
- package/docs/api/functions/deleteFile.md +33 -0
- package/docs/api/functions/disablePerformanceMonitoring.md +17 -0
- package/docs/api/functions/downloadFile.md +33 -0
- package/docs/api/functions/emitAuditEvent.md +27 -0
- package/docs/api/functions/enablePerformanceMonitoring.md +17 -0
- package/docs/api/functions/err.md +23 -0
- package/docs/api/functions/exportToCSV.md +56 -0
- package/docs/api/functions/exportToCSVWithTableRows.md +46 -0
- package/docs/api/functions/extractEventCodeFromPath.md +24 -0
- package/docs/api/functions/extractFileMetadata.md +33 -0
- package/docs/api/functions/formatCompactNumber.md +27 -0
- package/docs/api/functions/formatCurrency.md +31 -0
- package/docs/api/functions/formatDate.md +23 -0
- package/docs/api/functions/formatDateTime.md +24 -0
- package/docs/api/functions/formatFileSize.md +23 -0
- package/docs/api/functions/formatInTimeZone.md +46 -0
- package/docs/api/functions/formatNumber.md +31 -0
- package/docs/api/functions/formatPercent.md +64 -0
- package/docs/api/functions/formatTime.md +24 -0
- package/docs/api/functions/formatTimeInTimeZone.md +40 -0
- package/docs/api/functions/fromSupabaseClient.md +49 -0
- package/docs/api/functions/fromZonedTime.md +41 -0
- package/docs/api/functions/generateCSVContent.md +55 -0
- package/docs/api/functions/generateFilePath.md +29 -0
- package/docs/api/functions/generateFileUrlsBatch.md +33 -0
- package/docs/api/functions/generatePublicRoutePath.md +27 -0
- package/docs/api/functions/generateUniqueFileName.md +24 -0
- package/docs/api/functions/getAccessLevel.md +48 -0
- package/docs/api/functions/getAllAppPorts.md +19 -0
- package/docs/api/functions/getAllStylePaths.md +15 -0
- package/docs/api/functions/getAppConfig.md +17 -0
- package/docs/api/functions/getAppPort.md +34 -0
- package/docs/api/functions/getBucketName.md +27 -0
- package/docs/api/functions/getCurrentAppId.md +17 -0
- package/docs/api/functions/getCurrentAppName.md +17 -0
- package/docs/api/functions/getFileSizeLimit.md +23 -0
- package/docs/api/functions/getGlobalAuditManager.md +19 -0
- package/docs/api/functions/getInFlightRequestCount.md +19 -0
- package/docs/api/functions/getPerformanceMetrics.md +17 -0
- package/docs/api/functions/getPerformanceSummary.md +17 -0
- package/docs/api/functions/getPermissionMap.md +52 -0
- package/docs/api/functions/getPublicEventCacheStats.md +25 -0
- package/docs/api/functions/getPublicFileDisplayCacheStats.md +25 -0
- package/docs/api/functions/getPublicLogoCacheStats.md +25 -0
- package/docs/api/functions/getPublicUrl.md +39 -0
- package/docs/api/functions/getRBACConfig.md +15 -0
- package/docs/api/functions/getRBACLogger.md +15 -0
- package/docs/api/functions/getRoleContext.md +31 -0
- package/docs/api/functions/getSignedUrl.md +34 -0
- package/docs/api/functions/getStylePath.md +21 -0
- package/docs/api/functions/getTimeZoneDifference.md +40 -0
- package/docs/api/functions/getTimezoneAbbreviation.md +40 -0
- package/docs/api/functions/getUserTimeZone.md +26 -0
- package/docs/api/functions/hasAllPermissions.md +41 -0
- package/docs/api/functions/hasAnyPermission.md +41 -0
- package/docs/api/functions/isDebugMode.md +15 -0
- package/docs/api/functions/isDevelopmentMode.md +15 -0
- package/docs/api/functions/isErr.md +29 -0
- package/docs/api/functions/isOk.md +29 -0
- package/docs/api/functions/isPerformanceMonitoringEnabled.md +17 -0
- package/docs/api/functions/isPermitted.md +58 -0
- package/docs/api/functions/isPermittedCached.md +36 -0
- package/docs/api/functions/isRBACInitialized.md +19 -0
- package/docs/api/functions/isSecureClient.md +38 -0
- package/docs/api/functions/isValidPermission.md +27 -0
- package/docs/api/functions/listFiles.md +29 -0
- package/docs/api/functions/max.md +63 -0
- package/docs/api/functions/min.md +63 -0
- package/docs/api/functions/ok.md +29 -0
- package/docs/api/functions/parseAndNormalizeEventColours.md +105 -0
- package/docs/api/functions/recordAuditEvent.md +23 -0
- package/docs/api/functions/recordPermissionCheck.md +31 -0
- package/docs/api/functions/resetPerformanceMetrics.md +17 -0
- package/docs/api/functions/resolveAppContext.md +27 -0
- package/docs/api/functions/roundToNearestMinutes.md +41 -0
- package/docs/api/functions/sanitizeFormData.md +49 -0
- package/docs/api/functions/sanitizeHtml.md +39 -0
- package/docs/api/functions/sanitizeUserInput.md +27 -0
- package/docs/api/functions/setAppConfig.md +23 -0
- package/docs/api/functions/setGlobalAuditManager.md +25 -0
- package/docs/api/functions/setupRBAC.md +31 -0
- package/docs/api/functions/sum.md +63 -0
- package/docs/api/functions/toZonedTime.md +41 -0
- package/docs/api/functions/uploadFile.md +32 -0
- package/docs/api/functions/useAccessLevel.md +71 -0
- package/docs/api/functions/useAccessibleApps.md +55 -0
- package/docs/api/functions/useAppConfig.md +20 -0
- package/docs/api/functions/useAuthService.md +15 -0
- package/docs/api/functions/useCan.md +99 -0
- package/docs/api/functions/useEventService.md +15 -0
- package/docs/api/functions/useEventTheme.md +26 -0
- package/docs/api/functions/useEvents.md +45 -0
- package/docs/api/functions/useFileReference.md +264 -0
- package/docs/api/functions/useFileReferenceById.md +63 -0
- package/docs/api/functions/useFileReferenceForRecord.md +129 -0
- package/docs/api/functions/useFilesByCategory.md +80 -0
- package/docs/api/functions/useFormDialog.md +62 -0
- package/docs/api/functions/useInactivityService.md +15 -0
- package/docs/api/functions/useInactivityTracker.md +21 -0
- package/docs/api/functions/useIsPublicPage.md +19 -0
- package/docs/api/functions/useMultiplePermissions.md +88 -0
- package/docs/api/functions/useOptionalEvents.md +31 -0
- package/docs/api/functions/useOrganisationPermissions.md +27 -0
- package/docs/api/functions/useOrganisationSecurity.md +15 -0
- package/docs/api/functions/useOrganisationService.md +15 -0
- package/docs/api/functions/useOrganisations.md +48 -0
- package/docs/api/functions/usePermissions.md +130 -0
- package/docs/api/functions/usePublicEvent.md +36 -0
- package/docs/api/functions/usePublicEventCode.md +32 -0
- package/docs/api/functions/usePublicEventLogo.md +48 -0
- package/docs/api/functions/usePublicFileDisplay.md +54 -0
- package/docs/api/functions/usePublicPageContext.md +19 -0
- package/docs/api/functions/usePublicRouteParams.md +31 -0
- package/docs/api/functions/useRBAC.md +21 -0
- package/docs/api/functions/useResolvedScope.md +46 -0
- package/docs/api/functions/useResourcePermissions.md +25 -0
- package/docs/api/functions/useRoleManagement.md +121 -0
- package/docs/api/functions/useSecureSupabase.md +51 -0
- package/docs/api/functions/useSessionRestoration.md +15 -0
- package/docs/api/functions/useSessionTracking.md +62 -0
- package/docs/api/functions/useToast.md +83 -0
- package/docs/api/functions/useUnifiedAuth.md +24 -0
- package/docs/api/functions/useZodForm.md +27 -0
- package/docs/api/functions/validateFileSize.md +31 -0
- package/docs/api/functions/warnIfInsecureClient.md +40 -0
- package/docs/api/functions/withAccessLevelGuard.md +67 -0
- package/docs/api/functions/withPermissionGuard.md +73 -0
- package/docs/api/functions/withRoleGuard.md +86 -0
- package/docs/api/globals.md +502 -0
- package/docs/api/interfaces/AccessDeniedProps.md +87 -0
- package/docs/api/interfaces/AccessibleApp.md +41 -0
- package/docs/api/interfaces/AddressFieldProps.md +195 -0
- package/docs/api/interfaces/AddressFieldRef.md +67 -0
- package/docs/api/interfaces/AggregateConfig.md +35 -0
- package/docs/api/interfaces/AppSwitcherProps.md +51 -0
- package/docs/api/interfaces/AuthSessionData.md +27 -0
- package/docs/api/interfaces/AutocompleteOptions.md +61 -0
- package/docs/api/interfaces/AvatarProps.md +97 -0
- package/docs/api/interfaces/BadgeProps.md +30 -0
- package/docs/api/interfaces/BuildAppUrlOptions.md +41 -0
- package/docs/api/interfaces/ButtonProps.md +46 -0
- package/docs/api/interfaces/CalendarProps.md +60 -0
- package/docs/api/interfaces/CardProps.md +56 -0
- package/docs/api/interfaces/ColorPalette.md +13 -0
- package/docs/api/interfaces/ColorShade.md +58 -0
- package/docs/api/interfaces/ContextSelectorProps.md +131 -0
- package/docs/api/interfaces/DataRecord.md +16 -0
- package/docs/api/interfaces/DataTableAction.md +198 -0
- package/docs/api/interfaces/DataTableColumn.md +422 -0
- package/docs/api/interfaces/DataTableProps.md +511 -0
- package/docs/api/interfaces/DataTableToolbarButton.md +75 -0
- package/docs/api/interfaces/DatePickerWithTimezoneProps.md +75 -0
- package/docs/api/interfaces/DialogBodyProps.md +55 -0
- package/docs/api/interfaces/DialogCloseProps.md +25 -0
- package/docs/api/interfaces/DialogContentProps.md +160 -0
- package/docs/api/interfaces/DialogFooterProps.md +25 -0
- package/docs/api/interfaces/DialogHeaderProps.md +25 -0
- package/docs/api/interfaces/DialogPortalProps.md +19 -0
- package/docs/api/interfaces/DialogProps.md +53 -0
- package/docs/api/interfaces/DialogTriggerProps.md +53 -0
- package/docs/api/interfaces/EmptyStateConfig.md +55 -0
- package/docs/api/interfaces/ErrorBoundaryProps.md +131 -0
- package/docs/api/interfaces/ErrorBoundaryProviderProps.md +31 -0
- package/docs/api/interfaces/ErrorBoundaryState.md +61 -0
- package/docs/api/interfaces/EventAppRoleData.md +54 -0
- package/docs/api/interfaces/ExportColumn.md +69 -0
- package/docs/api/interfaces/ExportOptions.md +109 -0
- package/docs/api/interfaces/FileDisplayProps.md +192 -0
- package/docs/api/interfaces/FileMetadata.md +97 -0
- package/docs/api/interfaces/FileReference.md +89 -0
- package/docs/api/interfaces/FileSizeLimits.md +13 -0
- package/docs/api/interfaces/FileUploadOptions.md +107 -0
- package/docs/api/interfaces/FooterProps.md +37 -0
- package/docs/api/interfaces/FormFieldProps.md +171 -0
- package/docs/api/interfaces/FormProps.md +93 -0
- package/docs/api/interfaces/GrantEventAppRoleParams.md +97 -0
- package/docs/api/interfaces/ImportSummary.md +49 -0
- package/docs/api/interfaces/InactivityWarningModalProps.md +87 -0
- package/docs/api/interfaces/InputProps.md +46 -0
- package/docs/api/interfaces/InvalidScopeError.md +37 -0
- package/docs/api/interfaces/LabelProps.md +85 -0
- package/docs/api/interfaces/LoggerConfig.md +51 -0
- package/docs/api/interfaces/LoginFormProps.md +146 -0
- package/docs/api/interfaces/MissingUserContextError.md +37 -0
- package/docs/api/interfaces/NavigationGuardProps.md +109 -0
- package/docs/api/interfaces/NavigationItem.md +91 -0
- package/docs/api/interfaces/NavigationMenuProps.md +169 -0
- package/docs/api/interfaces/Organisation.md +105 -0
- package/docs/api/interfaces/OrganisationContextRequiredError.md +37 -0
- package/docs/api/interfaces/OrganisationMembership.md +105 -0
- package/docs/api/interfaces/OrganisationSecurityError.md +49 -0
- package/docs/api/interfaces/PaceAppLayoutPermissionConfig.md +127 -0
- package/docs/api/interfaces/PaceAppLayoutRouteConfigItem.md +91 -0
- package/docs/api/interfaces/PaceAppLayoutRoutingConfig.md +79 -0
- package/docs/api/interfaces/PaceLoginPageProps.md +41 -0
- package/docs/api/interfaces/PagePermissionGuardProps.md +143 -0
- package/docs/api/interfaces/PaletteData.md +33 -0
- package/docs/api/interfaces/ParsedAddress.md +91 -0
- package/docs/api/interfaces/PermissionDeniedError.md +37 -0
- package/docs/api/interfaces/ProgressProps.md +35 -0
- package/docs/api/interfaces/ProtectedRouteProps.md +67 -0
- package/docs/api/interfaces/PublicPageFooterProps.md +97 -0
- package/docs/api/interfaces/PublicPageHeaderProps.md +99 -0
- package/docs/api/interfaces/PublicPageLayoutProps.md +153 -0
- package/docs/api/interfaces/RBACAccessValidateParams.md +41 -0
- package/docs/api/interfaces/RBACAccessValidateResult.md +33 -0
- package/docs/api/interfaces/RBACAuditLogParams.md +65 -0
- package/docs/api/interfaces/RBACAuditLogResult.md +41 -0
- package/docs/api/interfaces/RBACContext.md +41 -0
- package/docs/api/interfaces/RBACError.md +37 -0
- package/docs/api/interfaces/RBACLogger.md +97 -0
- package/docs/api/interfaces/RBACNotInitializedError.md +37 -0
- package/docs/api/interfaces/RBACPageAccessCheckParams.md +57 -0
- package/docs/api/interfaces/RBACPerformanceMetrics.md +109 -0
- package/docs/api/interfaces/RBACPermissionCheckParams.md +57 -0
- package/docs/api/interfaces/RBACPermissionCheckResult.md +41 -0
- package/docs/api/interfaces/RBACPermissionsGetParams.md +49 -0
- package/docs/api/interfaces/RBACPermissionsGetResult.md +49 -0
- package/docs/api/interfaces/RBACResult.md +47 -0
- package/docs/api/interfaces/RBACRoleGrantParams.md +49 -0
- package/docs/api/interfaces/RBACRoleGrantResult.md +41 -0
- package/docs/api/interfaces/RBACRoleRevokeParams.md +49 -0
- package/docs/api/interfaces/RBACRoleRevokeResult.md +41 -0
- package/docs/api/interfaces/RBACRoleValidateParams.md +41 -0
- package/docs/api/interfaces/RBACRoleValidateResult.md +49 -0
- package/docs/api/interfaces/RBACRolesListParams.md +41 -0
- package/docs/api/interfaces/RBACRolesListResult.md +57 -0
- package/docs/api/interfaces/RBACSessionTrackParams.md +57 -0
- package/docs/api/interfaces/RBACSessionTrackResult.md +41 -0
- package/docs/api/interfaces/ResourcePermissions.md +119 -0
- package/docs/api/interfaces/RevokeEventAppRoleParams.md +81 -0
- package/docs/api/interfaces/RoleManagementResult.md +41 -0
- package/docs/api/interfaces/SessionRestorationLoaderProps.md +29 -0
- package/docs/api/interfaces/StorageConfig.md +33 -0
- package/docs/api/interfaces/StorageFileInfo.md +57 -0
- package/docs/api/interfaces/StorageFileMetadata.md +113 -0
- package/docs/api/interfaces/StorageListOptions.md +79 -0
- package/docs/api/interfaces/StorageListResult.md +33 -0
- package/docs/api/interfaces/StorageUploadOptions.md +81 -0
- package/docs/api/interfaces/StorageUploadResult.md +49 -0
- package/docs/api/interfaces/StorageUploadSuccess.md +35 -0
- package/docs/api/interfaces/StorageUrlOptions.md +49 -0
- package/docs/api/interfaces/StyleImport.md +17 -0
- package/docs/api/interfaces/SwitchProps.md +30 -0
- package/docs/api/interfaces/TabsContentProps.md +13 -0
- package/docs/api/interfaces/TabsListProps.md +13 -0
- package/docs/api/interfaces/TabsProps.md +13 -0
- package/docs/api/interfaces/TabsTriggerProps.md +41 -0
- package/docs/api/interfaces/TextareaProps.md +43 -0
- package/docs/api/interfaces/ToastActionElement.md +16 -0
- package/docs/api/interfaces/ToastProps.md +13 -0
- package/docs/api/interfaces/UnifiedAuthProviderProps.md +129 -0
- package/docs/api/interfaces/UseAccessibleAppsReturn.md +55 -0
- package/docs/api/interfaces/UseFormDialogOptions.md +49 -0
- package/docs/api/interfaces/UseFormDialogReturn.md +95 -0
- package/docs/api/interfaces/UseInactivityTrackerOptions.md +103 -0
- package/docs/api/interfaces/UseInactivityTrackerReturn.md +91 -0
- package/docs/api/interfaces/UsePublicEventLogoOptions.md +69 -0
- package/docs/api/interfaces/UsePublicEventLogoReturn.md +66 -0
- package/docs/api/interfaces/UsePublicEventOptions.md +29 -0
- package/docs/api/interfaces/UsePublicEventReturn.md +56 -0
- package/docs/api/interfaces/UsePublicFileDisplayOptions.md +39 -0
- package/docs/api/interfaces/UsePublicFileDisplayReturn.md +96 -0
- package/docs/api/interfaces/UsePublicRouteParamsReturn.md +76 -0
- package/docs/api/interfaces/UseResolvedScopeOptions.md +49 -0
- package/docs/api/interfaces/UseResolvedScopeReturn.md +39 -0
- package/docs/api/interfaces/UseResourcePermissionsOptions.md +29 -0
- package/docs/api/interfaces/UserEventAccess.md +92 -0
- package/docs/api/interfaces/UserMenuProps.md +69 -0
- package/docs/api/interfaces/UserProfile.md +49 -0
- package/docs/api/type-aliases/AccessLevel.md +11 -0
- package/docs/api/type-aliases/AccessLevelContext.md +14 -0
- package/docs/api/type-aliases/AllPermissions.md +11 -0
- package/docs/api/type-aliases/ApiError.md +37 -0
- package/docs/api/type-aliases/ApiResult.md +19 -0
- package/docs/api/type-aliases/AuditEventType.md +11 -0
- package/docs/api/type-aliases/BadgeVariant.md +18 -0
- package/docs/api/type-aliases/DataTableFeatureConfig.md +14 -0
- package/docs/api/type-aliases/DialogSize.md +13 -0
- package/docs/api/type-aliases/EventAppRole.md +11 -0
- package/docs/api/type-aliases/FileUploadProps.md +15 -0
- package/docs/api/type-aliases/GetRowId.md +33 -0
- package/docs/api/type-aliases/GlobalErrorHandler.md +35 -0
- package/docs/api/type-aliases/GlobalRole.md +11 -0
- package/docs/api/type-aliases/ImportHandlerResult.md +13 -0
- package/docs/api/type-aliases/NavigationMode.md +13 -0
- package/docs/api/type-aliases/Operation.md +11 -0
- package/docs/api/type-aliases/OrganisationContextType.md +13 -0
- package/docs/api/type-aliases/OrganisationRole.md +11 -0
- package/docs/api/type-aliases/PaceAppLayoutProps.md +14 -0
- package/docs/api/type-aliases/Permission.md +11 -0
- package/docs/api/type-aliases/PermissionCheck.md +46 -0
- package/docs/api/type-aliases/PermissionMap.md +11 -0
- package/docs/api/type-aliases/PermissionSource.md +13 -0
- package/docs/api/type-aliases/RBACConfig.md +13 -0
- package/docs/api/type-aliases/RBACFunctionResponse.md +57 -0
- package/docs/api/type-aliases/Scope.md +41 -0
- package/docs/api/type-aliases/SessionType.md +11 -0
- package/docs/api/type-aliases/UUID.md +11 -0
- package/docs/api/type-aliases/UnifiedAuthContextType.md +13 -0
- package/docs/api/type-aliases/UseFileReferenceForRecordReturn.md +161 -0
- package/docs/api/type-aliases/UseFileReferenceOptions.md +35 -0
- package/docs/api/type-aliases/UseFileReferenceReturn.md +13 -0
- package/docs/api/variables/ALL_PERMISSIONS.md +281 -0
- package/docs/api/variables/APP_PATH_MAPPING.md +14 -0
- package/docs/api/variables/AddressField.md +41 -0
- package/docs/api/variables/Alert.md +11 -0
- package/docs/api/variables/AlertDescription.md +11 -0
- package/docs/api/variables/AlertTitle.md +11 -0
- package/docs/api/variables/Avatar.md +13 -0
- package/docs/api/variables/Button.md +31 -0
- package/docs/api/variables/CACHE_PATTERNS.md +89 -0
- package/docs/api/variables/Calendar.md +74 -0
- package/docs/api/variables/Card.md +11 -0
- package/docs/api/variables/CardActions.md +11 -0
- package/docs/api/variables/CardContent.md +11 -0
- package/docs/api/variables/CardDescription.md +11 -0
- package/docs/api/variables/CardFooter.md +11 -0
- package/docs/api/variables/CardHeader.md +11 -0
- package/docs/api/variables/CardTitle.md +11 -0
- package/docs/api/variables/Checkbox.md +11 -0
- package/docs/api/variables/DEFAULT_APP_PORT_MAP.md +14 -0
- package/docs/api/variables/DEFAULT_FILE_SIZE_LIMIT.md +13 -0
- package/docs/api/variables/Dialog.md +14 -0
- package/docs/api/variables/DialogClose.md +14 -0
- package/docs/api/variables/DialogContent.md +28 -0
- package/docs/api/variables/DialogDescription.md +14 -0
- package/docs/api/variables/DialogPortal.md +14 -0
- package/docs/api/variables/DialogTitle.md +14 -0
- package/docs/api/variables/DialogTrigger.md +14 -0
- package/docs/api/variables/EVENT_APP_PERMISSIONS.md +109 -0
- package/docs/api/variables/ErrorBoundary.md +15 -0
- package/docs/api/variables/FILE_SIZE_LIMITS.md +13 -0
- package/docs/api/variables/Footer.md +11 -0
- package/docs/api/variables/GLOBAL_PERMISSIONS.md +29 -0
- package/docs/api/variables/Label.md +34 -0
- package/docs/api/variables/LoadingSpinner.md +28 -0
- package/docs/api/variables/LoginForm.md +34 -0
- package/docs/api/variables/NavigationMenu.md +203 -0
- package/docs/api/variables/ORGANISATION_PERMISSIONS.md +89 -0
- package/docs/api/variables/PAGE_PERMISSIONS.md +93 -0
- package/docs/api/variables/PaceLoginPage.md +40 -0
- package/docs/api/variables/PagePermissionGuard.md +11 -0
- package/docs/api/variables/Progress.md +32 -0
- package/docs/api/variables/SECURE_CLIENT_SYMBOL.md +14 -0
- package/docs/api/variables/STORAGE_CONFIG.md +13 -0
- package/docs/api/variables/Select.md +26 -0
- package/docs/api/variables/SelectContent.md +26 -0
- package/docs/api/variables/SelectGroup.md +26 -0
- package/docs/api/variables/SelectItem.md +26 -0
- package/docs/api/variables/SelectLabel.md +26 -0
- package/docs/api/variables/SelectSeparator.md +26 -0
- package/docs/api/variables/SelectTrigger.md +26 -0
- package/docs/api/variables/SelectValue.md +26 -0
- package/docs/api/variables/SessionRestorationLoader.md +11 -0
- package/docs/api/variables/Switch.md +23 -0
- package/docs/api/variables/Table.md +35 -0
- package/docs/api/variables/TableBody.md +11 -0
- package/docs/api/variables/TableCaption.md +11 -0
- package/docs/api/variables/TableCell.md +11 -0
- package/docs/api/variables/TableFooter.md +11 -0
- package/docs/api/variables/TableHead.md +11 -0
- package/docs/api/variables/TableHeader.md +11 -0
- package/docs/api/variables/TableRow.md +11 -0
- package/docs/api/variables/Tabs.md +25 -0
- package/docs/api/variables/TabsContent.md +24 -0
- package/docs/api/variables/TabsList.md +25 -0
- package/docs/api/variables/TabsTrigger.md +34 -0
- package/docs/api/variables/Toast.md +36 -0
- package/docs/api/variables/ToastAction.md +32 -0
- package/docs/api/variables/ToastClose.md +32 -0
- package/docs/api/variables/ToastDescription.md +32 -0
- package/docs/api/variables/ToastProvider.md +11 -0
- package/docs/api/variables/ToastTitle.md +32 -0
- package/docs/api/variables/ToastViewport.md +26 -0
- package/docs/api/variables/Tooltip.md +34 -0
- package/docs/api/variables/TooltipContent.md +34 -0
- package/docs/api/variables/TooltipProvider.md +11 -0
- package/docs/api/variables/TooltipRoot.md +11 -0
- package/docs/api/variables/TooltipTrigger.md +11 -0
- package/docs/api/variables/UserMenu.md +11 -0
- package/docs/api/variables/emailSchema.md +13 -0
- package/docs/api/variables/logger.md +203 -0
- package/docs/api/variables/nameSchema.md +13 -0
- package/docs/api/variables/passwordSchema.md +13 -0
- package/docs/api/variables/phoneSchema.md +13 -0
- package/docs/api/variables/rbacCache.md +16 -0
- package/docs/api/variables/styleConfig.md +25 -0
- package/docs/api/variables/urlSchema.md +13 -0
- package/docs/api-reference/hooks.md +2 -0
- package/docs/implementation-guides/data-tables.md +8 -0
- package/docs/rbac/getting-started.md +7 -0
- package/docs/rbac/troubleshooting.md +5 -1
- package/package.json +3 -3
- package/src/components/DataTable/hooks/useDataTableEffectiveActions.ts +29 -19
- package/src/components/DataTable/hooks/useDataTableScope.test.ts +5 -13
- package/src/components/DataTable/hooks/useDataTableScope.ts +16 -14
- package/src/components/Dialog/useDialogLifecycle.test.ts +4 -1
- package/src/components/FileDisplay/useFileDisplay.unit.test.ts +12 -8
- package/src/components/PaceAppLayout/PaceAppLayout.edge-cases.test.tsx +33 -9
- package/src/components/PaceAppLayout/useFilteredNavItems.ts +22 -7
- package/src/components/PaceAppLayout/usePaceAppLayoutConfig.ts +44 -23
- package/src/components/PaceAppLayout/usePaceAppLayoutPermissions.ts +1 -1
- package/src/components/PaceAppLayout/usePaceAppLayoutScope.ts +6 -4
- package/src/components/PaceAppLayout/useRoleBasedRouteAccess.ts +2 -2
- package/src/hooks/useAppConfig.unit.test.ts +74 -66
- package/src/hooks/useComponentPerformance.unit.test.tsx +6 -4
- package/src/hooks/useFileUrl.unit.test.ts +1 -3
- package/src/hooks/useInactivityTracker.unit.test.ts +6 -2
- package/src/hooks/usePerformanceMonitor.unit.test.ts +6 -16
- package/src/hooks/usePublicEvent.simple.test.ts +32 -47
- package/src/hooks/usePublicEvent.test.ts +9 -15
- package/src/providers/services/AuthServiceProvider.test.tsx +10 -5
- package/src/providers/services/EventServiceProvider.test.tsx +8 -3
- package/src/providers/services/InactivityServiceProvider.test.tsx +8 -3
- package/src/providers/services/OrganisationServiceProvider.test.tsx +8 -3
- package/src/rbac/README.md +7 -5
- package/src/rbac/api.test.ts +113 -56
- package/src/rbac/api.ts +80 -10
- package/src/rbac/components/NavigationGuard.tsx +2 -1
- package/src/rbac/components/PagePermissionGuard.test.tsx +23 -10
- package/src/rbac/engine.ts +23 -1
- package/src/rbac/hooks/permissions/runPermissionCheck.ts +18 -4
- package/src/rbac/hooks/permissions/useCan.test.ts +59 -20
- package/src/rbac/hooks/permissions/useCan.ts +7 -3
- package/src/rbac/hooks/permissions/useMultiplePermissions.ts +18 -9
- package/src/rbac/hooks/useCan.test.ts +2 -3
- package/src/rbac/hooks/usePageGuardScope.ts +6 -4
- package/src/rbac/hooks/usePagePermissionCheck.ts +4 -4
- package/src/rbac/hooks/useResolvedScope.ts +16 -10
- package/src/rbac/hooks/useResourcePermissions.test.ts +48 -58
- package/src/rbac/hooks/useResourcePermissions.ts +11 -20
- package/src/rbac/types.ts +3 -0
- package/src/services/AuthService.edge-cases.test.ts +2 -2
- package/src/services/EventService.ts +9 -4
- package/src/utils/file-reference/file-reference.test.ts +25 -14
- package/src/utils/supabase/createBaseClient.test.ts +30 -13
- package/docs/api/modules.md +0 -10028
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / UseAccessibleAppsReturn
|
|
6
|
+
|
|
7
|
+
# Interface: UseAccessibleAppsReturn
|
|
8
|
+
|
|
9
|
+
Defined in: [hooks/useAccessibleApps.ts:33](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useAccessibleApps.ts#L33)
|
|
10
|
+
|
|
11
|
+
Return type for useAccessibleApps hook.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### apps
|
|
16
|
+
|
|
17
|
+
> **apps**: [`AccessibleApp`](AccessibleApp.md)[]
|
|
18
|
+
|
|
19
|
+
Defined in: [hooks/useAccessibleApps.ts:35](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useAccessibleApps.ts#L35)
|
|
20
|
+
|
|
21
|
+
Array of accessible apps
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### loading
|
|
26
|
+
|
|
27
|
+
> **loading**: `boolean`
|
|
28
|
+
|
|
29
|
+
Defined in: [hooks/useAccessibleApps.ts:37](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useAccessibleApps.ts#L37)
|
|
30
|
+
|
|
31
|
+
Whether the query is loading
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### error
|
|
36
|
+
|
|
37
|
+
> **error**: `Error` \| `null`
|
|
38
|
+
|
|
39
|
+
Defined in: [hooks/useAccessibleApps.ts:39](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useAccessibleApps.ts#L39)
|
|
40
|
+
|
|
41
|
+
Error if query failed
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### refetch()
|
|
46
|
+
|
|
47
|
+
> **refetch**: () => `Promise`\<`void`\>
|
|
48
|
+
|
|
49
|
+
Defined in: [hooks/useAccessibleApps.ts:41](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useAccessibleApps.ts#L41)
|
|
50
|
+
|
|
51
|
+
Refetch the apps
|
|
52
|
+
|
|
53
|
+
#### Returns
|
|
54
|
+
|
|
55
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / UseFormDialogOptions
|
|
6
|
+
|
|
7
|
+
# Interface: UseFormDialogOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [hooks/useFormDialog.ts:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L31)
|
|
10
|
+
|
|
11
|
+
Options for configuring the useFormDialog hook behavior
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### onOpenChange()?
|
|
16
|
+
|
|
17
|
+
> `optional` **onOpenChange**: (`open`) => `void`
|
|
18
|
+
|
|
19
|
+
Defined in: [hooks/useFormDialog.ts:36](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L36)
|
|
20
|
+
|
|
21
|
+
Callback invoked when the dialog open state changes
|
|
22
|
+
|
|
23
|
+
#### Parameters
|
|
24
|
+
|
|
25
|
+
##### open
|
|
26
|
+
|
|
27
|
+
`boolean`
|
|
28
|
+
|
|
29
|
+
The new open state
|
|
30
|
+
|
|
31
|
+
#### Returns
|
|
32
|
+
|
|
33
|
+
`void`
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### resetOnClose?
|
|
38
|
+
|
|
39
|
+
> `optional` **resetOnClose**: `boolean`
|
|
40
|
+
|
|
41
|
+
Defined in: [hooks/useFormDialog.ts:42](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L42)
|
|
42
|
+
|
|
43
|
+
Whether to reset form data when the dialog closes
|
|
44
|
+
|
|
45
|
+
#### Default
|
|
46
|
+
|
|
47
|
+
```ts
|
|
48
|
+
true
|
|
49
|
+
```
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / UseFormDialogReturn
|
|
6
|
+
|
|
7
|
+
# Interface: UseFormDialogReturn\<T\>
|
|
8
|
+
|
|
9
|
+
Defined in: [hooks/useFormDialog.ts:48](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L48)
|
|
10
|
+
|
|
11
|
+
Return type for the useFormDialog hook
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### T
|
|
16
|
+
|
|
17
|
+
`T` = `unknown`
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### isOpen
|
|
22
|
+
|
|
23
|
+
> **isOpen**: `boolean`
|
|
24
|
+
|
|
25
|
+
Defined in: [hooks/useFormDialog.ts:52](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L52)
|
|
26
|
+
|
|
27
|
+
Current open state of the dialog
|
|
28
|
+
|
|
29
|
+
***
|
|
30
|
+
|
|
31
|
+
### formData
|
|
32
|
+
|
|
33
|
+
> **formData**: `T` \| `null`
|
|
34
|
+
|
|
35
|
+
Defined in: [hooks/useFormDialog.ts:57](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L57)
|
|
36
|
+
|
|
37
|
+
Current form data (null when dialog is closed or no data provided)
|
|
38
|
+
|
|
39
|
+
***
|
|
40
|
+
|
|
41
|
+
### openDialog()
|
|
42
|
+
|
|
43
|
+
> **openDialog**: (`data?`) => `void`
|
|
44
|
+
|
|
45
|
+
Defined in: [hooks/useFormDialog.ts:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L63)
|
|
46
|
+
|
|
47
|
+
Open the dialog with optional form data
|
|
48
|
+
|
|
49
|
+
#### Parameters
|
|
50
|
+
|
|
51
|
+
##### data?
|
|
52
|
+
|
|
53
|
+
Optional form data to populate the dialog
|
|
54
|
+
|
|
55
|
+
`T` | `null`
|
|
56
|
+
|
|
57
|
+
#### Returns
|
|
58
|
+
|
|
59
|
+
`void`
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### closeDialog()
|
|
64
|
+
|
|
65
|
+
> **closeDialog**: () => `void`
|
|
66
|
+
|
|
67
|
+
Defined in: [hooks/useFormDialog.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L68)
|
|
68
|
+
|
|
69
|
+
Close the dialog
|
|
70
|
+
|
|
71
|
+
#### Returns
|
|
72
|
+
|
|
73
|
+
`void`
|
|
74
|
+
|
|
75
|
+
***
|
|
76
|
+
|
|
77
|
+
### handleOpenChange()
|
|
78
|
+
|
|
79
|
+
> **handleOpenChange**: (`open`) => `void`
|
|
80
|
+
|
|
81
|
+
Defined in: [hooks/useFormDialog.ts:74](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L74)
|
|
82
|
+
|
|
83
|
+
Handler for controlled dialog components (e.g., Radix UI Dialog)
|
|
84
|
+
|
|
85
|
+
#### Parameters
|
|
86
|
+
|
|
87
|
+
##### open
|
|
88
|
+
|
|
89
|
+
`boolean`
|
|
90
|
+
|
|
91
|
+
The new open state
|
|
92
|
+
|
|
93
|
+
#### Returns
|
|
94
|
+
|
|
95
|
+
`void`
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / UseInactivityTrackerOptions
|
|
6
|
+
|
|
7
|
+
# Interface: UseInactivityTrackerOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [hooks/useInactivityTracker.ts:61](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L61)
|
|
10
|
+
|
|
11
|
+
Options for the useInactivityTracker hook.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### idleTimeoutMs?
|
|
16
|
+
|
|
17
|
+
> `optional` **idleTimeoutMs**: `number`
|
|
18
|
+
|
|
19
|
+
Defined in: [hooks/useInactivityTracker.ts:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L63)
|
|
20
|
+
|
|
21
|
+
Timeout in milliseconds before user is considered idle (default: 30 minutes)
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### warnBeforeMs?
|
|
26
|
+
|
|
27
|
+
> `optional` **warnBeforeMs**: `number`
|
|
28
|
+
|
|
29
|
+
Defined in: [hooks/useInactivityTracker.ts:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L65)
|
|
30
|
+
|
|
31
|
+
Time in milliseconds before idle timeout to show warning (default: 60 seconds)
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### onIdle()?
|
|
36
|
+
|
|
37
|
+
> `optional` **onIdle**: () => `void`
|
|
38
|
+
|
|
39
|
+
Defined in: [hooks/useInactivityTracker.ts:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L67)
|
|
40
|
+
|
|
41
|
+
Callback when user becomes idle
|
|
42
|
+
|
|
43
|
+
#### Returns
|
|
44
|
+
|
|
45
|
+
`void`
|
|
46
|
+
|
|
47
|
+
***
|
|
48
|
+
|
|
49
|
+
### onWarning()?
|
|
50
|
+
|
|
51
|
+
> `optional` **onWarning**: () => `void`
|
|
52
|
+
|
|
53
|
+
Defined in: [hooks/useInactivityTracker.ts:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L69)
|
|
54
|
+
|
|
55
|
+
Callback when warning should be shown
|
|
56
|
+
|
|
57
|
+
#### Returns
|
|
58
|
+
|
|
59
|
+
`void`
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### onActivity()?
|
|
64
|
+
|
|
65
|
+
> `optional` **onActivity**: () => `void`
|
|
66
|
+
|
|
67
|
+
Defined in: [hooks/useInactivityTracker.ts:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L71)
|
|
68
|
+
|
|
69
|
+
Callback when user becomes active again
|
|
70
|
+
|
|
71
|
+
#### Returns
|
|
72
|
+
|
|
73
|
+
`void`
|
|
74
|
+
|
|
75
|
+
***
|
|
76
|
+
|
|
77
|
+
### enabled?
|
|
78
|
+
|
|
79
|
+
> `optional` **enabled**: `boolean`
|
|
80
|
+
|
|
81
|
+
Defined in: [hooks/useInactivityTracker.ts:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L73)
|
|
82
|
+
|
|
83
|
+
Whether tracking is enabled (default: true)
|
|
84
|
+
|
|
85
|
+
***
|
|
86
|
+
|
|
87
|
+
### storageKey?
|
|
88
|
+
|
|
89
|
+
> `optional` **storageKey**: `string`
|
|
90
|
+
|
|
91
|
+
Defined in: [hooks/useInactivityTracker.ts:75](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L75)
|
|
92
|
+
|
|
93
|
+
Storage key for persistence (default: 'pace-core-inactivity')
|
|
94
|
+
|
|
95
|
+
***
|
|
96
|
+
|
|
97
|
+
### channelName?
|
|
98
|
+
|
|
99
|
+
> `optional` **channelName**: `string`
|
|
100
|
+
|
|
101
|
+
Defined in: [hooks/useInactivityTracker.ts:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L77)
|
|
102
|
+
|
|
103
|
+
Broadcast channel name for cross-tab sync (default: 'pace-core-inactivity')
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / UseInactivityTrackerReturn
|
|
6
|
+
|
|
7
|
+
# Interface: UseInactivityTrackerReturn
|
|
8
|
+
|
|
9
|
+
Defined in: [hooks/useInactivityTracker.ts:80](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L80)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### isIdle
|
|
14
|
+
|
|
15
|
+
> **isIdle**: `boolean`
|
|
16
|
+
|
|
17
|
+
Defined in: [hooks/useInactivityTracker.ts:82](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L82)
|
|
18
|
+
|
|
19
|
+
Whether the user is currently idle
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### timeRemaining
|
|
24
|
+
|
|
25
|
+
> **timeRemaining**: `number`
|
|
26
|
+
|
|
27
|
+
Defined in: [hooks/useInactivityTracker.ts:84](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L84)
|
|
28
|
+
|
|
29
|
+
Time remaining in milliseconds before idle timeout
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### showWarning
|
|
34
|
+
|
|
35
|
+
> **showWarning**: `boolean`
|
|
36
|
+
|
|
37
|
+
Defined in: [hooks/useInactivityTracker.ts:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L86)
|
|
38
|
+
|
|
39
|
+
Whether warning should be shown
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
43
|
+
### resetActivity()
|
|
44
|
+
|
|
45
|
+
> **resetActivity**: () => `void`
|
|
46
|
+
|
|
47
|
+
Defined in: [hooks/useInactivityTracker.ts:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L88)
|
|
48
|
+
|
|
49
|
+
Reset the activity timer
|
|
50
|
+
|
|
51
|
+
#### Returns
|
|
52
|
+
|
|
53
|
+
`void`
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
57
|
+
### startTracking()
|
|
58
|
+
|
|
59
|
+
> **startTracking**: () => `void`
|
|
60
|
+
|
|
61
|
+
Defined in: [hooks/useInactivityTracker.ts:90](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L90)
|
|
62
|
+
|
|
63
|
+
Start tracking inactivity
|
|
64
|
+
|
|
65
|
+
#### Returns
|
|
66
|
+
|
|
67
|
+
`void`
|
|
68
|
+
|
|
69
|
+
***
|
|
70
|
+
|
|
71
|
+
### stopTracking()
|
|
72
|
+
|
|
73
|
+
> **stopTracking**: () => `void`
|
|
74
|
+
|
|
75
|
+
Defined in: [hooks/useInactivityTracker.ts:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L92)
|
|
76
|
+
|
|
77
|
+
Stop tracking inactivity
|
|
78
|
+
|
|
79
|
+
#### Returns
|
|
80
|
+
|
|
81
|
+
`void`
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
85
|
+
### isTracking
|
|
86
|
+
|
|
87
|
+
> **isTracking**: `boolean`
|
|
88
|
+
|
|
89
|
+
Defined in: [hooks/useInactivityTracker.ts:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L94)
|
|
90
|
+
|
|
91
|
+
Whether tracking is currently active
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / UsePublicEventLogoOptions
|
|
6
|
+
|
|
7
|
+
# Interface: UsePublicEventLogoOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L94)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### cacheTtl?
|
|
14
|
+
|
|
15
|
+
> `optional` **cacheTtl**: `number`
|
|
16
|
+
|
|
17
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:96](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L96)
|
|
18
|
+
|
|
19
|
+
Cache TTL in milliseconds (default: 30 minutes)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### enableCache?
|
|
24
|
+
|
|
25
|
+
> `optional` **enableCache**: `boolean`
|
|
26
|
+
|
|
27
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:98](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L98)
|
|
28
|
+
|
|
29
|
+
Whether to enable caching (default: true)
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### validateImage?
|
|
34
|
+
|
|
35
|
+
> `optional` **validateImage**: `boolean`
|
|
36
|
+
|
|
37
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L100)
|
|
38
|
+
|
|
39
|
+
Whether to validate image existence (default: true)
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
43
|
+
### generateFallbackText()?
|
|
44
|
+
|
|
45
|
+
> `optional` **generateFallbackText**: (`eventName`) => `string`
|
|
46
|
+
|
|
47
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:102](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L102)
|
|
48
|
+
|
|
49
|
+
Custom fallback text generator
|
|
50
|
+
|
|
51
|
+
#### Parameters
|
|
52
|
+
|
|
53
|
+
##### eventName
|
|
54
|
+
|
|
55
|
+
`string`
|
|
56
|
+
|
|
57
|
+
#### Returns
|
|
58
|
+
|
|
59
|
+
`string`
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### supabase
|
|
64
|
+
|
|
65
|
+
> **supabase**: `SupabaseClient`\<`Database`\>
|
|
66
|
+
|
|
67
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:104](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L104)
|
|
68
|
+
|
|
69
|
+
Supabase client instance (required)
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / UsePublicEventLogoReturn
|
|
6
|
+
|
|
7
|
+
# Interface: UsePublicEventLogoReturn
|
|
8
|
+
|
|
9
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:81](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L81)
|
|
10
|
+
|
|
11
|
+
Return value of the usePublicEventLogo hook.
|
|
12
|
+
Provides logo URL, fallback text, loading state, error, and refetch function.
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
### logoUrl
|
|
17
|
+
|
|
18
|
+
> **logoUrl**: `string` \| `null`
|
|
19
|
+
|
|
20
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L83)
|
|
21
|
+
|
|
22
|
+
The logo URL if available, null if not found or error
|
|
23
|
+
|
|
24
|
+
***
|
|
25
|
+
|
|
26
|
+
### fallbackText
|
|
27
|
+
|
|
28
|
+
> **fallbackText**: `string`
|
|
29
|
+
|
|
30
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L85)
|
|
31
|
+
|
|
32
|
+
Fallback text (event initials) if no logo is available
|
|
33
|
+
|
|
34
|
+
***
|
|
35
|
+
|
|
36
|
+
### isLoading
|
|
37
|
+
|
|
38
|
+
> **isLoading**: `boolean`
|
|
39
|
+
|
|
40
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:87](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L87)
|
|
41
|
+
|
|
42
|
+
Whether the logo is currently loading
|
|
43
|
+
|
|
44
|
+
***
|
|
45
|
+
|
|
46
|
+
### error
|
|
47
|
+
|
|
48
|
+
> **error**: `Error` \| `null`
|
|
49
|
+
|
|
50
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L89)
|
|
51
|
+
|
|
52
|
+
Any error that occurred during loading
|
|
53
|
+
|
|
54
|
+
***
|
|
55
|
+
|
|
56
|
+
### refetch()
|
|
57
|
+
|
|
58
|
+
> **refetch**: () => `Promise`\<`void`\>
|
|
59
|
+
|
|
60
|
+
Defined in: [hooks/public/usePublicEventLogo.ts:91](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEventLogo.ts#L91)
|
|
61
|
+
|
|
62
|
+
Function to manually refetch the logo
|
|
63
|
+
|
|
64
|
+
#### Returns
|
|
65
|
+
|
|
66
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / UsePublicEventOptions
|
|
6
|
+
|
|
7
|
+
# Interface: UsePublicEventOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [hooks/public/usePublicEvent.ts:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEvent.ts#L88)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### cacheTtl?
|
|
14
|
+
|
|
15
|
+
> `optional` **cacheTtl**: `number`
|
|
16
|
+
|
|
17
|
+
Defined in: [hooks/public/usePublicEvent.ts:90](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEvent.ts#L90)
|
|
18
|
+
|
|
19
|
+
Cache TTL in milliseconds (default: 5 minutes)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### enableCache?
|
|
24
|
+
|
|
25
|
+
> `optional` **enableCache**: `boolean`
|
|
26
|
+
|
|
27
|
+
Defined in: [hooks/public/usePublicEvent.ts:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEvent.ts#L92)
|
|
28
|
+
|
|
29
|
+
Whether to enable caching (default: true)
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / UsePublicEventReturn
|
|
6
|
+
|
|
7
|
+
# Interface: UsePublicEventReturn
|
|
8
|
+
|
|
9
|
+
Defined in: [hooks/public/usePublicEvent.ts:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEvent.ts#L77)
|
|
10
|
+
|
|
11
|
+
Return value of the usePublicEvent hook.
|
|
12
|
+
Provides event data, loading state, error, and refetch function.
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
### event
|
|
17
|
+
|
|
18
|
+
> **event**: `Event` \| `null`
|
|
19
|
+
|
|
20
|
+
Defined in: [hooks/public/usePublicEvent.ts:79](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEvent.ts#L79)
|
|
21
|
+
|
|
22
|
+
The event data, null if not loaded or not found
|
|
23
|
+
|
|
24
|
+
***
|
|
25
|
+
|
|
26
|
+
### isLoading
|
|
27
|
+
|
|
28
|
+
> **isLoading**: `boolean`
|
|
29
|
+
|
|
30
|
+
Defined in: [hooks/public/usePublicEvent.ts:81](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEvent.ts#L81)
|
|
31
|
+
|
|
32
|
+
Whether the data is currently loading
|
|
33
|
+
|
|
34
|
+
***
|
|
35
|
+
|
|
36
|
+
### error
|
|
37
|
+
|
|
38
|
+
> **error**: `Error` \| `null`
|
|
39
|
+
|
|
40
|
+
Defined in: [hooks/public/usePublicEvent.ts:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEvent.ts#L83)
|
|
41
|
+
|
|
42
|
+
Any error that occurred during loading
|
|
43
|
+
|
|
44
|
+
***
|
|
45
|
+
|
|
46
|
+
### refetch()
|
|
47
|
+
|
|
48
|
+
> **refetch**: () => `Promise`\<`void`\>
|
|
49
|
+
|
|
50
|
+
Defined in: [hooks/public/usePublicEvent.ts:85](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/public/usePublicEvent.ts#L85)
|
|
51
|
+
|
|
52
|
+
Function to manually refetch the data
|
|
53
|
+
|
|
54
|
+
#### Returns
|
|
55
|
+
|
|
56
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / UsePublicFileDisplayOptions
|
|
6
|
+
|
|
7
|
+
# Interface: UsePublicFileDisplayOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [components/FileDisplay/usePublicFileDisplay.ts:82](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/usePublicFileDisplay.ts#L82)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### cacheTtl?
|
|
14
|
+
|
|
15
|
+
> `optional` **cacheTtl**: `number`
|
|
16
|
+
|
|
17
|
+
Defined in: [components/FileDisplay/usePublicFileDisplay.ts:84](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/usePublicFileDisplay.ts#L84)
|
|
18
|
+
|
|
19
|
+
Cache TTL in milliseconds (default: 30 minutes)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### enableCache?
|
|
24
|
+
|
|
25
|
+
> `optional` **enableCache**: `boolean`
|
|
26
|
+
|
|
27
|
+
Defined in: [components/FileDisplay/usePublicFileDisplay.ts:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/usePublicFileDisplay.ts#L86)
|
|
28
|
+
|
|
29
|
+
Whether to enable caching (default: true)
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### supabase
|
|
34
|
+
|
|
35
|
+
> **supabase**: `SupabaseClient`\<`Database`\>
|
|
36
|
+
|
|
37
|
+
Defined in: [components/FileDisplay/usePublicFileDisplay.ts:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/usePublicFileDisplay.ts#L88)
|
|
38
|
+
|
|
39
|
+
Supabase client instance (required)
|