@pixwel/pixwel-sdk 1.1.11 → 2.0.0

package/dist/src/Filename.js

@@ -37,12 +37,18 @@ var Filename = function () {
    * @param  {String} [mediaType=''] Indicates video, audio, image and allows for stricter required fields
    * @return {String}               A valid filename
    */
-		value: function render() {
-			var allTags = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-			var allTypes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
-			var asset = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
-			var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
-			var mediaType = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : "";
+		value: function render(params) {
+			var _params$allTags = params.allTags,
+			    allTags = _params$allTags === undefined ? [] : _params$allTags,
+			    _params$allTypes = params.allTypes,
+			    allTypes = _params$allTypes === undefined ? [] : _params$allTypes,
+			    _params$asset = params.asset,
+			    asset = _params$asset === undefined ? {} : _params$asset,
+			    _params$options = params.options,
+			    options = _params$options === undefined ? {} : _params$options,
+			    _params$mediaType = params.mediaType,
+			    mediaType = _params$mediaType === undefined ? "" : _params$mediaType;
+
 
 			if (!asset.project) {
 				throw new Error("missing asset.project");
@@ -159,8 +165,8 @@ var Filename = function () {
 			}
 
 			function locale(country, language) {
-				if (language.includes('-')) {
-					country = '';
+				if (language.includes("-")) {
+					country = "";
 				}
 				return [language, country].filter(function (str) {
 					return !!str && str !== "WW";

package/dist/src/Ingest.js

@@ -263,16 +263,19 @@ var Ingest = function () {
 		}
 		/**
    * Assembles Ingest based on weighted rules
-   * @param {*} context
-   * @param {*} filename
-   * @param {*} mediainfo
-   * @param {*} order
+   *
+   * @param {object} params
    */
 
 	}, {
 		key: "assemble",
-		value: function assemble(original, filename, mediainfo, order) {
-			var watermarks = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : [];
+		value: function assemble(params) {
+			var original = params.original,
+			    filename = params.filename,
+			    mediainfo = params.mediainfo,
+			    order = params.order,
+			    _params$watermarks = params.watermarks,
+			    watermarks = _params$watermarks === undefined ? [] : _params$watermarks;
 
 
 			var defaults = {

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@pixwel/pixwel-sdk",
 	"description": "",
-	"version": "1.1.11",
+	"version": "2.0.0",
 	"author": "Pixwel",
 	"license": "UNLICENSED",
 	"main": "./dist/index.js",

package/src/Filename.js

@@ -16,13 +16,16 @@ export default class Filename {
 	 * @param  {String} [mediaType=''] Indicates video, audio, image and allows for stricter required fields
 	 * @return {String}               A valid filename
 	 */
-	static render(
-		allTags = [],
-		allTypes = [],
-		asset = {},
-		options = {},
-		mediaType = ""
-	) {
+	static render(params) {
+
+		let {
+			allTags = [],
+			allTypes = [],
+			asset = {},
+			options = {},
+			mediaType = ""
+		} = params;
+
 		if (!asset.project) {
 			throw new Error("missing asset.project");
 		}
@@ -140,8 +143,8 @@ export default class Filename {
 		}
 
 		function locale(country, language) {
-			if (language.includes('-')) {
-				country = '';
+			if (language.includes("-")) {
+				country = "";
 			}
 			return [language, country]
 				.filter(str => {

package/src/Ingest.js

@@ -240,12 +240,12 @@ export default class Ingest {
 	}
 	/**
 	 * Assembles Ingest based on weighted rules
-	 * @param {*} context
-	 * @param {*} filename
-	 * @param {*} mediainfo
-	 * @param {*} order
+	 *
+	 * @param {object} params
 	 */
-	static assemble(original, filename, mediainfo, order, watermarks = []) {
+	static assemble(params) {
+
+		let { original, filename, mediainfo, order, watermarks = [] } = params;
 
 		let defaults = {
 			workRequest: order._id,

package/test/Filename.spec.js

@@ -1,6 +1,9 @@
 import Filename from "../src/Filename";
 let mocks = require("./mocks/mocks");
 
+let allTags = mocks.tags;
+let allTypes = mocks.types;
+
 describe("Filename", () => {
 	describe("render", () => {
 		it("renders tags as an underscore-separated string", function() {
@@ -25,7 +28,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_COMING-SOON_HOJE_PRORES_480p2398"
 			);
 		});
@@ -52,7 +55,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_ITR-TEST-ASSET-A_ENG-US_TXTD_COMING-SOON_HOJE_PRORES_480p2398"
 			);
 		});
@@ -79,7 +82,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_ITR-TEST-ASSET-A_PFR-FLE_TXTD_COMING-SOON_HOJE_PRORES_480p2398"
 			);
 		});
@@ -102,8 +105,9 @@ describe("Filename", () => {
 					Resolution: "640x480"
 				}
 			};
+			let mediaType = 'image';
 			expect(
-				Filename.render(mocks.tags, mocks.types, asset, options, "image")
+				Filename.render({ allTags, allTypes, asset, options, mediaType })
 			).toBe("TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_640x480");
 		});
 
@@ -127,7 +131,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_ITR-CANT-INTL-10_ENG_TXTD_PRORES_480p2398"
 			);
 		});
@@ -153,7 +157,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_REV_PRORES_480p2398"
 			);
 		});
@@ -172,7 +176,7 @@ describe("Filename", () => {
 				language: "ENG"
 			};
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options);
+				Filename.render({ allTags, allTypes, asset, options });
 			}).toThrow("missing asset.project");
 		});
 
@@ -193,7 +197,7 @@ describe("Filename", () => {
 				}
 			};
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options);
+				Filename.render({ allTags, allTypes, asset, options });
 			}).toThrow("missing asset.length");
 		});
 
@@ -221,7 +225,7 @@ describe("Filename", () => {
 		//         }
 		//     };
 		//     expect(() => {
-		//         Filename.render(mocks.tags, mocks.types, asset, options)
+		//         Filename.render({ allTags, allTypes, asset, options })
 		//     }).toThrow('conflicting options supplied: SubDub and Text');
 		// });
 
@@ -246,7 +250,7 @@ describe("Filename", () => {
 		// 		}
 		// 	};
 		// 	expect(() => {
-		// 		Filename.render(mocks.tags, mocks.types, asset, options);
+		// 		Filename.render({ allTags, allTypes, asset, options });
 		// 	}).toThrow("missing options.tags.Codec");
 		// });
 
@@ -270,8 +274,15 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
+			let mediaType = 'video';
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options, "video");
+				Filename.render({
+					allTags,
+					allTypes,
+					asset,
+					options,
+					mediaType
+				});
 			}).toThrow("missing options.tags.Resolution");
 		});
 
