Error - The type you provided for 'ThreadMetadata' does not match its requirements

Why this error occurred

You have provided a custom ThreadMetadata type for your application, but the type you provided isn’t a (completely) valid definition.

declare global {  interface Liveblocks {    ThreadMetadata: {      // Your custom fields go here...      pinned: boolean;      color: string | null; // ❌ Values may not be null      position: { x: number; y: number }; // ❌ Values must be simple      zIndex?: number;    };  }}

In the example above, there are two problems. Thread metadata may only contain simple key/value pairs, where the values must always be assignable to string | number | boolean | undefined.

How to fix it

You’ll need to figure out what part of your provided ThreadMetadata type definition isn’t valid. The example above could be fixed as such:

declare global {  interface Liveblocks {    ThreadMetadata: {      // Your custom fields go here...      pinned: boolean;      color?: string; // ✅      positionX: number; // ✅      positionY: number; // ✅      zIndex?: number;    };  }}

If you cannot find the root cause

Sometimes types can be complex and the root cause is still unclear. In those cases, there is a small trick you can use. Try to assign your type to the required base type, with this line:

import type { BaseMetadata } from "@liveblocks/client";
declare global {  interface Liveblocks {    ThreadMetadata: MyThreadMetadata;  }}
// Quick debugging snippet to find root causeconst xxx: BaseMetadata = {} as MyThreadMetadata;//    ^?//    The error will appear here

Now TypeScript will explain why it thinks your type isn’t valid metadata:

Type 'MyThreadMetadata' is not assignable to type 'BaseMetadata'.  Property 'color' is incompatible with index signature.    Type 'string | null' is not assignable to type 'string | number | boolean | undefined'.      Type 'null' is not assignable to type 'string | number | boolean | undefined'.