cozy-sharing 6.0.6 → 7.0.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [7.0.0](https://github.com/cozy/cozy-libs/compare/cozy-sharing@6.0.6...cozy-sharing@7.0.0) (2023-03-16)
+
+
+### Features
+
+* Return also readOnly status from getSharedDocument ([c68ba61](https://github.com/cozy/cozy-libs/commit/c68ba61b69dfd2b152e47252005f294fee818110))
+
+
+### BREAKING CHANGES
+
+* The function now returns the id encapsulated in an object. You can extract the id like this `const { id } = getSharedDocument(client)`
+
+
+
+
+
 ## 6.0.6 (2023-03-16)
 
 **Note:** Version bump only for package cozy-sharing

package/dist/getSharedDocument.js

@@ -1,10 +1,16 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
-import get from 'lodash/get';
+import { isReadOnly } from 'cozy-client/dist/models/permission';
+/**
+ * Get the first shared document for the current shared token
+ *
+ * @param {CozyClient} client
+ * @returns {{id, isReadOnly}} id of the document and the readOnly status
+ */
 
 var getSharedDocument = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(client) {
-    var _yield$client$collect, permissionsData, permissions, sharedDocumentId;
+    var _yield$client$collect, permissionsData, permissions, perm;
 
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
@@ -15,10 +21,13 @@ var getSharedDocument = /*#__PURE__*/function () {
         case 2:
           _yield$client$collect = _context.sent;
           permissionsData = _yield$client$collect.data;
-          permissions = permissionsData.attributes.permissions; // permissions contains several named keys, but the one to use depends on the situation. Using the first one is what we want in all known cases.
+          permissions = Object.values(permissionsData.attributes.permissions); // permissions contains several named keys, but the one to use depends on the situation. Using the first one is what we want in all known cases.
 
-          sharedDocumentId = get(Object.values(permissions), '0.values.0');
-          return _context.abrupt("return", sharedDocumentId);
+          perm = permissions[0];
+          return _context.abrupt("return", {
+            id: perm.values[0],
+            isReadOnly: isReadOnly(perm)
+          });
 
         case 7:
         case "end":

package/dist/getSharedDocument.spec.js

@@ -1,8 +1,10 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import getSharedDocument from './getSharedDocument';
-describe('Getting the shared document id', function () {
-  var mockClient = {
+
+function setupClient() {
+  var verbs = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  return {
     collection: function collection() {
       return {
         getOwnPermissions: jest.fn().mockReturnValue({
@@ -11,14 +13,14 @@ describe('Getting the shared document id', function () {
               permissions: {
                 collection: {
                   type: 'io.cozy.photos.albums',
-                  verbs: ['GET'],
+                  verbs: verbs,
                   values: ['myshareid']
                 },
                 files: {
                   selector: 'referenced_by',
                   type: 'io.cozy.files',
                   values: ['io.cozy.photos.albums/myshareid'],
-                  verbs: ['GET']
+                  verbs: verbs
                 }
               }
             }
@@ -27,22 +29,91 @@ describe('Getting the shared document id', function () {
       };
     }
   };
+}
+
+describe('Getting the shared document', function () {
   it('should get the id', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-    var id;
+    var client, _yield$getSharedDocum, id;
+
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
-          _context.next = 2;
-          return getSharedDocument(mockClient);
+          client = setupClient(['GET']);
+          _context.next = 3;
+          return getSharedDocument(client);
 
-        case 2:
-          id = _context.sent;
+        case 3:
+          _yield$getSharedDocum = _context.sent;
+          id = _yield$getSharedDocum.id;
           expect(id).toEqual('myshareid');
 
-        case 4:
+        case 6:
         case "end":
           return _context.stop();
       }
     }, _callee);
   })));
+  it('should return isReadOnly is true when we have only a GET permission', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
+    var client, _yield$getSharedDocum2, isReadOnly;
+
+    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          client = setupClient(['GET']);
+          _context2.next = 3;
+          return getSharedDocument(client);
+
+        case 3:
+          _yield$getSharedDocum2 = _context2.sent;
+          isReadOnly = _yield$getSharedDocum2.isReadOnly;
+          expect(isReadOnly).toBeTruthy();
+
+        case 6:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  })));
+  it('should return isReadOnly is false when we have an ALL permission', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
+    var client, _yield$getSharedDocum3, isReadOnly;
+
+    return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
+        case 0:
+          client = setupClient(['ALL']);
+          _context3.next = 3;
+          return getSharedDocument(client);
+
+        case 3:
+          _yield$getSharedDocum3 = _context3.sent;
+          isReadOnly = _yield$getSharedDocum3.isReadOnly;
+          expect(isReadOnly).toBeFalsy();
+
+        case 6:
+        case "end":
+          return _context3.stop();
+      }
+    }, _callee3);
+  })));
+  it('should return isReadOnly is false when we have a PATCH permission', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4() {
+    var client, _yield$getSharedDocum4, isReadOnly;
+
+    return _regeneratorRuntime.wrap(function _callee4$(_context4) {
+      while (1) switch (_context4.prev = _context4.next) {
+        case 0:
+          client = setupClient(['GET', 'PATCH', 'PUT']);
+          _context4.next = 3;
+          return getSharedDocument(client);
+
+        case 3:
+          _yield$getSharedDocum4 = _context4.sent;
+          isReadOnly = _yield$getSharedDocum4.isReadOnly;
+          expect(isReadOnly).toBeFalsy();
+
+        case 6:
+        case "end":
+          return _context4.stop();
+      }
+    }, _callee4);
+  })));
 });

