@vidispine/vdt-js 22.3.0-pre.4 → 22.3.0-pre.5

package/dist/index.js

@@ -3,23 +3,23 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var _defineProperty = require('@babel/runtime/helpers/defineProperty');
-var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProperties');
 var _slicedToArray = require('@babel/runtime/helpers/slicedToArray');
+var _toConsumableArray = require('@babel/runtime/helpers/toConsumableArray');
+var _objectWithoutProperties = require('@babel/runtime/helpers/objectWithoutProperties');
 var _typeof = require('@babel/runtime/helpers/typeof');
 var _classCallCheck = require('@babel/runtime/helpers/classCallCheck');
 var _createClass = require('@babel/runtime/helpers/createClass');
-var _toConsumableArray = require('@babel/runtime/helpers/toConsumableArray');
 var parseFileSize = require('filesize');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var _defineProperty__default = /*#__PURE__*/_interopDefaultLegacy(_defineProperty);
-var _objectWithoutProperties__default = /*#__PURE__*/_interopDefaultLegacy(_objectWithoutProperties);
 var _slicedToArray__default = /*#__PURE__*/_interopDefaultLegacy(_slicedToArray);
+var _toConsumableArray__default = /*#__PURE__*/_interopDefaultLegacy(_toConsumableArray);
+var _objectWithoutProperties__default = /*#__PURE__*/_interopDefaultLegacy(_objectWithoutProperties);
 var _typeof__default = /*#__PURE__*/_interopDefaultLegacy(_typeof);
 var _classCallCheck__default = /*#__PURE__*/_interopDefaultLegacy(_classCallCheck);
 var _createClass__default = /*#__PURE__*/_interopDefaultLegacy(_createClass);
