@terreno/api 0.13.2 → 0.14.0

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,51 @@ 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*/];
             }
         });

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.asyncHandler.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/api.asyncHandler.test.js

@@ -0,0 +1,236 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    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);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            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;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var bun_test_1 = require("bun:test");
+var express_1 = __importDefault(require("express"));
+var supertest_1 = __importDefault(require("supertest"));
+var api_1 = require("./api");
+var openApiValidator_1 = require("./openApiValidator");
+(0, bun_test_1.afterEach)(function () {
+    (0, openApiValidator_1.resetOpenApiValidatorConfig)();
+});
+var createApp = function () {
+    var app = (0, express_1.default)();
+    app.use(express_1.default.json());
+    return app;
+};
+var errorHandler = function (err, _req, res, _next) {
+    res.status(err.status || 500).json({ error: err.title || err.message });
+};
+(0, bun_test_1.describe)("asyncHandler with bodySchema validation", function () {
+    (0, bun_test_1.it)("validates and accepts a conforming body", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var app, res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    (0, openApiValidator_1.configureOpenApiValidator)({});
+                    app = createApp();
+                    app.post("/test", (0, api_1.asyncHandler)(function (_req, res) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            res.json({ ok: true });
+                            return [2 /*return*/];
+                        });
+                    }); }, {
+                        bodySchema: { name: { required: true, type: "string" } },
+                        validate: true,
+                    }));
+                    app.use(errorHandler);
+                    return [4 /*yield*/, (0, supertest_1.default)(app).post("/test").send({ name: "hello" }).expect(200)];
+                case 1:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.body.ok).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("rejects a body missing a required field", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var app;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    (0, openApiValidator_1.configureOpenApiValidator)({});
+                    app = createApp();
+                    app.post("/test", (0, api_1.asyncHandler)(function (_req, res) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            res.json({ ok: true });
+                            return [2 /*return*/];
+                        });
+                    }); }, {
+                        bodySchema: { name: { required: true, type: "string" } },
+                        validate: true,
+                    }));
+                    app.use(errorHandler);
+                    return [4 /*yield*/, (0, supertest_1.default)(app).post("/test").send({}).expect(400)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("skips body validation when validate is false", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var app, res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    (0, openApiValidator_1.configureOpenApiValidator)({});
+                    app = createApp();
+                    app.post("/test", (0, api_1.asyncHandler)(function (_req, res) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            res.json({ ok: true });
+                            return [2 /*return*/];
+                        });
+                    }); }, {
+                        bodySchema: { name: { required: true, type: "string" } },
+                        validate: false,
+                    }));
+                    app.use(errorHandler);
+                    return [4 /*yield*/, (0, supertest_1.default)(app).post("/test").send({}).expect(200)];
+                case 1:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.body.ok).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+(0, bun_test_1.describe)("asyncHandler with querySchema validation", function () {
+    (0, bun_test_1.it)("validates and accepts conforming query params", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var app, res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    (0, openApiValidator_1.configureOpenApiValidator)({});
+                    app = createApp();
+                    app.get("/test", (0, api_1.asyncHandler)(function (_req, res) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            res.json({ ok: true });
+                            return [2 /*return*/];
+                        });
+                    }); }, {
+                        querySchema: { page: { type: "integer" } },
+                        validate: true,
+                    }));
+                    app.use(errorHandler);
+                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/test?page=1").expect(200)];
+                case 1:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.body.ok).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("rejects invalid query params", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var app;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    (0, openApiValidator_1.configureOpenApiValidator)({});
+                    app = createApp();
+                    app.get("/test", (0, api_1.asyncHandler)(function (_req, res) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            res.json({ ok: true });
+                            return [2 /*return*/];
+                        });
+                    }); }, {
+                        querySchema: { page: { required: true, type: "integer" } },
+                        validate: true,
+                    }));
+                    app.use(errorHandler);
+                    return [4 /*yield*/, (0, supertest_1.default)(app).get("/test").expect(400)];
+                case 1:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+(0, bun_test_1.describe)("asyncHandler with both schemas", function () {
+    (0, bun_test_1.it)("runs both body and query validators sequentially", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var app, res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    (0, openApiValidator_1.configureOpenApiValidator)({});
+                    app = createApp();
+                    app.post("/test", (0, api_1.asyncHandler)(function (_req, res) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            res.json({ ok: true });
+                            return [2 /*return*/];
+                        });
+                    }); }, {
+                        bodySchema: { name: { required: true, type: "string" } },
+                        querySchema: { page: { type: "integer" } },
+                        validate: true,
+                    }));
+                    app.use(errorHandler);
+                    return [4 /*yield*/, (0, supertest_1.default)(app).post("/test?page=1").send({ name: "hi" }).expect(200)];
+                case 1:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.body.ok).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("forwards handler errors through next", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var app, res;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    (0, openApiValidator_1.configureOpenApiValidator)({});
+                    app = createApp();
+                    app.post("/test", (0, api_1.asyncHandler)(function () { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            throw new Error("handler boom");
+                        });
+                    }); }, {
+                        bodySchema: { name: { type: "string" } },
+                        validate: true,
+                    }));
+                    app.use(errorHandler);
+                    return [4 /*yield*/, (0, supertest_1.default)(app).post("/test").send({ name: "ok" }).expect(500)];
+                case 1:
+                    res = _a.sent();
+                    (0, bun_test_1.expect)(res.body.error).toBe("handler boom");
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});

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");