cozy-sharing 40.1.9 → 40.2.1

package/src/helpers/contacts.js

@@ -2,13 +2,30 @@ import { models } from 'cozy-client'
 import flag from 'cozy-flags'
 
 import { validateEmail } from '../helpers/email'
+import { DOCTYPE_CONTACTS, DOCTYPE_GROUPS } from '../models'
 
 const ContactModel = models.contact
 
 // Return the contact object if present
 // Else check if a contact exist with this email address, if yes return it
 // if not create it
-export const getOrCreateFromArray = async (client, contacts, createContact) => {
+// With contactsSuggestEnabled, people are sent by email and the
+// stack finds or creates the contact: an org member's id is not on this instance
+export const getOrCreateFromArray = async (
+  client,
+  contacts,
+  createContact,
+  contactsSuggestEnabled
+) => {
+  if (contactsSuggestEnabled) {
+    return contacts.map(contact => {
+      if (contact._type === DOCTYPE_GROUPS) return contact
+      const email = ContactModel.getPrimaryEmail(contact)
+      if (validateEmail(email)) return { _type: DOCTYPE_CONTACTS, email }
+      return contact._id ? contact : undefined
+    })
+  }
+
   return await Promise.all(
     contacts.map(async contact => {
       if (contact.id) {
@@ -45,6 +62,19 @@ export const getOrCreateFromArray = async (client, contacts, createContact) => {
   )
 }
 
+// A suggestion without id has no contact document, and only a fullname,
+// which getDisplayName does not read
+export const suggestContacts = async (client, q) => {
+  const { data } = await client
+    .getStackClient()
+    .fetchJSON('GET', `/contacts/suggest?q=${encodeURIComponent(q)}`)
+  return data.map(({ id, type, attributes }) => ({
+    ...attributes,
+    ...(id ? { _id: id, id } : { displayName: attributes.fullname }),
+    _type: type
+  }))
+}
+
 export const getContactsFromGroupId = (contacts = [], groupId) => {
   return contacts.filter(contact => {
     return contact.relationships?.groups?.data?.some(

package/src/helpers/contacts.spec.js

@@ -1,6 +1,10 @@
 import flag from 'cozy-flags'
 
-import { computeContactsAndGroups, getOrCreateFromArray } from './contacts'
+import {
+  computeContactsAndGroups,
+  getOrCreateFromArray,
+  suggestContacts
+} from './contacts'
 
 jest.mock('cozy-flags', () => ({
   __esModule: true,
@@ -128,3 +132,100 @@ describe('computeContactsAndGroups', () => {
     expect(contactsAndGroups.map(c => c._id)).toEqual(['alice', 'bob'])
   })
 })
+
+describe('getOrCreateFromArray with contactsSuggestEnabled', () => {
+  it('should send people by email and keep groups, without creating contacts', async () => {
+    const createContact = jest.fn()
+    const group = { _id: 'group-1', _type: 'io.cozy.contacts.groups' }
+
+    const recipients = await getOrCreateFromArray(
+      mockClient,
+      [
+        {
+          _id: 'org-member-1',
+          _type: 'io.cozy.contacts',
+          email: [{ address: 'member@org.example', primary: true }],
+          meta: { kind: 'member' }
+        },
+        { email: 'unknown@friends.example' },
+        group
+      ],
+      createContact,
+      true
+    )
+
+    expect(recipients).toEqual([
+      { _type: 'io.cozy.contacts', email: 'member@org.example' },
+      { _type: 'io.cozy.contacts', email: 'unknown@friends.example' },
+      group
+    ])
+    expect(createContact).not.toHaveBeenCalled()
+  })
+
+  it('should keep a contact without email by id, and drop a recipient with neither', async () => {
+    const cozyOnlyContact = {
+      _id: 'contact-1',
+      _type: 'io.cozy.contacts',
+      cozy: [{ url: 'https://bob.example' }]
+    }
+
+    const recipients = await getOrCreateFromArray(
+      mockClient,
+      [cozyOnlyContact, { instance: 'https://alice.example' }],
+      jest.fn(),
+      true
+    )
+
+    expect(recipients).toEqual([cozyOnlyContact, undefined])
+  })
+})
+
+describe('suggestContacts', () => {
+  it('should map the suggestions of the stack to contacts', async () => {
+    const fetchJSON = jest.fn().mockResolvedValue({
+      data: [
+        {
+          type: 'io.cozy.contacts',
+          id: 'org-member-1',
+          attributes: {
+            fullname: 'Jean Dupont',
+            name: { givenName: 'Jean', familyName: 'Dupont' },
+            email: [{ address: 'jean@org.example', primary: true }]
+          },
+          meta: { kind: 'member' }
+        },
+        {
+          type: 'io.cozy.contacts',
+          attributes: {
+            fullname: 'Paul Dupuis',
+            email: [{ address: 'paul@friends.example', primary: true }]
+          }
+        }
+      ]
+    })
+    const client = { getStackClient: () => ({ fetchJSON }) }
+
+    const contacts = await suggestContacts(client, 'dup & co')
+
+    expect(fetchJSON).toHaveBeenCalledWith(
+      'GET',
+      '/contacts/suggest?q=dup%20%26%20co'
+    )
+    expect(contacts).toEqual([
+      {
+        _id: 'org-member-1',
+        id: 'org-member-1',
+        _type: 'io.cozy.contacts',
+        fullname: 'Jean Dupont',
+        name: { givenName: 'Jean', familyName: 'Dupont' },
+        email: [{ address: 'jean@org.example', primary: true }]
+      },
+      {
+        _type: 'io.cozy.contacts',
+        fullname: 'Paul Dupuis',
+        displayName: 'Paul Dupuis',
+        email: [{ address: 'paul@friends.example', primary: true }]
+      }
+    ])
+  })
+})

package/src/helpers/recipients.js

@@ -1,3 +1,4 @@
+import { getPrimaryCozy } from 'cozy-client/dist/models/contact'
 import flag from 'cozy-flags'
 
 import { DOCTYPE_GROUPS } from '../models'
@@ -143,3 +144,42 @@ export const hasMemberActions = ({
   canManageMembers &&
   status !== 'owner' &&
   ((isCurrentUser && !isOwner) || canManageSharing)
+
+/**
+ * makeAvatarUrl derives the avatar image URL for the recipient.
+ * - If the recipient has an avatarPath (sharing context), it is
+ *   used directly with a base URI prefix (unless it is already
+ *   a full URL for a remote Cozy).
+ * - If the recipient has no avatarPath but has a cozy URL
+ *   (contact context), it points to that Cozy's public avatar.
+ * - The status is used as a cache-buster in the URL so the
+ *   browser refreshes the image when the sharing status changes.
+ *   For non-sharing recipients, 'contact' is the stable default.
+ */
+export const makeAvatarUrl = (recipient, instanceUri) => {
+  const avatarPath = recipient.avatarPath
+  const cozyUrl = !avatarPath ? getPrimaryCozy(recipient) : null
+  if (!avatarPath && !cozyUrl) return null
+
+  const finalPath =
+    avatarPath ||
+    `${cozyUrl.replace(/\/$/, '')}/public/avatar?fallback=initials`
+  const status = recipient.status || 'contact'
+  const isFullPath = finalPath.startsWith('http')
+  const base = isFullPath ? '' : instanceUri
+  return `${base}${finalPath}${finalPath.includes('?') ? '&' : '?'}v=${status}`
+}
+
+/**
+ * Adds to the recipients, except groups, the URL of their avatar
+ *
+ * @param {object[]} recipients - Recipients of a sharing
+ * @param {string} instanceUri - URI of the current user's instance
+ * @returns {object[]} The recipients with their `avatarUrl`
+ */
+export const addAvatarUrls = (recipients, instanceUri) =>
+  recipients.map(recipient =>
+    recipient.members
+      ? recipient
+      : { ...recipient, avatarUrl: makeAvatarUrl(recipient, instanceUri) }
+  )

package/src/helpers/recipients.spec.js

@@ -1,4 +1,9 @@
-import { hasMemberActions, markCurrentUser } from './recipients'
+import {
+  addAvatarUrls,
+  hasMemberActions,
+  makeAvatarUrl,
+  markCurrentUser
+} from './recipients'
 
 const instanceUri = 'https://alice.cozy.cc'
 
@@ -80,3 +85,80 @@ describe('hasMemberActions', () => {
     expect(hasMemberActions({ ...memberRights, status: 'ready' })).toBe(false)
   })
 })
+
+describe('makeAvatarUrl', () => {
+  const instanceUri = 'http://cozy.example.com'
+
+  it('prefixes the avatarPath with the instance URI and the status', () => {
+    expect(
+      makeAvatarUrl(
+        { status: 'owner', avatarPath: '/sharings/123/recipients/0/avatar' },
+        instanceUri
+      )
+    ).toBe('http://cozy.example.com/sharings/123/recipients/0/avatar?v=owner')
+  })
+
+  it('appends the status with & when avatarPath already has a query string', () => {
+    expect(
+      makeAvatarUrl(
+        { status: 'owner', avatarPath: '/public/avatar?fallback=initials' },
+        instanceUri
+      )
+    ).toBe('http://cozy.example.com/public/avatar?fallback=initials&v=owner')
+  })
+
+  it('does not prefix a full URL avatarPath with the instance URI', () => {
+    expect(
+      makeAvatarUrl(
+        {
+          status: 'contact',
+          avatarPath:
+            'https://jonsnow.mycozy.cloud/public/avatar?fallback=initials'
+        },
+        instanceUri
+      )
+    ).toBe(
+      'https://jonsnow.mycozy.cloud/public/avatar?fallback=initials&v=contact'
+    )
+  })
+
+  it('points to the public avatar of the contact cozy when there is no avatarPath', () => {
+    expect(
+      makeAvatarUrl(
+        {
+          _type: 'io.cozy.contacts',
+          cozy: [{ url: 'https://jonsnow.mycozy.cloud' }]
+        },
+        instanceUri
+      )
+    ).toBe(
+      'https://jonsnow.mycozy.cloud/public/avatar?fallback=initials&v=contact'
+    )
+  })
+
+  it('returns null when there is no avatarPath and no cozy URL', () => {
+    expect(
+      makeAvatarUrl(
+        { _type: 'io.cozy.contacts', public_name: 'Bob' },
+        instanceUri
+      )
+    ).toBe(null)
+  })
+})
+
+describe('addAvatarUrls', () => {
+  it('adds the avatar URL to the members but not to the groups', () => {
+    const [member, group] = addAvatarUrls(
+      [
+        { status: 'ready', avatarPath: '/sharings/123/recipients/1/avatar' },
+        { name: 'Team', members: [] }
+      ],
+      'http://cozy.example.com'
+    )
+
+    expect(member.avatarUrl).toBe(
+      'http://cozy.example.com/sharings/123/recipients/1/avatar?v=ready'
+    )
+    expect(group).not.toHaveProperty('avatarUrl')
+  })
+})

package/src/hooks/useResolveRecipients.js

@@ -2,6 +2,7 @@ import { useCallback } from 'react'
 
 import { useClient } from 'cozy-client'
 
+import { useSharingContext } from './useSharingContext'
 import { getOrCreateFromArray } from '../helpers/contacts'
 import { DOCTYPE_CONTACTS } from '../models'
 
@@ -14,6 +15,7 @@ import { DOCTYPE_CONTACTS } from '../models'
  */
 export const useResolveRecipients = () => {
   const client = useClient()
+  const contactsSuggestEnabled = useSharingContext()?.contactsSuggestEnabled
 
   return useCallback(
     async (
@@ -24,7 +26,8 @@ export const useResolveRecipients = () => {
       const contacts = await getOrCreateFromArray(
         client,
         pendingRecipients,
-        createContact
+        createContact,
+        contactsSuggestEnabled
       )
       const isReadOnly = selectedOption === 'readOnly'
 
@@ -33,6 +36,6 @@ export const useResolveRecipients = () => {
         readOnlyRecipients: isReadOnly ? contacts : []
       }
     },
-    [client]
+    [client, contactsSuggestEnabled]
   )
 }

package/src/hooks/useResolveRecipients.spec.js

@@ -13,6 +13,10 @@ jest.mock('../helpers/contacts', () => ({
   getOrCreateFromArray: jest.fn()
 }))
 
+jest.mock('./useSharingContext', () => ({
+  useSharingContext: () => ({ contactsSuggestEnabled: true })
+}))
+
 const contacts = [{ _id: 'alice' }, { _id: 'bob' }]
 
 describe('useResolveRecipients', () => {
@@ -48,7 +52,8 @@ describe('useResolveRecipients', () => {
     expect(getOrCreateFromArray).toHaveBeenCalledWith(
       mockClient,
       pendingRecipients,
-      expect.any(Function)
+      expect.any(Function),
+      true
     )
     expect(mockClient.create).toHaveBeenCalledWith('io.cozy.contacts', {
       email: [{ address: 'alice@cozy.cc' }]
@@ -64,7 +69,8 @@ describe('useResolveRecipients', () => {
     expect(getOrCreateFromArray).toHaveBeenCalledWith(
       mockClient,
       [],
-      createContact
+      createContact,
+      true
     )
   })
 })

package/src/index.jsx

@@ -10,7 +10,7 @@ export { useSharingContext } from './hooks/useSharingContext'
 export { useFetchDocumentPath } from './hooks/useFetchDocumentPath'
 
 export { GroupAvatar } from './components/Avatar/GroupAvatar'
-export { MemberAvatar } from './components/Avatar/MemberAvatar'
+export { MemberAvatarWrapper as MemberAvatar } from './components/Avatar/MemberAvatarWrapper'
 export { SharedDocument } from './SharedDocument'
 export { SharedStatus } from './SharedStatus'
 export { SharedBadge } from './SharedBadge'

package/src/queries/queries.js

@@ -16,7 +16,7 @@ export const buildSharingsByIdQuery = sharingId => ({
   }
 })
 
-export const buildReachableContactsQuery = () => ({
+export const buildReachableContactsQuery = ({ inGroups } = {}) => ({
   definition: Q(DOCTYPE_CONTACTS)
     .where({
       _id: {
@@ -42,12 +42,15 @@ export const buildReachableContactsQuery = () => ({
             }
           }
         }
-      ]
+      ],
+      ...(inGroups && { 'relationships.groups.data': { $exists: true } })
     })
     .indexFields(['_id'])
     .limitBy(1000),
   options: {
-    as: 'io.cozy.contacts/reachable'
+    as: inGroups
+      ? 'io.cozy.contacts/reachable-with-groups'
+      : 'io.cozy.contacts/reachable'
   }
 })