AdLibs

________________

The gist of it...

A collection of cross-browser methods for use with front-end development. adlibs is a tool that supports various browser and OS combinations dating back to IE9. It uses feature detection to determine the user's environment and outputs details pertaining to that OS and browser. adlibs also allows developers to safely execute front end methods such as domReady and XMLHttpRequests across all browsers.

Installation

npm install adlibs

Usage

Each function is exported as a single commonjs module, allowing only the needed modules to be bundled into a project to keep minified bundles as small as possible.

In Node.js:

// Load the full adlibs build.
var adlibs = require('adlibs');

// Load a single module for smaller builds with webpack.
var domReady = require('adlibs/lib/dom/domReady');
var browser = require('adlibs/lib/detect/browser');

Detection Modules

There are several modules that use feature detection to determine the user's environment. In order to populate the resulting objects, the detect function must be executed.

For example, in order to populate the browser object:

var browser = require('adlibs/lib/detect/browser').detect();

// outputs the name of the os
console.log(browser.os.name)

API Reference

Modules

canHas
comparableBits: This is due to Javascript using double-precision floating-point format numbers. If the number of bits in the bitmask is found to exceed the max supported, this module throws an error.
createSpy ⇒ sinon.spy: Helper method to create Sinon.JS spies directly on the value of module.exports for a required module. To spy on a method you need access to the object it is attached to, which is problematic when the function is directly returned from a "require" call. By accessing the require.cache we can get handle to the module's exports and inject the spy.
Browser: Browser Detection - Gets Data Pertaining to User's Browser and OS
Capabilities: Determines browser's capabilities (e.g. CORS support, sandboxable, video support, etc.)
Environment: Environment Detection - Gets Data Pertaining to User's Environment
Mraid: Mraid Detection
Safeframe: Safeframe Detection
addEventListener ⇒ function: Add an event listener to the element, which will execute the given callback.
~~appendHtml ⇒ Array~~: Appends all elements in the html string to the parent element. Correctly handles scripts with src attributes and inline javascript and ensures that the script will execute. NOTE: Only Element nodes in the html string will be appended. All other node types will be ignored (i.e. Text, Comment).
domReady: Executes the provided callback when the DOM is ready. Allows code to act on the DOM before the window "load" event fires.
getExecutingScript
triggerEvent: Creates a new DOM Event and triggers it on the provided element.
evaluator ⇒ Object: Runs eval against the value passed to it. This function exists because eval prevents Uglify from minifying correctly. Encapsulating eval in its own module prevents the above issue. Variables and properties are one letter vars because Uglify won't function for this module. For more info on eval visit: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/eval
jsonp ⇒ Object: Perform a cross domain request via JSONP. Provides the same interface as xhr.js. The request is made by appending a 'callback' parameter to the request url, and it is expected that the server will respond with the content wrapped in a function call, using the provided value of the callback parameter. If callbackFn isn't defined, a unique name will be generated.
loadScript: Dynamically loads scripts in parallel, and executes a single callback after all scripts have loaded.
measurePerformance
parseConfig ⇒ Object: Parses a json config from the provided Element. The defaults is expected to be a JSON string in the attribute value.
perfMarker: A module to mark the timestamps for script performance
reportData
format ⇒ String: Constructs a URL from its parsed components. 1) Host takes precedence over hostname and port. 2) Query takes precedence over search.
parse ⇒ Object: Deconstructs a URL into its components. It also parses the search component (the query string) into decoded key/value pairs on a query object.
xhr: Cross browser wrapper for XMLHttpRequest. If you need Cookies and HTTP Auth data to be included in the request, you must set withCredentials to true in the options.

Functions

insertAfter(elemToInsert, targetElem): Utility Function to Insert 'elemToInsert' after 'targetElem' in the DOM
isAScript(inputElem): Returns true if inputElem is a script element; false otherwise
addToDom(elem, target): Adds 'elem' to the DOM with target/parent element 'target' Scripts are treated differently than other elements because they have to be to work correctly
customCloneScript(inputScriptElem, win) ⇒ Element: Clones a script element in a way that is compatible with dynamic DOM-ready loading Unfortunately, node.cloneNode() will not work in place of this function in this case nor can it be used inside this function
cloneElem(elemToClone, win) ⇒ Node | Element: Creates a deep clone of the element passed in (with special logic for scripts) Scripts have to be handled differently because the script code will not execute unless they are processed this way
recursiveCloneAndAddToDom(inputElem, targetElem, win) ⇒ Node | Element: Recursively iterates through 'inputElem' child elements, creates clones of them, and attaches them to 'targetElem' Why? Because script elements (including nested ones) need to be cloned a specific way in order for the code they represent to be executed.
insertInlineHtmlString(htmlString, [parentElem], win) ⇒ boolean: Adds 'htmlString' as a child to element 'parentElem' in a way that's safe to use after the document has been closed
createInsContainer(win) ⇒ HTMLModElement: Returns an 'ins' element with a unique ID and class 'adlibs-ins'
docWriteHtmlString(htmlString, win) ⇒ boolean: Uses document.writeln to add an HTML string to the page
isNativeFunction(value) ⇒ any: Returns true if a function is the native implementation; false otherwise
embedHtml(htmlString, [parentElem], [callback], [win]): If the doc readyState is complete or interactive, use custom methods to safely write 'htmlString' to the page; otherwise, use native document.write

