@pixwel/pixwel-sdk 2.0.0 → 2.1.0

package/dist/src/Ingest.js

@@ -4,34 +4,307 @@ 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 _getPrototypeOf = require("babel-runtime/core-js/object/get-prototype-of");
+
+var _getPrototypeOf2 = _interopRequireDefault(_getPrototypeOf);
+
+var _classCallCheck2 = require("babel-runtime/helpers/classCallCheck");
+
+var _classCallCheck3 = _interopRequireDefault(_classCallCheck2);
+
+var _createClass2 = require("babel-runtime/helpers/createClass");
+
+var _createClass3 = _interopRequireDefault(_createClass2);
+
+var _possibleConstructorReturn2 = require("babel-runtime/helpers/possibleConstructorReturn");
+
+var _possibleConstructorReturn3 = _interopRequireDefault(_possibleConstructorReturn2);
+
+var _inherits2 = require("babel-runtime/helpers/inherits");
+
+var _inherits3 = _interopRequireDefault(_inherits2);
 
 var _lodash = require("lodash");
 
 var _lodash2 = _interopRequireDefault(_lodash);
 
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+var _File = require("./File");
+
+var _File2 = _interopRequireDefault(_File);
+
+var _Model2 = require("./Model");
+
+var _Model3 = _interopRequireDefault(_Model2);
 
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+var _fileType = require("./fileType");
+
+var _ramda = require("ramda");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 /**
  * [media description]
  * @type {[type]}
  */
