cozy-sharing 18.0.0 → 20.0.0

package/src/components/ShareRestrictionModal/helpers.js

@@ -0,0 +1,227 @@
+import { getSharingLink } from 'cozy-client/dist/models/sharing'
+import minilog from 'cozy-minilog'
+
+const log = minilog('ShareRestrictionModal/helpers')
+
+export const WRITE_PERMS = ['GET', 'POST', 'PUT', 'PATCH']
+export const READ_ONLY_PERMS = ['GET']
+
+/**
+ * Copy a string to the clipboard
+ *
+ * @param {string} value - The string saved to the clipboard
+ * @param {object} [options]
+ * @param {number} options.t - Translation function
+ * @param {Function} options.showAlert - Function to display an alert
+ */
+export const copyToClipboard = async (value, { t, showAlert } = {}) => {
+  if (!value) return false
+  try {
+    await navigator.clipboard.writeText(value)
+    showAlert({
+      message: t('copyReminderContent.success'),
+      severity: 'success',
+      variant: 'filled'
+    })
+  } catch (error) {
+    showAlert({
+      message: t('copyReminderContent.error'),
+      severity: 'error',
+      variant: 'filled'
+    })
+    log.error(
+      "Error in 'copyToClipboard' function when trying to copy to clipboard",
+      error
+    )
+  }
+}
+
+/**
+ * Make a TTL string from a date
+ * @param {Date|string} selectedDate
+ * @returns {string} - TTL string in seconds (e.g. '1234s')
+ */
+export const makeTTL = selectedDate => {
+  if (!selectedDate) return
+  try {
+    let selectedDateConverted = selectedDate
+    if (typeof selectedDate === 'string') {
+      selectedDateConverted = new Date(selectedDate)
+      if (selectedDateConverted?.toString() === 'Invalid Date') {
+        throw new Error(`Invalid date: ${selectedDate}`)
+      }
+    }
+    if (selectedDateConverted instanceof Date) {
+      const now = new Date()
+      const ttl =
+        selectedDateConverted > now
+          ? `${Math.round((selectedDateConverted - now) / 1000)}s`
+          : undefined
+      return ttl
+    }
+    throw new Error(`Invalid date: ${selectedDate}`)
+  } catch (error) {
+    log.error(error)
+    return
+  }
+}
+
+/**
+ * forwardFile - Triggers the download of one or multiple files by the browser
+ * @param {object} options
+ * @param {import('cozy-client/types/CozyClient').default} options.client
+ * @param {import('cozy-client/types/types').IOCozyFile} options.file File to download
+ * @param {Function} options.t i18n function
+ * @param {string} options.ttl Time to live of the sharing link
+ * @param {string} options.password Password of the sharing link
+ * @param {Function} options.showAlert - Function to display an alert
+ */
+export const forwardFile = async ({
+  client,
+  file,
+  t,
+  ttl,
+  password,
+  showAlert
+}) => {
+  try {
+    // We currently support only one file at a time
+    const url = await getSharingLink(client, [file._id], { ttl, password })
+    const isZipFile = file.class === 'zip'
+    const shareData = {
+      title: t('shareFile.title', {
+        name: file.name,
+        smart_count: isZipFile ? 2 : 1
+      }),
+      text: t('shareFile.text', {
+        name: file.name,
+        smart_count: isZipFile ? 2 : 1
+      }),
+      url
+    }
+    navigator.share(shareData)
+  } catch (error) {
+    showAlert({
+      message: t('shareFile.error'),
+      severity: 'error',
+      variant: 'filled'
+    })
+  }
+}
+
+/**
+ * createPermissions - Create the permissions of a file
+ * @param {object} options
+ * @param {import('cozy-client/types/types').IOCozyFile} options.file File to update permissions
+ * @param {Function} options.t i18n function
+ * @param {Date|string} options.ttl - Time to live of the sharing link
+ * @param {string} options.password - Password
+ * @param {'readOnly'|'write'} options.editingRights - Editing rights
+ * @param {string} options.documentType - Type of the document
+ * @param {Function} options.shareByLink - Function to create permissions
+ * @param {Function} options.showAlert - Function to display an alert
+ */
+export const createPermissions = async ({
+  file,
+  t,
+  ttl,
+  password,
+  editingRights,
+  documentType,
+  shareByLink,
+  showAlert
+}) => {
+  try {
+    const verbs = editingRights === 'readOnly' ? READ_ONLY_PERMS : WRITE_PERMS
+    return shareByLink(file, { verbs, ttl, password })
+  } catch (err) {
+    showAlert({
+      message: t(`${documentType}.share.shareByLink.permserror`),
+      severity: 'error',
+      variant: 'filled'
+    })
+    log.error(
+      "Error in 'readOnlyPermissionLink' function when trying to change permission",
+      err
+    )
+  }
+}
+
+/**
+ * updatePermissions - Updates the permissions of a file
+ * @param {object} options
+ * @param {import('cozy-client/types/types').IOCozyFile} options.file File to update permissions
+ * @param {Function} options.t i18n function
+ * @param {boolean} options.dateToggle - Expiration date toggle
+ * @param {Date|null} options.selectedDate - Expiration date
+ * @param {boolean} options.passwordToggle - Password toggle
+ * @param {string} options.password - Password
+ * @param {string} options.documentType - Type of the document
+ * @param {'readOnly'|'write'} options.editingRights - Editing rights
+ * @param {Function} options.updateDocumentPermissions - Function to update permissions
+ * @param {Function} options.showAlert - Function to display an alert
+ */
+export const updatePermissions = async ({
+  file,
+  t,
+  dateToggle,
+  selectedDate,
+  passwordToggle,
+  password,
+  editingRights,
+  documentType,
+  updateDocumentPermissions,
+  showAlert
+}) => {
+  try {
+    const expiresAt = dateToggle ? selectedDate?.toISOString() || undefined : ''
+    const ensurePassword = passwordToggle ? password || undefined : ''
+    const verbs = editingRights === 'readOnly' ? READ_ONLY_PERMS : WRITE_PERMS
+    return updateDocumentPermissions(file, {
+      verbs,
+      expiresAt,
+      password: ensurePassword
+    })
+  } catch (err) {
+    showAlert({
+      message: t(`${documentType}.share.shareByLink.permserror`),
+      severity: 'error',
+      variant: 'filled'
+    })
+    log.error(
+      "Error in 'updateDocumentPermissions' function when trying to change permission",
+      err
+    )
+  }
+}
+
+/**
+ * revokePermissions - Revokes the permissions of a file
+ * @param {object} options
+ * @param {import('cozy-client/types/types').IOCozyFile} options.file File to revoke permissions
+ * @param {Function} options.t i18n function
+ * @param {string} options.documentType - Type of the document
+ * @param {Function} options.revokeSharingLink - Function to revoke permissions
+ * @param {Function} options.showAlert - Function to display an alert
+ */
+export const revokePermissions = async ({
+  file,
+  t,
+  documentType,
+  revokeSharingLink,
+  showAlert
+}) => {
+  try {
+    return revokeSharingLink(file)
+  } catch (err) {
+    showAlert({
+      message: t(`${documentType}.share.error.revoke`),
+      severity: 'error',
+      variant: 'filled'
+    })
+    log.error(
+      "Error in 'revokePermissions' function when trying to revoke sharing link",
+      err
+    )
+  }
+}

