Oakrey.Applications.FileBrowsing.Abstractions 6.0.0

Oakrey.Applications.FileBrowsing.Abstractions

A .NET 10 Windows library that defines the contracts and base classes for file browsing and selection services. It contains no UI or file-system scanning code and carries only minimal runtime dependencies, making it the correct reference for libraries and application layers that need to consume or extend file browsing without coupling to a concrete implementation.

Main features

Service interfaces

Settings interfaces and base class

Architecture

classDiagram
    class IFileBrowsingService {
        +AvailableFiles List~FileInfo~
        +SelectedFile FileInfo?
        +SelectedFileChanged IObservable~FileInfo?~
    }

    class IExtendedFileBrowsingService {
        +CreateNewFile(name, ct) Task
        +DeleteSelectedFile(ct) Task
        +EditSelectedFile(ct) Task
        +OpenFolder(ct) Task
        +Reload(fileInfo)
        +Reload()
    }

    class IFileBrowsingServiceSettings {
        +FileExtension string
        +FolderPath string
        +FolderPathChanged IObservable~string~
        +IncludeSubFolders bool
        +LastSelectedFile string
        +SearchPattern string
    }

    class IFileExtendedBrowsingServiceSettings {
        +NewFileTemplate string
    }

    class FileBrowsingServiceSettingsBase {
        <<abstract>>
        +FileExtension string*
        +SearchPattern string*
    }

    IExtendedFileBrowsingService --|> IFileBrowsingService
    IFileExtendedBrowsingServiceSettings --|> IFileBrowsingServiceSettings
    FileBrowsingServiceSettingsBase ..|> IFileBrowsingServiceSettings

    FileBrowsingService ..|> IFileBrowsingService
    ExtendedFileBrowsingService ..|> IExtendedFileBrowsingService

    note for FileBrowsingService "Oakrey.Applications.FileBrowsing"
    note for ExtendedFileBrowsingService "Oakrey.Applications.FileBrowsing.Extended"

Concrete implementations live in the separate Oakrey.Applications.FileBrowsing and Oakrey.Applications.FileBrowsing.Extended packages. Consuming projects should reference only this abstractions package and register the implementation via the extension methods provided by those packages.

Requirements

• .NET 10 Windows (net10.0-windows) or later
• System.Reactive 6.1 or later � required for IObservable members on the interfaces
• Oakrey.Log 2.0 or later
• Oakrey.Applications.Abstractions � provides SettingsBase and ISettingsService

Installation

dotnet add package Oakrey.Applications.FileBrowsing.Abstractions

To also include the concrete implementation:

dotnet add package Oakrey.Applications.FileBrowsing
dotnet add package Oakrey.Applications.FileBrowsing.Extended

Configuration

Derive from FileBrowsingServiceSettingsBase to create a settings class for a specific file type. The two abstract members that must be implemented are FileExtension and SearchPattern.

public sealed class CsvBrowsingServiceSettings : FileBrowsingServiceSettingsBase
{
    public CsvBrowsingServiceSettings(ISettingsService settingsService)
        : base(settingsService)
    {
    }

    public override string FileExtension => "csv";

    public override string SearchPattern => "*.csv";
}

Register the settings and service in the DI container:

services.AddSingleton<IFileBrowsingServiceSettings, CsvBrowsingServiceSettings>();
services.AddFileBrowsingService();

Example usage

Consuming the abstraction

public sealed class FileViewModel
{
    private readonly IFileBrowsingService _browser;

    public FileViewModel(IFileBrowsingService browser)
    {
        _browser = browser;

        _browser.SelectedFileChanged.Subscribe(file =>
        {
            if (file is not null)
            {
                Console.WriteLine($"Selected: {file.FullName}");
            }
        });
    }

    public IReadOnlyList<FileInfo> Files => _browser.AvailableFiles;
}

Using the extended service

await _extendedBrowser.CreateNewFile("report", cancellationToken);
await _extendedBrowser.DeleteSelectedFile(cancellationToken);
await _extendedBrowser.OpenFolder(cancellationToken);

Reacting to folder changes

settings.FolderPathChanged.Subscribe(newPath =>
{
    Console.WriteLine($"Folder changed to: {newPath}");
});

settings.FolderPath = @"C:\Data\Reports";

Development notes

• This package contains only interfaces and the abstract settings base class. No file-system scanning, shell operations, or UI code is included.
• FileBrowsingServiceSettingsBase inherits from SettingsBase in Oakrey.Applications.Abstractions and uses ISettingsService for value persistence. Values are stored and retrieved by caller member name via Get<T>() / Set(value).
• Reactive notifications (SelectedFileChanged, FolderPathChanged) are backed by System.Reactive Subject<T> instances and are exposed as cold IObservable<T>.
• The target framework is net10.0-windows because System.Reactive includes Windows-specific scheduler integrations used downstream. There is no direct WPF dependency in this package.

License

MIT � Copyright � Oakrey 2016-present