@types/sharedb 1.0.22 → 1.0.23

sharedb/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for sharedb (https://github.com/share/sha
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sharedb.
 
 ### Additional Details
- * Last updated: Thu, 07 Oct 2021 13:31:20 GMT
+ * Last updated: Fri, 12 Nov 2021 19:31:24 GMT
  * Dependencies: none
  * Global values: none
 

sharedb/index.d.ts

@@ -31,6 +31,10 @@ declare class sharedb extends EventEmitter {
     extraDbs: {[extraDbName: string]: sharedb.ExtraDB};
     milestoneDb?: sharedb.MilestoneDB;
 
+    readonly projections: {
+        readonly [name: string]: ReadonlyProjection;
+    };
+
     constructor(options?: {
         db?: any,
         pubsub?: sharedb.PubSub,
@@ -254,13 +258,13 @@ declare namespace sharedb {
         interface QueryContext extends BaseContext {
             index: string;
             collection: string;
-            projection: Projection;
+            projection: ReadonlyProjection;
             fields: ProjectionFields;
             channel: string;
             query: any;
             options?: {[key: string]: any};
             db: DB | null;
-            snapshotProjection: Projection | null;
+            snapshotProjection: ReadonlyProjection | null;
         }
 
         interface ReadSnapshotsContext extends BaseContext {
@@ -285,9 +289,9 @@ declare namespace sharedb {
     }
 }
 
-interface Projection {
-    target: string;
-    fields: ProjectionFields;
+interface ReadonlyProjection {
+    readonly target: Readonly<string>;
+    readonly fields: Readonly<ProjectionFields>;
 }
 
 interface ProjectionFields {
@@ -296,7 +300,7 @@ interface ProjectionFields {
 
 interface SubmitRequest {
     index: string;
-    projection: Projection;
+    projection: ReadonlyProjection;
     collection: string;
     id: string;
     op: sharedb.CreateOp | sharedb.DeleteOp | sharedb.EditOp;

sharedb/lib/client.d.ts

@@ -29,6 +29,30 @@ export class Connection {
     fetchSnapshotByTimestamp(collection: string, id: string, timestamp: number, callback: (error: Error, snapshot: ShareDB.Snapshot) => void): void;
     getPresence(channel: string): Presence;
     getDocPresence(collection: string, id: string): Presence;
+
+    /**
+     * Returns whether anything in this client is either:
+     * - In-flight, waiting on a response from the server
+     * - Pending (locally queued)
+     */
+    hasPending(): boolean;
+
+    /**
+     * Invokes the callback once nothing on this client is in-flight or pending.
+     *
+     * @see hasPending
+     */
+    whenNothingPending(callback: () => void): void;
+
+    /**
+     * Manually send a JSON-serializable message to the server.
+     *
+     * WARNING - This is mostly for internal use within sharedb.
+     *
+     * Prefer to use methods like `Doc#submitOp`, `Doc#subscribe`, `Connection#createFetchQuery`,
+     * etc., which will manage the necessary message exchanges.
+     */
+    send(message: Record<string, unknown>): void;
 }
 export type Doc<T = any> = ShareDB.Doc<T>;
 export type Snapshot<T = any> = ShareDB.Snapshot<T>;

sharedb/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/sharedb",
-    "version": "1.0.22",
+    "version": "1.0.23",
     "description": "TypeScript definitions for sharedb",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sharedb",
     "license": "MIT",
@@ -40,6 +40,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "255cd0fdfdcbaed88c729a2071841aac7a11bb5ed47272c972d303615f351959",
+    "typesPublisherContentHash": "0fede5791642ef4d06d6a137afd9968129407dfe2827787900440ef8cb6555a8",
     "typeScriptVersion": "3.7"
 }