diff --git a/docs/backend_api/ApiToken.html b/docs/backend_api/ApiToken.html
index f00a999d2..b768600a5 100644
--- a/docs/backend_api/ApiToken.html
+++ b/docs/backend_api/ApiToken.html
@@ -282,7 +282,7 @@
- Classes
+ Classes
- Classes
+ Classes
Source:
Source:
Source:
+ Trigger tree refresh in all connected clients. This is required when some tree change happens in
+the backend.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+ Source:
Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ object contains newly created entities note and branch
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<{note: Note , branch: Branch }>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (parentNoteId, title, contentopt , extraOptionsopt ) → {Promise.<{note: Note , branch: Branch }>}
+ Creates new note according to given params and force all connected clients to refresh their tree.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
+
+
+
+
+ parentNoteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ create new note under this parent
+
+
+
+
+
+
+ title
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+ ""
+
+
+
+
+
+
+
+
+
+
+ extraOptions
+
+
+CreateNoteExtraOptions
+
+
+
+
+ <optional>
+
+
+
+
+
+ {}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+ Source:
Source:
() → {Object|*}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ - object representing basic info about running Trilium version
+
+
+
+
+
+
+ Type
+
+
+
+Object
+|
+
+*
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
(attributeId) → {Promise.<(Attribute |null)>} Source:
Source:
- Returns day note for given date (YYYY-MM-DD format). If such note doesn't exist, it is created.
+ Returns day note for given date. If such note doesn't exist, it is created.
@@ -1484,7 +1940,7 @@
- in YYYY-MM-DD format
@@ -1525,7 +1981,7 @@
Source:
Source:
Source:
Source:
Source:
(date) → {Promise.<(Note |null)>}
+ Returns month note for given date. If such note doesn't exist, it is created.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ date
+
+
+string
+
+
+
+
+
+
+
+
+
+ in YYYY-MM format
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<(Note |null)>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
(noteId) → {Promise.<(Note |null)>} Source:
Source:
Source:
Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<(Note |null)>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (date, options) → {Promise.<(Note |null)>}
+ Returns note for the first date of the week of the given date.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ date
+
+
+string
+
+
+
+
+
+
+
+
+
+ in YYYY-MM-DD format
+
+
+
+
+
+
+ options
+
+
+object
+
+
+
+
+
+
+
+
+
+ "startOfTheWeek" - either "monday" (default) or "sunday"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<(Note |null)>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (year) → {Promise.<(Note |null)>}
+ Returns year note for given year. If such note doesn't exist, it is created.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ year
+
+
+string
+
+
+
+
+
+
+
+
+
+ in YYYY format
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+ Source:
() → {Promise.<void>}
- Trigger tree refresh in all connected clients. This is required when some tree change happens in
-the backend.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
-
-
- Type
-
-
-
-Promise.<void>
-
-
-
-
-
-
-
-
-
-
-
-
-
@@ -3240,7 +4073,7 @@ This method looks similar to toggleNoteInParent() but differs because we're look
Source:
Source:
Source:
Source:
- Classes
+ Classes
- Classes
+ Classes
- Classes
+ Classes
- Classes
+ Classes
-
- content
-
-
-string
-
-
-
-
-
-
-
-
-
- note content - e.g. HTML text for text notes, file payload for files
-
-
-
-
isProtectedSource:
Source:
Source:
Source:
Source:
Source:
(async) getContent() → {Promise.<*>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<*>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
(async) getDescendantNoteIds() → {Promise.<Array.<string>>} Source:
Source:
Source:
Source:
(async) getJsonContent() → {Promise.<*>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<*>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
(async) getLabel(name) → {Promise.<Attribute >} Source:
Source:
Source:
Source:
Source:
Source:
(async) getNoteContent() → {Promise.<NoteContent >}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<NoteContent >
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
(async) getOwnedAttributes() → {Promise.<Array.<Attribute >>} Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
() → {boolean}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ true if the note has string content (not binary)
+
+
+
+
+
+
+ Type
+
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
(async) loadAttributesToCache() → {Promise.<void>} Source:
Source:
Source:
Source:
Source:
(async) setContent() → {Promise}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) setJsonContent() → {Promise}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
(async) setLabel(name, valueopt ) → {Promise.<void>} Source:
Source:
Source:
Source:
Source:
- Classes
+ Classes
JSDoc: Class: NoteContent
+
+
+
+
+
+
+
Class: NoteContent
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
(row)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ row
+
+
+
+
+
+
+
+ object containing database row from "note_contents" table
+
+
+
+
+
+
+
+
+
+
+
+
Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ noteContentId
+
+
+string
+
+
+
+
+
+
+
+
+
+ primary key
+
+
+
+
+
+
+ noteId
+
+
+string
+
+
+
+
+
+
+
+
+
+ reference to owning note
+
+
+
+
+
+
+ isProtected
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ true if note content is protected
+
+
+
+
+
+
+ content
+
+
+blob
+
+
+
+
+
+
+
+
+
+ note content - e.g. HTML text for text notes, file payload for files
+
+
+
+
+
+
+ dateCreated
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateModified
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extends
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (async) getNote() → {Promise.<Note >}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Note >
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
- Classes
+ Classes
- Classes
+ Classes
- Classes
+ Classes
- Classes
+ Classes
- Classes
+ Classes
- Classes
+ Classes
- Classes
+ Classes
- Classes
+ Classes
- Classes
+ Classes
JSDoc: Source: entities/note_content.js
+
+
+
+
+
+
+
Source: entities/note_content.js
+
+
+
+
+
+
+
+
+ "use strict";
+
+const Entity = require('./entity');
+const protectedSessionService = require('../services/protected_session');
+const repository = require('../services/repository');
+const dateUtils = require('../services/date_utils');
+
+/**
+ * This represents a Note which is a central object in the Trilium Notes project.
+ *
+ * @property {string} noteContentId - primary key
+ * @property {string} noteId - reference to owning note
+ * @property {boolean} isProtected - true if note content is protected
+ * @property {blob} content - note content - e.g. HTML text for text notes, file payload for files
+ * @property {string} dateCreated
+ * @property {string} dateModified
+ *
+ * @extends Entity
+ */
+class NoteContent extends Entity {
+ static get entityName() {
+ return "note_contents";
+ }
+
+ static get primaryKeyName() {
+ return "noteContentId";
+ }
+
+ static get hashedProperties() {
+ return ["noteContentId", "noteId", "isProtected", "content"];
+ }
+
+ /**
+ * @param row - object containing database row from "note_contents" table
+ */
+ constructor(row) {
+ super(row);
+
+ this.isProtected = !!this.isProtected;
+ /* true if content (meaning any kind of potentially encrypted content) is either not encrypted
+ * or encrypted, but with available protected session (so effectively decrypted) */
+ this.isContentAvailable = true;
+
+ // check if there's noteContentId, otherwise this is a new entity which wasn't encrypted yet
+ if (this.isProtected && this.noteContentId) {
+ this.isContentAvailable = protectedSessionService.isProtectedSessionAvailable();
+
+ if (this.isContentAvailable) {
+ protectedSessionService.decryptNoteContent(this);
+ }
+ else {
+ // saving ciphertexts in case we do want to update protected note outside of protected session
+ // (which is allowed)
+ this.contentCipherText = this.content;
+ this.content = "";
+ }
+ }
+ }
+
+ /**
+ * @returns {Promise<Note>}
+ */
+ async getNote() {
+ return await repository.getNote(this.noteId);
+ }
+
+ beforeSaving() {
+ if (!this.dateCreated) {
+ this.dateCreated = dateUtils.nowDate();
+ }
+
+ super.beforeSaving();
+
+ if (this.isChanged) {
+ this.dateModified = dateUtils.nowDate();
+ }
+ }
+
+ // cannot be static!
+ updatePojo(pojo) {
+ if (pojo.isProtected) {
+ if (this.isContentAvailable) {
+ protectedSessionService.encryptNoteContent(pojo);
+ }
+ else {
+ // updating protected note outside of protected session means we will keep original ciphertext
+ pojo.content = pojo.contentCipherText;
+ }
+ }
+
+ delete pojo.isContentAvailable;
+ delete pojo.contentCipherText;
+ }
+}
+
+module.exports = NoteContent;
+
+
+
+
+
+
+ Classes
+
+
+
- Classes
+ Classes
- Classes
+ Classes
- Classes
+ Classes
Source:
Source:
- Classes
+ Classes
- Classes
+ Classes
- Classes
+ Classes
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
Source:
() → {boolean}
+ This method checks whether user navigated away from the note from which the scripts has been started.
+This is necessary because script execution is async and by the time it is finished, the user might have
+already navigated away from this page - the end result would be that script might return data for the wrong
+note.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ returns true if the original note is still loaded, false if user switched to another
+
+
+
+
+
+
+ Type
+
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
(func) Source:
Source:
()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2196,7 +2389,7 @@ otherwise (by e.g. createNoteLink())
Source:
Source:
Source:
Source:
Source:
Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Source:
-
-
-
-
-
-
-
-
diff --git a/docs/frontend_api/entities_attribute.js.html b/docs/frontend_api/entities_attribute.js.html
index bdba252b1..1a6ed291d 100644
--- a/docs/frontend_api/entities_attribute.js.html
+++ b/docs/frontend_api/entities_attribute.js.html
@@ -59,7 +59,9 @@
get toString() {
return `Attribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name})`;
}
-}
+}
+
+export default Attribute;
diff --git a/docs/frontend_api/entities_note_full.js.html b/docs/frontend_api/entities_note_full.js.html
index e24275b4a..deeeab5f2 100644
--- a/docs/frontend_api/entities_note_full.js.html
+++ b/docs/frontend_api/entities_note_full.js.html
@@ -36,15 +36,13 @@ class NoteFull extends NoteShort {
super(treeCache, row);
/** @param {string} */
- this.content = row.content;
+ this.noteContent = row.noteContent;
- if (this.content !== "" && this.isJson()) {
- try {
- /** @param {object} */
- this.jsonContent = JSON.parse(this.content);
- }
- catch(e) {}
- }
+ /** @param {string} */
+ this.dateCreated = row.dateCreated;
+
+ /** @param {string} */
+ this.dateModified = row.dateModified;
}
}
diff --git a/docs/frontend_api/global.html b/docs/frontend_api/global.html
index a73e78e1b..643d96edf 100644
--- a/docs/frontend_api/global.html
+++ b/docs/frontend_api/global.html
@@ -303,7 +303,7 @@
Source: