@terreno/api 57.0.0-beta.1 → 57.1.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 +156 -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 +20 -0
- package/dist/rbac/statements.js +115 -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 +16 -12
- 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 +183 -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 +65 -0
- package/src/rbac/statements.ts +62 -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,155 @@
|
|
|
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 __values = (this && this.__values) || function(o) {
|
|
39
|
+
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
|
|
40
|
+
if (m) return m.call(o);
|
|
41
|
+
if (o && typeof o.length === "number") return {
|
|
42
|
+
next: function () {
|
|
43
|
+
if (o && i >= o.length) o = void 0;
|
|
44
|
+
return { value: o && o[i++], done: !o };
|
|
45
|
+
}
|
|
46
|
+
};
|
|
47
|
+
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
|
|
48
|
+
};
|
|
49
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
50
|
+
exports.OwnerScope = exports.defineScope = void 0;
|
|
51
|
+
var queryMatcher_1 = require("../realtime/queryMatcher");
|
|
52
|
+
var projectDocForFieldOf = function (doc, fragment, fieldOf) {
|
|
53
|
+
var e_1, _a;
|
|
54
|
+
var projected = {};
|
|
55
|
+
try {
|
|
56
|
+
for (var _b = __values(Object.keys(fragment)), _c = _b.next(); !_c.done; _c = _b.next()) {
|
|
57
|
+
var path = _c.value;
|
|
58
|
+
projected[path] = fieldOf(doc, path);
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
62
|
+
finally {
|
|
63
|
+
try {
|
|
64
|
+
if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
|
|
65
|
+
}
|
|
66
|
+
finally { if (e_1) throw e_1.error; }
|
|
67
|
+
}
|
|
68
|
+
return projected;
|
|
69
|
+
};
|
|
70
|
+
var defineScope = function (def) {
|
|
71
|
+
return {
|
|
72
|
+
check: function (args) { return __awaiter(void 0, void 0, void 0, function () {
|
|
73
|
+
var _a, fragment, subject;
|
|
74
|
+
return __generator(this, function (_b) {
|
|
75
|
+
switch (_b.label) {
|
|
76
|
+
case 0:
|
|
77
|
+
_a = def.adminBypass;
|
|
78
|
+
if (!_a) return [3 /*break*/, 2];
|
|
79
|
+
return [4 /*yield*/, def.adminBypass(args)];
|
|
80
|
+
case 1:
|
|
81
|
+
_a = (_b.sent());
|
|
82
|
+
_b.label = 2;
|
|
83
|
+
case 2:
|
|
84
|
+
if (_a) {
|
|
85
|
+
return [2 /*return*/, true];
|
|
86
|
+
}
|
|
87
|
+
return [4 /*yield*/, def.matches(args)];
|
|
88
|
+
case 3:
|
|
89
|
+
fragment = _b.sent();
|
|
90
|
+
if (!fragment) {
|
|
91
|
+
return [2 /*return*/, false];
|
|
92
|
+
}
|
|
93
|
+
if (!args.doc) {
|
|
94
|
+
return [2 /*return*/, true];
|
|
95
|
+
}
|
|
96
|
+
subject = def.fieldOf
|
|
97
|
+
? projectDocForFieldOf(args.doc, fragment, def.fieldOf)
|
|
98
|
+
: args.doc;
|
|
99
|
+
return [2 /*return*/, (0, queryMatcher_1.matchesQuery)(subject, fragment)];
|
|
100
|
+
}
|
|
101
|
+
});
|
|
102
|
+
}); },
|
|
103
|
+
filter: function (args) { return __awaiter(void 0, void 0, void 0, function () {
|
|
104
|
+
var _a;
|
|
105
|
+
return __generator(this, function (_b) {
|
|
106
|
+
switch (_b.label) {
|
|
107
|
+
case 0:
|
|
108
|
+
_a = def.adminBypass;
|
|
109
|
+
if (!_a) return [3 /*break*/, 2];
|
|
110
|
+
return [4 /*yield*/, def.adminBypass(args)];
|
|
111
|
+
case 1:
|
|
112
|
+
_a = (_b.sent());
|
|
113
|
+
_b.label = 2;
|
|
114
|
+
case 2:
|
|
115
|
+
if (_a) {
|
|
116
|
+
return [2 /*return*/, {}];
|
|
117
|
+
}
|
|
118
|
+
return [2 /*return*/, def.matches(args)];
|
|
119
|
+
}
|
|
120
|
+
});
|
|
121
|
+
}); },
|
|
122
|
+
};
|
|
123
|
+
};
|
|
124
|
+
exports.defineScope = defineScope;
|
|
125
|
+
var defaultAdminBypass = function (_a) {
|
|
126
|
+
var _b;
|
|
127
|
+
var user = _a.user;
|
|
128
|
+
var withRoles = user;
|
|
129
|
+
if (user === null || user === void 0 ? void 0 : user.admin) {
|
|
130
|
+
return true;
|
|
131
|
+
}
|
|
132
|
+
return Boolean((_b = withRoles === null || withRoles === void 0 ? void 0 : withRoles.roles) === null || _b === void 0 ? void 0 : _b.includes("superadmin"));
|
|
133
|
+
};
|
|
134
|
+
var OwnerScope = function (options) {
|
|
135
|
+
if (options === void 0) { options = {}; }
|
|
136
|
+
var _a = typeof options === "string" ? { field: options } : options, _b = _a.field, field = _b === void 0 ? "ownerId" : _b, _c = _a.adminBypass, adminBypass = _c === void 0 ? defaultAdminBypass : _c;
|
|
137
|
+
return (0, exports.defineScope)({
|
|
138
|
+
adminBypass: function (args) { return adminBypass({ user: args.user }); },
|
|
139
|
+
fieldOf: function (doc, path) {
|
|
140
|
+
var _a;
|
|
141
|
+
if (path !== field) {
|
|
142
|
+
return undefined;
|
|
143
|
+
}
|
|
144
|
+
var owner = doc === null || doc === void 0 ? void 0 : doc[field];
|
|
145
|
+
var ownerId = (_a = owner === null || owner === void 0 ? void 0 : owner._id) !== null && _a !== void 0 ? _a : owner;
|
|
146
|
+
return ownerId == null ? undefined : String(ownerId);
|
|
147
|
+
},
|
|
148
|
+
matches: function (_a) {
|
|
149
|
+
var _b;
|
|
150
|
+
var user = _a.user;
|
|
151
|
+
return (user ? (_b = {}, _b[field] = user.id, _b) : null);
|
|
152
|
+
},
|
|
153
|
+
});
|
|
154
|
+
};
|
|
155
|
+
exports.OwnerScope = OwnerScope;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export declare const terrenoStatements: {
|
|
2
|
+
readonly admin: readonly ["access", "runScripts", "viewBackgroundTasks"];
|
|
3
|
+
readonly configuration: readonly ["read", "update"];
|
|
4
|
+
readonly consentForm: readonly ["create", "list", "read", "update", "delete"];
|
|
5
|
+
readonly consentResponse: readonly ["list", "read"];
|
|
6
|
+
readonly featureFlag: readonly ["create", "list", "read", "update", "delete"];
|
|
7
|
+
readonly rbac: readonly ["read", "manageRoles", "assignRoles"];
|
|
8
|
+
readonly user: readonly ["create", "list", "read", "update", "delete", "impersonate", "setPassword"];
|
|
9
|
+
};
|
|
10
|
+
export type Statements = Record<string, readonly string[]>;
|
|
11
|
+
export type PermissionSet = {
|
|
12
|
+
[resource: string]: readonly string[];
|
|
13
|
+
};
|
|
14
|
+
export declare const READ_ACTIONS: readonly ["read", "list", "view"];
|
|
15
|
+
export declare const READ_ONLY_ROLE_PERMISSIONS: {
|
|
16
|
+
readonly readOnly: true;
|
|
17
|
+
};
|
|
18
|
+
export type RolePermissionSpec = PermissionSet | "*" | typeof READ_ONLY_ROLE_PERMISSIONS;
|
|
19
|
+
export declare const mergeStatements: <S extends Statements>(appStatements: S) => Statements & S;
|
|
20
|
+
export declare const expandRolePermissions: (spec: RolePermissionSpec, statements: Statements, readActions: readonly string[]) => PermissionSet;
|
|
@@ -0,0 +1,115 @@
|
|
|
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 __values = (this && this.__values) || function(o) {
|
|
14
|
+
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
|
|
15
|
+
if (m) return m.call(o);
|
|
16
|
+
if (o && typeof o.length === "number") return {
|
|
17
|
+
next: function () {
|
|
18
|
+
if (o && i >= o.length) o = void 0;
|
|
19
|
+
return { value: o && o[i++], done: !o };
|
|
20
|
+
}
|
|
21
|
+
};
|
|
22
|
+
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
|
|
23
|
+
};
|
|
24
|
+
var __read = (this && this.__read) || function (o, n) {
|
|
25
|
+
var m = typeof Symbol === "function" && o[Symbol.iterator];
|
|
26
|
+
if (!m) return o;
|
|
27
|
+
var i = m.call(o), r, ar = [], e;
|
|
28
|
+
try {
|
|
29
|
+
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
|
|
30
|
+
}
|
|
31
|
+
catch (error) { e = { error: error }; }
|
|
32
|
+
finally {
|
|
33
|
+
try {
|
|
34
|
+
if (r && !r.done && (m = i["return"])) m.call(i);
|
|
35
|
+
}
|
|
36
|
+
finally { if (e) throw e.error; }
|
|
37
|
+
}
|
|
38
|
+
return ar;
|
|
39
|
+
};
|
|
40
|
+
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
41
|
+
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
|
|
42
|
+
if (ar || !(i in from)) {
|
|
43
|
+
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
|
|
44
|
+
ar[i] = from[i];
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
return to.concat(ar || Array.prototype.slice.call(from));
|
|
48
|
+
};
|
|
49
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
50
|
+
exports.expandRolePermissions = exports.mergeStatements = exports.READ_ONLY_ROLE_PERMISSIONS = exports.READ_ACTIONS = exports.terrenoStatements = void 0;
|
|
51
|
+
var MODEL_CRUD = ["create", "list", "read", "update", "delete"];
|
|
52
|
+
exports.terrenoStatements = {
|
|
53
|
+
admin: ["access", "runScripts", "viewBackgroundTasks"],
|
|
54
|
+
configuration: ["read", "update"],
|
|
55
|
+
consentForm: MODEL_CRUD,
|
|
56
|
+
consentResponse: ["list", "read"],
|
|
57
|
+
featureFlag: MODEL_CRUD,
|
|
58
|
+
rbac: ["read", "manageRoles", "assignRoles"],
|
|
59
|
+
user: ["create", "list", "read", "update", "delete", "impersonate", "setPassword"],
|
|
60
|
+
};
|
|
61
|
+
exports.READ_ACTIONS = ["read", "list", "view"];
|
|
62
|
+
exports.READ_ONLY_ROLE_PERMISSIONS = { readOnly: true };
|
|
63
|
+
var isReadOnlySentinel = function (spec) {
|
|
64
|
+
return typeof spec === "object" &&
|
|
65
|
+
spec !== null &&
|
|
66
|
+
!Array.isArray(spec) &&
|
|
67
|
+
Object.keys(spec).length === 1 &&
|
|
68
|
+
spec.readOnly === true;
|
|
69
|
+
};
|
|
70
|
+
var mergeStatements = function (appStatements) {
|
|
71
|
+
return __assign(__assign({}, exports.terrenoStatements), appStatements);
|
|
72
|
+
};
|
|
73
|
+
exports.mergeStatements = mergeStatements;
|
|
74
|
+
var expandRolePermissions = function (spec, statements, readActions) {
|
|
75
|
+
var e_1, _a, e_2, _b;
|
|
76
|
+
if (spec === "*") {
|
|
77
|
+
var expanded = {};
|
|
78
|
+
try {
|
|
79
|
+
for (var _c = __values(Object.entries(statements)), _d = _c.next(); !_d.done; _d = _c.next()) {
|
|
80
|
+
var _e = __read(_d.value, 2), resource = _e[0], actions = _e[1];
|
|
81
|
+
expanded[resource] = __spreadArray([], __read(actions), false);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
catch (e_1_1) { e_1 = { error: e_1_1 }; }
|
|
85
|
+
finally {
|
|
86
|
+
try {
|
|
87
|
+
if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
|
|
88
|
+
}
|
|
89
|
+
finally { if (e_1) throw e_1.error; }
|
|
90
|
+
}
|
|
91
|
+
return expanded;
|
|
92
|
+
}
|
|
93
|
+
if (isReadOnlySentinel(spec)) {
|
|
94
|
+
var expanded = {};
|
|
95
|
+
try {
|
|
96
|
+
for (var _f = __values(Object.entries(statements)), _g = _f.next(); !_g.done; _g = _f.next()) {
|
|
97
|
+
var _h = __read(_g.value, 2), resource = _h[0], actions = _h[1];
|
|
98
|
+
var readish = actions.filter(function (action) { return readActions.includes(action); });
|
|
99
|
+
if (readish.length > 0) {
|
|
100
|
+
expanded[resource] = readish;
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
catch (e_2_1) { e_2 = { error: e_2_1 }; }
|
|
105
|
+
finally {
|
|
106
|
+
try {
|
|
107
|
+
if (_g && !_g.done && (_b = _f.return)) _b.call(_f);
|
|
108
|
+
}
|
|
109
|
+
finally { if (e_2) throw e_2.error; }
|
|
110
|
+
}
|
|
111
|
+
return expanded;
|
|
112
|
+
}
|
|
113
|
+
return spec;
|
|
114
|
+
};
|
|
115
|
+
exports.expandRolePermissions = expandRolePermissions;
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
import type { createAccessControl } from "better-auth/plugins/access";
|
|
2
|
+
import type express from "express";
|
|
3
|
+
import type { RequestHandler } from "express";
|
|
4
|
+
import type { Connection } from "mongoose";
|
|
5
|
+
import type { RESTMethod } from "../api";
|
|
6
|
+
import type { User, UserModel } from "../auth";
|
|
7
|
+
import type { PermissionMethod } from "../permissions";
|
|
8
|
+
import type { RbacAuditWrite } from "./auditModel";
|
|
9
|
+
import type { RbacRoleDocument, RoleDefinition } from "./roleModel";
|
|
10
|
+
import type { PermissionSet, Statements } from "./statements";
|
|
11
|
+
/**
|
|
12
|
+
* Non-generic TerrenoAccess for runtime wiring (modelRouter, rbacRouter, TerrenoApp).
|
|
13
|
+
* `queryFilter` / `fieldMask` take `resource: string` so a concrete
|
|
14
|
+
* `TerrenoAccess<AppStatements>` remains assignable (function parameters are
|
|
15
|
+
* contravariant; a keyof-S union would not accept `string`).
|
|
16
|
+
*/
|
|
17
|
+
export type AnyTerrenoAccess = TerrenoAccess<Statements>;
|
|
18
|
+
/** @deprecated Prefer typed TerrenoAccess; AnyTerrenoAccess uses TerrenoAccess<any>. */
|
|
19
|
+
export type LoosePermissionRequest = {
|
|
20
|
+
[resource: string]: string[] | undefined;
|
|
21
|
+
};
|
|
22
|
+
export interface ModelRouterAccessOptions {
|
|
23
|
+
resource: string;
|
|
24
|
+
actions?: Partial<Record<RESTMethod, string | null>>;
|
|
25
|
+
scope?: ResourceScope;
|
|
26
|
+
also?: Partial<Record<RESTMethod, PermissionMethod<unknown>[]>>;
|
|
27
|
+
allowAnonymous?: boolean;
|
|
28
|
+
}
|
|
29
|
+
export type { Statements };
|
|
30
|
+
export type PermissionRequest<S extends Statements> = {
|
|
31
|
+
[K in keyof S]?: S[K][number][];
|
|
32
|
+
};
|
|
33
|
+
export interface AccessResult {
|
|
34
|
+
allowed: boolean;
|
|
35
|
+
deniedBy?: "role" | "scope" | "source";
|
|
36
|
+
reason?: string;
|
|
37
|
+
}
|
|
38
|
+
export interface AccessCheckArgs<S extends Statements> {
|
|
39
|
+
user?: User;
|
|
40
|
+
permissions: PermissionRequest<S>;
|
|
41
|
+
doc?: unknown;
|
|
42
|
+
context?: Record<string, unknown>;
|
|
43
|
+
}
|
|
44
|
+
export interface FieldMask {
|
|
45
|
+
read: string[] | "*";
|
|
46
|
+
write: string[] | "*";
|
|
47
|
+
omit?: string[];
|
|
48
|
+
}
|
|
49
|
+
export interface RoleDiff {
|
|
50
|
+
gained: PermissionSet;
|
|
51
|
+
lost: PermissionSet;
|
|
52
|
+
affectedUserCount: number;
|
|
53
|
+
}
|
|
54
|
+
export interface UserPermissionDiff {
|
|
55
|
+
gained: PermissionSet;
|
|
56
|
+
lost: PermissionSet;
|
|
57
|
+
resulting: PermissionSet;
|
|
58
|
+
}
|
|
59
|
+
export interface RoleInput {
|
|
60
|
+
name: string;
|
|
61
|
+
displayName: string;
|
|
62
|
+
description?: string | null;
|
|
63
|
+
permissions: PermissionSet;
|
|
64
|
+
excludesRoles?: string[];
|
|
65
|
+
isLocked?: boolean;
|
|
66
|
+
isSealed?: boolean;
|
|
67
|
+
}
|
|
68
|
+
export interface RoleManager {
|
|
69
|
+
seedDefaults: () => Promise<void>;
|
|
70
|
+
list: () => Promise<RbacRoleDocument[]>;
|
|
71
|
+
create: (args: {
|
|
72
|
+
actor: User;
|
|
73
|
+
role: RoleInput;
|
|
74
|
+
}) => Promise<RbacRoleDocument>;
|
|
75
|
+
update: (args: {
|
|
76
|
+
actor: User;
|
|
77
|
+
roleName: string;
|
|
78
|
+
changes: Partial<RoleInput>;
|
|
79
|
+
}) => Promise<RbacRoleDocument>;
|
|
80
|
+
remove: (args: {
|
|
81
|
+
actor: User;
|
|
82
|
+
roleName: string;
|
|
83
|
+
}) => Promise<void>;
|
|
84
|
+
assign: (args: {
|
|
85
|
+
actor: User;
|
|
86
|
+
userId: string;
|
|
87
|
+
roleNames: string[];
|
|
88
|
+
}) => Promise<void>;
|
|
89
|
+
unassign: (args: {
|
|
90
|
+
actor: User;
|
|
91
|
+
userId: string;
|
|
92
|
+
roleNames: string[];
|
|
93
|
+
}) => Promise<void>;
|
|
94
|
+
assertCanModifyUser: (args: {
|
|
95
|
+
actor: User;
|
|
96
|
+
userId: string;
|
|
97
|
+
}) => Promise<void>;
|
|
98
|
+
previewRoleChange: (args: {
|
|
99
|
+
roleName: string;
|
|
100
|
+
permissions: PermissionSet;
|
|
101
|
+
}) => Promise<RoleDiff>;
|
|
102
|
+
previewAssignment: (args: {
|
|
103
|
+
actor: User;
|
|
104
|
+
userId: string;
|
|
105
|
+
roleNames: string[];
|
|
106
|
+
}) => Promise<UserPermissionDiff>;
|
|
107
|
+
}
|
|
108
|
+
export type StaleOnFailurePolicy = "deny" | "use-stale" | "use-stale-bounded";
|
|
109
|
+
export interface PermissionSourceGrants {
|
|
110
|
+
roles?: string[];
|
|
111
|
+
permissions?: PermissionSet;
|
|
112
|
+
deny?: PermissionSet;
|
|
113
|
+
}
|
|
114
|
+
export interface PermissionSource {
|
|
115
|
+
name: string;
|
|
116
|
+
ttlMs?: number;
|
|
117
|
+
staleOnFailure?: StaleOnFailurePolicy;
|
|
118
|
+
staleMaxAgeMs?: number;
|
|
119
|
+
getGrants: (args: {
|
|
120
|
+
user: User;
|
|
121
|
+
}) => Promise<PermissionSourceGrants | null>;
|
|
122
|
+
}
|
|
123
|
+
export interface ResourceScope<TDoc = unknown> {
|
|
124
|
+
check?: (args: ScopeArgs<TDoc>) => boolean | PermissionSet | Promise<boolean | PermissionSet>;
|
|
125
|
+
filter?: (args: ScopeArgs<TDoc>) => Promise<Record<string, unknown> | null>;
|
|
126
|
+
}
|
|
127
|
+
export interface ScopeArgs<TDoc> {
|
|
128
|
+
user: User;
|
|
129
|
+
action: string;
|
|
130
|
+
doc?: TDoc;
|
|
131
|
+
context?: Record<string, unknown>;
|
|
132
|
+
}
|
|
133
|
+
export type ResourceScopes<_S extends Statements> = {
|
|
134
|
+
[key: string]: ResourceScope;
|
|
135
|
+
};
|
|
136
|
+
export interface ResourceFieldViews<_S extends Statements> {
|
|
137
|
+
[resource: string]: {
|
|
138
|
+
views: Record<string, FieldMask>;
|
|
139
|
+
select: (args: {
|
|
140
|
+
user?: User;
|
|
141
|
+
doc?: unknown;
|
|
142
|
+
permissions: PermissionSet;
|
|
143
|
+
phase: "read" | "write" | "create";
|
|
144
|
+
}) => string | FieldMask | Promise<string | FieldMask>;
|
|
145
|
+
createView?: string | FieldMask | "deny";
|
|
146
|
+
};
|
|
147
|
+
}
|
|
148
|
+
export type { PermissionSet, RbacAuditWrite };
|
|
149
|
+
export type RbacAuditSink = (record: RbacAuditWrite) => void | Promise<void>;
|
|
150
|
+
export interface AccessOptions<S extends Statements> {
|
|
151
|
+
connection: Connection;
|
|
152
|
+
statements: S;
|
|
153
|
+
userModel?: UserModel;
|
|
154
|
+
defaultRoles?: RoleDefinition[];
|
|
155
|
+
scopes?: ResourceScopes<S>;
|
|
156
|
+
fieldViews?: ResourceFieldViews<S>;
|
|
157
|
+
sources?: PermissionSource[];
|
|
158
|
+
readActions?: readonly string[];
|
|
159
|
+
cacheTtlMs?: number;
|
|
160
|
+
resolvePermissions?: (args: {
|
|
161
|
+
user: User;
|
|
162
|
+
}) => Promise<PermissionSet | null>;
|
|
163
|
+
statementDescriptions?: Record<string, Record<string, string>>;
|
|
164
|
+
/**
|
|
165
|
+
* Extra destinations for RoleManager audit records (e.g. a consuming-app audit log).
|
|
166
|
+
* The built-in `RbacAudit` collection is still written unless `persistAudit` is false.
|
|
167
|
+
*/
|
|
168
|
+
auditSink?: RbacAuditSink | RbacAuditSink[];
|
|
169
|
+
/**
|
|
170
|
+
* When false, skip the built-in `RbacAudit` collection. At least one `auditSink` is then
|
|
171
|
+
* required so role mutations cannot go unaudited.
|
|
172
|
+
*/
|
|
173
|
+
persistAudit?: boolean;
|
|
174
|
+
}
|
|
175
|
+
export interface TerrenoAccess<S extends Statements> {
|
|
176
|
+
readonly statements: S;
|
|
177
|
+
readonly ac: ReturnType<typeof createAccessControl<S>>;
|
|
178
|
+
can: (args: AccessCheckArgs<S>) => Promise<AccessResult>;
|
|
179
|
+
getPermissions: (args: {
|
|
180
|
+
user: User;
|
|
181
|
+
}) => Promise<PermissionSet>;
|
|
182
|
+
queryFilter: (args: {
|
|
183
|
+
user?: User;
|
|
184
|
+
resource: string;
|
|
185
|
+
action: string;
|
|
186
|
+
context?: Record<string, unknown>;
|
|
187
|
+
}) => Promise<Record<string, unknown> | null>;
|
|
188
|
+
fieldMask: (args: {
|
|
189
|
+
user?: User;
|
|
190
|
+
resource: string;
|
|
191
|
+
doc?: unknown;
|
|
192
|
+
phase?: "read" | "write" | "create";
|
|
193
|
+
}) => Promise<FieldMask>;
|
|
194
|
+
middleware: (permissions: PermissionRequest<S>, options?: {
|
|
195
|
+
getDoc?: (req: express.Request) => Promise<unknown>;
|
|
196
|
+
}) => RequestHandler;
|
|
197
|
+
permission: (permissions: PermissionRequest<S>) => PermissionMethod<unknown>;
|
|
198
|
+
roles: RoleManager;
|
|
199
|
+
invalidateCache: (args?: {
|
|
200
|
+
userId?: string;
|
|
201
|
+
}) => void;
|
|
202
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { Schema } from "mongoose";
|
|
2
|
+
export interface RbacUser {
|
|
3
|
+
roles: string[];
|
|
4
|
+
}
|
|
5
|
+
export interface RbacUserPluginOptions {
|
|
6
|
+
/**
|
|
7
|
+
* Role names assigned to newly created users. Apps that gate resources through
|
|
8
|
+
* `access` need a baseline role here, otherwise signups start with no permissions.
|
|
9
|
+
*/
|
|
10
|
+
defaultRoles?: string[];
|
|
11
|
+
}
|
|
12
|
+
export declare const rbacUserPlugin: (schema: Schema, options?: RbacUserPluginOptions) => void;
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __read = (this && this.__read) || function (o, n) {
|
|
3
|
+
var m = typeof Symbol === "function" && o[Symbol.iterator];
|
|
4
|
+
if (!m) return o;
|
|
5
|
+
var i = m.call(o), r, ar = [], e;
|
|
6
|
+
try {
|
|
7
|
+
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
|
|
8
|
+
}
|
|
9
|
+
catch (error) { e = { error: error }; }
|
|
10
|
+
finally {
|
|
11
|
+
try {
|
|
12
|
+
if (r && !r.done && (m = i["return"])) m.call(i);
|
|
13
|
+
}
|
|
14
|
+
finally { if (e) throw e.error; }
|
|
15
|
+
}
|
|
16
|
+
return ar;
|
|
17
|
+
};
|
|
18
|
+
var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
19
|
+
if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
|
|
20
|
+
if (ar || !(i in from)) {
|
|
21
|
+
if (!ar) ar = Array.prototype.slice.call(from, 0, i);
|
|
22
|
+
ar[i] = from[i];
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
return to.concat(ar || Array.prototype.slice.call(from));
|
|
26
|
+
};
|
|
27
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
28
|
+
exports.rbacUserPlugin = void 0;
|
|
29
|
+
var rbacUserPlugin = function (schema, options) {
|
|
30
|
+
var _a;
|
|
31
|
+
var defaultRoles = __spreadArray([], __read(((_a = options === null || options === void 0 ? void 0 : options.defaultRoles) !== null && _a !== void 0 ? _a : [])), false);
|
|
32
|
+
schema.add({
|
|
33
|
+
roles: {
|
|
34
|
+
default: function () { return __spreadArray([], __read(defaultRoles), false); },
|
|
35
|
+
description: "RBAC role names assigned to this user",
|
|
36
|
+
index: true,
|
|
37
|
+
type: [String],
|
|
38
|
+
},
|
|
39
|
+
});
|
|
40
|
+
};
|
|
41
|
+
exports.rbacUserPlugin = rbacUserPlugin;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { ChangeStreamDocument } from "mongodb";
|
|
2
2
|
import type { Server } from "socket.io";
|
|
3
3
|
import type { User } from "../auth";
|
|
4
|
-
import {
|
|
4
|
+
import type { PermissionMethod } from "../permissions";
|
|
5
5
|
import { type SyncRegistryEntry } from "../sync/registry";
|
|
6
6
|
import { type RealtimeRegistryEntry } from "./registry";
|
|
7
7
|
import type { ChangeStreamConfig, RealtimeEvent } from "./types";
|