import { Column, Entity, Index, JoinColumn, ManyToOne } from 'typeorm'; import User from './User'; import Project from './Project'; import CrudApiEndpoint from 'Common/Types/Database/CrudApiEndpoint'; import Route from 'Common/Types/API/Route'; import TableColumnType from 'Common/Types/Database/TableColumnType'; import TableColumn from 'Common/Types/Database/TableColumn'; import ColumnType from 'Common/Types/Database/ColumnType'; import ObjectID from 'Common/Types/ObjectID'; import ColumnLength from 'Common/Types/Database/ColumnLength'; import TableAccessControl from 'Common/Types/Database/AccessControl/TableAccessControl'; import Permission from 'Common/Types/Permission'; import ColumnAccessControl from 'Common/Types/Database/AccessControl/ColumnAccessControl'; import UniqueColumnBy from 'Common/Types/Database/UniqueColumnBy'; import TenantColumn from 'Common/Types/Database/TenantColumn'; import TableMetadata from 'Common/Types/Database/TableMetadata'; import IconProp from 'Common/Types/Icon/IconProp'; import BaseModel from 'Common/Models/BaseModel'; import Workflow from './Workflow'; import TableBillingAccessControl from 'Common/Types/Database/AccessControl/TableBillingAccessControl'; import { PlanSelect } from 'Common/Types/Billing/SubscriptionPlan'; import EnableDocumentation from 'Common/Types/Database/EnableDocumentation'; @EnableDocumentation() @TableBillingAccessControl({ create: PlanSelect.Growth, read: PlanSelect.Growth, update: PlanSelect.Growth, delete: PlanSelect.Growth, }) @TenantColumn('projectId') @TableAccessControl({ create: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanCreateWorkflowVariable, ], read: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.ProjectMember, Permission.CanReadWorkflowVariable, ], delete: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanDeleteWorkflowVariable, ], update: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanEditWorkflowVariable, ], }) @CrudApiEndpoint(new Route('/workflow-variable')) @Entity({ name: 'WorkflowVariable', }) @TableMetadata({ tableName: 'WorkflowVariable', singularName: 'Workflow Variable', pluralName: 'Workflow Variables', icon: IconProp.Variable, tableDescription: 'Store environment variables or secrets for your workflows.', }) export default class WorkflowVariable extends BaseModel { @ColumnAccessControl({ create: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanCreateWorkflowVariable, ], read: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.ProjectMember, Permission.CanReadWorkflowVariable, ], update: [], }) @TableColumn({ manyToOneRelationColumn: 'projectId', type: TableColumnType.Entity, modelType: Project, title: 'Project', description: 'Relation to Project Resource in which this object belongs', }) @ManyToOne( (_type: string) => { return Project; }, { eager: false, nullable: true, onDelete: 'CASCADE', orphanedRowAction: 'nullify', } ) @JoinColumn({ name: 'projectId' }) public project?: Project = undefined; @ColumnAccessControl({ create: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanCreateWorkflowVariable, ], read: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.ProjectMember, Permission.CanReadWorkflowVariable, ], 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.CanCreateWorkflowVariable, ], read: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.ProjectMember, Permission.CanReadWorkflowVariable, ], update: [], }) @TableColumn({ manyToOneRelationColumn: 'workflowId', type: TableColumnType.Entity, modelType: Workflow, title: 'Workflow', description: 'Workflow this variable belong to. If this is null then this variable will be a global variable', }) @ManyToOne( (_type: string) => { return Workflow; }, { eager: false, nullable: true, onDelete: 'CASCADE', orphanedRowAction: 'nullify', } ) @JoinColumn({ name: 'workflowId' }) public workflow?: Workflow = undefined; @ColumnAccessControl({ create: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanCreateWorkflowVariable, ], read: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.ProjectMember, Permission.CanReadWorkflowVariable, ], update: [], }) @Index() @TableColumn({ type: TableColumnType.ObjectID, required: false, canReadOnRelationQuery: true, title: 'Workflow ID', description: 'ID of Workflow this variable belong to. If this is null then this variable will be a global variable', }) @Column({ type: ColumnType.ObjectID, nullable: true, transformer: ObjectID.getDatabaseTransformer(), }) public workflowId?: ObjectID = undefined; @ColumnAccessControl({ create: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanCreateWorkflowVariable, ], read: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.ProjectMember, Permission.CanReadWorkflowVariable, ], update: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanEditWorkflowVariable, ], }) @TableColumn({ required: true, type: TableColumnType.ShortText, canReadOnRelationQuery: true, title: 'Name', description: 'Variable Name', }) @Column({ nullable: false, type: ColumnType.ShortText, length: ColumnLength.ShortText, }) @UniqueColumnBy(['workflowId', 'projectId']) public name?: string = undefined; @ColumnAccessControl({ create: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanCreateWorkflowVariable, ], read: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.ProjectMember, Permission.CanReadWorkflowVariable, ], update: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanEditWorkflowVariable, ], }) @TableColumn({ required: false, type: TableColumnType.LongText, title: 'Description', description: 'Friendly description that will help you remember', }) @Column({ nullable: true, type: ColumnType.LongText, length: ColumnLength.LongText, }) public description?: string = undefined; @ColumnAccessControl({ create: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanCreateWorkflowVariable, ], read: [], update: [Permission.ProjectOwner, Permission.ProjectAdmin], }) @TableColumn({ required: true, type: TableColumnType.VeryLongText, title: 'Content', description: 'Content of the variable', }) @Column({ nullable: false, type: ColumnType.VeryLongText, }) public content?: string = undefined; @ColumnAccessControl({ create: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanCreateWorkflowVariable, ], read: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.ProjectMember, Permission.CanReadWorkflowVariable, ], update: [], }) @TableColumn({ required: true, type: TableColumnType.Boolean, title: 'Secret', description: "Is this variable a secret. If true, then it'll not be in the logs", }) @Column({ nullable: false, default: false, type: ColumnType.Boolean, }) public isSecret?: string = undefined; @ColumnAccessControl({ create: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanCreateWorkflowVariable, ], read: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.ProjectMember, Permission.CanReadWorkflowVariable, ], 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( (_type: string) => { return User; }, { eager: false, nullable: true, onDelete: 'CASCADE', orphanedRowAction: 'nullify', } ) @JoinColumn({ name: 'createdByUserId' }) public createdByUser?: User = undefined; @ColumnAccessControl({ create: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.CanCreateWorkflowVariable, ], read: [ Permission.ProjectOwner, Permission.ProjectAdmin, Permission.ProjectMember, Permission.CanReadWorkflowVariable, ], 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.CanReadWorkflowVariable, ], 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( (_type: string) => { 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.CanReadWorkflowVariable, ], 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; }