@oneuptime/common 14.0.2 → 14.0.5

package/Models/DatabaseModels/IncidentAlert.ts

@@ -0,0 +1,540 @@
+import Alert from "./Alert";
+import Incident from "./Incident";
+import Project from "./Project";
+import User from "./User";
+import BaseModel from "./DatabaseBaseModel/DatabaseBaseModel";
+import Route from "../../Types/API/Route";
+import ColumnAccessControl from "../../Types/Database/AccessControl/ColumnAccessControl";
+import OwnedThrough from "../../Types/Database/AccessControl/OwnedThrough";
+import TableAccessControl from "../../Types/Database/AccessControl/TableAccessControl";
+import CanAccessIfCanReadOn from "../../Types/Database/CanAccessIfCanReadOn";
+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 EnableWorkflow from "../../Types/Database/EnableWorkflow";
+import TableColumn from "../../Types/Database/TableColumn";
+import TableColumnType from "../../Types/Database/TableColumnType";
+import TableMetadata from "../../Types/Database/TableMetadata";
+import TenantColumn from "../../Types/Database/TenantColumn";
+import UniqueColumnsTogether from "../../Types/Database/UniqueColumnsTogether";
+import IconProp from "../../Types/Icon/IconProp";
+import { INCIDENT_ALERT_ALREADY_LINKED_MESSAGE } from "../../Types/Incident/IncidentAlertLink";
+import ObjectID from "../../Types/ObjectID";
+import Permission from "../../Types/Permission";
+import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
+
+/*
+ * Links an alert to an incident (many-to-many): one incident can carry any
+ * number of alerts, and one alert can be linked to more than one incident.
+ * Linking is how responders say "these alerts are part of this incident" -
+ * either by linking alerts to an incident that is already open, or by
+ * declaring a new incident from the alerts, which links them as it is created.
+ *
+ * The link belongs to the incident: its read scope follows the incident's
+ * labels (CanAccessIfCanReadOn) and owners (OwnedThrough). Alert roles are
+ * listed next to incident roles so a responder who works alerts can see which
+ * incidents their alerts are linked to, and link them too when they can also
+ * read incidents: the service only creates a link when the caller can read
+ * both the alert and the incident.
+ *
+ * Rows are immutable - a link is created or removed, never edited - so every
+ * column has an empty update list. The table keeps its update permissions
+ * anyway so generated clients (Terraform) treat both ids as replace-on-change
+ * instead of silently ignoring an edit.
+ */
+@EnableDocumentation()
+@EnableMCP()
+@CanAccessIfCanReadOn("incident")
+@TenantColumn("projectId")
+@TableAccessControl({
+  create: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.IncidentAdmin,
+    Permission.IncidentMember,
+    Permission.AlertAdmin,
+    Permission.AlertMember,
+    Permission.CreateIncidentAlert,
+  ],
+  read: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.Viewer,
+    Permission.IncidentAdmin,
+    Permission.IncidentMember,
+    Permission.IncidentViewer,
+    Permission.AlertAdmin,
+    Permission.AlertMember,
+    Permission.AlertViewer,
+    Permission.ReadIncidentAlert,
+  ],
+  delete: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.IncidentAdmin,
+    Permission.IncidentMember,
+    Permission.AlertAdmin,
+    Permission.AlertMember,
+    Permission.DeleteIncidentAlert,
+  ],
+  update: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.IncidentAdmin,
+    Permission.IncidentMember,
+    Permission.AlertAdmin,
+    Permission.AlertMember,
+    Permission.EditIncidentAlert,
+  ],
+})
+@EnableWorkflow({
+  create: true,
+  delete: true,
+  update: true,
+  read: true,
+})
+@CrudApiEndpoint(new Route("/incident-alert"))
+@TableMetadata({
+  tableName: "IncidentAlert",
+  singularName: "Incident Alert",
+  pluralName: "Incident Alerts",
+  icon: IconProp.Link,
+  tableDescription:
+    "Alerts linked to an incident. Link alerts to an incident to track them as part of that incident's response.",
+})
+@OwnedThrough("incidentId", Incident)
+@Entity({
+  name: "IncidentAlert",
+})
+@Index(["incidentId", "alertId", "projectId"], { unique: true })
+@UniqueColumnsTogether(
+  ["incidentId", "alertId", "projectId"],
+  INCIDENT_ALERT_ALREADY_LINKED_MESSAGE,
+)
+export default class IncidentAlert extends BaseModel {
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.CreateIncidentAlert,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.AlertViewer,
+      Permission.ReadIncidentAlert,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "projectId",
+    type: TableColumnType.Entity,
+    modelType: Project,
+    title: "Project",
+    description: "Relation to Project Resource in which this object belongs",
+  })
+  @ManyToOne(
+    () => {
+      return Project;
+    },
+    {
+      eager: false,
+      nullable: false,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "projectId" })
+  public project?: Project = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.CreateIncidentAlert,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.AlertViewer,
+      Permission.ReadIncidentAlert,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    canReadOnRelationQuery: true,
+    title: "Project ID",
+    description: "ID of your OneUptime Project in which this object belongs",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public projectId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.CreateIncidentAlert,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.AlertViewer,
+      Permission.ReadIncidentAlert,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "incidentId",
+    type: TableColumnType.Entity,
+    modelType: Incident,
+    title: "Incident",
+    description: "Relation to the Incident this alert is linked to",
+  })
+  @ManyToOne(
+    () => {
+      return Incident;
+    },
+    {
+      eager: false,
+      nullable: false,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "incidentId" })
+  public incident?: Incident = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.CreateIncidentAlert,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.AlertViewer,
+      Permission.ReadIncidentAlert,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    canReadOnRelationQuery: true,
+    title: "Incident ID",
+    description: "ID of the Incident this alert is linked to",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public incidentId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.CreateIncidentAlert,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.AlertViewer,
+      Permission.ReadIncidentAlert,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "alertId",
+    type: TableColumnType.Entity,
+    modelType: Alert,
+    title: "Alert",
+    description: "Relation to the Alert that is linked to the incident",
+  })
+  @ManyToOne(
+    () => {
+      return Alert;
+    },
+    {
+      eager: false,
+      nullable: false,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "alertId" })
+  public alert?: Alert = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.CreateIncidentAlert,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.AlertViewer,
+      Permission.ReadIncidentAlert,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    canReadOnRelationQuery: true,
+    title: "Alert ID",
+    description: "ID of the Alert that is linked to the incident",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public alertId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.CreateIncidentAlert,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.AlertViewer,
+      Permission.ReadIncidentAlert,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "createdByUserId",
+    type: TableColumnType.Entity,
+    modelType: User,
+    title: "Linked by User",
+    description:
+      "Relation to User who linked the alert to the incident (if it was linked by a User)",
+  })
+  @ManyToOne(
+    () => {
+      return User;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "createdByUserId" })
+  public createdByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.CreateIncidentAlert,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.AlertViewer,
+      Permission.ReadIncidentAlert,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Linked by User ID",
+    description:
+      "ID of the User who linked the alert to the incident (if it was linked by a User)",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public createdByUserId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.AlertViewer,
+      Permission.ReadIncidentAlert,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "deletedByUserId",
+    type: TableColumnType.Entity,
+    modelType: User,
+    title: "Deleted by User",
+    description:
+      "Relation to User who deleted this object (if this object was deleted by a User)",
+  })
+  @ManyToOne(
+    () => {
+      return User;
+    },
+    {
+      cascade: false,
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "deletedByUserId" })
+  public deletedByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.AlertViewer,
+      Permission.ReadIncidentAlert,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Deleted by User ID",
+    description:
+      "User ID who deleted this object (if this object was deleted by a User)",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public deletedByUserId?: ObjectID = undefined;
+}

