@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,511 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / DataTableProps
|
|
6
|
+
|
|
7
|
+
# Interface: DataTableProps\<TData\>
|
|
8
|
+
|
|
9
|
+
Defined in: [components/DataTable/DataTable.tsx:295](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L295)
|
|
10
|
+
|
|
11
|
+
Enhanced DataTable props with performance features
|
|
12
|
+
|
|
13
|
+
## Type Parameters
|
|
14
|
+
|
|
15
|
+
### TData
|
|
16
|
+
|
|
17
|
+
`TData` *extends* [`DataRecord`](DataRecord.md)
|
|
18
|
+
|
|
19
|
+
The type of data records in the table
|
|
20
|
+
|
|
21
|
+
## Properties
|
|
22
|
+
|
|
23
|
+
### data
|
|
24
|
+
|
|
25
|
+
> **data**: `TData`[]
|
|
26
|
+
|
|
27
|
+
Defined in: [components/DataTable/DataTable.tsx:301](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L301)
|
|
28
|
+
|
|
29
|
+
Array of data records to display in the table
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### columns
|
|
34
|
+
|
|
35
|
+
> **columns**: [`DataTableColumn`](DataTableColumn.md)\<`TData`\>[]
|
|
36
|
+
|
|
37
|
+
Defined in: [components/DataTable/DataTable.tsx:303](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L303)
|
|
38
|
+
|
|
39
|
+
Column definitions for the table
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
43
|
+
### rbac
|
|
44
|
+
|
|
45
|
+
> **rbac**: `DataTableRBACConfig`
|
|
46
|
+
|
|
47
|
+
Defined in: [components/DataTable/DataTable.tsx:310](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L310)
|
|
48
|
+
|
|
49
|
+
RBAC configuration - REQUIRED for all DataTables
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### title?
|
|
54
|
+
|
|
55
|
+
> `optional` **title**: `string`
|
|
56
|
+
|
|
57
|
+
Defined in: [components/DataTable/DataTable.tsx:317](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L317)
|
|
58
|
+
|
|
59
|
+
Optional title displayed above the table
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### description?
|
|
64
|
+
|
|
65
|
+
> `optional` **description**: `string`
|
|
66
|
+
|
|
67
|
+
Defined in: [components/DataTable/DataTable.tsx:319](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L319)
|
|
68
|
+
|
|
69
|
+
Optional description displayed below the title
|
|
70
|
+
|
|
71
|
+
***
|
|
72
|
+
|
|
73
|
+
### variant?
|
|
74
|
+
|
|
75
|
+
> `optional` **variant**: `"default"` \| `"compact"` \| `"spacious"`
|
|
76
|
+
|
|
77
|
+
Defined in: [components/DataTable/DataTable.tsx:321](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L321)
|
|
78
|
+
|
|
79
|
+
Visual variant of the table
|
|
80
|
+
|
|
81
|
+
***
|
|
82
|
+
|
|
83
|
+
### className?
|
|
84
|
+
|
|
85
|
+
> `optional` **className**: `string`
|
|
86
|
+
|
|
87
|
+
Defined in: [components/DataTable/DataTable.tsx:323](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L323)
|
|
88
|
+
|
|
89
|
+
Additional CSS classes for the table container
|
|
90
|
+
|
|
91
|
+
***
|
|
92
|
+
|
|
93
|
+
### features?
|
|
94
|
+
|
|
95
|
+
> `optional` **features**: `Partial`\<`DataTableFeatureFlags`\>
|
|
96
|
+
|
|
97
|
+
Defined in: [components/DataTable/DataTable.tsx:330](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L330)
|
|
98
|
+
|
|
99
|
+
Feature configuration - all features are disabled by default
|
|
100
|
+
|
|
101
|
+
***
|
|
102
|
+
|
|
103
|
+
### hierarchical?
|
|
104
|
+
|
|
105
|
+
> `optional` **hierarchical**: `HierarchicalConfig`
|
|
106
|
+
|
|
107
|
+
Defined in: [components/DataTable/DataTable.tsx:337](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L337)
|
|
108
|
+
|
|
109
|
+
Hierarchical parent/child row configuration
|
|
110
|
+
|
|
111
|
+
***
|
|
112
|
+
|
|
113
|
+
### performance?
|
|
114
|
+
|
|
115
|
+
> `optional` **performance**: `PerformanceConfig`
|
|
116
|
+
|
|
117
|
+
Defined in: [components/DataTable/DataTable.tsx:344](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L344)
|
|
118
|
+
|
|
119
|
+
Performance optimization configuration
|
|
120
|
+
|
|
121
|
+
***
|
|
122
|
+
|
|
123
|
+
### serverSide?
|
|
124
|
+
|
|
125
|
+
> `optional` **serverSide**: `ServerSideConfig`\<`TData`\>
|
|
126
|
+
|
|
127
|
+
Defined in: [components/DataTable/DataTable.tsx:346](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L346)
|
|
128
|
+
|
|
129
|
+
Server-side data fetching configuration
|
|
130
|
+
|
|
131
|
+
***
|
|
132
|
+
|
|
133
|
+
### paginationMode?
|
|
134
|
+
|
|
135
|
+
> `optional` **paginationMode**: `PaginationMode`
|
|
136
|
+
|
|
137
|
+
Defined in: [components/DataTable/DataTable.tsx:348](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L348)
|
|
138
|
+
|
|
139
|
+
Override automatic pagination mode detection
|
|
140
|
+
|
|
141
|
+
***
|
|
142
|
+
|
|
143
|
+
### chunking?
|
|
144
|
+
|
|
145
|
+
> `optional` **chunking**: `ChunkingConfig`
|
|
146
|
+
|
|
147
|
+
Defined in: [components/DataTable/DataTable.tsx:350](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L350)
|
|
148
|
+
|
|
149
|
+
Data chunking configuration for memory optimization
|
|
150
|
+
|
|
151
|
+
***
|
|
152
|
+
|
|
153
|
+
### searchIndex?
|
|
154
|
+
|
|
155
|
+
> `optional` **searchIndex**: `SearchIndexConfig`
|
|
156
|
+
|
|
157
|
+
Defined in: [components/DataTable/DataTable.tsx:352](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L352)
|
|
158
|
+
|
|
159
|
+
Search indexing configuration for fast search
|
|
160
|
+
|
|
161
|
+
***
|
|
162
|
+
|
|
163
|
+
### virtualHeight?
|
|
164
|
+
|
|
165
|
+
> `optional` **virtualHeight**: `number`
|
|
166
|
+
|
|
167
|
+
Defined in: [components/DataTable/DataTable.tsx:354](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L354)
|
|
168
|
+
|
|
169
|
+
Virtual scrolling height
|
|
170
|
+
|
|
171
|
+
***
|
|
172
|
+
|
|
173
|
+
### initialPageSize?
|
|
174
|
+
|
|
175
|
+
> `optional` **initialPageSize**: `number`
|
|
176
|
+
|
|
177
|
+
Defined in: [components/DataTable/DataTable.tsx:356](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L356)
|
|
178
|
+
|
|
179
|
+
Initial page size for pagination
|
|
180
|
+
|
|
181
|
+
***
|
|
182
|
+
|
|
183
|
+
### defaultGrouping?
|
|
184
|
+
|
|
185
|
+
> `optional` **defaultGrouping**: `string`[]
|
|
186
|
+
|
|
187
|
+
Defined in: [components/DataTable/DataTable.tsx:363](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L363)
|
|
188
|
+
|
|
189
|
+
Initial grouping configuration - columns to group by on load
|
|
190
|
+
|
|
191
|
+
***
|
|
192
|
+
|
|
193
|
+
### defaultSorting?
|
|
194
|
+
|
|
195
|
+
> `optional` **defaultSorting**: `object`[]
|
|
196
|
+
|
|
197
|
+
Defined in: [components/DataTable/DataTable.tsx:365](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L365)
|
|
198
|
+
|
|
199
|
+
Initial sorting configuration - sort state to apply on load
|
|
200
|
+
|
|
201
|
+
#### id
|
|
202
|
+
|
|
203
|
+
> **id**: `string`
|
|
204
|
+
|
|
205
|
+
#### desc
|
|
206
|
+
|
|
207
|
+
> **desc**: `boolean`
|
|
208
|
+
|
|
209
|
+
***
|
|
210
|
+
|
|
211
|
+
### enhancedPagination?
|
|
212
|
+
|
|
213
|
+
> `optional` **enhancedPagination**: `boolean`
|
|
214
|
+
|
|
215
|
+
Defined in: [components/DataTable/DataTable.tsx:371](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L371)
|
|
216
|
+
|
|
217
|
+
Enable enhanced pagination controls
|
|
218
|
+
|
|
219
|
+
***
|
|
220
|
+
|
|
221
|
+
### loadingComponent?
|
|
222
|
+
|
|
223
|
+
> `optional` **loadingComponent**: `ComponentType`\<\{ \}\>
|
|
224
|
+
|
|
225
|
+
Defined in: [components/DataTable/DataTable.tsx:373](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L373)
|
|
226
|
+
|
|
227
|
+
Custom loading component
|
|
228
|
+
|
|
229
|
+
***
|
|
230
|
+
|
|
231
|
+
### errorComponent?
|
|
232
|
+
|
|
233
|
+
> `optional` **errorComponent**: `ComponentType`\<\{ `error`: `Error`; `retry`: () => `void`; \}\>
|
|
234
|
+
|
|
235
|
+
Defined in: [components/DataTable/DataTable.tsx:375](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L375)
|
|
236
|
+
|
|
237
|
+
Custom error component
|
|
238
|
+
|
|
239
|
+
***
|
|
240
|
+
|
|
241
|
+
### onEditRow()?
|
|
242
|
+
|
|
243
|
+
> `optional` **onEditRow**: (`row`, `data`) => `void`
|
|
244
|
+
|
|
245
|
+
Defined in: [components/DataTable/DataTable.tsx:382](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L382)
|
|
246
|
+
|
|
247
|
+
Callback when a row is edited
|
|
248
|
+
|
|
249
|
+
#### Parameters
|
|
250
|
+
|
|
251
|
+
##### row
|
|
252
|
+
|
|
253
|
+
`TData`
|
|
254
|
+
|
|
255
|
+
##### data
|
|
256
|
+
|
|
257
|
+
`Partial`\<`TData`\>
|
|
258
|
+
|
|
259
|
+
#### Returns
|
|
260
|
+
|
|
261
|
+
`void`
|
|
262
|
+
|
|
263
|
+
***
|
|
264
|
+
|
|
265
|
+
### onDeleteRow()?
|
|
266
|
+
|
|
267
|
+
> `optional` **onDeleteRow**: (`row`) => `void`
|
|
268
|
+
|
|
269
|
+
Defined in: [components/DataTable/DataTable.tsx:384](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L384)
|
|
270
|
+
|
|
271
|
+
Callback when a row is deleted
|
|
272
|
+
|
|
273
|
+
#### Parameters
|
|
274
|
+
|
|
275
|
+
##### row
|
|
276
|
+
|
|
277
|
+
`TData`
|
|
278
|
+
|
|
279
|
+
#### Returns
|
|
280
|
+
|
|
281
|
+
`void`
|
|
282
|
+
|
|
283
|
+
***
|
|
284
|
+
|
|
285
|
+
### onCreateRow()?
|
|
286
|
+
|
|
287
|
+
> `optional` **onCreateRow**: (`data`) => `void`
|
|
288
|
+
|
|
289
|
+
Defined in: [components/DataTable/DataTable.tsx:386](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L386)
|
|
290
|
+
|
|
291
|
+
Callback when a new row is created
|
|
292
|
+
|
|
293
|
+
#### Parameters
|
|
294
|
+
|
|
295
|
+
##### data
|
|
296
|
+
|
|
297
|
+
`Partial`\<`TData`\>
|
|
298
|
+
|
|
299
|
+
#### Returns
|
|
300
|
+
|
|
301
|
+
`void`
|
|
302
|
+
|
|
303
|
+
***
|
|
304
|
+
|
|
305
|
+
### onImport()?
|
|
306
|
+
|
|
307
|
+
> `optional` **onImport**: (`data`) => [`ImportHandlerResult`](../type-aliases/ImportHandlerResult.md)
|
|
308
|
+
|
|
309
|
+
Defined in: [components/DataTable/DataTable.tsx:388](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L388)
|
|
310
|
+
|
|
311
|
+
Callback when data is imported
|
|
312
|
+
|
|
313
|
+
#### Parameters
|
|
314
|
+
|
|
315
|
+
##### data
|
|
316
|
+
|
|
317
|
+
`TData`[]
|
|
318
|
+
|
|
319
|
+
#### Returns
|
|
320
|
+
|
|
321
|
+
[`ImportHandlerResult`](../type-aliases/ImportHandlerResult.md)
|
|
322
|
+
|
|
323
|
+
***
|
|
324
|
+
|
|
325
|
+
### onExport()?
|
|
326
|
+
|
|
327
|
+
> `optional` **onExport**: (`options`) => `void` \| `Promise`\<`void`\>
|
|
328
|
+
|
|
329
|
+
Defined in: [components/DataTable/DataTable.tsx:390](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L390)
|
|
330
|
+
|
|
331
|
+
Callback for custom export functionality
|
|
332
|
+
|
|
333
|
+
#### Parameters
|
|
334
|
+
|
|
335
|
+
##### options
|
|
336
|
+
|
|
337
|
+
[`ExportOptions`](ExportOptions.md)\<`TData`\>
|
|
338
|
+
|
|
339
|
+
#### Returns
|
|
340
|
+
|
|
341
|
+
`void` \| `Promise`\<`void`\>
|
|
342
|
+
|
|
343
|
+
***
|
|
344
|
+
|
|
345
|
+
### onRowSelectionChange()?
|
|
346
|
+
|
|
347
|
+
> `optional` **onRowSelectionChange**: (`selection`) => `void`
|
|
348
|
+
|
|
349
|
+
Defined in: [components/DataTable/DataTable.tsx:392](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L392)
|
|
350
|
+
|
|
351
|
+
Callback when row selection changes
|
|
352
|
+
|
|
353
|
+
#### Parameters
|
|
354
|
+
|
|
355
|
+
##### selection
|
|
356
|
+
|
|
357
|
+
`Record`\<`string`, `boolean`\>
|
|
358
|
+
|
|
359
|
+
#### Returns
|
|
360
|
+
|
|
361
|
+
`void`
|
|
362
|
+
|
|
363
|
+
***
|
|
364
|
+
|
|
365
|
+
### selection?
|
|
366
|
+
|
|
367
|
+
> `optional` **selection**: `Record`\<`string`, `boolean`\>
|
|
368
|
+
|
|
369
|
+
Defined in: [components/DataTable/DataTable.tsx:394](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L394)
|
|
370
|
+
|
|
371
|
+
Controlled selection state
|
|
372
|
+
|
|
373
|
+
***
|
|
374
|
+
|
|
375
|
+
### onDeleteSelected()?
|
|
376
|
+
|
|
377
|
+
> `optional` **onDeleteSelected**: (`selectedRows`) => `void`
|
|
378
|
+
|
|
379
|
+
Defined in: [components/DataTable/DataTable.tsx:396](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L396)
|
|
380
|
+
|
|
381
|
+
Callback when bulk delete selected rows is triggered
|
|
382
|
+
|
|
383
|
+
#### Parameters
|
|
384
|
+
|
|
385
|
+
##### selectedRows
|
|
386
|
+
|
|
387
|
+
`Record`\<`string`, `boolean`\>
|
|
388
|
+
|
|
389
|
+
#### Returns
|
|
390
|
+
|
|
391
|
+
`void`
|
|
392
|
+
|
|
393
|
+
***
|
|
394
|
+
|
|
395
|
+
### getRowId?
|
|
396
|
+
|
|
397
|
+
> `optional` **getRowId**: [`GetRowId`](../type-aliases/GetRowId.md)\<`TData`\>
|
|
398
|
+
|
|
399
|
+
Defined in: [components/DataTable/DataTable.tsx:403](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L403)
|
|
400
|
+
|
|
401
|
+
Function to generate unique row IDs
|
|
402
|
+
|
|
403
|
+
***
|
|
404
|
+
|
|
405
|
+
### isLoading?
|
|
406
|
+
|
|
407
|
+
> `optional` **isLoading**: `boolean`
|
|
408
|
+
|
|
409
|
+
Defined in: [components/DataTable/DataTable.tsx:405](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L405)
|
|
410
|
+
|
|
411
|
+
Whether the table is in a loading state
|
|
412
|
+
|
|
413
|
+
***
|
|
414
|
+
|
|
415
|
+
### emptyState?
|
|
416
|
+
|
|
417
|
+
> `optional` **emptyState**: `ReactElement`\<`unknown`, `string` \| `JSXElementConstructor`\<`any`\>\> \| [`EmptyStateConfig`](EmptyStateConfig.md)
|
|
418
|
+
|
|
419
|
+
Defined in: [components/DataTable/DataTable.tsx:407](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L407)
|
|
420
|
+
|
|
421
|
+
Custom component to display when table is empty
|
|
422
|
+
|
|
423
|
+
***
|
|
424
|
+
|
|
425
|
+
### aggregates?
|
|
426
|
+
|
|
427
|
+
> `optional` **aggregates**: [`AggregateConfig`](AggregateConfig.md)[]
|
|
428
|
+
|
|
429
|
+
Defined in: [components/DataTable/DataTable.tsx:409](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L409)
|
|
430
|
+
|
|
431
|
+
Array of aggregation functions for grouped data
|
|
432
|
+
|
|
433
|
+
***
|
|
434
|
+
|
|
435
|
+
### importModalConfig?
|
|
436
|
+
|
|
437
|
+
> `optional` **importModalConfig**: `ImportModalConfig`
|
|
438
|
+
|
|
439
|
+
Defined in: [components/DataTable/DataTable.tsx:412](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L412)
|
|
440
|
+
|
|
441
|
+
Import modal configuration
|
|
442
|
+
|
|
443
|
+
***
|
|
444
|
+
|
|
445
|
+
### onImportModalClose()?
|
|
446
|
+
|
|
447
|
+
> `optional` **onImportModalClose**: () => `void`
|
|
448
|
+
|
|
449
|
+
Defined in: [components/DataTable/DataTable.tsx:414](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L414)
|
|
450
|
+
|
|
451
|
+
Called when the import modal is closed (e.g. to refetch table data).
|
|
452
|
+
|
|
453
|
+
#### Returns
|
|
454
|
+
|
|
455
|
+
`void`
|
|
456
|
+
|
|
457
|
+
***
|
|
458
|
+
|
|
459
|
+
### actions?
|
|
460
|
+
|
|
461
|
+
> `optional` **actions**: [`DataTableAction`](DataTableAction.md)\<`TData`\>[]
|
|
462
|
+
|
|
463
|
+
Defined in: [components/DataTable/DataTable.tsx:417](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L417)
|
|
464
|
+
|
|
465
|
+
Custom row actions - use this for custom action buttons
|
|
466
|
+
|
|
467
|
+
***
|
|
468
|
+
|
|
469
|
+
### columnOrder?
|
|
470
|
+
|
|
471
|
+
> `optional` **columnOrder**: `string`[]
|
|
472
|
+
|
|
473
|
+
Defined in: [components/DataTable/DataTable.tsx:420](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L420)
|
|
474
|
+
|
|
475
|
+
Column order configuration - array of column IDs in desired order
|
|
476
|
+
|
|
477
|
+
***
|
|
478
|
+
|
|
479
|
+
### storageKey?
|
|
480
|
+
|
|
481
|
+
> `optional` **storageKey**: `string`
|
|
482
|
+
|
|
483
|
+
Defined in: [components/DataTable/DataTable.tsx:427](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L427)
|
|
484
|
+
|
|
485
|
+
Unique storage key for persisting table layout state across sessions
|
|
486
|
+
|
|
487
|
+
***
|
|
488
|
+
|
|
489
|
+
### onLayoutChange()?
|
|
490
|
+
|
|
491
|
+
> `optional` **onLayoutChange**: (`layout`) => `void`
|
|
492
|
+
|
|
493
|
+
Defined in: [components/DataTable/DataTable.tsx:429](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/DataTable.tsx#L429)
|
|
494
|
+
|
|
495
|
+
Callback when table layout changes (column order, visibility, etc.)
|
|
496
|
+
|
|
497
|
+
#### Parameters
|
|
498
|
+
|
|
499
|
+
##### layout
|
|
500
|
+
|
|
501
|
+
###### columnOrder
|
|
502
|
+
|
|
503
|
+
`string`[]
|
|
504
|
+
|
|
505
|
+
###### columnVisibility
|
|
506
|
+
|
|
507
|
+
`Record`\<`string`, `boolean`\>
|
|
508
|
+
|
|
509
|
+
#### Returns
|
|
510
|
+
|
|
511
|
+
`void`
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / DataTableToolbarButton
|
|
6
|
+
|
|
7
|
+
# Interface: DataTableToolbarButton
|
|
8
|
+
|
|
9
|
+
Defined in: [components/DataTable/types/actions.ts:58](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types/actions.ts#L58)
|
|
10
|
+
|
|
11
|
+
Toolbar button definition
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### label
|
|
16
|
+
|
|
17
|
+
> **label**: `string`
|
|
18
|
+
|
|
19
|
+
Defined in: [components/DataTable/types/actions.ts:60](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types/actions.ts#L60)
|
|
20
|
+
|
|
21
|
+
Display label
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### icon?
|
|
26
|
+
|
|
27
|
+
> `optional` **icon**: `ComponentType`\<\{ `className?`: `string`; \}\>
|
|
28
|
+
|
|
29
|
+
Defined in: [components/DataTable/types/actions.ts:62](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types/actions.ts#L62)
|
|
30
|
+
|
|
31
|
+
Icon component
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### onClick()
|
|
36
|
+
|
|
37
|
+
> **onClick**: () => `void`
|
|
38
|
+
|
|
39
|
+
Defined in: [components/DataTable/types/actions.ts:64](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types/actions.ts#L64)
|
|
40
|
+
|
|
41
|
+
Click handler
|
|
42
|
+
|
|
43
|
+
#### Returns
|
|
44
|
+
|
|
45
|
+
`void`
|
|
46
|
+
|
|
47
|
+
***
|
|
48
|
+
|
|
49
|
+
### variant?
|
|
50
|
+
|
|
51
|
+
> `optional` **variant**: `"default"` \| `"destructive"` \| `"outline"` \| `"secondary"` \| `"ghost"`
|
|
52
|
+
|
|
53
|
+
Defined in: [components/DataTable/types/actions.ts:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types/actions.ts#L66)
|
|
54
|
+
|
|
55
|
+
Visual variant
|
|
56
|
+
|
|
57
|
+
***
|
|
58
|
+
|
|
59
|
+
### disabled?
|
|
60
|
+
|
|
61
|
+
> `optional` **disabled**: `boolean`
|
|
62
|
+
|
|
63
|
+
Defined in: [components/DataTable/types/actions.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types/actions.ts#L68)
|
|
64
|
+
|
|
65
|
+
Whether button is disabled
|
|
66
|
+
|
|
67
|
+
***
|
|
68
|
+
|
|
69
|
+
### testId?
|
|
70
|
+
|
|
71
|
+
> `optional` **testId**: `string`
|
|
72
|
+
|
|
73
|
+
Defined in: [components/DataTable/types/actions.ts:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types/actions.ts#L70)
|
|
74
|
+
|
|
75
|
+
Test ID for testing
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
[**@jmruthers/pace-core v0.6.12**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@jmruthers/pace-core](../globals.md) / DatePickerWithTimezoneProps
|
|
6
|
+
|
|
7
|
+
# Interface: DatePickerWithTimezoneProps
|
|
8
|
+
|
|
9
|
+
Defined in: [components/DatePickerWithTimezone/DatePickerWithTimezone.tsx:55](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DatePickerWithTimezone/DatePickerWithTimezone.tsx#L55)
|
|
10
|
+
|
|
11
|
+
Props for the DatePickerWithTimezone component
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### selected?
|
|
16
|
+
|
|
17
|
+
> `optional` **selected**: `Date`
|
|
18
|
+
|
|
19
|
+
Defined in: [components/DatePickerWithTimezone/DatePickerWithTimezone.tsx:59](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DatePickerWithTimezone/DatePickerWithTimezone.tsx#L59)
|
|
20
|
+
|
|
21
|
+
Currently selected date
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### onSelect()
|
|
26
|
+
|
|
27
|
+
> **onSelect**: (`date`) => `void`
|
|
28
|
+
|
|
29
|
+
Defined in: [components/DatePickerWithTimezone/DatePickerWithTimezone.tsx:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DatePickerWithTimezone/DatePickerWithTimezone.tsx#L63)
|
|
30
|
+
|
|
31
|
+
Date selection handler
|
|
32
|
+
|
|
33
|
+
#### Parameters
|
|
34
|
+
|
|
35
|
+
##### date
|
|
36
|
+
|
|
37
|
+
`Date` | `undefined`
|
|
38
|
+
|
|
39
|
+
#### Returns
|
|
40
|
+
|
|
41
|
+
`void`
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### onDone()?
|
|
46
|
+
|
|
47
|
+
> `optional` **onDone**: () => `void`
|
|
48
|
+
|
|
49
|
+
Defined in: [components/DatePickerWithTimezone/DatePickerWithTimezone.tsx:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DatePickerWithTimezone/DatePickerWithTimezone.tsx#L67)
|
|
50
|
+
|
|
51
|
+
Optional callback when "Done" button is clicked
|
|
52
|
+
|
|
53
|
+
#### Returns
|
|
54
|
+
|
|
55
|
+
`void`
|
|
56
|
+
|
|
57
|
+
***
|
|
58
|
+
|
|
59
|
+
### timezone?
|
|
60
|
+
|
|
61
|
+
> `optional` **timezone**: `string`
|
|
62
|
+
|
|
63
|
+
Defined in: [components/DatePickerWithTimezone/DatePickerWithTimezone.tsx:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DatePickerWithTimezone/DatePickerWithTimezone.tsx#L71)
|
|
64
|
+
|
|
65
|
+
Timezone to display (defaults to user's timezone)
|
|
66
|
+
|
|
67
|
+
***
|
|
68
|
+
|
|
69
|
+
### className?
|
|
70
|
+
|
|
71
|
+
> `optional` **className**: `string`
|
|
72
|
+
|
|
73
|
+
Defined in: [components/DatePickerWithTimezone/DatePickerWithTimezone.tsx:75](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DatePickerWithTimezone/DatePickerWithTimezone.tsx#L75)
|
|
74
|
+
|
|
75
|
+
Additional CSS classes
|