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

package/dist/index.d.ts

@@ -1052,20 +1052,19 @@ declare type DocumentType = keyof typeof 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
  */
-declare const getDocumentType: (shape: {
-    mimeType?: string | string[];
-}) => DocumentType;
+declare const getShapeDocumentType: (shape?: ShapeType) => DocumentType;
 
 declare type FilteredShapeListObject = {
     src: string;
     type: string;
-    shape: ParsedShapeType;
-    [key: string]: string | ParsedShapeType;
+    shape: ShapeType;
+    parsedShape: ParsedShapeType;
+    [key: string]: string | ParsedShapeType | ShapeType;
 };
 declare type FilterShapeSourceOption = {
     sortPriority?: Function;
@@ -1074,6 +1073,7 @@ declare type FilterShapeSourceOption = {
     sourceKey?: string;
     mimeTypeKey?: string;
     shapeKey?: string;
+    parsedShapeKey?: string;
 };
 /**
  * Filter a shape type list to get shapes that are playable in a browser
@@ -1097,12 +1097,12 @@ declare type ShapeMediaType = keyof typeof SHAPE_MEDIA_TYPES;
 /**
  * Returns a const for which media type a shape has
  *
- * @param parsedShape
+ * @param shape
  * @returns
  *
  * @category Shape
  */
-declare const getShapeMediaType: (parsedShape: ParsedShapeType) => ShapeMediaType;
+declare const getShapeMediaType: (shape: ShapeType) => ShapeMediaType;
 
 /**
  * Find the thumbnail uri in a VidiCore item object that's nearest a timeCode
@@ -1179,4 +1179,4 @@ declare type ParsedTranscodePreset = {
  */
 declare const parseTranscodePreset: (transcodePresetType: TranscodePresetType) => ParsedTranscodePreset;
 
-export { CreateFacetTypeFieldList, CreateFacetTypeOptions, CreateMetadataTypeInput, CreateTimeCodeOptions, DocumentType, FIELD_ATTRIBUTE_KEYS, FIELD_VALUE_ATTRIBUTE_KEYS, FilterShapeSourceOption, FilteredShapeListObject, FormatTimeCodeSecondsOptions, FormatTimeCodeSmpteOptions, FormatTimeCodeTextOptions, GROUP_ATTRIBUTE_KEYS, InputField, InputFieldObject, InputFieldValue, InputGroup, InputGroupsOrFields, InputTimespan, InputValue, InputValueObject, InputValueTypes, MetadataTypeToWebVttOptions, ParseFieldListOptions, ParseFieldOptions, ParseGroupListOptions, ParseGroupOptions, ParseHighlightTimespanListOptions, ParseHighlightTimespanOptions, ParseMetadataTypeOptions, ParseTimespanListOptions, ParseTimespanOptions, ParseValueListOptions, ParseValueOptions, ParsedAudioComponentType, ParsedAudioMediaInfoType, ParsedBaseMediaInfoType, ParsedBinaryComponentType, ParsedBinaryMediaInfoType, ParsedContainerComponentType, ParsedFacetType, ParsedFacetTypeCount, ParsedField, ParsedFieldAttributes, ParsedFieldList, ParsedFieldObject, ParsedFileType, ParsedGroup, ParsedGroupAttributes, ParsedGroupList, ParsedHighlightTimespan, ParsedMediaConvertTranscodePreset, ParsedMetadataAttributes, ParsedMetadataType, ParsedShapeType, ParsedTimespan, ParsedTimespanAttributes, ParsedTimespanList, ParsedTranscodePreset, ParsedValue, ParsedValueAttributes, ParsedValueList, ParsedVideoComponentType, ParsedVideoMediaInfoType, ROLE_NAMES, SYSTEM_FIELDGROUPS, SYSTEM_FIELDS, ShapeMediaType, TimeBase, TimeBaseInput, TimeCode, TimeCodeInput, TimeCodeInputOptions, createFacetType, createMetadataType, createTimeBase, createTimeCode, filterShapeSource, findNearestThumbnail, formatTimeBaseText, formatTimeBaseType, formatTimeCodeSeconds, formatTimeCodeSmpte, formatTimeCodeText, formatTimeCodeType, getDocumentType, getShapeMediaType, metadataTypeToWebVtt, parseAudioComponent, parseBinaryComponent, parseContainerComponent, parseFacetType, parseFieldList, parseFileType, parseGroupList, parseHighlightTimespan, parseHighlightTimespanList, parseKeyValuePairTypes as parseKeyValuePairType, parseMediaConvertPreset, parseMetadataType, parseNowDate, parseShapeType, parseSimpleMetadataType, parseTimespan, parseTimespanList, parseTranscodePreset, parseVideoComponent };
+export { CreateFacetTypeFieldList, CreateFacetTypeOptions, CreateMetadataTypeInput, CreateTimeCodeOptions, DocumentType, FIELD_ATTRIBUTE_KEYS, FIELD_VALUE_ATTRIBUTE_KEYS, FilterShapeSourceOption, FilteredShapeListObject, FormatTimeCodeSecondsOptions, FormatTimeCodeSmpteOptions, FormatTimeCodeTextOptions, GROUP_ATTRIBUTE_KEYS, InputField, InputFieldObject, InputFieldValue, InputGroup, InputGroupsOrFields, InputTimespan, InputValue, InputValueObject, InputValueTypes, MetadataTypeToWebVttOptions, ParseFieldListOptions, ParseFieldOptions, ParseGroupListOptions, ParseGroupOptions, ParseHighlightTimespanListOptions, ParseHighlightTimespanOptions, ParseMetadataTypeOptions, ParseTimespanListOptions, ParseTimespanOptions, ParseValueListOptions, ParseValueOptions, ParsedAudioComponentType, ParsedAudioMediaInfoType, ParsedBaseMediaInfoType, ParsedBinaryComponentType, ParsedBinaryMediaInfoType, ParsedContainerComponentType, ParsedFacetType, ParsedFacetTypeCount, ParsedField, ParsedFieldAttributes, ParsedFieldList, ParsedFieldObject, ParsedFileType, ParsedGroup, ParsedGroupAttributes, ParsedGroupList, ParsedHighlightTimespan, ParsedMediaConvertTranscodePreset, ParsedMetadataAttributes, ParsedMetadataType, ParsedShapeType, ParsedTimespan, ParsedTimespanAttributes, ParsedTimespanList, ParsedTranscodePreset, ParsedValue, ParsedValueAttributes, ParsedValueList, ParsedVideoComponentType, ParsedVideoMediaInfoType, ROLE_NAMES, SYSTEM_FIELDGROUPS, SYSTEM_FIELDS, ShapeMediaType, TimeBase, TimeBaseInput, TimeCode, TimeCodeInput, TimeCodeInputOptions, createFacetType, createMetadataType, createTimeBase, createTimeCode, filterShapeSource, findNearestThumbnail, formatTimeBaseText, formatTimeBaseType, formatTimeCodeSeconds, formatTimeCodeSmpte, formatTimeCodeText, formatTimeCodeType, getShapeDocumentType, getShapeMediaType, metadataTypeToWebVtt, parseAudioComponent, parseBinaryComponent, parseContainerComponent, parseFacetType, parseFieldList, parseFileType, parseGroupList, parseHighlightTimespan, parseHighlightTimespanList, parseKeyValuePairTypes as parseKeyValuePairType, parseMediaConvertPreset, parseMetadataType, parseNowDate, parseShapeType, parseSimpleMetadataType, parseTimespan, parseTimespanList, parseTranscodePreset, parseVideoComponent };

package/dist/index.es.js

@@ -2821,6 +2821,7 @@ var parseShapeType = function parseShapeType() {
   return parsedShape;
 };
 
+// eslint-disable-next-line import/no-cycle
 var DOCUMENT_TYPES = {
   PDF: 'PDF',
   TEXT: 'TEXT',
@@ -2832,15 +2833,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;
@@ -2867,8 +2869,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);
@@ -2891,29 +2893,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 ? 'parsedShape' : _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;
@@ -2935,13 +2939,13 @@ var filterShapeSource = function filterShapeSource(itemType, options) {
     if (src && allowedMimeTypes.includes(type)) {
       var _acc$push;
 
-      acc.push((_acc$push = {}, _defineProperty(_acc$push, sourceKey, src), _defineProperty(_acc$push, mimeTypeKey, type), _defineProperty(_acc$push, shapeKey, shape), _acc$push));
+      acc.push((_acc$push = {}, _defineProperty(_acc$push, sourceKey, src), _defineProperty(_acc$push, mimeTypeKey, type), _defineProperty(_acc$push, shapeKey, shapeType), _defineProperty(_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 = {
@@ -2951,23 +2955,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/')) {
@@ -3185,5 +3186,5 @@ var parseTranscodePreset = function parseTranscodePreset(transcodePresetType) {
   return output;
 };
 
-export { FIELD_ATTRIBUTE_KEYS, FIELD_VALUE_ATTRIBUTE_KEYS, GROUP_ATTRIBUTE_KEYS, ROLE_NAMES, SYSTEM_FIELDGROUPS, SYSTEM_FIELDS, TimeBase, TimeCode, createFacetType, createMetadataType, createTimeBase, createTimeCode, filterShapeSource, findNearestThumbnail, formatTimeBaseText, formatTimeBaseType, formatTimeCodeSeconds, formatTimeCodeSmpte, formatTimeCodeText, formatTimeCodeType, getDocumentType, getShapeMediaType, metadataTypeToWebVtt, parseAudioComponent, parseBinaryComponent, parseContainerComponent, parseFacetType, parseFieldList, parseFileType, parseGroupList, parseHighlightTimespan, parseHighlightTimespanList, parseKeyValuePairTypes as parseKeyValuePairType, parseMediaConvertPreset, parseMetadataType, parseNowDate, parseShapeType, parseSimpleMetadataType, parseTimespan, parseTimespanList, parseTranscodePreset, parseVideoComponent };
+export { FIELD_ATTRIBUTE_KEYS, FIELD_VALUE_ATTRIBUTE_KEYS, GROUP_ATTRIBUTE_KEYS, ROLE_NAMES, SYSTEM_FIELDGROUPS, SYSTEM_FIELDS, TimeBase, TimeCode, createFacetType, createMetadataType, createTimeBase, createTimeCode, filterShapeSource, findNearestThumbnail, formatTimeBaseText, formatTimeBaseType, formatTimeCodeSeconds, formatTimeCodeSmpte, formatTimeCodeText, formatTimeCodeType, getShapeDocumentType, getShapeMediaType, metadataTypeToWebVtt, parseAudioComponent, parseBinaryComponent, parseContainerComponent, parseFacetType, parseFieldList, parseFileType, parseGroupList, parseHighlightTimespan, parseHighlightTimespanList, parseKeyValuePairTypes as parseKeyValuePairType, parseMediaConvertPreset, parseMetadataType, parseNowDate, parseShapeType, parseSimpleMetadataType, parseTimespan, parseTimespanList, parseTranscodePreset, parseVideoComponent };
 //# sourceMappingURL=index.es.js.map