@terreno/api 0.13.3 → 0.14.1

package/dist/__tests__/versionCheckPlugin.test.js

@@ -39,6 +39,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 supertest_1 = __importDefault(require("supertest"));
 var versionConfig_1 = require("../models/versionConfig");
@@ -86,7 +87,7 @@ var versionCheckPlugin_1 = require("../versionCheckPlugin");
                 case 1:
                     res = _a.sent();
                     (0, bun_test_1.expect)(res.status).toBe(200);
-                    (0, bun_test_1.expect)(res.body).toEqual({ status: "ok" });
+                    (0, bun_test_1.expect)(res.body).toEqual({ pollingIntervalMs: 86400000, status: "ok" });
                     return [2 /*return*/];
             }
         });
@@ -131,7 +132,12 @@ var versionCheckPlugin_1 = require("../versionCheckPlugin");
                 case 2:
                     res = _a.sent();
                     (0, bun_test_1.expect)(res.status).toBe(200);
-                    (0, bun_test_1.expect)(res.body).toEqual({ requiredVersion: 50, status: "ok", warningVersion: 100 });
+                    (0, bun_test_1.expect)(res.body).toEqual({
+                        pollingIntervalMs: 86400000,
+                        requiredVersion: 50,
+                        status: "ok",
+                        warningVersion: 100,
+                    });
                     return [2 /*return*/];
             }
         });
@@ -236,7 +242,110 @@ var versionCheckPlugin_1 = require("../versionCheckPlugin");
                 case 2:
                     res = _a.sent();
                     (0, bun_test_1.expect)(res.status).toBe(200);
-                    (0, bun_test_1.expect)(res.body).toEqual({ requiredVersion: 50, status: "ok", warningVersion: 100 });
+                    (0, bun_test_1.expect)(res.body).toEqual({
+                        pollingIntervalMs: 86400000,
+                        requiredVersion: 50,
+                        status: "ok",
+                        warningVersion: 100,
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns pollingIntervalMs from config pollingIntervalMinutes", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
+                        pollingIntervalMinutes: 60,
+                        webRequiredVersion: 0,
+                        webWarningVersion: 0,
+                    })];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 100 })];
+                case 2:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.status).toBe(200);
+                    (0, bun_test_1.expect)(res.body.pollingIntervalMs).toBe(3600000);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns default pollingIntervalMs (86400000) when pollingIntervalMinutes not set", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
+                        webRequiredVersion: 0,
+                        webWarningVersion: 0,
+                    })];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 100 })];
+                case 2:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.status).toBe(200);
+                    (0, bun_test_1.expect)(res.body.pollingIntervalMs).toBe(86400000);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("handles numeric version parameter directly", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
+                        webRequiredVersion: 100,
+                        webWarningVersion: 150,
+                    })];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, app.get("/version-check?version=50&platform=web")];
+                case 2:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.status).toBe(200);
+                    (0, bun_test_1.expect)(res.body.status).toBe("required");
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns default warning message when warningMessage not set", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
+                        webRequiredVersion: 0,
+                        webWarningVersion: 100,
+                    })];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 50 })];
+                case 2:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.status).toBe(200);
+                    (0, bun_test_1.expect)(res.body.status).toBe("warning");
+                    (0, bun_test_1.expect)(res.body.message).toBe("A new version is available. Please update for the best experience.");
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns default required message when requiredMessage not set", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, versionConfig_1.VersionConfig.create({
+                        webRequiredVersion: 100,
+                        webWarningVersion: 150,
+                    })];
+                case 1:
+                    _a.sent();
+                    return [4 /*yield*/, app.get("/version-check").query({ platform: "web", version: 50 })];
+                case 2:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.status).toBe(200);
+                    (0, bun_test_1.expect)(res.body.status).toBe("required");
+                    (0, bun_test_1.expect)(res.body.message).toBe("This version is no longer supported. Please update to continue.");
                     return [2 /*return*/];
             }
         });
@@ -261,3 +370,27 @@ var versionCheckPlugin_1 = require("../versionCheckPlugin");
         });
     }); });
 });
