@terreno/api 0.30.0 → 56.0.0-beta.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 (226) hide show
  1. package/dist/api.d.ts +10 -0
  2. package/dist/api.js +110 -361
  3. package/dist/auth.d.ts +26 -0
  4. package/dist/auth.js +100 -1
  5. package/dist/betterAuth.d.ts +5 -0
  6. package/dist/betterAuthSetup.js +23 -4
  7. package/dist/docLoader.js +12 -9
  8. package/dist/errors.d.ts +13 -0
  9. package/dist/errors.js +29 -1
  10. package/dist/index.d.ts +17 -1
  11. package/dist/index.js +29 -1
  12. package/dist/middleware.d.ts +7 -0
  13. package/dist/middleware.js +16 -1
  14. package/dist/openApiCompat.d.ts +10 -1
  15. package/dist/openApiCompat.js +115 -47
  16. package/dist/permissions.d.ts +27 -0
  17. package/dist/permissions.js +42 -1
  18. package/dist/plugins.d.ts +13 -0
  19. package/dist/plugins.js +35 -1
  20. package/dist/realtime/changeStreamWatcher.d.ts +100 -3
  21. package/dist/realtime/changeStreamWatcher.js +542 -137
  22. package/dist/realtime/realtimeApp.d.ts +2 -0
  23. package/dist/realtime/realtimeApp.js +73 -21
  24. package/dist/realtime/sessionRevalidation.d.ts +90 -0
  25. package/dist/realtime/sessionRevalidation.js +438 -0
  26. package/dist/realtime/socketAuth.d.ts +97 -0
  27. package/dist/realtime/socketAuth.js +272 -0
  28. package/dist/realtime/socketUser.d.ts +54 -0
  29. package/dist/realtime/socketUser.js +75 -5
  30. package/dist/realtime/types.d.ts +40 -0
  31. package/dist/secretProviders.d.ts +23 -0
  32. package/dist/secretProviders.js +9 -3
  33. package/dist/sync/executors.d.ts +198 -0
  34. package/dist/sync/executors.js +670 -0
  35. package/dist/sync/loadHarness.js +807 -0
  36. package/dist/sync/models.d.ts +216 -0
  37. package/dist/sync/models.js +644 -0
  38. package/dist/sync/mutationHandler.d.ts +97 -0
  39. package/dist/sync/mutationHandler.js +886 -0
  40. package/dist/sync/registry.d.ts +73 -0
  41. package/dist/sync/registry.js +223 -0
  42. package/dist/sync/routes.d.ts +62 -0
  43. package/dist/sync/routes.js +936 -0
  44. package/dist/sync/scripts/compactTombstones.d.ts +47 -0
  45. package/dist/sync/scripts/compactTombstones.js +270 -0
  46. package/dist/sync/serialize.d.ts +20 -0
  47. package/dist/{tests/bunSetup.js → sync/serialize.js} +35 -68
  48. package/dist/sync/socketHandlers.d.ts +54 -0
  49. package/dist/sync/socketHandlers.js +470 -0
  50. package/dist/sync/streams.d.ts +85 -0
  51. package/dist/sync/streams.js +221 -0
  52. package/dist/sync/syncApp.d.ts +29 -0
  53. package/dist/sync/syncApp.js +44 -0
  54. package/dist/sync/syncBatch.d.ts +71 -0
  55. package/dist/sync/syncBatch.js +252 -0
  56. package/dist/sync/syncSeqPlugin.d.ts +8 -0
  57. package/dist/sync/syncSeqPlugin.js +903 -0
  58. package/dist/sync/types.d.ts +254 -0
  59. package/dist/sync/types.js +9 -0
  60. package/dist/terrenoApp.js +90 -27
  61. package/dist/vendor/wesleytodd-openapi/index.d.ts +1 -1
  62. package/dist/vendor/wesleytodd-openapi/lib/ui.d.ts +2 -1
  63. package/package.json +7 -6
  64. package/src/__tests__/openApiCompat.test.ts +20 -0
  65. package/src/actions.openApi.test.ts +7 -10
  66. package/src/api.test.ts +12 -0
  67. package/src/api.ts +87 -295
  68. package/src/auth.test.ts +128 -176
  69. package/src/auth.ts +109 -0
  70. package/src/betterAuth.ts +6 -0
  71. package/src/betterAuthSetup.test.ts +34 -0
  72. package/src/betterAuthSetup.ts +20 -1
  73. package/src/docLoader.ts +3 -1
  74. package/src/errors.ts +33 -0
  75. package/src/expressServer.test.ts +7 -1
  76. package/src/index.ts +42 -0
  77. package/src/middleware.test.ts +40 -1
  78. package/src/middleware.ts +15 -0
  79. package/src/openApiCompat.ts +99 -45
  80. package/src/permissions.test.ts +75 -1
  81. package/src/permissions.ts +49 -0
  82. package/src/plugins.test.ts +54 -0
  83. package/src/plugins.ts +43 -0
  84. package/src/realtime/changeStreamWatcher.ts +552 -114
  85. package/src/realtime/realtime.test.ts +157 -0
  86. package/src/realtime/realtimeApp.ts +75 -11
  87. package/src/realtime/sessionRevalidation.test.ts +423 -0
  88. package/src/realtime/sessionRevalidation.ts +273 -0
  89. package/src/realtime/socketAuth.test.ts +355 -0
  90. package/src/realtime/socketAuth.ts +228 -0
  91. package/src/realtime/socketUser.ts +69 -0
  92. package/src/realtime/types.ts +40 -0
  93. package/src/secretProviders.test.ts +7 -1
  94. package/src/secretProviders.ts +15 -3
  95. package/src/sync/ensureSyncIndexes.test.ts +144 -0
  96. package/src/sync/executors.test.ts +882 -0
  97. package/src/sync/executors.ts +703 -0
  98. package/src/sync/integration.test.ts +1160 -0
  99. package/src/sync/loadHarness.ts +618 -0
  100. package/src/sync/models.ts +640 -0
  101. package/src/sync/mutationHandler.test.ts +1252 -0
  102. package/src/sync/mutationHandler.ts +850 -0
  103. package/src/sync/registry.ts +232 -0
  104. package/src/sync/routes.ts +812 -0
  105. package/src/sync/scripts/compactTombstones.test.ts +249 -0
  106. package/src/sync/scripts/compactTombstones.ts +145 -0
  107. package/src/sync/serialize.ts +48 -0
  108. package/src/sync/sessionRevalidationIntegration.test.ts +281 -0
  109. package/src/sync/socketHandlers.ts +320 -0
  110. package/src/sync/streams.ts +188 -0
  111. package/src/sync/sync.test.ts +582 -0
  112. package/src/sync/syncApp.ts +44 -0
  113. package/src/sync/syncBatch.ts +219 -0
  114. package/src/sync/syncFrontier.test.ts +494 -0
  115. package/src/sync/syncPhaseC.test.ts +718 -0
  116. package/src/sync/syncRoutes.test.ts +865 -0
  117. package/src/sync/syncSeqPlugin.ts +738 -0
  118. package/src/sync/syncSocket.test.ts +1440 -0
  119. package/src/sync/types.ts +270 -0
  120. package/src/terrenoApp.ts +37 -17
  121. package/src/tests/bunSetup.ts +8 -0
  122. package/tsconfig.json +4 -4
  123. package/tsconfig.typedoc.json +7 -1
  124. package/dist/__tests__/openApiCompat.test.js +0 -317
  125. package/dist/__tests__/versionCheckPlugin.test.d.ts +0 -1
  126. package/dist/__tests__/versionCheckPlugin.test.js +0 -597
  127. package/dist/actions.openApi.test.d.ts +0 -1
  128. package/dist/actions.openApi.test.js +0 -255
  129. package/dist/actions.test.d.ts +0 -1
  130. package/dist/actions.test.js +0 -1089
  131. package/dist/api.arrayOperations.test.d.ts +0 -1
  132. package/dist/api.arrayOperations.test.js +0 -878
  133. package/dist/api.asyncHandler.test.d.ts +0 -1
  134. package/dist/api.asyncHandler.test.js +0 -236
  135. package/dist/api.coverage.test.d.ts +0 -1
  136. package/dist/api.coverage.test.js +0 -194
  137. package/dist/api.errorPaths.test.d.ts +0 -1
  138. package/dist/api.errorPaths.test.js +0 -801
  139. package/dist/api.errors.test.d.ts +0 -1
  140. package/dist/api.errors.test.js +0 -185
  141. package/dist/api.hooks.test.d.ts +0 -1
  142. package/dist/api.hooks.test.js +0 -950
  143. package/dist/api.query.test.d.ts +0 -1
  144. package/dist/api.query.test.js +0 -948
  145. package/dist/api.test.d.ts +0 -1
  146. package/dist/api.test.js +0 -2820
  147. package/dist/auth.compile.test.d.ts +0 -1
  148. package/dist/auth.compile.test.js +0 -201
  149. package/dist/auth.coverage.test.d.ts +0 -1
  150. package/dist/auth.coverage.test.js +0 -202
  151. package/dist/auth.test.d.ts +0 -1
  152. package/dist/auth.test.js +0 -2286
  153. package/dist/betterAuth.test.d.ts +0 -1
  154. package/dist/betterAuth.test.js +0 -181
  155. package/dist/betterAuthApp.test.d.ts +0 -1
  156. package/dist/betterAuthApp.test.js +0 -242
  157. package/dist/betterAuthSetup.test.d.ts +0 -1
  158. package/dist/betterAuthSetup.test.js +0 -762
  159. package/dist/config.test.d.ts +0 -1
  160. package/dist/config.test.js +0 -353
  161. package/dist/configuration.test.d.ts +0 -1
  162. package/dist/configuration.test.js +0 -980
  163. package/dist/configurationPlugin.test.d.ts +0 -1
  164. package/dist/configurationPlugin.test.js +0 -827
  165. package/dist/consentApp.test.d.ts +0 -1
  166. package/dist/consentApp.test.js +0 -1415
  167. package/dist/docLoader.test.d.ts +0 -1
  168. package/dist/docLoader.test.js +0 -137
  169. package/dist/envConfigurationPlugin.test.d.ts +0 -1
  170. package/dist/envConfigurationPlugin.test.js +0 -369
  171. package/dist/errors.test.d.ts +0 -1
  172. package/dist/errors.test.js +0 -607
  173. package/dist/expressServer.test.d.ts +0 -1
  174. package/dist/expressServer.test.js +0 -1249
  175. package/dist/githubAuth.test.d.ts +0 -1
  176. package/dist/githubAuth.test.js +0 -1142
  177. package/dist/httpClient.test.d.ts +0 -1
  178. package/dist/httpClient.test.js +0 -1471
  179. package/dist/logger.test.d.ts +0 -1
  180. package/dist/logger.test.js +0 -685
  181. package/dist/middleware.test.d.ts +0 -1
  182. package/dist/middleware.test.js +0 -241
  183. package/dist/notifiers/googleChatNotifier.test.d.ts +0 -1
  184. package/dist/notifiers/googleChatNotifier.test.js +0 -298
  185. package/dist/notifiers/slackNotifier.test.d.ts +0 -1
  186. package/dist/notifiers/slackNotifier.test.js +0 -297
  187. package/dist/notifiers/zoomNotifier.test.d.ts +0 -1
  188. package/dist/notifiers/zoomNotifier.test.js +0 -373
  189. package/dist/openApi.test.d.ts +0 -1
  190. package/dist/openApi.test.js +0 -620
  191. package/dist/openApiBuilder.test.d.ts +0 -1
  192. package/dist/openApiBuilder.test.js +0 -601
  193. package/dist/openApiEtag.test.d.ts +0 -1
  194. package/dist/openApiEtag.test.js +0 -86
  195. package/dist/openApiValidator.test.d.ts +0 -1
  196. package/dist/openApiValidator.test.js +0 -761
  197. package/dist/permissions.middleware.test.d.ts +0 -1
  198. package/dist/permissions.middleware.test.js +0 -308
  199. package/dist/permissions.test.d.ts +0 -1
  200. package/dist/permissions.test.js +0 -439
  201. package/dist/plugins.test.d.ts +0 -1
  202. package/dist/plugins.test.js +0 -890
  203. package/dist/populate.test.d.ts +0 -1
  204. package/dist/populate.test.js +0 -373
  205. package/dist/realtime/realtime.test.d.ts +0 -10
  206. package/dist/realtime/realtime.test.js +0 -3982
  207. package/dist/requestContext.test.d.ts +0 -1
  208. package/dist/requestContext.test.js +0 -412
  209. package/dist/scriptRunner.test.d.ts +0 -1
  210. package/dist/scriptRunner.test.js +0 -386
  211. package/dist/secretProviders.test.d.ts +0 -1
  212. package/dist/secretProviders.test.js +0 -726
  213. package/dist/syncConsents.test.d.ts +0 -1
  214. package/dist/syncConsents.test.js +0 -522
  215. package/dist/terrenoApp.test.d.ts +0 -1
  216. package/dist/terrenoApp.test.js +0 -489
  217. package/dist/tests/bunSetup.d.ts +0 -1
  218. package/dist/tests/fixtures/compileAuthEntry.d.ts +0 -1
  219. package/dist/tests/fixtures/compileAuthEntry.js +0 -37
  220. package/dist/tests/testEnv.d.ts +0 -0
  221. package/dist/tests/testEnv.js +0 -6
  222. package/dist/transformers.test.d.ts +0 -1
  223. package/dist/transformers.test.js +0 -423
  224. package/dist/utils.test.d.ts +0 -1
  225. package/dist/utils.test.js +0 -242
  226. /package/dist/{__tests__/openApiCompat.test.d.ts → sync/loadHarness.d.ts} +0 -0
