@prefecthq/prefect-ui-library
Version:
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_.
415 lines (414 loc) • 15.1 kB
TypeScript
import { AutomationAction } from '../automations/types/actions';
import { CreateAutomationQuery } from '../automations/types/createAutomationQuery';
import { WorkspaceEvent } from '../models';
type CreateWorkspaceRoutesConfig = {
accountId: string;
workspaceId: string;
};
export declare function createWorkspaceRoutes(config?: CreateWorkspaceRoutesConfig): {
automations: () => {
readonly name: "workspace.automations";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
automation: (automationId: string) => {
readonly name: "workspace.automation.view";
readonly params: {
readonly automationId: string;
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
automationCreate: (automationQuery?: CreateAutomationQuery) => {
readonly name: "workspace.automation.create";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
readonly query: import("vue-router").LocationQuery | undefined;
};
automationEdit: (automationId: string) => {
readonly name: "workspace.automation.edit";
readonly params: {
readonly automationId: string;
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
automateEvent: (event: WorkspaceEvent, actions?: AutomationAction[]) => {
readonly name: "workspace.automation.create";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
readonly query: import("vue-router").LocationQuery;
};
automateFlow: (flowId: string, actions?: AutomationAction[]) => {
readonly name: "workspace.automation.create";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
readonly query: import("vue-router").LocationQuery;
};
automateWorkPool: (workPoolId: string, actions?: AutomationAction[]) => {
readonly name: "workspace.automation.create";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
readonly query: import("vue-router").LocationQuery;
};
automateWorkPoolQueue: (workPoolQueueId: string, actions?: AutomationAction[]) => {
readonly name: "workspace.automation.create";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
readonly query: import("vue-router").LocationQuery;
};
events: () => {
readonly name: "workspace.events";
};
event: (eventId: string, eventDate: Date) => {
readonly name: "workspace.event";
readonly params: {
readonly eventId: string;
readonly eventDate: string;
};
};
artifact: (artifactId: string) => {
readonly name: "workspace.artifacts.artifact";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly artifactId: string;
};
};
artifactKey: (artifactKey: string) => {
readonly name: "workspace.artifacts.artifact.key";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly artifactKey: string;
};
};
artifacts: () => {
readonly name: "workspace.artifacts";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
dashboard: () => {
readonly name: "workspace.dashboard";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
runs: (query?: {
tab?: string;
}) => {
readonly name: "workspace.runs";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
readonly query: {
tab?: string;
} | undefined;
};
/** @deprecated use workspace.runs instead */
flowRuns: () => {
readonly name: "workspace.flow-runs";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
flowRun: (flowRunId: string) => {
readonly name: "workspace.runs.flow-run";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly flowRunId: string;
};
};
taskRun: (taskRunId: string) => {
readonly name: "workspace.runs.task-run";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly taskRunId: string;
};
};
flows: () => {
readonly name: "workspace.flows";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
flow: (flowId: string) => {
readonly name: "workspace.flows.flow";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly flowId: string;
};
};
flowCollections: () => {
readonly name: "workspace.flows.collections";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
flowCollection: (name: string) => {
readonly name: "workspace.flows.collections.collection";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly name: string;
};
};
deployments: () => {
readonly name: "workspace.deployments";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
deployment: (deploymentId: string) => {
readonly name: "workspace.deployments.deployment";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly deploymentId: string;
};
};
deploymentEdit: (deploymentId: string) => {
readonly name: "workspace.deployments.deployment-edit";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly deploymentId: string;
};
};
deploymentDuplicate: (deploymentId: string) => {
readonly name: "workspace.deployments.deployment-duplicate";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly deploymentId: string;
};
};
deploymentFlowRunCreate: (deploymentId: string, parameters?: Record<string, unknown>) => {
readonly name: "workspace.deployments.deployment-flow-run-create";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly deploymentId: string;
};
readonly query: {
parameters: string;
} | {
parameters?: undefined;
};
};
workQueues: () => {
readonly name: "workspace.work-queues";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
workQueue: (workQueueId: string) => {
readonly name: "workspace.work-queues.work-queue";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly workQueueId: string;
};
};
workQueueCreate: () => {
readonly name: "workspace.work-queues.work-queue-create";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
workQueueEdit: (workQueueId: string) => {
readonly name: "workspace.work-queues.work-queue-edit";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly workQueueId: string;
};
};
blocks: () => {
readonly name: "workspace.blocks";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
blocksCatalog: () => {
readonly name: "workspace.blocks.catalog";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
blocksCatalogView: (blockTypeSlug: string) => {
readonly name: "workspace.blocks.catalog-view";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly blockTypeSlug: string;
};
};
blockCreate: (blockTypeSlug: string) => {
readonly name: "workspace.blocks.block-create";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly blockTypeSlug: string;
};
};
block: (blockDocumentId: string) => {
readonly name: "workspace.blocks.block";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly blockDocumentId: string;
};
};
blockEdit: (blockDocumentId: string) => {
readonly name: "workspace.blocks.block-edit";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly blockDocumentId: string;
};
};
notifications: () => {
readonly name: "workspace.notifications";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
notificationCreate: () => {
readonly name: "workspace.notifications.create";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
notificationEdit: (notificationId: string) => {
readonly name: "workspace.notifications.notification-edit";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly notificationId: string;
};
};
concurrencyLimit: (concurrencyLimitId: string) => {
readonly name: "workspace.concurrency-limits.concurrency-limit";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly concurrencyLimitId: string;
};
};
concurrencyLimits: () => {
readonly name: "workspace.concurrency-limits";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
concurrencyLimitsV2: () => {
readonly name: "workspace.concurrency-limits-v2";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
concurrencyLimitV2: (concurrencyLimitId: string) => {
readonly name: "workspace.concurrency-limits-v2.concurrency-limit";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly concurrencyLimitId: string;
};
};
variables: () => {
readonly name: "workspace.variables";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
workPools: () => {
readonly name: "workspace.work-pools";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
workPool: (workPoolName: string) => {
readonly name: "workspace.work-pools.work-pool";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly workPoolName: string;
};
};
workPoolCreate: () => {
readonly name: "workspace.work-pools.work-pool-create";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
};
};
workPoolEdit: (workPoolName: string) => {
readonly name: "workspace.work-pools.work-pool-edit";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly workPoolName: string;
};
};
workPoolQueue: (workPoolName: string, workPoolQueueName: string) => {
readonly name: "workspace.work-pools.work-pool.work-pool-queue";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly workPoolName: string;
readonly workPoolQueueName: string;
};
};
workPoolQueueCreate: (workPoolName: string) => {
readonly name: "workspace.work-pools.work-pool.work-pool-queue-create";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly workPoolName: string;
};
};
workPoolQueueEdit: (workPoolName: string, workPoolQueueName: string) => {
readonly name: "workspace.work-pools.work-pool.work-pool-queue-edit";
readonly params: {
readonly accountId?: string | undefined;
readonly workspaceId?: string | undefined;
readonly workPoolName: string;
readonly workPoolQueueName: string;
};
};
};
export {};