@terreno/api 0.10.0 → 0.11.0

package/dist/tests.js

@@ -88,10 +88,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RequiredModel = exports.FoodModel = exports.StaffUserModel = exports.SuperUserModel = exports.UserModel = void 0;
-exports.getBaseServer = getBaseServer;
-exports.authAsUser = authAsUser;
-exports.setupDb = setupDb;
+exports.setupDb = exports.authAsUser = exports.getBaseServer = exports.RequiredModel = exports.FoodModel = exports.StaffUserModel = exports.SuperUserModel = exports.UserModel = void 0;
 var express_1 = __importDefault(require("express"));
 var mongoose_1 = __importStar(require("mongoose"));
 var passport_local_mongoose_1 = __importDefault(require("passport-local-mongoose"));
@@ -189,7 +186,7 @@ var requiredSchema = new mongoose_1.Schema({
     name: { description: "The name of the item", required: true, type: String },
 });
 exports.RequiredModel = (0, mongoose_1.model)("Required", requiredSchema);
-function getBaseServer() {
+var getBaseServer = function () {
     var app = (0, express_1.default)();
     app.set("query parser", function (str) { return qs_1.default.parse(str, { arrayLimit: 200 }); });
     // Express 5 defaults to 'simple' query parser (Node querystring) which doesn't
@@ -211,82 +208,81 @@ function getBaseServer() {
     });
     app.use(express_1.default.json());
     return app;
-}
-function authAsUser(app, type) {
-    return __awaiter(this, void 0, void 0, function () {
-        var email, password, agent, res;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    email = type === "admin" ? "admin@example.com" : "notAdmin@example.com";
-                    password = type === "admin" ? "securePassword" : "password";
-                    agent = supertest_1.default.agent(app);
-                    return [4 /*yield*/, agent.post("/auth/login").send({ email: email, password: password }).expect(200)];
-                case 1:
-                    res = _a.sent();
-                    return [4 /*yield*/, agent.set("authorization", "Bearer ".concat(res.body.data.token))];
-                case 2:
-                    _a.sent();
-                    return [2 /*return*/, agent];
-            }
-        });
+};
+exports.getBaseServer = getBaseServer;
+var authAsUser = function (app, type) { return __awaiter(void 0, void 0, void 0, function () {
+    var email, password, agent, res;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                email = type === "admin" ? "admin@example.com" : "notAdmin@example.com";
+                password = type === "admin" ? "securePassword" : "password";
+                agent = supertest_1.default.agent(app);
+                return [4 /*yield*/, agent.post("/auth/login").send({ email: email, password: password }).expect(200)];
+            case 1:
+                res = _a.sent();
+                return [4 /*yield*/, agent.set("authorization", "Bearer ".concat(res.body.data.token))];
+            case 2:
+                _a.sent();
+                return [2 /*return*/, agent];
+        }
     });