package/src/components/ShareRestrictionModal/helpers.spec.js

@@ -0,0 +1,159 @@
+import { makeTTL, revokePermissions, updatePermissions } from './helpers'
+
+describe('ShareRestrictionModal/helpers', () => {
+  describe('makeTTL', () => {
+    it('sould return undefined', () => {
+      expect(makeTTL()).toBeUndefined()
+      expect(makeTTL(123)).toBeUndefined()
+      expect(makeTTL('abc')).toBeUndefined()
+      expect(makeTTL(new Date('2023-01-01T00:00:00.000Z'))).toBeUndefined()
+      expect(makeTTL(new Date('abc'))).toBeUndefined()
+      expect(makeTTL('2023-01-01T00:00:00.000Z')).toBeUndefined()
+    })
+    it('sould return TTL in seconds', () => {
+      expect(makeTTL(new Date('2100-01-01T00:00:00.000Z'))).toBeDefined()
+      expect(makeTTL('2100-01-01T00:00:00.000Z')).toBeDefined()
+    })
+  })
+
+  describe('updatePermissions', () => {
+    const documentType = 'Files'
+    it('should call updateDocumentPermissions with "readOnly" permission', async () => {
+      const updateDocumentPermissions = jest.fn()
+      const file = { _id: '123' }
+
+      await updatePermissions({
+        file,
+        t: jest.fn(),
+        dateToggle: false,
+        selectedDate: null,
+        passwordToggle: false,
+        password: '',
+        editingRights: 'readOnly',
+        documentType,
+        updateDocumentPermissions,
+        showAlert: jest.fn()
+      })
+
+      expect(updateDocumentPermissions).toHaveBeenCalledWith(file, {
+        expiresAt: '',
+        password: '',
+        verbs: ['GET']
+      })
+    })
+
+    it('should call updateDocumentPermissions with "write" permissions', async () => {
+      const updateDocumentPermissions = jest.fn()
+      const file = { _id: '123' }
+
+      await updatePermissions({
+        file,
+        t: jest.fn(),
+        dateToggle: false,
+        selectedDate: null,
+        passwordToggle: false,
+        password: '',
+        editingRights: 'write',
+        documentType,
+        updateDocumentPermissions,
+        showAlert: jest.fn()
+      })
+
+      expect(updateDocumentPermissions).toHaveBeenCalledWith(file, {
+        expiresAt: '',
+        password: '',
+        verbs: ['GET', 'POST', 'PUT', 'PATCH']
+      })
+    })
+
+    it('should call updateDocumentPermissions with empty date & password if their switches are false', async () => {
+      const updateDocumentPermissions = jest.fn()
+      const file = { _id: '123' }
+
+      await updatePermissions({
+        file,
+        t: jest.fn(),
+        dateToggle: false,
+        selectedDate: null,
+        passwordToggle: false,
+        password: '',
+        editingRights: 'readOnly',
+        documentType,
+        updateDocumentPermissions,
+        showAlert: jest.fn()
+      })
+
+      expect(updateDocumentPermissions).toHaveBeenCalledWith(file, {
+        expiresAt: '',
+        password: '',
+        verbs: ['GET']
+      })
+    })
+
+    it('should call updateDocumentPermissions with "undefined" date & password if their switches are true but the permission doesn\'t yet have these values', async () => {
+      const updateDocumentPermissions = jest.fn()
+      const file = { _id: '123' }
+
+      await updatePermissions({
+        file,
+        t: jest.fn(),
+        dateToggle: true,
+        selectedDate: null,
+        passwordToggle: true,
+        password: '',
+        editingRights: 'readOnly',
+        documentType,
+        updateDocumentPermissions,
+        showAlert: jest.fn()
+      })
+
+      expect(updateDocumentPermissions).toHaveBeenCalledWith(file, {
+        expiresAt: undefined,
+        password: undefined,
+        verbs: ['GET']
+      })
+    })
+
+    it('should call updateDocumentPermissions with expected date & password if their switches are true', async () => {
+      const updateDocumentPermissions = jest.fn()
+      const file = { _id: '123' }
+
+      await updatePermissions({
+        file,
+        t: jest.fn(),
+        dateToggle: true,
+        selectedDate: new Date('2100-01-01T00:00:00.000Z'),
+        passwordToggle: true,
+        password: '1234',
+        editingRights: 'readOnly',
+        documentType,
+        updateDocumentPermissions,
+        showAlert: jest.fn()
+      })
+
+      expect(updateDocumentPermissions).toHaveBeenCalledWith(file, {
+        expiresAt: '2100-01-01T00:00:00.000Z',
+        password: '1234',
+        verbs: ['GET']
+      })
+    })
+  })
+
+  describe('revokePermissions', () => {
+    const documentType = 'Files'
+    it('should call revokeSharingLink', async () => {
+      const revokeSharingLink = jest.fn()
+      const file = { _id: '123' }
+
+      await revokePermissions({
+        file,
+        t: jest.fn(),
+        documentType,
+        revokeSharingLink,
+        showAlert: jest.fn()
+      })
+
+      expect(revokeSharingLink).toHaveBeenCalledWith(file)
+    })
+  })
+})

