@checkstack/maintenance-common 0.3.2 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @checkstack/maintenance-common
 
+## 0.4.0
+
+### Minor Changes
+
+- 18fa8e3: Add notification suppression toggle for maintenance windows
+
+  **New Feature:** When creating or editing a maintenance window, you can now enable "Suppress health notifications" to prevent health status change notifications from being sent for affected systems while the maintenance is active (in_progress status). This is useful for planned downtime where health alerts are expected and would otherwise create noise.
+
+  **Changes:**
+
+  - Added `suppressNotifications` field to maintenance schema
+  - Added new service-to-service API `hasActiveMaintenanceWithSuppression`
+  - Healthcheck queue executor now checks for suppression before sending notifications
+  - MaintenanceEditor UI includes new toggle checkbox
+
+  **Bug Fix:** Fixed migration system to correctly set PostgreSQL search_path when running plugin migrations. Previously, migrations could fail with "relation does not exist" errors because the schema context wasn't properly set.
+
 ## 0.3.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/maintenance-common",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "type": "module",
   "exports": {
     ".": {

package/src/rpc-contract.ts

@@ -25,7 +25,7 @@ export const maintenanceContract = {
           status: MaintenanceStatusEnum.optional(),
           systemId: z.string().optional(),
         })
-        .optional()
+        .optional(),
     )
     .output(z.object({ maintenances: z.array(MaintenanceWithSystemsSchema) })),
 
@@ -60,9 +60,9 @@ export const maintenanceContract = {
       z.object({
         maintenances: z.record(
           z.string(),
-          z.array(MaintenanceWithSystemsSchema)
+          z.array(MaintenanceWithSystemsSchema),
         ),
-      })
+      }),
     ),
 
   /** Create a new maintenance */
@@ -109,6 +109,18 @@ export const maintenanceContract = {
   })
     .input(z.object({ id: z.string() }))
     .output(z.object({ success: z.boolean() })),
+
+  /** Check if a system has active maintenance with notification suppression enabled.
+   * Used by healthcheck to skip notifications during expected downtime.
+   * Service-to-service endpoint (not exposed to users).
+   */
+  hasActiveMaintenanceWithSuppression: proc({
+    operationType: "query",
+    userType: "service",
+    access: [],
+  })
+    .input(z.object({ systemId: z.string() }))
+    .output(z.object({ suppressed: z.boolean() })),
 };
 
 // Export contract type
@@ -118,5 +130,5 @@ export type MaintenanceContract = typeof maintenanceContract;
 // Use: const client = rpcApi.forPlugin(MaintenanceApi);
 export const MaintenanceApi = createClientDefinition(
   maintenanceContract,
-  pluginMetadata
+  pluginMetadata,
 );

package/src/schemas.ts

@@ -18,6 +18,7 @@ export const MaintenanceSchema = z.object({
   id: z.string(),
   title: z.string(),
   description: z.string().optional(),
+  suppressNotifications: z.boolean(),
   status: MaintenanceStatusEnum,
   startAt: z.date(),
   endAt: z.date(),
@@ -62,6 +63,7 @@ export const CreateMaintenanceInputSchema = z
   .object({
     title: z.string().min(1, "Title is required"),
     description: z.string().optional(),
+    suppressNotifications: z.boolean().optional().default(false),
     startAt: z.date(),
     endAt: z.date(),
     systemIds: z.array(z.string()).min(1, "At least one system is required"),
@@ -78,6 +80,7 @@ export const UpdateMaintenanceInputSchema = z.object({
   id: z.string(),
   title: z.string().min(1).optional(),
   description: z.string().nullable().optional(),
+  suppressNotifications: z.boolean().optional(),
   startAt: z.date().optional(),
   endAt: z.date().optional(),
   systemIds: z.array(z.string()).min(1).optional(),