@oneuptime/common 12.0.14 → 12.0.16

package/Models/DatabaseModels/IncidentMeasurementValue.ts

@@ -0,0 +1,501 @@
+import Incident from "./Incident";
+import MeasurementStatus from "../../Types/Measurement/MeasurementStatus";
+import IncidentMeasurement from "./IncidentMeasurement";
+import Project from "./Project";
+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 ColumnLength from "../../Types/Database/ColumnLength";
+import ColumnType from "../../Types/Database/ColumnType";
+import CrudApiEndpoint from "../../Types/Database/CrudApiEndpoint";
+import EnableDocumentation from "../../Types/Database/EnableDocumentation";
+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 IconProp from "../../Types/Icon/IconProp";
+import ObjectID from "../../Types/ObjectID";
+import Permission from "../../Types/Permission";
+import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
+
+@EnableDocumentation()
+@CanAccessIfCanReadOn("incident")
+@TenantColumn("projectId")
+@OwnedThrough("incidentId", Incident)
+@TableAccessControl({
+  /*
+   * Deliberately empty. A measurement value is observed, not declared: it is
+   * derived from the incident's own timeline and nothing else may write it.
+   * Leaving these empty is what makes the API surface read-only.
+   */
+  create: [],
+  read: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.Viewer,
+    Permission.IncidentAdmin,
+    Permission.IncidentMember,
+    Permission.IncidentViewer,
+    Permission.ReadIncidentMeasurementValue,
+  ],
+  delete: [],
+  update: [],
+})
+@CrudApiEndpoint(new Route("/incident-measurement-value"))
+@Entity({
+  name: "IncidentMeasurementValue",
+})
+@Index(["incidentId", "incidentMeasurementId"], { unique: true })
+@TableMetadata({
+  tableName: "IncidentMeasurementValue",
+  singularName: "Incident Measurement Value",
+  pluralName: "Incident Measurement Values",
+  icon: IconProp.Clock,
+  tableDescription:
+    "The computed value of one incident measurement for one incident, recomputed from the incident's timeline rather than accumulated",
+})
+export default class IncidentMeasurementValue extends BaseModel {
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "projectId",
+    computed: true,
+    type: TableColumnType.Entity,
+    modelType: Project,
+    title: "Project",
+    description: "Relation to Project Resource in which this object belongs",
+  })
+  @ManyToOne(
+    () => {
+      return Project;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "projectId" })
+  public project?: Project = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    computed: 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;
+
+  // Incident Relation
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "incidentId",
+    computed: true,
+    type: TableColumnType.Entity,
+    modelType: Incident,
+    title: "Incident",
+    description: "The incident this measurement value was computed for",
+  })
+  @ManyToOne(
+    () => {
+      return Incident;
+    },
+    {
+      eager: false,
+      nullable: false,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "incidentId" })
+  public incident?: Incident = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    computed: true,
+    canReadOnRelationQuery: true,
+    title: "Incident ID",
+    description: "ID of the incident this measurement value was computed for",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public incidentId?: ObjectID = undefined;
+
+  // Incident Measurement Relation
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "incidentMeasurementId",
+    computed: true,
+    type: TableColumnType.Entity,
+    modelType: IncidentMeasurement,
+    title: "Incident Measurement",
+    description: "The measurement definition this value was computed from",
+  })
+  @ManyToOne(
+    () => {
+      return IncidentMeasurement;
+    },
+    {
+      eager: false,
+      nullable: false,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "incidentMeasurementId" })
+  public incidentMeasurement?: IncidentMeasurement = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    computed: true,
+    canReadOnRelationQuery: true,
+    title: "Incident Measurement ID",
+    description:
+      "ID of the measurement definition this value was computed from",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public incidentMeasurementId?: ObjectID = undefined;
+
+  // Computed Result
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: false,
+    computed: true,
+    type: TableColumnType.Date,
+    title: "Started At",
+    description:
+      "When this measurement's start anchor resolved to. Blank while the start anchor has not resolved.",
+  })
+  @Column({
+    type: ColumnType.Date,
+    nullable: true,
+  })
+  public startedAt?: Date = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: false,
+    computed: true,
+    type: TableColumnType.Date,
+    title: "Ended At",
+    description:
+      "When this measurement's end anchor resolved to. Blank while the end anchor has not resolved.",
+  })
+  @Column({
+    type: ColumnType.Date,
+    nullable: true,
+  })
+  public endedAt?: Date = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    required: false,
+    computed: true,
+    type: TableColumnType.Number,
+    title: "Value (Seconds)",
+    description:
+      "The measured duration in seconds. Only set when the status is Recorded - a measurement that could not be computed is left blank rather than written as zero.",
+  })
+  @Column({
+    type: ColumnType.Number,
+    nullable: true,
+  })
+  public valueInSeconds?: number = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    required: true,
+    computed: true,
+    type: TableColumnType.ShortText,
+    title: "Status",
+    description:
+      "The outcome of evaluating this measurement: Recorded, Pending, Not Applicable or Invalid.",
+    defaultValue: "Pending",
+    isDefaultValueColumn: true,
+    example: "Recorded",
+  })
+  @Column({
+    nullable: false,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+    default: "Pending",
+  })
+  public status?: MeasurementStatus = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: false,
+    computed: true,
+    type: TableColumnType.LongText,
+    title: "Status Message",
+    description:
+      "Why this measurement has the status it has, in plain words - for example which anchor has not been reached yet, or by how much the end precedes the start.",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.LongText,
+    length: ColumnLength.LongText,
+  })
+  public statusMessage?: string = undefined;
+
+  // Provenance
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: false,
+    computed: true,
+    type: TableColumnType.ObjectID,
+    title: "Start Incident State Timeline ID",
+    description:
+      "The incident state timeline entry the start anchor resolved to. Recorded for provenance only - it carries no foreign key, so deleting a timeline entry never blocks or rewrites this row; the next recompute simply produces the right answer.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public startIncidentStateTimelineId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: false,
+    computed: true,
+    type: TableColumnType.ObjectID,
+    title: "End Incident State Timeline ID",
+    description:
+      "The incident state timeline entry the end anchor resolved to. Recorded for provenance only - it carries no foreign key, so deleting a timeline entry never blocks or rewrites this row; the next recompute simply produces the right answer.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public endIncidentStateTimelineId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentMeasurementValue,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: false,
+    computed: true,
+    type: TableColumnType.Date,
+    title: "Computed At",
+    description: "When this value was last recomputed",
+  })
+  @Column({
+    type: ColumnType.Date,
+    nullable: true,
+  })
+  public computedAt?: Date = undefined;
+}