@@ -1,620 +0,0 @@
1
- "use strict";
2
- var __assign = (this && this.__assign) || function () {
3
- __assign = Object.assign || function(t) {
4
- for (var s, i = 1, n = arguments.length; i < n; i++) {
5
- s = arguments[i];
6
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
7
- t[p] = s[p];
8
- }
9
- return t;
10
- };
11
- return __assign.apply(this, arguments);
12
- };
13
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
14
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
15
- return new (P || (P = Promise))(function (resolve, reject) {
16
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
17
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
18
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
19
- step((generator = generator.apply(thisArg, _arguments || [])).next());
20
- });
21
- };
22
- var __generator = (this && this.__generator) || function (thisArg, body) {
23
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
24
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
25
- function verb(n) { return function (v) { return step([n, v]); }; }
26
- function step(op) {
27
- if (f) throw new TypeError("Generator is already executing.");
28
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
29
- if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
30
- if (y = 0, t) op = [op[0] & 2, t.value];
31
- switch (op[0]) {
32
- case 0: case 1: t = op; break;
33
- case 4: _.label++; return { value: op[1], done: false };
34
- case 5: _.label++; y = op[1]; op = [0]; continue;
35
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
36
- default:
37
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
38
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
39
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
40
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
41
- if (t[2]) _.ops.pop();
42
- _.trys.pop(); continue;
43
- }
44
- op = body.call(thisArg, _);
45
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
46
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
47
- }
48
- };
49
- var __read = (this && this.__read) || function (o, n) {
50
- var m = typeof Symbol === "function" && o[Symbol.iterator];
51
- if (!m) return o;
52
- var i = m.call(o), r, ar = [], e;
53
- try {
54
- while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
55
- }
56
- catch (error) { e = { error: error }; }
57
- finally {
58
- try {
59
- if (r && !r.done && (m = i["return"])) m.call(i);
60
- }
61
- finally { if (e) throw e.error; }
62
- }
63
- return ar;
64
- };
65
- var __importDefault = (this && this.__importDefault) || function (mod) {
66
- return (mod && mod.__esModule) ? mod : { "default": mod };
67
- };
68
- Object.defineProperty(exports, "__esModule", { value: true });
69
- // noExplicitAny: test mock typing
70
- // biome-ignore-all lint/suspicious/noExplicitAny: test mock typing
71
- var bun_test_1 = require("bun:test");
72
- var supertest_1 = __importDefault(require("supertest"));
73
- var api_1 = require("./api");
74
- var openApi_1 = require("./openApi");
75
- var permissions_1 = require("./permissions");
76
- var terrenoApp_1 = require("./terrenoApp");
77
- var tests_1 = require("./tests");
78
- function getMessageSummaryOpenApiMiddleware(options) {
79
- if (!options.openApi) {
80
- throw new Error("Expected openApi to be configured for test routes");
81
- }
82
- return options.openApi.path({
83
- parameters: [
84
- {
85
- in: "query",
86
- name: "foodIds",
87
- schema: {
88
- type: "string",
89
- },
90
- },
91
- ],
92
- responses: {
93
- 200: {
94
- content: {
95
- "application/json": {
96
- schema: {
97
- properties: {
98
- message: {
99
- type: "string",
100
- },
101
- },
102
- type: "object",
103
- },
104
- },
105
- },
106
- description: "Success",
107
- },
108
- },
109
- tags: ["Food"],
110
- });
111
- }
112
- function addRoutes(router, options) {
113
- var _this = this;
114
- router.use("/food", (0, api_1.modelRouter)(tests_1.FoodModel, __assign(__assign({}, options), { allowAnonymous: true, openApiExtraModelProperties: {
115
- foo: {
116
- type: "string",
117
- },
118
- }, permissions: {
119
- create: [permissions_1.Permissions.IsAny],
120
- delete: [permissions_1.Permissions.IsAny],
121
- list: [permissions_1.Permissions.IsAny],
122
- read: [permissions_1.Permissions.IsAny],
123
- update: [permissions_1.Permissions.IsAny],
124
- }, populatePaths: [{ path: "ownerId" }, { path: "eatenBy" }], queryFields: ["calories"] })));
125
- router.use("/food/count", getMessageSummaryOpenApiMiddleware, function (_req, res) { return __awaiter(_this, void 0, void 0, function () {
126
- return __generator(this, function (_a) {
127
- res.json({ message: "count" });
128
- return [2 /*return*/];
129
- });
130
- }); });
131
- }
132
- (0, bun_test_1.describe)("openApi", function () {
133
- var server;
134
- var app;
135
- (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
136
- return __generator(this, function (_a) {
137
- process.env.REFRESH_TOKEN_SECRET = "testsecret1234";
138
- process.env.ENABLE_SWAGGER = "true";
139
- app = new terrenoApp_1.TerrenoApp({
140
- configureApp: addRoutes,
141
- skipListen: true,
142
- userModel: tests_1.UserModel,
143
- }).build();
144
- return [2 /*return*/];
145
- });
146
- }); });
147
- (0, bun_test_1.it)("gets the openapi.json", function () { return __awaiter(void 0, void 0, void 0, function () {
148
- var res;
149
- return __generator(this, function (_a) {
150
- switch (_a.label) {
151
- case 0:
152
- server = (0, supertest_1.default)(app);
153
- return [4 /*yield*/, server.get("/openapi.json").expect(200)];
154
- case 1:
155
- res = _a.sent();
156
- (0, bun_test_1.expect)(res.body).toMatchSnapshot();
157
- return [2 /*return*/];
158
- }
159
- });
160
- }); });
161
- (0, bun_test_1.it)("gets the openapi.json with ETag header", function () { return __awaiter(void 0, void 0, void 0, function () {
162
- var res;
163
- return __generator(this, function (_a) {
164
- switch (_a.label) {
165
- case 0:
166
- server = (0, supertest_1.default)(app);
167
- return [4 /*yield*/, server.get("/openapi.json").expect(200)];
168
- case 1:
169
- res = _a.sent();
170
- (0, bun_test_1.expect)(res.headers.etag).toBeDefined();
171
- (0, bun_test_1.expect)(res.headers.etag).toMatch(/^"[a-f0-9]{16}"$/);
172
- return [2 /*return*/];
173
- }
174
- });
175
- }); });
176
- (0, bun_test_1.it)("returns 304 when If-None-Match matches ETag", function () { return __awaiter(void 0, void 0, void 0, function () {
177
- var firstRes, etag, secondRes;
178
- return __generator(this, function (_a) {
179
- switch (_a.label) {
180
- case 0:
181
- server = (0, supertest_1.default)(app);
182
- return [4 /*yield*/, server.get("/openapi.json").expect(200)];
183
- case 1:
184
- firstRes = _a.sent();
185
- etag = firstRes.headers.etag;
186
- (0, bun_test_1.expect)(etag).toBeDefined();
187
- return [4 /*yield*/, server.get("/openapi.json").set("If-None-Match", etag).expect(304)];
188
- case 2:
189
- secondRes = _a.sent();
190
- (0, bun_test_1.expect)(secondRes.body).toEqual({});
191
- (0, bun_test_1.expect)(secondRes.headers.etag).toBe(etag);
192
- return [2 /*return*/];
193
- }
194
- });
195
- }); });
196
- (0, bun_test_1.it)("returns 200 when If-None-Match does not match ETag", function () { return __awaiter(void 0, void 0, void 0, function () {
197
- var res;
198
- return __generator(this, function (_a) {
199
- switch (_a.label) {
200
- case 0:
201
- server = (0, supertest_1.default)(app);
202
- return [4 /*yield*/, server
203
- .get("/openapi.json")
204
- .set("If-None-Match", '"different-etag"')
205
- .expect(200)];
206
- case 1:
207
- res = _a.sent();
208
- (0, bun_test_1.expect)(res.body).toBeDefined();
209
- (0, bun_test_1.expect)(res.headers.etag).toBeDefined();
210
- (0, bun_test_1.expect)(res.headers.etag).not.toBe('"different-etag"');
211
- return [2 /*return*/];
212
- }
213
- });
214
- }); });
215
- (0, bun_test_1.it)("gets the swagger ui", function () { return __awaiter(void 0, void 0, void 0, function () {
216
- return __generator(this, function (_a) {
217
- switch (_a.label) {
218
- case 0:
219
- server = (0, supertest_1.default)(app);
220
- return [4 /*yield*/, server.get("/swagger/").expect(200)];
221
- case 1:
222
- _a.sent();
223
- return [2 /*return*/];
224
- }
225
- });
226
- }); });
227
- (0, bun_test_1.it)("gets food with populated paths", function () { return __awaiter(void 0, void 0, void 0, function () {
228
- var _a, _admin, notAdmin, food, res;
229
- return __generator(this, function (_b) {
230
- switch (_b.label) {
231
- case 0:
232
- server = (0, supertest_1.default)(app);
233
- return [4 /*yield*/, (0, tests_1.setupDb)()];
234
- case 1:
235
- _a = __read.apply(void 0, [_b.sent(), 2]), _admin = _a[0], notAdmin = _a[1];
236
- return [4 /*yield*/, tests_1.FoodModel.create({
237
- name: "test",
238
- ownerId: notAdmin._id,
239
- })];
240
- case 2:
241
- food = _b.sent();
242
- return [4 /*yield*/, server.get("/food/".concat(food._id)).expect(200)];
243
- case 3:
244
- res = _b.sent();
245
- (0, bun_test_1.expect)(res.body.data.ownerId._id).toEqual(notAdmin._id.toString());
246
- return [2 /*return*/];
247
- }
248
- });
249
- }); });
250
- // create a test for a custom express endpoint that doesnt use modelRouter and manually adds it
251
- // to openapi
252
- (0, bun_test_1.it)("gets the openapi.json with custom endpoint", function () { return __awaiter(void 0, void 0, void 0, function () {
253
- var res;
254
- return __generator(this, function (_a) {
255
- switch (_a.label) {
256
- case 0:
257
- server = (0, supertest_1.default)(app);
258
- return [4 /*yield*/, server.get("/openapi.json").expect(200)];
259
- case 1:
260
- res = _a.sent();
261
- (0, bun_test_1.expect)(res.body).toMatchSnapshot();
262
- return [2 /*return*/];
263
- }
264
- });
265
- }); });
266
- (0, bun_test_1.it)("gets the openapi.json and has correct Number query fields", function () { return __awaiter(void 0, void 0, void 0, function () {
267
- var res, foodQuery;
268
- return __generator(this, function (_a) {
269
- switch (_a.label) {
270
- case 0:
271
- server = (0, supertest_1.default)(app);
272
- return [4 /*yield*/, server.get("/openapi.json").expect(200)];
273
- case 1:
274
- res = _a.sent();
275
- foodQuery = res.body.paths["/food/"].get.parameters.find(function (p) { return p.name === "calories"; });
276
- // Ensure that a Number query field supports gt/gte/lt/lte and just a Number
277
- (0, bun_test_1.expect)(foodQuery.schema).toEqual({
278
- oneOf: [
279
- { description: "Number of calories in the food", type: "number" },
280
- {
281
- properties: {
282
- $gt: { description: "Number of calories in the food", type: "number" },
283
- $gte: { description: "Number of calories in the food", type: "number" },
284
- $lt: { description: "Number of calories in the food", type: "number" },
285
- $lte: { description: "Number of calories in the food", type: "number" },
286
- },
287
- type: "object",
288
- },
289
- ],
290
- });
291
- (0, bun_test_1.expect)(foodQuery).toMatchSnapshot();
292
- return [2 /*return*/];
293
- }
294
- });
295
- }); });
296
- });
297
- function addRoutesStringQuery(router, options) {
298
- router.use("/food", (0, api_1.modelRouter)(tests_1.FoodModel, __assign(__assign({}, options), { allowAnonymous: true, permissions: {
299
- create: [permissions_1.Permissions.IsAny],
300
- delete: [permissions_1.Permissions.IsAny],
301
- list: [permissions_1.Permissions.IsAny],
302
- read: [permissions_1.Permissions.IsAny],
303
- update: [permissions_1.Permissions.IsAny],
304
- }, queryFields: ["name"] })));
305
- }
306
- (0, bun_test_1.describe)("openApi string query fields", function () {
307
- var server;
308
- var app;
309
- (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
310
- return __generator(this, function (_a) {
311
- process.env.REFRESH_TOKEN_SECRET = "testsecret1234";
312
- process.env.ENABLE_SWAGGER = "true";
313
- app = new terrenoApp_1.TerrenoApp({
314
- configureApp: addRoutesStringQuery,
315
- skipListen: true,
316
- userModel: tests_1.UserModel,
317
- }).build();
318
- return [2 /*return*/];
319
- });
320
- }); });
321
- (0, bun_test_1.it)("builds an $in array query param for non-numeric query fields", function () { return __awaiter(void 0, void 0, void 0, function () {
322
- var res, nameQuery;
323
- return __generator(this, function (_a) {
324
- switch (_a.label) {
325
- case 0:
326
- server = (0, supertest_1.default)(app);
327
- return [4 /*yield*/, server.get("/openapi.json").expect(200)];
328
- case 1:
329
- res = _a.sent();
330
- nameQuery = res.body.paths["/food/"].get.parameters.find(function (p) { return p.name === "name"; });
331
- // Non-number/non-datetime fields support equality and $in array matching.
332
- (0, bun_test_1.expect)(nameQuery.schema).toEqual({
333
- oneOf: [
334
- { description: "The name of the food", type: "string" },
335
- {
336
- properties: {
337
- $in: { items: { type: "string" }, type: "array" },
338
- },
339
- type: "object",
340
- },
341
- ],
342
- });
343
- return [2 /*return*/];
344
- }
345
- });
346
- }); });
347
- });
348
- function addRoutesPopulate(router, options) {
349
- var _a;
350
- (_a = options === null || options === void 0 ? void 0 : options.openApi) === null || _a === void 0 ? void 0 : _a.component("schemas", "LimitedUser", {
351
- properties: {
352
- email: {
353
- description: "LimitedUser's email",
354
- type: "string",
355
- },
356
- name: {
357
- description: "LimitedUser's name",
358
- type: "string",
359
- },
360
- },
361
- type: "object",
362
- });
363
- router.use("/food", (0, api_1.modelRouter)(tests_1.FoodModel, __assign(__assign({}, options), { allowAnonymous: true, openApiExtraModelProperties: {
364
- foo: {
365
- type: "string",
366
- },
367
- }, permissions: {
368
- create: [permissions_1.Permissions.IsAny],
369
- delete: [permissions_1.Permissions.IsAny],
370
- list: [permissions_1.Permissions.IsAny],
371
- read: [permissions_1.Permissions.IsAny],
372
- update: [permissions_1.Permissions.IsAny],
373
- }, populatePaths: [
374
- { fields: ["name", "email"], path: "ownerId" },
375
- {
376
- fields: ["name", "email"],
377
- openApiComponent: "LimitedUser",
378
- path: "eatenBy",
379
- },
380
- {
381
- fields: ["name", "email"],
382
- openApiComponent: "LimitedUser",
383
- path: "likesIds.userId",
384
- },
385
- ] })));
386
- }
387
- (0, bun_test_1.describe)("openApi without swagger", function () {
388
- var server;
389
- var app;
390
- (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
391
- return __generator(this, function (_a) {
392
- process.env.REFRESH_TOKEN_SECRET = "testsecret1234";
393
- process.env.ENABLE_SWAGGER = "false";
394
- app = new terrenoApp_1.TerrenoApp({
395
- configureApp: addRoutes,
396
- skipListen: true,
397
- userModel: tests_1.UserModel,
398
- }).build();
399
- return [2 /*return*/];
400
- });
401
- }); });
402
- (0, bun_test_1.it)("does not have the swagger ui", function () { return __awaiter(void 0, void 0, void 0, function () {
403
- return __generator(this, function (_a) {
404
- switch (_a.label) {
405
- case 0:
406
- server = (0, supertest_1.default)(app);
407
- return [4 /*yield*/, server.get("/swagger/").expect(404)];
408
- case 1:
409
- _a.sent();
410
- return [2 /*return*/];
411
- }
412
- });
413
- }); });
414
- });
415
- (0, bun_test_1.describe)("openApi populate", function () {
416
- var server;
417
- var app;
418
- (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
419
- return __generator(this, function (_a) {
420
- process.env.REFRESH_TOKEN_SECRET = "testsecret1234";
421
- app = new terrenoApp_1.TerrenoApp({
422
- configureApp: addRoutesPopulate,
423
- skipListen: true,
424
- userModel: tests_1.UserModel,
425
- }).build();
426
- return [2 /*return*/];
427
- });
428
- }); });
429
- (0, bun_test_1.it)("gets the openapi.json with populate", function () { return __awaiter(void 0, void 0, void 0, function () {
430
- var res, properties;
431
- return __generator(this, function (_a) {
432
- switch (_a.label) {
433
- case 0:
434
- server = (0, supertest_1.default)(app);
435
- return [4 /*yield*/, server.get("/openapi.json").expect(200)];
436
- case 1:
437
- res = _a.sent();
438
- properties = res.body.paths["/food/{id}"].get.responses["200"].content["application/json"].schema
439
- .properties;
440
- // There's no component here, so we automatically generate the limited properties.
441
- (0, bun_test_1.expect)(properties.ownerId).toEqual({
442
- properties: {
443
- email: {
444
- type: "string",
445
- },
446
- name: {
447
- description: "The user's display name",
448
- type: "string",
449
- },
450
- },
451
- type: "object",
452
- });
453
- // We only reference the component here, rather than listing each field each time.
454
- (0, bun_test_1.expect)(properties.eatenBy).toEqual({
455
- items: {
456
- $ref: "#/components/schemas/LimitedUser",
457
- },
458
- type: "array",
459
- });
460
- (0, bun_test_1.expect)(properties.likesIds).toEqual({
461
- description: "User likes for this food",
462
- items: {
463
- properties: {
464
- _id: {
465
- type: "string",
466
- },
467
- likes: {
468
- description: "Whether the user liked the item",
469
- type: "boolean",
470
- },
471
- userId: {
472
- $ref: "#/components/schemas/LimitedUser",
473
- },
474
- },
475
- required: [],
476
- type: "object",
477
- },
478
- type: "array",
479
- });
480
- // Ensure the component is registered and used.
481
- (0, bun_test_1.expect)(res.body.components.schemas.LimitedUser).toEqual({
482
- properties: {
483
- email: {
484
- description: "LimitedUser's email",
485
- type: "string",
486
- },
487
- name: {
488
- description: "LimitedUser's name",
489
- type: "string",
490
- },
491
- },
492
- type: "object",
493
- });
494
- (0, bun_test_1.expect)(res.body).toMatchSnapshot();
495
- return [2 /*return*/];
496
- }
497
- });
498
- }); });
499
- });
500
- (0, bun_test_1.describe)("openApi middleware no-op paths", function () {
501
- (0, bun_test_1.it)("getOpenApiMiddleware returns noop when openApi not configured", function () {
502
- var mw = (0, openApi_1.getOpenApiMiddleware)(tests_1.FoodModel, {});
503
- (0, bun_test_1.expect)(typeof mw).toBe("function");
504
- (0, bun_test_1.expect)(mw.length).toBe(3);
505
- });
506
- (0, bun_test_1.it)("getOpenApiMiddleware returns noop when read permissions are empty", function () {
507
- var mw = (0, openApi_1.getOpenApiMiddleware)(tests_1.FoodModel, {
508
- openApi: { component: function () { }, path: function () { return (function () { }); } },
509
- permissions: {
510
- create: [],
511
- delete: [],
512
- list: [],
513
- read: [],
514
- update: [],
515
- },
516
- });
517
- (0, bun_test_1.expect)(typeof mw).toBe("function");
518
- (0, bun_test_1.expect)(mw.length).toBe(3);
519
- });
520
- (0, bun_test_1.it)("listOpenApiMiddleware returns noop when openApi not configured", function () {
521
- var mw = (0, openApi_1.listOpenApiMiddleware)(tests_1.FoodModel, {});
522
- (0, bun_test_1.expect)(mw.length).toBe(3);
523
- });
524
- (0, bun_test_1.it)("listOpenApiMiddleware returns noop when list permissions are empty", function () {
525
- var mw = (0, openApi_1.listOpenApiMiddleware)(tests_1.FoodModel, {
526
- openApi: { path: function () { return (function () { }); } },
527
- permissions: {
528
- create: [],
529
- delete: [],
530
- list: [],
531
- read: [],
532
- update: [],
533
- },
534
- });
535
- (0, bun_test_1.expect)(mw.length).toBe(3);
536
- });
537
- (0, bun_test_1.it)("createOpenApiMiddleware returns noop when openApi not configured", function () {
538
- var mw = (0, openApi_1.createOpenApiMiddleware)(tests_1.FoodModel, {});
539
- (0, bun_test_1.expect)(mw.length).toBe(3);
540
- });
541
- (0, bun_test_1.it)("createOpenApiMiddleware returns noop when create permissions are empty", function () {
542
- var mw = (0, openApi_1.createOpenApiMiddleware)(tests_1.FoodModel, {
543
- openApi: { path: function () { return (function () { }); } },
544
- permissions: {
545
- create: [],
546
- delete: [],
547
- list: [],
548
- read: [],
549
- update: [],
550
- },
551
- });
552
- (0, bun_test_1.expect)(mw.length).toBe(3);
553
- });
554
- (0, bun_test_1.it)("patchOpenApiMiddleware returns noop when openApi not configured", function () {
555
- var mw = (0, openApi_1.patchOpenApiMiddleware)(tests_1.FoodModel, {});
556
- (0, bun_test_1.expect)(mw.length).toBe(3);
557
- });
558
- (0, bun_test_1.it)("patchOpenApiMiddleware returns noop when update permissions are empty", function () {
559
- var mw = (0, openApi_1.patchOpenApiMiddleware)(tests_1.FoodModel, {
560
- openApi: { path: function () { return (function () { }); } },
561
- permissions: {
562
- create: [],
563
- delete: [],
564
- list: [],
565
- read: [],
566
- update: [],
567
- },
568
- });
569
- (0, bun_test_1.expect)(mw.length).toBe(3);
570
- });
571
- (0, bun_test_1.it)("deleteOpenApiMiddleware returns noop when openApi not configured", function () {
572
- var mw = (0, openApi_1.deleteOpenApiMiddleware)(tests_1.FoodModel, {});
573
- (0, bun_test_1.expect)(mw.length).toBe(3);
574
- });
575
- (0, bun_test_1.it)("deleteOpenApiMiddleware returns noop when delete permissions are empty", function () {
576
- var mw = (0, openApi_1.deleteOpenApiMiddleware)(tests_1.FoodModel, {
577
- openApi: { path: function () { return (function () { }); } },
578
- permissions: {
579
- create: [],
580
- delete: [],
581
- list: [],
582
- read: [],
583
- update: [],
584
- },
585
- });
586
- (0, bun_test_1.expect)(mw.length).toBe(3);
587
- });
588
- (0, bun_test_1.it)("readOpenApiMiddleware returns noop when openApi not configured", function () {
589
- var mw = (0, openApi_1.readOpenApiMiddleware)({}, {}, [], []);
590
- (0, bun_test_1.expect)(mw.length).toBe(3);
591
- });
592
- (0, bun_test_1.it)("readOpenApiMiddleware returns noop when read permissions are empty", function () {
593
- var mw = (0, openApi_1.readOpenApiMiddleware)({
594
- openApi: { path: function () { return (function () { }); } },
595
- permissions: {
596
- create: [],
597
- delete: [],
598
- list: [],
599
- read: [],
600
- update: [],
601
- },
602
- }, { id: { type: "string" } }, ["id"], []);
603
- (0, bun_test_1.expect)(mw.length).toBe(3);
604
- });
605
- (0, bun_test_1.it)("readOpenApiMiddleware returns middleware when configured with permissions", function () {
606
- // Use a simple path stub that returns a middleware function
607
- var pathFn = function () { return (function (_req, _res, next) { return next(); }); };
608
- var mw = (0, openApi_1.readOpenApiMiddleware)({
609
- openApi: { path: pathFn },
610
- permissions: {
611
- create: [],
612
- delete: [],
613
- list: [],
614
- read: [permissions_1.Permissions.IsAny],
615
- update: [],
616
- },
617
- }, { name: { type: "string" } }, ["name"], [{ in: "query", name: "search", schema: { type: "string" } }]);
618
- (0, bun_test_1.expect)(typeof mw).toBe("function");
619
- });
620
- });
@@ -1 +0,0 @@
1
- export {};