@yorkie-js/react 0.6.3 → 0.6.6-rc

package/dist/yorkie-js-react.d.ts

@@ -1,8 +1,11 @@
+import { default as default_2 } from 'react';
 import { Indexable } from '@yorkie-js/sdk';
 import { JSONArray } from '@yorkie-js/sdk';
 import { JSONObject } from '@yorkie-js/sdk';
 import { JSX } from 'react/jsx-dev-runtime';
+import { Presence } from '@yorkie-js/sdk';
 import { PropsWithChildren } from 'react';
+import { StreamConnectionStatus } from '@yorkie-js/sdk';
 
 /**
  * `DocumentProvider` is a component that provides a document to its children.
@@ -13,13 +16,18 @@ export declare const DocumentProvider: <R, P extends Indexable = Indexable>({ do
     docKey: string;
     initialRoot?: R | undefined;
     initialPresence?: P | undefined;
-    children?: React.ReactNode;
+    children?: default_2.ReactNode;
 }) => JSX.Element;
 
 export { JSONArray }
 
 export { JSONObject }
 
+/**
+ * `useConnection` is a custom hook that returns the connection status of the document.
+ */
+export declare const useConnection: () => StreamConnectionStatus;
+
 /**
  * `useDocument` is a custom hook that returns the root object and update function of the document.
  * This hook must be used within a `DocumentProvider`.
@@ -30,7 +38,8 @@ export declare const useDocument: <R, P extends Indexable = Indexable>() => {
         clientID: string;
         presence: P;
     }[];
-    update: (callback: (root: R, presence: P) => void) => void;
+    connection: StreamConnectionStatus;
+    update: (callback: (root: R, presence: Presence<P>) => void) => void;
     loading: boolean;
     error: Error | undefined;
 };
@@ -52,18 +61,25 @@ export declare const useRoot: () => {
 };
 
 /**
- * `useYorkieDoc` is a custom hook that initializes a Yorkie client and attaches a document.
+ * `useYorkieDoc` is a custom hook that initializes a Yorkie Client and a
+ * document in a single hook.
  *
  * @param apiKey
  * @param docKey
- * @param initialRoot
  * @returns
  */
-export declare function useYorkieDoc<T>(apiKey: string, docKey: string, initialRoot: T, options?: {
+export declare function useYorkieDoc<R, P extends Indexable>(apiKey: string, docKey: string, options?: {
+    initialRoot?: R;
+    initialPresence?: P;
     rpcAddr?: string;
 }): {
-    root: T;
-    update: (callback: (root: T) => void) => void;
+    root: R;
+    presences: Array<{
+        clientID: string;
+        presence: P;
+    }>;
+    connection: StreamConnectionStatus;
+    update: (callback: (root: R, presence: Presence<P>) => void) => void;
     loading: boolean;
     error: Error | undefined;
 };