@oneuptime/common 10.0.66 → 10.0.68

package/Models/AnalyticsModels/AuditLog.ts

@@ -0,0 +1,370 @@
+import AnalyticsBaseModel from "./AnalyticsBaseModel/AnalyticsBaseModel";
+import Route from "../../Types/API/Route";
+import AnalyticsTableEngine from "../../Types/AnalyticsDatabase/AnalyticsTableEngine";
+import AnalyticsTableName from "../../Types/AnalyticsDatabase/AnalyticsTableName";
+import AnalyticsTableColumn from "../../Types/AnalyticsDatabase/TableColumn";
+import TableColumnType from "../../Types/AnalyticsDatabase/TableColumnType";
+import { JSONArray } from "../../Types/JSON";
+import ObjectID from "../../Types/ObjectID";
+import Permission from "../../Types/Permission";
+import { PlanType } from "../../Types/Billing/SubscriptionPlan";
+
+export default class AuditLog extends AnalyticsBaseModel {
+  public constructor() {
+    const projectIdColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "projectId",
+      title: "Project ID",
+      description: "ID of the project this audit log belongs to.",
+      required: true,
+      type: TableColumnType.ObjectID,
+      isTenantId: true,
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const resourceTypeColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "resourceType",
+      title: "Resource Type",
+      description:
+        "Type of the resource that was changed (e.g. Incident, Monitor).",
+      required: true,
+      type: TableColumnType.Text,
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const resourceIdColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "resourceId",
+      title: "Resource ID",
+      description: "ID of the resource that was changed.",
+      required: true,
+      type: TableColumnType.ObjectID,
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const resourceNameColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "resourceName",
+      title: "Resource Name",
+      description: "Display name of the resource at the time of the change.",
+      required: false,
+      type: TableColumnType.Text,
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const actionColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "action",
+      title: "Action",
+      description: "The action performed: Create, Update, or Delete.",
+      required: true,
+      type: TableColumnType.Text,
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const userIdColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "userId",
+      title: "User ID",
+      description: "ID of the user who performed the action, if any.",
+      required: false,
+      type: TableColumnType.ObjectID,
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const userNameColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "userName",
+      title: "User Name",
+      description: "Display name of the user at the time of the action.",
+      required: false,
+      type: TableColumnType.Text,
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const userEmailColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "userEmail",
+      title: "User Email",
+      description: "Email of the user at the time of the action.",
+      required: false,
+      type: TableColumnType.Text,
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const userTypeColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "userType",
+      title: "User Type",
+      description:
+        "Type of actor: User, API, Automation, MasterAdmin, or System.",
+      required: false,
+      type: TableColumnType.Text,
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const apiKeyIdColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "apiKeyId",
+      title: "API Key ID",
+      description:
+        "ID of the API key used for this action, if performed via API.",
+      required: false,
+      type: TableColumnType.ObjectID,
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const apiKeyNameColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "apiKeyName",
+      title: "API Key Name",
+      description: "Display name of the API key at the time of the action.",
+      required: false,
+      type: TableColumnType.Text,
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const changesColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "changes",
+      title: "Changes",
+      description:
+        "Field-level changes for Update actions, or full snapshot for Create/Delete. Redacted fields are omitted.",
+      required: true,
+      defaultValue: [],
+      type: TableColumnType.JSONArray,
+      codec: { codec: "ZSTD", level: 3 },
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+      },
+    });
+
+    const retentionDateColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "retentionDate",
+      title: "Retention Date",
+      description:
+        "Date after which this row is eligible for TTL deletion, computed at ingest time as createdAt + project.auditLogsRetentionInDays.",
+      required: true,
+      type: TableColumnType.Date,
+      defaultValue: undefined,
+    });
+
+    super({
+      tableName: AnalyticsTableName.AuditLog,
+      tableEngine: AnalyticsTableEngine.MergeTree,
+      singularName: "Audit Log",
+      pluralName: "Audit Logs",
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ReadAuditLog,
+        ],
+        create: [Permission.ProjectOwner, Permission.ProjectAdmin],
+        update: [],
+        delete: [],
+      },
+      tableBillingAccessControl: {
+        create: PlanType.Enterprise,
+        read: PlanType.Enterprise,
+        update: PlanType.Enterprise,
+        delete: PlanType.Enterprise,
+      },
+      crudApiPath: new Route("/audit-log"),
+      tableColumns: [
+        projectIdColumn,
+        resourceTypeColumn,
+        resourceIdColumn,
+        resourceNameColumn,
+        actionColumn,
+        userIdColumn,
+        userNameColumn,
+        userEmailColumn,
+        userTypeColumn,
+        apiKeyIdColumn,
+        apiKeyNameColumn,
+        changesColumn,
+        retentionDateColumn,
+      ],
+      projections: [],
+      sortKeys: ["projectId", "createdAt", "resourceType", "resourceId"],
+      primaryKeys: ["projectId", "createdAt"],
+      partitionKey: "sipHash64(projectId) % 16",
+      ttlExpression: "retentionDate DELETE",
+    });
+  }
+
+  public get projectId(): ObjectID | undefined {
+    return this.getColumnValue("projectId") as ObjectID | undefined;
+  }
+  public set projectId(v: ObjectID | undefined) {
+    this.setColumnValue("projectId", v);
+  }
+
+  public get resourceType(): string | undefined {
+    return this.getColumnValue("resourceType") as string | undefined;
+  }
+  public set resourceType(v: string | undefined) {
+    this.setColumnValue("resourceType", v);
+  }
+
+  public get resourceId(): ObjectID | undefined {
+    return this.getColumnValue("resourceId") as ObjectID | undefined;
+  }
+  public set resourceId(v: ObjectID | undefined) {
+    this.setColumnValue("resourceId", v);
+  }
+
+  public get resourceName(): string | undefined {
+    return this.getColumnValue("resourceName") as string | undefined;
+  }
+  public set resourceName(v: string | undefined) {
+    this.setColumnValue("resourceName", v);
+  }
+
+  public get action(): string | undefined {
+    return this.getColumnValue("action") as string | undefined;
+  }
+  public set action(v: string | undefined) {
+    this.setColumnValue("action", v);
+  }
+
+  public get userId(): ObjectID | undefined {
+    return this.getColumnValue("userId") as ObjectID | undefined;
+  }
+  public set userId(v: ObjectID | undefined) {
+    this.setColumnValue("userId", v);
+  }
+
+  public get userName(): string | undefined {
+    return this.getColumnValue("userName") as string | undefined;
+  }
+  public set userName(v: string | undefined) {
+    this.setColumnValue("userName", v);
+  }
+
+  public get userEmail(): string | undefined {
+    return this.getColumnValue("userEmail") as string | undefined;
+  }
+  public set userEmail(v: string | undefined) {
+    this.setColumnValue("userEmail", v);
+  }
+
+  public get userType(): string | undefined {
+    return this.getColumnValue("userType") as string | undefined;
+  }
+  public set userType(v: string | undefined) {
+    this.setColumnValue("userType", v);
+  }
+
+  public get apiKeyId(): ObjectID | undefined {
+    return this.getColumnValue("apiKeyId") as ObjectID | undefined;
+  }
+  public set apiKeyId(v: ObjectID | undefined) {
+    this.setColumnValue("apiKeyId", v);
+  }
+
+  public get apiKeyName(): string | undefined {
+    return this.getColumnValue("apiKeyName") as string | undefined;
+  }
+  public set apiKeyName(v: string | undefined) {
+    this.setColumnValue("apiKeyName", v);
+  }
+
+  public get changes(): JSONArray | undefined {
+    return this.getColumnValue("changes") as JSONArray | undefined;
+  }
+  public set changes(v: JSONArray | undefined) {
+    this.setColumnValue("changes", v);
+  }
+
+  public get retentionDate(): Date | undefined {
+    return this.getColumnValue("retentionDate") as Date | undefined;
+  }
+  public set retentionDate(v: Date | undefined) {
+    this.setColumnValue("retentionDate", v);
+  }
+}

