@vidispine/vdt-js 22.4.0 → 23.1.0-pre.1

package/dist/index.js

@@ -9,7 +9,7 @@ var _defineProperty = require('@babel/runtime/helpers/defineProperty');
 var _typeof = require('@babel/runtime/helpers/typeof');
 var _classCallCheck = require('@babel/runtime/helpers/classCallCheck');
 var _createClass = require('@babel/runtime/helpers/createClass');
-var parseFileSize = require('filesize');
+var filesize = require('filesize');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -20,7 +20,6 @@ var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_definePropert
 var _typeof__default = /*#__PURE__*/_interopDefaultLegacy(_typeof);
 var _classCallCheck__default = /*#__PURE__*/_interopDefaultLegacy(_classCallCheck);
 var _createClass__default = /*#__PURE__*/_interopDefaultLegacy(_createClass);
-var parseFileSize__default = /*#__PURE__*/_interopDefaultLegacy(parseFileSize);
 
 var gcd = function gcd(a, b) {
   return b ? gcd(b, a % b) : a;
@@ -58,7 +57,7 @@ var parseKeyValuePairTypes = function parseKeyValuePairTypes(keyValuePairTypes)
 };
 
 /**
- * Object with all name of roles in VidiCore
+ * Const object with VidiCore role names
  *
  * @category Auth
  */
@@ -174,43 +173,43 @@ var ROLE_NAMES = {
   VXA_READ: '_vxa_read'
 };
 
-var SHARED_ATTRIBUTE_KEYS = ['uuid', 'user', 'timestamp', 'change', 'conflict', 'mode'];
-var SHARED_FIELD_AND_GROUP_ATTRIBUTE_KEYS = ['name', 'id', 'referenced', 'data', 'inheritance'];
-
 /**
- * Array with all available metadata group attributes
+ * Array with all available VidiCore system/default field group names
  *
  * @category Metadata
  */
-var GROUP_ATTRIBUTE_KEYS = [].concat(SHARED_ATTRIBUTE_KEYS, SHARED_FIELD_AND_GROUP_ATTRIBUTE_KEYS, ['cycle', 'field', 'group']);
+var SYSTEM_FIELDGROUPS = ['stl_subtitle', 'stl_tti', 'stl_gsi', 'mrk_marker', 'pho_validation', 'pho_resource', 'pho_error', 'facedetect_rect', 'facedetect_face', 'originalTrackFilename', 'stl_gsiHeader'];
 
 /**
- * Array with all available metadata group attributes
+ * Array with all available VidiCore system/default field names (including transient)
  *
  * @category Metadata
  */
-var FIELD_ATTRIBUTE_KEYS = [].concat(SHARED_ATTRIBUTE_KEYS, SHARED_FIELD_AND_GROUP_ATTRIBUTE_KEYS, ['value', 'reference', 'type', 'track']);
+var SYSTEM_FIELDS = ['title', 'user', 'shapeTag', 'representativeThumbnail', 'representativeThumbnailNoAuth', 'representativeItems', 'itemId', 'collectionId', 'mediaType', 'mimeType', 'created', 'startTimeCode', 'startSeconds', 'fieldValidationError', 'schemaValidationError', 'originalFilename', 'originalUri', 'originalAudioCodec', 'originalVideoCodec', 'originalHeight', 'originalWidth', 'originalFormat', 'durationSeconds', 'durationTimeCode', 'solr-index', '__user', '__collection', '__collection_size', '__ancestor_collection', '__ancestor_collection_size', '__shape', '__shape_size', '__shape_last_added', '__placeholder_shape_size', '__version', '__version_count', '__storage', '__storage_size', '__shapetag_{tag}_hash_{hash}', '__storage_{tag}', '__storage_{tag}_size', '__storagegroup', '__storagegroup_size', '__sequence', '__sequence_size', '__metadata_last_modified', '__external_id', '__deletion_lock_id', '__deletion_lock_expiry', '__child_collection', '__child_collection_size', '__parent_collection', '__parent_collection_size', '__items_size', 'stl_text', 'stl_justification', 'stl_xrelative', 'stl_yrelative', 'stl_vertical', 'stl_verticalbase', 'stl_horizontalbase', 'stl_sizerelative', 'stl_color', 'stl_outline', 'stl_outlinecolor', 'stl_outlinesize', 'stl_font', 'stl_service', 'stl_tti', 'stl_gsi', 'cct', 'tcd', 'tcf', 'oet', 'cd', 'mnc', 'cpn', 'dfc', 'tcp', 'tcs', 'tet', 'tnb', 'tnd', 'en', 'co', 'tng', 'rd', 'mnr', 'dsc', 'opt', 'lc', 'tpt', 'tn', 'slr', 'tns', 'rn', 'pub', 'dsn', 'ecd', 'mrk_zerolength', 'mrk_text', 'mrk_color', 'pho_resource_name', 'pho_error_level', 'pho_error_code', 'pho_error_description', 'facedetect_rect_width', 'facedetect_rect_height', 'facedetect_rect_y', 'facedetect_rect_x', 'facedetect_pid', 'facedetect_rect', 'trackId', 'eidr_actor', 'eidr_alternateId', 'eidr_countryOfOrigin', 'eidr_director', 'eidr_id', 'eidr_referentType', 'eidr_releaseDate', 'eidr_resourceName', 'eidr_status', 'eidr_sync', 'ttml_div', 'ttml_root', 'vxa_collection_id', 'vxaId', 'vxaLocalPath', 'tco', 'cs', 'ebn', 'tf', 'cf', 'sgn', 'tci', 'jc', 'vp', 'sn'];
+
+var SHARED_ATTRIBUTE_KEYS = ['uuid', 'user', 'timestamp', 'change', 'conflict', 'mode'];
+var SHARED_FIELD_AND_GROUP_ATTRIBUTE_KEYS = ['name', 'id', 'referenced', 'data', 'inheritance'];
 
 /**
  * Array with all available metadata field value attributes
  *
  * @category Metadata
  */
