@prefecthq/prefect-ui-library 1.0.0

package/dist/types/src/models/api/FlowRunResponse.d.ts

@@ -0,0 +1,39 @@
+import { CreatedOrUpdatedByResponse } from '../../models/api/CreatedOrUpdatedByResponse';
+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: unknown;
+    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;
+};

package/dist/types/src/models/api/LogResponse.d.ts

@@ -0,0 +1,12 @@
+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/dist/types/src/models/api/LogsRequestFilter.d.ts

@@ -0,0 +1,23 @@
+import { LogResponse } from '../../models/api/LogResponse';
+export type LogsRequestSort = `${Uppercase<keyof LogResponse>}_${'ASC' | 'DESC'}`;
+export interface LogsRequestFilter {
+    limit?: number;
+    offset?: number;
+    logs?: {
+        level?: {
+            ge_?: number;
+            le_?: number;
+        };
+        timestamp?: {
+            before_?: string;
+            after_?: string;
+        };
+        flow_run_id?: {
+            any_?: string[];
+        };
+        task_run_id?: {
+            any_?: string[];
+        };
+    };
+    sort?: LogsRequestSort;
+}

package/dist/types/src/models/api/NotificationCreateRequest.d.ts

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

package/dist/types/src/models/api/NotificationFilter.d.ts

@@ -0,0 +1,5 @@
+export type NotificationFilter = {
+    offset?: number;
+    limit?: number;
+    is_active?: boolean;
+};

package/dist/types/src/models/api/NotificationResponse.d.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/dist/types/src/models/api/NotificationUpdateRequest.d.ts

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

package/dist/types/src/models/api/SavedSearchResponse.d.ts

@@ -0,0 +1,19 @@
+export type SavedSearchResponse = {
+    id: string;
+    created?: string;
+    updated?: string;
+    name: string;
+    filters?: SavedSearchFilterResponse[];
+};
+export type FilterResponseValue = string | string[];
+export interface SavedSearchFilterResponse {
+    object?: string;
+    property?: string;
+    type?: string;
+    operation?: string;
+    value?: FilterResponseValue;
+}
+export type SavedSearchCreateRequest = {
+    name?: string;
+    filters?: SavedSearchFilterResponse[];
+};

package/dist/types/src/models/api/ScheduleRequest.d.ts

@@ -0,0 +1,18 @@
+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 declare function isRRuleScheduleRequest(schedule: ScheduleRequest): schedule is RRuleScheduleRequest;
+export declare function isCronScheduleRequest(schedule: ScheduleRequest): schedule is CronScheduleRequest;
+export declare function isIntervalScheduleRequest(schedule: ScheduleRequest): schedule is IntervalScheduleRequest;

package/dist/types/src/models/api/ScheduleResponse.d.ts

@@ -0,0 +1,18 @@
+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 declare function isRRuleScheduleResponse(schedule: ScheduleResponse): schedule is RRuleScheduleResponse;
+export declare function isCronScheduleResponse(schedule: ScheduleResponse): schedule is CronScheduleResponse;
+export declare function isIntervalScheduleResponse(schedule: ScheduleResponse): schedule is IntervalScheduleResponse;

package/dist/types/src/models/api/SchemaResponse.d.ts

@@ -0,0 +1,41 @@
+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 = {
+    block_type_slug?: string;
+    $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 & {
+    block_schema_references?: BlockSchemaReferenceResponse;
+    secret_fields?: string[];
+    definitions?: SchemaDefinitionsResponse;
+};

package/dist/types/src/models/api/StateDetailsRequest.d.ts

@@ -0,0 +1,11 @@
+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_rescheduled_time?: boolean | null;
+};

package/dist/types/src/models/api/StateDetailsResponse.d.ts

@@ -0,0 +1,11 @@
+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_rescheduled_time?: boolean | null;
+};

package/dist/types/src/models/api/StateHistoryResponse.d.ts

@@ -0,0 +1,8 @@
+import { ServerStateType } from '../../models/StateType';
+export type StateHistoryResponse = {
+    state_type: ServerStateType;
+    state_name: string;
+    count_runs: number;
+    sum_estimated_run_time: number;
+    sum_estimated_lateness: number;
+};

package/dist/types/src/models/api/StateRequest.d.ts

@@ -0,0 +1,9 @@
+import { ServerStateType, StateDetailsRequest } from '../../models';
+export type StateRequest = {
+    type: ServerStateType;
+    message?: string;
+    state_details?: StateDetailsRequest | null;
+    data?: Record<string, unknown>;
+    timestamp?: string;
+    name?: string;
+};

