@vidispine/vdt-react 22.3.0-pre.3 → 22.3.0

package/dist/index.es.js

@@ -5,8 +5,8 @@ import { utils, search, vsimport, collection, ChunkedUpload, access, metadatafie
 import _objectWithoutProperties from '@babel/runtime/helpers/objectWithoutProperties';
 import _toConsumableArray from '@babel/runtime/helpers/toConsumableArray';
 import _typeof from '@babel/runtime/helpers/typeof';
-import { createMetadataType, formatTimeCodeText, formatSeconds, parseMetadataType, roles } from '@vidispine/vdt-js';
-import { decompressFromEncodedURIComponent, compressToEncodedURIComponent } from 'lz-string';
+import { createMetadataType, formatTimeCodeSeconds, formatTimeCodeText, parseMetadataType, roles } from '@vidispine/vdt-js';
+import { compressToEncodedURIComponent, decompressFromEncodedURIComponent } from 'lz-string';
 import _asyncToGenerator from '@babel/runtime/helpers/asyncToGenerator';
 import _regeneratorRuntime from '@babel/runtime/regenerator';
 import useDeepCompareEffect from 'use-deep-compare-effect';
@@ -226,7 +226,11 @@ var searchReducer$3 = function searchReducer(state, action) {
     case ACTION_TYPE$3.CHANGE_ITEMSEARCHDOCUMENT:
       {
         return _objectSpread$k(_objectSpread$k({}, state), {}, {
-          itemSearchDocument: action.itemSearchDocument
+          page: Number.isInteger(action.page) ? action.page : state.page,
+          itemSearchDocument: action.itemSearchDocument,
+          matrixParams: _objectSpread$k(_objectSpread$k({}, state.matrixParams), {}, {
+            first: Number.isInteger(action.page) ? action.page * state.rowsPerPage + 1 : state.matrixParams.first
+          })
         });
       }
 
@@ -472,10 +476,11 @@ function useSearch(initialState) {
       value: value
     });
   }, []);
