fix(upload-api): fix incompatibilities with w3infra (#504)

This PR makes changes needed for
storacha/w3infra#154 namely:

1. Fixes type mappings in `package.json`, otherwise TS is confused in
w3infra.
2. Removes obsolete `index.js` file that lives in w3infra now.
3. Exports types so they can be used from w3infra.
4. Updates return type from `undefined` to `null` to match what w3infra
implementation returns.

packages/upload-api/package.json

@@ -2,16 +2,23 @@
   "name": "@web3-storage/upload-api",
   "version": "1.0.1",
   "type": "module",
+  "main": "./src/lib.js",
   "typesVersions": {
     "*": {
-      "*": [
-        "dist/src/*"
-      ],
-      "dist/src/lib.d.ts": [
+      "src/lib.js": [
         "dist/src/lib.d.ts"
       ],
+      "store": [
+        "dist/src/store.d.ts"
+      ],
+      "upload": [
+        "dist/src/upload.d.ts"
+      ],
+      "types": [
+        "dist/src/types.d.ts"
+      ],
       "test": [
-        "dist/test/*"
+        "dist/test/lib.d.ts"
       ]
     }
   },
@@ -45,7 +52,6 @@
     "test-watch": "pnpm build && mocha --bail --timeout 10s --watch --parallel -n no-warnings -n experimental-vm-modules --watch-files src,test"
   },
   "dependencies": {
-    "@sentry/serverless": "^7.22.0",
     "@ucanto/client": "^5.1.0",
     "@ucanto/interface": "^6.0.0",
     "@ucanto/principal": "^5.1.0",

packages/upload-api/src/lib.js

@@ -5,6 +5,7 @@ import * as CAR from '@ucanto/transport/car'
 import * as CBOR from '@ucanto/transport/cbor'
 import { createService as createStoreService } from './store.js'
 import { createService as createUploadService } from './upload.js'
+export * from './types.js'
 
 /**
  * @param {Types.UcantoServerContext} options

packages/upload-api/src/types.ts

@@ -34,7 +34,7 @@ export interface Service {
   upload: {
     add: ServiceMethod<UploadAdd, UploadAddOk, Failure>
     // @todo - Use proper type when no item was removed instead of undefined
-    remove: ServiceMethod<UploadRemove, UploadRemoveOk | undefined, Failure>
+    remove: ServiceMethod<UploadRemove, UploadRemoveOk | null, Failure>
     list: ServiceMethod<UploadList, UploadListOk, Failure>
   }
 }
@@ -70,7 +70,6 @@ export interface UcantoServerTestContext
 
 export interface StoreTestContext {
   testStoreTable: TestStoreTable
-  testUploadTable: TestUploadTable
   testSpaceRegistry: TestSpaceRegistry
 }
 
@@ -129,20 +128,13 @@ export interface TestStoreTable {
 export interface UploadTable {
   exists: (space: DID, root: UnknownLink) => Promise<boolean>
   insert: (item: UploadAddInput) => Promise<UploadAddOk>
-  remove: (space: DID, root: UnknownLink) => Promise<UploadRemoveOk | undefined>
+  remove: (space: DID, root: UnknownLink) => Promise<UploadRemoveOk | null>
   list: (
     space: DID,
     options?: ListOptions
   ) => Promise<ListResponse<UploadListItem>>
 }
 
-export interface TestUploadTable {
-  get(
-    space: DID,
-    root: UnknownLink
-  ): Promise<(UploadAddInput & UploadListItem) | undefined>
-}
-
 export interface StoreAddInput {
   space: DID
   link: UnknownLink
@@ -232,12 +224,16 @@ export interface SpaceUnknown extends Failure {
 }
 
 export interface Assert {
-  equal: (actual: unknown, expected: unknown, message?: string | Error) => void
-  deepEqual: (
-    actual: unknown,
-    expected: unknown,
-    message?: string | Error
-  ) => void
+  equal: <Actual, Expected extends Actual>(
+    actual: Actual,
+    expected: Expected,
+    message?: string
+  ) => unknown
+  deepEqual: <Actual, Expected extends Actual>(
+    actual: Actual,
+    expected: Expected,
+    message?: string
+  ) => unknown
 }
 
 export type Test = (assert: Assert, context: UcantoServerTestContext) => unknown

packages/upload-api/src/upload/remove.js

@@ -4,7 +4,7 @@ import * as API from '../types.js'
 
 /**
  * @param {API.UploadServiceContext} context
- * @returns {API.ServiceMethod<API.UploadRemove, API.UploadRemoveOk | undefined, API.Failure>}
+ * @returns {API.ServiceMethod<API.UploadRemove, API.UploadRemoveOk | null, API.Failure>}
  */
 export function uploadRemoveProvider(context) {
   return Server.provide(Upload.remove, async ({ capability }) => {

packages/upload-api/test/store.js

@@ -43,7 +43,7 @@ export const test = {
     assert.equal(storeAdd.with, spaceDid)
     assert.deepEqual(storeAdd.link, link)
 
-    assert.deepEqual(storeAdd.headers?.['content-length'], size)
+    assert.equal(storeAdd.headers?.['content-length'], String(size))
     assert.deepEqual(
       storeAdd.headers?.['x-amz-checksum-sha256'],
       base64pad.baseEncode(link.multihash.digest)
@@ -80,17 +80,17 @@ export const test = {
     }
 
     assert.deepEqual(
+      {
+        space: item.space,
+        link: item.link,
+        size: item.size,
+        issuer: item.issuer,
+      },
       {
         space: spaceDid,
         link,
         size: data.byteLength,
         issuer: alice.did(),
-      },
-      {
-        space: item?.space,
-        link: item?.link,
-        size: item?.size,
-        issuer: item?.issuer,
       }
     )
 
@@ -262,10 +262,7 @@ export const test = {
       }
     )
 
-    assert.equal(
-      Link.parse(item.invocation.toString()),
-      item.invocation.toString()
-    )
+    assert.deepEqual(Link.parse(item.invocation.toString()), item.invocation)
 
     assert.equal(
       Date.now() - new Date(item.insertedAt).getTime() < 60_000,

packages/upload-api/test/store.spec.js

@@ -37,7 +37,6 @@ describe('store/*', () => {
           storeTable,
           testStoreTable: storeTable,
           uploadTable,
-          testUploadTable: uploadTable,
           carStoreBucket,
           dudewhereBucket,
           access,

packages/upload-api/test/upload-table.js

@@ -60,7 +60,7 @@ export class UploadTable {
       this.items.splice(this.items.indexOf(item), 1)
     }
 
-    return item
+    return item || null
   }
 
   /**

packages/upload-api/test/upload.js

@@ -307,15 +307,15 @@ export const test = {
       )
     }
 
-    if (uploadRemove.error) {
+    if (uploadRemove?.error) {
       throw new Error(
         'expected upload/remove response to include the upload object removed',
         { cause: uploadRemove.error }
       )
     }
 
-    assert.equal(uploadRemove.root.toString(), car.roots[0].toString())
-    assert.equal(uploadRemove.shards?.[0].toString(), car.cid.toString())
+    assert.equal(uploadRemove?.root.toString(), car.roots[0].toString())
+    assert.equal(uploadRemove?.shards?.[0].toString(), car.cid.toString())
   },
 
   'upload/remove does not fail for non existent upload': async (
@@ -345,7 +345,7 @@ export const test = {
 
     assert.equal(
       uploadRemove,
-      undefined,
+      null,
       'expect falsy response when removing an upload you do not have'
     )
   },

packages/upload-api/test/upload.spec.js

@@ -37,7 +37,6 @@ describe('upload/*', () => {
           storeTable,
           testStoreTable: storeTable,
           uploadTable,
-          testUploadTable: uploadTable,
           carStoreBucket,
           dudewhereBucket,
           access,