diff --git a/.gitignore b/.gitignore
index fe971b317..a58d0910e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,4 +7,3 @@ yarn-error.log
config.ini
cert.key
cert.crt
-docs/
\ No newline at end of file
diff --git a/db/main_attributes.sql b/db/main_attributes.sql
index 7b52e9138..6bfcea15a 100644
--- a/db/main_attributes.sql
+++ b/db/main_attributes.sql
@@ -120,3 +120,16 @@ INSERT INTO attributes VALUES('5jvvr6TdRT6Z','1s6SGhByxkoU','relation','template
INSERT INTO attributes VALUES('R2885tNvHcoL','0QeaWUvZYuB9','label','task','',1,'2018-08-28T21:17:27.858Z','2018-08-28T21:17:31.743Z',1,'zDcAk9LKIE',0);
INSERT INTO attributes VALUES('DPug2JTxd7ED','0QeaWUvZYuB9','relation','template','HbtlYiMvmm4V',2,'2018-08-28T21:17:27.868Z','2018-08-28T21:17:31.744Z',1,'lkhxPGwxq0',0);
INSERT INTO attributes VALUES('82OrS7QREaBM','3RkyK9LI18dO','label','calendarRoot','',0,'2018-08-28T21:18:18.512Z','2018-08-28T21:18:18.512Z',0,'1Mw7vhXyk1',0);
+INSERT INTO attributes VALUES('J4vAdbL9o5M2','3RkyK9LI18dO','label','child:sorted','',2,'2018-08-29T10:51:55.205Z','2018-08-29T10:51:55.205Z',0,'6iLHLIFy96',0);
+INSERT INTO attributes VALUES('eZeOn45UgWa6','3RkyK9LI18dO','label','sorted','',1,'2018-08-29T10:51:55.212Z','2018-08-29T10:51:55.212Z',0,'GeXw6I7toO',0);
+INSERT INTO attributes VALUES('GTGfj3qmMoSC','3RkyK9LI18dO','label','child:sorted:sorted','',3,'2018-08-29T10:51:55.220Z','2018-08-29T10:51:55.220Z',0,'8gxZmnY60b',0);
+INSERT INTO attributes VALUES('kPk6wY2as8Il','HJusZTbBU494','label','sorted','',0,'2018-08-29T10:52:08.238Z','2018-08-29T10:52:08.238Z',0,'m+y/Oxpq6f',0);
+INSERT INTO attributes VALUES('ysCNVMnBf3s1','HJusZTbBU494','label','child:sorted','',1,'2018-08-29T10:52:08.249Z','2018-08-29T10:52:08.250Z',0,'ItprIuiTlZ',0);
+INSERT INTO attributes VALUES('oTeqKnzwZURH','HJusZTbBU494','label','yearNote','2017',2,'2018-08-29T10:53:09.515Z','2018-08-29T10:53:16.513Z',0,'YrrW7ywzCK',0);
+INSERT INTO attributes VALUES('KOTvzLMSuse5','6ZuXjCSWgjB4','label','sorted','',0,'2018-08-29T10:52:15.655Z','2018-08-29T10:52:15.658Z',0,'veo8Kp5mE0',0);
+INSERT INTO attributes VALUES('aCBsrwvzvqjE','6ZuXjCSWgjB4','label','monthNote','2017-11',1,'2018-08-29T10:53:37.887Z','2018-08-29T10:53:37.887Z',0,'tF8CYyko+S',0);
+INSERT INTO attributes VALUES('7twUQrUK7XcT','3oldoiMUPOlr','label','sorted','',0,'2018-08-29T10:52:19.809Z','2018-08-29T10:52:19.809Z',0,'sm1omFTQsu',0);
+INSERT INTO attributes VALUES('OJYkhC8lC8ZC','3oldoiMUPOlr','label','monthNote','2017-12',1,'2018-08-29T10:53:53.206Z','2018-08-29T10:53:55.686Z',0,'dec3sb4XOC',0);
+INSERT INTO attributes VALUES('tWMT7ukJwwQy','MG0wntwILQW6','label','dateNote','2017-12-22',0,'2018-08-29T10:54:54.959Z','2018-08-29T10:54:54.959Z',0,'ApbCv7exkj',0);
+INSERT INTO attributes VALUES('fpbatIuJE1a5','Iha4YwchR413','label','dateNote','2017-12-21',0,'2018-08-29T10:54:11.560Z','2018-08-29T10:55:02.740Z',0,'+XTEkYlpvF',0);
+INSERT INTO attributes VALUES('dGdwWsGNqPOD','GpGnjmcAPeWG','label','dateNote','2017-11-28',0,'2018-08-29T10:55:14.883Z','2018-08-29T10:55:14.884Z',0,'dBEaBZnqWC',0);
diff --git a/db/main_branches.sql b/db/main_branches.sql
index 0007cfdf8..1938f5e6a 100644
--- a/db/main_branches.sql
+++ b/db/main_branches.sql
@@ -1,9 +1,8 @@
INSERT INTO branches VALUES('root','root','none',0,NULL,1,0,'2018-01-01T00:00:00.000Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('dLgtLUFn3GoN','1Heh2acXfPNt','root',21,NULL,1,0,'2017-12-23T00:46:39.304Z','','1970-01-01T00:00:00.000Z');
-INSERT INTO branches VALUES('QLfS835GSfIh','3RkyK9LI18dO','1Heh2acXfPNt',1,NULL,1,0,'2017-12-23T01:20:04.181Z','','1970-01-01T00:00:00.000Z');
-INSERT INTO branches VALUES('QJAcYJ1gGUh9','L1Ox40M1aEyy','3RkyK9LI18dO',0,NULL,0,0,'2017-12-23T01:20:45.365Z','','1970-01-01T00:00:00.000Z');
+INSERT INTO branches VALUES('QLfS835GSfIh','3RkyK9LI18dO','1Heh2acXfPNt',1,NULL,0,0,'2017-12-23T01:20:04.181Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('wLTa2l3lYi83','HJusZTbBU494','3RkyK9LI18dO',2,NULL,0,0,'2017-12-23T01:20:50.709Z','','1970-01-01T00:00:00.000Z');
-INSERT INTO branches VALUES('yMhwsE7uvEij','3oldoiMUPOlr','HJusZTbBU494',1,NULL,1,0,'2017-12-23T01:20:55.775Z','','1970-01-01T00:00:00.000Z');
+INSERT INTO branches VALUES('yMhwsE7uvEij','3oldoiMUPOlr','HJusZTbBU494',1,NULL,0,0,'2017-12-23T01:20:55.775Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('EjQTcVVHFmmZ','MG0wntwILQW6','3oldoiMUPOlr',1,NULL,1,0,'2017-12-23T01:21:10.517Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('jvhKcwz4pYTr','ZC78NlmdXeC6','WdWZFuWNVDZk',0,NULL,1,0,'2017-12-23T04:06:21.579Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('CarTrwkGVcPz','NncfGH8dyNjJ','WdWZFuWNVDZk',1,NULL,0,0,'2017-12-23T04:06:24.012Z','','1970-01-01T00:00:00.000Z');
@@ -16,7 +15,7 @@ INSERT INTO branches VALUES('RxUiraiR655R','CF2lUIJAr6Ey','NncfGH8dyNjJ',2,NULL,
INSERT INTO branches VALUES('mZuSrZ18Zmv0','xkXwueRoDNeN','MG0wntwILQW6',0,NULL,0,0,'2017-12-23T01:35:40.306Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('hbcWTnEnXPwF','eXHZAKsMYgur','1Heh2acXfPNt',3,NULL,0,0,'2017-12-23T03:32:42.868Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('8a3aNxjG0nu7','2WU27ekfy07E','eXHZAKsMYgur',0,NULL,0,0,'2017-12-23T03:32:49.379Z','','1970-01-01T00:00:00.000Z');
-INSERT INTO branches VALUES('4Tu6vaPdCxCM','TjWEndYCCg7g','eXHZAKsMYgur',1,NULL,0,0,'2017-12-23T03:33:23.584Z','','1970-01-01T00:00:00.000Z');
+INSERT INTO branches VALUES('4Tu6vaPdCxCM','TjWEndYCCg7g','eXHZAKsMYgur',1,NULL,1,0,'2017-12-23T03:33:23.584Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('lBPOmhP12egP','8nRNDJGyGs2Z','TjWEndYCCg7g',0,NULL,0,0,'2017-12-23T03:33:37.327Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('C5ipVqeDWySp','9zSwD89vgzNO','8nRNDJGyGs2Z',0,NULL,0,0,'2017-12-23T03:37:04.912Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('uSitzbGcSATJ','u5t1EvWa3CMO','TjWEndYCCg7g',1,NULL,0,0,'2017-12-23T03:39:21.918Z','','1970-01-01T00:00:00.000Z');
@@ -51,12 +50,9 @@ INSERT INTO branches VALUES('abTEhnOsAsSg','PEGQGg0In3Ar','GpGnjmcAPeWG',2,NULL,
INSERT INTO branches VALUES('bryQseMhyzaI','IlULcDiOTI4K','1Heh2acXfPNt',0,NULL,0,0,'2017-12-23T18:04:26.439Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('ccslPJf3wQV3','vBv6ovBupfTj','IlULcDiOTI4K',0,NULL,0,0,'2017-12-23T18:04:50.904Z','','1970-01-01T00:00:00.000Z');
INSERT INTO branches VALUES('5Dt9YCMn59sY','mw4f2xB4J5fV','IlULcDiOTI4K',1,NULL,0,0,'2017-12-23T18:05:24.868Z','','1970-01-01T00:00:00.000Z');
-INSERT INTO branches VALUES('D2qDlaXQRJyT','lev881bdzoS1','1Heh2acXfPNt',9,NULL,0,0,'2018-08-28T20:50:21.911Z','uRqjXUyybe','2018-08-28T20:50:21.911Z');
-INSERT INTO branches VALUES('FIurtaYkU3mn','gDrEI7LFWqrP','lev881bdzoS1',0,NULL,1,0,'2018-08-28T20:50:21.931Z','vceB3lKKZ0','2018-08-28T20:50:21.931Z');
INSERT INTO branches VALUES('Qwj5gpLainnP','N029F9ANGn8b','Dk5RGYzufXg3',0,NULL,0,0,'2018-08-28T20:50:22.011Z','gziRGab1sT','2018-08-28T20:50:22.011Z');
INSERT INTO branches VALUES('gslGsoDESZjG','bFTtwsnNgw9T','Dk5RGYzufXg3',1,NULL,0,0,'2018-08-28T20:50:22.110Z','ZcNPsaKsw8','2018-08-28T20:50:22.110Z');
INSERT INTO branches VALUES('aP3f70xCJWGs','N029F9ANGn8b','bFTtwsnNgw9T',0,NULL,NULL,0,'2018-08-28T20:50:22.117Z','ZvcZgDrutn','2018-08-28T20:50:22.117Z');
-INSERT INTO branches VALUES('A56xlTT6rczp','YULCKCrWJJZ6','lev881bdzoS1',3,NULL,0,0,'2018-08-28T20:50:22.175Z','idD/qrQZEP','2018-08-28T20:50:22.175Z');
INSERT INTO branches VALUES('WlpZMMsXlQJw','wHb2YBwhjxiD','YULCKCrWJJZ6',0,NULL,0,0,'2018-08-28T20:50:22.181Z','cBicKleFbl','2018-08-28T20:50:22.181Z');
INSERT INTO branches VALUES('jyFk0k855gf1','cUYFEvsdY6N6','YULCKCrWJJZ6',1,NULL,0,0,'2018-08-28T20:50:22.187Z','BC+PIh5h25','2018-08-28T20:50:22.186Z');
INSERT INTO branches VALUES('O7hcbDc4taan','8APXN4n4Hnb8','YULCKCrWJJZ6',2,NULL,0,0,'2018-08-28T20:50:22.192Z','ubas1i1Xzz','2018-08-28T20:50:22.192Z');
@@ -69,13 +65,12 @@ INSERT INTO branches VALUES('vWch9vHEIsKw','OZKicr536m7U','YULCKCrWJJZ6',8,NULL,
INSERT INTO branches VALUES('p07f522OT9FP','oato1D7kuNU2','YULCKCrWJJZ6',9,NULL,0,0,'2018-08-28T20:50:22.231Z','LQlWJmL3RR','2018-08-28T20:50:22.231Z');
INSERT INTO branches VALUES('03YszmiIfe8B','C1I7GPA8ORO4','YULCKCrWJJZ6',10,NULL,0,0,'2018-08-28T20:50:22.236Z','uNgEmMMv59','2018-08-28T20:50:22.236Z');
INSERT INTO branches VALUES('iZJMJE9v4caq','gQNQaMBzRYdb','YULCKCrWJJZ6',11,NULL,0,0,'2018-08-28T20:50:22.242Z','OIMswfv8u0','2018-08-28T20:50:22.242Z');
-INSERT INTO branches VALUES('5cJwU0VlCJA7','WkdQrYTnsgxP','lev881bdzoS1',6,NULL,0,0,'2018-08-28T20:50:22.250Z','dFJdci5I2i','2018-08-28T20:50:22.250Z');
-INSERT INTO branches VALUES('BgakZWX2NSoa','8LOr7xUMuWD4','1Heh2acXfPNt',10,NULL,0,0,'2018-08-28T20:50:36.080Z','l6e868XpLw','2018-08-28T20:50:36.079Z');
+INSERT INTO branches VALUES('BgakZWX2NSoa','8LOr7xUMuWD4','1Heh2acXfPNt',13,NULL,0,0,'2018-08-28T20:50:36.080Z','l6e868XpLw','2018-08-28T20:50:36.079Z');
INSERT INTO branches VALUES('iRvWmIBZPmBV','NGSqsVZkg0Fb','kV2NwNNvepGF',0,NULL,0,0,'2018-08-28T20:50:36.107Z','TnumCb1pF9','2018-08-28T20:50:36.107Z');
INSERT INTO branches VALUES('89jF4vQ83Rx0','dbaUR3erYwl8','NGSqsVZkg0Fb',0,NULL,0,0,'2018-08-28T20:50:36.120Z','qunPMJhWRD','2018-08-28T20:50:36.120Z');
INSERT INTO branches VALUES('9zW6GNyUrSwj','HgaAwBX5zVcP','kV2NwNNvepGF',1,NULL,0,0,'2018-08-28T20:50:36.140Z','IsmvjdfKeM','2018-08-28T20:50:36.139Z');
INSERT INTO branches VALUES('6yEXb5xSww7E','qEi5St9PBPCP','8LOr7xUMuWD4',3,NULL,0,0,'2018-08-28T20:50:36.154Z','wiqkXVJhDQ','2018-08-28T20:50:36.154Z');
-INSERT INTO branches VALUES('WFBrWWGubT8N','IYKhW6LTUpwP','1Heh2acXfPNt',11,NULL,0,0,'2018-08-28T20:50:48.458Z','KaPAe+LyvC','2018-08-28T20:50:48.458Z');
+INSERT INTO branches VALUES('WFBrWWGubT8N','IYKhW6LTUpwP','1Heh2acXfPNt',14,NULL,0,0,'2018-08-28T20:50:48.458Z','KaPAe+LyvC','2018-08-28T20:50:48.458Z');
INSERT INTO branches VALUES('VEq36SudFqDe','L9qettZi0csz','IYKhW6LTUpwP',0,NULL,1,0,'2018-08-28T20:50:48.471Z','74RNaEVH/C','2018-08-28T20:50:48.470Z');
INSERT INTO branches VALUES('cnL65jQZPFng','Dyahpf7LroQY','IYKhW6LTUpwP',1,NULL,0,0,'2018-08-28T20:50:48.481Z','uY3Jzm+34n','2018-08-28T20:50:48.480Z');
INSERT INTO branches VALUES('n8qX7Q64oDGk','y4T7SoDx38PF','Dyahpf7LroQY',0,NULL,0,0,'2018-08-28T20:50:48.488Z','FHwozkkN5A','2018-08-28T20:50:48.488Z');
@@ -89,12 +84,17 @@ INSERT INTO branches VALUES('UPdB517CCSC6','vVhlPtM5YgWe','gYVdjKAJeImD',0,NULL,
INSERT INTO branches VALUES('2lLNmlPp32DT','XVlWndK4Oh6A','hL4rychNFWZs',2,NULL,0,0,'2018-08-28T20:50:48.575Z','7KpHQIqICP','2018-08-28T20:50:48.575Z');
INSERT INTO branches VALUES('8A8Hj2KELLZe','gYNJtGEPGW95','hL4rychNFWZs',3,NULL,0,0,'2018-08-28T20:50:48.583Z','akAZK6+pYC','2018-08-28T20:50:48.583Z');
INSERT INTO branches VALUES('feP0uJpIPOz3','HbtlYiMvmm4V','hL4rychNFWZs',4,NULL,0,0,'2018-08-28T20:50:48.592Z','2hPRviPOvY','2018-08-28T20:50:48.592Z');
-INSERT INTO branches VALUES('U4XC6g7oB4ME','Z5yhGE5g0UB5','lev881bdzoS1',9,NULL,1,0,'2018-08-28T20:51:10.194Z','EbAWPpwESx','2018-08-28T20:51:10.194Z');
INSERT INTO branches VALUES('VgaH4I1fLW0p','Dk5RGYzufXg3','Z5yhGE5g0UB5',0,NULL,1,0,'2018-08-28T20:51:30.388Z','A5p7MjKIdD','2018-08-28T20:50:21.941Z');
-INSERT INTO branches VALUES('bFGrKoCcHTD0','ucC6Zabv3Uml','lev881bdzoS1',10,NULL,0,0,'2018-08-28T20:51:51.532Z','/LLRUs4CNK','2018-08-28T20:50:22.122Z');
INSERT INTO branches VALUES('sOGDHPGhnMoM','YBAcWV8TjYEp','8LOr7xUMuWD4',0,NULL,0,0,'2018-08-28T20:56:04.336Z','e84wqxU8y+','2018-08-28T20:55:00.064Z');
INSERT INTO branches VALUES('Hoq9xTZg8sCK','kV2NwNNvepGF','YBAcWV8TjYEp',0,NULL,0,0,'2018-08-28T20:56:05.910Z','0rORbULibz','2018-08-28T20:50:36.095Z');
INSERT INTO branches VALUES('wGlzUbiXrVZd','dgqgC2fMQRtF','hL4rychNFWZs',1,NULL,0,1,'2018-08-28T21:11:19.888Z','L7baPh0p8r','2018-08-28T20:50:48.565Z');
INSERT INTO branches VALUES('MmDWuCCBOml4','1s6SGhByxkoU','L9qettZi0csz',0,NULL,0,1,'2018-08-28T21:11:48.815Z','WKSIF7WqPR','2018-08-28T21:11:29.823Z');
INSERT INTO branches VALUES('5HYoxqRZFsQr','1s6SGhByxkoU','L9qettZi0csz',0,NULL,0,1,'2018-08-28T21:11:48.942Z','3dMy0TKveJ','2018-08-28T21:11:48.942Z');
INSERT INTO branches VALUES('pHFRDDCc84RY','0QeaWUvZYuB9','L9qettZi0csz',0,NULL,0,1,'2018-08-28T21:17:31.699Z','+hThNugcFk','2018-08-28T21:17:27.853Z');
+INSERT INTO branches VALUES('QJAcYJ1gGUh9','L1Ox40M1aEyy','3RkyK9LI18dO',0,NULL,0,1,'2018-08-29T10:50:46.580Z','UzURkEuvae','1970-01-01T00:00:00.000Z');
+INSERT INTO branches VALUES('A56xlTT6rczp','YULCKCrWJJZ6','gDrEI7LFWqrP',0,NULL,0,0,'2018-08-29T16:03:23.987Z','7YCK6Cf3vr','2018-08-28T20:50:22.175Z');
+INSERT INTO branches VALUES('5cJwU0VlCJA7','WkdQrYTnsgxP','gDrEI7LFWqrP',1,NULL,0,0,'2018-08-29T16:03:24.889Z','RaGS8TUyuV','2018-08-28T20:50:22.250Z');
+INSERT INTO branches VALUES('U4XC6g7oB4ME','Z5yhGE5g0UB5','gDrEI7LFWqrP',2,NULL,1,0,'2018-08-29T16:03:25.779Z','fAkVtlU455','2018-08-28T20:51:10.194Z');
+INSERT INTO branches VALUES('FIurtaYkU3mn','gDrEI7LFWqrP','1Heh2acXfPNt',11,NULL,0,0,'2018-08-29T16:03:27.894Z','+Jd+Zzgx2u','2018-08-28T20:50:21.931Z');
+INSERT INTO branches VALUES('bFGrKoCcHTD0','ucC6Zabv3Uml','gDrEI7LFWqrP',3,NULL,0,0,'2018-08-29T16:03:30.624Z','KWGpDGiWrq','2018-08-28T20:50:22.122Z');
+INSERT INTO branches VALUES('D2qDlaXQRJyT','lev881bdzoS1','1Heh2acXfPNt',9,NULL,1,1,'2018-08-29T16:03:38.736Z','lB3YjAVyVb','2018-08-28T20:50:21.911Z');
diff --git a/db/main_notes.sql b/db/main_notes.sql
index 68cbf1f96..a51c879ab 100644
--- a/db/main_notes.sql
+++ b/db/main_notes.sql
@@ -1,9 +1,6 @@
INSERT INTO notes VALUES('root','root','root',0,0,'2017-12-22T11:41:07.000Z','2017-12-22T11:41:07.000Z','text','text/html','');
INSERT INTO notes VALUES('1Heh2acXfPNt','Trilium Demo','Welcome to Trilium Notes!
This is initial document provided by default Trilium to showcase some of its features and also give you some ideas how you might structure your notes. You can play with it, modify note content and tree structure as you wish.
If you need any help, visit Trilium website: https://github.com/zadam/trilium
Cleanup Once you''re finished with experimenting and want to cleanup these pages, you can simply delete them all.
Formatting Trilium supports classic formatting like italic , bold , bold and italic google.com
Lists Ordered:
First Item Second itemFirst sub-item Second sub-item
Unordered:
Block quotes Whereof one cannot speak, thereof one must be silent”
– Ludwig Wittgenstein
',0,0,'2017-12-23T00:46:39.304Z','2017-12-23T04:08:45.445Z','text','text/html','');
INSERT INTO notes VALUES('3RkyK9LI18dO','Journal','Expand note on the left pane to see content.
',0,0,'2017-12-23T01:20:04.181Z','2017-12-23T18:07:55.377Z','text','text/html','');
-INSERT INTO notes VALUES('L1Ox40M1aEyy','2016','No content.
',0,0,'2017-12-23T01:20:45.365Z','2017-12-23T16:40:43.129Z','text','text/html','');
-INSERT INTO notes VALUES('HJusZTbBU494','2017','No content.
',0,0,'2017-12-23T01:20:50.709Z','2017-12-23T16:41:03.119Z','text','text/html','');
-INSERT INTO notes VALUES('3oldoiMUPOlr','December','',0,0,'2017-12-23T01:20:55.775Z','2017-12-23T01:21:05.806Z','text','text/html','');
INSERT INTO notes VALUES('MG0wntwILQW6','22 - friday','Daily summary',0,0,'2017-12-23T01:21:10.517Z','2017-12-23T01:22:45.814Z','text','text/html','');
INSERT INTO notes VALUES('ZC78NlmdXeC6','Linux','Expand note on the left pane to see content.
',0,0,'2017-12-23T01:22:55.255Z','2017-12-23T18:08:10.381Z','text','text/html','');
INSERT INTO notes VALUES('NncfGH8dyNjJ','Programming','Expand note on the left pane to see content.
',0,0,'2017-12-23T01:23:02.584Z','2017-12-23T18:08:20.179Z','text','text/html','');
@@ -20,7 +17,6 @@ INSERT INTO notes VALUES('8nRNDJGyGs2Z','The Mechanical','Amazon:Like a raindrop rolling down dry valleys to the sea, his body sensed the contours of agony and helplessly followed their gradient. Impelled by alchemical compulsion rather than gravity, Jax became an unstoppable boulder careering along gullies of human whim.
Free Will was a vacuum, a negative space. It was the absence of coercion, the absence of compulsion, the absence of agony.
Overwhelming: he could do anything he wanted. But the grand sum of anything-at-all was nothing-at-all. The topology of freedom offered no gradients to nudge him, no landmarks to guide him. How did humans guide themselves? How did they know what to do and what not to do? How did they know when to do anything without the benefit of geasa and metageasa to prioritize every single action of their waking lives? How did they order their daily existence without somebody to tell them what to do?
Life as a slave was unspeakable; life as a slave who had briefly tasted freedom was unthinkable. Clakkers carried complex geasa by dint of alchemy; humans carried heavy obligations, too, but called them culture. Society.
Autor : Viktor Frankl - https://en.wikipedia.org/wiki/Viktor_Frankl
Wiki - https://en.wikipedia.org/wiki/Man%27s_Search_for_Meaning
But I must explain to you how all this mistaken idea of denouncing pleasure and praising pain was born and I will give you a complete account of the system, and expound the actual teachings of the great explorer of the truth, the master-builder of human happiness. No one rejects, dislikes, or avoids pleasure itself, because it is pleasure, but because those who do not know how to pursue pleasure rationally encounter consequences that are extremely painful. Nor again is there anyone who loves or pursues or desires to obtain pain of itself, because it is pain, but because occasionally circumstances occur in which toil and pain can procure him some great pleasure. To take a trivial example, which of us ever undertakes laborious physical exercise, except to obtain some advantage from it? But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?
',0,0,'2017-12-23T03:39:21.918Z','2017-12-23T03:40:26.692Z','text','text/html','');
INSERT INTO notes VALUES('Iha4YwchR413','21 - thursday','',0,0,'2017-12-23T03:44:21.176Z','2017-12-23T03:44:28.816Z','text','text/html','');
-INSERT INTO notes VALUES('6ZuXjCSWgjB4','November','',0,0,'2017-12-23T03:44:45.351Z','2017-12-23T03:44:53.787Z','text','text/html','');
INSERT INTO notes VALUES('GpGnjmcAPeWG','28','',0,0,'2017-12-23T03:44:57.036Z','2017-12-23T03:45:08.790Z','text','text/html','');
INSERT INTO notes VALUES('21K84UqGhqlt','Christmas gift ideas','',0,0,'2017-12-23T03:45:10.933Z','2017-12-23T16:43:28.160Z','text','text/html','');
INSERT INTO notes VALUES('rz5t0r9Qr2WC','Epics','Epic is kind of medium-term events or projects spread over days or months.
Remember that Trilium is all free form so you can organise your stuff in whatever way you''d like
',0,0,'2017-12-23T03:45:20.914Z','2017-12-23T03:52:37.779Z','text','text/html','');
@@ -36,7 +32,6 @@ INSERT INTO notes VALUES('62BKAQMVP2KW','Unity shortcuts','Hold Super -
INSERT INTO notes VALUES('h4OfLEAYspud','Security','Expand note on the left pane to see content.
',0,0,'2017-12-23T04:04:00.715Z','2017-12-23T18:08:25.474Z','text','text/html','');
INSERT INTO notes VALUES('1hASbLRDL7oo','Trusted timestamping','Wiki: https://en.wikipedia.org/wiki/Trusted_timestamping
Bozho: https://techblog.bozho.net/using-trusted-timestamping-java/
Trusted timestamping is the process of securely keeping track of the creation and modification time of a document. Security here means that no one—not even the owner of the document—should be able to change it once it has been recorded provided that the timestamper''s integrity is never compromised.
The administrative aspect involves setting up a publicly available, trusted timestamp management infrastructure to collect, process and renew timestamps.
',0,0,'2017-12-23T04:04:08.155Z','2017-12-23T04:04:30.386Z','text','text/html','');
INSERT INTO notes VALUES('jyqG9GucsMdn','Office party','That was fun!',0,0,'2017-12-23T04:05:16.439Z','2017-12-23T04:05:30.373Z','text','text/html','');
-INSERT INTO notes VALUES('WdWZFuWNVDZk','Tech','Expand note on the left pane to see content.
',0,0,'2017-12-23T04:06:16.179Z','2017-12-23T18:08:05.376Z','text','text/html','');
INSERT INTO notes VALUES('yK4SBJfwD3tY','Work','Expand note on the left pane to see content.
',0,0,'2017-12-23T04:06:32.833Z','2017-12-23T18:08:30.573Z','text','text/html','');
INSERT INTO notes VALUES('r4BnsmSQeVr1','HR','HR stuff
',0,0,'2017-12-23T04:06:37.427Z','2017-12-23T16:42:23.145Z','text','text/html','');
INSERT INTO notes VALUES('QbL3pTvhgzM8','Processes','No content.
',0,0,'2017-12-23T04:06:43.841Z','2017-12-23T16:42:15.893Z','text','text/html','');
@@ -45,7 +40,6 @@ INSERT INTO notes VALUES('PEGQGg0In3Ar','Phone call about work project','Bla
INSERT INTO notes VALUES('IlULcDiOTI4K','Inbox','
This is a place I use to put notes waiting for better categorization
',0,0,'2017-12-23T16:45:11.047Z','2017-12-23T18:04:49.545Z','text','text/html','');
INSERT INTO notes VALUES('vBv6ovBupfTj','Grocery list for today','
',0,0,'2017-12-23T18:04:50.904Z','2017-12-23T18:05:19.574Z','text','text/html','');
INSERT INTO notes VALUES('mw4f2xB4J5fV','Book to read','How to be a stoic from Massimo Pigliuci:
https://www.amazon.com/gp/product/B01K3WN1BY?pf_rd_m=A2R2RITDJNW1Q6&storeType=ebooks&pageType=STOREFRONT&pf_rd_p=8e2a96d9-c848-435b-92bd-0856850ad544&pf_rd_r=4J6CT15BS4X8062XNGDF&pf_rd_s=merchandised-search-5&pf_rd_t=40901&ref_=dbs_f_ebk_rwt_scns_mwl_ms5_kmw_8e2a96d9-c848-435b-92bd-0856850ad544_2&pf_rd_i=154606011
',0,0,'2017-12-23T18:05:24.868Z','2017-12-23T18:06:55.320Z','text','text/html','');
-INSERT INTO notes VALUES('lev881bdzoS1','Family','',0,0,'2018-08-28T20:50:21.905Z','2018-08-28T20:50:21.906Z','text','text/html','O6X0FsZToV');
INSERT INTO notes VALUES('gDrEI7LFWqrP','Family Tree','Expand note on the left pane to see content.
',0,0,'2017-12-23T04:06:16.179Z','2018-08-29T16:03:57.219Z','text','text/html','iIbiynQV+8');
diff --git a/docs/backend_api/ApiToken.html b/docs/backend_api/ApiToken.html
new file mode 100644
index 000000000..3ac23346c
--- /dev/null
+++ b/docs/backend_api/ApiToken.html
@@ -0,0 +1,297 @@
+
+
+
+ JSDoc: Class: ApiToken
+
+
+
+
+
+
+
Class: ApiToken
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
(apiTokenId, token, isDeleted, dateCreated)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ apiTokenId
+
+
+string
+
+
+
+
+
+
+
+
+
+ primary key
+
+
+
+
+
+
+ token
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ isDeleted
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ true if API token is deleted
+
+
+
+
+
+
+ dateCreated
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extends
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/Attribute.html b/docs/backend_api/Attribute.html
new file mode 100644
index 000000000..f8d9c6409
--- /dev/null
+++ b/docs/backend_api/Attribute.html
@@ -0,0 +1,435 @@
+
+
+
+ JSDoc: Class: Attribute
+
+
+
+
+
+
+
Class: Attribute
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
(attributeId, noteId, type, name, value, position, isInheritable, isDeleted, dateCreated, dateModified)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ attributeId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ noteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ position
+
+
+int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ isInheritable
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ isDeleted
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateCreated
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateModified
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extends
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/BackendScriptApi.html b/docs/backend_api/BackendScriptApi.html
new file mode 100644
index 000000000..7ebaed12a
--- /dev/null
+++ b/docs/backend_api/BackendScriptApi.html
@@ -0,0 +1,3823 @@
+
+
+
+ JSDoc: Class: BackendScriptApi
+
+
+
+
+
+
+
Class: BackendScriptApi
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Members
+
+
+
+Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ note
+
+
+Note
+
+
+
+
+
+ where script is currently executing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ entity
+
+
+Entity
+
+
+
+
+
+ whose event triggered this executions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ note
+
+
+Note
+
+
+
+
+
+ where script started executing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (parentNoteId, title, contentopt , extraOptionsopt ) → {Promise.<{note: Note , branch: Branch }>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
+
+
+
+
+ parentNoteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ create new note under this parent
+
+
+
+
+
+
+ title
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+ ""
+
+
+
+
+
+
+
+
+
+
+ extraOptions
+
+
+CreateNoteExtraOptions
+
+
+
+
+ <optional>
+
+
+
+
+
+ {}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ object contains newly created entities note and branch
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<{note: Note , branch: Branch }>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (noteId, parentNoteId) → {Promise.<void>}
+ If there's a branch between note and parent note, remove it. Otherwise do nothing.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ noteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ parentNoteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (noteId, parentNoteId, prefix) → {Promise.<void>}
+ If there's no branch between note and parent note, create one. Otherwise do nothing.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ noteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ parentNoteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prefix
+
+
+string
+
+
+
+
+
+
+
+
+
+ if branch will be create between note and parent note, set this prefix
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (attributeId) → {Promise.<(Attribute |null)>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ attributeId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<(Attribute |null)>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (branchId) → {Promise.<(Branch |null)>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ branchId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<(Branch |null)>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (date) → {Promise.<(Note |null)>}
+ Returns day note for given date (YYYY-MM-DD format). If such note doesn't exist, it is created.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ date
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<(Note |null)>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (SQL, array) → {Promise.<Array.<Entity >>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ SQL
+
+
+string
+
+
+
+
+
+
+
+
+
+ query
+
+
+
+
+
+
+ array
+
+
+Array.<?>
+
+
+
+
+
+
+
+
+
+ of params
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Entity >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (SQL, array) → {Promise.<(Entity |null)>}
+ Retrieves first entity from the SQL's result set.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ SQL
+
+
+string
+
+
+
+
+
+
+
+
+
+ query
+
+
+
+
+
+
+ array
+
+
+Array.<?>
+
+
+
+
+
+
+
+
+
+ of params
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<(Entity |null)>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (imageId) → {Promise.<(Image |null)>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ imageId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<(Image |null)>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {string|null}
+ Instance name identifies particular Trilium instance. It can be useful for scripts
+if some action needs to happen on only one specific instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+string
+|
+
+null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (noteId) → {Promise.<(Note |null)>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ noteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<(Note |null)>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (name, valueopt ) → {Promise.<Array.<Note >>}
+ Retrieves notes with given label name & value
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ attribute value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Note >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (name, valueopt ) → {Promise.<(Note |null)>}
+ Retrieves first note with given label name & value
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ attribute value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<(Note |null)>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {Promise.<(Note |null)>}
+ Returns root note of the calendar.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<(Note |null)>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (message)
+ Log given message to trilium logs.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ message
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (noteId, prefix, parentNoteIdopt )
+ This method finds note by its noteId and prefix and either sets it to the given parentNoteId
+or removes the branch (if parentNoteId is not given).
+
+This method looks similar to toggleNoteInParent() but differs because we're looking up branch by prefix.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ noteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prefix
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ parentNoteId
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (parentNoteId) Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ parentNoteId
+
+
+string
+
+
+
+
+
+
+
+
+
+ this note's child notes will be sorted
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ Promise
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (present, noteId, parentNoteId, prefix) → {Promise.<void>}
+ Based on the value, either create or remove branch between note and parent note.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ present
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ true if we want the branch to exist, false if we want it gone
+
+
+
+
+
+
+ noteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ parentNoteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prefix
+
+
+string
+
+
+
+
+
+
+
+
+
+ if branch will be create between note and parent note, set this prefix
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (func) → {Promise.<?>}
+ This functions wraps code which is supposed to be running in transaction. If transaction already
+exists, then we'll use that transaction.
+
+This method is required only when script has label manualTransactionHandling, all other scripts are
+transactional by default.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ func
+
+
+function
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ result of func callback
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<?>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/Branch.html b/docs/backend_api/Branch.html
new file mode 100644
index 000000000..da46e696b
--- /dev/null
+++ b/docs/backend_api/Branch.html
@@ -0,0 +1,413 @@
+
+
+
+ JSDoc: Class: Branch
+
+
+
+
+
+
+
Class: Branch
+
+
+
+
+
+
+
+
+
+
+ (branchId, noteId, parentNoteId, notePosition, prefix, isExpanded, isDeleted, dateModified, dateCreated) Branch represents note's placement in the tree - it's essentially pair of noteId and parentNoteId.
+Each note can have multiple (at least one) branches, meaning it can be placed into multiple places in the tree.
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
(branchId, noteId, parentNoteId, notePosition, prefix, isExpanded, isDeleted, dateModified, dateCreated)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ branchId
+
+
+string
+
+
+
+
+
+
+
+
+
+ primary key
+
+
+
+
+
+
+ noteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ parentNoteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ notePosition
+
+
+int
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ prefix
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ isExpanded
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ isDeleted
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateModified
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateCreated
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extends
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/Entity.html b/docs/backend_api/Entity.html
new file mode 100644
index 000000000..528be57b8
--- /dev/null
+++ b/docs/backend_api/Entity.html
@@ -0,0 +1,225 @@
+
+
+
+ JSDoc: Class: Entity
+
+
+
+
+
+
+
Class: Entity
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
(rowopt )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ row
+
+
+object
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ database row representing given entity
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/Image.html b/docs/backend_api/Image.html
new file mode 100644
index 000000000..f16a7edae
--- /dev/null
+++ b/docs/backend_api/Image.html
@@ -0,0 +1,389 @@
+
+
+
+ JSDoc: Class: Image
+
+
+
+
+
+
+
Class: Image
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
(imageId, format, checksum, name, data, isDeleted, dateModified, dateCreated)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ imageId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ format
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ checksum
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ data
+
+
+blob
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ isDeleted
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateModified
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateCreated
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extends
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/Note.html b/docs/backend_api/Note.html
new file mode 100644
index 000000000..5c3b6aee2
--- /dev/null
+++ b/docs/backend_api/Note.html
@@ -0,0 +1,6373 @@
+
+
+
+ JSDoc: Class: Note
+
+
+
+
+
+
+
Class: Note
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
(row)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ row
+
+
+
+
+
+
+
+ object containing database row from "notes" table
+
+
+
+
+
+
+
+
+
+
+
+
Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ noteId
+
+
+string
+
+
+
+
+
+
+
+
+
+ primary key
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+
+ one of "text", "code", "file" or "render"
+
+
+
+
+
+
+ mime
+
+
+string
+
+
+
+
+
+
+
+
+
+ MIME type, e.g. "text/html"
+
+
+
+
+
+
+ title
+
+
+string
+
+
+
+
+
+
+
+
+
+ note title
+
+
+
+
+
+
+ content
+
+
+string
+
+
+
+
+
+
+
+
+
+ note content - e.g. HTML text for text notes, file payload for files
+
+
+
+
+
+
+ isProtected
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ true if note is protected
+
+
+
+
+
+
+ isDeleted
+
+
+boolean
+
+
+
+
+
+
+
+
+
+ true if note is deleted
+
+
+
+
+
+
+ dateCreated
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateModified
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extends
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (async) findNotesWithAttribute(type, name, valueopt ) → {Promise.<Array.<Note >>}
+ Finds notes with given attribute name and value. Only own attributes are considered, not inherited ones
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute type (label, relation, etc.)
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ attribute value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Note >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) findNotesWithLabel(name, valueopt ) → {Promise.<Array.<Note >>}
+ Finds notes with given label name and value. Only own labels are considered, not inherited ones
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ label name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ label value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Note >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) findNotesWithRelation(name, valueopt ) → {Promise.<Array.<Note >>}
+ Finds notes with given relation name and value. Only own relations are considered, not inherited ones
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ relation name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ relation value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Note >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getAttribute(type, name) → {Promise.<Attribute >} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+
+ attribute type (label, relation, etc.)
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+ attribute name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ 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.
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Attribute >
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getAttributes() → {Promise.<Array.<Attribute >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ all note's attributes, including inherited ones
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Attribute >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getAttributeValue(type, name) → {Promise.<string>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+
+ attribute type (label, relation, etc.)
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+ attribute name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ attribute value of given type and name or null if no such attribute exists.
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getBranches() → {Promise.<Array.<Branch >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Branch >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getChildBranches() → {Promise.<Array.<Branch >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ child branches of this note
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Branch >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getChildNotes() → {Promise.<Array.<Note >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ child notes of this note
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Note >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getLabel(name) → {Promise.<Attribute >} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+ label name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ label if it exists, null otherwise
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Attribute >
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getLabels() → {Promise.<Array.<Attribute >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ all note's labels (attributes with type label), including inherited ones
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Attribute >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getLabelValue(name) → {Promise.<string>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+ label name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ label value if label exists, null otherwise
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getNoteImages() → {Promise.<Array.<NoteImage >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<NoteImage >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getOwnedAttributes() → {Promise.<Array.<Attribute >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ attributes belonging to this specific note (excludes inherited attributes)
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Attribute >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getParentNotes() → {Promise.<Array.<Note >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ parent notes of this note (note can have multiple parents because of cloning)
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Note >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getRelation(name) → {Promise.<Attribute >} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+ relation name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ relation if it exists, null otherwise
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Attribute >
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getRelations() → {Promise.<Array.<Attribute >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ all note's relations (attributes with type relation), including inherited ones
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Attribute >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getRelationTarget(name) → {Promise.<Note >|null} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ target note of the relation or null (if target is empty or note was not found)
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Note >
+|
+
+null
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getRelationValue(name) → {Promise.<string>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+ relation name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ relation value if relation exists, null otherwise
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getRevisions() → {Promise.<Array.<NoteRevision >>}
+ Returns note revisions of this note.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<NoteRevision >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {string}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ JS script environment - either "frontend" or "backend"
+
+
+
+
+
+
+ Type
+
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) hasAttribute(type, name) → {Promise.<boolean>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+
+ attribute type (label, relation, etc.)
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+ attribute name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ true if note has an attribute with given type and name (including inherited)
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<boolean>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) hasLabel(name) → {Promise.<boolean>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+ label name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ true if label exists (including inherited)
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<boolean>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) hasRelation(name) → {Promise.<boolean>} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+ relation name
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ true if relation exists (including inherited)
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<boolean>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ()
+ Clear note's attributes cache to force fresh reload for next attribute request.
+Cache is note instance scoped.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {boolean}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ true if this note is HTML
+
+
+
+
+
+
+ Type
+
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {boolean}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ true if this note is JavaScript (code or attachment)
+
+
+
+
+
+
+ Type
+
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {boolean}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ true if this note is of application/json content type
+
+
+
+
+
+
+ Type
+
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {boolean}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ true if this note is the root of the note tree. Root note has "root" noteId
+
+
+
+
+
+
+ Type
+
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) loadAttributesToCache() → {Promise.<void>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) removeAttribute(type, name, valueopt ) → {Promise.<void>}
+ Removes given attribute name-value pair if it exists.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute type (label, relation, etc.)
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ attribute value (optional)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) removeLabel(name, valueopt ) → {Promise.<void>}
+ Remove label name-value pair, if it exists.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ label name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ label value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) removeRelation(name, valueopt ) → {Promise.<void>}
+ Remove relation name-value pair, if it exists.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ relation name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ relation value (noteId)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) setAttribute(type, name, valueopt ) → {Promise.<void>}
+ Creates given attribute name-value pair if it doesn't exist.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute type (label, relation, etc.)
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ attribute value (optional)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) setLabel(name, valueopt ) → {Promise.<void>}
+ Create label name-value pair if it doesn't exist yet.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ label name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ label value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) setRelation(name, valueopt ) → {Promise.<void>}
+ Create relation name-value pair if it doesn't exist yet.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ relation name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ relation value (noteId)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) toggleAttribute(type, enabled, name, valueopt ) → {Promise.<void>}
+ Based on enabled, attribute is either set or removed.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute type ('relation', 'label' etc.)
+
+
+
+
+
+
+ enabled
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toggle On or Off
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ attribute value (optional)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) toggleLabel(enabled, name, valueopt ) → {Promise.<void>}
+ Based on enabled, label is either set or removed.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ enabled
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toggle On or Off
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ label name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ label value (optional)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) toggleRelation(enabled, name, valueopt ) → {Promise.<void>}
+ Based on enabled, relation is either set or removed.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ enabled
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ toggle On or Off
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ relation name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ relation value (noteId)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/NoteImage.html b/docs/backend_api/NoteImage.html
new file mode 100644
index 000000000..becb73367
--- /dev/null
+++ b/docs/backend_api/NoteImage.html
@@ -0,0 +1,343 @@
+
+
+
+ JSDoc: Class: NoteImage
+
+
+
+
+
+
+
Class: NoteImage
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
(noteImageId, noteId, imageId, isDeleted, dateModified, dateCreated)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ noteImageId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ noteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ imageId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ isDeleted
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateModified
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateCreated
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extends
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/NoteRevision.html b/docs/backend_api/NoteRevision.html
new file mode 100644
index 000000000..328f39192
--- /dev/null
+++ b/docs/backend_api/NoteRevision.html
@@ -0,0 +1,412 @@
+
+
+
+ JSDoc: Class: NoteRevision
+
+
+
+
+
+
+
Class: NoteRevision
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
(noteRevisionId, noteId, type, mime, title, content, isProtected, dateModifiedFrom, dateModifiedTo)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ noteRevisionId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ noteId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ mime
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ title
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ isProtected
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateModifiedFrom
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateModifiedTo
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extends
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/Option.html b/docs/backend_api/Option.html
new file mode 100644
index 000000000..858bccd6f
--- /dev/null
+++ b/docs/backend_api/Option.html
@@ -0,0 +1,320 @@
+
+
+
+ JSDoc: Class: Option
+
+
+
+
+
+
+
Class: Option
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
(name, value, isSynced, dateModified, dateCreated)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ isSynced
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateModified
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateCreated
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extends
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/RecentNote.html b/docs/backend_api/RecentNote.html
new file mode 100644
index 000000000..c37cd8909
--- /dev/null
+++ b/docs/backend_api/RecentNote.html
@@ -0,0 +1,297 @@
+
+
+
+ JSDoc: Class: RecentNote
+
+
+
+
+
+
+
Class: RecentNote
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
(branchId, notePath, isDeleted, dateModified)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ branchId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ notePath
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ isDeleted
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ dateModified
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Extends
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/entities_api_token.js.html b/docs/backend_api/entities_api_token.js.html
new file mode 100644
index 000000000..db27a39dd
--- /dev/null
+++ b/docs/backend_api/entities_api_token.js.html
@@ -0,0 +1,84 @@
+
+
+
+ JSDoc: Source: entities/api_token.js
+
+
+
+
+
+
+
Source: entities/api_token.js
+
+
+
+
+
+
+
+
+ "use strict";
+
+const Entity = require('./entity');
+const dateUtils = require('../services/date_utils');
+
+/**
+ * ApiToken is an entity representing token used to authenticate against Trilium API from client applications. Currently used only by Trilium Sender.
+ *
+ * @param {string} apiTokenId - primary key
+ * @param {string} token
+ * @param {boolean} isDeleted - true if API token is deleted
+ * @param {string} dateCreated
+ *
+ * @extends Entity
+ */
+class ApiToken extends Entity {
+ static get entityName() { return "api_tokens"; }
+ static get primaryKeyName() { return "apiTokenId"; }
+ static get hashedProperties() { return ["apiTokenId", "token", "dateCreated", "isDeleted"]; }
+
+ beforeSaving() {
+ if (!this.isDeleted) {
+ this.isDeleted = false;
+ }
+
+ if (!this.dateCreated) {
+ this.dateCreated = dateUtils.nowDate();
+ }
+
+ super.beforeSaving();
+ }
+}
+
+module.exports = ApiToken;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/backend_api/entities_attribute.js.html b/docs/backend_api/entities_attribute.js.html
new file mode 100644
index 000000000..8a97a2a1f
--- /dev/null
+++ b/docs/backend_api/entities_attribute.js.html
@@ -0,0 +1,143 @@
+
+
+
+ JSDoc: Source: entities/attribute.js
+
+
+
+
+
+
+
Source: entities/attribute.js
+
+
+
+
+
+
+
+
+ "use strict";
+
+const Entity = require('./entity');
+const repository = require('../services/repository');
+const dateUtils = require('../services/date_utils');
+const sql = require('../services/sql');
+
+/**
+ * Attribute is key value pair owned by a note.
+ *
+ * @param {string} attributeId
+ * @param {string} noteId
+ * @param {string} type
+ * @param {string} name
+ * @param {string} value
+ * @param {int} position
+ * @param {boolean} isInheritable
+ * @param {boolean} isDeleted
+ * @param {string} dateCreated
+ * @param {string} dateModified
+ *
+ * @extends Entity
+ */
+class Attribute extends Entity {
+ static get entityName() { return "attributes"; }
+ static get primaryKeyName() { return "attributeId"; }
+ static get hashedProperties() { return ["attributeId", "noteId", "type", "name", "value", "isInheritable", "isDeleted", "dateCreated"]; }
+
+ constructor(row) {
+ super(row);
+
+ this.isInheritable = !!this.isInheritable;
+
+ if (this.isDefinition()) {
+ try {
+ this.value = JSON.parse(this.value);
+ }
+ catch (e) {
+ }
+ }
+ }
+
+ async getNote() {
+ return await repository.getEntity("SELECT * FROM notes WHERE noteId = ?", [this.noteId]);
+ }
+
+ async getTargetNote() {
+ if (this.type !== 'relation') {
+ throw new Error(`Attribute ${this.attributeId} is not relation`);
+ }
+
+ if (!this.value) {
+ return null;
+ }
+
+ return await repository.getEntity("SELECT * FROM notes WHERE noteId = ?", [this.value]);
+ }
+
+ isDefinition() {
+ return this.type === 'label-definition' || this.type === 'relation-definition';
+ }
+
+ async beforeSaving() {
+ if (!this.value) {
+ // null value isn't allowed
+ this.value = "";
+ }
+
+ if (this.position === undefined) {
+ this.position = 1 + await sql.getValue(`SELECT COALESCE(MAX(position), 0) FROM attributes WHERE noteId = ?`, [this.noteId]);
+ }
+
+ if (!this.isInheritable) {
+ this.isInheritable = false;
+ }
+
+ if (!this.isDeleted) {
+ this.isDeleted = false;
+ }
+
+ if (!this.dateCreated) {
+ this.dateCreated = dateUtils.nowDate();
+ }
+
+ super.beforeSaving();
+
+ if (this.isChanged) {
+ this.dateModified = dateUtils.nowDate();
+ }
+ }
+}
+
+module.exports = Attribute;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/backend_api/entities_branch.js.html b/docs/backend_api/entities_branch.js.html
new file mode 100644
index 000000000..d6656f24d
--- /dev/null
+++ b/docs/backend_api/entities_branch.js.html
@@ -0,0 +1,106 @@
+
+
+
+ JSDoc: Source: entities/branch.js
+
+
+
+
+
+
+
Source: entities/branch.js
+
+
+
+
+
+
+
+
+ "use strict";
+
+const Entity = require('./entity');
+const dateUtils = require('../services/date_utils');
+const repository = require('../services/repository');
+const sql = require('../services/sql');
+
+/**
+ * Branch represents note's placement in the tree - it's essentially pair of noteId and parentNoteId.
+ * Each note can have multiple (at least one) branches, meaning it can be placed into multiple places in the tree.
+ *
+ * @param {string} branchId - primary key
+ * @param {string} noteId
+ * @param {string} parentNoteId
+ * @param {int} notePosition
+ * @param {string} prefix
+ * @param {boolean} isExpanded
+ * @param {boolean} isDeleted
+ * @param {string} dateModified
+ * @param {string} dateCreated
+ *
+ * @extends Entity
+ */
+class Branch extends Entity {
+ 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
+ static get hashedProperties() { return ["branchId", "noteId", "parentNoteId", "isDeleted", "prefix"]; }
+
+ async getNote() {
+ return await repository.getEntity("SELECT * FROM notes WHERE noteId = ?", [this.noteId]);
+ }
+
+ async beforeSaving() {
+ if (this.notePosition === undefined) {
+ const maxNotePos = await sql.getValue('SELECT MAX(notePosition) FROM branches WHERE parentNoteId = ? AND isDeleted = 0', [this.parentNoteId]);
+ this.notePosition = maxNotePos === null ? 0 : maxNotePos + 1;
+ }
+
+ if (!this.isDeleted) {
+ this.isDeleted = false;
+ }
+
+ if (!this.dateCreated) {
+ this.dateCreated = dateUtils.nowDate();
+ }
+
+ super.beforeSaving();
+
+ if (this.isChanged) {
+ this.dateModified = dateUtils.nowDate();
+ }
+ }
+}
+
+module.exports = Branch;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/backend_api/entities_entity.js.html b/docs/backend_api/entities_entity.js.html
new file mode 100644
index 000000000..22950d4ac
--- /dev/null
+++ b/docs/backend_api/entities_entity.js.html
@@ -0,0 +1,102 @@
+
+
+
+ JSDoc: Source: entities/entity.js
+
+
+
+
+
+
+
Source: entities/entity.js
+
+
+
+
+
+
+
+
+ "use strict";
+
+const utils = require('../services/utils');
+
+class Entity {
+ /**
+ * @param {object} [row] - database row representing given entity
+ */
+ constructor(row = {}) {
+ for (const key in row) {
+ this[key] = row[key];
+ }
+
+ if ('isDeleted' in this) {
+ this.isDeleted = !!this.isDeleted;
+ }
+ }
+
+ beforeSaving() {
+ this.generateIdIfNecessary();
+
+ const origHash = this.hash;
+
+ this.hash = this.generateHash();
+
+ this.isChanged = origHash !== this.hash;
+ }
+
+ generateIdIfNecessary() {
+ if (!this[this.constructor.primaryKeyName]) {
+ this[this.constructor.primaryKeyName] = utils.newEntityId();
+ }
+ }
+
+ generateHash() {
+ let contentToHash = "";
+
+ for (const propertyName of this.constructor.hashedProperties) {
+ contentToHash += "|" + this[propertyName];
+ }
+
+ return utils.hash(contentToHash).substr(0, 10);
+ }
+
+ async save() {
+ await require('../services/repository').updateEntity(this);
+
+ return this;
+ }
+}
+
+module.exports = Entity;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/backend_api/entities_image.js.html b/docs/backend_api/entities_image.js.html
new file mode 100644
index 000000000..162876e6c
--- /dev/null
+++ b/docs/backend_api/entities_image.js.html
@@ -0,0 +1,92 @@
+
+
+
+ JSDoc: Source: entities/image.js
+
+
+
+
+
+
+
Source: entities/image.js
+
+
+
+
+
+
+
+
+ "use strict";
+
+const Entity = require('./entity');
+const dateUtils = require('../services/date_utils');
+
+/**
+ * This class represents image data.
+ *
+ * @param {string} imageId
+ * @param {string} format
+ * @param {string} checksum
+ * @param {string} name
+ * @param {blob} data
+ * @param {boolean} isDeleted
+ * @param {string} dateModified
+ * @param {string} dateCreated
+ *
+ * @extends Entity
+ */
+class Image extends Entity {
+ static get entityName() { return "images"; }
+ static get primaryKeyName() { return "imageId"; }
+ static get hashedProperties() { return ["imageId", "format", "checksum", "name", "isDeleted", "dateCreated"]; }
+
+ beforeSaving() {
+ if (!this.isDeleted) {
+ this.isDeleted = false;
+ }
+
+ if (!this.dateCreated) {
+ this.dateCreated = dateUtils.nowDate();
+ }
+
+ super.beforeSaving();
+
+ if (this.isChanged) {
+ this.dateModified = dateUtils.nowDate();
+ }
+ }
+}
+
+module.exports = Image;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/backend_api/entities_note.js.html b/docs/backend_api/entities_note.js.html
new file mode 100644
index 000000000..0acc86d57
--- /dev/null
+++ b/docs/backend_api/entities_note.js.html
@@ -0,0 +1,589 @@
+
+
+
+ JSDoc: Source: entities/note.js
+
+
+
+
+
+
+
Source: entities/note.js
+
+
+
+
+
+
+
+
+ "use strict";
+
+const Entity = require('./entity');
+const Attribute = require('./attribute');
+const protectedSessionService = require('../services/protected_session');
+const repository = require('../services/repository');
+const dateUtils = require('../services/date_utils');
+
+const LABEL = 'label';
+const RELATION = 'relation';
+
+/**
+ * This represents a Note which is a central object in the Trilium Notes project.
+ *
+ * @property {string} noteId - primary key
+ * @property {string} type - one of "text", "code", "file" or "render"
+ * @property {string} mime - MIME type, e.g. "text/html"
+ * @property {string} title - note title
+ * @property {string} content - note content - e.g. HTML text for text notes, file payload for files
+ * @property {boolean} isProtected - true if note is protected
+ * @property {boolean} isDeleted - true if note is deleted
+ * @property {string} dateCreated
+ * @property {string} dateModified
+ *
+ * @extends Entity
+ */
+class Note extends Entity {
+ static get entityName() { return "notes"; }
+ static get primaryKeyName() { return "noteId"; }
+ static get hashedProperties() { return ["noteId", "title", "content", "type", "isProtected", "isDeleted"]; }
+
+ /**
+ * @param row - object containing database row from "notes" table
+ */
+ constructor(row) {
+ super(row);
+
+ this.isProtected = !!this.isProtected;
+
+ // check if there's noteId, otherwise this is a new entity which wasn't encrypted yet
+ if (this.isProtected && this.noteId) {
+ protectedSessionService.decryptNote(this);
+ }
+
+ this.setContent(this.content);
+ }
+
+ setContent(content) {
+ this.content = content;
+
+ try {
+ this.jsonContent = JSON.parse(this.content);
+ }
+ catch(e) {}
+ }
+
+ /** @returns {boolean} true if this note is the root of the note tree. Root note has "root" noteId */
+ isRoot() {
+ return this.noteId === 'root';
+ }
+
+ /** @returns {boolean} true if this note is of application/json content type */
+ isJson() {
+ return this.mime === "application/json";
+ }
+
+ /** @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");
+ }
+
+ /** @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} 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;
+ }
+
+ /**
+ * @returns {Promise<Attribute[]>} attributes belonging to this specific note (excludes inherited attributes)
+ */
+ async getOwnedAttributes() {
+ return await repository.getEntities(`SELECT * FROM attributes WHERE isDeleted = 0 AND noteId = ?`, [this.noteId]);
+ }
+
+ /** @returns {Promise<Attribute[]>} all note's attributes, including inherited ones */
+ async getAttributes() {
+ if (!this.__attributeCache) {
+ await this.loadAttributesToCache();
+ }
+
+ return this.__attributeCache;
+ }
+
+ /** @returns {Promise<Attribute[]>} all note's labels (attributes with type label), including inherited ones */
+ async getLabels() {
+ return (await this.getAttributes()).filter(attr => attr.type === LABEL);
+ }
+
+ /** @returns {Promise<Attribute[]>} all note's relations (attributes with type relation), including inherited ones */
+ async getRelations() {
+ return (await this.getAttributes()).filter(attr => attr.type === RELATION);
+ }
+
+ /**
+ * Clear note's attributes cache to force fresh reload for next attribute request.
+ * Cache is note instance scoped.
+ */
+ invalidateAttributeCache() {
+ this.__attributeCache = null;
+ }
+
+ /** @returns {Promise<void>} */
+ async loadAttributesToCache() {
+ const attributes = await repository.getEntities(`
+ WITH RECURSIVE
+ tree(noteId, level) AS (
+ SELECT ?, 0
+ UNION
+ SELECT branches.parentNoteId, tree.level + 1 FROM branches
+ JOIN tree ON branches.noteId = tree.noteId
+ JOIN notes ON notes.noteId = branches.parentNoteId
+ WHERE notes.isDeleted = 0
+ AND branches.isDeleted = 0
+ ),
+ treeWithAttrs(noteId, level) AS (
+ SELECT * FROM tree
+ UNION
+ SELECT attributes.value, treeWithAttrs.level + 1 FROM attributes
+ JOIN treeWithAttrs ON treeWithAttrs.noteId = attributes.noteId
+ WHERE attributes.isDeleted = 0
+ AND attributes.type = 'relation'
+ AND attributes.name = 'template'
+ AND (attributes.noteId = ? OR attributes.isInheritable = 1)
+ )
+ SELECT attributes.* FROM attributes JOIN treeWithAttrs ON attributes.noteId = treeWithAttrs.noteId
+ WHERE attributes.isDeleted = 0 AND (attributes.isInheritable = 1 OR attributes.noteId = ?)
+ ORDER BY level, noteId, position`, [this.noteId, this.noteId, this.noteId]);
+ // attributes are ordered so that "closest" attributes are first
+ // we order by noteId so that attributes from same note stay together. Actual noteId ordering doesn't matter.
+
+ const filteredAttributes = attributes.filter((attr, index) => {
+ if (attr.isDefinition()) {
+ const firstDefinitionIndex = attributes.findIndex(el => el.type === attr.type && el.name === attr.name);
+
+ // keep only if this element is the first definition for this type & name
+ return firstDefinitionIndex === index;
+ }
+ else {
+ const definitionAttr = attributes.find(el => el.type === attr.type + '-definition' && el.name === attr.name);
+
+ if (!definitionAttr) {
+ return true;
+ }
+
+ const definition = definitionAttr.value;
+
+ if (definition.multiplicityType === 'multivalue') {
+ return true;
+ }
+ else {
+ const firstAttrIndex = attributes.findIndex(el => el.type === attr.type && el.name === attr.name);
+
+ // in case of single-valued attribute we'll keep it only if it's first (closest)
+ return firstAttrIndex === index;
+ }
+ }
+ });
+
+ for (const attr of filteredAttributes) {
+ attr.isOwned = attr.noteId === this.noteId;
+ }
+
+ this.__attributeCache = filteredAttributes;
+ }
+
+ /**
+ * @param {string} type - attribute type (label, relation, etc.)
+ * @param {string} name - attribute name
+ * @returns {Promise<boolean>} 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>} 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<string>} 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;
+ }
+
+ /**
+ * Based on enabled, attribute is either set or removed.
+ *
+ * @param {string} type - attribute type ('relation', 'label' etc.)
+ * @param {boolean} enabled - toggle On or Off
+ * @param {string} name - attribute name
+ * @param {string} [value] - attribute value (optional)
+ * @returns {Promise<void>}
+ */
+ async toggleAttribute(type, enabled, name, value) {
+ if (enabled) {
+ await this.setAttribute(type, name, value);
+ }
+ else {
+ await this.removeAttribute(type, name, value);
+ }
+ }
+
+ /**
+ * Creates given attribute name-value pair if it doesn't exist.
+ *
+ * @param {string} type - attribute type (label, relation, etc.)
+ * @param {string} name - attribute name
+ * @param {string} [value] - attribute value (optional)
+ * @returns {Promise<void>}
+ */
+ async setAttribute(type, name, value) {
+ const attributes = await this.getOwnedAttributes();
+ let attr = attributes.find(attr => attr.type === type && (value === undefined || attr.value === value));
+
+ if (!attr) {
+ attr = new Attribute({
+ noteId: this.noteId,
+ type: type,
+ name: name,
+ value: value !== undefined ? value : ""
+ });
+
+ await attr.save();
+
+ this.invalidateAttributeCache();
+ }
+ }
+
+ /**
+ * Removes given attribute name-value pair if it exists.
+ *
+ * @param {string} type - attribute type (label, relation, etc.)
+ * @param {string} name - attribute name
+ * @param {string} [value] - attribute value (optional)
+ * @returns {Promise<void>}
+ */
+ async removeAttribute(type, name, value) {
+ const attributes = await this.getOwnedAttributes();
+
+ for (const attribute of attributes) {
+ if (attribute.type === type && (value === undefined || value === attribute.value)) {
+ attribute.isDeleted = true;
+ await attribute.save();
+
+ this.invalidateAttributeCache();
+ }
+ }
+ }
+
+ /**
+ * @param {string} name - label name
+ * @returns {Promise<boolean>} true if label exists (including inherited)
+ */
+ async hasLabel(name) { return await this.hasAttribute(LABEL, name); }
+
+ /**
+ * @param {string} name - relation name
+ * @returns {Promise<boolean>} true if relation exists (including inherited)
+ */
+ async hasRelation(name) { return await this.hasAttribute(RELATION, name); }
+
+ /**
+ * @param {string} name - label name
+ * @returns {Promise<Attribute>} label if it exists, null otherwise
+ */
+ async getLabel(name) { return await this.getAttribute(LABEL, name); }
+
+ /**
+ * @param {string} name - relation name
+ * @returns {Promise<Attribute>} relation if it exists, null otherwise
+ */
+ async getRelation(name) { return await this.getAttribute(RELATION, name); }
+
+ /**
+ * @param {string} name - label name
+ * @returns {Promise<string>} label value if label exists, null otherwise
+ */
+ async getLabelValue(name) { return await this.getAttributeValue(LABEL, name); }
+
+ /**
+ * @param {string} name - relation name
+ * @returns {Promise<string>} relation value if relation exists, null otherwise
+ */
+ async getRelationValue(name) { return await this.getAttributeValue(RELATION, name); }
+
+ /**
+ * Based on enabled, label is either set or removed.
+ *
+ * @param {boolean} enabled - toggle On or Off
+ * @param {string} name - label name
+ * @param {string} [value] - label value (optional)
+ * @returns {Promise<void>}
+ */
+ async toggleLabel(enabled, name, value) { return await this.toggleAttribute(LABEL, enabled, name, value); }
+
+ /**
+ * Based on enabled, relation is either set or removed.
+ *
+ * @param {boolean} enabled - toggle On or Off
+ * @param {string} name - relation name
+ * @param {string} [value] - relation value (noteId)
+ * @returns {Promise<void>}
+ */
+ async toggleRelation(enabled, name, value) { return await this.toggleAttribute(RELATION, enabled, name, value); }
+
+ /**
+ * Create label name-value pair if it doesn't exist yet.
+ *
+ * @param {string} name - label name
+ * @param {string} [value] - label value
+ * @returns {Promise<void>}
+ */
+ async setLabel(name, value) { return await this.setAttribute(LABEL, name, value); }
+
+ /**
+ * Create relation name-value pair if it doesn't exist yet.
+ *
+ * @param {string} name - relation name
+ * @param {string} [value] - relation value (noteId)
+ * @returns {Promise<void>}
+ */
+ async setRelation(name, value) { return await this.setAttribute(RELATION, name, value); }
+
+ /**
+ * Remove label name-value pair, if it exists.
+ *
+ * @param {string} name - label name
+ * @param {string} [value] - label value
+ * @returns {Promise<void>}
+ */
+ async removeLabel(name, value) { return await this.removeAttribute(LABEL, name, value); }
+
+ /**
+ * Remove relation name-value pair, if it exists.
+ *
+ * @param {string} name - relation name
+ * @param {string} [value] - relation value (noteId)
+ * @returns {Promise<void>}
+ */
+ async removeRelation(name, value) { return await this.removeAttribute(RELATION, name, value); }
+
+ /**
+ * @param {string} name
+ * @returns {Promise<Note>|null} target note of the relation or null (if target is empty or note was not found)
+ */
+ async getRelationTarget(name) {
+ const relation = await this.getRelation(name);
+
+ return relation ? await repository.getNote(relation.value) : null;
+ }
+
+ /**
+ * Finds notes with given attribute name and value. Only own attributes are considered, not inherited ones
+ *
+ * @param {string} type - attribute type (label, relation, etc.)
+ * @param {string} name - attribute name
+ * @param {string} [value] - attribute value
+ * @returns {Promise<Note[]>}
+ */
+ async findNotesWithAttribute(type, name, value) {
+ const params = [this.noteId, name];
+ let valueCondition = "";
+
+ if (value !== undefined) {
+ params.push(value);
+ valueCondition = " AND attributes.value = ?";
+ }
+
+ const notes = await repository.getEntities(`
+ WITH RECURSIVE
+ tree(noteId) AS (
+ SELECT ?
+ UNION
+ SELECT branches.noteId FROM branches
+ JOIN tree ON branches.parentNoteId = tree.noteId
+ JOIN notes ON notes.noteId = branches.noteId
+ WHERE notes.isDeleted = 0
+ AND branches.isDeleted = 0
+ )
+ SELECT notes.* FROM notes
+ JOIN tree ON tree.noteId = notes.noteId
+ JOIN attributes ON attributes.noteId = notes.noteId
+ WHERE attributes.isDeleted = 0
+ AND attributes.name = ?
+ ${valueCondition}
+ ORDER BY noteId, position`, params);
+
+ return notes;
+ }
+
+ /**
+ * Finds notes with given label name and value. Only own labels are considered, not inherited ones
+ *
+ * @param {string} name - label name
+ * @param {string} [value] - label value
+ * @returns {Promise<Note[]>}
+ */
+ async findNotesWithLabel(name, value) { return await this.findNotesWithAttribute(LABEL, name, value); }
+
+ /**
+ * Finds notes with given relation name and value. Only own relations are considered, not inherited ones
+ *
+ * @param {string} name - relation name
+ * @param {string} [value] - relation value
+ * @returns {Promise<Note[]>}
+ */
+ async findNotesWithRelation(name, value) { return await this.findNotesWithAttribute(RELATION, name, value); }
+
+ /**
+ * Returns note revisions of this note.
+ *
+ * @returns {Promise<NoteRevision[]>}
+ */
+ async getRevisions() {
+ return await repository.getEntities("SELECT * FROM note_revisions WHERE noteId = ?", [this.noteId]);
+ }
+
+ /**
+ * @returns {Promise<NoteImage[]>}
+ */
+ async getNoteImages() {
+ return await repository.getEntities("SELECT * FROM note_images WHERE noteId = ? AND isDeleted = 0", [this.noteId]);
+ }
+
+ /**
+ * @returns {Promise<Branch[]>}
+ */
+ async getBranches() {
+ return await repository.getEntities("SELECT * FROM branches WHERE isDeleted = 0 AND noteId = ?", [this.noteId]);
+ }
+
+ /**
+ * @returns {Promise<Note[]>} child notes of this note
+ */
+ async getChildNotes() {
+ return await repository.getEntities(`
+ SELECT notes.*
+ FROM branches
+ JOIN notes USING(noteId)
+ WHERE notes.isDeleted = 0
+ AND branches.isDeleted = 0
+ AND branches.parentNoteId = ?
+ ORDER BY branches.notePosition`, [this.noteId]);
+ }
+
+ /**
+ * @returns {Promise<Branch[]>} child branches of this note
+ */
+ async getChildBranches() {
+ return await repository.getEntities(`
+ SELECT branches.*
+ FROM branches
+ WHERE branches.isDeleted = 0
+ AND branches.parentNoteId = ?
+ ORDER BY branches.notePosition`, [this.noteId]);
+ }
+
+ /**
+ * @returns {Promise<Note[]>} parent notes of this note (note can have multiple parents because of cloning)
+ */
+ async getParentNotes() {
+ return await repository.getEntities(`
+ SELECT parent_notes.*
+ FROM
+ branches AS child_tree
+ JOIN notes AS parent_notes ON parent_notes.noteId = child_tree.parentNoteId
+ WHERE child_tree.noteId = ?
+ AND child_tree.isDeleted = 0
+ AND parent_notes.isDeleted = 0`, [this.noteId]);
+ }
+
+ beforeSaving() {
+ if (this.isJson() && this.jsonContent) {
+ this.content = JSON.stringify(this.jsonContent, null, '\t');
+ }
+
+ // we do this here because encryption needs the note ID for the IV
+ this.generateIdIfNecessary();
+
+ if (this.isProtected) {
+ protectedSessionService.encryptNote(this);
+ }
+
+ if (!this.isDeleted) {
+ this.isDeleted = false;
+ }
+
+ if (!this.dateCreated) {
+ this.dateCreated = dateUtils.nowDate();
+ }
+
+ super.beforeSaving();
+
+ if (this.isChanged) {
+ this.dateModified = dateUtils.nowDate();
+ }
+ }
+}
+
+module.exports = Note;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/backend_api/entities_note_image.js.html b/docs/backend_api/entities_note_image.js.html
new file mode 100644
index 000000000..837bd72d2
--- /dev/null
+++ b/docs/backend_api/entities_note_image.js.html
@@ -0,0 +1,99 @@
+
+
+
+ JSDoc: Source: entities/note_image.js
+
+
+
+
+
+
+
Source: entities/note_image.js
+
+
+
+
+
+
+
+
+ "use strict";
+
+const Entity = require('./entity');
+const repository = require('../services/repository');
+const dateUtils = require('../services/date_utils');
+
+/**
+ * This class represents image's placement in the note(s). One image may be placed into several notes.
+ *
+ * @param {string} noteImageId
+ * @param {string} noteId
+ * @param {string} imageId
+ * @param {boolean} isDeleted
+ * @param {string} dateModified
+ * @param {string} dateCreated
+ *
+ * @extends Entity
+ */
+class NoteImage extends Entity {
+ static get entityName() { return "note_images"; }
+ static get primaryKeyName() { return "noteImageId"; }
+ static get hashedProperties() { return ["noteImageId", "noteId", "imageId", "isDeleted", "dateCreated"]; }
+
+ async getNote() {
+ return await repository.getEntity("SELECT * FROM notes WHERE noteId = ?", [this.noteId]);
+ }
+
+ async getImage() {
+ return await repository.getEntity("SELECT * FROM images WHERE imageId = ?", [this.imageId]);
+ }
+
+ beforeSaving() {
+ if (!this.isDeleted) {
+ this.isDeleted = false;
+ }
+
+ if (!this.dateCreated) {
+ this.dateCreated = dateUtils.nowDate();
+ }
+
+ super.beforeSaving();
+
+ if (this.isChanged) {
+ this.dateModified = dateUtils.nowDate();
+ }
+ }
+}
+
+module.exports = NoteImage;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/backend_api/entities_note_revision.js.html b/docs/backend_api/entities_note_revision.js.html
new file mode 100644
index 000000000..cf2e8a7c2
--- /dev/null
+++ b/docs/backend_api/entities_note_revision.js.html
@@ -0,0 +1,100 @@
+
+
+
+ JSDoc: Source: entities/note_revision.js
+
+
+
+
+
+
+
Source: entities/note_revision.js
+
+
+
+
+
+
+
+
+ "use strict";
+
+const Entity = require('./entity');
+const protectedSessionService = require('../services/protected_session');
+const repository = require('../services/repository');
+
+/**
+ * NoteRevision represents snapshot of note's title and content at some point in the past. It's used for seamless note versioning.
+ *
+ * @param {string} noteRevisionId
+ * @param {string} noteId
+ * @param {string} type
+ * @param {string} mime
+ * @param {string} title
+ * @param {string} content
+ * @param {string} isProtected
+ * @param {string} dateModifiedFrom
+ * @param {string} dateModifiedTo
+ *
+ * @extends Entity
+ */
+class NoteRevision extends Entity {
+ static get entityName() { return "note_revisions"; }
+ static get primaryKeyName() { return "noteRevisionId"; }
+ static get hashedProperties() { return ["noteRevisionId", "noteId", "title", "content", "isProtected", "dateModifiedFrom", "dateModifiedTo"]; }
+
+ constructor(row) {
+ super(row);
+
+ this.isProtected = !!this.isProtected;
+
+ if (this.isProtected) {
+ protectedSessionService.decryptNoteRevision(this);
+ }
+ }
+
+ async getNote() {
+ return await repository.getEntity("SELECT * FROM notes WHERE noteId = ?", [this.noteId]);
+ }
+
+ beforeSaving() {
+ if (this.isProtected) {
+ protectedSessionService.encryptNoteRevision(this);
+ }
+
+ super.beforeSaving();
+ }
+}
+
+module.exports = NoteRevision;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/backend_api/entities_option.js.html b/docs/backend_api/entities_option.js.html
new file mode 100644
index 000000000..b875e8335
--- /dev/null
+++ b/docs/backend_api/entities_option.js.html
@@ -0,0 +1,87 @@
+
+
+
+ JSDoc: Source: entities/option.js
+
+
+
+
+
+
+
Source: entities/option.js
+
+
+
+
+
+
+
+
+ "use strict";
+
+const Entity = require('./entity');
+const dateUtils = require('../services/date_utils');
+
+/**
+ * Option represents name-value pair, either directly configurable by the user or some system property.
+ *
+ * @param {string} name
+ * @param {string} value
+ * @param {boolean} isSynced
+ * @param {string} dateModified
+ * @param {string} dateCreated
+ *
+ * @extends Entity
+ */
+class Option extends Entity {
+ static get entityName() { return "options"; }
+ static get primaryKeyName() { return "name"; }
+ static get hashedProperties() { return ["name", "value"]; }
+
+ constructor(row) {
+ super(row);
+
+ this.isSynced = !!this.isSynced;
+ }
+
+ beforeSaving() {
+ super.beforeSaving();
+
+ if (this.isChanged) {
+ this.dateModified = dateUtils.nowDate();
+ }
+ }
+}
+
+module.exports = Option;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/backend_api/entities_recent_note.js.html b/docs/backend_api/entities_recent_note.js.html
new file mode 100644
index 000000000..8353b2ca5
--- /dev/null
+++ b/docs/backend_api/entities_recent_note.js.html
@@ -0,0 +1,84 @@
+
+
+
+ JSDoc: Source: entities/recent_note.js
+
+
+
+
+
+
+
Source: entities/recent_note.js
+
+
+
+
+
+
+
+
+ "use strict";
+
+const Entity = require('./entity');
+const dateUtils = require('../services/date_utils');
+
+/**
+ * RecentNote represents recently visited note.
+ *
+ * @param {string} branchId
+ * @param {string} notePath
+ * @param {boolean} isDeleted
+ * @param {string} dateModified
+ *
+ * @extends Entity
+ */
+class RecentNote extends Entity {
+ static get entityName() { return "recent_notes"; }
+ static get primaryKeyName() { return "branchId"; }
+ static get hashedProperties() { return ["branchId", "notePath", "dateCreated", "isDeleted"]; }
+
+ beforeSaving() {
+ if (!this.isDeleted) {
+ this.isDeleted = false;
+ }
+
+ if (!this.dateCreated) {
+ this.dateCreated = dateUtils.nowDate();
+ }
+
+ super.beforeSaving();
+ }
+}
+
+module.exports = RecentNote;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/backend_api/fonts/OpenSans-Bold-webfont.eot b/docs/backend_api/fonts/OpenSans-Bold-webfont.eot
new file mode 100644
index 000000000..5d20d9163
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-Bold-webfont.eot differ
diff --git a/docs/backend_api/fonts/OpenSans-Bold-webfont.svg b/docs/backend_api/fonts/OpenSans-Bold-webfont.svg
new file mode 100644
index 000000000..3ed7be4bc
--- /dev/null
+++ b/docs/backend_api/fonts/OpenSans-Bold-webfont.svg
@@ -0,0 +1,1830 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/fonts/OpenSans-Bold-webfont.woff b/docs/backend_api/fonts/OpenSans-Bold-webfont.woff
new file mode 100644
index 000000000..1205787b0
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-Bold-webfont.woff differ
diff --git a/docs/backend_api/fonts/OpenSans-BoldItalic-webfont.eot b/docs/backend_api/fonts/OpenSans-BoldItalic-webfont.eot
new file mode 100644
index 000000000..1f639a15f
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-BoldItalic-webfont.eot differ
diff --git a/docs/backend_api/fonts/OpenSans-BoldItalic-webfont.svg b/docs/backend_api/fonts/OpenSans-BoldItalic-webfont.svg
new file mode 100644
index 000000000..6a2607b9d
--- /dev/null
+++ b/docs/backend_api/fonts/OpenSans-BoldItalic-webfont.svg
@@ -0,0 +1,1830 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/fonts/OpenSans-BoldItalic-webfont.woff b/docs/backend_api/fonts/OpenSans-BoldItalic-webfont.woff
new file mode 100644
index 000000000..ed760c062
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-BoldItalic-webfont.woff differ
diff --git a/docs/backend_api/fonts/OpenSans-Italic-webfont.eot b/docs/backend_api/fonts/OpenSans-Italic-webfont.eot
new file mode 100644
index 000000000..0c8a0ae06
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-Italic-webfont.eot differ
diff --git a/docs/backend_api/fonts/OpenSans-Italic-webfont.svg b/docs/backend_api/fonts/OpenSans-Italic-webfont.svg
new file mode 100644
index 000000000..e1075dcc2
--- /dev/null
+++ b/docs/backend_api/fonts/OpenSans-Italic-webfont.svg
@@ -0,0 +1,1830 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/fonts/OpenSans-Italic-webfont.woff b/docs/backend_api/fonts/OpenSans-Italic-webfont.woff
new file mode 100644
index 000000000..ff652e643
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-Italic-webfont.woff differ
diff --git a/docs/backend_api/fonts/OpenSans-Light-webfont.eot b/docs/backend_api/fonts/OpenSans-Light-webfont.eot
new file mode 100644
index 000000000..14868406a
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-Light-webfont.eot differ
diff --git a/docs/backend_api/fonts/OpenSans-Light-webfont.svg b/docs/backend_api/fonts/OpenSans-Light-webfont.svg
new file mode 100644
index 000000000..11a472ca8
--- /dev/null
+++ b/docs/backend_api/fonts/OpenSans-Light-webfont.svg
@@ -0,0 +1,1831 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/fonts/OpenSans-Light-webfont.woff b/docs/backend_api/fonts/OpenSans-Light-webfont.woff
new file mode 100644
index 000000000..e78607481
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-Light-webfont.woff differ
diff --git a/docs/backend_api/fonts/OpenSans-LightItalic-webfont.eot b/docs/backend_api/fonts/OpenSans-LightItalic-webfont.eot
new file mode 100644
index 000000000..8f445929f
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-LightItalic-webfont.eot differ
diff --git a/docs/backend_api/fonts/OpenSans-LightItalic-webfont.svg b/docs/backend_api/fonts/OpenSans-LightItalic-webfont.svg
new file mode 100644
index 000000000..431d7e354
--- /dev/null
+++ b/docs/backend_api/fonts/OpenSans-LightItalic-webfont.svg
@@ -0,0 +1,1835 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/fonts/OpenSans-LightItalic-webfont.woff b/docs/backend_api/fonts/OpenSans-LightItalic-webfont.woff
new file mode 100644
index 000000000..43e8b9e6c
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-LightItalic-webfont.woff differ
diff --git a/docs/backend_api/fonts/OpenSans-Regular-webfont.eot b/docs/backend_api/fonts/OpenSans-Regular-webfont.eot
new file mode 100644
index 000000000..6bbc3cf58
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-Regular-webfont.eot differ
diff --git a/docs/backend_api/fonts/OpenSans-Regular-webfont.svg b/docs/backend_api/fonts/OpenSans-Regular-webfont.svg
new file mode 100644
index 000000000..25a395234
--- /dev/null
+++ b/docs/backend_api/fonts/OpenSans-Regular-webfont.svg
@@ -0,0 +1,1831 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/fonts/OpenSans-Regular-webfont.woff b/docs/backend_api/fonts/OpenSans-Regular-webfont.woff
new file mode 100644
index 000000000..e231183dc
Binary files /dev/null and b/docs/backend_api/fonts/OpenSans-Regular-webfont.woff differ
diff --git a/docs/backend_api/global.html b/docs/backend_api/global.html
new file mode 100644
index 000000000..103072b40
--- /dev/null
+++ b/docs/backend_api/global.html
@@ -0,0 +1,603 @@
+
+
+
+ JSDoc: Global
+
+
+
+
+
+
+
Global
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Type Definitions
+
+
+
+CreateNoteAttribute
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute type - label, relation etc.
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ attribute name
+
+
+
+
+
+
+ value
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ attribute value
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+ Default
+
+
+ Description
+
+
+
+
+
+
+
+
+ json
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+ false
+
+
+
+
+ should the note be JSON
+
+
+
+
+
+
+ isProtected
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+ false
+
+
+
+
+ should the note be protected
+
+
+
+
+
+
+ type
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+ 'text'
+
+
+
+
+ note type
+
+
+
+
+
+
+ mime
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+ 'text/html'
+
+
+
+
+ MIME type of the note
+
+
+
+
+
+
+ attributes
+
+
+Array.<CreateNoteAttribute >
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+ []
+
+
+
+
+ attributes to be created for this note
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/index.html b/docs/backend_api/index.html
new file mode 100644
index 000000000..5c4e117d4
--- /dev/null
+++ b/docs/backend_api/index.html
@@ -0,0 +1,65 @@
+
+
+
+ JSDoc: Home
+
+
+
+
+
+
+
Home
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/backend_api/scripts/linenumber.js b/docs/backend_api/scripts/linenumber.js
new file mode 100644
index 000000000..8d52f7eaf
--- /dev/null
+++ b/docs/backend_api/scripts/linenumber.js
@@ -0,0 +1,25 @@
+/*global document */
+(function() {
+ var source = document.getElementsByClassName('prettyprint source linenums');
+ var i = 0;
+ var lineNumber = 0;
+ var lineId;
+ var lines;
+ var totalLines;
+ var anchorHash;
+
+ if (source && source[0]) {
+ anchorHash = document.location.hash.substring(1);
+ lines = source[0].getElementsByTagName('li');
+ totalLines = lines.length;
+
+ for (; i < totalLines; i++) {
+ lineNumber++;
+ lineId = 'line' + lineNumber;
+ lines[i].id = lineId;
+ if (lineId === anchorHash) {
+ lines[i].className += ' selected';
+ }
+ }
+ }
+})();
diff --git a/docs/backend_api/scripts/prettify/Apache-License-2.0.txt b/docs/backend_api/scripts/prettify/Apache-License-2.0.txt
new file mode 100644
index 000000000..d64569567
--- /dev/null
+++ b/docs/backend_api/scripts/prettify/Apache-License-2.0.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/docs/backend_api/scripts/prettify/lang-css.js b/docs/backend_api/scripts/prettify/lang-css.js
new file mode 100644
index 000000000..041e1f590
--- /dev/null
+++ b/docs/backend_api/scripts/prettify/lang-css.js
@@ -0,0 +1,2 @@
+PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
+/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);
diff --git a/docs/backend_api/scripts/prettify/prettify.js b/docs/backend_api/scripts/prettify/prettify.js
new file mode 100644
index 000000000..eef5ad7e6
--- /dev/null
+++ b/docs/backend_api/scripts/prettify/prettify.js
@@ -0,0 +1,28 @@
+var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
+(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
+[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
+l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
+q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
+q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
+"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
+a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
+for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
+"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
+H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
+J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
+I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
+["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
+/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
+["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
+hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b=
+!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p
+
+
+ JSDoc: Source: services/backend_script_api.js
+
+
+
+
+
+
+
Source: services/backend_script_api.js
+
+
+
+
+
+
+
+
+ const log = require('./log');
+const noteService = require('./notes');
+const sql = require('./sql');
+const utils = require('./utils');
+const dateUtils = require('./date_utils');
+const attributeService = require('./attributes');
+const dateNoteService = require('./date_notes');
+const treeService = require('./tree');
+const config = require('./config');
+const repository = require('./repository');
+const axios = require('axios');
+const cloningService = require('./cloning');
+const messagingService = require('./messaging');
+
+/**
+ * This is the main backend API interface for scripts. It's published in the local "api" object.
+ *
+ * @constructor
+ * @hideconstructor
+ */
+function BackendScriptApi(startNote, currentNote, originEntity) {
+ /** @property {Note} note where script started executing */
+ this.startNote = startNote;
+ /** @property {Note} note where script is currently executing */
+ this.currentNote = currentNote;
+ /** @property {Entity} entity whose event triggered this executions */
+ this.originEntity = originEntity;
+
+ this.axios = axios;
+
+ this.utils = {
+ unescapeHtml: utils.unescapeHtml,
+ isoDateTimeStr: dateUtils.dateStr,
+ isoDateStr: date => dateUtils.dateStr(date).substr(0, 10)
+ };
+
+ /**
+ * Instance name identifies particular Trilium instance. It can be useful for scripts
+ * if some action needs to happen on only one specific instance.
+ *
+ * @returns {string|null}
+ */
+ this.getInstanceName = () => config.General ? config.General.instanceName : null;
+
+ /**
+ * @method
+ * @param {string} noteId
+ * @returns {Promise<Note|null>}
+ */
+ this.getNote = repository.getNote;
+
+ /**
+ * @method
+ * @param {string} branchId
+ * @returns {Promise<Branch|null>}
+ */
+ this.getBranch = repository.getBranch;
+
+ /**
+ * @method
+ * @param {string} attributeId
+ * @returns {Promise<Attribute|null>}
+ */
+ this.getAttribute = repository.getAttribute;
+
+ /**
+ * @method
+ * @param {string} imageId
+ * @returns {Promise<Image|null>}
+ */
+ this.getImage = repository.getImage;
+
+ /**
+ * Retrieves first entity from the SQL's result set.
+ *
+ * @method
+ * @param {string} SQL query
+ * @param {Array.<?>} array of params
+ * @returns {Promise<Entity|null>}
+ */
+ this.getEntity = repository.getEntity;
+
+ /**
+ * @method
+ * @param {string} SQL query
+ * @param {Array.<?>} array of params
+ * @returns {Promise<Entity[]>}
+ */
+ this.getEntities = repository.getEntities;
+
+ /**
+ * Retrieves notes with given label name & value
+ *
+ * @method
+ * @param {string} name - attribute name
+ * @param {string} [value] - attribute value
+ * @returns {Promise<Note[]>}
+ */
+ this.getNotesWithLabel = attributeService.getNotesWithLabel;
+
+ /**
+ * Retrieves first note with given label name & value
+ *
+ * @method
+ * @param {string} name - attribute name
+ * @param {string} [value] - attribute value
+ * @returns {Promise<Note|null>}
+ */
+ this.getNoteWithLabel = attributeService.getNoteWithLabel;
+
+ /**
+ * If there's no branch between note and parent note, create one. Otherwise do nothing.
+ *
+ * @method
+ * @param {string} noteId
+ * @param {string} parentNoteId
+ * @param {string} prefix - if branch will be create between note and parent note, set this prefix
+ * @returns {Promise<void>}
+ */
+ this.ensureNoteIsPresentInParent = cloningService.ensureNoteIsPresentInParent;
+
+ /**
+ * If there's a branch between note and parent note, remove it. Otherwise do nothing.
+ *
+ * @method
+ * @param {string} noteId
+ * @param {string} parentNoteId
+ * @returns {Promise<void>}
+ */
+ this.ensureNoteIsAbsentFromParent = cloningService.ensureNoteIsAbsentFromParent;
+
+ /**
+ * Based on the value, either create or remove branch between note and parent note.
+ *
+ * @method
+ * @param {boolean} present - true if we want the branch to exist, false if we want it gone
+ * @param {string} noteId
+ * @param {string} parentNoteId
+ * @param {string} prefix - if branch will be create between note and parent note, set this prefix
+ * @returns {Promise<void>}
+ */
+ this.toggleNoteInParent = cloningService.toggleNoteInParent;
+
+ /**
+ * @typedef {object} CreateNoteAttribute
+ * @property {string} type - attribute type - label, relation etc.
+ * @property {string} name - attribute name
+ * @property {string} [value] - attribute value
+ */
+
+ /**
+ * @typedef {object} CreateNoteExtraOptions
+ * @property {boolean} [json=false] - should the note be JSON
+ * @property {boolean} [isProtected=false] - should the note be protected
+ * @property {string} [type='text'] - note type
+ * @property {string} [mime='text/html'] - MIME type of the note
+ * @property {CreateNoteAttribute[]} [attributes=[]] - attributes to be created for this note
+ */
+
+ /**
+ * @method
+ *
+ * @param {string} parentNoteId - create new note under this parent
+ * @param {string} title
+ * @param {string} [content=""]
+ * @param {CreateNoteExtraOptions} [extraOptions={}]
+ * @returns {Promise<{note: Note, branch: Branch}>} object contains newly created entities note and branch
+ */
+ this.createNote = noteService.createNote;
+
+ /**
+ * Log given message to trilium logs.
+ *
+ * @param message
+ */
+ this.log = message => log.info(`Script "${currentNote.title}" (${currentNote.noteId}): ${message}`);
+
+ /**
+ * Returns root note of the calendar.
+ *
+ * @method
+ * @returns {Promise<Note|null>}
+ */
+ this.getRootCalendarNote = dateNoteService.getRootCalendarNote;
+
+ /**
+ * Returns day note for given date (YYYY-MM-DD format). If such note doesn't exist, it is created.
+ *
+ * @method
+ * @param {string} date
+ * @returns {Promise<Note|null>}
+ */
+ this.getDateNote = dateNoteService.getDateNote;
+
+ /**
+ * @method
+ * @param {string} parentNoteId - this note's child notes will be sorted
+ * @returns Promise<void>
+ */
+ this.sortNotesAlphabetically = treeService.sortNotesAlphabetically;
+
+ /**
+ * This method finds note by its noteId and prefix and either sets it to the given parentNoteId
+ * or removes the branch (if parentNoteId is not given).
+ *
+ * This method looks similar to toggleNoteInParent() but differs because we're looking up branch by prefix.
+ *
+ * @method
+ * @param {string} noteId
+ * @param {string} prefix
+ * @param {string} [parentNoteId]
+ */
+ this.setNoteToParent = treeService.setNoteToParent;
+
+ /**
+ * This functions wraps code which is supposed to be running in transaction. If transaction already
+ * exists, then we'll use that transaction.
+ *
+ * This method is required only when script has label manualTransactionHandling, all other scripts are
+ * transactional by default.
+ *
+ * @method
+ * @param {function} func
+ * @returns {Promise<?>} result of func callback
+ */
+ this.transactional = sql.transactional;
+
+ /**
+ * Trigger tree refresh in all connected clients. This is required when some tree change happens in
+ * the backend.
+ *
+ * @returns {Promise<void>}
+ */
+ this.refreshTree = () => messagingService.sendMessageToAllClients({ type: 'refresh-tree' });
+}
+
+module.exports = BackendScriptApi;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/backend_api/styles/jsdoc-default.css b/docs/backend_api/styles/jsdoc-default.css
new file mode 100644
index 000000000..9207bc824
--- /dev/null
+++ b/docs/backend_api/styles/jsdoc-default.css
@@ -0,0 +1,358 @@
+@font-face {
+ font-family: 'Open Sans';
+ font-weight: normal;
+ font-style: normal;
+ src: url('../fonts/OpenSans-Regular-webfont.eot');
+ src:
+ local('Open Sans'),
+ local('OpenSans'),
+ url('../fonts/OpenSans-Regular-webfont.eot?#iefix') format('embedded-opentype'),
+ url('../fonts/OpenSans-Regular-webfont.woff') format('woff'),
+ url('../fonts/OpenSans-Regular-webfont.svg#open_sansregular') format('svg');
+}
+
+@font-face {
+ font-family: 'Open Sans Light';
+ font-weight: normal;
+ font-style: normal;
+ src: url('../fonts/OpenSans-Light-webfont.eot');
+ src:
+ local('Open Sans Light'),
+ local('OpenSans Light'),
+ url('../fonts/OpenSans-Light-webfont.eot?#iefix') format('embedded-opentype'),
+ url('../fonts/OpenSans-Light-webfont.woff') format('woff'),
+ url('../fonts/OpenSans-Light-webfont.svg#open_sanslight') format('svg');
+}
+
+html
+{
+ overflow: auto;
+ background-color: #fff;
+ font-size: 14px;
+}
+
+body
+{
+ font-family: 'Open Sans', sans-serif;
+ line-height: 1.5;
+ color: #4d4e53;
+ background-color: white;
+}
+
+a, a:visited, a:active {
+ color: #0095dd;
+ text-decoration: none;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+header
+{
+ display: block;
+ padding: 0px 4px;
+}
+
+tt, code, kbd, samp {
+ font-family: Consolas, Monaco, 'Andale Mono', monospace;
+}
+
+.class-description {
+ font-size: 130%;
+ line-height: 140%;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+.class-description:empty {
+ margin: 0;
+}
+
+#main {
+ float: left;
+ width: 70%;
+}
+
+article dl {
+ margin-bottom: 40px;
+}
+
+article img {
+ max-width: 100%;
+}
+
+section
+{
+ display: block;
+ background-color: #fff;
+ padding: 12px 24px;
+ border-bottom: 1px solid #ccc;
+ margin-right: 30px;
+}
+
+.variation {
+ display: none;
+}
+
+.signature-attributes {
+ font-size: 60%;
+ color: #aaa;
+ font-style: italic;
+ font-weight: lighter;
+}
+
+nav
+{
+ display: block;
+ float: right;
+ margin-top: 28px;
+ width: 30%;
+ box-sizing: border-box;
+ border-left: 1px solid #ccc;
+ padding-left: 16px;
+}
+
+nav ul {
+ font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif;
+ font-size: 100%;
+ line-height: 17px;
+ padding: 0;
+ margin: 0;
+ list-style-type: none;
+}
+
+nav ul a, nav ul a:visited, nav ul a:active {
+ font-family: Consolas, Monaco, 'Andale Mono', monospace;
+ line-height: 18px;
+ color: #4D4E53;
+}
+
+nav h3 {
+ margin-top: 12px;
+}
+
+nav li {
+ margin-top: 6px;
+}
+
+footer {
+ display: block;
+ padding: 6px;
+ margin-top: 12px;
+ font-style: italic;
+ font-size: 90%;
+}
+
+h1, h2, h3, h4 {
+ font-weight: 200;
+ margin: 0;
+}
+
+h1
+{
+ font-family: 'Open Sans Light', sans-serif;
+ font-size: 48px;
+ letter-spacing: -2px;
+ margin: 12px 24px 20px;
+}
+
+h2, h3.subsection-title
+{
+ font-size: 30px;
+ font-weight: 700;
+ letter-spacing: -1px;
+ margin-bottom: 12px;
+}
+
+h3
+{
+ font-size: 24px;
+ letter-spacing: -0.5px;
+ margin-bottom: 12px;
+}
+
+h4
+{
+ font-size: 18px;
+ letter-spacing: -0.33px;
+ margin-bottom: 12px;
+ color: #4d4e53;
+}
+
+h5, .container-overview .subsection-title
+{
+ font-size: 120%;
+ font-weight: bold;
+ letter-spacing: -0.01em;
+ margin: 8px 0 3px 0;
+}
+
+h6
+{
+ font-size: 100%;
+ letter-spacing: -0.01em;
+ margin: 6px 0 3px 0;
+ font-style: italic;
+}
+
+table
+{
+ border-spacing: 0;
+ border: 0;
+ border-collapse: collapse;
+}
+
+td, th
+{
+ border: 1px solid #ddd;
+ margin: 0px;
+ text-align: left;
+ vertical-align: top;
+ padding: 4px 6px;
+ display: table-cell;
+}
+
+thead tr
+{
+ background-color: #ddd;
+ font-weight: bold;
+}
+
+th { border-right: 1px solid #aaa; }
+tr > th:last-child { border-right: 1px solid #ddd; }
+
+.ancestors, .attribs { color: #999; }
+.ancestors a, .attribs a
+{
+ color: #999 !important;
+ text-decoration: none;
+}
+
+.clear
+{
+ clear: both;
+}
+
+.important
+{
+ font-weight: bold;
+ color: #950B02;
+}
+
+.yes-def {
+ text-indent: -1000px;
+}
+
+.type-signature {
+ color: #aaa;
+}
+
+.name, .signature {
+ font-family: Consolas, Monaco, 'Andale Mono', monospace;
+}
+
+.details { margin-top: 14px; border-left: 2px solid #DDD; }
+.details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; }
+.details dd { margin-left: 70px; }
+.details ul { margin: 0; }
+.details ul { list-style-type: none; }
+.details li { margin-left: 30px; padding-top: 6px; }
+.details pre.prettyprint { margin: 0 }
+.details .object-value { padding-top: 0; }
+
+.description {
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+.code-caption
+{
+ font-style: italic;
+ font-size: 107%;
+ margin: 0;
+}
+
+.prettyprint
+{
+ border: 1px solid #ddd;
+ width: 80%;
+ overflow: auto;
+}
+
+.prettyprint.source {
+ width: inherit;
+}
+
+.prettyprint code
+{
+ font-size: 100%;
+ line-height: 18px;
+ display: block;
+ padding: 4px 12px;
+ margin: 0;
+ background-color: #fff;
+ color: #4D4E53;
+}
+
+.prettyprint code span.line
+{
+ display: inline-block;
+}
+
+.prettyprint.linenums
+{
+ padding-left: 70px;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+.prettyprint.linenums ol
+{
+ padding-left: 0;
+}
+
+.prettyprint.linenums li
+{
+ border-left: 3px #ddd solid;
+}
+
+.prettyprint.linenums li.selected,
+.prettyprint.linenums li.selected *
+{
+ background-color: lightyellow;
+}
+
+.prettyprint.linenums li *
+{
+ -webkit-user-select: text;
+ -moz-user-select: text;
+ -ms-user-select: text;
+ user-select: text;
+}
+
+.params .name, .props .name, .name code {
+ color: #4D4E53;
+ font-family: Consolas, Monaco, 'Andale Mono', monospace;
+ font-size: 100%;
+}
+
+.params td.description > p:first-child,
+.props td.description > p:first-child
+{
+ margin-top: 0;
+ padding-top: 0;
+}
+
+.params td.description > p:last-child,
+.props td.description > p:last-child
+{
+ margin-bottom: 0;
+ padding-bottom: 0;
+}
+
+.disabled {
+ color: #454545;
+}
diff --git a/docs/backend_api/styles/prettify-jsdoc.css b/docs/backend_api/styles/prettify-jsdoc.css
new file mode 100644
index 000000000..5a2526e37
--- /dev/null
+++ b/docs/backend_api/styles/prettify-jsdoc.css
@@ -0,0 +1,111 @@
+/* JSDoc prettify.js theme */
+
+/* plain text */
+.pln {
+ color: #000000;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* string content */
+.str {
+ color: #006400;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a keyword */
+.kwd {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* a comment */
+.com {
+ font-weight: normal;
+ font-style: italic;
+}
+
+/* a type name */
+.typ {
+ color: #000000;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a literal value */
+.lit {
+ color: #006400;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* punctuation */
+.pun {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* lisp open bracket */
+.opn {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* lisp close bracket */
+.clo {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* a markup tag name */
+.tag {
+ color: #006400;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a markup attribute name */
+.atn {
+ color: #006400;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a markup attribute value */
+.atv {
+ color: #006400;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a declaration */
+.dec {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* a variable name */
+.var {
+ color: #000000;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a function name */
+.fun {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+ margin-top: 0;
+ margin-bottom: 0;
+}
diff --git a/docs/backend_api/styles/prettify-tomorrow.css b/docs/backend_api/styles/prettify-tomorrow.css
new file mode 100644
index 000000000..b6f92a78d
--- /dev/null
+++ b/docs/backend_api/styles/prettify-tomorrow.css
@@ -0,0 +1,132 @@
+/* Tomorrow Theme */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* Pretty printing styles. Used with prettify.js. */
+/* SPAN elements with the classes below are added by prettyprint. */
+/* plain text */
+.pln {
+ color: #4d4d4c; }
+
+@media screen {
+ /* string content */
+ .str {
+ color: #718c00; }
+
+ /* a keyword */
+ .kwd {
+ color: #8959a8; }
+
+ /* a comment */
+ .com {
+ color: #8e908c; }
+
+ /* a type name */
+ .typ {
+ color: #4271ae; }
+
+ /* a literal value */
+ .lit {
+ color: #f5871f; }
+
+ /* punctuation */
+ .pun {
+ color: #4d4d4c; }
+
+ /* lisp open bracket */
+ .opn {
+ color: #4d4d4c; }
+
+ /* lisp close bracket */
+ .clo {
+ color: #4d4d4c; }
+
+ /* a markup tag name */
+ .tag {
+ color: #c82829; }
+
+ /* a markup attribute name */
+ .atn {
+ color: #f5871f; }
+
+ /* a markup attribute value */
+ .atv {
+ color: #3e999f; }
+
+ /* a declaration */
+ .dec {
+ color: #f5871f; }
+
+ /* a variable name */
+ .var {
+ color: #c82829; }
+
+ /* a function name */
+ .fun {
+ color: #4271ae; } }
+/* Use higher contrast and text-weight for printable form. */
+@media print, projection {
+ .str {
+ color: #060; }
+
+ .kwd {
+ color: #006;
+ font-weight: bold; }
+
+ .com {
+ color: #600;
+ font-style: italic; }
+
+ .typ {
+ color: #404;
+ font-weight: bold; }
+
+ .lit {
+ color: #044; }
+
+ .pun, .opn, .clo {
+ color: #440; }
+
+ .tag {
+ color: #006;
+ font-weight: bold; }
+
+ .atn {
+ color: #404; }
+
+ .atv {
+ color: #060; } }
+/* Style */
+/*
+pre.prettyprint {
+ background: white;
+ font-family: Consolas, Monaco, 'Andale Mono', monospace;
+ font-size: 12px;
+ line-height: 1.5;
+ border: 1px solid #ccc;
+ padding: 10px; }
+*/
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+ margin-top: 0;
+ margin-bottom: 0; }
+
+/* IE indents via margin-left */
+li.L0,
+li.L1,
+li.L2,
+li.L3,
+li.L4,
+li.L5,
+li.L6,
+li.L7,
+li.L8,
+li.L9 {
+ /* */ }
+
+/* Alternate shading for lines */
+li.L1,
+li.L3,
+li.L5,
+li.L7,
+li.L9 {
+ /* */ }
diff --git a/docs/frontend_api/Branch.html b/docs/frontend_api/Branch.html
new file mode 100644
index 000000000..30a2c8bda
--- /dev/null
+++ b/docs/frontend_api/Branch.html
@@ -0,0 +1,728 @@
+
+
+
+ JSDoc: Class: Branch
+
+
+
+
+
+
+
Class: Branch
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (async) getNote() → {NoteShort }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+NoteShort
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {boolean}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ true if it's top level, meaning its parent is root note
+
+
+
+
+
+
+ Type
+
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:07 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/FrontendScriptApi.html b/docs/frontend_api/FrontendScriptApi.html
new file mode 100644
index 000000000..5f5601c95
--- /dev/null
+++ b/docs/frontend_api/FrontendScriptApi.html
@@ -0,0 +1,2281 @@
+
+
+
+ JSDoc: Class: FrontendScriptApi
+
+
+
+
+
+
+
Class: FrontendScriptApi
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Members
+
+
+
+Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ note
+
+
+object
+
+
+
+
+
+
+
+
+
+ where script is currently executing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ entity
+
+
+object
+|
+
+null
+
+
+
+
+
+
+
+
+
+ whose event triggered this execution
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ note
+
+
+object
+
+
+
+
+
+
+
+
+
+ where script started executing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (notePath) → {Promise.<void>}
+ Activates newly created note. Compared to this.activateNote() also refreshes tree.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ notePath
+
+
+string
+
+
+
+
+
+
+
+
+
+ (or noteId)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (notePath) → {Promise.<void>}
+ Activates note in the tree and in the note detail.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ notePath
+
+
+string
+
+
+
+
+
+
+
+
+
+ (or noteId)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Adds new button the the plugin area.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ opts
+
+
+ToolbarButtonOptions
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (notePath, noteTitleopt )
+ Create note link (jQuery object) for given note.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ notePath
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (or noteId)
+
+
+
+
+
+
+ noteTitle
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ if not present we'll use note title
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ date
+
+
+Date
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ date in YYYY-MM-DD format
+
+
+
+
+
+
+ Type
+
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {string}
+ Instance name identifies particular Trilium instance. It can be useful for scripts
+if some action needs to happen on only one specific instance.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (noteIds, silentNotFoundErroropt ) → {Promise.<Array.<NoteShort >>}
+ Returns list of notes. If note is missing from cache, it's loaded.
+
+This is often used to bulk-fill the cache with notes which would have to be picked one by one
+otherwise (by e.g. createNoteLink())
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ noteIds
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ silentNotFoundError
+
+
+boolean
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ don't report error if the note is not found
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<NoteShort >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (str) → {Date} Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ str
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ parsed object
+
+
+
+
+
+
+ Type
+
+
+
+Date
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {Promise.<void>}
+ Refresh tree
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<void>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (script, params) → {Promise.<*>}
+ Executes given anonymous function on the server.
+Internally this serializes the anonymous function into string and sends it to backend via AJAX.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ script
+
+
+string
+
+
+
+
+
+
+
+
+
+ script to be executed on the backend
+
+
+
+
+
+
+ params
+
+
+Array.<?>
+
+
+
+
+
+
+
+
+
+ list of parameters to the anonymous function to be send to backend
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+ return value of the executed function on the backend
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<*>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (message)
+ Show error message to the user.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ message
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (message)
+ Show info message to the user.
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ message
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:07 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/NoteFull.html b/docs/frontend_api/NoteFull.html
new file mode 100644
index 000000000..bf24211a9
--- /dev/null
+++ b/docs/frontend_api/NoteFull.html
@@ -0,0 +1,288 @@
+
+
+
+ JSDoc: Class: NoteFull
+
+
+
+
+
+
+
Class: NoteFull
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:07 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/NoteShort.html b/docs/frontend_api/NoteShort.html
new file mode 100644
index 000000000..97005cd98
--- /dev/null
+++ b/docs/frontend_api/NoteShort.html
@@ -0,0 +1,1325 @@
+
+
+
+ JSDoc: Class: NoteShort
+
+
+
+
+
+
+
Class: NoteShort
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Constructor
+
+
+
+
()
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+ Methods
+
+
+
+
+
+
+
+ (async) getBranches() → {Promise.<Array.<Branch >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Branch >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getChildBranches() → {Promise.<Array.<Branch >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<Branch >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {Array.<string>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getChildNotes() → {Promise.<Array.<NoteShort >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<NoteShort >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {Array.<string>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Array.<string>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (async) getParentNotes() → {Promise.<Array.<NoteShort >>}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+Promise.<Array.<NoteShort >>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {boolean}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ () → {boolean}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+ Type
+
+
+
+boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:07 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/branch.js.html b/docs/frontend_api/branch.js.html
new file mode 100644
index 000000000..9c70609a7
--- /dev/null
+++ b/docs/frontend_api/branch.js.html
@@ -0,0 +1,85 @@
+
+
+
+ JSDoc: Source: branch.js
+
+
+
+
+
+
+
Source: branch.js
+
+
+
+
+
+
+
+
+ /** Represents mapping between note and parent note */
+class Branch {
+ constructor(treeCache, row) {
+ this.treeCache = treeCache;
+ /** @param {string} primary key */
+ this.branchId = row.branchId;
+ /** @param {string} */
+ this.noteId = row.noteId;
+ this.note = null;
+ /** @param {string} */
+ this.parentNoteId = row.parentNoteId;
+ /** @param {int} */
+ this.notePosition = row.notePosition;
+ /** @param {string} */
+ this.prefix = row.prefix;
+ /** @param {boolean} */
+ this.isExpanded = row.isExpanded;
+ }
+
+ /** @returns {NoteShort} */
+ async getNote() {
+ return await this.treeCache.getNote(this.noteId);
+ }
+
+ /** @returns {boolean} true if it's top level, meaning its parent is root note */
+ isTopLevel() {
+ return this.parentNoteId === 'root';
+ }
+
+ get toString() {
+ return `Branch(branchId=${this.branchId})`;
+ }
+}
+
+export default Branch;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Thu Aug 23 2018 12:50:56 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/frontend_api/entities_branch.js.html b/docs/frontend_api/entities_branch.js.html
new file mode 100644
index 000000000..d4b1b9b86
--- /dev/null
+++ b/docs/frontend_api/entities_branch.js.html
@@ -0,0 +1,85 @@
+
+
+
+ JSDoc: Source: entities/branch.js
+
+
+
+
+
+
+
Source: entities/branch.js
+
+
+
+
+
+
+
+
+ /** Represents mapping between note and parent note */
+class Branch {
+ constructor(treeCache, row) {
+ this.treeCache = treeCache;
+ /** @param {string} primary key */
+ this.branchId = row.branchId;
+ /** @param {string} */
+ this.noteId = row.noteId;
+ this.note = null;
+ /** @param {string} */
+ this.parentNoteId = row.parentNoteId;
+ /** @param {int} */
+ this.notePosition = row.notePosition;
+ /** @param {string} */
+ this.prefix = row.prefix;
+ /** @param {boolean} */
+ this.isExpanded = row.isExpanded;
+ }
+
+ /** @returns {NoteShort} */
+ async getNote() {
+ return await this.treeCache.getNote(this.noteId);
+ }
+
+ /** @returns {boolean} true if it's top level, meaning its parent is root note */
+ isTopLevel() {
+ return this.parentNoteId === 'root';
+ }
+
+ get toString() {
+ return `Branch(branchId=${this.branchId})`;
+ }
+}
+
+export default Branch;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:07 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/frontend_api/entities_note_full.js.html b/docs/frontend_api/entities_note_full.js.html
new file mode 100644
index 000000000..5e7ba1951
--- /dev/null
+++ b/docs/frontend_api/entities_note_full.js.html
@@ -0,0 +1,73 @@
+
+
+
+ JSDoc: Source: entities/note_full.js
+
+
+
+
+
+
+
Source: entities/note_full.js
+
+
+
+
+
+
+
+
+ import NoteShort from './note_short.js';
+
+/**
+ * Represents full note, specifically including note's content.
+ */
+class NoteFull extends NoteShort {
+ constructor(treeCache, row) {
+ super(treeCache, row);
+
+ /** @param {string} */
+ this.content = row.content;
+
+ if (this.content !== "" && this.isJson()) {
+ try {
+ /** @param {object} */
+ this.jsonContent = JSON.parse(this.content);
+ }
+ catch(e) {}
+ }
+ }
+}
+
+export default NoteFull;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:07 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/frontend_api/entities_note_short.js.html b/docs/frontend_api/entities_note_short.js.html
new file mode 100644
index 000000000..09df0f057
--- /dev/null
+++ b/docs/frontend_api/entities_note_short.js.html
@@ -0,0 +1,137 @@
+
+
+
+ JSDoc: Source: entities/note_short.js
+
+
+
+
+
+
+
Source: entities/note_short.js
+
+
+
+
+
+
+
+
+ /**
+ * This note's representation is used in note tree and is kept in TreeCache.
+ * Its notable omission is the note content.
+ */
+class NoteShort {
+ constructor(treeCache, row) {
+ 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;
+ this.cssClass = row.cssClass;
+ }
+
+ /** @returns {boolean} */
+ isJson() {
+ return this.mime === "application/json";
+ }
+
+ /** @returns {Promise<Branch[]>} */
+ async getBranches() {
+ const branchIds = this.treeCache.parents[this.noteId].map(
+ parentNoteId => this.treeCache.getBranchIdByChildParent(this.noteId, parentNoteId));
+
+ return this.treeCache.getBranches(branchIds);
+ }
+
+ /** @returns {boolean} */
+ hasChildren() {
+ return this.treeCache.children[this.noteId]
+ && this.treeCache.children[this.noteId].length > 0;
+ }
+
+ /** @returns {Promise<Branch[]>} */
+ async getChildBranches() {
+ if (!this.treeCache.children[this.noteId]) {
+ return [];
+ }
+
+ const branchIds = this.treeCache.children[this.noteId].map(
+ childNoteId => this.treeCache.getBranchIdByChildParent(childNoteId, this.noteId));
+
+ return await this.treeCache.getBranches(branchIds);
+ }
+
+ /** @returns {string[]} */
+ getParentNoteIds() {
+ return this.treeCache.parents[this.noteId] || [];
+ }
+
+ /** @returns {Promise<NoteShort[]>} */
+ async getParentNotes() {
+ return await this.treeCache.getNotes(this.getParentNoteIds());
+ }
+
+ /** @returns {string[]} */
+ getChildNoteIds() {
+ return this.treeCache.children[this.noteId] || [];
+ }
+
+ /** @returns {Promise<NoteShort[]>} */
+ async getChildNotes() {
+ return await this.treeCache.getNotes(this.getChildNoteIds());
+ }
+
+ get toString() {
+ return `Note(noteId=${this.noteId}, title=${this.title})`;
+ }
+
+ get dto() {
+ const dto = Object.assign({}, this);
+ delete dto.treeCache;
+ delete dto.archived;
+
+ return dto;
+ }
+}
+
+export default NoteShort;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:07 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/frontend_api/fonts/OpenSans-Bold-webfont.eot b/docs/frontend_api/fonts/OpenSans-Bold-webfont.eot
new file mode 100644
index 000000000..5d20d9163
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-Bold-webfont.eot differ
diff --git a/docs/frontend_api/fonts/OpenSans-Bold-webfont.svg b/docs/frontend_api/fonts/OpenSans-Bold-webfont.svg
new file mode 100644
index 000000000..3ed7be4bc
--- /dev/null
+++ b/docs/frontend_api/fonts/OpenSans-Bold-webfont.svg
@@ -0,0 +1,1830 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/fonts/OpenSans-Bold-webfont.woff b/docs/frontend_api/fonts/OpenSans-Bold-webfont.woff
new file mode 100644
index 000000000..1205787b0
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-Bold-webfont.woff differ
diff --git a/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.eot b/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.eot
new file mode 100644
index 000000000..1f639a15f
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.eot differ
diff --git a/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.svg b/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.svg
new file mode 100644
index 000000000..6a2607b9d
--- /dev/null
+++ b/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.svg
@@ -0,0 +1,1830 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.woff b/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.woff
new file mode 100644
index 000000000..ed760c062
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-BoldItalic-webfont.woff differ
diff --git a/docs/frontend_api/fonts/OpenSans-Italic-webfont.eot b/docs/frontend_api/fonts/OpenSans-Italic-webfont.eot
new file mode 100644
index 000000000..0c8a0ae06
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-Italic-webfont.eot differ
diff --git a/docs/frontend_api/fonts/OpenSans-Italic-webfont.svg b/docs/frontend_api/fonts/OpenSans-Italic-webfont.svg
new file mode 100644
index 000000000..e1075dcc2
--- /dev/null
+++ b/docs/frontend_api/fonts/OpenSans-Italic-webfont.svg
@@ -0,0 +1,1830 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/fonts/OpenSans-Italic-webfont.woff b/docs/frontend_api/fonts/OpenSans-Italic-webfont.woff
new file mode 100644
index 000000000..ff652e643
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-Italic-webfont.woff differ
diff --git a/docs/frontend_api/fonts/OpenSans-Light-webfont.eot b/docs/frontend_api/fonts/OpenSans-Light-webfont.eot
new file mode 100644
index 000000000..14868406a
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-Light-webfont.eot differ
diff --git a/docs/frontend_api/fonts/OpenSans-Light-webfont.svg b/docs/frontend_api/fonts/OpenSans-Light-webfont.svg
new file mode 100644
index 000000000..11a472ca8
--- /dev/null
+++ b/docs/frontend_api/fonts/OpenSans-Light-webfont.svg
@@ -0,0 +1,1831 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/fonts/OpenSans-Light-webfont.woff b/docs/frontend_api/fonts/OpenSans-Light-webfont.woff
new file mode 100644
index 000000000..e78607481
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-Light-webfont.woff differ
diff --git a/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.eot b/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.eot
new file mode 100644
index 000000000..8f445929f
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.eot differ
diff --git a/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.svg b/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.svg
new file mode 100644
index 000000000..431d7e354
--- /dev/null
+++ b/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.svg
@@ -0,0 +1,1835 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.woff b/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.woff
new file mode 100644
index 000000000..43e8b9e6c
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-LightItalic-webfont.woff differ
diff --git a/docs/frontend_api/fonts/OpenSans-Regular-webfont.eot b/docs/frontend_api/fonts/OpenSans-Regular-webfont.eot
new file mode 100644
index 000000000..6bbc3cf58
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-Regular-webfont.eot differ
diff --git a/docs/frontend_api/fonts/OpenSans-Regular-webfont.svg b/docs/frontend_api/fonts/OpenSans-Regular-webfont.svg
new file mode 100644
index 000000000..25a395234
--- /dev/null
+++ b/docs/frontend_api/fonts/OpenSans-Regular-webfont.svg
@@ -0,0 +1,1831 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/fonts/OpenSans-Regular-webfont.woff b/docs/frontend_api/fonts/OpenSans-Regular-webfont.woff
new file mode 100644
index 000000000..e231183dc
Binary files /dev/null and b/docs/frontend_api/fonts/OpenSans-Regular-webfont.woff differ
diff --git a/docs/frontend_api/global.html b/docs/frontend_api/global.html
new file mode 100644
index 000000000..63e4813bf
--- /dev/null
+++ b/docs/frontend_api/global.html
@@ -0,0 +1,348 @@
+
+
+
+ JSDoc: Global
+
+
+
+
+
+
+
Global
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Type Definitions
+
+
+
+
+
+
+
+
+
+
+ Type:
+
+
+
+
+
+
+ Properties:
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ title
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ icon
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ name of the jQuery UI icon to be used (e.g. "clock" for "ui-icon-clock" icon)
+
+
+
+
+
+
+ action
+
+
+function
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ callback handling the click on the button
+
+
+
+
+
+
+ shortcut
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+ keyboard shortcut for the button, e.g. "alt+t"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:07 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/index.html b/docs/frontend_api/index.html
new file mode 100644
index 000000000..7546ae660
--- /dev/null
+++ b/docs/frontend_api/index.html
@@ -0,0 +1,65 @@
+
+
+
+ JSDoc: Home
+
+
+
+
+
+
+
Home
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:07 GMT+0200 (CEST)
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/frontend_api/note_full.js.html b/docs/frontend_api/note_full.js.html
new file mode 100644
index 000000000..097e67fb6
--- /dev/null
+++ b/docs/frontend_api/note_full.js.html
@@ -0,0 +1,73 @@
+
+
+
+ JSDoc: Source: note_full.js
+
+
+
+
+
+
+
Source: note_full.js
+
+
+
+
+
+
+
+
+ import NoteShort from './note_short.js';
+
+/**
+ * Represents full note, specifically including note's content.
+ */
+class NoteFull extends NoteShort {
+ constructor(treeCache, row) {
+ super(treeCache, row);
+
+ /** @param {string} */
+ this.content = row.content;
+
+ if (this.content !== "" && this.isJson()) {
+ try {
+ /** @param {object} */
+ this.jsonContent = JSON.parse(this.content);
+ }
+ catch(e) {}
+ }
+ }
+}
+
+export default NoteFull;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Thu Aug 23 2018 12:50:56 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/frontend_api/note_short.js.html b/docs/frontend_api/note_short.js.html
new file mode 100644
index 000000000..222ba177d
--- /dev/null
+++ b/docs/frontend_api/note_short.js.html
@@ -0,0 +1,137 @@
+
+
+
+ JSDoc: Source: note_short.js
+
+
+
+
+
+
+
Source: note_short.js
+
+
+
+
+
+
+
+
+ /**
+ * This note's representation is used in note tree and is kept in TreeCache.
+ * Its notable omission is the note content.
+ */
+class NoteShort {
+ constructor(treeCache, row) {
+ 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;
+ this.cssClass = row.cssClass;
+ }
+
+ /** @returns {boolean} */
+ isJson() {
+ return this.mime === "application/json";
+ }
+
+ /** @returns {Promise<Array.<Branch>>} */
+ async getBranches() {
+ const branchIds = this.treeCache.parents[this.noteId].map(
+ parentNoteId => this.treeCache.getBranchIdByChildParent(this.noteId, parentNoteId));
+
+ return this.treeCache.getBranches(branchIds);
+ }
+
+ /** @returns {boolean} */
+ hasChildren() {
+ return this.treeCache.children[this.noteId]
+ && this.treeCache.children[this.noteId].length > 0;
+ }
+
+ /** @returns {Promise<Array.<Branch>>} */
+ async getChildBranches() {
+ if (!this.treeCache.children[this.noteId]) {
+ return [];
+ }
+
+ const branchIds = this.treeCache.children[this.noteId].map(
+ childNoteId => this.treeCache.getBranchIdByChildParent(childNoteId, this.noteId));
+
+ return await this.treeCache.getBranches(branchIds);
+ }
+
+ /** @returns {Array.<string>} */
+ getParentNoteIds() {
+ return this.treeCache.parents[this.noteId] || [];
+ }
+
+ /** @returns {Promise<Array.<NoteShort>>} */
+ async getParentNotes() {
+ return await this.treeCache.getNotes(this.getParentNoteIds());
+ }
+
+ /** @returns {Array.<string>} */
+ getChildNoteIds() {
+ return this.treeCache.children[this.noteId] || [];
+ }
+
+ /** @returns {Promise<Array.<NoteShort>>} */
+ async getChildNotes() {
+ return await this.treeCache.getNotes(this.getChildNoteIds());
+ }
+
+ get toString() {
+ return `Note(noteId=${this.noteId}, title=${this.title})`;
+ }
+
+ get dto() {
+ const dto = Object.assign({}, this);
+ delete dto.treeCache;
+ delete dto.archived;
+
+ return dto;
+ }
+}
+
+export default NoteShort;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Thu Aug 23 2018 12:50:56 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/frontend_api/scripts/linenumber.js b/docs/frontend_api/scripts/linenumber.js
new file mode 100644
index 000000000..8d52f7eaf
--- /dev/null
+++ b/docs/frontend_api/scripts/linenumber.js
@@ -0,0 +1,25 @@
+/*global document */
+(function() {
+ var source = document.getElementsByClassName('prettyprint source linenums');
+ var i = 0;
+ var lineNumber = 0;
+ var lineId;
+ var lines;
+ var totalLines;
+ var anchorHash;
+
+ if (source && source[0]) {
+ anchorHash = document.location.hash.substring(1);
+ lines = source[0].getElementsByTagName('li');
+ totalLines = lines.length;
+
+ for (; i < totalLines; i++) {
+ lineNumber++;
+ lineId = 'line' + lineNumber;
+ lines[i].id = lineId;
+ if (lineId === anchorHash) {
+ lines[i].className += ' selected';
+ }
+ }
+ }
+})();
diff --git a/docs/frontend_api/scripts/prettify/Apache-License-2.0.txt b/docs/frontend_api/scripts/prettify/Apache-License-2.0.txt
new file mode 100644
index 000000000..d64569567
--- /dev/null
+++ b/docs/frontend_api/scripts/prettify/Apache-License-2.0.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/docs/frontend_api/scripts/prettify/lang-css.js b/docs/frontend_api/scripts/prettify/lang-css.js
new file mode 100644
index 000000000..041e1f590
--- /dev/null
+++ b/docs/frontend_api/scripts/prettify/lang-css.js
@@ -0,0 +1,2 @@
+PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n "]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
+/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);
diff --git a/docs/frontend_api/scripts/prettify/prettify.js b/docs/frontend_api/scripts/prettify/prettify.js
new file mode 100644
index 000000000..eef5ad7e6
--- /dev/null
+++ b/docs/frontend_api/scripts/prettify/prettify.js
@@ -0,0 +1,28 @@
+var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
+(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
+[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;ci[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
+l=[],p={},d=0,g=e.length;d=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
+q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
+q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
+"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
+a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
+for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
+"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
+H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
+J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
+I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
+["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
+/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
+["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
+hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p=0){var k=k.match(g),f,b;if(b=
+!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p
+
+
+ JSDoc: Source: services/frontend_script_api.js
+
+
+
+
+
+
+
Source: services/frontend_script_api.js
+
+
+
+
+
+
+
+
+ import treeService from './tree.js';
+import server from './server.js';
+import utils from './utils.js';
+import infoService from './info.js';
+import linkService from './link.js';
+import treeCache from './tree_cache.js';
+
+/**
+ * This is the main frontend API interface for scripts. It's published in the local "api" object.
+ *
+ * @constructor
+ * @hideconstructor
+ */
+function FrontendScriptApi(startNote, currentNote, originEntity = null) {
+ const $pluginButtons = $("#plugin-buttons");
+
+ /** @property {object} note where script started executing */
+ this.startNote = startNote;
+ /** @property {object} note where script is currently executing */
+ this.currentNote = currentNote;
+ /** @property {object|null} entity whose event triggered this execution */
+ this.originEntity = originEntity;
+
+ /**
+ * Activates note in the tree and in the note detail.
+ *
+ * @method
+ * @param {string} notePath (or noteId)
+ * @returns {Promise<void>}
+ */
+ this.activateNote = treeService.activateNote;
+
+ /**
+ * Activates newly created note. Compared to this.activateNote() also refreshes tree.
+ *
+ * @param {string} notePath (or noteId)
+ * @return {Promise<void>}
+ */
+ this.activateNewNote = async notePath => {
+ await treeService.reload();
+
+ await treeService.activateNote(notePath, true);
+ };
+
+ /**
+ * @typedef {Object} ToolbarButtonOptions
+ * @property {string} title
+ * @property {string} [icon] - name of the jQuery UI icon to be used (e.g. "clock" for "ui-icon-clock" icon)
+ * @property {function} action - callback handling the click on the button
+ * @property {string} [shortcut] - keyboard shortcut for the button, e.g. "alt+t"
+ */
+
+ /**
+ * Adds new button the the plugin area.
+ *
+ * @param {ToolbarButtonOptions} opts
+ */
+ this.addButtonToToolbar = opts => {
+ const buttonId = "toolbar-button-" + opts.title.replace(/[^a-zA-Z0-9]/g, "-");
+
+ const icon = $("<span>")
+ .addClass("ui-icon ui-icon-" + opts.icon);
+
+ const button = $('<button>')
+ .addClass("btn btn-xs")
+ .click(opts.action)
+ .append(icon)
+ .append($("<span>").text(opts.title));
+
+ button.attr('id', buttonId);
+
+ if ($("#" + buttonId).replaceWith(button).length === 0) {
+ $pluginButtons.append(button);
+ }
+
+ if (opts.shortcut) {
+ $(document).bind('keydown', opts.shortcut, opts.action);
+
+ button.attr("title", "Shortcut " + opts.shortcut);
+ }
+ };
+
+ function prepareParams(params) {
+ if (!params) {
+ return params;
+ }
+
+ return params.map(p => {
+ if (typeof p === "function") {
+ return "!@#Function: " + p.toString();
+ }
+ else {
+ return p;
+ }
+ });
+ }
+
+ /**
+ * Executes given anonymous function on the server.
+ * Internally this serializes the anonymous function into string and sends it to backend via AJAX.
+ *
+ * @param {string} script - script to be executed on the backend
+ * @param {Array.<?>} params - list of parameters to the anonymous function to be send to backend
+ * @return {Promise<*>} return value of the executed function on the backend
+ */
+ this.runOnServer = async (script, params = []) => {
+ if (typeof script === "function") {
+ script = script.toString();
+ }
+
+ const ret = await server.post('script/exec', {
+ script: script,
+ params: prepareParams(params),
+ startNoteId: startNote.noteId,
+ currentNoteId: currentNote.noteId,
+ originEntityName: "notes", // currently there's no other entity on frontend which can trigger event
+ originEntityId: originEntity ? originEntity.noteId : null
+ });
+
+ if (ret.success) {
+ return ret.executionResult;
+ }
+ else {
+ throw new Error("server error: " + ret.error);
+ }
+ };
+
+ /**
+ * Returns list of notes. If note is missing from cache, it's loaded.
+ *
+ * This is often used to bulk-fill the cache with notes which would have to be picked one by one
+ * otherwise (by e.g. createNoteLink())
+ *
+ * @param {string[]} noteIds
+ * @param {boolean} [silentNotFoundError] - don't report error if the note is not found
+ * @return {Promise<NoteShort[]>}
+ */
+ this.getNotes = async (noteIds, silentNotFoundError = false) => await treeCache.getNotes(noteIds, silentNotFoundError);
+
+ /**
+ * Instance name identifies particular Trilium instance. It can be useful for scripts
+ * if some action needs to happen on only one specific instance.
+ *
+ * @return {string}
+ */
+ this.getInstanceName = () => window.glob.instanceName;
+
+ /**
+ * @method
+ * @param {Date} date
+ * @returns {string} date in YYYY-MM-DD format
+ */
+ this.formatDateISO = utils.formatDateISO;
+
+ /**
+ * @method
+ * @param {string} str
+ * @returns {Date} parsed object
+ */
+ this.parseDate = utils.parseDate;
+
+ /**
+ * Show info message to the user.
+ *
+ * @method
+ * @param {string} message
+ */
+ this.showMessage = infoService.showMessage;
+
+ /**
+ * Show error message to the user.
+ *
+ * @method
+ * @param {string} message
+ */
+ this.showError = infoService.showError;
+
+ /**
+ * Refresh tree
+ *
+ * @method
+ * @returns {Promise<void>}
+ */
+ this.refreshTree = treeService.reload;
+
+ /**
+ * Create note link (jQuery object) for given note.
+ *
+ * @method
+ * @param {string} notePath (or noteId)
+ * @param {string} [noteTitle] - if not present we'll use note title
+ */
+ this.createNoteLink = linkService.createNoteLink;
+}
+
+export default FrontendScriptApi;
+
+
+
+
+
+
+ Classes
+
+
+
+ Documentation generated by JSDoc 3.5.5 on Wed Aug 29 2018 20:44:07 GMT+0200 (CEST)
+
+
+
+
+
+
diff --git a/docs/frontend_api/styles/jsdoc-default.css b/docs/frontend_api/styles/jsdoc-default.css
new file mode 100644
index 000000000..9207bc824
--- /dev/null
+++ b/docs/frontend_api/styles/jsdoc-default.css
@@ -0,0 +1,358 @@
+@font-face {
+ font-family: 'Open Sans';
+ font-weight: normal;
+ font-style: normal;
+ src: url('../fonts/OpenSans-Regular-webfont.eot');
+ src:
+ local('Open Sans'),
+ local('OpenSans'),
+ url('../fonts/OpenSans-Regular-webfont.eot?#iefix') format('embedded-opentype'),
+ url('../fonts/OpenSans-Regular-webfont.woff') format('woff'),
+ url('../fonts/OpenSans-Regular-webfont.svg#open_sansregular') format('svg');
+}
+
+@font-face {
+ font-family: 'Open Sans Light';
+ font-weight: normal;
+ font-style: normal;
+ src: url('../fonts/OpenSans-Light-webfont.eot');
+ src:
+ local('Open Sans Light'),
+ local('OpenSans Light'),
+ url('../fonts/OpenSans-Light-webfont.eot?#iefix') format('embedded-opentype'),
+ url('../fonts/OpenSans-Light-webfont.woff') format('woff'),
+ url('../fonts/OpenSans-Light-webfont.svg#open_sanslight') format('svg');
+}
+
+html
+{
+ overflow: auto;
+ background-color: #fff;
+ font-size: 14px;
+}
+
+body
+{
+ font-family: 'Open Sans', sans-serif;
+ line-height: 1.5;
+ color: #4d4e53;
+ background-color: white;
+}
+
+a, a:visited, a:active {
+ color: #0095dd;
+ text-decoration: none;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+header
+{
+ display: block;
+ padding: 0px 4px;
+}
+
+tt, code, kbd, samp {
+ font-family: Consolas, Monaco, 'Andale Mono', monospace;
+}
+
+.class-description {
+ font-size: 130%;
+ line-height: 140%;
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+.class-description:empty {
+ margin: 0;
+}
+
+#main {
+ float: left;
+ width: 70%;
+}
+
+article dl {
+ margin-bottom: 40px;
+}
+
+article img {
+ max-width: 100%;
+}
+
+section
+{
+ display: block;
+ background-color: #fff;
+ padding: 12px 24px;
+ border-bottom: 1px solid #ccc;
+ margin-right: 30px;
+}
+
+.variation {
+ display: none;
+}
+
+.signature-attributes {
+ font-size: 60%;
+ color: #aaa;
+ font-style: italic;
+ font-weight: lighter;
+}
+
+nav
+{
+ display: block;
+ float: right;
+ margin-top: 28px;
+ width: 30%;
+ box-sizing: border-box;
+ border-left: 1px solid #ccc;
+ padding-left: 16px;
+}
+
+nav ul {
+ font-family: 'Lucida Grande', 'Lucida Sans Unicode', arial, sans-serif;
+ font-size: 100%;
+ line-height: 17px;
+ padding: 0;
+ margin: 0;
+ list-style-type: none;
+}
+
+nav ul a, nav ul a:visited, nav ul a:active {
+ font-family: Consolas, Monaco, 'Andale Mono', monospace;
+ line-height: 18px;
+ color: #4D4E53;
+}
+
+nav h3 {
+ margin-top: 12px;
+}
+
+nav li {
+ margin-top: 6px;
+}
+
+footer {
+ display: block;
+ padding: 6px;
+ margin-top: 12px;
+ font-style: italic;
+ font-size: 90%;
+}
+
+h1, h2, h3, h4 {
+ font-weight: 200;
+ margin: 0;
+}
+
+h1
+{
+ font-family: 'Open Sans Light', sans-serif;
+ font-size: 48px;
+ letter-spacing: -2px;
+ margin: 12px 24px 20px;
+}
+
+h2, h3.subsection-title
+{
+ font-size: 30px;
+ font-weight: 700;
+ letter-spacing: -1px;
+ margin-bottom: 12px;
+}
+
+h3
+{
+ font-size: 24px;
+ letter-spacing: -0.5px;
+ margin-bottom: 12px;
+}
+
+h4
+{
+ font-size: 18px;
+ letter-spacing: -0.33px;
+ margin-bottom: 12px;
+ color: #4d4e53;
+}
+
+h5, .container-overview .subsection-title
+{
+ font-size: 120%;
+ font-weight: bold;
+ letter-spacing: -0.01em;
+ margin: 8px 0 3px 0;
+}
+
+h6
+{
+ font-size: 100%;
+ letter-spacing: -0.01em;
+ margin: 6px 0 3px 0;
+ font-style: italic;
+}
+
+table
+{
+ border-spacing: 0;
+ border: 0;
+ border-collapse: collapse;
+}
+
+td, th
+{
+ border: 1px solid #ddd;
+ margin: 0px;
+ text-align: left;
+ vertical-align: top;
+ padding: 4px 6px;
+ display: table-cell;
+}
+
+thead tr
+{
+ background-color: #ddd;
+ font-weight: bold;
+}
+
+th { border-right: 1px solid #aaa; }
+tr > th:last-child { border-right: 1px solid #ddd; }
+
+.ancestors, .attribs { color: #999; }
+.ancestors a, .attribs a
+{
+ color: #999 !important;
+ text-decoration: none;
+}
+
+.clear
+{
+ clear: both;
+}
+
+.important
+{
+ font-weight: bold;
+ color: #950B02;
+}
+
+.yes-def {
+ text-indent: -1000px;
+}
+
+.type-signature {
+ color: #aaa;
+}
+
+.name, .signature {
+ font-family: Consolas, Monaco, 'Andale Mono', monospace;
+}
+
+.details { margin-top: 14px; border-left: 2px solid #DDD; }
+.details dt { width: 120px; float: left; padding-left: 10px; padding-top: 6px; }
+.details dd { margin-left: 70px; }
+.details ul { margin: 0; }
+.details ul { list-style-type: none; }
+.details li { margin-left: 30px; padding-top: 6px; }
+.details pre.prettyprint { margin: 0 }
+.details .object-value { padding-top: 0; }
+
+.description {
+ margin-bottom: 1em;
+ margin-top: 1em;
+}
+
+.code-caption
+{
+ font-style: italic;
+ font-size: 107%;
+ margin: 0;
+}
+
+.prettyprint
+{
+ border: 1px solid #ddd;
+ width: 80%;
+ overflow: auto;
+}
+
+.prettyprint.source {
+ width: inherit;
+}
+
+.prettyprint code
+{
+ font-size: 100%;
+ line-height: 18px;
+ display: block;
+ padding: 4px 12px;
+ margin: 0;
+ background-color: #fff;
+ color: #4D4E53;
+}
+
+.prettyprint code span.line
+{
+ display: inline-block;
+}
+
+.prettyprint.linenums
+{
+ padding-left: 70px;
+ -webkit-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+.prettyprint.linenums ol
+{
+ padding-left: 0;
+}
+
+.prettyprint.linenums li
+{
+ border-left: 3px #ddd solid;
+}
+
+.prettyprint.linenums li.selected,
+.prettyprint.linenums li.selected *
+{
+ background-color: lightyellow;
+}
+
+.prettyprint.linenums li *
+{
+ -webkit-user-select: text;
+ -moz-user-select: text;
+ -ms-user-select: text;
+ user-select: text;
+}
+
+.params .name, .props .name, .name code {
+ color: #4D4E53;
+ font-family: Consolas, Monaco, 'Andale Mono', monospace;
+ font-size: 100%;
+}
+
+.params td.description > p:first-child,
+.props td.description > p:first-child
+{
+ margin-top: 0;
+ padding-top: 0;
+}
+
+.params td.description > p:last-child,
+.props td.description > p:last-child
+{
+ margin-bottom: 0;
+ padding-bottom: 0;
+}
+
+.disabled {
+ color: #454545;
+}
diff --git a/docs/frontend_api/styles/prettify-jsdoc.css b/docs/frontend_api/styles/prettify-jsdoc.css
new file mode 100644
index 000000000..5a2526e37
--- /dev/null
+++ b/docs/frontend_api/styles/prettify-jsdoc.css
@@ -0,0 +1,111 @@
+/* JSDoc prettify.js theme */
+
+/* plain text */
+.pln {
+ color: #000000;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* string content */
+.str {
+ color: #006400;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a keyword */
+.kwd {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* a comment */
+.com {
+ font-weight: normal;
+ font-style: italic;
+}
+
+/* a type name */
+.typ {
+ color: #000000;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a literal value */
+.lit {
+ color: #006400;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* punctuation */
+.pun {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* lisp open bracket */
+.opn {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* lisp close bracket */
+.clo {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* a markup tag name */
+.tag {
+ color: #006400;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a markup attribute name */
+.atn {
+ color: #006400;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a markup attribute value */
+.atv {
+ color: #006400;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a declaration */
+.dec {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* a variable name */
+.var {
+ color: #000000;
+ font-weight: normal;
+ font-style: normal;
+}
+
+/* a function name */
+.fun {
+ color: #000000;
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+ margin-top: 0;
+ margin-bottom: 0;
+}
diff --git a/docs/frontend_api/styles/prettify-tomorrow.css b/docs/frontend_api/styles/prettify-tomorrow.css
new file mode 100644
index 000000000..b6f92a78d
--- /dev/null
+++ b/docs/frontend_api/styles/prettify-tomorrow.css
@@ -0,0 +1,132 @@
+/* Tomorrow Theme */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* Pretty printing styles. Used with prettify.js. */
+/* SPAN elements with the classes below are added by prettyprint. */
+/* plain text */
+.pln {
+ color: #4d4d4c; }
+
+@media screen {
+ /* string content */
+ .str {
+ color: #718c00; }
+
+ /* a keyword */
+ .kwd {
+ color: #8959a8; }
+
+ /* a comment */
+ .com {
+ color: #8e908c; }
+
+ /* a type name */
+ .typ {
+ color: #4271ae; }
+
+ /* a literal value */
+ .lit {
+ color: #f5871f; }
+
+ /* punctuation */
+ .pun {
+ color: #4d4d4c; }
+
+ /* lisp open bracket */
+ .opn {
+ color: #4d4d4c; }
+
+ /* lisp close bracket */
+ .clo {
+ color: #4d4d4c; }
+
+ /* a markup tag name */
+ .tag {
+ color: #c82829; }
+
+ /* a markup attribute name */
+ .atn {
+ color: #f5871f; }
+
+ /* a markup attribute value */
+ .atv {
+ color: #3e999f; }
+
+ /* a declaration */
+ .dec {
+ color: #f5871f; }
+
+ /* a variable name */
+ .var {
+ color: #c82829; }
+
+ /* a function name */
+ .fun {
+ color: #4271ae; } }
+/* Use higher contrast and text-weight for printable form. */
+@media print, projection {
+ .str {
+ color: #060; }
+
+ .kwd {
+ color: #006;
+ font-weight: bold; }
+
+ .com {
+ color: #600;
+ font-style: italic; }
+
+ .typ {
+ color: #404;
+ font-weight: bold; }
+
+ .lit {
+ color: #044; }
+
+ .pun, .opn, .clo {
+ color: #440; }
+
+ .tag {
+ color: #006;
+ font-weight: bold; }
+
+ .atn {
+ color: #404; }
+
+ .atv {
+ color: #060; } }
+/* Style */
+/*
+pre.prettyprint {
+ background: white;
+ font-family: Consolas, Monaco, 'Andale Mono', monospace;
+ font-size: 12px;
+ line-height: 1.5;
+ border: 1px solid #ccc;
+ padding: 10px; }
+*/
+
+/* Specify class=linenums on a pre to get line numbering */
+ol.linenums {
+ margin-top: 0;
+ margin-bottom: 0; }
+
+/* IE indents via margin-left */
+li.L0,
+li.L1,
+li.L2,
+li.L3,
+li.L4,
+li.L5,
+li.L6,
+li.L7,
+li.L8,
+li.L9 {
+ /* */ }
+
+/* Alternate shading for lines */
+li.L1,
+li.L3,
+li.L5,
+li.L7,
+li.L9 {
+ /* */ }
