@terreno/admin-frontend 57.20.0 → 58.0.0-beta.1
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/.ai/guidelines/core.md +6 -5
- package/CHANGELOG.md +93 -0
- package/README.md +33 -21
- package/dist/AdminFieldRenderer.d.ts.map +1 -1
- package/dist/AdminFieldRenderer.js +4 -4
- package/dist/AdminFieldRenderer.js.map +1 -1
- package/dist/AdminFieldRendererCore.d.ts.map +1 -1
- package/dist/AdminFieldRendererCore.js +9 -9
- package/dist/AdminFieldRendererCore.js.map +1 -1
- package/dist/AdminFilterDrawer.d.ts +1 -2
- package/dist/AdminFilterDrawer.d.ts.map +1 -1
- package/dist/AdminFilterDrawer.js +4 -4
- package/dist/AdminFilterDrawer.js.map +1 -1
- package/dist/AdminHome.d.ts +0 -2
- package/dist/AdminHome.d.ts.map +1 -1
- package/dist/AdminHome.js +4 -5
- package/dist/AdminHome.js.map +1 -1
- package/dist/AdminMigrations.d.ts.map +1 -1
- package/dist/AdminMigrations.js +3 -3
- package/dist/AdminMigrations.js.map +1 -1
- package/dist/AdminMigrationsView.d.ts +1 -2
- package/dist/AdminMigrationsView.d.ts.map +1 -1
- package/dist/AdminMigrationsView.js +3 -3
- package/dist/AdminMigrationsView.js.map +1 -1
- package/dist/AdminModelForm.d.ts +3 -6
- package/dist/AdminModelForm.d.ts.map +1 -1
- package/dist/AdminModelForm.js +8 -11
- package/dist/AdminModelForm.js.map +1 -1
- package/dist/AdminModelList.d.ts +2 -5
- package/dist/AdminModelList.d.ts.map +1 -1
- package/dist/AdminModelList.js +4 -6
- package/dist/AdminModelList.js.map +1 -1
- package/dist/AdminModelTable.d.ts +0 -2
- package/dist/AdminModelTable.d.ts.map +1 -1
- package/dist/AdminModelTable.js +12 -28
- package/dist/AdminModelTable.js.map +1 -1
- package/dist/AdminNestedArrayField.d.ts +1 -2
- package/dist/AdminNestedArrayField.d.ts.map +1 -1
- package/dist/AdminNestedArrayField.js +4 -7
- package/dist/AdminNestedArrayField.js.map +1 -1
- package/dist/AdminObjectPicker.d.ts +0 -2
- package/dist/AdminObjectPicker.d.ts.map +1 -1
- package/dist/AdminObjectPicker.js +18 -63
- package/dist/AdminObjectPicker.js.map +1 -1
- package/dist/AdminPrimitiveArrayField.d.ts +1 -2
- package/dist/AdminPrimitiveArrayField.d.ts.map +1 -1
- package/dist/AdminPrimitiveArrayField.js +3 -3
- package/dist/AdminPrimitiveArrayField.js.map +1 -1
- package/dist/AdminProvider.d.ts.map +1 -1
- package/dist/AdminProvider.js +3 -9
- package/dist/AdminProvider.js.map +1 -1
- package/dist/AdminRefField.d.ts.map +1 -1
- package/dist/AdminRefField.js +2 -2
- package/dist/AdminRefField.js.map +1 -1
- package/dist/AdminRolesField.d.ts.map +1 -1
- package/dist/AdminRolesField.js +2 -2
- package/dist/AdminRolesField.js.map +1 -1
- package/dist/AdminRolesList.js +2 -2
- package/dist/AdminRolesList.js.map +1 -1
- package/dist/AdminScreenRouter.d.ts.map +1 -1
- package/dist/AdminScreenRouter.js +6 -6
- package/dist/AdminScreenRouter.js.map +1 -1
- package/dist/AdminScriptList.d.ts +0 -2
- package/dist/AdminScriptList.d.ts.map +1 -1
- package/dist/AdminScriptList.js +5 -5
- package/dist/AdminScriptList.js.map +1 -1
- package/dist/AdminScriptRunModal.d.ts +0 -2
- package/dist/AdminScriptRunModal.d.ts.map +1 -1
- package/dist/AdminScriptRunModal.js +2 -2
- package/dist/AdminScriptRunModal.js.map +1 -1
- package/dist/AdminShell.d.ts +1 -2
- package/dist/AdminShell.d.ts.map +1 -1
- package/dist/AdminShell.js +2 -2
- package/dist/AdminShell.js.map +1 -1
- package/dist/AdminShellLayout.d.ts +1 -1
- package/dist/AdminShellLayout.js +1 -1
- package/dist/AdminVersionConfig.d.ts +0 -2
- package/dist/AdminVersionConfig.d.ts.map +1 -1
- package/dist/AdminVersionConfig.js +8 -40
- package/dist/AdminVersionConfig.js.map +1 -1
- package/dist/AnnouncementEditor.d.ts +0 -2
- package/dist/AnnouncementEditor.d.ts.map +1 -1
- package/dist/AnnouncementEditor.js +20 -42
- package/dist/AnnouncementEditor.js.map +1 -1
- package/dist/AnnouncementList.d.ts +0 -2
- package/dist/AnnouncementList.d.ts.map +1 -1
- package/dist/AnnouncementList.js +3 -3
- package/dist/AnnouncementList.js.map +1 -1
- package/dist/AnnouncementOverview.d.ts +0 -2
- package/dist/AnnouncementOverview.d.ts.map +1 -1
- package/dist/AnnouncementOverview.js +11 -30
- package/dist/AnnouncementOverview.js.map +1 -1
- package/dist/AnnouncementOverviewScreenWidget.d.ts.map +1 -1
- package/dist/AnnouncementOverviewScreenWidget.js +2 -2
- package/dist/AnnouncementOverviewScreenWidget.js.map +1 -1
- package/dist/ConfigurationScreen.d.ts +1 -5
- package/dist/ConfigurationScreen.d.ts.map +1 -1
- package/dist/ConfigurationScreen.js +3 -4
- package/dist/ConfigurationScreen.js.map +1 -1
- package/dist/ConsentFormEditor.d.ts +0 -2
- package/dist/ConsentFormEditor.d.ts.map +1 -1
- package/dist/ConsentFormEditor.js +13 -65
- package/dist/ConsentFormEditor.js.map +1 -1
- package/dist/ConsentFormList.d.ts +0 -2
- package/dist/ConsentFormList.d.ts.map +1 -1
- package/dist/ConsentFormList.js +3 -3
- package/dist/ConsentFormList.js.map +1 -1
- package/dist/ConsentHistory.d.ts +0 -2
- package/dist/ConsentHistory.d.ts.map +1 -1
- package/dist/ConsentHistory.js +2 -2
- package/dist/ConsentHistory.js.map +1 -1
- package/dist/ConsentResponseViewer.d.ts +0 -2
- package/dist/ConsentResponseViewer.d.ts.map +1 -1
- package/dist/ConsentResponseViewer.js +3 -3
- package/dist/ConsentResponseViewer.js.map +1 -1
- package/dist/DocumentStorageBrowser.d.ts.map +1 -1
- package/dist/DocumentStorageBrowser.js +2 -2
- package/dist/DocumentStorageBrowser.js.map +1 -1
- package/dist/adminApiQueryParams.d.ts +1 -1
- package/dist/adminApiQueryParams.d.ts.map +1 -1
- package/dist/adminApiQueryParams.js +1 -1
- package/dist/adminApiQueryParams.js.map +1 -1
- package/dist/adminRequest.d.ts +5 -4
- package/dist/adminRequest.d.ts.map +1 -1
- package/dist/adminRequest.js +19 -102
- package/dist/adminRequest.js.map +1 -1
- package/dist/adminWindowedTable.d.ts +1 -2
- package/dist/adminWindowedTable.d.ts.map +1 -1
- package/dist/adminWindowedTable.js +2 -2
- package/dist/adminWindowedTable.js.map +1 -1
- package/dist/comms/CommsDashboardScreen.d.ts +0 -2
- package/dist/comms/CommsDashboardScreen.d.ts.map +1 -1
- package/dist/comms/CommsDashboardScreen.js +2 -2
- package/dist/comms/CommsDashboardScreen.js.map +1 -1
- package/dist/comms/CommsDashboardScreenWidget.d.ts.map +1 -1
- package/dist/comms/CommsDashboardScreenWidget.js +2 -2
- package/dist/comms/CommsDashboardScreenWidget.js.map +1 -1
- package/dist/comms/CommsMessageDetail.d.ts +0 -2
- package/dist/comms/CommsMessageDetail.d.ts.map +1 -1
- package/dist/comms/CommsMessageDetail.js +5 -5
- package/dist/comms/CommsMessageDetail.js.map +1 -1
- package/dist/comms/useCommsDashboardApi.d.ts +6 -19
- package/dist/comms/useCommsDashboardApi.d.ts.map +1 -1
- package/dist/comms/useCommsDashboardApi.js +34 -93
- package/dist/comms/useCommsDashboardApi.js.map +1 -1
- package/dist/consentPdfTemplates.d.ts +1 -0
- package/dist/consentPdfTemplates.d.ts.map +1 -1
- package/dist/consentPdfTemplates.js.map +1 -1
- package/dist/index.d.ts +3 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/jobs/JobsDashboardScreen.d.ts +0 -2
- package/dist/jobs/JobsDashboardScreen.d.ts.map +1 -1
- package/dist/jobs/JobsDashboardScreen.js +2 -2
- package/dist/jobs/JobsDashboardScreen.js.map +1 -1
- package/dist/jobs/JobsDashboardScreenWidget.d.ts.map +1 -1
- package/dist/jobs/JobsDashboardScreenWidget.js +2 -2
- package/dist/jobs/JobsDashboardScreenWidget.js.map +1 -1
- package/dist/jobs/JobsHomeWidget.js +2 -2
- package/dist/jobs/JobsHomeWidget.js.map +1 -1
- package/dist/jobs/JobsJobDetail.d.ts +0 -2
- package/dist/jobs/JobsJobDetail.d.ts.map +1 -1
- package/dist/jobs/JobsJobDetail.js +2 -2
- package/dist/jobs/JobsJobDetail.js.map +1 -1
- package/dist/jobs/jobPayload.d.ts +1 -1
- package/dist/jobs/jobPayload.d.ts.map +1 -1
- package/dist/jobs/useJobsDashboardApi.d.ts +29 -53
- package/dist/jobs/useJobsDashboardApi.d.ts.map +1 -1
- package/dist/jobs/useJobsDashboardApi.js +50 -84
- package/dist/jobs/useJobsDashboardApi.js.map +1 -1
- package/dist/orgs/MemberSecurityPanel.js.map +1 -1
- package/dist/orgs/OrgDirectoryScreen.d.ts +0 -2
- package/dist/orgs/OrgDirectoryScreen.d.ts.map +1 -1
- package/dist/orgs/OrgDirectoryScreen.js +5 -3
- package/dist/orgs/OrgDirectoryScreen.js.map +1 -1
- package/dist/orgs/OrgMembersScreen.d.ts +0 -2
- package/dist/orgs/OrgMembersScreen.d.ts.map +1 -1
- package/dist/orgs/OrgMembersScreen.js +3 -3
- package/dist/orgs/OrgMembersScreen.js.map +1 -1
- package/dist/orgs/OrgSettingsScreen.d.ts +0 -2
- package/dist/orgs/OrgSettingsScreen.d.ts.map +1 -1
- package/dist/orgs/OrgSettingsScreen.js +2 -2
- package/dist/orgs/OrgSettingsScreen.js.map +1 -1
- package/dist/orgs/OrgSwitcher.d.ts +0 -2
- package/dist/orgs/OrgSwitcher.d.ts.map +1 -1
- package/dist/orgs/OrgSwitcher.js +2 -2
- package/dist/orgs/OrgSwitcher.js.map +1 -1
- package/dist/orgs/normalizeListData.d.ts +2 -3
- package/dist/orgs/normalizeListData.d.ts.map +1 -1
- package/dist/orgs/normalizeListData.js.map +1 -1
- package/dist/orgs/organizationHeaders.d.ts +3 -0
- package/dist/orgs/organizationHeaders.d.ts.map +1 -0
- package/dist/orgs/organizationHeaders.js +8 -0
- package/dist/orgs/organizationHeaders.js.map +1 -0
- package/dist/orgs/useMemberSecurityApi.js +1 -1
- package/dist/orgs/useMemberSecurityApi.js.map +1 -1
- package/dist/orgs/useOrganizationsApi.d.ts +38 -13
- package/dist/orgs/useOrganizationsApi.d.ts.map +1 -1
- package/dist/orgs/useOrganizationsApi.js +89 -87
- package/dist/orgs/useOrganizationsApi.js.map +1 -1
- package/dist/types.d.ts +5 -29
- package/dist/types.d.ts.map +1 -1
- package/dist/types.js.map +1 -1
- package/dist/useAdminBackgroundTask.d.ts +2 -3
- package/dist/useAdminBackgroundTask.d.ts.map +1 -1
- package/dist/useAdminBackgroundTask.js +11 -33
- package/dist/useAdminBackgroundTask.js.map +1 -1
- package/dist/useAdminConfig.d.ts +9 -11
- package/dist/useAdminConfig.d.ts.map +1 -1
- package/dist/useAdminConfig.js +10 -38
- package/dist/useAdminConfig.js.map +1 -1
- package/dist/useAdminMigrations.d.ts +18 -19
- package/dist/useAdminMigrations.d.ts.map +1 -1
- package/dist/useAdminMigrations.js +19 -39
- package/dist/useAdminMigrations.js.map +1 -1
- package/dist/useAdminModelApi.d.ts +72 -0
- package/dist/useAdminModelApi.d.ts.map +1 -0
- package/dist/useAdminModelApi.js +94 -0
- package/dist/useAdminModelApi.js.map +1 -0
- package/dist/useAdminRoles.d.ts +10 -11
- package/dist/useAdminRoles.d.ts.map +1 -1
- package/dist/useAdminRoles.js +29 -97
- package/dist/useAdminRoles.js.map +1 -1
- package/dist/useAdminRpc.d.ts +46 -12
- package/dist/useAdminRpc.d.ts.map +1 -1
- package/dist/useAdminRpc.js +91 -30
- package/dist/useAdminRpc.js.map +1 -1
- package/dist/useAdminScripts.d.ts +37 -41
- package/dist/useAdminScripts.d.ts.map +1 -1
- package/dist/useAdminScripts.js +42 -109
- package/dist/useAdminScripts.js.map +1 -1
- package/dist/useConfigurationApi.d.ts +8 -16
- package/dist/useConfigurationApi.d.ts.map +1 -1
- package/dist/useConfigurationApi.js +16 -66
- package/dist/useConfigurationApi.js.map +1 -1
- package/dist/useConsentHistory.d.ts +3 -34
- package/dist/useConsentHistory.d.ts.map +1 -1
- package/dist/useConsentHistory.js +10 -38
- package/dist/useConsentHistory.js.map +1 -1
- package/dist/useDocumentStorageApi.d.ts +36 -8
- package/dist/useDocumentStorageApi.d.ts.map +1 -1
- package/dist/useDocumentStorageApi.js +65 -151
- package/dist/useDocumentStorageApi.js.map +1 -1
- package/dist/widgets/AIRequestsScreenWidget.d.ts.map +1 -1
- package/dist/widgets/AIRequestsScreenWidget.js +3 -21
- package/dist/widgets/AIRequestsScreenWidget.js.map +1 -1
- package/dist/widgets/DocumentsScreenWidget.d.ts.map +1 -1
- package/dist/widgets/DocumentsScreenWidget.js +2 -2
- package/dist/widgets/DocumentsScreenWidget.js.map +1 -1
- package/dist/widgets/ModelsGridWidget.d.ts.map +1 -1
- package/dist/widgets/ModelsGridWidget.js +5 -5
- package/dist/widgets/ModelsGridWidget.js.map +1 -1
- package/dist/widgets/RecentActivityWidget.js +3 -3
- package/dist/widgets/RecentActivityWidget.js.map +1 -1
- package/dist/widgets/VersionConfigScreenWidget.d.ts.map +1 -1
- package/dist/widgets/VersionConfigScreenWidget.js +2 -2
- package/dist/widgets/VersionConfigScreenWidget.js.map +1 -1
- package/dist/widgets/VersionConfigWidget.js +2 -2
- package/dist/widgets/VersionConfigWidget.js.map +1 -1
- package/dist/widgets/aiObservability/datasets/AiDatasetDetailScreen.js +4 -4
- package/dist/widgets/aiObservability/datasets/AiDatasetDetailScreen.js.map +1 -1
- package/dist/widgets/aiObservability/datasets/AiDatasetsListScreen.js +4 -4
- package/dist/widgets/aiObservability/datasets/AiDatasetsListScreen.js.map +1 -1
- package/dist/widgets/aiObservability/datasets/useAiObservabilityDatasetsApi.d.ts +30 -71
- package/dist/widgets/aiObservability/datasets/useAiObservabilityDatasetsApi.d.ts.map +1 -1
- package/dist/widgets/aiObservability/datasets/useAiObservabilityDatasetsApi.js +48 -95
- package/dist/widgets/aiObservability/datasets/useAiObservabilityDatasetsApi.js.map +1 -1
- package/dist/widgets/aiObservability/evaluators/AiEvaluatorDetailScreen.js +4 -4
- package/dist/widgets/aiObservability/evaluators/AiEvaluatorDetailScreen.js.map +1 -1
- package/dist/widgets/aiObservability/evaluators/AiEvaluatorNewScreen.js +3 -3
- package/dist/widgets/aiObservability/evaluators/AiEvaluatorNewScreen.js.map +1 -1
- package/dist/widgets/aiObservability/evaluators/AiEvaluatorsListScreen.js +3 -3
- package/dist/widgets/aiObservability/evaluators/AiEvaluatorsListScreen.js.map +1 -1
- package/dist/widgets/aiObservability/evaluators/useAiObservabilityEvaluatorsApi.d.ts +12 -31
- package/dist/widgets/aiObservability/evaluators/useAiObservabilityEvaluatorsApi.d.ts.map +1 -1
- package/dist/widgets/aiObservability/evaluators/useAiObservabilityEvaluatorsApi.js +19 -46
- package/dist/widgets/aiObservability/evaluators/useAiObservabilityEvaluatorsApi.js.map +1 -1
- package/dist/widgets/aiObservability/experiments/AiExperimentNewScreen.js +5 -5
- package/dist/widgets/aiObservability/experiments/AiExperimentNewScreen.js.map +1 -1
- package/dist/widgets/aiObservability/experiments/AiExperimentResultsScreen.js +4 -4
- package/dist/widgets/aiObservability/experiments/AiExperimentResultsScreen.js.map +1 -1
- package/dist/widgets/aiObservability/experiments/AiExperimentsListScreen.js +3 -3
- package/dist/widgets/aiObservability/experiments/AiExperimentsListScreen.js.map +1 -1
- package/dist/widgets/aiObservability/experiments/useAiObservabilityExperimentsApi.d.ts +18 -49
- package/dist/widgets/aiObservability/experiments/useAiObservabilityExperimentsApi.d.ts.map +1 -1
- package/dist/widgets/aiObservability/experiments/useAiObservabilityExperimentsApi.js +33 -65
- package/dist/widgets/aiObservability/experiments/useAiObservabilityExperimentsApi.js.map +1 -1
- package/dist/widgets/aiObservability/prompts/AiPromptEditorScreen.d.ts.map +1 -1
- package/dist/widgets/aiObservability/prompts/AiPromptEditorScreen.js +6 -4
- package/dist/widgets/aiObservability/prompts/AiPromptEditorScreen.js.map +1 -1
- package/dist/widgets/aiObservability/prompts/AiPromptEditorView.d.ts.map +1 -1
- package/dist/widgets/aiObservability/prompts/AiPromptEditorView.js +19 -9
- package/dist/widgets/aiObservability/prompts/AiPromptEditorView.js.map +1 -1
- package/dist/widgets/aiObservability/prompts/AiPromptPlaygroundView.d.ts.map +1 -1
- package/dist/widgets/aiObservability/prompts/AiPromptPlaygroundView.js +6 -1
- package/dist/widgets/aiObservability/prompts/AiPromptPlaygroundView.js.map +1 -1
- package/dist/widgets/aiObservability/prompts/AiPromptsListScreen.js +2 -2
- package/dist/widgets/aiObservability/prompts/AiPromptsListScreen.js.map +1 -1
- package/dist/widgets/aiObservability/prompts/useAiObservabilityPromptsApi.d.ts +18 -61
- package/dist/widgets/aiObservability/prompts/useAiObservabilityPromptsApi.d.ts.map +1 -1
- package/dist/widgets/aiObservability/prompts/useAiObservabilityPromptsApi.js +47 -82
- package/dist/widgets/aiObservability/prompts/useAiObservabilityPromptsApi.js.map +1 -1
- package/dist/widgets/aiObservability/review/AiReviewItemScreen.d.ts.map +1 -1
- package/dist/widgets/aiObservability/review/AiReviewItemScreen.js +5 -3
- package/dist/widgets/aiObservability/review/AiReviewItemScreen.js.map +1 -1
- package/dist/widgets/aiObservability/review/AiReviewQueueScreen.js +2 -2
- package/dist/widgets/aiObservability/review/AiReviewQueueScreen.js.map +1 -1
- package/dist/widgets/aiObservability/review/useAiObservabilityReviewApi.d.ts +12 -35
- package/dist/widgets/aiObservability/review/useAiObservabilityReviewApi.d.ts.map +1 -1
- package/dist/widgets/aiObservability/review/useAiObservabilityReviewApi.js +25 -63
- package/dist/widgets/aiObservability/review/useAiObservabilityReviewApi.js.map +1 -1
- package/dist/widgets/aiObservability/shell/AiObservabilityChrome.d.ts.map +1 -1
- package/dist/widgets/aiObservability/shell/AiObservabilityChrome.js +2 -2
- package/dist/widgets/aiObservability/shell/AiObservabilityChrome.js.map +1 -1
- package/dist/widgets/aiObservability/shell/AiObservabilityStatusChip.d.ts +0 -2
- package/dist/widgets/aiObservability/shell/AiObservabilityStatusChip.d.ts.map +1 -1
- package/dist/widgets/aiObservability/shell/AiObservabilityStatusChip.js +7 -24
- package/dist/widgets/aiObservability/shell/AiObservabilityStatusChip.js.map +1 -1
- package/dist/widgets/aiObservability/shell/observabilityRequest.d.ts +40 -0
- package/dist/widgets/aiObservability/shell/observabilityRequest.d.ts.map +1 -0
- package/dist/widgets/aiObservability/shell/observabilityRequest.js +62 -0
- package/dist/widgets/aiObservability/shell/observabilityRequest.js.map +1 -0
- package/dist/widgets/aiObservability/traces/AiTraceDetailScreen.d.ts.map +1 -1
- package/dist/widgets/aiObservability/traces/AiTraceDetailScreen.js +5 -3
- package/dist/widgets/aiObservability/traces/AiTraceDetailScreen.js.map +1 -1
- package/dist/widgets/aiObservability/traces/AiTracesListScreen.js +4 -4
- package/dist/widgets/aiObservability/traces/AiTracesListScreen.js.map +1 -1
- package/dist/widgets/aiObservability/traces/useAiObservabilityTracesApi.d.ts +18 -46
- package/dist/widgets/aiObservability/traces/useAiObservabilityTracesApi.d.ts.map +1 -1
- package/dist/widgets/aiObservability/traces/useAiObservabilityTracesApi.js +32 -72
- package/dist/widgets/aiObservability/traces/useAiObservabilityTracesApi.js.map +1 -1
- package/dist/widgets/harness/HarnessApprovalInbox.d.ts.map +1 -1
- package/dist/widgets/harness/HarnessApprovalInbox.js +5 -5
- package/dist/widgets/harness/HarnessApprovalInbox.js.map +1 -1
- package/dist/widgets/harness/useHarnessApprovals.d.ts +0 -1
- package/dist/widgets/harness/useHarnessApprovals.d.ts.map +1 -1
- package/dist/widgets/harness/useHarnessApprovals.js +0 -2
- package/dist/widgets/harness/useHarnessApprovals.js.map +1 -1
- package/package.json +16 -15
- package/src/AdminBreadcrumbs.test.tsx +1 -1
- package/src/AdminFieldRenderer.test.tsx +5 -5
- package/src/AdminFieldRenderer.tsx +0 -4
- package/src/AdminFieldRendererCore.tsx +0 -9
- package/src/AdminFilterDrawer.tsx +3 -10
- package/src/AdminHome.test.tsx +38 -32
- package/src/AdminHome.tsx +3 -8
- package/src/AdminMigrations.tsx +2 -7
- package/src/AdminMigrationsView.tsx +3 -5
- package/src/AdminModelForm.isolated.tsx +38 -202
- package/src/AdminModelForm.orgSkip.test.tsx +9 -12
- package/src/AdminModelForm.tsx +5 -14
- package/src/AdminModelForm.updateDepth.test.tsx +10 -28
- package/src/AdminModelList.test.tsx +10 -19
- package/src/AdminModelList.tsx +3 -12
- package/src/AdminModelTable.test.tsx +57 -111
- package/src/AdminModelTable.tsx +10 -36
- package/src/AdminModelTable.windowed.test.tsx +33 -45
- package/src/AdminNestedArrayField.tsx +1 -10
- package/src/AdminNestedObjectField.test.tsx +1 -13
- package/src/AdminObjectPicker.tsx +21 -72
- package/src/AdminPrimitiveArrayField.test.tsx +5 -33
- package/src/AdminPrimitiveArrayField.tsx +1 -5
- package/src/AdminProvider.test.tsx +14 -14
- package/src/AdminProvider.tsx +5 -9
- package/src/AdminRefField.tsx +0 -2
- package/src/AdminRolesField.tsx +1 -2
- package/src/AdminRolesList.test.tsx +43 -51
- package/src/AdminRolesList.tsx +2 -2
- package/src/AdminScreenPage.test.tsx +1 -1
- package/src/AdminScreenRouter.test.tsx +99 -84
- package/src/AdminScreenRouter.tsx +4 -11
- package/src/AdminScriptList.test.tsx +23 -24
- package/src/AdminScriptList.tsx +4 -7
- package/src/AdminScriptRunModal.tsx +2 -4
- package/src/AdminShell.test.tsx +23 -40
- package/src/AdminShell.tsx +2 -4
- package/src/AdminShellLayout.tsx +1 -1
- package/src/AdminVersionConfig.test.tsx +67 -81
- package/src/AdminVersionConfig.tsx +15 -53
- package/src/AnnouncementEditor.test.tsx +141 -163
- package/src/AnnouncementEditor.tsx +37 -50
- package/src/AnnouncementList.test.tsx +16 -35
- package/src/AnnouncementList.tsx +3 -5
- package/src/AnnouncementOverview.test.tsx +74 -83
- package/src/AnnouncementOverview.tsx +10 -33
- package/src/AnnouncementOverviewScreenWidget.test.tsx +4 -5
- package/src/AnnouncementOverviewScreenWidget.tsx +1 -5
- package/src/CheckboxListEditor.test.tsx +11 -9
- package/src/ConfigurationScreen.test.tsx +9 -12
- package/src/ConfigurationScreen.tsx +2 -7
- package/src/ConsentFormEditor.test.tsx +92 -173
- package/src/ConsentFormEditor.tsx +32 -79
- package/src/ConsentFormList.test.tsx +13 -28
- package/src/ConsentFormList.tsx +3 -5
- package/src/ConsentHistory.test.tsx +86 -78
- package/src/ConsentHistory.tsx +2 -7
- package/src/ConsentResponseViewer.test.tsx +21 -35
- package/src/ConsentResponseViewer.tsx +5 -7
- package/src/DocumentStorageBrowser.test.tsx +23 -76
- package/src/DocumentStorageBrowser.tsx +1 -2
- package/src/adminApiQueryParams.ts +1 -1
- package/src/adminPageAccess.test.ts +1 -1
- package/src/adminRequest.test.ts +3 -3
- package/src/adminRequest.ts +20 -108
- package/src/adminWindowedTable.test.ts +5 -15
- package/src/adminWindowedTable.ts +2 -7
- package/src/comms/CommsDashboardScreen.test.tsx +150 -114
- package/src/comms/CommsDashboardScreen.tsx +1 -4
- package/src/comms/CommsDashboardScreenWidget.test.tsx +33 -35
- package/src/comms/CommsDashboardScreenWidget.tsx +1 -2
- package/src/comms/CommsMessageDetail.test.tsx +117 -77
- package/src/comms/CommsMessageDetail.tsx +1 -8
- package/src/comms/useCommsDashboardApi.test.tsx +95 -89
- package/src/comms/useCommsDashboardApi.tsx +43 -130
- package/src/consentPdfTemplates.ts +1 -0
- package/src/index.tsx +14 -2
- package/src/isolated/AdminFieldRenderer.isolated.tsx +7 -8
- package/src/isolated/AdminFilterDrawer.isolated.tsx +8 -13
- package/src/isolated/AdminFilterDrawerMobile.isolated.tsx +3 -3
- package/src/isolated/AdminHomeWidgets.isolated.tsx +5 -4
- package/src/isolated/AdminNestedArrayField.isolated.tsx +11 -27
- package/src/isolated/AdminObjectPicker.isolated.tsx +77 -78
- package/src/isolated/AdminRefField.isolated.tsx +1 -3
- package/src/isolated/AdminScriptList.isolated.tsx +4 -4
- package/src/isolated/AdminScriptRunModal.isolated.tsx +3 -54
- package/src/isolated/AiPromptEditorScreen.isolated.tsx +157 -122
- package/src/isolated/AiPromptsListScreen.isolated.tsx +50 -53
- package/src/isolated/DocumentStorageBrowser.isolated.tsx +40 -83
- package/src/{widgets/ModelsGridWidget.test.tsx → isolated/ModelsGridWidget.isolated.tsx} +33 -23
- package/src/isolated/RecentActivityWidget.isolated.tsx +5 -4
- package/src/isolated/UserSecurityScreen.isolated.tsx +1 -5
- package/src/isolated/{rpcDualRun.isolated.tsx → adminRpcHooks.isolated.tsx} +37 -112
- package/src/isolated/adminWidgets.isolated.tsx +15 -23
- package/src/isolated/aiObservabilityDatasets.isolated.tsx +1069 -0
- package/src/isolated/aiObservabilityEvaluators.isolated.tsx +879 -0
- package/src/isolated/aiObservabilityExperiments.isolated.tsx +1009 -0
- package/src/isolated/aiObservabilityPrompts.isolated.tsx +1302 -0
- package/src/isolated/aiObservabilityReview.isolated.tsx +873 -0
- package/src/isolated/aiObservabilityTraces.isolated.tsx +1049 -0
- package/src/isolated/generateConsentHistoryPdf.isolated.ts +30 -10
- package/src/isolated/generateConsentPdfsMobile.isolated.ts +24 -3
- package/src/isolated/harnessApprovalsScreen.isolated.tsx +1 -3
- package/src/isolated/hooks.isolated.tsx +214 -674
- package/src/isolated/observabilityFakeApi.isolated.tsx +277 -0
- package/src/isolated/useJobsDashboardApi.isolated.tsx +52 -52
- package/src/jobs/JobsDashboardScreen.test.tsx +167 -123
- package/src/jobs/JobsDashboardScreen.tsx +1 -4
- package/src/jobs/JobsDashboardScreenWidget.test.tsx +50 -55
- package/src/jobs/JobsDashboardScreenWidget.tsx +1 -2
- package/src/jobs/JobsHomeWidget.test.tsx +55 -40
- package/src/jobs/JobsHomeWidget.tsx +2 -2
- package/src/jobs/JobsJobDetail.test.tsx +104 -60
- package/src/jobs/JobsJobDetail.tsx +2 -4
- package/src/jobs/jobPayload.ts +1 -1
- package/src/jobs/useJobsDashboardApi.test.tsx +111 -113
- package/src/jobs/useJobsDashboardApi.tsx +85 -124
- package/src/orgs/MemberSecurityPanel.test.tsx +18 -6
- package/src/orgs/MemberSecurityPanel.tsx +2 -2
- package/src/orgs/OrgDirectoryScreen.test.tsx +146 -102
- package/src/orgs/OrgDirectoryScreen.tsx +4 -5
- package/src/orgs/OrgManagementScreens.test.tsx +297 -229
- package/src/orgs/OrgMembersScreen.tsx +3 -6
- package/src/orgs/OrgSettingsScreen.tsx +1 -4
- package/src/orgs/OrgSwitcher.test.tsx +132 -65
- package/src/orgs/OrgSwitcher.tsx +3 -5
- package/src/orgs/normalizeListData.test.ts +1 -1
- package/src/orgs/normalizeListData.ts +2 -3
- package/src/orgs/orgSwitcherOscillation.test.tsx +103 -60
- package/src/orgs/organizationHeaders.ts +9 -0
- package/src/orgs/useMemberSecurityApi.ts +1 -1
- package/src/orgs/useOrganizationsApi.test.tsx +247 -149
- package/src/orgs/useOrganizationsApi.ts +151 -103
- package/src/testing/jestNativeMatchers.d.ts +7 -0
- package/src/testing/observabilityTestUtils.tsx +70 -0
- package/src/testing/{useAdminApiDouble.ts → useAdminModelApiDouble.ts} +6 -5
- package/src/types.ts +5 -44
- package/src/useAdminBackgroundTask.ts +10 -36
- package/src/useAdminConfig.ts +13 -51
- package/src/useAdminMigrations.test.tsx +70 -60
- package/src/useAdminMigrations.ts +36 -54
- package/src/useAdminModelApi.ts +156 -0
- package/src/useAdminRoles.ts +43 -117
- package/src/useAdminRpc.test.tsx +236 -18
- package/src/useAdminRpc.ts +142 -46
- package/src/useAdminScripts.ts +71 -146
- package/src/useConfigurationApi.ts +25 -81
- package/src/useConsentHistory.test.ts +71 -82
- package/src/useConsentHistory.ts +18 -68
- package/src/useDocumentStorageApi.ts +64 -156
- package/src/widgets/AIRequestsScreenWidget.test.tsx +74 -92
- package/src/widgets/AIRequestsScreenWidget.tsx +4 -31
- package/src/widgets/DocumentsScreenWidget.tsx +2 -9
- package/src/widgets/ModelsGridWidget.tsx +5 -6
- package/src/widgets/RecentActivityWidget.tsx +3 -3
- package/src/widgets/VersionConfigScreenWidget.tsx +1 -2
- package/src/widgets/VersionConfigWidget.tsx +2 -2
- package/src/widgets/aiObservability/datasets/AiDatasetDetailScreen.tsx +4 -4
- package/src/widgets/aiObservability/datasets/AiDatasetDetailView.test.tsx +4 -2
- package/src/widgets/aiObservability/datasets/AiDatasetsListScreen.tsx +4 -4
- package/src/widgets/aiObservability/datasets/datasetTypes.test.ts +0 -1
- package/src/widgets/aiObservability/datasets/useAiObservabilityDatasetsApi.test.ts +91 -185
- package/src/widgets/aiObservability/datasets/useAiObservabilityDatasetsApi.ts +79 -148
- package/src/widgets/aiObservability/evaluators/AiEvaluatorDetailScreen.tsx +4 -4
- package/src/widgets/aiObservability/evaluators/AiEvaluatorNewScreen.tsx +3 -3
- package/src/widgets/aiObservability/evaluators/AiEvaluatorPanels.test.tsx +89 -23
- package/src/widgets/aiObservability/evaluators/AiEvaluatorsListScreen.tsx +3 -3
- package/src/widgets/aiObservability/evaluators/evaluatorTypes.test.ts +1 -1
- package/src/widgets/aiObservability/evaluators/useAiObservabilityEvaluatorsApi.test.ts +67 -100
- package/src/widgets/aiObservability/evaluators/useAiObservabilityEvaluatorsApi.ts +33 -68
- package/src/widgets/aiObservability/experiments/AiExperimentNewScreen.tsx +5 -5
- package/src/widgets/aiObservability/experiments/AiExperimentNewView.test.tsx +4 -0
- package/src/widgets/aiObservability/experiments/AiExperimentResultsScreen.tsx +4 -4
- package/src/widgets/aiObservability/experiments/AiExperimentsListScreen.tsx +3 -3
- package/src/widgets/aiObservability/experiments/useAiObservabilityExperimentsApi.test.ts +62 -125
- package/src/widgets/aiObservability/experiments/useAiObservabilityExperimentsApi.ts +51 -90
- package/src/widgets/aiObservability/prompts/AiPromptEditorScreen.tsx +9 -4
- package/src/widgets/aiObservability/prompts/AiPromptEditorView.tsx +17 -9
- package/src/widgets/aiObservability/prompts/AiPromptHubView.test.tsx +45 -1
- package/src/widgets/aiObservability/prompts/AiPromptPlaygroundView.tsx +5 -1
- package/src/widgets/aiObservability/prompts/AiPromptsListScreen.tsx +2 -2
- package/src/widgets/aiObservability/prompts/promptTypes.test.ts +1 -1
- package/src/widgets/aiObservability/prompts/useAiObservabilityPromptsApi.test.ts +137 -113
- package/src/widgets/aiObservability/prompts/useAiObservabilityPromptsApi.ts +69 -118
- package/src/widgets/aiObservability/review/AiReviewItemScreen.tsx +8 -3
- package/src/widgets/aiObservability/review/AiReviewQueueScreen.tsx +2 -2
- package/src/widgets/aiObservability/review/useAiObservabilityReviewApi.test.ts +69 -72
- package/src/widgets/aiObservability/review/useAiObservabilityReviewApi.ts +42 -88
- package/src/widgets/aiObservability/shell/AiObservabilityChrome.tsx +1 -2
- package/src/widgets/aiObservability/shell/AiObservabilityStatusChip.test.tsx +74 -0
- package/src/widgets/aiObservability/shell/AiObservabilityStatusChip.tsx +9 -36
- package/src/widgets/aiObservability/shell/ObservabilityTable.test.tsx +7 -1
- package/src/widgets/aiObservability/shell/observabilityRequest.ts +108 -0
- package/src/widgets/aiObservability/traces/AiTraceDetailScreen.tsx +8 -3
- package/src/widgets/aiObservability/traces/AiTracesListScreen.tsx +4 -4
- package/src/widgets/aiObservability/traces/useAiObservabilityTracesApi.test.ts +112 -111
- package/src/widgets/aiObservability/traces/useAiObservabilityTracesApi.ts +61 -102
- package/src/widgets/builtInFieldWidgets.test.tsx +3 -4
- package/src/widgets/harness/HarnessApprovalInbox.test.tsx +0 -5
- package/src/widgets/harness/HarnessApprovalInbox.tsx +4 -10
- package/src/widgets/harness/useHarnessApprovals.ts +0 -3
- package/dist/dynamicHookApi.d.ts +0 -7
- package/dist/dynamicHookApi.d.ts.map +0 -1
- package/dist/dynamicHookApi.js +0 -4
- package/dist/dynamicHookApi.js.map +0 -1
- package/dist/orgs/adminModelEndpoints.d.ts +0 -31
- package/dist/orgs/adminModelEndpoints.d.ts.map +0 -1
- package/dist/orgs/adminModelEndpoints.js +0 -93
- package/dist/orgs/adminModelEndpoints.js.map +0 -1
- package/dist/useAdminApi.d.ts +0 -59
- package/dist/useAdminApi.d.ts.map +0 -1
- package/dist/useAdminApi.js +0 -40
- package/dist/useAdminApi.js.map +0 -1
- package/src/dynamicHookApi.ts +0 -11
- package/src/isolated/AIRequestsScreenWidget.isolated.tsx +0 -84
- package/src/isolated/aiObservabilityScreens.isolated.tsx +0 -5972
- package/src/isolated/useAdminScripts.isolated.tsx +0 -156
- package/src/orgs/adminModelEndpoints.test.ts +0 -156
- package/src/orgs/adminModelEndpoints.ts +0 -137
- package/src/useAdminApi.test.ts +0 -88
- package/src/useAdminApi.ts +0 -99
|
@@ -1,156 +0,0 @@
|
|
|
1
|
-
// noExplicitAny: test mocks use type-erased RTK Query API doubles
|
|
2
|
-
// biome-ignore-all lint/suspicious/noExplicitAny: test mock typing
|
|
3
|
-
import {describe, expect, it, mock} from "bun:test";
|
|
4
|
-
import {assert} from "chai";
|
|
5
|
-
import React from "react";
|
|
6
|
-
import {renderWithTheme} from "../../../ui/src/test-utils";
|
|
7
|
-
import {useAdminScripts} from "../useAdminScripts";
|
|
8
|
-
|
|
9
|
-
interface BuildSpec {
|
|
10
|
-
query?: (arg?: unknown) => unknown;
|
|
11
|
-
providesTags?: unknown;
|
|
12
|
-
invalidatesTags?: unknown;
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
interface CapturedEndpoints {
|
|
16
|
-
[key: string]: BuildSpec;
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
const makeMockApi = () => {
|
|
20
|
-
const injected: CapturedEndpoints = {};
|
|
21
|
-
const fakeHooks: Record<string, unknown> = {};
|
|
22
|
-
|
|
23
|
-
const addHookFor = (key: string, type: "query" | "mutation") => {
|
|
24
|
-
const cap = (s: string) => s.charAt(0).toUpperCase() + s.slice(1);
|
|
25
|
-
const hookName = type === "query" ? `use${cap(key)}Query` : `use${cap(key)}Mutation`;
|
|
26
|
-
fakeHooks[hookName] = mock(() =>
|
|
27
|
-
type === "query"
|
|
28
|
-
? {data: undefined, error: null, isFetching: false, isLoading: false}
|
|
29
|
-
: [mock(() => ({unwrap: async () => ({})})), {isLoading: false}]
|
|
30
|
-
);
|
|
31
|
-
};
|
|
32
|
-
|
|
33
|
-
const base: Record<string, unknown> = {};
|
|
34
|
-
Object.defineProperty(base, "__injected", {value: injected});
|
|
35
|
-
|
|
36
|
-
const apiProxy: Record<string, unknown> = new Proxy(base, {
|
|
37
|
-
get(target, prop: string) {
|
|
38
|
-
if (prop === "injectEndpoints") {
|
|
39
|
-
return ({endpoints}: {endpoints: (build: unknown) => Record<string, BuildSpec>}) => {
|
|
40
|
-
const build = {
|
|
41
|
-
mutation: (spec: BuildSpec) => ({...spec, __kind: "mutation"}),
|
|
42
|
-
query: (spec: BuildSpec) => ({...spec, __kind: "query"}),
|
|
43
|
-
};
|
|
44
|
-
const defs = endpoints(build);
|
|
45
|
-
for (const [key, def] of Object.entries(defs)) {
|
|
46
|
-
injected[key] = def;
|
|
47
|
-
const kind =
|
|
48
|
-
(def as Record<string, unknown>).__kind === "mutation" ? "mutation" : "query";
|
|
49
|
-
addHookFor(key, kind);
|
|
50
|
-
}
|
|
51
|
-
return apiProxy;
|
|
52
|
-
};
|
|
53
|
-
}
|
|
54
|
-
if (prop in target) {
|
|
55
|
-
return target[prop];
|
|
56
|
-
}
|
|
57
|
-
if (prop in fakeHooks) {
|
|
58
|
-
return fakeHooks[prop];
|
|
59
|
-
}
|
|
60
|
-
return undefined;
|
|
61
|
-
},
|
|
62
|
-
});
|
|
63
|
-
|
|
64
|
-
return apiProxy;
|
|
65
|
-
};
|
|
66
|
-
|
|
67
|
-
const runHook = <T,>(fn: () => T): T => {
|
|
68
|
-
let result: T | undefined;
|
|
69
|
-
const Probe: React.FC = () => {
|
|
70
|
-
result = fn();
|
|
71
|
-
return null;
|
|
72
|
-
};
|
|
73
|
-
renderWithTheme(<Probe />);
|
|
74
|
-
return result as T;
|
|
75
|
-
};
|
|
76
|
-
|
|
77
|
-
describe("useAdminScripts", () => {
|
|
78
|
-
it("injects list runs, run, get task, and cancel task endpoints", () => {
|
|
79
|
-
const api = makeMockApi();
|
|
80
|
-
const hooks = runHook(() => useAdminScripts(api as never, "/admin"));
|
|
81
|
-
|
|
82
|
-
const injected = (api as Record<string, unknown>).__injected as CapturedEndpoints;
|
|
83
|
-
assert.isDefined(injected.adminListScriptRuns);
|
|
84
|
-
assert.isDefined(injected.adminRunScript);
|
|
85
|
-
assert.isDefined(injected.adminGetScriptTask);
|
|
86
|
-
assert.isDefined(injected.adminCancelScriptTask);
|
|
87
|
-
|
|
88
|
-
const listDef = injected.adminListScriptRuns;
|
|
89
|
-
const listQuery = listDef.query?.({limit: 10, name: "migrate", page: 2}) as {
|
|
90
|
-
method: string;
|
|
91
|
-
url: string;
|
|
92
|
-
};
|
|
93
|
-
assert.equal(listQuery.method, "GET");
|
|
94
|
-
assert.equal(listQuery.url, "/admin/scripts/runs?page=2&limit=10&name=migrate");
|
|
95
|
-
assert.deepEqual(listDef.providesTags, ["admin_scriptRuns"]);
|
|
96
|
-
|
|
97
|
-
const runDef = injected.adminRunScript;
|
|
98
|
-
assert.deepEqual(runDef.query?.({name: "cleanup", wetRun: true}), {
|
|
99
|
-
method: "POST",
|
|
100
|
-
url: "/admin/scripts/cleanup/run?wetRun=true",
|
|
101
|
-
});
|
|
102
|
-
assert.deepEqual(runDef.invalidatesTags, ["admin_scriptRuns"]);
|
|
103
|
-
|
|
104
|
-
const getDef = injected.adminGetScriptTask;
|
|
105
|
-
assert.deepEqual(getDef.query?.("task-42"), {
|
|
106
|
-
method: "GET",
|
|
107
|
-
url: "/admin/scripts/tasks/task-42",
|
|
108
|
-
});
|
|
109
|
-
assert.deepEqual(getDef.providesTags, ["admin_scriptTask"]);
|
|
110
|
-
|
|
111
|
-
const cancelDef = injected.adminCancelScriptTask;
|
|
112
|
-
assert.deepEqual(cancelDef.query?.("task-42"), {
|
|
113
|
-
method: "DELETE",
|
|
114
|
-
url: "/admin/scripts/tasks/task-42",
|
|
115
|
-
});
|
|
116
|
-
assert.deepEqual(cancelDef.invalidatesTags, ["admin_scriptTask", "admin_scriptRuns"]);
|
|
117
|
-
|
|
118
|
-
expect(typeof hooks.useListScriptRunsQuery).toBe("function");
|
|
119
|
-
expect(typeof hooks.useRunScriptMutation).toBe("function");
|
|
120
|
-
expect(typeof hooks.useGetScriptTaskQuery).toBe("function");
|
|
121
|
-
expect(typeof hooks.useCancelScriptTaskMutation).toBe("function");
|
|
122
|
-
});
|
|
123
|
-
|
|
124
|
-
it("returns no-op hooks when injectEndpoints is unavailable", () => {
|
|
125
|
-
const hooks = runHook(() => useAdminScripts({} as never, "/admin"));
|
|
126
|
-
|
|
127
|
-
const listResult = hooks.useListScriptRunsQuery();
|
|
128
|
-
assert.deepEqual(listResult, {
|
|
129
|
-
data: undefined,
|
|
130
|
-
error: null,
|
|
131
|
-
isFetching: false,
|
|
132
|
-
isLoading: false,
|
|
133
|
-
});
|
|
134
|
-
|
|
135
|
-
const [runMutation] = hooks.useRunScriptMutation();
|
|
136
|
-
assert.equal(typeof runMutation, "function");
|
|
137
|
-
const runResult = runMutation({name: "noop", wetRun: false});
|
|
138
|
-
assert.equal(typeof runResult.unwrap, "function");
|
|
139
|
-
|
|
140
|
-
const [cancelMutation] = hooks.useCancelScriptTaskMutation();
|
|
141
|
-
assert.equal(typeof cancelMutation, "function");
|
|
142
|
-
const cancelResult = cancelMutation("task-1");
|
|
143
|
-
assert.equal(typeof cancelResult.unwrap, "function");
|
|
144
|
-
|
|
145
|
-
const taskQuery = hooks.useGetScriptTaskQuery("task-1", {pollingInterval: 0, skip: true});
|
|
146
|
-
assert.deepEqual(taskQuery, {data: undefined, error: null, isLoading: false});
|
|
147
|
-
|
|
148
|
-
const skippedList = hooks.useListScriptRunsQuery({page: 1}, {skip: true});
|
|
149
|
-
assert.deepEqual(skippedList, {
|
|
150
|
-
data: undefined,
|
|
151
|
-
error: null,
|
|
152
|
-
isFetching: false,
|
|
153
|
-
isLoading: false,
|
|
154
|
-
});
|
|
155
|
-
});
|
|
156
|
-
});
|
|
@@ -1,156 +0,0 @@
|
|
|
1
|
-
import {describe, it} from "bun:test";
|
|
2
|
-
import {assert} from "chai";
|
|
3
|
-
import type {EndpointBuilder} from "../types";
|
|
4
|
-
import {adminOrganizationHeaders, buildAdminModelEndpoints} from "./adminModelEndpoints";
|
|
5
|
-
|
|
6
|
-
interface EndpointDefinition {
|
|
7
|
-
invalidatesTags?: string[] | unknown;
|
|
8
|
-
providesTags?: unknown;
|
|
9
|
-
query: (args: unknown) => Record<string, unknown>;
|
|
10
|
-
serializeQueryArgs?: (args: {endpointName: string; queryArgs: unknown}) => string;
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
const build = {
|
|
14
|
-
mutation: (definition: EndpointDefinition): EndpointDefinition => definition,
|
|
15
|
-
query: (definition: EndpointDefinition): EndpointDefinition => definition,
|
|
16
|
-
} as unknown as EndpointBuilder;
|
|
17
|
-
|
|
18
|
-
const buildFoodEndpoints = (organizationId: string | undefined) =>
|
|
19
|
-
buildAdminModelEndpoints(build, {
|
|
20
|
-
headers: adminOrganizationHeaders(organizationId),
|
|
21
|
-
modelName: "Food",
|
|
22
|
-
organizationId,
|
|
23
|
-
routePath: "/admin/foods",
|
|
24
|
-
});
|
|
25
|
-
|
|
26
|
-
describe("adminModelEndpoints", () => {
|
|
27
|
-
it("omits organization headers when no organization is selected", () => {
|
|
28
|
-
assert.isUndefined(adminOrganizationHeaders(undefined));
|
|
29
|
-
});
|
|
30
|
-
|
|
31
|
-
it("sends X-Organization-Id on list, read, and write endpoints", () => {
|
|
32
|
-
const endpoints = buildFoodEndpoints("org-1");
|
|
33
|
-
const list = endpoints.adminList_Food as EndpointDefinition;
|
|
34
|
-
const read = endpoints.adminRead_Food as EndpointDefinition;
|
|
35
|
-
const create = endpoints.adminCreate_Food as EndpointDefinition;
|
|
36
|
-
const update = endpoints.adminUpdate_Food as EndpointDefinition;
|
|
37
|
-
const deleteEndpoint = endpoints.adminDelete_Food as EndpointDefinition;
|
|
38
|
-
const bulkPatch = endpoints.adminBulkPatch_Food as EndpointDefinition;
|
|
39
|
-
|
|
40
|
-
assert.deepEqual(list.query(undefined).headers, {"X-Organization-Id": "org-1"});
|
|
41
|
-
assert.deepEqual(list.query({page: 1}).headers, {"X-Organization-Id": "org-1"});
|
|
42
|
-
assert.deepEqual(read.query("food-1").headers, {"X-Organization-Id": "org-1"});
|
|
43
|
-
assert.deepEqual(create.query({name: "Soup"}).headers, {"X-Organization-Id": "org-1"});
|
|
44
|
-
assert.deepEqual(update.query({body: {name: "Stew"}, id: "food-1"}).headers, {
|
|
45
|
-
"X-Organization-Id": "org-1",
|
|
46
|
-
});
|
|
47
|
-
assert.deepEqual(deleteEndpoint.query("food-1").headers, {"X-Organization-Id": "org-1"});
|
|
48
|
-
assert.deepEqual(bulkPatch.query({ids: ["food-1"], patch: {disabled: true}}).headers, {
|
|
49
|
-
"X-Organization-Id": "org-1",
|
|
50
|
-
});
|
|
51
|
-
});
|
|
52
|
-
|
|
53
|
-
it("builds every CRUD query and invalidates the collection or row tags", () => {
|
|
54
|
-
const endpoints = buildFoodEndpoints("org-1");
|
|
55
|
-
const list = endpoints.adminList_Food as EndpointDefinition;
|
|
56
|
-
const read = endpoints.adminRead_Food as EndpointDefinition;
|
|
57
|
-
const create = endpoints.adminCreate_Food as EndpointDefinition;
|
|
58
|
-
const update = endpoints.adminUpdate_Food as EndpointDefinition;
|
|
59
|
-
const deleteEndpoint = endpoints.adminDelete_Food as EndpointDefinition;
|
|
60
|
-
const bulkPatch = endpoints.adminBulkPatch_Food as EndpointDefinition;
|
|
61
|
-
|
|
62
|
-
assert.deepEqual(list.query(undefined), {
|
|
63
|
-
headers: {"X-Organization-Id": "org-1"},
|
|
64
|
-
method: "GET",
|
|
65
|
-
url: "/admin/foods",
|
|
66
|
-
});
|
|
67
|
-
assert.deepEqual(read.query("food-1"), {
|
|
68
|
-
headers: {"X-Organization-Id": "org-1"},
|
|
69
|
-
method: "GET",
|
|
70
|
-
url: "/admin/foods/food-1",
|
|
71
|
-
});
|
|
72
|
-
assert.deepEqual(create.query({name: "Soup"}), {
|
|
73
|
-
body: {name: "Soup"},
|
|
74
|
-
headers: {"X-Organization-Id": "org-1"},
|
|
75
|
-
method: "POST",
|
|
76
|
-
url: "/admin/foods",
|
|
77
|
-
});
|
|
78
|
-
assert.deepEqual(update.query({body: {name: "Stew"}, id: "food-1"}), {
|
|
79
|
-
body: {name: "Stew"},
|
|
80
|
-
headers: {"X-Organization-Id": "org-1"},
|
|
81
|
-
method: "PATCH",
|
|
82
|
-
url: "/admin/foods/food-1",
|
|
83
|
-
});
|
|
84
|
-
assert.deepEqual(deleteEndpoint.query("food-1"), {
|
|
85
|
-
headers: {"X-Organization-Id": "org-1"},
|
|
86
|
-
method: "DELETE",
|
|
87
|
-
url: "/admin/foods/food-1",
|
|
88
|
-
});
|
|
89
|
-
assert.deepEqual(bulkPatch.query({ids: ["food-1"], patch: {disabled: true}}), {
|
|
90
|
-
body: {ids: ["food-1"], patch: {disabled: true}},
|
|
91
|
-
headers: {"X-Organization-Id": "org-1"},
|
|
92
|
-
method: "POST",
|
|
93
|
-
url: "/admin/foods/bulk-patch",
|
|
94
|
-
});
|
|
95
|
-
|
|
96
|
-
assert.deepEqual(list.providesTags, ["admin_Food"]);
|
|
97
|
-
assert.deepEqual(create.invalidatesTags, ["admin_Food"]);
|
|
98
|
-
assert.deepEqual(deleteEndpoint.invalidatesTags, ["admin_Food"]);
|
|
99
|
-
assert.deepEqual(bulkPatch.invalidatesTags, ["admin_Food"]);
|
|
100
|
-
|
|
101
|
-
const readProvidesTags = read.providesTags as (
|
|
102
|
-
result: unknown,
|
|
103
|
-
error: unknown,
|
|
104
|
-
id: string
|
|
105
|
-
) => unknown;
|
|
106
|
-
assert.deepEqual(readProvidesTags(undefined, undefined, "food-1"), [
|
|
107
|
-
{id: "food-1", type: "admin_Food"},
|
|
108
|
-
]);
|
|
109
|
-
|
|
110
|
-
const updateInvalidatesTags = update.invalidatesTags as (
|
|
111
|
-
result: unknown,
|
|
112
|
-
error: unknown,
|
|
113
|
-
args: {id: string}
|
|
114
|
-
) => unknown;
|
|
115
|
-
assert.deepEqual(updateInvalidatesTags(undefined, undefined, {id: "food-1"}), [
|
|
116
|
-
{id: "food-1", type: "admin_Food"},
|
|
117
|
-
"admin_Food",
|
|
118
|
-
]);
|
|
119
|
-
});
|
|
120
|
-
|
|
121
|
-
it("rebuilds list and read cache keys when the selected organization changes", () => {
|
|
122
|
-
const first = buildFoodEndpoints("org-1");
|
|
123
|
-
const second = buildFoodEndpoints("org-2");
|
|
124
|
-
const firstList = first.adminList_Food as EndpointDefinition;
|
|
125
|
-
const secondList = second.adminList_Food as EndpointDefinition;
|
|
126
|
-
const firstRead = first.adminRead_Food as EndpointDefinition;
|
|
127
|
-
const secondRead = second.adminRead_Food as EndpointDefinition;
|
|
128
|
-
|
|
129
|
-
assert.notEqual(
|
|
130
|
-
firstList.serializeQueryArgs?.({endpointName: "adminList_Food", queryArgs: {}}),
|
|
131
|
-
secondList.serializeQueryArgs?.({endpointName: "adminList_Food", queryArgs: {}})
|
|
132
|
-
);
|
|
133
|
-
assert.notEqual(
|
|
134
|
-
firstRead.serializeQueryArgs?.({endpointName: "adminRead_Food", queryArgs: "food-1"}),
|
|
135
|
-
secondRead.serializeQueryArgs?.({endpointName: "adminRead_Food", queryArgs: "food-1"})
|
|
136
|
-
);
|
|
137
|
-
assert.equal(
|
|
138
|
-
firstList.serializeQueryArgs?.({endpointName: "adminList_Food", queryArgs: undefined}),
|
|
139
|
-
"adminList_Food:org-1:{}"
|
|
140
|
-
);
|
|
141
|
-
assert.equal(
|
|
142
|
-
firstRead.serializeQueryArgs?.({endpointName: "adminRead_Food", queryArgs: "food-1"}),
|
|
143
|
-
"adminRead_Food:org-1:food-1"
|
|
144
|
-
);
|
|
145
|
-
assert.equal(
|
|
146
|
-
buildFoodEndpoints(undefined).adminList_Food.serializeQueryArgs?.({
|
|
147
|
-
endpointName: "adminList_Food",
|
|
148
|
-
queryArgs: undefined,
|
|
149
|
-
}),
|
|
150
|
-
"adminList_Food::{}"
|
|
151
|
-
);
|
|
152
|
-
assert.deepEqual((second.adminList_Food as EndpointDefinition).query({}).headers, {
|
|
153
|
-
"X-Organization-Id": "org-2",
|
|
154
|
-
});
|
|
155
|
-
});
|
|
156
|
-
});
|
|
@@ -1,137 +0,0 @@
|
|
|
1
|
-
import {buildAdminApiListQueryRequest} from "../adminApiQueryParams";
|
|
2
|
-
import type {EndpointBuilder} from "../types";
|
|
3
|
-
|
|
4
|
-
type AdminPayload = Record<string, unknown>;
|
|
5
|
-
type TagArg = unknown;
|
|
6
|
-
|
|
7
|
-
export interface AdminModelEndpointContext {
|
|
8
|
-
headers: Record<string, string> | undefined;
|
|
9
|
-
modelName: string;
|
|
10
|
-
organizationId: string | undefined;
|
|
11
|
-
routePath: string;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
export const adminOrganizationHeaders = (
|
|
15
|
-
organizationId: string | undefined
|
|
16
|
-
): Record<string, string> | undefined => {
|
|
17
|
-
if (!organizationId) {
|
|
18
|
-
return undefined;
|
|
19
|
-
}
|
|
20
|
-
return {"X-Organization-Id": organizationId};
|
|
21
|
-
};
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* A list or read argument that carries the organization it was asked under. `useAdminApi` passes
|
|
25
|
-
* this shape so an organization switch changes the query argument itself: RTK Query then
|
|
26
|
-
* subscribes to the new organization's cache entry instead of waiting on one it never requests.
|
|
27
|
-
* A bare argument (direct endpoint callers) uses the organization the endpoints were built with.
|
|
28
|
-
*/
|
|
29
|
-
interface AdminOrgScopedArg<T> {
|
|
30
|
-
adminOrganizationScope: true;
|
|
31
|
-
args: T;
|
|
32
|
-
organizationId: string | undefined;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
export const adminOrgScopedArg = <T>(
|
|
36
|
-
args: T,
|
|
37
|
-
organizationId: string | undefined
|
|
38
|
-
): AdminOrgScopedArg<T> => ({adminOrganizationScope: true, args, organizationId});
|
|
39
|
-
|
|
40
|
-
const isAdminOrgScopedArg = <T>(value: unknown): value is AdminOrgScopedArg<T> =>
|
|
41
|
-
typeof value === "object" &&
|
|
42
|
-
value !== null &&
|
|
43
|
-
(value as {adminOrganizationScope?: unknown}).adminOrganizationScope === true;
|
|
44
|
-
|
|
45
|
-
export const buildAdminModelEndpoints = (
|
|
46
|
-
build: EndpointBuilder,
|
|
47
|
-
context: AdminModelEndpointContext
|
|
48
|
-
) => {
|
|
49
|
-
const listKey = `adminList_${context.modelName}`;
|
|
50
|
-
const readKey = `adminRead_${context.modelName}`;
|
|
51
|
-
const createKey = `adminCreate_${context.modelName}`;
|
|
52
|
-
const updateKey = `adminUpdate_${context.modelName}`;
|
|
53
|
-
const deleteKey = `adminDelete_${context.modelName}`;
|
|
54
|
-
const bulkPatchKey = `adminBulkPatch_${context.modelName}`;
|
|
55
|
-
const {headers, organizationId, routePath} = context;
|
|
56
|
-
// The arguments and organization one list or read call was asked with.
|
|
57
|
-
const unwrap = <T>(
|
|
58
|
-
value: T | AdminOrgScopedArg<T>
|
|
59
|
-
): {args: T; headers: Record<string, string> | undefined; organizationId: string | undefined} =>
|
|
60
|
-
isAdminOrgScopedArg<T>(value)
|
|
61
|
-
? {
|
|
62
|
-
args: value.args,
|
|
63
|
-
headers: adminOrganizationHeaders(value.organizationId),
|
|
64
|
-
organizationId: value.organizationId,
|
|
65
|
-
}
|
|
66
|
-
: {args: value, headers, organizationId};
|
|
67
|
-
|
|
68
|
-
return {
|
|
69
|
-
[listKey]: build.query({
|
|
70
|
-
providesTags: [`admin_${context.modelName}`],
|
|
71
|
-
query: (
|
|
72
|
-
arg:
|
|
73
|
-
| Record<string, unknown>
|
|
74
|
-
| undefined
|
|
75
|
-
| AdminOrgScopedArg<Record<string, unknown> | undefined>
|
|
76
|
-
) => {
|
|
77
|
-
const scoped = unwrap(arg);
|
|
78
|
-
return {...buildAdminApiListQueryRequest(routePath, scoped.args), headers: scoped.headers};
|
|
79
|
-
},
|
|
80
|
-
serializeQueryArgs: ({endpointName, queryArgs}) => {
|
|
81
|
-
const scoped = unwrap(queryArgs);
|
|
82
|
-
return `${endpointName}:${scoped.organizationId ?? ""}:${JSON.stringify(scoped.args ?? {})}`;
|
|
83
|
-
},
|
|
84
|
-
}),
|
|
85
|
-
[readKey]: build.query({
|
|
86
|
-
providesTags: (_result: TagArg, _error: TagArg, arg: string | AdminOrgScopedArg<string>) => [
|
|
87
|
-
{id: unwrap(arg).args, type: `admin_${context.modelName}`},
|
|
88
|
-
],
|
|
89
|
-
query: (arg: string | AdminOrgScopedArg<string>) => {
|
|
90
|
-
const scoped = unwrap(arg);
|
|
91
|
-
return {headers: scoped.headers, method: "GET", url: `${routePath}/${scoped.args}`};
|
|
92
|
-
},
|
|
93
|
-
serializeQueryArgs: ({endpointName, queryArgs}) => {
|
|
94
|
-
const scoped = unwrap(queryArgs);
|
|
95
|
-
return `${endpointName}:${scoped.organizationId ?? ""}:${String(scoped.args)}`;
|
|
96
|
-
},
|
|
97
|
-
}),
|
|
98
|
-
[createKey]: build.mutation({
|
|
99
|
-
invalidatesTags: [`admin_${context.modelName}`],
|
|
100
|
-
query: (body: AdminPayload) => ({
|
|
101
|
-
body,
|
|
102
|
-
headers,
|
|
103
|
-
method: "POST",
|
|
104
|
-
url: routePath,
|
|
105
|
-
}),
|
|
106
|
-
}),
|
|
107
|
-
[updateKey]: build.mutation({
|
|
108
|
-
invalidatesTags: (_result: TagArg, _error: TagArg, {id}: {id: string}) => [
|
|
109
|
-
{id, type: `admin_${context.modelName}`},
|
|
110
|
-
`admin_${context.modelName}`,
|
|
111
|
-
],
|
|
112
|
-
query: ({id, body}: {id: string; body: AdminPayload}) => ({
|
|
113
|
-
body,
|
|
114
|
-
headers,
|
|
115
|
-
method: "PATCH",
|
|
116
|
-
url: `${routePath}/${id}`,
|
|
117
|
-
}),
|
|
118
|
-
}),
|
|
119
|
-
[deleteKey]: build.mutation({
|
|
120
|
-
invalidatesTags: [`admin_${context.modelName}`],
|
|
121
|
-
query: (id: string) => ({
|
|
122
|
-
headers,
|
|
123
|
-
method: "DELETE",
|
|
124
|
-
url: `${routePath}/${id}`,
|
|
125
|
-
}),
|
|
126
|
-
}),
|
|
127
|
-
[bulkPatchKey]: build.mutation({
|
|
128
|
-
invalidatesTags: [`admin_${context.modelName}`],
|
|
129
|
-
query: ({ids, patch}: {ids: string[]; patch: Record<string, unknown>}) => ({
|
|
130
|
-
body: {ids, patch},
|
|
131
|
-
headers,
|
|
132
|
-
method: "POST",
|
|
133
|
-
url: `${routePath}/bulk-patch`,
|
|
134
|
-
}),
|
|
135
|
-
}),
|
|
136
|
-
};
|
|
137
|
-
};
|
package/src/useAdminApi.test.ts
DELETED
|
@@ -1,88 +0,0 @@
|
|
|
1
|
-
import {describe, it} from "bun:test";
|
|
2
|
-
import {assert} from "chai";
|
|
3
|
-
|
|
4
|
-
import {buildAdminApiListQueryRequest} from "./adminApiQueryParams";
|
|
5
|
-
|
|
6
|
-
describe("serializeAdminApiQueryParams", () => {
|
|
7
|
-
it("serializes scalar choice filters", () => {
|
|
8
|
-
const serialized = buildAdminApiListQueryRequest("/admin/todos", {
|
|
9
|
-
limit: 25,
|
|
10
|
-
page: 1,
|
|
11
|
-
priority: "high",
|
|
12
|
-
}).url;
|
|
13
|
-
assert.include(serialized, "priority=high");
|
|
14
|
-
assert.include(serialized, "limit=25");
|
|
15
|
-
assert.notInclude(serialized, "object");
|
|
16
|
-
});
|
|
17
|
-
|
|
18
|
-
it("serializes empty-only choice filters with bracketed $in keys", () => {
|
|
19
|
-
const serialized = buildAdminApiListQueryRequest("/admin/todos", {
|
|
20
|
-
limit: 25,
|
|
21
|
-
page: 1,
|
|
22
|
-
priority: {$in: ["__empty__"]},
|
|
23
|
-
}).url;
|
|
24
|
-
assert.include(decodeURIComponent(serialized), "priority[$in][0]=__empty__");
|
|
25
|
-
assert.notInclude(serialized, "object");
|
|
26
|
-
});
|
|
27
|
-
|
|
28
|
-
it("serializes multi-choice $in filters with bracketed keys", () => {
|
|
29
|
-
const serialized = buildAdminApiListQueryRequest("/admin/todos", {
|
|
30
|
-
status: {$in: ["open", "closed"]},
|
|
31
|
-
}).url;
|
|
32
|
-
assert.include(decodeURIComponent(serialized), "status[$in][0]=open");
|
|
33
|
-
assert.include(decodeURIComponent(serialized), "status[$in][1]=closed");
|
|
34
|
-
});
|
|
35
|
-
|
|
36
|
-
it("serializes empty plus concrete choice values in one $in", () => {
|
|
37
|
-
const serialized = buildAdminApiListQueryRequest("/admin/todos", {
|
|
38
|
-
priority: {$in: ["high", "__empty__"]},
|
|
39
|
-
}).url;
|
|
40
|
-
assert.include(decodeURIComponent(serialized), "priority[$in][0]=high");
|
|
41
|
-
assert.include(decodeURIComponent(serialized), "priority[$in][1]=__empty__");
|
|
42
|
-
});
|
|
43
|
-
});
|
|
44
|
-
|
|
45
|
-
describe("buildAdminApiListQueryUrl", () => {
|
|
46
|
-
it("embeds serialized nested params in the URL instead of RTK params", () => {
|
|
47
|
-
const url = buildAdminApiListQueryRequest("/admin/todos", {
|
|
48
|
-
limit: 25,
|
|
49
|
-
page: 1,
|
|
50
|
-
priority: {$in: ["__empty__"]},
|
|
51
|
-
}).url;
|
|
52
|
-
assert.isTrue(url.startsWith("/admin/todos?"));
|
|
53
|
-
assert.include(decodeURIComponent(url), "priority[$in][0]=__empty__");
|
|
54
|
-
assert.notInclude(url, "[object Object]");
|
|
55
|
-
});
|
|
56
|
-
});
|
|
57
|
-
|
|
58
|
-
describe("buildAdminApiListQueryRequest", () => {
|
|
59
|
-
it("leaves the route unchanged when there are no serializable params", () => {
|
|
60
|
-
assert.deepEqual(buildAdminApiListQueryRequest("/admin/todos", undefined), {
|
|
61
|
-
method: "GET",
|
|
62
|
-
url: "/admin/todos",
|
|
63
|
-
});
|
|
64
|
-
assert.deepEqual(buildAdminApiListQueryRequest("/admin/todos", {priority: undefined}), {
|
|
65
|
-
method: "GET",
|
|
66
|
-
url: "/admin/todos",
|
|
67
|
-
});
|
|
68
|
-
});
|
|
69
|
-
|
|
70
|
-
it("returns a GET url with qs-serialized nested filters and no params object", () => {
|
|
71
|
-
const listRequest = buildAdminApiListQueryRequest("/admin/todos", {
|
|
72
|
-
limit: 25,
|
|
73
|
-
page: 1,
|
|
74
|
-
priority: {$in: ["__empty__"]},
|
|
75
|
-
});
|
|
76
|
-
|
|
77
|
-
assert.equal(listRequest.method, "GET");
|
|
78
|
-
assert.include(decodeURIComponent(listRequest.url), "priority[$in][0]=__empty__");
|
|
79
|
-
assert.notInclude(listRequest.url, "[object Object]");
|
|
80
|
-
});
|
|
81
|
-
|
|
82
|
-
it("documents default URLSearchParams coercion that breaks nested operators", () => {
|
|
83
|
-
const broken = new URLSearchParams({
|
|
84
|
-
priority: String({$in: ["__empty__"]}),
|
|
85
|
-
}).toString();
|
|
86
|
-
assert.equal(broken, "priority=%5Bobject+Object%5D");
|
|
87
|
-
});
|
|
88
|
-
});
|
package/src/useAdminApi.ts
DELETED
|
@@ -1,99 +0,0 @@
|
|
|
1
|
-
import {useMemo} from "react";
|
|
2
|
-
import {asDynamicHookApi} from "./dynamicHookApi";
|
|
3
|
-
import {
|
|
4
|
-
adminOrganizationHeaders,
|
|
5
|
-
adminOrgScopedArg,
|
|
6
|
-
buildAdminModelEndpoints,
|
|
7
|
-
} from "./orgs/adminModelEndpoints";
|
|
8
|
-
import {useOptionalOrgContext} from "./orgs/useOrgContext";
|
|
9
|
-
import type {AdminApi, EndpointBuilder} from "./types";
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* Hook that generates RTK Query CRUD hooks for a specific admin model.
|
|
13
|
-
*
|
|
14
|
-
* Dynamically injects endpoints for list, read, create, update, and delete operations
|
|
15
|
-
* into the provided RTK Query API. Returns typed hooks for each operation with automatic
|
|
16
|
-
* cache invalidation tags.
|
|
17
|
-
*
|
|
18
|
-
* @param api - RTK Query API instance to inject endpoints into
|
|
19
|
-
* @param routePath - Full route path to the model's endpoints (e.g., "/admin/users")
|
|
20
|
-
* @param modelName - Name of the model for cache tag generation (e.g., "User")
|
|
21
|
-
* @returns Object with hooks: `useListQuery`, `useReadQuery`, `useCreateMutation`, `useUpdateMutation`, `useDeleteMutation`
|
|
22
|
-
*
|
|
23
|
-
* @example
|
|
24
|
-
* ```typescript
|
|
25
|
-
* import {useAdminApi} from "@terreno/admin-frontend";
|
|
26
|
-
* import {api} from "@/store/openApiSdk";
|
|
27
|
-
*
|
|
28
|
-
* function UserList() {
|
|
29
|
-
* const {useListQuery, useCreateMutation, useDeleteMutation} = useAdminApi(
|
|
30
|
-
* api,
|
|
31
|
-
* "/admin/users",
|
|
32
|
-
* "User"
|
|
33
|
-
* );
|
|
34
|
-
*
|
|
35
|
-
* const {data, isLoading} = useListQuery({limit: 20, page: 1});
|
|
36
|
-
* const [create, {isLoading: isCreating}] = useCreateMutation();
|
|
37
|
-
* const [deleteUser] = useDeleteMutation();
|
|
38
|
-
*
|
|
39
|
-
* const handleCreate = async () => {
|
|
40
|
-
* await create({email: "test@example.com", name: "Test"}).unwrap();
|
|
41
|
-
* };
|
|
42
|
-
*
|
|
43
|
-
* const handleDelete = async (id: string) => {
|
|
44
|
-
* await deleteUser(id).unwrap();
|
|
45
|
-
* };
|
|
46
|
-
*
|
|
47
|
-
* return <DataTable data={data?.data} />;
|
|
48
|
-
* }
|
|
49
|
-
* ```
|
|
50
|
-
*
|
|
51
|
-
* @see useAdminConfig for fetching model configurations
|
|
52
|
-
* @see AdminModelTable for usage in the table view
|
|
53
|
-
*/
|
|
54
|
-
/** RTK Query hook options (`skip`, `pollingInterval`, ...), passed through as given. */
|
|
55
|
-
interface AdminQueryHookOptions {
|
|
56
|
-
skip?: boolean;
|
|
57
|
-
[option: string]: unknown;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
export const useAdminApi = (api: AdminApi, routePath: string, modelName: string) => {
|
|
61
|
-
const organizationId = useOptionalOrgContext()?.organizationId;
|
|
62
|
-
const headers = useMemo(() => adminOrganizationHeaders(organizationId), [organizationId]);
|
|
63
|
-
const enhancedApi = useMemo(() => {
|
|
64
|
-
const tagType = `admin_${modelName}`;
|
|
65
|
-
return api.enhanceEndpoints({addTagTypes: [tagType]}).injectEndpoints({
|
|
66
|
-
endpoints: (build: EndpointBuilder) =>
|
|
67
|
-
buildAdminModelEndpoints(build, {headers, modelName, organizationId, routePath}),
|
|
68
|
-
overrideExisting: true,
|
|
69
|
-
});
|
|
70
|
-
}, [api, headers, modelName, organizationId, routePath]);
|
|
71
|
-
|
|
72
|
-
const capitalize = (s: string) => s.charAt(0).toUpperCase() + s.slice(1);
|
|
73
|
-
const listKey = `adminList_${modelName}`;
|
|
74
|
-
const readKey = `adminRead_${modelName}`;
|
|
75
|
-
const createKey = `adminCreate_${modelName}`;
|
|
76
|
-
const updateKey = `adminUpdate_${modelName}`;
|
|
77
|
-
const deleteKey = `adminDelete_${modelName}`;
|
|
78
|
-
const bulkPatchKey = `adminBulkPatch_${modelName}`;
|
|
79
|
-
|
|
80
|
-
const enhanced = asDynamicHookApi(enhancedApi);
|
|
81
|
-
const useRawListQuery = enhanced[`use${capitalize(listKey)}Query`];
|
|
82
|
-
const useRawReadQuery = enhanced[`use${capitalize(readKey)}Query`];
|
|
83
|
-
// The organization rides in the argument, so switching it (such as the org switcher settling
|
|
84
|
-
// on a default after a read started) changes the argument and RTK Query fetches the new
|
|
85
|
-
// organization's entry. Kept in the closure only, the cache key moved while the subscription
|
|
86
|
-
// stayed on the old entry and the screen waited on a request that never went out.
|
|
87
|
-
const useListQuery = (params?: Record<string, unknown>, options?: AdminQueryHookOptions) =>
|
|
88
|
-
useRawListQuery(adminOrgScopedArg(params, organizationId), options);
|
|
89
|
-
const useReadQuery = (id: string, options?: AdminQueryHookOptions) =>
|
|
90
|
-
useRawReadQuery(adminOrgScopedArg(id, organizationId), options);
|
|
91
|
-
return {
|
|
92
|
-
useBulkPatchMutation: enhanced[`use${capitalize(bulkPatchKey)}Mutation`],
|
|
93
|
-
useCreateMutation: enhanced[`use${capitalize(createKey)}Mutation`],
|
|
94
|
-
useDeleteMutation: enhanced[`use${capitalize(deleteKey)}Mutation`],
|
|
95
|
-
useListQuery,
|
|
96
|
-
useReadQuery,
|
|
97
|
-
useUpdateMutation: enhanced[`use${capitalize(updateKey)}Mutation`],
|
|
98
|
-
};
|
|
99
|
-
};
|