package/Models/DatabaseModels/IncidentFeed.ts

@@ -41,6 +41,8 @@ export enum IncidentFeedEventType {
   OnCallNotification = "OnCallNotification",
   IncidentMemberAdded = "IncidentMemberAdded",
   IncidentMemberRemoved = "IncidentMemberRemoved",
+  AlertLinked = "AlertLinked",
+  AlertUnlinked = "AlertUnlinked",
   LabelRuleExecuted = "LabelRuleExecuted",
   OwnerRuleExecuted = "OwnerRuleExecuted",
   PrivacyRuleExecuted = "PrivacyRuleExecuted",

package/Models/DatabaseModels/Index.ts

@@ -69,6 +69,13 @@ import CloudResourceOwnerTeam from "./CloudResourceOwnerTeam";
 import CloudResourceOwnerUser from "./CloudResourceOwnerUser";
 import CloudResourceLabelRule from "./CloudResourceLabelRule";
 import CloudResourceOwnerRule from "./CloudResourceOwnerRule";
+import DatabaseServer from "./DatabaseServer";
+import DatabaseServerEndpoint from "./DatabaseServerEndpoint";
+import DatabaseServerFeed from "./DatabaseServerFeed";
+import DatabaseServerOwnerTeam from "./DatabaseServerOwnerTeam";
+import DatabaseServerOwnerUser from "./DatabaseServerOwnerUser";
+import DatabaseServerLabelRule from "./DatabaseServerLabelRule";
+import DatabaseServerOwnerRule from "./DatabaseServerOwnerRule";
 import RumApplication from "./RumApplication";
 import RumApplicationOwnerTeam from "./RumApplicationOwnerTeam";
 import RumApplicationOwnerUser from "./RumApplicationOwnerUser";
@@ -291,6 +298,7 @@ import TeamComplianceSetting from "./TeamComplianceSetting";
 import UsageBilling from "./TelemetryUsageBilling";
 import User from "./User";
 import UserSession from "./UserSession";
+import UserProjectSsoConsent from "./UserProjectSsoConsent";
 import UserCall from "./UserCall";
 // Notification Methods
 import UserEmail from "./UserEmail";
@@ -376,6 +384,7 @@ import AlertEpisodeLabelRule from "./AlertEpisodeLabelRule";
 
 import IncidentEpisode from "./IncidentEpisode";
 import IncidentEpisodeMember from "./IncidentEpisodeMember";
+import IncidentAlert from "./IncidentAlert";
 import IncidentEpisodeRoleMember from "./IncidentEpisodeRoleMember";
 import IncidentEpisodeStateTimeline from "./IncidentEpisodeStateTimeline";
 import IncidentEpisodeOwnerUser from "./IncidentEpisodeOwnerUser";
@@ -592,6 +601,7 @@ const AllModelTypes: Array<{
 
   IncidentEpisode,
   IncidentEpisodeMember,
+  IncidentAlert,
   IncidentEpisodeRoleMember,
   IncidentEpisodeStateTimeline,
   IncidentEpisodeOwnerUser,
@@ -850,6 +860,7 @@ const AllModelTypes: Array<{
   DataSource,
 
   UserSession,
+  UserProjectSsoConsent,
   UserTotpAuth,
   UserTwoFactorBackupCode,
   UserWebAuthn,
@@ -965,6 +976,13 @@ const AllModelTypes: Array<{
   CloudResourceOwnerUser,
   CloudResourceLabelRule,
   CloudResourceOwnerRule,
+  DatabaseServer,
+  DatabaseServerEndpoint,
+  DatabaseServerFeed,
+  DatabaseServerOwnerTeam,
+  DatabaseServerOwnerUser,
+  DatabaseServerLabelRule,
+  DatabaseServerOwnerRule,
   RumApplication,
   RumApplicationOwnerTeam,
   RumApplicationOwnerUser,

package/Models/DatabaseModels/NetworkDeviceDiscoveryScan.ts

@@ -13,6 +13,10 @@ import TableColumn from "../../Types/Database/TableColumn";
 import TableColumnType from "../../Types/Database/TableColumnType";
 import TableMetadata from "../../Types/Database/TableMetadata";
 import TenantColumn from "../../Types/Database/TenantColumn";
+import {
+  DiscoveredHostNetbiosStatus,
+  DiscoveredHostReverseDnsStatus,
+} from "../../Types/NetworkDevice/DiscoveredHostNamingStatus";
 import IconProp from "../../Types/Icon/IconProp";
 import ObjectID from "../../Types/ObjectID";
 import Permission from "../../Types/Permission";
@@ -71,6 +75,28 @@ export interface DiscoveredNetworkDevice {
    * it without NetbiosNameUtil.normalizeNetbiosName.
    */
   netbiosName?: string | undefined;
+  /*
+   * Why reverse DNS left this host without a name, when it did (OneUptime
+   * issue #3916) — no PTR record, a DNS server that timed out or failed, a
+   * lookup the pass never reached. Stamped by the probe only on hosts that
+   * ended the reverse-DNS pass with neither a sysName nor a dnsHostname, and
+   * absent everywhere else: on named hosts, on rows stored before this field
+   * existed, and on rows from an older probe.
+   *
+   * Stored verbatim like everything in this column, so read it only through
+   * readDiscoveredHostReverseDnsStatus — normalizeDiscoveredHosts does, and
+   * deletes anything that is not one of the codes.
+   */
+  dnsHostnameStatus?: DiscoveredHostReverseDnsStatus | undefined;
+  /*
+   * Why NetBIOS left this host without a name (issue #3916): no reply on UDP
+   * 137, a reply with no usable name, or a host the lookup never queried and
+   * why. Stamped only on scans that asked for NetBIOS names, and only on hosts
+   * the lookup was responsible for — those still unnamed after SNMP and
+   * reverse DNS — that it did not name. Read only through
+   * readDiscoveredHostNetbiosStatus, for the reason dnsHostnameStatus is.
+   */
+  netbiosNameStatus?: DiscoveredHostNetbiosStatus | undefined;
   isAlreadyRegistered?: boolean | undefined;
   /*
    * False when the host answered ping but not SNMP — such hosts cannot be