-var FIELD_VALUE_ATTRIBUTE_KEYS = [].concat(SHARED_ATTRIBUTE_KEYS, ['value', 'lang']);
+var FIELD_VALUE_ATTRIBUTE_KEYS = [].concat(_toConsumableArray__default["default"](SHARED_ATTRIBUTE_KEYS), ['value', 'lang']);
 
 /**
- * Array with all available VidiCore system/default field group names
+ * Array with all available metadata field attributes
  *
  * @category Metadata
  */
-var SYSTEM_FIELDGROUPS = ['stl_subtitle', 'stl_tti', 'stl_gsi', 'mrk_marker', 'pho_validation', 'pho_resource', 'pho_error', 'facedetect_rect', 'facedetect_face', 'originalTrackFilename', 'stl_gsiHeader'];
+var FIELD_ATTRIBUTE_KEYS = [].concat(_toConsumableArray__default["default"](SHARED_ATTRIBUTE_KEYS), _toConsumableArray__default["default"](SHARED_FIELD_AND_GROUP_ATTRIBUTE_KEYS), ['value', 'reference', 'type', 'track']);
 
 /**
- * Array with all available VidiCore system/default field group names
+ * Array with all available metadata group attributes
  *
  * @category Metadata
  */
-var SYSTEM_FIELDS = ['title', 'user', 'shapeTag', 'representativeThumbnail', 'representativeThumbnailNoAuth', 'representativeItems', 'itemId', 'collectionId', 'mediaType', 'mimeType', 'created', 'startTimeCode', 'startSeconds', 'fieldValidationError', 'schemaValidationError', 'originalFilename', 'originalUri', 'originalAudioCodec', 'originalVideoCodec', 'originalHeight', 'originalWidth', 'originalFormat', 'durationSeconds', 'durationTimeCode', 'solr-index', '__user', '__collection', '__collection_size', '__ancestor_collection', '__ancestor_collection_size', '__shape', '__shape_size', '__shape_last_added', '__placeholder_shape_size', '__version', '__version_count', '__storage', '__storage_size', '__shapetag_{tag}_hash_{hash}', '__storage_{tag}', '__storage_{tag}_size', '__storagegroup', '__storagegroup_size', '__sequence', '__sequence_size', '__metadata_last_modified', '__external_id', '__deletion_lock_id', '__deletion_lock_expiry', '__child_collection', '__child_collection_size', '__parent_collection', '__parent_collection_size', '__items_size', 'stl_text', 'stl_justification', 'stl_xrelative', 'stl_yrelative', 'stl_vertical', 'stl_verticalbase', 'stl_horizontalbase', 'stl_sizerelative', 'stl_color', 'stl_outline', 'stl_outlinecolor', 'stl_outlinesize', 'stl_font', 'stl_service', 'stl_tti', 'stl_gsi', 'cct', 'tcd', 'tcf', 'oet', 'cd', 'mnc', 'cpn', 'dfc', 'tcp', 'tcs', 'tet', 'tnb', 'tnd', 'en', 'co', 'tng', 'rd', 'mnr', 'dsc', 'opt', 'lc', 'tpt', 'tn', 'slr', 'tns', 'rn', 'pub', 'dsn', 'ecd', 'mrk_zerolength', 'mrk_text', 'mrk_color', 'pho_resource_name', 'pho_error_level', 'pho_error_code', 'pho_error_description', 'facedetect_rect_width', 'facedetect_rect_height', 'facedetect_rect_y', 'facedetect_rect_x', 'facedetect_pid', 'facedetect_rect', 'trackId', 'eidr_actor', 'eidr_alternateId', 'eidr_countryOfOrigin', 'eidr_director', 'eidr_id', 'eidr_referentType', 'eidr_releaseDate', 'eidr_resourceName', 'eidr_status', 'eidr_sync', 'ttml_div', 'ttml_root', 'vxa_collection_id', 'vxaId', 'vxaLocalPath', 'tco', 'cs', 'ebn', 'tf', 'cf', 'sgn', 'tci', 'jc', 'vp', 'sn'];
+var GROUP_ATTRIBUTE_KEYS = [].concat(_toConsumableArray__default["default"](SHARED_ATTRIBUTE_KEYS), _toConsumableArray__default["default"](SHARED_FIELD_AND_GROUP_ATTRIBUTE_KEYS), ['cycle', 'field', 'group']);
 
 var _excluded$e = ["value"],
   _excluded2$2 = ["start", "end", "base"];
