@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,51 @@
1
+ import {NotificationPreference} from "../models/notificationPreference";
2
+ import type {NotificationPreferenceChannel} from "../types/notificationPreference";
3
+
4
+ export type NotificationsBeforeSendChannel = "mail" | "push" | "sms" | "verification";
5
+
6
+ export interface NotificationsBeforeSendContext {
7
+ channel: NotificationsBeforeSendChannel;
8
+ userId?: string;
9
+ }
10
+
11
+ export interface NotificationsBeforeSendResult {
12
+ cancel?: boolean;
13
+ }
14
+
15
+ const PREFERENCE_FIELD_BY_CHANNEL: Partial<
16
+ Record<NotificationsBeforeSendChannel, NotificationPreferenceChannel>
17
+ > = {
18
+ mail: "mail",
19
+ push: "push",
20
+ sms: "sms",
21
+ };
22
+
23
+ /**
24
+ * Duck-typed CommsApp `beforeSend` hook that cancels outbound delivery when the user
25
+ * disabled that channel in NotificationPreference. Missing preference rows default to
26
+ * all channels on. The `verification` channel is never cancelled here.
27
+ */
28
+ export const notificationsBeforeSend = async ({
29
+ channel,
30
+ userId,
31
+ }: NotificationsBeforeSendContext): Promise<NotificationsBeforeSendResult | undefined> => {
32
+ if (channel === "verification" || !userId) {
33
+ return undefined;
34
+ }
35
+
36
+ const preferenceField = PREFERENCE_FIELD_BY_CHANNEL[channel];
37
+ if (!preferenceField) {
38
+ return undefined;
39
+ }
40
+
41
+ const preference = await NotificationPreference.findOneOrNone({ownerId: userId});
42
+ if (!preference) {
43
+ return undefined;
44
+ }
45
+
46
+ if (preference[preferenceField] === false) {
47
+ return {cancel: true};
48
+ }
49
+
50
+ return undefined;
51
+ };
@@ -391,7 +391,6 @@ describe("openApi populate", () => {
391
391
  $ref: "#/components/schemas/LimitedUser",
392
392
  },
393
393
  },
394
- required: [],
395
394
  type: "object",
396
395
  },
397
396
  type: "array",
package/src/openApi.ts CHANGED
@@ -15,7 +15,7 @@ const m2sOptions = {
15
15
  props: ["readOnly", "required", "enum", "default"],
16
16
  };
17
17
 
