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

package/dist/cjs/ServerStorage.d.ts

@@ -0,0 +1,35 @@
+import { Database } from 'better-sqlite3';
+import { ClientMessage } from '@lo-fi/common';
+import { MessageSender } from './MessageSender.js';
+import { UserProfiles } from './Profiles.js';
+import { TokenInfo } from './TokenVerifier.js';
+interface ServerStorageOptions {
+    db: Database;
+    sender: MessageSender;
+    profiles: UserProfiles<any>;
+    replicaTruancyMinutes: number;
+    log?: (...args: any[]) => void;
+    disableRebasing?: boolean;
+}
+export declare class ServerStorage {
+    private profileLoader;
+    private libraries;
+    private db;
+    private sender;
+    constructor({ db, sender, profiles, replicaTruancyMinutes, disableRebasing, log, }: ServerStorageOptions);
+    /**
+     * Call with any message from any replica
+     */
+    receive: (libraryId: string, clientKey: string, message: ClientMessage, info: TokenInfo) => Promise<void>;
+    /**
+     * Call when a replica disconnects from the server
+     */
+    remove: (libraryId: string, replicaId: string) => void;
+    evictLibrary: (libraryId: string) => void;
+    evictUser: (libraryId: string, userId: string) => void;
+    private createSchema;
+    close: () => Promise<void>;
+    getLibraryPresence: (libraryId: string) => Record<string, import("@lo-fi/common").UserInfo<any, any>>;
+    getDocumentSnapshot: (libraryId: string, documentId: string) => any;
+}
+export {};

package/dist/cjs/ServerStorage.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerStorage = void 0;
+const ServerLibrary_js_1 = require("./ServerLibrary.js");
+const Profiles_js_1 = require("./Profiles.js");
+const migrations_js_1 = require("./migrations.js");
+class ServerStorage {
+    constructor({ db, sender, profiles, replicaTruancyMinutes, disableRebasing = false, log = () => { }, }) {
+        /**
+         * Call with any message from any replica
+         */
+        this.receive = (libraryId, clientKey, message, info) => {
+            const library = this.libraries.open(libraryId);
+            return library.receive(message, clientKey, info);
+        };
+        /**
+         * Call when a replica disconnects from the server
+         */
+        this.remove = (libraryId, replicaId) => {
+            const library = this.libraries.open(libraryId);
+            library.remove(replicaId);
+        };
+        this.evictLibrary = (libraryId) => {
+            const library = this.libraries.open(libraryId);
+            library.destroy();
+        };
+        this.evictUser = (libraryId, userId) => {
+            const library = this.libraries.open(libraryId);
+            library.evictUser(userId);
+        };
+        this.createSchema = () => {
+            (0, migrations_js_1.migrations)(this.db);
+        };
+        this.close = async () => {
+            this.db.close();
+        };
+        this.getLibraryPresence = (libraryId) => {
+            const library = this.libraries.open(libraryId);
+            return library.getPresence();
+        };
+        this.getDocumentSnapshot = (libraryId, documentId) => {
+            const library = this.libraries.open(libraryId);
+            return library.getDocumentSnapshot(documentId);
+        };
+        this.db = db;
+        this.sender = sender;
+        this.createSchema();
+        this.profileLoader = new Profiles_js_1.UserProfileLoader(profiles);
+        this.libraries = new ServerLibrary_js_1.ServerLibraryManager({
+            db: this.db,
+            sender: this.sender,
+            profileLoader: this.profileLoader,
+            replicaTruancyMinutes,
+            log,
+            disableRebasing,
+        });
+    }
+}
+exports.ServerStorage = ServerStorage;
+//# sourceMappingURL=ServerStorage.js.map

