@arbidocs/react 0.5.61 → 0.5.63

package/dist/{index.d-BLw5AN0H.d.cts → index.d-AT7wdTWC.d.cts}

@@ -2,7 +2,7 @@ import * as zustand from 'zustand';
 import * as React$1 from 'react';
 import { ReactNode, ComponentType, ReactElement } from 'react';
 import { StoreApi } from 'zustand/vanilla';
-import { SearchChunk } from '@arbidocs/sdk/browser';
+import { ArtifactEvent, SearchChunk } from '@arbidocs/sdk/browser';
 import { ToasterProps } from 'sonner';
 
 /**
@@ -222,6 +222,54 @@ declare function useTurnDocumentId(input: TurnDocumentInput): string | null;
  */
 declare function takeDocumentForTurn(input: TurnDocumentInput): string | null;
 
+/**
+ * The documents the assistant is writing (or wrote) in this tab's chats, as their artifact events
+ * stream in: the chat engine records every one (`recordChatArtifact`), before the host's
+ * `chat.onArtifact` shows it. One store for every surface that shows a draft as it is written: the
+ * answer's artifact card, the document viewer, and a drafting chat's document pane.
+ *
+ * A module-level store, like the open-document registry: a chat and a viewer agree wherever they
+ * sit in the tree. It holds what streamed in this tab only; a saved draft is read from the
+ * documents list. Cleared on sign-out (`clearChatArtifacts`).
+ */
+/** An artifact as it streams: what the events said so far. */
+interface ChatArtifact {
+    /** The document it is written into (`doc-…`). */
+    docExtId: string;
+    title: string;
+    /** The content so far (Markdown, or the html/react source of a live artifact). */
+    content: string;
+    /**
+     * `markdown` / `text` are document drafts (stored by the server as Word documents); `html` /
+     * `react` are live artifacts; `image` is a generated image.
+     */
+    mode: 'markdown' | 'html' | 'text' | 'react' | 'image';
+    isComplete: boolean;
+    version?: number | null;
+    /** The answer that writes it. */
+    messageExtId?: string;
+    /** The conversation it is written in (`new` until the server named it). */
+    conversationId: string;
+    createdAt: string;
+}
+/** Record an artifact event of a chat turn in `conversationId`. */
+declare function recordChatArtifact(event: ArtifactEvent, conversationId: string): void;
+/** Forget every streamed artifact (sign-out). */
+declare function clearChatArtifacts(): void;
+/** Every artifact streamed in this tab, by document id. */
+declare function getChatArtifacts(): Readonly<Record<string, ChatArtifact>>;
+/** The artifact streaming (or streamed) into this document, if one did in this tab. */
+declare function getChatArtifact(documentId: string | null | undefined): ChatArtifact | undefined;
+/** The artifact streaming into this document, if one is. Re-renders as it streams. */
+declare function useChatArtifact(documentId: string | null | undefined): ChatArtifact | undefined;
+/** The artifact this answer writes (or wrote), if it did in this tab. */
+declare function useMessageChatArtifact(messageId: string | null | undefined): ChatArtifact | undefined;
+/**
+ * The latest artifact written in this conversation in this tab (the one a drafting surface shows),
+ * if one was.
+ */
+declare function useConversationChatArtifact(conversationId: string | null | undefined): ChatArtifact | undefined;
+
 /**
  * A thread's document: the one document a conversation drafts in, part of the conversation.
  *
@@ -465,4 +513,4 @@ declare function NotificationBell({ renderTrigger, onNavigate, onSelectNotificat
 
 declare function Toaster({ toastOptions, ...props }: ToasterProps): React$1.JSX.Element;
 
-export { takeDocumentForTurn as $, type AppNotification as A, hasMessageBody as B, insertMention as C, DEFAULT_NOTIFY_TONE as D, latestThreadOfDocument as E, linkMentions as F, mentionFromHref as G, type HostConfigRecord as H, notify as I, openDocumentId as J, opensInWord as K, LEGACY_THREAD_DOCUMENTS_KEY as L, MAX_SESSION_NOTIFICATIONS as M, NotificationBell as N, type OpenDocumentRegistration as O, persistNotifyHistory as P, persistSearchSession as Q, readLegacyThreadDocuments as R, type SavedDocumentInput as S, type ThreadBinding as T, UNBOUND as U, requestSearch as V, type WordDocumentKind as W, savedDocumentIdFor as X, seedNotifications as Y, selectUnread as Z, sharedSearchSession as _, ArbiHost as a, takePendingSearch as a0, toMessageMentions as a1, useHostConfigRecord as a2, useNotify as a3, useOpenDocumentId as a4, useRegisterOpenDocument as a5, useTurnDocumentId as a6, type ArbiHostConnection as b, type ArbiHostProps as c, MENTION_HREF_PREFIX as d, type MentionCandidate as e, type MentionKind as f, type MessageMentionRef as g, type NotificationBellProps as h, type NotificationBellTriggerState as i, type NotifyConfig as j, type NotifyOptions as k, type NotifyVariant as l, type SearchSession as m, type SearchSessionState as n, type SearchStatus as o, type ThreadBindingRow as p, Toaster as q, type TurnDocumentInput as r, bindingOfRow as s, clearSearchSession as t, configureNotify as u, createSearchSession as v, extractMentions as w, filterMentionCandidates as x, findMentionQuery as y, forgetLegacyThreadDocuments as z };
+export { requestSearch as $, type AppNotification as A, forgetLegacyThreadDocuments as B, type ChatArtifact as C, DEFAULT_NOTIFY_TONE as D, getChatArtifact as E, getChatArtifacts as F, hasMessageBody as G, type HostConfigRecord as H, insertMention as I, latestThreadOfDocument as J, linkMentions as K, LEGACY_THREAD_DOCUMENTS_KEY as L, MAX_SESSION_NOTIFICATIONS as M, NotificationBell as N, type OpenDocumentRegistration as O, mentionFromHref as P, notify as Q, openDocumentId as R, type SavedDocumentInput as S, type ThreadBinding as T, UNBOUND as U, opensInWord as V, type WordDocumentKind as W, persistNotifyHistory as X, persistSearchSession as Y, readLegacyThreadDocuments as Z, recordChatArtifact as _, ArbiHost as a, savedDocumentIdFor as a0, seedNotifications as a1, selectUnread as a2, sharedSearchSession as a3, takeDocumentForTurn as a4, takePendingSearch as a5, toMessageMentions as a6, useChatArtifact as a7, useConversationChatArtifact as a8, useHostConfigRecord as a9, useMessageChatArtifact as aa, useNotify as ab, useOpenDocumentId as ac, useRegisterOpenDocument as ad, useTurnDocumentId as ae, type ArbiHostConnection as b, type ArbiHostProps as c, MENTION_HREF_PREFIX as d, type MentionCandidate as e, type MentionKind as f, type MessageMentionRef as g, type NotificationBellProps as h, type NotificationBellTriggerState as i, type NotifyConfig as j, type NotifyOptions as k, type NotifyVariant as l, type SearchSession as m, type SearchSessionState as n, type SearchStatus as o, type ThreadBindingRow as p, Toaster as q, type TurnDocumentInput as r, bindingOfRow as s, clearChatArtifacts as t, clearSearchSession as u, configureNotify as v, createSearchSession as w, extractMentions as x, filterMentionCandidates as y, findMentionQuery as z };

package/dist/{index.d-BLw5AN0H.d.ts → index.d-AT7wdTWC.d.ts}

@@ -2,7 +2,7 @@ import * as zustand from 'zustand';
 import * as React$1 from 'react';
 import { ReactNode, ComponentType, ReactElement } from 'react';
 import { StoreApi } from 'zustand/vanilla';
-import { SearchChunk } from '@arbidocs/sdk/browser';
+import { ArtifactEvent, SearchChunk } from '@arbidocs/sdk/browser';
 import { ToasterProps } from 'sonner';
 
 /**
@@ -222,6 +222,54 @@ declare function useTurnDocumentId(input: TurnDocumentInput): string | null;
  */
 declare function takeDocumentForTurn(input: TurnDocumentInput): string | null;
 
