@jmruthers/pace-core 0.6.2 → 0.6.4
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/CHANGELOG.md +45 -0
- package/cursor-rules/00-pace-core-compliance.mdc +34 -2
- package/dist/{AuthService-BPvc3Ka0.d.ts → AuthService-Cb34EQs3.d.ts} +9 -1
- package/dist/{DataTable-TPTKCX4D.js → DataTable-E7YQZD7D.js} +9 -8
- package/dist/{PublicPageProvider-DC6kCaqf.d.ts → PublicPageProvider-DEMpysFR.d.ts} +45 -67
- package/dist/{UnifiedAuthProvider-CVcTjx-d.d.ts → UnifiedAuthProvider-CKvHP1MK.d.ts} +1 -8
- package/dist/{UnifiedAuthProvider-CH6Z342H.js → UnifiedAuthProvider-QPXO24B4.js} +5 -4
- package/dist/{api-MVVQZLJI.js → api-6LVZTHDS.js} +10 -10
- package/dist/{audit-B5P6FFIR.js → audit-V53FV5AG.js} +2 -2
- package/dist/chunk-36LVWXB2.js +227 -0
- package/dist/chunk-36LVWXB2.js.map +1 -0
- package/dist/{chunk-24UVZUZG.js → chunk-3LPHPB62.js} +129 -387
- package/dist/chunk-3LPHPB62.js.map +1 -0
- package/dist/{chunk-2UOI2FG5.js → chunk-5EC5MEWX.js} +4 -4
- package/dist/{chunk-3XC4CPTD.js → chunk-7JPAB3T5.js} +244 -5727
- package/dist/chunk-7JPAB3T5.js.map +1 -0
- package/dist/{chunk-6J4GEEJR.js → chunk-ATKZM7RX.js} +53 -27
- package/dist/chunk-ATKZM7RX.js.map +1 -0
- package/dist/{chunk-EHMR7VYL.js → chunk-AVMLPIM7.js} +443 -189
- package/dist/chunk-AVMLPIM7.js.map +1 -0
- package/dist/chunk-DGUM43GV.js +11 -0
- package/dist/{chunk-NECFR5MM.js → chunk-I6DAQMWX.js} +575 -647
- package/dist/chunk-I6DAQMWX.js.map +1 -0
- package/dist/{chunk-F2IMUDXZ.js → chunk-M7MPQISP.js} +2 -2
- package/dist/{chunk-XWQCNGTQ.js → chunk-NN6WWZ5U.js} +173 -79
- package/dist/chunk-NN6WWZ5U.js.map +1 -0
- package/dist/{chunk-MMZ7JXPU.js → chunk-OEWDTMG7.js} +13 -21
- package/dist/{chunk-MMZ7JXPU.js.map → chunk-OEWDTMG7.js.map} +1 -1
- package/dist/{chunk-SFZUDBL5.js → chunk-YKRAFF5K.js} +70 -56
- package/dist/chunk-YKRAFF5K.js.map +1 -0
- package/dist/components.d.ts +2 -2
- package/dist/components.js +12 -13
- package/dist/contextValidator-OOPCLPZW.js +9 -0
- package/dist/contextValidator-OOPCLPZW.js.map +1 -0
- package/dist/eslint-rules/pace-core-compliance.cjs +106 -0
- package/dist/hooks.d.ts +2 -2
- package/dist/hooks.js +7 -6
- package/dist/hooks.js.map +1 -1
- package/dist/index.d.ts +7 -7
- package/dist/index.js +21 -16
- package/dist/index.js.map +1 -1
- package/dist/providers.d.ts +3 -3
- package/dist/providers.js +4 -3
- package/dist/rbac/index.d.ts +67 -27
- package/dist/rbac/index.js +15 -8
- package/dist/styles/index.js +1 -1
- package/dist/theming/runtime.js +1 -1
- package/dist/types.js +1 -1
- package/dist/{usePublicRouteParams-1oMokgLF.d.ts → usePublicRouteParams-i3qtoBgg.d.ts} +7 -16
- package/dist/utils.js +5 -7
- package/dist/utils.js.map +1 -1
- package/docs/api/README.md +14 -16
- package/docs/api/modules.md +3796 -2513
- package/docs/components/context-selector.md +126 -0
- package/docs/migration/RBAC_SCOPE_MIGRATION.md +385 -0
- package/docs/pace-mint-fix-auto-selection.md +218 -0
- package/docs/pace-mint-rbac-setup.md +391 -0
- package/docs/rbac/secure-client-protection.md +330 -0
- package/package.json +10 -5
- package/scripts/audit/core/checks/compliance.cjs +72 -0
- package/scripts/audit/core/checks/dependencies.cjs +568 -28
- package/scripts/audit/core/checks/documentation.cjs +68 -3
- package/scripts/audit/core/checks/environment.cjs +2 -14
- package/scripts/audit/core/checks/error-handling.cjs +47 -6
- package/src/components/ContextSelector/ContextSelector.tsx +384 -0
- package/src/components/ContextSelector/index.ts +3 -0
- package/src/components/DataTable/components/RowComponent.tsx +19 -19
- package/src/components/DataTable/components/UnifiedTableBody.tsx +2 -2
- package/src/components/DataTable/hooks/useDataTablePermissions.ts +8 -6
- package/src/components/Dialog/Dialog.tsx +29 -1
- package/src/components/FileDisplay/FileDisplay.tsx +42 -10
- package/src/components/Header/Header.test.tsx +43 -73
- package/src/components/Header/Header.tsx +44 -45
- package/src/components/PaceAppLayout/PaceAppLayout.integration.test.tsx +10 -19
- package/src/components/PaceAppLayout/PaceAppLayout.performance.test.tsx +2 -2
- package/src/components/PaceAppLayout/PaceAppLayout.security.test.tsx +5 -5
- package/src/components/PaceAppLayout/PaceAppLayout.test.tsx +9 -9
- package/src/components/PaceAppLayout/PaceAppLayout.tsx +157 -36
- package/src/components/PaceAppLayout/README.md +14 -17
- package/src/components/PaceAppLayout/test-setup.tsx +2 -2
- package/src/components/index.ts +5 -5
- package/src/eslint-rules/pace-core-compliance.cjs +106 -0
- package/src/hooks/__tests__/useAppConfig.unit.test.ts +4 -98
- package/src/hooks/useAppConfig.ts +15 -30
- package/src/hooks/useFileDisplay.ts +77 -50
- package/src/index.ts +4 -5
- package/src/providers/services/AuthServiceProvider.tsx +17 -7
- package/src/providers/services/EventServiceProvider.tsx +33 -5
- package/src/providers/services/UnifiedAuthProvider.tsx +90 -134
- package/src/rbac/__tests__/adapters.comprehensive.test.tsx +1 -1
- package/src/rbac/adapters.tsx +2 -2
- package/src/rbac/api.test.ts +59 -51
- package/src/rbac/api.ts +178 -132
- package/src/rbac/components/PagePermissionGuard.tsx +38 -10
- package/src/rbac/hooks/__tests__/useSecureSupabase.test.ts +32 -21
- package/src/rbac/hooks/permissions/useAccessLevel.ts +1 -1
- package/src/rbac/hooks/permissions/useCan.ts +41 -11
- package/src/rbac/hooks/permissions/useHasAllPermissions.ts +1 -1
- package/src/rbac/hooks/permissions/useHasAnyPermission.ts +1 -1
- package/src/rbac/hooks/permissions/useMultiplePermissions.ts +1 -1
- package/src/rbac/hooks/useCan.test.ts +0 -9
- package/src/rbac/hooks/useRBAC.test.ts +1 -5
- package/src/rbac/hooks/useRBAC.ts +36 -37
- package/src/rbac/hooks/useResolvedScope.test.ts +120 -35
- package/src/rbac/hooks/useResolvedScope.ts +35 -40
- package/src/rbac/hooks/useSecureSupabase.ts +7 -7
- package/src/rbac/index.ts +7 -0
- package/src/rbac/secureClient.test.ts +22 -18
- package/src/rbac/secureClient.ts +103 -16
- package/src/rbac/security.ts +0 -17
- package/src/rbac/types.ts +1 -0
- package/src/rbac/utils/__tests__/contextValidator.test.ts +64 -86
- package/src/rbac/utils/clientSecurity.ts +93 -0
- package/src/rbac/utils/contextValidator.ts +77 -168
- package/src/services/AuthService.ts +39 -7
- package/src/services/EventService.ts +285 -56
- package/src/services/OrganisationService.ts +81 -14
- package/src/services/__tests__/EventService.test.ts +1 -2
- package/src/services/base/BaseService.ts +3 -0
- package/src/utils/dynamic/dynamicUtils.ts +7 -4
- package/dist/chunk-24UVZUZG.js.map +0 -1
- package/dist/chunk-3XC4CPTD.js.map +0 -1
- package/dist/chunk-6J4GEEJR.js.map +0 -1
- package/dist/chunk-7D4SUZUM.js +0 -38
- package/dist/chunk-EHMR7VYL.js.map +0 -1
- package/dist/chunk-NECFR5MM.js.map +0 -1
- package/dist/chunk-SFZUDBL5.js.map +0 -1
- package/dist/chunk-XWQCNGTQ.js.map +0 -1
- package/docs/api/classes/ColumnFactory.md +0 -243
- package/docs/api/classes/InvalidScopeError.md +0 -73
- package/docs/api/classes/Logger.md +0 -178
- package/docs/api/classes/MissingUserContextError.md +0 -66
- package/docs/api/classes/OrganisationContextRequiredError.md +0 -66
- package/docs/api/classes/PermissionDeniedError.md +0 -73
- package/docs/api/classes/RBACAuditManager.md +0 -297
- package/docs/api/classes/RBACCache.md +0 -322
- package/docs/api/classes/RBACEngine.md +0 -171
- package/docs/api/classes/RBACError.md +0 -76
- package/docs/api/classes/RBACNotInitializedError.md +0 -66
- package/docs/api/classes/SecureSupabaseClient.md +0 -163
- package/docs/api/classes/StorageUtils.md +0 -328
- package/docs/api/enums/FileCategory.md +0 -184
- package/docs/api/enums/LogLevel.md +0 -54
- package/docs/api/enums/RBACErrorCode.md +0 -228
- package/docs/api/enums/RPCFunction.md +0 -118
- package/docs/api/interfaces/AddressFieldProps.md +0 -241
- package/docs/api/interfaces/AddressFieldRef.md +0 -94
- package/docs/api/interfaces/AggregateConfig.md +0 -43
- package/docs/api/interfaces/AutocompleteOptions.md +0 -75
- package/docs/api/interfaces/AvatarProps.md +0 -128
- package/docs/api/interfaces/BadgeProps.md +0 -34
- package/docs/api/interfaces/ButtonProps.md +0 -56
- package/docs/api/interfaces/CalendarProps.md +0 -73
- package/docs/api/interfaces/CardProps.md +0 -69
- package/docs/api/interfaces/ColorPalette.md +0 -7
- package/docs/api/interfaces/ColorShade.md +0 -66
- package/docs/api/interfaces/ComplianceResult.md +0 -30
- package/docs/api/interfaces/DataAccessRecord.md +0 -96
- package/docs/api/interfaces/DataRecord.md +0 -11
- package/docs/api/interfaces/DataTableAction.md +0 -252
- package/docs/api/interfaces/DataTableColumn.md +0 -504
- package/docs/api/interfaces/DataTableProps.md +0 -625
- package/docs/api/interfaces/DataTableToolbarButton.md +0 -96
- package/docs/api/interfaces/DatabaseComplianceResult.md +0 -85
- package/docs/api/interfaces/DatabaseIssue.md +0 -41
- package/docs/api/interfaces/EmptyStateConfig.md +0 -61
- package/docs/api/interfaces/EnhancedNavigationMenuProps.md +0 -235
- package/docs/api/interfaces/ErrorBoundaryProps.md +0 -147
- package/docs/api/interfaces/ErrorBoundaryProviderProps.md +0 -36
- package/docs/api/interfaces/ErrorBoundaryState.md +0 -75
- package/docs/api/interfaces/EventAppRoleData.md +0 -71
- package/docs/api/interfaces/ExportColumn.md +0 -90
- package/docs/api/interfaces/ExportOptions.md +0 -126
- package/docs/api/interfaces/FileDisplayProps.md +0 -249
- package/docs/api/interfaces/FileMetadata.md +0 -129
- package/docs/api/interfaces/FileReference.md +0 -118
- package/docs/api/interfaces/FileSizeLimits.md +0 -7
- package/docs/api/interfaces/FileUploadOptions.md +0 -139
- package/docs/api/interfaces/FileUploadProps.md +0 -296
- package/docs/api/interfaces/FooterProps.md +0 -107
- package/docs/api/interfaces/FormFieldProps.md +0 -166
- package/docs/api/interfaces/FormProps.md +0 -113
- package/docs/api/interfaces/GrantEventAppRoleParams.md +0 -122
- package/docs/api/interfaces/InactivityWarningModalProps.md +0 -115
- package/docs/api/interfaces/InputProps.md +0 -56
- package/docs/api/interfaces/LabelProps.md +0 -107
- package/docs/api/interfaces/LoggerConfig.md +0 -62
- package/docs/api/interfaces/LoginFormProps.md +0 -187
- package/docs/api/interfaces/NavigationAccessRecord.md +0 -107
- package/docs/api/interfaces/NavigationContextType.md +0 -164
- package/docs/api/interfaces/NavigationGuardProps.md +0 -139
- package/docs/api/interfaces/NavigationItem.md +0 -120
- package/docs/api/interfaces/NavigationMenuProps.md +0 -221
- package/docs/api/interfaces/NavigationProviderProps.md +0 -117
- package/docs/api/interfaces/Organisation.md +0 -140
- package/docs/api/interfaces/OrganisationContextType.md +0 -388
- package/docs/api/interfaces/OrganisationMembership.md +0 -140
- package/docs/api/interfaces/OrganisationProviderProps.md +0 -76
- package/docs/api/interfaces/OrganisationSecurityError.md +0 -62
- package/docs/api/interfaces/PaceAppLayoutProps.md +0 -409
- package/docs/api/interfaces/PaceLoginPageProps.md +0 -49
- package/docs/api/interfaces/PageAccessRecord.md +0 -85
- package/docs/api/interfaces/PagePermissionContextType.md +0 -140
- package/docs/api/interfaces/PagePermissionGuardProps.md +0 -153
- package/docs/api/interfaces/PagePermissionProviderProps.md +0 -119
- package/docs/api/interfaces/PaletteData.md +0 -41
- package/docs/api/interfaces/ParsedAddress.md +0 -120
- package/docs/api/interfaces/PermissionEnforcerProps.md +0 -153
- package/docs/api/interfaces/ProgressProps.md +0 -42
- package/docs/api/interfaces/ProtectedRouteProps.md +0 -78
- package/docs/api/interfaces/PublicPageFooterProps.md +0 -112
- package/docs/api/interfaces/PublicPageHeaderProps.md +0 -125
- package/docs/api/interfaces/PublicPageLayoutProps.md +0 -185
- package/docs/api/interfaces/QuickFix.md +0 -52
- package/docs/api/interfaces/RBACAccessValidateParams.md +0 -52
- package/docs/api/interfaces/RBACAccessValidateResult.md +0 -41
- package/docs/api/interfaces/RBACAuditLogParams.md +0 -85
- package/docs/api/interfaces/RBACAuditLogResult.md +0 -52
- package/docs/api/interfaces/RBACConfig.md +0 -133
- package/docs/api/interfaces/RBACContext.md +0 -52
- package/docs/api/interfaces/RBACLogger.md +0 -112
- package/docs/api/interfaces/RBACPageAccessCheckParams.md +0 -74
- package/docs/api/interfaces/RBACPerformanceMetrics.md +0 -138
- package/docs/api/interfaces/RBACPermissionCheckParams.md +0 -74
- package/docs/api/interfaces/RBACPermissionCheckResult.md +0 -52
- package/docs/api/interfaces/RBACPermissionsGetParams.md +0 -63
- package/docs/api/interfaces/RBACPermissionsGetResult.md +0 -63
- package/docs/api/interfaces/RBACResult.md +0 -58
- package/docs/api/interfaces/RBACRoleGrantParams.md +0 -63
- package/docs/api/interfaces/RBACRoleGrantResult.md +0 -52
- package/docs/api/interfaces/RBACRoleRevokeParams.md +0 -63
- package/docs/api/interfaces/RBACRoleRevokeResult.md +0 -52
- package/docs/api/interfaces/RBACRoleValidateParams.md +0 -52
- package/docs/api/interfaces/RBACRoleValidateResult.md +0 -63
- package/docs/api/interfaces/RBACRolesListParams.md +0 -52
- package/docs/api/interfaces/RBACRolesListResult.md +0 -74
- package/docs/api/interfaces/RBACSessionTrackParams.md +0 -74
- package/docs/api/interfaces/RBACSessionTrackResult.md +0 -52
- package/docs/api/interfaces/ResourcePermissions.md +0 -155
- package/docs/api/interfaces/RevokeEventAppRoleParams.md +0 -100
- package/docs/api/interfaces/RoleBasedRouterContextType.md +0 -151
- package/docs/api/interfaces/RoleBasedRouterProps.md +0 -156
- package/docs/api/interfaces/RoleManagementResult.md +0 -52
- package/docs/api/interfaces/RouteAccessRecord.md +0 -107
- package/docs/api/interfaces/RouteConfig.md +0 -134
- package/docs/api/interfaces/RuntimeComplianceResult.md +0 -55
- package/docs/api/interfaces/SecureDataContextType.md +0 -168
- package/docs/api/interfaces/SecureDataProviderProps.md +0 -132
- package/docs/api/interfaces/SessionRestorationLoaderProps.md +0 -34
- package/docs/api/interfaces/SetupIssue.md +0 -41
- package/docs/api/interfaces/StorageConfig.md +0 -41
- package/docs/api/interfaces/StorageFileInfo.md +0 -74
- package/docs/api/interfaces/StorageFileMetadata.md +0 -151
- package/docs/api/interfaces/StorageListOptions.md +0 -99
- package/docs/api/interfaces/StorageListResult.md +0 -41
- package/docs/api/interfaces/StorageUploadOptions.md +0 -101
- package/docs/api/interfaces/StorageUploadResult.md +0 -63
- package/docs/api/interfaces/StorageUrlOptions.md +0 -60
- package/docs/api/interfaces/StyleImport.md +0 -19
- package/docs/api/interfaces/SwitchProps.md +0 -34
- package/docs/api/interfaces/TabsContentProps.md +0 -9
- package/docs/api/interfaces/TabsListProps.md +0 -9
- package/docs/api/interfaces/TabsProps.md +0 -9
- package/docs/api/interfaces/TabsTriggerProps.md +0 -50
- package/docs/api/interfaces/TextareaProps.md +0 -53
- package/docs/api/interfaces/ToastActionElement.md +0 -12
- package/docs/api/interfaces/ToastProps.md +0 -9
- package/docs/api/interfaces/UnifiedAuthContextType.md +0 -823
- package/docs/api/interfaces/UnifiedAuthProviderProps.md +0 -173
- package/docs/api/interfaces/UseFormDialogOptions.md +0 -62
- package/docs/api/interfaces/UseFormDialogReturn.md +0 -117
- package/docs/api/interfaces/UseInactivityTrackerOptions.md +0 -138
- package/docs/api/interfaces/UseInactivityTrackerReturn.md +0 -123
- package/docs/api/interfaces/UsePublicEventLogoOptions.md +0 -87
- package/docs/api/interfaces/UsePublicEventLogoReturn.md +0 -84
- package/docs/api/interfaces/UsePublicEventOptions.md +0 -34
- package/docs/api/interfaces/UsePublicEventReturn.md +0 -71
- package/docs/api/interfaces/UsePublicFileDisplayOptions.md +0 -47
- package/docs/api/interfaces/UsePublicFileDisplayReturn.md +0 -123
- package/docs/api/interfaces/UsePublicRouteParamsReturn.md +0 -97
- package/docs/api/interfaces/UseResolvedScopeOptions.md +0 -47
- package/docs/api/interfaces/UseResolvedScopeReturn.md +0 -47
- package/docs/api/interfaces/UseResourcePermissionsOptions.md +0 -34
- package/docs/api/interfaces/UserEventAccess.md +0 -121
- package/docs/api/interfaces/UserMenuProps.md +0 -88
- package/docs/api/interfaces/UserProfile.md +0 -63
- package/src/components/EventSelector/EventSelector.test.tsx +0 -720
- package/src/components/EventSelector/EventSelector.tsx +0 -423
- package/src/components/EventSelector/index.ts +0 -3
- package/src/components/OrganisationSelector/OrganisationSelector.test.tsx +0 -784
- package/src/components/OrganisationSelector/OrganisationSelector.tsx +0 -327
- package/src/components/OrganisationSelector/index.ts +0 -9
- /package/dist/{DataTable-TPTKCX4D.js.map → DataTable-E7YQZD7D.js.map} +0 -0
- /package/dist/{UnifiedAuthProvider-CH6Z342H.js.map → UnifiedAuthProvider-QPXO24B4.js.map} +0 -0
- /package/dist/{api-MVVQZLJI.js.map → api-6LVZTHDS.js.map} +0 -0
- /package/dist/{audit-B5P6FFIR.js.map → audit-V53FV5AG.js.map} +0 -0
- /package/dist/{chunk-2UOI2FG5.js.map → chunk-5EC5MEWX.js.map} +0 -0
- /package/dist/{chunk-7D4SUZUM.js.map → chunk-DGUM43GV.js.map} +0 -0
- /package/dist/{chunk-F2IMUDXZ.js.map → chunk-M7MPQISP.js.map} +0 -0
|
@@ -1,173 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / UnifiedAuthProviderProps
|
|
2
|
-
|
|
3
|
-
# Interface: UnifiedAuthProviderProps
|
|
4
|
-
|
|
5
|
-
Props for the UnifiedAuthProvider component.
|
|
6
|
-
|
|
7
|
-
## Table of contents
|
|
8
|
-
|
|
9
|
-
### Properties
|
|
10
|
-
|
|
11
|
-
- [children](UnifiedAuthProviderProps.md#children)
|
|
12
|
-
- [supabaseClient](UnifiedAuthProviderProps.md#supabaseclient)
|
|
13
|
-
- [appName](UnifiedAuthProviderProps.md#appname)
|
|
14
|
-
- [persistState](UnifiedAuthProviderProps.md#persiststate)
|
|
15
|
-
- [enablePersistence](UnifiedAuthProviderProps.md#enablepersistence)
|
|
16
|
-
- [requireOrganisationContext](UnifiedAuthProviderProps.md#requireorganisationcontext)
|
|
17
|
-
- [appConfig](UnifiedAuthProviderProps.md#appconfig)
|
|
18
|
-
- [idleTimeoutMs](UnifiedAuthProviderProps.md#idletimeoutms)
|
|
19
|
-
- [warnBeforeMs](UnifiedAuthProviderProps.md#warnbeforems)
|
|
20
|
-
- [onIdleLogout](UnifiedAuthProviderProps.md#onidlelogout)
|
|
21
|
-
- [renderInactivityWarning](UnifiedAuthProviderProps.md#renderinactivitywarning)
|
|
22
|
-
- [dangerouslyDisableInactivity](UnifiedAuthProviderProps.md#dangerouslydisableinactivity)
|
|
23
|
-
|
|
24
|
-
## Properties
|
|
25
|
-
|
|
26
|
-
### children
|
|
27
|
-
|
|
28
|
-
• **children**: `ReactNode`
|
|
29
|
-
|
|
30
|
-
#### Defined in
|
|
31
|
-
|
|
32
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:155](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L155)
|
|
33
|
-
|
|
34
|
-
___
|
|
35
|
-
|
|
36
|
-
### supabaseClient
|
|
37
|
-
|
|
38
|
-
• **supabaseClient**: `default`\<`any`, ``"public"``, ``"public"``, `any`, `any`\>
|
|
39
|
-
|
|
40
|
-
#### Defined in
|
|
41
|
-
|
|
42
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:156](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L156)
|
|
43
|
-
|
|
44
|
-
___
|
|
45
|
-
|
|
46
|
-
### appName
|
|
47
|
-
|
|
48
|
-
• **appName**: `string`
|
|
49
|
-
|
|
50
|
-
#### Defined in
|
|
51
|
-
|
|
52
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:157](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L157)
|
|
53
|
-
|
|
54
|
-
___
|
|
55
|
-
|
|
56
|
-
### persistState
|
|
57
|
-
|
|
58
|
-
• `Optional` **persistState**: `boolean`
|
|
59
|
-
|
|
60
|
-
#### Defined in
|
|
61
|
-
|
|
62
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:158](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L158)
|
|
63
|
-
|
|
64
|
-
___
|
|
65
|
-
|
|
66
|
-
### enablePersistence
|
|
67
|
-
|
|
68
|
-
• `Optional` **enablePersistence**: `boolean`
|
|
69
|
-
|
|
70
|
-
#### Defined in
|
|
71
|
-
|
|
72
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:159](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L159)
|
|
73
|
-
|
|
74
|
-
___
|
|
75
|
-
|
|
76
|
-
### requireOrganisationContext
|
|
77
|
-
|
|
78
|
-
• `Optional` **requireOrganisationContext**: `boolean`
|
|
79
|
-
|
|
80
|
-
#### Defined in
|
|
81
|
-
|
|
82
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:160](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L160)
|
|
83
|
-
|
|
84
|
-
___
|
|
85
|
-
|
|
86
|
-
### appConfig
|
|
87
|
-
|
|
88
|
-
• `Optional` **appConfig**: ``null`` \| \{ `requires_event`: `boolean` }
|
|
89
|
-
|
|
90
|
-
#### Defined in
|
|
91
|
-
|
|
92
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:163](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L163)
|
|
93
|
-
|
|
94
|
-
___
|
|
95
|
-
|
|
96
|
-
### idleTimeoutMs
|
|
97
|
-
|
|
98
|
-
• **idleTimeoutMs**: `number`
|
|
99
|
-
|
|
100
|
-
#### Defined in
|
|
101
|
-
|
|
102
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:166](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L166)
|
|
103
|
-
|
|
104
|
-
___
|
|
105
|
-
|
|
106
|
-
### warnBeforeMs
|
|
107
|
-
|
|
108
|
-
• **warnBeforeMs**: `number`
|
|
109
|
-
|
|
110
|
-
#### Defined in
|
|
111
|
-
|
|
112
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:167](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L167)
|
|
113
|
-
|
|
114
|
-
___
|
|
115
|
-
|
|
116
|
-
### onIdleLogout
|
|
117
|
-
|
|
118
|
-
• **onIdleLogout**: (`reason`: ``"inactivity"``) => `void`
|
|
119
|
-
|
|
120
|
-
#### Type declaration
|
|
121
|
-
|
|
122
|
-
▸ (`reason`): `void`
|
|
123
|
-
|
|
124
|
-
##### Parameters
|
|
125
|
-
|
|
126
|
-
| Name | Type |
|
|
127
|
-
| :------ | :------ |
|
|
128
|
-
| `reason` | ``"inactivity"`` |
|
|
129
|
-
|
|
130
|
-
##### Returns
|
|
131
|
-
|
|
132
|
-
`void`
|
|
133
|
-
|
|
134
|
-
#### Defined in
|
|
135
|
-
|
|
136
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:168](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L168)
|
|
137
|
-
|
|
138
|
-
___
|
|
139
|
-
|
|
140
|
-
### renderInactivityWarning
|
|
141
|
-
|
|
142
|
-
• `Optional` **renderInactivityWarning**: (`args`: \{ `timeRemaining`: `number` ; `onStaySignedIn`: () => `void` ; `onSignOutNow`: () => `void` }) => `ReactNode`
|
|
143
|
-
|
|
144
|
-
#### Type declaration
|
|
145
|
-
|
|
146
|
-
▸ (`args`): `ReactNode`
|
|
147
|
-
|
|
148
|
-
##### Parameters
|
|
149
|
-
|
|
150
|
-
| Name | Type |
|
|
151
|
-
| :------ | :------ |
|
|
152
|
-
| `args` | `Object` |
|
|
153
|
-
| `args.timeRemaining` | `number` |
|
|
154
|
-
| `args.onStaySignedIn` | () => `void` |
|
|
155
|
-
| `args.onSignOutNow` | () => `void` |
|
|
156
|
-
|
|
157
|
-
##### Returns
|
|
158
|
-
|
|
159
|
-
`ReactNode`
|
|
160
|
-
|
|
161
|
-
#### Defined in
|
|
162
|
-
|
|
163
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:169](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L169)
|
|
164
|
-
|
|
165
|
-
___
|
|
166
|
-
|
|
167
|
-
### dangerouslyDisableInactivity
|
|
168
|
-
|
|
169
|
-
• `Optional` **dangerouslyDisableInactivity**: `boolean`
|
|
170
|
-
|
|
171
|
-
#### Defined in
|
|
172
|
-
|
|
173
|
-
[packages/core/src/providers/services/UnifiedAuthProvider.tsx:174](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/services/UnifiedAuthProvider.tsx#L174)
|
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / UseFormDialogOptions
|
|
2
|
-
|
|
3
|
-
# Interface: UseFormDialogOptions\<T\>
|
|
4
|
-
|
|
5
|
-
Options for configuring the useFormDialog hook behavior
|
|
6
|
-
|
|
7
|
-
## Type parameters
|
|
8
|
-
|
|
9
|
-
| Name | Type |
|
|
10
|
-
| :------ | :------ |
|
|
11
|
-
| `T` | `unknown` |
|
|
12
|
-
|
|
13
|
-
## Table of contents
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
- [onOpenChange](UseFormDialogOptions.md#onopenchange)
|
|
18
|
-
- [resetOnClose](UseFormDialogOptions.md#resetonclose)
|
|
19
|
-
|
|
20
|
-
## Properties
|
|
21
|
-
|
|
22
|
-
### onOpenChange
|
|
23
|
-
|
|
24
|
-
• `Optional` **onOpenChange**: (`open`: `boolean`) => `void`
|
|
25
|
-
|
|
26
|
-
Callback invoked when the dialog open state changes
|
|
27
|
-
|
|
28
|
-
#### Type declaration
|
|
29
|
-
|
|
30
|
-
▸ (`open`): `void`
|
|
31
|
-
|
|
32
|
-
##### Parameters
|
|
33
|
-
|
|
34
|
-
| Name | Type | Description |
|
|
35
|
-
| :------ | :------ | :------ |
|
|
36
|
-
| `open` | `boolean` | The new open state |
|
|
37
|
-
|
|
38
|
-
##### Returns
|
|
39
|
-
|
|
40
|
-
`void`
|
|
41
|
-
|
|
42
|
-
#### Defined in
|
|
43
|
-
|
|
44
|
-
[packages/core/src/hooks/useFormDialog.ts:36](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L36)
|
|
45
|
-
|
|
46
|
-
___
|
|
47
|
-
|
|
48
|
-
### resetOnClose
|
|
49
|
-
|
|
50
|
-
• `Optional` **resetOnClose**: `boolean`
|
|
51
|
-
|
|
52
|
-
Whether to reset form data when the dialog closes
|
|
53
|
-
|
|
54
|
-
**`Default`**
|
|
55
|
-
|
|
56
|
-
```ts
|
|
57
|
-
true
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
#### Defined in
|
|
61
|
-
|
|
62
|
-
[packages/core/src/hooks/useFormDialog.ts:42](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L42)
|
|
@@ -1,117 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / UseFormDialogReturn
|
|
2
|
-
|
|
3
|
-
# Interface: UseFormDialogReturn\<T\>
|
|
4
|
-
|
|
5
|
-
Return type for the useFormDialog hook
|
|
6
|
-
|
|
7
|
-
## Type parameters
|
|
8
|
-
|
|
9
|
-
| Name | Type |
|
|
10
|
-
| :------ | :------ |
|
|
11
|
-
| `T` | `unknown` |
|
|
12
|
-
|
|
13
|
-
## Table of contents
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
- [isOpen](UseFormDialogReturn.md#isopen)
|
|
18
|
-
- [formData](UseFormDialogReturn.md#formdata)
|
|
19
|
-
- [openDialog](UseFormDialogReturn.md#opendialog)
|
|
20
|
-
- [closeDialog](UseFormDialogReturn.md#closedialog)
|
|
21
|
-
- [handleOpenChange](UseFormDialogReturn.md#handleopenchange)
|
|
22
|
-
|
|
23
|
-
## Properties
|
|
24
|
-
|
|
25
|
-
### isOpen
|
|
26
|
-
|
|
27
|
-
• **isOpen**: `boolean`
|
|
28
|
-
|
|
29
|
-
Current open state of the dialog
|
|
30
|
-
|
|
31
|
-
#### Defined in
|
|
32
|
-
|
|
33
|
-
[packages/core/src/hooks/useFormDialog.ts:52](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L52)
|
|
34
|
-
|
|
35
|
-
___
|
|
36
|
-
|
|
37
|
-
### formData
|
|
38
|
-
|
|
39
|
-
• **formData**: ``null`` \| `T`
|
|
40
|
-
|
|
41
|
-
Current form data (null when dialog is closed or no data provided)
|
|
42
|
-
|
|
43
|
-
#### Defined in
|
|
44
|
-
|
|
45
|
-
[packages/core/src/hooks/useFormDialog.ts:57](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L57)
|
|
46
|
-
|
|
47
|
-
___
|
|
48
|
-
|
|
49
|
-
### openDialog
|
|
50
|
-
|
|
51
|
-
• **openDialog**: (`data?`: ``null`` \| `T`) => `void`
|
|
52
|
-
|
|
53
|
-
Open the dialog with optional form data
|
|
54
|
-
|
|
55
|
-
#### Type declaration
|
|
56
|
-
|
|
57
|
-
▸ (`data?`): `void`
|
|
58
|
-
|
|
59
|
-
##### Parameters
|
|
60
|
-
|
|
61
|
-
| Name | Type | Description |
|
|
62
|
-
| :------ | :------ | :------ |
|
|
63
|
-
| `data?` | ``null`` \| `T` | Optional form data to populate the dialog |
|
|
64
|
-
|
|
65
|
-
##### Returns
|
|
66
|
-
|
|
67
|
-
`void`
|
|
68
|
-
|
|
69
|
-
#### Defined in
|
|
70
|
-
|
|
71
|
-
[packages/core/src/hooks/useFormDialog.ts:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L63)
|
|
72
|
-
|
|
73
|
-
___
|
|
74
|
-
|
|
75
|
-
### closeDialog
|
|
76
|
-
|
|
77
|
-
• **closeDialog**: () => `void`
|
|
78
|
-
|
|
79
|
-
Close the dialog
|
|
80
|
-
|
|
81
|
-
#### Type declaration
|
|
82
|
-
|
|
83
|
-
▸ (): `void`
|
|
84
|
-
|
|
85
|
-
##### Returns
|
|
86
|
-
|
|
87
|
-
`void`
|
|
88
|
-
|
|
89
|
-
#### Defined in
|
|
90
|
-
|
|
91
|
-
[packages/core/src/hooks/useFormDialog.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L68)
|
|
92
|
-
|
|
93
|
-
___
|
|
94
|
-
|
|
95
|
-
### handleOpenChange
|
|
96
|
-
|
|
97
|
-
• **handleOpenChange**: (`open`: `boolean`) => `void`
|
|
98
|
-
|
|
99
|
-
Handler for controlled dialog components (e.g., Radix UI Dialog)
|
|
100
|
-
|
|
101
|
-
#### Type declaration
|
|
102
|
-
|
|
103
|
-
▸ (`open`): `void`
|
|
104
|
-
|
|
105
|
-
##### Parameters
|
|
106
|
-
|
|
107
|
-
| Name | Type | Description |
|
|
108
|
-
| :------ | :------ | :------ |
|
|
109
|
-
| `open` | `boolean` | The new open state |
|
|
110
|
-
|
|
111
|
-
##### Returns
|
|
112
|
-
|
|
113
|
-
`void`
|
|
114
|
-
|
|
115
|
-
#### Defined in
|
|
116
|
-
|
|
117
|
-
[packages/core/src/hooks/useFormDialog.ts:74](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useFormDialog.ts#L74)
|
|
@@ -1,138 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / UseInactivityTrackerOptions
|
|
2
|
-
|
|
3
|
-
# Interface: UseInactivityTrackerOptions
|
|
4
|
-
|
|
5
|
-
Options for the useInactivityTracker hook.
|
|
6
|
-
|
|
7
|
-
## Table of contents
|
|
8
|
-
|
|
9
|
-
### Properties
|
|
10
|
-
|
|
11
|
-
- [idleTimeoutMs](UseInactivityTrackerOptions.md#idletimeoutms)
|
|
12
|
-
- [warnBeforeMs](UseInactivityTrackerOptions.md#warnbeforems)
|
|
13
|
-
- [onIdle](UseInactivityTrackerOptions.md#onidle)
|
|
14
|
-
- [onWarning](UseInactivityTrackerOptions.md#onwarning)
|
|
15
|
-
- [onActivity](UseInactivityTrackerOptions.md#onactivity)
|
|
16
|
-
- [enabled](UseInactivityTrackerOptions.md#enabled)
|
|
17
|
-
- [storageKey](UseInactivityTrackerOptions.md#storagekey)
|
|
18
|
-
- [channelName](UseInactivityTrackerOptions.md#channelname)
|
|
19
|
-
|
|
20
|
-
## Properties
|
|
21
|
-
|
|
22
|
-
### idleTimeoutMs
|
|
23
|
-
|
|
24
|
-
• `Optional` **idleTimeoutMs**: `number`
|
|
25
|
-
|
|
26
|
-
Timeout in milliseconds before user is considered idle (default: 30 minutes)
|
|
27
|
-
|
|
28
|
-
#### Defined in
|
|
29
|
-
|
|
30
|
-
[packages/core/src/hooks/useInactivityTracker.ts:63](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L63)
|
|
31
|
-
|
|
32
|
-
___
|
|
33
|
-
|
|
34
|
-
### warnBeforeMs
|
|
35
|
-
|
|
36
|
-
• `Optional` **warnBeforeMs**: `number`
|
|
37
|
-
|
|
38
|
-
Time in milliseconds before idle timeout to show warning (default: 60 seconds)
|
|
39
|
-
|
|
40
|
-
#### Defined in
|
|
41
|
-
|
|
42
|
-
[packages/core/src/hooks/useInactivityTracker.ts:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L65)
|
|
43
|
-
|
|
44
|
-
___
|
|
45
|
-
|
|
46
|
-
### onIdle
|
|
47
|
-
|
|
48
|
-
• `Optional` **onIdle**: () => `void`
|
|
49
|
-
|
|
50
|
-
Callback when user becomes idle
|
|
51
|
-
|
|
52
|
-
#### Type declaration
|
|
53
|
-
|
|
54
|
-
▸ (): `void`
|
|
55
|
-
|
|
56
|
-
##### Returns
|
|
57
|
-
|
|
58
|
-
`void`
|
|
59
|
-
|
|
60
|
-
#### Defined in
|
|
61
|
-
|
|
62
|
-
[packages/core/src/hooks/useInactivityTracker.ts:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L67)
|
|
63
|
-
|
|
64
|
-
___
|
|
65
|
-
|
|
66
|
-
### onWarning
|
|
67
|
-
|
|
68
|
-
• `Optional` **onWarning**: () => `void`
|
|
69
|
-
|
|
70
|
-
Callback when warning should be shown
|
|
71
|
-
|
|
72
|
-
#### Type declaration
|
|
73
|
-
|
|
74
|
-
▸ (): `void`
|
|
75
|
-
|
|
76
|
-
##### Returns
|
|
77
|
-
|
|
78
|
-
`void`
|
|
79
|
-
|
|
80
|
-
#### Defined in
|
|
81
|
-
|
|
82
|
-
[packages/core/src/hooks/useInactivityTracker.ts:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L69)
|
|
83
|
-
|
|
84
|
-
___
|
|
85
|
-
|
|
86
|
-
### onActivity
|
|
87
|
-
|
|
88
|
-
• `Optional` **onActivity**: () => `void`
|
|
89
|
-
|
|
90
|
-
Callback when user becomes active again
|
|
91
|
-
|
|
92
|
-
#### Type declaration
|
|
93
|
-
|
|
94
|
-
▸ (): `void`
|
|
95
|
-
|
|
96
|
-
##### Returns
|
|
97
|
-
|
|
98
|
-
`void`
|
|
99
|
-
|
|
100
|
-
#### Defined in
|
|
101
|
-
|
|
102
|
-
[packages/core/src/hooks/useInactivityTracker.ts:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L71)
|
|
103
|
-
|
|
104
|
-
___
|
|
105
|
-
|
|
106
|
-
### enabled
|
|
107
|
-
|
|
108
|
-
• `Optional` **enabled**: `boolean`
|
|
109
|
-
|
|
110
|
-
Whether tracking is enabled (default: true)
|
|
111
|
-
|
|
112
|
-
#### Defined in
|
|
113
|
-
|
|
114
|
-
[packages/core/src/hooks/useInactivityTracker.ts:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L73)
|
|
115
|
-
|
|
116
|
-
___
|
|
117
|
-
|
|
118
|
-
### storageKey
|
|
119
|
-
|
|
120
|
-
• `Optional` **storageKey**: `string`
|
|
121
|
-
|
|
122
|
-
Storage key for persistence (default: 'pace-core-inactivity')
|
|
123
|
-
|
|
124
|
-
#### Defined in
|
|
125
|
-
|
|
126
|
-
[packages/core/src/hooks/useInactivityTracker.ts:75](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L75)
|
|
127
|
-
|
|
128
|
-
___
|
|
129
|
-
|
|
130
|
-
### channelName
|
|
131
|
-
|
|
132
|
-
• `Optional` **channelName**: `string`
|
|
133
|
-
|
|
134
|
-
Broadcast channel name for cross-tab sync (default: 'pace-core-inactivity')
|
|
135
|
-
|
|
136
|
-
#### Defined in
|
|
137
|
-
|
|
138
|
-
[packages/core/src/hooks/useInactivityTracker.ts:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L77)
|
|
@@ -1,123 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / UseInactivityTrackerReturn
|
|
2
|
-
|
|
3
|
-
# Interface: UseInactivityTrackerReturn
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [isIdle](UseInactivityTrackerReturn.md#isidle)
|
|
10
|
-
- [timeRemaining](UseInactivityTrackerReturn.md#timeremaining)
|
|
11
|
-
- [showWarning](UseInactivityTrackerReturn.md#showwarning)
|
|
12
|
-
- [resetActivity](UseInactivityTrackerReturn.md#resetactivity)
|
|
13
|
-
- [startTracking](UseInactivityTrackerReturn.md#starttracking)
|
|
14
|
-
- [stopTracking](UseInactivityTrackerReturn.md#stoptracking)
|
|
15
|
-
- [isTracking](UseInactivityTrackerReturn.md#istracking)
|
|
16
|
-
|
|
17
|
-
## Properties
|
|
18
|
-
|
|
19
|
-
### isIdle
|
|
20
|
-
|
|
21
|
-
• **isIdle**: `boolean`
|
|
22
|
-
|
|
23
|
-
Whether the user is currently idle
|
|
24
|
-
|
|
25
|
-
#### Defined in
|
|
26
|
-
|
|
27
|
-
[packages/core/src/hooks/useInactivityTracker.ts:82](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L82)
|
|
28
|
-
|
|
29
|
-
___
|
|
30
|
-
|
|
31
|
-
### timeRemaining
|
|
32
|
-
|
|
33
|
-
• **timeRemaining**: `number`
|
|
34
|
-
|
|
35
|
-
Time remaining in milliseconds before idle timeout
|
|
36
|
-
|
|
37
|
-
#### Defined in
|
|
38
|
-
|
|
39
|
-
[packages/core/src/hooks/useInactivityTracker.ts:84](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L84)
|
|
40
|
-
|
|
41
|
-
___
|
|
42
|
-
|
|
43
|
-
### showWarning
|
|
44
|
-
|
|
45
|
-
• **showWarning**: `boolean`
|
|
46
|
-
|
|
47
|
-
Whether warning should be shown
|
|
48
|
-
|
|
49
|
-
#### Defined in
|
|
50
|
-
|
|
51
|
-
[packages/core/src/hooks/useInactivityTracker.ts:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L86)
|
|
52
|
-
|
|
53
|
-
___
|
|
54
|
-
|
|
55
|
-
### resetActivity
|
|
56
|
-
|
|
57
|
-
• **resetActivity**: () => `void`
|
|
58
|
-
|
|
59
|
-
Reset the activity timer
|
|
60
|
-
|
|
61
|
-
#### Type declaration
|
|
62
|
-
|
|
63
|
-
▸ (): `void`
|
|
64
|
-
|
|
65
|
-
##### Returns
|
|
66
|
-
|
|
67
|
-
`void`
|
|
68
|
-
|
|
69
|
-
#### Defined in
|
|
70
|
-
|
|
71
|
-
[packages/core/src/hooks/useInactivityTracker.ts:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L88)
|
|
72
|
-
|
|
73
|
-
___
|
|
74
|
-
|
|
75
|
-
### startTracking
|
|
76
|
-
|
|
77
|
-
• **startTracking**: () => `void`
|
|
78
|
-
|
|
79
|
-
Start tracking inactivity
|
|
80
|
-
|
|
81
|
-
#### Type declaration
|
|
82
|
-
|
|
83
|
-
▸ (): `void`
|
|
84
|
-
|
|
85
|
-
##### Returns
|
|
86
|
-
|
|
87
|
-
`void`
|
|
88
|
-
|
|
89
|
-
#### Defined in
|
|
90
|
-
|
|
91
|
-
[packages/core/src/hooks/useInactivityTracker.ts:90](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L90)
|
|
92
|
-
|
|
93
|
-
___
|
|
94
|
-
|
|
95
|
-
### stopTracking
|
|
96
|
-
|
|
97
|
-
• **stopTracking**: () => `void`
|
|
98
|
-
|
|
99
|
-
Stop tracking inactivity
|
|
100
|
-
|
|
101
|
-
#### Type declaration
|
|
102
|
-
|
|
103
|
-
▸ (): `void`
|
|
104
|
-
|
|
105
|
-
##### Returns
|
|
106
|
-
|
|
107
|
-
`void`
|
|
108
|
-
|
|
109
|
-
#### Defined in
|
|
110
|
-
|
|
111
|
-
[packages/core/src/hooks/useInactivityTracker.ts:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L92)
|
|
112
|
-
|
|
113
|
-
___
|
|
114
|
-
|
|
115
|
-
### isTracking
|
|
116
|
-
|
|
117
|
-
• **isTracking**: `boolean`
|
|
118
|
-
|
|
119
|
-
Whether tracking is currently active
|
|
120
|
-
|
|
121
|
-
#### Defined in
|
|
122
|
-
|
|
123
|
-
[packages/core/src/hooks/useInactivityTracker.ts:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/hooks/useInactivityTracker.ts#L94)
|