@dpgradio/creative 5.0.3 → 5.0.5

package/README.md

@@ -225,8 +225,10 @@ const image = new ImageGeneratorProperties('https://static.qmusic.be/acties/joe-
 
 This package provides a number of utility functions.
 
-| Function                        | Description                                                   |
-| ------------------------------- | -----------                                                   |
-| `loadScript(url, { timeout })`  | Dynammically loads a JS script.                               |
-| `openLink(url)`                 | App-compatible link opener.                                   |
-| `tap(value, callback)`          | Invokes `callback` with the `value` and then returns `value`. |
+| Function                        | Description                                                                              |
+| ------------------------------- | ---------------------------------------------------------------------------------------- |
+| `loadScript(url, { timeout })`  | Dynammically loads a JS script.                                                          |
+| `openLink(url)`                 | App-compatible link opener.                                                              |
+| `tap(value, callback)`          | Invokes `callback` with the `value` and then returns `value`.                            |
+| `cdnImageUrl(endpoint[, size])` | Get a full image URL for an endpoint in a given size (`w480`, `w800`, `w1200`, `w2400`). |
+| `cdnUrl(endpoint)`              | Get a full CDN URL for a given endpoint.                                                 |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dpgradio/creative",
-  "version": "5.0.3",
+  "version": "5.0.5",
   "description": "Support package for standalone Javascript applications",
   "main": "src/index.js",
   "scripts": {

package/src/api/PaginatedResponse.js

@@ -0,0 +1,41 @@
+import api from './api'
+
+export default class PaginatedResponse {
+  constructor(response, dataKey = 'data') {
+    this.pagination = response.pagination
+    this.data = response[dataKey]
+    this.dataKey = dataKey
+  }
+
+  async fetchNext() {
+    const response = await api.onVersion(null).request().get(this.pagination.next)
+    this.pagination.next = response.pagination.next
+    this.data = [...this.data, ...response[this.dataKey]]
+
+    return response[this.dataKey]
+  }
+
+  async fetchPrevious() {
+    const response = await api.onVersion(null).request().get(this.pagination.previous)
+    this.pagination.previous = response.pagination.previous
+    this.data = [...response[this.dataKey], ...this.data]
+
+    return response[this.dataKey]
+  }
+
+  async fetchAllNext() {
+    while ((await this.fetchNext()).length > 0) {
+      continue
+    }
+
+    return this.data
+  }
+
+  async fetchAllPrevious() {
+    while ((await this.fetchPrevious()).length > 0) {
+      continue
+    }
+
+    return this.data
+  }
+}

package/src/api/api.js

@@ -17,6 +17,11 @@ export class Api {
 
     this.requestModifiers = []
 
+    this.errorHandlers = []
+
+    this.apiKey = null
+    this.radioToken = null
+
     // Endpoints
     this.channels = new Channels(this)
     this.config = new Config(this)
@@ -29,18 +34,23 @@ export class Api {
   }
 
   request() {
-    return tap(new Request(this.baseUrl, this.version), (request) => {
-      this.requestModifiers.forEach((modifier) => modifier(request))
+    const modifiers = [...this.requestModifiers]
+
+    this.apiKey && modifiers.push((request) => request.withQueryParameters({ api_key: this.apiKey }))
+    this.radioToken && modifiers.push((request) => request.withHeader('Authorization', `Bearer ${this.radioToken}`))
+
+    return tap(new Request(this.baseUrl, this.version, this.errorHandlers), (request) => {
+      modifiers.forEach((modifier) => modifier(request))
     })
   }
 
   setApiKey(apiKey) {
-    this.requestModifiers.push((request) => request.withQueryParameters({ api_key: apiKey }))
+    this.apiKey = apiKey
     return this
   }
 
   setRadioToken(token) {
-    this.requestModifiers.push((request) => request.withHeader('Authorization', `Bearer ${token}`))
+    this.radioToken = token
     return this
   }
 
@@ -52,9 +62,17 @@ export class Api {
     return tap(this.clone(), (api) => (api.baseUrlOverride = GLOBAL_API_URL))
   }
 
+  addErrorHandler(handler) {
+    this.errorHandlers.push(handler)
+    return this
+  }
+
   clone() {
     return tap(new Api(this.baseUrlOverride, this.version), (api) => {
+      api.apiKey = this.apiKey
+      api.radioToken = this.radioToken
       api.requestModifiers = this.requestModifiers
+      api.errorHandlers = this.errorHandlers
     })
   }
 }

package/src/api/endpoints/Endpoint.js

@@ -2,6 +2,7 @@
 import { Api } from '../api.js'
 // eslint-disable-next-line no-unused-vars -- used in JSDoc
 import Request from '../request.js'
+import PaginatedResponse from '../PaginatedResponse.js'
 
 export default class Endpoint {
   /**
@@ -34,4 +35,24 @@ export default class Endpoint {
     }
     return response[key]
   }
+
+  /**
+   * @param {requestCallback} callback
+   * @returns {PaginatedResponse}
+   */
+  async requestPaginatedData(callback, key = 'data') {
+    const response = await callback(this.api.request())
+
+    if (response === null) {
+      throw new Error(`Endpoint returned invalid JSON.`)
+    }
+    if (response[key] === undefined) {
+      throw new Error(`Key '${key}' not found in response: ${JSON.stringify(response)}`)
+    }
+    if (response.pagination === undefined) {
+      throw new Error(`Key 'pagination' not found in response: ${JSON.stringify(response)}`)
+    }
+
+    return new PaginatedResponse(response, key)
+  }
 }

package/src/api/endpoints/Ratings.js

@@ -2,7 +2,7 @@ import Endpoint from './Endpoint.js'
 
 export default class Ratings extends Endpoint {
   async allForMember() {
-    return await this.requestData((r) => r.get('/members/me/ratings'), 'ratings')
+    return await this.requestPaginatedData((r) => r.get('/members/me/ratings'), 'ratings')
   }
 
   async like(selectorCode) {

package/src/api/request.js

@@ -1,9 +1,10 @@
 import tap from '../utils/tap.js'
 
 export default class Request {
-  constructor(baseUrl, version) {
+  constructor(baseUrl, version, errorHandlers = []) {
     this.baseUrl = baseUrl
     this.version = version
+    this.errorHandlers = errorHandlers
     this.queryParameters = {}
     this.data = null
     this.headers = {}
@@ -75,6 +76,8 @@ export default class Request {
     })
 
     if (!response.ok) {
+      this.errorHandlers.forEach((handler) => handler({ response }))
+
       throw new Error(
         `API request (${method} ${url}) failed: [${response.status}] ${response.statusText}\n\n` +
           `RESPONSE\n--------\n${await response.text()}`
@@ -93,8 +96,13 @@ export default class Request {
 
     const endpointWithoutSlash = endpoint.replace(/^\/+/, '')
 
-    return tap(new URL(`${baseUrlWithProtocol}/${this.version}/${endpointWithoutSlash}`), (url) => {
-      url.search = new URLSearchParams(this.queryParameters).toString()
+    const urlParts = [baseUrlWithProtocol, this.version, endpointWithoutSlash].filter(Boolean)
+
+    return tap(new URL(urlParts.join('/')), (url) => {
+      url.search = new URLSearchParams({
+        ...Object.fromEntries(new URLSearchParams(url.search)),
+        ...this.queryParameters,
+      }).toString()
     })
   }
 }