updated API docs

docs/frontend_api/entities_note_short.js.html

@@ -42,7 +42,9 @@ const NOTE_TYPE_ICONS = {
     "render": "bx bx-extension",
     "search": "bx bx-file-find",
     "relation-map": "bx bx-map-alt",
-    "book": "bx bx-book"
+    "book": "bx bx-book",
+    "note-map": "bx bx-map-alt",
+    "mermaid": "bx bx-selection"
 };
 
 /**
@@ -89,8 +91,6 @@ class NoteShort {
         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) {
@@ -252,7 +252,7 @@ class NoteShort {
 
             if (this.noteId !== 'root') {
                 for (const parentNote of this.getParentNotes()) {
-                    // these virtual parent-child relationships are also loaded into frontend tree cache
+                    // these virtual parent-child relationships are also loaded into froca
                     if (parentNote.type !== 'search') {
                         attrArrs.push(parentNote.__getInheritableAttributes(newPath));
                     }
@@ -282,6 +282,10 @@ class NoteShort {
         return noteAttributeCache.attributes[this.noteId];
     }
 
+    isRoot() {
+        return this.noted
+    }
+
     getAllNotePaths(encounteredNoteIds = null) {
         if (this.noteId === 'root') {
             return [['root']];
@@ -330,7 +334,8 @@ class NoteShort {
             notePath: path,
             isInHoistedSubTree: path.includes(hoistedNotePath),
             isArchived: path.find(noteId => froca.notes[noteId].hasLabel('archived')),
-            isSearch: path.find(noteId => froca.notes[noteId].type === 'search')
+            isSearch: path.find(noteId => froca.notes[noteId].type === 'search'),
+            isHidden: path.includes("hidden")
         }));
 
         notePaths.sort((a, b) => {
@@ -729,6 +734,55 @@ class NoteShort {
         const labels = this.getLabels('workspaceTabBackgroundColor');
         return labels.length > 0 ? labels[0].value : "";
     }
+
+    /** @returns {boolean} true if this note is JavaScript (code or attachment) */
+    isJavaScript() {
+        return (this.type === "code" || this.type === "file")
+            && (this.mime.startsWith("application/javascript")
+                || this.mime === "application/x-javascript"
+                || this.mime === "text/javascript");
+    }
+
+    /** @returns {boolean} true if this note is HTML */
+    isHtml() {
+        return (this.type === "code" || this.type === "file" || this.type === "render") && this.mime === "text/html";
+    }
+
+    /** @returns {string|null} JS script environment - either "frontend" or "backend" */
+    getScriptEnv() {
+        if (this.isHtml() || (this.isJavaScript() && this.mime.endsWith('env=frontend'))) {
+            return "frontend";
+        }
+
+        if (this.type === 'render') {
+            return "frontend";
+        }
+
+        if (this.isJavaScript() && this.mime.endsWith('env=backend')) {
+            return "backend";
+        }
+
+        return null;
+    }
+
+    async executeScript() {
+        if (!this.isJavaScript()) {
+            throw new Error(`Note ${this.noteId} is of type ${this.type} and mime ${this.mime} and thus cannot be executed`);
+        }
+
+        const env = this.getScriptEnv();
+
+        if (env === "frontend") {
+            const bundleService = (await import("../services/bundle.js")).default;
+            await bundleService.getAndExecuteBundle(this.noteId);
+        }
+        else if (env === "backend") {
+            await server.post('script/run/' + this.noteId);
+        }
+        else {
+            throw new Error(`Unrecognized env type ${env} for note ${this.noteId}`);
+        }
+    }
 }
 
 export default NoteShort;
@@ -742,13 +796,13 @@ export default NoteShort;
 </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>Global</h3><ul><li><a href="global.html#decorateWidget">decorateWidget</a></li><li><a href="global.html#doRenderBody">doRenderBody</a></li><li><a href="global.html#widgetCollapsedStateChangedEvent">widgetCollapsedStateChangedEvent</a></li></ul>
+    <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>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.6</a>
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.7</a>
 </footer>
 
 <script> prettyPrint(); </script>