package/dist/cjs/ServerStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ServerStorage.js","sourceRoot":"","sources":["../../src/ServerStorage.ts"],"names":[],"mappings":";;;AAEA,yDAA0D;AAE1D,+CAAgE;AAEhE,mDAA6C;AAW7C,MAAa,aAAa;IAMzB,YAAY,EACX,EAAE,EACF,MAAM,EACN,QAAQ,EACR,qBAAqB,EACrB,eAAe,GAAG,KAAK,EACvB,GAAG,GAAG,GAAG,EAAE,GAAE,CAAC,GACQ;QAevB;;WAEG;QACH,YAAO,GAAG,CACT,SAAiB,EACjB,SAAiB,EACjB,OAAsB,EACtB,IAAe,EACd,EAAE;YACH,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/C,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QAClD,CAAC,CAAC;QAEF;;WAEG;QACH,WAAM,GAAG,CAAC,SAAiB,EAAE,SAAiB,EAAE,EAAE;YACjD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/C,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3B,CAAC,CAAC;QAEF,iBAAY,GAAG,CAAC,SAAiB,EAAE,EAAE;YACpC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/C,OAAO,CAAC,OAAO,EAAE,CAAC;QACnB,CAAC,CAAC;QAEF,cAAS,GAAG,CAAC,SAAiB,EAAE,MAAc,EAAE,EAAE;YACjD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/C,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC3B,CAAC,CAAC;QAEM,iBAAY,GAAG,GAAG,EAAE;YAC3B,IAAA,0BAAU,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACrB,CAAC,CAAC;QAEF,UAAK,GAAG,KAAK,IAAI,EAAE;YAClB,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;QACjB,CAAC,CAAC;QAEF,uBAAkB,GAAG,CAAC,SAAiB,EAAE,EAAE;YAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/C,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC,CAAC;QAEF,wBAAmB,GAAG,CAAC,SAAiB,EAAE,UAAkB,EAAE,EAAE;YAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/C,OAAO,OAAO,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAChD,CAAC,CAAC;QA7DD,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,aAAa,GAAG,IAAI,+BAAiB,CAAC,QAAQ,CAAC,CAAC;QACrD,IAAI,CAAC,SAAS,GAAG,IAAI,uCAAoB,CAAC;YACzC,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,qBAAqB;YACrB,GAAG;YACH,eAAe;SACf,CAAC,CAAC;IACJ,CAAC;CAkDD;AA5ED,sCA4EC"}

package/dist/cjs/TokenProvider.d.ts

@@ -1,16 +1,16 @@
-import { ReplicaType } from '@verdant-web/common';
-export declare class TokenProvider {
-    private config;
-    constructor(config: {
-        secret: string;
-    });
-    getToken: ({ userId, libraryId, syncEndpoint, role, type, expiresIn, fileEndpoint, }: {
-        userId: string;
-        libraryId: string;
-        syncEndpoint: string;
-        fileEndpoint?: string | undefined;
-        role?: string | undefined;
-        type?: ReplicaType | undefined;
-        expiresIn?: string | number | undefined;
-    }) => string;
-}
+import { ReplicaType } from '@verdant-web/common';
+export declare class TokenProvider {
+    private config;
+    constructor(config: {
+        secret: string;
+    });
+    getToken: ({ userId, libraryId, syncEndpoint, role, type, expiresIn, fileEndpoint, }: {
+        userId: string;
+        libraryId: string;
+        syncEndpoint: string;
+        fileEndpoint?: string | undefined;
+        role?: string | undefined;
+        type?: ReplicaType | undefined;
+        expiresIn?: string | number | undefined;
+    }) => string;
+}

package/dist/cjs/TokenProvider.js

