@pixwel/pixwel-sdk 1.1.7 → 1.1.9

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+declare module "@pixwel/pixwel-sdk" {
+	export class Filename {
+		constructor(data:object);
+		static render(allTags:any[], allTypes:any[], asset:object, options:object, mediaType?:string):string;
+	}
+	export class Ingest {
+		constructor(data:object);
+		selected:object;
+		static mapFromMediainfo(info:object, mediaType:string):object;
+		static mapFromFilename(info:object, mediaType:string):object;
+		static assemble(ingest:object, filename:object, mediainfo:object, order:object, watermarks:object[]):Ingest;
+	}
+	export class Order {
+		constructor(data:object);
+	}
+}

package/dist/index.js

@@ -40,15 +40,6 @@ Object.defineProperty(exports, 'IngestFile', {
   }
 });
 
-var _IngestFileDrop = require('./src/IngestFileDrop');
-
-Object.defineProperty(exports, 'IngestFileDrop', {
-  enumerable: true,
-  get: function get() {
-    return _interopRequireDefault(_IngestFileDrop).default;
-  }
-});
-
 var _Order = require('./src/Order');
 
 Object.defineProperty(exports, 'Order', {

package/dist/src/Filename.js

@@ -45,19 +45,19 @@ var Filename = function () {
 			var mediaType = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : "";
 
 			if (!asset.project) {
-				throw "missing asset.project";
+				throw new Error("missing asset.project");
 			}
 
 			if (asset.project && !asset.project.filePrefix) {
-				throw "missing asset.project.filePrefix";
+				throw new Error("missing asset.project.filePrefix");
 			}
 
 			if (!asset.name) {
-				throw "missing asset.name";
+				throw new Error("missing asset.name");
 			}
 
 			if (!asset.type) {
-				throw "missing asset.type";
+				throw new Error("missing asset.type");
 			}
 
 			var defaults = {
@@ -82,35 +82,25 @@ var Filename = function () {
 			options = _lodash2.default.merge(defaults, options);
 
 			if (!options.language) {
-				throw "missing options.language";
-			}
-
-			if (!options.tags.SubDub.sub && !options.tags.SubDub.dub && !options.tags.Text) {
-				throw "missing options.tags.Text or options.tags.SubDub";
+				throw new Error("missing options.language");
 			}
 
 			if (mediaType && mediaType == "video" && !options.tags.Codec) {
-				throw "missing options.tags.Codec";
+				throw new Error("missing options.tags.Codec");
 			}
 
 			if (mediaType && mediaType == "video" && !options.tags.Resolution) {
-				throw "missing options.tags.Resolution";
+				throw new Error("missing options.tags.Resolution");
 			}
 
 			if (mediaType && mediaType == "video" && !options.tags.Framerate) {
-				throw "missing options.tags.Framerate";
+				throw new Error("missing options.tags.Framerate");
 			}
 
 			if (mediaType == "video" && !options.tags["Frame Mode"]) {
-				throw "missing options.tags[Frame Mode]";
+				throw new Error("missing options.tags[Frame Mode]");
 			}
 
-			// currently, slurpee's filename.ts will render this, but we can add this back in later when
-			// filename.ts starts to rely on Filename.render
-			// if ((options.tags.SubDub.dub || options.tags.SubDub.sub) && options.tags.Text) {
-			//     throw 'conflicting options supplied: SubDub and Text';
-			// }
-
 			function assetType(asset, types) {
 				if (/trailer/.test(asset.type)) {
 					return false;
@@ -118,7 +108,7 @@ var Filename = function () {
 
 				var matchingType = _lodash2.default.find(types, { name: asset.type });
 				if (!matchingType) {
-					throw "Asset type \"" + asset.type + "\" could not be found";
+					throw new Error("Asset type \"" + asset.type + "\" could not be found");
 				}
 
 				return matchingType.file || matchingType.name.replace(".", "-").toUpperCase();
@@ -169,6 +159,9 @@ var Filename = function () {
 			}
 
 			function locale(country, language) {
+				if (language.includes('-')) {
+					country = '';
+				}
 				return [language, country].filter(function (str) {
 					return !!str && str !== "WW";
 				}).join("-");

package/dist/src/Ingest.js

@@ -24,28 +24,29 @@ var Ingest = function () {
 	}
 
 	_createClass(Ingest, null, [{
-		key: "mapMetaToTags",
+		key: "mapFromMediainfo",
 
 		/**
-   * [mapMetaToTags description]
-   * @param  {[type]} info [description]
-   * @return {[type]}      [description]
+   * Maps mediainfo metadata into ingest Tag format
+   * @param {*} info
+   * @param {*} mediaType
    */
-		value: function mapMetaToTags(info, mediaType) {
-
-			var tags = {
-				Aspect: "",
-				Standard: "",
-				Resolution: "",
-				Codec: "",
-				"Frame Mode": "",
-				Text: "",
-				Usage: "",
+		value: function mapFromMediainfo(info, mediaType) {
+			var schema = {
+				Aspect: null,
+				Standard: null,
+				Resolution: null,
+				Codec: null,
+				"Frame Mode": null,
+				Text: null,
+				Usage: null,
 				Extra: [],
-				Framerate: "",
-				Duration: ""
+				Framerate: null,
+				Duration: null
 			};
 
+			var tags = {};
+
 			if (!info.File) {
 				throw "missing info.File";
 			}
@@ -55,34 +56,34 @@ var Ingest = function () {
 			}
 
 			var general = void 0;
-			if (!Array.isArray(info['File']['track'])) {
-				general = info['File']['track'];
+			if (!Array.isArray(info["File"]["track"])) {
+				general = info["File"]["track"];
 			} else {
-				general = _lodash2.default.find(info['File']['track'], { _type: 'General' });
+				general = _lodash2.default.find(info["File"]["track"], { _type: "General" });
 			}
 
 			switch (mediaType) {
-				case 'video':
-					mediaType = 'Video';
+				case "video":
+					mediaType = "Video";
 					break;
-				case 'image':
-					mediaType = 'Image';
+				case "image":
+					mediaType = "Image";
 					break;
 				default:
-					if (general.Format && general.Format == 'MXF') {
-						tags.Usage = 'broadcast';
+					if (general.Format && general.Format == "MXF") {
+						tags.Usage = "broadcast";
 					}
 					return tags;
 			}
 
 			var mediainfoDefaults = {
-				Display_aspect_ratio: "",
+				DisplayAspectRatio: "",
 				Format: "",
 				Standard: "",
 				Height: "",
 				Width: "",
-				Frame_rate: "",
-				Scan_type: ""
+				FrameRate: "",
+				ScanType: ""
 			};
 
 			var media = _lodash2.default.find(info["File"]["track"], {
@@ -92,21 +93,41 @@ var Ingest = function () {
 
 			var width = parseInt(media["Width"].replace(" ", "").match(/[0-9 ]+/));
 			var height = parseInt(media["Height"].replace(" ", "").match(/[0-9 ]+/));
-			tags.Resolution = width && height ? width + "x" + height : "";
-
-			tags.Standard = media["Standard"] ? media["Standard"].toLowerCase() : "";
+			var Resolution = width && height ? width + "x" + height : null;
+			if (Resolution) {
+				tags.Resolution = Resolution;
+			}
 
-			var scan = /Progressive/.test(media["Scan_type"]) ? "p" : "i";
-			var dimension = /3D/.test(name) ? "3D" : "2D";
+			var Standard = media["Standard"] ? media["Standard"].toLowerCase() : null;
+			if (Standard) {
+				tags.Standard = Standard;
+			}
 
-			var framerate = media["Frame_rate"].split(" ");
-			if (framerate.length) {
-				var f = framerate[0];
-				if (f == "23.976") {
-					f = "23.98";
-				}
-				f = parseFloat(f).toString();
-				tags.Framerate = f != "NaN" ? f : "";
+			var framerate = media["FrameRate"];
+			switch (framerate) {
+				case "23.976":
+					framerate = "23.98";
+					break;
+				case "24.000":
+					framerate = "24";
+					break;
+				case "25.000":
+					framerate = "25";
+					break;
+				case "29.970":
+					framerate = "29.97";
+					break;
+				case "50.000":
+					framerate = "50";
+					break;
+				case "59.940":
+					framerate = "59.94";
+					break;
+			}
+			framerate = parseFloat(framerate).toString();
+			framerate = framerate != "NaN" ? framerate : null;
+			if (framerate) {
+				tags.Framerate = framerate;
 			}
 
 			if (!tags.Standard) {
@@ -124,16 +145,18 @@ var Ingest = function () {
 				}
 			}
 
-			tags.Codec = function (codec) {
-				switch (codec) {
-					case "AVC":
-						return "h264";
-					case "ProRes":
-						return "prores";
-					default:
-						return "";
-				}
-			}(media["Format"]);
+			var Codec = void 0;
+			switch (media["Format"]) {
+				case "AVC":
+					Codec = "h264";
+					break;
+				case "ProRes":
+					Codec = "prores";
+					break;
+			}
+			if (Codec) {
+				tags.Codec = Codec;
+			}
 
 			if (tags.Codec == "h264") {
 				tags.Usage = "online";
@@ -143,68 +166,198 @@ var Ingest = function () {
 				tags.Usage = "broadcast";
 			}
 
-			if (general && general['Format'] == 'MXF') {
-				tags.Usage = 'broadcast';
+			if (general && general["Format"] == "MXF") {
+				tags.Usage = "broadcast";
 			}
 
-			tags.Aspect = media["Display_aspect_ratio"] || "";
-			tags["Frame Mode"] = media["Scan_type"].toLowerCase();
+			switch (media["DisplayAspectRatio"]) {
+				case "1.000":
+					tags.Aspect = "1:1";
+					break;
+				case "1.347":
+					tags.Aspect = "4:3";
+					break;
+				case "1.756":
+					tags.Aspect = "16:9";
+					break;
+				case "1.778":
+					tags.Aspect = "16:9";
+					break;
+				case "1.366":
+					tags.Aspect = "4:3";
+					break;
+				case "0.562":
+					tags.Aspect = "9:16";
+					break;
+			}
 
-			return tags;
-		}
-	}, {
-		key: "mapFromKnownData",
-		value: function mapFromKnownData(context, order, tags) {
-			var watermarks = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : [];
+			var ScanType = media["ScanType"].toLowerCase() || null;
+			if (ScanType) {
+				tags["Frame Mode"] = ScanType;
+			}
 
+			var ingest = {
+				selected: {
+					download: {
+						tags: tags
+					}
+				}
+			};
 
-			if (order.asset) {
-				context = {
-					asset: order.asset._id,
-					project: order.project._id,
-					assetType: order.assetType,
-					purpose: "download"
-				};
-			}
+			return ingest;
+		}
+		/**
+   * Maps parsed filename data to a partial ingest record for later merging
+   * @param {*} filename
+   * @param {*} allTags
+   */
 
-			var previewType = function () {
-				if (order.isSub() && order.isDub()) return "both";
-				if (order.isDub()) return "dub";
-				if (order.isSub()) return "sub";
-			}();
+	}, {
+		key: "mapFromFilename",
+		value: function mapFromFilename(filename, allTags) {
+			var tags = {
+				SubDub: {
+					sub: null,
+					dub: null
+				}
+			};
+			filename.file.tags.forEach(function (tag) {
+				var foundTag = _lodash2.default.find(allTags, { name: tag });
+				if (foundTag) {
+					if (foundTag.type == 'SubDub') {
+						if (foundTag.name == 'sub') {
+							tags.SubDub.sub = true;
+						}
+						if (foundTag.name == 'dub') {
+							tags.SubDub.dub = true;
+						}
+					} else {
+						tags[foundTag.type] = foundTag.name;
+					}
+				}
+			});
+			tags.Extra = filename.extra;
+			var ingest = {
+				selected: {
+					download: {
+						tags: tags
+					},
+					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.language) {
+				ingest.selected.preview.language = filename.file.language;
+				ingest.selected.download.language = filename.file.language;
+			}
+			if (filename.file.country) {
+				ingest.selected.download.country = filename.file.country;
+			}
+			return ingest;
+		}
+		/**
+   * Assembles Ingest based on weighted rules
+   * @param {*} context
+   * @param {*} filename
+   * @param {*} mediainfo
+   * @param {*} order
+   */
 
-			var isPreviewEnabled = tags.Codec == "prores" && tags.Resolution.split("x")[1] == "1080" && (tags.Framerate == "23.98" || tags.Framerate == "25") && watermarks.length || null;
+	}, {
+		key: "assemble",
+		value: function assemble(original, filename, mediainfo, order) {
+			var watermarks = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
 
-			var watermark = watermarks[0] ? watermarks[0]._id : "";
 
-			return {
+			var defaults = {
 				workRequest: order._id,
 				selected: {
 					download: {
 						enabled: true,
-						country: order.country,
-						language: order.language,
-						tags: tags,
+						tags: {
+							Extra: []
+						},
 						embargo: {
 							enabled: false
 						}
 					},
 					preview: {
-						enabled: isPreviewEnabled,
-						language: order.language,
-						revision: "Final",
-						type: previewType,
-						watermark: watermark,
+						enabled: false,
+						revision: 'Final',
+						type: 'none',
 						embargo: {
 							enabled: false
 						}
 					},
 					thumbnail: {
-						enabled: false
+						enabled: false,
+						position: 50
 					}
-				},
-				context: context
+				}
 			};
+
+			var ingest = _lodash2.default.merge(defaults, original, filename, mediainfo);
+
+			if (original.asset && original.asset.creative) {
+				ingest.selected.preview.revision = 'Unfinished';
+			}
+
+			if (!original.context.asset && filename.asset && filename.asset._id) {
+				ingest.selected.asset = filename.asset._id;
+			}
+
+			if (ingest.workRequest) {
+				ingest.selected.project = ingest.context.project;
+				ingest.selected.asset = ingest.context.asset;
+				ingest.selected.assetType = ingest.context.assetType;
+			}
+
+			if (ingest.workRequest) {
+				ingest.selected.download.tags.Extra = [];
+			}
+
+			if (original.context.tag) {
+				ingest.selected.download.tags.Extra = [original.context.tag];
+			}
+
+			if (order.territory) {
+				ingest.selected.download.country = order.territory;
+			}
+			if (order.language) {
+				ingest.selected.preview.language = order.language;
+				ingest.selected.download.language = order.language;
+			}
+			if (order._id) {
+				ingest.selected.download.tags.Text = 'txtd';
+			}
+			if (order.isSub() || order.isDub()) {
+				ingest.selected.download.tags.SubDub = {
+					sub: order.isSub(),
+					dub: order.isDub()
+				};
+			}
+			if (order.isSub()) {
+				ingest.selected.preview.type = "sub";
+			}
+			if (order.isDub()) {
+				ingest.selected.preview.type = "dub";
+			}
+			if (order.isSub() && order.isDub()) {
+				ingest.selected.preview.type = "both";
+			}
+
+			ingest.selected.preview.watermark = watermarks[0] ? watermarks[0]._id : "";
+
+			var tags = ingest.selected.download.tags;
+			ingest.selected.preview.enabled = !!(tags.Codec == "prores" && tags.Resolution.split("x")[1] == "1080" && (tags.Framerate == "23.98" || tags.Framerate == "25") && watermarks.length) || false;
+
+			return ingest;
 		}
 	}]);
 

package/dist/src/Order.js

@@ -33,6 +33,10 @@ var Order = function () {
 		};
 		Object.assign(this, schema, data);
 	}
+	/**
+  * Determines if an order should be classified as 'dubbed' based on its dng values
+  */
+
 
 	_createClass(Order, [{
 		key: "isDub",
@@ -40,14 +44,22 @@ var Order = function () {
 			if (!this.dng) {
 				return null;
 			}
+			if (this.dng.graphics && this.dng.graphics.includes('Dedicated / Localized')) {
+				return false;
+			}
 			return _lodash2.default.flattenDeep(Object.entries(this.dng)).includes("Dedicated / Localized");
 		}
+		/**
+   * Determines in an order should be classified as 'subbed' based on its dng values
+   */
+
 	}, {
 		key: "isSub",
 		value: function isSub() {
 			if (!this.dng) {
 				return null;
 			}
+			if (this.dng === 'Graphics Only') return false;
 			return _lodash2.default.flattenDeep(Object.entries(this.dng)).includes("Subtitled");
 		}
 	}]);

package/index.js

@@ -2,5 +2,4 @@ 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

@@ -1,28 +1,34 @@
 {
-    "name": "@pixwel/pixwel-sdk",
-    "description": "",
-    "version": "1.1.7",
-    "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"
-        ]
-    },
-    "dependencies": {
-        "lodash": "^4.17.10"
-    },
-    "devDependencies": {
-        "babel-cli": "^6.26.0",
-        "babel-preset-env": "^1.7.0",
-        "jest": "^22.4.4"
-    }
+	"name": "@pixwel/pixwel-sdk",
+	"description": "",
+	"version": "1.1.9",
+	"author": "Pixwel",
+	"license": "UNLICENSED",
+	"main": "./dist/index.js",
+	"scripts": {
+		"build": "npx babel-cli -d dist index.js src/*.js",
+		"watch": "npx babel-cli -w -d dist index.js src/*.js",
+		"test": "npx jest --coverage"
+	},
+	"browserify": {
+		"transform": [
+			"babelify"
+		]
+	},
+	"jest": {
+		"verbose": true,
+		"coverageDirectory": "coverage",
+		"collectCoverage": true,
+		"collectCoverageFrom": [
+			"src/*.js"
+		]
+	},
+	"dependencies": {
+		"lodash": "^4.17.10"
+	},
+	"devDependencies": {
+		"babel-cli": "^6.26.0",
+		"babel-preset-env": "^1.7.0",
+		"jest": "^22.4.4"
+	}
 }