Oakrey.Applications.Abstractions 7.0.0

Oakrey.Applications.Abstractions

Core abstractions and base classes for Oakrey WPF desktop applications.

This library is a lightweight contract layer. It defines the interfaces and base classes that the rest of the ApplicationServices packages depend on, keeping consumers decoupled from any specific implementation.

Main features

Architecture

graph TD
    subgraph Abstractions ["Oakrey.Applications.Abstractions"]
        IApplicationInfo
        ISettingsService
        SettingsBase
        IPreLoadable
        PreLoadingException
        KeyboardExtension
    end

    SettingsBase -->|uses| ISettingsService
    IPreLoadable -->|surfaces| PreLoadingException

The library depends on Oakrey.Log.Abstractions and Oakrey.ViewModels, both used by SettingsBase. IObservable<T> is provided by the .NET base class library, so consumers do not need System.Reactive merely to implement IPreLoadable.

Requirements

• .NET 10 (net10.0-windows)
• Windows OS (WPF dependency)

Build

dotnet build Abstractions/Abstractions.csproj

Pack as a NuGet package:

dotnet pack Abstractions/Abstractions.csproj -c Release

The package ID is Oakrey.Applications.Abstractions.

Usage

Application info

public sealed class MyAppInfo : IApplicationInfo
{
    // Implement the metadata and path properties required by IApplicationInfo.
}

Register and consume via IApplicationInfo:

services.AddSingleton<IApplicationInfo, MyAppInfo>();

Settings

public class AppSettings : SettingsBase
{
    public AppSettings(ISettingsService settingsService)
        : base(settingsService) { }

    public string Theme
    {
        get => Get<string>() ?? "Dark";
        set => Set(value);
    }
}

CallerMemberName is used automatically, so the property name becomes the storage key.

Pre-loading

public class DatabasePreLoader : IPreLoadable
{
    public IDisposable Subscribe(IObserver<PreLoadingException> observer) { ... }

    public async Task Preload(CancellationToken cancellationToken)
    {
        // perform async initialisation
    }
}

Clean-config detection

if (KeyboardExtension.IsCleanConfigCombinationPressed())
{
    // delete or reset stored settings before the main window opens
}

Development notes

• SettingsBase automatically calls ISettingsService.Save on every persistent Set call. Volatile values are not saved to disk.
• Setting updates and failures are logged without including setting values, which may contain secrets.
• KeyboardExtension returns false when no WPF application exists or its dispatcher is shutting down.

License

MIT -- Copyright Oakrey 2016-present