@oneuptime/common 9.2.11 → 9.2.14

package/Models/DatabaseModels/{CopilotPullRequest.ts → LlmProvider.ts}

@@ -1,18 +1,16 @@
-import CodeRepository from "./CopilotCodeRepository";
 import Project from "./Project";
-import ServiceCatalog from "./ServiceCatalog";
-import ServiceCopilotCodeRepository from "./ServiceCopilotCodeRepository";
 import User from "./User";
 import BaseModel from "./DatabaseBaseModel/DatabaseBaseModel";
 import Route from "../../Types/API/Route";
-import PullRequestState from "../../Types/CodeRepository/PullRequestState";
+import { PlanType } from "../../Types/Billing/SubscriptionPlan";
 import ColumnAccessControl from "../../Types/Database/AccessControl/ColumnAccessControl";
 import TableAccessControl from "../../Types/Database/AccessControl/TableAccessControl";
-import CanAccessIfCanReadOn from "../../Types/Database/CanAccessIfCanReadOn";
+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 IsPermissionsIf from "../../Types/Database/IsPermissionsIf";
+import SlugifyColumn from "../../Types/Database/SlugifyColumn";
 import TableColumn from "../../Types/Database/TableColumn";
 import TableColumnType from "../../Types/Database/TableColumnType";
 import TableMetadata from "../../Types/Database/TableMetadata";
@@ -20,451 +18,448 @@ 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";
+import { Column, Entity, JoinColumn, ManyToOne } from "typeorm";
+import EnableDocumentation from "../../Types/Database/EnableDocumentation";
+import LlmType from "../../Types/LLM/LlmType";
 
-@CanAccessIfCanReadOn("codeRepository")
 @EnableDocumentation()
+@TableBillingAccessControl({
+  create: PlanType.Growth,
+  read: PlanType.Free,
+  update: PlanType.Growth,
+  delete: PlanType.Free,
+})
+@IsPermissionsIf(Permission.Public, "projectId", null)
 @TenantColumn("projectId")
+@CrudApiEndpoint(new Route("/llm-provider"))
+@SlugifyColumn("name", "slug")
+@Entity({
+  name: "LlmProvider",
+})
+@TableMetadata({
+  tableName: "LlmProvider",
+  singularName: "LLM Provider",
+  pluralName: "LLM Providers",
+  icon: IconProp.Bolt,
+  tableDescription:
+    "Manage LLM Provider configurations. Connect to OpenAI, Anthropic, Ollama, or other LLM providers to enable AI features.",
+})
 @TableAccessControl({
-  create: [],
+  create: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.CreateProjectLlm,
+  ],
   read: [
+    Permission.Public,
     Permission.ProjectOwner,
     Permission.ProjectAdmin,
     Permission.ProjectMember,
-    Permission.ReadCopilotPullRequest,
+    Permission.ReadProjectLlm,
+  ],
+  delete: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.DeleteProjectLlm,
+  ],
+  update: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.EditProjectLlm,
   ],
-  delete: [],
-  update: [],
-})
-@EnableWorkflow({
-  create: true,
-  delete: false,
-  update: true,
-})
-@CrudApiEndpoint(new Route("/copilot-pull-request"))
-@TableMetadata({
-  tableName: "CopilotPullRequest",
-  singularName: "Copilot Pull Request",
-  pluralName: "Copilot Pull Requests",
-  icon: IconProp.Bolt,
-  tableDescription:
-    "List of pull requests created by Copilot and status of those requests.",
-})
-@Entity({
-  name: "CopilotPullRequest",
 })
-export default class CopilotPullRequest extends BaseModel {
+export default class LlmProvider extends BaseModel {
   @ColumnAccessControl({
-    create: [],
-    read: [
+    create: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.CreateProjectLlm,
+    ],
+    read: [Permission.Public],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditProjectLlm,
     ],
-    update: [],
   })
   @TableColumn({
-    manyToOneRelationColumn: "projectId",
-    type: TableColumnType.Entity,
-    modelType: Project,
-    title: "Project",
-    description: "Relation to Project Resource in which this object belongs",
+    required: true,
+    type: TableColumnType.Name,
+    canReadOnRelationQuery: true,
+    title: "Name",
+    description: "A friendly name for this LLM configuration.",
   })
-  @ManyToOne(
-    () => {
-      return Project;
-    },
-    {
-      eager: false,
-      nullable: false,
-      onDelete: "CASCADE",
-      orphanedRowAction: "nullify",
-    },
-  )
-  @JoinColumn({ name: "projectId" })
-  public project?: Project = undefined;
+  @Column({
+    nullable: false,
+    type: ColumnType.Name,
+    length: ColumnLength.Name,
+  })
+  public name?: string = undefined;
 
   @ColumnAccessControl({
-    create: [],
-    read: [
+    create: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.CreateProjectLlm,
     ],
+    read: [Permission.Public],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditProjectLlm,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.LongText,
+    title: "Description",
+    description: "Description of this LLM configuration.",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.LongText,
+  })
+  public description?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [Permission.Public],
     update: [],
   })
