@scaleflex/widget-explorer 4.4.0 → 4.5.1

package/lib/hooks/useStartUpload.js

@@ -0,0 +1,43 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { useDispatch, useSelector } from 'react-redux';
+import { useCore, usePlugin } from '@scaleflex/widget-core/lib/hooks';
+import { PLUGINS_IDS } from '@scaleflex/widget-utils/lib/constants';
+import { selectUploads } from '@scaleflex/widget-core/lib/slices/uploads.slice';
+import { useLocateFile } from '.';
+import { addUploadActivity } from '../thunks/uploads.thunks';
+var useStartUpload = function useStartUpload() {
+  var dispatch = useDispatch();
+  var _useCore = useCore(),
+    upload = _useCore.upload;
+  var progressPanelInstance = usePlugin(PLUGINS_IDS.PROGRESS_PANEL);
+  var locateFile = useLocateFile();
+  var currentUploads = useSelector(selectUploads);
+  var onUpload = function onUpload(files, uploadActivityOptions) {
+    if (progressPanelInstance) {
+      Object.keys(files).forEach(function (fileId) {
+        var file = _objectSpread({}, files[fileId]);
+        dispatch(addUploadActivity(_objectSpread({
+          file: file,
+          locateFile: locateFile
+        }, uploadActivityOptions)));
+      });
+    }
+  };
+  var startUpload = function startUpload() {
+    var uploadsObjToUpload = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : currentUploads;
+    var uploadActivityOptions = arguments.length > 1 ? arguments[1] : undefined;
+    var onUploadFn = function onUploadFn(files) {
+      return onUpload(files, uploadActivityOptions);
+    };
+    return upload(uploadsObjToUpload, onUploadFn)["catch"](function () {
+      // Error logged in Core
+    });
+  };
+  return startUpload;
+};
+export default useStartUpload;

package/lib/hooks/useToLocaleNumber.js

@@ -0,0 +1,14 @@
+import { useCallback } from 'react';
+import { convertToLocaleNumber } from '@scaleflex/widget-utils/lib/formatNumbers';
+import useExplorer from '@scaleflex/widget-explorer/lib/hooks/useExplorer';
+var useToLocaleNumber = function useToLocaleNumber(defaultLocale) {
+  var _ref = useExplorer().opts || {},
+    _ref$config = _ref.config,
+    _ref$config2 = _ref$config === void 0 ? {} : _ref$config,
+    _ref$config2$numberFo = _ref$config2.numberFormatLocale,
+    numberFormatLocale = _ref$config2$numberFo === void 0 ? defaultLocale : _ref$config2$numberFo;
+  return useCallback(function (number) {
+    return convertToLocaleNumber(number, numberFormatLocale);
+  }, [numberFormatLocale]);
+};
+export default useToLocaleNumber;

package/lib/hooks/useValidateFileName.js