-}
-function setupDb() {
-    return __awaiter(this, void 0, void 0, function () {
-        var _a, notAdmin, admin, adminOther, error_1;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0: return [4 /*yield*/, mongoose_1.default
-                        .connect("mongodb://127.0.0.1/terreno?&connectTimeoutMS=360000")
-                        .catch(logger_1.logger.catch)];
-                case 1:
-                    _b.sent();
-                    process.env.REFRESH_TOKEN_SECRET = "refresh_secret";
-                    process.env.TOKEN_SECRET = "secret";
-                    process.env.TOKEN_EXPIRES_IN = "30m";
-                    process.env.TOKEN_ISSUER = "example.com";
-                    process.env.SESSION_SECRET = "session";
-                    // Broken out of the try/catch below so you can test the catch logger by shutting down mongo.
-                    return [4 /*yield*/, Promise.all([exports.UserModel.deleteMany({}), exports.FoodModel.deleteMany({})]).catch(logger_1.logger.catch)];
-                case 2:
-                    // Broken out of the try/catch below so you can test the catch logger by shutting down mongo.
-                    _b.sent();
-                    _b.label = 3;
-                case 3:
-                    _b.trys.push([3, 11, , 12]);
-                    return [4 /*yield*/, Promise.all([
-                            exports.UserModel.create({ email: "notAdmin@example.com", name: "Not Admin" }),
-                            exports.UserModel.create({ admin: true, email: "admin@example.com", name: "Admin" }),
-                            exports.UserModel.create({ admin: true, email: "admin+other@example.com", name: "Admin Other" }),
-                        ])];
-                case 4:
-                    _a = __read.apply(void 0, [_b.sent(), 3]), notAdmin = _a[0], admin = _a[1], adminOther = _a[2];
-                    return [4 /*yield*/, notAdmin.setPassword("password")];
-                case 5:
-                    _b.sent();
-                    return [4 /*yield*/, notAdmin.save()];
-                case 6:
-                    _b.sent();
-                    return [4 /*yield*/, admin.setPassword("securePassword")];
-                case 7:
-                    _b.sent();
-                    return [4 /*yield*/, admin.save()];
-                case 8:
-                    _b.sent();
-                    return [4 /*yield*/, adminOther.setPassword("otherPassword")];
-                case 9:
-                    _b.sent();
-                    return [4 /*yield*/, adminOther.save()];
-                case 10:
-                    _b.sent();
-                    return [2 /*return*/, [admin, notAdmin, adminOther]];
-                case 11:
-                    error_1 = _b.sent();
-                    console.error("Error setting up DB", error_1);
-                    throw error_1;
-                case 12: return [2 /*return*/];
-            }
-        });
+}); };
+exports.authAsUser = authAsUser;
+var setupDb = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var _a, notAdmin, admin, adminOther, error_1;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0: return [4 /*yield*/, mongoose_1.default
+                    .connect("mongodb://127.0.0.1/terreno?&connectTimeoutMS=360000")
+                    .catch(logger_1.logger.catch)];
+            case 1:
+                _b.sent();
+                process.env.REFRESH_TOKEN_SECRET = "refresh_secret";
+                process.env.TOKEN_SECRET = "secret";
+                process.env.TOKEN_EXPIRES_IN = "30m";
+                process.env.TOKEN_ISSUER = "example.com";
+                process.env.SESSION_SECRET = "session";
+                // Broken out of the try/catch below so you can test the catch logger by shutting down mongo.
+                return [4 /*yield*/, Promise.all([exports.UserModel.deleteMany({}), exports.FoodModel.deleteMany({})]).catch(logger_1.logger.catch)];
+            case 2:
+                // Broken out of the try/catch below so you can test the catch logger by shutting down mongo.
+                _b.sent();
+                _b.label = 3;
+            case 3:
+                _b.trys.push([3, 11, , 12]);
+                return [4 /*yield*/, Promise.all([
+                        exports.UserModel.create({ email: "notAdmin@example.com", name: "Not Admin" }),
+                        exports.UserModel.create({ admin: true, email: "admin@example.com", name: "Admin" }),
+                        exports.UserModel.create({ admin: true, email: "admin+other@example.com", name: "Admin Other" }),
+                    ])];
+            case 4:
+                _a = __read.apply(void 0, [_b.sent(), 3]), notAdmin = _a[0], admin = _a[1], adminOther = _a[2];
+                return [4 /*yield*/, notAdmin.setPassword("password")];
+            case 5:
+                _b.sent();
+                return [4 /*yield*/, notAdmin.save()];
+            case 6:
+                _b.sent();
+                return [4 /*yield*/, admin.setPassword("securePassword")];
+            case 7:
+                _b.sent();
+                return [4 /*yield*/, admin.save()];
+            case 8:
+                _b.sent();
+                return [4 /*yield*/, adminOther.setPassword("otherPassword")];
+            case 9:
+                _b.sent();
+                return [4 /*yield*/, adminOther.save()];
+            case 10:
+                _b.sent();
+                return [2 /*return*/, [admin, notAdmin, adminOther]];
+            case 11:
+                error_1 = _b.sent();
+                logger_1.logger.error("Error setting up DB", error_1);
+                throw error_1;
+            case 12: return [2 /*return*/];
+        }
     });
