Oakrey.Applications.Abstractions 6.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
        AppInfoBase
        ISettingsService
        SettingsBase
        PathsAndNames
        IPreLoadable
        PreLoadingException
        KeyboardExtension
    end

    AppInfoBase -->|implements| IApplicationInfo
    SettingsBase -->|uses| ISettingsService
    IPreLoadable -->|surfaces| PreLoadingException

The library has no dependency on any other ApplicationServices package except Oakrey.Log and Oakrey.ViewModels (used by SettingsBase).

Requirements

• .NET 10 (net10.0-windows)
• Windows OS (WPF dependency)
• Assets/icon.png present in the application output directory when using AppInfoBase.Logo

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 class MyAppInfo : AppInfoBase
{
    public override string DeploymentUrl => "https://example.com/deploy/myapp";
}

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.
• Log files are written to %LocalAppData%\<AppName>\Logs\ with a timestamp-based file name.
• Default settings are read from the application base directory (DefaultSettings.json). User settings are stored in %AppData%\<AppName>\Settings.json.
• PathsAndNames reads from Assembly.GetEntryAssembly(). In unit test hosts this may differ from the assembly under test � account for this in test setup.

License

MIT -- Copyright Oakrey 2016-present