@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.
Files changed (299) hide show
  1. package/CHANGELOG.md +45 -0
  2. package/cursor-rules/00-pace-core-compliance.mdc +34 -2
  3. package/dist/{AuthService-BPvc3Ka0.d.ts → AuthService-Cb34EQs3.d.ts} +9 -1
  4. package/dist/{DataTable-TPTKCX4D.js → DataTable-THFPBKTP.js} +9 -8
  5. package/dist/{PublicPageProvider-DC6kCaqf.d.ts → PublicPageProvider-DEMpysFR.d.ts} +45 -67
  6. package/dist/{UnifiedAuthProvider-CVcTjx-d.d.ts → UnifiedAuthProvider-CKvHP1MK.d.ts} +1 -8
  7. package/dist/{UnifiedAuthProvider-CH6Z342H.js → UnifiedAuthProvider-KAGUYQ4J.js} +5 -4
  8. package/dist/{api-MVVQZLJI.js → api-IAGWF3ZG.js} +10 -10
  9. package/dist/{audit-B5P6FFIR.js → audit-V53FV5AG.js} +2 -2
  10. package/dist/{chunk-SFZUDBL5.js → chunk-2T2IG7T7.js} +70 -56
  11. package/dist/chunk-2T2IG7T7.js.map +1 -0
  12. package/dist/{chunk-MMZ7JXPU.js → chunk-6Z7LTB3D.js} +13 -21
  13. package/dist/{chunk-MMZ7JXPU.js.map → chunk-6Z7LTB3D.js.map} +1 -1
  14. package/dist/{chunk-6J4GEEJR.js → chunk-CNCQDFLN.js} +53 -27
  15. package/dist/chunk-CNCQDFLN.js.map +1 -0
  16. package/dist/chunk-DGUM43GV.js +11 -0
  17. package/dist/{chunk-EHMR7VYL.js → chunk-DWUBLJJM.js} +361 -187
  18. package/dist/chunk-DWUBLJJM.js.map +1 -0
  19. package/dist/{chunk-2UOI2FG5.js → chunk-HFZBI76P.js} +4 -4
  20. package/dist/{chunk-F2IMUDXZ.js → chunk-M7MPQISP.js} +2 -2
  21. package/dist/{chunk-3XC4CPTD.js → chunk-PQBSKX33.js} +244 -5727
  22. package/dist/chunk-PQBSKX33.js.map +1 -0
  23. package/dist/chunk-QRPVRXYT.js +226 -0
  24. package/dist/chunk-QRPVRXYT.js.map +1 -0
  25. package/dist/{chunk-24UVZUZG.js → chunk-RWEBCB47.js} +129 -387
  26. package/dist/chunk-RWEBCB47.js.map +1 -0
  27. package/dist/{chunk-XWQCNGTQ.js → chunk-YDQHOZNA.js} +173 -79
  28. package/dist/chunk-YDQHOZNA.js.map +1 -0
  29. package/dist/{chunk-NECFR5MM.js → chunk-ZNIWI3UC.js} +562 -644
  30. package/dist/chunk-ZNIWI3UC.js.map +1 -0
  31. package/dist/components.d.ts +2 -2
  32. package/dist/components.js +12 -13
  33. package/dist/contextValidator-3JNZKUTX.js +9 -0
  34. package/dist/contextValidator-3JNZKUTX.js.map +1 -0
  35. package/dist/eslint-rules/pace-core-compliance.cjs +106 -0
  36. package/dist/hooks.d.ts +2 -2
  37. package/dist/hooks.js +7 -6
  38. package/dist/hooks.js.map +1 -1
  39. package/dist/index.d.ts +7 -7
  40. package/dist/index.js +21 -16
  41. package/dist/index.js.map +1 -1
  42. package/dist/providers.d.ts +3 -3
  43. package/dist/providers.js +4 -3
  44. package/dist/rbac/index.d.ts +67 -27
  45. package/dist/rbac/index.js +15 -8
  46. package/dist/styles/index.js +1 -1
  47. package/dist/theming/runtime.js +1 -1
  48. package/dist/types.js +1 -1
  49. package/dist/{usePublicRouteParams-1oMokgLF.d.ts → usePublicRouteParams-i3qtoBgg.d.ts} +7 -16
  50. package/dist/utils.js +5 -7
  51. package/dist/utils.js.map +1 -1
  52. package/docs/api/README.md +14 -16
  53. package/docs/api/modules.md +3796 -2513
  54. package/docs/components/context-selector.md +126 -0
  55. package/docs/migration/RBAC_SCOPE_MIGRATION.md +385 -0
  56. package/docs/pace-mint-fix-auto-selection.md +218 -0
  57. package/docs/pace-mint-rbac-setup.md +391 -0
  58. package/docs/rbac/secure-client-protection.md +330 -0
  59. package/package.json +3 -3
  60. package/scripts/audit/core/checks/compliance.cjs +72 -0
  61. package/scripts/audit/core/checks/dependencies.cjs +559 -28
  62. package/scripts/audit/core/checks/documentation.cjs +68 -3
  63. package/scripts/audit/core/checks/environment.cjs +2 -14
  64. package/scripts/audit/core/checks/error-handling.cjs +47 -6
  65. package/src/components/ContextSelector/ContextSelector.tsx +384 -0
  66. package/src/components/ContextSelector/index.ts +3 -0
  67. package/src/components/DataTable/components/RowComponent.tsx +19 -19
  68. package/src/components/DataTable/components/UnifiedTableBody.tsx +2 -2
  69. package/src/components/DataTable/hooks/useDataTablePermissions.ts +8 -6
  70. package/src/components/Dialog/Dialog.tsx +29 -1
  71. package/src/components/FileDisplay/FileDisplay.tsx +42 -10
  72. package/src/components/Header/Header.test.tsx +43 -73
  73. package/src/components/Header/Header.tsx +44 -45
  74. package/src/components/PaceAppLayout/PaceAppLayout.integration.test.tsx +10 -19
  75. package/src/components/PaceAppLayout/PaceAppLayout.performance.test.tsx +2 -2
  76. package/src/components/PaceAppLayout/PaceAppLayout.security.test.tsx +5 -5
  77. package/src/components/PaceAppLayout/PaceAppLayout.test.tsx +9 -9
  78. package/src/components/PaceAppLayout/PaceAppLayout.tsx +135 -33
  79. package/src/components/PaceAppLayout/README.md +14 -17
  80. package/src/components/PaceAppLayout/test-setup.tsx +2 -2
  81. package/src/components/index.ts +5 -5
  82. package/src/eslint-rules/pace-core-compliance.cjs +106 -0
  83. package/src/hooks/__tests__/useAppConfig.unit.test.ts +4 -98
  84. package/src/hooks/useAppConfig.ts +15 -30
  85. package/src/hooks/useFileDisplay.ts +77 -50
  86. package/src/index.ts +4 -5
  87. package/src/providers/services/AuthServiceProvider.tsx +17 -7
  88. package/src/providers/services/EventServiceProvider.tsx +33 -5
  89. package/src/providers/services/UnifiedAuthProvider.tsx +90 -134
  90. package/src/rbac/__tests__/adapters.comprehensive.test.tsx +1 -1
  91. package/src/rbac/adapters.tsx +2 -2
  92. package/src/rbac/api.test.ts +59 -51
  93. package/src/rbac/api.ts +178 -132
  94. package/src/rbac/components/PagePermissionGuard.tsx +38 -10
  95. package/src/rbac/hooks/__tests__/useSecureSupabase.test.ts +32 -21
  96. package/src/rbac/hooks/permissions/useAccessLevel.ts +1 -1
  97. package/src/rbac/hooks/permissions/useCan.ts +41 -11
  98. package/src/rbac/hooks/permissions/useHasAllPermissions.ts +1 -1
  99. package/src/rbac/hooks/permissions/useHasAnyPermission.ts +1 -1
  100. package/src/rbac/hooks/permissions/useMultiplePermissions.ts +1 -1
  101. package/src/rbac/hooks/useCan.test.ts +0 -9
  102. package/src/rbac/hooks/useRBAC.test.ts +1 -5
  103. package/src/rbac/hooks/useRBAC.ts +36 -37
  104. package/src/rbac/hooks/useResolvedScope.test.ts +120 -35
  105. package/src/rbac/hooks/useResolvedScope.ts +35 -40
  106. package/src/rbac/hooks/useSecureSupabase.ts +7 -7
  107. package/src/rbac/index.ts +7 -0
  108. package/src/rbac/secureClient.test.ts +22 -18
  109. package/src/rbac/secureClient.ts +103 -16
  110. package/src/rbac/security.ts +0 -17
  111. package/src/rbac/types.ts +1 -0
  112. package/src/rbac/utils/__tests__/contextValidator.test.ts +64 -86
  113. package/src/rbac/utils/clientSecurity.ts +93 -0
  114. package/src/rbac/utils/contextValidator.ts +77 -168
  115. package/src/services/AuthService.ts +39 -7
  116. package/src/services/EventService.ts +186 -54
  117. package/src/services/OrganisationService.ts +81 -14
  118. package/src/services/__tests__/EventService.test.ts +1 -2
  119. package/src/services/base/BaseService.ts +3 -0
  120. package/src/utils/dynamic/dynamicUtils.ts +7 -4
  121. package/dist/chunk-24UVZUZG.js.map +0 -1
  122. package/dist/chunk-3XC4CPTD.js.map +0 -1
  123. package/dist/chunk-6J4GEEJR.js.map +0 -1
  124. package/dist/chunk-7D4SUZUM.js +0 -38
  125. package/dist/chunk-EHMR7VYL.js.map +0 -1
  126. package/dist/chunk-NECFR5MM.js.map +0 -1
  127. package/dist/chunk-SFZUDBL5.js.map +0 -1
  128. package/dist/chunk-XWQCNGTQ.js.map +0 -1
  129. package/docs/api/classes/ColumnFactory.md +0 -243
  130. package/docs/api/classes/InvalidScopeError.md +0 -73
  131. package/docs/api/classes/Logger.md +0 -178
  132. package/docs/api/classes/MissingUserContextError.md +0 -66
  133. package/docs/api/classes/OrganisationContextRequiredError.md +0 -66
  134. package/docs/api/classes/PermissionDeniedError.md +0 -73
  135. package/docs/api/classes/RBACAuditManager.md +0 -297
  136. package/docs/api/classes/RBACCache.md +0 -322
  137. package/docs/api/classes/RBACEngine.md +0 -171
  138. package/docs/api/classes/RBACError.md +0 -76
  139. package/docs/api/classes/RBACNotInitializedError.md +0 -66
  140. package/docs/api/classes/SecureSupabaseClient.md +0 -163
  141. package/docs/api/classes/StorageUtils.md +0 -328
  142. package/docs/api/enums/FileCategory.md +0 -184
  143. package/docs/api/enums/LogLevel.md +0 -54
  144. package/docs/api/enums/RBACErrorCode.md +0 -228
  145. package/docs/api/enums/RPCFunction.md +0 -118
  146. package/docs/api/interfaces/AddressFieldProps.md +0 -241
  147. package/docs/api/interfaces/AddressFieldRef.md +0 -94
  148. package/docs/api/interfaces/AggregateConfig.md +0 -43
  149. package/docs/api/interfaces/AutocompleteOptions.md +0 -75
  150. package/docs/api/interfaces/AvatarProps.md +0 -128
  151. package/docs/api/interfaces/BadgeProps.md +0 -34
  152. package/docs/api/interfaces/ButtonProps.md +0 -56
  153. package/docs/api/interfaces/CalendarProps.md +0 -73
  154. package/docs/api/interfaces/CardProps.md +0 -69
  155. package/docs/api/interfaces/ColorPalette.md +0 -7
  156. package/docs/api/interfaces/ColorShade.md +0 -66
  157. package/docs/api/interfaces/ComplianceResult.md +0 -30
  158. package/docs/api/interfaces/DataAccessRecord.md +0 -96
  159. package/docs/api/interfaces/DataRecord.md +0 -11
  160. package/docs/api/interfaces/DataTableAction.md +0 -252
  161. package/docs/api/interfaces/DataTableColumn.md +0 -504
  162. package/docs/api/interfaces/DataTableProps.md +0 -625
  163. package/docs/api/interfaces/DataTableToolbarButton.md +0 -96
  164. package/docs/api/interfaces/DatabaseComplianceResult.md +0 -85
  165. package/docs/api/interfaces/DatabaseIssue.md +0 -41
  166. package/docs/api/interfaces/EmptyStateConfig.md +0 -61
  167. package/docs/api/interfaces/EnhancedNavigationMenuProps.md +0 -235
  168. package/docs/api/interfaces/ErrorBoundaryProps.md +0 -147
  169. package/docs/api/interfaces/ErrorBoundaryProviderProps.md +0 -36
  170. package/docs/api/interfaces/ErrorBoundaryState.md +0 -75
  171. package/docs/api/interfaces/EventAppRoleData.md +0 -71
  172. package/docs/api/interfaces/ExportColumn.md +0 -90
  173. package/docs/api/interfaces/ExportOptions.md +0 -126
  174. package/docs/api/interfaces/FileDisplayProps.md +0 -249
  175. package/docs/api/interfaces/FileMetadata.md +0 -129
  176. package/docs/api/interfaces/FileReference.md +0 -118
  177. package/docs/api/interfaces/FileSizeLimits.md +0 -7
  178. package/docs/api/interfaces/FileUploadOptions.md +0 -139
  179. package/docs/api/interfaces/FileUploadProps.md +0 -296
  180. package/docs/api/interfaces/FooterProps.md +0 -107
  181. package/docs/api/interfaces/FormFieldProps.md +0 -166
  182. package/docs/api/interfaces/FormProps.md +0 -113
  183. package/docs/api/interfaces/GrantEventAppRoleParams.md +0 -122
  184. package/docs/api/interfaces/InactivityWarningModalProps.md +0 -115
  185. package/docs/api/interfaces/InputProps.md +0 -56
  186. package/docs/api/interfaces/LabelProps.md +0 -107
  187. package/docs/api/interfaces/LoggerConfig.md +0 -62
  188. package/docs/api/interfaces/LoginFormProps.md +0 -187
  189. package/docs/api/interfaces/NavigationAccessRecord.md +0 -107
  190. package/docs/api/interfaces/NavigationContextType.md +0 -164
  191. package/docs/api/interfaces/NavigationGuardProps.md +0 -139
  192. package/docs/api/interfaces/NavigationItem.md +0 -120
  193. package/docs/api/interfaces/NavigationMenuProps.md +0 -221
  194. package/docs/api/interfaces/NavigationProviderProps.md +0 -117
  195. package/docs/api/interfaces/Organisation.md +0 -140
  196. package/docs/api/interfaces/OrganisationContextType.md +0 -388
  197. package/docs/api/interfaces/OrganisationMembership.md +0 -140
  198. package/docs/api/interfaces/OrganisationProviderProps.md +0 -76
  199. package/docs/api/interfaces/OrganisationSecurityError.md +0 -62
  200. package/docs/api/interfaces/PaceAppLayoutProps.md +0 -409
  201. package/docs/api/interfaces/PaceLoginPageProps.md +0 -49
  202. package/docs/api/interfaces/PageAccessRecord.md +0 -85
  203. package/docs/api/interfaces/PagePermissionContextType.md +0 -140
  204. package/docs/api/interfaces/PagePermissionGuardProps.md +0 -153
  205. package/docs/api/interfaces/PagePermissionProviderProps.md +0 -119
  206. package/docs/api/interfaces/PaletteData.md +0 -41
  207. package/docs/api/interfaces/ParsedAddress.md +0 -120
  208. package/docs/api/interfaces/PermissionEnforcerProps.md +0 -153
  209. package/docs/api/interfaces/ProgressProps.md +0 -42
  210. package/docs/api/interfaces/ProtectedRouteProps.md +0 -78
  211. package/docs/api/interfaces/PublicPageFooterProps.md +0 -112
  212. package/docs/api/interfaces/PublicPageHeaderProps.md +0 -125
  213. package/docs/api/interfaces/PublicPageLayoutProps.md +0 -185
  214. package/docs/api/interfaces/QuickFix.md +0 -52
  215. package/docs/api/interfaces/RBACAccessValidateParams.md +0 -52
  216. package/docs/api/interfaces/RBACAccessValidateResult.md +0 -41
  217. package/docs/api/interfaces/RBACAuditLogParams.md +0 -85
  218. package/docs/api/interfaces/RBACAuditLogResult.md +0 -52
  219. package/docs/api/interfaces/RBACConfig.md +0 -133
  220. package/docs/api/interfaces/RBACContext.md +0 -52
  221. package/docs/api/interfaces/RBACLogger.md +0 -112
  222. package/docs/api/interfaces/RBACPageAccessCheckParams.md +0 -74
  223. package/docs/api/interfaces/RBACPerformanceMetrics.md +0 -138
  224. package/docs/api/interfaces/RBACPermissionCheckParams.md +0 -74
  225. package/docs/api/interfaces/RBACPermissionCheckResult.md +0 -52
  226. package/docs/api/interfaces/RBACPermissionsGetParams.md +0 -63
  227. package/docs/api/interfaces/RBACPermissionsGetResult.md +0 -63
  228. package/docs/api/interfaces/RBACResult.md +0 -58
  229. package/docs/api/interfaces/RBACRoleGrantParams.md +0 -63
  230. package/docs/api/interfaces/RBACRoleGrantResult.md +0 -52
  231. package/docs/api/interfaces/RBACRoleRevokeParams.md +0 -63
  232. package/docs/api/interfaces/RBACRoleRevokeResult.md +0 -52
  233. package/docs/api/interfaces/RBACRoleValidateParams.md +0 -52
  234. package/docs/api/interfaces/RBACRoleValidateResult.md +0 -63
  235. package/docs/api/interfaces/RBACRolesListParams.md +0 -52
  236. package/docs/api/interfaces/RBACRolesListResult.md +0 -74
  237. package/docs/api/interfaces/RBACSessionTrackParams.md +0 -74
  238. package/docs/api/interfaces/RBACSessionTrackResult.md +0 -52
  239. package/docs/api/interfaces/ResourcePermissions.md +0 -155
  240. package/docs/api/interfaces/RevokeEventAppRoleParams.md +0 -100
  241. package/docs/api/interfaces/RoleBasedRouterContextType.md +0 -151
  242. package/docs/api/interfaces/RoleBasedRouterProps.md +0 -156
  243. package/docs/api/interfaces/RoleManagementResult.md +0 -52
  244. package/docs/api/interfaces/RouteAccessRecord.md +0 -107
  245. package/docs/api/interfaces/RouteConfig.md +0 -134
  246. package/docs/api/interfaces/RuntimeComplianceResult.md +0 -55
  247. package/docs/api/interfaces/SecureDataContextType.md +0 -168
  248. package/docs/api/interfaces/SecureDataProviderProps.md +0 -132
  249. package/docs/api/interfaces/SessionRestorationLoaderProps.md +0 -34
  250. package/docs/api/interfaces/SetupIssue.md +0 -41
  251. package/docs/api/interfaces/StorageConfig.md +0 -41
  252. package/docs/api/interfaces/StorageFileInfo.md +0 -74
  253. package/docs/api/interfaces/StorageFileMetadata.md +0 -151
  254. package/docs/api/interfaces/StorageListOptions.md +0 -99
  255. package/docs/api/interfaces/StorageListResult.md +0 -41
  256. package/docs/api/interfaces/StorageUploadOptions.md +0 -101
  257. package/docs/api/interfaces/StorageUploadResult.md +0 -63
  258. package/docs/api/interfaces/StorageUrlOptions.md +0 -60
  259. package/docs/api/interfaces/StyleImport.md +0 -19
  260. package/docs/api/interfaces/SwitchProps.md +0 -34
  261. package/docs/api/interfaces/TabsContentProps.md +0 -9
  262. package/docs/api/interfaces/TabsListProps.md +0 -9
  263. package/docs/api/interfaces/TabsProps.md +0 -9
  264. package/docs/api/interfaces/TabsTriggerProps.md +0 -50
  265. package/docs/api/interfaces/TextareaProps.md +0 -53
  266. package/docs/api/interfaces/ToastActionElement.md +0 -12
  267. package/docs/api/interfaces/ToastProps.md +0 -9
  268. package/docs/api/interfaces/UnifiedAuthContextType.md +0 -823
  269. package/docs/api/interfaces/UnifiedAuthProviderProps.md +0 -173
  270. package/docs/api/interfaces/UseFormDialogOptions.md +0 -62
  271. package/docs/api/interfaces/UseFormDialogReturn.md +0 -117
  272. package/docs/api/interfaces/UseInactivityTrackerOptions.md +0 -138
  273. package/docs/api/interfaces/UseInactivityTrackerReturn.md +0 -123
  274. package/docs/api/interfaces/UsePublicEventLogoOptions.md +0 -87
  275. package/docs/api/interfaces/UsePublicEventLogoReturn.md +0 -84
  276. package/docs/api/interfaces/UsePublicEventOptions.md +0 -34
  277. package/docs/api/interfaces/UsePublicEventReturn.md +0 -71
  278. package/docs/api/interfaces/UsePublicFileDisplayOptions.md +0 -47
  279. package/docs/api/interfaces/UsePublicFileDisplayReturn.md +0 -123
  280. package/docs/api/interfaces/UsePublicRouteParamsReturn.md +0 -97
  281. package/docs/api/interfaces/UseResolvedScopeOptions.md +0 -47
  282. package/docs/api/interfaces/UseResolvedScopeReturn.md +0 -47
  283. package/docs/api/interfaces/UseResourcePermissionsOptions.md +0 -34
  284. package/docs/api/interfaces/UserEventAccess.md +0 -121
  285. package/docs/api/interfaces/UserMenuProps.md +0 -88
  286. package/docs/api/interfaces/UserProfile.md +0 -63
  287. package/src/components/EventSelector/EventSelector.test.tsx +0 -720
  288. package/src/components/EventSelector/EventSelector.tsx +0 -423
  289. package/src/components/EventSelector/index.ts +0 -3
  290. package/src/components/OrganisationSelector/OrganisationSelector.test.tsx +0 -784
  291. package/src/components/OrganisationSelector/OrganisationSelector.tsx +0 -327
  292. package/src/components/OrganisationSelector/index.ts +0 -9
  293. /package/dist/{DataTable-TPTKCX4D.js.map → DataTable-THFPBKTP.js.map} +0 -0
  294. /package/dist/{UnifiedAuthProvider-CH6Z342H.js.map → UnifiedAuthProvider-KAGUYQ4J.js.map} +0 -0
  295. /package/dist/{api-MVVQZLJI.js.map → api-IAGWF3ZG.js.map} +0 -0
  296. /package/dist/{audit-B5P6FFIR.js.map → audit-V53FV5AG.js.map} +0 -0
  297. /package/dist/{chunk-7D4SUZUM.js.map → chunk-DGUM43GV.js.map} +0 -0
  298. /package/dist/{chunk-2UOI2FG5.js.map → chunk-HFZBI76P.js.map} +0 -0
  299. /package/dist/{chunk-F2IMUDXZ.js.map → chunk-M7MPQISP.js.map} +0 -0
