@liveblocks/react/dist/index.d.ts

A set of React hooks and providers to use Liveblocks declaratively. Liveblocks is the all-in-one toolkit to build collaborative products like Figma, Notion, and more.

import { R as RegisterAiKnowledgeProps, w as RegisterAiToolProps } from './room-DamZM98T.js';
export { A as AiChatStatus, C as ClientContext, L as LiveblocksProvider, M as MutationContext, y as RoomContext, N as RoomProvider, S as SendAiMessageOptions, U as UseSendAiMessageOptions, x as UseThreadsOptions, B as createLiveblocksContext, K as createRoomContext, O as useAddReaction, aJ as useAiChat, aL as useAiChatMessages, aM as useAiChatStatus, aK as useAiChats, av as useAttachmentUrl, P as useBroadcastEvent, Q as useCanRedo, T as useCanUndo, z as useClient, aB as useCreateAiChat, V as useCreateComment, W as useCreateThread, aC as useDeleteAiChat, D as useDeleteAllInboxNotifications, X as useDeleteComment, E as useDeleteInboxNotification, Y as useDeleteThread, Z as useEditComment, a0 as useEditCommentMetadata, $ as useEditThreadMetadata, F as useErrorListener, a5 as useEventListener, aG as useGroupInfo, a6 as useHistory, am as useHistoryVersionData, aw as useHistoryVersions, _ as useInboxNotificationThread, ay as useInboxNotifications, a7 as useIsInsideRoom, a8 as useLostConnectionListener, H as useMarkAllInboxNotificationsAsRead, I as useMarkInboxNotificationAsRead, a9 as useMarkThreadAsRead, a1 as useMarkThreadAsResolved, a2 as useMarkThreadAsUnresolved, aa as useMutation, ab as useMyPresence, az as useNotificationSettings, an as useOther, ao as useOthers, ap as useOthersConnectionIds, ac as useOthersListener, aq as useOthersMapped, ad as useRedo, ae as useRemoveReaction, af as useRoom, aF as useRoomInfo, ax as useRoomSubscriptionSettings, au as useSearchComments, ar as useSelf, aD as useSendAiMessage, ag as useStatus, as as useStorage, ah as useStorageRoot, a3 as useSubscribeToThread, J as useSyncStatus, ai as useThreadSubscription, at as useThreads, aj as useUndo, aH as useUnreadInboxNotificationsCount, a4 as useUnsubscribeFromThread, ak as useUpdateMyPresence, aA as useUpdateNotificationSettings, al as useUpdateRoomSubscriptionSettings, aN as useUrlMetadata, aI as useUser, aE as useUserThreads_experimental } from './room-DamZM98T.js';
export { Json, JsonObject, isNotificationChannelEnabled, shallow } from '@liveblocks/client';
import * as react_jsx_runtime from 'react/jsx-runtime';
import * as react from 'react';
import { ReactNode } from 'react';
import '@liveblocks/core';

type Props = {
    fallback: ReactNode;
    children: (() => ReactNode | undefined) | ReactNode | undefined;
};
/**
 * Almost like a normal <Suspense> component, except that for server-side
 * renders, the fallback will be used.
 *
 * The child props will have to be provided in a function, i.e. change:
 *
 *   <Suspense fallback={<Loading />}>
 *     <MyRealComponent a={1} />
 *   </Suspense>
 *
 * To:
 *
 *   <ClientSideSuspense fallback={<Loading />}>
 *     <MyRealComponent a={1} />
 *   </ClientSideSuspense>
 *
 */
declare function ClientSideSuspense(props: Props): react_jsx_runtime.JSX.Element;

/**
 * Make knowledge about your application state available to any AI used in
 * a chat or a one-off request.
 *
 * For example:
 *
 *     <RegisterAiKnowledge
 *        description="The current mode of my application"
 *        value="dark" />
 *
 * Or scoped to a specific chat:
 *
 *     <RegisterAiKnowledge
 *        description="The current list of todos"
 *        value={todos}
 *        chatId="chat-1234" />
 *
 * By mounting this component, the AI will get access to this knwoledge.
 * By unmounting this component, the AI will no longer have access to it.
 * It can choose to use or ignore this knowledge in its responses.
 */
declare const RegisterAiKnowledge: react.NamedExoticComponent<RegisterAiKnowledgeProps>;
/**
 * Make a tool available to your AI chat or a one-off request.
 * A tool is a piece of functionality that the AI can call to perform an action
 * or look up information on the user's behalf.
 *
 * Also, tools are used to render custom UIs for tool invocations, which are
 * embedded inside the AI chat.
 *
 * For example:
 *
 *   <RegisterAiTool
 *     name="list-todos"
 *     tool={defineAiTool()({ ... })}
 *     />
 *
 * Or scoped to a specific chat:
 *
 *   <RegisterAiTool
 *     name="list-todos"
 *     tool={defineAiTool()({ ... })}
 *     chatId="chat-1234"
 *     />
 *
 * By mounting this component, the tool is made available.
 * By unmounting this component, the tool will no longer be available.
 */
declare const RegisterAiTool: react.NamedExoticComponent<RegisterAiToolProps>;

export { ClientSideSuspense, RegisterAiKnowledge, RegisterAiKnowledgeProps, RegisterAiTool, RegisterAiToolProps };