canHas

canHas
- .can(obj, propertyName) ⇒ Boolean
- .has(globalObjectName, [scope]) ⇒ *
- .own(obj, propertyName) ⇒ Boolean
- .run(obj, [methodName]) ⇒ function
- .forIn(obj, callback)
- .keys(obj) ⇒ *

canHas.can(obj, propertyName) ⇒ `Boolean`

Can this object use this property?

Kind: static method of canHas

Param
obj
propertyName

Example

var can = require('adlibs/lib/canHas').can;

canHas.has(globalObjectName, [scope]) ⇒ `*`

Does this window have this object in it?

Kind: static method of canHas

Param	Description
globalObjectName
[scope]	Alternatively, you can call "run" with a more sane method signature.

Example

var has = require('adlibs/lib/canHas').has;

canHas.own(obj, propertyName) ⇒ `Boolean`

Check to see if this object owns the method as opposed to just inheriting it from another object.

Kind: static method of canHas

Param
obj
propertyName

canHas.run(obj, [methodName]) ⇒ `function`

Return a runnable method by default.

Kind: static method of canHas

Param	Description
obj	Scope to use, or method to run when not providing a method as the second param.
[methodName]	The method to check for.

canHas.forIn(obj, callback)

For each in, shorthanded because manually writing hasOwnProperty each and every time is not a good use of time.

Kind: static method of canHas

Param
obj
callback

canHas.keys(obj) ⇒ `*`

A substitute for Object.keys for when browsers don't attempt to convert non-objects to arrays

Kind: static method of canHas

Param
obj

comparableBits

This is due to Javascript using double-precision floating-point format numbers. If the number of bits in the bitmask is found to exceed the max supported, this module throws an error.

comparableBits
- .factory ⇒ ComparableBits
- .provider ⇒ ComparableBits
- .make(bit, [data]) ⇒ Action
- .compare(action, bitSig, [callback]) ⇒ Boolean

comparableBits.factory ⇒ `ComparableBits`

Create a new instance of the ComparableBits module.

Kind: static property of comparableBits
Example

var bits = require('adlibs/lib/comparableBits').factory();

var someAction = bits.make(0x1 | 0x2, 'flag1,mode1or2')
bits.compare(someAction, 0x1, callback) // -> executes callback

comparableBits.provider ⇒ `ComparableBits`

Tie into an existing instance of the ComparableBits module.

Kind: static property of comparableBits

Param
packageName

comparableBits.make(bit, [data]) ⇒ `Action`

Creates the action object with it's attributed bitmask flag

Kind: static method of comparableBits
Returns: Action - Returns the created Action object

Param	Type	Description
bit	`Number`	The actions's unique bitmask
[data]	`String`	The action's label

Example

var make = require('adlibs/lib/comparableBits').make;

comparableBits.compare(action, bitSig, [callback]) ⇒ `Boolean`

Encapsulates a bitmask service which takes a bitmask and compares it to the attributed action's flag

Kind: static method of comparableBits
Returns: Boolean - Returns true if the action's flags do match either of the provided bitmasks

Param	Type	Description
action	`Action`	The action object to compare to the provided bitmasks
bitSig	`Number`	Should have a unique bit signature for bit logic
[callback]	`*`	The action's pertaining data

Example

var compare = require('adlibs/lib/comparableBits').compare;

createSpy ⇒ `sinon.spy`

Helper method to create Sinon.JS spies directly on the value of module.exports for a required module. To spy on a method you need access to the object it is attached to, which is problematic when the function is directly returned from a "require" call. By accessing the require.cache we can get handle to the module's exports and inject the spy.

Param	Type	Description
loadedModule
mockType	`String`	Defaults to 'spy'; can also be 'stub'.

