@types/sharedb 1.0.21 → 2.2.0

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: Sat, 31 Jul 2021 08:01:15 GMT
+ * Last updated: Wed, 01 Dec 2021 08:01:02 GMT
  * Dependencies: none
  * Global values: none
 

sharedb/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for sharedb 1.0
+// Type definitions for sharedb 2.2
 // Project: https://github.com/share/sharedb
 // Definitions by: Steve Oney <https://github.com/soney>
 //                 Eric Hwang <https://github.com/ericyhwang>
@@ -30,6 +30,11 @@ declare class sharedb extends EventEmitter {
     pubsub: sharedb.PubSub;
     extraDbs: {[extraDbName: string]: sharedb.ExtraDB};
     milestoneDb?: sharedb.MilestoneDB;
+    errorHandler: ErrorHandler;
+
+    readonly projections: {
+        readonly [name: string]: ReadonlyProjection;
+    };
 
     constructor(options?: {
         db?: any,
@@ -38,6 +43,8 @@ declare class sharedb extends EventEmitter {
         milestoneDb?: sharedb.MilestoneDB,
         suppressPublish?: boolean,
         maxSubmitRetries?: number,
+        doNotForwardSendPresenceErrorsToClient?: boolean,
+        errorHandler?: ErrorHandler;
 
         presence?: boolean,
         /**
@@ -218,7 +225,9 @@ declare namespace sharedb {
             query: QueryContext;
             readSnapshots: ReadSnapshotsContext;
             receive: ReceiveContext;
+            receivePresence: PresenceContext;
             reply: ReplyContext;
+            sendPresence: PresenceContext;
             submit: SubmitContext;
         }
 
@@ -251,16 +260,21 @@ declare namespace sharedb {
             op: any;
         }
 
+        interface PresenceContext extends BaseContext {
+            presence: PresenceMessage;
+            collection?: string;
+        }
+
         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 +299,9 @@ declare namespace sharedb {
     }
 }
 
-interface Projection {
-    target: string;
-    fields: ProjectionFields;
+interface ReadonlyProjection {
+    readonly target: Readonly<string>;
+    readonly fields: Readonly<ProjectionFields>;
 }
 
 interface ProjectionFields {
@@ -296,7 +310,7 @@ interface ProjectionFields {
 
 interface SubmitRequest {
     index: string;
-    projection: Projection;
+    projection: ReadonlyProjection;
     collection: string;
     id: string;
     op: sharedb.CreateOp | sharedb.DeleteOp | sharedb.EditOp;
@@ -322,4 +336,22 @@ interface GetOpsOptions {
     };
 }
 
+interface PresenceMessage {
+    a: 'p';
+    ch: string; // channel
+    src: string; // client ID
+    id: string; // presence ID
+    p: any; // presence payload
+    pv: number; // presence version
+    c?: string; // document collection
+    d?: string; // document ID
+    v?: number; // document version
+    t?: string; // document OT type
+}
+
 type BasicCallback = (err?: Error) => void;
+
+type ErrorHandler = (error: Error, context: ErrorHandlerContext) => void;
+interface ErrorHandlerContext {
+    agent?: Agent;
+}

sharedb/lib/agent.d.ts

@@ -16,7 +16,7 @@ export = Agent;
  *
  * @see https://github.com/share/sharedb#class-sharedbagent
  */
-declare class Agent {
+declare class Agent<TCustom = any> {
     backend: ShareDbBackend;
     stream: Duplex & {
         /**
@@ -30,7 +30,7 @@ declare class Agent {
      * given client session. It is in memory only as long as the session is
      * active, and it is passed to each middleware call.
      */
-    custom: any;
+    custom: TCustom;
 
     /**
      * Sends a JSON-compatible message to the client for this agent.

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.21",
+    "version": "2.2.0",
     "description": "TypeScript definitions for sharedb",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sharedb",
     "license": "MIT",
@@ -40,6 +40,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "bee90d8cc90e624482774a71e75ff69ecbccf00bd4ea8b0e6b92050848328b8b",
-    "typeScriptVersion": "3.6"
+    "typesPublisherContentHash": "dad7e36fc031d7a9c0b324db1a345d7056c756cc410f1e22257f26b18d53aa63",
+    "typeScriptVersion": "3.8"
 }