package/src/components/WhoHasAccess.jsx

@@ -37,9 +37,7 @@ const WhoHasAccess = ({
   onRevokeSelf,
   verifyRecipient,
   link,
-  permissions,
-  onUpdateShareLinkPermissions,
-  onRevokeLink
+  permissions
 }) => {
   const previousLink = usePrevious(link)
   const linkHasBeenJustCreated = link && previousLink === null
@@ -58,8 +56,6 @@ const WhoHasAccess = ({
             onRevokeSelf={onRevokeSelf}
             link={link}
             permissions={permissions}
-            onChangePermissions={onUpdateShareLinkPermissions}
-            onDisable={onRevokeLink}
             fadeIn={linkHasBeenJustCreated}
           />
         )}

package/src/helpers/permissions.js

@@ -14,3 +14,15 @@ export const checkIsReadOnlyPermissions = permissions => {
     ).length > 0
   )
 }
+
+export const checkIsPermissionHasExpiresDate = permissions => {
+  return Boolean(permissions?.[0]?.attributes?.expires_at)
+}
+
+export const getPermissionExpiresDate = permissions => {
+  return permissions?.[0]?.attributes?.expires_at
+}
+
+export const checkIsPermissionHasPassword = permissions => {
+  return Boolean(permissions?.[0]?.attributes?.password)
+}

