@terreno/api 0.0.1

package/dist/permissions.test.js

@@ -0,0 +1,413 @@
+"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 __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 });
+var bun_test_1 = require("bun:test");
+var supertest_1 = __importDefault(require("supertest"));
+var api_1 = require("./api");
+var auth_1 = require("./auth");
+var permissions_1 = require("./permissions");
+var tests_1 = require("./tests");
+(0, bun_test_1.describe)("permissions", function () {
+    var server;
+    var app;
+    (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a, admin, notAdmin;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    process.env.REFRESH_TOKEN_SECRET = "testsecret1234";
+                    return [4 /*yield*/, (0, tests_1.setupDb)()];
+                case 1:
+                    _a = __read.apply(void 0, [_b.sent(), 2]), admin = _a[0], notAdmin = _a[1];
+                    return [4 /*yield*/, Promise.all([
+                            tests_1.FoodModel.create({
+                                calories: 1,
+                                created: new Date(),
+                                name: "Spinach",
+                                ownerId: notAdmin._id,
+                            }),
+                            tests_1.FoodModel.create({
+                                calories: 100,
+                                created: Date.now() - 10,
+                                name: "Apple",
+                                ownerId: admin._id,
+                            }),
+                        ])];
+                case 2:
+                    _b.sent();
+                    app = (0, tests_1.getBaseServer)();
+                    (0, auth_1.setupAuth)(app, tests_1.UserModel);
+                    (0, auth_1.addAuthRoutes)(app, tests_1.UserModel);
+                    app.use("/food", (0, api_1.modelRouter)(tests_1.FoodModel, {
+                        allowAnonymous: true,
+                        permissions: {
+                            create: [permissions_1.Permissions.IsAuthenticated],
+                            delete: [permissions_1.Permissions.IsAdmin],
+                            list: [permissions_1.Permissions.IsAny],
+                            read: [permissions_1.Permissions.IsAny],
+                            update: [permissions_1.Permissions.IsOwner],
+                        },
+                    }));
+                    app.use("/required", (0, api_1.modelRouter)(tests_1.RequiredModel, {
+                        permissions: {
+                            create: [permissions_1.Permissions.IsAuthenticated],
+                            delete: [permissions_1.Permissions.IsAdmin],
+                            list: [permissions_1.Permissions.IsAny],
+                            read: [permissions_1.Permissions.IsAny],
+                            update: [permissions_1.Permissions.IsOwner],
+                        },
+                    }));
+                    server = (0, supertest_1.default)(app);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.describe)("anonymous food", function () {
+        (0, bun_test_1.it)("list", 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*/, server.get("/food").expect(200)];
+                    case 1:
+                        res = _a.sent();
+                        (0, bun_test_1.expect)(res.body.data).toHaveLength(2);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("get", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var res, res2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, server.get("/food").expect(200)];
+                    case 1:
+                        res = _a.sent();
+                        (0, bun_test_1.expect)(res.body.data).toHaveLength(2);
+                        return [4 /*yield*/, server.get("/food/".concat(res.body.data[0]._id)).expect(200)];
+                    case 2:
+                        res2 = _a.sent();
+                        (0, bun_test_1.expect)(res.body.data[0]._id).toBe(res2.body.data._id);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("post", 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*/, server.post("/food").send({
+                            calories: 15,
+                            name: "Broccoli",
+                        })];
+                    case 1:
+                        res = _a.sent();
+                        (0, bun_test_1.expect)(res.status).toBe(405);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("patch", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var res, res2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, server.get("/food")];
+                    case 1:
+                        res = _a.sent();
+                        return [4 /*yield*/, server.patch("/food/".concat(res.body.data[0]._id)).send({
+                                name: "Broccoli",
+                            })];
+                    case 2:
+                        res2 = _a.sent();
+                        (0, bun_test_1.expect)(res2.status).toBe(403);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("delete", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var res, res2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, server.get("/food")];
+                    case 1:
+                        res = _a.sent();
+                        return [4 /*yield*/, server.delete("/food/".concat(res.body.data[0]._id))];
+                    case 2:
+                        res2 = _a.sent();
+                        (0, bun_test_1.expect)(res2.status).toBe(405);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+    (0, bun_test_1.describe)("non admin food", function () {
+        var agent;
+        (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, tests_1.authAsUser)(app, "notAdmin")];
+                    case 1:
+                        agent = _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("list", 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*/, agent.get("/food").expect(200)];
+                    case 1:
+                        res = _a.sent();
+                        (0, bun_test_1.expect)(res.body.data).toHaveLength(2);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("get", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var res, res2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, agent.get("/food").expect(200)];
+                    case 1:
+                        res = _a.sent();
+                        (0, bun_test_1.expect)(res.body.data).toHaveLength(2);
+                        return [4 /*yield*/, server.get("/food/".concat(res.body.data[0]._id)).expect(200)];
+                    case 2:
+                        res2 = _a.sent();
+                        (0, bun_test_1.expect)(res.body.data[0]._id).toBe(res2.body.data._id);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("post", function () { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, agent
+                            .post("/food")
+                            .send({
+                            calories: 15,
+                            name: "Broccoli",
+                        })
+                            .expect(201)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("patch own item", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var res, spinach, res2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, agent.get("/food")];
+                    case 1:
+                        res = _a.sent();
+                        spinach = res.body.data.find(function (food) { return food.name === "Spinach"; });
+                        return [4 /*yield*/, agent
+                                .patch("/food/".concat(spinach._id))
+                                .send({
+                                name: "Broccoli",
+                            })
+                                .expect(200)];
+                    case 2:
+                        res2 = _a.sent();
+                        (0, bun_test_1.expect)(res2.body.data.name).toBe("Broccoli");
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("patch other item", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var res, spinach;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, agent.get("/food")];
+                    case 1:
+                        res = _a.sent();
+                        spinach = res.body.data.find(function (food) { return food.name === "Apple"; });
+                        return [4 /*yield*/, agent
+                                .patch("/food/".concat(spinach._id))
+                                .send({
+                                name: "Broccoli",
+                            })
+                                .expect(403)];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("delete", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var res, res2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, agent.get("/food")];
+                    case 1:
+                        res = _a.sent();
+                        return [4 /*yield*/, agent.delete("/food/".concat(res.body.data[0]._id))];
+                    case 2:
+                        res2 = _a.sent();
+                        (0, bun_test_1.expect)(res2.status).toBe(405);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+    (0, bun_test_1.describe)("admin food", function () {
+        var agent;
+        (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, tests_1.authAsUser)(app, "admin")];
+                    case 1:
+                        agent = _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("list", 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*/, agent.get("/food")];
+                    case 1:
+                        res = _a.sent();
+                        (0, bun_test_1.expect)(res.body.data).toHaveLength(2);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("get", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var res, res2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, agent.get("/food")];
+                    case 1:
+                        res = _a.sent();
+                        (0, bun_test_1.expect)(res.body.data).toHaveLength(2);
+                        return [4 /*yield*/, agent.get("/food/".concat(res.body.data[0]._id))];
+                    case 2:
+                        res2 = _a.sent();
+                        (0, bun_test_1.expect)(res.body.data[0]._id).toBe(res2.body.data._id);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("post", 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*/, agent.post("/food").send({
+                            calories: 15,
+                            name: "Broccoli",
+                        })];
+                    case 1:
+                        res = _a.sent();
+                        (0, bun_test_1.expect)(res.status).toBe(201);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("patch", 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*/, agent.get("/food")];
+                    case 1:
+                        res = _a.sent();
+                        return [4 /*yield*/, agent
+                                .patch("/food/".concat(res.body.data[0]._id))
+                                .send({
+                                name: "Broccoli",
+                            })
+                                .expect(200)];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("delete", 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*/, agent.get("/food")];
+                    case 1:
+                        res = _a.sent();
+                        return [4 /*yield*/, agent.delete("/food/".concat(res.body.data[0]._id)).expect(204)];
+                    case 2:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        (0, bun_test_1.it)("handles validation errors", function () { return __awaiter(void 0, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, agent
+                            .post("/required")
+                            .send({
+                            about: "Whoops forgot required",
+                        })
+                            .expect(400)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    });
+});

package/dist/plugins.d.ts

@@ -0,0 +1,67 @@
+import { type Document, type Schema, SchemaType, type SchemaTypeOptions } from "mongoose";
+import { type APIErrorConstructor } from "./errors";
+export interface BaseUser {
+    admin: boolean;
+    email: string;
+}
+export declare function baseUserPlugin(schema: Schema<any, any, any, any>): void;
+/** For models with the isDeletedPlugin, extend this interface to add the appropriate fields. */
+export interface IsDeleted {
+    deleted: boolean;
+}
+export declare function isDeletedPlugin(schema: Schema<any, any, any, any>, defaultValue?: boolean): void;
+export declare function isDisabledPlugin(schema: Schema<any, any, any, any>, defaultValue?: boolean): void;
+export interface CreatedDeleted {
+    updated: {
+        type: Date;
+        required: true;
+    };
+    created: {
+        type: Date;
+        required: true;
+    };
+}
+export declare function createdUpdatedPlugin(schema: Schema<any, any, any, any>): void;
+export declare function firebaseJWTPlugin(schema: Schema): void;
+/**
+ * This adds a static method `Model.findOneOrNone` to the schema. This should replace `Model.findOne` in most instances.
+ * `Model.findOne` should only be used with a unique index, but that's not apparent from the docs. Otherwise you can wind
+ * up with a random document that matches the query. The returns either null if no document matches, the actual
+ * document, or throws an exception if multiple are found.
+ * @param schema Mongoose Schema
+ */
+export declare function findOneOrNone<T>(schema: Schema<T>): void;
+/**
+ * This adds a static method `Model.findExactlyOne` to the schema. This or findOneOrNone should replace `Model.findOne`
+ * in most instances.
+ * `Model.findOne` should only be used with a unique index, but that's not apparent from the docs. Otherwise you can wind
+ * up with a random document that matches the query. The returns the one matching document, or throws an exception if
+ * multiple or none are found.
+ * @param schema Mongoose Schema
+ */
+export declare function findExactlyOne<T>(schema: Schema<T>): void;
+/**
+ * This adds a static method `Model.upsert` to the schema. This method will either update an existing document
+ * that matches the conditions or create a new document if none exists. It throws an error if multiple documents
+ * match the conditions to prevent ambiguous updates.
+ * @param schema Mongoose Schema
+ */
+export declare function upsertPlugin<T>(schema: Schema<any, any, any, any>): void;
+/** For models with the upsertPlugin, extend this interface to add the upsert static method. */
+export interface HasUpsert<T> {
+    upsert(conditions: Record<string, any>, update: Record<string, any>): Promise<T>;
+}
+export interface FindOneOrNonePlugin<T> {
+    findOneOrNone(query: Record<string, any>, errorArgs?: Partial<APIErrorConstructor>): Promise<(Document & T) | null>;
+}
+export interface FindExactlyOnePlugin<T> {
+    findExactlyOne(query: Record<string, any>, errorArgs?: Partial<APIErrorConstructor>): Promise<Document & T>;
+}
+export declare class DateOnly extends SchemaType {
+    constructor(key: string, options: SchemaTypeOptions<any>);
+    handleSingle(val: any): Date | undefined;
+    $conditionalHandlers: any;
+    castForQuery($conditional: any, val: any, context: any): Date | undefined;
+    cast(val: any): Date | undefined;
+    get(val: any): this;
+}