feat(FEC-8153): save reference to player instances and expose API to …

…get them (#174)

Save reference to each instantiated player.
Add methods to get all players or a player by ID.
Make sure to delete the reference upon destroying a player.

will add tests once review is done.
still deliberating if to add this code in its own module. doing so will add some boilerplate code of module management which i'm not sure is worth the addition, i.e. need to add register player and delete player methods....

flow-typed/types/kaltura-players.js

@@ -0,0 +1,9 @@
+import {KalturaPlayer} from '../../src/kaltura-player';
+
+/**
+ * @type {Object.<string, KalturaPlayer>}
+ * @name KalturaPlayers
+ * @description a map of player instances by player ids
+*/
+type _KalturaPlayers = {[id: string]: KalturaPlayer};
+declare type KalturaPlayers = _KalturaPlayers;

src/index.js

@@ -18,6 +18,7 @@ import '@playkit-js/playkit-js-kava';
 import * as shaka from 'shaka-player';
 // Import setup method
 import {setup} from './setup';
+export {getPlayers, getPlayer} from './proxy';
 // Import cast framework
 import {cast} from './common/cast';
 // Import playlist

src/proxy.js

@@ -2,9 +2,35 @@
 import {KalturaPlayer} from './kaltura-player';
 import {FakeEventTarget} from '@playkit-js/playkit-js';
 
+const Players: KalturaPlayers = {};
+/**
+ * get all instantiated players
+ * @returns {KalturaPlayers} - map of player ids and their respective instantiated player
+ */
+function getPlayers(): KalturaPlayers {
+  return Players;
+}
+
+/**
+ * get a player instance by id
+ * @param {string} id - the player ID
+ * @returns {KalturaPlayer | null} - the player if found by the supplied ID or null if key doesn't exist
+ */
+function getPlayer(id: string): ?KalturaPlayer {
+  if (Players[id]) {
+    return Players[id];
+  }
+  return null;
+}
+
 const proxyIgnoredProps: Array<string> = ['_remotePlayer', '_listeners', '_uiWrapper'];
 const proxyHandler: Object = {
   get(kp: KalturaPlayer, prop: string) {
+    if (prop === 'destroy') {
+      const playerId = kp.config.targetId;
+      delete Players[playerId];
+    }
+
     if (prop in FakeEventTarget.prototype || proxyIgnoredProps.includes(prop)) {
       // $FlowFixMe
       return kp[prop];
@@ -30,7 +56,9 @@ const proxyHandler: Object = {
 
 const getPlayerProxy = (options: KPOptionsObject) => {
   const player = new KalturaPlayer(options);
-  return new Proxy(player, proxyHandler);
+  const proxy = new Proxy(player, proxyHandler);
+  Players[options.targetId] = proxy;
+  return proxy;
 };
 
-export {getPlayerProxy};
+export {getPlayerProxy, getPlayer, getPlayers};