@checkstack/queue-common 0.0.3 → 0.1.0

package/CHANGELOG.md

@@ -1,5 +1,86 @@
 # @checkstack/queue-common
 
+## 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/queue-common",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "type": "module",
   "exports": {
     ".": {

package/src/access.ts

@@ -0,0 +1,22 @@
+import { accessPair } from "@checkstack/common";
+
+/**
+ * Access rules for the Queue plugin.
+ */
+export const queueAccess = {
+  /**
+   * Queue settings access.
+   */
+  settings: accessPair("queue", {
+    read: "Read Queue Settings",
+    manage: "Update Queue Settings",
+  }),
+};
+
+/**
+ * All access rules for registration with the plugin system.
+ */
+export const queueAccessRules = [
+  queueAccess.settings.read,
+  queueAccess.settings.manage,
+];

package/src/index.ts

@@ -1,10 +1,5 @@
 export * from "./schemas";
-export * from "./permissions";
-export {
-  queueContract,
-  QueueApi,
-  type QueueContract,
-  type QueueMetadata,
-} from "./rpc-contract";
+export * from "./access";
+export { queueContract, QueueApi, type QueueContract } from "./rpc-contract";
 export * from "./plugin-metadata";
 export { queueRoutes } from "./routes";

package/src/rpc-contract.ts

@@ -1,7 +1,10 @@
 import { oc } from "@orpc/contract";
-import { createClientDefinition } from "@checkstack/common";
+import {
+  createClientDefinition,
+  type ProcedureMetadata,
+} from "@checkstack/common";
 import { z } from "zod";
-import { permissions } from "./permissions";
+import { queueAccess } from "./access";
 import { pluginMetadata } from "./plugin-metadata";
 import {
   QueuePluginDtoSchema,
@@ -9,28 +12,32 @@ import {
   UpdateQueueConfigurationSchema,
 } from "./schemas";
 
-// Permission metadata type
-export interface QueueMetadata {
-  permissions?: string[];
-}
-
 // Base builder with metadata support
-const _base = oc.$meta<QueueMetadata>({});
+const _base = oc.$meta<ProcedureMetadata>({});
 
-// Queue RPC Contract with permission metadata
+// Queue RPC Contract with access metadata
 export const queueContract = {
-  // Queue plugin queries - Read permission
+  // Queue plugin queries - Read access
   getPlugins: _base
-    .meta({ permissions: [permissions.queueRead.id] })
+    .meta({
+      userType: "authenticated",
+      access: [queueAccess.settings.read],
+    })
     .output(z.array(QueuePluginDtoSchema)),
 
   getConfiguration: _base
-    .meta({ permissions: [permissions.queueRead.id] })
+    .meta({
+      userType: "authenticated",
+      access: [queueAccess.settings.read],
+    })
     .output(QueueConfigurationDtoSchema),
 
-  // Queue configuration updates - Manage permission
+  // Queue configuration updates - Manage access
   updateConfiguration: _base
-    .meta({ permissions: [permissions.queueManage.id] })
+    .meta({
+      userType: "authenticated",
+      access: [queueAccess.settings.manage],
+    })
     .input(UpdateQueueConfigurationSchema)
     .output(QueueConfigurationDtoSchema),
 };

package/src/permissions.ts

@@ -1,11 +0,0 @@
-import { createPermission } from "@checkstack/common";
-
-/**
- * Permissions for queue settings
- */
-export const permissions = {
-  queueRead: createPermission("queue", "read", "Read Queue Settings"),
-  queueManage: createPermission("queue", "manage", "Update Queue Settings"),
-};
-
-export const permissionList = Object.values(permissions);