+(0, bun_test_1.describe)("VersionCheckPlugin direct usage", function () {
+    (0, bun_test_1.it)("can be instantiated and register called directly on an express app", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var express, plugin, expressApp, testApp, res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    express = require("express");
+                    plugin = new versionCheckPlugin_1.VersionCheckPlugin();
+                    (0, bun_test_1.expect)(plugin).toBeDefined();
+                    (0, bun_test_1.expect)(plugin).toBeInstanceOf(versionCheckPlugin_1.VersionCheckPlugin);
+                    (0, bun_test_1.expect)(typeof plugin.register).toBe("function");
+                    expressApp = express();
+                    plugin.register(expressApp);
+                    testApp = (0, supertest_1.default)(expressApp);
+                    return [4 /*yield*/, testApp.get("/version-check")];
+                case 1:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.status).toBe(200);
+                    (0, bun_test_1.expect)(res.body.status).toBe("ok");
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});

package/dist/api.arrayOperations.test.js

@@ -55,6 +55,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 supertest_1 = __importDefault(require("supertest"));
 var api_1 = require("./api");

package/dist/api.d.ts

@@ -4,6 +4,7 @@ import { type User } from "./auth";
 import { type ModelRouterValidationOptions } from "./openApiValidator";
 import { type RESTPermissions } from "./permissions";
 import type { PopulatePath } from "./populate";
+import type { RealtimeConfig } from "./realtime/types";
 import { type TerrenoTransformer } from "./transformers";
 export type JSONPrimitive = string | number | boolean | null;
 export interface JSONArray extends Array<JSONValue> {
@@ -193,13 +194,13 @@ export interface ModelRouterOptions<T> {
      * Throw an APIError to return a 400 with an error message.
      * @deprecated: Use responseHandler instead.
      */
-    postList?: (value: (Document<any, any, any> & T)[], request: express.Request) => Promise<(Document<any, any, any> & T)[]>;
+    postList?: (value: (Document<unknown, unknown, unknown> & T)[], request: express.Request) => Promise<(Document<unknown, unknown, unknown> & T)[]>;
     /**
      * Serialize an object or list of objects before returning to the client.
      * This is a good spot to remove sensitive information from the object, such as passwords or API
      * keys. Throw an APIError to return a 400 with an error message.
      */
-    responseHandler?: (value: (Document<any, any, any> & T) | (Document<any, any, any> & T)[], method: "list" | "create" | "read" | "update" | "delete", request: express.Request, options: ModelRouterOptions<T>) => Promise<JSONValue>;
+    responseHandler?: (value: (Document<unknown, unknown, unknown> & T) | (Document<unknown, unknown, unknown> & T)[], method: "list" | "create" | "read" | "update" | "delete", request: express.Request, options: ModelRouterOptions<T>) => Promise<JSONValue>;
     /**
      * The OpenAPI generator for this server. This is used to generate the OpenAPI documentation.
      */
@@ -235,6 +236,14 @@ export interface ModelRouterOptions<T> {
      * This option overrides the global setting for this specific router.
      */
     validation?: boolean | ModelRouterValidationOptions;
+    /**
+     * Enable real-time sync for this model via WebSocket events.
+     * When configured, CRUD operations will emit events to connected clients
+     * through the RealtimeApp plugin's change stream watcher.
+     *
+     * Requires the RealtimeApp plugin to be registered with TerrenoApp.
+     */
+    realtime?: RealtimeConfig;
 }
 /**
  * Registration object returned by modelRouter when called with a path.
@@ -253,7 +262,7 @@ export interface ModelRouterRegistration {
     /** The Express router containing CRUD endpoints */
     router: express.Router;
     /** @internal Rebuilds the router with the openApi instance injected into options */
-    _buildWithOpenApi: (openApi: any) => express.Router;
+    _buildWithOpenApi: (openApi: OpenApiMiddleware) => express.Router;
 }
 /**
  * Create a set of CRUD routes given a Mongoose model and configuration options.
@@ -324,6 +333,8 @@ export interface AsyncHandlerOptions {
  * }));
  * ```
  */
-export declare const asyncHandler: (fn: any, options?: AsyncHandlerOptions) => (req: Request, res: Response, next: NextFunction) => void;
+type AsyncHandlerFn = (req: any, res: Response, next: NextFunction) => Promise<unknown> | unknown;
+export declare const asyncHandler: (fn: AsyncHandlerFn, options?: AsyncHandlerOptions) => (req: Request, res: Response, next: NextFunction) => void;
 export declare const gooseRestRouter: typeof modelRouter;
 export type GooseRESTOptions<T> = ModelRouterOptions<T>;
+export {};

package/dist/api.errors.test.js

@@ -39,6 +39,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 mongoose_1 = __importDefault(require("mongoose"));
 var errors_1 = require("./errors");

package/dist/api.hooks.test.js

@@ -55,6 +55,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 supertest_1 = __importDefault(require("supertest"));
 var api_1 = require("./api");