@pixwel/pixwel-sdk 1.1.0

package/dist/src/IngestFile.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+	value: true
+});
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+var IngestFile = function IngestFile(file, order) {
+	_classCallCheck(this, IngestFile);
+
+	this.file = file;
+}
+// renderedName, ingest, options
+;
+
+exports.default = IngestFile;

package/dist/src/IngestFileDrop.js

@@ -0,0 +1,178 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+	value: true
+});
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+var _pixwelSdk = require("@pixwel/pixwel-sdk");
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+/**
+ * Collects file handles from HTML5, full paths from Aspera, inspects
+ * the dropped file using mediainfo, then renames the file according to
+ * the data from Mediainfo and the Order and submits it for upload.
+ * @type {Object}
+ */
+var IngestFileDrop = function () {
+	/**
+  * Map that contains data from HTML5 file drop and Aspera file drop
+  * @type {Object}
+  */
+	function IngestFileDrop(scope, Mediainfo, IngestUpload) {
+		_classCallCheck(this, IngestFileDrop);
+
+		this.map = {};
+		this.scope = scope;
+		this.IngestUpload = IngestUpload;
+		this.Mediainfo = Mediainfo;
+		this.asperaDropHandler = this.asperaDropHandler.bind(this);
+		this.htmlDropHandler = this.htmlDropHandler.bind(this);
+	}
+	/**
+  * HTML file drop handler
+  * @param  {[type]} e [description]
+  * @return {[type]}   [description]
+  */
+
+
+	_createClass(IngestFileDrop, [{
+		key: "htmlDropHandler",
+		value: function htmlDropHandler(e) {
+			var files = e.dataTransfer.files;
+			for (var i = 0; i < files.length; i++) {
+				this.registerHtmlFile(files[i]);
+			}
+		}
+		/**
+   * Aspera drop handler
+   * @param  {[type]} data [description]
+   * @return {[type]}      [description]
+   */
+
+	}, {
+		key: "asperaDropHandler",
+		value: function asperaDropHandler(data) {
+			var that = this;
+			var files = data.files.dataTransfer.files;
+			if (!files.length) {
+				return;
+			}
+			for (var i = 0; i < files.length; i++) {
+				this.registerAsperaFile(files[i]);
+			}
+			return Promise.all(this.export()).then(function (renamed) {
+				that.IngestUpload.uploadFiles(renamed, {}).then(function () {
+					that.map = {};
+				});
+			});
+		}
+		/**
+   * Registers and HTML file drop
+   * @param  {[type]} file [description]
+   * @return {[type]}      [description]
+   */
+
+	}, {
+		key: "registerHtmlFile",
+		value: function registerHtmlFile(file) {
+			this.map[file.name] = file;
+		}
+		/**
+   * Registers and Aspera file drop
+   * @param  {[type]} file [description]
+   * @return {[type]}      [description]
+   */
+
+	}, {
+		key: "registerAsperaFile",
+		value: function registerAsperaFile(file) {
+			var basename = this.getBasename(file);
+			this.map[basename]["path"] = file.name;
+		}
+		/**
+   * Gets correct basename for MacOS and Windows
+   * @param  {[type]} file [description]
+   * @return {[type]}      [description]
+   */
+
+	}, {
+		key: "getBasename",
+		value: function getBasename(file) {
+			return file.name[0] === "/" ? file.name.split("/").pop() : file.name.split("\\").pop();
+		}
+		/**
+   * Renames and generates ingest record for internal filemap
+   * @return {[type]} [description]
+   */
+
+	}, {
+		key: "export",
+		value: function _export() {
+			var that = this;
+			return Object.values(this.map).map(function (file) {
+				return that.rename(file);
+			});
+		}
+		/**
+   * Renames the file and decorates it with ingest data using data from
+   * mediainfo and the Order
+   * @param  {[type]} file [description]
+   * @return {[type]}      [description]
+   */
+
+	}, {
+		key: "rename",
+		value: function rename(file) {
+			var that = this;
+			return this.Mediainfo.inform(file).then(function (meta) {
+				var order = void 0;
+				var asset = void 0;
+				var mediaType = file.type.split("/")[0];
+
+				var tags = _pixwelSdk.Ingest.mapMetaToTags(meta, mediaType);
+
+				if (!that.scope.workRequest) {
+					order = new _pixwelSdk.Order();
+					asset = new _pixwelSdk.Asset();
+					tags.Text = "txtd";
+					file.ingest = _pixwelSdk.Ingest.mapFromKnownData(that.scope.context, order, tags, that.scope.watermarks);
+					return file;
+				}
+
+				order = new _pixwelSdk.Order(that.scope.workRequest);
+				asset = _pixwelSdk.Asset.mapFromOrder(order);
+
+				var options = {
+					tags: tags,
+					country: order.country,
+					language: order.language
+				};
+
+				if (that.scope.request && that.scope.request.tag) {
+					options.tags.Extra = [that.scope.request.tag.replace(" ", "-")];
+				}
+
+				options.tags.SubDub = {
+					sub: order.isSub(),
+					dub: order.isDub()
+				};
+				if (!order.isSub() && !order.isDub()) {
+					options.tags.Text = "txtd";
+				}
+
+				var basename = _pixwelSdk.Filename.render(that.scope.tags, that.scope.assetTypes, asset, options, mediaType);
+				var extension = file.name.split(".").pop();
+				file.renderedName = basename + "." + extension;
+				file.ingest = _pixwelSdk.Ingest.mapFromKnownData(that.scope.context, order, tags, that.scope.watermarks);
+				return file;
+			});
+		}
+	}]);
+
+	return IngestFileDrop;
+}();
+
+exports.default = IngestFileDrop;

