test(*): adds testing todos and cleans up test/src ahead of #88

also includes some cleanup and minor updates found in test discovery

package.json

@@ -28,7 +28,7 @@
     "serve": "eleventy --serve",
     "serve:prod": "eleventy --serve --port=80",
     "start": "npm run serve:prod",
-    "test": "jest",
+    "test": "jest --verbose",
     "test:dev": "jest --silent=false",
     "test:ci": "jest --ci --coverage --maxWorkers=2",
     "build": "tsc",

src/client.ts

@@ -589,7 +589,7 @@ export class BikeTagClient extends EventEmitter {
     }
   }
 
-  /// ****************************  Queue Methods   **************************************** ///
+  /// ****************************  Queue Data Methods   *********************************** ///
 
   queue(
     payload?: RequireAtLeastOne<getQueuePayload>,

src/imgur/deleteTag.ts

@@ -7,8 +7,8 @@ import { AvailableApis, HttpStatusCode } from '../common/enums'
 export async function deleteTag(
   client: ImgurClient,
   payload: deleteTagPayload
-): Promise<BikeTagApiResponse<any>> {
-  const responses = []
+): Promise<BikeTagApiResponse<boolean[]>> {
+  const responses: boolean[] = []
   const hashes = []
 
   if (payload.tagnumber || payload.slug) {
@@ -30,13 +30,13 @@ export async function deleteTag(
   }
 
   for (const hash of hashes) {
-    responses.push(await client.deleteImage(hash))
+    responses.push((await client.deleteImage(hash)).data)
   }
 
   return {
     data: responses,
     success: true,
     source: AvailableApis[AvailableApis.imgur],
     status: HttpStatusCode.Ok,
-  } as BikeTagApiResponse<any>
+  }
 }

src/imgur/deleteTags.ts

@@ -1,14 +1,14 @@
 import ImgurClient from 'imgur'
 import { deleteTagsPayload } from '../common/payloads'
-import { BikeTagApiResponse, ImgurImage } from '../common/types'
+import { BikeTagApiResponse } from '../common/types'
 import { getImageHashFromImgurImage } from './helpers'
 import { AvailableApis, HttpStatusCode } from '../common/enums'
 
-export async function deleteTag(
+export async function deleteTags(
   client: ImgurClient,
   payload: deleteTagsPayload
-): Promise<BikeTagApiResponse<any>> {
-  const responses = []
+): Promise<BikeTagApiResponse<boolean[]>> {
+  const responses: boolean[] = []
   const deleteHashes = []
   let tags = payload.tags
 
@@ -17,13 +17,11 @@ export async function deleteTag(
   }
   for (const tag of tags) {
     if (tag.foundImageUrl) {
-      deleteHashes.push(
-        getImageHashFromImgurImage({ link: tag.foundImageUrl } as ImgurImage)
-      )
+      deleteHashes.push(getImageHashFromImgurImage({ link: tag.foundImageUrl }))
     }
     if (tag.mysteryImageUrl) {
       deleteHashes.push(
-        getImageHashFromImgurImage({ link: tag.mysteryImageUrl } as ImgurImage)
+        getImageHashFromImgurImage({ link: tag.mysteryImageUrl })
       )
     }
   }
@@ -33,13 +31,13 @@ export async function deleteTag(
   }
 
   for (const hash of deleteHashes) {
-    responses.push(await client.deleteImage(hash))
+    responses.push((await client.deleteImage(hash)).data)
   }
 
   return {
     data: responses,
     success: true,
     source: AvailableApis[AvailableApis.imgur],
     status: HttpStatusCode.Ok,
-  } as BikeTagApiResponse<any>
+  }
 }

src/imgur/helpers.ts

@@ -396,7 +396,7 @@ export const getBikeTagNumberIndexFromImgurImages = (
 }
 
 export const getImageHashFromImgurImage = (
-  image: ImgurImage,
+  image: Partial<ImgurImage>,
   cache?: typeof TinyCache
 ): string => {
   return getImageHashFromText(image.link, cache)

src/imgur/index.ts

@@ -1,4 +1,5 @@
 export { deleteTag } from './deleteTag'
+export { deleteTags } from './deleteTags'
 export { getTags } from './getTags'
 export { getPlayers } from './getPlayers'
 export { updateTag } from './updateTag'

test/src/biketag/index.spec.ts

@@ -0,0 +1,27 @@
+describe('biketag.data()', () => {
+  test.todo('BikeTagClient provides BikeTag adapter from Credentials')
+
+  test.todo(
+    'BikeTagClient can ready BikeTag api when passed valid ImgurCredentials'
+  )
+
+  test.todo(
+    'BikeTagClient throws Errors.NotImplemented when game interface is invoked using BikeTag as a source'
+  )
+
+  test.todo(
+    'BikeTagClient throws Errors.NotImplemented when ambassadors interface is invoked using BikeTag as a source'
+  )
+
+  test.todo(
+    'BikeTagClient throws Errors.NotImplemented when settings interface is invoked using BikeTag as a source'
+  )
+
+  test.todo(
+    'BikeTagClient throws Errors.NotImplemented when tags interface is invoked using BikeTag as a source'
+  )
+
+  test.todo(
+    'BikeTagClient throws Errors.NotImplemented when players interface is invoked using BikeTag as a source'
+  )
+})