11th March, 2026

Now, Self-hosted LiveSync has finally begun to be split into the Self-hosted LiveSync plugin for Obsidian, and a properly abstracted version of it.
This may not offer much benefit to Obsidian plugin users, or might even cause a slight inconvenience, but I believe it will certainly help improve testability and make the ecosystem better.
However, I do not see the point in putting something with little benefit into beta, so I am handling this on the alpha branch. I would actually preferred to create an R&D branch, but I was not keen on the ampersand, and I feel it will eventually become a proper beta anyway.

### Refactored

- Separated `ObsidianLiveSyncPlugin` into `ObsidianLiveSyncPlugin` and `LiveSyncBaseCore`.
- Now `LiveSyncCore` indicates the type specified version of `LiveSyncBaseCore`.
- Referencing `plugin.xxx` has been rewritten to referencing the corresponding service or `core.xxx`.

### Internal API changes

- Storage Access APIs are now yielding Promises. This is to allow more limited storage platforms to be supported.

### R&D

- Browser-version of Self-hosted LiveSync is now in development. This is not intended for public use now, but I will eventually make it available for testing.
- We can see the code in `src/apps/webapp` for the browser version.

src/modules/essential/ModuleBasicMenu.ts

@@ -0,0 +1,86 @@
+import type { LiveSyncCore } from "@/main";
+import { LOG_LEVEL_NOTICE } from "octagonal-wheels/common/logger";
+import { fireAndForget } from "octagonal-wheels/promises";
+import { AbstractModule } from "../AbstractModule";
+// Separated Module for basic menu commands, which are not related to obsidian specific features. It is expected to be used in other platforms with minimal changes.
+// However, it is odd that it has here at all; it really ought to be in each respective feature. It will likely be moved eventually. Until now, addCommand pointed to Obsidian's version.
+export class ModuleBasicMenu extends AbstractModule {
+    _everyOnloadStart(): Promise<boolean> {
+        this.addCommand({
+            id: "livesync-replicate",
+            name: "Replicate now",
+            callback: async () => {
+                await this.services.replication.replicate();
+            },
+        });
+        this.addCommand({
+            id: "livesync-dump",
+            name: "Dump information of this doc ",
+            callback: () => {
+                const file = this.services.vault.getActiveFilePath();
+                if (!file) return;
+                fireAndForget(() => this.localDatabase.getDBEntry(file, {}, true, false));
+            },
+        });
+        this.addCommand({
+            id: "livesync-toggle",
+            name: "Toggle LiveSync",
+            callback: async () => {
+                if (this.settings.liveSync) {
+                    this.settings.liveSync = false;
+                    this._log("LiveSync Disabled.", LOG_LEVEL_NOTICE);
+                } else {
+                    this.settings.liveSync = true;
+                    this._log("LiveSync Enabled.", LOG_LEVEL_NOTICE);
+                }
+                await this.services.control.applySettings();
+                await this.services.setting.saveSettingData();
+            },
+        });
+        this.addCommand({
+            id: "livesync-suspendall",
+            name: "Toggle All Sync.",
+            callback: async () => {
+                if (this.services.appLifecycle.isSuspended()) {
+                    this.services.appLifecycle.setSuspended(false);
+                    this._log("Self-hosted LiveSync resumed", LOG_LEVEL_NOTICE);
+                } else {
+                    this.services.appLifecycle.setSuspended(true);
+                    this._log("Self-hosted LiveSync suspended", LOG_LEVEL_NOTICE);
+                }
+                await this.services.control.applySettings();
+                await this.services.setting.saveSettingData();
+            },
+        });
+
+        this.addCommand({
+            id: "livesync-scan-files",
+            name: "Scan storage and database again",
+            callback: async () => {
+                await this.services.vault.scanVault(true);
+            },
+        });
+
+        this.addCommand({
+            id: "livesync-runbatch",
+            name: "Run pended batch processes",
+            callback: async () => {
+                await this.services.fileProcessing.commitPendingFileEvents();
+            },
+        });
+
+        // TODO, Replicator is possibly one of features. It should be moved to features.
+        this.addCommand({
+            id: "livesync-abortsync",
+            name: "Abort synchronization immediately",
+            callback: () => {
+                this.core.replicator.terminateSync();
+            },
+        });
+        return Promise.resolve(true);
+    }
+
+    override onBindFunction(core: LiveSyncCore, services: typeof core.services): void {
+        services.appLifecycle.onInitialise.addHandler(this._everyOnloadStart.bind(this));
+    }
+}

src/modules/essential/ModuleInitializerFile.ts

@@ -73,7 +73,7 @@ export class ModuleInitializerFile extends AbstractModule {
         await this.collectDeletedFiles();
 
         this._log("Collecting local files on the storage", LOG_LEVEL_VERBOSE);
-        const filesStorageSrc = this.core.storageAccess.getFiles();
+        const filesStorageSrc = await this.core.storageAccess.getFiles();
 
         const _filesStorage = [] as typeof filesStorageSrc;
 
@@ -300,7 +300,7 @@ export class ModuleInitializerFile extends AbstractModule {
             throw new Error(`Missing doc:${(file as any).path}`);
         }
         if ("path" in file) {
-            const w = this.core.storageAccess.getFileStub((file as any).path);
+            const w = await this.core.storageAccess.getFileStub((file as any).path);
             if (w) {
                 file = w;
             } else {

src/modules/essential/ModuleMigration.ts

@@ -8,7 +8,7 @@ import {
     eventHub,
 } from "../../common/events.ts";
 import { AbstractModule } from "../AbstractModule.ts";
-import { $msg } from "src/lib/src/common/i18n.ts";
+import { $msg } from "@lib/common/i18n.ts";
 import { performDoctorConsultation, RebuildOptions } from "../../lib/src/common/configForDoc.ts";
 import { isValidPath } from "../../common/utils.ts";
 import { isMetaEntry } from "../../lib/src/common/types.ts";
@@ -40,7 +40,7 @@ export class ModuleMigration extends AbstractModule {
         );
         if (isModified) {
             this.settings = settings;
-            await this.core.saveSettings();
+            await this.saveSettings();
         }
         if (!skipRebuild) {
             if (shouldRebuild) {
@@ -231,7 +231,7 @@ export class ModuleMigration extends AbstractModule {
         if (ret == FIX) {
             for (const file of recoverable) {
                 // Overwrite the database with the files on the storage
-                const stubFile = this.core.storageAccess.getFileStub(file.path);
+                const stubFile = await this.core.storageAccess.getFileStub(file.path);
                 if (stubFile == null) {
                     Logger(`Could not find stub file for ${file.path}`, LOG_LEVEL_NOTICE);
                     continue;