@oneuptime/common 9.2.15 → 9.2.17

package/Models/DatabaseModels/ServiceCatalogCodeRepository.ts

@@ -0,0 +1,549 @@
+import Project from "./Project";
+import User from "./User";
+import BaseModel from "./DatabaseBaseModel/DatabaseBaseModel";
+import Route from "../../Types/API/Route";
+import { PlanType } from "../../Types/Billing/SubscriptionPlan";
+import ColumnAccessControl from "../../Types/Database/AccessControl/ColumnAccessControl";
+import TableAccessControl from "../../Types/Database/AccessControl/TableAccessControl";
+import TableBillingAccessControl from "../../Types/Database/AccessControl/TableBillingAccessControl";
+import CanAccessIfCanReadOn from "../../Types/Database/CanAccessIfCanReadOn";
+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 { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
+import ServiceCatalog from "./ServiceCatalog";
+import CodeRepository from "./CodeRepository";
+import CodeRepositoryImprovementAction from "../../Types/ServiceCatalog/CodeRepositoryImprovementAction";
+
+@CanAccessIfCanReadOn("serviceCatalog")
+@EnableDocumentation()
+@TenantColumn("projectId")
+@TableBillingAccessControl({
+  create: PlanType.Growth,
+  read: PlanType.Growth,
+  update: PlanType.Growth,
+  delete: PlanType.Growth,
+})
+@TableAccessControl({
+  create: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.CreateServiceCatalogCodeRepository,
+  ],
+  read: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.ReadServiceCatalogCodeRepository,
+  ],
+  delete: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.DeleteServiceCatalogCodeRepository,
+  ],
+  update: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.EditServiceCatalogCodeRepository,
+  ],
+})
+@EnableWorkflow({
+  create: true,
+  delete: true,
+  update: true,
+  read: true,
+})
+@CrudApiEndpoint(new Route("/service-catalog-code-repository"))
+@TableMetadata({
+  tableName: "ServiceCatalogCodeRepository",
+  singularName: "Service Catalog Code Repository",
+  pluralName: "Service Catalog Code Repositories",
+  icon: IconProp.Code,
+  tableDescription:
+    "Link code repositories to service catalog items with the path where the service code lives.",
+})
+@Entity({
+  name: "ServiceCatalogCodeRepository",
+})
+export default class ServiceCatalogCodeRepository extends BaseModel {
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "projectId",
+    type: TableColumnType.Entity,
+    modelType: Project,
+    title: "Project",
+    description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
+  })
+  @ManyToOne(
+    () => {
+      return Project;
+    },
+    {
+      eager: false,
+      nullable: false,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "projectId" })
+  public project?: Project = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    canReadOnRelationQuery: true,
+    title: "Project ID",
+    description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public projectId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "serviceCatalogId",
+    type: TableColumnType.Entity,
+    modelType: ServiceCatalog,
+    title: "Service Catalog",
+    description:
+      "Relation to Service Catalog Resource in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
+  })
+  @ManyToOne(
+    () => {
+      return ServiceCatalog;
+    },
+    {
+      eager: false,
+      nullable: false,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "serviceCatalogId" })
+  public serviceCatalog?: ServiceCatalog = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    canReadOnRelationQuery: true,
+    title: "Service Catalog ID",
+    description:
+      "ID of your OneUptime Service Catalog in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public serviceCatalogId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "codeRepositoryId",
+    type: TableColumnType.Entity,
+    modelType: CodeRepository,
+    title: "Code Repository",
+    description: "Relation to Code Repository in which this object belongs",
+    example: "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
+  })
+  @ManyToOne(
+    () => {
+      return CodeRepository;
+    },
+    {
+      eager: false,
+      nullable: false,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "codeRepositoryId" })
+  public codeRepository?: CodeRepository = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    canReadOnRelationQuery: true,
+    title: "Code Repository ID",
+    description: "ID of your Code Repository in which this object belongs",
+    example: "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public codeRepositoryId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditServiceCatalogCodeRepository,
+    ],
+  })
+  @TableColumn({
+    type: TableColumnType.LongText,
+    required: false,
+    title: "Service Path in Repository",
+    description:
+      "The path in the repository where the service code lives (e.g., /services/api or /src/backend)",
+    example: "/services/api",
+  })
+  @Column({
+    type: ColumnType.LongText,
+    nullable: true,
+  })
+  public servicePathInRepository?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "createdByUserId",
+    type: TableColumnType.Entity,
+    modelType: User,
+    title: "Created by User",
+    description:
+      "Relation to User who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
+  })
+  @ManyToOne(
+    () => {
+      return User;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "createdByUserId" })
+  public createdByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Created by User ID",
+    description:
+      "User ID who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public createdByUserId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "deletedByUserId",
+    type: TableColumnType.Entity,
+    title: "Deleted by User",
+    modelType: User,
+    description:
+      "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
+  })
+  @ManyToOne(
+    () => {
+      return User;
+    },
+    {
+      cascade: false,
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "deletedByUserId" })
+  public deletedByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Deleted by User ID",
+    description:
+      "User ID who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public deletedByUserId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditServiceCatalogCodeRepository,
+    ],
+  })
+  @TableColumn({
+    type: TableColumnType.Boolean,
+    required: false,
+    isDefaultValueColumn: true,
+    title: "Enable Automatic Code Improvements",
+    description:
+      "Enable OneUptime to automatically create pull requests to improve the code for this service.",
+  })
+  @Column({
+    type: ColumnType.Boolean,
+    nullable: false,
+    default: true,
+  })
+  public enableAutomaticImprovements?: boolean = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditServiceCatalogCodeRepository,
+    ],
+  })
+  @TableColumn({
+    type: TableColumnType.Number,
+    required: false,
+    isDefaultValueColumn: true,
+    title: "Max Open Pull Requests",
+    description:
+      "Maximum number of open pull requests that OneUptime can create for this service at any given time.",
+  })
+  @Column({
+    type: ColumnType.Number,
+    nullable: false,
+    default: 3,
+  })
+  public maxOpenPullRequests?: number = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.CreateServiceCatalogCodeRepository,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadServiceCatalogCodeRepository,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.EditServiceCatalogCodeRepository,
+    ],
+  })
+  @TableColumn({
+    type: TableColumnType.JSON,
+    required: false,
+    isDefaultValueColumn: false,
+    title: "Restricted Improvement Actions",
+    description:
+      "Restrict code improvements to only these actions. If empty, all improvement actions are allowed.",
+  })
+  @Column({
+    type: ColumnType.JSON,
+    nullable: true,
+  })
+  public restrictedImprovementActions?: Array<CodeRepositoryImprovementAction> =
+    undefined;
+}