package/Models/DatabaseModels/Alert.ts

@@ -18,6 +18,7 @@ import ColumnType from "../../Types/Database/ColumnType";
 import CrudApiEndpoint from "../../Types/Database/CrudApiEndpoint";
 import EnableDocumentation from "../../Types/Database/EnableDocumentation";
 import EnableMCP from "../../Types/Database/EnableMCP";
+import EnableAuditLog from "../../Types/Database/EnableAuditLog";
 import EnableWorkflow from "../../Types/Database/EnableWorkflow";
 import MultiTenentQueryAllowed from "../../Types/Database/MultiTenentQueryAllowed";
 import TableColumn from "../../Types/Database/TableColumn";
@@ -87,6 +88,7 @@ import NotificationRuleWorkspaceChannel from "../../Types/Workspace/Notification
   update: true,
   read: true,
 })
+@EnableAuditLog()
 @TableMetadata({
   tableName: "Alert",
   singularName: "Alert",

package/Models/DatabaseModels/ApiKey.ts

@@ -9,6 +9,7 @@ import TableBillingAccessControl from "../../Types/Database/AccessControl/TableB
 import ColumnLength from "../../Types/Database/ColumnLength";
 import ColumnType from "../../Types/Database/ColumnType";
 import CrudApiEndpoint from "../../Types/Database/CrudApiEndpoint";
+import EnableAuditLog from "../../Types/Database/EnableAuditLog";
 import EnableDocumentation from "../../Types/Database/EnableDocumentation";
 import SlugifyColumn from "../../Types/Database/SlugifyColumn";
 import TableColumn from "../../Types/Database/TableColumn";
@@ -57,6 +58,7 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
     Permission.EditProjectApiKey,
   ],
 })