-}
+}); };
+exports.setupDb = setupDb;

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-export declare function isValidObjectId(id: string): boolean;
+export declare const isValidObjectId: (id: string) => boolean;
 export declare const timeout: (ms: number) => Promise<NodeJS.Timeout>;
 /**
  * Ensure that all mongoose models are set to strict mode.
@@ -8,4 +8,4 @@ export declare const timeout: (ms: number) => Promise<NodeJS.Timeout>;
  * @param ignoredModels - Array of model names to skip validation for
  * @throws Error if any model is not set to strict mode or missing virtual settings
  */
-export declare function checkModelsStrict(ignoredModels?: string[]): void;
+export declare const checkModelsStrict: (ignoredModels?: string[]) => void;

package/dist/utils.js

@@ -80,14 +80,12 @@ var __values = (this && this.__values) || function(o) {
     throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.timeout = void 0;
-exports.isValidObjectId = isValidObjectId;
-exports.checkModelsStrict = checkModelsStrict;
+exports.checkModelsStrict = exports.timeout = exports.isValidObjectId = void 0;
 var mongoose_1 = __importStar(require("mongoose"));
 var logger_1 = require("./logger");
 // A better version of mongoose's ObjectId.isValid,
 // which falsely will say any 12 character string is valid.
-function isValidObjectId(id) {
+var isValidObjectId = function (id) {
     try {
         return new mongoose_1.Types.ObjectId(id).toString() === id;
     }
@@ -95,7 +93,8 @@ function isValidObjectId(id) {
         logger_1.logger.error("Error validating object id ".concat(id, ": ").concat(error));
         return false;
     }
-}
+};
+exports.isValidObjectId = isValidObjectId;
 var timeout = function (ms) { return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
         return [2 /*return*/, new Promise(function (resolve) { return setTimeout(resolve, ms); })];
@@ -110,7 +109,7 @@ exports.timeout = timeout;
  * @param ignoredModels - Array of model names to skip validation for
  * @throws Error if any model is not set to strict mode or missing virtual settings
  */
-function checkModelsStrict(ignoredModels) {
+var checkModelsStrict = function (ignoredModels) {
     var e_1, _a;
     var _b, _c;
     if (ignoredModels === void 0) { ignoredModels = []; }
@@ -140,4 +139,5 @@ function checkModelsStrict(ignoredModels) {
         }
         finally { if (e_1) throw e_1.error; }
     }
-}
+};
+exports.checkModelsStrict = checkModelsStrict;

package/package.json

@@ -100,8 +100,9 @@
     "lint:unsafefix": "biome check --fix --unsafe ./src",
     "test": "bun test --preload ./src/tests/bunSetup.ts --update-snapshots",
     "test:ci": "bun test --preload ./src/tests/bunSetup.ts",
+    "test:coverage": "bun run ../scripts/check-coverage.ts",
     "updateSnapshot": "bun test --update-snapshots"
   },
   "types": "dist/index.d.ts",
-  "version": "0.10.0"
+  "version": "0.11.0"
 }

package/src/__snapshots__/openApi.test.ts.snap

@@ -221,6 +221,7 @@ exports[`openApi gets the openapi.json 1`] = `
                                   "type": "number",
                                 },
                                 "created": {
+                                  "description": "When this document was created",
                                   "format": "date-time",
                                   "type": "string",
                                 },
@@ -247,6 +248,7 @@ exports[`openApi gets the openapi.json 1`] = `
                                   "type": "string",
                                 },
                                 "updated": {
+                                  "description": "When this document was last updated",
                                   "format": "date-time",
                                   "type": "string",
                                 },
