@checkstack/signal-backend 0.0.4 → 0.1.0

package/CHANGELOG.md

@@ -1,5 +1,83 @@
 # @checkstack/signal-backend
 
+## 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 [827b286]
+- Updated dependencies [f533141]
+- Updated dependencies [aa4a8ab]
+  - @checkstack/backend-api@0.3.0
+  - @checkstack/common@0.2.0
+  - @checkstack/signal-common@0.1.0
+
 ## 0.0.4
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/signal-backend",
-  "version": "0.0.4",
+  "version": "0.1.0",
   "type": "module",
   "exports": {
     ".": {

package/src/signal-service-impl.ts

@@ -1,5 +1,5 @@
 import type { EventBus, Logger } from "@checkstack/backend-api";
-import { qualifyPermissionId } from "@checkstack/common";
+import { qualifyAccessRuleId } from "@checkstack/common";
 import type {
   Signal,
   SignalMessage,
@@ -12,9 +12,9 @@ import { SIGNAL_BROADCAST_HOOK, SIGNAL_USER_HOOK } from "./hooks";
  * This is a subset of the AuthApi client to avoid circular dependencies.
  */
 interface AuthClientForSignals {
-  filterUsersByPermission: (input: {
+  filterUsersByAccessRule: (input: {
     userIds: string[];
-    permission: string;
+    accessRule: string;
   }) => Promise<string[]>;
 }
 
@@ -30,7 +30,7 @@ export class SignalServiceImpl implements SignalService {
   constructor(private eventBus: EventBus, private logger: Logger) {}
 
   /**
-   * Set the auth client for permission-based signal filtering.
+   * Set the auth client for access-based signal filtering.
    * This should be called after plugins have loaded.
    */
   setAuthClient(client: AuthClientForSignals): void {
@@ -81,7 +81,7 @@ export class SignalServiceImpl implements SignalService {
     userIds: string[],
     payload: T,
     pluginMetadata: { pluginId: string },
-    permission: { id: string }
+    accessRule: { id: string }
   ): Promise<void> {
     if (userIds.length === 0) return;
 
@@ -92,18 +92,18 @@ export class SignalServiceImpl implements SignalService {
       return;
     }
 
-    // Construct fully-qualified permission ID: ${pluginMetadata.pluginId}.${permission.id}
-    const qualifiedPermission = qualifyPermissionId(pluginMetadata, permission);
+    // Construct fully-qualified access rule ID: ${pluginMetadata.pluginId}.${accessRule.id}
+    const qualifiedAccessRule = qualifyAccessRuleId(pluginMetadata, accessRule);
 
     // Filter users via auth RPC
-    const authorizedIds = await this.authClient.filterUsersByPermission({
+    const authorizedIds = await this.authClient.filterUsersByAccessRule({
       userIds,
-      permission: qualifiedPermission,
+      accessRule: qualifiedAccessRule,
     });
 
     if (authorizedIds.length === 0) {
       this.logger.debug(
-        `No users authorized for signal ${signal.id} with permission ${qualifiedPermission}`
+        `No users authorized for signal ${signal.id} with access ${qualifiedAccessRule}`
       );
       return;
     }