@checkstack/integration-common 0.0.3 → 0.1.0

package/CHANGELOG.md

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

package/package.json

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

package/src/access.ts

@@ -0,0 +1,20 @@
+import { access } from "@checkstack/common";
+
+/**
+ * Access rules for the Integration plugin.
+ */
+export const integrationAccess = {
+  /**
+   * Manage webhook integrations and view delivery logs.
+   */
+  manage: access(
+    "integration",
+    "manage",
+    "Manage webhook integrations and view delivery logs"
+  ),
+};
+
+/**
+ * All access rules for registration with the plugin system.
+ */
+export const integrationAccessRules = [integrationAccess.manage];

package/src/index.ts

@@ -48,8 +48,8 @@ export {
 // are defined in @checkstack/integration-backend/provider-types.
 // Frontend code should only use the Zod schemas above for API contracts.
 
-// Permissions
-export * from "./permissions";
+// Access rules
+export * from "./access";
 
 // RPC Contract
 export * from "./rpc-contract";

package/src/rpc-contract.ts

@@ -1,6 +1,6 @@
 import { oc } from "@orpc/contract";
 import { z } from "zod";
-import { permissions } from "./permissions";
+import { integrationAccess } from "./access";
 import { pluginMetadata } from "./plugin-metadata";
 import {
   createClientDefinition,
@@ -23,7 +23,7 @@ import {
   EventPayloadSchemaOutputSchema,
 } from "./schemas";
 
-// Base builder with full metadata support (userType + permissions)
+// Base builder with full metadata support (userType + access)
 const _base = oc.$meta<ProcedureMetadata>({});
 
 // Integration RPC Contract
@@ -36,7 +36,7 @@ export const integrationContract = {
   listSubscriptions: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(
       z.object({
@@ -58,7 +58,7 @@ export const integrationContract = {
   getSubscription: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(z.object({ id: z.string() }))
     .output(WebhookSubscriptionSchema),
@@ -67,7 +67,7 @@ export const integrationContract = {
   createSubscription: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(CreateSubscriptionInputSchema)
     .output(WebhookSubscriptionSchema),
@@ -76,7 +76,7 @@ export const integrationContract = {
   updateSubscription: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(UpdateSubscriptionInputSchema)
     .output(WebhookSubscriptionSchema),
@@ -85,7 +85,7 @@ export const integrationContract = {
   deleteSubscription: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(z.object({ id: z.string() }))
     .output(z.object({ success: z.boolean() })),
@@ -94,7 +94,7 @@ export const integrationContract = {
   toggleSubscription: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(z.object({ id: z.string(), enabled: z.boolean() }))
     .output(z.object({ success: z.boolean() })),
@@ -107,7 +107,7 @@ export const integrationContract = {
   listProviders: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .output(z.array(IntegrationProviderInfoSchema)),
 
@@ -115,7 +115,7 @@ export const integrationContract = {
   testProviderConnection: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(
       z.object({
@@ -134,7 +134,7 @@ export const integrationContract = {
   listConnections: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(z.object({ providerId: z.string() }))
     .output(z.array(ProviderConnectionRedactedSchema)),
@@ -143,7 +143,7 @@ export const integrationContract = {
   getConnection: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(z.object({ connectionId: z.string() }))
     .output(ProviderConnectionRedactedSchema),
@@ -152,7 +152,7 @@ export const integrationContract = {
   createConnection: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(CreateConnectionInputSchema)
     .output(ProviderConnectionRedactedSchema),
@@ -161,7 +161,7 @@ export const integrationContract = {
   updateConnection: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(UpdateConnectionInputSchema)
     .output(ProviderConnectionRedactedSchema),
@@ -170,7 +170,7 @@ export const integrationContract = {
   deleteConnection: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(z.object({ connectionId: z.string() }))
     .output(z.object({ success: z.boolean() })),
@@ -179,7 +179,7 @@ export const integrationContract = {
   testConnection: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(z.object({ connectionId: z.string() }))
     .output(TestConnectionResultSchema),
@@ -188,7 +188,7 @@ export const integrationContract = {
   getConnectionOptions: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(GetConnectionOptionsInputSchema)
     .output(z.array(ConnectionOptionSchema)),
@@ -201,7 +201,7 @@ export const integrationContract = {
   listEventTypes: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .output(z.array(IntegrationEventInfoSchema)),
 
@@ -209,7 +209,7 @@ export const integrationContract = {
   getEventsByCategory: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .output(
       z.array(
@@ -224,7 +224,7 @@ export const integrationContract = {
   getEventPayloadSchema: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(z.object({ eventId: z.string() }))
     .output(EventPayloadSchemaOutputSchema),
@@ -237,7 +237,7 @@ export const integrationContract = {
   getDeliveryLogs: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(DeliveryLogQueryInputSchema)
     .output(
@@ -251,7 +251,7 @@ export const integrationContract = {
   getDeliveryLog: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(z.object({ id: z.string() }))
     .output(DeliveryLogSchema),
@@ -260,7 +260,7 @@ export const integrationContract = {
   retryDelivery: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(z.object({ logId: z.string() }))
     .output(z.object({ success: z.boolean(), message: z.string().optional() })),
@@ -269,7 +269,7 @@ export const integrationContract = {
   getDeliveryStats: _base
     .meta({
       userType: "authenticated",
-      permissions: [permissions.integrationManage.id],
+      access: [integrationAccess.manage],
     })
     .input(
       z.object({

package/src/permissions.ts

@@ -1,12 +0,0 @@
-import { createPermission } from "@checkstack/common";
-
-export const permissions = {
-  /** Manage webhook integrations and view delivery logs */
-  integrationManage: createPermission(
-    "integration",
-    "manage",
-    "Manage webhook integrations and view delivery logs"
-  ),
-};
-
-export const permissionList = Object.values(permissions);