@terreno/api 57.0.0 → 57.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/.ai/skills/mongoose-schema-safety/SKILL.md +8 -0
- package/dist/actions.d.ts +7 -2
- package/dist/actions.js +60 -25
- package/dist/adminModelRouter.d.ts +14 -0
- package/dist/adminModelRouter.js +199 -0
- package/dist/adminTypes.d.ts +182 -0
- package/dist/adminTypes.js +5 -0
- package/dist/api.d.ts +44 -3
- package/dist/api.js +74 -26
- package/dist/auth.d.ts +18 -1
- package/dist/auth.js +122 -20
- package/dist/consentApp.d.ts +2 -0
- package/dist/consentApp.js +98 -0
- package/dist/index.d.ts +22 -1
- package/dist/index.js +51 -7
- package/dist/mcp/auth.d.ts +11 -0
- package/dist/mcp/auth.js +133 -0
- package/dist/mcp/createMCPRequest.d.ts +16 -0
- package/dist/mcp/createMCPRequest.js +26 -0
- package/dist/mcp/handlers.d.ts +8 -0
- package/dist/mcp/handlers.js +793 -0
- package/dist/mcp/query.d.ts +32 -0
- package/dist/mcp/query.js +232 -0
- package/dist/mcp/registry.d.ts +21 -0
- package/dist/mcp/registry.js +54 -0
- package/dist/mcp/schemaGenerator.d.ts +14 -0
- package/dist/mcp/schemaGenerator.js +379 -0
- package/dist/mcp/server.d.ts +8 -0
- package/dist/mcp/server.js +133 -0
- package/dist/mcp/toolGenerator.d.ts +14 -0
- package/dist/mcp/toolGenerator.js +246 -0
- package/dist/mcp/types.d.ts +85 -0
- package/dist/mcp/types.js +2 -0
- package/dist/openApi.d.ts +1 -1
- package/dist/openApi.js +26 -8
- package/dist/permissions.js +15 -15
- package/dist/rbac/access.d.ts +3 -0
- package/dist/rbac/access.js +294 -0
- package/dist/rbac/auditModel.d.ts +31 -0
- package/dist/rbac/auditModel.js +112 -0
- package/dist/rbac/backfillAdmins.d.ts +18 -0
- package/dist/rbac/backfillAdmins.js +139 -0
- package/dist/rbac/fieldViews.d.ts +3 -0
- package/dist/rbac/fieldViews.js +201 -0
- package/dist/rbac/middleware.d.ts +21 -0
- package/dist/rbac/middleware.js +108 -0
- package/dist/rbac/modelRouterAccess.d.ts +42 -0
- package/dist/rbac/modelRouterAccess.js +388 -0
- package/dist/rbac/permissionUtils.d.ts +8 -0
- package/dist/rbac/permissionUtils.js +209 -0
- package/dist/rbac/realtimeAccess.d.ts +18 -0
- package/dist/rbac/realtimeAccess.js +173 -0
- package/dist/rbac/resolve.d.ts +28 -0
- package/dist/rbac/resolve.js +387 -0
- package/dist/rbac/roleManager.d.ts +20 -0
- package/dist/rbac/roleManager.js +741 -0
- package/dist/rbac/roleModel.d.ts +42 -0
- package/dist/rbac/roleModel.js +267 -0
- package/dist/rbac/routes.d.ts +9 -0
- package/dist/rbac/routes.js +211 -0
- package/dist/rbac/scopes.d.ts +15 -0
- package/dist/rbac/scopes.js +155 -0
- package/dist/rbac/statements.d.ts +30 -0
- package/dist/rbac/statements.js +126 -0
- package/dist/rbac/types.d.ts +202 -0
- package/dist/rbac/types.js +2 -0
- package/dist/rbac/userPlugin.d.ts +12 -0
- package/dist/rbac/userPlugin.js +41 -0
- package/dist/realtime/changeStreamWatcher.d.ts +1 -1
- package/dist/realtime/changeStreamWatcher.js +48 -39
- package/dist/realtime/realtimeApp.js +4 -8
- package/dist/realtime/registry.d.ts +5 -0
- package/dist/realtime/registry.js +13 -1
- package/dist/scrubAdminFields.d.ts +17 -0
- package/dist/scrubAdminFields.js +192 -0
- package/dist/sync/executors.d.ts +1 -1
- package/dist/sync/executors.js +63 -40
- package/dist/sync/loadHarness.js +4 -5
- package/dist/sync/registry.d.ts +5 -0
- package/dist/sync/registry.js +13 -1
- package/dist/sync/routes.js +41 -36
- package/dist/sync/serialize.js +5 -6
- package/dist/terrenoApp.d.ts +18 -0
- package/dist/terrenoApp.js +46 -3
- package/dist/terrenoPlugin.d.ts +8 -1
- package/dist/tests/createTestData.js +8 -0
- package/dist/tests/models.d.ts +1 -0
- package/dist/tests/models.js +5 -0
- package/dist/tests/testHelper.js +1 -2
- package/dist/transformers.js +16 -1
- package/package.json +17 -13
- package/src/__snapshots__/openApi.test.ts.snap +192 -0
- package/src/actions.test.ts +194 -1
- package/src/actions.ts +65 -8
- package/src/adminModelRouter.ts +154 -0
- package/src/adminTypes.ts +206 -0
- package/src/api.test.ts +66 -1
- package/src/api.ts +131 -12
- package/src/auth.test.ts +135 -1
- package/src/auth.ts +81 -3
- package/src/consentApp.test.ts +24 -0
- package/src/consentApp.ts +100 -0
- package/src/index.ts +56 -0
- package/src/mcp/auth.test.ts +197 -0
- package/src/mcp/auth.ts +100 -0
- package/src/mcp/createMCPRequest.test.ts +47 -0
- package/src/mcp/createMCPRequest.ts +32 -0
- package/src/mcp/customTools.test.ts +54 -0
- package/src/mcp/handlers.ts +639 -0
- package/src/mcp/integration.test.ts +1493 -0
- package/src/mcp/query.test.ts +172 -0
- package/src/mcp/query.ts +179 -0
- package/src/mcp/registry.ts +70 -0
- package/src/mcp/schemaGenerator.test.ts +182 -0
- package/src/mcp/schemaGenerator.ts +354 -0
- package/src/mcp/server.test.ts +226 -0
- package/src/mcp/server.ts +86 -0
- package/src/mcp/toolGenerator.test.ts +284 -0
- package/src/mcp/toolGenerator.ts +199 -0
- package/src/mcp/types.ts +95 -0
- package/src/openApi.test.ts +107 -0
- package/src/openApi.ts +32 -1
- package/src/permissions.ts +3 -2
- package/src/rbac/access.test.ts +357 -0
- package/src/rbac/access.ts +201 -0
- package/src/rbac/auditModel.ts +103 -0
- package/src/rbac/backfillAdmins.ts +54 -0
- package/src/rbac/fieldViews.test.ts +39 -0
- package/src/rbac/fieldViews.ts +122 -0
- package/src/rbac/middleware.ts +55 -0
- package/src/rbac/modelRouterAccess.test.ts +336 -0
- package/src/rbac/modelRouterAccess.ts +331 -0
- package/src/rbac/permissionUtils.test.ts +112 -0
- package/src/rbac/permissionUtils.ts +83 -0
- package/src/rbac/realtimeAccess.test.ts +242 -0
- package/src/rbac/realtimeAccess.ts +138 -0
- package/src/rbac/resolve.test.ts +358 -0
- package/src/rbac/resolve.ts +285 -0
- package/src/rbac/roleManager.test.ts +915 -0
- package/src/rbac/roleManager.ts +440 -0
- package/src/rbac/roleModel.test.ts +114 -0
- package/src/rbac/roleModel.ts +196 -0
- package/src/rbac/routes.ts +170 -0
- package/src/rbac/scopes.test.ts +105 -0
- package/src/rbac/scopes.ts +81 -0
- package/src/rbac/statements.test.ts +67 -0
- package/src/rbac/statements.ts +73 -0
- package/src/rbac/types.ts +198 -0
- package/src/rbac/userPlugin.test.ts +55 -0
- package/src/rbac/userPlugin.ts +25 -0
- package/src/realtime/changeStreamWatcher.ts +20 -15
- package/src/realtime/realtime.test.ts +25 -1
- package/src/realtime/realtimeApp.ts +2 -5
- package/src/realtime/registry.ts +15 -0
- package/src/scrubAdminFields.test.ts +113 -0
- package/src/scrubAdminFields.ts +158 -0
- package/src/sync/executors.ts +31 -1
- package/src/sync/loadHarness.ts +8 -7
- package/src/sync/models.test.ts +262 -0
- package/src/sync/registry.ts +15 -0
- package/src/sync/routes.ts +25 -11
- package/src/sync/scripts/compactTombstones.test.ts +4 -6
- package/src/sync/serialize.ts +17 -9
- package/src/sync/sync.test.ts +52 -0
- package/src/sync/syncRoutes.test.ts +5 -2
- package/src/sync/syncSocket.test.ts +28 -0
- package/src/terrenoApp.test.ts +100 -0
- package/src/terrenoApp.ts +65 -3
- package/src/terrenoPlugin.ts +10 -1
- package/src/tests/bunSetup.ts +2 -0
- package/src/tests/createTestData.ts +5 -1
- package/src/tests/models.ts +6 -0
- package/src/tests/testHelper.ts +1 -3
- package/src/transformers.test.ts +12 -0
- package/src/transformers.ts +7 -1
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type { Document } from "mongoose";
|
|
2
|
+
import mongoose, { type Connection, type Model } from "mongoose";
|
|
3
|
+
import type { APIErrorConstructor } from "../errors";
|
|
4
|
+
import { type PermissionSet, type RolePermissionSpec, type Statements } from "./statements";
|
|
5
|
+
export interface RoleDefinition {
|
|
6
|
+
name: string;
|
|
7
|
+
displayName: string;
|
|
8
|
+
description?: string;
|
|
9
|
+
permissions: RolePermissionSpec;
|
|
10
|
+
excludesRoles?: string[];
|
|
11
|
+
isLocked?: boolean;
|
|
12
|
+
isSealed?: boolean;
|
|
13
|
+
}
|
|
14
|
+
export interface RbacRoleDocument {
|
|
15
|
+
_id: mongoose.Types.ObjectId;
|
|
16
|
+
name: string;
|
|
17
|
+
displayName: string;
|
|
18
|
+
description?: string;
|
|
19
|
+
permissions: PermissionSet;
|
|
20
|
+
excludesRoles: string[];
|
|
21
|
+
isLocked: boolean;
|
|
22
|
+
isSealed: boolean;
|
|
23
|
+
created: Date;
|
|
24
|
+
updated: Date;
|
|
25
|
+
}
|
|
26
|
+
export type RbacRoleModel = Model<RbacRoleDocument> & {
|
|
27
|
+
findExactlyOne: (query: Record<string, unknown>, errorArgs?: Partial<APIErrorConstructor>) => Promise<Document & RbacRoleDocument>;
|
|
28
|
+
findOneOrNone: (query: Record<string, unknown>, errorArgs?: Partial<APIErrorConstructor>) => Promise<(Document & RbacRoleDocument) | null>;
|
|
29
|
+
seedDefaults: (args: {
|
|
30
|
+
statements: Statements;
|
|
31
|
+
extraRoles?: RoleDefinition[];
|
|
32
|
+
}) => Promise<void>;
|
|
33
|
+
};
|
|
34
|
+
export { READ_ONLY_ROLE_PERMISSIONS } from "./statements";
|
|
35
|
+
/**
|
|
36
|
+
* Insert missing default roles. Existing unsealed roles are left unchanged so admin
|
|
37
|
+
* customizations survive process restarts. Sealed roles are refreshed from code.
|
|
38
|
+
*/
|
|
39
|
+
export declare const upsertSeededRole: (model: RbacRoleModel, role: RoleDefinition, statements: Statements) => Promise<void>;
|
|
40
|
+
export declare const expandRolePermissions: (spec: RolePermissionSpec, statements: Statements, readActions?: readonly string[]) => PermissionSet;
|
|
41
|
+
export declare const terrenoDefaultRoles: RoleDefinition[];
|
|
42
|
+
export declare const createRbacRoleModel: (connection: Connection) => RbacRoleModel;
|
|
@@ -0,0 +1,267 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __assign = (this && this.__assign) || function () {
|
|
3
|
+
__assign = Object.assign || function(t) {
|
|
4
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
5
|
+
s = arguments[i];
|
|
6
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
7
|
+
t[p] = s[p];
|
|
8
|
+
}
|
|
9
|
+
return t;
|
|
10
|
+
};
|
|
11
|
+
return __assign.apply(this, arguments);
|
|
12
|
+
};
|
|
13
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
14
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
15
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
16
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
17
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
18
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
19
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
20
|
+
});
|
|
21
|
+
};
|
|
22
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
23
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
|
|
24
|
+
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
25
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
26
|
+
function step(op) {
|
|
27
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
28
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
29
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
30
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
31
|
+
switch (op[0]) {
|
|
32
|
+
case 0: case 1: t = op; break;
|
|
33
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
34
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
35
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
36
|
+
default:
|
|
37
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
38
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
39
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
40
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
41
|
+
if (t[2]) _.ops.pop();
|
|
42
|
+
_.trys.pop(); continue;
|
|
43
|
+
}
|
|
44
|
+
op = body.call(thisArg, _);
|
|
45
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
46
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
47
|
+
}
|
|
48
|
+
};
|
|
49
|
+
var __values = (this && this.__values) || function(o) {
|
|
50
|
+
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
|
|
51
|
+
if (m) return m.call(o);
|
|
52
|
+
if (o && typeof o.length === "number") return {
|
|
53
|
+
next: function () {
|
|
54
|
+
if (o && i >= o.length) o = void 0;
|
|
55
|
+
return { value: o && o[i++], done: !o };
|
|
56
|
+
}
|
|
57
|
+
};
|
|
58
|
+
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
|
|
59
|
+
};
|
|
60
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
61
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
62
|
+
};
|
|
63
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
64
|
+
exports.createRbacRoleModel = exports.terrenoDefaultRoles = exports.expandRolePermissions = exports.upsertSeededRole = exports.READ_ONLY_ROLE_PERMISSIONS = void 0;
|
|
65
|
+
var mongoose_1 = __importDefault(require("mongoose"));
|
|
66
|
+
var plugins_1 = require("../plugins");
|
|
67
|
+
var statements_1 = require("./statements");
|
|
68
|
+
var statements_2 = require("./statements");
|
|
69
|
+
Object.defineProperty(exports, "READ_ONLY_ROLE_PERMISSIONS", { enumerable: true, get: function () { return statements_2.READ_ONLY_ROLE_PERMISSIONS; } });
|
|
70
|
+
/**
|
|
71
|
+
* Insert missing default roles. Existing unsealed roles are left unchanged so admin
|
|
72
|
+
* customizations survive process restarts. Sealed roles are refreshed from code.
|
|
73
|
+
*/
|
|
74
|
+
var upsertSeededRole = function (model, role, statements) { return __awaiter(void 0, void 0, void 0, function () {
|
|
75
|
+
var permissions, existing;
|
|
76
|
+
var _a, _b, _c, _d, _e;
|
|
77
|
+
return __generator(this, function (_f) {
|
|
78
|
+
switch (_f.label) {
|
|
79
|
+
case 0:
|
|
80
|
+
permissions = (0, exports.expandRolePermissions)(role.permissions, statements);
|
|
81
|
+
return [4 /*yield*/, model.findOneOrNone({ name: role.name })];
|
|
82
|
+
case 1:
|
|
83
|
+
existing = _f.sent();
|
|
84
|
+
if (!existing) return [3 /*break*/, 3];
|
|
85
|
+
if (!existing.isSealed) {
|
|
86
|
+
return [2 /*return*/];
|
|
87
|
+
}
|
|
88
|
+
existing.description = role.description;
|
|
89
|
+
existing.displayName = role.displayName;
|
|
90
|
+
existing.excludesRoles = (_a = role.excludesRoles) !== null && _a !== void 0 ? _a : [];
|
|
91
|
+
existing.isLocked = (_b = role.isLocked) !== null && _b !== void 0 ? _b : false;
|
|
92
|
+
existing.isSealed = true;
|
|
93
|
+
existing.permissions = permissions;
|
|
94
|
+
return [4 /*yield*/, existing.save()];
|
|
95
|
+
case 2:
|
|
96
|
+
_f.sent();
|
|
97
|
+
return [2 /*return*/];
|
|
98
|
+
case 3: return [4 /*yield*/, model.create({
|
|
99
|
+
description: role.description,
|
|
100
|
+
displayName: role.displayName,
|
|
101
|
+
excludesRoles: (_c = role.excludesRoles) !== null && _c !== void 0 ? _c : [],
|
|
102
|
+
isLocked: (_d = role.isLocked) !== null && _d !== void 0 ? _d : false,
|
|
103
|
+
isSealed: (_e = role.isSealed) !== null && _e !== void 0 ? _e : false,
|
|
104
|
+
name: role.name,
|
|
105
|
+
permissions: permissions,
|
|
106
|
+
})];
|
|
107
|
+
case 4:
|
|
108
|
+
_f.sent();
|
|
109
|
+
return [2 /*return*/];
|
|
110
|
+
}
|
|
111
|
+
});
|
|
112
|
+
}); };
|
|
113
|
+
exports.upsertSeededRole = upsertSeededRole;
|
|
114
|
+
var expandRolePermissions = function (spec, statements, readActions) {
|
|
115
|
+
if (readActions === void 0) { readActions = statements_1.READ_ACTIONS; }
|
|
116
|
+
return (0, statements_1.expandRolePermissions)(spec, statements, readActions);
|
|
117
|
+
};
|
|
118
|
+
exports.expandRolePermissions = expandRolePermissions;
|
|
119
|
+
exports.terrenoDefaultRoles = [
|
|
120
|
+
{
|
|
121
|
+
displayName: "Super Admin",
|
|
122
|
+
isLocked: true,
|
|
123
|
+
isSealed: true,
|
|
124
|
+
name: "superadmin",
|
|
125
|
+
permissions: "*",
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
displayName: "Admin",
|
|
129
|
+
isLocked: true,
|
|
130
|
+
name: "admin",
|
|
131
|
+
permissions: {
|
|
132
|
+
admin: ["access"],
|
|
133
|
+
configuration: ["read", "update"],
|
|
134
|
+
user: ["create", "list", "read", "update"],
|
|
135
|
+
},
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
displayName: "Auditor",
|
|
139
|
+
isLocked: true,
|
|
140
|
+
name: "auditor",
|
|
141
|
+
permissions: statements_1.READ_ONLY_ROLE_PERMISSIONS,
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
displayName: "Member",
|
|
145
|
+
isLocked: true,
|
|
146
|
+
name: "member",
|
|
147
|
+
permissions: {},
|
|
148
|
+
},
|
|
149
|
+
];
|
|
150
|
+
var rbacRoleSchema = new mongoose_1.default.Schema({
|
|
151
|
+
description: {
|
|
152
|
+
description: "Human-readable description of the role",
|
|
153
|
+
type: String,
|
|
154
|
+
},
|
|
155
|
+
displayName: {
|
|
156
|
+
description: "Human-readable name shown in the admin UI",
|
|
157
|
+
required: true,
|
|
158
|
+
trim: true,
|
|
159
|
+
type: String,
|
|
160
|
+
},
|
|
161
|
+
excludesRoles: {
|
|
162
|
+
default: [],
|
|
163
|
+
description: "Role names that cannot be held together with this role",
|
|
164
|
+
type: [String],
|
|
165
|
+
},
|
|
166
|
+
isLocked: {
|
|
167
|
+
default: false,
|
|
168
|
+
description: "Whether the role name is locked from deletion or renaming",
|
|
169
|
+
type: Boolean,
|
|
170
|
+
},
|
|
171
|
+
isSealed: {
|
|
172
|
+
default: false,
|
|
173
|
+
description: "Whether the role is immutable through the admin API",
|
|
174
|
+
type: Boolean,
|
|
175
|
+
},
|
|
176
|
+
name: {
|
|
177
|
+
description: "Stable machine name stored on users",
|
|
178
|
+
index: true,
|
|
179
|
+
required: true,
|
|
180
|
+
trim: true,
|
|
181
|
+
type: String,
|
|
182
|
+
unique: true,
|
|
183
|
+
},
|
|
184
|
+
permissions: {
|
|
185
|
+
description: "Permission JSON validated against access statements",
|
|
186
|
+
required: true,
|
|
187
|
+
type: mongoose_1.default.Schema.Types.Mixed,
|
|
188
|
+
},
|
|
189
|
+
}, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
|
|
190
|
+
rbacRoleSchema.plugin(plugins_1.createdUpdatedPlugin);
|
|
191
|
+
rbacRoleSchema.plugin(plugins_1.findOneOrNone);
|
|
192
|
+
rbacRoleSchema.plugin(plugins_1.findExactlyOne);
|
|
193
|
+
rbacRoleSchema.statics = __assign(__assign({}, rbacRoleSchema.statics), { seedDefaults: function (_a) {
|
|
194
|
+
return __awaiter(this, arguments, void 0, function (_b) {
|
|
195
|
+
var terrenoNames, terrenoDefaultRoles_1, terrenoDefaultRoles_1_1, role, e_1_1, _c, _d, role, e_2_1;
|
|
196
|
+
var e_1, _e, e_2, _f;
|
|
197
|
+
var statements = _b.statements, extraRoles = _b.extraRoles;
|
|
198
|
+
return __generator(this, function (_g) {
|
|
199
|
+
switch (_g.label) {
|
|
200
|
+
case 0:
|
|
201
|
+
terrenoNames = new Set(exports.terrenoDefaultRoles.map(function (role) { return role.name; }));
|
|
202
|
+
_g.label = 1;
|
|
203
|
+
case 1:
|
|
204
|
+
_g.trys.push([1, 6, 7, 8]);
|
|
205
|
+
terrenoDefaultRoles_1 = __values(exports.terrenoDefaultRoles), terrenoDefaultRoles_1_1 = terrenoDefaultRoles_1.next();
|
|
206
|
+
_g.label = 2;
|
|
207
|
+
case 2:
|
|
208
|
+
if (!!terrenoDefaultRoles_1_1.done) return [3 /*break*/, 5];
|
|
209
|
+
role = terrenoDefaultRoles_1_1.value;
|
|
210
|
+
return [4 /*yield*/, (0, exports.upsertSeededRole)(this, role, statements)];
|
|
211
|
+
case 3:
|
|
212
|
+
_g.sent();
|
|
213
|
+
_g.label = 4;
|
|
214
|
+
case 4:
|
|
215
|
+
terrenoDefaultRoles_1_1 = terrenoDefaultRoles_1.next();
|
|
216
|
+
return [3 /*break*/, 2];
|
|
217
|
+
case 5: return [3 /*break*/, 8];
|
|
218
|
+
case 6:
|
|
219
|
+
e_1_1 = _g.sent();
|
|
220
|
+
e_1 = { error: e_1_1 };
|
|
221
|
+
return [3 /*break*/, 8];
|
|
222
|
+
case 7:
|
|
223
|
+
try {
|
|
224
|
+
if (terrenoDefaultRoles_1_1 && !terrenoDefaultRoles_1_1.done && (_e = terrenoDefaultRoles_1.return)) _e.call(terrenoDefaultRoles_1);
|
|
225
|
+
}
|
|
226
|
+
finally { if (e_1) throw e_1.error; }
|
|
227
|
+
return [7 /*endfinally*/];
|
|
228
|
+
case 8:
|
|
229
|
+
_g.trys.push([8, 13, 14, 15]);
|
|
230
|
+
_c = __values(extraRoles !== null && extraRoles !== void 0 ? extraRoles : []), _d = _c.next();
|
|
231
|
+
_g.label = 9;
|
|
232
|
+
case 9:
|
|
233
|
+
if (!!_d.done) return [3 /*break*/, 12];
|
|
234
|
+
role = _d.value;
|
|
235
|
+
if (terrenoNames.has(role.name)) {
|
|
236
|
+
return [3 /*break*/, 11];
|
|
237
|
+
}
|
|
238
|
+
return [4 /*yield*/, (0, exports.upsertSeededRole)(this, role, statements)];
|
|
239
|
+
case 10:
|
|
240
|
+
_g.sent();
|
|
241
|
+
_g.label = 11;
|
|
242
|
+
case 11:
|
|
243
|
+
_d = _c.next();
|
|
244
|
+
return [3 /*break*/, 9];
|
|
245
|
+
case 12: return [3 /*break*/, 15];
|
|
246
|
+
case 13:
|
|
247
|
+
e_2_1 = _g.sent();
|
|
248
|
+
e_2 = { error: e_2_1 };
|
|
249
|
+
return [3 /*break*/, 15];
|
|
250
|
+
case 14:
|
|
251
|
+
try {
|
|
252
|
+
if (_d && !_d.done && (_f = _c.return)) _f.call(_c);
|
|
253
|
+
}
|
|
254
|
+
finally { if (e_2) throw e_2.error; }
|
|
255
|
+
return [7 /*endfinally*/];
|
|
256
|
+
case 15: return [2 /*return*/];
|
|
257
|
+
}
|
|
258
|
+
});
|
|
259
|
+
});
|
|
260
|
+
} });
|
|
261
|
+
var createRbacRoleModel = function (connection) {
|
|
262
|
+
if (connection.models.RbacRole) {
|
|
263
|
+
return connection.models.RbacRole;
|
|
264
|
+
}
|
|
265
|
+
return connection.model("RbacRole", rbacRoleSchema);
|
|
266
|
+
};
|
|
267
|
+
exports.createRbacRoleModel = createRbacRoleModel;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { type UserModel } from "../auth";
|
|
2
|
+
import type { TerrenoPlugin } from "../terrenoPlugin";
|
|
3
|
+
import type { AnyTerrenoAccess } from "./types";
|
|
4
|
+
export interface RbacRouterOptions {
|
|
5
|
+
access: AnyTerrenoAccess;
|
|
6
|
+
userModel: UserModel;
|
|
7
|
+
basePath?: string;
|
|
8
|
+
}
|
|
9
|
+
export declare const rbacRouter: ({ access, userModel, basePath, }: RbacRouterOptions) => TerrenoPlugin;
|
|
@@ -0,0 +1,211 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
12
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
|
|
13
|
+
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
14
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
15
|
+
function step(op) {
|
|
16
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
17
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
18
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
19
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
20
|
+
switch (op[0]) {
|
|
21
|
+
case 0: case 1: t = op; break;
|
|
22
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
23
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
24
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
25
|
+
default:
|
|
26
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
27
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
28
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
29
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
30
|
+
if (t[2]) _.ops.pop();
|
|
31
|
+
_.trys.pop(); continue;
|
|
32
|
+
}
|
|
33
|
+
op = body.call(thisArg, _);
|
|
34
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
35
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
36
|
+
}
|
|
37
|
+
};
|
|
38
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
39
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
40
|
+
};
|
|
41
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
42
|
+
exports.rbacRouter = void 0;
|
|
43
|
+
var express_1 = __importDefault(require("express"));
|
|
44
|
+
var api_1 = require("../api");
|
|
45
|
+
var auth_1 = require("../auth");
|
|
46
|
+
var errors_1 = require("../errors");
|
|
47
|
+
var rbacRouter = function (_a) {
|
|
48
|
+
var access = _a.access, userModel = _a.userModel, _b = _a.basePath, basePath = _b === void 0 ? "/rbac" : _b;
|
|
49
|
+
return {
|
|
50
|
+
register: function (app) {
|
|
51
|
+
var router = express_1.default.Router();
|
|
52
|
+
router.get("/statements", (0, auth_1.authenticateMiddleware)(), access.middleware({ rbac: ["read"] }), (0, api_1.asyncHandler)(function (_req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
53
|
+
return __generator(this, function (_a) {
|
|
54
|
+
return [2 /*return*/, res.json({
|
|
55
|
+
data: {
|
|
56
|
+
statements: access.statements,
|
|
57
|
+
},
|
|
58
|
+
})];
|
|
59
|
+
});
|
|
60
|
+
}); }));
|
|
61
|
+
router.get("/roles", (0, auth_1.authenticateMiddleware)(), access.middleware({ rbac: ["read"] }), (0, api_1.asyncHandler)(function (_req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
62
|
+
var roles;
|
|
63
|
+
return __generator(this, function (_a) {
|
|
64
|
+
switch (_a.label) {
|
|
65
|
+
case 0: return [4 /*yield*/, access.roles.list()];
|
|
66
|
+
case 1:
|
|
67
|
+
roles = _a.sent();
|
|
68
|
+
return [2 /*return*/, res.json({ data: roles })];
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
}); }));
|
|
72
|
+
router.post("/roles", (0, auth_1.authenticateMiddleware)(), access.middleware({ rbac: ["manageRoles"] }), (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
73
|
+
var actor, role;
|
|
74
|
+
return __generator(this, function (_a) {
|
|
75
|
+
switch (_a.label) {
|
|
76
|
+
case 0:
|
|
77
|
+
actor = req.user;
|
|
78
|
+
if (!actor) {
|
|
79
|
+
throw new errors_1.APIError({ status: 401, title: "Unauthorized" });
|
|
80
|
+
}
|
|
81
|
+
return [4 /*yield*/, access.roles.create({ actor: actor, role: req.body })];
|
|
82
|
+
case 1:
|
|
83
|
+
role = _a.sent();
|
|
84
|
+
return [2 /*return*/, res.status(201).json({ data: role })];
|
|
85
|
+
}
|
|
86
|
+
});
|
|
87
|
+
}); }));
|
|
88
|
+
router.patch("/roles/:name", (0, auth_1.authenticateMiddleware)(), access.middleware({ rbac: ["manageRoles"] }), (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
89
|
+
var actor, role;
|
|
90
|
+
return __generator(this, function (_a) {
|
|
91
|
+
switch (_a.label) {
|
|
92
|
+
case 0:
|
|
93
|
+
actor = req.user;
|
|
94
|
+
if (!actor) {
|
|
95
|
+
throw new errors_1.APIError({ status: 401, title: "Unauthorized" });
|
|
96
|
+
}
|
|
97
|
+
return [4 /*yield*/, access.roles.update({
|
|
98
|
+
actor: actor,
|
|
99
|
+
changes: req.body,
|
|
100
|
+
roleName: req.params.name,
|
|
101
|
+
})];
|
|
102
|
+
case 1:
|
|
103
|
+
role = _a.sent();
|
|
104
|
+
return [2 /*return*/, res.json({ data: role })];
|
|
105
|
+
}
|
|
106
|
+
});
|
|
107
|
+
}); }));
|
|
108
|
+
router.delete("/roles/:name", (0, auth_1.authenticateMiddleware)(), access.middleware({ rbac: ["manageRoles"] }), (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
109
|
+
var actor;
|
|
110
|
+
return __generator(this, function (_a) {
|
|
111
|
+
switch (_a.label) {
|
|
112
|
+
case 0:
|
|
113
|
+
actor = req.user;
|
|
114
|
+
if (!actor) {
|
|
115
|
+
throw new errors_1.APIError({ status: 401, title: "Unauthorized" });
|
|
116
|
+
}
|
|
117
|
+
return [4 /*yield*/, access.roles.remove({ actor: actor, roleName: req.params.name })];
|
|
118
|
+
case 1:
|
|
119
|
+
_a.sent();
|
|
120
|
+
return [2 /*return*/, res.status(204).send()];
|
|
121
|
+
}
|
|
122
|
+
});
|
|
123
|
+
}); }));
|
|
124
|
+
router.post("/roles/:name/preview", (0, auth_1.authenticateMiddleware)(), access.middleware({ rbac: ["manageRoles"] }), (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
125
|
+
var diff;
|
|
126
|
+
return __generator(this, function (_a) {
|
|
127
|
+
switch (_a.label) {
|
|
128
|
+
case 0: return [4 /*yield*/, access.roles.previewRoleChange({
|
|
129
|
+
permissions: req.body.permissions,
|
|
130
|
+
roleName: req.params.name,
|
|
131
|
+
})];
|
|
132
|
+
case 1:
|
|
133
|
+
diff = _a.sent();
|
|
134
|
+
return [2 /*return*/, res.json({ data: diff })];
|
|
135
|
+
}
|
|
136
|
+
});
|
|
137
|
+
}); }));
|
|
138
|
+
router.get("/users/:id/permissions", (0, auth_1.authenticateMiddleware)(), access.middleware({ rbac: ["read"] }), (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
139
|
+
var user, permissions, withRoles;
|
|
140
|
+
var _a;
|
|
141
|
+
return __generator(this, function (_b) {
|
|
142
|
+
switch (_b.label) {
|
|
143
|
+
case 0: return [4 /*yield*/, userModel.findById(req.params.id)];
|
|
144
|
+
case 1:
|
|
145
|
+
user = _b.sent();
|
|
146
|
+
if (!user) {
|
|
147
|
+
throw new errors_1.APIError({ status: 404, title: "User not found" });
|
|
148
|
+
}
|
|
149
|
+
return [4 /*yield*/, access.getPermissions({
|
|
150
|
+
user: user,
|
|
151
|
+
})];
|
|
152
|
+
case 2:
|
|
153
|
+
permissions = _b.sent();
|
|
154
|
+
withRoles = user;
|
|
155
|
+
return [2 /*return*/, res.json({
|
|
156
|
+
data: {
|
|
157
|
+
permissions: permissions,
|
|
158
|
+
roles: (_a = withRoles.roles) !== null && _a !== void 0 ? _a : [],
|
|
159
|
+
},
|
|
160
|
+
})];
|
|
161
|
+
}
|
|
162
|
+
});
|
|
163
|
+
}); }));
|
|
164
|
+
router.put("/users/:id/roles", (0, auth_1.authenticateMiddleware)(), access.middleware({ rbac: ["assignRoles"] }), (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
165
|
+
var actor;
|
|
166
|
+
return __generator(this, function (_a) {
|
|
167
|
+
switch (_a.label) {
|
|
168
|
+
case 0:
|
|
169
|
+
actor = req.user;
|
|
170
|
+
if (!actor) {
|
|
171
|
+
throw new errors_1.APIError({ status: 401, title: "Unauthorized" });
|
|
172
|
+
}
|
|
173
|
+
if (!Array.isArray(req.body.roleNames)) {
|
|
174
|
+
throw new errors_1.APIError({ status: 400, title: "roleNames is required" });
|
|
175
|
+
}
|
|
176
|
+
return [4 /*yield*/, access.roles.assign({
|
|
177
|
+
actor: actor,
|
|
178
|
+
roleNames: req.body.roleNames,
|
|
179
|
+
userId: req.params.id,
|
|
180
|
+
})];
|
|
181
|
+
case 1:
|
|
182
|
+
_a.sent();
|
|
183
|
+
return [2 /*return*/, res.json({ data: { success: true } })];
|
|
184
|
+
}
|
|
185
|
+
});
|
|
186
|
+
}); }));
|
|
187
|
+
router.post("/users/:id/roles/preview", (0, auth_1.authenticateMiddleware)(), access.middleware({ rbac: ["assignRoles"] }), (0, api_1.asyncHandler)(function (req, res) { return __awaiter(void 0, void 0, void 0, function () {
|
|
188
|
+
var actor, diff;
|
|
189
|
+
return __generator(this, function (_a) {
|
|
190
|
+
switch (_a.label) {
|
|
191
|
+
case 0:
|
|
192
|
+
if (!Array.isArray(req.body.roleNames)) {
|
|
193
|
+
throw new errors_1.APIError({ status: 400, title: "roleNames is required" });
|
|
194
|
+
}
|
|
195
|
+
actor = req.user;
|
|
196
|
+
return [4 /*yield*/, access.roles.previewAssignment({
|
|
197
|
+
actor: actor,
|
|
198
|
+
roleNames: req.body.roleNames,
|
|
199
|
+
userId: req.params.id,
|
|
200
|
+
})];
|
|
201
|
+
case 1:
|
|
202
|
+
diff = _a.sent();
|
|
203
|
+
return [2 /*return*/, res.json({ data: diff })];
|
|
204
|
+
}
|
|
205
|
+
});
|
|
206
|
+
}); }));
|
|
207
|
+
app.use(basePath, router);
|
|
208
|
+
},
|
|
209
|
+
};
|
|
210
|
+
};
|
|
211
|
+
exports.rbacRouter = rbacRouter;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { User } from "../auth";
|
|
2
|
+
import type { ResourceScope, ScopeArgs } from "./types";
|
|
3
|
+
export interface ScopeDefinition<TDoc> {
|
|
4
|
+
matches: (args: ScopeArgs<TDoc>) => Promise<Record<string, unknown> | null> | Record<string, unknown> | null;
|
|
5
|
+
adminBypass?: (args: ScopeArgs<TDoc>) => boolean | Promise<boolean>;
|
|
6
|
+
fieldOf?: (doc: TDoc, path: string) => unknown;
|
|
7
|
+
}
|
|
8
|
+
export declare const defineScope: <TDoc>(def: ScopeDefinition<TDoc>) => ResourceScope<TDoc>;
|
|
9
|
+
export interface OwnerScopeOptions {
|
|
10
|
+
field?: string;
|
|
11
|
+
adminBypass?: (args: {
|
|
12
|
+
user?: User;
|
|
13
|
+
}) => boolean | Promise<boolean>;
|
|
14
|
+
}
|
|
15
|
+
export declare const OwnerScope: (options?: string | OwnerScopeOptions) => ResourceScope;
|