@terreno/api 57.3.0 → 57.4.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.
Files changed (293) hide show
  1. package/.ai/skills/mongoose-schema-safety/SKILL.md +23 -10
  2. package/README.md +6 -0
  3. package/dist/adminTypes.d.ts +7 -0
  4. package/dist/adminTypes.js +6 -1
  5. package/dist/api.d.ts +10 -0
  6. package/dist/api.js +99 -36
  7. package/dist/audit/auditApp.d.ts +30 -0
  8. package/dist/audit/auditApp.js +155 -0
  9. package/dist/audit/auditEventModel.d.ts +29 -0
  10. package/dist/audit/auditEventModel.js +102 -0
  11. package/dist/audit/cloudTasksEnqueue.d.ts +32 -0
  12. package/dist/audit/cloudTasksEnqueue.js +162 -0
  13. package/dist/audit/diff.d.ts +10 -0
  14. package/dist/audit/diff.js +230 -0
  15. package/dist/audit/processQueue.d.ts +6 -0
  16. package/dist/audit/processQueue.js +101 -0
  17. package/dist/audit/rbacSink.d.ts +2 -0
  18. package/dist/audit/rbacSink.js +82 -0
  19. package/dist/audit/record.d.ts +56 -0
  20. package/dist/audit/record.js +373 -0
  21. package/dist/betterAuth.d.ts +6 -0
  22. package/dist/betterAuthSetup.js +1 -1
  23. package/dist/collectionRegistry.d.ts +3 -1
  24. package/dist/collectionRegistry.js +25 -0
  25. package/dist/index.d.ts +26 -1
  26. package/dist/index.js +48 -2
  27. package/dist/mcp/query.d.ts +0 -13
  28. package/dist/mcp/query.js +8 -8
  29. package/dist/migrations/fixtures/all-down/20260910120000-one.d.ts +4 -0
  30. package/dist/migrations/fixtures/all-down/20260910120000-one.js +49 -0
  31. package/dist/migrations/fixtures/all-down/20260910120001-two.d.ts +4 -0
  32. package/dist/migrations/fixtures/all-down/20260910120001-two.js +49 -0
  33. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.d.ts +3 -0
  34. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +45 -0
  35. package/dist/migrations/fixtures/bad-name/not-a-migration.d.ts +3 -0
  36. package/dist/migrations/fixtures/bad-name/not-a-migration.js +45 -0
  37. package/dist/migrations/fixtures/missing-up/20260910120000-noup.d.ts +2 -0
  38. package/dist/migrations/fixtures/missing-up/20260910120000-noup.js +5 -0
  39. package/dist/migrations/fixtures/valid/20260910120000-alpha.d.ts +3 -0
  40. package/dist/migrations/fixtures/valid/20260910120000-alpha.js +45 -0
  41. package/dist/migrations/fixtures/valid/20260910120001-beta.d.ts +4 -0
  42. package/dist/migrations/fixtures/valid/20260910120001-beta.js +49 -0
  43. package/dist/migrations/generate.d.ts +17 -0
  44. package/dist/migrations/generate.js +277 -0
  45. package/dist/migrations/load.d.ts +20 -0
  46. package/dist/migrations/load.js +236 -0
  47. package/dist/migrations/lock.d.ts +13 -0
  48. package/dist/migrations/lock.js +145 -0
  49. package/dist/migrations/runner.d.ts +42 -0
  50. package/dist/migrations/runner.js +503 -0
  51. package/dist/migrations/schemaCatalog.d.ts +44 -0
  52. package/dist/migrations/schemaCatalog.js +326 -0
  53. package/dist/migrations/types.d.ts +87 -0
  54. package/dist/migrations/types.js +7 -0
  55. package/dist/models/notification.d.ts +2 -0
  56. package/dist/models/notification.js +62 -0
  57. package/dist/models/notificationPreference.d.ts +2 -0
  58. package/dist/models/notificationPreference.js +49 -0
  59. package/dist/notifications/notificationService.d.ts +40 -0
  60. package/dist/notifications/notificationService.js +323 -0
  61. package/dist/notifications/notificationsApp.d.ts +18 -0
  62. package/dist/notifications/notificationsApp.js +250 -0
  63. package/dist/notifications/notificationsBeforeSend.d.ts +14 -0
  64. package/dist/notifications/notificationsBeforeSend.js +77 -0
  65. package/dist/openApi.d.ts +1 -7
  66. package/dist/openApi.js +7 -6
  67. package/dist/openApiBuilder.d.ts +14 -3
  68. package/dist/openApiValidator.d.ts +13 -1
  69. package/dist/openApiValidator.js +200 -36
  70. package/dist/orgs/orgContext.d.ts +23 -0
  71. package/dist/orgs/orgContext.js +198 -0
  72. package/dist/orgs/orgPermissions.d.ts +4 -0
  73. package/dist/orgs/orgPermissions.js +77 -0
  74. package/dist/orgs/orgPlugin.d.ts +13 -0
  75. package/dist/orgs/orgPlugin.js +84 -0
  76. package/dist/orgs/organizationModel.d.ts +13 -0
  77. package/dist/orgs/organizationModel.js +301 -0
  78. package/dist/orgs/organizationSettings.d.ts +19 -0
  79. package/dist/orgs/organizationSettings.js +120 -0
  80. package/dist/orgs/orgsApp.d.ts +28 -0
  81. package/dist/orgs/orgsApp.js +678 -0
  82. package/dist/permissions.d.ts +7 -13
  83. package/dist/permissions.js +8 -31
  84. package/dist/rateLimit/middleware.d.ts +0 -8
  85. package/dist/rateLimit/middleware.js +2 -3
  86. package/dist/rateLimit/mongoStore.d.ts +1 -0
  87. package/dist/rateLimit/mongoStore.js +1 -0
  88. package/dist/rateLimit/policies.d.ts +0 -4
  89. package/dist/rateLimit/policies.js +5 -7
  90. package/dist/rateLimit/redisStore.d.ts +1 -0
  91. package/dist/rateLimit/redisStore.js +1 -0
  92. package/dist/rbac/access.js +30 -13
  93. package/dist/rbac/membershipOrgAdminSource.d.ts +6 -0
  94. package/dist/rbac/membershipOrgAdminSource.js +122 -0
  95. package/dist/rbac/modelRouterAccess.d.ts +3 -0
  96. package/dist/rbac/modelRouterAccess.js +3 -0
  97. package/dist/rbac/resolve.js +60 -31
  98. package/dist/rbac/roleModel.d.ts +2 -5
  99. package/dist/rbac/roleModel.js +18 -4
  100. package/dist/rbac/statements.d.ts +10 -1
  101. package/dist/rbac/statements.js +19 -2
  102. package/dist/rbac/types.d.ts +5 -0
  103. package/dist/realtime/changeStreamWatcher.d.ts +10 -4
  104. package/dist/realtime/changeStreamWatcher.js +110 -64
  105. package/dist/realtime/deprecation.d.ts +1 -0
  106. package/dist/realtime/deprecation.js +1 -0
  107. package/dist/realtime/realtimeApp.d.ts +1 -0
  108. package/dist/realtime/realtimeApp.js +1 -0
  109. package/dist/schemaMetadata.js +16 -5
  110. package/dist/sync/adminBroadcastScope.d.ts +40 -0
  111. package/dist/sync/adminBroadcastScope.js +194 -0
  112. package/dist/sync/adminWindowAccess.d.ts +13 -0
  113. package/dist/sync/adminWindowAccess.js +96 -0
  114. package/dist/sync/adminWindowMutation.d.ts +88 -0
  115. package/dist/sync/adminWindowMutation.js +247 -0
  116. package/dist/sync/executors.d.ts +9 -3
  117. package/dist/sync/executors.js +190 -159
  118. package/dist/sync/mutationHandler.d.ts +5 -2
  119. package/dist/sync/mutationHandler.js +191 -71
  120. package/dist/sync/registry.js +4 -0
  121. package/dist/sync/routes.d.ts +13 -0
  122. package/dist/sync/routes.js +113 -56
  123. package/dist/sync/socketHandlers.d.ts +8 -2
  124. package/dist/sync/socketHandlers.js +144 -50
  125. package/dist/sync/streams.d.ts +2 -0
  126. package/dist/sync/streams.js +7 -1
  127. package/dist/sync/syncApp.d.ts +2 -1
  128. package/dist/sync/syncApp.js +2 -1
  129. package/dist/sync/syncBatch.d.ts +5 -2
  130. package/dist/sync/syncBatch.js +4 -4
  131. package/dist/sync/types.d.ts +18 -0
  132. package/dist/terrenoApp.d.ts +29 -0
  133. package/dist/terrenoApp.js +91 -54
  134. package/dist/tests/createTestData.d.ts +1 -3
  135. package/dist/tests/createTestData.js +3 -5
  136. package/dist/tests/models.d.ts +1 -0
  137. package/dist/tests/models.js +9 -2
  138. package/dist/tests/testHelper.d.ts +0 -5
  139. package/dist/tests/testHelper.js +2 -9
  140. package/dist/types/authToken.d.ts +3 -3
  141. package/dist/types/mcpServiceToken.d.ts +2 -2
  142. package/dist/types/membership.d.ts +23 -0
  143. package/dist/types/membership.js +2 -0
  144. package/dist/types/notification.d.ts +28 -0
  145. package/dist/types/notification.js +2 -0
  146. package/dist/types/notificationPreference.d.ts +20 -0
  147. package/dist/types/notificationPreference.js +2 -0
  148. package/dist/types/organization.d.ts +36 -0
  149. package/dist/types/organization.js +2 -0
  150. package/dist/webhooks/idempotency/webhookReceipt.d.ts +4 -49
  151. package/dist/webhooks/idempotency/webhookReceipt.js +7 -7
  152. package/dist/webhooks/rawBody.d.ts +1 -0
  153. package/dist/webhooks/rawBody.js +1 -0
  154. package/package.json +31 -25
  155. package/src/__snapshots__/openApi.test.ts.snap +192 -54
  156. package/src/__snapshots__/openApiBuilder.test.ts.snap +0 -18
  157. package/src/__snapshots__/schemaMetadata.test.ts.snap +0 -1
  158. package/src/adminTypes.ts +8 -0
  159. package/src/api.test.ts +39 -2
  160. package/src/api.ts +68 -0
  161. package/src/audit/auditApp.test.ts +243 -0
  162. package/src/audit/auditApp.ts +139 -0
  163. package/src/audit/auditEventModel.ts +156 -0
  164. package/src/audit/auditRouter.test.ts +456 -0
  165. package/src/audit/cloudTasksEnqueue.test.ts +124 -0
  166. package/src/audit/cloudTasksEnqueue.ts +104 -0
  167. package/src/audit/diff.ts +163 -0
  168. package/src/audit/processQueue.ts +69 -0
  169. package/src/audit/rbacSink.test.ts +86 -0
  170. package/src/audit/rbacSink.ts +42 -0
  171. package/src/audit/record.test.ts +402 -0
  172. package/src/audit/record.ts +328 -0
  173. package/src/auth.test.ts +1 -1
  174. package/src/betterAuth.ts +7 -0
  175. package/src/betterAuthSetup.test.ts +27 -0
  176. package/src/betterAuthSetup.ts +1 -0
  177. package/src/collectionRegistry.test.ts +8 -9
  178. package/src/collectionRegistry.ts +21 -1
  179. package/src/express.d.ts +2 -0
  180. package/src/expressServer.test.ts +50 -2
  181. package/src/index.ts +69 -0
  182. package/src/mcp/handlers.test.ts +275 -0
  183. package/src/mcp/query.ts +3 -3
  184. package/src/mcp/toolGenerator.test.ts +81 -0
  185. package/src/migrations/cli.test.ts +376 -0
  186. package/src/migrations/cli.ts +283 -0
  187. package/src/migrations/fixtures/all-down/20260910120000-one.ts +6 -0
  188. package/src/migrations/fixtures/all-down/20260910120001-two.ts +6 -0
  189. package/src/migrations/fixtures/bad-id/20260910120000-mismatch.ts +4 -0
  190. package/src/migrations/fixtures/bad-name/not-a-migration.ts +4 -0
  191. package/src/migrations/fixtures/missing-up/20260910120000-noup.ts +2 -0
  192. package/src/migrations/fixtures/valid/20260910120000-alpha.ts +4 -0
  193. package/src/migrations/fixtures/valid/20260910120001-beta.ts +6 -0
  194. package/src/migrations/generate.test.ts +333 -0
  195. package/src/migrations/generate.ts +216 -0
  196. package/src/migrations/load.test.ts +103 -0
  197. package/src/migrations/load.ts +124 -0
  198. package/src/migrations/lock.test.ts +133 -0
  199. package/src/migrations/lock.ts +118 -0
  200. package/src/migrations/runner.test.ts +504 -0
  201. package/src/migrations/runner.ts +358 -0
  202. package/src/migrations/schemaCatalog.test.ts +159 -0
  203. package/src/migrations/schemaCatalog.ts +262 -0
  204. package/src/migrations/types.ts +94 -0
  205. package/src/models/notification.ts +68 -0
  206. package/src/models/notificationPreference.ts +62 -0
  207. package/src/notifications/notificationService.ts +254 -0
  208. package/src/notifications/notificationsApp.test.ts +505 -0
  209. package/src/notifications/notificationsApp.ts +200 -0
  210. package/src/notifications/notificationsBeforeSend.ts +51 -0
  211. package/src/openApi.test.ts +0 -1
  212. package/src/openApi.ts +2 -1
  213. package/src/openApiBuilder.ts +14 -3
  214. package/src/openApiValidator.test.ts +221 -2
  215. package/src/openApiValidator.ts +218 -33
  216. package/src/orgs/orgAccessOptIn.test.ts +87 -0
  217. package/src/orgs/orgContext.test.ts +259 -0
  218. package/src/orgs/orgContext.ts +151 -0
  219. package/src/orgs/orgPermissions.test.ts +105 -0
  220. package/src/orgs/orgPermissions.ts +40 -0
  221. package/src/orgs/orgPlugin.test.ts +130 -0
  222. package/src/orgs/orgPlugin.ts +70 -0
  223. package/src/orgs/orgRbac.test.ts +267 -0
  224. package/src/orgs/orgSecurityDefects.test.ts +415 -0
  225. package/src/orgs/organizationModel.test.ts +205 -0
  226. package/src/orgs/organizationModel.ts +257 -0
  227. package/src/orgs/organizationSettings.test.ts +113 -0
  228. package/src/orgs/organizationSettings.ts +126 -0
  229. package/src/orgs/orgsApp.test.ts +382 -0
  230. package/src/orgs/orgsApp.ts +563 -0
  231. package/src/permissions.test.ts +62 -36
  232. package/src/permissions.ts +8 -30
  233. package/src/rateLimit/middleware.ts +1 -1
  234. package/src/rateLimit/mongoStore.ts +1 -0
  235. package/src/rateLimit/policies.ts +2 -2
  236. package/src/rateLimit/redisStore.ts +1 -0
  237. package/src/rbac/access.ts +11 -3
  238. package/src/rbac/membershipOrgAdminSource.ts +59 -0
  239. package/src/rbac/modelRouterAccess.ts +3 -0
  240. package/src/rbac/permissionUtils.test.ts +26 -5
  241. package/src/rbac/resolve.test.ts +34 -2
  242. package/src/rbac/resolve.ts +26 -7
  243. package/src/rbac/roleModel.test.ts +34 -1
  244. package/src/rbac/roleModel.ts +17 -1
  245. package/src/rbac/statements.test.ts +19 -0
  246. package/src/rbac/statements.ts +19 -1
  247. package/src/rbac/types.ts +5 -0
  248. package/src/realtime/changeStreamWatcher.ts +73 -33
  249. package/src/realtime/deprecation.ts +1 -0
  250. package/src/realtime/realtime.test.ts +357 -185
  251. package/src/realtime/realtimeApp.ts +1 -0
  252. package/src/schemaMetadata.test.ts +14 -0
  253. package/src/schemaMetadata.ts +5 -5
  254. package/src/sync/adminBroadcastConfig.test.ts +96 -0
  255. package/src/sync/adminBroadcastScope.test.ts +155 -0
  256. package/src/sync/adminBroadcastScope.ts +123 -0
  257. package/src/sync/adminWindowAccess.test.ts +57 -0
  258. package/src/sync/adminWindowAccess.ts +32 -0
  259. package/src/sync/adminWindowMutation.test.ts +450 -0
  260. package/src/sync/adminWindowMutation.ts +283 -0
  261. package/src/sync/executors.ts +33 -6
  262. package/src/sync/mutationHandler.test.ts +277 -1
  263. package/src/sync/mutationHandler.ts +171 -29
  264. package/src/sync/registry.ts +4 -0
  265. package/src/sync/routes.ts +52 -8
  266. package/src/sync/socketHandlers.ts +154 -58
  267. package/src/sync/streams.ts +6 -0
  268. package/src/sync/sync.test.ts +3 -2
  269. package/src/sync/syncApp.ts +2 -1
  270. package/src/sync/syncBatch.ts +7 -2
  271. package/src/sync/syncRoutes.test.ts +297 -3
  272. package/src/sync/syncSocket.test.ts +229 -0
  273. package/src/sync/types.ts +20 -0
  274. package/src/terrenoApp.migrations.test.ts +114 -0
  275. package/src/terrenoApp.test.ts +41 -0
  276. package/src/terrenoApp.ts +94 -31
  277. package/src/tests/createTestData.ts +2 -2
  278. package/src/tests/models.ts +10 -2
  279. package/src/tests/testHelper.ts +1 -7
  280. package/src/types/authToken.ts +2 -4
  281. package/src/types/mcpServiceToken.ts +1 -7
  282. package/src/types/membership.ts +48 -0
  283. package/src/types/notification.ts +34 -0
  284. package/src/types/notificationPreference.ts +28 -0
  285. package/src/types/organization.ts +49 -0
  286. package/src/webhooks/idempotency/webhookReceipt.ts +4 -7
  287. package/src/webhooks/rawBody.test.ts +33 -0
  288. package/src/webhooks/rawBody.ts +1 -0
  289. package/tsconfig.json +1 -1
  290. package/tsconfig.typedoc.json +2 -1
  291. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.d.ts +0 -2
  292. package/dist/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
  293. package/src/vendor/wesleytodd-openapi/lib/convert-yaml.js +0 -13