-  @Index()
   @TableColumn({
-    type: TableColumnType.ObjectID,
     required: true,
-    canReadOnRelationQuery: true,
-    title: "Project ID",
-    description: "ID of your OneUptime Project in which this object belongs",
+    unique: true,
+    type: TableColumnType.Slug,
+    computed: true,
+    title: "Slug",
+    description: "Friendly globally unique name for your object",
   })
   @Column({
-    type: ColumnType.ObjectID,
     nullable: false,
-    transformer: ObjectID.getDatabaseTransformer(),
+    type: ColumnType.Slug,
+    length: ColumnLength.Slug,
   })
-  public projectId?: ObjectID = undefined;
+  public slug?: string = undefined;
 
   @ColumnAccessControl({
-    create: [],
-    read: [
+    create: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.CreateProjectLlm,
+    ],
+    read: [Permission.Public],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditProjectLlm,
     ],
-    update: [],
   })
   @TableColumn({
-    manyToOneRelationColumn: "codeRepositoryId",
-    type: TableColumnType.Entity,
-    modelType: CodeRepository,
-    title: "Code Repository",
-    description:
-      "Relation to CodeRepository Resource in which this object belongs",
+    required: true,
+    type: TableColumnType.ShortText,
+    title: "LLM Type",
+    description: "The type of LLM provider (OpenAI, Anthropic, Ollama, etc.)",
   })
-  @ManyToOne(
-    () => {
-      return CodeRepository;
-    },
-    {
-      eager: false,
-      nullable: true,
-      onDelete: "CASCADE",
-      orphanedRowAction: "nullify",
-    },
-  )
-  @JoinColumn({ name: "codeRepositoryId" })
-  public codeRepository?: CodeRepository = undefined;
+  @Column({
+    nullable: false,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public llmType?: LlmType = undefined;
 
   @ColumnAccessControl({
-    create: [],
-    read: [
+    create: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.CreateProjectLlm,
+    ],
+    read: [Permission.ProjectOwner, Permission.ProjectAdmin],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditProjectLlm,
     ],
-    update: [],
   })
-  @Index()
   @TableColumn({
-    type: TableColumnType.ObjectID,
-    required: true,
-    canReadOnRelationQuery: true,
-    title: "Code Repository ID",
+    required: false,
+    type: TableColumnType.LongText,
+    title: "API Key",
     description:
-      "ID of your OneUptime Code Repository in which this object belongs",
+      "The API key for the LLM provider. Required for OpenAI and Anthropic.",
+    encrypted: true,
   })
   @Column({
-    type: ColumnType.ObjectID,
-    nullable: false,
-    transformer: ObjectID.getDatabaseTransformer(),
+    nullable: true,
+    type: ColumnType.LongText,
   })
-  public codeRepositoryId?: ObjectID = undefined;
+  public apiKey?: string = undefined;
 
   @ColumnAccessControl({
-    create: [],
-    read: [
+    create: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.CreateProjectLlm,
+    ],
+    read: [Permission.Public],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditProjectLlm,
     ],
-    update: [],
   })
   @TableColumn({
-    manyToOneRelationColumn: "createdByUserId",
-    type: TableColumnType.Entity,
-    modelType: User,
-    title: "Created by User",
+    required: false,
+    type: TableColumnType.ShortText,
+    title: "Model Name",
     description:
-      "Relation to User who created this object (if this object was created by a User)",
+      "The name of the model to use (e.g., gpt-4, claude-3-opus, llama2).",
   })
