DxWorks.ScriptBee.Plugin.Api 2.0.0

Prefix Reserved
.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package DxWorks.ScriptBee.Plugin.Api --version 2.0.0
                    


                    

                
NuGet\Install-Package DxWorks.ScriptBee.Plugin.Api -Version 2.0.0
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="DxWorks.ScriptBee.Plugin.Api" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="DxWorks.ScriptBee.Plugin.Api" Version="2.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="DxWorks.ScriptBee.Plugin.Api" />
                    


                            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 DxWorks.ScriptBee.Plugin.Api --version 2.0.0
                    


                    

                
#r "nuget: DxWorks.ScriptBee.Plugin.Api, 2.0.0"
#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 DxWorks.ScriptBee.Plugin.Api@2.0.0
#: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=DxWorks.ScriptBee.Plugin.Api&version=2.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=DxWorks.ScriptBee.Plugin.Api&version=2.0.0
                    


                            Install as a Cake Tool

DxWorks.ScriptBee.Plugin.Api

This is the API for the ScriptBee plugin. It contains the interfaces and classes that are used by the plugin to communicate with the ScriptBee service.

For entire documentation check ScriptBee Plugin API

Currently, ScriptBee supports the following types of plugins:

Every plugin must have a manifest.yaml file in its root directory. More information about the manifest can be found in the manifest section.

Services

Besides the plugin interfaces, ScriptBee offers a set of services that can be used by plugins via dependency injection.

IHelperFunctionsContainer

The IHelperFunctionsContainer service is used to register helper functions. Helper functions are a way to extend the functionality of ScriptBee. They can be used to add custom functions that can be used in the scripts directly.

IHelperFunctionsContainer wraps the helper functions and provides a way to access them.

public interface IHelperFunctionsContainer
{
    public Dictionary<string, Delegate> GetFunctionsDictionary();

    public IEnumerable<IHelperFunctions> GetFunctions();
}

ScriptRunner uses the IHelperFunctionsContainer service to get the helper functions and add them to the script engine.

IHelperFunctionsResultService

The IHelperFunctionsResultService service is used to store the results of the helper functions and have a uniform way to deal with script outputs.

public interface IHelperFunctionsResultService
{
    Task UploadResultAsync(string fileName, string type, string content, CancellationToken cancellationToken = default);

    Task UploadResultAsync(string fileName, string type, Stream content, CancellationToken cancellationToken = default);

    void UploadResult(string fileName, string type, string content);

    void UploadResult(string fileName, string type, Stream content);
}

ScriptBee's default helper functions use the IHelperFunctionsResultService service to upload the results of the helper functions.

Run Result Types

ScriptBee has a set of predefined result types that can be used by the helper functions to upload the results.

public static class RunResultDefaultTypes
{
    public const string ConsoleType = "Console";
    public const string FileType = "File";
    public const string RunError = "RunError";
}
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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (4)

Showing the top 4 NuGet packages that depend on DxWorks.ScriptBee.Plugin.Api:

Package Downloads
DxWorks.ScriptBee.Plugins.Honeydew

Honeydew ScriptBee Loader Plugin
DxWorks.ScriptBee.Plugins.InspectorGit

Inspector Git ScriptBee Loader Plugin
DxWorks.ScriptBee.Plugins.JiraMiner

Jira Miner ScriptBee Loader Plugin
DxWorks.ScriptBee.Plugins.SoftwareAssessment

Software AssessmentScriptBee Linker Plugin

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.0 108 4/6/2026
1.1.0 1,111 3/18/2023
1.0.0 1,577 12/1/2022
0.0.0 1,057 5/8/2022

# Version 2.0.0

## Changes

- upgrade to use dotnet 10
- update Westwind.Utilities to 5.2.8.1