Local-First Platform Designed for Privacy, Ease of Use, and No Vendor Lock-In

import * as S from "@effect/schema/Schema";
import {
  NonEmptyString1000,
  SqliteBoolean,
  cast,
  database,
  id,
  table,
  // can be also imported from "@evolu/react"
} from "@evolu/common";
 
// Without React
import { createEvolu } from "@evolu/common-web";
 
// With React
import {
  createEvolu,
  useEvolu,
  useQuery,
} from "@evolu/react";
 
const TodoId = id("Todo");
// It's branded string: string & Brand<"Id"> & Brand<"Todo">
// TodoId type ensures no other ID can be used where TodoId is expected.
type TodoId = typeof TodoId.Type;
 
const TodoTable = table({
  id: TodoId,
  // Note we can enforce NonEmptyString1000.
  title: NonEmptyString1000,
  // SQLite doesn't support the boolean type, so Evolu uses SqliteBoolean instead.
  isCompleted: S.nullable(SqliteBoolean),
});
type TodoTable = typeof TodoTable.Type;
 
const Database = database({
  todo: TodoTable,
});
type Database = typeof Database.Type;
 
const evolu = createEvolu(Database);
 
// Create a typed SQL query. Yes, with autocomplete and type-checking.
const allTodos = evolu.createQuery((db) =>
  db
    .selectFrom("todo")
    .selectAll()
    // SQLite doesn't support the boolean type, but we have `cast` helper.
    .where("isDeleted", "is not", cast(true))
    .orderBy("createdAt"),
);
 
// Load the query. Batched and cached by default.
const allTodosPromise = evolu.loadQuery(allTodos);
 
// React Helper Functions
 
// Use the query in React reactively (it's updated on a mutation).
const { rows } = useQuery(allTodos);
 
// Create a todo.
const { create } = useEvolu<Database>();
create("todo", {
  title: S.decodeSync(NonEmptyString1000)("Learn Effect"),
});
 
// Update a todo.
const { update } = useEvolu<Database>();
update("todo", { id, isCompleted: true });
 
// Delete all data on a device.
useEvolu().resetOwner();
 
// Restore all data on a different device.
useEvolu().restoreOwner(mnemonic);
 
// All other Frameworks
 
// Create a todo.
evolu.create("todo", {
  title: S.decodeSync(NonEmptyString1000)("Learn Effect"),
});
 
// Update a todo.
evolu.update("todo", { id, isCompleted: true });
 
// Delete all data on a device.
evolu.resetOwner();
 
// Restore all data on a different device.
evolu.restoreOwner(mnemonic);