@verdant-web/server 1.7.8 → 1.7.9

package/dist/esm/Server.d.ts

@@ -1,121 +1,121 @@
-/// <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;
-    getLibraryPresence: (libraryId: string) => Record<string, import("@verdant-web/common").UserInfo<any, any>>;
-    /**
-     * 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;
+    getLibraryPresence: (libraryId: string) => Record<string, import("@verdant-web/common").UserInfo<any, any>>;
+    /**
+     * 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;
+}