@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,62 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / LoggerConfig
|
|
2
|
-
|
|
3
|
-
# Interface: LoggerConfig
|
|
4
|
-
|
|
5
|
-
Logger configuration interface
|
|
6
|
-
|
|
7
|
-
## Table of contents
|
|
8
|
-
|
|
9
|
-
### Properties
|
|
10
|
-
|
|
11
|
-
- [level](LoggerConfig.md#level)
|
|
12
|
-
- [includeTimestamp](LoggerConfig.md#includetimestamp)
|
|
13
|
-
- [includeComponent](LoggerConfig.md#includecomponent)
|
|
14
|
-
- [prefix](LoggerConfig.md#prefix)
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
### level
|
|
19
|
-
|
|
20
|
-
• **level**: [`LogLevel`](../enums/LogLevel.md)
|
|
21
|
-
|
|
22
|
-
Minimum log level to output
|
|
23
|
-
|
|
24
|
-
#### Defined in
|
|
25
|
-
|
|
26
|
-
[packages/core/src/utils/core/logger.ts:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L23)
|
|
27
|
-
|
|
28
|
-
___
|
|
29
|
-
|
|
30
|
-
### includeTimestamp
|
|
31
|
-
|
|
32
|
-
• **includeTimestamp**: `boolean`
|
|
33
|
-
|
|
34
|
-
Whether to include timestamps
|
|
35
|
-
|
|
36
|
-
#### Defined in
|
|
37
|
-
|
|
38
|
-
[packages/core/src/utils/core/logger.ts:25](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L25)
|
|
39
|
-
|
|
40
|
-
___
|
|
41
|
-
|
|
42
|
-
### includeComponent
|
|
43
|
-
|
|
44
|
-
• **includeComponent**: `boolean`
|
|
45
|
-
|
|
46
|
-
Whether to include component names
|
|
47
|
-
|
|
48
|
-
#### Defined in
|
|
49
|
-
|
|
50
|
-
[packages/core/src/utils/core/logger.ts:27](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L27)
|
|
51
|
-
|
|
52
|
-
___
|
|
53
|
-
|
|
54
|
-
### prefix
|
|
55
|
-
|
|
56
|
-
• `Optional` **prefix**: `string`
|
|
57
|
-
|
|
58
|
-
Custom prefix for all log messages
|
|
59
|
-
|
|
60
|
-
#### Defined in
|
|
61
|
-
|
|
62
|
-
[packages/core/src/utils/core/logger.ts:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/utils/core/logger.ts#L29)
|
|
@@ -1,187 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / LoginFormProps
|
|
2
|
-
|
|
3
|
-
# Interface: LoginFormProps
|
|
4
|
-
|
|
5
|
-
Props for the LoginForm component.
|
|
6
|
-
Configures login form behavior, validation, and callbacks.
|
|
7
|
-
|
|
8
|
-
## Table of contents
|
|
9
|
-
|
|
10
|
-
### Properties
|
|
11
|
-
|
|
12
|
-
- [onSignIn](LoginFormProps.md#onsignin)
|
|
13
|
-
- [onSuccess](LoginFormProps.md#onsuccess)
|
|
14
|
-
- [onError](LoginFormProps.md#onerror)
|
|
15
|
-
- [isLoading](LoginFormProps.md#isloading)
|
|
16
|
-
- [appName](LoginFormProps.md#appname)
|
|
17
|
-
- [title](LoginFormProps.md#title)
|
|
18
|
-
- [subtitle](LoginFormProps.md#subtitle)
|
|
19
|
-
- [showSignUp](LoginFormProps.md#showsignup)
|
|
20
|
-
- [onSignUp](LoginFormProps.md#onsignup)
|
|
21
|
-
- [className](LoginFormProps.md#classname)
|
|
22
|
-
|
|
23
|
-
## Properties
|
|
24
|
-
|
|
25
|
-
### onSignIn
|
|
26
|
-
|
|
27
|
-
• **onSignIn**: (`data`: \{ `email`: `string` ; `password`: `string` }) => `Promise`\<`void`\>
|
|
28
|
-
|
|
29
|
-
Callback invoked when the form is submitted
|
|
30
|
-
|
|
31
|
-
#### Type declaration
|
|
32
|
-
|
|
33
|
-
▸ (`data`): `Promise`\<`void`\>
|
|
34
|
-
|
|
35
|
-
##### Parameters
|
|
36
|
-
|
|
37
|
-
| Name | Type |
|
|
38
|
-
| :------ | :------ |
|
|
39
|
-
| `data` | `Object` |
|
|
40
|
-
| `data.email` | `string` |
|
|
41
|
-
| `data.password` | `string` |
|
|
42
|
-
|
|
43
|
-
##### Returns
|
|
44
|
-
|
|
45
|
-
`Promise`\<`void`\>
|
|
46
|
-
|
|
47
|
-
#### Defined in
|
|
48
|
-
|
|
49
|
-
[packages/core/src/components/LoginForm/LoginForm.tsx:115](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L115)
|
|
50
|
-
|
|
51
|
-
___
|
|
52
|
-
|
|
53
|
-
### onSuccess
|
|
54
|
-
|
|
55
|
-
• `Optional` **onSuccess**: () => `void`
|
|
56
|
-
|
|
57
|
-
Callback invoked on successful sign-in
|
|
58
|
-
|
|
59
|
-
#### Type declaration
|
|
60
|
-
|
|
61
|
-
▸ (): `void`
|
|
62
|
-
|
|
63
|
-
##### Returns
|
|
64
|
-
|
|
65
|
-
`void`
|
|
66
|
-
|
|
67
|
-
#### Defined in
|
|
68
|
-
|
|
69
|
-
[packages/core/src/components/LoginForm/LoginForm.tsx:117](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L117)
|
|
70
|
-
|
|
71
|
-
___
|
|
72
|
-
|
|
73
|
-
### onError
|
|
74
|
-
|
|
75
|
-
• `Optional` **onError**: (`error`: `Error`) => `void`
|
|
76
|
-
|
|
77
|
-
Callback invoked if sign-in fails
|
|
78
|
-
|
|
79
|
-
#### Type declaration
|
|
80
|
-
|
|
81
|
-
▸ (`error`): `void`
|
|
82
|
-
|
|
83
|
-
##### Parameters
|
|
84
|
-
|
|
85
|
-
| Name | Type |
|
|
86
|
-
| :------ | :------ |
|
|
87
|
-
| `error` | `Error` |
|
|
88
|
-
|
|
89
|
-
##### Returns
|
|
90
|
-
|
|
91
|
-
`void`
|
|
92
|
-
|
|
93
|
-
#### Defined in
|
|
94
|
-
|
|
95
|
-
[packages/core/src/components/LoginForm/LoginForm.tsx:119](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L119)
|
|
96
|
-
|
|
97
|
-
___
|
|
98
|
-
|
|
99
|
-
### isLoading
|
|
100
|
-
|
|
101
|
-
• `Optional` **isLoading**: `boolean`
|
|
102
|
-
|
|
103
|
-
Show loading spinner and disable form while true
|
|
104
|
-
|
|
105
|
-
#### Defined in
|
|
106
|
-
|
|
107
|
-
[packages/core/src/components/LoginForm/LoginForm.tsx:121](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L121)
|
|
108
|
-
|
|
109
|
-
___
|
|
110
|
-
|
|
111
|
-
### appName
|
|
112
|
-
|
|
113
|
-
• `Optional` **appName**: `string`
|
|
114
|
-
|
|
115
|
-
Application name for display in the form
|
|
116
|
-
|
|
117
|
-
#### Defined in
|
|
118
|
-
|
|
119
|
-
[packages/core/src/components/LoginForm/LoginForm.tsx:123](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L123)
|
|
120
|
-
|
|
121
|
-
___
|
|
122
|
-
|
|
123
|
-
### title
|
|
124
|
-
|
|
125
|
-
• `Optional` **title**: `string`
|
|
126
|
-
|
|
127
|
-
Custom title for the form
|
|
128
|
-
|
|
129
|
-
#### Defined in
|
|
130
|
-
|
|
131
|
-
[packages/core/src/components/LoginForm/LoginForm.tsx:125](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L125)
|
|
132
|
-
|
|
133
|
-
___
|
|
134
|
-
|
|
135
|
-
### subtitle
|
|
136
|
-
|
|
137
|
-
• `Optional` **subtitle**: `string`
|
|
138
|
-
|
|
139
|
-
Custom subtitle for the form
|
|
140
|
-
|
|
141
|
-
#### Defined in
|
|
142
|
-
|
|
143
|
-
[packages/core/src/components/LoginForm/LoginForm.tsx:127](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L127)
|
|
144
|
-
|
|
145
|
-
___
|
|
146
|
-
|
|
147
|
-
### showSignUp
|
|
148
|
-
|
|
149
|
-
• `Optional` **showSignUp**: `boolean`
|
|
150
|
-
|
|
151
|
-
Show a sign-up link or button
|
|
152
|
-
|
|
153
|
-
#### Defined in
|
|
154
|
-
|
|
155
|
-
[packages/core/src/components/LoginForm/LoginForm.tsx:129](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L129)
|
|
156
|
-
|
|
157
|
-
___
|
|
158
|
-
|
|
159
|
-
### onSignUp
|
|
160
|
-
|
|
161
|
-
• `Optional` **onSignUp**: () => `void`
|
|
162
|
-
|
|
163
|
-
Optional callback for sign-up button
|
|
164
|
-
|
|
165
|
-
#### Type declaration
|
|
166
|
-
|
|
167
|
-
▸ (): `void`
|
|
168
|
-
|
|
169
|
-
##### Returns
|
|
170
|
-
|
|
171
|
-
`void`
|
|
172
|
-
|
|
173
|
-
#### Defined in
|
|
174
|
-
|
|
175
|
-
[packages/core/src/components/LoginForm/LoginForm.tsx:131](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L131)
|
|
176
|
-
|
|
177
|
-
___
|
|
178
|
-
|
|
179
|
-
### className
|
|
180
|
-
|
|
181
|
-
• `Optional` **className**: `string`
|
|
182
|
-
|
|
183
|
-
Additional CSS classes
|
|
184
|
-
|
|
185
|
-
#### Defined in
|
|
186
|
-
|
|
187
|
-
[packages/core/src/components/LoginForm/LoginForm.tsx:133](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/LoginForm/LoginForm.tsx#L133)
|
|
@@ -1,107 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / NavigationAccessRecord
|
|
2
|
-
|
|
3
|
-
# Interface: NavigationAccessRecord
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [navigationItem](NavigationAccessRecord.md#navigationitem)
|
|
10
|
-
- [permissions](NavigationAccessRecord.md#permissions)
|
|
11
|
-
- [userId](NavigationAccessRecord.md#userid)
|
|
12
|
-
- [scope](NavigationAccessRecord.md#scope)
|
|
13
|
-
- [allowed](NavigationAccessRecord.md#allowed)
|
|
14
|
-
- [timestamp](NavigationAccessRecord.md#timestamp)
|
|
15
|
-
- [pageId](NavigationAccessRecord.md#pageid)
|
|
16
|
-
- [roles](NavigationAccessRecord.md#roles)
|
|
17
|
-
- [accessLevel](NavigationAccessRecord.md#accesslevel)
|
|
18
|
-
|
|
19
|
-
## Properties
|
|
20
|
-
|
|
21
|
-
### navigationItem
|
|
22
|
-
|
|
23
|
-
• **navigationItem**: `string`
|
|
24
|
-
|
|
25
|
-
#### Defined in
|
|
26
|
-
|
|
27
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:100](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L100)
|
|
28
|
-
|
|
29
|
-
___
|
|
30
|
-
|
|
31
|
-
### permissions
|
|
32
|
-
|
|
33
|
-
• **permissions**: (\`create:$\{string}\` \| \`read:$\{string}\` \| \`update:$\{string}\` \| \`delete:$\{string}\`)[]
|
|
34
|
-
|
|
35
|
-
#### Defined in
|
|
36
|
-
|
|
37
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L101)
|
|
38
|
-
|
|
39
|
-
___
|
|
40
|
-
|
|
41
|
-
### userId
|
|
42
|
-
|
|
43
|
-
• **userId**: `string`
|
|
44
|
-
|
|
45
|
-
#### Defined in
|
|
46
|
-
|
|
47
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:102](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L102)
|
|
48
|
-
|
|
49
|
-
___
|
|
50
|
-
|
|
51
|
-
### scope
|
|
52
|
-
|
|
53
|
-
• **scope**: [`Scope`](../modules.md#scope)
|
|
54
|
-
|
|
55
|
-
#### Defined in
|
|
56
|
-
|
|
57
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:103](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L103)
|
|
58
|
-
|
|
59
|
-
___
|
|
60
|
-
|
|
61
|
-
### allowed
|
|
62
|
-
|
|
63
|
-
• **allowed**: `boolean`
|
|
64
|
-
|
|
65
|
-
#### Defined in
|
|
66
|
-
|
|
67
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:104](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L104)
|
|
68
|
-
|
|
69
|
-
___
|
|
70
|
-
|
|
71
|
-
### timestamp
|
|
72
|
-
|
|
73
|
-
• **timestamp**: `string`
|
|
74
|
-
|
|
75
|
-
#### Defined in
|
|
76
|
-
|
|
77
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:105](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L105)
|
|
78
|
-
|
|
79
|
-
___
|
|
80
|
-
|
|
81
|
-
### pageId
|
|
82
|
-
|
|
83
|
-
• `Optional` **pageId**: `string`
|
|
84
|
-
|
|
85
|
-
#### Defined in
|
|
86
|
-
|
|
87
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:106](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L106)
|
|
88
|
-
|
|
89
|
-
___
|
|
90
|
-
|
|
91
|
-
### roles
|
|
92
|
-
|
|
93
|
-
• `Optional` **roles**: `string`[]
|
|
94
|
-
|
|
95
|
-
#### Defined in
|
|
96
|
-
|
|
97
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:107](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L107)
|
|
98
|
-
|
|
99
|
-
___
|
|
100
|
-
|
|
101
|
-
### accessLevel
|
|
102
|
-
|
|
103
|
-
• `Optional` **accessLevel**: `string`
|
|
104
|
-
|
|
105
|
-
#### Defined in
|
|
106
|
-
|
|
107
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:108](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L108)
|
|
@@ -1,164 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / NavigationContextType
|
|
2
|
-
|
|
3
|
-
# Interface: NavigationContextType
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [hasNavigationPermission](NavigationContextType.md#hasnavigationpermission)
|
|
10
|
-
- [getNavigationPermissions](NavigationContextType.md#getnavigationpermissions)
|
|
11
|
-
- [getFilteredNavigationItems](NavigationContextType.md#getfilterednavigationitems)
|
|
12
|
-
- [isEnabled](NavigationContextType.md#isenabled)
|
|
13
|
-
- [isStrictMode](NavigationContextType.md#isstrictmode)
|
|
14
|
-
- [isAuditLogEnabled](NavigationContextType.md#isauditlogenabled)
|
|
15
|
-
- [getNavigationAccessHistory](NavigationContextType.md#getnavigationaccesshistory)
|
|
16
|
-
- [clearNavigationAccessHistory](NavigationContextType.md#clearnavigationaccesshistory)
|
|
17
|
-
|
|
18
|
-
## Properties
|
|
19
|
-
|
|
20
|
-
### hasNavigationPermission
|
|
21
|
-
|
|
22
|
-
• **hasNavigationPermission**: (`item`: `NavigationItem`) => `boolean`
|
|
23
|
-
|
|
24
|
-
Check if user has permission for a navigation item
|
|
25
|
-
|
|
26
|
-
#### Type declaration
|
|
27
|
-
|
|
28
|
-
▸ (`item`): `boolean`
|
|
29
|
-
|
|
30
|
-
##### Parameters
|
|
31
|
-
|
|
32
|
-
| Name | Type |
|
|
33
|
-
| :------ | :------ |
|
|
34
|
-
| `item` | `NavigationItem` |
|
|
35
|
-
|
|
36
|
-
##### Returns
|
|
37
|
-
|
|
38
|
-
`boolean`
|
|
39
|
-
|
|
40
|
-
#### Defined in
|
|
41
|
-
|
|
42
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:113](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L113)
|
|
43
|
-
|
|
44
|
-
___
|
|
45
|
-
|
|
46
|
-
### getNavigationPermissions
|
|
47
|
-
|
|
48
|
-
• **getNavigationPermissions**: () => `Record`\<`string`, `string`[]\>
|
|
49
|
-
|
|
50
|
-
Get all navigation permissions for current user
|
|
51
|
-
|
|
52
|
-
#### Type declaration
|
|
53
|
-
|
|
54
|
-
▸ (): `Record`\<`string`, `string`[]\>
|
|
55
|
-
|
|
56
|
-
##### Returns
|
|
57
|
-
|
|
58
|
-
`Record`\<`string`, `string`[]\>
|
|
59
|
-
|
|
60
|
-
#### Defined in
|
|
61
|
-
|
|
62
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:116](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L116)
|
|
63
|
-
|
|
64
|
-
___
|
|
65
|
-
|
|
66
|
-
### getFilteredNavigationItems
|
|
67
|
-
|
|
68
|
-
• **getFilteredNavigationItems**: (`items`: `NavigationItem`[]) => `NavigationItem`[]
|
|
69
|
-
|
|
70
|
-
Get filtered navigation items based on permissions
|
|
71
|
-
|
|
72
|
-
#### Type declaration
|
|
73
|
-
|
|
74
|
-
▸ (`items`): `NavigationItem`[]
|
|
75
|
-
|
|
76
|
-
##### Parameters
|
|
77
|
-
|
|
78
|
-
| Name | Type |
|
|
79
|
-
| :------ | :------ |
|
|
80
|
-
| `items` | `NavigationItem`[] |
|
|
81
|
-
|
|
82
|
-
##### Returns
|
|
83
|
-
|
|
84
|
-
`NavigationItem`[]
|
|
85
|
-
|
|
86
|
-
#### Defined in
|
|
87
|
-
|
|
88
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:119](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L119)
|
|
89
|
-
|
|
90
|
-
___
|
|
91
|
-
|
|
92
|
-
### isEnabled
|
|
93
|
-
|
|
94
|
-
• **isEnabled**: `boolean`
|
|
95
|
-
|
|
96
|
-
Check if navigation permission checking is enabled
|
|
97
|
-
|
|
98
|
-
#### Defined in
|
|
99
|
-
|
|
100
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:122](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L122)
|
|
101
|
-
|
|
102
|
-
___
|
|
103
|
-
|
|
104
|
-
### isStrictMode
|
|
105
|
-
|
|
106
|
-
• **isStrictMode**: `boolean`
|
|
107
|
-
|
|
108
|
-
Check if strict mode is enabled
|
|
109
|
-
|
|
110
|
-
#### Defined in
|
|
111
|
-
|
|
112
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:125](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L125)
|
|
113
|
-
|
|
114
|
-
___
|
|
115
|
-
|
|
116
|
-
### isAuditLogEnabled
|
|
117
|
-
|
|
118
|
-
• **isAuditLogEnabled**: `boolean`
|
|
119
|
-
|
|
120
|
-
Check if audit logging is enabled
|
|
121
|
-
|
|
122
|
-
#### Defined in
|
|
123
|
-
|
|
124
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:128](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L128)
|
|
125
|
-
|
|
126
|
-
___
|
|
127
|
-
|
|
128
|
-
### getNavigationAccessHistory
|
|
129
|
-
|
|
130
|
-
• **getNavigationAccessHistory**: () => [`NavigationAccessRecord`](NavigationAccessRecord.md)[]
|
|
131
|
-
|
|
132
|
-
Get navigation access history
|
|
133
|
-
|
|
134
|
-
#### Type declaration
|
|
135
|
-
|
|
136
|
-
▸ (): [`NavigationAccessRecord`](NavigationAccessRecord.md)[]
|
|
137
|
-
|
|
138
|
-
##### Returns
|
|
139
|
-
|
|
140
|
-
[`NavigationAccessRecord`](NavigationAccessRecord.md)[]
|
|
141
|
-
|
|
142
|
-
#### Defined in
|
|
143
|
-
|
|
144
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:131](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L131)
|
|
145
|
-
|
|
146
|
-
___
|
|
147
|
-
|
|
148
|
-
### clearNavigationAccessHistory
|
|
149
|
-
|
|
150
|
-
• **clearNavigationAccessHistory**: () => `void`
|
|
151
|
-
|
|
152
|
-
Clear navigation access history
|
|
153
|
-
|
|
154
|
-
#### Type declaration
|
|
155
|
-
|
|
156
|
-
▸ (): `void`
|
|
157
|
-
|
|
158
|
-
##### Returns
|
|
159
|
-
|
|
160
|
-
`void`
|
|
161
|
-
|
|
162
|
-
#### Defined in
|
|
163
|
-
|
|
164
|
-
[packages/core/src/rbac/components/NavigationProvider.tsx:134](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationProvider.tsx#L134)
|
|
@@ -1,139 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / NavigationGuardProps
|
|
2
|
-
|
|
3
|
-
# Interface: NavigationGuardProps
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [navigationItem](NavigationGuardProps.md#navigationitem)
|
|
10
|
-
- [children](NavigationGuardProps.md#children)
|
|
11
|
-
- [fallback](NavigationGuardProps.md#fallback)
|
|
12
|
-
- [strictMode](NavigationGuardProps.md#strictmode)
|
|
13
|
-
- [auditLog](NavigationGuardProps.md#auditlog)
|
|
14
|
-
- [scope](NavigationGuardProps.md#scope)
|
|
15
|
-
- [onDenied](NavigationGuardProps.md#ondenied)
|
|
16
|
-
- [loading](NavigationGuardProps.md#loading)
|
|
17
|
-
- [requireAll](NavigationGuardProps.md#requireall)
|
|
18
|
-
|
|
19
|
-
## Properties
|
|
20
|
-
|
|
21
|
-
### navigationItem
|
|
22
|
-
|
|
23
|
-
• **navigationItem**: `NavigationItem`
|
|
24
|
-
|
|
25
|
-
Navigation item being protected
|
|
26
|
-
|
|
27
|
-
#### Defined in
|
|
28
|
-
|
|
29
|
-
[packages/core/src/rbac/components/NavigationGuard.tsx:77](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L77)
|
|
30
|
-
|
|
31
|
-
___
|
|
32
|
-
|
|
33
|
-
### children
|
|
34
|
-
|
|
35
|
-
• **children**: `ReactNode`
|
|
36
|
-
|
|
37
|
-
Content to render when user has permission
|
|
38
|
-
|
|
39
|
-
#### Defined in
|
|
40
|
-
|
|
41
|
-
[packages/core/src/rbac/components/NavigationGuard.tsx:80](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L80)
|
|
42
|
-
|
|
43
|
-
___
|
|
44
|
-
|
|
45
|
-
### fallback
|
|
46
|
-
|
|
47
|
-
• `Optional` **fallback**: `ReactNode`
|
|
48
|
-
|
|
49
|
-
Content to render when user lacks permission
|
|
50
|
-
|
|
51
|
-
#### Defined in
|
|
52
|
-
|
|
53
|
-
[packages/core/src/rbac/components/NavigationGuard.tsx:83](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L83)
|
|
54
|
-
|
|
55
|
-
___
|
|
56
|
-
|
|
57
|
-
### strictMode
|
|
58
|
-
|
|
59
|
-
• `Optional` **strictMode**: `boolean`
|
|
60
|
-
|
|
61
|
-
Enable strict mode to prevent bypassing (default: true)
|
|
62
|
-
|
|
63
|
-
#### Defined in
|
|
64
|
-
|
|
65
|
-
[packages/core/src/rbac/components/NavigationGuard.tsx:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L86)
|
|
66
|
-
|
|
67
|
-
___
|
|
68
|
-
|
|
69
|
-
### auditLog
|
|
70
|
-
|
|
71
|
-
• `Optional` **auditLog**: `boolean`
|
|
72
|
-
|
|
73
|
-
Force audit logging for this navigation access (default: true)
|
|
74
|
-
|
|
75
|
-
#### Defined in
|
|
76
|
-
|
|
77
|
-
[packages/core/src/rbac/components/NavigationGuard.tsx:89](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L89)
|
|
78
|
-
|
|
79
|
-
___
|
|
80
|
-
|
|
81
|
-
### scope
|
|
82
|
-
|
|
83
|
-
• `Optional` **scope**: [`Scope`](../modules.md#scope)
|
|
84
|
-
|
|
85
|
-
Custom scope for permission checking
|
|
86
|
-
|
|
87
|
-
#### Defined in
|
|
88
|
-
|
|
89
|
-
[packages/core/src/rbac/components/NavigationGuard.tsx:92](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L92)
|
|
90
|
-
|
|
91
|
-
___
|
|
92
|
-
|
|
93
|
-
### onDenied
|
|
94
|
-
|
|
95
|
-
• `Optional` **onDenied**: (`item`: `NavigationItem`) => `void`
|
|
96
|
-
|
|
97
|
-
Callback when access is denied
|
|
98
|
-
|
|
99
|
-
#### Type declaration
|
|
100
|
-
|
|
101
|
-
▸ (`item`): `void`
|
|
102
|
-
|
|
103
|
-
##### Parameters
|
|
104
|
-
|
|
105
|
-
| Name | Type |
|
|
106
|
-
| :------ | :------ |
|
|
107
|
-
| `item` | `NavigationItem` |
|
|
108
|
-
|
|
109
|
-
##### Returns
|
|
110
|
-
|
|
111
|
-
`void`
|
|
112
|
-
|
|
113
|
-
#### Defined in
|
|
114
|
-
|
|
115
|
-
[packages/core/src/rbac/components/NavigationGuard.tsx:95](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L95)
|
|
116
|
-
|
|
117
|
-
___
|
|
118
|
-
|
|
119
|
-
### loading
|
|
120
|
-
|
|
121
|
-
• `Optional` **loading**: `ReactNode`
|
|
122
|
-
|
|
123
|
-
Loading state content
|
|
124
|
-
|
|
125
|
-
#### Defined in
|
|
126
|
-
|
|
127
|
-
[packages/core/src/rbac/components/NavigationGuard.tsx:98](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L98)
|
|
128
|
-
|
|
129
|
-
___
|
|
130
|
-
|
|
131
|
-
### requireAll
|
|
132
|
-
|
|
133
|
-
• `Optional` **requireAll**: `boolean`
|
|
134
|
-
|
|
135
|
-
Require all permissions (AND) or any permission (OR)
|
|
136
|
-
|
|
137
|
-
#### Defined in
|
|
138
|
-
|
|
139
|
-
[packages/core/src/rbac/components/NavigationGuard.tsx:101](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/components/NavigationGuard.tsx#L101)
|