cozy-ui 60.4.0 → 60.5.0

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# [60.5.0](https://github.com/cozy/cozy-ui/compare/v60.4.0...v60.5.0) (2022-01-20)
+
+
+### Features
+
+* Add FilePicker component ([288d047](https://github.com/cozy/cozy-ui/commit/288d047))
+* Add filesize package ([9286dcd](https://github.com/cozy/cozy-ui/commit/9286dcd))
+
 # [60.4.0](https://github.com/cozy/cozy-ui/compare/v60.3.0...v60.4.0) (2022-01-20)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-ui",
-  "version": "60.4.0",
+  "version": "60.5.0",
   "description": "Cozy apps UI SDK",
   "main": "./index.js",
   "bin": {
@@ -153,6 +153,7 @@
     "classnames": "^2.2.5",
     "cozy-interapp": "^0.5.4",
     "date-fns": "^1.28.5",
+    "filesize": "8.0.7",
     "hammerjs": "^2.0.8",
     "intersection-observer": "0.11.0",
     "mui-bottom-sheet": "https://github.com/cozy/mui-bottom-sheet.git#v1.0.6",

package/react/FilePicker/FilePickerBody.jsx

@@ -0,0 +1,112 @@
+import React, { useCallback, memo } from 'react'
+import PropTypes from 'prop-types'
+
+import { models, useQuery } from 'cozy-client'
+import List from '../MuiCozyTheme/List'
+import LoadMore from '../LoadMore'
+
+import { buildContentFolderQuery } from './queries'
+import FilePickerBodyItem from './FilePickerBodyItem'
+
+const {
+  file: { isDirectory, isFile }
+} = models
+
+const FilePickerBody = ({
+  navigateTo,
+  folderId,
+  onSelectFileId,
+  filesIdsSelected,
+  fileTypesAccepted,
+  multiple
+}) => {
+  const contentFolderQuery = buildContentFolderQuery(folderId)
+  const { data: contentFolder, hasMore, fetchMore } = useQuery(
+    contentFolderQuery.definition,
+    contentFolderQuery.options
+  )
+
+  const onCheck = useCallback(
+    fileId => {
+      const isChecked = filesIdsSelected.some(
+        fileIdSelected => fileIdSelected === fileId
+      )
+      if (isChecked) {
+        onSelectFileId(
+          filesIdsSelected.filter(fileIdSelected => fileIdSelected !== fileId)
+        )
+      } else onSelectFileId(prev => [...prev, fileId])
+    },
+    [filesIdsSelected, onSelectFileId]
+  )
+
+  // When click on checkbox/radio area...
+  const handleChoiceClick = useCallback(
+    file => () => {
+      if (multiple) onCheck(file._id)
+      else onSelectFileId(file._id)
+    },
+    [multiple, onCheck, onSelectFileId]
+  )
+
+  // ...when click anywhere on the rest of the line
+  const handleListItemClick = useCallback(
+    file => () => {
+      if (isDirectory(file)) {
+        navigateTo(contentFolder.find(f => f._id === file._id))
+      }
+
+      if (isFile(file) && fileTypesAccepted.file) {
+        if (multiple) onCheck(file._id)
+        else onSelectFileId(file._id)
+      }
+    },
+    [
+      contentFolder,
+      fileTypesAccepted.file,
+      multiple,
+      navigateTo,
+      onCheck,
+      onSelectFileId
+    ]
+  )
+
+  return (
+    <List>
+      {contentFolder &&
+        contentFolder.map((file, idx) => {
+          const hasDivider = contentFolder
+            ? idx !== contentFolder.length - 1
+            : false
+
+          return (
+            <FilePickerBodyItem
+              key={file._id}
+              file={file}
+              fileTypesAccepted={fileTypesAccepted}
+              multiple={multiple}
+              handleChoiceClick={handleChoiceClick}
+              handleListItemClick={handleListItemClick}
+              onCheck={onCheck}
+              filesIdsSelected={filesIdsSelected}
+              hasDivider={hasDivider}
+            />
+          )
+        })}
+      {hasMore && <LoadMore label={'loadMore'} fetchMore={fetchMore} />}
+    </List>
+  )
+}
+
+FilePickerBody.propTypes = {
+  onSelectFileId: PropTypes.func.isRequired,
+  filesIdsSelected: PropTypes.arrayOf(PropTypes.string).isRequired,
+  folderId: PropTypes.string.isRequired,
+  navigateTo: PropTypes.func.isRequired,
+  fileTypesAccepted: PropTypes.exact({
+    file: PropTypes.bool,
+    folder: PropTypes.bool
+  })
+}
+
+export default memo(FilePickerBody)

package/react/FilePicker/FilePickerBodyItem.jsx

@@ -0,0 +1,129 @@
+import React, { memo } from 'react'
+import PropTypes from 'prop-types'
+import cx from 'classnames'
+import filesize from 'filesize'
+import { makeStyles } from '@material-ui/core/styles'
+
+import { models } from 'cozy-client'
+
+import ListItem from '../MuiCozyTheme/ListItem'
+import ListItemIcon from '../MuiCozyTheme/ListItemIcon'
+import ListItemText from '../ListItemText'
+import Divider from '../MuiCozyTheme/Divider'
+import Icon from '../Icon'
+import FileTypeText from '../Icons/FileTypeText'
+import FileTypeFolder from '../Icons/FileTypeFolder'
+import Checkbox from '../Checkbox'
+import Radio from '../Radio'
+import { useI18n } from '../I18n'
+
+import styles from './styles.styl'
+
+const {
+  file: { isDirectory, isFile }
+} = models
+
+const useStyles = makeStyles(() => ({
+  verticalDivider: {
+    height: '2rem',
+    display: 'flex',
+    alignSelf: 'auto',
+    alignItems: 'center',
+    marginLeft: '0.5rem'
+  },
+  listItemIcon: {
+    marginLeft: '1rem'
+  }
+}))
+
+const FilePickerBodyItem = ({
+  file,
+  fileTypesAccepted,
+  multiple,
+  handleChoiceClick,
+  handleListItemClick,
+  filesIdsSelected,
+  hasDivider
+}) => {
+  const classes = useStyles()
+  const { f } = useI18n()
+  const hasChoice =
+    (fileTypesAccepted.file && isFile(file)) ||
+    (fileTypesAccepted.folder && isDirectory(file))
+
+  const Input = multiple ? Checkbox : Radio
+
+  const listItemSecondaryContent = isFile(file)
+    ? `${f(file.attributes.updated_at, 'DD MMM YYYY')} - ${filesize(
+        file.attributes.size,
+        { base: 10 }
+      )}`
+    : null
+
+  return (
+    <>
+      <ListItem button className="u-p-0">
+        <div
+          data-testid="listitem-onclick"
+          className={styles['filePickerBreadcrumb-wrapper']}
+          onClick={handleListItemClick(file)}
+        >
+          <ListItemIcon className={classes.listItemIcon}>
+            <Icon
+              icon={isDirectory(file) ? FileTypeFolder : FileTypeText}
+              width="32"
+              height="32"
+            />
+          </ListItemIcon>
+          <ListItemText
+            primary={file.name}
+            secondary={listItemSecondaryContent}
+          />
+        </div>
+        {isDirectory(file) && hasChoice && (
+          <Divider
+            orientation="vertical"
+            flexItem
+            className={classes.verticalDivider}
+          />
+        )}
+        <div
+          data-testid="choice-onclick"
+          className="u-ph-1 u-pv-half u-h-2 u-flex u-flex-items-center"
+          onClick={hasChoice ? handleChoiceClick(file) : undefined}
+        >
+          <Input
+            data-testid={multiple ? 'checkbox-btn' : 'radio-btn'}
+            gutter={false}
+            onChange={() => {
+              // handled by onClick on the container
+            }}
+            checked={filesIdsSelected.includes(file._id)}
+            value={file._id}
+            className={cx('u-p-0', {
+              'u-o-100': hasChoice,
+              'u-o-0': !hasChoice
+            })}
+            disabled={!hasChoice}
+          />
+        </div>
+      </ListItem>
+      {hasDivider && <Divider component="li" />}
+    </>
+  )
+}
+
+FilePickerBodyItem.propTypes = {
+  file: PropTypes.object.isRequired,
+  fileTypesAccepted: PropTypes.exact({
+    file: PropTypes.bool,
+    folder: PropTypes.bool
+  }),
+  multiple: PropTypes.bool,
+  handleChoiceClick: PropTypes.func.isRequired,
+  handleListItemClick: PropTypes.func.isRequired,
+  filesIdsSelected: PropTypes.arrayOf(PropTypes.string).isRequired,
+  hasDivider: PropTypes.bool.isRequired
+}
+
+export default memo(FilePickerBodyItem)

package/react/FilePicker/FilePickerBodyItem.spec.jsx

@@ -0,0 +1,131 @@
+import React from 'react'
+import { render, fireEvent } from '@testing-library/react'
+import filesize from 'filesize'
+
+import DemoProvider from './docs/DemoProvider'
+import FilePickerBodyItem from './FilePickerBodyItem'
+
+const mockFile01 = {
+  _id: '001',
+  type: 'file',
+  name: 'Filename',
+  attributes: { updated_at: '2021-01-01T12:00:00.000000+01:00' }
+}
+const mockFolder01 = {
+  _id: '002',
+  type: 'directory',
+  name: 'Foldername',
+  attributes: { updated_at: '2021-01-01T12:00:00.000000+01:00' }
+}
+
+jest.mock('filesize', () => jest.fn())
+
+describe('FilePickerBodyItem components:', () => {
+  const mockHandleChoiceClick = jest.fn()
+  const mockHandleListItemClick = jest.fn()
+  filesize.mockReturnValue('111Ko')
+
+  const setup = ({
+    file = mockFile01,
+    multiple = false,
+    fileTypesAccepted = { file: true, folder: false }
+  }) => {
+    return render(
+      <DemoProvider>
+        <FilePickerBodyItem
+          file={file}
+          fileTypesAccepted={fileTypesAccepted}
+          multiple={multiple}
+          handleChoiceClick={mockHandleChoiceClick}
+          handleListItemClick={mockHandleListItemClick}
+          filesIdsSelected={[]}
+          hasDivider={false}
+        />
+      </DemoProvider>
+    )
+  }
+
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  it('should be rendered correctly', () => {
+    const { container } = setup({})
+
+    expect(container).toBeDefined()
+  })
+
+  it('should display filename', () => {
+    const { getByText } = setup({})
+
+    expect(getByText('Filename'))
+  })
+
+  it('should display foldername', () => {
+    const { getByText } = setup({ file: mockFolder01 })
+
+    expect(getByText('Foldername'))
+  })
+
+  describe('Functions called', () => {
+    it('should call "handleChoiceClick" function when click on checkbox/radio area', () => {
+      const { getByTestId } = setup({})
+      fireEvent.click(getByTestId('choice-onclick'))
+
+      expect(mockHandleChoiceClick).toHaveBeenCalled()
+    })
+
+    it('should NOT call "handleChoiceClick" function when click on checkbox/radio area, if is Folder & not accepted', () => {
+      const { getByTestId } = setup({ file: mockFolder01 })
+      fireEvent.click(getByTestId('choice-onclick'))
+
+      expect(mockHandleChoiceClick).not.toHaveBeenCalled()
+    })
+    it('should NOT call "handleChoiceClick" function when click on checkbox/radio area, if is File & not accepted', () => {
+      const { getByTestId } = setup({
+        fileTypesAccepted: { file: false, folder: true }
+      })
+      fireEvent.click(getByTestId('choice-onclick'))
+
+      expect(mockHandleChoiceClick).not.toHaveBeenCalled()
+    })
+
+    it('should call "handleListItemClick" function when click on ListItem node', () => {
+      const { getByTestId } = setup({})
+      fireEvent.click(getByTestId('listitem-onclick'))
+
+      expect(mockHandleListItemClick).toHaveBeenCalled()
+    })
+  })
+
+  describe('Attribute "multiple"', () => {
+    it('should radio button exists if "multiple" atribute is False', () => {
+      const { getByTestId } = setup({})
+      const radioBtn = getByTestId('radio-btn')
+      expect(radioBtn).not.toBeNull()
+    })
+
+    it('should checkbox button exists if "multiple" atribute is True', () => {
+      const { getByTestId } = setup({ multiple: true })
+      const checkboxBtn = getByTestId('checkbox-btn')
+      expect(checkboxBtn).not.toBeNull()
+    })
+  })
+
+  describe('Radio/Checkbox button', () => {
+    it('should disable and not display the Radio button if it is a File and is not accepted', () => {
+      const { getByTestId } = setup({
+        fileTypesAccepted: { file: false }
+      })
+      const radioBtn = getByTestId('radio-btn')
+
+      expect(radioBtn.getAttribute('disabled')).toBe('')
+    })
+    it('should disable and not display the Radio button if it is a Folder and is not accepted', () => {
+      const { getByTestId } = setup({ file: mockFolder01 })
+      const radioBtn = getByTestId('radio-btn')
+
+      expect(radioBtn.getAttribute('disabled')).toBe('')
+    })
+  })
+})

package/react/FilePicker/FilePickerBreadcrumb.jsx

@@ -0,0 +1,54 @@
+import React, { Fragment, useCallback, memo } from 'react'
+import PropTypes from 'prop-types'
+
+import Typography from '../Typography'
+import Icon from '../Icon'
+import RightIcon from '../Icons/Right'
+import useBreakpoints from '../hooks/useBreakpoints'
+
+import styles from './styles.styl'
+
+const FilePickerBreadcrumb = ({ path, onBreadcrumbClick }) => {
+  const { isMobile } = useBreakpoints()
+  const hasPath = path && path.length > 0
+
+  const navigateTo = useCallback(folder => () => onBreadcrumbClick(folder), [
+    onBreadcrumbClick
+  ])
+
+  return (
+    <Typography variant="h4" className="u-flex u-flex-items-center">
+      {hasPath
+        ? isMobile
+          ? path[path.length - 1].name
+          : path.map((folder, idx) => {
+              if (idx < path.length - 1) {
+                return (
+                  <Fragment key={idx}>
+                    <span
+                      className={styles['filePickerBreadcrumb-previousPath']}
+                      onClick={navigateTo(folder)}
+                    >
+                      {folder.name}
+                    </span>
+                    <Icon
+                      icon={RightIcon}
+                      className={styles['filePickerBreadcrumb-icon']}
+                    />
+                  </Fragment>
+                )
+              } else {
+                return <span key={idx}>{folder.name}</span>
+              }
+            })
+        : null}
+    </Typography>
+  )
+}
+
+FilePickerBreadcrumb.propTypes = {
+  path: PropTypes.array,
+  onBreadcrumbClick: PropTypes.func
+}
+
+export default memo(FilePickerBreadcrumb)

package/react/FilePicker/FilePickerFooter.jsx

@@ -0,0 +1,40 @@
+import React, { memo } from 'react'
+import PropTypes from 'prop-types'
+
+import Button from '../Button'
+import { createUseI18n } from '../I18n'
+
+import en from './locales/en.json'
+import fr from './locales/fr.json'
+
+const locales = { en, fr }
+const useI18n = createUseI18n(locales)
+
+const FilePickerFooter = ({ onConfirm, onClose, disabledConfirm }) => {
+  const { t } = useI18n()
+
+  return (
+    <>
+      <Button
+        data-testid="close-btn"
+        label={t('footer.buttons.cancel')}
+        theme="secondary"
+        onClick={onClose}
+      />
+      <Button
+        data-testid="confirm-btn"
+        label={t('footer.buttons.confirm')}
+        onClick={onConfirm}
+        disabled={disabledConfirm}
+      />
+    </>
+  )
+}
+
+FilePickerFooter.propTypes = {
+  onConfirm: PropTypes.func.isRequired,
+  onClose: PropTypes.func.isRequired,
+  disabledConfirm: PropTypes.bool.isRequired
+}
+
+export default memo(FilePickerFooter)

package/react/FilePicker/FilePickerFooter.spec.jsx

@@ -0,0 +1,41 @@
+import React from 'react'
+import { render, fireEvent } from '@testing-library/react'
+
+import DemoProvider from './docs/DemoProvider'
+import FilePickerFooter from './FilePickerFooter'
+
+describe('FilePickerFooter components:', () => {
+  const mockOnConfirm = jest.fn()
+  const mockOnClose = jest.fn()
+
+  const setup = (disabledConfirm = false) => {
+    return render(
+      <DemoProvider>
+        <FilePickerFooter
+          onConfirm={mockOnConfirm}
+          onClose={mockOnClose}
+          disabledConfirm={disabledConfirm}
+        />
+      </DemoProvider>
+    )
+  }
+  it('should be rendered correctly', () => {
+    const { container } = setup()
+
+    expect(container).toBeDefined()
+  })
+
+  it('should confirm button have been called', () => {
+    const { getByTestId } = setup()
+    fireEvent.click(getByTestId('confirm-btn'))
+
+    expect(mockOnConfirm).toHaveBeenCalled()
+  })
+
+  it('should close button have been called', () => {
+    const { getByTestId } = setup()
+    fireEvent.click(getByTestId('close-btn'))
+
+    expect(mockOnClose).toHaveBeenCalled()
+  })
+})

package/react/FilePicker/FilePickerHeader.jsx

@@ -0,0 +1,85 @@
+import React, { useCallback, memo } from 'react'
+import PropTypes from 'prop-types'
+import uniqBy from 'lodash/uniqBy'
+import get from 'lodash/get'
+
+import { useQuery, hasQueryBeenLoaded } from 'cozy-client'
+
+import useBreakpoints from '../hooks/useBreakpoints'
+import IconButton from '../IconButton'
+import Icon from '../Icon'
+import Previous from '../Icons/Previous'
+
+import FilePickerBreadcrumb from './FilePickerBreadcrumb'
+import { buildCurrentFolderQuery } from './queries'
+import { ROOT_DIR_ID } from './index'
+
+/**
+ * @param {IOCozyFolder} displayedFolder - An io.cozy.files folder
+ * @returns {{id: string, name: string}[]}
+ */
+const getBreadcrumbPath = displayedFolder => {
+  return uniqBy(
+    [
+      {
+        id: ROOT_DIR_ID
+      },
+      {
+        id: get(displayedFolder, 'dir_id')
+      },
+      {
+        id: displayedFolder.id,
+        name: displayedFolder.name
+      }
+    ],
+    'id'
+  )
+    .filter(({ id }) => Boolean(id))
+    .map(breadcrumb => ({
+      id: breadcrumb.id,
+      name: breadcrumb.name || (breadcrumb.id === ROOT_DIR_ID ? 'Drive' : '…')
+    }))
+}
+
+const FilePickerHeader = ({ navigateTo, folderId, onClose }) => {
+  const { isMobile } = useBreakpoints()
+
+  const currentFolderQuery = buildCurrentFolderQuery(folderId)
+  const { data: currentFolder, ...restCurrentFolder } = useQuery(
+    currentFolderQuery.definition,
+    currentFolderQuery.options
+  )
+
+  const path = hasQueryBeenLoaded(restCurrentFolder)
+    ? getBreadcrumbPath(currentFolder[0])
+    : []
+
+  const onBack = useCallback(path => navigateTo(path), [navigateTo])
+
+  const handleClick = useCallback(() => {
+    path.length > 1 && isMobile ? onBack(path[path.length - 2]) : onClose()
+  }, [isMobile, path, onBack, onClose])
+
+  return (
+    <div className="u-flex u-flex-items-center">
+      {isMobile && (
+        <IconButton onClick={handleClick} className="u-p-0 u-pr-1">
+          <Icon icon={Previous} />
+        </IconButton>
+      )}
+      <FilePickerBreadcrumb
+        path={path}
+        onBreadcrumbClick={navigateTo}
+        opening={false}
+        inlined
+      />
+    </div>
+  )
+}
+
+FilePickerHeader.propTypes = {
+  folderId: PropTypes.string.isRequired,
+  navigateTo: PropTypes.func.isRequired
+}
+
+export default memo(FilePickerHeader)

package/react/FilePicker/Readme.md

@@ -0,0 +1,53 @@
+FilePicker allows you to select a file or folder in Drive
+
+```jsx
+import CozyIcon from 'cozy-ui/transpiled/react/Icons/Cozy'
+import Button from 'cozy-ui/transpiled/react/Button'
+import FilePicker from 'cozy-ui/transpiled/react/FilePicker'
+import Variants from 'cozy-ui/docs/components/Variants'
+import DemoProvider from './docs/DemoProvider';
+
+initialState = {
+  filePickerOpened: isTesting()
+};
+
+const initialVariants = [
+  { acceptFile: true, acceptFolder: false, multiple: false }
+];
+
+const toggleFilePicker = () => setState({ filePickerOpened: !state.filePickerOpened });
+const onChange = (fileId) => alert(`ID of file selected : [${fileId}]`);
+<DemoProvider>
+  <Variants initialVariants={initialVariants} screenshotAllVariants>
+    {variant => {
+      let acceptRule = ''
+      if (variant.acceptFile) {
+        acceptRule = 'file'
+        if (variant.acceptFolder) {
+          acceptRule = 'file,folder'
+        }
+      }
+      if (variant.acceptFolder) {
+        acceptRule = 'folder'
+        if (variant.acceptFile) {
+          acceptRule = 'folder,file'
+        }
+      }
+
+      return (
+        <>
+          <button onClick={toggleFilePicker}>Open FilePicker</button>
+          {state.filePickerOpened && (
+            <FilePicker
+              onClose={toggleFilePicker}
+              onChange={onChange}
+              accept={acceptRule}
+              multiple={variant.multiple}
+            />
+          )}
+        </>
+      )
+    }}
+  </Variants>
+</DemoProvider>
+```