release 0.61.13

(cherry picked from commit 92e43bc051)

.eslintignore

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

.eslintrc.js

@@ -0,0 +1,210 @@
+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,
+        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

@@ -3,18 +3,11 @@ description: Report a bug
 title: "(Bug report) "
 labels: "Type: Bug"
 body:
-- type: checkboxes
-  attributes:
-    label: Preflight Checklist
-    description: Please ensure you've completed all of the following.
-    options:
-      - label: I have searched the [issue tracker](https://www.github.com/zadam/trilium/issues) for a bug report that matches the one I want to file, without success.
-        required: true
 - type: input
   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
@@ -47,17 +40,13 @@ body:
     required: true
 - type: textarea
   attributes:
-    label: Expected Behavior
-    description: A clear and concise description of what you expected to happen.
+    label: Description
+    description: A clear and concise description of the bug and any additional information.
   validations:
     required: true
 - type: textarea
   attributes:
-    label: Actual Behavior
-    description: A clear description of what actually happens.
+    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: true
-- type: textarea
-  attributes:
-    label: Additional Information
-    description: If your problem needs further explanation, or if the issue you're seeing cannot be reproduced in a gist, please add more information here.
+    required: false

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,15 +1,8 @@
 name: Feature Request
-description: Report a bug
+description: Ask for a new feature to be added
 title: "(Feature request) "
 labels: "Type: Enhancement"
 body:
-- type: checkboxes
-  attributes:
-    label: Preflight Checklist
-    description: Please ensure you've completed all of the following.
-    options:
-      - label: I have searched the [issue tracker](https://www.github.com/zadam/trilium/issues) for a feature request that matches the one I want to file, without success.
-        required: true
 - type: textarea
   attributes:
     label: Describe feature

.gitignore

@@ -9,3 +9,7 @@ config.ini
 cert.key
 cert.crt
 server-package.json
+.idea/httpRequests/
+data/
+tmp/
+.eslintcache

.gitpod.yml

@@ -2,7 +2,7 @@ image:
   file: .gitpod.dockerfile
 
 tasks:
-    - before: nvm install 14.18.1 && nvm use 14.18.1
+    - before: nvm install 18.18.2 && nvm use 18.18.2
       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_16" project-jdk-name="openjdk-16" 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,13 @@
+//https://prettier.io/docs/en/options.html
+module.exports = {
+	semi: true,
+	trailingComma: 'none',
+	singleQuote: true,
+	printWidth: 100,
+	tabWidth: 4,
+	useTabs: false,
+	quoteProps: "as-needed",
+	bracketSpacing: true,
+	arrowParens: "avoid"
+	// 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",
+}

CODE_OF_CONDUCT

@@ -0,0 +1 @@
+Please treat each other with respect and understanding.

Dockerfile

@@ -1,8 +1,12 @@
-FROM node:14.18.1-alpine
+# !!! Don't try to build this Dockerfile directly, run it through bin/build-docker.sh script !!!
+FROM node:18.18.2-alpine
 
 # Create app directory
 WORKDIR /usr/src/app
 
+# Bundle app source
+COPY . .
+
 COPY server-package.json package.json
 
 # Install app dependencies
@@ -17,13 +21,22 @@ 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
 
-# Bundle app source
-COPY . .
+# Some setup tools need to be kept
+RUN apk add --no-cache su-exec shadow
 
-USER node
+# Add application user and setup proper volume permissions
+RUN adduser -s /bin/false node; exit 0
 
+# Start the application
 EXPOSE 8080
-CMD [ "node", "./src/www" ]
+CMD [ "./start-docker.sh" ]
+
+HEALTHCHECK --start-period=10s CMD exec su-exec node node docker_healthcheck.js

README-ZH_CN.md

@@ -1,43 +1,55 @@
-# 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/baddate/trilium/wiki/)
+* [Wiki 的中文翻译版本](https://github.com/baddate/trilium/wiki/)
 
 您还可以阅读[个人知识库模式](https://github.com/zadam/trilium/wiki/Patterns-of-personal-knowledge-base)，以获取有关如何使用 Trilium 的灵感。
 
@@ -47,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
@@ -56,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,13 +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>
 
-## Features
+Ukraine is currently defending itself from Russian aggression, please consider [donating to Ukrainian Army or humanitarian charities](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>
+
+## 🎁 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)
@@ -16,16 +22,22 @@ Trilium Notes is a hierarchical note taking application with focus on building l
 * Seamless [note versioning](https://github.com/zadam/trilium/wiki/Note-revisions)
 * Note [attributes](https://github.com/zadam/trilium/wiki/Attributes) can be used for note organization, querying and advanced [scripting](https://github.com/zadam/trilium/wiki/Scripts)
 * [Synchronization](https://github.com/zadam/trilium/wiki/Synchronization) with self-hosted sync server
+  * there's a [3rd party service for hosting synchronisation server](https://trilium.cc/paid-hosting)
+* [Sharing](https://github.com/zadam/trilium/wiki/Sharing) (publishing) notes to public internet
 * Strong [note encryption](https://github.com/zadam/trilium/wiki/Protected-notes) with per-note granularity
+* Sketching diagrams with built-in Excalidraw (note type "canvas")
 * [Relation maps](https://github.com/zadam/trilium/wiki/Relation-map) and [link maps](https://github.com/zadam/trilium/wiki/Link-map) for visualizing notes and their relations
 * [Scripting](https://github.com/zadam/trilium/wiki/Scripts) - see [Advanced showcases](https://github.com/zadam/trilium/wiki/Advanced-showcases)
+* [REST API](https://github.com/zadam/trilium/wiki/ETAPI) for automation
 * Scales well in both usability and performance upwards of 100 000 notes
 * Touch optimized [mobile frontend](https://github.com/zadam/trilium/wiki/Mobile-frontend) for smartphones and tablets
 * [Night theme](https://github.com/zadam/trilium/wiki/Themes)
 * [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).
 
@@ -33,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
 
@@ -51,13 +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)
 
-## License
+## 🤝 Support
+
+You can support Trilium using GitHub Sponsors, [PayPal](https://paypal.me/za4am) or Bitcoin (bitcoin:bc1qv3svjn40v89mnkre5vyvs2xw6y8phaltl385d2).
+
+## 🔑 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,12 +1,17 @@
 # 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):
 
 ![](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))

TODO

@@ -1,3 +0,0 @@
-- new icon
-- polish becca entities API
-- separate private and public APIs in becca entities

bin/build-debian.sh

@@ -5,18 +5,3 @@ echo "Packaging debian x64 distribution..."
 VERSION=`jq -r ".version" package.json`
 
 ./node_modules/.bin/electron-installer-debian --config bin/deb-options.json --options.version=${VERSION} --arch amd64
-
-
-# hacky stop-gag measure to produce debian compatible XZ compressed debs until this is fixed: https://github.com/electron-userland/electron-installer-debian/issues/272
-cd dist
-ar x trilium_${VERSION}_amd64.deb
-rm trilium_${VERSION}_amd64.deb
-# recompress
-< control.tar.zst zstd -d | xz > control.tar.xz
-< data.tar.zst zstd -d | xz > data.tar.xz
-# create deb archive (I really do not know, what argument "sdsd" is for but something is required for ar to create the archive as desired)
-ar -m -c -a sdsd trilium_${VERSION}_amd64.deb debian-binary control.tar.xz data.tar.xz
-
-rm control* data* debian-binary
-
-echo "Converted to XZ deb"

bin/build-linux-x64.sh

@@ -24,8 +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

@@ -23,6 +23,11 @@ rm -rf $BUILD_DIR
 # Mac build has by default useless directory level
 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..."
 
 VERSION=`jq -r ".version" package.json`

bin/build-server.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 PKG_DIR=dist/trilium-linux-x64-server
-NODE_VERSION=14.18.1
+NODE_VERSION=18.18.2
 
 if [ "$1" != "DONTCOPY" ]
 then
@@ -20,12 +20,19 @@ rm -r $PKG_DIR/node/lib/node_modules/npm
 rm -r $PKG_DIR/node/include/node
 
 rm -r $PKG_DIR/node_modules/electron*
+rm -r $PKG_DIR/webpack*
+rm -r $PKG_DIR/electron.js
 
 cp -r bin/better-sqlite3/linux-server-better_sqlite3.node $PKG_DIR/node_modules/better-sqlite3/build/Release/better_sqlite3.node
 
 printf "#!/bin/sh\n./node/bin/node src/www" > $PKG_DIR/trilium.sh
 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`
 
 cd dist

bin/build-win-x64.sh

@@ -22,12 +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 bin/tpl/trilium-portable.bat $BUILD_DIR/
-cp bin/tpl/trilium-no-cert-check.bat $BUILD_DIR/
-cp bin/tpl/trilium-safe-mode.bat $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 $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 14.18.1 npm run webpack
+n exec 18.18.2 npm run webpack
 
 DIR=$1
 
@@ -27,7 +27,7 @@ cp -r electron.js $DIR/
 cp webpack-* $DIR/
 
 # run in subshell (so we return to original dir)
-(cd $DIR && n exec 14.18.1 npm install --only=prod)
+(cd $DIR && n exec 18.18.2 npm install --only=prod)
 
 # cleanup of useless files in dependencies
 rm -r $DIR/node_modules/image-q/demo
@@ -44,8 +44,7 @@ find $DIR/node_modules -name demo -exec rm -rf {} \;
 
 find $DIR/libraries -name "*.map" -type f -delete
 
-rm -r $DIR/src/public/app
+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/
 
-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
+rm -rf $DIR/src/public/app

bin/create-anonymization-script.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+const anonymizationService = require('../src/services/anonymization');
+const fs = require('fs');
+const path = require('path');
+
+fs.writeFileSync(path.resolve(__dirname, 'tpl', 'anonymize-database.sql'), anonymizationService.getFullAnonymizationScript());

bin/deb-options.json

@@ -1,6 +1,7 @@
 {
   "src": "dist/trilium-linux-x64",
   "dest": "dist/",
+  "compression": "xz",
   "name": "trilium",
   "productName": "Trilium Notes",
   "genericName": "Note taker",

bin/export-schema.sh

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

bin/release-flatpack.sh

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

bin/tpl/anonymize-database.sql

@@ -0,0 +1,47 @@
+UPDATE etapi_tokens SET tokenHash = 'API token hash value';
+UPDATE notes SET title = 'title' WHERE title NOT IN ('root', '_hidden', '_share');
+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', 'workspaceCalendarRoot', 'workspaceTemplate', 'searchHome', 'workspaceInbox',
+       'workspaceSearchHome', 'sqlConsoleHome', 'datePattern', 'pageSize', 'viewType', 'mapRootNoteId',
+       'bookmarkFolder', 'sorted', 'sortDirection', 'sortFoldersFirst', 'sortNatural', 'sortLocale', 'top',
+       'fullContentWidth', 'shareHiddenFromTree', 'shareOmitDefaultCss', 'shareRoot', 'shareDescription',
+       'shareRaw', 'shareDisallowRobotIndexing', 'shareIndex', 'displayRelations', 'hideRelations', 'titleTemplate',
+       'template', 'toc', 'color', 'keepCurrentHoisting', 'executeButton', 'executeDescription', 'newNotesOnTop',
+       'clipperInbox', 'internalLink', 'imageLink', 'relationMapLink', 'includeMapLink', 'runOnNoteCreation',
+       'runOnNoteTitleChange', 'runOnNoteChange', 'runOnNoteContentChange', 'runOnNoteDeletion', 'runOnBranchCreation',
+       'runOnBranchDeletion', 'runOnChildNoteCreation', 'runOnAttributeCreation', 'runOnAttributeChange', 'template',
+       'inherit', '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', 'cssClass', 'iconClass',
+       'keyboardShortcut', 'run', 'runOnInstance', 'runAtHour', 'customRequestHandler', 'customResourceProvider',
+       'widget', 'noteInfoWidgetDisabled', 'linkMapWidgetDisabled', 'revisionsWidgetDisabled',
+       'whatLinksHereWidgetDisabled', 'similarNotesWidgetDisabled', 'workspace', 'workspaceIconClass',
+       'workspaceTabBackgroundColor', 'workspaceCalendarRoot', 'workspaceTemplate', 'searchHome', 'workspaceInbox',
+       'workspaceSearchHome', 'sqlConsoleHome', 'datePattern', 'pageSize', 'viewType', 'mapRootNoteId',
+       'bookmarkFolder', 'sorted', 'sortDirection', 'sortFoldersFirst', 'sortNatural', 'sortLocale', 'top',
+       'fullContentWidth', 'shareHiddenFromTree', 'shareOmitDefaultCss', 'shareRoot', 'shareDescription',
+       'shareRaw', 'shareDisallowRobotIndexing', 'shareIndex', 'displayRelations', 'hideRelations', 'titleTemplate',
+       'template', 'toc', 'color', 'keepCurrentHoisting', 'executeButton', 'executeDescription', 'newNotesOnTop',
+       'clipperInbox', 'internalLink', 'imageLink', 'relationMapLink', 'includeMapLink', 'runOnNoteCreation',
+       'runOnNoteTitleChange', 'runOnNoteChange', 'runOnNoteContentChange', 'runOnNoteDeletion', 'runOnBranchCreation',
+       'runOnBranchDeletion', 'runOnChildNoteCreation', 'runOnAttributeCreation', 'runOnAttributeChange', 'template',
+       'inherit', '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')
+  AND value != '';
+
+VACUUM;

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

@@ -1,4 +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%
 start trilium.exe
+GOTO END
+
+:END

bin/tpl/trilium-portable.bat

@@ -1,4 +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%
 start trilium.exe
+GOTO END
+
+:END

bin/tpl/trilium-safe-mode.bat

@@ -1,4 +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%
-start trilium.exe
+start trilium.exe --disable-gpu
+GOTO END
+
+:END

bin/tpl/trilium-safe-mode.sh

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

config-sample.ini

@@ -16,8 +16,14 @@ 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=
 keyPath=
+# setting to give trust to reverse proxies, a comma-separated list of trusted rev. proxy IPs can be specified (CIDR notation is permitted),
+# alternatively 'true' will make use of the leftmost IP in X-Forwarded-For, ultimately an integer can be used to tell about the number of hops between
+# Trilium (which is hop 0) and the first trusted rev. proxy. 
+# once set, expressjs will use the X-Forwarded-For header set by the rev. proxy to determinate the real IPs of clients.
+# expressjs shortcuts are supported: loopback(127.0.0.1/8, ::1/128), linklocal(169.254.0.0/16, fe80::/10), uniquelocal(10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fc00::/7)
+trustedReverseProxy=false

db/TODO.txt

@@ -1,11 +1,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/0184__add_excludeFromNoteMap_to_journal.js

@@ -1,15 +0,0 @@
-const becca = require('../../src/becca/becca');
-const beccaLoader = require('../../src/becca/becca_loader');
-const cls = require('../../src/services/cls');
-
-module.exports = () => {
-    cls.init(() => {
-        beccaLoader.load();
-
-        for (const note of Object.values(becca.notes)) {
-            if (note.hasLabel('calendarRoot')) {
-                note.addLabel('excludeFromNoteMap', "", true);
-            }
-        }
-    });
-};

db/migrations/0185__migrate_black_theme_to_dark.sql

@@ -1,4 +0,0 @@
--- black theme has been removed, dark is closest replacement
-UPDATE options SET value = 'dark' WHERE name = 'theme' AND value = 'black';
-
-UPDATE options SET value = 'light' WHERE name = 'theme' AND value = 'white';

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,27 @@
+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");
+    const sql = require("../../src/services/sql");
+
+    cls.init(() => {
+        // emergency disabling of image compression since it appears to make problems in migration to 0.61
+        sql.execute(`UPDATE options SET value = 'false' WHERE name = 'compressImages'`);
+
+        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/migrations/0226__rename_noteSize_label.sql

@@ -0,0 +1 @@
+UPDATE attributes SET value = 'contentAndAttachmentsAndRevisionsSize' WHERE name = 'orderBy' AND value = 'noteSize';

db/migrations/0227__disable_image_compression.sql

@@ -0,0 +1,2 @@
+-- emergency disabling of image compression since it appears to make problems in migration to 0.61
+UPDATE options SET value = 'false' WHERE name = 'compressImages';

db/schema.sql

@@ -4,15 +4,19 @@ CREATE TABLE IF NOT EXISTS "entity_changes" (
                                                 `entityId`	TEXT NOT NULL,
                                                 `hash`	TEXT NOT NULL,
                                                 `isErased` INT NOT NULL,
-                                                `sourceId` TEXT NOT NULL,
+                                                `changeId` TEXT NOT NULL,
+                                                `componentId` TEXT NOT NULL,
+                                                `instanceId` TEXT NOT NULL,
                                                 `isSynced` INTEGER NOT NULL,
                                                 `utcDateChanged` TEXT NOT NULL
                                                 );
-CREATE TABLE IF NOT EXISTS "api_tokens"
+CREATE TABLE IF NOT EXISTS "etapi_tokens"
 (
-    apiTokenId TEXT PRIMARY KEY NOT NULL,
-    token TEXT NOT NULL,
+    etapiTokenId TEXT PRIMARY KEY NOT NULL,
+    name TEXT NOT NULL,
+    tokenHash TEXT NOT NULL,
     utcDateCreated TEXT NOT NULL,
+    utcDateModified TEXT NOT NULL,
     isDeleted INT NOT NULL DEFAULT 0);
 CREATE TABLE IF NOT EXISTS "branches" (
                                           `branchId`	TEXT NOT NULL,
@@ -24,7 +28,6 @@ CREATE TABLE IF NOT EXISTS "branches" (
                                           `isDeleted`	INTEGER NOT NULL DEFAULT 0,
                                           `deleteId`    TEXT DEFAULT NULL,
                                           `utcDateModified`	TEXT NOT NULL,
-                                          utcDateCreated TEXT NOT NULL,
                                           PRIMARY KEY(`branchId`));
 CREATE TABLE IF NOT EXISTS "notes" (
                                        `noteId`	TEXT NOT NULL,
@@ -32,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,
@@ -39,33 +43,23 @@ 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,
+                                             `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,
-    value TEXT,
+    value TEXT not null,
     isSynced INTEGER default 0 not null,
-    utcDateCreated TEXT not null,
     utcDateModified TEXT NOT NULL
 );
 CREATE TABLE IF NOT EXISTS "attributes"
@@ -92,11 +86,12 @@ 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);
 CREATE INDEX IDX_attributes_noteId_index
@@ -109,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,16 @@
+# Running `docker-compose up` will create/use the "trilium-data" directory in the user home
+# Run `TRILIUM_DATA_DIR=/path/of/your/choice docker-compose up` to set a different directory
 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_DATA_DIR:-~/trilium-data}:/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/ApiToken.html

@@ -1,378 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Class: ApiToken</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Class: ApiToken</h1>
-
-    
-
-
-
-
-<section>
-
-<header>
-    
-        <h2><span class="attribs"><span class="type-signature"></span></span>ApiToken<span class="signature">()</span><span class="type-signature"></span></h2>
-        
-            <div class="class-description">ApiToken is an entity representing token used to authenticate against Trilium API from client applications. Currently used only by Trilium Sender.</div>
-        
-    
-</header>
-
-<article>
-    <div class="container-overview">
-    
-        
-
-    
-    <h2>Constructor</h2>
-    
-
-    
-    <h4 class="name" id="ApiToken"><span class="type-signature"></span>new ApiToken<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_api_token.js.html">becca/entities/api_token.js</a>, <a href="becca_entities_api_token.js.html#line9">line 9</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-    </div>
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-        <h3 class="subsection-title">Members</h3>
-
-        
-            
-<h4 class="name" id="apiTokenId"><span class="type-signature"></span>apiTokenId<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_api_token.js.html">becca/entities/api_token.js</a>, <a href="becca_entities_api_token.js.html#line18">line 18</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="token"><span class="type-signature"></span>token<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_api_token.js.html">becca/entities/api_token.js</a>, <a href="becca_entities_api_token.js.html#line20">line 20</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_api_token.js.html">becca/entities/api_token.js</a>, <a href="becca_entities_api_token.js.html#line22">line 22</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-    
-
-    
-
-    
-
-    
-</article>
-
-</section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="ApiToken.html">ApiToken</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="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.7</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

docs/backend_api/Branch.html

@@ -1,767 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Class: Branch</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Class: Branch</h1>
-
-    
-
-
-
-
-<section>
-
-<header>
-    
-        <h2><span class="attribs"><span class="type-signature"></span></span>Branch<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>
-        
-    
-</header>
-
-<article>
-    <div class="container-overview">
-    
-        
-
-    
-    <h2>Constructor</h2>
-    
-
-    
-    <h4 class="name" id="Branch"><span class="type-signature"></span>new Branch<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_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line12">line 12</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-    </div>
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-        <h3 class="subsection-title">Members</h3>
-
-        
-            
-<h4 class="name" id="branchId"><span class="type-signature"></span>branchId<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_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line43">line 43</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="childNote"><span class="type-signature"></span>childNote<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_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line85">line 85</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="isExpanded"><span class="type-signature"></span>isExpanded<span class="type-signature"> :boolean</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">boolean</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line53">line 53</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line45">line 45</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="notePosition"><span class="type-signature"></span>notePosition<span class="type-signature"> :int</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">int</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line51">line 51</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="parentNote"><span class="type-signature"></span>parentNote<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_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line99">line 99</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="parentNoteId"><span class="type-signature"></span>parentNoteId<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_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line47">line 47</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="prefix"><span class="type-signature"></span>prefix<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_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line49">line 49</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="utcDateModified"><span class="type-signature"></span>utcDateModified<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_branch.js.html">becca/entities/branch.js</a>, <a href="becca_entities_branch.js.html#line55">line 55</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-    
-
-    
-
-    
-
-    
-</article>
-
-</section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="ApiToken.html">ApiToken</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="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.7</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

docs/backend_api/Option.html

@@ -1,446 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Class: Option</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Class: Option</h1>
-
-    
-
-
-
-
-<section>
-
-<header>
-    
-        <h2><span class="attribs"><span class="type-signature"></span></span>Option<span class="signature">()</span><span class="type-signature"></span></h2>
-        
-            <div class="class-description">Option represents name-value pair, either directly configurable by the user or some system property.</div>
-        
-    
-</header>
-
-<article>
-    <div class="container-overview">
-    
-        
-
-    
-    <h2>Constructor</h2>
-    
-
-    
-    <h4 class="name" id="Option"><span class="type-signature"></span>new Option<span class="signature">()</span><span class="type-signature"></span></h4>
-    
-
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line9">line 9</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-    </div>
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-        <h3 class="subsection-title">Members</h3>
-
-        
-            
-<h4 class="name" id="isSynced"><span class="type-signature"></span>isSynced<span class="type-signature"> :boolean</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">boolean</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line22">line 22</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line18">line 18</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="utcDateModified"><span class="type-signature"></span>utcDateModified<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line24">line 24</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="value"><span class="type-signature"></span>value<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_option.js.html">becca/entities/option.js</a>, <a href="becca_entities_option.js.html#line20">line 20</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-    
-
-    
-
-    
-
-    
-</article>
-
-</section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="ApiToken.html">ApiToken</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="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.7</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

docs/backend_api/RecentNote.html

@@ -1,378 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Class: RecentNote</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Class: RecentNote</h1>
-
-    
-
-
-
-
-<section>
-
-<header>
-    
-        <h2><span class="attribs"><span class="type-signature"></span></span>RecentNote<span class="signature">()</span><span class="type-signature"></span></h2>
-        
-            <div class="class-description">RecentNote represents recently visited note.</div>
-        
-    
-</header>
-
-<article>
-    <div class="container-overview">
-    
-        
-
-    
-    <h2>Constructor</h2>
-    
-
-    
-    <h4 class="name" id="RecentNote"><span class="type-signature"></span>new RecentNote<span class="signature">()</span><span class="type-signature"></span></h4>
-    
-
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line9">line 9</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-    </div>
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-        <h3 class="subsection-title">Members</h3>
-
-        
-            
-<h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line17">line 17</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="notePath"><span class="type-signature"></span>notePath<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line19">line 19</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="utcDateCreated"><span class="type-signature"></span>utcDateCreated<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_recent_note.js.html">becca/entities/recent_note.js</a>, <a href="becca_entities_recent_note.js.html#line21">line 21</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-    
-
-    
-
-    
-
-    
-</article>
-
-</section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="ApiToken.html">ApiToken</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="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.7</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

docs/backend_api/becca_entities_abstract_becca_entity.js.html

@@ -0,0 +1,360 @@
+<!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() {
+        if (!this[this.constructor.primaryKeyName]) {
+            this[this.constructor.primaryKeyName] = utils.newEntityId();
+        }
+    }
+
+    /** @protected */
+    getUtcDateChanged() {
+        return this.utcDateModified || this.utcDateCreated;
+    }
+
+    /**
+     * @protected
+     * @returns {Becca}
+     */
+    get becca() {
+        if (!becca) {
+            becca = require('../becca');
+        }
+
+        return becca;
+    }
+
+    /** @protected */
+    putEntityChange(isDeleted) {
+        entityChangesService.putEntityChange({
+            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
+     * @returns {string}
+     */
+    generateHash(isDeleted) {
+        let contentToHash = "";
+
+        for (const propertyName of this.constructor.hashedProperties) {
+            contentToHash += `|${this[propertyName]}`;
+        }
+
+        if (isDeleted) {
+            contentToHash += "|deleted";
+        }
+
+        return utils.hash(contentToHash).substr(0, 10);
+    }
+
+    /** @protected */
+    getPojoToSave() {
+        return this.getPojo();
+    }
+
+    /**
+     * @protected
+     * @abstract
+     */
+    getPojo() {
+        throw new Error(`Unimplemented getPojo() for entity '${this.constructor.name}'`)
+    }
+
+    /**
+     * 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];
+
+        this.beforeSaving(opts);
+
+        const pojo = this.getPojoToSave();
+
+        sql.transactional(() => {
+            sql.upsert(entityName, primaryKeyName, pojo);
+
+            if (entityName === 'recent_notes') {
+                return;
+            }
+
+            this.putEntityChange(!!this.isDeleted);
+
+            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]);
+        // blobs are not marked as erased in entity_changes, they are just purged completely
+        // this is because technically every keystroke can create a new blob and there would be just too many
+        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.putEntityChange({
+            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.putEntityChange(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.putEntityChange(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_api_token.js.html

@@ -1,85 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Source: becca/entities/api_token.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/api_token.js</h1>
-
-    
-
-
-
-    
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>"use strict";
-
-const dateUtils = require('../../services/date_utils.js');
-const AbstractEntity = require("./abstract_entity.js");
-
-/**
- * ApiToken is an entity representing token used to authenticate against Trilium API from client applications. Currently used only by Trilium Sender.
- */
-class ApiToken extends AbstractEntity {
-    static get entityName() { return "api_tokens"; }
-    static get primaryKeyName() { return "apiTokenId"; }
-    static get hashedProperties() { return ["apiTokenId", "token", "utcDateCreated"]; }
-
-    constructor(row) {
-        super();
-
-        /** @type {string} */
-        this.apiTokenId = row.apiTokenId;
-        /** @type {string} */
-        this.token = row.token;
-        /** @type {string} */
-        this.utcDateCreated = row.utcDateCreated || dateUtils.utcNowDateTime();
-    }
-
-    getPojo() {
-        return {
-            apiTokenId: this.apiTokenId,
-            token: this.token,
-            utcDateCreated: this.utcDateCreated
-        }
-    }
-}
-
-module.exports = ApiToken;
-</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="ApiToken.html">ApiToken</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="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.7</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

docs/backend_api/becca_entities_battachment.js.html

@@ -0,0 +1,288 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: becca/entities/battachment.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/battachment.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>"use strict";
+
+const utils = require('../../services/utils');
+const dateUtils = require('../../services/date_utils');
+const AbstractBeccaEntity = require("./abstract_becca_entity");
+const sql = require("../../services/sql");
+const protectedSessionService = require("../../services/protected_session");
+const log = require("../../services/log");
+
+const attachmentRoleToNoteTypeMapping = {
+    'image': 'image'
+};
+
+/**
+ * Attachment represent data related/attached to the note. Conceptually similar to attributes, but intended for
+ * larger amounts of data and generally not accessible to the user.
+ *
+ * @extends AbstractBeccaEntity
+ */
+class BAttachment extends AbstractBeccaEntity {
+    static get entityName() { return "attachments"; }
+    static get primaryKeyName() { return "attachmentId"; }
+    static get hashedProperties() { return ["attachmentId", "ownerId", "role", "mime", "title", "blobId", "utcDateScheduledForErasureSince"]; }
+
+    constructor(row) {
+        super();
+
+        if (!row.ownerId?.trim()) {
+            throw new Error("'ownerId' must be given to initialize a Attachment entity");
+        } else if (!row.role?.trim()) {
+            throw new Error("'role' must be given to initialize a Attachment entity");
+        } else if (!row.mime?.trim()) {
+            throw new Error("'mime' must be given to initialize a Attachment entity");
+        } else if (!row.title?.trim()) {
+            throw new Error("'title' must be given to initialize a Attachment entity");
+        }
+
+        /** @type {string} */
+        this.attachmentId = row.attachmentId;
+        /** @type {string} either noteId or revisionId to which this attachment belongs */
+        this.ownerId = row.ownerId;
+        /** @type {string} */
+        this.role = row.role;
+        /** @type {string} */
+        this.mime = row.mime;
+        /** @type {string} */
+        this.title = row.title;
+        /** @type {int} */
+        this.position = row.position;
+        /** @type {string} */
+        this.blobId = row.blobId;
+        /** @type {boolean} */
+        this.isProtected = !!row.isProtected;
+        /** @type {string} */
+        this.dateModified = row.dateModified;
+        /** @type {string} */
+        this.utcDateModified = row.utcDateModified;
+        /** @type {string} */
+        this.utcDateScheduledForErasureSince = row.utcDateScheduledForErasureSince;
+
+        /** @type {int} optionally added to the entity */
+        this.contentLength = row.contentLength;
+
+        this.decrypt();
+    }
+
+    /** @returns {BAttachment} */
+    copy() {
+        return new BAttachment({
+            ownerId: this.ownerId,
+            role: this.role,
+            mime: this.mime,
+            title: this.title,
+            blobId: this.blobId,
+            isProtected: this.isProtected
+        });
+    }
+
+    /** @returns {BNote} */
+    getNote() {
+        return this.becca.notes[this.ownerId];
+    }
+
+    /** @returns {boolean} true if the note has string content (not binary) */
+    hasStringContent() {
+        return utils.isStringNote(this.type, this.mime);
+    }
+
+    isContentAvailable() {
+        return !this.attachmentId // new attachment which was not encrypted yet
+            || !this.isProtected
+            || protectedSessionService.isProtectedSessionAvailable()
+    }
+
+    getTitleOrProtected() {
+        return this.isContentAvailable() ? this.title : '[protected]';
+    }
+
+    decrypt() {
+        if (!this.isProtected || !this.attachmentId) {
+            this.isDecrypted = true;
+            return;
+        }
+
+        if (!this.isDecrypted &amp;&amp; protectedSessionService.isProtectedSessionAvailable()) {
+            try {
+                this.title = protectedSessionService.decryptString(this.title);
+                this.isDecrypted = true;
+            }
+            catch (e) {
+                log.error(`Could not decrypt attachment ${this.attachmentId}: ${e.message} ${e.stack}`);
+            }
+        }
+    }
+
+    /** @returns {string|Buffer}  */
+    getContent() {
+        return this._getContent();
+    }
+
+    /**
+     * @param content
+     * @param {object} [opts]
+     * @param {object} [opts.forceSave=false] - will also save this BAttachment entity
+     * @param {object} [opts.forceFrontendReload=false] - override frontend heuristics on when to reload, instruct to reload
+     */
+    setContent(content, opts) {
+        this._setContent(content, opts);
+    }
+
+    /** @returns {{note: BNote, branch: BBranch}} */
+    convertToNote() {
+        if (this.type === 'search') {
+            throw new Error(`Note of type search cannot have child notes`);
+        }
+
+        if (!this.getNote()) {
+            throw new Error("Cannot find note of this attachment. It is possible that this is note revision's attachment. " +
+                "Converting note revision's attachments to note is not (yet) supported.");
+        }
+
+        if (!(this.role in attachmentRoleToNoteTypeMapping)) {
+            throw new Error(`Mapping from attachment role '${this.role}' to note's type is not defined`);
+        }
+
+        if (!this.isContentAvailable()) { // isProtected is the same for attachment
+            throw new Error(`Cannot convert protected attachment outside of protected session`);
+        }
+
+        const noteService = require('../../services/notes');
+
+        const { note, branch } = noteService.createNewNote({
+            parentNoteId: this.ownerId,
+            title: this.title,
+            type: attachmentRoleToNoteTypeMapping[this.role],
+            mime: this.mime,
+            content: this.getContent(),
+            isProtected: this.isProtected
+        });
+
+        this.markAsDeleted();
+
+        const parentNote = this.getNote();
+
+        if (this.role === 'image' &amp;&amp; parentNote.type === 'text') {
+            const origContent = parentNote.getContent();
+            const oldAttachmentUrl = `api/attachments/${this.attachmentId}/image/`;
+            const newNoteUrl = `api/images/${note.noteId}/`;
+
+            const fixedContent = utils.replaceAll(origContent, oldAttachmentUrl, newNoteUrl);
+
+            if (fixedContent !== origContent) {
+                parentNote.setContent(fixedContent);
+            }
+
+            noteService.asyncPostProcessContent(note, fixedContent);
+        }
+
+        return { note, branch };
+    }
+
+    getFileName() {
+        const type = this.role === 'image' ? 'image' : 'file';
+
+        return utils.formatDownloadTitle(this.title, type, this.mime);
+    }
+
+    beforeSaving() {
+        super.beforeSaving();
+
+        if (this.position === undefined || this.position === null) {
+            this.position = 10 + sql.getValue(`SELECT COALESCE(MAX(position), 0)
+                                              FROM attachments
+                                              WHERE ownerId = ?`, [this.noteId]);
+        }
+
+        this.dateModified = dateUtils.localNowDateTime();
+        this.utcDateModified = dateUtils.utcNowDateTime();
+    }
+
+    getPojo() {
+        return {
+            attachmentId: this.attachmentId,
+            ownerId: this.ownerId,
+            role: this.role,
+            mime: this.mime,
+            title: this.title,
+            position: this.position,
+            blobId: this.blobId,
+            isProtected: !!this.isProtected,
+            isDeleted: false,
+            dateModified: this.dateModified,
+            utcDateModified: this.utcDateModified,
+            utcDateScheduledForErasureSince: this.utcDateScheduledForErasureSince,
+            contentLength: this.contentLength
+        };
+    }
+
+    getPojoToSave() {
+        const pojo = this.getPojo();
+        delete pojo.contentLength;
+
+        if (pojo.isProtected) {
+            if (this.isDecrypted) {
+                pojo.title = protectedSessionService.encrypt(pojo.title);
+            }
+            else {
+                // updating protected note outside of protected session means we will keep original ciphertexts
+                delete pojo.title;
+            }
+        }
+
+        return pojo;
+    }
+}
+
+module.exports = BAttachment;
+</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_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,17 +28,20 @@
         <article>
             <pre class="prettyprint source linenums"><code>"use strict";
 
-const Note = require('./note.js');
-const AbstractEntity = require("./abstract_entity.js");
-const sql = require("../../services/sql.js");
-const dateUtils = require("../../services/date_utils.js");
+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 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"]; }
@@ -79,7 +82,7 @@ class Attribute extends AbstractEntity {
         /** @type {int} */
         this.position = position;
         /** @type {string} */
-        this.value = value;
+        this.value = value || "";
         /** @type {boolean} */
         this.isInheritable = !!isInheritable;
         /** @type {string} */
@@ -95,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);
@@ -111,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
@@ -135,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) {
@@ -157,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:'));
@@ -181,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) {
@@ -222,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,
@@ -234,7 +261,7 @@ class Attribute extends AbstractEntity {
     }
 }
 
-module.exports = Attribute;
+module.exports = BAttribute;
 </code></pre>
         </article>
     </section>
@@ -245,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="ApiToken.html">ApiToken</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="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.7</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_bblob.js.html

@@ -0,0 +1,81 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: becca/entities/bblob.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/bblob.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>class BBlob {
+    static get entityName() { return "blobs"; }
+    static get primaryKeyName() { return "blobId"; }
+    static get hashedProperties() { return ["blobId", "content"]; }
+
+    constructor(row) {
+        /** @type {string} */
+        this.blobId = row.blobId;
+        /** @type {string|Buffer} */
+        this.content = row.content;
+        /** @type {int} */
+        this.contentLength = row.contentLength;
+        /** @type {string} */
+        this.dateModified = row.dateModified;
+        /** @type {string} */
+        this.utcDateModified = row.utcDateModified;
+    }
+
+    getPojo() {
+        return {
+            blobId: this.blobId,
+            content: this.content,
+            contentLength: this.contentLength,
+            dateModified: this.dateModified,
+            utcDateModified: this.utcDateModified
+        };
+    }
+}
+
+module.exports = BBlob;
+</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_bbranch.js.html

@@ -0,0 +1,333 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: becca/entities/bbranch.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/bbranch.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>"use strict";
+
+const BNote = require('./bnote');
+const AbstractBeccaEntity = require("./abstract_becca_entity");
+const dateUtils = require("../../services/date_utils");
+const utils = require("../../services/utils");
+const TaskContext = require("../../services/task_context");
+const cls = require("../../services/cls");
+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.
+ *
+ * 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 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
+    static get hashedProperties() { return ["branchId", "noteId", "parentNoteId", "prefix"]; }
+
+    constructor(row) {
+        super();
+
+        if (!row) {
+            return;
+        }
+
+        this.updateFromRow(row);
+        this.init();
+    }
+
+    updateFromRow(row) {
+        this.update([
+            row.branchId,
+            row.noteId,
+            row.parentNoteId,
+            row.prefix,
+            row.notePosition,
+            row.isExpanded,
+            row.utcDateModified
+        ]);
+    }
+
+    update([branchId, noteId, parentNoteId, prefix, notePosition, isExpanded, utcDateModified]) {
+        /** @type {string} */
+        this.branchId = branchId;
+        /** @type {string} */
+        this.noteId = noteId;
+        /** @type {string} */
+        this.parentNoteId = parentNoteId;
+        /** @type {string|null} */
+        this.prefix = prefix;
+        /** @type {int} */
+        this.notePosition = notePosition;
+        /** @type {boolean} */
+        this.isExpanded = !!isExpanded;
+        /** @type {string} */
+        this.utcDateModified = utcDateModified;
+
+        return this;
+    }
+
+    init() {
+        if (this.branchId) {
+            this.becca.branches[this.branchId] = this;
+        }
+
+        this.becca.childParentToBranch[`${this.noteId}-${this.parentNoteId}`] = this;
+
+        const childNote = this.childNote;
+
+        if (!childNote.parentBranches.includes(this)) {
+            childNote.parentBranches.push(this);
+        }
+
+        if (this.noteId === 'root') {
+            return;
+        }
+
+        const parentNote = this.parentNote;
+
+        if (!childNote.parents.includes(parentNote)) {
+            childNote.parents.push(parentNote);
+        }
+
+        if (!parentNote.children.includes(childNote)) {
+            parentNote.children.push(childNote);
+        }
+    }
+
+    /** @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 BNote({noteId: this.noteId}));
+        }
+
+        return this.becca.notes[this.noteId];
+    }
+
+    /** @returns {BNote} */
+    getNote() {
+        return this.childNote;
+    }
+
+    /** @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) &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 BNote({noteId: this.parentNoteId}));
+        }
+
+        return this.becca.notes[this.parentNoteId];
+    }
+
+    get isDeleted() {
+        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]
+     *
+     * @returns {boolean} - true if note has been deleted, false otherwise
+     */
+    deleteBranch(deleteId, taskContext) {
+        if (!deleteId) {
+            deleteId = utils.randomString(10);
+        }
+
+        if (!taskContext) {
+            taskContext = new TaskContext('no-progress-reporting');
+        }
+
+        taskContext.increaseProgressCount();
+
+        const note = this.getNote();
+
+        if (!taskContext.noteDeletionHandlerTriggered) {
+            const parentBranches = note.getParentBranches();
+
+            if (parentBranches.length === 1 &amp;&amp; parentBranches[0] === this) {
+                // needs to be run before branches and attributes are deleted and thus attached relations disappear
+                const handlers = require("../../services/handlers");
+                handlers.runAttachedRelations(note, 'runOnNoteDeletion', note);
+            }
+        }
+
+        if (this.noteId === 'root'
+            || this.noteId === cls.getHoistedNoteId()) {
+
+            throw new Error("Can't delete root or hoisted branch/note");
+        }
+
+        this.markAsDeleted(deleteId);
+
+        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}'`);
+
+            this.becca.notes[note.noteId].isBeingDeleted = true;
+
+            for (const attribute of note.getOwnedAttributes().slice()) {
+                attribute.markAsDeleted(deleteId);
+            }
+
+            for (const relation of note.getTargetRelations()) {
+                relation.markAsDeleted(deleteId);
+            }
+
+            for (const attachment of note.getAttachments()) {
+                attachment.markAsDeleted(deleteId);
+            }
+
+            note.markAsDeleted(deleteId);
+
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+
+    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) {
+            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();
+
+        this.becca.branches[this.branchId] = this;
+    }
+
+    getPojo() {
+        return {
+            branchId: this.branchId,
+            noteId: this.noteId,
+            parentNoteId: this.parentNoteId,
+            prefix: this.prefix,
+            notePosition: this.notePosition,
+            isExpanded: this.isExpanded,
+            isDeleted: false,
+            utcDateModified: this.utcDateModified
+        };
+    }
+
+    createClone(parentNoteId, notePosition) {
+        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 = BBranch;
+</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_betapi_token.js.html

@@ -0,0 +1,129 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: becca/entities/betapi_token.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/betapi_token.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>"use strict";
+
+const dateUtils = require('../../services/date_utils');
+const AbstractBeccaEntity = require("./abstract_becca_entity");
+
+/**
+ * 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 "&lt;etapiTokenId>_&lt;tokenHash>". This is also called "authToken" to distinguish it
+ * from tokenHash and token.
+ *
+ * @extends AbstractBeccaEntity
+ */
+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"]; }
+
+    constructor(row) {
+        super();
+
+        if (!row) {
+            return;
+        }
+
+        this.updateFromRow(row);
+        this.init();
+    }
+
+    updateFromRow(row) {
+        /** @type {string} */
+        this.etapiTokenId = row.etapiTokenId;
+        /** @type {string} */
+        this.name = row.name;
+        /** @type {string} */
+        this.tokenHash = row.tokenHash;
+        /** @type {string} */
+        this.utcDateCreated = row.utcDateCreated || dateUtils.utcNowDateTime();
+        /** @type {string} */
+        this.utcDateModified = row.utcDateModified || this.utcDateCreated;
+        /** @type {boolean} */
+        this.isDeleted = !!row.isDeleted;
+
+        if (this.etapiTokenId) {
+            this.becca.etapiTokens[this.etapiTokenId] = this;
+        }
+    }
+
+    init() {
+        if (this.etapiTokenId) {
+            this.becca.etapiTokens[this.etapiTokenId] = this;
+        }
+    }
+
+    getPojo() {
+        return {
+            etapiTokenId: this.etapiTokenId,
+            name: this.name,
+            tokenHash: this.tokenHash,
+            utcDateCreated: this.utcDateCreated,
+            utcDateModified: this.utcDateModified,
+            isDeleted: this.isDeleted
+        }
+    }
+
+    beforeSaving() {
+        this.utcDateModified = dateUtils.utcNowDateTime();
+
+        super.beforeSaving();
+
+        this.becca.etapiTokens[this.etapiTokenId] = this;
+    }
+}
+
+module.exports = BEtapiToken;
+</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_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>
 
     
 
@@ -28,13 +28,15 @@
         <article>
             <pre class="prettyprint source linenums"><code>"use strict";
 
-const dateUtils = require('../../services/date_utils.js');
-const AbstractEntity = require("./abstract_entity.js");
+const dateUtils = require('../../services/date_utils');
+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 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"]; }
@@ -42,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} */
@@ -50,8 +57,6 @@ class Option extends AbstractEntity {
         this.isSynced = !!row.isSynced;
         /** @type {string} */
         this.utcDateModified = row.utcDateModified;
-
-        this.becca.options[this.name] = this;
     }
 
     beforeSaving() {
@@ -65,14 +70,12 @@ class Option extends AbstractEntity {
             name: this.name,
             value: this.value,
             isSynced: this.isSynced,
-            utcDateModified: this.utcDateModified,
-            // utcDateCreated is scheduled for removal so the value does not matter
-            utcDateCreated: dateUtils.utcNowDateTime()
+            utcDateModified: this.utcDateModified
         }
     }
 }
 
-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="ApiToken.html">ApiToken</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="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.7</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_branch.js.html

@@ -1,207 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Source: becca/entities/branch.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/branch.js</h1>
-
-    
-
-
-
-    
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>"use strict";
-
-const Note = require('./note.js');
-const AbstractEntity = require("./abstract_entity.js");
-const sql = require("../../services/sql.js");
-const dateUtils = require("../../services/date_utils.js");
-
-/**
- * Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
- * parents.
- */
-class Branch extends AbstractEntity {
-    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
-    static get hashedProperties() { return ["branchId", "noteId", "parentNoteId", "prefix"]; }
-
-    constructor(row) {
-        super();
-
-        if (!row) {
-            return;
-        }
-
-        this.updateFromRow(row);
-        this.init();
-    }
-
-    updateFromRow(row) {
-        this.update([
-            row.branchId,
-            row.noteId,
-            row.parentNoteId,
-            row.prefix,
-            row.notePosition,
-            row.isExpanded,
-            row.utcDateModified
-        ]);
-    }
-
-    update([branchId, noteId, parentNoteId, prefix, notePosition, isExpanded, utcDateModified]) {
-        /** @type {string} */
-        this.branchId = branchId;
-        /** @type {string} */
-        this.noteId = noteId;
-        /** @type {string} */
-        this.parentNoteId = parentNoteId;
-        /** @type {string} */
-        this.prefix = prefix;
-        /** @type {int} */
-        this.notePosition = notePosition;
-        /** @type {boolean} */
-        this.isExpanded = !!isExpanded;
-        /** @type {string} */
-        this.utcDateModified = utcDateModified;
-
-        return this;
-    }
-
-    init() {
-        if (this.branchId === '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);
-        }
-
-        this.becca.branches[this.branchId] = this;
-        this.becca.childParentToBranch[`${this.noteId}-${this.parentNoteId}`] = this;
-    }
-
-    /** @returns {Note} */
-    get childNote() {
-        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}));
-        }
-
-        return this.becca.notes[this.noteId];
-    }
-
-    getNote() {
-        return this.childNote;
-    }
-
-    /** @returns {Note} */
-    get parentNote() {
-        if (!(this.parentNoteId in this.becca.notes)) {
-            // entities can come out of order in sync, create skeleton which will be filled later
-            this.becca.addNote(this.parentNoteId, new Note({noteId: this.parentNoteId}));
-        }
-
-        return this.becca.notes[this.parentNoteId];
-    }
-
-    get isDeleted() {
-        return !(this.branchId in this.becca.branches);
-    }
-
-    beforeSaving() {
-        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;
-        }
-
-        if (!this.isExpanded) {
-            this.isExpanded = false;
-        }
-
-        this.utcDateModified = dateUtils.utcNowDateTime();
-
-        super.beforeSaving();
-
-        this.becca.branches[this.branchId] = this;
-    }
-
-    getPojo() {
-        return {
-            branchId: this.branchId,
-            noteId: this.noteId,
-            parentNoteId: this.parentNoteId,
-            prefix: this.prefix,
-            notePosition: this.notePosition,
-            isExpanded: this.isExpanded,
-            isDeleted: false,
-            utcDateModified: this.utcDateModified,
-            // not used for anything, will be later dropped
-            utcDateCreated: dateUtils.utcNowDateTime()
-        };
-    }
-
-    createClone(parentNoteId, notePosition) {
-        return new Branch({
-            noteId: this.noteId,
-            parentNoteId: parentNoteId,
-            notePosition: notePosition,
-            prefix: this.prefix,
-            isExpanded: this.isExpanded
-        });
-    }
-}
-
-module.exports = Branch;
-</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="ApiToken.html">ApiToken</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="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.7</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

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>
 
     
 
@@ -28,13 +28,15 @@
         <article>
             <pre class="prettyprint source linenums"><code>"use strict";
 
-const dateUtils = require('../../services/date_utils.js');
-const AbstractEntity = require("./abstract_entity.js");
+const dateUtils = require('../../services/date_utils');
+const AbstractBeccaEntity = require("./abstract_becca_entity");
 
 /**
  * RecentNote represents recently visited note.
+ *
+ * @extends AbstractBeccaEntity
  */
-class RecentNote extends AbstractEntity {
+class BRecentNote extends AbstractBeccaEntity {
     static get entityName() { return "recent_notes"; }
     static get primaryKeyName() { return "noteId"; }
 
@@ -58,7 +60,7 @@ class RecentNote extends AbstractEntity {
     }
 }
 
-module.exports = RecentNote;
+module.exports = BRecentNote;
 </code></pre>
         </article>
     </section>
@@ -69,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="ApiToken.html">ApiToken</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="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.7</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_brevision.js.html

@@ -0,0 +1,265 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Source: becca/entities/brevision.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/brevision.js</h1>
+
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>"use strict";
+
+const protectedSessionService = require('../../services/protected_session');
+const utils = require('../../services/utils');
+const dateUtils = require('../../services/date_utils');
+const becca = require('../becca');
+const AbstractBeccaEntity = require("./abstract_becca_entity");
+const sql = require("../../services/sql");
+const BAttachment = require("./battachment");
+
+/**
+ * Revision represents a snapshot of note's title and content at some point in the past.
+ * It's used for seamless note versioning.
+ *
+ * @extends AbstractBeccaEntity
+ */
+class BRevision extends AbstractBeccaEntity {
+    static get entityName() { return "revisions"; }
+    static get primaryKeyName() { return "revisionId"; }
+    static get hashedProperties() { return ["revisionId", "noteId", "title", "isProtected", "dateLastEdited", "dateCreated",
+                                            "utcDateLastEdited", "utcDateCreated", "utcDateModified", "blobId"]; }
+
+    constructor(row, titleDecrypted = false) {
+        super();
+
+        /** @type {string} */
+        this.revisionId = row.revisionId;
+        /** @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.blobId = row.blobId;
+        /** @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 {int} */
+        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) */
+    hasStringContent() {
+        return utils.isStringNote(this.type, this.mime);
+    }
+
+    isContentAvailable() {
+        return !this.revisionId // new note which was not encrypted yet
+            || !this.isProtected
+            || protectedSessionService.isProtectedSessionAvailable()
+    }
+
+    /*
+     * Note revision content has quite special handling - it's not a separate entity, but a lazily loaded
+     * part of Revision entity with its own sync. The 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 {string|Buffer} */
+    getContent() {
+        return this._getContent();
+    }
+
+    /**
+     * @returns {*}
+     * @throws Error in case of invalid JSON */
+    getJsonContent() {
+        const content = this.getContent();
+
+        if (!content || !content.trim()) {
+            return null;
+        }
+
+        return JSON.parse(content);
+    }
+
+    /** @returns {*|null} valid object or null if the content cannot be parsed as JSON */
+    getJsonContentSafely() {
+        try {
+            return this.getJsonContent();
+        }
+        catch (e) {
+            return null;
+        }
+    }
+
+    /**
+     * @param content
+     * @param {object} [opts]
+     * @param {object} [opts.forceSave=false] - will also save this BRevision entity
+     */
+    setContent(content, opts) {
+        this._setContent(content, opts);
+    }
+
+    /** @returns {BAttachment[]} */
+    getAttachments() {
+        return sql.getRows(`
+                SELECT attachments.*
+                FROM attachments 
+                WHERE ownerId = ? 
+                  AND isDeleted = 0`, [this.revisionId])
+            .map(row => new BAttachment(row));
+    }
+
+    /** @returns {BAttachment|null} */
+    getAttachmentById(attachmentId, opts = {}) {
+        opts.includeContentLength = !!opts.includeContentLength;
+
+        const query = opts.includeContentLength
+            ? `SELECT attachments.*, LENGTH(blobs.content) AS contentLength
+               FROM attachments 
+               JOIN blobs USING (blobId) 
+               WHERE ownerId = ? AND attachmentId = ? AND isDeleted = 0`
+            : `SELECT * FROM attachments WHERE ownerId = ? AND attachmentId = ? AND isDeleted = 0`;
+
+        return sql.getRows(query, [this.revisionId, attachmentId])
+            .map(row => new BAttachment(row))[0];
+    }
+
+    /** @returns {BAttachment[]} */
+    getAttachmentsByRole(role) {
+        return sql.getRows(`
+                SELECT attachments.*
+                FROM attachments 
+                WHERE ownerId = ? 
+                  AND role = ?
+                  AND isDeleted = 0
+                ORDER BY position`, [this.revisionId, role])
+            .map(row => new BAttachment(row));
+    }
+
+    /** @returns {BAttachment} */
+    getAttachmentByTitle(title) {
+        return sql.getRows(`
+                SELECT attachments.*
+                FROM attachments 
+                WHERE ownerId = ? 
+                  AND title = ?
+                  AND isDeleted = 0
+                ORDER BY position`, [this.revisionId, title])
+            .map(row => new BAttachment(row))[0];
+    }
+
+    beforeSaving() {
+        super.beforeSaving();
+
+        this.utcDateModified = dateUtils.utcNowDateTime();
+    }
+
+    getPojo() {
+        return {
+            revisionId: this.revisionId,
+            noteId: this.noteId,
+            type: this.type,
+            mime: this.mime,
+            isProtected: this.isProtected,
+            title: this.title,
+            blobId: this.blobId,
+            dateLastEdited: this.dateLastEdited,
+            dateCreated: this.dateCreated,
+            utcDateLastEdited: this.utcDateLastEdited,
+            utcDateCreated: this.utcDateCreated,
+            utcDateModified: this.utcDateModified,
+            content: this.content, // used when retrieving full note revision to frontend
+            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 = BRevision;
+</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_note_revision.js.html

@@ -1,245 +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.js');
-const entityChangesService = require('../../services/entity_changes');
-const AbstractEntity = require("./abstract_entity.js");
-
-/**
- * NoteRevision represents snapshot of note's title and content at some point in the past.
- * It's used for seamless note versioning.
- */
-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) {
-        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) {
-            if (protectedSessionService.isProtectedSessionAvailable()) {
-                this.title = protectedSessionService.decryptString(this.title);
-            }
-            else {
-                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 it's 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="ApiToken.html">ApiToken</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="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.7</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="ApiToken.html">ApiToken</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="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.7</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>
@@ -39,6 +37,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#line352">line 352</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#line343">line 343</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#line333">line 333</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#line309">line 309</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#line320">line 320</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#line299">line 299</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="ApiToken.html">ApiToken</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="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.7</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,41 @@ 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");
+const syncMutex = require("./sync_mutex.js");
 
 /**
- * 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 +88,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 +132,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 +151,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,23 +161,23 @@ 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 create 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;
 
     /**
-     * If there's a branch between note and parent note, remove it. Otherwise do nothing.
+     * If there's a branch between note and parent note, remove it. Otherwise, do nothing.
      *
      * @method
      * @param {string} noteId
@@ -189,25 +193,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 create 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 +218,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 +232,23 @@ function BackendScriptApi(currentNote, apiParams) {
         mime: 'application/json'
     });
 
-    /**
-     * @typedef {object} CreateNewNoteParams
-     * @property {string} parentNoteId - MANDATORY
-     * @property {string} title - MANDATORY
-     * @property {string|buffer} content - MANDATORY
-     * @property {string} type - text, code, file, image, search, book, relation-map - MANDATORY
-     * @property {string} mime - value is derived from default mimes for type
-     * @property {boolean} isProtected - default is false
-     * @property {boolean} isExpanded - default is false
-     * @property {string} prefix - default is empty string
-     * @property {int} notePosition - default is last existing notePosition in a parent + 10
-     */
-
     /**
      * @method
      *
-     * @param {CreateNewNoteParams} [params]
-     * @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 +256,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 +273,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 +303,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(`Script "${currentNote.title}" (${currentNote.noteId}): ${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,15 +347,17 @@ function BackendScriptApi(currentNote, apiParams) {
      *
      * @method
      * @param {string} date in YYYY-MM-DD format
-     * @returns {Note|null}
+     * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use the default calendar
+     * @returns {BNote|null}
      */
-    this.getDateNote = dateNoteService.getDateNote;
+    this.getDayNote = dateNoteService.getDayNote;
 
     /**
      * 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;
 
@@ -353,8 +366,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;
 
@@ -363,7 +378,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;
 
@@ -372,15 +388,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
@@ -389,10 +419,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;
 
@@ -410,7 +441,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;
@@ -436,14 +467,161 @@ 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);
+
+    /**
+     * Executes given anonymous function on the frontend(s).
+     * Internally this serializes the anonymous function into string and sends it to frontend(s) via WebSocket.
+     * Note that there can be multiple connected frontend instances (e.g. in different tabs). In such case, all
+     * instances execute the given function.
+     *
+     * @method
+     * @param {string} script - script to be executed on the frontend
+     * @param {Array.<?>} params - list of parameters to the anonymous function to be sent to frontend
+     * @returns {undefined} - no return value is provided.
+     */
+    this.runOnFrontend = async (script, params = []) => {
+        if (typeof script === "function") {
+            script = script.toString();
+        }
+
+        ws.sendMessageToAllClients({
+            type: 'execute-script',
+            script: script,
+            params: prepareParams(params),
+            startNoteId: this.startNote.noteId,
+            currentNoteId: this.currentNote.noteId,
+            originEntityName: "notes", // currently there's no other entity on the frontend which can trigger event
+            originEntityId: this.originEntity?.noteId || null
+        });
+
+        function prepareParams(params) {
+            if (!params) {
+                return params;
+            }
+
+            return params.map(p => {
+                if (typeof p === "function") {
+                    return `!@#Function: ${p.toString()}`;
+                }
+                else {
+                    return p;
+                }
+            });
+        }
+    };
+
+    /**
+     * Sync process can make data intermittently inconsistent. Scripts which require strong data consistency
+     * can use this function to wait for a possible sync process to finish and prevent new sync process from starting
+     * while it is running.
+     *
+     * Because this is an async process, the inner callback doesn't have automatic transaction handling, so in case
+     * you need to make some DB changes, you need to surround your call with api.transactional(...)
+     *
+     * @method
+     * @param {function} callback - function to be executed while sync process is not running
+     * @returns {Promise} - resolves once the callback is finished (callback is awaited)
+     */
+    this.runOutsideOfSync = syncMutex.doExclusively;
+
+    /**
+     * This object contains "at your risk" and "no BC guarantees" objects for advanced use cases.
+     *
+     * @property {Becca} becca - provides access to the backend in-memory object graph, see {@link https://github.com/zadam/trilium/blob/master/src/becca/becca.js}
+     */
+    this.__private = {
+        becca
+    }
 }
 
 module.exports = BackendScriptApi;
@@ -457,13 +635,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="ApiToken.html">ApiToken</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="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.7</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

@@ -36,10 +36,13 @@ const log = require('./log');
 const Database = require('better-sqlite3');
 const dataDir = require('./data_dir');
 const cls = require('./cls');
+const fs = require("fs-extra");
 
 const dbConnection = new Database(dataDir.DOCUMENT_PATH);
 dbConnection.pragma('journal_mode = WAL');
 
+const LOG_ALL_QUERIES = false;
+
 [`exit`, `SIGINT`, `SIGUSR1`, `SIGUSR2`, `SIGTERM`].forEach(eventType => {
     process.on(eventType, () => {
         if (dbConnection) {
@@ -51,16 +54,22 @@ dbConnection.pragma('journal_mode = WAL');
 });
 
 function insert(tableName, rec, replace = false) {
-    const keys = Object.keys(rec);
+    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));
 
@@ -72,15 +81,15 @@ function replace(tableName, rec) {
 }
 
 function upsert(tableName, primaryKey, rec) {
-    const keys = Object.keys(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(", ");
 
@@ -117,13 +126,7 @@ function getRowOrNull(query, params = []) {
 }
 
 function getValue(query, params = []) {
-    const row = getRowOrNull(query, params);
-
-    if (!row) {
-        return null;
-    }
-
-    return row[Object.keys(row)[0]];
+    return wrap(query, s => s.pluck().get(params));
 }
 
 // smaller values can result in better performance due to better usage of statement cache
@@ -167,48 +170,37 @@ function getRawRows(query, params = []) {
 }
 
 function iterateRows(query, params = []) {
+    if (LOG_ALL_QUERIES) {
+        console.log(query);
+    }
+
     return stmt(query).iterate(params);
 }
 
 function getMap(query, params = []) {
     const map = {};
-    const results = getRows(query, params);
+    const results = getRawRows(query, params);
 
     for (const row of results) {
-        const keys = Object.keys(row);
-
-        map[row[keys[0]]] = row[keys[1]];
+        map[row[0]] = row[1];
     }
 
     return map;
 }
 
 function getColumn(query, params = []) {
-    const list = [];
-    const result = getRows(query, params);
-
-    if (result.length === 0) {
-        return list;
-    }
-
-    const key = Object.keys(result[0])[0];
-
-    for (const row of result) {
-        list.push(row[key]);
-    }
-
-    return list;
+    return wrap(query, s => s.pluck().all(params));
 }
 
 function execute(query, params = []) {
     return wrap(query, s => s.run(params));
 }
 
-function executeWithoutTransaction(query, params = []) {
-    dbConnection.run(query, params);
+function executeMany(query, params) {
+    if (LOG_ALL_QUERIES) {
+        console.log(query);
     }
 
-function executeMany(query, params) {
     while (params.length > 0) {
         const curParams = params.slice(0, Math.min(params.length, PARAM_LIMIT));
         params = params.slice(curParams.length);
@@ -229,6 +221,10 @@ function executeMany(query, params) {
 }
 
 function executeScript(query) {
+    if (LOG_ALL_QUERIES) {
+        console.log(query);
+    }
+
     return dbConnection.exec(query);
 }
 
@@ -236,6 +232,10 @@ function wrap(query, func) {
     const startTimestamp = Date.now();
     let result;
 
+    if (LOG_ALL_QUERIES) {
+        console.log(query);
+    }
+
     try {
         result = func(stmt(query));
     }
@@ -245,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;
@@ -276,14 +276,17 @@ function transactional(func) {
         return ret;
     }
     catch (e) {
-        const entityChanges = cls.getAndClearEntityChangeIds();
+        const entityChangeIds = cls.getAndClearEntityChangeIds();
 
-        if (entityChanges.length > 0) {
+        if (entityChangeIds.length > 0) {
             log.info("Transaction rollback dirtied the becca, forcing reload.");
 
             require('../becca/becca_loader').load();
         }
 
+        // the maxEntityChangeId has been incremented during failed transaction, need to recalculate
+        require('./entity_changes').recalculateMaxEntityChangeId();
+
         throw e;
     }
 }
@@ -306,11 +309,20 @@ 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);
 }
 
+async function copyDatabase(targetFilePath) {
+    try {
+        fs.unlinkSync(targetFilePath);
+    } catch (e) {
+    } // unlink throws exception if the file did not exist
+
+    await dbConnection.backup(targetFilePath);
+}
+
 module.exports = {
     dbConnection,
     insert,
@@ -322,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,
 
@@ -332,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,
@@ -343,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,
@@ -356,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,
 
@@ -366,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,
 
@@ -378,12 +390,12 @@ module.exports = {
      * @param {object[]} [params] - array of params if needed
      */
     execute,
-    executeWithoutTransaction,
     executeMany,
     executeScript,
     transactional,
     upsert,
-    fillParamList
+    fillParamList,
+    copyDatabase
 };
 </code></pre>
         </article>
@@ -395,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="ApiToken.html">ApiToken</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="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.7</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
 </footer>
 
 <script> prettyPrint(); </script>

docs/frontend_api/Attribute.html

@@ -1,757 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <title>JSDoc: Class: Attribute</title>
-
-    <script src="scripts/prettify/prettify.js"> </script>
-    <script src="scripts/prettify/lang-css.js"> </script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-
-<body>
-
-<div id="main">
-
-    <h1 class="page-title">Class: Attribute</h1>
-
-    
-
-
-
-
-<section>
-
-<header>
-    
-        <h2><span class="attribs"><span class="type-signature"></span></span>Attribute<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>
-        
-    
-</header>
-
-<article>
-    <div class="container-overview">
-    
-        
-
-    
-    <h2>Constructor</h2>
-    
-
-    
-    <h4 class="name" id="Attribute"><span class="type-signature"></span>new Attribute<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="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line7">line 7</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-    </div>
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-        <h3 class="subsection-title">Members</h3>
-
-        
-            
-<h4 class="name" id="attributeId"><span class="type-signature"></span>attributeId<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="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line16">line 16</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="isInheritable"><span class="type-signature"></span>isInheritable<span class="type-signature"> :boolean</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">boolean</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line28">line 28</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line22">line 22</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="noteId"><span class="type-signature"></span>noteId<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line18">line 18</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="position"><span class="type-signature"></span>position<span class="type-signature"> :int</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">int</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line26">line 26</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line20">line 20</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="entities_attribute.js.html">entities/attribute.js</a>, <a href="entities_attribute.js.html#line24">line 24</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-    
-
-    
-        <h3 class="subsection-title">Methods</h3>
-
-        
-            
-
-    
-
-    
-    <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>
-    
-
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <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>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<h5>Returns:</h5>
-
-        
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type"><a href="NoteShort.html">NoteShort</a></span>
-
-
-    </dd>
-</dl>
-
-    
-
-
-
-
-
-        
-    
-
-    
-
-    
-</article>
-
-</section>
-
-
-
-
-</div>
-
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
-</nav>
-
-<br class="clear">
-
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a>
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>

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="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line13">line 13</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="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line44">line 44</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="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line56">line 56</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="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line50">line 50</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="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line46">line 46</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="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line52">line 52</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,75 +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="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line48">line 48</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-        
-            
-<h4 class="name" id="utcDateModified"><span class="type-signature"></span>utcDateModified<span class="type-signature"> :string</span></h4>
-
-
-
-
-
-
-    <h5>Type:</h5>
-    <ul>
-        <li>
-            
-<span class="param-type">string</span>
-
-
-        </li>
-    </ul>
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line58">line 58</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line21">line 21</a>
     </li></ul></dd>
     
 
@@ -670,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="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line54">line 54</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line25">line 25</a>
     </li></ul></dd>
     
 
@@ -698,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="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="FNote.html">FNote</a>}</span></h4>
     
 
     
@@ -746,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="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line112">line 112</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line33">line 33</a>
     </li></ul></dd>
     
 
@@ -782,10 +782,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">null</span>
+<span class="param-type"><a href="FNote.html">FNote</a></span>
 
 
     </dd>
@@ -803,7 +800,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">(async) </span>getTargetNote<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="FNote.html">FNote</a>>}</span></h4>
     
 
     
@@ -851,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="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line119">line 119</a>
+        <a href="entities_fattribute.js.html">entities/fattribute.js</a>, <a href="entities_fattribute.js.html#line38">line 38</a>
     </li></ul></dd>
     
 
@@ -887,112 +884,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">null</span>
-
-
-    </dd>
-</dl>
-
-    
-
-
-
-
-
-        
-            
-
-    
-
-    
-    <h4 class="name" id="isDefinition"><span class="type-signature"></span>isDefinition<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
-    
-
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="becca_entities_attribute.js.html">becca/entities/attribute.js</a>, <a href="becca_entities_attribute.js.html#line134">line 134</a>
-    </li></ul></dd>
-    
-
-    
-
-    
-
-    
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<h5>Returns:</h5>
-
-        
-
-
-<dl>
-    <dt>
-        Type
-    </dt>
-    <dd>
-        
-<span class="param-type">boolean</span>
+<span class="param-type">Promise.&lt;<a href="FNote.html">FNote</a>></span>
 
 
     </dd>
@@ -1020,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>Modules</h3><ul><li><a href="module-sql.html">sql</a></li></ul><h3>Classes</h3><ul><li><a href="ApiToken.html">ApiToken</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="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>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><h3>Global</h3><ul><li><a href="global.html#getJsonContent">getJsonContent</a></li><li><a href="global.html#getJsonContentSafely">getJsonContentSafely</a></li></ul>
 </nav>
 
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a>
 </footer>
 
 <script> prettyPrint(); </script>