OpenUrzednik.Mf 1.0.3-preview.gaa0bcd1436

This is a prerelease version of OpenUrzednik.Mf.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package OpenUrzednik.Mf --version 1.0.3-preview.gaa0bcd1436
                    
NuGet\Install-Package OpenUrzednik.Mf -Version 1.0.3-preview.gaa0bcd1436
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="OpenUrzednik.Mf" Version="1.0.3-preview.gaa0bcd1436" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="OpenUrzednik.Mf" Version="1.0.3-preview.gaa0bcd1436" />
                    
Directory.Packages.props
<PackageReference Include="OpenUrzednik.Mf" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add OpenUrzednik.Mf --version 1.0.3-preview.gaa0bcd1436
                    
#r "nuget: OpenUrzednik.Mf, 1.0.3-preview.gaa0bcd1436"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package OpenUrzednik.Mf@1.0.3-preview.gaa0bcd1436
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=OpenUrzednik.Mf&version=1.0.3-preview.gaa0bcd1436&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=OpenUrzednik.Mf&version=1.0.3-preview.gaa0bcd1436&prerelease
                    
Install as a Cake Tool

OpenUrzednik.NET 💼🇵🇱

Nuget License

OpenUrzednik.NET to nowoczesny, otwartoźródłowy zestaw bibliotek dla platformy .NET, służący do integracji z polskimi API oraz danymi publicznymi. W aktualnej fazie rozwoju projekt skupia się przede wszystkim na wspólnych abstrakcjach w OpenUrzednik.Core oraz na pierwszych szkieletach pakietów provider-specific.

⚠️ Projekt nieoficjalny: Ten zestaw bibliotek jest oddolną inicjatywą społecznościową i nie jest powiązany, autoryzowany ani sponsorowany przez żadne z polskich ministerstw ani urzędów państwowych.


🚀 Dlaczego powstał ten projekt?

Większość istniejących pakietów dla polskich API została porzucona lub nie utrzymuje się w nowoczesnym modelu .NET. OpenUrzednik.NET ma dostarczać:

  • Nowoczesne API: wsparcie dla net8.0, net9.0 i net10.0
  • Spójne modele błędów: OpenUrzednikResult / OpenUrzednikResult<T> zamiast rozproszonej logiki błędów
  • Elastyczność: zachowanie klasycznego stylu przez .EnsureSuccess() / .EnsureSuccessAsync()
  • Przejrzysty rozwój: kod podzielony na Core i pakiety provider-specific

📦 Status pakietów

Pakiet Status Opis Celowy target
OpenUrzednik.Core ✅ Dostępne podstawowe abstrakcje OpenUrzednikResult, OpenUrzednikResult<T>, OpenUrzednikError, OpenUrzednikException oraz metody rozszerzeń EnsureSuccess / EnsureSuccessAsync net8.0, net9.0, net10.0
OpenUrzednik.Nbp 🚧 Szkielet Pakiet przygotowany pod integrację z API NBP net8.0, net9.0, net10.0
OpenUrzednik.Gus 🚧 Szkielet Pakiet przygotowany pod integrację z GUS net8.0, net9.0, net10.0
OpenUrzednik.Krs 🚧 Szkielet Pakiet przygotowany pod integrację z KRS net8.0, net9.0, net10.0
OpenUrzednik.Mf 🚧 Szkielet Pakiet przygotowany pod integrację z Białą Listą VAT net8.0, net9.0, net10.0

🛠️ Szybki start

Aktualnie najłatwiej zacząć od OpenUrzednik.Core.

Przykład użycia OpenUrzednikResult

using OpenUrzednik.Core;
using OpenUrzednik.Core.Errors;
using OpenUrzednik.Core.Extensions;

OpenUrzednikResult<int> result = OpenUrzednikResult.Success(42);
int value = result.EnsureSuccess();
Console.WriteLine(value);

Przykład błędu biznesowego:

using OpenUrzednik.Core;
using OpenUrzednik.Core.Errors;
using OpenUrzednik.Core.Extensions;

OpenUrzednikResult<int> failed = OpenUrzednikResult.Failure<int>(new ValidationError("NIP is invalid."));

try
{
    int value = failed.EnsureSuccess();
}
catch (ValidationException ex)
{
    Console.WriteLine(ex.Message);
}

Uwaga o DI i klientach

Na tym etapie repozytorium nie ma jeszcze gotowych klientów HTTP ani rozszerzeń DI dla konkretnych providerów. Pakiety OpenUrzednik.Nbp, OpenUrzednik.Gus, OpenUrzednik.Krs i OpenUrzednik.Mf są obecnie szkieletem, który będzie rozwijany w kolejnych zmianach.

Testy

Testy znajdują się w katalogu tests/ i obejmują przede wszystkim podstawowe zachowania OpenUrzednik.Core.


🤝 Współpraca (Contributing)

Chcesz dodać obsługę kolejnego źródła danych lub zgłosić błąd? Zobacz CONTRIBUTING.md — zawiera zasady pracy nad repozytorium, konwencje API oraz instrukcje dla pull requestów.

📄 Licencja

Projekt jest dostępny na warunkach licencji MIT. Szczegóły znajdziesz w pliku LICENSE.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.