@checkstack/frontend-api 0.0.3 → 0.1.0

package/CHANGELOG.md

@@ -1,5 +1,86 @@
 # @checkstack/frontend-api
 
+## 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/common@0.2.0
+
+## 0.0.4
+
+### Patch Changes
+
+- Updated dependencies [8e43507]
+  - @checkstack/common@0.1.0
+
 ## 0.0.3
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/frontend-api",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "type": "module",
   "main": "./src/index.ts",
   "scripts": {

package/src/core-apis.ts

@@ -1,8 +1,4 @@
-import {
-  PermissionAction,
-  ClientDefinition,
-  InferClient,
-} from "@checkstack/common";
+import { AccessRule, ClientDefinition, InferClient } from "@checkstack/common";
 import { createApiRef } from "./api-ref";
 
 export interface LoggerApi {
@@ -22,16 +18,30 @@ export interface FetchApi {
 export const loggerApiRef = createApiRef<LoggerApi>("core.logger");
 export const fetchApiRef = createApiRef<FetchApi>("core.fetch");
 
-export interface PermissionApi {
-  usePermission(permission: string): { loading: boolean; allowed: boolean };
-  useResourcePermission(
-    resource: string,
-    action: PermissionAction
-  ): { loading: boolean; allowed: boolean };
-  useManagePermission(resource: string): { loading: boolean; allowed: boolean };
+/**
+ * Unified access API for checking user access via AccessRules.
+ *
+ * Uses the same AccessRule objects from plugin common packages
+ * that are used in backend contracts.
+ */
+export interface AccessApi {
+  /**
+   * Check if the current user has access based on an AccessRule.
+   *
+   * @example
+   * ```tsx
+   * import { catalogAccess } from "@checkstack/catalog-common";
+   *
+   * const { allowed, loading } = accessApi.useAccess(catalogAccess.system.manage);
+   * if (allowed) {
+   *   // User can manage systems
+   * }
+   * ```
+   */
+  useAccess(accessRule: AccessRule): { loading: boolean; allowed: boolean };
 }
 
-export const permissionApiRef = createApiRef<PermissionApi>("core.permission");
+export const accessApiRef = createApiRef<AccessApi>("core.access");
 
 export interface RpcApi {
   client: unknown;

package/src/plugin-registry.ts

@@ -14,7 +14,7 @@ interface ResolvedRoute {
   pluginId: string;
   element?: React.ReactNode;
   title?: string;
-  permission?: string;
+  accessRule?: string;
 }
 
 class PluginRegistry {
@@ -61,7 +61,7 @@ class PluginRegistry {
         pluginId: route.route.pluginId,
         element: route.element,
         title: route.title,
-        permission: route.permission?.id,
+        accessRule: route.accessRule?.id,
       };
 
       // Add to route map for resolution
@@ -175,7 +175,7 @@ class PluginRegistry {
           path: fullPath,
           element: route.element,
           title: route.title,
-          permission: route.permission?.id,
+          accessRule: route.accessRule?.id,
         };
       });
     });

package/src/plugin.ts

@@ -4,7 +4,7 @@ import type { SlotDefinition } from "./slots";
 import type {
   RouteDefinition,
   PluginMetadata,
-  Permission,
+  AccessRule,
 } from "@checkstack/common";
 
 /**
@@ -51,8 +51,8 @@ export interface PluginRoute {
   /** Page title */
   title?: string;
 
-  /** Permission required to access this route (use permission object from common package) */
-  permission?: Permission;
+  /** Access rule required to access this route (use access object from common package) */
+  accessRule?: AccessRule;
 }
 
 /**

package/src/slots.ts

@@ -44,10 +44,10 @@ export const NavbarRightSlot = createSlot("core.layout.navbar.right");
 
 /**
  * Context for user menu item slots.
- * Provides the user's permissions array and authentication info for synchronous checks.
+ * Provides the user's access rules array and authentication info for synchronous checks.
  */
 export interface UserMenuItemsContext {
-  permissions: string[];
+  accessRules: string[];
   hasCredentialAccount: boolean;
 }