@@ -1,27 +1,27 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokenProvider = void 0;
-const common_1 = require("@verdant-web/common");
-const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
-class TokenProvider {
-    constructor(config) {
-        this.config = config;
-        this.getToken = ({ userId, libraryId, syncEndpoint, role, type = common_1.ReplicaType.Realtime, expiresIn = '1d', fileEndpoint, }) => {
-            return jsonwebtoken_1.default.sign({
-                sub: userId,
-                lib: libraryId,
-                url: syncEndpoint,
-                file: fileEndpoint,
-                role,
-                type,
-            }, this.config.secret, {
-                expiresIn,
-            });
-        };
-    }
-}
-exports.TokenProvider = TokenProvider;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenProvider = void 0;
+const common_1 = require("@verdant-web/common");
+const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+class TokenProvider {
+    constructor(config) {
+        this.config = config;
+        this.getToken = ({ userId, libraryId, syncEndpoint, role, type = common_1.ReplicaType.Realtime, expiresIn = '1d', fileEndpoint, }) => {
+            return jsonwebtoken_1.default.sign({
+                sub: userId,
+                lib: libraryId,
+                url: syncEndpoint,
+                file: fileEndpoint,
+                role,
+                type,
+            }, this.config.secret, {
+                expiresIn,
+            });
+        };
+    }
+}
+exports.TokenProvider = TokenProvider;
 //# sourceMappingURL=TokenProvider.js.map

package/dist/cjs/TokenVerifier.d.ts

@@ -1,16 +1,16 @@
-import { ReplicaType } from '@verdant-web/common';
-export declare class TokenVerifier {
-    private config;
-    constructor(config: {
-        secret: string;
-    });
-    verifyToken: (token: string) => TokenInfo;
-}
-export interface TokenInfo {
-    userId: string;
-    libraryId: string;
-    syncEndpoint: string;
-    role?: string;
-    type: ReplicaType;
-    token: string;
-}
+import { ReplicaType } from '@verdant-web/common';
+export declare class TokenVerifier {
+    private config;
+    constructor(config: {
+        secret: string;
+    });
+    verifyToken: (token: string) => TokenInfo;
+}
+export interface TokenInfo {
+    userId: string;
+    libraryId: string;
+    syncEndpoint: string;
+    role?: string;
+    type: ReplicaType;
+    token: string;
+}

package/dist/cjs/TokenVerifier.js

@@ -1,29 +1,29 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokenVerifier = void 0;
-const common_1 = require("@verdant-web/common");
-const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
-class TokenVerifier {
-    constructor(config) {
-        this.config = config;
-        this.verifyToken = (token) => {
-            const decoded = jsonwebtoken_1.default.verify(token, this.config.secret, {
-                complete: false,
-            });
-            (0, common_1.assert)(decoded.sub);
-            return {
-                userId: decoded.sub,
-                libraryId: decoded.lib,
-                syncEndpoint: decoded.url,
-                role: decoded.role,
-                type: decoded.type,
-                token,
-            };
-        };
-    }
-}
-exports.TokenVerifier = TokenVerifier;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TokenVerifier = void 0;
+const common_1 = require("@verdant-web/common");
+const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+class TokenVerifier {
+    constructor(config) {
+        this.config = config;
+        this.verifyToken = (token) => {
+            const decoded = jsonwebtoken_1.default.verify(token, this.config.secret, {
+                complete: false,
+            });
+            (0, common_1.assert)(decoded.sub);
+            return {
+                userId: decoded.sub,
+                libraryId: decoded.lib,
+                syncEndpoint: decoded.url,
+                role: decoded.role,
+                type: decoded.type,
+                token,
+            };
+        };
+    }
+}
+exports.TokenVerifier = TokenVerifier;
 //# sourceMappingURL=TokenVerifier.js.map

package/dist/cjs/files/FileMetadata.d.ts

