@june-ai/june-ui 0.2.4 → 0.2.6

package/dist/index.d.cts

@@ -139,6 +139,13 @@ interface DocumentStore {
     remove(id: string): void;
 }
 declare function createDocumentStore(): DocumentStore;
+/**
+ * Remembers content produced from the user's own edits (for example when JuneUI rewrites
+ * the OpenUI program). When that content comes back through the DocumentEditor props it is
+ * ignored instead of being treated as a new AI version.
+ */
+declare function rememberDocumentEcho(store: DocumentStore, id: string, content: string): void;
+declare function isDocumentEcho(store: DocumentStore, id: string, content: string): boolean;
 /** The shared in-memory store used when none is provided. Documents are keyed by documentId. */
 declare function getDefaultDocumentStore(): DocumentStore;
 
@@ -281,13 +288,49 @@ type JuneRendererProps = Omit<OpenUIRendererProps, "library" | "response" | "isS
     onJuneError?: (error: JuneError) => void;
     /** Document editor callbacks and store. Memoize this object. */
     documents?: JuneDocumentOptions;
+    /**
+     * Called with an updated OpenUI program when the user edits a document (body or title).
+     * The matching `DocumentEditor(id, title, content)` call is rewritten with the new title and
+     * the body as Markdown; nothing else in the program changes. Store the value and pass it back
+     * as `response` to keep your program (and any "OpenUI Lang" view) in sync with the editor.
+     */
+    onResponseChange?: (response: string, change: ResponseChangeInfo) => void;
+    /** Debounce for onResponseChange in ms (default 300). */
+    responseChangeDelay?: number;
     loadingFallback?: ReactNode;
     emptyFallback?: ReactNode;
     errorFallback?: ReactNode | ((args: FallbackArgs) => ReactNode);
     resetKeys?: readonly unknown[];
 };
+interface ResponseChangeInfo {
+    documentId: string;
+    title: string;
+    /** The document body written into the program, as Markdown. */
+    markdown: string;
+    source: DocumentChange["source"];
+}
 declare function JuneRenderer(props: JuneRendererProps): react.JSX.Element;
 
