release 0.61.3-beta

Fix bugs in highlights，v0.61.0-beta

.eslintignore

@@ -0,0 +1,7 @@
+node_modules
+dist
+bin
+docs
+libraries
+coverage
+play

.eslintrc.js

@@ -0,0 +1,211 @@
+module.exports = {
+    env: {
+        browser: true,
+        commonjs: true,
+        es2021: true,
+        node: true,
+    },
+    // plugins: ['prettier'], // to be activated
+    extends: ['eslint:recommended', 'airbnb-base', 'plugin:jsonc/recommended-with-jsonc', 'prettier'],
+    overrides: [
+        {
+            files: ['*.json', '*.json5', '*.jsonc'],
+            parser: 'jsonc-eslint-parser',
+        },
+        {
+            files: ['package.json'],
+            parser: 'jsonc-eslint-parser',
+            rules: {
+                'jsonc/sort-keys': [
+                    'off',
+                    {
+                        pathPattern: '^$',
+                        order: [
+                            'name',
+                            'version',
+                            'private',
+                            'packageManager',
+                            'description',
+                            'type',
+                            'keywords',
+                            'homepage',
+                            'bugs',
+                            'license',
+                            'author',
+                            'contributors',
+                            'funding',
+                            'files',
+                            'main',
+                            'module',
+                            'exports',
+                            'unpkg',
+                            'jsdelivr',
+                            'browser',
+                            'bin',
+                            'man',
+                            'directories',
+                            'repository',
+                            'publishConfig',
+                            'scripts',
+                            'peerDependencies',
+                            'peerDependenciesMeta',
+                            'optionalDependencies',
+                            'dependencies',
+                            'devDependencies',
+                            'engines',
+                            'config',
+                            'overrides',
+                            'pnpm',
+                            'husky',
+                            'lint-staged',
+                            'eslintConfig',
+                        ],
+                    },
+                    {
+                        pathPattern: '^(?:dev|peer|optional|bundled)?[Dd]ependencies$',
+                        order: { type: 'asc' },
+                    },
+                ],
+            },
+        },
+    ],
+    globals: {
+        $: true,
+        jQuery: true,
+        glob: true,
+        log: true,
+        EditorWatchdog: true,
+        // \src\share\canvas_share.js
+        React: true,
+        appState: true,
+        ExcalidrawLib: true,
+        elements: true,
+        files: true,
+        ReactDOM: true,
+        // src\public\app\widgets\type_widgets\relation_map.js
+        jsPlumb: true,
+        panzoom: true,
+        logError: true,
+        // src\public\app\widgets\type_widgets\image.js
+        WZoom: true,
+        // \src\public\app\widgets\type_widgets\read_only_text.js
+        renderMathInElement: true,
+        // \src\public\app\widgets\type_widgets\editable_text.js
+        BalloonEditor: true,
+        FancytreeNode: true,
+        CKEditorInspector: true,
+        // \src\public\app\widgets\type_widgets\editable_code.js
+        CodeMirror: true,
+        // \src\public\app\services\resizer.js
+        Split: true,
+        // \src\public\app\services\content_renderer.js
+        mermaid: true,
+        // src\public\app\services\frontend_script_api.js
+        dayjs: true,
+        // \src\public\app\widgets\note_map.js
+        ForceGraph: true,
+        // \src\public\app\setup.js
+        ko: true,
+        syncInProgress: true,
+        // src\public\app\services\utils.js
+        logInfo: true,
+        __non_webpack_require__: true,
+        //
+    },
+    parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+    },
+    rules: {
+        // eslint:recommended
+        'no-unused-vars': 'off',
+        'linebreak-style': 'off',
+        'no-useless-escape': 'off',
+        'no-empty': 'off',
+        'no-constant-condition': 'off',
+        'getter-return': 'off',
+        'no-cond-assign': 'off',
+        'no-async-promise-executor': 'off',
+        'no-extra-semi': 'off',
+        'no-inner-declarations': 'off',
+
+        // prettier
+        'prettier/prettier': ['off', { endOfLine: 'auto' }],
+
+        // airbnb-base
+        'no-console': 'off',
+        'no-plusplus': 'off',
+        'no-param-reassign': 'off',
+        'global-require': 'off',
+        'no-use-before-define': 'off',
+        'no-await-in-loop': 'off',
+        radix: 'off',
+        'import/order': 'off',
+        'import/no-extraneous-dependencies': 'off',
+        'prefer-destructuring': 'off',
+        'no-shadow': 'off',
+        'no-new': 'off',
+        'no-restricted-syntax': 'off',
+        strict: 'off',
+        'class-methods-use-this': 'off',
+        'no-else-return': 'off',
+        'import/no-dynamic-require': 'off',
+        'no-underscore-dangle': 'off',
+        'prefer-template': 'off',
+        'consistent-return': 'off',
+        'no-continue': 'off',
+        'object-shorthand': 'off',
+        'one-var': 'off',
+        'prefer-const': 'off',
+        'spaced-comment': 'off',
+        'no-loop-func': 'off',
+        'arrow-body-style': 'off',
+
+        'guard-for-in': 'off',
+        'no-return-assign': 'off',
+        'dot-notation': 'off',
+
+        'func-names': 'off',
+        'import/no-useless-path-segments': 'off',
+        'default-param-last': 'off',
+        'prefer-arrow-callback': 'off',
+        'no-unneeded-ternary': 'off',
+        'no-return-await': 'off',
+        'import/extensions': 'off',
+
+        'no-var': 'off',
+        'import/newline-after-import': 'off',
+        'no-restricted-globals': 'off',
+        'operator-assignment': 'off',
+        'no-eval': 'off',
+        'max-classes-per-file': 'off',
+        'vars-on-top': 'off',
+        'no-bitwise': 'off',
+        'no-lonely-if': 'off',
+        'no-multi-assign': 'off',
+        'no-promise-executor-return': 'off',
+        'no-empty-function': 'off',
+        'import/no-unresolved': 'off',
+        camelcase: 'off',
+        eqeqeq: 'off',
+        'lines-between-class-members': 'off',
+        'import/no-cycle': 'off',
+        'new-cap': 'off',
+        'prefer-object-spread': 'off',
+        'no-new-func': 'off',
+        'no-unused-expressions': 'off',
+        'lines-around-directive': 'off',
+        'prefer-exponentiation-operator': 'off',
+        'no-restricted-properties': 'off',
+        'prefer-rest-params': 'off',
+        'no-unreachable-loop': 'off',
+        'no-alert': 'off',
+        'no-useless-return': 'off',
+        'no-nested-ternary': 'off',
+        'prefer-regex-literals': 'off',
+        'import/no-named-as-default-member': 'off',
+        yoda: 'off',
+        'no-script-url': 'off',
+        'no-prototype-builtins':'off'
+    },
+};

.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,5 @@ cert.crt
 server-package.json
 .idea/httpRequests/
 data/
+tmp/
+.eslintcache

.gitpod.yml

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

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+#npx lint-staged

.idea/dataSources.xml

@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="DataSourceManagerImpl" format="xml" multifile-model="true">
-    <data-source source="LOCAL" name="SQLite - document.db" uuid="30cef30d-e704-484d-a4ca-5d3bfc2ece63">
+    <data-source source="LOCAL" name="document.db" uuid="2a4ac1e6-b828-4a2a-8e4a-3f59f10aff26">
       <driver-ref>sqlite.xerial</driver-ref>
       <synchronize>true</synchronize>
       <jdbc-driver>org.sqlite.JDBC</jdbc-driver>
-      <jdbc-url>jdbc:sqlite:$PROJECT_DIR$/../trilium-data/document.db</jdbc-url>
+      <jdbc-url>jdbc:sqlite:$PROJECT_DIR$/data/document.db</jdbc-url>
       <working-dir>$ProjectFileDir$</working-dir>
     </data-source>
   </component>

.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/inspectionProfiles/Project_Default.xml

@@ -1,7 +1,7 @@
 <component name="InspectionProjectProfileManager">
   <profile version="1.0">
     <option name="myName" value="Project Default" />
-    <inspection_tool class="JSUnfilteredForInLoop" enabled="false" level="WARNING" enabled_by_default="false" />
+    <inspection_tool class="Eslint" enabled="true" level="WARNING" enabled_by_default="true" />
     <inspection_tool class="SpellCheckingInspection" enabled="false" level="TYPO" enabled_by_default="false">
       <option name="processCode" value="true" />
       <option name="processLiterals" value="true" />

.idea/jsLinters/eslint.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="EslintConfiguration">
+    <option name="fix-on-save" value="true" />
+  </component>
+</project>

.idea/misc.xml

@@ -1,9 +1,8 @@
-<?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
   <component name="JavaScriptSettings">
     <option name="languageLevel" value="ES6" />
   </component>
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_18" default="true" project-jdk-name="openjdk-18" 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>
 </project>

.prettierrc.js

@@ -0,0 +1,11 @@
+//https://prettier.io/docs/en/options.html 
+module.exports = {
+	semi: true,
+	trailingComma: 'es5',
+	singleQuote: true,
+	printWidth: 120,
+	tabWidth: 4,
+	// useTabs: false,
+	// bracketSpacing: true,
+	// htmlWhitespaceSensitivity: 'ignore',
+};

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "esbenp.prettier-vscode",
+  ]
+}

.vscode/launch.json

@@ -1,18 +1,24 @@
 {
     "version": "0.2.0",
     "configurations": [
+        // nodemon should be installed globally, use npm i -g nodemon
         {
-            "type": "node",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "name": "nodemon start-server",
+            "program": "${workspaceFolder}/src/www",
             "request": "launch",
-            "name": "start-server",
+            "restart": true,
+            "runtimeExecutable": "nodemon",
+            "env": {
+                "TRILIUM_ENV": "dev",
+                "TRILIUM_DATA_DIR": "./data"
+            },
             "skipFiles": [
                 "<node_internals>/**"
             ],
-            "env": {
-                "TRILIUM_ENV": "dev"
-            },
+            "type": "node",
             "outputCapture": "std",
-            "program": "${workspaceFolder}/src/www"
-        }
+        },
     ]
 }

.vscode/settings.json

@@ -0,0 +1,33 @@
+{
+  "[javascript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "editor.formatOnSave": true,
+  "eslint.format.enable": true,
+  "eslint.probe": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "html",
+    "vue",
+    "markdown",
+    "json",
+    "jsonc"
+  ],
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "html",
+    "vue",
+    "markdown",
+    "json",
+    "jsonc"
+  ],
+  "files.eol": "\n",
+}

DockerHealthcheck.sh

@@ -1,6 +0,0 @@
-#!/bin/sh
-if wget --spider -S "127.0.0.1:8080/api/health-check" 2>&1 | awk 'NR==2' | grep -w "HTTP/1.1 200 OK" ; then
-    exit 0
-else
-    exit 1
-fi

Dockerfile

@@ -1,9 +1,12 @@
 # !!! Don't try to build this Dockerfile directly, run it through bin/build-docker.sh script !!!
-FROM node:16.15.0-alpine
+FROM node:18.16.1-alpine
 
 # Create app directory
 WORKDIR /usr/src/app
 
+# Bundle app source
+COPY . .
+
 COPY server-package.json package.json
 
 # Install app dependencies
@@ -18,15 +21,17 @@ RUN set -x \
         nasm \
         libpng-dev \
         python3 \
-    && npm install --production \
-    && apk del .build-dependencies
+    && npm install \
+    && 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
 
 # Some setup tools need to be kept
 RUN apk add --no-cache su-exec shadow
 
-# Bundle app source
-COPY . .
-
 # Add application user and setup proper volume permissions
 RUN adduser -s /bin/false node; exit 0
 
@@ -34,4 +39,4 @@ RUN adduser -s /bin/false node; exit 0
 EXPOSE 8080
 CMD [ "./start-docker.sh" ]
 