+@EnableAuditLog()
 @TableMetadata({
   tableName: "ApiKey",
   singularName: "API Key",

package/Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel.ts

@@ -2,6 +2,7 @@ import EnableRealtimeEventsOn from "../../../Types/Realtime/EnableRealtimeEvents
 import Route from "../../../Types/API/Route";
 import { ColumnAccessControl } from "../../../Types/BaseDatabase/AccessControl";
 import ColumnBillingAccessControl from "../../../Types/BaseDatabase/ColumnBillingAccessControl";
+import EnableAuditLogOn from "../../../Types/BaseDatabase/EnableAuditLogOn";
 import EnableWorkflowOn from "../../../Types/BaseDatabase/EnableWorkflowOn";
 import ModelPermission from "../../../Types/BaseDatabase/ModelPermission";
 import { PlanType } from "../../../Types/Billing/SubscriptionPlan";
@@ -121,6 +122,8 @@ export default class DatabaseBaseModel extends BaseEntity {
 
   public enableWorkflowOn!: EnableWorkflowOn;
 
+  public enableAuditLogOn!: EnableAuditLogOn | undefined;
+
   public enableDocumentation!: boolean;
   public isMasterAdminApiDocs!: boolean;
 

package/Models/DatabaseModels/GlobalConfig.ts

@@ -502,6 +502,62 @@ export default class GlobalConfig extends GlobalConfigModel {
   })
   public metaWhatsAppWebhookVerifyToken?: string = undefined;
 
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.VeryLongText,
+    title: "Telegram Bot Token",
+    description:
+      "Bot token issued by @BotFather for sending Telegram messages.",
+  })
+  @Column({
+    type: ColumnType.VeryLongText,
+    nullable: true,
+    unique: true,
+  })
+  public telegramBotToken?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    title: "Telegram Bot Username",
+    description:
+      "Username of your OneUptime Telegram bot (without the leading @). Used to build verification deep links.",
+  })
+  @Column({
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+    nullable: true,
+    unique: true,
+  })
+  public telegramBotUsername?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    title: "Telegram Webhook Secret Token",
+    description:
+      "Secret token passed to Telegram setWebhook. Telegram sends it back in the X-Telegram-Bot-Api-Secret-Token header.",
+  })
+  @Column({
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+    nullable: true,
+    unique: true,
+  })
+  public telegramWebhookSecretToken?: string = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [],

package/Models/DatabaseModels/Incident.ts

@@ -19,6 +19,7 @@ import ColumnType from "../../Types/Database/ColumnType";
 import CrudApiEndpoint from "../../Types/Database/CrudApiEndpoint";
 import EnableDocumentation from "../../Types/Database/EnableDocumentation";
 import EnableMCP from "../../Types/Database/EnableMCP";
+import EnableAuditLog from "../../Types/Database/EnableAuditLog";
 import EnableWorkflow from "../../Types/Database/EnableWorkflow";
 import MultiTenentQueryAllowed from "../../Types/Database/MultiTenentQueryAllowed";
 import SlugifyColumn from "../../Types/Database/SlugifyColumn";
