@prefecthq/prefect-ui-library/src/compositions/useFlowRuns.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 { MaybeReadonly } from '@prefecthq/prefect-design'
import { UseSubscription, useSubscriptionWithDependencies, SubscriptionOptions } from '@prefecthq/vue-compositions'
import { ComputedRef, MaybeRef, MaybeRefOrGetter, computed, toRef, toValue } from 'vue'
import { useCan } from '@/compositions/useCan'
import { useWorkspaceApi } from '@/compositions/useWorkspaceApi'
import { FlowRun, FlowRunsFilter } from '@/models'
import { WorkspaceFlowRunsApi } from '@/services'
import { Getter } from '@/types/reactivity'

export type UseFlowRuns = {
  subscription: UseSubscription<WorkspaceFlowRunsApi['getFlowRuns']>,
  flowRuns: ComputedRef<FlowRun[]>,
}

export function useFlowRuns(filter?: MaybeRefOrGetter<MaybeReadonly<FlowRunsFilter> | null | undefined>, options?: MaybeRef<SubscriptionOptions>): UseFlowRuns {
  const api = useWorkspaceApi()
  const can = useCan()

  const parameters: Getter<[FlowRunsFilter] | null> = () => {
    if (!can.read.flow_run) {
      return null
    }

    const value = toValue(filter)

    if (!value) {
      return null
    }

    return [value]
  }

  const parametersRef = toRef(parameters)
  const subscription = useSubscriptionWithDependencies(api.flowRuns.getFlowRuns, parametersRef, options)
  const flowRuns = computed(() => subscription.response ?? [])

  return {
    subscription,
    flowRuns,
  }
}