@@ -984,6 +983,7 @@ var TimeBase = /*#__PURE__*/function () {
      *
      * @remarks
      * Default format: denominator(:numerator if > 1)
+     *
      * `constant` has precedence over `fraction` if both are true (e.g. NTSC > 30000:1001)
      *
      * @param options For how to display it as text
@@ -1014,6 +1014,7 @@ var TimeBase = /*#__PURE__*/function () {
      * - `number` gives that amount of decimal places
      *
      * Default format: rate with two decimals if needed (i.e. decimals are > 0)
+     *
      * Option precedence (when all true): `constant` > `rounded` > `fixed`
      *
      * @param options For how to display it as rate
@@ -1335,6 +1336,7 @@ var TimeCode = /*#__PURE__*/function () {
      *
      * @remarks
      * Default format: samples@denominator(:numerator if > 1)
+     *
      * `constant` has precedence over `fraction` if both are true
      *
      * @param options Options for how to format text
@@ -1621,7 +1623,9 @@ var getGreatestCommonDivisor = function getGreatestCommonDivisor(num1, num2) {
 var _excluded$5 = ["timeBase", "useGCD"];
 /**
  * Format seconds to TimeCode object
- * Input time base is always 1:1 since it expects seconds as input
+ *
+ * @remarks
+ * Input time base is always considered as 1:1 since it expects seconds as input
  *
  * Note: Max 15 digits accuracy (double precision float64), e.g.
  * - 10^6 seconds can have 10^9 decimals (nanosecond) precision
@@ -2133,6 +2137,19 @@ var parseHighlightTimespanList = function parseHighlightTimespanList() {
   }, {});
 };
 
+/**
+ * Parse Vidicore "NOW" constants to a date object
+ *
+ * Format: `NOW[+/-][number][HOUR/DAY/MONTH/YEAR(s)]` (e.g. "NOW-2HOURS")
+ *
+ * @remarks
+ * Returns an approximate date since it's created client side
+ *
+ * @param value A "NOW" constant
+ * @returns A date from the NOW constant
+ *
+ * @category Search
+ */
 var parseNowDate = function parseNowDate() {
   var value = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'NOW';
   if (value.startsWith('NOW')) {
@@ -2191,7 +2208,7 @@ var sampleRateSymbols = {
   B: 'Hz',
   mB: 'mHz'
 };
-var bitRateSymbols = {
+var bitRateSymbols$1 = {
   kB: 'kbps',
   B: 'bps',
   MB: 'mbps'
@@ -2216,16 +2233,24 @@ var parseAudioComponent = function parseAudioComponent(audioComponentType) {
     audioBitRateMode = audioMediaInfo.Bit_rate_mode;
   var audioMetadata = parseKeyValuePairTypes(metadata || []);
   var audioSamplerateSamples = timeBase !== null && timeBase !== void 0 && timeBase.denominator ? ((timeBase === null || timeBase === void 0 ? void 0 : timeBase.denominator) || 1) / ((timeBase === null || timeBase === void 0 ? void 0 : timeBase.numerator) || 1) : undefined;
-  var audioSamplerate = audioSamplerateSamples !== undefined ? parseFileSize__default["default"](audioSamplerateSamples, {
+  var audioSamplerate = audioSamplerateSamples !== undefined ? filesize.filesize(audioSamplerateSamples, {
     base: 10,
     round: 1,
     symbols: sampleRateSymbols
   }) : undefined;
-  var audioBitrate = bitrate !== undefined ? parseFileSize__default["default"](bitrate, {
-    base: 10,
-    round: 2,
-    symbols: bitRateSymbols
-  }) : undefined;
+  var audioBitrate;
+  var audioBitrateKbps;
+  if (bitrate !== undefined) {
+    var _split;
+    audioBitrate = filesize.filesize(bitrate, {
+      round: 2,
+      symbols: bitRateSymbols$1
+    });
+    audioBitrateKbps = Number((_split = filesize.filesize(bitrate, {
+      exponent: 1,
+      symbols: bitRateSymbols$1
+    }).split(' kbps')) === null || _split === void 0 ? void 0 : _split[0]);
+  }
   return {
     audioFormat: audioFormat,
     audioCodec: audioCodec,
@@ -2233,6 +2258,7 @@ var parseAudioComponent = function parseAudioComponent(audioComponentType) {
     audioSamplerateSamples: audioSamplerateSamples,
     audioBitDepth: audioBitDepth,
     audioBitrate: audioBitrate,
+    audioBitrateKbps: audioBitrateKbps,
     audioBitRateMode: audioBitRateMode,
     audioChannels: audioChannels,
     audioMediaInfo: audioMediaInfo,
@@ -2240,9 +2266,43 @@ var parseAudioComponent = function parseAudioComponent(audioComponentType) {
   };
 };
 
+/**
+ * Const object with all file states in VidiCore
+ * (see https://apidoc.vidispine.com/latest/storage/storage.html#file-states for more info)
+ *
+ * @category File
+ */
+var FILE_STATES = {
+  /** Just created, not used. */
+  NONE: 'NONE',
+  /** Discovered or created, not yet marked as finished. */
+  OPEN: 'OPEN',
+  /** File does no longer grow. */
+  CLOSED: 'CLOSED',
+  /** The current state is not known. */
+  UNKNOWN: 'UNKNOWN',
+  /** File is missing from the file system/storage. */
+  MISSING: 'MISSING',
+  /** File has been missing for a longer period. Candidate for restoration from archive. */
+  LOST: 'LOST',
+  /** File will appear on file system/storage, transfer subsystem or transcoder will create it. */
+  TO_APPEAR: 'TO_APPEAR',
+  /** The file is no longer in use, and will be deleted at the next clean-up sweep. */
+  TO_BE_DELETED: 'TO_BE_DELETED',
+  /** File is in use by transfer subsystem or transcoder. */
+  BEING_READ: 'BEING_READ',
+  /** File is archived. */
+  ARCHIVED: 'ARCHIVED',
+  /** File will be synchronized by multi-site agent. */
+  AWAITING_SYNC: 'AWAITING_SYNC'
+};
+
 /**
  * Parses a VidiCore file object
  *
+ * @remarks
+ * File sizes are parsed with JEDEC standard (base 2)
+ *
  * @param fileType VidiCore file object
  * @returns A parsed file object
  *
@@ -2257,7 +2317,10 @@ var parseFileType = function parseFileType(fileType) {
     fileId = fileType.id;
   var _uriList = _slicedToArray__default["default"](uriList, 1),
     uri = _uriList[0];
-  var fileSize = fileSizeBytes !== undefined ? parseFileSize__default["default"](fileSizeBytes) : '';
+  var fileSize = fileSizeBytes !== undefined ? filesize.filesize(fileSizeBytes, {
+    base: 2,
+    standard: 'jedec'
+  }) : '';
   var fileName = path ? path.split('/').pop() : undefined;
   return {
     uri: uri,
@@ -2372,6 +2435,11 @@ var parseContainerComponent = function parseContainerComponent() {
   return parsedContainerComponentType;
 };
 
+var bitRateSymbols = {
+  kB: 'kbps',
+  B: 'bps',
+  MB: 'mbps'
+};
 /**
  * Parses the technical information of a VideoComponentType.
  * @param {Object} videoComponentType - A VideoComponentType from VidiCore.
@@ -2432,9 +2500,19 @@ var parseVideoComponent = function parseVideoComponent() {
     width = _ref.width;
   var aspectRatio = parseAspectRatio(resolution);
   var dimension = "".concat(width, "x").concat(height);
-  var videoBitrate = bitrate ? parseFileSize__default["default"](bitrate, {
-    bits: true
-  }) : undefined;
+  var videoBitrate;
+  var videoBitrateMbps;
+  if (bitrate !== undefined) {
+    var _split;
+    videoBitrate = filesize.filesize(bitrate, {
+      round: 2,
+      symbols: bitRateSymbols
+    });
+    videoBitrateMbps = Number((_split = filesize.filesize(bitrate, {
+      exponent: 2,
+      symbols: bitRateSymbols
+    }).split(' mbps')) === null || _split === void 0 ? void 0 : _split[0]);
+  }
   return {
     videoFormat: videoFormat,
     dimension: dimension,
@@ -2446,6 +2524,7 @@ var parseVideoComponent = function parseVideoComponent() {
     videoCodec: videoCodec,
     smpte: smpte,
     videoBitrate: videoBitrate,
+    videoBitrateMbps: videoBitrateMbps,
     fieldOrder: fieldOrder,
     colorSpace: colorSpace,
     chromaSubsampling: chromaSubsampling,
@@ -2512,8 +2591,11 @@ var parseShapeType = function parseShapeType() {
   return parsedShape;
 };
 
-// eslint-disable-next-line import/no-cycle
-
+/**
+ * Const object with document types
+ *
+ * @category Shape
+ */
 var DOCUMENT_TYPES = {
   PDF: 'PDF',
   TEXT: 'TEXT',
@@ -2521,6 +2603,21 @@ var DOCUMENT_TYPES = {
   JSON: 'JSON',
   XML: 'XML'
 };
+
+/**
+ * Const object with media types
+ *
+ * @category Shape
+ */
+var SHAPE_MEDIA_TYPES = {
+  IMAGE: 'IMAGE',
+  AUDIO: 'AUDIO',
+  VIDEO: 'VIDEO',
+  DOCUMENT: 'DOCUMENT',
+  BINARY: 'BINARY'
+};
+
+// eslint-disable-next-line import/no-cycle
 /**
  * Return a const for the document type of a shape (looks at mimeType)
  *
@@ -2628,15 +2725,6 @@ var filterShapeSource = function filterShapeSource(itemType, options) {
   return filteredShapeList;
 };
 
-// eslint-disable-next-line import/no-cycle
-
-var SHAPE_MEDIA_TYPES = {
-  IMAGE: 'IMAGE',
-  AUDIO: 'AUDIO',
-  VIDEO: 'VIDEO',
-  DOCUMENT: 'DOCUMENT',
-  BINARY: 'BINARY'
-};
 /**
  * Returns a const for which media type a shape has
  *
@@ -2834,10 +2922,13 @@ var parseTranscodePreset = function parseTranscodePreset(transcodePresetType) {
   return output;
 };
 
+exports.DOCUMENT_TYPES = DOCUMENT_TYPES;
 exports.FIELD_ATTRIBUTE_KEYS = FIELD_ATTRIBUTE_KEYS;
 exports.FIELD_VALUE_ATTRIBUTE_KEYS = FIELD_VALUE_ATTRIBUTE_KEYS;
+exports.FILE_STATES = FILE_STATES;
 exports.GROUP_ATTRIBUTE_KEYS = GROUP_ATTRIBUTE_KEYS;
 exports.ROLE_NAMES = ROLE_NAMES;
+exports.SHAPE_MEDIA_TYPES = SHAPE_MEDIA_TYPES;
 exports.SYSTEM_FIELDGROUPS = SYSTEM_FIELDGROUPS;
 exports.SYSTEM_FIELDS = SYSTEM_FIELDS;
 exports.TimeBase = TimeBase;