@@ -91,6 +92,7 @@ import NotificationRuleWorkspaceChannel from "../../Types/Workspace/Notification
   update: true,
   read: true,
 })
+@EnableAuditLog()
 @TableMetadata({
   tableName: "Incident",
   singularName: "Incident",

package/Models/DatabaseModels/Index.ts

@@ -140,6 +140,7 @@ import ShortLink from "./ShortLink";
 // SMS
 import SmsLog from "./SmsLog";
 import WhatsAppLog from "./WhatsAppLog";
+import TelegramLog from "./TelegramLog";
 import PushNotificationLog from "./PushNotificationLog";
 import WorkspaceNotificationLog from "./WorkspaceNotificationLog";
 // Status Page
@@ -176,6 +177,7 @@ import UserCall from "./UserCall";
 import UserEmail from "./UserEmail";
 import UserPush from "./UserPush";
 import UserWhatsApp from "./UserWhatsApp";
+import UserTelegram from "./UserTelegram";
 // User Notification Rules
 import UserNotificationRule from "./UserNotificationRule";
 import UserNotificationSetting from "./UserNotificationSetting";
@@ -414,6 +416,7 @@ const AllModelTypes: Array<{
 
   SmsLog,
   WhatsAppLog,
+  TelegramLog,
   PushNotificationLog,
   WorkspaceNotificationLog,
   CallLog,
@@ -424,6 +427,7 @@ const AllModelTypes: Array<{
   UserCall,
   UserPush,
   UserWhatsApp,
+  UserTelegram,
   UserIncomingCallNumber,
 
   UserNotificationRule,

package/Models/DatabaseModels/Label.ts

@@ -11,6 +11,7 @@ import ColumnLength from "../../Types/Database/ColumnLength";
 import ColumnType from "../../Types/Database/ColumnType";
 import CrudApiEndpoint from "../../Types/Database/CrudApiEndpoint";
 import EnableDocumentation from "../../Types/Database/EnableDocumentation";
+import EnableAuditLog from "../../Types/Database/EnableAuditLog";
 import EnableWorkflow from "../../Types/Database/EnableWorkflow";
 import ColorField from "../../Types/Database/ColorField";
 import SlugifyColumn from "../../Types/Database/SlugifyColumn";
@@ -64,6 +65,7 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
   update: true,
   read: true,
 })
+@EnableAuditLog()
 @CrudApiEndpoint(new Route("/label"))
 @SlugifyColumn("name", "slug")
 @TableMetadata({

package/Models/DatabaseModels/Monitor.ts

@@ -12,6 +12,7 @@ import ColumnType from "../../Types/Database/ColumnType";
 import CrudApiEndpoint from "../../Types/Database/CrudApiEndpoint";
 import EnableDocumentation from "../../Types/Database/EnableDocumentation";
 import EnableMCP from "../../Types/Database/EnableMCP";
+import EnableAuditLog from "../../Types/Database/EnableAuditLog";
 import EnableWorkflow from "../../Types/Database/EnableWorkflow";
 import SlugifyColumn from "../../Types/Database/SlugifyColumn";
 import TableColumn from "../../Types/Database/TableColumn";
@@ -80,6 +81,7 @@ import NotificationRuleWorkspaceChannel from "../../Types/Workspace/Notification
   update: true,
   read: true,
 })
+@EnableAuditLog()
 @CrudApiEndpoint(new Route("/monitor"))
 @SlugifyColumn("name", "slug")
 @Entity({

package/Models/DatabaseModels/OnCallDutyPolicy.ts

@@ -30,6 +30,7 @@ import {
   ManyToOne,
 } from "typeorm";
 import NotificationRuleWorkspaceChannel from "../../Types/Workspace/NotificationRules/NotificationRuleWorkspaceChannel";
+import EnableAuditLog from "../../Types/Database/EnableAuditLog";
 import EnableWorkflow from "../../Types/Database/EnableWorkflow";
 
 @EnableDocumentation()
@@ -42,6 +43,7 @@ import EnableWorkflow from "../../Types/Database/EnableWorkflow";
   update: true,
   read: true,
 })
+@EnableAuditLog()
 @TableAccessControl({
   create: [
     Permission.ProjectOwner,