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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.es.js CHANGED
@@ -1613,7 +1613,9 @@ var useAddMetadataFieldAttributes = function useAddMetadataFieldAttributes(_ref5
1613
1613
  _ref5$fieldQueryParam = _ref5.fieldQueryParams,
1614
1614
  fieldQueryParams = _ref5$fieldQueryParam === void 0 ? {} : _ref5$fieldQueryParam,
1615
1615
  _ref5$groupQueryParam = _ref5.groupQueryParams,
1616
- groupQueryParams = _ref5$groupQueryParam === void 0 ? {} : _ref5$groupQueryParam;
1616
+ groupQueryParams = _ref5$groupQueryParam === void 0 ? {} : _ref5$groupQueryParam,
1617
+ _ref5$getAttributes = _ref5.getAttributes,
1618
+ getAttributes = _ref5$getAttributes === void 0 ? true : _ref5$getAttributes;
1617
1619
 
1618
1620
  var _useState = useState(false),
1619
1621
  _useState2 = _slicedToArray(_useState, 2),
@@ -1631,6 +1633,11 @@ var useAddMetadataFieldAttributes = function useAddMetadataFieldAttributes(_ref5
1631
1633
  setGroupsWithAttributes = _useState6[1];
1632
1634
 
1633
1635
  useDeepCompareEffect(function () {
1636
+ var didCancel = false;
1637
+ if (getAttributes === false) return function () {
1638
+ didCancel = true;
1639
+ };
1640
+
1634
1641
  var addFieldAttributes = function addFieldAttributes() {
1635
1642
  var fieldsArray = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
1636
1643
  var fieldsAttributes = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
@@ -1682,8 +1689,6 @@ var useAddMetadataFieldAttributes = function useAddMetadataFieldAttributes(_ref5
1682
1689
  });
1683
1690
  };
1684
1691
 
1685
- var didCancel = false;
1686
-
1687
1692
  function fetchAttributesAsync() {
1688
1693
  return _fetchAttributesAsync.apply(this, arguments);
1689
1694
  }
@@ -1862,7 +1867,7 @@ var useAddMetadataFieldAttributes = function useAddMetadataFieldAttributes(_ref5
1862
1867
  return function () {
1863
1868
  didCancel = true;
1864
1869
  };
1865
- }, [fields, groups, fieldDataToInclude, groupDataToInclude, fieldQueryParams, groupQueryParams]);
1870
+ }, [fields, groups, fieldDataToInclude, groupDataToInclude, fieldQueryParams, groupQueryParams, getAttributes]);
1866
1871
  return {
1867
1872
  fieldsWithAttributes: fieldsWithAttributes,
1868
1873
  groupsWithAttributes: groupsWithAttributes,
@@ -3888,7 +3893,73 @@ function useCompoundMetadata(itemId, values, groups, groupFields, setGroupFields
3888
3893
  };
3889
3894
  }
3890
3895
 
