chore(): update changelog

* feat(mixpanel): make MixpanelPeople return promises

* remove decorator from people property

* add cordova decorator'

* test(mixpanel): add mixpanel tests

* test(mixpanel): remove unused imports

* fix(mixpanel): fix MixpanelPeople class

closes #667

.github/CONTRIBUTING.md

@@ -1,18 +1,19 @@
 # Contributing to Ionic Native
 
-
-## Feature request?
-Have a plugin you'd like to see supported? Since Ionic Native is a thin wrapper around existing Cordova plugins, adding support for new plugins is as easy as creating a new wrapper for whatever plugin you'd like to add.
-
-Take a look at our [Developer Guide](https://github.com/driftyco/ionic-native/blob/master/DEVELOPER.md) for more info on adding new plugins.
-
 ## Have an issue?
 #### There are no rules, but here are a few things to consider:
 ###### Before you submit an issue:
 * Do a quick search to see if there are similar issues
-* **Check that you are using the latest version of** `ionic-native`
+* Make sure that you are waiting for `deviceready` to fire before interacting with any plugin. If you are using Ionic 2, this can be done using [the `Platform.ready()` function](http://ionicframework.com/docs/v2/api/platform/Platform/#ready).
+* **Check that you are using the latest version of** `ionic-native`, you can install the latest version by running `npm i --save ionic-native@latest`
 
 ###### Still having problems? submit an issue with the following details:
 * Short description of the issue
 * Steps to reproduce
 * Stack trace (if available)
+
+
+## Feature request?
+Have a plugin you'd like to see supported? Since Ionic Native is a thin wrapper around existing Cordova plugins, adding support for new plugins is as easy as creating a new wrapper for whatever plugin you'd like to add.
+
+Take a look at our [Developer Guide](https://github.com/driftyco/ionic-native/blob/master/DEVELOPER.md) for more info on adding new plugins.

CHANGELOG.md

@@ -1,3 +1,20 @@
+<a name="2.2.4"></a>
+## [2.2.4](https://github.com/driftyco/ionic-native/compare/v2.2.3...v2.2.4) (2016-10-15)
+
+
+### Bug Fixes
+
+* **sqlite:** fix callback order for transaction ([#700](https://github.com/driftyco/ionic-native/issues/700)) ([799e2f0](https://github.com/driftyco/ionic-native/commit/799e2f0))
+
+
+### Features
+
+* **device-feedback:** add DeviceFeedback plugin ([#696](https://github.com/driftyco/ionic-native/issues/696)) ([bbda6e2](https://github.com/driftyco/ionic-native/commit/bbda6e2))
+* **image-picker:** add new android methods ([3edfafb](https://github.com/driftyco/ionic-native/commit/3edfafb))
+* **mixpanel:** MixpanelPeople returns promises ([#681](https://github.com/driftyco/ionic-native/issues/681)) ([b95f88c](https://github.com/driftyco/ionic-native/commit/b95f88c)), closes [#667](https://github.com/driftyco/ionic-native/issues/667)
+
+
+
 <a name="2.2.3"></a>
 ## [2.2.3](https://github.com/driftyco/ionic-native/compare/v2.2.2...v2.2.3) (2016-10-14)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ionic-native",
-  "version": "2.2.3",
+  "version": "2.2.4",
   "description": "Native plugin wrappers for Cordova and Ionic with TypeScript, ES6+, Promise and Observable support",
   "main": "dist/es5/index.js",
   "module": "dist/esm/index.js",

src/index.ts

@@ -32,6 +32,7 @@ import { DatePicker } from './plugins/datepicker';
 import { DBMeter } from './plugins/dbmeter';
 import { Deeplinks } from './plugins/deeplinks';
 import { Device } from './plugins/device';
+import { DeviceFeedback } from './plugins/device-feedback';
 import { DeviceAccounts } from './plugins/deviceaccounts';
 import { DeviceMotion } from './plugins/devicemotion';
 import { DeviceOrientation } from './plugins/deviceorientation';
@@ -139,6 +140,7 @@ export * from './plugins/datepicker';
 export * from './plugins/dbmeter';
 export * from './plugins/deeplinks';
 export * from './plugins/device';
+export * from './plugins/device-feedback';
 export * from './plugins/deviceaccounts';
 export * from './plugins/devicemotion';
 export * from './plugins/deviceorientation';
@@ -248,6 +250,7 @@ window['IonicNative'] = {
   DBMeter,
   Deeplinks,
   Device,
+  DeviceFeedback,
   DeviceAccounts,
   DeviceMotion,
   DeviceOrientation,

src/plugins/background-geolocation.ts

@@ -236,8 +236,8 @@ export interface Config {
  *
  * // When device is ready :
  * platform.ready().then(() => {
- *     // IMPORTANT: BackgroundGeolocation must be called within app.ts and or before Geolocation. Otherwise the platform will not ask you for background tracking permission. 
- * 
+ *     // IMPORTANT: BackgroundGeolocation must be called within app.ts and or before Geolocation. Otherwise the platform will not ask you for background tracking permission.
+ *
  *     // BackgroundGeolocation is highly configurable. See platform specific configuration options
  *     let config = {
  *             desiredAccuracy: 10,
@@ -330,10 +330,9 @@ export class BackgroundGeolocation {
   /**
    * Configure the plugin.
    *
-   * @param {Function} Success callback will be called when background location is determined.
-   * @param {Function} Fail callback to be executed every time a geolocation error occurs.
-   * @param {Object} An object of type Config
-   *
+   * @param {Function} callback callback will be called when background location is determined.
+   * @param {Function} errorCallback callback to be executed every time a geolocation error occurs.
+   * @param {Config} options An object of type Config
    * @return Location object, which tries to mimic w3c Coordinates interface.
    * See http://dev.w3.org/geo/api/spec-source.html#coordinates_interface
    * Callback to be executed every time a geolocation is recorded in the background.
@@ -341,7 +340,7 @@ export class BackgroundGeolocation {
   @Cordova({
     sync: true
   })
-  static configure(callback: Function, errorCallback: Function, options: Config): void { return; }
+  static configure(callback: Function, errorCallback: Function, options: Config): any { return; }
 
   /**
    * Turn ON the background-geolocation system.

src/plugins/device-feedback.ts

@@ -0,0 +1,54 @@
+import {Plugin, Cordova} from './plugin';
+/**
+ * @name DeviceFeedback
+ * @description
+ *
+ * Plugin that lets you provide haptic or acoustic feedback on Android devices.
+ *
+ * @usage
+ * ```
+ * import { DeviceFeedback } from 'ionic-native';
+ *
+ * DeviceFeedback.acoustic();
+ *
+ * DeviceFeedback.haptic(0);
+ *
+ * DeviceFeedback.isFeedbackEnabled()
+ *   .then((feedback) => {
+ *     console.log(feedback);
+ *     // {
+ *     //   acoustic: true,
+ *     //   haptic: true
+ *     // }
+ *   });
+ *
+ * ```
+ */
+@Plugin({
+  plugin: 'cordova-plugin-velda-devicefeedback',
+  pluginRef: 'plugins.deviceFeedback',
+  repo: 'https://github.com/VVelda/device-feedback',
+  platforms: ['Android']
+})
+export class DeviceFeedback {
+
+  /**
+   * Provide sound feedback to user, nevertheless respect user's settings and current active device profile as native feedback do.
+   */
+  @Cordova({ sync: true })
+  static acoustic(): void { }
+
+  /**
+   * Provide vibrate feedback to user, nevertheless respect user's tactile feedback setting as native feedback do.
+   * @param type {Number} Specify type of vibration feedback. 0 for long press, 1 for virtual key, or 3 for keyboard tap.
+   */
+  @Cordova({ sync: true })
+  static haptic(type: number): void { }
+
+  /**
+   * Check if haptic and acoustic feedback is enabled by user settings.
+   */
+  @Cordova()
+  static isFeedbackEnabled(): Promise<{ haptic: boolean; acoustic: boolean; }> { return; }
+
+}

src/plugins/imagepicker.ts

@@ -2,19 +2,23 @@ import { Cordova, Plugin } from './plugin';
 
 
 export interface ImagePickerOptions {
-  // max images to be selected, defaults to 15. If this is set to 1, upon
-  // selection of a single image, the plugin will return it.
+  /**
+   * max images to be selected, defaults to 15. If this is set to 1, upon selection of a single image, the plugin will return it.
+   */
   maximumImagesCount?: number;
 
-  // max width and height to allow the images to be.  Will keep aspect
-  // ratio no matter what.  So if both are 800, the returned image
-  // will be at most 800 pixels wide and 800 pixels tall.  If the width is
-  // 800 and height 0 the image will be 800 pixels wide if the source
-  // is at least that wide.
+  /**
+   * Max width to allow images to be
+   */
   width?: number;
+  /**
+   * Max height to allow images to be
+   */
   height?: number;
 
-  // quality of resized image, defaults to 100
+  /**
+   * Quality of images, defaults to 100
+   */
   quality?: number;
 }
 
@@ -38,6 +42,8 @@ export interface ImagePickerOptions {
  *   }
  * }, (err) => { });
  * ```
+ * @interfaces
+ * ImagePickerOptions
  */
 @Plugin({
   plugin: 'cordova-plugin-image-picker',
@@ -56,4 +62,22 @@ export class ImagePicker {
   })
   static getPictures(options: ImagePickerOptions): Promise<any> { return; }
 
+  /**
+   * Check if we have permission to read images
+   * @returns {Promise<boolean>} Returns a promise that resolves with a boolean that indicates whether we have permission
+   */
+  @Cordova({
+    platforms: ['Android']
+  })
+  static hasReadPermission(): Promise<boolean> { return; }
+
+  /**
+   * Request permission to read images
+   * @returns {Promise<any>}
+   */
+  @Cordova({
+    platforms: ['Android']
+  })
+  static requestReadPermission(): Promise<any> { return; }
+
 }

src/plugins/mixpanel.ts

@@ -1,7 +1,15 @@
-import { Cordova, CordovaProperty, Plugin } from './plugin';
+import { Cordova, Plugin } from './plugin';
 
 declare var mixpanel: any;
 
+/**
+ * @private
+ */
+export const pluginMeta = {
+  plugin: 'cordova-plugin-mixpanel',
+  pluginRef: 'mixpanel',
+  repo: 'https://github.com/samzilverberg/cordova-mixpanel-plugin'
+};
 
 /**
  * @name Mixpanel
@@ -18,11 +26,7 @@ declare var mixpanel: any;
  *
  * ```
  */
-@Plugin({
-  plugin: 'cordova-plugin-mixpanel',
-  pluginRef: 'mixpanel',
-  repo: 'https://github.com/samzilverberg/cordova-mixpanel-plugin'
-})
+@Plugin(pluginMeta)
 export class Mixpanel {
   /**
    *
@@ -96,17 +100,61 @@ export class Mixpanel {
    *
    * @returns {MixpanelPeople}
    */
-  @CordovaProperty
-  static get people(): MixpanelPeople { return mixpanel.people; };
+  static get people(): typeof MixpanelPeople {
+    return MixpanelPeople;
+  };
 
 }
 /**
  * @private
  */
-export declare class MixpanelPeople {
-  static identify(distinctId: string, onSuccess?: Function, onFail?: Function): void;
-  static increment(peopleProperties: any, onSuccess?: Function, onFail?: Function): void;
-  static setPushId(pushId: string, onSuccess?: Function, onFail?: Function): void;
-  static set(peopleProperties: any, onSuccess?: Function, onFail?: Function): void;
-  static setOnce(peopleProperties: any, onSuccess?: Function, onFail?: Function): void;
+export class MixpanelPeople {
+  /**
+   * @private
+   */
+  static plugin: string = pluginMeta.plugin;
+  /**
+   * @private
+   */
+  static pluginRef: string = pluginMeta.pluginRef + '.people';
+
+  /**
+   *
+   * @param distinctId {string}
+   * @return {Promise<any>}
+   */
+  @Cordova()
+  static identify(distinctId: string): Promise<any> { return; }
+
+  /**
+   *
+   * @param peopleProperties {string}
+   * @return {Promise<any>}
+   */
+  @Cordova()
+  static increment(peopleProperties: any): Promise<any> { return; }
+
+  /**
+   *
+   * @param pushId
+   * @return {Promise<any>}
+   */
+  @Cordova()
+  static setPushId(pushId: string): Promise<any> { return; }
+
+  /**
+   *
+   * @param peopleProperties
+   * @return {Promise<any>}
+   */
+  @Cordova()
+  static set(peopleProperties: any): Promise<any> { return; }
+
+  /**
+   *
+   * @param peopleProperties
+   * @return {Promise<any>}
+   */
+  @Cordova()
+  static setOnce(peopleProperties: any): Promise<any> { return; }
 }

src/plugins/sqlite.ts

@@ -87,7 +87,10 @@ export class SQLite {
   })
   addTransaction(transaction: any): void { }
 
-  @CordovaInstance()
+  @CordovaInstance({
+    successIndex: 2,
+    errorIndex: 1
+  })
   transaction(fn: any): Promise<any> { return; }
 
   @CordovaInstance()

src/plugins/toast.ts

@@ -53,6 +53,8 @@ export interface ToastOptions {
  *   }
  * );
  * ```
+ * @interfaces
+ * ToastOptions
  */
 @Plugin({
   plugin: 'cordova-plugin-x-toast',

test/plugin.spec.ts

@@ -1,4 +1,4 @@
-/// <reference path="./../typings/index.d.ts" />
+/// <reference path="../typings/index.d.ts" />
 
 import 'es6-shim';
 import {Plugin, Cordova} from './../src/plugins/plugin';

test/plugins/mixpanel.spec.ts

@@ -0,0 +1,28 @@
+import {Mixpanel} from '../../src/plugins/mixpanel';
+declare const window: any;
+
+window.mixpanel = {
+  people: {
+    identify: (args, success, error) => success('Success')
+  }
+};
+
+describe('Mixpanel', () => {
+
+  it('should return MixpanelPeople', () => {
+    expect(Mixpanel.people).toBeDefined();
+    expect(Mixpanel.people.identify).toBeDefined();
+  });
+
+  it('should call a method of MixpanelPeople', (done) => {
+    const spy = spyOn(window.mixpanel.people, 'identify').and.callThrough();
+    Mixpanel.people.identify('veryDistinctSuchIdVeryWow')
+      .then(result => {
+        expect(result).toEqual('Success');
+        done();
+      });
+    expect(spy.calls.mostRecent().args[0]).toEqual('veryDistinctSuchIdVeryWow');
+    expect(window.mixpanel.people.identify).toHaveBeenCalled();
+  });
+
+});