@prefecthq/prefect-ui-library/src/services/WorkspaceTaskRunsApi.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 { FlowRun, FlowRunResponse } from '@/models'
import { TaskRunHistoryResponse } from '@/models/api/TaskRunHistoryResponse'
import { TaskRunResponse } from '@/models/api/TaskRunResponse'
import { FlowRunsPaginationFilter, TaskRunsFilter, TaskRunsHistoryFilter, TaskRunsPaginationFilter } from '@/models/Filters'
import { Paginated } from '@/models/pagination'
import { StateUpdate } from '@/models/StateUpdate'
import { TaskRun } from '@/models/TaskRun'
import { TaskRunHistory } from '@/models/TaskRunHistory'
import { BatchProcessor } from '@/services/BatchProcessor'
import { mapper } from '@/services/Mapper'
import { WorkspaceApi } from '@/services/WorkspaceApi'
import { toMap } from '@/utilities'

export class WorkspaceTaskRunsApi extends WorkspaceApi {

  protected override routePrefix = '/task_runs'

  private readonly batcher = new BatchProcessor<string, TaskRun>(async ids => {
    if (ids.length === 1) {
      const [id] = ids
      const { data } = await this.get<TaskRunResponse>(`/${id}`)

      return () => mapper.map('TaskRunResponse', data, 'TaskRun')
    }

    const taskRuns = await this.getTaskRuns({
      taskRuns: {
        id: ids,
      },
    })

    return toMap(taskRuns, 'id')
  }, { maxBatchSize: 200 })

  public getTaskRun(taskRunId: string): Promise<TaskRun> {
    return this.batcher.batch(taskRunId)
  }

  public async getTaskRuns(filter: TaskRunsFilter = {}): Promise<TaskRun[]> {
    const request = mapper.map('TaskRunsFilter', filter, 'TaskRunsFilterRequest')
    const { data } = await this.post<TaskRunResponse[]>('/filter', request)

    return mapper.map('TaskRunResponse', data, 'TaskRun')
  }

  public async getTaskRunsPaginated(filter: TaskRunsPaginationFilter = {}): Promise<Paginated<TaskRun>> {
    const request = mapper.map('TaskRunsPaginationFilter', filter, 'TaskRunsPaginationFilterRequest')
    const { data } = await this.post<Paginated<TaskRunResponse>>('/paginate', request)

    return mapper.map('TaskRunsPaginationResponse', data, 'TaskRunsPagination')
  }

  public async getTaskRunsCount(filter: TaskRunsFilter = {}): Promise<number> {
    const request = mapper.map('TaskRunsFilter', filter, 'TaskRunsFilterRequest')
    const { data } = await this.post<number>('/count', request)

    return data
  }

  public setTaskRunState(id: string, body: StateUpdate): Promise<void> {
    const requestBody = mapper.map('StateUpdate', body, 'StateUpdateRequest')

    return this.post(`/${id}/set_state`, { state: requestBody.state, force: true })
  }

  public deleteTaskRun(taskRunId: string): Promise<void> {
    return this.delete(`/${taskRunId}`)
  }

  public async getTaskRunsHistory(filter: TaskRunsHistoryFilter): Promise<TaskRunHistory[]> {
    const request = mapper.map('TaskRunsHistoryFilter', filter, 'TaskRunsHistoryFilterRequest')
    const { data } = await this.post<TaskRunHistoryResponse[]>('/history', request)

    return mapper.map('TaskRunHistoryResponse', data, 'TaskRunHistory')
  }
}