@@ -325,6 +327,7 @@ exports[`openApi gets the openapi.json 1`] = `
                                 "type": "number",
                               },
                               "created": {
+                                "description": "When this document was created",
                                 "format": "date-time",
                                 "type": "string",
                               },
@@ -351,6 +354,7 @@ exports[`openApi gets the openapi.json 1`] = `
                                 "type": "string",
                               },
                               "updated": {
+                                "description": "When this document was last updated",
                                 "format": "date-time",
                                 "type": "string",
                               },
@@ -536,6 +540,7 @@ exports[`openApi gets the openapi.json 1`] = `
                           "type": "number",
                         },
                         "created": {
+                          "description": "When this document was created",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -562,6 +567,7 @@ exports[`openApi gets the openapi.json 1`] = `
                           "type": "string",
                         },
                         "updated": {
+                          "description": "When this document was last updated",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -640,6 +646,7 @@ exports[`openApi gets the openapi.json 1`] = `
                         "type": "number",
                       },
                       "created": {
+                        "description": "When this document was created",
                         "format": "date-time",
                         "type": "string",
                       },
@@ -666,6 +673,7 @@ exports[`openApi gets the openapi.json 1`] = `
                         "type": "string",
                       },
                       "updated": {
+                        "description": "When this document was last updated",
                         "format": "date-time",
                         "type": "string",
                       },
@@ -780,6 +788,7 @@ exports[`openApi gets the openapi.json 1`] = `
                             "type": "number",
                           },
                           "created": {
+                            "description": "When this document was created",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -806,6 +815,7 @@ exports[`openApi gets the openapi.json 1`] = `
                             "type": "string",
                           },
                           "updated": {
+                            "description": "When this document was last updated",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -884,6 +894,7 @@ exports[`openApi gets the openapi.json 1`] = `
                           "type": "number",
                         },
                         "created": {
+                          "description": "When this document was created",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -910,6 +921,7 @@ exports[`openApi gets the openapi.json 1`] = `
                           "type": "string",
                         },
                         "updated": {
+                          "description": "When this document was last updated",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -1154,6 +1166,7 @@ exports[`openApi gets the openapi.json 1`] = `
                             "type": "number",
                           },
                           "created": {
+                            "description": "When this document was created",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -1180,6 +1193,7 @@ exports[`openApi gets the openapi.json 1`] = `
                             "type": "string",
                           },
                           "updated": {
+                            "description": "When this document was last updated",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -1258,6 +1272,7 @@ exports[`openApi gets the openapi.json 1`] = `
                           "type": "number",
                         },
                         "created": {
+                          "description": "When this document was created",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -1284,6 +1299,7 @@ exports[`openApi gets the openapi.json 1`] = `
                           "type": "string",
                         },
                         "updated": {
+                          "description": "When this document was last updated",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -1462,6 +1478,7 @@ exports[`openApi gets the openapi.json 1`] = `
                           "type": "number",
                         },
                         "created": {
+                          "description": "When this document was created",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -1488,6 +1505,7 @@ exports[`openApi gets the openapi.json 1`] = `
                           "type": "string",
                         },
                         "updated": {
+                          "description": "When this document was last updated",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -1566,6 +1584,7 @@ exports[`openApi gets the openapi.json 1`] = `
                         "type": "number",
                       },
                       "created": {
+                        "description": "When this document was created",
                         "format": "date-time",
                         "type": "string",
                       },
@@ -1592,6 +1611,7 @@ exports[`openApi gets the openapi.json 1`] = `
                         "type": "string",
                       },
                       "updated": {
+                        "description": "When this document was last updated",
                         "format": "date-time",
                         "type": "string",
                       },
