@oneuptime/common 14.0.11 → 14.0.12

package/build/dist/Server/Utils/IncomingCall/MissedCallNotification.js

@@ -0,0 +1,204 @@
+import OneUptimeDate from "../../../Types/Date";
+import EmailTemplateType from "../../../Types/Email/EmailTemplateType";
+import IncomingCallStatus from "../../../Types/IncomingCall/IncomingCallStatus";
+import { MissedIncomingCallReason } from "../../../Types/IncomingCall/MissedIncomingCall";
+import NotificationSettingEventType from "../../../Types/NotificationSetting/NotificationSettingEventType";
+import PushNotificationUtil from "../PushNotificationUtil";
+class MissedCallNotification {
+    static getCallerLabel(call) {
+        return call.callerPhoneNumber.trim() || "an unknown number";
+    }
+    static getEmailSubject(call) {
+        return `Missed call from ${MissedCallNotification.getCallerLabel(call)} to ${call.policyName}`;
+    }
+    // The outcome in a few words: the email's Result field.
+    static getResult(reason) {
+        switch (reason) {
+            case MissedIncomingCallReason.NoAnswer:
+                return "Nobody answered";
+            case MissedIncomingCallReason.CallerHungUp:
+                return "Caller hung up before anyone answered";
+            case MissedIncomingCallReason.NoOneAvailable:
+                return "Nobody was available";
+            case MissedIncomingCallReason.PolicyDisabled:
+                return "Policy is disabled";
+            default:
+                return "Call could not be routed";
+        }
+    }
+    // One sentence for SMS, voice and push: "+1… called Support. Nobody answered."
+    static getSummary(call) {
+        return `${MissedCallNotification.getCallerLabel(call)} called ${call.policyName}. ${MissedCallNotification.getResult(call.reason)}.`;
+    }
+    /*
+     * What happened, for the top of the email: what the caller went through and
+     * the one thing to check when it is a configuration problem rather than a
+     * busy line.
+     */
+    static getExplanation(call) {
+        switch (call.reason) {
+            case MissedIncomingCallReason.NoAnswer:
+                return "Nobody answered. OneUptime went through the escalation rules, then played your No Answer Message to the caller and ended the call.";
+            case MissedIncomingCallReason.CallerHungUp: {
+                const waitedSeconds = MissedCallNotification.getSecondsBetween(call.startedAt, call.endedAt);
+                const waited = waitedSeconds !== undefined
+                    ? ` after waiting ${MissedCallNotification.formatDuration(waitedSeconds)}`
+                    : "";
+                return `The caller hung up${waited}, before anyone answered.`;
+            }
+            case MissedIncomingCallReason.NoOneAvailable:
+                return "Nobody was rung. No escalation rule had an on-call user with a verified incoming call number, so OneUptime played your No One Available Message to the caller and ended the call.";
+            case MissedIncomingCallReason.PolicyDisabled:
+                return "Nobody was rung because this incoming call policy is disabled. The caller was told the service is disabled and the call ended.";
+            default:
+                return call.statusMessage.trim()
+                    ? `The call could not be routed to anyone: ${call.statusMessage.trim()}`
+                    : "The call could not be routed to anyone.";
+        }
+    }
+    // "No answer after 30 seconds", "Line busy", "Caller hung up while ringing".
+    static getAttemptResult(attempt) {
+        const rang = attempt.ringSeconds !== undefined
+            ? ` after ${MissedCallNotification.formatDuration(attempt.ringSeconds)}`
+            : "";
+        switch (attempt.status) {
+            case IncomingCallStatus.NoAnswer:
+                return `No answer${rang}`;
+            case IncomingCallStatus.CallerHungUp:
+                return `Caller hung up while ringing${rang}`;
+            case IncomingCallStatus.Busy:
+                return "Line busy";
+            case IncomingCallStatus.Failed:
+                return "Call failed";
+            case IncomingCallStatus.Connected:
+            case IncomingCallStatus.Completed:
+                return "Answered";
+            case IncomingCallStatus.Ringing:
+                return "Ringing";
+            default:
+                return attempt.status ? attempt.status.toString() : "Unknown";
+        }
+    }
+    // "47 seconds", "1 minute", "2 minutes 5 seconds", "1 hour 2 minutes".
+    static formatDuration(totalSeconds) {
+        const seconds = Math.max(0, Math.round(totalSeconds));
+        const hours = Math.floor(seconds / 3600);
+        const minutes = Math.floor((seconds % 3600) / 60);
+        const remainingSeconds = seconds % 60;
+        const parts = [];
+        const unit = (value, name) => {
+            return `${value} ${name}${value === 1 ? "" : "s"}`;
+        };
+        if (hours > 0) {
+            parts.push(unit(hours, "hour"));
+        }
+        if (minutes > 0) {
+            parts.push(unit(minutes, "minute"));
+        }
+        // Seconds are noise next to hours.
+        if ((remainingSeconds > 0 && hours === 0) || parts.length === 0) {
+            parts.push(unit(remainingSeconds, "second"));
+        }
+        return parts.join(" ");
+    }
+    static getSecondsBetween(from, to) {
+        if (!from || !to) {
+            return undefined;
+        }
+        const seconds = Math.round((new Date(to).getTime() - new Date(from).getTime()) / 1000);
+        return seconds >= 0 ? seconds : undefined;
+    }
+    static buildContent(data) {
+        const call = data.call;
+        const callerLabel = MissedCallNotification.getCallerLabel(call);
+        const result = MissedCallNotification.getResult(call.reason);
+        const summary = MissedCallNotification.getSummary(call);
+        const attemptsShown = call.attempts.slice(0, MissedCallNotification.MAX_ATTEMPTS_IN_EMAIL);
+        const moreAttemptsCount = call.attempts.length - attemptsShown.length;
+        const vars = {
+            policyName: call.policyName,
+            projectName: call.projectName,
+            callerPhoneNumber: callerLabel,
+            routingPhoneNumber: call.routingPhoneNumber.trim(),
+            result: result,
+            explanation: MissedCallNotification.getExplanation(call),
+            /*
+             * Trusted HTML: the date helper emits its own <br/> between zones, and
+             * the template renders this through the raw `text` slot for that reason.
+             */
+            callStartedAt: call.startedAt
+                ? OneUptimeDate.getDateAsFormattedHTMLInMultipleTimezones({
+                    date: call.startedAt,
+                    timezones: data.timezone ? [data.timezone] : [],
+                })
+                : "",
+            hasAttempts: attemptsShown.length > 0 ? "true" : "false",
+            attempts: attemptsShown.map((attempt, index) => {
+                const details = [];
+                if (attempt.ruleName.trim()) {
+                    details.push(attempt.ruleName.trim());
+                }
+                if (attempt.phoneNumber.trim()) {
+                    details.push(attempt.phoneNumber.trim());
+                }
+                details.push(MissedCallNotification.getAttemptResult(attempt));
+                return {
+                    position: (index + 1).toString(),
+                    userName: attempt.userName.trim() || "Unknown user",
+                    details: details.join(" · "),
+                };
+            }),
+            hasMoreAttempts: moreAttemptsCount > 0 ? "true" : "false",
+            moreAttemptsCount: moreAttemptsCount.toString(),
+            incomingCallLogViewLink: call.incomingCallLogViewLink,
+        };
+        // Picks the OwnerInfo sentence, as on every other owner email.
+        if (data.isOwner) {
+            vars["isOwner"] = "true";
+        }
+        const emailEnvelope = {
+            templateType: EmailTemplateType.IncomingCallPolicyOwnerMissedCall,
+            vars: vars,
+            subject: MissedCallNotification.getEmailSubject(call),
+            // The policy name is user text; the mailer must not compile it.
+            isSubjectLiteral: true,
+        };
+        const smsMessage = {
+            message: `This is a message from OneUptime. Missed call: ${summary} To unsubscribe from this notification go to User Settings in OneUptime Dashboard.`,
+        };
+        const callRequestMessage = {
+            data: [
+                {
+                    sayMessage: `This is a message from OneUptime. Missed call. ${summary} To unsubscribe from this notification go to User Settings in OneUptime Dashboard. Good bye.`,
+                },
+            ],
+        };
+        const pushNotificationMessage = PushNotificationUtil.createGenericNotification({
+            title: `Missed call to ${call.policyName}`,
+            body: `${callerLabel} called. ${result}. Tap to open the call log.`,
+            clickAction: call.incomingCallLogViewLink,
+            tag: "incoming-call-missed",
+            requireInteraction: false,
+        });
+        /*
+         * No WhatsApp template is registered for this event, and
+         * createWhatsAppMessageFromTemplate throws without one. A plain body is
+         * sent instead, as the SLO notifications do.
+         */
+        const whatsAppMessage = {
+            body: smsMessage.message,
+        };
+        return {
+            emailEnvelope,
+            smsMessage,
+            callRequestMessage,
+            pushNotificationMessage,
+            whatsAppMessage,
+        };
+    }
+}
+// How many attempts the email lists before it points at the call log.
+MissedCallNotification.MAX_ATTEMPTS_IN_EMAIL = 25;
+MissedCallNotification.EVENT_TYPE = NotificationSettingEventType.SEND_INCOMING_CALL_MISSED_OWNER_NOTIFICATION;
+export default MissedCallNotification;
+//# sourceMappingURL=MissedCallNotification.js.map

