bump

- Add new features for setting Self-hosted LiveSync up more easier.

docs/quick_setup.md

@@ -92,9 +92,6 @@ After installing Self-hosted LiveSync on the device, select `Open setup URI` fro
 Answer the following.
 
 - `Yes` to `Importing LiveSync's conf, OK?`
-- `No` to `Keep local DB?`
-- `Yes` to `Keep remote DB?`
-- `No` to `Rebuild the database?`
-- `Yes` to `Replicate once?`
+- `Set it up as secondary or subsequent device` to `How would you like to set it up?`.
 
 Then, The configuration will now take effect and replication will start. Your files will be synchronised soon!

docs/quick_setup_ja.md

@@ -85,13 +85,10 @@ All done! と表示されれば完了です。自動的に、`Copy setup URI`が
 クリップボードにSetup URIが保存されますので、これを2台目以降のデバイスに何らかの方法で転送してください。
 
 # 2台目以降の設定方法
-２台目の端末にSelf-hosted LiveSyncをインストールしたあと、コマンドパレットから`Open setup URI`を選択し、転送したsetup URIを入力します。その後、パスフレーズを入力するとセットアップ用のウィザードが開きます。  
+2台目の端末にSelf-hosted LiveSyncをインストールしたあと、コマンドパレットから`Open setup URI`を選択し、転送したsetup URIを入力します。その後、パスフレーズを入力するとセットアップ用のウィザードが開きます。  
 下記のように答えてください。
 
 - `Importing LiveSync's conf, OK?` に `Yes`
-- `Keep local DB?` に `No`
-- `Keep remote DB?`  に `Yes`
-- `Rebuild the database?` に `No`
-- `Replicate once?` に `Yes`
+- `How would you like to set it up?` に `Set it up as secondary or subsequent device`
 
 これで設定が反映され、レプリケーションが開始されます。

docs/setup_own_server.md

@@ -32,16 +32,18 @@ max_age = 3600
 
 Make `local.ini` and run with docker run like this, you can launch the CouchDB.
 ```
-$ docker run --rm -it -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=password -v .local.ini:/opt/couchdb/etc/local.ini -p 5984:5984 couchdb
+$ docker run --rm -it -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=password -v /path/to/local.ini:/opt/couchdb/etc/local.ini -p 5984:5984 couchdb
 ```
+*Remember to replace the path with the path to your local.ini*
 Note: At this time, the file owner of local.ini became 5984:5984. It's the limitation docker image. please change the owner before editing local.ini again.
 
 If you could confirm that Self-hosted LiveSync can sync with the server, launch docker image as background as you like.
 
-example)
+Example to run docker in detached mode:
 ```
-$ docker run -d --restart always -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=password -v .local.ini:/opt/couchdb/etc/local.ini -p 5984:5984 couchdb
+$ docker run -d --restart always -e COUCHDB_USER=admin -e COUCHDB_PASSWORD=password -v /path/to/local.ini:/opt/couchdb/etc/local.ini -p 5984:5984 couchdb
 ```
+*Remember to replace the path with the path to your local.ini*
 
 ## Access from mobile device
 If you want to access Self-hosted LiveSync from mobile devices, you need a valid SSL certificate.

manifest.json

