@checkstack/maintenance-common 0.1.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,142 @@
 # @checkstack/maintenance-common
 
+## 0.3.0
+
+### Minor Changes
+
+- 7a23261: ## TanStack Query Integration
+
+  Migrated all frontend components to use `usePluginClient` hook with TanStack Query integration, replacing the legacy `forPlugin()` pattern.
+
+  ### New Features
+
+  - **`usePluginClient` hook**: Provides type-safe access to plugin APIs with `.useQuery()` and `.useMutation()` methods
+  - **Automatic request deduplication**: Multiple components requesting the same data share a single network request
+  - **Built-in caching**: Configurable stale time and cache duration per query
+  - **Loading/error states**: TanStack Query provides `isLoading`, `error`, `isRefetching` states automatically
+  - **Background refetching**: Stale data is automatically refreshed when components mount
+
+  ### Contract Changes
+
+  All RPC contracts now require `operationType: "query"` or `operationType: "mutation"` metadata:
+
+  ```typescript
+  const getItems = proc()
+    .meta({ operationType: "query", access: [access.read] })
+    .output(z.array(itemSchema))
+    .query();
+
+  const createItem = proc()
+    .meta({ operationType: "mutation", access: [access.manage] })
+    .input(createItemSchema)
+    .output(itemSchema)
+    .mutation();
+  ```
+
+  ### Migration
+
+  ```typescript
+  // Before (forPlugin pattern)
+  const api = useApi(myPluginApiRef);
+  const [items, setItems] = useState<Item[]>([]);
+  useEffect(() => {
+    api.getItems().then(setItems);
+  }, [api]);
+
+  // After (usePluginClient pattern)
+  const client = usePluginClient(MyPluginApi);
+  const { data: items, isLoading } = client.getItems.useQuery({});
+  ```
+
+  ### Bug Fixes
+
+  - Fixed `rpc.test.ts` test setup for middleware type inference
+  - Fixed `SearchDialog` to use `setQuery` instead of deprecated `search` method
+  - Fixed null→undefined warnings in notification and queue frontends
+
+### Patch Changes
+
+- Updated dependencies [7a23261]
+  - @checkstack/frontend-api@0.2.0
+  - @checkstack/common@0.3.0
+  - @checkstack/signal-common@0.1.1
+
+## 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

package/package.json

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

package/src/access.ts

