Restrict Presence Type to JSON Serializable Types

[chacha912]

Description:

Currently, the presence type is defined to extend Indexable, and when transmitting presence via protobuf, it is converted to a string using JSON.stringify.

• presence type:

  yorkie-js-sdk/src/document/document.ts

  Line 388 in effd586

  export class Document<T, P extends Indexable = Indexable> {

• protobuf:

  yorkie-js-sdk/src/api/yorkie/v1/resources.proto

  Lines 307 to 309 in 02e9bc0

  	message Presence {
  	map<string, string> data = 1;
  	}

• PR that changes presence to use JSON.stringify: Fix bug when setting non-string values in Presence #311

The current type <P extends Indexable> allows any type as its value since type Indexable = Record<string, any>. Consequently, values that are not JSON serializable, such as byte array, Date, and Long, may not work correctly. Therefore, it is essential to restrict the type of P(presence) to only allow JSON serializable types not Indexable.

Reference) JSON type used in other libraries:

• JSON type generated when using Supabase Type Generation:

export type Json = string | number | boolean | null | { [key: string]: Json } | Json[];

• JSON type defined in liveblocks:

export type Json = JsonScalar | JsonArray | JsonObject;
export type JsonScalar = string | number | boolean | null;
export type JsonArray = Json[];
export type JsonObject = { [key: string]: Json | undefined };

Why:
Using non-JSON serializable values in the presence type may lead to unexpected behavior.

[hackerwins]

Feel free to send a pull request.