package/Models/DatabaseModels/ServiceCatalogDependency.ts

@@ -100,6 +100,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -138,6 +139,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -169,6 +171,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     title: "Service Catalog",
     description:
       "Relation to Service Catalog Resource in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
   })
   @ManyToOne(
     () => {
@@ -208,6 +211,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     title: "Service Catalog ID",
     description:
       "ID of your OneUptime Service Catalog in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -239,6 +243,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     title: "Service Catalog",
     description:
       "Relation to Service Catalog Resource in which this object belongs",
+    example: "a7b8c9d0-e1f2-3456-ab78-cd90ef123456",
   })
   @ManyToOne(
     () => {
@@ -278,6 +283,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     title: "Dependency Service Catalog ID",
     description:
       "ID of your OneUptime Service Catalog in which this object belongs",
+    example: "a7b8c9d0-e1f2-3456-ab78-cd90ef123456",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -309,6 +315,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
   })
   @ManyToOne(
     () => {
@@ -345,6 +352,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -371,6 +379,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
   })
   @ManyToOne(
     () => {
@@ -403,6 +412,7 @@ export default class ServiceCatlogDependency extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
   })
   @Column({
     type: ColumnType.ObjectID,

package/Models/DatabaseModels/ServiceCatalogMonitor.ts

@@ -100,6 +100,7 @@ export default class ServiceCatalogMonitor extends BaseModel {
     modelType: Project,
     title: "Project",
     description: "Relation to Project Resource in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @ManyToOne(
     () => {
@@ -138,6 +139,7 @@ export default class ServiceCatalogMonitor extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Project ID",
     description: "ID of your OneUptime Project in which this object belongs",
+    example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -169,6 +171,7 @@ export default class ServiceCatalogMonitor extends BaseModel {
     title: "Service Catalog",
     description:
       "Relation to Service Catalog Resource in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
   })
   @ManyToOne(
     () => {
@@ -208,6 +211,7 @@ export default class ServiceCatalogMonitor extends BaseModel {
     title: "Service Catalog ID",
     description:
       "ID of your OneUptime Service Catalog in which this object belongs",
+    example: "f6a7b8c9-d0e1-2345-fa67-bc89de012345",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -238,6 +242,7 @@ export default class ServiceCatalogMonitor extends BaseModel {
     modelType: Monitor,
     title: "Monitor",
     description: "Relation to Monitor in which this object belongs",
+    example: "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
   })
   @ManyToOne(
     () => {
@@ -276,6 +281,7 @@ export default class ServiceCatalogMonitor extends BaseModel {
     canReadOnRelationQuery: true,
     title: "Monitor ID",
     description: "ID of your Monitorin which this object belongs",
+    example: "b8c9d0e1-f2a3-4567-bc89-de01fa234567",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -307,6 +313,7 @@ export default class ServiceCatalogMonitor extends BaseModel {
     title: "Created by User",
     description:
       "Relation to User who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
   })
   @ManyToOne(
     () => {
@@ -343,6 +350,7 @@ export default class ServiceCatalogMonitor extends BaseModel {
     title: "Created by User ID",
     description:
       "User ID who created this object (if this object was created by a User)",
+    example: "c3d4e5f6-a7b8-9012-cd34-ef56ab789012",
   })
   @Column({
     type: ColumnType.ObjectID,
@@ -369,6 +377,7 @@ export default class ServiceCatalogMonitor extends BaseModel {
     modelType: User,
     description:
       "Relation to User who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
   })
   @ManyToOne(
     () => {
@@ -401,6 +410,7 @@ export default class ServiceCatalogMonitor extends BaseModel {
     title: "Deleted by User ID",
     description:
       "User ID who deleted this object (if this object was deleted by a User)",
+    example: "d4e5f6a7-b8c9-0123-de45-fa67bc890123",
   })
   @Column({
     type: ColumnType.ObjectID,