@checkstack/integration-jira-common 0.0.4 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,88 @@
 # @checkstack/integration-jira-common
 
+## 0.1.1
+
+### Patch Changes
+
+- Updated dependencies [7a23261]
+  - @checkstack/common@0.3.0
+  - @checkstack/integration-common@0.2.0
+
+## 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/integration-common@0.1.0
+
 ## 0.0.4
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/integration-jira-common",
-  "version": "0.0.4",
+  "version": "0.1.1",
   "type": "module",
   "main": "src/index.ts",
   "scripts": {
@@ -10,6 +10,7 @@
   },
   "dependencies": {
     "@checkstack/common": "workspace:*",
+    "@checkstack/integration-common": "workspace:*",
     "@orpc/contract": "^1.13.2",
     "zod": "^4.2.1"
   },

package/src/rpc-contract.ts

@@ -1,10 +1,7 @@
-import { oc } from "@orpc/contract";
 import { z } from "zod";
 import { pluginMetadata } from "./plugin-metadata";
-import {
-  createClientDefinition,
-  type ProcedureMetadata,
-} from "@checkstack/common";
+import { createClientDefinition, proc } from "@checkstack/common";
+import { integrationAccess } from "@checkstack/integration-common";
 import {
   JiraConnectionRedactedSchema,
   CreateJiraConnectionInputSchema,
@@ -14,9 +11,6 @@ import {
   JiraFieldSchema,
 } from "./schemas";
 
-// Base builder with full metadata support
-const _base = oc.$meta<ProcedureMetadata>({});
-
 /**
  * RPC contract for Jira-specific operations.
  * These endpoints are in addition to the generic integration endpoints.
@@ -27,55 +21,54 @@ export const jiraContract = {
   // ==========================================================================
 
   /** List all Jira connections (redacted - no API tokens) */
-  listConnections: _base
-    .meta({
-      userType: "user",
-      permissions: ["integration.manage"],
-    })
-    .output(z.array(JiraConnectionRedactedSchema)),
+  listConnections: proc({
+    operationType: "query",
+    userType: "user",
+    access: [integrationAccess.manage],
+  }).output(z.array(JiraConnectionRedactedSchema)),
 
   /** Get a single connection (redacted) */
-  getConnection: _base
-    .meta({
-      userType: "user",
-      permissions: ["integration.manage"],
-    })
+  getConnection: proc({
+    operationType: "query",
+    userType: "user",
+    access: [integrationAccess.manage],
+  })
     .input(z.object({ id: z.string() }))
     .output(JiraConnectionRedactedSchema),
 
   /** Create a new Jira connection */
-  createConnection: _base
-    .meta({
-      userType: "user",
-      permissions: ["integration.manage"],
-    })
+  createConnection: proc({
+    operationType: "mutation",
+    userType: "user",
+    access: [integrationAccess.manage],
+  })
     .input(CreateJiraConnectionInputSchema)
     .output(JiraConnectionRedactedSchema),
 
   /** Update a Jira connection */
-  updateConnection: _base
-    .meta({
-      userType: "user",
-      permissions: ["integration.manage"],
-    })
+  updateConnection: proc({
+    operationType: "mutation",
+    userType: "user",
+    access: [integrationAccess.manage],
+  })
     .input(UpdateJiraConnectionInputSchema)
     .output(JiraConnectionRedactedSchema),
 
   /** Delete a Jira connection */
-  deleteConnection: _base
-    .meta({
-      userType: "user",
-      permissions: ["integration.manage"],
-    })
+  deleteConnection: proc({
+    operationType: "mutation",
+    userType: "user",
+    access: [integrationAccess.manage],
+  })
     .input(z.object({ id: z.string() }))
     .output(z.object({ success: z.boolean() })),
 
   /** Test a Jira connection */
-  testConnection: _base
-    .meta({
-      userType: "user",
-      permissions: ["integration.manage"],
-    })
+  testConnection: proc({
+    operationType: "mutation",
+    userType: "user",
+    access: [integrationAccess.manage],
+  })
     .input(z.object({ id: z.string() }))
     .output(
       z.object({
@@ -89,20 +82,20 @@ export const jiraContract = {
   // ==========================================================================
 
   /** Get projects available in a Jira connection */
-  getProjects: _base
-    .meta({
-      userType: "user",
-      permissions: ["integration.manage"],
-    })
+  getProjects: proc({
+    operationType: "query",
+    userType: "user",
+    access: [integrationAccess.manage],
+  })
     .input(z.object({ connectionId: z.string() }))
     .output(z.array(JiraProjectSchema)),
 
   /** Get issue types available for a project */
-  getIssueTypes: _base
-    .meta({
-      userType: "user",
-      permissions: ["integration.manage"],
-    })
+  getIssueTypes: proc({
+    operationType: "query",
+    userType: "user",
+    access: [integrationAccess.manage],
+  })
     .input(
       z.object({
         connectionId: z.string(),
@@ -112,11 +105,11 @@ export const jiraContract = {
     .output(z.array(JiraIssueTypeSchema)),
 
   /** Get fields available for a project and issue type */
-  getFields: _base
-    .meta({
-      userType: "user",
-      permissions: ["integration.manage"],
-    })
+  getFields: proc({
+    operationType: "query",
+    userType: "user",
+    access: [integrationAccess.manage],
+  })
     .input(
       z.object({
         connectionId: z.string(),
@@ -127,11 +120,11 @@ export const jiraContract = {
     .output(z.array(JiraFieldSchema)),
 
   /** Get priorities available in Jira */
-  getPriorities: _base
-    .meta({
-      userType: "user",
-      permissions: ["integration.manage"],
-    })
+  getPriorities: proc({
+    operationType: "query",
+    userType: "user",
+    access: [integrationAccess.manage],
+  })
     .input(z.object({ connectionId: z.string() }))
     .output(
       z.array(