-HEALTHCHECK CMD sh DockerHealthcheck.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)
+[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) | [Japanese](https://github.com/zadam/trilium/blob/master/README.ja.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)
-* 可用性和性能均能很好地扩展至超过10万个笔记
-* 针对智能手机和平板电脑进行触摸优化的[移动前端](https://github.com/zadam/trilium/wiki/Mobile-frontend)
+* [脚本](https://github.com/zadam/trilium/wiki/Scripts) - 请参阅[高级功能展示](https://github.com/zadam/trilium/wiki/Advanced-showcases)
+* 在拥有超过 10 万条笔记时仍能保持良好的可用性和性能
+* 针对智能手机和平板电脑进行优化的[用于移动设备的前端](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)
-* [Web Clipper](https://github.com/zadam/trilium/wiki/Web-clipper)可轻松保存Web内容
+* [Evernote](https://github.com/zadam/trilium/wiki/Evernote-import) 和 [Markdown 导入导出](https://github.com/zadam/trilium/wiki/Markdown)功能
+* 使用[网页剪藏](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/wiki/Server-installation)。
-    * 当前仅支持（经过测试）最新的Chrome和Firefox浏览器。
+* 如果要在桌面上使用 Trilium，请从[最新版本](https://github.com/zadam/trilium/releases/latest)下载适用于您平台的二进制版本，解压缩该软件包并运行`trilium`可执行文件。
+* 如果要在服务器上安装 Trilium，请参考[此页面](https://github.com/zadam/trilium/wiki/Server-installation)。
+  * 当前仅支持（测试过）最近发布的 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) - 市场上最好的所见即所得编辑器，互动性强且聆听能力强的团队
-* [FancyTree](https://github.com/mar10/fancytree) - 一个非常丰富的关于树的库，强大的没有对手。没有它，Trilium Notes将不会如此。
+* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - 市面上最好的所见即所得编辑器，拥有互动性强且聆听能力强的团队
+* [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.ja.md

@@ -0,0 +1,83 @@
+# 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) | [Japanese](https://github.com/zadam/trilium/blob/master/README.ja.md)
+
+Trilium Notes は、大規模な個人知識ベースの構築に焦点を当てた、階層型ノートアプリケーションです。概要は[スクリーンショット](https://github.com/zadam/trilium/wiki/Screenshot-tour)をご覧ください：
+
+<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>
+
+ウクライナは現在、ロシアの侵略から自国を守っています。[ウクライナ軍や人道的な慈善団体への寄付](https://standforukraine.com/)をご検討ください。
+
+<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>
+
+## 🎁 特徴
+
+* ノートは、任意の深さのツリーに配置できます。単一のノートをツリー内の複数の場所に配置できます ([cloning](https://github.com/zadam/trilium/wiki/Cloning-notes) を参照)
+* マークダウン[オートフォーマット](https://github.com/zadam/trilium/wiki/Text-notes#autoformat)による、表、画像、[数学](https://github.com/zadam/trilium/wiki/Text-notes#math-support)などの豊富な WYSIWYG ノート編集機能
+* シンタックスハイライトを含む[ソースコード付きノート](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-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)を参照
+* 自動化のための [REST API](https://github.com/zadam/trilium/wiki/ETAPI)
+* ユーザビリティとパフォーマンスの両方で 100 000 ノート以上に拡張可能
+* スマートフォンとタブレット向けのタッチ最適化[モバイルフロントエンド](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)
+* Web コンテンツを簡単に保存するための [Web クリッパー](https://github.com/zadam/trilium/wiki/Web-clipper)
+
+サードパーティのテーマ、スクリプト、プラグインなどは、 [awesome-trilium](https://github.com/Nriver/awesome-trilium) をチェックしてください。
+
+## 🏗 ビルド
+
+Trilium は、デスクトップアプリケーション（Linux、Windows）またはサーバー上でホストされるウェブアプリケーション（Linux）として提供されます。 Mac OS のデスクトップビルドも利用可能ですが、 [unsupported](https://github.com/zadam/trilium/wiki/FAQ#mac-os-support) となっています。
+
+* デスクトップで Trilium を使用したい場合は、 [latest release](https://github.com/zadam/trilium/releases/latest) からお使いのプラットフォームのバイナリリリースをダウンロードし、パッケージを解凍して ``trilium`` の実行ファイルを実行してください。
+* サーバーに Trilium をインストールする場合は、[このページ](https://github.com/zadam/trilium/wiki/Server-installation)に従ってください。
+  * 現在、対応（動作確認）しているブラウザは、最近の 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/)
+
+また、[個人的な知識基盤のパターン](https://github.com/zadam/trilium/wiki/Patterns-of-personal-knowledge-base)を読むと、 Trilium の使い方のヒントを得ることができます。
+
+## 💻 コントリビュート
+
+ブラウザベースの開発環境を使用
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/zadam/trilium)
+
+または、ローカルにクローンして実行
+```
+npm install
+npm run start-server
+```
+
+## 📢 シャウトアウト
+
+* [CKEditor 5](https://github.com/ckeditor/ckeditor5) - 市場で最高の WYSIWYG エディター、非常にインタラクティブで聞き上手なチーム
+* [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)で使用。
+
+## 🤝 サポート
+
+GitHub スポンサー、[PayPal](https://paypal.me/za4am)もしくは Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2) にて Trilium をサポートすることができます。
+
+## 🔑 ライセンス
+
+このプログラムはフリーソフトウェアです：フリーソフトウェア財団が発行した GNU Affero General Public License のバージョン3、またはそれ以降のバージョンのいずれかに従って、再配布および/または改変することができます。

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) | [Japanese](https://github.com/zadam/trilium/blob/master/README.ja.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 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,7 +25,7 @@ Ukraine is currently defending itself from Russian aggression, please consider [
   * 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 bult-in Excalidraw (note type "canvas")
+* 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
@@ -33,7 +35,9 @@ Ukraine is currently defending itself from Russian aggression, please consider [
 * [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).
 
@@ -41,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
 
@@ -59,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 Trilium 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

@@ -1,6 +1,6 @@
 # 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)
+[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) | [Japanese](https://github.com/zadam/trilium/blob/master/README.ja.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):
@@ -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

@@ -24,12 +24,10 @@ mv "./dist/Trilium Notes-linux-x64" $BUILD_DIR
 
 cp images/app-icons/png/128x128.png $BUILD_DIR/icon.png
 
-# removing software WebGL binaries because they are pretty huge and not necessary
-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.15.0
+NODE_VERSION=18.16.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

@@ -22,14 +22,12 @@ rm -rf $BUILD_DIR
 
 mv "./dist/Trilium Notes-win32-x64" $BUILD_DIR
 
-# removing software WebGL binaries because they are pretty huge and not necessary
-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.15.0 npm run webpack
+n exec 18.16.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.15.0 npm install --only=prod)
+(cd $DIR && n exec 18.16.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

@@ -13,22 +13,45 @@ then
     exit 1
 fi
 
-VERSION_DATE=$(git log -1 --format=%aI v${VERSION} | cut -c -10)
-VERSION_COMMIT=$(git rev-list -n 1 v${VERSION})
-
-echo "Updating files with version ${VERSION}, date ${VERSION_DATE} and commit ${VERSION_COMMIT}"
+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
+cd ~/trilium-flathub || exit
 
 if ! git diff-index --quiet HEAD --; then
     echo "There are uncommitted changes"
     exit 1
 fi
 
-xmlstarlet ed --inplace --update "/component/releases/release/@version" --value "${VERSION}" --update "/component/releases/release/@date" --value "${VERSION_DATE}" ./trilium-flathub/com.github.zadam.trilium.metainfo.xml
+BASE_BRANCH=master
 
-yq --inplace "(.modules[0].sources[0].tag = \"v${VERSION}\") | (.modules[0].sources[0].commit = \"${VERSION_COMMIT}\")" ./trilium-flathub/com.github.zadam.trilium.yml
+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
+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,165 @@
 
 UPDATE etapi_tokens SET tokenHash = 'API token hash value';
-UPDATE notes SET title = 'title' WHERE title NOT IN ('root', 'hidden', 'share');
-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 notes SET title = 'title' WHERE noteId != 'root' AND noteId NOT LIKE '\_%' ESCAPE '\';
+UPDATE blobs SET content = 'text' WHERE content IS NOT NULL;
+UPDATE revisions SET title = 'title';
+
+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',
+                                     'cssClass',
+                                     'iconClass',
+                                     'keyboardShortcut',
+                                     'run',
+                                     'runOnInstance',
+                                     'runAtHour',
+                                     'customRequestHandler',
+                                     'customResourceProvider',
+                                     'widget',
+                                     'noteInfoWidgetDisabled',
+                                     'linkMapWidgetDisabled',
+                                     'revisionsWidgetDisabled',
+                                     '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',
+                                     'revisionsWidgetDisabled',
+                                     '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', 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' 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');
 UPDATE branches SET prefix = 'prefix' WHERE prefix IS NOT NULL AND prefix != 'recovered';
 UPDATE options SET value = 'anonymized' WHERE name IN
-                    ('documentId', 'documentSecret', 'encryptedDataKey', 
-                     'passwordVerificationHash', 'passwordVerificationSalt', 
-                     'passwordDerivedKeySalt', 'username', 'syncServerHost', 'syncProxy') 
+                    ('documentId', 'documentSecret', 'encryptedDataKey',
+                     'passwordVerificationHash', 'passwordVerificationSalt',
+                     '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
-IF %ERRORLEVEL% NEQ 0 (start trilium.exe) ELSE (powershell.exe ./trilium-no-cert-check.ps1)
+start trilium.exe
+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
-IF %ERRORLEVEL% NEQ 0 (start trilium.exe) ELSE (powershell.exe ./trilium-portable.ps1)
+start trilium.exe
+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
-IF %ERRORLEVEL% NEQ 0 (start trilium.exe --disable-gpu) ELSE (powershell.exe ./trilium-safe-mode.ps1)
+start trilium.exe --disable-gpu
+GOTO END
+
+:END

bin/tpl/trilium-safe-mode.ps1

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

config-sample.ini

@@ -16,7 +16,7 @@ noBackup=false
 # host=0.0.0.0
 # port setting is relevant only for web deployments, desktop builds run on a fixed port (changeable with TRILIUM_PORT environment variable)
 port=8080
-# true for TLS/SSL/HTTPS (secure), false for HTTP (unsecure).
+# true for TLS/SSL/HTTPS (secure), false for HTTP (insecure).
 https=false
 # path to certificate (run "bash bin/generate-cert.sh" to generate self-signed certificate). Relevant only if https=true
 certPath=

db/TODO.txt

@@ -1,11 +1,5 @@
-- 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/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 eraseService = require("../../src/services/erase");
+
+    await cls.init(async () => {
+        // precaution for the 0211 migration
+        eraseService.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().slice()) {
+                    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}`);
+            }
+        }
+    });
+};

db/migrations/0214__fix_root_children_ordering.sql

@@ -0,0 +1 @@
+UPDATE branches SET notePosition = notePosition - 999899999 WHERE parentNoteId = 'root' AND notePosition > 999999999;

db/migrations/0215__content_structure.sql

@@ -0,0 +1,10 @@
+CREATE TABLE IF NOT EXISTS "blobs" (
+                                               `blobId`	TEXT NOT NULL,
+                                               `content`	TEXT NULL DEFAULT NULL,
+                                               `dateModified` TEXT NOT NULL,
+                                               `utcDateModified` TEXT NOT NULL,
+                                               PRIMARY KEY(`blobId`)
+);
+
+ALTER TABLE notes ADD blobId TEXT DEFAULT NULL;
+ALTER TABLE note_revisions ADD blobId TEXT DEFAULT NULL;

db/migrations/0216__move_content_into_blobs.js

@@ -0,0 +1,62 @@
+module.exports = () => {
+    const sql = require("../../src/services/sql");
+    const utils = require("../../src/services/utils");
+
+    const existingBlobIds = new Set();
+
+    for (const noteId of sql.getColumn(`SELECT noteId FROM note_contents`)) {
+        const row = sql.getRow(`SELECT noteId, content, dateModified, utcDateModified FROM note_contents WHERE noteId = ?`, [noteId]);
+        const blobId = utils.hashedBlobId(row.content);
+
+        if (!existingBlobIds.has(blobId)) {
+            existingBlobIds.add(blobId);
+
+            sql.insert('blobs', {
+                blobId,
+                content: row.content,
+                dateModified: row.dateModified,
+                utcDateModified: row.utcDateModified
+            });
+
+            sql.execute("UPDATE entity_changes SET entityName = 'blobs', entityId = ? WHERE entityName = 'note_contents' AND entityId = ?", [blobId, row.noteId]);
+        } else {
+            // duplicates
+            sql.execute("DELETE FROM entity_changes WHERE entityName = 'note_contents' AND entityId = ?", [row.noteId]);
+        }
+
+        sql.execute('UPDATE notes SET blobId = ? WHERE noteId = ?', [blobId, row.noteId]);
+    }
+
+    for (const noteRevisionId of sql.getColumn(`SELECT noteRevisionId FROM note_revision_contents`)) {
+        const row = sql.getRow(`SELECT noteRevisionId, content, utcDateModified FROM note_revision_contents WHERE noteRevisionId = ?`, [noteRevisionId]);
+        const blobId = utils.hashedBlobId(row.content);
+
+        if (!existingBlobIds.has(blobId)) {
+            existingBlobIds.add(blobId);
+
+            sql.insert('blobs', {
+                blobId,
+                content: row.content,
+                dateModified: row.utcDateModified,
+                utcDateModified: row.utcDateModified
+            });
+
+            sql.execute("UPDATE entity_changes SET entityName = 'blobs', entityId = ? WHERE entityName = 'note_revision_contents' AND entityId = ?", [blobId, row.noteRevisionId]);
+        } else {
+            // duplicates
+            sql.execute("DELETE FROM entity_changes WHERE entityName = 'note_revision_contents' AND entityId = ?", [row.noteId]);
+        }
+
+        sql.execute('UPDATE note_revisions SET blobId = ? WHERE noteRevisionId = ?', [blobId, row.noteRevisionId]);
+    }
+
+    const notesWithoutBlobIds = sql.getColumn("SELECT noteId FROM notes WHERE blobId IS NULL");
+    if (notesWithoutBlobIds.length > 0) {
+        throw new Error("BlobIds were not filled correctly in notes: " + JSON.stringify(notesWithoutBlobIds));
+    }
+
+    const noteRevisionsWithoutBlobIds = sql.getColumn("SELECT noteRevisionId FROM note_revisions WHERE blobId IS NULL");
+    if (noteRevisionsWithoutBlobIds.length > 0) {
+        throw new Error("BlobIds were not filled correctly in note revisions: " + JSON.stringify(noteRevisionsWithoutBlobIds));
+    }
+};

db/migrations/0217__drop_content_tables.sql

@@ -0,0 +1,4 @@
+DROP TABLE note_contents;
+DROP TABLE note_revision_contents;
+
+DELETE FROM entity_changes WHERE entityName IN ('note_contents', 'note_revision_contents');

db/migrations/0218__rename_note_revision_to_revision.sql

@@ -0,0 +1,25 @@
+CREATE TABLE IF NOT EXISTS "revisions" (`revisionId`	TEXT NOT NULL PRIMARY KEY,
+                                        `noteId`	TEXT NOT NULL,
+                                        type TEXT DEFAULT '' NOT NULL,
+                                        mime TEXT DEFAULT '' NOT NULL,
+                                        `title`	TEXT NOT NULL,
+                                        `isProtected`	INT NOT NULL DEFAULT 0,
+                                        blobId TEXT DEFAULT NULL,
+                                        `utcDateLastEdited` TEXT NOT NULL,
+                                        `utcDateCreated` TEXT NOT NULL,
+                                        `utcDateModified` TEXT NOT NULL,
+                                        `dateLastEdited` TEXT NOT NULL,
+                                        `dateCreated` TEXT NOT NULL);
+
+INSERT INTO revisions (revisionId, noteId, type, mime, title, isProtected, utcDateLastEdited, utcDateCreated, utcDateModified, dateLastEdited, dateCreated, blobId)
+SELECT noteRevisionId, noteId, type, mime, title, isProtected, utcDateLastEdited, utcDateCreated, utcDateModified, dateLastEdited, dateCreated, blobId FROM note_revisions;
+
+DROP TABLE note_revisions;
+
+CREATE INDEX `IDX_revisions_noteId` ON `revisions` (`noteId`);
+CREATE INDEX `IDX_revisions_utcDateCreated` ON `revisions` (`utcDateCreated`);
+CREATE INDEX `IDX_revisions_utcDateLastEdited` ON `revisions` (`utcDateLastEdited`);
+CREATE INDEX `IDX_revisions_dateCreated` ON `revisions` (`dateCreated`);
+CREATE INDEX `IDX_revisions_dateLastEdited` ON `revisions` (`dateLastEdited`);
+
+UPDATE entity_changes SET entityName = 'revisions' WHERE entityName = 'note_revisions';

db/migrations/0219__attachments.sql

@@ -0,0 +1,21 @@
+CREATE TABLE IF NOT EXISTS "attachments"
+(
+    attachmentId      TEXT not null primary key,
+    ownerId       TEXT not null,
+    role         TEXT not null,
+    mime         TEXT not null,
+    title         TEXT not null,
+    isProtected    INT  not null DEFAULT 0,
+    position     INT  default 0 not null,
+    blobId    TEXT DEFAULT null,
+    dateModified TEXT NOT NULL,
+    utcDateModified TEXT not null,
+    utcDateScheduledForErasureSince TEXT DEFAULT NULL,
+    isDeleted    INT  not null,
+    deleteId    TEXT DEFAULT NULL);
+
+CREATE INDEX IDX_attachments_ownerId_role
+    on attachments (ownerId, role);
+
+CREATE INDEX IDX_attachments_utcDateScheduledForErasureSince
+    on attachments (utcDateScheduledForErasureSince);

db/migrations/0220__migrate_images_to_attachments.js

@@ -0,0 +1,23 @@
+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 {
+                const attachment = note.convertToParentAttachment({autoConversion: true});
+
+                if (attachment) {
+                    log.info(`Auto-converted note '${note.noteId}' into attachment '${attachment.attachmentId}'.`);
+                }
+            }
+            catch (e) {
+                log.error(`Cannot convert note '${note.noteId}' to attachment: ${e.message} ${e.stack}`);
+            }
+        }
+    });
+};

db/migrations/0221__remove_hideIncludedImages_main_option.sql

@@ -0,0 +1,2 @@
+DELETE FROM options WHERE name = 'hideIncludedImages_main';
+DELETE FROM entity_changes WHERE entityName = 'options' AND entityId = 'hideIncludedImages_main';

db/migrations/0222__rename_openTabs_to_openNoteContexts.sql

@@ -0,0 +1,2 @@
+UPDATE options SET name = 'openNoteContexts' WHERE name = 'openTabs';
+UPDATE entity_changes SET entityId = 'openNoteContexts' WHERE entityName = 'options' AND entityId = 'openTabs';

db/migrations/0223__NOOP.sql

@@ -0,0 +1 @@
+SELECT 1;

db/migrations/0224__fix_blobIds.sql

@@ -0,0 +1,14 @@
+UPDATE blobs SET blobId = REPLACE(blobId, '+', 'X');
+UPDATE blobs SET blobId = REPLACE(blobId, '/', 'Y');
+
+UPDATE notes SET blobId = REPLACE(blobId, '+', 'X');
+UPDATE notes SET blobId = REPLACE(blobId, '/', 'Y');
+
+UPDATE attachments SET blobId = REPLACE(blobId, '+', 'X');
+UPDATE attachments SET blobId = REPLACE(blobId, '/', 'Y');
+
+UPDATE revisions SET blobId = REPLACE(blobId, '+', 'X');
+UPDATE revisions SET blobId = REPLACE(blobId, '/', 'Y');
+
+UPDATE entity_changes SET entityId = REPLACE(entityId, '+', 'X') WHERE entityName = 'blobs';
+UPDATE entity_changes SET entityId = REPLACE(entityId, '/', 'Y') WHERE entityName = 'blobs';

db/migrations/0225__create_blobId_indices.sql

@@ -0,0 +1,3 @@
+CREATE INDEX IF NOT EXISTS IDX_notes_blobId on notes (blobId);
+CREATE INDEX IF NOT EXISTS IDX_revisions_blobId on revisions (blobId);
+CREATE INDEX IF NOT EXISTS IDX_attachments_blobId on attachments (blobId);

db/schema.sql

@@ -35,6 +35,7 @@ CREATE TABLE IF NOT EXISTS "notes" (
                                        `isProtected`	INT NOT NULL DEFAULT 0,
                                        `type` TEXT NOT NULL DEFAULT 'text',
                                        `mime` TEXT NOT NULL DEFAULT 'text/html',
+                                       blobId TEXT DEFAULT NULL,
                                        `isDeleted`	INT NOT NULL DEFAULT 0,
                                        `deleteId`   TEXT DEFAULT NULL,
                                        `dateCreated`	TEXT NOT NULL,
@@ -42,27 +43,18 @@ CREATE TABLE IF NOT EXISTS "notes" (
                                        `utcDateCreated`	TEXT NOT NULL,
                                        `utcDateModified`	TEXT NOT NULL,
                                        PRIMARY KEY(`noteId`));
-CREATE TABLE IF NOT EXISTS "note_contents" (
-                                               `noteId`	TEXT NOT NULL,
-                                               `content`	TEXT NULL DEFAULT NULL,
-                                               `dateModified` TEXT NOT NULL,
-                                               `utcDateModified` TEXT NOT NULL,
-                                               PRIMARY KEY(`noteId`)
-);
-CREATE TABLE IF NOT EXISTS "note_revisions" (`noteRevisionId`	TEXT NOT NULL PRIMARY KEY,
+CREATE TABLE IF NOT EXISTS "revisions" (`revisionId`	TEXT NOT NULL PRIMARY KEY,
                                              `noteId`	TEXT NOT NULL,
                                              type TEXT DEFAULT '' NOT NULL,
                                              mime TEXT DEFAULT '' NOT NULL,
                                              `title`	TEXT NOT NULL,
                                              `isProtected`	INT NOT NULL DEFAULT 0,
+                                            blobId TEXT DEFAULT NULL,
                                              `utcDateLastEdited` TEXT NOT NULL,
                                              `utcDateCreated` TEXT NOT NULL,
                                              `utcDateModified` TEXT NOT NULL,
                                              `dateLastEdited` TEXT NOT NULL,
                                              `dateCreated` TEXT NOT NULL);
-CREATE TABLE IF NOT EXISTS "note_revision_contents" (`noteRevisionId`	TEXT NOT NULL PRIMARY KEY,
-                                                     `content`	TEXT,
-                                                     `utcDateModified` TEXT NOT NULL);
 CREATE TABLE IF NOT EXISTS "options"
 (
     name TEXT not null PRIMARY KEY,
@@ -94,11 +86,11 @@ CREATE INDEX `IDX_notes_dateCreated` ON `notes` (`dateCreated`);
 CREATE INDEX `IDX_notes_dateModified` ON `notes` (`dateModified`);
 CREATE INDEX `IDX_notes_utcDateModified` ON `notes` (`utcDateModified`);
 CREATE INDEX `IDX_notes_utcDateCreated` ON `notes` (`utcDateCreated`);
-CREATE INDEX `IDX_note_revisions_noteId` ON `note_revisions` (`noteId`);
-CREATE INDEX `IDX_note_revisions_utcDateCreated` ON `note_revisions` (`utcDateCreated`);
-CREATE INDEX `IDX_note_revisions_utcDateLastEdited` ON `note_revisions` (`utcDateLastEdited`);
-CREATE INDEX `IDX_note_revisions_dateCreated` ON `note_revisions` (`dateCreated`);
-CREATE INDEX `IDX_note_revisions_dateLastEdited` ON `note_revisions` (`dateLastEdited`);
+CREATE INDEX `IDX_revisions_noteId` ON `revisions` (`noteId`);
+CREATE INDEX `IDX_revisions_utcDateCreated` ON `revisions` (`utcDateCreated`);
+CREATE INDEX `IDX_revisions_utcDateLastEdited` ON `revisions` (`utcDateLastEdited`);
+CREATE INDEX `IDX_revisions_dateCreated` ON `revisions` (`dateCreated`);
+CREATE INDEX `IDX_revisions_dateLastEdited` ON `revisions` (`dateLastEdited`);
 CREATE INDEX `IDX_entity_changes_changeId` ON `entity_changes` (`changeId`);
 CREATE INDEX IDX_attributes_name_value
     on attributes (name, value);
@@ -112,3 +104,31 @@ CREATE TABLE IF NOT EXISTS "recent_notes"
     notePath TEXT not null,
     utcDateCreated TEXT not null
 );
+CREATE TABLE IF NOT EXISTS "blobs" (
+                                               `blobId`	TEXT NOT NULL,
+                                               `content`	TEXT NULL DEFAULT NULL,
+                                               `dateModified` TEXT NOT NULL,
+                                               `utcDateModified` TEXT NOT NULL,
+                                               PRIMARY KEY(`blobId`)
+);
+CREATE TABLE IF NOT EXISTS "attachments"
+(
+    attachmentId      TEXT not null primary key,
+    ownerId       TEXT not null,
+    role         TEXT not null,
+    mime         TEXT not null,
+    title         TEXT not null,
+    isProtected    INT  not null DEFAULT 0,
+    position     INT  default 0 not null,
+    blobId    TEXT DEFAULT null,
+    dateModified TEXT NOT NULL,
+    utcDateModified TEXT not null,
+    utcDateScheduledForErasureSince TEXT DEFAULT NULL,
+    isDeleted    INT  not null,
+    deleteId    TEXT DEFAULT NULL);
+CREATE INDEX IDX_attachments_ownerId_role
+    on attachments (ownerId, role);
+
+CREATE INDEX IDX_notes_blobId on notes (blobId);
+CREATE INDEX IDX_revisions_blobId on revisions (blobId);
+CREATE INDEX IDX_attachments_blobId on attachments (blobId);

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,42 @@
+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.Network.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);
+}
+
+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/AbstractBeccaEntity.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Class: AbstractEntity</title>
+    <title>JSDoc: Class: AbstractBeccaEntity</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: AbstractEntity</h1>
+    <h1 class="page-title">Class: AbstractBeccaEntity</h1>
 
     
 
@@ -28,7 +28,7 @@
 
 <header>
     
-        <h2><span class="attribs"><span class="type-signature"></span></span>AbstractEntity<span class="signature">()</span><span class="type-signature"></span></h2>
+        <h2><span class="attribs"><span class="type-signature"></span></span>AbstractBeccaEntity<span class="signature">()</span><span class="type-signature"></span></h2>
         
             <div class="class-description">Base class for all backend entities.</div>
         
@@ -45,7 +45,7 @@
     
 
     
-    <h4 class="name" id="AbstractEntity"><span class="type-signature"></span>new AbstractEntity<span class="signature">()</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="AbstractBeccaEntity"><span class="type-signature"></span>new AbstractBeccaEntity<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="becca_entities_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line16">line 16</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>
     
 
@@ -183,7 +183,7 @@
     
     <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#line50">line 50</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#line55">line 55</a>
     </li></ul></dd>
     
 
@@ -205,6 +205,195 @@
     
         <h3 class="subsection-title">Methods</h3>
 
+        
+            
+
+    
+
+    
+    <h4 class="name" id="_getContent"><span class="type-signature">(protected) </span>_getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <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#line244">line 244</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">string</span>
+|
+
+<span class="param-type">Buffer</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<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_becca_entity.js.html">becca/entities/abstract_becca_entity.js</a>, <a href="becca_entities_abstract_becca_entity.js.html#line124">line 124</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
         
             
 
@@ -259,7 +448,7 @@
     
     <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#line59">line 59</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#line64">line 64</a>
     </li></ul></dd>
     
 
@@ -343,7 +532,7 @@
     
     <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#line18">line 18</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#line20">line 20</a>
     </li></ul></dd>
     
 
@@ -427,7 +616,7 @@
     
     <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#line30">line 30</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#line32">line 32</a>
     </li></ul></dd>
     
 
@@ -511,7 +700,7 @@
     
     <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#line23">line 23</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#line25">line 25</a>
     </li></ul></dd>
     
 
@@ -595,7 +784,7 @@
     
     <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#line71">line 71</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#line76">line 76</a>
     </li></ul></dd>
     
 
@@ -679,7 +868,7 @@
     
     <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#line45">line 45</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#line47">line 47</a>
     </li></ul></dd>
     
 
@@ -725,7 +914,7 @@
 <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.
+This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 </div>
 
 
@@ -833,7 +1022,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#line125">line 125</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#line261">line 261</a>
     </li></ul></dd>
     
 
@@ -869,7 +1058,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>
     
 
     
@@ -921,7 +1110,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#line80">line 80</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#line85">line 85</a>
     </li></ul></dd>
     
 
@@ -957,7 +1146,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>
@@ -985,13 +1174,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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/BAttribute.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Class: Attribute</title>
+    <title>JSDoc: Class: BAttribute</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: BAttribute</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>BAttribute<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="BAttribute"><span class="type-signature"></span>new BAttribute<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="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_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line16">line 16</a>
     </li></ul></dd>
     
 
@@ -134,7 +134,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>
 
 
@@ -205,7 +205,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_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line47">line 47</a>
     </li></ul></dd>
     
 
@@ -245,7 +245,7 @@ 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="AbstractEntity.html#becca">AbstractEntity#becca</a>
+        <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
     </li></ul></dd>
     
 
@@ -268,7 +268,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_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line50">line 50</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#line55">line 55</a>
     </li></ul></dd>
     
 
@@ -336,7 +336,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_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line59">line 59</a>
     </li></ul></dd>
     
 
@@ -404,7 +404,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_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line53">line 53</a>
     </li></ul></dd>
     
 
@@ -472,7 +472,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#line48">line 48</a>
+        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line49">line 49</a>
     </li></ul></dd>
     
 
@@ -540,7 +540,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#line54">line 54</a>
+        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line55">line 55</a>
     </li></ul></dd>
     
 
@@ -608,7 +608,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#line50">line 50</a>
+        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line51">line 51</a>
     </li></ul></dd>
     
 
@@ -676,7 +676,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_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line61">line 61</a>
     </li></ul></dd>
     
 
@@ -744,7 +744,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_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line57">line 57</a>
     </li></ul></dd>
     
 
@@ -766,6 +766,205 @@ and relation (representing named relationship between source and target note)</d
     
         <h3 class="subsection-title">Methods</h3>
 
+        
+            
+
+    
+
+    
+    <h4 class="name" id="_getContent"><span class="type-signature">(protected) </span>_getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#_getContent">AbstractBeccaEntity#_getContent</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#line244">line 244</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">string</span>
+|
+
+<span class="param-type">Buffer</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<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#_setContent">AbstractBeccaEntity#_setContent</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#line124">line 124</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
         
             
 
@@ -802,7 +1001,7 @@ 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="AbstractEntity.html#addEntityChange">AbstractEntity#addEntityChange</a>
+        <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
     </li></ul></dd>
     
 
@@ -825,7 +1024,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_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line59">line 59</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#line64">line 64</a>
     </li></ul></dd>
     
 
@@ -891,7 +1090,7 @@ 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="AbstractEntity.html#beforeSaving">AbstractEntity#beforeSaving</a>
+        <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
     </li></ul></dd>
     
 
@@ -914,7 +1113,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_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line18">line 18</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#line20">line 20</a>
     </li></ul></dd>
     
 
@@ -980,7 +1179,7 @@ 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="AbstractEntity.html#generateHash">AbstractEntity#generateHash</a>
+        <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
     </li></ul></dd>
     
 
@@ -1003,7 +1202,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_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line30">line 30</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#line32">line 32</a>
     </li></ul></dd>
     
 
@@ -1069,7 +1268,7 @@ 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="AbstractEntity.html#generateIdIfNecessary">AbstractEntity#generateIdIfNecessary</a>
+        <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
     </li></ul></dd>
     
 
@@ -1092,7 +1291,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_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line23">line 23</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#line25">line 25</a>
     </li></ul></dd>
     
 
@@ -1128,7 +1327,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="getNote"><span class="type-signature"></span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
     
 
     
@@ -1176,7 +1375,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#line115">line 115</a>
+        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line129">line 129</a>
     </li></ul></dd>
     
 
@@ -1212,7 +1411,7 @@ and relation (representing named relationship between source and target note)</d
     </dt>
     <dd>
         
-<span class="param-type"><a href="Note.html">Note</a></span>
+<span class="param-type"><a href="BNote.html">BNote</a></span>
 |
 
 <span class="param-type">null</span>
@@ -1263,7 +1462,7 @@ 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="AbstractEntity.html#getPojoToSave">AbstractEntity#getPojoToSave</a>
+        <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
     </li></ul></dd>
     
 
@@ -1286,7 +1485,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_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line71">line 71</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#line76">line 76</a>
     </li></ul></dd>
     
 
@@ -1322,7 +1521,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="getTargetNote"><span class="type-signature"></span>getTargetNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>|null}</span></h4>
     
 
     
@@ -1370,7 +1569,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#line122">line 122</a>
+        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line142">line 142</a>
     </li></ul></dd>
     
 
@@ -1406,7 +1605,7 @@ and relation (representing named relationship between source and target note)</d
     </dt>
     <dd>
         
-<span class="param-type"><a href="Note.html">Note</a></span>
+<span class="param-type"><a href="BNote.html">BNote</a></span>
 |
 
 <span class="param-type">null</span>
@@ -1457,7 +1656,7 @@ 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="AbstractEntity.html#getUtcDateChanged">AbstractEntity#getUtcDateChanged</a>
+        <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
     </li></ul></dd>
     
 
@@ -1480,7 +1679,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_abstract_entity.js.html">becca/entities/abstract_entity.js</a>, <a href="becca_entities_abstract_entity.js.html#line45">line 45</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#line47">line 47</a>
     </li></ul></dd>
     
 
@@ -1564,7 +1763,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#line137">line 137</a>
+        <a href="becca_entities_battribute.js.html">becca/entities/battribute.js</a>, <a href="becca_entities_battribute.js.html#line157">line 157</a>
     </li></ul></dd>
     
 
@@ -1628,7 +1827,7 @@ and relation (representing named relationship between source and target note)</d
 <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.
+This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 </div>
 
 
@@ -1718,7 +1917,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>
     
 
@@ -1741,7 +1940,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#line125">line 125</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#line261">line 261</a>
     </li></ul></dd>
     
 
@@ -1777,7 +1976,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>
     
 
     
@@ -1811,7 +2010,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>
     
 
@@ -1834,7 +2033,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#line80">line 80</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#line85">line 85</a>
     </li></ul></dd>
     
 
@@ -1870,7 +2069,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>
@@ -1898,13 +2097,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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/BBranch.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Class: Branch</title>
+    <title>JSDoc: Class: BBranch</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: BBranch</h1>
 
     
 
@@ -28,10 +28,13 @@
 
 <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>BBranch<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>
+parents.
+
+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.</div>
         
     
 </header>
@@ -46,7 +49,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="BBranch"><span class="type-signature"></span>new BBranch<span class="signature">()</span><span class="type-signature"></span></h4>
     
 
     
@@ -94,7 +97,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line18">line 18</a>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line20">line 20</a>
     </li></ul></dd>
     
 
@@ -134,7 +137,7 @@ parents.</div>
 
 
     <ul>
-        <li><a href="AbstractEntity.html">AbstractEntity</a></li>
+        <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
     </ul>
 
 
@@ -177,7 +180,7 @@ parents.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#becca">AbstractEntity#becca</a>
+        <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
     </li></ul></dd>
     
 
@@ -200,7 +203,7 @@ parents.</div>
     
     <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#line50">line 50</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#line55">line 55</a>
     </li></ul></dd>
     
 
@@ -268,7 +271,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line49">line 49</a>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line51">line 51</a>
     </li></ul></dd>
     
 
@@ -326,7 +329,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line94">line 94</a>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line97">line 97</a>
     </li></ul></dd>
     
 
@@ -394,7 +397,73 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line59">line 59</a>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line61">line 61</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="isWeak"><span class="type-signature"></span>isWeak<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    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.
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line134">line 134</a>
     </li></ul></dd>
     
 
@@ -462,7 +531,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line51">line 51</a>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line53">line 53</a>
     </li></ul></dd>
     
 
@@ -530,7 +599,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line57">line 57</a>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line59">line 59</a>
     </li></ul></dd>
     
 
@@ -588,7 +657,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line108">line 108</a>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line112">line 112</a>
     </li></ul></dd>
     
 
@@ -656,7 +725,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line53">line 53</a>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line55">line 55</a>
     </li></ul></dd>
     
 
@@ -674,7 +743,7 @@ parents.</div>
 
         
             
-<h4 class="name" id="prefix"><span class="type-signature"></span>prefix<span class="type-signature"> :string</span></h4>
+<h4 class="name" id="prefix"><span class="type-signature"></span>prefix<span class="type-signature"> :string|null</span></h4>
 
 
 
@@ -686,6 +755,9 @@ parents.</div>
         <li>
             
 <span class="param-type">string</span>
+|
+
+<span class="param-type">null</span>
 
 
         </li>
@@ -724,7 +796,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line55">line 55</a>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line57">line 57</a>
     </li></ul></dd>
     
 
@@ -792,7 +864,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line61">line 61</a>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line63">line 63</a>
     </li></ul></dd>
     
 
@@ -814,6 +886,205 @@ parents.</div>
     
         <h3 class="subsection-title">Methods</h3>
 
+        
+            
+
+    
+
+    
+    <h4 class="name" id="_getContent"><span class="type-signature">(protected) </span>_getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#_getContent">AbstractBeccaEntity#_getContent</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#line244">line 244</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">string</span>
+|
+
+<span class="param-type">Buffer</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<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#_setContent">AbstractBeccaEntity#_setContent</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#line124">line 124</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
         
             
 
@@ -850,7 +1121,7 @@ parents.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#addEntityChange">AbstractEntity#addEntityChange</a>
+        <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
     </li></ul></dd>
     
 
@@ -873,7 +1144,7 @@ parents.</div>
     
     <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#line59">line 59</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#line64">line 64</a>
     </li></ul></dd>
     
 
@@ -939,7 +1210,7 @@ parents.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#beforeSaving">AbstractEntity#beforeSaving</a>
+        <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
     </li></ul></dd>
     
 
@@ -962,7 +1233,7 @@ parents.</div>
     
     <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#line18">line 18</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#line20">line 20</a>
     </li></ul></dd>
     
 
@@ -1144,7 +1415,7 @@ parents.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line129">line 129</a>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line146">line 146</a>
     </li></ul></dd>
     
 
@@ -1232,7 +1503,7 @@ parents.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#generateHash">AbstractEntity#generateHash</a>
+        <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
     </li></ul></dd>
     
 
@@ -1255,7 +1526,7 @@ parents.</div>
     
     <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#line30">line 30</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#line32">line 32</a>
     </li></ul></dd>
     
 
@@ -1321,7 +1592,7 @@ parents.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#generateIdIfNecessary">AbstractEntity#generateIdIfNecessary</a>
+        <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
     </li></ul></dd>
     
 
@@ -1344,7 +1615,7 @@ parents.</div>
     
     <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#line23">line 23</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#line25">line 25</a>
     </li></ul></dd>
     
 
@@ -1374,6 +1645,108 @@ parents.</div>
 
 
 
+        
+            
+
+    
+
+    
+    <h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="BNote.html">BNote</a>}</span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="becca_entities_bbranch.js.html">becca/entities/bbranch.js</a>, <a href="becca_entities_bbranch.js.html#line107">line 107</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type"><a href="BNote.html">BNote</a></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
         
             
 
@@ -1410,7 +1783,7 @@ parents.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#getPojoToSave">AbstractEntity#getPojoToSave</a>
+        <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
     </li></ul></dd>
     
 
@@ -1433,7 +1806,7 @@ parents.</div>
     
     <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#line71">line 71</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#line76">line 76</a>
     </li></ul></dd>
     
 
@@ -1499,7 +1872,7 @@ parents.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#getUtcDateChanged">AbstractEntity#getUtcDateChanged</a>
+        <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
     </li></ul></dd>
     
 
@@ -1522,7 +1895,7 @@ parents.</div>
     
     <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#line45">line 45</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#line47">line 47</a>
     </li></ul></dd>
     
 
@@ -1568,7 +1941,7 @@ parents.</div>
 <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.
+This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 </div>
 
 
@@ -1658,7 +2031,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>
     
 
@@ -1681,7 +2054,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#line125">line 125</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#line261">line 261</a>
     </li></ul></dd>
     
 
@@ -1717,7 +2090,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>
     
 
     
@@ -1751,7 +2124,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>
     
 
@@ -1774,7 +2147,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#line80">line 80</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#line85">line 85</a>
     </li></ul></dd>
     
 
@@ -1810,7 +2183,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>
@@ -1838,13 +2211,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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/BEtapiToken.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Class: Option</title>
+    <title>JSDoc: Class: BEtapiToken</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: Option</h1>
+    <h1 class="page-title">Class: BEtapiToken</h1>
 
     
 
@@ -28,9 +28,15 @@
 
 <header>
     
-        <h2><span class="attribs"><span class="type-signature"></span></span>Option<span class="signature">()</span><span class="type-signature"></span></h2>
+        <h2><span class="attribs"><span class="type-signature"></span></span>BEtapiToken<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>
+            <div class="class-description">EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications.
+Used by:
+- Trilium Sender
+- ETAPI clients
+
+The format user is presented with is "<etapiTokenId>_<tokenHash>". This is also called "authToken" to distinguish it
+from tokenHash and token.</div>
         
     
 </header>
@@ -45,7 +51,7 @@
     
 
     
-    <h4 class="name" id="Option"><span class="type-signature"></span>new Option<span class="signature">()</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="BEtapiToken"><span class="type-signature"></span>new BEtapiToken<span class="signature">()</span><span class="type-signature"></span></h4>
     
 
     
@@ -93,7 +99,7 @@
     
     <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>
+        <a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line17">line 17</a>
     </li></ul></dd>
     
 
@@ -133,7 +139,7 @@
 
 
     <ul>
-        <li><a href="AbstractEntity.html">AbstractEntity</a></li>
+        <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
     </ul>
 
 
@@ -176,7 +182,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#becca">AbstractEntity#becca</a>
+        <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
     </li></ul></dd>
     
 
@@ -199,7 +205,7 @@
     
     <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#line50">line 50</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#line55">line 55</a>
     </li></ul></dd>
     
 
@@ -217,7 +223,75 @@
 
         
             
-<h4 class="name" id="isSynced"><span class="type-signature"></span>isSynced<span class="type-signature"> :boolean</span></h4>
+<h4 class="name" id="etapiTokenId"><span class="type-signature"></span>etapiTokenId<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_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line35">line 35</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="isDeleted"><span class="type-signature"></span>isDeleted<span class="type-signature"> :boolean</span></h4>
 
 
 
@@ -267,7 +341,7 @@
     
     <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>
+        <a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line45">line 45</a>
     </li></ul></dd>
     
 
@@ -335,7 +409,143 @@
     
     <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>
+        <a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line37">line 37</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="tokenHash"><span class="type-signature"></span>tokenHash<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_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line39">line 39</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_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line41">line 41</a>
     </li></ul></dd>
     
 
@@ -403,7 +613,7 @@
     
     <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>
+        <a href="becca_entities_betapi_token.js.html">becca/entities/betapi_token.js</a>, <a href="becca_entities_betapi_token.js.html#line43">line 43</a>
     </li></ul></dd>
     
 
@@ -420,23 +630,31 @@
 
 
         
+    
+
+    
+        <h3 class="subsection-title">Methods</h3>
+
+        
             
-<h4 class="name" id="value"><span class="type-signature"></span>value<span class="type-signature"> :string</span></h4>
+
+    
+
+    
+    <h4 class="name" id="_getContent"><span class="type-signature">(protected) </span>_getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
+    
+
+    
+
+
 
 
 
 
 
 
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
 
 
-        </li>
-    </ul>
 
 
 
@@ -451,6 +669,11 @@
     
 
     
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#_getContent">AbstractBeccaEntity#_getContent</a>
+    </li></ul></dd>
+    
 
     
 
@@ -471,7 +694,7 @@
     
     <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>
+        <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#line244">line 244</a>
     </li></ul></dd>
     
 
@@ -487,11 +710,129 @@
 
 
 
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
         
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">string</span>
+|
+
+<span class="param-type">Buffer</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
     
 
     
-        <h3 class="subsection-title">Methods</h3>
+    <h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<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#_setContent">AbstractBeccaEntity#_setContent</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#line124">line 124</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
         
             
@@ -529,7 +870,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#addEntityChange">AbstractEntity#addEntityChange</a>
+        <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
     </li></ul></dd>
     
 
@@ -552,7 +893,7 @@
     
     <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#line59">line 59</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#line64">line 64</a>
     </li></ul></dd>
     
 
@@ -618,7 +959,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#beforeSaving">AbstractEntity#beforeSaving</a>
+        <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
     </li></ul></dd>
     
 
@@ -641,7 +982,7 @@
     
     <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#line18">line 18</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#line20">line 20</a>
     </li></ul></dd>
     
 
@@ -707,7 +1048,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#generateHash">AbstractEntity#generateHash</a>
+        <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
     </li></ul></dd>
     
 
@@ -730,7 +1071,7 @@
     
     <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#line30">line 30</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#line32">line 32</a>
     </li></ul></dd>
     
 
@@ -796,7 +1137,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#generateIdIfNecessary">AbstractEntity#generateIdIfNecessary</a>
+        <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
     </li></ul></dd>
     
 
@@ -819,7 +1160,7 @@
     
     <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#line23">line 23</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#line25">line 25</a>
     </li></ul></dd>
     
 
@@ -885,7 +1226,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#getPojoToSave">AbstractEntity#getPojoToSave</a>
+        <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
     </li></ul></dd>
     
 
@@ -908,7 +1249,7 @@
     
     <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#line71">line 71</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#line76">line 76</a>
     </li></ul></dd>
     
 
@@ -974,7 +1315,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#getUtcDateChanged">AbstractEntity#getUtcDateChanged</a>
+        <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
     </li></ul></dd>
     
 
@@ -997,7 +1338,7 @@
     
     <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#line45">line 45</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#line47">line 47</a>
     </li></ul></dd>
     
 
@@ -1043,7 +1384,7 @@
 <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.
+This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 </div>
 
 
@@ -1133,7 +1474,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>
     
 
@@ -1156,7 +1497,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#line125">line 125</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#line261">line 261</a>
     </li></ul></dd>
     
 
@@ -1192,7 +1533,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>
     
 
     
@@ -1226,7 +1567,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>
     
 
@@ -1249,7 +1590,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#line80">line 80</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#line85">line 85</a>
     </li></ul></dd>
     
 
@@ -1285,7 +1626,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>
@@ -1313,13 +1654,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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</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: EtapiToken</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: EtapiToken</h1>
+    <h1 class="page-title">Class: BOption</h1>
 
     
 
@@ -28,15 +28,9 @@
 
 <header>
     
-        <h2><span class="attribs"><span class="type-signature"></span></span>EtapiToken<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">EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications.
-Used by:
-- Trilium Sender
-- ETAPI clients
-
-The format user is presented with is "<etapiTokenId>_<tokenHash>". This is also called "authToken" to distinguish it
-from tokenHash and token.</div>
+            <div class="class-description">Option represents a name-value pair, either directly configurable by the user or some system property.</div>
         
     
 </header>
@@ -51,7 +45,7 @@ from tokenHash and token.</div>
     
 
     
-    <h4 class="name" id="EtapiToken"><span class="type-signature"></span>new EtapiToken<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>
     
 
     
@@ -99,7 +93,7 @@ from tokenHash and token.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line17">line 17</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>
     
 
@@ -139,7 +133,7 @@ from tokenHash and token.</div>
 
 
     <ul>
-        <li><a href="AbstractEntity.html">AbstractEntity</a></li>
+        <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
     </ul>
 
 
@@ -182,7 +176,7 @@ from tokenHash and token.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#becca">AbstractEntity#becca</a>
+        <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
     </li></ul></dd>
     
 
@@ -205,7 +199,7 @@ from tokenHash and token.</div>
     
     <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#line50">line 50</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#line55">line 55</a>
     </li></ul></dd>
     
 
@@ -223,75 +217,7 @@ from tokenHash and token.</div>
 
         
             
-<h4 class="name" id="etapiTokenId"><span class="type-signature"></span>etapiTokenId<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_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line35">line 35</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="isDeleted"><span class="type-signature"></span>isDeleted<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>
 
 
 
@@ -341,7 +267,7 @@ from tokenHash and token.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line45">line 45</a>
+        <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line29">line 29</a>
     </li></ul></dd>
     
 
@@ -409,143 +335,7 @@ from tokenHash and token.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line37">line 37</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="tokenHash"><span class="type-signature"></span>tokenHash<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_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line39">line 39</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_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line41">line 41</a>
+        <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line25">line 25</a>
     </li></ul></dd>
     
 
@@ -613,7 +403,75 @@ from tokenHash and token.</div>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_etapi_token.js.html">becca/entities/etapi_token.js</a>, <a href="becca_entities_etapi_token.js.html#line43">line 43</a>
+        <a href="becca_entities_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line31">line 31</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_boption.js.html">becca/entities/boption.js</a>, <a href="becca_entities_boption.js.html#line27">line 27</a>
     </li></ul></dd>
     
 
@@ -635,6 +493,205 @@ from tokenHash and token.</div>
     
         <h3 class="subsection-title">Methods</h3>
 
+        
+            
+
+    
+
+    
+    <h4 class="name" id="_getContent"><span class="type-signature">(protected) </span>_getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#_getContent">AbstractBeccaEntity#_getContent</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#line244">line 244</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">string</span>
+|
+
+<span class="param-type">Buffer</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<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#_setContent">AbstractBeccaEntity#_setContent</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#line124">line 124</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
         
             
 
@@ -671,7 +728,7 @@ from tokenHash and token.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#addEntityChange">AbstractEntity#addEntityChange</a>
+        <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
     </li></ul></dd>
     
 
@@ -694,7 +751,7 @@ from tokenHash and token.</div>
     
     <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#line59">line 59</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#line64">line 64</a>
     </li></ul></dd>
     
 
@@ -760,7 +817,7 @@ from tokenHash and token.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#beforeSaving">AbstractEntity#beforeSaving</a>
+        <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
     </li></ul></dd>
     
 
@@ -783,7 +840,7 @@ from tokenHash and token.</div>
     
     <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#line18">line 18</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#line20">line 20</a>
     </li></ul></dd>
     
 
@@ -849,7 +906,7 @@ from tokenHash and token.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#generateHash">AbstractEntity#generateHash</a>
+        <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
     </li></ul></dd>
     
 
@@ -872,7 +929,7 @@ from tokenHash and token.</div>
     
     <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#line30">line 30</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#line32">line 32</a>
     </li></ul></dd>
     
 
@@ -938,7 +995,7 @@ from tokenHash and token.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#generateIdIfNecessary">AbstractEntity#generateIdIfNecessary</a>
+        <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
     </li></ul></dd>
     
 
@@ -961,7 +1018,7 @@ from tokenHash and token.</div>
     
     <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#line23">line 23</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#line25">line 25</a>
     </li></ul></dd>
     
 
@@ -1027,7 +1084,7 @@ from tokenHash and token.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#getPojoToSave">AbstractEntity#getPojoToSave</a>
+        <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
     </li></ul></dd>
     
 
@@ -1050,7 +1107,7 @@ from tokenHash and token.</div>
     
     <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#line71">line 71</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#line76">line 76</a>
     </li></ul></dd>
     
 
@@ -1116,7 +1173,7 @@ from tokenHash and token.</div>
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#getUtcDateChanged">AbstractEntity#getUtcDateChanged</a>
+        <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
     </li></ul></dd>
     
 
@@ -1139,7 +1196,7 @@ from tokenHash and token.</div>
     
     <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#line45">line 45</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#line47">line 47</a>
     </li></ul></dd>
     
 
@@ -1185,7 +1242,7 @@ from tokenHash and token.</div>
 <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.
+This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 </div>
 
 
@@ -1275,7 +1332,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>
     
 
@@ -1298,7 +1355,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#line125">line 125</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#line261">line 261</a>
     </li></ul></dd>
     
 
@@ -1334,7 +1391,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>
     
 
     
@@ -1368,7 +1425,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>
     
 
@@ -1391,7 +1448,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#line80">line 80</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#line85">line 85</a>
     </li></ul></dd>
     
 
@@ -1427,7 +1484,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>
@@ -1455,13 +1512,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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/BRecentNote.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
     <meta charset="utf-8">
-    <title>JSDoc: Class: RecentNote</title>
+    <title>JSDoc: Class: BRecentNote</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: RecentNote</h1>
+    <h1 class="page-title">Class: BRecentNote</h1>
 
     
 
@@ -28,7 +28,7 @@
 
 <header>
     
-        <h2><span class="attribs"><span class="type-signature"></span></span>RecentNote<span class="signature">()</span><span class="type-signature"></span></h2>
+        <h2><span class="attribs"><span class="type-signature"></span></span>BRecentNote<span class="signature">()</span><span class="type-signature"></span></h2>
         
             <div class="class-description">RecentNote represents recently visited note.</div>
         
@@ -45,7 +45,7 @@
     
 
     
-    <h4 class="name" id="RecentNote"><span class="type-signature"></span>new RecentNote<span class="signature">()</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="BRecentNote"><span class="type-signature"></span>new BRecentNote<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="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line11">line 11</a>
+        <a href="becca_entities_brecent_note.js.html">becca/entities/brecent_note.js</a>, <a href="becca_entities_brecent_note.js.html#line11">line 11</a>
     </li></ul></dd>
     
 
@@ -133,7 +133,7 @@
 
 
     <ul>
-        <li><a href="AbstractEntity.html">AbstractEntity</a></li>
+        <li><a href="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li>
     </ul>
 
 
@@ -176,7 +176,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#becca">AbstractEntity#becca</a>
+        <a href="AbstractBeccaEntity.html#becca">AbstractBeccaEntity#becca</a>
     </li></ul></dd>
     
 
@@ -199,7 +199,7 @@
     
     <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#line50">line 50</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#line55">line 55</a>
     </li></ul></dd>
     
 
@@ -267,7 +267,7 @@
     
     <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>
+        <a href="becca_entities_brecent_note.js.html">becca/entities/brecent_note.js</a>, <a href="becca_entities_brecent_note.js.html#line19">line 19</a>
     </li></ul></dd>
     
 
@@ -335,7 +335,7 @@
     
     <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>
+        <a href="becca_entities_brecent_note.js.html">becca/entities/brecent_note.js</a>, <a href="becca_entities_brecent_note.js.html#line21">line 21</a>
     </li></ul></dd>
     
 
@@ -403,7 +403,7 @@
     
     <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>
+        <a href="becca_entities_brecent_note.js.html">becca/entities/brecent_note.js</a>, <a href="becca_entities_brecent_note.js.html#line23">line 23</a>
     </li></ul></dd>
     
 
@@ -425,6 +425,205 @@
     
         <h3 class="subsection-title">Methods</h3>
 
+        
+            
+
+    
+
+    
+    <h4 class="name" id="_getContent"><span class="type-signature">(protected) </span>_getContent<span class="signature">()</span><span class="type-signature"> &rarr; {string|Buffer}</span></h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-overrides">Overrides:</dt>
+    <dd class="tag-overrides"><ul class="dummy"><li>
+        <a href="AbstractBeccaEntity.html#_getContent">AbstractBeccaEntity#_getContent</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#line244">line 244</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">string</span>
+|
+
+<span class="param-type">Buffer</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="_setContent"><span class="type-signature">(protected) </span>_setContent<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#_setContent">AbstractBeccaEntity#_setContent</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#line124">line 124</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
         
             
 
@@ -461,7 +660,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#addEntityChange">AbstractEntity#addEntityChange</a>
+        <a href="AbstractBeccaEntity.html#addEntityChange">AbstractBeccaEntity#addEntityChange</a>
     </li></ul></dd>
     
 
@@ -484,7 +683,7 @@
     
     <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#line59">line 59</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#line64">line 64</a>
     </li></ul></dd>
     
 
@@ -550,7 +749,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#beforeSaving">AbstractEntity#beforeSaving</a>
+        <a href="AbstractBeccaEntity.html#beforeSaving">AbstractBeccaEntity#beforeSaving</a>
     </li></ul></dd>
     
 
@@ -573,7 +772,7 @@
     
     <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#line18">line 18</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#line20">line 20</a>
     </li></ul></dd>
     
 
@@ -639,7 +838,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#generateHash">AbstractEntity#generateHash</a>
+        <a href="AbstractBeccaEntity.html#generateHash">AbstractBeccaEntity#generateHash</a>
     </li></ul></dd>
     
 
@@ -662,7 +861,7 @@
     
     <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#line30">line 30</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#line32">line 32</a>
     </li></ul></dd>
     
 
@@ -728,7 +927,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#generateIdIfNecessary">AbstractEntity#generateIdIfNecessary</a>
+        <a href="AbstractBeccaEntity.html#generateIdIfNecessary">AbstractBeccaEntity#generateIdIfNecessary</a>
     </li></ul></dd>
     
 
@@ -751,7 +950,7 @@
     
     <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#line23">line 23</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#line25">line 25</a>
     </li></ul></dd>
     
 
@@ -817,7 +1016,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#getPojoToSave">AbstractEntity#getPojoToSave</a>
+        <a href="AbstractBeccaEntity.html#getPojoToSave">AbstractBeccaEntity#getPojoToSave</a>
     </li></ul></dd>
     
 
@@ -840,7 +1039,7 @@
     
     <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#line71">line 71</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#line76">line 76</a>
     </li></ul></dd>
     
 
@@ -906,7 +1105,7 @@
     
     <dt class="tag-overrides">Overrides:</dt>
     <dd class="tag-overrides"><ul class="dummy"><li>
-        <a href="AbstractEntity.html#getUtcDateChanged">AbstractEntity#getUtcDateChanged</a>
+        <a href="AbstractBeccaEntity.html#getUtcDateChanged">AbstractBeccaEntity#getUtcDateChanged</a>
     </li></ul></dd>
     
 
@@ -929,7 +1128,7 @@
     
     <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#line45">line 45</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#line47">line 47</a>
     </li></ul></dd>
     
 
@@ -975,7 +1174,7 @@
 <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.
+This is a low-level method, for notes and branches use `note.deleteNote()` and 'branch.deleteBranch()` instead.
 </div>
 
 
@@ -1065,7 +1264,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>
     
 
@@ -1088,7 +1287,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#line125">line 125</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#line261">line 261</a>
     </li></ul></dd>
     
 
@@ -1124,7 +1323,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>
     
 
     
@@ -1158,7 +1357,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>
     
 
@@ -1181,7 +1380,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#line80">line 80</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#line85">line 85</a>
     </li></ul></dd>
     
 
@@ -1217,7 +1416,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>
@@ -1245,13 +1444,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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/becca_entities_abstract_becca_entity.js.html

@@ -0,0 +1,354 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <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>
+    <!--[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: becca/entities/abstract_becca_entity.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>"use strict";
+
+const utils = require('../../services/utils');
+const sql = require('../../services/sql');
+const entityChangesService = require('../../services/entity_changes');
+const eventService = require("../../services/events");
+const dateUtils = require("../../services/date_utils");
+const cls = require("../../services/cls");
+const log = require("../../services/log");
+const protectedSessionService = require("../../services/protected_session");
+const blobService = require("../../services/blob");
+
+let becca = null;
+
+/**
+ * Base class for all backend entities.
+ */
+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]}`;
+        }
+
+        if (isDeleted) {
+            contentToHash += "|deleted";
+        }
+
+        return utils.hash(contentToHash).substr(0, 10);
+    }
+
+    /** @protected */
+    getUtcDateChanged() {
+        return this.utcDateModified || this.utcDateCreated;
+    }
+
+    /**
+     * @protected
+     * @returns {Becca}
+     */
+    get becca() {
+        if (!becca) {
+            becca = require('../becca');
+        }
+
+        return becca;
+    }
+
+    /** @protected */
+    addEntityChange(isDeleted = false) {
+        entityChangesService.addEntityChange({
+            entityName: this.constructor.entityName,
+            entityId: this[this.constructor.primaryKeyName],
+            hash: this.generateHash(isDeleted),
+            isErased: false,
+            utcDateChanged: this.getUtcDateChanged(),
+            isSynced: this.constructor.entityName !== 'options' || !!this.isSynced
+        });
+    }
+
+    /** @protected */
+    getPojoToSave() {
+        return this.getPojo();
+    }
+
+    /**
+     * Saves entity - executes SQL, but doesn't commit the transaction on its own
+     *
+     * @returns {this}
+     */
+    save(opts = {}) {
+        const entityName = this.constructor.entityName;
+        const primaryKeyName = this.constructor.primaryKeyName;
+
+        const isNewEntity = !this[primaryKeyName];
+
+        if (this.beforeSaving) {
+            this.beforeSaving(opts);
+        }
+
+        const pojo = this.getPojoToSave();
+
+        sql.transactional(() => {
+            sql.upsert(entityName, primaryKeyName, pojo);
+
+            if (entityName === 'recent_notes') {
+                return;
+            }
+
+            this.addEntityChange(false);
+
+            if (!cls.isEntityEventsDisabled()) {
+                const eventPayload = {
+                    entityName,
+                    entity: this
+                };
+
+                if (isNewEntity) {
+                    eventService.emit(eventService.ENTITY_CREATED, eventPayload);
+                }
+
+                eventService.emit(eventService.ENTITY_CHANGED, eventPayload);
+            }
+        });
+
+        return this;
+    }
+
+    /** @protected */
+    _setContent(content, opts = {}) {
+        // client code asks to save entity even if blobId didn't change (something else was changed)
+        opts.forceSave = !!opts.forceSave;
+        opts.forceFrontendReload = !!opts.forceFrontendReload;
+
+        if (content === null || content === undefined) {
+            throw new Error(`Cannot set null content to ${this.constructor.primaryKeyName} '${this[this.constructor.primaryKeyName]}'`);
+        }
+
+        if (this.hasStringContent()) {
+            content = content.toString();
+        } else {
+            content = Buffer.isBuffer(content) ? content : Buffer.from(content);
+        }
+
+        const unencryptedContentForHashCalculation = this.#getUnencryptedContentForHashCalculation(content);
+
+        if (this.isProtected) {
+            if (protectedSessionService.isProtectedSessionAvailable()) {
+                content = protectedSessionService.encrypt(content);
+            } else {
+                throw new Error(`Cannot update content of blob since protected session is not available.`);
+            }
+        }
+
+        sql.transactional(() => {
+            const newBlobId = this.#saveBlob(content, unencryptedContentForHashCalculation, opts);
+            const oldBlobId = this.blobId;
+
+            if (newBlobId !== oldBlobId || opts.forceSave) {
+                this.blobId = newBlobId;
+                this.save();
+
+                if (newBlobId !== oldBlobId) {
+                    this.#deleteBlobIfNotUsed(oldBlobId);
+                }
+            }
+        });
+    }
+
+    #deleteBlobIfNotUsed(oldBlobId) {
+        if (sql.getValue("SELECT 1 FROM notes WHERE blobId = ? LIMIT 1", [oldBlobId])) {
+            return;
+        }
+
+        if (sql.getValue("SELECT 1 FROM attachments WHERE blobId = ? LIMIT 1", [oldBlobId])) {
+            return;
+        }
+
+        if (sql.getValue("SELECT 1 FROM revisions WHERE blobId = ? LIMIT 1", [oldBlobId])) {
+            return;
+        }
+
+        sql.execute("DELETE FROM blobs WHERE blobId = ?", [oldBlobId]);
+        sql.execute("DELETE FROM entity_changes WHERE entityName = 'blobs' AND entityId = ?", [oldBlobId]);
+    }
+
+    #getUnencryptedContentForHashCalculation(unencryptedContent) {
+        if (this.isProtected) {
+            // a "random" prefix makes sure that the calculated hash/blobId is different for a decrypted/encrypted content
+            const encryptedPrefixSuffix = "t$[nvQg7q)&amp;_ENCRYPTED_?M:Bf&amp;j3jr_";
+            return Buffer.isBuffer(unencryptedContent)
+                ? Buffer.concat([Buffer.from(encryptedPrefixSuffix), unencryptedContent])
+                : `${encryptedPrefixSuffix}${unencryptedContent}`;
+        } else {
+            return unencryptedContent;
+        }
+    }
+
+    #saveBlob(content, unencryptedContentForHashCalculation, opts = {}) {
+        /*
+         * We're using the unencrypted blob for the hash calculation, because otherwise the random IV would
+         * cause every content blob to be unique which would balloon the database size (esp. with revisioning).
+         * This has minor security implications (it's easy to infer that given content is shared between different
+         * notes/attachments), but the trade-off comes out clearly positive.
+         */
+        const newBlobId = utils.hashedBlobId(unencryptedContentForHashCalculation);
+        const blobNeedsInsert = !sql.getValue('SELECT 1 FROM blobs WHERE blobId = ?', [newBlobId]);
+
+        if (!blobNeedsInsert) {
+            return newBlobId;
+        }
+
+        const pojo = {
+            blobId: newBlobId,
+            content: content,
+            dateModified: dateUtils.localNowDateTime(),
+            utcDateModified: dateUtils.utcNowDateTime()
+        };
+
+        sql.upsert("blobs", "blobId", pojo);
+
+        // we can't reuse blobId as an entity_changes hash, because this one has to be calculatable without having
+        // access to the decrypted content
+        const hash = blobService.calculateContentHash(pojo);
+
+        entityChangesService.addEntityChange({
+            entityName: 'blobs',
+            entityId: newBlobId,
+            hash: hash,
+            isErased: false,
+            utcDateChanged: pojo.utcDateModified,
+            isSynced: true,
+            // overriding componentId will cause frontend to think the change is coming from a different component
+            // and thus reload
+            componentId: opts.forceFrontendReload ? utils.randomString(10) : null
+        });
+
+        eventService.emit(eventService.ENTITY_CHANGED, {
+            entityName: 'blobs',
+            entity: this
+        });
+
+        return newBlobId;
+    }
+
+    /**
+     * @protected
+     * @returns {string|Buffer}
+     */
+    _getContent() {
+        const row = sql.getRow(`SELECT content FROM blobs WHERE blobId = ?`, [this.blobId]);
+
+        if (!row) {
+            throw new Error(`Cannot find content for ${this.constructor.primaryKeyName} '${this[this.constructor.primaryKeyName]}', blobId '${this.blobId}'`);
+        }
+
+        return blobService.processContent(row.content, this.isProtected, this.hasStringContent());
+    }
+
+    /**
+     * 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.
+     *
+     * @param [deleteId=null]
+     */
+    markAsDeleted(deleteId = null) {
+        const entityId = this[this.constructor.primaryKeyName];
+        const entityName = this.constructor.entityName;
+
+        this.utcDateModified = dateUtils.utcNowDateTime();
+
+        sql.execute(`UPDATE ${entityName} SET isDeleted = 1, deleteId = ?, utcDateModified = ?
+                           WHERE ${this.constructor.primaryKeyName} = ?`,
+            [deleteId, this.utcDateModified, entityId]);
+
+        if (this.dateModified) {
+            this.dateModified = dateUtils.localNowDateTime();
+
+            sql.execute(`UPDATE ${entityName} SET dateModified = ? WHERE ${this.constructor.primaryKeyName} = ?`,
+                [this.dateModified, entityId]);
+        }
+
+        log.info(`Marking ${entityName} ${entityId} as deleted`);
+
+        this.addEntityChange(true);
+
+        eventService.emit(eventService.ENTITY_DELETED, { entityName, entityId, entity: this });
+    }
+
+    markAsDeletedSimple() {
+        const entityId = this[this.constructor.primaryKeyName];
+        const entityName = this.constructor.entityName;
+
+        this.utcDateModified = dateUtils.utcNowDateTime();
+
+        sql.execute(`UPDATE ${entityName} SET isDeleted = 1, utcDateModified = ?
+                           WHERE ${this.constructor.primaryKeyName} = ?`,
+            [this.utcDateModified, entityId]);
+
+        log.info(`Marking ${entityName} ${entityId} as deleted`);
+
+        this.addEntityChange(true);
+
+        eventService.emit(eventService.ENTITY_DELETED, { entityName, entityId, entity: this });
+    }
+}
+
+module.exports = AbstractBeccaEntity;
+</code></pre>
+        </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="AbstractBeccaEntity.html">AbstractBeccaEntity</a></li><li><a href="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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 4.0.2</a>
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

docs/backend_api/becca_entities_abstract_entity.js.html

@@ -1,218 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Source: becca/entities/abstract_entity.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: becca/entities/abstract_entity.js</h1>
-
-    
-
-
-
-    
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>"use strict";
-
-const utils = require('../../services/utils');
-const sql = require('../../services/sql');
-const entityChangesService = require('../../services/entity_changes');
-const eventService = require("../../services/events");
-const dateUtils = require("../../services/date_utils");
-const cls = require("../../services/cls");
-const log = require("../../services/log");
-
-let becca = null;
-
-/**
- * Base class for all backend entities.
- */
-class AbstractEntity {
-    /** @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];
-        }
-
-        if (isDeleted) {
-            contentToHash += "|deleted";
-        }
-
-        return utils.hash(contentToHash).substr(0, 10);
-    }
-
-    /** @protected */
-    getUtcDateChanged() {
-        return this.utcDateModified || this.utcDateCreated;
-    }
-
-    /** @protected */
-    get becca() {
-        if (!becca) {
-            becca = require('../becca');
-        }
-
-        return becca;
-    }
-
-    /** @protected */
-    addEntityChange(isDeleted = false) {
-        entityChangesService.addEntityChange({
-            entityName: this.constructor.entityName,
-            entityId: this[this.constructor.primaryKeyName],
-            hash: this.generateHash(isDeleted),
-            isErased: false,
-            utcDateChanged: this.getUtcDateChanged(),
-            isSynced: this.constructor.entityName !== 'options' || !!this.isSynced
-        });
-    }
-
-    /** @protected */
-    getPojoToSave() {
-        return this.getPojo();
-    }
-
-    /**
-     * Saves entity - executes SQL, but doesn't commit the transaction on its own
-     *
-     * @returns {AbstractEntity}
-     */
-    save() {
-        const entityName = this.constructor.entityName;
-        const primaryKeyName = this.constructor.primaryKeyName;
-
-        const isNewEntity = !this[primaryKeyName];
-
-        if (this.beforeSaving) {
-            this.beforeSaving();
-        }
-
-        const pojo = this.getPojoToSave();
-
-        sql.transactional(() => {
-            sql.upsert(entityName, primaryKeyName, pojo);
-
-            if (entityName === 'recent_notes') {
-                return;
-            }
-
-            this.addEntityChange(false);
-
-            if (!cls.isEntityEventsDisabled()) {
-                const eventPayload = {
-                    entityName,
-                    entity: this
-                };
-
-                if (isNewEntity) {
-                    eventService.emit(eventService.ENTITY_CREATED, eventPayload);
-                }
-
-                eventService.emit(eventService.ENTITY_CHANGED, eventPayload);
-            }
-        });
-
-        return this;
-    }
-
-    /**
-     * 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.
-     *
-     * @param [deleteId=null]
-     */
-    markAsDeleted(deleteId = null) {
-        const entityId = this[this.constructor.primaryKeyName];
-        const entityName = this.constructor.entityName;
-
-        this.utcDateModified = dateUtils.utcNowDateTime();
-
-        sql.execute(`UPDATE ${entityName} SET isDeleted = 1, deleteId = ?, utcDateModified = ?
-                           WHERE ${this.constructor.primaryKeyName} = ?`,
-            [deleteId, this.utcDateModified, entityId]);
-
-        if (this.dateModified) {
-            this.dateModified = dateUtils.localNowDateTime();
-
-            sql.execute(`UPDATE ${entityName} SET dateModified = ? WHERE ${this.constructor.primaryKeyName} = ?`,
-                [this.dateModified, entityId]);
-        }
-
-        log.info(`Marking ${entityName} ${entityId} as deleted`);
-
-        this.addEntityChange(true);
-
-        eventService.emit(eventService.ENTITY_DELETED, { entityName, entityId, entity: this });
-    }
-
-    markAsDeletedSimple() {
-        const entityId = this[this.constructor.primaryKeyName];
-        const entityName = this.constructor.entityName;
-
-        this.utcDateModified = dateUtils.utcNowDateTime();
-
-        sql.execute(`UPDATE ${entityName} SET isDeleted = 1, utcDateModified = ?
-                           WHERE ${this.constructor.primaryKeyName} = ?`,
-            [this.utcDateModified, entityId]);
-
-        log.info(`Marking ${entityName} ${entityId} as deleted`);
-
-        this.addEntityChange(true);
-
-        eventService.emit(eventService.ENTITY_DELETED, { entityName, entityId, entity: this });
-    }
-}
-
-module.exports = AbstractEntity;
-</code></pre>
-        </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_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 AbstractEntity = require("./abstract_entity");
+const BNote = require('./bnote');
+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"]; }
@@ -90,7 +91,6 @@ class Attribute extends AbstractEntity {
         return this;
     }
 
-
     init() {
         if (this.attributeId) {
             this.becca.attributes[this.attributeId] = this;
@@ -98,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);
@@ -114,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 targets 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
@@ -138,18 +152,24 @@ 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') {
-            throw new Error(`Attribute ${this.attributeId} is not relation`);
+            throw new Error(`Attribute '${this.attributeId}' is not a relation.`);
         }
 
         if (!this.value) {
@@ -160,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:'));
@@ -184,19 +204,23 @@ class Attribute extends AbstractEntity {
         return !(this.attributeId in this.becca.attributes);
     }
 
-    beforeSaving() {
-        if (!this.value) {
-            if (this.type === 'relation') {
-                throw new Error(`Cannot save relation ${this.name} since it does not target any note.`);
-            }
+    beforeSaving(opts = {}) {
+        if (!opts.skipValidation) {
+            this.validate();
+        }
 
+        this.name = sanitizeAttributeName(this.name);
+
+        if (!this.value) {
             // null value isn't allowed
             this.value = "";
         }
 
-        if (this.position === undefined) {
-            // TODO: can be calculated from becca
-            this.position = 1 + sql.getValue(`SELECT COALESCE(MAX(position), 0) FROM attributes WHERE noteId = ?`, [this.noteId]);
+        if (this.position === undefined || this.position === null) {
+            const maxExistingPosition = this.getNote().getAttributes()
+                .reduce((maxPosition, attr) => Math.max(maxPosition, attr.position || 0), 0);
+
+            this.position = maxExistingPosition + 10;
         }
 
         if (!this.isInheritable) {
@@ -225,7 +249,7 @@ class Attribute extends AbstractEntity {
     }
 
     createClone(type, name, value, isInheritable) {
-        return new Attribute({
+        return new BAttribute({
             noteId: this.noteId,
             type: type,
             name: name,
@@ -237,7 +261,7 @@ class Attribute extends AbstractEntity {
     }
 }
 
-module.exports = Attribute;
+module.exports = BAttribute;
 </code></pre>
         </article>
     </section>
@@ -248,13 +272,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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</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,11 +28,10 @@
         <article>
             <pre class="prettyprint source linenums"><code>"use strict";
 
-const Note = require('./note');
-const AbstractEntity = require("./abstract_entity");
-const sql = require("../../services/sql");
+const BNote = require('./bnote');
+const AbstractBeccaEntity = require("./abstract_becca_entity");
 const dateUtils = require("../../services/date_utils");
-const utils = require("../../services/utils.js");
+const utils = require("../../services/utils");
 const TaskContext = require("../../services/task_context");
 const cls = require("../../services/cls");
 const log = require("../../services/log");
@@ -41,9 +40,12 @@ 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,45 +100,47 @@ 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];
     }
 
+    /** @returns {BNote} */
     getNote() {
         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 +150,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) {
@@ -177,8 +194,7 @@ class Branch extends AbstractEntity {
             }
         }
 
-        if (this.branchId === 'root'
-            || this.noteId === 'root'
+        if (this.noteId === 'root'
             || this.noteId === cls.getHoistedNoteId()) {
 
             throw new Error("Can't delete root or hoisted branch/note");
@@ -186,18 +202,24 @@ class Branch extends AbstractEntity {
 
         this.markAsDeleted(deleteId);
 
-        const notDeletedBranches = note.getParentBranches();
+        const notDeletedBranches = note.getStrongParentBranches();
 
         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}'`);
 
-            for (const attribute of note.getOwnedAttributes()) {
+            this.becca.notes[note.noteId].isBeingDeleted = true;
+
+            for (const attribute of note.getOwnedAttributes().slice()) {
                 attribute.markAsDeleted(deleteId);
             }
 
@@ -205,6 +227,10 @@ class Branch extends AbstractEntity {
                 relation.markAsDeleted(deleteId);
             }
 
+            for (const attachment of note.getAttachments()) {
+                attachment.markAsDeleted(deleteId);
+            }
+
             note.markAsDeleted(deleteId);
 
             return true;
@@ -215,16 +241,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
-            const maxNotePos = sql.getValue('SELECT MAX(notePosition) FROM branches WHERE parentNoteId = ? AND isDeleted = 0', [this.parentNoteId]);
-            this.notePosition = maxNotePos === null ? 0 : maxNotePos + 10;
+            let maxNotePos = 0;
+
+            for (const childBranch of this.parentNote.getChildBranches()) {
+                if (maxNotePos &lt; childBranch.notePosition
+                    &amp;&amp; childBranch.noteId !== '_hidden' // hidden has a 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();
@@ -246,17 +290,24 @@ class Branch extends AbstractEntity {
     }
 
     createClone(parentNoteId, notePosition) {
-        return new Branch({
-            noteId: this.noteId,
-            parentNoteId: parentNoteId,
-            notePosition: notePosition,
-            prefix: this.prefix,
-            isExpanded: this.isExpanded
-        });
+        const existingBranch = this.becca.getBranchFromChildAndParent(this.noteId, parentNoteId);
+
+        if (existingBranch) {
+            existingBranch.notePosition = notePosition;
+            return existingBranch;
+        } 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>
@@ -267,13 +318,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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</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.
+ * Option represents a 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"]; }
@@ -44,6 +44,11 @@ class Option extends AbstractEntity {
     constructor(row) {
         super();
 
+        this.updateFromRow(row);
+        this.becca.options[this.name] = this;
+    }
+
+    updateFromRow(row) {
         /** @type {string} */
         this.name = row.name;
         /** @type {string} */
@@ -52,8 +57,6 @@ class Option extends AbstractEntity {
         this.isSynced = !!row.isSynced;
         /** @type {string} */
         this.utcDateModified = row.utcDateModified;
-
-        this.becca.options[this.name] = this;
     }
 
     beforeSaving() {
@@ -72,7 +75,7 @@ class Option extends AbstractEntity {
     }
 }
 
-module.exports = Option;
+module.exports = BOption;
 </code></pre>
         </article>
     </section>
@@ -83,13 +86,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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/backend_api/becca_entities_note_revision.js.html

@@ -1,244 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Source: becca/entities/note_revision.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: becca/entities/note_revision.js</h1>
-
-    
-
-
-
-    
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>"use strict";
-
-const protectedSessionService = require('../../services/protected_session');
-const utils = require('../../services/utils');
-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");
-
-/**
- * NoteRevision represents snapshot of note's title and content at some point in the past.
- * It's used for seamless note versioning.
- *
- * @extends AbstractEntity
- */
-class NoteRevision extends AbstractEntity {
-    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, titleDecrypted = false) {
-        super();
-
-        /** @type {string} */
-        this.noteRevisionId = row.noteRevisionId;
-        /** @type {string} */
-        this.noteId = row.noteId;
-        /** @type {string} */
-        this.type = row.type;
-        /** @type {string} */
-        this.mime = row.mime;
-        /** @type {boolean} */
-        this.isProtected = !!row.isProtected;
-        /** @type {string} */
-        this.title = row.title;
-        /** @type {string} */
-        this.dateLastEdited = row.dateLastEdited;
-        /** @type {string} */
-        this.dateCreated = row.dateCreated;
-        /** @type {string} */
-        this.utcDateLastEdited = row.utcDateLastEdited;
-        /** @type {string} */
-        this.utcDateCreated = row.utcDateCreated;
-        /** @type {string} */
-        this.utcDateModified = row.utcDateModified;
-        /** @type {number} */
-        this.contentLength = row.contentLength;
-
-        if (this.isProtected &amp;&amp; !titleDecrypted) {
-            this.title = protectedSessionService.isProtectedSessionAvailable()
-                ? protectedSessionService.decryptString(this.title)
-                : "[protected]";
-        }
-    }
-
-    getNote() {
-        return becca.notes[this.noteId];
-    }
-
-    /** @returns {boolean} true if the note has string content (not binary) */
-    isStringNote() {
-        return utils.isStringNote(this.type, this.mime);
-    }
-
-    /*
-     * Note revision content has quite special handling - it's not a separate entity, but a lazily loaded
-     * 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
-     * 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.
-     */
-
-    /** @returns {*} */
-    getContent(silentNotFoundError = false) {
-        const res = sql.getRow(`SELECT content FROM note_revision_contents WHERE noteRevisionId = ?`, [this.noteRevisionId]);
-
-        if (!res) {
-            if (silentNotFoundError) {
-                return undefined;
-            }
-            else {
-                throw new Error("Cannot find note revision content for noteRevisionId=" + this.noteRevisionId);
-            }
-        }
-
-        let content = res.content;
-
-        if (this.isProtected) {
-            if (protectedSessionService.isProtectedSessionAvailable()) {
-                content = protectedSessionService.decrypt(content);
-            }
-            else {
-                content = "";
-            }
-        }
-
-        if (this.isStringNote()) {
-            return content === null
-                ? ""
-                : content.toString("UTF-8");
-        }
-        else {
-            return content;
-        }
-    }
-
-    setContent(content, ignoreMissingProtectedSession = false) {
-        const pojo = {
-            noteRevisionId: this.noteRevisionId,
-            content: content,
-            utcDateModified: dateUtils.utcNowDateTime()
-        };
-
-        if (this.isProtected) {
-            if (protectedSessionService.isProtectedSessionAvailable()) {
-                pojo.content = protectedSessionService.encrypt(pojo.content);
-            }
-            else if (!ignoreMissingProtectedSession) {
-                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());
-
-        entityChangesService.addEntityChange({
-            entityName: 'note_revision_contents',
-            entityId: this.noteRevisionId,
-            hash: hash,
-            isErased: false,
-            utcDateChanged: this.getUtcDateChanged(),
-            isSynced: true
-        });
-    }
-
-    /** @returns {{contentLength, dateModified, utcDateModified}} */
-    getContentMetadata() {
-        return sql.getRow(`
-            SELECT 
-                LENGTH(content) AS contentLength, 
-                dateModified,
-                utcDateModified 
-            FROM note_revision_contents 
-            WHERE noteRevisionId = ?`, [this.noteRevisionId]);
-    }
-
-    beforeSaving() {
-        super.beforeSaving();
-
-        this.utcDateModified = dateUtils.utcNowDateTime();
-    }
-
-    getPojo() {
-        return {
-            noteRevisionId: this.noteRevisionId,
-            noteId: this.noteId,
-            type: this.type,
-            mime: this.mime,
-            isProtected: this.isProtected,
-            title: this.title,
-            dateLastEdited: this.dateLastEdited,
-            dateCreated: this.dateCreated,
-            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) {
-            if (protectedSessionService.isProtectedSessionAvailable()) {
-                pojo.title = protectedSessionService.encrypt(this.title);
-            }
-            else {
-                // updating protected note outside of protected session means we will keep original ciphertexts
-                delete pojo.title;
-            }
-        }
-
-        return pojo;
-    }
-}
-
-module.exports = NoteRevision;
-</code></pre>
-        </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/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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</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 the 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 the script is currently executing. Don't mix this up with the concept of active note */
     this.currentNote = currentNote;
-    /** @property {Entity} entity whose event triggered this executions */
+    /** @property {AbstractBeccaEntity} entity whose event triggered this execution */
     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,18 +160,18 @@ 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;
 
     /**
-     * If there's no branch between note and parent note, create one. Otherwise, do nothing.
+     * If there's no branch between note and parent note, create one. Otherwise, do nothing. Returns the new or existing branch.
      *
      * @method
      * @param {string} noteId
      * @param {string} parentNoteId
-     * @param {string} prefix - if branch will be created between note and parent note, set this prefix
-     * @returns {void}
+     * @param {string} prefix - if branch is created between note and parent note, set this prefix
+     * @returns {{branch: BBranch|null}}
      */
     this.ensureNoteIsPresentInParent = cloningService.ensureNoteIsPresentInParent;
 
@@ -189,25 +192,19 @@ function BackendScriptApi(currentNote, apiParams) {
      * @param {boolean} present - true if we want the branch to exist, false if we want it gone
      * @param {string} noteId
      * @param {string} parentNoteId
-     * @param {string} prefix - if branch will be created between note and parent note, set this prefix
+     * @param {string} prefix - if branch is created between note and parent note, set this prefix
      * @returns {void}
      */
     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, canvas - 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]
-     * @returns {{note: Note, branch: Branch}} object contains newly created entities note and branch
+     * @property {object} params
+     * @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={}]
-     * @returns {{note: Note, branch: Branch}} object contains newly created entities note and branch
+     * @param {object} [extraOptions={}]
+     * @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;
@@ -286,7 +272,7 @@ function BackendScriptApi(currentNote, apiParams) {
 
         const parentNote = becca.getNote(parentNoteId);
 
-        // code note type can be inherited, otherwise text is default
+        // code note type can be inherited, otherwise "text" is the default
         extraOptions.type = parentNote.type === 'code' ? 'code' : 'text';
         extraOptions.mime = parentNote.type === 'code' ? parentNote.mime : 'text/html';
 
@@ -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}
-     * @deprecated use getDayNote instead
-     */
-    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}
+     * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use the default calendar
+     * @returns {BNote|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"
-     * @returns {Note|null}
+     * @param {object} [options]
+     * @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;
 
@@ -420,7 +440,7 @@ function BackendScriptApi(currentNote, apiParams) {
      * Return randomly generated string of given length. This random string generation is NOT cryptographically secure.
      *
      * @method
-     * @param {number} length of the string
+     * @param {int} length of the string
      * @returns {string} random string
      */
     this.randomString = utils.randomString;
@@ -446,19 +466,101 @@ function BackendScriptApi(currentNote, apiParams) {
 
     /**
      * @method
-     * @deprecated - this is now no-op since all the changes should be gracefully handled per widget
-     */
-    this.refreshTree = () => {};
-
-    /**
-     * @return {{syncVersion, appVersion, buildRevision, dbVersion, dataDirectory, buildDate}|*} - object representing basic info about running Trilium version
+     * @returns {{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(noteId) ||
+            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('iconClass');
+        }
+
+        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.
      *
-     * @type {{becca: Becca}}
+     * @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
@@ -476,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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</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(", ");
 
@@ -239,7 +245,7 @@ function wrap(query, func) {
             // in these cases error should be simply ignored.
             console.log(e.message);
 
-            return null
+            return null;
         }
 
         throw e;
@@ -278,6 +284,9 @@ function transactional(func) {
             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(',')}`);
 
     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="BAttachment.html">BAttachment</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="BOption.html">BOption</a></li><li><a href="BRecentNote.html">BRecentNote</a></li><li><a href="BRevision.html">BRevision</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.2</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,75 @@ 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#line17">line 17</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="froca"><span class="type-signature"></span>froca<span class="type-signature"> :Froca</span></h4>
+
+
+
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Froca</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<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#line10">line 10</a>
     </li></ul></dd>
     
 
@@ -262,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#line28">line 28</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line29">line 29</a>
     </li></ul></dd>
     
 
@@ -330,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#line22">line 22</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line23">line 23</a>
     </li></ul></dd>
     
 
@@ -398,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#line18">line 18</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line19">line 19</a>
     </li></ul></dd>
     
 
@@ -466,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#line26">line 26</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line27">line 27</a>
     </li></ul></dd>
     
 
@@ -534,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#line20">line 20</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line21">line 21</a>
     </li></ul></dd>
     
 
@@ -602,7 +670,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#line25">line 25</a>
     </li></ul></dd>
     
 
@@ -630,7 +698,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 +746,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#line33">line 33</a>
     </li></ul></dd>
     
 
@@ -714,7 +782,7 @@ 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>
@@ -732,7 +800,7 @@ and relation (representing named relationship between source and target note)</d
     
 
     
-    <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="NoteShort.html">NoteShort</a>>}</span></h4>
+    <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>
     
 
     
@@ -780,7 +848,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#line37">line 37</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line38">line 38</a>
     </li></ul></dd>
     
 
@@ -816,7 +884,7 @@ and relation (representing named relationship between source and target note)</d
     </dt>
     <dd>
         
-<span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span>
+<span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
 
 
     </dd>
@@ -844,13 +912,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="module.exports.html">exports</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="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.2</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,75 @@ 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#line18">line 18</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="froca"><span class="type-signature"></span>froca<span class="type-signature"> :Froca</span></h4>
+
+
+
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Froca</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line8">line 8</a>
     </li></ul></dd>
     
 
@@ -266,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#line29">line 29</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line30">line 30</a>
     </li></ul></dd>
     
 
@@ -334,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#line27">line 27</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line28">line 28</a>
     </li></ul></dd>
     
 
@@ -402,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#line19">line 19</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line20">line 20</a>
     </li></ul></dd>
     
 
@@ -470,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#line23">line 23</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line24">line 24</a>
     </li></ul></dd>
     
 
@@ -538,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#line21">line 21</a>
+        <a href="entities_fbranch.js.html">entities/fbranch.js</a>, <a href="entities_fbranch.js.html#line22">line 22</a>
     </li></ul></dd>
     
 
@@ -606,7 +674,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#line26">line 26</a>
     </li></ul></dd>
     
 
@@ -634,7 +702,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 +750,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#line34">line 34</a>
     </li></ul></dd>
     
 
@@ -718,7 +786,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 +804,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 +852,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#line39">line 39</a>
     </li></ul></dd>
     
 
@@ -820,7 +888,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 +906,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 +954,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#line44">line 44</a>
     </li></ul></dd>
     
 
@@ -922,7 +990,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 +1056,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#line49">line 49</a>
     </li></ul></dd>
     
 
@@ -1017,7 +1085,7 @@ parents.</div>
 
         
 <div class="param-desc">
-    true if it's top level, meaning its parent is root note
+    true if it's top level, meaning its parent is the root note
 </div>
 
 
@@ -1056,13 +1124,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="module.exports.html">exports</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="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.2</a>
 </footer>
 
 <script> prettyPrint(); </script>