Start refactor and add variable support for item names

README.md

@@ -35,7 +35,7 @@ As developers of production software we found ourselves in a position of rebuild
 - [ ] A fully customizable grid layout
 
 ## Download and install  
-Built packages are available on the releases page.
+Built binaries are available on the releases page.
 
 [Releases and downloads](https://github.com/svt/bridge/releases)
 
@@ -46,7 +46,9 @@ The full documentation is hosted in this repository under the [`docs`](/docs/REA
 [Full documentation](/docs/README.md)
 
 ## Security  
-Always keep an eye open when interacting with third party code. As a general rule, **never run code you don't trust.** This includes third party plugins as they have a great amount of access when running on your computer or server.
+We do our best to keep this software secure and its dependencies up-to-date.  
+Be careful when installing and running third party plugins.  
+Please see our security policy for instructions on how to report security issues. 
 
 ## License
 

api/items.js

@@ -221,7 +221,7 @@ function deepClone (obj) {
 
 /**
  * Populate any variable placeholders
- * in an item's properities - in place
+ * in an item's properties - in place
  *
  * @param { any } item
  * @param { any } type
@@ -359,3 +359,30 @@ async function removeIssue (itemId, issueId) {
   })
 }
 exports.removeIssue = removeIssue
+
+/**
+ * Render a value for an item by its id,
+ * this will replace any variable placeholders
+ *
+ * @example
+ *
+ * Item {
+ *  id: '1234',
+ *  data: {
+ *    name: '$(this.data.myValue)',
+ *    myValue: 'Hello World'
+ *  }
+ * }
+ *
+ * renderValue('1234', 'data.name') -> 'Hello World'
+ *
+ * @param { String } itemId The id of the item
+ * @param { String } path The path to the value to render
+ * @returns { Promise.<String | any | undefined> }
+ */
+async function renderValue (itemId, path) {
+  const item = await getItem(itemId)
+  const currentValue = objectPath.get(item || {}, path)
+  return variables.substituteInString(currentValue, undefined, { this: item })
+}
+exports.renderValue = renderValue

api/variables.js

@@ -2,6 +2,8 @@
 //
 // SPDX-License-Identifier: MIT
 
+const objectPath = require('object-path')
+
 const commands = require('./commands')
 const state = require('./state')
 
@@ -44,12 +46,18 @@ exports.getAllVariables = getAllVariables
  * "Hello $(my variable)" -> "Hello world"
  *
  * @param { String } str
- * @param { any } data Data to substitute variables for,
- *                     defaults to the local state
+ * @param { any } data          Data to substitute variables for,
+ *                              defaults to the local state
+ * @param { any } overrideData  Data that will override the
+ *                              default data rather than replace
  * @returns { String }
  */
-function substituteInString (str, data = (state.getLocalState()?.variables || {})) {
+function substituteInString (str, data = (state.getLocalState()?.variables || {}), overrideData = {}) {
   const text = str.split(VARIABLE_REGEX)
+  const values = {
+    ...data,
+    ...overrideData
+  }
 
   let out = ''
   let i = 0
@@ -58,8 +66,8 @@ function substituteInString (str, data = (state.getLocalState()?.variables || {}
     if (i % 2 === 0) {
       out += text.shift()
     } else {
-      const variableName = text.shift()
-      const value = data[variableName]
+      const path = text.shift()
+      const value = objectPath.get(values, path)
       out += value || ''
     }
     i++

docs/api/README.md

@@ -341,7 +341,7 @@ Play an item and set its state to 'playing'.
 Stop an item and set its state to 'stopped'.
 
 ### `bridge.items.applyIssue(itemId, issueId, issueSpec): Promise<Void>`  
-Add an issue to an item
+Add an issue to an item.
 
 **Example**
 ```javascript
@@ -358,6 +358,9 @@ Remove an issue from an item
 bridge.items.removeIssue('6jI2', 'myIssue')
 ```
 
+### `bridge.items.renderValue(itemId, path): Promise<String | any | undefined>`  
+Render a specific value for an item.
+
 ## Client  
 **The client api between the renerer and main processes**  
 Control aspects of clients