Added IO and Validation services

Author: cdavernas

ServerlessWorkflow.Sdk/Extensions/EvaluationResultsExtensions.cs

@@ -0,0 +1,19 @@
+namespace ServerlessWorkflow.Sdk;
+
+/// <summary>
+/// Defines extensions for <see cref="EvaluationResults"/>
+/// </summary>
+public static class EvaluationResultsExtensions
+{
+
+    /// <summary>
+    /// Gets the errors that have occured during evaluation
+    /// </summary>
+    /// <param name="results">The extended <see cref="EvaluationResults"/></param>
+    /// <returns>A new <see cref="IEnumerable{T}"/> containing key/value mapping of the errors that have occured during evaluation</returns>
+    public static IEnumerable<KeyValuePair<string, string>> GetErrors(this EvaluationResults results)
+    {
+        return results.Details.Where(d => !d.IsValid && d.Errors?.Any() == true).Select(e => new KeyValuePair<string, string>(e.EvaluationPath.ToString(), string.Join(Environment.NewLine, e.Errors!.Select(kvp => kvp.Value))));
+    }
+
+}

ServerlessWorkflow.Sdk/Extensions/IServiceCollectionExtensions.cs

@@ -0,0 +1,33 @@
+using FluentValidation;
+using Microsoft.Extensions.DependencyInjection;
+using ServerlessWorkflow.Sdk.Services.FluentBuilders;
+using ServerlessWorkflow.Sdk.Services.IO;
+using ServerlessWorkflow.Sdk.Services.Validation;
+
+namespace ServerlessWorkflow.Sdk;
+
+/// <summary>
+/// Defines extensions for <see cref="IServiceCollection"/>s
+/// </summary>
+public static class IServiceCollectionExtensions
+{
+
+    /// <summary>
+    /// Adds and configures Serverless Workflow services (<see cref="Neuroglia.Serialization.ISerializer"/>s, <see cref="IWorkflowReader"/>, <see cref="IWorkflowWriter"/>, ...)
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection"/> to configure</param>
+    /// <returns>The configured <see cref="IServiceCollection"/></returns>
+    public static IServiceCollection AddServerlessWorkflow(this IServiceCollection services)
+    {
+        services.AddHttpClient();
+        services.AddSingleton<IWorkflowExternalDefinitionResolver, WorkflowExternalDefinitionResolver>();
+        services.AddSingleton<IWorkflowReader, WorkflowReader>();
+        services.AddSingleton<IWorkflowWriter, WorkflowWriter>();
+        services.AddSingleton<IWorkflowSchemaValidator, WorkflowSchemaValidator>();
+        services.AddSingleton<IWorkflowValidator, WorkflowValidator>();
+        services.AddTransient<IWorkflowBuilder, WorkflowBuilder>();
+        services.AddValidatorsFromAssemblyContaining<WorkflowDefinitionValidator>(ServiceLifetime.Singleton);
+        return services;
+    }
+
+}

ServerlessWorkflow.Sdk/Extensions/IWorkflowReaderExtensions.cs

