chore(): update changelog

closes #883

CHANGELOG.md

@@ -1,3 +1,24 @@
+<a name="2.2.13"></a>
+## [2.2.13](https://github.com/driftyco/ionic-native/compare/v2.2.12...v2.2.13) (2016-12-27)
+
+
+### Bug Fixes
+
+* **admob:** add adId prop to AdMobOptions ([d5dfdf8](https://github.com/driftyco/ionic-native/commit/d5dfdf8))
+* **background-mode:** isEnabled and isActive return booleans ([ba77fd7](https://github.com/driftyco/ionic-native/commit/ba77fd7)), closes [#908](https://github.com/driftyco/ionic-native/issues/908)
+* **diagnostic:** add missing types ([1841220](https://github.com/driftyco/ionic-native/commit/1841220)), closes [#905](https://github.com/driftyco/ionic-native/issues/905)
+* **diagnostic:** add permissionStatus types ([#890](https://github.com/driftyco/ionic-native/issues/890)) ([3385c1b](https://github.com/driftyco/ionic-native/commit/3385c1b))
+
+
+### Features
+
+* **android-fingerprint-auth:** update to v1.2.1 ([#910](https://github.com/driftyco/ionic-native/issues/910)) ([a1b0f88](https://github.com/driftyco/ionic-native/commit/a1b0f88))
+* **nfc:** add new functions ([#853](https://github.com/driftyco/ionic-native/issues/853)) ([c44fb75](https://github.com/driftyco/ionic-native/commit/c44fb75))
+* **onesignal:** improve typings ([#888](https://github.com/driftyco/ionic-native/issues/888)) ([56e8eae](https://github.com/driftyco/ionic-native/commit/56e8eae))
+* **sim:** add new methods ([#894](https://github.com/driftyco/ionic-native/issues/894)) ([0c36988](https://github.com/driftyco/ionic-native/commit/0c36988))
+
+
+
 <a name="2.2.12"></a>
 ## [2.2.12](https://github.com/driftyco/ionic-native/compare/v2.2.11...v2.2.12) (2016-12-16)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ionic-native",
-  "version": "2.2.12",
+  "version": "2.2.13",
   "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/plugins/admob.ts

@@ -5,6 +5,11 @@ export type AdMobAdSize = 'SMART_BANNER' | 'BANNER' | 'MEDIUM_RECTANGLE' | 'FULL
 
 export interface AdMobOptions {
 
+  /**
+   * Banner ad ID
+   */
+  adId?: string;
+
   /**
    * Banner Ad Size, defaults to `SMART_BANNER`. IT can be: `SMART_BANNER`, `BANNER`, `MEDIUM_RECTANGLE`, `FULL_BANNER`, `LEADERBOARD`, `SKYSCRAPER`, or `CUSTOM`
    */

src/plugins/android-fingerprint-auth.ts

@@ -3,14 +3,26 @@ import { Cordova, Plugin } from './plugin';
 export interface AndroidFingerprintAuthOptions {
 
   /**
+   * Required
    * Used as the alias for your key in the Android Key Store.
    */
   clientId: string;
 
   /**
-   * Used to encrypt the token returned upon successful fingerprint authentication.
+   * Used to create credential string for encrypted token and as alias to retrieve the cipher.
    */
-  clientSecret: string;
+  username?: string;
+
+  /**
+   * Used to create credential string for encrypted token
+   */
+  password?: string;
+
+  /**
+   * Required for decrypt()
+   * Encrypted user credentials to decrypt upon successful authentication.
+   */
+  token?: string;
 
   /**
    * Set to true to remove the "USE BACKUP" button
@@ -22,6 +34,33 @@ export interface AndroidFingerprintAuthOptions {
    */
   locale?: string;
 
+  /**
+   * The device max is 5 attempts. Set this parameter if you want to allow fewer than 5 attempts.
+   */
+  maxAttempts?: number;
+
+  /**
+   * Require the user to authenticate with a fingerprint to authorize every use of the key.
+   * New fingerprint enrollment will invalidate key and require backup authenticate to
+   * re-enable the fingerprint authentication dialog.
+   */
+  userAuthRequired?: boolean;
+
+  /**
+   * Set the title of the fingerprint authentication dialog.
+   */
+  dialogTitle?: string;
+
+  /**
+   * Set the message of the fingerprint authentication dialog.
+   */
+  dialogMessage?: string;
+
+  /**
+   * Set the hint displayed by the fingerprint icon on the fingerprint authentication dialog.
+   */
+  dialogHint?: string;
+
 }
 
 /**
@@ -37,15 +76,20 @@ export interface AndroidFingerprintAuthOptions {
  *     if(result.isAvailable){
  *       // it is available
  *
- *       AndroidFingerprintAuth.show({ clientId: "myAppName", clientSecret: "so_encrypted_much_secure_very_secret" })
+ *       AndroidFingerprintAuth.encrypt({ clientId: "myAppName", username: "myUsername", password: "myPassword" })
  *         .then(result => {
- *            if(result.withFingerprint) {
- *              console.log('Successfully authenticated with fingerprint!');
- *            } else if(result.withPassword) {
+ *            if (result.withFingerprint) {
+ *                console.log("Successfully encrypted credentials.");
+ *                console.log("Encrypted credentials: " + result.token);
+ *            } else if (result.withBackup) {
  *              console.log('Successfully authenticated with backup password!');
  *            } else console.log('Didn\'t authenticate!');
  *         })
- *         .catch(error => console.error(error));
+ *         .catch(error => {
+ *            if (error === "Cancelled") {
+ *              console.log("Fingerprint authentication cancelled");
+ *            } else console.error(error)
+ *         });
  *
  *     } else {
  *       // fingerprint auth isn't available
@@ -70,15 +114,41 @@ export class AndroidFingerprintAuth {
    * @returns {Promise<any>}
    */
   @Cordova()
-  static show(options: AndroidFingerprintAuthOptions): Promise<{
+  static encrypt(options: AndroidFingerprintAuthOptions): Promise<{
     /**
-     * Base64 encoded string
+     * Biometric authentication
      */
-    withFingerprint: string;
+    withFingerprint: boolean;
     /**
-     *
+     * Authentication using backup credential activity
      */
-    withPassword: boolean;
+    withBackup: boolean;
+    /**
+     * base64encoded string representation of user credentials
+     */
+    token: string;
+  }> {return; }
+
+  /**
+   * Opens a native dialog fragment to use the device hardware fingerprint scanner to authenticate against fingerprints registered for the device.
+   * @param options {AndroidFingerprintAuthOptions} Options
+   * @returns {Promise<any>}
+   */
+  @Cordova()
+  static decrypt(options: AndroidFingerprintAuthOptions): Promise<{
+    /**
+     * Biometric authentication
+     */
+    withFingerprint: boolean;
+    /**
+     * Authentication using backup credential activity
+     */
+    withBackup: boolean;
+    /**
+     * FingerprintAuth.CipherMode.DECRYPT
+     * Decrypted password
+     */
+    password: string;
   }> {return; }
 
   /**
@@ -86,6 +156,12 @@ export class AndroidFingerprintAuth {
    * @returns {Promise<any>} Returns a Promise that resolves if fingerprint auth is available on the device
    */
   @Cordova()
-  static isAvailable(): Promise<{isAvailable: boolean}> {return; }
+  static isAvailable(): Promise<{isAvailable: boolean}> { return; }
 
+  /**
+   * Delete the cipher used for encryption and decryption by username
+   * @returns {Promise<any>} Returns a Promise that resolves if the cipher was successfully deleted
+   */
+  @Cordova()
+  static delete(options: {clientId: string; username: string; }): Promise<{deleted: boolean}> { return; }
 }

src/plugins/backgroundmode.ts

@@ -76,17 +76,21 @@ export class BackgroundMode {
 
   /**
   * Checks if background mode is enabled or not.
-  * @returns {Promise<boolean>} returns a promise that resolves with boolean that indicates if the background mode is enabled.
+  * @returns {boolean} returns a boolean that indicates if the background mode is enabled.
   */
-  @Cordova()
-  static isEnabled(): Promise<boolean> { return; }
+  @Cordova({
+    sync: true
+  })
+  static isEnabled(): boolean { return; }
 
   /**
   * Can be used to get the information if the background mode is active.
-  * @returns {Promise<boolean>} returns a promise that resolves with boolean that indicates if the background mode is active.
+  * @returns {boolean} returns a boolean that indicates if the background mode is active.
   */
-  @Cordova()
-  static isActive(): Promise<boolean> { return; }
+  @Cordova({
+    sync: true
+  })
+  static isActive(): boolean { return; }
 
   /**
   * Override the default title, ticker and text.

src/plugins/diagnostic.ts

@@ -66,12 +66,12 @@ export class Diagnostic {
 
   @CordovaProperty
   static permissionStatus: {
-    GRANTED;
-    DENIED;
-    NOT_REQUESTED;
-    DENIED_ALWAYS;
-    RESTRICTED;
-    GRANTED_WHEN_IN_USE;
+    GRANTED: string;
+    DENIED: string;
+    NOT_REQUESTED: string;
+    DENIED_ALWAYS: string;
+    RESTRICTED: string;
+    GRANTED_WHEN_IN_USE: string;
   };
 
   static locationAuthorizationMode = {

src/plugins/googleanalytics.ts

@@ -10,6 +10,20 @@ declare var window;
  * - A Cordova 3.0+ project for iOS and/or Android
  * - A Mobile App property through the Google Analytics Admin Console
  * - (Android) Google Play Services SDK installed via [Android SDK Manager](https://developer.android.com/sdk/installing/adding-packages.html)
+ * @usage
+ * ```typescript
+ * import { GoogleAnalytics } from 'ionic-native';
+ *
+ * GoogleAnalytics.startTrackerWithId('YOUR_TRACKER_ID')
+ *    .then(() => {
+ *      console.log('Google analytics is ready now');
+ *      // Tracker is ready
+ *      // You can now track pages or set additional information such as AppVersion or UserId
+ *    })
+ *    .catch(e => console.log('Error starting GoogleAnalytics', e));
+ *
+ *
+ * ```
  */
 @Plugin({
   pluginName: 'GoogleAnalytics',

src/plugins/media.ts

@@ -17,7 +17,11 @@ export interface MediaError {
  *
  *
  * // Create a MediaPlugin instance.  Expects path to file or url as argument
- * var file = new MediaPlugin('path/to/file.mp3');
+ * // We can optionally pass a second argument to track the status of the media
+ *
+ * const onStatusUpdate = (status) => console.log(status);
+ *
+ * const file = new MediaPlugin('path/to/file.mp3', onStatusUpdate);
  *
  * // Catch the Success & Error Output
  * // Platform Quirks

src/plugins/nfc.ts

@@ -47,19 +47,18 @@ export class NFC {
 
   /**
    * Registers an event listener for tags matching any tag type.
-   * @param mimeType
    * @param onSuccess
    * @param onFailure
    * @returns {Observable<any>}
    */
   @Cordova({
     observable: true,
-    successIndex: 1,
-    errorIndex: 4,
+    successIndex: 0,
+    errorIndex: 3,
     clearFunction: 'removeTagDiscoveredListener',
     clearWithArgs: true
   })
-  static addTagDiscoveredListener(mimeType: string, onSuccess?: Function, onFailure?: Function): Observable<any> {return; }
+  static addTagDiscoveredListener(onSuccess?: Function, onFailure?: Function): Observable<any> {return; }
 
   /**
    * Registers an event listener for NDEF tags matching a specified MIME type.
@@ -152,6 +151,27 @@ export class NFC {
    */
   @Cordova()
   static enabled(): Promise<any> {return; }
+  /**
+   * Convert bytes to string
+   * @param bytes {number[]}
+   * @returns {string}
+   */
+  @Cordova({ sync: true })
+  static bytesToString(bytes: number[]): string {return; }
+  /**
+   * Convert string to bytes
+   * @param str {string}
+   * @returns {string}
+   */
+  @Cordova({ sync: true })
+  static stringToBytes(str: string): number[] {return; };
+  /**
+   * Convert bytes to hex string
+   * @param bytes {number[]}
+   * @returns {string}
+   */
+  @Cordova({ sync: true })
+  static bytesToHexString(bytes: number[]): string {return; };
 
 }
 /**

src/plugins/onesignal.ts

@@ -1,7 +1,31 @@
 import { Cordova, Plugin } from './plugin';
 import { Observable } from 'rxjs/Observable';
 
-export interface OneSignalNotification {
+export interface OSNotification {
+  /**
+   * Was app in focus.
+   */
+  isAppInFocus: boolean;
+  /**
+   * Was notification shown to the user. Will be false for silent notifications.
+   */
+  shown: boolean;
+  /**
+   * **ANDROID** - Android Notification assigned to the notification. Can be used to cancel or replace the notification.
+   */
+  androidNotificationId?: number;
+  /**
+   * Payload received from OneSignal.
+   */
+  payload: OSNotificationPayload;
+  /**
+   * How the notification was displayed to the user. Can be set to `Notification`, `InAppAlert`, or `None` if it was not displayed.
+   */
+  displayType: OSDisplayType;
+  /**
+   * **ANDROID** - Notification is a summary notification for a group this will contain all notification payloads it was created from.
+   */
+  groupedNotifications?: OSNotificationPayload[];
   app_id: string;
   contents: any;
   headings?: any;
@@ -64,6 +88,177 @@ export interface OneSignalNotification {
   ios_category?: string;
 }
 
+/**
+ * **ANDROID** - Privacy setting for how the notification should be shown on the lockscreen of Android 5+ devices.
+ */
+export enum OSLockScreenVisibility {
+  /**
+   * Fully visible (default)
+   */
+  Public = 1,
+  /**
+   * Contents are hidden
+   */
+  Private = 0,
+  /**
+   * Not shown
+   */
+  Secret = -1
+}
+
+/**
+ * How the notification was displayed to the user. Part of OSNotification. See inFocusDisplaying for more information on how this is used.
+ */
+export enum OSDisplayType {
+  /**
+   * notification is silent, or inFocusDisplaying is disabled.
+   */
+  None = 0,
+  /**
+   * (**DEFAULT**) - native alert dialog display.
+   */
+  InAppAlert = 1,
+  /**
+   * native notification display.
+   */
+  Notification = 2
+}
+
+/**
+ * Contents and settings of the notification the user received.
+ */
+export interface OSNotificationPayload {
+  /**
+   * OneSignal notification UUID.
+   */
+  notificationID: string;
+  /**
+   * Title of the notification.
+   */
+  title: string;
+  /**
+   * Body of the notification.
+   */
+  body: string;
+  /**
+   * Custom additional data that was sent with the notification. Set on the dashboard under Options > Additional Data
+   * or with the 'data' field on the REST API.
+   */
+  additionalData?: any;
+  /**
+   * **ANDROID** - Small icon resource name set on the notification.
+   */
+  smallIcon?: string;
+  /**
+   * **ANDROID** - Large icon set on the notification.
+   */
+  largeIcon?: string;
+  /**
+   * **ANDROID** - Big picture image set on the notification.
+   */
+  bigPicture?: string;
+  /**
+   * **ANDROID** - Accent color shown around small notification icon on Android 5+ devices. ARGB format.
+   */
+  smallIconAccentColor?: string;
+  /**
+   * URL to open when opening the notification.
+   */
+  launchUrl?: string;
+  /**
+   * Sound resource to play when the notification is shown.
+   */
+  sound: string;
+  /**
+   * **ANDROID** - Devices that have a notification LED will blink in this color. ARGB format.
+   */
+  ledColor?: string;
+  lockScreenVisibility?: OSLockScreenVisibility;
+  /**
+   * **ANDROID** - Notifications with this same key will be grouped together as a single summary notification.
+   */
+  groupKey?: string;
+  /**
+   * **ANDROID** - Summary text displayed in the summary notification.
+   */
+  groupMessage?: string;
+  /**
+   * List of action buttons on the notification.
+   */
+  actionButtons: OSActionButton[];
+  /**
+   * **ANDROID** - The Google project number the notification was sent under.
+   */
+  fromProjectNumber?: string;
+  /**
+   * **ANDROID** - If a background image was set this object will be available.
+   */
+  backgroundImageLayout?: OSBackgroundImageLayout;
+  priority?: number;
+  /**
+   * List of action buttons on the notification.
+   */
+  rawPayload: string;
+}
+
+/**
+ * List of action buttons on the notification.
+ */
+export interface OSActionButton {
+  /**
+   * Id assigned to the button.
+   */
+  id: string;
+  /**
+   * Text show on the button to the user.
+   */
+  text: string;
+  /**
+   * **ANDROID** - Icon shown on the button.
+   */
+  icon: string;
+}
+
+/**
+ * **ANDROID** - If a background image was set, this object will be available.
+ */
+export interface OSBackgroundImageLayout {
+  /**
+   * Image URL or name used as the background image.
+   */
+  image: string;
+  /**
+   * Text color of the title on the notification. ARGB Format.
+   */
+  titleTextColor: string;
+  /**
+   * Text color of the body on the notification. ARGB Format.
+   */
+  bodyTextColor: string;
+}
+
+/**
+ * The information returned from a notification the user received.
+ */
+export interface OSNotificationOpenedResult {
+  action: {
+    /**
+     * Was the notification opened normally (`Opened`) or was a button pressed on the notification (`ActionTaken`).
+     */
+    type: OSActionType;
+    /**
+     * If `type` == `ActionTaken` then this will contain the id of the button pressed.
+     */
+    actionID?: string;
+  };
+  notification: OSNotification;
+}
+
+export enum OSActionType {
+  Opened = 0,
+  ActionTake = 1
+}
+
 /**
  * @name OneSignal
  * @description
@@ -91,13 +286,21 @@ export interface OneSignalNotification {
  * OneSignal.endInit();
  * ```
  * @interfaces
- * OneSignalNotification
+ * OSNotification
+ * OSLockScreenVisibility
+ * OSDisplayType
+ * OSNotificationPayload
+ * OSActionButton
+ * OSBackgroundImageLayout
+ * OSNotificationOpenedResult
+ * OSActionType
  */
 @Plugin({
   pluginName: 'OneSignal',
   plugin: 'onesignal-cordova-plugin',
   pluginRef: 'plugins.OneSignal',
-  repo: 'https://github.com/OneSignal/OneSignal-Cordova-SDK'
+  repo: 'https://github.com/OneSignal/OneSignal-Cordova-SDK',
+  platforms: ['Android', 'iOS', 'Windows', 'FireOS']
 })
 export class OneSignal {
 
@@ -111,45 +314,57 @@ export class OneSignal {
   };
 
   /**
-   * Start the initialization process. Once you are done configuring OneSignal, call the endInit function.
+   * Start the initialization process. Once you are done configuring OneSignal, call the `endInit` function.
    *
-   * @param {string} appId Your AppId from your OneSignal app
-   * @param {string} googleProjectNumber The Google Project Number (which you can get from the Google Developer Portal) and the autoRegister option.
+   * @param {string} appId Your OneSignal app id
+   * @param {string} googleProjectNumber **ANDROID** - your Google project number; only required for Android GCM/FCM pushes.
    * @returns {any}
    */
   @Cordova({ sync: true })
-  static startInit(appId: string, googleProjectNumber: string): any { return; }
+  static startInit(appId: string, googleProjectNumber?: string): any { return; }
 
   /**
-   * Callback to run when a notification is received
-   * @return {Observable<any>}
+   * Callback to run when a notification is received, whether it was displayed or not.
+   *
+   * @return {Observable<OneSignalReceivedNotification>}
    */
   @Cordova({
     observable: true
   })
-  static handleNotificationReceived(): Observable<any> { return; }
+  static handleNotificationReceived(): Observable<OSNotification> { return; }
 
   /**
-   * Callback to run when a notification is opened
-   * @return {Observable<any>}
+   * Callback to run when a notification is tapped on from the notification shade (**ANDROID**) or notification
+   * center (**iOS**), or when closing an Alert notification shown in the app (if InAppAlert is enabled in
+   * inFocusDisplaying).
+   *
+   * @return {Observable<OneSignalOpenedNotification>}
    */
   @Cordova({
     observable: true
   })
-  static handleNotificationOpened(): Observable<any> { return; }
+  static handleNotificationOpened(): Observable<OSNotificationOpenedResult> { return; }
 
   /**
+   * **iOS** - Settings for iOS apps
    *
    * @param settings
+   *  kOSSettingsKeyAutoPrompt: boolean = true
+   *  Auto prompt user for notification permissions.
+   *
+   *  kOSSettingsKeyInAppLaunchURL: boolean = false
+   *  Launch notifications with a launch URL as an in app webview.
    * @returns {any}
    */
   @Cordova({ sync: true })
   static iOSSettings(settings: {
-    kOSSettingsKeyInAppLaunchURL: boolean;
     kOSSettingsKeyAutoPrompt: boolean;
+    kOSSettingsKeyInAppLaunchURL: boolean;
   }): any { return; }
 
   /**
+   * Must be called after `startInit` to complete initialization of OneSignal.
+   *
    * @returns {any}
    */
   @Cordova({ sync: true })
@@ -167,11 +382,14 @@ export class OneSignal {
    * Lets you retrieve the OneSignal user id and device token.
    * Your handler is called after the device is successfully registered with OneSignal.
    *
-   * @returns {Promise<any>} Returns a Promise that reolves if the device was successfully registered.
-   * It returns a JSON with `userId`and `pushToken`.
+   * @returns {Promise<{userId: string; pushToken: string}>} Returns a Promise that reolves if the device was successfully registered.
+   *
+   *  userId {string} OneSignal userId is a UUID formatted string. (unique per device per app)
+   *
+   *  pushToken {string} A push token is a Google/Apple assigned identifier(unique per device per app).
    */
   @Cordova()
-  static getIds(): Promise<any> { return; }
+  static getIds(): Promise<{userId: string; pushToken: string}> { return; }
 
 
   /**
@@ -211,7 +429,7 @@ export class OneSignal {
 
   /**
    * Call this when you would like to prompt an iOS user to accept push notifications with the default system prompt.
-   * Only use if you passed false to autoRegister when calling init.
+   * Only works if you set `kOSSettingsAutoPrompt` to `false` in `iOSSettings`
    */
   @Cordova({ sync: true })
   static registerForPushNotifications(): void { }
@@ -244,10 +462,11 @@ export class OneSignal {
   *
   * Setting to control how OneSignal notifications will be shown when one is received while your app is in focus. By default this is set to inAppAlert, which can be helpful during development.
   *
-  * @param {number} displayOption Options are 0 = None, 1 = InAppAlert, and 2 = Notification.
+  * @param {DisplayType} displayOption
+  * @returns {any}
   */
   @Cordova({ sync: true })
-  static inFocusDisplaying(displayOption: number): void { }
+  static inFocusDisplaying(displayOption: OSDisplayType): any { return; }
 
   /**
   * You can call this method with false to opt users out of receiving all notifications through OneSignal.
@@ -264,7 +483,7 @@ export class OneSignal {
   * @returns {Promise<any>} Returns a Promise that resolves if the notification was send successfully.
   */
   @Cordova()
-  static postNotification(notificationObj: OneSignalNotification): Promise<any> { return; }
+  static postNotification(notificationObj: OSNotification): Promise<any> { return; }
 
   /**
   * Prompts the user for location permission to allow geotagging based on the "Location radius" filter on the OneSignal dashboard.

src/plugins/sim.ts

@@ -17,6 +17,15 @@ import { Cordova, Plugin } from './plugin';
  *   (info) => console.log('Sim info: ', info),
  *   (err) => console.log('Unable to get sim info: ', err)
  * );
+ *
+ * Sim.hasReadPermission().then(
+ *   (info) => console.log('Has permission: ', info)
+ * );
+ *
+ * Sim.requestReadPermission().then(
+ *   () => console.log('Permission granted'),
+ *   () => console.log('Permission denied')
+ * );
  * ```
  */
 @Plugin({
@@ -34,4 +43,21 @@ export class Sim {
   @Cordova()
   static getSimInfo(): Promise<any> { return; }
 
+  /**
+   * Check permission
+   * @returns {Promise<any>}
+   */
+  @Cordova({
+    platforms: ['Android']
+  })
+  static hasReadPermission(): Promise<any> { return; }
+
+  /**
+   * Request permission
+   * @returns {Promise<any>}
+   */
+  @Cordova({
+    platforms: ['Android']
+  })
+  static requestReadPermission(): Promise<any> { return; }
 }