feat: Move useRealtime from cozy-ui to cozy-realtime

packages/cozy-realtime/package.json

@@ -3,6 +3,7 @@
   "version": "3.12.2",
   "description": "Realtime interactions with cozy-stack using Websocket",
   "main": "dist/index.js",
+  "main": "dist/index.browser.js",
   "author": "Cozy",
   "license": "MIT",
   "homepage": "https://docs.cozy.io/en/cozy-realtime/README/",

packages/cozy-realtime/src/index.browser.js

@@ -0,0 +1,5 @@
+import CozyRealtime from './CozyRealtime'
+
+export { default as useRealtime } from './useRealtime'
+export { default as RealtimePlugin } from './RealtimePlugin'
+export default CozyRealtime

packages/cozy-realtime/src/useRealtime.js

@@ -0,0 +1,48 @@
+import { useEffect } from 'react'
+
+const useRealtime = (client, specs, deps) => {
+  if (!client.plugins || !client.plugins.realtime) {
+    console.error(
+      '[useRealtime] The provided CozyClient instance does not have a RealtimePlugin registered'
+    )
+    return
+  }
+
+  const subscribeRealtime = () => {
+    Object.entries(specs).forEach(([doctype, events]) => {
+      Object.entries(events).forEach(async ([event, callback]) => {
+        try {
+          await client.plugins.realtime.subscribe(event, doctype, callback)
+        } catch (err) {
+          console.error(err)
+          console.error(
+            `[useRealtime] Impossible to subscribe to ${event} event on ${doctype}. Does your app have the required permissions on this doctype?`
+          )
+        }
+      })
+    })
+  }
+
+  const unsubscribeRealtime = () => {
+    Object.entries(specs).forEach(([doctype, events]) => {
+      Object.entries(events).forEach(async ([event, callback]) => {
+        try {
+          await client.plugins.realtime.unsubscribe(event, doctype, callback)
+        } catch (err) {
+          console.error(err)
+          console.error(
+            `[useRealtime] Impossible to unsubscribe from ${event} event on ${doctype}. Does your app have the required permissions on this doctype?`
+          )
+        }
+      })
+    })
+  }
+
+  useEffect(() => {
+    subscribeRealtime()
+
+    return unsubscribeRealtime
+  }, deps)
+}
+
+export default useRealtime

packages/cozy-realtime/src/useRealtime.spec.js

@@ -0,0 +1,41 @@
+import useRealtime from './useRealtime'
+import { renderHook } from '@testing-library/react-hooks'
+
+it('should subscribe to realtime events according to given specs', () => {
+  const onCreateOrUpdate = jest.fn()
+
+  const specs = {
+    'io.cozy.apps': {
+      created: onCreateOrUpdate
+    },
+    'io.cozy.contacts': {
+      updated: onCreateOrUpdate
+    }
+  }
+
+  const mockClient = {
+    plugins: {
+      realtime: {
+        subscribe: jest.fn(),
+        unsubscribe: jest.fn(),
+        unsubscribeAll: jest.fn()
+      }
+    }
+  }
+
+  renderHook(() => useRealtime(mockClient, specs, []))
+
+  expect(mockClient.plugins.realtime.subscribe).toHaveBeenNthCalledWith(
+    1,
+    'created',
+    'io.cozy.apps',
+    onCreateOrUpdate
+  )
+
+  expect(mockClient.plugins.realtime.subscribe).toHaveBeenNthCalledWith(
+    2,
+    'updated',
+    'io.cozy.contacts',
+    onCreateOrUpdate
+  )
+})