release 0.59.4

(cherry picked from commit e871edc8f3)

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -7,7 +7,7 @@ body:
   attributes:
     label: Trilium Version
     description: What version of Trilium are you using?
-    placeholder: 0.48.0-beta
+    placeholder: 0.57.0-beta
   validations:
     required: true
 - type: dropdown
@@ -44,3 +44,9 @@ body:
     description: A clear and concise description of the bug and any additional information.
   validations:
     required: true
+- type: textarea
+  attributes:
+    label: Error logs
+    description: Please provide error logs, see [wiki page](https://github.com/zadam/trilium/wiki/Error-logs) for instructions on how to submit them.
+  validations:
+    required: false

.gitignore

@@ -11,3 +11,4 @@ cert.crt
 server-package.json
 .idea/httpRequests/
 data/
+tmp/

.gitpod.yml

@@ -2,7 +2,7 @@ image:
   file: .gitpod.dockerfile
 
 tasks:
-    - before: nvm install 16.14.2 && nvm use 16.14.2
+    - before: nvm install 16.19.1 && nvm use 16.19.1
       init: npm install
       command: npm run start-server
 

.idea/git_toolbox_prj.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="GitToolBoxProjectSettings">
+    <option name="commitMessageIssueKeyValidationOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+    <option name="commitMessageValidationEnabledOverride">
+      <BoolValueOverride>
+        <option name="enabled" value="true" />
+      </BoolValueOverride>
+    </option>
+  </component>
+</project>

.idea/misc.xml

@@ -3,12 +3,7 @@
   <component name="JavaScriptSettings">
     <option name="languageLevel" value="ES6" />
   </component>
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_11" default="true" project-jdk-name="11" project-jdk-type="JavaSDK">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_16" default="true" project-jdk-name="openjdk-16" project-jdk-type="JavaSDK">
     <output url="file://$PROJECT_DIR$/out" />
   </component>
-  <component name="SwUserDefinedSpecifications">
-    <option name="specTypeByUrl">
-      <map />
-    </option>
-  </component>
 </project>

.vscode/launch.json

@@ -9,7 +9,8 @@
                 "<node_internals>/**"
             ],
             "env": {
-                "TRILIUM_ENV": "dev"
+                "TRILIUM_ENV": "dev",
+                "TRILIUM_DATA_DIR": "./data"
             },
             "outputCapture": "std",
             "program": "${workspaceFolder}/src/www"

Dockerfile

@@ -1,9 +1,12 @@
 # !!! Don't try to build this Dockerfile directly, run it through bin/build-docker.sh script !!!
-FROM node:16.14.2-alpine
+FROM node:16.19.1-alpine
 
 # Create app directory
 WORKDIR /usr/src/app
 
+# Bundle app source
+COPY . .
+
 COPY server-package.json package.json
 
 # Install app dependencies
@@ -18,13 +21,22 @@ RUN set -x \
         nasm \
         libpng-dev \
         python3 \
-    && npm install --production \
+    && npm install \
-    && apk del .build-dependencies
+    && apk del .build-dependencies \
+    && npm run webpack \
+    && npm prune --omit=dev \
+    && cp src/public/app/share.js src/public/app-dist/. \
+    && cp -r src/public/app/doc_notes src/public/app-dist/. \
+    && rm -rf src/public/app
 
-# Bundle app source
+# Some setup tools need to be kept
-COPY . .
+RUN apk add --no-cache su-exec shadow
 
-USER node
+# Add application user and setup proper volume permissions
+RUN adduser -s /bin/false node; exit 0
 
+# Start the application
 EXPOSE 8080
-CMD [ "node", "./src/www" ]
+CMD [ "./start-docker.sh" ]
+
+HEALTHCHECK --start-period=10s CMD exec su-exec node node docker_healthcheck.js

README-ZH_CN.md

