@types/sharedb 1.0.20 → 1.0.24

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: Fri, 30 Jul 2021 20:31:33 GMT
+ * Last updated: Fri, 19 Nov 2021 17:31:08 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,
@@ -219,6 +223,7 @@ declare namespace sharedb {
             readSnapshots: ReadSnapshotsContext;
             receive: ReceiveContext;
             reply: ReplyContext;
+            sendPresence: PresenceContext;
             submit: SubmitContext;
         }
 
@@ -251,16 +256,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 +295,9 @@ declare namespace sharedb {
     }
 }
 
-interface Projection {
-    target: string;
-    fields: ProjectionFields;
+interface ReadonlyProjection {
+    readonly target: Readonly<string>;
+    readonly fields: Readonly<ProjectionFields>;
 }
 
 interface ProjectionFields {
@@ -296,7 +306,7 @@ interface ProjectionFields {
 
 interface SubmitRequest {
     index: string;
-    projection: Projection;
+    projection: ReadonlyProjection;
     collection: string;
     id: string;
     op: sharedb.CreateOp | sharedb.DeleteOp | sharedb.EditOp;
@@ -322,4 +332,17 @@ 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;

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

@@ -9,6 +9,18 @@ export class Connection {
     // ShareDB, but it is handy for server-side only user code that may cache
     // state on the agent and read it in middleware
     agent: Agent | null;
+
+    collections: Record<string, Record<string, Doc>>;
+    queries: Record<string, Query>;
+
+    seq: number;
+    id: string | null; // Equals agent.src on the server
+    nextQueryId: number;
+    nextSnapshotRequestId: number;
+
+    state: string;
+    debug: boolean;
+
     close(): void;
     get(collectionName: string, documentID: string): Doc;
     createFetchQuery<T = any>(collectionName: string, query: any, options?: {results?: Array<Doc<T>>} | null, callback?: (err: Error, results: Array<Doc<T>>) => void): Query<T>;
@@ -17,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.20",
+    "version": "1.0.24",
     "description": "TypeScript definitions for sharedb",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/sharedb",
     "license": "MIT",
@@ -40,6 +40,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "3e35c818c257912c461928ea9cade48609a7716ec6e78834e97fc9221e331d32",
-    "typeScriptVersion": "3.6"
+    "typesPublisherContentHash": "31089b496f83294c189f25c4fe77b81644e41e69c380c9aa1b79cbbb645866c7",
+    "typeScriptVersion": "3.8"
 }