@terreno/api 0.9.3 → 0.11.0

package/dist/permissions.middleware.test.js

@@ -0,0 +1,341 @@
+"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 __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) {
+        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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var bun_test_1 = require("bun:test");
+var Sentry = __importStar(require("@sentry/bun"));
+var errors_1 = require("./errors");
+var permissions_1 = require("./permissions");
+(0, bun_test_1.describe)("permissionMiddleware", function () {
+    var allPermissions = {
+        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 buildReq = function (overrides) {
+        if (overrides === void 0) { overrides = {}; }
+        return __assign({ method: "GET", params: {}, user: { id: "user-1" } }, overrides);
+    };
+    (0, bun_test_1.it)("calls next immediately for OPTIONS requests", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var model, middleware, next;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    model = {
+                        collection: { findOne: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, null];
+                            }); }); }) },
+                        findById: (0, bun_test_1.mock)(function () { return ({ exec: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, null];
+                            }); }); }) }); }),
+                        modelName: "MockModel",
+                    };
+                    middleware = (0, permissions_1.permissionMiddleware)(model, { permissions: allPermissions });
+                    next = (0, bun_test_1.mock)(function () { });
+                    return [4 /*yield*/, middleware(buildReq({ method: "OPTIONS" }), {}, next)];
+                case 1:
+                    _a.sent();
+                    (0, bun_test_1.expect)(next).toHaveBeenCalledTimes(1);
+                    (0, bun_test_1.expect)(next.mock.calls[0]).toEqual([]);
+                    (0, bun_test_1.expect)(model.findById).toHaveBeenCalledTimes(0);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns APIError for unsupported HTTP methods", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var model, middleware, next, _a, error;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    model = {
+                        collection: { findOne: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, null];
+                            }); }); }) },
+                        findById: (0, bun_test_1.mock)(function () { return ({ exec: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, null];
+                            }); }); }) }); }),
+                        modelName: "MockModel",
+                    };
+                    middleware = (0, permissions_1.permissionMiddleware)(model, { permissions: allPermissions });
+                    next = (0, bun_test_1.mock)(function () { });
+                    return [4 /*yield*/, middleware(buildReq({ method: "TRACE" }), {}, next)];
+                case 1:
+                    _b.sent();
+                    (0, bun_test_1.expect)(next).toHaveBeenCalledTimes(1);
+                    _a = __read(next.mock.calls[0], 1), error = _a[0];
+                    (0, bun_test_1.expect)(error).toBeInstanceOf(errors_1.APIError);
+                    (0, bun_test_1.expect)(error.status).toBe(405);
+                    (0, bun_test_1.expect)(error.title).toContain("Method TRACE not allowed");
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("wraps query execution failures in a 500 APIError", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var exec, model, middleware, next, _a, error;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    exec = (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            throw new Error("query failed");
+                        });
+                    }); });
+                    model = {
+                        collection: { findOne: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, null];
+                            }); }); }) },
+                        findById: (0, bun_test_1.mock)(function () { return ({ exec: exec }); }),
+                        modelName: "MockModel",
+                    };
+                    middleware = (0, permissions_1.permissionMiddleware)(model, { permissions: allPermissions });
+                    next = (0, bun_test_1.mock)(function () { });
+                    return [4 /*yield*/, middleware(buildReq({ method: "GET", params: { id: "507f1f77bcf86cd799439011" } }), {}, next)];
+                case 1:
+                    _b.sent();
+                    (0, bun_test_1.expect)(exec).toHaveBeenCalledTimes(1);
+                    _a = __read(next.mock.calls[0], 1), error = _a[0];
+                    (0, bun_test_1.expect)(error).toBeInstanceOf(errors_1.APIError);
+                    (0, bun_test_1.expect)(error.status).toBe(500);
+                    (0, bun_test_1.expect)(error.title).toContain("GET failed on 507f1f77bcf86cd799439011");
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("captures sentry message when document does not exist", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var captureMessageSpy, model, middleware, next, _a, error;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    captureMessageSpy = (0, bun_test_1.spyOn)(Sentry, "captureMessage");
+                    model = {
+                        collection: { findOne: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, null];
+                            }); }); }) },
+                        findById: (0, bun_test_1.mock)(function () { return ({ exec: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, null];
+                            }); }); }) }); }),
+                        modelName: "MockModel",
+                    };
+                    middleware = (0, permissions_1.permissionMiddleware)(model, { permissions: allPermissions });
+                    next = (0, bun_test_1.mock)(function () { });
+                    return [4 /*yield*/, middleware(buildReq({ method: "GET", params: { id: "507f1f77bcf86cd799439011" } }), {}, next)];
+                case 1:
+                    _b.sent();
+                    (0, bun_test_1.expect)(captureMessageSpy).toHaveBeenCalledWith("Document 507f1f77bcf86cd799439011 not found for model MockModel");
+                    _a = __read(next.mock.calls[0], 1), error = _a[0];
+                    (0, bun_test_1.expect)(error).toBeInstanceOf(errors_1.APIError);
+                    (0, bun_test_1.expect)(error.status).toBe(404);
+                    (0, bun_test_1.expect)(error.meta).toBeUndefined();
+                    captureMessageSpy.mockRestore();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns hidden reason metadata when document is deleted", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var model, middleware, next, _a, error;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    model = {
+                        collection: { findOne: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, ({ deleted: true })];
+                            }); }); }) },
+                        findById: (0, bun_test_1.mock)(function () { return ({ exec: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, null];
+                            }); }); }) }); }),
+                        modelName: "MockModel",
+                    };
+                    middleware = (0, permissions_1.permissionMiddleware)(model, { permissions: allPermissions });
+                    next = (0, bun_test_1.mock)(function () { });
+                    return [4 /*yield*/, middleware(buildReq({ method: "GET", params: { id: "507f1f77bcf86cd799439011" } }), {}, next)];
+                case 1:
+                    _b.sent();
+                    _a = __read(next.mock.calls[0], 1), error = _a[0];
+                    (0, bun_test_1.expect)(error).toBeInstanceOf(errors_1.APIError);
+                    (0, bun_test_1.expect)(error.status).toBe(404);
+                    (0, bun_test_1.expect)(error.meta).toEqual({ deleted: "true" });
+                    (0, bun_test_1.expect)(error.disableExternalErrorTracking).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns hidden reason metadata when document is disabled", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var model, middleware, next, _a, error;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    model = {
+                        collection: { findOne: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, ({ disabled: true })];
+                            }); }); }) },
+                        findById: (0, bun_test_1.mock)(function () { return ({ exec: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, null];
+                            }); }); }) }); }),
+                        modelName: "MockModel",
+                    };
+                    middleware = (0, permissions_1.permissionMiddleware)(model, { permissions: allPermissions });
+                    next = (0, bun_test_1.mock)(function () { });
+                    return [4 /*yield*/, middleware(buildReq({ method: "GET", params: { id: "507f1f77bcf86cd799439011" } }), {}, next)];
+                case 1:
+                    _b.sent();
+                    _a = __read(next.mock.calls[0], 1), error = _a[0];
+                    (0, bun_test_1.expect)(error).toBeInstanceOf(errors_1.APIError);
+                    (0, bun_test_1.expect)(error.status).toBe(404);
+                    (0, bun_test_1.expect)(error.meta).toEqual({ disabled: "true" });
+                    (0, bun_test_1.expect)(error.disableExternalErrorTracking).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns hidden reason metadata when document is archived", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var model, middleware, next, _a, error;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    model = {
+                        collection: { findOne: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, ({ archived: true })];
+                            }); }); }) },
+                        findById: (0, bun_test_1.mock)(function () { return ({ exec: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, null];
+                            }); }); }) }); }),
+                        modelName: "MockModel",
+                    };
+                    middleware = (0, permissions_1.permissionMiddleware)(model, { permissions: allPermissions });
+                    next = (0, bun_test_1.mock)(function () { });
+                    return [4 /*yield*/, middleware(buildReq({ method: "GET", params: { id: "507f1f77bcf86cd799439011" } }), {}, next)];
+                case 1:
+                    _b.sent();
+                    _a = __read(next.mock.calls[0], 1), error = _a[0];
+                    (0, bun_test_1.expect)(error).toBeInstanceOf(errors_1.APIError);
+                    (0, bun_test_1.expect)(error.status).toBe(404);
+                    (0, bun_test_1.expect)(error.meta).toEqual({ archived: "true" });
+                    (0, bun_test_1.expect)(error.disableExternalErrorTracking).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns plain not found when hidden document has no reason", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var model, middleware, next, _a, error;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    model = {
+                        collection: { findOne: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, ({ foo: "bar" })];
+                            }); }); }) },
+                        findById: (0, bun_test_1.mock)(function () { return ({ exec: (0, bun_test_1.mock)(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                                return [2 /*return*/, null];
+                            }); }); }) }); }),
+                        modelName: "MockModel",
+                    };
+                    middleware = (0, permissions_1.permissionMiddleware)(model, { permissions: allPermissions });
+                    next = (0, bun_test_1.mock)(function () { });
+                    return [4 /*yield*/, middleware(buildReq({ method: "GET", params: { id: "507f1f77bcf86cd799439011" } }), {}, next)];
+                case 1:
+                    _b.sent();
+                    _a = __read(next.mock.calls[0], 1), error = _a[0];
+                    (0, bun_test_1.expect)(error).toBeInstanceOf(errors_1.APIError);
+                    (0, bun_test_1.expect)(error.status).toBe(404);
+                    (0, bun_test_1.expect)(error.meta).toBeUndefined();
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});

