@yorkie-js/react 0.6.22 → 0.6.24

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

@@ -9,8 +9,27 @@ import { Presence } from '@yorkie-js/sdk';
 import { PropsWithChildren } from 'react';
 import { StreamConnectionStatus } from '@yorkie-js/sdk';
 
+/**
+ * `createDocumentSelector` is a factory function that provides a selector-based `useDocument` hook.
+ * By currying this function, type T can be inferred from the selector function.
+ */
+export declare const createDocumentSelector: <R, P extends Indexable = Indexable>() => <T = DocumentContextType<R, P>>(selector: (state: DocumentContextType<R, P>) => T, equalityFn?: (a: T, b: T) => boolean) => T;
+
 export { Document_2 as Document }
 
+declare type DocumentContextType<R, P extends Indexable = Indexable> = {
+    doc: Document_2<R, P> | undefined;
+    root: R;
+    presences: Array<{
+        clientID: string;
+        presence: P;
+    }>;
+    connection: StreamConnectionStatus;
+    update: (callback: (root: R, presence: Presence<P>) => void) => void;
+    loading: boolean;
+    error: Error | undefined;
+};
+
 /**
  * `DocumentProvider` is a component that provides a document to its children.
  * This component must be under a `YorkieProvider` component to initialize the
@@ -27,42 +46,37 @@ export { JSONArray }
 
 export { JSONObject }
 
+/**
+ * Performs a shallow equality check between two values.
+ */
+export declare function shallowEqual<T>(valueA: T, valueB: T): boolean;
+
 /**
  * `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.
+ * `useDocument` is a custom hook that returns the complete document context.
  * This hook must be used within a `DocumentProvider`.
+ * @returns The complete document context.
  */
-export declare const useDocument: <R, P extends Indexable = Indexable>() => {
-    doc: Document_2<R, P>;
-    root: R;
-    presences: {
-        clientID: string;
-        presence: P;
-    }[];
-    connection: StreamConnectionStatus;
-    update: (callback: (root: R, presence: Presence<P>) => void) => void;
-    loading: boolean;
-    error: Error | undefined;
-};
+export declare function useDocument<R, P extends Indexable = Indexable>(): DocumentContextType<R, P>;
 
 /**
  * `usePresences` is a custom hook that returns the presences of the document.
  */
-export declare const usePresences: () => {
+export declare const usePresences: <P extends Indexable = Indexable>() => {
     clientID: string;
-    presence: any;
+    presence: P;
 }[];
 
 /**
  * `useRoot` is a custom hook that returns the root object of the document.
  * This hook must be used within a `DocumentProvider`.
  */
-export declare const useRoot: () => {
-    root: any;
+export declare const useRoot: <R>() => {
+    root: R;
 };
 
 /**