@oneuptime/common 7.0.2525 → 7.0.2550

package/Models/BaseModel.ts

@@ -1,739 +1,731 @@
-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 { PlanSelect } 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 { PlanSelect } 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';
+  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";
 import {
-    BaseEntity,
-    CreateDateColumn,
-    DeleteDateColumn,
-    PrimaryGeneratedColumn,
-    UpdateDateColumn,
-    VersionColumn,
-} from 'typeorm';
+  BaseEntity,
+  CreateDateColumn,
+  DeleteDateColumn,
+  PrimaryGeneratedColumn,
+  UpdateDateColumn,
+  VersionColumn,
+} from "typeorm";
 
 export type BaseModelType = { new (): BaseModel };
 
 export type DbTypes =
-    | string
-    | number
-    | PositiveNumber
-    | Email
-    | HashedString
-    | URL
-    | Phone
-    | JSONObject
-    | ObjectID
-    | JSONArray
-    | Buffer;
+  | string
+  | number
+  | PositiveNumber
+  | Email
+  | HashedString
+  | URL
+  | Phone
+  | JSONObject
+  | ObjectID
+  | JSONArray
+  | Buffer;
 
 export default class BaseModel extends BaseEntity {
-    @TableColumn({
-        title: 'ID',
-        type: TableColumnType.ObjectID,
-        description: 'ID of this object',
-    })
-    @PrimaryGeneratedColumn('uuid')
-    public _id?: string = undefined;
-
-    @TableColumn({
-        title: 'Created',
-        type: TableColumnType.Date,
-        description: 'Date and Time when the object was created.',
-    })
-    @CreateDateColumn()
-    public createdAt?: Date = undefined;
-
-    @TableColumn({
-        title: 'Updated',
-        type: TableColumnType.Date,
-        description: 'Date and Time when the object was updated.',
-    })
-    @UpdateDateColumn()
-    public updatedAt?: Date = undefined;
-
-    @TableColumn({
-        title: 'Deleted',
-        type: TableColumnType.Date,
-        description: 'Date and Time when the object was deleted.',
-    })
-    @DeleteDateColumn()
-    public deletedAt?: Date = undefined;
-
-    @TableColumn({
-        title: 'Version',
-        type: TableColumnType.Version,
-        description: 'Object version',
-    })
-    @VersionColumn()
-    public version?: number = undefined;
-
-    public createRecordPermissions!: Array<Permission>;
-    public readRecordPermissions!: Array<Permission>;
-    public deleteRecordPermissions!: Array<Permission>;
-    public updateRecordPermissions!: Array<Permission>;
-
-    // Billing Plans.
-    public createBillingPlan!: PlanSelect | null;
-    public readBillingPlan!: PlanSelect | null;
-    public updateBillingPlan!: PlanSelect | null;
-    public deleteBillingPlan!: PlanSelect | null;
-
-    public allowAccessIfSubscriptionIsUnpaid!: boolean;
-
-    public enableWorkflowOn!: EnableWorkflowOn;
-
-    public enableDocumentation!: boolean;
-    public isMasterAdminApiDocs!: boolean;
-
-    public currentUserCanAccessColumnBy!: string | null;
-    public labelsColumn!: string | null;
-    public slugifyColumn!: string | null;
-    public saveSlugToColumn!: string | null;
-    public singularName!: string | null;
-    public pluralName!: string | null;
-
-    // total items  by
-    public totalItemsByColumnName!: string | null;
-    public totalItemsNumber!: number | null;
-    public totalItemsErrorMessage!: string | null;
-
-    public isPermissionIf: Dictionary<JSONObject> = {};
-
-    public isMultiTenantRequestAllowed!: boolean | null;
-    public allowUserQueryWithoutTenant!: boolean | null;
-
-    public crudApiPath!: Route | null;
-
-    // If this resource is by projectId, which column does projectId belong to?
-    public tenantColumn!: string | null;
-
-    public accessControlColumn!: string | null;
-
-    public icon!: IconProp | null;
-
-    public tableDescription!: string | null;
-
-    public tableName!: string | null;
-
-    public canAccessIfCanReadOn!: string | null;
-
-    public constructor(id?: ObjectID) {
-        super();
-        if (id) {
-            this.id = id;
-        }
-    }
-
-    public getHashedColumns(): Columns {
-        const dictionary: Dictionary<TableColumnMetadata> =
-            getTableColumns(this);
-        const columns: Array<string> = [];
-        for (const key in dictionary) {
-            if (dictionary[key]?.hashed) {
-                columns.push(key);
-            }
-        }
-
-        return new Columns(columns);
-    }
-
-    public getDisplayColumnPlaceholderAs(columnName: string): string | null {
-        return getTableColumn(this, columnName)?.placeholder || null;
-    }
-
-    public getDisplayColumnTitleAs(columnName: string): string | null {
-        return getTableColumn(this, columnName)?.title || null;
-    }
-
-    public getDisplayColumnDescriptionAs(columnName: string): string | null {
-        return getTableColumn(this, columnName)?.description || null;
-    }
-
-    public getEncryptedColumns(): Columns {
-        const dictionary: Dictionary<TableColumnMetadata> =
-            getTableColumns(this);
-        const columns: Array<string> = [];
-        for (const key in dictionary) {
-            if (dictionary[key]?.encrypted) {
-                columns.push(key);
-            }
-        }
-
-        return new Columns(columns);
-    }
-
-    public getTableColumns(): Columns {
-        return new Columns(Object.keys(getTableColumns(this)));
-    }
-
-    public canQueryMultiTenant(): boolean {
-        return Boolean(this.isMultiTenantRequestAllowed);
-    }
-
-    public isUserQueryWithoutTenantAllowed(): boolean {
-        return Boolean(this.allowUserQueryWithoutTenant);
-    }
-
-    public getTableColumnMetadata(columnName: string): TableColumnMetadata {
-        const dictionary: Dictionary<TableColumnMetadata> =
-            getTableColumns(this);
-        return dictionary[columnName] as TableColumnMetadata;
-    }
-
-    public hasColumn(columnName: string): boolean {
-        return Boolean(getTableColumn(this, columnName));
-    }
-
-    public getColumnBillingAccessControl(
-        columnName: string
-    ): ColumnBillingAccessControl {
-        const dictionary: Dictionary<ColumnBillingAccessControl> =
-            getColumnBillingAccessControlForAllColumns(this);
-        return dictionary[columnName] as ColumnBillingAccessControl;
-    }
-
-    public getColumnAccessControlFor(
-        columnName: string
-    ): ColumnAccessControl | null {
-        return this.getColumnAccessControlForAllColumns()[columnName] || null;
-    }
-
-    public getColumnAccessControlForAllColumns(): Dictionary<ColumnAccessControl> {
-        const dictionary: Dictionary<ColumnAccessControl> =
-            getColumnAccessControlForAllColumns(this);
-
-        const defaultColumns: Array<string> = [
-            '_id',
-            'createdAt',
-            'deletedAt',
-            'updatedAt',
-        ];
-
-        for (const key of defaultColumns) {
-            dictionary[key] = {
-                read: this.readRecordPermissions,
-                create: this.createRecordPermissions,
-                update: this.updateRecordPermissions,
-            };
-        }
-
-        return dictionary;
-    }
-
-    public hasValue(columnName: string): boolean {
-        return Boolean((this as any)[columnName]);
-    }
-
-    public getValue<T extends DbTypes>(columnName: string): T {
-        return (this as any)[columnName] as T;
-    }
-
-    public setValue<T extends DbTypes>(columnName: string, value: T): void {
-        (this as any)[columnName] = value;
-    }
-
-    public removeValue(columnName: string): void {
-        (this as any)[columnName] = undefined;
-    }
-
-    public doesPermissionHaveConditions(
-        permission: Permission
-    ): JSONObject | null {
-        return this.isPermissionIf[permission]
-            ? (this.isPermissionIf[permission] as JSONObject)
-            : null;
-    }
-
-    public getUniqueColumns(): Columns {
-        const dictionary: Dictionary<TableColumnMetadata> =
-            getTableColumns(this);
-        const columns: Array<string> = [];
-        for (const key in dictionary) {
-            if (dictionary[key]?.unique) {
-                columns.push(key);
-            }
-        }
-
-        return new Columns(columns);
-    }
-
-    public setSlugifyColumn(columnName: string): void {
-        this.slugifyColumn = columnName;
-    }
-
-    public getTotalItemsByColumnName(): string | null {
-        return this.totalItemsByColumnName;
-    }
-
-    public getTotalItemsByErrorMessage(): string | null {
-        return this.totalItemsErrorMessage;
-    }
-
-    public getTotalItemsNumber(): number | null {
-        return this.totalItemsNumber;
-    }
-
-    public getRequiredColumns(): Columns {
-        const dictionary: Dictionary<TableColumnMetadata> =
-            getTableColumns(this);
-        const columns: Array<string> = [];
-        for (const key in dictionary) {
-            if (dictionary[key]?.required) {
-                columns.push(key);
-            }
-        }
-
-        return new Columns(columns);
-    }
-
-    public getSlugifyColumn(): string | null {
-        return this.slugifyColumn;
-    }
-
-    public getCrudApiPath(): Route | null {
-        return this.crudApiPath;
-    }
-
-    public getSaveSlugToColumn(): string | null {
-        return this.saveSlugToColumn;
-    }
+  @TableColumn({
+    title: "ID",
+    type: TableColumnType.ObjectID,
+    description: "ID of this object",
+  })
+  @PrimaryGeneratedColumn("uuid")
+  public _id?: string = undefined;
+
+  @TableColumn({
+    title: "Created",
+    type: TableColumnType.Date,
+    description: "Date and Time when the object was created.",
+  })
+  @CreateDateColumn()
+  public createdAt?: Date = undefined;
+
+  @TableColumn({
+    title: "Updated",
+    type: TableColumnType.Date,
+    description: "Date and Time when the object was updated.",
+  })
+  @UpdateDateColumn()
+  public updatedAt?: Date = undefined;
+
+  @TableColumn({
+    title: "Deleted",
+    type: TableColumnType.Date,
+    description: "Date and Time when the object was deleted.",
+  })
+  @DeleteDateColumn()
+  public deletedAt?: Date = undefined;
+
+  @TableColumn({
+    title: "Version",
+    type: TableColumnType.Version,
+    description: "Object version",
+  })
+  @VersionColumn()
+  public version?: number = undefined;
+
+  public createRecordPermissions!: Array<Permission>;
+  public readRecordPermissions!: Array<Permission>;
+  public deleteRecordPermissions!: Array<Permission>;
+  public updateRecordPermissions!: Array<Permission>;
+
+  // Billing Plans.
+  public createBillingPlan!: PlanSelect | null;
+  public readBillingPlan!: PlanSelect | null;
+  public updateBillingPlan!: PlanSelect | null;
+  public deleteBillingPlan!: PlanSelect | null;
+
+  public allowAccessIfSubscriptionIsUnpaid!: boolean;
+
+  public enableWorkflowOn!: EnableWorkflowOn;
+
+  public enableDocumentation!: boolean;
+  public isMasterAdminApiDocs!: boolean;
+
+  public currentUserCanAccessColumnBy!: string | null;
+  public labelsColumn!: string | null;
+  public slugifyColumn!: string | null;
+  public saveSlugToColumn!: string | null;
+  public singularName!: string | null;
+  public pluralName!: string | null;
+
+  // total items  by
+  public totalItemsByColumnName!: string | null;
+  public totalItemsNumber!: number | null;
+  public totalItemsErrorMessage!: string | null;
+
+  public isPermissionIf: Dictionary<JSONObject> = {};
+
+  public isMultiTenantRequestAllowed!: boolean | null;
+  public allowUserQueryWithoutTenant!: boolean | null;
+
+  public crudApiPath!: Route | null;
+
+  // If this resource is by projectId, which column does projectId belong to?
+  public tenantColumn!: string | null;
+
+  public accessControlColumn!: string | null;
+
+  public icon!: IconProp | null;
+
+  public tableDescription!: string | null;
+
+  public tableName!: string | null;
+
+  public canAccessIfCanReadOn!: string | null;
+
+  public constructor(id?: ObjectID) {
+    super();
+    if (id) {
+      this.id = id;
+    }
+  }
+
+  public getHashedColumns(): Columns {
+    const dictionary: Dictionary<TableColumnMetadata> = getTableColumns(this);
+    const columns: Array<string> = [];
+    for (const key in dictionary) {
+      if (dictionary[key]?.hashed) {
+        columns.push(key);
+      }
+    }
+
+    return new Columns(columns);
+  }
+
+  public getDisplayColumnPlaceholderAs(columnName: string): string | null {
+    return getTableColumn(this, columnName)?.placeholder || null;
+  }
+
+  public getDisplayColumnTitleAs(columnName: string): string | null {
+    return getTableColumn(this, columnName)?.title || null;
+  }
+
+  public getDisplayColumnDescriptionAs(columnName: string): string | null {
+    return getTableColumn(this, columnName)?.description || null;
+  }
+
+  public getEncryptedColumns(): Columns {
+    const dictionary: Dictionary<TableColumnMetadata> = getTableColumns(this);
+    const columns: Array<string> = [];
+    for (const key in dictionary) {
+      if (dictionary[key]?.encrypted) {
+        columns.push(key);
+      }
+    }
 
-    public getTenantColumn(): string | null {
-        return this.tenantColumn;
-    }
+    return new Columns(columns);
+  }
+
+  public getTableColumns(): Columns {
+    return new Columns(Object.keys(getTableColumns(this)));
+  }
 
-    public getAccessControlColumn(): string | null {
-        return this.accessControlColumn;
-    }
+  public canQueryMultiTenant(): boolean {
+    return Boolean(this.isMultiTenantRequestAllowed);
+  }
 
-    public getUserColumn(): string | null {
-        return this.currentUserCanAccessColumnBy;
-    }
+  public isUserQueryWithoutTenantAllowed(): boolean {
+    return Boolean(this.allowUserQueryWithoutTenant);
+  }
 
-    public getLabelsColumn(): string | null {
-        return this.labelsColumn;
-    }
+  public getTableColumnMetadata(columnName: string): TableColumnMetadata {
+    const dictionary: Dictionary<TableColumnMetadata> = getTableColumns(this);
+    return dictionary[columnName] as TableColumnMetadata;
+  }
 
-    public get id(): ObjectID | null {
-        return this._id ? new ObjectID(this._id) : null;
-    }
+  public hasColumn(columnName: string): boolean {
+    return Boolean(getTableColumn(this, columnName));
+  }
 
-    public set id(value: ObjectID | null) {
-        if (value) {
-            this._id = value.toString();
-        }
-    }
+  public getColumnBillingAccessControl(
+    columnName: string,
+  ): ColumnBillingAccessControl {
+    const dictionary: Dictionary<ColumnBillingAccessControl> =
+      getColumnBillingAccessControlForAllColumns(this);
+    return dictionary[columnName] as ColumnBillingAccessControl;
+  }
 
-    public isDefaultValueColumn(columnName: string): boolean {
-        return Boolean(getTableColumn(this, columnName).isDefaultValueColumn);
-    }
+  public getColumnAccessControlFor(
+    columnName: string,
+  ): ColumnAccessControl | null {
+    return this.getColumnAccessControlForAllColumns()[columnName] || null;
+  }
 
-    public getColumnValue(
-        columnName: string
-    ): JSONValue | BaseModel | Array<BaseModel> | null {
-        if (getTableColumn(this, columnName) && (this as any)[columnName]) {
-            return (this as any)[columnName] as JSONValue;
-        }
+  public getColumnAccessControlForAllColumns(): Dictionary<ColumnAccessControl> {
+    const dictionary: Dictionary<ColumnAccessControl> =
+      getColumnAccessControlForAllColumns(this);
 
-        return null;
-    }
+    const defaultColumns: Array<string> = [
+      "_id",
+      "createdAt",
+      "deletedAt",
+      "updatedAt",
+    ];
 
-    public setColumnValue(
-        columnName: string,
-        value: JSONValue | BaseModel | Array<BaseModel>
-    ): void {
-        if (getTableColumn(this, columnName)) {
-            return ((this as any)[columnName] = value as any);
-        }
-    }
+    for (const key of defaultColumns) {
+      dictionary[key] = {
+        read: this.readRecordPermissions,
+        create: this.createRecordPermissions,
+        update: this.updateRecordPermissions,
+      };
+    }
+
+    return dictionary;
+  }
+
+  public hasValue(columnName: string): boolean {
+    return Boolean((this as any)[columnName]);
+  }
+
+  public getValue<T extends DbTypes>(columnName: string): T {
+    return (this as any)[columnName] as T;
+  }
+
+  public setValue<T extends DbTypes>(columnName: string, value: T): void {
+    (this as any)[columnName] = value;
+  }
+
+  public removeValue(columnName: string): void {
+    (this as any)[columnName] = undefined;
+  }
+
+  public doesPermissionHaveConditions(
+    permission: Permission,
+  ): JSONObject | null {
+    return this.isPermissionIf[permission]
+      ? (this.isPermissionIf[permission] as JSONObject)
+      : null;
+  }
+
+  public getUniqueColumns(): Columns {
+    const dictionary: Dictionary<TableColumnMetadata> = getTableColumns(this);
+    const columns: Array<string> = [];
+    for (const key in dictionary) {
+      if (dictionary[key]?.unique) {
+        columns.push(key);
+      }
+    }
+
+    return new Columns(columns);
+  }
+
+  public setSlugifyColumn(columnName: string): void {
+    this.slugifyColumn = columnName;
+  }
+
+  public getTotalItemsByColumnName(): string | null {
+    return this.totalItemsByColumnName;
+  }
+
+  public getTotalItemsByErrorMessage(): string | null {
+    return this.totalItemsErrorMessage;
+  }
+
+  public getTotalItemsNumber(): number | null {
+    return this.totalItemsNumber;
+  }
+
+  public getRequiredColumns(): Columns {
+    const dictionary: Dictionary<TableColumnMetadata> = getTableColumns(this);
+    const columns: Array<string> = [];
+    for (const key in dictionary) {
+      if (dictionary[key]?.required) {
+        columns.push(key);
+      }
+    }
+
+    return new Columns(columns);
+  }
+
+  public getSlugifyColumn(): string | null {
+    return this.slugifyColumn;
+  }
+
+  public getCrudApiPath(): Route | null {
+    return this.crudApiPath;
+  }
 
-    public isTableColumn(columnName: string): boolean {
-        return Boolean(getTableColumn(this, columnName));
-    }
+  public getSaveSlugToColumn(): string | null {
+    return this.saveSlugToColumn;
+  }
 
-    public isEntityColumn(columnName: string): boolean {
-        const tableColumnType: TableColumnMetadata = getTableColumn(
-            this,
-            columnName
-        );
+  public getTenantColumn(): string | null {
+    return this.tenantColumn;
+  }
 
-        if (!tableColumnType) {
-            throw new BadDataException(
-                'TableColumnMetadata not found for ' + columnName + ' column'
-            );
-        }
+  public getAccessControlColumn(): string | null {
+    return this.accessControlColumn;
+  }
 
-        return Boolean(
-            tableColumnType.type === TableColumnType.Entity ||
-                tableColumnType.type === TableColumnType.EntityArray
-        );
-    }
+  public getUserColumn(): string | null {
+    return this.currentUserCanAccessColumnBy;
+  }
 
-    public isHashedStringColumn(columnName: string): boolean {
-        const tableColumnType: TableColumnMetadata = getTableColumn(
-            this,
-            columnName
-        );
+  public getLabelsColumn(): string | null {
+    return this.labelsColumn;
+  }
 
-        if (!tableColumnType) {
-            throw new BadDataException(
-                'TableColumnMetadata not found for ' + columnName + ' column'
-            );
-        }
+  public get id(): ObjectID | null {
+    return this._id ? new ObjectID(this._id) : null;
+  }
 
-        return Boolean(tableColumnType.type === TableColumnType.HashedString);
+  public set id(value: ObjectID | null) {
+    if (value) {
+      this._id = value.toString();
     }
+  }
 
-    public isFileColumn(columnName: string): boolean {
-        const tableColumnType: TableColumnMetadata = getTableColumn(
-            this,
-            columnName
-        );
+  public isDefaultValueColumn(columnName: string): boolean {
+    return Boolean(getTableColumn(this, columnName).isDefaultValueColumn);
+  }
 
-        if (!tableColumnType || !tableColumnType.modelType) {
-            return false;
-        }
-
-        const fileModel: BaseModel = new tableColumnType.modelType();
-
-        if (fileModel.isFileModel()) {
-            return true;
-        }
-
-        return false;
+  public getColumnValue(
+    columnName: string,
+  ): JSONValue | BaseModel | Array<BaseModel> | null {
+    if (getTableColumn(this, columnName) && (this as any)[columnName]) {
+      return (this as any)[columnName] as JSONValue;
     }
 
-    public hasPermission(_permissions: Array<Permission>): boolean {
-        return false;
-    }
+    return null;
+  }
 
-    public isTenantModel(): boolean {
-        return false;
+  public setColumnValue(
+    columnName: string,
+    value: JSONValue | BaseModel | Array<BaseModel>,
+  ): void {
+    if (getTableColumn(this, columnName)) {
+      return ((this as any)[columnName] = value as any);
     }
+  }
 
-    public isFileModel(): boolean {
-        return false;
-    }
+  public isTableColumn(columnName: string): boolean {
+    return Boolean(getTableColumn(this, columnName));
+  }
 
-    public isAccessControlModel(): boolean {
-        return false;
-    }
+  public isEntityColumn(columnName: string): boolean {
+    const tableColumnType: TableColumnMetadata = getTableColumn(
+      this,
+      columnName,
+    );
 
-    public isUserModel(): boolean {
-        return false;
+    if (!tableColumnType) {
+      throw new BadDataException(
+        "TableColumnMetadata not found for " + columnName + " column",
+      );
     }
 
-    public hasCreatePermissions(
-        userProjectPermissions: UserTenantAccessPermission | Array<Permission>,
-        columnName?: string
-    ): boolean {
-        let modelPermission: Array<Permission> = this.createRecordPermissions;
-
-        if (columnName) {
-            const columnAccessControl: ColumnAccessControl | null =
-                this.getColumnAccessControlFor(columnName);
-            if (columnAccessControl) {
-                modelPermission = columnAccessControl.create;
-            }
-        }
-
-        return ModelPermission.hasPermissions(
-            userProjectPermissions,
-            modelPermission
-        );
-    }
+    return Boolean(
+      tableColumnType.type === TableColumnType.Entity ||
+        tableColumnType.type === TableColumnType.EntityArray,
+    );
+  }
 
-    public getReadPermissions(): Array<Permission> {
-        return this.readRecordPermissions;
-    }
+  public isHashedStringColumn(columnName: string): boolean {
+    const tableColumnType: TableColumnMetadata = getTableColumn(
+      this,
+      columnName,
+    );
 
-    public getReadBillingPlan(): PlanSelect | null {
-        return this.readBillingPlan;
+    if (!tableColumnType) {
+      throw new BadDataException(
+        "TableColumnMetadata not found for " + columnName + " column",
+      );
     }
 
-    public getCreateBillingPlan(): PlanSelect | null {
-        return this.createBillingPlan;
-    }
+    return Boolean(tableColumnType.type === TableColumnType.HashedString);
+  }
 
-    public getUpdateBillingPlan(): PlanSelect | null {
-        return this.updateBillingPlan;
-    }
+  public isFileColumn(columnName: string): boolean {
+    const tableColumnType: TableColumnMetadata = getTableColumn(
+      this,
+      columnName,
+    );
 
-    public getDeleteBillingPlan(): PlanSelect | null {
-        return this.deleteBillingPlan;
+    if (!tableColumnType || !tableColumnType.modelType) {
+      return false;
     }
 
-    public getCreatePermissions(): Array<Permission> {
-        return this.createRecordPermissions;
-    }
+    const fileModel: BaseModel = new tableColumnType.modelType();
 
-    public getUpdatePermissions(): Array<Permission> {
-        return this.updateRecordPermissions;
+    if (fileModel.isFileModel()) {
+      return true;
     }
 
-    public getDeletePermissions(): Array<Permission> {
-        return this.deleteRecordPermissions;
-    }
-
-    public hasReadPermissions(
-        userProjectPermissions: UserTenantAccessPermission | Array<Permission>,
-        columnName?: string
-    ): boolean {
-        let modelPermission: Array<Permission> = this.readRecordPermissions;
-
-        if (columnName) {
-            const columnAccessControl: ColumnAccessControl | null =
-                this.getColumnAccessControlFor(columnName);
-            if (columnAccessControl) {
-                modelPermission = columnAccessControl.read;
-            }
+    return false;
+  }
+
+  public hasPermission(_permissions: Array<Permission>): boolean {
+    return false;
+  }
+
+  public isTenantModel(): boolean {
+    return false;
+  }
+
+  public isFileModel(): boolean {
+    return false;
+  }
+
+  public isAccessControlModel(): boolean {
+    return false;
+  }
+
+  public isUserModel(): boolean {
+    return false;
+  }
+
+  public hasCreatePermissions(
+    userProjectPermissions: UserTenantAccessPermission | Array<Permission>,
+    columnName?: string,
+  ): boolean {
+    let modelPermission: Array<Permission> = this.createRecordPermissions;
+
+    if (columnName) {
+      const columnAccessControl: ColumnAccessControl | null =
+        this.getColumnAccessControlFor(columnName);
+      if (columnAccessControl) {
+        modelPermission = columnAccessControl.create;
+      }
+    }
+
+    return ModelPermission.hasPermissions(
+      userProjectPermissions,
+      modelPermission,
+    );
+  }
+
+  public getReadPermissions(): Array<Permission> {
+    return this.readRecordPermissions;
+  }
+
+  public getReadBillingPlan(): PlanSelect | null {
+    return this.readBillingPlan;
+  }
+
+  public getCreateBillingPlan(): PlanSelect | null {
+    return this.createBillingPlan;
+  }
+
+  public getUpdateBillingPlan(): PlanSelect | null {
+    return this.updateBillingPlan;
+  }
+
+  public getDeleteBillingPlan(): PlanSelect | null {
+    return this.deleteBillingPlan;
+  }
+
+  public getCreatePermissions(): Array<Permission> {
+    return this.createRecordPermissions;
+  }
+
+  public getUpdatePermissions(): Array<Permission> {
+    return this.updateRecordPermissions;
+  }
+
+  public getDeletePermissions(): Array<Permission> {
+    return this.deleteRecordPermissions;
+  }
+
+  public hasReadPermissions(
+    userProjectPermissions: UserTenantAccessPermission | Array<Permission>,
+    columnName?: string,
+  ): boolean {
+    let modelPermission: Array<Permission> = this.readRecordPermissions;
+
+    if (columnName) {
+      const columnAccessControl: ColumnAccessControl | null =
+        this.getColumnAccessControlFor(columnName);
+      if (columnAccessControl) {
+        modelPermission = columnAccessControl.read;
+      }
+    }
+
+    return ModelPermission.hasPermissions(
+      userProjectPermissions,
+      modelPermission,
+    );
+  }
+
+  public hasDeletePermissions(
+    userProjectPermissions: UserTenantAccessPermission | Array<Permission>,
+  ): boolean {
+    const modelPermission: Array<Permission> = this.deleteRecordPermissions;
+    return ModelPermission.hasPermissions(
+      userProjectPermissions,
+      modelPermission,
+    );
+  }
+
+  public hasUpdatePermissions(
+    userProjectPermissions: UserTenantAccessPermission | Array<Permission>,
+    columnName?: string,
+  ): boolean {
+    let modelPermission: Array<Permission> = this.updateRecordPermissions;
+
+    if (columnName) {
+      const columnAccessControl: ColumnAccessControl | null =
+        this.getColumnAccessControlFor(columnName);
+      if (columnAccessControl) {
+        modelPermission = columnAccessControl.update;
+      }
+    }
+
+    return ModelPermission.hasPermissions(
+      userProjectPermissions,
+      modelPermission,
+    );
+  }
+
+  public getAPIDocumentationPath(): string {
+    return Text.pascalCaseToDashes(this.tableName as string);
+  }
+
+  public static toJSON(model: BaseModel, modelType: BaseModelType): JSONObject {
+    const json: JSONObject = this.toJSONObject(model, modelType);
+    return JSONFunctions.serialize(json);
+  }
+
+  public static toJSONObject(
+    model: BaseModel,
+    modelType: BaseModelType,
+  ): JSONObject {
+    const json: JSONObject = {};
+
+    const vanillaModel: BaseModel = new modelType();
+
+    for (const key of vanillaModel.getTableColumns().columns) {
+      if ((model as any)[key] === undefined) {
+        continue;
+      }
+
+      const tableColumnMetadata: TableColumnMetadata =
+        vanillaModel.getTableColumnMetadata(key);
+
+      if (tableColumnMetadata) {
+        if (
+          (model as any)[key] &&
+          tableColumnMetadata.modelType &&
+          tableColumnMetadata.type === TableColumnType.Entity &&
+          (model as any)[key] instanceof BaseModel
+        ) {
+          (json as any)[key] = this.toJSONObject(
+            (model as any)[key],
+            tableColumnMetadata.modelType,
+          );
+        } else if (
+          (model as any)[key] &&
+          Array.isArray((model as any)[key]) &&
+          (model as any)[key].length > 0 &&
+          tableColumnMetadata.modelType &&
+          tableColumnMetadata.type === TableColumnType.EntityArray
+        ) {
+          (json as any)[key] = this.toJSONObjectArray(
+            (model as any)[key] as Array<BaseModel>,
+            tableColumnMetadata.modelType,
+          );
+        } else {
+          (json as any)[key] = (model as any)[key];
         }
-
-        return ModelPermission.hasPermissions(
-            userProjectPermissions,
-            modelPermission
-        );
-    }
-
-    public hasDeletePermissions(
-        userProjectPermissions: UserTenantAccessPermission | Array<Permission>
-    ): boolean {
-        const modelPermission: Array<Permission> = this.deleteRecordPermissions;
-        return ModelPermission.hasPermissions(
-            userProjectPermissions,
-            modelPermission
-        );
-    }
-
-    public hasUpdatePermissions(
-        userProjectPermissions: UserTenantAccessPermission | Array<Permission>,
-        columnName?: string
-    ): boolean {
-        let modelPermission: Array<Permission> = this.updateRecordPermissions;
-
-        if (columnName) {
-            const columnAccessControl: ColumnAccessControl | null =
-                this.getColumnAccessControlFor(columnName);
-            if (columnAccessControl) {
-                modelPermission = columnAccessControl.update;
-            }
+      }
+    }
+
+    return json;
+  }
+
+  public static toJSONObjectArray(
+    list: Array<BaseModel>,
+    modelType: BaseModelType,
+  ): JSONArray {
+    const array: JSONArray = [];
+
+    for (const item of list) {
+      array.push(this.toJSONObject(item, modelType));
+    }
+
+    return array;
+  }
+
+  public static toJSONArray(
+    list: Array<BaseModel>,
+    modelType: BaseModelType,
+  ): JSONArray {
+    const array: JSONArray = [];
+
+    for (const item of list) {
+      array.push(this.toJSON(item, modelType));
+    }
+
+    return array;
+  }
+
+  private static _fromJSON<T extends BaseModel>(
+    json: JSONObject | T,
+    type: { new (): T },
+  ): T {
+    if (json instanceof BaseModel) {
+      return json;
+    }
+
+    json = JSONFunctions.deserialize(json);
+    const baseModel: T = new type();
+
+    for (const key of Object.keys(json)) {
+      const tableColumnMetadata: TableColumnMetadata =
+        baseModel.getTableColumnMetadata(key);
+      if (tableColumnMetadata) {
+        if (
+          json[key] &&
+          tableColumnMetadata.modelType &&
+          tableColumnMetadata.type === TableColumnType.Entity
+        ) {
+          if (
+            json[key] &&
+            Array.isArray(json[key]) &&
+            (json[key] as Array<any>).length > 0
+          ) {
+            json[key] = (json[key] as Array<any>)[0];
+          }
+
+          (baseModel as any)[key] = this.fromJSON(
+            json[key] as JSONObject,
+            tableColumnMetadata.modelType,
+          );
+        } else if (
+          json[key] &&
+          tableColumnMetadata.modelType &&
+          tableColumnMetadata.type === TableColumnType.EntityArray
+        ) {
+          if (json[key] && !Array.isArray(json[key])) {
+            json[key] = [json[key]];
+          }
+
+          (baseModel as any)[key] = this.fromJSONArray(
+            json[key] as JSONArray,
+            tableColumnMetadata.modelType,
+          );
+        } else {
+          (baseModel as any)[key] = json[key];
         }
-
-        return ModelPermission.hasPermissions(
-            userProjectPermissions,
-            modelPermission
-        );
+      }
     }
 
-    public getAPIDocumentationPath(): string {
-        return Text.pascalCaseToDashes(this.tableName as string);
-    }
+    return baseModel as T;
+  }
 
-    public static toJSON(
-        model: BaseModel,
-        modelType: BaseModelType
-    ): JSONObject {
-        const json: JSONObject = this.toJSONObject(model, modelType);
-        return JSONFunctions.serialize(json);
-    }
+  public static fromJSON<T extends BaseModel>(
+    json: JSONObject | JSONArray | BaseModel | Array<BaseModel>,
+    type: { new (): T },
+  ): T | Array<T> {
+    if (Array.isArray(json)) {
+      const arr: Array<T> = [];
 
-    public static toJSONObject(
-        model: BaseModel,
-        modelType: BaseModelType
-    ): JSONObject {
-        const json: JSONObject = {};
-
-        const vanillaModel: BaseModel = new modelType();
-
-        for (const key of vanillaModel.getTableColumns().columns) {
-            if ((model as any)[key] === undefined) {
-                continue;
-            }
-
-            const tableColumnMetadata: TableColumnMetadata =
-                vanillaModel.getTableColumnMetadata(key);
-
-            if (tableColumnMetadata) {
-                if (
-                    (model as any)[key] &&
-                    tableColumnMetadata.modelType &&
-                    tableColumnMetadata.type === TableColumnType.Entity &&
-                    (model as any)[key] instanceof BaseModel
-                ) {
-                    (json as any)[key] = this.toJSONObject(
-                        (model as any)[key],
-                        tableColumnMetadata.modelType
-                    );
-                } else if (
-                    (model as any)[key] &&
-                    Array.isArray((model as any)[key]) &&
-                    (model as any)[key].length > 0 &&
-                    tableColumnMetadata.modelType &&
-                    tableColumnMetadata.type === TableColumnType.EntityArray
-                ) {
-                    (json as any)[key] = this.toJSONObjectArray(
-                        (model as any)[key] as Array<BaseModel>,
-                        tableColumnMetadata.modelType
-                    );
-                } else {
-                    (json as any)[key] = (model as any)[key];
-                }
-            }
+      for (const item of json) {
+        if (item instanceof BaseModel) {
+          arr.push(item as T);
+          continue;
         }
 
-        return json;
-    }
-
-    public static toJSONObjectArray(
-        list: Array<BaseModel>,
-        modelType: BaseModelType
-    ): JSONArray {
-        const array: JSONArray = [];
-
-        for (const item of list) {
-            array.push(this.toJSONObject(item, modelType));
-        }
+        arr.push(this._fromJSON<T>(item, type));
+      }
 
-        return array;
+      return arr;
     }
 
-    public static toJSONArray(
-        list: Array<BaseModel>,
-        modelType: BaseModelType
-    ): JSONArray {
-        const array: JSONArray = [];
-
-        for (const item of list) {
-            array.push(this.toJSON(item, modelType));
-        }
-
-        return array;
+    if (json instanceof BaseModel) {
+      return json as T;
     }
 
-    private static _fromJSON<T extends BaseModel>(
-        json: JSONObject | T,
-        type: { new (): T }
-    ): T {
-        if (json instanceof BaseModel) {
-            return json;
-        }
-
-        json = JSONFunctions.deserialize(json);
-        const baseModel: T = new type();
-
-        for (const key of Object.keys(json)) {
-            const tableColumnMetadata: TableColumnMetadata =
-                baseModel.getTableColumnMetadata(key);
-            if (tableColumnMetadata) {
-                if (
-                    json[key] &&
-                    tableColumnMetadata.modelType &&
-                    tableColumnMetadata.type === TableColumnType.Entity
-                ) {
-                    if (
-                        json[key] &&
-                        Array.isArray(json[key]) &&
-                        (json[key] as Array<any>).length > 0
-                    ) {
-                        json[key] = (json[key] as Array<any>)[0];
-                    }
-
-                    (baseModel as any)[key] = this.fromJSON(
-                        json[key] as JSONObject,
-                        tableColumnMetadata.modelType
-                    );
-                } else if (
-                    json[key] &&
-                    tableColumnMetadata.modelType &&
-                    tableColumnMetadata.type === TableColumnType.EntityArray
-                ) {
-                    if (json[key] && !Array.isArray(json[key])) {
-                        json[key] = [json[key]];
-                    }
-
-                    (baseModel as any)[key] = this.fromJSONArray(
-                        json[key] as JSONArray,
-                        tableColumnMetadata.modelType
-                    );
-                } else {
-                    (baseModel as any)[key] = json[key];
-                }
-            }
-        }
+    return this._fromJSON<T>(json, type);
+  }
 
-        return baseModel as T;
+  public static fromJSONObject<T extends BaseModel>(
+    json: JSONObject | T,
+    type: { new (): T },
+  ): T {
+    if (json instanceof BaseModel) {
+      return json;
     }
 
-    public static fromJSON<T extends BaseModel>(
-        json: JSONObject | JSONArray | BaseModel | Array<BaseModel>,
-        type: { new (): T }
-    ): T | Array<T> {
-        if (Array.isArray(json)) {
-            const arr: Array<T> = [];
-
-            for (const item of json) {
-                if (item instanceof BaseModel) {
-                    arr.push(item as T);
-                    continue;
-                }
-
-                arr.push(this._fromJSON<T>(item, type));
-            }
-
-            return arr;
-        }
-
-        if (json instanceof BaseModel) {
-            return json as T;
-        }
-
-        return this._fromJSON<T>(json, type);
-    }
+    return this.fromJSON<T>(json, type) as T;
+  }
 
-    public static fromJSONObject<T extends BaseModel>(
-        json: JSONObject | T,
-        type: { new (): T }
-    ): T {
-        if (json instanceof BaseModel) {
-            return json;
-        }
+  public static fromJSONArray<T extends BaseModel>(
+    json: Array<JSONObject | T>,
+    type: { new (): T },
+  ): Array<T> {
+    const arr: Array<T> = [];
 
-        return this.fromJSON<T>(json, type) as T;
+    for (const item of json) {
+      arr.push(this._fromJSON<T>(item, type));
     }
 
-    public static fromJSONArray<T extends BaseModel>(
-        json: Array<JSONObject | T>,
-        type: { new (): T }
-    ): Array<T> {
-        const arr: Array<T> = [];
-
-        for (const item of json) {
-            arr.push(this._fromJSON<T>(item, type));
-        }
-
-        return arr;
-    }
+    return arr;
+  }
 }