feat(NotesCollection): Add get method

This method will allow me to use real time on cozy-notes
cozy · Dec 19, 2023 · 72574fb · 72574fb
1 parent 383cfd5
commit 72574fb
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 0 deletions.
diff --git a/docs/api/cozy-stack-client.md b/docs/api/cozy-stack-client.md
@@ -1181,12 +1181,25 @@ Implements `DocumentCollection` API to interact with the /notes endpoint of the
 **Kind**: global class  
 
 * [NotesCollection](#NotesCollection)
+    * [.get(id)](#NotesCollection+get) ⇒ <code>Object</code>
     * [.all()](#NotesCollection+all) ⇒ <code>Object</code>
     * [.destroy(note)](#NotesCollection+destroy) ⇒ <code>Object</code>
     * [.create(options)](#NotesCollection+create) ⇒ <code>Object</code>
     * [.fetchURL(note)](#NotesCollection+fetchURL) ⇒ <code>Object</code>
     * [.getDefaultSchema()](#NotesCollection+getDefaultSchema) ⇒ <code>object</code>
 
+<a name="NotesCollection+get"></a>
+
+### notesCollection.get(id) ⇒ <code>Object</code>
+Fetches the note data
+
+**Kind**: instance method of [<code>NotesCollection</code>](#NotesCollection)  
+**Returns**: <code>Object</code> - Information about the note  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| id | <code>string</code> | Note id |
+
 <a name="NotesCollection+all"></a>
 
 ### notesCollection.all() ⇒ <code>Object</code>

diff --git a/packages/cozy-stack-client/src/NotesCollection.js b/packages/cozy-stack-client/src/NotesCollection.js
@@ -23,6 +23,20 @@ class NotesCollection extends DocumentCollection {
     super(NOTES_DOCTYPE, stackClient)
   }
 
+  /**
+   * Fetches the note data
+   *
+   * @param {string} id Note id
+   * @returns {{data}} Information about the note
+   */
+  async get(id) {
+    const resp = await this.stackClient.fetchJSON('GET', `/notes/${id}`)
+
+    return {
+      data: normalizeNote(resp.data)
+    }
+  }
+
   /**
    * Fetches all notes
    *

diff --git a/packages/cozy-stack-client/src/NotesCollection.spec.js b/packages/cozy-stack-client/src/NotesCollection.spec.js
@@ -17,6 +17,37 @@ describe('NotesCollection', () => {
     jest.restoreAllMocks()
   })
 
+  describe('get', () => {
+    const { stackClient, collection } = setup()
+
+    it('should call the appropriate route', async () => {
+      jest.spyOn(stackClient, 'fetchJSON').mockResolvedValue({
+        data: [],
+        links: {},
+        meta: { count: 0 }
+      })
+
+      await collection.get('id123')
+      expect(stackClient.fetchJSON).toHaveBeenCalledWith('GET', '/notes/id123')
+    })
+
+    it('should normalize document', async () => {
+      jest.spyOn(stackClient, 'fetchJSON').mockResolvedValue({
+        data: { _id: '1', attributes: { title: 'Test Note' } },
+        links: {},
+        meta: { count: 0 }
+      })
+      const result = await collection.get('id123')
+      expect(result.data).toEqual({
+        _id: '1',
+        _type: 'io.cozy.notes',
+        id: '1',
+        title: 'Test Note',
+        attributes: { title: 'Test Note' }
+      })
+    })
+  })
+
   describe('all', () => {
     const { stackClient, collection } = setup()