@checkstack/healthcheck-common 0.4.0 → 0.4.2

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @checkstack/healthcheck-common
 
+## 0.4.2
+
+### Patch Changes
+
+- 8a87cd4: Updated access rules to use new `accessPair` interface
+
+  Migrated to the new `accessPair` interface with per-level options objects for cleaner access rule definitions.
+
+- Updated dependencies [8a87cd4]
+  - @checkstack/common@0.5.0
+  - @checkstack/signal-common@0.1.3
+
+## 0.4.1
+
+### Patch Changes
+
+- Updated dependencies [83557c7]
+  - @checkstack/common@0.4.0
+  - @checkstack/signal-common@0.1.2
+
 ## 0.4.0
 
 ### Minor Changes

package/package.json

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

package/src/access.ts

@@ -8,6 +8,9 @@ export const healthCheckAccess = {
    * Status-only access for viewing health check status.
    * Enabled by default for anonymous and authenticated users.
    * Uses system-level instance access for team-based filtering.
+   *
+   * Bulk endpoints should use the same access rule with instanceAccess
+   * override at the contract level.
    */
   status: access("healthcheck.status", "read", "View Health Check Status", {
     idParam: "systemId",
@@ -15,22 +18,12 @@ export const healthCheckAccess = {
     isPublic: true,
   }),
 
-  /**
-   * Bulk status access for viewing health check status for multiple systems.
-   * Uses recordKey for filtering the output record by accessible system IDs.
-   */
-  bulkStatus: access("healthcheck.status", "read", "View Health Check Status", {
-    recordKey: "statuses",
-    isDefault: true,
-    isPublic: true,
-  }),
-
   /**
    * Configuration access for viewing and managing health check configurations.
    */
   configuration: accessPair("healthcheck", {
-    read: "Read Health Check Configurations",
-    manage: "Full management of Health Check Configurations",
+    read: { description: "Read Health Check Configurations" },
+    manage: { description: "Full management of Health Check Configurations" },
   }),
 
   /**
@@ -40,7 +33,7 @@ export const healthCheckAccess = {
   details: access(
     "healthcheck.details",
     "read",
-    "View Detailed Health Check Run Data (Warning: This may expose sensitive data, depending on the health check strategy)"
+    "View Detailed Health Check Run Data (Warning: This may expose sensitive data, depending on the health check strategy)",
   ),
 };
 

package/src/rpc-contract.ts

@@ -67,7 +67,7 @@ export const healthCheckContract = {
     userType: "authenticated",
     access: [healthCheckAccess.configuration.read],
   }).output(
-    z.object({ configurations: z.array(HealthCheckConfigurationSchema) })
+    z.object({ configurations: z.array(HealthCheckConfigurationSchema) }),
   ),
 
   createConfiguration: proc({
@@ -87,7 +87,7 @@ export const healthCheckContract = {
       z.object({
         id: z.string(),
         body: UpdateHealthCheckConfigurationSchema,
-      })
+      }),
     )
     .output(HealthCheckConfigurationSchema),
 
@@ -124,8 +124,8 @@ export const healthCheckContract = {
           configurationName: z.string(),
           enabled: z.boolean(),
           stateThresholds: StateThresholdsSchema.optional(),
-        })
-      )
+        }),
+      ),
     ),
 
   associateSystem: proc({
@@ -137,7 +137,7 @@ export const healthCheckContract = {
       z.object({
         systemId: z.string(),
         body: AssociateHealthCheckSchema,
-      })
+      }),
     )
     .output(z.void()),
 
@@ -150,7 +150,7 @@ export const healthCheckContract = {
       z.object({
         systemId: z.string(),
         configId: z.string(),
-      })
+      }),
     )
     .output(z.void()),
 
@@ -167,12 +167,12 @@ export const healthCheckContract = {
       z.object({
         systemId: z.string(),
         configurationId: z.string(),
-      })
+      }),
     )
     .output(
       z.object({
         retentionConfig: RetentionConfigSchema.nullable(),
-      })
+      }),
     ),
 
   updateRetentionConfig: proc({
@@ -185,7 +185,7 @@ export const healthCheckContract = {
         systemId: z.string(),
         configurationId: z.string(),
         retentionConfig: RetentionConfigSchema.nullable(),
-      })
+      }),
     )
     .output(z.void()),
 
@@ -206,13 +206,13 @@ export const healthCheckContract = {
         endDate: z.date().optional(),
         limit: z.number().optional().default(10),
         offset: z.number().optional().default(0),
-      })
+      }),
     )
     .output(
       z.object({
         runs: z.array(HealthCheckRunPublicSchema),
         total: z.number(),
-      })
+      }),
     ),
 
   getDetailedHistory: proc({
@@ -228,13 +228,13 @@ export const healthCheckContract = {
         endDate: z.date().optional(),
         limit: z.number().optional().default(10),
         offset: z.number().optional().default(0),
-      })
+      }),
     )
     .output(
       z.object({
         runs: z.array(HealthCheckRunSchema),
         total: z.number(),
-      })
+      }),
     ),
 
   getAggregatedHistory: proc({
@@ -249,12 +249,12 @@ export const healthCheckContract = {
         startDate: z.date(),
         endDate: z.date(),
         bucketSize: z.enum(["hourly", "daily", "auto"]),
-      })
+      }),
     )
     .output(
       z.object({
         buckets: z.array(AggregatedBucketBaseSchema),
-      })
+      }),
     ),
 
   getDetailedAggregatedHistory: proc({
@@ -269,12 +269,12 @@ export const healthCheckContract = {
         startDate: z.date(),
         endDate: z.date(),
         bucketSize: z.enum(["hourly", "daily", "auto"]),
-      })
+      }),
     )
     .output(
       z.object({
         buckets: z.array(AggregatedBucketSchema),
-      })
+      }),
     ),
 
   getSystemHealthStatus: proc({
@@ -288,13 +288,14 @@ export const healthCheckContract = {
   getBulkSystemHealthStatus: proc({
     operationType: "query",
     userType: "public",
-    access: [healthCheckAccess.bulkStatus],
+    access: [healthCheckAccess.status],
+    instanceAccess: { recordKey: "statuses" },
   })
     .input(z.object({ systemIds: z.array(z.string()) }))
     .output(
       z.object({
         statuses: z.record(z.string(), SystemHealthStatusResponseSchema),
-      })
+      }),
     ),
 
   getSystemHealthOverview: proc({
@@ -320,11 +321,11 @@ export const healthCheckContract = {
                 id: z.string(),
                 status: HealthCheckStatusSchema,
                 timestamp: z.date(),
-              })
+              }),
             ),
-          })
+          }),
         ),
-      })
+      }),
     ),
 };
 
@@ -335,5 +336,5 @@ export type HealthCheckContract = typeof healthCheckContract;
 // Use: const client = rpcApi.forPlugin(HealthCheckApi);
 export const HealthCheckApi = createClientDefinition(
   healthCheckContract,
-  pluginMetadata
+  pluginMetadata,
 );