@june-ai/june-ui 0.1.0 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+## [Unreleased] (planned 0.2.0)
+
+### Added
+- `JuneRenderer` and `@june-ai/june-ui/core` entry (no built-in library import).
+- Theme support: `theme` ("light" | "dark" | "system"), `themeVars`, `className`, `style`;
+  `@june-ai/june-ui/styles.css`.
+- Error boundary, `onJuneError` structured errors (`JuneError`), fallbacks, `resetKeys`.
+- Streaming: `useJuneStream`, `consumeStream`, `fetchStream`, `sseToText`, abort + unmount cleanup.
+- Actions: `defineJuneAction`, `actions` prop, schema validation, confirmation for sensitive actions.
+- `createJuneLibrary` (validation, allow/deny lists) on top of OpenUI's `createLibrary`.
+- All other OpenUI `Renderer` props are forwarded and typed from the installed OpenUI version.
+
+### Changed
+- `@openuidev/react-lang` is now a peer dependency (single shared parser); `zod`, `zustand`,
+  `@openuidev/react-headless` declared as peers.
+- React peer range widened to `^18.3.1 || ^19.0.0`.
+- `onAction` is typed with OpenUI's event type (handlers typed `(event: unknown) => void` still work).
+
+### Compatibility
+- `<JuneUI response isStreaming onAction onError />` from 0.1.0 works unchanged.

package/README.md

@@ -1,44 +1,66 @@
-# June UI SDK
-
-A React Generative UI SDK powered by OpenUI.
-
-## Installation
-
-```bash
-npm install @june-ai/june-ui
-```
-
-## Usage
-
-```tsx
-import { JuneUI } from "@june-ai/june-ui";
-
-function App() {
-  return (
-    <JuneUI
-      response={response}
-      isStreaming={false}
-    />
-  );
-}
-
-export default App;
-```
-
-## Features
-
-- Generative UI rendering
-- Streaming support
-- Custom React components
-- Theme customization
-- Action callbacks
-- Error handling
-
-## Requirements
-
-- React 19+
-- React DOM 19+
-
-## License
-
-MIT
+# @june-ai/june-ui
+
+React Generative UI SDK built on [OpenUI](https://github.com/thesysdev/openui). June adds streaming
+helpers, themes, safe actions, error recovery, and library validation. OpenUI does all parsing and
+rendering.
+
+## Install
+
+```bash
+npm install @june-ai/june-ui
+```
+
+Import styles once in your app entry:
+
+```ts
+import "@openuidev/react-ui/components.css"; // OpenUI built-in components
+import "@june-ai/june-ui/styles.css";        // June theme variables
+```
+
+## Usage
+
+```tsx
+import { JuneUI } from "@june-ai/june-ui";
+
+<JuneUI response={response} isStreaming={isStreaming} theme="system" onJuneError={console.error} />
+```
+
+### Streaming (works with any backend)
+
+```tsx
+const stream = useJuneStream();
+stream.startFetch("/api/generate", { method: "POST", body, sse: false }); // sse: true for SSE
+<JuneUI response={stream.response} isStreaming={stream.isStreaming} />
+```
+
+### Custom library
+
+```tsx
+import { createJuneLibrary } from "@june-ai/june-ui";
+const library = createJuneLibrary({ root: "Stack", components: [Stack, Card] }); // module scope
+<JuneUI library={library} response={response} />
+```
+
+### Actions
+
+```tsx
+const actions = { submit: defineJuneAction({ schema, sensitive: true, handler }) };
+<JuneUI actions={actions} confirmAction={({ name }) => window.confirm(name)} ... />
+```
+Model output never executes code. Only actions you registered by name can run, and sensitive
+actions are denied unless confirmed.
+
+### Lightweight entry
+
+`@june-ai/june-ui/core` exports `JuneRenderer`, which requires your own `library` and does not
+import OpenUI's built-in component library.
+
+## OpenUI features
+
+Tool providers, query loaders, state callbacks, and parse-result callbacks are forwarded to
+OpenUI's `Renderer` as props. See OpenUI's docs for their behaviour. Never put API keys in the
+browser; do tool/MCP calls in your backend.
+
+## Requirements
+
+React 18.3.1+ or 19, plus the OpenUI peer dependencies listed in package.json.