18
- export const apiErrorContent = {
18
+ const apiErrorContent = {
19
19
  "application/json": {
20
20
  schema: {$ref: "#/components/schemas/APIError"},
21
21
  },
@@ -491,6 +491,7 @@ export const deleteOpenApiMiddleware = <T>(
491
491
 
492
492
  // This is a generic OpenAPI wrapper for a read that returns any object described by `properties`.
493
493
  // Useful for endpoints that don't directly map to a model.
494
+ /** @internal */
494
495
  export const readOpenApiMiddleware = <T>(
495
496
  options: Partial<ModelRouterOptions<T>>,
496
497
  properties: Record<string, unknown>,
@@ -118,19 +118,30 @@ const composeRequestHandlers = (handlers: express.RequestHandler[]): express.Req
118
118
  */
119
119
  export interface OpenApiSchemaProperty {
120
120
  /** The JSON Schema type (e.g., "string", "number", "boolean", "object", "array") */
121
- type: string;
121
+ type?: string;
122
+ /** JSON Schema oneOf for query operators (scalar or Mongo-style object). */
123
+ oneOf?: OpenApiSchemaProperty[];
122
124
  /** Human-readable description of the property */
123
125
  description?: string;
126
+ /** Allowed values for string/number enums in query validation. */
127
+ enum?: string[];
124
128
  /** Format hint for the type (e.g., "date-time", "email", "uri", "uuid") */
125
129
  format?: string;
126
130
  /** Schema for array items when type is "array" */
127
131
  items?: OpenApiSchemaProperty;
132
+ /** Minimum array length when type is "array". */
133
+ minItems?: number;
128
134
  /** Nested properties when type is "object" */
129
135
  properties?: Record<string, OpenApiSchemaProperty>;
130
136
  /** Schema for additional properties or boolean to allow/disallow them */
131
137
  additionalProperties?: OpenApiSchemaProperty | boolean;
132
- /** Whether this property is required in the parent object */
133
- required?: boolean;
138
+ /**
139
+ * Property-level required flag, or object-schema required key list for nested
140
+ * operator shapes (`{$in: ...}`, `{$regex: ...}`).
141
+ */
142
+ required?: boolean | string[];
143
+ /** When true, string values must be escaped regex literals (query `$regex` operator). */
144
+ escapedRegexLiteral?: boolean;
134
145
  }
135
146
 
136
147
  /**
@@ -1,7 +1,9 @@
1
1
  import {afterEach, beforeEach, describe, expect, it} from "bun:test";
2
2
  import type {ErrorObject} from "ajv";
3
3
  import type {NextFunction, Request, Response} from "express";
4
+ import mongoose from "mongoose";
4
5
 
6
+ import {ADMIN_LIST_CHOICE_EMPTY_VALUE} from "./adminTypes";
5
7
  import {modelRouter} from "./api";
6
8
  import {type UserModel as AuthUserModel, addAuthRoutes, setupAuth} from "./auth";
7
9
  import type {OpenApiSchemaProperty} from "./openApiBuilder";
@@ -12,6 +14,7 @@ import {
12
14
  createValidator,
13
15
  getOpenApiValidatorConfig,
14
16
  getSchemaFromModel,
17
+ isEscapedRegexLiteral,
15
18
  isOpenApiValidatorConfigured,
16
19
  resetOpenApiValidatorConfig,
17
20
  validateModelRequestBody,
@@ -111,6 +114,22 @@ describe("openApiValidator", () => {
111
114
  const res = await admin.post("/required").send({about: "no name"}).expect(400);
112
115
  expect(res.body.title).toBe("Request validation failed");
113
116
  });
117
+
118
+ it("allows PATCH bodies that omit mongoose required fields", async () => {
119
+ configureOpenApiValidator();
120
+
121
+ const freshApp = await setupFreshApp();
122
+ freshApp.use("/required", modelRouter(RequiredModel, requiredRouterOptions));
123
+ const admin = await authAsUser(freshApp, "admin");
124
+ const created = await admin.post("/required").send({name: "Apple"}).expect(201);
125
+
126
+ const patched = await admin
127
+ .patch(`/required/${created.body.data._id}`)
128
+ .send({about: "partial"})
129
+ .expect(200);
130
+ expect(patched.body.data.name).toBe("Apple");
131
+ expect(patched.body.data.about).toBe("partial");
132
+ });
114
133
  });
115
134
 
116
135
  describe("onAdditionalPropertiesRemoved hook", () => {
@@ -266,9 +285,133 @@ describe("openApiValidator", () => {
266
285
  expect(schema.hidden).toBeUndefined();
267
286
  });
268
287
 
269
- it("marks query fields as not required", () => {
288
+ it("does not mark query fields as required", () => {
270
289
  const schema = buildQuerySchemaFromFields(FoodModel, ["name"]);
271
- expect(schema.name.required).toBe(false);
290
+ expect(schema.name.required).toBeUndefined();
291
+ });
292
+ });
293
+
294
+ describe("choice list query validation", () => {
295
+ const priorityListSchema = new mongoose.Schema({
296
+ name: {required: true, type: String},
297
+ priority: {enum: ["low", "high"], type: String},
298
+ });
299
+ const PriorityListModel =
300
+ mongoose.models.OpenApiPriorityList ??
301
+ mongoose.model("OpenApiPriorityList", priorityListSchema);
302
+
303
+ const assertQueryAccepted = (query: Record<string, unknown>): void => {
304
+ configureOpenApiValidator({coerceTypes: true});
305
+ const schema = buildQuerySchemaFromFields(PriorityListModel, ["priority"]);
306
+ const middleware = validateQueryParams(schema);
307
+ let nextCalled = false;
308
+ const req = {method: "GET", path: "/test", query: {...query}} as unknown as Request;
309
+ middleware(req, {} as Response, () => {
310
+ nextCalled = true;
311
+ });
312
+ expect(nextCalled).toBe(true);
313
+ };
314
+
315
+ it("accepts scalar and $in choice query shapes", () => {
316
+ assertQueryAccepted({limit: "25", page: "1", priority: "high"});
317
+ assertQueryAccepted({limit: "25", page: "1", priority: {$in: ["high"]}});
318
+ assertQueryAccepted({
319
+ limit: "25",
320
+ page: "1",
321
+ priority: {$in: ["high", ADMIN_LIST_CHOICE_EMPTY_VALUE]},
322
+ });
323
+ });
324
+
325
+ it("rejects invalid choice query shapes", () => {
326
+ configureOpenApiValidator({coerceTypes: true});
327
+ const schema = buildQuerySchemaFromFields(PriorityListModel, ["priority"]);
328
+ const middleware = validateQueryParams(schema);
329
+ const req = {
330
+ method: "GET",
331
+ path: "/test",
332
+ query: {limit: "25", page: "1", priority: {$in: ["high", "missing"]}},
333
+ } as unknown as Request;
334
+
335
+ expect(() => {
336
+ middleware(req, {} as Response, () => {});
337
+ }).toThrow();
338
+ });
339
+ });
340
+
341
+ describe("isEscapedRegexLiteral", () => {
342
+ it("accepts literal text and escaped metacharacters", () => {
343
+ expect(isEscapedRegexLiteral("alice")).toBe(true);
344
+ expect(isEscapedRegexLiteral("\\.\\*")).toBe(true);
345
+ });
346
+
347
+ it("rejects executable regex patterns", () => {
348
+ expect(isEscapedRegexLiteral(".*")).toBe(false);
349
+ expect(isEscapedRegexLiteral("^x")).toBe(false);
350
+ expect(isEscapedRegexLiteral("[a-z]")).toBe(false);
351
+ });
352
+ });
353
+
354
+ describe("query operator hardening", () => {
355
+ const assertQueryRejected = (query: Record<string, unknown>): void => {
356
+ configureOpenApiValidator({coerceTypes: true, removeAdditional: false});
357
+ const schema = buildQuerySchemaFromFields(FoodModel, ["name"]);
358
+ const middleware = validateQueryParams(schema);
359
+ const req = {method: "GET", path: "/test", query: {...query}} as unknown as Request;
360
+
361
+ expect(() => {
362
+ middleware(req, {} as Response, () => {});
363
+ }).toThrow();
364
+ };
365
+
366
+ const assertQueryAccepted = (query: Record<string, unknown>): void => {
367
+ configureOpenApiValidator({coerceTypes: true, removeAdditional: false});
368
+ const schema = buildQuerySchemaFromFields(FoodModel, ["name"]);
369
+ const middleware = validateQueryParams(schema);
370
+ let nextCalled = false;
371
+ const req = {method: "GET", path: "/test", query: {...query}} as unknown as Request;
372
+ middleware(req, {} as Response, () => {
373
+ nextCalled = true;
374
+ });
375
+ expect(nextCalled).toBe(true);
376
+ };
377
+
378
+ it("accepts escaped literal regex operators", () => {
379
+ assertQueryAccepted({
380
+ name: {$options: "i", $regex: "Green Beans"},
381
+ });
382
+ assertQueryAccepted({
383
+ name: {$options: "i", $regex: "\\.\\*"},
384
+ });
385
+ });
386
+
387
+ it("rejects executable regex operators even when removeAdditional is false", () => {
388
+ assertQueryRejected({
389
+ name: {$options: "i", $regex: ".*"},
390
+ });
391
+ assertQueryRejected({
392
+ name: {$options: "i", $regex: "^x"},
393
+ });
394
+ });
395
+
396
+ it("rejects extra nested operators on $in objects", () => {
397
+ assertQueryRejected({
398
+ name: {$in: ["Apple"], $ne: "Banana"},
399
+ });
400
+ });
401
+
402
+ it("rejects extra nested operators on range objects", () => {
403
+ configureOpenApiValidator({coerceTypes: true, removeAdditional: false});
404
+ const schema = buildQuerySchemaFromFields(FoodModel, ["calories"]);
405
+ const middleware = validateQueryParams(schema);
406
+ const req = {
407
+ method: "GET",
408
+ path: "/test",
409
+ query: {calories: {$gte: 1, $where: "1"}},
410
+ } as unknown as Request;
411
+
412
+ expect(() => {
413
+ middleware(req, {} as Response, () => {});
414
+ }).toThrow();
272
415
  });
273
416
  });
274
417
 
@@ -725,6 +868,23 @@ describe("openApiValidator", () => {
725
868
 
726
869
  expect(nextCalled).toBe(true);
727
870
  });
871
+
872
+ it("does not require mongoose required fields when partial is true", () => {
873
+ const middleware = validateModelRequestBody(RequiredModel, {partial: true});
874
+
875
+ let nextCalled = false;
876
+ const req = {
877
+ body: {about: "only about"},
878
+ method: "PATCH",
879
+ path: "/required",
880
+ } as unknown as Request;
881
+ const res = {} as Response;
882
+ middleware(req, res, () => {
883
+ nextCalled = true;
884
+ });
885
+
886
+ expect(nextCalled).toBe(true);
887
+ });
728
888
  });
729
889
 
730
890
  describe("getSchemaFromModel", () => {
@@ -733,6 +893,65 @@ describe("openApiValidator", () => {
733
893
  expect(schema.name).toBeDefined();
734
894
  expect(schema.about).toBeDefined();
735
895
  });
896
+
897
+ it("puts enum constraints on array items, not the array property", () => {
898
+ const enumArraySchema = new mongoose.Schema({
899
+ values: {
900
+ default: ["alpha", "beta"],
901
+ enum: ["alpha", "beta"],
902
+ type: [String],
903
+ },
904
+ });
905
+ const EnumArrayModel =
906
+ mongoose.models.OpenApiValidatorEnumArray ??
907
+ mongoose.model("OpenApiValidatorEnumArray", enumArraySchema);
908
+
909
+ const schema = getSchemaFromModel(EnumArrayModel);
910
+ expect(schema.values).toEqual({
911
+ items: {enum: ["alpha", "beta"], type: "string"},
912
+ type: "array",
913
+ });
914
+ });
915
+ });
916
+
917
+ describe("enum array request bodies", () => {
918
+ const enumArraySchema = new mongoose.Schema({
919
+ label: {required: true, type: String},
920
+ values: {
921
+ enum: ["alpha", "beta"],
922
+ type: [String],
923
+ },
924
+ });
925
+ const EnumArrayModel =
926
+ mongoose.models.OpenApiValidatorEnumArrayRoute ??
927
+ mongoose.model("OpenApiValidatorEnumArrayRoute", enumArraySchema);
928
+
929
+ const enumArrayRouterOptions = {
930
+ permissions: {
931
+ create: [Permissions.IsAuthenticated],
932
+ delete: [Permissions.IsAdmin],
933
+ list: [Permissions.IsAuthenticated],
934
+ read: [Permissions.IsAuthenticated],
935
+ update: [Permissions.IsAuthenticated],
936
+ },
937
+ queryFields: ["label"],
938
+ sort: "-label" as const,
939
+ };
940
+
941
+ it("accepts enum array values on create when validation is enabled", async () => {
942
+ configureOpenApiValidator();
943
+
944
+ const freshApp = await setupFreshApp();
945
+ freshApp.use("/enum-arrays", modelRouter(EnumArrayModel, enumArrayRouterOptions));
946
+ const admin = await authAsUser(freshApp, "admin");
947
+
948
+ const res = await admin
949
+ .post("/enum-arrays")
950
+ .send({label: "sample", values: ["alpha", "beta"]})
951
+ .expect(201);
952
+
953
+ expect(res.body.data.values).toEqual(["alpha", "beta"]);
954
+ });
736
955
  });
737
956
 
738
957
  describe("getOpenApiValidatorConfig", () => {