@oneuptime/common 11.4.1 → 11.5.0

package/Models/DatabaseModels/AIRun.ts

@@ -334,6 +334,56 @@ export default class AIRun extends BaseModel {
   })
   public triggeredByAlertId?: ObjectID = undefined;
 
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: false,
+    canReadOnRelationQuery: true,
+    title: "Monitor ID",
+    description:
+      "The monitor behind the alert that triggered this run — the dedupe key for per-monitor investigation windows.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public monitorId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: true,
+    type: TableColumnType.Number,
+    title: "Attempt Count",
+    description:
+      "How many times a worker has claimed this run for execution. Incremented on each claim; the queue stops retrying after the maximum.",
+    isDefaultValueColumn: true,
+    defaultValue: 0,
+  })
+  @Column({
+    nullable: false,
+    default: 0,
+    type: ColumnType.Number,
+  })
+  public attemptCount?: number = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [

package/Models/DatabaseModels/AlertSeverity.ts

@@ -477,6 +477,12 @@ export default class AlertSeverity extends BaseModel {
     type: TableColumnType.SmallNumber,
     title: "Order",
     description: "Order / Priority of this resource",
+    /*
+     * Readable on relation queries like its name/color siblings —
+     * severity ranking (lower = more severe) is needed wherever a related
+     * alert's severity is selected (e.g. the Service Map overlay).
+     */
+    canReadOnRelationQuery: true,
   })
   @Column({
     type: ColumnType.SmallNumber,

package/Models/DatabaseModels/IncidentSeverity.ts

@@ -477,6 +477,12 @@ export default class IncidentSeverity extends BaseModel {
     type: TableColumnType.SmallNumber,
     title: "Order",
     description: "Order / Priority of this resource",
+    /*
+     * Readable on relation queries like its name/color siblings —
+     * severity ranking (lower = more severe) is needed wherever a related
+     * incident's severity is selected (e.g. the Service Map overlay).
+     */
+    canReadOnRelationQuery: true,
   })
   @Column({
     type: ColumnType.SmallNumber,

package/Models/DatabaseModels/Index.ts

@@ -6,6 +6,13 @@ import KubernetesClusterOwnerUser from "./KubernetesClusterOwnerUser";
 import KubernetesResource from "./KubernetesResource";
 import KubernetesContainer from "./KubernetesContainer";
 import DockerHost from "./DockerHost";
+import NetworkDevice from "./NetworkDevice";
+import NetworkDeviceOwnerTeam from "./NetworkDeviceOwnerTeam";
+import NetworkDeviceOwnerUser from "./NetworkDeviceOwnerUser";
+import NetworkDeviceOwnerRule from "./NetworkDeviceOwnerRule";
+import NetworkDeviceLabelRule from "./NetworkDeviceLabelRule";
+import NetworkDeviceDiscoveryScan from "./NetworkDeviceDiscoveryScan";
+import NetworkInterface from "./NetworkInterface";
 import DockerHostOwnerTeam from "./DockerHostOwnerTeam";
 import DockerHostOwnerUser from "./DockerHostOwnerUser";
 import DockerResource from "./DockerResource";
@@ -25,6 +32,7 @@ import IoTFleet from "./IoTFleet";
 import IoTFleetOwnerTeam from "./IoTFleetOwnerTeam";
 import IoTFleetOwnerUser from "./IoTFleetOwnerUser";
 import IoTDevice from "./IoTDevice";
+import IoTDeviceCredential from "./IoTDeviceCredential";
 import CephCluster from "./CephCluster";
 import CephClusterOwnerTeam from "./CephClusterOwnerTeam";
 import CephClusterOwnerUser from "./CephClusterOwnerUser";
@@ -768,6 +776,13 @@ const AllModelTypes: Array<{
   KubernetesResource,
   KubernetesContainer,
   DockerHost,
+  NetworkDevice,
+  NetworkDeviceOwnerTeam,
+  NetworkDeviceOwnerUser,
+  NetworkDeviceOwnerRule,
+  NetworkDeviceLabelRule,
+  NetworkDeviceDiscoveryScan,
+  NetworkInterface,
   DockerHostOwnerTeam,
   DockerHostOwnerUser,
   DockerResource,
@@ -787,6 +802,7 @@ const AllModelTypes: Array<{
   IoTFleetOwnerTeam,
   IoTFleetOwnerUser,
   IoTDevice,
+  IoTDeviceCredential,
   CephCluster,
   CephClusterOwnerTeam,
   CephClusterOwnerUser,

package/Models/DatabaseModels/IoTDeviceCredential.ts

@@ -0,0 +1,471 @@
+import IoTFleet from "./IoTFleet";
+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 TableAccessControl from "../../Types/Database/AccessControl/TableAccessControl";
+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";
+
+/*
+ * IoT device registry + per-device MQTT credential.
+ *
+ * Registering a device does two things:
+ *
+ *   1. Issues a PER-DEVICE credential (secretKey) the device presents
+ *      on MQTT CONNECT (username = this row's id, password = the
+ *      secret). Device-authenticated clients can only publish to
+ *      their own oneuptime/<fleet>/<device>/... topics, and a single
+ *      compromised device can be revoked (isEnabled=false) without
+ *      rotating the project-wide ingestion key.
+ *
+ *   2. Marks the device as EXPECTED: registered devices survive the
+ *      stale-inventory cleanup (flipped to Down instead of deleted),
+ *      and IoT Device monitors inject an absent series for registered
+ *      devices that stop reporting — silent deaths alert per device.
+ *
+ * This is distinct from IoTDevice, the ingest-written inventory
+ * snapshot: credentials are user-managed rows keyed on the same
+ * (fleet, externalId) identity the device stamps on its datapoints.
+ */
+@EnableDocumentation()
+@TenantColumn("projectId")
+@CrudApiEndpoint(new Route("/iot-device-credential"))
+@Entity({
+  name: "IoTDeviceCredential",
+})
+@Index(["projectId", "iotFleetId", "externalId"], {
+  unique: true,
+})
+@TableAccessControl({
+  create: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.CreateIoTDeviceCredential,
+  ],
+  read: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ReadIoTDeviceCredential,
+    Permission.ReadIoTFleet,
+  ],
+  delete: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.DeleteIoTDeviceCredential,
+  ],
+  update: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.EditIoTDeviceCredential,
+  ],
+})
+@TableMetadata({
+  tableName: "IoTDeviceCredential",
+  singularName: "IoT Device Credential",
+  pluralName: "IoT Device Credentials",
+  icon: IconProp.Lock,
+  tableDescription:
+    "Registered IoT devices and their per-device MQTT credentials. Registered devices get individual authentication, topic isolation, revocation, and silent-death offline detection.",
+})
+export default class IoTDeviceCredential extends BaseModel {
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateIoTDeviceCredential,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ReadIoTDeviceCredential,
+      Permission.ReadIoTFleet,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "projectId",
+    type: TableColumnType.Entity,
+    modelType: Project,
+    title: "Project",
+    description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
+  })
+  @ManyToOne(
+    () => {
+      return Project;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "projectId" })
+  public project?: Project = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateIoTDeviceCredential,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ReadIoTDeviceCredential,
+      Permission.ReadIoTFleet,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    canReadOnRelationQuery: true,
+    title: "Project ID",
+    description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public projectId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateIoTDeviceCredential,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ReadIoTDeviceCredential,
+      Permission.ReadIoTFleet,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "iotFleetId",
+    type: TableColumnType.Entity,
+    modelType: IoTFleet,
+    title: "IoT Fleet",
+    description: "Fleet this device belongs to.",
+  })
+  @ManyToOne(
+    () => {
+      return IoTFleet;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "iotFleetId" })
+  public iotFleet?: IoTFleet = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateIoTDeviceCredential,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ReadIoTDeviceCredential,
+      Permission.ReadIoTFleet,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    canReadOnRelationQuery: true,
+    title: "IoT Fleet ID",
+    description: "ID of the IoT Fleet this device belongs to.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public iotFleetId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateIoTDeviceCredential,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ReadIoTDeviceCredential,
+      Permission.ReadIoTFleet,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    required: true,
+    type: TableColumnType.ShortText,
+    title: "Device ID",
+    description:
+      "The device id — must match the device.id label the device stamps on its datapoints. It is also the <device> segment of the device's MQTT topics, so a device that reports directly over MQTT cannot use an id containing '/', '+', or '#' (such devices can still report through a gateway).",
+    canReadOnRelationQuery: true,
+    example: "sensor-001",
+  })
+  @Column({
+    nullable: false,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public externalId?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateIoTDeviceCredential,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ReadIoTDeviceCredential,
+      Permission.ReadIoTFleet,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditIoTDeviceCredential,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.ShortText,
+    title: "Name",
+    description: "Any friendly name of this device",
+    canReadOnRelationQuery: true,
+    example: "Boiler room temperature sensor",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public name?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateIoTDeviceCredential,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ReadIoTDeviceCredential,
+      Permission.ReadIoTFleet,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditIoTDeviceCredential,
+    ],
+  })
+  @TableColumn({
+    isDefaultValueColumn: true,
+    required: true,
+    type: TableColumnType.Boolean,
+    defaultValue: true,
+    title: "Enabled",
+    description:
+      "Disabled credentials are rejected at MQTT CONNECT and stop the device's silent-death offline detection.",
+  })
+  @Column({
+    type: ColumnType.Boolean,
+    nullable: false,
+    default: true,
+  })
+  public isEnabled?: boolean = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ReadIoTDeviceCredential,
+      Permission.ReadIoTFleet,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.Date,
+    required: false,
+    title: "Last Connected At",
+    description: "When this credential last authenticated an MQTT connection.",
+  })
+  @Column({
+    type: ColumnType.Date,
+    nullable: true,
+  })
+  public lastConnectedAt?: Date = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateIoTDeviceCredential,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ReadIoTDeviceCredential,
+      Permission.ReadIoTFleet,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "createdByUserId",
+    type: TableColumnType.Entity,
+    modelType: User,
+    title: "Created by User",
+    description:
+      "Relation to User who created this object (if this object was created by a User)",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+  })
+  @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.CreateIoTDeviceCredential,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ReadIoTDeviceCredential,
+      Permission.ReadIoTFleet,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Created by User ID",
+    description:
+      "User ID who created this object (if this object was created by a User)",
+    example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public createdByUserId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "deletedByUserId",
+    type: TableColumnType.Entity,
+    title: "Deleted by User",
+    modelType: User,
+    description:
+      "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
+  })
+  @ManyToOne(
+    () => {
+      return User;
+    },
+    {
+      cascade: false,
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "deletedByUserId" })
+  public deletedByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [],
+    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)",
+    example: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public deletedByUserId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ReadIoTDeviceCredential,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    isDefaultValueColumn: false,
+    computed: true,
+    title: "Device Secret",
+    description:
+      "Secret this device presents as the MQTT password (with this credential's ID as the username).",
+    example: "c3d4e5f6-a7b8-9012-cdef-123456789012",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public secretKey?: ObjectID = undefined;
+}

