@terreno/api 57.4.0 → 57.6.1

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 (210) hide show
  1. package/README.md +5 -5
  2. package/bunfig.toml +1 -1
  3. package/dist/actions.js +197 -368
  4. package/dist/adminModelRouter.js +88 -173
  5. package/dist/api.js +617 -852
  6. package/dist/audit/auditApp.js +48 -89
  7. package/dist/audit/auditEventModel.js +15 -16
  8. package/dist/audit/cloudTasksEnqueue.js +56 -149
  9. package/dist/audit/diff.js +70 -160
  10. package/dist/audit/processQueue.js +25 -70
  11. package/dist/audit/rbacSink.js +25 -66
  12. package/dist/audit/record.js +129 -251
  13. package/dist/auth.js +432 -681
  14. package/dist/authRecovery.js +155 -269
  15. package/dist/authTokens.js +43 -118
  16. package/dist/betterAuthApp.js +25 -26
  17. package/dist/betterAuthSetup.js +258 -413
  18. package/dist/browserLogsRoute.d.ts +6 -0
  19. package/dist/browserLogsRoute.js +97 -0
  20. package/dist/collectionRegistry.js +32 -47
  21. package/dist/config.js +53 -122
  22. package/dist/configurationApp.js +180 -361
  23. package/dist/configurationPlugin.js +130 -302
  24. package/dist/consentApp.js +276 -421
  25. package/dist/docLoader.js +78 -126
  26. package/dist/envConfigurationPlugin.js +25 -147
  27. package/dist/errors.js +151 -247
  28. package/dist/example.js +28 -34
  29. package/dist/expressServer.d.ts +10 -0
  30. package/dist/expressServer.js +109 -255
  31. package/dist/frameworkModelNames.d.ts +24 -0
  32. package/dist/frameworkModelNames.js +31 -0
  33. package/dist/githubAuth.js +152 -216
  34. package/dist/httpClient.js +176 -264
  35. package/dist/index.d.ts +2 -0
  36. package/dist/index.js +7 -2
  37. package/dist/logger.js +145 -278
  38. package/dist/mcp/auth.js +76 -128
  39. package/dist/mcp/createMCPRequest.js +4 -5
  40. package/dist/mcp/handlers.js +268 -480
  41. package/dist/mcp/query.js +56 -150
  42. package/dist/mcp/registry.js +17 -30
  43. package/dist/mcp/schemaGenerator.js +95 -181
  44. package/dist/mcp/server.js +28 -100
  45. package/dist/mcp/serviceTokens.js +102 -191
  46. package/dist/mcp/toolGenerator.js +78 -191
  47. package/dist/middleware.js +15 -27
  48. package/dist/migrations/fixtures/all-down/20260910120000-one.js +2 -42
  49. package/dist/migrations/fixtures/all-down/20260910120001-two.js +2 -42
  50. package/dist/migrations/fixtures/bad-id/20260910120000-mismatch.js +1 -39
  51. package/dist/migrations/fixtures/bad-name/not-a-migration.js +1 -39
  52. package/dist/migrations/fixtures/valid/20260910120000-alpha.js +1 -39
  53. package/dist/migrations/fixtures/valid/20260910120001-beta.js +2 -42
  54. package/dist/migrations/generate.js +107 -229
  55. package/dist/migrations/load.js +75 -201
  56. package/dist/migrations/lock.js +54 -126
  57. package/dist/migrations/runner.js +192 -446
  58. package/dist/migrations/schemaCatalog.js +122 -263
  59. package/dist/models/consentForm.js +6 -6
  60. package/dist/models/consentResponse.js +5 -5
  61. package/dist/models/mcpServiceToken.js +66 -156
  62. package/dist/models/notification.js +6 -6
  63. package/dist/models/notificationPreference.js +6 -6
  64. package/dist/models/versionConfig.js +5 -5
  65. package/dist/notifications/notificationService.js +133 -273
  66. package/dist/notifications/notificationsApp.js +85 -179
  67. package/dist/notifications/notificationsBeforeSend.js +19 -64
  68. package/dist/notifiers/googleChatNotifier.js +36 -117
  69. package/dist/notifiers/slackNotifier.d.ts +31 -2
  70. package/dist/notifiers/slackNotifier.js +170 -119
  71. package/dist/notifiers/zoomNotifier.js +60 -111
  72. package/dist/openApi.js +107 -122
  73. package/dist/openApiBuilder.js +117 -159
  74. package/dist/openApiCompat.js +81 -148
  75. package/dist/openApiEtag.js +7 -7
  76. package/dist/openApiValidator.js +177 -286
  77. package/dist/orgs/orgContext.js +87 -157
  78. package/dist/orgs/orgPermissions.js +29 -68
  79. package/dist/orgs/orgPlugin.js +9 -27
  80. package/dist/orgs/organizationModel.js +65 -166
  81. package/dist/orgs/organizationSettings.js +29 -36
  82. package/dist/orgs/orgsApp.js +346 -608
  83. package/dist/permissions.js +88 -181
  84. package/dist/plugins.js +125 -218
  85. package/dist/populate.js +130 -240
  86. package/dist/rateLimit/applyTrustProxy.js +1 -1
  87. package/dist/rateLimit/createStore.js +7 -8
  88. package/dist/rateLimit/memoryStore.js +22 -100
  89. package/dist/rateLimit/middleware.js +48 -99
  90. package/dist/rateLimit/mongoStore.js +54 -112
  91. package/dist/rateLimit/policies.js +41 -75
  92. package/dist/rateLimit/redisStore.js +39 -133
  93. package/dist/rbac/access.js +119 -267
  94. package/dist/rbac/assertAllowed.js +95 -171
  95. package/dist/rbac/auditModel.js +14 -58
  96. package/dist/rbac/backfillAdmins.js +24 -130
  97. package/dist/rbac/fieldViews.js +46 -141
  98. package/dist/rbac/membershipOrgAdminSource.js +28 -99
  99. package/dist/rbac/middleware.js +30 -96
  100. package/dist/rbac/modelRouterAccess.js +130 -307
  101. package/dist/rbac/permissionUtils.js +40 -179
  102. package/dist/rbac/realtimeAccess.js +81 -147
  103. package/dist/rbac/resolve.d.ts +1 -1
  104. package/dist/rbac/resolve.js +148 -342
  105. package/dist/rbac/roleManager.js +318 -700
  106. package/dist/rbac/roleModel.js +44 -171
  107. package/dist/rbac/routes.js +93 -196
  108. package/dist/rbac/scopes.js +39 -133
  109. package/dist/rbac/statements.js +23 -91
  110. package/dist/rbac/userPlugin.js +3 -29
  111. package/dist/realtime/changeStreamWatcher.js +489 -800
  112. package/dist/realtime/deprecation.js +8 -10
  113. package/dist/realtime/queryMatcher.js +110 -191
  114. package/dist/realtime/queryStore.js +35 -118
  115. package/dist/realtime/realtimeApp.js +247 -401
  116. package/dist/realtime/registry.js +19 -30
  117. package/dist/realtime/sessionRevalidation.js +132 -358
  118. package/dist/realtime/socketAuth.js +89 -208
  119. package/dist/realtime/socketUser.js +10 -56
  120. package/dist/requestContext.js +93 -139
  121. package/dist/schemaMetadata.js +179 -274
  122. package/dist/scriptRunner.js +96 -266
  123. package/dist/scrubAdminFields.js +36 -108
  124. package/dist/secretProviders.js +130 -299
  125. package/dist/seedRunner.js +221 -514
  126. package/dist/sync/adminBroadcastScope.js +58 -170
  127. package/dist/sync/adminWindowAccess.js +15 -86
  128. package/dist/sync/adminWindowMutation.js +110 -181
  129. package/dist/sync/executors.js +425 -629
  130. package/dist/sync/loadHarness.js +392 -689
  131. package/dist/sync/models.js +181 -341
  132. package/dist/sync/mutationHandler.js +533 -801
  133. package/dist/sync/registrationSideEffects.js +41 -95
  134. package/dist/sync/registry.js +29 -49
  135. package/dist/sync/routes.js +484 -817
  136. package/dist/sync/scripts/compactTombstones.js +83 -228
  137. package/dist/sync/serialize.js +18 -58
  138. package/dist/sync/socketHandlers.js +253 -478
  139. package/dist/sync/streams.js +49 -117
  140. package/dist/sync/syncApp.js +12 -15
  141. package/dist/sync/syncBatch.js +63 -168
  142. package/dist/sync/syncSeqPlugin.js +430 -702
  143. package/dist/syncConsents.js +113 -253
  144. package/dist/terrenoApp.js +166 -276
  145. package/dist/tests/createTestData.js +146 -256
  146. package/dist/tests/models.js +14 -54
  147. package/dist/tests/mongoTestSetup.js +42 -103
  148. package/dist/tests/testHelper.js +31 -93
  149. package/dist/tests.js +12 -51
  150. package/dist/transformers.js +61 -164
  151. package/dist/utils.js +31 -93
  152. package/dist/vendor/wesleytodd-openapi/index.js +37 -51
  153. package/dist/vendor/wesleytodd-openapi/lib/generate-doc.js +32 -40
  154. package/dist/vendor/wesleytodd-openapi/lib/layer-schema.js +3 -3
  155. package/dist/vendor/wesleytodd-openapi/lib/ui.js +50 -19
  156. package/dist/vendor/wesleytodd-openapi/lib/validate.js +19 -47
  157. package/dist/versionCheckPlugin.js +52 -100
  158. package/dist/webhooks/headerValue.js +2 -2
  159. package/dist/webhooks/idempotency/memoryStore.js +16 -59
  160. package/dist/webhooks/idempotency/mongoStore.js +55 -130
  161. package/dist/webhooks/idempotency/webhookReceipt.js +9 -9
  162. package/dist/webhooks/rawBody.js +1 -1
  163. package/dist/webhooks/timingSafeEqual.js +4 -5
  164. package/dist/webhooks/verifiers/hmac.js +17 -18
  165. package/dist/webhooks/verifiers/sendgrid.js +20 -22
  166. package/dist/webhooks/verifiers/stripe.js +31 -65
  167. package/dist/webhooks/verifiers/twilio.js +23 -73
  168. package/dist/webhooks/webhooksApp.js +78 -177
  169. package/dist/zodOpenApi.js +2 -2
  170. package/package.json +6 -6
  171. package/src/__tests__/browserLogsRoute.test.ts +165 -0
  172. package/src/api.arrayOperations.test.ts +44 -0
  173. package/src/api.ts +64 -39
  174. package/src/audit/auditApp.test.ts +5 -5
  175. package/src/audit/auditEventModel.ts +7 -3
  176. package/src/audit/auditRouter.test.ts +5 -5
  177. package/src/audit/rbacSink.test.ts +2 -2
  178. package/src/audit/record.test.ts +2 -2
  179. package/src/audit/record.ts +3 -2
  180. package/src/auth.ts +1 -1
  181. package/src/authRecovery.test.ts +43 -0
  182. package/src/authRecovery.ts +16 -10
  183. package/src/authTokens.ts +6 -2
  184. package/src/authVerification.test.ts +22 -0
  185. package/src/browserLogsRoute.ts +110 -0
  186. package/src/configurationPlugin.test.ts +1 -11
  187. package/src/expressServer.ts +10 -0
  188. package/src/frameworkModelNames.test.ts +62 -0
  189. package/src/frameworkModelNames.ts +33 -0
  190. package/src/index.ts +7 -0
  191. package/src/isolated/migrateCliConnect.isolated.ts +51 -0
  192. package/src/mcp/auth.test.ts +34 -1
  193. package/src/migrations/cli.test.ts +0 -23
  194. package/src/models/mcpServiceToken.ts +4 -3
  195. package/src/models/notification.ts +3 -2
  196. package/src/models/notificationPreference.ts +1 -1
  197. package/src/notifications/notificationsApp.test.ts +24 -1
  198. package/src/notifiers/slackNotifier.test.ts +186 -1
  199. package/src/notifiers/slackNotifier.ts +167 -8
  200. package/src/orgs/orgPlugin.ts +1 -1
  201. package/src/orgs/organizationModel.ts +11 -6
  202. package/src/plugins.test.ts +5 -0
  203. package/src/plugins.ts +3 -0
  204. package/src/realtime/realtimeApp.ts +1 -1
  205. package/src/sync/integration.test.ts +2 -2
  206. package/src/terrenoApp.ts +3 -0
  207. package/src/types.d.ts +1 -0
  208. package/src/webhooks/idempotency/webhookReceipt.ts +4 -3
  209. package/tsconfig.json +13 -54
  210. package/tsconfig.typedoc.json +2 -0
