@checkstack/api-docs-frontend 0.0.4 → 0.1.0

package/CHANGELOG.md

@@ -1,5 +1,94 @@
 # @checkstack/api-docs-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/api-docs-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
+
+- Updated dependencies [8e43507]
+- Updated dependencies [97c5a6b]
+- Updated dependencies [8e43507]
+  - @checkstack/ui@0.1.0
+  - @checkstack/common@0.1.0
+  - @checkstack/api-docs-common@0.0.4
+  - @checkstack/frontend-api@0.0.4
+
 ## 0.0.4
 
 ### Patch Changes

package/package.json

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

package/src/ApiDocsMenuItem.tsx

@@ -2,25 +2,19 @@ import { useNavigate } from "react-router-dom";
 import { FileCode2 } from "lucide-react";
 import { DropdownMenuItem } from "@checkstack/ui";
 import type { UserMenuItemsContext } from "@checkstack/frontend-api";
-import { resolveRoute, qualifyPermissionId } from "@checkstack/common";
-import {
-  pluginMetadata,
-  permissions,
-} from "@checkstack/api-docs-common";
+import { resolveRoute } from "@checkstack/common";
+import { pluginMetadata, apiDocsAccess } from "@checkstack/api-docs-common";
 import { apiDocsRoutes } from "./index";
 import React from "react";
 
-const REQUIRED_PERMISSION = qualifyPermissionId(
-  pluginMetadata,
-  permissions.apiDocsView
-);
+const REQUIRED_ACCESS_RULE = `${pluginMetadata.pluginId}.${apiDocsAccess.view.id}`;
 
 export function ApiDocsMenuItem({
-  permissions: userPerms,
+  accessRules: userPerms,
 }: UserMenuItemsContext) {
   const navigate = useNavigate();
   const canView =
-    userPerms.includes("*") || userPerms.includes(REQUIRED_PERMISSION);
+    userPerms.includes("*") || userPerms.includes(REQUIRED_ACCESS_RULE);
 
   if (!canView) return <React.Fragment />;
 

package/src/ApiDocsPage.tsx

@@ -49,7 +49,7 @@ interface OperationObject {
   >;
   "x-orpc-meta"?: {
     userType?: string;
-    permissions?: string[];
+    accessRules?: string[];
   };
 }
 
@@ -290,11 +290,11 @@ function EndpointCard({
             </p>
           )}
 
-          {meta?.permissions && meta.permissions.length > 0 && (
+          {meta?.accessRules && meta.accessRules.length > 0 && (
             <div>
-              <h4 className="text-sm font-medium mb-2">Required Permissions</h4>
+              <h4 className="text-sm font-medium mb-2">Required Access Rules</h4>
               <div className="flex flex-wrap gap-2">
-                {meta.permissions.map((perm) => (
+                {meta.accessRules.map((perm) => (
                   <Badge key={perm} variant="secondary">
                     {perm}
                   </Badge>

package/src/index.tsx

@@ -4,10 +4,7 @@ import {
   UserMenuItemsSlot,
 } from "@checkstack/frontend-api";
 import { createRoutes } from "@checkstack/common";
-import {
-  pluginMetadata,
-  permissions,
-} from "@checkstack/api-docs-common";
+import { pluginMetadata, apiDocsAccess } from "@checkstack/api-docs-common";
 import { ApiDocsPage } from "./ApiDocsPage";
 import { ApiDocsMenuItem } from "./ApiDocsMenuItem";
 
@@ -21,7 +18,7 @@ export const apiDocsPlugin = createFrontendPlugin({
     {
       route: apiDocsRoutes.routes.docs,
       element: <ApiDocsPage />,
-      permission: permissions.apiDocsView,
+      accessRule: apiDocsAccess.view,
     },
   ],
   extensions: [