package/Models/DatabaseModels/IncidentStateTimeline.ts

@@ -751,12 +751,20 @@ export default class IncidentStateTimeline extends BaseModel {
       Permission.IncidentViewer,
       Permission.ReadIncidentStateTimeline,
     ],
-    update: [],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.EditIncidentStateTimeline,
+    ],
   })
   @TableColumn({
     type: TableColumnType.Date,
     title: "Starts At",
-    description: "When did this status change?",
+    description:
+      "When did this status change? Correct this when the recorded time is wrong - every measurement derived from this timeline is recomputed from the corrected value.",
     example: "2024-01-15T13:15:00.000Z",
   })
   @Column({

package/Models/DatabaseModels/IncomingCallPolicyLabelRule.ts

@@ -40,6 +40,9 @@ import {
     Permission.ProjectAdmin,
     Permission.ProjectMember,
     Permission.Viewer,
+    Permission.OnCallAdmin,
+    Permission.OnCallMember,
+    Permission.OnCallViewer,
     Permission.ReadIncomingCallPolicyLabelRule,
   ],
   delete: [
@@ -83,6 +86,9 @@ export default class IncomingCallPolicyLabelRule extends BaseModel {
       Permission.ProjectAdmin,
       Permission.ProjectMember,
       Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
       Permission.ReadIncomingCallPolicyLabelRule,
     ],
     update: [],
@@ -119,6 +125,9 @@ export default class IncomingCallPolicyLabelRule extends BaseModel {
       Permission.ProjectAdmin,
       Permission.ProjectMember,
       Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
       Permission.ReadIncomingCallPolicyLabelRule,
     ],
     update: [],
@@ -149,6 +158,9 @@ export default class IncomingCallPolicyLabelRule extends BaseModel {
       Permission.ProjectAdmin,
       Permission.ProjectMember,
       Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
       Permission.ReadIncomingCallPolicyLabelRule,
     ],
     update: [
@@ -183,6 +195,9 @@ export default class IncomingCallPolicyLabelRule extends BaseModel {
       Permission.ProjectAdmin,
       Permission.ProjectMember,
       Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
       Permission.ReadIncomingCallPolicyLabelRule,
     ],
     update: [
@@ -215,6 +230,9 @@ export default class IncomingCallPolicyLabelRule extends BaseModel {
       Permission.ProjectAdmin,
       Permission.ProjectMember,
       Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
       Permission.ReadIncomingCallPolicyLabelRule,
     ],
     update: [
@@ -250,6 +268,9 @@ export default class IncomingCallPolicyLabelRule extends BaseModel {
       Permission.ProjectAdmin,
       Permission.ProjectMember,
       Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
       Permission.ReadIncomingCallPolicyLabelRule,
     ],
     update: [
@@ -296,6 +317,9 @@ export default class IncomingCallPolicyLabelRule extends BaseModel {
       Permission.ProjectAdmin,
       Permission.ProjectMember,
       Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
       Permission.ReadIncomingCallPolicyLabelRule,
     ],
     update: [
@@ -329,6 +353,9 @@ export default class IncomingCallPolicyLabelRule extends BaseModel {
       Permission.ProjectAdmin,
       Permission.ProjectMember,
       Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
       Permission.ReadIncomingCallPolicyLabelRule,
     ],
     update: [
@@ -362,6 +389,9 @@ export default class IncomingCallPolicyLabelRule extends BaseModel {
       Permission.ProjectAdmin,
       Permission.ProjectMember,
       Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
       Permission.ReadIncomingCallPolicyLabelRule,
     ],
     update: [
@@ -408,6 +438,9 @@ export default class IncomingCallPolicyLabelRule extends BaseModel {
       Permission.ProjectAdmin,
       Permission.ProjectMember,
       Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
       Permission.ReadIncomingCallPolicyLabelRule,
     ],
     update: [],
@@ -445,6 +478,9 @@ export default class IncomingCallPolicyLabelRule extends BaseModel {
       Permission.ProjectAdmin,
       Permission.ProjectMember,
       Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
       Permission.ReadIncomingCallPolicyLabelRule,
     ],
     update: [],