@@ -1,162 +1,66 @@
1
1
  "use strict";
2
- var __assign = (this && this.__assign) || function () {
3
- __assign = Object.assign || function(t) {
4
- for (var s, i = 1, n = arguments.length; i < n; i++) {
5
- s = arguments[i];
6
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7
- t[p] = s[p];
8
- }
9
- return t;
10
- };
11
- return __assign.apply(this, arguments);
12
- };
13
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
14
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
15
- return new (P || (P = Promise))(function (resolve, reject) {
16
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
17
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
18
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
19
- step((generator = generator.apply(thisArg, _arguments || [])).next());
20
- });
21
- };
22
- var __generator = (this && this.__generator) || function (thisArg, body) {
23
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
24
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
25
- function verb(n) { return function (v) { return step([n, v]); }; }
26
- function step(op) {
27
- if (f) throw new TypeError("Generator is already executing.");
28
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
29
- if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
30
- if (y = 0, t) op = [op[0] & 2, t.value];
31
- switch (op[0]) {
32
- case 0: case 1: t = op; break;
33
- case 4: _.label++; return { value: op[1], done: false };
34
- case 5: _.label++; y = op[1]; op = [0]; continue;
35
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
36
- default:
37
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
38
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
39
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
40
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
41
- if (t[2]) _.ops.pop();
42
- _.trys.pop(); continue;
43
- }
44
- op = body.call(thisArg, _);
45
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
46
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
47
- }
48
- };
49
- var __values = (this && this.__values) || function(o) {
50
- var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
51
- if (m) return m.call(o);
52
- if (o && typeof o.length === "number") return {
53
- next: function () {
54
- if (o && i >= o.length) o = void 0;
55
- return { value: o && o[i++], done: !o };
56
- }
57
- };
58
- throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
59
- };
60
- var __read = (this && this.__read) || function (o, n) {
61
- var m = typeof Symbol === "function" && o[Symbol.iterator];
62
- if (!m) return o;
63
- var i = m.call(o), r, ar = [], e;
64
- try {
65
- while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
66
- }
67
- catch (error) { e = { error: error }; }
68
- finally {
69
- try {
70
- if (r && !r.done && (m = i["return"])) m.call(i);
71
- }
72
- finally { if (e) throw e.error; }
73
- }
74
- return ar;
75
- };
76
- var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
77
- if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
78
- if (ar || !(i in from)) {
79
- if (!ar) ar = Array.prototype.slice.call(from, 0, i);
80
- ar[i] = from[i];
81
- }
82
- }
83
- return to.concat(ar || Array.prototype.slice.call(from));
84
- };
85
2
  Object.defineProperty(exports, "__esModule", { value: true });
