TypeScript Packages

Kizaki exposes five TypeScript packages. Each has one job.

Package Map

Two sub-paths provide authentication:

Quick Lookup

Request Flow

1. A component calls useQuery() from @kizaki/react with a query built from @kizaki/sdk/browser and an entity from @kizaki/schema.
2. A user action triggers useMutation(), which invokes a function from @kizaki/client.
3. On the server, the @expose function uses @kizaki/sdk to run queries and return a result.
4. The mutation completes, the live query refreshes, and the UI updates.

@kizaki/schema is the shared vocabulary across all layers.

Minimal Example

All five packages in a single feature:

// Browser component — uses @kizaki/react, @kizaki/sdk/browser, @kizaki/schema, @kizaki/client
import { useQuery, useMutation } from "@kizaki/react";
import { select } from "@kizaki/sdk/browser";
import { Project } from "@kizaki/schema";
import { createProject } from "@kizaki/client";

const projectsQuery = select(Project).orderBy(Project.createdAt, "desc");

function Projects() {
  const { data, status } = useQuery(projectsQuery);
  const create = useMutation(createProject, { invalidate: [projectsQuery] });

  if (status === "loading") return <p>Loading...</p>;
  return (
    <>
      <button onClick={() => create.mutate("New Project")}>New Project</button>
      <ul>{data.map(p => <li key={p.id}>{p.name}</li>)}</ul>
    </>
  );
}

// Server function — uses @kizaki/sdk, @kizaki/schema
import { query, insert, getPrincipal } from "@kizaki/sdk";
import { Project } from "@kizaki/schema";

/** @expose */
export async function createProject(name: string) {
  const me = getPrincipal();
  return query(insert(Project).values({ name, ownerId: me.id }).returning(Project.id));
}

Generated vs. Runtime

Two packages are generated from your .inspire schema during compilation:

• @kizaki/schema — regenerated on schema changes. Lives at .kizaki/build/schema/.
• @kizaki/client — regenerated when @expose functions change. Lives at .kizaki/build/client/.

The remaining packages (@kizaki/sdk, @kizaki/sdk/browser, @kizaki/react) are runtime libraries shipped with the platform. They do not change when your schema changes.

Never edit generated files by hand. The dev server regenerates them automatically.

Further Reading

• Schema reference — entity objects, field refs, row type inference
• SDK reference — query builders, context, transactions, files, email, payments
• Client reference — generated RPC functions
• Browser SDK reference — browser queries, subscriptions, presence
• React reference — hooks for live data and mutations
• Auth reference — login, signup, OAuth, account linking