@@ -0,0 +1,60 @@
+using ServerlessWorkflow.Sdk.Models;
+using ServerlessWorkflow.Sdk.Services.IO;
+using System;
+using System.IO;
+using System.Text;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace ServerlessWorkflow.Sdk
+{
+
+    /// <summary>
+    /// Defines extensions for <see cref="IWorkflowReader"/>s
+    /// </summary>
+    public static class IWorkflowReaderExtensions
+    {
+
+        /// <summary>
+        /// Reads a <see cref="WorkflowDefinition"/> from the specified <see cref="Stream"/>
+        /// </summary>
+        /// <param name="reader">The extended <see cref="IWorkflowReader"/></param>
+        /// <param name="stream">The <see cref="Stream"/> to read the <see cref="WorkflowDefinition"/> from</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new <see cref="WorkflowDefinition"/></returns>
+        public static async Task<WorkflowDefinition> ReadAsync(this IWorkflowReader reader, Stream stream, CancellationToken cancellationToken = default)
+        {
+            return await reader.ReadAsync(stream, new(), cancellationToken);
+        }
+
+        /// <summary>
+        /// Parses the specified input into a new <see cref="WorkflowDefinition"/>
+        /// </summary>
+        /// <param name="reader">The extended <see cref="IWorkflowReader"/></param>
+        /// <param name="input">The input to parse</param>
+        /// <param name="options"><see cref="WorkflowReaderOptions"/> to use</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new <see cref="WorkflowDefinition"/></returns>
+        public static async Task<WorkflowDefinition> ParseAsync(this IWorkflowReader reader, string input, WorkflowReaderOptions options, CancellationToken cancellationToken = default)
+        {
+            if (string.IsNullOrWhiteSpace(input))
+                throw new ArgumentNullException(nameof(input));
+            using Stream stream = new MemoryStream(Encoding.UTF8.GetBytes(input));
+            return await reader.ReadAsync(stream, options, cancellationToken);
+        }
+
+        /// <summary>
+        /// Parses the specified input into a new <see cref="WorkflowDefinition"/>
+        /// </summary>
+        /// <param name="reader">The extended <see cref="IWorkflowReader"/></param>
+        /// <param name="input">The input to parse</param>
+        /// <param name="cancellationToken">A <see cref="CancellationToken"/></param>
+        /// <returns>A new <see cref="WorkflowDefinition"/></returns>
+        public static async Task<WorkflowDefinition> ParseAsync(this IWorkflowReader reader, string input,CancellationToken cancellationToken = default)
+        {
+            return await reader.ParseAsync(input, new(), cancellationToken);
+        }
+
+    }
+
+}

ServerlessWorkflow.Sdk/Extensions/StringExtensions.cs

@@ -27,4 +27,21 @@ public static class StringExtensions
     /// <returns>The snake-cased string</returns>
     public static string ToSnakeCase(this string input) => YamlDotNet.Serialization.NamingConventions.UnderscoredNamingConvention.Instance.Apply(input);
 
+    /// <summary>
+    /// Determines whether or not the specified input is JSON format
+    /// </summary>
+    /// <param name="text">The input to check</param>
+    /// <returns>A boolean indicating whether or not the specified text is JSON format</returns>
+    public static bool IsJson(this string text)
+    {
+        if (string.IsNullOrWhiteSpace(text)) throw new ArgumentNullException(nameof(text));
+        var text2 = text.Trim();
+        if (!text2.StartsWith("[") || !text2.EndsWith("]"))
+        {
+            if (text2.StartsWith("{")) return text2.EndsWith("}");
+            else return false;
+        }
+        return true;
+    }
+
 }

ServerlessWorkflow.Sdk/Extensions/WorkflowDefinitionExtensions.cs