@@ -0,0 +1,48 @@
+import { access, 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.
+   * Uses system-level instance access for team-based filtering.
+   */
+  maintenance: accessPair(
+    "maintenance",
+    {
+      read: "View planned maintenances",
+      manage:
+        "Manage planned maintenances - create, edit, delete, and add updates",
+    },
+    {
+      idParam: "systemId",
+      readIsDefault: true,
+      readIsPublic: true,
+    }
+  ),
+
+  /**
+   * Bulk maintenance access for viewing maintenances for multiple systems.
+   * Uses recordKey for filtering the output record by accessible system IDs.
+   */
+  bulkMaintenance: access(
+    "maintenance.maintenance",
+    "read",
+    "View planned maintenances",
+    {
+      recordKey: "maintenances",
+      isDefault: true,
+      isPublic: 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

@@ -1,11 +1,6 @@
-import { oc } from "@orpc/contract";
 import { z } from "zod";
-import {
-  createClientDefinition,
-  createResourceAccessList,
-  type ProcedureMetadata,
-} from "@checkstack/common";
-import { permissions } from "./permissions";
+import { createClientDefinition, proc } from "@checkstack/common";
+import { maintenanceAccess } from "./access";
 import { pluginMetadata } from "./plugin-metadata";
 import {
   MaintenanceWithSystemsSchema,
@@ -17,22 +12,13 @@ import {
   MaintenanceStatusEnum,
 } from "./schemas";
 
-const _base = oc.$meta<ProcedureMetadata>({});
-
-// Resource access configurations for team-based access control
-const maintenanceListAccess = createResourceAccessList(
-  "maintenance",
-  "maintenances"
-);
-
 export const maintenanceContract = {
   /** List all maintenances with optional status filter */
-  listMaintenances: _base
-    .meta({
-      userType: "public",
-      permissions: [permissions.maintenanceRead.id],
-      resourceAccess: [maintenanceListAccess],
-    })
+  listMaintenances: proc({
+    operationType: "query",
+    userType: "public",
+    access: [maintenanceAccess.maintenance.read],
+  })
     .input(
       z
         .object({
@@ -44,65 +30,83 @@ export const maintenanceContract = {
     .output(z.object({ maintenances: z.array(MaintenanceWithSystemsSchema) })),
 
   /** Get a single maintenance with all details */
-  getMaintenance: _base
-    .meta({
-      userType: "public",
-      permissions: [permissions.maintenanceRead.id],
-    })
+  getMaintenance: proc({
+    operationType: "query",
+    userType: "public",
+    access: [maintenanceAccess.maintenance.read],
+  })
     .input(z.object({ id: z.string() }))
     .output(MaintenanceDetailSchema.nullable()),
 
   /** Get active or upcoming maintenances for a specific system */
-  getMaintenancesForSystem: _base
-    .meta({
-      userType: "public",
-      permissions: [permissions.maintenanceRead.id],
-    })
+  getMaintenancesForSystem: proc({
+    operationType: "query",
+    userType: "public",
+    access: [maintenanceAccess.maintenance.read],
+  })
     .input(z.object({ systemId: z.string() }))
     .output(z.array(MaintenanceWithSystemsSchema)),
 
+  /** Get active maintenances for multiple systems in a single request.
+   * Used for efficient dashboard rendering to avoid N+1 queries.
+   */
+  getBulkMaintenancesForSystems: proc({
+    operationType: "query",
+    userType: "public",
+    access: [maintenanceAccess.bulkMaintenance],
+  })
+    .input(z.object({ systemIds: z.array(z.string()) }))
+    .output(
+      z.object({
+        maintenances: z.record(
+          z.string(),
+          z.array(MaintenanceWithSystemsSchema)
+        ),
+      })
+    ),
+
   /** Create a new maintenance */
-  createMaintenance: _base
-    .meta({
-      userType: "authenticated",
-      permissions: [permissions.maintenanceManage.id],
-    })
+  createMaintenance: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    access: [maintenanceAccess.maintenance.manage],
+  })
     .input(CreateMaintenanceInputSchema)
     .output(MaintenanceWithSystemsSchema),
 
   /** Update an existing maintenance */
-  updateMaintenance: _base
-    .meta({
-      userType: "authenticated",
-      permissions: [permissions.maintenanceManage.id],
-    })
+  updateMaintenance: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    access: [maintenanceAccess.maintenance.manage],
+  })
     .input(UpdateMaintenanceInputSchema)
     .output(MaintenanceWithSystemsSchema),
 
   /** Add a status update to a maintenance */
-  addUpdate: _base
-    .meta({
-      userType: "authenticated",
-      permissions: [permissions.maintenanceManage.id],
-    })
+  addUpdate: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    access: [maintenanceAccess.maintenance.manage],
+  })
     .input(AddMaintenanceUpdateInputSchema)
     .output(MaintenanceUpdateSchema),
 
   /** Close a maintenance early (sets status to completed) */
-  closeMaintenance: _base
-    .meta({
-      userType: "authenticated",
-      permissions: [permissions.maintenanceManage.id],
-    })
+  closeMaintenance: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    access: [maintenanceAccess.maintenance.manage],
+  })
     .input(z.object({ id: z.string(), message: z.string().optional() }))
     .output(MaintenanceWithSystemsSchema),
 
   /** Delete a maintenance */
-  deleteMaintenance: _base
-    .meta({
-      userType: "authenticated",
-      permissions: [permissions.maintenanceManage.id],
-    })
+  deleteMaintenance: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    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);