@pingux/astro 1.0.0-alpha.4 → 1.0.0-alpha.5

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [1.0.0-alpha.5](https://gitlab.corp.pingidentity.com/ux/pingux/compare/@pingux/astro@1.0.0-alpha.4...@pingux/astro@1.0.0-alpha.5) (2021-12-29)
+
+
+### Features
+
+* [UIP-4918] Add File Input ([5987d40](https://gitlab.corp.pingidentity.com/ux/pingux/commit/5987d4064f8a2a54d3e81037acba17c299bea2b0))
+
+
+
+
+
 # [1.0.0-alpha.4](https://gitlab.corp.pingidentity.com/ux/pingux/compare/@pingux/astro@1.0.0-alpha.3...@pingux/astro@1.0.0-alpha.4) (2021-12-20)
 
 **Note:** Version bump only for package @pingux/astro

package/lib/cjs/components/FileInputField/FileInputField.js

@@ -0,0 +1,324 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard");
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _Object$defineProperty2 = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+_Object$defineProperty2(exports, "__esModule", {
+  value: true
+});
+
+exports["default"] = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/define-property"));
+
+var _defineProperties = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/define-properties"));
+
+var _getOwnPropertyDescriptors = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors"));
+
+var _forEach = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/for-each"));
+
+var _getOwnPropertyDescriptor = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor"));
+
+var _getOwnPropertySymbols = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols"));
+
+var _keys = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/keys"));
+
+var _values = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/values"));
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/extends"));
+
+var _filter = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/filter"));
+
+var _concat = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/concat"));
+
+var _url = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/url"));
+
+var _map = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/map"));
+
+var _slice = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/slice"));
+
+var _from = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/array/from"));
+
+var _defineProperty3 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/slicedToArray"));
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/objectWithoutProperties"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _visuallyHidden = require("@react-aria/visually-hidden");
+
+var _reactDropzone = require("react-dropzone");
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _utils = require("@react-aria/utils");
+
+var _uuid = require("uuid");
+
+var _index = require("../../index");
+
+var _FileItem = _interopRequireDefault(require("./FileItem"));
+
+var _FileSelect = _interopRequireDefault(require("./FileSelect"));
+
+var _useStatusClasses3 = _interopRequireDefault(require("../../hooks/useStatusClasses"));
+
+var _useField2 = _interopRequireDefault(require("../../hooks/useField"));
+
+var _statuses = _interopRequireDefault(require("../../utils/devUtils/constants/statuses"));
+
+var _react2 = require("@emotion/react");
+
+function ownKeys(object, enumerableOnly) { var keys = (0, _keys["default"])(object); if (_getOwnPropertySymbols["default"]) { var symbols = (0, _getOwnPropertySymbols["default"])(object); if (enumerableOnly) symbols = (0, _filter["default"])(symbols).call(symbols, function (sym) { return (0, _getOwnPropertyDescriptor["default"])(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { var _context2; (0, _forEach["default"])(_context2 = ownKeys(Object(source), true)).call(_context2, function (key) { (0, _defineProperty3["default"])(target, key, source[key]); }); } else if (_getOwnPropertyDescriptors["default"]) { (0, _defineProperties["default"])(target, (0, _getOwnPropertyDescriptors["default"])(source)); } else { var _context3; (0, _forEach["default"])(_context3 = ownKeys(Object(source))).call(_context3, function (key) { (0, _defineProperty2["default"])(target, key, (0, _getOwnPropertyDescriptor["default"])(source, key)); }); } } return target; }
+
+/**
+ * The FileInputField component allows users to upload one or more files by
+ * clicking the button or via drag and drop.
+ *
+ * We utilize [react-dropzone](https://react-dropzone.js.org/) for the drag and drop functionality.
+ * */
+var FileInputField = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
+  var defaultButtonText = props.defaultButtonText,
+      defaultFileList = props.defaultFileList,
+      uploadedFilesImperative = props.fileList,
+      helperText = props.helperText,
+      isDisabled = props.isDisabled,
+      isLoading = props.isLoading,
+      isMultiple = props.isMultiple,
+      onFileSelect = props.onFileSelect,
+      onRemove = props.onRemove,
+      status = props.status,
+      textProps = props.textProps,
+      others = (0, _objectWithoutProperties2["default"])(props, ["defaultButtonText", "defaultFileList", "fileList", "helperText", "isDisabled", "isLoading", "isMultiple", "onFileSelect", "onRemove", "status", "textProps"]);
+
+  var _useState = (0, _react.useState)(defaultFileList || []),
+      _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
+      uploadedFiles = _useState2[0],
+      setUploadedFiles = _useState2[1];
+
+  var inputRef = (0, _react.useRef)();
+  /* istanbul ignore next */
+
+  (0, _react.useImperativeHandle)(ref, function () {
+    return inputRef.current;
+  });
+
+  var _useField = (0, _useField2["default"])(_objectSpread({
+    status: status,
+    isDisabled: isDisabled
+  }, others)),
+      fieldContainerProps = _useField.fieldContainerProps,
+      fieldControlProps = _useField.fieldControlProps,
+      fieldLabelProps = _useField.fieldLabelProps;
+
+  var _useVisuallyHidden = (0, _visuallyHidden.useVisuallyHidden)(),
+      visuallyHiddenProps = _useVisuallyHidden.visuallyHiddenProps;
+
+  var handleFileSelect = (0, _react.useCallback)(function () {
+    inputRef.current.value = null;
+    inputRef.current.click();
+  }, [inputRef]);
+  var handleFileUpload = (0, _react.useCallback)(function (event, newFiles) {
+    if (onFileSelect) {
+      onFileSelect(event, newFiles);
+    }
+
+    var arrayWithNewFiles = (0, _from["default"])(newFiles);
+
+    if (!isMultiple) {
+      arrayWithNewFiles = (0, _slice["default"])(arrayWithNewFiles).call(arrayWithNewFiles, 0, 1);
+    }
+
+    var newFilesWithIdAndLink = (0, _map["default"])(arrayWithNewFiles).call(arrayWithNewFiles, function (newFile) {
+      return {
+        fileObj: newFile,
+        name: newFile.name,
+        id: (0, _uuid.v4)(),
+        downloadLink: _url["default"].createObjectURL(newFile),
+        status: _statuses["default"].DEFAULT
+      };
+    });
+
+    if (isMultiple) {
+      setUploadedFiles(function (prevFiles) {
+        var _context;
+
+        return (0, _concat["default"])(_context = []).call(_context, prevFiles, newFilesWithIdAndLink);
+      });
+    } else {
+      setUploadedFiles(newFilesWithIdAndLink);
+    }
+  }, [isMultiple, onFileSelect]);
+  var onDrop = (0, _react.useCallback)(function (acceptedFiles, fileRejections, event) {
+    handleFileUpload(event, acceptedFiles);
+  }, [handleFileUpload]);
+
+  var _useDropzone = (0, _reactDropzone.useDropzone)({
+    onDrop: onDrop,
+    noKeyboard: true,
+    disabled: isDisabled || isLoading
+  }),
+      getRootProps = _useDropzone.getRootProps,
+      getInputProps = _useDropzone.getInputProps,
+      isDragActive = _useDropzone.isDragActive;
+
+  var handleOnChange = (0, _react.useCallback)(function (event) {
+    handleFileUpload(event, event.target.files);
+  }, [handleFileUpload]);
+  var handleFileDelete = (0, _react.useCallback)(function (e, fileId) {
+    if (onRemove) {
+      onRemove(e, fileId);
+    }
+
+    setUploadedFiles(function (prevFiles) {
+      return (0, _filter["default"])(prevFiles).call(prevFiles, function (_ref) {
+        var id = _ref.id;
+        return id !== fileId;
+      });
+    });
+  }, [onRemove]);
+  var filesListNode = (0, _react.useMemo)(function () {
+    var filesToRender = uploadedFilesImperative || uploadedFiles;
+
+    if (!(filesToRender === null || filesToRender === void 0 ? void 0 : filesToRender.length)) {
+      return null;
+    }
+
+    return (0, _map["default"])(filesToRender).call(filesToRender, function (fileProps) {
+      return (0, _react2.jsx)(_FileItem["default"], (0, _extends2["default"])({
+        handleFileDelete: handleFileDelete,
+        isDisabled: isDisabled || isLoading,
+        key: fileProps.id,
+        textProps: textProps
+      }, fileProps));
+    });
+  }, [uploadedFilesImperative, uploadedFiles, handleFileDelete, isDisabled, isLoading, textProps]);
+
+  var _useStatusClasses = (0, _useStatusClasses3["default"])('fileInputFieldWrapper', (0, _defineProperty3["default"])({
+    isDragActive: isDragActive,
+    isLoading: isLoading
+  }, "is-".concat(status), true)),
+      classNames = _useStatusClasses.classNames;
+
+  var shouldFileSelectRender = (0, _react.useCallback)(function () {
+    var isFileUploaded;
+
+    if (uploadedFilesImperative) {
+      isFileUploaded = Boolean(uploadedFilesImperative === null || uploadedFilesImperative === void 0 ? void 0 : uploadedFilesImperative.length);
+    } else {
+      isFileUploaded = Boolean(uploadedFiles === null || uploadedFiles === void 0 ? void 0 : uploadedFiles.length);
+    }
+
+    return isMultiple || !isFileUploaded;
+  }, [uploadedFiles, uploadedFilesImperative, isMultiple]);
+  return (0, _react2.jsx)(_react["default"].Fragment, null, (0, _react2.jsx)(_index.Label, fieldLabelProps), (0, _react2.jsx)(_index.Box, (0, _extends2["default"])({
+    variant: "boxes.fileInputFieldWrapper"
+  }, (0, _utils.mergeProps)(fieldContainerProps, others), {
+    className: classNames
+  }, getRootProps()), (0, _react2.jsx)(_index.Input, (0, _extends2["default"])({}, (0, _utils.mergeProps)(visuallyHiddenProps, fieldControlProps, getInputProps()), {
+    "aria-label": "File Input",
+    multiple: isMultiple,
+    onChange: handleOnChange,
+    ref: inputRef,
+    type: "file"
+  })), filesListNode, shouldFileSelectRender() && (0, _react2.jsx)(_FileSelect["default"], {
+    buttonText: defaultButtonText,
+    handleFileSelect: handleFileSelect,
+    isDisabled: isDisabled || isLoading,
+    textProps: textProps
+  }), isLoading && (0, _react2.jsx)(_index.Loader, {
+    color: "active",
+    sx: {
+      position: 'absolute'
+    },
+    "data-testid": "file-input-field__loader"
+  })), helperText && (0, _react2.jsx)(_index.FieldHelperText, {
+    status: status
+  }, helperText));
+});
+FileInputField.displayName = 'FileInputField';
+FileInputField.propTypes = {
+  /** The rendered label for the field. */
+  label: _propTypes["default"].node,
+
+  /** Text rendered below the input. */
+  helperText: _propTypes["default"].node,
+
+  /** Determines the component border status color indicator and helper text styling. */
+  status: _propTypes["default"].oneOf((0, _values["default"])(_statuses["default"])),
+
+  /** Default button text that will be changed on the file name once file is uploaded */
+  defaultButtonText: _propTypes["default"].string,
+
+  /** Defines whether input can accept multiple files or not */
+  isMultiple: _propTypes["default"].bool,
+
+  /** Determines whether the loading indicator is shown. */
+  isLoading: _propTypes["default"].bool,
+
+  /** Whether the field is disabled. */
+  isDisabled: _propTypes["default"].bool,
+
+  /** Array of objects for uploaded files.
+   * Objects should have the following structure:
+   *
+   * {
+   *
+   *  fileObj: File object (optional),
+   *
+   *  id: file id (required - will be returned on delete),
+   *
+   *  name: file name that will be displayed (required - will be displayed),
+   *
+   *  downloadLink: link for the file download (optional),
+   *
+   *  status: file status (if error - icon of the
+   *  component will be red icon and warning sign)(optional),
+   *
+   * }
+   * */
+  fileList: _propTypes["default"].arrayOf(_propTypes["default"].shape({
+    fileObj: _propTypes["default"].shape({}),
+    id: _propTypes["default"].string.required,
+    name: _propTypes["default"].string.required,
+    downloadLink: _propTypes["default"].string,
+    status: _propTypes["default"].oneOf((0, _values["default"])(_statuses["default"]))
+  })),
+
+  /** Default array of objects for uploaded files. */
+  defaultFileList: _propTypes["default"].arrayOf(_propTypes["default"].shape({
+    fileObj: _propTypes["default"].shape({}),
+    id: _propTypes["default"].string.required,
+    name: _propTypes["default"].string.required,
+    downloadLink: _propTypes["default"].string,
+    status: _propTypes["default"].oneOf((0, _values["default"])(_statuses["default"]))
+  })),
+
+  /** The handler that is called when the input files is uploaded.
+   *
+   * `(event, files) => void`
+   * */
+  onFileSelect: _propTypes["default"].func,
+
+  /** The handler that is called when an uploaded file got removed.
+   *
+   * `(fileId) => void`
+   * */
+  onRemove: _propTypes["default"].func,
+
+  /** These props will be spread to the field text component. */
+  textProps: _propTypes["default"].shape({})
+};
+FileInputField.defaultProps = {
+  defaultButtonText: 'Select a file',
+  status: _statuses["default"].DEFAULT
+};
+var _default = FileInputField;
+exports["default"] = _default;

package/lib/cjs/components/FileInputField/FileInputField.stories.js

@@ -0,0 +1,250 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard");
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+
+var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
+
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+
+exports.WithCustomWidth = exports.ErrorWithMultipleFiles = exports.ErrorStatusSingleFile = exports.DefaultFileListUncontrolled = exports.ControlledState = exports.CustomButtonText = exports.Default = exports["default"] = void 0;
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/slicedToArray"));
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/extends"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _uuid = require("uuid");
+
+var _ = _interopRequireDefault(require("./"));
+
+var _index = require("../../index");
+
+var _statuses = _interopRequireDefault(require("../../utils/devUtils/constants/statuses"));
+
+var _react2 = require("@emotion/react");
+
+var _default = {
+  title: 'Form/FileInputField',
+  component: _["default"],
+  parameters: {
+    docs: {
+      source: {
+        type: 'code'
+      }
+    }
+  },
+  argTypes: {
+    label: {
+      control: {
+        type: 'text'
+      },
+      defaultValue: 'Field Label'
+    },
+    helperText: {
+      control: {
+        type: 'text'
+      }
+    },
+    status: {
+      control: {
+        type: 'select',
+        options: _statuses["default"]
+      },
+      defaultValue: _statuses["default"].DEFAULT
+    },
+    defaultButtonText: {
+      control: {
+        type: 'text'
+      }
+    },
+    isMultiple: {
+      control: {
+        type: 'boolean'
+      }
+    },
+    isLoading: {
+      control: {
+        type: 'boolean'
+      }
+    },
+    isDisabled: {
+      control: {
+        type: 'boolean'
+      }
+    },
+    fileList: {
+      control: {
+        type: 'none'
+      }
+    },
+    defaultFileList: {
+      control: {
+        type: 'none'
+      }
+    },
+    textProps: {
+      control: {
+        type: 'none'
+      }
+    }
+  }
+};
+exports["default"] = _default;
+var fitContentWidthSx = {
+  width: 'fit-content'
+};
+
+var Default = function Default(args) {
+  return (0, _react2.jsx)(_["default"], (0, _extends2["default"])({
+    sx: fitContentWidthSx
+  }, args));
+};
+
+exports.Default = Default;
+
+var CustomButtonText = function CustomButtonText() {
+  return (0, _react2.jsx)(_["default"], {
+    defaultButtonText: "Original Button Name",
+    label: "Custom Button Text",
+    sx: fitContentWidthSx
+  });
+};
+
+exports.CustomButtonText = CustomButtonText;
+
+var ControlledState = function ControlledState() {
+  var _useState = (0, _react.useState)([]),
+      _useState2 = (0, _slicedToArray2["default"])(_useState, 2),
+      userFiles = _useState2[0],
+      setUserFiles = _useState2[1];
+
+  var _useState3 = (0, _react.useState)(),
+      _useState4 = (0, _slicedToArray2["default"])(_useState3, 2),
+      error = _useState4[0],
+      setError = _useState4[1];
+
+  var handleFileSelect = function handleFileSelect(event, files) {
+    // this is approximate conversion just for an example
+    var uploadedFileSizeMb = files[0].size / 1e6;
+
+    if (uploadedFileSizeMb > 2) {
+      setError('Only files under 2 MB can be uploaded.');
+    } else {
+      setUserFiles([{
+        id: (0, _uuid.v4)(),
+        name: files[0].name,
+        downloadLink: 'link for testing purposes'
+      }]);
+      setError(null);
+    }
+  }; // you would want to handle this differently in case you have multiple files
+
+
+  var handleFileRemove = function handleFileRemove() {
+    setUserFiles([]);
+    setError(null);
+  };
+
+  return (0, _react2.jsx)(_["default"], {
+    label: "Controlled State With limit on file size upload below 2 mb",
+    onFileSelect: handleFileSelect,
+    onRemove: handleFileRemove,
+    fileList: userFiles,
+    sx: fitContentWidthSx,
+    status: error && _statuses["default"].ERROR,
+    helperText: error
+  });
+};
+
+exports.ControlledState = ControlledState;
+
+var DefaultFileListUncontrolled = function DefaultFileListUncontrolled() {
+  return (0, _react2.jsx)(_["default"], {
+    defaultFileList: [{
+      id: 'test-id1',
+      name: 'PingId Mobile (Android)',
+      downloadLink: 'https://download.pingidentity.com/public/PingID/android/PingID.apk'
+    }, {
+      id: 'test-id2',
+      name: 'PingId Desktop (macOS)',
+      downloadLink: 'https://downloads.pingidentity.com/pingid/mac-client/PingID.pkg'
+    }, {
+      id: 'test-id3',
+      name: 'PingId Desktop (Windows)',
+      downloadLink: 'https://download.pingidentity.com/public/PingID/PingID_1.7.2.zip'
+    }],
+    isMultiple: true,
+    label: "Uncontrolled File List with default files",
+    sx: fitContentWidthSx
+  });
+};
+
+exports.DefaultFileListUncontrolled = DefaultFileListUncontrolled;
+
+var ErrorStatusSingleFile = function ErrorStatusSingleFile() {
+  return (0, _react2.jsx)(_["default"], {
+    defaultFileList: [{
+      id: 'test-id3',
+      name: 'PingId Desktop (Windows)',
+      downloadLink: 'https://download.pingidentity.com/public/PingID/PingID_1.7.2.zip',
+      status: _statuses["default"].ERROR
+    }],
+    label: "Error Status Single File",
+    sx: fitContentWidthSx,
+    helperText: "There is an error",
+    status: _statuses["default"].ERROR
+  });
+};
+
+exports.ErrorStatusSingleFile = ErrorStatusSingleFile;
+
+var ErrorWithMultipleFiles = function ErrorWithMultipleFiles() {
+  return (0, _react2.jsx)(_["default"], {
+    defaultFileList: [{
+      id: 'test-id3',
+      name: 'PingId Desktop (Windows)',
+      downloadLink: 'https://download.pingidentity.com/public/PingID/PingID_1.7.2.zip',
+      status: _statuses["default"].ERROR
+    }, {
+      id: 'test-id2',
+      name: 'PingId Desktop (macOS)',
+      downloadLink: 'https://downloads.pingidentity.com/pingid/mac-client/PingID.pkg'
+    }],
+    label: "Error Status With Multiple Files but without a red border",
+    sx: fitContentWidthSx,
+    helperText: "There is an error but helperText text will be default since no status passed",
+    isMultiple: true
+  });
+};
+
+exports.ErrorWithMultipleFiles = ErrorWithMultipleFiles;
+
+var WithCustomWidth = function WithCustomWidth() {
+  var textSx = {
+    textOverflow: 'ellipsis',
+    overflow: 'hidden',
+    whiteSpace: 'nowrap'
+  };
+  return (0, _react2.jsx)(_index.Box, {
+    width: 200
+  }, (0, _react2.jsx)(_["default"], {
+    defaultButtonText: "Long Long Button Text With A Lot of Words In It",
+    defaultFileList: [{
+      id: 'test-id1',
+      name: 'Really Long File Name That Cant Fit',
+      downloadLink: 'https://download.pingidentity.com/public/PingID/android/PingID.apk'
+    }],
+    label: "Custom Width",
+    textProps: {
+      sx: textSx
+    },
+    isMultiple: true
+  }));
+};
+
+exports.WithCustomWidth = WithCustomWidth;