@@ -0,0 +1,51 @@
+namespace ServerlessWorkflow.Sdk;
+
+/// <summary>
+/// Defines extensions for <see cref="WorkflowDefinition"/>s
+/// </summary>
+public static class WorkflowDefinitionExtensions
+{
+
+    /// <summary>
+    /// Gets all the <see cref="ActionDefinition"/>s of the specified type declared in the <see cref="WorkflowDefinition"/>
+    /// </summary>
+    /// <param name="workflow">The <see cref="WorkflowDefinition"/> to query</param>
+    /// <param name="type">The type of <see cref="ActionDefinition"/>s to get. A null value gets all <see cref="ActionDefinition"/>s</param>
+    /// <returns>A new <see cref="IEnumerable{T}"/> containing the <see cref="ActionDefinition"/>s of the specified type declared in the <see cref="WorkflowDefinition"/></returns>
+    public static IEnumerable<ActionDefinition> GetActions(this WorkflowDefinition workflow, string? type = null)
+    {
+        var actions = workflow.States.SelectMany(s => s switch
+        {
+            CallbackStateDefinition callbackState => new ActionDefinition[] { callbackState.Action! },
+            EventStateDefinition eventState => eventState.OnEvents.SelectMany(t => t.Actions),
+            ForEachStateDefinition foreachState => foreachState.Actions,
+            OperationStateDefinition operationState => operationState.Actions,
+            ParallelStateDefinition parallelState => parallelState.Branches.SelectMany(b => b.Actions),
+            _ => Array.Empty<ActionDefinition>()
+        });
+        if (!string.IsNullOrWhiteSpace(type)) actions = actions.Where(a => a.Type == type);
+        return actions;
+    }
+
+    /// <summary>
+    /// Gets all the <see cref="FunctionReference"/>s declared in the <see cref="WorkflowDefinition"/>
+    /// </summary>
+    /// <param name="workflow">The <see cref="WorkflowDefinition"/> to query</param>
+    /// <returns>A new <see cref="IEnumerable{T}"/> containing the <see cref="FunctionReference"/>s declared in the <see cref="WorkflowDefinition"/></returns>
+    public static IEnumerable<FunctionReference> GetFunctionReferences(this WorkflowDefinition workflow) => workflow.GetActions(ActionType.Function).Select(a => a.Function)!;
+
+    /// <summary>
+    /// Gets all the <see cref="EventReference"/>s declared in the <see cref="WorkflowDefinition"/>
+    /// </summary>
+    /// <param name="workflow">The <see cref="WorkflowDefinition"/> to query</param>
+    /// <returns>A new <see cref="IEnumerable{T}"/> containing the <see cref="EventReference"/>s declared in the <see cref="WorkflowDefinition"/></returns>
+    public static IEnumerable<EventReference> GetEventReferences(this WorkflowDefinition workflow) => workflow.GetActions(ActionType.Event).Select(a => a.Event)!;
+
+    /// <summary>
+    /// Gets all the <see cref="SubflowReference"/>s declared in the <see cref="WorkflowDefinition"/>
+    /// </summary>
+    /// <param name="workflow">The <see cref="WorkflowDefinition"/> to query</param>
+    /// <returns>A new <see cref="IEnumerable{T}"/> containing the <see cref="SubflowReference"/>s declared in the <see cref="WorkflowDefinition"/></returns>
+    public static IEnumerable<SubflowReference> GetSubflowReferences(this WorkflowDefinition workflow) => workflow.GetActions(ActionType.Subflow).Select(a => a.Subflow)!;
+
+}

ServerlessWorkflow.Sdk/Models/ExternalDefinitionCollection.cs

@@ -0,0 +1,53 @@
+namespace ServerlessWorkflow.Sdk.Models;
+
+/// <summary>
+/// Represents a <see cref="List{T}"/> that can be loaded from an external definition file
+/// </summary>
+/// <typeparam name="T">The type of elements contained by the <see cref="ExternalDefinitionCollection{T}"/></typeparam>
+public class ExternalDefinitionCollection<T>
+    : List<T>
+{
+
+    /// <summary>
+    /// Initializes a new <see cref="ExternalDefinitionCollection{T}"/>
+    /// </summary>
+    public ExternalDefinitionCollection()
+        : base()
+    {
+        this.DefinitionUri = null!;
+        this.Loaded = true;
+    }
+
+    /// <summary>
+    /// Initializes a new <see cref="ExternalDefinitionCollection{T}"/>
+    /// </summary>
+    /// <param name="collection">The collection whose elements are copied into the <see cref="ExternalDefinitionCollection{T}"/></param>
+    public ExternalDefinitionCollection(IEnumerable<T> collection)
+        : base(collection)
+    {
+        this.DefinitionUri = null!;
+        this.Loaded = true;
+    }
+
+    /// <summary>
+    /// Initializes a new <see cref="ExternalDefinitionCollection{T}"/>
+    /// </summary>
+    /// <param name="definitionUri">The <see cref="Uri"/> used to reference the file that defines the elements contained by the <see cref="ExternalDefinitionCollection{T}"/></param>
+    public ExternalDefinitionCollection(Uri definitionUri)
+        : base()
+    {
+        this.DefinitionUri = definitionUri;
+        this.Loaded = false;
+    }
+
+    /// <summary>
+    /// Gets the <see cref="Uri"/> used to reference the file that defines the elements contained by the <see cref="ExternalDefinitionCollection{T}"/>
+    /// </summary>
+    public virtual Uri DefinitionUri { get; private set; }
+
+    /// <summary>
+    /// Gets a boolean indicating whether or not the <see cref="ExternalDefinitionCollection{T}"/> has been loaded
+    /// </summary>
+    public virtual bool Loaded { get; }
+
+}