@terreno/api 0.31.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 (250) hide show
  1. package/CHANGELOG.md +122 -2
  2. package/LICENSE +202 -21
  3. package/dist/api.d.ts +12 -3
  4. package/dist/api.js +110 -361
  5. package/dist/auth.d.ts +26 -0
  6. package/dist/auth.js +100 -1
  7. package/dist/betterAuth.d.ts +5 -0
  8. package/dist/betterAuthSetup.d.ts +1 -15
  9. package/dist/betterAuthSetup.js +29 -8
  10. package/dist/configurationPlugin.js +2 -2
  11. package/dist/docLoader.js +12 -9
  12. package/dist/errors.d.ts +13 -0
  13. package/dist/errors.js +29 -1
  14. package/dist/expressServer.js +5 -11
  15. package/dist/githubAuth.js +4 -1
  16. package/dist/index.d.ts +17 -1
  17. package/dist/index.js +29 -1
  18. package/dist/middleware.d.ts +7 -0
  19. package/dist/middleware.js +16 -1
  20. package/dist/openApiCompat.d.ts +10 -1
  21. package/dist/openApiCompat.js +115 -47
  22. package/dist/permissions.d.ts +27 -0
  23. package/dist/permissions.js +42 -1
  24. package/dist/plugins.d.ts +15 -3
  25. package/dist/plugins.js +36 -6
  26. package/dist/realtime/changeStreamWatcher.d.ts +100 -3
  27. package/dist/realtime/changeStreamWatcher.js +542 -137
  28. package/dist/realtime/realtimeApp.d.ts +3 -1
  29. package/dist/realtime/realtimeApp.js +75 -27
  30. package/dist/realtime/sessionRevalidation.d.ts +90 -0
  31. package/dist/realtime/sessionRevalidation.js +438 -0
  32. package/dist/realtime/socketAuth.d.ts +97 -0
  33. package/dist/realtime/socketAuth.js +272 -0
  34. package/dist/realtime/socketUser.d.ts +54 -0
  35. package/dist/realtime/socketUser.js +75 -5
  36. package/dist/realtime/types.d.ts +40 -0
  37. package/dist/secretProviders.d.ts +23 -0
  38. package/dist/secretProviders.js +9 -3
  39. package/dist/sync/executors.d.ts +198 -0
  40. package/dist/sync/executors.js +670 -0
  41. package/dist/sync/loadHarness.js +807 -0
  42. package/dist/sync/models.d.ts +216 -0
  43. package/dist/sync/models.js +644 -0
  44. package/dist/sync/mutationHandler.d.ts +97 -0
  45. package/dist/sync/mutationHandler.js +886 -0
  46. package/dist/sync/registry.d.ts +73 -0
  47. package/dist/sync/registry.js +223 -0
  48. package/dist/sync/routes.d.ts +62 -0
  49. package/dist/sync/routes.js +936 -0
  50. package/dist/sync/scripts/compactTombstones.d.ts +47 -0
  51. package/dist/sync/scripts/compactTombstones.js +270 -0
  52. package/dist/sync/serialize.d.ts +20 -0
  53. package/dist/{tests/bunSetup.js → sync/serialize.js} +35 -68
  54. package/dist/sync/socketHandlers.d.ts +54 -0
  55. package/dist/sync/socketHandlers.js +470 -0
  56. package/dist/sync/streams.d.ts +85 -0
  57. package/dist/sync/streams.js +221 -0
  58. package/dist/sync/syncApp.d.ts +29 -0
  59. package/dist/sync/syncApp.js +44 -0
  60. package/dist/sync/syncBatch.d.ts +71 -0
  61. package/dist/sync/syncBatch.js +252 -0
  62. package/dist/sync/syncSeqPlugin.d.ts +8 -0
  63. package/dist/sync/syncSeqPlugin.js +903 -0
  64. package/dist/sync/types.d.ts +254 -0
  65. package/dist/sync/types.js +9 -0
  66. package/dist/terrenoApp.js +90 -27
  67. package/dist/tests/models.d.ts +11 -27
  68. package/dist/tests/models.js +3 -5
  69. package/dist/tests/testHelper.d.ts +3 -9
  70. package/dist/vendor/wesleytodd-openapi/index.d.ts +1 -1
  71. package/dist/vendor/wesleytodd-openapi/lib/ui.d.ts +2 -1
  72. package/package.json +10 -8
  73. package/src/__tests__/openApiCompat.test.ts +20 -0
  74. package/src/actions.test.ts +12 -19
  75. package/src/actions.ts +2 -2
  76. package/src/api.coverage.test.ts +9 -7
  77. package/src/api.errorPaths.test.ts +1 -47
  78. package/src/api.test.ts +12 -0
  79. package/src/api.ts +98 -317
  80. package/src/auth.test.ts +128 -176
  81. package/src/auth.ts +109 -0
  82. package/src/betterAuth.ts +6 -0
  83. package/src/betterAuthSetup.test.ts +34 -0
  84. package/src/betterAuthSetup.ts +27 -8
  85. package/src/configurationPlugin.ts +2 -2
  86. package/src/consentApp.test.ts +12 -12
  87. package/src/docLoader.ts +3 -1
  88. package/src/errors.ts +33 -0
  89. package/src/expressServer.test.ts +7 -1
  90. package/src/expressServer.ts +5 -11
  91. package/src/githubAuth.ts +3 -1
  92. package/src/index.ts +42 -0
  93. package/src/middleware.test.ts +40 -1
  94. package/src/middleware.ts +15 -0
  95. package/src/models/versionConfig.ts +1 -1
  96. package/src/openApiBuilder.test.ts +9 -24
  97. package/src/openApiCompat.ts +99 -45
  98. package/src/openApiValidator.test.ts +0 -41
  99. package/src/permissions.test.ts +75 -1
  100. package/src/permissions.ts +49 -0
  101. package/src/plugins.test.ts +54 -14
  102. package/src/plugins.ts +47 -9
  103. package/src/populate.test.ts +16 -25
  104. package/src/realtime/changeStreamWatcher.ts +552 -114
  105. package/src/realtime/realtime.test.ts +157 -239
  106. package/src/realtime/realtimeApp.ts +80 -19
  107. package/src/realtime/sessionRevalidation.test.ts +423 -0
  108. package/src/realtime/sessionRevalidation.ts +273 -0
  109. package/src/realtime/socketAuth.test.ts +355 -0
  110. package/src/realtime/socketAuth.ts +228 -0
  111. package/src/realtime/socketUser.ts +69 -0
  112. package/src/realtime/types.ts +40 -0
  113. package/src/secretProviders.test.ts +7 -1
  114. package/src/secretProviders.ts +15 -3
  115. package/src/sync/ensureSyncIndexes.test.ts +144 -0
  116. package/src/sync/executors.test.ts +882 -0
  117. package/src/sync/executors.ts +703 -0
  118. package/src/sync/integration.test.ts +1160 -0
  119. package/src/sync/loadHarness.ts +618 -0
  120. package/src/sync/models.ts +640 -0
  121. package/src/sync/mutationHandler.test.ts +1252 -0
  122. package/src/sync/mutationHandler.ts +850 -0
  123. package/src/sync/registry.ts +232 -0
  124. package/src/sync/routes.ts +812 -0
  125. package/src/sync/scripts/compactTombstones.test.ts +249 -0
  126. package/src/sync/scripts/compactTombstones.ts +145 -0
  127. package/src/sync/serialize.ts +48 -0
  128. package/src/sync/sessionRevalidationIntegration.test.ts +281 -0
  129. package/src/sync/socketHandlers.ts +320 -0
  130. package/src/sync/streams.ts +188 -0
  131. package/src/sync/sync.test.ts +582 -0
  132. package/src/sync/syncApp.ts +44 -0
  133. package/src/sync/syncBatch.ts +219 -0
  134. package/src/sync/syncFrontier.test.ts +494 -0
  135. package/src/sync/syncPhaseC.test.ts +718 -0
  136. package/src/sync/syncRoutes.test.ts +865 -0
  137. package/src/sync/syncSeqPlugin.ts +738 -0
  138. package/src/sync/syncSocket.test.ts +1440 -0
  139. package/src/sync/types.ts +270 -0
  140. package/src/terrenoApp.ts +37 -17
  141. package/src/tests/bunSetup.ts +8 -0
  142. package/src/tests/models.ts +6 -8
  143. package/tsconfig.json +4 -4
  144. package/tsconfig.typedoc.json +7 -1
  145. package/dist/__tests__/openApiCompat.test.js +0 -317
  146. package/dist/__tests__/versionCheckPlugin.test.d.ts +0 -1
  147. package/dist/__tests__/versionCheckPlugin.test.js +0 -597
  148. package/dist/actions.openApi.test.d.ts +0 -1
  149. package/dist/actions.openApi.test.js +0 -253
  150. package/dist/actions.test.d.ts +0 -1
  151. package/dist/actions.test.js +0 -1087
  152. package/dist/api.arrayOperations.test.d.ts +0 -1
  153. package/dist/api.arrayOperations.test.js +0 -878
  154. package/dist/api.asyncHandler.test.d.ts +0 -1
  155. package/dist/api.asyncHandler.test.js +0 -236
  156. package/dist/api.coverage.test.d.ts +0 -1
  157. package/dist/api.coverage.test.js +0 -192
  158. package/dist/api.errorPaths.test.d.ts +0 -1
  159. package/dist/api.errorPaths.test.js +0 -887
  160. package/dist/api.errors.test.d.ts +0 -1
  161. package/dist/api.errors.test.js +0 -185
  162. package/dist/api.hooks.test.d.ts +0 -1
  163. package/dist/api.hooks.test.js +0 -950
  164. package/dist/api.query.test.d.ts +0 -1
  165. package/dist/api.query.test.js +0 -948
  166. package/dist/api.test.d.ts +0 -1
  167. package/dist/api.test.js +0 -2820
  168. package/dist/auth.compile.test.d.ts +0 -1
  169. package/dist/auth.compile.test.js +0 -201
  170. package/dist/auth.coverage.test.d.ts +0 -1
  171. package/dist/auth.coverage.test.js +0 -202
  172. package/dist/auth.test.d.ts +0 -1
  173. package/dist/auth.test.js +0 -2286
  174. package/dist/betterAuth.test.d.ts +0 -1
  175. package/dist/betterAuth.test.js +0 -181
  176. package/dist/betterAuthApp.test.d.ts +0 -1
  177. package/dist/betterAuthApp.test.js +0 -242
  178. package/dist/betterAuthSetup.test.d.ts +0 -1
  179. package/dist/betterAuthSetup.test.js +0 -762
  180. package/dist/config.test.d.ts +0 -1
  181. package/dist/config.test.js +0 -353
  182. package/dist/configuration.test.d.ts +0 -1
  183. package/dist/configuration.test.js +0 -980
  184. package/dist/configurationPlugin.test.d.ts +0 -1
  185. package/dist/configurationPlugin.test.js +0 -827
  186. package/dist/consentApp.test.d.ts +0 -1
  187. package/dist/consentApp.test.js +0 -1411
  188. package/dist/docLoader.test.d.ts +0 -1
  189. package/dist/docLoader.test.js +0 -137
  190. package/dist/envConfigurationPlugin.test.d.ts +0 -1
  191. package/dist/envConfigurationPlugin.test.js +0 -369
  192. package/dist/errors.test.d.ts +0 -1
  193. package/dist/errors.test.js +0 -607
  194. package/dist/expressServer.test.d.ts +0 -1
  195. package/dist/expressServer.test.js +0 -1249
  196. package/dist/githubAuth.test.d.ts +0 -1
  197. package/dist/githubAuth.test.js +0 -1142
  198. package/dist/httpClient.test.d.ts +0 -1
  199. package/dist/httpClient.test.js +0 -1471
  200. package/dist/logger.test.d.ts +0 -1
  201. package/dist/logger.test.js +0 -685
  202. package/dist/middleware.test.d.ts +0 -1
  203. package/dist/middleware.test.js +0 -241
  204. package/dist/notifiers/googleChatNotifier.test.d.ts +0 -1
  205. package/dist/notifiers/googleChatNotifier.test.js +0 -298
  206. package/dist/notifiers/slackNotifier.test.d.ts +0 -1
  207. package/dist/notifiers/slackNotifier.test.js +0 -297
  208. package/dist/notifiers/zoomNotifier.test.d.ts +0 -1
  209. package/dist/notifiers/zoomNotifier.test.js +0 -373
  210. package/dist/openApi.test.d.ts +0 -1
  211. package/dist/openApi.test.js +0 -620
  212. package/dist/openApiBuilder.test.d.ts +0 -1
  213. package/dist/openApiBuilder.test.js +0 -599
  214. package/dist/openApiEtag.test.d.ts +0 -1
  215. package/dist/openApiEtag.test.js +0 -86
  216. package/dist/openApiValidator.test.d.ts +0 -1
  217. package/dist/openApiValidator.test.js +0 -795
  218. package/dist/permissions.middleware.test.d.ts +0 -1
  219. package/dist/permissions.middleware.test.js +0 -308
  220. package/dist/permissions.test.d.ts +0 -1
  221. package/dist/permissions.test.js +0 -439
  222. package/dist/plugins.test.d.ts +0 -1
  223. package/dist/plugins.test.js +0 -902
  224. package/dist/populate.test.d.ts +0 -1
  225. package/dist/populate.test.js +0 -370
  226. package/dist/realtime/realtime.test.d.ts +0 -10
  227. package/dist/realtime/realtime.test.js +0 -4213
  228. package/dist/realtime/realtimeAppSetup.test.d.ts +0 -1
  229. package/dist/realtime/realtimeAppSetup.test.js +0 -213
  230. package/dist/requestContext.test.d.ts +0 -1
  231. package/dist/requestContext.test.js +0 -412
  232. package/dist/scriptRunner.test.d.ts +0 -1
  233. package/dist/scriptRunner.test.js +0 -386
  234. package/dist/secretProviders.test.d.ts +0 -1
  235. package/dist/secretProviders.test.js +0 -726
  236. package/dist/syncConsents.test.d.ts +0 -1
  237. package/dist/syncConsents.test.js +0 -522
  238. package/dist/terrenoApp.test.d.ts +0 -1
  239. package/dist/terrenoApp.test.js +0 -489
  240. package/dist/tests/bunSetup.d.ts +0 -1
  241. package/dist/tests/fixtures/compileAuthEntry.d.ts +0 -1
  242. package/dist/tests/fixtures/compileAuthEntry.js +0 -37
  243. package/dist/tests/testEnv.d.ts +0 -0
  244. package/dist/tests/testEnv.js +0 -6
  245. package/dist/transformers.test.d.ts +0 -1
  246. package/dist/transformers.test.js +0 -423
  247. package/dist/utils.test.d.ts +0 -1
  248. package/dist/utils.test.js +0 -242
  249. package/src/realtime/realtimeAppSetup.test.ts +0 -161
  250. /package/dist/{__tests__/openApiCompat.test.d.ts → sync/loadHarness.d.ts} +0 -0
