@vidispine/vdt-js 22.4.0-pre.6 → 22.4.0-pre.7

package/dist/index.js

@@ -2836,6 +2836,7 @@ var parseShapeType = function parseShapeType() {
   return parsedShape;
 };
 
+// eslint-disable-next-line import/no-cycle
 var DOCUMENT_TYPES = {
   PDF: 'PDF',
   TEXT: 'TEXT',
@@ -2847,15 +2848,16 @@ var DOCUMENT_TYPES = {
 /**
  * Return a const for the document type of a shape (looks at mimeType)
  *
- * @param shape
+ * @param shape A VidiCore shape
  * @returns The document type for a shape
  *
  * @category Shape
  */
-var getDocumentType = function getDocumentType(shape) {
-  var _ref = shape || {},
-      mimeTypeArrayOrString = _ref.mimeType;
-
+var getShapeDocumentType = function getShapeDocumentType() {
+  var shape = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  // shapeType.mimeType is always a string array,
+  // but accepts passing in { mimeType: string } for backwards compatibility
+  var mimeTypeArrayOrString = shape.mimeType;
   var mimeType = Array.isArray(mimeTypeArrayOrString) ? mimeTypeArrayOrString[0] : mimeTypeArrayOrString;
   if (!mimeType) return undefined;
   if (mimeType.endsWith('/pdf')) return DOCUMENT_TYPES.PDF;
@@ -2882,8 +2884,8 @@ var H264_CODEC = 'h264'; // Sort by tags in the order of previewShapeOrder, seco
 var PREVIEW_SHAPE_ORDER = ['__mp4', '__mp3_160k', '__png', '__jpeg', '__gif', 'original'].reverse();
 
 var defaultSortPriority = function defaultSortPriority(_ref, _ref2) {
-  var firstEl = _ref.shape.tag;
-  var secondEl = _ref2.shape.tag;
+  var firstEl = _ref.parsedShape.tag;
+  var secondEl = _ref2.parsedShape.tag;
 
   if (PREVIEW_SHAPE_ORDER.includes(firstEl) || PREVIEW_SHAPE_ORDER.includes(secondEl)) {
     return PREVIEW_SHAPE_ORDER.indexOf(secondEl) - PREVIEW_SHAPE_ORDER.indexOf(firstEl);
@@ -2906,29 +2908,31 @@ var filterShapeSource = function filterShapeSource(itemType, options) {
   var _ref3 = options || {},
       _ref3$allowedMimeType = _ref3.allowedMimeTypes,
       allowedMimeTypes = _ref3$allowedMimeType === void 0 ? DEFAULT_ALLOWED_MIME_TYPES : _ref3$allowedMimeType,
-      _ref3$sortPriority = _ref3.sortPriority,
-      sortPriority = _ref3$sortPriority === void 0 ? defaultSortPriority : _ref3$sortPriority,
       _ref3$allowedMethods = _ref3.allowedMethods,
       allowedMethods = _ref3$allowedMethods === void 0 ? DEFAULT_ALLOWED_METHODS : _ref3$allowedMethods,
+      _ref3$sortPriority = _ref3.sortPriority,
+      sortPriority = _ref3$sortPriority === void 0 ? defaultSortPriority : _ref3$sortPriority,
       _ref3$sourceKey = _ref3.sourceKey,
       sourceKey = _ref3$sourceKey === void 0 ? 'src' : _ref3$sourceKey,
       _ref3$mimeTypeKey = _ref3.mimeTypeKey,
       mimeTypeKey = _ref3$mimeTypeKey === void 0 ? 'type' : _ref3$mimeTypeKey,
       _ref3$shapeKey = _ref3.shapeKey,
-      shapeKey = _ref3$shapeKey === void 0 ? 'shape' : _ref3$shapeKey;
+      shapeKey = _ref3$shapeKey === void 0 ? 'shape' : _ref3$shapeKey,
+      _ref3$parsedShapeKey = _ref3.parsedShapeKey,
+      parsedShapeKey = _ref3$parsedShapeKey === void 0 ? 'parsedShapeKey' : _ref3$parsedShapeKey;
 
   var _ref4 = itemType || {},
       _ref4$shape = _ref4.shape,
       shapeList = _ref4$shape === void 0 ? [] : _ref4$shape;
 
-  var parsedShapeList = shapeList.reduce(function (acc, shapeType) {
+  var filteredShapeList = shapeList.reduce(function (acc, shapeType) {
     var type;
     var src;
-    var shape = parseShapeType(shapeType);
-    var uri = shape.uri,
-        mimeType = shape.mimeType,
-        containerFormat = shape.containerFormat,
-        videoCodec = shape.videoCodec;
+    var parsedShape = parseShapeType(shapeType);
+    var uri = parsedShape.uri,
+        mimeType = parsedShape.mimeType,
+        containerFormat = parsedShape.containerFormat,
+        videoCodec = parsedShape.videoCodec;
 
     if (mimeType) {
       type = mimeType;
@@ -2950,13 +2954,13 @@ var filterShapeSource = function filterShapeSource(itemType, options) {
     if (src && allowedMimeTypes.includes(type)) {
       var _acc$push;
 
-      acc.push((_acc$push = {}, _defineProperty__default["default"](_acc$push, sourceKey, src), _defineProperty__default["default"](_acc$push, mimeTypeKey, type), _defineProperty__default["default"](_acc$push, shapeKey, shape), _acc$push));
+      acc.push((_acc$push = {}, _defineProperty__default["default"](_acc$push, sourceKey, src), _defineProperty__default["default"](_acc$push, mimeTypeKey, type), _defineProperty__default["default"](_acc$push, shapeKey, shapeType), _defineProperty__default["default"](_acc$push, parsedShapeKey, parsedShape), _acc$push));
     }
 
     return acc;
   }, []);
-  if (typeof sortPriority === 'function') parsedShapeList.sort(defaultSortPriority);
-  return parsedShapeList;
+  if (typeof sortPriority === 'function') filteredShapeList.sort(defaultSortPriority);
+  return filteredShapeList;
 };
 
 var SHAPE_MEDIA_TYPES = {
@@ -2966,23 +2970,20 @@ var SHAPE_MEDIA_TYPES = {
   DOCUMENT: 'DOCUMENT',
   BINARY: 'BINARY'
 };
-// TODO: For consistency, replace input with an actual ShapeType not a parsed shape
-// (parse it internally if needed)
 
 /**
  * Returns a const for which media type a shape has
  *
- * @param parsedShape
+ * @param shape
  * @returns
  *
  * @category Shape
  */
-var getShapeMediaType = function getShapeMediaType(parsedShape) {
-  var _ref = parsedShape || {},
-      mimeType = _ref.mimeType,
-      videoCodec = _ref.videoCodec,
-      audioCodec = _ref.audioCodec;
-
+var getShapeMediaType = function getShapeMediaType(shape) {
+  var parsedShape = parseShapeType(shape);
+  var mimeType = parsedShape.mimeType,
+      videoCodec = parsedShape.videoCodec,
+      audioCodec = parsedShape.audioCodec;
   if (!mimeType) return undefined;
 
   if (mimeType.startsWith('audio/')) {
@@ -3220,7 +3221,7 @@ exports.formatTimeCodeSeconds = formatTimeCodeSeconds;
 exports.formatTimeCodeSmpte = formatTimeCodeSmpte;
 exports.formatTimeCodeText = formatTimeCodeText;
 exports.formatTimeCodeType = formatTimeCodeType;
-exports.getDocumentType = getDocumentType;
+exports.getShapeDocumentType = getShapeDocumentType;
 exports.getShapeMediaType = getShapeMediaType;
 exports.metadataTypeToWebVtt = metadataTypeToWebVtt;
 exports.parseAudioComponent = parseAudioComponent;