@prefecthq/prefect-ui-library 2.9.18 → 2.10.0

package/src/models/api/Filters.ts

@@ -0,0 +1,261 @@
+import { ArtifactSortValues, DeploymentSortValues, FlowRunSortValues, FlowSortValues, LogSortValues, TaskRunSortValues, VariableSortValues } from '@/types/SortOptionTypes'
+
+/** A list where results will be returned only if they match all the values in the list */
+export type All = { all_?: string[] }
+
+/** A list where results will be returned if any of the values are included in the list */
+export type Any = { any_?: string[] }
+export type Like = { like_?: string }
+export type StartsWith = { startswith_?: string[] }
+
+/** A list where results will be returned if values don't match any in the list */
+export type NotAny = { not_any_?: string[] }
+
+/** Matches on boolean equality */
+export type Equals = { eq_?: boolean }
+export type NullableEquals = { eq_?: boolean | null }
+
+/** Matches on boolean equality */
+export type Exists = { exists_?: boolean }
+
+/** Matches on boolean equality */
+export type Latest = { is_latest: boolean }
+
+/** If true, returns results whose key is null */
+export type IsNull = { is_null_?: boolean }
+
+/** A date-time string to include results starting at or before this time */
+export type Before = { before_?: string }
+export type After = { after_?: string }
+
+export type GreaterThan = { ge_?: number }
+export type LessThan = { le_?: number }
+
+export type OperationRequest = 'and_' | 'or_'
+export type OperatorRequest = { operator?: OperationRequest }
+
+export type TagFilterRequest = OperatorRequest & All & IsNull
+
+export type StateFilterRequest = OperatorRequest & { type?: Any } & { name?: Any }
+
+export type FlowFilterRequest = {
+  operator?: OperationRequest,
+  id?: Any,
+  name?: Any & Like,
+  tags?: TagFilterRequest,
+}
+
+export type FlowRunFilterRequest = {
+  operator?: OperationRequest,
+  id?: Any & NotAny,
+  name?: Any & Like,
+  tags?: TagFilterRequest,
+  deployment_id?: OperatorRequest & Any & IsNull,
+  work_queue_name?: OperatorRequest & Any & IsNull,
+  state?: StateFilterRequest,
+  flow_version?: Any,
+  start_time?: Before & After & IsNull,
+  expected_start_time?: Before & After,
+  next_scheduled_start_time?: Before & After,
+  parent_task_run_id?: OperatorRequest & Any & IsNull,
+  parent_flow_run_id?: Any,
+}
+
+export type TaskRunFilterRequest = {
+  operator?: OperationRequest,
+  id?: Any,
+  name?: Any & Like,
+  tags?: TagFilterRequest,
+  state?: StateFilterRequest,
+  start_time?: Before & After & IsNull,
+  subflow_runs?: Exists,
+}
+
+export type DeploymentFilterRequest = {
+  operator?: OperationRequest,
+  id?: Any,
+  name?: Any & Like,
+  is_schedule_active?: Equals,
+  work_queue_name?: Any,
+  work_queue_id?: Any,
+  status?: Any,
+  flow_or_deployment_name?: Like,
+  paused?: Equals,
+}
+
+export type WorkPoolFilterRequest = {
+  operator?: OperationRequest,
+  id?: Any,
+  name?: Any,
+  type?: Any,
+}
+
+export type WorkPoolQueueFilterRequest = {
+  operator?: OperationRequest,
+  id?: Any,
+  name?: Any,
+}
+
+export type UnionFilterRequest<T> = {
+  flows?: FlowFilterRequest,
+  flow_runs?: FlowRunFilterRequest,
+  task_runs?: TaskRunFilterRequest,
+  deployments?: DeploymentFilterRequest,
+  work_pools?: WorkPoolFilterRequest,
+  work_pool_queues?: WorkPoolQueueFilterRequest,
+  sort?: T,
+  offset?: number,
+  limit?: number,
+}
+
+export type BlockTypeFilterRequest = {
+  name?: Like,
+  slug?: Any,
+}
+
+export type BlockSchemaFilterRequest = {
+  operator?: OperationRequest,
+  block_type_id?: Any,
+  block_capabilities?: All,
+  id?: Any,
+  version?: Any,
+}
+
+export type BlockDocumentFilterRequest = {
+  operator?: OperationRequest,
+  id?: Any,
+  is_anonymous?: NullableEquals,
+  block_type_id?: Any,
+  name?: Any & Like,
+}
+
+export type FlowsFilterRequest = UnionFilterRequest<FlowSortValues>
+export type FlowRunsFilterRequest = UnionFilterRequest<FlowRunSortValues>
+export type TaskRunsFilterRequest = UnionFilterRequest<TaskRunSortValues>
+export type DeploymentsFilterRequest = UnionFilterRequest<DeploymentSortValues>
+
+export type ArtifactFilterRequest = {
+  id?: Any,
+  key?: Any & Like & Exists,
+  type?: Any & NotAny,
+  flow_run_id?: Any,
+  task_run_id?: Any,
+}
+
+export type ArtifactsFilterRequest = {
+  artifacts?: ArtifactFilterRequest,
+  task_runs?: TaskRunFilterRequest,
+  flow_runs?: FlowRunFilterRequest,
+  sort?: ArtifactSortValues,
+  offset?: number,
+  limit?: number,
+}
+
+export type VariableFilterRequest = {
+  id?: Any,
+  name?: Any & Like,
+  value?: Any & Like,
+}
+
+export type VariablesFilterRequest = {
+  variables?: VariableFilterRequest,
+  sort?: VariableSortValues,
+  offset?: number,
+  limit?: number,
+}
+
+export type FlowRunsHistoryFilterRequest = FlowRunsFilterRequest & {
+  history_start: string,
+  history_end: string,
+  history_interval_seconds: number,
+}
+
+export type NotificationsFilterRequest = {
+  flow_run_notification_policy_filter?: {
+    is_active?: Equals,
+  },
+  offset?: number,
+  limit?: number,
+}
+
+export type SavedSearchesFilterRequest = {
+  offset?: number,
+  limit?: number,
+}
+
+export type LogsFilterRequest = {
+  logs?: {
+    operator?: OperationRequest,
+    level?: GreaterThan & LessThan,
+    timestamp?: Before & After,
+    flow_run_id?: Any,
+    task_run_id?: Any,
+  },
+  sort?: LogSortValues,
+  offset?: number,
+  limit?: number,
+}
+
+export type ConcurrencyLimitsFilterRequest = {
+  offset?: number,
+  limit?: number,
+}
+
+export type BlockTypesFilterRequest = {
+  block_types?: BlockTypeFilterRequest,
+  block_schemas?: BlockSchemaFilterRequest,
+  offset?: number,
+  limit?: number,
+}
+
+export type BlockSchemasFilterRequest = {
+  block_schemas?: BlockSchemaFilterRequest,
+  offset?: number,
+  limit?: number,
+}
+
+export type BlockDocumentsFilterRequest = {
+  block_documents?: BlockDocumentFilterRequest,
+  block_types?: BlockTypeFilterRequest,
+  block_schemas?: BlockSchemaFilterRequest,
+  include_secrets?: boolean,
+  offset?: number,
+  limit?: number,
+}
+
+export type WorkQueuesFilterRequest = {
+  work_queues?: {
+    operator?: OperationRequest,
+    id?: Any,
+    name?: Any & StartsWith,
+  },
+  offset?: number,
+  limit?: number,
+}
+
+export type WorkPoolsFilterRequest = {
+  work_pools?: WorkPoolFilterRequest,
+  offset?: number,
+  limit?: number,
+}
+
+export type WorkPoolQueuesFilterRequest = {
+  work_pools?: WorkPoolFilterRequest,
+  offset?: number,
+  limit?: number,
+}
+
+export type WorkPoolWorkersFilterRequest = {
+  workers?: {
+    operator?: OperationRequest,
+    last_heartbeat_time?: Before & After,
+  },
+  limit?: number,
+  offset?: number,
+}
+
+export type TaskRunsHistoryFilterRequest = Pick<TaskRunsFilterRequest, 'deployments' | 'flow_runs' | 'task_runs' | 'flows'> & {
+  history_start: string,
+  history_end: string,
+  history_interval_seconds: number,
+}

