@openlup/platform 0.28.0 → 0.30.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.
Files changed (241) hide show
  1. package/CHANGELOG.md +369 -156
  2. package/README.md +220 -4
  3. package/dist/composition/index.d.ts +1 -0
  4. package/dist/composition/index.js +1 -0
  5. package/dist/composition/marketingContribution.d.ts +21 -0
  6. package/dist/composition/marketingContribution.js +29 -0
  7. package/dist/composition/nodeHost.d.ts +1 -1
  8. package/dist/composition/nodeHost.js +3 -2
  9. package/dist/lifecycle/appUpgrade.d.ts +52 -0
  10. package/dist/lifecycle/appUpgrade.js +180 -0
  11. package/dist/lifecycle/index.d.ts +2 -0
  12. package/dist/lifecycle/index.js +2 -0
  13. package/dist/lifecycle/postgresInstallQualification.d.ts +51 -0
  14. package/dist/lifecycle/postgresInstallQualification.js +74 -0
  15. package/dist/marketing/acquisitionCaseSchemas.d.ts +103 -0
  16. package/dist/marketing/acquisitionCaseSchemas.js +53 -0
  17. package/dist/marketing/acquisitionEvidenceSchemas.d.ts +105 -0
  18. package/dist/marketing/acquisitionEvidenceSchemas.js +55 -0
  19. package/dist/marketing/analytics/dataLayer.d.ts +18 -0
  20. package/dist/marketing/analytics/dataLayer.js +111 -0
  21. package/dist/marketing/analytics/noop.d.ts +9 -0
  22. package/dist/marketing/analytics/noop.js +8 -0
  23. package/dist/marketing/analytics/purchaseFacts.d.ts +4 -0
  24. package/dist/marketing/analytics/purchaseFacts.js +69 -0
  25. package/dist/marketing/analytics/routePolicy.d.ts +10 -0
  26. package/dist/marketing/analytics/routePolicy.js +59 -0
  27. package/dist/marketing/consentEvidence.d.ts +8 -0
  28. package/dist/marketing/consentEvidence.js +32 -0
  29. package/dist/marketing/contactLegal.d.ts +14 -0
  30. package/dist/marketing/contactLegal.js +19 -0
  31. package/dist/marketing/contracts/acquisition.d.ts +88 -0
  32. package/dist/marketing/contracts/acquisition.js +1 -0
  33. package/dist/marketing/contracts/acquisitionPorts.d.ts +49 -0
  34. package/dist/marketing/contracts/acquisitionPorts.js +1 -0
  35. package/dist/marketing/contracts/analytics.d.ts +144 -0
  36. package/dist/marketing/contracts/analytics.js +1 -0
  37. package/dist/marketing/contracts/contactLegal.d.ts +53 -0
  38. package/dist/marketing/contracts/contactLegal.js +1 -0
  39. package/dist/marketing/contracts/index.d.ts +6 -0
  40. package/dist/marketing/contracts/index.js +1 -0
  41. package/dist/marketing/contracts/prelaunch.d.ts +39 -0
  42. package/dist/marketing/contracts/prelaunch.js +1 -0
  43. package/dist/marketing/index.d.ts +16 -0
  44. package/dist/marketing/index.js +14 -0
  45. package/dist/marketing/prelaunchAcquisitionSchemas.d.ts +116 -0
  46. package/dist/marketing/prelaunchAcquisitionSchemas.js +51 -0
  47. package/dist/marketing/seo/jsonLd.d.ts +157 -0
  48. package/dist/marketing/seo/jsonLd.js +127 -0
  49. package/dist/marketing/seo/metadata.d.ts +41 -0
  50. package/dist/marketing/seo/metadata.js +36 -0
  51. package/dist/marketing/seo/serializeJsonLd.d.ts +1 -0
  52. package/dist/marketing/seo/serializeJsonLd.js +6 -0
  53. package/dist/marketing/seo/urls.d.ts +14 -0
  54. package/dist/marketing/seo/urls.js +23 -0
  55. package/dist/marketing/server/acquisitionCaseDirect.d.ts +4 -0
  56. package/dist/marketing/server/acquisitionCaseDirect.js +88 -0
  57. package/dist/marketing/server/acquisitionCaseHandlers.d.ts +28 -0
  58. package/dist/marketing/server/acquisitionCaseHandlers.js +40 -0
  59. package/dist/marketing/server/acquisitionCasePorts.d.ts +42 -0
  60. package/dist/marketing/server/acquisitionCasePorts.js +1 -0
  61. package/dist/marketing/server/acquisitionEvidenceDirect.d.ts +5 -0
  62. package/dist/marketing/server/acquisitionEvidenceDirect.js +100 -0
  63. package/dist/marketing/server/analyticsContext.d.ts +3 -0
  64. package/dist/marketing/server/analyticsContext.js +65 -0
  65. package/dist/marketing/server/analyticsContextPorts.d.ts +31 -0
  66. package/dist/marketing/server/analyticsContextPorts.js +1 -0
  67. package/dist/marketing/server/bindings.d.ts +14 -0
  68. package/dist/marketing/server/bindings.js +18 -0
  69. package/dist/marketing/server/directPorts.d.ts +26 -0
  70. package/dist/marketing/server/directPorts.js +1 -0
  71. package/dist/marketing/server/index.d.ts +14 -0
  72. package/dist/marketing/server/index.js +11 -0
  73. package/dist/marketing/server/postgres/acquisitionCaseRoutines.d.ts +10 -0
  74. package/dist/marketing/server/postgres/acquisitionCaseRoutines.js +204 -0
  75. package/dist/marketing/server/postgres/acquisitionEvidenceRoutines.d.ts +10 -0
  76. package/dist/marketing/server/postgres/acquisitionEvidenceRoutines.js +107 -0
  77. package/dist/marketing/server/postgres/index.d.ts +3 -0
  78. package/dist/marketing/server/postgres/index.js +3 -0
  79. package/dist/marketing/server/prelaunchAcquisitionDirect.d.ts +4 -0
  80. package/dist/marketing/server/prelaunchAcquisitionDirect.js +122 -0
  81. package/dist/marketing/server/privacyContributor.d.ts +66 -0
  82. package/dist/marketing/server/privacyContributor.js +87 -0
  83. package/dist/marketing/server/research/adminSurveyResponsesHandler.d.ts +9 -0
  84. package/dist/marketing/server/research/adminSurveyResponsesHandler.js +53 -0
  85. package/dist/marketing/server/research/managedSurveyResponseSubmit.d.ts +39 -0
  86. package/dist/marketing/server/research/managedSurveyResponseSubmit.js +102 -0
  87. package/dist/marketing/server/research/surveyResponseSubmitHandler.d.ts +8 -0
  88. package/dist/marketing/server/research/surveyResponseSubmitHandler.js +41 -0
  89. package/dist/marketing/validation.d.ts +2 -0
  90. package/dist/marketing/validation.js +3 -0
  91. package/dist/migrations/postgresRunner.d.ts +9 -0
  92. package/dist/migrations/postgresRunner.js +17 -10
  93. package/dist/operations/adminAlertsSchemas.d.ts +153 -0
  94. package/dist/operations/adminAlertsSchemas.js +69 -0
  95. package/dist/operations/adminAlertsView.d.ts +73 -0
  96. package/dist/operations/adminAlertsView.js +184 -0
  97. package/dist/operations/alertPagingPolicy.d.ts +15 -0
  98. package/dist/operations/alertPagingPolicy.js +43 -0
  99. package/dist/operations/alertThrottlePolicy.d.ts +3 -0
  100. package/dist/operations/alertThrottlePolicy.js +18 -0
  101. package/dist/operations/clients.d.ts +17 -0
  102. package/dist/operations/clients.js +32 -0
  103. package/dist/operations/contracts/admin.d.ts +93 -0
  104. package/dist/operations/contracts/admin.js +1 -0
  105. package/dist/operations/contracts/adminAlertsContracts.d.ts +40 -0
  106. package/dist/operations/contracts/adminAlertsContracts.js +1 -0
  107. package/dist/operations/contracts/alertHumanContext.d.ts +7 -0
  108. package/dist/operations/contracts/alertHumanContext.js +1 -0
  109. package/dist/operations/contracts/index.d.ts +6 -0
  110. package/dist/operations/contracts/index.js +6 -0
  111. package/dist/operations/contracts/observabilityContracts.d.ts +41 -0
  112. package/dist/operations/contracts/observabilityContracts.js +1 -0
  113. package/dist/operations/contracts/observabilityPorts.d.ts +18 -0
  114. package/dist/operations/contracts/observabilityPorts.js +1 -0
  115. package/dist/operations/contracts/ports.d.ts +19 -0
  116. package/dist/operations/contracts/ports.js +1 -0
  117. package/dist/operations/errors.d.ts +6 -0
  118. package/dist/operations/errors.js +6 -0
  119. package/dist/operations/index.d.ts +9 -0
  120. package/dist/operations/index.js +9 -0
  121. package/dist/operations/schemas.d.ts +138 -0
  122. package/dist/operations/schemas.js +104 -0
  123. package/dist/operations/server/adminAlertsHandlers.d.ts +16 -0
  124. package/dist/operations/server/adminAlertsHandlers.js +35 -0
  125. package/dist/operations/server/adminPipelineHandlers.d.ts +12 -0
  126. package/dist/operations/server/adminPipelineHandlers.js +48 -0
  127. package/dist/operations/server/adminSettingsHandlers.d.ts +14 -0
  128. package/dist/operations/server/adminSettingsHandlers.js +82 -0
  129. package/dist/operations/server/controlPlaneHandler.d.ts +7 -0
  130. package/dist/operations/server/controlPlaneHandler.js +54 -0
  131. package/dist/operations/server/controlPlaneStore.d.ts +12 -0
  132. package/dist/operations/server/controlPlaneStore.js +138 -0
  133. package/dist/operations/server/controlPlaneWatchdog.d.ts +7 -0
  134. package/dist/operations/server/controlPlaneWatchdog.js +20 -0
  135. package/dist/operations/server/index.d.ts +12 -0
  136. package/dist/operations/server/index.js +12 -0
  137. package/dist/operations/server/migrations.d.ts +14 -0
  138. package/dist/operations/server/migrations.js +7 -0
  139. package/dist/operations/server/platformWatchdogDecision.d.ts +34 -0
  140. package/dist/operations/server/platformWatchdogDecision.js +71 -0
  141. package/dist/operations/server/platformWatchdogDeliveryPolicy.d.ts +10 -0
  142. package/dist/operations/server/platformWatchdogDeliveryPolicy.js +53 -0
  143. package/dist/operations/server/platformWatchdogQueue.d.ts +11 -0
  144. package/dist/operations/server/platformWatchdogQueue.js +94 -0
  145. package/dist/operations/server/platformWatchdogService.d.ts +47 -0
  146. package/dist/operations/server/platformWatchdogService.js +105 -0
  147. package/dist/operations/validation.d.ts +2 -0
  148. package/dist/operations/validation.js +3 -0
  149. package/dist/portability/filesystemObjects.d.ts +12 -0
  150. package/dist/portability/filesystemObjects.js +191 -0
  151. package/dist/portability/index.d.ts +5 -0
  152. package/dist/portability/index.js +4 -0
  153. package/dist/portability/objects.d.ts +63 -0
  154. package/dist/portability/objects.js +138 -0
  155. package/dist/portability/postgresRows.d.ts +64 -0
  156. package/dist/portability/postgresRows.js +182 -0
  157. package/dist/scheduler/advisoryLock.js +20 -2
  158. package/dist/scheduler/nodeScheduler.d.ts +2 -2
  159. package/dist/scheduler/nodeScheduler.js +35 -6
  160. package/package.json +47 -2
  161. package/release-gates.json +143 -9
  162. package/sql/20260814010000_platform_control_plane.sql +286 -0
  163. package/src/composition/index.ts +1 -0
  164. package/src/composition/marketingContribution.ts +37 -0
  165. package/src/composition/nodeHost.ts +4 -3
  166. package/src/lifecycle/appUpgrade.ts +186 -0
  167. package/src/lifecycle/index.ts +19 -0
  168. package/src/lifecycle/postgresInstallQualification.ts +125 -0
  169. package/src/marketing/acquisitionCaseSchemas.ts +75 -0
  170. package/src/marketing/acquisitionEvidenceSchemas.ts +72 -0
  171. package/src/marketing/analytics/dataLayer.ts +100 -0
  172. package/src/marketing/analytics/noop.ts +14 -0
  173. package/src/marketing/analytics/purchaseFacts.ts +63 -0
  174. package/src/marketing/analytics/routePolicy.ts +55 -0
  175. package/src/marketing/consentEvidence.ts +36 -0
  176. package/src/marketing/contactLegal.ts +22 -0
  177. package/src/marketing/contracts/acquisition.ts +50 -0
  178. package/src/marketing/contracts/acquisitionPorts.ts +48 -0
  179. package/src/marketing/contracts/analytics.ts +88 -0
  180. package/src/marketing/contracts/contactLegal.ts +41 -0
  181. package/src/marketing/contracts/index.ts +17 -0
  182. package/src/marketing/contracts/prelaunch.ts +15 -0
  183. package/src/marketing/index.ts +16 -0
  184. package/src/marketing/prelaunchAcquisitionSchemas.ts +64 -0
  185. package/src/marketing/seo/jsonLd.ts +153 -0
  186. package/src/marketing/seo/metadata.ts +62 -0
  187. package/src/marketing/seo/serializeJsonLd.ts +6 -0
  188. package/src/marketing/seo/urls.ts +34 -0
  189. package/src/marketing/server/acquisitionCaseDirect.ts +67 -0
  190. package/src/marketing/server/acquisitionCaseHandlers.ts +57 -0
  191. package/src/marketing/server/acquisitionCasePorts.ts +42 -0
  192. package/src/marketing/server/acquisitionEvidenceDirect.ts +76 -0
  193. package/src/marketing/server/analyticsContext.ts +55 -0
  194. package/src/marketing/server/analyticsContextPorts.ts +28 -0
  195. package/src/marketing/server/bindings.ts +27 -0
  196. package/src/marketing/server/directPorts.ts +27 -0
  197. package/src/marketing/server/index.ts +14 -0
  198. package/src/marketing/server/postgres/acquisitionCaseRoutines.ts +218 -0
  199. package/src/marketing/server/postgres/acquisitionEvidenceRoutines.ts +103 -0
  200. package/src/marketing/server/postgres/index.ts +3 -0
  201. package/src/marketing/server/prelaunchAcquisitionDirect.ts +121 -0
  202. package/src/marketing/server/privacyContributor.ts +123 -0
  203. package/src/marketing/server/research/adminSurveyResponsesHandler.ts +78 -0
  204. package/src/marketing/server/research/managedSurveyResponseSubmit.ts +158 -0
  205. package/src/marketing/server/research/surveyResponseSubmitHandler.ts +57 -0
  206. package/src/marketing/validation.ts +3 -0
  207. package/src/migrations/postgresRunner.ts +24 -9
  208. package/src/operations/adminAlertsSchemas.ts +78 -0
  209. package/src/operations/adminAlertsView.ts +238 -0
  210. package/src/operations/alertPagingPolicy.ts +50 -0
  211. package/src/operations/alertThrottlePolicy.ts +22 -0
  212. package/src/operations/clients.ts +44 -0
  213. package/src/operations/contracts/admin.ts +24 -0
  214. package/src/operations/contracts/adminAlertsContracts.ts +13 -0
  215. package/src/operations/contracts/alertHumanContext.ts +17 -0
  216. package/src/operations/contracts/index.ts +6 -0
  217. package/src/operations/contracts/observabilityContracts.ts +40 -0
  218. package/src/operations/contracts/observabilityPorts.ts +30 -0
  219. package/src/operations/contracts/ports.ts +22 -0
  220. package/src/operations/errors.ts +6 -0
  221. package/src/operations/index.ts +9 -0
  222. package/src/operations/schemas.ts +122 -0
  223. package/src/operations/server/adminAlertsHandlers.ts +61 -0
  224. package/src/operations/server/adminPipelineHandlers.ts +73 -0
  225. package/src/operations/server/adminSettingsHandlers.ts +114 -0
  226. package/src/operations/server/controlPlaneHandler.ts +56 -0
  227. package/src/operations/server/controlPlaneStore.ts +150 -0
  228. package/src/operations/server/controlPlaneWatchdog.ts +28 -0
  229. package/src/operations/server/index.ts +12 -0
  230. package/src/operations/server/migrations.ts +7 -0
  231. package/src/operations/server/platformWatchdogDecision.ts +93 -0
  232. package/src/operations/server/platformWatchdogDeliveryPolicy.ts +92 -0
  233. package/src/operations/server/platformWatchdogQueue.ts +96 -0
  234. package/src/operations/server/platformWatchdogService.ts +209 -0
  235. package/src/operations/validation.ts +3 -0
  236. package/src/portability/filesystemObjects.ts +138 -0
  237. package/src/portability/index.ts +12 -0
  238. package/src/portability/objects.ts +160 -0
  239. package/src/portability/postgresRows.ts +169 -0
  240. package/src/scheduler/advisoryLock.ts +20 -5
  241. package/src/scheduler/nodeScheduler.ts +28 -8