package/build/dist/Server/Utils/IncomingCall/MissedCallNotification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MissedCallNotification.js","sourceRoot":"","sources":["../../../../../Server/Utils/IncomingCall/MissedCallNotification.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAGhD,OAAO,iBAAiB,MAAM,wCAAwC,CAAC;AACvE,OAAO,kBAAkB,MAAM,gDAAgD,CAAC;AAChF,OAAO,EAAE,wBAAwB,EAAE,MAAM,gDAAgD,CAAC;AAE1F,OAAO,4BAA4B,MAAM,iEAAiE,CAAC;AAK3G,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AA+C3D,MAAqB,sBAAsB;IAOlC,MAAM,CAAC,cAAc,CAAC,IAAgB;QAC3C,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,mBAAmB,CAAC;IAC9D,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAgB;QAC5C,OAAO,oBAAoB,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IACjG,CAAC;IAED,wDAAwD;IACjD,MAAM,CAAC,SAAS,CAAC,MAAgC;QACtD,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,wBAAwB,CAAC,QAAQ;gBACpC,OAAO,iBAAiB,CAAC;YAC3B,KAAK,wBAAwB,CAAC,YAAY;gBACxC,OAAO,uCAAuC,CAAC;YACjD,KAAK,wBAAwB,CAAC,cAAc;gBAC1C,OAAO,sBAAsB,CAAC;YAChC,KAAK,wBAAwB,CAAC,cAAc;gBAC1C,OAAO,oBAAoB,CAAC;YAC9B;gBACE,OAAO,0BAA0B,CAAC;QACtC,CAAC;IACH,CAAC;IAED,+EAA+E;IACxE,MAAM,CAAC,UAAU,CAAC,IAAgB;QACvC,OAAO,GAAG,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,UAAU,KAAK,sBAAsB,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;IACvI,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,cAAc,CAAC,IAAgB;QAC3C,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;YACpB,KAAK,wBAAwB,CAAC,QAAQ;gBACpC,OAAO,oIAAoI,CAAC;YAE9I,KAAK,wBAAwB,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC3C,MAAM,aAAa,GACjB,sBAAsB,CAAC,iBAAiB,CACtC,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,OAAO,CACb,CAAC;gBAEJ,MAAM,MAAM,GACV,aAAa,KAAK,SAAS;oBACzB,CAAC,CAAC,kBAAkB,sBAAsB,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE;oBAC1E,CAAC,CAAC,EAAE,CAAC;gBAET,OAAO,qBAAqB,MAAM,2BAA2B,CAAC;YAChE,CAAC;YAED,KAAK,wBAAwB,CAAC,cAAc;gBAC1C,OAAO,mLAAmL,CAAC;YAE7L,KAAK,wBAAwB,CAAC,cAAc;gBAC1C,OAAO,gIAAgI,CAAC;YAE1I;gBACE,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE;oBAC9B,CAAC,CAAC,2CAA2C,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE;oBACxE,CAAC,CAAC,yCAAyC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,6EAA6E;IACtE,MAAM,CAAC,gBAAgB,CAAC,OAA0B;QACvD,MAAM,IAAI,GACR,OAAO,CAAC,WAAW,KAAK,SAAS;YAC/B,CAAC,CAAC,UAAU,sBAAsB,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;YACxE,CAAC,CAAC,EAAE,CAAC;QAET,QAAQ,OAAO,CAAC,MAAM,EAAE,CAAC;YACvB,KAAK,kBAAkB,CAAC,QAAQ;gBAC9B,OAAO,YAAY,IAAI,EAAE,CAAC;YAC5B,KAAK,kBAAkB,CAAC,YAAY;gBAClC,OAAO,+BAA+B,IAAI,EAAE,CAAC;YAC/C,KAAK,kBAAkB,CAAC,IAAI;gBAC1B,OAAO,WAAW,CAAC;YACrB,KAAK,kBAAkB,CAAC,MAAM;gBAC5B,OAAO,aAAa,CAAC;YACvB,KAAK,kBAAkB,CAAC,SAAS,CAAC;YAClC,KAAK,kBAAkB,CAAC,SAAS;gBAC/B,OAAO,UAAU,CAAC;YACpB,KAAK,kBAAkB,CAAC,OAAO;gBAC7B,OAAO,SAAS,CAAC;YACnB;gBACE,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAClE,CAAC;IACH,CAAC;IAED,uEAAuE;IAChE,MAAM,CAAC,cAAc,CAAC,YAAoB;QAC/C,MAAM,OAAO,GAAW,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;QAC9D,MAAM,KAAK,GAAW,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;QACjD,MAAM,OAAO,GAAW,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAC1D,MAAM,gBAAgB,GAAW,OAAO,GAAG,EAAE,CAAC;QAE9C,MAAM,KAAK,GAAkB,EAAE,CAAC;QAEhC,MAAM,IAAI,GAA4C,CACpD,KAAa,EACb,IAAY,EACJ,EAAE;YACV,OAAO,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC;QACrD,CAAC,CAAC;QAEF,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;QAClC,CAAC;QAED,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;QACtC,CAAC;QAED,mCAAmC;QACnC,IAAI,CAAC,gBAAgB,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAChE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC/C,CAAC;QAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAEM,MAAM,CAAC,iBAAiB,CAC7B,IAAsB,EACtB,EAAoB;QAEpB,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,OAAO,GAAW,IAAI,CAAC,KAAK,CAChC,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,GAAG,IAAI,CAC3D,CAAC;QAEF,OAAO,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5C,CAAC;IAEM,MAAM,CAAC,YAAY,CAAC,IAM1B;QACC,MAAM,IAAI,GAAe,IAAI,CAAC,IAAI,CAAC;QACnC,MAAM,WAAW,GAAW,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACxE,MAAM,MAAM,GAAW,sBAAsB,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACrE,MAAM,OAAO,GAAW,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEhE,MAAM,aAAa,GAA6B,IAAI,CAAC,QAAQ,CAAC,KAAK,CACjE,CAAC,EACD,sBAAsB,CAAC,qBAAqB,CAC7C,CAAC;QACF,MAAM,iBAAiB,GACrB,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC;QAE9C,MAAM,IAAI,GAAoC;YAC5C,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,iBAAiB,EAAE,WAAW;YAC9B,kBAAkB,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE;YAClD,MAAM,EAAE,MAAM;YACd,WAAW,EAAE,sBAAsB,CAAC,cAAc,CAAC,IAAI,CAAC;YACxD;;;eAGG;YACH,aAAa,EAAE,IAAI,CAAC,SAAS;gBAC3B,CAAC,CAAC,aAAa,CAAC,yCAAyC,CAAC;oBACtD,IAAI,EAAE,IAAI,CAAC,SAAS;oBACpB,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;iBAChD,CAAC;gBACJ,CAAC,CAAC,EAAE;YACN,WAAW,EAAE,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;YACxD,QAAQ,EAAE,aAAa,CAAC,GAAG,CACzB,CAAC,OAA0B,EAAE,KAAa,EAAc,EAAE;gBACxD,MAAM,OAAO,GAAkB,EAAE,CAAC;gBAElC,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;oBAC5B,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;gBACxC,CAAC;gBAED,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC;oBAC/B,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC3C,CAAC;gBAED,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC;gBAE/D,OAAO;oBACL,QAAQ,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE;oBAChC,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,cAAc;oBACnD,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;iBAC7B,CAAC;YACJ,CAAC,CACuB;YAC1B,eAAe,EAAE,iBAAiB,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;YACzD,iBAAiB,EAAE,iBAAiB,CAAC,QAAQ,EAAE;YAC/C,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;SACtD,CAAC;QAEF,+DAA+D;QAC/D,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC;QAC3B,CAAC;QAED,MAAM,aAAa,GAAkB;YACnC,YAAY,EAAE,iBAAiB,CAAC,iCAAiC;YACjE,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,sBAAsB,CAAC,eAAe,CAAC,IAAI,CAAC;YACrD,gEAAgE;YAChE,gBAAgB,EAAE,IAAI;SACvB,CAAC;QAEF,MAAM,UAAU,GAAe;YAC7B,OAAO,EAAE,kDAAkD,OAAO,oFAAoF;SACvJ,CAAC;QAEF,MAAM,kBAAkB,GAAuB;YAC7C,IAAI,EAAE;gBACJ;oBACE,UAAU,EAAE,kDAAkD,OAAO,8FAA8F;iBACpK;aACF;SACF,CAAC;QAEF,MAAM,uBAAuB,GAC3B,oBAAoB,CAAC,yBAAyB,CAAC;YAC7C,KAAK,EAAE,kBAAkB,IAAI,CAAC,UAAU,EAAE;YAC1C,IAAI,EAAE,GAAG,WAAW,YAAY,MAAM,6BAA6B;YACnE,WAAW,EAAE,IAAI,CAAC,uBAAuB;YACzC,GAAG,EAAE,sBAAsB;YAC3B,kBAAkB,EAAE,KAAK;SAC1B,CAAC,CAAC;QAEL;;;;WAIG;QACH,MAAM,eAAe,GAA2B;YAC9C,IAAI,EAAE,UAAU,CAAC,OAAO;SACzB,CAAC;QAEF,OAAO;YACL,aAAa;YACb,UAAU;YACV,kBAAkB;YAClB,uBAAuB;YACvB,eAAe;SAChB,CAAC;IACJ,CAAC;;AAnQD,sEAAsE;AAC/C,4CAAqB,GAAW,EAAE,CAAC;AAEnC,iCAAU,GAC/B,4BAA4B,CAAC,4CAA4C,CAAC;eALzD,sBAAsB"}

