@verdant-web/server 1.8.13 → 1.8.14-next.1

package/dist/cjs/Replicas.js

@@ -1,133 +1,133 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReplicaInfos = void 0;
-class ReplicaInfos {
-    constructor(db, replicaTruancyMinutes) {
-        this.db = db;
-        this.replicaTruancyMinutes = replicaTruancyMinutes;
-        this.get = (libraryId, replicaId) => {
-            const row = this.db
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReplicaInfos = void 0;
+class ReplicaInfos {
+    constructor(db, replicaTruancyMinutes) {
+        this.db = db;
+        this.replicaTruancyMinutes = replicaTruancyMinutes;
+        this.get = (libraryId, replicaId) => {
+            const row = this.db
                 .prepare(`
 					SELECT * FROM ReplicaInfo
 					WHERE id = ? AND libraryId = ?
-				`)
-                .get(replicaId, libraryId);
-            if (!row) {
-                return null;
-            }
-            return {
-                id: row.id,
-                libraryId: row.libraryId,
-                clientId: row.clientId,
-                lastSeenWallClockTime: row.lastSeenWallClockTime,
-                ackedLogicalTime: row.ackedLogicalTime,
-                type: row.type,
-                ackedServerOrder: row.ackedServerOrder,
-            };
-        };
-        this.getOrCreate = (libraryId, replicaId, info) => {
-            const replicaInfo = this.db
+				`)
+                .get(replicaId, libraryId);
+            if (!row) {
+                return null;
+            }
+            return {
+                id: row.id,
+                libraryId: row.libraryId,
+                clientId: row.clientId,
+                lastSeenWallClockTime: row.lastSeenWallClockTime,
+                ackedLogicalTime: row.ackedLogicalTime,
+                type: row.type,
+                ackedServerOrder: row.ackedServerOrder,
+            };
+        };
+        this.getOrCreate = (libraryId, replicaId, info) => {
+            const replicaInfo = this.db
                 .prepare(`
 			SELECT * FROM ReplicaInfo
 			WHERE id = ? AND libraryId = ?
-			`)
-                .get(replicaId, libraryId);
-            if (!replicaInfo) {
-                this.db
+			`)
+                .get(replicaId, libraryId);
+            if (!replicaInfo) {
+                this.db
                     .prepare(`
 			INSERT INTO ReplicaInfo (id, clientId, libraryId, type)
 			VALUES (?, ?, ?, ?)
-			`)
-                    .run(replicaId, info.userId, libraryId, info.type);
-                return {
-                    status: 'new',
-                    replicaInfo: {
-                        id: replicaId,
-                        clientId: info.userId,
-                        ackedLogicalTime: null,
-                        lastSeenWallClockTime: null,
-                        libraryId: libraryId,
-                        type: info.type,
-                        ackedServerOrder: 0,
-                    },
-                };
-            }
-            if (replicaInfo.type !== info.type) {
-                // type should be updated if a new token changes it
-                this.db
+			`)
+                    .run(replicaId, info.userId, libraryId, info.type);
+                return {
+                    status: 'new',
+                    replicaInfo: {
+                        id: replicaId,
+                        clientId: info.userId,
+                        ackedLogicalTime: null,
+                        lastSeenWallClockTime: null,
+                        libraryId: libraryId,
+                        type: info.type,
+                        ackedServerOrder: 0,
+                    },
+                };
+            }
+            if (replicaInfo.type !== info.type) {
+                // type should be updated if a new token changes it
+                this.db
                     .prepare(`
 					UPDATE ReplicaInfo
 					SET type = ?
 					WHERE id = ? AND libraryId = ?
-					`)
-                    .run(info.type, replicaId, libraryId);
-            }
-            if (replicaInfo.clientId !== info.userId) {
-                throw new Error(`Replica ${replicaId} already exists with a different user ID`);
-            }
-            if (replicaInfo.lastSeenWallClockTime &&
-                replicaInfo.lastSeenWallClockTime < this.truantCutoff) {
-                return {
-                    status: 'truant',
-                    replicaInfo,
-                };
-            }
-            return {
-                status: 'existing',
-                replicaInfo,
-            };
-        };
-        this.getAllNonTruant = (libraryId) => {
-            return this.db
+					`)
+                    .run(info.type, replicaId, libraryId);
+            }
+            if (replicaInfo.clientId !== info.userId) {
+                throw new Error(`Replica ${replicaId} already exists with a different user ID`);
+            }
+            if (replicaInfo.lastSeenWallClockTime &&
+                replicaInfo.lastSeenWallClockTime < this.truantCutoff) {
+                return {
+                    status: 'truant',
+                    replicaInfo,
+                };
+            }
+            return {
+                status: 'existing',
+                replicaInfo,
+            };
+        };
+        this.getAllNonTruant = (libraryId) => {
+            return this.db
                 .prepare(`
 			SELECT * FROM ReplicaInfo
 			WHERE libraryId = ? AND lastSeenWallClockTime > ?
-		`)
-                .all(libraryId, this.truantCutoff);
-        };
-        this.getAll = (libraryId) => {
-            return this.db
+		`)
+                .all(libraryId, this.truantCutoff);
+        };
+        this.getAll = (libraryId) => {
+            return this.db
                 .prepare(`
 			SELECT * FROM ReplicaInfo
 			WHERE libraryId = ?
-		`)
-                .all(libraryId);
-        };
-        this.updateLastSeen = (libraryId, replicaId) => {
-            const clockTime = new Date().getTime();
-            return this.db
+		`)
+                .all(libraryId);
+        };
+        this.updateLastSeen = (libraryId, replicaId) => {
+            const clockTime = new Date().getTime();
+            return this.db
                 .prepare(`
       UPDATE ReplicaInfo
       SET lastSeenWallClockTime = ?
       WHERE id = ? AND libraryId = ?
-    `)
-                .run(clockTime, replicaId, libraryId);
-        };
-        this.updateAcknowledged = (libraryId, replicaId, timestamp) => {
-            this.db
+    `)
+                .run(clockTime, replicaId, libraryId);
+        };
+        this.updateAcknowledged = (libraryId, replicaId, timestamp) => {
+            this.db
                 .prepare(`
 			UPDATE ReplicaInfo
 			SET ackedLogicalTime = ?
 			WHERE id = ? AND libraryId = ?
-		`)
-                .run(timestamp, replicaId, libraryId);
-        };
-        this.updateServerOrder = (libraryId, replicaId, serverOrder) => {
-            // only increment the server order, never set it to lower than before
-            this.db
+		`)
+                .run(timestamp, replicaId, libraryId);
+        };
+        this.updateServerOrder = (libraryId, replicaId, serverOrder) => {
+            // only increment the server order, never set it to lower than before
+            this.db
                 .prepare(`
 			UPDATE ReplicaInfo
 			SET ackedServerOrder = MAX(ackedServerOrder, ?)
 			WHERE id = ? AND libraryId = ?
-		`)
-                .run(serverOrder, replicaId, libraryId);
-        };
-        this.acknowledgeOperation = (libraryId, replicaId, timestamp) => {
-            if (!timestamp)
-                return;
-            // get the server order from the operation with the timestamp and update the replica's server order
-            // to the max of the current server order and the server order of the operation
-            this.db
+		`)
+                .run(serverOrder, replicaId, libraryId);
+        };
+        this.acknowledgeOperation = (libraryId, replicaId, timestamp) => {
+            if (!timestamp)
+                return;
+            // get the server order from the operation with the timestamp and update the replica's server order
+            // to the max of the current server order and the server order of the operation
+            this.db
                 .prepare(`
 			UPDATE ReplicaInfo
 			SET ackedLogicalTime = ?, ackedServerOrder = MAX(ackedServerOrder, COALESCE((
@@ -135,48 +135,48 @@ class ReplicaInfos {
 				WHERE libraryId = ? AND timestamp = ?
 			), 0))
 			WHERE id = ? AND libraryId = ?
-			`)
-                .run(timestamp, libraryId, timestamp, replicaId, libraryId);
-        };
-        this.getGlobalAck = (libraryId, onlineReplicaIds) => {
-            const nonTruant = this.getAllNonTruant(libraryId);
-            const globalAckEligible = nonTruant.filter((replica) => replica.type < 2 || (onlineReplicaIds === null || onlineReplicaIds === void 0 ? void 0 : onlineReplicaIds.includes(replica.id)));
-            // get the earliest acked time
-            return globalAckEligible.reduce((acc, replica) => {
-                if (!replica.ackedLogicalTime) {
-                    return acc;
-                }
-                if (acc === undefined) {
-                    return replica.ackedLogicalTime;
-                }
-                return acc < replica.ackedLogicalTime ? acc : replica.ackedLogicalTime;
-            }, undefined);
-        };
-        this.delete = (libraryId, replicaId) => {
-            return this.db
+			`)
+                .run(timestamp, libraryId, timestamp, replicaId, libraryId);
+        };
+        this.getGlobalAck = (libraryId, onlineReplicaIds) => {
+            const nonTruant = this.getAllNonTruant(libraryId);
+            const globalAckEligible = nonTruant.filter((replica) => replica.type < 2 || (onlineReplicaIds === null || onlineReplicaIds === void 0 ? void 0 : onlineReplicaIds.includes(replica.id)));
+            // get the earliest acked time
+            return globalAckEligible.reduce((acc, replica) => {
+                if (!replica.ackedLogicalTime) {
+                    return acc;
+                }
+                if (acc === undefined) {
+                    return replica.ackedLogicalTime;
+                }
+                return acc < replica.ackedLogicalTime ? acc : replica.ackedLogicalTime;
+            }, undefined);
+        };
+        this.delete = (libraryId, replicaId) => {
+            return this.db
                 .prepare(`
 			DELETE FROM ReplicaInfo
 			WHERE id = ? AND libraryId = ?
-		`)
-                .run(replicaId, libraryId);
-        };
-        this.deleteAll = (libraryId) => {
-            return this.db
+		`)
+                .run(replicaId, libraryId);
+        };
+        this.deleteAll = (libraryId) => {
+            return this.db
                 .prepare(`
 			DELETE FROM ReplicaInfo
 			WHERE libraryId = ?
-		`)
-                .run(libraryId);
-        };
-        this.deleteAllForUser = (libraryId, userId) => {
-            return this.db
-                .prepare(`DELETE FROM ReplicaInfo WHERE libraryId = ? AND clientId = ?`)
-                .run(libraryId, userId);
-        };
-    }
-    get truantCutoff() {
-        return Date.now() - this.replicaTruancyMinutes * 60 * 1000;
-    }
-}
-exports.ReplicaInfos = ReplicaInfos;
+		`)
+                .run(libraryId);
+        };
+        this.deleteAllForUser = (libraryId, userId) => {
+            return this.db
+                .prepare(`DELETE FROM ReplicaInfo WHERE libraryId = ? AND clientId = ?`)
+                .run(libraryId, userId);
+        };
+    }
+    get truantCutoff() {
+        return Date.now() - this.replicaTruancyMinutes * 60 * 1000;
+    }
+}
+exports.ReplicaInfos = ReplicaInfos;
 //# sourceMappingURL=Replicas.js.map

