Overview

Annoto Kaltura Plugin

Quickstart

Install dependencies

npm install
npm i -g gulp

Run development

npm run start

Build for production

npm run build

Build for staging

npm run build:staging

Upload assets to AWS S3

Make sure to set environmental variables:

AWS_S3_ACCESS_ID
AWS_S3_SECRET

To upload run:

gulp publish
gulp publish --prod

test loading speed

gulp pagespeed

Accessing Annoto widget API

    kWidget.addReadyCallback( function(playerId){
        var kdp = document.getElementById(playerId); 

        kdp.kBind( 'annotoPluginReady', function(api) { 
            console.log('Annoto is ready and the API can now be used'); 
        
            kdp.kUnbind('annotoPluginReady');
        });
    });

Babel Notes

.babelrc contains the transpiler configuration.

It uses the babel-preset-env.

To find out the list of browsers for the browserlist configuration check out browserl.ist

As an alternative configuration (instead of using the env preset):

{
  "presets": [
      [
          "es2015",
          {
              "modules": false,
              "loose": true
          }
      ],
      "stage-1"
  ],
    "plugins": [
        "syntax-flow",
        "transform-flow-strip-types",
        "transform-class-properties"
    ],
  "retainLines": true
}

ESLint Notes

Airbnb does not allow for of loops: Issue.

Airbnb does not allow underscore variables no-underscore-dangle but override it in .eslintc to use convention of internal class methods. Nothing to do with privacy.