@@ -295,8 +306,15 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
+			let mediaType = 'video';
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options, "video");
+				Filename.render({
+					allTags,
+					allTypes,
+					asset,
+					options,
+					mediaType
+				});
 			}).toThrow("missing options.tags.Framerate");
 		});
 
@@ -320,8 +338,9 @@ describe("Filename", () => {
 					// "Frame Mode": 'progressive'
 				}
 			};
+			let mediaType = 'video';
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options, "video");
+				Filename.render({ allTags, allTypes, asset, options, mediaType });
 			}).toThrow("missing options.tags[Frame Mode]");
 		});
 
@@ -342,7 +361,7 @@ describe("Filename", () => {
 				}
 			};
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options);
+				Filename.render({ allTags, allTypes, asset, options });
 			}).toThrow("missing asset.length");
 		});
 
@@ -359,7 +378,7 @@ describe("Filename", () => {
 				language: "ENG"
 			};
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options);
+				Filename.render({ allTags, allTypes, asset, options });
 			}).toThrow("missing asset.project.filePrefix");
 		});
 
@@ -376,7 +395,7 @@ describe("Filename", () => {
 				language: "ENG"
 			};
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options);
+				Filename.render({ allTags, allTypes, asset, options });
 			}).toThrow("missing asset.name");
 		});
 
@@ -393,7 +412,7 @@ describe("Filename", () => {
 				language: "ENG"
 			};
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset, options);
+				Filename.render({ allTags, allTypes, asset, options });
 			}).toThrow("missing asset.type");
 		});
 