package/build/dist/Server/Utils/Mcp/McpDelegationToken.js

@@ -0,0 +1,92 @@
+import McpOAuthConfig from "./McpOAuthConfig";
+import McpOAuthSignedToken from "./McpOAuthSignedToken";
+import Email from "../../../Types/Email";
+import ObjectID from "../../../Types/ObjectID";
+const PURPOSE = {
+    keyDerivationLabel: "oneuptime:mcp:oauth:api-delegation-token:v1",
+    maxLength: 4096,
+};
+class McpDelegationToken {
+    static sign(claims, now) {
+        const token = McpOAuthSignedToken.sign({
+            purpose: PURPOSE,
+            claims: {
+                u: claims.userId.toString(),
+                e: claims.userEmail.toString(),
+                n: claims.userName,
+                p: claims.projectId.toString(),
+                g: claims.grantId.toString(),
+                ci: claims.clientId,
+                cn: claims.clientName,
+                w: claims.canWrite === true,
+            },
+            expiresInSeconds: McpOAuthConfig.DELEGATION_TOKEN_TTL_SECONDS,
+            now,
+        });
+        if (!token) {
+            /*
+             * Every field is bounded where it was stored (a client id is at most
+             * 500 characters, a name 100), so this is unreachable short of a bug.
+             */
+            throw new Error("MCP delegation token could not be created.");
+        }
+        return token;
+    }
+    // NEVER throws: anything that is not a valid, current token is null.
+    static verify(token, now) {
+        const claims = McpOAuthSignedToken.verify({
+            purpose: PURPOSE,
+            token,
+            now,
+        });
+        if (!claims) {
+            return null;
+        }
+        const userId = claims["u"];
+        const userEmail = claims["e"];
+        const userName = claims["n"];
+        const projectId = claims["p"];
+        const grantId = claims["g"];
+        const clientId = claims["ci"];
+        const clientName = claims["cn"];
+        const canWrite = claims["w"];
+        if (typeof userId !== "string" ||
+            typeof projectId !== "string" ||
+            typeof grantId !== "string" ||
+            !ObjectID.isValidUUID(userId) ||
+            !ObjectID.isValidUUID(projectId) ||
+            !ObjectID.isValidUUID(grantId)) {
+            return null;
+        }
+        if (typeof userEmail !== "string" || !Email.isValid(userEmail)) {
+            return null;
+        }
+        if (typeof userName !== "string" ||
+            typeof clientId !== "string" ||
+            typeof clientName !== "string" ||
+            !clientId) {
+            return null;
+        }
+        /*
+         * A token that does not say is not a token that may write: the claim is
+         * required, so nothing can come to mean "read and write" by omission.
+         */
+        if (typeof canWrite !== "boolean") {
+            return null;
+        }
+        return {
+            userId: new ObjectID(userId),
+            userEmail: new Email(userEmail),
+            userName,
+            projectId: new ObjectID(projectId),
+            grantId: new ObjectID(grantId),
+            clientId,
+            clientName,
+            canWrite,
+        };
+    }
+}
+// Lower case: Node lower-cases header names on the way in.
+McpDelegationToken.HEADER_NAME = "x-oneuptime-mcp-delegation";
+export default McpDelegationToken;
+//# sourceMappingURL=McpDelegationToken.js.map