package/dist/components/EditLinkPermissionDialog.js

@@ -1,72 +0,0 @@
-import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-import PropTypes from 'prop-types';
-import React, { useState } from 'react';
-import Button from 'cozy-ui/transpiled/react/Buttons';
-import { ConfirmDialog } from 'cozy-ui/transpiled/react/CozyDialogs';
-import FormControlLabel from 'cozy-ui/transpiled/react/FormControlLabel';
-import RadioGroup from 'cozy-ui/transpiled/react/RadioGroup';
-import Radio from 'cozy-ui/transpiled/react/Radios';
-import { useI18n } from 'cozy-ui/transpiled/react/providers/I18n';
-
-var EditLinkPermissionDialog = function EditLinkPermissionDialog(_ref) {
-  var open = _ref.open,
-      onClose = _ref.onClose,
-      document = _ref.document,
-      onPermissionsSelected = _ref.onPermissionsSelected;
-
-  var _useI18n = useI18n(),
-      t = _useI18n.t;
-
-  var _useState = useState(true),
-      _useState2 = _slicedToArray(_useState, 2),
-      isReadOnlyPermissions = _useState2[0],
-      setIsReadOnlyPermissions = _useState2[1];
-
-  var onChange = function onChange(event) {
-    setIsReadOnlyPermissions(event.target.value === 'true');
-  };
-
-  var onConfirm = function onConfirm() {
-    var verbs = isReadOnlyPermissions ? ['GET'] : ['GET', 'POST', 'PUT', 'PATCH'];
-    onPermissionsSelected({
-      verbs: verbs
-    });
-    onClose();
-  };
-
-  return /*#__PURE__*/React.createElement(ConfirmDialog, {
-    open: open,
-    onClose: onClose,
-    title: t('Share.permissionLink.title'),
-    content: /*#__PURE__*/React.createElement(RadioGroup, {
-      "aria-label": "radio",
-      value: isReadOnlyPermissions.toString(),
-      onChange: onChange
-    }, /*#__PURE__*/React.createElement(FormControlLabel, {
-      value: "true",
-      label: (document === null || document === void 0 ? void 0 : document.type) === 'directory' ? t("Share.permissionLink.seeFolder") : t("Share.permissionLink.seeFile"),
-      control: /*#__PURE__*/React.createElement(Radio, null)
-    }), /*#__PURE__*/React.createElement(FormControlLabel, {
-      value: "false",
-      label: (document === null || document === void 0 ? void 0 : document.type) === 'directory' ? t("Share.permissionLink.modifyFolder") : t("Share.permissionLink.modifyFile"),
-      control: /*#__PURE__*/React.createElement(Radio, null)
-    })),
-    actions: /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Button, {
-      variant: "secondary",
-      label: t('Share.permissionLink.cancel'),
-      onClick: onClose
-    }), /*#__PURE__*/React.createElement(Button, {
-      variant: "primary",
-      label: t('Share.permissionLink.confirm'),
-      onClick: onConfirm
-    }))
-  });
-};
-
-EditLinkPermissionDialog.propTypes = {
-  open: PropTypes.bool.isRequired,
-  onClose: PropTypes.func.isRequired,
-  document: PropTypes.object.isRequired,
-  onPermissionsSelected: PropTypes.func.isRequired
-};
-export default EditLinkPermissionDialog;