@@ -1,7 +1,7 @@
 {
     "id": "obsidian-livesync",
     "name": "Self-hosted LiveSync",
-    "version": "0.15.3",
+    "version": "0.15.5",
     "minAppVersion": "0.9.12",
     "description": "Community implementation of self-hosted livesync. Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
     "author": "vorotamoroz",

package-lock.json

@@ -1,12 +1,12 @@
 {
     "name": "obsidian-livesync",
-    "version": "0.15.3",
+    "version": "0.15.5",
     "lockfileVersion": 2,
     "requires": true,
     "packages": {
         "": {
             "name": "obsidian-livesync",
-            "version": "0.15.3",
+            "version": "0.15.5",
             "license": "MIT",
             "dependencies": {
                 "diff-match-patch": "^1.0.5",

package.json

@@ -1,6 +1,6 @@
 {
     "name": "obsidian-livesync",
-    "version": "0.15.3",
+    "version": "0.15.5",
     "description": "Reflect your vault changes to some other devices immediately. Please make sure to disable other synchronize solutions to avoid content corruption or duplication.",
     "main": "main.js",
     "type": "module",

src/ObsidianLiveSyncSettingTab.ts

@@ -164,6 +164,24 @@ export class ObsidianLiveSyncSettingTab extends PluginSettingTab {
 
                 })
             })
+        const infoWarnForSubsequent = setupWizardEl.createEl("div", { text: `To set up second or subsequent device, please use  'Copy setup URI' and 'Open setup URI'` });
+        infoWarnForSubsequent.addClass("op-warn-info");
+        new Setting(setupWizardEl)
+            .setName("Copy setup URI")
+            .addButton((text) => {
+                text.setButtonText("Copy setup URI").onClick(() => {
+                    // @ts-ignore
+                    this.plugin.app.commands.executeCommandById("obsidian-livesync:livesync-copysetupuri")
+
+                })
+            })
+            .addButton((text) => {
+                text.setButtonText("Open setup URI").onClick(() => {
+                    // @ts-ignore
+                    this.plugin.app.commands.executeCommandById("obsidian-livesync:livesync-opensetupuri")
+
+                })
+            })
 
         addScreenElement("110", setupWizardEl);
 
@@ -361,7 +379,17 @@ export class ObsidianLiveSyncSettingTab extends PluginSettingTab {
                     .onClick(async () => {
                         await applyEncryption(true);
                     })
-            );
+            )
+            .addButton((button) =>
+            button
+                .setButtonText("Apply w/o rebuilding")
+                .setWarning()
+                .setDisabled(false)
+                .setClass("sls-btn-right")
+                .onClick(async () => {
+                    await applyEncryption(false);
+                })
+        );
 
 
         const rebuildDB = async (method: "localOnly" | "remoteOnly" | "rebuildBothByThisDevice") => {

src/dialogs.ts

@@ -98,7 +98,7 @@ export class PopoverSelectString extends FuzzySuggestModal<string> {
     constructor(app: App, note: string, placeholder: string | null, getItemsFun: () => string[], callback: (e: string) => void) {
         super(app);
         this.app = app;
-        this.setPlaceholder(placeholder ?? "y/n) " + note);
+        this.setPlaceholder((placeholder ?? "y/n) ") + note);
         if (getItemsFun) this.getItemsFun = getItemsFun;
         this.callback = callback;
     }

src/main.ts

@@ -82,7 +82,7 @@ const askYesNo = (app: App, message: string): Promise<"yes" | "no"> => {
 const askSelectString = (app: App, message: string, items: string[]): Promise<string> => {
     const getItemsFun = () => items;
     return new Promise((res) => {
-        const popover = new PopoverSelectString(app, message, "Select file)", getItemsFun, (result) => res(result));
+        const popover = new PopoverSelectString(app, message, "", getItemsFun, (result) => res(result));
         popover.open();
     });
 };
@@ -340,11 +340,31 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
         const configURIBase = "obsidian://setuplivesync?settings=";
         this.addCommand({
             id: "livesync-copysetupuri",
-            name: "Copy setup URI (beta)",
+            name: "Copy setup URI",
             callback: async () => {
                 const encryptingPassphrase = await askString(this.app, "Encrypt your settings", "Passphrase", "");
                 if (encryptingPassphrase === false) return;
-                const encryptedSetting = encodeURIComponent(await encrypt(JSON.stringify(this.settings), encryptingPassphrase));
+                const setting = { ...this.settings };
+                const keys = Object.keys(setting) as (keyof ObsidianLiveSyncSettings)[];
+                for (const k of keys) {
+                    if (JSON.stringify(k in setting ? setting[k] : "") == JSON.stringify(k in DEFAULT_SETTINGS ? DEFAULT_SETTINGS[k] : "*")) {
+                        delete setting[k];
+                    }
+                }
+                const encryptedSetting = encodeURIComponent(await encrypt(JSON.stringify(setting), encryptingPassphrase));
+                const uri = `${configURIBase}${encryptedSetting}`;
+                await navigator.clipboard.writeText(uri);
+                Logger("Setup URI copied to clipboard", LOG_LEVEL.NOTICE);
+            },
+        });
+        this.addCommand({
+            id: "livesync-copysetupurifull",
+            name: "Copy setup URI (Full)",
+            callback: async () => {
+                const encryptingPassphrase = await askString(this.app, "Encrypt your settings", "Passphrase", "");
+                if (encryptingPassphrase === false) return;
+                const setting = { ...this.settings };
+                const encryptedSetting = encodeURIComponent(await encrypt(JSON.stringify(setting), encryptingPassphrase));
                 const uri = `${configURIBase}${encryptedSetting}`;
                 await navigator.clipboard.writeText(uri);
                 Logger("Setup URI copied to clipboard", LOG_LEVEL.NOTICE);
@@ -352,9 +372,9 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
         });
         this.addCommand({
             id: "livesync-opensetupuri",
-            name: "Open setup URI (beta)",
+            name: "Open setup URI",
             callback: async () => {
-                const setupURI = await askString(this.app, "Set up manually", "Set up URI", `${configURIBase}aaaaa`);
+                const setupURI = await askString(this.app, "Easy setup", "Set up URI", `${configURIBase}aaaaa`);
                 if (setupURI === false) return;
                 if (!setupURI.startsWith(`${configURIBase}`)) {
                     Logger("Set up URI looks wrong.", LOG_LEVEL.NOTICE);
@@ -374,58 +394,91 @@ export default class ObsidianLiveSyncPlugin extends Plugin {
                 if (newConf) {
                     const result = await askYesNo(this.app, "Importing LiveSync's conf, OK?");
                     if (result == "yes") {
-                        const newSettingW = Object.assign({}, this.settings, newConf);
-                        // stopping once.
+                        const newSettingW = Object.assign({}, DEFAULT_SETTINGS, newConf);
                         this.localDatabase.closeReplication();
                         this.settings.suspendFileWatching = true;
                         console.dir(newSettingW);
-                        const keepLocalDB = await askYesNo(this.app, "Keep local DB?");
-                        const keepRemoteDB = await askYesNo(this.app, "Keep remote DB?");
-                        if (keepLocalDB == "yes" && keepRemoteDB == "yes") {
-                            // nothing to do. so peaceful.
+                        const setupJustImport = "Just import setting";
+                        const setupAsNew = "Set it up as secondary or subsequent device";
+                        const setupAgain = "Reconfigure and reconstitute the data";
+                        const setupManually = "Leave everything to me";
+
+                        const setupType = await askSelectString(this.app, "How would you like to set it up?", [setupAsNew, setupAgain, setupJustImport, setupManually]);
+                        if (setupType == setupJustImport) {
                             this.settings = newSettingW;
                             await this.saveSettings();
-                            const replicate = await askYesNo(this.app, "Unlock and replicate?");
-                            if (replicate == "yes") {
-                                await this.replicate(true);
-                                await this.markRemoteUnlocked();
-                            }
-                            Logger("Configuration loaded.", LOG_LEVEL.NOTICE);
-                            return;
-                        }
-                        if (keepLocalDB == "no" && keepRemoteDB == "no") {
-                            const reset = await askYesNo(this.app, "Drop everything?");
-                            if (reset != "yes") {
-                                Logger("Cancelled", LOG_LEVEL.NOTICE);
-                                this.settings = oldConf;
+                        } else if (setupType == setupAsNew) {
+                            this.settings = newSettingW;
+                            await this.saveSettings();
+                            await this.resetLocalOldDatabase();
+                            await this.resetLocalDatabase();
+                            await this.localDatabase.initializeDatabase();
+                            await this.markRemoteResolved();
+                            await this.replicate(true);
+                        } else if (setupType == setupAgain) {
+                            const confirm = "I know this operation will rebuild all my databases with files on this device, and files that are on the remote database and I didn't synchronize to any other devices will be lost and want to proceed indeed.";
+                            if (await askSelectString(this.app, "Do you really want to do this?", ["Cancel", confirm]) != confirm) {
                                 return;
                             }
-                        }
-                        let initDB;
-                        this.settings = newSettingW;
-                        await this.saveSettings();
-                        if (keepLocalDB == "no") {
-                            this.resetLocalOldDatabase();
-                            this.resetLocalDatabase();
-                            this.localDatabase.initializeDatabase();
-                            const rebuild = await askYesNo(this.app, "Rebuild the database?");
-                            if (rebuild == "yes") {
-                                initDB = this.initializeDatabase(true);
-                            } else {
-                                this.markRemoteResolved();
-                            }
-                        }
-                        if (keepRemoteDB == "no") {
+                            await this.saveSettings();
+                            await this.resetLocalOldDatabase();
+                            await this.resetLocalDatabase();
+                            await this.localDatabase.initializeDatabase();
+                            await this.initializeDatabase(true);
                             await this.tryResetRemoteDatabase();
                             await this.markRemoteLocked();
-                        }
-                        if (keepLocalDB == "no" || keepRemoteDB == "no") {
-                            const replicate = await askYesNo(this.app, "Replicate once?");
-                            if (replicate == "yes") {
-                                if (initDB != null) {
-                                    await initDB;
+                            await this.markRemoteResolved();
+                            await this.replicate(true);
+
+                        } else if (setupType == setupManually) {
+                            const keepLocalDB = await askYesNo(this.app, "Keep local DB?");
+                            const keepRemoteDB = await askYesNo(this.app, "Keep remote DB?");
+                            if (keepLocalDB == "yes" && keepRemoteDB == "yes") {
+                                // nothing to do. so peaceful.
+                                this.settings = newSettingW;
+                                await this.saveSettings();
+                                const replicate = await askYesNo(this.app, "Unlock and replicate?");
+                                if (replicate == "yes") {
+                                    await this.replicate(true);
+                                    await this.markRemoteUnlocked();
+                                }
+                                Logger("Configuration loaded.", LOG_LEVEL.NOTICE);
+                                return;
+                            }
+                            if (keepLocalDB == "no" && keepRemoteDB == "no") {
+                                const reset = await askYesNo(this.app, "Drop everything?");
+                                if (reset != "yes") {
+                                    Logger("Cancelled", LOG_LEVEL.NOTICE);
+                                    this.settings = oldConf;
+                                    return;
+                                }
+                            }
+                            let initDB;
+                            this.settings = newSettingW;
+                            await this.saveSettings();
+                            if (keepLocalDB == "no") {
+                                this.resetLocalOldDatabase();
+                                this.resetLocalDatabase();
+                                this.localDatabase.initializeDatabase();
+                                const rebuild = await askYesNo(this.app, "Rebuild the database?");
+                                if (rebuild == "yes") {
+                                    initDB = this.initializeDatabase(true);
+                                } else {
+                                    this.markRemoteResolved();
+                                }
+                            }
+                            if (keepRemoteDB == "no") {
+                                await this.tryResetRemoteDatabase();
+                                await this.markRemoteLocked();
+                            }
+                            if (keepLocalDB == "no" || keepRemoteDB == "no") {
+                                const replicate = await askYesNo(this.app, "Replicate once?");
+                                if (replicate == "yes") {
+                                    if (initDB != null) {
+                                        await initDB;
+                                    }
+                                    await this.replicate(true);
                                 }
-                                await this.replicate(true);
                             }
                         }
                     }

updates.md

@@ -6,8 +6,10 @@ I appreciate for reviewing and giving me advice @Pouhon158!
 
 #### Minors
 - 0.15.1 Missed the stylesheet.
-- 0.15.2 The wizard has been improved and documentated!
+- 0.15.2 The wizard has been improved and documented!
 - 0.15.3 Fixed the issue about locking/unlocking remote database while rebuilding in the wizard.
+- 0.15.4 Fixed issues about asynchronous processing (e.g., Conflict check or hidden file detection)
+- 0.15.5 Add new features for setting Self-hosted LiveSync up more easier.
 
 ### 0.14.1
 - The target selecting filter was implemented.
@@ -33,20 +35,5 @@ I appreciate for reviewing and giving me advice @Pouhon158!
 - 0.14.6 Change Target to ES2018
 - 0.14.7 Refactor and fix typos.
 - 0.14.8 Refactored again. There should be no change in behaviour, but please let me know if there is any.
-### 0.13.0
 
-- The metadata of the deleted files will be kept on the database by default. If you want to delete this as the previous version, please turn on `Delete metadata of deleted files.`. And, if you have upgraded from the older version, please ensure every device has been upgraded.
-- Please turn on `Delete metadata of deleted files.` if you are using livesync-classroom or filesystem-livesync.
-- We can see the history of deleted files.
-- `Pick file to show` was renamed to `Pick a file to show.
-- Files in the `Pick a file to show` are now ordered by their modified date descent.
-- Update information became to be shown on the major upgrade.
-
-#### Minors
-- 0.13.1 Fixed on conflict resolution.
-- 0.13.2 Fixed file deletion failures.
-- 0.13.4
-  - Now, we can synchronise hidden files that conflicted on each devices.
-  - We can search for conflicting docs.
-  - Pending processes can now be run at any time.
-  - Performance improved on synchronising large numbers of files at once.
+... To continue on to `updates_old.md`.

updates_old.md

@@ -0,0 +1,17 @@
+### 0.13.0
+
+- The metadata of the deleted files will be kept on the database by default. If you want to delete this as the previous version, please turn on `Delete metadata of deleted files.`. And, if you have upgraded from the older version, please ensure every device has been upgraded.
+- Please turn on `Delete metadata of deleted files.` if you are using livesync-classroom or filesystem-livesync.
+- We can see the history of deleted files.
+- `Pick file to show` was renamed to `Pick a file to show.
+- Files in the `Pick a file to show` are now ordered by their modified date descent.
+- Update information became to be shown on the major upgrade.
+
+#### Minors
+- 0.13.1 Fixed on conflict resolution.
+- 0.13.2 Fixed file deletion failures.
+- 0.13.4
+  - Now, we can synchronise hidden files that conflicted on each devices.
+  - We can search for conflicting docs.
+  - Pending processes can now be run at any time.
+  - Performance improved on synchronising large numbers of files at once.