package/dist/types/src/models/api/StateResponse.d.ts

@@ -0,0 +1,11 @@
+import { StateDetailsResponse } from '../../models/api/StateDetailsResponse';
+import { StateType } from '../../models/StateType';
+export type StateResponse = {
+    id: string;
+    type: Uppercase<StateType>;
+    message: string;
+    state_details: StateDetailsResponse | null;
+    data: Record<string, unknown>;
+    timestamp: string;
+    name: string;
+};

package/dist/types/src/models/api/StateUpdateRequest.d.ts

@@ -0,0 +1,11 @@
+import { StateDetailsRequest } from '../../models/api/StateDetailsRequest';
+import { ServerStateType } from '../../models/StateType';
+export interface StateUpdateRequestDetails {
+    type: ServerStateType;
+    name?: string;
+    message?: string;
+    state_details?: StateDetailsRequest;
+}
+export type StateUpdateRequest = {
+    state: StateUpdateRequestDetails;
+};

package/dist/types/src/models/api/TaskInputResponse.d.ts

@@ -0,0 +1,16 @@
+export type TaskInputResponse = ConstantTaskInputResponse | ParameterTaskInputResponse | TaskRunTaskInputResponse;
+export type ConstantTaskInputResponse = {
+    input_type: 'constant';
+    type: string;
+};
+export type ParameterTaskInputResponse = {
+    input_type: 'parameter';
+    name: string;
+};
+export type TaskRunTaskInputResponse = {
+    input_type: 'task_run';
+    id: string;
+};
+export declare function isConstantTaskInputResponse(taskInputResponse: TaskInputResponse): taskInputResponse is ConstantTaskInputResponse;
+export declare function isParameterTaskInputResponse(taskInputResponse: TaskInputResponse): taskInputResponse is ParameterTaskInputResponse;
+export declare function isTaskRunTaskInputResponse(taskInputResponse: TaskInputResponse): taskInputResponse is TaskRunTaskInputResponse;

package/dist/types/src/models/api/TaskRunResponse.d.ts

@@ -0,0 +1,31 @@
+import { EmpiricalPolicyResponse } from '../../models/api/EmpiricalPolicyResponse';
+import { StateResponse } from '../../models/api/StateResponse';
+import { TaskInputResponse } from '../../models/api/TaskInputResponse';
+import { ServerStateType } from '../../models/StateType';
+import { DateString } from '../../types/dates';
+export type TaskRunResponse = {
+    id: string;
+    created: string;
+    updated: string;
+    name: string | null;
+    flow_run_id: string;
+    task_key: string;
+    dynamic_key: string;
+    cache_key: string | null;
+    cache_expiration: DateString | null;
+    task_version: string | null;
+    empirical_policy: EmpiricalPolicyResponse | null;
+    tags: string[] | null;
+    state_id: string | null;
+    task_inputs: Record<string, TaskInputResponse[]> | 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 | null;
+    estimated_run_time: number | null;
+    estimated_start_time_delta: number | null;
+    state: StateResponse | null;
+};

package/dist/types/src/models/api/UiFlowRunHistoryResponse.d.ts

@@ -0,0 +1,8 @@
+import { ServerStateType } from '../../models/StateType';
+export type UiFlowRunHistoryResponse = {
+    id: string;
+    state_type: ServerStateType;
+    duration: number;
+    lateness: number;
+    timestamp: string;
+};

package/dist/types/src/models/api/WorkPoolQueueRequest.d.ts

@@ -0,0 +1,14 @@
+export type WorkPoolQueueCreateRequest = Partial<{
+    name: string;
+    description: string | null;
+    is_paused: boolean;
+    concurrency_limit: number | null;
+    priority: number;
+}>;
+export type WorkPoolQueueEditRequest = {
+    name?: string;
+    description?: string | null;
+    is_paused?: boolean;
+    concurrency_limit?: number | null;
+    priority?: number;
+};

package/dist/types/src/models/api/WorkPoolQueueResponse.d.ts

@@ -0,0 +1,12 @@
+import { DateString } from '../../types/dates';
+export type WorkPoolQueueResponse = {
+    id: string;
+    created: DateString;
+    updated: DateString;
+    work_pool_id: string;
+    name: string;
+    description: string | null;
+    is_paused: boolean | null;
+    concurrency_limit: number | null;
+    priority: number;
+};

package/dist/types/src/models/api/WorkPoolRequest.d.ts

