@checkstack/maintenance-backend 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +84 -0
- package/package.json +1 -1
- package/src/index.ts +6 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,89 @@
|
|
|
1
1
|
# @checkstack/maintenance-backend
|
|
2
2
|
|
|
3
|
+
## 0.2.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 9faec1f: # Unified AccessRule Terminology Refactoring
|
|
8
|
+
|
|
9
|
+
This release completes a comprehensive terminology refactoring from "permission" to "accessRule" across the entire codebase, establishing a consistent and modern access control vocabulary.
|
|
10
|
+
|
|
11
|
+
## Changes
|
|
12
|
+
|
|
13
|
+
### Core Infrastructure (`@checkstack/common`)
|
|
14
|
+
|
|
15
|
+
- Introduced `AccessRule` interface as the primary access control type
|
|
16
|
+
- Added `accessPair()` helper for creating read/manage access rule pairs
|
|
17
|
+
- Added `access()` builder for individual access rules
|
|
18
|
+
- Replaced `Permission` type with `AccessRule` throughout
|
|
19
|
+
|
|
20
|
+
### API Changes
|
|
21
|
+
|
|
22
|
+
- `env.registerPermissions()` → `env.registerAccessRules()`
|
|
23
|
+
- `meta.permissions` → `meta.access` in RPC contracts
|
|
24
|
+
- `usePermission()` → `useAccess()` in frontend hooks
|
|
25
|
+
- Route `permission:` field → `accessRule:` field
|
|
26
|
+
|
|
27
|
+
### UI Changes
|
|
28
|
+
|
|
29
|
+
- "Roles & Permissions" tab → "Roles & Access Rules"
|
|
30
|
+
- "You don't have permission..." → "You don't have access..."
|
|
31
|
+
- All permission-related UI text updated
|
|
32
|
+
|
|
33
|
+
### Documentation & Templates
|
|
34
|
+
|
|
35
|
+
- Updated 18 documentation files with AccessRule terminology
|
|
36
|
+
- Updated 7 scaffolding templates with `accessPair()` pattern
|
|
37
|
+
- All code examples use new AccessRule API
|
|
38
|
+
|
|
39
|
+
## Migration Guide
|
|
40
|
+
|
|
41
|
+
### Backend Plugins
|
|
42
|
+
|
|
43
|
+
```diff
|
|
44
|
+
- import { permissionList } from "./permissions";
|
|
45
|
+
- env.registerPermissions(permissionList);
|
|
46
|
+
+ import { accessRules } from "./access";
|
|
47
|
+
+ env.registerAccessRules(accessRules);
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### RPC Contracts
|
|
51
|
+
|
|
52
|
+
```diff
|
|
53
|
+
- .meta({ userType: "user", permissions: [permissions.read.id] })
|
|
54
|
+
+ .meta({ userType: "user", access: [access.read] })
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Frontend Hooks
|
|
58
|
+
|
|
59
|
+
```diff
|
|
60
|
+
- const canRead = accessApi.usePermission(permissions.read.id);
|
|
61
|
+
+ const canRead = accessApi.useAccess(access.read);
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Routes
|
|
65
|
+
|
|
66
|
+
```diff
|
|
67
|
+
- permission: permissions.entityRead.id,
|
|
68
|
+
+ accessRule: access.read,
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Patch Changes
|
|
72
|
+
|
|
73
|
+
- Updated dependencies [9faec1f]
|
|
74
|
+
- Updated dependencies [827b286]
|
|
75
|
+
- Updated dependencies [f533141]
|
|
76
|
+
- Updated dependencies [aa4a8ab]
|
|
77
|
+
- @checkstack/backend-api@0.3.0
|
|
78
|
+
- @checkstack/catalog-common@1.1.0
|
|
79
|
+
- @checkstack/command-backend@0.1.0
|
|
80
|
+
- @checkstack/common@0.2.0
|
|
81
|
+
- @checkstack/integration-backend@0.1.0
|
|
82
|
+
- @checkstack/integration-common@0.1.0
|
|
83
|
+
- @checkstack/maintenance-common@0.2.0
|
|
84
|
+
- @checkstack/notification-common@0.1.0
|
|
85
|
+
- @checkstack/signal-common@0.1.0
|
|
86
|
+
|
|
3
87
|
## 0.1.0
|
|
4
88
|
|
|
5
89
|
### Minor Changes
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -2,16 +2,13 @@ import * as schema from "./schema";
|
|
|
2
2
|
import type { NodePgDatabase } from "drizzle-orm/node-postgres";
|
|
3
3
|
import { z } from "zod";
|
|
4
4
|
import {
|
|
5
|
-
|
|
5
|
+
maintenanceAccessRules,
|
|
6
|
+
maintenanceAccess,
|
|
6
7
|
pluginMetadata,
|
|
7
8
|
maintenanceContract,
|
|
8
9
|
maintenanceRoutes,
|
|
9
|
-
permissions,
|
|
10
10
|
} from "@checkstack/maintenance-common";
|
|
11
|
-
import {
|
|
12
|
-
createBackendPlugin,
|
|
13
|
-
coreServices,
|
|
14
|
-
} from "@checkstack/backend-api";
|
|
11
|
+
import { createBackendPlugin, coreServices } from "@checkstack/backend-api";
|
|
15
12
|
import { integrationEventExtensionPoint } from "@checkstack/integration-backend";
|
|
16
13
|
import { MaintenanceService } from "./service";
|
|
17
14
|
import { createRouter } from "./router";
|
|
@@ -52,7 +49,7 @@ const maintenanceUpdatedPayloadSchema = z.object({
|
|
|
52
49
|
export default createBackendPlugin({
|
|
53
50
|
metadata: pluginMetadata,
|
|
54
51
|
register(env) {
|
|
55
|
-
env.
|
|
52
|
+
env.registerAccessRules(maintenanceAccessRules);
|
|
56
53
|
|
|
57
54
|
// Register hooks as integration events
|
|
58
55
|
const integrationEvents = env.getExtensionPoint(
|
|
@@ -117,7 +114,7 @@ export default createBackendPlugin({
|
|
|
117
114
|
route:
|
|
118
115
|
resolveRoute(maintenanceRoutes.routes.config) +
|
|
119
116
|
"?action=create",
|
|
120
|
-
|
|
117
|
+
requiredAccessRules: [maintenanceAccess.maintenance.manage],
|
|
121
118
|
},
|
|
122
119
|
{
|
|
123
120
|
id: "manage",
|
|
@@ -126,7 +123,7 @@ export default createBackendPlugin({
|
|
|
126
123
|
iconName: "Wrench",
|
|
127
124
|
shortcuts: ["meta+shift+m", "ctrl+shift+m"],
|
|
128
125
|
route: resolveRoute(maintenanceRoutes.routes.config),
|
|
129
|
-
|
|
126
|
+
requiredAccessRules: [maintenanceAccess.maintenance.manage],
|
|
130
127
|
},
|
|
131
128
|
],
|
|
132
129
|
});
|