package/src/models/api/FlowResponse.ts

@@ -0,0 +1,7 @@
+export type FlowResponse = {
+  created: string,
+  id: string,
+  name: string,
+  description: string,
+  updated: string,
+}

package/src/models/api/FlowRunGraphResponse.ts

@@ -0,0 +1,18 @@
+import { StateResponse } from '@/models/api/StateResponse'
+import { TaskRunInputType } from '@/models/GraphNode'
+import { DateString } from '@/types/dates'
+
+export type FlowRunGraphResponse = {
+  id: string,
+  name?: string,
+  upstream_dependencies: {
+    id: string,
+    input_type: TaskRunInputType,
+  }[],
+  state: StateResponse,
+  expected_start_time: DateString | null,
+  start_time: DateString | null,
+  end_time: DateString | null,
+  total_run_time: number | null,
+  estimated_run_time: number | null,
+}

package/src/models/api/FlowRunHistoryResponse.ts

@@ -0,0 +1,7 @@
+import { StateHistoryResponse } from '@/models/api/StateHistoryResponse'
+
+export type FlowRunHistoryResponse = {
+  interval_start: string,
+  interval_end: string,
+  states: StateHistoryResponse[],
+}

package/src/models/api/FlowRunInputKeysetResponse.ts

@@ -0,0 +1,5 @@
+export type FlowRunInputKeysetResponse = {
+  description: string,
+  schema: string,
+  response: string,
+}

