Merge pull request #255 from evoluhq/new-api

New API

.changeset/blue-tables-invent.md

@@ -0,0 +1,45 @@
+---
+"eslint-config-evolu": major
+"@evolu/common-react": major
+"@evolu/react-native": major
+"@evolu/common-web": major
+"@evolu/common": major
+"@evolu/server": major
+"native": major
+"server": major
+"web": major
+"@evolu/react": minor
+---
+
+New API
+
+With the upcoming React 19 `use` Hook, I took a chance to review and improve the Evolu API. I moved as many logic and types as possible to the Evolu interface to make platform variants more lightweight and to allow the use of Evolu directly out of any UI library.
+
+The most significant change is the split of SQL query declaration and usage. The rest of the API is almost the same except for minor improvements.
+
+### Example
+
+```ts
+// Create queries.
+const allTodos = evolu.createQuery((db) => db.selectFrom("todo").selectAll());
+const todoById = (id: TodoId) =>
+  evolu.createQuery((db) =>
+    db.selectFrom("todo").selectAll().where("id", "=", id),
+  );
+
+// We can load a query or many queries.
+const allTodosPromise = evolu.loadQuery(allTodos).then(({ rows }) => {
+  console.log(rows);
+});
+evolu.loadQueries([allTodos, todoById(1)]);
+
+// useQuery can load once or use a promise.
+const { rows } = useQuery(allTodos);
+const { rows } = useQuery(allTodos, { once: true });
+const { rows } = useQuery(allTodos, { promise: allTodosPromise });
+const { row } = useQuery(todoById(1));
+```
+
+I also refactored (read: simplified a lot) Effect Layer usage across all libraries.
+
+There is no breaking change in data storage or protocol.

.changeset/config.json

@@ -9,7 +9,9 @@
   "updateInternalDependencies": "patch",
   "ignore": [],
   "___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
-    "useCalculatedVersionForSnapshots": true,
     "onlyUpdatePeerDependentsWhenOutOfRange": true
+  },
+  "snapshot": {
+    "useCalculatedVersion": true
   }
 }

.prettierrc.json

@@ -1 +1,3 @@
-{}
+{
+  "plugins": ["./node_modules/prettier-plugin-jsdoc/dist/index.js"]
+}

README.md

@@ -28,20 +28,20 @@ Client-server architecture provides us with easy backup and synchronization, but
 To start using Evolu, define tables for your database and export React Hooks.
 
 ```ts
-import * as Schema from "@effect/schema/Schema";
+import * as S from "@effect/schema/Schema";
 import * as Evolu from "@evolu/react";
 
 const TodoId = Evolu.id("Todo");
-type TodoId = Schema.Schema.To<typeof TodoId>;
+type TodoId = S.Schema.To<typeof TodoId>;
 
-const TodoTable = Schema.struct({
+const TodoTable = S.struct({
   id: TodoId,
   title: Evolu.NonEmptyString1000,
   isCompleted: Evolu.SqliteBoolean,
 });
-type TodoTable = Schema.Schema.To<typeof TodoTable>;
+type TodoTable = S.Schema.To<typeof TodoTable>;
 
-const Database = Schema.struct({
+const Database = S.struct({
   todo: TodoTable,
 });
 
@@ -59,10 +59,10 @@ export const {
 Learn more about [Schema](https://github.com/effect-ts/schema).
 
 ```ts
-import * as Schema from "@effect/schema/Schema";
+import * as S from "@effect/schema/Schema";
 import * as Evolu from "@evolu/react";
 
-Schema.parse(Evolu.String1000)(title);
+S.parse(Evolu.String1000)(title);
 ```
 
 ### Mutate Data