@jmruthers/pace-core 0.6.2 → 0.6.3
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-THFPBKTP.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-KAGUYQ4J.js} +5 -4
- package/dist/{api-MVVQZLJI.js → api-IAGWF3ZG.js} +10 -10
- package/dist/{audit-B5P6FFIR.js → audit-V53FV5AG.js} +2 -2
- package/dist/{chunk-SFZUDBL5.js → chunk-2T2IG7T7.js} +70 -56
- package/dist/chunk-2T2IG7T7.js.map +1 -0
- package/dist/{chunk-MMZ7JXPU.js → chunk-6Z7LTB3D.js} +13 -21
- package/dist/{chunk-MMZ7JXPU.js.map → chunk-6Z7LTB3D.js.map} +1 -1
- package/dist/{chunk-6J4GEEJR.js → chunk-CNCQDFLN.js} +53 -27
- package/dist/chunk-CNCQDFLN.js.map +1 -0
- package/dist/chunk-DGUM43GV.js +11 -0
- package/dist/{chunk-EHMR7VYL.js → chunk-DWUBLJJM.js} +361 -187
- package/dist/chunk-DWUBLJJM.js.map +1 -0
- package/dist/{chunk-2UOI2FG5.js → chunk-HFZBI76P.js} +4 -4
- package/dist/{chunk-F2IMUDXZ.js → chunk-M7MPQISP.js} +2 -2
- package/dist/{chunk-3XC4CPTD.js → chunk-PQBSKX33.js} +244 -5727
- package/dist/chunk-PQBSKX33.js.map +1 -0
- package/dist/chunk-QRPVRXYT.js +226 -0
- package/dist/chunk-QRPVRXYT.js.map +1 -0
- package/dist/{chunk-24UVZUZG.js → chunk-RWEBCB47.js} +129 -387
- package/dist/chunk-RWEBCB47.js.map +1 -0
- package/dist/{chunk-XWQCNGTQ.js → chunk-YDQHOZNA.js} +173 -79
- package/dist/chunk-YDQHOZNA.js.map +1 -0
- package/dist/{chunk-NECFR5MM.js → chunk-ZNIWI3UC.js} +562 -644
- package/dist/chunk-ZNIWI3UC.js.map +1 -0
- package/dist/components.d.ts +2 -2
- package/dist/components.js +12 -13
- package/dist/contextValidator-3JNZKUTX.js +9 -0
- package/dist/contextValidator-3JNZKUTX.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 +3 -3
- package/scripts/audit/core/checks/compliance.cjs +72 -0
- package/scripts/audit/core/checks/dependencies.cjs +559 -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 +135 -33
- 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 +186 -54
- 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-THFPBKTP.js.map} +0 -0
- /package/dist/{UnifiedAuthProvider-CH6Z342H.js.map → UnifiedAuthProvider-KAGUYQ4J.js.map} +0 -0
- /package/dist/{api-MVVQZLJI.js.map → api-IAGWF3ZG.js.map} +0 -0
- /package/dist/{audit-B5P6FFIR.js.map → audit-V53FV5AG.js.map} +0 -0
- /package/dist/{chunk-7D4SUZUM.js.map → chunk-DGUM43GV.js.map} +0 -0
- /package/dist/{chunk-2UOI2FG5.js.map → chunk-HFZBI76P.js.map} +0 -0
- /package/dist/{chunk-F2IMUDXZ.js.map → chunk-M7MPQISP.js.map} +0 -0
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / EventAppRoleData
|
|
2
|
-
|
|
3
|
-
# Interface: EventAppRoleData
|
|
4
|
-
|
|
5
|
-
## Hierarchy
|
|
6
|
-
|
|
7
|
-
- **`EventAppRoleData`**
|
|
8
|
-
|
|
9
|
-
↳ [`RevokeEventAppRoleParams`](RevokeEventAppRoleParams.md)
|
|
10
|
-
|
|
11
|
-
↳ [`GrantEventAppRoleParams`](GrantEventAppRoleParams.md)
|
|
12
|
-
|
|
13
|
-
## Table of contents
|
|
14
|
-
|
|
15
|
-
### Properties
|
|
16
|
-
|
|
17
|
-
- [user\_id](EventAppRoleData.md#user_id)
|
|
18
|
-
- [organisation\_id](EventAppRoleData.md#organisation_id)
|
|
19
|
-
- [event\_id](EventAppRoleData.md#event_id)
|
|
20
|
-
- [app\_id](EventAppRoleData.md#app_id)
|
|
21
|
-
- [role](EventAppRoleData.md#role)
|
|
22
|
-
|
|
23
|
-
## Properties
|
|
24
|
-
|
|
25
|
-
### user\_id
|
|
26
|
-
|
|
27
|
-
• **user\_id**: `string`
|
|
28
|
-
|
|
29
|
-
#### Defined in
|
|
30
|
-
|
|
31
|
-
[packages/core/src/rbac/hooks/useRoleManagement.ts:65](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L65)
|
|
32
|
-
|
|
33
|
-
___
|
|
34
|
-
|
|
35
|
-
### organisation\_id
|
|
36
|
-
|
|
37
|
-
• **organisation\_id**: `string`
|
|
38
|
-
|
|
39
|
-
#### Defined in
|
|
40
|
-
|
|
41
|
-
[packages/core/src/rbac/hooks/useRoleManagement.ts:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L66)
|
|
42
|
-
|
|
43
|
-
___
|
|
44
|
-
|
|
45
|
-
### event\_id
|
|
46
|
-
|
|
47
|
-
• **event\_id**: `string`
|
|
48
|
-
|
|
49
|
-
#### Defined in
|
|
50
|
-
|
|
51
|
-
[packages/core/src/rbac/hooks/useRoleManagement.ts:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L67)
|
|
52
|
-
|
|
53
|
-
___
|
|
54
|
-
|
|
55
|
-
### app\_id
|
|
56
|
-
|
|
57
|
-
• **app\_id**: `string`
|
|
58
|
-
|
|
59
|
-
#### Defined in
|
|
60
|
-
|
|
61
|
-
[packages/core/src/rbac/hooks/useRoleManagement.ts:68](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L68)
|
|
62
|
-
|
|
63
|
-
___
|
|
64
|
-
|
|
65
|
-
### role
|
|
66
|
-
|
|
67
|
-
• **role**: ``"viewer"`` \| ``"participant"`` \| ``"planner"`` \| ``"event_admin"``
|
|
68
|
-
|
|
69
|
-
#### Defined in
|
|
70
|
-
|
|
71
|
-
[packages/core/src/rbac/hooks/useRoleManagement.ts:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/rbac/hooks/useRoleManagement.ts#L69)
|
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / ExportColumn
|
|
2
|
-
|
|
3
|
-
# Interface: ExportColumn
|
|
4
|
-
|
|
5
|
-
Column definition for export
|
|
6
|
-
|
|
7
|
-
## Table of contents
|
|
8
|
-
|
|
9
|
-
### Properties
|
|
10
|
-
|
|
11
|
-
- [header](ExportColumn.md#header)
|
|
12
|
-
- [id](ExportColumn.md#id)
|
|
13
|
-
- [accessorKey](ExportColumn.md#accessorkey)
|
|
14
|
-
- [accessorFn](ExportColumn.md#accessorfn)
|
|
15
|
-
- [editAccessorKey](ExportColumn.md#editaccessorkey)
|
|
16
|
-
- [isIdColumn](ExportColumn.md#isidcolumn)
|
|
17
|
-
|
|
18
|
-
## Properties
|
|
19
|
-
|
|
20
|
-
### header
|
|
21
|
-
|
|
22
|
-
• `Optional` **header**: `string`
|
|
23
|
-
|
|
24
|
-
#### Defined in
|
|
25
|
-
|
|
26
|
-
[packages/core/src/components/DataTable/utils/exportUtils.ts:49](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/utils/exportUtils.ts#L49)
|
|
27
|
-
|
|
28
|
-
___
|
|
29
|
-
|
|
30
|
-
### id
|
|
31
|
-
|
|
32
|
-
• `Optional` **id**: `string`
|
|
33
|
-
|
|
34
|
-
#### Defined in
|
|
35
|
-
|
|
36
|
-
[packages/core/src/components/DataTable/utils/exportUtils.ts:50](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/utils/exportUtils.ts#L50)
|
|
37
|
-
|
|
38
|
-
___
|
|
39
|
-
|
|
40
|
-
### accessorKey
|
|
41
|
-
|
|
42
|
-
• `Optional` **accessorKey**: `string`
|
|
43
|
-
|
|
44
|
-
#### Defined in
|
|
45
|
-
|
|
46
|
-
[packages/core/src/components/DataTable/utils/exportUtils.ts:51](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/utils/exportUtils.ts#L51)
|
|
47
|
-
|
|
48
|
-
___
|
|
49
|
-
|
|
50
|
-
### accessorFn
|
|
51
|
-
|
|
52
|
-
• `Optional` **accessorFn**: (`row`: [`DataRecord`](DataRecord.md)) => `unknown`
|
|
53
|
-
|
|
54
|
-
#### Type declaration
|
|
55
|
-
|
|
56
|
-
▸ (`row`): `unknown`
|
|
57
|
-
|
|
58
|
-
##### Parameters
|
|
59
|
-
|
|
60
|
-
| Name | Type |
|
|
61
|
-
| :------ | :------ |
|
|
62
|
-
| `row` | [`DataRecord`](DataRecord.md) |
|
|
63
|
-
|
|
64
|
-
##### Returns
|
|
65
|
-
|
|
66
|
-
`unknown`
|
|
67
|
-
|
|
68
|
-
#### Defined in
|
|
69
|
-
|
|
70
|
-
[packages/core/src/components/DataTable/utils/exportUtils.ts:52](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/utils/exportUtils.ts#L52)
|
|
71
|
-
|
|
72
|
-
___
|
|
73
|
-
|
|
74
|
-
### editAccessorKey
|
|
75
|
-
|
|
76
|
-
• `Optional` **editAccessorKey**: `string`
|
|
77
|
-
|
|
78
|
-
#### Defined in
|
|
79
|
-
|
|
80
|
-
[packages/core/src/components/DataTable/utils/exportUtils.ts:53](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/utils/exportUtils.ts#L53)
|
|
81
|
-
|
|
82
|
-
___
|
|
83
|
-
|
|
84
|
-
### isIdColumn
|
|
85
|
-
|
|
86
|
-
• `Optional` **isIdColumn**: `boolean`
|
|
87
|
-
|
|
88
|
-
#### Defined in
|
|
89
|
-
|
|
90
|
-
[packages/core/src/components/DataTable/utils/exportUtils.ts:54](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/utils/exportUtils.ts#L54)
|
|
@@ -1,126 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / ExportOptions
|
|
2
|
-
|
|
3
|
-
# Interface: ExportOptions\<TData\>
|
|
4
|
-
|
|
5
|
-
Options provided to the onExport handler for custom export functionality
|
|
6
|
-
|
|
7
|
-
**`Example`**
|
|
8
|
-
|
|
9
|
-
```tsx
|
|
10
|
-
<DataTable
|
|
11
|
-
onExport={async (options) => {
|
|
12
|
-
// Export only specific columns
|
|
13
|
-
const customColumns = options.allColumns.filter(col =>
|
|
14
|
-
['name', 'email', 'role'].includes(col.accessorKey || '')
|
|
15
|
-
);
|
|
16
|
-
await exportToCSVWithTableRows(
|
|
17
|
-
options.tableRows,
|
|
18
|
-
customColumns,
|
|
19
|
-
options.columnIdToTableColumn,
|
|
20
|
-
'custom-export.csv'
|
|
21
|
-
);
|
|
22
|
-
}}
|
|
23
|
-
/>
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Type parameters
|
|
27
|
-
|
|
28
|
-
| Name | Type |
|
|
29
|
-
| :------ | :------ |
|
|
30
|
-
| `TData` | extends [`DataRecord`](DataRecord.md) |
|
|
31
|
-
|
|
32
|
-
## Table of contents
|
|
33
|
-
|
|
34
|
-
### Properties
|
|
35
|
-
|
|
36
|
-
- [tableRows](ExportOptions.md#tablerows)
|
|
37
|
-
- [allColumns](ExportOptions.md#allcolumns)
|
|
38
|
-
- [visibleColumns](ExportOptions.md#visiblecolumns)
|
|
39
|
-
- [columnIdToTableColumn](ExportOptions.md#columnidtotablecolumn)
|
|
40
|
-
- [data](ExportOptions.md#data)
|
|
41
|
-
- [filename](ExportOptions.md#filename)
|
|
42
|
-
- [table](ExportOptions.md#table)
|
|
43
|
-
|
|
44
|
-
## Properties
|
|
45
|
-
|
|
46
|
-
### tableRows
|
|
47
|
-
|
|
48
|
-
• **tableRows**: \{ `original`: `TData` ; `getValue`: (`columnId`: `string`) => `unknown` ; `id`: `string` }[]
|
|
49
|
-
|
|
50
|
-
Filtered table rows with getValue() method for proper accessorFn evaluation
|
|
51
|
-
|
|
52
|
-
#### Defined in
|
|
53
|
-
|
|
54
|
-
[packages/core/src/components/DataTable/types.ts:643](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L643)
|
|
55
|
-
|
|
56
|
-
___
|
|
57
|
-
|
|
58
|
-
### allColumns
|
|
59
|
-
|
|
60
|
-
• **allColumns**: [`DataTableColumn`](DataTableColumn.md)\<`TData`\>[]
|
|
61
|
-
|
|
62
|
-
All column definitions passed to the DataTable
|
|
63
|
-
|
|
64
|
-
#### Defined in
|
|
65
|
-
|
|
66
|
-
[packages/core/src/components/DataTable/types.ts:649](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L649)
|
|
67
|
-
|
|
68
|
-
___
|
|
69
|
-
|
|
70
|
-
### visibleColumns
|
|
71
|
-
|
|
72
|
-
• **visibleColumns**: [`DataTableColumn`](DataTableColumn.md)\<`TData`\>[]
|
|
73
|
-
|
|
74
|
-
Currently visible columns in the table
|
|
75
|
-
|
|
76
|
-
#### Defined in
|
|
77
|
-
|
|
78
|
-
[packages/core/src/components/DataTable/types.ts:651](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L651)
|
|
79
|
-
|
|
80
|
-
___
|
|
81
|
-
|
|
82
|
-
### columnIdToTableColumn
|
|
83
|
-
|
|
84
|
-
• **columnIdToTableColumn**: `Map`\<`string`, `unknown`\>
|
|
85
|
-
|
|
86
|
-
Mapping of column IDs to TanStack table column instances (for getValue() calls)
|
|
87
|
-
|
|
88
|
-
#### Defined in
|
|
89
|
-
|
|
90
|
-
[packages/core/src/components/DataTable/types.ts:653](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L653)
|
|
91
|
-
|
|
92
|
-
___
|
|
93
|
-
|
|
94
|
-
### data
|
|
95
|
-
|
|
96
|
-
• **data**: `TData`[]
|
|
97
|
-
|
|
98
|
-
Raw data array (unfiltered)
|
|
99
|
-
|
|
100
|
-
#### Defined in
|
|
101
|
-
|
|
102
|
-
[packages/core/src/components/DataTable/types.ts:655](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L655)
|
|
103
|
-
|
|
104
|
-
___
|
|
105
|
-
|
|
106
|
-
### filename
|
|
107
|
-
|
|
108
|
-
• **filename**: `string`
|
|
109
|
-
|
|
110
|
-
Default filename generated from table title
|
|
111
|
-
|
|
112
|
-
#### Defined in
|
|
113
|
-
|
|
114
|
-
[packages/core/src/components/DataTable/types.ts:657](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L657)
|
|
115
|
-
|
|
116
|
-
___
|
|
117
|
-
|
|
118
|
-
### table
|
|
119
|
-
|
|
120
|
-
• **table**: `unknown`
|
|
121
|
-
|
|
122
|
-
TanStack table instance for advanced operations
|
|
123
|
-
|
|
124
|
-
#### Defined in
|
|
125
|
-
|
|
126
|
-
[packages/core/src/components/DataTable/types.ts:659](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/DataTable/types.ts#L659)
|
|
@@ -1,249 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / FileDisplayProps
|
|
2
|
-
|
|
3
|
-
# Interface: FileDisplayProps
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [table\_name](FileDisplayProps.md#table_name)
|
|
10
|
-
- [record\_id](FileDisplayProps.md#record_id)
|
|
11
|
-
- [organisation\_id](FileDisplayProps.md#organisation_id)
|
|
12
|
-
- [category](FileDisplayProps.md#category)
|
|
13
|
-
- [displayOnly](FileDisplayProps.md#displayonly)
|
|
14
|
-
- [showDelete](FileDisplayProps.md#showdelete)
|
|
15
|
-
- [className](FileDisplayProps.md#classname)
|
|
16
|
-
- [imgClassName](FileDisplayProps.md#imgclassname)
|
|
17
|
-
- [children](FileDisplayProps.md#children)
|
|
18
|
-
- [loadingComponent](FileDisplayProps.md#loadingcomponent)
|
|
19
|
-
- [errorComponent](FileDisplayProps.md#errorcomponent)
|
|
20
|
-
- [showFallback](FileDisplayProps.md#showfallback)
|
|
21
|
-
- [generateFallbackText](FileDisplayProps.md#generatefallbacktext)
|
|
22
|
-
- [fallbackText](FileDisplayProps.md#fallbacktext)
|
|
23
|
-
- [fallbackSourceText](FileDisplayProps.md#fallbacksourcetext)
|
|
24
|
-
- [fallbackSize](FileDisplayProps.md#fallbacksize)
|
|
25
|
-
- [enableChildren](FileDisplayProps.md#enablechildren)
|
|
26
|
-
- [showMetadata](FileDisplayProps.md#showmetadata)
|
|
27
|
-
|
|
28
|
-
## Properties
|
|
29
|
-
|
|
30
|
-
### table\_name
|
|
31
|
-
|
|
32
|
-
• **table\_name**: `string`
|
|
33
|
-
|
|
34
|
-
#### Defined in
|
|
35
|
-
|
|
36
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:58](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L58)
|
|
37
|
-
|
|
38
|
-
___
|
|
39
|
-
|
|
40
|
-
### record\_id
|
|
41
|
-
|
|
42
|
-
• **record\_id**: `string`
|
|
43
|
-
|
|
44
|
-
#### Defined in
|
|
45
|
-
|
|
46
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:59](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L59)
|
|
47
|
-
|
|
48
|
-
___
|
|
49
|
-
|
|
50
|
-
### organisation\_id
|
|
51
|
-
|
|
52
|
-
• `Optional` **organisation\_id**: `string`
|
|
53
|
-
|
|
54
|
-
Optional organisation ID. When not provided (undefined), the component will automatically
|
|
55
|
-
search for files in both user-scoped (organisation_id = null) and organisation-scoped contexts.
|
|
56
|
-
If both types of files exist, organisation-scoped files are preferred.
|
|
57
|
-
When explicitly set to null, only user-scoped files are searched.
|
|
58
|
-
|
|
59
|
-
#### Defined in
|
|
60
|
-
|
|
61
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:66](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L66)
|
|
62
|
-
|
|
63
|
-
___
|
|
64
|
-
|
|
65
|
-
### category
|
|
66
|
-
|
|
67
|
-
• `Optional` **category**: [`FileCategory`](../enums/FileCategory.md)
|
|
68
|
-
|
|
69
|
-
#### Defined in
|
|
70
|
-
|
|
71
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:67](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L67)
|
|
72
|
-
|
|
73
|
-
___
|
|
74
|
-
|
|
75
|
-
### displayOnly
|
|
76
|
-
|
|
77
|
-
• `Optional` **displayOnly**: `boolean`
|
|
78
|
-
|
|
79
|
-
Display only a single file instead of all files. Uses first file (prefers images) from all files, without category filtering
|
|
80
|
-
|
|
81
|
-
#### Defined in
|
|
82
|
-
|
|
83
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:69](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L69)
|
|
84
|
-
|
|
85
|
-
___
|
|
86
|
-
|
|
87
|
-
### showDelete
|
|
88
|
-
|
|
89
|
-
• `Optional` **showDelete**: `boolean`
|
|
90
|
-
|
|
91
|
-
#### Defined in
|
|
92
|
-
|
|
93
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:70](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L70)
|
|
94
|
-
|
|
95
|
-
___
|
|
96
|
-
|
|
97
|
-
### className
|
|
98
|
-
|
|
99
|
-
• `Optional` **className**: `string`
|
|
100
|
-
|
|
101
|
-
#### Defined in
|
|
102
|
-
|
|
103
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:71](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L71)
|
|
104
|
-
|
|
105
|
-
___
|
|
106
|
-
|
|
107
|
-
### imgClassName
|
|
108
|
-
|
|
109
|
-
• `Optional` **imgClassName**: `string`
|
|
110
|
-
|
|
111
|
-
Classes to apply to the first child element of <figure> (img, p, or other elements)
|
|
112
|
-
|
|
113
|
-
#### Defined in
|
|
114
|
-
|
|
115
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:73](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L73)
|
|
116
|
-
|
|
117
|
-
___
|
|
118
|
-
|
|
119
|
-
### children
|
|
120
|
-
|
|
121
|
-
• `Optional` **children**: `ReactNode`
|
|
122
|
-
|
|
123
|
-
#### Defined in
|
|
124
|
-
|
|
125
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:74](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L74)
|
|
126
|
-
|
|
127
|
-
___
|
|
128
|
-
|
|
129
|
-
### loadingComponent
|
|
130
|
-
|
|
131
|
-
• `Optional` **loadingComponent**: `ComponentType`\<{}\>
|
|
132
|
-
|
|
133
|
-
Custom loading component to render during data fetching
|
|
134
|
-
|
|
135
|
-
#### Defined in
|
|
136
|
-
|
|
137
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:76](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L76)
|
|
138
|
-
|
|
139
|
-
___
|
|
140
|
-
|
|
141
|
-
### errorComponent
|
|
142
|
-
|
|
143
|
-
• `Optional` **errorComponent**: `ComponentType`\<\{ `error`: ``null`` \| `string` \| `Error` ; `retry?`: () => `void` }\>
|
|
144
|
-
|
|
145
|
-
Custom error component to render when an error occurs
|
|
146
|
-
|
|
147
|
-
#### Defined in
|
|
148
|
-
|
|
149
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:78](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L78)
|
|
150
|
-
|
|
151
|
-
___
|
|
152
|
-
|
|
153
|
-
### showFallback
|
|
154
|
-
|
|
155
|
-
• `Optional` **showFallback**: `boolean`
|
|
156
|
-
|
|
157
|
-
Whether to show fallback UI when no file is available or image fails to load
|
|
158
|
-
|
|
159
|
-
#### Defined in
|
|
160
|
-
|
|
161
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:80](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L80)
|
|
162
|
-
|
|
163
|
-
___
|
|
164
|
-
|
|
165
|
-
### generateFallbackText
|
|
166
|
-
|
|
167
|
-
• `Optional` **generateFallbackText**: (`fileName?`: `string`) => `string`
|
|
168
|
-
|
|
169
|
-
Custom function to generate fallback text from file name or other context
|
|
170
|
-
|
|
171
|
-
#### Type declaration
|
|
172
|
-
|
|
173
|
-
▸ (`fileName?`): `string`
|
|
174
|
-
|
|
175
|
-
##### Parameters
|
|
176
|
-
|
|
177
|
-
| Name | Type |
|
|
178
|
-
| :------ | :------ |
|
|
179
|
-
| `fileName?` | `string` |
|
|
180
|
-
|
|
181
|
-
##### Returns
|
|
182
|
-
|
|
183
|
-
`string`
|
|
184
|
-
|
|
185
|
-
#### Defined in
|
|
186
|
-
|
|
187
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:82](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L82)
|
|
188
|
-
|
|
189
|
-
___
|
|
190
|
-
|
|
191
|
-
### fallbackText
|
|
192
|
-
|
|
193
|
-
• `Optional` **fallbackText**: `string`
|
|
194
|
-
|
|
195
|
-
Explicit fallback text to display (overrides generateFallbackText)
|
|
196
|
-
|
|
197
|
-
#### Defined in
|
|
198
|
-
|
|
199
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:84](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L84)
|
|
200
|
-
|
|
201
|
-
___
|
|
202
|
-
|
|
203
|
-
### fallbackSourceText
|
|
204
|
-
|
|
205
|
-
• `Optional` **fallbackSourceText**: `string`
|
|
206
|
-
|
|
207
|
-
Source text to use for generating fallback text (overrides filename)
|
|
208
|
-
|
|
209
|
-
#### Defined in
|
|
210
|
-
|
|
211
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:86](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L86)
|
|
212
|
-
|
|
213
|
-
___
|
|
214
|
-
|
|
215
|
-
### fallbackSize
|
|
216
|
-
|
|
217
|
-
• `Optional` **fallbackSize**: ``"sm"`` \| ``"lg"`` \| ``"md"`` \| ``"xl"`` \| ``"xs"`` \| ``"2xl"``
|
|
218
|
-
|
|
219
|
-
Size variant for fallback display (only applies when showFallback is true)
|
|
220
|
-
|
|
221
|
-
#### Defined in
|
|
222
|
-
|
|
223
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:88](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L88)
|
|
224
|
-
|
|
225
|
-
___
|
|
226
|
-
|
|
227
|
-
### enableChildren
|
|
228
|
-
|
|
229
|
-
• `Optional` **enableChildren**: `boolean`
|
|
230
|
-
|
|
231
|
-
Enable children rendering in displayOnly mode. When true, uses standard display path
|
|
232
|
-
(with children support) even if showDelete is false. The delete button will only appear
|
|
233
|
-
if showDelete is also true.
|
|
234
|
-
|
|
235
|
-
#### Defined in
|
|
236
|
-
|
|
237
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:94](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L94)
|
|
238
|
-
|
|
239
|
-
___
|
|
240
|
-
|
|
241
|
-
### showMetadata
|
|
242
|
-
|
|
243
|
-
• `Optional` **showMetadata**: `boolean`
|
|
244
|
-
|
|
245
|
-
Whether to show metadata (filename, filesize, mimetype) in figcaption. Defaults to true.
|
|
246
|
-
|
|
247
|
-
#### Defined in
|
|
248
|
-
|
|
249
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:96](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L96)
|
|
@@ -1,129 +0,0 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / FileMetadata
|
|
2
|
-
|
|
3
|
-
# Interface: FileMetadata
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Properties
|
|
8
|
-
|
|
9
|
-
- [fileName](FileMetadata.md#filename)
|
|
10
|
-
- [fileType](FileMetadata.md#filetype)
|
|
11
|
-
- [fileSize](FileMetadata.md#filesize)
|
|
12
|
-
- [width](FileMetadata.md#width)
|
|
13
|
-
- [height](FileMetadata.md#height)
|
|
14
|
-
- [category](FileMetadata.md#category)
|
|
15
|
-
- [hash](FileMetadata.md#hash)
|
|
16
|
-
- [uploadedBy](FileMetadata.md#uploadedby)
|
|
17
|
-
- [uploadedAt](FileMetadata.md#uploadedat)
|
|
18
|
-
- [tags](FileMetadata.md#tags)
|
|
19
|
-
- [customMetadata](FileMetadata.md#custommetadata)
|
|
20
|
-
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
### fileName
|
|
24
|
-
|
|
25
|
-
• **fileName**: `string`
|
|
26
|
-
|
|
27
|
-
#### Defined in
|
|
28
|
-
|
|
29
|
-
[packages/core/src/types/file-reference.ts:20](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L20)
|
|
30
|
-
|
|
31
|
-
___
|
|
32
|
-
|
|
33
|
-
### fileType
|
|
34
|
-
|
|
35
|
-
• **fileType**: `string`
|
|
36
|
-
|
|
37
|
-
#### Defined in
|
|
38
|
-
|
|
39
|
-
[packages/core/src/types/file-reference.ts:21](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L21)
|
|
40
|
-
|
|
41
|
-
___
|
|
42
|
-
|
|
43
|
-
### fileSize
|
|
44
|
-
|
|
45
|
-
• `Optional` **fileSize**: `number`
|
|
46
|
-
|
|
47
|
-
#### Defined in
|
|
48
|
-
|
|
49
|
-
[packages/core/src/types/file-reference.ts:22](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L22)
|
|
50
|
-
|
|
51
|
-
___
|
|
52
|
-
|
|
53
|
-
### width
|
|
54
|
-
|
|
55
|
-
• `Optional` **width**: `number`
|
|
56
|
-
|
|
57
|
-
#### Defined in
|
|
58
|
-
|
|
59
|
-
[packages/core/src/types/file-reference.ts:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L23)
|
|
60
|
-
|
|
61
|
-
___
|
|
62
|
-
|
|
63
|
-
### height
|
|
64
|
-
|
|
65
|
-
• `Optional` **height**: `number`
|
|
66
|
-
|
|
67
|
-
#### Defined in
|
|
68
|
-
|
|
69
|
-
[packages/core/src/types/file-reference.ts:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L24)
|
|
70
|
-
|
|
71
|
-
___
|
|
72
|
-
|
|
73
|
-
### category
|
|
74
|
-
|
|
75
|
-
• **category**: [`FileCategory`](../enums/FileCategory.md)
|
|
76
|
-
|
|
77
|
-
#### Defined in
|
|
78
|
-
|
|
79
|
-
[packages/core/src/types/file-reference.ts:25](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L25)
|
|
80
|
-
|
|
81
|
-
___
|
|
82
|
-
|
|
83
|
-
### hash
|
|
84
|
-
|
|
85
|
-
• `Optional` **hash**: `string`
|
|
86
|
-
|
|
87
|
-
#### Defined in
|
|
88
|
-
|
|
89
|
-
[packages/core/src/types/file-reference.ts:26](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L26)
|
|
90
|
-
|
|
91
|
-
___
|
|
92
|
-
|
|
93
|
-
### uploadedBy
|
|
94
|
-
|
|
95
|
-
• `Optional` **uploadedBy**: `string`
|
|
96
|
-
|
|
97
|
-
#### Defined in
|
|
98
|
-
|
|
99
|
-
[packages/core/src/types/file-reference.ts:27](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L27)
|
|
100
|
-
|
|
101
|
-
___
|
|
102
|
-
|
|
103
|
-
### uploadedAt
|
|
104
|
-
|
|
105
|
-
• `Optional` **uploadedAt**: `string`
|
|
106
|
-
|
|
107
|
-
#### Defined in
|
|
108
|
-
|
|
109
|
-
[packages/core/src/types/file-reference.ts:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L28)
|
|
110
|
-
|
|
111
|
-
___
|
|
112
|
-
|
|
113
|
-
### tags
|
|
114
|
-
|
|
115
|
-
• `Optional` **tags**: `string`[]
|
|
116
|
-
|
|
117
|
-
#### Defined in
|
|
118
|
-
|
|
119
|
-
[packages/core/src/types/file-reference.ts:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L29)
|
|
120
|
-
|
|
121
|
-
___
|
|
122
|
-
|
|
123
|
-
### customMetadata
|
|
124
|
-
|
|
125
|
-
• `Optional` **customMetadata**: `Record`\<`string`, `unknown`\>
|
|
126
|
-
|
|
127
|
-
#### Defined in
|
|
128
|
-
|
|
129
|
-
[packages/core/src/types/file-reference.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/file-reference.ts#L30)
|