package/docs/api/interfaces/OrganisationContextType.md DELETED
@@ -1,388 +0,0 @@
1
- [@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / OrganisationContextType
2
-
3
- # Interface: OrganisationContextType
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [selectedOrganisation](OrganisationContextType.md#selectedorganisation)
10
- - [organisations](OrganisationContextType.md#organisations)
11
- - [userMemberships](OrganisationContextType.md#usermemberships)
12
- - [isLoading](OrganisationContextType.md#isloading)
13
- - [error](OrganisationContextType.md#error)
14
- - [hasValidOrganisationContext](OrganisationContextType.md#hasvalidorganisationcontext)
15
- - [isContextReady](OrganisationContextType.md#iscontextready)
16
- - [setSelectedOrganisation](OrganisationContextType.md#setselectedorganisation)
17
- - [switchOrganisation](OrganisationContextType.md#switchorganisation)
18
- - [getUserRole](OrganisationContextType.md#getuserrole)
19
- - [validateOrganisationAccess](OrganisationContextType.md#validateorganisationaccess)
20
- - [ensureOrganisationContext](OrganisationContextType.md#ensureorganisationcontext)
21
- - [refreshOrganisations](OrganisationContextType.md#refreshorganisations)
22
- - [getPrimaryOrganisation](OrganisationContextType.md#getprimaryorganisation)
23
- - [isOrganisationSecure](OrganisationContextType.md#isorganisationsecure)
24
- - [getOrganisationHierarchy](OrganisationContextType.md#getorganisationhierarchy)
25
- - [canAccessChildOrganisations](OrganisationContextType.md#canaccesschildorganisations)
26
- - [validateUserAccess](OrganisationContextType.md#validateuseraccess)
27
- - [getUserPermissions](OrganisationContextType.md#getuserpermissions)
28
- - [logOrganisationAccess](OrganisationContextType.md#logorganisationaccess)
29
-
30
- ## Properties
31
-
32
- ### selectedOrganisation
33
-
34
- • **selectedOrganisation**: ``null`` \| [`Organisation`](Organisation.md)
35
-
36
- #### Defined in
37
-
38
- [packages/core/src/types/organisation.ts:110](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L110)
39
-
40
- ___
41
-
42
- ### organisations
43
-
44
- • **organisations**: [`Organisation`](Organisation.md)[]
45
-
46
- #### Defined in
47
-
48
- [packages/core/src/types/organisation.ts:111](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L111)
49
-
50
- ___
51
-
52
- ### userMemberships
53
-
54
- • **userMemberships**: [`OrganisationMembership`](OrganisationMembership.md)[]
55
-
56
- #### Defined in
57
-
58
- [packages/core/src/types/organisation.ts:112](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L112)
59
-
60
- ___
61
-
62
- ### isLoading
63
-
64
- • **isLoading**: `boolean`
65
-
66
- #### Defined in
67
-
68
- [packages/core/src/types/organisation.ts:115](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L115)
69
-
70
- ___
71
-
72
- ### error
73
-
74
- • **error**: ``null`` \| `Error`
75
-
76
- #### Defined in
77
-
78
- [packages/core/src/types/organisation.ts:116](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L116)
79
-
80
- ___
81
-
82
- ### hasValidOrganisationContext
83
-
84
- • **hasValidOrganisationContext**: `boolean`
85
-
86
- #### Defined in
87
-
88
- [packages/core/src/types/organisation.ts:117](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L117)
89
-
90
- ___
91
-
92
- ### isContextReady
93
-
94
- • **isContextReady**: `boolean`
95
-
96
- #### Defined in
97
-
98
- [packages/core/src/types/organisation.ts:118](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L118)
99
-
100
- ___
101
-
102
- ### setSelectedOrganisation
103
-
104
- • **setSelectedOrganisation**: (`org`: ``null`` \| [`Organisation`](Organisation.md)) => `void`
105
-
106
- #### Type declaration
107
-
108
- ▸ (`org`): `void`
109
-
110
- ##### Parameters
111
-
112
- | Name | Type |
113
- | :------ | :------ |
114
- | `org` | ``null`` \| [`Organisation`](Organisation.md) |
115
-
116
- ##### Returns
117
-
118
- `void`
119
-
120
- #### Defined in
121
-
122
- [packages/core/src/types/organisation.ts:121](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L121)
123
-
124
- ___
125
-
126
- ### switchOrganisation
127
-
128
- • **switchOrganisation**: (`orgId`: `string`) => `Promise`\<`void`\>
129
-
130
- #### Type declaration
131
-
132
- ▸ (`orgId`): `Promise`\<`void`\>
133
-
134
- ##### Parameters
135
-
136
- | Name | Type |
137
- | :------ | :------ |
138
- | `orgId` | `string` |
139
-
140
- ##### Returns
141
-
142
- `Promise`\<`void`\>
143
-
144
- #### Defined in
145
-
146
- [packages/core/src/types/organisation.ts:122](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L122)
147
-
148
- ___
149
-
150
- ### getUserRole
151
-
152
- • **getUserRole**: (`orgId?`: `string`) => `string`
153
-
154
- #### Type declaration
155
-
156
- ▸ (`orgId?`): `string`
157
-
158
- ##### Parameters
159
-
160
- | Name | Type |
161
- | :------ | :------ |
162
- | `orgId?` | `string` |
163
-
164
- ##### Returns
165
-
166
- `string`
167
-
168
- #### Defined in
169
-
170
- [packages/core/src/types/organisation.ts:125](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L125)
171
-
172
- ___
173
-
174
- ### validateOrganisationAccess
175
-
176
- • **validateOrganisationAccess**: (`orgId`: `string`) => `boolean`
177
-
178
- #### Type declaration
179
-
180
- ▸ (`orgId`): `boolean`
181
-
182
- ##### Parameters
183
-
184
- | Name | Type |
185
- | :------ | :------ |
186
- | `orgId` | `string` |
187
-
188
- ##### Returns
189
-
190
- `boolean`
191
-
192
- #### Defined in
193
-
194
- [packages/core/src/types/organisation.ts:126](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L126)
195
-
196
- ___
197
-
198
- ### ensureOrganisationContext
199
-
200
- • **ensureOrganisationContext**: () => [`Organisation`](Organisation.md)
201
-
202
- #### Type declaration
203
-
204
- ▸ (): [`Organisation`](Organisation.md)
205
-
206
- ##### Returns
207
-
208
- [`Organisation`](Organisation.md)
209
-
210
- #### Defined in
211
-
212
- [packages/core/src/types/organisation.ts:127](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L127)
213
-
214
- ___
215
-
216
- ### refreshOrganisations
217
-
218
- • **refreshOrganisations**: () => `Promise`\<`void`\>
219
-
220
- #### Type declaration
221
-
222
- ▸ (): `Promise`\<`void`\>
223
-
224
- ##### Returns
225
-
226
- `Promise`\<`void`\>
227
-
228
- #### Defined in
229
-
230
- [packages/core/src/types/organisation.ts:130](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L130)
231
-
232
- ___
233
-
234
- ### getPrimaryOrganisation
235
-
236
- • **getPrimaryOrganisation**: () => ``null`` \| [`Organisation`](Organisation.md)
237
-
238
- #### Type declaration
239
-
240
- ▸ (): ``null`` \| [`Organisation`](Organisation.md)
241
-
242
- ##### Returns
243
-
244
- ``null`` \| [`Organisation`](Organisation.md)
245
-
246
- #### Defined in
247
-
248
- [packages/core/src/types/organisation.ts:131](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L131)
249
-
250
- ___
251
-
252
- ### isOrganisationSecure
253
-
254
- • **isOrganisationSecure**: () => `boolean`
255
-
256
- #### Type declaration
257
-
258
- ▸ (): `boolean`
259
-
260
- ##### Returns
261
-
262
- `boolean`
263
-
264
- #### Defined in
265
-
266
- [packages/core/src/types/organisation.ts:132](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L132)
267
-
268
- ___
269
-
270
- ### getOrganisationHierarchy
271
-
272
- • `Optional` **getOrganisationHierarchy**: (`orgId`: `string`) => `Promise`\<`OrganisationHierarchy`[]\>
273
-
274
- #### Type declaration
275
-
276
- ▸ (`orgId`): `Promise`\<`OrganisationHierarchy`[]\>
277
-
278
- ##### Parameters
279
-
280
- | Name | Type |
281
- | :------ | :------ |
282
- | `orgId` | `string` |
283
-
284
- ##### Returns
285
-
286
- `Promise`\<`OrganisationHierarchy`[]\>
287
-
288
- #### Defined in
289
-
290
- [packages/core/src/types/organisation.ts:135](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L135)
291
-
292
- ___
293
-
294
- ### canAccessChildOrganisations
295
-
296
- • `Optional` **canAccessChildOrganisations**: (`orgId`: `string`) => `boolean`
297
-
298
- #### Type declaration
299
-
300
- ▸ (`orgId`): `boolean`
301
-
302
- ##### Parameters
303
-
304
- | Name | Type |
305
- | :------ | :------ |
306
- | `orgId` | `string` |
307
-
308
- ##### Returns
309
-
310
- `boolean`
311
-
312
- #### Defined in
313
-
314
- [packages/core/src/types/organisation.ts:136](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L136)
315
-
316
- ___
317
-
318
- ### validateUserAccess
319
-
320
- • `Optional` **validateUserAccess**: (`userId`: `string`, `orgId`: `string`) => `Promise`\<`boolean`\>
321
-
322
- #### Type declaration
323
-
324
- ▸ (`userId`, `orgId`): `Promise`\<`boolean`\>
325
-
326
- ##### Parameters
327
-
328
- | Name | Type |
329
- | :------ | :------ |
330
- | `userId` | `string` |
331
- | `orgId` | `string` |
332
-
333
- ##### Returns
334
-
335
- `Promise`\<`boolean`\>
336
-
337
- #### Defined in
338
-
339
- [packages/core/src/types/organisation.ts:137](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L137)
340
-
341
- ___
342
-
343
- ### getUserPermissions
344
-
345
- • `Optional` **getUserPermissions**: (`orgId?`: `string`) => `Promise`\<`string`[]\>
346
-
347
- #### Type declaration
348
-
349
- ▸ (`orgId?`): `Promise`\<`string`[]\>
350
-
351
- ##### Parameters
352
-
353
- | Name | Type |
354
- | :------ | :------ |
355
- | `orgId?` | `string` |
356
-
357
- ##### Returns
358
-
359
- `Promise`\<`string`[]\>
360
-
361
- #### Defined in
362
-
363
- [packages/core/src/types/organisation.ts:138](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L138)
364
-
365
- ___
366
-
367
- ### logOrganisationAccess
368
-
369
- • `Optional` **logOrganisationAccess**: (`action`: `string`, `details?`: `unknown`) => `Promise`\<`void`\>
370
-
371
- #### Type declaration
372
-
373
- ▸ (`action`, `details?`): `Promise`\<`void`\>
374
-
375
- ##### Parameters
376
-
377
- | Name | Type |
378
- | :------ | :------ |
379
- | `action` | `string` |
380
- | `details?` | `unknown` |
381
-
382
- ##### Returns
383
-
384
- `Promise`\<`void`\>
385
-
386
- #### Defined in
387
-
388
- [packages/core/src/types/organisation.ts:139](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L139)
package/docs/api/interfaces/OrganisationMembership.md DELETED
@@ -1,140 +0,0 @@
1
- [@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / OrganisationMembership
2
-
3
- # Interface: OrganisationMembership
4
-
5
- ## Table of contents
6
-
7
- ### Properties
8
-
9
- - [id](OrganisationMembership.md#id)
10
- - [user\_id](OrganisationMembership.md#user_id)
11
- - [organisation\_id](OrganisationMembership.md#organisation_id)
12
- - [role](OrganisationMembership.md#role)
13
- - [status](OrganisationMembership.md#status)
14
- - [granted\_at](OrganisationMembership.md#granted_at)
15
- - [granted\_by](OrganisationMembership.md#granted_by)
16
- - [revoked\_at](OrganisationMembership.md#revoked_at)
17
- - [revoked\_by](OrganisationMembership.md#revoked_by)
18
- - [notes](OrganisationMembership.md#notes)
19
- - [created\_at](OrganisationMembership.md#created_at)
20
- - [updated\_at](OrganisationMembership.md#updated_at)
21
-
22
- ## Properties
23
-
24
- ### id
25
-
26
- • **id**: `string`
27
-
28
- #### Defined in
29
-
30
- [packages/core/src/types/organisation.ts:28](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L28)
31
-
32
- ___
33
-
34
- ### user\_id
35
-
36
- • **user\_id**: `UserId`
37
-
38
- #### Defined in
39
-
40
- [packages/core/src/types/organisation.ts:29](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L29)
41
-
42
- ___
43
-
44
- ### organisation\_id
45
-
46
- • **organisation\_id**: `OrganisationId`
47
-
48
- #### Defined in
49
-
50
- [packages/core/src/types/organisation.ts:30](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L30)
51
-
52
- ___
53
-
54
- ### role
55
-
56
- • **role**: ``"org_admin"`` \| ``"leader"`` \| ``"member"`` \| ``"supporter"``
57
-
58
- #### Defined in
59
-
60
- [packages/core/src/types/organisation.ts:31](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L31)
61
-
62
- ___
63
-
64
- ### status
65
-
66
- • **status**: ``"active"`` \| ``"inactive"`` \| ``"suspended"``
67
-
68
- #### Defined in
69
-
70
- [packages/core/src/types/organisation.ts:32](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L32)
71
-
72
- ___
73
-
74
- ### granted\_at
75
-
76
- • **granted\_at**: `string`
77
-
78
- #### Defined in
79
-
80
- [packages/core/src/types/organisation.ts:33](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L33)
81
-
82
- ___
83
-
84
- ### granted\_by
85
-
86
- • `Optional` **granted\_by**: `string`
87
-
88
- #### Defined in
89
-
90
- [packages/core/src/types/organisation.ts:34](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L34)
91
-
92
- ___
93
-
94
- ### revoked\_at
95
-
96
- • `Optional` **revoked\_at**: `string`
97
-
98
- #### Defined in
99
-
100
- [packages/core/src/types/organisation.ts:35](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L35)
101
-
102
- ___
103
-
104
- ### revoked\_by
105
-
106
- • `Optional` **revoked\_by**: `string`
107
-
108
- #### Defined in
109
-
110
- [packages/core/src/types/organisation.ts:36](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L36)
111
-
112
- ___
113
-
114
- ### notes
115
-
116
- • `Optional` **notes**: `string`
117
-
118
- #### Defined in
119
-
120
- [packages/core/src/types/organisation.ts:37](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L37)
121
-
122
- ___
123
-
124
- ### created\_at
125
-
126
- • **created\_at**: `string`
127
-
128
- #### Defined in
129
-
130
- [packages/core/src/types/organisation.ts:38](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L38)
131
-
132
- ___
133
-
134
- ### updated\_at
135
-
136
- • **updated\_at**: `string`
137
-
138
- #### Defined in
139
-
140
- [packages/core/src/types/organisation.ts:39](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L39)
package/docs/api/interfaces/OrganisationProviderProps.md DELETED
@@ -1,76 +0,0 @@
1
- [@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / OrganisationProviderProps
2
-
3
- # Interface: OrganisationProviderProps
4
-
5
- ## Hierarchy
6
-
7
- - `OrganisationProviderProps`
8
-
9
- ↳ **`OrganisationProviderProps`**
10
-
11
- ## Table of contents
12
-
13
- ### Properties
14
-
15
- - [children](OrganisationProviderProps.md#children)
16
- - [requireOrganisationContext](OrganisationProviderProps.md#requireorganisationcontext)
17
- - [autoSelectPrimaryOrganisation](OrganisationProviderProps.md#autoselectprimaryorganisation)
18
- - [onOrganisationChange](OrganisationProviderProps.md#onorganisationchange)
19
-
20
- ## Properties
21
-
22
- ### children
23
-
24
- • **children**: `ReactNode`
25
-
26
- #### Overrides
27
-
28
- BaseOrganisationProviderProps.children
29
-
30
- #### Defined in
31
-
32
- [packages/core/src/providers/OrganisationProvider.tsx:22](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/OrganisationProvider.tsx#L22)
33
-
34
- ___
35
-
36
- ### requireOrganisationContext
37
-
38
- • `Optional` **requireOrganisationContext**: `boolean`
39
-
40
- #### Defined in
41
-
42
- [packages/core/src/providers/OrganisationProvider.tsx:23](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/OrganisationProvider.tsx#L23)
43
-
44
- ___
45
-
46
- ### autoSelectPrimaryOrganisation
47
-
48
- • `Optional` **autoSelectPrimaryOrganisation**: `boolean`
49
-
50
- #### Defined in
51
-
52
- [packages/core/src/providers/OrganisationProvider.tsx:24](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/OrganisationProvider.tsx#L24)
53
-
54
- ___
55
-
56
- ### onOrganisationChange
57
-
58
- • `Optional` **onOrganisationChange**: (`organisation`: `any`) => `void`
59
-
60
- #### Type declaration
61
-
62
- ▸ (`organisation`): `void`
63
-
64
- ##### Parameters
65
-
66
- | Name | Type |
67
- | :------ | :------ |
68
- | `organisation` | `any` |
69
-
70
- ##### Returns
71
-
72
- `void`
73
-
74
- #### Defined in
75
-
76
- [packages/core/src/providers/OrganisationProvider.tsx:25](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/providers/OrganisationProvider.tsx#L25)
package/docs/api/interfaces/OrganisationSecurityError.md DELETED
@@ -1,62 +0,0 @@
1
- [@jmruthers/pace-core - v0.6.2](../README.md) / [Exports](../modules.md) / OrganisationSecurityError
2
-
3
- # Interface: OrganisationSecurityError
4
-
5
- ## Hierarchy
6
-
7
- - `Error`
8
-
9
- ↳ **`OrganisationSecurityError`**
10
-
11
- ## Table of contents
12
-
13
- ### Properties
14
-
15
- - [name](OrganisationSecurityError.md#name)
16
- - [code](OrganisationSecurityError.md#code)
17
- - [organisationId](OrganisationSecurityError.md#organisationid)
18
- - [userId](OrganisationSecurityError.md#userid)
19
-
20
- ## Properties
21
-
22
- ### name
23
-
24
- • **name**: ``"OrganisationSecurityError"``
25
-
26
- #### Overrides
27
-
28
- Error.name
29
-
30
- #### Defined in
31
-
32
- [packages/core/src/types/organisation.ts:102](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L102)
33
-
34
- ___
35
-
36
- ### code
37
-
38
- • **code**: `string`
39
-
40
- #### Defined in
41
-
42
- [packages/core/src/types/organisation.ts:103](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L103)
43
-
44
- ___
45
-
46
- ### organisationId
47
-
48
- • `Optional` **organisationId**: `string`
49
-
50
- #### Defined in
51
-
52
- [packages/core/src/types/organisation.ts:104](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L104)
53
-
54
- ___
55
-
56
- ### userId
57
-
58
- • `Optional` **userId**: `string`
59
-
60
- #### Defined in
61
-
62
- [packages/core/src/types/organisation.ts:105](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/types/organisation.ts#L105)