mirror of
https://github.com/zadam/trilium.git
synced 2024-09-23 09:06:00 +08:00
506 lines
15 KiB
HTML
506 lines
15 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: Source: entities/note_short.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: entities/note_short.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article>
|
|
<pre class="prettyprint source linenums"><code>import server from '../services/server.js';
|
|
import Attribute from './attribute.js';
|
|
|
|
const LABEL = 'label';
|
|
const LABEL_DEFINITION = 'label-definition';
|
|
const RELATION = 'relation';
|
|
const RELATION_DEFINITION = 'relation-definition';
|
|
|
|
/**
|
|
* This note's representation is used in note tree and is kept in TreeCache.
|
|
*/
|
|
class NoteShort {
|
|
/**
|
|
* @param {TreeCache} treeCache
|
|
* @param {Object.<string, Object>} row
|
|
*/
|
|
constructor(treeCache, row) {
|
|
this.treeCache = treeCache;
|
|
|
|
/** @type {string[]} */
|
|
this.attributes = [];
|
|
|
|
/** @type {string[]} */
|
|
this.targetRelations = [];
|
|
|
|
/** @type {string[]} */
|
|
this.parents = [];
|
|
/** @type {string[]} */
|
|
this.children = [];
|
|
|
|
/** @type {Object.<string, string>} */
|
|
this.parentToBranch = {};
|
|
|
|
/** @type {Object.<string, string>} */
|
|
this.childToBranch = {};
|
|
|
|
this.update(row);
|
|
}
|
|
|
|
update(row) {
|
|
/** @param {string} */
|
|
this.noteId = row.noteId;
|
|
/** @param {string} */
|
|
this.title = row.title;
|
|
/** @param {int} */
|
|
this.contentLength = row.contentLength;
|
|
/** @param {boolean} */
|
|
this.isProtected = !!row.isProtected;
|
|
/** @param {string} one of 'text', 'code', 'file' or 'render' */
|
|
this.type = row.type;
|
|
/** @param {string} content-type, e.g. "application/json" */
|
|
this.mime = row.mime;
|
|
/** @param {boolean} */
|
|
this.isDeleted = row.isDeleted;
|
|
}
|
|
|
|
addParent(parentNoteId, branchId) {
|
|
if (!this.parents.includes(parentNoteId)) {
|
|
this.parents.push(parentNoteId);
|
|
}
|
|
|
|
this.parentToBranch[parentNoteId] = branchId;
|
|
}
|
|
|
|
addChild(childNoteId, branchId) {
|
|
if (!this.children.includes(childNoteId)) {
|
|
this.children.push(childNoteId);
|
|
}
|
|
|
|
this.childToBranch[childNoteId] = branchId;
|
|
|
|
const branchIdPos = {};
|
|
|
|
for (const branchId of Object.values(this.childToBranch)) {
|
|
branchIdPos[branchId] = this.treeCache.getBranch(branchId).notePosition;
|
|
}
|
|
|
|
this.children.sort((a, b) => branchIdPos[this.childToBranch[a]] < branchIdPos[this.childToBranch[b]] ? -1 : 1);
|
|
}
|
|
|
|
/** @returns {boolean} */
|
|
isJson() {
|
|
return this.mime === "application/json";
|
|
}
|
|
|
|
async getContent() {
|
|
// we're not caching content since these objects are in treeCache and as such pretty long lived
|
|
const note = await server.get("notes/" + this.noteId);
|
|
|
|
return note.content;
|
|
}
|
|
|
|
async getJsonContent() {
|
|
const content = await this.getContent();
|
|
|
|
try {
|
|
return JSON.parse(content);
|
|
}
|
|
catch (e) {
|
|
console.log(`Cannot parse content of note ${this.noteId}: `, e.message);
|
|
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/** @returns {string[]} */
|
|
getBranchIds() {
|
|
return Object.values(this.parentToBranch);
|
|
}
|
|
|
|
/** @returns {Branch[]} */
|
|
getBranches() {
|
|
const branchIds = Object.values(this.parentToBranch);
|
|
|
|
return this.treeCache.getBranches(branchIds);
|
|
}
|
|
|
|
/** @returns {boolean} */
|
|
hasChildren() {
|
|
return this.children.length > 0;
|
|
}
|
|
|
|
/** @returns {Branch[]} */
|
|
getChildBranches() {
|
|
// don't use Object.values() to guarantee order
|
|
const branchIds = this.children.map(childNoteId => this.childToBranch[childNoteId]);
|
|
|
|
return this.treeCache.getBranches(branchIds);
|
|
}
|
|
|
|
/** @returns {string[]} */
|
|
getParentNoteIds() {
|
|
return this.parents;
|
|
}
|
|
|
|
/** @returns {NoteShort[]} */
|
|
getParentNotes() {
|
|
return this.treeCache.getNotesFromCache(this.parents);
|
|
}
|
|
|
|
/** @returns {string[]} */
|
|
getChildNoteIds() {
|
|
return this.children;
|
|
}
|
|
|
|
/** @returns {Promise<NoteShort[]>} */
|
|
async getChildNotes() {
|
|
return await this.treeCache.getNotes(this.children);
|
|
}
|
|
|
|
/**
|
|
* @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
|
|
*/
|
|
getOwnedAttributes(type, name) {
|
|
const attrs = this.attributes
|
|
.map(attributeId => this.treeCache.attributes[attributeId])
|
|
.filter(attr => !!attr);
|
|
|
|
return this.__filterAttrs(attrs, type, name)
|
|
}
|
|
|
|
/**
|
|
* @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
|
|
*/
|
|
getAttributes(type, name) {
|
|
const ownedAttributes = this.getOwnedAttributes();
|
|
|
|
const attrArrs = [
|
|
ownedAttributes
|
|
];
|
|
|
|
for (const templateAttr of ownedAttributes.filter(oa => oa.type === 'relation' && oa.name === 'template')) {
|
|
const templateNote = this.treeCache.getNoteFromCache(templateAttr.value);
|
|
|
|
if (templateNote) {
|
|
attrArrs.push(templateNote.getAttributes());
|
|
}
|
|
}
|
|
|
|
if (this.noteId !== 'root') {
|
|
for (const parentNote of this.getParentNotes()) {
|
|
attrArrs.push(parentNote.getInheritableAttributes());
|
|
}
|
|
}
|
|
|
|
const attributes = attrArrs.flat();
|
|
|
|
return this.__filterAttrs(attributes, type, name);
|
|
}
|
|
|
|
__filterAttrs(attributes, type, name) {
|
|
if (type && name) {
|
|
return attributes.filter(attr => attr.type === type && attr.name === name);
|
|
} else if (type) {
|
|
return attributes.filter(attr => attr.type === type);
|
|
} else if (name) {
|
|
return attributes.filter(attr => attr.name === name);
|
|
} else {
|
|
return attributes;
|
|
}
|
|
}
|
|
|
|
getInheritableAttributes() {
|
|
const attrs = this.getAttributes();
|
|
|
|
return attrs.filter(attr => attr.isInheritable);
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - label name to filter
|
|
* @returns {Attribute[]} all note's labels (attributes with type label), including inherited ones
|
|
*/
|
|
getOwnedLabels(name) {
|
|
return this.getOwnedAttributes(LABEL, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - label name to filter
|
|
* @returns {Attribute[]} all note's labels (attributes with type label), including inherited ones
|
|
*/
|
|
getLabels(name) {
|
|
return this.getAttributes(LABEL, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - label name to filter
|
|
* @returns {Attribute[]} all note's label definitions, including inherited ones
|
|
*/
|
|
getLabelDefinitions(name) {
|
|
return this.getAttributes(LABEL_DEFINITION, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - relation name to filter
|
|
* @returns {Attribute[]} all note's relations (attributes with type relation), including inherited ones
|
|
*/
|
|
getOwnedRelations(name) {
|
|
return this.getOwnedAttributes(RELATION, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - relation name to filter
|
|
* @returns {Attribute[]} all note's relations (attributes with type relation), including inherited ones
|
|
*/
|
|
getRelations(name) {
|
|
return this.getAttributes(RELATION, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - relation name to filter
|
|
* @returns {Attribute[]} all note's relation definitions including inherited ones
|
|
*/
|
|
getRelationDefinitions(name) {
|
|
return this.getAttributes(RELATION_DEFINITION, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @returns {boolean} true if note has an attribute with given type and name (including inherited)
|
|
*/
|
|
hasAttribute(type, name) {
|
|
return !!this.getAttribute(type, name);
|
|
}
|
|
|
|
/**
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @returns {boolean} true if note has an attribute with given type and name (including inherited)
|
|
*/
|
|
hasOwnedAttribute(type, name) {
|
|
return !!this.getOwnedAttribute(type, name);
|
|
}
|
|
|
|
/**
|
|
* @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.
|
|
*/
|
|
getOwnedAttribute(type, name) {
|
|
const attributes = this.getOwnedAttributes(type, name);
|
|
|
|
return attributes.length > 0 ? attributes[0] : 0;
|
|
}
|
|
|
|
/**
|
|
* @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.
|
|
*/
|
|
getAttribute(type, name) {
|
|
const attributes = this.getAttributes(type, name);
|
|
|
|
return attributes.length > 0 ? attributes[0] : 0;
|
|
}
|
|
|
|
/**
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @returns {string} attribute value of given type and name or null if no such attribute exists.
|
|
*/
|
|
getOwnedAttributeValue(type, name) {
|
|
const attr = this.getOwnedAttribute(type, name);
|
|
|
|
return attr ? attr.value : null;
|
|
}
|
|
|
|
/**
|
|
* @param {string} type - attribute type (label, relation, etc.)
|
|
* @param {string} name - attribute name
|
|
* @returns {string} attribute value of given type and name or null if no such attribute exists.
|
|
*/
|
|
getAttributeValue(type, name) {
|
|
const attr = this.getAttribute(type, name);
|
|
|
|
return attr ? attr.value : null;
|
|
}
|
|
|
|
/**
|
|
* @param {string} name - label name
|
|
* @returns {boolean} true if label exists (excluding inherited)
|
|
*/
|
|
hasOwnedLabel(name) { return this.hasOwnedAttribute(LABEL, name); }
|
|
|
|
/**
|
|
* @param {string} name - label name
|
|
* @returns {boolean} true if label exists (including inherited)
|
|
*/
|
|
hasLabel(name) { return this.hasAttribute(LABEL, name); }
|
|
|
|
/**
|
|
* @param {string} name - relation name
|
|
* @returns {boolean} true if relation exists (excluding inherited)
|
|
*/
|
|
hasOwnedRelation(name) { return this.hasOwnedAttribute(RELATION, name); }
|
|
|
|
/**
|
|
* @param {string} name - relation name
|
|
* @returns {boolean} true if relation exists (including inherited)
|
|
*/
|
|
hasRelation(name) { return this.hasAttribute(RELATION, name); }
|
|
|
|
/**
|
|
* @param {string} name - label name
|
|
* @returns {Attribute} 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
|
|
*/
|
|
getLabel(name) { return this.getAttribute(LABEL, name); }
|
|
|
|
/**
|
|
* @param {string} name - relation name
|
|
* @returns {Attribute} 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
|
|
*/
|
|
getRelation(name) { return this.getAttribute(RELATION, name); }
|
|
|
|
/**
|
|
* @param {string} name - label name
|
|
* @returns {string} label value if label exists, null otherwise
|
|
*/
|
|
getOwnedLabelValue(name) { return this.getOwnedAttributeValue(LABEL, name); }
|
|
|
|
/**
|
|
* @param {string} name - label name
|
|
* @returns {string} label value if label exists, null otherwise
|
|
*/
|
|
getLabelValue(name) { return this.getAttributeValue(LABEL, name); }
|
|
|
|
/**
|
|
* @param {string} name - relation name
|
|
* @returns {string} relation value if relation exists, null otherwise
|
|
*/
|
|
getOwnedRelationValue(name) { return this.getOwnedAttributeValue(RELATION, name); }
|
|
|
|
/**
|
|
* @param {string} name - relation name
|
|
* @returns {string} relation value if relation exists, null otherwise
|
|
*/
|
|
getRelationValue(name) { return this.getAttributeValue(RELATION, name); }
|
|
|
|
/**
|
|
* @param {string} name
|
|
* @returns {Promise<NoteShort>|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);
|
|
|
|
return targets.length > 0 ? targets[0] : null;
|
|
}
|
|
|
|
/**
|
|
* @param {string} [name] - relation name to filter
|
|
* @returns {Promise<NoteShort[]>}
|
|
*/
|
|
async getRelationTargets(name) {
|
|
const relations = this.getRelations(name);
|
|
const targets = [];
|
|
|
|
for (const relation of relations) {
|
|
targets.push(await this.treeCache.getNote(relation.value));
|
|
}
|
|
|
|
return targets;
|
|
}
|
|
|
|
/**
|
|
* Clear note's attributes cache to force fresh reload for next attribute request.
|
|
* Cache is note instance scoped.
|
|
*/
|
|
invalidateAttributeCache() {
|
|
this.__attributeCache = null;
|
|
}
|
|
|
|
/**
|
|
* Get relations which target this note
|
|
*
|
|
* @returns {Attribute[]}
|
|
*/
|
|
getTargetRelations() {
|
|
return this.targetRelations
|
|
.map(attributeId => this.treeCache.attributes[attributeId]);
|
|
}
|
|
|
|
get toString() {
|
|
return `Note(noteId=${this.noteId}, title=${this.title})`;
|
|
}
|
|
|
|
get dto() {
|
|
const dto = Object.assign({}, this);
|
|
delete dto.treeCache;
|
|
|
|
return dto;
|
|
}
|
|
|
|
getCssClass() {
|
|
const labels = this.getLabels('cssClass');
|
|
return labels.map(l => l.value).join(' ');
|
|
}
|
|
}
|
|
|
|
export default NoteShort;</code></pre>
|
|
</article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><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><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.3</a>
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html>
|