feat: upload/remove returns removed item (#289)

needed by storacha/w3cli#20 to find which shards to also remove when removing an upload License: MIT Signed-off-by: Oli Evans <[email protected]>
storacha · Dec 13, 2022 · 5e6681f · 5e6681f
1 parent 66be860
commit 5e6681f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/packages/upload-client/src/types.ts b/packages/upload-client/src/types.ts
@@ -36,7 +36,7 @@ export interface Service {
   upload: {
     add: ServiceMethod<UploadAdd, UploadAddResponse, never>
     list: ServiceMethod<UploadList, ListResponse<UploadListResult>, never>
-    remove: ServiceMethod<UploadRemove, null, never>
+    remove: ServiceMethod<UploadRemove, UploadRemoveResponse | undefined, never>
   }
 }
 
@@ -51,6 +51,8 @@ export interface UploadAddResponse {
   shards?: CARLink[]
 }
 
+export interface UploadRemoveResponse extends UploadAddResponse {}
+
 export interface ListResponse<R> {
   cursor?: string
   size: number

diff --git a/packages/upload-client/src/upload.js b/packages/upload-client/src/upload.js
@@ -151,4 +151,6 @@ export async function remove(
       cause: result,
     })
   }
+
+  return result
 }
diff --git a/packages/upload-client/test/upload.test.js b/packages/upload-client/test/upload.test.js
@@ -367,7 +367,7 @@ describe('Upload.remove', () => {
           assert.equal(invCap.can, UploadCapabilities.remove.can)
           assert.equal(invCap.with, space.did())
           assert.equal(String(invCap.nb?.root), car.roots[0].toString())
-          return null
+          return { root: car.roots[0] }
         }),
       },
     })
-Original file line number
+Diff line change
@@ Expand Up / @@ -151,4 +151,6 @@ export async function remove( @@
           cause: result,
         })
       }
+      return result
     }