package/build/dist/Server/Utils/Mcp/McpDelegationToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"McpDelegationToken.js","sourceRoot":"","sources":["../../../../../Server/Utils/Mcp/McpDelegationToken.ts"],"names":[],"mappings":"AAAA,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,mBAEN,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,MAAM,sBAAsB,CAAC;AAEzC,OAAO,QAAQ,MAAM,yBAAyB,CAAC;AAyD/C,MAAM,OAAO,GAA+B;IAC1C,kBAAkB,EAAE,6CAA6C;IACjE,SAAS,EAAE,IAAI;CAChB,CAAC;AAEF,MAAqB,kBAAkB;IAI9B,MAAM,CAAC,IAAI,CAChB,MAA2B,EAC3B,GAAsB;QAEtB,MAAM,KAAK,GAAkB,mBAAmB,CAAC,IAAI,CAAC;YACpD,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE;gBACN,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;gBAC3B,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;gBAC9B,CAAC,EAAE,MAAM,CAAC,QAAQ;gBAClB,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;gBAC9B,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE;gBAC5B,EAAE,EAAE,MAAM,CAAC,QAAQ;gBACnB,EAAE,EAAE,MAAM,CAAC,UAAU;gBACrB,CAAC,EAAE,MAAM,CAAC,QAAQ,KAAK,IAAI;aAC5B;YACD,gBAAgB,EAAE,cAAc,CAAC,4BAA4B;YAC7D,GAAG;SACJ,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,EAAE,CAAC;YACX;;;eAGG;YACH,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,qEAAqE;IAC9D,MAAM,CAAC,MAAM,CAClB,KAAc,EACd,GAAsB;QAEtB,MAAM,MAAM,GAAsB,mBAAmB,CAAC,MAAM,CAAC;YAC3D,OAAO,EAAE,OAAO;YAChB,KAAK;YACL,GAAG;SACJ,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,MAAM,GAAY,MAAM,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,SAAS,GAAY,MAAM,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,QAAQ,GAAY,MAAM,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,SAAS,GAAY,MAAM,CAAC,GAAG,CAAC,CAAC;QACvC,MAAM,OAAO,GAAY,MAAM,CAAC,GAAG,CAAC,CAAC;QACrC,MAAM,QAAQ,GAAY,MAAM,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,UAAU,GAAY,MAAM,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,QAAQ,GAAY,MAAM,CAAC,GAAG,CAAC,CAAC;QAEtC,IACE,OAAO,MAAM,KAAK,QAAQ;YAC1B,OAAO,SAAS,KAAK,QAAQ;YAC7B,OAAO,OAAO,KAAK,QAAQ;YAC3B,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC;YAC7B,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC;YAChC,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAO,CAAC,EAC9B,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC/D,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IACE,OAAO,QAAQ,KAAK,QAAQ;YAC5B,OAAO,QAAQ,KAAK,QAAQ;YAC5B,OAAO,UAAU,KAAK,QAAQ;YAC9B,CAAC,QAAQ,EACT,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED;;;WAGG;QACH,IAAI,OAAO,QAAQ,KAAK,SAAS,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO;YACL,MAAM,EAAE,IAAI,QAAQ,CAAC,MAAM,CAAC;YAC5B,SAAS,EAAE,IAAI,KAAK,CAAC,SAAS,CAAC;YAC/B,QAAQ;YACR,SAAS,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC;YAClC,OAAO,EAAE,IAAI,QAAQ,CAAC,OAAO,CAAC;YAC9B,QAAQ;YACR,UAAU;YACV,QAAQ;SACT,CAAC;IACJ,CAAC;;AApGD,2DAA2D;AACpC,8BAAW,GAAW,4BAA4B,CAAC;eAFvD,kBAAkB"}

