Roadmap

[Sandros94]

Roadmap

• [x] custom fetch plugin and useFetch composable.
• [x] Database presets
• [x] support official SurrealDB Rest integration. Discarded in favor of RPC. Can still be manually used via $surrealFetch and useSurrealFetch.
• [x] support official SurrealDB RPC integration.
• [x] server side surrealFetch and surrealRPC utils
• [x] catch Surreal errors
• [x] built-in auth composable.
• [x] custom websocket composable.
• [x] unwrap RPC responses by default
• [ ] doublecheck types
• [ ] docs
• [ ] study Concise Binary Object Representation (waiting for reply on undio#18)
• [ ] vitests

Experiment with SurrealDB 2.0 alpha

• [ ] headers prefix
• [ ] new auth

[Sandros94]

hijacking this issue to track module's roadmap

[martinholovsky]

Can you make it Nuxt v3 compatible please? 🙏 Module site states that its not yet https://nuxt.com/modules/SurrealDB#nuxt-surrealdb

[Sandros94]

Can you make it Nuxt v3 compatible please? 🙏 Module site states that its not yet https://nuxt.com/modules/SurrealDB#nuxt-surrealdb

That was actually a bug and fixed with nuxt/modules#980 PR. The minimum version compatible is currently 3.10

[Celibioux]

Thank you for you great work :) it's really amazing ☺️ Just one question please ! Are you using the Surrealdb JS SDK ? A great repo for reference : https://github.com/dvanmali/surrealdb-nuxt-starter

[Sandros94]

Thank you for you great work :) it's really amazing ☺️

Thank you 🙏

[...] Are you using the Surrealdb JS SDK ?

No, currently I'm not. The main reason being that I'm more focused on environment support, to maximize the module's usability in any production env supported by Nuxt itself. This might change in the future, but it will depend on a number of factor such as surrealdb/surrealdb.js#251.

A great repo for reference : https://github.com/dvanmali/surrealdb-nuxt-starter

Indeed, the SDK is so simple to use that just wrapping it in a module didn't seem to provide any added functionalities compared to directly using it in a project. I'm also considering changing some of my current params to be more inline with the SDK ones

[Celibioux]

Thank you for the great work you're offering it is really promissing and i'll give it a try in a project right away... Just some ideas if you don't mind as i've noticed that you're using vueuse/useWebsocket and there is unjs/crossws (from Pooya) the Nitro maker i think it's already builtin in Nitro ? It's Just a Thought Btw ☺️

[Sandros94]

crossws is a platform agnostic websocket server, while vueuse/useWebsocket is a reactive websocket client 😁

[dodanex]

Thank you for you great work :) it's really amazing ☺️ Just one question please ! Are you using the Surrealdb JS SDK ? A great repo for reference : https://github.com/dvanmali/surrealdb-nuxt-starter

I already tried the Surrealdb JS SDK and I'm not that convinced. I think this new implementation for Nuxt can be a better approach.

[Sandros94]

I already tried the Surrealdb JS SDK and I'm not that convinced

Keep in mind that the JS SDK is still under active development and not officially finalized, so anything could change. Not to mention that their approach is to support everyone (framework and non) with a single SDK.

What made me choose to start working on this module was to have a tighter implementation for Nuxt itself. Yes this means almost double the work, but the final outcome is to be able to have Nuxt-specific features that may not be implementable into the SDK itself

My current approach is to follow as close as possible the RPC endpoint API, the same used by the JS SDK. So the feature-set should be pretty similar