Merge pull request #119 from renderforest/stage

release 0.3.0

Author: AlbertHambardzumyan

README.md

@@ -33,13 +33,15 @@ Welcome to the Renderforest API! You can use our API to:
       - [Get title](#get-title)
       - [Get mute music](#get-mute-music)
       - [Get sounds](#get-sounds)
-      - [Get theme](#get-theme)
+      - [Get styles](#get-styles)
+      - [Get voice-over](#get-voice-over)
       - [Get project colors](#get-project-colors)
       - [Get screens](#get-screens)
       - [Get screen areas](#get-screen-areas)
       - [Get patch object](#get-patch-object)
     * [Setters](#setters)
-      - [Set theme](#set-theme)
+      - [Set styles](#set-styles)
+      - [Set voice-over](#set-voice-over)
       - [Set mute music](#set-mute-music)
       - [Set sounds](#set-sounds)
       - [Set text on text holder area](#set-text-on-text-holder-area)
@@ -278,7 +280,8 @@ renderforest.getProjectData(payload)
     console.log('Title:', projectDataInstance.getTitle())
     console.log('Mute music:', projectDataInstance.getMuteMusic())
     console.log('Sounds:', projectDataInstance.getSounds())
-    console.log('Theme:', projectDataInstance.getTheme())
+    console.log('Styles:', projectDataInstance.getStyles())
+    console.log('VoiceOver:', projectDataInstance.getVoiceOver())
     console.log('Project colors:', projectDataInstance.getProjectColors())
     console.log('Screens:', projectDataInstance.getScreens())
 
@@ -385,9 +388,14 @@ projectDataInstance.getMuteMusic()  // false
 projectDataInstance.getSounds()  // Array of sound objects
 ```
 
-##### Get theme
+##### Get styles
 ```js
-projectDataInstance.getTheme()  // { themeVariableName: 'num', themeVariableValue: '2' }
+projectDataInstance.getStyles()  // { theme: '1', transition: '2' }
+```
+
+##### Get voice-over
+```js
+projectDataInstance.getVoiceOver() // { path: 'https://example.com/voice-over.mp3' }
 ```
 
 ##### Get project colors
@@ -415,14 +423,22 @@ projectDataInstance.getPatchObject()  // Object containing local updates. Used t
 
 #### Setters
 
-##### Set theme
+##### Set styles
+```js
+// get theme/transition from .templates API
+const styles = {
+  theme: '1', // optional
+  transition: '2' // optional
+}
+projectDataInstance.setStyles(styles)
+```
+
+##### Set voice-over
 ```js
-// get theme from .templates API
-const theme = {
-  themeVariableName: 'num',
-  themeVariableValue: '2'
+const voiceOver = {
+  path: 'https://example.com/voice-ower.mp3' // optional
 }
-projectDataInstance.setTheme(theme)
+projectDataInstance.setVoiceOver(voiceOver)
 ```
 
 ##### Set mute music
@@ -538,16 +554,7 @@ if (screens && screens[2]) {
 ```js
 // get project colors from ./templates API
 const projectColors = [
-  { id: 0, hexCode: 'ffffff' },
-  { id: 1, hexCode: 'a1d4ec' },
-  { id: 2, hexCode: '1d2e54' },
-  { id: 3, hexCode: '61a371' },
-  { id: 4, hexCode: 'a0b6e7' },
-  { id: 5, hexCode: 'e0d0ef' },
-  { id: 6, hexCode: '5c1313' },
-  { id: 7, hexCode: 'b2e1f4' },
-  { id: 8, hexCode: '706bb5' },
-  { id: 9, hexCode: 'b4ddf5' }
+  'ffffff', 'a1d4ec', '1d2e54', '61a371', 'a0b6e7', 'e0d0ef', '5c1313', 'b2e1f4', '706bb5', 'b4ddf5'
 ]
 projectDataInstance.setProjectColors(projectColors)
 ```

examples/project-data/get-project-data.js

@@ -22,7 +22,8 @@ renderforest.getProjectData(payload)
     console.log('Title:', projectDataInstance.getTitle())
     console.log('Mute music:', projectDataInstance.getMuteMusic())
     console.log('Sounds:', projectDataInstance.getSounds())
-    console.log('Theme:', projectDataInstance.getTheme())
+    console.log('Styles:', projectDataInstance.getStyles())
+    console.log('VoiceOver:', projectDataInstance.getVoiceOver())
     console.log('Project colors:', projectDataInstance.getProjectColors())
     console.log('Screens:', projectDataInstance.getScreens())
 

examples/project-data/update-project-data-partial-advanced.js

@@ -20,11 +20,16 @@ async function sample () {
   // make some change
   projectDataInstance.setMuteMusic(true)
 
-  const theme = {
-    themeVariableName: 'num',
-    themeVariableValue: '2'
+  const styles = {
+    theme: '1', // optional
+    transition: '2' // optional
   }
-  projectDataInstance.setTheme(theme) // get theme from ./templates API
+  projectDataInstance.setStyles(styles) // get theme/transition from ./templates API
+
+  const voiceOver = {
+    path: 'https://example.com/voice-ower.mp3' // optional
+  }
+  projectDataInstance.setVoiceOver(voiceOver)
 
   // sound from ./sounds API
   const sound1 = {
@@ -115,17 +120,9 @@ async function sample () {
   }
 
   const projectColors = [
-    { id: 0, hexCode: 'ffffff' },
-    { id: 1, hexCode: 'a1d4ec' },
-    { id: 2, hexCode: '1d2e54' },
-    { id: 3, hexCode: '61a371' },
-    { id: 4, hexCode: 'a0b6e7' },
-    { id: 5, hexCode: 'e0d0ef' },
-    { id: 6, hexCode: '5c1313' },
-    { id: 7, hexCode: 'b2e1f4' },
-    { id: 8, hexCode: '706bb5' },
-    { id: 9, hexCode: 'b4ddf5' }
+    'ffffff', 'a1d4ec', '1d2e54', '61a371', 'a0b6e7', 'e0d0ef', '5c1313', 'b2e1f4', '706bb5', 'b4ddf5'
   ]
+
   projectDataInstance.setProjectColors(projectColors) // get project colors from ./templates API
 
   const screen = {

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@renderforest/sdk-node",
   "description": "Renderforest SDK for Node.js",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "author": "RenderForest LLC",
   "bugs": {
     "url": "https://github.com/renderforest/renderforest-sdk-node/issues"

package.json

@@ -111,30 +111,6 @@ class ProjectData {
     this.patchProperties.push('projectColors')
   }
 
-  /**
-   * @returns {Object}
-   * @description Get the project theme.
-   */
-  getTheme () {
-    return {
-      themeVariableName: this.projectDataJson.data['themeVariableName'],
-      themeVariableValue: this.projectDataJson.data['themeVariableValue']
-    }
-  }
-
-  /**
-   * @param {Object} payload
-   * @param {string} payload.themeVariableName
-   * @param {string} payload.themeVariableValue
-   * @description Set the project theme.
-   */
-  setTheme (payload) {
-    this.projectDataJson.data['themeVariableName'] = payload.themeVariableName
-    this.projectDataJson.data['themeVariableValue'] = payload.themeVariableValue
-    this.patchProperties.push('themeVariableName')
-    this.patchProperties.push('themeVariableValue')
-  }
-
   /**
    * @returns {Array}
    * @description Get the project sounds.
@@ -152,6 +128,40 @@ class ProjectData {
     this.patchProperties.push('sounds')
   }
 
+  /**
+   * @returns {Object}
+   * @description Get the project styles.
+   */
+  getStyles () {
+    return this.projectDataJson.data['styles']
+  }
+
+  /**
+   * @param {Object} styles
+   * @description Set the project styles.
+   */
+  setStyles (styles) {
+    this.projectDataJson.data['styles'] = styles
+    this.patchProperties.push('styles')
+  }
+
+  /**
+   * @returns {Object}
+   * @description Get the project voiceOver.
+   */
+  getVoiceOver () {
+    return this.projectDataJson.data['voiceOver']
+  }
+
+  /**
+   * @param {Object} voiceOver
+   * @description Set the project voiceOver.
+   */
+  setVoiceOver (voiceOver) {
+    this.projectDataJson.data['voiceOver'] = voiceOver
+    this.patchProperties.push('voiceOver')
+  }
+
   /**
    * @returns {string}
    * @description Get the project title.

src/classes/project-data.js

@@ -46,6 +46,6 @@ class ProjectData {
   }
 }
 
-ProjectData.API_PREFIX = '/api/v4'
+ProjectData.API_PREFIX = '/api/v5'
 
 module.exports = ProjectData