Coject.Workshop.Metadata 1.0.0

Coject.Workshop.Metadata

Coject.Workshop.Metadata is a .NET library for Workshop audit metadata, validation, deterministic generation plans, and C# source-artifact helpers for controller and model audit workflows.

This is generation-time metadata/source-generation support. It is not runtime Controller integration: it does not register controllers, provide middleware or request handling, or execute audit logging at runtime.

Target framework

• net8.0

Installation

<PackageReference Include="Coject.Workshop.Metadata" Version="1.0.0" />

The package depends exactly on Coject.Core.Logging.Contracts version 3.0.0.

Minimal usage

The following uses the public metadata, planning, and generation APIs to render an inline model audit contract:

using Coject.Workshop.Metadata;

var metadata = new WorkshopModelAuditMetadata
{
    ModelType = "Acme.Models.Order",
    MutableAuditable = true,
    Fields =
    [
        new WorkshopModelFieldMetadata
        {
            PropertyName = "Id",
            ScalarKind = WorkshopAuditScalarKind.Int32,
            Identity = true
        },
        new WorkshopModelFieldMetadata
        {
            PropertyName = "Description",
            ScalarKind = WorkshopAuditScalarKind.String
        }
    ]
};

var plan = WorkshopModelAuditGenerationPlanner.CreatePlan(metadata);
var generatedSource = WorkshopModelAuditArtifactGenerator.RenderInlineModelSource(plan);

generatedSource is source text to apply to the model; the package does not add it to a project or deploy it for you.

Current scope and limitations

• Provides Workshop-owned metadata models, JSON metadata storage, validation, generation plans, and deterministic controller/model audit source artifacts.
• The current model planner supports the scalar kinds defined by WorkshopAuditScalarKind; mutable auditable models require exactly one supported identity field. Read/report models can opt out with MutableAuditable = false.
• The v1 controller regeneration mode is Preserve.
• Generated output is intended to be consumed by the calling build or generation workflow and relies on Coject.Core.Logging.Contracts 3.0.0.
• Runtime Controller integration, Baha API runtime integration, hosting, and production deployment are outside this package's scope.