3891
- var _excluded$2 = ["itemType", "collectionType", "joinValue", "flat", "groupAsList", "children"];
3896
+ function useGetEntityMetadata(_ref) {
3897
+ var entity = _ref.entity,
3898
+ entityId = _ref.entityId,
3899
+ _ref$queryParams = _ref.queryParams,
3900
+ queryParams = _ref$queryParams === void 0 ? {} : _ref$queryParams,
3901
+ _ref$refreshOnMount = _ref.refreshOnMount,
3902
+ refreshOnMount = _ref$refreshOnMount === void 0 ? true : _ref$refreshOnMount;
3903
+
3904
+ var _useApi = useApi(metadata.getEntityMetadata),
3905
+ request = _useApi.request,
3906
+ _useApi$data = _useApi.data,
3907
+ metadataType = _useApi$data === void 0 ? {} : _useApi$data,
3908
+ isLoading = _useApi.isLoading,
3909
+ isError = _useApi.isError;
3910
+
3911
+ var onRefresh = function onRefresh() {
3912
+ return request({
3913
+ entity: entity,
3914
+ entityId: entityId,
3915
+ queryParams: queryParams
3916
+ });
3917
+ };
3918
+
3919
+ useDeepCompareEffect(function () {
3920
+ if (refreshOnMount) onRefresh();
3921
+ }, [entity, entityId, queryParams]);
3922
+ return {
3923
+ metadataType: metadataType,
3924
+ isLoading: isLoading,
3925
+ isError: isError,
3926
+ onRefresh: onRefresh
3927
+ };
3928
+ }
3929
+
3930
+ function useGetFieldGroup(_ref) {
3931
+ var groupName = _ref.groupName,
3932
+ _ref$queryParams = _ref.queryParams,
3933
+ queryParams = _ref$queryParams === void 0 ? {} : _ref$queryParams,
3934
+ _ref$refreshOnMount = _ref.refreshOnMount,
3935
+ refreshOnMount = _ref$refreshOnMount === void 0 ? true : _ref$refreshOnMount;
3936
+
3937
+ var _useApi = useApi(fieldgroup.getFieldGroup),
3938
+ request = _useApi.request,
3939
+ _useApi$data = _useApi.data,
3940
+ metadataFieldGroupType = _useApi$data === void 0 ? {} : _useApi$data,
3941
+ isLoading = _useApi.isLoading,
3942
+ isError = _useApi.isError;
3943
+
3944
+ var onRefresh = function onRefresh() {
3945
+ return request({
3946
+ groupName: groupName,
3947
+ queryParams: queryParams
3948
+ });
3949
+ };
3950
+
3951
+ useDeepCompareEffect(function () {
3952
+ if (refreshOnMount) onRefresh();
3953
+ }, [groupName, queryParams]);
3954
+ return {
3955
+ metadataFieldGroupType: metadataFieldGroupType,
3956
+ isLoading: isLoading,
3957
+ isError: isError,
3958
+ onRefresh: onRefresh
3959
+ };
3960
+ }
3961
+
3962
+ var _excluded$2 = ["itemType", "collectionType", "metadataType", "joinValue", "flat", "groupAsList", "children"];
3892
3963
 
3893
3964
  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; }
3894
3965
 
