Muonroi.UiEngine.Catalog 1.0.0-alpha.16

Muonroi.UiEngine.Catalog

Runtime catalog service that scans ASP.NET Core APIs and rule engine rules, builds API-to-rule bindings and a dependency graph, and exposes them through REST endpoints consumed by the Muonroi Rule Studio UI.

Muonroi.UiEngine.Catalog is a commercial ASP.NET Core library that auto-discovers API endpoints and IRule<TContext> implementations from the running application, links them into a typed catalog graph, and serves the result over dedicated REST routes (/api/v1/ui-engine/catalog/*). Snapshots of the graph can be persisted in PostgreSQL or SQL Server for historical diffing and UI-driven navigation. The package is consumed by the mu-rule-flow-designer frontend palette and by the Muonroi Rule Studio.

Installation

dotnet add package Muonroi.UiEngine.Catalog --prerelease

Quick Start

Call AddUiEngineCatalog inside Program.cs, then add the controllers to the MVC pipeline. Without a connection string the catalog uses an in-memory snapshot store (suitable for development).

// Program.cs
var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();
builder.Services.AddUiEngineCatalog(options =>
{
    // Optional: persist snapshots to PostgreSQL
    options.PostgresConnectionString =
        builder.Configuration.GetConnectionString("Catalog");
    options.Schema = "catalog";
    options.AutoMigrateDatabase = true;
});

var app = builder.Build();
app.MapControllers();
app.Run();

Once the app is running the following endpoints are available:

Features

• API scanning — reflects over all registered ApiDescription groups to produce typed MUiEngineCatalogApiDescriptor records with route, HTTP method, auth schemes, request/response types, and tenant-requirement flag.
• Rule scanning — walks all loaded assemblies for concrete IRule<TContext> and ICompensatableRule<TContext> implementations and captures code, order, hook point, rule type, and dependency list.
• Binding resolution — links APIs to the rules they invoke via [BindRuleContext] attribute metadata.
• Dependency graph — builds a MUiEngineCatalogGraph from scanned APIs and rules for visualisation in Rule Studio.
• Snapshot persistence — saves and retrieves graph snapshots per tenant via ICatalogSnapshotStore; backed by PostgreSQL (Npgsql), SQL Server (EF Core), or an in-memory store when no connection string is configured.
• Auto-migration — UiEngineCatalogDatabaseMigrator runs EnsureCreatedAsync on startup when AutoMigrateDatabase = true.
• Rule Studio palette — MRuleCatalogCompatController returns rule groups in the shape expected by MRuleCatalogService on the frontend, with optional category and search query filters.
• Connector catalog — MConnectorCatalogController exposes IConnectorRegistry.ListAvailable() without authentication (the flow designer calls this endpoint directly).
• Per-tenant caching — catalog responses are cached in IMemoryCache with a 5-minute absolute expiry, keyed by tenant ID.

Configuration

DI registration

services.AddUiEngineCatalog(options =>
{
    // Use PostgreSQL for persistent snapshots
    options.PostgresConnectionString = "Host=...;Database=catalog;...";

    // — or — SQL Server
    options.SqlServerConnectionString = "Server=...;Database=catalog;...";

    // Database schema (default: "dbo")
    options.Schema = "dbo";

    // Run EF Core migrations on startup (default: true)
    options.AutoMigrateDatabase = true;
});

When neither connection string is set, ICatalogSnapshotStore is bound to InMemoryCatalogSnapshotStore — no database is required.

UiEngineCatalogOptions properties

API Reference

Samples

No dedicated sample exists for this package. The Quick Start above is grounded directly in the public API.

Compatibility

• Target framework: net8.0
• Requires: Microsoft.AspNetCore.App framework reference
• License: Commercial — requires a valid Muonroi license. See LICENSE-COMMERCIAL.

Related Packages

• Muonroi.Core.Abstractions — defines ICatalogScanService, ICatalogSnapshotStore, and all catalog model types
• Muonroi.RuleEngine.Abstractions — defines IRule<TContext> and ICompensatableRule<TContext> that the scanner discovers
• Muonroi.RuleEngine.Runtime — rule runtime whose RuleOptions the scanner reads for runtime-registered rules
• Muonroi.Integration.Abstractions — defines IConnectorRegistry consumed by the connector catalog endpoint
• Muonroi.AspNetCore — host package that wires the catalog into the broader UI engine manifest pipeline

License

This package requires a commercial Muonroi license. See LICENSE-COMMERCIAL for terms. Contact leanhphi1706@gmail.com for activation.