-var Ingest = function () {
-	function Ingest() {
-		_classCallCheck(this, Ingest);
+var Ingest = function (_Model) {
+	(0, _inherits3.default)(Ingest, _Model);
+
+	function Ingest(data) {
+		(0, _classCallCheck3.default)(this, Ingest);
+
+		var _this = (0, _possibleConstructorReturn3.default)(this, (Ingest.__proto__ || (0, _getPrototypeOf2.default)(Ingest)).call(this, data));
+
+		_this._resource = "ingests";
+		return _this;
 	}
 
-	_createClass(Ingest, null, [{
-		key: "mapFromMediainfo",
+	(0, _createClass3.default)(Ingest, [{
+		key: "renderPath",
+
+		/**
+   * Returns path given an ingest record
+   *
+   */
+		value: function renderPath() {
+			var ingest = this.data();
+			if (!ingest.asset.project.studio.slug) {
+				throw new Error("missing studio slug");
+			}
+			if (!ingest.asset.project.slug) {
+				throw new Error("missing asset.project.slug");
+			}
+			if (!ingest.asset.project.slug) {
+				throw new Error("missing asset.project.slug");
+			}
+			return [ingest.asset.project.studio.slug, ingest.asset.project.slug, ingest.asset.type].join("/");
+		}
+		/**
+   * Create a File from an Ingest object with path and filename
+   *
+   * @param {object} params
+   */
+
+	}, {
+		key: "renderFilename",
+		value: function renderFilename() {
+			var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : params = {},
+			    allTags = _ref.allTags,
+			    allTypes = _ref.allTypes,
+			    order = _ref.order;
+
+			var asset = this.data().asset;
+			var options = this.data().selected.download;
+			var mediaType = this.data().asset.mediaType;
+
+			if (!asset.project) {
+				throw new Error("missing asset.project");
+			}
+
+			if (asset.project && !asset.project.filePrefix) {
+				throw new Error("missing asset.project.filePrefix");
+			}
+
+			if (!asset.name) {
+				throw new Error("missing asset.name");
+			}
+
+			if (!asset.type) {
+				throw new Error("missing asset.type");
+			}
+
+			var defaults = {
+				language: null,
+				country: null,
+				version: null,
+				tags: {
+					Usage: null,
+					Aspect: null,
+					SubDub: {
+						sub: null,
+						dub: null
+					},
+					Resolution: null,
+					"Frame Mode": null,
+					Framerate: null,
+					Text: null,
+					Codec: null,
+					Extra: []
+				}
+			};
+			options = _lodash2.default.merge(defaults, options);
+
+			if (!options.language) {
+				throw new Error("missing options.language");
+			}
+
+			if (mediaType && mediaType == "video" && !options.tags.Codec) {
+				throw new Error("missing options.tags.Codec");
+			}
+
+			if (mediaType && mediaType == "video" && !options.tags.Resolution) {
+				throw new Error("missing options.tags.Resolution");
+			}
+
+			if (mediaType && mediaType == "video" && !options.tags.Framerate) {
+				throw new Error("missing options.tags.Framerate");
+			}
+
+			if (mediaType == "video" && !options.tags["Frame Mode"]) {
+				throw new Error("missing options.tags[Frame Mode]");
+			}
+
+			function assetType(asset, types) {
+				if (/trailer/.test(asset.type)) {
+					return false;
+				}
+
+				var matchingType = _lodash2.default.find(types, { name: asset.type });
+				if (!matchingType) {
+					throw new Error("Asset type \"" + asset.type + "\" could not be found");
+				}
+
+				return matchingType.file || matchingType.name.replace(".", "-").toUpperCase();
+			}
+
+			function assetTitle(asset) {
+				var prefix = "";
+				var name = asset.slug.toUpperCase().replace("INT-L", "INTL");
+				if (/trailer/.test(asset.type)) {
+					switch (asset.type) {
+						case "trailer.intl":
+							prefix = "ITR-";
+							name = name.replace(/INTL-TRAILER-/, "");
+							break;
+						case "trailer":
+							prefix = "TR-";
+							name = name.replace(/TRAILER-/, "");
+							break;
+						case "trailer.us":
+							prefix = "DTR-";
+							name = name.replace(/DOMESTIC-TRAILER-/, "");
+							break;
+					}
+				}
+				return prefix + name;
+			}
+
+			function runningTime(asset) {
+				var matches = asset.type.match(/^film-clip|^featurette/);
+				if (!matches) {
+					return;
+				}
+
+				var minutes = Math.floor(asset.length / 60);
+				var seconds = asset.length % 60;
+
+				var result = "";
+
+				if (minutes > 0) {
+					result += minutes + "min";
+				}
+
+				if (seconds > 0) {
+					result += seconds + "sec";
+				}
+
+				return result;
+			}
+
+			function locale(country, language) {
+				if (language.includes("-")) {
+					country = "";
+				}
+				return [language, country].filter(function (str) {
+					return !!str && str !== "WW";
+				}).join("-");
+			}
+
+			function textType(subDub, text) {
+				if (!subDub || !subDub.sub && !subDub.dub) {
+					return text;
+				}
+
+				var result = [];
+				if (subDub.sub) {
+					result.push("sub");
+				}
+
+				if (subDub.dub) {
+					result.push("dub");
+				}
+
+				return result;
+			}
+
+			function matchSet(allTags, tags) {
+				var selectedTags = (0, _lodash2.default)(tags).values().flatten().value();
+
+				var setTag = (0, _lodash2.default)(allTags).filter("set").find(function (setTag) {
+					return _lodash2.default.difference(setTag.set, selectedTags).length === 0;
+				});
+
+				if (setTag) {
+					return setTag.name;
+				}
+			}
+
+			var tags = options.tags,
+			    parts = [asset.project.filePrefix, assetType(asset, allTypes), assetTitle(asset), runningTime(asset), locale(options.country, options.language), textType(tags.SubDub, tags.Text), tags.Extra.join("_"), options.version, tags.Codec];
+
+			parts = (0, _lodash2.default)(parts).flatten().filter().map(function (part) {
+				return part.toUpperCase();
+			});
+
+			var matchedSet = matchSet(allTags, options.tags);
+			var requiredInfo = tags.Resolution && tags["Frame Mode"] && tags.Framerate;
+
+			if (matchedSet) {
+				parts = parts.push(matchedSet);
+			} else if (mediaType == "video" && tags.Resolution && !requiredInfo) {
+				parts = parts.push(tags.Resolution.replace(/\d+x/, ""));
+			} else if (mediaType == "image" && tags.Resolution) {
+				parts = parts.push(tags.Resolution);
+			}
+
+			var name = parts.join("_");
+
+			var hasResInfo = name.match(/\d+(i|p)/i);
+			var hasAllInfo = name.match(/\d+(i|p)\d+/i);
+
+			if (requiredInfo && !hasResInfo && !hasAllInfo) {
+				var res = tags.Resolution;
+				var encodeTag = [hasResInfo ? "" : res.indexOf("x") ? res.replace(/\d+x/, "") : res, res.match(/i|p/i) && !hasResInfo ? "" : tags["Frame Mode"].toLowerCase().slice(0, 1), tags.Framerate.replace(".", "").toUpperCase()].filter(function (val) {
+					return val;
+				}).join("");
 
+				var match = new RegExp(encodeTag, "i");
+				name = name.match(match) ? name.replace(match, encodeTag) : name + "_" + encodeTag;
+			} else if (hasResInfo && !hasAllInfo && tags.Framerate) {
+				name += tags.Framerate.replace(".", "").toUpperCase();
+			}
+
+			return name;
+		}
+		/**
+   * Returns the mediaType of the ingest
+   */
+
+	}, {
+		key: "mediaType",
+		value: function mediaType() {
+			return this.src.mediaType;
+		}
 		/**
    * Maps mediainfo metadata into ingest Tag format
-   * @param {*} info
-   * @param {*} mediaType
+   *
    */
-		value: function mapFromMediainfo(info, mediaType) {
+
+	}, {
+		key: "mapFromMediainfo",
+		value: function mapFromMediainfo() {
+			var info = this.mediainfo;
+			var mediaType = this.asset.mediaType;
+
 			var schema = {
 				Aspect: null,
 				Standard: null,
@@ -214,7 +487,10 @@ var Ingest = function () {
 
 	}, {
 		key: "mapFromFilename",
-		value: function mapFromFilename(filename, allTags) {
+		value: function mapFromFilename(params) {
+			var allTags = params.allTags;
+
+			var filename = this.filename;
 			var tags = {
 				SubDub: {
 					sub: null,
@@ -224,11 +500,11 @@ var Ingest = function () {
 			filename.file.tags.forEach(function (tag) {
 				var foundTag = _lodash2.default.find(allTags, { name: tag });
 				if (foundTag) {
-					if (foundTag.type == 'SubDub') {
-						if (foundTag.name == 'sub') {
+					if (foundTag.type == "SubDub") {
+						if (foundTag.name == "sub") {
 							tags.SubDub.sub = true;
 						}
-						if (foundTag.name == 'dub') {
+						if (foundTag.name == "dub") {
 							tags.SubDub.dub = true;
 						}
 					} else {
@@ -245,12 +521,12 @@ var Ingest = function () {
 					preview: {}
 				}
 			};
-			if (filename.file.tags.includes('sub') && filename.file.tags.includes('dub')) {
-				ingest.selected.preview.type = 'both';
-			} else if (filename.file.tags.includes('sub')) {
-				ingest.selected.preview.type = 'sub';
-			} else if (filename.file.tags.includes('dub')) {
-				ingest.selected.preview.type = 'dub';
+			if (filename.file.tags.includes("sub") && filename.file.tags.includes("dub")) {
+				ingest.selected.preview.type = "both";
+			} else if (filename.file.tags.includes("sub")) {
+				ingest.selected.preview.type = "sub";
+			} else if (filename.file.tags.includes("dub")) {
+				ingest.selected.preview.type = "dub";
 			}
 			if (filename.file.language) {
 				ingest.selected.preview.language = filename.file.language;
@@ -262,7 +538,42 @@ var Ingest = function () {
 			return ingest;
 		}
 		/**
-   * Assembles Ingest based on weighted rules
+   * Create a File from an Ingest object
+   *
+   * @param {object} params 
+   */
+
+	}, {
+		key: "createFile",
+		value: function createFile(params) {
+			var allTags = params.allTags,
+			    allTypes = params.allTypes,
+			    order = params.order;
+
+
+			this.filename = this.mapFromFilename({ allTags: allTags });
+			this.mediainfo = this.mapFromMediainfo();
+
+			var ingest = this.assemble({ order: order });
+
+			var file = new _File2.default({
+				name: this.renderFilename({ allTags: allTags, allTypes: allTypes }),
+				path: this.renderPath(),
+				asset: ingest.asset._id,
+				generator: 'ingest',
+				contextTag: ingest.context.tag,
+				language: ingest.selected.download.language,
+				country: ingest.selected.download.country,
+				tags: flatValues(ingest.selected.download.tags),
+				ingest: ingest._id,
+				workRequest: ingest.workRequest,
+				verified: true
+			});
+
+			return file;
+		}
+		/**
+   * Merges ingest metadata sources
    *
    * @param {object} params
    */
@@ -270,10 +581,11 @@ var Ingest = function () {
 	}, {
 		key: "assemble",
 		value: function assemble(params) {
-			var original = params.original,
-			    filename = params.filename,
-			    mediainfo = params.mediainfo,
-			    order = params.order,
+			var original = this.data();
+			var filename = this.data().filename;
+			var mediainfo = this.data().mediainfo;
+
+			var order = params.order,
 			    _params$watermarks = params.watermarks,
 			    watermarks = _params$watermarks === undefined ? [] : _params$watermarks;
 
@@ -292,8 +604,8 @@ var Ingest = function () {
 					},
 					preview: {
 						enabled: false,
-						revision: 'Final',
-						type: 'none',
+						revision: "Final",
+						type: "none",
 						embargo: {
 							enabled: false
 						}
@@ -308,7 +620,7 @@ var Ingest = function () {
 			var ingest = _lodash2.default.merge(defaults, filename, original, mediainfo);
 
 			if (original.asset && original.asset.creative) {
-				ingest.selected.preview.revision = 'Unfinished';
+				ingest.selected.preview.revision = "Unfinished";
 			}
 
 			if (!original.context.asset && filename.asset && filename.asset._id) {
@@ -337,7 +649,7 @@ var Ingest = function () {
 				ingest.selected.download.language = order.language;
 			}
 			if (order._id) {
-				ingest.selected.download.tags.Text = 'txtd';
+				ingest.selected.download.tags.Text = "txtd";
 			}
 			if (order.isSub() || order.isDub()) {
 				ingest.selected.download.tags.SubDub = {
@@ -362,9 +674,29 @@ var Ingest = function () {
 
 			return ingest;
 		}
+	}], [{
+		key: "_resource",
+		get: function get() {
+			return 'ingests';
+		}
 	}]);
-
 	return Ingest;
-}();
+}(_Model3.default);
+
+/**
+ * Flattens ingest.selected.download.tags into a simple array
+ *
+ * @param {object} data
+ */
 
-exports.default = Ingest;
+
+exports.default = Ingest;
+function flatValues(data) {
+	var copy = (0, _ramda.clone)(data);
+	if (copy.SubDub) {
+		copy.SubDub = (0, _ramda.keys)((0, _ramda.filter)(function (val) {
+			return !!val;
+		}, copy.SubDub));
+	}
+	return (0, _ramda.flatten)((0, _ramda.values)(copy));
+}

package/dist/src/IngestFile.js

@@ -4,10 +4,14 @@ 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 _classCallCheck2 = require("babel-runtime/helpers/classCallCheck");
+
+var _classCallCheck3 = _interopRequireDefault(_classCallCheck2);
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 var IngestFile = function IngestFile(file, order) {
-	_classCallCheck(this, IngestFile);
+	(0, _classCallCheck3.default)(this, IngestFile);
 
 	this.file = file;
 }