@prefecthq/prefect-ui-library/src/models/Deployment.ts

This library is the Vue and Typescript component library for [Prefect 2](https://github.com/PrefectHQ/prefect) and [Prefect Cloud 2](https://www.prefect.io/cloud/). _The components and utilities in this project are not meant to be used independently_.

import { ConcurrencyV2Limit } from '@/models/ConcurrencyV2Limit'
import { CreatedOrUpdatedBy } from '@/models/CreatedOrUpdatedBy'
import { DeploymentSchedule } from '@/models/DeploymentSchedule'
import { DeploymentStatus } from '@/models/DeploymentStatus'
import { DeploymentVersionInfo } from '@/models/DeploymentVersionInfo'
import { ObjectLevelCan } from '@/models/ObjectLevelCan'
import { SchemaV2, SchemaValuesV2 } from '@/schemas'
import { createTuple } from '@/utilities'

export const { values: deploymentCollisionStrategies, isValue: isDeploymentCollisionStrategy } = createTuple(['ENQUEUE', 'CANCEL_NEW'])
export type DeploymentCollisionStrategy = typeof deploymentCollisionStrategies[number]

export type DeploymentConcurrencyOptions = {
  collisionStrategy: DeploymentCollisionStrategy,
}

export interface IDeployment {
  id: string,
  created: Date,
  createdBy: CreatedOrUpdatedBy | null,
  updated: Date,
  updatedBy: CreatedOrUpdatedBy | null,
  name: string,
  version: string,
  versionInfo: DeploymentVersionInfo | null,
  description: string | null,
  flowId: string,
  versionId: string | null,
  paused: boolean,
  schedules: DeploymentSchedule[],
  parameters: SchemaValuesV2,
  parameterOpenApiSchema: SchemaV2,
  tags: string[] | null,
  manifestPath: string | null,
  path: string | null,
  entrypoint: string | null,
  storageDocumentId: string | null,
  infrastructureDocumentId: string | null,
  jobVariables: Record<string, unknown> | null,
  workQueueName: string | null,
  workPoolName: string | null,
  enforceParameterSchema: boolean,
  pullSteps: unknown,
  can: ObjectLevelCan<'deployment'>,
  status: DeploymentStatus,
  disabled: boolean,
  globalConcurrencyLimit: ConcurrencyV2Limit | null,
  concurrencyOptions: DeploymentConcurrencyOptions | null,
}

export class Deployment implements IDeployment {
  public readonly id: string
  public readonly kind = 'deployment'
  public created: Date
  public createdBy: CreatedOrUpdatedBy | null
  public updated: Date
  public updatedBy: CreatedOrUpdatedBy | null
  public name: string
  public version: string
  public versionInfo: DeploymentVersionInfo | null
  public description: string | null
  public readonly flowId: string
  public readonly versionId: string | null
  public paused: boolean
  public schedules: DeploymentSchedule[]
  public parameters: SchemaValuesV2
  public parameterOpenApiSchema: SchemaV2
  public tags: string[] | null
  public manifestPath: string | null
  public path: string | null
  public entrypoint: string | null
  public storageDocumentId: string | null
  public infrastructureDocumentId: string | null
  public jobVariables: Record<string, unknown> | null
  public workQueueName: string | null
  public workPoolName: string | null
  public enforceParameterSchema: boolean
  public pullSteps: unknown
  public can: ObjectLevelCan<'deployment'>
  public status: DeploymentStatus
  public disabled: boolean
  public globalConcurrencyLimit: ConcurrencyV2Limit | null
  public concurrencyOptions: DeploymentConcurrencyOptions | null

  public constructor(deployment: IDeployment) {
    this.id = deployment.id
    this.created = deployment.created
    this.createdBy = deployment.createdBy
    this.updated = deployment.updated
    this.updatedBy = deployment.updatedBy
    this.name = deployment.name
    this.version = deployment.version
    this.description = deployment.description
    this.flowId = deployment.flowId
    this.versionId = deployment.versionId
    this.versionInfo = deployment.versionInfo
    this.paused = deployment.paused
    this.schedules = deployment.schedules
    this.parameters = deployment.parameters
    this.parameterOpenApiSchema = deployment.parameterOpenApiSchema
    this.tags = deployment.tags
    this.manifestPath = deployment.manifestPath
    this.path = deployment.path
    this.entrypoint = deployment.entrypoint
    this.storageDocumentId = deployment.storageDocumentId
    this.infrastructureDocumentId = deployment.infrastructureDocumentId
    this.jobVariables = deployment.jobVariables
    this.workQueueName = deployment.workQueueName
    this.workPoolName = deployment.workPoolName
    this.enforceParameterSchema = deployment.enforceParameterSchema
    this.pullSteps = deployment.pullSteps
    this.can = deployment.can
    this.status = deployment.status
    this.disabled = deployment.disabled
    this.globalConcurrencyLimit = deployment.globalConcurrencyLimit
    this.concurrencyOptions = deployment.concurrencyOptions
  }

  public get concurrencyLimit(): number | null {
    return this.globalConcurrencyLimit?.limit ?? null
  }

  public get deprecated(): boolean {
    return (this.manifestPath === '' || this.manifestPath === null) && (this.entrypoint === '' || this.entrypoint === null)
  }

  public get appliedBy(): string | null {
    if (this.updatedBy) {
      return this.updatedBy.displayValue
    }

    if (this.createdBy) {
      return this.createdBy.displayValue
    }

    return null
  }
}