Xeku.Scripts 0.0.0.7

Xeku.Scripts

An XAF module for dynamic C# script compilation and execution using Roslyn.

Features

• Script Types: Support for Action, Function, Validator, and Transformer patterns.
• Dynamic Compilation: Compile C# code at runtime using Roslyn.
• IScriptService: Programmatic API for executing scripts from other modules or code.
• Asynchronous Support: Full support for async/await in script logic.
• Monaco Editor Integration: Professional code editor with syntax highlighting.
• ScriptContext API: Simplified interface for scripts to interact with XAF.
• Execution Logging: Track script execution history with JSON serialization for complex return values.
• Assembly Caching: Optimized performance through compiled assembly caching.

Installation

dotnet add package Xeku.Scripts

Dependencies

• Xeku.Core - Core module with common services
• Xeku.Editors - Monaco editor support

Usage

Script Types

Basic Script Structure

public class ScriptMain
{
    // Example Action Script
    public void Run(ScriptContext ctx)
    {
        ctx.ShowMessage("Hello from Script!");
    }
}

IScriptService

Register the service in your startup:

services.AddScripts();

Usage in your code:

public class MyService {
    private readonly IScriptService _scriptService;
    
    public async Task Process() {
        var result = await _scriptService.ExecuteAsync("MyScript");
        if (result.IsSuccess) {
            // Handle success
        }
    }
}

ScriptContext API

Integration

1. Add module reference in your Module.cs:

RequiredModuleTypes.Add(typeof(Xeku.Scripts.ScriptsModule));

2. Register services in Startup.cs:

public void ConfigureServices(IServiceCollection services) {
    // ...
    services.AddScripts();
}

AI Code Generation 🤖

This module supports automatic script code generation using Large Language Models (LLMs).

Supported LLM Providers

Configuration

# Set LLM provider (openai, gemini, azureopenai, ollama)
setx LLM_PROVIDER "gemini"

# Set API key based on provider
setx GEMINI_API_KEY "your-api-key"

Business Object Auto-Discovery

The AI generation feature automatically scans all Business Objects in your project, allowing AI to understand available classes and properties. Users simply describe their requirements in natural language, for example:

Query all orders created today, calculate total amount and display

AI will automatically generate correct code based on your project's Order class and its properties.

Business Objects

Actions

Architecture

graph TD
    subgraph Runtime
        Script[Script Business Object]
        Roslyn[Roslyn Compiler]
        Cache[Assembly Cache]
    end
    
    subgraph Execution
        Controller[ScriptController]
        Context[ScriptContext]
        Log[ExecutionLog]
    end
    
    Script --> Roslyn
    Roslyn --> Cache
    Controller --> Script
    Controller --> Context
    Controller --> Log

License

Proprietary - Xeku Solutions