@dpgradio/creative 5.1.0 → 5.2.0

package/README.md

@@ -40,15 +40,20 @@ The configuration will also be used by other components of this package (e.g. pr
 ```js
 import { configuration } from '@dpgradio/creative'
 
+// Global config only
+await configuration.retrieveConfigForDetectedStation()
+
+// Global and app-specific config
 await configuration.retrieveConfigForDetectedStation(appId) // Default, by hostname or query parameter
 
 // Or, if you want to retrieve the config by hostnames only.
 await configuration.retrieveConfigByHostname(appId)
 // Or, if you want to retrieve the config for a specific station:
-await configuration.retrieveConfigByStation(appId, stationIdA, stationIdB, stationIdC)
+await configuration.retrieveConfigByStation(stationId, appId)
 
 // By default the first station ID (stationIdA) is used as the current station of the configuration.
-// If you want to use a different station, you can do so by calling:
+// If you want to use a different station, you can do so by calling setStation:
+await configuration.retrieveConfigByStations([stationIdA, stationIdB, stationIdC], appId)
 configuration.setStation(stationIdC)
 ```
 You can change the station later on at any time without having to retrieve the config again.

package/examples/useConfig.js

@@ -1,13 +1,17 @@
 import configuration, { config } from '../src/config/config.js'
 
-const appId = 'greety'
+global.window = { location: { hostname: 'qmusic.nl', search: '' } }
+
+const appId = 'player'
 const stationIdA = 'qmusic_be'
 const stationIdB = 'qmusic_nl'
 
-await configuration.retrieveConfig(appId, stationIdA, stationIdB)
+await configuration.retrieveConfigForDetectedStation()
+console.log(config()) // global config
 
-console.log(config('app')) // greety config of qmusic_be
+await configuration.retrieveConfigForDetectedStation(appId)
+console.log(config('app')) // player config of qmusic_be
 
+await configuration.retrieveConfigForStations([stationIdA, stationIdB], appId)
 configuration.setStation(stationIdB)
-
-console.log(config('app')) // greety config of qmusic_nl
+console.log(config('app')) // player config of qmusic_nl

package/package.json

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

package/src/api/endpoints/Config.js

@@ -2,11 +2,13 @@ import Endpoint from './Endpoint.js'
 
 export default class Config extends Endpoint {
   async global({ stationIds = null, domains = null }) {
-    return await this.requestData((r) => r.get('/config', { station_ids: stationIds, domains }))
+    return await this.requestData((r) => r.get('/config', this.withoutNullValues({ station_ids: stationIds, domains })))
   }
 
   async app(appId, { stationIds = null, domains = null }) {
-    return await this.requestData((r) => r.get(`/config/${appId}`, { station_ids: stationIds, domains }))
+    return await this.requestData((r) =>
+      r.get(`/config/${appId}`, this.withoutNullValues({ station_ids: stationIds, domains }))
+    )
   }
 
   async updateSchema(appId, schema) {

package/src/api/endpoints/Endpoint.js

@@ -55,4 +55,8 @@ export default class Endpoint {
 
     return new PaginatedResponse(response, key)
   }
+
+  withoutNullValues(object) {
+    return Object.fromEntries(Object.entries(object).filter(([, value]) => value !== null))
+  }
 }

package/src/config/config.js

@@ -15,7 +15,10 @@ class Configuration {
     return this
   }
 
-  async retrieveConfigForDetectedStation(appId) {
+  /**
+   * Retrieve the configuration for the current hostname or present query parameter and the given app (optional).
+   */
+  async retrieveConfigForDetectedStation(appId = null) {
     const parameters = new URLSearchParams(window.location.search)
     if (parameters.has('stationId')) {
       return this.retrieveConfigForStation(appId, parameters.get('stationId'))
@@ -24,15 +27,20 @@ class Configuration {
   }
 
   /**
-   * Retrieve the configuration for the given app and the current hostname.
+   * Retrieve the configuration for the current hostname and the given app (optional).
    */
-  async retrieveConfigByHostname(appId) {
+  async retrieveConfigByHostname(appId = null) {
     this.appId = appId
 
     // This is not the most robust way to get the hostname without subdomains, e.g. .co.uk domains will break.
     // However, for the TLDs we use, this should be fine.
     const hostname = window.location.hostname.split('.').splice(-2).join('.')
-    this.rawConfig = await api.global().config.app(appId, { domains: [hostname] })
+
+    if (appId) {
+      this.rawConfig = await api.global().config.app(appId, { domains: [hostname] })
+    } else {
+      this.rawConfig = await api.global().config.global({ domains: [hostname] })
+    }
 
     this.stationId = Object.keys(this.rawConfig)[0]
 
@@ -40,13 +48,24 @@ class Configuration {
   }
 
   /**
-   * Retrieve the configuration for the given app and the given station(s).
+   * Retrieve the configuration for the given station and the given app (optional).
    */
-  async retrieveConfigForStation(appId, ...stationIds) {
+  async retrieveConfigForStation(stationId, appId = null) {
+    return await this.retrieveConfigForStations([stationId], appId)
+  }
+
+  /**
+   * Retrieve the configuration for the given stations and the given app (optional).
+   */
+  async retrieveConfigForStations(stationIds, appId = null) {
     this.appId = appId
     this.stationId = stationIds[0]
 
-    this.rawConfig = await api.global().config.app(appId, { stationIds })
+    if (appId) {
+      this.rawConfig = await api.global().config.app(appId, { stationIds })
+    } else {
+      this.rawConfig = await api.global().config.global({ stationIds })
+    }
 
     return this
   }
@@ -58,10 +77,12 @@ class Configuration {
     if (!this.stationId) {
       throw new Error('No station set. First use [config.setStation] to set the station.')
     }
-    if (!this.appId) {
-      throw new Error('No app identifier set. First use [config.retrieveConfig] to retrieve the configuration.')
+    if (!this.rawConfig[this.stationId]) {
+      throw new Error(
+        `No configuration found for station [${this.stationId}]. Make sure there is a global config for this station.`
+      )
     }
-    if (!this.rawConfig[this.stationId]?.[this.appId]) {
+    if (this.appId && !this.rawConfig[this.stationId]?.[this.appId]) {
       throw new Error(
         `No configuration found for station [${this.stationId}] and app [${this.appId}]. Make sure the app is enabled for this station.`
       )
@@ -69,7 +90,7 @@ class Configuration {
 
     const stationConfig = {
       ...this.rawConfig[this.stationId],
-      app: this.rawConfig[this.stationId][this.appId],
+      ...(this.appId ? { app: this.rawConfig[this.stationId][this.appId] } : {}),
     }
 
     return property ? dotSyntaxAccess(stationConfig, property) : stationConfig