Create best-in-class NuGet protocol SDK

[loic-sharma]

Problem

It is difficult to create tooling around the NuGet protocol due to a lack of libraries.

Solution

Create the best-in-class libraries for the NuGet protocol:

• Well documented: https://loic-sharma.github.io/BaGet/tools/sdk/
• Stable API surface
• Can be used from both .NET Core and .NET Framework
• Clean integration with ASP.NET Core
• Minimal dependencies
• Follows Azure SDK's guidelines: https://azure.github.io/azure-sdk/dotnet_introduction.html

Existing Solutions

• NuGet.Protocol - The NuGet client team maintains this package. It is extremely powerful, supports both V2 and V3 APIs, and supports private feeds. However, it is difficult to use, poorly documented, tightly coupled with the client's implementation, and does not have a stable API surface.
• NuGet.Protocol.Catalog - The NuGet server team maintains this package. It is .NET Framework only, but well documented and has a stable API surface. This only covers the catalog resource and does not cover other resources like search, autocomplete, package metadata, package content

Tasks

• Preview 1
  • Improve on-boarding experience [Client SDK] Improve on-boarding experience #305
  • Add the catalog SDK [Client SDK] Add the catalog SDK #308
  • Standardize SDK best practices [Client SDK] Standardize SDK best practices #322
  • Test performance on large static feeds [Client SDK] Test performance on large static feeds #304
  • Release [Client SDK] Release preview 1 #340
• Preview 2
  • Use primitive types in JSON models (ex: strings instead of NuGetVersion)
  • Reduce NuGet.* dependencies (can we use just NuGet.Versioning?)
  • Rename from CatalogLeafUrl to Url wherever necessary
  • IPackageMetadataClient.GetRegistrationLeafOrNullAsync should accept a leaf URL (see this)
  • Split search and autocomplete SDK [Client SDK] Split search and autocomplete resources #468
  • Don't expose low-level JSON models in high-level SDK
  • Move to System.Text.Json?
  • Improve XML doc for catalog processor options
  • Improve test coverage: [Client SDK] Add thorough tests #309
  • Add dependency injection extensions
  • Add package publish SDK [Client SDK] Add package publish SDK #310
  • Unlist package SDK
  • Add symbol publish SDK
  • Add package signature SDK
  • Add package deprecation SDK [Client SDK] Add package deprecation SDK #395
  • Add license expression to registration (it's in catalog already)
• Future
  • Add high performance catalog SDK
  • Support search failover [Client SDK] Support search failover #314
  • Support authentication plugins [Client SDK] Prototype authentication  #334

[Sewer56]

I am going to simply agree with the label. Epic.

[loic-sharma]

@Sewer56 The SDK is ready to try out, please let me know what you think! https://github.com/loic-sharma/BaGet/tree/master/src/BaGet.Protocol#bagetprotocol