@dpgradio/creative 5.0.0

package/.babelrc

@@ -0,0 +1,4 @@
+// Babel is only used for jest support at the moment. Maybe consider a different testing libary.
+{
+  "presets": ["@babel/preset-env"]
+}

package/.eslintrc.cjs

@@ -0,0 +1,12 @@
+module.exports = {
+  env: {
+    browser: true,
+    es6: true,
+    node: true,
+  },
+  extends: ['@dpgradio/eslint-config-recommended'],
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 2023,
+  },
+}

package/README.md

@@ -0,0 +1,232 @@
+# @dpgradio/creative
+
+## Installation
+
+```bash
+yarn add @dpgradio/creative
+```
+
+## CSS: Fonts and Colors
+
+Note that version 5 of this package provides fonts and colors as pure css.
+The variables and fonts are no longer available as scss variables/imports.
+
+Example:
+
+```css
+@import "q-creative/styles/colors/qmusic";
+@import "q-creative/styles/fonts/qmusic";
+
+body, html {
+  background-color: rgb(var(--q-teal));
+  color: rgb(var(--q-grey) / 0.8);
+  font-family: 'QMarkMyWords';
+}
+```
+
+## Config
+
+### Usage
+
+Add the following in the main script of your application to retrieve the configuration.
+The configuration will also be used by other components of this package (e.g. privacy, tracking, etc.).
+
+```js
+import { configuration } from '@dpgradio/creative'
+
+await configuration.retrieveConfig(appId, stationIdA, stationIdB, stationIdC)
+
+// 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:
+configuration.setStation(stationIdC)
+```
+You can change the station later on at any time without having to retrieve the config again.
+The API client will automatically use the correct station.
+Privacy and tracking need to be reinitalized after changing the station.
+
+The config can now be used as follows:
+
+```js
+import { config } from '@dpgradio/creative'
+
+config('api_base_url') // or: config().api_base_url
+config('app.default_theme') // or: config().app.default_theme
+```
+
+### Update Schema
+
+Applications can create/modify the configuration schema by creating a script with the following contents:
+
+```js
+import { api, configuration } from '@dpgradio/creative'
+
+api.setApiKey('<api-token-here>')
+
+await configuration.replaceSchema('greety', [
+  {
+    name: 'display_language',
+    type: 'options',
+    default: 'dutch',
+    options: ['dutch', 'english'],
+  },
+  {
+    name: 'author_name',
+    type: 'string',
+  },
+])
+```
+
+(assuming availablity of top-level await and `fetch`)
+
+## Privacy and Tracking
+
+### Privacy
+
+#### Initialization
+
+Without [config](#config):
+
+```js
+import { privacy } from '@dpgradio/creative'
+
+privacy.initialize(privacyManagerId, websiteUrl, cmpCname)
+```
+
+With config (after [initializing the config](#config)):
+
+```js
+import { privacy } from '@dpgradio/creative'
+
+privacy.initialize()
+```
+
+#### Get consent string
+
+```js
+import { privacy } from '@dpgradio/creative'
+
+const consent = await privacy.waitForConsent()
+
+// Available properties:
+consent.consentString
+consent.purposes
+consent.allowsTargetedAdvertising()
+```
+
+### Tracking
+
+```js
+import { dataLayer } from '@dpgradio/creative'
+
+dataLayer.initialize() // Pushes gtmStart and currently authenticated user
+dataLayer.pushVirtualPageView(brand) // brand is not required when the config is initialized
+
+dataLayer.pushEvent(event, data)
+```
+
+## API
+
+With an initialized [configuration](#config):
+
+```js
+import { api } from '@dpgradio/creative'
+
+const channels = await api.channels.all()
+
+const globalChannels = await api.global().channels.all()
+
+api.setRadioToken(token)
+const profile = await api.members.me() // or await api.setRadioToken(token).members.me()
+
+api.setApiKey(key)
+await api.global().config.update(appId, schema)
+
+const oldChannels = await api.onVersion('1.4').channels.all()
+```
+
+Without an initialized [configuration](#config):
+
+```js
+import { Api } from '@dpgradio/creative'
+
+const api = new Api('https://api.qmusic.be')
+
+const channels = await api.channels.all()
+```
+
+## Socket
+
+```js
+import { socket } from '@dpgradio/creative'
+
+socket.connect(stationId).subscribe('plays').on('play', () => {
+  console.log('play')
+}, { backlog: 3 }})
+
+// or
+
+socket.join({ station: stationId, entity: 'plays', action: 'play', options: { backlog: 3 } }, (play) => {
+  console.log(play)
+})
+```
+
+## Hybrid
+
+```js
+import { hyrid } from '@dpgradio/creative'
+
+hybrid.appInfo
+hybrid.isNativeApp()
+hybrid.isVersion({ iOS, Android })
+hybrid.call(method, options)
+hybrid.on(method, callback, once)
+hybrid.one(method, callback)
+const radioToken = await hybrid.appLoaded()
+hybrid.decodeRadioToken(radioToken)
+```
+
+## Sharing Generator
+
+Example:
+
+```js
+import { Shareable, ImageGeneratorProperties } from 'q-creative/share'
+
+const shareable = new Shareable()
+  .withTitle(`${this.name} is mijn seventies match!`)
+  .withDescription('Ontdek wie jouw seventies match is in de Generation Quiz van Joe!')
+  .withMessageText(`Mijn seventies match is ${this.name}, wat is die van jou?`)
+  .redirectTo('https://article_url.com')
+  .fromDomain('joe.be')
+
+// Facebook
+const image = new ImageGeneratorProperties('https://static.qmusic.be/acties/joe-70s-quiz-share-fb/index.html')
+  .withDimensions(1200, 630)
+  .withPayload({ results: this.matches });
+       
+(await shareable.generateUsingImage(image)).openFacebookUrl()
+
+// Instagram
+const image = new ImageGeneratorProperties('https://static.qmusic.be/acties/joe-70s-quiz-share-fb/index.html')
+  .withDimensions(1080, 1920)
+  .withPayload({ results: this.matches });
+       
+(await shareable.generateUsingImage(image)).openInstagramUrl()
+
+// Whatsapp
+const image = new ImageGeneratorProperties('https://static.qmusic.be/acties/joe-70s-quiz-share-fb/index.html')
+  .withDimensions(1200, 630)
+  .withPayload({ results: this.matches });
+       
+(await shareable.generateUsingImage(image)).openWhatsappUrl()
+```
+
+## Utilities
+
+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`. |

package/examples/updateConfigSchema.js

@@ -0,0 +1,27 @@
+import api from '../src/api/api.js'
+import configuration from '../src/config/config.js'
+
+// To add support for node <17.5, install node-fetch and include the following line
+// global.fetch = await import('node-fetch').then((module) => module.default)
+
+// Make sure you have set the DARIO_API_KEY environment variable
+// Add the following to your .bashrc or .zshrc: `export DARIO_API_KEY=your-api-key`
+// eslint-disable-next-line no-undef
+api.setApiKey(process.env.DARIO_API_KEY)
+
+configuration.replaceSchema('greety', [
+  {
+    name: 'display_language',
+    type: 'options',
+    default: 'dutch',
+    options: ['dutch', 'english'],
+  },
+  {
+    name: 'author_name',
+    type: 'string',
+  },
+  {
+    name: 'author_email',
+    type: 'string',
+  },
+])

package/examples/useApi.js

@@ -0,0 +1,16 @@
+import api from '../src/api/api.js'
+import configuration from '../src/config/config.js'
+
+const appId = 'greety'
+const stationId = 'qmusic_be'
+
+await configuration.retrieveConfig(appId, stationId)
+
+const channels = await api.channels.all()
+
+console.log(channels)
+
+const token = '<radio-token-here>'
+const profile = await api.setRadioToken(token).members.me()
+
+console.log(profile)

package/examples/useConfig.js

@@ -0,0 +1,13 @@
+import configuration, { config } from '../src/config/config.js'
+
+const appId = 'greety'
+const stationIdA = 'qmusic_be'
+const stationIdB = 'qmusic_nl'
+
+await configuration.retrieveConfig(appId, stationIdA, stationIdB)
+
+console.log(config('app')) // greety config of qmusic_be
+
+configuration.setStation(stationIdB)
+
+console.log(config('app')) // greety config of qmusic_nl

package/jest.config.cjs

@@ -0,0 +1,195 @@
+/*
+ * For a detailed explanation regarding each configuration property, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/lc/cnjbcmm51_z3lcvg0vj8_zdc0000gn/T/jest_dx",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  rootDir: 'src',
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "jsdom",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@dpgradio/creative",
+  "version": "5.0.0",
+  "description": "Support package for standalone Javascript applications",
+  "main": "src/index.js",
+  "scripts": {
+    "test": "jest",
+    "lint-check": "eslint --ext .js --ignore-path .gitignore src",
+    "lint": "yarn lint-check --fix"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dpgradio/creative.git"
+  },
+  "keywords": [
+    "qmusic"
+  ],
+  "type": "module",
+  "author": "DPG Media",
+  "license": "ISC",
+  "dependencies": {
+    "jwt-decode": "^3.1.2",
+    "sockjs-client": "^1.6.1"
+  },
+  "devDependencies": {
+    "@dpgradio/eslint-config-recommended": "^0.0.1",
+    "eslint": "^8.32.0",
+    "jest": "^29.4.0",
+    "jest-environment-jsdom": "^29.4.0"
+  }
+}

package/src/__test__/utils/openLink.test.js

@@ -0,0 +1,44 @@
+import { describe, expect, test, jest } from '@jest/globals'
+import hybrid from '../../app/hybrid'
+import openLink from '../../utils/openLink'
+
+jest.mock('../../utils/hybrid.js', () => ({
+  isNativeApp: jest.fn(),
+  call: jest.fn(),
+}))
+
+const setUserAgent = (userAgent) => {
+  jest.spyOn(window.navigator, 'userAgent', 'get').mockImplementation(() => userAgent)
+}
+
+describe('opening a link in the app', () => {
+  test('it calls a hybrid method', () => {
+    hybrid.isNativeApp.mockImplementation(() => true)
+
+    openLink('https://www.google.com/')
+
+    expect(hybrid.call).toHaveBeenCalledWith('navigateTo', { inApp: false, url: 'https://www.google.com/' })
+  })
+})
+
+describe('opening a link in the browser', () => {
+  test('it opens in a new window in non-Safari', () => {
+    hybrid.isNativeApp.mockImplementation(() => false)
+    setUserAgent('Chrome')
+    window.open = jest.fn()
+
+    openLink('https://www.google.com/')
+
+    expect(window.open).toHaveBeenCalledWith('https://www.google.com/')
+  })
+
+  test('it redirects to the link in Safari', () => {
+    hybrid.isNativeApp.mockImplementation(() => false)
+    setUserAgent('Safari')
+    delete window.location // allows us to set and read the location object
+
+    openLink('https://www.google.com/')
+
+    expect(window.location).toBe('https://www.google.com/')
+  })
+})

package/src/api/api.js

@@ -0,0 +1,60 @@
+import { config } from '../config/config.js'
+import Request from './request.js'
+import tap from '../utils/tap.js'
+import Channels from './endpoints/Channels.js'
+import Config from './endpoints/Config.js'
+import Members from './endpoints/Members.js'
+
+const GLOBAL_API_URL = 'https://api.radio.dpgmedia.cloud'
+
+export const DEFAULT_VERSION = '2.9'
+
+export class Api {
+  constructor(baseUrl, version = DEFAULT_VERSION) {
+    this.baseUrlOverride = baseUrl
+    this.version = version
+
+    this.requestModifiers = []
+
+    // Endpoints
+    this.channels = new Channels(this)
+    this.config = new Config(this)
+    this.members = new Members(this)
+  }
+
+  get baseUrl() {
+    return this.baseUrlOverride || config('apiBaseUrl')
+  }
+
+  request() {
+    return tap(new Request(this.baseUrl, this.version), (request) => {
+      this.requestModifiers.forEach((modifier) => modifier(request))
+    })
+  }
+
+  setApiKey(apiKey) {
+    this.requestModifiers.push((request) => request.withQueryParameters({ api_key: apiKey }))
+    return this
+  }
+
+  setRadioToken(token) {
+    this.requestModifiers.push((request) => request.withHeader('Authorization', `Bearer ${token}`))
+    return this
+  }
+
+  onVersion(version) {
+    return tap(this.clone(), (api) => (api.version = version))
+  }
+
+  global() {
+    return tap(this.clone(), (api) => (api.baseUrlOverride = GLOBAL_API_URL))
+  }
+
+  clone() {
+    return tap(new Api(this.baseUrlOverride, this.version), (api) => {
+      api.requestModifiers = this.requestModifiers
+    })
+  }
+}
+
+export default new Api()

package/src/api/endpoints/Channels.js

@@ -0,0 +1,7 @@
+import Endpoint from './Endpoint.js'
+
+export default class Channels extends Endpoint {
+  async all() {
+    return await this.requestData((r) => r.get('/channels'))
+  }
+}

package/src/api/endpoints/Config.js

@@ -0,0 +1,15 @@
+import Endpoint from './Endpoint.js'
+
+export default class Config extends Endpoint {
+  async global() {
+    return await this.requestData((r) => r.get('/config'))
+  }
+
+  async app(appId, stationIds) {
+    return await this.requestData((r) => r.get(`/config/${appId}`, { station_ids: stationIds }))
+  }
+
+  async updateSchema(appId, schema) {
+    await this.api.request().put(`/config/${appId}`, { schema })
+  }
+}