package/src/models/api/FlowRunResponse.ts

@@ -0,0 +1,43 @@
+import { CreatedOrUpdatedByResponse } from '@/models/api/CreatedOrUpdatedByResponse'
+import { EmpiricalPolicyResponse } from '@/models/api/EmpiricalPolicyResponse'
+import { StateResponse } from '@/models/api/StateResponse'
+import { ServerStateType } from '@/models/StateType'
+import { PrefectStateNames } from '@/types'
+import { DateString } from '@/types/dates'
+import { SchemaValues } from '@/types/schemas'
+
+export type FlowRunResponse = {
+  id: string,
+  created: DateString,
+  created_by: CreatedOrUpdatedByResponse | null,
+  updated: DateString,
+  name: string | null,
+  flow_id: string,
+  state_id: string | null,
+  deployment_id: string | null,
+  flow_version: string | null,
+  parameters: SchemaValues,
+  idempotency_key: string | null,
+  context: unknown,
+  empirical_policy: EmpiricalPolicyResponse | null,
+  empirical_config: unknown,
+  tags: string[] | null,
+  parent_task_run_id: string | null,
+  state_name: PrefectStateNames | null,
+  state_type: ServerStateType | null,
+  run_count: number | null,
+  expected_start_time: DateString | null,
+  next_scheduled_start_time: DateString | null,
+  start_time: DateString | null,
+  end_time: DateString | null,
+  total_run_time: number,
+  estimated_run_time: number,
+  estimated_start_time_delta: number | null,
+  auto_scheduled: boolean | null,
+  state: StateResponse | null,
+  work_queue_name: string | null,
+  work_pool_name: string | null,
+  work_pool_queue_name: string | null,
+  // TODO: Remove optionality when api changes are fully merged
+  job_variables?: Record<string, unknown> | null,
+}

package/src/models/api/LogResponse.ts

@@ -0,0 +1,13 @@
+import { LogLevel } from '@/models/Log'
+
+export type LogResponse = {
+  id: string,
+  created: string,
+  updated: string,
+  name: string,
+  level: LogLevel,
+  message: string,
+  timestamp: string,
+  flow_run_id: string,
+  task_run_id: string | null,
+}

package/src/models/api/NotificationCreateRequest.ts

@@ -0,0 +1,6 @@
+export type NotificationCreateRequest = {
+  is_active: boolean,
+  state_names: string[],
+  tags: string[],
+  block_document_id: string,
+}

package/src/models/api/NotificationResponse.ts

@@ -0,0 +1,9 @@
+export type NotificationResponse = {
+  id: string,
+  created: string,
+  updated: string,
+  is_active: boolean,
+  state_names: string[],
+  tags: string[],
+  block_document_id: string,
+}

package/src/models/api/NotificationUpdateRequest.ts

@@ -0,0 +1,6 @@
+export type NotificationUpdateRequest = {
+  is_active?: boolean,
+  state_names?: string[],
+  tags?: string[],
+  block_document_id?: string,
+}

package/src/models/api/OrchestrationResult.ts

@@ -0,0 +1,9 @@
+export type OrchestrationResultDetails = {
+  type: string,
+  reason: string,
+}
+
+export type OrchestrationResult = {
+  status: string,
+  details: OrchestrationResultDetails,
+}

package/src/models/api/OrchestrationResultResponse.ts

@@ -0,0 +1,9 @@
+export type OrchestrationResultDetails = {
+  type: string,
+  reason: string,
+}
+
+export type OrchestrationResultResponse = {
+  status: string,
+  details: OrchestrationResultDetails,
+}

package/src/models/api/RunGraphDataResponse.ts