86
3
  exports.defaultResponseHandler = exports.serialize = exports.transform = exports.AdminOwnerTransformer = void 0;
87
- var errors_1 = require("./errors");
88
- var logger_1 = require("./logger");
89
- var getUserType = function (user, obj) {
90
- if (user === null || user === void 0 ? void 0 : user.admin) {
4
+ const errors_1 = require("./errors");
5
+ const logger_1 = require("./logger");
6
+ const getUserType = (user, obj) => {
7
+ if (user?.admin) {
91
8
  return "admin";
92
9
  }
93
- var withOwner = obj;
94
- if (withOwner && user && String(withOwner === null || withOwner === void 0 ? void 0 : withOwner.ownerId) === String(user === null || user === void 0 ? void 0 : user.id)) {
10
+ const withOwner = obj;
11
+ if (withOwner && user && String(withOwner?.ownerId) === String(user?.id)) {
95
12
  return "owner";
96
13
  }
97
- if (user === null || user === void 0 ? void 0 : user.id) {
14
+ if (user?.id) {
98
15
  return "auth";
99
16
  }
100
17
  return "anon";
101
18
  };
102
- var AdminOwnerTransformer = function (options) {
103
- var pickFields = function (obj, fields) {
104
- var e_1, _a;
105
- var newData = {};
106
- try {
107
- for (var fields_1 = __values(fields), fields_1_1 = fields_1.next(); !fields_1_1.done; fields_1_1 = fields_1.next()) {
108
- var field = fields_1_1.value;
109
- var key = field;
110
- if (obj[key] !== undefined) {
111
- newData[key] = obj[key];
112
- }
19
+ const AdminOwnerTransformer = (options) => {
20
+ const pickFields = (obj, fields) => {
21
+ const newData = {};
22
+ for (const field of fields) {
23
+ const key = field;
24
+ if (obj[key] !== undefined) {
25
+ newData[key] = obj[key];
113
26
  }
114
27
  }
115
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
116
- finally {
117
- try {
118
- if (fields_1_1 && !fields_1_1.done && (_a = fields_1.return)) _a.call(fields_1);
119
- }
120
- finally { if (e_1) throw e_1.error; }
121
- }
122
28
  return newData;
123
29
  };
124
30
  return {
125
- serialize: function (obj, user) {
126
- var _a, _b, _c, _d;
127
- var userType = getUserType(user, obj);
31
+ serialize: (obj, user) => {
32
+ const userType = getUserType(user, obj);
128
33
  if (userType === "admin") {
129
- return pickFields(obj, __spreadArray(__spreadArray([], __read(((_a = options.adminReadFields) !== null && _a !== void 0 ? _a : [])), false), ["id"], false));
34
+ return pickFields(obj, [...(options.adminReadFields ?? []), "id"]);
130
35
  }
131
36
  if (userType === "owner") {
132
- return pickFields(obj, __spreadArray(__spreadArray([], __read(((_b = options.ownerReadFields) !== null && _b !== void 0 ? _b : [])), false), ["id"], false));
37
+ return pickFields(obj, [...(options.ownerReadFields ?? []), "id"]);
133
38
  }
134
39
  if (userType === "auth") {
135
- return pickFields(obj, __spreadArray(__spreadArray([], __read(((_c = options.authReadFields) !== null && _c !== void 0 ? _c : [])), false), ["id"], false));
40
+ return pickFields(obj, [...(options.authReadFields ?? []), "id"]);
136
41
  }
137
- return pickFields(obj, __spreadArray(__spreadArray([], __read(((_d = options.anonReadFields) !== null && _d !== void 0 ? _d : [])), false), ["id"], false));
42
+ return pickFields(obj, [...(options.anonReadFields ?? []), "id"]);
138
43
  },
139
- transform: function (obj, _method, user) {
140
- var _a, _b, _c, _d;
141
- var userType = getUserType(user, obj);
142
- var allowedFields;
44
+ transform: (obj, _method, user) => {
45
+ const userType = getUserType(user, obj);
46
+ let allowedFields;
143
47
  if (userType === "admin") {
144
- allowedFields = (_a = options.adminWriteFields) !== null && _a !== void 0 ? _a : [];
48
+ allowedFields = options.adminWriteFields ?? [];
145
49
  }
146
50
  else if (userType === "owner") {
147
- allowedFields = (_b = options.ownerWriteFields) !== null && _b !== void 0 ? _b : [];
51
+ allowedFields = options.ownerWriteFields ?? [];
148
52
  }
149
53
  else if (userType === "auth") {
150
- allowedFields = (_c = options.authWriteFields) !== null && _c !== void 0 ? _c : [];
54
+ allowedFields = options.authWriteFields ?? [];
151
55
  }
152
56
  else {
153
- allowedFields = (_d = options.anonWriteFields) !== null && _d !== void 0 ? _d : [];
57
+ allowedFields = options.anonWriteFields ?? [];
154
58
  }
155
- var unallowedFields = Object.keys(obj).filter(function (k) { return !allowedFields.includes(k); });
59
+ const unallowedFields = Object.keys(obj).filter((k) => !allowedFields.includes(k));
156
60
  if (unallowedFields.length) {
157
61
  throw new errors_1.APIError({
158
62
  status: 403,
159
- title: "User of type ".concat(userType, " cannot write fields: ").concat(unallowedFields.join(", ")),
63
+ title: `User of type ${userType} cannot write fields: ${unallowedFields.join(", ")}`,
160
64
  });
161
65
  }
162
66
  return obj;
@@ -164,76 +68,69 @@ var AdminOwnerTransformer = function (options) {
164
68
  };
165
69
  };
166
70
  exports.AdminOwnerTransformer = AdminOwnerTransformer;
167
- var transform = function (options, data, method, user) {
168
- var _a, _b;
169
- if (!((_a = options.transformer) === null || _a === void 0 ? void 0 : _a.transform)) {
71
+ const transform = (options, data, method, user) => {
72
+ if (!options.transformer?.transform) {
170
73
  return data;
171
74
  }
172
75
  logger_1.logger.warn("transform functions are deprecated, use preCreate/preUpdate/preDelete hooks instead");
173
76
  // TS doesn't realize this is defined otherwise...
174
- var transformFn = (_b = options.transformer) === null || _b === void 0 ? void 0 : _b.transform;
77
+ const transformFn = options.transformer?.transform;
175
78
  if (!Array.isArray(data)) {
176
79
  return transformFn(data, method, user);
177
80
  }
178
- return data.map(function (d) { return transformFn(d, method, user); });
81
+ return data.map((d) => transformFn(d, method, user));
179
82
  };
180
83
  exports.transform = transform;
181
- var serialize = function (req, options, data) {
182
- var _a;
183
- var serializeFn = function (serializeData, serializeUser) {
184
- var _a, _b;
84
+ const serialize = (req, options, data) => {
85
+ const serializeFn = (serializeData, serializeUser) => {
185
86
  // Change-stream post-images are plain BSON objects (no toObject). Calling
186
87
  // toObject on them throws and used to drop every sync:delta / realtime emit.
187
- var dataObject = (typeof serializeData.toObject === "function"
88
+ const dataObject = (typeof serializeData.toObject === "function"
188
89
  ? serializeData.toObject()
189
- : __assign({}, serializeData));
90
+ : { ...serializeData });
190
91
  dataObject.id = serializeData._id;
191
92
  // Search for any value that is a Map and transform it to a plain object.
192
93
  // Otherwise Express drops the contents.
193
- for (var key in dataObject) {
194
- var value = dataObject[key];
94
+ for (const key in dataObject) {
95
+ const value = dataObject[key];
195
96
  if (value instanceof Map) {
196
97
  dataObject[key] = Object.fromEntries(value);
197
98
  }
198
99
  }
199
- if ((_a = options.transformer) === null || _a === void 0 ? void 0 : _a.serialize) {
200
- return (_b = options.transformer) === null || _b === void 0 ? void 0 : _b.serialize(dataObject, serializeUser);
100
+ if (options.transformer?.serialize) {
101
+ return options.transformer?.serialize(dataObject, serializeUser);
201
102
  }
202
103
  return dataObject;
203
104
  };
204
- if ((_a = options.transformer) === null || _a === void 0 ? void 0 : _a.serialize) {
105
+ if (options.transformer?.serialize) {
205
106
  logger_1.logger.warn("transform.serialize functions are deprecated, use post* hooks and serialize instead");
206
107
  }
207
108
  if (!Array.isArray(data)) {
208
109
  return serializeFn(data, req.user);
209
110
  }
210
- return data.map(function (d) { return serializeFn(d, req.user); });
111
+ return data.map((d) => serializeFn(d, req.user));
211
112
  };
212
113
  exports.serialize = serialize;
213
114
  /**
214
115
  * Default response handler for modelRouter. Calls toObject on each doc and returns the result,
215
116
  * using transformers.serializer if provided.
216
117
  */
217
- var defaultResponseHandler = function (doc, method, request, options) { return __awaiter(void 0, void 0, void 0, function () {
218
- var errorObj;
219
- return __generator(this, function (_a) {
220
- if (!doc) {
221
- return [2 /*return*/, null];
222
- }
223
- try {
224
- return [2 /*return*/, (0, exports.serialize)(request, options, doc)];
225
- }
226
- catch (error) {
227
- errorObj = error;
228
- throw new errors_1.APIError({
229
- cause: errorObj,
230
- code: "serialization-error",
231
- detail: errorObj.message,
232
- status: 400,
233
- title: "Error serializing ".concat(method, " response"),
234
- });
235
- }
236
- return [2 /*return*/];
237
- });
238
- }); };
118
+ const defaultResponseHandler = async (doc, method, request, options) => {
119
+ if (!doc) {
120
+ return null;
121
+ }
122
+ try {
123
+ return (0, exports.serialize)(request, options, doc);
124
+ }
125
+ catch (error) {
126
+ const errorObj = error;
127
+ throw new errors_1.APIError({
128
+ cause: errorObj,
129
+ code: "serialization-error",
130
+ detail: errorObj.message,
131
+ status: 400,
132
+ title: `Error serializing ${method} response`,
133
+ });
134
+ }
135
+ };
239
136
  exports.defaultResponseHandler = defaultResponseHandler;
package/dist/utils.js CHANGED
@@ -32,75 +32,26 @@ var __importStar = (this && this.__importStar) || (function () {
32
32
  return result;
33
33
  };
34
34
  })();
35
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
36
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
37
- return new (P || (P = Promise))(function (resolve, reject) {
38
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
39
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
40
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
41
- step((generator = generator.apply(thisArg, _arguments || [])).next());
42
- });
43
- };
44
- var __generator = (this && this.__generator) || function (thisArg, body) {
45
- 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);
46
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
47
- function verb(n) { return function (v) { return step([n, v]); }; }
48
- function step(op) {
49
- if (f) throw new TypeError("Generator is already executing.");
50
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
51
- 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;
52
- if (y = 0, t) op = [op[0] & 2, t.value];
53
- switch (op[0]) {
54
- case 0: case 1: t = op; break;
55
- case 4: _.label++; return { value: op[1], done: false };
56
- case 5: _.label++; y = op[1]; op = [0]; continue;
57
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
58
- default:
59
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
60
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
61
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
62
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
63
- if (t[2]) _.ops.pop();
64
- _.trys.pop(); continue;
65
- }
66
- op = body.call(thisArg, _);
67
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
68
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
69
- }
70
- };
71
- var __values = (this && this.__values) || function(o) {
72
- var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
73
- if (m) return m.call(o);
74
- if (o && typeof o.length === "number") return {
75
- next: function () {
76
- if (o && i >= o.length) o = void 0;
77
- return { value: o && o[i++], done: !o };
78
- }
79
- };
80
- throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
81
- };
82
35
  Object.defineProperty(exports, "__esModule", { value: true });
83
36
  exports.checkModelsStrict = exports.timeout = exports.isValidObjectId = void 0;
84
- var mongoose_1 = __importStar(require("mongoose"));
85
- var errors_1 = require("./errors");
86
- var logger_1 = require("./logger");
37
+ const mongoose_1 = __importStar(require("mongoose"));
38
+ const errors_1 = require("./errors");
39
+ const logger_1 = require("./logger");
87
40
  // A better version of mongoose's ObjectId.isValid,
88
41
  // which falsely will say any 12 character string is valid.
89
- var isValidObjectId = function (id) {
42
+ const isValidObjectId = (id) => {
90
43
  try {
91
44
  return new mongoose_1.Types.ObjectId(id).toString() === id;
92
45
  }
93
46
  catch (error) {
94
- logger_1.logger.error("Error validating object id ".concat(id, ": ").concat(error));
47
+ logger_1.logger.error(`Error validating object id ${id}: ${error}`);
95
48
  return false;
96
49
  }
97
50
  };
98
51
  exports.isValidObjectId = isValidObjectId;
99
- var timeout = function (ms) { return __awaiter(void 0, void 0, void 0, function () {
100
- return __generator(this, function (_a) {
101
- return [2 /*return*/, new Promise(function (resolve) { return setTimeout(resolve, ms); })];
102
- });
103
- }); };
52
+ const timeout = async (ms) => {
53
+ return new Promise((resolve) => setTimeout(resolve, ms));
54
+ };
104
55
  exports.timeout = timeout;
105
56
  /**
106
57
  * Ensure that all mongoose models are set to strict mode.
@@ -110,44 +61,31 @@ exports.timeout = timeout;
110
61
  * @param ignoredModels - Array of model names to skip validation for
111
62
  * @throws Error if any model is not set to strict mode or missing virtual settings
112
63
  */
113
- var checkModelsStrict = function (ignoredModels) {
114
- var e_1, _a;
115
- var _b, _c;
116
- if (ignoredModels === void 0) { ignoredModels = []; }
117
- var models = mongoose_1.default.modelNames();
118
- try {
119
- for (var models_1 = __values(models), models_1_1 = models_1.next(); !models_1_1.done; models_1_1 = models_1.next()) {
120
- var model = models_1_1.value;
121
- var schema = mongoose_1.default.model(model).schema;
122
- if (((_b = schema.get("toObject")) === null || _b === void 0 ? void 0 : _b.virtuals) !== true) {
123
- throw new errors_1.APIError({
124
- status: 500,
125
- title: "Model ".concat(model, " toObject.virtuals not set to true"),
126
- });
127
- }
128
- if (((_c = schema.get("toJSON")) === null || _c === void 0 ? void 0 : _c.virtuals) !== true) {
129
- throw new errors_1.APIError({
130
- status: 500,
131
- title: "Model ".concat(model, " toJSON.virtuals not set to true"),
132
- });
133
- }
134
- if (ignoredModels.includes(model)) {
135
- continue;
136
- }
137
- if (schema.get("strict") !== "throw") {
138
- throw new errors_1.APIError({
139
- status: 500,
140
- title: "Model ".concat(model, " is not set to strict mode."),
141
- });
142
- }
64
+ const checkModelsStrict = (ignoredModels = []) => {
65
+ const models = mongoose_1.default.modelNames();
66
+ for (const model of models) {
67
+ const schema = mongoose_1.default.model(model).schema;
68
+ if (schema.get("toObject")?.virtuals !== true) {
69
+ throw new errors_1.APIError({
70
+ status: 500,
71
+ title: `Model ${model} toObject.virtuals not set to true`,
72
+ });
143
73
  }
144
- }
145
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
146
- finally {
147
- try {
148
- if (models_1_1 && !models_1_1.done && (_a = models_1.return)) _a.call(models_1);
74
+ if (schema.get("toJSON")?.virtuals !== true) {
75
+ throw new errors_1.APIError({
76
+ status: 500,
77
+ title: `Model ${model} toJSON.virtuals not set to true`,
78
+ });
79
+ }
80
+ if (ignoredModels.includes(model)) {
81
+ continue;
82
+ }
83
+ if (schema.get("strict") !== "throw") {
84
+ throw new errors_1.APIError({
85
+ status: 500,
86
+ title: `Model ${model} is not set to strict mode.`,
87
+ });
149
88
  }
150
- finally { if (e_1) throw e_1.error; }
151
89
  }
152
90
  };
153
91
  exports.checkModelsStrict = checkModelsStrict;
@@ -3,27 +3,16 @@
3
3
  // License: ISC (see LICENSE)
4
4
  // Vendored to allow local modifications and avoid external dependency drift.
5
5
  'use strict';
6
- var __assign = (this && this.__assign) || function () {
7
- __assign = Object.assign || function(t) {
8
- for (var s, i = 1, n = arguments.length; i < n; i++) {
9
- s = arguments[i];
10
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
11
- t[p] = s[p];
12
- }
13
- return t;
14
- };
15
- return __assign.apply(this, arguments);
16
- };
17
- var httpErrors = require('http-errors');
18
- var Router = require('router');
19
- var SwaggerParser = require('swagger-parser');
20
- var ui = require('./lib/ui');
21
- var makeValidator = require('./lib/validate');
22
- var _a = require('./lib/layer-schema'), getSchema = _a.get, setSchema = _a.set;
23
- var minimumViableDocument = require('./lib/minimum-doc');
24
- var generateDocument = require('./lib/generate-doc');
25
- var defaultRoutePrefix = '/openapi';
26
- var YAML = require('yaml');
6
+ const httpErrors = require('http-errors');
7
+ const Router = require('router');
8
+ const SwaggerParser = require('swagger-parser');
9
+ const ui = require('./lib/ui');
10
+ const makeValidator = require('./lib/validate');
11
+ const { get: getSchema, set: setSchema } = require('./lib/layer-schema');
12
+ const minimumViableDocument = require('./lib/minimum-doc');
13
+ const generateDocument = require('./lib/generate-doc');
14
+ const defaultRoutePrefix = '/openapi';
15
+ const YAML = require('yaml');
27
16
  module.exports = function ExpressOpenApi(_routePrefix, _doc, _opts) {
28
17
  // Acceptable arguments:
29
18
  // oapi()
@@ -34,9 +23,9 @@ module.exports = function ExpressOpenApi(_routePrefix, _doc, _opts) {
34
23
  // oapi(doc, opts)
35
24
  //
36
25
  // The below logic is correct, but very hard to reason about
37
- var routePrefix = _routePrefix || defaultRoutePrefix;
38
- var doc = _doc || minimumViableDocument;
39
- var opts = _opts || {};
26
+ let routePrefix = _routePrefix || defaultRoutePrefix;
27
+ let doc = _doc || minimumViableDocument;
28
+ let opts = _opts || {};
40
29
  if (typeof _routePrefix !== 'string') {
41
30
  routePrefix = defaultRoutePrefix;
42
31
  doc = _routePrefix || minimumViableDocument;
@@ -44,11 +33,11 @@ module.exports = function ExpressOpenApi(_routePrefix, _doc, _opts) {
44
33
  }
45
34
  // We need to route a bit, seems a safe addition
46
35
  // to use the express router in an express middleware
47
- var router = new Router();
36
+ const router = new Router();
48
37
  // Fully generate the doc on the first request
49
- var isFirstRequest = true;
38
+ let isFirstRequest = true;
50
39
  // Where the magic happens
51
- var middleware = function OpenApiMiddleware(req, res, next) {
40
+ const middleware = function OpenApiMiddleware(req, res, next) {
52
41
  if (isFirstRequest) {
53
42
  middleware.document = generateDocument(middleware.document, req.app._router || req.app.router, opts.basePath);
54
43
  isFirstRequest = false;
@@ -61,8 +50,7 @@ module.exports = function ExpressOpenApi(_routePrefix, _doc, _opts) {
61
50
  middleware.generateDocument = generateDocument;
62
51
  middleware.options = opts;
63
52
  // Add a path schema to the document
64
- middleware.path = function (schema) {
65
- if (schema === void 0) { schema = {}; }
53
+ middleware.path = function (schema = {}) {
66
54
  function schemaMiddleware(req, res, next) {
67
55
  next();
68
56
  }
@@ -70,13 +58,11 @@ module.exports = function ExpressOpenApi(_routePrefix, _doc, _opts) {
70
58
  return schemaMiddleware;
71
59
  };
72
60
  // Validate path middleware
73
- middleware.validPath = function (schema, pathOpts) {
74
- if (schema === void 0) { schema = {}; }
75
- if (pathOpts === void 0) { pathOpts = {}; }
76
- var validate;
61
+ middleware.validPath = function (schema = {}, pathOpts = {}) {
62
+ let validate;
77
63
  function validSchemaMiddleware(req, res, next) {
78
64
  if (!validate) {
79
- validate = makeValidator(middleware, getSchema(validSchemaMiddleware), __assign(__assign({}, pathOpts), opts));
65
+ validate = makeValidator(middleware, getSchema(validSchemaMiddleware), { ...pathOpts, ...opts });
80
66
  }
81
67
  return validate(req, res, next);
82
68
  }
@@ -95,9 +81,9 @@ module.exports = function ExpressOpenApi(_routePrefix, _doc, _opts) {
95
81
  // Return ref to type
96
82
  if (name && !description) {
97
83
  if (!middleware.document.components || !middleware.document.components[type] || !middleware.document.components[type][name]) {
98
- throw new Error("Unknown ".concat(type, " ref: ").concat(name));
84
+ throw new Error(`Unknown ${type} ref: ${name}`);
99
85
  }
100
- return { $ref: "#/components/".concat(type, "/").concat(name) };
86
+ return { $ref: `#/components/${type}/${name}` };
101
87
  }
102
88
  // Set name on parameter if not passed
103
89
  if (type === 'parameters') {
@@ -119,33 +105,33 @@ module.exports = function ExpressOpenApi(_routePrefix, _doc, _opts) {
119
105
  middleware.links = middleware.component.bind(null, 'links');
120
106
  middleware.callbacks = middleware.component.bind(null, 'callbacks');
121
107
  // Expose ui middleware
122
- middleware.swaggerui = function (options) { return ui.serveSwaggerUI("".concat(routePrefix, ".json"), options); };
108
+ middleware.swaggerui = (options) => ui.serveSwaggerUI(`${routePrefix}.json`, options);
123
109
  // OpenAPI document as json
124
- router.get("".concat(routePrefix, ".json"), function (req, res) {
110
+ router.get(`${routePrefix}.json`, (req, res) => {
125
111
  middleware.document = generateDocument(middleware.document, req.app._router || req.app.router, opts.basePath);
126
112
  res.json(middleware.document);
127
113
  });
128
114
  // OpenAPI document as yaml
129
- router.get(["".concat(routePrefix, ".yaml"), "".concat(routePrefix, ".yml")], function (req, res) {
130
- var jsonSpec = generateDocument(middleware.document, req.app._router || req.app.router, opts.basePath);
131
- var yamlSpec = YAML.stringify(jsonSpec);
115
+ router.get([`${routePrefix}.yaml`, `${routePrefix}.yml`], (req, res) => {
116
+ const jsonSpec = generateDocument(middleware.document, req.app._router || req.app.router, opts.basePath);
117
+ const yamlSpec = YAML.stringify(jsonSpec);
132
118
  res.type('yaml');
133
119
  res.send(yamlSpec);
134
120
  });
135
- router.get("".concat(routePrefix, "/components/:type/:name.json"), function (req, res, next) {
136
- var _a = req.params, type = _a.type, name = _a.name;
121
+ router.get(`${routePrefix}/components/:type/:name.json`, (req, res, next) => {
122
+ const { type, name } = req.params;
137
123
  middleware.document = generateDocument(middleware.document, req.app._router || req.app.router, opts.basePath);
138
124
  // No component by that identifer
139
125
  if (!middleware.document.components[type] || !middleware.document.components[type][name]) {
140
- return next(httpErrors(404, "Component does not exist: ".concat(type, "/").concat(name)));
126
+ return next(httpErrors(404, `Component does not exist: ${type}/${name}`));
141
127
  }
142
128
  // Return component
143
129
  res.json(middleware.document.components[type][name]);
144
130
  });
145
131
  // Validate full open api document
146
- router.get("".concat(routePrefix, "/validate"), function (req, res) {
132
+ router.get(`${routePrefix}/validate`, (req, res) => {
147
133
  middleware.document = generateDocument(middleware.document, req.app._router || req.app.router, opts.basePath);
148
- SwaggerParser.validate(middleware.document, function (err, api) {
134
+ SwaggerParser.validate(middleware.document, (err, api) => {
149
135
  if (err) {
150
136
  return res.json({
151
137
  valid: false,
@@ -161,13 +147,13 @@ module.exports = function ExpressOpenApi(_routePrefix, _doc, _opts) {
161
147
  });
162
148
  // Serve up the for exploring the document
163
149
  if (opts.htmlui) {
164
- var ui_1 = opts.htmlui;
150
+ let ui = opts.htmlui;
165
151
  if (!Array.isArray(opts.htmlui)) {
166
- ui_1 = [opts.htmlui];
152
+ ui = [opts.htmlui];
167
153
  }
168
- if (ui_1.includes('swagger-ui')) {
169
- router.get("".concat(routePrefix), function (req, res) { res.redirect("".concat(routePrefix, "/swagger-ui")); });
170
- router.use("".concat(routePrefix, "/swagger-ui"), middleware.swaggerui);
154
+ if (ui.includes('swagger-ui')) {
155
+ router.get(`${routePrefix}`, (req, res) => { res.redirect(`${routePrefix}/swagger-ui`); });
156
+ router.use(`${routePrefix}/swagger-ui`, middleware.swaggerui);
171
157
  }
172
158
  }
173
159
  return middleware;