@terreno/api 0.15.0 → 0.15.2

package/dist/actions.openApi.test.js

@@ -0,0 +1,252 @@
+"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) {
+        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 __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+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 expressServer_1 = require("./expressServer");
+var permissions_1 = require("./permissions");
+var terrenoApp_1 = require("./terrenoApp");
+var tests_1 = require("./tests");
+var zodOpenApi_1 = require("./zodOpenApi");
+var foodActionPermissions = {
+    create: [permissions_1.Permissions.IsAny],
+    delete: [permissions_1.Permissions.IsAny],
+    list: [permissions_1.Permissions.IsAny],
+    read: [permissions_1.Permissions.IsAny],
+    update: [permissions_1.Permissions.IsAny],
+};
+var foodActionRouterOptions = {
+    allowAnonymous: true,
+    collectionActions: {
+        summarize: {
+            body: zodOpenApi_1.z
+                .object({
+                label: zodOpenApi_1.z.string(),
+            })
+                .strict(),
+            handler: function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+                var body = _b.body;
+                return __generator(this, function (_c) {
+                    return [2 /*return*/, ({ label: body.label, total: 1 })];
+                });
+            }); },
+            method: "POST",
+            permissions: [permissions_1.Permissions.IsAny],
+            response: zodOpenApi_1.z.object({ label: zodOpenApi_1.z.string(), total: zodOpenApi_1.z.number() }).strict(),
+            summary: "Summarize foods collection",
+            tag: "CustomFoodTag",
+        },
+    },
+    instanceActions: {
+        ping: {
+            handler: function (_a) { return __awaiter(void 0, [_a], void 0, function (_b) {
+                var doc = _b.doc;
+                return __generator(this, function (_c) {
+                    return [2 /*return*/, ({ id: String(doc._id) })];
+                });
+            }); },
+            method: "GET",
+            permissions: [permissions_1.Permissions.IsAny],
+            response: zodOpenApi_1.z.object({ id: zodOpenApi_1.z.string() }),
+            summary: "Ping a food document",
+        },
+    },
+    permissions: foodActionPermissions,
+    sort: "-created",
+};
+var primeActionOpenApiRoutes = function (server, foodId) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, server.get("/food/".concat(foodId, "/ping")).expect(200)];
+            case 1:
+                _a.sent();
+                return [4 /*yield*/, server.post("/food/summarize").send({ label: "test" }).expect(200)];
+            case 2:
+                _a.sent();
+                return [2 /*return*/];
+        }
+    });
+}); };
+var assertActionOpenApiSpec = function (spec) {
+    var _a, _b, _c, _d, _e;
+    var paths = spec.paths;
+    var collectionPath = paths["/food/summarize"];
+    var instancePath = paths["/food/{id}/ping"];
+    (0, bun_test_1.expect)(collectionPath === null || collectionPath === void 0 ? void 0 : collectionPath.post).toBeDefined();
+    (0, bun_test_1.expect)(instancePath === null || instancePath === void 0 ? void 0 : instancePath.get).toBeDefined();
+    var collectionOp = collectionPath.post;
+    var instanceOp = instancePath.get;
+    (0, bun_test_1.expect)(collectionOp.operationId).toBe("CustomFoodTag_summarize");
+    (0, bun_test_1.expect)(collectionOp.tags).toEqual(["CustomFoodTag"]);
+    (0, bun_test_1.expect)(collectionOp.summary).toBe("Summarize foods collection");
+    (0, bun_test_1.expect)(instanceOp.operationId).toBe("foods_ping");
+    (0, bun_test_1.expect)(instanceOp.tags).toEqual(["foods"]);
+    (0, bun_test_1.expect)(instanceOp.summary).toBe("Ping a food document");
+    var collectionParams = (_a = collectionOp.parameters) !== null && _a !== void 0 ? _a : [];
+    (0, bun_test_1.expect)(collectionParams.some(function (p) { return p.in === "path" && p.name === "id"; })).toBe(false);
+    var instanceParams = (_b = instanceOp.parameters) !== null && _b !== void 0 ? _b : [];
+    var idParam = instanceParams.find(function (p) { return p.in === "path" && p.name === "id"; });
+    (0, bun_test_1.expect)(idParam).toBeDefined();
+    (0, bun_test_1.expect)(idParam === null || idParam === void 0 ? void 0 : idParam.required).toBe(true);
+    var collectionRequestSchema = collectionOp.requestBody.content["application/json"].schema;
+    (0, bun_test_1.expect)((_c = collectionRequestSchema.properties) === null || _c === void 0 ? void 0 : _c.label).toBeDefined();
+    var collectionResponseSchema = collectionOp.responses["200"].content["application/json"].schema;
+    (0, bun_test_1.expect)((_d = collectionResponseSchema.properties) === null || _d === void 0 ? void 0 : _d.data).toBeDefined();
+    var instanceResponseSchema = instanceOp.responses["200"].content["application/json"].schema;
+    (0, bun_test_1.expect)((_e = instanceResponseSchema.properties) === null || _e === void 0 ? void 0 : _e.data).toBeDefined();
+};
+(0, bun_test_1.describe)("action OpenAPI emission", function () {
+    var admin;
+    var foodId;
+    (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
+        var food;
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    process.env.REFRESH_TOKEN_SECRET = "testsecret1234";
+                    process.env.ENABLE_SWAGGER = "true";
+                    return [4 /*yield*/, (0, tests_1.setupDb)()];
+                case 1:
+                    _a = __read.apply(void 0, [_b.sent(), 1]), admin = _a[0];
+                    return [4 /*yield*/, tests_1.FoodModel.create({
+                            calories: 1,
+                            hidden: false,
+                            name: "OpenApiFood",
+                            ownerId: admin._id,
+                            source: { name: "test" },
+                        })];
+                case 2:
+                    food = _b.sent();
+                    foodId = String(food._id);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.describe)("TerrenoApp", function () {
+        (0, bun_test_1.it)("includes action operations in openapi.json after first request", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var foodRegistration, app, server, specRes;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        foodRegistration = (0, api_1.modelRouter)("/food", tests_1.FoodModel, foodActionRouterOptions);
+                        app = new terrenoApp_1.TerrenoApp({
+                            skipListen: true,
+                            userModel: tests_1.UserModel,
+                        })
+                            .register(foodRegistration)
+                            .build();
+                        server = (0, supertest_1.default)(app);
+                        return [4 /*yield*/, primeActionOpenApiRoutes(server, foodId)];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, server.get("/openapi.json").expect(200)];
+                    case 2:
+                        specRes = _a.sent();
+                        assertActionOpenApiSpec(specRes.body);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+    (0, bun_test_1.describe)("setupServer", function () {
+        var app;
+        (0, bun_test_1.beforeEach)(function () {
+            var addRoutes = function (router, routerOptions) {
+                router.use("/food", (0, api_1.modelRouter)(tests_1.FoodModel, __assign(__assign({}, foodActionRouterOptions), routerOptions)));
+            };
+            app = (0, expressServer_1.setupServer)({
+                addRoutes: addRoutes,
+                skipListen: true,
+                userModel: tests_1.UserModel,
+            });
+            (0, auth_1.setupAuth)(app, tests_1.UserModel);
+            (0, auth_1.addAuthRoutes)(app, tests_1.UserModel);
+        });
+        (0, bun_test_1.it)("emits the same action operations on first hit via legacy setupServer", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var server, specRes;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        server = (0, supertest_1.default)(app);
+                        return [4 /*yield*/, primeActionOpenApiRoutes(server, foodId)];
+                    case 1:
+                        _a.sent();
+                        return [4 /*yield*/, server.get("/openapi.json").expect(200)];
+                    case 2:
+                        specRes = _a.sent();
+                        assertActionOpenApiSpec(specRes.body);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+});

package/dist/actions.test.d.ts

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