@terreno/api 0.0.1

package/dist/notifiers/zoomNotifier.test.js

@@ -0,0 +1,370 @@
+"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;
+};
+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 Sentry = __importStar(require("@sentry/node"));
+var axios_1 = __importDefault(require("axios"));
+var zoomNotifier_1 = require("./zoomNotifier");
+(0, bun_test_1.describe)("sendToZoom", function () {
+    var mockAxiosPost;
+    var ORIGINAL_ENV = process.env;
+    (0, bun_test_1.beforeEach)(function () {
+        mockAxiosPost = (0, bun_test_1.spyOn)(axios_1.default, "post").mockResolvedValue({ status: 200 });
+        process.env = __assign({}, ORIGINAL_ENV);
+        process.env.ZOOM_CHAT_WEBHOOKS = undefined;
+        Sentry.captureException.mockClear();
+        Sentry.captureMessage.mockClear();
+    });
+    (0, bun_test_1.afterEach)(function () {
+        mockAxiosPost.mockRestore();
+    });
+    (0, bun_test_1.afterAll)(function () {
+        process.env = ORIGINAL_ENV;
+    });
+    (0, bun_test_1.it)("returns early when ZOOM_CHAT_WEBHOOKS is missing", function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, zoomNotifier_1.sendToZoom)({ body: "world", header: "hello" }, { channel: "default" })];
+                case 1:
+                    _a.sent();
+                    (0, bun_test_1.expect)(mockAxiosPost.mock.calls.length).toBe(0);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("posts to default webhook with rich message format and authorization header", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var callArgs, _a, url, payload, options;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    process.env.ZOOM_CHAT_WEBHOOKS = JSON.stringify({
+                        default: {
+                            channel: "https://zoom.example/webhook",
+                            verificationToken: "test-token-123",
+                        },
+                    });
+                    mockAxiosPost.mockResolvedValue({ status: 200 });
+                    return [4 /*yield*/, (0, zoomNotifier_1.sendToZoom)({ body: "world", header: "hello" }, { channel: "default" })];
+                case 1:
+                    _b.sent();
+                    (0, bun_test_1.expect)(mockAxiosPost.mock.calls.length).toBe(1);
+                    callArgs = mockAxiosPost.mock.calls[0];
+                    (0, bun_test_1.expect)(Array.isArray(callArgs)).toBe(true);
+                    _a = __read(callArgs, 3), url = _a[0], payload = _a[1], options = _a[2];
+                    (0, bun_test_1.expect)(url).toBe("https://zoom.example/webhook?format=full");
+                    (0, bun_test_1.expect)(payload).toEqual({
+                        content: {
+                            body: [{ text: "world", type: "message" }],
+                            head: { text: "hello" },
+                        },
+                    });
+                    (0, bun_test_1.expect)(options === null || options === void 0 ? void 0 : options.headers).toEqual({
+                        Authorization: "test-token-123",
+                        "Content-Type": "application/json",
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("posts to a specific channel when provided", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var callArgs, _a, url, payload, options;
+        var _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    process.env.ZOOM_CHAT_WEBHOOKS = JSON.stringify({
+                        default: {
+                            channel: "https://zoom.example/default",
+                            verificationToken: "default-token",
+                        },
+                        ops: {
+                            channel: "https://zoom.example/ops",
+                            verificationToken: "ops-token",
+                        },
+                    });
+                    mockAxiosPost.mockResolvedValue({ status: 200 });
+                    return [4 /*yield*/, (0, zoomNotifier_1.sendToZoom)({ body: "ops msg", header: "ops msg" }, { channel: "ops" })];
+                case 1:
+                    _c.sent();
+                    callArgs = mockAxiosPost.mock.calls[0];
+                    (0, bun_test_1.expect)(Array.isArray(callArgs)).toBe(true);
+                    _a = __read(callArgs, 3), url = _a[0], payload = _a[1], options = _a[2];
+                    (0, bun_test_1.expect)(url).toBe("https://zoom.example/ops?format=full");
+                    (0, bun_test_1.expect)(payload).toEqual({
+                        content: {
+                            body: [{ text: "ops msg", type: "message" }],
+                            head: { text: "ops msg" },
+                        },
+                    });
+                    (0, bun_test_1.expect)((_b = options === null || options === void 0 ? void 0 : options.headers) === null || _b === void 0 ? void 0 : _b.Authorization).toBe("ops-token");
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("falls back to default when channel not found", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var callArgs, _a, url, payload;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    process.env.ZOOM_CHAT_WEBHOOKS = JSON.stringify({
+                        default: {
+                            channel: "https://zoom.example/default",
+                            verificationToken: "default-token",
+                        },
+                    });
+                    mockAxiosPost.mockResolvedValue({ status: 200 });
+                    return [4 /*yield*/, (0, zoomNotifier_1.sendToZoom)({ body: "missing channel", header: "missing channel" }, { channel: "unknown" })];
+                case 1:
+                    _b.sent();
+                    callArgs = mockAxiosPost.mock.calls[0];
+                    (0, bun_test_1.expect)(Array.isArray(callArgs)).toBe(true);
+                    _a = __read(callArgs, 2), url = _a[0], payload = _a[1];
+                    (0, bun_test_1.expect)(url).toBe("https://zoom.example/default?format=full");
+                    (0, bun_test_1.expect)(payload).toEqual({
+                        content: {
+                            body: [{ text: "missing channel", type: "message" }],
+                            head: { text: "missing channel" },
+                        },
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns early when webhook url is missing for channel", function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    process.env.ZOOM_CHAT_WEBHOOKS = JSON.stringify({
+                        default: {
+                            verificationToken: "default-token",
+                        },
+                    });
+                    return [4 /*yield*/, (0, zoomNotifier_1.sendToZoom)({ body: "no url", header: "no url" }, { channel: "default" })];
+                case 1:
+                    _a.sent();
+                    (0, bun_test_1.expect)(mockAxiosPost.mock.calls.length).toBe(0);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("returns early when verification token is missing for channel", function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    process.env.ZOOM_CHAT_WEBHOOKS = JSON.stringify({
+                        default: {
+                            channel: "https://zoom.example/default",
+                        },
+                    });
+                    return [4 /*yield*/, (0, zoomNotifier_1.sendToZoom)({ body: "no token", header: "no token" }, { channel: "default" })];
+                case 1:
+                    _a.sent();
+                    (0, bun_test_1.expect)(mockAxiosPost.mock.calls.length).toBe(0);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("prefixes header with [ENV] when env provided", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var callArgs, _a, payload;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    process.env.ZOOM_CHAT_WEBHOOKS = JSON.stringify({
+                        default: {
+                            channel: "https://zoom.example/default",
+                            verificationToken: "token",
+                        },
+                    });
+                    mockAxiosPost.mockResolvedValue({ status: 200 });
+                    return [4 /*yield*/, (0, zoomNotifier_1.sendToZoom)({ body: "status ok", header: "status ok" }, { channel: "default", env: "stg" })];
+                case 1:
+                    _b.sent();
+                    callArgs = mockAxiosPost.mock.calls[0];
+                    (0, bun_test_1.expect)(Array.isArray(callArgs)).toBe(true);
+                    _a = __read(callArgs, 2), payload = _a[1];
+                    (0, bun_test_1.expect)(payload).toEqual({
+                        content: {
+                            body: [{ text: "status ok", type: "message" }],
+                            head: { text: "[STG] status ok" },
+                        },
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("includes subheader when provided", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var callArgs, _a, payload;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    process.env.ZOOM_CHAT_WEBHOOKS = JSON.stringify({
+                        default: {
+                            channel: "https://zoom.example/default",
+                            verificationToken: "token",
+                        },
+                    });
+                    mockAxiosPost.mockResolvedValue({ status: 200 });
+                    return [4 /*yield*/, (0, zoomNotifier_1.sendToZoom)({ body: "Body text", header: "Main Header", subheader: "Subheader text" }, { channel: "default" })];
+                case 1:
+                    _b.sent();
+                    callArgs = mockAxiosPost.mock.calls[0];
+                    (0, bun_test_1.expect)(Array.isArray(callArgs)).toBe(true);
+                    _a = __read(callArgs, 2), payload = _a[1];
+                    (0, bun_test_1.expect)(payload).toEqual({
+                        content: {
+                            body: [{ text: "Body text", type: "message" }],
+                            head: { sub_head: { text: "Subheader text" }, text: "Main Header" },
+                        },
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("captures error and throws APIError when shouldThrow=true", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var error_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    process.env.ZOOM_CHAT_WEBHOOKS = JSON.stringify({
+                        default: {
+                            channel: "https://zoom.example/default",
+                            verificationToken: "token",
+                        },
+                    });
+                    mockAxiosPost.mockRejectedValue(new Error("zoom down"));
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, (0, zoomNotifier_1.sendToZoom)({ body: "err", header: "err" }, { channel: "default", shouldThrow: true })];
+                case 2:
+                    _a.sent();
+                    throw new Error("Expected sendToZoom to throw APIError");
+                case 3:
+                    error_1 = _a.sent();
+                    (0, bun_test_1.expect)(error_1.name).toBe("APIError");
+                    (0, bun_test_1.expect)(error_1.title).toMatch(/Error posting to Zoom/i);
+                    return [3 /*break*/, 4];
+                case 4:
+                    (0, bun_test_1.expect)(mockAxiosPost.mock.calls.length).toBe(1);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    (0, bun_test_1.it)("captures error and does not throw when shouldThrow=false", function () { return __awaiter(void 0, void 0, void 0, function () {
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    process.env.ZOOM_CHAT_WEBHOOKS = JSON.stringify({
+                        default: {
+                            channel: "https://zoom.example/default",
+                            verificationToken: "token",
+                        },
+                    });
+                    mockAxiosPost.mockRejectedValue(new Error("zoom intermittent"));
+                    return [4 /*yield*/, (0, zoomNotifier_1.sendToZoom)({ body: "err", header: "err" }, { channel: "default", shouldThrow: false })];
+                case 1:
+                    _a.sent();
+                    (0, bun_test_1.expect)(mockAxiosPost.mock.calls.length).toBe(1);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});

package/dist/openApi.d.ts

@@ -0,0 +1,60 @@
+import type { Model } from "mongoose";
+import type { modelRouterOptions } from "./api";
+export declare const apiErrorContent: {
+    "application/json": {
+        schema: {
+            $ref: string;
+        };
+    };
+};
+export declare const defaultOpenApiErrorResponses: {
+    400: {
+        content: {
+            "application/json": {
+                schema: {
+                    $ref: string;
+                };
+            };
+        };
+        description: string;
+    };
+    401: {
+        description: string;
+    };
+    403: {
+        content: {
+            "application/json": {
+                schema: {
+                    $ref: string;
+                };
+            };
+        };
+        description: string;
+    };
+    404: {
+        content: {
+            "application/json": {
+                schema: {
+                    $ref: string;
+                };
+            };
+        };
+        description: string;
+    };
+    405: {
+        content: {
+            "application/json": {
+                schema: {
+                    $ref: string;
+                };
+            };
+        };
+        description: string;
+    };
+};
+export declare function getOpenApiMiddleware<T>(model: Model<T>, options: Partial<modelRouterOptions<T>>): any;
+export declare function listOpenApiMiddleware<T>(model: Model<T>, options: Partial<modelRouterOptions<T>>): any;
+export declare function createOpenApiMiddleware<T>(model: Model<T>, options: Partial<modelRouterOptions<T>>): any;
+export declare function patchOpenApiMiddleware<T>(model: Model<T>, options: Partial<modelRouterOptions<T>>): any;
+export declare function deleteOpenApiMiddleware<T>(model: Model<T>, options: Partial<modelRouterOptions<T>>): any;
+export declare function readOpenApiMiddleware<T>(options: Partial<modelRouterOptions<T>>, properties: any, required: string[], queryParameters: any): any;