leafrelay 0.1.6 → 0.2.0

package/dist/index.d.ts

@@ -1,734 +1,23 @@
-declare const PACKET_TYPES: readonly ["disconnect", "connect", "heartbeat", "message", "json", "event", "ack", "error", "noop"];
-type PacketType = typeof PACKET_TYPES[number];
-interface SocketPacket {
-    type?: PacketType;
-    id?: string;
-    ack?: true | 'data';
-    endpoint?: string;
-    name?: string;
-    args?: unknown[];
-    data?: unknown;
-    ackId?: string;
-    reason?: string;
-    advice?: string;
-}
-interface OverleafRealtimeSocketOptions {
-    origin: string;
-    cookie: string;
-    reconnect?: boolean;
-    reconnectionDelay?: number;
-    reconnectionLimit?: number;
-    maxReconnectionAttempts?: number;
-}
-declare function encodePacket(packet: SocketPacket): string;
-declare function decodePacket(value: string): SocketPacket;
-declare function decodePayload(value: string): SocketPacket[];
-declare class OverleafRealtimeSocket {
-    private readonly options;
-    private readonly events;
-    private readonly endpoint;
-    private readonly origin;
-    private cookie;
-    private socket?;
-    private connected;
-    private explicitlyDisconnected;
-    private reconnectEnabled;
-    private reconnectAttempts;
-    private reconnectTimer?;
-    private inactivityTimer?;
-    private closeTimeoutMs;
-    private acknowledgementId;
-    private readonly acknowledgements;
-    private readonly sendBuffer;
-    readonly io: {
-        reconnect: (enabled: boolean) => void;
-    };
-    constructor(url: string, options: OverleafRealtimeSocketOptions);
-    on(event: string, handler: (...args: any[]) => void): this;
-    once(event: string, handler: (...args: any[]) => void): this;
-    removeListener(event: string, handler: (...args: any[]) => void): this;
-    removeAllListeners(event?: string): this;
-    emit(event: string, ...args: any[]): this;
-    disconnect(): this;
-    private connect;
-    private receive;
-    private handlePacket;
-    private send;
-    private flush;
-    private resetInactivityTimer;
-    private handleClose;
-    private closeSocket;
-    private scheduleReconnect;
-}
-declare const overleafSocketProtocol: {
-    encodePacket: typeof encodePacket;
-    decodePacket: typeof decodePacket;
-    decodePayload: typeof decodePayload;
-};
-
-type FileType = 'doc' | 'file' | 'folder' | 'outputs';
-type FolderKey = 'docs' | 'fileRefs' | 'folders' | 'outputs';
-declare const FolderKeys: Readonly<Record<string, FolderKey>>;
-interface ProjectLinkedFileProvider {
-    provider: 'project_file';
-    source_project_id: string;
-    source_entity_path: string;
-}
-interface UrlLinkedFileProvider {
-    provider: 'url';
-    url: string;
-}
-interface FileEntity {
-    _id: string;
-    name: string;
-    _type?: FileType;
-    readonly?: boolean;
-}
-interface DocumentEntity extends FileEntity {
-    version?: number;
-    mtime?: number;
-    lastVersion?: number;
-    localCache?: string;
-    remoteCache?: string;
-}
-interface FileRefEntity extends FileEntity {
-    linkedFileData: ProjectLinkedFileProvider | UrlLinkedFileProvider | null;
-    created: string;
-}
-interface OutputFileEntity extends FileEntity {
-    path: string;
-    url: string;
-    type: string;
-    build: string;
-}
-interface FolderEntity extends FileEntity {
-    docs: DocumentEntity[];
-    fileRefs: FileRefEntity[];
-    folders: FolderEntity[];
-    outputs?: OutputFileEntity[];
-}
-interface MemberEntity {
-    _id: string;
-    first_name: string;
-    last_name?: string;
-    email: string;
-    privileges?: string;
-    signUpDate?: string;
-}
-interface ProjectSettingsSchema {
-    learnedWords: string[];
-    languages: Array<{
-        code: string;
-        name: string;
-    }>;
-    compilers: Array<{
-        code: string;
-        name: string;
-    }>;
-}
-interface ProjectEntity {
-    _id: string;
-    name: string;
-    rootDoc_id: string;
-    rootFolder: FolderEntity[];
-    publicAccessLevel: string;
-    compiler: string;
-    spellCheckLanguage: string;
-    deletedDocs: Array<{
-        _id: string;
-        name: string;
-        deletedAt: string;
-    }>;
-    members: MemberEntity[];
-    invites: MemberEntity[];
-    owner: MemberEntity;
-    features: Record<string, unknown>;
-    settings: ProjectSettingsSchema;
-}
-
-interface Identity {
-    csrfToken: string;
-    cookies: string;
-}
-interface NewProjectResponseSchema {
-    project_id: string;
-    owner_ref: string;
-    owner: MemberEntity;
-}
-interface CompileResponseSchema {
-    status: 'success' | 'failure' | 'error';
-    compileGroup: string;
-    clsiServerId?: string;
-    pdfDownloadDomain?: string;
-    outputFiles: Array<OutputFileEntity>;
-    stats: {
-        "latexmk-errors": number;
-        "pdf-size": number;
-        "latex-runs": number;
-        "latex-runs-with-errors": number;
-        "latex-runs-0": number;
-        "latex-runs-with-error-0s": number;
-    };
-    timings: {
-        "sync": number;
-        "compile": number;
-        "output": number;
-        "compileE2E": number;
-    };
-    enableHybridPdfDownload: boolean;
-}
-interface SyncPdfResponseSchema {
-    file: string;
-    line: number;
-    column: number;
-}
-interface SyncCodeResponseSchema {
-    pdf: Array<{
-        page: number;
-        h: number;
-        v: number;
-        width: number;
-        height: number;
-    }>;
-}
-interface SnippetItemSchema {
-    meta: string;
-    score: number;
-    caption: string;
-    snippet: string;
-}
-interface MisspellingItemSchema {
-    index: number;
-    suggestions: string[];
-}
-interface MetadataResponseScheme {
-    projectId: string;
-    projectMeta: {
-        [id: string]: {
-            labels: string[];
-            packages: {
-                [K: string]: SnippetItemSchema[];
-            };
-        };
-    };
-}
-interface ProjectPersist {
-    id: string;
-    userId: string;
-    name: string;
-    lastUpdated?: string;
-    lastUpdatedBy?: MemberEntity;
-    source?: 'owner' | 'collaborator' | 'readOnly';
-    accessLevel: 'owner' | 'collaborator' | 'readOnly';
-    archived?: boolean;
-    trashed?: boolean;
-    scm?: any;
-}
-interface ProjectTagsResponseSchema {
-    __v: number;
-    _id: string;
-    name: string;
-    user_id: string;
-    project_ids: string[];
-}
-interface ProjectLabelResponseSchema {
-    id: string;
-    comment: string;
-    version: string;
-    user_id: string;
-    created_at: number;
-    user_display_name?: string;
-}
-interface ProjectUpdateMeta {
-    users: {
-        id: string;
-        first_name: string;
-        last_name?: string;
-        email: string;
-    }[];
-    start_ts: number;
-    end_ts: number;
-}
-interface ProjectHistoryResponseSchema {
-    fromV: number;
-    toV: number;
-    meta: ProjectUpdateMeta;
-    labels: ProjectLabelResponseSchema[];
-    pathnames: string[];
-    project_ops: {
-        add?: {
-            pathname: string;
-        };
-        remove?: {
-            pathname: string;
-        };
-        atV: number;
-    }[];
-}
-interface ProjectUpdateResponseSchema {
-    updates: ProjectHistoryResponseSchema[];
-    nextBeforeTimestamp: number;
-}
-interface ProjectFileDiffResponseSchema {
-    diff: {
-        u?: string;
-        d?: string;
-        i?: string;
-        meta?: ProjectUpdateMeta;
-    }[];
-}
-interface ProjectFileTreeDiffResponseSchema {
-    diff: {
-        pathname: string;
-        newPathname?: string;
-        operation?: 'edited' | 'added' | 'removed' | 'renamed';
-        deletedAtV?: number;
-    }[];
-}
-interface ProjectMessageResponseSchema {
-    id: string;
-    content: string;
-    timestamp: number;
-    user_id: string;
-    user: {
-        id: string;
-        first_name: string;
-        last_name?: string;
-        email: string;
-    };
-    clientId: string;
-}
-interface ResponseSchema {
-    type: 'success' | 'error';
-    statusCode?: number;
-    raw?: ArrayBuffer;
+type ReplicaState = 'starting' | 'syncing' | 'active' | 'paused' | 'stopping' | 'error';
+interface ReplicaStatus {
+    state: ReplicaState;
     message?: string;
-    userInfo?: {
-        userId: string;
-        userEmail: string;
-    };
-    identity?: Identity;
-    projects?: ProjectPersist[];
-    entity?: FileEntity;
-    entities?: {
-        path: string;
-        type: string;
-    }[];
-    compile?: CompileResponseSchema;
-    content?: Uint8Array;
-    syncPdf?: SyncPdfResponseSchema;
-    syncCode?: SyncCodeResponseSchema;
-    meta?: MetadataResponseScheme;
-    misspellings?: MisspellingItemSchema[];
-    tags?: ProjectTagsResponseSchema[];
-    labels?: ProjectLabelResponseSchema[];
-    updates?: ProjectUpdateResponseSchema;
-    diff?: ProjectFileDiffResponseSchema;
-    treeDiff?: ProjectFileTreeDiffResponseSchema;
-    messages?: ProjectMessageResponseSchema[];
-    settings?: ProjectSettingsSchema;
 }
-declare class BaseAPI {
-    private url;
-    private identity?;
-    private historyRequestChain;
-    private lastHistoryRequestAt;
-    private isHistoryRoute;
-    private waitForHistoryRequest;
-    private retryAfterMs;
-    constructor(url: string);
-    private getCsrfToken;
-    private getUserId;
-    _initSocketV0(identity: Identity, query?: string): OverleafRealtimeSocket;
-    passportLogin(email: string, password: string): Promise<ResponseSchema>;
-    cookiesLogin(cookies: string): Promise<ResponseSchema>;
-    updateCookies(identity: Identity): Promise<Identity>;
-    setIdentity(identity: Identity): this;
-    /**
-     * Check if an HTTP error is transient (worth retrying).
-     * Retries on: 5xx server errors, network errors (fetch failures), and 429 rate limiting.
-     */
-    private isTransientError;
-    protected request(type: 'GET' | 'POST' | 'PUT' | 'DELETE', route: string, body?: FormData | object, callback?: (res?: string) => object | undefined, extraHeaders?: object): Promise<ResponseSchema>;
-    protected download(route: string): Promise<Buffer<ArrayBuffer>>;
-    logout(identity: Identity): Promise<ResponseSchema>;
-    userProjectsJson(identity: Identity): Promise<ResponseSchema>;
-    getProjectsJson(identity: Identity): Promise<ResponseSchema>;
-    projectEntitiesJson(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    newProject(identity: Identity, projectName: string, template: 'none' | 'example'): Promise<ResponseSchema>;
-    cloneProject(identity: Identity, projectId: string, projectName: string): Promise<ResponseSchema>;
-    renameProject(identity: Identity, projectId: string, newProjectName: string): Promise<ResponseSchema>;
-    deleteProject(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    archiveProject(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    unarchiveProject(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    trashProject(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    untrashProject(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    getFile(identity: Identity, projectId: string, fileId: string): Promise<{
-        type: string;
-        content: Uint8Array<ArrayBuffer>;
-    }>;
-    addDoc(identity: Identity, projectId: string, parentFolderId: string, filename: string): Promise<ResponseSchema>;
-    uploadFile(identity: Identity, projectId: string, parentFolderId: string, filename: string, fileContent: Uint8Array): Promise<ResponseSchema>;
-    uploadProject(identity: Identity, filename: string, fileContent: Uint8Array): Promise<ResponseSchema>;
-    addFolder(identity: Identity, projectId: string, folderName: string, parentFolderId: string): Promise<ResponseSchema>;
-    deleteEntity(identity: Identity, projectId: string, fileType: FileType, fileId: string): Promise<ResponseSchema>;
-    deleteAuxFiles(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    renameEntity(identity: Identity, projectId: string, entityType: string, entityId: string, name: string): Promise<ResponseSchema>;
-    moveEntity(identity: Identity, projectId: string, entityType: string, entityId: string, newParentFolderId: string): Promise<ResponseSchema>;
-    compile(identity: Identity, projectId: string, rootResourcePath: string | null, draft?: boolean, stopOnFirstError?: boolean): Promise<ResponseSchema>;
-    stopCompile(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    indexAll(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    getMetadata(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    proxyRequestToSpellingApi(identity: Identity, language: string, userId: string, words: string[]): Promise<ResponseSchema>;
-    spellingControllerLearn(identity: Identity, userId: string, word: string): Promise<ResponseSchema>;
-    spellingControllerUnlearn(identity: Identity, word: string): Promise<ResponseSchema>;
-    getProjectSettings(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    updateProjectSettings(identity: Identity, projectId: string, setting: any): Promise<ResponseSchema>;
-    getFileFromClsi(identity: Identity, url: string, compileGroup: string, clsiServerId?: string, pdfDownloadDomain?: string): Promise<{
-        type: string;
-        content: Uint8Array<ArrayBuffer>;
-    }>;
-    /** Download from an absolute URL, optionally including web frontend cookies. */
-    private _downloadAbsolute;
-    proxySyncPdf(identity: Identity, projectId: string, page: number, h: number, v: number, buildId: string): Promise<ResponseSchema>;
-    proxySyncCode(identity: Identity, projectId: string, file: string, line: number, column: number, buildId: string): Promise<ResponseSchema>;
-    getAllTags(identity: Identity): Promise<ResponseSchema>;
-    createTag(identity: Identity, name: string): Promise<ResponseSchema>;
-    renameTag(identity: Identity, tagId: string, name: string): Promise<ResponseSchema>;
-    deleteTag(identity: Identity, tagId: string): Promise<ResponseSchema>;
-    addProjectToTag(identity: Identity, tagId: string, projectId: string): Promise<ResponseSchema>;
-    removeProjectFromTag(identity: Identity, tagId: string, projectId: string): Promise<ResponseSchema>;
-    proxyToHistoryApiAndGetUpdates(identity: Identity, projectId: string, before?: number): Promise<ResponseSchema>;
-    proxyToHistoryApiAndGetFileDiff(identity: Identity, projectId: string, pathname: string, from: number, to: number): Promise<ResponseSchema>;
-    proxyToHistoryApiAndGetFileTreeDiff(identity: Identity, projectId: string, from: number, to: number): Promise<ResponseSchema>;
-    downloadZipOfVersion(identity: Identity, projectId: string, version: number): Promise<{
-        type: string;
-        content: Uint8Array<ArrayBuffer>;
-    }>;
-    getLabels(identity: Identity, projectId: string): Promise<ResponseSchema>;
-    createLabel(identity: Identity, projectId: string, comment: string, version: number): Promise<ResponseSchema>;
-    deleteLabel(identity: Identity, projectId: string, labelId: string): Promise<ResponseSchema>;
-    getMessages(identity: Identity, projectId: string, limit?: number): Promise<ResponseSchema>;
-    sendMessage(identity: Identity, projectId: string, client_id: string, content: string): Promise<ResponseSchema>;
-}
-
-declare class ExtendedBaseAPI extends BaseAPI {
-    refreshLinkedFile(identity: Identity, project_id: string, file_id: string): Promise<ResponseSchema>;
-    createLinkedFile(identity: Identity, project_id: string, parent_folder_id: string, name: string, provider: string, data: any): Promise<ResponseSchema>;
-}
-
-interface UpdateUserSchema {
-    id: string;
-    user_id: string;
-    name: string;
-    email: string;
-    doc_id: string;
-    row: number;
-    column: number;
-    last_updated_at?: number;
-}
-interface OnlineUserSchema {
-    client_age: number;
-    client_id: string;
-    connected: boolean;
-    cursorData?: {
-        column: number;
-        doc_id: string;
-        row: number;
-    };
-    email: string;
-    first_name: string;
-    last_name?: string;
-    last_updated_at: string;
-    user_id: string;
-}
-interface UpdateSchema {
-    doc: string;
-    op?: {
-        p: number;
-        i?: string;
-        d?: string;
-        u?: boolean;
-    }[];
-    v: number;
-    lastV?: number;
-    hash?: string;
-    meta?: {
-        source: string;
-        ts: number;
-        user_id: string;
-    };
-}
-interface EventsHandler {
-    onFileCreated?: (parentFolderId: string, type: FileType, entity: FileEntity) => void;
-    onFileRenamed?: (entityId: string, newName: string) => void;
-    onFileRemoved?: (entityId: string) => void;
-    onFileMoved?: (entityId: string, newParentFolderId: string) => void;
-    onFileChanged?: (update: UpdateSchema) => void;
-    onDisconnected?: () => void;
-    onConnectionAccepted?: (publicId: string) => void;
-    onClientUpdated?: (user: UpdateUserSchema) => void;
-    onClientDisconnected?: (id: string) => void;
-    onReceivedMessage?: (message: ProjectMessageResponseSchema) => void;
-    onSpellCheckLanguageUpdated?: (language: string) => void;
-    onCompilerUpdated?: (compiler: string) => void;
-    onRootDocUpdated?: (rootDocId: string) => void;
-}
-type ConnectionScheme = 'Alt' | 'realtime';
-type AlternativeSocketFactory = (url: string, api: BaseAPI, identity: Identity, projectId: string, record: Promise<ProjectEntity>) => any;
-declare class SocketIOAPI {
-    private url;
-    private readonly api;
-    private readonly identity;
-    private readonly projectId;
-    private static alternativeSocketFactory?;
-    private scheme;
-    private record?;
-    private _handlers;
-    private connectedPublicId?;
-    private socket?;
-    private emit;
-    /** Track the scheme used when the socket was last initialized */
-    private _socketInitScheme?;
-    constructor(url: string, api: BaseAPI, identity: Identity, projectId: string);
-    static setAlternativeSocketFactory(factory: AlternativeSocketFactory): void;
-    init(): void;
-    /** Returns true if the socket needs re-initialization (scheme changed, or socket was never init'd) */
-    get needsReinit(): boolean;
-    get connectionScheme(): ConnectionScheme;
-    private initInternalHandlers;
-    disconnect(): void;
-    get handlers(): EventsHandler[];
-    get isUsingAlternativeConnectionScheme(): boolean;
-    toggleAlternativeConnectionScheme(url: string, updatedRecord?: ProjectEntity): void;
-    resumeEventHandlers(handlers: Array<EventsHandler>): void;
-    updateEventHandlers(handlers: EventsHandler): void;
-    get unSyncFileChanges(): number;
-    syncFileChanges(): Promise<any>;
-    /**
-     * Reference: services/web/frontend/js/ide/connection/ConnectionManager.js#L427
-     * @param {string} projectId - The project id.
-     * @returns {Promise}
-     */
-    joinProject(project_id: string): Promise<ProjectEntity>;
-    /**
-     * Reference: services/web/frontend/js/ide/editor/Document.js#L500
-     * @param {string} docId - The document id.
-     * @returns {Promise}
-     */
-    joinDoc(docId: string): Promise<any>;
-    /**
-     * Reference: services/web/frontend/js/ide/editor/Document.js#L591
-     * @param {string} docId - The document id.
-     * @returns {Promise}
-     */
-    leaveDoc(docId: string): Promise<any>;
-    /**
-     * Reference: services/web/frontend/js/ide/editor/ShareJsDocs.js#L78
-     * @param {string} docId - The document id.
-     * @param {any} update - The changes.
-     * @returns {Promise}
-     */
-    applyOtUpdate(docId: string, update: UpdateSchema): Promise<void>;
-    /**
-     * Reference: services/web/frontend/js/ide/online-users/OnlineUserManager.js#L42
-     * @returns {Promise}
-     */
-    getConnectedUsers(): Promise<OnlineUserSchema[]>;
-    /**
-     * Reference: services/web/frontend/js/ide/online-users/OnlineUserManager.js#L150
-     * @param {string} docId - The document id.
-     * @returns {Promise}
-     */
-    updatePosition(doc_id: string, row: number, column: number): Promise<any>;
-}
-
-type LogLevel = 'info' | 'warn' | 'error';
-type LogSink = (level: LogLevel, args: readonly unknown[]) => void;
-declare function setLogSink(nextSink: LogSink | undefined): void;
-declare function log(...args: unknown[]): void;
-declare function warn(...args: unknown[]): void;
-declare function error(...args: unknown[]): void;
-
-interface ServerSession {
-    url: string;
-    userId: string;
-    userEmail: string;
-    identity: Identity;
-    updatedAt: string;
-}
-interface LeafRelayConfig {
-    version: 1;
-    servers: Record<string, ServerSession>;
-}
-declare function configPath(environment?: NodeJS.ProcessEnv): string;
-declare function normalizeServerUrl(value: string): string;
-declare function serverKey(value: string): string;
-declare function readConfig(path?: string): Promise<LeafRelayConfig>;
-declare function writeConfig(config: LeafRelayConfig, path?: string): Promise<void>;
-declare function saveServerSession(session: ServerSession, path?: string): Promise<void>;
-declare function getServerSession(server: string, environment?: NodeJS.ProcessEnv, path?: string): Promise<ServerSession | undefined>;
-
-interface RemoteEntry {
-    path: string;
-    type: FileType;
-    entity: FileEntity;
-    parent?: FolderEntity;
-}
-type RemoteChange = {
-    path: string;
-    previousPath?: string;
-};
-declare class RemoteProject {
-    private readonly url;
-    private readonly projectId;
-    private readonly cookies;
-    private readonly api;
-    private identity;
-    private socket;
-    private project;
-    private readonly entries;
-    private readonly idToPath;
-    private changeHandler?;
-    constructor(url: string, projectId: string, cookies: string);
-    connect(): Promise<void>;
-    disconnect(): void;
-    onChange(handler: (change: RemoteChange) => void): void;
-    listEntries(): RemoteEntry[];
-    entry(path: string): RemoteEntry | undefined;
-    read(path: string): Promise<Uint8Array>;
-    mkdir(path: string): Promise<void>;
-    write(path: string, content: Uint8Array): Promise<void>;
-    remove(path: string): Promise<void>;
-    getCurrentVersion(): Promise<number>;
-    getFileTreeDiff(from: number, to: number): Promise<ProjectFileTreeDiffResponseSchema | undefined>;
-    private writeDocument;
-    private ensureParent;
-    private requireEntry;
-    private reindex;
-    private indexFolder;
-    private folderById;
-    private removeFromParent;
-    private emitChange;
-    private registerEvents;
-}
-
-declare const SYNC_STATE_SCHEMA_VERSION = 2;
-interface LocalReplicaSyncState {
-    schemaVersion: number;
-    projectUri: string;
-    remoteVersion: number;
-    files: {
-        [path: string]: string;
-    };
-    textBases: {
-        [path: string]: string;
-    };
-}
-declare function sha256(content: Uint8Array): string;
-declare function parseSyncState(serialized: string, projectUri: string): LocalReplicaSyncState | undefined;
-declare function createSyncState(projectUri: string, remoteVersion: number): LocalReplicaSyncState;
-declare function updateSyncCheckpoint(state: LocalReplicaSyncState, path: string, content: Uint8Array): void;
-declare function removeSyncCheckpoint(state: LocalReplicaSyncState, path: string): void;
-declare function readTextBase(state: LocalReplicaSyncState | undefined, path: string): Uint8Array | undefined;
-
-interface ReplicaFileSystem {
-    listFiles(): Promise<string[]>;
-    read(path: string): Promise<Uint8Array | undefined>;
-    write(path: string, content: Uint8Array): Promise<void>;
-    remove(path: string): Promise<void>;
-    watch(onChange: (path: string) => void): Promise<() => Promise<void>>;
-}
-interface RemoteReplica {
-    listEntries(): RemoteEntry[];
-    entry(path: string): RemoteEntry | undefined;
-    read(path: string): Promise<Uint8Array>;
-    write(path: string, content: Uint8Array): Promise<void>;
-    remove(path: string): Promise<void>;
-    getCurrentVersion(): Promise<number>;
-    getFileTreeDiff(from: number, to: number): Promise<ProjectFileTreeDiffResponseSchema | undefined>;
-    onChange(handler: (change: {
-        path: string;
-        previousPath?: string;
-    }) => void): void;
-}
-interface SyncStateStore {
-    load(): Promise<LocalReplicaSyncState | undefined>;
-    save(state: LocalReplicaSyncState): Promise<void>;
-}
-interface SyncEngineOptions {
-    projectUri: string;
-    local: ReplicaFileSystem;
-    remote: RemoteReplica;
-    stateStore: SyncStateStore;
-    ignore(path: string): boolean;
-    log(message: string): void;
-    onConflict(path: string, reason: string): void;
-}
-declare class SyncEngine {
-    private readonly options;
-    private state?;
-    private queue;
-    private conflicts;
-    private stopLocalWatch?;
-    private eventTimers;
-    constructor(options: SyncEngineOptions);
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    private startupReconcile;
-    private schedule;
-    private reconcilePath;
-    private remoteFilePaths;
-    private shouldIgnore;
-}
-
-declare class NodeReplicaFileSystem implements ReplicaFileSystem {
-    private readonly root;
-    private readonly ignore;
-    private watcher?;
-    constructor(root: string, ignore: (path: string) => boolean);
-    listFiles(): Promise<string[]>;
-    read(path: string): Promise<Uint8Array | undefined>;
-    write(path: string, content: Uint8Array): Promise<void>;
-    remove(path: string): Promise<void>;
-    watch(onChange: (path: string) => void): Promise<() => Promise<void>>;
-}
-
-interface LocalProjectSettings {
-    uri: string;
+interface ReplicaAttachResult {
+    replicaId: string;
+    root: string;
     serverName: string;
-    serverUrl: string;
     projectId: string;
     projectName: string;
-    userId?: string;
-    localReplica: {
-        settings: Record<string, unknown>;
-    };
+    shared: boolean;
+    status: ReplicaStatus;
+    conflicts: string[];
 }
-declare function readProjectSettings(directory: string): Promise<LocalProjectSettings>;
 
 interface RunningServe {
+    readonly replica: ReplicaAttachResult;
     stop(): Promise<void>;
 }
 declare function startServe(directory?: string): Promise<RunningServe>;
 
-declare class FileSyncStateStore implements SyncStateStore {
-    private readonly projectUri;
-    private readonly path;
-    private serialized?;
-    constructor(directory: string, projectUri: string);
-    load(): Promise<LocalReplicaSyncState | undefined>;
-    save(state: LocalReplicaSyncState): Promise<void>;
-}
-
-declare const DEFAULT_IGNORE_PATTERNS: string[];
-declare function createIgnoreMatcher(patterns: unknown): (path: string) => boolean;
-
-interface TextMergeResult {
-    status: 'merged' | 'conflict' | 'binary';
-    content?: Uint8Array;
-}
-declare function encodeTextBase(content: Uint8Array): string | undefined;
-declare function mergeText(baseContent: Uint8Array, localContent: Uint8Array, remoteContent: Uint8Array): TextMergeResult;
-
-export { BaseAPI, type CompileResponseSchema, DEFAULT_IGNORE_PATTERNS, type DocumentEntity, type EventsHandler, ExtendedBaseAPI, type FileEntity, type FileRefEntity, FileSyncStateStore, type FileType, type FolderEntity, type FolderKey, FolderKeys, type Identity, type LeafRelayConfig, type LocalProjectSettings, type LocalReplicaSyncState, type LogLevel, type LogSink, type MemberEntity, type MetadataResponseScheme, type MisspellingItemSchema, type NewProjectResponseSchema, NodeReplicaFileSystem, type OnlineUserSchema, type OutputFileEntity, OverleafRealtimeSocket, type OverleafRealtimeSocketOptions, type ProjectEntity, type ProjectFileDiffResponseSchema, type ProjectFileTreeDiffResponseSchema, type ProjectHistoryResponseSchema, type ProjectLabelResponseSchema, type ProjectLinkedFileProvider, type ProjectMessageResponseSchema, type ProjectPersist, type ProjectSettingsSchema, type ProjectTagsResponseSchema, type ProjectUpdateMeta, type ProjectUpdateResponseSchema, type RemoteChange, type RemoteEntry, RemoteProject, type RemoteReplica, type ReplicaFileSystem, type ResponseSchema, type RunningServe, SYNC_STATE_SCHEMA_VERSION, type ServerSession, type SnippetItemSchema, SocketIOAPI, type SyncCodeResponseSchema, SyncEngine, type SyncEngineOptions, type SyncPdfResponseSchema, type SyncStateStore, type TextMergeResult, type UpdateSchema, type UpdateUserSchema, type UrlLinkedFileProvider, configPath, createIgnoreMatcher, createSyncState, encodeTextBase, error, getServerSession, log, mergeText, normalizeServerUrl, overleafSocketProtocol, parseSyncState, readConfig, readProjectSettings, readTextBase, removeSyncCheckpoint, saveServerSession, serverKey, setLogSink, sha256, startServe, updateSyncCheckpoint, warn, writeConfig };
+export { type RunningServe, startServe };