+/**
+ * Rewrites the arguments of a `DocumentEditor(documentId, title, content, ...)` call inside an
+ * OpenUI Lang program, leaving every other character of the program untouched.
+ */
+interface DocumentProgramUpdate {
+    title?: string;
+    /** New document body (Markdown or a Tiptap JSON string). */
+    content?: string;
+}
+/**
+ * Finds the DocumentEditor call whose first argument equals `documentId` and replaces its title
+ * and/or content. Returns the new program, or null when no matching call was found.
+ */
+declare function updateDocumentInProgram(program: string, documentId: string, update: DocumentProgramUpdate, componentName?: string): string | null;
+/** Reads the current title and content of a DocumentEditor call, or null. */
+declare function readDocumentFromProgram(program: string, documentId: string, componentName?: string): {
+    title: string;
+    content: string;
+} | null;
+
 declare function useResolvedTheme(mode: JuneThemeMode): JuneResolvedTheme;
 interface JuneThemeProviderProps {
     /**
@@ -413,9 +456,10 @@ type Extendable = Library & {
     extend: NonNullable<Library["extend"]>;
 };
 /**
- * Returns a library that contains every component of `library` plus DocumentEditor,
- * and allows DocumentEditor inside Card (Stack already accepts any child).
- * The library must include Card, which both OpenUI libraries do.
+ * Returns a library that contains every component of `library` plus DocumentEditor.
+ * On Zod 4.1+ it also joins Card's children. Zod 3.25 (what the app bundles) has no
+ * `util.mergeDefs`, and OpenUI's slot clone calls that, so the slot step is skipped
+ * there. The component is still registered and can be rendered.
  */
 declare function withDocumentEditor(library: Extendable): Required<_openuidev_lang_core.Library<_openuidev_react_lang.ComponentRenderer<any>, _openuidev_lang_core.DefinedAction<any, string>>>;
 
@@ -501,4 +545,4 @@ declare function JuneUI({ library, ...props }: JuneUIProps): react.JSX.Element;
  */
 declare const juneLibrary: Required<_openuidev_lang_core.Library<_openuidev_react_lang.ComponentRenderer<any>, _openuidev_lang_core.DefinedAction<any, string>>>;
 
-export { ALL_EXPORT_FORMATS, type ActionEventParser, type ActionOutcome, type ConfirmAction, type ConsumeStreamOptions, type DocJSON, type DocNode, type DocumentChange, type DocumentConflict, DocumentEditor, type DocumentEditorProps, type DocumentExportEvent, type DocumentExportFormat, type DocumentExporter, type DocumentInstructionOptions, type DocumentRecord, type DocumentSavePayload, type DocumentSnapshot, type DocumentStore, type ExportContext, type ExportResult, type FallbackArgs, type FetchStreamOptions, type JuneAction, type JuneActionContext, type JuneActionDefinition, type JuneActionMap, JuneDocumentContext, JuneDocumentEditorComponent, type JuneDocumentOptions, JuneError, JuneErrorBoundary, type JuneErrorBoundaryProps, type JuneErrorCode, type JuneErrorOptions, type JuneLibraryOptions, JuneRenderer, type JuneRendererProps, type JuneResolvedTheme, JuneRuntimeContext, type JuneStreamState, type JuneThemeMode, JuneThemeProvider, type JuneThemeProviderProps, type JuneThemeVars, JuneUI, type JuneUIProps, type OpenUIActionEvent, type OpenUILibrary, type OpenUIRendererProps, type ParsedActionEvent, type RunActionOptions, type SchemaLike, type SseOptions, type StreamChunk, type StreamSource, type StreamStarter, type StreamStatus, type UseJuneStreamOptions, type UseJuneStreamResult, consumeStream, copyDocumentToClipboard, createActionHandler, createDocumentStore, createJuneLibrary, darkTheme, defaultParseActionEvent, defineJuneAction, defineJuneComponent, documentPromptOptions, downloadResult, exportDocument, fetchStream, getDefaultDocumentStore, getDocumentEditorInstructions, getDocumentEditorRules, isJuneError, jsonFieldExtractor, juneLibrary, lightTheme, listDocumentExporters, mergeDocuments, registerDocumentExporter, runAction, serializeDocumentsForAgent, sseToText, toJuneError, useDocumentOptions, useJuneRuntime, useJuneStream, useJuneTheme, useResolvedTheme, withDocumentEditor };
+export { ALL_EXPORT_FORMATS, type ActionEventParser, type ActionOutcome, type ConfirmAction, type ConsumeStreamOptions, type DocJSON, type DocNode, type DocumentChange, type DocumentConflict, DocumentEditor, type DocumentEditorProps, type DocumentExportEvent, type DocumentExportFormat, type DocumentExporter, type DocumentInstructionOptions, type DocumentProgramUpdate, type DocumentRecord, type DocumentSavePayload, type DocumentSnapshot, type DocumentStore, type ExportContext, type ExportResult, type FallbackArgs, type FetchStreamOptions, type JuneAction, type JuneActionContext, type JuneActionDefinition, type JuneActionMap, JuneDocumentContext, JuneDocumentEditorComponent, type JuneDocumentOptions, JuneError, JuneErrorBoundary, type JuneErrorBoundaryProps, type JuneErrorCode, type JuneErrorOptions, type JuneLibraryOptions, JuneRenderer, type JuneRendererProps, type JuneResolvedTheme, JuneRuntimeContext, type JuneStreamState, type JuneThemeMode, JuneThemeProvider, type JuneThemeProviderProps, type JuneThemeVars, JuneUI, type JuneUIProps, type OpenUIActionEvent, type OpenUILibrary, type OpenUIRendererProps, type ParsedActionEvent, type ResponseChangeInfo, type RunActionOptions, type SchemaLike, type SseOptions, type StreamChunk, type StreamSource, type StreamStarter, type StreamStatus, type UseJuneStreamOptions, type UseJuneStreamResult, consumeStream, copyDocumentToClipboard, createActionHandler, createDocumentStore, createJuneLibrary, darkTheme, defaultParseActionEvent, defineJuneAction, defineJuneComponent, documentPromptOptions, downloadResult, exportDocument, fetchStream, getDefaultDocumentStore, getDocumentEditorInstructions, getDocumentEditorRules, isDocumentEcho, isJuneError, jsonFieldExtractor, juneLibrary, lightTheme, listDocumentExporters, mergeDocuments, readDocumentFromProgram, registerDocumentExporter, rememberDocumentEcho, runAction, serializeDocumentsForAgent, sseToText, toJuneError, updateDocumentInProgram, useDocumentOptions, useJuneRuntime, useJuneStream, useJuneTheme, useResolvedTheme, withDocumentEditor };

package/dist/index.d.ts

@@ -139,6 +139,13 @@ interface DocumentStore {
     remove(id: string): void;
 }
 declare function createDocumentStore(): DocumentStore;
+/**
+ * Remembers content produced from the user's own edits (for example when JuneUI rewrites
+ * the OpenUI program). When that content comes back through the DocumentEditor props it is
+ * ignored instead of being treated as a new AI version.
+ */
+declare function rememberDocumentEcho(store: DocumentStore, id: string, content: string): void;
+declare function isDocumentEcho(store: DocumentStore, id: string, content: string): boolean;
 /** The shared in-memory store used when none is provided. Documents are keyed by documentId. */
 declare function getDefaultDocumentStore(): DocumentStore;
 
@@ -281,13 +288,49 @@ type JuneRendererProps = Omit<OpenUIRendererProps, "library" | "response" | "isS
     onJuneError?: (error: JuneError) => void;
     /** Document editor callbacks and store. Memoize this object. */
     documents?: JuneDocumentOptions;
+    /**
+     * Called with an updated OpenUI program when the user edits a document (body or title).
+     * The matching `DocumentEditor(id, title, content)` call is rewritten with the new title and
+     * the body as Markdown; nothing else in the program changes. Store the value and pass it back
+     * as `response` to keep your program (and any "OpenUI Lang" view) in sync with the editor.
+     */
+    onResponseChange?: (response: string, change: ResponseChangeInfo) => void;
+    /** Debounce for onResponseChange in ms (default 300). */
+    responseChangeDelay?: number;
     loadingFallback?: ReactNode;
     emptyFallback?: ReactNode;
     errorFallback?: ReactNode | ((args: FallbackArgs) => ReactNode);
     resetKeys?: readonly unknown[];
 };
