feat(geofence): Adds geofence plugin (#442)

* Fixes syntax error in usage example, and improves usage formatting

* Moves error codes into usage section

* Adds basics of geofence plugin

* Updates exports to include Geofence

* Adds geofence docs and tested functions

* Corrects promise types and comments out unimplemented functions

* Minor updates to geofence

* Reverts camera-preview changes for this branch to master

src/index.ts

@@ -41,6 +41,7 @@ import { Facebook } from './plugins/facebook';
 import { File } from './plugins/file';
 import { Transfer } from './plugins/filetransfer';
 import { Flashlight } from './plugins/flashlight';
+import {Geofence} from './plugins/geofence';
 import { Geolocation } from './plugins/geolocation';
 import { Globalization } from './plugins/globalization';
 import { GooglePlus } from './plugins/google-plus';
@@ -64,6 +65,7 @@ import { NativeStorage } from './plugins/nativestorage';
 import { MediaPlugin } from './plugins/media';
 import { Network } from './plugins/network';
 import { OneSignal } from './plugins/onesignal';
+
 import { PhotoViewer } from './plugins/photo-viewer';
 import { ScreenOrientation } from './plugins/screen-orientation';
 import { PinDialog } from './plugins/pin-dialog';
@@ -151,6 +153,7 @@ export {
   EstimoteBeacons,
   File,
   Flashlight,
+  Geofence,
   Globalization,
   GooglePlus,
   GoogleAnalytics,
@@ -221,6 +224,7 @@ window['IonicNative'] = {
   Facebook: Facebook,
   File: File,
   Flashlight: Flashlight,
+  Geofence: Geofence,
   Geolocation: Geolocation,
   Globalization: Globalization,
   GooglePlus: GooglePlus,

src/plugins/geofence.ts

@@ -0,0 +1,168 @@
+import { Cordova, Plugin } from './plugin';
+import { Observable } from 'rxjs/Observable';
+/**
+ * @name Geofence
+ * @description Monitors circular geofences around latitude/longitude coordinates, and sends a notification to the user when the boundary of a geofence is crossed. Notifications can be sent when the user enters and/or exits a geofence.
+ * Geofences persist after device reboot. Geofences will be monitored even when the app is not running.
+ * @usage
+ * ```
+ * import { Geofence } from 'ionic-native';
+ * import { Platform } from  'ionic-angular'
+ * ...
+ *
+ * constructor(private platform: Platform) {
+ *   this.platform.ready().then(() => {
+         // initialize the plugin
+ *       Geofence.initialize().then(
+ *         // resolved promise does not return a value
+ *         () => console.log('Geofence Plugin Ready'),
+ *         (err) => console.log(err)
+ *       )
+ *   })
+ * }
+ *  
+ * private addGeofence() {
+ *   //options describing geofence
+ *   let fence = {
+ *     id: "69ca1b88-6fbe-4e80-a4d4-ff4d3748acdb", //any unique ID
+ *     latitude:       37.285951, //center of geofence radius
+ *     longitude:      -121.936650,
+ *     radius:         100, //radius to edge of geofence
+ *     transitionType: 3, //see 'Transition Types' below
+ *     notification: { //notification settings
+ *         id:             1, //any unique ID
+ *         title:          "You crossed a fence", //notification title
+ *         text:           "You just arrived to Gliwice city center.", //notification body
+ *         openAppOnClick: true //open app when notification is tapped
+ *     }
+ *   }
+ *   
+ *   Geofence.addOrUpdate(fence).then(
+ *      () => console.log('Geofence added'),
+ *      (err) => console.log('Geofence failed to add')
+ *    ); 
+ * }
+ * 
+ * ```
+ * ### Transition Types ###
+ * Transition type specifies whether the geofence should trigger when the user enters and/or leaves the geofence.
+ *
+ * #### Supported values ####
+ * - 1: Enter
+ * - 2: Leave
+ * - 3: Both
+ *
+ * ### Defining a Geofence ###
+ * Geofences are defined by an object that is passed to `addOrUpdate()`. Object properties are:
+ * - id: Any unique ID for the geofence. This ID is used to remove and update a geofence
+ * - latitude: Latitude coordinate of the center of the geofence radius
+ * - longitude: Latitude coordinate of the center of the geofence radius
+ * - radius: Radius from the center to the edge of the geofence
+ * - transitionType: Type of geofence transition to monitor for. See 'Transition Types' above
+ * - notification: Object. Options for defining the notification sent when a geofence is crossed
+ *   - id: Any unique ID
+ *   - title: Notification title
+ *   - text: Notification body
+ *   - openAppOnClick: Boolean. Whether to open the app when the notification is tapped by the user
+ *
+ * ### Troubleshooting ###
+ * #### I get compile errors when I run `ionic build ios` or `ionic run ios`. ####
+ * This could be caused by the Cordova project directory in `/platforms/ios` not being named correctly. 
+ * Try running `ionic platform rm <platform>` then run `ionic platform add <platform>` to recreate the
+ * platform directories.
+ */
+declare var window: any;
+
+@Plugin({
+  plugin: 'cordova-plugin-geofence',
+  pluginRef: 'geofence',
+  repo: 'https://github.com/cowbell/cordova-plugin-geofence/',
+  platforms: ['Android', 'iOS', 'Windows Phone 8', 'Windows Phone']
+})
+
+export class Geofence {
+
+  public static TransitionType = {
+    ENTER: 1,
+    EXIT: 2,
+    BOTH: 3
+  };
+
+  public static onTrasitionReceived: Function;
+
+  /**
+   * Initializes the plugin. User will be prompted to allow the app to use location and notifications.
+   *
+   * @return {Promise<any>}
+   */
+  @Cordova()
+  static initialize(): Promise<void> { return };
+  
+  /**
+   * Adds a new geofence or array of geofences. For geofence object, see above.
+   *
+   * @return {Promise<any>}
+   */
+  @Cordova()
+  static addOrUpdate(geofences: Object | Array<Object>): Promise<void> { return };
+  
+  /**
+   * Removes a geofence or array of geofences. `geofenceID` corresponds to one or more IDs specified when the 
+   * geofence was created.
+   *
+   * @return {Promise<any>}
+   */
+  @Cordova()
+  static remove(geofenceId: string | Array<string>): Promise<void> { return };
+  
+  /**
+   * Removes all geofences.
+   *
+   * @return {Promise<any>}
+   */
+  @Cordova()
+  static removeAll(): Promise<void> { return };
+  
+  /**
+   * Returns an array of geofences currently being monitored.
+   *
+   * @return {Promise<Array<string>>}
+   */
+  @Cordova()
+  static getWatched(): Promise<string> { return };
+
+  /**
+   * Called when a geofence is crossed in the direction specified by `TransitType`. 
+   * Commenting out. Not yet implemented in plugin.
+   *
+   * @return {Promise<any>}
+   */
+  @Cordova()
+  static onTransitionReceived(): Observable<any> {
+
+    return new Observable<any>((observer) => {
+      window.geofence.onTransitionReceived = observer.next.bind(observer);
+      return null;
+      // undefined can be replaced with ()=>{} .. whichever works better
+    });
+
+  }
+
+  /**
+   * Called when the user clicks a geofence notification. iOS and Android only.
+   * Commenting out. Not yet implemented in plugin.
+   *
+   * @return {Promise<Object>}
+   */
+  @Cordova()
+  static onNotificationClicked(): Observable<any> {
+
+  return new Observable<any>((observer) => {
+    window.geofence.onNotificationClicked = observer.next.bind(observer);
+      return () => window.geofence.onNotificationClicked = () => {}
+      // undefined can be replaced with ()=>{} .. whichever works better
+    });
+
+  }
+
+}