cozy-sharing 16.11.0 → 16.12.0

package/CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [16.12.0](https://github.com/cozy/cozy-libs/compare/cozy-sharing@16.11.0...cozy-sharing@16.12.0) (2024-12-06)
+
+
+### Features
+
+* Add openSharingLink action ([de97967](https://github.com/cozy/cozy-libs/commit/de979676b43ab73e412683895437f108740ab5e2))
+* Add OpenSharingLinkButton & OpenSharingLinkFabButton components ([ffc603c](https://github.com/cozy/cozy-libs/commit/ffc603c798954b5ebffb4a860c82f231765bda8d))
+* Upgrade cozy-ui to 113.5.0 ([9bbd797](https://github.com/cozy/cozy-libs/commit/9bbd797056e085f00d1d867641abb12695fbf52b))
+
+
+
+
+
 # [16.11.0](https://github.com/cozy/cozy-libs/compare/cozy-sharing@16.10.0...cozy-sharing@16.11.0) (2024-12-05)
 
 

package/dist/OpenSharingLinkButton.js

@@ -0,0 +1,52 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["link", "isSharingShortcutCreated"];
+import PropTypes from 'prop-types';
+import React from 'react';
+import Button from 'cozy-ui/transpiled/react/Buttons';
+import Icon from 'cozy-ui/transpiled/react/Icon';
+import { useI18n } from 'cozy-ui/transpiled/react/providers/I18n';
+import { getIconWithlabel, openExternalLink } from './helpers/sharings';
+/**
+ * OpenSharingLinkButton component renders a Button
+ * that opens an link for Add/Synchronize/Create Cozy when clicked.
+ *
+ * @param {Object} props - The props for the component.
+ * @param {string} props.link - The URL to be opened when the button is clicked.
+ * @param {boolean} [props.isSharingShortcutCreated=false] - Indicates if a sharing shortcut has been created. (default false)
+ * @param {Object} [props] - Additional props to be passed to the Button component.
+ */
+
+export var OpenSharingLinkButton = function OpenSharingLinkButton(_ref) {
+  var link = _ref.link,
+      _ref$isSharingShortcu = _ref.isSharingShortcutCreated,
+      isSharingShortcutCreated = _ref$isSharingShortcu === void 0 ? false : _ref$isSharingShortcu,
+      props = _objectWithoutProperties(_ref, _excluded);
+
+  var _useI18n = useI18n(),
+      t = _useI18n.t;
+
+  var handleClick = function handleClick() {
+    openExternalLink(link);
+  };
+
+  var _getIconWithlabel = getIconWithlabel({
+    link: link,
+    isSharingShortcutCreated: isSharingShortcutCreated,
+    t: t
+  }),
+      icon = _getIconWithlabel.icon,
+      label = _getIconWithlabel.label;
+
+  return /*#__PURE__*/React.createElement(Button, _extends({
+    onClick: handleClick,
+    startIcon: /*#__PURE__*/React.createElement(Icon, {
+      icon: icon
+    }),
+    label: label
+  }, props));
+};
+OpenSharingLinkButton.propTypes = {
+  link: PropTypes.string,
+  isSharingShortcutCreated: PropTypes.bool
+};

package/dist/OpenSharingLinkFabButton.js

@@ -0,0 +1,80 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["position", "right", "bottom"],
+    _excluded2 = ["link", "isSharingShortcutCreated"],
+    _excluded3 = ["style"];
+
+function ownKeys(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(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+import PropTypes from 'prop-types';
+import React from 'react';
+import { ExtendableFab } from 'cozy-ui/transpiled/react/Fab';
+import { useI18n } from 'cozy-ui/transpiled/react/providers/I18n';
+import { getIconWithlabel, openExternalLink } from './helpers/sharings';
+
+var makeStyles = function makeStyles(customStyle) {
+  var position = customStyle.position,
+      right = customStyle.right,
+      bottom = customStyle.bottom,
+      rest = _objectWithoutProperties(customStyle, _excluded);
+
+  return _objectSpread({
+    position: position !== null && position !== void 0 ? position : 'fixed',
+    right: right !== null && right !== void 0 ? right : '1rem',
+    bottom: bottom !== null && bottom !== void 0 ? bottom : '1rem'
+  }, rest);
+};
+/**
+ * OpenSharingLinkFabButton component renders a ExtendableFab button
+ * that opens an link for Add/Synchronize/Create Cozy when clicked.
+ *
+ * @param {Object} props - The props for the component.
+ * @param {string} props.link - The URL to be opened when the button is clicked.
+ * @param {boolean} [props.isSharingShortcutCreated=false] - Indicates if a sharing shortcut has been created. (default false)
+ * @param {Object} [props] - Additional props to be passed to the ExtendableFab component.
+ */
+
+
+export var OpenSharingLinkFabButton = function OpenSharingLinkFabButton(_ref) {
+  var link = _ref.link,
+      _ref$isSharingShortcu = _ref.isSharingShortcutCreated,
+      isSharingShortcutCreated = _ref$isSharingShortcu === void 0 ? false : _ref$isSharingShortcu,
+      props = _objectWithoutProperties(_ref, _excluded2);
+
+  var _props$style = props.style,
+      style = _props$style === void 0 ? {} : _props$style,
+      rest = _objectWithoutProperties(props, _excluded3);
+
+  var _useI18n = useI18n(),
+      t = _useI18n.t;
+
+  var fabStyles = makeStyles(style);
+
+  var handleClick = function handleClick() {
+    openExternalLink(link);
+  };
+
+  var _getIconWithlabel = getIconWithlabel({
+    link: link,
+    isSharingShortcutCreated: isSharingShortcutCreated,
+    t: t
+  }),
+      icon = _getIconWithlabel.icon,
+      label = _getIconWithlabel.label;
+
+  return /*#__PURE__*/React.createElement(ExtendableFab, _extends({
+    color: "primary",
+    label: label,
+    style: fabStyles,
+    icon: icon,
+    follow: window,
+    onClick: handleClick
+  }, rest));
+};
+OpenSharingLinkFabButton.propTypes = {
+  link: PropTypes.string.isRequired,
+  isSharingShortcutCreated: PropTypes.bool
+};

package/dist/actions/openSharingLink.js

@@ -0,0 +1,45 @@
+import _extends from "@babel/runtime/helpers/extends";
+import React, { forwardRef } from 'react';
+import ActionsMenuItem from 'cozy-ui/transpiled/react/ActionsMenu/ActionsMenuItem';
+import Icon from 'cozy-ui/transpiled/react/Icon';
+import ListItemIcon from 'cozy-ui/transpiled/react/ListItemIcon';
+import ListItemText from 'cozy-ui/transpiled/react/ListItemText';
+import { getIconWithlabel, openExternalLink } from '../helpers/sharings';
+
+var makeComponent = function makeComponent(label, icon) {
+  var Component = /*#__PURE__*/forwardRef(function (props, ref) {
+    return /*#__PURE__*/React.createElement(ActionsMenuItem, _extends({}, props, {
+      ref: ref
+    }), /*#__PURE__*/React.createElement(ListItemIcon, null, /*#__PURE__*/React.createElement(Icon, {
+      icon: icon
+    })), /*#__PURE__*/React.createElement(ListItemText, {
+      primary: label
+    }));
+  });
+  Component.displayName = 'OpenSharingLink';
+  return Component;
+};
+
+export var openSharingLink = function openSharingLink(_ref) {
+  var t = _ref.t,
+      isSharingShortcutCreated = _ref.isSharingShortcutCreated,
+      link = _ref.link;
+
+  var _getIconWithlabel = getIconWithlabel({
+    link: link,
+    isSharingShortcutCreated: isSharingShortcutCreated,
+    t: t
+  }),
+      icon = _getIconWithlabel.icon,
+      label = _getIconWithlabel.label;
+
+  return {
+    name: 'openSharingLink',
+    label: label,
+    icon: icon,
+    action: function action() {
+      openExternalLink(link);
+    },
+    Component: makeComponent(label, icon)
+  };
+};

package/dist/helpers/sharings.js

@@ -1,10 +1,14 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { Q } from 'cozy-client';
+import CloudPlusOutlinedIcon from 'cozy-ui/transpiled/react/Icons/CloudPlusOutlined';
+import SyncIcon from 'cozy-ui/transpiled/react/Icons/Sync';
+import ToTheCloudIcon from 'cozy-ui/transpiled/react/Icons/ToTheCloud';
 import { fetchFilesPaths } from './files';
 import { updateInternalObjectFromRealtime, normalizeDocFromRealtime } from './realtime';
 import logger from '../logger';
 import { addSharing, updateSharing } from '../state';
+var CREATE_COZY_HREF = 'https://manager.cozycloud.cc/cozy/create';
 export var getSharingObject = function getSharingObject(internalSharing, sharing) {
   if (internalSharing) {
     return updateInternalObjectFromRealtime(internalSharing, sharing);
@@ -105,4 +109,45 @@ export var createSharingInStore = /*#__PURE__*/function () {
 }();
 export var updateSharingInStore = function updateSharingInStore(dispatch, sharing) {
   dispatch(updateSharing(sharing));
+};
+/**
+ * Open the link in a new tab
+ * @param {string} url
+ */
+
+export var openExternalLink = function openExternalLink(url) {
+  window.open(url, '_blank');
+};
+/**
+ * Get the icon and label to display in the button
+ * @param {object} params
+ * @param {string} params.link
+ * @param {boolean} params.isSharingShortcutCreated
+ * @param {object} params.t
+ * @returns {{ icon: React.Component, label: string }}
+ */
+
+export var getIconWithlabel = function getIconWithlabel(_ref4) {
+  var link = _ref4.link,
+      isSharingShortcutCreated = _ref4.isSharingShortcutCreated,
+      t = _ref4.t;
+
+  if (link === CREATE_COZY_HREF) {
+    return {
+      icon: ToTheCloudIcon,
+      label: t('Share.create-cozy')
+    };
+  }
+
+  if (!isSharingShortcutCreated) {
+    return {
+      icon: CloudPlusOutlinedIcon,
+      label: t('toolbar.add_to_mine')
+    };
+  }
+
+  return {
+    icon: SyncIcon,
+    label: t('toolbar.menu_sync_cozy')
+  };
 };

package/dist/index.js

@@ -22,4 +22,7 @@ export { SharingBannerPlugin } from './components/SharingBanner';
 export { useSharingInfos } from './components/SharingBanner/hooks/useSharingInfos';
 export { ConfirmTrustedRecipientsDialog } from './ConfirmTrustedRecipientsDialog';
 export { ShareButtonWithRecipients } from './ShareButtonWithRecipients';
-export { DOCUMENT_TYPE } from './helpers/documentType';
+export { DOCUMENT_TYPE } from './helpers/documentType';
+export { OpenSharingLinkButton } from './OpenSharingLinkButton';
+export { OpenSharingLinkFabButton } from './OpenSharingLinkFabButton';
+export { openSharingLink } from './actions/openSharingLink';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-sharing",
-  "version": "16.11.0",
+  "version": "16.12.0",
   "description": "Provides sharing login for React applications.",
   "main": "dist/index.js",
   "author": "Cozy",
@@ -46,11 +46,14 @@
     "@storybook/react": "7.6.0",
     "@storybook/react-webpack5": "7.6.0",
     "@storybook/testing-library": "0.2.2",
+    "@testing-library/jest-dom": "5.16.4",
+    "@testing-library/react": "10.4.9",
+    "@testing-library/react-hooks": "8.0.1",
     "babel-jest": "26.6.3",
     "babel-plugin-css-modules-transform": "1.6.2",
     "babel-plugin-inline-react-svg": "1.1.2",
-    "cozy-client": "^48.25.0",
-    "cozy-ui": "^111.12.0",
+    "cozy-client": "^51.4.0",
+    "cozy-ui": "113.5.0",
     "enzyme": "3.11.0",
     "enzyme-adapter-react-16": "1.15.6",
     "enzyme-to-json": "3.6.2",
@@ -61,9 +64,9 @@
     "storybook": "7.6.0"
   },
   "peerDependencies": {
-    "cozy-client": ">=48.25.0",
+    "cozy-client": ">=51.4.0",
     "cozy-realtime": "^3.11.0",
-    "cozy-ui": ">=111.12.0",
+    "cozy-ui": ">=113.5.0",
     "prop-types": "^15.7.2",
     "react": "^16.12.0",
     "react-router": "^5.0.1"
@@ -71,5 +74,5 @@
   "sideEffects": [
     "*.css"
   ],
-  "gitHead": "99210fddf08b4701afcf0390c0042d3f7cfb97ec"
+  "gitHead": "2f410e1905e3b74d32346b2be30377e31516f195"
 }

package/src/OpenSharingLinkButton.jsx

@@ -0,0 +1,49 @@
+import PropTypes from 'prop-types'
+import React from 'react'
+
+import Button from 'cozy-ui/transpiled/react/Buttons'
+import Icon from 'cozy-ui/transpiled/react/Icon'
+import { useI18n } from 'cozy-ui/transpiled/react/providers/I18n'
+
+import { getIconWithlabel, openExternalLink } from './helpers/sharings'
+
+/**
+ * OpenSharingLinkButton component renders a Button
+ * that opens an link for Add/Synchronize/Create Cozy when clicked.
+ *
+ * @param {Object} props - The props for the component.
+ * @param {string} props.link - The URL to be opened when the button is clicked.
+ * @param {boolean} [props.isSharingShortcutCreated=false] - Indicates if a sharing shortcut has been created. (default false)
+ * @param {Object} [props] - Additional props to be passed to the Button component.
+ */
+export const OpenSharingLinkButton = ({
+  link,
+  isSharingShortcutCreated = false,
+  ...props
+}) => {
+  const { t } = useI18n()
+
+  const handleClick = () => {
+    openExternalLink(link)
+  }
+
+  const { icon, label } = getIconWithlabel({
+    link,
+    isSharingShortcutCreated,
+    t
+  })
+
+  return (
+    <Button
+      onClick={handleClick}
+      startIcon={<Icon icon={icon} />}
+      label={label}
+      {...props}
+    />
+  )
+}
+
+OpenSharingLinkButton.propTypes = {
+  link: PropTypes.string,
+  isSharingShortcutCreated: PropTypes.bool
+}

package/src/OpenSharingLinkFabButton.jsx

@@ -0,0 +1,63 @@
+import PropTypes from 'prop-types'
+import React from 'react'
+
+import { ExtendableFab } from 'cozy-ui/transpiled/react/Fab'
+import { useI18n } from 'cozy-ui/transpiled/react/providers/I18n'
+
+import { getIconWithlabel, openExternalLink } from './helpers/sharings'
+
+const makeStyles = customStyle => {
+  const { position, right, bottom, ...rest } = customStyle
+  return {
+    position: position ?? 'fixed',
+    right: right ?? '1rem',
+    bottom: bottom ?? '1rem',
+    ...rest
+  }
+}
+
+/**
+ * OpenSharingLinkFabButton component renders a ExtendableFab button
+ * that opens an link for Add/Synchronize/Create Cozy when clicked.
+ *
+ * @param {Object} props - The props for the component.
+ * @param {string} props.link - The URL to be opened when the button is clicked.
+ * @param {boolean} [props.isSharingShortcutCreated=false] - Indicates if a sharing shortcut has been created. (default false)
+ * @param {Object} [props] - Additional props to be passed to the ExtendableFab component.
+ */
+export const OpenSharingLinkFabButton = ({
+  link,
+  isSharingShortcutCreated = false,
+  ...props
+}) => {
+  const { style = {}, ...rest } = props
+  const { t } = useI18n()
+  const fabStyles = makeStyles(style)
+
+  const handleClick = () => {
+    openExternalLink(link)
+  }
+
+  const { icon, label } = getIconWithlabel({
+    link,
+    isSharingShortcutCreated,
+    t
+  })
+
+  return (
+    <ExtendableFab
+      color="primary"
+      label={label}
+      style={fabStyles}
+      icon={icon}
+      follow={window}
+      onClick={handleClick}
+      {...rest}
+    />
+  )
+}
+
+OpenSharingLinkFabButton.propTypes = {
+  link: PropTypes.string.isRequired,
+  isSharingShortcutCreated: PropTypes.bool
+}

package/src/actions/openSharingLink.js

@@ -0,0 +1,42 @@
+import React, { forwardRef } from 'react'
+
+import ActionsMenuItem from 'cozy-ui/transpiled/react/ActionsMenu/ActionsMenuItem'
+import Icon from 'cozy-ui/transpiled/react/Icon'
+import ListItemIcon from 'cozy-ui/transpiled/react/ListItemIcon'
+import ListItemText from 'cozy-ui/transpiled/react/ListItemText'
+
+import { getIconWithlabel, openExternalLink } from '../helpers/sharings'
+
+const makeComponent = (label, icon) => {
+  const Component = forwardRef((props, ref) => {
+    return (
+      <ActionsMenuItem {...props} ref={ref}>
+        <ListItemIcon>
+          <Icon icon={icon} />
+        </ListItemIcon>
+        <ListItemText primary={label} />
+      </ActionsMenuItem>
+    )
+  })
+  Component.displayName = 'OpenSharingLink'
+
+  return Component
+}
+
+export const openSharingLink = ({ t, isSharingShortcutCreated, link }) => {
+  const { icon, label } = getIconWithlabel({
+    link,
+    isSharingShortcutCreated,
+    t
+  })
+
+  return {
+    name: 'openSharingLink',
+    label,
+    icon,
+    action: () => {
+      openExternalLink(link)
+    },
+    Component: makeComponent(label, icon)
+  }
+}

package/src/helpers/sharings.js

@@ -1,4 +1,7 @@
 import { Q } from 'cozy-client'
+import CloudPlusOutlinedIcon from 'cozy-ui/transpiled/react/Icons/CloudPlusOutlined'
+import SyncIcon from 'cozy-ui/transpiled/react/Icons/Sync'
+import ToTheCloudIcon from 'cozy-ui/transpiled/react/Icons/ToTheCloud'
 
 import { fetchFilesPaths } from './files'
 import {
@@ -8,6 +11,8 @@ import {
 import logger from '../logger'
 import { addSharing, updateSharing } from '../state'
 
+const CREATE_COZY_HREF = 'https://manager.cozycloud.cc/cozy/create'
+
 export const getSharingObject = (internalSharing, sharing) => {
   if (internalSharing) {
     return updateInternalObjectFromRealtime(internalSharing, sharing)
@@ -48,3 +53,29 @@ export const createSharingInStore = async ({
 export const updateSharingInStore = (dispatch, sharing) => {
   dispatch(updateSharing(sharing))
 }
+
+/**
+ * Open the link in a new tab
+ * @param {string} url
+ */
+export const openExternalLink = url => {
+  window.open(url, '_blank')
+}
+
+/**
+ * Get the icon and label to display in the button
+ * @param {object} params
+ * @param {string} params.link
+ * @param {boolean} params.isSharingShortcutCreated
+ * @param {object} params.t
+ * @returns {{ icon: React.Component, label: string }}
+ */
+export const getIconWithlabel = ({ link, isSharingShortcutCreated, t }) => {
+  if (link === CREATE_COZY_HREF) {
+    return { icon: ToTheCloudIcon, label: t('Share.create-cozy') }
+  }
+  if (!isSharingShortcutCreated) {
+    return { icon: CloudPlusOutlinedIcon, label: t('toolbar.add_to_mine') }
+  }
+  return { icon: SyncIcon, label: t('toolbar.menu_sync_cozy') }
+}

package/src/index.jsx

@@ -27,3 +27,6 @@ export { useSharingInfos } from './components/SharingBanner/hooks/useSharingInfo
 export { ConfirmTrustedRecipientsDialog } from './ConfirmTrustedRecipientsDialog'
 export { ShareButtonWithRecipients } from './ShareButtonWithRecipients'
 export { DOCUMENT_TYPE } from './helpers/documentType'
+export { OpenSharingLinkButton } from './OpenSharingLinkButton'
+export { OpenSharingLinkFabButton } from './OpenSharingLinkFabButton'
+export { openSharingLink } from './actions/openSharingLink'