Example
incrementCounter.js:

module.exports = function() { ... async call ...  };

my-test.js

var incrementCounter = require('./incrementCounter'),
createSpy = require('cse-common/lib/createSpy');

var spy = createSpy(incrementCounter);

// test code
assert(spy.callCount, 4);
spy.restore();

Browser

Browser Detection - Gets Data Pertaining to User's Browser and OS

Example

var browser = require("adlibs/lib/detect/browser")

Browser
- static
  - .mathMLSupport(d) ⇒ Boolean
  - .isMobile([win]) ⇒ Boolean
  - .getVersion(uaVersion, minVersion, [maxVersion]) ⇒ Number
  - .looksLike(regex, ua) ⇒ * | Boolean
  - .parseIntIfMatch(ua, regex, [radix]) ⇒ Number
  - .parseFloatIfMatch(ua, regex) ⇒
  - .getAndroidVersion(win, uaVersion) ⇒ Number
  - .getChromiumVersion(win, uaVersion) ⇒ Number
  - .getSafariVersion(win, uaVersion) ⇒ Number
  - .getKindleVersion(win, uaVersion) ⇒ Number
  - .getOtherOS(win, ua) ⇒ Browser
  - .getAppleOS(win, ua) ⇒ Browser
  - .getMicrosoftOS(win, ua) ⇒ Browser
  - .getAndroidOS(win, ua) ⇒ Browser
  - .getKindleOS(win, ua) ⇒ Browser
  - .getOsFromUa(win, ua) ⇒ Browser
  - .detect([win], [userAgent]) ⇒ Browser
  - .read(key) ⇒ *
- inner
  - ~save(result) ⇒ Number

browser.mathMLSupport(d) ⇒ `Boolean`

Check for MathML support in browsers to help detect certain browser version numbers where this is the only difference.

Kind: static method of Browser
Returns: Boolean - returns true if browser has mathml support

Param	Type
d	`Document`

browser.isMobile([win]) ⇒ `Boolean`

Performs a simple test to see if we're on mobile or not.

Kind: static method of Browser
Returns: Boolean - returns true if mobile

Param	Type
[win]	`Window`

browser.getVersion(uaVersion, minVersion, [maxVersion]) ⇒ `Number`

Uses the min and max versions of a browser to determine its version.

Kind: static method of Browser
Returns: Number - returns version number

Param	Type
uaVersion	`Number`
minVersion	`Number`
[maxVersion]	`Number`

browser.looksLike(regex, ua) ⇒ `*` | `Boolean`

Searches for a match between the regex and specified string.

Kind: static method of Browser
Returns: * | Boolean - returns true if match found

Param	Type
regex	`RegExp`
ua	`String`

browser.parseIntIfMatch(ua, regex, [radix]) ⇒ `Number`

Parses the result of the RegExp match if it exists. Gracefully falls back to the default version if not.

Kind: static method of Browser
Returns: Number - returns the regex match or default version

Param	Type
ua	`String`
regex	`RegExp`
[radix]	`Number`

browser.parseFloatIfMatch(ua, regex) ⇒

Parses the floating point value of the RegExp match if found. Gracefully falls back to the default if not.

Kind: static method of Browser
Returns: returns the regex match or the default version

Param	Type
ua	`String`
regex	`RegExp`

browser.getAndroidVersion(win, uaVersion) ⇒ `Number`

Determines the version of Android being used.

Kind: static method of Browser
Returns: Number - returns the Android version

Param	Type
win	`Window`
uaVersion	`Number`

browser.getChromiumVersion(win, uaVersion) ⇒ `Number`

Determines the version of Chrome being used.

Kind: static method of Browser
Returns: Number - returns the Chrome version

Param	Type
win	`Window`
uaVersion	`Number`

browser.getSafariVersion(win, uaVersion) ⇒ `Number`

Returns the version of the Safari browser.

Kind: static method of Browser
Returns: Number - returns the version of Safari

Param	Type
win	`Window`
uaVersion	`Number`

browser.getKindleVersion(win, uaVersion) ⇒ `Number`

Creates a Browser instance with its attributed Kindle values.

Kind: static method of Browser

Param	Type
win	`Window`
uaVersion	`Number`

browser.getOtherOS(win, ua) ⇒ `Browser`

Creates a Browser instance with its attributed OS and device type values.

Kind: static method of Browser
Returns: Browser - returns the browser instance

Param	Type
win	`Window`
ua	`String`

browser.getAppleOS(win, ua) ⇒ `Browser`

