@verdant-web/server 3.3.10 → 4.0.0

package/dist/esm/ReplicaKeepaliveTimers.js

@@ -1,27 +0,0 @@
-import { EventSubscriber } from '@verdant-web/common';
-/**
- * A set of timers per-replica which are
- * refreshed whenever the replica sends
- * a message to the server. If a timer expires,
- * the replica is removed from presence. This
- * is a failsafe for socket-based replicas but
- * essential for pull-based replicas.
- */
-export class ReplicaKeepaliveTimers extends EventSubscriber {
-    constructor(timeout = 30 * 1000) {
-        super();
-        this.timeout = timeout;
-        this.timers = new Map();
-        this.refresh = (libraryId, replicaId) => {
-            const existing = this.timers.get(replicaId);
-            if (existing) {
-                clearTimeout(existing);
-            }
-            this.timers.set(replicaId, setTimeout(() => {
-                this.emit('lost', libraryId, replicaId);
-                this.timers.delete(replicaId);
-            }, this.timeout));
-        };
-    }
-}
-//# sourceMappingURL=ReplicaKeepaliveTimers.js.map

package/dist/esm/ReplicaKeepaliveTimers.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ReplicaKeepaliveTimers.js","sourceRoot":"","sources":["../../src/ReplicaKeepaliveTimers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD;;;;;;;GAOG;AACH,MAAM,OAAO,sBAAuB,SAAQ,eAE1C;IAGD,YAAoB,UAAU,EAAE,GAAG,IAAI;QACtC,KAAK,EAAE,CAAC;QADW,YAAO,GAAP,OAAO,CAAY;QAF/B,WAAM,GAAG,IAAI,GAAG,EAA0B,CAAC;QAMnD,YAAO,GAAG,CAAC,SAAiB,EAAE,SAAiB,EAAE,EAAE;YAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;YAC5C,IAAI,QAAQ,EAAE,CAAC;gBACd,YAAY,CAAC,QAAQ,CAAC,CAAC;YACxB,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,GAAG,CACd,SAAS,EACT,UAAU,CAAC,GAAG,EAAE;gBACf,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;gBACxC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC/B,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAChB,CAAC;QACH,CAAC,CAAC;IAfF,CAAC;CAgBD"}

package/dist/esm/Server.d.ts

@@ -1,166 +0,0 @@
-import { DocumentBaseline, FileData, Operation, ServerMessage } from '@verdant-web/common';
-import EventEmitter from 'events';
-import { Server as HttpServer, IncomingMessage, ServerResponse } from 'http';
-import internal from 'stream';
-import { FileStorage } from './files/FileStorage.js';
-import { MessageSender } from './MessageSender.js';
-import { UserProfiles } from './Profiles.js';
-import { StorageFactory } from './storage/Storage.js';
-import { TokenInfo } from './TokenVerifier.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;
-    /**
-     * Your storage implementation. See the sqlStorage export for a built-in
-     * option.
-     */
-    storage: StorageFactory;
-    /**
-     * 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?: {
-        deleteExpirationDays?: number;
-    };
-}
-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 {
-    private httpServer;
-    private wss;
-    private fileStorage?;
-    private storage;
-    private library;
-    private clientConnections;
-    private keepalives;
-    private tokenVerifier;
-    private connectionToReplicaIdMap;
-    private log;
-    private __testMode;
-    constructor(options: ServerOptions);
-    /**
-     * Attaches the Verdant server to an HttpServer instance, which
-     * allows it to handle requests and websockets required for the
-     * Verdant protocol.
-     *
-     * You can pass httpPath = false if you want to handle HTTP requests
-     * yourself, and this will only attach the websocket handling.
-     */
-    attach: (server: HttpServer, options?: {
-        httpPath?: string | false;
-    }) => void;
-    /**
-     * Handles an HTTP upgrade request to a websocket connection.
-     */
-    handleUpgrade: (req: IncomingMessage, socket: internal.Duplex, head: Buffer) => Promise<void>;
-    private authorizeRequest;
-    private getRequestToken;
-    private createInternalRequestHandler;
-    /**
-     * Handles an HTTP request from a verdant client.
-     */
-    handleRequest: (req: IncomingMessage, res: ServerResponse) => Promise<void>;
-    /**
-     * Handles a "fetch" style request. Complement to handleRequest, for servers
-     * that use Request/Response style handlers.
-     */
-    handleFetch: (req: Request) => Promise<Response>;
-    private handleRequestBody;
-    private writeErrorResponse;
-    private getErrorResponse;
-    /**
-     * 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>;
-    /**
-     * Handles a "fetch" style file request. Complement to handleFileRequest,
-     * for servers that use Request/Response style handlers.
-     */
-    handleFileFetch: (req: Request) => Promise<Response>;
-    private getFileStorageOrThrow;
-    private streamIncomingFile;
-    getFileData: (library: string, fileId: string) => Promise<FileData>;
-    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) => Promise<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<import("./types.js").LibraryInfo | null>;
-    /**
-     * 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) => Promise<any>;
-}