@@ -1,28 +1,28 @@
-import { Database } from 'better-sqlite3';
-import { FileInfo } from './FileStorage.js';
-export interface FileMetadataConfig {
-    deleteExpirationDays?: number;
-}
-export declare class FileMetadata {
-    private db;
-    private deleteExpirationDays;
-    constructor(db: Database, { deleteExpirationDays }?: FileMetadataConfig);
-    get: (libraryId: string, fileId: string) => {
-        libraryId: string;
-        fileId: string;
-        name: string;
-        type: string;
-    };
-    getAll: (libraryId: string) => any[];
-    deleteAll: (libraryId: string) => import("better-sqlite3").RunResult;
-    put: (libraryId: string, fileInfo: FileInfo) => import("better-sqlite3").RunResult;
-    markPendingDelete: (libraryId: string, fileId: string) => import("better-sqlite3").RunResult;
-    delete: (libraryId: string, fileId: string) => import("better-sqlite3").RunResult;
-    getPendingDeletes: (libraryId: string) => {
-        libraryId: string;
-        fileId: string;
-        name: string;
-        type: string;
-        pendingDeleteAt: number;
-    }[];
-}
+import { Database } from 'better-sqlite3';
+import { FileInfo } from './FileStorage.js';
+export interface FileMetadataConfig {
+    deleteExpirationDays?: number;
+}
+export declare class FileMetadata {
+    private db;
+    private deleteExpirationDays;
+    constructor(db: Database, { deleteExpirationDays }?: FileMetadataConfig);
+    get: (libraryId: string, fileId: string) => {
+        libraryId: string;
+        fileId: string;
+        name: string;
+        type: string;
+    };
+    getAll: (libraryId: string) => any[];
+    deleteAll: (libraryId: string) => import("better-sqlite3").RunResult;
+    put: (libraryId: string, fileInfo: FileInfo) => import("better-sqlite3").RunResult;
+    markPendingDelete: (libraryId: string, fileId: string) => import("better-sqlite3").RunResult;
+    delete: (libraryId: string, fileId: string) => import("better-sqlite3").RunResult;
+    getPendingDeletes: (libraryId: string) => {
+        libraryId: string;
+        fileId: string;
+        name: string;
+        type: string;
+        pendingDeleteAt: number;
+    }[];
+}

package/dist/cjs/files/FileMetadata.js

