@oneuptime/common 10.7.1 → 10.8.0

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

@@ -0,0 +1,751 @@
+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 Label from "./Label";
+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 AccessControlColumn from "../../Types/Database/AccessControlColumn";
+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 SlugifyColumn from "../../Types/Database/SlugifyColumn";
+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 UniqueColumnBy from "../../Types/Database/UniqueColumnBy";
+import IconProp from "../../Types/Icon/IconProp";
+import ObjectID from "../../Types/ObjectID";
+import Permission from "../../Types/Permission";
+import { Column, Entity, Index, JoinColumn, JoinTable, ManyToMany, ManyToOne, } from "typeorm";
+let RumApplication = class RumApplication extends BaseModel {
+    constructor() {
+        super(...arguments);
+        this.project = undefined;
+        this.projectId = undefined;
+        this.name = undefined;
+        this.slug = undefined;
+        this.description = undefined;
+        this.appIdentifier = undefined;
+        this.clientType = undefined;
+        this.sdkLanguage = undefined;
+        this.otelCollectorStatus = undefined;
+        this.agentVersion = undefined;
+        this.lastSeenAt = undefined;
+        this.labels = undefined;
+        this.retainTelemetryDataForDays = undefined;
+        this.telemetryRetentionConfig = undefined;
+        this.createdByUser = undefined;
+        this.createdByUserId = undefined;
+        this.deletedByUser = undefined;
+        this.deletedByUserId = undefined;
+    }
+};
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateRumApplication,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        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: true,
+        onDelete: "CASCADE",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "projectId" }),
+    __metadata("design:type", Project)
+], RumApplication.prototype, "project", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateRumApplication,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        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(),
+    }),
+    __metadata("design:type", ObjectID)
+], RumApplication.prototype, "projectId", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateRumApplication,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditRumApplication,
+        ],
+    }),
+    TableColumn({
+        required: true,
+        type: TableColumnType.ShortText,
+        canReadOnRelationQuery: true,
+        title: "Name",
+        description: "Friendly name for this application",
+        example: "storefront-web",
+    }),
+    Column({
+        nullable: false,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    UniqueColumnBy("projectId"),
+    __metadata("design:type", String)
+], RumApplication.prototype, "name", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        required: true,
+        unique: true,
+        type: TableColumnType.Slug,
+        computed: true,
+        title: "Slug",
+        description: "Friendly globally unique name for your object",
+    }),
+    Column({
+        nullable: false,
+        type: ColumnType.Slug,
+        length: ColumnLength.Slug,
+    }),
+    __metadata("design:type", String)
+], RumApplication.prototype, "slug", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateRumApplication,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditRumApplication,
+        ],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.LongText,
+        canReadOnRelationQuery: true,
+        title: "Description",
+        description: "Friendly description that will help you remember",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.LongText,
+        length: ColumnLength.LongText,
+    }),
+    __metadata("design:type", String)
+], RumApplication.prototype, "description", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        required: true,
+        type: TableColumnType.ShortText,
+        canReadOnRelationQuery: true,
+        title: "App Identifier",
+        description: "Stable identifier for this application from the service.name OpenTelemetry resource attribute. Identity key for this RUM application.",
+    }),
+    Column({
+        nullable: false,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], RumApplication.prototype, "appIdentifier", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.ShortText,
+        canReadOnRelationQuery: true,
+        title: "Client Type",
+        description: "Whether this application's clients are browsers or mobile devices (browser / mobile), derived from browser.* / device.* attributes.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], RumApplication.prototype, "clientType", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.ShortText,
+        canReadOnRelationQuery: true,
+        title: "SDK Language",
+        description: "Last-seen telemetry.sdk.language resource attribute (e.g. webjs, swift, android). Used to scope this application's client telemetry apart from a same-named backend service.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], RumApplication.prototype, "sdkLanguage", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.ShortText,
+        title: "OTel Collector Status",
+        description: "Whether telemetry is currently being received (connected) or has gone stale (disconnected).",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], RumApplication.prototype, "otelCollectorStatus", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.ShortText,
+        title: "Agent Version",
+        description: "Version of the OpenTelemetry SDK reporting this application.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], RumApplication.prototype, "agentVersion", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.Date,
+        canReadOnRelationQuery: true,
+        title: "Last Seen At",
+        description: "When telemetry was last received for this application",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.Date,
+    }),
+    __metadata("design:type", Date)
+], RumApplication.prototype, "lastSeenAt", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateRumApplication,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditRumApplication,
+        ],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.EntityArray,
+        modelType: Label,
+        title: "Labels",
+        description: "Relation to Labels Array where this object is categorized in.",
+    }),
+    ManyToMany(() => {
+        return Label;
+    }, { eager: false }),
+    JoinTable({
+        name: "RumApplicationLabel",
+        inverseJoinColumn: {
+            name: "labelId",
+            referencedColumnName: "_id",
+        },
+        joinColumn: {
+            name: "rumApplicationId",
+            referencedColumnName: "_id",
+        },
+    }),
+    __metadata("design:type", Array)
+], RumApplication.prototype, "labels", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateRumApplication,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditRumApplication,
+        ],
+    }),
+    TableColumn({
+        type: TableColumnType.Number,
+        title: "Retain Telemetry Data For Days",
+        description: "Number of days to retain telemetry data for this application. Leave blank to use the project-wide default.",
+    }),
+    Column({
+        type: ColumnType.Number,
+        nullable: true,
+        unique: false,
+    }),
+    __metadata("design:type", Number)
+], RumApplication.prototype, "retainTelemetryDataForDays", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateRumApplication,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditRumApplication,
+        ],
+    }),
+    TableColumn({
+        type: TableColumnType.JSON,
+        required: false,
+        title: "Telemetry Data Retention Overrides",
+        description: "Per-pillar retention overrides for this application. Unset fields fall back to the application default, then the project's retention settings.",
+    }),
+    Column({
+        type: ColumnType.JSON,
+        nullable: true,
+    }),
+    __metadata("design:type", Object)
+], RumApplication.prototype, "telemetryRetentionConfig", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateRumApplication,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        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)",
+    }),
+    ManyToOne(() => {
+        return User;
+    }, {
+        eager: false,
+        nullable: true,
+        onDelete: "SET NULL",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "createdByUserId" }),
+    __metadata("design:type", User)
+], RumApplication.prototype, "createdByUser", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateRumApplication,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        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)",
+    }),
+    Column({
+        type: ColumnType.ObjectID,
+        nullable: true,
+        transformer: ObjectID.getDatabaseTransformer(),
+    }),
+    __metadata("design:type", ObjectID)
+], RumApplication.prototype, "createdByUserId", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        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)",
+    }),
+    ManyToOne(() => {
+        return User;
+    }, {
+        cascade: false,
+        eager: false,
+        nullable: true,
+        onDelete: "SET NULL",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "deletedByUserId" }),
+    __metadata("design:type", User)
+], RumApplication.prototype, "deletedByUser", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        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(),
+    }),
+    __metadata("design:type", ObjectID)
+], RumApplication.prototype, "deletedByUserId", void 0);
+RumApplication = __decorate([
+    AccessControlColumn("labels"),
+    EnableDocumentation(),
+    TenantColumn("projectId"),
+    TableAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.CreateRumApplication,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.SettingsViewer,
+            Permission.ReadRumApplication,
+        ],
+        delete: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.DeleteRumApplication,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.SettingsAdmin,
+            Permission.SettingsMember,
+            Permission.EditRumApplication,
+        ],
+    }),
+    CrudApiEndpoint(new Route("/rum-application")),
+    SlugifyColumn("name", "slug")
+    /*
+     * Enforce one RumApplication row per (projectId, appIdentifier) at the DB
+     * level. RUM is keyed by the application (service.name), NOT by end-user
+     * device — a per-device row would be a cardinality disaster.
+     */
+    ,
+    Index(["projectId", "appIdentifier"], { unique: true }),
+    TableMetadata({
+        tableName: "RumApplication",
+        singularName: "RUM Application",
+        pluralName: "RUM Applications",
+        icon: IconProp.Globe,
+        tableDescription: "Browser & mobile applications auto-discovered from OpenTelemetry RUM telemetry (browser.* / device.* resource attributes). One row per application, aggregating all end-user clients.",
+    }),
+    Entity({
+        name: "RumApplication",
+    })
+], RumApplication);
+export default RumApplication;
+//# sourceMappingURL=RumApplication.js.map