@oneuptime/common 9.3.22 → 9.4.0

package/Server/Services/UserIncomingCallNumberService.ts

@@ -0,0 +1,258 @@
+import { IsBillingEnabled } from "../EnvironmentConfig";
+import CreateBy from "../Types/Database/CreateBy";
+import { OnCreate } from "../Types/Database/Hooks";
+import logger from "../Utils/Logger";
+import DatabaseService from "./DatabaseService";
+import ProjectService from "./ProjectService";
+import SmsService from "./SmsService";
+import BadDataException from "../../Types/Exception/BadDataException";
+import ObjectID from "../../Types/ObjectID";
+import Text from "../../Types/Text";
+import Project from "../../Models/DatabaseModels/Project";
+import Model from "../../Models/DatabaseModels/UserIncomingCallNumber";
+import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+
+export class Service extends DatabaseService<Model> {
+  public constructor() {
+    super(Model);
+  }
+
+  @CaptureSpan()
+  protected override async onBeforeCreate(
+    createBy: CreateBy<Model>,
+  ): Promise<OnCreate<Model>> {
+    // Check if user is trying to set isVerified to true
+    if (!createBy.props.isRoot && createBy.data.isVerified) {
+      throw new BadDataException("isVerified cannot be set to true");
+    }
+
+    // Check if SMS notifications are enabled for this project
+    const project: Project | null = await ProjectService.findOneById({
+      id: createBy.data.projectId!,
+      props: {
+        isRoot: true,
+      },
+      select: {
+        enableSmsNotifications: true,
+        smsOrCallCurrentBalanceInUSDCents: true,
+      },
+    });
+
+    if (!project) {
+      throw new BadDataException("Project not found");
+    }
+
+    if (!project.enableSmsNotifications) {
+      throw new BadDataException(
+        "SMS notifications are disabled for this project. Please enable them in Project Settings > Notification Settings.",
+      );
+    }
+
+    if (
+      (project.smsOrCallCurrentBalanceInUSDCents as number) <= 100 &&
+      IsBillingEnabled
+    ) {
+      throw new BadDataException(
+        "Your SMS balance is low. Please recharge your SMS balance in Project Settings > Notification Settings.",
+      );
+    }
+
+    // Check if user already has a verified phone number for this project
+    const existingVerifiedNumber: Model | null = await this.findOneBy({
+      query: {
+        userId: createBy.data.userId!,
+        projectId: createBy.data.projectId!,
+        isVerified: true,
+      },
+      select: {
+        _id: true,
+      },
+      props: {
+        isRoot: true,
+      },
+    });
+
+    if (existingVerifiedNumber) {
+      throw new BadDataException(
+        "You already have a verified phone number for this project. Please delete the existing one before adding a new one.",
+      );
+    }
+
+    return { carryForward: null, createBy };
+  }
+
+  @CaptureSpan()
+  protected override async onCreateSuccess(
+    _onCreate: OnCreate<Model>,
+    createdItem: Model,
+  ): Promise<Model> {
+    if (!createdItem.isVerified) {
+      this.sendVerificationCode(createdItem);
+    }
+
+    return createdItem;
+  }
+
+  @CaptureSpan()
+  public async resendVerificationCode(itemId: ObjectID): Promise<void> {
+    const item: Model | null = await this.findOneById({
+      id: itemId,
+      props: {
+        isRoot: true,
+      },
+      select: {
+        phone: true,
+        verificationCode: true,
+        isVerified: true,
+        projectId: true,
+        userId: true,
+      },
+    });
+
+    if (!item) {
+      throw new BadDataException(
+        "Item with ID " + itemId.toString() + " not found",
+      );
+    }
+
+    if (item.isVerified) {
+      throw new BadDataException("Phone Number already verified");
+    }
+
+    // Check if SMS notifications are enabled for this project
+    const project: Project | null = await ProjectService.findOneById({
+      id: item.projectId!,
+      props: {
+        isRoot: true,
+      },
+      select: {
+        enableSmsNotifications: true,
+        smsOrCallCurrentBalanceInUSDCents: true,
+      },
+    });
+
+    if (!project) {
+      throw new BadDataException("Project not found");
+    }
+
+    if (!project.enableSmsNotifications) {
+      throw new BadDataException(
+        "SMS notifications are disabled for this project. Please enable them in Project Settings > Notification Settings.",
+      );
+    }
+
+    if (
+      (project.smsOrCallCurrentBalanceInUSDCents as number) <= 100 &&
+      IsBillingEnabled
+    ) {
+      throw new BadDataException(
+        "Your SMS balance is low. Please recharge your SMS balance in Project Settings > Notification Settings.",
+      );
+    }
+
+    // Generate new verification code
+    item.verificationCode = Text.generateRandomNumber(6);
+
+    await this.updateOneById({
+      id: item.id!,
+      props: {
+        isRoot: true,
+      },
+      data: {
+        verificationCode: item.verificationCode,
+      },
+    });
+
+    this.sendVerificationCode(item);
+  }
+
+  public sendVerificationCode(item: Model): void {
+    // Send verification SMS
+    SmsService.sendSms(
+      {
+        to: item.phone!,
+        message:
+          "This message is from OneUptime. Your verification code for incoming call routing is " +
+          item.verificationCode,
+      },
+      {
+        projectId: item.projectId,
+        isSensitive: true,
+        userId: item.userId!,
+      },
+    ).catch((err: Error) => {
+      logger.error(err);
+    });
+  }
+
+  @CaptureSpan()
+  public async verifyPhoneNumber(
+    itemId: ObjectID,
+    userId: ObjectID,
+    code: string,
+  ): Promise<void> {
+    const item: Model | null = await this.findOneById({
+      id: itemId,
+      props: {
+        isRoot: true,
+      },
+      select: {
+        userId: true,
+        verificationCode: true,
+        isVerified: true,
+        projectId: true,
+      },
+    });
+
+    if (!item) {
+      throw new BadDataException("Item not found");
+    }
+
+    // Check user ID
+    if (item.userId?.toString() !== userId.toString()) {
+      throw new BadDataException("Invalid user ID");
+    }
+
+    if (item.isVerified) {
+      throw new BadDataException("Phone number is already verified");
+    }
+
+    if (item.verificationCode !== code) {
+      throw new BadDataException("Invalid verification code");
+    }
+
+    // Check if user already has a verified number for this project
+    const existingVerifiedNumber: Model | null = await this.findOneBy({
+      query: {
+        userId: item.userId!,
+        projectId: item.projectId!,
+        isVerified: true,
+      },
+      select: {
+        _id: true,
+      },
+      props: {
+        isRoot: true,
+      },
+    });
+
+    if (existingVerifiedNumber) {
+      throw new BadDataException(
+        "You already have a verified phone number for this project. Please delete the existing one before verifying a new one.",
+      );
+    }
+
+    // Mark as verified
+    await this.updateOneById({
+      id: itemId,
+      props: {
+        isRoot: true,
+      },
+      data: {
+        isVerified: true,
+      },
+    });
+  }
+}
+
+export default new Service();