package/dist/state.js

@@ -461,9 +461,7 @@ var getApps = function getApps(state) {
 
 export var hasSharedParent = function hasSharedParent(state, documentPath) {
   if (!state.sharedPaths) {
-    // eslint-disable-next-line
-    console.log('hasSharedParent should not occur', state, documentPath);
-    return false;
+    return false; // hasSharedParent should not occur
   }
 
   return state.sharedPaths.some(function (path) {
@@ -472,9 +470,7 @@ export var hasSharedParent = function hasSharedParent(state, documentPath) {
 };
 export var hasSharedChild = function hasSharedChild(state, documentPath) {
   if (!state.sharedPaths) {
-    // eslint-disable-next-line
-    console.log('hasSharedChild should not occur', state, documentPath);
-    return false;
+    return false; // hasSharedChild should not occur
   }
 
   var ret = state.sharedPaths.some(function (path) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cozy-sharing",
-  "version": "6.0.6",
+  "version": "7.0.0",
   "description": "Provides sharing login for React applications.",
   "main": "dist/index.js",
   "author": "Cozy",
@@ -61,5 +61,5 @@
   "sideEffects": [
     "*.css"
   ],
-  "gitHead": "94b2b5a6a105edfc6fc7a20204291d2191ba2ba1"
+  "gitHead": "b623a595cc50731ff2bf2db93f0533cf1553530a"
 }

package/src/getSharedDocument.js

@@ -1,15 +1,23 @@
-import get from 'lodash/get'
+import { isReadOnly } from 'cozy-client/dist/models/permission'
 
+/**
+ * Get the first shared document for the current shared token
+ *
+ * @param {CozyClient} client
+ * @returns {{id, isReadOnly}} id of the document and the readOnly status
+ */
 const getSharedDocument = async client => {
   const { data: permissionsData } = await client
     .collection('io.cozy.permissions')
     .getOwnPermissions()
 
-  const permissions = permissionsData.attributes.permissions
+  const permissions = Object.values(permissionsData.attributes.permissions)
   // permissions contains several named keys, but the one to use depends on the situation. Using the first one is what we want in all known cases.
-  const sharedDocumentId = get(Object.values(permissions), '0.values.0')
-
-  return sharedDocumentId
+  const perm = permissions[0]
+  return {
+    id: perm.values[0],
+    isReadOnly: isReadOnly(perm)
+  }
 }
 
 export default getSharedDocument

package/src/getSharedDocument.spec.js

@@ -1,7 +1,7 @@
 import getSharedDocument from './getSharedDocument'
 
-describe('Getting the shared document id', () => {
-  const mockClient = {
+function setupClient(verbs = []) {
+  return {
     collection: () => ({
       getOwnPermissions: jest.fn().mockReturnValue({
         data: {
@@ -9,14 +9,14 @@ describe('Getting the shared document id', () => {
             permissions: {
               collection: {
                 type: 'io.cozy.photos.albums',
-                verbs: ['GET'],
+                verbs,
                 values: ['myshareid']
               },
               files: {
                 selector: 'referenced_by',
                 type: 'io.cozy.files',
                 values: ['io.cozy.photos.albums/myshareid'],
-                verbs: ['GET']
+                verbs
               }
             }
           }
@@ -24,9 +24,30 @@ describe('Getting the shared document id', () => {
       })
     })
   }
+}
 
+describe('Getting the shared document', () => {
   it('should get the id', async () => {
-    const id = await getSharedDocument(mockClient)
+    const client = setupClient(['GET'])
+    const { id } = await getSharedDocument(client)
     expect(id).toEqual('myshareid')
   })
+
+  it('should return isReadOnly is true when we have only a GET permission', async () => {
+    const client = setupClient(['GET'])
+    const { isReadOnly } = await getSharedDocument(client)
+    expect(isReadOnly).toBeTruthy()
+  })
+
+  it('should return isReadOnly is false when we have an ALL permission', async () => {
+    const client = setupClient(['ALL'])
+    const { isReadOnly } = await getSharedDocument(client)
+    expect(isReadOnly).toBeFalsy()
+  })
+
+  it('should return isReadOnly is false when we have a PATCH permission', async () => {
+    const client = setupClient(['GET', 'PATCH', 'PUT'])
+    const { isReadOnly } = await getSharedDocument(client)
+    expect(isReadOnly).toBeFalsy()
+  })
 })

package/src/state.js

@@ -349,18 +349,14 @@ const getApps = state => state.apps
 
 export const hasSharedParent = (state, documentPath) => {
   if (!state.sharedPaths) {
-    // eslint-disable-next-line
-    console.log('hasSharedParent should not occur', state, documentPath)
-    return false
+    return false // hasSharedParent should not occur
   }
   return state.sharedPaths.some(path => documentPath.indexOf(`${path}/`) === 0)
 }
 
 export const hasSharedChild = (state, documentPath) => {
   if (!state.sharedPaths) {
-    // eslint-disable-next-line
-    console.log('hasSharedChild should not occur', state, documentPath)
-    return false
+    return false // hasSharedChild should not occur
   }
   const ret = state.sharedPaths.some(
     path => path.indexOf(`${documentPath}/`) === 0