@terreno/admin-frontend 57.2.0 → 57.4.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/.ai/guidelines/core.md +14 -7
- package/README.md +6 -2
- package/dist/AdminConflictSheet.d.ts +16 -0
- package/dist/AdminConflictSheet.js +52 -0
- package/dist/AdminConflictSheet.js.map +1 -0
- package/dist/AdminHome.js +2 -1
- package/dist/AdminHome.js.map +1 -1
- package/dist/AdminMigrations.d.ts +3 -0
- package/dist/AdminMigrations.js +19 -0
- package/dist/AdminMigrations.js.map +1 -0
- package/dist/AdminMigrationsView.d.ts +10 -0
- package/dist/AdminMigrationsView.js +94 -0
- package/dist/AdminMigrationsView.js.map +1 -0
- package/dist/AdminModelForm.js +190 -44
- package/dist/AdminModelForm.js.map +1 -1
- package/dist/AdminModelTable.js +315 -27
- package/dist/AdminModelTable.js.map +1 -1
- package/dist/AdminObjectPicker.js +30 -6
- package/dist/AdminObjectPicker.js.map +1 -1
- package/dist/AdminProvider.d.ts +6 -2
- package/dist/AdminProvider.js +29 -7
- package/dist/AdminProvider.js.map +1 -1
- package/dist/AdminScreenPage.d.ts +18 -0
- package/dist/AdminScreenPage.js +35 -0
- package/dist/AdminScreenPage.js.map +1 -0
- package/dist/AdminScreenRouter.d.ts +1 -1
- package/dist/AdminScreenRouter.js +8 -3
- package/dist/AdminScreenRouter.js.map +1 -1
- package/dist/AdminShell.d.ts +7 -3
- package/dist/AdminShell.js +53 -24
- package/dist/AdminShell.js.map +1 -1
- package/dist/AdminVersionConfig.js +21 -2
- package/dist/AdminVersionConfig.js.map +1 -1
- package/dist/AnnouncementEditor.d.ts +45 -0
- package/dist/AnnouncementEditor.js +370 -0
- package/dist/AnnouncementEditor.js.map +1 -0
- package/dist/AnnouncementList.d.ts +15 -0
- package/dist/AnnouncementList.js +97 -0
- package/dist/AnnouncementList.js.map +1 -0
- package/dist/AnnouncementOverview.d.ts +46 -0
- package/dist/AnnouncementOverview.js +101 -0
- package/dist/AnnouncementOverview.js.map +1 -0
- package/dist/AnnouncementOverviewScreenWidget.d.ts +4 -0
- package/dist/AnnouncementOverviewScreenWidget.js +28 -0
- package/dist/AnnouncementOverviewScreenWidget.js.map +1 -0
- package/dist/ConsentFormEditor.js +20 -3
- package/dist/ConsentFormEditor.js.map +1 -1
- package/dist/DocumentStorageBrowser.js +6 -89
- package/dist/DocumentStorageBrowser.js.map +1 -1
- package/dist/adminApiQueryParams.d.ts +5 -0
- package/dist/adminApiQueryParams.js +25 -0
- package/dist/adminApiQueryParams.js.map +1 -0
- package/dist/adminConflictSheetStack.d.ts +17 -0
- package/dist/adminConflictSheetStack.js +64 -0
- package/dist/adminConflictSheetStack.js.map +1 -0
- package/dist/adminContext.d.ts +3 -0
- package/dist/adminContext.js +6 -0
- package/dist/adminContext.js.map +1 -0
- package/dist/adminModelListQueryParams.d.ts +3 -2
- package/dist/adminModelListQueryParams.js +74 -27
- package/dist/adminModelListQueryParams.js.map +1 -1
- package/dist/adminRequest.d.ts +51 -0
- package/dist/adminRequest.js +161 -0
- package/dist/adminRequest.js.map +1 -0
- package/dist/adminRpc.d.ts +7 -0
- package/dist/adminRpc.js +21 -0
- package/dist/adminRpc.js.map +1 -0
- package/dist/adminShellNav.d.ts +17 -1
- package/dist/adminShellNav.js +41 -9
- package/dist/adminShellNav.js.map +1 -1
- package/dist/adminWindowRefresh.d.ts +31 -0
- package/dist/adminWindowRefresh.js +48 -0
- package/dist/adminWindowRefresh.js.map +1 -0
- package/dist/adminWindowedTable.d.ts +13 -0
- package/dist/adminWindowedTable.js +33 -0
- package/dist/adminWindowedTable.js.map +1 -0
- package/dist/comms/CommsDashboardScreen.d.ts +10 -0
- package/dist/comms/CommsDashboardScreen.js +183 -0
- package/dist/comms/CommsDashboardScreen.js.map +1 -0
- package/dist/comms/CommsDashboardScreenWidget.d.ts +4 -0
- package/dist/comms/CommsDashboardScreenWidget.js +11 -0
- package/dist/comms/CommsDashboardScreenWidget.js.map +1 -0
- package/dist/comms/CommsMessageDetail.d.ts +8 -0
- package/dist/comms/CommsMessageDetail.js +50 -0
- package/dist/comms/CommsMessageDetail.js.map +1 -0
- package/dist/comms/CommsStatCard.d.ts +17 -0
- package/dist/comms/CommsStatCard.js +14 -0
- package/dist/comms/CommsStatCard.js.map +1 -0
- package/dist/comms/CommsStatusBadge.d.ts +5 -0
- package/dist/comms/CommsStatusBadge.js +14 -0
- package/dist/comms/CommsStatusBadge.js.map +1 -0
- package/dist/comms/commsDashboardParams.d.ts +13 -0
- package/dist/comms/commsDashboardParams.js +71 -0
- package/dist/comms/commsDashboardParams.js.map +1 -0
- package/dist/comms/commsMessagePayload.d.ts +50 -0
- package/dist/comms/commsMessagePayload.js +43 -0
- package/dist/comms/commsMessagePayload.js.map +1 -0
- package/dist/comms/commsRetrySummary.d.ts +4 -0
- package/dist/comms/commsRetrySummary.js +12 -0
- package/dist/comms/commsRetrySummary.js.map +1 -0
- package/dist/comms/useCommsDashboardApi.d.ts +78 -0
- package/dist/comms/useCommsDashboardApi.js +101 -0
- package/dist/comms/useCommsDashboardApi.js.map +1 -0
- package/dist/comms/useCommsDashboardUrlFilters.d.ts +5 -0
- package/dist/comms/useCommsDashboardUrlFilters.js +16 -0
- package/dist/comms/useCommsDashboardUrlFilters.js.map +1 -0
- package/dist/index.d.ts +31 -2
- package/dist/index.js +30 -1
- package/dist/index.js.map +1 -1
- package/dist/isAuditLogModel.d.ts +2 -0
- package/dist/isAuditLogModel.js +8 -0
- package/dist/isAuditLogModel.js.map +1 -0
- package/dist/jobs/JobsDashboardScreen.d.ts +10 -0
- package/dist/jobs/JobsDashboardScreen.js +155 -0
- package/dist/jobs/JobsDashboardScreen.js.map +1 -0
- package/dist/jobs/JobsDashboardScreenWidget.d.ts +4 -0
- package/dist/jobs/JobsDashboardScreenWidget.js +11 -0
- package/dist/jobs/JobsDashboardScreenWidget.js.map +1 -0
- package/dist/jobs/JobsHomeWidget.d.ts +4 -0
- package/dist/jobs/JobsHomeWidget.js +21 -0
- package/dist/jobs/JobsHomeWidget.js.map +1 -0
- package/dist/jobs/JobsJobDetail.d.ts +8 -0
- package/dist/jobs/JobsJobDetail.js +78 -0
- package/dist/jobs/JobsJobDetail.js.map +1 -0
- package/dist/jobs/JobsStatusBadge.d.ts +5 -0
- package/dist/jobs/JobsStatusBadge.js +16 -0
- package/dist/jobs/JobsStatusBadge.js.map +1 -0
- package/dist/jobs/jobPayload.d.ts +62 -0
- package/dist/jobs/jobPayload.js +54 -0
- package/dist/jobs/jobPayload.js.map +1 -0
- package/dist/jobs/jobsDashboardParams.d.ts +11 -0
- package/dist/jobs/jobsDashboardParams.js +70 -0
- package/dist/jobs/jobsDashboardParams.js.map +1 -0
- package/dist/jobs/useJobsDashboardApi.d.ts +60 -0
- package/dist/jobs/useJobsDashboardApi.js +88 -0
- package/dist/jobs/useJobsDashboardApi.js.map +1 -0
- package/dist/jobs/useJobsDashboardUrlFilters.d.ts +5 -0
- package/dist/jobs/useJobsDashboardUrlFilters.js +16 -0
- package/dist/jobs/useJobsDashboardUrlFilters.js.map +1 -0
- package/dist/orgs/OrgDirectoryScreen.d.ts +16 -0
- package/dist/orgs/OrgDirectoryScreen.js +81 -0
- package/dist/orgs/OrgDirectoryScreen.js.map +1 -0
- package/dist/orgs/OrgMembersScreen.d.ts +9 -0
- package/dist/orgs/OrgMembersScreen.js +115 -0
- package/dist/orgs/OrgMembersScreen.js.map +1 -0
- package/dist/orgs/OrgSettingsScreen.d.ts +9 -0
- package/dist/orgs/OrgSettingsScreen.js +80 -0
- package/dist/orgs/OrgSettingsScreen.js.map +1 -0
- package/dist/orgs/OrgSwitcher.d.ts +8 -0
- package/dist/orgs/OrgSwitcher.js +58 -0
- package/dist/orgs/OrgSwitcher.js.map +1 -0
- package/dist/orgs/adminModelEndpoints.d.ts +18 -0
- package/dist/orgs/adminModelEndpoints.js +73 -0
- package/dist/orgs/adminModelEndpoints.js.map +1 -0
- package/dist/orgs/normalizeListData.d.ts +9 -0
- package/dist/orgs/normalizeListData.js +8 -0
- package/dist/orgs/normalizeListData.js.map +1 -0
- package/dist/orgs/organizationSettings.d.ts +17 -0
- package/dist/orgs/organizationSettings.js +6 -0
- package/dist/orgs/organizationSettings.js.map +1 -0
- package/dist/orgs/shouldSkipOrgScopedAdminQuery.d.ts +4 -0
- package/dist/orgs/shouldSkipOrgScopedAdminQuery.js +2 -0
- package/dist/orgs/shouldSkipOrgScopedAdminQuery.js.map +1 -0
- package/dist/orgs/sortOrganizations.d.ts +6 -0
- package/dist/orgs/sortOrganizations.js +9 -0
- package/dist/orgs/sortOrganizations.js.map +1 -0
- package/dist/orgs/useOrgContext.d.ts +20 -0
- package/dist/orgs/useOrgContext.js +57 -0
- package/dist/orgs/useOrgContext.js.map +1 -0
- package/dist/orgs/useOrganizationsApi.d.ts +14 -0
- package/dist/orgs/useOrganizationsApi.js +103 -0
- package/dist/orgs/useOrganizationsApi.js.map +1 -0
- package/dist/pdfUtils.d.ts +0 -2
- package/dist/pdfUtils.js +2 -2
- package/dist/pdfUtils.js.map +1 -1
- package/dist/types.d.ts +102 -4
- package/dist/types.js.map +1 -1
- package/dist/useAdminApi.js +7 -61
- package/dist/useAdminApi.js.map +1 -1
- package/dist/useAdminBackgroundTask.d.ts +11 -3
- package/dist/useAdminBackgroundTask.js +18 -3
- package/dist/useAdminBackgroundTask.js.map +1 -1
- package/dist/useAdminConfig.js +16 -1
- package/dist/useAdminConfig.js.map +1 -1
- package/dist/useAdminMigrations.d.ts +40 -0
- package/dist/useAdminMigrations.js +43 -0
- package/dist/useAdminMigrations.js.map +1 -0
- package/dist/useAdminRoles.d.ts +1 -0
- package/dist/useAdminRoles.js +34 -0
- package/dist/useAdminRoles.js.map +1 -1
- package/dist/useAdminRpc.d.ts +28 -0
- package/dist/useAdminRpc.js +128 -0
- package/dist/useAdminRpc.js.map +1 -0
- package/dist/useAdminScripts.js +51 -0
- package/dist/useAdminScripts.js.map +1 -1
- package/dist/useConfigurationApi.d.ts +13 -15
- package/dist/useConfigurationApi.js +23 -0
- package/dist/useConfigurationApi.js.map +1 -1
- package/dist/useConsentHistory.js +9 -1
- package/dist/useConsentHistory.js.map +1 -1
- package/dist/useDocumentStorageApi.js +72 -0
- package/dist/useDocumentStorageApi.js.map +1 -1
- package/dist/widgets/AIRequestsScreenWidget.js +21 -10
- package/dist/widgets/AIRequestsScreenWidget.js.map +1 -1
- package/dist/widgets/DocumentsScreenWidget.js +2 -2
- package/dist/widgets/DocumentsScreenWidget.js.map +1 -1
- package/dist/widgets/ModelsGridWidget.js +10 -3
- package/dist/widgets/ModelsGridWidget.js.map +1 -1
- package/dist/widgets/RecentActivityWidget.js +11 -4
- package/dist/widgets/RecentActivityWidget.js.map +1 -1
- package/dist/widgets/builtInWidgets.js +6 -9
- package/dist/widgets/builtInWidgets.js.map +1 -1
- package/dist/widgets/homeWidgetUtils.d.ts +0 -1
- package/dist/widgets/homeWidgetUtils.js +0 -8
- package/dist/widgets/homeWidgetUtils.js.map +1 -1
- package/package.json +21 -5
- package/src/AdminActionMenu.test.tsx +168 -1
- package/src/AdminBreadcrumbs.test.tsx +22 -2
- package/src/AdminConflictSheet.test.tsx +173 -0
- package/src/AdminConflictSheet.tsx +102 -0
- package/src/AdminFieldRenderer.test.tsx +6 -1
- package/src/AdminHome.test.tsx +11 -12
- package/src/AdminHome.tsx +2 -4
- package/src/AdminMigrations.tsx +45 -0
- package/src/AdminMigrationsView.tsx +225 -0
- package/src/{AdminModelForm.test.tsx → AdminModelForm.isolated.tsx} +462 -155
- package/src/AdminModelForm.orgSkip.test.tsx +81 -0
- package/src/AdminModelForm.tsx +227 -56
- package/src/AdminModelForm.updateDepth.test.tsx +427 -0
- package/src/AdminModelList.test.tsx +13 -3
- package/src/AdminModelTable.test.tsx +561 -58
- package/src/AdminModelTable.tsx +430 -73
- package/src/AdminModelTable.windowed.test.tsx +897 -0
- package/src/AdminObjectPicker.tsx +32 -6
- package/src/AdminPrimitiveArrayField.test.tsx +179 -1
- package/src/AdminProvider.test.tsx +213 -3
- package/src/AdminProvider.tsx +39 -7
- package/src/AdminRolesList.test.tsx +198 -1
- package/src/AdminScreenPage.test.tsx +81 -0
- package/src/AdminScreenPage.tsx +37 -0
- package/src/AdminScreenRouter.test.tsx +395 -37
- package/src/AdminScreenRouter.tsx +24 -6
- package/src/AdminScriptList.test.tsx +181 -1
- package/src/AdminShell.test.tsx +596 -2
- package/src/AdminShell.tsx +110 -22
- package/src/AdminVersionConfig.test.tsx +1 -1
- package/src/AdminVersionConfig.tsx +31 -3
- package/src/AnnouncementEditor.test.tsx +603 -0
- package/src/AnnouncementEditor.tsx +673 -0
- package/src/AnnouncementList.test.tsx +198 -0
- package/src/AnnouncementList.tsx +214 -0
- package/src/AnnouncementOverview.test.tsx +325 -0
- package/src/AnnouncementOverview.tsx +325 -0
- package/src/AnnouncementOverviewScreenWidget.test.tsx +69 -0
- package/src/AnnouncementOverviewScreenWidget.tsx +51 -0
- package/src/CheckboxListEditor.test.tsx +9 -2
- package/src/ConfigurationScreen.test.tsx +1 -1
- package/src/ConsentFormEditor.test.tsx +29 -30
- package/src/ConsentFormEditor.tsx +27 -3
- package/src/ConsentFormList.test.tsx +13 -12
- package/src/ConsentHistory.test.tsx +1 -1
- package/src/ConsentResponseViewer.test.tsx +11 -12
- package/src/DocumentStorageBrowser.test.tsx +1 -1
- package/src/DocumentStorageBrowser.tsx +12 -142
- package/src/LocaleContentEditor.test.tsx +1 -1
- package/src/adminApiQueryParams.ts +33 -0
- package/src/adminConflictSheetStack.ts +87 -0
- package/src/adminContext.ts +8 -0
- package/src/adminModelListQueryParams.test.ts +118 -0
- package/src/adminModelListQueryParams.ts +89 -30
- package/src/adminRequest.test.ts +216 -0
- package/src/adminRequest.ts +213 -0
- package/src/adminRpc.test.ts +18 -0
- package/src/adminRpc.ts +31 -0
- package/src/adminScriptsHarness.test.ts +21 -0
- package/src/adminShellNav.test.ts +72 -6
- package/src/adminShellNav.ts +55 -10
- package/src/adminWindowRefresh.test.ts +65 -0
- package/src/adminWindowRefresh.ts +76 -0
- package/src/adminWindowedTable.test.ts +90 -0
- package/src/adminWindowedTable.ts +55 -0
- package/src/comms/CommsDashboardScreen.test.tsx +397 -0
- package/src/comms/CommsDashboardScreen.tsx +500 -0
- package/src/comms/CommsDashboardScreenWidget.test.tsx +62 -0
- package/src/comms/CommsDashboardScreenWidget.tsx +20 -0
- package/src/comms/CommsMessageDetail.test.tsx +245 -0
- package/src/comms/CommsMessageDetail.tsx +239 -0
- package/src/comms/CommsStatCard.test.tsx +69 -0
- package/src/comms/CommsStatCard.tsx +60 -0
- package/src/comms/CommsStatusBadge.tsx +14 -0
- package/src/comms/commsDashboardParams.test.ts +75 -0
- package/src/comms/commsDashboardParams.ts +91 -0
- package/src/comms/commsMessagePayload.test.ts +22 -0
- package/src/comms/commsMessagePayload.ts +83 -0
- package/src/comms/commsRetrySummary.ts +10 -0
- package/src/comms/useCommsDashboardApi.test.tsx +144 -0
- package/src/comms/useCommsDashboardApi.tsx +181 -0
- package/src/comms/useCommsDashboardUrlFilters.test.tsx +58 -0
- package/src/comms/useCommsDashboardUrlFilters.tsx +31 -0
- package/src/dynamicHookApi.ts +1 -1
- package/src/index.tsx +93 -1
- package/src/isAuditLogModel.test.ts +14 -0
- package/src/isAuditLogModel.ts +11 -0
- package/src/isolated/AIRequestsScreenWidget.isolated.tsx +84 -0
- package/src/isolated/AdminFieldRenderer.isolated.tsx +161 -1
- package/src/isolated/AdminFilterDrawer.isolated.tsx +308 -0
- package/src/isolated/AdminFilterDrawerMobile.isolated.tsx +172 -0
- package/src/isolated/AdminHomeWidgets.isolated.tsx +73 -0
- package/src/isolated/AdminNestedArrayField.isolated.tsx +1 -1
- package/src/isolated/AdminObjectPicker.isolated.tsx +8 -1
- package/src/isolated/AdminRefField.isolated.tsx +1 -1
- package/src/isolated/AdminScriptList.isolated.tsx +124 -0
- package/src/isolated/AdminScriptRunModal.isolated.tsx +275 -5
- package/src/isolated/DocumentStorageBrowser.isolated.tsx +14 -1
- package/src/isolated/RecentActivityWidget.isolated.tsx +138 -0
- package/src/isolated/adminWidgets.isolated.tsx +190 -0
- package/src/isolated/generateConsentHistoryPdf.isolated.ts +251 -0
- package/src/isolated/generateConsentPdfMobile.isolated.ts +87 -0
- package/src/isolated/generateConsentPdfsMobile.isolated.ts +129 -0
- package/src/isolated/hooks.isolated.tsx +246 -4
- package/src/isolated/rpcDualRun.isolated.tsx +449 -0
- package/src/isolated/useAdminScripts.isolated.tsx +156 -0
- package/src/isolated/useJobsDashboardApi.isolated.tsx +60 -0
- package/src/jobs/JobsDashboardScreen.test.tsx +310 -0
- package/src/jobs/JobsDashboardScreen.tsx +461 -0
- package/src/jobs/JobsDashboardScreenWidget.test.tsx +83 -0
- package/src/jobs/JobsDashboardScreenWidget.tsx +20 -0
- package/src/jobs/JobsHomeWidget.test.tsx +92 -0
- package/src/jobs/JobsHomeWidget.tsx +53 -0
- package/src/jobs/JobsJobDetail.test.tsx +253 -0
- package/src/jobs/JobsJobDetail.tsx +278 -0
- package/src/jobs/JobsStatusBadge.tsx +16 -0
- package/src/jobs/jobPayload.ts +114 -0
- package/src/jobs/jobsDashboardParams.test.ts +80 -0
- package/src/jobs/jobsDashboardParams.ts +84 -0
- package/src/jobs/useJobsDashboardApi.test.tsx +152 -0
- package/src/jobs/useJobsDashboardApi.tsx +132 -0
- package/src/jobs/useJobsDashboardUrlFilters.test.tsx +31 -0
- package/src/jobs/useJobsDashboardUrlFilters.tsx +31 -0
- package/src/orgs/OrgDirectoryScreen.test.tsx +184 -0
- package/src/orgs/OrgDirectoryScreen.tsx +200 -0
- package/src/orgs/OrgManagementScreens.test.tsx +270 -0
- package/src/orgs/OrgMembersScreen.tsx +254 -0
- package/src/orgs/OrgSettingsScreen.tsx +145 -0
- package/src/orgs/OrgSwitcher.test.tsx +145 -0
- package/src/orgs/OrgSwitcher.tsx +101 -0
- package/src/orgs/adminModelEndpoints.test.ts +156 -0
- package/src/orgs/adminModelEndpoints.ts +96 -0
- package/src/orgs/normalizeListData.test.ts +17 -0
- package/src/orgs/normalizeListData.ts +13 -0
- package/src/orgs/orgSwitcherOscillation.test.tsx +107 -0
- package/src/orgs/organizationSettings.test.ts +11 -0
- package/src/orgs/organizationSettings.ts +22 -0
- package/src/orgs/shouldSkipOrgScopedAdminQuery.test.ts +22 -0
- package/src/orgs/shouldSkipOrgScopedAdminQuery.ts +7 -0
- package/src/orgs/sortOrganizations.test.ts +13 -0
- package/src/orgs/sortOrganizations.ts +14 -0
- package/src/orgs/useOrgContext.test.tsx +94 -0
- package/src/orgs/useOrgContext.tsx +90 -0
- package/src/orgs/useOrganizationsApi.test.tsx +165 -0
- package/src/orgs/useOrganizationsApi.ts +118 -0
- package/src/pdfUtils.test.ts +37 -0
- package/src/pdfUtils.ts +2 -2
- package/src/testing/useAdminApiDouble.ts +70 -0
- package/src/types.ts +94 -4
- package/src/useAdminApi.test.ts +88 -0
- package/src/useAdminApi.ts +7 -65
- package/src/useAdminBackgroundTask.ts +26 -8
- package/src/useAdminConfig.ts +20 -2
- package/src/useAdminMigrations.test.tsx +75 -0
- package/src/useAdminMigrations.ts +77 -0
- package/src/useAdminRoles.test.ts +28 -0
- package/src/useAdminRoles.ts +40 -0
- package/src/useAdminRpc.test.tsx +250 -0
- package/src/useAdminRpc.ts +173 -0
- package/src/useAdminScripts.ts +67 -0
- package/src/useConfigurationApi.ts +37 -16
- package/src/useConsentHistory.ts +15 -2
- package/src/useDocumentStorageApi.ts +77 -0
- package/src/widgets/AIRequestsScreenWidget.test.tsx +154 -0
- package/src/widgets/AIRequestsScreenWidget.tsx +26 -11
- package/src/widgets/DocumentsScreenWidget.tsx +9 -2
- package/src/widgets/ModelsGridWidget.test.tsx +91 -0
- package/src/widgets/ModelsGridWidget.tsx +11 -1
- package/src/widgets/RecentActivityWidget.tsx +10 -3
- package/src/widgets/builtInFieldWidgets.test.tsx +166 -0
- package/src/widgets/builtInWidgets.ts +8 -0
- package/src/widgets/homeWidgetUtils.ts +0 -9
- package/src/widgets/pluginWidgets.test.tsx +12 -1
- package/src/AdminFilterDrawer.test.tsx +0 -89
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
import type {AdminGetAuthHeaders} from "./types";
|
|
2
|
+
|
|
3
|
+
/** Default AbortController timeout for {@link adminRequest}. */
|
|
4
|
+
export const DEFAULT_ADMIN_REQUEST_TIMEOUT_MS = 30_000;
|
|
5
|
+
|
|
6
|
+
export interface AdminRequestArgs {
|
|
7
|
+
url: string;
|
|
8
|
+
method?: string;
|
|
9
|
+
body?: BodyInit | Record<string, unknown> | null;
|
|
10
|
+
signal?: AbortSignal;
|
|
11
|
+
credentials?: RequestCredentials;
|
|
12
|
+
headers?: HeadersInit;
|
|
13
|
+
timeoutMs?: number;
|
|
14
|
+
parseAs?: "json" | "text" | "blob";
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Thrown for non-2xx responses and timeouts. Shape matches `@terreno/ui` `APIError`
|
|
19
|
+
* (`status` + `data.title`) so existing admin screens can display it.
|
|
20
|
+
*/
|
|
21
|
+
export class AdminAPIError extends Error {
|
|
22
|
+
data: {detail?: string; title: string};
|
|
23
|
+
status: number;
|
|
24
|
+
|
|
25
|
+
constructor({
|
|
26
|
+
detail,
|
|
27
|
+
status,
|
|
28
|
+
title,
|
|
29
|
+
}: {
|
|
30
|
+
detail?: string;
|
|
31
|
+
status: number;
|
|
32
|
+
title: string;
|
|
33
|
+
}) {
|
|
34
|
+
super(title);
|
|
35
|
+
this.name = "AdminAPIError";
|
|
36
|
+
this.data = {detail, title};
|
|
37
|
+
this.status = status;
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
const isFormData = (value: unknown): value is FormData => {
|
|
42
|
+
return typeof FormData !== "undefined" && value instanceof FormData;
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
const isJsonBody = (value: unknown): value is Record<string, unknown> => {
|
|
46
|
+
if (value == null || typeof value !== "object") {
|
|
47
|
+
return false;
|
|
48
|
+
}
|
|
49
|
+
if (isFormData(value)) {
|
|
50
|
+
return false;
|
|
51
|
+
}
|
|
52
|
+
if (typeof Blob !== "undefined" && value instanceof Blob) {
|
|
53
|
+
return false;
|
|
54
|
+
}
|
|
55
|
+
if (typeof ArrayBuffer !== "undefined" && value instanceof ArrayBuffer) {
|
|
56
|
+
return false;
|
|
57
|
+
}
|
|
58
|
+
return true;
|
|
59
|
+
};
|
|
60
|
+
|
|
61
|
+
const readErrorPayload = async (response: Response): Promise<{detail?: string; title: string}> => {
|
|
62
|
+
const contentType = response.headers.get("Content-Type") ?? "";
|
|
63
|
+
if (contentType.includes("application/json")) {
|
|
64
|
+
try {
|
|
65
|
+
const parsed = (await response.json()) as {detail?: string; title?: string};
|
|
66
|
+
if (typeof parsed.title === "string" && parsed.title.length > 0) {
|
|
67
|
+
return {detail: parsed.detail, title: parsed.title};
|
|
68
|
+
}
|
|
69
|
+
} catch {
|
|
70
|
+
// Fall through to status text.
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
const fallback = response.statusText.trim();
|
|
74
|
+
return {title: fallback.length > 0 ? fallback : `Request failed (${response.status})`};
|
|
75
|
+
};
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* Native `fetch` helper for admin RPC (config, scripts, roles, …). Not axios and not
|
|
79
|
+
* RTK `injectEndpoints`. Hosts inject auth via {@link bindAdminRequest} /
|
|
80
|
+
* `AdminProvider` `{getAuthHeaders, credentials}`.
|
|
81
|
+
*/
|
|
82
|
+
export const adminRequest = async <T = unknown>({
|
|
83
|
+
body,
|
|
84
|
+
credentials,
|
|
85
|
+
headers,
|
|
86
|
+
method = "GET",
|
|
87
|
+
parseAs,
|
|
88
|
+
signal,
|
|
89
|
+
timeoutMs = DEFAULT_ADMIN_REQUEST_TIMEOUT_MS,
|
|
90
|
+
url,
|
|
91
|
+
}: AdminRequestArgs): Promise<T> => {
|
|
92
|
+
const controller = new AbortController();
|
|
93
|
+
const onAbort = (): void => {
|
|
94
|
+
controller.abort();
|
|
95
|
+
};
|
|
96
|
+
if (signal) {
|
|
97
|
+
if (signal.aborted) {
|
|
98
|
+
controller.abort();
|
|
99
|
+
} else {
|
|
100
|
+
signal.addEventListener("abort", onAbort, {once: true});
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
const timeoutId = setTimeout(() => {
|
|
104
|
+
controller.abort();
|
|
105
|
+
}, timeoutMs);
|
|
106
|
+
|
|
107
|
+
const requestHeaders = new Headers(headers);
|
|
108
|
+
let requestBody: BodyInit | undefined;
|
|
109
|
+
if (isFormData(body)) {
|
|
110
|
+
requestBody = body;
|
|
111
|
+
} else if (isJsonBody(body)) {
|
|
112
|
+
requestBody = JSON.stringify(body);
|
|
113
|
+
if (!requestHeaders.has("Content-Type")) {
|
|
114
|
+
requestHeaders.set("Content-Type", "application/json");
|
|
115
|
+
}
|
|
116
|
+
} else if (body != null) {
|
|
117
|
+
requestBody = body as BodyInit;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
try {
|
|
121
|
+
const response = await globalThis.fetch(url, {
|
|
122
|
+
body: requestBody,
|
|
123
|
+
credentials,
|
|
124
|
+
headers: requestHeaders,
|
|
125
|
+
method,
|
|
126
|
+
signal: controller.signal,
|
|
127
|
+
});
|
|
128
|
+
if (!response.ok) {
|
|
129
|
+
const payload = await readErrorPayload(response);
|
|
130
|
+
throw new AdminAPIError({...payload, status: response.status});
|
|
131
|
+
}
|
|
132
|
+
if (response.status === 204) {
|
|
133
|
+
return undefined as T;
|
|
134
|
+
}
|
|
135
|
+
if (parseAs === "blob") {
|
|
136
|
+
return (await response.blob()) as T;
|
|
137
|
+
}
|
|
138
|
+
if (parseAs === "text") {
|
|
139
|
+
return (await response.text()) as T;
|
|
140
|
+
}
|
|
141
|
+
const contentType = response.headers.get("Content-Type") ?? "";
|
|
142
|
+
if (contentType.includes("application/json")) {
|
|
143
|
+
return (await response.json()) as T;
|
|
144
|
+
}
|
|
145
|
+
return (await response.text()) as T;
|
|
146
|
+
} catch (error) {
|
|
147
|
+
if (error instanceof AdminAPIError) {
|
|
148
|
+
throw error;
|
|
149
|
+
}
|
|
150
|
+
const name = error instanceof Error ? error.name : "";
|
|
151
|
+
if (name === "AbortError" || controller.signal.aborted) {
|
|
152
|
+
throw new AdminAPIError({status: 0, title: "Request timed out"});
|
|
153
|
+
}
|
|
154
|
+
throw error;
|
|
155
|
+
} finally {
|
|
156
|
+
clearTimeout(timeoutId);
|
|
157
|
+
signal?.removeEventListener("abort", onAbort);
|
|
158
|
+
}
|
|
159
|
+
};
|
|
160
|
+
|
|
161
|
+
export interface BindAdminRequestOptions {
|
|
162
|
+
credentials?: RequestCredentials;
|
|
163
|
+
getAuthHeaders?: AdminGetAuthHeaders;
|
|
164
|
+
/**
|
|
165
|
+
* API origin for embedded hosts (e.g. `http://localhost:4000`). Absolute `url`
|
|
166
|
+
* values are left unchanged. Relative paths such as `/admin/config` and
|
|
167
|
+
* `/rbac/roles` are prefixed so they do not hit the Expo web origin.
|
|
168
|
+
*/
|
|
169
|
+
origin?: string;
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* Prefix a relative admin RPC URL with the host API origin. Same-origin SPA
|
|
174
|
+
* hosts omit `origin` and keep path-only URLs.
|
|
175
|
+
*/
|
|
176
|
+
const resolveAdminFetchUrl = ({origin, url}: {origin?: string; url: string}): string => {
|
|
177
|
+
if (!origin) {
|
|
178
|
+
return url;
|
|
179
|
+
}
|
|
180
|
+
if (/^[a-z][a-z0-9+.-]*:/i.test(url) || url.startsWith("//")) {
|
|
181
|
+
return url;
|
|
182
|
+
}
|
|
183
|
+
const trimmedOrigin = origin.replace(/\/$/, "");
|
|
184
|
+
const path = url.startsWith("/") ? url : `/${url}`;
|
|
185
|
+
return `${trimmedOrigin}${path}`;
|
|
186
|
+
};
|
|
187
|
+
|
|
188
|
+
/**
|
|
189
|
+
* Bind host auth onto {@link adminRequest}.
|
|
190
|
+
* SPA: `credentials: "same-origin"` and no Bearer headers.
|
|
191
|
+
* Embedded: `getAuthHeaders` returns `Authorization: Bearer …` plus `origin`.
|
|
192
|
+
*/
|
|
193
|
+
export const bindAdminRequest = ({
|
|
194
|
+
credentials,
|
|
195
|
+
getAuthHeaders,
|
|
196
|
+
origin,
|
|
197
|
+
}: BindAdminRequestOptions): ((args: AdminRequestArgs) => Promise<unknown>) => {
|
|
198
|
+
return async (args: AdminRequestArgs): Promise<unknown> => {
|
|
199
|
+
const headers = new Headers(args.headers);
|
|
200
|
+
if (getAuthHeaders) {
|
|
201
|
+
const extra = await getAuthHeaders();
|
|
202
|
+
new Headers(extra).forEach((value, key) => {
|
|
203
|
+
headers.set(key, value);
|
|
204
|
+
});
|
|
205
|
+
}
|
|
206
|
+
return adminRequest({
|
|
207
|
+
...args,
|
|
208
|
+
credentials: args.credentials ?? credentials,
|
|
209
|
+
headers,
|
|
210
|
+
url: resolveAdminFetchUrl({origin, url: args.url}),
|
|
211
|
+
});
|
|
212
|
+
};
|
|
213
|
+
};
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import {describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
|
|
4
|
+
import {asJsonBody, withQueryString} from "./adminRpc";
|
|
5
|
+
|
|
6
|
+
describe("withQueryString", () => {
|
|
7
|
+
it("omits empty params and stringifies the rest", () => {
|
|
8
|
+
assert.strictEqual(withQueryString({url: "/comms/messages"}), "/comms/messages");
|
|
9
|
+
assert.strictEqual(
|
|
10
|
+
withQueryString({params: {limit: 20, page: 1, q: ""}, url: "/comms/messages"}),
|
|
11
|
+
"/comms/messages?limit=20&page=1"
|
|
12
|
+
);
|
|
13
|
+
});
|
|
14
|
+
|
|
15
|
+
it("asJsonBody preserves JSON objects for adminRequest", () => {
|
|
16
|
+
assert.deepEqual(asJsonBody({kind: "bulk-patch"}), {kind: "bulk-patch"});
|
|
17
|
+
});
|
|
18
|
+
});
|
package/src/adminRpc.ts
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type {AdminRequestArgs} from "./adminRequest";
|
|
2
|
+
|
|
3
|
+
export type AdminRpc = (args: AdminRequestArgs) => Promise<unknown>;
|
|
4
|
+
|
|
5
|
+
export const withQueryString = ({
|
|
6
|
+
params,
|
|
7
|
+
url,
|
|
8
|
+
}: {
|
|
9
|
+
params?: Record<string, unknown>;
|
|
10
|
+
url: string;
|
|
11
|
+
}): string => {
|
|
12
|
+
if (!params) {
|
|
13
|
+
return url;
|
|
14
|
+
}
|
|
15
|
+
const search = new URLSearchParams();
|
|
16
|
+
for (const [key, value] of Object.entries(params)) {
|
|
17
|
+
if (value === undefined || value === null || value === "") {
|
|
18
|
+
continue;
|
|
19
|
+
}
|
|
20
|
+
search.set(key, String(value));
|
|
21
|
+
}
|
|
22
|
+
const query = search.toString();
|
|
23
|
+
if (!query) {
|
|
24
|
+
return url;
|
|
25
|
+
}
|
|
26
|
+
return `${url}?${query}`;
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
export const asJsonBody = (value: object): Record<string, unknown> => {
|
|
30
|
+
return value as Record<string, unknown>;
|
|
31
|
+
};
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import {describe, expect, it} from "bun:test";
|
|
2
|
+
import type {BackgroundTask} from "./types";
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* Shared bun-test double for `useAdminScripts`. `mock.module` is process-wide,
|
|
6
|
+
* so AdminScriptList and AdminMigrationsView tests must read the same task query
|
|
7
|
+
* state instead of installing competing module mocks.
|
|
8
|
+
*/
|
|
9
|
+
export const adminScriptsHarness: {
|
|
10
|
+
omitGetScriptTaskQuery: boolean;
|
|
11
|
+
taskQuery: {data: {task?: BackgroundTask} | undefined; error: unknown};
|
|
12
|
+
} = {
|
|
13
|
+
omitGetScriptTaskQuery: false,
|
|
14
|
+
taskQuery: {data: undefined, error: null},
|
|
15
|
+
};
|
|
16
|
+
|
|
17
|
+
describe("adminScriptsHarness", () => {
|
|
18
|
+
it("starts with an empty task query", (): void => {
|
|
19
|
+
expect(adminScriptsHarness.taskQuery.data).toBeUndefined();
|
|
20
|
+
});
|
|
21
|
+
});
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
-
import {describe,
|
|
1
|
+
import {describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
2
3
|
|
|
3
|
-
import {groupAdminModelsByGroup} from "./adminShellNav";
|
|
4
|
+
import {buildAdminSidebarGroups, groupAdminModelsByGroup} from "./adminShellNav";
|
|
4
5
|
import type {AdminModelConfig} from "./types";
|
|
5
6
|
|
|
6
7
|
const stubModel = (name: string, displayName: string, group?: string): AdminModelConfig =>
|
|
@@ -21,9 +22,74 @@ describe("groupAdminModelsByGroup", () => {
|
|
|
21
22
|
stubModel("B", "B"),
|
|
22
23
|
stubModel("C", "C", "Alpha"),
|
|
23
24
|
]);
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
25
|
+
assert.deepEqual(
|
|
26
|
+
groups.map((g) => g.group),
|
|
27
|
+
["Alpha", "Zebra", "General"]
|
|
28
|
+
);
|
|
29
|
+
assert.deepEqual(
|
|
30
|
+
groups[0]?.models.map((m) => m.name),
|
|
31
|
+
["C"]
|
|
32
|
+
);
|
|
33
|
+
assert.deepEqual(
|
|
34
|
+
groups[1]?.models.map((m) => m.name),
|
|
35
|
+
["A"]
|
|
36
|
+
);
|
|
37
|
+
assert.deepEqual(
|
|
38
|
+
groups[2]?.models.map((m) => m.name),
|
|
39
|
+
["B"]
|
|
40
|
+
);
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
it("returns no groups when models is missing", () => {
|
|
44
|
+
assert.deepEqual(groupAdminModelsByGroup(undefined as unknown as AdminModelConfig[]), []);
|
|
45
|
+
});
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
describe("buildAdminSidebarGroups", () => {
|
|
49
|
+
it("places grouped custom screens in matching model groups before models", () => {
|
|
50
|
+
const {groups, ungroupedScreens} = buildAdminSidebarGroups({
|
|
51
|
+
customScreens: [
|
|
52
|
+
{displayName: "Overview", group: "Announcements", name: "announcements"},
|
|
53
|
+
{displayName: "Reports", name: "reports"},
|
|
54
|
+
],
|
|
55
|
+
models: [
|
|
56
|
+
stubModel("Announcement", "All announcements", "Announcements"),
|
|
57
|
+
stubModel("User", "Users", "Accounts"),
|
|
58
|
+
],
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
assert.deepEqual(
|
|
62
|
+
ungroupedScreens.map((screen) => screen.name),
|
|
63
|
+
["reports"]
|
|
64
|
+
);
|
|
65
|
+
assert.deepEqual(
|
|
66
|
+
groups.map((entry) => entry.group),
|
|
67
|
+
["Accounts", "Announcements"]
|
|
68
|
+
);
|
|
69
|
+
const announcements = groups.find((entry) => entry.group === "Announcements");
|
|
70
|
+
assert.deepEqual(
|
|
71
|
+
announcements?.customScreens.map((screen) => screen.name),
|
|
72
|
+
["announcements"]
|
|
73
|
+
);
|
|
74
|
+
assert.deepEqual(
|
|
75
|
+
announcements?.models.map((model) => model.name),
|
|
76
|
+
["Announcement"]
|
|
77
|
+
);
|
|
78
|
+
});
|
|
79
|
+
|
|
80
|
+
it("creates a sidebar group for grouped screens without matching models", () => {
|
|
81
|
+
const {groups, ungroupedScreens} = buildAdminSidebarGroups({
|
|
82
|
+
customScreens: [{displayName: "Insights", group: "Analytics", name: "insights"}],
|
|
83
|
+
models: [],
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
assert.deepEqual(ungroupedScreens, []);
|
|
87
|
+
assert.deepEqual(groups, [
|
|
88
|
+
{
|
|
89
|
+
customScreens: [{displayName: "Insights", group: "Analytics", name: "insights"}],
|
|
90
|
+
group: "Analytics",
|
|
91
|
+
models: [],
|
|
92
|
+
},
|
|
93
|
+
]);
|
|
28
94
|
});
|
|
29
95
|
});
|
package/src/adminShellNav.ts
CHANGED
|
@@ -1,15 +1,36 @@
|
|
|
1
|
-
import type {AdminModelConfig} from "./types";
|
|
1
|
+
import type {AdminCustomScreen, AdminModelConfig} from "./types";
|
|
2
2
|
|
|
3
3
|
export interface AdminModelGroup {
|
|
4
4
|
group: string;
|
|
5
5
|
models: AdminModelConfig[];
|
|
6
6
|
}
|
|
7
7
|
|
|
8
|
+
export interface AdminSidebarGroup {
|
|
9
|
+
customScreens: AdminCustomScreen[];
|
|
10
|
+
group: string;
|
|
11
|
+
models: AdminModelConfig[];
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
const sortSidebarGroupKeys = (keys: string[]): string[] => {
|
|
15
|
+
return [...keys].sort((a, b) => {
|
|
16
|
+
if (a === "General") {
|
|
17
|
+
return 1;
|
|
18
|
+
}
|
|
19
|
+
if (b === "General") {
|
|
20
|
+
return -1;
|
|
21
|
+
}
|
|
22
|
+
return a.localeCompare(b);
|
|
23
|
+
});
|
|
24
|
+
};
|
|
25
|
+
|
|
8
26
|
/**
|
|
9
27
|
* Groups admin models by {@link AdminModelConfig.group} for sidebar navigation.
|
|
10
28
|
* Models without a group go under "General", which is sorted last.
|
|
11
29
|
*/
|
|
12
30
|
export const groupAdminModelsByGroup = (models: AdminModelConfig[]): AdminModelGroup[] => {
|
|
31
|
+
if (!Array.isArray(models)) {
|
|
32
|
+
return [];
|
|
33
|
+
}
|
|
13
34
|
const map = new Map<string, AdminModelConfig[]>();
|
|
14
35
|
for (const model of models) {
|
|
15
36
|
const group = model.group?.trim() || "General";
|
|
@@ -20,14 +41,38 @@ export const groupAdminModelsByGroup = (models: AdminModelConfig[]): AdminModelG
|
|
|
20
41
|
map.set(group, [model]);
|
|
21
42
|
}
|
|
22
43
|
}
|
|
23
|
-
const keys = [...map.keys()]
|
|
24
|
-
if (a === "General") {
|
|
25
|
-
return 1;
|
|
26
|
-
}
|
|
27
|
-
if (b === "General") {
|
|
28
|
-
return -1;
|
|
29
|
-
}
|
|
30
|
-
return a.localeCompare(b);
|
|
31
|
-
});
|
|
44
|
+
const keys = sortSidebarGroupKeys([...map.keys()]);
|
|
32
45
|
return keys.map((group) => ({group, models: map.get(group) ?? []}));
|
|
33
46
|
};
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Merges grouped custom screens into model sidebar groups (screens first), leaving
|
|
50
|
+
* ungrouped screens for the separate Screens section.
|
|
51
|
+
*/
|
|
52
|
+
export const buildAdminSidebarGroups = ({
|
|
53
|
+
customScreens,
|
|
54
|
+
models,
|
|
55
|
+
}: {
|
|
56
|
+
customScreens: AdminCustomScreen[];
|
|
57
|
+
models: AdminModelConfig[];
|
|
58
|
+
}): {groups: AdminSidebarGroup[]; ungroupedScreens: AdminCustomScreen[]} => {
|
|
59
|
+
const modelGroups = groupAdminModelsByGroup(models);
|
|
60
|
+
const groupedScreens = customScreens.filter((screen) => Boolean(screen.group?.trim()));
|
|
61
|
+
const ungroupedScreens = customScreens.filter((screen) => !screen.group?.trim());
|
|
62
|
+
|
|
63
|
+
const groupNames = new Set<string>();
|
|
64
|
+
for (const {group} of modelGroups) {
|
|
65
|
+
groupNames.add(group);
|
|
66
|
+
}
|
|
67
|
+
for (const screen of groupedScreens) {
|
|
68
|
+
groupNames.add(screen.group?.trim() ?? "General");
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
const groups = sortSidebarGroupKeys([...groupNames]).map((group) => ({
|
|
72
|
+
customScreens: groupedScreens.filter((screen) => (screen.group?.trim() || "General") === group),
|
|
73
|
+
group,
|
|
74
|
+
models: modelGroups.find((entry) => entry.group === group)?.models ?? [],
|
|
75
|
+
}));
|
|
76
|
+
|
|
77
|
+
return {groups, ungroupedScreens};
|
|
78
|
+
};
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import {beforeEach, describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
import {
|
|
4
|
+
clearAdminWindowMembershipStale,
|
|
5
|
+
getAdminWindowMembershipStale,
|
|
6
|
+
markAdminWindowMembershipStale,
|
|
7
|
+
resetAdminWindowRefreshForTests,
|
|
8
|
+
subscribeAdminWindowRefresh,
|
|
9
|
+
} from "./adminWindowRefresh";
|
|
10
|
+
|
|
11
|
+
describe("adminWindowRefresh", () => {
|
|
12
|
+
beforeEach(() => {
|
|
13
|
+
resetAdminWindowRefreshForTests();
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
it("flags and clears a collection, notifying subscribers once per change", () => {
|
|
17
|
+
let notifications = 0;
|
|
18
|
+
const unsubscribe = subscribeAdminWindowRefresh(() => {
|
|
19
|
+
notifications += 1;
|
|
20
|
+
});
|
|
21
|
+
|
|
22
|
+
assert.isUndefined(getAdminWindowMembershipStale("todos"));
|
|
23
|
+
markAdminWindowMembershipStale({collection: "todos"});
|
|
24
|
+
assert.deepEqual(getAdminWindowMembershipStale("todos"), {});
|
|
25
|
+
assert.equal(notifications, 1);
|
|
26
|
+
|
|
27
|
+
markAdminWindowMembershipStale({collection: "todos"});
|
|
28
|
+
assert.equal(notifications, 1);
|
|
29
|
+
|
|
30
|
+
clearAdminWindowMembershipStale({collection: "todos"});
|
|
31
|
+
assert.isUndefined(getAdminWindowMembershipStale("todos"));
|
|
32
|
+
assert.equal(notifications, 2);
|
|
33
|
+
|
|
34
|
+
clearAdminWindowMembershipStale({collection: "todos"});
|
|
35
|
+
assert.equal(notifications, 2);
|
|
36
|
+
|
|
37
|
+
unsubscribe();
|
|
38
|
+
markAdminWindowMembershipStale({collection: "todos"});
|
|
39
|
+
assert.equal(notifications, 2);
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
it("keeps a stable entry reference so it can back useSyncExternalStore", () => {
|
|
43
|
+
markAdminWindowMembershipStale({awaitId: "todo-9", collection: "todos"});
|
|
44
|
+
const first = getAdminWindowMembershipStale("todos");
|
|
45
|
+
assert.deepEqual(first, {awaitId: "todo-9"});
|
|
46
|
+
markAdminWindowMembershipStale({awaitId: "todo-9", collection: "todos"});
|
|
47
|
+
assert.strictEqual(getAdminWindowMembershipStale("todos"), first);
|
|
48
|
+
|
|
49
|
+
markAdminWindowMembershipStale({awaitId: "todo-10", collection: "todos"});
|
|
50
|
+
assert.deepEqual(getAdminWindowMembershipStale("todos"), {awaitId: "todo-10"});
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
it("ignores an empty collection and treats an undefined collection as fresh", () => {
|
|
54
|
+
markAdminWindowMembershipStale({collection: ""});
|
|
55
|
+
assert.isUndefined(getAdminWindowMembershipStale(""));
|
|
56
|
+
assert.isUndefined(getAdminWindowMembershipStale(undefined));
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it("keeps collections independent", () => {
|
|
60
|
+
markAdminWindowMembershipStale({collection: "todos"});
|
|
61
|
+
assert.isUndefined(getAdminWindowMembershipStale("users"));
|
|
62
|
+
clearAdminWindowMembershipStale({collection: "users"});
|
|
63
|
+
assert.deepEqual(getAdminWindowMembershipStale("todos"), {});
|
|
64
|
+
});
|
|
65
|
+
});
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Windowed admin writes go through the syncdb outbox instead of the REST list endpoint, so the
|
|
3
|
+
* cached membership page never learns that a row was created or removed. Forms flag the
|
|
4
|
+
* collection here and the changelist refetches membership, whether it stayed mounted behind the
|
|
5
|
+
* form or remounts when the form pops.
|
|
6
|
+
*
|
|
7
|
+
* A create also has to outrun the outbox: `mutate` only enqueues, so the first refetch can land
|
|
8
|
+
* before the server has the row. `awaitId` tells the changelist which id to wait for, and it
|
|
9
|
+
* retries a bounded number of times before falling back to the manual Refresh control.
|
|
10
|
+
*/
|
|
11
|
+
export interface AdminWindowMembershipStale {
|
|
12
|
+
/** Id a create is waiting on; absent for deletes, where any refetch is authoritative. */
|
|
13
|
+
awaitId?: string;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
const staleByCollection = new Map<string, AdminWindowMembershipStale>();
|
|
17
|
+
const listeners = new Set<() => void>();
|
|
18
|
+
|
|
19
|
+
const notify = (): void => {
|
|
20
|
+
for (const listener of listeners) {
|
|
21
|
+
listener();
|
|
22
|
+
}
|
|
23
|
+
};
|
|
24
|
+
|
|
25
|
+
export const subscribeAdminWindowRefresh = (listener: () => void): (() => void) => {
|
|
26
|
+
listeners.add(listener);
|
|
27
|
+
return (): void => {
|
|
28
|
+
listeners.delete(listener);
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Returns a stable entry reference while the flag is unchanged, so it can back
|
|
34
|
+
* `useSyncExternalStore` without re-rendering on every notification.
|
|
35
|
+
*/
|
|
36
|
+
export const getAdminWindowMembershipStale = (
|
|
37
|
+
collection: string | undefined
|
|
38
|
+
): AdminWindowMembershipStale | undefined => {
|
|
39
|
+
if (!collection) {
|
|
40
|
+
return undefined;
|
|
41
|
+
}
|
|
42
|
+
return staleByCollection.get(collection);
|
|
43
|
+
};
|
|
44
|
+
|
|
45
|
+
/** Signal that a windowed write changed which rows belong to `collection`. */
|
|
46
|
+
export const markAdminWindowMembershipStale = ({
|
|
47
|
+
collection,
|
|
48
|
+
awaitId,
|
|
49
|
+
}: {
|
|
50
|
+
collection: string;
|
|
51
|
+
awaitId?: string;
|
|
52
|
+
}): void => {
|
|
53
|
+
if (collection.length === 0) {
|
|
54
|
+
return;
|
|
55
|
+
}
|
|
56
|
+
const existing = staleByCollection.get(collection);
|
|
57
|
+
if (existing && existing.awaitId === awaitId) {
|
|
58
|
+
return;
|
|
59
|
+
}
|
|
60
|
+
staleByCollection.set(collection, awaitId ? {awaitId} : {});
|
|
61
|
+
notify();
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
/** Called by the changelist once it has taken ownership of the refetch for `collection`. */
|
|
65
|
+
export const clearAdminWindowMembershipStale = ({collection}: {collection: string}): void => {
|
|
66
|
+
if (!staleByCollection.delete(collection)) {
|
|
67
|
+
return;
|
|
68
|
+
}
|
|
69
|
+
notify();
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
/** @internal Test helper — clears every stale flag. */
|
|
73
|
+
export const resetAdminWindowRefreshForTests = (): void => {
|
|
74
|
+
staleByCollection.clear();
|
|
75
|
+
notify();
|
|
76
|
+
};
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import {describe, it} from "bun:test";
|
|
2
|
+
import {assert} from "chai";
|
|
3
|
+
|
|
4
|
+
import {isWindowedAdminTable, resolveWindowedTableRows} from "./adminWindowedTable";
|
|
5
|
+
import type {AdminModelConfig, AdminSyncDb} from "./types";
|
|
6
|
+
|
|
7
|
+
const stringIdConfig = {
|
|
8
|
+
adminBroadcast: true,
|
|
9
|
+
fields: {_id: {required: true, type: "string"}, title: {required: true, type: "string"}},
|
|
10
|
+
syncCollection: "todos",
|
|
11
|
+
} as AdminModelConfig;
|
|
12
|
+
|
|
13
|
+
const fakeSyncDb = {
|
|
14
|
+
hydrateWindow: async () => ({hydratedIds: []}),
|
|
15
|
+
store: {getEntity: () => undefined},
|
|
16
|
+
} as AdminSyncDb;
|
|
17
|
+
|
|
18
|
+
describe("isWindowedAdminTable", () => {
|
|
19
|
+
it("requires syncDb, fetch client, adminBroadcast, syncCollection, and string _id", () => {
|
|
20
|
+
assert.isTrue(
|
|
21
|
+
isWindowedAdminTable({
|
|
22
|
+
hasFetchClient: true,
|
|
23
|
+
modelConfig: stringIdConfig,
|
|
24
|
+
syncDb: fakeSyncDb,
|
|
25
|
+
})
|
|
26
|
+
);
|
|
27
|
+
assert.isFalse(
|
|
28
|
+
isWindowedAdminTable({
|
|
29
|
+
hasFetchClient: true,
|
|
30
|
+
modelConfig: stringIdConfig,
|
|
31
|
+
})
|
|
32
|
+
);
|
|
33
|
+
assert.isFalse(
|
|
34
|
+
isWindowedAdminTable({
|
|
35
|
+
hasFetchClient: false,
|
|
36
|
+
modelConfig: stringIdConfig,
|
|
37
|
+
syncDb: fakeSyncDb,
|
|
38
|
+
})
|
|
39
|
+
);
|
|
40
|
+
assert.isFalse(
|
|
41
|
+
isWindowedAdminTable({
|
|
42
|
+
hasFetchClient: true,
|
|
43
|
+
modelConfig: {...stringIdConfig, adminBroadcast: false},
|
|
44
|
+
syncDb: fakeSyncDb,
|
|
45
|
+
})
|
|
46
|
+
);
|
|
47
|
+
assert.isFalse(
|
|
48
|
+
isWindowedAdminTable({
|
|
49
|
+
hasFetchClient: true,
|
|
50
|
+
modelConfig: {...stringIdConfig, syncCollection: undefined},
|
|
51
|
+
syncDb: fakeSyncDb,
|
|
52
|
+
})
|
|
53
|
+
);
|
|
54
|
+
assert.isFalse(
|
|
55
|
+
isWindowedAdminTable({
|
|
56
|
+
hasFetchClient: true,
|
|
57
|
+
modelConfig: {
|
|
58
|
+
...stringIdConfig,
|
|
59
|
+
fields: {_id: {required: true, type: "objectid"}},
|
|
60
|
+
},
|
|
61
|
+
syncDb: fakeSyncDb,
|
|
62
|
+
})
|
|
63
|
+
);
|
|
64
|
+
});
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
describe("resolveWindowedTableRows", () => {
|
|
68
|
+
it("keeps REST membership order and ignores store ids outside the page", () => {
|
|
69
|
+
const restById = new Map([
|
|
70
|
+
["a", {_id: "a", title: "Alpha"}],
|
|
71
|
+
["b", {_id: "b", title: "Beta"}],
|
|
72
|
+
]);
|
|
73
|
+
const store: Record<string, {data: unknown; deleted?: boolean; id: string}> = {
|
|
74
|
+
a: {data: {_id: "a", title: "Alpha store"}, id: "a"},
|
|
75
|
+
b: {data: {_id: "b", title: "Beta"}, deleted: true, id: "b"},
|
|
76
|
+
ghost: {data: {_id: "ghost", title: "Should not render"}, id: "ghost"},
|
|
77
|
+
};
|
|
78
|
+
const rows = resolveWindowedTableRows({
|
|
79
|
+
collection: "todos",
|
|
80
|
+
getEntity: ({id}) => store[id],
|
|
81
|
+
membershipIds: ["a", "b", "c"],
|
|
82
|
+
restById,
|
|
83
|
+
});
|
|
84
|
+
assert.deepEqual(
|
|
85
|
+
rows.map((row) => row.title),
|
|
86
|
+
["Alpha store"]
|
|
87
|
+
);
|
|
88
|
+
assert.isUndefined(rows.find((row) => row._id === "ghost"));
|
|
89
|
+
});
|
|
90
|
+
});
|