package/Server/Services/UserSmsService.ts

@@ -137,6 +137,37 @@ export class Service extends DatabaseService<Model> {
       throw new BadDataException("Phone Number already verified");
     }
 
+    // Check if SMS notifications are enabled for this project
+    const project: Project | null = await ProjectService.findOneById({
+      id: item.projectId!,
+      props: {
+        isRoot: true,
+      },
+      select: {
+        enableSmsNotifications: true,
+        smsOrCallCurrentBalanceInUSDCents: true,
+      },
+    });
+
+    if (!project) {
+      throw new BadDataException("Project not found");
+    }
+
+    if (!project.enableSmsNotifications) {
+      throw new BadDataException(
+        "SMS notifications are disabled for this project. Please enable them in Project Settings > Notification Settings.",
+      );
+    }
+
+    if (
+      (project.smsOrCallCurrentBalanceInUSDCents as number) <= 100 &&
+      IsBillingEnabled
+    ) {
+      throw new BadDataException(
+        "Your SMS balance is low. Please recharge your SMS balance in Project Settings > Notification Settings.",
+      );
+    }
+
     // generate new verification code
     item.verificationCode = Text.generateRandomNumber(6);
 

package/Server/Utils/StartServer.ts

@@ -45,6 +45,11 @@ const app: ExpressApplication = Express.getExpressApp();
 app.disable("x-powered-by");
 app.set("port", process.env["PORT"]);
 app.set("view engine", "ejs");
