feat: more information on block children and collection view endpoints

This change puts more information on the blocks/<block_id>/children and
/collections/<collection_id>/<view_id> endpoints. This allows the
'parent' block or collection itself to be represented in the response.

Ultimately, this can save an API call to get the title of the parent and
collection.

Author: kevinjalbert

server/src/api.py

@@ -98,9 +98,9 @@ def block_children_view(notion_token, block_id):
     try:
         notion_api = NotionApi(notion_token)
 
-        children = notion_api.block_children(block_id)
+        content = notion_api.block_children(block_id)
 
-        return jsonify(children=children), 200
+        return jsonify(content), 200
     except Exception as error:
         return jsonify(error=str(error)), 500
 
@@ -126,7 +126,7 @@ def collection_view(notion_token, collection_id, view_id):
 
         content = notion_api.collection_view_content(collection_id, view_id)
 
-        return jsonify(rows=content), 200
+        return jsonify(content), 200
     except Exception as error:
         return jsonify(error=str(error)), 500
 

shared/notionscripts/block_presenter.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env -S PATH="${PATH}:/usr/local/bin" python3
 
-from notion.collection import CollectionRowBlock
+from notion.collection import CollectionRowBlock, CollectionView
 
 
 class BlockPresenter(dict):
@@ -9,5 +9,7 @@ def __init__(self, block):
         self.block = block
         if isinstance(block, CollectionRowBlock):
             dict.__init__(self, **{"id": block.id, **block.get_all_properties()})
+        elif isinstance(block, CollectionView):
+            dict.__init__(self, **{"collection_id": block.parent.id, "view_id": block.id, "collection_title": block.parent.title, "view_title": block.name})
         else:
             dict.__init__(self, **{"id": block.id, "title": block.title})

shared/notionscripts/notion_api.py

@@ -27,7 +27,10 @@ def block_content(self, block_id):
     def block_children(self, block_id):
         block = self.client().get_block(block_id)
 
-        return [BlockPresenter(child) for child in block.children]
+        return {
+            "parent": BlockPresenter(block),
+            "children": [BlockPresenter(child) for child in block.children]
+        }
 
     def block_append(self, block_id, data):
         block = self.client().get_block(block_id)
@@ -58,7 +61,10 @@ def collection_view_content(self, collection_id, view_id):
         collection_view = self.__collection_view(collection_id, view_id)
         results = collection_view.default_query().execute()
 
-        return [BlockPresenter(row) for row in results]
+        return {
+            "collection": BlockPresenter(collection_view),
+            "rows": [BlockPresenter(row) for row in results]
+        }
 
     def collection_append(self, collection_id, view_id, data):
         collection_view = self.__collection_view(collection_id, view_id)

shared/notionscripts/tests/notion_api_page_helper.py

@@ -90,5 +90,6 @@ def create_collection_view():
     )
     cvb.title = "Test collection"
     view = cvb.views.add_new(view_type="table")
+    view.name = "Test view"
 
     return view

shared/notionscripts/tests/test_notion_api.py

@@ -28,8 +28,9 @@ def test_block_children(notion_token):
 
     content = notion_api.block_children(block.id)
 
-    assert content[0] == {"id": child_block_1.id, "title": "child block 1"}
-    assert content[1] == {"id": child_block_2.id, "title": "child block 2"}
+    assert content["parent"] == {"id": block.id, "title": "a parent block"}
+    assert content["children"][0] == {"id": child_block_1.id, "title": "child block 1"}
+    assert content["children"][1] == {"id": child_block_2.id, "title": "child block 2"}
 
 
 def test_block_append(notion_token):
@@ -106,13 +107,19 @@ def test_collection_view_content(notion_token):
     notion_api = NotionApi(token=notion_token)
 
     collection_view = create_collection_view()
-    collection_id = collection_view.parent.id.replace("-", "")
-    view_id = collection_view.id.replace("-", "")
+    collection_id = collection_view.parent.id
+    view_id = collection_view.id
 
     collection_view.collection.add_row(name="test row")
-    collection_view_content = notion_api.collection_view_content(collection_id, view_id)
+    collection_view_content = notion_api.collection_view_content(collection_id.replace("-", ""), view_id.replace("-", ""))
 
-    assert collection_view_content[0]["name"] == "test row"
+    assert collection_view_content["collection"] == {
+        "collection_id": collection_id,
+        "view_id": view_id,
+        "collection_title": "Test collection",
+        "view_title": "Test view"
+    }
+    assert collection_view_content["rows"][0]["name"] == "test row"
 
 
 def test_collection_view_append(notion_token):
@@ -125,6 +132,6 @@ def test_collection_view_append(notion_token):
     notion_api.collection_append(collection_id, view_id, {"enabled": True, "value": 10, "name": "test row"})
     collection_view_content = notion_api.collection_view_content(collection_id, view_id)
 
-    assert collection_view_content[0]["name"] == "test row"
-    assert collection_view_content[0]["enabled"] is True
-    assert collection_view_content[0]["value"] == 10
+    assert collection_view_content["rows"][0]["name"] == "test row"
+    assert collection_view_content["rows"][0]["enabled"] is True
+    assert collection_view_content["rows"][0]["value"] == 10