@yorkie-js/react 0.7.12-rc → 0.7.13

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

@@ -99,7 +99,7 @@ declare type DocumentContextType<R, P extends Indexable = Indexable> = {
  * This component must be under a `YorkieProvider` component to initialize the
  * Yorkie client properly.
  */
-export declare const DocumentProvider: <R, P extends Indexable = Indexable>({ docKey, initialRoot, initialPresence, enableDevtools, syncMode, documentPollInterval, disableGC, children, }: {
+export declare const DocumentProvider: <R, P extends Indexable = Indexable>({ docKey, initialRoot, initialPresence, enableDevtools, syncMode, documentPollInterval, disableGC, disablePresence, children, }: {
     docKey: string;
     initialRoot?: R;
     initialPresence?: P;
@@ -121,6 +121,15 @@ export declare const DocumentProvider: <R, P extends Indexable = Indexable>({ do
      * GC behavior on this client.
      */
     disableGC?: boolean;
+    /**
+     * `disablePresence` declares that this document does not use presence.
+     * Forwarded to both `new Document(...)` and `client.attach(...)`. The
+     * server fixates the value on first attach — subsequent attaches
+     * inherit the server's value regardless of what this prop carries.
+     * Useful for counter-only documents where the per-client presence
+     * map would otherwise leak memory.
+     */
+    disablePresence?: boolean;
     children?: default_2.ReactNode;
 }) => JSX.Element;
 
@@ -290,6 +299,16 @@ export declare const usePresences: <P extends Indexable = Indexable>() => Array<
     presence: P;
 }>;
 
+/**
+ * `useRemoveDocument` returns a function that removes the current document
+ * from the server via `client.remove` (as opposed to `client.detach`).
+ * After it resolves the document is gone for every client and the key can
+ * be reattached as a fresh document. The returned function rejects until
+ * the document is attached, and the removal error is propagated to the
+ * caller. This hook must be used within a `DocumentProvider`.
+ */
+export declare const useRemoveDocument: <R, P extends Indexable = Indexable>() => () => Promise<void>;
+
 /**
  * `useRevisions` is a custom hook that provides revision management methods
  * for the current document. It wraps the client's revision API methods
@@ -342,6 +361,13 @@ export declare function useYorkieDoc<R, P extends Indexable = Indexable>(apiKey:
      * GC behavior on this client.
      */
     disableGC?: boolean;
+    /**
+     * `disablePresence` declares that this document does not use presence.
+     * Forwarded to both `new Document(...)` and `client.attach(...)`. The
+     * server fixates the value on first attach — subsequent attaches
+     * inherit the server's value regardless of what this option carries.
+     */
+    disablePresence?: boolean;
 }): {
     root: R;
     presences: Array<{