Enable typed queries for threads

[FlowFlorent]

Description

@liveblocks/react

• useThreads now handles typed queries

Example:

  useThreads({
    query: {
      metadata: {
        organization: {
          startsWith: "liveblocks:",
        },
      },
    },
  })

@liveblocks/node

• getThreads now handles typed queries

  client.getThreads<{
    status: "open";
    priority: 3;
    organization: "liveblocks:engineering";
  }>({
    roomId: "room1",
    query: {
      metadata: {
        status: "open",
        priority: 3,
        organization: {
          startsWith: "liveblocks:",
        },
      },
    },
  })

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
examples-nextjs-comments-canvas	❌ Failed (Inspect)			Apr 23, 2024 8:44pm

2 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
examples-nextjs-comments-audio	⬜️ Ignored (Inspect)	Visit Preview		Apr 23, 2024 8:44pm
examples-nextjs-comments-notifications	⬜️ Ignored (Inspect)	Visit Preview		Apr 23, 2024 8:44pm

[vercel]

Deployment failed with the following error:

Too many requests - try again in 3 minutes (more than 60, code: "api-deployments-flood").

[nvie]

I left a few comments. Overall, I think the safest way to write a function that takes a more complex object and produces a valid query string is to use a recursive "prettifier", which takes an AST (in this case the "typed query", which sort of is a simplified AST) and produces a string value, i.e. the reverse operation of a parse.

You can see an example of it here:
https://github.com/liveblocks/liveblocks-cloudflare/blob/main/packages/liveblocks-query-parser/src/prettify/index.ts

With a function like that, it's impossible to generate syntactically invalid outputs, and it will take care of all the proper escaping. (Notice how this function calls itself recursively on sub parts of the AST, until it reaches the "nodes", which it basically just uses JSON.stringify() for.)

[nvie]

@FlowFlorent Let me know once you're done with this PR. I'm happy to play devils advocate and try to come up with unit tests that won't pass.

[FlowFlorent]

@nvie Thanks for all your comments, I've adjusted the PR.

I am still a bit uncertain about the escaping part though 🤔

[vercel]

Deployment failed with the following error:

Too many requests - try again in 4 minutes (more than 60, code: "api-deployments-flood").

[nvie]

Nice work, @FlowFlorent! 🙌

[nvie]

Suggested change

	"@liveblocks/query-parser": "^0.0.3",
	"@liveblocks/query-parser": "^0.0.4",