@checkstack/maintenance-common 0.0.3 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,156 @@
 # @checkstack/maintenance-common
 
+## 0.2.0
+
+### Minor Changes
+
+- 9faec1f: # Unified AccessRule Terminology Refactoring
+
+  This release completes a comprehensive terminology refactoring from "permission" to "accessRule" across the entire codebase, establishing a consistent and modern access control vocabulary.
+
+  ## Changes
+
+  ### Core Infrastructure (`@checkstack/common`)
+
+  - Introduced `AccessRule` interface as the primary access control type
+  - Added `accessPair()` helper for creating read/manage access rule pairs
+  - Added `access()` builder for individual access rules
+  - Replaced `Permission` type with `AccessRule` throughout
+
+  ### API Changes
+
+  - `env.registerPermissions()` → `env.registerAccessRules()`
+  - `meta.permissions` → `meta.access` in RPC contracts
+  - `usePermission()` → `useAccess()` in frontend hooks
+  - Route `permission:` field → `accessRule:` field
+
+  ### UI Changes
+
+  - "Roles & Permissions" tab → "Roles & Access Rules"
+  - "You don't have permission..." → "You don't have access..."
+  - All permission-related UI text updated
+
+  ### Documentation & Templates
+
+  - Updated 18 documentation files with AccessRule terminology
+  - Updated 7 scaffolding templates with `accessPair()` pattern
+  - All code examples use new AccessRule API
+
+  ## Migration Guide
+
+  ### Backend Plugins
+
+  ```diff
+  - import { permissionList } from "./permissions";
+  - env.registerPermissions(permissionList);
+  + import { accessRules } from "./access";
+  + env.registerAccessRules(accessRules);
+  ```
+
+  ### RPC Contracts
+
+  ```diff
+  - .meta({ userType: "user", permissions: [permissions.read.id] })
+  + .meta({ userType: "user", access: [access.read] })
+  ```
+
+  ### Frontend Hooks
+
+  ```diff
+  - const canRead = accessApi.usePermission(permissions.read.id);
+  + const canRead = accessApi.useAccess(access.read);
+  ```
+
+  ### Routes
+
+  ```diff
+  - permission: permissions.entityRead.id,
+  + accessRule: access.read,
+  ```
+
+### Patch Changes
+
+- Updated dependencies [9faec1f]
+- Updated dependencies [f533141]
+  - @checkstack/common@0.2.0
+  - @checkstack/frontend-api@0.1.0
+  - @checkstack/signal-common@0.1.0
+
+## 0.1.0
+
+### Minor Changes
+
+- 8e43507: # Teams and Resource-Level Access Control
+
+  This release introduces a comprehensive Teams system for organizing users and controlling access to resources at a granular level.
+
+  ## Features
+
+  ### Team Management
+
+  - Create, update, and delete teams with name and description
+  - Add/remove users from teams
+  - Designate team managers with elevated privileges
+  - View team membership and manager status
+
+  ### Resource-Level Access Control
+
+  - Grant teams access to specific resources (systems, health checks, incidents, maintenances)
+  - Configure read-only or manage permissions per team
+  - Resource-level "Team Only" mode that restricts access exclusively to team members
+  - Separate `resourceAccessSettings` table for resource-level settings (not per-grant)
+  - Automatic cleanup of grants when teams are deleted (database cascade)
+
+  ### Middleware Integration
+
+  - Extended `autoAuthMiddleware` to support resource access checks
+  - Single-resource pre-handler validation for detail endpoints
+  - Automatic list filtering for collection endpoints
+  - S2S endpoints for access verification
+
+  ### Frontend Components
+
+  - `TeamsTab` component for managing teams in Auth Settings
+  - `TeamAccessEditor` component for assigning team access to resources
+  - Resource-level "Team Only" toggle in `TeamAccessEditor`
+  - Integration into System, Health Check, Incident, and Maintenance editors
+
+  ## Breaking Changes
+
+  ### API Response Format Changes
+
+  List endpoints now return objects with named keys instead of arrays directly:
+
+  ```typescript
+  // Before
+  const systems = await catalogApi.getSystems();
+
+  // After
+  const { systems } = await catalogApi.getSystems();
+  ```
+
+  Affected endpoints:
+
+  - `catalog.getSystems` → `{ systems: [...] }`
+  - `healthcheck.getConfigurations` → `{ configurations: [...] }`
+  - `incident.listIncidents` → `{ incidents: [...] }`
+  - `maintenance.listMaintenances` → `{ maintenances: [...] }`
+
+  ### User Identity Enrichment
+
+  `RealUser` and `ApplicationUser` types now include `teamIds: string[]` field with team memberships.
+
+  ## Documentation
+
+  See `docs/backend/teams.md` for complete API reference and integration guide.
+
+### Patch Changes
+
+- Updated dependencies [8e43507]
+  - @checkstack/common@0.1.0
+  - @checkstack/frontend-api@0.0.4
+  - @checkstack/signal-common@0.0.4
+
 ## 0.0.3
 
 ### Patch Changes