package/dist/components/EditLinkPermissionDialog.spec.js

@@ -1,48 +0,0 @@
-import _extends from "@babel/runtime/helpers/extends";
-import { render, fireEvent } from '@testing-library/react';
-import React from 'react';
-import { createMockClient } from 'cozy-client';
-import EditLinkPermissionDialog from './EditLinkPermissionDialog';
-import AppLike from '../../test/AppLike';
-describe('EditLinkPermissionDialog', function () {
-  var client = createMockClient({});
-
-  var setup = function setup(props) {
-    return render( /*#__PURE__*/React.createElement(AppLike, {
-      client: client
-    }, /*#__PURE__*/React.createElement(EditLinkPermissionDialog, _extends({
-      open: true,
-      onClose: function onClose() {}
-    }, props))));
-  };
-
-  it('should select read permissions', function () {
-    var onPermissionsSelected = jest.fn();
-    var props = {
-      onPermissionsSelected: onPermissionsSelected
-    };
-
-    var _setup = setup(props),
-        getByText = _setup.getByText;
-
-    fireEvent.click(getByText('OK'));
-    expect(onPermissionsSelected).toHaveBeenCalledWith({
-      verbs: ['GET']
-    });
-  });
-  it('should select write permissions', function () {
-    var onPermissionsSelected = jest.fn();
-    var props = {
-      onPermissionsSelected: onPermissionsSelected
-    };
-
-    var _setup2 = setup(props),
-        getByText = _setup2.getByText;
-
-    fireEvent.click(getByText('Modify file'));
-    fireEvent.click(getByText('OK'));
-    expect(onPermissionsSelected).toHaveBeenCalledWith({
-      verbs: ['GET', 'POST', 'PUT', 'PATCH']
-    });
-  });
-});

package/src/components/EditLinkPermissionDialog.jsx