+interface ResponseChangeInfo {
+    documentId: string;
+    title: string;
+    /** The document body written into the program, as Markdown. */
+    markdown: string;
+    source: DocumentChange["source"];
+}
 declare function JuneRenderer(props: JuneRendererProps): react.JSX.Element;
 
+/**
+ * Rewrites the arguments of a `DocumentEditor(documentId, title, content, ...)` call inside an
+ * OpenUI Lang program, leaving every other character of the program untouched.
+ */
+interface DocumentProgramUpdate {
+    title?: string;
+    /** New document body (Markdown or a Tiptap JSON string). */
+    content?: string;
+}
+/**
+ * Finds the DocumentEditor call whose first argument equals `documentId` and replaces its title
+ * and/or content. Returns the new program, or null when no matching call was found.
+ */
+declare function updateDocumentInProgram(program: string, documentId: string, update: DocumentProgramUpdate, componentName?: string): string | null;
+/** Reads the current title and content of a DocumentEditor call, or null. */
+declare function readDocumentFromProgram(program: string, documentId: string, componentName?: string): {
+    title: string;
+    content: string;
+} | null;
+
 declare function useResolvedTheme(mode: JuneThemeMode): JuneResolvedTheme;
 interface JuneThemeProviderProps {
     /**
@@ -413,9 +456,10 @@ type Extendable = Library & {
     extend: NonNullable<Library["extend"]>;
 };
 /**
- * Returns a library that contains every component of `library` plus DocumentEditor,
- * and allows DocumentEditor inside Card (Stack already accepts any child).
- * The library must include Card, which both OpenUI libraries do.
+ * Returns a library that contains every component of `library` plus DocumentEditor.
+ * On Zod 4.1+ it also joins Card's children. Zod 3.25 (what the app bundles) has no
+ * `util.mergeDefs`, and OpenUI's slot clone calls that, so the slot step is skipped
+ * there. The component is still registered and can be rendered.
  */
 declare function withDocumentEditor(library: Extendable): Required<_openuidev_lang_core.Library<_openuidev_react_lang.ComponentRenderer<any>, _openuidev_lang_core.DefinedAction<any, string>>>;
 
@@ -501,4 +545,4 @@ declare function JuneUI({ library, ...props }: JuneUIProps): react.JSX.Element;
  */
 declare const juneLibrary: Required<_openuidev_lang_core.Library<_openuidev_react_lang.ComponentRenderer<any>, _openuidev_lang_core.DefinedAction<any, string>>>;
 
-export { ALL_EXPORT_FORMATS, type ActionEventParser, type ActionOutcome, type ConfirmAction, type ConsumeStreamOptions, type DocJSON, type DocNode, type DocumentChange, type DocumentConflict, DocumentEditor, type DocumentEditorProps, type DocumentExportEvent, type DocumentExportFormat, type DocumentExporter, type DocumentInstructionOptions, type DocumentRecord, type DocumentSavePayload, type DocumentSnapshot, type DocumentStore, type ExportContext, type ExportResult, type FallbackArgs, type FetchStreamOptions, type JuneAction, type JuneActionContext, type JuneActionDefinition, type JuneActionMap, JuneDocumentContext, JuneDocumentEditorComponent, type JuneDocumentOptions, JuneError, JuneErrorBoundary, type JuneErrorBoundaryProps, type JuneErrorCode, type JuneErrorOptions, type JuneLibraryOptions, JuneRenderer, type JuneRendererProps, type JuneResolvedTheme, JuneRuntimeContext, type JuneStreamState, type JuneThemeMode, JuneThemeProvider, type JuneThemeProviderProps, type JuneThemeVars, JuneUI, type JuneUIProps, type OpenUIActionEvent, type OpenUILibrary, type OpenUIRendererProps, type ParsedActionEvent, type RunActionOptions, type SchemaLike, type SseOptions, type StreamChunk, type StreamSource, type StreamStarter, type StreamStatus, type UseJuneStreamOptions, type UseJuneStreamResult, consumeStream, copyDocumentToClipboard, createActionHandler, createDocumentStore, createJuneLibrary, darkTheme, defaultParseActionEvent, defineJuneAction, defineJuneComponent, documentPromptOptions, downloadResult, exportDocument, fetchStream, getDefaultDocumentStore, getDocumentEditorInstructions, getDocumentEditorRules, isJuneError, jsonFieldExtractor, juneLibrary, lightTheme, listDocumentExporters, mergeDocuments, registerDocumentExporter, runAction, serializeDocumentsForAgent, sseToText, toJuneError, useDocumentOptions, useJuneRuntime, useJuneStream, useJuneTheme, useResolvedTheme, withDocumentEditor };
+export { ALL_EXPORT_FORMATS, type ActionEventParser, type ActionOutcome, type ConfirmAction, type ConsumeStreamOptions, type DocJSON, type DocNode, type DocumentChange, type DocumentConflict, DocumentEditor, type DocumentEditorProps, type DocumentExportEvent, type DocumentExportFormat, type DocumentExporter, type DocumentInstructionOptions, type DocumentProgramUpdate, type DocumentRecord, type DocumentSavePayload, type DocumentSnapshot, type DocumentStore, type ExportContext, type ExportResult, type FallbackArgs, type FetchStreamOptions, type JuneAction, type JuneActionContext, type JuneActionDefinition, type JuneActionMap, JuneDocumentContext, JuneDocumentEditorComponent, type JuneDocumentOptions, JuneError, JuneErrorBoundary, type JuneErrorBoundaryProps, type JuneErrorCode, type JuneErrorOptions, type JuneLibraryOptions, JuneRenderer, type JuneRendererProps, type JuneResolvedTheme, JuneRuntimeContext, type JuneStreamState, type JuneThemeMode, JuneThemeProvider, type JuneThemeProviderProps, type JuneThemeVars, JuneUI, type JuneUIProps, type OpenUIActionEvent, type OpenUILibrary, type OpenUIRendererProps, type ParsedActionEvent, type ResponseChangeInfo, type RunActionOptions, type SchemaLike, type SseOptions, type StreamChunk, type StreamSource, type StreamStarter, type StreamStatus, type UseJuneStreamOptions, type UseJuneStreamResult, consumeStream, copyDocumentToClipboard, createActionHandler, createDocumentStore, createJuneLibrary, darkTheme, defaultParseActionEvent, defineJuneAction, defineJuneComponent, documentPromptOptions, downloadResult, exportDocument, fetchStream, getDefaultDocumentStore, getDocumentEditorInstructions, getDocumentEditorRules, isDocumentEcho, isJuneError, jsonFieldExtractor, juneLibrary, lightTheme, listDocumentExporters, mergeDocuments, readDocumentFromProgram, registerDocumentExporter, rememberDocumentEcho, runAction, serializeDocumentsForAgent, sseToText, toJuneError, updateDocumentInProgram, useDocumentOptions, useJuneRuntime, useJuneStream, useJuneTheme, useResolvedTheme, withDocumentEditor };