package/dist/cjs/Server.d.ts

@@ -1,143 +1,143 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-import { DocumentBaseline, Operation, ServerMessage } from '@verdant-web/common';
-import EventEmitter from 'events';
-import { IncomingMessage, Server as HttpServer, ServerResponse } from 'http';
-import { UserProfiles } from './Profiles.js';
-import { MessageSender } from './MessageSender.js';
-import { TokenInfo } from './TokenVerifier.js';
-import { FileStorage } from './files/FileStorage.js';
-import { FileMetadataConfig } from './files/FileMetadata.js';
-export interface ServerOptions {
-    /**
-     * Attach to a pre-existing HTTP server. Provide this if you have another server,
-     * like an Express server, that you want to add lofi to. If provided, you don't
-     * need to call .listen()
-     */
-    httpServer?: HttpServer;
-    /**
-     * The secret value used to generate tokens from your authentication endpoint.
-     * Used to verify and decode user identity and library access on connection.
-     */
-    tokenSecret: string;
-    /**
-     * The path to your SQLite database.
-     */
-    databaseFile: string;
-    /**
-     * Optionally provide an implementation of the UserProfiles interface to look up
-     * static user profile data to use in persistence. This data is considered trusted
-     * and can be used to identify users with information like name or profile image.
-     */
-    profiles?: UserProfiles<any>;
-    /**
-     * How many minutes of inactivity before a replica is considered truant and
-     * removed from the library. Defaults to 30 days.
-     */
-    replicaTruancyMinutes?: number;
-    /**
-     * Supply a logging function to log debug messages.
-     */
-    log?: (...args: any[]) => void;
-    /**
-     * Disable history compaction. Storage usage will grow indefinitely. Not recommended.
-     */
-    disableRebasing?: boolean;
-    /**
-     * Provide a FileStorage backend to accept file uploads. Without a file backend,
-     * users will not be able to synchronize files, and all files added on peer replicas
-     * will be forever unavailable.
-     *
-     * A default, filesystem-backed FileStorage implementation is provided as an export
-     * of this library.
-     */
-    fileStorage?: FileStorage;
-    fileConfig?: FileMetadataConfig;
-}
-export interface ServerEvents {
-    error: (err: any) => void;
-    warning: (msg: string, ...args: any[]) => void;
-    changes: (info: Omit<TokenInfo, 'token'>, operations: Operation[], baselines: DocumentBaseline[]) => void;
-    request: (info: TokenInfo) => void;
-    'socket-close': (info: TokenInfo) => void;
-    'socket-connection': (info: TokenInfo) => void;
-}
-export declare interface Server {
-    on<Event extends keyof ServerEvents>(ev: Event, cb: ServerEvents[Event]): this;
-    off<Event extends keyof ServerEvents>(ev: Event, cb: ServerEvents[Event]): this;
-    emit<Event extends keyof ServerEvents>(ev: Event, ...args: Parameters<ServerEvents[Event]>): boolean;
-}
-export declare class Server extends EventEmitter implements MessageSender {
-    readonly httpServer: HttpServer;
-    private wss;
-    private fileStorage?;
-    private fileMetadata;
-    private library;
-    private clientConnections;
-    private keepalives;
-    private tokenVerifier;
-    private connectionToReplicaIdMap;
-    private log;
-    private __testMode;
-    constructor(options: ServerOptions);
-    private authorizeRequest;
-    private getRequestToken;
-    private internalServerHandleRequest;
-    handleRequest: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
-    /**
-     * Handles a multipart upload of a file from a verdant client. The upload
-     * will include parameters for the file's ID, name, and type. The request
-     * must be authenticated with a token to tie it to a library.
-     */
-    handleFileRequest: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
-    broadcast: (libraryId: string, message: ServerMessage, omitKeys?: string[]) => void;
-    send: (libraryId: string, key: string, message: ServerMessage) => void;
-    private handleMessage;
-    private handleConnection;
-    listen: (handle: any, listeningListener?: (() => void) | undefined) => void;
-    close: () => Promise<void>;
-    /**
-     * Completely remove a library from the server.
-     * This will remove all data associated with the library.
-     * Use it very carefully! Data will still be stored on user
-     * devices, so this is not as scary as it sounds - the next time
-     * any replica connects, it will repopulate the library. But
-     * you should still be careful.
-     */
-    evictLibrary: (libraryId: string) => void;
-    /**
-     * Returns currently connected replica info for a library
-     */
-    getLibraryPresence: (libraryId: string) => Record<string, import("@verdant-web/common").UserInfo<any, any>>;
-    /**
-     * Returns helpful information about a library.
-     * This is currently only the known replicas and some
-     * more low-level metadata.
-     */
-    getLibraryInfo: (libraryId: string) => Promise<{
-        replicas: {
-            id: string;
-            ackedLogicalTime: string | null;
-            ackedServerOrder: number;
-            type: import("@verdant-web/common").ReplicaType;
-            truant: boolean | 0 | null;
-            profile: any;
-        }[];
-        latestServerOrder: number;
-        operationsCount: number;
-        baselinesCount: number;
-        globalAck: string | undefined;
-    }>;
-    /**
-     * Removes all replicas associated with a User ID from
-     * the server. Consistency algorithms will no longer wait on these
-     * replicas before confirming and squashing changes.
-     */
-    evictUser: (libraryId: string, userId: string) => void;
-    /**
-     * Retrieves a snapshot of the full document contents at this time.
-     * Useful for capturing the shape of data for static usage outside
-     * of the live system.
-     */
-    getDocumentSnapshot: (libraryId: string, collection: string, documentId: string) => any;
-}
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { DocumentBaseline, Operation, ServerMessage } from '@verdant-web/common';
+import EventEmitter from 'events';
+import { IncomingMessage, Server as HttpServer, ServerResponse } from 'http';
+import { UserProfiles } from './Profiles.js';
+import { MessageSender } from './MessageSender.js';
+import { TokenInfo } from './TokenVerifier.js';
+import { FileStorage } from './files/FileStorage.js';
+import { FileMetadataConfig } from './files/FileMetadata.js';
+export interface ServerOptions {
+    /**
+     * Attach to a pre-existing HTTP server. Provide this if you have another server,
+     * like an Express server, that you want to add lofi to. If provided, you don't
+     * need to call .listen()
+     */
+    httpServer?: HttpServer;
+    /**
+     * The secret value used to generate tokens from your authentication endpoint.
+     * Used to verify and decode user identity and library access on connection.
+     */
+    tokenSecret: string;
+    /**
+     * The path to your SQLite database.
+     */
+    databaseFile: string;
+    /**
+     * Optionally provide an implementation of the UserProfiles interface to look up
+     * static user profile data to use in persistence. This data is considered trusted
+     * and can be used to identify users with information like name or profile image.
+     */
+    profiles?: UserProfiles<any>;
+    /**
+     * How many minutes of inactivity before a replica is considered truant and
+     * removed from the library. Defaults to 30 days.
+     */
+    replicaTruancyMinutes?: number;
+    /**
+     * Supply a logging function to log debug messages.
+     */
+    log?: (...args: any[]) => void;
+    /**
+     * Disable history compaction. Storage usage will grow indefinitely. Not recommended.
+     */
+    disableRebasing?: boolean;
+    /**
+     * Provide a FileStorage backend to accept file uploads. Without a file backend,
+     * users will not be able to synchronize files, and all files added on peer replicas
+     * will be forever unavailable.
+     *
+     * A default, filesystem-backed FileStorage implementation is provided as an export
+     * of this library.
+     */
+    fileStorage?: FileStorage;
+    fileConfig?: FileMetadataConfig;
+}
+export interface ServerEvents {
+    error: (err: any) => void;
+    warning: (msg: string, ...args: any[]) => void;
+    changes: (info: Omit<TokenInfo, 'token'>, operations: Operation[], baselines: DocumentBaseline[]) => void;
+    request: (info: TokenInfo) => void;
+    'socket-close': (info: TokenInfo) => void;
+    'socket-connection': (info: TokenInfo) => void;
+}
+export declare interface Server {
+    on<Event extends keyof ServerEvents>(ev: Event, cb: ServerEvents[Event]): this;
+    off<Event extends keyof ServerEvents>(ev: Event, cb: ServerEvents[Event]): this;
+    emit<Event extends keyof ServerEvents>(ev: Event, ...args: Parameters<ServerEvents[Event]>): boolean;
+}
+export declare class Server extends EventEmitter implements MessageSender {
+    readonly httpServer: HttpServer;
+    private wss;
+    private fileStorage?;
+    private fileMetadata;
+    private library;
+    private clientConnections;
+    private keepalives;
+    private tokenVerifier;
+    private connectionToReplicaIdMap;
+    private log;
+    private __testMode;
+    constructor(options: ServerOptions);
+    private authorizeRequest;
+    private getRequestToken;
+    private internalServerHandleRequest;
+    handleRequest: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+    /**
+     * Handles a multipart upload of a file from a verdant client. The upload
+     * will include parameters for the file's ID, name, and type. The request
+     * must be authenticated with a token to tie it to a library.
+     */
+    handleFileRequest: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
+    broadcast: (libraryId: string, message: ServerMessage, omitKeys?: string[]) => void;
+    send: (libraryId: string, key: string, message: ServerMessage) => void;
+    private handleMessage;
+    private handleConnection;
+    listen: (handle: any, listeningListener?: (() => void) | undefined) => void;
+    close: () => Promise<void>;
+    /**
+     * Completely remove a library from the server.
+     * This will remove all data associated with the library.
+     * Use it very carefully! Data will still be stored on user
+     * devices, so this is not as scary as it sounds - the next time
+     * any replica connects, it will repopulate the library. But
+     * you should still be careful.
+     */
+    evictLibrary: (libraryId: string) => void;
+    /**
+     * Returns currently connected replica info for a library
+     */
+    getLibraryPresence: (libraryId: string) => Record<string, import("@verdant-web/common").UserInfo<any, any>>;
+    /**
+     * Returns helpful information about a library.
+     * This is currently only the known replicas and some
+     * more low-level metadata.
+     */
+    getLibraryInfo: (libraryId: string) => Promise<{
+        replicas: {
+            id: string;
+            ackedLogicalTime: string | null;
+            ackedServerOrder: number;
+            type: import("@verdant-web/common").ReplicaType;
+            truant: boolean | 0 | null;
+            profile: any;
+        }[];
+        latestServerOrder: number;
+        operationsCount: number;
+        baselinesCount: number;
+        globalAck: string | undefined;
+    }>;
+    /**
+     * Removes all replicas associated with a User ID from
+     * the server. Consistency algorithms will no longer wait on these
+     * replicas before confirming and squashing changes.
+     */
+    evictUser: (libraryId: string, userId: string) => void;
+    /**
+     * Retrieves a snapshot of the full document contents at this time.
+     * Useful for capturing the shape of data for static usage outside
+     * of the live system.
+     */
+    getDocumentSnapshot: (libraryId: string, collection: string, documentId: string) => any;
+}