@checkstack/command-frontend 0.0.5 → 0.1.0

package/CHANGELOG.md

@@ -1,5 +1,82 @@
 # @checkstack/command-frontend
 
+## 0.1.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/command-common@0.1.0
+  - @checkstack/common@0.2.0
+  - @checkstack/frontend-api@0.1.0
+  - @checkstack/ui@0.2.0
+
 ## 0.0.5
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/command-frontend",
-  "version": "0.0.5",
+  "version": "0.1.0",
   "type": "module",
   "exports": {
     ".": {

package/src/index.tsx

@@ -118,16 +118,16 @@ export function formatShortcut(shortcut: string, isMac: boolean): string {
  *
  * @param commands - Array of commands with shortcuts
  * @param navigate - Navigation function to call when a command is triggered
- * @param userPermissions - Array of permission IDs the user has
+ * @param userAccessRules - Array of access rule IDs the user has
  */
 export function useGlobalShortcuts(
   commands: SearchResult[],
   navigate: (route: string) => void,
-  userPermissions: string[]
+  userAccessRules: string[]
 ): void {
   useEffect(() => {
-    // Check if user has wildcard permission (admin)
-    const hasWildcard = userPermissions.includes("*");
+    // Check if user has wildcard access rule (admin)
+    const hasWildcard = userAccessRules.includes("*");
 
     const handleKeyDown = (event: KeyboardEvent) => {
       // Don't trigger in input fields
@@ -144,12 +144,12 @@ export function useGlobalShortcuts(
       for (const command of commands) {
         if (!command.shortcuts || !command.route) continue;
 
-        // Check permissions (skip if user has wildcard)
-        if (!hasWildcard && command.requiredPermissions?.length) {
-          const hasPermission = command.requiredPermissions.every((perm) =>
-            userPermissions.includes(perm)
+        // Check access rules (skip if user has wildcard)
+        if (!hasWildcard && command.requiredAccessRules?.length) {
+          const hasAccess = command.requiredAccessRules.every((rule) =>
+            userAccessRules.includes(rule)
           );
-          if (!hasPermission) continue;
+          if (!hasAccess) continue;
         }
 
         for (const shortcut of command.shortcuts) {
@@ -165,7 +165,7 @@ export function useGlobalShortcuts(
 
     globalThis.addEventListener("keydown", handleKeyDown);
     return () => globalThis.removeEventListener("keydown", handleKeyDown);
-  }, [commands, navigate, userPermissions]);
+  }, [commands, navigate, userAccessRules]);
 }
 
 /**
@@ -359,7 +359,7 @@ export function GlobalShortcuts(): React.ReactNode {
     globalThis.location.href = route;
   }, []);
 
-  // For now, pass "*" as permission since the backend already filters by permission
+  // For now, pass "*" as access rule since the backend already filters
   // The commands returned from getCommands are already filtered
   useGlobalShortcuts(commands, navigate, ["*"]);