ServerlessWorkflow.Sdk.Runtime 1.0.2

Prefix Reserved

dotnet add package ServerlessWorkflow.Sdk.Runtime --version 1.0.2

NuGet\Install-Package ServerlessWorkflow.Sdk.Runtime -Version 1.0.2

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="ServerlessWorkflow.Sdk.Runtime" Version="1.0.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="ServerlessWorkflow.Sdk.Runtime" Version="1.0.2" />
                    

                            Directory.Packages.props

<PackageReference Include="ServerlessWorkflow.Sdk.Runtime" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add ServerlessWorkflow.Sdk.Runtime --version 1.0.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ServerlessWorkflow.Sdk.Runtime, 1.0.2"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package ServerlessWorkflow.Sdk.Runtime@1.0.2

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=ServerlessWorkflow.Sdk.Runtime&version=1.0.2
                    

                            Install as a Cake Addin

#tool nuget:?package=ServerlessWorkflow.Sdk.Runtime&version=1.0.2
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ServerlessWorkflow.Sdk.Runtime

A .NET runtime for executing Serverless Workflow DSL definitions.

This package ships the services required to load, schedule, and execute workflow definitions, including task executors, expression evaluation (JQ and JavaScript via Jint), authentication, secret management, schema validation (JSON Schema, Avro, XML), and CloudEvents integration.

Installation

dotnet add package ServerlessWorkflow.Sdk.Runtime

Usage

using ServerlessWorkflow.Sdk.Runtime;

var builder = Host.CreateApplicationBuilder(args);

builder.Services.AddServerlessWorkflowRuntime(builder.Configuration);

Then resolve and use IWorkflowRuntime to run a workflow:

var runtime = host.Services.GetRequiredService<IWorkflowRuntime>();

var process = await runtime.RunAsync(definition, input, executionOptions: null, cancellationToken);
await process.WaitAsync(cancellationToken);

You can also run a workflow by reference:

var process = await runtime.RunAsync(
    @namespace: "samples",
    name: "fake-workflow",
    version: "0.1.0",
    input: input,
    executionOptions: null,
    cancellationToken);

Key services

Service	Role
`IWorkflowRuntime`	Entry point for running workflows.
`IWorkflowDefinitionStore`	Persists and retrieves workflow definitions.
`IWorkflowStateStore`	Persists workflow execution state.
`IWorkflowProcessFactory`	Creates `IWorkflowProcess` instances for execution.
`ITaskExecutor` / `TaskExecutorFactory`	Execute individual DSL tasks.
`RuntimeExpressionEvaluator`	Evaluates runtime expressions (JQ / JavaScript).
`AuthenticationHandler` / `OAuth2TokenManager`	Handles workflow authentication.
`SecretsManager`	Resolves secret references at runtime.
`ICloudEventBus`	Publishes and subscribes to CloudEvents.

ServerlessWorkflow.Sdk — core DSL models
ServerlessWorkflow.Sdk.Builders — fluent builders
ServerlessWorkflow.Sdk.Runtime.Cli — swf command-line runner
Project root

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.