feat(embed): export scores as png

FlatIO · Jul 5, 2017 · 28ea1f8 · 28ea1f8
1 parent 10ac08a
commit 28ea1f8
Show file tree

Hide file tree

Showing 9 changed files with 91 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.4.0
+
+* Add method: `getPNG`
+
 ## v0.3.0
 
 * Add methods: `getEmbedConfig`, `setEditorConfig`, `edit`

diff --git a/README.md b/README.md
@@ -86,6 +86,7 @@ When instantiating `Flat.Embed`, you can pass options in the second parameter. I
   * [`loadJSON`](#loadjsonscore-object-promisevoid-error): Load Flat JSON file
   * [`getMusicXML`](#getmusicxmloptions-object-promisestringuint8array-error): Get the score in MusicXML (compressed or not)
   * [`getJSON`](#getjson-object): Get the score data in Flat JSON format
+  * [`getPNG`](#getpngoptions-object-promisestringuint8array-error): Get the score as a PNG file
   * [`getScoreMeta`](#getscoremeta-object): Get the metadata from the current score (for hosted scores)
   * [`fullscreen`](#fullscreenstate-bool-promisevoid-error): Toggle fullscreen mode
   * [`play`](#play-promisevoid-error): Start playback
@@ -272,6 +273,26 @@ embed.getJSON().then(function (data) {
 });
 ```
 
+### `getPNG(options?: object): Promise<string|Uint8Array, Error>`
+
+Get the current displayed score as a PNG file
+
+```js
+// PNG
+embed.getPNG().then(function (png) {
+  // PNG file as a Uint8Array
+  console.log(png);
+});
+```
+
+```js
+// PNG
+embed.getPNG({result: 'dataURL'}).then(function (png) {
+  // PNG file as a DataURL
+  console.log(png);
+});
+```
+
 ### `getScoreMeta(): object`
 
 Get the score metadata of the hosted score. The object will have the same format that the one returned [by our API `GET /v2/scores/{score}`](https://flat.io/developers/api/reference/#operation/getScore).

diff --git a/dist/embed.js b/dist/embed.js
diff --git a/dist/embed.js.map b/dist/embed.js.map
diff --git a/dist/embed.min.js b/dist/embed.min.js
diff --git a/dist/embed.min.js.map b/dist/embed.min.js.map
diff --git a/package.json b/package.json
@@ -54,6 +54,7 @@
     "rollup": "^0.42.0",
     "rollup-plugin-babel": "^2.7.1",
     "rollup-plugin-commonjs": "^8.0.2",
+    "rollup-plugin-hypothetical": "^1.2.1",
     "rollup-plugin-node-resolve": "^3.0.0",
     "uglify-js": "^3.0.0"
   }

diff --git a/rollup.js b/rollup.js
@@ -9,6 +9,7 @@ const rollup = require('rollup');
 const babel = require('rollup-plugin-babel');
 const resolve = require('rollup-plugin-node-resolve');
 const commonjs = require('rollup-plugin-commonjs');
+const hypothetical = require('rollup-plugin-hypothetical');
 
 // Banner
 const pkg = require('./package.json');
@@ -37,6 +38,12 @@ const build = () => {
   rollup.rollup({
     entry: 'src/embed.js',
     plugins: [
+      hypothetical({
+        allowRealFiles: true,
+        files: {
+          './node_modules/core-js/library/modules/es6.object.to-string.js': 'export default null'
+        }
+      }),
       babel({
         runtimeHelpers: true,
         exclude: 'node_modules/**'
@@ -62,14 +69,15 @@ const build = () => {
     fs.writeFileSync('dist/embed.js.map', map.toString());
 
     const minified = uglifyJs.minify(code, {
-      fromString: true,
-      inSourceMap: map,
-      outSourceMap: 'dist/embed.min.js.map',
+      sourceMap: {
+        content: map,
+        filename: 'dist/embed.min.js.map'
+      },
       output: {
         preamble: banner
       },
       mangle: {
-        except: ['Embed']
+        reserved: ['Embed']
       }
     });
 

diff --git a/src/embed.js b/src/embed.js
@@ -171,7 +171,7 @@ class Embed {
       if (typeof options !== 'object') {
         return reject(new TypeError('Options must be an object'));
       }
-      this.call('getMusicXML', options).then(function (data) {
+      this.call('getMusicXML', options).then((data) => {
         // Plain XML
         if (typeof data === 'string') {
           return resolve(data);
@@ -182,6 +182,28 @@ class Embed {
     });
   }
 
+  /**
+   * Convert the displayed score in PNG
+   *
+   * @return {Promise}
+   * @fullfill {Uint8Array} PNG File
+   * @reject {Error} Conversion error
+   */
+   getPNG(options) {
+     return new Promise((resolve, reject) => {
+       options = options || {};
+       if (typeof options !== 'object') {
+         return reject(new TypeError('Options must be an object'));
+       }
+       this.call('getPNG', options).then((data) => {
+         if (typeof data === 'string') {
+           return resolve(data);
+         }
+         return resolve(new Uint8Array(data));
+       }).catch(reject);
+     });
+   }
+
   /**
    * Get the metadata of the score (for scores hosted on Flat)
    *