package/build/dist/Server/Utils/Mcp/McpOAuthConfig.js

@@ -0,0 +1,159 @@
+import { DisableMcpOAuth, DisableMcpOAuthClientIdMetadataDocuments, Host, HttpProtocol, } from "../../EnvironmentConfig";
+/*
+ * The fixed points of the MCP authorization server: where it lives, and how
+ * long the things it hands out last.
+ *
+ * ONE ISSUER, UNDER /mcp
+ *
+ * The authorization server and the MCP endpoint it protects share a URL:
+ * `https://<host>/mcp` is both the issuer and the resource. Every OAuth
+ * endpoint sits beneath it, so the whole feature is reachable through the one
+ * path that already routes to the App on every deployment, and it claims
+ * nothing about the rest of the origin.
+ *
+ * ALWAYS FROM CONFIGURATION, NEVER FROM THE REQUEST
+ *
+ * Every URL here is built from HOST / HTTP_PROTOCOL. A token is bound to the
+ * resource it was issued for, and an issuer that followed the Host header
+ * would let whoever controls a hostname pointed at this instance mint
+ * metadata naming their own endpoints.
+ */
+const MCP_PATH = "/mcp";
+const OAUTH_PATH = `${MCP_PATH}/oauth`;
+class McpOAuthConfig {
+    static isEnabled() {
+        return !DisableMcpOAuth;
+    }
+    static isClientIdMetadataDocumentEnabled() {
+        return !DisableMcpOAuthClientIdMetadataDocuments;
+    }
+    /*
+     * The origin this instance is served from. The fallback matches the MCP
+     * server's own (Config/ServerConfig.getApiUrl), so the two can never
+     * disagree about where the API is.
+     */
+    static getOrigin() {
+        return Host ? `${HttpProtocol}${Host}` : "https://oneuptime.com";
+    }
+    // The MCP endpoint: the protected resource (RFC 9728) and token audience.
+    static getResource() {
+        return `${McpOAuthConfig.getOrigin()}${MCP_PATH}`;
+    }
+    // The authorization server's issuer identifier (RFC 8414).
+    static getIssuer() {
+        return `${McpOAuthConfig.getOrigin()}${MCP_PATH}`;
+    }
+    static getAuthorizationEndpoint() {
+        return `${McpOAuthConfig.getOrigin()}${OAUTH_PATH}/authorize`;
+    }
+    static getTokenEndpoint() {
+        return `${McpOAuthConfig.getOrigin()}${OAUTH_PATH}/token`;
+    }
+    static getRegistrationEndpoint() {
+        return `${McpOAuthConfig.getOrigin()}${OAUTH_PATH}/register`;
+    }
+    static getRevocationEndpoint() {
+        return `${McpOAuthConfig.getOrigin()}${OAUTH_PATH}/revoke`;
+    }
+    /*
+     * The protected resource metadata URL a challenge points at. The copy under
+     * /mcp rather than the one under /.well-known: it is served by the same
+     * route that just answered 401, so it is reachable wherever the challenge
+     * is, including behind a proxy that forwards only /mcp.
+     */
+    static getProtectedResourceMetadataUrl() {
+        return `${McpOAuthConfig.getResource()}/.well-known/oauth-protected-resource`;
+    }
+    // Where a person is sent to sign in and decide.
+    static getConsentPageUrl() {
+        return `${McpOAuthConfig.getOrigin()}/accounts/mcp-authorize`;
+    }
+    static getDocumentationUrl() {
+        return `${McpOAuthConfig.getOrigin()}/docs/ai/mcp-server`;
+    }
+    /*
+     * Whether a `resource` value names this MCP server.
+     *
+     * Compared as URLs rather than as strings, so the differences that do not
+     * change what a URL points at are tolerated: letter case in the scheme and
+     * host, a default port spelled out, a trailing slash (clients derive the
+     * value from whatever their user typed). Anything that does change it is
+     * refused - another host, scheme, port or path is a token meant for
+     * somewhere else - and so is a query, a fragment or embedded credentials,
+     * none of which a resource identifier may carry (RFC 8707 section 2).
+     */
+    static isThisResource(value) {
+        if (typeof value !== "string" || !value) {
+            return false;
+        }
+        let candidate;
+        let expected;
+        try {
+            candidate = new globalThis.URL(value);
+            expected = new globalThis.URL(McpOAuthConfig.getResource());
+        }
+        catch (_a) {
+            return false;
+        }
+        /*
+         * The raw string is checked as well: the parser reports an empty query
+         * or fragment ("…/mcp?", "…/mcp#") as no query or fragment at all.
+         */
+        if (value.includes("?") ||
+            value.includes("#") ||
+            candidate.username ||
+            candidate.password) {
+            return false;
+        }
+        return (candidate.origin === expected.origin &&
+            McpOAuthConfig.stripTrailingSlash(candidate.pathname) ===
+                McpOAuthConfig.stripTrailingSlash(expected.pathname));
+    }
+    static stripTrailingSlash(pathname) {
+        return pathname.endsWith("/") ? pathname.slice(0, -1) : pathname;
+    }
+}
+/*
+ * An authorization code is collected by the client within seconds of the
+ * member pressing Authorize. Five minutes is generous for a slow network
+ * and short enough that a code which leaks afterwards is already dead.
+ */
+McpOAuthConfig.AUTHORIZATION_CODE_TTL_SECONDS = 5 * 60;
+/*
+ * The credential that rides on every MCP request, so the one most likely to
+ * end up in a log or a crash dump. An hour bounds what a leaked one is
+ * worth; the client refreshes without anybody noticing.
+ */
+McpOAuthConfig.ACCESS_TOKEN_TTL_SECONDS = 60 * 60;
+/*
+ * Sliding: each refresh issues a new token good for another thirty days,
+ * so a client in regular use never has to ask its user to sign in again,
+ * and one left unused for a month quietly stops working. The same window
+ * a dashboard session's refresh token gets.
+ */
+McpOAuthConfig.REFRESH_TOKEN_TTL_SECONDS = 30 * 24 * 60 * 60;
+/*
+ * How long a refresh token that has just been exchanged may be presented
+ * again without that being treated as theft.
+ *
+ * Rotation invalidates a refresh token the moment it is used, and using a
+ * spent one revokes the whole grant - that is what makes a stolen token
+ * detectable. But clients do send the same token twice in good faith: a
+ * response lost on the way back and retried, two workers of one hosted
+ * client refreshing at the same moment. Without a grace period each of
+ * those would sign the user out. Inside it, the retry simply gets its own
+ * fresh pair.
+ */
+McpOAuthConfig.REFRESH_TOKEN_REUSE_GRACE_SECONDS = 60;
+/*
+ * How long the signed description of an authorization request stays valid:
+ * the time a person has to sign in and decide on the consent screen.
+ */
+McpOAuthConfig.AUTHORIZATION_REQUEST_TTL_SECONDS = 10 * 60;
+/*
+ * How long the internal credential the MCP server presents to the API on a
+ * member's behalf is good for. It is minted per tool call and used at once.
+ */
+McpOAuthConfig.DELEGATION_TOKEN_TTL_SECONDS = 60;
+export default McpOAuthConfig;
+//# sourceMappingURL=McpOAuthConfig.js.map

