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

package/dist/index.js

@@ -1634,7 +1634,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 = react.useState(false),
       _useState2 = _slicedToArray__default["default"](_useState, 2),
@@ -1652,6 +1654,11 @@ var useAddMetadataFieldAttributes = function useAddMetadataFieldAttributes(_ref5
       setGroupsWithAttributes = _useState6[1];
 
   useDeepCompareEffect__default["default"](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] : {};
@@ -1703,8 +1710,6 @@ var useAddMetadataFieldAttributes = function useAddMetadataFieldAttributes(_ref5
       });
     };
 
-    var didCancel = false;
-
     function fetchAttributesAsync() {
       return _fetchAttributesAsync.apply(this, arguments);
     }
@@ -1883,7 +1888,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,
@@ -3909,7 +3914,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(vdtApi.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__default["default"](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(vdtApi.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__default["default"](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; }
 
@@ -3917,6 +3988,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,
@@ -3926,8 +3998,13 @@ function MetadataType(_ref) {
       children = _ref.children,
       props = _objectWithoutProperties__default["default"](_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 = react.useMemo(function () {
     return vdtJs.parseMetadataType(metadataType, {
       joinValue: joinValue,
@@ -4546,32 +4623,26 @@ var ErrorBoundary = /*#__PURE__*/function (_Component) {
   return ErrorBoundary;
 }(react.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(vdtApi.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;
 
-  react.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
@@ -4718,6 +4789,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__*/react.cloneElement(child, cloneProps);
+  };
+
+  return react.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__default["default"](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; }
@@ -6726,6 +6833,7 @@ exports.ComposeProviders = ComposeProviders;
 exports.DropArea = DropArea;
 exports.ErrorBoundary = ErrorBoundary;
 exports.GetCollection = GetCollectionContent;
+exports.GetEntityMetadata = GetEntityMetadata;
 exports.GetFieldGroup = GetFieldGroup;
 exports.GetItem = GetItem;
 exports.GetJobs = GetJobs;
@@ -6754,6 +6862,8 @@ exports.useEntityAccess = useEntityAccess;
 exports.useGetCollection = useGetCollection$1;
 exports.useGetCollectionItem = useGetCollection;
 exports.useGetEntity = useGetEntity;
+exports.useGetEntityMetadata = useGetEntityMetadata;
+exports.useGetFieldGroup = useGetFieldGroup;
 exports.useGetFieldMetadataDataset = useGetFieldMetadataDataset;
 exports.useGetItem = useGetItem;
 exports.useGetSavedSearchFolders = useGetSavedSearchFolders;