@@ -1,597 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- var __generator = (this && this.__generator) || function (thisArg, body) {
12
- 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);
13
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
14
- function verb(n) { return function (v) { return step([n, v]); }; }
15
- function step(op) {
16
- if (f) throw new TypeError("Generator is already executing.");
17
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
18
- 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;
19
- if (y = 0, t) op = [op[0] & 2, t.value];
20
- switch (op[0]) {
21
- case 0: case 1: t = op; break;
22
- case 4: _.label++; return { value: op[1], done: false };
23
- case 5: _.label++; y = op[1]; op = [0]; continue;
24
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
25
- default:
26
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
27
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
28
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
29
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
30
- if (t[2]) _.ops.pop();
31
- _.trys.pop(); continue;
32
- }
33
- op = body.call(thisArg, _);
34
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
35
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
36
- }
37
- };
38
- var __values = (this && this.__values) || function(o) {
39
- var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
40
- if (m) return m.call(o);
41
- if (o && typeof o.length === "number") return {
42
- next: function () {
43
- if (o && i >= o.length) o = void 0;
44
- return { value: o && o[i++], done: !o };
45
- }
46
- };
47
- throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
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
- var bun_test_1 = require("bun:test");
70
- var chai_1 = require("chai");
71
- var supertest_1 = __importDefault(require("supertest"));
72
- var versionConfig_1 = require("../models/versionConfig");
73
- var terrenoApp_1 = require("../terrenoApp");
74
- var tests_1 = require("../tests");
75
- var versionCheckPlugin_1 = require("../versionCheckPlugin");
76
- var typedUserModel = tests_1.UserModel;
77
- (0, bun_test_1.describe)("VersionCheckPlugin", function () {
78
- var app;
79
- (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
80
- var expressApp;
81
- return __generator(this, function (_a) {
82
- switch (_a.label) {
83
- case 0: return [4 /*yield*/, (0, tests_1.setupDb)()];
84
- case 1:
85
- _a.sent();
86
- return [4 /*yield*/, versionConfig_1.VersionConfig.deleteMany({})];
87
- case 2:
88
- _a.sent();
89
- expressApp = new terrenoApp_1.TerrenoApp({
90
- skipListen: true,
91
- userModel: typedUserModel,
92
- })
93
- .register(new versionCheckPlugin_1.VersionCheckPlugin())
94
- .build();
95
- app = (0, supertest_1.default)(expressApp);
96
- return [2 /*return*/];
97
- }
98
- });
99
- }); });
100
- (0, bun_test_1.afterEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
101
- return __generator(this, function (_a) {
102
- switch (_a.label) {
103
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.deleteMany({})];
104
- case 1:
105
- _a.sent();
106
- return [2 /*return*/];
107
- }
108
- });
109
- }); });
110
- (0, bun_test_1.it)("returns ok when no VersionConfig exists", function () { return __awaiter(void 0, void 0, void 0, function () {
111
- var res;
112
- return __generator(this, function (_a) {
113
- switch (_a.label) {
114
- case 0: return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 100 })];
115
- case 1:
116
- res = _a.sent();
117
- (0, bun_test_1.expect)(res.status).toBe(200);
118
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
119
- (0, bun_test_1.expect)(res.body).toEqual(bun_test_1.expect.objectContaining({
120
- pollingIntervalMs: 86400000,
121
- status: "ok",
122
- }));
123
- return [2 /*return*/];
124
- }
125
- });
126
- }); });
127
- (0, bun_test_1.it)("returns ok when version param is missing", function () { return __awaiter(void 0, void 0, void 0, function () {
128
- var res;
129
- return __generator(this, function (_a) {
130
- switch (_a.label) {
131
- case 0: return [4 /*yield*/, app.get("/version-check")];
132
- case 1:
133
- res = _a.sent();
134
- (0, bun_test_1.expect)(res.status).toBe(200);
135
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
136
- (0, bun_test_1.expect)(res.body).toEqual(bun_test_1.expect.objectContaining({ status: "ok" }));
137
- return [2 /*return*/];
138
- }
139
- });
140
- }); });
141
- (0, bun_test_1.it)("returns ok when version param is invalid", function () { return __awaiter(void 0, void 0, void 0, function () {
142
- var res;
143
- return __generator(this, function (_a) {
144
- switch (_a.label) {
145
- case 0: return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: "invalid" })];
146
- case 1:
147
- res = _a.sent();
148
- (0, bun_test_1.expect)(res.status).toBe(200);
149
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
150
- (0, bun_test_1.expect)(res.body).toEqual(bun_test_1.expect.objectContaining({ status: "ok" }));
151
- return [2 /*return*/];
152
- }
153
- });
154
- }); });
155
- (0, bun_test_1.it)("returns ok when version is provided more than once", function () { return __awaiter(void 0, void 0, void 0, function () {
156
- var res;
157
- return __generator(this, function (_a) {
158
- switch (_a.label) {
159
- case 0: return [4 /*yield*/, app.get("/version-check?platform=mobile&version=1&version=2")];
160
- case 1:
161
- res = _a.sent();
162
- chai_1.assert.equal(res.status, 200);
163
- chai_1.assert.equal(res.body.status, "ok");
164
- chai_1.assert.notProperty(res.body, "pollingIntervalMs");
165
- return [2 /*return*/];
166
- }
167
- });
168
- }); });
169
- (0, bun_test_1.it)("returns ok when client version >= warning and required (web)", function () { return __awaiter(void 0, void 0, void 0, function () {
170
- var res;
171
- return __generator(this, function (_a) {
172
- switch (_a.label) {
173
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
174
- webRequiredVersion: 50,
175
- webWarningVersion: 100,
176
- })];
177
- case 1:
178
- _a.sent();
179
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 150 })];
180
- case 2:
181
- res = _a.sent();
182
- (0, bun_test_1.expect)(res.status).toBe(200);
183
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
184
- (0, bun_test_1.expect)(res.body).toEqual(bun_test_1.expect.objectContaining({
185
- pollingIntervalMs: 86400000,
186
- requiredVersion: 50,
187
- status: "ok",
188
- warningVersion: 100,
189
- }));
190
- return [2 /*return*/];
191
- }
192
- });
193
- }); });
194
- (0, bun_test_1.it)("returns warning when client version < warning (web)", function () { return __awaiter(void 0, void 0, void 0, function () {
195
- var res;
196
- return __generator(this, function (_a) {
197
- switch (_a.label) {
198
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
199
- warningMessage: "Please update!",
200
- webRequiredVersion: 50,
201
- webWarningVersion: 100,
202
- })];
203
- case 1:
204
- _a.sent();
205
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 80 })];
206
- case 2:
207
- res = _a.sent();
208
- (0, bun_test_1.expect)(res.status).toBe(200);
209
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
210
- (0, bun_test_1.expect)(res.body.status).toBe("warning");
211
- (0, bun_test_1.expect)(res.body.message).toBe("Please update!");
212
- return [2 /*return*/];
213
- }
214
- });
215
- }); });
216
- (0, bun_test_1.it)("returns required when client version < required (web)", function () { return __awaiter(void 0, void 0, void 0, function () {
217
- var res;
218
- return __generator(this, function (_a) {
219
- switch (_a.label) {
220
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
221
- requiredMessage: "Update required",
222
- updateUrl: "https://example.com/update",
223
- webRequiredVersion: 100,
224
- webWarningVersion: 150,
225
- })];
226
- case 1:
227
- _a.sent();
228
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 50 })];
229
- case 2:
230
- res = _a.sent();
231
- (0, bun_test_1.expect)(res.status).toBe(200);
232
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
233
- (0, bun_test_1.expect)(res.body.status).toBe("required");
234
- (0, bun_test_1.expect)(res.body.message).toBe("Update required");
235
- (0, bun_test_1.expect)(res.body.updateUrl).toBe("https://example.com/update");
236
- return [2 /*return*/];
237
- }
238
- });
239
- }); });
240
- (0, bun_test_1.it)("uses mobile thresholds when platform is mobile", function () { return __awaiter(void 0, void 0, void 0, function () {
241
- var webRes, mobileRes;
242
- return __generator(this, function (_a) {
243
- switch (_a.label) {
244
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
245
- mobileRequiredVersion: 200,
246
- mobileWarningVersion: 250,
247
- webRequiredVersion: 50,
248
- webWarningVersion: 80,
249
- })];
250
- case 1:
251
- _a.sent();
252
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 100 })];
253
- case 2:
254
- webRes = _a.sent();
255
- (0, bun_test_1.expect)(webRes.body.requestId).toBe(webRes.headers["x-request-id"]);
256
- (0, bun_test_1.expect)(webRes.body.status).toBe("ok");
257
- return [4 /*yield*/, app.get("/version-check").query({ platform: "mobile", version: 100 })];
258
- case 3:
259
- mobileRes = _a.sent();
260
- (0, bun_test_1.expect)(mobileRes.body.requestId).toBe(mobileRes.headers["x-request-id"]);
261
- (0, bun_test_1.expect)(mobileRes.body.status).toBe("required");
262
- return [2 /*return*/];
263
- }
264
- });
265
- }); });
266
- (0, bun_test_1.it)("returns warning when a mobile version is below the mobile warning threshold", function () { return __awaiter(void 0, void 0, void 0, function () {
267
- var res;
268
- return __generator(this, function (_a) {
269
- switch (_a.label) {
270
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
271
- mobileRequiredVersion: 100,
272
- mobileWarningVersion: 200,
273
- warningMessage: "Update the mobile app",
274
- })];
275
- case 1:
276
- _a.sent();
277
- return [4 /*yield*/, app.get("/version-check").query({ platform: "mobile", version: 150 })];
278
- case 2:
279
- res = _a.sent();
280
- (0, bun_test_1.expect)(res.status).toBe(200);
281
- (0, bun_test_1.expect)(res.body).toEqual(bun_test_1.expect.objectContaining({
282
- message: "Update the mobile app",
283
- requiredVersion: 100,
284
- status: "warning",
285
- warningVersion: 200,
286
- }));
287
- return [2 /*return*/];
288
- }
289
- });
290
- }); });
291
- (0, bun_test_1.it)("omits mobile thresholds when they are not configured", function () { return __awaiter(void 0, void 0, void 0, function () {
292
- var res;
293
- return __generator(this, function (_a) {
294
- switch (_a.label) {
295
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({})];
296
- case 1:
297
- _a.sent();
298
- return [4 /*yield*/, app.get("/version-check").query({ platform: "mobile", version: 1 })];
299
- case 2:
300
- res = _a.sent();
301
- (0, bun_test_1.expect)(res.status).toBe(200);
302
- (0, bun_test_1.expect)(res.body).toEqual(bun_test_1.expect.objectContaining({
303
- status: "ok",
304
- }));
305
- (0, bun_test_1.expect)(res.body.requiredVersion).toBeUndefined();
306
- (0, bun_test_1.expect)(res.body.warningVersion).toBeUndefined();
307
- return [2 /*return*/];
308
- }
309
- });
310
- }); });
311
- (0, bun_test_1.it)("defaults to web when platform is invalid", function () { return __awaiter(void 0, void 0, void 0, function () {
312
- var res;
313
- return __generator(this, function (_a) {
314
- switch (_a.label) {
315
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
316
- webRequiredVersion: 100,
317
- webWarningVersion: 150,
318
- })];
319
- case 1:
320
- _a.sent();
321
- return [4 /*yield*/, app.get("/version-check").query({ platform: "invalid", version: 50 })];
322
- case 2:
323
- res = _a.sent();
324
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
325
- (0, bun_test_1.expect)(res.body.status).toBe("required");
326
- return [2 /*return*/];
327
- }
328
- });
329
- }); });
330
- (0, bun_test_1.it)("version equal to threshold returns ok (not warning)", function () { return __awaiter(void 0, void 0, void 0, function () {
331
- var res;
332
- return __generator(this, function (_a) {
333
- switch (_a.label) {
334
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
335
- webRequiredVersion: 50,
336
- webWarningVersion: 100,
337
- })];
338
- case 1:
339
- _a.sent();
340
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 100 })];
341
- case 2:
342
- res = _a.sent();
343
- (0, bun_test_1.expect)(res.status).toBe(200);
344
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
345
- (0, bun_test_1.expect)(res.body).toEqual(bun_test_1.expect.objectContaining({
346
- pollingIntervalMs: 86400000,
347
- requiredVersion: 50,
348
- status: "ok",
349
- warningVersion: 100,
350
- }));
351
- return [2 /*return*/];
352
- }
353
- });
354
- }); });
355
- (0, bun_test_1.it)("returns pollingIntervalMs from config pollingIntervalMinutes", function () { return __awaiter(void 0, void 0, void 0, function () {
356
- var res;
357
- return __generator(this, function (_a) {
358
- switch (_a.label) {
359
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
360
- pollingIntervalMinutes: 60,
361
- webRequiredVersion: 0,
362
- webWarningVersion: 0,
363
- })];
364
- case 1:
365
- _a.sent();
366
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 100 })];
367
- case 2:
368
- res = _a.sent();
369
- (0, bun_test_1.expect)(res.status).toBe(200);
370
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
371
- (0, bun_test_1.expect)(res.body.pollingIntervalMs).toBe(3600000);
372
- return [2 /*return*/];
373
- }
374
- });
375
- }); });
376
- (0, bun_test_1.it)("returns default pollingIntervalMs (86400000) when pollingIntervalMinutes not set", function () { return __awaiter(void 0, void 0, void 0, function () {
377
- var res;
378
- return __generator(this, function (_a) {
379
- switch (_a.label) {
380
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
381
- webRequiredVersion: 0,
382
- webWarningVersion: 0,
383
- })];
384
- case 1:
385
- _a.sent();
386
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 100 })];
387
- case 2:
388
- res = _a.sent();
389
- (0, bun_test_1.expect)(res.status).toBe(200);
390
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
391
- (0, bun_test_1.expect)(res.body.pollingIntervalMs).toBe(86400000);
392
- return [2 /*return*/];
393
- }
394
- });
395
- }); });
396
- (0, bun_test_1.it)("handles numeric version parameter directly", function () { return __awaiter(void 0, void 0, void 0, function () {
397
- var res;
398
- return __generator(this, function (_a) {
399
- switch (_a.label) {
400
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
401
- webRequiredVersion: 100,
402
- webWarningVersion: 150,
403
- })];
404
- case 1:
405
- _a.sent();
406
- return [4 /*yield*/, app.get("/version-check?version=50&platform=web")];
407
- case 2:
408
- res = _a.sent();
409
- (0, bun_test_1.expect)(res.status).toBe(200);
410
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
411
- (0, bun_test_1.expect)(res.body.status).toBe("required");
412
- return [2 /*return*/];
413
- }
414
- });
415
- }); });
416
- (0, bun_test_1.it)("returns default warning message when warningMessage not set", function () { return __awaiter(void 0, void 0, void 0, function () {
417
- var res;
418
- return __generator(this, function (_a) {
419
- switch (_a.label) {
420
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
421
- webRequiredVersion: 0,
422
- webWarningVersion: 100,
423
- })];
424
- case 1:
425
- _a.sent();
426
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 50 })];
427
- case 2:
428
- res = _a.sent();
429
- (0, bun_test_1.expect)(res.status).toBe(200);
430
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
431
- (0, bun_test_1.expect)(res.body.status).toBe("warning");
432
- (0, bun_test_1.expect)(res.body.message).toBe("A new version is available. Please update for the best experience.");
433
- return [2 /*return*/];
434
- }
435
- });
436
- }); });
437
- (0, bun_test_1.it)("returns default required message when requiredMessage not set", function () { return __awaiter(void 0, void 0, void 0, function () {
438
- var res;
439
- return __generator(this, function (_a) {
440
- switch (_a.label) {
441
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
442
- webRequiredVersion: 100,
443
- webWarningVersion: 150,
444
- })];
445
- case 1:
446
- _a.sent();
447
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 50 })];
448
- case 2:
449
- res = _a.sent();
450
- (0, bun_test_1.expect)(res.status).toBe(200);
451
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
452
- (0, bun_test_1.expect)(res.body.status).toBe("required");
453
- (0, bun_test_1.expect)(res.body.message).toBe("This version is no longer supported. Please update to continue.");
454
- return [2 /*return*/];
455
- }
456
- });
457
- }); });
458
- (0, bun_test_1.it)("version equal to required returns warning not required", function () { return __awaiter(void 0, void 0, void 0, function () {
459
- var res;
460
- return __generator(this, function (_a) {
461
- switch (_a.label) {
462
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
463
- webRequiredVersion: 100,
464
- webWarningVersion: 150,
465
- })];
466
- case 1:
467
- _a.sent();
468
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 100 })];
469
- case 2:
470
- res = _a.sent();
471
- (0, bun_test_1.expect)(res.status).toBe(200);
472
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
473
- (0, bun_test_1.expect)(res.body.status).toBe("warning");
474
- return [2 /*return*/];
475
- }
476
- });
477
- }); });
478
- (0, bun_test_1.it)("uses default messages when warningMessage/requiredMessage are not set", function () { return __awaiter(void 0, void 0, void 0, function () {
479
- var warningRes, requiredRes;
480
- return __generator(this, function (_a) {
481
- switch (_a.label) {
482
- case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
483
- webRequiredVersion: 100,
484
- webWarningVersion: 200,
485
- })];
486
- case 1:
487
- _a.sent();
488
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 150 })];
489
- case 2:
490
- warningRes = _a.sent();
491
- (0, bun_test_1.expect)(warningRes.body.requestId).toBe(warningRes.headers["x-request-id"]);
492
- (0, bun_test_1.expect)(warningRes.body.status).toBe("warning");
493
- (0, bun_test_1.expect)(warningRes.body.message).toBe("A new version is available. Please update for the best experience.");
494
- return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 50 })];
495
- case 3:
496
- requiredRes = _a.sent();
497
- (0, bun_test_1.expect)(requiredRes.body.requestId).toBe(requiredRes.headers["x-request-id"]);
498
- (0, bun_test_1.expect)(requiredRes.body.status).toBe("required");
499
- (0, bun_test_1.expect)(requiredRes.body.message).toBe("This version is no longer supported. Please update to continue.");
500
- return [2 /*return*/];
501
- }
502
- });
503
- }); });
504
- (0, bun_test_1.it)("handles numeric version parameter", function () { return __awaiter(void 0, void 0, void 0, function () {
505
- var res;
506
- return __generator(this, function (_a) {
507
- switch (_a.label) {
508
- case 0: return [4 /*yield*/, app.get("/version-check?version=50&platform=web")];
509
- case 1:
510
- res = _a.sent();
511
- (0, bun_test_1.expect)(res.status).toBe(200);
512
- (0, bun_test_1.expect)(res.body.requestId).toBe(res.headers["x-request-id"]);
513
- return [2 /*return*/];
514
- }
515
- });
516
- }); });
517
- });
518
- (0, bun_test_1.describe)("VersionCheckPlugin direct usage", function () {
519
- (0, bun_test_1.it)("can be instantiated and register called directly on an express app", function () { return __awaiter(void 0, void 0, void 0, function () {
520
- var express, plugin, expressApp, testApp, res;
521
- return __generator(this, function (_a) {
522
- switch (_a.label) {
523
- case 0:
524
- express = require("express");
525
- plugin = new versionCheckPlugin_1.VersionCheckPlugin();
526
- (0, bun_test_1.expect)(plugin).toBeDefined();
527
- (0, bun_test_1.expect)(plugin).toBeInstanceOf(versionCheckPlugin_1.VersionCheckPlugin);
528
- (0, bun_test_1.expect)(typeof plugin.register).toBe("function");
529
- expressApp = express();
530
- plugin.register(expressApp);
531
- testApp = (0, supertest_1.default)(expressApp);
532
- return [4 /*yield*/, testApp.get("/version-check")];
533
- case 1:
534
- res = _a.sent();
535
- (0, bun_test_1.expect)(res.status).toBe(200);
536
- (0, bun_test_1.expect)(res.body.status).toBe("ok");
537
- return [2 /*return*/];
538
- }
539
- });
540
- }); });
541
- (0, bun_test_1.it)("handles a numeric version query parameter", function () { return __awaiter(void 0, void 0, void 0, function () {
542
- var express, expressApp, plugin, testApp, res;
543
- return __generator(this, function (_a) {
544
- switch (_a.label) {
545
- case 0: return [4 /*yield*/, (0, tests_1.setupDb)()];
546
- case 1:
547
- _a.sent();
548
- return [4 /*yield*/, versionConfig_1.VersionConfig.deleteMany({})];
549
- case 2:
550
- _a.sent();
551
- express = require("express");
552
- expressApp = express();
553
- // Use a custom query parser that coerces numeric strings to numbers so we
554
- // exercise the `typeof versionParam === "number"` branch.
555
- expressApp.set("query parser", function (qs) {
556
- var e_1, _a;
557
- var params = {};
558
- try {
559
- for (var _b = __values(qs.split("&")), _c = _b.next(); !_c.done; _c = _b.next()) {
560
- var pair = _c.value;
561
- var _d = __read(pair.split("="), 2), key = _d[0], val = _d[1];
562
- if (val !== undefined && /^\d+$/.test(val)) {
563
- params[decodeURIComponent(key)] = Number(val);
564
- }
565
- else {
566
- params[decodeURIComponent(key)] = decodeURIComponent(val !== null && val !== void 0 ? val : "");
567
- }
568
- }
569
- }
570
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
571
- finally {
572
- try {
573
- if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
574
- }
575
- finally { if (e_1) throw e_1.error; }
576
- }
577
- return params;
578
- });
579
- plugin = new versionCheckPlugin_1.VersionCheckPlugin();
580
- plugin.register(expressApp);
581
- return [4 /*yield*/, versionConfig_1.VersionConfig.create({
582
- webRequiredVersion: 100,
583
- webWarningVersion: 150,
584
- })];
585
- case 3:
586
- _a.sent();
587
- testApp = (0, supertest_1.default)(expressApp);
588
- return [4 /*yield*/, testApp.get("/version-check?version=50&platform=web")];
589
- case 4:
590
- res = _a.sent();
591
- (0, bun_test_1.expect)(res.status).toBe(200);
592
- (0, bun_test_1.expect)(res.body.status).toBe("required");
593
- return [2 /*return*/];
594
- }
595
- });
596
- }); });
597
- });
@@ -1 +0,0 @@
1
- export {};