@@ -1,89 +0,0 @@
-import PropTypes from 'prop-types'
-import React, { useState } from 'react'
-
-import Button from 'cozy-ui/transpiled/react/Buttons'
-import { ConfirmDialog } from 'cozy-ui/transpiled/react/CozyDialogs'
-import FormControlLabel from 'cozy-ui/transpiled/react/FormControlLabel'
-import RadioGroup from 'cozy-ui/transpiled/react/RadioGroup'
-import Radio from 'cozy-ui/transpiled/react/Radios'
-import { useI18n } from 'cozy-ui/transpiled/react/providers/I18n'
-
-const EditLinkPermissionDialog = ({
-  open,
-  onClose,
-  document,
-  onPermissionsSelected
-}) => {
-  const { t } = useI18n()
-
-  const [isReadOnlyPermissions, setIsReadOnlyPermissions] = useState(true)
-
-  const onChange = event => {
-    setIsReadOnlyPermissions(event.target.value === 'true')
-  }
-
-  const onConfirm = () => {
-    const verbs = isReadOnlyPermissions
-      ? ['GET']
-      : ['GET', 'POST', 'PUT', 'PATCH']
-    onPermissionsSelected({ verbs })
-    onClose()
-  }
-
-  return (
-    <ConfirmDialog
-      open={open}
-      onClose={onClose}
-      title={t('Share.permissionLink.title')}
-      content={
-        <RadioGroup
-          aria-label="radio"
-          value={isReadOnlyPermissions.toString()}
-          onChange={onChange}
-        >
-          <FormControlLabel
-            value="true"
-            label={
-              document?.type === 'directory'
-                ? t(`Share.permissionLink.seeFolder`)
-                : t(`Share.permissionLink.seeFile`)
-            }
-            control={<Radio />}
-          />
-          <FormControlLabel
-            value="false"
-            label={
-              document?.type === 'directory'
-                ? t(`Share.permissionLink.modifyFolder`)
-                : t(`Share.permissionLink.modifyFile`)
-            }
-            control={<Radio />}
-          />
-        </RadioGroup>
-      }
-      actions={
-        <>
-          <Button
-            variant="secondary"
-            label={t('Share.permissionLink.cancel')}
-            onClick={onClose}
-          />
-          <Button
-            variant="primary"
-            label={t('Share.permissionLink.confirm')}
-            onClick={onConfirm}
-          />
-        </>
-      }
-    />
-  )
-}
-
-EditLinkPermissionDialog.propTypes = {
-  open: PropTypes.bool.isRequired,
-  onClose: PropTypes.func.isRequired,
-  document: PropTypes.object.isRequired,
-  onPermissionsSelected: PropTypes.func.isRequired
-}
-
-export default EditLinkPermissionDialog

package/src/components/EditLinkPermissionDialog.spec.jsx

@@ -1,53 +0,0 @@
-import { render, fireEvent } from '@testing-library/react'
-import React from 'react'
-
-import { createMockClient } from 'cozy-client'
-
-import EditLinkPermissionDialog from './EditLinkPermissionDialog'
-import AppLike from '../../test/AppLike'
-
-describe('EditLinkPermissionDialog', () => {
-  const client = createMockClient({})
-
-  const setup = props => {
-    return render(
-      <AppLike client={client}>
-        <EditLinkPermissionDialog open onClose={() => {}} {...props} />
-      </AppLike>
-    )
-  }
-
-  it('should select read permissions', () => {
-    const onPermissionsSelected = jest.fn()
-
-    const props = {
-      onPermissionsSelected
-    }
-
-    const { getByText } = setup(props)
-
-    fireEvent.click(getByText('OK'))
-
-    expect(onPermissionsSelected).toHaveBeenCalledWith({
-      verbs: ['GET']
-    })
-  })
-
-  it('should select write permissions', () => {
-    const onPermissionsSelected = jest.fn()
-
-    const props = {
-      onPermissionsSelected
-    }
-
-    const { getByText } = setup(props)
-
-    fireEvent.click(getByText('Modify file'))
-
-    fireEvent.click(getByText('OK'))
-
-    expect(onPermissionsSelected).toHaveBeenCalledWith({
-      verbs: ['GET', 'POST', 'PUT', 'PATCH']
-    })
-  })
-})