+/*
+ * Enable trust proxy to correctly interpret X-Forwarded-* headers from reverse proxies
+ * This is needed for req.protocol, req.ip to be correct when behind nginx/load balancers
+ */
+app.set("trust proxy", true);
 app.use(CookieParser());
 
 const jsonBodyParserMiddleware: RequestHandler = ExpressJson({

package/Types/Call/CallProvider.ts

@@ -0,0 +1,99 @@
+import { JSONObject } from "../JSON";
+
+// Phone number from provider search
+export interface AvailablePhoneNumber {
+  phoneNumber: string; // "+14155550123"
+  friendlyName: string; // "(415) 555-0123"
+  locality?: string; // "San Francisco"
+  region?: string; // "CA"
+  country: string; // "US"
+}
+
+// Purchased phone number details
+export interface PurchasedPhoneNumber {
+  phoneNumberId: string; // Provider's ID (e.g., Twilio SID)
+  phoneNumber: string;
+}
+
+// Owned phone number (already purchased in Twilio account)
+export interface OwnedPhoneNumber {
+  phoneNumberId: string; // Provider's ID (e.g., Twilio SID)
+  phoneNumber: string; // "+14155550123"
+  friendlyName: string; // "(415) 555-0123"
+  voiceUrl?: string | undefined; // Current webhook URL configured
+}
+
+// Search options for available numbers
+export interface SearchNumberOptions {
+  countryCode: string;
+  areaCode?: string;
+  contains?: string;
+  limit?: number;
+}
+
+// Options for dial operation
+export interface DialOptions {
+  toPhoneNumber: string;
+  fromPhoneNumber: string;
+  timeoutSeconds: number;
+  statusCallbackUrl: string;
+}
+
+// Parsed incoming call data from webhook
+export interface IncomingCallData {
+  callId: string; // Provider's call ID
+  callerPhoneNumber: string;
+  calledPhoneNumber: string;
+}
+
+// Parsed dial status data from webhook
+export interface DialStatusData {
+  callId: string;
+  dialStatus: "completed" | "busy" | "no-answer" | "failed" | "canceled";
+  dialDurationSeconds?: number;
+}
+
+// Express Request type for webhook parsing
+export interface WebhookRequest {
+  body: JSONObject;
+  headers: { [key: string]: string | string[] | undefined };
+  originalUrl: string;
+  url: string;
+  protocol: string;
+  get: (name: string) => string | undefined;
+}
+
+// Call provider interface - all providers must implement this
+export interface ICallProvider {
+  // Phone number management
+  searchAvailableNumbers(
+    options: SearchNumberOptions,
+  ): Promise<AvailablePhoneNumber[]>;
+  listOwnedNumbers(): Promise<OwnedPhoneNumber[]>;
+  purchaseNumber(
+    phoneNumber: string,
+    webhookUrl: string,
+  ): Promise<PurchasedPhoneNumber>;
+  assignExistingNumber(
+    phoneNumberId: string,
+    webhookUrl: string,
+  ): Promise<PurchasedPhoneNumber>;
+  releaseNumber(phoneNumberId: string): Promise<void>;
+  updateWebhookUrl(phoneNumberId: string, webhookUrl: string): Promise<void>;
+
+  // Voice response generation (provider-specific markup)
+  generateGreetingResponse(message: string): string;
+  generateDialResponse(options: DialOptions): string;
+  generateHangupResponse(message?: string): string;
+  generateEscalationResponse(
+    message: string,
+    nextDialOptions: DialOptions,
+  ): string;
+
+  // Webhook parsing
+  parseIncomingCallWebhook(request: WebhookRequest): IncomingCallData;
+  parseDialStatusWebhook(request: WebhookRequest): DialStatusData;
+
+  // Webhook signature validation
+  validateWebhookSignature(request: WebhookRequest, signature: string): boolean;
+}

package/Types/Call/CallProviderType.ts

@@ -0,0 +1,6 @@
+// Available call providers
+enum CallProviderType {
+  Twilio = "twilio",
+}
+
+export default CallProviderType;

package/Types/Icon/IconProp.ts

@@ -62,6 +62,7 @@ enum IconProp {
   Activity = "Activity",
   Alert = "Alert",
   Call = "Call",
+  IncomingCall = "IncomingCall",
   List = "List",
   CheckCircle = "CheckCircle",
   Search = "Search",

package/Types/IncomingCall/IncomingCallStatus.ts

@@ -0,0 +1,13 @@
+enum IncomingCallStatus {
+  Initiated = "Initiated",
+  Ringing = "Ringing",
+  Connected = "Connected",
+  Escalated = "Escalated",
+  NoAnswer = "NoAnswer",
+  Failed = "Failed",
+  Completed = "Completed",
+  CallerHungUp = "CallerHungUp",
+  Busy = "Busy",
+}
+
+export default IncomingCallStatus;

package/Types/Permission.ts

@@ -164,6 +164,9 @@ enum Permission {
   ReadWorkspaceNotificationLog = "ReadWorkspaceNotificationLog",
   ReadLlmLog = "ReadLlmLog",
 
+  ReadProjectSCIMLog = "ReadProjectSCIMLog",
+  ReadStatusPageSCIMLog = "ReadStatusPageSCIMLog",
+
   CreateIncidentOwnerTeam = "CreateIncidentOwnerTeam",
   DeleteIncidentOwnerTeam = "DeleteIncidentOwnerTeam",
   EditIncidentOwnerTeam = "EditIncidentOwnerTeam",
@@ -598,6 +601,24 @@ enum Permission {
   DeleteProjectOnCallDutyPolicyEscalationRuleTeam = "DeleteProjectOnCallDutyPolicyEscalationRuleTeam",
   ReadProjectOnCallDutyPolicyEscalationRuleTeam = "ReadProjectOnCallDutyPolicyEscalationRuleTeam",
 
+  // Incoming Call Policy Permissions
+  CreateProjectIncomingCallPolicy = "CreateProjectIncomingCallPolicy",
+  EditProjectIncomingCallPolicy = "EditProjectIncomingCallPolicy",
+  DeleteProjectIncomingCallPolicy = "DeleteProjectIncomingCallPolicy",
+  ReadProjectIncomingCallPolicy = "ReadProjectIncomingCallPolicy",
+
+  // Incoming Call Policy Escalation Rule Permissions
+  CreateProjectIncomingCallPolicyEscalationRule = "CreateProjectIncomingCallPolicyEscalationRule",
+  EditProjectIncomingCallPolicyEscalationRule = "EditProjectIncomingCallPolicyEscalationRule",
+  DeleteProjectIncomingCallPolicyEscalationRule = "DeleteProjectIncomingCallPolicyEscalationRule",
+  ReadProjectIncomingCallPolicyEscalationRule = "ReadProjectIncomingCallPolicyEscalationRule",
+
+  // Incoming Call Log Permissions
+  ReadProjectIncomingCallLog = "ReadProjectIncomingCallLog",
+
+  // Incoming Call Log Item Permissions
+  ReadProjectIncomingCallLogItem = "ReadProjectIncomingCallLogItem",
+
   // Project SMTP Config (Team Permission)
   CreateProjectSMTPConfig = "CreateProjectSMTPConfig",
   EditProjectSMTPConfig = "EditProjectSMTPConfig",
@@ -1373,6 +1394,23 @@ export class PermissionHelper {
         isAccessControlPermission: false,
       },
 
+      {
+        permission: Permission.ReadProjectSCIMLog,
+        title: "Read Project SCIM Log",
+        description:
+          "This permission can read SCIM provisioning logs of the project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+      {
+        permission: Permission.ReadStatusPageSCIMLog,
+        title: "Read Status Page SCIM Log",
+        description:
+          "This permission can read SCIM provisioning logs of status pages in the project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+
       {
         permission: Permission.CreateProjectMonitorStatus,
         title: "Create Monitor Status",
@@ -2475,6 +2513,94 @@ export class PermissionHelper {
         isAccessControlPermission: false,
       },
 
+      // Incoming Call Policy Permissions
+      {
+        permission: Permission.CreateProjectIncomingCallPolicy,
+        title: "Create Incoming Call Policy",
+        description:
+          "This permission can create incoming call policies for this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+      {
+        permission: Permission.DeleteProjectIncomingCallPolicy,
+        title: "Delete Incoming Call Policy",
+        description:
+          "This permission can delete incoming call policies of this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+      {
+        permission: Permission.EditProjectIncomingCallPolicy,
+        title: "Edit Incoming Call Policy",
+        description:
+          "This permission can edit incoming call policies of this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+      {
+        permission: Permission.ReadProjectIncomingCallPolicy,
+        title: "Read Incoming Call Policy",
+        description:
+          "This permission can read incoming call policies of this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+
+      // Incoming Call Policy Escalation Rule Permissions
+      {
+        permission: Permission.CreateProjectIncomingCallPolicyEscalationRule,
+        title: "Create Incoming Call Policy Escalation Rule",
+        description:
+          "This permission can create incoming call policy escalation rules for this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+      {
+        permission: Permission.DeleteProjectIncomingCallPolicyEscalationRule,
+        title: "Delete Incoming Call Policy Escalation Rule",
+        description:
+          "This permission can delete incoming call policy escalation rules of this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+      {
+        permission: Permission.EditProjectIncomingCallPolicyEscalationRule,
+        title: "Edit Incoming Call Policy Escalation Rule",
+        description:
+          "This permission can edit incoming call policy escalation rules of this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+      {
+        permission: Permission.ReadProjectIncomingCallPolicyEscalationRule,
+        title: "Read Incoming Call Policy Escalation Rule",
+        description:
+          "This permission can read incoming call policy escalation rules of this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+
+      // Incoming Call Log Permissions
+      {
+        permission: Permission.ReadProjectIncomingCallLog,
+        title: "Read Incoming Call Log",
+        description:
+          "This permission can read incoming call logs of this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+
+      // Incoming Call Log Item Permissions
+      {
+        permission: Permission.ReadProjectIncomingCallLogItem,
+        title: "Read Incoming Call Log Item",
+        description:
+          "This permission can read incoming call log items of this project.",
+        isAssignableToTenant: true,
+        isAccessControlPermission: false,
+      },
+
       {
         permission:
           Permission.CreateProjectOnCallDutyPolicyEscalationRuleSchedule,

package/Types/Phone.ts

@@ -13,7 +13,7 @@ export default class Phone extends DatabaseProperty {
   public static pickPhoneNumberToSendSMSOrCallFrom(data: {
     to: Phone | string;
     primaryPhoneNumberToPickFrom: Phone | string;
-    seocndaryPhoneNumbersToPickFrom: Phone[] | string[];
+    secondaryPhoneNumbersToPickFrom: Phone[] | string[];
   }): Phone {
     /*
      * convert all to string, so that we can compare them
@@ -28,8 +28,8 @@ export default class Phone extends DatabaseProperty {
         ? data.primaryPhoneNumberToPickFrom
         : data.primaryPhoneNumberToPickFrom.toString();
 
-    const seocndaryPhoneNumbersToPickFrom: string[] =
-      data.seocndaryPhoneNumbersToPickFrom.map((phone: Phone | string) => {
+    const secondaryPhoneNumbersToPickFrom: string[] =
+      data.secondaryPhoneNumbersToPickFrom.map((phone: Phone | string) => {
         return typeof phone === "string" ? phone : phone.toString();
       });
 
@@ -51,7 +51,7 @@ export default class Phone extends DatabaseProperty {
       return new Phone(primaryPhoneNumberToPickFrom);
     }
 
-    for (const secondaryPhoneNumber of seocndaryPhoneNumbersToPickFrom) {
+    for (const secondaryPhoneNumber of secondaryPhoneNumbersToPickFrom) {
       const secondaryPhoneNumberCountryCode: string = normalizePhoneNumber(
         secondaryPhoneNumber,
       ).substring(0, 2);
@@ -148,4 +148,53 @@ export default class Phone extends DatabaseProperty {
       example: { _type: ObjectType.Phone, value: "+1-555-123-4567" },
     });
   }
+
+  // Map of calling code prefixes to ISO country codes
+  private static readonly CALLING_CODE_TO_COUNTRY_MAP: Record<string, string> =
+    {
+      "+1": "US", // US and Canada
+      "+44": "GB", // United Kingdom
+      "+61": "AU", // Australia
+      "+49": "DE", // Germany
+      "+33": "FR", // France
+      "+91": "IN", // India
+      "+81": "JP", // Japan
+      "+86": "CN", // China
+      "+55": "BR", // Brazil
+      "+52": "MX", // Mexico
+    };
+
+  /**
+   * Extract ISO country code from a phone number
+   * @param phoneNumber - The phone number (e.g., "+15551234567")
+   * @returns ISO country code (e.g., "US") or "US" as default
+   */
+  public static getCountryCodeFromPhoneNumber(phoneNumber: string): string {
+    for (const [prefix, countryCode] of Object.entries(
+      Phone.CALLING_CODE_TO_COUNTRY_MAP,
+    )) {
+      if (phoneNumber.startsWith(prefix)) {
+        return countryCode;
+      }
+    }
+    return "US"; // Default to US if unknown
+  }
+
+  /**
+   * Extract area code from a phone number
+   * Currently only supports US/Canada (+1) numbers
+   * @param phoneNumber - The phone number (e.g., "+15551234567")
+   * @returns Area code (e.g., "555") or empty string for non-US/CA numbers
+   */
+  public static getAreaCodeFromPhoneNumber(phoneNumber: string): string {
+    // For US/Canada numbers (+1), extract the next 3 digits
+    if (phoneNumber.startsWith("+1")) {
+      const number: string = phoneNumber.substring(2);
+      if (number.length >= 3) {
+        return number.substring(0, 3);
+      }
+    }
+    // For other countries, area code extraction is more complex
+    return "";
+  }
 }

package/Types/SCIM/SCIMLogStatus.ts

@@ -0,0 +1,7 @@
+enum SCIMLogStatus {
+  Success = "Success",
+  Error = "Error",
+  Warning = "Warning",
+}
+
+export default SCIMLogStatus;