Merge pull request #259 from rdkcentral/dev

Release v4.6.0

Author: michielvandergeest

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v4.6.0
+
+*16 aug 2021*
+
+- Added context to Pin plugin
+- Added option to overwrite the font loader from platform
+- Added cleanup of App fonts on app close
+- Fixed initial focus bug
+- Added storeSameHash flag to accepted config flags of Router
+- Fixed getQueryStringParams() using active hash in Router
+
 ## v4.5.0
 
 *12 july 2021*

docs/changelog.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v4.6.0
+
+*16 aug 2021*
+
+- Added context to Pin plugin
+- Added option to overwrite the font loader from platform
+- Added cleanup of App fonts on app close
+- Fixed initial focus bug
+- Added storeSameHash flag to accepted config flags of Router
+- Fixed getQueryStringParams() using active hash in Router
+
 ## v4.5.0
 
 *12 july 2021*

docs/plugins/pin.md

@@ -36,15 +36,17 @@ Pin.hide()
 
 Sends a Pin code to the middleware layer for verification. If the code is correct, the STB will be unlocked.
 
+The `submit` method accepts `pin` and `context` as it's arguments. The context argument indicates in with what purpsose the Pin dialog is being used. The accepted values van be either `parental` or `purchase`. `context` defaults to `purchase`, but it's recommended to explicitly specify the context
+
 The `submit` method is automatically invoked when you are using the built-in **Pin** dialog. Use this method for sending the Pin code *only* if you are making a fully custom **Pin** dialog in your App.
 
 ```js
-Pin.submit('0000')
+Pin.submit('0000', context)
   .then(() => console.log('Unlocked!'))
   .catch(e => console.log('Pin error', e))
 ```
 
-The `submit` method returns a *Promise*. If the supplied Pin code is correct, the Promise resolves with `true` and the STB will be unlocked. If the Pin code is wrong, the Promise resolves with `false`.
+The `submit` method returns a *Promise*. If the supplied Pin code is correct (and context is valid), the Promise resolves with `true` and the STB will be unlocked. If the Pin code or context are wrong, the Promise resolves with `false`.
 
 If the middleware is unable to unlock the STB, the Promise is *rejected* (with an optional error message).
 
@@ -55,7 +57,7 @@ During development, the default Pin code is  `0000`. Optionally, you can overwri
 Checks if the STB is currently *unlocked*.
 
 ```js
-Pin.unlocked()
+Pin.unlocked(context)
   .then(
     unlocked => unlocked === true ?
       console.log('STB is unlocked') :
@@ -71,7 +73,7 @@ If the middleware is unable to retrieve the current state, the Promise is *rejec
 Checks if the STB is currently *locked*.
 
 ```js