@@ -3896,6 +3967,7 @@ function _objectSpread$6(target) { for (var i = 1; i < arguments.length; i++) {
3896
3967
  function MetadataType(_ref) {
3897
3968
  var itemType = _ref.itemType,
3898
3969
  collectionType = _ref.collectionType,
3970
+ propsMetadataType = _ref.metadataType,
3899
3971
  _ref$joinValue = _ref.joinValue,
3900
3972
  joinValue = _ref$joinValue === void 0 ? ',' : _ref$joinValue,
3901
3973
  _ref$flat = _ref.flat,
@@ -3905,8 +3977,13 @@ function MetadataType(_ref) {
3905
3977
  children = _ref.children,
3906
3978
  props = _objectWithoutProperties(_ref, _excluded$2);
3907
3979
 
3908
- var entityType = itemType || collectionType || {};
3909
- var metadataType = entityType.metadata;
3980
+ var metadataType = propsMetadataType;
3981
+
3982
+ if (itemType || collectionType) {
3983
+ var entityType = itemType || collectionType || {};
3984
+ metadataType = entityType === null || entityType === void 0 ? void 0 : entityType.metadata;
3985
+ }
3986
+
3910
3987
  var metadata = useMemo(function () {
3911
3988
  return parseMetadataType(metadataType, {
3912
3989
  joinValue: joinValue,
@@ -4525,32 +4602,26 @@ var ErrorBoundary = /*#__PURE__*/function (_Component) {
4525
4602
  return ErrorBoundary;
4526
4603
  }(Component);
4527
4604
 
4528
- /* eslint react/prop-types: "off" */
4529
4605
  function GetFieldGroup(_ref) {
4530
4606
  var groupName = _ref.groupName,
4531
4607
  queryParams = _ref.queryParams,
4608
+ refreshOnMount = _ref.refreshOnMount,
4532
4609
  children = _ref.children;
4533
4610
 
4534
- var _useApi = useApi(fieldgroup.getFieldGroup),
4535
- request = _useApi.request,
4536
- metadataFieldGroupDocument = _useApi.data,
4537
- isLoading = _useApi.isLoading,
4538
- isError = _useApi.isError;
4539
-
4540
- var onRefresh = function onRefresh() {
4541
- return request({
4542
- groupName: groupName,
4543
- queryParams: queryParams
4544
- });
4545
- };
4611
+ var _useGetFieldGroup = useGetFieldGroup({
4612
+ groupName: groupName,
4613
+ queryParams: queryParams,
4614
+ refreshOnMount: refreshOnMount
4615
+ }),
4616
+ metadataFieldGroupType = _useGetFieldGroup.metadataFieldGroupType,
4617
+ onRefresh = _useGetFieldGroup.onRefresh,
4618
+ isLoading = _useGetFieldGroup.isLoading,
4619
+ isError = _useGetFieldGroup.isError;
4546
4620
 
4547
- useEffect(function () {
4548
- onRefresh(); // eslint-disable-next-line react-hooks/exhaustive-deps
4549
- }, [groupName, queryParams]);
4550
4621
  var cloneProps = {
4551
4622
  groupName: groupName,
4552
4623
  queryParams: queryParams,
4553
- metadataFieldGroupDocument: metadataFieldGroupDocument,
4624
+ metadataFieldGroupType: metadataFieldGroupType,
4554
4625
  onRefresh: onRefresh,
4555
4626
  isLoading: isLoading,
4556
4627
  isError: isError
@@ -4697,6 +4768,42 @@ function ComposeProviders(_ref) {
4697
4768
  }, children);
4698
4769
  }
4699
4770
 
4771
+ function GetEntityMetadata(_ref) {
4772
+ var entity = _ref.entity,
4773
+ entityId = _ref.entityId,
4774
+ queryParams = _ref.queryParams,
4775
+ refreshOnMount = _ref.refreshOnMount,
4776
+ children = _ref.children;
4777
+
4778
+ var _useGetEntityMetadata = useGetEntityMetadata({
4779
+ entity: entity,
4780
+ entityId: entityId,
4781
+ queryParams: queryParams,
4782
+ refreshOnMount: refreshOnMount
4783
+ }),
4784
+ metadataType = _useGetEntityMetadata.metadataType,
4785
+ onRefresh = _useGetEntityMetadata.onRefresh,
4786
+ isLoading = _useGetEntityMetadata.isLoading,
4787
+ isError = _useGetEntityMetadata.isError;
4788
+
4789
+ var cloneProps = {
4790
+ entity: entity,
4791
+ entityId: entityId,
4792
+ queryParams: queryParams,
4793
+ metadataType: metadataType,
4794
+ onRefresh: onRefresh,
4795
+ isLoading: isLoading,
4796
+ isError: isError
4797
+ };
4798
+ if (entity === 'collection') cloneProps.collectionId = entityId;else if (entity === 'item') cloneProps.itemId = entityId;
4799
+
4800
+ var cloneChild = function cloneChild(child) {
4801
+ return /*#__PURE__*/cloneElement(child, cloneProps);
4802
+ };
4803
+
4804
+ return Children.map(children, cloneChild);
4805
+ }
4806
+
4700
4807
  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; }
4701
4808
 
4702
4809
  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 +6803,5 @@ function DropArea(_ref) {
6696
6803
  });
6697
6804
  }
6698
6805
 
6699
- 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 };
6806
+ 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 };
6700
6807
  //# sourceMappingURL=index.es.js.map