@@ -0,0 +1,12 @@
+export type WorkPoolCreateRequest = Partial<{
+    name: string;
+    description: string;
+    type: string;
+    is_paused: boolean;
+    concurrency_limit: number;
+}>;
+export type WorkPoolEditRequest = Partial<{
+    description: string | null;
+    is_paused: boolean;
+    concurrency_limit: number | null;
+}>;

package/dist/types/src/models/api/WorkPoolResponse.d.ts

@@ -0,0 +1,12 @@
+import { DateString } from '../../types/dates';
+export type WorkPoolResponse = {
+    id: string;
+    created: DateString;
+    updated: DateString;
+    name: string;
+    description: string | null;
+    type: string;
+    is_paused: boolean | null;
+    concurrency_limit: number | null;
+    default_queue_id: string;
+};

package/dist/types/src/models/api/WorkPoolWorkerFilter.d.ts

@@ -0,0 +1,13 @@
+type operator_ = 'and_' | 'or_';
+export type WorkPoolWorkerFilter = {
+    workers?: {
+        operator?: operator_;
+        last_heartbeat_time?: {
+            before_?: string;
+            after_?: string;
+        };
+    };
+    limit?: number;
+    offset?: number;
+};
+export {};

package/dist/types/src/models/api/WorkPoolWorkerResponse.d.ts

@@ -0,0 +1,9 @@
+import { DateString } from '../../types/dates';
+export type WorkPoolWorkerResponse = {
+    id: string;
+    created: DateString;
+    updated: DateString;
+    name: string;
+    work_pool_id: string;
+    last_heartbeat_time: DateString;
+};

package/dist/types/src/models/api/WorkQueueFilterResponse.d.ts

@@ -0,0 +1,4 @@
+export type WorkQueueFilterResponse = {
+    tags: string[] | null;
+    deployment_ids: string[] | null;
+};

package/dist/types/src/models/api/WorkQueueHealthPolicyResponse.d.ts

@@ -0,0 +1,4 @@
+export type WorkQueueHealthPolicyResponse = {
+    maximum_late_runs: number;
+    maximum_seconds_since_last_polled: number;
+};

package/dist/types/src/models/api/WorkQueueRequest.d.ts

@@ -0,0 +1,11 @@
+export type WorkQueueCreateRequest = Partial<{
+    name: string | null;
+    description: string | null;
+    is_paused: boolean | null;
+    concurrency_limit: number | null;
+}>;
+export type WorkQueueEditRequest = Partial<{
+    description: string | null;
+    is_paused: boolean | null;
+    concurrency_limit: number | null;
+}>;

package/dist/types/src/models/api/WorkQueueResponse.d.ts

@@ -0,0 +1,14 @@
+import { WorkQueueFilterResponse } from '../../models/api/WorkQueueFilterResponse';
+import { DateString } from '../../types/dates';
+export type WorkQueueResponse = {
+    id: string;
+    created: DateString;
+    updated: DateString;
+    name: string;
+    filter?: WorkQueueFilterResponse;
+    description: string | null;
+    is_paused: boolean | null;
+    concurrency_limit: number | null;
+    priority: number;
+    work_pool_id: string;
+};

package/dist/types/src/models/api/WorkQueueStatusResponse.d.ts

@@ -0,0 +1,9 @@
+import { WorkQueueHealthPolicyResponse } from '../../models/api/WorkQueueHealthPolicyResponse';
+import { DateString } from '../../types/dates';
+export type WorkQueueStatusResponse = {
+    healthy: boolean;
+    late_runs_count: number;
+    last_polled: DateString | null;
+    health_check_policy: WorkQueueHealthPolicyResponse;
+    agent_detail: never[];
+};

package/dist/types/src/models/api/WorkerScheduledFlowRunResponse.d.ts

@@ -0,0 +1,6 @@
+import { FlowRunResponse } from '../../models';
+export type WorkerScheduledFlowRunResponse = {
+    work_pool_id: string;
+    work_pool_queue_id: string;
+    flow_run: FlowRunResponse;
+};

package/dist/types/src/models/api/WorkerScheduledFlowRunsRequest.d.ts

@@ -0,0 +1,6 @@
+export type WorkerScheduledFlowRunsRequest = Partial<{
+    work_pool_queue_names: string[];
+    scheduled_before: string;
+    scheduled_after: string;
+    limit: number;
+}>;

package/dist/types/src/models/api/index.d.ts

