Breaking changes to Microsoft.JSInterop

[pranavkm]

In 3.0-preview6, we're migrating Microsoft.JSInterop to use the System.Text.Json based serializer. As part of this transition, there are several breaking changes to the JSInterop library:

• The helper type Microsoft.JSInterop.Json is being removed. Users may use a JSON serializer of their choice. We recommend using the System.Text.Json-based serializer since Blazor already references it. Here's the code change required to migrate to use System.Text.Json:

// Before
string value = Json.Serialize(...);
MyPoco poco = Json.Deserialize<MyPoco>("...");

// After
using System.Text.Json.Serialization;
...

string value = JsonSerializer.ToString(...);
MyPoco poco = JsonSerializer.Parse<MyPoco>("...");

• DotNetObjectRef is replaced by a generic DotNetObjectRef<T> that is required for both sending and receiving a managed object reference when doing interop with the browser

// Before
IJSRuntime.InvokeAsync("SomeJSMethod", new DotNetObjectRef(someObject));

[JSInvokable]
public static Task SomeDotNetMethod(MyObject myObject)
{
    ...
}

// After
IJSRuntime.InvokeAsync("SomeMethod", DotNetObjectRef.Create(someObject));

[JSInvokable]
public static Task SomeDotNetMethod(DotNetObjectRef<MyObject> myObject)
{
    ...
}

• Microsoft.JSInterop will use System.Text.Json to marshal interop data. To customize serialization, you may use serialization primitives such as JsonPropertyNameAttribute, JsonIgnoreAttribute etc.

• IJSRuntime.UntrackObjectRef(DotNetObjectRef); has been removed. To stop tracking an object reference, dispose the DotNetObjectRef<T> instance either on the server or the client.

Please use dotnet/aspnetcore#10810 for further discussions.