@@ -0,0 +1,22 @@
1
+ import type { AlertSeverity } from "./contracts/observabilityContracts.js";
2
+
3
+ /**
4
+ * Per-severity re-notification cadence for platform watchdog alerts.
5
+ *
6
+ * A firing alert re-pages at most once per this window (keyed off
7
+ * `last_notified_at`). Lower severities re-page less often so a persistent
8
+ * low-severity alert cannot flood the channel, while p0 stays loud.
9
+ */
10
+ const THROTTLE_SECONDS_BY_SEVERITY: Record<AlertSeverity, number> = {
11
+ p0: 1 * 60 * 60, // 1h
12
+ p1: 4 * 60 * 60, // 4h
13
+ p2: 12 * 60 * 60, // 12h
14
+ p3: 24 * 60 * 60, // 24h
15
+ };
16
+
17
+ /** Fallback window for an unknown/unparseable severity. */
18
+ export const DEFAULT_THROTTLE_SECONDS = 60 * 60;
19
+
20
+ export function throttleSecondsForSeverity(severity: string): number {
21
+ return THROTTLE_SECONDS_BY_SEVERITY[severity as AlertSeverity] ?? DEFAULT_THROTTLE_SECONDS;
22
+ }
@@ -0,0 +1,44 @@
1
+ import type { z } from "zod";
2
+ import { adminSettingsReadResponseSchema, adminSettingsUpdateResponseSchema, adminPipelineReadResponseSchema } from "./schemas.js";
3
+ import { adminAlertsOverviewResponseSchema } from "./adminAlertsSchemas.js";
4
+ import type { AdminSettingsReadResponse, AdminSettingsUpdateRequest, AdminSettingsUpdateResponse, AdminPipelineReadResponse } from "./contracts/admin.js";
5
+ import type { AdminAlertsOverviewResponse } from "./contracts/adminAlertsContracts.js";
6
+
7
+ /** The existing BFF requester owns fetch, envelope validation, cancellation and diagnostics. */
8
+ export interface OperationsRequestOptions extends Omit<RequestInit, "body"> {
9
+ body?: unknown;
10
+ fetcher?: typeof fetch;
11
+ timeoutMs?: number;
12
+ }
13
+ export type OperationsRequestBff = <T>(path: string, schema: z.ZodType<T>, options?: OperationsRequestOptions) => Promise<T>;
14
+
15
+ /** Bind the existing browser calls without installing an ambient fetch implementation. */
16
+ export function createOperationsClients(requestBff: OperationsRequestBff) {
17
+ return {
18
+ getAdminSettings(accessToken: string, options: OperationsRequestOptions = {}): Promise<AdminSettingsReadResponse> {
19
+ return requestBff("/api/bff/admin/platform/settings", adminSettingsReadResponseSchema, {
20
+ ...options, method: "GET", headers: authHeaders(accessToken, options),
21
+ });
22
+ },
23
+ updateAdminSetting(accessToken: string, request: AdminSettingsUpdateRequest, options: OperationsRequestOptions = {}): Promise<AdminSettingsUpdateResponse> {
24
+ return requestBff("/api/bff/admin/platform/settings/update", adminSettingsUpdateResponseSchema, {
25
+ ...options, method: "POST", headers: authHeaders(accessToken, options), body: request,
26
+ });
27
+ },
28
+ getAdminPipeline(accessToken: string, options: OperationsRequestOptions = {}): Promise<AdminPipelineReadResponse> {
29
+ return requestBff("/api/bff/admin/platform/pipeline", adminPipelineReadResponseSchema, {
30
+ ...options, method: "GET", headers: authHeaders(accessToken, options),
31
+ });
32
+ },
33
+ getAdminAlertsOverview(accessToken: string, options: OperationsRequestOptions = {}): Promise<AdminAlertsOverviewResponse> {
34
+ return requestBff("/api/bff/admin/platform/alerts", adminAlertsOverviewResponseSchema, {
35
+ ...options, method: "GET", headers: authHeaders(accessToken, options),
36
+ });
37
+ },
38
+ };
39
+ }
40
+ function authHeaders(accessToken: string, options: OperationsRequestOptions): Headers {
41
+ const headers = new Headers(options.headers);
42
+ headers.set("Authorization", `Bearer ${accessToken}`);
43
+ return headers;
44
+ }
@@ -0,0 +1,24 @@
1
+ /** DTOs for the existing operational settings, pipeline and control-plane surfaces. */
2
+ export type AdminPipelineTester = { id: string; status: string; email_sequence_step: number | null; email_sequence_paused: boolean | null };
3
+ export type AdminPipelineEmailTemplate = { id: string; name: string; sequence_order: number | null };
4
+ export type AdminPipelineEmailEvent = { event_type: string };
5
+ export type AdminPipelineReadRequest = Record<string, never>;
6
+ export type AdminPipelineReadResponse = { testers: AdminPipelineTester[]; templates: AdminPipelineEmailTemplate[]; emailSendCount: number; emailEvents: AdminPipelineEmailEvent[] };
7
+ export type AdminPipelineDhlTrackingRefreshRequest = Record<string, never>;
8
+ export type AdminPipelineDhlTrackingRefreshResponse = { checked: number; updated: number };
9
+ export type AdminSettingsAdminUser = { id: string; email: string | null; role: string | null };
10
+ export type AdminSettingsReadRequest = Record<string, never>;
11
+ export type AdminSettingsReadResponse = { settings: Record<string, unknown>; adminUsers: AdminSettingsAdminUser[] };
12
+ export type AdminSettingWriteValue = string | number | boolean | null;
13
+ export type AdminSettingsUpdateRequest = { key: string; value: AdminSettingWriteValue };
14
+ export type AdminSettingsUpdateResponse = { key: string; saved: true };
15
+ export type PlatformControlPlaneReadRequest = Record<string, never>;
16
+ export type PlatformControlPlaneReadResponse = {
17
+ controls: { controlKey: string; enabled: boolean; revision: number; updatedAt: string }[];
18
+ jobs: { jobName: string; enabled: boolean; activeDriver: "worker" | "scheduler" | "operator"; lastStatus: "running" | "success" | "failed" | "skipped" | null; lastStartedAt: string | null; lastFinishedAt: string | null; lastSuccessAt: string | null }[];
19
+ alerts: { dedupeKey: string; severity: "p0" | "p1" | "p2" | "p3"; status: "open" | "acknowledged" | "resolved"; owner: string; title: string; firstSeenAt: string; lastSeenAt: string; resolvedAt: string | null }[];
20
+ };
21
+ export type PlatformControlPlaneMutation =
22
+ | { action: "set-control"; idempotencyKey: string; controlKey: string; enabled: boolean }
23
+ | { action: "record-heartbeat"; idempotencyKey: string; health: "healthy" | "degraded" | "failed"; firingCount: number; maxSeverity: "p0" | "p1" | "p2" | "p3" | null; promotionReady: boolean };
24
+ export type PlatformControlPlaneMutationResponse = { action: "set-control" | "record-heartbeat"; replayed: boolean; revision: number | null; recordedAt: string };
@@ -0,0 +1,13 @@
1
+ /** Operator projection; persistence and read authority remain host-owned. */
2
+ export type AdminAlertSeverity = "p0" | "p1" | "p2" | "p3";
3
+ export type AdminAlertLane = "commerce" | "platform";
4
+ export type AdminAlertHealth = "ok" | "degraded" | "down" | "unknown";
5
+ export type AdminAlert = {
6
+ id: string; dedupeKey: string; lane: AdminAlertLane; owner: string;
7
+ severity: AdminAlertSeverity; status: "open" | "acknowledged"; pageable: boolean;
8
+ title: string; message: string; supportCode: string | null; runbookUrl: string | null;
9
+ firstSeenAt: string; lastSeenAt: string; snoozedUntil: string | null;
10
+ };
11
+ export type AdminAlertsHeartbeat = { lastSuccessAt: string | null; staleAfterSeconds: number; stale: boolean };
12
+ export type AdminAlertsSummary = { commercePageableCount: number; commerceTotalCount: number; platformPageableCount: number; snoozedCount: number; maxOpenSeverity: AdminAlertSeverity | null };
13
+ export type AdminAlertsOverviewResponse = { health: AdminAlertHealth; summary: AdminAlertsSummary; heartbeat: AdminAlertsHeartbeat; alerts: AdminAlert[]; snoozedAlerts: AdminAlert[]; generatedAt: string };
@@ -0,0 +1,17 @@
1
+ export type AlertIncidentClass =
2
+ | "customer_communication_failure"
3
+ | "scheduled_job_failed"
4
+ | "scheduled_job_missed"
5
+ | "fulfillment_tracking_stalled"
6
+ | "configuration_drift"
7
+ | "data_integrity"
8
+ | "queue_backlog"
9
+ | "recipient_configuration_failure"
10
+ | "platform_watchdog";
11
+
12
+ export type AlertHumanContext = {
13
+ incidentClass: AlertIncidentClass;
14
+ impact: string;
15
+ firstAction: string;
16
+ urgency: string;
17
+ };
@@ -0,0 +1,6 @@
1
+ export * from "./admin.js";
2
+ export * from "./adminAlertsContracts.js";
3
+ export * from "./ports.js";
4
+ export * from "./observabilityContracts.js";
5
+ export * from "./observabilityPorts.js";
6
+ export * from "./alertHumanContext.js";
@@ -0,0 +1,40 @@
1
+ export type AlertSeverity = "p0" | "p1" | "p2" | "p3";
2
+ /** Opaque host-owned transport key; this module declares no vendor capability. */
3
+ export type AlertChannel = string;
4
+ export type WatchdogSnapshot = { checkedAt: string };
5
+
6
+ export type AlertDecision<Channel extends string = AlertChannel> = {
7
+ dedupeKey: string;
8
+ severity: AlertSeverity;
9
+ owner: string;
10
+ runbookUrl: string;
11
+ title: string;
12
+ message: string; humanContext?: import("./alertHumanContext.js").AlertHumanContext;
13
+ channels: Channel[];
14
+ payload: Record<string, unknown>; paging?: "default" | "never";
15
+ };
16
+
17
+ export type OpenAlert = {
18
+ id: string;
19
+ dedupeKey: string;
20
+ status: "open" | "acknowledged";
21
+ severity: AlertSeverity;
22
+ lastNotifiedAt: string | null;
23
+ /** Most recent watchdog delivery decision, including skipped/failed attempts. */
24
+ lastNotificationAttemptAt?: string | null;
25
+ lastNotificationStatus?: AlertNotificationOutcome["status"] | null;
26
+ /** Earliest time the watchdog may create another delivery-attempt ledger row. */
27
+ nextNotificationAttemptAt?: string | null;
28
+ /** Consecutive failed webhook attempts; reset by sent/skipped outcomes. */
29
+ notificationFailureCount?: number;
30
+ /** Operator silence window; when set and in the future, paging is suppressed. */
31
+ snoozedUntil?: string | null;
32
+ };
33
+
34
+ export type AlertNotificationOutcome<Channel extends string = AlertChannel> = {
35
+ channel: Channel;
36
+ status: "sent" | "failed" | "skipped";
37
+ provider?: string | null;
38
+ providerResponse?: Record<string, unknown> | null;
39
+ error?: string | null;
40
+ };
@@ -0,0 +1,30 @@
1
+ import type {
2
+ AlertDecision,
3
+ AlertNotificationOutcome,
4
+ WatchdogSnapshot,
5
+ OpenAlert,
6
+ } from "./observabilityContracts.js";
7
+
8
+ export type ObservabilityEvidencePort<Snapshot extends WatchdogSnapshot = WatchdogSnapshot> = {
9
+ collectSnapshot(now: Date): Promise<Snapshot>;
10
+ };
11
+
12
+ export type AlertLedgerPort<Channel extends string = string> = {
13
+ listOpenAlerts(): Promise<OpenAlert[]>;
14
+ upsertOpenAlert: (decision: AlertDecision<Channel>, now: Date) => Promise<OpenAlert>;
15
+ resolveAlert(dedupeKey: string, now: Date): Promise<void>;
16
+ recordNotification: (
17
+ alertId: string,
18
+ /** The kernel retains its existing webhook-keyed skipped-attempt audit rows. */
19
+ outcome: AlertNotificationOutcome<Channel | "webhook">,
20
+ now: Date,
21
+ schedule: {
22
+ nextAttemptAt: Date;
23
+ failureCount: number;
24
+ },
25
+ ) => Promise<void>;
26
+ };
27
+
28
+ export type AlertSinkPort<Channel extends string = string> = {
29
+ send: (decision: AlertDecision<Channel>, alert: OpenAlert) => Promise<AlertNotificationOutcome<Channel>>;
30
+ };
@@ -0,0 +1,22 @@
1
+ import type {
2
+ AdminPipelineReadRequest, AdminPipelineReadResponse,
3
+ AdminSettingsReadRequest, AdminSettingsReadResponse,
4
+ AdminSettingsUpdateRequest, AdminSettingsUpdateResponse,
5
+ PlatformControlPlaneReadRequest, PlatformControlPlaneReadResponse,
6
+ PlatformControlPlaneMutation, PlatformControlPlaneMutationResponse,
7
+ } from "./admin.js";
8
+
9
+ export interface AdminPipelineReadPort {
10
+ readPipeline(request: AdminPipelineReadRequest): Promise<AdminPipelineReadResponse>;
11
+ }
12
+ export interface AdminSettingsOperationsPort {
13
+ readSettings(request: AdminSettingsReadRequest): Promise<AdminSettingsReadResponse>;
14
+ updateSetting(request: AdminSettingsUpdateRequest): Promise<AdminSettingsUpdateResponse>;
15
+ }
16
+ export interface PlatformControlPlanePort {
17
+ readControlPlane(request: PlatformControlPlaneReadRequest): Promise<PlatformControlPlaneReadResponse>;
18
+ mutateControlPlane(request: PlatformControlPlaneMutation): Promise<PlatformControlPlaneMutationResponse>;
19
+ }
20
+ export type OperationsAuthorizationResult =
21
+ | { ok: true }
22
+ | { ok: false; code: "UNAUTHORIZED" | "FORBIDDEN"; message: string };
@@ -0,0 +1,6 @@
1
+ export class PlatformControlPlaneConflictError extends Error {
2
+ override readonly name = "PlatformControlPlaneConflictError";
3
+ }
4
+ export class PlatformControlPlaneUnavailableError extends Error {
5
+ override readonly name = "PlatformControlPlaneUnavailableError";
6
+ }
@@ -0,0 +1,9 @@
1
+ /** Browser-safe operational contracts, validation and operator projections. */
2
+ export * from "./contracts/index.js";
3
+ export * from "./schemas.js";
4
+ export * from "./adminAlertsSchemas.js";
5
+ export * from "./adminAlertsView.js";
6
+ export * from "./alertPagingPolicy.js";
7
+ export * from "./alertThrottlePolicy.js";
8
+ export * from "./errors.js";
9
+ export * from "./clients.js";
@@ -0,0 +1,122 @@
1
+ import { z } from "./validation.js";
2
+
3
+ export const adminPipelineTesterSchema = z.object({
4
+ id: z.string().min(1),
5
+ status: z.string().min(1),
6
+ email_sequence_step: z.number().int().min(0).nullable(),
7
+ email_sequence_paused: z.boolean().nullable(),
8
+ });
9
+
10
+ export const adminPipelineEmailTemplateSchema = z.object({
11
+ id: z.string().min(1),
12
+ name: z.string().min(1),
13
+ sequence_order: z.number().int().min(0).nullable(),
14
+ });
15
+
16
+ export const adminPipelineEmailEventSchema = z.object({
17
+ event_type: z.string().min(1),
18
+ });
19
+
20
+ export const adminPipelineReadRequestSchema = z.object({}).strict();
21
+
22
+ export const adminPipelineReadResponseSchema = z.object({
23
+ testers: z.array(adminPipelineTesterSchema),
24
+ templates: z.array(adminPipelineEmailTemplateSchema),
25
+ emailSendCount: z.number().int().min(0),
26
+ emailEvents: z.array(adminPipelineEmailEventSchema),
27
+ });
28
+
29
+ export const adminPipelineDhlTrackingRefreshRequestSchema = z.object({}).strict();
30
+
31
+ export const adminPipelineDhlTrackingRefreshResponseSchema = z.object({
32
+ checked: z.number().int().min(0),
33
+ updated: z.number().int().min(0),
34
+ });
35
+
36
+ export const adminSettingsReadRequestSchema = z.object({}).strict();
37
+
38
+ export const adminSettingsAdminUserSchema = z.object({
39
+ id: z.string().min(1),
40
+ email: z.string().nullable(),
41
+ role: z.string().nullable(),
42
+ });
43
+
44
+ export const adminSettingsReadResponseSchema = z.object({
45
+ settings: z.record(z.string(), z.unknown()),
46
+ adminUsers: z.array(adminSettingsAdminUserSchema),
47
+ });
48
+
49
+ export const adminSettingWriteValueSchema = z.union([
50
+ z.string(),
51
+ z.number(),
52
+ z.boolean(),
53
+ z.null(),
54
+ ]);
55
+
56
+ export const adminSettingsUpdateRequestSchema = z.object({
57
+ key: z.string().trim().min(1),
58
+ value: adminSettingWriteValueSchema,
59
+ });
60
+
61
+ export const adminSettingsUpdateResponseSchema = z.object({
62
+ key: z.string().min(1),
63
+ saved: z.literal(true),
64
+ });
65
+
66
+ const platformControlKeySchema = z.string().trim().regex(/^[A-Za-z0-9][A-Za-z0-9._:-]{0,119}$/);
67
+ const platformOperationKeySchema = z.string().trim().regex(/^[A-Za-z0-9][A-Za-z0-9._:-]{0,255}$/);
68
+ const platformTimestampSchema = z.string().datetime({ offset: true });
69
+
70
+ export const platformControlPlaneReadRequestSchema = z.object({}).strict();
71
+
72
+ export const platformControlPlaneReadResponseSchema = z.object({
73
+ controls: z.array(z.object({
74
+ controlKey: platformControlKeySchema,
75
+ enabled: z.boolean(),
76
+ revision: z.number().int().min(1),
77
+ updatedAt: platformTimestampSchema,
78
+ })),
79
+ jobs: z.array(z.object({
80
+ jobName: z.string().min(1),
81
+ enabled: z.boolean(),
82
+ activeDriver: z.enum(["worker", "scheduler", "operator"]),
83
+ lastStatus: z.enum(["running", "success", "failed", "skipped"]).nullable(),
84
+ lastStartedAt: platformTimestampSchema.nullable(),
85
+ lastFinishedAt: platformTimestampSchema.nullable(),
86
+ lastSuccessAt: platformTimestampSchema.nullable(),
87
+ })),
88
+ alerts: z.array(z.object({
89
+ dedupeKey: z.string().min(1),
90
+ severity: z.enum(["p0", "p1", "p2", "p3"]),
91
+ status: z.enum(["open", "acknowledged", "resolved"]),
92
+ owner: z.string().min(1),
93
+ title: z.string().min(1),
94
+ firstSeenAt: platformTimestampSchema,
95
+ lastSeenAt: platformTimestampSchema,
96
+ resolvedAt: platformTimestampSchema.nullable(),
97
+ })),
98
+ });
99
+
100
+ export const platformControlPlaneMutationSchema = z.union([
101
+ z.object({
102
+ action: z.literal("set-control"),
103
+ idempotencyKey: platformOperationKeySchema,
104
+ controlKey: platformControlKeySchema,
105
+ enabled: z.boolean(),
106
+ }).strict(),
107
+ z.object({
108
+ action: z.literal("record-heartbeat"),
109
+ idempotencyKey: platformOperationKeySchema,
110
+ health: z.enum(["healthy", "degraded", "failed"]),
111
+ firingCount: z.number().int().min(0),
112
+ maxSeverity: z.enum(["p0", "p1", "p2", "p3"]).nullable(),
113
+ promotionReady: z.boolean(),
114
+ }).strict(),
115
+ ]);
116
+
117
+ export const platformControlPlaneMutationResponseSchema = z.object({
118
+ action: z.enum(["set-control", "record-heartbeat"]),
119
+ replayed: z.boolean(),
120
+ revision: z.number().int().min(1).nullable(),
121
+ recordedAt: platformTimestampSchema,
122
+ });
@@ -0,0 +1,61 @@
1
+ import { createBffResponder, type BffResponderOptions } from "../../bff/index.js";
2
+ import type { HttpRequest, HttpResponse } from "../../http/index.js";
3
+ import { adminAlertsOverviewResponseSchema } from "../index.js";
4
+ import { buildAlertsOverview } from "../index.js";
5
+ import type {
6
+ PlatformAlertLedgerRow,
7
+ WatchdogHeartbeatRow,
8
+ } from "../index.js";
9
+ import type { OperationsAuthorizationResult } from "../contracts/index.js";
10
+ type AuthorizeAdmin = () => Promise<OperationsAuthorizationResult>;
11
+
12
+ export interface AdminAlertsReadPort {
13
+ listLiveAlerts(): Promise<PlatformAlertLedgerRow[]>;
14
+ readWatchdogHeartbeat(): Promise<WatchdogHeartbeatRow>;
15
+ }
16
+
17
+ export interface AdminAlertsOverviewDeps extends BffResponderOptions {
18
+ readPort: AdminAlertsReadPort;
19
+ authorizeAdmin: AuthorizeAdmin;
20
+ now?: () => Date;
21
+ }
22
+
23
+ export function createAdminAlertsOverviewHandler({
24
+ readPort,
25
+ authorizeAdmin,
26
+ now = () => new Date(), responseRequestId,
27
+ }: AdminAlertsOverviewDeps) {
28
+ const { sendBffError, sendBffSuccess, sendMethodNotAllowed } = createBffResponder({ responseRequestId });
29
+ return async function handler(req: HttpRequest, res: HttpResponse): Promise<void> {
30
+ if (req.method !== "GET") {
31
+ sendMethodNotAllowed(res, ["GET"]);
32
+ return;
33
+ }
34
+
35
+ const authorization = await authorizeAdmin();
36
+ if (authorization.ok === false) {
37
+ sendBffError(res, authorization.code, authorization.message);
38
+ return;
39
+ }
40
+
41
+ try {
42
+ // Heartbeat and alerts are read together: an empty alert list is only
43
+ // "healthy" if the watchdog actually reported recently.
44
+ const [alerts, heartbeat] = await Promise.all([
45
+ readPort.listLiveAlerts(),
46
+ readPort.readWatchdogHeartbeat(),
47
+ ]);
48
+
49
+ const overview = buildAlertsOverview(alerts, heartbeat, now());
50
+ const response = adminAlertsOverviewResponseSchema.safeParse(overview);
51
+ if (!response.success) {
52
+ sendBffError(res, "INVALID_RESPONSE", "Admin alerts overview returned invalid response");
53
+ return;
54
+ }
55
+
56
+ sendBffSuccess(res, response.data);
57
+ } catch {
58
+ sendBffError(res, "UPSTREAM_UNAVAILABLE", "Admin alerts overview failed");
59
+ }
60
+ };
61
+ }
@@ -0,0 +1,73 @@
1
+ import { createBffResponder, type BffResponderOptions, type BffResponder } from "../../bff/index.js";
2
+ import type { HttpRequest, HttpResponse } from "../../http/index.js";
3
+ import {
4
+ adminPipelineReadRequestSchema,
5
+ adminPipelineReadResponseSchema,
6
+ } from "../index.js";
7
+ import type { AdminPipelineReadPort } from "../contracts/index.js";
8
+ import type { OperationsAuthorizationResult } from "../contracts/index.js";
9
+
10
+ interface AdminPipelineBaseDeps extends BffResponderOptions {
11
+ authorizeAdmin: (req: HttpRequest) => Promise<OperationsAuthorizationResult>;
12
+ }
13
+
14
+ export interface AdminPipelineReadDeps extends AdminPipelineBaseDeps {
15
+ pipelinePort: Pick<AdminPipelineReadPort, "readPipeline">;
16
+ }
17
+
18
+ export function createAdminPipelineReadHandler({
19
+ pipelinePort,
20
+ authorizeAdmin, responseRequestId,
21
+ }: AdminPipelineReadDeps) {
22
+ const responder = createBffResponder({ responseRequestId });
23
+ const { sendBffError, sendBffSuccess, sendMethodNotAllowed } = responder;
24
+ return async function handler(req: HttpRequest, res: HttpResponse): Promise<void> {
25
+ if (req.method !== "GET") {
26
+ sendMethodNotAllowed(res, ["GET"]);
27
+ return;
28
+ }
29
+
30
+ const authorization = await readAuthorization(req, res, authorizeAdmin, responder);
31
+ if (!authorization) return;
32
+
33
+ const request = adminPipelineReadRequestSchema.safeParse(req.query);
34
+ if (!request.success) {
35
+ sendBffError(res, "BAD_REQUEST", "Invalid admin pipeline read request", {
36
+ details: request.error.flatten(),
37
+ });
38
+ return;
39
+ }
40
+
41
+ try {
42
+ const result = await pipelinePort.readPipeline(request.data);
43
+ const response = adminPipelineReadResponseSchema.safeParse(result);
44
+ if (!response.success) {
45
+ sendBffError(res, "INVALID_RESPONSE", "Admin pipeline read returned invalid response");
46
+ return;
47
+ }
48
+
49
+ sendBffSuccess(res, response.data);
50
+ } catch {
51
+ sendBffError(res, "UPSTREAM_UNAVAILABLE", "Admin pipeline read failed");
52
+ }
53
+ };
54
+ }
55
+
56
+ async function readAuthorization(
57
+ req: HttpRequest,
58
+ res: HttpResponse,
59
+ authorizeAdmin: (req: HttpRequest) => Promise<OperationsAuthorizationResult>,
60
+ { sendBffError }: BffResponder,
61
+ ): Promise<true | null> {
62
+ try {
63
+ const authorization = await authorizeAdmin(req);
64
+ if (authorization.ok === false) {
65
+ sendBffError(res, authorization.code, authorization.message);
66
+ return null;
67
+ }
68
+ return true;
69
+ } catch {
70
+ sendBffError(res, "UPSTREAM_UNAVAILABLE", "Admin authorization failed");
71
+ return null;
72
+ }
73
+ }
@@ -0,0 +1,114 @@
1
+ import { createBffResponder, type BffResponderOptions } from "../../bff/index.js";
2
+ import type { HttpRequest, HttpResponse } from "../../http/index.js";
3
+ import {
4
+ adminSettingsReadRequestSchema,
5
+ adminSettingsReadResponseSchema,
6
+ adminSettingsUpdateRequestSchema,
7
+ adminSettingsUpdateResponseSchema,
8
+ } from "../index.js";
9
+ import type { AdminSettingsOperationsPort } from "../contracts/index.js";
10
+ import type { OperationsAuthorizationResult } from "../contracts/index.js";
11
+
12
+ export interface AdminSettingsReadDeps extends BffResponderOptions {
13
+ settingsPort: Pick<AdminSettingsOperationsPort, "readSettings">;
14
+ authorizeAdmin: (req: HttpRequest) => Promise<OperationsAuthorizationResult>;
15
+ }
16
+
17
+ export interface AdminSettingsUpdateDeps extends BffResponderOptions {
18
+ settingsPort: Pick<AdminSettingsOperationsPort, "updateSetting">;
19
+ authorizeAdmin: (req: HttpRequest) => Promise<OperationsAuthorizationResult>;
20
+ }
21
+
22
+ export function createAdminSettingsReadHandler({
23
+ settingsPort,
24
+ authorizeAdmin, responseRequestId,
25
+ }: AdminSettingsReadDeps) {
26
+ const { sendBffError, sendBffSuccess, sendMethodNotAllowed } = createBffResponder({ responseRequestId });
27
+ return async function handler(req: HttpRequest, res: HttpResponse): Promise<void> {
28
+ if (req.method !== "GET") {
29
+ sendMethodNotAllowed(res, ["GET"]);
30
+ return;
31
+ }
32
+
33
+ let authorization: OperationsAuthorizationResult;
34
+ try {
35
+ authorization = await authorizeAdmin(req);
36
+ } catch {
37
+ sendBffError(res, "UPSTREAM_UNAVAILABLE", "Admin authorization failed");
38
+ return;
39
+ }
40
+
41
+ if (authorization.ok === false) {
42
+ sendBffError(res, authorization.code, authorization.message);
43
+ return;
44
+ }
45
+
46
+ const request = adminSettingsReadRequestSchema.safeParse(req.query);
47
+ if (!request.success) {
48
+ sendBffError(res, "BAD_REQUEST", "Invalid admin settings read request", {
49
+ details: request.error.flatten(),
50
+ });
51
+ return;
52
+ }
53
+
54
+ try {
55
+ const result = await settingsPort.readSettings(request.data);
56
+ const response = adminSettingsReadResponseSchema.safeParse(result);
57
+ if (!response.success) {
58
+ sendBffError(res, "INVALID_RESPONSE", "Admin settings read returned invalid response");
59
+ return;
60
+ }
61
+
62
+ sendBffSuccess(res, response.data);
63
+ } catch {
64
+ sendBffError(res, "UPSTREAM_UNAVAILABLE", "Admin settings read failed");
65
+ }
66
+ };
67
+ }
68
+
69
+ export function createAdminSettingsUpdateHandler({
70
+ settingsPort,
71
+ authorizeAdmin, responseRequestId,
72
+ }: AdminSettingsUpdateDeps) {
73
+ const { sendBffError, sendBffSuccess, sendMethodNotAllowed } = createBffResponder({ responseRequestId });
74
+ return async function handler(req: HttpRequest, res: HttpResponse): Promise<void> {
75
+ if (req.method !== "POST") {
76
+ sendMethodNotAllowed(res, ["POST"]);
77
+ return;
78
+ }
79
+
80
+ let authorization: OperationsAuthorizationResult;
81
+ try {
82
+ authorization = await authorizeAdmin(req);
83
+ } catch {
84
+ sendBffError(res, "UPSTREAM_UNAVAILABLE", "Admin authorization failed");
85
+ return;
86
+ }
87
+
88
+ if (authorization.ok === false) {
89
+ sendBffError(res, authorization.code, authorization.message);
90
+ return;
91
+ }
92
+
93
+ const request = adminSettingsUpdateRequestSchema.safeParse(req.body);
94
+ if (!request.success) {
95
+ sendBffError(res, "BAD_REQUEST", "Invalid admin settings update request", {
96
+ details: request.error.flatten(),
97
+ });
98
+ return;
99
+ }
100
+
101
+ try {
102
+ const result = await settingsPort.updateSetting(request.data);
103
+ const response = adminSettingsUpdateResponseSchema.safeParse(result);
104
+ if (!response.success) {
105
+ sendBffError(res, "INVALID_RESPONSE", "Admin settings update returned invalid response");
106
+ return;
107
+ }
108
+
109
+ sendBffSuccess(res, response.data);
110
+ } catch {
111
+ sendBffError(res, "UPSTREAM_UNAVAILABLE", "Admin settings update failed");
112
+ }
113
+ };
114
+ }