jquery.notification.js

/**
 * @copyright Copyright 2014 Wendelin Thomas. All rights reserved
 * Licensed under the MIT License.
 * @see https://github.com/wendelin/jquery.fn/blob/gh-pages/LICENSE.md
 * @requires jquery
 * @module jquery.notification
 */
(function (factory) {
if (typeof define === "function" && define.amd) {
	// AMD. Register as a module depending on jQuery.
	define("jquery.notification",["jquery"], factory);
} else {
	// No AMD. Register plugin with global jQuery object.
	factory(jQuery);
}
}(function($){
	"use strict";
	
	/**
	 * <p>Wrapper and fallback for the "notification" API.</p>
	 * 
	 * <p>Options:</p>
	 * <dl>
	 *   <dt>dir</dt>      <dd>The direction of the notification; it can be auto, ltr, or rtl</dd>
	 *   <dt>lang</dt>     <dd>Specifiy the lang used within the notification. This string must be a valid BCP 47 language tag.</dd>
	 *   <dt>body</dt>     <dd>A string representing an extra content to display within the notification</dd>
	 *   <dt>tag</dt>      <dd>An ID for a given notification that allows to retrieve, replace or remove it if necessary</dd>
	 *   <dt>icon</dt>     <dd>The URL of an image to be used as an icon by the notification</dd>
	 * </dl>
	 *
	 * @see https://developer.mozilla.org/en/docs/Web/API/notification
	 *
	 * @example $.notification("foo");
	 * @example $.notification("foo", {body:"bar"});
	 * @example $.notification("Hit me", {}, {
	 *     show: function(){$.notification("Hello");},
	 *     close: function(){$.notification("Bye");},
	 *     click: function(){$.notification("Clicked");},
	 *     error: function(){$.notification("Error");}
	 * })
	 * @method $.notification
	 * @param {String} title
	 * @param {Object.<({
	 *   dir:String.<'auto','ltr','rtl'>,
	 *   lang:String,
	 *   body:String,
	 *   tag:String,
	 *   icon:URL
	 * })>} options
	 * @param {Object.<({
	 *   click:Function,
	 *   close:Function,
	 *   error:Function,
	 *   show:Function
	 * })>} events Optional events
	 * @returns {Notification|jQuery}
	 */
	$.notification = (function(){
		var Notification = window.Notification || window.mozNotification || window.webkitNotification;
		
		var notify = function (title, options, events, type) {
			options = options || {};
			if (type === "native"  && Notification && Notification.permission === "granted") {
				var o = $.extend({},options);
				delete options["type"];		// remove non standard parameter
				var n = new Notification(title, options);
				if (events) $(n).on(events);
				return n;
			} else {
				return (fn.types[type]||fn.types[fn.fallbackType])(title, options, events);
			}
		};
		
		var fn = function (title, options, events) {
			options = options || {};
			var type = fn.defaultType;
			if (!fn.types[type]) type = fn.defaultType;	// ignore invalid "type" / fallback
			
			if (type === "native" && Notification && Notification.permission === "default") {
				var d = new $.Deferred();
				fn.requestPermission().always(function(){
					d.resolve(notify(title, options, events, type));
				});
				return d;
				
			} else {
				return notify(title, options, events, type);
			}
		};
		$.extend(fn, {
			defaultType: (!!Notification ? "native" : "alert"),
			fallbackType: "alert",
			types: {
				alert:function (title, options, events) {
					if (events && events.show) events.show();
					alert(title + (options && options.body ? "\n\n" + options.body : ""));
					if (events && events.close) events.close();
					return $.extend({close:function(){}},options);	// returns fake Notification object
				}
			},
			requestPermissionsTimeout: 10000, /* milliseconds */
			requestPermission: function(){
				var d = new $.Deferred();
				
				Notification.requestPermission(function (status) {
					if (Notification.permission !== status) {
						Notification.permission = status;
					}
					d.resolve(status);
				});
				
				setTimeout(function(){
					if (d.state() === "pending") {
						d.reject();
					}
				}, fn.requestPermissionsTimeout);
				
				return d;
			}
		});
		
		return fn;
	}());

}));