package/dist/src/Order.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+	value: true
+});
+
+var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }();
+
+var _lodash = require("lodash");
+
+var _lodash2 = _interopRequireDefault(_lodash);
+
+var _Filename = require("./Filename.js");
+
+var _Filename2 = _interopRequireDefault(_Filename);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+var Order = function () {
+	function Order(data) {
+		_classCallCheck(this, Order);
+
+		var schema = {
+			_id: null,
+			asset: null,
+			project: null,
+			assetType: null,
+			country: null,
+			language: null,
+			dng: null
+		};
+		Object.assign(this, schema, data);
+	}
+
+	_createClass(Order, [{
+		key: "isDub",
+		value: function isDub() {
+			if (!this.dng) {
+				return null;
+			}
+			return _lodash2.default.flattenDeep(Object.entries(this.dng)).includes("Dedicated / Localized");
+		}
+	}, {
+		key: "isSub",
+		value: function isSub() {
+			if (!this.dng) {
+				return null;
+			}
+			return _lodash2.default.flattenDeep(Object.entries(this.dng)).includes("Subtitled");
+		}
+	}]);
+
+	return Order;
+}();
+
+exports.default = Order;

package/dist/src/Srt.js

@@ -0,0 +1,102 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+
+var _lodash = require('lodash');
+
+var _lodash2 = _interopRequireDefault(_lodash);
+
+var _TimeFormat = require('./TimeFormat');
+
+var _TimeFormat2 = _interopRequireDefault(_TimeFormat);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function stripTags(input, allowed) {
+    allowed = (((allowed || '') + '').toLowerCase().match(/<[a-z][a-z0-9]*>/g) || []).join('');
+    var tags = /<\/?([a-z][a-z0-9]*)\b[^>]*>/gi;
+    var commentsAndPhpTags = /<!--[\s\S]*?-->|<\?(?:php)?[\s\S]*?\?>/gi;
+    return input.replace(commentsAndPhpTags, '').replace(tags, function ($0, $1) {
+        return allowed.indexOf('<' + $1.toLowerCase() + '>') > -1 ? $0 : '';
+    });
+}
+
+var SRT_STATE_SUBNUMBER = 0,
+    SRT_STATE_TIME = 1,
+    SRT_STATE_TEXT = 2,
+    SRT_STATE_BLANK = 3;
+
+exports.default = {
+    parse: function parse(lines) {
+        var result = [],
+            state = SRT_STATE_SUBNUMBER,
+            subText = '',
+            subTime = '';
+
+        function time(subTime) {
+
+            var range = subTime.split(' --> ');
+            if (!_TimeFormat2.default.isValidTime(range[0]) || !_TimeFormat2.default.isValidTime(range[1])) {
+                throw new Error('Malformed SRT file');
+            }
+
+            return {
+                startTime: range[0],
+                stopTime: range[1]
+            };
+        }
+
+        lines.forEach(function (line) {
+            line = line.replace(/^\s+|\s+$/g, '');
+
+            switch (state) {
+                case SRT_STATE_SUBNUMBER:
+                    state = SRT_STATE_TIME;
+                    break;
+
+                case SRT_STATE_TIME:
+                    subTime = line;
+                    state = SRT_STATE_TEXT;
+                    break;
+
+                case SRT_STATE_TEXT:
+                    if (line !== '') {
+                        subText += subText ? "\n" + line : line;
+                        return;
+                    }
+                    result.push(Object.assign(time(subTime), {
+                        text: subText
+                    }));
+                    subText = '';
+                    state = SRT_STATE_SUBNUMBER;
+                    break;
+            }
+        });
+
+        return result;
+    },
+    export: function _export(lines) {
+        var result = '',
+            i = 1;
+
+        lines.forEach(function (line) {
+            if (line.text === undefined) {
+                return;
+            }
+
+            // Replace <br> tags with newlines. These tags may accidentally be stored in the translation
+            var text = _lodash2.default.unescape(line.text.replace(/<br>/g, '\n'));
+
+            // Remove any tags that may have made it into the translation (div tags seem to be the main problem).
+            // <b> <i> are the only two supported tags currently
+            text = stripTags(text, '<b><i>');
+
+            result += i++ + "\n";
+            result += _TimeFormat2.default.startTime(line) + " --> " + _TimeFormat2.default.stopTime(line) + "\n";
+            result += text + "\n\n";
+        });
+        return result;
+    }
+};