package/build/dist/Server/Utils/Mcp/McpOAuthConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"McpOAuthConfig.js","sourceRoot":"","sources":["../../../../../Server/Utils/Mcp/McpOAuthConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,wCAAwC,EACxC,IAAI,EACJ,YAAY,GACb,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;;;;;;;;;;;GAkBG;AAEH,MAAM,QAAQ,GAAW,MAAM,CAAC;AAChC,MAAM,UAAU,GAAW,GAAG,QAAQ,QAAQ,CAAC;AAE/C,MAAqB,cAAc;IAiD1B,MAAM,CAAC,SAAS;QACrB,OAAO,CAAC,eAAe,CAAC;IAC1B,CAAC;IAEM,MAAM,CAAC,iCAAiC;QAC7C,OAAO,CAAC,wCAAwC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,SAAS;QACrB,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,YAAY,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,uBAAuB,CAAC;IACnE,CAAC;IAED,0EAA0E;IACnE,MAAM,CAAC,WAAW;QACvB,OAAO,GAAG,cAAc,CAAC,SAAS,EAAE,GAAG,QAAQ,EAAE,CAAC;IACpD,CAAC;IAED,2DAA2D;IACpD,MAAM,CAAC,SAAS;QACrB,OAAO,GAAG,cAAc,CAAC,SAAS,EAAE,GAAG,QAAQ,EAAE,CAAC;IACpD,CAAC;IAEM,MAAM,CAAC,wBAAwB;QACpC,OAAO,GAAG,cAAc,CAAC,SAAS,EAAE,GAAG,UAAU,YAAY,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,gBAAgB;QAC5B,OAAO,GAAG,cAAc,CAAC,SAAS,EAAE,GAAG,UAAU,QAAQ,CAAC;IAC5D,CAAC;IAEM,MAAM,CAAC,uBAAuB;QACnC,OAAO,GAAG,cAAc,CAAC,SAAS,EAAE,GAAG,UAAU,WAAW,CAAC;IAC/D,CAAC;IAEM,MAAM,CAAC,qBAAqB;QACjC,OAAO,GAAG,cAAc,CAAC,SAAS,EAAE,GAAG,UAAU,SAAS,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,+BAA+B;QAC3C,OAAO,GAAG,cAAc,CAAC,WAAW,EAAE,uCAAuC,CAAC;IAChF,CAAC;IAED,gDAAgD;IACzC,MAAM,CAAC,iBAAiB;QAC7B,OAAO,GAAG,cAAc,CAAC,SAAS,EAAE,yBAAyB,CAAC;IAChE,CAAC;IAEM,MAAM,CAAC,mBAAmB;QAC/B,OAAO,GAAG,cAAc,CAAC,SAAS,EAAE,qBAAqB,CAAC;IAC5D,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,cAAc,CAAC,KAAc;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC;YACxC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,SAAyB,CAAC;QAC9B,IAAI,QAAwB,CAAC;QAE7B,IAAI,CAAC;YACH,SAAS,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACtC,QAAQ,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,EAAE,CAAC,CAAC;QAC9D,CAAC;QAAC,WAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACf,CAAC;QAED;;;WAGG;QACH,IACE,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;YACnB,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;YACnB,SAAS,CAAC,QAAQ;YAClB,SAAS,CAAC,QAAQ,EAClB,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,CACL,SAAS,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;YACpC,cAAc,CAAC,kBAAkB,CAAC,SAAS,CAAC,QAAQ,CAAC;gBACnD,cAAc,CAAC,kBAAkB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CACvD,CAAC;IACJ,CAAC;IAEO,MAAM,CAAC,kBAAkB,CAAC,QAAgB;QAChD,OAAO,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IACnE,CAAC;;AA9JD;;;;GAIG;AACoB,6CAA8B,GAAW,CAAC,GAAG,EAAE,CAAC;AAEvE;;;;GAIG;AACoB,uCAAwB,GAAW,EAAE,GAAG,EAAE,CAAC;AAElE;;;;;GAKG;AACoB,wCAAyB,GAAW,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAE7E;;;;;;;;;;;GAWG;AACoB,gDAAiC,GAAW,EAAE,CAAC;AAEtE;;;GAGG;AACoB,gDAAiC,GAAW,EAAE,GAAG,EAAE,CAAC;AAE3E;;;GAGG;AACoB,2CAA4B,GAAW,EAAE,CAAC;eA/C9C,cAAc"}