@terreno/api 0.13.2 → 0.14.0

package/dist/terrenoApp.test.js

@@ -10,6 +10,39 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -67,11 +100,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var bun_test_1 = require("bun:test");
+var mongoose_1 = __importStar(require("mongoose"));
 var supertest_1 = __importDefault(require("supertest"));
 var api_1 = require("./api");
+var configurationPlugin_1 = require("./configurationPlugin");
 var permissions_1 = require("./permissions");
+var plugins_1 = require("./plugins");
 var terrenoApp_1 = require("./terrenoApp");
 var tests_1 = require("./tests");
+var typedUserModel = tests_1.UserModel;
 (0, bun_test_1.describe)("TerrenoApp", function () {
     var originalEnv = process.env;
     (0, bun_test_1.beforeEach)(function () {
@@ -84,7 +121,7 @@ var tests_1 = require("./tests");
         (0, bun_test_1.it)("returns an express application without listening", function () {
             var app = new terrenoApp_1.TerrenoApp({
                 skipListen: true,
-                userModel: tests_1.UserModel,
+                userModel: typedUserModel,
             }).build();
             (0, bun_test_1.expect)(app).toBeDefined();
         });
@@ -92,7 +129,7 @@ var tests_1 = require("./tests");
             var app = new terrenoApp_1.TerrenoApp({
                 corsOrigin: "https://example.com",
                 skipListen: true,
-                userModel: tests_1.UserModel,
+                userModel: typedUserModel,
             }).build();
             (0, bun_test_1.expect)(app).toBeDefined();
         });
@@ -101,7 +138,7 @@ var tests_1 = require("./tests");
         (0, bun_test_1.it)("returns an express application with skipListen", function () {
             var app = new terrenoApp_1.TerrenoApp({
                 skipListen: true,
-                userModel: tests_1.UserModel,
+                userModel: typedUserModel,
             }).start();
             (0, bun_test_1.expect)(app).toBeDefined();
         });
@@ -109,20 +146,20 @@ var tests_1 = require("./tests");
     (0, bun_test_1.describe)("register with modelRouter", function () {
         var admin;
         (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
-            var _a;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            var _d;
+            return __generator(this, function (_e) {
+                switch (_e.label) {
                     case 0: return [4 /*yield*/, (0, tests_1.setupDb)()];
                     case 1:
-                        _a = __read.apply(void 0, [_b.sent(), 1]), admin = _a[0];
+                        _d = __read.apply(void 0, [_e.sent(), 1]), admin = _d[0];
                         return [2 /*return*/];
                 }
             });
         }); });
         (0, bun_test_1.it)("mounts model router at the specified path", function () { return __awaiter(void 0, void 0, void 0, function () {
             var foodRegistration, app, agent, res;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
                         foodRegistration = (0, api_1.modelRouter)("/food", tests_1.FoodModel, {
                             allowAnonymous: true,
@@ -139,7 +176,7 @@ var tests_1 = require("./tests");
                         (0, bun_test_1.expect)(foodRegistration.path).toBe("/food");
                         app = new terrenoApp_1.TerrenoApp({
                             skipListen: true,
-                            userModel: tests_1.UserModel,
+                            userModel: typedUserModel,
                         })
                             .register(foodRegistration)
                             .build();
@@ -150,13 +187,13 @@ var tests_1 = require("./tests");
                                 source: { name: "Nature" },
                             })];
                     case 1:
-                        _a.sent();
+                        _d.sent();
                         return [4 /*yield*/, (0, tests_1.authAsUser)(app, "admin")];
                     case 2:
-                        agent = _a.sent();
+                        agent = _d.sent();
                         return [4 /*yield*/, agent.get("/food").expect(200)];
                     case 3:
-                        res = _a.sent();
+                        res = _d.sent();
                         (0, bun_test_1.expect)(res.body.data).toHaveLength(1);
                         (0, bun_test_1.expect)(res.body.data[0].name).toBe("Apple");
                         return [2 /*return*/];
@@ -165,7 +202,7 @@ var tests_1 = require("./tests");
         }); });
         (0, bun_test_1.it)("supports chaining multiple registrations", function () { return __awaiter(void 0, void 0, void 0, function () {
             var foodRegistration, app;
-            return __generator(this, function (_a) {
+            return __generator(this, function (_d) {
                 foodRegistration = (0, api_1.modelRouter)("/food", tests_1.FoodModel, {
                     allowAnonymous: true,
                     permissions: {
@@ -178,7 +215,7 @@ var tests_1 = require("./tests");
                 });
                 app = new terrenoApp_1.TerrenoApp({
                     skipListen: true,
-                    userModel: tests_1.UserModel,
+                    userModel: typedUserModel,
                 })
                     .register(foodRegistration)
                     .build();
@@ -195,12 +232,11 @@ var tests_1 = require("./tests");
             };
             var app = new terrenoApp_1.TerrenoApp({
                 skipListen: true,
-                userModel: tests_1.UserModel,
+                userModel: typedUserModel,
             })
                 .register(plugin)
                 .build();
             (0, bun_test_1.expect)(registerFn).toHaveBeenCalledTimes(1);
-            // Verify the plugin received the express app
             var calledWith = registerFn.mock.calls[0][0];
             (0, bun_test_1.expect)(calledWith).toBe(app);
         });
@@ -208,8 +244,8 @@ var tests_1 = require("./tests");
     (0, bun_test_1.describe)("addMiddleware", function () {
         (0, bun_test_1.it)("runs request handler middleware", function () { return __awaiter(void 0, void 0, void 0, function () {
             var middlewareCalled, middleware, app;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            return __generator(this, function (_d) {
+                switch (_d.label) {
                     case 0:
                         middlewareCalled = false;
                         middleware = function (_req, _res, next) {
@@ -218,19 +254,156 @@ var tests_1 = require("./tests");
                         };
                         app = new terrenoApp_1.TerrenoApp({
                             skipListen: true,
-                            userModel: tests_1.UserModel,
+                            userModel: typedUserModel,
                         })
                             .addMiddleware(middleware)
                             .build();
                         return [4 /*yield*/, (0, supertest_1.default)(app).get("/nonexistent").expect(404)];
                     case 1:
-                        _a.sent();
+                        _d.sent();
                         (0, bun_test_1.expect)(middlewareCalled).toBe(true);
                         return [2 /*return*/];
                 }
             });
         }); });
     });
+    (0, bun_test_1.describe)("configure", function () {
+        (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0: return [4 /*yield*/, (0, tests_1.setupDb)()];
+                    case 1:
+                        _d.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("mounts configuration routes when configure() is called", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var cfgSchema, modelName, CfgModel, app, agent, res;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        cfgSchema = new mongoose_1.Schema({ siteName: { default: "My Site", description: "Site name", type: String } }, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
+                        cfgSchema.plugin(configurationPlugin_1.configurationPlugin);
+                        cfgSchema.plugin(plugins_1.createdUpdatedPlugin);
+                        modelName = "CfgModel_".concat(Date.now());
+                        CfgModel = mongoose_1.default.model(modelName, cfgSchema);
+                        app = new terrenoApp_1.TerrenoApp({
+                            skipListen: true,
+                            userModel: typedUserModel,
+                        })
+                            .configure(CfgModel)
+                            .build();
+                        return [4 /*yield*/, (0, tests_1.authAsUser)(app, "admin")];
+                    case 1:
+                        agent = _d.sent();
+                        return [4 /*yield*/, agent.get("/configuration/meta")];
+                    case 2:
+                        res = _d.sent();
+                        (0, bun_test_1.expect)(res.status).toBe(200);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("supports custom basePath via configure options", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var cfgSchema2, modelName, CfgModel2, app, agent, res;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        cfgSchema2 = new mongoose_1.Schema({ siteName: { default: "Test", description: "Site name", type: String } }, { strict: "throw", toJSON: { virtuals: true }, toObject: { virtuals: true } });
+                        cfgSchema2.plugin(configurationPlugin_1.configurationPlugin);
+                        cfgSchema2.plugin(plugins_1.createdUpdatedPlugin);
+                        modelName = "CfgModel2_".concat(Date.now());
+                        CfgModel2 = mongoose_1.default.model(modelName, cfgSchema2);
+                        app = new terrenoApp_1.TerrenoApp({
+                            skipListen: true,
+                            userModel: typedUserModel,
+                        })
+                            .configure(CfgModel2, { basePath: "/settings" })
+                            .build();
+                        return [4 /*yield*/, (0, tests_1.authAsUser)(app, "admin")];
+                    case 1:
+                        agent = _d.sent();
+                        return [4 /*yield*/, agent.get("/settings/meta")];
+                    case 2:
+                        res = _d.sent();
+                        (0, bun_test_1.expect)(res.status).toBe(200);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+    (0, bun_test_1.describe)("fallthrough error handler", function () {
+        (0, bun_test_1.it)("returns 500 for non-API errors", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var plugin, app, res;
+            return __generator(this, function (_d) {
+                switch (_d.label) {
+                    case 0:
+                        plugin = {
+                            register: function (pluginApp) {
+                                pluginApp.get("/trigger-fallthrough", function (_req, _res) {
+                                    throw new Error("unexpected failure");
+                                });
+                            },
+                        };
+                        app = new terrenoApp_1.TerrenoApp({
+                            skipListen: true,
+                            userModel: typedUserModel,
+                        })
+                            .register(plugin)
+                            .build();
+                        return [4 /*yield*/, (0, supertest_1.default)(app).get("/trigger-fallthrough")];
+                    case 1:
+                        res = _d.sent();
+                        (0, bun_test_1.expect)(res.status).toBe(500);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+    (0, bun_test_1.describe)("start with listen", function () {
+        (0, bun_test_1.it)("starts and listens on the configured port", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var port, app;
+            return __generator(this, function (_d) {
+                port = "19876";
+                process.env.PORT = port;
+                app = new terrenoApp_1.TerrenoApp({
+                    userModel: typedUserModel,
+                }).start();
+                (0, bun_test_1.expect)(app).toBeDefined();
+                return [2 /*return*/];
+            });
+        }); });
+    });
+    (0, bun_test_1.describe)("addMiddleware with app-configuring function", function () {
+        (0, bun_test_1.it)("invokes a function that receives the express app (fn.length > 3)", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var receivedApp, configFn, app;
+            return __generator(this, function (_d) {
+                configFn = function (_appInstance, _a, _b, _c) {
+                    receivedApp = _appInstance;
+                };
+                app = new terrenoApp_1.TerrenoApp({
+                    skipListen: true,
+                    userModel: typedUserModel,
+                })
+                    .addMiddleware(configFn)
+                    .build();
+                (0, bun_test_1.expect)(app).toBeDefined();
+                (0, bun_test_1.expect)(receivedApp).toBe(app);
+                return [2 /*return*/];
+            });
+        }); });
+    });
+    (0, bun_test_1.describe)("logRequests option", function () {
+        (0, bun_test_1.it)("disables request logging when logRequests is false", function () {
+            var app = new terrenoApp_1.TerrenoApp({
+                logRequests: false,
+                skipListen: true,
+                userModel: typedUserModel,
+            }).build();
+            (0, bun_test_1.expect)(app).toBeDefined();
+        });
+    });
     (0, bun_test_1.describe)("modelRouter overload", function () {
         (0, bun_test_1.it)("returns ModelRouterRegistration when path is provided", function () {
             var result = (0, api_1.modelRouter)("/food", tests_1.FoodModel, {

package/dist/terrenoPlugin.d.ts

@@ -1,3 +1,4 @@
+import type http from "node:http";
 import type express from "express";
 /**
  * Interface for plugins that can be registered with TerrenoApp.
@@ -35,4 +36,14 @@ export interface TerrenoPlugin {
      * @param app - The Express application instance to register with
      */
     register(app: express.Application, openApi?: unknown): void;
+    /**
+     * Called after the HTTP server is created but before it starts listening.
+     * Use this to attach services that need the raw HTTP server, such as
+     * Socket.io or other WebSocket libraries.
+     *
+     * Only called when using `TerrenoApp.start()` (not `build()`).
+     *
+     * @param server - The Node.js HTTP server instance
+     */
+    onServerCreated?(server: http.Server): void;
 }

package/dist/tests/bunSetup.js

@@ -64,6 +64,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+// biome-ignore-all lint/suspicious/noExplicitAny: test mock typing
 var bun_test_1 = require("bun:test");
 var node_stream_1 = require("node:stream");
 var mongoose_1 = __importDefault(require("mongoose"));

package/dist/tests.js

@@ -156,7 +156,7 @@ var foodSchema = new mongoose_1.Schema({
             type: mongoose_1.Schema.Types.ObjectId,
         },
     ],
-    // noExplicitAny: DateOnly is a custom SchemaType not recognized by Mongoose's built-in type definitions
+    // biome-ignore lint/suspicious/noExplicitAny: DateOnly is a custom SchemaType not recognized by Mongoose's built-in type definitions
     expiration: { description: "Expiration date of the food", type: plugins_1.DateOnly },
     hidden: {
         default: false,

package/dist/transformers.d.ts

@@ -17,9 +17,9 @@ export declare const AdminOwnerTransformer: <T>(options: {
     adminWriteFields?: string[];
 }) => TerrenoTransformer<T>;
 export declare const transform: <T>(options: ModelRouterOptions<T>, data: Partial<T> | Partial<T>[], method: "create" | "update", user?: User) => Partial<T> | (Partial<T> | undefined)[] | undefined;
-export declare const serialize: <T>(req: express.Request, options: ModelRouterOptions<T>, data: (Document & T) | (Document & T)[]) => Partial<T> | (Partial<T> | undefined)[] | undefined;
+export declare const serialize: <T>(req: express.Request, options: ModelRouterOptions<T>, data: (Document<unknown, unknown, unknown> & T) | (Document<unknown, unknown, unknown> & T)[]) => Partial<T> | (Partial<T> | undefined)[] | undefined;
 /**
  * Default response handler for modelRouter. Calls toObject on each doc and returns the result,
  * using transformers.serializer if provided.
  */
-export declare const defaultResponseHandler: <T>(doc: (Document & T) | (Document & T)[] | null, method: "list" | "create" | "read" | "update", request: express.Request, options: ModelRouterOptions<T>) => Promise<Partial<T> | (Partial<T> | undefined)[] | null | undefined>;
+export declare const defaultResponseHandler: <T>(doc: (Document<unknown, unknown, unknown> & T) | (Document<unknown, unknown, unknown> & T)[] | null, method: "list" | "create" | "read" | "update", request: express.Request, options: ModelRouterOptions<T>) => Promise<Partial<T> | (Partial<T> | undefined)[] | null | undefined>;

package/dist/transformers.js

@@ -79,7 +79,8 @@ var getUserType = function (user, obj) {
     if (user === null || user === void 0 ? void 0 : user.admin) {
         return "admin";
     }
-    if (obj && user && String(obj === null || obj === void 0 ? void 0 : obj.ownerId) === String(user === null || user === void 0 ? void 0 : user.id)) {
+    var withOwner = obj;
+    if (withOwner && user && String(withOwner === null || withOwner === void 0 ? void 0 : withOwner.ownerId) === String(user === null || user === void 0 ? void 0 : user.id)) {
         return "owner";
     }
     if (user === null || user === void 0 ? void 0 : user.id) {
@@ -94,8 +95,9 @@ var AdminOwnerTransformer = function (options) {
         try {
             for (var fields_1 = __values(fields), fields_1_1 = fields_1.next(); !fields_1_1.done; fields_1_1 = fields_1.next()) {
                 var field = fields_1_1.value;
-                if (obj[field] !== undefined) {
-                    newData[field] = obj[field];
+                var key = field;
+                if (obj[key] !== undefined) {
+                    newData[key] = obj[key];
                 }
             }
         }

package/dist/transformers.test.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -55,10 +66,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+// biome-ignore-all lint/suspicious/noExplicitAny: test mock typing
 var bun_test_1 = require("bun:test");
 var supertest_1 = __importDefault(require("supertest"));
 var api_1 = require("./api");
 var auth_1 = require("./auth");
+var errors_1 = require("./errors");
 var permissions_1 = require("./permissions");
 var tests_1 = require("./tests");
 var transformers_1 = require("./transformers");
@@ -368,3 +381,80 @@ var transformers_1 = require("./transformers");
         });
     }); });
 });
+(0, bun_test_1.describe)("transform (deprecated helper)", function () {
+    var mockTransformFn = function (obj, _method) { return (__assign(__assign({}, obj), { name: "".concat(obj.name, "_transformed") })); };
+    (0, bun_test_1.it)("returns data unchanged when no transformer is configured", function () {
+        var options = { permissions: {} };
+        var data = { name: "Apple" };
+        (0, bun_test_1.expect)((0, transformers_1.transform)(options, data, "create")).toEqual(data);
+    });
+    (0, bun_test_1.it)("transforms a single object", function () {
+        var options = {
+            transformer: { transform: mockTransformFn },
+        };
+        var result = (0, transformers_1.transform)(options, { name: "Apple" }, "create");
+        (0, bun_test_1.expect)(result.name).toBe("Apple_transformed");
+    });
+    (0, bun_test_1.it)("transforms an array of objects", function () {
+        var options = {
+            transformer: { transform: mockTransformFn },
+        };
+        var data = [{ name: "Apple" }, { name: "Banana" }];
+        var result = (0, transformers_1.transform)(options, data, "update");
+        (0, bun_test_1.expect)(result).toHaveLength(2);
+        (0, bun_test_1.expect)(result[0].name).toBe("Apple_transformed");
+        (0, bun_test_1.expect)(result[1].name).toBe("Banana_transformed");
+    });
+});
+(0, bun_test_1.describe)("defaultResponseHandler", function () {
+    (0, bun_test_1.it)("returns null when doc is null", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var options, req, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    options = { permissions: {} };
+                    req = {};
+                    return [4 /*yield*/, (0, transformers_1.defaultResponseHandler)(null, "read", req, options)];
+                case 1:
+                    result = _a.sent();
+                    (0, bun_test_1.expect)(result).toBeNull();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("throws APIError when serialize throws", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var options, fakeDoc, req, err_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    options = {
+                        transformer: {
+                            serialize: function () {
+                                throw new Error("serialize boom");
+                            },
+                        },
+                    };
+                    fakeDoc = {
+                        _id: "abc",
+                        toObject: function () { return ({ name: "Apple" }); },
+                    };
+                    req = {};
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, (0, transformers_1.defaultResponseHandler)(fakeDoc, "read", req, options)];
+                case 2:
+                    _a.sent();
+                    (0, bun_test_1.expect)(true).toBe(false);
+                    return [3 /*break*/, 4];
+                case 3:
+                    err_1 = _a.sent();
+                    (0, bun_test_1.expect)(err_1).toBeInstanceOf(errors_1.APIError);
+                    (0, bun_test_1.expect)(err_1.status).toBe(400);
+                    (0, bun_test_1.expect)(err_1.title).toContain("Error serializing read response");
+                    return [3 /*break*/, 4];
+                case 4: return [2 /*return*/];
+            }
+        });
+    }); });
+});

package/dist/types/consentResponse.d.ts

@@ -1,8 +1,11 @@
 import type mongoose from "mongoose";
 import type { FindExactlyOnePlugin, FindOneOrNonePlugin } from "../plugins";
-export type ConsentResponseMethods = {};
-export type ConsentResponseStatics = FindExactlyOnePlugin<ConsentResponseDocument> & FindOneOrNonePlugin<ConsentResponseDocument>;
-export type ConsentResponseModel = mongoose.Model<ConsentResponseDocument, object, ConsentResponseMethods> & ConsentResponseStatics;
+export interface ConsentResponseMethods {
+}
+export interface ConsentResponseStatics extends FindExactlyOnePlugin<ConsentResponseDocument>, FindOneOrNonePlugin<ConsentResponseDocument> {
+}
+export interface ConsentResponseModel extends mongoose.Model<ConsentResponseDocument, object, ConsentResponseMethods>, ConsentResponseStatics {
+}
 export interface ConsentResponseDocument extends mongoose.Document {
     _id: mongoose.Types.ObjectId;
     userId: mongoose.Types.ObjectId;

package/dist/versionCheckPlugin.d.ts

@@ -3,6 +3,8 @@ import type { TerrenoPlugin } from "./terrenoPlugin";
 export type VersionCheckStatus = "ok" | "warning" | "required";
 export interface VersionCheckResponse {
     message?: string;
+    /** How often the client should poll for updates, in milliseconds. */
+    pollingIntervalMs?: number;
     requiredVersion?: number;
     status: VersionCheckStatus;
     updateUrl?: string;

package/dist/versionCheckPlugin.js

@@ -41,6 +41,7 @@ var api_1 = require("./api");
 var versionConfig_1 = require("./models/versionConfig");
 var DEFAULT_WARNING_MESSAGE = "A new version is available. Please update for the best experience.";
 var DEFAULT_REQUIRED_MESSAGE = "This version is no longer supported. Please update to continue.";
+var DEFAULT_POLLING_INTERVAL_MINUTES = 1440;
 /**
  * TerrenoPlugin that adds a public GET /version-check endpoint for upgrade enforcement.
  * Compares client build number against admin-configured thresholds per platform.
@@ -52,26 +53,30 @@ var VersionCheckPlugin = /** @class */ (function () {
         var _this = this;
         app.get("/version-check", (0, api_1.asyncHandler)(function (req, res) { return __awaiter(_this, void 0, void 0, function () {
             var versionParam, platform, version, platformNormalized, config, requiredVersion, warningVersion, response;
-            var _a, _b, _c, _d, _e, _f;
-            return __generator(this, function (_g) {
-                switch (_g.label) {
+            var _a, _b, _c, _d, _e, _f, _g;
+            return __generator(this, function (_h) {
+                switch (_h.label) {
                     case 0:
                         versionParam = req.query.version;
                         platform = req.query.platform;
-                        version = typeof versionParam === "string"
-                            ? parseInt(versionParam, 10)
-                            : typeof versionParam === "number"
-                                ? versionParam
-                                : undefined;
+                        if (typeof versionParam === "string") {
+                            version = parseInt(versionParam, 10);
+                        }
+                        else if (typeof versionParam === "number") {
+                            version = versionParam;
+                        }
                         if (version === undefined || Number.isNaN(version)) {
                             return [2 /*return*/, res.json({ status: "ok" })];
                         }
                         platformNormalized = platform === "web" || platform === "mobile" ? platform : "web";
                         return [4 /*yield*/, versionConfig_1.VersionConfig.findOneOrNone({ _singleton: "config" })];
                     case 1:
-                        config = _g.sent();
+                        config = _h.sent();
                         if (!config) {
-                            return [2 /*return*/, res.json({ status: "ok" })];
+                            return [2 /*return*/, res.json({
+                                    pollingIntervalMs: DEFAULT_POLLING_INTERVAL_MINUTES * 60 * 1000,
+                                    status: "ok",
+                                })];
                         }
                         requiredVersion = platformNormalized === "web"
                             ? ((_a = config.webRequiredVersion) !== null && _a !== void 0 ? _a : 0)
@@ -80,6 +85,7 @@ var VersionCheckPlugin = /** @class */ (function () {
                             ? ((_c = config.webWarningVersion) !== null && _c !== void 0 ? _c : 0)
                             : ((_d = config.mobileWarningVersion) !== null && _d !== void 0 ? _d : 0);
                         response = {
+                            pollingIntervalMs: ((_e = config.pollingIntervalMinutes) !== null && _e !== void 0 ? _e : DEFAULT_POLLING_INTERVAL_MINUTES) * 60 * 1000,
                             requiredVersion: requiredVersion > 0 ? requiredVersion : undefined,
                             status: "ok",
                             updateUrl: config.updateUrl || undefined,
@@ -87,11 +93,11 @@ var VersionCheckPlugin = /** @class */ (function () {
                         };
                         if (requiredVersion > 0 && version < requiredVersion) {
                             response.status = "required";
-                            response.message = (_e = config.requiredMessage) !== null && _e !== void 0 ? _e : DEFAULT_REQUIRED_MESSAGE;
+                            response.message = (_f = config.requiredMessage) !== null && _f !== void 0 ? _f : DEFAULT_REQUIRED_MESSAGE;
                         }
                         else if (warningVersion > 0 && version < warningVersion) {
                             response.status = "warning";
-                            response.message = (_f = config.warningMessage) !== null && _f !== void 0 ? _f : DEFAULT_WARNING_MESSAGE;
+                            response.message = (_g = config.warningMessage) !== null && _g !== void 0 ? _g : DEFAULT_WARNING_MESSAGE;
                         }
                         return [2 /*return*/, res.json(response)];
                 }

package/package.json

@@ -37,7 +37,9 @@
     "passport-local": "^1.0.0",
     "passport-local-mongoose": "^9.0.1",
     "qs": "^6.14.1",
+    "@thream/socketio-jwt": "^3.1.4",
     "scmp": "^2.1.0",
+    "socket.io": "^4.8.1",
     "winston": "^3.18.3"
   },
   "description": "Styled after the Django & Django REST Framework, a batteries-include framework for building REST APIs with Node/Express/Mongoose.",
@@ -81,7 +83,7 @@
     "access": "public"
   },
   "peerDependencies": {
-    "mongoose": "^8.0.0"
+    "mongoose": "^8.0.0 || ^9.0.0"
   },
   "repository": {
     "type": "git",
@@ -104,5 +106,5 @@
     "updateSnapshot": "bun test --update-snapshots"
   },
   "types": "dist/index.d.ts",
-  "version": "0.13.2"
+  "version": "0.14.0"
 }