@@ -0,0 +1,51 @@
+export * from './BlockDocumentCreateRequest';
+export * from './BlockDocumentFilterRequest';
+export * from './BlockDocumentResponse';
+export * from './BlockDocumentUpdateRequest';
+export * from './BlockSchemaFilterRequest';
+export * from './BlockSchemaResponse';
+export * from './BlockTypeFilterRequest';
+export * from './BlockTypeResponse';
+export * from './ConcurrencyLimitCreateRequest';
+export * from './ConcurrencyLimitResponse';
+export * from './CreatedOrUpdatedByResponse';
+export * from './DeploymentFlowRunRequest';
+export * from './DeploymentResponse';
+export * from './DeploymentUpdateRequest';
+export * from './EmpiricalPolicyResponse';
+export * from './FlowResponse';
+export * from './FlowRunGraphResponse';
+export * from './FlowRunHistoryResponse';
+export * from './FlowRunResponse';
+export * from './LogResponse';
+export * from './LogsRequestFilter';
+export * from './NotificationCreateRequest';
+export * from './NotificationFilter';
+export * from './NotificationResponse';
+export * from './NotificationUpdateRequest';
+export * from './SavedSearchResponse';
+export * from './ScheduleRequest';
+export * from './ScheduleResponse';
+export * from './SchemaResponse';
+export * from './StateDetailsRequest';
+export * from './StateDetailsResponse';
+export * from './StateHistoryResponse';
+export * from './StateRequest';
+export * from './StateResponse';
+export * from './StateUpdateRequest';
+export * from './TaskInputResponse';
+export * from './TaskRunResponse';
+export * from './UiFlowRunHistoryResponse';
+export * from './WorkerScheduledFlowRunResponse';
+export * from './WorkerScheduledFlowRunsRequest';
+export * from './WorkPoolQueueRequest';
+export * from './WorkPoolQueueResponse';
+export * from './WorkPoolRequest';
+export * from './WorkPoolResponse';
+export * from './WorkPoolWorkerFilter';
+export * from './WorkPoolWorkerResponse';
+export * from './WorkQueueFilterResponse';
+export * from './WorkQueueHealthPolicyResponse';
+export * from './WorkQueueRequest';
+export * from './WorkQueueResponse';
+export * from './WorkQueueStatusResponse';

package/dist/types/src/models/index.d.ts

@@ -0,0 +1,66 @@
+export * from './api';
+export * from './ApiRouteParams';
+export * from './BlockDocument';
+export * from './BlockDocumentCreate';
+export * from './BlockDocumentFilter';
+export * from './BlockDocumentUpdate';
+export * from './BlockSchema';
+export * from './BlockSchemaFilter';
+export * from './BlockType';
+export * from './BlockTypeFilter';
+export * from './ConcurrencyLimit';
+export * from './ConcurrencyLimitCreate';
+export * from './ConcurrencyLimitsFilter';
+export * from './CreatedOrUpdatedBy';
+export * from './CronSchedule';
+export * from './CronStringLengthError';
+export * from './Deployment';
+export * from './DeploymentFlowRunCreate';
+export * from './DeploymentUpdate';
+export * from './EmpiricalPolicy';
+export * from './ExistingHandleError';
+export * from './FilterDateError';
+export * from './FilterPrefixError';
+export * from './FilterRelativeDateUnitError';
+export * from './Flow';
+export * from './FlowRun';
+export * from './GraphNode';
+export * from './IntervalSchedule';
+export * from './InvalidSchemaValueError';
+export * from './ISchedule';
+export * from './Log';
+export * from './NoSchemaPropertyDefaultValueError';
+export * from './Notification';
+export * from './NotificationCreate';
+export * from './NotificationUpdate';
+export * from './RRuleSchedule';
+export * from './RunHistory';
+export * from './SavedSearch';
+export * from './ServerSettings';
+export * from './Schedule';
+export * from './State';
+export * from './StateCreate';
+export * from './StateDetails';
+export * from './StateDetailsCreate';
+export * from './StateHistory';
+export * from './StateType';
+export * from './StateUpdate';
+export * from './TaskInput';
+export * from './TaskRun';
+export * from './TimelineNode';
+export * from './UiFlowRunHistory';
+export * from './WorkerScheduledFlowRun';
+export * from './WorkerScheduledFlowRuns';
+export * from './WorkPool';
+export * from './WorkPoolCreate';
+export * from './WorkPoolEdit';
+export * from './WorkPoolQueue';
+export * from './WorkPoolQueueCreate';
+export * from './WorkPoolQueueEdit';
+export * from './WorkPoolWorker';
+export * from './WorkQueue';
+export * from './WorkQueueCreate';
+export * from './WorkQueueEdit';
+export * from './WorkQueueFilter';
+export * from './WorkQueueHealthPolicy';
+export * from './WorkQueueStatus';

package/dist/types/src/router/index.d.ts

@@ -0,0 +1 @@
+export * from './routes';