@checkstack/notification-common 0.0.4 → 0.1.0

package/CHANGELOG.md

@@ -1,5 +1,80 @@
 # @checkstack/notification-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
+  - @checkstack/signal-common@0.1.0
+
 ## 0.0.4
 
 ### Patch Changes

package/package.json

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

package/src/access.ts

@@ -0,0 +1,20 @@
+import { access } from "@checkstack/common";
+
+/**
+ * Access rules for the Notification plugin.
+ */
+export const notificationAccess = {
+  /**
+   * Configure notification settings and send broadcasts.
+   */
+  admin: access(
+    "notification",
+    "manage",
+    "Configure notification settings and send broadcasts"
+  ),
+};
+
+/**
+ * All access rules for registration with the plugin system.
+ */
+export const notificationAccessRules = [notificationAccess.admin];

package/src/index.ts

@@ -1,5 +1,5 @@
 export * from "./schemas";
-export * from "./permissions";
+export * from "./access";
 export * from "./rpc-contract";
 export * from "./signals";
 export * from "./plugin-metadata";

package/src/rpc-contract.ts

@@ -1,6 +1,6 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
-import { permissions } from "./permissions";
+import { notificationAccess } from "./access";
 import { pluginMetadata } from "./plugin-metadata";
 import {
   createClientDefinition,
@@ -14,7 +14,7 @@ import {
   PaginationInputSchema,
 } from "./schemas";
 
-// Base builder with full metadata support (userType + permissions)
+// Base builder with full metadata support (userType + access)
 const _base = oc.$meta<ProcedureMetadata>({});
 
 // Notification RPC Contract
@@ -98,14 +98,14 @@ export const notificationContract = {
     .output(z.void()),
 
   // ==========================================================================
-  // ADMIN SETTINGS ENDPOINTS (userType: "user" with admin permissions)
+  // ADMIN SETTINGS ENDPOINTS (userType: "user" with admin accesss)
   // ==========================================================================
 
   // Get retention schema for DynamicForm
   getRetentionSchema: _base
     .meta({
       userType: "user",
-      permissions: [permissions.notificationAdmin.id],
+      access: [notificationAccess.admin],
     })
     .output(z.record(z.string(), z.unknown())),
 
@@ -113,7 +113,7 @@ export const notificationContract = {
   getRetentionSettings: _base
     .meta({
       userType: "user",
-      permissions: [permissions.notificationAdmin.id],
+      access: [notificationAccess.admin],
     })
     .output(RetentionSettingsSchema),
 
@@ -121,7 +121,7 @@ export const notificationContract = {
   setRetentionSettings: _base
     .meta({
       userType: "user",
-      permissions: [permissions.notificationAdmin.id],
+      access: [notificationAccess.admin],
     })
     .input(RetentionSettingsSchema)
     .output(z.void()),
@@ -256,14 +256,14 @@ export const notificationContract = {
     ),
 
   // ==========================================================================
-  // DELIVERY STRATEGY ADMIN ENDPOINTS (userType: "user" with admin permissions)
+  // DELIVERY STRATEGY ADMIN ENDPOINTS (userType: "user" with admin accesss)
   // ==========================================================================
 
   // Get all registered delivery strategies with current config
   getDeliveryStrategies: _base
     .meta({
       userType: "user",
-      permissions: [permissions.notificationAdmin.id],
+      access: [notificationAccess.admin],
     })
     .output(
       z.array(
@@ -304,7 +304,7 @@ export const notificationContract = {
   updateDeliveryStrategy: _base
     .meta({
       userType: "user",
-      permissions: [permissions.notificationAdmin.id],
+      access: [notificationAccess.admin],
     })
     .input(
       z.object({

package/src/permissions.ts

@@ -1,12 +0,0 @@
-import { createPermission } from "@checkstack/common";
-
-export const permissions = {
-  /** Configure retention policy and send broadcasts */
-  notificationAdmin: createPermission(
-    "notification",
-    "manage",
-    "Configure notification settings and send broadcasts"
-  ),
-};
-
-export const permissionList = Object.values(permissions);