chore(): update changelog

closes #939

CHANGELOG.md

@@ -1,5 +1,20 @@
+<a name="2.4.1"></a>
+## [2.4.1](https://github.com/driftyco/ionic-native/compare/v2.4.0...v2.4.1) (2017-01-24)
+
+
+### Bug Fixes
+
+* **screen-orientation:** lockOrientation returns a promise ([1c09ee1](https://github.com/driftyco/ionic-native/commit/1c09ee1)), closes [#939](https://github.com/driftyco/ionic-native/issues/939)
+
+
+
 <a name="2.4.0"></a>
-# [2.4.0](https://github.com/driftyco/ionic-native/compare/v2.3.2...v2.4.0) (2017-01-24)
+# [2.4.0](https://github.com/driftyco/ionic-native/compare/v2.3.3...v2.4.0) (2017-01-24)
+
+
+
+<a name="2.3.3"></a>
+## [2.3.3](https://github.com/driftyco/ionic-native/compare/v2.3.2...v2.3.3) (2017-01-24)
 
 
 ### Bug Fixes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ionic-native",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "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/plugin.ts

@@ -4,6 +4,98 @@ import { Observable } from 'rxjs/Observable';
 declare var window;
 declare var Promise;
 
+/**
+ * @private
+ */
+export interface PluginConfig {
+  /**
+   * Plugin name, this should match the class name
+   */
+  pluginName: string;
+  /**
+   * Plugin NPM package name
+   */
+  plugin: string;
+  /**
+   * Plugin object reference
+   */
+  pluginRef: string;
+  /**
+   * Github repository URL
+   */
+  repo: string;
+  /**
+   * Custom install command
+   */
+  install?: string;
+  /**
+   * Supported platforms
+   */
+  platforms?: string[];
+}
+
+/**
+ * @private
+ */
+export interface CordovaOptions {
+  /**
+   * Set to true if the wrapped method is a sync function
+   */
+  sync?: boolean;
+  /**
+   * Callback order. Set to reverse if the success/error callbacks are the first 2 arguments that the wrapped method takes.
+   */
+  callbackOrder?: 'reverse';
+  /**
+   * Callback style
+   */
+  callbackStyle?: 'node' | 'object';
+  /**
+   * Set a custom index for the success callback function. This doesn't work if callbackOrder or callbackStyle are set.
+   */
+  successIndex?: number;
+  /**
+   * Set a custom index for the error callback function. This doesn't work if callbackOrder or callbackStyle are set.
+   */
+  errorIndex?: number;
+  /**
+   * Success function property name. This must be set if callbackStyle is set to object.
+   */
+  successName?: string;
+  /**
+   * Error function property name. This must be set if callbackStyle is set to object.
+   */
+  errorName?: string;
+  /**
+   * Set to true to return an observable
+   */
+  observable?: boolean;
+  /**
+   * If observable is set to true, this can be set to a different function name that will cancel the observable.
+   */
+  clearFunction?: string;
+  /**
+   * This can be used if clearFunction is set. Set this to true to call the clearFunction with the same arguments used in the initial function.
+   */
+  clearWithArgs?: boolean;
+  /**
+   * Creates an observable that wraps a global event. Replaces document.addEventListener
+   */
+  eventObservable?: boolean;
+  /**
+   * Event name, this must be set if eventObservable is set to true
+   */
+  event?: string;
+  /**
+   * Set to true if the wrapped method returns a promise
+   */
+  otherPromise?: boolean;
+  /**
+   * Supported platforms
+   */
+  platforms?: string[];
+}
+
 /**
  * @private
  * @param pluginRef
@@ -303,7 +395,7 @@ function overrideFunction(pluginObj: any, methodName: string, args: any[], opts:
  * @param opts
  * @returns {function(...[any]): (undefined|*|Observable|*|*)}
  */
-export const wrap = function(pluginObj: any, methodName: string, opts: any = {}) {
+export const wrap = function(pluginObj: any, methodName: string, opts: CordovaOptions = {}) {
   return (...args) => {
     if (opts.sync) {
       // Sync doesn't wrap the plugin with a promise or observable, it returns the result as-is
@@ -320,35 +412,6 @@ export const wrap = function(pluginObj: any, methodName: string, opts: any = {})
   };
 };
 
-/**
- * @private
- */
-export interface PluginConfig {
-  /**
-   * Plugin name, this should match the class name
-   */
-  pluginName: string;
-  /**
-   * Plugin NPM package name
-   */
-  plugin: string;
-  /**
-   * Plugin object reference
-   */
-  pluginRef: string;
-  /**
-   * Github repository URL
-   */
-  repo: string;
-  /**
-   * Custom install command
-   */
-  install?: string;
-  /**
-   * Supported platforms
-   */
-  platforms?: string[];
-}
 
 /**
  * @private
@@ -405,7 +468,7 @@ export function Plugin(config: PluginConfig) {
  * Wrap a stub function in a call to a Cordova plugin, checking if both Cordova
  * and the required plugin are installed.
  */
-export function Cordova(opts: any = {}) {
+export function Cordova(opts: CordovaOptions = {}) {
   return (target: Object, methodName: string, descriptor: TypedPropertyDescriptor<any>) => {
     return {
       value: function(...args: any[]) {

src/plugins/screen-orientation.ts

@@ -49,9 +49,10 @@ export class ScreenOrientation {
    * Lock the orientation to the passed value.
    * See below for accepted values
    * @param orientation {string} The orientation which should be locked. Accepted values see table below.
+   * @returns {Promise<any>} returns a promise that resolves when the screen orientation is locked, and rejects when an error occurs.
    */
-  @Cordova({ sync: true })
-  static lockOrientation(orientation: string): void { }
+  @Cordova({ otherPromise: true })
+  static lockOrientation(orientation: string): Promise<string> { return; }
 
   /**
    * Unlock and allow all orientations.