Ryth Azhur
3aafec6dd4
The IR called them react-message and django-message, so a FastAPI channel had to declare a DjangoMessage. They are client-message and server-message now, and the direction words hold wherever a channel is declared: Params / ClientMessage / ServerMessage, with mizan-core deriving <Pascal>Params and friends so no backend names a type itself. Django's ReactChannel and FastAPI's ReactChannel are both Channel. mizan-fastapi never registered a channels extension, so build_ir() emitted no channel at all and every payload type was invisible to codegen. It registers one now. RegistryExtension is an ABC requiring all(), which is what the IR reads — an extension that cannot enumerate its registrations no longer exists. The gate that should have caught the rename could not: tests/afi registered no channel because mizan-rust had no channel registry to register one in, so a five-package rename of the wire contract passed byte-parity without a channel byte crossing it. mizan-rust grows ChannelSlotKind, a CHANNELS slice, a #[mizan::channel] macro, and KDL emission whose wire_to_pascal matches Python's split; the AFI fixture now carries a channel with every slot and one with a single slot, so all three backends prove the contract byte for byte. MizanChannel held three Option<String> beside three has_*() predicates and unwrapped them with defaults; it holds an ordered slot vector, so an absent slot is absent rather than defaulted. The channels target emitted a React hooks file that a stage1-only consumer could not compile — react emits that now. The codegen's parity tests byte-compared emitted source against baselines without ever compiling it: they compile the generated crate and run its tests, import the generated Python package and call every method, and typecheck each TypeScript target against a consumer. Also fixed at source: app_visitor printed its import diagnostic to stdout, the stream export_mizan_ir writes KDL to, so a failed import silently corrupted the IR; the apps root was hardcoded to "apps"; _default_literal crashed build_ir on any non-JSON-serializable field default; Django and mizan-core derived Pascal names two different ways, disagreeing on every dotted channel name. ir.py builds a document and renders templates/ir/document.kdl.j2 rather than appending KDL strings with hand-tracked indentation, and named types resolve to a fixed point — a model reachable only through a union branch was referenced by a ref that no type block ever defined. The rest is the write-gate's own classifiers run over the standing tree: relative imports, silent swallows, Protocol contracts that should be ABCs, emitters hand-rendering target source, catch-all arms over closed enums, and comments narrating the project rather than the code. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@rythazhur/mizan (TypeScript)
React client for the mizan framework. See the monorepo root for full documentation.
Install
npm install @rythazhur/mizan@git+https://git.impactsoundworks.com/isw/mizan.git#workspace=react
Usage
You don't use this package directly. You use the generated hooks.
This is the pre-kernel React adapter: it ships its own MizanProvider
(src/context.tsx) that owns HTTP/WebSocket/CSRF/session/context state
directly, rather than subscribing to the @mizan/base kernel. It is still
the provider the Django + desktop example wires against. (DjangoContext,
useDjango, etc. are deprecated aliases for the Mizan* names.)
1. Configure
# mizan.toml
output = "src/api"
targets = ["react"]
[source.django]
manage_path = "../backend/manage.py"
command = ["uv", "run", "python"]
2. Generate
The codegen is the mizan-generate Rust binary (source at
protocol/mizan-codegen/; protocol/mizan-generate/ is the npm launcher):
mizan-generate --config mizan.toml
3. Wrap your app
import { MizanProvider } from '@rythazhur/mizan'
<MizanProvider>
<App />
</MizanProvider>
MizanProvider is the only provider you need. It handles HTTP, WebSocket, CSRF, session init, context auto-fetching, and channel connections.
4. Use generated hooks
import { useCurrentUser, useEcho, useContactForm, useChatChannel } from '@/api'
// Context (SSR-hydrated, auto-refreshed)
const user = useCurrentUser()
// Server function
const echo = useEcho()
const result = await echo({ text: 'hello' })
// Form (Zod + server validation)
const form = useContactForm()
form.set('email', 'test@example.com')
await form.submit()
// Channel (WebSocket)
const chat = useChatChannel({ room: 'general' })
chat.send({ text: 'hello' })
chat.messages // typed, reactive
Generated Files
The Rust codegen emits per-target files into the configured output
directory (Stage 1 is auto-included whenever react is a target):
| File | Contents |
|---|---|
types.ts |
Pydantic types |
contexts/<name>.ts |
Per-context fetchXxx bundles |
react.tsx |
<MizanContext> provider + typed use{Hook}() hooks |
channels.ts / channels.hooks.tsx |
Channel types + hooks (when the schema carries channels) |
index.ts |
Stage 1 re-export root |
Sub-exports
| Import | When to use |
|---|---|
@rythazhur/mizan |
Core: MizanProvider, hooks, forms, errors |
@rythazhur/mizan/channels |
WebSocket channels |
@rythazhur/mizan/jwt |
JWT token management |
@rythazhur/mizan/client |
HTTP clients (CSR/SSR) |
These are library internals used by the generated code. You should import from @/api (your generated index), not from the library directly.
Running Tests
# Unit tests (Vitest, jsdom)
npm test
# E2E tests (Playwright, real browser)
# Requires Docker backend running
npx playwright test