Combine.DataController.Sdk 3.0.0

Combine.DataController.Sdk

SDK for building plugins for the Combine.DataController platform.

A plugin is a compiled .NET assembly that exposes one or more tasks. Tasks are invoked by process Tasks at runtime, with their input and output mapped to/from the running process context.

Install

dotnet add package Combine.DataController.Sdk

The package ships with a Roslyn analyzer (DC1001–DC1003) that validates your task and plugin types at compile time.

Minimal task

using Combine.DataController.Sdk;

public sealed class SendEmailInput
{
    public string To { get; set; } = "";
    public string Subject { get; set; } = "";
    public string Body { get; set; } = "";
}

public sealed class SendEmailOutput
{
    public bool Success { get; set; }
    public string MessageId { get; set; } = "";
}

[Task("Send email")]
public sealed class SendEmailTask : ITask<SendEmailInput, SendEmailOutput>
{
    public Task<SendEmailOutput> ExecuteAsync(SendEmailInput input, CancellationToken ct)
    {
        // ... do the work ...
        return Task.FromResult(new SendEmailOutput { Success = true, MessageId = "abc-123" });
    }
}

Public surface

Supported property types

TInput and TOutput properties (and any IModel they reference) must use one of:

• string, int, long, decimal, double, float, bool, Guid, DateTime, DateTimeOffset
• System.Text.Json.JsonDocument
• byte[] (binary blob — JSON-serialised as a base64 string)
• A type implementing IModel
• A Nullable<T> of any of the above
• A collection (ICollection<T>, List<T>, T[]) of any of the above

byte[] is the only allowed byte-based type — bare byte, byte?, and List<byte> are intentionally not supported. Use byte[] for binary data.

Anything else is reported as compile-time error DC1001 by the bundled analyzer.

Analyzer diagnostics

Plugin with options

using Combine.DataController.Sdk;
using Microsoft.Extensions.DependencyInjection;

public sealed class SmtpOptions : IPluginOptions
{
    public string Host { get; set; } = "";
    public int    Port { get; set; } = 587;

    [Sensitive]
    public string Password { get; set; } = "";
}

public sealed class SmtpPlugin : IPlugin<SmtpOptions>
{
    public void Configure(IServiceCollection services, SmtpOptions options)
    {
        services.AddSingleton(options);
        services.AddSingleton<ISmtpClient>(_ => new SmtpClient(options.Host, options.Port));
    }
}

The host binds SmtpOptions from the Plugins:Smtp configuration section. Per-task overrides can be applied via OptionMappings in the process element configuration.