@@ -1,49 +1,57 @@
-# Trilium笔记
+# Trilium Notes
 
 [English](https://github.com/zadam/trilium/blob/master/README.md) | [Chinese](https://github.com/zadam/trilium/blob/master/README-ZH_CN.md) | [Russian](https://github.com/zadam/trilium/blob/master/README.ru.md)
 
 [![Join the chat at https://gitter.im/trilium-notes/Lobby](https://badges.gitter.im/trilium-notes/Lobby.svg)](https://gitter.im/trilium-notes/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-Trilium Notes是一个分层的笔记应用程序，专注于建立大型个人知识库。请参阅[屏幕截图](https://github.com/zadam/trilium/wiki/Screenshot-tour)以快速了解：
+Trilium Notes 是一个层次化的笔记应用程序，专注于建立大型个人知识库。请参阅[屏幕截图](https://github.com/zadam/trilium/wiki/Screenshot-tour)以快速了解：
 
 ![](https://raw.githubusercontent.com/wiki/zadam/trilium/images/screenshot.png)
 
 Ukraine is currently suffering from Russian aggression, please consider donating to [one of these charities](https://old.reddit.com/r/ukraine/comments/s6g5un/want_to_support_ukraine_heres_a_list_of_charities/).
 
 <img src="https://upload.wikimedia.org/wikipedia/commons/4/49/Flag_of_Ukraine.svg" alt="drawing" width="600"/>
+<img src="https://signmyrocket.com//uploads/2b2a523cd0c0e76cdbba95a89a9636b2_1676971281.jpg" alt="Trilium Notes supports Ukraine!" width="600"/>
 
 ## 特性
 
 * 笔记可以排列成任意深的树。单个笔记可以放在树中的多个位置（请参阅[克隆](https://github.com/zadam/trilium/wiki/Cloning-notes)）
-* 丰富的所见即所得笔记编辑功能，包括带有markdown[自动格式化功能的](https://github.com/zadam/trilium/wiki/Text-notes#autoformat)表格，图像和[数学](https://github.com/zadam/trilium/wiki/Text-notes#math-support)
+* 丰富的所见即所得笔记编辑功能，包括带有 Markdown [自动格式化功能的](https://github.com/zadam/trilium/wiki/Text-notes#autoformat)表格，图像和[数学](https://github.com/zadam/trilium/wiki/Text-notes#math-support)
 * 支持编辑[使用源代码的笔记](https://github.com/zadam/trilium/wiki/Code-notes)，包括语法高亮显示
-* 笔记之间快速[导航](https://github.com/zadam/trilium/wiki/Note-navigation)，全文搜索和[笔记挂起](https://github.com/zadam/trilium/wiki/Note-hoisting)
+* 笔记之间快速[导航](https://github.com/zadam/trilium/wiki/Note-navigation)，全文搜索和[笔记聚焦](https://github.com/zadam/trilium/wiki/Note-hoisting)
 * 无缝[笔记版本控制](https://github.com/zadam/trilium/wiki/Note-revisions)
 * 笔记[属性](https://github.com/zadam/trilium/wiki/Attributes)可用于笔记组织，查询和高级[脚本编写](https://github.com/zadam/trilium/wiki/Scripts)
 * [同步](https://github.com/zadam/trilium/wiki/Synchronization)与自托管同步服务器
+  * 有一个[第三方提供的同步服务器托管服务](https://trilium.cc/paid-hosting)
+* 公开地[分享](https://github.com/zadam/trilium/wiki/Sharing)（发布）笔记到互联网
 * 具有按笔记粒度的强大的[笔记加密](https://github.com/zadam/trilium/wiki/Protected-notes)
+* 使用自带的 Excalidraw 来绘制图表（笔记类型“画布”）
 * [关系图](https://github.com/zadam/trilium/wiki/Relation-map)和[链接图](https://github.com/zadam/trilium/wiki/Link-map)，用于可视化笔记及其关系
-* [脚本](https://github.com/zadam/trilium/wiki/Scripts)-请参阅[高级展示](https://github.com/zadam/trilium/wiki/Advanced-showcases)
+* [脚本](https://github.com/zadam/trilium/wiki/Scripts) - 请参阅[高级功能展示](https://github.com/zadam/trilium/wiki/Advanced-showcases)
-* 可用性和性能均能很好地扩展至超过10万个笔记
+* 在拥有超过 10 万条笔记时仍能保持良好的可用性和性能
-* 针对智能手机和平板电脑进行触摸优化的[移动前端](https://github.com/zadam/trilium/wiki/Mobile-frontend)
+* 针对智能手机和平板电脑进行优化的[用于移动设备的前端](https://github.com/zadam/trilium/wiki/Mobile-frontend)
 * [夜间主题](https://github.com/zadam/trilium/wiki/Themes)
-* [Evernote](https://github.com/zadam/trilium/wiki/Evernote-import)和[Markdown导入导出](https://github.com/zadam/trilium/wiki/Markdown)
+* [Evernote](https://github.com/zadam/trilium/wiki/Evernote-import) 和 [Markdown 导入导出](https://github.com/zadam/trilium/wiki/Markdown)功能
-* [Web Clipper](https://github.com/zadam/trilium/wiki/Web-clipper)可轻松保存Web内容
+* 使用[网页剪藏](https://github.com/zadam/trilium/wiki/Web-clipper)轻松保存互联网上的内容
 
 ## 构建
 
-Trilium是作为桌面应用程序（Linux和Windows）或服务器上托管的Web应用程序（Linux）提供的。Mac OS桌面版本可用，但[不受支持](https://github.com/zadam/trilium/wiki/FAQ#mac-os-support)。
+Trilium 可以用作桌面应用程序（Linux 和 Windows）或服务器（Linux）上托管的 Web 应用程序。虽然有 macOS 版本的桌面应用程序，但它[不受支持](https://github.com/zadam/trilium/wiki/FAQ#mac-os-support)。
 
-* 如果要在桌面上使用Trilium，请从[最新版本](https://github.com/zadam/trilium/releases/latest)下载适用于您平台的二进制[版本](https://github.com/zadam/trilium/releases/latest)，解压缩该软件包并运行`trilium`可执行文件。
+* 如果要在桌面上使用 Trilium，请从[最新版本](https://github.com/zadam/trilium/releases/latest)下载适用于您平台的二进制版本，解压缩该软件包并运行`trilium`可执行文件。
-* 如果要在服务器上安装Trilium，请遵循[此页面](https://github.com/zadam/trilium/wiki/Server-installation)。
+* 如果要在服务器上安装 Trilium，请参考[此页面](https://github.com/zadam/trilium/wiki/Server-installation)。
-    * 当前仅支持（经过测试）最新的Chrome和Firefox浏览器。
+  * 当前仅支持（测试过）最近发布的 Chrome 和 Firefox 浏览器。
+
+Trilium 也提供 Flatpak：
+
+[<img width="240" src="https://flathub.org/assets/badges/flathub-badge-en.png">](https://flathub.org/apps/details/com.github.zadam.trilium)
 
 ## 文档
 
-[有关文档页面的完整列表，请参见Wiki。](https://github.com/zadam/trilium/wiki/)
+[有关文档页面的完整列表，请参见 Wiki。](https://github.com/zadam/trilium/wiki/)
 
-[中文Wiki在这里](https://github.com/baddate/trilium/wiki/)
+* [Wiki 的中文翻译版本](https://github.com/baddate/trilium/wiki/)
 
-您还可以阅读[个人知识库模式](https://github.com/zadam/trilium/wiki/Patterns-of-personal-knowledge-base)，以获取有关如何使用Trilium的灵感。
+您还可以阅读[个人知识库模式](https://github.com/zadam/trilium/wiki/Patterns-of-personal-knowledge-base)，以获取有关如何使用 Trilium 的灵感。
 
 ## 贡献
 
@@ -51,7 +59,7 @@ Trilium是作为桌面应用程序（Linux和Windows）或服务器上托管的W
 
 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/zadam/trilium)
 
-或在本地克隆并运行
+或者克隆本仓库到本地，并运行
 
 ```
 npm install
@@ -60,7 +68,15 @@ npm run start-server
 
 ## 致谢
 
-* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - 市场上最好的所见即所得编辑器，互动性强且聆听能力强的团队
+* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - 市面上最好的所见即所得编辑器，拥有互动性强且聆听能力强的团队
-* [FancyTree](https://github.com/mar10/fancytree) - 一个非常丰富的关于树的库，强大的没有对手。没有它，Trilium Notes将不会如此。
+* [FancyTree](https://github.com/mar10/fancytree) - 一个非常丰富的关于树的库，强大到没有对手。没有它，Trilium Notes 将不会如此。
 * [CodeMirror](https://github.com/codemirror/CodeMirror) - 支持大量语言的代码编辑器
-* [jsPlumb](https://github.com/jsplumb/jsplumb)强大的可视化连接库。- 用于[关系图](https://github.com/zadam/trilium/wiki/Relation-map)和[链接图](https://github.com/zadam/trilium/wiki/Link-map)
+* [jsPlumb](https://github.com/jsplumb/jsplumb) - 强大的可视化连接库。用于[关系图](https://github.com/zadam/trilium/wiki/Relation-map)和[链接图](https://github.com/zadam/trilium/wiki/Link-map)
+
+## 捐赠
+
+你可以通过 GitHub Sponsors，[PayPal](https://paypal.me/za4am) 或者比特币 (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2) 来捐赠。
+
+## 许可证
+
+本程序是自由软件：你可以再发布本软件和/或修改本软件，只要你遵循 Free Software Foundation 发布的 GNU Affero General Public License 的第三版或者任何（由你选择）更晚的版本。

README.md

@@ -1,17 +1,19 @@
 # Trilium Notes
 
-[English](https://github.com/zadam/trilium/blob/master/README.md) | [Chinese](https://github.com/zadam/trilium/blob/master/README-ZH_CN.md) | [Russian](https://github.com/zadam/trilium/blob/master/README.ru.md)
+[![Join the chat at https://gitter.im/trilium-notes/Lobby](https://badges.gitter.im/trilium-notes/Lobby.svg)](https://gitter.im/trilium-notes/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [English](https://github.com/zadam/trilium/blob/master/README.md) | [Chinese](https://github.com/zadam/trilium/blob/master/README-ZH_CN.md) | [Russian](https://github.com/zadam/trilium/blob/master/README.ru.md)
 
-[![Join the chat at https://gitter.im/trilium-notes/Lobby](https://badges.gitter.im/trilium-notes/Lobby.svg)](https://gitter.im/trilium-notes/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 Trilium Notes is a hierarchical note taking application with focus on building large personal knowledge bases. See [screenshots](https://github.com/zadam/trilium/wiki/Screenshot-tour) for quick overview:
 
-![](https://raw.githubusercontent.com/wiki/zadam/trilium/images/screenshot.png)
+<a href="https://github.com/zadam/trilium/wiki/Screenshot-tour"><img src="https://raw.githubusercontent.com/wiki/zadam/trilium/images/screenshot.png" alt="Trilium Screenshot" width="1000"></a>
 
-Ukraine is currently suffering from Russian aggression, please consider donating to [one of these charities](https://old.reddit.com/r/ukraine/comments/s6g5un/want_to_support_ukraine_heres_a_list_of_charities/).
+Ukraine is currently defending itself from Russian aggression, please consider [donating to Ukrainian Army or humanitarian charities](https://standforukraine.com/).
 
-<img src="https://upload.wikimedia.org/wikipedia/commons/4/49/Flag_of_Ukraine.svg" alt="drawing" width="600"/>
+<p float="left">
+  <img src="https://upload.wikimedia.org/wikipedia/commons/4/49/Flag_of_Ukraine.svg" alt="drawing" width="400"/>
+  <img src="https://signmyrocket.com//uploads/2b2a523cd0c0e76cdbba95a89a9636b2_1676971281.jpg" alt="Trilium Notes supports Ukraine!" width="570"/>
+</p>
 
-## Features
+## 🎁 Features
 
 * Notes can be arranged into arbitrarily deep tree. Single note can be placed into multiple places in the tree (see [cloning](https://github.com/zadam/trilium/wiki/Cloning-notes))
 * Rich WYSIWYG note editing including e.g. tables, images and [math](https://github.com/zadam/trilium/wiki/Text-notes#math-support) with markdown [autoformat](https://github.com/zadam/trilium/wiki/Text-notes#autoformat)
@@ -23,6 +25,7 @@ Ukraine is currently suffering from Russian aggression, please consider donating
   * there's a [3rd party service for hosting synchronisation server](https://trilium.cc/paid-hosting)
 * [Sharing](https://github.com/zadam/trilium/wiki/Sharing) (publishing) notes to public internet
 * Strong [note encryption](https://github.com/zadam/trilium/wiki/Protected-notes) with per-note granularity
+* Sketching diagrams with built-in Excalidraw (note type "canvas")
 * [Relation maps](https://github.com/zadam/trilium/wiki/Relation-map) and [link maps](https://github.com/zadam/trilium/wiki/Link-map) for visualizing notes and their relations
 * [Scripting](https://github.com/zadam/trilium/wiki/Scripts) - see [Advanced showcases](https://github.com/zadam/trilium/wiki/Advanced-showcases)
 * [REST API](https://github.com/zadam/trilium/wiki/ETAPI) for automation
@@ -32,7 +35,9 @@ Ukraine is currently suffering from Russian aggression, please consider donating
 * [Evernote](https://github.com/zadam/trilium/wiki/Evernote-import) and [Markdown import & export](https://github.com/zadam/trilium/wiki/Markdown)
 * [Web Clipper](https://github.com/zadam/trilium/wiki/Web-clipper) for easy saving of web content
 
-## Builds
+Check out [awesome-trilium](https://github.com/Nriver/awesome-trilium) for 3rd party themes, scripts, plugins and more.
+
+## 🏗 Builds
 
 Trilium is provided as either desktop application (Linux and Windows) or web application hosted on your server (Linux). Mac OS desktop build is available, but it is [unsupported](https://github.com/zadam/trilium/wiki/FAQ#mac-os-support).
 
@@ -40,13 +45,17 @@ Trilium is provided as either desktop application (Linux and Windows) or web app
 * If you want to install Trilium on server, follow [this page](https://github.com/zadam/trilium/wiki/Server-installation).
   * Currently only recent Chrome and Firefox are supported (tested) browsers.
 
-## Documentation
+Trilium is also provided as a Flatpak:
+
+[<img width="240" src="https://flathub.org/assets/badges/flathub-badge-en.png">](https://flathub.org/apps/details/com.github.zadam.trilium)
+
+## 📝 Documentation
 
 [See wiki for complete list of documentation pages.](https://github.com/zadam/trilium/wiki/)
 
 You can also read [Patterns of personal knowledge base](https://github.com/zadam/trilium/wiki/Patterns-of-personal-knowledge-base) to get some inspiration on how you might use Trilium.
 
-## Contribute
+## 💻 Contribute
 
 Use a browser based dev environment
 
@@ -58,17 +67,17 @@ npm install
 npm run start-server
 ```
 
-## Shoutouts
+## 📢 Shoutouts
 
 * [CKEditor 5](https://github.com/ckeditor/ckeditor5) - best WYSIWYG editor on the market, very interactive and listening team
 * [FancyTree](https://github.com/mar10/fancytree) - very feature rich tree library without real competition. Trilium Notes would not be the same without it.
 * [CodeMirror](https://github.com/codemirror/CodeMirror) - code editor with support for huge amount of languages
 * [jsPlumb](https://github.com/jsplumb/jsplumb) - visual connectivity library without competition. Used in [relation maps](https://github.com/zadam/trilium/wiki/Relation-map) and [link maps](https://github.com/zadam/trilium/wiki/Link-map)
 
-## Donating
+## 🤝 Support
 
-You can donate using GitHub Sponsors, [PayPal](https://paypal.me/za4am) or Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2).
+You can support Trilum using GitHub Sponsors, [PayPal](https://paypal.me/za4am) or Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2).
 
-## License
+## 🔑 License
 
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

README.ru.md

@@ -10,6 +10,7 @@ Trilium Notes – это приложение для заметок с иера
 Ukraine is currently suffering from Russian aggression, please consider donating to [one of these charities](https://old.reddit.com/r/ukraine/comments/s6g5un/want_to_support_ukraine_heres_a_list_of_charities/).
 
 <img src="https://upload.wikimedia.org/wikipedia/commons/4/49/Flag_of_Ukraine.svg" alt="drawing" width="600"/>
+<img src="https://signmyrocket.com//uploads/2b2a523cd0c0e76cdbba95a89a9636b2_1676971281.jpg" alt="Trilium Notes supports Ukraine!" width="600"/>
 
 ## Возможности
 

bin/build-linux-x64.sh

@@ -30,6 +30,7 @@ rm -r $BUILD_DIR/swiftshader
 cp bin/tpl/anonymize-database.sql $BUILD_DIR/
 
 cp -r dump-db $BUILD_DIR/
+rm -rf $BUILD_DIR/dump-db/node_modules
 
 cp bin/tpl/trilium-portable.sh $BUILD_DIR/
 chmod 755 $BUILD_DIR/trilium-portable.sh

bin/build-mac-x64.sh

@@ -26,6 +26,7 @@ mv "./dist/Trilium Notes-darwin-x64" $BUILD_DIR
 cp bin/tpl/anonymize-database.sql $BUILD_DIR/
 
 cp -r dump-db $BUILD_DIR/
+rm -rf $BUILD_DIR/dump-db/node_modules
 
 echo "Zipping mac x64 electron distribution..."
 

bin/build-server.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 PKG_DIR=dist/trilium-linux-x64-server
-NODE_VERSION=16.14.2
+NODE_VERSION=16.19.1
 
 if [ "$1" != "DONTCOPY" ]
 then
@@ -31,6 +31,7 @@ chmod 755 $PKG_DIR/trilium.sh
 cp bin/tpl/anonymize-database.sql $PKG_DIR/
 
 cp -r dump-db $PKG_DIR/
+rm -rf $PKG_DIR/dump-db/node_modules
 
 VERSION=`jq -r ".version" package.json`
 

bin/build-win-x64.sh

@@ -28,8 +28,9 @@ rm -r $BUILD_DIR/swiftshader
 cp bin/tpl/anonymize-database.sql $BUILD_DIR/
 
 cp -r dump-db $BUILD_DIR/
+rm -rf $BUILD_DIR/dump-db/node_modules
 
-cp bin/tpl/trilium-{portable,no-cert-check,safe-mode}.{bat,ps1} $BUILD_DIR/
+cp bin/tpl/trilium-{portable,no-cert-check,safe-mode}.bat $BUILD_DIR/
 
 echo "Zipping windows x64 electron distribution..."
 VERSION=`jq -r ".version" package.json`

bin/copy-trilium.sh

@@ -5,7 +5,7 @@ if [[ $# -eq 0 ]] ; then
     exit 1
 fi
 
-n exec 16.14.2 npm run webpack
+n exec 16.19.1 npm run webpack
 
 DIR=$1
 
@@ -14,9 +14,6 @@ mkdir $DIR
 
 echo "Copying Trilium to build directory $DIR"
 
-cp -r dump-db $DIR/
-rm -rf $DIR/dump-db/node_modules
-
 cp -r images $DIR/
 cp -r libraries $DIR/
 cp -r src $DIR/
@@ -30,7 +27,7 @@ cp -r electron.js $DIR/
 cp webpack-* $DIR/
 
 # run in subshell (so we return to original dir)
-(cd $DIR && n exec 16.14.2 npm install --only=prod)
+(cd $DIR && n exec 16.19.1 npm install --only=prod)
 
 # cleanup of useless files in dependencies
 rm -r $DIR/node_modules/image-q/demo
@@ -48,10 +45,6 @@ find $DIR/node_modules -name demo -exec rm -rf {} \;
 find $DIR/libraries -name "*.map" -type f -delete
 
 cp $DIR/src/public/app/share.js $DIR/src/public/app-dist/
+cp -r $DIR/src/public/app/doc_notes $DIR/src/public/app-dist/
 
 rm -rf $DIR/src/public/app
-
-sed -i -e 's/app\/desktop.js/app-dist\/desktop.js/g' $DIR/src/views/desktop.ejs
-sed -i -e 's/app\/mobile.js/app-dist\/mobile.js/g' $DIR/src/views/mobile.ejs
-sed -i -e 's/app\/setup.js/app-dist\/setup.js/g' $DIR/src/views/setup.ejs
-sed -i -e 's/app\/share.js/app-dist\/share.js/g' $DIR/src/views/share/*.ejs

bin/export-schema.sh

@@ -2,6 +2,6 @@
 
 SCHEMA_FILE_PATH=db/schema.sql
 
-sqlite3 ~/trilium-data/document.db .schema | grep -v "sqlite_sequence" > "$SCHEMA_FILE_PATH"
+sqlite3 ./data/document.db .schema | grep -v "sqlite_sequence" > "$SCHEMA_FILE_PATH"
 
 echo "DB schema exported to $SCHEMA_FILE_PATH"

bin/release-flatpack.sh

@@ -0,0 +1,57 @@
+#!/usr/bin/env bash
+
+if [[ $# -eq 0 ]] ; then
+    echo "Missing argument of new version"
+    exit 1
+fi
+
+VERSION=$1
+
+if ! [[ ${VERSION} =~ ^[0-9]{1,2}\.[0-9]{1,2}\.[0-9]{1,2}(-.+)?$ ]] ;
+then
+    echo "Version ${VERSION} isn't in format X.Y.Z"
+    exit 1
+fi
+
+VERSION_DATE=$(git log -1 --format=%aI "v${VERSION}" | cut -c -10)
+VERSION_COMMIT=$(git rev-list -n 1 "v${VERSION}")
+
+# expecting the directory at a specific path
+cd ~/trilium-flathub || exit
+
+if ! git diff-index --quiet HEAD --; then
+    echo "There are uncommitted changes"
+    exit 1
+fi
+
+BASE_BRANCH=master
+
+if [[ "$VERSION" == *"beta"* ]]; then
+    BASE_BRANCH=beta
+fi
+
+git switch "${BASE_BRANCH}"
+git pull
+
+BRANCH=b${VERSION}
+
+git branch "${BRANCH}"
+git switch "${BRANCH}"
+
+echo "Updating files with version ${VERSION}, date ${VERSION_DATE} and commit ${VERSION_COMMIT}"
+
+flatpak-node-generator npm ../trilium/package-lock.json
+
+xmlstarlet ed --inplace --update "/component/releases/release/@version" --value "${VERSION}" --update "/component/releases/release/@date" --value "${VERSION_DATE}" ./com.github.zadam.trilium.metainfo.xml
+
+yq --inplace "(.modules[0].sources[0].tag = \"v${VERSION}\") | (.modules[0].sources[0].commit = \"${VERSION_COMMIT}\")" ./com.github.zadam.trilium.yml
+
+git add ./generated-sources.json
+git add ./com.github.zadam.trilium.metainfo.xml
+git add ./com.github.zadam.trilium.yml
+
+git commit -m "release $VERSION"
+git push --set-upstream origin "${BRANCH}"
+
+gh pr create --fill -B "${BASE_BRANCH}"
+gh pr merge --auto --merge --delete-branch

bin/tpl/anonymize-database.sql

@@ -1,17 +1,166 @@
 
 UPDATE etapi_tokens SET tokenHash = 'API token hash value';
-UPDATE notes SET title = 'title' WHERE title NOT IN ('root', 'hidden', 'share');
+UPDATE notes SET title = 'title' WHERE noteId != 'root' AND noteId NOT LIKE '\_%' ESCAPE '\';
 UPDATE note_contents SET content = 'text' WHERE content IS NOT NULL;
 UPDATE note_revisions SET title = 'title';
 UPDATE note_revision_contents SET content = 'text' WHERE content IS NOT NULL;
 
-UPDATE attributes SET name = 'name', value = 'value' WHERE type = 'label' AND name NOT IN('inbox', 'disableVersioning', 'calendarRoot', 'archived', 'excludeFromExport', 'disableInclusion', 'appCss', 'appTheme', 'hidePromotedAttributes', 'readOnly', 'autoReadOnlyDisabled', 'hoistedCssClass', 'cssClass', 'iconClass', 'keyboardShortcut', 'run', 'runOnInstance', 'runAtHour', 'customRequestHandler', 'customResourceProvider', 'widget', 'noteInfoWidgetDisabled', 'linkMapWidgetDisabled', 'noteRevisionsWidgetDisabled', 'whatLinksHereWidgetDisabled', 'similarNotesWidgetDisabled', 'workspace', 'workspaceIconClass', 'workspaceTabBackgroundColor', 'searchHome', 'hoistedInbox', 'hoistedSearchHome', 'sqlConsoleHome', 'datePattern', 'pageSize', 'viewType', 'mapRootNoteId', 'bookmarked', 'bookmarkFolder', 'sorted', 'top', 'fullContentWidth', 'shareHiddenFromTree', 'shareAlias', 'shareOmitDefaultCss', 'shareRoot', 'internalLink', 'imageLink', 'relationMapLink', 'includeMapLink', 'runOnNoteCreation', 'runOnNoteTitleChange', 'runOnNoteChange', 'runOnChildNoteCreation', 'runOnAttributeCreation', 'runOnAttributeChange', 'template', 'widget', 'renderNote', 'shareCss', 'shareJs', 'shareFavicon');
+UPDATE attributes SET name = 'name', value = 'value'
-UPDATE attributes SET name = 'name' WHERE type = 'relation' AND name NOT IN ('inbox', 'disableVersioning', 'calendarRoot', 'archived', 'excludeFromExport', 'disableInclusion', 'appCss', 'appTheme', 'hidePromotedAttributes', 'readOnly', 'autoReadOnlyDisabled', 'hoistedCssClass', 'cssClass', 'iconClass', 'keyboardShortcut', 'run', 'runOnInstance', 'runAtHour', 'customRequestHandler', 'customResourceProvider', 'widget', 'noteInfoWidgetDisabled', 'linkMapWidgetDisabled', 'noteRevisionsWidgetDisabled', 'whatLinksHereWidgetDisabled', 'similarNotesWidgetDisabled', 'workspace', 'workspaceIconClass', 'workspaceTabBackgroundColor', 'searchHome', 'hoistedInbox', 'hoistedSearchHome', 'sqlConsoleHome', 'datePattern', 'pageSize', 'viewType', 'mapRootNoteId', 'bookmarked', 'bookmarkFolder', 'sorted', 'top', 'fullContentWidth', 'shareHiddenFromTree', 'shareAlias', 'shareOmitDefaultCss', 'shareRoot', 'internalLink', 'imageLink', 'relationMapLink', 'includeMapLink', 'runOnNoteCreation', 'runOnNoteTitleChange', 'runOnNoteChange', 'runOnChildNoteCreation', 'runOnAttributeCreation', 'runOnAttributeChange', 'template', 'widget', 'renderNote', 'shareCss', 'shareJs', 'shareFavicon');
+                  WHERE type = 'label'
+                    AND name NOT IN ('inbox',
+                                     'disableVersioning',
+                                     'calendarRoot',
+                                     'archived',
+                                     'excludeFromExport',
+                                     'disableInclusion',
+                                     'appCss',
+                                     'appTheme',
+                                     'hidePromotedAttributes',
+                                     'readOnly',
+                                     'autoReadOnlyDisabled',
+                                     'cssClass',
+                                     'iconClass',
+                                     'keyboardShortcut',
+                                     'run',
+                                     'runOnInstance',
+                                     'runAtHour',
+                                     'customRequestHandler',
+                                     'customResourceProvider',
+                                     'widget',
+                                     'noteInfoWidgetDisabled',
+                                     'linkMapWidgetDisabled',
+                                     'noteRevisionsWidgetDisabled',
+                                     'whatLinksHereWidgetDisabled',
+                                     'similarNotesWidgetDisabled',
+                                     'workspace',
+                                     'workspaceIconClass',
+                                     'workspaceTabBackgroundColor',
+                                     'searchHome',
+                                     'workspaceInbox',
+                                     'workspaceSearchHome',
+                                     'sqlConsoleHome',
+                                     'datePattern',
+                                     'pageSize',
+                                     'viewType',
+                                     'mapRootNoteId',
+                                     'bookmarkFolder',
+                                     'sorted',
+                                     'top',
+                                     'fullContentWidth',
+                                     'shareHiddenFromTree',
+                                     'shareAlias',
+                                     'shareOmitDefaultCss',
+                                     'shareRoot',
+                                     'internalLink',
+                                     'imageLink',
+                                     'relationMapLink',
+                                     'includeMapLink',
+                                     'runOnNoteCreation',
+                                     'runOnNoteTitleChange',
+                                     'runOnNoteContentChange',
+                                     'runOnNoteChange',
+                                     'runOnChildNoteCreation',
+                                     'runOnAttributeCreation',
+                                     'runOnAttributeChange',
+                                     'template',
+                                     'inherit',
+                                     'widget',
+                                     'renderNote',
+                                     'shareCss',
+                                     'shareJs',
+                                     'shareFavicon',
+                                     'executeButton',
+                                     'keepCurrentHoisting',
+                                     'color',
+                                     'toc',
+                                     'excludeFromNoteMap',
+                                     'docName',
+                                     'launcherType',
+                                     'builtinWidget',
+                                     'baseSize',
+                                     'growthFactor'
+                      );
+
+UPDATE attributes SET name = 'name'
+                    AND name NOT IN ('inbox',
+                                     'disableVersioning',
+                                     'calendarRoot',
+                                     'archived',
+                                     'excludeFromExport',
+                                     'disableInclusion',
+                                     'appCss',
+                                     'appTheme',
+                                     'hidePromotedAttributes',
+                                     'readOnly',
+                                     'autoReadOnlyDisabled',
+                                     'cssClass',
+                                     'iconClass',
+                                     'keyboardShortcut',
+                                     'run',
+                                     'runOnInstance',
+                                     'runAtHour',
+                                     'customRequestHandler',
+                                     'customResourceProvider',
+                                     'widget',
+                                     'noteInfoWidgetDisabled',
+                                     'linkMapWidgetDisabled',
+                                     'noteRevisionsWidgetDisabled',
+                                     'whatLinksHereWidgetDisabled',
+                                     'similarNotesWidgetDisabled',
+                                     'workspace',
+                                     'workspaceIconClass',
+                                     'workspaceTabBackgroundColor',
+                                     'searchHome',
+                                     'workspaceInbox',
+                                     'workspaceSearchHome',
+                                     'sqlConsoleHome',
+                                     'datePattern',
+                                     'pageSize',
+                                     'viewType',
+                                     'mapRootNoteId',
+                                     'bookmarkFolder',
+                                     'sorted',
+                                     'top',
+                                     'fullContentWidth',
+                                     'shareHiddenFromTree',
+                                     'shareAlias',
+                                     'shareOmitDefaultCss',
+                                     'shareRoot',
+                                     'internalLink',
+                                     'imageLink',
+                                     'relationMapLink',
+                                     'includeMapLink',
+                                     'runOnNoteCreation',
+                                     'runOnNoteTitleChange',
+                                     'runOnNoteContentChange',
+                                     'runOnNoteChange',
+                                     'runOnChildNoteCreation',
+                                     'runOnAttributeCreation',
+                                     'runOnAttributeChange',
+                                     'template',
+                                     'inherit',
+                                     'widget',
+                                     'renderNote',
+                                     'shareCss',
+                                     'shareJs',
+                                     'shareFavicon',
+                                     'executeButton',
+                                     'keepCurrentHoisting',
+                                     'color',
+                                     'toc',
+                                     'excludeFromNoteMap',
+                                     'docName',
+                                     'launcherType',
+                                     'builtinWidget',
+                                     'baseSize',
+                                     'growthFactor'
+                                    );
+
 UPDATE branches SET prefix = 'prefix' WHERE prefix IS NOT NULL AND prefix != 'recovered';
 UPDATE options SET value = 'anonymized' WHERE name IN
-                    ('documentId', 'documentSecret', 'encryptedDataKey', 
+                    ('documentId', 'documentSecret', 'encryptedDataKey',
-                     'passwordVerificationHash', 'passwordVerificationSalt', 
+                     'passwordVerificationHash', 'passwordVerificationSalt',
-                     'passwordDerivedKeySalt', 'username', 'syncServerHost', 'syncProxy') 
+                     'passwordDerivedKeySalt', 'username', 'syncServerHost', 'syncProxy')
                       AND value != '';
 
 VACUUM;

bin/tpl/trilium-no-cert-check.bat

@@ -1,5 +1,23 @@
+@echo off
+:: Try to get powershell to launch Trilium since it deals with UTF-8 characters in current path
+:: If there's no powershell available, fallback to unicode enabled command interpreter
+
+WHERE powershell.exe > NUL 2>&1
+IF %ERRORLEVEL% NEQ 0 GOTO BATCH ELSE GOTO POWERSHELL
+
+:POWERSHELL
+powershell -ExecutionPolicy Bypass -NonInteractive -NoLogo "Set-Item -Path Env:NODE_TLS_REJECT_UNAUTHORIZED -Value 0; ./trilium.exe"
+GOTO END
+
+:BATCH
+:: Make sure we support UTF-8 characters
+chcp 65001
+
+:: Get Current Trilium executable directory and compute data directory
 SET DIR=%~dp0
 set NODE_TLS_REJECT_UNAUTHORIZED=0
 cd %DIR%
-WHERE powershell.exe
+start trilium.exe
-IF %ERRORLEVEL% NEQ 0 (start trilium.exe) ELSE (powershell.exe ./trilium-no-cert-check.ps1)
+GOTO END
+
+:END

bin/tpl/trilium-no-cert-check.ps1

@@ -1,2 +0,0 @@
-Set-Item -Path Env:NODE_TLS_REJECT_UNAUTHORIZED -Value 0
-./trilium.exe

bin/tpl/trilium-portable.bat

@@ -1,5 +1,23 @@
+@echo off
+:: Try to get powershell to launch Trilium since it deals with UTF-8 characters in current path
+:: If there's no powershell available, fallback to unicode enabled command interpreter
+
+WHERE powershell.exe > NUL 2>&1
+IF %ERRORLEVEL% NEQ 0 GOTO BATCH ELSE GOTO POWERSHELL
+
+:POWERSHELL
+powershell -ExecutionPolicy Bypass -NonInteractive -NoLogo "Set-Item -Path Env:TRILIUM_DATA_DIR -Value './trilium-data'; ./trilium.exe"
+GOTO END
+
+:BATCH
+:: Make sure we support UTF-8 characters
+chcp 65001
+
+:: Get Current Trilium executable directory and compute data directory
 SET DIR=%~dp0
 SET TRILIUM_DATA_DIR=%DIR%\trilium-data
 cd %DIR%
-WHERE powershell.exe
+start trilium.exe
-IF %ERRORLEVEL% NEQ 0 (start trilium.exe) ELSE (powershell.exe ./trilium-portable.ps1)
+GOTO END
+
+:END

bin/tpl/trilium-portable.ps1

@@ -1,2 +0,0 @@
-Set-Item -Path Env:TRILIUM_DATA_DIR -Value './trilium-data'
-./trilium.exe

bin/tpl/trilium-safe-mode.bat

@@ -1,5 +1,23 @@
+@echo off
+:: Try to get powershell to launch Trilium since it deals with UTF-8 characters in current path
+:: If there's no powershell available, fallback to unicode enabled command interpreter
+
+WHERE powershell.exe > NUL 2>&1
+IF %ERRORLEVEL% NEQ 0 GOTO BATCH ELSE GOTO POWERSHELL
+
+:POWERSHELL
+powershell -ExecutionPolicy Bypass -NonInteractive -NoLogo "Set-Item -Path Env:TRILIUM_SAFE_MODE -Value 1; ./trilium.exe --disable-gpu"
+GOTO END
+
+:BATCH
+:: Make sure we support UTF-8 characters
+chcp 65001
+
+:: Get Current Trilium executable directory and compute data directory
 SET DIR=%~dp0
 SET TRILIUM_SAFE_MODE=1
 cd %DIR%
-WHERE powershell.exe
+start trilium.exe --disable-gpu
-IF %ERRORLEVEL% NEQ 0 (start trilium.exe) ELSE (powershell.exe ./trilium-safe-mode.ps1)
+GOTO END
+
+:END

bin/tpl/trilium-safe-mode.ps1

@@ -1,2 +0,0 @@
-Set-Item -Path Env:TRILIUM_SAFE_MODE -Value 1
-./trilium.exe

bin/tpl/trilium-safe-mode.sh

@@ -3,5 +3,5 @@
 DIR=`dirname "$0"`
 export TRILIUM_SAFE_MODE=1
 
-"$DIR/trilium"
+"$DIR/trilium" --disable-gpu
 

config-sample.ini

@@ -21,3 +21,9 @@ https=false
 # path to certificate (run "bash bin/generate-cert.sh" to generate self-signed certificate). Relevant only if https=true
 certPath=
 keyPath=
+# setting to give trust to reverse proxies, a comma-separated list of trusted rev. proxy IPs can be specified (CIDR notation is permitted),
+# alternatively 'true' will make use of the leftmost IP in X-Forwarded-For, ultimately an integer can be used to tell about the number of hops between
+# Trilium (which is hop 0) and the first trusted rev. proxy. 
+# once set, expressjs will use the X-Forwarded-For header set by the rev. proxy to determinate the real IPs of clients.
+# expressjs shortcuts are supported: loopback(127.0.0.1/8, ::1/128), linklocal(169.254.0.0/16, fe80::/10), uniquelocal(10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fc00::/7)
+trustedReverseProxy=false

db/TODO.txt

@@ -1,11 +1,6 @@
-- drop branches.utcDateCreated - not used for anything
-- drop options.utcDateCreated - not used for anything
 - isDeleted = 0 by default
 - rename openTabs to openNoteContexts
-- migrate black theme to dark theme
 - unify readOnly handling to a single attribute:
   * readOnly - like now
   * readOnly=auto - like without readOnly (used to override inherited readOnly)
   * readOnly=never - like autoReadOnlyDisabled
-- remove focusOnAttributesKeyboardShortcut
-- rename white theme to "light" theme (it's not completely white and matches well to dark theme)

db/migrations/0192__add_memberId_to_entity_changes.sql

@@ -1,4 +1,7 @@
-CREATE TABLE IF NOT EXISTS "mig_entity_changes" (
+DROP TABLE entity_changes;
+-- not preserving the data because of https://github.com/zadam/trilium/issues/3447
+
+CREATE TABLE IF NOT EXISTS "entity_changes" (
                                                     `id`	INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
                                                     `entityName`	TEXT NOT NULL,
                                                     `entityId`	TEXT NOT NULL,
@@ -11,13 +14,6 @@ CREATE TABLE IF NOT EXISTS "mig_entity_changes" (
                                                     `utcDateChanged` TEXT NOT NULL
 );
 
-INSERT INTO mig_entity_changes (id, entityName, entityId, hash, isErased, changeId, componentId, instanceId, isSynced, utcDateChanged)
-SELECT id, entityName, entityId, hash, isErased, changeId, '', '', isSynced, utcDateChanged FROM entity_changes;
-
-DROP TABLE  entity_changes;
-
-ALTER TABLE mig_entity_changes RENAME TO entity_changes;
-
 CREATE UNIQUE INDEX `IDX_entityChanges_entityName_entityId` ON "entity_changes" (
                                                                                  `entityName`,
                                                                                  `entityId`

db/migrations/0195__remove_recent_notes_from_entity_changes.sql

@@ -0,0 +1,2 @@
+-- removing potential remnants of recent notes in entity changes, see https://github.com/zadam/trilium/issues/2842
+DELETE FROM entity_changes WHERE entityName = 'recent_notes';

db/migrations/0196__rename_bulk_actions.sql

@@ -0,0 +1,2 @@
+UPDATE attributes SET value = replace(value, 'setLabelValue', 'updateLabelValue') WHERE name = 'action' AND type = 'label';
+UPDATE attributes SET value = replace(value, 'setRelationTarget', 'updateRelationTarget') WHERE name = 'action' AND type = 'label';

db/migrations/0197__NOOP.js

@@ -0,0 +1 @@
+module.exports = () => console.log("NOOP, increased because of protected notes IV change");

db/migrations/0198__rename_branchIds.sql

@@ -0,0 +1,6 @@
+UPDATE branches SET branchId = '_hidden__search' WHERE parentNoteId = 'hidden' AND noteId = 'search' AND isDeleted = 0;
+UPDATE branches SET branchId = 'root__globalNoteMap' WHERE parentNoteId = 'singles' AND noteId = 'globalnotemap' AND isDeleted = 0;
+UPDATE branches SET branchId = '_hidden__sqlConsole' WHERE parentNoteId = 'hidden' AND noteId = 'sqlconsole' AND isDeleted = 0;
+UPDATE branches SET branchId = 'root__hidden' WHERE parentNoteId = 'root' AND noteId = 'hidden' AND isDeleted = 0;
+UPDATE branches SET branchId = '_hidden__bulkAction' WHERE parentNoteId = 'hidden' AND noteId = 'bulkaction' AND isDeleted = 0;
+UPDATE branches SET branchId = '_hidden__share' WHERE parentNoteId = 'root' AND noteId = 'share' AND isDeleted = 0;

db/migrations/0199__rename_ids.sql

@@ -0,0 +1,53 @@
+UPDATE notes SET noteId = '_globalNoteMap', title = 'Note Map' WHERE noteId = 'globalnotemap';
+UPDATE note_contents SET noteId = '_globalNoteMap' WHERE noteId = 'globalnotemap';
+UPDATE note_revisions SET noteId = '_globalNoteMap' WHERE noteId = 'globalnotemap';
+UPDATE branches SET noteId = '_globalNoteMap' WHERE noteId = 'globalnotemap';
+UPDATE branches SET parentNoteId = '_globalNoteMap' WHERE parentNoteId = 'globalnotemap';
+UPDATE attributes SET noteId = '_globalNoteMap' WHERE noteId = 'globalnotemap';
+UPDATE attributes SET value = '_globalNoteMap' WHERE type = 'relation' AND value = 'globalnotemap';
+UPDATE entity_changes SET entityId = '_globalNoteMap' WHERE entityId = 'globalnotemap';
+
+UPDATE notes SET noteId = '_bulkAction', title = 'Bulk Action' WHERE noteId = 'bulkaction';
+UPDATE note_contents SET noteId = '_bulkAction' WHERE noteId = 'bulkaction';
+UPDATE note_revisions SET noteId = '_bulkAction' WHERE noteId = 'bulkaction';
+UPDATE branches SET parentNoteId = '_bulkAction' WHERE parentNoteId = 'bulkaction';
+UPDATE branches SET noteId = '_bulkAction' WHERE noteId = 'bulkaction';
+UPDATE attributes SET noteId = '_bulkAction' WHERE noteId = 'bulkaction';
+UPDATE attributes SET value = '_bulkAction' WHERE type = 'relation' AND value = 'bulkaction';
+UPDATE entity_changes SET entityId = '_bulkAction' WHERE entityId = 'bulkaction';
+
+UPDATE notes SET noteId = '_sqlConsole', title = 'SQL Console History' WHERE noteId = 'sqlconsole';
+UPDATE note_contents SET noteId = '_sqlConsole' WHERE noteId = 'sqlconsole';
+UPDATE note_revisions SET noteId = '_sqlConsole' WHERE noteId = 'sqlconsole';
+UPDATE branches SET noteId = '_sqlConsole' WHERE noteId = 'sqlconsole';
+UPDATE branches SET parentNoteId = '_sqlConsole' WHERE parentNoteId = 'sqlconsole';
+UPDATE attributes SET noteId = '_sqlConsole' WHERE noteId = 'sqlconsole';
+UPDATE attributes SET value = '_sqlConsole' WHERE type = 'relation' AND value = 'sqlconsole';
+UPDATE entity_changes SET entityId = '_sqlConsole' WHERE entityId = 'sqlconsole';
+
+UPDATE notes SET noteId = '_hidden', title = 'Hidden Notes' WHERE noteId = 'hidden';
+UPDATE note_contents SET noteId = '_hidden' WHERE noteId = 'hidden';
+UPDATE note_revisions SET noteId = '_hidden' WHERE noteId = 'hidden';
+UPDATE branches SET noteId = '_hidden', prefix = NULL WHERE noteId = 'hidden';
+UPDATE branches SET parentNoteId = '_hidden' WHERE parentNoteId = 'hidden';
+UPDATE attributes SET noteId = '_hidden' WHERE noteId = 'hidden';
+UPDATE attributes SET value = '_hidden' WHERE type = 'relation' AND value = 'hidden';
+UPDATE entity_changes SET entityId = '_hidden' WHERE entityId = 'hidden';
+
+UPDATE notes SET noteId = '_search', title = 'Search History' WHERE noteId = 'search';
+UPDATE note_contents SET noteId = '_search' WHERE noteId = 'search';
+UPDATE note_revisions SET noteId = '_search' WHERE noteId = 'search';
+UPDATE branches SET noteId = '_search' WHERE noteId = 'search';
+UPDATE branches SET parentNoteId = '_search' WHERE parentNoteId = 'search';
+UPDATE attributes SET noteId = '_search' WHERE noteId = 'search';
+UPDATE attributes SET value = '_search' WHERE type = 'relation' AND value = 'search';
+UPDATE entity_changes SET entityId = '_search' WHERE entityId = 'search';
+
+UPDATE notes SET noteId = '_share', title = 'Shared Notes' WHERE noteId = 'share';
+UPDATE note_contents SET noteId = '_share' WHERE noteId = 'share';
+UPDATE note_revisions SET noteId = '_share' WHERE noteId = 'share';
+UPDATE branches SET noteId = '_share' WHERE noteId = 'share';
+UPDATE branches SET parentNoteId = '_share' WHERE parentNoteId = 'share';
+UPDATE attributes SET noteId = '_share' WHERE noteId = 'share';
+UPDATE attributes SET value = '_share' WHERE type = 'relation' AND value = 'share';
+UPDATE entity_changes SET entityId = '_share' WHERE entityId = 'share';

db/migrations/0200__create_hidden_subtree.js

@@ -0,0 +1,12 @@
+module.exports = () => {
+    const hiddenSubtreeService = require('../../src/services/hidden_subtree');
+    const cls = require("../../src/services/cls");
+    const beccaLoader = require("../../src/becca/becca_loader");
+
+    cls.init(() => {
+        beccaLoader.load();
+        // make sure the hidden subtree exists since the subsequent migrations we will move some existing notes into it (share...)
+        // in previous releases hidden subtree was created lazily
+        hiddenSubtreeService.checkHiddenSubtree(true);
+    });
+};

db/migrations/0201__move_share_under_hidden.sql

@@ -0,0 +1,2 @@
+DELETE FROM branches WHERE noteId = '_share' AND parentNoteId != 'root' AND parentNoteId != '_hidden'; -- delete all other branches of _share if any
+UPDATE branches SET parentNoteId = '_hidden' WHERE noteId = '_share';

db/migrations/0202__move_global_note_map_under_hidden.sql

@@ -0,0 +1,2 @@
+DELETE FROM branches WHERE noteId = '_globalNoteMap' AND parentNoteId != 'singles' AND parentNoteId != '_hidden'; -- make sure there are no clones which would fail at the next line
+UPDATE branches SET parentNoteId = '_hidden' WHERE noteId = '_globalNoteMap';

db/migrations/0203__delete_singles_special_note.sql

@@ -0,0 +1,6 @@
+DELETE FROM branches WHERE noteId = 'singles';
+DELETE FROM notes WHERE noteId = 'singles';
+DELETE FROM note_contents WHERE noteId = 'singles';
+DELETE FROM note_revisions WHERE noteId = 'singles';
+DELETE FROM attributes WHERE noteId = 'singles';
+DELETE FROM entity_changes WHERE entityId = 'singles';

db/migrations/0204__migrate_bookmarks_to_clones.js

@@ -0,0 +1,21 @@
+module.exports = () => {
+    const cls = require("../../src/services/cls");
+    const cloningService = require("../../src/services/cloning");
+    const beccaLoader = require("../../src/becca/becca_loader");
+    const becca = require("../../src/becca/becca");
+
+    cls.init(() => {
+        beccaLoader.load();
+
+        for (const attr of becca.findAttributes('label','bookmarked')) {
+            cloningService.toggleNoteInParent(true, attr.noteId, '_lbBookmarks');
+
+            attr.markAsDeleted("0204__migrate_bookmarks_to_clones");
+        }
+
+        // bookmarkFolder used to work in 0.57 without the bookmarked label
+        for (const attr of becca.findAttributes('label','bookmarkFolder')) {
+            cloningService.toggleNoteInParent(true, attr.noteId, '_lbBookmarks');
+        }
+    });
+};

db/migrations/0205__rename_note_types.sql

@@ -0,0 +1,3 @@
+UPDATE notes SET type = 'relationMap' WHERE type = 'relation-map';
+UPDATE notes SET type = 'noteMap' WHERE type = 'note-map';
+UPDATE notes SET type = 'webView' WHERE type = 'web-view';

db/migrations/0206__delete_search_and_sql_console_history.js

@@ -0,0 +1,33 @@
+// the history was previously not exposed and the fact they were not cleaned up is rather a side-effect than an intention
+
+module.exports = () => {
+    const cls = require("../../src/services/cls");
+    const beccaLoader = require("../../src/becca/becca_loader");
+    const becca = require("../../src/becca/becca");
+
+    cls.init(() => {
+        beccaLoader.load();
+
+        // deleting just branches because they might be cloned (and therefore saved) also outside of the hidden subtree
+
+        const searchRoot = becca.getNote('_search');
+
+        for (const searchBranch of searchRoot.getChildBranches()) {
+            const searchNote = searchBranch.getNote();
+
+            if (searchNote.type === 'search') {
+                searchBranch.deleteBranch('0206__delete_search_and_sql_console_history');
+            }
+        }
+
+        const sqlConsoleRoot = becca.getNote('_sqlConsole');
+
+        for (const sqlConsoleBranch of sqlConsoleRoot.getChildBranches()) {
+            const sqlConsoleNote = sqlConsoleBranch.getNote();
+
+            if (sqlConsoleNote.type === 'code' && sqlConsoleNote.mime === 'text/x-sqlite;schema=trilium') {
+                sqlConsoleBranch.deleteBranch('0206__delete_search_and_sql_console_history');
+            }
+        }
+    });
+};

db/migrations/0207__rename_search_and_sql_console.sql

@@ -0,0 +1,2 @@
+UPDATE notes SET title = 'SQL Console History' WHERE noteId = '_sqlConsole';
+UPDATE notes SET title = 'Search History' WHERE noteId = '_search';

db/migrations/0208__remove_archived_from_hidden.js

@@ -0,0 +1,13 @@
+module.exports = () => {
+    const cls = require("../../src/services/cls");
+    const beccaLoader = require("../../src/becca/becca_loader");
+    const becca = require("../../src/becca/becca");
+
+    cls.init(() => {
+        beccaLoader.load();
+
+        for (const label of becca.getNote('_hidden').getLabels('archived')) {
+            label.markAsDeleted('0208__remove_archived_from_hidden');
+        }
+    });
+};

db/migrations/0209__rename_hoisted_labels.sql

@@ -0,0 +1,5 @@
+UPDATE attributes SET name = 'workspaceInbox' WHERE type = 'label' AND name = 'hoistedInbox';
+UPDATE entity_changes SET entityId = 'workspaceInbox' WHERE entityName = 'attributes' AND entityId = 'hoistedInbox';
+
+UPDATE attributes SET name = 'workspaceSearchHome' WHERE type = 'label' AND name = 'hoistedSearchHome';
+UPDATE entity_changes SET entityId = 'workspaceSearchHome' WHERE entityName = 'attributes' AND entityId = 'hoistedSearchHome';

db/migrations/0210__consistency_checks.js

@@ -0,0 +1,24 @@
+module.exports = async () => {
+    const cls = require("../../src/services/cls");
+    const beccaLoader = require("../../src/becca/becca_loader");
+    const log = require("../../src/services/log");
+    const consistencyChecks = require("../../src/services/consistency_checks");
+    const noteService = require("../../src/services/notes");
+
+    await cls.init(async () => {
+        // precaution for the 0211 migration
+        noteService.eraseDeletedNotesNow();
+
+        beccaLoader.load();
+
+        try {
+            // precaution before running 211 which might produce unique constraint problems if the DB was not consistent
+            consistencyChecks.runOnDemandChecksWithoutExclusiveLock(true);
+        }
+        catch (e) {
+            // consistency checks might start failing in the future if there's some incompatible migration down the road
+            // we can optimistically assume the DB is consistent and still continue
+            log.error(`Consistency checks failed in migration 0210: ${e.message} ${e.stack}`);
+        }
+    });
+};

db/migrations/0211__rename_branchIds.sql

@@ -0,0 +1,12 @@
+-- case based on isDeleted is needed, otherwise 2 branches (1 deleted, 1 not) might get the same ID
+UPDATE entity_changes SET entityId = COALESCE((
+    SELECT
+        CASE isDeleted
+            WHEN 0 THEN parentNoteId || '_' || noteId
+            WHEN 1 THEN branchId
+        END
+    FROM branches WHERE branchId = entityId
+), entityId)
+WHERE entityName = 'branches' AND isErased = 0;
+
+UPDATE branches SET branchId = parentNoteId || '_' || noteId WHERE isDeleted = 0;

db/migrations/0212__delete_all_attributes_of_named_notes.js

@@ -0,0 +1,27 @@
+module.exports = () => {
+    const cls = require("../../src/services/cls");
+    const beccaLoader = require("../../src/becca/becca_loader");
+    const becca = require("../../src/becca/becca");
+    const log = require("../../src/services/log");
+
+    cls.init(() => {
+        beccaLoader.load();
+
+        const hidden = becca.getNote("_hidden");
+
+        if (!hidden) {
+            log.info("MIGRATION 212: no _hidden note, skipping.");
+            return;
+        }
+
+        for (const noteId of hidden.getSubtreeNoteIds({includeHidden: true})) {
+            if (noteId.startsWith("_")) { // is "named" note
+                const note = becca.getNote(noteId);
+
+                for (const attr of note.getOwnedAttributes()) {
+                    attr.markAsDeleted("0212__delete_all_attributes_of_named_notes");
+                }
+            }
+        }
+    });
+};

db/migrations/0213__migrate_scripts.js

@@ -0,0 +1,48 @@
+module.exports = () => {
+    const beccaLoader = require("../../src/becca/becca_loader");
+    const becca = require("../../src/becca/becca");
+    const cls = require("../../src/services/cls");
+    const log = require("../../src/services/log");
+
+    cls.init(() => {
+        beccaLoader.load();
+
+        for (const note of Object.values(becca.notes)) {
+            try {
+                if (!note.isJavaScript()) {
+                    continue;
+                }
+
+                if (!note.mime?.endsWith('env=frontend') && !note.mime?.endsWith('env=backend')) {
+                    continue;
+                }
+
+                const origContent = note.getContent().toString();
+                const fixedContent = origContent
+                    .replaceAll("runOnServer", "runOnBackend")
+                    .replaceAll("api.refreshTree()", "")
+                    .replaceAll("addTextToActiveTabEditor", "addTextToActiveContextEditor")
+                    .replaceAll("getActiveTabNote", "getActiveContextNote")
+                    .replaceAll("getActiveTabTextEditor", "getActiveContextTextEditor")
+                    .replaceAll("getActiveTabNotePath", "getActiveContextNotePath")
+                    .replaceAll("getDateNote", "getDayNote")
+                    .replaceAll("utils.unescapeHtml", "unescapeHtml")
+                    .replaceAll("sortNotesByTitle", "sortNotes")
+                    .replaceAll("CollapsibleWidget", "RightPanelWidget")
+                    .replaceAll("TabAwareWidget", "NoteContextAwareWidget")
+                    .replaceAll("TabCachingWidget", "NoteContextAwareWidget")
+                    .replaceAll("NoteContextCachingWidget", "NoteContextAwareWidget");
+
+                if (origContent !== fixedContent) {
+                    log.info(`Replacing legacy API calls for note '${note.noteId}'`);
+
+                    note.saveNoteRevision();
+                    note.setContent(fixedContent);
+                }
+            }
+            catch (e) {
+                log.error(`Error during migration to 213 for note '${note.noteId}': ${e.message} ${e.stack}`);
+            }
+        }
+    });
+};

docker-compose.yml

@@ -1,17 +1,14 @@
 version: '2.1'
 services:
   trilium:
-    build:
-      context: .
     image: zadam/trilium
     restart: always
     environment:
-      - TRILIUM_DATA_DIR=/data
+      - TRILIUM_DATA_DIR=/home/node/trilium-data
     ports:
       - "8080:8080"
     volumes:
-      - trilium:/data
+      - trilium:/home/node/trilium-data
 
 volumes:
   trilium:
-

docker_healthcheck.js

@@ -0,0 +1,43 @@
+const http = require("http");
+const ini = require("ini");
+const fs = require("fs");
+const dataDir = require("./src/services/data_dir");
+const config = ini.parse(fs.readFileSync(dataDir.CONFIG_INI_PATH, 'utf-8'));
+
+if (config.https) {
+    // built-in TLS (terminated by trilium) is not supported yet, PRs are welcome
+    // for reverse proxy terminated TLS this will works since config.https will be false
+    process.exit(0);
+    return;
+}
+
+const port = require('./src/services/port');
+const host = require('./src/services/host');
+
+const options = { timeout: 2000 };
+
+const callback = res => {
+    console.log(`STATUS: ${res.statusCode}`);
+    if (res.statusCode === 200) {
+        process.exit(0);
+    } else {
+        process.exit(1);
+    }
+};
+
+let request;
+
+if (port !== 0) { // TCP socket.
+    const url = `http://${host}:${port}/api/health-check`;
+    request = http.request(url, options, callback);
+} else { // Unix socket.
+    options.socketPath = host;
+    options.path = '/api/health-check';
+    request = http.request(options, callback);
+}
+
+request.on("error", err => {
+    console.log("ERROR");
+    process.exit(1);
+});
+request.end();

docs/backend_api/AbstractEntity.html

@@ -1,434 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Class: AbstractEntity</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Class: AbstractEntity</h1>
-
-    
-
-
-
-
-<section>
-
-<header>
-    
-        <h2><span class="attribs"><span class="type-signature"></span></span>AbstractEntity<span class="signature">()</span><span class="type-signature"></span></h2>
-        
-            <div class="class-description">Base class for all backend entities.</div>
-        
-    
-</header>
-
-<article>
-    <div class="container-overview">
-    
-        
-
-    
-    <h2>Constructor</h2>
-    
-
-    
-    <h4 class="name" id="AbstractEntity"><span class="type-signature"></span>new AbstractEntity<span class="signature">()</span><span class="type-signature"></span></h4>
-    
-
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line16">line 16</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-    </div>
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-        <h3 class="subsection-title">Methods</h3>
-
-        
-            
-
-    
-
-    
-    <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDeleted<span class="signature">(deleteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
-    
-
-    
-
-
-
-<div class="description">
-    Mark the entity as (soft) deleted. It will be completely erased later.
-
-This is a low level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
-</div>
-
-
-
-
-
-
-
-
-
-    <h5>Parameters:</h5>
-    
-
-<table class="params">
-    <thead>
-    <tr>
-        
-        <th>Name</th>
-        
-
-        <th>Type</th>
-
-        
-        <th>Attributes</th>
-        
-
-        
-        <th>Default</th>
-        
-
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-
-    <tbody>
-    
-
-        <tr>
-            
-                <td class="name"><code>deleteId</code></td>
-            
-
-            <td class="type">
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-                    &lt;optional><br>
-                
-
-                
-
-                
-                </td>
-            
-
-            
-                <td class="default">
-                
-                    null
-                
-                </td>
-            
-
-            <td class="description last"></td>
-        </tr>
-
-    
-    </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line118">line 118</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-        
-            
-
-    
-
-    
-    <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="AbstractEntity.html">AbstractEntity</a>}</span></h4>
-    
-
-    
-
-
-
-<div class="description">
-    Saves entity - executes SQL, but doesn't commit the transaction on its own
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line73">line 73</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<h5>Returns:</h5>
-
-        
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type"><a href="AbstractEntity.html">AbstractEntity</a></span>
-
-
-    </dd>
-</dl>
-
-    
-
-
-
-
-
-        
-    
-
-    
-
-    
-</article>
-
-</section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
-</nav>
-
-<br class="clear">
-
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

docs/backend_api/BNoteRevision.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Class: NoteRevision</title>
+    <title>JSDoc: Class: BNoteRevision</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Class: NoteRevision</h1>
+    <h1 class="page-title">Class: BNoteRevision</h1>
 
     
 
@@ -28,7 +28,7 @@
 
 <header>
     
-        <h2><span class="attribs"><span class="type-signature"></span></span>NoteRevision<span class="signature">()</span><span class="type-signature"></span></h2>
+        <h2><span class="attribs"><span class="type-signature"></span></span>BNoteRevision<span class="signature">()</span><span class="type-signature"></span></h2>
         
             <div class="class-description">NoteRevision represents snapshot of note's title and content at some point in the past.
 It's used for seamless note versioning.</div>
@@ -46,7 +46,7 @@ It's used for seamless note versioning.</div>
     
 
     
-    <h4 class="name" id="NoteRevision"><span class="type-signature"></span>new NoteRevision<span class="signature">()</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="BNoteRevision"><span class="type-signature"></span>new BNoteRevision<span class="signature">()</span><span class="type-signature"></span></h4>
     
 
     
@@ -94,7 +94,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line17">line 17</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line17">line 17</a>
     </li></ul></dd>
     
 
@@ -134,7 +134,7 @@ It's used for seamless note versioning.</div>
 
 
     <ul>
-        <li><a href="AbstractEntity.html">AbstractEntity</a></li>
+        <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
     </ul>
 
 
@@ -155,6 +155,69 @@ It's used for seamless note versioning.</div>
 
         
             
+<h4 class="name" id="becca"><span class="type-signature">(protected) </span>becca<span class="type-signature"></span></h4>
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line53">line 53</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
 <h4 class="name" id="contentLength"><span class="type-signature"></span>contentLength<span class="type-signature"> :number</span></h4>
 
 
@@ -205,7 +268,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line48">line 48</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line48">line 48</a>
     </li></ul></dd>
     
 
@@ -273,7 +336,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line40">line 40</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line40">line 40</a>
     </li></ul></dd>
     
 
@@ -341,7 +404,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line38">line 38</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line38">line 38</a>
     </li></ul></dd>
     
 
@@ -409,7 +472,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line34">line 34</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line34">line 34</a>
     </li></ul></dd>
     
 
@@ -477,7 +540,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line32">line 32</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line32">line 32</a>
     </li></ul></dd>
     
 
@@ -545,7 +608,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line28">line 28</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line28">line 28</a>
     </li></ul></dd>
     
 
@@ -613,7 +676,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line26">line 26</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line26">line 26</a>
     </li></ul></dd>
     
 
@@ -681,7 +744,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line36">line 36</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line36">line 36</a>
     </li></ul></dd>
     
 
@@ -749,7 +812,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line30">line 30</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line30">line 30</a>
     </li></ul></dd>
     
 
@@ -817,7 +880,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line44">line 44</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line44">line 44</a>
     </li></ul></dd>
     
 
@@ -885,7 +948,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line42">line 42</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line42">line 42</a>
     </li></ul></dd>
     
 
@@ -953,7 +1016,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line46">line 46</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line46">line 46</a>
     </li></ul></dd>
     
 
@@ -975,6 +1038,362 @@ It's used for seamless note versioning.</div>
     
         <h3 class="subsection-title">Methods</h3>
 
+        
+            
+
+    
+
+    
+    <h4 class="name" id="addEntityChange"><span class="type-signature">(protected) </span>addEntityChange<span class="signature">()</span><span class="type-signature"></span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line62">line 62</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="beforeSaving"><span class="type-signature">(protected) </span>beforeSaving<span class="signature">()</span><span class="type-signature"></span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line18">line 18</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="generateHash"><span class="type-signature">(protected) </span>generateHash<span class="signature">()</span><span class="type-signature"></span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line30">line 30</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="generateIdIfNecessary"><span class="type-signature">(protected) </span>generateIdIfNecessary<span class="signature">()</span><span class="type-signature"></span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line23">line 23</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
         
             
 
@@ -1029,7 +1448,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line79">line 79</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line76">line 76</a>
     </li></ul></dd>
     
 
@@ -1131,7 +1550,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line143">line 143</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line140">line 140</a>
     </li></ul></dd>
     
 
@@ -1179,6 +1598,184 @@ It's used for seamless note versioning.</div>
 
 
 
+        
+            
+
+    
+
+    
+    <h4 class="name" id="getPojoToSave"><span class="type-signature">(protected) </span>getPojoToSave<span class="signature">()</span><span class="type-signature"></span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line74">line 74</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="getUtcDateChanged"><span class="type-signature">(protected) </span>getUtcDateChanged<span class="signature">()</span><span class="type-signature"></span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line45">line 45</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
         
             
 
@@ -1233,7 +1830,7 @@ It's used for seamless note versioning.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_note_revision.js.html">becca/entities/note_revision.js</a>, <a href="becca_entities_note_revision.js.html#line65">line 65</a>
+        <a href="becca_entities_bnote_revision.js.html">becca/entities/bnote_revision.js</a>, <a href="becca_entities_bnote_revision.js.html#line62">line 62</a>
     </li></ul></dd>
     
 
@@ -1391,7 +1988,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#markAsDeleted">AbstractEntity#markAsDeleted</a>
+        <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
     </li></ul></dd>
     
 
@@ -1414,7 +2011,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line118">line 118</a>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line128">line 128</a>
     </li></ul></dd>
     
 
@@ -1450,7 +2047,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-    <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="AbstractEntity.html">AbstractEntity</a>}</span></h4>
+    <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {this}</span></h4>
     
 
     
@@ -1484,7 +2081,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#save">AbstractEntity#save</a>
+        <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
     </li></ul></dd>
     
 
@@ -1507,7 +2104,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line73">line 73</a>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line83">line 83</a>
     </li></ul></dd>
     
 
@@ -1543,7 +2140,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     </dt>
     <dd>
         
-<span class="param-type"><a href="AbstractEntity.html">AbstractEntity</a></span>
+<span class="param-type">this</span>
 
 
     </dd>
@@ -1571,13 +2168,13 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/BOption.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Class: Attribute</title>
+    <title>JSDoc: Class: BOption</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Class: Attribute</h1>
+    <h1 class="page-title">Class: BOption</h1>
 
     
 
@@ -28,10 +28,9 @@
 
 <header>
     
-        <h2><span class="attribs"><span class="type-signature"></span></span>Attribute<span class="signature">()</span><span class="type-signature"></span></h2>
+        <h2><span class="attribs"><span class="type-signature"></span></span>BOption<span class="signature">()</span><span class="type-signature"></span></h2>
         
-            <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair)
+            <div class="class-description">Option represents name-value pair, either directly configurable by the user or some system property.</div>
-and relation (representing named relationship between source and target note)</div>
         
     
 </header>
@@ -46,7 +45,7 @@ and relation (representing named relationship between source and target note)</d
     
 
     
-    <h4 class="name" id="Attribute"><span class="type-signature"></span>new Attribute<span class="signature">()</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="BOption"><span class="type-signature"></span>new BOption<span class="signature">()</span><span class="type-signature"></span></h4>
     
 
     
@@ -94,7 +93,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line15">line 15</a>
+        <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line11">line 11</a>
     </li></ul></dd>
     
 
@@ -134,7 +133,7 @@ and relation (representing named relationship between source and target note)</d
 
 
     <ul>
-        <li><a href="AbstractEntity.html">AbstractEntity</a></li>
+        <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
     </ul>
 
 
@@ -155,23 +154,13 @@ and relation (representing named relationship between source and target note)</d
 
         
             
-<h4 class="name" id="attributeId"><span class="type-signature"></span>attributeId<span class="type-signature"> :string</span></h4>
+<h4 class="name" id="becca"><span class="type-signature">(protected) </span>becca<span class="type-signature"></span></h4>
 
 
 
 
 
 
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
 
 
 
@@ -185,6 +174,11 @@ and relation (representing named relationship between source and target note)</d
     
 
     
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
+    </li></ul></dd>
+    
 
     
 
@@ -205,7 +199,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line46">line 46</a>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line53">line 53</a>
     </li></ul></dd>
     
 
@@ -223,7 +217,7 @@ and relation (representing named relationship between source and target note)</d
 
         
             
-<h4 class="name" id="isInheritable"><span class="type-signature"></span>isInheritable<span class="type-signature"> :boolean</span></h4>
+<h4 class="name" id="isSynced"><span class="type-signature"></span>isSynced<span class="type-signature"> :boolean</span></h4>
 
 
 
@@ -273,7 +267,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line58">line 58</a>
+        <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line24">line 24</a>
     </li></ul></dd>
     
 
@@ -341,211 +335,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line52">line 52</a>
+        <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line20">line 20</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line48">line 48</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"> :int</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">int</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line54">line 54</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line50">line 50</a>
     </li></ul></dd>
     
 
@@ -613,7 +403,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line60">line 60</a>
+        <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line26">line 26</a>
     </li></ul></dd>
     
 
@@ -681,7 +471,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line56">line 56</a>
+        <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line22">line 22</a>
     </li></ul></dd>
     
 
@@ -709,7 +499,7 @@ and relation (representing named relationship between source and target note)</d
     
 
     
-    <h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4>
+    <h4 class="name" id="addEntityChange"><span class="type-signature">(protected) </span>addEntityChange<span class="signature">()</span><span class="type-signature"></span></h4>
     
 
     
@@ -737,6 +527,11 @@ and relation (representing named relationship between source and target note)</d
     
 
     
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
+    </li></ul></dd>
+    
 
     
 
@@ -757,7 +552,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line114">line 114</a>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line62">line 62</a>
     </li></ul></dd>
     
 
@@ -782,27 +577,6 @@ and relation (representing named relationship between source and target note)</d
 
 
 
-<h5>Returns:</h5>
-
-        
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type"><a href="Note.html">Note</a></span>
-|
-
-<span class="param-type">null</span>
-
-
-    </dd>
-</dl>
-
-    
 
 
 
@@ -814,7 +588,7 @@ and relation (representing named relationship between source and target note)</d
     
 
     
-    <h4 class="name" id="getTargetNote"><span class="type-signature"></span>getTargetNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Note.html">Note</a>|null}</span></h4>
+    <h4 class="name" id="beforeSaving"><span class="type-signature">(protected) </span>beforeSaving<span class="signature">()</span><span class="type-signature"></span></h4>
     
 
     
@@ -842,6 +616,11 @@ and relation (representing named relationship between source and target note)</d
     
 
     
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
+    </li></ul></dd>
+    
 
     
 
@@ -862,7 +641,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line121">line 121</a>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line18">line 18</a>
     </li></ul></dd>
     
 
@@ -887,27 +666,6 @@ and relation (representing named relationship between source and target note)</d
 
 
 
-<h5>Returns:</h5>
-
-        
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type"><a href="Note.html">Note</a></span>
-|
-
-<span class="param-type">null</span>
-
-
-    </dd>
-</dl>
-
-    
 
 
 
@@ -919,7 +677,7 @@ and relation (representing named relationship between source and target note)</d
     
 
     
-    <h4 class="name" id="isDefinition"><span class="type-signature"></span>isDefinition<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
+    <h4 class="name" id="generateHash"><span class="type-signature">(protected) </span>generateHash<span class="signature">()</span><span class="type-signature"></span></h4>
     
 
     
@@ -947,6 +705,11 @@ and relation (representing named relationship between source and target note)</d
     
 
     
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
+    </li></ul></dd>
+    
 
     
 
@@ -967,7 +730,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line136">line 136</a>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line30">line 30</a>
     </li></ul></dd>
     
 
@@ -992,24 +755,273 @@ and relation (representing named relationship between source and target note)</d
 
 
 
-<h5>Returns:</h5>
+
+
+
+
 
         
-
+            
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type">boolean</span>
-
-
-    </dd>
-</dl>
 
     
+
+    
+    <h4 class="name" id="generateIdIfNecessary"><span class="type-signature">(protected) </span>generateIdIfNecessary<span class="signature">()</span><span class="type-signature"></span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line23">line 23</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="getPojoToSave"><span class="type-signature">(protected) </span>getPojoToSave<span class="signature">()</span><span class="type-signature"></span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line74">line 74</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="getUtcDateChanged"><span class="type-signature">(protected) </span>getUtcDateChanged<span class="signature">()</span><span class="type-signature"></span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line45">line 45</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
 
@@ -1121,7 +1133,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#markAsDeleted">AbstractEntity#markAsDeleted</a>
+        <a href="AbstractBeccaEntity.html#markAsDeleted">AbstractBeccaEntity#markAsDeleted</a>
     </li></ul></dd>
     
 
@@ -1144,7 +1156,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line118">line 118</a>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line128">line 128</a>
     </li></ul></dd>
     
 
@@ -1180,7 +1192,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     
 
     
-    <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="AbstractEntity.html">AbstractEntity</a>}</span></h4>
+    <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {this}</span></h4>
     
 
     
@@ -1214,7 +1226,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#save">AbstractEntity#save</a>
+        <a href="AbstractBeccaEntity.html#save">AbstractBeccaEntity#save</a>
     </li></ul></dd>
     
 
@@ -1237,7 +1249,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line73">line 73</a>
+        <a href="becca_entities_abstract_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line83">line 83</a>
     </li></ul></dd>
     
 
@@ -1273,7 +1285,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
     </dt>
     <dd>
         
-<span class="param-type"><a href="AbstractEntity.html">AbstractEntity</a></span>
+<span class="param-type">this</span>
 
 
     </dd>
@@ -1301,13 +1313,13 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/Option.html

@@ -1,731 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Class: Option</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Class: Option</h1>
-
-    
-
-
-
-
-<section>
-
-<header>
-    
-        <h2><span class="attribs"><span class="type-signature"></span></span>Option<span class="signature">()</span><span class="type-signature"></span></h2>
-        
-            <div class="class-description">Option represents name-value pair, either directly configurable by the user or some system property.</div>
-        
-    
-</header>
-
-<article>
-    <div class="container-overview">
-    
-        
-
-    
-    <h2>Constructor</h2>
-    
-
-    
-    <h4 class="name" id="Option"><span class="type-signature"></span>new Option<span class="signature">()</span><span class="type-signature"></span></h4>
-    
-
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line11">line 11</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-    </div>
-
-    
-        <h3 class="subsection-title">Extends</h3>
-
-        
-
-
-    <ul>
-        <li><a href="AbstractEntity.html">AbstractEntity</a></li>
-    </ul>
-
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-        <h3 class="subsection-title">Members</h3>
-
-        
-            
-<h4 class="name" id="isSynced"><span class="type-signature"></span>isSynced<span class="type-signature"> :boolean</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">boolean</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line24">line 24</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line20">line 20</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="utcDateModified"><span class="type-signature"></span>utcDateModified<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line26">line 26</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="value"><span class="type-signature"></span>value<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line22">line 22</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-    
-
-    
-        <h3 class="subsection-title">Methods</h3>
-
-        
-            
-
-    
-
-    
-    <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDeleted<span class="signature">(deleteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
-    
-
-    
-
-
-
-<div class="description">
-    Mark the entity as (soft) deleted. It will be completely erased later.
-
-This is a low level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
-</div>
-
-
-
-
-
-
-
-
-
-    <h5>Parameters:</h5>
-    
-
-<table class="params">
-    <thead>
-    <tr>
-        
-        <th>Name</th>
-        
-
-        <th>Type</th>
-
-        
-        <th>Attributes</th>
-        
-
-        
-        <th>Default</th>
-        
-
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-
-    <tbody>
-    
-
-        <tr>
-            
-                <td class="name"><code>deleteId</code></td>
-            
-
-            <td class="type">
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-                    &lt;optional><br>
-                
-
-                
-
-                
-                </td>
-            
-
-            
-                <td class="default">
-                
-                    null
-                
-                </td>
-            
-
-            <td class="description last"></td>
-        </tr>
-
-    
-    </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-overrides">Overrides:</dt>
-    <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#markAsDeleted">AbstractEntity#markAsDeleted</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line118">line 118</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-        
-            
-
-    
-
-    
-    <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="AbstractEntity.html">AbstractEntity</a>}</span></h4>
-    
-
-    
-
-
-
-<div class="description">
-    Saves entity - executes SQL, but doesn't commit the transaction on its own
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-overrides">Overrides:</dt>
-    <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#save">AbstractEntity#save</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line73">line 73</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<h5>Returns:</h5>
-
-        
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type"><a href="AbstractEntity.html">AbstractEntity</a></span>
-
-
-    </dd>
-</dl>
-
-    
-
-
-
-
-
-        
-    
-
-    
-
-    
-</article>
-
-</section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
-</nav>
-
-<br class="clear">
-
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

docs/backend_api/RecentNote.html

@@ -1,663 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Class: RecentNote</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Class: RecentNote</h1>
-
-    
-
-
-
-
-<section>
-
-<header>
-    
-        <h2><span class="attribs"><span class="type-signature"></span></span>RecentNote<span class="signature">()</span><span class="type-signature"></span></h2>
-        
-            <div class="class-description">RecentNote represents recently visited note.</div>
-        
-    
-</header>
-
-<article>
-    <div class="container-overview">
-    
-        
-
-    
-    <h2>Constructor</h2>
-    
-
-    
-    <h4 class="name" id="RecentNote"><span class="type-signature"></span>new RecentNote<span class="signature">()</span><span class="type-signature"></span></h4>
-    
-
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line11">line 11</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-    </div>
-
-    
-        <h3 class="subsection-title">Extends</h3>
-
-        
-
-
-    <ul>
-        <li><a href="AbstractEntity.html">AbstractEntity</a></li>
-    </ul>
-
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-        <h3 class="subsection-title">Members</h3>
-
-        
-            
-<h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line19">line 19</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="notePath"><span class="type-signature"></span>notePath<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line21">line 21</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="utcDateCreated"><span class="type-signature"></span>utcDateCreated<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line23">line 23</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-    
-
-    
-        <h3 class="subsection-title">Methods</h3>
-
-        
-            
-
-    
-
-    
-    <h4 class="name" id="markAsDeleted"><span class="type-signature"></span>markAsDeleted<span class="signature">(deleteId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
-    
-
-    
-
-
-
-<div class="description">
-    Mark the entity as (soft) deleted. It will be completely erased later.
-
-This is a low level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
-</div>
-
-
-
-
-
-
-
-
-
-    <h5>Parameters:</h5>
-    
-
-<table class="params">
-    <thead>
-    <tr>
-        
-        <th>Name</th>
-        
-
-        <th>Type</th>
-
-        
-        <th>Attributes</th>
-        
-
-        
-        <th>Default</th>
-        
-
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-
-    <tbody>
-    
-
-        <tr>
-            
-                <td class="name"><code>deleteId</code></td>
-            
-
-            <td class="type">
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-                    &lt;optional><br>
-                
-
-                
-
-                
-                </td>
-            
-
-            
-                <td class="default">
-                
-                    null
-                
-                </td>
-            
-
-            <td class="description last"></td>
-        </tr>
-
-    
-    </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-overrides">Overrides:</dt>
-    <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#markAsDeleted">AbstractEntity#markAsDeleted</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line118">line 118</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-        
-            
-
-    
-
-    
-    <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="AbstractEntity.html">AbstractEntity</a>}</span></h4>
-    
-
-    
-
-
-
-<div class="description">
-    Saves entity - executes SQL, but doesn't commit the transaction on its own
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-overrides">Overrides:</dt>
-    <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#save">AbstractEntity#save</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line73">line 73</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<h5>Returns:</h5>
-
-        
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type"><a href="AbstractEntity.html">AbstractEntity</a></span>
-
-
-    </dd>
-</dl>
-
-    
-
-
-
-
-
-        
-    
-
-    
-
-    
-</article>
-
-</section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
-</nav>
-
-<br class="clear">
-
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

docs/backend_api/becca_entities_abstract_becca_entity.js.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Source: becca/entities/abstract_entity.js</title>
+    <title>JSDoc: Source: becca/entities/abstract_becca_entity.js</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Source: becca/entities/abstract_entity.js</h1>
+    <h1 class="page-title">Source: becca/entities/abstract_becca_entity.js</h1>
 
     
 
@@ -41,22 +41,25 @@ let becca = null;
 /**
  * Base class for all backend entities.
  */
-class AbstractEntity {
+class AbstractBeccaEntity {
+    /** @protected */
     beforeSaving() {
         this.generateIdIfNecessary();
     }
 
+    /** @protected */
     generateIdIfNecessary() {
         if (!this[this.constructor.primaryKeyName]) {
             this[this.constructor.primaryKeyName] = utils.newEntityId();
         }
     }
 
+    /** @protected */
     generateHash(isDeleted = false) {
         let contentToHash = "";
 
         for (const propertyName of this.constructor.hashedProperties) {
-            contentToHash += "|" + this[propertyName];
+            contentToHash += `|${this[propertyName]}`;
         }
 
         if (isDeleted) {
@@ -66,10 +69,15 @@ class AbstractEntity {
         return utils.hash(contentToHash).substr(0, 10);
     }
 
+    /** @protected */
     getUtcDateChanged() {
         return this.utcDateModified || this.utcDateCreated;
     }
 
+    /**
+     * @protected
+     * @returns {Becca}
+     */
     get becca() {
         if (!becca) {
             becca = require('../becca');
@@ -78,6 +86,7 @@ class AbstractEntity {
         return becca;
     }
 
+    /** @protected */
     addEntityChange(isDeleted = false) {
         entityChangesService.addEntityChange({
             entityName: this.constructor.entityName,
@@ -89,6 +98,7 @@ class AbstractEntity {
         });
     }
 
+    /** @protected */
     getPojoToSave() {
         return this.getPojo();
     }
@@ -96,16 +106,16 @@ class AbstractEntity {
     /**
      * Saves entity - executes SQL, but doesn't commit the transaction on its own
      *
-     * @returns {AbstractEntity}
+     * @returns {this}
      */
-    save() {
+    save(opts = {}) {
         const entityName = this.constructor.entityName;
         const primaryKeyName = this.constructor.primaryKeyName;
 
         const isNewEntity = !this[primaryKeyName];
 
         if (this.beforeSaving) {
-            this.beforeSaving();
+            this.beforeSaving(opts);
         }
 
         const pojo = this.getPojoToSave();
@@ -185,7 +195,7 @@ class AbstractEntity {
     }
 }
 
-module.exports = AbstractEntity;
+module.exports = AbstractBeccaEntity;
 </code></pre>
         </article>
     </section>
@@ -196,13 +206,13 @@ module.exports = AbstractEntity;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/becca_entities_battribute.js.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Source: becca/entities/attribute.js</title>
+    <title>JSDoc: Source: becca/entities/battribute.js</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Source: becca/entities/attribute.js</h1>
+    <h1 class="page-title">Source: becca/entities/battribute.js</h1>
 
     
 
@@ -28,19 +28,20 @@
         <article>
             <pre class="prettyprint source linenums"><code>"use strict";
 
-const Note = require('./note');
+const BNote = require('./bnote');
-const AbstractEntity = require("./abstract_entity");
+const AbstractBeccaEntity = require("./abstract_becca_entity");
 const sql = require("../../services/sql");
 const dateUtils = require("../../services/date_utils");
 const promotedAttributeDefinitionParser = require("../../services/promoted_attribute_definition_parser");
+const {sanitizeAttributeName} = require("../../services/sanitize_attribute_name");
 
 /**
  * Attribute is an abstract concept which has two real uses - label (key - value pair)
  * and relation (representing named relationship between source and target note)
  *
- * @extends AbstractEntity
+ * @extends AbstractBeccaEntity
  */
-class Attribute extends AbstractEntity {
+class BAttribute extends AbstractBeccaEntity {
     static get entityName() { return "attributes"; }
     static get primaryKeyName() { return "attributeId"; }
     static get hashedProperties() { return ["attributeId", "noteId", "type", "name", "value", "isInheritable"]; }
@@ -97,7 +98,7 @@ class Attribute extends AbstractEntity {
 
         if (!(this.noteId in this.becca.notes)) {
             // entities can come out of order in sync, create skeleton which will be filled later
-            this.becca.addNote(this.noteId, new Note({noteId: this.noteId}));
+            this.becca.addNote(this.noteId, new BNote({noteId: this.noteId}));
         }
 
         this.becca.notes[this.noteId].ownedAttributes.push(this);
@@ -113,9 +114,23 @@ class Attribute extends AbstractEntity {
         }
     }
 
+    validate() {
+        if (!["label", "relation"].includes(this.type)) {
+            throw new Error(`Invalid attribute type '${this.type}' in attribute '${this.attributeId}' of note '${this.noteId}'`);
+        }
+
+        if (!this.name?.trim()) {
+            throw new Error(`Invalid empty name in attribute '${this.attributeId}' of note '${this.noteId}'`);
+        }
+
+        if (this.type === 'relation' &amp;&amp; !(this.value in this.becca.notes)) {
+            throw new Error(`Cannot save relation '${this.name}' of note '${this.noteId}' since it target not existing note '${this.value}'.`);
+        }
+    }
+
     get isAffectingSubtree() {
         return this.isInheritable
-            || (this.type === 'relation' &amp;&amp; this.name === 'template');
+            || (this.type === 'relation' &amp;&amp; ['template', 'inherit'].includes(this.name));
     }
 
     get targetNoteId() { // alias
@@ -137,14 +152,20 @@ class Attribute extends AbstractEntity {
     }
 
     /**
-     * @returns {Note|null}
+     * @returns {BNote|null}
      */
     getNote() {
-        return this.becca.getNote(this.noteId);
+        const note = this.becca.getNote(this.noteId);
+
+        if (!note) {
+            throw new Error(`Note '${this.noteId}' of attribute '${this.attributeId}', type '${this.type}', name '${this.name}' does not exist.`);
+        }
+
+        return note;
     }
 
     /**
-     * @returns {Note|null}
+     * @returns {BNote|null}
      */
     getTargetNote() {
         if (this.type !== 'relation') {
@@ -159,7 +180,7 @@ class Attribute extends AbstractEntity {
     }
 
     /**
-     * @return {boolean}
+     * @returns {boolean}
      */
     isDefinition() {
         return this.type === 'label' &amp;&amp; (this.name.startsWith('label:') || this.name.startsWith('relation:'));
@@ -183,12 +204,14 @@ class Attribute extends AbstractEntity {
         return !(this.attributeId in this.becca.attributes);
     }
 
-    beforeSaving() {
+    beforeSaving(opts = {}) {
-        if (!this.value) {
+        if (!opts.skipValidation) {
-            if (this.type === 'relation') {
+            this.validate();
-                throw new Error(`Cannot save relation ${this.name} since it does not target any note.`);
+        }
-            }
 
+        this.name = sanitizeAttributeName(this.name);
+
+        if (!this.value) {
             // null value isn't allowed
             this.value = "";
         }
@@ -224,7 +247,7 @@ class Attribute extends AbstractEntity {
     }
 
     createClone(type, name, value, isInheritable) {
-        return new Attribute({
+        return new BAttribute({
             noteId: this.noteId,
             type: type,
             name: name,
@@ -236,7 +259,7 @@ class Attribute extends AbstractEntity {
     }
 }
 
-module.exports = Attribute;
+module.exports = BAttribute;
 </code></pre>
         </article>
     </section>
@@ -247,13 +270,13 @@ module.exports = Attribute;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/becca_entities_bbranch.js.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Source: becca/entities/branch.js</title>
+    <title>JSDoc: Source: becca/entities/bbranch.js</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Source: becca/entities/branch.js</h1>
+    <h1 class="page-title">Source: becca/entities/bbranch.js</h1>
 
     
 
@@ -28,22 +28,24 @@
         <article>
             <pre class="prettyprint source linenums"><code>"use strict";
 
-const Note = require('./note');
+const BNote = require('./bnote');
-const AbstractEntity = require("./abstract_entity");
+const AbstractBeccaEntity = require("./abstract_becca_entity");
-const sql = require("../../services/sql");
 const dateUtils = require("../../services/date_utils");
-const utils = require("../../services/utils.js");
+const utils = require("../../services/utils");
-const TaskContext = require("../../services/task_context.js");
+const TaskContext = require("../../services/task_context");
-const cls = require("../../services/cls.js");
+const cls = require("../../services/cls");
-const log = require("../../services/log.js");
+const log = require("../../services/log");
 
 /**
  * Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
  * parents.
  *
- * @extends AbstractEntity
+ * Note that you should not rely on the branch's identity, since it can change easily with a note's move.
+ * Always check noteId instead.
+ *
+ * @extends AbstractBeccaEntity
  */
-class Branch extends AbstractEntity {
+class BBranch extends AbstractBeccaEntity {
     static get entityName() { return "branches"; }
     static get primaryKeyName() { return "branchId"; }
     // notePosition is not part of hash because it would produce a lot of updates in case of reordering
@@ -79,7 +81,7 @@ class Branch extends AbstractEntity {
         this.noteId = noteId;
         /** @type {string} */
         this.parentNoteId = parentNoteId;
-        /** @type {string} */
+        /** @type {string|null} */
         this.prefix = prefix;
         /** @type {int} */
         this.notePosition = notePosition;
@@ -98,31 +100,32 @@ class Branch extends AbstractEntity {
 
         this.becca.childParentToBranch[`${this.noteId}-${this.parentNoteId}`] = this;
 
-        if (this.branchId === 'root') {
+        const childNote = this.childNote;
+
+        if (!childNote.parentBranches.includes(this)) {
+            childNote.parentBranches.push(this);
+        }
+
+        if (this.noteId === 'root') {
             return;
         }
 
-        const childNote = this.childNote;
         const parentNote = this.parentNote;
 
         if (!childNote.parents.includes(parentNote)) {
             childNote.parents.push(parentNote);
         }
 
-        if (!childNote.parentBranches.includes(this)) {
-            childNote.parentBranches.push(this);
-        }
-
         if (!parentNote.children.includes(childNote)) {
             parentNote.children.push(childNote);
         }
     }
 
-    /** @returns {Note} */
+    /** @returns {BNote} */
     get childNote() {
         if (!(this.noteId in this.becca.notes)) {
             // entities can come out of order in sync/import, create skeleton which will be filled later
-            this.becca.addNote(this.noteId, new Note({noteId: this.noteId}));
+            this.becca.addNote(this.noteId, new BNote({noteId: this.noteId}));
         }
 
         return this.becca.notes[this.noteId];
@@ -132,11 +135,11 @@ class Branch extends AbstractEntity {
         return this.childNote;
     }
 
-    /** @returns {Note} */
+    /** @returns {BNote|undefined} - root branch will have undefined parent, all other branches have to have a parent note */
     get parentNote() {
-        if (!(this.parentNoteId in this.becca.notes)) {
+        if (!(this.parentNoteId in this.becca.notes) &amp;&amp; this.parentNoteId !== 'none') {
             // entities can come out of order in sync/import, create skeleton which will be filled later
-            this.becca.addNote(this.parentNoteId, new Note({noteId: this.parentNoteId}));
+            this.becca.addNote(this.parentNoteId, new BNote({noteId: this.parentNoteId}));
         }
 
         return this.becca.notes[this.parentNoteId];
@@ -146,13 +149,26 @@ class Branch extends AbstractEntity {
         return !(this.branchId in this.becca.branches);
     }
 
+    /**
+     * Branch is weak when its existence should not hinder deletion of its note.
+     * As a result, note with only weak branches should be immediately deleted.
+     * An example is shared or bookmarked clones - they are created automatically and exist for technical reasons,
+     * not as user-intended actions. From user perspective, they don't count as real clones and for the purpose
+     * of deletion should not act as a clone.
+     *
+     * @returns {boolean}
+     */
+    get isWeak() {
+        return ['_share', '_lbBookmarks'].includes(this.parentNoteId);
+    }
+
     /**
      * Delete a branch. If this is a last note's branch, delete the note as well.
      *
      * @param {string} [deleteId] - optional delete identified
      * @param {TaskContext} [taskContext]
      *
-     * @return {boolean} - true if note has been deleted, false otherwise
+     * @returns {boolean} - true if note has been deleted, false otherwise
      */
     deleteBranch(deleteId, taskContext) {
         if (!deleteId) {
@@ -165,8 +181,19 @@ class Branch extends AbstractEntity {
 
         taskContext.increaseProgressCount();
 
-        if (this.branchId === 'root'
+        const note = this.getNote();
-            || this.noteId === 'root'
+
+        if (!taskContext.noteDeletionHandlerTriggered) {
+            const parentBranches = note.getParentBranches();
+
+            if (parentBranches.length === 1 &amp;&amp; parentBranches[0] === this) {
+                // needs to be run before branches and attributes are deleted and thus attached relations disappear
+                const handlers = require("../../services/handlers");
+                handlers.runAttachedRelations(note, 'runOnNoteDeletion', note);
+            }
+        }
+
+        if (this.noteId === 'root'
             || this.noteId === cls.getHoistedNoteId()) {
 
             throw new Error("Can't delete root or hoisted branch/note");
@@ -174,17 +201,22 @@ class Branch extends AbstractEntity {
 
         this.markAsDeleted(deleteId);
 
-        const note = this.getNote();
+        const notDeletedBranches = note.getStrongParentBranches();
-        const notDeletedBranches = note.getParentBranches();
 
         if (notDeletedBranches.length === 0) {
+            for (const weakBranch of note.getParentBranches()) {
+                weakBranch.markAsDeleted(deleteId);
+            }
+
             for (const childBranch of note.getChildBranches()) {
                 childBranch.deleteBranch(deleteId, taskContext);
             }
 
             // first delete children and then parent - this will show up better in recent changes
 
-            log.info("Deleting note " + note.noteId);
+            log.info(`Deleting note ${note.noteId}`);
+
+            this.becca.notes[note.noteId].isBeingDeleted = true;
 
             for (const attribute of note.getOwnedAttributes()) {
                 attribute.markAsDeleted(deleteId);
@@ -204,16 +236,34 @@ class Branch extends AbstractEntity {
     }
 
     beforeSaving() {
+        if (!this.noteId || !this.parentNoteId) {
+            throw new Error(`noteId and parentNoteId are mandatory properties for Branch`);
+        }
+
+        this.branchId = `${this.parentNoteId}_${this.noteId}`;
+
         if (this.notePosition === undefined || this.notePosition === null) {
-            // TODO finding new position can be refactored into becca
+            let maxNotePos = 0;
-            const maxNotePos = sql.getValue('SELECT MAX(notePosition) FROM branches WHERE parentNoteId = ? AND isDeleted = 0', [this.parentNoteId]);
+
-            this.notePosition = maxNotePos === null ? 0 : maxNotePos + 10;
+            for (const childBranch of this.parentNote.getChildBranches()) {
+                if (maxNotePos &lt; childBranch.notePosition
+                    &amp;&amp; childBranch.noteId !== '_hidden' // hidden has very large notePosition to always stay last
+                ) {
+                    maxNotePos = childBranch.notePosition;
+                }
+            }
+
+            this.notePosition = maxNotePos + 10;
         }
 
         if (!this.isExpanded) {
             this.isExpanded = false;
         }
 
+        if (!this.prefix?.trim()) {
+            this.prefix = null;
+        }
+
         this.utcDateModified = dateUtils.utcNowDateTime();
 
         super.beforeSaving();
@@ -235,17 +285,24 @@ class Branch extends AbstractEntity {
     }
 
     createClone(parentNoteId, notePosition) {
-        return new Branch({
+        const existingBranch = this.becca.getBranchFromChildAndParent(this.noteId, parentNoteId);
-            noteId: this.noteId,
+
-            parentNoteId: parentNoteId,
+        if (existingBranch) {
-            notePosition: notePosition,
+            existingBranch.notePosition = notePosition;
-            prefix: this.prefix,
+            return existingBranch;
-            isExpanded: this.isExpanded
+        } else {
-        });
+            return new BBranch({
+                noteId: this.noteId,
+                parentNoteId: parentNoteId,
+                notePosition: notePosition,
+                prefix: this.prefix,
+                isExpanded: this.isExpanded
+            });
+        }
     }
 }
 
-module.exports = Branch;
+module.exports = BBranch;
 </code></pre>
         </article>
     </section>
@@ -256,13 +313,13 @@ module.exports = Branch;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/becca_entities_betapi_token.js.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Source: becca/entities/etapi_token.js</title>
+    <title>JSDoc: Source: becca/entities/betapi_token.js</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Source: becca/entities/etapi_token.js</h1>
+    <h1 class="page-title">Source: becca/entities/betapi_token.js</h1>
 
     
 
@@ -29,7 +29,7 @@
             <pre class="prettyprint source linenums"><code>"use strict";
 
 const dateUtils = require('../../services/date_utils');
-const AbstractEntity = require("./abstract_entity");
+const AbstractBeccaEntity = require("./abstract_becca_entity");
 
 /**
  * EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications.
@@ -40,9 +40,9 @@ const AbstractEntity = require("./abstract_entity");
  * The format user is presented with is "&lt;etapiTokenId>_&lt;tokenHash>". This is also called "authToken" to distinguish it
  * from tokenHash and token.
  *
- * @extends AbstractEntity
+ * @extends AbstractBeccaEntity
  */
-class EtapiToken extends AbstractEntity {
+class BEtapiToken extends AbstractBeccaEntity {
     static get entityName() { return "etapi_tokens"; }
     static get primaryKeyName() { return "etapiTokenId"; }
     static get hashedProperties() { return ["etapiTokenId", "name", "tokenHash", "utcDateCreated", "utcDateModified", "isDeleted"]; }
@@ -103,7 +103,7 @@ class EtapiToken extends AbstractEntity {
     }
 }
 
-module.exports = EtapiToken;
+module.exports = BEtapiToken;
 </code></pre>
         </article>
     </section>
@@ -114,13 +114,13 @@ module.exports = EtapiToken;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/becca_entities_bnote_revision.js.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Source: becca/entities/note_revision.js</title>
+    <title>JSDoc: Source: becca/entities/bnote_revision.js</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Source: becca/entities/note_revision.js</h1>
+    <h1 class="page-title">Source: becca/entities/bnote_revision.js</h1>
 
     
 
@@ -34,20 +34,20 @@ const sql = require('../../services/sql');
 const dateUtils = require('../../services/date_utils');
 const becca = require('../becca');
 const entityChangesService = require('../../services/entity_changes');
-const AbstractEntity = require("./abstract_entity");
+const AbstractBeccaEntity = require("./abstract_becca_entity");
 
 /**
  * NoteRevision represents snapshot of note's title and content at some point in the past.
  * It's used for seamless note versioning.
  *
- * @extends AbstractEntity
+ * @extends AbstractBeccaEntity
  */
-class NoteRevision extends AbstractEntity {
+class BNoteRevision extends AbstractBeccaEntity {
     static get entityName() { return "note_revisions"; }
     static get primaryKeyName() { return "noteRevisionId"; }
     static get hashedProperties() { return ["noteRevisionId", "noteId", "title", "isProtected", "dateLastEdited", "dateCreated", "utcDateLastEdited", "utcDateCreated", "utcDateModified"]; }
 
-    constructor(row) {
+    constructor(row, titleDecrypted = false) {
         super();
 
         /** @type {string} */
@@ -75,13 +75,10 @@ class NoteRevision extends AbstractEntity {
         /** @type {number} */
         this.contentLength = row.contentLength;
 
-        if (this.isProtected) {
+        if (this.isProtected &amp;&amp; !titleDecrypted) {
-            if (protectedSessionService.isProtectedSessionAvailable()) {
+            this.title = protectedSessionService.isProtectedSessionAvailable()
-                this.title = protectedSessionService.decryptString(this.title);
+                ? protectedSessionService.decryptString(this.title)
-            }
+                : "[protected]";
-            else {
-                this.title = "[protected]";
-            }
         }
     }
 
@@ -96,8 +93,8 @@ class NoteRevision extends AbstractEntity {
 
     /*
      * Note revision content has quite special handling - it's not a separate entity, but a lazily loaded
-     * part of NoteRevision entity with it's own sync. Reason behind this hybrid design is that
+     * part of NoteRevision entity with its own sync. Reason behind this hybrid design is that
-     * content can be quite large and it's not necessary to load it / fill memory for any note access even
+     * content can be quite large, and it's not necessary to load it / fill memory for any note access even
      * if we don't need a content, especially for bulk operations like search.
      *
      * This is the same approach as is used for Note's content.
@@ -112,7 +109,7 @@ class NoteRevision extends AbstractEntity {
                 return undefined;
             }
             else {
-                throw new Error("Cannot find note revision content for noteRevisionId=" + this.noteRevisionId);
+                throw new Error(`Cannot find note revision content for noteRevisionId=${this.noteRevisionId}`);
             }
         }
 
@@ -137,7 +134,7 @@ class NoteRevision extends AbstractEntity {
         }
     }
 
-    setContent(content, ignoreMissingProtectedSession = false) {
+    setContent(content) {
         const pojo = {
             noteRevisionId: this.noteRevisionId,
             content: content,
@@ -148,14 +145,14 @@ class NoteRevision extends AbstractEntity {
             if (protectedSessionService.isProtectedSessionAvailable()) {
                 pojo.content = protectedSessionService.encrypt(pojo.content);
             }
-            else if (!ignoreMissingProtectedSession) {
+            else {
                 throw new Error(`Cannot update content of noteRevisionId=${this.noteRevisionId} since we're out of protected session.`);
             }
         }
 
         sql.upsert("note_revision_contents", "noteRevisionId", pojo);
 
-        const hash = utils.hash(this.noteRevisionId + "|" + pojo.content.toString());
+        const hash = utils.hash(`${this.noteRevisionId}|${pojo.content.toString()}`);
 
         entityChangesService.addEntityChange({
             entityName: 'note_revision_contents',
@@ -197,14 +194,12 @@ class NoteRevision extends AbstractEntity {
             utcDateLastEdited: this.utcDateLastEdited,
             utcDateCreated: this.utcDateCreated,
             utcDateModified: this.utcDateModified,
-            content: this.content,
             contentLength: this.contentLength
         };
     }
 
     getPojoToSave() {
         const pojo = this.getPojo();
-        delete pojo.content; // not getting persisted
         delete pojo.contentLength; // not getting persisted
 
         if (pojo.isProtected) {
@@ -221,7 +216,7 @@ class NoteRevision extends AbstractEntity {
     }
 }
 
-module.exports = NoteRevision;
+module.exports = BNoteRevision;
 </code></pre>
         </article>
     </section>
@@ -232,13 +227,13 @@ module.exports = NoteRevision;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/becca_entities_boption.js.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Source: becca/entities/option.js</title>
+    <title>JSDoc: Source: becca/entities/boption.js</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Source: becca/entities/option.js</h1>
+    <h1 class="page-title">Source: becca/entities/boption.js</h1>
 
     
 
@@ -29,14 +29,14 @@
             <pre class="prettyprint source linenums"><code>"use strict";
 
 const dateUtils = require('../../services/date_utils');
-const AbstractEntity = require("./abstract_entity");
+const AbstractBeccaEntity = require("./abstract_becca_entity");
 
 /**
  * Option represents name-value pair, either directly configurable by the user or some system property.
  *
- * @extends AbstractEntity
+ * @extends AbstractBeccaEntity
  */
-class Option extends AbstractEntity {
+class BOption extends AbstractBeccaEntity {
     static get entityName() { return "options"; }
     static get primaryKeyName() { return "name"; }
     static get hashedProperties() { return ["name", "value"]; }
@@ -72,7 +72,7 @@ class Option extends AbstractEntity {
     }
 }
 
-module.exports = Option;
+module.exports = BOption;
 </code></pre>
         </article>
     </section>
@@ -83,13 +83,13 @@ module.exports = Option;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/becca_entities_brecent_note.js.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Source: becca/entities/recent_note.js</title>
+    <title>JSDoc: Source: becca/entities/brecent_note.js</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Source: becca/entities/recent_note.js</h1>
+    <h1 class="page-title">Source: becca/entities/brecent_note.js</h1>
 
     
 
@@ -29,14 +29,14 @@
             <pre class="prettyprint source linenums"><code>"use strict";
 
 const dateUtils = require('../../services/date_utils');
-const AbstractEntity = require("./abstract_entity");
+const AbstractBeccaEntity = require("./abstract_becca_entity");
 
 /**
  * RecentNote represents recently visited note.
  *
- * @extends AbstractEntity
+ * @extends AbstractBeccaEntity
  */
-class RecentNote extends AbstractEntity {
+class BRecentNote extends AbstractBeccaEntity {
     static get entityName() { return "recent_notes"; }
     static get primaryKeyName() { return "noteId"; }
 
@@ -60,7 +60,7 @@ class RecentNote extends AbstractEntity {
     }
 }
 
-module.exports = RecentNote;
+module.exports = BRecentNote;
 </code></pre>
         </article>
     </section>
@@ -71,13 +71,13 @@ module.exports = RecentNote;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/index.html

@@ -50,13 +50,13 @@
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/module-sql.html

@@ -28,8 +28,6 @@
 
 <header>
     
-        
-    
 </header>
 
 <article>
@@ -38,6 +36,50 @@
         
 
         
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line3">line 3</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+        
     
     </div>
 
@@ -208,7 +250,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line355">line 355</a>
+        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line364">line 364</a>
     </li></ul></dd>
     
 
@@ -388,7 +430,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line346">line 346</a>
+        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line355">line 355</a>
     </li></ul></dd>
     
 
@@ -590,7 +632,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line336">line 336</a>
+        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line345">line 345</a>
     </li></ul></dd>
     
 
@@ -792,7 +834,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line312">line 312</a>
+        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line321">line 321</a>
     </li></ul></dd>
     
 
@@ -994,7 +1036,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line323">line 323</a>
+        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line332">line 332</a>
     </li></ul></dd>
     
 
@@ -1196,7 +1238,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line302">line 302</a>
+        <a href="services_sql.js.html">services/sql.js</a>, <a href="services_sql.js.html#line311">line 311</a>
     </li></ul></dd>
     
 
@@ -1252,13 +1294,13 @@
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/services_backend_script_api.js.html

@@ -42,37 +42,40 @@ const appInfo = require('./app_info');
 const searchService = require('./search/services/search');
 const SearchContext = require("./search/search_context");
 const becca = require("../becca/becca");
+const ws = require("./ws");
+const SpacedUpdate = require("./spaced_update");
+const specialNotesService = require("./special_notes");
+const branchService = require("./branches");
+const exportService = require("./export/zip");
 
 /**
- * This is the main backend API interface for scripts. It's published in the local "api" object.
+ * <p>This is the main backend API interface for scripts. All the properties and methods are published in the "api" object
+ * available in the JS backend notes. You can use e.g. <code>api.log(api.startNote.title);</code></p>
  *
  * @constructor
- * @hideconstructor
  */
 function BackendScriptApi(currentNote, apiParams) {
-    /** @property {Note} note where script started executing */
+    /** @property {BNote} note where script started executing */
     this.startNote = apiParams.startNote;
-    /** @property {Note} note where script is currently executing. Don't mix this up with concept of active note */
+    /** @property {BNote} note where script is currently executing. Don't mix this up with concept of active note */
     this.currentNote = currentNote;
-    /** @property {Entity} entity whose event triggered this executions */
+    /** @property {AbstractBeccaEntity} entity whose event triggered this executions */
     this.originEntity = apiParams.originEntity;
 
     for (const key in apiParams) {
         this[key] = apiParams[key];
     }
 
-    /** @property {axios} Axios library for HTTP requests. See https://axios-http.com/ for documentation */
+    /**
+     * @property {axios} Axios library for HTTP requests. See {@link https://axios-http.com} for documentation
+     * @deprecated use native (browser compatible) fetch() instead
+     */
     this.axios = axios;
-    /** @property {dayjs} day.js library for date manipulation. See https://day.js.org/ for documentation */
+    /** @property {dayjs} day.js library for date manipulation. See {@link https://day.js.org} for documentation */
     this.dayjs = dayjs;
-    /** @property {axios} xml2js library for XML parsing. See https://github.com/Leonidas-from-XIV/node-xml2js for documentation */
+    /** @property {axios} xml2js library for XML parsing. See {@link https://github.com/Leonidas-from-XIV/node-xml2js} for documentation */
     this.xml2js = xml2js;
 
-    // DEPRECATED - use direct api.unescapeHtml
-    this.utils = {
-        unescapeHtml: utils.unescapeHtml
-    };
-
     /**
      * Instance name identifies particular Trilium instance. It can be useful for scripts
      * if some action needs to happen on only one specific instance.
@@ -84,32 +87,32 @@ function BackendScriptApi(currentNote, apiParams) {
     /**
      * @method
      * @param {string} noteId
-     * @returns {Note|null}
+     * @returns {BNote|null}
      */
     this.getNote = noteId => becca.getNote(noteId);
 
     /**
      * @method
      * @param {string} branchId
-     * @returns {Branch|null}
+     * @returns {BBranch|null}
      */
     this.getBranch = branchId => becca.getBranch(branchId);
 
     /**
      * @method
      * @param {string} attributeId
-     * @returns {Attribute|null}
+     * @returns {BAttribute|null}
      */
     this.getAttribute = attributeId => becca.getAttribute(attributeId);
 
     /**
      * This is a powerful search method - you can search by attributes and their values, e.g.:
-     * "#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search
+     * "#dateModified =* MONTH AND #log". See {@link https://github.com/zadam/trilium/wiki/Search} for full documentation for all options
      *
      * @method
      * @param {string} query
      * @param {Object} [searchParams]
-     * @returns {Note[]}
+     * @returns {BNote[]}
      */
     this.searchForNotes = (query, searchParams = {}) => {
         if (searchParams.includeArchivedNotes === undefined) {
@@ -128,12 +131,12 @@ function BackendScriptApi(currentNote, apiParams) {
 
     /**
      * This is a powerful search method - you can search by attributes and their values, e.g.:
-     * "#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search
+     * "#dateModified =* MONTH AND #log". See {@link https://github.com/zadam/trilium/wiki/Search} for full documentation for all options
      *
      * @method
      * @param {string} query
      * @param {Object} [searchParams]
-     * @returns {Note|null}
+     * @returns {BNote|null}
      */
     this.searchForNote = (query, searchParams = {}) => {
         const notes = this.searchForNotes(query, searchParams);
@@ -147,7 +150,7 @@ function BackendScriptApi(currentNote, apiParams) {
      * @method
      * @param {string} name - attribute name
      * @param {string} [value] - attribute value
-     * @returns {Note[]}
+     * @returns {BNote[]}
      */
     this.getNotesWithLabel = attributeService.getNotesWithLabel;
 
@@ -157,7 +160,7 @@ function BackendScriptApi(currentNote, apiParams) {
      * @method
      * @param {string} name - attribute name
      * @param {string} [value] - attribute value
-     * @returns {Note|null}
+     * @returns {BNote|null}
      */
     this.getNoteWithLabel = attributeService.getNoteWithLabel;
 
@@ -194,20 +197,14 @@ function BackendScriptApi(currentNote, apiParams) {
      */
     this.toggleNoteInParent = cloningService.toggleNoteInParent;
 
-    /**
-     * @typedef {object} CreateNoteAttribute
-     * @property {string} type - attribute type - label, relation etc.
-     * @property {string} name - attribute name
-     * @property {string} [value] - attribute value
-     */
-
     /**
      * Create text note. See also createNewNote() for more options.
      *
+     * @method
      * @param {string} parentNoteId
      * @param {string} title
      * @param {string} content
-     * @return {{note: Note, branch: Branch}} - object having "note" and "branch" keys representing respective objects
+     * @returns {{note: BNote, branch: BBranch}} - object having "note" and "branch" keys representing respective objects
      */
     this.createTextNote = (parentNoteId, title, content = '') => noteService.createNewNote({
         parentNoteId,
@@ -220,10 +217,11 @@ function BackendScriptApi(currentNote, apiParams) {
      * Create data note - data in this context means object serializable to JSON. Created note will be of type 'code' and
      * JSON MIME type. See also createNewNote() for more options.
      *
+     * @method
      * @param {string} parentNoteId
      * @param {string} title
      * @param {object} content
-     * @return {{note: Note, branch: Branch}} object having "note" and "branch" keys representing respective objects
+     * @returns {{note: BNote, branch: BBranch}} object having "note" and "branch" keys representing respective objects
      */
     this.createDataNote = (parentNoteId, title, content = {}) => noteService.createNewNote({
         parentNoteId,
@@ -233,43 +231,23 @@ function BackendScriptApi(currentNote, apiParams) {
         mime: 'application/json'
     });
 
-    /**
-     * @typedef {object} CreateNewNoteParams
-     * @property {string} parentNoteId - MANDATORY
-     * @property {string} title - MANDATORY
-     * @property {string|buffer} content - MANDATORY
-     * @property {string} type - text, code, file, image, search, book, relation-map - MANDATORY
-     * @property {string} mime - value is derived from default mimes for type
-     * @property {boolean} isProtected - default is false
-     * @property {boolean} isExpanded - default is false
-     * @property {string} prefix - default is empty string
-     * @property {int} notePosition - default is last existing notePosition in a parent + 10
-     */
-
     /**
      * @method
      *
-     * @param {CreateNewNoteParams} [params]
+     * @property {object} params
-     * @returns {{note: Note, branch: Branch}} object contains newly created entities note and branch
+     * @property {string} params.parentNoteId
+     * @property {string} params.title
+     * @property {string|buffer} params.content
+     * @property {string} params.type - text, code, file, image, search, book, relationMap, canvas
+     * @property {string} [params.mime] - value is derived from default mimes for type
+     * @property {boolean} [params.isProtected=false]
+     * @property {boolean} [params.isExpanded=false]
+     * @property {string} [params.prefix='']
+     * @property {int} [params.notePosition] - default is last existing notePosition in a parent + 10
+     * @returns {{note: BNote, branch: BBranch}} object contains newly created entities note and branch
      */
     this.createNewNote = noteService.createNewNote;
 
-    /**
-     * @typedef {object} CreateNoteAttribute
-     * @property {string} type - attribute type - label, relation etc.
-     * @property {string} name - attribute name
-     * @property {string} [value] - attribute value
-     */
-
-    /**
-     * @typedef {object} CreateNoteExtraOptions
-     * @property {boolean} [json=false] - should the note be JSON
-     * @property {boolean} [isProtected=false] - should the note be protected
-     * @property {string} [type='text'] - note type
-     * @property {string} [mime='text/html'] - MIME type of the note
-     * @property {CreateNoteAttribute[]} [attributes=[]] - attributes to be created for this note
-     */
-
     /**
      * @method
      * @deprecated please use createTextNote() with similar API for simpler use cases or createNewNote() for more complex needs
@@ -277,8 +255,16 @@ function BackendScriptApi(currentNote, apiParams) {
      * @param {string} parentNoteId - create new note under this parent
      * @param {string} title
      * @param {string} [content=""]
-     * @param {CreateNoteExtraOptions} [extraOptions={}]
+     * @param {object} [extraOptions={}]
-     * @returns {{note: Note, branch: Branch}} object contains newly created entities note and branch
+     * @property {boolean} [extraOptions.json=false] - should the note be JSON
+     * @property {boolean} [extraOptions.isProtected=false] - should the note be protected
+     * @property {string} [extraOptions.type='text'] - note type
+     * @property {string} [extraOptions.mime='text/html'] - MIME type of the note
+     * @property {object[]} [extraOptions.attributes=[]] - attributes to be created for this note
+     * @property {string} extraOptions.attributes.type - attribute type - label, relation etc.
+     * @property {string} extraOptions.attributes.name - attribute name
+     * @property {string} [extraOptions.attributes.value] - attribute value
+     * @returns {{note: BNote, branch: BBranch}} object contains newly created entities note and branch
      */
     this.createNote = (parentNoteId, title, content = "", extraOptions= {}) => {
         extraOptions.parentNoteId = parentNoteId;
@@ -316,18 +302,42 @@ function BackendScriptApi(currentNote, apiParams) {
         });
     };
 
+    this.logMessages = {};
+    this.logSpacedUpdates = {};
+
     /**
-     * Log given message to trilium logs.
+     * Log given message to trilium logs and log pane in UI
      *
+     * @method
      * @param message
+     * @returns {void}
      */
-    this.log = message => log.info(message);
+    this.log = message => {
+        log.info(message);
+
+        const {noteId} = this.startNote;
+
+        this.logMessages[noteId] = this.logMessages[noteId] || [];
+        this.logSpacedUpdates[noteId] = this.logSpacedUpdates[noteId] || new SpacedUpdate(() => {
+            const messages = this.logMessages[noteId];
+            this.logMessages[noteId] = [];
+
+            ws.sendMessageToAllClients({
+                type: 'api-log-messages',
+                noteId,
+                messages
+            });
+        }, 100);
+
+        this.logMessages[noteId].push(message);
+        this.logSpacedUpdates[noteId].scheduleUpdate();
+    };
 
     /**
      * Returns root note of the calendar.
      *
      * @method
-     * @returns {Note|null}
+     * @returns {BNote|null}
      */
     this.getRootCalendarNote = dateNoteService.getRootCalendarNote;
 
@@ -336,17 +346,8 @@ function BackendScriptApi(currentNote, apiParams) {
      *
      * @method
      * @param {string} date in YYYY-MM-DD format
-     * @returns {Note|null}
+     * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use the default calendar
-     * @deprecated use getDayNote instead
+     * @returns {BNote|null}
-     */
-    this.getDateNote = dateNoteService.getDayNote;
-
-    /**
-     * Returns day note for given date. If such note doesn't exist, it is created.
-     *
-     * @method
-     * @param {string} date in YYYY-MM-DD format
-     * @returns {Note|null}
      */
     this.getDayNote = dateNoteService.getDayNote;
 
@@ -354,7 +355,8 @@ function BackendScriptApi(currentNote, apiParams) {
      * Returns today's day note. If such note doesn't exist, it is created.
      *
      * @method
-     * @returns {Note|null}
+     * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use the default calendar
+     * @returns {BNote|null}
      */
     this.getTodayNote = dateNoteService.getTodayNote;
 
@@ -363,8 +365,10 @@ function BackendScriptApi(currentNote, apiParams) {
      *
      * @method
      * @param {string} date in YYYY-MM-DD format
-     * @param {object} options - "startOfTheWeek" - either "monday" (default) or "sunday"
+     * @param {object} [options]
-     * @returns {Note|null}
+     * @param {string} [options.startOfTheWeek=monday] - either "monday" (default) or "sunday"
+     * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use the default calendar
+     * @returns {BNote|null}
      */
     this.getWeekNote = dateNoteService.getWeekNote;
 
@@ -373,7 +377,8 @@ function BackendScriptApi(currentNote, apiParams) {
      *
      * @method
      * @param {string} date in YYYY-MM format
-     * @returns {Note|null}
+     * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use the default calendar
+     * @returns {BNote|null}
      */
     this.getMonthNote = dateNoteService.getMonthNote;
 
@@ -382,15 +387,29 @@ function BackendScriptApi(currentNote, apiParams) {
      *
      * @method
      * @param {string} year in YYYY format
-     * @returns {Note|null}
+     * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use the default calendar
+     * @returns {BNote|null}
      */
     this.getYearNote = dateNoteService.getYearNote;
 
     /**
+     * Sort child notes of a given note.
+     *
      * @method
      * @param {string} parentNoteId - this note's child notes will be sorted
+     * @param {object} [sortConfig]
+     * @property {string} [sortConfig.sortBy=title] - 'title', 'dateCreated', 'dateModified' or a label name
+     *                                See {@link https://github.com/zadam/trilium/wiki/Sorting} for details.
+     * @property {boolean} [sortConfig.reverse=false]
+     * @property {boolean} [sortConfig.foldersFirst=false]
+     * @returns {void}
      */
-    this.sortNotesByTitle = parentNoteId => treeService.sortNotes(parentNoteId);
+    this.sortNotes = (parentNoteId, sortConfig = {}) => treeService.sortNotes(
+        parentNoteId,
+        sortConfig.sortBy || "title",
+        !!sortConfig.reverse,
+        !!sortConfig.foldersFirst
+    );
 
     /**
      * This method finds note by its noteId and prefix and either sets it to the given parentNoteId
@@ -399,10 +418,11 @@ function BackendScriptApi(currentNote, apiParams) {
      * This method looks similar to toggleNoteInParent() but differs because we're looking up branch by prefix.
      *
      * @method
-     * @deprecated - this method is pretty confusing and serves specialized purpose only
+     * @deprecated this method is pretty confusing and serves specialized purpose only
      * @param {string} noteId
      * @param {string} prefix
      * @param {string|null} parentNoteId
+     * @returns {void}
      */
     this.setNoteToParent = treeService.setNoteToParent;
 
@@ -446,14 +466,105 @@ function BackendScriptApi(currentNote, apiParams) {
 
     /**
      * @method
-     * @deprecated - this is now no-op since all the changes should be gracefully handled per widget
+     * @returns {{syncVersion, appVersion, buildRevision, dbVersion, dataDirectory, buildDate}|*} - object representing basic info about running Trilium version
-     */
-    this.refreshTree = () => {};
-
-    /**
-     * @return {{syncVersion, appVersion, buildRevision, dbVersion, dataDirectory, buildDate}|*} - object representing basic info about running Trilium version
      */
     this.getAppInfo = () => appInfo
+
+    /**
+     * Creates a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.
+     *
+     * @method
+     * @param {object} opts
+     * @property {string} opts.id - id of the launcher, only alphanumeric at least 6 characters long
+     * @property {string} opts.type - one of
+     *                          * "note" - activating the launcher will navigate to the target note (specified in targetNoteId param)
+     *                          * "script" -  activating the launcher will execute the script (specified in scriptNoteId param)
+     *                          * "customWidget" - the launcher will be rendered with a custom widget (specified in widgetNoteId param)
+     * @property {string} opts.title
+     * @property {boolean} [opts.isVisible=false] - if true, will be created in the "Visible launchers", otherwise in "Available launchers"
+     * @property {string} [opts.icon] - name of the boxicon to be used (e.g. "bx-time")
+     * @property {string} [opts.keyboardShortcut] - will activate the target note/script upon pressing, e.g. "ctrl+e"
+     * @property {string} [opts.targetNoteId] - for type "note"
+     * @property {string} [opts.scriptNoteId] - for type "script"
+     * @property {string} [opts.widgetNoteId] - for type "customWidget"
+     * @returns {{note: BNote}}
+     */
+    this.createOrUpdateLauncher = opts => {
+        if (!opts.id) { throw new Error("ID is a mandatory parameter for api.createOrUpdateLauncher(opts)"); }
+        if (!opts.id.match(/[a-z0-9]{6,1000}/i)) { throw new Error(`ID must be an alphanumeric string at least 6 characters long.`); }
+        if (!opts.type) { throw new Error("Launcher Type is a mandatory parameter for api.createOrUpdateLauncher(opts)"); }
+        if (!["note", "script", "customWidget"].includes(opts.type)) { throw new Error(`Given launcher type '${opts.type}'`); }
+        if (!opts.title?.trim()) { throw new Error("Title is a mandatory parameter for api.createOrUpdateLauncher(opts)"); }
+        if (opts.type === 'note' && !opts.targetNoteId) { throw new Error("targetNoteId is mandatory for launchers of type 'note'"); }
+        if (opts.type === 'script' && !opts.scriptNoteId) { throw new Error("scriptNoteId is mandatory for launchers of type 'script'"); }
+        if (opts.type === 'customWidget' && !opts.widgetNoteId) { throw new Error("widgetNoteId is mandatory for launchers of type 'customWidget'"); }
+
+        const parentNoteId = !!opts.isVisible ? '_lbVisibleLaunchers' : '_lbAvailableLaunchers';
+        const noteId = 'al_' + opts.id;
+
+        const launcherNote =
+            becca.getNote(opts.id) ||
+            specialNotesService.createLauncher({
+                noteId: noteId,
+                parentNoteId: parentNoteId,
+                launcherType: opts.type,
+            }).note;
+
+        if (launcherNote.title !== opts.title) {
+            launcherNote.title = opts.title;
+            launcherNote.save();
+        }
+
+        if (launcherNote.getParentBranches().length === 1) {
+            const branch = launcherNote.getParentBranches()[0];
+
+            if (branch.parentNoteId !== parentNoteId) {
+                branchService.moveBranchToNote(branch, parentNoteId);
+            }
+        }
+
+        if (opts.type === 'note') {
+            launcherNote.setRelation('target', opts.targetNoteId);
+        } else if (opts.type === 'script') {
+            launcherNote.setRelation('script', opts.scriptNoteId);
+        } else if (opts.type === 'customWidget') {
+            launcherNote.setRelation('widget', opts.widgetNoteId);
+        } else {
+            throw new Error(`Unrecognized launcher type '${opts.type}'`);
+        }
+
+        if (opts.keyboardShortcut) {
+            launcherNote.setLabel('keyboardShortcut', opts.keyboardShortcut);
+        } else {
+            launcherNote.removeLabel('keyboardShortcut');
+        }
+
+        if (opts.icon) {
+            launcherNote.setLabel('iconClass', `bx ${opts.icon}`);
+        } else {
+            launcherNote.removeLabel('keyboardShortcut');
+        }
+
+        return {note: launcherNote};
+    };
+
+    /**
+     * @method
+     * @param {string} noteId
+     * @param {string} format - either 'html' or 'markdown'
+     * @param {string} zipFilePath
+     * @returns {Promise<void>}
+     */
+    this.exportSubtreeToZipFile = async (noteId, format, zipFilePath) => await exportService.exportToZipFile(noteId, format, zipFilePath);
+
+    /**
+     * This object contains "at your risk" and "no BC guarantees" objects for advanced use cases.
+     *
+     * @property {Becca} becca - provides access to the backend in-memory object graph, see {@link https://github.com/zadam/trilium/blob/master/src/becca/becca.js}
+     */
+    this.__private = {
+        becca
+    }
 }
 
 module.exports = BackendScriptApi;
@@ -467,13 +578,13 @@ module.exports = BackendScriptApi;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/services_sql.js.html

@@ -56,14 +56,20 @@ const LOG_ALL_QUERIES = false;
 function insert(tableName, rec, replace = false) {
     const keys = Object.keys(rec);
     if (keys.length === 0) {
-        log.error("Can't insert empty object into table " + tableName);
+        log.error(`Can't insert empty object into table ${tableName}`);
         return;
     }
 
     const columns = keys.join(", ");
     const questionMarks = keys.map(p => "?").join(", ");
 
-    const query = "INSERT " + (replace ? "OR REPLACE" : "") + " INTO " + tableName + "(" + columns + ") VALUES (" + questionMarks + ")";
+    const query = `INSERT
+    ${replace ? "OR REPLACE" : ""} INTO
+    ${tableName}
+    (
+    ${columns}
+    )
+    VALUES (${questionMarks})`;
 
     const res = execute(query, Object.values(rec));
 
@@ -77,13 +83,13 @@ function replace(tableName, rec) {
 function upsert(tableName, primaryKey, rec) {
     const keys = Object.keys(rec);
     if (keys.length === 0) {
-        log.error("Can't upsert empty object into table " + tableName);
+        log.error(`Can't upsert empty object into table ${tableName}`);
         return;
     }
 
     const columns = keys.join(", ");
 
-    const questionMarks = keys.map(colName => "@" + colName).join(", ");
+    const questionMarks = keys.map(colName => `@${colName}`).join(", ");
 
     const updateMarks = keys.map(colName => `${colName} = @${colName}`).join(", ");
 
@@ -270,14 +276,17 @@ function transactional(func) {
         return ret;
     }
     catch (e) {
-        const entityChanges = cls.getAndClearEntityChangeIds();
+        const entityChangeIds = cls.getAndClearEntityChangeIds();
 
-        if (entityChanges.length > 0) {
+        if (entityChangeIds.length > 0) {
             log.info("Transaction rollback dirtied the becca, forcing reload.");
 
             require('../becca/becca_loader').load();
         }
 
+        // the maxEntityChangeId has been incremented during failed transaction, need to recalculate
+        require('./entity_changes').recalculateMaxEntityChangeId();
+
         throw e;
     }
 }
@@ -300,7 +309,7 @@ function fillParamList(paramIds, truncate = true) {
     }
 
     // doing it manually to avoid this showing up on the sloq query list
-    const s = stmt(`INSERT INTO param_list VALUES ` + paramIds.map(paramId => `(?)`).join(','), paramIds);
+    const s = stmt(`INSERT INTO param_list VALUES ${paramIds.map(paramId => `(?)`).join(',')}`, paramIds);
 
     s.run(paramIds);
 }
@@ -325,7 +334,7 @@ module.exports = {
      * @method
      * @param {string} query - SQL query with ? used as parameter placeholder
      * @param {object[]} [params] - array of params if needed
-     * @return [object] - single value
+     * @returns [object] - single value
      */
     getValue,
 
@@ -335,7 +344,7 @@ module.exports = {
      * @method
      * @param {string} query - SQL query with ? used as parameter placeholder
      * @param {object[]} [params] - array of params if needed
-     * @return {object} - map of column name to column value
+     * @returns {object} - map of column name to column value
      */
     getRow,
     getRowOrNull,
@@ -346,7 +355,7 @@ module.exports = {
      * @method
      * @param {string} query - SQL query with ? used as parameter placeholder
      * @param {object[]} [params] - array of params if needed
-     * @return {object[]} - array of all rows, each row is a map of column name to column value
+     * @returns {object[]} - array of all rows, each row is a map of column name to column value
      */
     getRows,
     getRawRows,
@@ -359,7 +368,7 @@ module.exports = {
      * @method
      * @param {string} query - SQL query with ? used as parameter placeholder
      * @param {object[]} [params] - array of params if needed
-     * @return {object} - map of first column to second column
+     * @returns {object} - map of first column to second column
      */
     getMap,
 
@@ -369,7 +378,7 @@ module.exports = {
      * @method
      * @param {string} query - SQL query with ? used as parameter placeholder
      * @param {object[]} [params] - array of params if needed
-     * @return {object[]} - array of first column of all returned rows
+     * @returns {object[]} - array of first column of all returned rows
      */
     getColumn,
 
@@ -398,13 +407,13 @@ module.exports = {
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractEntity.html">AbstractEntity</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="EtapiToken.html">EtapiToken</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
+    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttribute.html">BAttribute</a></li><li><a href="BBranch.html">BBranch</a></li><li><a href="BEtapiToken.html">BEtapiToken</a></li><li><a href="BNote.html">BNote</a></li><li><a href="BNoteRevision.html">BNoteRevision</a></li><li><a href="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/frontend_api/FAttribute.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Class: Attribute</title>
+    <title>JSDoc: Class: FAttribute</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Class: Attribute</h1>
+    <h1 class="page-title">Class: FAttribute</h1>
 
     
 
@@ -28,7 +28,7 @@
 
 <header>
     
-        <h2><span class="attribs"><span class="type-signature"></span></span>Attribute<span class="signature">()</span><span class="type-signature"></span></h2>
+        <h2><span class="attribs"><span class="type-signature"></span></span>FAttribute<span class="signature">()</span><span class="type-signature"></span></h2>
         
             <div class="class-description">Attribute is an abstract concept which has two real uses - label (key - value pair)
 and relation (representing named relationship between source and target note)</div>
@@ -46,7 +46,7 @@ and relation (representing named relationship between source and target note)</d
     
 
     
-    <h4 class="name" id="Attribute"><span class="type-signature"></span>new Attribute<span class="signature">()</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="FAttribute"><span class="type-signature"></span>new FAttribute<span class="signature">()</span><span class="type-signature"></span></h4>
     
 
     
@@ -94,7 +94,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line7">line 7</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line7">line 7</a>
     </li></ul></dd>
     
 
@@ -194,7 +194,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line16">line 16</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line16">line 16</a>
     </li></ul></dd>
     
 
@@ -262,7 +262,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line28">line 28</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line28">line 28</a>
     </li></ul></dd>
     
 
@@ -330,7 +330,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line22">line 22</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line22">line 22</a>
     </li></ul></dd>
     
 
@@ -398,7 +398,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line18">line 18</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line18">line 18</a>
     </li></ul></dd>
     
 
@@ -466,7 +466,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line26">line 26</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line26">line 26</a>
     </li></ul></dd>
     
 
@@ -534,7 +534,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line20">line 20</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line20">line 20</a>
     </li></ul></dd>
     
 
@@ -602,7 +602,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line24">line 24</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line24">line 24</a>
     </li></ul></dd>
     
 
@@ -630,7 +630,7 @@ and relation (representing named relationship between source and target note)</d
     
 
     
-    <h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4>
+    <h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="FNote.html">FNote</a>}</span></h4>
     
 
     
@@ -678,7 +678,7 @@ and relation (representing named relationship between source and target note)</d
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line32">line 32</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line32">line 32</a>
     </li></ul></dd>
     
 
@@ -714,7 +714,109 @@ and relation (representing named relationship between source and target note)</d
     </dt>
     <dd>
         
-<span class="param-type"><a href="NoteShort.html">NoteShort</a></span>
+<span class="param-type"><a href="FNote.html">FNote</a></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="getTargetNote"><span class="type-signature">(async) </span>getTargetNote<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line37">line 37</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
 
 
     </dd>
@@ -742,13 +844,13 @@ and relation (representing named relationship between source and target note)</d
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/frontend_api/FBranch.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Class: Branch</title>
+    <title>JSDoc: Class: FBranch</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Class: Branch</h1>
+    <h1 class="page-title">Class: FBranch</h1>
 
     
 
@@ -28,7 +28,7 @@
 
 <header>
     
-        <h2><span class="attribs"><span class="type-signature"></span></span>Branch<span class="signature">()</span><span class="type-signature"></span></h2>
+        <h2><span class="attribs"><span class="type-signature"></span></span>FBranch<span class="signature">()</span><span class="type-signature"></span></h2>
         
             <div class="class-description">Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
 parents.</div>
@@ -46,7 +46,7 @@ parents.</div>
     
 
     
-    <h4 class="name" id="Branch"><span class="type-signature"></span>new Branch<span class="signature">()</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="FBranch"><span class="type-signature"></span>new FBranch<span class="signature">()</span><span class="type-signature"></span></h4>
     
 
     
@@ -94,7 +94,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line5">line 5</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line5">line 5</a>
     </li></ul></dd>
     
 
@@ -198,7 +198,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line17">line 17</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line17">line 17</a>
     </li></ul></dd>
     
 
@@ -266,7 +266,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line29">line 29</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line29">line 29</a>
     </li></ul></dd>
     
 
@@ -334,7 +334,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line27">line 27</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line27">line 27</a>
     </li></ul></dd>
     
 
@@ -402,7 +402,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line19">line 19</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line19">line 19</a>
     </li></ul></dd>
     
 
@@ -470,7 +470,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line23">line 23</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line23">line 23</a>
     </li></ul></dd>
     
 
@@ -538,7 +538,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line21">line 21</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line21">line 21</a>
     </li></ul></dd>
     
 
@@ -606,7 +606,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line25">line 25</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line25">line 25</a>
     </li></ul></dd>
     
 
@@ -634,7 +634,7 @@ parents.</div>
     
 
     
-    <h4 class="name" id="getNote"><span class="type-signature">(async) </span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4>
+    <h4 class="name" id="getNote"><span class="type-signature">(async) </span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="FNote.html">FNote</a>}</span></h4>
     
 
     
@@ -682,7 +682,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line33">line 33</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line33">line 33</a>
     </li></ul></dd>
     
 
@@ -718,7 +718,7 @@ parents.</div>
     </dt>
     <dd>
         
-<span class="param-type"><a href="NoteShort.html">NoteShort</a></span>
+<span class="param-type"><a href="FNote.html">FNote</a></span>
 
 
     </dd>
@@ -736,7 +736,7 @@ parents.</div>
     
 
     
-    <h4 class="name" id="getNoteFromCache"><span class="type-signature"></span>getNoteFromCache<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4>
+    <h4 class="name" id="getNoteFromCache"><span class="type-signature"></span>getNoteFromCache<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="FNote.html">FNote</a>}</span></h4>
     
 
     
@@ -784,7 +784,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line38">line 38</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line38">line 38</a>
     </li></ul></dd>
     
 
@@ -820,7 +820,7 @@ parents.</div>
     </dt>
     <dd>
         
-<span class="param-type"><a href="NoteShort.html">NoteShort</a></span>
+<span class="param-type"><a href="FNote.html">FNote</a></span>
 
 
     </dd>
@@ -838,7 +838,7 @@ parents.</div>
     
 
     
-    <h4 class="name" id="getParentNote"><span class="type-signature">(async) </span>getParentNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4>
+    <h4 class="name" id="getParentNote"><span class="type-signature">(async) </span>getParentNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="FNote.html">FNote</a>}</span></h4>
     
 
     
@@ -886,7 +886,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line43">line 43</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line43">line 43</a>
     </li></ul></dd>
     
 
@@ -922,7 +922,7 @@ parents.</div>
     </dt>
     <dd>
         
-<span class="param-type"><a href="NoteShort.html">NoteShort</a></span>
+<span class="param-type"><a href="FNote.html">FNote</a></span>
 
 
     </dd>
@@ -988,7 +988,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_branch.js.html">entities/branch.js</a>, <a href="entities_branch.js.html#line48">line 48</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line48">line 48</a>
     </li></ul></dd>
     
 
@@ -1056,13 +1056,13 @@ parents.</div>
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/frontend_api/FNoteComplement.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Class: NoteComplement</title>
+    <title>JSDoc: Class: FNoteComplement</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Class: NoteComplement</h1>
+    <h1 class="page-title">Class: FNoteComplement</h1>
 
     
 
@@ -28,9 +28,9 @@
 
 <header>
     
-        <h2><span class="attribs"><span class="type-signature"></span></span>NoteComplement<span class="signature">()</span><span class="type-signature"></span></h2>
+        <h2><span class="attribs"><span class="type-signature"></span></span>FNoteComplement<span class="signature">()</span><span class="type-signature"></span></h2>
         
-            <div class="class-description">Complements the NoteShort with the main note content and other extra attributes</div>
+            <div class="class-description">Complements the FNote with the main note content and other extra attributes</div>
         
     
 </header>
@@ -45,7 +45,7 @@
     
 
     
-    <h4 class="name" id="NoteComplement"><span class="type-signature"></span>new NoteComplement<span class="signature">()</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="FNoteComplement"><span class="type-signature"></span>new FNoteComplement<span class="signature">()</span><span class="type-signature"></span></h4>
     
 
     
@@ -93,7 +93,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line4">line 4</a>
+        <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line4">line 4</a>
     </li></ul></dd>
     
 
@@ -193,7 +193,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line33">line 33</a>
+        <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line33">line 33</a>
     </li></ul></dd>
     
 
@@ -261,7 +261,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line36">line 36</a>
+        <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line36">line 36</a>
     </li></ul></dd>
     
 
@@ -333,7 +333,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line13">line 13</a>
+        <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line13">line 13</a>
     </li></ul></dd>
     
 
@@ -401,7 +401,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line16">line 16</a>
+        <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line16">line 16</a>
     </li></ul></dd>
     
 
@@ -469,7 +469,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line19">line 19</a>
+        <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line19">line 19</a>
     </li></ul></dd>
     
 
@@ -537,7 +537,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line22">line 22</a>
+        <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line22">line 22</a>
     </li></ul></dd>
     
 
@@ -605,7 +605,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line7">line 7</a>
+        <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line7">line 7</a>
     </li></ul></dd>
     
 
@@ -673,7 +673,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line25">line 25</a>
+        <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line25">line 25</a>
     </li></ul></dd>
     
 
@@ -741,7 +741,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_note_complement.js.html">entities/note_complement.js</a>, <a href="entities_note_complement.js.html#line28">line 28</a>
+        <a href="entities_fnote_complement.js.html">entities/fnote_complement.js</a>, <a href="entities_fnote_complement.js.html#line28">line 28</a>
     </li></ul></dd>
     
 
@@ -775,13 +775,13 @@
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/frontend_api/entities_fattribute.js.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Source: entities/attribute.js</title>
+    <title>JSDoc: Source: entities/fattribute.js</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Source: entities/attribute.js</h1>
+    <h1 class="page-title">Source: entities/fattribute.js</h1>
 
     
 
@@ -32,7 +32,7 @@
  * Attribute is an abstract concept which has two real uses - label (key - value pair)
  * and relation (representing named relationship between source and target note)
  */
-class Attribute {
+class FAttribute {
     constructor(froca, row) {
         this.froca = froca;
 
@@ -56,13 +56,24 @@ class Attribute {
         this.isInheritable = !!row.isInheritable;
     }
 
-    /** @returns {NoteShort} */
+    /** @returns {FNote} */
     getNote() {
         return this.froca.notes[this.noteId];
     }
 
+    /** @returns {Promise&lt;FNote>} */
+    async getTargetNote() {
+        const targetNoteId = this.targetNoteId;
+
+        return await this.froca.getNote(targetNoteId, true);
+    }
+
     get targetNoteId() { // alias
-        return this.type === 'relation' ? this.value : undefined;
+        if (this.type !== 'relation') {
+            throw new Error(`Attribute ${this.attributeId} is not a relation`);
+        }
+
+        return this.value;
     }
 
     get isAutoLink() {
@@ -70,7 +81,7 @@ class Attribute {
     }
 
     get toString() {
-        return `Attribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name}, value=${this.value})`;
+        return `FAttribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name}, value=${this.value})`;
     }
 
     isDefinition() {
@@ -93,7 +104,7 @@ class Attribute {
     }
 }
 
-export default Attribute;
+export default FAttribute;
 </code></pre>
         </article>
     </section>
@@ -104,13 +115,13 @@ export default Attribute;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/frontend_api/entities_fbranch.js.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Source: entities/branch.js</title>
+    <title>JSDoc: Source: entities/fbranch.js</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Source: entities/branch.js</h1>
+    <h1 class="page-title">Source: entities/fbranch.js</h1>
 
     
 
@@ -30,7 +30,7 @@
  * Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
  * parents.
  */
-class Branch {
+class FBranch {
     constructor(froca, row) {
         this.froca = froca;
 
@@ -57,17 +57,17 @@ class Branch {
         this.fromSearchNote = !!row.fromSearchNote;
     }
 
-    /** @returns {NoteShort} */
+    /** @returns {FNote} */
     async getNote() {
         return this.froca.getNote(this.noteId);
     }
 
-    /** @returns {NoteShort} */
+    /** @returns {FNote} */
     getNoteFromCache() {
         return this.froca.getNoteFromCache(this.noteId);
     }
 
-    /** @returns {NoteShort} */
+    /** @returns {FNote} */
     async getParentNote() {
         return this.froca.getNote(this.parentNoteId);
     }
@@ -78,11 +78,17 @@ class Branch {
     }
 
     get toString() {
-        return `Branch(branchId=${this.branchId})`;
+        return `FBranch(branchId=${this.branchId})`;
+    }
+
+    get pojo() {
+        const pojo = {...this};
+        delete pojo.froca;
+        return pojo;
     }
 }
 
-export default Branch;
+export default FBranch;
 </code></pre>
         </article>
     </section>
@@ -93,13 +99,13 @@ export default Branch;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/frontend_api/entities_fnote.js.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Source: entities/note_short.js</title>
+    <title>JSDoc: Source: entities/fnote.js</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Source: entities/note_short.js</h1>
+    <h1 class="page-title">Source: entities/fnote.js</h1>
 
     
 
@@ -31,6 +31,8 @@ import noteAttributeCache from "../services/note_attribute_cache.js";
 import ws from "../services/ws.js";
 import options from "../services/options.js";
 import froca from "../services/froca.js";
+import protectedSessionHolder from "../services/protected_session_holder.js";
+import cssClassManager from "../services/css_class_manager.js";
 
 const LABEL = 'label';
 const RELATION = 'relation';
@@ -41,18 +43,18 @@ const NOTE_TYPE_ICONS = {
     "code": "bx bx-code",
     "render": "bx bx-extension",
     "search": "bx bx-file-find",
-    "relation-map": "bx bx-map-alt",
+    "relationMap": "bx bx-map-alt",
     "book": "bx bx-book",
-    "note-map": "bx bx-map-alt",
+    "noteMap": "bx bx-map-alt",
-    "mermaid": "bx bx-selection"
+    "mermaid": "bx bx-selection",
+    "canvas": "bx bx-pen",
+    "webView": "bx bx-globe-alt",
+    "launcher": "bx bx-link",
+    "doc": "bx bxs-file-doc",
+    "contentWidget": "bx bxs-widget"
 };
 
-/**
+class FNote {
- * FIXME: since there's no "full note" anymore we can rename this to Note
- *
- * This note's representation is used in note tree and is kept in Froca.
- */
-class NoteShort {
     /**
      * @param {Froca} froca
      * @param {Object.&lt;string, Object>} row
@@ -139,8 +141,8 @@ class NoteShort {
     }
 
     async getContent() {
-        // we're not caching content since these objects are in froca and as such pretty long lived
+        // we're not caching content since these objects are in froca and as such pretty long-lived
-        const note = await server.get("notes/" + this.noteId);
+        const note = await server.get(`notes/${this.noteId}`);
 
         return note.content;
     }
@@ -152,7 +154,7 @@ class NoteShort {
             return JSON.parse(content);
         }
         catch (e) {
-            console.log(`Cannot parse content of note ${this.noteId}: `, e.message);
+            console.log(`Cannot parse content of note '${this.noteId}': `, e.message);
 
             return null;
         }
@@ -174,7 +176,7 @@ class NoteShort {
     }
 
     /**
-     * @returns {Branch[]}
+     * @returns {FBranch[]}
      */
     getParentBranches() {
         const branchIds = Object.values(this.parentToBranch);
@@ -183,7 +185,7 @@ class NoteShort {
     }
 
     /**
-     * @returns {Branch[]}
+     * @returns {FBranch[]}
      * @deprecated use getParentBranches() instead
      */
     getBranches() {
@@ -195,7 +197,7 @@ class NoteShort {
         return this.children.length > 0;
     }
 
-    /** @returns {Branch[]} */
+    /** @returns {FBranch[]} */
     getChildBranches() {
         // don't use Object.values() to guarantee order
         const branchIds = this.children.map(childNoteId => this.childToBranch[childNoteId]);
@@ -208,7 +210,7 @@ class NoteShort {
         return this.parents;
     }
 
-    /** @returns {NoteShort[]} */
+    /** @returns {FNote[]} */
     getParentNotes() {
         return this.froca.getNotesFromCache(this.parents);
     }
@@ -225,7 +227,7 @@ class NoteShort {
 
             const aNote = this.froca.getNoteFromCache([aNoteId]);
 
-            if (aNote.hasLabel('archived')) {
+            if (aNote.isArchived || aNote.isHiddenCompletely()) {
                 return 1;
             }
 
@@ -233,12 +235,16 @@ class NoteShort {
         });
     }
 
+    get isArchived() {
+        return this.hasAttribute('label', 'archived');
+    }
+
     /** @returns {string[]} */
     getChildNoteIds() {
         return this.children;
     }
 
-    /** @returns {Promise&lt;NoteShort[]>} */
+    /** @returns {Promise&lt;FNote[]>} */
     async getChildNotes() {
         return await this.froca.getNotes(this.children);
     }
@@ -246,7 +252,7 @@ class NoteShort {
     /**
      * @param {string} [type] - (optional) attribute type to filter
      * @param {string} [name] - (optional) attribute name to filter
-     * @returns {Attribute[]} all note's attributes, including inherited ones
+     * @returns {FAttribute[]} all note's attributes, including inherited ones
      */
     getOwnedAttributes(type, name) {
         const attrs = this.attributes
@@ -259,7 +265,7 @@ class NoteShort {
     /**
      * @param {string} [type] - (optional) attribute type to filter
      * @param {string} [name] - (optional) attribute name to filter
-     * @returns {Attribute[]} all note's attributes, including inherited ones
+     * @returns {FAttribute[]} all note's attributes, including inherited ones
      */
     getAttributes(type, name) {
         return this.__filterAttrs(this.__getCachedAttributes([]), type, name);
@@ -276,7 +282,8 @@ class NoteShort {
             const newPath = [...path, this.noteId];
             const attrArrs = [ this.getOwnedAttributes() ];
 
-            if (this.noteId !== 'root') {
+            // inheritable attrs on root are typically not intended to be applied to hidden subtree #3537
+            if (this.noteId !== 'root' &amp;&amp; this.noteId !== '_hidden') {
                 for (const parentNote of this.getParentNotes()) {
                     // these virtual parent-child relationships are also loaded into froca
                     if (parentNote.type !== 'search') {
@@ -285,11 +292,15 @@ class NoteShort {
                 }
             }
 
-            for (const templateAttr of attrArrs.flat().filter(attr => attr.type === 'relation' &amp;&amp; attr.name === 'template')) {
+            for (const templateAttr of attrArrs.flat().filter(attr => attr.type === 'relation' &amp;&amp; ['template', 'inherit'].includes(attr.name))) {
                 const templateNote = this.froca.notes[templateAttr.value];
 
                 if (templateNote &amp;&amp; templateNote.noteId !== this.noteId) {
-                    attrArrs.push(templateNote.__getCachedAttributes(newPath));
+                    attrArrs.push(
+                        templateNote.__getCachedAttributes(newPath)
+                            // template attr is used as a marker for templates, but it's not meant to be inherited
+                            .filter(attr => !(attr.type === 'label' &amp;&amp; (attr.name === 'template' || attr.name === 'workspacetemplate')))
+                    );
                 }
             }
 
@@ -309,7 +320,7 @@ class NoteShort {
     }
 
     isRoot() {
-        return this.noted
+        return this.noteId === 'root';
     }
 
     getAllNotePaths(encounteredNoteIds = null) {
@@ -359,9 +370,9 @@ class NoteShort {
         const notePaths = this.getAllNotePaths().map(path => ({
             notePath: path,
             isInHoistedSubTree: path.includes(hoistedNotePath),
-            isArchived: path.find(noteId => froca.notes[noteId].hasLabel('archived')),
+            isArchived: path.find(noteId => froca.notes[noteId].isArchived),
             isSearch: path.find(noteId => froca.notes[noteId].type === 'search'),
-            isHidden: path.includes("hidden")
+            isHidden: path.includes('_hidden')
         }));
 
         notePaths.sort((a, b) => {
@@ -371,6 +382,8 @@ class NoteShort {
                 return a.isSearch ? 1 : -1;
             } else if (a.isArchived !== b.isArchived) {
                 return a.isArchived ? 1 : -1;
+            } else if (a.isHidden !== b.isHidden) {
+                return a.isHidden ? 1 : -1;
             } else {
                 return a.notePath.length - b.notePath.length;
             }
@@ -379,11 +392,36 @@ class NoteShort {
         return notePaths;
     }
 
+    /**
+     * @return boolean - true if there's no non-hidden path, note is not cloned to the visible tree
+     */
+    isHiddenCompletely() {
+        if (this.noteId === 'root') {
+            return false;
+        }
+
+        for (const parentNote of this.getParentNotes()) {
+            if (parentNote.noteId === 'root') {
+                return false;
+            } else if (parentNote.noteId === '_hidden') {
+                continue;
+            }
+
+            if (!parentNote.isHiddenCompletely()) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
     __filterAttrs(attributes, type, name) {
+        this.__validateTypeName(type, name);
+
         if (!type &amp;&amp; !name) {
             return attributes;
         } else if (type &amp;&amp; name) {
-            return attributes.filter(attr => attr.type === type &amp;&amp; attr.name === name);
+            return attributes.filter(attr => attr.name === name &amp;&amp; attr.type === type);
         } else if (type) {
             return attributes.filter(attr => attr.type === type);
         } else if (name) {
@@ -397,9 +435,22 @@ class NoteShort {
         return attrs.filter(attr => attr.isInheritable);
     }
 
+    __validateTypeName(type, name) {
+        if (type &amp;&amp; type !== 'label' &amp;&amp; type !== 'relation') {
+            throw new Error(`Unrecognized attribute type '${type}'. Only 'label' and 'relation' are possible values.`);
+        }
+
+        if (name) {
+            const firstLetter = name.charAt(0);
+            if (firstLetter === '#' || firstLetter === '~') {
+                throw new Error(`Detect '#' or '~' in the attribute's name. In the API, attribute names should be set without these characters.`);
+            }
+        }
+    }
+
     /**
      * @param {string} [name] - label name to filter
-     * @returns {Attribute[]} all note's labels (attributes with type label), including inherited ones
+     * @returns {FAttribute[]} all note's labels (attributes with type label), including inherited ones
      */
     getOwnedLabels(name) {
         return this.getOwnedAttributes(LABEL, name);
@@ -407,7 +458,7 @@ class NoteShort {
 
     /**
      * @param {string} [name] - label name to filter
-     * @returns {Attribute[]} all note's labels (attributes with type label), including inherited ones
+     * @returns {FAttribute[]} all note's labels (attributes with type label), including inherited ones
      */
     getLabels(name) {
         return this.getAttributes(LABEL, name);
@@ -426,7 +477,7 @@ class NoteShort {
         else if (this.noteId === 'root') {
             return "bx bx-chevrons-right";
         }
-        if (this.noteId === 'share') {
+        if (this.noteId === '_share') {
             return "bx bx-share-alt";
         }
         else if (this.type === 'text') {
@@ -445,6 +496,11 @@ class NoteShort {
         }
     }
 
+    getColorClass() {
+        const color = this.getLabelValue("color");
+        return cssClassManager.createClassForColor(color);
+    }
+
     isFolder() {
         return this.type === 'search'
             || this.getFilteredChildBranches().length > 0;
@@ -454,7 +510,7 @@ class NoteShort {
         let childBranches = this.getChildBranches();
 
         if (!childBranches) {
-            ws.logError(`No children for ${parentNote}. This shouldn't happen.`);
+            ws.logError(`No children for '${this.noteId}'. This shouldn't happen.`);
             return;
         }
 
@@ -475,7 +531,7 @@ class NoteShort {
 
     /**
      * @param {string} [name] - relation name to filter
-     * @returns {Attribute[]} all note's relations (attributes with type relation), including inherited ones
+     * @returns {FAttribute[]} all note's relations (attributes with type relation), including inherited ones
      */
     getOwnedRelations(name) {
         return this.getOwnedAttributes(RELATION, name);
@@ -483,7 +539,7 @@ class NoteShort {
 
     /**
      * @param {string} [name] - relation name to filter
-     * @returns {Attribute[]} all note's relations (attributes with type relation), including inherited ones
+     * @returns {FAttribute[]} all note's relations (attributes with type relation), including inherited ones
      */
     getRelations(name) {
         return this.getAttributes(RELATION, name);
@@ -510,23 +566,23 @@ class NoteShort {
     /**
      * @param {string} type - attribute type (label, relation, etc.)
      * @param {string} name - attribute name
-     * @returns {Attribute} attribute of given type and name. If there's more such attributes, first is  returned. Returns null if there's no such attribute belonging to this note.
+     * @returns {FAttribute} attribute of given type and name. If there's more such attributes, first is  returned. Returns null if there's no such attribute belonging to this note.
      */
     getOwnedAttribute(type, name) {
-        const attributes = this.getOwnedAttributes(type, name);
+        const attributes = this.getOwnedAttributes();
 
-        return attributes.length > 0 ? attributes[0] : 0;
+        return attributes.find(attr => attr.name === name &amp;&amp; attr.type === type);
     }
 
     /**
      * @param {string} type - attribute type (label, relation, etc.)
      * @param {string} name - attribute name
-     * @returns {Attribute} attribute of given type and name. If there's more such attributes, first is  returned. Returns null if there's no such attribute belonging to this note.
+     * @returns {FAttribute} attribute of given type and name. If there's more such attributes, first is  returned. Returns null if there's no such attribute belonging to this note.
      */
     getAttribute(type, name) {
-        const attributes = this.getAttributes(type, name);
+        const attributes = this.getAttributes();
 
-        return attributes.length > 0 ? attributes[0] : null;
+        return attributes.find(attr => attr.name === name &amp;&amp; attr.type === type);
     }
 
     /**
@@ -577,25 +633,25 @@ class NoteShort {
 
     /**
      * @param {string} name - label name
-     * @returns {Attribute} label if it exists, null otherwise
+     * @returns {FAttribute} label if it exists, null otherwise
      */
     getOwnedLabel(name) { return this.getOwnedAttribute(LABEL, name); }
 
     /**
      * @param {string} name - label name
-     * @returns {Attribute} label if it exists, null otherwise
+     * @returns {FAttribute} label if it exists, null otherwise
      */
     getLabel(name) { return this.getAttribute(LABEL, name); }
 
     /**
      * @param {string} name - relation name
-     * @returns {Attribute} relation if it exists, null otherwise
+     * @returns {FAttribute} relation if it exists, null otherwise
      */
     getOwnedRelation(name) { return this.getOwnedAttribute(RELATION, name); }
 
     /**
      * @param {string} name - relation name
-     * @returns {Attribute} relation if it exists, null otherwise
+     * @returns {FAttribute} relation if it exists, null otherwise
      */
     getRelation(name) { return this.getAttribute(RELATION, name); }
 
@@ -625,7 +681,7 @@ class NoteShort {
 
     /**
      * @param {string} name
-     * @returns {Promise&lt;NoteShort>|null} target note of the relation or null (if target is empty or note was not found)
+     * @returns {Promise&lt;FNote>|null} target note of the relation or null (if target is empty or note was not found)
      */
     async getRelationTarget(name) {
         const targets = await this.getRelationTargets(name);
@@ -635,7 +691,7 @@ class NoteShort {
 
     /**
      * @param {string} [name] - relation name to filter
-     * @returns {Promise&lt;NoteShort[]>}
+     * @returns {Promise&lt;FNote[]>}
      */
     async getRelationTargets(name) {
         const relations = this.getRelations(name);
@@ -649,10 +705,13 @@ class NoteShort {
     }
 
     /**
-     * @returns {NoteShort[]}
+     * @returns {FNote[]}
      */
-    getTemplateNotes() {
+    getNotesToInheritAttributesFrom() {
-        const relations = this.getRelations('template');
+        const relations = [
+            ...this.getRelations('template'),
+            ...this.getRelations('inherit')
+        ];
 
         return relations.map(rel => this.froca.notes[rel.value]);
     }
@@ -662,16 +721,21 @@ class NoteShort {
             return [];
         }
 
-        return this.getAttributes()
+        const promotedAttrs = this.getAttributes()
             .filter(attr => attr.isDefinition())
             .filter(attr => {
                 const def = attr.getDefinition();
 
                 return def &amp;&amp; def.isPromoted;
             });
+
+        // attrs are not resorted if position changes after initial load
+        promotedAttrs.sort((a, b) => a.position &lt; b.position ? -1 : 1);
+
+        return promotedAttrs;
     }
 
-    hasAncestor(ancestorNoteId, visitedNoteIds = null) {
+    hasAncestor(ancestorNoteId, followTemplates = false, visitedNoteIds = null) {
         if (this.noteId === ancestorNoteId) {
             return true;
         }
@@ -685,14 +749,16 @@ class NoteShort {
 
         visitedNoteIds.add(this.noteId);
 
-        for (const templateNote of this.getTemplateNotes()) {
+        if (followTemplates) {
-            if (templateNote.hasAncestor(ancestorNoteId, visitedNoteIds)) {
+            for (const templateNote of this.getNotesToInheritAttributesFrom()) {
-                return true;
+                if (templateNote.hasAncestor(ancestorNoteId, followTemplates, visitedNoteIds)) {
+                    return true;
+                }
             }
         }
 
         for (const parentNote of this.getParentNotes()) {
-            if (parentNote.hasAncestor(ancestorNoteId, visitedNoteIds)) {
+            if (parentNote.hasAncestor(ancestorNoteId, followTemplates, visitedNoteIds)) {
                 return true;
             }
         }
@@ -700,6 +766,10 @@ class NoteShort {
         return false;
     }
 
+    isInHiddenSubtree() {
+        return this.noteId === '_hidden' || this.hasAncestor('_hidden');
+    }
+
     /**
      * @deprecated NOOP
      */
@@ -708,7 +778,7 @@ class NoteShort {
     /**
      * Get relations which target this note
      *
-     * @returns {Attribute[]}
+     * @returns {FAttribute[]}
      */
     getTargetRelations() {
         return this.targetRelations
@@ -718,7 +788,7 @@ class NoteShort {
     /**
      * Get relations which target this note
      *
-     * @returns {NoteShort[]}
+     * @returns {FNote[]}
      */
     async getTargetRelationSourceNotes() {
         const targetRelations = this.getTargetRelations();
@@ -729,7 +799,7 @@ class NoteShort {
     /**
      * Return note complement which is most importantly note's content
      *
-     * @return {Promise&lt;NoteComplement>}
+     * @returns {Promise&lt;FNoteComplement>}
      */
     async getNoteComplement() {
         return await this.froca.getNoteComplement(this.noteId);
@@ -761,9 +831,9 @@ class NoteShort {
         return labels.length > 0 ? labels[0].value : "";
     }
 
-    /** @returns {boolean} true if this note is JavaScript (code or attachment) */
+    /** @returns {boolean} true if this note is JavaScript (code or file) */
     isJavaScript() {
-        return (this.type === "code" || this.type === "file")
+        return (this.type === "code" || this.type === "file" || this.type === 'launcher')
             &amp;&amp; (this.mime.startsWith("application/javascript")
                 || this.mime === "application/x-javascript"
                 || this.mime === "text/javascript");
@@ -800,10 +870,10 @@ class NoteShort {
 
         if (env === "frontend") {
             const bundleService = (await import("../services/bundle.js")).default;
-            await bundleService.getAndExecuteBundle(this.noteId);
+            return await bundleService.getAndExecuteBundle(this.noteId);
         }
         else if (env === "backend") {
-            await server.post('script/run/' + this.noteId);
+            const resp = await server.post(`script/run/${this.noteId}`);
         }
         else {
             throw new Error(`Unrecognized env type ${env} for note ${this.noteId}`);
@@ -822,16 +892,28 @@ class NoteShort {
                 continue;
             }
 
-            if (parentNote.noteId === 'share' || parentNote.isShared()) {
+            if (parentNote.noteId === '_share' || parentNote.isShared()) {
                 return true;
             }
         }
 
         return false;
     }
+
+    isContentAvailable() {
+        return !this.isProtected || protectedSessionHolder.isProtectedSessionAvailable()
+    }
+
+    isLaunchBarConfig() {
+        return this.type === 'launcher' || ['_lbRoot', '_lbAvailableLaunchers', '_lbVisibleLaunchers'].includes(this.noteId);
+    }
+
+    isOptions() {
+        return this.noteId.startsWith("_options");
+    }
 }
 
-export default NoteShort;
+export default FNote;
 </code></pre>
         </article>
     </section>
@@ -842,13 +924,13 @@ export default NoteShort;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/frontend_api/entities_fnote_complement.js.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Source: entities/note_complement.js</title>
+    <title>JSDoc: Source: entities/fnote_complement.js</title>
 
     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
@@ -17,7 +17,7 @@
 
 <div id="main">
 
-    <h1 class="page-title">Source: entities/note_complement.js</h1>
+    <h1 class="page-title">Source: entities/fnote_complement.js</h1>
 
     
 
@@ -27,9 +27,9 @@
     <section>
         <article>
             <pre class="prettyprint source linenums"><code>/**
- * Complements the NoteShort with the main note content and other extra attributes
+ * Complements the FNote with the main note content and other extra attributes
  */
-class NoteComplement {
+class FNoteComplement {
     constructor(row) {
         /** @type {string} */
         this.noteId = row.noteId;
@@ -65,7 +65,7 @@ class NoteComplement {
     }
 }
 
-export default NoteComplement;
+export default FNoteComplement;
 </code></pre>
         </article>
     </section>
@@ -76,13 +76,13 @@ export default NoteComplement;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/frontend_api/global.html

@@ -1,440 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Global</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Global</h1>
-
-    
-
-
-
-
-<section>
-
-<header>
-    
-        <h2></h2>
-        
-    
-</header>
-
-<article>
-    <div class="container-overview">
-    
-        
-
-        
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-        
-    
-    </div>
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-        <h3 class="subsection-title">Methods</h3>
-
-        
-            
-
-    
-
-    
-    <h4 class="name" id="doRenderBody"><span class="type-signature">(async) </span>doRenderBody<span class="signature">()</span><span class="type-signature"></span></h4>
-    
-
-    
-
-
-
-<div class="description">
-    for overriding
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="widgets_collapsible_widget.js.html">widgets/collapsible_widget.js</a>, <a href="widgets_collapsible_widget.js.html#line34">line 34</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-        
-    
-
-    
-        <h3 class="subsection-title">Type Definitions</h3>
-
-        
-                
-<h4 class="name" id="ToolbarButtonOptions">ToolbarButtonOptions</h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">Object</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-    <h5 class="subsection-title">Properties:</h5>
-
-    
-
-<table class="props">
-    <thead>
-    <tr>
-        
-        <th>Name</th>
-        
-
-        <th>Type</th>
-
-        
-        <th>Attributes</th>
-        
-
-        
-
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-
-    <tbody>
-    
-
-        <tr>
-            
-                <td class="name"><code>title</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
-
-
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-
-                
-                </td>
-            
-
-            
-
-            <td class="description last"></td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>icon</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
-
-
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-                    &lt;optional><br>
-                
-
-                
-                </td>
-            
-
-            
-
-            <td class="description last">name of the boxicon to be used (e.g. "time" for "bx-time" icon)</td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>action</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">function</span>
-
-
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-
-                
-                </td>
-            
-
-            
-
-            <td class="description last">callback handling the click on the button</td>
-        </tr>
-
-    
-
-        <tr>
-            
-                <td class="name"><code>shortcut</code></td>
-            
-
-            <td class="type">
-            
-                
-<span class="param-type">string</span>
-
-
-            
-            </td>
-
-            
-                <td class="attributes">
-                
-                    &lt;optional><br>
-                
-
-                
-                </td>
-            
-
-            
-
-            <td class="description last">keyboard shortcut for the button, e.g. "alt+t"</td>
-        </tr>
-
-    
-    </tbody>
-</table>
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line104">line 104</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-            
-    
-
-    
-</article>
-
-</section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
-</nav>
-
-<br class="clear">
-
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

docs/frontend_api/index.html

@@ -50,13 +50,13 @@
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/frontend_api/services_frontend_script_api.js.html

@@ -35,22 +35,21 @@ import noteTooltipService from './note_tooltip.js';
 import protectedSessionService from './protected_session.js';
 import dateNotesService from './date_notes.js';
 import searchService from './search.js';
-import CollapsibleWidget from '../widgets/collapsible_widget.js';
+import RightPanelWidget from '../widgets/right_panel_widget.js';
 import ws from "./ws.js";
-import appContext from "./app_context.js";
+import appContext from "../components/app_context.js";
 import NoteContextAwareWidget from "../widgets/note_context_aware_widget.js";
-import NoteContextCachingWidget from "../widgets/note_context_caching_widget.js";
 import BasicWidget from "../widgets/basic_widget.js";
+import SpacedUpdate from "./spaced_update.js";
+import shortcutService from "./shortcuts.js";
 
 /**
- * This is the main frontend API interface for scripts. It's published in the local "api" object.
+ * <p>This is the main frontend API interface for scripts. All the properties and methods are published in the "api" object
+ * available in the JS frontend notes. You can use e.g. <code>api.showMessage(api.startNote.title);</code></p>
  *
  * @constructor
- * @hideconstructor
  */
 function FrontendScriptApi(startNote, currentNote, originEntity = null, $container = null) {
-    const $pluginButtons = $("#plugin-buttons");
-
     /** @property {jQuery} container of all the rendered script content */
     this.$container = $container;
 
@@ -61,11 +60,20 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
     /** @property {object|null} entity whose event triggered this execution */
     this.originEntity = originEntity;
 
-    // to keep consistency with backend API
+    /** @property {dayjs} day.js library for date manipulation. See {@link https://day.js.org} for documentation */
     this.dayjs = dayjs;
 
-    /** @property {CollapsibleWidget} */
+    /**
-    this.CollapsibleWidget = CollapsibleWidget;
+     * @property {RightPanelWidget}
+     * @deprecated use api.RightPanelWidget instead
+     */
+    this.CollapsibleWidget = RightPanelWidget;
+
+    /** @property {RightPanelWidget} */
+    this.RightPanelWidget = RightPanelWidget;
+
+    /** @property {NoteContextAwareWidget} */
+    this.NoteContextAwareWidget = NoteContextAwareWidget;
 
     /**
      * @property {NoteContextAwareWidget}
@@ -73,17 +81,17 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      */
     this.TabAwareWidget = NoteContextAwareWidget;
 
-    /** @property {NoteContextAwareWidget} */
+    /**
-    this.NoteContextAwareWidget = NoteContextAwareWidget;
+     * @property {NoteContextAwareWidget}
+     * @deprecated use NoteContextAwareWidget instead
+     */
+    this.TabCachingWidget = NoteContextAwareWidget;
 
     /**
-     * @property {NoteContextCachingWidget}
+     * @property {NoteContextAwareWidget}
-     * @deprecated use NoteContextCachingWidget instead
+     * @deprecated use NoteContextAwareWidget instead
      */
-    this.TabCachingWidget = NoteContextCachingWidget;
+    this.NoteContextCachingWidget = NoteContextAwareWidget;
-
-    /** @property {NoteContextAwareWidget} */
-    this.NoteContextCachingWidget = NoteContextCachingWidget;
 
     /** @property {BasicWidget} */
     this.BasicWidget = BasicWidget;
@@ -103,7 +111,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * Activates newly created note. Compared to this.activateNote() also makes sure that frontend has been fully synced.
      *
      * @param {string} notePath (or noteId)
-     * @return {Promise<void>}
+     * @returns {Promise<void>}
      */
     this.activateNewNote = async notePath => {
         await ws.waitForMaxKnownEntityChangeId();
@@ -115,14 +123,15 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
     /**
      * Open a note in a new tab.
      *
+     * @method
      * @param {string} notePath (or noteId)
      * @param {boolean} activate - set to true to activate the new tab, false to stay on the current tab
-     * @return {Promise<void>}
+     * @returns {Promise<void>}
      */
     this.openTabWithNote = async (notePath, activate) => {
         await ws.waitForMaxKnownEntityChangeId();
 
-        await appContext.tabManager.openContextWithNote(notePath, activate);
+        await appContext.tabManager.openContextWithNote(notePath, { activate });
 
         if (activate) {
             appContext.triggerEvent('focusAndSelectTitle');
@@ -130,56 +139,47 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
     };
 
     /**
-     * @typedef {Object} ToolbarButtonOptions
+     * Open a note in a new split.
-     * @property {string} title
+     *
-     * @property {string} [icon] - name of the boxicon to be used (e.g. "time" for "bx-time" icon)
+     * @method
-     * @property {function} action - callback handling the click on the button
+     * @param {string} notePath (or noteId)
-     * @property {string} [shortcut] - keyboard shortcut for the button, e.g. "alt+t"
+     * @param {boolean} activate - set to true to activate the new split, false to stay on the current split
+     * @returns {Promise<void>}
      */
+    this.openSplitWithNote = async (notePath, activate) => {
+        await ws.waitForMaxKnownEntityChangeId();
+
+        const subContexts = appContext.tabManager.getActiveContext().getSubContexts();
+        const {ntxId} = subContexts[subContexts.length - 1];
+
+        appContext.triggerCommand("openNewNoteSplit", {ntxId, notePath});
+
+        if (activate) {
+            appContext.triggerEvent('focusAndSelectTitle');
+        }
+    };
 
     /**
-     * Adds new button the the plugin area.
+     * Adds a new launcher to the launchbar. If the launcher (id) already exists, it will be updated.
      *
-     * @param {ToolbarButtonOptions} opts
+     * @method
+     * @deprecated you can now create/modify launchers in the top-left Menu -> Configure Launchbar
+     *             for special needs there's also backend API's createOrUpdateLauncher()
+     * @param {object} opts
+     * @property {string} [opts.id] - id of the button, used to identify the old instances of this button to be replaced
+     *                          ID is optional because of BC, but not specifying it is deprecated. ID can be alphanumeric only.
+     * @property {string} opts.title
+     * @property {string} [opts.icon] - name of the boxicon to be used (e.g. "time" for "bx-time" icon)
+     * @property {function} opts.action - callback handling the click on the button
+     * @property {string} [opts.shortcut] - keyboard shortcut for the button, e.g. "alt+t"
      */
-    this.addButtonToToolbar = opts => {
+    this.addButtonToToolbar = async opts => {
-        const buttonId = "toolbar-button-" + opts.title.replace(/\s/g, "-");
+        console.warn("api.addButtonToToolbar() has been deprecated since v0.58 and may be removed in the future. Use  Menu -> Configure Launchbar to create/update launchers instead.");
 
-        let button;
+        const {action, ...reqBody} = opts;
-        if (utils.isMobile()) {
+        reqBody.action = action.toString();
-            $('#plugin-buttons-placeholder').remove();
-            button = $('<a class="dropdown-item" href="#">')
-                .on('click', () => {
-                    setTimeout(() => $pluginButtons.dropdown('hide'), 0);
-                });
 
-            if (opts.icon) {
+        await server.put('special-notes/api-script-launcher', reqBody);
-                button.append($("<span>").addClass("bx bx-" + opts.icon))
-                    .append(" ");
-            }
-
-            button.append($("<span>").text(opts.title));
-        } else {
-            button = $('<span class="button-widget icon-action bx" data-toggle="tooltip" title="" data-placement="right"></span>')
-                .addClass("bx bx-" + (opts.icon || "question-mark"));
-
-            button.attr("title", opts.title);
-            button.tooltip({html: true});
-        }
-
-        button = button.on('click', opts.action);
-
-        button.attr('id', buttonId);
-
-        if ($("#" + buttonId).replaceWith(button).length === 0) {
-            $pluginButtons.append(button);
-        }
-
-        if (opts.shortcut) {
-            utils.bindGlobalShortcut(opts.shortcut, opts.action);
-
-            button.attr("title", "Shortcut " + opts.shortcut);
-        }
     };
 
     function prepareParams(params) {
@@ -189,7 +189,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
 
         return params.map(p => {
             if (typeof p === "function") {
-                return "!@#Function: " + p.toString();
+                return `!@#Function: ${p.toString()}`;
             }
             else {
                 return p;
@@ -201,9 +201,10 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * Executes given anonymous function on the backend.
      * Internally this serializes the anonymous function into string and sends it to backend via AJAX.
      *
+     * @method
      * @param {string} script - script to be executed on the backend
-     * @param {Array.<?>} params - list of parameters to the anonymous function to be send to backend
+     * @param {Array.<?>} params - list of parameters to the anonymous function to be sent to backend
-     * @return {Promise<*>} return value of the executed function on the backend
+     * @returns {Promise<*>} return value of the executed function on the backend
      */
     this.runOnBackend = async (script, params = []) => {
         if (typeof script === "function") {
@@ -225,23 +226,17 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
             return ret.executionResult;
         }
         else {
-            throw new Error("server error: " + ret.error);
+            throw new Error(`server error: ${ret.error}`);
         }
     };
 
-    /**
-     * @deprecated new name of this API call is runOnBackend so use that
-     * @method
-     */
-    this.runOnServer = this.runOnBackend;
-
     /**
      * This is a powerful search method - you can search by attributes and their values, e.g.:
      * "#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search
      *
      * @method
      * @param {string} searchString
-     * @returns {Promise<NoteShort[]>}
+     * @returns {Promise<FNote[]>}
      */
     this.searchForNotes = async searchString => {
         return await searchService.searchForNotes(searchString);
@@ -253,7 +248,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      *
      * @method
      * @param {string} searchString
-     * @returns {Promise<NoteShort|null>}
+     * @returns {Promise<FNote|null>}
      */
     this.searchForNote = async searchString => {
         const notes = await this.searchForNotes(searchString);
@@ -264,8 +259,9 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
     /**
      * Returns note by given noteId. If note is missing from cache, it's loaded.
      **
+     * @method
      * @param {string} noteId
-     * @return {Promise<NoteShort>}
+     * @returns {Promise<FNote>}
      */
     this.getNote = async noteId => await froca.getNote(noteId);
 
@@ -275,17 +271,18 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * This is often used to bulk-fill the cache with notes which would have to be picked one by one
      * otherwise (by e.g. createNoteLink())
      *
+     * @method
      * @param {string[]} noteIds
      * @param {boolean} [silentNotFoundError] - don't report error if the note is not found
-     * @return {Promise<NoteShort[]>}
+     * @returns {Promise<FNote[]>}
      */
     this.getNotes = async (noteIds, silentNotFoundError = false) => await froca.getNotes(noteIds, silentNotFoundError);
 
     /**
      * Update frontend tree (note) cache from the backend.
      *
-     * @param {string[]} noteIds
      * @method
+     * @param {string[]} noteIds
      */
     this.reloadNotes = async noteIds => await froca.reloadNotes(noteIds);
 
@@ -293,7 +290,8 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * Instance name identifies particular Trilium instance. It can be useful for scripts
      * if some action needs to happen on only one specific instance.
      *
-     * @return {string}
+     * @method
+     * @returns {string}
      */
     this.getInstanceName = () => window.glob.instanceName;
 
@@ -328,10 +326,22 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
     this.showError = toastService.showError;
 
     /**
+     * Trigger command.
+     *
      * @method
-     * @deprecated - this is now no-op since all the changes should be gracefully handled per widget
+     * @param {string} name
+     * @param {object} data
      */
-    this.refreshTree = () => {};
+    this.triggerCommand = (name, data) => appContext.triggerCommand(name, data);
+
+    /**
+     * Trigger event.
+     *
+     * @method
+     * @param {string} name
+     * @param {object} data
+     */
+    this.triggerEvent = (name, data) => appContext.triggerEvent(name, data);
 
     /**
      * Create note link (jQuery object) for given note.
@@ -342,58 +352,76 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * @param {boolean} [params.showTooltip=true] - enable/disable tooltip on the link
      * @param {boolean} [params.showNotePath=false] - show also whole note's path as part of the link
      * @param {boolean} [params.showNoteIcon=false] - show also note icon before the title
-     * @param {string} [title=] - custom link tile with note's title as default
+     * @param {string} [params.title=] - custom link tile with note's title as default
      */
     this.createNoteLink = linkService.createNoteLink;
 
     /**
      * Adds given text to the editor cursor
      *
-     * @param {string} text - this must be clear text, HTML is not supported.
      * @method
+     * @param {string} text - this must be clear text, HTML is not supported.
      */
-    this.addTextToActiveTabEditor = text => appContext.triggerCommand('addTextToActiveEditor', {text});
+    this.addTextToActiveContextEditor = text => appContext.triggerCommand('addTextToActiveEditor', {text});
 
     /**
      * @method
-     * @returns {NoteShort} active note (loaded into right pane)
+     * @returns {FNote} active note (loaded into right pane)
      */
-    this.getActiveTabNote = () => appContext.tabManager.getActiveContextNote();
+    this.getActiveContextNote = () => appContext.tabManager.getActiveContextNote();
 
     /**
      * See https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html for a documentation on the returned instance.
      *
      * @method
-     * @param callback - method receiving "textEditor" instance
+     * @returns {Promise<CKEditor>} instance of CKEditor
      */
-    this.getActiveTabTextEditor = callback => appContext.triggerCommand('executeInActiveEditor', {callback});
+    this.getActiveContextTextEditor = () => appContext.tabManager.getActiveContext()?.getTextEditor();
+
+    /**
+     * See https://codemirror.net/doc/manual.html#api
+     *
+     * @method
+     * @returns {Promise<CodeMirror>} instance of CodeMirror
+     */
+    this.getActiveContextCodeEditor = () => appContext.tabManager.getActiveContext()?.getCodeEditor();
+
+    /**
+     * Get access to the widget handling note detail. Methods like `getWidgetType()` and `getTypeWidget()` to get to the
+     * implementation of actual widget type.
+     *
+     * @method
+     * @returns {Promise<NoteDetailWidget>}
+     */
+    this.getActiveNoteDetailWidget = () => new Promise(resolve => appContext.triggerCommand('executeInActiveNoteDetailWidget', {callback: resolve}));
 
     /**
      * @method
      * @returns {Promise<string|null>} returns note path of active note or null if there isn't active note
      */
-    this.getActiveTabNotePath = () => appContext.tabManager.getActiveContextNotePath();
+    this.getActiveContextNotePath = () => appContext.tabManager.getActiveContextNotePath();
+
+    /**
+     * Returns component which owns given DOM element (the nearest parent component in DOM tree)
+     *
+     * @method
+     * @param {Element} el - DOM element
+     * @returns {Component}
+     */
+    this.getComponentByEl = el => appContext.getComponentByEl(el);
 
     /**
      * @method
-     * @param {object} $el - jquery object on which to setup the tooltip
+     * @param {object} $el - jquery object on which to set up the tooltip
+     * @returns {Promise<void>}
      */
     this.setupElementTooltip = noteTooltipService.setupElementTooltip;
 
-    /**
-     * @deprecated use protectNote and protectSubtree instead
-     * @method
-     */
-    this.protectActiveNote = async () => {
-        const activeNote = appContext.tabManager.getActiveContextNote();
-
-        await protectedSessionService.protectNote(activeNote.noteId, true, false);
-    };
-
     /**
      * @method
      * @param {string} noteId
      * @param {boolean} protect - true to protect note, false to unprotect
+     * @returns {Promise<void>}
      */
     this.protectNote = async (noteId, protect) => {
         await protectedSessionService.protectNote(noteId, protect, false);
@@ -403,6 +431,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * @method
      * @param {string} noteId
      * @param {boolean} protect - true to protect subtree, false to unprotect
+     * @returns {Promise<void>}
      */
     this.protectSubTree = async (noteId, protect) => {
         await protectedSessionService.protectNote(noteId, protect, true);
@@ -412,7 +441,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * Returns date-note for today. If it doesn't exist, it is automatically created.
      *
      * @method
-     * @return {Promise<NoteShort>}
+     * @returns {Promise<FNote>}
      */
     this.getTodayNote = dateNotesService.getTodayNote;
 
@@ -421,17 +450,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      *
      * @method
      * @param {string} date - e.g. "2019-04-29"
-     * @return {Promise<NoteShort>}
+     * @returns {Promise<FNote>}
-     * @deprecated use getDayNote instead
-     */
-    this.getDateNote = dateNotesService.getDayNote;
-
-    /**
-     * Returns day note for a given date. If it doesn't exist, it is automatically created.
-     *
-     * @method
-     * @param {string} date - e.g. "2019-04-29"
-     * @return {Promise<NoteShort>}
      */
     this.getDayNote = dateNotesService.getDayNote;
 
@@ -440,7 +459,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      *
      * @method
      * @param {string} date - e.g. "2019-04-29"
-     * @return {Promise<NoteShort>}
+     * @returns {Promise<FNote>}
      */
      this.getWeekNote = dateNotesService.getWeekNote;
 
@@ -449,7 +468,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      *
      * @method
      * @param {string} month - e.g. "2019-04"
-     * @return {Promise<NoteShort>}
+     * @returns {Promise<FNote>}
      */
     this.getMonthNote = dateNotesService.getMonthNote;
 
@@ -458,7 +477,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      *
      * @method
      * @param {string} year - e.g. "2019"
-     * @return {Promise<NoteShort>}
+     * @returns {Promise<FNote>}
      */
     this.getYearNote = dateNotesService.getYearNote;
 
@@ -467,7 +486,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      *
      * @method
      * @param {string} noteId - set hoisted note. 'root' will effectively unhoist
-     * @return {Promise}
+     * @returns {Promise<void>}
      */
     this.setHoistedNoteId = (noteId) => {
         const activeNoteContext = appContext.tabManager.getActiveContext();
@@ -481,8 +500,11 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * @method
      * @param {string} keyboardShortcut - e.g. "ctrl+shift+a"
      * @param {function} handler
+     * @param {string} [namespace] - specify namespace of the handler for the cases where call for bind may be repeated.
+     *                               If a handler with this ID exists, it's replaced by the new handler.
+     * @returns {Promise<void>}
      */
-    this.bindGlobalShortcut = utils.bindGlobalShortcut;
+    this.bindGlobalShortcut = shortcutService.bindGlobalShortcut;
 
     /**
      * Trilium runs in backend and frontend process, when something is changed on the backend from script,
@@ -492,6 +514,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * Typical use case is when new note has been created, we should wait until it is synced into frontend and only then activate it.
      *
      * @method
+     * @returns {Promise<void>}
      */
     this.waitUntilSynced = ws.waitForMaxKnownEntityChangeId;
 
@@ -499,6 +522,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * This will refresh all currently opened notes which have included note specified in the parameter
      *
      * @param includedNoteId - noteId of the included note
+     * @returns {Promise<void>}
      */
     this.refreshIncludedNote = includedNoteId => appContext.triggerEvent('refreshIncludedNote', {noteId: includedNoteId});
 
@@ -510,6 +534,34 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
      * @returns {string} random string
      */
     this.randomString = utils.randomString;
+
+    this.logMessages = {};
+    this.logSpacedUpdates = {};
+
+    /**
+     * Log given message to the log pane in UI
+     *
+     * @param message
+     * @returns {void}
+     */
+    this.log = message => {
+        const {noteId} = this.startNote;
+
+        message = `${utils.now()}: ${message}`;
+
+        console.log(`Script ${noteId}: ${message}`);
+
+        this.logMessages[noteId] = this.logMessages[noteId] || [];
+        this.logSpacedUpdates[noteId] = this.logSpacedUpdates[noteId] || new SpacedUpdate(() => {
+            const messages = this.logMessages[noteId];
+            this.logMessages[noteId] = [];
+
+            appContext.triggerEvent("apiLogMessages", {noteId, messages});
+        }, 100);
+
+        this.logMessages[noteId].push(message);
+        this.logSpacedUpdates[noteId].scheduleUpdate();
+    };
 }
 
 export default FrontendScriptApi;
@@ -523,13 +575,13 @@ export default FrontendScriptApi;
 </div>
 
 <nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FAttribute.html">FAttribute</a></li><li><a href="FBranch.html">FBranch</a></li><li><a href="FNote.html">FNote</a></li><li><a href="FNoteComplement.html">FNoteComplement</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.1</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/frontend_api/widgets_collapsible_widget.js.html

@@ -1,90 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Source: widgets/collapsible_widget.js</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Source: widgets/collapsible_widget.js</h1>
-
-    
-
-
-
-    
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>import NoteContextAwareWidget from "./note_context_aware_widget.js";
-
-const WIDGET_TPL = `
-&lt;div class="card widget">
-    &lt;div class="card-header">&lt;/div>
-
-    &lt;div id="[to be set]" class="body-wrapper">
-        &lt;div class="card-body">&lt;/div>
-    &lt;/div>
-&lt;/div>`;
-
-export default class CollapsibleWidget extends NoteContextAwareWidget {
-    get widgetTitle() { return "Untitled widget"; }
-
-    get help() { return {}; }
-
-    doRender() {
-        this.$widget = $(WIDGET_TPL);
-        this.contentSized();
-        this.$widget.find('[data-target]').attr('data-target', "#" + this.componentId);
-
-        this.$bodyWrapper = this.$widget.find('.body-wrapper');
-        this.$bodyWrapper.attr('id', this.componentId); // for toggle to work we need id
-
-        this.$body = this.$bodyWrapper.find('.card-body');
-
-        this.$title = this.$widget.find('.card-header');
-        this.$title.text(this.widgetTitle);
-
-        this.initialized = this.doRenderBody();
-    }
-
-    /** for overriding */
-    async doRenderBody() {}
-
-    isExpanded() {
-        return this.$bodyWrapper.hasClass("show");
-    }
-}
-</code></pre>
-        </article>
-    </section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
-</nav>
-
-<br class="clear">
-
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

dump-db/README.md

@@ -6,7 +6,7 @@ It is meant as a last resort solution when the standard mean to access your data
 
 ## Installation
 
-This tool requires node.js, testing has been done on 16.14.2, but it will probably work on other versions as well.
+This tool requires node.js, testing has been done on 16.18.0, but it will probably work on other versions as well.
 
 ```
 npm install

dump-db/dump-db.js

@@ -2,7 +2,7 @@
 
 const yargs = require('yargs/yargs')
 const { hideBin } = require('yargs/helpers')
-const dumpService = require("./inc/dump.js");
+const dumpService = require("./inc/dump");
 
 yargs(hideBin(process.argv))
     .command('$0 <path_to_document> <target_directory>', 'dump the contents of document.db into the target directory', (yargs) => {

dump-db/inc/data_key.js

@@ -1,6 +1,6 @@
 const crypto = require("crypto");
-const sql = require("./sql.js");
+const sql = require("./sql");
-const decryptService = require("./decrypt.js");
+const decryptService = require("./decrypt");
 
 function getDataKey(password) {
     if (!password) {

dump-db/inc/decrypt.js

@@ -48,7 +48,7 @@ function decrypt(key, cipherText, ivLength = 13) {
     }
     catch (e) {
         // recovery from https://github.com/zadam/trilium/issues/510
-        if (e.message && e.message.includes("WRONG_FINAL_BLOCK_LENGTH")) {
+        if (e.message?.includes("WRONG_FINAL_BLOCK_LENGTH") || e.message?.includes("wrong final block length")) {
             log.info("Caught WRONG_FINAL_BLOCK_LENGTH, returning cipherText instead");
 
             return cipherText;

dump-db/inc/dump.js

@@ -1,9 +1,9 @@
 const fs = require("fs");
 const sanitize = require("sanitize-filename");
-const sql = require("./sql.js");
+const sql = require("./sql");
-const decryptService = require("./decrypt.js");
+const decryptService = require("./decrypt");
-const dataKeyService = require("./data_key.js");
+const dataKeyService = require("./data_key");
-const extensionService = require("./extension.js");
+const extensionService = require("./extension");
 
 function dumpDocument(documentPath, targetPath, options) {
     const stats = {

dump-db/package-lock.json

@@ -387,9 +387,12 @@
       }
     },
     "node_modules/minimist": {
-      "version": "1.2.5",
+      "version": "1.2.7",
-      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.7.tgz",
-      "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw=="
+      "integrity": "sha512-bzfL1YUZsP41gmu/qjrEk0Q6i2ix/cVeAhbCbqH9u3zYutS1cLg00qhrD0M2MVdCcx4Sc0UpP2eBWo9rotpq6g==",
+      "funding": {
+        "url": "https://github.com/sponsors/ljharb"
+      }
     },
     "node_modules/mkdirp-classic": {
       "version": "0.5.3",
@@ -1163,9 +1166,9 @@
       "integrity": "sha512-z0yWI+4FDrrweS8Zmt4Ej5HdJmky15+L2e6Wgn3+iK5fWzb6T3fhNFq2+MeTRb064c6Wr4N/wv0DzQTjNzHNGQ=="
     },
     "minimist": {
-      "version": "1.2.5",
+      "version": "1.2.7",
-      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
+      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.7.tgz",
-      "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw=="
+      "integrity": "sha512-bzfL1YUZsP41gmu/qjrEk0Q6i2ix/cVeAhbCbqH9u3zYutS1cLg00qhrD0M2MVdCcx4Sc0UpP2eBWo9rotpq6g=="
     },
     "mkdirp-classic": {
       "version": "0.5.3",

electron.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const {app, globalShortcut} = require('electron');
+const {app, globalShortcut, BrowserWindow} = require('electron');
 const sqlInit = require('./src/services/sql_init');
 const appIconService = require('./src/services/app_icon');
 const windowService = require('./src/services/window');
@@ -13,12 +13,12 @@ appIconService.installLocalAppIcon();
 
 require('electron-dl')({ saveAs: true });
 
+// Quit when all windows are closed, except on macOS. There, it's common
+// for applications and their menu bar to stay active until the user quits
+// explicitly with Cmd + Q.
 app.on('window-all-closed', () => {
     if (process.platform !== 'darwin') {
-        app.quit();
+        app.quit()
-    }
-    else if (process.platform === 'win32') {
-        app.exit(0); // attempt to fix the issue when app.quite() won't terminate processes on windows
     }
 });
 
@@ -27,10 +27,18 @@ app.on('ready', async () => {
 
     // if db is not initialized -> setup process
     // if db is initialized, then we need to wait until the migration process is finished
-    if (await sqlInit.isDbInitialized()) {
+    if (sqlInit.isDbInitialized()) {
         await sqlInit.dbReady;
 
-        await windowService.createMainWindow();
+        await windowService.createMainWindow(app);
+
+        if (process.platform === 'darwin') {
+            app.on('activate', async () => {
+                if (BrowserWindow.getAllWindows().length === 0) {
+                    await windowService.createMainWindow(app);
+                }
+            });
+        }
 
         tray.createTray();
     }

libraries/boxicons/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2021 Aniket Suvarna
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.