Carry per-access folder counts through tree response transformers

Author: ErykKul

src/datasets/domain/models/FileTreeNode.ts

@@ -20,6 +20,18 @@ export interface FileTreeFolderNode {
      * `originals=true`.
      */
     bytes: number
+    /**
+     * Files in the subtree marked restricted. Mirrors the per-file
+     * `access` resolution: a row that is both restricted and embargoed
+     * is counted here, not in `embargoed`.
+     */
+    restricted: number
+    /**
+     * Non-restricted files in the subtree whose embargo has not yet
+     * lapsed. The "public" count is implied: `files - restricted -
+     * embargoed`.
+     */
+    embargoed: number
   }
 }
 

src/datasets/infra/repositories/transformers/fileTreeTransformers.ts

@@ -11,7 +11,13 @@ interface FolderItemPayload {
   type: 'folder'
   name: string
   path: string
-  counts?: { files: number; folders: number; bytes: number }
+  counts?: {
+    files: number
+    folders: number
+    bytes: number
+    restricted: number
+    embargoed: number
+  }
 }
 
 interface FileItemPayload {

test/unit/datasets/ListDatasetTreeNode.test.ts

@@ -16,7 +16,13 @@ describe('ListDatasetTreeNode (unit)', () => {
         type: FileTreeNodeType.FOLDER,
         name: 'sub',
         path: 'data/sub',
-        counts: { files: 1, folders: 0, bytes: 1024 }
+        counts: {
+          files: 1,
+          folders: 0,
+          bytes: 1024,
+          restricted: 0,
+          embargoed: 0
+        }
       },
       {
         type: FileTreeNodeType.FILE,

test/unit/datasets/fileTreeTransformers.test.ts

@@ -25,7 +25,13 @@ describe('transformTreeResponseToFileTreePage', () => {
           type: 'folder',
           name: 'raw',
           path: 'data/raw',
-          counts: { files: 3, folders: 0, bytes: 4096 }
+          counts: {
+            files: 3,
+            folders: 0,
+            bytes: 4096,
+            restricted: 0,
+            embargoed: 0
+          }
         },
         {
           type: 'file',
@@ -60,7 +66,13 @@ describe('transformTreeResponseToFileTreePage', () => {
       throw new Error('expected folder')
     }
     expect(folder.name).toBe('raw')
-    expect(folder.counts).toEqual({ files: 3, folders: 0, bytes: 4096 })
+    expect(folder.counts).toEqual({
+      files: 3,
+      folders: 0,
+      bytes: 4096,
+      restricted: 0,
+      embargoed: 0
+    })
 
     const file = page.items[1]
     if (!isFileTreeFileNode(file)) {