@@ -408,7 +427,11 @@ describe("Filename", () => {
 				}
 			};
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset);
+				Filename.render({
+					allTags,
+					allTypes,
+					asset
+				});
 			}).toThrow("missing options.language");
 		});
 
@@ -428,7 +451,12 @@ describe("Filename", () => {
 				}
 			};
 			expect(() => {
-				Filename.render(mocks.tags, mocks.types, asset);
+				Filename.render({
+					allTags,
+					allTypes,
+					asset,
+					options
+				});
 			}).toThrow("missing options.language");
 		});
 
@@ -453,7 +481,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_ITR-TEST-ASSET-A_ENG-US_TXTD_PRORES_480p2398"
 			);
 		});
@@ -478,7 +506,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_DTR-TEST-ASSET-A_ENG_TXTD_PRORES_480p2398"
 			);
 		});
@@ -503,7 +531,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_TR-GENERIC-TRAILER_ENG_TXTD_PRORES_480p2398"
 			);
 		});
@@ -528,7 +556,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_TV-SPOT-INTL_COOL-SPOT-15_ENG_TXTD_PRORES_480p2398"
 			);
 		});
@@ -554,7 +582,7 @@ describe("Filename", () => {
 				}
 			};
 			expect(function() {
-				Filename.render(mocks.tags, mocks.types, asset, options);
+				Filename.render({ allTags, allTypes, asset, options });
 			}).toThrow('Asset type "doesnt-exist" could not be found');
 		});
 
@@ -579,19 +607,19 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_FILM-CLIP-INTL_ULTRA-VIOLENCE_1MIN3SEC_ENG_TXTD_PRORES_480p2398"
 			);
 
 			asset.length = 60;
 
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_FILM-CLIP-INTL_ULTRA-VIOLENCE_1MIN_ENG_TXTD_PRORES_480p2398"
 			);
 
 			asset.length = 45;
 
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_FILM-CLIP-INTL_ULTRA-VIOLENCE_45SEC_ENG_TXTD_PRORES_480p2398"
 			);
 		});
@@ -617,7 +645,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_H264_1080p2398"
 			);
 		});
@@ -644,7 +672,7 @@ describe("Filename", () => {
 					Codec: "PRORES"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_COMING-SOON_HOJE_PRORES_1080p2997"
 			);
 		});
@@ -671,7 +699,7 @@ describe("Filename", () => {
 					Codec: "PRORES"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_COMING-SOON_HOJE_PRORES_1080i2997"
 			);
 
@@ -690,7 +718,7 @@ describe("Filename", () => {
 				}
 			};
 
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_ITR-TEST-ASSET-A_ENG_TXTD_COMING-SOON_HOJE_H264_1080p2997"
 			);
 		});
@@ -717,7 +745,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_TV-SPOT-INTL_TEST-ASSET-INTL-10_ENG_TXTD_COMING-SOON_HOJE_PRORES_480p2398"
 			);
 		});
@@ -747,7 +775,7 @@ describe("Filename", () => {
 					"Frame Mode": "progressive"
 				}
 			};
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_TV-SPOT-INTL_TEST-ASSET-INTL-10_ENG_SUB_COMING-SOON_HOJE_PRORES_480p2398"
 			);
 
@@ -756,7 +784,7 @@ describe("Filename", () => {
 				dub: true
 			});
 
-			expect(Filename.render(mocks.tags, mocks.types, asset, options)).toBe(
+			expect(Filename.render({ allTags, allTypes, asset, options })).toBe(
 				"TESTPROJECT_TV-SPOT-INTL_TEST-ASSET-INTL-10_ENG_SUB_DUB_COMING-SOON_HOJE_PRORES_480p2398"
 			);
 		});

package/test/Ingest.spec.js

@@ -23,7 +23,7 @@ describe("Ingest", () => {
 			};
 			let mediainfo = {};
 			let order = new Order();
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.download.language).toBe("ENG");
 			expect(ingest.selected.download.country).toBe("US");
 		});
