@pixwel/pixwel-sdk 2.0.0 → 2.1.0

package/dist/src/fileType.js

@@ -0,0 +1,43 @@
+"use strict";
+
+var extname = require("path").extname;
+
+var TYPES = {
+	document: ["doc", "docx", "xls", "xlsx", "txt", "pdf", "ppt", "pptx"],
+
+	video: ["mov", "mp4", "m4v", "mpg", "mxf"],
+
+	audio: ["mp3", "wav", "m4a"],
+
+	image: ["jpg", "jpeg", "png", "tif", "tiff", "ai", "psd", "eps"],
+
+	zip: ["zip"]
+};
+
+function extensionType(extension) {
+	for (var type in TYPES) {
+		if (TYPES[type].indexOf(extension) > -1) {
+			return type;
+		}
+	}
+}
+
+function extension(path) {
+	return extname(path.split("?")[0].toLowerCase()).substring(1);
+}
+
+function mediaType(path) {
+	var type = extensionType(extension(path));
+
+	if (type) {
+		return type;
+	}
+
+	throw new Error("Unknown extension '" + extension + "'");
+}
+
+module.exports = {
+	extension: extension,
+	extensionType: extensionType,
+	mediaType: mediaType
+};

package/index.js

@@ -1,5 +1,19 @@
+export let Pixwel = {
+	credentials: {
+		token: null
+	},
+	endpoint: 'https://api.pixwel.com/api'
+};
+
 export { default as Asset } from './src/Asset';
+export { default as AssetType } from './src/AssetType';
+export { default as Encode } from './src/Encode';
+export { default as File } from './src/File';
 export { default as Filename } from './src/Filename';
 export { default as Ingest } from './src/Ingest';
 export { default as IngestFile } from './src/IngestFile';
+export { default as Model } from './src/Model';
 export { default as Order } from './src/Order';
+export { default as Tag } from './src/Tag';
+
+

package/package.json

@@ -1,14 +1,15 @@
 {
 	"name": "@pixwel/pixwel-sdk",
 	"description": "",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"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"
+		"test": "npx jest --coverage",
+		"debug": "node --inspect-brk node_modules/.bin/jest --watch --runInBand"
 	},
 	"browserify": {
 		"transform": [
@@ -24,10 +25,15 @@
 		]
 	},
 	"dependencies": {
-		"lodash": "^4.17.10"
+		"axios": "^0.19.0",
+		"deep-object-diff": "^1.1.0",
+		"lodash": "^4.17.15",
+		"ramda": "^0.26.1",
+		"validate.js": "^0.13.1"
 	},
 	"devDependencies": {
 		"babel-cli": "^6.26.0",
+		"babel-plugin-transform-runtime": "^6.23.0",
 		"babel-preset-env": "^1.7.0",
 		"jest": "^22.4.4"
 	}

package/src/AssetType.js

@@ -0,0 +1,11 @@
+import Model from "./Model";
+
+export default class AssetType extends Model {
+	constructor(data) {
+		super(data);
+		this._resource = 'assettypes';
+	}
+	static get _resource() {
+		return 'assettypes';
+	}
+}

package/src/Encode.js

@@ -0,0 +1,11 @@
+import Model from "./Model";
+
+export default class Encode extends Model {
+	constructor(data) {
+		super(data);
+		this._resource = 'encodes';
+	}
+	static get _resource() {
+		return 'encodes';
+	}
+}

package/src/File.js

@@ -0,0 +1,11 @@
+import Model from "./Model";
+
+export default class File extends Model {
+	constructor(data) {
+		super(data);
+		this._resource = "files";
+	}
+	static get _resource() {
+		return 'files';
+	}
+}

package/src/Filename.js

@@ -6,243 +6,4 @@ import _ from "lodash";
  * @type class
  */
 export default class Filename {
-	/**
-	 * Renders a valid filename given all tags, all types, an asset, and metadata
-	 * options likely parsed from the file itself.
-	 * @param  {Array}  [allTags=[]]  Collection of all known tags
-	 * @param  {Array}  [allTypes=[]] Collection of all known types
-	 * @param  {Object} [asset={}]    A Platform Asset
-	 * @param  {Object} [options={}] options containing metadata about file
-	 * @param  {String} [mediaType=''] Indicates video, audio, image and allows for stricter required fields
-	 * @return {String}               A valid filename
-	 */
-	static render(params) {
-
-		let {
-			allTags = [],
-			allTypes = [],
-			asset = {},
-			options = {},
-			mediaType = ""
-		} = params;
-
-		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");
-		}
-
-		let 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 = _.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;
-			}
-
-			let matchingType = _.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) {
-			let prefix = "";
-			let 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) {
-			let matches = asset.type.match(/^film-clip|^featurette/);
-			if (!matches) {
-				return;
-			}
-
-			let minutes = Math.floor(asset.length / 60);
-			let seconds = asset.length % 60;
-
-			let 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(str => {
-					return !!str && str !== "WW";
-				})
-				.join("-");
-		}
-
-		function textType(subDub, text) {
-			if (!subDub || (!subDub.sub && !subDub.dub)) {
-				return text;
-			}
-
-			let result = [];
-			if (subDub.sub) {
-				result.push("sub");
-			}
-
-			if (subDub.dub) {
-				result.push("dub");
-			}
-
-			return result;
-		}
-
-		function matchSet(allTags, tags) {
-			let selectedTags = _(tags)
-				.values()
-				.flatten()
-				.value();
-
-			let setTag = _(allTags)
-				.filter("set")
-				.find(setTag => {
-					return _.difference(setTag.set, selectedTags).length === 0;
-				});
-
-			if (setTag) {
-				return setTag.name;
-			}
-		}
-
-		let 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 = _(parts)
-			.flatten()
-			.filter()
-			.map(part => part.toUpperCase());
-
-		let matchedSet = matchSet(allTags, options.tags);
-		let 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);
-		}
-
-		let name = parts.join("_");
-
-		let hasResInfo = name.match(/\d+(i|p)/i);
-		let hasAllInfo = name.match(/\d+(i|p)\d+/i);
-
-		if (requiredInfo && !hasResInfo && !hasAllInfo) {
-			let res = tags.Resolution;
-			let 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(val => {
-					return val;
-				})
-				.join("");
-
-			let 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;
-	}
 }