mirror of
https://github.com/TriliumNext/Notes.git
synced 2025-10-31 04:51:31 +08:00
288 lines
9.1 KiB
HTML
288 lines
9.1 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<title>JSDoc: Source: services/backend_script_api.js</title>
|
||
|
|
|
||
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
||
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
||
|
|
<!--[if lt IE 9]>
|
||
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||
|
|
<![endif]-->
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||
|
|
</head>
|
||
|
|
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<div id="main">
|
||
|
|
|
||
|
|
<h1 class="page-title">Source: services/backend_script_api.js</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
<article>
|
||
|
|
<pre class="prettyprint source linenums"><code>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;</code></pre>
|
||
|
|
</article>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav>
|
||
|
|
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ApiToken.html">ApiToken</a></li><li><a href="Attribute.html">Attribute</a></li><li><a href="BackendScriptApi.html">BackendScriptApi</a></li><li><a href="Branch.html">Branch</a></li><li><a href="Entity.html">Entity</a></li><li><a href="Image.html">Image</a></li><li><a href="Note.html">Note</a></li><li><a href="NoteImage.html">NoteImage</a></li><li><a href="NoteRevision.html">NoteRevision</a></li><li><a href="Option.html">Option</a></li><li><a href="RecentNote.html">RecentNote</a></li></ul><h3><a href="global.html">Global</a></h3>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<br class="clear">
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Wed Aug 29 2018 20:44:06 GMT+0200 (CEST)
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
<script> prettyPrint(); </script>
|
||
|
|
<script src="scripts/linenumber.js"> </script>
|
||
|
|
</body>
|
||
|
|
</html>
|