awesome-cordova-plugins/src/plugins/plugin.ts

129 lines
3.7 KiB
TypeScript
Raw Normal View History

2015-11-29 08:26:55 +08:00
import {get} from '../util';
declare var window;
declare var Promise;
2015-11-30 07:20:11 +08:00
export const getPlugin = function(pluginRef: string): any {
return get(window, pluginRef);
}
export const isInstalled = function(pluginRef: string): boolean {
return !!getPlugin(pluginRef);
}
export const pluginWarn = function(pluginName: string, method: string, plugin: string) {
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');
}
}
export const cordovaWarn = function(pluginName: string, method: string) {
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-11-29 08:26:55 +08:00
export const wrap = function(pluginObj, methodName, opts: any = {}) {
return (...args) => {
return new Promise((resolve, reject) => {
2015-11-30 06:30:15 +08:00
if(!window.cordova) {
2015-11-30 07:20:11 +08:00
cordovaWarn(pluginObj.name, methodName);
2015-11-30 06:30:15 +08:00
reject({
error: 'cordova_not_available'
})
2015-11-30 07:20:11 +08:00
return;
2015-11-30 06:30:15 +08:00
}
2015-11-30 09:54:45 +08:00
// Try to figure out where the success/error callbacks need to be bound
// to our promise resolve/reject handlers.
// If the plugin method expects myMethod(success, err, options)
if(opts.callbackOrder == 'reverse') {
args[0] = resolve;
args[1] = reject;
} else if(typeof opts.successIndex !== 'undefined' || typeof opts.errorIndex !== 'undefined') {
// If we've specified a success/error index
2015-11-29 08:26:55 +08:00
args[opts.successIndex] = resolve;
args[opts.errorIndex] = reject;
2015-11-30 09:54:45 +08:00
} 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);
2015-11-29 08:26:55 +08:00
}
2015-11-30 07:20:11 +08:00
let pluginInstance = getPlugin(pluginObj.pluginRef);
2015-11-29 08:26:55 +08:00
if(!pluginInstance) {
2015-11-30 07:20:11 +08:00
pluginWarn(pluginObj.name, methodName, pluginObj.name);
2015-11-29 08:26:55 +08:00
reject({
error: 'plugin_not_installed'
});
return;
}
get(window, pluginObj.pluginRef)[methodName].apply(pluginObj, args);
})
}
}
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
export function Plugin(config) {
return function(cls) {
// Add these fields to the class
for(let k in config) {
cls[k] = config[k];
}
return cls;
}
}
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
export function Cordova(opts:any = {}) {
2015-11-30 09:54:45 +08:00
return (target: Object, methodName: string, descriptor: TypedPropertyDescriptor<any>) => {
let originalMethod = descriptor.value;
return {
value: function(...args: any[]) {
return wrap(this, methodName, opts)();
}
2015-11-29 08:26:55 +08:00
}
}
}
2015-11-30 07:20:11 +08:00
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
export function RequiresPlugin(target: Function, key: string, descriptor: TypedPropertyDescriptor<any>) {
let originalMethod = descriptor.value;
descriptor.value = function(...args: any[]) {
console.log('Calling', this);
if(!window.cordova) {
cordovaWarn(this.name, null);
return;
}
let pluginInstance = getPlugin(this.pluginRef);
if(!pluginInstance) {
pluginWarn(this.name, null, this.name);
return;
}
originalMethod.apply(this, args);
}
return descriptor;
}