@@ -0,0 +1,39 @@
+import { RunGraphEdge, RunGraphNodeKind, StateType } from '@prefecthq/graphs'
+import { ServerStateType } from '@/models/StateType'
+
+export type RunGraphDataResponse = {
+  start_time: string,
+  end_time: string | null,
+  root_node_ids: string[],
+  nodes: [string, RunGraphNodeResponse][],
+  artifacts?: RunGraphArtifactResponse[],
+  states?: RunGraphStateResponse[],
+}
+
+export type RunGraphNodeResponse = {
+  kind: RunGraphNodeKind,
+  id: string,
+  label: string,
+  state_name: string,
+  state_type: ServerStateType,
+  start_time: string,
+  end_time: string | null,
+  parents: RunGraphEdge[],
+  children: RunGraphEdge[],
+  artifacts?: RunGraphArtifactResponse[],
+}
+
+export type RunGraphArtifactResponse = {
+  id: string,
+  is_latest: boolean,
+  created: string,
+  key: string,
+  type: string,
+}
+
+export type RunGraphStateResponse = {
+  id: string,
+  timestamp: string,
+  type: StateType,
+  name: string,
+}

package/src/models/api/SavedSearchResponse.ts

@@ -0,0 +1,94 @@
+import { DateRangeSelectAroundUnit } from '@prefecthq/prefect-design'
+
+export type SavedSearchResponse = {
+  id: string,
+  created?: string,
+  updated?: string,
+  name: string,
+  filters?: SavedSearchFilterResponse[],
+}
+
+export type DateRangeSpanResponse = {
+  type: 'span',
+  seconds: number,
+}
+
+export function isDateRangeSpanResponse(value: unknown): value is DateRangeSpanResponse {
+  return typeof value === 'object'
+    && value !== null
+    && 'type' in value
+    && value.type === 'span'
+    && 'seconds' in value
+    && typeof value.seconds === 'number'
+}
+
+export type DateRangeRangeResponse = {
+  type: 'range',
+  startDate: string,
+  endDate: string,
+}
+
+export function isDateRangeRangeResponse(value: unknown): value is DateRangeRangeResponse {
+  return typeof value === 'object'
+    && value !== null
+    && 'type' in value
+    && value.type === 'range'
+    && 'startDate' in value
+    && typeof value.startDate === 'string'
+    && 'endDate' in value
+    && typeof value.endDate === 'string'
+}
+
+export type DateRangePeriodResponse = {
+  type: 'period',
+  period: 'Today',
+}
+
+export function isDateRangePeriodResponse(value: unknown): value is DateRangePeriodResponse {
+  return typeof value === 'object'
+    && value !== null
+    && 'type' in value
+    && value.type === 'period'
+    && 'period' in value
+    && value.period === 'Today'
+}
+
+export type DateRangeAroundResponse = {
+  type: 'around',
+  date: string,
+  quantity: number,
+  unit: DateRangeSelectAroundUnit,
+}
+
+export function isDateRangeAroundResponse(value: unknown): value is DateRangeAroundResponse {
+  return typeof value === 'object'
+    && value !== null
+    && 'type' in value
+    && value.type === 'around'
+    && 'date' in value
+    && typeof value.date === 'string'
+    && 'unit' in value
+    && typeof value.unit === 'string'
+}
+
+export type DateRangeResponse = DateRangeSpanResponse | DateRangeRangeResponse | DateRangePeriodResponse | DateRangeAroundResponse
+
+export function isDateRangeResponse(value: unknown): value is DateRangeResponse {
+  return isDateRangeSpanResponse(value) || isDateRangeRangeResponse(value) || isDateRangePeriodResponse(value) || isDateRangeAroundResponse(value)
+}
+
+export type FilterResponseValue = string | string[] | DateRangeResponse
+
+export interface SavedSearchFilterResponse {
+  object?: string,
+  property?: string,
+  type?: string,
+  operation?: string,
+  value?: FilterResponseValue,
+}
+
+
+export type SavedSearchCreateRequest = {
+  name?: string,
+  filters?: SavedSearchFilterResponse[],
+}

package/src/models/api/ScheduleRequest.ts

@@ -0,0 +1,33 @@
+export type ScheduleRequest = RRuleScheduleRequest | CronScheduleRequest | IntervalScheduleRequest
+
+export type RRuleScheduleRequest = {
+  rrule: string,
+  timezone: string | null,
+}
+
+export type CronScheduleRequest = {
+  cron: string,
+  timezone: string | null,
+  day_or: boolean,
+}
+
+export type IntervalScheduleRequest = {
+  interval: number,
+  timezone: string | null,
+  anchor_date: string | null,
+}
+
+export function isRRuleScheduleRequest(schedule: ScheduleRequest): schedule is RRuleScheduleRequest {
+  const rruleScheduleRequest = schedule as RRuleScheduleRequest
+  return !!rruleScheduleRequest.rrule
+}
+
+export function isCronScheduleRequest(schedule: ScheduleRequest): schedule is CronScheduleRequest {
+  const cronScheduleRequest = schedule as CronScheduleRequest
+  return !!cronScheduleRequest.cron
+}
+
+export function isIntervalScheduleRequest(schedule: ScheduleRequest): schedule is IntervalScheduleRequest {
+  const intervalScheduleRequest = schedule as IntervalScheduleRequest
+  return !!intervalScheduleRequest.interval
+}

