chore(): update changelog

fix(file): fix writeFile method

CHANGELOG.md

@@ -1,17 +1,43 @@
+<a name="2.2.2"></a>
+## [2.2.2](https://github.com/driftyco/ionic-native/compare/v2.2.1...v2.2.2) (2016-10-12)
+
+
+### Bug Fixes
+
+* **file:** getFreeDiskSpace now works ([d2f42ef](https://github.com/driftyco/ionic-native/commit/d2f42ef))
+* **file:** read methods can accept Blobs too ([276d61b](https://github.com/driftyco/ionic-native/commit/276d61b))
+
+
+### Features
+
+* **file:** getFile and getDirectory are now public ([5c92455](https://github.com/driftyco/ionic-native/commit/5c92455)), closes [#657](https://github.com/driftyco/ionic-native/issues/657)
+
+
+
+<a name="2.2.1"></a>
+## [2.2.1](https://github.com/driftyco/ionic-native/compare/v2.2.0...v2.2.1) (2016-10-12)
+
+
+### Bug Fixes
+
+* **diagnostic:** misspelled getContactsAuthorizationStatus method ([#678](https://github.com/driftyco/ionic-native/issues/678)) ([bff4862](https://github.com/driftyco/ionic-native/commit/bff4862))
+* **file:** fix writeFile method ([842a80d](https://github.com/driftyco/ionic-native/commit/842a80d))
+* **file:** last parameter for writeFile now only accepts options ([5710eb7](https://github.com/driftyco/ionic-native/commit/5710eb7))
+* **http:** export via window.IonicNative ([#675](https://github.com/driftyco/ionic-native/issues/675)) ([cf7abe1](https://github.com/driftyco/ionic-native/commit/cf7abe1))
+* **location-accuracy:** accuracy param is number ([c2d4f1c](https://github.com/driftyco/ionic-native/commit/c2d4f1c)), closes [#676](https://github.com/driftyco/ionic-native/issues/676)
+* **themeablebrowser:** add missed options ([#680](https://github.com/driftyco/ionic-native/issues/680)) ([e28e5b0](https://github.com/driftyco/ionic-native/commit/e28e5b0))
+
+
+### Features
+
+* **file:** resolveLocalFilesystemUrl and resolveDirectoryUrl are now public methods ([542ff4c](https://github.com/driftyco/ionic-native/commit/542ff4c)), closes [#657](https://github.com/driftyco/ionic-native/issues/657)
+
+
+
 <a name="2.2.0"></a>
 # [2.2.0](https://github.com/driftyco/ionic-native/compare/v2.1.9...v2.2.0) (2016-10-11)
 
 
-## BREAKING CHANGES
-
-### OneSignal
-The wrapper for this plugin has been updated to the match latest version of the plugin (2.x). If you are still using and older version of the plugin (1.x), you should use ionic-native v.2.1.x. 
-
-### ThemeableBrowser
-The wrapper for this plugin (and related interfaces) has been refactored to replace "Themable" with "Themeable". Please fix your existing code to match the new class and interfaces names.
-
-----
-
 ### Bug Fixes
 
 * **native-transitions:** add missing interface properties ([35c8bbd](https://github.com/driftyco/ionic-native/commit/35c8bbd))

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ionic-native",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "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

@@ -52,6 +52,7 @@ import { GooglePlus } from './plugins/google-plus';
 import { GoogleMap } from './plugins/googlemaps';
 import { GoogleAnalytics } from './plugins/googleanalytics';
 import { Hotspot } from  './plugins/hotspot';
+import { HTTP } from  './plugins/http';
 import { Httpd } from './plugins/httpd';
 import { IBeacon } from './plugins/ibeacon';
 import { ImagePicker } from './plugins/imagepicker';
@@ -266,6 +267,7 @@ window['IonicNative'] = {
   GoogleMap,
   GoogleAnalytics,
   Hotspot,
+  HTTP,
   Httpd,
   IBeacon,
   ImagePicker,

src/plugins/datepicker.ts

@@ -1,66 +1,104 @@
-import { Cordova, Plugin } from './plugin';
+import {Cordova, Plugin} from './plugin';
 
 
 export interface DatePickerOptions {
   /**
-   * Platforms: iOS, Android, Windows
    * The mode of the date picker
    * Values: date | time | datetime
    */
   mode: string;
 
   /**
-   * Platforms: iOS, Android, Windows
    * Selected date
    */
   date: Date | string | number;
 
   /**
-   * Platforms: iOS, Android, Windows
    * Minimum date
-   * Type: Date | empty String
    * Default: empty String
    */
   minDate?: Date | string | number;
 
   /**
-   * Platforms?: iOS, Android, Windows
    * Maximum date
-   * Type?: Date | empty String
    * Default?: empty String
    */
   maxDate?: Date | string | number;
 
   /**
-   * Platforms?: Android
    * Label for the dialog title. If empty, uses android default (Set date/Set time).
-   * Type?: String
    * Default?: empty String
    */
   titleText?: string;
 
   /**
-   * Platforms?: Android
    * Label of BUTTON_POSITIVE (done button) on Android
    */
   okText?: string;
-
-  // TODO complete documentation here, and copy params & docs to main plugin docs
+  /**
+   * Label of BUTTON_NEGATIVE (cancel button). If empty, uses android.R.string.cancel.
+   */
   cancelText?: string;
+  /**
+   * Label of today button. If empty, doesn't show the option to select current date.
+   */
   todayText?: string;
+  /**
+   * Label of now button. If empty, doesn't show the option to select current time.
+   */
   nowText?: string;
+  /**
+   * Shows time dialog in 24 hours format.
+   */
   is24Hour?: boolean;
+  /**
+   * Choose the Android theme for the picker. You can use the DatePicker.ANDROID_THEMES property.
+   * Values: 1: THEME_TRADITIONAL | 2: THEME_HOLO_DARK | 3: THEME_HOLO_LIGHT | 4: THEME_DEVICE_DEFAULT_DARK | 5: THEME_DEVICE_DEFAULT_LIGHT
+   */
   androidTheme?: number;
+  /**
+   * Shows or hide dates earlier then selected date.
+   */
   allowOldDate?: boolean;
+  /**
+   * Shows or hide dates after selected date.
+   */
   allowFutureDates?: boolean;
+  /**
+   * Label of done button.
+   */
   doneButtonLabel?: string;
+  /**
+   * Hex color of done button.
+   */
   doneButtonColor?: string;
+  /**
+   * Label of cancel button.
+   */
   cancelButtonLabel?: string;
+  /**
+   * Hex color of cancel button.
+   */
   cancelButtonColor?: string;
+  /**
+   * X position of date picker. The position is absolute to the root view of the application.
+   */
   x?: number;
+  /**
+   * Y position of date picker. The position is absolute to the root view of the application.
+   */
   y?: number;
+  /**
+   * Interval between options in the minute section of the date picker.
+   */
   minuteInterval?: number;
+  /**
+   * Force the UIPopoverArrowDirection enum. The value any will revert to default UIPopoverArrowDirectionAny and let the app choose the proper direction itself.
+   */
   popoverArrowDirection?: string;
+  /**
+   * Force locale for datePicker.
+   */
   locale?: string;
 }
 
@@ -86,7 +124,8 @@ export interface DatePickerOptions {
  *   err => console.log('Error occurred while getting date: ', err)
  * );
  * ```
- *
+ * @interfaces
+ * DatePickerOptions
  */
 @Plugin({
   plugin: 'cordova-plugin-datepicker',
@@ -95,12 +134,25 @@ export interface DatePickerOptions {
 })
 export class DatePicker {
 
+  /**
+   * @private
+   */
+  static ANDROID_THEMES = {
+    THEME_TRADITIONAL: 1,
+    THEME_HOLO_DARK: 2,
+    THEME_HOLO_LIGHT: 3,
+    THEME_DEVICE_DEFAULT_DARK: 4,
+    THEME_DEVICE_DEFAULT_LIGHT: 5
+  };
+
   /**
    * Shows the date and/or time picker dialog(s)
    * @param {DatePickerOptions} options Options for the date picker.
    * @returns {Promise<Date>} Returns a promise that resolves with the picked date and/or time, or rejects with an error.
    */
   @Cordova()
-  static show(options: DatePickerOptions): Promise<Date> { return; }
+  static show(options: DatePickerOptions): Promise<Date> {
+    return;
+  }
 
 }

src/plugins/diagnostic.ts

@@ -279,7 +279,7 @@ export class Diagnostic {
    * @returns {Promise<any>}
    */
   @Cordova({ platforms: ['Android', 'iOS'] })
-  static getContactsAuthroizationStatus(): Promise<any> { return; }
+  static getContactsAuthorizationStatus(): Promise<any> { return; }
 
   /**
    * Requests contacts authorization for the application.

src/plugins/file.ts

@@ -1,4 +1,4 @@
-import { Plugin, Cordova } from './plugin';
+import {Plugin, pluginWarn} from './plugin';
 
 declare var window: any;
 declare var cordova: any;
@@ -301,10 +301,10 @@ export interface FileReader {
   onabort: (evt: ProgressEvent) => void;
 
   abort(): void;
-  readAsText(fe: File, encoding?: string): void;
-  readAsDataURL(fe: File): void;
-  readAsBinaryString(fe: File): void;
-  readAsArrayBuffer(fe: File): void;
+  readAsText(fe: File | Blob, encoding?: string): void;
+  readAsDataURL(fe: File | Blob): void;
+  readAsBinaryString(fe: File | Blob): void;
+  readAsArrayBuffer(fe: File | Blob): void;
 }
 
 declare var FileReader: {
@@ -337,6 +337,12 @@ declare var FileError: {
   PATH_EXISTS_ERR: number;
 };
 
+let pluginMeta = {
+  plugin: 'cordova-plugin-file',
+  pluginRef: 'cordova.file',
+  repo: 'https://github.com/apache/cordova-plugin-file'
+};
+
 /**
  * @name File
  * @description
@@ -358,11 +364,7 @@ declare var FileError: {
  *  Although most of the plugin code was written when an earlier spec was current: http://www.w3.org/TR/2011/WD-file-system-api-20110419/
  *  It also implements the FileWriter spec : http://dev.w3.org/2009/dap/file-system/file-writer.html
  */
-@Plugin({
-  plugin: 'cordova-plugin-file',
-  pluginRef: 'cordova.file',
-  repo: 'https://github.com/apache/cordova-plugin-file'
-})
+@Plugin(pluginMeta)
 export class File {
   static cordovaFileError: {} = {
     1: 'NOT_FOUND_ERR',
@@ -381,9 +383,19 @@ export class File {
     14: 'DIR_READ_ERR',
   };
 
-  @Cordova()
+  /**
+   * Get free disk space
+   * @returns {Promise<number>} Returns a promise that resolves with the remaining free disk space
+   */
   static getFreeDiskSpace(): Promise<number> {
-    return;
+    return new Promise<any>((resolve, reject) => {
+      if (!cordova || !cordova.exec) {
+        pluginWarn(pluginMeta);
+        reject({ error: 'plugin_not_installed' });
+      } else {
+        cordova.exec(resolve, reject, 'File', 'getFreeDiskSpace', []);
+      }
+    });
   }
 
   /**
@@ -393,7 +405,6 @@ export class File {
    * @param {string} dir Name of directory to check
    * @return {Promise<boolean|FileError>} Returns a Promise that resolves to true if the directory exists or rejects with an error.
    */
-
   static checkDir(path: string, dir: string): Promise<boolean|FileError> {
     if ((/^\//.test(dir))) {
       let err = new FileError(5);
@@ -418,7 +429,6 @@ export class File {
    * @param {boolean} replace If true, replaces file with same name. If false returns error
    * @return {Promise<DirectoryEntry|FileError>} Returns a Promise that resolves with a DirectoryEntry or rejects with an error.
    */
-
   static createDir(path: string, dirName: string, replace: boolean): Promise<DirectoryEntry|FileError> {
     if ((/^\//.test(dirName))) {
       let err = new FileError(5);
@@ -447,7 +457,6 @@ export class File {
    * @param {string} dirName The directory name
    * @return {Promise<RemoveResult|FileError>} Returns a Promise that resolves to a RemoveResult or rejects with an error.
    */
-
   static removeDir(path: string, dirName: string): Promise<RemoveResult|FileError> {
     if ((/^\//.test(dirName))) {
       let err = new FileError(5);
@@ -473,7 +482,6 @@ export class File {
    * @param {string} newDirName The destination directory name
    * @return {Promise<DirectoryEntry|Entry|FileError>} Returns a Promise that resolves to the new DirectoryEntry object or rejects with an error.
    */
-
   static moveDir(path: string, dirName: string, newPath: string, newDirName: string): Promise<DirectoryEntry|Entry|FileError> {
     newDirName = newDirName || dirName;
 
@@ -530,7 +538,6 @@ export class File {
    * @param {string} dirName Name of directory
    * @return {Promise<Entry[]>} Returns a Promise that resolves to an array of Entry objects or rejects with an error.
    */
-
   static listDir(path: string, dirName: string): Promise<Entry[]> {
     if ((/^\//.test(dirName))) {
       let err = new FileError(5);
@@ -555,7 +562,6 @@ export class File {
    * @param {string} dirName Name of directory
    * @return {Promise<RemoveResult>} Returns a Promise that resolves with a RemoveResult or rejects with an error.
    */
-
   static removeRecursively(path: string, dirName: string): Promise<RemoveResult> {
     if ((/^\//.test(dirName))) {
       let err = new FileError(5);
@@ -579,7 +585,6 @@ export class File {
    * @param {string} file Name of file to check
    * @return {Promise<boolean|FileError>} Returns a Promise that resolves with a boolean or rejects with an error.
    */
-
   static checkFile(path: string, file: string): Promise<boolean|FileError> {
     if ((/^\//.test(file))) {
       let err = new FileError(5);
@@ -637,7 +642,6 @@ export class File {
    * @param {string} fileName Name of file to remove
    * @return {Promise<RemoveResult|FileError>} Returns a Promise that resolves to a RemoveResult or rejects with an error.
    */
-
   static removeFile(path: string, fileName: string): Promise<RemoveResult|FileError> {
     if ((/^\//.test(fileName))) {
       let err = new FileError(5);
@@ -659,38 +663,37 @@ export class File {
    * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
    * @param {string} fileName path relative to base path
    * @param {string | Blob} text content or blob to write
-   * @param {boolean | WriteOptions} replaceOrOptions replace file if set to true. See WriteOptions for more information.
+   * @param {WriteOptions} options replace file if set to true. See WriteOptions for more information.
    * @returns {Promise<void>} Returns a Promise that resolves or rejects with an error.
    */
   static writeFile(path: string, fileName: string,
-                   text: string | Blob, replaceOrOptions: boolean | WriteOptions): Promise<void> {
+                   text: string | Blob, options: WriteOptions): Promise<void> {
     if ((/^\//.test(fileName))) {
       let err = new FileError(5);
       err.message = 'file-name cannot start with \/';
       return Promise.reject(err);
     }
 
-    let opts: WriteOptions = {};
-    if (replaceOrOptions) {
-      if (typeof(replaceOrOptions) === 'boolean') {
-        opts.replace = <boolean>replaceOrOptions;
-      }
-    }
+    let getFileOpts: Flags = {
+      create: true,
+      exclusive: options.replace
+    };
 
     return File.resolveDirectoryUrl(path)
       .then((fse) => {
-        return File.getFile(fse, fileName, opts);
+        return File.getFile(fse, fileName, getFileOpts);
       })
       .then((fe) => {
         return File.createWriter(fe);
       })
       .then((writer) => {
-        if (opts.append) {
+
+        if (options.append) {
           writer.seek(writer.length);
         }
 
-        if (opts.hasOwnProperty('truncate')) {
-          writer.truncate(opts.truncate);
+        if (options.truncate) {
+          writer.truncate(options.truncate);
         }
 
         return File.write(writer, text);
@@ -959,12 +962,14 @@ export class File {
   }
 
   /**
-   * @private
+   * Resolves a local file system URL
+   * @param fileUrl {string} file system url
+   * @returns {Promise<Entry>}
    */
-  private static resolveLocalFilesystemUrl(furl: string): Promise<Entry> {
+  static resolveLocalFilesystemUrl(fileUrl: string): Promise<Entry> {
     return new Promise<Entry>((resolve, reject) => {
       try {
-        window.resolveLocalFileSystemURL(furl, (entry) => {
+        window.resolveLocalFileSystemURL(fileUrl, (entry) => {
           resolve(entry);
         }, (err) => {
           File.fillErrorMessage(err);
@@ -978,10 +983,12 @@ export class File {
   }
 
   /**
-   * @private
+   * Resolves a local directory url
+   * @param directoryUrl {string} directory system url
+   * @returns {Promise<DirectoryEntry>}
    */
-  private static resolveDirectoryUrl(durl: string): Promise<DirectoryEntry> {
-    return File.resolveLocalFilesystemUrl(durl)
+  static resolveDirectoryUrl(directoryUrl: string): Promise<DirectoryEntry> {
+    return File.resolveLocalFilesystemUrl(directoryUrl)
       .then((de) => {
         if (de.isDirectory) {
           return <DirectoryEntry>de;
@@ -994,12 +1001,16 @@ export class File {
   }
 
   /**
-   * @private
+   * Get a directory
+   * @param directoryEntry {DirectoryEntry} Directory entry, obtained by resolveDirectoryUrl method
+   * @param directoryName {string} Directory name
+   * @param flags {Flags} Options
+   * @returns {Promise<DirectoryEntry>}
    */
-  private static getDirectory(fse: DirectoryEntry, dn: string, flags: Flags): Promise<DirectoryEntry> {
+  static getDirectory(directoryEntry: DirectoryEntry, directoryName: string, flags: Flags): Promise<DirectoryEntry> {
     return new Promise<DirectoryEntry>((resolve, reject) => {
       try {
-        fse.getDirectory(dn, flags, (de) => {
+        directoryEntry.getDirectory(directoryName, flags, (de) => {
           resolve(de);
         }, (err) => {
           File.fillErrorMessage(err);
@@ -1013,14 +1024,16 @@ export class File {
   }
 
   /**
-   * @private
+   * Get a file
+   * @param directoryEntry {DirectoryEntry} Directory entry, obtained by resolveDirectoryUrl method
+   * @param fileName {string} File name
+   * @param flags {Flags} Options
+   * @returns {Promise<FileEntry>}
    */
-  private static getFile(fse: DirectoryEntry, fn: string, flags: Flags): Promise<FileEntry> {
+  static getFile(directoryEntry: DirectoryEntry, fileName: string, flags: Flags): Promise<FileEntry> {
     return new Promise<FileEntry>((resolve, reject) => {
       try {
-        fse.getFile(fn, flags, (fe) => {
-          resolve(fe);
-        }, (err) => {
+        directoryEntry.getFile(fileName, flags, resolve, (err) => {
           File.fillErrorMessage(err);
           reject(err);
         });
@@ -1123,12 +1136,12 @@ export class File {
       return this.writeFileInChunks(writer, gu);
     }
 
-    return new Promise<void>((resolve, reject) => {
+    return new Promise<any>((resolve, reject) => {
       writer.onwriteend = (evt) => {
         if (writer.error) {
           reject(writer.error);
         } else {
-          resolve();
+          resolve(evt);
         }
       };
       writer.write(gu);

src/plugins/http.ts

@@ -1,4 +1,4 @@
-import {Plugin, Cordova} from './plugin';
+import { Plugin, Cordova } from './plugin';
 /**
  * @name HTTP
  * @description
@@ -35,7 +35,8 @@ import {Plugin, Cordova} from './plugin';
 @Plugin({
   plugin: 'cordova-plugin-http',
   pluginRef: 'cordovaHTTP',
-  repo: 'https://github.com/wymsee/cordova-HTTP'
+  repo: 'https://github.com/wymsee/cordova-HTTP',
+  platforms: ['Android', 'iOS']
 })
 export class HTTP {
 
@@ -118,11 +119,11 @@ export class HTTP {
    * @param body {Object} The body of the request
    * @param headers {Object} The headers to set for this request
    * @param filePath {string} The local path of the file to upload
-   * @param fileParameter {string} The name of the parameter to pass the file along as
+   * @param name {string} The name of the parameter to pass the file along as
    * @return {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
    */
   @Cordova()
-  static uploadFile(url: string, body: any, headers: any, filePath: string, fileParameter: string): Promise<HTTPResponse> { return; }
+  static uploadFile(url: string, body: any, headers: any, filePath: string, name: string): Promise<HTTPResponse> { return; }
 
   /**
    *
@@ -134,8 +135,6 @@ export class HTTP {
    */
   @Cordova()
   static downloadFile(url: string, body: any, headers: any, filePath: string): Promise<HTTPResponse> { return; }
-
-
 }
 
 export interface HTTPResponse {

src/plugins/location-accuracy.ts

@@ -44,10 +44,11 @@ export class LocationAccuracy {
 
   /**
    * Requests accurate location
+   * @param accuracy {number} Accuracy, from 0 to 4. You can use the static properties of this class that start with REQUEST_PRIORITY_
    * @returns {Promise<any>} Returns a promise that resolves on success and rejects if an error occurred
    */
   @Cordova({ callbackOrder: 'reverse' })
-  static request(accuracy: string): Promise<any> { return; }
+  static request(accuracy: number): Promise<any> { return; }
 
   static REQUEST_PRIORITY_NO_POWER = 0;
   static REQUEST_PRIORITY_LOW_POWER = 1;

src/plugins/themeable-browser.ts

@@ -15,12 +15,19 @@ export interface ThemeableBrowserButton {
 }
 
 export interface ThemeableBrowserOptions {
-  statusbar?: { color: string; };
+  statusbar?: {
+    color: string;
+  };
   toolbar?: {
     height?: number;
     color?: string;
+    image?: string;
+  };
+  title?: {
+    color?: string;
+    staticText?: string;
+    showPageTitle?: boolean;
   };
-  title?: { color: string; };
   backButton?: ThemeableBrowserButton;
   forwardButton?: ThemeableBrowserButton;
   closeButton?: ThemeableBrowserButton;
@@ -37,6 +44,7 @@ export interface ThemeableBrowserOptions {
     }[];
   };
   backButtonCanClose?: boolean;
+  disableAnimation?: boolean;
 
   // inAppBrowser options
   location?: string;