package/dist/plugins.d.ts

@@ -4,13 +4,13 @@ export interface BaseUser {
     admin: boolean;
     email: string;
 }
-export declare function baseUserPlugin(schema: Schema<any, any, any, any>): void;
+export declare const 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 declare const isDeletedPlugin: (schema: Schema<any, any, any, any>, defaultValue?: boolean) => void;
+export declare const isDisabledPlugin: (schema: Schema<any, any, any, any>, defaultValue?: boolean) => void;
 export interface CreatedDeleted {
     updated: {
         type: Date;
@@ -21,8 +21,8 @@ export interface CreatedDeleted {
         required: true;
     };
 }
-export declare function createdUpdatedPlugin(schema: Schema<any, any, any, any>): void;
-export declare function firebaseJWTPlugin(schema: Schema): void;
+export declare const createdUpdatedPlugin: (schema: Schema<any, any, any, any>) => void;
+export declare const 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
@@ -30,7 +30,7 @@ export declare function firebaseJWTPlugin(schema: Schema): void;
  * document, or throws an exception if multiple are found.
  * @param schema Mongoose Schema
  */
-export declare function findOneOrNone<T>(schema: Schema<T>): void;
+export declare const 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.
@@ -39,14 +39,14 @@ export declare function findOneOrNone<T>(schema: Schema<T>): void;
  * multiple or none are found.
  * @param schema Mongoose Schema
  */
-export declare function findExactlyOne<T>(schema: Schema<T>): void;
+export declare const 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;
+export declare const 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>;

package/dist/plugins.js

@@ -95,23 +95,18 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DateOnly = void 0;
-exports.baseUserPlugin = baseUserPlugin;
-exports.isDeletedPlugin = isDeletedPlugin;
-exports.isDisabledPlugin = isDisabledPlugin;
-exports.createdUpdatedPlugin = createdUpdatedPlugin;
-exports.firebaseJWTPlugin = firebaseJWTPlugin;
-exports.findOneOrNone = findOneOrNone;
-exports.findExactlyOne = findExactlyOne;
-exports.upsertPlugin = upsertPlugin;
+exports.DateOnly = exports.upsertPlugin = exports.findExactlyOne = exports.findOneOrNone = exports.firebaseJWTPlugin = exports.createdUpdatedPlugin = exports.isDisabledPlugin = exports.isDeletedPlugin = exports.baseUserPlugin = void 0;
 var luxon_1 = require("luxon");
 var mongoose_1 = __importStar(require("mongoose"));
 var errors_1 = require("./errors");
-function baseUserPlugin(schema) {
-    schema.add({ admin: { default: false, type: Boolean } });
-    schema.add({ email: { index: true, type: String } });
-}
-function isDeletedPlugin(schema, defaultValue) {
+var baseUserPlugin = function (schema) {
+    schema.add({
+        admin: { default: false, description: "Whether the user has admin privileges", type: Boolean },
+    });
+    schema.add({ email: { description: "The user's email address", index: true, type: String } });
+};
+exports.baseUserPlugin = baseUserPlugin;
+var isDeletedPlugin = function (schema, defaultValue) {
     if (defaultValue === void 0) { defaultValue = false; }
     schema.add({
         deleted: {
@@ -122,20 +117,21 @@ function isDeletedPlugin(schema, defaultValue) {
             type: Boolean,
         },
     });
-    function applyDeleteFilter(q) {
+    var applyDeleteFilter = function (q) {
         var query = q.getQuery();
         if (query && query.deleted === undefined) {
             void q.where({ deleted: { $ne: true } });
         }
-    }
+    };
     schema.pre("find", function () {
         applyDeleteFilter(this);
     });
     schema.pre("findOne", function () {
         applyDeleteFilter(this);
     });
-}
-function isDisabledPlugin(schema, defaultValue) {
+};
+exports.isDeletedPlugin = isDeletedPlugin;
+var isDisabledPlugin = function (schema, defaultValue) {
     if (defaultValue === void 0) { defaultValue = false; }
     schema.add({
         disabled: {
@@ -145,10 +141,13 @@ function isDisabledPlugin(schema, defaultValue) {
             type: Boolean,
         },
     });
-}
-function createdUpdatedPlugin(schema) {
-    schema.add({ updated: { index: true, type: Date } });
-    schema.add({ created: { index: true, type: Date } });
+};
+exports.isDisabledPlugin = isDisabledPlugin;
+var createdUpdatedPlugin = function (schema) {
+    schema.add({
+        updated: { description: "When this document was last updated", index: true, type: Date },
+    });
+    schema.add({ created: { description: "When this document was created", index: true, type: Date } });
     schema.pre("save", function () {
         if (this.disableCreatedUpdatedPlugin === true) {
             return;
@@ -163,10 +162,14 @@ function createdUpdatedPlugin(schema) {
     schema.pre(/save|updateOne|insertMany/, function () {
         void this.updateOne({}, { $set: { updated: new Date() } });
     });
-}
-function firebaseJWTPlugin(schema) {
-    schema.add({ firebaseId: { index: true, type: String } });
-}
+};
+exports.createdUpdatedPlugin = createdUpdatedPlugin;
+var firebaseJWTPlugin = function (schema) {
+    schema.add({
+        firebaseId: { description: "The user's Firebase authentication ID", index: true, type: String },
+    });
+};
+exports.firebaseJWTPlugin = firebaseJWTPlugin;
 /**
  * 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
@@ -174,7 +177,7 @@ function firebaseJWTPlugin(schema) {
  * document, or throws an exception if multiple are found.
  * @param schema Mongoose Schema
  */
-function findOneOrNone(schema) {
+var findOneOrNone = function (schema) {
     schema.statics.findOneOrNone = function (query, errorArgs) {
         return __awaiter(this, void 0, void 0, function () {
             var results;
@@ -194,7 +197,8 @@ function findOneOrNone(schema) {
             });
         });
     };
-}
+};
+exports.findOneOrNone = findOneOrNone;
 /**
  * This adds a static method `Model.findExactlyOne` to the schema. This or findOneOrNone should replace `Model.findOne`
  * in most instances.
@@ -203,7 +207,7 @@ function findOneOrNone(schema) {
  * multiple or none are found.
  * @param schema Mongoose Schema
  */
-function findExactlyOne(schema) {
+var findExactlyOne = function (schema) {
     schema.statics.findExactlyOne = function (query, errorArgs) {
         return __awaiter(this, void 0, void 0, function () {
             var results;
@@ -223,14 +227,15 @@ function findExactlyOne(schema) {
             });
         });
     };
-}
+};
+exports.findExactlyOne = findExactlyOne;
 /**
  * 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
  */
-function upsertPlugin(schema) {
+var upsertPlugin = function (schema) {
     schema.statics.upsert = function (conditions, update) {
         return __awaiter(this, void 0, void 0, function () {
             var docs, doc, combinedData, newDoc;
@@ -259,7 +264,8 @@ function upsertPlugin(schema) {
             });
         });
     };
-}
+};
+exports.upsertPlugin = upsertPlugin;
 var DateOnly = /** @class */ (function (_super) {
     __extends(DateOnly, _super);
     function DateOnly(key, options) {

package/dist/populate.test.js

@@ -1,4 +1,37 @@
 "use strict";
+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) {
@@ -53,6 +86,7 @@ var __read = (this && this.__read) || function (o, n) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var bun_test_1 = require("bun:test");
+var mongoose_1 = __importStar(require("mongoose"));
 var populate_1 = require("./populate");
 var tests_1 = require("./tests");
 (0, bun_test_1.describe)("populate functions", function () {
@@ -183,3 +217,68 @@ var tests_1 = require("./tests");
         (0, bun_test_1.expect)(result.containers[1].items).toEqual(["item-3", "item-4"]);
     });
 });
+(0, bun_test_1.describe)("fixMixedFields", function () {
+    (0, bun_test_1.it)("returns early when schema is missing", function () {
+        var properties = { foo: { type: "object" } };
+        (0, bun_test_1.expect)(function () { return (0, populate_1.fixMixedFields)(null, properties); }).not.toThrow();
+    });
+    (0, bun_test_1.it)("returns early when properties is missing", function () {
+        var schema = new mongoose_1.Schema({});
+        (0, bun_test_1.expect)(function () { return (0, populate_1.fixMixedFields)(schema, null); }).not.toThrow();
+    });
+    (0, bun_test_1.it)("replaces Mixed fields with only description", function () {
+        var schema = new mongoose_1.Schema({ data: { description: "any data", type: mongoose_1.Schema.Types.Mixed } });
+        var properties = { data: { description: "any data", type: "object" } };
+        (0, populate_1.fixMixedFields)(schema, properties);
+        (0, bun_test_1.expect)(properties.data).toEqual({ description: "any data" });
+    });
+    (0, bun_test_1.it)("recurses into arrays of sub-documents", function () {
+        var subSchema = new mongoose_1.Schema({ meta: { type: mongoose_1.Schema.Types.Mixed } });
+        var schema = new mongoose_1.Schema({ items: [subSchema] });
+        var properties = {
+            items: {
+                items: {
+                    properties: {
+                        meta: { type: "object" },
+                    },
+                },
+                type: "array",
+            },
+        };
+        (0, populate_1.fixMixedFields)(schema, properties);
+        (0, bun_test_1.expect)(properties.items.items.properties.meta).toEqual({ description: undefined });
+    });
+    (0, bun_test_1.it)("skips unknown paths", function () {
+        var schema = new mongoose_1.Schema({ foo: String });
+        var properties = { unknownKey: { type: "string" } };
+        (0, bun_test_1.expect)(function () { return (0, populate_1.fixMixedFields)(schema, properties); }).not.toThrow();
+    });
+});
+(0, bun_test_1.describe)("getOpenApiSpecForModel edge cases", function () {
+    (0, bun_test_1.it)("returns model properties without populatePaths", function () {
+        var result = (0, populate_1.getOpenApiSpecForModel)(tests_1.UserModel);
+        (0, bun_test_1.expect)(result.properties).toBeDefined();
+    });
+    (0, bun_test_1.it)("returns with extraModelProperties merged", function () {
+        var result = (0, populate_1.getOpenApiSpecForModel)(tests_1.UserModel, {
+            extraModelProperties: { customField: { type: "string" } },
+        });
+        (0, bun_test_1.expect)(result.properties.customField).toEqual({ type: "string" });
+    });
+    (0, bun_test_1.it)("skips populate paths without ref", function () {
+        // Create a schema with a non-referenced ObjectId field
+        var testSchema = new mongoose_1.Schema({ name: String, simpleId: mongoose_1.Schema.Types.ObjectId });
+        var TestModelNoRef = mongoose_1.default.models.TestModelNoRef || mongoose_1.default.model("TestModelNoRef", testSchema);
+        var result = (0, populate_1.getOpenApiSpecForModel)(TestModelNoRef, {
+            populatePaths: [{ path: "simpleId" }],
+        });
+        // Should not throw, simpleId stays as-is
+        (0, bun_test_1.expect)(result.properties).toBeDefined();
+    });
+    (0, bun_test_1.it)("populates with fields allowlist", function () {
+        var result = (0, populate_1.getOpenApiSpecForModel)(tests_1.FoodModel, {
+            populatePaths: [{ fields: ["name"], path: "ownerId" }],
+        });
+        (0, bun_test_1.expect)(result.properties).toBeDefined();
+    });
+});