package/dist/src/Sub.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+exports.default = {
+    parse: function parse(lines) {
+        var result = [],
+            current = {
+            text: ""
+        };
+
+        lines.forEach(function (line) {
+            line = line.replace(/^\s+|\s+$/g, '');
+            var subTime = line.match(/^([0-9:\.]+),([0-9:\.]+)$/);
+
+            if (subTime) {
+                if (current.text) {
+                    result.push(current);
+                }
+                current = {
+                    startTime: subTime[1],
+                    stopTime: subTime[2],
+                    text: ""
+                };
+                return;
+            }
+
+            if (line) {
+                if (current.startTime === undefined || current.stopTime === 'undefined') {
+                    throw new Error('Malformed SUB file');
+                }
+                current.text += current.text ? "\n" + line : line;
+            }
+        });
+
+        if (current.text) {
+            result.push(current);
+        }
+        return result;
+    }
+};

package/dist/src/TimeFormat.js

@@ -0,0 +1,48 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+var stringRegex = /^(\d+):(\d+):(\d+)[,|.](\d{2,3})?$/;
+
+exports.default = {
+    isValidTime: function isValidTime(time) {
+        return !!time.match(stringRegex);
+    },
+    timeToTimestamp: function timeToTimestamp(time) {
+        var match = time.match(stringRegex);
+        if (!match) {
+            return 0;
+        }
+        var precision = match[4].length === 2 ? 100 : 1000;
+        return parseInt(match[1], 10) * 60 * 60 + parseInt(match[2], 10) * 60 + parseInt(match[3], 10) + parseInt(match[4], 10) / precision;
+    },
+    timestampToTime: function timestampToTime(second, decimalMark) {
+        var hours = ~~(second / 3600);
+        var min = ~~(second / 60) % 60;
+        var sec = second % 60;
+        var fixedSec = sec.toFixed(3).replace('.', decimalMark ? decimalMark : ',');
+        return (hours < 10 ? '0' + hours : hours) + ":" + (min < 10 ? '0' + min : min) + ':' + (sec < 10 ? '0' + fixedSec : fixedSec);
+    },
+    timeDiff: function timeDiff(time1, time2) {
+        if (time1 === undefined || time2 === undefined) {
+            return 0;
+        }
+        return this.timestampDiff(this.timeToTimestamp(time1), this.timeToTimestamp(time2));
+    },
+    timestampDiff: function timestampDiff(time1, time2) {
+        if (time1 === undefined || time2 === undefined || time1 === time2) {
+            return 0;
+        }
+        var diff = time2 - time1;
+        return Math.round(Math.max(-1, Math.min(1, diff)) * 10) / 10;
+    },
+    startTime: function startTime(line) {
+        var timestamp = this.timeToTimestamp(line.startTime) + (line.inOffset || 0);
+        return this.timestampToTime(timestamp);
+    },
+    stopTime: function stopTime(line) {
+        var timestamp = this.timeToTimestamp(line.stopTime) + (line.outOffset || 0);
+        return this.timestampToTime(timestamp);
+    }
+};

