Merge pull request #79 from KenEucker/develop

1.7.2

.github/workflows/release.yaml

@@ -8,7 +8,7 @@ on:
 jobs:
   release:
     name: Release
-    runs-on: macos-latest
+    runs-on: ubuntu-latest
 
     steps:
       - name: Checkout

.github/workflows/tests.yaml

@@ -7,7 +7,7 @@ on:
 jobs:
   test:
     name: Test on node ${{ matrix.node-version }}
-    runs-on: macos-latest
+    runs-on: ubuntu-latest
 
     strategy:
       matrix:

.gitignore

@@ -6,4 +6,5 @@ dist
 biketag.*
 logs
 .env
-coverage
+coverage
+examples/node/__snapshots__

package.json

@@ -1,6 +1,6 @@
 {
   "name": "biketag",
-  "version": "1.6.1",
+  "version": "1.7.2",
   "description": "The Javascript client API for BikeTag Games",
   "main": "./biketag.node.js",
   "browser": "./biketag.js",
@@ -53,7 +53,6 @@
     "@sanity/client": "^2.8.0",
     "axios": "^0.21.1",
     "axios-cache-adapter": "^2.7.3",
-    "dotenv": "^10.0.0",
     "form-data": "^4.0.0",
     "imgur": "git://github.com/keneucker/node-imgur.git#release",
     "snoowrap": "^1.23.0",
@@ -73,6 +72,7 @@
     "clean-webpack-plugin": "^4.0.0-alpha.0",
     "commitizen": "^4.2.4",
     "cz-conventional-changelog": "^3.0.1",
+    "dotenv": "^10.0.0",
     "eslint": "^7.0.0",
     "eslint-config-prettier": "^8.3.0",
     "husky": "^7.0.4",

src/client.ts

@@ -81,7 +81,7 @@ export class BikeTagClient extends EventEmitter {
 
     this.mostAvailableApi = undefined
 
-    this.setConfiguration(config)
+    this.setConfiguration(config ?? {})
 
     if (this.imgurConfig) {
       this.imgurClient = new ImgurClient(this.imgurConfig)
@@ -142,22 +142,22 @@ export class BikeTagClient extends EventEmitter {
         ? { tagnumbers: opts }
         : Array.isArray(opts)
         ? { payload: opts }
-        : opts
+        : opts ?? {}
 
     options.source = source
 
-    /// Set the game in the options, defaulting to the configured game
-    options.game = options.game
-      ? options.game
-      : (this.biketagConfig as Credentials).game
-
     switch (optsType) {
       case 'game':
         options.game = options.game ?? options.slug
-        options.slug = options.slug ?? options.game.toLowerCase()
+        options.slug = options.slug ?? options.game?.toLowerCase() ?? undefined
         break
 
       case 'tag':
+        /// Set the game in the options, defaulting to the configured game
+        options.game = options.game
+          ? options.game
+          : (this.biketagConfig as Credentials).game
+
         /// Set the album hash, if present (Imgur specific)
         if (this.imgurConfig?.hash) {
           options.hash = options.hash ?? this.imgurConfig.hash
@@ -329,15 +329,13 @@ export class BikeTagClient extends EventEmitter {
   }
 
   getGameData(
-    payload: RequireAtLeastOne<getGameDataPayload> | string
+    payload: RequireAtLeastOne<getGameDataPayload> | string | undefined
   ): Promise<BikeTagApiResponse<GameData>> {
-    const onlyApplicableOpts = {
-      ...(typeof payload === 'string' ? { game: payload } : payload),
-      source: 'sanity',
-    }
+    const onlyApplicableOpts =
+      typeof payload === 'string' ? { game: payload } : payload
     const { client, options, api } = this.getDefaultAPI(
       onlyApplicableOpts,
-      {},
+      { source: 'sanity' },
       'game'
     )
 

src/sanity/getGameData.ts

@@ -9,30 +9,35 @@ import { getGameDataPayload } from '../common/payloads'
 export async function getGameData(
   client: SanityClient,
   options: getGameDataPayload
-): Promise<BikeTagApiResponse<GameData>> {
+): Promise<BikeTagApiResponse<GameData | GameData[]>> {
   if (!options) {
     throw new Error('no options')
   }
 
-  if (!options.slug?.length && !options.name?.length) {
-    throw new Error('no slug')
-  }
-
   const fields = constructSanityFieldsQuery(options.fields, 'game')
   const slugIsSet = options.slug?.length
+  const nameIsSet = options.name?.length
   const query = slugIsSet
     ? `*[_type == "game" && slug.current == "${options.slug}"][0]{${fields}}`
-    : `*[_type == "game" && name match "${options.name}"][0]{${fields}}`
+    : nameIsSet
+    ? `*[_type == "game" && name match "${options.name}"][0]{${fields}}`
+    : '*[_type == "game"]'
 
   const params = {}
 
   return client.fetch(query, params).then((game) => {
+    const isArray = Array.isArray(game)
+    const games = isArray ? game : [game]
+    const gameData = []
+
     // construct gameData object from game
-    const gameData = constructGameFromSanityObject(game, options.fields)
+    for (const game of games) {
+      gameData.push(constructGameFromSanityObject(game, options.fields))
+    }
 
     // wrap tag in BikeTagApiResponse
     const response = {
-      data: gameData,
+      data: isArray ? gameData : gameData[0],
       status: 1,
       success: true,
       source: 'sanity',