-  @ManyToOne(
-    () => {
-      return User;
-    },
-    {
-      eager: false,
-      nullable: true,
-      onDelete: "SET NULL",
-      orphanedRowAction: "nullify",
-    },
-  )
-  @JoinColumn({ name: "createdByUserId" })
-  public createdByUser?: User = undefined;
+  @Column({
+    nullable: true,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public modelName?: string = undefined;
 
   @ColumnAccessControl({
-    create: [],
-    read: [
+    create: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.CreateProjectLlm,
+    ],
+    read: [Permission.Public],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditProjectLlm,
     ],
-    update: [],
   })
   @TableColumn({
-    type: TableColumnType.ObjectID,
-    title: "Created by User ID",
+    required: false,
+    type: TableColumnType.ShortURL,
+    title: "Base URL",
     description:
-      "User ID who created this object (if this object was created by a User)",
+      "The base URL for the LLM API. Required for Ollama, optional for others.",
   })
   @Column({
-    type: ColumnType.ObjectID,
     nullable: true,
-    transformer: ObjectID.getDatabaseTransformer(),
+    type: ColumnType.ShortURL,
+    length: ColumnLength.ShortURL,
   })
-  public createdByUserId?: ObjectID = undefined;
+  public baseUrl?: string = undefined;
 
   @ColumnAccessControl({
-    create: [],
-    read: [
+    create: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.CreateProjectLlm,
     ],
+    read: [Permission.Public],
     update: [],
   })
   @TableColumn({
-    manyToOneRelationColumn: "deletedByUserId",
     type: TableColumnType.Entity,
-    title: "Deleted by User",
-    modelType: User,
+    required: false,
+    modelType: Project,
+    title: "Project",
     description:
-      "Relation to User who deleted this object (if this object was deleted by a User)",
+      "The project this LLM belongs to. If null, it is a global LLM.",
   })
   @ManyToOne(
     () => {
-      return User;
+      return Project;
     },
     {
       cascade: false,
       eager: false,
       nullable: true,
-      onDelete: "SET NULL",
+      onDelete: "CASCADE",
       orphanedRowAction: "nullify",
     },
   )
-  @JoinColumn({ name: "deletedByUserId" })
-  public deletedByUser?: User = undefined;
+  @JoinColumn({ name: "projectId" })
+  public project?: Project = undefined;
 
   @ColumnAccessControl({
-    create: [],
-    read: [
+    create: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.CreateProjectLlm,
     ],
+    read: [Permission.Public],
     update: [],
   })
   @TableColumn({
     type: TableColumnType.ObjectID,
-    title: "Deleted by User ID",
+    required: false,
+    canReadOnRelationQuery: true,
+    title: "Project ID",
     description:
-      "User ID who deleted this object (if this object was deleted by a User)",
+      "ID of the project this LLM belongs to. If null, it is a global LLM.",
   })
   @Column({
     type: ColumnType.ObjectID,
     nullable: true,
     transformer: ObjectID.getDatabaseTransformer(),
   })
-  public deletedByUserId?: ObjectID = undefined;
+  public projectId?: ObjectID = undefined;
 
   @ColumnAccessControl({
     create: [],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
-    ],
+    read: [],
     update: [],
   })
-  @TableColumn({
-    manyToOneRelationColumn: "serviceCatalogId",
-    type: TableColumnType.Entity,
-    required: false,
-    modelType: ServiceCatalog,
-    title: "Service Catalog",
-    description:
-      "Relation to Service Catalog Resource in which this object belongs",
-  })
+  @TableColumn({ type: TableColumnType.Entity, modelType: User })
   @ManyToOne(
     () => {
-      return ServiceCatalog;
+      return User;
     },
     {
+      cascade: false,
       eager: false,
       nullable: true,
-      onDelete: "CASCADE",
+      onDelete: "SET NULL",
       orphanedRowAction: "nullify",
     },
   )
-  @JoinColumn({ name: "serviceCatalogId" })
-  public serviceCatalog?: ServiceCatalog = undefined;
+  @JoinColumn({ name: "deletedByUserId" })
+  public deletedByUser?: User = undefined;
 
   @ColumnAccessControl({
     create: [],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
-    ],
+    read: [],
     update: [],
   })
-  @Index()
   @TableColumn({
     type: TableColumnType.ObjectID,
-    required: false,
-    canReadOnRelationQuery: true,
-    title: "Service Catalog ID",
+    title: "Deleted by User ID",
     description:
-      "ID of your OneUptime ServiceCatalog in which this object belongs",
+      "User ID who deleted this object (if this object was deleted by a User)",
   })
   @Column({
     type: ColumnType.ObjectID,
     nullable: true,
     transformer: ObjectID.getDatabaseTransformer(),
   })