-Pin.locked()
+Pin.locked(context)
   .then(
     locked => locked === true ?
       console.log('STB is locked') :

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightningjs/sdk",
-  "version": "4.5.0",
+  "version": "4.6.0",
   "license": "Apache-2.0",
   "scripts": {
     "postinstall": "node ./scripts/postinstall.js",

package.json

@@ -62,6 +62,30 @@ if (window.innerHeight === 720) {
   defaultOptions.stage['precision'] = 0.6666666667
 }
 
+const customFontFaces = []
+
+const fontLoader = (fonts, store) =>
+  new Promise((resolve, reject) => {
+    fonts
+      .map(({ family, url, urls, descriptors }) => () => {
+        const src = urls
+          ? urls.map(url => {
+              return 'url(' + url + ')'
+            })
+          : 'url(' + url + ')'
+        const fontFace = new FontFace(family, src, descriptors || {})
+        store.push(fontFace)
+        Log.info('Loading font', family)
+        document.fonts.add(fontFace)
+        return fontFace.load()
+      })
+      .reduce((promise, method) => {
+        return promise.then(() => method())
+      }, Promise.resolve(null))
+      .then(resolve)
+      .catch(reject)
+  })
+
 export default function(App, appData, platformSettings) {
   return class Application extends Lightning.Application {
     constructor(options) {
@@ -99,6 +123,8 @@ export default function(App, appData, platformSettings) {
 
           this.childList.a(AppInstance)
 
+          this._refocus()
+
           Log.info('App version', this.config.version)
           Log.info('SDK version', sdkVersion)
 
@@ -149,31 +175,27 @@ export default function(App, appData, platformSettings) {
     close() {
       Log.info('Closing App')
       this.childList.remove(this.tag('App'))
-
+      this.cleanupFonts()
       // force texture garbage collect
       this.stage.gc()
       this.destroy()
     }
 
     loadFonts(fonts) {
-      return new Promise((resolve, reject) => {
-        fonts
-          .map(({ family, url, urls, descriptors }) => () => {
-            const src = urls
-              ? urls.map(url => {
-                  return 'url(' + url + ')'
-                })
-              : 'url(' + url + ')'
-            const fontFace = new FontFace(family, src, descriptors || {})
-            document.fonts.add(fontFace)
-            return fontFace.load()
-          })
-          .reduce((promise, method) => {
-            return promise.then(() => method())
-          }, Promise.resolve(null))
-          .then(resolve)
-          .catch(reject)
-      })
+      return platformSettings.fontLoader && typeof platformSettings.fontLoader === 'function'
+        ? platformSettings.fontLoader(fonts, customFontFaces)
+        : fontLoader(fonts, customFontFaces)
+    }
+
+    cleanupFonts() {
+      if ('delete' in document.fonts) {
+        customFontFaces.forEach(fontFace => {
+          Log.info('Removing font', fontFace.family)
+          document.fonts.delete(fontFace)
+        })
+      } else {
+        Log.info('No support for removing manually-added fonts')
+      }
     }
 
     loadLanguage(config) {

src/Application/index.js

@@ -20,11 +20,13 @@
 import Settings from '../Settings'
 import PinDialog from './dialog'
 import { ApplicationInstance } from '../Launch'
+import { Log } from '../../index'
 
 // only used during local development
 let unlocked = false
+const contextItems = ['purchase', 'parental']
 
-let submit = pin => {
+let submit = (pin, context) => {
   return new Promise((resolve, reject) => {
     if (pin.toString() === Settings.get('platform', 'pin', '0000').toString()) {
       unlocked = true
@@ -35,7 +37,7 @@ let submit = pin => {
   })
 }
 
-let check = () => {
+let check = context => {
   return new Promise(resolve => {
     resolve(unlocked)
   })
@@ -52,6 +54,17 @@ export const initPin = config => {
 
 let pinDialog = null
 
+const contextCheck = context => {
+  if (context === undefined) {
+    Log.info('Please provide context explicitly')
+    return contextItems[0]
+  } else if (!contextItems.includes(context)) {
+    Log.warn('Incorrect context provided')
+    return false
+  }
+  return context
+}
+
 // Public API
 export default {
   show() {
@@ -73,34 +86,49 @@ export default {
     )
     pinDialog = null
   },
-  submit(pin) {
+  submit(pin, context) {
     return new Promise((resolve, reject) => {
       try {
-        submit(pin)
-          .then(resolve)
-          .catch(reject)
+        context = contextCheck(context)
+        if (context) {
+          submit(pin, context)
+            .then(resolve)
+            .catch(reject)
+        } else {
+          reject('Incorrect Context provided')
+        }
       } catch (e) {
         reject(e)
       }
     })
   },
-  unlocked() {
+  unlocked(context) {
     return new Promise((resolve, reject) => {
       try {
-        check()
-          .then(resolve)
-          .catch(reject)
+        context = contextCheck(context)
+        if (context) {
+          check(context)
+            .then(resolve)
+            .catch(reject)
+        } else {
+          reject('Incorrect Context provided')
+        }
       } catch (e) {
         reject(e)
       }
     })
   },
-  locked() {
+  locked(context) {
     return new Promise((resolve, reject) => {
       try {
-        check()
-          .then(unlocked => resolve(!!!unlocked))
-          .catch(reject)
+        context = contextCheck(context)
+        if (context) {
+          check(context)
+            .then(unlocked => resolve(!!!unlocked))
+            .catch(reject)
+        } else {
+          reject('Incorrect Context provided')
+        }
       } catch (e) {
         reject(e)
       }

src/Pin/index.js

@@ -88,6 +88,7 @@ export const getConfigMap = () => {
     'autoRestoreRemote',
     'numberNavigation',
     'updateHash',
+    'storeSameHash',
   ].reduce((config, key) => {
     config.set(key, isObj ? routerSettings[key] : Settings.get('platform', key))
     return config