package/src/models/api/ScheduleResponse.ts

@@ -0,0 +1,33 @@
+export type ScheduleResponse = RRuleScheduleResponse | CronScheduleResponse | IntervalScheduleResponse
+
+export type RRuleScheduleResponse = {
+  rrule: string,
+  timezone: string | null,
+}
+
+export type CronScheduleResponse = {
+  cron: string,
+  timezone: string | null,
+  day_or: boolean,
+}
+
+export type IntervalScheduleResponse = {
+  interval: number,
+  timezone: string | null,
+  anchor_date: string | null,
+}
+
+export function isRRuleScheduleResponse(schedule: ScheduleResponse): schedule is RRuleScheduleResponse {
+  const rruleScheduleResponse = schedule as RRuleScheduleResponse
+  return !!rruleScheduleResponse.rrule
+}
+
+export function isCronScheduleResponse(schedule: ScheduleResponse): schedule is CronScheduleResponse {
+  const cronScheduleResponse = schedule as CronScheduleResponse
+  return !!cronScheduleResponse.cron
+}
+
+export function isIntervalScheduleResponse(schedule: ScheduleResponse): schedule is IntervalScheduleResponse {
+  const intervalScheduleResponse = schedule as IntervalScheduleResponse
+  return !!intervalScheduleResponse.interval
+}

package/src/models/api/SchemaResponse.ts

@@ -0,0 +1,52 @@
+import { SchemaReference, SchemaType, SchemaStringFormat, SchemaEnum } from '@/types/schemas'
+
+export type BlockSchemaReferenceResponse = {
+  block_schema_checksum: string,
+  block_type_slug: string,
+}
+
+export type BlockSchemaReferencesResponse = Record<string, BlockSchemaReferenceResponse | undefined>
+
+export type SchemaPropertiesResponse = Record<string, SchemaPropertyResponse | undefined>
+export type SchemaDefinitionsResponse = Record<string, SchemaResponse | undefined>
+
+export type SchemaPropertyResponse = {
+  // prefect specific properties
+  block_type_slug?: string,
+
+  // open api properties
+  $ref?: SchemaReference,
+  anyOf?: SchemaResponse[],
+  allOf?: SchemaResponse[],
+  example?: string,
+  alias?: string,
+  default?: unknown,
+  description?: string,
+  enum?: SchemaEnum<unknown>,
+  exclusiveMaximum?: number,
+  exclusiveMinimum?: number,
+  format?: SchemaStringFormat,
+  items?: SchemaPropertyResponse,
+  maximum?: number,
+  maxItems?: number,
+  maxLength?: number,
+  minimum?: number,
+  minItems?: number,
+  minLength?: number,
+  multipleOf?: number,
+  pattern?: string,
+  properties?: SchemaPropertiesResponse,
+  required?: string[],
+  title?: string,
+  type?: SchemaType,
+  uniqueItems?: boolean,
+}
+
+export type SchemaResponse = SchemaPropertyResponse & {
+  // prefect specific properties
+  block_schema_references?: BlockSchemaReferenceResponse,
+  secret_fields?: string[],
+
+  // open api properties
+  definitions?: SchemaDefinitionsResponse,
+}

package/src/models/api/StateDetailsRequest.ts

@@ -0,0 +1,12 @@
+import { DateString } from '@/types/dates'
+
+export type StateDetailsRequest = {
+  flow_run_id?: string | null,
+  task_run_id?: string | null,
+  child_flow_run_id?: string | null,
+  scheduled_time?: DateString | null,
+  cache_key?: string | null,
+  cache_expiration?: string | null,
+  pause_timeout?: DateString | null,
+  pause_reschedule?: boolean | null,
+}

package/src/models/api/StateDetailsResponse.ts

@@ -0,0 +1,14 @@
+import { FlowRunInputKeysetResponse } from '@/models/api/FlowRunInputKeysetResponse'
+import { DateString } from '@/types/dates'
+
+export type StateDetailsResponse = {
+  flow_run_id?: string | null,
+  task_run_id?: string | null,
+  child_flow_run_id?: string | null,
+  scheduled_time?: DateString | null,
+  cache_key?: string | null,
+  cache_expiration?: string | null,
+  pause_timeout?: DateString | null,
+  pause_reschedule?: boolean | null,
+  run_input_keyset?: FlowRunInputKeysetResponse | null,
+}