-  public serviceCatalogId?: ObjectID = undefined;
+  public deletedByUserId?: ObjectID = undefined;
 
   @ColumnAccessControl({
-    create: [],
-    read: [
+    create: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.CreateProjectLlm,
     ],
+    read: [Permission.ProjectOwner],
     update: [],
   })
-  @TableColumn({
-    manyToOneRelationColumn: "serviceRepositoryId",
-    type: TableColumnType.Entity,
-    required: false,
-    modelType: ServiceCopilotCodeRepository,
-    title: "Service Repository",
-    description:
-      "Relation to Service Repository Resource in which this object belongs",
-  })
+  @TableColumn({ type: TableColumnType.Entity, modelType: User })
   @ManyToOne(
     () => {
-      return ServiceCopilotCodeRepository;
+      return User;
     },
     {
       eager: false,
       nullable: true,
-      onDelete: "CASCADE",
+      onDelete: "SET NULL",
       orphanedRowAction: "nullify",
     },
   )
-  @JoinColumn({ name: "serviceRepositoryId" })
-  public serviceRepository?: ServiceCopilotCodeRepository = undefined;
+  @JoinColumn({ name: "createdByUserId" })
+  public createdByUser?: User = undefined;
 
   @ColumnAccessControl({
-    create: [],
-    read: [
+    create: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.CreateProjectLlm,
     ],
+    read: [Permission.ProjectOwner],
     update: [],
   })
-  @Index()
   @TableColumn({
     type: TableColumnType.ObjectID,
-    required: false,
-    canReadOnRelationQuery: true,
-    title: "Service Repository ID",
+    title: "Created by User ID",
     description:
-      "ID of your OneUptime Service Repository in which this object belongs",
+      "User ID who created this object (if this object was created by a User)",
   })
   @Column({
     type: ColumnType.ObjectID,
     nullable: true,
     transformer: ObjectID.getDatabaseTransformer(),
   })
-  public serviceRepositoryId?: ObjectID = undefined;
+  public createdByUserId?: ObjectID = undefined;
 
   @ColumnAccessControl({
     create: [],
-    read: [
-      Permission.ProjectOwner,
-      Permission.ProjectAdmin,
-      Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
-    ],
+    read: [],
     update: [],
   })
   @TableColumn({
-    type: TableColumnType.ShortText,
-    required: false,
-    isDefaultValueColumn: false,
+    isDefaultValueColumn: true,
+    required: true,
+    type: TableColumnType.Boolean,
     canReadOnRelationQuery: true,
-    title: "Pull Request ID",
+    title: "Is Global LLM",
     description:
-      "ID of Pull Request in the repository where this event was executed and then PR was created.",
+      "Is this a global LLM that is available to all projects? Only admins can create global LLMs.",
+    defaultValue: false,
   })
   @Column({
-    type: ColumnType.ShortText,
-    nullable: true,
+    type: ColumnType.Boolean,
+    nullable: false,
+    unique: false,
+    default: false,
   })
-  public pullRequestId?: string = undefined;
+  public isGlobalLlm?: boolean = undefined;
 
   @ColumnAccessControl({
-    create: [],
-    read: [
+    create: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.CreateProjectLlm,
     ],
-    update: [],
-  })
-  @TableColumn({
-    type: TableColumnType.ShortText,
-    title: "Copilot Event Status",
-    canReadOnRelationQuery: true,
-    description:
-      "Status of Copilot Event that was triggered for this file in Code Repository",
-  })
-  @Column({
-    type: ColumnType.ShortText,
-    nullable: false,
-  })
-  public copilotPullRequestStatus?: PullRequestState = undefined;
-
-  @ColumnAccessControl({
-    create: [],
-    read: [
+    read: [Permission.Public],
+    update: [
       Permission.ProjectOwner,
       Permission.ProjectAdmin,
       Permission.ProjectMember,
-      Permission.ReadCopilotPullRequest,
+      Permission.EditProjectLlm,
     ],
-    update: [],
   })
   @TableColumn({
+    isDefaultValueColumn: true,
+    required: true,
     type: TableColumnType.Boolean,
-    title: "Is Setup Pull Request",
-    required: false,
+    title: "Is Default",
     description:
-      "Is this pull request created by Copilot for setting up the repository?",
+      "Is this the default LLM provider for the project? When set, the global LLM provider will not be used.",
+    defaultValue: false,
   })
   @Column({
     type: ColumnType.Boolean,
-    nullable: true,
+    nullable: false,
+    unique: false,
+    default: false,
   })
-  public isSetupPullRequest?: boolean = undefined;
+  public isDefault?: boolean = undefined;
 }