@@ -1706,6 +1726,7 @@ exports[`openApi gets the openapi.json 1`] = `
                             "type": "number",
                           },
                           "created": {
+                            "description": "When this document was created",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -1732,6 +1753,7 @@ exports[`openApi gets the openapi.json 1`] = `
                             "type": "string",
                           },
                           "updated": {
+                            "description": "When this document was last updated",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -1810,6 +1832,7 @@ exports[`openApi gets the openapi.json 1`] = `
                           "type": "number",
                         },
                         "created": {
+                          "description": "When this document was created",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -1836,6 +1859,7 @@ exports[`openApi gets the openapi.json 1`] = `
                           "type": "string",
                         },
                         "updated": {
+                          "description": "When this document was last updated",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -2157,6 +2181,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                                   "type": "number",
                                 },
                                 "created": {
+                                  "description": "When this document was created",
                                   "format": "date-time",
                                   "type": "string",
                                 },
@@ -2183,6 +2208,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                                   "type": "string",
                                 },
                                 "updated": {
+                                  "description": "When this document was last updated",
                                   "format": "date-time",
                                   "type": "string",
                                 },
@@ -2261,6 +2287,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                                 "type": "number",
                               },
                               "created": {
+                                "description": "When this document was created",
                                 "format": "date-time",
                                 "type": "string",
                               },
@@ -2287,6 +2314,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                                 "type": "string",
                               },
                               "updated": {
+                                "description": "When this document was last updated",
                                 "format": "date-time",
                                 "type": "string",
                               },
@@ -2472,6 +2500,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                           "type": "number",
                         },
                         "created": {
+                          "description": "When this document was created",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -2498,6 +2527,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                           "type": "string",
                         },
                         "updated": {
+                          "description": "When this document was last updated",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -2576,6 +2606,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                         "type": "number",
                       },
                       "created": {
+                        "description": "When this document was created",
                         "format": "date-time",
                         "type": "string",
                       },
@@ -2602,6 +2633,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                         "type": "string",
                       },
                       "updated": {
+                        "description": "When this document was last updated",
                         "format": "date-time",
                         "type": "string",
                       },
@@ -2716,6 +2748,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                             "type": "number",
                           },
                           "created": {
+                            "description": "When this document was created",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -2742,6 +2775,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                             "type": "string",
                           },
                           "updated": {
+                            "description": "When this document was last updated",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -2820,6 +2854,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                           "type": "number",
                         },
                         "created": {
+                          "description": "When this document was created",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -2846,6 +2881,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                           "type": "string",
                         },
                         "updated": {
+                          "description": "When this document was last updated",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -3090,6 +3126,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                             "type": "number",
                           },
                           "created": {
+                            "description": "When this document was created",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -3116,6 +3153,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                             "type": "string",
                           },
                           "updated": {
+                            "description": "When this document was last updated",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -3194,6 +3232,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                           "type": "number",
                         },
                         "created": {
+                          "description": "When this document was created",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -3220,6 +3259,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                           "type": "string",
                         },
                         "updated": {
+                          "description": "When this document was last updated",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -3398,6 +3438,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                           "type": "number",
                         },
                         "created": {
+                          "description": "When this document was created",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -3424,6 +3465,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                           "type": "string",
                         },
                         "updated": {
+                          "description": "When this document was last updated",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -3502,6 +3544,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                         "type": "number",
                       },
                       "created": {
+                        "description": "When this document was created",
                         "format": "date-time",
                         "type": "string",
                       },
@@ -3528,6 +3571,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                         "type": "string",
                       },
                       "updated": {
+                        "description": "When this document was last updated",
                         "format": "date-time",
                         "type": "string",
                       },
@@ -3642,6 +3686,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                             "type": "number",
                           },
                           "created": {
+                            "description": "When this document was created",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -3668,6 +3713,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                             "type": "string",
                           },
                           "updated": {
+                            "description": "When this document was last updated",
                             "format": "date-time",
                             "type": "string",
                           },
@@ -3746,6 +3792,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                           "type": "number",
                         },
                         "created": {
+                          "description": "When this document was created",
                           "format": "date-time",
                           "type": "string",
                         },
@@ -3772,6 +3819,7 @@ exports[`openApi gets the openapi.json with custom endpoint 1`] = `
                           "type": "string",
                         },
                         "updated": {
+                          "description": "When this document was last updated",
                           "format": "date-time",
                           "type": "string",
                         },