@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,376 @@
1
+ /**
2
+ * Tests for `terreno-migrate` argv parsing and command behavior.
3
+ */
4
+ import {beforeEach, describe, expect, it} from "bun:test";
5
+ import {mkdtemp, readdir, rm, writeFile} from "node:fs/promises";
6
+ import {tmpdir} from "node:os";
7
+ import {join} from "node:path";
8
+ import mongoose from "mongoose";
9
+
10
+ import {setupDb} from "../tests";
11
+ import {runMigrateCli} from "./cli";
12
+ import {MIGRATION_LOCK_ID, MIGRATIONS_COLLECTION} from "./types";
13
+
14
+ const fixtures = (...parts: string[]): string => {
15
+ return join(import.meta.dir, "fixtures", ...parts);
16
+ };
17
+
18
+ const capture = (): {
19
+ stderr: string;
20
+ stdout: string;
21
+ writeErr: (chunk: string) => void;
22
+ writeOut: (chunk: string) => void;
23
+ } => {
24
+ const out: string[] = [];
25
+ const err: string[] = [];
26
+ return {
27
+ get stderr(): string {
28
+ return err.join("");
29
+ },
30
+ get stdout(): string {
31
+ return out.join("");
32
+ },
33
+ writeErr: (chunk: string): void => {
34
+ err.push(chunk);
35
+ },
36
+ writeOut: (chunk: string): void => {
37
+ out.push(chunk);
38
+ },
39
+ };
40
+ };
41
+
42
+ const appliedIds = async (): Promise<string[]> => {
43
+ const docs = await mongoose.connection
44
+ .collection(MIGRATIONS_COLLECTION)
45
+ .find({_id: {$ne: MIGRATION_LOCK_ID}})
46
+ .project({id: 1})
47
+ .toArray();
48
+ return docs.map((doc) => String(doc.id)).sort();
49
+ };
50
+
51
+ describe("runMigrateCli", () => {
52
+ beforeEach(async () => {
53
+ await setupDb();
54
+ await mongoose.connection.collection(MIGRATIONS_COLLECTION).deleteMany({});
55
+ });
56
+
57
+ it("prints usage when no command is given", async () => {
58
+ const io = capture();
59
+ const code = await runMigrateCli({
60
+ argv: [],
61
+ stderr: {write: io.writeErr},
62
+ stdout: {write: io.writeOut},
63
+ });
64
+ expect(code).toBe(1);
65
+ expect(io.stderr).toContain("terreno-migrate");
66
+ });
67
+
68
+ it("rejects unknown flags from parseArgs", async () => {
69
+ const io = capture();
70
+ const code = await runMigrateCli({
71
+ argv: ["check", "--bogus"],
72
+ stderr: {write: io.writeErr},
73
+ stdout: {write: io.writeOut},
74
+ });
75
+ expect(code).toBe(1);
76
+ expect(io.stderr).toContain("terreno-migrate");
77
+ });
78
+
79
+ it("rejects unknown commands", async () => {
80
+ const io = capture();
81
+ const code = await runMigrateCli({
82
+ argv: ["explode"],
83
+ stderr: {write: io.writeErr},
84
+ stdout: {write: io.writeOut},
85
+ });
86
+ expect(code).toBe(1);
87
+ expect(io.stderr).toContain("Unknown command explode");
88
+ });
89
+
90
+ it("requires a Mongo URI when mongoose is not injected", async () => {
91
+ const io = capture();
92
+ const code = await runMigrateCli({
93
+ argv: ["status", "--dir", fixtures("valid")],
94
+ env: {},
95
+ stderr: {write: io.writeErr},
96
+ stdout: {write: io.writeOut},
97
+ });
98
+ expect(code).toBe(1);
99
+ expect(io.stderr).toContain("Missing Mongo URI");
100
+ });
101
+
102
+ it("prints usage on --help and exits 0", async () => {
103
+ const io = capture();
104
+ const code = await runMigrateCli({
105
+ argv: ["--help"],
106
+ stderr: {write: io.writeErr},
107
+ stdout: {write: io.writeOut},
108
+ });
109
+ expect(code).toBe(0);
110
+ expect(`${io.stdout}${io.stderr}`).toContain("terreno-migrate");
111
+ expect(`${io.stdout}${io.stderr}`).toContain("check");
112
+ });
113
+
114
+ it("generate without --models exits 1", async () => {
115
+ const io = capture();
116
+ const code = await runMigrateCli({
117
+ argv: ["generate", "--dir", fixtures("valid")],
118
+ stderr: {write: io.writeErr},
119
+ stdout: {write: io.writeOut},
120
+ });
121
+ expect(code).toBe(1);
122
+ expect(io.stderr).toContain("Missing --models");
123
+ });
124
+
125
+ it("generate reports when the models module exports none", async () => {
126
+ const dir = await mkdtemp(join(tmpdir(), "migrate-cli-gen-"));
127
+ const modelsDir = await mkdtemp(join(tmpdir(), "migrate-cli-models-"));
128
+ try {
129
+ const modelsPath = join(modelsDir, "scalar.ts");
130
+ await writeFile(modelsPath, "export default 1;\n");
131
+ const namedPath = join(modelsDir, "named.ts");
132
+ await writeFile(namedPath, "export const extra = {foo: 1};\n");
133
+ const arrayPath = join(modelsDir, "array.ts");
134
+ await writeFile(arrayPath, 'export default [{name: "not-a-model"}];\n');
135
+ const bagPath = join(modelsDir, "bag.ts");
136
+ await writeFile(bagPath, 'export default {models: [{name: "not-a-model"}]};\n');
137
+ const fakeModelPath = join(modelsDir, "fake-model.ts");
138
+ await writeFile(
139
+ fakeModelPath,
140
+ `export default [{
141
+ collection: {collectionName: "fake_cli"},
142
+ modelName: "FakeCliModel",
143
+ schema: {indexes: () => [], paths: {}},
144
+ }];
145
+ `
146
+ );
147
+
148
+ for (const path of [modelsPath, namedPath, arrayPath, bagPath]) {
149
+ const io = capture();
150
+ const code = await runMigrateCli({
151
+ argv: ["generate", "--dir", dir, "--models", path, "--name", "init"],
152
+ stderr: {write: io.writeErr},
153
+ stdout: {write: io.writeOut},
154
+ });
155
+ expect(code).toBe(1);
156
+ expect(io.stderr).toContain("No Mongoose models found");
157
+ }
158
+
159
+ const fakeIo = capture();
160
+ const fakeCode = await runMigrateCli({
161
+ argv: ["generate", "--dir", dir, "--models", fakeModelPath, "--name", "init"],
162
+ stderr: {write: fakeIo.writeErr},
163
+ stdout: {write: fakeIo.writeOut},
164
+ });
165
+ expect(fakeCode).toBe(0);
166
+ expect(fakeIo.stdout).toContain("No schema changes");
167
+ } finally {
168
+ await rm(dir, {force: true, recursive: true});
169
+ await rm(modelsDir, {force: true, recursive: true});
170
+ }
171
+ });
172
+
173
+ it("generate writes a migration file for real Mongoose models", async () => {
174
+ const dir = await mkdtemp(join(tmpdir(), "migrate-cli-gen-"));
175
+ const modelsDir = await mkdtemp(join(tmpdir(), "migrate-cli-models-"));
176
+ try {
177
+ const modelsPath = join(modelsDir, "models.ts");
178
+ const mongooseUrl = import.meta.resolve("mongoose");
179
+ await writeFile(
180
+ modelsPath,
181
+ `import mongoose from ${JSON.stringify(mongooseUrl)};
182
+
183
+ const schema = new mongoose.Schema(
184
+ {title: {description: "Title", required: true, type: String}},
185
+ {collection: "cli_gen_todos"}
186
+ );
187
+ export const CliGenTodo = mongoose.models.CliGenTodo ?? mongoose.model("CliGenTodo", schema);
188
+ `
189
+ );
190
+
191
+ const io = capture();
192
+ const code = await runMigrateCli({
193
+ argv: ["generate", "--dir", dir, "--models", modelsPath, "--name", "init"],
194
+ stderr: {write: io.writeErr},
195
+ stdout: {write: io.writeOut},
196
+ });
197
+ expect(io.stderr).toBe("");
198
+ expect(code).toBe(0);
199
+ expect(io.stdout).toMatch(/^Wrote .*-init\.ts\n$/);
200
+ const files = await readdir(dir);
201
+ expect(files).toHaveLength(1);
202
+ expect(files[0]).toEndWith("-init.ts");
203
+
204
+ const checkIo = capture();
205
+ expect(
206
+ await runMigrateCli({
207
+ argv: ["check", "--dir", dir],
208
+ stderr: {write: checkIo.writeErr},
209
+ stdout: {write: checkIo.writeOut},
210
+ })
211
+ ).toBe(0);
212
+ expect(checkIo.stdout).toContain("OK 1 migration(s)");
213
+ } finally {
214
+ await rm(dir, {force: true, recursive: true});
215
+ await rm(modelsDir, {force: true, recursive: true});
216
+ }
217
+ });
218
+
219
+ it("connects and disconnects itself when given a Mongo URI", async () => {
220
+ const {host, name, port} = mongoose.connection;
221
+ const uri = `mongodb://${host}:${port}/${name}`;
222
+ await mongoose.disconnect();
223
+ expect(mongoose.connection.readyState).toBe(0);
224
+
225
+ try {
226
+ const io = capture();
227
+ const code = await runMigrateCli({
228
+ argv: ["status", "--dir", fixtures("valid")],
229
+ env: {MONGODB_URI: uri, NODE_ENV: "test"},
230
+ stderr: {write: io.writeErr},
231
+ stdout: {write: io.writeOut},
232
+ });
233
+ expect(code).toBe(0);
234
+ expect(io.stdout).toContain("Applied (0)");
235
+ expect(io.stdout).toContain("Pending (2)");
236
+ expect(mongoose.connection.readyState).toBe(0);
237
+ } finally {
238
+ await mongoose.connect(uri);
239
+ }
240
+ });
241
+
242
+ it("writes help to process stdout when io is omitted", async () => {
243
+ expect(await runMigrateCli({argv: ["--help"]})).toBe(0);
244
+ expect(await runMigrateCli({argv: ["nope"]})).toBe(1);
245
+ });
246
+
247
+ it("check validates files without Mongo", async () => {
248
+ const io = capture();
249
+ const code = await runMigrateCli({
250
+ argv: ["check", "--dir", fixtures("valid")],
251
+ stderr: {write: io.writeErr},
252
+ stdout: {write: io.writeOut},
253
+ });
254
+ expect(code).toBe(0);
255
+ expect(io.stdout).toContain("20260910120000-alpha");
256
+ });
257
+
258
+ it("dry up calls pending files and does not write history", async () => {
259
+ const io = capture();
260
+ const code = await runMigrateCli({
261
+ argv: ["up", "--dir", fixtures("valid"), "--dry"],
262
+ mongoose,
263
+ stderr: {write: io.writeErr},
264
+ stdout: {write: io.writeOut},
265
+ });
266
+ expect(code).toBe(0);
267
+ expect(io.stdout).toContain("20260910120000-alpha");
268
+ expect(await appliedIds()).toEqual([]);
269
+ });
270
+
271
+ it("denies production wet up without ALLOW_MIGRATIONS", async () => {
272
+ const io = capture();
273
+ const code = await runMigrateCli({
274
+ argv: ["up", "--dir", fixtures("valid"), "--force"],
275
+ env: {NODE_ENV: "production"},
276
+ mongoose,
277
+ stderr: {write: io.writeErr},
278
+ stdout: {write: io.writeOut},
279
+ });
280
+ expect(code).toBe(1);
281
+ expect(io.stderr).toContain("Migrations not allowed");
282
+ expect(await appliedIds()).toEqual([]);
283
+ });
284
+
285
+ it("denies production wet up when ALLOW_MIGRATIONS is set without --force", async () => {
286
+ const io = capture();
287
+ const code = await runMigrateCli({
288
+ argv: ["up", "--dir", fixtures("valid")],
289
+ env: {ALLOW_MIGRATIONS: "true", NODE_ENV: "production"},
290
+ mongoose,
291
+ stderr: {write: io.writeErr},
292
+ stdout: {write: io.writeOut},
293
+ });
294
+ expect(code).toBe(1);
295
+ expect(io.stderr).toContain("Migrations not allowed");
296
+ });
297
+
298
+ it("status lists pending files before up", async () => {
299
+ const io = capture();
300
+ const code = await runMigrateCli({
301
+ argv: ["status", "--dir", fixtures("valid")],
302
+ env: {NODE_ENV: "test"},
303
+ mongoose,
304
+ stderr: {write: io.writeErr},
305
+ stdout: {write: io.writeOut},
306
+ });
307
+ expect(code).toBe(0);
308
+ expect(io.stdout).toContain("Pending (2)");
309
+ expect(io.stdout).toContain("20260910120000-alpha");
310
+ });
311
+
312
+ it("applies then rolls back against Mongo", async () => {
313
+ const upIo = capture();
314
+ const upCode = await runMigrateCli({
315
+ argv: ["up", "--dir", fixtures("valid")],
316
+ env: {NODE_ENV: "test"},
317
+ mongoose,
318
+ stderr: {write: upIo.writeErr},
319
+ stdout: {write: upIo.writeOut},
320
+ });
321
+ expect(upCode).toBe(0);
322
+ expect(await appliedIds()).toEqual(["20260910120000-alpha", "20260910120001-beta"]);
323
+
324
+ const downIo = capture();
325
+ const downCode = await runMigrateCli({
326
+ argv: ["down", "--dir", fixtures("valid"), "--steps", "1"],
327
+ env: {NODE_ENV: "test"},
328
+ mongoose,
329
+ stderr: {write: downIo.writeErr},
330
+ stdout: {write: downIo.writeOut},
331
+ });
332
+ expect(downCode).toBe(0);
333
+ expect(await appliedIds()).toEqual(["20260910120000-alpha"]);
334
+
335
+ const statusIo = capture();
336
+ const statusCode = await runMigrateCli({
337
+ argv: ["status", "--dir", fixtures("valid")],
338
+ env: {NODE_ENV: "test"},
339
+ mongoose,
340
+ stderr: {write: statusIo.writeErr},
341
+ stdout: {write: statusIo.writeOut},
342
+ });
343
+ expect(statusCode).toBe(0);
344
+ expect(statusIo.stdout).toContain("Applied (1)\n20260910120000-alpha\n");
345
+ expect(statusIo.stdout).toContain("Pending (1)\n20260910120001-beta\n");
346
+ });
347
+
348
+ it("fails down when the target file has no down", async () => {
349
+ await runMigrateCli({
350
+ argv: ["up", "--dir", fixtures("valid")],
351
+ env: {NODE_ENV: "test"},
352
+ mongoose,
353
+ stderr: {write: () => undefined},
354
+ stdout: {write: () => undefined},
355
+ });
356
+ await runMigrateCli({
357
+ argv: ["down", "--dir", fixtures("valid"), "--steps", "1"],
358
+ env: {NODE_ENV: "test"},
359
+ mongoose,
360
+ stderr: {write: () => undefined},
361
+ stdout: {write: () => undefined},
362
+ });
363
+
364
+ const io = capture();
365
+ const code = await runMigrateCli({
366
+ argv: ["down", "--dir", fixtures("valid"), "--steps", "1"],
367
+ env: {NODE_ENV: "test"},
368
+ mongoose,
369
+ stderr: {write: io.writeErr},
370
+ stdout: {write: io.writeOut},
371
+ });
372
+ expect(code).toBe(1);
373
+ expect(io.stderr).toContain("has no down");
374
+ expect(await appliedIds()).toEqual(["20260910120000-alpha"]);
375
+ });
376
+ });
@@ -0,0 +1,283 @@
1
+ #!/usr/bin/env bun
2
+ /**
3
+ * `terreno-migrate` CLI: check, generate, status, up, and down. Production wet
4
+ * up/down requires ALLOW_MIGRATIONS=true and `--force`.
5
+ */
6
+ import {isAbsolute, resolve} from "node:path";
7
+ import {pathToFileURL} from "node:url";
8
+ import {parseArgs} from "node:util";
9
+ import type {Model, Document as MongooseDocument} from "mongoose";
10
+ import mongoose from "mongoose";
11
+
12
+ import {APIError} from "../errors";
13
+ import {logger} from "../logger";
14
+ import {generateMigration} from "./generate";
15
+ import {checkMigrationFiles} from "./load";
16
+ import {
17
+ assertMigrationsAllowed,
18
+ getMigrationStatus,
19
+ runDownMigrations,
20
+ runMigrations,
21
+ } from "./runner";
22
+
23
+ const USAGE = `Usage: terreno-migrate <command> [options]
24
+
25
+ Commands:
26
+ check Validate migration files (no Mongo)
27
+ generate Write a timestamped file from the model vs schemaAfter diff
28
+ status List applied and pending migrations
29
+ up Apply pending migrations
30
+ down Roll back applied migrations
31
+
32
+ Options:
33
+ --dir <path> Migration directory (default: ./migrations)
34
+ --models <path> Module exporting models or {models} (generate)
35
+ --name <slug> Filename slug for generate (default: auto)
36
+ --dry Call up/down with dryRun true; do not write history
37
+ --force Required for production wet up/down (with ALLOW_MIGRATIONS=true)
38
+ --steps <n> Number of applied migrations to roll back (down only, default 1)
39
+ --help Show this help
40
+ `;
41
+
42
+ export interface MigrateCliIo {
43
+ write: (chunk: string) => void;
44
+ }
45
+
46
+ export interface RunMigrateCliOptions {
47
+ argv: string[];
48
+ env?: NodeJS.ProcessEnv;
49
+ mongoose?: typeof mongoose;
50
+ stdout?: MigrateCliIo;
51
+ stderr?: MigrateCliIo;
52
+ }
53
+
54
+ const writeLine = (io: MigrateCliIo, line: string): void => {
55
+ io.write(`${line}\n`);
56
+ };
57
+
58
+ const errorMessage = (error: unknown): string => {
59
+ if (error instanceof APIError) {
60
+ return error.detail ? `${error.title}: ${error.detail}` : error.title;
61
+ }
62
+ if (error instanceof Error) {
63
+ return error.message;
64
+ }
65
+ return String(error);
66
+ };
67
+
68
+ const isMongooseModel = (value: unknown): value is Model<MongooseDocument> => {
69
+ if ((typeof value !== "object" && typeof value !== "function") || value === null) {
70
+ return false;
71
+ }
72
+ return "schema" in value && "modelName" in value;
73
+ };
74
+
75
+ const collectModels = (mod: unknown): Model<MongooseDocument>[] => {
76
+ if (Array.isArray(mod)) {
77
+ return mod.filter(isMongooseModel);
78
+ }
79
+ if (typeof mod !== "object" || mod === null) {
80
+ return [];
81
+ }
82
+ const record = mod as Record<string, unknown>;
83
+ if (Array.isArray(record.models)) {
84
+ return record.models.filter(isMongooseModel);
85
+ }
86
+ return Object.values(record).filter(isMongooseModel);
87
+ };
88
+
89
+ const loadModelsModule = async (modulePath: string): Promise<Model<MongooseDocument>[]> => {
90
+ const resolved = isAbsolute(modulePath) ? modulePath : resolve(modulePath);
91
+ const imported = (await import(pathToFileURL(resolved).href)) as Record<string, unknown>;
92
+ const fromDefault = collectModels(imported.default);
93
+ if (fromDefault.length > 0) {
94
+ return fromDefault;
95
+ }
96
+ return collectModels(imported);
97
+ };
98
+
99
+ export const runMigrateCli = async ({
100
+ argv,
101
+ env = process.env,
102
+ mongoose: mongooseNs,
103
+ stderr = {write: (chunk: string) => process.stderr.write(chunk)},
104
+ stdout = {write: (chunk: string) => process.stdout.write(chunk)},
105
+ }: RunMigrateCliOptions): Promise<number> => {
106
+ let values: {
107
+ dir?: string;
108
+ dry?: boolean;
109
+ force?: boolean;
110
+ help?: boolean;
111
+ models?: string;
112
+ name?: string;
113
+ steps?: string;
114
+ };
115
+ let positionals: string[];
116
+ try {
117
+ const parsed = parseArgs({
118
+ allowPositionals: true,
119
+ args: argv,
120
+ options: {
121
+ dir: {type: "string"},
122
+ dry: {default: false, type: "boolean"},
123
+ force: {default: false, type: "boolean"},
124
+ help: {default: false, type: "boolean"},
125
+ models: {type: "string"},
126
+ name: {type: "string"},
127
+ steps: {type: "string"},
128
+ },
129
+ strict: true,
130
+ });
131
+ values = parsed.values;
132
+ positionals = parsed.positionals;
133
+ } catch (error) {
134
+ writeLine(stderr, errorMessage(error));
135
+ writeLine(stderr, USAGE);
136
+ return 1;
137
+ }
138
+
139
+ if (values.help) {
140
+ writeLine(stdout, USAGE);
141
+ return 0;
142
+ }
143
+
144
+ const command = positionals[0];
145
+ if (!command) {
146
+ writeLine(stderr, USAGE);
147
+ return 1;
148
+ }
149
+
150
+ const dir = values.dir ?? "./migrations";
151
+ const dryRun = values.dry === true;
152
+ const force = values.force === true;
153
+
154
+ try {
155
+ if (command === "check") {
156
+ const loaded = await checkMigrationFiles({dir});
157
+ writeLine(stdout, `OK ${loaded.length} migration(s)`);
158
+ for (const migration of loaded) {
159
+ writeLine(stdout, migration.id);
160
+ }
161
+ return 0;
162
+ }
163
+
164
+ if (command === "generate") {
165
+ if (!values.models) {
166
+ throw new APIError({
167
+ detail: "Pass --models <module> that exports models",
168
+ status: 400,
169
+ title: "Missing --models",
170
+ });
171
+ }
172
+ const models = await loadModelsModule(values.models);
173
+ const result = await generateMigration({
174
+ dir,
175
+ models,
176
+ name: values.name,
177
+ });
178
+ if (result.noop) {
179
+ writeLine(stdout, "No schema changes");
180
+ return 0;
181
+ }
182
+ writeLine(stdout, `Wrote ${result.path}`);
183
+ return 0;
184
+ }
185
+
186
+ if (command !== "status" && command !== "up" && command !== "down") {
187
+ writeLine(stderr, `Unknown command ${command}`);
188
+ writeLine(stderr, USAGE);
189
+ return 1;
190
+ }
191
+
192
+ if (command === "up" || command === "down") {
193
+ assertMigrationsAllowed({
194
+ allowEnv: env.ALLOW_MIGRATIONS === "true",
195
+ dryRun,
196
+ force,
197
+ isProduction: env.NODE_ENV === "production",
198
+ });
199
+ }
200
+
201
+ let connectedHere = false;
202
+ const mongooseLib = mongooseNs ?? mongoose;
203
+ if (mongooseNs == null) {
204
+ const uri = env.MONGO_URI ?? env.MONGODB_URI;
205
+ if (!uri) {
206
+ throw new APIError({
207
+ detail: "Set MONGO_URI or MONGODB_URI",
208
+ status: 400,
209
+ title: "Missing Mongo URI",
210
+ });
211
+ }
212
+ await mongooseLib.connect(uri);
213
+ connectedHere = true;
214
+ }
215
+
216
+ try {
217
+ const migrations = await checkMigrationFiles({dir});
218
+ const connection = mongooseLib.connection;
219
+
220
+ if (command === "status") {
221
+ const status = await getMigrationStatus({connection, migrations});
222
+ writeLine(stdout, `Applied (${status.applied.length})`);
223
+ for (const row of status.applied) {
224
+ writeLine(stdout, row.id);
225
+ }
226
+ writeLine(stdout, `Pending (${status.pending.length})`);
227
+ for (const row of status.pending) {
228
+ writeLine(stdout, row.id);
229
+ }
230
+ return 0;
231
+ }
232
+
233
+ if (command === "up") {
234
+ const result = await runMigrations({
235
+ connection,
236
+ dryRun,
237
+ logger,
238
+ migrations,
239
+ mongoose: mongooseLib,
240
+ });
241
+ writeLine(
242
+ stdout,
243
+ dryRun ? `Dry-run applied ${result.applied.length}` : `Applied ${result.applied.length}`
244
+ );
245
+ for (const id of result.applied) {
246
+ writeLine(stdout, id);
247
+ }
248
+ return 0;
249
+ }
250
+
251
+ const steps = values.steps == null ? 1 : Number(values.steps);
252
+ const result = await runDownMigrations({
253
+ connection,
254
+ dryRun,
255
+ logger,
256
+ migrations,
257
+ mongoose: mongooseLib,
258
+ steps,
259
+ });
260
+ writeLine(
261
+ stdout,
262
+ dryRun ? `Dry-run reversed ${result.reversed.length}` : `Reversed ${result.reversed.length}`
263
+ );
264
+ for (const id of result.reversed) {
265
+ writeLine(stdout, id);
266
+ }
267
+ return 0;
268
+ } finally {
269
+ if (connectedHere) {
270
+ await mongooseLib.disconnect();
271
+ }
272
+ }
273
+ } catch (error) {
274
+ writeLine(stderr, errorMessage(error));
275
+ return 1;
276
+ }
277
+ };
278
+
279
+ if (import.meta.main) {
280
+ void runMigrateCli({argv: process.argv.slice(2)}).then((code) => {
281
+ process.exit(code);
282
+ });
283
+ }
@@ -0,0 +1,6 @@
1
+ /** Loader fixture: reversible file used to prove full up-then-down exercise. */
2
+ export const id = "20260910120000-one";
3
+
4
+ export const up = async (): Promise<void> => undefined;
5
+
6
+ export const down = async (): Promise<void> => undefined;
@@ -0,0 +1,6 @@
1
+ /** Loader fixture: second reversible file in the all-down pair. */
2
+ export const id = "20260910120001-two";
3
+
4
+ export const up = async (): Promise<void> => undefined;
5
+
6
+ export const down = async (): Promise<void> => undefined;
@@ -0,0 +1,4 @@
1
+ /** Loader fixture: filename is valid but exported `id` does not match the stem. */
2
+ export const id = "wrong-id";
3
+
4
+ export const up = async (): Promise<void> => undefined;
@@ -0,0 +1,4 @@
1
+ /** Loader fixture: filename is not `YYYYMMDDHHmmss-slug.ts`. */
2
+ export const id = "not-a-migration";
3
+
4
+ export const up = async (): Promise<void> => undefined;
@@ -0,0 +1,2 @@
1
+ /** Loader fixture: valid filename/id but missing required `up` export. */
2
+ export const id = "20260910120000-noup";
@@ -0,0 +1,4 @@
1
+ /** Loader fixture: irreversible (no `down`), first in the valid pair. */
2
+ export const id = "20260910120000-alpha";
3
+
4
+ export const up = async (): Promise<void> => undefined;
@@ -0,0 +1,6 @@
1
+ /** Loader fixture: reversible (`down` present), second in the valid pair. */
2
+ export const id = "20260910120001-beta";
3
+
4
+ export const up = async (): Promise<void> => undefined;
5
+
6
+ export const down = async (): Promise<void> => undefined;