Function defineWorkflowConfig

defineWorkflowConfig(
    config: WorkflowConfigInput,
): {
    deployments: {
        definitions: {
            description?: string;
            fields?: FieldEntry[];
            groups?: Group[];
            initialStage: string;
            lifecycle?: WorkflowLifecycle;
            name: string;
            predicates?: Record<string, string>;
            roleAliases?: RoleAliases;
            semantics?: Semantic[];
            stages: Stage[];
            start?: StartBlock;
            title: string;
        }[];
        expectedMinReaderModel?: number;
        name: string;
        resourceAliases?: {
            name: string;
            resource: | { id: string; type: "dataset" }
            | { id: string; type: "canvas" }
            | { id: string; type: "media-library" }
            | { id: string; type: "dashboard" };
        }[];
        tag: string;
        workflowResource: | { id: string; type: "dataset" }
        | { id: string; type: "canvas" }
        | { id: string; type: "media-library" }
        | { id: string; type: "dashboard" };
    }[];
    telemetry?: WorkflowTelemetryLogger;
}
Validate a deploy config — the binding of each definition's logical resource handles to physical resources, per environment (tag). Throws a formatted, path-prefixed error if the shape is invalid. The CLI collapses the selected deployment's bindings via resourceAliasesToMap into the resourceAliases map deployDefinitions expands against.

Validates shape only; reader-floor acknowledgement belongs to paths that submit definitions (deployDefinitions, the CLI deploy and definition-diff commands, and blueprint provision). Other commands may load a selected deployment with a missing floor.

Each WorkflowDeploymentInput carries an acknowledgement; definition-submission paths compare it with the submitted definitions. The returned WorkflowConfig is the looser parsed shape.
Parameters
- config: WorkflowConfigInput
Returns {
    deployments: {
        definitions: {
            description?: string;
            fields?: FieldEntry[];
            groups?: Group[];
            initialStage: string;
            lifecycle?: WorkflowLifecycle;
            name: string;
            predicates?: Record<string, string>;
            roleAliases?: RoleAliases;
            semantics?: Semantic[];
            stages: Stage[];
            start?: StartBlock;
            title: string;
        }[];
        expectedMinReaderModel?: number;
        name: string;
        resourceAliases?: {
            name: string;
            resource: | { id: string; type: "dataset" }
            | { id: string; type: "canvas" }
            | { id: string; type: "media-library" }
            | { id: string; type: "dashboard" };
        }[];
        tag: string;
        workflowResource: | { id: string; type: "dataset" }
        | { id: string; type: "canvas" }
        | { id: string; type: "media-library" }
        | { id: string; type: "dashboard" };
    }[];
    telemetry?: WorkflowTelemetryLogger;
}

Function defineWorkflowConfig

Parameters

Settings