Note

By design, user facing contracts such as events, values or nodes must implement marker interfaces.This enforces contracts to be explicitly define and decoupled from logic.

Getting started

Using SafeNodes assemblies

// when defining contractsusingSafeNodes.Design;// when using the runtimeusingSafeNodes.Runtime;

Defining a custom value

[Api("my-text-value")]publicsealedrecordTextValue(stringValue):IValue;

[Api("my-trim-text-initializer")]publicsealedclassTrimTextInitializer:IValueInitializer<TextValue>{publicTextValueInitializeValue(stringrawValue){returnnewTextValue(rawValue.Trim());}}

Defining an event

// you could have as much data as you want here, I just keep things simplepublicsealedrecordBlankData:IEventData;[Api("my-blank-event")]publicsealedclassBlankEvent:IEvent<BlankData>{publicvoidDefine(BlankDatadata){// initializes the event using the data if needed}// Whether this event will be triggerd, you can use the event data here.publicboolIsActivated()=>true;}

Defining a node

[Api("my-print-node")]publicsealedclassPrintNode(IInput<TextValue>textToPrint,ITriggerdone,IOutput<TextValue>textOutput):INode{[Api("print-text")]publicIInput<TextValue>TextToPrint{get;}=textToPrint;[Api("text")]publicIOutput<TextValue>TextOutput{get;}=textOutput;[Api("done")]publicITriggerDone{get;}=done;// this is where the logic goespublicasyncTask<ErrorOr<Success>>Execute(CancellationTokencancellationToken){vartextToPrint=TextToPrint.Get();Console.WriteLine(textToPrint);TextOutput.Set(textToPrint);// awaits for the children nodes (and their children) to completeawaitDone.Trigger(cancellationToken);returnResult.Success;}}

Pipelines

// make nodes to benchmark implement this interfacepublicinterfaceIBenchmarkMe;publicsealedclassBenchmarkNodes<TNode>:INodeContextPipeline<TNode>whereTNode:IBenchmarkMe,INode{publicasyncTask<IErrorOr>Next(TNodenode,NodeContextPipelineNextnext,CancellationTokencancellationToken){varstopwatch=newStopwatch();varresult=awaitnext();Console.WriteLine($"{typeof(TNode)} execution time ticks :{stopwatch.ElapsedTicks}");returnresult;}}

Running a blueprint

// setup a DI containervarbuilder=newContainerBuilder();// don't forget to add the SafeNodesModule in the DI containerbuilder.RegisterModule<SafeNodesModule>();// your defined types need to be added to the DI container !!// the recommended lifetime is Transient (InstancePerDependency)builder.RegisterTypes([typeof(BlankEvent),typeof(PrintNode),typeof(TrimTextInitializer)]).AsImplementedInterfaces().InstancePerDependency();builder.RegisterGeneric(typeof(BenchmarkNodes<>)).AsImplementedInterfaces().InstancePerDependency();varapp=builder.Build();awaitusingvarscope=app.BeginLifetimeScope();varblueprintRuntime=scope.Resolve<IBlueprintRuntime>();Console.WriteLine("Runtime ...");// this is your blueprint definition.// use the API references here.varblueprint=newBlueprint{Event=newBlueprintEvent{EventReference="my-blank-event"},Nodes=[newBlueprintNode{// this id is a runtime id,// this allows to have multiple nodes of the same typesId="node-1",NodeReference="my-print-node",IsEntrypoint=true,// this node is triggered by the eventInputs=[newBlueprintNodeInput{InputReference="print-text",// set the input value from a raw value and an initializerInitializer=newBlueprintNodeInputInitializer{InitializerReference="my-trim-text-initializer",RawValue=" Hello, World ! "}}],},newBlueprintNode{Id="node-2",NodeReference="my-print-node",Inputs=[newBlueprintNodeInput{InputReference="print-text",// this is the value to set to input to,// it comes from the output 'text' of the node 'node-id'Source=newBlueprintNodeInputSource{NodeId="node-1",OutputReference="text"}}],// this node is not triggered by the event,// rather by the 'done' trigger of the 'node-1' nodeTrigger=newBlueprintNodeTrigger{NodeId="node-1",TriggerReference="done"}}]};// execute the blueprint, throws if the event data is not compatible with the blueprint's eventawaitblueprintRuntime.ExecuteMandatory(blueprint,newBlankData());// execute the blueprint or skip when the event data is not compatible// var blueprintWasExecuted = await blueprintRuntime.Execute(blueprint, new BlankData());