package/index.js

@@ -0,0 +1,6 @@
+export { default as Asset } from './src/Asset';
+export { default as Filename } from './src/Filename';
+export { default as Ingest } from './src/Ingest';
+export { default as IngestFile } from './src/IngestFile';
+export { default as IngestFileDrop } from './src/IngestFileDrop';
+export { default as Order } from './src/Order';

package/package.json

@@ -0,0 +1,26 @@
+{
+    "name": "@pixwel/pixwel-sdk",
+    "description": "",
+    "version": "1.1.0",
+    "author": "Pixwel",
+    "license": "UNLICENSED",
+    "main": "./dist/index.js",
+    "scripts": {
+        "build": "babel -d dist index.js src/*.js",
+        "test": "jest --coverage"
+    },
+    "jest": {
+        "verbose": true,
+        "coverageDirectory": "coverage",
+        "collectCoverage": true,
+        "collectCoverageFrom": [
+            "src/*.js"
+        ]
+    },
+    "devDependencies": {
+        "babel-cli": "^6.26.0",
+        "babel-preset-env": "^1.7.0",
+        "jest": "^22.4.4",
+        "lodash": "^4.17.10"
+    }
+}

package/src/Ass.js

@@ -0,0 +1,195 @@
+import _ from 'lodash';
+import TimeFormat from './TimeFormat';
+
+function trim(str) {
+    return str.replace(/^\s+|\s+$/g, '');
+}
+
+function searchIndex(lines, pattern, startIndex) {
+    var len = lines.length;
+    startIndex = startIndex || 0;
+
+    for (var i = startIndex; i < len; i++) {
+        var line = lines[i];
+        if (line.match(pattern)) {
+            return i;
+        }
+    }
+    return false;
+}
+
+function extractStyles(lines) {
+    var line, styles = {};
+
+    var currentIndex = searchIndex(lines, /^\[V4\+ Styles\]$/);
+
+    if (currentIndex === false) {
+        return styles;
+    }
+
+    currentIndex = searchIndex(lines, /^Format:/, ++currentIndex);
+
+    if (currentIndex === false) {
+        return styles;
+    }
+
+    line = trim(lines[currentIndex]);
+    var fields = line.replace(/^Format:\s+/, '').split(/\s*,\s*/);
+    var nameIndex = fields.indexOf('Name');
+    var alignmentIndex = fields.indexOf('Alignment');
+
+    if (nameIndex === -1) {
+        return styles;
+    }
+
+    var pattern = new RegExp('^' + (new Array(fields.length).join('\s*(.*?)\s*,')) + '(.*?)$');
+
+    currentIndex = searchIndex(lines, /^Style:/, ++currentIndex);
+
+    while (currentIndex !== false) {
+        line = trim(lines[currentIndex]);
+
+        var parts = line.replace(/^Style:\s+/, '').match(pattern);
+        if (!parts) {
+            throw new Error('Error, missing fields in a `Style` entry');
+        }
+        if (parts.length) {
+            var style = {};
+            if (alignmentIndex !== -1) {
+                var alignmentNumber = parts[alignmentIndex + 1];
+                style.alignment = alignmentNumber >= 7 ? 'top' : 'bottom';
+            }
+            styles[parts[nameIndex + 1]] = style;
+        }
+        currentIndex = searchIndex(lines, /^Style:/, ++currentIndex);
+    }
+    return styles;
+}
+
+export default {
+    parse: function(lines) {
+        var line;
+        var currentIndex = 0;
+
+        function normalizeTime(time) {
+            if (time.charAt(1) === ':') {
+                time = '0' + time;
+            }
+            return time.replace('.', ',') + '0';
+        }
+
+        function normalizeText(text) {
+            return text.replace(/\\n|\\N/, '\n')
+                .replace(/{\\(.*)1}(.*){\\\1[0]}/g, function(match, tag, content) {
+                    return '<' + tag + '>' + content + '</' + tag + '>';
+                });
+        }
+
+        var styles = extractStyles(lines);
+
+        currentIndex = searchIndex(lines, /^\[Events\]$/);
+
+        if (currentIndex === false) {
+            throw new Error('Error, missing `[Events]` section');
+        }
+
+        currentIndex = searchIndex(lines, /^Format:/, ++currentIndex);
+
+        if (currentIndex === false) {
+            throw new Error('Error, missing `Format` entry');
+        }
+
+        line = trim(lines[currentIndex]);
+        var fields = line.replace(/^Format:\s+/, '').split(/\s*,\s*/);
+        var startIndex = fields.indexOf('Start');
+        var endIndex = fields.indexOf('End');
+        var styleIndex = fields.indexOf('Style');
+        var textIndex = fields.indexOf('Text');
+
+        if (startIndex === -1 || endIndex === -1 || textIndex === -1) {
+            throw new Error('Error, missing fields in a `Format` entry');
+        }
+
+        var result = [];
+        var pattern = new RegExp('^' + (new Array(fields.length).join('\s*(.*?)\s*,')) + '(.*?)$');
+
+        currentIndex = searchIndex(lines, /^Dialogue:/, ++currentIndex);
+
+        while (currentIndex !== false) {
+            line = trim(lines[currentIndex]);
+            var parts = line.replace(/^Dialogue:\s+/, '').match(pattern);
+            if (!parts) {
+                throw new Error('Error, missing fields in a `Dialogue` entry');
+            }
+            if (parts.length) {
+                var entry = {
+                    startTime: normalizeTime(parts[startIndex + 1]),
+                    stopTime: normalizeTime(parts[endIndex + 1]),
+                    text: normalizeText(parts[textIndex + 1]),
+                    alignment: 'bottom'
+                };
+                if (styleIndex !== -1) {
+                    var style = styles[parts[styleIndex + 1]];
+                    if (style && style.alignment) {
+                        entry.alignment = style.alignment;
+                    }
+                }
+                result.push(entry);
+            }
+            currentIndex = searchIndex(lines, /^Dialogue:/, ++currentIndex);
+        }
+        return result;
+    },
+    export: function(lines, options) {
+        var result = '';
+
+        options = options || {};
+
+        var font = options.font || {
+            face: 'Arial',
+            size: 20
+        };
+
+        result += "[Script Info]\n";
+        result += "ScriptType: v4.00+\n\n";
+
+        result += "[V4+ Styles]\n";
+        result += "Format: Name, Fontname, Fontsize, PrimaryColour,Shadow,MarginV,Alignment\n";
+        result += "Style: Bottom," + font.face + "," + font.size + ",&H00FFFFFF,1,20,2\n";
+        result += "Style: Top," + font.face + "," + font.size + ",&H00FFFFFF,1,20,8\n\n";
+
+        result += "[Events]\n";
+        result += "Format: Layer, Start, End, Style, Text\n";
+
+        function normalizeTime(time) {
+            if (time.charAt(0) === '0') {
+                time = time.substr(1);
+            }
+            return time.replace(',', '.').slice(0, -1);
+        }
+
+        function normalizeText(text) {
+            return _.unescape(text
+                .replace(/<div>/g, '\\N')
+                .replace(/<\/div>/g, '')
+                .replace(/\n/g, '\\N')
+                .replace(/<br>/g, '\\N')
+                .replace(/<i>/g, '{\\i1}')
+                .replace(/<\/i>/g, '{\\i0}')
+                .replace(/<b>/g, '{\\b1}')
+                .replace(/<\/b>/g, '{\\b0}'))
+        }
+
+        lines.forEach(function(line) {
+            if (line.text === undefined) {
+                return;
+            }
+            result += "Dialogue: 0";
+            result += "," + normalizeTime(TimeFormat.startTime(line));
+            result += "," + normalizeTime(TimeFormat.stopTime(line));
+            result += line.alignment === 'top' ? ",Top" : ",Bottom";
+            result += "," + normalizeText(line.text) + "\n";
+        });
+        return result;
+    }
+};

package/src/Asset.js

@@ -0,0 +1,20 @@
+export default class Asset {
+	static mapFromOrder(order) {
+		if (!order) {
+			throw new Error("missing order");
+		}
+		if (!order.asset) {
+			throw new Error("missing order.asset");
+		}
+		if (!order.project) {
+			throw new Error("missing order.project");
+		}
+		if (!order.project.slug) {
+			throw new Error("missing order.project.slug");
+		}
+		var asset = order.asset;
+		asset.project = order.project;
+		asset.project.filePrefix = order.project.slug.toUpperCase();
+		return asset;
+	}
+}