package/Models/DatabaseModels/LlmLog.ts

@@ -302,6 +302,62 @@ export default class LlmLog extends BaseModel {
   })
   public totalTokens?: number = undefined;
 
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadLlmLog,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: true,
+    type: TableColumnType.Number,
+    title: "Cached Input Tokens",
+    description:
+      "Input tokens served from the provider's prompt cache (billed at a discount)",
+    canReadOnRelationQuery: false,
+    isDefaultValueColumn: true,
+    defaultValue: 0,
+  })
+  @Column({
+    nullable: false,
+    default: 0,
+    type: ColumnType.Number,
+  })
+  public cachedInputTokens?: number = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ReadLlmLog,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: true,
+    type: TableColumnType.Number,
+    title: "Cache Creation Tokens",
+    description:
+      "Input tokens written to the provider's prompt cache on this call",
+    canReadOnRelationQuery: false,
+    isDefaultValueColumn: true,
+    defaultValue: 0,
+  })
+  @Column({
+    nullable: false,
+    default: 0,
+    type: ColumnType.Number,
+  })
+  public cacheCreationTokens?: number = undefined;
+
   // Cost tracking
 
   @ColumnAccessControl({

package/Models/DatabaseModels/LlmProvider.ts

@@ -21,6 +21,7 @@ import Permission from "../../Types/Permission";
 import { Column, Entity, JoinColumn, ManyToOne } from "typeorm";
 import EnableDocumentation from "../../Types/Database/EnableDocumentation";
 import LlmType from "../../Types/LLM/LlmType";
+import { JSONObject } from "../../Types/JSON";
 
 @EnableDocumentation()
 @TableBillingAccessControl({
@@ -298,6 +299,38 @@ export default class LlmProvider extends BaseModel {
   })
   public baseUrl?: string = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.CreateProjectLlm,
+    ],
+    read: [Permission.Public],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.EditProjectLlm,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.JSON,
+    title: "Additional Parameters",
+    description:
+      "Optional JSON object with extra parameters sent directly to the provider API. These are merged last and override any defaults.",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.JSON,
+  })
+  public additionalParams?: JSONObject = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,