@@ -36,7 +36,7 @@ describe("Ingest", () => {
 			};
 			let mediainfo = {};
 			let order = new Order();
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.asset).toBe("a1b2c3");
 		});
 		it('should prefer ingest asset data over filename when coming from workrequest', () => {
@@ -62,7 +62,7 @@ describe("Ingest", () => {
 			};
 			let mediainfo = {};
 			let order = new Order({ _id: "5c90dd39ab0e003b358b456d" });
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.asset.slug).toEqual('alpha');
 		});
 		it("should use all context when coming from an order", () => {
@@ -89,7 +89,7 @@ describe("Ingest", () => {
 			};
 			let mediainfo = {};
 			let order = new Order({ _id: "5c90dd39ab0e003b358b456d" });
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.download.tags.Extra).toEqual(['FRIDAY']);
 			expect(ingest.selected.project).toBe("5ada6930679eef010c8b45fc");
 			expect(ingest.selected.asset).toBe("5c804776bb65ce2e008b4568");
@@ -112,7 +112,7 @@ describe("Ingest", () => {
 			};
 			let mediainfo = {};
 			let order = new Order();
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.preview.revision).toBe("Unfinished");
 		});
 		it("should keep tags from parsed filename when order is empty", () => {
@@ -133,7 +133,7 @@ describe("Ingest", () => {
 			};
 			let mediainfo = {};
 			let order = new Order();
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.download.tags).toEqual({
 				Extra: ["coming-soon"],
 				SubDub: { sub: true }
@@ -146,7 +146,7 @@ describe("Ingest", () => {
 			};
 			let mediainfo = {};
 			let order = new Order();
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.preview.revision).toBe("Final");
 		});
 		it("should enable preview if file is prores 1080p 23.98/25", () => {
@@ -167,13 +167,13 @@ describe("Ingest", () => {
 			};
 			let order = new Order();
 			let watermarks = [1];
-			let ingest = Ingest.assemble(
+			let ingest = Ingest.assemble({
 				original,
 				filename,
 				mediainfo,
 				order,
 				watermarks
-			);
+			});
 			expect(ingest.selected.preview.enabled).toBe(true);
 		});
 		it("should prefer language and country from order over filename", () => {
@@ -186,7 +186,7 @@ describe("Ingest", () => {
 				territory: "FI",
 				language: "FIN"
 			});
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.download.language).toBe("FIN");
 			expect(ingest.selected.download.country).toBe("FI");
 		});
@@ -199,7 +199,7 @@ describe("Ingest", () => {
 				selected: { download: { tags: { Codec: "h264", Aspect: "16:9" } } }
 			};
 			let order = new Order();
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.download.tags.Codec).toBe("h264");
 			expect(ingest.selected.download.tags.Aspect).toBe("16:9");
 		});
@@ -211,7 +211,7 @@ describe("Ingest", () => {
 				isSub: jest.fn().mockReturnValue(true),
 				isDub: jest.fn().mockReturnValue(null)
 			};
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.preview.type).toBe("sub");
 		});
 		it("should set preview.type=dub if order.isDub", () => {
@@ -222,7 +222,7 @@ describe("Ingest", () => {
 				isSub: jest.fn().mockReturnValue(null),
 				isDub: jest.fn().mockReturnValue(true)
 			};
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.preview.type).toBe("dub");
 		});
 		it("should set preview.type=both if order.isDub and order.isDub", () => {
@@ -233,7 +233,7 @@ describe("Ingest", () => {
 				isSub: jest.fn().mockReturnValue(true),
 				isDub: jest.fn().mockReturnValue(true)
 			};
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.preview.type).toBe("both");
 		});
 		it("should retain Extra tags from order over filename", () => {
@@ -250,7 +250,7 @@ describe("Ingest", () => {
 				isSub: jest.fn().mockReturnValue(true),
 				isDub: jest.fn().mockReturnValue(true)
 			};
-			let ingest = Ingest.assemble(original, filename, mediainfo, order);
+			let ingest = Ingest.assemble({ original, filename, mediainfo, order });
 			expect(ingest.selected.download.tags.Extra).toEqual(["coming-soon"]);
 		});
 	});