@oneuptime/common 11.1.2 → 11.2.1

package/build/dist/Models/DatabaseModels/IoTDevice.js

@@ -0,0 +1,722 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+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 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";
+/*
+ * ------------------------------------------------------------------
+ *                            IoTDevice
+ * ------------------------------------------------------------------
+ *
+ * Inventory snapshot of a single IoT device (sensor, gateway, etc.)
+ * in a single fleet. Populated by the OTel metrics ingest path from
+ * the device/gateway OTLP push stream — identity and status already
+ * arrive in every metric batch, so no separate object stream is
+ * needed.
+ *
+ * `externalId` is the `device.id` datapoint label verbatim —
+ * immutable and collision-free within a fleet.
+ *
+ * Latest-metric delta: iot_cpu_usage_ratio is already a true 0..1
+ * ratio, so latestCpuPercent is just ratio * 100 — no
+ * allocatable-denominator cache is needed.
+ *
+ * The list/detail pages read this table instead of groupBy-ing over
+ * 24h of ClickHouse metric data. Rows are upserted per scrape and
+ * hard-deleted once lastSeenAt falls behind "now - 15min" for fleets
+ * that remain connected.
+ *
+ * Writes go through IoTDeviceService under isRoot; users never
+ * create/update/delete rows directly.
+ *
+ * ------------------------------------------------------------------
+ */
+const READ_PERMISSIONS = [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.Viewer,
+    Permission.SettingsAdmin,
+    Permission.SettingsMember,
+    Permission.SettingsViewer,
+    Permission.ReadIoTFleet,
+];
+let IoTDevice = class IoTDevice extends BaseModel {
+    constructor() {
+        super(...arguments);
+        this.project = undefined;
+        this.projectId = undefined;
+        this.iotFleet = undefined;
+        this.iotFleetId = undefined;
+        this.kind = undefined;
+        this.externalId = undefined;
+        this.name = undefined;
+        this.deviceType = undefined;
+        this.firmwareVersion = undefined;
+        this.isUp = undefined;
+        this.uptimeSeconds = undefined;
+        this.latestCpuPercent = undefined;
+        this.latestMemoryBytes = undefined;
+        this.maxMemoryBytes = undefined;
+        this.latestMemoryPercent = undefined;
+        this.latestBatteryPercent = undefined;
+        this.latestSignalStrengthDbm = undefined;
+        this.latestTemperatureCelsius = undefined;
+        this.metricsUpdatedAt = undefined;
+        this.lastSeenAt = undefined;
+        this.createdByUser = undefined;
+        this.createdByUserId = undefined;
+        this.deletedByUser = undefined;
+        this.deletedByUserId = undefined;
+    }
+};
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        manyToOneRelationColumn: "projectId",
+        type: TableColumnType.Entity,
+        modelType: Project,
+        title: "Project",
+        description: "Relation to Project this device belongs to.",
+    }),
+    ManyToOne(() => {
+        return Project;
+    }, {
+        eager: false,
+        nullable: true,
+        onDelete: "CASCADE",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "projectId" }),
+    __metadata("design:type", Project)
+], IoTDevice.prototype, "project", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    Index(),
+    TableColumn({
+        type: TableColumnType.ObjectID,
+        required: true,
+        canReadOnRelationQuery: true,
+        title: "Project ID",
+        description: "ID of the Project this device belongs to.",
+    }),
+    Column({
+        type: ColumnType.ObjectID,
+        nullable: false,
+        transformer: ObjectID.getDatabaseTransformer(),
+    }),
+    __metadata("design:type", ObjectID)
+], IoTDevice.prototype, "projectId", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        manyToOneRelationColumn: "iotFleetId",
+        type: TableColumnType.Entity,
+        modelType: IoTFleet,
+        title: "IoT Fleet",
+        description: "Fleet this device lives in.",
+    }),
+    ManyToOne(() => {
+        return IoTFleet;
+    }, {
+        eager: false,
+        nullable: true,
+        onDelete: "CASCADE",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "iotFleetId" }),
+    __metadata("design:type", IoTFleet)
+], IoTDevice.prototype, "iotFleet", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    Index(),
+    TableColumn({
+        type: TableColumnType.ObjectID,
+        required: true,
+        canReadOnRelationQuery: true,
+        title: "IoT Fleet ID",
+        description: "ID of the IoT Fleet this device lives in.",
+    }),
+    Column({
+        type: ColumnType.ObjectID,
+        nullable: false,
+        transformer: ObjectID.getDatabaseTransformer(),
+    }),
+    __metadata("design:type", ObjectID)
+], IoTDevice.prototype, "iotFleetId", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: true,
+        type: TableColumnType.ShortText,
+        canReadOnRelationQuery: true,
+        title: "Kind",
+        description: "IoT device class in singular PascalCase: Device, Sensor or Gateway.",
+    }),
+    Column({
+        nullable: false,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], IoTDevice.prototype, "kind", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: true,
+        type: TableColumnType.ShortText,
+        canReadOnRelationQuery: true,
+        title: "External ID",
+        description: "The `device.id` datapoint label verbatim. Immutable and collision-free within a fleet; also the detail-route param.",
+    }),
+    Column({
+        nullable: false,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], IoTDevice.prototype, "externalId", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.ShortText,
+        canReadOnRelationQuery: true,
+        title: "Name",
+        description: "Human-friendly name from the iot_device_info `name` label. Null until the matching info series is scraped.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], IoTDevice.prototype, "name", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.ShortText,
+        canReadOnRelationQuery: true,
+        title: "Device Type",
+        description: "Device type from the `iot.device.type` attribute (e.g. thermostat, camera, meter). Null until reported.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], IoTDevice.prototype, "deviceType", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.ShortText,
+        canReadOnRelationQuery: true,
+        title: "Firmware Version",
+        description: "Firmware version from the `iot.device.firmware` attribute. Null until reported.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], IoTDevice.prototype, "firmwareVersion", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.Boolean,
+        canReadOnRelationQuery: true,
+        title: "Is Up",
+        description: "True when the latest iot_device_up value for this device is 1 (device online).",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.Boolean,
+    }),
+    __metadata("design:type", Boolean)
+], IoTDevice.prototype, "isUp", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.Number,
+        canReadOnRelationQuery: true,
+        title: "Uptime Seconds",
+        description: "Latest iot_uptime_seconds value for this device. Null until the first metric arrives.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.Number,
+    }),
+    __metadata("design:type", Number)
+], IoTDevice.prototype, "uptimeSeconds", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.Number,
+        canReadOnRelationQuery: true,
+        title: "Latest CPU Percent",
+        description: "Most recent CPU utilization percent (iot_cpu_usage_ratio * 100 — already a true ratio; no allocatable-denominator cache needed). Stored as decimal so sub-percent precision survives the round trip. Null until the first metric arrives.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.Decimal,
+        transformer: {
+            to: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                return value;
+            },
+            from: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                if (typeof value === "number") {
+                    return value;
+                }
+                const parsed = parseFloat(value);
+                return isNaN(parsed) ? null : parsed;
+            },
+        },
+    }),
+    __metadata("design:type", Number)
+], IoTDevice.prototype, "latestCpuPercent", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.BigPositiveNumber,
+        canReadOnRelationQuery: true,
+        title: "Latest Memory Bytes",
+        description: "Most recent memory usage (iot_memory_usage_bytes). Stored as bigint so values past 2 GiB don't overflow.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.BigPositiveNumber,
+        transformer: {
+            to: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                return Math.trunc(value).toString();
+            },
+            from: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                const parsed = parseInt(value, 10);
+                return isNaN(parsed) ? null : parsed;
+            },
+        },
+    }),
+    __metadata("design:type", Number)
+], IoTDevice.prototype, "latestMemoryBytes", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.BigPositiveNumber,
+        canReadOnRelationQuery: true,
+        title: "Max Memory Bytes",
+        description: "Total memory available to this device (iot_memory_size_bytes). The denominator for the memory usage bar.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.BigPositiveNumber,
+        transformer: {
+            to: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                return Math.trunc(value).toString();
+            },
+            from: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                const parsed = parseInt(value, 10);
+                return isNaN(parsed) ? null : parsed;
+            },
+        },
+    }),
+    __metadata("design:type", Number)
+], IoTDevice.prototype, "maxMemoryBytes", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.Number,
+        canReadOnRelationQuery: true,
+        title: "Latest Memory Percent",
+        description: "Most recent memory usage as a percent of maxMemoryBytes. Stored as decimal — mirrors latestCpuPercent — so list views can sort/filter without dividing bigints client-side.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.Decimal,
+        transformer: {
+            to: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                return value;
+            },
+            from: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                if (typeof value === "number") {
+                    return value;
+                }
+                const parsed = parseFloat(value);
+                return isNaN(parsed) ? null : parsed;
+            },
+        },
+    }),
+    __metadata("design:type", Number)
+], IoTDevice.prototype, "latestMemoryPercent", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.Number,
+        canReadOnRelationQuery: true,
+        title: "Latest Battery Percent",
+        description: "Most recent battery level percent (iot_battery_percent). Stored as decimal so sub-percent precision survives the round trip. Null until the first metric arrives.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.Decimal,
+        transformer: {
+            to: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                return value;
+            },
+            from: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                if (typeof value === "number") {
+                    return value;
+                }
+                const parsed = parseFloat(value);
+                return isNaN(parsed) ? null : parsed;
+            },
+        },
+    }),
+    __metadata("design:type", Number)
+], IoTDevice.prototype, "latestBatteryPercent", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.Number,
+        canReadOnRelationQuery: true,
+        title: "Latest Signal Strength Dbm",
+        description: "Most recent signal strength in dBm (iot_signal_strength_dbm). Stored as decimal so sub-unit precision survives the round trip. Null until the first metric arrives.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.Decimal,
+        transformer: {
+            to: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                return value;
+            },
+            from: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                if (typeof value === "number") {
+                    return value;
+                }
+                const parsed = parseFloat(value);
+                return isNaN(parsed) ? null : parsed;
+            },
+        },
+    }),
+    __metadata("design:type", Number)
+], IoTDevice.prototype, "latestSignalStrengthDbm", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.Number,
+        canReadOnRelationQuery: true,
+        title: "Latest Temperature Celsius",
+        description: "Most recent temperature reading in degrees Celsius (iot_temperature_celsius). Stored as decimal so sub-degree precision survives the round trip. Null until the first metric arrives.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.Decimal,
+        transformer: {
+            to: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                return value;
+            },
+            from: (value) => {
+                if (value === null || value === undefined) {
+                    return null;
+                }
+                if (typeof value === "number") {
+                    return value;
+                }
+                const parsed = parseFloat(value);
+                return isNaN(parsed) ? null : parsed;
+            },
+        },
+    }),
+    __metadata("design:type", Number)
+], IoTDevice.prototype, "latestTemperatureCelsius", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.Date,
+        canReadOnRelationQuery: true,
+        title: "Metrics Updated At",
+        description: "Observed timestamp of the latest metric point. Acts as the monotonic guard for metric updates and the cutoff for staleness rendering.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.Date,
+    }),
+    __metadata("design:type", Date)
+], IoTDevice.prototype, "metricsUpdatedAt", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        required: true,
+        type: TableColumnType.Date,
+        canReadOnRelationQuery: true,
+        title: "Last Seen At",
+        description: "Agent-observed timestamp of the most recent scrape containing this device. Also acts as the monotonic guard for upserts.",
+    }),
+    Column({
+        nullable: false,
+        type: ColumnType.Date,
+    }),
+    __metadata("design:type", Date)
+], IoTDevice.prototype, "lastSeenAt", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        manyToOneRelationColumn: "createdByUserId",
+        type: TableColumnType.Entity,
+        modelType: User,
+        title: "Created By User",
+        description: "Not user-facing; ingest writes as isRoot so this stays null in practice.",
+    }),
+    ManyToOne(() => {
+        return User;
+    }, {
+        eager: false,
+        nullable: true,
+        onDelete: "SET NULL",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "createdByUserId" }),
+    __metadata("design:type", User)
+], IoTDevice.prototype, "createdByUser", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        type: TableColumnType.ObjectID,
+        title: "Created By User ID",
+        description: "ID of the user who created this row.",
+    }),
+    Column({
+        type: ColumnType.ObjectID,
+        nullable: true,
+        transformer: ObjectID.getDatabaseTransformer(),
+    }),
+    __metadata("design:type", ObjectID)
+], IoTDevice.prototype, "createdByUserId", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        manyToOneRelationColumn: "deletedByUserId",
+        type: TableColumnType.Entity,
+        modelType: User,
+        title: "Deleted By User",
+        description: "Relation to the user who deleted this row.",
+    }),
+    ManyToOne(() => {
+        return User;
+    }, {
+        eager: false,
+        nullable: true,
+        onDelete: "SET NULL",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "deletedByUserId" }),
+    __metadata("design:type", User)
+], IoTDevice.prototype, "deletedByUser", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+    }),
+    TableColumn({
+        type: TableColumnType.ObjectID,
+        title: "Deleted By User ID",
+        description: "ID of the user who deleted this row.",
+    }),
+    Column({
+        type: ColumnType.ObjectID,
+        nullable: true,
+        transformer: ObjectID.getDatabaseTransformer(),
+    }),
+    __metadata("design:type", ObjectID)
+], IoTDevice.prototype, "deletedByUserId", void 0);
+IoTDevice = __decorate([
+    TenantColumn("projectId"),
+    TableAccessControl({
+        create: [],
+        read: READ_PERMISSIONS,
+        update: [],
+        delete: [],
+    }),
+    CrudApiEndpoint(new Route("/iot-device")),
+    TableMetadata({
+        tableName: "IoTDevice",
+        singularName: "IoT Device",
+        pluralName: "IoT Devices",
+        icon: IconProp.Cube,
+        tableDescription: "Snapshot of an IoT device (sensor, gateway, etc.) as last reported by the IoT fleet. Populated by the telemetry ingest pipeline; not user-editable.",
+    }),
+    Index(["projectId", "iotFleetId", "kind", "externalId"], {
+        unique: true,
+    }),
+    Entity({
+        name: "IoTDevice",
+    })
+], IoTDevice);
+export default IoTDevice;
+//# sourceMappingURL=IoTDevice.js.map