cozy-sharing 16.9.0 → 16.11.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [16.11.0](https://github.com/cozy/cozy-libs/compare/cozy-sharing@16.10.0...cozy-sharing@16.11.0) (2024-12-05)
+
+
+### Features
+
+* **Sharing:** Expose new component to show owner recipient ([bcc6302](https://github.com/cozy/cozy-libs/commit/bcc6302abf0190259e86a9d327aa0d46e39b693b))
+
+
+
+
+
+# [16.10.0](https://github.com/cozy/cozy-libs/compare/cozy-sharing@16.9.0...cozy-sharing@16.10.0) (2024-12-05)
+
+
+### Features
+
+* **Sharing:** Add isPublic prop to SharingProvider ([d08862d](https://github.com/cozy/cozy-libs/commit/d08862d65fd4caaabfd29f116ade0607528345a9))
+
+
+
+
+
 # [16.9.0](https://github.com/cozy/cozy-libs/compare/cozy-sharing@16.8.0...cozy-sharing@16.9.0) (2024-12-04)
 
 

package/dist/SharingProvider.js

@@ -32,6 +32,7 @@ function _callSuper(_this, derived, args) {
 
 import React, { Component } from 'react';
 import { withClient } from 'cozy-client';
+import minilog from 'cozy-minilog';
 import SharingContext from './context';
 import { fetchNextPermissions } from './fetchNextPermissions';
 import { fetchFilesPaths } from './helpers/files';
@@ -39,10 +40,13 @@ import { getSharingObject, createSharingInStore, updateSharingInStore } from './
 import { SynchronousJobQueue } from './helpers/synchronousJobQueue';
 import { fetchApps } from './queries/queries';
 import reducer, { receiveSharings, addSharing, updateSharing, addSharingLink, updateSharingLink, revokeSharingLink, revokeRecipient, revokeGroup as revokeGroupFromState, revokeSelf, receivePaths, isOwner as _isOwner, canReshare as _canReshare, getOwner as _getOwner, getRecipients as _getRecipients, getSharingById, getExternalSharingIds, getSharingForSelf as _getSharingForSelf, getSharingType as _getSharingType, getSharingLink as _getSharingLink, getSharedDocIdsBySharings, getDocumentSharing, getDocumentPermissions as _getDocumentPermissions, hasSharedParent as _hasSharedParent, hasSharedChild as _hasSharedChild, getSharedParentPath as _getSharedParentPath } from './state';
+var log = minilog('SharingProvider');
 var SHARING_DOCTYPE = 'io.cozy.sharings';
 var PERMISSION_DOCTYPE = 'io.cozy.permissions';
 export var SharingProvider = /*#__PURE__*/function (_Component) {
   function SharingProvider(props, context) {
+    var _props$isPublic;
+
     var _this2;
 
     _classCallCheck(this, SharingProvider);
@@ -614,6 +618,7 @@ export var SharingProvider = /*#__PURE__*/function (_Component) {
       refresh: _this2.fetchAllSharings,
       hasWriteAccess: _this2.hasWriteAccess
     };
+    _this2.isPublic = (_props$isPublic = props.isPublic) !== null && _props$isPublic !== void 0 ? _props$isPublic : false;
     _this2.realtime = null;
     _this2.isInitialized = false;
     _this2.synchronousJobQueue = new SynchronousJobQueue();
@@ -654,11 +659,21 @@ export var SharingProvider = /*#__PURE__*/function (_Component) {
         return _regeneratorRuntime.wrap(function _callee13$(_context13) {
           while (1) switch (_context13.prev = _context13.next) {
             case 0:
+              if (!this.isPublic) {
+                _context13.next = 3;
+                break;
+              }
+
+              // In public mode, the promise below fails because the methods do not have the required permissions.
+              log.warn('fetchAllSharings is not allowed in public context.');
+              return _context13.abrupt("return");
+
+            case 3:
               _this$props = this.props, doctype = _this$props.doctype, client = _this$props.client;
-              _context13.next = 3;
+              _context13.next = 6;
               return Promise.all([this.sharingCol.findByDoctype(doctype), this.permissionCol.findLinksByDoctype(doctype), client.fetchQueryAndGetFromState(fetchApps())]);
 
-            case 3:
+            case 6:
               _yield$Promise$all = _context13.sent;
               _yield$Promise$all2 = _slicedToArray(_yield$Promise$all, 3);
               sharings = _yield$Promise$all2[0];
@@ -674,43 +689,43 @@ export var SharingProvider = /*#__PURE__*/function (_Component) {
                 hasLoadedAtLeastOnePage: true
               }); // eslint-disable-next-line promise/catch-or-return
 
-              _context13.next = 12;
+              _context13.next = 15;
               return fetchNextPermissions(permissions, this.dispatch, this.permissionCol);
 
-            case 12:
+            case 15:
               if (!(doctype === 'io.cozy.files')) {
-                _context13.next = 22;
+                _context13.next = 25;
                 break;
               }
 
               sharedDocIds = getSharedDocIdsBySharings(sharings);
-              _context13.next = 16;
+              _context13.next = 19;
               return client.collection(doctype).all({
                 keys: sharedDocIds
               });
 
-            case 16:
+            case 19:
               resp = _context13.sent;
               folderPaths = resp.data.filter(function (f) {
                 return f.type === 'directory' && !f.trashed;
               }).map(function (f) {
                 return f.path;
               });
-              _context13.next = 20;
+              _context13.next = 23;
               return fetchFilesPaths(client, doctype, resp.data.filter(function (f) {
                 return f.type !== 'directory' && !f.trashed;
               }));
 
-            case 20:
+            case 23:
               filePaths = _context13.sent;
               this.dispatch(receivePaths([].concat(_toConsumableArray(folderPaths), _toConsumableArray(filePaths))));
 
-            case 22:
+            case 25:
               this.setState({
                 allLoaded: true
               });
 
-            case 23:
+            case 26:
             case "end":
               return _context13.stop();
           }

package/dist/SharingProvider.spec.js

@@ -11,11 +11,13 @@ import AppLike from '../test/AppLike';
 
 var AppWrapper = function AppWrapper(_ref) {
   var children = _ref.children,
-      client = _ref.client;
+      client = _ref.client,
+      isPublic = _ref.isPublic;
   return /*#__PURE__*/React.createElement(AppLike, {
     client: client
   }, /*#__PURE__*/React.createElement(SharingProvider, {
-    client: client
+    client: client,
+    isPublic: isPublic
   }, children));
 };
 
@@ -83,7 +85,17 @@ describe('SharingProvider', function () {
   };
   client.isLogged = true;
   beforeEach(function () {
-    jest.spyOn(client, 'collection');
+    jest.spyOn(client, 'collection').mockReturnValue({
+      findByDoctype: jest.fn().mockResolvedValue({
+        data: []
+      }),
+      findLinksByDoctype: jest.fn().mockResolvedValue({
+        data: []
+      }),
+      findApps: jest.fn().mockResolvedValue({
+        data: []
+      })
+    });
     jest.spyOn(SharingProvider.prototype, 'fetchAllSharings').mockReturnValue(Promise.resolve());
   });
   afterEach(function () {
@@ -107,6 +119,18 @@ describe('SharingProvider', function () {
     expect(client.plugins.realtime.subscribe).toHaveBeenCalled();
     expect(SharingProvider.prototype.fetchAllSharings).toHaveBeenCalled();
   });
+  it("should not call collection's methods but always subscribe to the realtime when isPublic is true", function () {
+    client.isLogged = true;
+    render( /*#__PURE__*/React.createElement(AppWrapper, {
+      client: client,
+      isPublic: true
+    }));
+    expect(SharingProvider.prototype.fetchAllSharings).toHaveBeenCalled();
+    expect(client.plugins.realtime.subscribe).toHaveBeenCalled();
+    expect(client.collection().findByDoctype).not.toHaveBeenCalled();
+    expect(client.collection().findLinksByDoctype).not.toHaveBeenCalled();
+    expect(client.collection().findApps).not.toHaveBeenCalled();
+  });
 });
 describe('hasWriteAccess', function () {
   it('tells if a doc is writtable', function () {

package/dist/components/Recipient/OwnerRecipientDefaultLite.js

@@ -0,0 +1,23 @@
+import React from 'react';
+import { useClient, useQuery, hasQueryBeenLoaded } from 'cozy-client';
+import MemberRecipientLite from './MemberRecipientLite';
+import withLocales from '../../hoc/withLocales';
+import { buildInstanceSettingsQuery } from '../../queries/queries';
+
+var OwnerRecipientDefaultLite = function OwnerRecipientDefaultLite() {
+  var _instanceSettingsResu;
+
+  var client = useClient();
+  var instanceSettingsQuery = buildInstanceSettingsQuery();
+  var instanceSettingsResult = useQuery(instanceSettingsQuery.definition, instanceSettingsQuery.options);
+  return hasQueryBeenLoaded(instanceSettingsResult) && /*#__PURE__*/React.createElement(MemberRecipientLite, {
+    recipient: {
+      status: 'owner',
+      instance: client.options.uri,
+      public_name: instanceSettingsResult === null || instanceSettingsResult === void 0 || (_instanceSettingsResu = instanceSettingsResult.data) === null || _instanceSettingsResu === void 0 || (_instanceSettingsResu = _instanceSettingsResu.attributes) === null || _instanceSettingsResu === void 0 ? void 0 : _instanceSettingsResu.public_name
+    },
+    isOwner: true
+  });
+};
+
+export default withLocales(OwnerRecipientDefaultLite);

package/dist/index.js

@@ -12,6 +12,7 @@ export { SharingOwnerAvatar } from './SharingOwnerAvatar';
 export { SharedRecipients } from './SharedRecipients';
 export { default as MemberRecipientLite } from './components/Recipient/MemberRecipientLite';
 export { default as LinkRecipientLite } from './components/Recipient/LinkRecipientLite';
+export { default as OwnerRecipientDefaultLite } from './components/Recipient/OwnerRecipientDefaultLite';
 export { SharedRecipientsList } from './SharedRecipientsList';
 export { ShareButton } from './ShareButton';
 export { ShareModal } from './components/ShareModal/ShareModal';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-sharing",
-  "version": "16.9.0",
+  "version": "16.11.0",
   "description": "Provides sharing login for React applications.",
   "main": "dist/index.js",
   "author": "Cozy",
@@ -71,5 +71,5 @@
   "sideEffects": [
     "*.css"
   ],
-  "gitHead": "8b0b03c7978ff9bff74635d31a8e4ec259294200"
+  "gitHead": "99210fddf08b4701afcf0390c0042d3f7cfb97ec"
 }

package/src/SharingProvider.jsx

@@ -1,6 +1,7 @@
 import React, { Component } from 'react'
 
 import { withClient } from 'cozy-client'
+import minilog from 'cozy-minilog'
 
 import SharingContext from './context'
 import { fetchNextPermissions } from './fetchNextPermissions'
@@ -40,6 +41,7 @@ import reducer, {
   getSharedParentPath
 } from './state'
 
+const log = minilog('SharingProvider')
 const SHARING_DOCTYPE = 'io.cozy.sharings'
 const PERMISSION_DOCTYPE = 'io.cozy.permissions'
 
@@ -83,6 +85,7 @@ export class SharingProvider extends Component {
       refresh: this.fetchAllSharings,
       hasWriteAccess: this.hasWriteAccess
     }
+    this.isPublic = props.isPublic ?? false
     this.realtime = null
     this.isInitialized = false
 
@@ -175,6 +178,11 @@ export class SharingProvider extends Component {
   }
 
   async fetchAllSharings() {
+    if (this.isPublic) {
+      // In public mode, the promise below fails because the methods do not have the required permissions.
+      log.warn('fetchAllSharings is not allowed in public context.')
+      return
+    }
     const { doctype, client } = this.props
     const [sharings, permissions, apps] = await Promise.all([
       this.sharingCol.findByDoctype(doctype),

package/src/SharingProvider.spec.jsx

@@ -9,10 +9,12 @@ import SharingContext from './context'
 import { receiveSharings } from './state'
 import AppLike from '../test/AppLike'
 
-const AppWrapper = ({ children, client }) => {
+const AppWrapper = ({ children, client, isPublic }) => {
   return (
     <AppLike client={client}>
-      <SharingProvider client={client}>{children}</SharingProvider>
+      <SharingProvider client={client} isPublic={isPublic}>
+        {children}
+      </SharingProvider>
     </AppLike>
   )
 }
@@ -62,7 +64,11 @@ describe('SharingProvider', () => {
   client.isLogged = true
 
   beforeEach(() => {
-    jest.spyOn(client, 'collection')
+    jest.spyOn(client, 'collection').mockReturnValue({
+      findByDoctype: jest.fn().mockResolvedValue({ data: [] }),
+      findLinksByDoctype: jest.fn().mockResolvedValue({ data: [] }),
+      findApps: jest.fn().mockResolvedValue({ data: [] })
+    })
     jest
       .spyOn(SharingProvider.prototype, 'fetchAllSharings')
       .mockReturnValue(Promise.resolve())
@@ -87,6 +93,17 @@ describe('SharingProvider', () => {
     expect(client.plugins.realtime.subscribe).toHaveBeenCalled()
     expect(SharingProvider.prototype.fetchAllSharings).toHaveBeenCalled()
   })
+
+  it("should not call collection's methods but always subscribe to the realtime when isPublic is true", () => {
+    client.isLogged = true
+    render(<AppWrapper client={client} isPublic={true} />)
+
+    expect(SharingProvider.prototype.fetchAllSharings).toHaveBeenCalled()
+    expect(client.plugins.realtime.subscribe).toHaveBeenCalled()
+    expect(client.collection().findByDoctype).not.toHaveBeenCalled()
+    expect(client.collection().findLinksByDoctype).not.toHaveBeenCalled()
+    expect(client.collection().findApps).not.toHaveBeenCalled()
+  })
 })
 
 describe('hasWriteAccess', () => {

package/src/components/Recipient/OwnerRecipientDefaultLite.jsx

@@ -0,0 +1,32 @@
+import React from 'react'
+
+import { useClient, useQuery, hasQueryBeenLoaded } from 'cozy-client'
+
+import MemberRecipientLite from './MemberRecipientLite'
+import withLocales from '../../hoc/withLocales'
+import { buildInstanceSettingsQuery } from '../../queries/queries'
+
+const OwnerRecipientDefaultLite = () => {
+  const client = useClient()
+
+  const instanceSettingsQuery = buildInstanceSettingsQuery()
+  const instanceSettingsResult = useQuery(
+    instanceSettingsQuery.definition,
+    instanceSettingsQuery.options
+  )
+
+  return (
+    hasQueryBeenLoaded(instanceSettingsResult) && (
+      <MemberRecipientLite
+        recipient={{
+          status: 'owner',
+          instance: client.options.uri,
+          public_name: instanceSettingsResult?.data?.attributes?.public_name
+        }}
+        isOwner={true}
+      />
+    )
+  )
+}
+
+export default withLocales(OwnerRecipientDefaultLite)

package/src/index.jsx

@@ -16,6 +16,7 @@ export { SharingOwnerAvatar } from './SharingOwnerAvatar'
 export { SharedRecipients } from './SharedRecipients'
 export { default as MemberRecipientLite } from './components/Recipient/MemberRecipientLite'
 export { default as LinkRecipientLite } from './components/Recipient/LinkRecipientLite'
+export { default as OwnerRecipientDefaultLite } from './components/Recipient/OwnerRecipientDefaultLite'
 export { SharedRecipientsList } from './SharedRecipientsList'
 export { ShareButton } from './ShareButton'
 export { ShareModal } from './components/ShareModal/ShareModal'