Workes.ContentSystem 0.3.0

Workes.ContentSystem

Workes.ContentSystem is an engine-neutral backend for storing and organizing extensible content entries.

It is intended to be useful anywhere an application needs an ordered or structured stream of entries: console history, chat, logs, notifications, forum-like views, feeds, audit trails, and custom UI timelines.

Highlights

• Extensible content entries instead of one fixed message shape.
• Pluggable content structures, starting with a configurable sequence structure.
• Structure-assigned and caller-keyed manager workflows.
• Structure-owned entry identity so different storage models can use the IDs that fit them.
• Optional change hooks for observing committed mutations.
• A shared failure and exception model matching the style used in other Workes packages.
• Planned portable snapshots for serialization and state transfer, plus optional attachment points for export, bridges, and platform-specific integration.

Installation

Install the package from NuGet:

dotnet add package Workes.ContentSystem --version 0.3.0

Or add a package reference:

<PackageReference Include="Workes.ContentSystem" Version="0.3.0" />

The package targets .NET Standard 2.1.

Quick Example

The structure-assigned-ID manager uses an explicit sequence structure here:

var content = new ContentManager(
    new ContentSequenceStructure(ContentOverflowPolicy.DropOldest(capacity: 200)));

content.Add(new PlainContentEntry(DateTimeOffset.UtcNow, "Server started."));
content.Add(new PlainContentEntry(DateTimeOffset.UtcNow, "Player joined: Workes"));

foreach (ContentEntryRecord record in content.Records)
{
    Console.WriteLine($"{record.Id}: {record.PlainText}");
}

For caller-provided IDs, use a keyed manager:

var content = new KeyedContentManager<string>();

content.Add("server-started", new PlainContentEntry(DateTimeOffset.UtcNow, "Server started."));

ContentEntryRecord record = content.Get("server-started");

See the Quick Start for the beginner-first walkthrough.

Documentation

Start here:

1. Quick Start
2. Concepts

Focused guides:

• Content Entries
• Content Identity
• Content Structures
• Content Managers
• Content Changes
• Content Snapshots
• Failures
• Export And Attachments

See the Changelog for release history and migration-sensitive changes.

License

Workes.ContentSystem is available under the MIT License.