+/**
+ * The documents the assistant is writing (or wrote) in this tab's chats, as their artifact events
+ * stream in: the chat engine records every one (`recordChatArtifact`), before the host's
+ * `chat.onArtifact` shows it. One store for every surface that shows a draft as it is written: the
+ * answer's artifact card, the document viewer, and a drafting chat's document pane.
+ *
+ * A module-level store, like the open-document registry: a chat and a viewer agree wherever they
+ * sit in the tree. It holds what streamed in this tab only; a saved draft is read from the
+ * documents list. Cleared on sign-out (`clearChatArtifacts`).
+ */
+/** An artifact as it streams: what the events said so far. */
+interface ChatArtifact {
+    /** The document it is written into (`doc-…`). */
+    docExtId: string;
+    title: string;
+    /** The content so far (Markdown, or the html/react source of a live artifact). */
+    content: string;
+    /**
+     * `markdown` / `text` are document drafts (stored by the server as Word documents); `html` /
+     * `react` are live artifacts; `image` is a generated image.
+     */
+    mode: 'markdown' | 'html' | 'text' | 'react' | 'image';
+    isComplete: boolean;
+    version?: number | null;
+    /** The answer that writes it. */
+    messageExtId?: string;
+    /** The conversation it is written in (`new` until the server named it). */
+    conversationId: string;
+    createdAt: string;
+}
+/** Record an artifact event of a chat turn in `conversationId`. */
+declare function recordChatArtifact(event: ArtifactEvent, conversationId: string): void;
+/** Forget every streamed artifact (sign-out). */
+declare function clearChatArtifacts(): void;
+/** Every artifact streamed in this tab, by document id. */
+declare function getChatArtifacts(): Readonly<Record<string, ChatArtifact>>;
+/** The artifact streaming (or streamed) into this document, if one did in this tab. */
+declare function getChatArtifact(documentId: string | null | undefined): ChatArtifact | undefined;
+/** The artifact streaming into this document, if one is. Re-renders as it streams. */
+declare function useChatArtifact(documentId: string | null | undefined): ChatArtifact | undefined;
+/** The artifact this answer writes (or wrote), if it did in this tab. */
+declare function useMessageChatArtifact(messageId: string | null | undefined): ChatArtifact | undefined;
+/**
+ * The latest artifact written in this conversation in this tab (the one a drafting surface shows),
+ * if one was.
+ */
+declare function useConversationChatArtifact(conversationId: string | null | undefined): ChatArtifact | undefined;
+
 /**
  * A thread's document: the one document a conversation drafts in, part of the conversation.
  *
@@ -465,4 +513,4 @@ declare function NotificationBell({ renderTrigger, onNavigate, onSelectNotificat
 
 declare function Toaster({ toastOptions, ...props }: ToasterProps): React$1.JSX.Element;
 
-export { takeDocumentForTurn as $, type AppNotification as A, hasMessageBody as B, insertMention as C, DEFAULT_NOTIFY_TONE as D, latestThreadOfDocument as E, linkMentions as F, mentionFromHref as G, type HostConfigRecord as H, notify as I, openDocumentId as J, opensInWord as K, LEGACY_THREAD_DOCUMENTS_KEY as L, MAX_SESSION_NOTIFICATIONS as M, NotificationBell as N, type OpenDocumentRegistration as O, persistNotifyHistory as P, persistSearchSession as Q, readLegacyThreadDocuments as R, type SavedDocumentInput as S, type ThreadBinding as T, UNBOUND as U, requestSearch as V, type WordDocumentKind as W, savedDocumentIdFor as X, seedNotifications as Y, selectUnread as Z, sharedSearchSession as _, ArbiHost as a, takePendingSearch as a0, toMessageMentions as a1, useHostConfigRecord as a2, useNotify as a3, useOpenDocumentId as a4, useRegisterOpenDocument as a5, useTurnDocumentId as a6, type ArbiHostConnection as b, type ArbiHostProps as c, MENTION_HREF_PREFIX as d, type MentionCandidate as e, type MentionKind as f, type MessageMentionRef as g, type NotificationBellProps as h, type NotificationBellTriggerState as i, type NotifyConfig as j, type NotifyOptions as k, type NotifyVariant as l, type SearchSession as m, type SearchSessionState as n, type SearchStatus as o, type ThreadBindingRow as p, Toaster as q, type TurnDocumentInput as r, bindingOfRow as s, clearSearchSession as t, configureNotify as u, createSearchSession as v, extractMentions as w, filterMentionCandidates as x, findMentionQuery as y, forgetLegacyThreadDocuments as z };
+export { requestSearch as $, type AppNotification as A, forgetLegacyThreadDocuments as B, type ChatArtifact as C, DEFAULT_NOTIFY_TONE as D, getChatArtifact as E, getChatArtifacts as F, hasMessageBody as G, type HostConfigRecord as H, insertMention as I, latestThreadOfDocument as J, linkMentions as K, LEGACY_THREAD_DOCUMENTS_KEY as L, MAX_SESSION_NOTIFICATIONS as M, NotificationBell as N, type OpenDocumentRegistration as O, mentionFromHref as P, notify as Q, openDocumentId as R, type SavedDocumentInput as S, type ThreadBinding as T, UNBOUND as U, opensInWord as V, type WordDocumentKind as W, persistNotifyHistory as X, persistSearchSession as Y, readLegacyThreadDocuments as Z, recordChatArtifact as _, ArbiHost as a, savedDocumentIdFor as a0, seedNotifications as a1, selectUnread as a2, sharedSearchSession as a3, takeDocumentForTurn as a4, takePendingSearch as a5, toMessageMentions as a6, useChatArtifact as a7, useConversationChatArtifact as a8, useHostConfigRecord as a9, useMessageChatArtifact as aa, useNotify as ab, useOpenDocumentId as ac, useRegisterOpenDocument as ad, useTurnDocumentId as ae, type ArbiHostConnection as b, type ArbiHostProps as c, MENTION_HREF_PREFIX as d, type MentionCandidate as e, type MentionKind as f, type MessageMentionRef as g, type NotificationBellProps as h, type NotificationBellTriggerState as i, type NotifyConfig as j, type NotifyOptions as k, type NotifyVariant as l, type SearchSession as m, type SearchSessionState as n, type SearchStatus as o, type ThreadBindingRow as p, Toaster as q, type TurnDocumentInput as r, bindingOfRow as s, clearChatArtifacts as t, clearSearchSession as u, configureNotify as v, createSearchSession as w, extractMentions as x, filterMentionCandidates as y, findMentionQuery as z };

package/dist/{index.d-DPVj21h1.d.ts → index.d-B0dosFZc.d.cts}

@@ -605,7 +605,7 @@ declare const Command: React.ForwardRefExoticComponent<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     label?: string;
     shouldFilter?: boolean;
     filter?: (value: string, search: string, keywords?: string[]) => number;
@@ -631,7 +631,7 @@ declare const CommandList: React.ForwardRefExoticComponent<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     label?: string;
 } & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
 declare const CommandEmpty: React.ForwardRefExoticComponent<Omit<{
@@ -640,14 +640,14 @@ declare const CommandEmpty: React.ForwardRefExoticComponent<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
 declare const CommandGroup: React.ForwardRefExoticComponent<Omit<{
     children?: React.ReactNode;
 } & Omit<Pick<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild">, "value" | "heading"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>>, "value" | "heading"> & {
     heading?: React.ReactNode;
     value?: string;
     forceMount?: boolean;
@@ -656,7 +656,7 @@ declare const CommandSeparator: React.ForwardRefExoticComponent<Omit<Pick<Pick<R
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     alwaysRender?: boolean;
 } & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
 declare const CommandItem: React.ForwardRefExoticComponent<Omit<{
@@ -665,7 +665,7 @@ declare const CommandItem: React.ForwardRefExoticComponent<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild">, "value" | "onSelect" | "disabled"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>>, "value" | "onSelect" | "disabled"> & {
     disabled?: boolean;
     onSelect?: (value: string) => void;
     value?: string;

package/dist/{index.d-DPVj21h1.d.cts → index.d-B0dosFZc.d.ts}

@@ -605,7 +605,7 @@ declare const Command: React.ForwardRefExoticComponent<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     label?: string;
     shouldFilter?: boolean;
     filter?: (value: string, search: string, keywords?: string[]) => number;
@@ -631,7 +631,7 @@ declare const CommandList: React.ForwardRefExoticComponent<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     label?: string;
 } & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
 declare const CommandEmpty: React.ForwardRefExoticComponent<Omit<{
@@ -640,14 +640,14 @@ declare const CommandEmpty: React.ForwardRefExoticComponent<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
 declare const CommandGroup: React.ForwardRefExoticComponent<Omit<{
     children?: React.ReactNode;
 } & Omit<Pick<Pick<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "key" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild">, "value" | "heading"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>>, "value" | "heading"> & {
     heading?: React.ReactNode;
     value?: string;
     forceMount?: boolean;
@@ -656,7 +656,7 @@ declare const CommandSeparator: React.ForwardRefExoticComponent<Omit<Pick<Pick<R
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>> & {
     alwaysRender?: boolean;
 } & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
 declare const CommandItem: React.ForwardRefExoticComponent<Omit<{
@@ -665,7 +665,7 @@ declare const CommandItem: React.ForwardRefExoticComponent<Omit<{
     ref?: React.Ref<HTMLDivElement>;
 } & {
     asChild?: boolean;
-}, "key" | keyof React.HTMLAttributes<HTMLDivElement> | "asChild">, "value" | "onSelect" | "disabled"> & {
+}, "key" | "asChild" | keyof React.HTMLAttributes<HTMLDivElement>>, "value" | "onSelect" | "disabled"> & {
     disabled?: boolean;
     onSelect?: (value: string) => void;
     value?: string;