awesome-cordova-plugins/dist/plugins/plugin.js

183 lines
6.7 KiB
JavaScript
Raw Normal View History

2015-11-29 08:26:55 +08:00
var util_1 = require('../util');
2015-12-01 02:34:54 +08:00
var Rx_1 = require('@reactivex/rxjs/dist/cjs/Rx');
2015-11-30 07:20:11 +08:00
exports.getPlugin = function (pluginRef) {
return util_1.get(window, pluginRef);
};
exports.isInstalled = function (pluginRef) {
return !!exports.getPlugin(pluginRef);
};
exports.pluginWarn = function (pluginName, method, plugin) {
if (method) {
console.warn('Native: tried calling ' + pluginName + '.' + method +
', but the ' + pluginName + ' plugin is not installed. Install the ' +
plugin + ' plugin');
}
else {
console.warn('Native: tried accessing the ' + pluginName + ' plugin but it\'s not installed. Install the ' + plugin + ' plugin');
}
};
exports.cordovaWarn = function (pluginName, method) {
if (method) {
console.warn('Native: tried calling ' + pluginName + '.' + method + ', but Cordova is not available. Make sure to include cordova.js or run in a device/simulator');
}
else {
console.warn('Native: tried accessing the ' + pluginName + ' plugin but Cordova is not available. Make sure to include cordova.js or run in a device/simulator');
}
};
2015-12-01 02:34:54 +08:00
function callCordovaPlugin(pluginObj, methodName, args, opts, resolve, reject) {
// Try to figure out where the success/error callbacks need to be bound
// to our promise resolve/reject handlers.
2015-12-01 04:38:52 +08:00
if (opts === void 0) { opts = {}; }
2015-12-01 02:34:54 +08:00
// If the plugin method expects myMethod(success, err, options)
if (opts.callbackOrder == 'reverse') {
2015-12-01 03:27:25 +08:00
// Get those arguments in the order [reject, resolve, ...restOfArgs]
args.unshift(reject);
args.unshift(resolve);
2015-12-01 02:34:54 +08:00
}
else if (typeof opts.successIndex !== 'undefined' || typeof opts.errorIndex !== 'undefined') {
// If we've specified a success/error index
args.splice(opts.successIndex, 0, resolve);
args.splice(opts.errorIndex, 0, reject);
}
else {
// Otherwise, let's tack them on to the end of the argument list
// which is 90% of cases
args.push(resolve);
args.push(reject);
}
var pluginInstance = exports.getPlugin(pluginObj.pluginRef);
if (!pluginInstance) {
2015-12-01 04:38:52 +08:00
// Do this check in here in the case that the Web API for this plugin is available (for example, Geolocation).
if (!window.cordova) {
exports.cordovaWarn(pluginObj.name, methodName);
reject({
error: 'cordova_not_available'
});
return;
}
2015-12-01 02:34:54 +08:00
exports.pluginWarn(pluginObj.name, methodName, pluginObj.name);
reject({
error: 'plugin_not_installed'
});
return;
}
console.log('Cordova calling', pluginObj.name, methodName, args);
2015-12-01 03:27:25 +08:00
// TODO: Illegal invocation needs window context
return util_1.get(window, pluginObj.pluginRef)[methodName].apply(pluginInstance, args);
2015-12-01 02:34:54 +08:00
}
2015-12-02 03:33:08 +08:00
function getPromise(cb) {
if (window.Promise) {
console.log('Native promises available...');
return new Promise(function (resolve, reject) {
cb(resolve, reject);
});
}
else if (window.angular) {
var $q_1 = window.angular.injector(['ng']).get('$q');
console.log('Loaded $q', $q_1);
return $q_1(function (resolve, reject) {
cb(resolve, reject);
});
}
else {
console.error('No Promise support or polyfill found. To enable Ionic Native support, please add the es6-promise polyfill before this script, or run with a library like Angular 1/2 or on a recent browser.');
}
}
2015-12-01 02:34:54 +08:00
function wrapPromise(pluginObj, methodName, args, opts) {
if (opts === void 0) { opts = {}; }
2015-12-02 03:33:08 +08:00
return getPromise(function (resolve, reject) {
2015-12-01 02:34:54 +08:00
callCordovaPlugin(pluginObj, methodName, args, opts, resolve, reject);
});
}
function wrapObservable(pluginObj, methodName, args, opts) {
if (opts === void 0) { opts = {}; }
2015-12-01 03:27:25 +08:00
return new Rx_1.Observable(function (observer) {
2015-12-01 04:38:52 +08:00
var pluginResult = callCordovaPlugin(pluginObj, methodName, args, opts, observer.next.bind(observer), observer.error.bind(observer));
2015-12-01 02:34:54 +08:00
return function () {
2015-12-01 04:38:52 +08:00
try {
return util_1.get(window, pluginObj.pluginRef)[opts.clearFunction].apply(pluginObj, pluginResult);
}
catch (e) {
console.warn('Unable to clear the previous observable watch for', pluginObj.name, methodName);
console.log(e);
}
2015-12-01 02:34:54 +08:00
};
});
}
2015-11-29 08:26:55 +08:00
exports.wrap = function (pluginObj, methodName, opts) {
if (opts === void 0) { opts = {}; }
return function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i - 0] = arguments[_i];
}
2015-12-01 02:34:54 +08:00
if (opts.observable) {
return wrapObservable(pluginObj, methodName, args, opts);
}
else {
return wrapPromise(pluginObj, methodName, args, opts);
}
2015-11-29 08:26:55 +08:00
};
};
2015-11-30 09:54:45 +08:00
/**
* Class decorator specifying Plugin metadata. Required for all plugins.
*/
2015-11-29 08:26:55 +08:00
function Plugin(config) {
return function (cls) {
// Add these fields to the class
for (var k in config) {
cls[k] = config[k];
}
2015-12-02 03:33:08 +08:00
cls['installed'] = function () {
return !!exports.getPlugin(config.pluginRef);
};
2015-11-29 08:26:55 +08:00
return cls;
};
}
exports.Plugin = Plugin;
2015-11-30 09:54:45 +08:00
/**
* Wrap a stub function in a call to a Cordova plugin, checking if both Cordova
* and the required plugin are installed.
*/
2015-11-29 08:26:55 +08:00
function Cordova(opts) {
if (opts === void 0) { opts = {}; }
2015-11-30 09:54:45 +08:00
return function (target, methodName, descriptor) {
var originalMethod = descriptor.value;
return {
value: function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i - 0] = arguments[_i];
}
2015-11-30 11:50:58 +08:00
return exports.wrap(this, methodName, opts).apply(this, args);
2015-11-30 09:54:45 +08:00
}
};
2015-11-29 08:26:55 +08:00
};
}
exports.Cordova = Cordova;
2015-11-30 09:54:45 +08:00
/**
* Before calling the original method, ensure Cordova and the plugin are installed.
*/
2015-11-30 07:20:11 +08:00
function RequiresPlugin(target, key, descriptor) {
var originalMethod = descriptor.value;
descriptor.value = function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i - 0] = arguments[_i];
}
console.log('Calling', this);
if (!window.cordova) {
exports.cordovaWarn(this.name, null);
return;
}
var pluginInstance = exports.getPlugin(this.pluginRef);
if (!pluginInstance) {
exports.pluginWarn(this.name, null, this.name);
return;
}
originalMethod.apply(this, args);
};
return descriptor;
}
exports.RequiresPlugin = RequiresPlugin;
2015-12-01 02:34:54 +08:00
//# sourceMappingURL=plugin.js.map