@oneuptime/common 12.0.14 → 12.0.16

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

@@ -0,0 +1,681 @@
+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 Project from "./Project";
+import Service from "./Service";
+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 TableBillingAccessControl from "../../Types/Database/AccessControl/TableBillingAccessControl";
+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 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 IconProp from "../../Types/Icon/IconProp";
+import ObjectID from "../../Types/ObjectID";
+import Permission from "../../Types/Permission";
+import { PlanType } from "../../Types/Billing/SubscriptionPlan";
+import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
+/*
+ * Postgres returns `decimal` columns as strings; without a transformer every
+ * arithmetic comparison downstream silently becomes a string comparison.
+ * Same convention as ServiceLevelObjectiveBurnRateRule / NetworkInterface.
+ */
+const decimalTransformer = {
+    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;
+    },
+};
+let LlmCostBudget = class LlmCostBudget extends BaseModel {
+    constructor() {
+        super(...arguments);
+        this.project = undefined;
+        this.projectId = undefined;
+        this.name = undefined;
+        this.description = undefined;
+        this.isEnabled = undefined;
+        this.dailyBudgetInUSD = undefined;
+        this.service = undefined;
+        this.serviceId = undefined;
+        this.llmSystem = undefined;
+        this.llmModel = undefined;
+        this.currentDaySpendInUSD = undefined;
+        this.spendLastEvaluatedAt = undefined;
+        this.createdByUser = undefined;
+        this.createdByUserId = undefined;
+        this.deletedByUser = undefined;
+        this.deletedByUserId = undefined;
+    }
+};
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.CreateProjectLlmCostBudget,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        manyToOneRelationColumn: "projectId",
+        type: TableColumnType.Entity,
+        modelType: Project,
+        title: "Project",
+        description: "Relation to the project this LLM cost budget belongs to.",
+    }),
+    ManyToOne(() => {
+        return Project;
+    }, {
+        eager: false,
+        nullable: true,
+        onDelete: "CASCADE",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "projectId" }),
+    __metadata("design:type", Project)
+], LlmCostBudget.prototype, "project", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.CreateProjectLlmCostBudget,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [],
+    }),
+    Index(),
+    TableColumn({
+        type: TableColumnType.ObjectID,
+        required: true,
+        canReadOnRelationQuery: true,
+        title: "Project ID",
+        description: "ID of the project this LLM cost budget belongs to.",
+    }),
+    Column({
+        type: ColumnType.ObjectID,
+        nullable: false,
+        transformer: ObjectID.getDatabaseTransformer(),
+    }),
+    __metadata("design:type", ObjectID)
+], LlmCostBudget.prototype, "projectId", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.CreateProjectLlmCostBudget,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditProjectLlmCostBudget,
+        ],
+    }),
+    TableColumn({
+        required: true,
+        type: TableColumnType.Name,
+        canReadOnRelationQuery: true,
+        title: "Name",
+        description: "Friendly name for this budget.",
+    }),
+    Column({
+        nullable: false,
+        type: ColumnType.Name,
+        length: ColumnLength.Name,
+    }),
+    __metadata("design:type", String)
+], LlmCostBudget.prototype, "name", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.CreateProjectLlmCostBudget,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditProjectLlmCostBudget,
+        ],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.LongText,
+        canReadOnRelationQuery: true,
+        title: "Description",
+        description: "Description of what this budget covers.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.LongText,
+        length: ColumnLength.LongText,
+    }),
+    __metadata("design:type", String)
+], LlmCostBudget.prototype, "description", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.CreateProjectLlmCostBudget,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditProjectLlmCostBudget,
+        ],
+    }),
+    Index(),
+    TableColumn({
+        required: true,
+        type: TableColumnType.Boolean,
+        title: "Is Enabled",
+        description: "Whether this budget is evaluated.",
+        defaultValue: true,
+        isDefaultValueColumn: true,
+    }),
+    Column({
+        type: ColumnType.Boolean,
+        nullable: false,
+        default: true,
+    }),
+    __metadata("design:type", Boolean)
+], LlmCostBudget.prototype, "isEnabled", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.CreateProjectLlmCostBudget,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditProjectLlmCostBudget,
+        ],
+    }),
+    TableColumn({
+        required: true,
+        type: TableColumnType.Number,
+        canReadOnRelationQuery: true,
+        title: "Daily Budget (USD)",
+        description: "Daily LLM spend budget in USD, evaluated over the UTC day. Spend and percent-used are published as metrics for monitors to alert on.",
+    }),
+    Column({
+        nullable: false,
+        type: ColumnType.Decimal,
+        transformer: decimalTransformer,
+    }),
+    __metadata("design:type", Number)
+], LlmCostBudget.prototype, "dailyBudgetInUSD", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.CreateProjectLlmCostBudget,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditProjectLlmCostBudget,
+        ],
+    }),
+    TableColumn({
+        manyToOneRelationColumn: "serviceId",
+        type: TableColumnType.Entity,
+        modelType: Service,
+        required: false,
+        title: "Service",
+        description: "Optional service scope. When set, only LLM spend of this telemetry service counts against the budget. Leave empty for a project-wide budget.",
+    }),
+    ManyToOne(() => {
+        return Service;
+    }, {
+        eager: false,
+        nullable: true,
+        onDelete: "CASCADE",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "serviceId" }),
+    __metadata("design:type", Service)
+], LlmCostBudget.prototype, "service", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.CreateProjectLlmCostBudget,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditProjectLlmCostBudget,
+        ],
+    }),
+    Index(),
+    TableColumn({
+        type: TableColumnType.ObjectID,
+        required: false,
+        canReadOnRelationQuery: true,
+        title: "Service ID",
+        description: "Optional telemetry service ID scoping this budget. Null means the budget is project-wide.",
+    }),
+    Column({
+        type: ColumnType.ObjectID,
+        nullable: true,
+        transformer: ObjectID.getDatabaseTransformer(),
+    }),
+    __metadata("design:type", ObjectID)
+], LlmCostBudget.prototype, "serviceId", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.CreateProjectLlmCostBudget,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditProjectLlmCostBudget,
+        ],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.ShortText,
+        canReadOnRelationQuery: true,
+        title: "LLM Provider",
+        description: "Optional provider filter, e.g. openai, anthropic, aws.bedrock (matches the span's gen_ai provider). Leave empty to count every provider.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], LlmCostBudget.prototype, "llmSystem", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.CreateProjectLlmCostBudget,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditProjectLlmCostBudget,
+        ],
+    }),
+    TableColumn({
+        required: false,
+        type: TableColumnType.ShortText,
+        canReadOnRelationQuery: true,
+        title: "LLM Model",
+        description: "Optional model filter, e.g. gpt-4o (matches the span's requested model exactly). Leave empty to count every model.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.ShortText,
+        length: ColumnLength.ShortText,
+    }),
+    __metadata("design:type", String)
+], LlmCostBudget.prototype, "llmModel", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        type: TableColumnType.Number,
+        required: false,
+        title: "Current Day Spend (USD)",
+        description: "LLM spend accrued so far in the current UTC day, in USD. Computed by the worker.",
+    }),
+    Column({
+        nullable: true,
+        type: ColumnType.Decimal,
+        transformer: decimalTransformer,
+    }),
+    __metadata("design:type", Number)
+], LlmCostBudget.prototype, "currentDaySpendInUSD", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        type: TableColumnType.Date,
+        required: false,
+        title: "Spend Last Evaluated At",
+        description: "The last time the worker evaluated this budget. Computed by the worker.",
+    }),
+    Column({
+        type: ColumnType.Date,
+        nullable: true,
+    }),
+    __metadata("design:type", Date)
+], LlmCostBudget.prototype, "spendLastEvaluatedAt", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        manyToOneRelationColumn: "createdByUserId",
+        type: TableColumnType.Entity,
+        modelType: User,
+        title: "Created By User",
+        description: "Relation to the user who created this budget.",
+    }),
+    ManyToOne(() => {
+        return User;
+    }, {
+        eager: false,
+        nullable: true,
+        onDelete: "SET NULL",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "createdByUserId" }),
+    __metadata("design:type", User)
+], LlmCostBudget.prototype, "createdByUser", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        type: TableColumnType.ObjectID,
+        title: "Created By User ID",
+        description: "ID of the user who created this budget.",
+    }),
+    Column({
+        type: ColumnType.ObjectID,
+        nullable: true,
+        transformer: ObjectID.getDatabaseTransformer(),
+    }),
+    __metadata("design:type", ObjectID)
+], LlmCostBudget.prototype, "createdByUserId", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        manyToOneRelationColumn: "deletedByUserId",
+        type: TableColumnType.Entity,
+        modelType: User,
+        title: "Deleted By User",
+        description: "Relation to the user who deleted this budget.",
+    }),
+    ManyToOne(() => {
+        return User;
+    }, {
+        eager: false,
+        nullable: true,
+        onDelete: "SET NULL",
+        orphanedRowAction: "nullify",
+    }),
+    JoinColumn({ name: "deletedByUserId" }),
+    __metadata("design:type", User)
+], LlmCostBudget.prototype, "deletedByUser", void 0);
+__decorate([
+    ColumnAccessControl({
+        create: [],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        update: [],
+    }),
+    TableColumn({
+        type: TableColumnType.ObjectID,
+        title: "Deleted By User ID",
+        description: "ID of the user who deleted this budget.",
+    }),
+    Column({
+        type: ColumnType.ObjectID,
+        nullable: true,
+        transformer: ObjectID.getDatabaseTransformer(),
+    }),
+    __metadata("design:type", ObjectID)
+], LlmCostBudget.prototype, "deletedByUserId", void 0);
+LlmCostBudget = __decorate([
+    EnableDocumentation(),
+    TableBillingAccessControl({
+        create: PlanType.Free,
+        read: PlanType.Free,
+        update: PlanType.Free,
+        delete: PlanType.Free,
+    }),
+    TenantColumn("projectId"),
+    CrudApiEndpoint(new Route("/llm-cost-budget")),
+    Entity({
+        name: "LlmCostBudget",
+    }),
+    EnableWorkflow({
+        create: true,
+        delete: true,
+        update: true,
+        read: true,
+    }),
+    TableMetadata({
+        tableName: "LlmCostBudget",
+        singularName: "LLM Cost Budget",
+        pluralName: "LLM Cost Budgets",
+        icon: IconProp.CurrencyDollar,
+        tableDescription: "Daily USD spend budgets for LLM / GenAI telemetry. A worker sums the day's LLM span cost and publishes it as the oneuptime.llm.budget.* metrics, so Metrics monitors, dashboards and anomaly detection can act on spend.",
+    }),
+    TableAccessControl({
+        create: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.CreateProjectLlmCostBudget,
+        ],
+        read: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.ProjectMember,
+            Permission.Viewer,
+            Permission.TelemetryAdmin,
+            Permission.TelemetryMember,
+            Permission.TelemetryViewer,
+            Permission.ReadProjectLlmCostBudget,
+        ],
+        delete: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.DeleteProjectLlmCostBudget,
+        ],
+        update: [
+            Permission.ProjectOwner,
+            Permission.ProjectAdmin,
+            Permission.EditProjectLlmCostBudget,
+        ],
+    })
+], LlmCostBudget);
+export default LlmCostBudget;
+//# sourceMappingURL=LlmCostBudget.js.map