@@ -0,0 +1,301 @@
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 __read = (this && this.__read) || function (o, n) {
50
+ var m = typeof Symbol === "function" && o[Symbol.iterator];
51
+ if (!m) return o;
52
+ var i = m.call(o), r, ar = [], e;
53
+ try {
54
+ while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
55
+ }
56
+ catch (error) { e = { error: error }; }
57
+ finally {
58
+ try {
59
+ if (r && !r.done && (m = i["return"])) m.call(i);
60
+ }
61
+ finally { if (e) throw e.error; }
62
+ }
63
+ return ar;
64
+ };
65
+ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
66
+ if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
67
+ if (ar || !(i in from)) {
68
+ if (!ar) ar = Array.prototype.slice.call(from, 0, i);
69
+ ar[i] = from[i];
70
+ }
71
+ }
72
+ return to.concat(ar || Array.prototype.slice.call(from));
73
+ };
74
+ var __importDefault = (this && this.__importDefault) || function (mod) {
75
+ return (mod && mod.__esModule) ? mod : { "default": mod };
76
+ };
77
+ Object.defineProperty(exports, "__esModule", { value: true });
78
+ exports.Membership = exports.Organization = exports.getMembershipModel = exports.getOrganizationModel = exports.organizationSlugFromName = exports.assertOrganizationSlugAvailable = void 0;
79
+ var mongoose_1 = __importDefault(require("mongoose"));
80
+ var errors_1 = require("../errors");
81
+ var plugins_1 = require("../plugins");
82
+ var organizationSettings_1 = require("./organizationSettings");
83
+ var MEMBERSHIP_ROLE_NAMES = ["org-admin", "member"];
84
+ var MEMBERSHIP_STATUSES = ["active", "suspended"];
85
+ var toObjectId = function (value) {
86
+ if (value instanceof mongoose_1.default.Types.ObjectId) {
87
+ return value;
88
+ }
89
+ return new mongoose_1.default.Types.ObjectId(value);
90
+ };
91
+ var assertOrganizationSlugAvailable = function (slug, excludeOrganizationId) { return __awaiter(void 0, void 0, void 0, function () {
92
+ var query, existing;
93
+ return __generator(this, function (_a) {
94
+ switch (_a.label) {
95
+ case 0:
96
+ query = { deleted: { $in: [true, false] }, slug: slug };
97
+ if (excludeOrganizationId) {
98
+ query._id = { $ne: excludeOrganizationId };
99
+ }
100
+ return [4 /*yield*/, exports.Organization.findOneOrNone(query)];
101
+ case 1:
102
+ existing = _a.sent();
103
+ if (existing) {
104
+ throw new errors_1.ConflictError("Organization name already in use");
105
+ }
106
+ return [2 /*return*/];
107
+ }
108
+ });
109
+ }); };
110
+ exports.assertOrganizationSlugAvailable = assertOrganizationSlugAvailable;
111
+ var organizationSlugFromName = function (name) {
112
+ var slug = name
113
+ .trim()
114
+ .toLowerCase()
115
+ .replace(/[^a-z0-9]+/g, "-")
116
+ .replace(/^-+|-+$/g, "");
117
+ if (!slug) {
118
+ throw new errors_1.APIError({
119
+ status: 400,
120
+ title: "Organization name must produce a slug",
121
+ });
122
+ }
123
+ return slug;
124
+ };
125
+ exports.organizationSlugFromName = organizationSlugFromName;
126
+ var organizationSchema = new mongoose_1.default.Schema({
127
+ disabled: {
128
+ default: false,
129
+ description: "Whether operators have disabled this organization",
130
+ type: Boolean,
131
+ },
132
+ name: {
133
+ description: "Human-readable organization name",
134
+ required: true,
135
+ trim: true,
136
+ type: String,
137
+ },
138
+ ownerId: {
139
+ description: "User who created the organization; transferable",
140
+ ref: "User",
141
+ required: true,
142
+ type: mongoose_1.default.Schema.Types.ObjectId,
143
+ },
144
+ settings: {
145
+ description: "App-defined organization settings object",
146
+ type: mongoose_1.default.Schema.Types.Mixed,
147
+ },
148
+ slug: {
149
+ description: "URL-safe unique identifier generated from the organization name",
150
+ required: true,
151
+ trim: true,
152
+ type: String,
153
+ unique: true,
154
+ },
155
+ }, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
156
+ organizationSchema.plugin(plugins_1.createdUpdatedPlugin);
157
+ organizationSchema.plugin(plugins_1.isDeletedPlugin);
158
+ organizationSchema.plugin(plugins_1.findOneOrNone);
159
+ organizationSchema.plugin(plugins_1.findExactlyOne);
160
+ organizationSchema.pre("validate", function () {
161
+ if (!this.slug) {
162
+ this.slug = (0, exports.organizationSlugFromName)(this.name);
163
+ }
164
+ if (!this.isModified("settings")) {
165
+ return;
166
+ }
167
+ this.settings = (0, organizationSettings_1.applyOrganizationSettings)(this.settings);
168
+ });
169
+ var membershipSchema = new mongoose_1.default.Schema({
170
+ organizationId: {
171
+ description: "Organization this membership belongs to",
172
+ index: true,
173
+ ref: "Organization",
174
+ required: true,
175
+ type: mongoose_1.default.Schema.Types.ObjectId,
176
+ },
177
+ roleName: {
178
+ default: "member",
179
+ description: "Per-organization role: org-admin or member",
180
+ enum: MEMBERSHIP_ROLE_NAMES,
181
+ required: true,
182
+ type: String,
183
+ },
184
+ status: {
185
+ default: "active",
186
+ description: "Whether this membership is active or suspended",
187
+ enum: MEMBERSHIP_STATUSES,
188
+ required: true,
189
+ type: String,
190
+ },
191
+ userId: {
192
+ description: "User who holds this membership",
193
+ index: true,
194
+ ref: "User",
195
+ required: true,
196
+ type: mongoose_1.default.Schema.Types.ObjectId,
197
+ },
198
+ }, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
199
+ membershipSchema.index({ organizationId: 1, userId: 1 }, { unique: true });
200
+ membershipSchema.plugin(plugins_1.createdUpdatedPlugin);
201
+ membershipSchema.plugin(plugins_1.isDeletedPlugin);
202
+ membershipSchema.plugin(plugins_1.findOneOrNone);
203
+ membershipSchema.plugin(plugins_1.findExactlyOne);
204
+ membershipSchema.statics = __assign(__assign({}, membershipSchema.statics), { findActiveForUser: function (userId) {
205
+ return __awaiter(this, void 0, void 0, function () {
206
+ return __generator(this, function (_a) {
207
+ return [2 /*return*/, this.find({
208
+ status: "active",
209
+ userId: toObjectId(userId),
210
+ })];
211
+ });
212
+ });
213
+ }, isMember: function (userId, organizationId) {
214
+ return __awaiter(this, void 0, void 0, function () {
215
+ var membership;
216
+ return __generator(this, function (_a) {
217
+ switch (_a.label) {
218
+ case 0: return [4 /*yield*/, this.findOneOrNone({
219
+ organizationId: toObjectId(organizationId),
220
+ status: "active",
221
+ userId: toObjectId(userId),
222
+ })];
223
+ case 1:
224
+ membership = _a.sent();
225
+ return [2 /*return*/, Boolean(membership)];
226
+ }
227
+ });
228
+ });
229
+ }, isOrgAdmin: function (userId, organizationId) {
230
+ return __awaiter(this, void 0, void 0, function () {
231
+ var membership;
232
+ return __generator(this, function (_a) {
233
+ switch (_a.label) {
234
+ case 0: return [4 /*yield*/, this.findOneOrNone({
235
+ organizationId: toObjectId(organizationId),
236
+ roleName: "org-admin",
237
+ status: "active",
238
+ userId: toObjectId(userId),
239
+ })];
240
+ case 1:
241
+ membership = _a.sent();
242
+ return [2 /*return*/, Boolean(membership)];
243
+ }
244
+ });
245
+ });
246
+ } });
247
+ var getOrganizationModel = function () {
248
+ var existing = mongoose_1.default.models.Organization;
249
+ if (existing) {
250
+ return existing;
251
+ }
252
+ return mongoose_1.default.model("Organization", organizationSchema);
253
+ };
254
+ exports.getOrganizationModel = getOrganizationModel;
255
+ var getMembershipModel = function () {
256
+ var existing = mongoose_1.default.models.Membership;
257
+ if (existing) {
258
+ return existing;
259
+ }
260
+ return mongoose_1.default.model("Membership", membershipSchema);
261
+ };
262
+ exports.getMembershipModel = getMembershipModel;
263
+ var createLazyModel = function (getModel) {
264
+ var handler = {
265
+ apply: function (_target, thisArg, argArray) {
266
+ return Reflect.apply(getModel(), thisArg, argArray);
267
+ },
268
+ construct: function (_target, argArray) {
269
+ var Model = getModel();
270
+ return new (Model.bind.apply(Model, __spreadArray([void 0], __read(argArray), false)))();
271
+ },
272
+ get: function (_target, prop) {
273
+ var model = getModel();
274
+ var value = Reflect.get(model, prop, model);
275
+ if (typeof value === "function") {
276
+ return value.bind(model);
277
+ }
278
+ return value;
279
+ },
280
+ getPrototypeOf: function () {
281
+ return Object.getPrototypeOf(getModel());
282
+ },
283
+ has: function (_target, prop) {
284
+ return prop in getModel();
285
+ },
286
+ set: function (_target, prop, value) {
287
+ Reflect.set(getModel(), prop, value);
288
+ return true;
289
+ },
290
+ };
291
+ var LazyMongooseModel = /** @class */ (function () {
292
+ function LazyMongooseModel() {
293
+ }
294
+ return LazyMongooseModel;
295
+ }());
296
+ return new Proxy(LazyMongooseModel, handler);
297
+ };
298
+ /** Lazy so importing `@terreno/api` does not register Organization until first use. */
299
+ exports.Organization = createLazyModel(exports.getOrganizationModel);
300
+ /** Lazy so importing `@terreno/api` does not register Membership until first use. */
301
+ exports.Membership = createLazyModel(exports.getMembershipModel);
@@ -0,0 +1,19 @@
1
+ import mongoose from "mongoose";
2
+ import type { OrganizationSettings } from "../types/organization";
3
+ /**
4
+ * Build a nested Mongoose schema for `Organization.settings`.
5
+ * Fields should be optional or have defaults so existing organizations still validate.
6
+ */
7
+ export declare const createOrganizationSettingsSchema: (definition: mongoose.SchemaDefinition, options?: mongoose.SchemaOptions) => mongoose.Schema;
8
+ /** Register the app settings schema. Call before creating or patching organizations. */
9
+ export declare const registerOrganizationSettings: (schema?: mongoose.Schema) => void;
10
+ export declare const getOrganizationSettingsSchema: () => mongoose.Schema | undefined;
11
+ /**
12
+ * Validate and cast `Organization.settings` when a schema is registered.
13
+ * With no schema, Mixed values pass through unchanged.
14
+ */
15
+ export declare const applyOrganizationSettings: <TSettings extends OrganizationSettings = OrganizationSettings>(settings: unknown) => TSettings | undefined;
16
+ /** Read typed settings from an organization document or API payload. */
17
+ export declare const organizationSettingsOf: <TSettings extends OrganizationSettings = OrganizationSettings>(organization: {
18
+ settings?: TSettings | null;
19
+ }) => TSettings;
@@ -0,0 +1,120 @@
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 __importDefault = (this && this.__importDefault) || function (mod) {
14
+ return (mod && mod.__esModule) ? mod : { "default": mod };
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ exports.organizationSettingsOf = exports.applyOrganizationSettings = exports.getOrganizationSettingsSchema = exports.registerOrganizationSettings = exports.createOrganizationSettingsSchema = void 0;
18
+ var mongoose_1 = __importDefault(require("mongoose"));
19
+ var errors_1 = require("../errors");
20
+ var SETTINGS_VALIDATOR_MODEL = "__TerrenoOrganizationSettings";
21
+ var registeredOrganizationSettingsSchema;
22
+ var dropSettingsValidatorModel = function () {
23
+ var existing = mongoose_1.default.models[SETTINGS_VALIDATOR_MODEL];
24
+ if (existing) {
25
+ mongoose_1.default.deleteModel(SETTINGS_VALIDATOR_MODEL);
26
+ }
27
+ };
28
+ /**
29
+ * Build a nested Mongoose schema for `Organization.settings`.
30
+ * Fields should be optional or have defaults so existing organizations still validate.
31
+ */
32
+ var createOrganizationSettingsSchema = function (definition, options) {
33
+ return new mongoose_1.default.Schema(definition, __assign({ _id: false, id: false, strict: "throw" }, options));
34
+ };
35
+ exports.createOrganizationSettingsSchema = createOrganizationSettingsSchema;
36
+ /** Register the app settings schema. Call before creating or patching organizations. */
37
+ var registerOrganizationSettings = function (schema) {
38
+ dropSettingsValidatorModel();
39
+ registeredOrganizationSettingsSchema = schema;
40
+ };
41
+ exports.registerOrganizationSettings = registerOrganizationSettings;
42
+ var getOrganizationSettingsSchema = function () {
43
+ return registeredOrganizationSettingsSchema;
44
+ };
45
+ exports.getOrganizationSettingsSchema = getOrganizationSettingsSchema;
46
+ var settingsValidationMessage = function (error) {
47
+ if (error instanceof mongoose_1.default.Error.ValidationError) {
48
+ return Object.values(error.errors)
49
+ .map(function (fieldError) { return fieldError.message; })
50
+ .join("; ");
51
+ }
52
+ if (error instanceof Error) {
53
+ return error.message;
54
+ }
55
+ return "Organization settings are invalid";
56
+ };
57
+ var getSettingsValidatorModel = function (schema) {
58
+ var existing = mongoose_1.default.models[SETTINGS_VALIDATOR_MODEL];
59
+ if (existing) {
60
+ return existing;
61
+ }
62
+ return mongoose_1.default.model(SETTINGS_VALIDATOR_MODEL, schema, undefined, {
63
+ overwriteModels: true,
64
+ });
65
+ };
66
+ /**
67
+ * Validate and cast `Organization.settings` when a schema is registered.
68
+ * With no schema, Mixed values pass through unchanged.
69
+ */
70
+ var applyOrganizationSettings = function (settings) {
71
+ if (settings === undefined || settings === null) {
72
+ return undefined;
73
+ }
74
+ var schema = registeredOrganizationSettingsSchema;
75
+ if (!schema) {
76
+ return settings;
77
+ }
78
+ if (typeof settings !== "object" || Array.isArray(settings)) {
79
+ throw new errors_1.ValidationError({
80
+ fields: { settings: "Organization settings must be an object" },
81
+ title: "Organization settings must be an object",
82
+ });
83
+ }
84
+ try {
85
+ var unknownKeys = Object.keys(settings).filter(function (key) {
86
+ return schema.path(key) === undefined;
87
+ });
88
+ if (unknownKeys.length > 0) {
89
+ throw new errors_1.ValidationError({
90
+ fields: { settings: "Unknown settings field: ".concat(unknownKeys.join(", ")) },
91
+ title: "Organization settings are invalid",
92
+ });
93
+ }
94
+ var ValidatorModel = getSettingsValidatorModel(schema);
95
+ var document_1 = new ValidatorModel(settings);
96
+ var validationError = document_1.validateSync();
97
+ if (validationError) {
98
+ throw validationError;
99
+ }
100
+ return document_1.toObject({ versionKey: false });
101
+ }
102
+ catch (error) {
103
+ if (error instanceof errors_1.ValidationError) {
104
+ throw error;
105
+ }
106
+ throw new errors_1.ValidationError({
107
+ cause: error instanceof Error ? error : undefined,
108
+ detail: settingsValidationMessage(error),
109
+ fields: { settings: settingsValidationMessage(error) },
110
+ title: "Organization settings are invalid",
111
+ });
112
+ }
113
+ };
114
+ exports.applyOrganizationSettings = applyOrganizationSettings;
115
+ /** Read typed settings from an organization document or API payload. */
116
+ var organizationSettingsOf = function (organization) {
117
+ var _a;
118
+ return ((_a = organization.settings) !== null && _a !== void 0 ? _a : {});
119
+ };
120
+ exports.organizationSettingsOf = organizationSettingsOf;
@@ -0,0 +1,28 @@
1
+ import type express from "express";
2
+ import { type Application } from "express";
3
+ import type mongoose from "mongoose";
4
+ import { type UserModel } from "../auth";
5
+ import type { AnyTerrenoAccess } from "../rbac/types";
6
+ import type { TerrenoPlugin } from "../terrenoPlugin";
7
+ export interface OrgAuditEvent {
8
+ actorId?: string;
9
+ organizationId?: string;
10
+ organizationLabel?: string;
11
+ verb: "created" | "updated" | "disabled" | "deleted" | "memberAttached" | "memberUpdated" | "memberRemoved";
12
+ }
13
+ export interface OrgsAppOptions {
14
+ access: AnyTerrenoAccess;
15
+ basePath?: string;
16
+ onOrgAudit?: (event: OrgAuditEvent, req: express.Request) => void | Promise<void>;
17
+ /** Nested schema for `Organization.settings`. Same as `registerOrganizationSettings`. */
18
+ settingsSchema?: mongoose.Schema;
19
+ userModel: UserModel;
20
+ }
21
+ export declare class OrgsApp implements TerrenoPlugin {
22
+ private readonly access;
23
+ private readonly basePath;
24
+ private readonly onOrgAudit?;
25
+ private readonly userModel;
26
+ constructor(options: OrgsAppOptions);
27
+ register(app: Application, openApi?: unknown): void;
28
+ }