From 9692b256ca59bb39b2971dc4e25b04bdc84a1136 Mon Sep 17 00:00:00 2001 From: Shawn Jackson <100798704+sjcpu4096@users.noreply.github.com> Date: Thu, 9 Jun 2022 07:48:02 -0700 Subject: [PATCH] Append chapters to VideoObject metadata where applicable (#829) * Call method to add VideoObject markup on init * Rename method that injects video chapters metadata * Move call of addHasPartMetadata into a utility method * Update name of method * Update regex specificity * Resolve linting errors Add and update unit tests * Rename 'appendSeoMarkup' to 'appendVideoMetadata' * Rename 'isVideoEmbed' method Re-write message source validity check * Rename isVimeoEmbedWithHashParam and remove hash from regex --- dist/player.es.js | 243 +++++++++++++++++++++++------------- dist/player.js | 243 +++++++++++++++++++++++------------- dist/player.js.map | 2 +- dist/player.min.js | 2 +- dist/player.min.js.map | 2 +- src/lib/embed.js | 44 ++++++- src/lib/functions.js | 11 ++ src/player.js | 3 +- test/embed-test.js | 32 +++-- test/functions-test.js | 17 ++- test/helpers/browser-env.js | 4 +- 11 files changed, 401 insertions(+), 202 deletions(-) diff --git a/dist/player.es.js b/dist/player.es.js index 56d6c8133..5c1199e64 100644 --- a/dist/player.es.js +++ b/dist/player.es.js @@ -80,6 +80,17 @@ function isInteger(value) { function isVimeoUrl(url) { return /^(https?:)?\/\/((player|www)\.)?vimeo\.com(?=$|\/)/.test(url); } +/** + * Check to see if the URL is for a Vimeo embed. + * + * @param {string} url The url string. + * @return {boolean} + */ + +function isVimeoEmbedWithHashParam(url) { + var expr = /^https:\/\/player\.vimeo\.com\/video\/\d+/; + return expr.test(url); +} /** * Get the Vimeo URL from an element. * The element must have either a data-vimeo-id or data-vimeo-url attribute. @@ -127,9 +138,9 @@ function createCommonjsModule(fn, module) { } /*! - * weakmap-polyfill v2.0.1 - ECMAScript6 WeakMap polyfill + * weakmap-polyfill v2.0.4 - ECMAScript6 WeakMap polyfill * https://github.com/polygonplanet/weakmap-polyfill - * Copyright (c) 2015-2020 Polygon Planet + * Copyright (c) 2015-2021 polygonplanet * @license MIT */ (function (self) { @@ -140,8 +151,17 @@ function createCommonjsModule(fn, module) { var hasOwnProperty = Object.prototype.hasOwnProperty; + var hasDefine = Object.defineProperty && function () { + try { + // Avoid IE8's broken Object.defineProperty + return Object.defineProperty({}, 'x', { + value: 1 + }).x === 1; + } catch (e) {} + }(); + var defineProperty = function (object, name, value) { - if (Object.defineProperty) { + if (hasDefine) { Object.defineProperty(object, name, { configurable: true, writable: true, @@ -256,7 +276,7 @@ function createCommonjsModule(fn, module) { function isObject(x) { return Object(x) === x; } -})(typeof self !== 'undefined' ? self : typeof window !== 'undefined' ? window : typeof commonjsGlobal !== 'undefined' ? commonjsGlobal : commonjsGlobal); +})(typeof globalThis !== 'undefined' ? globalThis : typeof self !== 'undefined' ? self : typeof window !== 'undefined' ? window : typeof commonjsGlobal !== 'undefined' ? commonjsGlobal : commonjsGlobal); var npo_src = createCommonjsModule(function (module) { /*! Native Promise Only @@ -267,7 +287,7 @@ var npo_src = createCommonjsModule(function (module) { // special form of UMD for polyfilling across evironments context[name] = context[name] || definition(); - if (module.exports) { + if ( module.exports) { module.exports = context[name]; } })("Promise", typeof commonjsGlobal != "undefined" ? commonjsGlobal : commonjsGlobal, function DEF() { @@ -714,6 +734,108 @@ function swapCallbacks(oldElement, newElement) { callbackMap.delete(oldElement); } +/** + * @module lib/postmessage + */ +/** + * Parse a message received from postMessage. + * + * @param {*} data The data received from postMessage. + * @return {object} + */ + +function parseMessageData(data) { + if (typeof data === 'string') { + try { + data = JSON.parse(data); + } catch (error) { + // If the message cannot be parsed, throw the error as a warning + console.warn(error); + return {}; + } + } + + return data; +} +/** + * Post a message to the specified target. + * + * @param {Player} player The player object to use. + * @param {string} method The API method to call. + * @param {object} params The parameters to send to the player. + * @return {void} + */ + +function postMessage(player, method, params) { + if (!player.element.contentWindow || !player.element.contentWindow.postMessage) { + return; + } + + var message = { + method: method + }; + + if (params !== undefined) { + message.value = params; + } // IE 8 and 9 do not support passing messages, so stringify them + + + var ieVersion = parseFloat(navigator.userAgent.toLowerCase().replace(/^.*msie (\d+).*$/, '$1')); + + if (ieVersion >= 8 && ieVersion < 10) { + message = JSON.stringify(message); + } + + player.element.contentWindow.postMessage(message, player.origin); +} +/** + * Parse the data received from a message event. + * + * @param {Player} player The player that received the message. + * @param {(Object|string)} data The message data. Strings will be parsed into JSON. + * @return {void} + */ + +function processData(player, data) { + data = parseMessageData(data); + var callbacks = []; + var param; + + if (data.event) { + if (data.event === 'error') { + var promises = getCallbacks(player, data.data.method); + promises.forEach(function (promise) { + var error = new Error(data.data.message); + error.name = data.data.name; + promise.reject(error); + removeCallback(player, data.data.method, promise); + }); + } + + callbacks = getCallbacks(player, "event:".concat(data.event)); + param = data.data; + } else if (data.method) { + var callback = shiftCallbacks(player, data.method); + + if (callback) { + callbacks.push(callback); + param = data.value; + } + } + + callbacks.forEach(function (callback) { + try { + if (typeof callback === 'function') { + callback.call(player, param); + return; + } + + callback.resolve(param); + } catch (e) {// empty + } + }); +} + /** * @module lib/embed */ @@ -904,107 +1026,49 @@ function resizeEmbeds() { window.addEventListener('message', onMessage); } - -/** - * @module lib/postmessage - */ /** - * Parse a message received from postMessage. + * Add chapters to existing metadata for Google SEO * - * @param {*} data The data received from postMessage. - * @return {object} - */ - -function parseMessageData(data) { - if (typeof data === 'string') { - try { - data = JSON.parse(data); - } catch (error) { - // If the message cannot be parsed, throw the error as a warning - console.warn(error); - return {}; - } - } - - return data; -} -/** - * Post a message to the specified target. - * - * @param {Player} player The player object to use. - * @param {string} method The API method to call. - * @param {object} params The parameters to send to the player. + * @param {HTMLElement} [parent=document] The parent element. * @return {void} */ -function postMessage(player, method, params) { - if (!player.element.contentWindow || !player.element.contentWindow.postMessage) { +function initAppendVideoMetadata() { + var parent = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : document; + + // Prevent execution if users include the player.js script multiple times. + if (window.VimeoSeoMetadataAppended) { return; } - var message = { - method: method - }; - - if (params !== undefined) { - message.value = params; - } // IE 8 and 9 do not support passing messages, so stringify them + window.VimeoSeoMetadataAppended = true; + var onMessage = function onMessage(event) { + var data = parseMessageData(event.data); - var ieVersion = parseFloat(navigator.userAgent.toLowerCase().replace(/^.*msie (\d+).*$/, '$1')); - - if (ieVersion >= 8 && ieVersion < 10) { - message = JSON.stringify(message); - } - - player.element.contentWindow.postMessage(message, player.origin); -} -/** - * Parse the data received from a message event. - * - * @param {Player} player The player that received the message. - * @param {(Object|string)} data The message data. Strings will be parsed into JSON. - * @return {void} - */ - -function processData(player, data) { - data = parseMessageData(data); - var callbacks = []; - var param; + if (!data || data.event !== 'ready') { + return; + } - if (data.event) { - if (data.event === 'error') { - var promises = getCallbacks(player, data.data.method); - promises.forEach(function (promise) { - var error = new Error(data.data.message); - error.name = data.data.name; - promise.reject(error); - removeCallback(player, data.data.method, promise); - }); + if (!isVimeoUrl(event.origin)) { + return; } - callbacks = getCallbacks(player, "event:".concat(data.event)); - param = data.data; - } else if (data.method) { - var callback = shiftCallbacks(player, data.method); + var iframes = parent.querySelectorAll('iframe'); - if (callback) { - callbacks.push(callback); - param = data.value; - } - } + for (var i = 0; i < iframes.length; i++) { + var iframe = iframes[i]; // Initiate appendVideoMetadata if iframe is a Vimeo embed - callbacks.forEach(function (callback) { - try { - if (typeof callback === 'function') { - callback.call(player, param); - return; - } + var isValidMessageSource = iframe.contentWindow === event.source; - callback.resolve(param); - } catch (e) {// empty + if (isVimeoEmbedWithHashParam(iframe.src) && isValidMessageSource) { + var player = new Player(iframe); + player.callMethod('appendVideoMetadata', window.location.href); + } } - }); + }; + + window.addEventListener('message', onMessage); } /* MIT License @@ -2505,6 +2569,7 @@ if (!isNode) { screenfull = initializeScreenfull(); initializeEmbeds(); resizeEmbeds(); + initAppendVideoMetadata(); } export default Player; diff --git a/dist/player.js b/dist/player.js index f1c698ac6..da85c6498 100644 --- a/dist/player.js +++ b/dist/player.js @@ -86,6 +86,17 @@ function isVimeoUrl(url) { return /^(https?:)?\/\/((player|www)\.)?vimeo\.com(?=$|\/)/.test(url); } + /** + * Check to see if the URL is for a Vimeo embed. + * + * @param {string} url The url string. + * @return {boolean} + */ + + function isVimeoEmbedWithHashParam(url) { + var expr = /^https:\/\/player\.vimeo\.com\/video\/\d+/; + return expr.test(url); + } /** * Get the Vimeo URL from an element. * The element must have either a data-vimeo-id or data-vimeo-url attribute. @@ -133,9 +144,9 @@ } /*! - * weakmap-polyfill v2.0.1 - ECMAScript6 WeakMap polyfill + * weakmap-polyfill v2.0.4 - ECMAScript6 WeakMap polyfill * https://github.com/polygonplanet/weakmap-polyfill - * Copyright (c) 2015-2020 Polygon Planet + * Copyright (c) 2015-2021 polygonplanet * @license MIT */ (function (self) { @@ -146,8 +157,17 @@ var hasOwnProperty = Object.prototype.hasOwnProperty; + var hasDefine = Object.defineProperty && function () { + try { + // Avoid IE8's broken Object.defineProperty + return Object.defineProperty({}, 'x', { + value: 1 + }).x === 1; + } catch (e) {} + }(); + var defineProperty = function (object, name, value) { - if (Object.defineProperty) { + if (hasDefine) { Object.defineProperty(object, name, { configurable: true, writable: true, @@ -262,7 +282,7 @@ function isObject(x) { return Object(x) === x; } - })(typeof self !== 'undefined' ? self : typeof window !== 'undefined' ? window : typeof commonjsGlobal !== 'undefined' ? commonjsGlobal : commonjsGlobal); + })(typeof globalThis !== 'undefined' ? globalThis : typeof self !== 'undefined' ? self : typeof window !== 'undefined' ? window : typeof commonjsGlobal !== 'undefined' ? commonjsGlobal : commonjsGlobal); var npo_src = createCommonjsModule(function (module) { /*! Native Promise Only @@ -273,7 +293,7 @@ // special form of UMD for polyfilling across evironments context[name] = context[name] || definition(); - if (module.exports) { + if ( module.exports) { module.exports = context[name]; } })("Promise", typeof commonjsGlobal != "undefined" ? commonjsGlobal : commonjsGlobal, function DEF() { @@ -720,6 +740,108 @@ callbackMap.delete(oldElement); } + /** + * @module lib/postmessage + */ + /** + * Parse a message received from postMessage. + * + * @param {*} data The data received from postMessage. + * @return {object} + */ + + function parseMessageData(data) { + if (typeof data === 'string') { + try { + data = JSON.parse(data); + } catch (error) { + // If the message cannot be parsed, throw the error as a warning + console.warn(error); + return {}; + } + } + + return data; + } + /** + * Post a message to the specified target. + * + * @param {Player} player The player object to use. + * @param {string} method The API method to call. + * @param {object} params The parameters to send to the player. + * @return {void} + */ + + function postMessage(player, method, params) { + if (!player.element.contentWindow || !player.element.contentWindow.postMessage) { + return; + } + + var message = { + method: method + }; + + if (params !== undefined) { + message.value = params; + } // IE 8 and 9 do not support passing messages, so stringify them + + + var ieVersion = parseFloat(navigator.userAgent.toLowerCase().replace(/^.*msie (\d+).*$/, '$1')); + + if (ieVersion >= 8 && ieVersion < 10) { + message = JSON.stringify(message); + } + + player.element.contentWindow.postMessage(message, player.origin); + } + /** + * Parse the data received from a message event. + * + * @param {Player} player The player that received the message. + * @param {(Object|string)} data The message data. Strings will be parsed into JSON. + * @return {void} + */ + + function processData(player, data) { + data = parseMessageData(data); + var callbacks = []; + var param; + + if (data.event) { + if (data.event === 'error') { + var promises = getCallbacks(player, data.data.method); + promises.forEach(function (promise) { + var error = new Error(data.data.message); + error.name = data.data.name; + promise.reject(error); + removeCallback(player, data.data.method, promise); + }); + } + + callbacks = getCallbacks(player, "event:".concat(data.event)); + param = data.data; + } else if (data.method) { + var callback = shiftCallbacks(player, data.method); + + if (callback) { + callbacks.push(callback); + param = data.value; + } + } + + callbacks.forEach(function (callback) { + try { + if (typeof callback === 'function') { + callback.call(player, param); + return; + } + + callback.resolve(param); + } catch (e) {// empty + } + }); + } + /** * @module lib/embed */ @@ -910,107 +1032,49 @@ window.addEventListener('message', onMessage); } - - /** - * @module lib/postmessage - */ /** - * Parse a message received from postMessage. + * Add chapters to existing metadata for Google SEO * - * @param {*} data The data received from postMessage. - * @return {object} - */ - - function parseMessageData(data) { - if (typeof data === 'string') { - try { - data = JSON.parse(data); - } catch (error) { - // If the message cannot be parsed, throw the error as a warning - console.warn(error); - return {}; - } - } - - return data; - } - /** - * Post a message to the specified target. - * - * @param {Player} player The player object to use. - * @param {string} method The API method to call. - * @param {object} params The parameters to send to the player. + * @param {HTMLElement} [parent=document] The parent element. * @return {void} */ - function postMessage(player, method, params) { - if (!player.element.contentWindow || !player.element.contentWindow.postMessage) { + function initAppendVideoMetadata() { + var parent = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : document; + + // Prevent execution if users include the player.js script multiple times. + if (window.VimeoSeoMetadataAppended) { return; } - var message = { - method: method - }; - - if (params !== undefined) { - message.value = params; - } // IE 8 and 9 do not support passing messages, so stringify them + window.VimeoSeoMetadataAppended = true; + var onMessage = function onMessage(event) { + var data = parseMessageData(event.data); - var ieVersion = parseFloat(navigator.userAgent.toLowerCase().replace(/^.*msie (\d+).*$/, '$1')); - - if (ieVersion >= 8 && ieVersion < 10) { - message = JSON.stringify(message); - } - - player.element.contentWindow.postMessage(message, player.origin); - } - /** - * Parse the data received from a message event. - * - * @param {Player} player The player that received the message. - * @param {(Object|string)} data The message data. Strings will be parsed into JSON. - * @return {void} - */ - - function processData(player, data) { - data = parseMessageData(data); - var callbacks = []; - var param; + if (!data || data.event !== 'ready') { + return; + } - if (data.event) { - if (data.event === 'error') { - var promises = getCallbacks(player, data.data.method); - promises.forEach(function (promise) { - var error = new Error(data.data.message); - error.name = data.data.name; - promise.reject(error); - removeCallback(player, data.data.method, promise); - }); + if (!isVimeoUrl(event.origin)) { + return; } - callbacks = getCallbacks(player, "event:".concat(data.event)); - param = data.data; - } else if (data.method) { - var callback = shiftCallbacks(player, data.method); + var iframes = parent.querySelectorAll('iframe'); - if (callback) { - callbacks.push(callback); - param = data.value; - } - } + for (var i = 0; i < iframes.length; i++) { + var iframe = iframes[i]; // Initiate appendVideoMetadata if iframe is a Vimeo embed - callbacks.forEach(function (callback) { - try { - if (typeof callback === 'function') { - callback.call(player, param); - return; - } + var isValidMessageSource = iframe.contentWindow === event.source; - callback.resolve(param); - } catch (e) {// empty + if (isVimeoEmbedWithHashParam(iframe.src) && isValidMessageSource) { + var player = new Player(iframe); + player.callMethod('appendVideoMetadata', window.location.href); + } } - }); + }; + + window.addEventListener('message', onMessage); } /* MIT License @@ -2511,6 +2575,7 @@ screenfull = initializeScreenfull(); initializeEmbeds(); resizeEmbeds(); + initAppendVideoMetadata(); } return Player; diff --git a/dist/player.js.map b/dist/player.js.map index 110f64cab..ef698e13b 100644 --- a/dist/player.js.map +++ b/dist/player.js.map @@ -1 +1 @@ -{"version":3,"file":"player.js","sources":["src/lib/functions.js","src/lib/compatibility-check.js","node_modules/weakmap-polyfill/weakmap-polyfill.js","node_modules/native-promise-only/lib/npo.src.js","src/lib/callbacks.js","src/lib/embed.js","src/lib/postmessage.js","src/lib/screenfull.js","src/player.js"],"sourcesContent":["/**\n * @module lib/functions\n */\n\n/**\n * Check to see this is a node environment.\n * @type {Boolean}\n */\n/* global global */\nexport const isNode = typeof global !== 'undefined' &&\n ({}).toString.call(global) === '[object global]';\n\n/**\n * Get the name of the method for a given getter or setter.\n *\n * @param {string} prop The name of the property.\n * @param {string} type Either “get” or “set”.\n * @return {string}\n */\nexport function getMethodName(prop, type) {\n if (prop.indexOf(type.toLowerCase()) === 0) {\n return prop;\n }\n\n return `${type.toLowerCase()}${prop.substr(0, 1).toUpperCase()}${prop.substr(1)}`;\n}\n\n/**\n * Check to see if the object is a DOM Element.\n *\n * @param {*} element The object to check.\n * @return {boolean}\n */\nexport function isDomElement(element) {\n return Boolean(\n element && element.nodeType === 1 && 'nodeName' in element &&\n element.ownerDocument && element.ownerDocument.defaultView\n );\n}\n\n/**\n * Check to see whether the value is a number.\n *\n * @see http://dl.dropboxusercontent.com/u/35146/js/tests/isNumber.html\n * @param {*} value The value to check.\n * @param {boolean} integer Check if the value is an integer.\n * @return {boolean}\n */\nexport function isInteger(value) {\n // eslint-disable-next-line eqeqeq\n return !isNaN(parseFloat(value)) && isFinite(value) && Math.floor(value) == value;\n}\n\n/**\n * Check to see if the URL is a Vimeo url.\n *\n * @param {string} url The url string.\n * @return {boolean}\n */\nexport function isVimeoUrl(url) {\n return (/^(https?:)?\\/\\/((player|www)\\.)?vimeo\\.com(?=$|\\/)/).test(url);\n}\n\n/**\n * Get the Vimeo URL from an element.\n * The element must have either a data-vimeo-id or data-vimeo-url attribute.\n *\n * @param {object} oEmbedParameters The oEmbed parameters.\n * @return {string}\n */\nexport function getVimeoUrl(oEmbedParameters = {}) {\n const id = oEmbedParameters.id;\n const url = oEmbedParameters.url;\n const idOrUrl = id || url;\n\n if (!idOrUrl) {\n throw new Error('An id or url must be passed, either in an options object or as a data-vimeo-id or data-vimeo-url attribute.');\n }\n\n if (isInteger(idOrUrl)) {\n return `https://vimeo.com/${idOrUrl}`;\n }\n\n if (isVimeoUrl(idOrUrl)) {\n return idOrUrl.replace('http:', 'https:');\n }\n\n if (id) {\n throw new TypeError(`“${id}” is not a valid video id.`);\n }\n\n throw new TypeError(`“${idOrUrl}” is not a vimeo.com url.`);\n}\n","import { isNode } from './functions';\n\nconst arrayIndexOfSupport = typeof Array.prototype.indexOf !== 'undefined';\nconst postMessageSupport = typeof window !== 'undefined' && typeof window.postMessage !== 'undefined';\n\nif (!isNode && (!arrayIndexOfSupport || !postMessageSupport)) {\n throw new Error('Sorry, the Vimeo Player API is not available in this browser.');\n}\n","/*!\n * weakmap-polyfill v2.0.1 - ECMAScript6 WeakMap polyfill\n * https://github.com/polygonplanet/weakmap-polyfill\n * Copyright (c) 2015-2020 Polygon Planet \n * @license MIT\n */\n\n(function(self) {\n 'use strict';\n\n if (self.WeakMap) {\n return;\n }\n\n var hasOwnProperty = Object.prototype.hasOwnProperty;\n var defineProperty = function(object, name, value) {\n if (Object.defineProperty) {\n Object.defineProperty(object, name, {\n configurable: true,\n writable: true,\n value: value\n });\n } else {\n object[name] = value;\n }\n };\n\n self.WeakMap = (function() {\n\n // ECMA-262 23.3 WeakMap Objects\n function WeakMap() {\n if (this === void 0) {\n throw new TypeError(\"Constructor WeakMap requires 'new'\");\n }\n\n defineProperty(this, '_id', genId('_WeakMap'));\n\n // ECMA-262 23.3.1.1 WeakMap([iterable])\n if (arguments.length > 0) {\n // Currently, WeakMap `iterable` argument is not supported\n throw new TypeError('WeakMap iterable is not supported');\n }\n }\n\n // ECMA-262 23.3.3.2 WeakMap.prototype.delete(key)\n defineProperty(WeakMap.prototype, 'delete', function(key) {\n checkInstance(this, 'delete');\n\n if (!isObject(key)) {\n return false;\n }\n\n var entry = key[this._id];\n if (entry && entry[0] === key) {\n delete key[this._id];\n return true;\n }\n\n return false;\n });\n\n // ECMA-262 23.3.3.3 WeakMap.prototype.get(key)\n defineProperty(WeakMap.prototype, 'get', function(key) {\n checkInstance(this, 'get');\n\n if (!isObject(key)) {\n return void 0;\n }\n\n var entry = key[this._id];\n if (entry && entry[0] === key) {\n return entry[1];\n }\n\n return void 0;\n });\n\n // ECMA-262 23.3.3.4 WeakMap.prototype.has(key)\n defineProperty(WeakMap.prototype, 'has', function(key) {\n checkInstance(this, 'has');\n\n if (!isObject(key)) {\n return false;\n }\n\n var entry = key[this._id];\n if (entry && entry[0] === key) {\n return true;\n }\n\n return false;\n });\n\n // ECMA-262 23.3.3.5 WeakMap.prototype.set(key, value)\n defineProperty(WeakMap.prototype, 'set', function(key, value) {\n checkInstance(this, 'set');\n\n if (!isObject(key)) {\n throw new TypeError('Invalid value used as weak map key');\n }\n\n var entry = key[this._id];\n if (entry && entry[0] === key) {\n entry[1] = value;\n return this;\n }\n\n defineProperty(key, this._id, [key, value]);\n return this;\n });\n\n\n function checkInstance(x, methodName) {\n if (!isObject(x) || !hasOwnProperty.call(x, '_id')) {\n throw new TypeError(\n methodName + ' method called on incompatible receiver ' +\n typeof x\n );\n }\n }\n\n function genId(prefix) {\n return prefix + '_' + rand() + '.' + rand();\n }\n\n function rand() {\n return Math.random().toString().substring(2);\n }\n\n\n defineProperty(WeakMap, '_polyfill', true);\n return WeakMap;\n })();\n\n\n function isObject(x) {\n return Object(x) === x;\n }\n\n})(\n typeof self !== 'undefined' ? self :\n typeof window !== 'undefined' ? window :\n typeof global !== 'undefined' ? global : this\n);\n","/*! Native Promise Only\n v0.8.1 (c) Kyle Simpson\n MIT License: http://getify.mit-license.org\n*/\n\n(function UMD(name,context,definition){\n\t// special form of UMD for polyfilling across evironments\n\tcontext[name] = context[name] || definition();\n\tif (typeof module != \"undefined\" && module.exports) { module.exports = context[name]; }\n\telse if (typeof define == \"function\" && define.amd) { define(function $AMD$(){ return context[name]; }); }\n})(\"Promise\",typeof global != \"undefined\" ? global : this,function DEF(){\n\t/*jshint validthis:true */\n\t\"use strict\";\n\n\tvar builtInProp, cycle, scheduling_queue,\n\t\tToString = Object.prototype.toString,\n\t\ttimer = (typeof setImmediate != \"undefined\") ?\n\t\t\tfunction timer(fn) { return setImmediate(fn); } :\n\t\t\tsetTimeout\n\t;\n\n\t// dammit, IE8.\n\ttry {\n\t\tObject.defineProperty({},\"x\",{});\n\t\tbuiltInProp = function builtInProp(obj,name,val,config) {\n\t\t\treturn Object.defineProperty(obj,name,{\n\t\t\t\tvalue: val,\n\t\t\t\twritable: true,\n\t\t\t\tconfigurable: config !== false\n\t\t\t});\n\t\t};\n\t}\n\tcatch (err) {\n\t\tbuiltInProp = function builtInProp(obj,name,val) {\n\t\t\tobj[name] = val;\n\t\t\treturn obj;\n\t\t};\n\t}\n\n\t// Note: using a queue instead of array for efficiency\n\tscheduling_queue = (function Queue() {\n\t\tvar first, last, item;\n\n\t\tfunction Item(fn,self) {\n\t\t\tthis.fn = fn;\n\t\t\tthis.self = self;\n\t\t\tthis.next = void 0;\n\t\t}\n\n\t\treturn {\n\t\t\tadd: function add(fn,self) {\n\t\t\t\titem = new Item(fn,self);\n\t\t\t\tif (last) {\n\t\t\t\t\tlast.next = item;\n\t\t\t\t}\n\t\t\t\telse {\n\t\t\t\t\tfirst = item;\n\t\t\t\t}\n\t\t\t\tlast = item;\n\t\t\t\titem = void 0;\n\t\t\t},\n\t\t\tdrain: function drain() {\n\t\t\t\tvar f = first;\n\t\t\t\tfirst = last = cycle = void 0;\n\n\t\t\t\twhile (f) {\n\t\t\t\t\tf.fn.call(f.self);\n\t\t\t\t\tf = f.next;\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\t})();\n\n\tfunction schedule(fn,self) {\n\t\tscheduling_queue.add(fn,self);\n\t\tif (!cycle) {\n\t\t\tcycle = timer(scheduling_queue.drain);\n\t\t}\n\t}\n\n\t// promise duck typing\n\tfunction isThenable(o) {\n\t\tvar _then, o_type = typeof o;\n\n\t\tif (o != null &&\n\t\t\t(\n\t\t\t\to_type == \"object\" || o_type == \"function\"\n\t\t\t)\n\t\t) {\n\t\t\t_then = o.then;\n\t\t}\n\t\treturn typeof _then == \"function\" ? _then : false;\n\t}\n\n\tfunction notify() {\n\t\tfor (var i=0; i 0) {\n\t\t\t\t\tschedule(notify,self);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tcatch (err) {\n\t\t\treject.call(new MakeDefWrapper(self),err);\n\t\t}\n\t}\n\n\tfunction reject(msg) {\n\t\tvar self = this;\n\n\t\t// already triggered?\n\t\tif (self.triggered) { return; }\n\n\t\tself.triggered = true;\n\n\t\t// unwrap\n\t\tif (self.def) {\n\t\t\tself = self.def;\n\t\t}\n\n\t\tself.msg = msg;\n\t\tself.state = 2;\n\t\tif (self.chain.length > 0) {\n\t\t\tschedule(notify,self);\n\t\t}\n\t}\n\n\tfunction iteratePromises(Constructor,arr,resolver,rejecter) {\n\t\tfor (var idx=0; idx}\n */\nexport function getOEmbedParameters(element, defaults = {}) {\n return oEmbedParameters.reduce((params, param) => {\n const value = element.getAttribute(`data-vimeo-${param}`);\n\n if (value || value === '') {\n params[param] = value === '' ? 1 : value;\n }\n\n return params;\n }, defaults);\n}\n\n/**\n * Create an embed from oEmbed data inside an element.\n *\n * @param {object} data The oEmbed data.\n * @param {HTMLElement} element The element to put the iframe in.\n * @return {HTMLIFrameElement} The iframe embed.\n */\nexport function createEmbed({ html }, element) {\n if (!element) {\n throw new TypeError('An element must be provided');\n }\n\n if (element.getAttribute('data-vimeo-initialized') !== null) {\n return element.querySelector('iframe');\n }\n\n const div = document.createElement('div');\n div.innerHTML = html;\n\n element.appendChild(div.firstChild);\n element.setAttribute('data-vimeo-initialized', 'true');\n\n return element.querySelector('iframe');\n}\n\n/**\n * Make an oEmbed call for the specified URL.\n *\n * @param {string} videoUrl The vimeo.com url for the video.\n * @param {Object} [params] Parameters to pass to oEmbed.\n * @param {HTMLElement} element The element.\n * @return {Promise}\n */\nexport function getOEmbedData(videoUrl, params = {}, element) {\n return new Promise((resolve, reject) => {\n if (!isVimeoUrl(videoUrl)) {\n throw new TypeError(`“${videoUrl}” is not a vimeo.com url.`);\n }\n\n let url = `https://vimeo.com/api/oembed.json?url=${encodeURIComponent(videoUrl)}`;\n\n for (const param in params) {\n if (params.hasOwnProperty(param)) {\n url += `&${param}=${encodeURIComponent(params[param])}`;\n }\n }\n\n const xhr = 'XDomainRequest' in window ? new XDomainRequest() : new XMLHttpRequest();\n xhr.open('GET', url, true);\n\n xhr.onload = function() {\n if (xhr.status === 404) {\n reject(new Error(`“${videoUrl}” was not found.`));\n return;\n }\n\n if (xhr.status === 403) {\n reject(new Error(`“${videoUrl}” is not embeddable.`));\n return;\n }\n\n try {\n const json = JSON.parse(xhr.responseText);\n // Check api response for 403 on oembed\n if (json.domain_status_code === 403) {\n // We still want to create the embed to give users visual feedback\n createEmbed(json, element);\n reject(new Error(`“${videoUrl}” is not embeddable.`));\n return;\n }\n\n resolve(json);\n }\n catch (error) {\n reject(error);\n }\n };\n\n xhr.onerror = function() {\n const status = xhr.status ? ` (${xhr.status})` : '';\n reject(new Error(`There was an error fetching the embed code from Vimeo${status}.`));\n };\n\n xhr.send();\n });\n}\n\n/**\n * Initialize all embeds within a specific element\n *\n * @param {HTMLElement} [parent=document] The parent element.\n * @return {void}\n */\nexport function initializeEmbeds(parent = document) {\n const elements = [].slice.call(parent.querySelectorAll('[data-vimeo-id], [data-vimeo-url]'));\n\n const handleError = (error) => {\n if ('console' in window && console.error) {\n console.error(`There was an error creating an embed: ${error}`);\n }\n };\n\n elements.forEach((element) => {\n try {\n // Skip any that have data-vimeo-defer\n if (element.getAttribute('data-vimeo-defer') !== null) {\n return;\n }\n\n const params = getOEmbedParameters(element);\n const url = getVimeoUrl(params);\n\n getOEmbedData(url, params, element).then((data) => {\n return createEmbed(data, element);\n }).catch(handleError);\n }\n catch (error) {\n handleError(error);\n }\n });\n}\n\n/**\n * Resize embeds when messaged by the player.\n *\n * @param {HTMLElement} [parent=document] The parent element.\n * @return {void}\n */\nexport function resizeEmbeds(parent = document) {\n // Prevent execution if users include the player.js script multiple times.\n if (window.VimeoPlayerResizeEmbeds_) {\n return;\n }\n window.VimeoPlayerResizeEmbeds_ = true;\n\n const onMessage = (event) => {\n if (!isVimeoUrl(event.origin)) {\n return;\n }\n\n // 'spacechange' is fired only on embeds with cards\n if (!event.data || event.data.event !== 'spacechange') {\n return;\n }\n\n const iframes = parent.querySelectorAll('iframe');\n\n for (let i = 0; i < iframes.length; i++) {\n if (iframes[i].contentWindow !== event.source) {\n continue;\n }\n\n // Change padding-bottom of the enclosing div to accommodate\n // card carousel without distorting aspect ratio\n const space = iframes[i].parentElement;\n space.style.paddingBottom = `${event.data.data[0].bottom}px`;\n\n break;\n }\n };\n\n window.addEventListener('message', onMessage);\n}\n","/**\n * @module lib/postmessage\n */\n\nimport { getCallbacks, removeCallback, shiftCallbacks } from './callbacks';\n\n/**\n * Parse a message received from postMessage.\n *\n * @param {*} data The data received from postMessage.\n * @return {object}\n */\nexport function parseMessageData(data) {\n if (typeof data === 'string') {\n try {\n data = JSON.parse(data);\n }\n catch (error) {\n // If the message cannot be parsed, throw the error as a warning\n console.warn(error);\n return {};\n }\n }\n\n return data;\n}\n\n/**\n * Post a message to the specified target.\n *\n * @param {Player} player The player object to use.\n * @param {string} method The API method to call.\n * @param {object} params The parameters to send to the player.\n * @return {void}\n */\nexport function postMessage(player, method, params) {\n if (!player.element.contentWindow || !player.element.contentWindow.postMessage) {\n return;\n }\n\n let message = {\n method\n };\n\n if (params !== undefined) {\n message.value = params;\n }\n\n // IE 8 and 9 do not support passing messages, so stringify them\n const ieVersion = parseFloat(navigator.userAgent.toLowerCase().replace(/^.*msie (\\d+).*$/, '$1'));\n if (ieVersion >= 8 && ieVersion < 10) {\n message = JSON.stringify(message);\n }\n\n player.element.contentWindow.postMessage(message, player.origin);\n}\n\n/**\n * Parse the data received from a message event.\n *\n * @param {Player} player The player that received the message.\n * @param {(Object|string)} data The message data. Strings will be parsed into JSON.\n * @return {void}\n */\nexport function processData(player, data) {\n data = parseMessageData(data);\n let callbacks = [];\n let param;\n\n if (data.event) {\n if (data.event === 'error') {\n const promises = getCallbacks(player, data.data.method);\n\n promises.forEach((promise) => {\n const error = new Error(data.data.message);\n error.name = data.data.name;\n\n promise.reject(error);\n removeCallback(player, data.data.method, promise);\n });\n }\n\n callbacks = getCallbacks(player, `event:${data.event}`);\n param = data.data;\n }\n else if (data.method) {\n const callback = shiftCallbacks(player, data.method);\n\n if (callback) {\n callbacks.push(callback);\n param = data.value;\n }\n }\n\n callbacks.forEach((callback) => {\n try {\n if (typeof callback === 'function') {\n callback.call(player, param);\n return;\n }\n\n callback.resolve(param);\n }\n catch (e) {\n // empty\n }\n });\n}\n","/* MIT License\n\nCopyright (c) Sindre Sorhus (sindresorhus.com)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\nTerms */\n\nexport function initializeScreenfull() {\n\n const fn = (function() {\n let val;\n\n const fnMap = [\n [\n 'requestFullscreen',\n 'exitFullscreen',\n 'fullscreenElement',\n 'fullscreenEnabled',\n 'fullscreenchange',\n 'fullscreenerror'\n ],\n // New WebKit\n [\n 'webkitRequestFullscreen',\n 'webkitExitFullscreen',\n 'webkitFullscreenElement',\n 'webkitFullscreenEnabled',\n 'webkitfullscreenchange',\n 'webkitfullscreenerror'\n\n ],\n // Old WebKit\n [\n 'webkitRequestFullScreen',\n 'webkitCancelFullScreen',\n 'webkitCurrentFullScreenElement',\n 'webkitCancelFullScreen',\n 'webkitfullscreenchange',\n 'webkitfullscreenerror'\n\n ],\n [\n 'mozRequestFullScreen',\n 'mozCancelFullScreen',\n 'mozFullScreenElement',\n 'mozFullScreenEnabled',\n 'mozfullscreenchange',\n 'mozfullscreenerror'\n ],\n [\n 'msRequestFullscreen',\n 'msExitFullscreen',\n 'msFullscreenElement',\n 'msFullscreenEnabled',\n 'MSFullscreenChange',\n 'MSFullscreenError'\n ]\n ];\n\n let i = 0;\n const l = fnMap.length;\n const ret = {};\n\n for (; i < l; i++) {\n val = fnMap[i];\n if (val && val[1] in document) {\n for (i = 0; i < val.length; i++) {\n ret[fnMap[0][i]] = val[i];\n }\n return ret;\n }\n }\n\n return false;\n }());\n\n const eventNameMap = {\n fullscreenchange: fn.fullscreenchange,\n fullscreenerror: fn.fullscreenerror\n };\n\n const screenfull = {\n request(element) {\n return new Promise((resolve, reject) => {\n const onFullScreenEntered = function() {\n screenfull.off('fullscreenchange', onFullScreenEntered);\n resolve();\n };\n\n screenfull.on('fullscreenchange', onFullScreenEntered);\n\n element = element || document.documentElement;\n\n const returnPromise = element[fn.requestFullscreen]();\n if (returnPromise instanceof Promise) {\n returnPromise.then(onFullScreenEntered).catch(reject);\n }\n });\n },\n exit() {\n return new Promise((resolve, reject) => {\n if (!screenfull.isFullscreen) {\n resolve();\n return;\n }\n\n const onFullScreenExit = function() {\n screenfull.off('fullscreenchange', onFullScreenExit);\n resolve();\n };\n\n screenfull.on('fullscreenchange', onFullScreenExit);\n\n const returnPromise = document[fn.exitFullscreen]();\n if (returnPromise instanceof Promise) {\n returnPromise.then(onFullScreenExit).catch(reject);\n }\n });\n },\n on(event, callback) {\n const eventName = eventNameMap[event];\n if (eventName) {\n document.addEventListener(eventName, callback);\n }\n },\n off(event, callback) {\n const eventName = eventNameMap[event];\n if (eventName) {\n document.removeEventListener(eventName, callback);\n }\n }\n };\n\n Object.defineProperties(screenfull, {\n isFullscreen: {\n get() {\n return Boolean(document[fn.fullscreenElement]);\n }\n },\n element: {\n enumerable: true,\n get() {\n return document[fn.fullscreenElement];\n }\n },\n isEnabled: {\n enumerable: true,\n get() {\n // Coerce to boolean in case of old WebKit\n return Boolean(document[fn.fullscreenEnabled]);\n }\n }\n });\n\n return screenfull;\n}\n","import './lib/compatibility-check';\n\nimport 'weakmap-polyfill';\nimport Promise from 'native-promise-only';\n\nimport { storeCallback, getCallbacks, removeCallback, swapCallbacks } from './lib/callbacks';\nimport { getMethodName, isDomElement, isVimeoUrl, getVimeoUrl, isNode } from './lib/functions';\nimport { getOEmbedParameters, getOEmbedData, createEmbed, initializeEmbeds, resizeEmbeds } from './lib/embed';\nimport { parseMessageData, postMessage, processData } from './lib/postmessage';\nimport { initializeScreenfull } from './lib/screenfull.js';\n\nconst playerMap = new WeakMap();\nconst readyMap = new WeakMap();\nlet screenfull = {};\n\nclass Player {\n /**\n * Create a Player.\n *\n * @param {(HTMLIFrameElement|HTMLElement|string|jQuery)} element A reference to the Vimeo\n * player iframe, and id, or a jQuery object.\n * @param {object} [options] oEmbed parameters to use when creating an embed in the element.\n * @return {Player}\n */\n constructor(element, options = {}) {\n /* global jQuery */\n if (window.jQuery && element instanceof jQuery) {\n if (element.length > 1 && window.console && console.warn) {\n console.warn('A jQuery object with multiple elements was passed, using the first element.');\n }\n\n element = element[0];\n }\n\n // Find an element by ID\n if (typeof document !== 'undefined' && typeof element === 'string') {\n element = document.getElementById(element);\n }\n\n // Not an element!\n if (!isDomElement(element)) {\n throw new TypeError('You must pass either a valid element or a valid id.');\n }\n\n // Already initialized an embed in this div, so grab the iframe\n if (element.nodeName !== 'IFRAME') {\n const iframe = element.querySelector('iframe');\n\n if (iframe) {\n element = iframe;\n }\n }\n\n // iframe url is not a Vimeo url\n if (element.nodeName === 'IFRAME' && !isVimeoUrl(element.getAttribute('src') || '')) {\n throw new Error('The player element passed isn’t a Vimeo embed.');\n }\n\n // If there is already a player object in the map, return that\n if (playerMap.has(element)) {\n return playerMap.get(element);\n }\n\n this._window = element.ownerDocument.defaultView;\n this.element = element;\n this.origin = '*';\n\n const readyPromise = new Promise((resolve, reject) => {\n this._onMessage = (event) => {\n if (!isVimeoUrl(event.origin) || this.element.contentWindow !== event.source) {\n return;\n }\n\n if (this.origin === '*') {\n this.origin = event.origin;\n }\n\n const data = parseMessageData(event.data);\n const isError = data && data.event === 'error';\n const isReadyError = isError && data.data && data.data.method === 'ready';\n\n if (isReadyError) {\n const error = new Error(data.data.message);\n error.name = data.data.name;\n reject(error);\n return;\n }\n\n const isReadyEvent = data && data.event === 'ready';\n const isPingResponse = data && data.method === 'ping';\n\n if (isReadyEvent || isPingResponse) {\n this.element.setAttribute('data-ready', 'true');\n resolve();\n return;\n }\n\n processData(this, data);\n };\n\n this._window.addEventListener('message', this._onMessage);\n\n if (this.element.nodeName !== 'IFRAME') {\n const params = getOEmbedParameters(element, options);\n const url = getVimeoUrl(params);\n\n getOEmbedData(url, params, element).then((data) => {\n const iframe = createEmbed(data, element);\n // Overwrite element with the new iframe,\n // but store reference to the original element\n this.element = iframe;\n this._originalElement = element;\n\n swapCallbacks(element, iframe);\n playerMap.set(this.element, this);\n\n return data;\n }).catch(reject);\n }\n });\n\n // Store a copy of this Player in the map\n readyMap.set(this, readyPromise);\n playerMap.set(this.element, this);\n\n // Send a ping to the iframe so the ready promise will be resolved if\n // the player is already ready.\n if (this.element.nodeName === 'IFRAME') {\n postMessage(this, 'ping');\n }\n\n if (screenfull.isEnabled) {\n const exitFullscreen = () => screenfull.exit();\n this.fullscreenchangeHandler = () => {\n if (screenfull.isFullscreen) {\n storeCallback(this, 'event:exitFullscreen', exitFullscreen);\n }\n else {\n removeCallback(this, 'event:exitFullscreen', exitFullscreen);\n }\n // eslint-disable-next-line\n this.ready().then(() => {\n postMessage(this, 'fullscreenchange', screenfull.isFullscreen);\n });\n };\n\n screenfull.on('fullscreenchange', this.fullscreenchangeHandler);\n }\n\n return this;\n }\n\n /**\n * Get a promise for a method.\n *\n * @param {string} name The API method to call.\n * @param {Object} [args={}] Arguments to send via postMessage.\n * @return {Promise}\n */\n callMethod(name, args = {}) {\n return new Promise((resolve, reject) => {\n // We are storing the resolve/reject handlers to call later, so we\n // can’t return here.\n // eslint-disable-next-line promise/always-return\n return this.ready().then(() => {\n storeCallback(this, name, {\n resolve,\n reject\n });\n\n postMessage(this, name, args);\n }).catch(reject);\n });\n }\n\n /**\n * Get a promise for the value of a player property.\n *\n * @param {string} name The property name\n * @return {Promise}\n */\n get(name) {\n return new Promise((resolve, reject) => {\n name = getMethodName(name, 'get');\n\n // We are storing the resolve/reject handlers to call later, so we\n // can’t return here.\n // eslint-disable-next-line promise/always-return\n return this.ready().then(() => {\n storeCallback(this, name, {\n resolve,\n reject\n });\n\n postMessage(this, name);\n }).catch(reject);\n });\n }\n\n /**\n * Get a promise for setting the value of a player property.\n *\n * @param {string} name The API method to call.\n * @param {mixed} value The value to set.\n * @return {Promise}\n */\n set(name, value) {\n return new Promise((resolve, reject) => {\n name = getMethodName(name, 'set');\n\n if (value === undefined || value === null) {\n throw new TypeError('There must be a value to set.');\n }\n\n // We are storing the resolve/reject handlers to call later, so we\n // can’t return here.\n // eslint-disable-next-line promise/always-return\n return this.ready().then(() => {\n storeCallback(this, name, {\n resolve,\n reject\n });\n\n postMessage(this, name, value);\n }).catch(reject);\n });\n }\n\n /**\n * Add an event listener for the specified event. Will call the\n * callback with a single parameter, `data`, that contains the data for\n * that event.\n *\n * @param {string} eventName The name of the event.\n * @param {function(*)} callback The function to call when the event fires.\n * @return {void}\n */\n on(eventName, callback) {\n if (!eventName) {\n throw new TypeError('You must pass an event name.');\n }\n\n if (!callback) {\n throw new TypeError('You must pass a callback function.');\n }\n\n if (typeof callback !== 'function') {\n throw new TypeError('The callback must be a function.');\n }\n\n const callbacks = getCallbacks(this, `event:${eventName}`);\n if (callbacks.length === 0) {\n this.callMethod('addEventListener', eventName).catch(() => {\n // Ignore the error. There will be an error event fired that\n // will trigger the error callback if they are listening.\n });\n }\n\n storeCallback(this, `event:${eventName}`, callback);\n }\n\n /**\n * Remove an event listener for the specified event. Will remove all\n * listeners for that event if a `callback` isn’t passed, or only that\n * specific callback if it is passed.\n *\n * @param {string} eventName The name of the event.\n * @param {function} [callback] The specific callback to remove.\n * @return {void}\n */\n off(eventName, callback) {\n if (!eventName) {\n throw new TypeError('You must pass an event name.');\n }\n\n if (callback && typeof callback !== 'function') {\n throw new TypeError('The callback must be a function.');\n }\n\n const lastCallback = removeCallback(this, `event:${eventName}`, callback);\n\n // If there are no callbacks left, remove the listener\n if (lastCallback) {\n this.callMethod('removeEventListener', eventName).catch((e) => {\n // Ignore the error. There will be an error event fired that\n // will trigger the error callback if they are listening.\n });\n }\n }\n\n /**\n * A promise to load a new video.\n *\n * @promise LoadVideoPromise\n * @fulfill {number} The video with this id or url successfully loaded.\n * @reject {TypeError} The id was not a number.\n */\n /**\n * Load a new video into this embed. The promise will be resolved if\n * the video is successfully loaded, or it will be rejected if it could\n * not be loaded.\n *\n * @param {number|string|object} options The id of the video, the url of the video, or an object with embed options.\n * @return {LoadVideoPromise}\n */\n loadVideo(options) {\n return this.callMethod('loadVideo', options);\n }\n\n /**\n * A promise to perform an action when the Player is ready.\n *\n * @todo document errors\n * @promise LoadVideoPromise\n * @fulfill {void}\n */\n /**\n * Trigger a function when the player iframe has initialized. You do not\n * need to wait for `ready` to trigger to begin adding event listeners\n * or calling other methods.\n *\n * @return {ReadyPromise}\n */\n ready() {\n const readyPromise = readyMap.get(this) || new Promise((resolve, reject) => {\n reject(new Error('Unknown player. Probably unloaded.'));\n });\n return Promise.resolve(readyPromise);\n }\n\n /**\n * A promise to add a cue point to the player.\n *\n * @promise AddCuePointPromise\n * @fulfill {string} The id of the cue point to use for removeCuePoint.\n * @reject {RangeError} the time was less than 0 or greater than the\n * video’s duration.\n * @reject {UnsupportedError} Cue points are not supported with the current\n * player or browser.\n */\n /**\n * Add a cue point to the player.\n *\n * @param {number} time The time for the cue point.\n * @param {object} [data] Arbitrary data to be returned with the cue point.\n * @return {AddCuePointPromise}\n */\n addCuePoint(time, data = {}) {\n return this.callMethod('addCuePoint', { time, data });\n }\n\n /**\n * A promise to remove a cue point from the player.\n *\n * @promise AddCuePointPromise\n * @fulfill {string} The id of the cue point that was removed.\n * @reject {InvalidCuePoint} The cue point with the specified id was not\n * found.\n * @reject {UnsupportedError} Cue points are not supported with the current\n * player or browser.\n */\n /**\n * Remove a cue point from the video.\n *\n * @param {string} id The id of the cue point to remove.\n * @return {RemoveCuePointPromise}\n */\n removeCuePoint(id) {\n return this.callMethod('removeCuePoint', id);\n }\n\n /**\n * A representation of a text track on a video.\n *\n * @typedef {Object} VimeoTextTrack\n * @property {string} language The ISO language code.\n * @property {string} kind The kind of track it is (captions or subtitles).\n * @property {string} label The human‐readable label for the track.\n */\n /**\n * A promise to enable a text track.\n *\n * @promise EnableTextTrackPromise\n * @fulfill {VimeoTextTrack} The text track that was enabled.\n * @reject {InvalidTrackLanguageError} No track was available with the\n * specified language.\n * @reject {InvalidTrackError} No track was available with the specified\n * language and kind.\n */\n /**\n * Enable the text track with the specified language, and optionally the\n * specified kind (captions or subtitles).\n *\n * When set via the API, the track language will not change the viewer’s\n * stored preference.\n *\n * @param {string} language The two‐letter language code.\n * @param {string} [kind] The kind of track to enable (captions or subtitles).\n * @return {EnableTextTrackPromise}\n */\n enableTextTrack(language, kind) {\n if (!language) {\n throw new TypeError('You must pass a language.');\n }\n\n return this.callMethod('enableTextTrack', {\n language,\n kind\n });\n }\n\n /**\n * A promise to disable the active text track.\n *\n * @promise DisableTextTrackPromise\n * @fulfill {void} The track was disabled.\n */\n /**\n * Disable the currently-active text track.\n *\n * @return {DisableTextTrackPromise}\n */\n disableTextTrack() {\n return this.callMethod('disableTextTrack');\n }\n\n /**\n * A promise to pause the video.\n *\n * @promise PausePromise\n * @fulfill {void} The video was paused.\n */\n /**\n * Pause the video if it’s playing.\n *\n * @return {PausePromise}\n */\n pause() {\n return this.callMethod('pause');\n }\n\n /**\n * A promise to play the video.\n *\n * @promise PlayPromise\n * @fulfill {void} The video was played.\n */\n /**\n * Play the video if it’s paused. **Note:** on iOS and some other\n * mobile devices, you cannot programmatically trigger play. Once the\n * viewer has tapped on the play button in the player, however, you\n * will be able to use this function.\n *\n * @return {PlayPromise}\n */\n play() {\n return this.callMethod('play');\n }\n\n /**\n * Request that the player enters fullscreen.\n * @return {Promise}\n */\n requestFullscreen() {\n if (screenfull.isEnabled) {\n return screenfull.request(this.element);\n }\n return this.callMethod('requestFullscreen');\n }\n\n /**\n * Request that the player exits fullscreen.\n * @return {Promise}\n */\n exitFullscreen() {\n if (screenfull.isEnabled) {\n return screenfull.exit();\n }\n return this.callMethod('exitFullscreen');\n }\n\n /**\n * Returns true if the player is currently fullscreen.\n * @return {Promise}\n */\n getFullscreen() {\n if (screenfull.isEnabled) {\n return Promise.resolve(screenfull.isFullscreen);\n }\n return this.get('fullscreen');\n }\n\n /**\n * Request that the player enters picture-in-picture.\n * @return {Promise}\n */\n requestPictureInPicture() {\n return this.callMethod('requestPictureInPicture');\n }\n\n /**\n * Request that the player exits picture-in-picture.\n * @return {Promise}\n */\n exitPictureInPicture() {\n return this.callMethod('exitPictureInPicture');\n }\n\n /**\n * Returns true if the player is currently picture-in-picture.\n * @return {Promise}\n */\n getPictureInPicture() {\n return this.get('pictureInPicture');\n }\n\n /**\n * A promise to unload the video.\n *\n * @promise UnloadPromise\n * @fulfill {void} The video was unloaded.\n */\n /**\n * Return the player to its initial state.\n *\n * @return {UnloadPromise}\n */\n unload() {\n return this.callMethod('unload');\n }\n\n /**\n * Cleanup the player and remove it from the DOM\n *\n * It won't be usable and a new one should be constructed\n * in order to do any operations.\n *\n * @return {Promise}\n */\n destroy() {\n return new Promise((resolve) => {\n readyMap.delete(this);\n playerMap.delete(this.element);\n\n if (this._originalElement) {\n playerMap.delete(this._originalElement);\n this._originalElement.removeAttribute('data-vimeo-initialized');\n }\n\n if (this.element && this.element.nodeName === 'IFRAME' && this.element.parentNode) {\n // If we've added an additional wrapper div, remove that from the DOM.\n // If not, just remove the iframe element.\n if (this.element.parentNode.parentNode && this._originalElement && this._originalElement !== this.element.parentNode) {\n this.element.parentNode.parentNode.removeChild(this.element.parentNode);\n }\n else {\n this.element.parentNode.removeChild(this.element);\n }\n }\n\n // If the clip is private there is a case where the element stays the\n // div element. Destroy should reset the div and remove the iframe child.\n if (this.element && this.element.nodeName === 'DIV' && this.element.parentNode) {\n this.element.removeAttribute('data-vimeo-initialized');\n const iframe = this.element.querySelector('iframe');\n if (iframe && iframe.parentNode) {\n // If we've added an additional wrapper div, remove that from the DOM.\n // If not, just remove the iframe element.\n if (iframe.parentNode.parentNode && this._originalElement && this._originalElement !== iframe.parentNode) {\n iframe.parentNode.parentNode.removeChild(iframe.parentNode);\n }\n else {\n iframe.parentNode.removeChild(iframe);\n }\n }\n }\n\n this._window.removeEventListener('message', this._onMessage);\n\n if (screenfull.isEnabled) {\n screenfull.off('fullscreenchange', this.fullscreenchangeHandler);\n }\n\n resolve();\n });\n }\n\n /**\n * A promise to get the autopause behavior of the video.\n *\n * @promise GetAutopausePromise\n * @fulfill {boolean} Whether autopause is turned on or off.\n * @reject {UnsupportedError} Autopause is not supported with the current\n * player or browser.\n */\n /**\n * Get the autopause behavior for this player.\n *\n * @return {GetAutopausePromise}\n */\n getAutopause() {\n return this.get('autopause');\n }\n\n /**\n * A promise to set the autopause behavior of the video.\n *\n * @promise SetAutopausePromise\n * @fulfill {boolean} Whether autopause is turned on or off.\n * @reject {UnsupportedError} Autopause is not supported with the current\n * player or browser.\n */\n /**\n * Enable or disable the autopause behavior of this player.\n *\n * By default, when another video is played in the same browser, this\n * player will automatically pause. Unless you have a specific reason\n * for doing so, we recommend that you leave autopause set to the\n * default (`true`).\n *\n * @param {boolean} autopause\n * @return {SetAutopausePromise}\n */\n setAutopause(autopause) {\n return this.set('autopause', autopause);\n }\n\n /**\n * A promise to get the buffered property of the video.\n *\n * @promise GetBufferedPromise\n * @fulfill {Array} Buffered Timeranges converted to an Array.\n */\n /**\n * Get the buffered property of the video.\n *\n * @return {GetBufferedPromise}\n */\n getBuffered() {\n return this.get('buffered');\n }\n\n /**\n * @typedef {Object} CameraProperties\n * @prop {number} props.yaw - Number between 0 and 360.\n * @prop {number} props.pitch - Number between -90 and 90.\n * @prop {number} props.roll - Number between -180 and 180.\n * @prop {number} props.fov - The field of view in degrees.\n */\n /**\n * A promise to get the camera properties of the player.\n *\n * @promise GetCameraPromise\n * @fulfill {CameraProperties} The camera properties.\n */\n /**\n * For 360° videos get the camera properties for this player.\n *\n * @return {GetCameraPromise}\n */\n getCameraProps() {\n return this.get('cameraProps');\n }\n\n /**\n * A promise to set the camera properties of the player.\n *\n * @promise SetCameraPromise\n * @fulfill {Object} The camera was successfully set.\n * @reject {RangeError} The range was out of bounds.\n */\n /**\n * For 360° videos set the camera properties for this player.\n *\n * @param {CameraProperties} camera The camera properties\n * @return {SetCameraPromise}\n */\n setCameraProps(camera) {\n return this.set('cameraProps', camera);\n }\n\n /**\n * A representation of a chapter.\n *\n * @typedef {Object} VimeoChapter\n * @property {number} startTime The start time of the chapter.\n * @property {object} title The title of the chapter.\n * @property {number} index The place in the order of Chapters. Starts at 1.\n */\n /**\n * A promise to get chapters for the video.\n *\n * @promise GetChaptersPromise\n * @fulfill {VimeoChapter[]} The chapters for the video.\n */\n /**\n * Get an array of all the chapters for the video.\n *\n * @return {GetChaptersPromise}\n */\n getChapters() {\n return this.get('chapters');\n }\n\n /**\n * A promise to get the currently active chapter.\n *\n * @promise GetCurrentChaptersPromise\n * @fulfill {VimeoChapter|undefined} The current chapter for the video.\n */\n /**\n * Get the currently active chapter for the video.\n *\n * @return {GetCurrentChaptersPromise}\n */\n getCurrentChapter() {\n return this.get('currentChapter');\n }\n\n /**\n * A promise to get the color of the player.\n *\n * @promise GetColorPromise\n * @fulfill {string} The hex color of the player.\n */\n /**\n * Get the color for this player.\n *\n * @return {GetColorPromise}\n */\n getColor() {\n return this.get('color');\n }\n\n /**\n * A promise to set the color of the player.\n *\n * @promise SetColorPromise\n * @fulfill {string} The color was successfully set.\n * @reject {TypeError} The string was not a valid hex or rgb color.\n * @reject {ContrastError} The color was set, but the contrast is\n * outside of the acceptable range.\n * @reject {EmbedSettingsError} The owner of the player has chosen to\n * use a specific color.\n */\n /**\n * Set the color of this player to a hex or rgb string. Setting the\n * color may fail if the owner of the video has set their embed\n * preferences to force a specific color.\n *\n * @param {string} color The hex or rgb color string to set.\n * @return {SetColorPromise}\n */\n setColor(color) {\n return this.set('color', color);\n }\n\n /**\n * A representation of a cue point.\n *\n * @typedef {Object} VimeoCuePoint\n * @property {number} time The time of the cue point.\n * @property {object} data The data passed when adding the cue point.\n * @property {string} id The unique id for use with removeCuePoint.\n */\n /**\n * A promise to get the cue points of a video.\n *\n * @promise GetCuePointsPromise\n * @fulfill {VimeoCuePoint[]} The cue points added to the video.\n * @reject {UnsupportedError} Cue points are not supported with the current\n * player or browser.\n */\n /**\n * Get an array of the cue points added to the video.\n *\n * @return {GetCuePointsPromise}\n */\n getCuePoints() {\n return this.get('cuePoints');\n }\n\n /**\n * A promise to get the current time of the video.\n *\n * @promise GetCurrentTimePromise\n * @fulfill {number} The current time in seconds.\n */\n /**\n * Get the current playback position in seconds.\n *\n * @return {GetCurrentTimePromise}\n */\n getCurrentTime() {\n return this.get('currentTime');\n }\n\n /**\n * A promise to set the current time of the video.\n *\n * @promise SetCurrentTimePromise\n * @fulfill {number} The actual current time that was set.\n * @reject {RangeError} the time was less than 0 or greater than the\n * video’s duration.\n */\n /**\n * Set the current playback position in seconds. If the player was\n * paused, it will remain paused. Likewise, if the player was playing,\n * it will resume playing once the video has buffered.\n *\n * You can provide an accurate time and the player will attempt to seek\n * to as close to that time as possible. The exact time will be the\n * fulfilled value of the promise.\n *\n * @param {number} currentTime\n * @return {SetCurrentTimePromise}\n */\n setCurrentTime(currentTime) {\n return this.set('currentTime', currentTime);\n }\n\n /**\n * A promise to get the duration of the video.\n *\n * @promise GetDurationPromise\n * @fulfill {number} The duration in seconds.\n */\n /**\n * Get the duration of the video in seconds. It will be rounded to the\n * nearest second before playback begins, and to the nearest thousandth\n * of a second after playback begins.\n *\n * @return {GetDurationPromise}\n */\n getDuration() {\n return this.get('duration');\n }\n\n /**\n * A promise to get the ended state of the video.\n *\n * @promise GetEndedPromise\n * @fulfill {boolean} Whether or not the video has ended.\n */\n /**\n * Get the ended state of the video. The video has ended if\n * `currentTime === duration`.\n *\n * @return {GetEndedPromise}\n */\n getEnded() {\n return this.get('ended');\n }\n\n /**\n * A promise to get the loop state of the player.\n *\n * @promise GetLoopPromise\n * @fulfill {boolean} Whether or not the player is set to loop.\n */\n /**\n * Get the loop state of the player.\n *\n * @return {GetLoopPromise}\n */\n getLoop() {\n return this.get('loop');\n }\n\n /**\n * A promise to set the loop state of the player.\n *\n * @promise SetLoopPromise\n * @fulfill {boolean} The loop state that was set.\n */\n /**\n * Set the loop state of the player. When set to `true`, the player\n * will start over immediately once playback ends.\n *\n * @param {boolean} loop\n * @return {SetLoopPromise}\n */\n setLoop(loop) {\n return this.set('loop', loop);\n }\n\n\n /**\n * A promise to set the muted state of the player.\n *\n * @promise SetMutedPromise\n * @fulfill {boolean} The muted state that was set.\n */\n /**\n * Set the muted state of the player. When set to `true`, the player\n * volume will be muted.\n *\n * @param {boolean} muted\n * @return {SetMutedPromise}\n */\n setMuted(muted) {\n return this.set('muted', muted);\n }\n\n /**\n * A promise to get the muted state of the player.\n *\n * @promise GetMutedPromise\n * @fulfill {boolean} Whether or not the player is muted.\n */\n /**\n * Get the muted state of the player.\n *\n * @return {GetMutedPromise}\n */\n getMuted() {\n return this.get('muted');\n }\n\n /**\n * A promise to get the paused state of the player.\n *\n * @promise GetLoopPromise\n * @fulfill {boolean} Whether or not the video is paused.\n */\n /**\n * Get the paused state of the player.\n *\n * @return {GetLoopPromise}\n */\n getPaused() {\n return this.get('paused');\n }\n\n /**\n * A promise to get the playback rate of the player.\n *\n * @promise GetPlaybackRatePromise\n * @fulfill {number} The playback rate of the player on a scale from 0.5 to 2.\n */\n /**\n * Get the playback rate of the player on a scale from `0.5` to `2`.\n *\n * @return {GetPlaybackRatePromise}\n */\n getPlaybackRate() {\n return this.get('playbackRate');\n }\n\n /**\n * A promise to set the playbackrate of the player.\n *\n * @promise SetPlaybackRatePromise\n * @fulfill {number} The playback rate was set.\n * @reject {RangeError} The playback rate was less than 0.5 or greater than 2.\n */\n /**\n * Set the playback rate of the player on a scale from `0.5` to `2`. When set\n * via the API, the playback rate will not be synchronized to other\n * players or stored as the viewer's preference.\n *\n * @param {number} playbackRate\n * @return {SetPlaybackRatePromise}\n */\n setPlaybackRate(playbackRate) {\n return this.set('playbackRate', playbackRate);\n }\n\n /**\n * A promise to get the played property of the video.\n *\n * @promise GetPlayedPromise\n * @fulfill {Array} Played Timeranges converted to an Array.\n */\n /**\n * Get the played property of the video.\n *\n * @return {GetPlayedPromise}\n */\n getPlayed() {\n return this.get('played');\n }\n\n /**\n * A promise to get the qualities available of the current video.\n *\n * @promise GetQualitiesPromise\n * @fulfill {Array} The qualities of the video.\n */\n /**\n * Get the qualities of the current video.\n *\n * @return {GetQualitiesPromise}\n */\n getQualities() {\n return this.get('qualities');\n }\n\n /**\n * A promise to get the current set quality of the video.\n *\n * @promise GetQualityPromise\n * @fulfill {string} The current set quality.\n */\n /**\n * Get the current set quality of the video.\n *\n * @return {GetQualityPromise}\n */\n getQuality() {\n return this.get('quality');\n }\n\n /**\n * A promise to set the video quality.\n *\n * @promise SetQualityPromise\n * @fulfill {number} The quality was set.\n * @reject {RangeError} The quality is not available.\n */\n /**\n * Set a video quality.\n *\n * @param {string} quality\n * @return {SetQualityPromise}\n */\n setQuality(quality) {\n return this.set('quality', quality);\n }\n\n /**\n * A promise to get the seekable property of the video.\n *\n * @promise GetSeekablePromise\n * @fulfill {Array} Seekable Timeranges converted to an Array.\n */\n /**\n * Get the seekable property of the video.\n *\n * @return {GetSeekablePromise}\n */\n getSeekable() {\n return this.get('seekable');\n }\n\n /**\n * A promise to get the seeking property of the player.\n *\n * @promise GetSeekingPromise\n * @fulfill {boolean} Whether or not the player is currently seeking.\n */\n /**\n * Get if the player is currently seeking.\n *\n * @return {GetSeekingPromise}\n */\n getSeeking() {\n return this.get('seeking');\n }\n\n /**\n * A promise to get the text tracks of a video.\n *\n * @promise GetTextTracksPromise\n * @fulfill {VimeoTextTrack[]} The text tracks associated with the video.\n */\n /**\n * Get an array of the text tracks that exist for the video.\n *\n * @return {GetTextTracksPromise}\n */\n getTextTracks() {\n return this.get('textTracks');\n }\n\n /**\n * A promise to get the embed code for the video.\n *\n * @promise GetVideoEmbedCodePromise\n * @fulfill {string} The ``; + const iframe = html``; container.appendChild(iframe); t.deepEqual(createEmbed({ html: 'html' }, container), iframe); }); test('createEmbed makes an iframe from the oembed data', (t) => { const container = html`
`; - const markup = ''; + const markup = ''; const embed = createEmbed({ html: markup }, container); t.true(container.getAttribute('data-vimeo-initialized') === 'true'); - t.deepEqual(embed.outerHTML, html``.outerHTML); + t.deepEqual(embed.outerHTML, html``.outerHTML); }); test('createEmbed returns the iframe from a responsive embed', (t) => { const container = html`
`; - const markup = '
'; + const markup = '
'; const embed = createEmbed({ html: markup }, container); t.true(container.getAttribute('data-vimeo-initialized') === 'true'); - t.deepEqual(embed.outerHTML, html``.outerHTML); + t.deepEqual(embed.outerHTML, html``.outerHTML); }); test('initializeEmbeds should create embeds', async (t) => { - const div = html`
`; + const div = html`
`; document.body.appendChild(div); await new Promise((resolve, reject) => { @@ -84,3 +84,11 @@ test('resizeEmbeds is a function and sets a window property', (t) => { resizeEmbeds(); t.true(window.VimeoPlayerResizeEmbeds_); }); + +test('initAppendVideoMetadata is a function and sets a window property', (t) => { + t.plan(2); + t.true(typeof initAppendVideoMetadata === 'function'); + + initAppendVideoMetadata(); + t.true(window.VimeoSeoMetadataAppended); +}); diff --git a/test/functions-test.js b/test/functions-test.js index 5f7f7c809..2ee1b50b9 100755 --- a/test/functions-test.js +++ b/test/functions-test.js @@ -1,6 +1,6 @@ import test from 'ava'; import html from './helpers/html'; -import { getMethodName, isDomElement, isInteger, isVimeoUrl, getVimeoUrl } from '../src/lib/functions'; +import { getMethodName, isDomElement, isInteger, isVimeoUrl, isVimeoEmbed, getVimeoUrl } from '../src/lib/functions'; test('getMethodName properly formats the method name', (t) => { t.true(getMethodName('color', 'get') === 'getColor'); @@ -45,17 +45,24 @@ test('isVimeoUrl identifies *.vimeo.com only', (t) => { t.true(isVimeoUrl('https://notvimeo.com') === false); t.true(isVimeoUrl('https://vimeo.someone.com') === false); t.true(isVimeoUrl('https://player.vimeo.com/video/123') === true); - t.true(isVimeoUrl('https://vimeo.com/336812660') === true); + t.true(isVimeoUrl('https://vimeo.com/445351154') === true); t.true(isVimeoUrl('https://vimeo.com.evil.net') === false); t.true(isVimeoUrl('http://player.vimeo.com.evil.com') === false); t.true(isVimeoUrl('https://player.vimeozcom') === false); t.true(isVimeoUrl('https://www2vimeo.com') === false); }); +test('isVimeoEmbed identifies Vimeo embeds only', (t) => { + t.true(isVimeoEmbed('https://player.vimeo.com/video/76979871?h=8272103f6e') === true); + t.true(isVimeoEmbed('https://player.vimeo.com/video/76979871') === true); + t.true(isVimeoEmbed('http://player.vimeo.com/video/76979871?h=8272103f6e') === false); + t.true(isVimeoEmbed('http2://not-vimeo.com/video/76979871') === false); +}); + test('getVimeoUrl correctly returns a url from the embed parameters', (t) => { - t.true(getVimeoUrl({ id: 336812660 }) === 'https://vimeo.com/336812660'); - t.true(getVimeoUrl({ url: 'http://vimeo.com/336812660' }) === 'https://vimeo.com/336812660'); - t.true(getVimeoUrl({ url: 'https://vimeo.com/336812660' }) === 'https://vimeo.com/336812660'); + t.true(getVimeoUrl({ id: 445351154 }) === 'https://vimeo.com/445351154'); + t.true(getVimeoUrl({ url: 'http://vimeo.com/445351154' }) === 'https://vimeo.com/445351154'); + t.true(getVimeoUrl({ url: 'https://vimeo.com/445351154' }) === 'https://vimeo.com/445351154'); }); diff --git a/test/helpers/browser-env.js b/test/helpers/browser-env.js index 590966ab6..d8945b46b 100755 --- a/test/helpers/browser-env.js +++ b/test/helpers/browser-env.js @@ -2,9 +2,9 @@ import { JSDOM } from 'jsdom'; const html = ` -
+
- +
`;