Creates a Browser instance with its attributed Apple values.

Kind: static method of Browser
Returns: Browser - returns the Browser instance

Param	Type
win	`Window`
ua	`String`

browser.getMicrosoftOS(win, ua) ⇒ `Browser`

Creates a Browser instance with its attributed Windows values.

Kind: static method of Browser
Returns: Browser - returns the Browser instance

Param	Type
win	`Window`
ua	`String`

browser.getAndroidOS(win, ua) ⇒ `Browser`

Creates a Browser instance with its attributed Android values.

Kind: static method of Browser
Returns: Browser - returns the Browser instance

Param	Type
win	`Window`
ua	`String`

browser.getKindleOS(win, ua) ⇒ `Browser`

Returns the Kindle's OS.

Kind: static method of Browser
Returns: Browser - returns the Browser instance

Param	Type
win	`Window`
ua	`String`

browser.getOsFromUa(win, ua) ⇒ `Browser`

Reads the user agent string to determine OS.

Kind: static method of Browser
Returns: Browser - returns the Browser instance

Param	Type
win	`Window`
ua	`String`

browser.detect([win], [userAgent]) ⇒ `Browser`

Returns an object containing browser details (e.g. name, os, version, etc.).

Kind: static method of Browser
Returns: Browser - returns the Browser instance

Param	Type
[win]	`Window`
[userAgent]	`String`

Example

var os = browser.detect().os.name;

console.log(os); // outputs OS name (e.g. Windows, Mac, Android, etc.)

browser.read(key) ⇒ `*`

Retrieve any results in the map by name because they're returned in an array without names.

Kind: static method of Browser

Param	Type
key	`String`

Browser~save(result) ⇒ `Number`

Saves a property to the results array and returns its index.

Kind: inner method of Browser

Param	Type
result	`*`

Capabilities

Determines browser's capabilities (e.g. CORS support, sandboxable, video support, etc.)

Example

var capabilities = require("adlibs/lib/detect/capabilities");

capabilities.detect() ⇒ `Object`

Detects browser's capabilities and returns an object.

Kind: static method of Capabilities
Example

// Outputs whether the browser supports h264 video ( 1 if yes, else 0)
var h264 = capabilities.detect().h264;

Environment

Environment Detection - Gets Data Pertaining to User's Environment

Example

var environment = require("adlibs/lib/detect/environment");

Environment
- .detect() ⇒ Object
- .getFlashVersion() ⇒ Number
- .getFrameDepth() ⇒ String
- .getAvailableScreenSize() ⇒ Object
- .getScreenSize() ⇒ Object
- .getAdDocSize() ⇒ Object

environment.detect() ⇒ `Object`

Detect environmental variables and return them wrapped within an object.

Kind: static method of Environment
Returns: Object - returns the environment object
Example

var flash = environment.detect().flash;

console.log(flash) // outputs the version of Flash

environment.getFlashVersion() ⇒ `Number`

Kind: static method of Environment

environment.getFrameDepth() ⇒ `String`

Kind: static method of Environment

environment.getAvailableScreenSize() ⇒ `Object`

Kind: static method of Environment

environment.getScreenSize() ⇒ `Object`

Kind: static method of Environment

environment.getAdDocSize() ⇒ `Object`

Kind: static method of Environment

Mraid

Mraid Detection

Example

var mraid = require("adlibs/lib/detect/mraid");

console.log(mraid.getVersion()) // outputs mraid version;

Mraid
- .ready(cb, [If])
- .getVersion([If]) ⇒ String
- .diagnostic(win) ⇒ Object

mraid.ready(cb, [If])

Executes cb when mraid is ready.

Kind: static method of Mraid

Param	Type	Description
cb	`function`
[If]	`Window`	not given, uses the current window.

mraid.getVersion([If]) ⇒ `String`

Gets mraid version.

Kind: static method of Mraid

Param	Type	Description
[If]	`Window`	not given, uses the current window.

mraid.diagnostic(win) ⇒ `Object`

Kind: static method of Mraid

Param	Type	Description
win	`Object`	Window Object

Safeframe

Safeframe Detection

Example

var safeframe = require("adlibs/lib/detect/safeframe");

Safeframe
- .getVersion([win]) ⇒ String
- .getSpecVersion([win]) ⇒ String
- .getInfo([win]) ⇒ Array
- .getConf([win]) ⇒ Array
- .getSupport([win]) ⇒ Array
- .getInView([win]) ⇒ Number
- .getWinFocus([win]) ⇒ Number
- .getMetrics([win]) ⇒ Array