@@ -985,7 +985,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/Attribute.html b/docs/backend_api/BAttribute.html
similarity index 72%
rename from docs/backend_api/Attribute.html
rename to docs/backend_api/BAttribute.html
index 6b9aa5ed8..8ae4ede4f 100644
--- a/docs/backend_api/Attribute.html
+++ b/docs/backend_api/BAttribute.html
@@ -2,7 +2,7 @@
- JSDoc: Class: Attribute
+ JSDoc: Class: BAttribute
@@ -17,7 +17,7 @@
-
Class: Attribute
+
Class: BAttribute
@@ -28,7 +28,7 @@
-
Attribute()
+
BAttribute()
Attribute is an abstract concept which has two real uses - label (key - value pair)
and relation (representing named relationship between source and target note)
@@ -46,7 +46,7 @@ and relation (representing named relationship between source and target note)new Attribute()
+
new BAttribute()
@@ -94,7 +94,7 @@ and relation (representing named relationship between source and target note)Source:
@@ -1898,7 +1898,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/Branch.html b/docs/backend_api/BBranch.html
similarity index 76%
rename from docs/backend_api/Branch.html
rename to docs/backend_api/BBranch.html
index bba99a3bc..7aea50f32 100644
--- a/docs/backend_api/Branch.html
+++ b/docs/backend_api/BBranch.html
@@ -2,7 +2,7 @@
- JSDoc: Class: Branch
+ JSDoc: Class: BBranch
@@ -17,7 +17,7 @@
-
Class: Branch
+
Class: BBranch
@@ -28,7 +28,7 @@
-
Branch()
+
BBranch()
Branch represents a relationship between a child note and its parent note. Trilium allows a note to have multiple
parents.
@@ -49,7 +49,7 @@ Always check noteId instead.
@@ -1907,7 +1907,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/EtapiToken.html b/docs/backend_api/BEtapiToken.html
similarity index 72%
rename from docs/backend_api/EtapiToken.html
rename to docs/backend_api/BEtapiToken.html
index 22cf9e2eb..3e9bcbe39 100644
--- a/docs/backend_api/EtapiToken.html
+++ b/docs/backend_api/BEtapiToken.html
@@ -2,7 +2,7 @@
- JSDoc: Class: EtapiToken
+ JSDoc: Class: BEtapiToken
@@ -17,7 +17,7 @@
-
Class: EtapiToken
+
Class: BEtapiToken
@@ -28,7 +28,7 @@
-
EtapiToken()
+
BEtapiToken()
EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications.
Used by:
@@ -51,7 +51,7 @@ from tokenHash and token.
@@ -1455,7 +1455,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/Note.html b/docs/backend_api/BNote.html
similarity index 86%
rename from docs/backend_api/Note.html
rename to docs/backend_api/BNote.html
index 763500c81..cc39f2216 100644
--- a/docs/backend_api/Note.html
+++ b/docs/backend_api/BNote.html
@@ -2,7 +2,7 @@
- JSDoc: Class: Note
+ JSDoc: Class: BNote
@@ -17,7 +17,7 @@
-
Class: Note
+
Class: BNote
@@ -28,7 +28,7 @@
-
Note()
+
BNote()
Trilium's main entity which can represent text note, image, code note, file attachment etc.
@@ -2168,7 +2168,7 @@ This is a low level method, for notes and branches use `note.deleteNote()` and '
diff --git a/docs/backend_api/Option.html b/docs/backend_api/BOption.html
similarity index 72%
rename from docs/backend_api/Option.html
rename to docs/backend_api/BOption.html
index 00e1e5f69..729982cb5 100644
--- a/docs/backend_api/Option.html
+++ b/docs/backend_api/BOption.html
@@ -2,7 +2,7 @@
- JSDoc: Class: Option
+ JSDoc: Class: BOption
@@ -17,7 +17,7 @@
-
Class: Option
+
Class: BOption
@@ -28,7 +28,7 @@
-
Option()
+
BOption()
Option represents name-value pair, either directly configurable by the user or some system property.
@@ -6929,7 +6947,7 @@ exists, then we'll use that transaction.
diff --git a/docs/backend_api/becca_entities_abstract_entity.js.html b/docs/backend_api/becca_entities_abstract_becca_entity.js.html
similarity index 88%
rename from docs/backend_api/becca_entities_abstract_entity.js.html
rename to docs/backend_api/becca_entities_abstract_becca_entity.js.html
index b30f61521..65f982723 100644
--- a/docs/backend_api/becca_entities_abstract_entity.js.html
+++ b/docs/backend_api/becca_entities_abstract_becca_entity.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: becca/entities/abstract_entity.js
+ JSDoc: Source: becca/entities/abstract_becca_entity.js
@@ -17,7 +17,7 @@
-
Source: becca/entities/abstract_entity.js
+
Source: becca/entities/abstract_becca_entity.js
@@ -41,7 +41,7 @@ let becca = null;
/**
* Base class for all backend entities.
*/
-class AbstractEntity {
+class AbstractBeccaEntity {
/** @protected */
beforeSaving() {
this.generateIdIfNecessary();
@@ -195,7 +195,7 @@ class AbstractEntity {
}
}
-module.exports = AbstractEntity;
+module.exports = AbstractBeccaEntity;
@@ -206,7 +206,7 @@ module.exports = AbstractEntity;
diff --git a/docs/backend_api/becca_entities_attribute.js.html b/docs/backend_api/becca_entities_battribute.js.html
similarity index 87%
rename from docs/backend_api/becca_entities_attribute.js.html
rename to docs/backend_api/becca_entities_battribute.js.html
index e2084c5ff..447c8fca3 100644
--- a/docs/backend_api/becca_entities_attribute.js.html
+++ b/docs/backend_api/becca_entities_battribute.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: becca/entities/attribute.js
+ JSDoc: Source: becca/entities/battribute.js
@@ -17,7 +17,7 @@
-
Source: becca/entities/attribute.js
+
Source: becca/entities/battribute.js
@@ -28,8 +28,8 @@
"use strict";
-const Note = require('./note');
-const AbstractEntity = require("./abstract_entity");
+const BNote = require('./bnote');
+const AbstractBeccaEntity = require("./abstract_becca_entity");
const sql = require("../../services/sql");
const dateUtils = require("../../services/date_utils");
const promotedAttributeDefinitionParser = require("../../services/promoted_attribute_definition_parser");
@@ -39,9 +39,9 @@ const {sanitizeAttributeName} = require("../../services/sanitize_attribute_name"
* Attribute is an abstract concept which has two real uses - label (key - value pair)
* and relation (representing named relationship between source and target note)
*
- * @extends AbstractEntity
+ * @extends AbstractBeccaEntity
*/
-class Attribute extends AbstractEntity {
+class BAttribute extends AbstractBeccaEntity {
static get entityName() { return "attributes"; }
static get primaryKeyName() { return "attributeId"; }
static get hashedProperties() { return ["attributeId", "noteId", "type", "name", "value", "isInheritable"]; }
@@ -98,7 +98,7 @@ class Attribute extends AbstractEntity {
if (!(this.noteId in this.becca.notes)) {
// entities can come out of order in sync, create skeleton which will be filled later
- this.becca.addNote(this.noteId, new Note({noteId: this.noteId}));
+ this.becca.addNote(this.noteId, new BNote({noteId: this.noteId}));
}
this.becca.notes[this.noteId].ownedAttributes.push(this);
@@ -152,7 +152,7 @@ class Attribute extends AbstractEntity {
}
/**
- * @returns {Note|null}
+ * @returns {BNote|null}
*/
getNote() {
const note = this.becca.getNote(this.noteId);
@@ -165,7 +165,7 @@ class Attribute extends AbstractEntity {
}
/**
- * @returns {Note|null}
+ * @returns {BNote|null}
*/
getTargetNote() {
if (this.type !== 'relation') {
@@ -245,7 +245,7 @@ class Attribute extends AbstractEntity {
}
createClone(type, name, value, isInheritable) {
- return new Attribute({
+ return new BAttribute({
noteId: this.noteId,
type: type,
name: name,
@@ -257,7 +257,7 @@ class Attribute extends AbstractEntity {
}
}
-module.exports = Attribute;
+module.exports = BAttribute;
@@ -268,7 +268,7 @@ module.exports = Attribute;
diff --git a/docs/backend_api/becca_entities_branch.js.html b/docs/backend_api/becca_entities_bbranch.js.html
similarity index 88%
rename from docs/backend_api/becca_entities_branch.js.html
rename to docs/backend_api/becca_entities_bbranch.js.html
index e914ea3ad..516a40431 100644
--- a/docs/backend_api/becca_entities_branch.js.html
+++ b/docs/backend_api/becca_entities_bbranch.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: becca/entities/branch.js
+ JSDoc: Source: becca/entities/bbranch.js
@@ -17,7 +17,7 @@
-
Source: becca/entities/branch.js
+
Source: becca/entities/bbranch.js
@@ -28,8 +28,8 @@
"use strict";
-const Note = require('./note');
-const AbstractEntity = require("./abstract_entity");
+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");
@@ -43,9 +43,9 @@ const log = require("../../services/log");
* 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 AbstractEntity
+ * @extends AbstractBeccaEntity
*/
-class Branch extends AbstractEntity {
+class BBranch extends AbstractBeccaEntity {
static get entityName() { return "branches"; }
static get primaryKeyName() { return "branchId"; }
// notePosition is not part of hash because it would produce a lot of updates in case of reordering
@@ -121,11 +121,11 @@ class Branch extends AbstractEntity {
}
}
- /** @returns {Note} */
+ /** @returns {BNote} */
get childNote() {
if (!(this.noteId in this.becca.notes)) {
// entities can come out of order in sync/import, create skeleton which will be filled later
- this.becca.addNote(this.noteId, new Note({noteId: this.noteId}));
+ this.becca.addNote(this.noteId, new BNote({noteId: this.noteId}));
}
return this.becca.notes[this.noteId];
@@ -135,11 +135,11 @@ class Branch extends AbstractEntity {
return this.childNote;
}
- /** @returns {Note|undefined} - root branch will have undefined parent, all other branches have to have a parent note */
+ /** @returns {BNote|undefined} - root branch will have undefined parent, all other branches have to have a parent note */
get parentNote() {
if (!(this.parentNoteId in this.becca.notes) && this.parentNoteId !== 'none') {
// entities can come out of order in sync/import, create skeleton which will be filled later
- this.becca.addNote(this.parentNoteId, new Note({noteId: this.parentNoteId}));
+ this.becca.addNote(this.parentNoteId, new BNote({noteId: this.parentNoteId}));
}
return this.becca.notes[this.parentNoteId];
@@ -291,7 +291,7 @@ class Branch extends AbstractEntity {
existingBranch.notePosition = notePosition;
return existingBranch;
} else {
- return new Branch({
+ return new BBranch({
noteId: this.noteId,
parentNoteId: parentNoteId,
notePosition: notePosition,
@@ -302,7 +302,7 @@ class Branch extends AbstractEntity {
}
}
-module.exports = Branch;
+module.exports = BBranch;
@@ -313,7 +313,7 @@ module.exports = Branch;
diff --git a/docs/backend_api/becca_entities_etapi_token.js.html b/docs/backend_api/becca_entities_betapi_token.js.html
similarity index 78%
rename from docs/backend_api/becca_entities_etapi_token.js.html
rename to docs/backend_api/becca_entities_betapi_token.js.html
index 064d6494b..78682c44c 100644
--- a/docs/backend_api/becca_entities_etapi_token.js.html
+++ b/docs/backend_api/becca_entities_betapi_token.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: becca/entities/etapi_token.js
+ JSDoc: Source: becca/entities/betapi_token.js
@@ -17,7 +17,7 @@
-
Source: becca/entities/etapi_token.js
+
Source: becca/entities/betapi_token.js
@@ -29,7 +29,7 @@
"use strict";
const dateUtils = require('../../services/date_utils');
-const AbstractEntity = require("./abstract_entity");
+const AbstractBeccaEntity = require("./abstract_becca_entity");
/**
* EtapiToken is an entity representing token used to authenticate against Trilium REST API from client applications.
@@ -40,9 +40,9 @@ const AbstractEntity = require("./abstract_entity");
* The format user is presented with is "<etapiTokenId>_<tokenHash>". This is also called "authToken" to distinguish it
* from tokenHash and token.
*
- * @extends AbstractEntity
+ * @extends AbstractBeccaEntity
*/
-class EtapiToken extends AbstractEntity {
+class BEtapiToken extends AbstractBeccaEntity {
static get entityName() { return "etapi_tokens"; }
static get primaryKeyName() { return "etapiTokenId"; }
static get hashedProperties() { return ["etapiTokenId", "name", "tokenHash", "utcDateCreated", "utcDateModified", "isDeleted"]; }
@@ -103,7 +103,7 @@ class EtapiToken extends AbstractEntity {
}
}
-module.exports = EtapiToken;
+module.exports = BEtapiToken;
@@ -114,7 +114,7 @@ module.exports = EtapiToken;
diff --git a/docs/backend_api/becca_entities_note.js.html b/docs/backend_api/becca_entities_bnote.js.html
similarity index 96%
rename from docs/backend_api/becca_entities_note.js.html
rename to docs/backend_api/becca_entities_bnote.js.html
index 0a5e86b0c..2e481ccf6 100644
--- a/docs/backend_api/becca_entities_note.js.html
+++ b/docs/backend_api/becca_entities_bnote.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: becca/entities/note.js
+ JSDoc: Source: becca/entities/bnote.js
@@ -17,7 +17,7 @@
-
Source: becca/entities/note.js
+
Source: becca/entities/bnote.js
@@ -34,8 +34,8 @@ const sql = require('../../services/sql');
const utils = require('../../services/utils');
const dateUtils = require('../../services/date_utils');
const entityChangesService = require('../../services/entity_changes');
-const AbstractEntity = require("./abstract_entity");
-const NoteRevision = require("./note_revision");
+const AbstractBeccaEntity = require("./abstract_becca_entity");
+const BNoteRevision = require("./bnote_revision");
const TaskContext = require("../../services/task_context");
const dayjs = require("dayjs");
const utc = require('dayjs/plugin/utc');
@@ -47,9 +47,9 @@ const RELATION = 'relation';
/**
* Trilium's main entity which can represent text note, image, code note, file attachment etc.
*
- * @extends AbstractEntity
+ * @extends AbstractBeccaEntity
*/
-class Note extends AbstractEntity {
+class BNote extends AbstractBeccaEntity {
static get entityName() { return "notes"; }
static get primaryKeyName() { return "noteId"; }
static get hashedProperties() { return ["noteId", "title", "isProtected", "type", "mime"]; }
@@ -120,10 +120,10 @@ class Note extends AbstractEntity {
/** @type {Branch[]}
* @private */
this.parentBranches = [];
- /** @type {Note[]}
+ /** @type {BNote[]}
* @private */
this.parents = [];
- /** @type {Note[]}
+ /** @type {BNote[]}
* @private*/
this.children = [];
/** @type {Attribute[]}
@@ -143,7 +143,7 @@ class Note extends AbstractEntity {
this.becca.addNote(this.noteId, this);
- /** @type {Note[]|null}
+ /** @type {BNote[]|null}
* @private */
this.ancestorCache = null;
@@ -201,12 +201,12 @@ class Note extends AbstractEntity {
return this.parentBranches;
}
- /** @returns {Note[]} */
+ /** @returns {BNote[]} */
getParentNotes() {
return this.parents;
}
- /** @returns {Note[]} */
+ /** @returns {BNote[]} */
getChildNotes() {
return this.children;
}
@@ -860,7 +860,7 @@ class Note extends AbstractEntity {
return !!this.targetRelations.find(rel => rel.name === 'template');
}
- /** @returns {Note[]} */
+ /** @returns {BNote[]} */
getSubtreeNotesIncludingTemplated() {
const set = new Set();
@@ -891,7 +891,7 @@ class Note extends AbstractEntity {
return Array.from(set);
}
- /** @return {Note[]} */
+ /** @return {BNote[]} */
getSearchResultNotes() {
if (this.type !== 'search') {
return [];
@@ -913,7 +913,7 @@ class Note extends AbstractEntity {
}
/**
- * @returns {{notes: Note[], relationships: Array.<{parentNoteId: string, childNoteId: string}>}}
+ * @returns {{notes: BNote[], relationships: Array.<{parentNoteId: string, childNoteId: string}>}}
*/
getSubtree({includeArchived = true, includeHidden = false, resolveSearch = false} = {}) {
const noteSet = new Set();
@@ -1033,7 +1033,7 @@ class Note extends AbstractEntity {
return this.getAttributes().length;
}
- /** @returns {Note[]} */
+ /** @returns {BNote[]} */
getAncestors() {
if (!this.ancestorCache) {
const noteIds = new Set();
@@ -1078,7 +1078,7 @@ class Note extends AbstractEntity {
return this.targetRelations;
}
- /** @returns {Note[]} - returns only notes which are templated, does not include their subtrees
+ /** @returns {BNote[]} - returns only notes which are templated, does not include their subtrees
* in effect returns notes which are influenced by note's non-inheritable attributes */
getTemplatedNotes() {
const arr = [this];
@@ -1112,7 +1112,7 @@ class Note extends AbstractEntity {
getNoteRevisions() {
return sql.getRows("SELECT * FROM note_revisions WHERE noteId = ?", [this.noteId])
- .map(row => new NoteRevision(row));
+ .map(row => new BNoteRevision(row));
}
/**
@@ -1165,9 +1165,9 @@ class Note extends AbstractEntity {
}
}
else {
- const Attribute = require("./attribute");
+ const BAttribute = require("./battribute");
- new Attribute({
+ new BAttribute({
noteId: this.noteId,
type: type,
name: name,
@@ -1205,7 +1205,7 @@ class Note extends AbstractEntity {
* @return {Attribute}
*/
addAttribute(type, name, value = "", isInheritable = false, position = 1000) {
- const Attribute = require("./attribute");
+ const BAttribute = require("./battribute");
return new Attribute({
noteId: this.noteId,
@@ -1387,7 +1387,7 @@ class Note extends AbstractEntity {
}
/**
- * @return {NoteRevision|null}
+ * @return {BNoteRevision|null}
*/
saveNoteRevision() {
const content = this.getContent();
@@ -1398,7 +1398,7 @@ class Note extends AbstractEntity {
const contentMetadata = this.getContentMetadata();
- const noteRevision = new NoteRevision({
+ const noteRevision = new BNoteRevision({
noteId: this.noteId,
// title and text should be decrypted now
title: this.title,
@@ -1462,7 +1462,7 @@ class Note extends AbstractEntity {
}
}
-module.exports = Note;
+module.exports = BNote;
@@ -1473,7 +1473,7 @@ module.exports = Note;
diff --git a/docs/backend_api/becca_entities_note_revision.js.html b/docs/backend_api/becca_entities_bnote_revision.js.html
similarity index 90%
rename from docs/backend_api/becca_entities_note_revision.js.html
rename to docs/backend_api/becca_entities_bnote_revision.js.html
index 701317705..134307c84 100644
--- a/docs/backend_api/becca_entities_note_revision.js.html
+++ b/docs/backend_api/becca_entities_bnote_revision.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: becca/entities/note_revision.js
+ JSDoc: Source: becca/entities/bnote_revision.js
@@ -17,7 +17,7 @@
-
Source: becca/entities/note_revision.js
+
Source: becca/entities/bnote_revision.js
@@ -34,15 +34,15 @@ const sql = require('../../services/sql');
const dateUtils = require('../../services/date_utils');
const becca = require('../becca');
const entityChangesService = require('../../services/entity_changes');
-const AbstractEntity = require("./abstract_entity");
+const AbstractBeccaEntity = require("./abstract_becca_entity");
/**
* NoteRevision represents snapshot of note's title and content at some point in the past.
* It's used for seamless note versioning.
*
- * @extends AbstractEntity
+ * @extends AbstractBeccaEntity
*/
-class NoteRevision extends AbstractEntity {
+class BNoteRevision extends AbstractBeccaEntity {
static get entityName() { return "note_revisions"; }
static get primaryKeyName() { return "noteRevisionId"; }
static get hashedProperties() { return ["noteRevisionId", "noteId", "title", "isProtected", "dateLastEdited", "dateCreated", "utcDateLastEdited", "utcDateCreated", "utcDateModified"]; }
@@ -218,7 +218,7 @@ class NoteRevision extends AbstractEntity {
}
}
-module.exports = NoteRevision;
+module.exports = BNoteRevision;
@@ -229,7 +229,7 @@ module.exports = NoteRevision;
diff --git a/docs/backend_api/becca_entities_option.js.html b/docs/backend_api/becca_entities_boption.js.html
similarity index 72%
rename from docs/backend_api/becca_entities_option.js.html
rename to docs/backend_api/becca_entities_boption.js.html
index f63984cec..3a35c6105 100644
--- a/docs/backend_api/becca_entities_option.js.html
+++ b/docs/backend_api/becca_entities_boption.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: becca/entities/option.js
+ JSDoc: Source: becca/entities/boption.js
@@ -17,7 +17,7 @@
-
Source: becca/entities/option.js
+
Source: becca/entities/boption.js
@@ -29,14 +29,14 @@
"use strict";
const dateUtils = require('../../services/date_utils');
-const AbstractEntity = require("./abstract_entity");
+const AbstractBeccaEntity = require("./abstract_becca_entity");
/**
* Option represents name-value pair, either directly configurable by the user or some system property.
*
- * @extends AbstractEntity
+ * @extends AbstractBeccaEntity
*/
-class Option extends AbstractEntity {
+class BOption extends AbstractBeccaEntity {
static get entityName() { return "options"; }
static get primaryKeyName() { return "name"; }
static get hashedProperties() { return ["name", "value"]; }
@@ -72,7 +72,7 @@ class Option extends AbstractEntity {
}
}
-module.exports = Option;
+module.exports = BOption;
@@ -83,7 +83,7 @@ module.exports = Option;
diff --git a/docs/backend_api/becca_entities_recent_note.js.html b/docs/backend_api/becca_entities_brecent_note.js.html
similarity index 67%
rename from docs/backend_api/becca_entities_recent_note.js.html
rename to docs/backend_api/becca_entities_brecent_note.js.html
index 5d6268cb2..359c20669 100644
--- a/docs/backend_api/becca_entities_recent_note.js.html
+++ b/docs/backend_api/becca_entities_brecent_note.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: becca/entities/recent_note.js
+ JSDoc: Source: becca/entities/brecent_note.js
@@ -17,7 +17,7 @@
diff --git a/docs/backend_api/global.html b/docs/backend_api/global.html
index 0cba37b8c..099cb2d0b 100644
--- a/docs/backend_api/global.html
+++ b/docs/backend_api/global.html
@@ -1711,7 +1711,7 @@
diff --git a/docs/backend_api/index.html b/docs/backend_api/index.html
index afc8c4960..7171d3635 100644
--- a/docs/backend_api/index.html
+++ b/docs/backend_api/index.html
@@ -50,7 +50,7 @@
diff --git a/docs/backend_api/module-sql.html b/docs/backend_api/module-sql.html
index 58ca58289..1716e1a65 100644
--- a/docs/backend_api/module-sql.html
+++ b/docs/backend_api/module-sql.html
@@ -1294,7 +1294,7 @@
diff --git a/docs/backend_api/services_backend_script_api.js.html b/docs/backend_api/services_backend_script_api.js.html
index eb02c31b5..9be900162 100644
--- a/docs/backend_api/services_backend_script_api.js.html
+++ b/docs/backend_api/services_backend_script_api.js.html
@@ -55,9 +55,9 @@ const exportService = require("./export/zip");
* @hideconstructor
*/
function BackendScriptApi(currentNote, apiParams) {
- /** @property {Note} note where script started executing */
+ /** @property {BNote} note where script started executing */
this.startNote = apiParams.startNote;
- /** @property {Note} note where script is currently executing. Don't mix this up with concept of active note */
+ /** @property {BNote} note where script is currently executing. Don't mix this up with concept of active note */
this.currentNote = currentNote;
/** @property {Entity} entity whose event triggered this executions */
this.originEntity = apiParams.originEntity;
@@ -89,7 +89,7 @@ function BackendScriptApi(currentNote, apiParams) {
/**
* @method
* @param {string} noteId
- * @returns {Note|null}
+ * @returns {BNote|null}
*/
this.getNote = noteId => becca.getNote(noteId);
@@ -114,7 +114,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @method
* @param {string} query
* @param {Object} [searchParams]
- * @returns {Note[]}
+ * @returns {BNote[]}
*/
this.searchForNotes = (query, searchParams = {}) => {
if (searchParams.includeArchivedNotes === undefined) {
@@ -138,7 +138,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @method
* @param {string} query
* @param {Object} [searchParams]
- * @returns {Note|null}
+ * @returns {BNote|null}
*/
this.searchForNote = (query, searchParams = {}) => {
const notes = this.searchForNotes(query, searchParams);
@@ -152,7 +152,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @method
* @param {string} name - attribute name
* @param {string} [value] - attribute value
- * @returns {Note[]}
+ * @returns {BNote[]}
*/
this.getNotesWithLabel = attributeService.getNotesWithLabel;
@@ -162,7 +162,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @method
* @param {string} name - attribute name
* @param {string} [value] - attribute value
- * @returns {Note|null}
+ * @returns {BNote|null}
*/
this.getNoteWithLabel = attributeService.getNoteWithLabel;
@@ -212,7 +212,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @param {string} parentNoteId
* @param {string} title
* @param {string} content
- * @return {{note: Note, branch: Branch}} - object having "note" and "branch" keys representing respective objects
+ * @return {{note: BNote, branch: Branch}} - object having "note" and "branch" keys representing respective objects
*/
this.createTextNote = (parentNoteId, title, content = '') => noteService.createNewNote({
parentNoteId,
@@ -228,7 +228,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @param {string} parentNoteId
* @param {string} title
* @param {object} content
- * @return {{note: Note, branch: Branch}} object having "note" and "branch" keys representing respective objects
+ * @return {{note: BNote, branch: Branch}} object having "note" and "branch" keys representing respective objects
*/
this.createDataNote = (parentNoteId, title, content = {}) => noteService.createNewNote({
parentNoteId,
@@ -255,7 +255,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @method
*
* @param {CreateNewNoteParams} [params]
- * @returns {{note: Note, branch: Branch}} object contains newly created entities note and branch
+ * @returns {{note: BNote, branch: Branch}} object contains newly created entities note and branch
*/
this.createNewNote = noteService.createNewNote;
@@ -283,7 +283,7 @@ function BackendScriptApi(currentNote, apiParams) {
* @param {string} title
* @param {string} [content=""]
* @param {CreateNoteExtraOptions} [extraOptions={}]
- * @returns {{note: Note, branch: Branch}} object contains newly created entities note and branch
+ * @returns {{note: BNote, branch: Branch}} object contains newly created entities note and branch
*/
this.createNote = (parentNoteId, title, content = "", extraOptions= {}) => {
extraOptions.parentNoteId = parentNoteId;
@@ -354,7 +354,7 @@ function BackendScriptApi(currentNote, apiParams) {
* Returns root note of the calendar.
*
* @method
- * @returns {Note|null}
+ * @returns {BNote|null}
*/
this.getRootCalendarNote = dateNoteService.getRootCalendarNote;
@@ -363,8 +363,8 @@ function BackendScriptApi(currentNote, apiParams) {
*
* @method
* @param {string} date in YYYY-MM-DD format
- * @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar
- * @returns {Note|null}
+ * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
+ * @returns {BNote|null}
* @deprecated use getDayNote instead
*/
this.getDateNote = dateNoteService.getDayNote;
@@ -374,8 +374,8 @@ function BackendScriptApi(currentNote, apiParams) {
*
* @method
* @param {string} date in YYYY-MM-DD format
- * @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar
- * @returns {Note|null}
+ * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
+ * @returns {BNote|null}
*/
this.getDayNote = dateNoteService.getDayNote;
@@ -383,8 +383,8 @@ function BackendScriptApi(currentNote, apiParams) {
* Returns today's day note. If such note doesn't exist, it is created.
*
* @method
- * @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar
- * @returns {Note|null}
+ * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
+ * @returns {BNote|null}
*/
this.getTodayNote = dateNoteService.getTodayNote;
@@ -394,8 +394,8 @@ function BackendScriptApi(currentNote, apiParams) {
* @method
* @param {string} date in YYYY-MM-DD format
* @param {object} [options] - "startOfTheWeek" - either "monday" (default) or "sunday"
- * @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar
- * @returns {Note|null}
+ * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
+ * @returns {BNote|null}
*/
this.getWeekNote = dateNoteService.getWeekNote;
@@ -404,8 +404,8 @@ function BackendScriptApi(currentNote, apiParams) {
*
* @method
* @param {string} date in YYYY-MM format
- * @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar
- * @returns {Note|null}
+ * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
+ * @returns {BNote|null}
*/
this.getMonthNote = dateNoteService.getMonthNote;
@@ -414,8 +414,8 @@ function BackendScriptApi(currentNote, apiParams) {
*
* @method
* @param {string} year in YYYY format
- * @param {Note} [rootNote] - specify calendar root note, normally leave empty to use default calendar
- * @returns {Note|null}
+ * @param {BNote} [rootNote] - specify calendar root note, normally leave empty to use default calendar
+ * @returns {BNote|null}
*/
this.getYearNote = dateNoteService.getYearNote;
@@ -596,8 +596,9 @@ function BackendScriptApi(currentNote, apiParams) {
* @param {string} noteId
* @param {string} format - either 'html' or 'markdown'
* @param {string} zipFilePath
+ * @returns {Promise}
*/
- this.exportSubtreeToZipFile = (noteId, format, zipFilePath) => exportService.exportToZipFile(noteId, format, zipFilePath);
+ this.exportSubtreeToZipFile = async (noteId, format, zipFilePath) => await exportService.exportToZipFile(noteId, format, zipFilePath);
/**
* This object contains "at your risk" and "no BC guarantees" objects for advanced use cases.
@@ -620,7 +621,7 @@ module.exports = BackendScriptApi;
diff --git a/docs/backend_api/services_sql.js.html b/docs/backend_api/services_sql.js.html
index 91b2d3863..66ec0b8fc 100644
--- a/docs/backend_api/services_sql.js.html
+++ b/docs/backend_api/services_sql.js.html
@@ -404,7 +404,7 @@ module.exports = {
diff --git a/docs/frontend_api/Attribute.html b/docs/frontend_api/FAttribute.html
similarity index 73%
rename from docs/frontend_api/Attribute.html
rename to docs/frontend_api/FAttribute.html
index 2f337a101..5a1ca75a2 100644
--- a/docs/frontend_api/Attribute.html
+++ b/docs/frontend_api/FAttribute.html
@@ -2,7 +2,7 @@
- JSDoc: Class: Attribute
+ JSDoc: Class: FAttribute
@@ -17,7 +17,7 @@
-
Class: Attribute
+
Class: FAttribute
@@ -28,7 +28,7 @@
-
Attribute()
+
FAttribute()
Attribute is an abstract concept which has two real uses - label (key - value pair)
and relation (representing named relationship between source and target note)
@@ -46,7 +46,7 @@ and relation (representing named relationship between source and target note)new Attribute()
+
new FAttribute()
@@ -94,7 +94,7 @@ and relation (representing named relationship between source and target note)Source:
@@ -7263,7 +7257,7 @@ This note's representation is used in note tree and is kept in Froca.
diff --git a/docs/frontend_api/NoteComplement.html b/docs/frontend_api/FNoteComplement.html
similarity index 72%
rename from docs/frontend_api/NoteComplement.html
rename to docs/frontend_api/FNoteComplement.html
index 9238439ef..25eda287a 100644
--- a/docs/frontend_api/NoteComplement.html
+++ b/docs/frontend_api/FNoteComplement.html
@@ -2,7 +2,7 @@
- JSDoc: Class: NoteComplement
+ JSDoc: Class: FNoteComplement
@@ -17,7 +17,7 @@
-
Class: NoteComplement
+
Class: FNoteComplement
@@ -28,9 +28,9 @@
-
NoteComplement()
+
FNoteComplement()
-
Complements the NoteShort with the main note content and other extra attributes
+
Complements the FNote with the main note content and other extra attributes
@@ -8202,7 +8202,7 @@ Typical use case is when new note has been created, we should wait until it is s
diff --git a/docs/frontend_api/entities_attribute.js.html b/docs/frontend_api/entities_fattribute.js.html
similarity index 77%
rename from docs/frontend_api/entities_attribute.js.html
rename to docs/frontend_api/entities_fattribute.js.html
index 31db32461..389c5e918 100644
--- a/docs/frontend_api/entities_attribute.js.html
+++ b/docs/frontend_api/entities_fattribute.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: entities/attribute.js
+ JSDoc: Source: entities/fattribute.js
@@ -17,7 +17,7 @@
-
Source: entities/attribute.js
+
Source: entities/fattribute.js
@@ -32,7 +32,7 @@
* Attribute is an abstract concept which has two real uses - label (key - value pair)
* and relation (representing named relationship between source and target note)
*/
-class Attribute {
+class FAttribute {
constructor(froca, row) {
this.froca = froca;
@@ -56,12 +56,12 @@ class Attribute {
this.isInheritable = !!row.isInheritable;
}
- /** @returns {NoteShort} */
+ /** @returns {FNote} */
getNote() {
return this.froca.notes[this.noteId];
}
- /** @returns {Promise<NoteShort>} */
+ /** @returns {Promise<FNote>} */
async getTargetNote() {
const targetNoteId = this.targetNoteId;
@@ -70,7 +70,7 @@ class Attribute {
get targetNoteId() { // alias
if (this.type !== 'relation') {
- throw new Error(`Attribute ${this.attributeId} is not a relation`);
+ throw new Error(`FAttribute ${this.attributeId} is not a relation`);
}
return this.value;
@@ -81,7 +81,7 @@ class Attribute {
}
get toString() {
- return `Attribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name}, value=${this.value})`;
+ return `FAttribute(attributeId=${this.attributeId}, type=${this.type}, name=${this.name}, value=${this.value})`;
}
isDefinition() {
@@ -104,7 +104,7 @@ class Attribute {
}
}
-export default Attribute;
+export default FAttribute;
@@ -115,7 +115,7 @@ export default Attribute;
diff --git a/docs/frontend_api/entities_branch.js.html b/docs/frontend_api/entities_fbranch.js.html
similarity index 76%
rename from docs/frontend_api/entities_branch.js.html
rename to docs/frontend_api/entities_fbranch.js.html
index 49e04e632..01423c8c5 100644
--- a/docs/frontend_api/entities_branch.js.html
+++ b/docs/frontend_api/entities_fbranch.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: entities/branch.js
+ JSDoc: Source: entities/fbranch.js
@@ -17,7 +17,7 @@
diff --git a/docs/frontend_api/entities_note_short.js.html b/docs/frontend_api/entities_fnote.js.html
similarity index 91%
rename from docs/frontend_api/entities_note_short.js.html
rename to docs/frontend_api/entities_fnote.js.html
index 4e24579e6..a5cfbd7fe 100644
--- a/docs/frontend_api/entities_note_short.js.html
+++ b/docs/frontend_api/entities_fnote.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: entities/note_short.js
+ JSDoc: Source: entities/fnote.js
@@ -17,7 +17,7 @@
-
Source: entities/note_short.js
+
Source: entities/fnote.js
@@ -54,12 +54,7 @@ const NOTE_TYPE_ICONS = {
"contentWidget": "bx bxs-widget"
};
-/**
- * FIXME: since there's no "full note" anymore we can rename this to Note
- *
- * This note's representation is used in note tree and is kept in Froca.
- */
-class NoteShort {
+class FNote {
/**
* @param {Froca} froca
* @param {Object.<string, Object>} row
@@ -181,7 +176,7 @@ class NoteShort {
}
/**
- * @returns {Branch[]}
+ * @returns {FBranch[]}
*/
getParentBranches() {
const branchIds = Object.values(this.parentToBranch);
@@ -190,7 +185,7 @@ class NoteShort {
}
/**
- * @returns {Branch[]}
+ * @returns {FBranch[]}
* @deprecated use getParentBranches() instead
*/
getBranches() {
@@ -202,7 +197,7 @@ class NoteShort {
return this.children.length > 0;
}
- /** @returns {Branch[]} */
+ /** @returns {FBranch[]} */
getChildBranches() {
// don't use Object.values() to guarantee order
const branchIds = this.children.map(childNoteId => this.childToBranch[childNoteId]);
@@ -215,7 +210,7 @@ class NoteShort {
return this.parents;
}
- /** @returns {NoteShort[]} */
+ /** @returns {FNote[]} */
getParentNotes() {
return this.froca.getNotesFromCache(this.parents);
}
@@ -245,7 +240,7 @@ class NoteShort {
return this.children;
}
- /** @returns {Promise<NoteShort[]>} */
+ /** @returns {Promise<FNote[]>} */
async getChildNotes() {
return await this.froca.getNotes(this.children);
}
@@ -253,7 +248,7 @@ class NoteShort {
/**
* @param {string} [type] - (optional) attribute type to filter
* @param {string} [name] - (optional) attribute name to filter
- * @returns {Attribute[]} all note's attributes, including inherited ones
+ * @returns {FAttribute[]} all note's attributes, including inherited ones
*/
getOwnedAttributes(type, name) {
const attrs = this.attributes
@@ -266,7 +261,7 @@ class NoteShort {
/**
* @param {string} [type] - (optional) attribute type to filter
* @param {string} [name] - (optional) attribute name to filter
- * @returns {Attribute[]} all note's attributes, including inherited ones
+ * @returns {FAttribute[]} all note's attributes, including inherited ones
*/
getAttributes(type, name) {
return this.__filterAttrs(this.__getCachedAttributes([]), type, name);
@@ -427,7 +422,7 @@ class NoteShort {
/**
* @param {string} [name] - label name to filter
- * @returns {Attribute[]} all note's labels (attributes with type label), including inherited ones
+ * @returns {FAttribute[]} all note's labels (attributes with type label), including inherited ones
*/
getOwnedLabels(name) {
return this.getOwnedAttributes(LABEL, name);
@@ -435,7 +430,7 @@ class NoteShort {
/**
* @param {string} [name] - label name to filter
- * @returns {Attribute[]} all note's labels (attributes with type label), including inherited ones
+ * @returns {FAttribute[]} all note's labels (attributes with type label), including inherited ones
*/
getLabels(name) {
return this.getAttributes(LABEL, name);
@@ -508,7 +503,7 @@ class NoteShort {
/**
* @param {string} [name] - relation name to filter
- * @returns {Attribute[]} all note's relations (attributes with type relation), including inherited ones
+ * @returns {FAttribute[]} all note's relations (attributes with type relation), including inherited ones
*/
getOwnedRelations(name) {
return this.getOwnedAttributes(RELATION, name);
@@ -516,7 +511,7 @@ class NoteShort {
/**
* @param {string} [name] - relation name to filter
- * @returns {Attribute[]} all note's relations (attributes with type relation), including inherited ones
+ * @returns {FAttribute[]} all note's relations (attributes with type relation), including inherited ones
*/
getRelations(name) {
return this.getAttributes(RELATION, name);
@@ -543,7 +538,7 @@ class NoteShort {
/**
* @param {string} type - attribute type (label, relation, etc.)
* @param {string} name - attribute name
- * @returns {Attribute} attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
+ * @returns {FAttribute} attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
*/
getOwnedAttribute(type, name) {
const attributes = this.getOwnedAttributes(type, name);
@@ -554,7 +549,7 @@ class NoteShort {
/**
* @param {string} type - attribute type (label, relation, etc.)
* @param {string} name - attribute name
- * @returns {Attribute} attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
+ * @returns {FAttribute} attribute of given type and name. If there's more such attributes, first is returned. Returns null if there's no such attribute belonging to this note.
*/
getAttribute(type, name) {
const attributes = this.getAttributes(type, name);
@@ -610,25 +605,25 @@ class NoteShort {
/**
* @param {string} name - label name
- * @returns {Attribute} label if it exists, null otherwise
+ * @returns {FAttribute} label if it exists, null otherwise
*/
getOwnedLabel(name) { return this.getOwnedAttribute(LABEL, name); }
/**
* @param {string} name - label name
- * @returns {Attribute} label if it exists, null otherwise
+ * @returns {FAttribute} label if it exists, null otherwise
*/
getLabel(name) { return this.getAttribute(LABEL, name); }
/**
* @param {string} name - relation name
- * @returns {Attribute} relation if it exists, null otherwise
+ * @returns {FAttribute} relation if it exists, null otherwise
*/
getOwnedRelation(name) { return this.getOwnedAttribute(RELATION, name); }
/**
* @param {string} name - relation name
- * @returns {Attribute} relation if it exists, null otherwise
+ * @returns {FAttribute} relation if it exists, null otherwise
*/
getRelation(name) { return this.getAttribute(RELATION, name); }
@@ -658,7 +653,7 @@ class NoteShort {
/**
* @param {string} name
- * @returns {Promise<NoteShort>|null} target note of the relation or null (if target is empty or note was not found)
+ * @returns {Promise<FNote>|null} target note of the relation or null (if target is empty or note was not found)
*/
async getRelationTarget(name) {
const targets = await this.getRelationTargets(name);
@@ -668,7 +663,7 @@ class NoteShort {
/**
* @param {string} [name] - relation name to filter
- * @returns {Promise<NoteShort[]>}
+ * @returns {Promise<FNote[]>}
*/
async getRelationTargets(name) {
const relations = this.getRelations(name);
@@ -682,7 +677,7 @@ class NoteShort {
}
/**
- * @returns {NoteShort[]}
+ * @returns {FNote[]}
*/
getTemplateNotes() {
const relations = this.getRelations('template');
@@ -750,7 +745,7 @@ class NoteShort {
/**
* Get relations which target this note
*
- * @returns {Attribute[]}
+ * @returns {FAttribute[]}
*/
getTargetRelations() {
return this.targetRelations
@@ -760,7 +755,7 @@ class NoteShort {
/**
* Get relations which target this note
*
- * @returns {NoteShort[]}
+ * @returns {FNote[]}
*/
async getTargetRelationSourceNotes() {
const targetRelations = this.getTargetRelations();
@@ -771,7 +766,7 @@ class NoteShort {
/**
* Return note complement which is most importantly note's content
*
- * @return {Promise<NoteComplement>}
+ * @return {Promise<FNoteComplement>}
*/
async getNoteComplement() {
return await this.froca.getNoteComplement(this.noteId);
@@ -885,7 +880,7 @@ class NoteShort {
}
}
-export default NoteShort;
+export default FNote;
@@ -896,7 +891,7 @@ export default NoteShort;
diff --git a/docs/frontend_api/entities_note_complement.js.html b/docs/frontend_api/entities_fnote_complement.js.html
similarity index 74%
rename from docs/frontend_api/entities_note_complement.js.html
rename to docs/frontend_api/entities_fnote_complement.js.html
index a7b13f24a..6ed38dc95 100644
--- a/docs/frontend_api/entities_note_complement.js.html
+++ b/docs/frontend_api/entities_fnote_complement.js.html
@@ -2,7 +2,7 @@
- JSDoc: Source: entities/note_complement.js
+ JSDoc: Source: entities/fnote_complement.js
@@ -17,7 +17,7 @@
-
Source: entities/note_complement.js
+
Source: entities/fnote_complement.js
@@ -27,9 +27,9 @@
/**
- * Complements the NoteShort with the main note content and other extra attributes
+ * Complements the FNote with the main note content and other extra attributes
*/
-class NoteComplement {
+class FNoteComplement {
constructor(row) {
/** @type {string} */
this.noteId = row.noteId;
@@ -65,7 +65,7 @@ class NoteComplement {
}
}
-export default NoteComplement;
+export default FNoteComplement;
@@ -76,7 +76,7 @@ export default NoteComplement;
diff --git a/docs/frontend_api/global.html b/docs/frontend_api/global.html
index 657f703e2..d7ba46285 100644
--- a/docs/frontend_api/global.html
+++ b/docs/frontend_api/global.html
@@ -457,7 +457,7 @@
diff --git a/docs/frontend_api/index.html b/docs/frontend_api/index.html
index 55816361e..85abe287b 100644
--- a/docs/frontend_api/index.html
+++ b/docs/frontend_api/index.html
@@ -50,7 +50,7 @@
diff --git a/docs/frontend_api/module.exports.html b/docs/frontend_api/module.exports.html
index c743929ac..67fb32df4 100644
--- a/docs/frontend_api/module.exports.html
+++ b/docs/frontend_api/module.exports.html
@@ -155,7 +155,7 @@
diff --git a/docs/frontend_api/services_frontend_script_api.js.html b/docs/frontend_api/services_frontend_script_api.js.html
index 13673d085..d2c928a8d 100644
--- a/docs/frontend_api/services_frontend_script_api.js.html
+++ b/docs/frontend_api/services_frontend_script_api.js.html
@@ -236,7 +236,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
*
* @method
* @param {string} searchString
- * @returns {Promise<NoteShort[]>}
+ * @returns {Promise<FNote[]>}
*/
this.searchForNotes = async searchString => {
return await searchService.searchForNotes(searchString);
@@ -248,7 +248,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
*
* @method
* @param {string} searchString
- * @returns {Promise<NoteShort|null>}
+ * @returns {Promise<FNote|null>}
*/
this.searchForNote = async searchString => {
const notes = await this.searchForNotes(searchString);
@@ -260,7 +260,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* Returns note by given noteId. If note is missing from cache, it's loaded.
**
* @param {string} noteId
- * @return {Promise<NoteShort>}
+ * @return {Promise<FNote>}
*/
this.getNote = async noteId => await froca.getNote(noteId);
@@ -272,7 +272,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
*
* @param {string[]} noteIds
* @param {boolean} [silentNotFoundError] - don't report error if the note is not found
- * @return {Promise<NoteShort[]>}
+ * @return {Promise<FNote[]>}
*/
this.getNotes = async (noteIds, silentNotFoundError = false) => await froca.getNotes(noteIds, silentNotFoundError);
@@ -383,7 +383,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
/**
* @method
* @deprecated use getActiveContextNote() instead
- * @returns {NoteShort} active note (loaded into right pane)
+ * @returns {FNote} active note (loaded into right pane)
*/
this.getActiveTabNote = () => {
console.warn("api.getActiveTabNote() is deprecated, use getActiveContextNote() instead.");
@@ -393,7 +393,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
/**
* @method
- * @returns {NoteShort} active note (loaded into right pane)
+ * @returns {FNote} active note (loaded into right pane)
*/
this.getActiveContextNote = () => appContext.tabManager.getActiveContextNote();
@@ -499,7 +499,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
* Returns date-note for today. If it doesn't exist, it is automatically created.
*
* @method
- * @return {Promise<NoteShort>}
+ * @return {Promise<FNote>}
*/
this.getTodayNote = dateNotesService.getTodayNote;
@@ -508,7 +508,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
*
* @method
* @param {string} date - e.g. "2019-04-29"
- * @return {Promise<NoteShort>}
+ * @return {Promise<FNote>}
* @deprecated use getDayNote instead
*/
this.getDateNote = dateNotesService.getDayNote;
@@ -518,7 +518,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
*
* @method
* @param {string} date - e.g. "2019-04-29"
- * @return {Promise<NoteShort>}
+ * @return {Promise<FNote>}
*/
this.getDayNote = dateNotesService.getDayNote;
@@ -527,7 +527,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
*
* @method
* @param {string} date - e.g. "2019-04-29"
- * @return {Promise<NoteShort>}
+ * @return {Promise<FNote>}
*/
this.getWeekNote = dateNotesService.getWeekNote;
@@ -536,7 +536,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
*
* @method
* @param {string} month - e.g. "2019-04"
- * @return {Promise<NoteShort>}
+ * @return {Promise<FNote>}
*/
this.getMonthNote = dateNotesService.getMonthNote;
@@ -545,7 +545,7 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null, $contain
*
* @method
* @param {string} year - e.g. "2019"
- * @return {Promise<NoteShort>}
+ * @return {Promise<FNote>}
*/
this.getYearNote = dateNotesService.getYearNote;
@@ -639,7 +639,7 @@ export default FrontendScriptApi;
diff --git a/docs/frontend_api/widgets_collapsible_widget.js.html b/docs/frontend_api/widgets_collapsible_widget.js.html
index 7df84e660..94ae6982e 100644
--- a/docs/frontend_api/widgets_collapsible_widget.js.html
+++ b/docs/frontend_api/widgets_collapsible_widget.js.html
@@ -74,7 +74,7 @@ export default class CollapsibleWidget extends NoteContextAwareWidget {