@oneuptime/common 7.0.2928 → 7.0.2936

package/Models/{BaseModel.ts → DatabaseModels/DatabaseBaseModel/DatabaseBaseModel.ts}

@@ -1,30 +1,32 @@
-import Route from "../Types/API/Route";
-import { ColumnAccessControl } from "../Types/BaseDatabase/AccessControl";
-import ColumnBillingAccessControl from "../Types/BaseDatabase/ColumnBillingAccessControl";
-import EnableWorkflowOn from "../Types/BaseDatabase/EnableWorkflowOn";
-import ModelPermission from "../Types/BaseDatabase/ModelPermission";
-import { PlanType } from "../Types/Billing/SubscriptionPlan";
-import { getColumnAccessControlForAllColumns } from "../Types/Database/AccessControl/ColumnAccessControl";
-import { getColumnBillingAccessControlForAllColumns } from "../Types/Database/AccessControl/ColumnBillingAccessControl";
-import Columns from "../Types/Database/Columns";
+import Route from "../../../Types/API/Route";
+import { ColumnAccessControl } from "../../../Types/BaseDatabase/AccessControl";
+import ColumnBillingAccessControl from "../../../Types/BaseDatabase/ColumnBillingAccessControl";
+import EnableWorkflowOn from "../../../Types/BaseDatabase/EnableWorkflowOn";
+import ModelPermission from "../../../Types/BaseDatabase/ModelPermission";
+import { PlanType } from "../../../Types/Billing/SubscriptionPlan";
+import { getColumnAccessControlForAllColumns } from "../../../Types/Database/AccessControl/ColumnAccessControl";
+import { getColumnBillingAccessControlForAllColumns } from "../../../Types/Database/AccessControl/ColumnBillingAccessControl";
+import Columns from "../../../Types/Database/Columns";
 import TableColumn, {
   TableColumnMetadata,
   getTableColumn,
   getTableColumns,
-} from "../Types/Database/TableColumn";
-import TableColumnType from "../Types/Database/TableColumnType";
-import Dictionary from "../Types/Dictionary";
-import Email from "../Types/Email";
-import BadDataException from "../Types/Exception/BadDataException";
-import HashedString from "../Types/HashedString";
-import IconProp from "../Types/Icon/IconProp";
-import { JSONArray, JSONObject, JSONValue } from "../Types/JSON";
-import JSONFunctions from "../Types/JSONFunctions";
-import ObjectID from "../Types/ObjectID";
-import Permission, { UserTenantAccessPermission } from "../Types/Permission";
-import Phone from "../Types/Phone";
-import PositiveNumber from "../Types/PositiveNumber";
-import Text from "../Types/Text";
+} from "../../../Types/Database/TableColumn";
+import TableColumnType from "../../../Types/Database/TableColumnType";
+import Dictionary from "../../../Types/Dictionary";
+import Email from "../../../Types/Email";
+import BadDataException from "../../../Types/Exception/BadDataException";
+import HashedString from "../../../Types/HashedString";
+import IconProp from "../../../Types/Icon/IconProp";
+import { JSONArray, JSONObject, JSONValue } from "../../../Types/JSON";
+import JSONFunctions from "../../../Types/JSONFunctions";
+import ObjectID from "../../../Types/ObjectID";
+import Permission, {
+  UserTenantAccessPermission,
+} from "../../../Types/Permission";
+import Phone from "../../../Types/Phone";
+import PositiveNumber from "../../../Types/PositiveNumber";
+import Text from "../../../Types/Text";
 import {
   BaseEntity,
   CreateDateColumn,
@@ -34,8 +36,6 @@ import {
   VersionColumn,
 } from "typeorm";
 
-export type BaseModelType = { new (): BaseModel };
-
 export type DbTypes =
   | string
   | number
@@ -49,7 +49,7 @@ export type DbTypes =
   | JSONArray
   | Buffer;
 
-export default class BaseModel extends BaseEntity {
+export default class DatabaseBaseModel extends BaseEntity {
   @TableColumn({
     title: "ID",
     type: TableColumnType.ObjectID,
@@ -348,7 +348,7 @@ export default class BaseModel extends BaseEntity {
 
   public getColumnValue(
     columnName: string,
-  ): JSONValue | BaseModel | Array<BaseModel> | null {
+  ): JSONValue | DatabaseBaseModel | Array<DatabaseBaseModel> | null {
     if (getTableColumn(this, columnName) && (this as any)[columnName]) {
       return (this as any)[columnName] as JSONValue;
     }
@@ -358,7 +358,7 @@ export default class BaseModel extends BaseEntity {
 
   public setColumnValue(
     columnName: string,
-    value: JSONValue | BaseModel | Array<BaseModel>,
+    value: JSONValue | DatabaseBaseModel | Array<DatabaseBaseModel>,
   ): void {
     if (getTableColumn(this, columnName)) {
       return ((this as any)[columnName] = value as any);
@@ -412,7 +412,7 @@ export default class BaseModel extends BaseEntity {
       return false;
     }
 
-    const fileModel: BaseModel = new tableColumnType.modelType();
+    const fileModel: DatabaseBaseModel = new tableColumnType.modelType();
 
     if (fileModel.isFileModel()) {
       return true;
@@ -547,18 +547,21 @@ export default class BaseModel extends BaseEntity {
     return Text.pascalCaseToDashes(this.tableName as string);
   }
 
-  public static toJSON(model: BaseModel, modelType: BaseModelType): JSONObject {
+  public static toJSON(
+    model: DatabaseBaseModel,
+    modelType: DatabaseBaseModelType,
+  ): JSONObject {
     const json: JSONObject = this.toJSONObject(model, modelType);
     return JSONFunctions.serialize(json);
   }
 
   public static toJSONObject(
-    model: BaseModel,
-    modelType: BaseModelType,
+    model: DatabaseBaseModel,
+    modelType: DatabaseBaseModelType,
   ): JSONObject {
     const json: JSONObject = {};
 
-    const vanillaModel: BaseModel = new modelType();
+    const vanillaModel: DatabaseBaseModel = new modelType();
 
     for (const key of vanillaModel.getTableColumns().columns) {
       if ((model as any)[key] === undefined) {
@@ -573,7 +576,7 @@ export default class BaseModel extends BaseEntity {
           (model as any)[key] &&
           tableColumnMetadata.modelType &&
           tableColumnMetadata.type === TableColumnType.Entity &&
-          (model as any)[key] instanceof BaseModel
+          (model as any)[key] instanceof DatabaseBaseModel
         ) {
           (json as any)[key] = this.toJSONObject(
             (model as any)[key],
@@ -587,7 +590,7 @@ export default class BaseModel extends BaseEntity {
           tableColumnMetadata.type === TableColumnType.EntityArray
         ) {
           (json as any)[key] = this.toJSONObjectArray(
-            (model as any)[key] as Array<BaseModel>,
+            (model as any)[key] as Array<DatabaseBaseModel>,
             tableColumnMetadata.modelType,
           );
         } else {
@@ -600,8 +603,8 @@ export default class BaseModel extends BaseEntity {
   }
 
   public static toJSONObjectArray(
-    list: Array<BaseModel>,
-    modelType: BaseModelType,
+    list: Array<DatabaseBaseModel>,
+    modelType: DatabaseBaseModelType,
   ): JSONArray {
     const array: JSONArray = [];
 
@@ -613,8 +616,8 @@ export default class BaseModel extends BaseEntity {
   }
 
   public static toJSONArray(
-    list: Array<BaseModel>,
-    modelType: BaseModelType,
+    list: Array<DatabaseBaseModel>,
+    modelType: DatabaseBaseModelType,
   ): JSONArray {
     const array: JSONArray = [];
 
@@ -625,11 +628,11 @@ export default class BaseModel extends BaseEntity {
     return array;
   }
 
-  private static _fromJSON<T extends BaseModel>(
+  private static _fromJSON<T extends DatabaseBaseModel>(
     json: JSONObject | T,
     type: { new (): T },
   ): T {
-    if (json instanceof BaseModel) {
+    if (json instanceof DatabaseBaseModel) {
       return json;
     }
 
@@ -679,15 +682,15 @@ export default class BaseModel extends BaseEntity {
     return baseModel as T;
   }
 
-  public static fromJSON<T extends BaseModel>(
-    json: JSONObject | JSONArray | BaseModel | Array<BaseModel>,
+  public static fromJSON<T extends DatabaseBaseModel>(
+    json: JSONObject | JSONArray | DatabaseBaseModel | Array<DatabaseBaseModel>,
     type: { new (): T },
   ): T | Array<T> {
     if (Array.isArray(json)) {
       const arr: Array<T> = [];
 
       for (const item of json) {
-        if (item instanceof BaseModel) {
+        if (item instanceof DatabaseBaseModel) {
           arr.push(item as T);
           continue;
         }
@@ -698,25 +701,25 @@ export default class BaseModel extends BaseEntity {
       return arr;
     }
 
-    if (json instanceof BaseModel) {
+    if (json instanceof DatabaseBaseModel) {
       return json as T;
     }
 
     return this._fromJSON<T>(json, type);
   }
 
-  public static fromJSONObject<T extends BaseModel>(
+  public static fromJSONObject<T extends DatabaseBaseModel>(
     json: JSONObject | T,
     type: { new (): T },
   ): T {
-    if (json instanceof BaseModel) {
+    if (json instanceof DatabaseBaseModel) {
       return json;
     }
 
     return this.fromJSON<T>(json, type) as T;
   }
 
-  public static fromJSONArray<T extends BaseModel>(
+  public static fromJSONArray<T extends DatabaseBaseModel>(
     json: Array<JSONObject | T>,
     type: { new (): T },
   ): Array<T> {
@@ -729,3 +732,5 @@ export default class BaseModel extends BaseEntity {
     return arr;
   }
 }
+
+export type DatabaseBaseModelType = { new (): DatabaseBaseModel };

package/Models/{FileModel.ts → DatabaseModels/DatabaseBaseModel/FileModel.ts}

@@ -1,13 +1,13 @@
-import ColumnAccessControl from "../Types/Database/AccessControl/ColumnAccessControl";
-import ColumnLength from "../Types/Database/ColumnLength";
-import ColumnType from "../Types/Database/ColumnType";
-import SlugifyColumn from "../Types/Database/SlugifyColumn";
-import TableColumn from "../Types/Database/TableColumn";
-import TableColumnType from "../Types/Database/TableColumnType";
-import MimeType from "../Types/File/MimeType";
-import ObjectID from "../Types/ObjectID";
-import Permission from "../Types/Permission";
-import BaseModel from "./BaseModel";
+import ColumnAccessControl from "../../../Types/Database/AccessControl/ColumnAccessControl";
+import ColumnLength from "../../../Types/Database/ColumnLength";
+import ColumnType from "../../../Types/Database/ColumnType";
+import SlugifyColumn from "../../../Types/Database/SlugifyColumn";
+import TableColumn from "../../../Types/Database/TableColumn";
+import TableColumnType from "../../../Types/Database/TableColumnType";
+import MimeType from "../../../Types/File/MimeType";
+import ObjectID from "../../../Types/ObjectID";
+import Permission from "../../../Types/Permission";
+import BaseModel from "./DatabaseBaseModel";
 import { Column } from "typeorm";
 
 @SlugifyColumn("name", "slug")

package/Models/{GlobalConfig.ts → DatabaseModels/DatabaseBaseModel/GlobalConfig.ts}

@@ -1,5 +1,5 @@
-import ObjectID from "../Types/ObjectID";
-import BaseModel from "./BaseModel";
+import ObjectID from "../../../Types/ObjectID";
+import BaseModel from "./DatabaseBaseModel";
 
 export default class GlobalConfig extends BaseModel {
   public constructor(id?: ObjectID) {

package/Models/{TenantModel.ts → DatabaseModels/DatabaseBaseModel/TenantModel.ts}

@@ -1,5 +1,5 @@
-import ObjectID from "../Types/ObjectID";
-import BaseModel from "./BaseModel";
+import ObjectID from "../../../Types/ObjectID";
+import BaseModel from "./DatabaseBaseModel";
 
 export default class TenantModel extends BaseModel {
   public constructor(id?: ObjectID) {

package/Models/{UserModel.ts → DatabaseModels/DatabaseBaseModel/UserModel.ts}

@@ -1,5 +1,5 @@
-import ObjectID from "../Types/ObjectID";
-import BaseModel from "./BaseModel";
+import ObjectID from "../../../Types/ObjectID";
+import BaseModel from "./DatabaseBaseModel";
 
 export default class UserModel extends BaseModel {
   public constructor(id?: ObjectID) {

package/Models/DatabaseModels/Domain.ts

@@ -0,0 +1,354 @@
+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 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 DomainType from "../../Types/Domain";
+import IconProp from "../../Types/Icon/IconProp";
+import ObjectID from "../../Types/ObjectID";
+import Permission from "../../Types/Permission";
+import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
+
+@EnableDocumentation()
+@TenantColumn("projectId")
+@TableAccessControl({
+  create: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.CreateProjectDomain,
+  ],
+  read: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.ReadProjectDomain,
+  ],
+  delete: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.DeleteProjectDomain,
+  ],
+  update: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.EditProjectDomain,
+  ],
+})
+@CrudApiEndpoint(new Route("/domain"))
+@SlugifyColumn("name", "slug")
+@TableMetadata({
+  tableName: "Domain",
+  singularName: "Domain",
+  pluralName: "Domains",
+  icon: IconProp.Globe,
+  tableDescription: "Manage Custom Domains for your project",
+})
+@Entity({
+  name: "Domain",
+})
+export default class Domain extends BaseModel {
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateProjectDomain,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectDomain,
+    ],
+    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" })
+  public project?: Project = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateProjectDomain,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectDomain,
+    ],
+    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(),
+  })
+  public projectId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateProjectDomain,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectDomain,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditProjectDomain,
+    ],
+  })
+  @TableColumn({
+    required: true,
+    type: TableColumnType.Domain,
+    canReadOnRelationQuery: true,
+    title: "Domain",
+    description: "Domain - acmeinc.com for example.",
+  })
+  @Column({
+    nullable: false,
+    type: ColumnType.Domain,
+    length: ColumnLength.Domain,
+    transformer: DomainType.getDatabaseTransformer(),
+  })
+  @UniqueColumnBy("projectId")
+  public domain?: DomainType = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectDomain,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    required: true,
+    unique: true,
+    type: TableColumnType.Slug,
+    title: "Slug",
+    description: "Friendly globally unique name for your object",
+  })
+  @Column({
+    nullable: false,
+    type: ColumnType.Slug,
+    length: ColumnLength.Slug,
+  })
+  public slug?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateProjectDomain,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectDomain,
+    ],
+    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: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "createdByUserId" })
+  public createdByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateProjectDomain,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectDomain,
+    ],
+    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(),
+  })
+  public createdByUserId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectDomain,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "deletedByUserId",
+    type: TableColumnType.Entity,
+    title: "Deleted by 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: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "deletedByUserId" })
+  public deletedByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectDomain,
+    ],
+    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(),
+  })
+  public deletedByUserId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectDomain,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditProjectDomain,
+    ],
+  })
+  @TableColumn({
+    isDefaultValueColumn: true,
+    type: TableColumnType.Boolean,
+    title: "Verified",
+    description: "Is this domain verified?",
+  })
+  @Column({
+    type: ColumnType.Boolean,
+    default: false,
+  })
+  public isVerified?: boolean = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateProjectDomain,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadProjectDomain,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ShortText,
+    title: "Domain Verification Text",
+    description:
+      "Verification text that you need to add to your domains TXT record to veify the domain.",
+  })
+  @Column({
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+    nullable: false,
+    unique: true,
+  })
+  public domainVerificationText?: string = undefined;
+}