@checkstack/maintenance-frontend 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,86 @@
 # @checkstack/maintenance-frontend
 
+## 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 [95eeec7]
+- Updated dependencies [f533141]
+  - @checkstack/auth-frontend@0.2.0
+  - @checkstack/catalog-common@1.1.0
+  - @checkstack/common@0.2.0
+  - @checkstack/frontend-api@0.1.0
+  - @checkstack/maintenance-common@0.2.0
+  - @checkstack/ui@0.2.0
+  - @checkstack/signal-frontend@0.0.6
+
 ## 0.1.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/maintenance-frontend",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "type": "module",
   "main": "src/index.tsx",
   "scripts": {

package/src/components/MaintenanceMenuItems.tsx

@@ -3,20 +3,17 @@ import { Link } from "react-router-dom";
 import { Wrench } from "lucide-react";
 import type { UserMenuItemsContext } from "@checkstack/frontend-api";
 import { DropdownMenuItem } from "@checkstack/ui";
-import { qualifyPermissionId, resolveRoute } from "@checkstack/common";
+import { resolveRoute } from "@checkstack/common";
 import {
   maintenanceRoutes,
-  permissions,
+  maintenanceAccess,
   pluginMetadata,
 } from "@checkstack/maintenance-common";
 
 export const MaintenanceMenuItems = ({
-  permissions: userPerms,
+  accessRules: userPerms,
 }: UserMenuItemsContext) => {
-  const qualifiedId = qualifyPermissionId(
-    pluginMetadata,
-    permissions.maintenanceManage
-  );
+  const qualifiedId = `${pluginMetadata.pluginId}.${maintenanceAccess.maintenance.manage.id}`;
   const canManage = userPerms.includes("*") || userPerms.includes(qualifiedId);
 
   if (!canManage) {

package/src/index.tsx

@@ -10,7 +10,7 @@ import {
   maintenanceRoutes,
   MaintenanceApi,
   pluginMetadata,
-  permissions,
+  maintenanceAccess,
 } from "@checkstack/maintenance-common";
 import {
   SystemDetailsTopSlot,
@@ -30,7 +30,7 @@ export default createFrontendPlugin({
       route: maintenanceRoutes.routes.config,
       element: <MaintenanceConfigPage />,
       title: "Maintenances",
-      permission: permissions.maintenanceManage,
+      accessRule: maintenanceAccess.maintenance.manage,
     },
     {
       route: maintenanceRoutes.routes.systemHistory,

package/src/pages/MaintenanceConfigPage.tsx

@@ -3,7 +3,7 @@ import { useSearchParams } from "react-router-dom";
 import {
   useApi,
   rpcApiRef,
-  permissionApiRef,
+  accessApiRef,
   wrapInSuspense,
 } from "@checkstack/frontend-api";
 import { maintenanceApiRef } from "../api";
@@ -11,6 +11,7 @@ import type {
   MaintenanceWithSystems,
   MaintenanceStatus,
 } from "@checkstack/maintenance-common";
+import { maintenanceAccess } from "@checkstack/maintenance-common";
 import { CatalogApi, type System } from "@checkstack/catalog-common";
 import {
   Card,
@@ -51,14 +52,14 @@ import { getMaintenanceStatusBadge } from "../utils/badges";
 const MaintenanceConfigPageContent: React.FC = () => {
   const api = useApi(maintenanceApiRef);
   const rpcApi = useApi(rpcApiRef);
-  const permissionApi = useApi(permissionApiRef);
+  const accessApi = useApi(accessApiRef);
   const [searchParams, setSearchParams] = useSearchParams();
 
   const catalogApi = useMemo(() => rpcApi.forPlugin(CatalogApi), [rpcApi]);
   const toast = useToast();
 
-  const { allowed: canManage, loading: permissionLoading } =
-    permissionApi.useResourcePermission("maintenance", "manage");
+  const { allowed: canManage, loading: accessLoading } =
+    accessApi.useAccess(maintenanceAccess.maintenance.manage);
 
   const [maintenances, setMaintenances] = useState<MaintenanceWithSystems[]>(
     []
@@ -186,7 +187,7 @@ const MaintenanceConfigPageContent: React.FC = () => {
     <PageLayout
       title="Planned Maintenances"
       subtitle="Manage scheduled maintenance windows for systems"
-      loading={permissionLoading}
+      loading={accessLoading}
       allowed={canManage}
       actions={
         <Button onClick={handleCreate}>

package/src/pages/MaintenanceDetailPage.tsx

@@ -9,11 +9,14 @@ import {
   useApi,
   rpcApiRef,
   wrapInSuspense,
-  permissionApiRef,
+  accessApiRef,
 } from "@checkstack/frontend-api";
 import { resolveRoute } from "@checkstack/common";
 import { maintenanceApiRef } from "../api";
-import { maintenanceRoutes } from "@checkstack/maintenance-common";
+import {
+  maintenanceRoutes,
+  maintenanceAccess,
+} from "@checkstack/maintenance-common";
 import type { MaintenanceDetail } from "@checkstack/maintenance-common";
 import {
   catalogRoutes,
@@ -53,14 +56,13 @@ const MaintenanceDetailPageContent: React.FC = () => {
   const [searchParams] = useSearchParams();
   const api = useApi(maintenanceApiRef);
   const rpcApi = useApi(rpcApiRef);
-  const permissionApi = useApi(permissionApiRef);
+  const accessApi = useApi(accessApiRef);
   const toast = useToast();
 
   const catalogApi = useMemo(() => rpcApi.forPlugin(CatalogApi), [rpcApi]);
 
-  const { allowed: canManage } = permissionApi.useResourcePermission(
-    "maintenance",
-    "manage"
+  const { allowed: canManage } = accessApi.useAccess(
+    maintenanceAccess.maintenance.manage
   );
 
   const [maintenance, setMaintenance] = useState<MaintenanceDetail>();