@strato-admin/core 0.1.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +3 -2
- package/dist/index.js +3 -3
- package/dist/ra-core/src/auth/AuthContext.d.ts +2 -0
- package/dist/ra-core/src/auth/AuthContext.js +3 -0
- package/dist/ra-core/src/auth/Authenticated.d.ts +40 -0
- package/dist/ra-core/src/auth/Authenticated.js +39 -0
- package/dist/ra-core/src/auth/CanAccess.d.ts +20 -0
- package/dist/ra-core/src/auth/CanAccess.js +31 -0
- package/dist/ra-core/src/auth/LogoutOnMount.d.ts +8 -0
- package/dist/ra-core/src/auth/LogoutOnMount.js +16 -0
- package/dist/ra-core/src/auth/WithPermissions.d.ts +19 -0
- package/dist/ra-core/src/auth/WithPermissions.js +66 -0
- package/dist/ra-core/src/auth/addRefreshAuthToAuthProvider.d.ts +22 -0
- package/dist/ra-core/src/auth/addRefreshAuthToAuthProvider.js +41 -0
- package/dist/ra-core/src/auth/addRefreshAuthToDataProvider.d.ts +21 -0
- package/dist/ra-core/src/auth/addRefreshAuthToDataProvider.js +30 -0
- package/dist/ra-core/src/auth/convertLegacyAuthProvider.d.ts +12 -0
- package/dist/ra-core/src/auth/convertLegacyAuthProvider.js +19 -0
- package/dist/ra-core/src/auth/index.d.ts +27 -0
- package/dist/ra-core/src/auth/index.js +34 -0
- package/dist/ra-core/src/auth/types.d.ts +7 -0
- package/dist/ra-core/src/auth/types.js +5 -0
- package/dist/ra-core/src/auth/useAuthProvider.d.ts +10 -0
- package/dist/ra-core/src/auth/useAuthProvider.js +11 -0
- package/dist/ra-core/src/auth/useAuthState.d.ts +48 -0
- package/dist/ra-core/src/auth/useAuthState.js +171 -0
- package/dist/ra-core/src/auth/useAuthenticated.d.ts +36 -0
- package/dist/ra-core/src/auth/useAuthenticated.js +34 -0
- package/dist/ra-core/src/auth/useCanAccess.d.ts +56 -0
- package/dist/ra-core/src/auth/useCanAccess.js +108 -0
- package/dist/ra-core/src/auth/useCanAccessCallback.d.ts +39 -0
- package/dist/ra-core/src/auth/useCanAccessCallback.js +45 -0
- package/dist/ra-core/src/auth/useCanAccessResources.d.ts +67 -0
- package/dist/ra-core/src/auth/useCanAccessResources.js +92 -0
- package/dist/ra-core/src/auth/useCheckAuth.d.ts +48 -0
- package/dist/ra-core/src/auth/useCheckAuth.js +76 -0
- package/dist/ra-core/src/auth/useGetIdentity.d.ts +41 -0
- package/dist/ra-core/src/auth/useGetIdentity.js +86 -0
- package/dist/ra-core/src/auth/useGetPermissions.d.ts +41 -0
- package/dist/ra-core/src/auth/useGetPermissions.js +47 -0
- package/dist/ra-core/src/auth/useHandleAuthCallback.d.ts +20 -0
- package/dist/ra-core/src/auth/useHandleAuthCallback.js +83 -0
- package/dist/ra-core/src/auth/useIsAuthPending.d.ts +13 -0
- package/dist/ra-core/src/auth/useIsAuthPending.js +30 -0
- package/dist/ra-core/src/auth/useLogin.d.ts +34 -0
- package/dist/ra-core/src/auth/useLogin.js +78 -0
- package/dist/ra-core/src/auth/useLogout.d.ts +31 -0
- package/dist/ra-core/src/auth/useLogout.js +117 -0
- package/dist/ra-core/src/auth/useLogoutIfAccessDenied.d.ts +42 -0
- package/dist/ra-core/src/auth/useLogoutIfAccessDenied.js +111 -0
- package/dist/ra-core/src/auth/usePermissions.d.ts +41 -0
- package/dist/ra-core/src/auth/usePermissions.js +123 -0
- package/dist/ra-core/src/auth/useRequireAccess.d.ts +140 -0
- package/dist/ra-core/src/auth/useRequireAccess.js +56 -0
- package/dist/ra-core/src/controller/button/index.d.ts +7 -0
- package/dist/ra-core/src/controller/button/index.js +7 -0
- package/dist/ra-core/src/controller/button/useBulkDeleteController.d.ts +14 -0
- package/dist/ra-core/src/controller/button/useBulkDeleteController.js +66 -0
- package/dist/ra-core/src/controller/button/useBulkUpdateController.d.ts +16 -0
- package/dist/ra-core/src/controller/button/useBulkUpdateController.js +70 -0
- package/dist/ra-core/src/controller/button/useDeleteController.d.ts +64 -0
- package/dist/ra-core/src/controller/button/useDeleteController.js +119 -0
- package/dist/ra-core/src/controller/button/useDeleteWithConfirmController.d.ts +69 -0
- package/dist/ra-core/src/controller/button/useDeleteWithConfirmController.js +139 -0
- package/dist/ra-core/src/controller/button/useDeleteWithUndoController.d.ts +46 -0
- package/dist/ra-core/src/controller/button/useDeleteWithUndoController.js +52 -0
- package/dist/ra-core/src/controller/button/useUpdateController.d.ts +68 -0
- package/dist/ra-core/src/controller/button/useUpdateController.js +113 -0
- package/dist/ra-core/src/controller/checkMinimumRequiredProps.d.ts +4 -0
- package/dist/ra-core/src/controller/checkMinimumRequiredProps.js +21 -0
- package/dist/ra-core/src/controller/create/CreateBase.d.ts +46 -0
- package/dist/ra-core/src/controller/create/CreateBase.js +55 -0
- package/dist/ra-core/src/controller/create/CreateContext.d.ts +20 -0
- package/dist/ra-core/src/controller/create/CreateContext.js +21 -0
- package/dist/ra-core/src/controller/create/CreateContextProvider.d.ts +29 -0
- package/dist/ra-core/src/controller/create/CreateContextProvider.js +31 -0
- package/dist/ra-core/src/controller/create/CreateController.d.ts +19 -0
- package/dist/ra-core/src/controller/create/CreateController.js +18 -0
- package/dist/ra-core/src/controller/create/index.d.ts +6 -0
- package/dist/ra-core/src/controller/create/index.js +6 -0
- package/dist/ra-core/src/controller/create/useCreateContext.d.ts +12 -0
- package/dist/ra-core/src/controller/create/useCreateContext.js +18 -0
- package/dist/ra-core/src/controller/create/useCreateController.d.ts +50 -0
- package/dist/ra-core/src/controller/create/useCreateController.js +149 -0
- package/dist/ra-core/src/controller/edit/EditBase.d.ts +41 -0
- package/dist/ra-core/src/controller/edit/EditBase.js +72 -0
- package/dist/ra-core/src/controller/edit/EditContext.d.ts +20 -0
- package/dist/ra-core/src/controller/edit/EditContext.js +21 -0
- package/dist/ra-core/src/controller/edit/EditContextProvider.d.ts +29 -0
- package/dist/ra-core/src/controller/edit/EditContextProvider.js +28 -0
- package/dist/ra-core/src/controller/edit/EditController.d.ts +19 -0
- package/dist/ra-core/src/controller/edit/EditController.js +18 -0
- package/dist/ra-core/src/controller/edit/index.d.ts +6 -0
- package/dist/ra-core/src/controller/edit/index.js +6 -0
- package/dist/ra-core/src/controller/edit/useEditContext.d.ts +12 -0
- package/dist/ra-core/src/controller/edit/useEditContext.js +18 -0
- package/dist/ra-core/src/controller/edit/useEditController.d.ts +72 -0
- package/dist/ra-core/src/controller/edit/useEditController.js +206 -0
- package/dist/ra-core/src/controller/field/ReferenceArrayFieldBase.d.ts +77 -0
- package/dist/ra-core/src/controller/field/ReferenceArrayFieldBase.js +119 -0
- package/dist/ra-core/src/controller/field/ReferenceFieldBase.d.ts +51 -0
- package/dist/ra-core/src/controller/field/ReferenceFieldBase.js +71 -0
- package/dist/ra-core/src/controller/field/ReferenceFieldContext.d.ts +4 -0
- package/dist/ra-core/src/controller/field/ReferenceFieldContext.js +10 -0
- package/dist/ra-core/src/controller/field/ReferenceManyCountBase.d.ts +20 -0
- package/dist/ra-core/src/controller/field/ReferenceManyCountBase.js +35 -0
- package/dist/ra-core/src/controller/field/ReferenceManyFieldBase.d.ts +59 -0
- package/dist/ra-core/src/controller/field/ReferenceManyFieldBase.js +108 -0
- package/dist/ra-core/src/controller/field/ReferenceOneFieldBase.d.ts +26 -0
- package/dist/ra-core/src/controller/field/ReferenceOneFieldBase.js +64 -0
- package/dist/ra-core/src/controller/field/index.d.ts +12 -0
- package/dist/ra-core/src/controller/field/index.js +12 -0
- package/dist/ra-core/src/controller/field/sanitizeFieldRestProps.d.ts +1 -0
- package/dist/ra-core/src/controller/field/sanitizeFieldRestProps.js +1 -0
- package/dist/ra-core/src/controller/field/types.d.ts +28 -0
- package/dist/ra-core/src/controller/field/types.js +1 -0
- package/dist/ra-core/src/controller/field/useReferenceArrayFieldController.d.ts +39 -0
- package/dist/ra-core/src/controller/field/useReferenceArrayFieldController.js +82 -0
- package/dist/ra-core/src/controller/field/useReferenceFieldController.d.ts +14 -0
- package/dist/ra-core/src/controller/field/useReferenceFieldController.js +31 -0
- package/dist/ra-core/src/controller/field/useReferenceManyFieldController.d.ts +49 -0
- package/dist/ra-core/src/controller/field/useReferenceManyFieldController.js +264 -0
- package/dist/ra-core/src/controller/field/useReferenceOneFieldController.d.ts +41 -0
- package/dist/ra-core/src/controller/field/useReferenceOneFieldController.js +67 -0
- package/dist/ra-core/src/controller/index.d.ts +17 -0
- package/dist/ra-core/src/controller/index.js +16 -0
- package/dist/ra-core/src/controller/input/ArrayInputBase.d.ts +46 -0
- package/dist/ra-core/src/controller/input/ArrayInputBase.js +130 -0
- package/dist/ra-core/src/controller/input/ArrayInputContext.d.ts +9 -0
- package/dist/ra-core/src/controller/input/ArrayInputContext.js +8 -0
- package/dist/ra-core/src/controller/input/ReferenceArrayInputBase.d.ts +78 -0
- package/dist/ra-core/src/controller/input/ReferenceArrayInputBase.js +97 -0
- package/dist/ra-core/src/controller/input/ReferenceInputBase.d.ts +65 -0
- package/dist/ra-core/src/controller/input/ReferenceInputBase.js +75 -0
- package/dist/ra-core/src/controller/input/SimpleFormIteratorBase.d.ts +17 -0
- package/dist/ra-core/src/controller/input/SimpleFormIteratorBase.js +55 -0
- package/dist/ra-core/src/controller/input/SimpleFormIteratorContext.d.ts +15 -0
- package/dist/ra-core/src/controller/input/SimpleFormIteratorContext.js +8 -0
- package/dist/ra-core/src/controller/input/SimpleFormIteratorItemBase.d.ts +12 -0
- package/dist/ra-core/src/controller/input/SimpleFormIteratorItemBase.js +53 -0
- package/dist/ra-core/src/controller/input/SimpleFormIteratorItemContext.d.ts +13 -0
- package/dist/ra-core/src/controller/input/SimpleFormIteratorItemContext.js +8 -0
- package/dist/ra-core/src/controller/input/index.d.ts +17 -0
- package/dist/ra-core/src/controller/input/index.js +17 -0
- package/dist/ra-core/src/controller/input/referenceDataStatus.d.ts +32 -0
- package/dist/ra-core/src/controller/input/referenceDataStatus.js +74 -0
- package/dist/ra-core/src/controller/input/sanitizeInputRestProps.d.ts +1 -0
- package/dist/ra-core/src/controller/input/sanitizeInputRestProps.js +1 -0
- package/dist/ra-core/src/controller/input/types.d.ts +3 -0
- package/dist/ra-core/src/controller/input/types.js +1 -0
- package/dist/ra-core/src/controller/input/useArrayInput.d.ts +8 -0
- package/dist/ra-core/src/controller/input/useArrayInput.js +29 -0
- package/dist/ra-core/src/controller/input/useGetArrayInputNewItemDefaults.d.ts +3 -0
- package/dist/ra-core/src/controller/input/useGetArrayInputNewItemDefaults.js +37 -0
- package/dist/ra-core/src/controller/input/useReferenceArrayInputController.d.ts +48 -0
- package/dist/ra-core/src/controller/input/useReferenceArrayInputController.js +137 -0
- package/dist/ra-core/src/controller/input/useReferenceInputController.d.ts +54 -0
- package/dist/ra-core/src/controller/input/useReferenceInputController.js +208 -0
- package/dist/ra-core/src/controller/input/useReferenceParams.d.ts +106 -0
- package/dist/ra-core/src/controller/input/useReferenceParams.js +226 -0
- package/dist/ra-core/src/controller/input/useSimpleFormIterator.d.ts +7 -0
- package/dist/ra-core/src/controller/input/useSimpleFormIterator.js +15 -0
- package/dist/ra-core/src/controller/input/useSimpleFormIteratorItem.d.ts +7 -0
- package/dist/ra-core/src/controller/input/useSimpleFormIteratorItem.js +15 -0
- package/dist/ra-core/src/controller/input/useSupportCreateSuggestion.d.ts +54 -0
- package/dist/ra-core/src/controller/input/useSupportCreateSuggestion.js +90 -0
- package/dist/ra-core/src/controller/list/FilterContext.d.ts +6 -0
- package/dist/ra-core/src/controller/list/FilterContext.js +5 -0
- package/dist/ra-core/src/controller/list/InfiniteListBase.d.ts +47 -0
- package/dist/ra-core/src/controller/list/InfiniteListBase.js +103 -0
- package/dist/ra-core/src/controller/list/InfinitePaginationContext.d.ts +25 -0
- package/dist/ra-core/src/controller/list/InfinitePaginationContext.js +32 -0
- package/dist/ra-core/src/controller/list/ListBase.d.ts +48 -0
- package/dist/ra-core/src/controller/list/ListBase.js +98 -0
- package/dist/ra-core/src/controller/list/ListContext.d.ts +54 -0
- package/dist/ra-core/src/controller/list/ListContext.js +55 -0
- package/dist/ra-core/src/controller/list/ListContextProvider.d.ts +33 -0
- package/dist/ra-core/src/controller/list/ListContextProvider.js +33 -0
- package/dist/ra-core/src/controller/list/ListController.d.ts +19 -0
- package/dist/ra-core/src/controller/list/ListController.js +18 -0
- package/dist/ra-core/src/controller/list/ListFilterContext.d.ts +39 -0
- package/dist/ra-core/src/controller/list/ListFilterContext.js +55 -0
- package/dist/ra-core/src/controller/list/ListPaginationContext.d.ts +43 -0
- package/dist/ra-core/src/controller/list/ListPaginationContext.js +67 -0
- package/dist/ra-core/src/controller/list/ListSortContext.d.ts +36 -0
- package/dist/ra-core/src/controller/list/ListSortContext.js +39 -0
- package/dist/ra-core/src/controller/list/RecordsIterator.d.ts +16 -0
- package/dist/ra-core/src/controller/list/RecordsIterator.js +22 -0
- package/dist/ra-core/src/controller/list/WithListContext.d.ts +32 -0
- package/dist/ra-core/src/controller/list/WithListContext.js +42 -0
- package/dist/ra-core/src/controller/list/index.d.ts +30 -0
- package/dist/ra-core/src/controller/list/index.js +30 -0
- package/dist/ra-core/src/controller/list/queryReducer.d.ts +45 -0
- package/dist/ra-core/src/controller/list/queryReducer.js +85 -0
- package/dist/ra-core/src/controller/list/useExpanded.d.ts +31 -0
- package/dist/ra-core/src/controller/list/useExpanded.js +70 -0
- package/dist/ra-core/src/controller/list/useFilterContext.d.ts +2 -0
- package/dist/ra-core/src/controller/list/useFilterContext.js +5 -0
- package/dist/ra-core/src/controller/list/useInfiniteListController.d.ts +44 -0
- package/dist/ra-core/src/controller/list/useInfiniteListController.js +175 -0
- package/dist/ra-core/src/controller/list/useInfinitePaginationContext.d.ts +16 -0
- package/dist/ra-core/src/controller/list/useInfinitePaginationContext.js +17 -0
- package/dist/ra-core/src/controller/list/useList.d.ts +55 -0
- package/dist/ra-core/src/controller/list/useList.js +223 -0
- package/dist/ra-core/src/controller/list/useListContext.d.ts +59 -0
- package/dist/ra-core/src/controller/list/useListContext.js +65 -0
- package/dist/ra-core/src/controller/list/useListContextWithProps.d.ts +44 -0
- package/dist/ra-core/src/controller/list/useListContextWithProps.js +84 -0
- package/dist/ra-core/src/controller/list/useListController.d.ts +296 -0
- package/dist/ra-core/src/controller/list/useListController.js +234 -0
- package/dist/ra-core/src/controller/list/useListFilterContext.d.ts +11 -0
- package/dist/ra-core/src/controller/list/useListFilterContext.js +18 -0
- package/dist/ra-core/src/controller/list/useListPaginationContext.d.ts +12 -0
- package/dist/ra-core/src/controller/list/useListPaginationContext.js +19 -0
- package/dist/ra-core/src/controller/list/useListParams.d.ts +116 -0
- package/dist/ra-core/src/controller/list/useListParams.js +281 -0
- package/dist/ra-core/src/controller/list/useListSortContext.d.ts +12 -0
- package/dist/ra-core/src/controller/list/useListSortContext.js +19 -0
- package/dist/ra-core/src/controller/list/useRecordSelection.d.ts +32 -0
- package/dist/ra-core/src/controller/list/useRecordSelection.js +93 -0
- package/dist/ra-core/src/controller/list/useSavedQueries.d.ts +14 -0
- package/dist/ra-core/src/controller/list/useSavedQueries.js +29 -0
- package/dist/ra-core/src/controller/list/useSelectAll.d.ts +48 -0
- package/dist/ra-core/src/controller/list/useSelectAll.js +102 -0
- package/dist/ra-core/src/controller/list/useUnselect.d.ts +10 -0
- package/dist/ra-core/src/controller/list/useUnselect.js +18 -0
- package/dist/ra-core/src/controller/list/useUnselectAll.d.ts +9 -0
- package/dist/ra-core/src/controller/list/useUnselectAll.js +18 -0
- package/dist/ra-core/src/controller/record/OptionalRecordContextProvider.d.ts +21 -0
- package/dist/ra-core/src/controller/record/OptionalRecordContextProvider.js +18 -0
- package/dist/ra-core/src/controller/record/RecordContext.d.ts +37 -0
- package/dist/ra-core/src/controller/record/RecordContext.js +33 -0
- package/dist/ra-core/src/controller/record/RecordRepresentation.d.ts +11 -0
- package/dist/ra-core/src/controller/record/RecordRepresentation.js +15 -0
- package/dist/ra-core/src/controller/record/WithRecord.d.ts +20 -0
- package/dist/ra-core/src/controller/record/WithRecord.js +18 -0
- package/dist/ra-core/src/controller/record/index.d.ts +5 -0
- package/dist/ra-core/src/controller/record/index.js +5 -0
- package/dist/ra-core/src/controller/record/useRecordContext.d.ts +34 -0
- package/dist/ra-core/src/controller/record/useRecordContext.js +36 -0
- package/dist/ra-core/src/controller/saveContext/SaveContext.d.ts +20 -0
- package/dist/ra-core/src/controller/saveContext/SaveContext.js +2 -0
- package/dist/ra-core/src/controller/saveContext/SaveContextProvider.d.ts +4 -0
- package/dist/ra-core/src/controller/saveContext/SaveContextProvider.js +3 -0
- package/dist/ra-core/src/controller/saveContext/index.d.ts +6 -0
- package/dist/ra-core/src/controller/saveContext/index.js +6 -0
- package/dist/ra-core/src/controller/saveContext/useMutationMiddlewares.d.ts +39 -0
- package/dist/ra-core/src/controller/saveContext/useMutationMiddlewares.js +79 -0
- package/dist/ra-core/src/controller/saveContext/usePickSaveContext.d.ts +5 -0
- package/dist/ra-core/src/controller/saveContext/usePickSaveContext.js +25 -0
- package/dist/ra-core/src/controller/saveContext/useRegisterMutationMiddleware.d.ts +6 -0
- package/dist/ra-core/src/controller/saveContext/useRegisterMutationMiddleware.js +18 -0
- package/dist/ra-core/src/controller/saveContext/useSaveContext.d.ts +14 -0
- package/dist/ra-core/src/controller/saveContext/useSaveContext.js +17 -0
- package/dist/ra-core/src/controller/show/ShowBase.d.ts +42 -0
- package/dist/ra-core/src/controller/show/ShowBase.js +72 -0
- package/dist/ra-core/src/controller/show/ShowContext.d.ts +20 -0
- package/dist/ra-core/src/controller/show/ShowContext.js +21 -0
- package/dist/ra-core/src/controller/show/ShowContextProvider.d.ts +27 -0
- package/dist/ra-core/src/controller/show/ShowContextProvider.js +25 -0
- package/dist/ra-core/src/controller/show/ShowController.d.ts +19 -0
- package/dist/ra-core/src/controller/show/ShowController.js +18 -0
- package/dist/ra-core/src/controller/show/index.d.ts +6 -0
- package/dist/ra-core/src/controller/show/index.js +6 -0
- package/dist/ra-core/src/controller/show/useShowContext.d.ts +12 -0
- package/dist/ra-core/src/controller/show/useShowContext.js +19 -0
- package/dist/ra-core/src/controller/show/useShowController.d.ts +75 -0
- package/dist/ra-core/src/controller/show/useShowController.js +110 -0
- package/dist/ra-core/src/controller/useFilterState.d.ts +46 -0
- package/dist/ra-core/src/controller/useFilterState.js +70 -0
- package/dist/ra-core/src/controller/usePaginationState.d.ts +33 -0
- package/dist/ra-core/src/controller/usePaginationState.js +45 -0
- package/dist/ra-core/src/controller/usePrevNextController.d.ts +127 -0
- package/dist/ra-core/src/controller/usePrevNextController.js +215 -0
- package/dist/ra-core/src/controller/useReference.d.ts +49 -0
- package/dist/ra-core/src/controller/useReference.js +42 -0
- package/dist/ra-core/src/controller/useSortState.d.ts +61 -0
- package/dist/ra-core/src/controller/useSortState.js +96 -0
- package/dist/ra-core/src/core/CoreAdmin.d.ts +83 -0
- package/dist/ra-core/src/core/CoreAdmin.js +86 -0
- package/dist/ra-core/src/core/CoreAdminContext.d.ts +154 -0
- package/dist/ra-core/src/core/CoreAdminContext.js +27 -0
- package/dist/ra-core/src/core/CoreAdminRoutes.d.ts +15 -0
- package/dist/ra-core/src/core/CoreAdminRoutes.js +33 -0
- package/dist/ra-core/src/core/CoreAdminUI.d.ts +260 -0
- package/dist/ra-core/src/core/CoreAdminUI.js +33 -0
- package/dist/ra-core/src/core/CustomRoutes.d.ts +16 -0
- package/dist/ra-core/src/core/CustomRoutes.js +11 -0
- package/dist/ra-core/src/core/DefaultTitleContext.d.ts +15 -0
- package/dist/ra-core/src/core/DefaultTitleContext.js +15 -0
- package/dist/ra-core/src/core/HasDashboardContext.d.ts +21 -0
- package/dist/ra-core/src/core/HasDashboardContext.js +22 -0
- package/dist/ra-core/src/core/IsOffline.d.ts +4 -0
- package/dist/ra-core/src/core/IsOffline.js +5 -0
- package/dist/ra-core/src/core/NavigateToFirstResource.d.ts +10 -0
- package/dist/ra-core/src/core/NavigateToFirstResource.js +21 -0
- package/dist/ra-core/src/core/OptionalResourceContextProvider.d.ts +22 -0
- package/dist/ra-core/src/core/OptionalResourceContextProvider.js +18 -0
- package/dist/ra-core/src/core/Resource.d.ts +16 -0
- package/dist/ra-core/src/core/Resource.js +31 -0
- package/dist/ra-core/src/core/ResourceContext.d.ts +19 -0
- package/dist/ra-core/src/core/ResourceContext.js +19 -0
- package/dist/ra-core/src/core/ResourceContextProvider.d.ts +26 -0
- package/dist/ra-core/src/core/ResourceContextProvider.js +22 -0
- package/dist/ra-core/src/core/ResourceDefinitionContext.d.ts +35 -0
- package/dist/ra-core/src/core/ResourceDefinitionContext.js +48 -0
- package/dist/ra-core/src/core/SourceContext.d.ts +27 -0
- package/dist/ra-core/src/core/SourceContext.js +35 -0
- package/dist/ra-core/src/core/UserMenuContext.d.ts +34 -0
- package/dist/ra-core/src/core/UserMenuContext.js +28 -0
- package/dist/ra-core/src/core/UserMenuContextProvider.d.ts +16 -0
- package/dist/ra-core/src/core/UserMenuContextProvider.js +9 -0
- package/dist/ra-core/src/core/index.d.ts +27 -0
- package/dist/ra-core/src/core/index.js +27 -0
- package/dist/ra-core/src/core/useConfigureAdminRouterFromChildren.d.ts +34 -0
- package/dist/ra-core/src/core/useConfigureAdminRouterFromChildren.js +227 -0
- package/dist/ra-core/src/core/useFirstResourceWithListAccess.d.ts +8 -0
- package/dist/ra-core/src/core/useFirstResourceWithListAccess.js +19 -0
- package/dist/ra-core/src/core/useGetRecordRepresentation.d.ts +13 -0
- package/dist/ra-core/src/core/useGetRecordRepresentation.js +44 -0
- package/dist/ra-core/src/core/useGetResourceLabel.d.ts +22 -0
- package/dist/ra-core/src/core/useGetResourceLabel.js +42 -0
- package/dist/ra-core/src/core/useIsOffline.d.ts +7 -0
- package/dist/ra-core/src/core/useIsOffline.js +18 -0
- package/dist/ra-core/src/core/useResourceContext.d.ts +36 -0
- package/dist/ra-core/src/core/useResourceContext.js +38 -0
- package/dist/ra-core/src/core/useResourceDefinition.d.ts +31 -0
- package/dist/ra-core/src/core/useResourceDefinition.js +48 -0
- package/dist/ra-core/src/core/useResourceDefinitionContext.d.ts +1 -0
- package/dist/ra-core/src/core/useResourceDefinitionContext.js +3 -0
- package/dist/ra-core/src/core/useResourceDefinitions.d.ts +21 -0
- package/dist/ra-core/src/core/useResourceDefinitions.js +20 -0
- package/dist/ra-core/src/core/useUserMenu.d.ts +28 -0
- package/dist/ra-core/src/core/useUserMenu.js +30 -0
- package/dist/ra-core/src/core/useWrappedSource.d.ts +11 -0
- package/dist/ra-core/src/core/useWrappedSource.js +15 -0
- package/dist/ra-core/src/dataProvider/DataProviderContext.d.ts +3 -0
- package/dist/ra-core/src/dataProvider/DataProviderContext.js +4 -0
- package/dist/ra-core/src/dataProvider/HttpError.d.ts +6 -0
- package/dist/ra-core/src/dataProvider/HttpError.js +19 -0
- package/dist/ra-core/src/dataProvider/combineDataProviders.d.ts +21 -0
- package/dist/ra-core/src/dataProvider/combineDataProviders.js +32 -0
- package/dist/ra-core/src/dataProvider/convertLegacyDataProvider.d.ts +12 -0
- package/dist/ra-core/src/dataProvider/convertLegacyDataProvider.js +40 -0
- package/dist/ra-core/src/dataProvider/dataFetchActions.d.ts +15 -0
- package/dist/ra-core/src/dataProvider/dataFetchActions.js +49 -0
- package/dist/ra-core/src/dataProvider/defaultDataProvider.d.ts +2 -0
- package/dist/ra-core/src/dataProvider/defaultDataProvider.js +12 -0
- package/dist/ra-core/src/dataProvider/fetch.d.ts +32 -0
- package/dist/ra-core/src/dataProvider/fetch.js +78 -0
- package/dist/ra-core/src/dataProvider/index.d.ts +34 -0
- package/dist/ra-core/src/dataProvider/index.js +33 -0
- package/dist/ra-core/src/dataProvider/populateQueryCache.d.ts +22 -0
- package/dist/ra-core/src/dataProvider/populateQueryCache.js +30 -0
- package/dist/ra-core/src/dataProvider/testDataProvider.d.ts +2 -0
- package/dist/ra-core/src/dataProvider/testDataProvider.js +41 -0
- package/dist/ra-core/src/dataProvider/undo/AddUndoableMutationContext.d.ts +2 -0
- package/dist/ra-core/src/dataProvider/undo/AddUndoableMutationContext.js +2 -0
- package/dist/ra-core/src/dataProvider/undo/TakeUndoableMutationContext.d.ts +2 -0
- package/dist/ra-core/src/dataProvider/undo/TakeUndoableMutationContext.js +2 -0
- package/dist/ra-core/src/dataProvider/undo/UndoableMutationsContextProvider.d.ts +13 -0
- package/dist/ra-core/src/dataProvider/undo/UndoableMutationsContextProvider.js +38 -0
- package/dist/ra-core/src/dataProvider/undo/index.d.ts +6 -0
- package/dist/ra-core/src/dataProvider/undo/index.js +6 -0
- package/dist/ra-core/src/dataProvider/undo/types.d.ts +3 -0
- package/dist/ra-core/src/dataProvider/undo/types.js +1 -0
- package/dist/ra-core/src/dataProvider/undo/useAddUndoableMutation.d.ts +1 -0
- package/dist/ra-core/src/dataProvider/undo/useAddUndoableMutation.js +3 -0
- package/dist/ra-core/src/dataProvider/undo/useTakeUndoableMutation.d.ts +1 -0
- package/dist/ra-core/src/dataProvider/undo/useTakeUndoableMutation.js +3 -0
- package/dist/ra-core/src/dataProvider/undoableEventEmitter.d.ts +3 -0
- package/dist/ra-core/src/dataProvider/undoableEventEmitter.js +2 -0
- package/dist/ra-core/src/dataProvider/useCreate.d.ts +89 -0
- package/dist/ra-core/src/dataProvider/useCreate.js +155 -0
- package/dist/ra-core/src/dataProvider/useDataProvider.d.ts +2 -0
- package/dist/ra-core/src/dataProvider/useDataProvider.js +140 -0
- package/dist/ra-core/src/dataProvider/useDelete.d.ts +83 -0
- package/dist/ra-core/src/dataProvider/useDelete.js +171 -0
- package/dist/ra-core/src/dataProvider/useDeleteMany.d.ts +81 -0
- package/dist/ra-core/src/dataProvider/useDeleteMany.js +193 -0
- package/dist/ra-core/src/dataProvider/useGetList.d.ts +58 -0
- package/dist/ra-core/src/dataProvider/useGetList.js +131 -0
- package/dist/ra-core/src/dataProvider/useGetMany.d.ts +49 -0
- package/dist/ra-core/src/dataProvider/useGetMany.js +143 -0
- package/dist/ra-core/src/dataProvider/useGetManyAggregate.d.ts +62 -0
- package/dist/ra-core/src/dataProvider/useGetManyAggregate.js +295 -0
- package/dist/ra-core/src/dataProvider/useGetManyReference.d.ts +62 -0
- package/dist/ra-core/src/dataProvider/useGetManyReference.js +117 -0
- package/dist/ra-core/src/dataProvider/useGetOne.d.ts +48 -0
- package/dist/ra-core/src/dataProvider/useGetOne.js +94 -0
- package/dist/ra-core/src/dataProvider/useGetRecordId.d.ts +14 -0
- package/dist/ra-core/src/dataProvider/useGetRecordId.js +22 -0
- package/dist/ra-core/src/dataProvider/useInfiniteGetList.d.ts +64 -0
- package/dist/ra-core/src/dataProvider/useInfiniteGetList.js +177 -0
- package/dist/ra-core/src/dataProvider/useIsDataLoaded.d.ts +13 -0
- package/dist/ra-core/src/dataProvider/useIsDataLoaded.js +35 -0
- package/dist/ra-core/src/dataProvider/useLoading.d.ts +12 -0
- package/dist/ra-core/src/dataProvider/useLoading.js +41 -0
- package/dist/ra-core/src/dataProvider/useMutationWithMutationMode.d.ts +51 -0
- package/dist/ra-core/src/dataProvider/useMutationWithMutationMode.js +238 -0
- package/dist/ra-core/src/dataProvider/useRefresh.d.ts +14 -0
- package/dist/ra-core/src/dataProvider/useRefresh.js +21 -0
- package/dist/ra-core/src/dataProvider/useUpdate.d.ts +89 -0
- package/dist/ra-core/src/dataProvider/useUpdate.js +183 -0
- package/dist/ra-core/src/dataProvider/useUpdateMany.d.ts +81 -0
- package/dist/ra-core/src/dataProvider/useUpdateMany.js +171 -0
- package/dist/ra-core/src/dataProvider/validateResponseFormat.d.ts +2 -0
- package/dist/ra-core/src/dataProvider/validateResponseFormat.js +35 -0
- package/dist/ra-core/src/dataProvider/withLifecycleCallbacks.d.ts +162 -0
- package/dist/ra-core/src/dataProvider/withLifecycleCallbacks.js +377 -0
- package/dist/ra-core/src/dataTable/DataTableBase.d.ts +36 -0
- package/dist/ra-core/src/dataTable/DataTableBase.js +104 -0
- package/dist/ra-core/src/dataTable/DataTableCallbacksContext.d.ts +18 -0
- package/dist/ra-core/src/dataTable/DataTableCallbacksContext.js +3 -0
- package/dist/ra-core/src/dataTable/DataTableColumnFilterContext.d.ts +2 -0
- package/dist/ra-core/src/dataTable/DataTableColumnFilterContext.js +3 -0
- package/dist/ra-core/src/dataTable/DataTableColumnRankContext.d.ts +2 -0
- package/dist/ra-core/src/dataTable/DataTableColumnRankContext.js +3 -0
- package/dist/ra-core/src/dataTable/DataTableConfigContext.d.ts +22 -0
- package/dist/ra-core/src/dataTable/DataTableConfigContext.js +7 -0
- package/dist/ra-core/src/dataTable/DataTableDataContext.d.ts +4 -0
- package/dist/ra-core/src/dataTable/DataTableDataContext.js +3 -0
- package/dist/ra-core/src/dataTable/DataTableRenderContext.d.ts +3 -0
- package/dist/ra-core/src/dataTable/DataTableRenderContext.js +3 -0
- package/dist/ra-core/src/dataTable/DataTableSelectedIdsContext.d.ts +3 -0
- package/dist/ra-core/src/dataTable/DataTableSelectedIdsContext.js +3 -0
- package/dist/ra-core/src/dataTable/DataTableSortContext.d.ts +3 -0
- package/dist/ra-core/src/dataTable/DataTableSortContext.js +3 -0
- package/dist/ra-core/src/dataTable/DataTableStoreContext.d.ts +8 -0
- package/dist/ra-core/src/dataTable/DataTableStoreContext.js +6 -0
- package/dist/ra-core/src/dataTable/index.d.ts +11 -0
- package/dist/ra-core/src/dataTable/index.js +11 -0
- package/dist/ra-core/src/dataTable/types.d.ts +2 -0
- package/dist/ra-core/src/dataTable/types.js +1 -0
- package/dist/ra-core/src/export/ExporterContext.d.ts +2 -0
- package/dist/ra-core/src/export/ExporterContext.js +4 -0
- package/dist/ra-core/src/export/defaultExporter.d.ts +2 -0
- package/dist/ra-core/src/export/defaultExporter.js +3 -0
- package/dist/ra-core/src/export/downloadCSV.d.ts +1 -0
- package/dist/ra-core/src/export/downloadCSV.js +17 -0
- package/dist/ra-core/src/export/fetchRelatedRecords.d.ts +14 -0
- package/dist/ra-core/src/export/fetchRelatedRecords.js +19 -0
- package/dist/ra-core/src/export/getRelatedIds.d.ts +24 -0
- package/dist/ra-core/src/export/getRelatedIds.js +26 -0
- package/dist/ra-core/src/export/index.d.ts +5 -0
- package/dist/ra-core/src/export/index.js +5 -0
- package/dist/ra-core/src/export/useBulkExport.d.ts +11 -0
- package/dist/ra-core/src/export/useBulkExport.js +30 -0
- package/dist/ra-core/src/form/FilterLiveForm.d.ts +56 -0
- package/dist/ra-core/src/form/FilterLiveForm.js +161 -0
- package/dist/ra-core/src/form/Form.d.ts +56 -0
- package/dist/ra-core/src/form/Form.js +55 -0
- package/dist/ra-core/src/form/FormDataConsumer.d.ts +74 -0
- package/dist/ra-core/src/form/FormDataConsumer.js +68 -0
- package/dist/ra-core/src/form/WarnWhenUnsavedChanges.d.ts +5 -0
- package/dist/ra-core/src/form/WarnWhenUnsavedChanges.js +5 -0
- package/dist/ra-core/src/form/choices/ChoicesContext.d.ts +65 -0
- package/dist/ra-core/src/form/choices/ChoicesContext.js +7 -0
- package/dist/ra-core/src/form/choices/ChoicesContextProvider.d.ts +6 -0
- package/dist/ra-core/src/form/choices/ChoicesContextProvider.js +3 -0
- package/dist/ra-core/src/form/choices/index.d.ts +4 -0
- package/dist/ra-core/src/form/choices/index.js +4 -0
- package/dist/ra-core/src/form/choices/useChoices.d.ts +31 -0
- package/dist/ra-core/src/form/choices/useChoices.js +42 -0
- package/dist/ra-core/src/form/choices/useChoicesContext.d.ts +5 -0
- package/dist/ra-core/src/form/choices/useChoicesContext.js +62 -0
- package/dist/ra-core/src/form/getFormInitialValues.d.ts +8 -0
- package/dist/ra-core/src/form/getFormInitialValues.js +14 -0
- package/dist/ra-core/src/form/groups/FormGroupContext.d.ts +9 -0
- package/dist/ra-core/src/form/groups/FormGroupContext.js +9 -0
- package/dist/ra-core/src/form/groups/FormGroupContextProvider.d.ts +49 -0
- package/dist/ra-core/src/form/groups/FormGroupContextProvider.js +64 -0
- package/dist/ra-core/src/form/groups/FormGroupsContext.d.ts +15 -0
- package/dist/ra-core/src/form/groups/FormGroupsContext.js +3 -0
- package/dist/ra-core/src/form/groups/FormGroupsProvider.d.ts +11 -0
- package/dist/ra-core/src/form/groups/FormGroupsProvider.js +67 -0
- package/dist/ra-core/src/form/groups/index.d.ts +6 -0
- package/dist/ra-core/src/form/groups/index.js +6 -0
- package/dist/ra-core/src/form/groups/useFormGroup.d.ts +67 -0
- package/dist/ra-core/src/form/groups/useFormGroup.js +146 -0
- package/dist/ra-core/src/form/groups/useFormGroupContext.d.ts +4 -0
- package/dist/ra-core/src/form/groups/useFormGroupContext.js +9 -0
- package/dist/ra-core/src/form/groups/useFormGroups.d.ts +4 -0
- package/dist/ra-core/src/form/groups/useFormGroups.js +9 -0
- package/dist/ra-core/src/form/index.d.ts +14 -0
- package/dist/ra-core/src/form/index.js +14 -0
- package/dist/ra-core/src/form/sanitizeEmptyValues.d.ts +7 -0
- package/dist/ra-core/src/form/sanitizeEmptyValues.js +26 -0
- package/dist/ra-core/src/form/useApplyInputDefaultValues.d.ts +19 -0
- package/dist/ra-core/src/form/useApplyInputDefaultValues.js +71 -0
- package/dist/ra-core/src/form/useAugmentedForm.d.ts +32 -0
- package/dist/ra-core/src/form/useAugmentedForm.js +101 -0
- package/dist/ra-core/src/form/useFormIsDirty.d.ts +4 -0
- package/dist/ra-core/src/form/useFormIsDirty.js +39 -0
- package/dist/ra-core/src/form/useFormValues.d.ts +4 -0
- package/dist/ra-core/src/form/useFormValues.js +9 -0
- package/dist/ra-core/src/form/useInput.d.ts +33 -0
- package/dist/ra-core/src/form/useInput.js +100 -0
- package/dist/ra-core/src/form/useRecordFromLocation.d.ts +22 -0
- package/dist/ra-core/src/form/useRecordFromLocation.js +59 -0
- package/dist/ra-core/src/form/useSuggestions.d.ts +43 -0
- package/dist/ra-core/src/form/useSuggestions.js +186 -0
- package/dist/ra-core/src/form/useWarnWhenUnsavedChanges.d.ts +7 -0
- package/dist/ra-core/src/form/useWarnWhenUnsavedChanges.js +74 -0
- package/dist/ra-core/src/form/validation/ValidationError.d.ts +5 -0
- package/dist/ra-core/src/form/validation/ValidationError.js +22 -0
- package/dist/ra-core/src/form/validation/getSimpleValidationResolver.d.ts +31 -0
- package/dist/ra-core/src/form/validation/getSimpleValidationResolver.js +87 -0
- package/dist/ra-core/src/form/validation/index.d.ts +7 -0
- package/dist/ra-core/src/form/validation/index.js +7 -0
- package/dist/ra-core/src/form/validation/setSubmissionErrors.d.ts +21 -0
- package/dist/ra-core/src/form/validation/setSubmissionErrors.js +34 -0
- package/dist/ra-core/src/form/validation/useGetValidationErrorMessage.d.ts +26 -0
- package/dist/ra-core/src/form/validation/useGetValidationErrorMessage.js +35 -0
- package/dist/ra-core/src/form/validation/useNotifyIsFormInvalid.d.ts +9 -0
- package/dist/ra-core/src/form/validation/useNotifyIsFormInvalid.js +30 -0
- package/dist/ra-core/src/form/validation/useUnique.d.ts +57 -0
- package/dist/ra-core/src/form/validation/useUnique.js +107 -0
- package/dist/ra-core/src/form/validation/validate.d.ts +168 -0
- package/dist/ra-core/src/form/validation/validate.js +218 -0
- package/dist/ra-core/src/i18n/I18nContext.d.ts +3 -0
- package/dist/ra-core/src/i18n/I18nContext.js +11 -0
- package/dist/ra-core/src/i18n/I18nContextProvider.d.ts +10 -0
- package/dist/ra-core/src/i18n/I18nContextProvider.js +47 -0
- package/dist/ra-core/src/i18n/TestTranslationProvider.d.ts +8 -0
- package/dist/ra-core/src/i18n/TestTranslationProvider.js +20 -0
- package/dist/ra-core/src/i18n/TranslatableContext.d.ts +16 -0
- package/dist/ra-core/src/i18n/TranslatableContext.js +2 -0
- package/dist/ra-core/src/i18n/TranslatableContextProvider.d.ts +6 -0
- package/dist/ra-core/src/i18n/TranslatableContextProvider.js +5 -0
- package/dist/ra-core/src/i18n/Translate.d.ts +7 -0
- package/dist/ra-core/src/i18n/Translate.js +10 -0
- package/dist/ra-core/src/i18n/TranslationMessages.d.ts +221 -0
- package/dist/ra-core/src/i18n/TranslationMessages.js +1 -0
- package/dist/ra-core/src/i18n/TranslationUtils.d.ts +60 -0
- package/dist/ra-core/src/i18n/TranslationUtils.js +70 -0
- package/dist/ra-core/src/i18n/index.d.ts +20 -0
- package/dist/ra-core/src/i18n/index.js +20 -0
- package/dist/ra-core/src/i18n/substituteTokens.d.ts +8 -0
- package/dist/ra-core/src/i18n/substituteTokens.js +18 -0
- package/dist/ra-core/src/i18n/useI18nProvider.d.ts +12 -0
- package/dist/ra-core/src/i18n/useI18nProvider.js +14 -0
- package/dist/ra-core/src/i18n/useLocale.d.ts +17 -0
- package/dist/ra-core/src/i18n/useLocale.js +21 -0
- package/dist/ra-core/src/i18n/useLocaleState.d.ts +27 -0
- package/dist/ra-core/src/i18n/useLocaleState.js +34 -0
- package/dist/ra-core/src/i18n/useLocales.d.ts +31 -0
- package/dist/ra-core/src/i18n/useLocales.js +28 -0
- package/dist/ra-core/src/i18n/useResourceTranslation.d.ts +8 -0
- package/dist/ra-core/src/i18n/useResourceTranslation.js +18 -0
- package/dist/ra-core/src/i18n/useSetLocale.d.ts +25 -0
- package/dist/ra-core/src/i18n/useSetLocale.js +29 -0
- package/dist/ra-core/src/i18n/useTranslatable.d.ts +29 -0
- package/dist/ra-core/src/i18n/useTranslatable.js +98 -0
- package/dist/ra-core/src/i18n/useTranslatableContext.d.ts +31 -0
- package/dist/ra-core/src/i18n/useTranslatableContext.js +38 -0
- package/dist/ra-core/src/i18n/useTranslate.d.ts +21 -0
- package/dist/ra-core/src/i18n/useTranslate.js +29 -0
- package/dist/ra-core/src/i18n/useTranslateLabel.d.ts +6 -0
- package/dist/ra-core/src/i18n/useTranslateLabel.js +26 -0
- package/dist/ra-core/src/index.d.ts +16 -0
- package/dist/ra-core/src/index.js +16 -0
- package/dist/ra-core/src/inference/InferredElement.d.ts +12 -0
- package/dist/ra-core/src/inference/InferredElement.js +40 -0
- package/dist/ra-core/src/inference/assertions.d.ts +26 -0
- package/dist/ra-core/src/inference/assertions.js +38 -0
- package/dist/ra-core/src/inference/getElementsFromRecords.d.ts +35 -0
- package/dist/ra-core/src/inference/getElementsFromRecords.js +39 -0
- package/dist/ra-core/src/inference/getValuesFromRecords.d.ts +28 -0
- package/dist/ra-core/src/inference/getValuesFromRecords.js +40 -0
- package/dist/ra-core/src/inference/index.d.ts +6 -0
- package/dist/ra-core/src/inference/index.js +6 -0
- package/dist/ra-core/src/inference/inferElementFromValues.d.ts +41 -0
- package/dist/ra-core/src/inference/inferElementFromValues.js +161 -0
- package/dist/ra-core/src/inference/inferTypeFromValues.d.ts +21 -0
- package/dist/ra-core/src/inference/inferTypeFromValues.js +141 -0
- package/dist/ra-core/src/inference/types.d.ts +9 -0
- package/dist/ra-core/src/inference/types.js +1 -0
- package/dist/ra-core/src/notification/AddNotificationContext.d.ts +2 -0
- package/dist/ra-core/src/notification/AddNotificationContext.js +2 -0
- package/dist/ra-core/src/notification/CloseNotificationContext.d.ts +2 -0
- package/dist/ra-core/src/notification/CloseNotificationContext.js +2 -0
- package/dist/ra-core/src/notification/NotificationContext.d.ts +37 -0
- package/dist/ra-core/src/notification/NotificationContext.js +35 -0
- package/dist/ra-core/src/notification/NotificationContextProvider.d.ts +3 -0
- package/dist/ra-core/src/notification/NotificationContextProvider.js +31 -0
- package/dist/ra-core/src/notification/index.d.ts +9 -0
- package/dist/ra-core/src/notification/index.js +9 -0
- package/dist/ra-core/src/notification/types.d.ts +14 -0
- package/dist/ra-core/src/notification/types.js +1 -0
- package/dist/ra-core/src/notification/useAddNotificationContext.d.ts +1 -0
- package/dist/ra-core/src/notification/useAddNotificationContext.js +3 -0
- package/dist/ra-core/src/notification/useCloseNotification.d.ts +1 -0
- package/dist/ra-core/src/notification/useCloseNotification.js +9 -0
- package/dist/ra-core/src/notification/useNotificationContext.d.ts +1 -0
- package/dist/ra-core/src/notification/useNotificationContext.js +3 -0
- package/dist/ra-core/src/notification/useNotify.d.ts +20 -0
- package/dist/ra-core/src/notification/useNotify.js +28 -0
- package/dist/ra-core/src/preferences/PreferenceKeyContext.d.ts +7 -0
- package/dist/ra-core/src/preferences/PreferenceKeyContext.js +7 -0
- package/dist/ra-core/src/preferences/PreferencesEditorContext.d.ts +16 -0
- package/dist/ra-core/src/preferences/PreferencesEditorContext.js +2 -0
- package/dist/ra-core/src/preferences/PreferencesEditorContextProvider.d.ts +3 -0
- package/dist/ra-core/src/preferences/PreferencesEditorContextProvider.js +48 -0
- package/dist/ra-core/src/preferences/index.d.ts +7 -0
- package/dist/ra-core/src/preferences/index.js +7 -0
- package/dist/ra-core/src/preferences/usePreference.d.ts +18 -0
- package/dist/ra-core/src/preferences/usePreference.js +10 -0
- package/dist/ra-core/src/preferences/usePreferenceInput.d.ts +22 -0
- package/dist/ra-core/src/preferences/usePreferenceInput.js +43 -0
- package/dist/ra-core/src/preferences/usePreferencesEditor.d.ts +2 -0
- package/dist/ra-core/src/preferences/usePreferencesEditor.js +9 -0
- package/dist/ra-core/src/preferences/useSetInspectorTitle.d.ts +7 -0
- package/dist/ra-core/src/preferences/useSetInspectorTitle.js +19 -0
- package/dist/ra-core/src/routing/AdminRouter.d.ts +13 -0
- package/dist/ra-core/src/routing/AdminRouter.js +15 -0
- package/dist/ra-core/src/routing/BasenameContext.d.ts +1 -0
- package/dist/ra-core/src/routing/BasenameContext.js +2 -0
- package/dist/ra-core/src/routing/BasenameContextProvider.d.ts +12 -0
- package/dist/ra-core/src/routing/BasenameContextProvider.js +11 -0
- package/dist/ra-core/src/routing/LinkBase.d.ts +17 -0
- package/dist/ra-core/src/routing/LinkBase.js +22 -0
- package/dist/ra-core/src/routing/Navigate.d.ts +14 -0
- package/dist/ra-core/src/routing/Navigate.js +17 -0
- package/dist/ra-core/src/routing/Outlet.d.ts +19 -0
- package/dist/ra-core/src/routing/Outlet.js +22 -0
- package/dist/ra-core/src/routing/RestoreScrollPosition.d.ts +24 -0
- package/dist/ra-core/src/routing/RestoreScrollPosition.js +23 -0
- package/dist/ra-core/src/routing/RouterProvider.d.ts +163 -0
- package/dist/ra-core/src/routing/RouterProvider.js +1 -0
- package/dist/ra-core/src/routing/RouterProviderContext.d.ts +15 -0
- package/dist/ra-core/src/routing/RouterProviderContext.js +19 -0
- package/dist/ra-core/src/routing/TestMemoryRouter.d.ts +21 -0
- package/dist/ra-core/src/routing/TestMemoryRouter.js +42 -0
- package/dist/ra-core/src/routing/adapters/reactRouterProvider.d.ts +6 -0
- package/dist/ra-core/src/routing/adapters/reactRouterProvider.js +86 -0
- package/dist/ra-core/src/routing/index.d.ts +28 -0
- package/dist/ra-core/src/routing/index.js +28 -0
- package/dist/ra-core/src/routing/types.d.ts +3 -0
- package/dist/ra-core/src/routing/types.js +1 -0
- package/dist/ra-core/src/routing/useBasename.d.ts +21 -0
- package/dist/ra-core/src/routing/useBasename.js +23 -0
- package/dist/ra-core/src/routing/useBlocker.d.ts +14 -0
- package/dist/ra-core/src/routing/useBlocker.js +17 -0
- package/dist/ra-core/src/routing/useCanBlock.d.ts +7 -0
- package/dist/ra-core/src/routing/useCanBlock.js +11 -0
- package/dist/ra-core/src/routing/useCreatePath.d.ts +42 -0
- package/dist/ra-core/src/routing/useCreatePath.js +69 -0
- package/dist/ra-core/src/routing/useGetPathForRecord.d.ts +42 -0
- package/dist/ra-core/src/routing/useGetPathForRecord.js +135 -0
- package/dist/ra-core/src/routing/useGetPathForRecordCallback.d.ts +6 -0
- package/dist/ra-core/src/routing/useGetPathForRecordCallback.js +82 -0
- package/dist/ra-core/src/routing/useInRouterContext.d.ts +11 -0
- package/dist/ra-core/src/routing/useInRouterContext.js +15 -0
- package/dist/ra-core/src/routing/useLocation.d.ts +10 -0
- package/dist/ra-core/src/routing/useLocation.js +13 -0
- package/dist/ra-core/src/routing/useMatch.d.ts +15 -0
- package/dist/ra-core/src/routing/useMatch.js +15 -0
- package/dist/ra-core/src/routing/useMatchPath.d.ts +17 -0
- package/dist/ra-core/src/routing/useMatchPath.js +17 -0
- package/dist/ra-core/src/routing/useNavigate.d.ts +12 -0
- package/dist/ra-core/src/routing/useNavigate.js +15 -0
- package/dist/ra-core/src/routing/useParams.d.ts +9 -0
- package/dist/ra-core/src/routing/useParams.js +13 -0
- package/dist/ra-core/src/routing/useRedirect.d.ts +30 -0
- package/dist/ra-core/src/routing/useRedirect.js +66 -0
- package/dist/ra-core/src/routing/useResetErrorBoundaryOnLocationChange.d.ts +7 -0
- package/dist/ra-core/src/routing/useResetErrorBoundaryOnLocationChange.js +17 -0
- package/dist/ra-core/src/routing/useRestoreScrollPosition.d.ts +40 -0
- package/dist/ra-core/src/routing/useRestoreScrollPosition.js +70 -0
- package/dist/ra-core/src/routing/useScrollToTop.d.ts +22 -0
- package/dist/ra-core/src/routing/useScrollToTop.js +33 -0
- package/dist/ra-core/src/routing/useSplatPathBase.d.ts +13 -0
- package/dist/ra-core/src/routing/useSplatPathBase.js +21 -0
- package/dist/ra-core/src/store/StoreContext.d.ts +2 -0
- package/dist/ra-core/src/store/StoreContext.js +4 -0
- package/dist/ra-core/src/store/StoreContextProvider.d.ts +7 -0
- package/dist/ra-core/src/store/StoreContextProvider.js +12 -0
- package/dist/ra-core/src/store/StoreSetter.d.ts +37 -0
- package/dist/ra-core/src/store/StoreSetter.js +40 -0
- package/dist/ra-core/src/store/index.d.ts +11 -0
- package/dist/ra-core/src/store/index.js +11 -0
- package/dist/ra-core/src/store/localStorageStore.d.ts +27 -0
- package/dist/ra-core/src/store/localStorageStore.js +198 -0
- package/dist/ra-core/src/store/memoryStore.d.ts +15 -0
- package/dist/ra-core/src/store/memoryStore.js +108 -0
- package/dist/ra-core/src/store/types.d.ts +11 -0
- package/dist/ra-core/src/store/types.js +1 -0
- package/dist/ra-core/src/store/useRemoveFromStore.d.ts +17 -0
- package/dist/ra-core/src/store/useRemoveFromStore.js +29 -0
- package/dist/ra-core/src/store/useRemoveItemsFromStore.d.ts +17 -0
- package/dist/ra-core/src/store/useRemoveItemsFromStore.js +29 -0
- package/dist/ra-core/src/store/useResetStore.d.ts +17 -0
- package/dist/ra-core/src/store/useResetStore.js +21 -0
- package/dist/ra-core/src/store/useStore.d.ts +48 -0
- package/dist/ra-core/src/store/useStore.js +32 -0
- package/dist/ra-core/src/store/useStoreContext.d.ts +4 -0
- package/dist/ra-core/src/store/useStoreContext.js +6 -0
- package/dist/ra-core/src/test-ui/Admin.d.ts +2 -0
- package/dist/ra-core/src/test-ui/Admin.js +8 -0
- package/dist/ra-core/src/test-ui/ArrayInput.d.ts +10 -0
- package/dist/ra-core/src/test-ui/ArrayInput.js +8 -0
- package/dist/ra-core/src/test-ui/AutocompleteArrayInput.d.ts +5 -0
- package/dist/ra-core/src/test-ui/AutocompleteArrayInput.js +5 -0
- package/dist/ra-core/src/test-ui/AutocompleteInput.d.ts +5 -0
- package/dist/ra-core/src/test-ui/AutocompleteInput.js +29 -0
- package/dist/ra-core/src/test-ui/BooleanInput.d.ts +2 -0
- package/dist/ra-core/src/test-ui/BooleanInput.js +10 -0
- package/dist/ra-core/src/test-ui/Confirm.d.ts +10 -0
- package/dist/ra-core/src/test-ui/Confirm.js +25 -0
- package/dist/ra-core/src/test-ui/CreateButton.d.ts +3 -0
- package/dist/ra-core/src/test-ui/CreateButton.js +9 -0
- package/dist/ra-core/src/test-ui/DataTable.d.ts +15 -0
- package/dist/ra-core/src/test-ui/DataTable.js +88 -0
- package/dist/ra-core/src/test-ui/DeleteButton.d.ts +5 -0
- package/dist/ra-core/src/test-ui/DeleteButton.js +18 -0
- package/dist/ra-core/src/test-ui/EditButton.d.ts +5 -0
- package/dist/ra-core/src/test-ui/EditButton.js +13 -0
- package/dist/ra-core/src/test-ui/Layout.d.ts +4 -0
- package/dist/ra-core/src/test-ui/Layout.js +36 -0
- package/dist/ra-core/src/test-ui/Notification.d.ts +13 -0
- package/dist/ra-core/src/test-ui/Notification.js +109 -0
- package/dist/ra-core/src/test-ui/Pagination.d.ts +1 -0
- package/dist/ra-core/src/test-ui/Pagination.js +28 -0
- package/dist/ra-core/src/test-ui/PrevNextButtons.d.ts +5 -0
- package/dist/ra-core/src/test-ui/PrevNextButtons.js +18 -0
- package/dist/ra-core/src/test-ui/ShowButton.d.ts +5 -0
- package/dist/ra-core/src/test-ui/ShowButton.js +13 -0
- package/dist/ra-core/src/test-ui/SimpleForm.d.ts +2 -0
- package/dist/ra-core/src/test-ui/SimpleForm.js +11 -0
- package/dist/ra-core/src/test-ui/SimpleFormIterator.d.ts +46 -0
- package/dist/ra-core/src/test-ui/SimpleFormIterator.js +101 -0
- package/dist/ra-core/src/test-ui/SimpleList.d.ts +6 -0
- package/dist/ra-core/src/test-ui/SimpleList.js +12 -0
- package/dist/ra-core/src/test-ui/SimpleShowLayout.d.ts +4 -0
- package/dist/ra-core/src/test-ui/SimpleShowLayout.js +3 -0
- package/dist/ra-core/src/test-ui/TextInput.d.ts +6 -0
- package/dist/ra-core/src/test-ui/TextInput.js +9 -0
- package/dist/ra-core/src/test-ui/defaultI18nProvider.d.ts +2 -0
- package/dist/ra-core/src/test-ui/defaultI18nProvider.js +10 -0
- package/dist/ra-core/src/test-ui/index.d.ts +21 -0
- package/dist/ra-core/src/test-ui/index.js +21 -0
- package/dist/ra-core/src/types.d.ts +284 -0
- package/dist/ra-core/src/types.js +5 -0
- package/dist/ra-core/src/util/FieldTitle.d.ts +17 -0
- package/dist/ra-core/src/util/FieldTitle.js +24 -0
- package/dist/ra-core/src/util/Ready.d.ts +2 -0
- package/dist/ra-core/src/util/Ready.js +57 -0
- package/dist/ra-core/src/util/asyncDebounce.d.ts +7 -0
- package/dist/ra-core/src/util/asyncDebounce.js +29 -0
- package/dist/ra-core/src/util/escapePath.d.ts +11 -0
- package/dist/ra-core/src/util/escapePath.js +10 -0
- package/dist/ra-core/src/util/genericMemo.d.ts +5 -0
- package/dist/ra-core/src/util/genericMemo.js +14 -0
- package/dist/ra-core/src/util/getFieldLabelTranslationArgs.d.ts +22 -0
- package/dist/ra-core/src/util/getFieldLabelTranslationArgs.js +73 -0
- package/dist/ra-core/src/util/getMutationMode.d.ts +1 -0
- package/dist/ra-core/src/util/getMutationMode.js +13 -0
- package/dist/ra-core/src/util/hooks.d.ts +15 -0
- package/dist/ra-core/src/util/hooks.js +73 -0
- package/dist/ra-core/src/util/index.d.ts +20 -0
- package/dist/ra-core/src/util/index.js +19 -0
- package/dist/ra-core/src/util/mergeRefs.d.ts +2 -0
- package/dist/ra-core/src/util/mergeRefs.js +13 -0
- package/dist/ra-core/src/util/removeEmpty.d.ts +2 -0
- package/dist/ra-core/src/util/removeEmpty.js +16 -0
- package/dist/ra-core/src/util/removeKey.d.ts +2 -0
- package/dist/ra-core/src/util/removeKey.js +22 -0
- package/dist/ra-core/src/util/shallowEqual.d.ts +1 -0
- package/dist/ra-core/src/util/shallowEqual.js +29 -0
- package/dist/ra-core/src/util/useCheckForApplicationUpdate.d.ts +21 -0
- package/dist/ra-core/src/util/useCheckForApplicationUpdate.js +84 -0
- package/dist/ra-core/src/util/useDebouncedEvent.d.ts +8 -0
- package/dist/ra-core/src/util/useDebouncedEvent.js +28 -0
- package/dist/ra-core/src/util/useEvent.d.ts +7 -0
- package/dist/ra-core/src/util/useEvent.js +19 -0
- package/dist/ra-core/src/util/useFieldValue.d.ts +21 -0
- package/dist/ra-core/src/util/useFieldValue.js +27 -0
- package/dist/ra-core/src/util/useWhyDidYouUpdate.d.ts +12 -0
- package/dist/ra-core/src/util/useWhyDidYouUpdate.js +42 -0
- package/dist/ra-core/src/util/warning.d.ts +2 -0
- package/dist/ra-core/src/util/warning.js +5 -0
- package/dist/resource/Resource.d.ts +14 -0
- package/dist/resource/Resource.js +31 -0
- package/dist/resource/ResourceSchema.d.ts +170 -13
- package/dist/resource/ResourceSchema.js +118 -20
- package/dist/resource/ResourceSchemaProvider.d.ts +2 -1
- package/dist/resource/ResourceSchemaProvider.js +9 -9
- package/dist/resource/SchemaRegistry.d.ts +64 -5
- package/dist/resource/SchemaRegistry.js +189 -22
- package/dist/resource/index.d.ts +2 -0
- package/dist/resource/index.js +2 -0
- package/dist/resource/useConstructedPageTitle.d.ts +1 -0
- package/dist/resource/useConstructedPageTitle.js +27 -0
- package/dist/routing/index.d.ts +2 -0
- package/dist/routing/index.js +2 -0
- package/dist/routing/useCreatePath.d.ts +7 -0
- package/dist/routing/useCreatePath.js +36 -0
- package/dist/routing/useGetPathForRecord.d.ts +11 -0
- package/dist/routing/useGetPathForRecord.js +94 -0
- package/dist/settings/SettingsContext.d.ts +16 -0
- package/dist/settings/SettingsContext.js +3 -0
- package/dist/settings/useSettingValue.d.ts +15 -0
- package/dist/settings/useSettingValue.js +23 -0
- package/dist/strato-core/src/core/Resource.d.ts +0 -0
- package/dist/strato-core/src/core/Resource.js +1 -0
- package/dist/strato-core/src/core/index.d.ts +0 -0
- package/dist/strato-core/src/core/index.js +1 -0
- package/dist/strato-core/src/index.d.ts +3 -0
- package/dist/strato-core/src/index.js +4 -0
- package/dist/strato-core/src/ra-messages.d.ts +1 -0
- package/dist/strato-core/src/ra-messages.js +296 -0
- package/dist/strato-core/src/resource/FieldSchema.d.ts +18 -0
- package/dist/strato-core/src/resource/FieldSchema.js +19 -0
- package/dist/strato-core/src/resource/InputSchema.d.ts +18 -0
- package/dist/strato-core/src/resource/InputSchema.js +19 -0
- package/dist/strato-core/src/resource/ResourceContext.d.ts +2 -0
- package/dist/strato-core/src/resource/ResourceContext.js +3 -0
- package/dist/strato-core/src/resource/ResourceSchema.d.ts +33 -0
- package/dist/strato-core/src/resource/ResourceSchema.js +90 -0
- package/dist/strato-core/src/resource/ResourceSchemaProvider.d.ts +15 -0
- package/dist/strato-core/src/resource/ResourceSchemaProvider.js +71 -0
- package/dist/strato-core/src/resource/SchemaRegistry.d.ts +71 -0
- package/dist/strato-core/src/resource/SchemaRegistry.js +212 -0
- package/dist/strato-core/src/resource/index.d.ts +6 -0
- package/dist/strato-core/src/resource/index.js +6 -0
- package/package.json +9 -3
- package/src/index.ts +3 -4
- package/src/resource/Resource.test.tsx +87 -0
- package/src/resource/Resource.tsx +62 -0
- package/src/resource/ResourceSchema.tsx +378 -57
- package/src/resource/ResourceSchemaProvider.tsx +17 -27
- package/src/resource/SchemaRegistry.tsx +295 -46
- package/src/resource/index.ts +2 -0
- package/src/resource/useConstructedPageTitle.ts +31 -0
- package/src/routing/index.ts +2 -0
- package/src/routing/useCreatePath.test.tsx +38 -0
- package/src/routing/useCreatePath.ts +40 -0
- package/src/routing/useGetPathForRecord.ts +127 -0
- package/src/settings/SettingsContext.ts +20 -0
- package/src/settings/useSettingValue.ts +32 -0
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
import { useEffect, useMemo } from 'react';
|
|
2
|
+
import { useQuery, useQueryClient, } from '@tanstack/react-query';
|
|
3
|
+
import { useDataProvider } from './useDataProvider';
|
|
4
|
+
import { useEvent } from '../util';
|
|
5
|
+
/**
|
|
6
|
+
* Call the dataProvider.getManyReference() method and return the resolved result
|
|
7
|
+
* as well as the loading state.
|
|
8
|
+
*
|
|
9
|
+
* The return value updates according to the request state:
|
|
10
|
+
*
|
|
11
|
+
* - start: { isPending: true, refetch }
|
|
12
|
+
* - success: { data: [data from store], total: [total from response], isPending: false, refetch }
|
|
13
|
+
* - error: { error: [error from response], isPending: false, refetch }
|
|
14
|
+
*
|
|
15
|
+
* This hook will return the cached result when called a second time
|
|
16
|
+
* with the same parameters, until the response arrives.
|
|
17
|
+
*
|
|
18
|
+
* @param {string} resource The resource name, e.g. 'posts'
|
|
19
|
+
* @param {Params} params The getManyReference parameters { target, id, pagination, sort, filter, meta }
|
|
20
|
+
* @param {Object} options Options object to pass to the queryClient.
|
|
21
|
+
* May include side effects to be executed upon success or failure, e.g. { onSuccess: () => { refresh(); } }
|
|
22
|
+
*
|
|
23
|
+
* @typedef Params
|
|
24
|
+
* @prop params.target The target resource key, e.g. 'post_id'
|
|
25
|
+
* @prop params.id The identifier of the record to look for in target, e.g. '123'
|
|
26
|
+
* @prop params.pagination The request pagination { page, perPage }, e.g. { page: 1, perPage: 10 }
|
|
27
|
+
* @prop params.sort The request sort { field, order }, e.g. { field: 'id', order: 'DESC' }
|
|
28
|
+
* @prop params.filter The request filters, e.g. { title: 'hello, world' }
|
|
29
|
+
* @prop params.meta Optional meta parameters
|
|
30
|
+
*
|
|
31
|
+
* @returns The current request state. Destructure as { data, total, error, isPending, refetch }.
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
*
|
|
35
|
+
* import { useGetManyReference, useRecordContext } from 'react-admin';
|
|
36
|
+
*
|
|
37
|
+
* const PostComments = () => {
|
|
38
|
+
* const record = useRecordContext();
|
|
39
|
+
* // fetch all comments related to the current record
|
|
40
|
+
* const { data, isPending, error } = useGetManyReference(
|
|
41
|
+
* 'comments',
|
|
42
|
+
* { target: 'post_id', id: record.id, pagination: { page: 1, perPage: 10 }, sort: { field: 'published_at', order: 'DESC' } }
|
|
43
|
+
* );
|
|
44
|
+
* if (isPending) { return <Loading />; }
|
|
45
|
+
* if (error) { return <p>ERROR</p>; }
|
|
46
|
+
* return <ul>{data.map(comment =>
|
|
47
|
+
* <li key={comment.id}>{comment.body}</li>
|
|
48
|
+
* )}</ul>;
|
|
49
|
+
* };
|
|
50
|
+
*/
|
|
51
|
+
export const useGetManyReference = (resource, params = {}, options = {}) => {
|
|
52
|
+
const { target, id, pagination = { page: 1, perPage: 25 }, sort = { field: 'id', order: 'DESC' }, filter = {}, meta, } = params;
|
|
53
|
+
const dataProvider = useDataProvider();
|
|
54
|
+
const queryClient = useQueryClient();
|
|
55
|
+
const { onError = noop, onSuccess = noop, onSettled = noop, ...queryOptions } = options;
|
|
56
|
+
const onSuccessEvent = useEvent(onSuccess);
|
|
57
|
+
const onErrorEvent = useEvent(onError);
|
|
58
|
+
const onSettledEvent = useEvent(onSettled);
|
|
59
|
+
const result = useQuery({
|
|
60
|
+
queryKey: [
|
|
61
|
+
resource,
|
|
62
|
+
'getManyReference',
|
|
63
|
+
{ target, id, pagination, sort, filter, meta },
|
|
64
|
+
],
|
|
65
|
+
queryFn: queryParams => {
|
|
66
|
+
if (!target || id == null) {
|
|
67
|
+
// check at runtime to support partial parameters with the enabled option
|
|
68
|
+
return Promise.reject(new Error('target and id are required'));
|
|
69
|
+
}
|
|
70
|
+
return dataProvider
|
|
71
|
+
.getManyReference(resource, {
|
|
72
|
+
target,
|
|
73
|
+
id,
|
|
74
|
+
pagination,
|
|
75
|
+
sort,
|
|
76
|
+
filter,
|
|
77
|
+
meta,
|
|
78
|
+
signal: dataProvider.supportAbortSignal === true
|
|
79
|
+
? queryParams.signal
|
|
80
|
+
: undefined,
|
|
81
|
+
})
|
|
82
|
+
.then(({ data, total, pageInfo, meta }) => ({
|
|
83
|
+
data,
|
|
84
|
+
total,
|
|
85
|
+
pageInfo,
|
|
86
|
+
meta,
|
|
87
|
+
}));
|
|
88
|
+
},
|
|
89
|
+
...queryOptions,
|
|
90
|
+
});
|
|
91
|
+
useEffect(() => {
|
|
92
|
+
if (result.data === undefined)
|
|
93
|
+
return;
|
|
94
|
+
// optimistically populate the getOne cache
|
|
95
|
+
result.data?.data?.forEach(record => {
|
|
96
|
+
queryClient.setQueryData([resource, 'getOne', { id: String(record.id), meta }], oldRecord => oldRecord ?? record);
|
|
97
|
+
});
|
|
98
|
+
onSuccessEvent(result.data);
|
|
99
|
+
}, [queryClient, meta, onSuccessEvent, resource, result.data]);
|
|
100
|
+
useEffect(() => {
|
|
101
|
+
if (result.error == null)
|
|
102
|
+
return;
|
|
103
|
+
onErrorEvent(result.error);
|
|
104
|
+
}, [onErrorEvent, result.error]);
|
|
105
|
+
useEffect(() => {
|
|
106
|
+
if (result.status === 'pending')
|
|
107
|
+
return;
|
|
108
|
+
onSettledEvent(result.data, result.error);
|
|
109
|
+
}, [onSettledEvent, result.data, result.error, result.status]);
|
|
110
|
+
return useMemo(() => result.data
|
|
111
|
+
? {
|
|
112
|
+
...result,
|
|
113
|
+
...result.data,
|
|
114
|
+
}
|
|
115
|
+
: result, [result]);
|
|
116
|
+
};
|
|
117
|
+
const noop = () => undefined;
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { RaRecord, GetOneParams, GetOneResult } from '../types';
|
|
2
|
+
import { UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
|
|
3
|
+
/**
|
|
4
|
+
* Call the dataProvider.getOne() method and return the resolved value
|
|
5
|
+
* as well as the loading state.
|
|
6
|
+
*
|
|
7
|
+
* The return value updates according to the request state:
|
|
8
|
+
*
|
|
9
|
+
* - start: { isPending: true, isFetching: true, refetch }
|
|
10
|
+
* - success: { data: [data from response], isPending: false, refetch }
|
|
11
|
+
* - error: { error: [error from response], isPending: false, refetch }
|
|
12
|
+
*
|
|
13
|
+
* This hook will return the cached result when called a second time
|
|
14
|
+
* with the same parameters, until the response arrives.
|
|
15
|
+
*
|
|
16
|
+
* @param resource The resource name, e.g. 'posts'
|
|
17
|
+
* @param {Params} params The getOne parameters { id, meta }, e.g. { id: 123 }
|
|
18
|
+
* @param {Options} options Options object to pass to the react-query queryClient.
|
|
19
|
+
*
|
|
20
|
+
* @typedef Params
|
|
21
|
+
* @prop id a resource identifier, e.g. 123
|
|
22
|
+
*
|
|
23
|
+
* @typedef Options
|
|
24
|
+
* @prop enabled Flag to conditionally run the query. If it's false, the query will not run
|
|
25
|
+
* @prop onSuccess Side effect function to be executed upon success, e.g. { onSuccess: { refresh: true } }
|
|
26
|
+
* @prop onError Side effect function to be executed upon failure, e.g. { onError: error => notify(error.message) }
|
|
27
|
+
*
|
|
28
|
+
* @returns The current request state. Destructure as { data, error, isPending, refetch }.
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
*
|
|
32
|
+
* import { useGetOne, useRecordContext } from 'react-admin';
|
|
33
|
+
*
|
|
34
|
+
* const UserProfile = () => {
|
|
35
|
+
* const record = useRecordContext();
|
|
36
|
+
* const { data, isPending, error } = useGetOne('users', { id: record.id });
|
|
37
|
+
* if (isPending) { return <Loading />; }
|
|
38
|
+
* if (error) { return <p>ERROR</p>; }
|
|
39
|
+
* return <div>User {data.username}</div>;
|
|
40
|
+
* };
|
|
41
|
+
*/
|
|
42
|
+
export declare const useGetOne: <RecordType extends RaRecord = any, ErrorType = Error>(resource: string, { id, meta }: Partial<GetOneParams<RecordType>>, options?: UseGetOneOptions<RecordType, ErrorType>) => UseGetOneHookValue<RecordType, ErrorType>;
|
|
43
|
+
export type UseGetOneOptions<RecordType extends RaRecord = any, ErrorType = Error> = Omit<UseQueryOptions<GetOneResult<RecordType>['data'], ErrorType>, 'queryKey' | 'queryFn'> & {
|
|
44
|
+
onSuccess?: (data: GetOneResult<RecordType>['data']) => void;
|
|
45
|
+
onError?: (error: ErrorType) => void;
|
|
46
|
+
onSettled?: (data?: GetOneResult<RecordType>['data'], error?: ErrorType | null) => void;
|
|
47
|
+
};
|
|
48
|
+
export type UseGetOneHookValue<RecordType extends RaRecord = any, ErrorType = Error> = UseQueryResult<GetOneResult<RecordType>['data'], ErrorType>;
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { useQuery, } from '@tanstack/react-query';
|
|
2
|
+
import { useDataProvider } from './useDataProvider';
|
|
3
|
+
import { useEffect } from 'react';
|
|
4
|
+
import { useEvent } from '../util';
|
|
5
|
+
/**
|
|
6
|
+
* Call the dataProvider.getOne() method and return the resolved value
|
|
7
|
+
* as well as the loading state.
|
|
8
|
+
*
|
|
9
|
+
* The return value updates according to the request state:
|
|
10
|
+
*
|
|
11
|
+
* - start: { isPending: true, isFetching: true, refetch }
|
|
12
|
+
* - success: { data: [data from response], isPending: false, refetch }
|
|
13
|
+
* - error: { error: [error from response], isPending: false, refetch }
|
|
14
|
+
*
|
|
15
|
+
* This hook will return the cached result when called a second time
|
|
16
|
+
* with the same parameters, until the response arrives.
|
|
17
|
+
*
|
|
18
|
+
* @param resource The resource name, e.g. 'posts'
|
|
19
|
+
* @param {Params} params The getOne parameters { id, meta }, e.g. { id: 123 }
|
|
20
|
+
* @param {Options} options Options object to pass to the react-query queryClient.
|
|
21
|
+
*
|
|
22
|
+
* @typedef Params
|
|
23
|
+
* @prop id a resource identifier, e.g. 123
|
|
24
|
+
*
|
|
25
|
+
* @typedef Options
|
|
26
|
+
* @prop enabled Flag to conditionally run the query. If it's false, the query will not run
|
|
27
|
+
* @prop onSuccess Side effect function to be executed upon success, e.g. { onSuccess: { refresh: true } }
|
|
28
|
+
* @prop onError Side effect function to be executed upon failure, e.g. { onError: error => notify(error.message) }
|
|
29
|
+
*
|
|
30
|
+
* @returns The current request state. Destructure as { data, error, isPending, refetch }.
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
*
|
|
34
|
+
* import { useGetOne, useRecordContext } from 'react-admin';
|
|
35
|
+
*
|
|
36
|
+
* const UserProfile = () => {
|
|
37
|
+
* const record = useRecordContext();
|
|
38
|
+
* const { data, isPending, error } = useGetOne('users', { id: record.id });
|
|
39
|
+
* if (isPending) { return <Loading />; }
|
|
40
|
+
* if (error) { return <p>ERROR</p>; }
|
|
41
|
+
* return <div>User {data.username}</div>;
|
|
42
|
+
* };
|
|
43
|
+
*/
|
|
44
|
+
export const useGetOne = (resource, { id, meta }, options = {}) => {
|
|
45
|
+
const dataProvider = useDataProvider();
|
|
46
|
+
const { onError = noop, onSuccess = noop, onSettled = noop, enabled, ...queryOptions } = options;
|
|
47
|
+
const onSuccessEvent = useEvent(onSuccess);
|
|
48
|
+
const onErrorEvent = useEvent(onError);
|
|
49
|
+
const onSettledEvent = useEvent(onSettled);
|
|
50
|
+
const result = useQuery({
|
|
51
|
+
// Sometimes the id comes as a string (e.g. when read from the URL in a Show view).
|
|
52
|
+
// Sometimes the id comes as a number (e.g. when read from a Record in useGetList response).
|
|
53
|
+
// As the react-query cache is type-sensitive, we always stringify the identifier to get a match
|
|
54
|
+
queryKey: [resource, 'getOne', { id: String(id), meta }],
|
|
55
|
+
queryFn: queryParams => id == null
|
|
56
|
+
? Promise.reject('useGetOne: id cannot be null')
|
|
57
|
+
: dataProvider
|
|
58
|
+
.getOne(resource, {
|
|
59
|
+
id,
|
|
60
|
+
meta,
|
|
61
|
+
signal: dataProvider.supportAbortSignal === true
|
|
62
|
+
? queryParams.signal
|
|
63
|
+
: undefined,
|
|
64
|
+
})
|
|
65
|
+
.then(({ data }) => data),
|
|
66
|
+
enabled: enabled ?? id != null,
|
|
67
|
+
...queryOptions,
|
|
68
|
+
});
|
|
69
|
+
useEffect(() => {
|
|
70
|
+
if (result.data === undefined ||
|
|
71
|
+
result.error != null ||
|
|
72
|
+
result.isFetching)
|
|
73
|
+
return;
|
|
74
|
+
onSuccessEvent(result.data);
|
|
75
|
+
}, [onSuccessEvent, result.data, result.error, result.isFetching]);
|
|
76
|
+
useEffect(() => {
|
|
77
|
+
if (result.error == null || result.isFetching)
|
|
78
|
+
return;
|
|
79
|
+
onErrorEvent(result.error);
|
|
80
|
+
}, [onErrorEvent, result.error, result.isFetching]);
|
|
81
|
+
useEffect(() => {
|
|
82
|
+
if (result.status === 'pending' || result.isFetching)
|
|
83
|
+
return;
|
|
84
|
+
onSettledEvent(result.data, result.error);
|
|
85
|
+
}, [
|
|
86
|
+
onSettledEvent,
|
|
87
|
+
result.data,
|
|
88
|
+
result.error,
|
|
89
|
+
result.status,
|
|
90
|
+
result.isFetching,
|
|
91
|
+
]);
|
|
92
|
+
return result;
|
|
93
|
+
};
|
|
94
|
+
const noop = () => undefined;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { Identifier } from '../types';
|
|
2
|
+
/**
|
|
3
|
+
* Helper hook to get the current `recordId`.
|
|
4
|
+
*
|
|
5
|
+
* `recordId` is obtained from parameters if passed as a parameter, or from the `RecordContext` if there is one, or, lastly, from the router URL.
|
|
6
|
+
*
|
|
7
|
+
* @param {any} recordId optional if used inside a RecordContextProvider or if recordId can be guessed from the URL
|
|
8
|
+
*
|
|
9
|
+
* @returns The `recordId` determined in this manner.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* const recordId = useGetRecordId();
|
|
13
|
+
*/
|
|
14
|
+
export declare function useGetRecordId(recordId?: Identifier): Identifier;
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { useRecordContext } from '../controller';
|
|
2
|
+
import { useParams } from '../routing';
|
|
3
|
+
/**
|
|
4
|
+
* Helper hook to get the current `recordId`.
|
|
5
|
+
*
|
|
6
|
+
* `recordId` is obtained from parameters if passed as a parameter, or from the `RecordContext` if there is one, or, lastly, from the router URL.
|
|
7
|
+
*
|
|
8
|
+
* @param {any} recordId optional if used inside a RecordContextProvider or if recordId can be guessed from the URL
|
|
9
|
+
*
|
|
10
|
+
* @returns The `recordId` determined in this manner.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* const recordId = useGetRecordId();
|
|
14
|
+
*/
|
|
15
|
+
export function useGetRecordId(recordId) {
|
|
16
|
+
const contextRecord = useRecordContext();
|
|
17
|
+
const { id: routeId } = useParams();
|
|
18
|
+
const actualRecordId = recordId ?? contextRecord?.id ?? routeId;
|
|
19
|
+
if (actualRecordId == null)
|
|
20
|
+
throw new Error(`useGetRecordId could not find the current record id. You need to use it inside a RecordContextProvider, or inside a supported route, or provide the record id to the hook yourself.`);
|
|
21
|
+
return actualRecordId;
|
|
22
|
+
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { InfiniteData, QueryKey, UseInfiniteQueryOptions, UseInfiniteQueryResult } from '@tanstack/react-query';
|
|
2
|
+
import { RaRecord, GetListParams, GetInfiniteListResult } from '../types';
|
|
3
|
+
/**
|
|
4
|
+
* Call the dataProvider.getList() method and return the resolved result
|
|
5
|
+
* as well as the loading state. The return from useInfiniteGetList is equivalent to the return from react-hook form useInfiniteQuery.
|
|
6
|
+
*
|
|
7
|
+
* @see https://tanstack.com/query/v5/docs/react/reference/useInfiniteQuery
|
|
8
|
+
*
|
|
9
|
+
* This hook will return the cached result when called a second time
|
|
10
|
+
* with the same parameters, until the response arrives.
|
|
11
|
+
*
|
|
12
|
+
* @param {string} resource The resource name, e.g. 'posts'
|
|
13
|
+
* @param {Params} params The getList parameters { pagination, sort, filter, meta }
|
|
14
|
+
* @param {Object} options Options object to pass to the queryClient.
|
|
15
|
+
* May include side effects to be executed upon success or failure, e.g. { onSuccess: () => { fetchNextPage(); } }
|
|
16
|
+
*
|
|
17
|
+
* @typedef Params
|
|
18
|
+
* @prop params.pagination The request pagination { page, perPage }, e.g. { page: 1, perPage: 10 }
|
|
19
|
+
* @prop params.sort The request sort { field, order }, e.g. { field: 'id', order: 'DESC' }
|
|
20
|
+
* @prop params.filter The request filters, e.g. { title: 'hello, world' }
|
|
21
|
+
* @prop params.meta Optional meta parameters
|
|
22
|
+
*
|
|
23
|
+
* @returns The current request state. Destructure as { data, total, error, isPending, isSuccess, hasNextPage, fetchNextPage }.
|
|
24
|
+
*
|
|
25
|
+
* @example
|
|
26
|
+
*
|
|
27
|
+
* import { useInfiniteGetList } from 'react-admin';
|
|
28
|
+
*
|
|
29
|
+
* const LatestNews = () => {
|
|
30
|
+
* const { data, total, isPending, error, hasNextPage, fetchNextPage } = useInfiniteGetList(
|
|
31
|
+
* 'posts',
|
|
32
|
+
* { pagination: { page: 1, perPage: 10 }, sort: { field: 'published_at', order: 'DESC' } }
|
|
33
|
+
* );
|
|
34
|
+
* if (isPending) { return <Loading />; }
|
|
35
|
+
* if (error) { return <p>ERROR</p>; }
|
|
36
|
+
* return (
|
|
37
|
+
* <>
|
|
38
|
+
* <ul>
|
|
39
|
+
* {data?.pages.map(page => {
|
|
40
|
+
* return page.data.map(post => (
|
|
41
|
+
* <li key={post.id}>{post.title}</li>
|
|
42
|
+
* ));
|
|
43
|
+
* })}
|
|
44
|
+
* </ul>
|
|
45
|
+
* <div>
|
|
46
|
+
* <button disabled={!hasNextPage} onClick={() => fetchNextPage()}>
|
|
47
|
+
* Fetch next page
|
|
48
|
+
* </button>
|
|
49
|
+
* </div>
|
|
50
|
+
* </>
|
|
51
|
+
* );
|
|
52
|
+
* };
|
|
53
|
+
*/
|
|
54
|
+
export declare const useInfiniteGetList: <RecordType extends RaRecord = any, ErrorType = Error>(resource: string, params?: Partial<GetListParams>, options?: UseInfiniteGetListOptions<RecordType, ErrorType>) => UseInfiniteGetListHookValue<RecordType, ErrorType>;
|
|
55
|
+
export type UseInfiniteGetListOptions<RecordType extends RaRecord = any, ErrorType = Error> = Omit<UseInfiniteQueryOptions<GetInfiniteListResult<RecordType>, ErrorType, InfiniteData<GetInfiniteListResult<RecordType>>, QueryKey, number>, 'queryKey' | 'queryFn' | 'getNextPageParam' | 'getPreviousPageParam' | 'initialPageParam'> & {
|
|
56
|
+
onSuccess?: (data: InfiniteData<GetInfiniteListResult<RecordType>>) => void;
|
|
57
|
+
onError?: (error: ErrorType) => void;
|
|
58
|
+
onSettled?: (data?: InfiniteData<GetInfiniteListResult<RecordType>>, error?: ErrorType | null) => void;
|
|
59
|
+
};
|
|
60
|
+
export type UseInfiniteGetListHookValue<RecordType extends RaRecord = any, ErrorType = Error> = UseInfiniteQueryResult<InfiniteData<GetInfiniteListResult<RecordType>>, ErrorType> & {
|
|
61
|
+
total?: number;
|
|
62
|
+
pageParam?: number;
|
|
63
|
+
meta?: any;
|
|
64
|
+
};
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
import { useInfiniteQuery, useQueryClient, } from '@tanstack/react-query';
|
|
2
|
+
import { useDataProvider } from './useDataProvider';
|
|
3
|
+
import { useEffect, useRef } from 'react';
|
|
4
|
+
import { useEvent } from '../util';
|
|
5
|
+
const MAX_DATA_LENGTH_TO_CACHE = 100;
|
|
6
|
+
/**
|
|
7
|
+
* Call the dataProvider.getList() method and return the resolved result
|
|
8
|
+
* as well as the loading state. The return from useInfiniteGetList is equivalent to the return from react-hook form useInfiniteQuery.
|
|
9
|
+
*
|
|
10
|
+
* @see https://tanstack.com/query/v5/docs/react/reference/useInfiniteQuery
|
|
11
|
+
*
|
|
12
|
+
* This hook will return the cached result when called a second time
|
|
13
|
+
* with the same parameters, until the response arrives.
|
|
14
|
+
*
|
|
15
|
+
* @param {string} resource The resource name, e.g. 'posts'
|
|
16
|
+
* @param {Params} params The getList parameters { pagination, sort, filter, meta }
|
|
17
|
+
* @param {Object} options Options object to pass to the queryClient.
|
|
18
|
+
* May include side effects to be executed upon success or failure, e.g. { onSuccess: () => { fetchNextPage(); } }
|
|
19
|
+
*
|
|
20
|
+
* @typedef Params
|
|
21
|
+
* @prop params.pagination The request pagination { page, perPage }, e.g. { page: 1, perPage: 10 }
|
|
22
|
+
* @prop params.sort The request sort { field, order }, e.g. { field: 'id', order: 'DESC' }
|
|
23
|
+
* @prop params.filter The request filters, e.g. { title: 'hello, world' }
|
|
24
|
+
* @prop params.meta Optional meta parameters
|
|
25
|
+
*
|
|
26
|
+
* @returns The current request state. Destructure as { data, total, error, isPending, isSuccess, hasNextPage, fetchNextPage }.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
*
|
|
30
|
+
* import { useInfiniteGetList } from 'react-admin';
|
|
31
|
+
*
|
|
32
|
+
* const LatestNews = () => {
|
|
33
|
+
* const { data, total, isPending, error, hasNextPage, fetchNextPage } = useInfiniteGetList(
|
|
34
|
+
* 'posts',
|
|
35
|
+
* { pagination: { page: 1, perPage: 10 }, sort: { field: 'published_at', order: 'DESC' } }
|
|
36
|
+
* );
|
|
37
|
+
* if (isPending) { return <Loading />; }
|
|
38
|
+
* if (error) { return <p>ERROR</p>; }
|
|
39
|
+
* return (
|
|
40
|
+
* <>
|
|
41
|
+
* <ul>
|
|
42
|
+
* {data?.pages.map(page => {
|
|
43
|
+
* return page.data.map(post => (
|
|
44
|
+
* <li key={post.id}>{post.title}</li>
|
|
45
|
+
* ));
|
|
46
|
+
* })}
|
|
47
|
+
* </ul>
|
|
48
|
+
* <div>
|
|
49
|
+
* <button disabled={!hasNextPage} onClick={() => fetchNextPage()}>
|
|
50
|
+
* Fetch next page
|
|
51
|
+
* </button>
|
|
52
|
+
* </div>
|
|
53
|
+
* </>
|
|
54
|
+
* );
|
|
55
|
+
* };
|
|
56
|
+
*/
|
|
57
|
+
export const useInfiniteGetList = (resource, params = {}, options = {}) => {
|
|
58
|
+
const { pagination = { page: 1, perPage: 25 }, sort = { field: 'id', order: 'DESC' }, filter = {}, meta, } = params;
|
|
59
|
+
const dataProvider = useDataProvider();
|
|
60
|
+
const queryClient = useQueryClient();
|
|
61
|
+
const { onSuccess = noop, onError = noop, onSettled = noop, ...queryOptions } = options;
|
|
62
|
+
const onSuccessEvent = useEvent(onSuccess);
|
|
63
|
+
const onErrorEvent = useEvent(onError);
|
|
64
|
+
const onSettledEvent = useEvent(onSettled);
|
|
65
|
+
const result = useInfiniteQuery({
|
|
66
|
+
queryKey: [
|
|
67
|
+
resource,
|
|
68
|
+
'getInfiniteList',
|
|
69
|
+
{ pagination, sort, filter, meta },
|
|
70
|
+
],
|
|
71
|
+
queryFn: queryParams => {
|
|
72
|
+
const { pageParam = pagination.page } = queryParams;
|
|
73
|
+
return dataProvider
|
|
74
|
+
.getList(resource, {
|
|
75
|
+
pagination: {
|
|
76
|
+
page: pageParam,
|
|
77
|
+
perPage: pagination.perPage,
|
|
78
|
+
},
|
|
79
|
+
sort,
|
|
80
|
+
filter,
|
|
81
|
+
meta,
|
|
82
|
+
signal: dataProvider.supportAbortSignal === true
|
|
83
|
+
? queryParams.signal
|
|
84
|
+
: undefined,
|
|
85
|
+
})
|
|
86
|
+
.then(({ data, pageInfo, total, meta }) => ({
|
|
87
|
+
data,
|
|
88
|
+
total,
|
|
89
|
+
pageParam,
|
|
90
|
+
pageInfo,
|
|
91
|
+
meta,
|
|
92
|
+
}));
|
|
93
|
+
},
|
|
94
|
+
initialPageParam: pagination.page,
|
|
95
|
+
...queryOptions,
|
|
96
|
+
getNextPageParam: lastLoadedPage => {
|
|
97
|
+
if (lastLoadedPage.pageInfo) {
|
|
98
|
+
return lastLoadedPage.pageInfo.hasNextPage
|
|
99
|
+
? lastLoadedPage.pageParam + 1
|
|
100
|
+
: undefined;
|
|
101
|
+
}
|
|
102
|
+
const totalPages = Math.ceil((lastLoadedPage.total || 0) / pagination.perPage);
|
|
103
|
+
return lastLoadedPage.pageParam < totalPages
|
|
104
|
+
? Number(lastLoadedPage.pageParam) + 1
|
|
105
|
+
: undefined;
|
|
106
|
+
},
|
|
107
|
+
getPreviousPageParam: lastLoadedPage => {
|
|
108
|
+
if (lastLoadedPage.pageInfo) {
|
|
109
|
+
return lastLoadedPage.pageInfo.hasPreviousPage
|
|
110
|
+
? lastLoadedPage.pageParam - 1
|
|
111
|
+
: undefined;
|
|
112
|
+
}
|
|
113
|
+
return lastLoadedPage.pageParam === 1
|
|
114
|
+
? undefined
|
|
115
|
+
: lastLoadedPage.pageParam - 1;
|
|
116
|
+
},
|
|
117
|
+
});
|
|
118
|
+
const metaValue = useRef(meta);
|
|
119
|
+
const resourceValue = useRef(resource);
|
|
120
|
+
useEffect(() => {
|
|
121
|
+
metaValue.current = meta;
|
|
122
|
+
}, [meta]);
|
|
123
|
+
useEffect(() => {
|
|
124
|
+
resourceValue.current = resource;
|
|
125
|
+
}, [resource]);
|
|
126
|
+
useEffect(() => {
|
|
127
|
+
if (result.data === undefined ||
|
|
128
|
+
result.error != null ||
|
|
129
|
+
result.isFetching)
|
|
130
|
+
return;
|
|
131
|
+
// optimistically populate the getOne cache
|
|
132
|
+
const allPagesDataLength = result.data.pages.reduce((acc, page) => acc + page.data.length, 0);
|
|
133
|
+
if (allPagesDataLength <= MAX_DATA_LENGTH_TO_CACHE) {
|
|
134
|
+
result.data.pages.forEach(page => {
|
|
135
|
+
page.data.forEach(record => {
|
|
136
|
+
queryClient.setQueryData([
|
|
137
|
+
resourceValue.current,
|
|
138
|
+
'getOne',
|
|
139
|
+
{ id: String(record.id), meta: metaValue.current },
|
|
140
|
+
], oldRecord => oldRecord ?? record);
|
|
141
|
+
});
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
onSuccessEvent(result.data);
|
|
145
|
+
}, [
|
|
146
|
+
onSuccessEvent,
|
|
147
|
+
queryClient,
|
|
148
|
+
result.data,
|
|
149
|
+
result.error,
|
|
150
|
+
result.isFetching,
|
|
151
|
+
]);
|
|
152
|
+
useEffect(() => {
|
|
153
|
+
if (result.error == null || result.isFetching)
|
|
154
|
+
return;
|
|
155
|
+
onErrorEvent(result.error);
|
|
156
|
+
}, [onErrorEvent, result.error, result.isFetching]);
|
|
157
|
+
useEffect(() => {
|
|
158
|
+
if (result.status === 'pending' || result.isFetching)
|
|
159
|
+
return;
|
|
160
|
+
onSettledEvent(result.data, result.error);
|
|
161
|
+
}, [
|
|
162
|
+
onSettledEvent,
|
|
163
|
+
result.data,
|
|
164
|
+
result.error,
|
|
165
|
+
result.status,
|
|
166
|
+
result.isFetching,
|
|
167
|
+
]);
|
|
168
|
+
return (result.data
|
|
169
|
+
? {
|
|
170
|
+
...result,
|
|
171
|
+
data: result.data,
|
|
172
|
+
total: result.data?.pages[0]?.total ?? undefined,
|
|
173
|
+
meta: result.data?.pages[0]?.meta,
|
|
174
|
+
}
|
|
175
|
+
: result);
|
|
176
|
+
};
|
|
177
|
+
const noop = () => undefined;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Check if react-query has already fetched data for a query key.
|
|
3
|
+
*
|
|
4
|
+
* This hook is reactive.
|
|
5
|
+
*
|
|
6
|
+
* @example
|
|
7
|
+
* const isCustomerLoaded = useIsDataLoaded(['customers', 'getOne', { id: customerId }]);
|
|
8
|
+
*
|
|
9
|
+
* @returns {boolean} true if the data is loaded, false otherwise
|
|
10
|
+
*/
|
|
11
|
+
export declare const useIsDataLoaded: (queryKey: any, options?: {
|
|
12
|
+
enabled?: boolean;
|
|
13
|
+
}) => boolean;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { useEffect, useState } from 'react';
|
|
2
|
+
import { useQueryClient, QueryObserver } from '@tanstack/react-query';
|
|
3
|
+
/**
|
|
4
|
+
* Check if react-query has already fetched data for a query key.
|
|
5
|
+
*
|
|
6
|
+
* This hook is reactive.
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* const isCustomerLoaded = useIsDataLoaded(['customers', 'getOne', { id: customerId }]);
|
|
10
|
+
*
|
|
11
|
+
* @returns {boolean} true if the data is loaded, false otherwise
|
|
12
|
+
*/
|
|
13
|
+
export const useIsDataLoaded = (queryKey, options = {}) => {
|
|
14
|
+
const { enabled = true } = options;
|
|
15
|
+
const queryClient = useQueryClient();
|
|
16
|
+
const [isDataLoaded, setDataLoaded] = useState(() => {
|
|
17
|
+
if (!enabled) {
|
|
18
|
+
return false;
|
|
19
|
+
}
|
|
20
|
+
return queryClient.getQueryData(queryKey) !== undefined;
|
|
21
|
+
});
|
|
22
|
+
useEffect(() => {
|
|
23
|
+
if (!enabled)
|
|
24
|
+
return;
|
|
25
|
+
if (queryClient.getQueryData(queryKey) === undefined) {
|
|
26
|
+
const observer = new QueryObserver(queryClient, { queryKey });
|
|
27
|
+
const unsubscribe = observer.subscribe(result => {
|
|
28
|
+
setDataLoaded(!result.isPending);
|
|
29
|
+
unsubscribe();
|
|
30
|
+
});
|
|
31
|
+
return unsubscribe;
|
|
32
|
+
}
|
|
33
|
+
}, [enabled, queryKey, queryClient]);
|
|
34
|
+
return isDataLoaded;
|
|
35
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Get the state of the dataProvider connection.
|
|
3
|
+
*
|
|
4
|
+
* Returns true if a query or a mutation is pending.
|
|
5
|
+
*
|
|
6
|
+
* Custom implementation because react-query's useIsFetching and useIsMutating
|
|
7
|
+
* render each time the number of active queries changes, which is too often.
|
|
8
|
+
*
|
|
9
|
+
* @see useIsFetching
|
|
10
|
+
* @see useIsMutating
|
|
11
|
+
*/
|
|
12
|
+
export declare const useLoading: () => boolean;
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { notifyManager, useQueryClient } from '@tanstack/react-query';
|
|
3
|
+
/**
|
|
4
|
+
* Get the state of the dataProvider connection.
|
|
5
|
+
*
|
|
6
|
+
* Returns true if a query or a mutation is pending.
|
|
7
|
+
*
|
|
8
|
+
* Custom implementation because react-query's useIsFetching and useIsMutating
|
|
9
|
+
* render each time the number of active queries changes, which is too often.
|
|
10
|
+
*
|
|
11
|
+
* @see useIsFetching
|
|
12
|
+
* @see useIsMutating
|
|
13
|
+
*/
|
|
14
|
+
export const useLoading = () => {
|
|
15
|
+
const client = useQueryClient();
|
|
16
|
+
const mountedRef = React.useRef(false);
|
|
17
|
+
const isFetchingRef = React.useRef(client.isFetching() > 0);
|
|
18
|
+
const isMutatingRef = React.useRef(client.isMutating() > 0);
|
|
19
|
+
const [isLoading, setIsLoading] = React.useState(isFetchingRef.current || isMutatingRef.current);
|
|
20
|
+
React.useEffect(() => {
|
|
21
|
+
mountedRef.current = true;
|
|
22
|
+
const unsubscribeQueryCache = client.getQueryCache().subscribe(notifyManager.batchCalls(() => {
|
|
23
|
+
if (mountedRef.current) {
|
|
24
|
+
isFetchingRef.current = client.isFetching() > 0;
|
|
25
|
+
setIsLoading(isFetchingRef.current || isMutatingRef.current);
|
|
26
|
+
}
|
|
27
|
+
}));
|
|
28
|
+
const unsubscribeMutationCache = client.getMutationCache().subscribe(notifyManager.batchCalls(() => {
|
|
29
|
+
if (mountedRef.current) {
|
|
30
|
+
isMutatingRef.current = client.isMutating() > 0;
|
|
31
|
+
setIsLoading(isFetchingRef.current || isMutatingRef.current);
|
|
32
|
+
}
|
|
33
|
+
}));
|
|
34
|
+
return () => {
|
|
35
|
+
mountedRef.current = false;
|
|
36
|
+
unsubscribeQueryCache();
|
|
37
|
+
unsubscribeMutationCache();
|
|
38
|
+
};
|
|
39
|
+
}, [client]);
|
|
40
|
+
return isLoading;
|
|
41
|
+
};
|