@terreno/api 0.0.11 → 0.0.13

package/dist/api.d.ts

@@ -181,16 +181,6 @@ export interface ModelRouterOptions<T> {
      * 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>;
-    /**
-     * The discriminatorKey that you passed when creating the Mongoose models. Defaults to __t. See:
-     * https://mongoosejs.com/docs/discriminators.html If this key is provided,
-     * you must provide the same key as part of the top level of the body when making performing
-     * update or delete operations on this model.
-     *    \{discriminatorKey: "__t"\}
-     *
-     *     PATCH \{__t: "SuperUser", name: "Foo"\} // __t is required or there will be a 404 error.
-     */
-    discriminatorKey?: string;
     /**
      * The OpenAPI generator for this server. This is used to generate the OpenAPI documentation.
      */
@@ -214,14 +204,13 @@ export interface ModelRouterOptions<T> {
      */
     openApiExtraModelProperties?: any;
 }
-export declare function getModel(baseModel: Model<any>, body?: any, options?: ModelRouterOptions<any>): mongoose.Model<any, {}, {}, {}, any, any, any>;
 /**
- * Create a set of CRUD routes given a Mongoose model $baseModel and configuration options.
+ * Create a set of CRUD routes given a Mongoose model and configuration options.
  *
- * @param baseModel A Mongoose Model
+ * @param model A Mongoose Model
  * @param options Options for configuring the REST API, such as permissions, transformers, and hooks.
  */
-export declare function modelRouter<T>(baseModel: Model<T>, options: ModelRouterOptions<T>): express.Router;
+export declare function modelRouter<T>(model: Model<T>, options: ModelRouterOptions<T>): express.Router;
 export declare const asyncHandler: (fn: any) => (req: Request, res: Response, next: NextFunction) => Promise<any>;
 export declare const gooseRestRouter: typeof modelRouter;
 export type GooseRESTOptions<T> = ModelRouterOptions<T>;

package/dist/api.errors.test.d.ts

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

package/dist/api.errors.test.js

@@ -0,0 +1,175 @@
+"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 mongoose_1 = __importDefault(require("mongoose"));
+var errors_1 = require("./errors");
+(0, bun_test_1.describe)("errors module", function () {
+    (0, bun_test_1.describe)("APIError", function () {
+        (0, bun_test_1.it)("sets default status to 500 when not provided", function () {
+            var error = new errors_1.APIError({ title: "Test error" });
+            (0, bun_test_1.expect)(error.status).toBe(500);
+        });
+        (0, bun_test_1.it)("sets status to 500 for invalid status codes below 400", function () {
+            var error = new errors_1.APIError({ status: 200, title: "Test error" });
+            (0, bun_test_1.expect)(error.status).toBe(500);
+        });
+        (0, bun_test_1.it)("sets status to 500 for invalid status codes above 599", function () {
+            var error = new errors_1.APIError({ status: 600, title: "Test error" });
+            (0, bun_test_1.expect)(error.status).toBe(500);
+        });
+        (0, bun_test_1.it)("includes error stack in message when error is provided", function () {
+            var originalError = new Error("Original error");
+            var apiError = new errors_1.APIError({
+                error: originalError,
+                title: "Wrapped error",
+            });
+            (0, bun_test_1.expect)(apiError.message).toContain("Wrapped error");
+            (0, bun_test_1.expect)(originalError.stack).toBeDefined();
+            (0, bun_test_1.expect)(apiError.message).toContain(originalError.stack);
+        });
+        (0, bun_test_1.it)("includes detail in message when provided", function () {
+            var error = new errors_1.APIError({
+                detail: "More details here",
+                title: "Test error",
+            });
+            (0, bun_test_1.expect)(error.message).toContain("Test error");
+            (0, bun_test_1.expect)(error.message).toContain("More details here");
+        });
+        (0, bun_test_1.it)("sets fields in meta when provided", function () {
+            var _a;
+            var error = new errors_1.APIError({
+                fields: { email: "Invalid email format" },
+                title: "Validation error",
+            });
+            (0, bun_test_1.expect)((_a = error.meta) === null || _a === void 0 ? void 0 : _a.fields).toEqual({ email: "Invalid email format" });
+        });
+    });
+    (0, bun_test_1.describe)("errorsPlugin", function () {
+        (0, bun_test_1.it)("adds apiErrors field to schema", function () { return __awaiter(void 0, void 0, void 0, function () {
+            var testSchema;
+            return __generator(this, function (_a) {
+                testSchema = new mongoose_1.default.Schema({ name: String });
+                (0, errors_1.errorsPlugin)(testSchema);
+                (0, bun_test_1.expect)(testSchema.path("apiErrors")).toBeDefined();
+                return [2 /*return*/];
+            });
+        }); });
+    });
+    (0, bun_test_1.describe)("isAPIError", function () {
+        (0, bun_test_1.it)("returns true for APIError instances", function () {
+            var error = new errors_1.APIError({ title: "Test" });
+            (0, bun_test_1.expect)((0, errors_1.isAPIError)(error)).toBe(true);
+        });
+        (0, bun_test_1.it)("returns false for regular Error instances", function () {
+            var error = new Error("Test");
+            (0, bun_test_1.expect)((0, errors_1.isAPIError)(error)).toBe(false);
+        });
+    });
+    (0, bun_test_1.describe)("getDisableExternalErrorTracking", function () {
+        (0, bun_test_1.it)("returns undefined for non-objects", function () {
+            (0, bun_test_1.expect)((0, errors_1.getDisableExternalErrorTracking)(null)).toBeUndefined();
+            (0, bun_test_1.expect)((0, errors_1.getDisableExternalErrorTracking)("string")).toBeUndefined();
+        });
+        (0, bun_test_1.it)("returns value from APIError", function () {
+            var error = new errors_1.APIError({ disableExternalErrorTracking: true, title: "Test" });
+            (0, bun_test_1.expect)((0, errors_1.getDisableExternalErrorTracking)(error)).toBe(true);
+        });
+        (0, bun_test_1.it)("returns value from plain object with property", function () {
+            var obj = { disableExternalErrorTracking: true };
+            (0, bun_test_1.expect)((0, errors_1.getDisableExternalErrorTracking)(obj)).toBe(true);
+        });
+    });
+    (0, bun_test_1.describe)("getAPIErrorBody", function () {
+        (0, bun_test_1.it)("includes all non-undefined fields", function () {
+            var error = new errors_1.APIError({
+                code: "TEST_CODE",
+                detail: "Test detail",
+                id: "error-123",
+                links: { about: "http://example.com" },
+                meta: { extra: "data" },
+                source: { parameter: "id" },
+                status: 400,
+                title: "Test error",
+            });
+            var body = (0, errors_1.getAPIErrorBody)(error);
+            (0, bun_test_1.expect)(body.title).toBe("Test error");
+            (0, bun_test_1.expect)(body.status).toBe(400);
+            (0, bun_test_1.expect)(body.code).toBe("TEST_CODE");
+            (0, bun_test_1.expect)(body.detail).toBe("Test detail");
+            (0, bun_test_1.expect)(body.id).toBe("error-123");
+            (0, bun_test_1.expect)(body.links).toEqual({ about: "http://example.com" });
+            (0, bun_test_1.expect)(body.source).toEqual({ parameter: "id" });
+            (0, bun_test_1.expect)(body.meta).toEqual({ extra: "data" });
+        });
+    });
+    (0, bun_test_1.describe)("apiUnauthorizedMiddleware", function () {
+        (0, bun_test_1.it)("returns 401 for Unauthorized errors", function () {
+            var err = new Error("Unauthorized");
+            var res = {
+                json: function (data) {
+                    this.body = data;
+                    return this;
+                },
+                send: function () {
+                    return this;
+                },
+                status: function (code) {
+                    this.statusCode = code;
+                    return this;
+                },
+            };
+            var next = function () { };
+            (0, errors_1.apiUnauthorizedMiddleware)(err, {}, res, next);
+            (0, bun_test_1.expect)(res.statusCode).toBe(401);
+            (0, bun_test_1.expect)(res.body.title).toBe("Unauthorized");
+        });
+        (0, bun_test_1.it)("calls next for non-Unauthorized errors", function () {
+            var err = new Error("Some other error");
+            var nextCalled = false;
+            var next = function () {
+                nextCalled = true;
+            };
+            (0, errors_1.apiUnauthorizedMiddleware)(err, {}, {}, next);
+            (0, bun_test_1.expect)(nextCalled).toBe(true);
+        });
+    });
+});

package/dist/api.hooks.test.d.ts

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