EnsureJson is failing on a particular interface about liveblocks HOT 4 CLOSED

Hi @oravecz, we documented this issue here, in case you're interested in the details.

Ultimately, the key issue that causes this type error is on line 12:

export interface AttributeValue {
    v?: object;  // 👈 An `object` isn't guaranteed to be JSON-serializable
}

In addition, from looking at your example, your best shot will be to use type instead of interfaces, if you are in control of those type definitions, and your application allows it.

• Change this object to JsonObject
• Change interface to type (which aren't "open" by default, and thus helps TypeScript understand that there won't be any non-JSON fields added to the type elsewhere)

Here is an adjusted example that works around this problem.

Hope this helps to explain and solves your issue. Feel free to re-open this issue if you have any further questions! 🙏

from liveblocks.

Yes, that is the documentation I had referenced in the ticket.

The docs might be helped by coming out and stating "An object isn't guaranteed to be JSON-serializable"

Unfortunately for me, this interface is external to my codebase, and seems like it will prevent me from using LiveBlocks.

I'm curious also, why an "override" can't be provided for the developer to vouch that the Storage instance is serializable. I understand the desire to be pedantic. You probably fielded situations where non-serializable payloads were passed in the past, and are trying to avoid the issue.

But in doing so, you have created a hurdle for developers who need to use the TS any type. For us, this comes about because we are using OpenAPI to generate the payloads and skeletons for a Java backend, so some codegen restriction on a different language is impeding our ability to generate a more precise TS interface.

Can you say more about regarding the idea to provide developers with an option to remove the serialization check you are trying to enforce via types?

from liveblocks.

Yeah, this is tricky. One reason the types are like this is because we also use them to automatically derive the immutable JSON types from these definitions. Not enforing JSON-serializableness here will lead to many unexpected "unknowns" down the road, which can be even more confusing.

To unblock you, if you don't control the generated interface types, another workaround for you can be the following:

const attributes: (Attribute & Lson)[] = [];

new LiveList<Attribute & Lson>(attributes)
//           ^^^^^^^^^^^^^^^^ Manually tell TypeScript your Attribute type will be JSON-serializable

Playground link

Hope that helps!

from liveblocks.

Can we extend that Playground example a little bit more?

const attributes: (Attribute & Lson)[] = [];
const attribute = attributes[0] as unknown as (Attribute & LsonObject);

const list = new LiveList<Attribute & Lson>(attributes)
const item = new LiveObject<Attribute & LsonObject>(attribute);
list.push(item);

The last line doesn't seem to work with the types specified.

Playground Link

from liveblocks.