@yorkie-js/sdk 0.7.7 → 0.7.9

package/README.md

@@ -10,7 +10,7 @@ To get started using Yorkie JavaScript SDK, see: https://yorkie.dev/docs/js-sdk
 
 ## Contributing
 
-See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
+See [CONTRIBUTING](../../CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
 
 ## Contributors ✨
 

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

@@ -93,20 +93,30 @@ declare interface Attachable {
 /**
  * `AttachChannelOptions` are user-settable options used when attaching channels.
  */
-declare interface AttachChannelOptions {
+export declare interface AttachChannelOptions {
     /**
-     * `isRealtime` determines whether to automatically watch channel changes
-     * and send heartbeats. If false (manual mode), the client must call sync()
-     * explicitly to refresh the TTL.
-     * Default is true for backward compatibility.
+     * `syncMode` selects how the channel keeps presence in sync with the server.
+     * Default is `SyncMode.Realtime`.
+     * - `SyncMode.Realtime`: open a watch stream and run the heartbeat. Required
+     *   to receive broadcast events.
+     * - `SyncMode.Polling`: heartbeat-only. No watch stream is opened. The
+     *   heartbeat refreshes TTL and brings the latest sessionCount. Recommended
+     *   for large channels where broadcast is not needed.
+     * - `SyncMode.Manual`: no automatic activity. Caller must invoke `sync()`.
      */
-    isRealtime?: boolean;
+    syncMode?: SyncMode;
+    /**
+     * `channelHeartbeatInterval` overrides the heartbeat interval (ms) for this
+     * attachment. If unset, mode-specific defaults apply: Polling=3000,
+     * Realtime=30000.
+     */
+    channelHeartbeatInterval?: number;
 }
 
 /**
  * `AttachOptions` are user-settable options used when attaching documents.
  */
-declare interface AttachOptions<R, P> {
+export declare interface AttachOptions<R, P> {
     /**
      * `initialRoot` is the initial root of the document. It is used to
      * initialize the document. It is used when the fields are not set in the
@@ -121,6 +131,11 @@ declare interface AttachOptions<R, P> {
      * `syncMode` defines the synchronization mode of the document.
      */
     syncMode?: SyncMode;
+    /**
+     * `documentPollInterval` (ms) — only used when `syncMode` is `Polling`.
+     * Default: 3000.
+     */
+    documentPollInterval?: number;
     /**
      * `schema` is the schema of the document. It is used to validate the
      * document.
@@ -1039,6 +1054,17 @@ export declare class Client {
      * `changeSyncMode` changes the synchronization mode of the given document.
      */
     changeSyncMode<R, P extends Indexable>(doc: Document_2<R, P>, syncMode: SyncMode): Promise<Document_2<R, P>>;
+    /**
+     * `changeSyncMode` changes the synchronization mode of the given channel.
+     */
+    changeSyncMode(channel: Channel, syncMode: SyncMode): Promise<Channel>;
+    private changeDocumentSyncMode;
+    /**
+     * `assertValidChannelSyncMode` rejects sync modes that are not valid for
+     * channels. `RealtimePushOnly` and `RealtimeSyncOff` are document-only.
+     */
+    private assertValidChannelSyncMode;
+    private changeChannelSyncMode;
     /**
      * `sync` pushes local changes of the attached documents to the server and
      * receives changes of the remote replica from the server then apply them to
@@ -1096,6 +1122,17 @@ export declare class Client {
      * `restoreRevision` restores the document to the given revision.
      */
     restoreRevision<R, P extends Indexable>(doc: Document_2<R, P>, revisionId: string): Promise<void>;
+    /**
+     * `peekChannel` reads the current session count of a channel without
+     * creating a session on the server. Use this when the caller only needs
+     * to display the count (e.g. "N people writing") without contributing to
+     * it and without receiving broadcasts.
+     *
+     * Unlike `attach({ readOnly: true })`, this does not occupy a `Session`
+     * entry on the server, does not generate heartbeat RPCs, and does not
+     * subscribe to channel events. Polling is the caller's responsibility.
+     */
+    peekChannel(channelKey: string): Promise<number>;
     /**
      * `broadcast` broadcasts the given payload to the given topic.
      */
@@ -1997,12 +2034,28 @@ declare class CRDTTree extends CRDTElement implements GCParent {
      * `edit` edits the tree with the given range and content.
      * If the content is undefined, the range will be removed.
      */
-    edit(range: [CRDTTreePos, CRDTTreePos], contents: Array<CRDTTreeNode> | undefined, splitLevel: number, editedAt: TimeTicket, issueTimeTicket: (() => TimeTicket) | undefined, versionVector?: VersionVector): [Array<TreeChange>, Array<GCPair>, DataSize, Array<CRDTTreeNode>, number];
+    edit(range: [CRDTTreePos, CRDTTreePos], contents: Array<CRDTTreeNode> | undefined, splitLevel: number, editedAt: TimeTicket, issueTimeTicket: (() => TimeTicket) | undefined, versionVector?: VersionVector): [
+    Array<TreeChange>,
+    Array<GCPair>,
+    DataSize,
+    Array<CRDTTreeNode>,
+    number,
+    number,
+    Set<string>
+    ];
     /**
      * `editT` edits the given range with the given value.
      * This method uses indexes instead of a pair of TreePos for testing.
      */
-    editT(range: [number, number], contents: Array<CRDTTreeNode> | undefined, splitLevel: number, editedAt: TimeTicket, issueTimeTicket: () => TimeTicket): [Array<TreeChange>, Array<GCPair>, DataSize, Array<CRDTTreeNode>, number];
+    editT(range: [number, number], contents: Array<CRDTTreeNode> | undefined, splitLevel: number, editedAt: TimeTicket, issueTimeTicket: () => TimeTicket): [
+    Array<TreeChange>,
+    Array<GCPair>,
+    DataSize,
+    Array<CRDTTreeNode>,
+    number,
+    number,
+    Set<string>
+    ];
     /**
      * `move` move the given source range to the given target range.
      */
@@ -3035,7 +3088,12 @@ declare class Document_2<R, P extends Indexable = Indexable> implements Attachab
      * `applySnapshot` applies the given snapshot into this document.
      */
     applySnapshot(serverSeq: bigint, snapshotVector: VersionVector, snapshot?: Uint8Array, clientSeq?: number): void;
-    private clearHistory;
+    /**
+     * `clearHistory` flushes both undo and redo stacks. This is used
+     * after applying a snapshot or initialRoot so that setup operations
+     * are not reachable via undo.
+     */
+    clearHistory(): void;
     /**
      * `applyChanges` applies the given changes into this document.
      */
@@ -6005,7 +6063,8 @@ declare interface SubscribeFn<T> {
 }
 
 /**
- * `SyncMode` defines synchronization modes for the PushPullChanges API.
+ * `SyncMode` defines synchronization modes for the PushPullChanges API
+ * (documents) and the RefreshChannel heartbeat (channels).
  */
 export declare enum SyncMode {
     /**
@@ -6024,7 +6083,15 @@ export declare enum SyncMode {
      * `RealtimeSyncOff` mode indicates that changes are not automatically pushed or pulled,
      * but the watch stream is kept active.
      */
-    RealtimeSyncOff = "realtime-syncoff"
+    RealtimeSyncOff = "realtime-syncoff",
+    /**
+     * `Polling` mode runs the sync loop without opening a watch stream.
+     * - For Channel: heartbeat refreshes TTL and brings sessionCount.
+     * - For Document: PushPullChanges runs at the polling interval. Remote
+     *   changes arrive on the next tick (latency = interval). Not suitable
+     *   for collaborative editing — use Realtime for that.
+     */
+    Polling = "polling"
 }
 
 /**