package/package.json

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

package/src/access.ts

@@ -0,0 +1,31 @@
+import { accessPair } from "@checkstack/common";
+
+/**
+ * Access rules for the Maintenance plugin.
+ */
+export const maintenanceAccess = {
+  /**
+   * Maintenance access with both read and manage levels.
+   * Read is public by default.
+   */
+  maintenance: accessPair(
+    "maintenance",
+    {
+      read: "View planned maintenances",
+      manage:
+        "Manage planned maintenances - create, edit, delete, and add updates",
+    },
+    {
+      readIsDefault: true,
+      readIsPublic: true,
+    }
+  ),
+};
+
+/**
+ * All access rules for registration with the plugin system.
+ */
+export const maintenanceAccessRules = [
+  maintenanceAccess.maintenance.read,
+  maintenanceAccess.maintenance.manage,
+];

package/src/index.ts

@@ -1,4 +1,4 @@
-export { permissions, permissionList } from "./permissions";
+export { maintenanceAccess, maintenanceAccessRules } from "./access";
 export {
   maintenanceContract,
   MaintenanceApi,

package/src/rpc-contract.ts

@@ -4,7 +4,7 @@ import {
   createClientDefinition,
   type ProcedureMetadata,
 } from "@checkstack/common";
-import { permissions } from "./permissions";
+import { maintenanceAccess } from "./access";
 import { pluginMetadata } from "./plugin-metadata";
 import {
   MaintenanceWithSystemsSchema,
@@ -23,7 +23,7 @@ export const maintenanceContract = {
   listMaintenances: _base
     .meta({
       userType: "public",
-      permissions: [permissions.maintenanceRead.id],
+      access: [maintenanceAccess.maintenance.read],
     })
     .input(
       z
@@ -33,13 +33,13 @@ export const maintenanceContract = {
         })
         .optional()
     )
-    .output(z.array(MaintenanceWithSystemsSchema)),
+    .output(z.object({ maintenances: z.array(MaintenanceWithSystemsSchema) })),
 
   /** Get a single maintenance with all details */
   getMaintenance: _base
     .meta({
       userType: "public",
-      permissions: [permissions.maintenanceRead.id],
+      access: [maintenanceAccess.maintenance.read],
     })
     .input(z.object({ id: z.string() }))
     .output(MaintenanceDetailSchema.nullable()),
@@ -48,7 +48,7 @@ export const maintenanceContract = {
   getMaintenancesForSystem: _base
     .meta({
       userType: "public",
-      permissions: [permissions.maintenanceRead.id],
+      access: [maintenanceAccess.maintenance.read],
     })
     .input(z.object({ systemId: z.string() }))
     .output(z.array(MaintenanceWithSystemsSchema)),
@@ -57,7 +57,7 @@ export const maintenanceContract = {
   createMaintenance: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.maintenanceManage.id],
+      access: [maintenanceAccess.maintenance.manage],
     })
     .input(CreateMaintenanceInputSchema)
     .output(MaintenanceWithSystemsSchema),
@@ -66,7 +66,7 @@ export const maintenanceContract = {
   updateMaintenance: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.maintenanceManage.id],
+      access: [maintenanceAccess.maintenance.manage],
     })
     .input(UpdateMaintenanceInputSchema)
     .output(MaintenanceWithSystemsSchema),
@@ -75,7 +75,7 @@ export const maintenanceContract = {
   addUpdate: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.maintenanceManage.id],
+      access: [maintenanceAccess.maintenance.manage],
     })
     .input(AddMaintenanceUpdateInputSchema)
     .output(MaintenanceUpdateSchema),
@@ -84,7 +84,7 @@ export const maintenanceContract = {
   closeMaintenance: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.maintenanceManage.id],
+      access: [maintenanceAccess.maintenance.manage],
     })
     .input(z.object({ id: z.string(), message: z.string().optional() }))
     .output(MaintenanceWithSystemsSchema),
@@ -93,7 +93,7 @@ export const maintenanceContract = {
   deleteMaintenance: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.maintenanceManage.id],
+      access: [maintenanceAccess.maintenance.manage],
     })
     .input(z.object({ id: z.string() }))
     .output(z.object({ success: z.boolean() })),

package/src/permissions.ts

@@ -1,19 +0,0 @@
-import { createPermission, type Permission } from "@checkstack/common";
-
-export const permissions = {
-  /** Read access to maintenances - granted to all authenticated users by default */
-  maintenanceRead: createPermission(
-    "maintenance",
-    "read",
-    "View planned maintenances",
-    { isAuthenticatedDefault: true, isPublicDefault: true }
-  ),
-  /** Manage maintenances - create, edit, delete, and add updates */
-  maintenanceManage: createPermission(
-    "maintenance",
-    "manage",
-    "Manage planned maintenances"
-  ),
-} as const satisfies Record<string, Permission>;
-
-export const permissionList = Object.values(permissions);