@@ -1,69 +1,69 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileMetadata = void 0;
-class FileMetadata {
-    constructor(db, { deleteExpirationDays = 1 } = {}) {
-        this.db = db;
-        this.deleteExpirationDays = 1;
-        this.get = (libraryId, fileId) => {
-            return this.db
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileMetadata = void 0;
+class FileMetadata {
+    constructor(db, { deleteExpirationDays = 1 } = {}) {
+        this.db = db;
+        this.deleteExpirationDays = 1;
+        this.get = (libraryId, fileId) => {
+            return this.db
                 .prepare(`
       SELECT * FROM FileMetadata
       WHERE libraryId = ? AND fileId = ?
-    `)
-                .get(libraryId, fileId);
-        };
-        this.getAll = (libraryId) => {
-            return this.db
+    `)
+                .get(libraryId, fileId);
+        };
+        this.getAll = (libraryId) => {
+            return this.db
                 .prepare(`
 			SELECT * FROM FileMetadata
 			WHERE libraryId = ?
-		`)
-                .all(libraryId);
-        };
-        this.deleteAll = (libraryId) => {
-            return this.db
+		`)
+                .all(libraryId);
+        };
+        this.deleteAll = (libraryId) => {
+            return this.db
                 .prepare(`
 			DELETE FROM FileMetadata
 			WHERE libraryId = ?
-		`)
-                .run(libraryId);
-        };
-        this.put = (libraryId, fileInfo) => {
-            return this.db
+		`)
+                .run(libraryId);
+        };
+        this.put = (libraryId, fileInfo) => {
+            return this.db
                 .prepare(`
       INSERT OR REPLACE INTO FileMetadata (libraryId, fileId, name, type)
       VALUES (?, ?, ?, ?)
-    `)
-                .run(libraryId, fileInfo.id, fileInfo.fileName, fileInfo.type);
-        };
-        this.markPendingDelete = (libraryId, fileId) => {
-            return this.db
+    `)
+                .run(libraryId, fileInfo.id, fileInfo.fileName, fileInfo.type);
+        };
+        this.markPendingDelete = (libraryId, fileId) => {
+            return this.db
                 .prepare(`
 					UPDATE FileMetadata
 					SET pendingDeleteAt = ?
 					WHERE libraryId = ? AND fileId = ?
-				`)
-                .run(Date.now(), libraryId, fileId);
-        };
-        this.delete = (libraryId, fileId) => {
-            return this.db
+				`)
+                .run(Date.now(), libraryId, fileId);
+        };
+        this.delete = (libraryId, fileId) => {
+            return this.db
                 .prepare(`
       DELETE FROM FileMetadata
       WHERE libraryId = ? AND fileId = ?
-    `)
-                .run(libraryId, fileId);
-        };
-        this.getPendingDeletes = (libraryId) => {
-            return this.db
+    `)
+                .run(libraryId, fileId);
+        };
+        this.getPendingDeletes = (libraryId) => {
+            return this.db
                 .prepare(`
 					SELECT * FROM FileMetadata
 					WHERE libraryId = ? AND pendingDeleteAt < ?
-				`)
-                .all(libraryId, Date.now() - 1000 * 60 * 60 * 24 * this.deleteExpirationDays);
-        };
-        this.deleteExpirationDays = deleteExpirationDays;
-    }
-}
-exports.FileMetadata = FileMetadata;
+				`)
+                .all(libraryId, Date.now() - 1000 * 60 * 60 * 24 * this.deleteExpirationDays);
+        };
+        this.deleteExpirationDays = deleteExpirationDays;
+    }
+}
+exports.FileMetadata = FileMetadata;
 //# sourceMappingURL=FileMetadata.js.map

package/dist/cjs/files/FileStorage.d.ts

@@ -1,35 +1,35 @@
-/// <reference types="node" resolution-mode="require"/>
-import { Readable } from 'stream';
-export interface FileInfo {
-    fileName: string;
-    id: string;
-    libraryId: string;
-    type: string;
-}
-/**
- * The interface for implementing a file storage backend.
- * verdant will supply file Blobs and metadata, and the storage backend
- * must store them somewhere.
- *
- * The storage backend must also provide a way to get a URL for the file,
- * even if the file is not yet uploaded, based on its metadata.
- */
-export interface FileStorage {
-    put(fileStream: Readable, data: FileInfo): Promise<void>;
-    getUrl(data: FileInfo): string | Promise<string>;
-    delete(data: FileInfo): Promise<void>;
-}
-export declare class LocalFileStorage implements FileStorage {
-    private readonly host;
-    private readonly rootDirectory;
-    constructor({ rootDirectory, host, }: {
-        rootDirectory: string;
-        host: string;
-    });
-    private prepareHost;
-    put(fileStream: Readable, data: FileInfo): Promise<void>;
-    getUrl(data: FileInfo): string;
-    delete(data: FileInfo): Promise<void>;
-    private getPath;
-    private getStorageLocation;
-}
+/// <reference types="node" resolution-mode="require"/>
+import { Readable } from 'stream';
+export interface FileInfo {
+    fileName: string;
+    id: string;
+    libraryId: string;
+    type: string;
+}
+/**
+ * The interface for implementing a file storage backend.
+ * verdant will supply file Blobs and metadata, and the storage backend
+ * must store them somewhere.
+ *
+ * The storage backend must also provide a way to get a URL for the file,
+ * even if the file is not yet uploaded, based on its metadata.
+ */
+export interface FileStorage {
+    put(fileStream: Readable, data: FileInfo): Promise<void>;
+    getUrl(data: FileInfo): string | Promise<string>;
+    delete(data: FileInfo): Promise<void>;
+}
+export declare class LocalFileStorage implements FileStorage {
+    private readonly host;
+    private readonly rootDirectory;
+    constructor({ rootDirectory, host, }: {
+        rootDirectory: string;
+        host: string;
+    });
+    private prepareHost;
+    put(fileStream: Readable, data: FileInfo): Promise<void>;
+    getUrl(data: FileInfo): string;
+    delete(data: FileInfo): Promise<void>;
+    private getPath;
+    private getStorageLocation;
+}