-var _toConsumableArray__default = /*#__PURE__*/_interopDefaultLegacy(_toConsumableArray);
 var parseFileSize__default = /*#__PURE__*/_interopDefaultLegacy(parseFileSize);
 
 function ownKeys$8(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -259,171 +259,212 @@ var roles = /*#__PURE__*/Object.freeze({
   VXA_READ: VXA_READ
 });
 
-var _excluded$4 = ["groupName"],
+var _excluded$4 = ["value"],
     _excluded2$2 = ["start", "end"];
 
 function ownKeys$7(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 
 function _objectSpread$7(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys$7(Object(source), !0).forEach(function (key) { _defineProperty__default["default"](target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys$7(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
-var parseValueList$1 = function parseValueList(value) {
-  if (value === undefined) return [];
-  if (value === null) return [{
-    value: ''
-  }];
+var COMBINED_PROPERTY_KEYS = ['uuid', 'user', 'timestamp', 'change', 'conflict', 'mode', 'name', 'id', 'referenced', 'data', 'inheritance'];
+var GROUP_PROPERTY_KEYS = [].concat(COMBINED_PROPERTY_KEYS, ['cycle']);
+var FIELD_PROPERTY_KEYS = [].concat(COMBINED_PROPERTY_KEYS, ['value', 'reference', 'type', 'track']);
+var FIELD_VALUE_PROPERTY_KEYS = [].concat(COMBINED_PROPERTY_KEYS, ['value', 'lang']);
+
+var isObject = function isObject(o) {
+  return Object.prototype.toString.call(o) === '[object Object]';
+};
+
+var isDate = function isDate(o) {
+  return Object.prototype.toString.call(o) === '[object Date]';
+};
+
+var isField = function isField(value) {
+  var FIELD_TYPES = ['string', 'boolean', 'number'];
+
+  var isFieldType = function isFieldType(v) {
+    return FIELD_TYPES.includes(_typeof__default["default"](v));
+  };
+
+  var isFieldObject = function isFieldObject(v) {
+    return isObject(v) && (v.value === null || isObject(v.value) || isFieldType(v.value));
+  };
+
+  if (value === null) {
+    return true;
+  }
 
   if (Array.isArray(value)) {
-    return value.map(function (valueOrObject) {
-      if (_typeof__default["default"](valueOrObject) === 'object') {
-        return _objectSpread$7({
-          value: valueOrObject.value || ''
-        }, valueOrObject);
-      }
+    return value.some(isField);
+  }
 
-      return {
-        value: valueOrObject
-      };
-    });
+  return isFieldType(value) || isFieldObject(value) || isDate(value);
+};
+
+var isGroup = function isGroup(value) {
+  var isGroupObject = function isGroupObject(v) {
+    return isObject(v) && v.value === undefined && Object.entries(value);
+  };
+
+  if (Array.isArray(value)) {
+    return value.every(isGroup);
   }
 
-  if (value.value) return [value];
-  return [{
-    value: value
-  }];
+  return isGroupObject(value);
 };
 
-var parseValue = function parseValue() {
-  var fieldValue = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+var tryPluralize = function tryPluralize(str, arr) {
+  return str + (arr.length > 1 ? 's' : '');
+};
 
-  if (fieldValue && (fieldValue.value || fieldValue.name)) {
-    var valueList = fieldValue.value,
-        uuid = fieldValue.uuid;
-    var value = parseValueList$1(valueList);
-    return {
-      value: value,
-      uuid: uuid
-    };
+var ensureKeysAreValid = function ensureKeysAreValid(keysToCheck, keysToMatch) {
+  var unsupportedKeys = keysToCheck.filter(function (k) {
+    return !keysToMatch.includes(k);
+  });
+
+  if (unsupportedKeys.length) {
+    throw Error("Unsupported ".concat(tryPluralize('key', unsupportedKeys), " (").concat(unsupportedKeys.join(', '), ")"));
+  }
+};
+
+var parseValue = function parseValue(value) {
+  if (Array.isArray(value)) {
+    throw Error('Invalid value object, cannot be array');
   }
 
+  if ([undefined, null].includes(value)) return {};
+  if (isDate(value)) return {
+    value: value.toISOString()
+  };
   return {
-    value: parseValueList$1(fieldValue)
+    value: value
   };
 };
 
-var parseField$1 = function parseField() {
-  var field = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var name = field.name,
-      value = field.value;
-  var parsedValue = parseValue(value);
-  return _objectSpread$7({
-    name: name
-  }, parsedValue);
+var parseValueObject = function parseValueObject(valueObject) {
+  ensureKeysAreValid(Object.keys(valueObject), FIELD_VALUE_PROPERTY_KEYS);
+
+  if (Object.keys(valueObject).length === 0) {
+    throw Error('Invalid value object, cannot be empty object');
+  }
+
+  var parsedValue = parseValue(valueObject === null || valueObject === void 0 ? void 0 : valueObject.value);
+  return _objectSpread$7(_objectSpread$7({}, valueObject), parsedValue !== undefined ? parsedValue : {});
 };
 
-var shouldBeField = function shouldBeField(_ref) {
-  var name = _ref.name,
-      value = _ref.value;
-  return ['string', 'boolean', 'number'].includes(_typeof__default["default"](value)) || name !== 'group' && Array.isArray(value) || value === null;
+var parseFieldValue = function parseFieldValue(value) {
+  if ([undefined, null].includes(value)) return undefined;
+  if (Array.isArray(value)) return value.map(parseFieldValue);
+  if (isObject(value)) return parseValueObject(value);
+  return parseValue(value);
 };
 
-var parseGroup$1 = function parseGroup() {
-  var thisGroup = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var groupName = thisGroup.name,
-      _thisGroup$value = thisGroup.value,
-      groupsOrFields = _thisGroup$value === void 0 ? {} : _thisGroup$value; // eslint-disable-next-line no-use-before-define
+var parseFieldObject = function parseFieldObject(fieldObject) {
+  ensureKeysAreValid(Object.keys(fieldObject), FIELD_PROPERTY_KEYS);
+  var parsedFieldValue = parseFieldValue(fieldObject === null || fieldObject === void 0 ? void 0 : fieldObject.value);
 
-  var _parseGroupsOrFields = parseGroupsOrFields(groupsOrFields),
-      field = _parseGroupsOrFields.field,
-      group = _parseGroupsOrFields.group;
+  if (parsedFieldValue === undefined) {
+    fieldObject.value;
+        var fieldObjectWithoutValue = _objectWithoutProperties__default["default"](fieldObject, _excluded$4);
+
+    return fieldObjectWithoutValue;
+  }
+
+  return _objectSpread$7(_objectSpread$7({}, fieldObject), {}, {
+    value: _toConsumableArray__default["default"](Array.isArray(parsedFieldValue) ? parsedFieldValue : [parsedFieldValue])
+  });
+};
+
+var parseField$1 = function parseField(field) {
+  if (isObject(field)) {
+    return parseFieldObject(field);
+  }
+
+  var parsedFieldValue = parseFieldValue(field);
+
+  if (parsedFieldValue === undefined) {
+    return undefined;
+  }
 
   return {
-    name: groupName,
-    group: group,
-    field: field
+    value: _toConsumableArray__default["default"](Array.isArray(parsedFieldValue) ? parsedFieldValue : [parsedFieldValue])
   };
 };
 
-var parseGroupsOrFields = function parseGroupsOrFields(groupsOrFields) {
+var parseGroupsAndFields = function parseGroupsAndFields(groupOrField) {
   var group = [];
   var field = [];
-  Object.entries(groupsOrFields).forEach(function (_ref2) {
-    var _ref3 = _slicedToArray__default["default"](_ref2, 2),
-        name = _ref3[0],
-        value = _ref3[1];
-
-    if (shouldBeField({
-      name: name,
-      value: value
-    })) {
-      field.push(parseField$1({
-        name: name,
-        value: value
-      }));
-    } else if (Array.isArray(value)) {
-      value.forEach(function (_ref4) {
-        var groupName = _ref4.groupName,
-            groupValue = _objectWithoutProperties__default["default"](_ref4, _excluded$4);
-
-        group.push(parseGroup$1({
-          name: groupName,
-          value: groupValue
-        }));
+  var groupAttributes = {};
+  Object.entries(groupOrField || {}).forEach(function (_ref) {
+    var _ref2 = _slicedToArray__default["default"](_ref, 2),
+        name = _ref2[0],
+        value = _ref2[1];
+
+    if (GROUP_PROPERTY_KEYS.includes(name)) {
+      groupAttributes = _objectSpread$7(_objectSpread$7({}, groupAttributes), {}, _defineProperty__default["default"]({}, name, value));
+    } else if (isField(value)) {
+      try {
+        field.push(_objectSpread$7({
+          name: name
+        }, parseField$1(value)));
+      } catch (error) {
+        throw Error(error.message + (name ? " for field \"".concat(name, "\"") : ''));
+      }
+    } else if (isGroup(value)) {
+      (Array.isArray(value) ? value : [value]).forEach(function (v) {
+        group.push(_objectSpread$7({
+          name: name
+        }, parseGroupsAndFields(v)));
       });
     } else {
-      group.push(parseGroup$1({
-        name: name,
-        value: value
-      }));
+      throw Error("Unhandled value for \"".concat(name, "\""));
     }
   });
-  return {
-    group: group,
+  return _objectSpread$7(_objectSpread$7(_objectSpread$7({}, groupAttributes), group.length > 0 ? {
+    group: group
+  } : {}), field.length > 0 ? {
     field: field
-  };
+  } : {});
 };
 
 var parseTimespan$1 = function parseTimespan() {
   var timespan = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
 
-  var _ref5 = timespan || {},
-      _ref5$start = _ref5.start,
-      start = _ref5$start === void 0 ? '-INF' : _ref5$start,
-      _ref5$end = _ref5.end,
-      end = _ref5$end === void 0 ? '+INF' : _ref5$end,
-      groupsOrFields = _objectWithoutProperties__default["default"](_ref5, _excluded2$2);
+  var _ref3 = timespan || {},
+      _ref3$start = _ref3.start,
+      start = _ref3$start === void 0 ? '-INF' : _ref3$start,
+      _ref3$end = _ref3.end,
+      end = _ref3$end === void 0 ? '+INF' : _ref3$end,
+      groupsAndFields = _objectWithoutProperties__default["default"](_ref3, _excluded2$2);
 
-  var _parseGroupsOrFields2 = parseGroupsOrFields(groupsOrFields),
-      group = _parseGroupsOrFields2.group,
-      field = _parseGroupsOrFields2.field;
+  var _parseGroupsAndFields = parseGroupsAndFields(groupsAndFields),
+      group = _parseGroupsAndFields.group,
+      field = _parseGroupsAndFields.field;
 
-  return {
-    start: start,
-    end: end,
-    field: field,
+  return _objectSpread$7(_objectSpread$7(_objectSpread$7({}, group ? {
     group: group
-  };
+  } : {}), field ? {
+    field: field
+  } : {}), {}, {
+    start: start,
+    end: end
+  });
 };
 /**
  * Create a MetadataType object from a metadata object
- * @param {Object} metadata={} - object with metadata to create MetadataType object of
+ *
+ * @param {Object} metadata - object with metadata to create MetadataType object of
  * @returns {Object} MetadataType
  */
 
 
 var createMetadataType = function createMetadataType() {
   var metadata = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  var metadataType = {};
-
-  if (Array.isArray(metadata)) {
-    metadataType.timespan = metadata.map(function (thisTimeSpan) {
-      return parseTimespan$1(thisTimeSpan);
-    });
-  } else {
-    var genericTimespan = parseTimespan$1(metadata);
-    metadataType.timespan = [genericTimespan];
-  }
-
-  return metadataType;
+  return {
+    timespan: (Array.isArray(metadata) ? metadata : [metadata]).map(function (t) {
+      return parseTimespan$1(t);
+    })
+  };
 };
 
 var sortTimespanList = function sortTimespanList(timespan1, timespan2) {
@@ -859,13 +900,13 @@ var parseHighlightTimespan = function parseHighlightTimespan() {
       start = _ref.start,
       end = _ref.end;
 
-  var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var _opts$arrayOnSingle = opts.arrayOnSingle,
-      arrayOnSingle = _opts$arrayOnSingle === void 0 ? true : _opts$arrayOnSingle,
-      _opts$joinValue = opts.joinValue,
-      joinValue = _opts$joinValue === void 0 ? undefined : _opts$joinValue,
-      _opts$timespanAsList = opts.timespanAsList,
-      timespanAsList = _opts$timespanAsList === void 0 ? undefined : _opts$timespanAsList;
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var _options$arrayOnSingl = options.arrayOnSingle,
+      arrayOnSingle = _options$arrayOnSingl === void 0 ? true : _options$arrayOnSingl,
+      _options$joinValue = options.joinValue,
+      joinValue = _options$joinValue === void 0 ? undefined : _options$joinValue,
+      _options$timespanAsLi = options.timespanAsList,
+      timespanAsList = _options$timespanAsLi === void 0 ? undefined : _options$timespanAsLi;
   var initialValue = timespanAsList ? {
     start: start,
     end: end