@@ -0,0 +1,324 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { useCallback } from 'react';
+import { Warning } from '@scaleflex/icons';
+import { PC } from '@scaleflex/widget-common';
+import { useModal } from '@scaleflex/widget-core/lib/hooks';
+import { useTheme } from '@scaleflex/ui/theme/hooks';
+import { FILE_EXTENSION_REGEX } from '@scaleflex/widget-utils/lib/constants';
+import useExplorer from './useExplorer';
+import { checkFileOrFolderNameValidation } from '@scaleflex/widget-utils/lib/checkFileOrFolderNameValidation';
+import { jsx as _jsx } from "react/jsx-runtime";
+var getExtension = function getExtension(fileName) {
+  var _match;
+  return (_match = (fileName || '').match(FILE_EXTENSION_REGEX)) === null || _match === void 0 ? void 0 : _match[1];
+};
+var hasExtension = function hasExtension(fileName) {
+  return Boolean(getExtension(fileName));
+};
+var CHECK_FILE_RENAME_VALIDATION_ERROR = {
+  ERROR: 'ERROR',
+  EMPTY_NAME: 'EMPTY_NAME',
+  INVALID_NAME: 'INVALID_NAME',
+  EMPTY_EXTENSION: 'EMPTY_EXTENSION',
+  CHANGE_EXTENSION: 'CHANGE_EXTENSION'
+};
+var handleError = function handleError(_ref) {
+  var _ref$errorCode = _ref.errorCode,
+    errorCode = _ref$errorCode === void 0 ? CHECK_FILE_RENAME_VALIDATION_ERROR.ERROR : _ref$errorCode,
+    _ref$errorTitleI18nKe = _ref.errorTitleI18nKey,
+    errorTitleI18nKey = _ref$errorTitleI18nKe === void 0 ? '' : _ref$errorTitleI18nKe,
+    _ref$errorDescI18nKey = _ref.errorDescI18nKey,
+    errorDescI18nKey = _ref$errorDescI18nKey === void 0 ? '' : _ref$errorDescI18nKey,
+    _ref$details = _ref.details,
+    details = _ref$details === void 0 ? {} : _ref$details;
+  return {
+    valid: false,
+    errorCode: errorCode,
+    errorTitleI18nKey: errorTitleI18nKey,
+    errorDescI18nKey: errorDescI18nKey,
+    details: details
+  };
+};
+
+/**
+ * Validate file name changes, to be able to control extension remove/update.
+ * Details: T7195 https://sfx.li/IFr4y01tgqL1wg
+ *
+ * @param {string} oldName - Old file name that should be changed
+ * @param {strign} newName - New file name
+ * @param {object} [opts] - Options object
+ * @param {boolean} [opts.ignoreChangedNameExtension=false] - If TRUE, fn will ignore extension updates
+ *
+ * @returns {object} - Object with validation details
+ */
+var checkFileRenameValidation = function checkFileRenameValidation(oldName, newName) {
+  var _ref2 = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {},
+    _ref2$ignoreChangedNa = _ref2.ignoreChangedNameExtension,
+    ignoreChangedNameExtension = _ref2$ignoreChangedNa === void 0 ? false : _ref2$ignoreChangedNa;
+  // Check extensions
+  if (hasExtension(oldName)) {
+    // If old name doesn't have extension next logic is useless
+    var oldExtension = getExtension(oldName);
+    var newExtension = getExtension(newName);
+    if (!newExtension) {
+      return handleError({
+        errorCode: CHECK_FILE_RENAME_VALIDATION_ERROR.EMPTY_EXTENSION,
+        errorTitleI18nKey: 'explorerEmptyFileExtensionValidation',
+        errorDescI18nKey: 'explorerEmptyFileExtensionDescValidation',
+        details: {
+          oldExtension: oldExtension,
+          newExtension: newExtension
+        }
+      });
+    }
+    if (oldExtension !== newExtension && !ignoreChangedNameExtension) {
+      return handleError({
+        errorCode: CHECK_FILE_RENAME_VALIDATION_ERROR.CHANGE_EXTENSION,
+        errorTitleI18nKey: 'explorerChangeFileExtensionTitleConfirmation',
+        errorDescI18nKey: 'explorerChangeFileNameValidation',
+        details: {
+          oldExtension: oldExtension,
+          newExtension: newExtension
+        }
+      });
+    }
+    if (checkFileOrFolderNameValidation(newName)) {
+      return handleError({
+        errorCode: CHECK_FILE_RENAME_VALIDATION_ERROR.INVALID_NAME,
+        errorTitleI18nKey: 'explorerFileRenameInvalidNameTitle',
+        errorDescI18nKey: 'explorerFileRenameInvalidNameDesc'
+      });
+    }
+  }
+  return {
+    valid: true
+  };
+};
+
+/**
+ * @param {string} name - file name
+ *
+ * @returns {object} - Object with validation details
+ */
+var checkFileNameValidation = function checkFileNameValidation(name) {
+  if (checkFileOrFolderNameValidation(name)) {
+    return handleError({
+      errorCode: CHECK_FILE_RENAME_VALIDATION_ERROR.INVALID_NAME,
+      errorTitleI18nKey: 'explorerFileRenameInvalidNameTitle',
+      errorDescI18nKey: 'explorerFileNameInvalidNameDesc'
+    });
+  }
+  return {
+    valid: true
+  };
+};
+
+/**
+ * Change file name extension.
+ *
+ * @param {string} fileName - File name with extension that should be changed
+ * @param {string} nextExtension - Extension without dot. For example: 'jpg'
+ * @param {string} [prevExtension] - Extension without dot. For example: 'jpg'
+ *
+ * @returns {string} - File name with updated extension. For example: changeFileNameExtension('file-name.jpg', 'jpg', 'gif') will return file-name.gif
+ */
+var changeFileNameExtension = function changeFileNameExtension(fileName, nextExtension) {
+  var prevExtension = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+  if (fileName && nextExtension) {
+    var replaceExt = function replaceExt(prev, next) {
+      var regexp = new RegExp(".".concat(prev, "$"));
+      if (regexp.test(fileName)) {
+        return fileName.replace(new RegExp(".".concat(prev, "$")), ".".concat(next));
+      }
+      return fileName;
+    };
+    if (prevExtension) {
+      return replaceExt(prevExtension, nextExtension);
+    }
+    var currentExtension = getExtension(fileName);
+    if (currentExtension) {
+      // fileName has extension
+      return replaceExt(currentExtension, nextExtension);
+    }
+    return "".concat(fileName, ".").concat(nextExtension);
+  }
+  return fileName;
+};
+var toggleValidationModal = function toggleValidationModal(_ref3) {
+  var toggleModal = _ref3.toggleModal,
+    title = _ref3.title,
+    theme = _ref3.theme,
+    content = _ref3.content,
+    buttonPrimaryLabel = _ref3.buttonPrimaryLabel,
+    onButtonPrimaryClick = _ref3.onButtonPrimaryClick,
+    onButtonSecondaryClick = _ref3.onButtonSecondaryClick,
+    onCancel = _ref3.onCancel,
+    _ref3$toggleModalProp = _ref3.toggleModalProps,
+    toggleModalProps = _ref3$toggleModalProp === void 0 ? {} : _ref3$toggleModalProp;
+  toggleModal(_objectSpread({
+    icon: /*#__PURE__*/_jsx(Warning, {
+      color: theme.palette[PC.Warning],
+      size: 29
+    }),
+    title: title,
+    enterKeySubmits: true,
+    disableAutoClose: true,
+    modalIconStyle: {
+      backgroundColor: theme.palette[PC.Orange_0_1_Overlay]
+    },
+    modalStyle: {
+      width: 450,
+      maxWidth: 'none'
+    },
+    modalBodyStyle: {
+      textAlign: 'center',
+      padding: '12px 32px'
+    },
+    modalFooterStyle: {
+      flexDirection: 'row',
+      padding: '12px 32px 32px 32px'
+    },
+    primaryTitleStyle: {
+      textAlign: 'center'
+    },
+    modalSecondaryButtonColor: 'basic',
+    warningPrimaryButton: true,
+    content: content,
+    contentStyle: {
+      textAlign: 'center'
+    },
+    modalPrimaryButton: {
+      width: 187
+    },
+    modalSecondaryButton: {
+      width: 187
+    },
+    buttonPrimaryLabel: buttonPrimaryLabel,
+    inlineActionButtons: true,
+    onCancel: onCancel,
+    onButtonPrimaryClick: onButtonPrimaryClick,
+    onButtonSecondaryClick: onButtonSecondaryClick
+  }, toggleModalProps));
+};
+var useValidateFileName = function useValidateFileName() {
+  var returnValidityOnly = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+  var _useExplorer = useExplorer(),
+    i18n = _useExplorer.i18n;
+  var toggleModal = useModal();
+  var theme = useTheme();
+  var handleCancellation = function handleCancellation() {
+    return toggleModal(null);
+  };
+  var handleItemRenamingValidation = useCallback(function (oldName, newName, options) {
+    var _ref4 = options || {},
+      onChangeExtension = _ref4.onChangeExtension,
+      onKeepOldExtension = _ref4.onKeepOldExtension,
+      _ref4$ignoreChangedNa = _ref4.ignoreChangedNameExtension,
+      ignoreChangedNameExtension = _ref4$ignoreChangedNa === void 0 ? false : _ref4$ignoreChangedNa;
+    var renameValidation = checkFileRenameValidation(oldName, newName, {
+      ignoreChangedNameExtension: ignoreChangedNameExtension
+    });
+    var valid = renameValidation.valid,
+      errorTitleI18nKey = renameValidation.errorTitleI18nKey,
+      errorCode = renameValidation.errorCode,
+      errorDescI18nKey = renameValidation.errorDescI18nKey,
+      details = renameValidation.details;
+    if (!valid) {
+      var title = i18n(errorTitleI18nKey);
+      var toggleModalProps = {};
+      var handleKeepOldExtension = function handleKeepOldExtension() {
+        if (typeof onKeepOldExtension === 'function') {
+          var newNameWithOldExtension = changeFileNameExtension(newName, details === null || details === void 0 ? void 0 : details.oldExtension, details === null || details === void 0 ? void 0 : details.newExtension);
+          onKeepOldExtension(newNameWithOldExtension, handleCancellation, renameValidation);
+        }
+      };
+      if (errorCode === CHECK_FILE_RENAME_VALIDATION_ERROR.CHANGE_EXTENSION) {
+        title = i18n(errorTitleI18nKey, {
+          old_extension: details === null || details === void 0 ? void 0 : details.oldExtension,
+          new_extension: details === null || details === void 0 ? void 0 : details.newExtension
+        });
+        toggleModalProps = {
+          buttonSecondaryLabel: i18n('mutualizedCancelButtonLabel'),
+          onButtonPrimaryClick: function onButtonPrimaryClick() {
+            if (typeof onChangeExtension === 'function') {
+              onChangeExtension(handleCancellation, renameValidation);
+            }
+          }
+        };
+      }
+      if (errorCode === CHECK_FILE_RENAME_VALIDATION_ERROR.EMPTY_EXTENSION) {
+        toggleModalProps = {
+          buttonPrimaryLabel: i18n('explorerModelOkButton'),
+          onButtonPrimaryClick: handleKeepOldExtension,
+          hideSecondaryButton: true
+        };
+      }
+      if (errorCode === CHECK_FILE_RENAME_VALIDATION_ERROR.INVALID_NAME) {
+        if (returnValidityOnly) {
+          return {
+            valid: false
+          };
+        }
+        toggleModalProps = {
+          buttonPrimaryLabel: i18n('explorerModelOkButton'),
+          onButtonPrimaryClick: handleCancellation,
+          onCancel: handleCancellation,
+          hideSecondaryButton: true
+        };
+      }
+      // TODO: Convert the file name to .js after finding a solution for handling jsx codes in .js files from vite.
+      toggleValidationModal({
+        toggleModal: toggleModal,
+        title: title,
+        theme: theme,
+        content: i18n(errorDescI18nKey),
+        onCancel: handleKeepOldExtension,
+        onButtonPrimaryClick: handleKeepOldExtension,
+        onButtonSecondaryClick: handleKeepOldExtension,
+        toggleModalProps: toggleModalProps
+      });
+    }
+    return renameValidation;
+  }, [i18n, theme, toggleModal]);
+  var handleItemNamingValidation = useCallback(function (name, options) {
+    var _ref5 = options || {},
+      triggerRename = _ref5.triggerRename;
+    var nameValidation = checkFileNameValidation(name);
+    var _ref6 = nameValidation || {},
+      valid = _ref6.valid,
+      errorTitleI18nKey = _ref6.errorTitleI18nKey,
+      errorCode = _ref6.errorCode,
+      errorDescI18nKey = _ref6.errorDescI18nKey;
+    if (!valid) {
+      var title = i18n(errorTitleI18nKey);
+      if (errorCode === CHECK_FILE_RENAME_VALIDATION_ERROR.INVALID_NAME) {
+        toggleValidationModal({
+          toggleModal: toggleModal,
+          title: title,
+          theme: theme,
+          content: i18n(errorDescI18nKey, {
+            name: name
+          }),
+          buttonPrimaryLabel: i18n('mutualizedRenameButtonLabel'),
+          onButtonPrimaryClick: function onButtonPrimaryClick() {
+            handleCancellation();
+            triggerRename();
+          },
+          onCancel: handleCancellation,
+          hideSecondaryButton: true
+        });
+      }
+    }
+    return nameValidation;
+  }, [i18n, theme, toggleModal]);
+  return {
+    handleItemRenamingValidation: handleItemRenamingValidation,
+    handleItemNamingValidation: handleItemNamingValidation
+  };
+};
+export default useValidateFileName;