-  var setItemSearchDocument = useCallback(function (itemSearchDocument) {
+  var setItemSearchDocument = useCallback(function (itemSearchDocument, page) {
     return dispatch({
       type: ACTION_TYPE$3.CHANGE_ITEMSEARCHDOCUMENT,
-      itemSearchDocument: itemSearchDocument
+      itemSearchDocument: itemSearchDocument,
+      page: page
     });
   }, []);
   var setQueryParams = useCallback(function (queryParams) {
@@ -1613,7 +1618,9 @@ var useAddMetadataFieldAttributes = function useAddMetadataFieldAttributes(_ref5
       _ref5$fieldQueryParam = _ref5.fieldQueryParams,
       fieldQueryParams = _ref5$fieldQueryParam === void 0 ? {} : _ref5$fieldQueryParam,
       _ref5$groupQueryParam = _ref5.groupQueryParams,
-      groupQueryParams = _ref5$groupQueryParam === void 0 ? {} : _ref5$groupQueryParam;
+      groupQueryParams = _ref5$groupQueryParam === void 0 ? {} : _ref5$groupQueryParam,
+      _ref5$getAttributes = _ref5.getAttributes,
+      getAttributes = _ref5$getAttributes === void 0 ? true : _ref5$getAttributes;
 
   var _useState = useState(false),
       _useState2 = _slicedToArray(_useState, 2),
@@ -1631,6 +1638,11 @@ var useAddMetadataFieldAttributes = function useAddMetadataFieldAttributes(_ref5
       setGroupsWithAttributes = _useState6[1];
 
   useDeepCompareEffect(function () {
+    var didCancel = false;
+    if (getAttributes === false) return function () {
+      didCancel = true;
+    };
+
     var addFieldAttributes = function addFieldAttributes() {
       var fieldsArray = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
       var fieldsAttributes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -1682,8 +1694,6 @@ var useAddMetadataFieldAttributes = function useAddMetadataFieldAttributes(_ref5
       });
     };
 
-    var didCancel = false;
-
     function fetchAttributesAsync() {
       return _fetchAttributesAsync.apply(this, arguments);
     }
@@ -1862,7 +1872,7 @@ var useAddMetadataFieldAttributes = function useAddMetadataFieldAttributes(_ref5
     return function () {
       didCancel = true;
     };
-  }, [fields, groups, fieldDataToInclude, groupDataToInclude, fieldQueryParams, groupQueryParams]);
+  }, [fields, groups, fieldDataToInclude, groupDataToInclude, fieldQueryParams, groupQueryParams, getAttributes]);
   return {
     fieldsWithAttributes: fieldsWithAttributes,
     groupsWithAttributes: groupsWithAttributes,
@@ -3084,7 +3094,7 @@ function useHoverScrub() {
       }
 
       var mouseTimecodePosition = mouseElementPosition / (e.currentTarget.offsetWidth / +durationSeconds);
-      setThumbnailTimeCode(formatSeconds(mouseTimecodePosition));
+      setThumbnailTimeCode(formatTimeCodeSeconds(mouseTimecodePosition));
       var newIndex = indexOfPrecededTimeCode(mouseTimecodePosition, thumbnailTimeCodeArray.map(function (tc) {
         return tc.toSeconds().toFixed(0);
       }));
@@ -3888,7 +3898,73 @@ function useCompoundMetadata(itemId, values, groups, groupFields, setGroupFields
   };
 }
 
-var _excluded$2 = ["itemType", "collectionType", "joinValue", "flat", "groupAsList", "children"];
+function useGetEntityMetadata(_ref) {
+  var entity = _ref.entity,
+      entityId = _ref.entityId,
+      _ref$queryParams = _ref.queryParams,
+      queryParams = _ref$queryParams === void 0 ? {} : _ref$queryParams,
+      _ref$refreshOnMount = _ref.refreshOnMount,
+      refreshOnMount = _ref$refreshOnMount === void 0 ? true : _ref$refreshOnMount;
+
+  var _useApi = useApi(metadata.getEntityMetadata),
+      request = _useApi.request,
+      _useApi$data = _useApi.data,
+      metadataType = _useApi$data === void 0 ? {} : _useApi$data,
+      isLoading = _useApi.isLoading,
+      isError = _useApi.isError;
+
+  var onRefresh = function onRefresh() {
+    return request({
+      entity: entity,
+      entityId: entityId,
+      queryParams: queryParams
+    });
+  };
+
+  useDeepCompareEffect(function () {
+    if (refreshOnMount) onRefresh();
+  }, [entity, entityId, queryParams]);
+  return {
+    metadataType: metadataType,
+    isLoading: isLoading,
+    isError: isError,
+    onRefresh: onRefresh
+  };
+}
+
+function useGetFieldGroup(_ref) {
+  var groupName = _ref.groupName,
+      _ref$queryParams = _ref.queryParams,
+      queryParams = _ref$queryParams === void 0 ? {} : _ref$queryParams,
+      _ref$refreshOnMount = _ref.refreshOnMount,
+      refreshOnMount = _ref$refreshOnMount === void 0 ? true : _ref$refreshOnMount;
+
+  var _useApi = useApi(fieldgroup.getFieldGroup),
+      request = _useApi.request,
+      _useApi$data = _useApi.data,
+      metadataFieldGroupType = _useApi$data === void 0 ? {} : _useApi$data,
+      isLoading = _useApi.isLoading,
+      isError = _useApi.isError;
+
+  var onRefresh = function onRefresh() {
+    return request({
+      groupName: groupName,
+      queryParams: queryParams
+    });
+  };
+
+  useDeepCompareEffect(function () {
+    if (refreshOnMount) onRefresh();
+  }, [groupName, queryParams]);
+  return {
+    metadataFieldGroupType: metadataFieldGroupType,
+    isLoading: isLoading,
+    isError: isError,
+    onRefresh: onRefresh
+  };
+}
+
+var _excluded$2 = ["itemType", "collectionType", "metadataType", "joinValue", "flat", "groupAsList", "children"];
 
 function ownKeys$6(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; }
 
@@ -3896,6 +3972,7 @@ function _objectSpread$6(target) { for (var i = 1; i < arguments.length; i++) {
 function MetadataType(_ref) {
   var itemType = _ref.itemType,
       collectionType = _ref.collectionType,
+      propsMetadataType = _ref.metadataType,
       _ref$joinValue = _ref.joinValue,
       joinValue = _ref$joinValue === void 0 ? ',' : _ref$joinValue,
       _ref$flat = _ref.flat,
@@ -3905,8 +3982,13 @@ function MetadataType(_ref) {
       children = _ref.children,
       props = _objectWithoutProperties(_ref, _excluded$2);
 
-  var entityType = itemType || collectionType || {};
-  var metadataType = entityType.metadata;
+  var metadataType = propsMetadataType;
+
+  if (itemType || collectionType) {
+    var entityType = itemType || collectionType || {};
+    metadataType = entityType === null || entityType === void 0 ? void 0 : entityType.metadata;
+  }
+
   var metadata = useMemo(function () {
     return parseMetadataType(metadataType, {
       joinValue: joinValue,
@@ -4525,32 +4607,26 @@ var ErrorBoundary = /*#__PURE__*/function (_Component) {
   return ErrorBoundary;
 }(Component);
 
-/* eslint react/prop-types: "off" */
 function GetFieldGroup(_ref) {
   var groupName = _ref.groupName,
       queryParams = _ref.queryParams,
+      refreshOnMount = _ref.refreshOnMount,
       children = _ref.children;
 
-  var _useApi = useApi(fieldgroup.getFieldGroup),
-      request = _useApi.request,
-      metadataFieldGroupDocument = _useApi.data,
-      isLoading = _useApi.isLoading,
-      isError = _useApi.isError;
-
-  var onRefresh = function onRefresh() {
-    return request({
-      groupName: groupName,
-      queryParams: queryParams
-    });
-  };
+  var _useGetFieldGroup = useGetFieldGroup({
+    groupName: groupName,
+    queryParams: queryParams,
+    refreshOnMount: refreshOnMount
+  }),
+      metadataFieldGroupType = _useGetFieldGroup.metadataFieldGroupType,
+      onRefresh = _useGetFieldGroup.onRefresh,
+      isLoading = _useGetFieldGroup.isLoading,
+      isError = _useGetFieldGroup.isError;
 
-  useEffect(function () {
-    onRefresh(); // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [groupName, queryParams]);
   var cloneProps = {
     groupName: groupName,
     queryParams: queryParams,
-    metadataFieldGroupDocument: metadataFieldGroupDocument,
+    metadataFieldGroupType: metadataFieldGroupType,
     onRefresh: onRefresh,
     isLoading: isLoading,
     isError: isError
@@ -4697,6 +4773,42 @@ function ComposeProviders(_ref) {
   }, children);
 }
 
+function GetEntityMetadata(_ref) {
+  var entity = _ref.entity,
+      entityId = _ref.entityId,
+      queryParams = _ref.queryParams,
+      refreshOnMount = _ref.refreshOnMount,
+      children = _ref.children;
+
+  var _useGetEntityMetadata = useGetEntityMetadata({
+    entity: entity,
+    entityId: entityId,
+    queryParams: queryParams,
+    refreshOnMount: refreshOnMount
+  }),
+      metadataType = _useGetEntityMetadata.metadataType,
+      onRefresh = _useGetEntityMetadata.onRefresh,
+      isLoading = _useGetEntityMetadata.isLoading,
+      isError = _useGetEntityMetadata.isError;
+
+  var cloneProps = {
+    entity: entity,
+    entityId: entityId,
+    queryParams: queryParams,
+    metadataType: metadataType,
+    onRefresh: onRefresh,
+    isLoading: isLoading,
+    isError: isError
+  };
+  if (entity === 'collection') cloneProps.collectionId = entityId;else if (entity === 'item') cloneProps.itemId = entityId;
+
+  var cloneChild = function cloneChild(child) {
+    return /*#__PURE__*/cloneElement(child, cloneProps);
+  };
+
+  return Children.map(children, cloneChild);
+}
+
 function ownKeys$3(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$3(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys$3(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys$3(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -6696,5 +6808,5 @@ function DropArea(_ref) {
   });
 }
 
-export { Auth, AuthContext, AuthProvider, BinContext, BinProvider, ComposeProviders, DropArea, ErrorBoundary, GetCollectionContent as GetCollection, GetFieldGroup, GetItem, GetJobs, HasRole, ListEntityAccess, MetadataType, RolesProvider, SearchCollection, SearchItem, SearchItemCollection, SettingsProvider, VidispineApi, compose, handleAddEntity, handleMoveEntity, handleRemoveEntity, useAddMetadataFieldAttributes, useApi, useAuthContext, useAutocomplete, useCollectionAutoPlay, useCompoundMetadata, useCsvDownload, useDocSearchAutocomplete, useEntityAccess, useGetCollection$1 as useGetCollection, useGetCollection as useGetCollectionItem, useGetEntity, useGetFieldMetadataDataset, useGetItem, useGetSavedSearchFolders, useGroup, useHoverScrub, useInterval, useJobSearch, useListGroup, useListUser, useLocalStorage, useMouseDownPosition, useQueryInitialState, useRepresentativeItems, useRoles, useSavedSearch, useSearch, useSearchGroup, useSearchItem, useSearchUser, useSelected, useSettings, useSettingsActions, useTab, useThumbnailScrub, useUpdateEffect, useUpdateQueryState, useUploadFiles, useUser, withErrorBoundary };
+export { Auth, AuthContext, AuthProvider, BinContext, BinProvider, ComposeProviders, DropArea, ErrorBoundary, GetCollectionContent as GetCollection, GetEntityMetadata, GetFieldGroup, GetItem, GetJobs, HasRole, ListEntityAccess, MetadataType, RolesProvider, SearchCollection, SearchItem, SearchItemCollection, SettingsProvider, VidispineApi, compose, handleAddEntity, handleMoveEntity, handleRemoveEntity, useAddMetadataFieldAttributes, useApi, useAuthContext, useAutocomplete, useCollectionAutoPlay, useCompoundMetadata, useCsvDownload, useDocSearchAutocomplete, useEntityAccess, useGetCollection$1 as useGetCollection, useGetCollection as useGetCollectionItem, useGetEntity, useGetEntityMetadata, useGetFieldGroup, useGetFieldMetadataDataset, useGetItem, useGetSavedSearchFolders, useGroup, useHoverScrub, useInterval, useJobSearch, useListGroup, useListUser, useLocalStorage, useMouseDownPosition, useQueryInitialState, useRepresentativeItems, useRoles, useSavedSearch, useSearch, useSearchGroup, useSearchItem, useSearchUser, useSelected, useSettings, useSettingsActions, useTab, useThumbnailScrub, useUpdateEffect, useUpdateQueryState, useUploadFiles, useUser, withErrorBoundary };
 //# sourceMappingURL=index.es.js.map