Badaching.Extensions.Plugins.Abstractions 1.0.2

BadaChing Plugin Architecture

BadaChing supports a plugin architecture to help with building out importers for various different bank statements. This package provides the abstractions to build such plugins.

What does it provide?

IPlugin is a general interface that signals a plugin. It does not define any specific functionality, apart from the name and version of a plugin.

IStatementReader is a specific abstraction that implements IPlugin, but declares two additional items:

• FileExtension is the type of file that this reader supports. Implement it in the traditional Windows way, e.g. ".csv"
• Task<Statement> ReadAsync(Stream s) is the entry point into your code.
• Statement is an object that represents the statement read in by your code, and returned to the app. While there isn't validation applied to your result, and the app handles most values being missing or empty (not all banks provides all the details), you are encouraged to complete as many properties as you can to make your plugin usefull to the users.

I've built something, how do I test it?

Locate the "Plugin" folder in the BadaChing application folder. Place your DLL into this location and restart the application.

Some more detail

Why a Stream? Can't I load the file myself?

Windows restricts what I/O access your code has in the UWP app environment, and unfeterred disk access is not possible. The application provides the stream by way of loading it via the StorageFile class.