@terreno/api 0.25.0 → 0.27.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.
- package/.ai/guidelines/core.md +1 -0
- package/README.md +4 -3
- package/dist/__tests__/openApiCompat.test.js +8 -2
- package/dist/__tests__/versionCheckPlugin.test.js +15 -0
- package/dist/actions.openApi.test.js +1 -0
- package/dist/actions.test.js +1 -0
- package/dist/api.arrayOperations.test.js +1 -0
- package/dist/api.coverage.test.d.ts +1 -0
- package/dist/api.coverage.test.js +191 -0
- package/dist/api.errorPaths.test.d.ts +1 -0
- package/dist/api.errorPaths.test.js +278 -0
- package/dist/api.errors.test.js +1 -0
- package/dist/api.hooks.test.js +1 -0
- package/dist/api.js +160 -167
- package/dist/api.query.test.js +1 -0
- package/dist/api.test.js +1 -0
- package/dist/auth.js +1 -0
- package/dist/auth.test.js +122 -0
- package/dist/betterAuthApp.test.js +1 -2
- package/dist/betterAuthSetup.js +1 -0
- package/dist/betterAuthSetup.test.js +1 -0
- package/dist/configuration.test.js +1 -0
- package/dist/configurationApp.js +1 -0
- package/dist/configurationPlugin.test.js +80 -0
- package/dist/consentApp.test.js +1 -0
- package/dist/docLoader.js +1 -3
- package/dist/envConfigurationPlugin.js +1 -0
- package/dist/example.js +3 -2
- package/dist/expressServer.js +6 -6
- package/dist/expressServer.test.js +23 -0
- package/dist/githubAuth.js +2 -0
- package/dist/githubAuth.test.js +1 -0
- package/dist/index.d.ts +9 -2
- package/dist/index.js +28 -3
- package/dist/logger.test.js +107 -0
- package/dist/openApi.test.js +52 -0
- package/dist/openApiBuilder.js +2 -1
- package/dist/openApiBuilder.test.js +3 -2
- package/dist/openApiValidator.js +1 -0
- package/dist/openApiValidator.test.js +41 -0
- package/dist/permissions.middleware.test.js +1 -0
- package/dist/permissions.test.js +1 -0
- package/dist/plugins.js +8 -0
- package/dist/plugins.test.js +1 -0
- package/dist/populate.js +4 -2
- package/dist/populate.test.js +1 -0
- package/dist/realtime/realtime.test.js +13 -3
- package/dist/realtime/types.d.ts +1 -1
- package/dist/requestContext.test.js +28 -0
- package/dist/terrenoApp.js +1 -0
- package/dist/tests/createTestData.js +11 -6
- package/dist/tests/fixtures/compileAuthEntry.js +1 -1
- package/dist/tests/models.js +1 -0
- package/dist/vendor/wesleytodd-openapi/lib/generate-doc.js +3 -1
- package/package.json +7 -7
- package/src/__tests__/openApiCompat.test.ts +8 -2
- package/src/__tests__/versionCheckPlugin.test.ts +9 -0
- package/src/actions.openApi.test.ts +1 -0
- package/src/actions.test.ts +1 -0
- package/src/api.arrayOperations.test.ts +1 -0
- package/src/api.coverage.test.ts +121 -0
- package/src/api.errorPaths.test.ts +171 -0
- package/src/api.errors.test.ts +1 -0
- package/src/api.hooks.test.ts +1 -0
- package/src/api.query.test.ts +1 -0
- package/src/api.test.ts +1 -0
- package/src/api.ts +13 -9
- package/src/auth.test.ts +91 -2
- package/src/auth.ts +6 -0
- package/src/betterAuthApp.test.ts +3 -3
- package/src/betterAuthSetup.test.ts +1 -0
- package/src/betterAuthSetup.ts +3 -0
- package/src/configuration.test.ts +1 -0
- package/src/configurationApp.ts +2 -0
- package/src/configurationPlugin.test.ts +46 -1
- package/src/consentApp.test.ts +1 -0
- package/src/docLoader.ts +1 -2
- package/src/envConfigurationPlugin.ts +2 -0
- package/src/example.ts +3 -2
- package/src/expressServer.test.ts +13 -0
- package/src/expressServer.ts +5 -3
- package/src/githubAuth.test.ts +1 -0
- package/src/githubAuth.ts +2 -0
- package/src/index.ts +40 -2
- package/src/logger.test.ts +78 -0
- package/src/openApi.test.ts +54 -0
- package/src/openApiBuilder.test.ts +7 -6
- package/src/openApiBuilder.ts +2 -1
- package/src/openApiValidator.test.ts +64 -0
- package/src/openApiValidator.ts +1 -0
- package/src/permissions.middleware.test.ts +1 -0
- package/src/permissions.test.ts +1 -0
- package/src/plugins.test.ts +1 -0
- package/src/plugins.ts +9 -0
- package/src/populate.test.ts +1 -0
- package/src/populate.ts +4 -2
- package/src/realtime/realtime.test.ts +13 -3
- package/src/realtime/realtimeApp.ts +1 -0
- package/src/realtime/registry.ts +1 -0
- package/src/realtime/types.ts +1 -2
- package/src/requestContext.test.ts +32 -0
- package/src/terrenoApp.ts +1 -0
- package/src/tests/createTestData.ts +11 -6
- package/src/tests/fixtures/compileAuthEntry.ts +1 -1
- package/src/tests/models.ts +1 -0
- package/src/vendor/wesleytodd-openapi/lib/generate-doc.js +4 -1
- package/tsconfig.json +3 -3
- package/dist/notifiers/index.d.ts +0 -3
- package/dist/notifiers/index.js +0 -19
- package/dist/realtime/index.d.ts +0 -6
- package/dist/realtime/index.js +0 -27
- package/src/notifiers/index.ts +0 -3
- package/src/realtime/index.ts +0 -34
- /package/{types.d.ts → src/types.d.ts} +0 -0
package/.ai/guidelines/core.md
CHANGED
|
@@ -69,3 +69,4 @@ router.get("/yourRoute/:id", [
|
|
|
69
69
|
- Define statics/methods by direct assignment: `schema.methods = {bar() {}}`
|
|
70
70
|
- All model types live in `src/types/models/`
|
|
71
71
|
- In routes: `req.user` is `UserDocument | undefined`
|
|
72
|
+
- **No barrel imports** — import from concrete files (e.g. `../models/user`), not `../models` index barrels. See `docs/explanation/no-barrel-imports.md`.
|
package/README.md
CHANGED
|
@@ -35,14 +35,15 @@ import {Schema} from "mongoose";
|
|
|
35
35
|
import {DateOnly} from "@terreno/api";
|
|
36
36
|
|
|
37
37
|
// Register DateOnly type before any models are loaded
|
|
38
|
-
|
|
38
|
+
const schemaTypes = Schema.Types as typeof Schema.Types & {DateOnly: typeof DateOnly};
|
|
39
|
+
schemaTypes.DateOnly = DateOnly;
|
|
39
40
|
```
|
|
40
41
|
|
|
41
42
|
Then you can use it in your schemas:
|
|
42
43
|
|
|
43
44
|
```typescript
|
|
44
45
|
const eventSchema = new Schema({
|
|
45
|
-
eventDate: {type:
|
|
46
|
+
eventDate: {type: schemaTypes.DateOnly},
|
|
46
47
|
});
|
|
47
48
|
```
|
|
48
49
|
|
|
@@ -237,7 +238,7 @@ Sentry.init({
|
|
|
237
238
|
integrations: [
|
|
238
239
|
// Only profile integration needs to be added, the rest are defaults and are already added,
|
|
239
240
|
// including Express, mongoose, HTTP, etc.
|
|
240
|
-
nodeProfilingIntegration()
|
|
241
|
+
nodeProfilingIntegration(),
|
|
241
242
|
],
|
|
242
243
|
// Debug can be helpful for figuruing out why something isn't working.
|
|
243
244
|
// debug: true,
|
|
@@ -227,7 +227,10 @@ var runMiddleware = function (app) {
|
|
|
227
227
|
routeLayer = findLayer(stack, function (layer) { var _a; return ((_a = layer.route) === null || _a === void 0 ? void 0 : _a.path) === "/items/:itemId"; });
|
|
228
228
|
(0, bun_test_1.expect)(routeLayer).toBeDefined();
|
|
229
229
|
(0, bun_test_1.expect)(routeLayer === null || routeLayer === void 0 ? void 0 : routeLayer.regexp).toBeInstanceOf(RegExp);
|
|
230
|
-
|
|
230
|
+
if (!((routeLayer === null || routeLayer === void 0 ? void 0 : routeLayer.regexp) instanceof RegExp)) {
|
|
231
|
+
throw new Error("Expected the item route layer to have a regexp");
|
|
232
|
+
}
|
|
233
|
+
(0, bun_test_1.expect)(routeLayer.regexp.test("/items/123")).toBe(true);
|
|
231
234
|
(0, bun_test_1.expect)(routeLayer === null || routeLayer === void 0 ? void 0 : routeLayer.keys).toEqual([{ name: "itemId", optional: false }]);
|
|
232
235
|
return [4 /*yield*/, (0, supertest_1.default)(app).get("/items/123").expect(200)];
|
|
233
236
|
case 1:
|
|
@@ -290,7 +293,10 @@ var runMiddleware = function (app) {
|
|
|
290
293
|
var widgetLayer = findLayer(stack, function (layer) { var _a; return ((_a = layer.route) === null || _a === void 0 ? void 0 : _a.path) === "/widgets/:widgetId"; });
|
|
291
294
|
(0, bun_test_1.expect)(widgetLayer).toBeDefined();
|
|
292
295
|
(0, bun_test_1.expect)(widgetLayer === null || widgetLayer === void 0 ? void 0 : widgetLayer.regexp).toBeInstanceOf(RegExp);
|
|
293
|
-
|
|
296
|
+
if (!((widgetLayer === null || widgetLayer === void 0 ? void 0 : widgetLayer.regexp) instanceof RegExp)) {
|
|
297
|
+
throw new Error("Expected the widget route layer to have a regexp");
|
|
298
|
+
}
|
|
299
|
+
(0, bun_test_1.expect)(widgetLayer.regexp.test("/widgets/42")).toBe(true);
|
|
294
300
|
(0, bun_test_1.expect)(widgetLayer === null || widgetLayer === void 0 ? void 0 : widgetLayer.keys).toEqual([{ name: "widgetId", optional: false }]);
|
|
295
301
|
});
|
|
296
302
|
(0, bun_test_1.it)("escapes regex metacharacters in static path segments", function () {
|
|
@@ -67,6 +67,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
67
67
|
};
|
|
68
68
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
69
69
|
var bun_test_1 = require("bun:test");
|
|
70
|
+
var chai_1 = require("chai");
|
|
70
71
|
var supertest_1 = __importDefault(require("supertest"));
|
|
71
72
|
var versionConfig_1 = require("../models/versionConfig");
|
|
72
73
|
var terrenoApp_1 = require("../terrenoApp");
|
|
@@ -151,6 +152,20 @@ var typedUserModel = tests_1.UserModel;
|
|
|
151
152
|
}
|
|
152
153
|
});
|
|
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
|
+
}); });
|
|
154
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 () {
|
|
155
170
|
var res;
|
|
156
171
|
return __generator(this, function (_a) {
|
|
@@ -66,6 +66,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
66
66
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
67
67
|
};
|
|
68
68
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
69
|
+
// noExplicitAny: test mock typing
|
|
69
70
|
// biome-ignore-all lint/suspicious/noExplicitAny: test mock typing
|
|
70
71
|
var bun_test_1 = require("bun:test");
|
|
71
72
|
var supertest_1 = __importDefault(require("supertest"));
|
package/dist/actions.test.js
CHANGED
|
@@ -66,6 +66,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
66
66
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
67
67
|
};
|
|
68
68
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
69
|
+
// noExplicitAny: test mock typing
|
|
69
70
|
// biome-ignore-all lint/suspicious/noExplicitAny: test mock typing
|
|
70
71
|
var bun_test_1 = require("bun:test");
|
|
71
72
|
var mongoose_1 = require("mongoose");
|
|
@@ -55,6 +55,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
55
55
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
56
56
|
};
|
|
57
57
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
58
|
+
// noExplicitAny: test mock typing
|
|
58
59
|
// biome-ignore-all lint/suspicious/noExplicitAny: test mock typing
|
|
59
60
|
var bun_test_1 = require("bun:test");
|
|
60
61
|
var supertest_1 = __importDefault(require("supertest"));
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,191 @@
|
|
|
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 __read = (this && this.__read) || function (o, n) {
|
|
39
|
+
var m = typeof Symbol === "function" && o[Symbol.iterator];
|
|
40
|
+
if (!m) return o;
|
|
41
|
+
var i = m.call(o), r, ar = [], e;
|
|
42
|
+
try {
|
|
43
|
+
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
|
|
44
|
+
}
|
|
45
|
+
catch (error) { e = { error: error }; }
|
|
46
|
+
finally {
|
|
47
|
+
try {
|
|
48
|
+
if (r && !r.done && (m = i["return"])) m.call(i);
|
|
49
|
+
}
|
|
50
|
+
finally { if (e) throw e.error; }
|
|
51
|
+
}
|
|
52
|
+
return ar;
|
|
53
|
+
};
|
|
54
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
55
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
56
|
+
};
|
|
57
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
58
|
+
// noExplicitAny: test mock typing
|
|
59
|
+
// biome-ignore-all lint/suspicious/noExplicitAny: test mock typing
|
|
60
|
+
var bun_test_1 = require("bun:test");
|
|
61
|
+
var mongoose_1 = __importDefault(require("mongoose"));
|
|
62
|
+
var supertest_1 = __importDefault(require("supertest"));
|
|
63
|
+
var api_1 = require("./api");
|
|
64
|
+
var auth_1 = require("./auth");
|
|
65
|
+
var permissions_1 = require("./permissions");
|
|
66
|
+
var tests_1 = require("./tests");
|
|
67
|
+
// A model without the isDeleted plugin so deletes call doc.deleteOne(). The
|
|
68
|
+
// document delete hook throws to exercise the hard-delete error branch.
|
|
69
|
+
var explosiveSchema = new mongoose_1.default.Schema({
|
|
70
|
+
name: { description: "The name of the item", type: String },
|
|
71
|
+
});
|
|
72
|
+
explosiveSchema.pre("deleteOne", { document: true, query: false }, function () {
|
|
73
|
+
throw new Error("deleteOne exploded");
|
|
74
|
+
});
|
|
75
|
+
var ExplosiveModel = mongoose_1.default.model("ExplosiveCoverage", explosiveSchema);
|
|
76
|
+
(0, bun_test_1.describe)("modelRouter error path coverage", function () {
|
|
77
|
+
var server;
|
|
78
|
+
var app;
|
|
79
|
+
var admin;
|
|
80
|
+
var apple;
|
|
81
|
+
(0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
82
|
+
var _a;
|
|
83
|
+
return __generator(this, function (_b) {
|
|
84
|
+
switch (_b.label) {
|
|
85
|
+
case 0: return [4 /*yield*/, (0, tests_1.setupDb)()];
|
|
86
|
+
case 1:
|
|
87
|
+
_a = __read.apply(void 0, [_b.sent(), 1]), admin = _a[0];
|
|
88
|
+
return [4 /*yield*/, tests_1.FoodModel.create({
|
|
89
|
+
calories: 100,
|
|
90
|
+
categories: [
|
|
91
|
+
{ name: "Fruit", show: true },
|
|
92
|
+
{ name: "Popular", show: false },
|
|
93
|
+
],
|
|
94
|
+
created: new Date("2021-12-03T00:00:30.000Z"),
|
|
95
|
+
hidden: false,
|
|
96
|
+
name: "Apple",
|
|
97
|
+
ownerId: admin._id,
|
|
98
|
+
tags: ["healthy", "cheap"],
|
|
99
|
+
})];
|
|
100
|
+
case 2:
|
|
101
|
+
apple = _b.sent();
|
|
102
|
+
app = (0, tests_1.getBaseServer)();
|
|
103
|
+
(0, auth_1.setupAuth)(app, tests_1.UserModel);
|
|
104
|
+
(0, auth_1.addAuthRoutes)(app, tests_1.UserModel);
|
|
105
|
+
return [2 /*return*/];
|
|
106
|
+
}
|
|
107
|
+
});
|
|
108
|
+
}); });
|
|
109
|
+
(0, bun_test_1.it)("returns 400 when an array operation transformer throws a non-APIError", function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
110
|
+
var res;
|
|
111
|
+
return __generator(this, function (_a) {
|
|
112
|
+
switch (_a.label) {
|
|
113
|
+
case 0:
|
|
114
|
+
app.use("/food", (0, api_1.modelRouter)(tests_1.FoodModel, {
|
|
115
|
+
allowAnonymous: true,
|
|
116
|
+
permissions: {
|
|
117
|
+
create: [permissions_1.Permissions.IsAny],
|
|
118
|
+
delete: [permissions_1.Permissions.IsAny],
|
|
119
|
+
list: [permissions_1.Permissions.IsAny],
|
|
120
|
+
read: [permissions_1.Permissions.IsAny],
|
|
121
|
+
update: [permissions_1.Permissions.IsAny],
|
|
122
|
+
},
|
|
123
|
+
transformer: {
|
|
124
|
+
transform: function () {
|
|
125
|
+
throw new Error("array transform boom");
|
|
126
|
+
},
|
|
127
|
+
},
|
|
128
|
+
}));
|
|
129
|
+
server = (0, supertest_1.default)(app);
|
|
130
|
+
return [4 /*yield*/, server.post("/food/".concat(apple._id, "/tags")).send({ tags: "organic" }).expect(403)];
|
|
131
|
+
case 1:
|
|
132
|
+
res = _a.sent();
|
|
133
|
+
(0, bun_test_1.expect)(res.body.title).toContain("array transform boom");
|
|
134
|
+
return [2 /*return*/];
|
|
135
|
+
}
|
|
136
|
+
});
|
|
137
|
+
}); });
|
|
138
|
+
(0, bun_test_1.it)("returns 400 when saving an array operation fails validation", function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
139
|
+
var res;
|
|
140
|
+
return __generator(this, function (_a) {
|
|
141
|
+
switch (_a.label) {
|
|
142
|
+
case 0:
|
|
143
|
+
app.use("/food", (0, api_1.modelRouter)(tests_1.FoodModel, {
|
|
144
|
+
allowAnonymous: true,
|
|
145
|
+
permissions: {
|
|
146
|
+
create: [permissions_1.Permissions.IsAny],
|
|
147
|
+
delete: [permissions_1.Permissions.IsAny],
|
|
148
|
+
list: [permissions_1.Permissions.IsAny],
|
|
149
|
+
read: [permissions_1.Permissions.IsAny],
|
|
150
|
+
update: [permissions_1.Permissions.IsAny],
|
|
151
|
+
},
|
|
152
|
+
}));
|
|
153
|
+
server = (0, supertest_1.default)(app);
|
|
154
|
+
return [4 /*yield*/, server
|
|
155
|
+
.post("/food/".concat(apple._id, "/eatenBy"))
|
|
156
|
+
.send({ eatenBy: "not-an-object-id" })
|
|
157
|
+
.expect(400)];
|
|
158
|
+
case 1:
|
|
159
|
+
res = _a.sent();
|
|
160
|
+
(0, bun_test_1.expect)(res.body.title).toContain("PATCH Pre Update error");
|
|
161
|
+
return [2 /*return*/];
|
|
162
|
+
}
|
|
163
|
+
});
|
|
164
|
+
}); });
|
|
165
|
+
(0, bun_test_1.it)("returns 400 when a hard delete (no isDeleted plugin) fails", function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
166
|
+
var doc, res;
|
|
167
|
+
return __generator(this, function (_a) {
|
|
168
|
+
switch (_a.label) {
|
|
169
|
+
case 0: return [4 /*yield*/, ExplosiveModel.create({ name: "boom" })];
|
|
170
|
+
case 1:
|
|
171
|
+
doc = _a.sent();
|
|
172
|
+
app.use("/explosive", (0, api_1.modelRouter)(ExplosiveModel, {
|
|
173
|
+
allowAnonymous: true,
|
|
174
|
+
permissions: {
|
|
175
|
+
create: [permissions_1.Permissions.IsAny],
|
|
176
|
+
delete: [permissions_1.Permissions.IsAny],
|
|
177
|
+
list: [permissions_1.Permissions.IsAny],
|
|
178
|
+
read: [permissions_1.Permissions.IsAny],
|
|
179
|
+
update: [permissions_1.Permissions.IsAny],
|
|
180
|
+
},
|
|
181
|
+
}));
|
|
182
|
+
server = (0, supertest_1.default)(app);
|
|
183
|
+
return [4 /*yield*/, server.delete("/explosive/".concat(doc._id)).expect(400)];
|
|
184
|
+
case 2:
|
|
185
|
+
res = _a.sent();
|
|
186
|
+
(0, bun_test_1.expect)(res.body.title).toContain("deleteOne exploded");
|
|
187
|
+
return [2 /*return*/];
|
|
188
|
+
}
|
|
189
|
+
});
|
|
190
|
+
}); });
|
|
191
|
+
});
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,278 @@
|
|
|
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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
14
|
+
if (k2 === undefined) k2 = k;
|
|
15
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
16
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
17
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
18
|
+
}
|
|
19
|
+
Object.defineProperty(o, k2, desc);
|
|
20
|
+
}) : (function(o, m, k, k2) {
|
|
21
|
+
if (k2 === undefined) k2 = k;
|
|
22
|
+
o[k2] = m[k];
|
|
23
|
+
}));
|
|
24
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
25
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
26
|
+
}) : function(o, v) {
|
|
27
|
+
o["default"] = v;
|
|
28
|
+
});
|
|
29
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
30
|
+
var ownKeys = function(o) {
|
|
31
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
32
|
+
var ar = [];
|
|
33
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
34
|
+
return ar;
|
|
35
|
+
};
|
|
36
|
+
return ownKeys(o);
|
|
37
|
+
};
|
|
38
|
+
return function (mod) {
|
|
39
|
+
if (mod && mod.__esModule) return mod;
|
|
40
|
+
var result = {};
|
|
41
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
42
|
+
__setModuleDefault(result, mod);
|
|
43
|
+
return result;
|
|
44
|
+
};
|
|
45
|
+
})();
|
|
46
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
47
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
48
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
49
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
50
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
51
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
52
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
53
|
+
});
|
|
54
|
+
};
|
|
55
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
56
|
+
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);
|
|
57
|
+
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
58
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
59
|
+
function step(op) {
|
|
60
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
61
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
62
|
+
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;
|
|
63
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
64
|
+
switch (op[0]) {
|
|
65
|
+
case 0: case 1: t = op; break;
|
|
66
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
67
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
68
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
69
|
+
default:
|
|
70
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
71
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
72
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
73
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
74
|
+
if (t[2]) _.ops.pop();
|
|
75
|
+
_.trys.pop(); continue;
|
|
76
|
+
}
|
|
77
|
+
op = body.call(thisArg, _);
|
|
78
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
79
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
80
|
+
}
|
|
81
|
+
};
|
|
82
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
83
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
84
|
+
};
|
|
85
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
86
|
+
var bun_test_1 = require("bun:test");
|
|
87
|
+
var Sentry = __importStar(require("@sentry/bun"));
|
|
88
|
+
var chai_1 = require("chai");
|
|
89
|
+
var mongoose_1 = __importDefault(require("mongoose"));
|
|
90
|
+
var supertest_1 = __importDefault(require("supertest"));
|
|
91
|
+
var api_1 = require("./api");
|
|
92
|
+
var auth_1 = require("./auth");
|
|
93
|
+
var permissions_1 = require("./permissions");
|
|
94
|
+
var tests_1 = require("./tests");
|
|
95
|
+
var authUserModel = tests_1.UserModel;
|
|
96
|
+
var anyPermissions = {
|
|
97
|
+
create: [permissions_1.Permissions.IsAny],
|
|
98
|
+
delete: [permissions_1.Permissions.IsAny],
|
|
99
|
+
list: [permissions_1.Permissions.IsAny],
|
|
100
|
+
read: [permissions_1.Permissions.IsAny],
|
|
101
|
+
update: [permissions_1.Permissions.IsAny],
|
|
102
|
+
};
|
|
103
|
+
(0, bun_test_1.describe)("modelRouter error paths", function () {
|
|
104
|
+
var app;
|
|
105
|
+
var server;
|
|
106
|
+
(0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
107
|
+
return __generator(this, function (_a) {
|
|
108
|
+
switch (_a.label) {
|
|
109
|
+
case 0: return [4 /*yield*/, (0, tests_1.setupDb)()];
|
|
110
|
+
case 1:
|
|
111
|
+
_a.sent();
|
|
112
|
+
app = (0, tests_1.getBaseServer)();
|
|
113
|
+
(0, auth_1.setupAuth)(app, authUserModel);
|
|
114
|
+
(0, auth_1.addAuthRoutes)(app, authUserModel);
|
|
115
|
+
return [2 /*return*/];
|
|
116
|
+
}
|
|
117
|
+
});
|
|
118
|
+
}); });
|
|
119
|
+
(0, bun_test_1.afterEach)(function () {
|
|
120
|
+
var _a, _b, _c, _d, _e, _f;
|
|
121
|
+
// Restore any spies installed on the shared FoodModel / Sentry.
|
|
122
|
+
(_b = (_a = tests_1.FoodModel.find).mockRestore) === null || _b === void 0 ? void 0 : _b.call(_a);
|
|
123
|
+
(_d = (_c = tests_1.FoodModel.findById).mockRestore) === null || _d === void 0 ? void 0 : _d.call(_c);
|
|
124
|
+
(_f = (_e = Sentry.captureMessage).mockRestore) === null || _f === void 0 ? void 0 : _f.call(_e);
|
|
125
|
+
});
|
|
126
|
+
var mountFood = function (options) {
|
|
127
|
+
if (options === void 0) { options = {}; }
|
|
128
|
+
app.use("/food", (0, api_1.modelRouter)(tests_1.FoodModel, __assign({ allowAnonymous: true, permissions: anyPermissions }, options)));
|
|
129
|
+
server = (0, supertest_1.default)(app);
|
|
130
|
+
};
|
|
131
|
+
(0, bun_test_1.it)("wraps populate failures on create in a Populate error", function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
132
|
+
var rejectingQuery, res;
|
|
133
|
+
return __generator(this, function (_a) {
|
|
134
|
+
switch (_a.label) {
|
|
135
|
+
case 0:
|
|
136
|
+
mountFood({ populatePaths: [{ fields: ["email"], path: "ownerId" }] });
|
|
137
|
+
rejectingQuery = {
|
|
138
|
+
exec: function () { return Promise.reject(new Error("populate exploded")); },
|
|
139
|
+
populate: function () {
|
|
140
|
+
return this;
|
|
141
|
+
},
|
|
142
|
+
};
|
|
143
|
+
(0, bun_test_1.spyOn)(tests_1.FoodModel, "findById").mockReturnValue(rejectingQuery);
|
|
144
|
+
return [4 /*yield*/, server
|
|
145
|
+
.post("/food")
|
|
146
|
+
.send({ calories: 5, name: "Broccoli", ownerId: new mongoose_1.default.Types.ObjectId() })
|
|
147
|
+
.expect(400)];
|
|
148
|
+
case 1:
|
|
149
|
+
res = _a.sent();
|
|
150
|
+
chai_1.assert.include(res.body.title, "Populate error");
|
|
151
|
+
chai_1.assert.include(res.body.title, "populate exploded");
|
|
152
|
+
return [2 /*return*/];
|
|
153
|
+
}
|
|
154
|
+
});
|
|
155
|
+
}); });
|
|
156
|
+
(0, bun_test_1.it)("wraps list query failures in a List error", function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
157
|
+
var rejectingQuery, res;
|
|
158
|
+
return __generator(this, function (_a) {
|
|
159
|
+
switch (_a.label) {
|
|
160
|
+
case 0:
|
|
161
|
+
mountFood();
|
|
162
|
+
rejectingQuery = {
|
|
163
|
+
exec: function () { return Promise.reject(new Error("list exploded")); },
|
|
164
|
+
limit: function () {
|
|
165
|
+
return this;
|
|
166
|
+
},
|
|
167
|
+
};
|
|
168
|
+
(0, bun_test_1.spyOn)(tests_1.FoodModel, "find").mockReturnValue(rejectingQuery);
|
|
169
|
+
return [4 /*yield*/, server.get("/food").expect(500)];
|
|
170
|
+
case 1:
|
|
171
|
+
res = _a.sent();
|
|
172
|
+
chai_1.assert.include(res.body.title, "List error");
|
|
173
|
+
return [2 /*return*/];
|
|
174
|
+
}
|
|
175
|
+
});
|
|
176
|
+
}); });
|
|
177
|
+
(0, bun_test_1.it)("swallows Sentry failures when warning about truncated unpaginated lists", function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
178
|
+
var ownerId, captureSpy, res;
|
|
179
|
+
return __generator(this, function (_a) {
|
|
180
|
+
switch (_a.label) {
|
|
181
|
+
case 0:
|
|
182
|
+
mountFood({ defaultLimit: 1 });
|
|
183
|
+
ownerId = new mongoose_1.default.Types.ObjectId();
|
|
184
|
+
return [4 /*yield*/, tests_1.FoodModel.create([
|
|
185
|
+
{ calories: 1, name: "A", ownerId: ownerId },
|
|
186
|
+
{ calories: 2, name: "B", ownerId: ownerId },
|
|
187
|
+
])];
|
|
188
|
+
case 1:
|
|
189
|
+
_a.sent();
|
|
190
|
+
captureSpy = (0, bun_test_1.spyOn)(Sentry, "captureMessage").mockImplementation(function () {
|
|
191
|
+
throw new Error("sentry down");
|
|
192
|
+
});
|
|
193
|
+
return [4 /*yield*/, server.get("/food").expect(200)];
|
|
194
|
+
case 2:
|
|
195
|
+
res = _a.sent();
|
|
196
|
+
// The extra document is sliced off so only `limit` rows are returned.
|
|
197
|
+
chai_1.assert.lengthOf(res.body.data, 1);
|
|
198
|
+
chai_1.assert.isTrue(res.body.more);
|
|
199
|
+
chai_1.assert.isAbove(captureSpy.mock.calls.length, 0);
|
|
200
|
+
return [2 /*return*/];
|
|
201
|
+
}
|
|
202
|
+
});
|
|
203
|
+
}); });
|
|
204
|
+
(0, bun_test_1.it)("wraps deleteOne failures for models without soft delete", function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
205
|
+
var brittleSchema, BrittleModel, created, res;
|
|
206
|
+
return __generator(this, function (_a) {
|
|
207
|
+
switch (_a.label) {
|
|
208
|
+
case 0:
|
|
209
|
+
brittleSchema = new mongoose_1.default.Schema({ name: { description: "The name", type: String } }, { strict: "throw" });
|
|
210
|
+
brittleSchema.pre("deleteOne", { document: true, query: false }, function () {
|
|
211
|
+
throw new Error("deleteOne exploded");
|
|
212
|
+
});
|
|
213
|
+
BrittleModel = mongoose_1.default.model("BrittleDelete_".concat(Date.now()), brittleSchema);
|
|
214
|
+
app.use("/brittle", (0, api_1.modelRouter)(BrittleModel, { allowAnonymous: true, permissions: anyPermissions }));
|
|
215
|
+
server = (0, supertest_1.default)(app);
|
|
216
|
+
return [4 /*yield*/, BrittleModel.create({ name: "doomed" })];
|
|
217
|
+
case 1:
|
|
218
|
+
created = _a.sent();
|
|
219
|
+
return [4 /*yield*/, server.delete("/brittle/".concat(created._id)).expect(400)];
|
|
220
|
+
case 2:
|
|
221
|
+
res = _a.sent();
|
|
222
|
+
chai_1.assert.include(res.body.title, "deleteOne exploded");
|
|
223
|
+
return [2 /*return*/];
|
|
224
|
+
}
|
|
225
|
+
});
|
|
226
|
+
}); });
|
|
227
|
+
(0, bun_test_1.it)("wraps non-APIError transformer failures during array operations", function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
228
|
+
var food, res;
|
|
229
|
+
return __generator(this, function (_a) {
|
|
230
|
+
switch (_a.label) {
|
|
231
|
+
case 0:
|
|
232
|
+
mountFood({
|
|
233
|
+
transformer: {
|
|
234
|
+
transform: function () {
|
|
235
|
+
throw new Error("transform exploded");
|
|
236
|
+
},
|
|
237
|
+
},
|
|
238
|
+
});
|
|
239
|
+
return [4 /*yield*/, tests_1.FoodModel.create({
|
|
240
|
+
calories: 1,
|
|
241
|
+
name: "Tagged",
|
|
242
|
+
ownerId: new mongoose_1.default.Types.ObjectId(),
|
|
243
|
+
})];
|
|
244
|
+
case 1:
|
|
245
|
+
food = _a.sent();
|
|
246
|
+
return [4 /*yield*/, server.post("/food/".concat(food._id, "/tags")).send({ tags: "vegetable" }).expect(403)];
|
|
247
|
+
case 2:
|
|
248
|
+
res = _a.sent();
|
|
249
|
+
chai_1.assert.include(res.body.title, "transform exploded");
|
|
250
|
+
return [2 /*return*/];
|
|
251
|
+
}
|
|
252
|
+
});
|
|
253
|
+
}); });
|
|
254
|
+
(0, bun_test_1.it)("wraps save failures during array operations", function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
255
|
+
var food, res;
|
|
256
|
+
return __generator(this, function (_a) {
|
|
257
|
+
switch (_a.label) {
|
|
258
|
+
case 0:
|
|
259
|
+
mountFood();
|
|
260
|
+
return [4 /*yield*/, tests_1.FoodModel.create({
|
|
261
|
+
calories: 1,
|
|
262
|
+
name: "Eaten",
|
|
263
|
+
ownerId: new mongoose_1.default.Types.ObjectId(),
|
|
264
|
+
})];
|
|
265
|
+
case 1:
|
|
266
|
+
food = _a.sent();
|
|
267
|
+
return [4 /*yield*/, server
|
|
268
|
+
.post("/food/".concat(food._id, "/eatenBy"))
|
|
269
|
+
.send({ eatenBy: "not-an-object-id" })
|
|
270
|
+
.expect(400)];
|
|
271
|
+
case 2:
|
|
272
|
+
res = _a.sent();
|
|
273
|
+
chai_1.assert.include(res.body.title, "PATCH Pre Update error");
|
|
274
|
+
return [2 /*return*/];
|
|
275
|
+
}
|
|
276
|
+
});
|
|
277
|
+
}); });
|
|
278
|
+
});
|
package/dist/api.errors.test.js
CHANGED
|
@@ -39,6 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
39
39
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
40
40
|
};
|
|
41
41
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
42
|
+
// noExplicitAny: test mock typing
|
|
42
43
|
// biome-ignore-all lint/suspicious/noExplicitAny: test mock typing
|
|
43
44
|
var bun_test_1 = require("bun:test");
|
|
44
45
|
var mongoose_1 = __importDefault(require("mongoose"));
|
package/dist/api.hooks.test.js
CHANGED
|
@@ -55,6 +55,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
55
55
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
56
56
|
};
|
|
57
57
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
58
|
+
// noExplicitAny: test mock typing
|
|
58
59
|
// biome-ignore-all lint/suspicious/noExplicitAny: test mock typing
|
|
59
60
|
var bun_test_1 = require("bun:test");
|
|
60
61
|
var supertest_1 = __importDefault(require("supertest"));
|