import server from '../services/server.js'; import Attribute from './attribute.js'; import branches from "../services/branches.js"; const LABEL = 'label'; const LABEL_DEFINITION = 'label-definition'; const RELATION = 'relation'; const RELATION_DEFINITION = 'relation-definition'; /** * FIXME: rethink how attributes are cached in Note entities since they are long lived inside the cache. * Attribute cache should be limited to "transaction". * * This note's representation is used in note tree and is kept in TreeCache. */ class NoteShort { /** * @param {TreeCache} treeCache * @param {Object.} row * @param {Branch[]} branches - all relevant branches, i.e. where this note is either child or parent */ constructor(treeCache, row, branches) { this.treeCache = treeCache; /** @param {string} */ this.noteId = row.noteId; /** @param {string} */ this.title = row.title; /** @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.archived = row.archived; /** @param {string} */ this.cssClass = row.cssClass; /** @type {string[]} */ this.parents = []; /** @type {string[]} */ this.children = []; /** @type {Object.} */ this.parentToBranch = {}; /** @type {Object.} */ this.childToBranch = {}; for (const branch of branches) { if (this.noteId === branch.noteId) { this.parents.push(branch.parentNoteId); this.parentToBranch[branch.parentNoteId] = branch.branchId; } else if (this.noteId === branch.parentNoteId) { this.children.push(branch.noteId); this.childToBranch[branch.noteId] = branch.branchId; } else { throw new Error(`Unknown branch ${branch.branchId} for note ${this.noteId}`); } } } 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.branches[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 {Promise} */ async getBranches() { const branchIds = Object.values(this.parentToBranch); return this.treeCache.getBranches(branchIds); } /** @returns {boolean} */ hasChildren() { return this.children.length > 0; } /** @returns {Promise} */ async getChildBranches() { const branchIds = Object.values(this.childToBranch); return this.treeCache.getBranches(branchIds); } /** @returns {string[]} */ getParentNoteIds() { return this.parents; } /** @returns {Promise} */ async getParentNotes() { return await this.treeCache.getNotes(this.parents); } /** @returns {string[]} */ getChildNoteIds() { return this.children; } /** @returns {Promise} */ async getChildNotes() { return await this.treeCache.getNotes(this.children); } /** * @param {string} [name] - attribute name to filter * @returns {Promise} */ async getAttributes(name) { if (!this.attributeCache) { this.attributeCache = (await server.get('notes/' + this.noteId + '/attributes')) .map(attrRow => new Attribute(this.treeCache, attrRow)); } if (name) { return this.attributeCache.filter(attr => attr.name === name); } else { return this.attributeCache; } } /** * @param {string} [name] - label name to filter * @returns {Promise} all note's labels (attributes with type label), including inherited ones */ async getLabels(name) { return (await this.getAttributes(name)).filter(attr => attr.type === LABEL); } /** * @param {string} [name] - label name to filter * @returns {Promise} all note's label definitions, including inherited ones */ async getLabelDefinitions(name) { return (await this.getAttributes(name)).filter(attr => attr.type === LABEL_DEFINITION); } /** * @param {string} [name] - relation name to filter * @returns {Promise} all note's relations (attributes with type relation), including inherited ones */ async getRelations(name) { return (await this.getAttributes(name)).filter(attr => attr.type === RELATION); } /** * @param {string} [name] - relation name to filter * @returns {Promise} all note's relation definitions including inherited ones */ async getRelationDefinitions(name) { return (await this.getAttributes(name)).filter(attr => attr.type === RELATION_DEFINITION); } /** * @param {string} type - attribute type (label, relation, etc.) * @param {string} name - attribute name * @returns {Promise} true if note has an attribute with given type and name (including inherited) */ async hasAttribute(type, name) { return !!await this.getAttribute(type, name); } /** * @param {string} type - attribute type (label, relation, etc.) * @param {string} name - attribute name * @returns {Promise} 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. */ async getAttribute(type, name) { const attributes = await this.getAttributes(); return attributes.find(attr => attr.type === type && attr.name === name); } /** * @param {string} type - attribute type (label, relation, etc.) * @param {string} name - attribute name * @returns {Promise} attribute value of given type and name or null if no such attribute exists. */ async getAttributeValue(type, name) { const attr = await this.getAttribute(type, name); return attr ? attr.value : null; } /** * @param {string} name - label name * @returns {Promise} true if label exists (including inherited) */ async hasLabel(name) { return await this.hasAttribute(LABEL, name); } /** * @param {string} name - relation name * @returns {Promise} true if relation exists (including inherited) */ async hasRelation(name) { return await this.hasAttribute(RELATION, name); } /** * @param {string} name - label name * @returns {Promise} label if it exists, null otherwise */ async getLabel(name) { return await this.getAttribute(LABEL, name); } /** * @param {string} name - relation name * @returns {Promise} relation if it exists, null otherwise */ async getRelation(name) { return await this.getAttribute(RELATION, name); } /** * @param {string} name - label name * @returns {Promise} label value if label exists, null otherwise */ async getLabelValue(name) { return await this.getAttributeValue(LABEL, name); } /** * @param {string} name - relation name * @returns {Promise} relation value if relation exists, null otherwise */ async getRelationValue(name) { return await this.getAttributeValue(RELATION, name); } /** * @param {string} name * @returns {Promise|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} */ async getRelationTargets(name) { const relations = await 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 {Promise} */ async getTargetRelations() { return (await server.get('notes/' + this.noteId + '/target-relations')) .map(attrRow => new Attribute(this.treeCache, attrRow)); } get toString() { return `Note(noteId=${this.noteId}, title=${this.title})`; } get dto() { const dto = Object.assign({}, this); delete dto.treeCache; delete dto.archived; delete dto.attributeCache; return dto; } } export default NoteShort;