5.32.1

closes #3649

.editorconfig

@@ -1,15 +1,15 @@
-# http://editorconfig.org
-
-root = true
-
-[*]
-charset = utf-8
-indent_style = space
-indent_size = 2
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.md]
-insert_final_newline = false
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+insert_final_newline = false
 trim_trailing_whitespace = false

.github/CONTRIBUTING.md

@@ -4,8 +4,8 @@
 #### 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
-* 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`
+* Make sure that you are waiting for `deviceready` to fire before interacting with any plugin. If you are using Ionic, this can be done using [the `Platform.ready()` function](http://ionicframework.com/docs/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/core@latest`
 
 ###### Still having problems? submit an issue with the following details:
 * Short description of the issue
@@ -16,4 +16,4 @@
 ## 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.
+Take a look at our [Developer Guide](https://github.com/ionic-team/ionic-native/blob/master/DEVELOPER.md) for more info on adding new plugins.

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,28 @@
+**I'm submitting a ...**  (check one with "x")
+[ ] bug report
+[ ] feature request
+[ ] support request => Please do not submit support requests here, use one of these channels: https://forum.ionicframework.com/ or https://ionicworldwide.herokuapp.com/
+
+**Current behavior:**
+<!-- Describe how the bug manifests. -->
+
+**Expected behavior:**
+<!-- Describe what the behavior would be without the bug. -->
+
+**Steps to reproduce:**
+<!-- If you are able to illustrate the bug or feature request with an example, please provide steps to reproduce. -->
+
+**Related code:**
+
+```
+insert any relevant code here
+```
+
+**Other information:**
+<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->
+
+**Ionic info:** (run `ionic info` from a terminal/cmd prompt and paste output below):
+
+```
+insert the output from ionic info here
+```

.github/workflows/nodejs.yml

@@ -0,0 +1,46 @@
+name: Node CI
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x]
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Cache ionic site
+      id: ionic-site
+      uses: actions/cache@v2
+      with:
+        path: ~/ionic-site/
+        key: ionic-site-${{ hashFiles('**/package-lock.json') }}
+    - name: Setup git
+      run: bash ./scripts/git/config.sh
+    - name: Prepare ionic-site repo
+      if: github.ref == 'refs/heads/master'
+      run: bash ./scripts/docs/prepare.sh
+    - name: Install dependencies
+      run: npm ci
+    - name: Lint
+      run: npm run lint
+    - name: Build
+      run: npm run build
+    - name: Test
+      run: npm run test
+    - name: Readmes
+      run: npm run readmes
+    - name: Deploy doc
+      if: github.ref == 'refs/heads/master'
+      run: bash ./scripts/docs/update_docs.sh
+      env:
+        GITHUB_PROJECT_REPONAME: ${{ github.repository }}
+        GITHUB_SHA1: ${{ github.sha }}

.github/workflows/npmpublish.yml

@@ -0,0 +1,38 @@
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - name: Install dependencies
+        run: npm ci
+      - name: Lint
+        run: npm run lint
+      - name: Build
+        run: npm run build
+      - name: Test
+        run: npm run test
+      - name: Readmes
+        run: npm run readmes
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm run shipit
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -1,5 +1,12 @@
 .DS_Store
 node_modules/
 .idea
-dist/
+.tmp
+aot/
 scripts/ionic-native-bower
+scripts/docs-json/*.json
+dist/
+src/@ionic-native/plugins/**/ngx
+*.d.ts
+injectable-classes.json
+

.prettierignore

@@ -0,0 +1,6 @@
+package.json
+node_modules
+.github
+.vscode
+dist
+CHANGELOG.md

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

CODE_OF_CONDUCT.md

@@ -0,0 +1,11 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of the Ionic project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities.
+
+Communication through any of Ionic's channels (GitHub, Slack, Forum, IRC, mailing lists, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the Ionic project to do the same.
+
+If any member of the community violates this code of conduct, the maintainers of the Ionic project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate.
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please email us at [hi@ionicframework.com](mailto:hi@ionicframework.com).

DEVELOPER.md

@@ -2,18 +2,21 @@
 
 This is a short guide on creating new plugin wrappers for Ionic Native.
 
-
 ## Creating Plugin Wrappers
 
 First, let's start by creating a new plugin wrapper from template.
- 
+
 ```
 // Call this command, and replace PluginName with the name of the plugin you wish to add
 // Make sure to capitalize the first letter, or use CamelCase if necessary.
- 
+
 gulp plugin:create -n PluginName
+
+// add -m flag to get a minimal template to start with
+gulp plugin:create -m -n PluginName
 ```
 
+Running the command above will create a new directory `src/@ionic-native/plugins/plugin-name/` with a single file in there: `index.ts`. This file is where all the plugin definitions should be.
 
 Let's take a look at the existing plugin wrapper for Geolocation to see what goes into an Ionic Native plugin (comments have been removed for clarity):
 
@@ -22,17 +25,18 @@ Let's take a look at the existing plugin wrapper for Geolocation to see what goe
   plugin: 'cordova-plugin-geolocation',
   pluginRef: 'navigator.geolocation'
 })
+@Injectable()
 export class Geolocation {
 
   @Cordova()
-  static getCurrentPosition(options?: GeolocationOptions): Promise<Geoposition> { return }
+  getCurrentPosition(options?: GeolocationOptions): Promise<Geoposition> { return; }
 
   @Cordova({
     callbackOrder: 'reverse',
     observable: true,
     clearFunction: 'clearWatch'
   })
-  static watchPosition(options?: GeolocationOptions): Observable<Geoposition> { return }
+  watchPosition(options?: GeolocationOptions): Observable<Geoposition> { return; }
 }
 ```
 
@@ -41,6 +45,7 @@ export class Geolocation {
 First and foremost, we want to create a class representing our plugin, in this case Geolocation.
 
 ```
+@Injectable()
 class Geolocation {
 
 }
@@ -57,6 +62,7 @@ For example, the `@Plugin` decorator adds information about the plugin to our Ge
   plugin: 'cordova-plugin-geolocation',
   pluginRef: 'navigator.geolocation'
 })
+@Injectable()
 export class Geolocation {
 
 }
@@ -64,7 +70,7 @@ export class Geolocation {
 
 Here, `plugin` is the name of the plugin package on npm and used when calling `cordova plugin add`.
 
-`pluginRef` refers to the where on `window` the underlying Cordova plugin is normally exposed.  For example, in the case of the Cordova Geolocation plugin, normally you would make calls like `window.navigator.geolocation.getCurrentPosition({}, success, error)`, so the `pluginRef` in this case is `navigator.geolocation`.
+`pluginRef` refers to the where on `window` the underlying Cordova plugin is normally exposed. For example, in the case of the Cordova Geolocation plugin, normally you would make calls like `window.navigator.geolocation.getCurrentPosition({}, success, error)`, so the `pluginRef` in this case is `navigator.geolocation`.
 
 #### Class Methods
 
@@ -74,14 +80,12 @@ Let's take a look at `getCurrentPosition` first.
 
 ```
   @Cordova()
-  static getCurrentPosition(options?: GeolocationOptions): Promise<Geoposition> { return }
+  getCurrentPosition(options?: GeolocationOptions): Promise<Geoposition> { return }
 ```
 
 It's just a stub. The `return` is only there to keep the TypeScript type-checker from complaining since we indicate that `getCurrentPosition` returns a `Promise<Geoposition>`.
 
-By default, the `@Cordova` decorator wraps the plugin callbacks in a Promise that resolves when the success callback is called and rejects when the error callback is called.  It also ensures that Cordova and the underlying plugin are available, and prints helpful diagnostics if they aren't.
-
-You'll also notice that `getCurrentPosition` is a static method. That's because the plugin class is just a utility class to call the underlying Cordova plugin methods, it's not an instance and has no state.
+By default, the `@Cordova` decorator wraps the plugin callbacks in a Promise that resolves when the success callback is called and rejects when the error callback is called. It also ensures that Cordova and the underlying plugin are available, and prints helpful diagnostics if they aren't.
 
 Next, let's look at the `watchPosition` method.
 
@@ -91,80 +95,28 @@ Next, let's look at the `watchPosition` method.
     observable: true,
     clearFunction: 'clearWatch'
   })
-  static watchPosition(options?: GeolocationOptions): Observable<Geoposition> { return }
+  watchPosition(options?: GeolocationOptions): Observable<Geoposition> { return }
 ```
 
 The `@Cordova` decorator has a few more options now.
 
-`observable` indicates that this method may call its callbacks multiple times, so `@Cordova` wraps it in an [`Observable`](https://github.com/driftyco/ionic-native#promises-and-observables) instead of a Promise.
+`observable` indicates that this method may call its callbacks multiple times, so `@Cordova` wraps it in an [`Observable`](https://github.com/ionic-team/ionic-native#promises-and-observables) instead of a Promise.
 
-`callbackOrder` refers to the method signature of the underlying Cordova plugin, and tells Ionic Native which arguments are the callbacks to map to the wrapping Promise or Observable.  In this case, the signature is [`watchPosition(success, error, options)`](https://github.com/apache/cordova-plugin-geolocation#navigatorgeolocationwatchposition), so we need to tell `@Cordova` that the callbacks are the first arguments, not the last arguments.  For rare cases, you can also specify the options `successIndex` and `errorIndex` to indicate where in the argument list the callbacks are located.
+`callbackOrder` refers to the method signature of the underlying Cordova plugin, and tells Ionic Native which arguments are the callbacks to map to the wrapping Promise or Observable. In this case, the signature is [`watchPosition(success, error, options)`](https://github.com/apache/cordova-plugin-geolocation#navigatorgeolocationwatchposition), so we need to tell `@Cordova` that the callbacks are the first arguments, not the last arguments. For rare cases, you can also specify the options `successIndex` and `errorIndex` to indicate where in the argument list the callbacks are located.
 
 `clearFunction` is used in conjunction with the `observable` option and indicates the function to be called when the Observable is disposed.
 
-### Updating index.ts
-
-For new plugins, you will need to update `/src/index.ts` to properly export your plugin and make it available for use.
-
-1. Import the plugin class into `index.ts`:
-
-`import {PluginClassName} from ./plugins/filenameForPlugin`
-
-No need to put the `.ts` extension on the filename.
-
-2. Add the plugin class name to the list in the `export` object:
-
-```
-export {
-  ActionSheet,
-  AdMob,
-  AndroidFingerprintAuth,
-  YourPluginClassName,
-  ...
-}
-```
-
-3. Add the plugin class name to the `window['IonicNative']` object:
-
-```
-window['IonicNative'] = {
-  ActionSheet: ActionSheet,
-  AdMob: AdMob,
-  AndroidFingerprintAuth: AndroidFingerprintAuth,
-  YourPluginClassName: YourPluginClassName,
-  ...
-```
-
-4. If your plugin exports any other objects outside of the plugin class, add an export statement for the file:
-
-`export * from './plugins/filenameForPlugin';`
-
-No need to put the `.ts` extension on the filename.
-
-For example, `googlemaps.ts` exports a const outside of the plugin's main `GoogleMap` class:
-
-```
-export const GoogleMapsAnimation = {
-  BOUNCE: 'BOUNCE',
-  DROP: 'DROP'
-};
-```
-
-To properly export `GoogleMapsAnimation`, `index.ts` is updated with:
-
-`export * from './plugins/googlemaps';`
-
 ### Testing your changes
 
-You need to run `npm run build` in the `ionic-native` project, this will create a `dist` directory. Then, you must go to your ionic application folder and replace your current `node_modules/ionic-native/dist/` with the newly generated one.
+You need to run `npm run build` in the `ionic-native` project, this will create a `dist` directory. The `dist` directory will contain a sub directory `@ionic-native` with all the packages compiled in there. Copy the package(s) you created/modified to your app's node_modules under the `@ionic-native` directory. (e.g. `cp -r dist/@ionic-native/plugin-name ../my-app/node_modules/@ionic-native/`).
 
 ### Cleaning the code
 
-You need to run `npm run lint` to analyze the code and ensure it's consistency with the repository style. Fix any errors before submitting a PR.
+You need to run `npm run lint` to analyze the code and ensure its consistency with the repository style. Fix any errors before submitting a PR.
 
 ### 'Wrapping' Up
 
-That's it! The only thing left to do is rigorously document the plugin and it's usage.  Take a look at some of the other plugins for good documentation styles.
+That's it! The only thing left to do is rigorously document the plugin and its usage. Take a look at some of the other plugins for good documentation styles.
 
 ## Commit Message Format
 
@@ -173,24 +125,109 @@ We have very precise rules over how our git commit messages can be formatted. Th
 `type(scope): subject`
 
 #### Type
+
 Must be one of the following:
 
-* **fix**: A bug fix
-* **feat**: A new feature
-* **docs**: Documentation only changes
-* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
-* **refactor**: A code change that neither fixes a bug nor adds a feature
-* **perf**: A code change that improves performance
-* **test**: Adding missing tests
-* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
+- **fix**: A bug fix
+- **feat**: A new feature
+- **docs**: Documentation only changes
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **perf**: A code change that improves performance
+- **test**: Adding missing tests
+- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
 
 #### Scope
+
 The scope could be anything specifying place of the commit change. For example, the name of the plugin being changed
 
 #### Subject
+
 The subject contains succinct description of the change:
 
-* use the imperative, present tense: "change" not "changed" nor "changes"
-* do not capitalize first letter
-* do not place a period (.) at the end
-* entire length of the commit message must not go over 50 characters
+- use the imperative, present tense: "change" not "changed" nor "changes"
+- do not capitalize first letter
+- do not place a period (.) at the end
+- entire length of the commit message must not go over 50 characters
+
+### Ionic Native Decorators
+
+#### Plugin
+
+A decorator to wrap the main plugin class, and any other classes that will use `@Cordova` or `@CordovaProperty` decorators. This decorator accepts the following configuration:
+
+- _pluginName_: Plugin name, this should match the class name
+- _plugin_: The plugin's NPM package, or Github URL if NPM is not available.
+- _pluginRef_: The plugin object reference. Example: 'cordova.file'.
+- _repo_: The plugin's Github Repository URL
+- _install_: (optional) Install command. This is used in case a plugin has a custom install command (takes variables).
+- _platforms_: An array of strings indicating the supported platforms.
+
+#### Cordova
+
+Checks if the plugin and the method are available before executing. By default, the decorator will wrap the callbacks of the function and return a Promise. This decorator takes the following configuration options:
+
+- **observable**: set to true to return an Observable
+- **methodName**: an optional name of the cordova plugins method name (if different from wrappers method name)
+- **clearFunction**: an optional name of a method to clear the observable we returned
+- **clearWithArgs**: 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.
+- **sync**: set to true if the method should return the value as-is without wrapping with Observable/Promise
+- **callbackOrder**: set to `reverse` if the success and error callbacks are the first two arguements of the method
+- **callbackStyle**: set to `node` if the plugin has one callback with a node style (e.g: `function(err, result){}`), or set to `object` if the callbacks are part of an object
+- **successName**: Success function property name. This must be set if callbackStyle is set to object.
+- **errorName**: Error function property name. This must be set if callbackStyle is set to object.
+- **successIndex**: Set a custom index for the success callback function. This doesn't work if callbackOrder or callbackStyle are set.
+- **errorIndex**: Set a custom index for the error callback function. This doesn't work if callbackOrder or callbackStyle are set.
+- **eventObservable**: set to true to return an observable that wraps an event listener
+- **event**: Event name, this must be set if eventObservable is set to true
+- **element**: Element to attach the event listener to, this is optional, defaults to `window`
+- **otherPromise**: Set to true if the wrapped method returns a promise
+- **platforms**: array of strings indicating supported platforms. Specify this if the supported platforms doesn't match the plugin's supported platforms.
+
+Example:
+
+```ts
+@Cordova()
+someMethod(): Promise<any> { return; }
+
+@Cordova({ sync: true })
+syncMethod(): number { }
+```
+
+#### CordovaProperty
+
+Checks if the plugin and property exist before getting/setting the property's value
+
+Example:
+
+```ts
+@CordovaProperty()
+someProperty: string;
+```
+
+#### CordovaCheck
+
+Checks if the plugin exists before performing a custom written method. By default, the method will return a promise that will reject with an error if the plugin is not available. This wrapper accepts two optional configurations:
+
+- **observable**: set to true to return an empty Observable if the plugin isn't available
+- **sync**: set to true to return nothing if the plugin isn't available
+
+Example:
+
+```ts
+@CordovaCheck()
+someMethod(): Promise<any> {
+  // anything here will only run if the plugin is available
+}
+```
+
+#### CordovaFunctionOverride
+
+Wrap a stub function in a call to a Cordova plugin, checking if both Cordova and the required plugin are installed.
+
+Example:
+
+```ts
+@CordovaFunctionOverride()
+someMethod(): Observable<any> { return; }
+```

LICENSE

@@ -1,23 +1,23 @@
-Copyright 2015-present Drifty Co.
-http://drifty.com/
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright 2015-present Drifty Co.
+http://drifty.com/
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,95 +1,275 @@
-[![Circle CI](https://circleci.com/gh/driftyco/ionic-native.svg?style=shield)](https://circleci.com/gh/driftyco/ionic-native) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
-[![npm](https://img.shields.io/npm/l/express.svg)](https://www.npmjs.com/package/ionic-native)
-
-[![NPM](https://nodei.co/npm/ionic-native.png?stars&downloads)](https://nodei.co/npm/ionic-native/)
-[![NPM](https://nodei.co/npm-dl/ionic-native.png?months=6&height=2)](https://nodei.co/npm/ionic-native/)
+[![Circle CI](https://circleci.com/gh/ionic-team/ionic-native.svg?style=shield)](https://circleci.com/gh/ionic-team/ionic-native) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) ![](https://img.shields.io/npm/v/@ionic-native/core.svg)
 
 # Ionic Native
 
-Ionic Native is a curated set of wrappers for Cordova plugins that make adding any native functionality you need to your [Ionic](http://ionicframework.com/), Cordova, or Web View mobile app easy.
+Ionic Native is a curated set of wrappers for Cordova plugins that make adding any native functionality you need to your [Ionic](https://ionicframework.com/) mobile app easy.
 
-### Documentation
+Ionic Native wraps plugin callbacks in a Promise or Observable, providing a common interface for all plugins and making it easy to use plugins with Angular change detection.
 
-For the full Ionic Native documentation, please visit [http://ionicframework.com/docs/v2/native/](http://ionicframework.com/docs/v2/native/).
+Ionic Native is available in two versions: 
+1. Ionic Native [Community Edition](https://ionicframework.com/docs/native/community), featuring open source, community-maintained Cordova and Capacitor plugins and APIs.
+2. Ionic Native [Enterprise Edition](https://ionicframework.com/docs/enterprise), featuring a library of Premier plugins and solutions that are fully supported and maintained by the Ionic team, with access to Ionic experts and a guaranteed response SLA to mission-critical app development.
 
-### Promises and Observables
+## Capacitor Support
 
-Ionic Native wraps plugin callbacks in a Promise or [Observable](https://gist.github.com/staltz/868e7e9bc2a7b8c1f754), providing a common interface for all plugins and ensuring that native events trigger change detection in Angular 2.
+In addition to Cordova, Ionic Native also works with [Capacitor](https://capacitor.ionicframework.com), Ionic's official native runtime. Basic usage below. For complete details, [see the Capacitor documentation](https://capacitor.ionicframework.com/docs/cordova/using-cordova-plugins).
 
-```
-import { Geolocation } from 'ionic-native';
+## Installation
 
-Geolocation.getCurrentPosition().then(pos => {
-  console.log('lat: ' + pos.coords.latitude + ', lon: ' + pos.coords.longitude);
-});
+Run following command to install Ionic Native in your project.
 
-let watch = Geolocation.watchPosition().subscribe(pos => {
-  console.log('lat: ' + pos.coords.latitude + ', lon: ' + pos.coords.longitude);
-});
-
-// to stop watching
-watch.unsubscribe();
+```bash
+npm install @ionic-native/core --save
 ```
 
-### Angular 1
+You also need to install the Ionic Native package for each plugin you want to add. Please see the [Ionic Native documentation](https://ionicframework.com/docs/native/) for complete instructions on how to add and use the plugins.
 
-Ionic Native works as a stand-in for [ngCordova](http://ngcordova.com/). In many cases, the usage is identical, but we import `ionic.native` instead of `ngCordova` as our module.
+## Documentation
 
-As a rule of thumb: take the ES6 class name of the plugin and add `$cordova` to get the service name. For example, `Geolocation` would be `$cordovaGeolocation`, and `Camera` will be `$cordovaCamera`:
+For the full Ionic Native documentation, please visit [https://ionicframework.com/docs/native/](https://ionicframework.com/docs/native/).
 
-```javascript
-angular.module('myApp', ['ionic', 'ionic.native'])
+### Basic Usage
 
-.controller('MyCtrl', function($scope, $cordovaCamera) {
-  $scope.takePicture = function() {
-    $cordovaCamera.getPicture(opts).then(function(p) {
-    }, function(err) {
-    });
-  };
-});
+#### Ionic/Angular apps
+
+To use a plugin, import and add the plugin provider to your `@NgModule`, and then inject it where you wish to use it.
+Make sure to import the injectable class from the `/ngx` directory as shown in the following examples:
+
+```typescript
+// app.module.ts
+import { Camera } from '@ionic-native/camera/ngx';
+
+...
+
+@NgModule({
+  ...
+
+  providers: [
+    ...
+    Camera
+    ...
+  ]
+  ...
+})
+export class AppModule { }
 ```
 
-For services that return observables, the Angular 1 digest cycle must be done manually (currently):
+```typescript
+import { Geolocation } from '@ionic-native/geolocation/ngx';
+import { Platform } from 'ionic-angular';
 
-```javascript
-angular.module('myApp', ['ionic', 'ionic.native'])
+@Component({ ... })
+export class MyComponent {
 
-.controller('MyCtrl', function($scope, $cordovaGeolocation) {
-  $scope.takePicture = function() {
-    $cordovaGeolocation.watchPosition(opts).subscribe(function(p) {
-      $scope.$apply(function() {
-        $scope.position = p.coords;
+  constructor(private geolocation: Geolocation, private platform: Platform) {
+
+    this.platform.ready().then(() => {
+
+      // get position
+      this.geolocation.getCurrentPosition().then(pos => {
+        console.log(`lat: ${pos.coords.latitude}, lon: ${pos.coords.longitude}`)
       });
-    }, function(err) {
+
+
+      // watch position
+      const watch = geolocation.watchPosition().subscribe(pos => {
+        console.log(`lat: ${pos.coords.latitude}, lon: ${pos.coords.longitude}`)
+      });
+
+      // to stop watching
+      watch.unsubscribe();
     });
+
+  }
+
+}
+```
+
+#### Ionic/React apps
+
+React apps must use Capacitor to build native mobile apps. However, Ionic Native (and therefore, Cordova plugins) can still be used.
+
+```bash
+# Install Core library (once per project)
+npm install @ionic-native/core
+
+# Install Ionic Native TypeScript wrapper
+npm install @ionic-native/barcode-scanner
+
+# Install Cordova plugin
+npm install phonegap-plugin-barcodescanner
+
+# Update native platform project(s) to include newly added plugin
+ionic cap sync
+```
+
+Import the plugin object then use its static methods:
+
+```typescript
+import { BarcodeScanner } from '@ionic-native/barcode-scanner';
+
+const Tab1: React.FC = () => {
+  const openScanner = async () => {
+    const data = await BarcodeScanner.scan();
+    console.log(`Barcode data: ${data.text}`);
   };
+  return (
+    <IonPage>
+      <IonHeader>
+        <IonToolbar>
+          <IonTitle>Tab 1</IonTitle>
+        </IonToolbar>
+      </IonHeader>
+      <IonContent>
+        <IonButton onClick={openScanner}>Scan barcode</IonButton>
+      </IonContent>
+    </IonPage>
+  );
+};
+```
+
+#### ES2015+/TypeScript
+
+These modules can work in any ES2015+/TypeScript app (including Angular/Ionic apps). To use any plugin, import the class from the appropriate package, and use it's static methods.
+
+```js
+import { Camera } from '@ionic-native/camera';
+
+document.addEventListener('deviceready', () => {
+  Camera.getPicture()
+    .then(data => console.log('Took a picture!', data))
+    .catch(e => console.log('Error occurred while taking a picture', e));
 });
 ```
 
+#### AngularJS
+
+Ionic Native generates an AngularJS module in runtime and prepares a service for each plugin. To use the plugins in your AngularJS app:
+
+1. Download the latest bundle from the [Github releases](https://github.com/ionic-team/ionic-native/releases) page.
+2. Include it in `index.html` before your app's code.
+3. Inject `ionic.native` module in your app.
+4. Inject any plugin you would like to use with a `$cordova` prefix.
+
+```js
+angular.module('myApp', ['ionic.native']).controller('MyPageController', function ($cordovaCamera) {
+  $cordovaCamera.getPicture().then(
+    function (data) {
+      console.log('Took a picture!', data);
+    },
+    function (err) {
+      console.log('Error occurred while taking a picture', err);
+    }
+  );
+});
+```
+
+#### Vanilla JS
+
+To use Ionic Native in any other setup:
+
+1. Download the latest bundle from the [Github releases](https://github.com/ionic-team/ionic-native/releases) page.
+2. Include it in `index.html` before your app's code.
+3. Access any plugin using the global `IonicNative` variable.
+
+```js
+document.addEventListener('deviceready', function () {
+  IonicNative.Camera.getPicture().then(
+    function (data) {
+      console.log('Took a picture!', data);
+    },
+    function (err) {
+      console.log('Error occurred while taking a picture', err);
+    }
+  );
+});
+```
+
+### Mocking and Browser Development (Ionic/Angular apps only)
+
+Ionic Native makes it possible to mock plugins and develop nearly the entirety of your app in the browser or in `ionic serve`.
+
+To do this, you need to provide a mock implementation of the plugins you wish to use. Here's an example of mocking the `Camera` plugin to return a stock image while in development:
+
+First import the `Camera` class in your `src/app/app.module.ts` file:
+
+```typescript
+import { Camera } from '@ionic-native/camera/ngx';
+```
+
+Then create a new class that extends the `Camera` class with a mock implementation:
+
+```typescript
+class CameraMock extends Camera {
+  getPicture(options) {
+    return new Promise((resolve, reject) => {
+      resolve('BASE_64_ENCODED_DATA_GOES_HERE');
+    });
+  }
+}
+```
+
+Finally, override the previous `Camera` class in your `providers` for this module:
+
+```typescript
+providers: [{ provide: Camera, useClass: CameraMock }];
+```
+
+Here's the full example:
+
+```typescript
+import { ErrorHandler, NgModule } from '@angular/core';
+import { BrowserModule } from '@angular/platform-browser';
+import { IonicApp, IonicModule, IonicErrorHandler } from 'ionic-angular';
+import { MyApp } from './app.component';
+import { HomePage } from '../pages/home/home';
+
+import { Camera } from '@ionic-native/camera/ngx';
+
+import { HomePage } from '../pages/home/home';
+import { MyApp } from './app.component';
+
+class CameraMock extends Camera {
+  getPicture(options) {
+    return new Promise((resolve, reject) => {
+      resolve('BASE_64_ENCODED_DATA_GOES_HERE');
+    });
+  }
+}
+
+@NgModule({
+  declarations: [MyApp, HomePage],
+  imports: [BrowserModule, IonicModule.forRoot(MyApp)],
+  bootstrap: [IonicApp],
+  entryComponents: [MyApp, HomePage],
+  providers: [
+    { provide: ErrorHandler, useClass: IonicErrorHandler },
+    { provide: Camera, useClass: CameraMock },
+  ],
+})
+export class AppModule {}
+```
+
 ### Runtime Diagnostics
 
 Spent way too long diagnosing an issue only to realize a plugin wasn't firing or installed? Ionic Native lets you know what the issue is and how you can resolve it.
 
-![img](http://ionic-io-assets.s3.amazonaws.com/ionic-native-console.png)
-
-## Installation
-
-Run following commmand to install ionic-native in your project.
-```
-npm install ionic-native --save
-```
-
+![img](https://ionic-io-assets.s3.amazonaws.com/ionic-native-console.png)
 
 ## Plugin Missing?
-Let us know or submit a PR! Take a look at [the Developer Guide](https://github.com/driftyco/ionic-native/blob/master/DEVELOPER.md) for more on how to contribute. :heart:
 
+Let us know or submit a PR! Take a look at [the Developer Guide](https://github.com/ionic-team/ionic-native/blob/master/DEVELOPER.md) for more on how to contribute. :heart:
 
 # Credits
 
-Ibby Hadeed - [@ihadeed](http://github.com/ihadeed)
+Ibby Hadeed - [@ihadeed](https://github.com/ihadeed)
 
-Tim Lancina - [@timlancina](http://twitter.com/timlancina)
+Daniel Sogl - [@sogldaniel](https://twitter.com/sogldaniel)
 
-Max Lynch - [@maxlynch](http://twitter.com/maxlynch)
+Tim Lancina - [@timlancina](https://twitter.com/timlancina)
+
+Mike Hartington - [@mhartington](https://twitter.com/mhartington)
+
+Max Lynch - [@maxlynch](https://twitter.com/maxlynch)
 
 Rob Wormald - [@robwormald](https://twitter.com/robwormald)

circle.yml

@@ -1,27 +1,51 @@
-machine:
-  node:
-    version: 4.1.0
-  ruby:
-    version: 2.1.2
-
-general:
-  branches:
-    only:
-      - master # ignore PRs and branches
-
-dependencies:
- pre:
-   - ./scripts/docs/prepare.sh
- cache_directories:
-   - "~/ionic-site" # cache ionic-site
-
-test:
-  override:
-    - npm test
-    - npm run build
-
-deployment:
- staging:
-   branch: master
-   commands:
-     - ./scripts/docs/update_docs.sh
+version: 2
+jobs:
+  build:
+    working_directory: ~/ionic-native/
+    docker:
+      - image: node:14
+    steps:
+      - checkout
+      - restore_cache:
+         key: ionic-site-{{ checksum "package.json" }}
+      - run:
+         name: Prepare ionic-site repo
+         command: |
+           if [ "${CIRCLE_BRANCH}" == "master" ]; then
+             ./scripts/docs/prepare.sh
+           fi
+      - save_cache:
+         key: ionic-site-{{ checksum "package.json" }}
+         paths:
+         - ~/ionic-site/
+      - restore_cache:
+         key: node_modules_{{ checksum "package.json" }}
+      - run:
+         name: Install node modules
+         command: npm ci
+      - save_cache:
+         key: node_modules_{{ checksum "package.json" }}
+         paths:
+         - ~/ionic-native/node_modules/
+      - run:
+          name: Run tslint
+          command: npm run lint
+      - run: bash ./scripts/git/config.sh
+      - run:
+          name: Build Ionic Native
+          command: npm run build
+      - run:
+          name: Generate README files to ensure docs are valid
+          command: npm run readmes
+      - run:
+          name: Run tests
+          command: npm test
+      - add_ssh_keys
+      - deploy:
+          name: Update docs
+          command: |
+            if [ "${CIRCLE_BRANCH}" == "master" ]; then
+              ./scripts/docs/update_docs.sh
+            else
+              echo "We are on ${CIRCLE_BRANCH} branch, not going to update docs."
+            fi

gulpfile.js

@@ -1,49 +1,51 @@
-var gulp = require('gulp');
-var minimist = require('minimist');
-var uglify = require('gulp-uglify');
-var rename = require("gulp-rename");
-var tslint = require('gulp-tslint');
-var decamelize = require('decamelize');
-var replace = require('gulp-replace');
+'use strict';
 
-var flagConfig = {
-  string: ['port', 'version', 'ngVersion', 'animations'],
-  boolean: ['dry-run'],
-  alias: {'p': 'port', 'v': 'version', 'a': 'ngVersion'},
-  default: { port: 8000 }
-};
-var flags = minimist(process.argv.slice(2), flagConfig);
+const gulp = require('gulp'),
+  minimist = require('minimist'),
+  rename = require('gulp-rename'),
+  tslint = require('gulp-tslint'),
+  replace = require('gulp-replace'),
+  _ = require('lodash');
+
+const flagConfig = {
+    string: ['port', 'version', 'ngVersion', 'animations'],
+    boolean: ['dry-run'],
+    alias: { p: 'port', v: 'version', a: 'ngVersion' },
+    default: { port: 8000 },
+  },
+  flags = minimist(process.argv.slice(2), flagConfig);
 
 /* Docs tasks */
 require('./scripts/docs/gulp-tasks')(gulp, flags);
 
-
-gulp.task("minify:dist", function(){
-  gulp.src('./dist/ionic.native.js')
-  .pipe(uglify())
-  .pipe(rename({
-    suffix: '.min'
-  }))
-  .pipe(gulp.dest('./dist'));
+gulp.task('lint', () => {
+  return gulp
+    .src('src/**/*.ts')
+    .pipe(
+      tslint({
+        formatter: 'verbose',
+        configuration: 'tslint.json',
+      })
+    )
+    .pipe(tslint.report());
 });
 
-gulp.task('lint', function() {
-  gulp.src('src/**/*.ts')
-    .pipe(tslint({
-      formatter: "verbose",
-      configuration: 'tslint.json'
-    }))
-    .pipe(tslint.report())
-});
+gulp.task('plugin:create', () => {
+  if (flags.n && flags.n !== '') {
+    const src = flags.m ? './scripts/templates/wrap-min.tmpl' : './scripts/templates/wrap.tmpl',
+      pluginName = flags.n,
+      spaced = pluginName.replace(/(?!^)([A-Z])/g, ' $1'),
+      kebabCase = _.kebabCase(pluginName);
 
-gulp.task('plugin:create', function(){
-  if(flags.n && flags.n !== ''){
-    var src = flags.m?'./scripts/templates/wrap-min.tmpl':'./scripts/templates/wrap.tmpl';
-    return gulp.src(src)
-      .pipe(replace('PluginName', flags.n))
-      .pipe(rename(decamelize(flags.n, '-') + '.ts'))
-      .pipe(gulp.dest('./src/plugins/'));
+    return gulp
+      .src(src)
+      .pipe(replace('{{ PluginName }}', pluginName))
+      .pipe(replace('{{ Plugin_Name }}', spaced))
+      .pipe(replace('{{ pluginName }}', _.lowerFirst(pluginName)))
+      .pipe(replace('{{ plugin-name }}', kebabCase))
+      .pipe(rename('index.ts'))
+      .pipe(gulp.dest('./src/@ionic-native/plugins/' + kebabCase));
   } else {
-    console.log("Usage is: gulp plugin:create -n PluginName");
+    console.log('Usage is: gulp plugin:create -n PluginName');
   }
 });

karma.conf.ts

@@ -1,61 +0,0 @@
-const WATCH = process.argv.indexOf('--watch') > -1;
-
-module.exports = config => {
-  config.set({
-
-    // base path that will be used to resolve all patterns (eg. files, exclude)
-    basePath: './',
-
-    // frameworks to use
-    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
-    frameworks: ['jasmine', 'browserify'],
-
-    // list of files / patterns to load in the browser
-    files: [
-      'test/**/*.spec.ts'
-    ],
-
-    // preprocess matching files before serving them to the browser
-    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
-    preprocessors: {
-      'test/**/*.spec.ts': ['browserify']
-    },
-
-    browserify: {
-      debug: true,
-      plugin: [ 'tsify' ],
-      extensions: ['.js', '.ts']
-    },
-
-    phantomjsLauncher: {
-      // Have phantomjs exit if a ResourceError is encountered (useful if karma exits without killing phantom)
-      exitOnResourceError: true
-    },
-
-    // test results reporter to use
-    // possible values: 'dots', 'progress'
-    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
-    reporters: ['dots'],
-
-    // web server port
-    port: 9876,
-
-    // enable / disable colors in the output (reporters and logs)
-    colors: true,
-
-    // level of logging
-    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
-    logLevel: config.LOG_INFO,
-
-    // enable / disable watching file and executing tests whenever any file changes
-    autoWatch: WATCH,
-
-    // start these browsers
-    // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
-    browsers: ['PhantomJS'],
-
-    // Continuous Integration mode
-    // if true, Karma captures browsers, runs the tests and exits
-    singleRun: !WATCH
-  });
-};

package.json

@@ -1,76 +1,109 @@
 {
   "name": "ionic-native",
-  "version": "2.4.1",
+  "version": "5.32.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",
-  "typings": "dist/es5/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "homepage": "https://ionicframework.com/",
+  "author": "Ionic Team <hi@ionic.io> (https://ionic.io)",
+  "license": "MIT",
+  "scripts": {
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "build:core": "tsc -p tsconfig.core.json",
+    "build:esm": "ts-node -P scripts/tsconfig.json scripts/tasks/build-esm",
+    "build:es5": "ts-node -P scripts/tsconfig.json scripts/tasks/build-es5",
+    "build:ngx": "ts-node -P scripts/tsconfig.json scripts/tasks/build-ngx",
+    "build": "npm run build:core && npm run build:esm && npm run build:ngx && npm run build:es5",
+    "prebuild": "rimraf -rf dist",
+    "npmpub": "ts-node -P scripts/tsconfig.json scripts/tasks/publish",
+    "lint": "gulp lint",
+    "readmes": "gulp readmes",
+    "docs-json": "ts-node -P scripts/tsconfig.json scripts/docs-json",
+    "version": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md",
+    "shipit": "npm run build && npm run readmes && npm run npmpub",
+    "prettier": "prettier --write \"**/*.{js,json,css,scss,less,md,ts,html,component.html}\""
+  },
   "dependencies": {
-    "rxjs": "5.0.0-beta.12"
+    "tslib": "^2.2.0"
   },
   "devDependencies": {
-    "browserify": "^13.3.0",
-    "canonical-path": "0.0.2",
-    "conventional-changelog-cli": "^1.2.0",
-    "conventional-github-releaser": "^1.1.3",
-    "cpr": "^2.0.2",
-    "cz-conventional-changelog": "^1.2.0",
-    "decamelize": "^1.2.0",
-    "dgeni": "^0.4.2",
-    "dgeni-packages": "^0.10.18",
-    "es6-shim": "~0.35.2",
-    "glob": "^7.1.1",
-    "gulp": "^3.9.1",
-    "gulp-rename": "^1.2.2",
-    "gulp-replace": "^0.5.4",
-    "gulp-tslint": "^6.1.2",
-    "gulp-uglify": "^2.0.0",
-    "jasmine-core": "~2.5.2",
-    "karma": "~1.3.0",
-    "karma-browserify": "~5.1.0",
-    "karma-jasmine": "~1.1.0",
-    "karma-phantomjs-launcher": "~1.0.2",
-    "lodash": "4.17.4",
-    "minimist": "^1.1.3",
-    "mkdirp": "^0.5.1",
-    "node-html-encoder": "0.0.2",
-    "q": "1.4.1",
-    "semver": "^5.3.0",
-    "tsify": "~3.0.0",
-    "tslint": "^3.15.1",
-    "tslint-ionic-rules": "0.0.7",
-    "typescript": "~2.0.10",
-    "watchify": "~3.7.0"
+    "@angular/common": "^11.2.10",
+    "@angular/compiler": "^11.2.10",
+    "@angular/compiler-cli": "^11.2.10",
+    "@angular/core": "^11.2.10",
+    "@types/cordova": "0.0.34",
+    "@types/fs-extra": "^9.0.11",
+    "@types/jest": "^26.0.22",
+    "@types/lodash": "^4.14.168",
+    "@types/node": "^12.20.9",
+    "@types/rimraf": "^3.0.0",
+    "@types/webpack": "^4.41.27",
+    "async-promise-queue": "^1.0.5",
+    "conventional-changelog-cli": "^2.1.1",
+    "cz-conventional-changelog": "^3.3.0",
+    "dgeni": "^0.4.14",
+    "dgeni-packages": "0.16.10",
+    "fs-extra": "^9.1.0",
+    "gulp": "^4.0.2",
+    "gulp-rename": "^2.0.0",
+    "gulp-replace": "^1.0.0",
+    "gulp-tslint": "^8.1.4",
+    "husky": "^4.3.8",
+    "jest": "^26.6.3",
+    "lint-staged": "^10.5.4",
+    "lodash": "^4.17.21",
+    "minimist": "^1.2.5",
+    "natives": "^1.1.6",
+    "prettier": "^2.2.1",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.45.2",
+    "rxjs": "^6.6.7",
+    "ts-jest": "^26.5.5",
+    "ts-node": "~8.3.0",
+    "tslint": "~6.1.0",
+    "tslint-config-prettier": "^1.18.0",
+    "tslint-ionic-rules": "0.0.21",
+    "typedoc": "^0.18.0",
+    "typescript": "~4.1.5",
+    "typescript-tslint-plugin": "^1.0.1",
+    "uglifyjs-webpack-plugin": "^2.2.0",
+    "unminified-webpack-plugin": "^2.0.0",
+    "webpack": "^4.46.0",
+    "winston": "^3.3.3",
+    "zone.js": "^0.11.4"
   },
-  "scripts": {
-    "test": "karma start",
-    "test:watch": "npm test -- --watch",
-    "start": "npm run test:watch",
-    "lint": "gulp lint",
-    "build": "npm run lint && npm run build:js && npm run build:esm && npm run build:bundle && npm run build:minify",
-    "build:js": "tsc -p tsconfig-es5.json",
-    "build:esm": "tsc -p tsconfig-esm.json",
-    "build:bundle": "browserify dist/es5/index.js > dist/ionic.native.js",
-    "build:minify": "gulp minify:dist",
-    "shipit": "npm run build && npm publish && bash ./scripts/bower.sh",
-    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
-    "plugin:create": "gulp plugin:create"
+  "jest": {
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(js?|ts?)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js",
+      "jsx",
+      "json"
+    ]
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/driftyco/ionic-native.git"
+    "url": "git+https://github.com/ionic-team/ionic-native.git"
   },
-  "license": "MIT",
   "bugs": {
-    "url": "https://github.com/driftyco/ionic-native/issues"
+    "url": "https://github.com/ionic-team/ionic-native/issues"
   },
-  "homepage": "https://github.com/driftyco/ionic-native",
   "config": {
     "commitizen": {
       "path": "./node_modules/cz-conventional-changelog"
     }
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*": [
+      "prettier --write"
+    ]
   }
 }

prettier.config.js

@@ -0,0 +1,16 @@
+module.exports = {
+  printWidth: 120,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'es5',
+  bracketSpacing: true,
+  jsxBracketSameLine: false,
+  arrowParens: 'avoid',
+  rangeStart: 0,
+  rangeEnd: Infinity,
+  requirePragma: false,
+  insertPragma: false,
+  proseWrap: 'preserve',
+};

scripts/bower.json

@@ -1,26 +0,0 @@
-{
-  "name": "ionic-native",
-  "description": "Native plugin wrappers for Cordova and Ionic with TypeScript, ES6+, Promise and Observable support",
-  "main": [
-    "ionic.native.js"
-  ],
-  "authors": [
-    "Max Lynch <max@ionic.io>"
-  ],
-  "license": "MIT",
-  "keywords": [
-    "ionic",
-    "native",
-    "html5",
-    "hybrid",
-    "mobile"
-  ],
-  "homepage": "https://github.com/driftyco/ionic-native-bower",
-  "ignore": [
-    "**/.*",
-    "node_modules",
-    "bower_components",
-    "test",
-    "tests"
-  ]
-}

scripts/bower.sh

@@ -1,28 +0,0 @@
-#!/bin/bash
-set -e
-
-
-# readJsonProp(jsonFile, property)
-# - restriction: property needs to be on an own line!
-function readJsonProp {
-  echo $(sed -En 's/.*"'$2'"[ ]*:[ ]*"(.*)".*/\1/p' $1)
-}
-
-VERSION=$(readJsonProp "package.json" "version")
-
-echo "BOWERING IONIC-NATIVE VERSION $VERSION. FOR GREAT JUSTICE..."
-
-DIR="scripts/ionic-native-bower"
-rm -rf $DIR
-mkdir $DIR
-cp dist/ionic.native.js dist/ionic.native.min.js $DIR
-cd $DIR
-git init
-git remote add origin git@github.com:driftyco/ionic-native-bower.git
-cp ../bower.json .
-git add .
-git commit -m "Bower release"
-git tag -f -m v$VERSION v$VERSION
-git push -f --tags origin master
-
-echo "BOWERING COMPLETED SOMEWHAT SUCCESSFULLY"

scripts/build/helpers.ts

@@ -0,0 +1,136 @@
+import * as ts from 'typescript';
+import * as fs from 'fs-extra';
+import * as path from 'path';
+import { camelCase, clone } from 'lodash';
+import { Logger } from '../logger';
+
+export const ROOT = path.resolve(__dirname, '../../');
+// tslint:disable-next-line:no-var-requires
+export const TS_CONFIG = clone(require(path.resolve(ROOT, 'tsconfig.json')));
+export const COMPILER_OPTIONS = TS_CONFIG.compilerOptions;
+export const PLUGINS_ROOT = path.join(ROOT, 'src/@ionic-native/plugins/');
+export const PLUGIN_PATHS = fs.readdirSync(PLUGINS_ROOT).map(d => path.join(PLUGINS_ROOT, d, 'index.ts'));
+
+export function getDecorator(node: ts.Node, index = 0): ts.Decorator {
+  if (node.decorators && node.decorators[index]) {
+    return node.decorators[index];
+  }
+}
+
+export function hasDecorator(decoratorName: string, node: ts.Node): boolean {
+  return (
+    node.decorators &&
+    node.decorators.length &&
+    node.decorators.findIndex(d => getDecoratorName(d) === decoratorName) > -1
+  );
+}
+
+export function getDecoratorName(decorator: any) {
+  return decorator.expression.expression.text;
+}
+
+export function getRawDecoratorArgs(decorator: any): any[] {
+  if (decorator.expression.arguments.length === 0) return [];
+  return decorator.expression.arguments[0].properties;
+}
+
+export function getDecoratorArgs(decorator: any) {
+  const properties: any[] = getRawDecoratorArgs(decorator);
+  const args = {};
+
+  properties.forEach(prop => {
+    let val: number | boolean;
+
+    switch (prop.initializer.kind) {
+      case ts.SyntaxKind.StringLiteral:
+      case ts.SyntaxKind.Identifier:
+        val = prop.initializer.text;
+        break;
+
+      case ts.SyntaxKind.ArrayLiteralExpression:
+        val = prop.initializer.elements.map((e: any) => e.text);
+        break;
+
+      case ts.SyntaxKind.TrueKeyword:
+        val = true;
+        break;
+
+      case ts.SyntaxKind.FalseKeyword:
+        val = false;
+        break;
+
+      case ts.SyntaxKind.NumericLiteral:
+        val = Number(prop.initializer.text);
+        break;
+
+      default:
+        Logger.debug('Unexpected property value type: ' + prop.initializer.kind);
+        throw new Error('Unexpected property value type << helpers.ts >>');
+    }
+
+    args[prop.name.text] = val;
+  });
+
+  return args;
+}
+
+/**
+ * FROM STENCIL
+ * Convert a js value into typescript AST
+ * @param val array, object, string, boolean, or number
+ * @returns Typescript Object Literal, Array Literal, String Literal, Boolean Literal, Numeric Literal
+ */
+export function convertValueToLiteral(val: any) {
+  if (Array.isArray(val)) {
+    return arrayToArrayLiteral(val);
+  }
+  if (typeof val === 'object') {
+    return objectToObjectLiteral(val);
+  }
+  if (typeof val === 'number') {
+    return ts.createNumericLiteral(String(val));
+  }
+  return ts.createLiteral(val);
+}
+
+/**
+ * FROM STENCIL
+ * Convert a js object into typescript AST
+ * @param obj key value object
+ * @returns Typescript Object Literal Expression
+ */
+function objectToObjectLiteral(obj: { [key: string]: any }): ts.ObjectLiteralExpression {
+  const newProperties: ts.ObjectLiteralElementLike[] = Object.keys(obj).map(
+    (key: string): ts.ObjectLiteralElementLike => {
+      return ts.createPropertyAssignment(ts.createLiteral(key), convertValueToLiteral(obj[key]) as ts.Expression);
+    }
+  );
+
+  return ts.createObjectLiteral(newProperties);
+}
+
+/**
+ * FROM STENCIL
+ * Convert a js array into typescript AST
+ * @param list array
+ * @returns Typescript Array Literal Expression
+ */
+function arrayToArrayLiteral(list: any[]): ts.ArrayLiteralExpression {
+  const newList: any[] = list.map(convertValueToLiteral);
+  return ts.createArrayLiteral(newList);
+}
+
+export function getMethodsForDecorator(decoratorName: string) {
+  switch (decoratorName) {
+    case 'CordovaProperty':
+      return ['cordovaPropertyGet', 'cordovaPropertySet'];
+    case 'InstanceProperty':
+      return ['instancePropertyGet', 'instancePropertySet'];
+    case 'CordovaCheck':
+      return ['checkAvailability'];
+    case 'InstanceCheck':
+      return ['instanceAvailability'];
+  }
+
+  return [camelCase(decoratorName)];
+}

scripts/build/ngx.ts

@@ -0,0 +1,132 @@
+import * as ts from 'typescript';
+import * as fs from 'fs-extra';
+import * as path from 'path';
+import * as rimraf from 'rimraf';
+import * as rollup from 'rollup';
+import { generateDeclarations } from './transpile';
+import { clone } from 'lodash';
+import { EmitFlags, createCompilerHost, CompilerOptions, CompilerHost, createProgram } from '@angular/compiler-cli';
+import { importsTransformer } from './transformers/imports';
+import { pluginClassTransformer } from './transformers/plugin-class';
+import { COMPILER_OPTIONS, PLUGIN_PATHS, ROOT } from './helpers';
+
+export function getProgram(rootNames: string[] = createSourceFiles()) {
+  const options: CompilerOptions = clone(COMPILER_OPTIONS);
+  options.basePath = ROOT;
+  options.moduleResolution = ts.ModuleResolutionKind.NodeJs;
+  options.module = ts.ModuleKind.ES2015;
+  options.target = ts.ScriptTarget.ES5;
+  options.lib = ['dom', 'es2017'];
+  options.inlineSourceMap = true;
+  options.importHelpers = true;
+  options.inlineSources = true;
+  options.enableIvy = false;
+
+  delete options.baseUrl;
+
+  const host: CompilerHost = createCompilerHost({ options });
+  return createProgram({
+    rootNames,
+    options,
+    host,
+  });
+}
+
+// hacky way to export metadata only for core package
+export function transpileNgxCore() {
+  getProgram([path.resolve(ROOT, 'src/@ionic-native/core/index.ts')]).emit({
+    emitFlags: EmitFlags.Metadata,
+    emitCallback: ({ program, writeFile, customTransformers, cancellationToken, targetSourceFile }) => {
+      return program.emit(targetSourceFile, writeFile, cancellationToken, true, customTransformers);
+    },
+  });
+}
+
+export function transpileNgx() {
+  getProgram().emit({
+    emitFlags: EmitFlags.Metadata,
+    customTransformers: {
+      beforeTs: [importsTransformer(true), pluginClassTransformer(true)],
+    },
+  });
+}
+
+export function generateDeclarationFiles() {
+  generateDeclarations(PLUGIN_PATHS.map(p => p.replace('index.ts', 'ngx/index.ts')));
+}
+
+export function generateLegacyBundles() {
+  [
+    path.resolve(ROOT, 'dist/@ionic-native/core/index.js'),
+    ...PLUGIN_PATHS.map(p =>
+      p.replace(path.join(ROOT, 'src'), path.join(ROOT, 'dist')).replace('index.ts', 'ngx/index.js')
+    ),
+  ].forEach(p =>
+    rollup
+      .rollup({
+        input: p,
+        onwarn(warning, warn) {
+          if (warning.code === 'UNUSED_EXTERNAL_IMPORT') return;
+          warn(warning);
+        },
+        external: ['@angular/core', '@ionic-native/core', 'rxjs', 'tslib'],
+      })
+      .then(bundle =>
+        bundle.write({
+          file: path.join(path.dirname(p), 'bundle.js'),
+          format: 'cjs',
+        })
+      )
+  );
+}
+
+// remove reference to @ionic-native/core decorators
+export function modifyMetadata() {
+  debugger;
+  PLUGIN_PATHS.map(p =>
+    p.replace(path.join(ROOT, 'src'), path.join(ROOT, 'dist')).replace('index.ts', 'ngx/index.metadata.json')
+  ).forEach(p => {
+    const content = fs.readJSONSync(p);
+    let _prop: { members: { [x: string]: any[] } };
+    for (const prop in content[0].metadata) {
+      _prop = content[0].metadata[prop];
+      removeIonicNativeDecorators(_prop);
+
+      if (_prop.members) {
+        for (const memberProp in _prop.members) {
+          removeIonicNativeDecorators(_prop.members[memberProp][0]);
+        }
+      }
+    }
+
+    fs.writeJSONSync(p, content);
+  });
+}
+
+function removeIonicNativeDecorators(node: any) {
+  if (node.decorators && node.decorators.length) {
+    node.decorators = node.decorators.filter(
+      (d: { expression: { module: string } }) => d.expression.module !== '@ionic-native/core'
+    );
+  }
+
+  if (node.decorators && !node.decorators.length) delete node.decorators;
+}
+
+function createSourceFiles(): string[] {
+  return PLUGIN_PATHS.map((indexPath: string) => {
+    const ngxPath = path.resolve(indexPath.replace('index.ts', ''), 'ngx'),
+      newPath = path.resolve(ngxPath, 'index.ts');
+
+    // delete directory
+    rimraf.sync(ngxPath);
+    fs.mkdirpSync(ngxPath);
+    fs.copyFileSync(indexPath, newPath);
+
+    return newPath;
+  });
+}
+
+export function cleanupNgx() {
+  PLUGIN_PATHS.forEach((indexPath: string) => rimraf.sync(indexPath.replace('index.ts', 'ngx')));
+}

scripts/build/remove-tslib-helpers.js

@@ -0,0 +1,2 @@
+// removes the __extends method that is added automatically by typescript
+module.exports = source => source.replace(/var\s__extends\s=\s\(this\s&&[\sa-z\._\(\)\|{}=:\[\]&,;?]+}\)\(\);/i, '');

scripts/build/transformers/extract-injectables.ts

@@ -0,0 +1,59 @@
+import * as fs from 'fs-extra';
+import * as path from 'path';
+import * as ts from 'typescript';
+
+import { hasDecorator, ROOT } from '../helpers';
+
+export interface InjectableClassEntry {
+  file: string;
+  className: string;
+  dirName: string;
+}
+
+const injectableClasses: InjectableClassEntry[] = [];
+export const EMIT_PATH = path.resolve(ROOT, 'injectable-classes.json');
+
+/**
+ * This transformer extracts all the injectable classes
+ * so we can use all the names later on when we compile
+ * an es5 bundle.
+ *
+ * Every injectable class will end up in the
+ * window['IonicNative'] object.
+ */
+export function extractInjectables() {
+  return (ctx: ts.TransformationContext) => {
+    return tsSourceFile => {
+      if (tsSourceFile.fileName.indexOf('src/@ionic-native/plugins') > -1) {
+        ts.visitEachChild(
+          tsSourceFile,
+          node => {
+            if (node.kind !== ts.SyntaxKind.ClassDeclaration) {
+              return node;
+            }
+
+            const isInjectable: boolean = hasDecorator('Injectable', node);
+            if (isInjectable) {
+              injectableClasses.push({
+                file: tsSourceFile.path,
+                className: (node as ts.ClassDeclaration).name.text,
+                dirName: tsSourceFile.path.split(/[\\\/]+/).reverse()[1],
+              });
+            }
+          },
+          ctx
+        );
+      }
+
+      return tsSourceFile;
+    };
+  };
+}
+
+export function emitInjectableClasses() {
+  fs.writeJSONSync(EMIT_PATH, injectableClasses);
+}
+
+export function cleanEmittedData() {
+  fs.unlinkSync(EMIT_PATH);
+}

scripts/build/transformers/imports.ts

@@ -0,0 +1,77 @@
+import * as ts from 'typescript';
+import { getMethodsForDecorator } from '../helpers';
+
+function transformImports(file: ts.SourceFile, ctx: ts.TransformationContext, ngcBuild?: boolean) {
+  // remove angular imports
+  if (!ngcBuild) {
+    // @ts-expect-error
+    file.statements = (file.statements as any).filter(
+      (s: any) => !(s.kind === ts.SyntaxKind.ImportDeclaration && s.moduleSpecifier.text === '@angular/core')
+    );
+  }
+
+  // find the @ionic-native/core import statement
+  const importStatement = (file.statements as any).find((s: any) => {
+    return s.kind === ts.SyntaxKind.ImportDeclaration && s.moduleSpecifier.text === '@ionic-native/core';
+  });
+
+  // we're only interested in files containing @ionic-native/core import statement
+  if (!importStatement) return file;
+
+  const decorators: string[] = [];
+
+  const decoratorRegex: RegExp = /@([a-zA-Z]+)\(/g;
+
+  const ignored: string[] = ['Plugin', 'Component', 'Injectable'];
+
+  const keep: string[] = ['getPromise', 'checkAvailability'];
+
+  let m;
+
+  while ((m = decoratorRegex.exec(file.text)) !== null) {
+    if (m.index === decoratorRegex.lastIndex) {
+      decoratorRegex.lastIndex++;
+    }
+    if (m && m[1] && decorators.indexOf(m[1]) === -1 && ignored.indexOf(m[1]) === -1) decorators.push(m[1]);
+  }
+
+  if (decorators.length) {
+    let methods = [];
+
+    decorators.forEach(d => (methods = getMethodsForDecorator(d).concat(methods)));
+
+    const methodElements = methods.map(m => ts.createIdentifier(m));
+    const methodNames = methodElements.map(el => el.escapedText);
+
+    importStatement.importClause.namedBindings.elements = [
+      ts.createIdentifier('IonicNativePlugin'),
+      ...methodElements,
+      ...importStatement.importClause.namedBindings.elements.filter(
+        el => keep.indexOf(el.name.text) !== -1 && methodNames.indexOf(el.name.text) === -1
+      ),
+    ];
+
+    if (ngcBuild) {
+      importStatement.importClause.namedBindings.elements = importStatement.importClause.namedBindings.elements.map(
+        binding => {
+          if (binding.escapedText) {
+            binding.name = {
+              text: binding.escapedText,
+            };
+          }
+          return binding;
+        }
+      );
+    }
+  }
+
+  return file;
+}
+
+export function importsTransformer(ngcBuild?: boolean) {
+  return (ctx: ts.TransformationContext) => {
+    return tsSourceFile => {
+      return transformImports(tsSourceFile, ctx, ngcBuild);
+    };
+  };
+}

scripts/build/transformers/members.ts

@@ -0,0 +1,33 @@
+import * as ts from 'typescript';
+import { transformMethod } from './methods';
+import { transformProperty } from './properties';
+
+export function transformMembers(cls: ts.ClassDeclaration) {
+  const propertyIndices: number[] = [];
+
+  const members = cls.members.map((member: any, index: number) => {
+    // only process decorated members
+    if (!member.decorators || !member.decorators.length) return member;
+
+    switch (member.kind) {
+      case ts.SyntaxKind.MethodDeclaration:
+        return transformMethod(member);
+      case ts.SyntaxKind.PropertyDeclaration:
+        propertyIndices.push(index);
+        return member;
+      case ts.SyntaxKind.Constructor:
+        return ts.createConstructor(undefined, undefined, member.parameters, member.body);
+      default:
+        return member; // in case anything gets here by accident...
+    }
+  });
+
+  propertyIndices.forEach((i: number) => {
+    const [getter, setter] = transformProperty(members, i) as any;
+    members.push(getter, setter);
+  });
+
+  propertyIndices.reverse().forEach(i => members.splice(i, 1));
+
+  return members;
+}

scripts/build/transformers/methods.ts

@@ -0,0 +1,62 @@
+import * as ts from 'typescript';
+import { Logger } from '../../logger';
+import {
+  convertValueToLiteral,
+  getDecorator,
+  getDecoratorArgs,
+  getDecoratorName,
+  getMethodsForDecorator,
+} from '../helpers';
+
+export function transformMethod(method: ts.MethodDeclaration) {
+  if (!method) return;
+
+  const decorator = getDecorator(method),
+    decoratorName = getDecoratorName(decorator),
+    decoratorArgs = getDecoratorArgs(decorator);
+
+  try {
+    return ts.createMethod(
+      undefined,
+      undefined,
+      undefined,
+      method.name,
+      undefined,
+      method.typeParameters,
+      method.parameters,
+      method.type,
+      ts.createBlock([ts.createReturn(getMethodBlock(method, decoratorName, decoratorArgs))])
+    );
+  } catch (e) {
+    Logger.error('Error transforming method: ' + (method.name as any).text);
+    Logger.error(e.message);
+  }
+}
+
+function getMethodBlock(method: ts.MethodDeclaration, decoratorName: string, decoratorArgs: any): ts.Expression {
+  const decoratorMethod = getMethodsForDecorator(decoratorName)[0];
+
+  switch (decoratorName) {
+    case 'CordovaCheck':
+    case 'InstanceCheck':
+      // TODO remove function wrapper
+      return ts.createImmediatelyInvokedArrowFunction([
+        ts.createIf(
+          ts.createBinary(
+            ts.createCall(ts.createIdentifier(decoratorMethod), undefined, [ts.createThis()]),
+            ts.SyntaxKind.EqualsEqualsEqualsToken,
+            ts.createTrue()
+          ),
+          method.body
+        ),
+      ]);
+
+    default:
+      return ts.createCall(ts.createIdentifier(decoratorMethod), undefined, [
+        ts.createThis(),
+        ts.createLiteral(decoratorArgs?.methodName || (method.name as any).text),
+        convertValueToLiteral(decoratorArgs),
+        ts.createIdentifier('arguments'),
+      ]);
+  }
+}

scripts/build/transformers/plugin-class.ts

@@ -0,0 +1,71 @@
+import * as ts from 'typescript';
+
+import { Logger } from '../../logger';
+import { convertValueToLiteral, getDecorator, getDecoratorArgs, getDecoratorName } from '../helpers';
+import { transformMembers } from './members';
+
+function transformClass(cls: any, ngcBuild?: boolean) {
+  Logger.profile('transformClass: ' + cls.name.text);
+
+  const pluginStatics = [];
+  const dec: any = getDecorator(cls);
+
+  if (dec) {
+    const pluginDecoratorArgs = getDecoratorArgs(dec);
+
+    // add plugin decorator args as static properties of the plugin's class
+    for (const prop in pluginDecoratorArgs) {
+      pluginStatics.push(
+        ts.createProperty(
+          undefined,
+          [ts.createToken(ts.SyntaxKind.StaticKeyword)],
+          ts.createIdentifier(prop),
+          undefined,
+          undefined,
+          convertValueToLiteral(pluginDecoratorArgs[prop])
+        )
+      );
+    }
+  }
+
+  cls = ts.createClassDeclaration(
+    ngcBuild && cls.decorators && cls.decorators.length
+      ? cls.decorators.filter(d => getDecoratorName(d) === 'Injectable')
+      : undefined, // remove Plugin and Injectable decorators
+    [ts.createToken(ts.SyntaxKind.ExportKeyword)],
+    cls.name,
+    cls.typeParameters,
+    cls.heritageClauses,
+    [...transformMembers(cls), ...pluginStatics]
+  );
+
+  Logger.profile('transformClass: ' + cls.name.text);
+  return cls;
+}
+
+function transformClasses(file: ts.SourceFile, ctx: ts.TransformationContext, ngcBuild?: boolean) {
+  Logger.silly('Transforming file: ' + file.fileName);
+  return ts.visitEachChild(
+    file,
+    node => {
+      if (
+        node.kind !== ts.SyntaxKind.ClassDeclaration ||
+        (node.modifiers && node.modifiers.find(v => v.kind === ts.SyntaxKind.DeclareKeyword))
+      ) {
+        return node;
+      }
+      return transformClass(node, ngcBuild);
+    },
+    ctx
+  );
+}
+
+export function pluginClassTransformer(ngcBuild?: boolean): ts.TransformerFactory<ts.SourceFile> {
+  return (ctx: ts.TransformationContext) => {
+    return tsSourceFile => {
+      if (tsSourceFile.fileName.indexOf('src/@ionic-native/plugins') > -1)
+        return transformClasses(tsSourceFile, ctx, ngcBuild);
+      return tsSourceFile;
+    };
+  };
+}

scripts/build/transformers/properties.ts

@@ -0,0 +1,58 @@
+import * as ts from 'typescript';
+
+import { getDecorator, getDecoratorName } from '../helpers';
+
+export function transformProperty(members: any[], index: number) {
+  const property = members[index] as ts.PropertyDeclaration,
+    decorator = getDecorator(property),
+    decoratorName = getDecoratorName(decorator);
+
+  let type: 'cordova' | 'instance';
+
+  switch (decoratorName) {
+    case 'CordovaProperty':
+      type = 'cordova';
+      break;
+
+    case 'InstanceProperty':
+      type = 'instance';
+      break;
+
+    default:
+      return property;
+  }
+
+  const getter = ts.createGetAccessor(
+    undefined,
+    undefined,
+    property.name,
+    undefined,
+    property.type,
+    ts.createBlock([
+      ts.createReturn(
+        ts.createCall(ts.createIdentifier(type + 'PropertyGet'), undefined, [
+          ts.createThis(),
+          ts.createLiteral((property.name as any).text),
+        ])
+      ),
+    ])
+  );
+
+  const setter = ts.createSetAccessor(
+    undefined,
+    undefined,
+    property.name,
+    [ts.createParameter(undefined, undefined, undefined, 'value', undefined, property.type)],
+    ts.createBlock([
+      ts.createStatement(
+        ts.createCall(ts.createIdentifier(type + 'PropertySet'), undefined, [
+          ts.createThis(),
+          ts.createLiteral((property.name as any).text),
+          ts.createIdentifier('value'),
+        ])
+      ),
+    ])
+  );
+
+  return [getter, setter];
+}

scripts/build/transpile.ts

@@ -0,0 +1,40 @@
+import * as ts from 'typescript';
+import { pluginClassTransformer } from './transformers/plugin-class';
+import { importsTransformer } from './transformers/imports';
+import { clone } from 'lodash';
+import { emitInjectableClasses, extractInjectables } from './transformers/extract-injectables';
+import { COMPILER_OPTIONS, PLUGIN_PATHS, TS_CONFIG } from './helpers';
+
+let host: ts.CompilerHost;
+
+export function getCompilerHost() {
+  if (!host) host = ts.createCompilerHost(TS_CONFIG);
+  return host;
+}
+
+export function getProgram(declaration = false, pluginPaths: string[] = PLUGIN_PATHS) {
+  const compilerOptions: ts.CompilerOptions = clone(COMPILER_OPTIONS);
+  compilerOptions.declaration = declaration;
+  compilerOptions.moduleResolution = ts.ModuleResolutionKind.NodeJs;
+  compilerOptions.target = ts.ScriptTarget.ES5;
+  compilerOptions.module = ts.ModuleKind.ES2015;
+  compilerOptions.inlineSourceMap = true;
+  compilerOptions.inlineSources = true;
+  compilerOptions.lib = ['lib.dom.d.ts', 'lib.es5.d.ts', 'lib.es2015.d.ts', 'lib.es2016.d.ts', 'lib.es2017.d.ts'];
+
+  return ts.createProgram(pluginPaths, compilerOptions, getCompilerHost());
+}
+
+export function generateDeclarations(sourceFiles?: string[]) {
+  return getProgram(true, sourceFiles).emit(undefined, getCompilerHost().writeFile, undefined, true);
+}
+
+export function transpile() {
+  const emitResult = getProgram().emit(undefined, getCompilerHost().writeFile, undefined, false, {
+    before: [extractInjectables(), importsTransformer(), pluginClassTransformer()],
+  });
+
+  emitInjectableClasses();
+
+  return emitResult;
+}

scripts/config.json

@@ -1,5 +0,0 @@
-{
-  "sitePath": "../ionic-site",
-  "v2DocsDir": "docs/v2/native",
-  "docsDest": "../ionic-site/content/docs/v2/native"
-}

scripts/docs-json/index.ts

@@ -0,0 +1,112 @@
+import * as fs from 'fs-extra';
+import { basename, dirname, resolve } from 'path';
+import { Application } from 'typedoc';
+import TypeDoc = require('typedoc');
+import { runInNewContext } from 'vm';
+
+interface Plugin {
+  packageName: string;
+  displayName: string;
+  description: string;
+  platforms: string[];
+  usage: string;
+  repo: string;
+  installVariables: string[];
+  cordovaPlugin: {
+    name: string;
+  };
+  premierSlug: string;
+  capacitorIncompatible: boolean;
+}
+
+const rootDir = resolve(__dirname, '../..');
+const typedocTmp = resolve(__dirname, 'typedoc.tmp.json');
+const pluginsDir = resolve(rootDir, 'src/@ionic-native/plugins');
+const typedoc = new Application();
+
+typedoc.options.addReader(new TypeDoc.TSConfigReader());
+typedoc.options.addReader(new TypeDoc.TypeDocReader());
+
+typedoc.bootstrap({
+  mode: 'modules',
+  ignoreCompilerErrors: true,
+});
+
+run(pluginsDir);
+
+async function run(pluginsDir: string) {
+  const typedocData = await generateTypedoc(pluginsDir);
+  const modules = typedocData.children.filter(isModule);
+  const plugins = modules.filter(hasPlugin).map(processPlugin);
+  await fs.outputJson(resolve(__dirname, 'plugins.json'), plugins, {
+    spaces: 2,
+  });
+}
+
+async function generateTypedoc(root: string, outputPath = typedocTmp) {
+  const pluginDirs = await fs.readdir(root);
+  const paths = pluginDirs.map(dir => resolve(root, dir, 'index.ts'));
+  typedoc.generateJson(paths, outputPath);
+  return fs.readJson(outputPath);
+}
+
+function processPlugin(pluginModule): Plugin {
+  const pluginClass = pluginModule.children.find(isPlugin);
+  const decorator = getPluginDecorator(pluginClass);
+  const packageName = `@ionic-native/${basename(dirname(pluginModule.originalName))}`;
+  const displayName = getTag(pluginClass, 'name');
+  const usage = getTag(pluginClass, 'usage');
+  const description = getTag(pluginClass, 'description');
+  const premierSlug = getTag(pluginClass, 'premier');
+  const capIncompat = getTag(pluginClass, 'capacitorincompatible');
+  const capacitorIncompatible = capIncompat ? true : undefined;
+  return {
+    packageName,
+    displayName,
+    description,
+    usage,
+    platforms: decorator.platforms,
+    repo: decorator.repo,
+    installVariables: decorator.installVariables,
+    cordovaPlugin: {
+      name: decorator.plugin,
+    },
+    premierSlug,
+    capacitorIncompatible,
+  };
+}
+
+/**
+ * Typedoc only gives us the Plugin decorator internals
+ * as a string. So, rather than try to parse that with a RegExp,
+ * we evaluate it using Node's vm module.
+ */
+const getPluginDecorator = (child: any) => {
+  if (isPlugin(child)) {
+    const decorator = child.decorators.find(d => d.name === 'Plugin');
+    return runInNewContext(`(${decorator.arguments.config})`);
+  }
+};
+
+const getTag = (child: any, tagName: string): string => {
+  if (hasTags(child)) {
+    const tag = child.comment.tags.find(t => t.tag === tagName);
+    if (tag) {
+      return tag.text;
+    }
+  }
+};
+
+const isModule = (child: any): boolean => child.kind === 1;
+
+const isClass = (child: any): boolean => child.kind === 128;
+
+const isPlugin = (child: any): boolean =>
+  isClass(child) &&
+  hasTags(child) &&
+  Array.isArray(child.decorators) &&
+  child.decorators.some(d => d.name === 'Plugin');
+
+const hasPlugin = (child: any): boolean => child.children.some(isPlugin);
+
+const hasTags = (child: any): boolean => child.comment && Array.isArray(child.comment.tags);

scripts/docs-json/readme.md

@@ -0,0 +1,3 @@
+# docs-json
+
+This script reads and generates [typedoc](https://github.com/TypeStrong/typedoc) data for each of the plugins in `src/@ionic-native/plugins`. That data is then formatted and output as `plugins.json` in this directory.

scripts/docs/config.json

@@ -0,0 +1,6 @@
+{
+  "sitePath": "../ionic-site",
+  "v2DocsDir": "docs/native",
+  "docsDest": "../ionic-site/content/docs/native",
+  "pluginDir": "dist/@ionic-native/plugins"
+}

scripts/docs/dgeni-config.js

@@ -1,185 +0,0 @@
-var Package = require('dgeni').Package;
-var jsdocPackage = require('dgeni-packages/jsdoc');
-var nunjucksPackage = require('dgeni-packages/nunjucks');
-var typescriptPackage = require('./typescript-package');
-var linksPackage = require('./links-package');
-var gitPackage = require('dgeni-packages/git');
-var path = require('path');
-var semver = require('semver');
-var fs = require('fs');
-var _ = require('lodash');
-var config = require('../config.json');
-var projectPackage = require('../../package.json');
-
-// Define the dgeni package for generating the docs
-module.exports = function(currentVersion) {
-
-  return new Package('ionic-v2-docs',
-                     [jsdocPackage, nunjucksPackage, typescriptPackage,
-                      linksPackage, gitPackage])
-
-// .processor(require('./processors/latest-version'))
-.processor(require('./processors/jekyll'))
-.processor(require('./processors/remove-private-members'))
-.processor(require('./processors/hide-private-api'))
-.processor(require('./processors/collect-inputs-outputs'))
-
-// for debugging docs
-// .processor(function test(){
-//   return {
-//
-//     $runBefore: ['rendering-docs'],
-//     $process: function(docs){
-//       docs.forEach(function(doc){
-//         if (doc.name == "Camera"){
-//
-//           // console.log(doc.tags);
-//           // doc.tags.forEach(function(tag){
-//           //   if(tag.tagName == 'classes'){
-//           //
-//           //   }
-//           // });
-//
-//           // doc.moduleDoc.exports.forEach(function(d,i){
-//           //   if(d.name === 'CameraOptions') {
-//           //     console.log('Name: ' + d.name);
-//           //     console.log('Type: ' + d.docType);
-//           //     console.log('First member: ', d.members[0]);
-//           //   }
-//           // });
-//
-//
-//           // var exports = doc.exportSymbol.parent.exports;
-//           // for(var p in exports) {
-//           //   if(p == 'CameraOptions')
-//           //   {
-//           //     var x = exports[p];
-//           //     console.log(x.members.quality);
-//           //   }
-//           // }
-//           // doc.members.forEach(function(method){
-//           //   if (method.name === "getPicture") {
-//           //     console.log(method);
-//           //   }
-//           // })
-//         }
-//       })
-//     }
-//   }
-// })
-
-.config(function(log) {
-  log.level = 'error'; //'silly', 'debug', 'info', 'warn', 'error'
-})
-
-.config(function(renderDocsProcessor, computePathsProcessor, versionInfo) {
-
-  versions = [];
-  // new version, add it to the versions list
-  if (currentVersion != 'nightly' && !_.includes(versions, currentVersion)) {
-    versions.unshift(currentVersion);
-  }
-  //First semver valid version is latest
-  var latestVersion = _.find(versions, semver.valid);
-  versions = versions.map(function(version) {
-    // We don't separate by versions so always put the docs in the root
-    var folder = '';
-    return {
-      href: '/' + config.v2DocsDir.replace('content/',''),
-      folder: folder,
-      name: version
-    };
-  });
-
-  var versionData = {
-    list: versions,
-    current: _.find(versions, {name: currentVersion}),
-    latest: _.find(versions, {name: latestVersion}) || _.first(versions)
-  };
-
-  renderDocsProcessor.extraData.version = versionData;
-  renderDocsProcessor.extraData.versionInfo = versionInfo;
-  computePathsProcessor.pathTemplates = [{
-    docTypes: ['class', 'var', 'function', 'let'],
-    getOutputPath: function(doc) {
-      var docPath = doc.name + '/index.md';
-      var path = 'content/' + config.v2DocsDir + '/' +  docPath;
-
-      return path;
-    }
-  }];
-})
-
-//configure file reading
-.config(function(readFilesProcessor, readTypeScriptModules) {
-
-  // Don't run unwanted processors since we are not using the normal file reading processor
-  readFilesProcessor.$enabled = false;
-  readFilesProcessor.basePath = path.resolve(__dirname, '../..');
-
-  readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname,
-                                                '../..'));
-  readTypeScriptModules.sourceFiles = [
-    'src/index.ts'
-  ];
-})
-
-.config(function(parseTagsProcessor) {
-  parseTagsProcessor.tagDefinitions = parseTagsProcessor.tagDefinitions
-                                        .concat(require('./tag-defs/tag-defs'));
-})
-
-// .config(function(parseTagsProcessor) {
-//   // We actually don't want to parse param docs in this package as we are
-//   // getting the data out using TS
-//   parseTagsProcessor.tagDefinitions.forEach(function(tagDef) {
-//     console.log(tagDef);
-//     if (tagDef.name === 'param') {
-//       tagDef.docProperty = 'paramData';
-//       tagDef.transforms = [];
-//     }
-//   });
-// })
-
-// Configure links
-.config(function(getLinkInfo) {
-  getLinkInfo.useFirstAmbiguousLink = false;
-})
-
-// Configure file writing
-.config(function(writeFilesProcessor) {
-  writeFilesProcessor.outputFolder  = config.sitePath;
-})
-
-// Configure rendering
-.config(function(templateFinder, templateEngine) {
-
-  // Nunjucks and Angular conflict in their template bindings so change the Nunjucks
-  // Also conflict with Jekyll
-  templateEngine.config.tags = {
-    variableStart: '<$',
-    variableEnd: '$>',
-    blockStart: '<@',
-    blockEnd: '@>',
-    commentStart: '<#',
-    commentEnd: '#>'
-  };
-
-  // add custom filters to nunjucks
-  templateEngine.filters.push(
-    require('./filters/capital'),
-    require('./filters/code'),
-    require('./filters/dump')
-  );
-
-  templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates'));
-
-  // Specify how to match docs to templates.
-  templateFinder.templatePatterns = [
-    '${ doc.template }',
-    '${ doc.docType }.template.html',
-    'common.template.html'
-  ];
-});
-
-};

scripts/docs/dgeni/configs/links.js

@@ -0,0 +1,3 @@
+module.exports = function (getLinkInfo) {
+  getLinkInfo.useFirstAmbiguousLink = false;
+};

scripts/docs/dgeni/configs/log.js

@@ -0,0 +1,3 @@
+module.exports = function (log) {
+  log.level = 'error'; //'silly', 'debug', 'info', 'warn', 'error'
+};

scripts/docs/dgeni/configs/tag-defs.js

@@ -0,0 +1,3 @@
+module.exports = function (parseTagsProcessor) {
+  parseTagsProcessor.tagDefinitions = parseTagsProcessor.tagDefinitions.concat(require('../tag-defs/tag-defs'));
+};

scripts/docs/dgeni/configs/template-filters.js

@@ -0,0 +1,12 @@
+module.exports = function (templateEngine) {
+  // Nunjucks and Angular conflict in their template bindings so change the Nunjucks
+  // Also conflict with Jekyll
+  templateEngine.config.tags = {
+    variableStart: '<$',
+    variableEnd: '$>',
+    blockStart: '<@',
+    blockEnd: '@>',
+    commentStart: '<#',
+    commentEnd: '#>',
+  };
+};

scripts/docs/dgeni/configs/template-tags.js

@@ -0,0 +1,9 @@
+module.exports = function (templateEngine) {
+  // add custom filters to nunjucks
+  templateEngine.filters.push(
+    require('../filters/capital'),
+    require('../filters/code'),
+    require('../filters/dump'),
+    require('../filters/dashify')
+  );
+};

scripts/docs/dgeni/dgeni-config.js

@@ -0,0 +1,75 @@
+'use strict';
+const Package = require('dgeni').Package,
+  jsdocPackage = require('dgeni-packages/jsdoc'),
+  nunjucksPackage = require('dgeni-packages/nunjucks'),
+  typescriptPackage = require('dgeni-packages/typescript'),
+  linksPackage = require('dgeni-packages/links'),
+  path = require('path'),
+  config = require('../config.json');
+
+module.exports = currentVersion => {
+  return (
+    new Package('ionic-native-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage])
+
+      .processor(require('./processors/remove-private-members'))
+      .processor(require('./processors/hide-private-api'))
+      .processor(require('./processors/parse-optional'))
+      .processor(require('./processors/mark-properties'))
+      .processor(require('./processors/npm-id'))
+      .processor(require('./processors/jekyll'))
+
+      .config(require('./configs/log'))
+      .config(require('./configs/template-filters'))
+      .config(require('./configs/template-tags'))
+      .config(require('./configs/tag-defs'))
+      .config(require('./configs/links'))
+
+      .config(function (renderDocsProcessor, computePathsProcessor) {
+        currentVersion = {
+          href: '/' + config.v2DocsDir.replace('content/', ''),
+          folder: '',
+          name: currentVersion,
+        };
+
+        renderDocsProcessor.extraData.version = {
+          list: [currentVersion],
+          current: currentVersion,
+          latest: currentVersion,
+        };
+
+        computePathsProcessor.pathTemplates = [
+          {
+            docTypes: ['class'],
+            getOutputPath: doc => 'content/' + config.v2DocsDir + '/' + doc.name + '/index.md',
+          },
+        ];
+      })
+
+      //configure file reading
+      .config(function (readFilesProcessor, readTypeScriptModules) {
+        // Don't run unwanted processors since we are not using the normal file reading processor
+        readFilesProcessor.$enabled = false;
+        readFilesProcessor.basePath = path.resolve(__dirname, '../../..');
+
+        readTypeScriptModules.basePath = path.resolve(__dirname, '../../..');
+        readTypeScriptModules.sourceFiles = ['./src/@ionic-native/plugins/**/*.ts'];
+      })
+
+      // Configure file writing
+      .config(function (writeFilesProcessor) {
+        writeFilesProcessor.outputFolder = '../ionic-site/';
+      })
+
+      // Configure rendering
+      .config(function (templateFinder) {
+        templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates'));
+
+        // Specify how to match docs to templates.
+        templateFinder.templatePatterns = [
+          '${ doc.template }',
+          '${ doc.docType }.template.html',
+          'common.template.html',
+        ];
+      })
+  );
+};

scripts/docs/dgeni/dgeni-readmes-config.js

@@ -0,0 +1,70 @@
+'use strict';
+const Package = require('dgeni').Package,
+  jsdocPackage = require('dgeni-packages/jsdoc'),
+  nunjucksPackage = require('dgeni-packages/nunjucks'),
+  typescriptPackage = require('dgeni-packages/typescript'),
+  linksPackage = require('dgeni-packages/links'),
+  path = require('path'),
+  config = require('../config.json');
+
+module.exports = currentVersion => {
+  return (
+    new Package('ionic-native-readmes', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage])
+
+      .processor(require('./processors/readmes'))
+      .processor(require('./processors/remove-private-members'))
+      .processor(require('./processors/hide-private-api'))
+      .processor(require('./processors/npm-id'))
+
+      .config(require('./configs/log'))
+      .config(require('./configs/template-filters'))
+      .config(require('./configs/template-tags'))
+      .config(require('./configs/tag-defs'))
+      .config(require('./configs/links'))
+
+      .config(function (renderDocsProcessor, computePathsProcessor) {
+        currentVersion = {
+          href: '/' + config.v2DocsDir.replace('content/', ''),
+          folder: '',
+          name: currentVersion,
+        };
+
+        renderDocsProcessor.extraData.version = {
+          list: [currentVersion],
+          current: currentVersion,
+          latest: currentVersion,
+        };
+
+        computePathsProcessor.pathTemplates = [
+          {
+            docTypes: ['class'],
+            getOutputPath: doc =>
+              doc.originalModule.replace(config.pluginDir + '/', '').replace(/\/index$/, '/README.md'),
+          },
+        ];
+      })
+
+      //configure file reading
+      .config(function (readFilesProcessor, readTypeScriptModules) {
+        // Don't run unwanted processors since we are not using the normal file reading processor
+        readFilesProcessor.$enabled = false;
+        readFilesProcessor.basePath = path.resolve(__dirname, '../../..');
+
+        readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname, '../../..'));
+        readTypeScriptModules.sourceFiles = ['./src/@ionic-native/plugins/**/*.ts'];
+      })
+
+      // Configure file writing
+      .config(function (writeFilesProcessor) {
+        writeFilesProcessor.outputFolder = './dist/@ionic-native/';
+      })
+
+      // Configure rendering
+      .config(function (templateFinder) {
+        templateFinder.templateFolders.unshift(path.resolve(__dirname, 'templates'));
+
+        // Specify how to match docs to templates.
+        templateFinder.templatePatterns = ['${ doc.template }', '${ doc.docType }.template.md', 'readme.template.md'];
+      })
+  );
+};

scripts/docs/dgeni/filters/capital.js

@@ -0,0 +1,5 @@
+'use strict';
+module.exports = {
+  name: 'capital',
+  process: str => (str ? str.charAt(0).toUpperCase() + str.substring(1) : ''),
+};

scripts/docs/dgeni/filters/code.js

@@ -1,4 +1,5 @@
-var encoder = new require('node-html-encoder').Encoder();
+'use strict';
+const encoder = new require('node-html-encoder').Encoder();
 
 function code(str, inline, lang) {
   // Encode any HTML entities in the code string
@@ -10,16 +11,14 @@ function code(str, inline, lang) {
   str = '<code' + lang + '>' + str + '</code>';
 
   // If not inline then wrap the code element in a pre element
-  if ( !inline ) {
+  if (!inline) {
     str = '<pre>' + str + '</pre>';
   }
 
   return str;
-};
+}
 
 module.exports = {
   name: 'code',
-  process: function(str, lang) {
-    return code(str, true, lang);
-  }
+  process: (str, lang) => code(str, true, lang),
 };

scripts/docs/dgeni/filters/dashify.js

@@ -0,0 +1,5 @@
+'use strict';
+module.exports = {
+  name: 'dashify',
+  process: str => (str ? str.replace(/\s/g, '-') : ''),
+};

scripts/docs/dgeni/filters/dump.js

@@ -0,0 +1,5 @@
+'use strict';
+module.exports = {
+  name: 'dump',
+  process: obj => console.log(obj),
+};

scripts/docs/dgeni/processors/debug.js

@@ -0,0 +1,39 @@
+'use strict';
+module.exports = function test() {
+  return {
+    name: 'debug',
+    $runBefore: ['rendering-docs'],
+    $process: function (docs) {
+      docs.forEach(function (doc) {
+        if (doc.name == 'Camera') {
+          console.log(doc.tags);
+          doc.tags.forEach(function (tag) {
+            if (tag.tagName == 'classes') {
+            }
+          });
+
+          doc.moduleDoc.exports.forEach(function (d, i) {
+            if (d.name === 'CameraOptions') {
+              console.log('Name: ' + d.name);
+              console.log('Type: ' + d.docType);
+              console.log('First member: ', d.members[0]);
+            }
+          });
+
+          var exports = doc.exportSymbol.parent.exports;
+          for (var p in exports) {
+            if (p == 'CameraOptions') {
+              var x = exports[p];
+              console.log(x.members.quality);
+            }
+          }
+          doc.members.forEach(function (method) {
+            if (method.name === 'getPicture') {
+              console.log(method);
+            }
+          });
+        }
+      });
+    },
+  };
+};

scripts/docs/dgeni/processors/hide-private-api.js

@@ -0,0 +1,9 @@
+'use strict';
+module.exports = function removePrivateApi() {
+  return {
+    name: 'remove-private-api',
+    description: 'Prevent the private apis from being rendered',
+    $runBefore: ['rendering-docs'],
+    $process: docs => docs.filter(doc => !doc.private && (!doc.tags || !doc.tags.tagsByName.get('hidden'))),
+  };
+};

scripts/docs/dgeni/processors/jekyll.js

@@ -0,0 +1,63 @@
+'use strict';
+module.exports = function jekyll(renderDocsProcessor) {
+  return {
+    name: 'jekyll',
+    description: 'Create jekyll includes',
+    $runAfter: ['paths-computed'],
+    $runBefore: ['rendering-docs'],
+    $process: docs => {
+      // pretty up and sort the docs object for menu generation
+      docs = docs.filter(doc => (!!doc.name && !!doc.outputPath) || doc.docType === 'index-page');
+
+      docs.push({
+        docType: 'class',
+        URL: 'https://github.com/ionic-team/ionic-native-google-maps/blob/master/documents/README.md',
+        name: 'Google Maps',
+      });
+
+      docs.sort((a, b) => {
+        const textA = a.name ? a.name.toUpperCase() : '',
+          textB = b.name ? b.name.toUpperCase() : '';
+
+        return textA < textB ? -1 : textA > textB ? 1 : 0;
+      });
+
+      docs.forEach(doc => {
+        if (!doc.outputPath) {
+          return;
+        }
+
+        doc.outputPath = doc.outputPath.toLowerCase().replace(/\s/g, '-');
+        doc.URL = doc.outputPath.replace('docs//', 'docs/').replace('/index.md', '').replace('content/', '');
+        // add trailing slash to plugin pages
+        if (!doc.URL.endsWith('/') && !doc.URL.endsWith('.html')) {
+          doc.URL = doc.URL + '/';
+        }
+
+        doc.URL = '/' + doc.URL;
+      });
+
+      const betaDocs = [];
+
+      docs = docs.filter(doc => {
+        if (doc.beta === true) {
+          betaDocs.push(doc);
+          return false;
+        }
+        return true;
+      });
+
+      docs = docs.concat(betaDocs);
+
+      // add side menu
+      docs.push({
+        docType: 'nativeMenu',
+        id: 'native_menu',
+        template: 'native_menu.template.html',
+        outputPath: 'content/_includes/fluid/native_menu.html',
+      });
+
+      return docs;
+    },
+  };
+};

scripts/docs/dgeni/processors/mark-properties.js

@@ -0,0 +1,16 @@
+'use strict';
+module.exports = function markProperties() {
+  return {
+    name: 'mark-properties',
+    $runBefore: ['rendering-docs'],
+    $process: docs =>
+      docs.map(doc => {
+        for (let i in doc.members) {
+          if (doc.members.hasOwnProperty(i) && typeof doc.members[i].parameters === 'undefined') {
+            doc.members[i].isProperty = true;
+          }
+        }
+        return doc;
+      }),
+  };
+};

scripts/docs/dgeni/processors/npm-id.js

@@ -0,0 +1,20 @@
+'use strict';
+module.exports = function npmId(renderDocsProcessor) {
+  return {
+    name: 'npm-id',
+    $runAfter: ['paths-computed'],
+    $runBefore: ['rendering-docs'],
+    $process: docs => {
+      // pretty up and sort the docs object for menu generation
+      docs = docs.filter(function (doc) {
+        return (!!doc.name && !!doc.outputPath) || doc.docType === 'index-page';
+      });
+
+      docs.forEach(doc => {
+        doc.npmId = doc.id.match(/plugins\/(.*)\/index/)[1];
+      });
+
+      return docs;
+    },
+  };
+};

scripts/docs/dgeni/processors/parse-optional.js

@@ -0,0 +1,22 @@
+'use strict';
+module.exports = function parseOptional() {
+  return {
+    $runBefore: ['rendering-docs'],
+    $process: docs => {
+      docs.forEach(doc => {
+        if (doc.members && doc.members.length) {
+          for (let i in doc.members) {
+            if (doc.members[i].params && doc.members[i].params.length) {
+              for (let ii in doc.members[i].params) {
+                if (doc.members[i].params[ii].optional) {
+                  doc.members[i].params[ii].description += '<strong class="tag">Optional</strong>';
+                }
+              }
+            }
+          }
+        }
+      });
+      return docs;
+    },
+  };
+};

scripts/docs/dgeni/processors/readmes.js

@@ -0,0 +1,19 @@
+'use strict';
+module.exports = function readmes(renderDocsProcessor) {
+  return {
+    name: 'readmes',
+    description: 'Create jekyll includes',
+    $runAfter: ['paths-computed'],
+    $runBefore: ['rendering-docs'],
+    $process: docs => {
+      // pretty up and sort the docs object for menu generation
+      docs = docs.filter(doc => (!!doc.name && !!doc.outputPath) || doc.docType === 'index-page');
+
+      docs.forEach(doc => {
+        doc.outputPath = doc.outputPath.replace('src/@ionic-native/', '');
+      });
+
+      return docs;
+    },
+  };
+};

scripts/docs/dgeni/processors/remove-private-members.js

@@ -0,0 +1,22 @@
+'use strict';
+module.exports = function removePrivateMembers() {
+  return {
+    name: 'remove-private-members',
+    description: 'Remove member docs with @private tags',
+    $runAfter: ['tags-parsed'],
+    $runBefore: ['rendering-docs'],
+    $process: docs => {
+      docs.forEach(doc => {
+        if (doc.members) {
+          doc.members = doc.members.filter(member => !member.tags.tagsByName.get('hidden'));
+        }
+
+        if (doc.statics) {
+          doc.statics = doc.statics.filter(staticMethod => !staticMethod.tags.tagsByName.get('hidden'));
+        }
+      });
+
+      return docs;
+    },
+  };
+};

scripts/docs/dgeni/tag-defs/tag-defs.js

@@ -0,0 +1,11 @@
+'use strict';
+module.exports = [
+  { name: 'advanced' },
+  { name: 'demo' },
+  { name: 'beta', transforms: (doc, tag, value) => typeof value !== 'undefined' }, // make the value true or undefined instead of '' or undefined
+  { name: 'usage' },
+  { name: 'hidden' }, // hide from docs
+  { name: 'classes' }, // related classes
+  { name: 'interfaces' }, // related interfaces
+  { name: 'paid', transforms: (doc, tag, value) => typeof value !== 'undefined' }, // paid plugin, set value to true
+];

scripts/docs/dgeni/templates/common.template.html

@@ -0,0 +1,208 @@
+---
+layout: "fluid/docs_base"
+version: "<$ version.current.name $>"
+versionHref: "<$ version.current.href.replace('content/','') $>"
+path: "<$ doc.path $>"
+category: native
+id: "<$ doc.name|lower|replace(' ','-') $>"
+title: "<@ if doc.docType == "directive" @><$ doc.name | dashCase $><@ else @><$ doc.name $><@ endif @>"
+header_sub_title: "<$ doc.docType | capital $> in module <$ doc.module $>"
+doc: "<$ doc.name $>"
+docType: "<$ doc.docType $>"
+---
+
+<@- macro interfaceTable(interface) -@> <@ for export in doc.moduleDoc.exports -@> <@ if export.name == interface @>
+<table class="table param-table" style="margin: 0;">
+  <thead>
+    <tr>
+      <th>Param</th>
+      <th>Type</th>
+      <th>Details</th>
+    </tr>
+  </thead>
+  <tbody>
+    <@ for param in export.members @>
+    <tr>
+      <td>
+        <$ param.name $>
+      </td>
+      <td>
+        <code><$ param.returnType | escape $></code>
+      </td>
+      <td>
+        <$ param.description | marked $> <@ if param.optional @><em>(optional)</em><@ endif @>
+      </td>
+    </tr>
+    <@ endfor @>
+  </tbody>
+</table>
+<@ endif @> <@- endfor @> <@- endmacro -@> <@- macro githubViewLink(doc) -@>
+<a
+  href="https://github.com/ionic-team/ionic-native/tree/master/<$ doc.fileInfo.relativePath $>#L<$ doc.location.start.line+1 $>-L<$ doc.location.end.line+1 $>"
+  ><$ doc.fileInfo.relativePath $> (line <$ doc.location.start.line+1 $>)</a
+>
+<@- endmacro -@> <@- macro paramTable(params, isDirective) -@>
+<table class="table param-table" style="margin: 0;">
+  <thead>
+    <tr>
+      <th><@ if isDirective @>Attr<@ else @>Param<@ endif @></th>
+      <th>Type</th>
+      <th>Details</th>
+    </tr>
+  </thead>
+  <tbody>
+    <@- for param in params @>
+    <tr>
+      <td>
+        <$ param.name $> <@- if param.alias @>| <$ param.alias $><@ endif -@>
+      </td>
+      <td>
+        <$ typeList(param.typeList) $>
+      </td>
+      <td>
+        <$ param.description | marked $> <@- if param.defaultValue @>
+        <p><em>(default: <$ param.defaultValue $>)</em></p>
+        <@ endif -@>
+      </td>
+    </tr>
+    <@ endfor -@>
+  </tbody>
+</table>
+<@- endmacro -@> <@- macro functionSyntax(fn) @> <@- set sep = joiner(',&nbsp;') -@>
+<code
+  ><$ fn.name $><@- if not fn.isProperty @>(<@ endif -@><@- for param in fn.params @><$ sep() $> <@- if
+  param.type.optional @>[<@- endif -@> <$ param.name $> <@- if param.type.optional -@>]<@- endif -@> <@- endfor -@><@-
+  if not fn.isProperty @>)<@- endif -@></code
+>
+<@- endmacro -@> <@- macro typeList(types) -@> <@ set separator = joiner("|") @> <@- for type in types @><$ separator()
+$><$ type | code $><@ endfor -@> <@- endmacro -@> <@- macro typeInfo(fn) -@> <$ typeList(fn.typeList) $> <$
+fn.description $> <@- endmacro -@> <@- macro documentPlatforms(method) -@> <@- if method.decorators @> <@ for prop in
+method.decorators[0].argumentInfo @> <@ if prop.platforms @>
+<p>
+  <strong>Platforms:</strong>
+  <@- for platform in prop.platforms -@>
+  <strong class="tag"><$ platform $></strong>&nbsp; <@- endfor -@>
+</p>
+<@ endif @> <@ endfor @> <@- endif @> <@- endmacro -@> <@ macro documentMethod(method) -@>
+<h3><a class="anchor" name="<$ method.name $>" href="#<$ method.name $>"></a><$ functionSyntax(method) $></h3>
+<$ documentPlatforms(method) $> <$ method.description $> <@ if method.params -@> <$ paramTable(method.params) $> <@-
+endif @> <@ if method.returns -@>
+<div class="return-value" markdown="1">
+  <i class="icon ion-arrow-return-left"></i>
+  <b>Returns:</b> <$ typeInfo(method.returns) $>
+</div>
+<@- endif @> <@- endmacro -@> <@- macro documentClass(doc) @> <@- if doc.statics.length -@>
+<h2><a class="anchor" name="static-members" href="#static-members"></a>Static Members</h2>
+<@ for method in doc.statics -@> <$ documentMethod(method) $> <@ endfor -@> <@ endif @> <# --- methods in class --- #>
+<@- if doc.members and doc.members.length @>
+
+<h2><a class="anchor" name="instance-members" href="#instance-members"></a>Instance Members</h2>
+<@ for method in doc.members -@> <$ documentMethod(method) $> <@- endfor @> <@- endif -@> <@ endmacro @>
+
+<h1 class="api-title">
+  <$ doc.name $> <@- if doc.beta == true -@>
+  <span class="beta" title="beta">&beta;</span>
+  <@- endif -@> <@- if doc.paid == true -@>
+  <span class="paid" title="paid">Paid</span>
+  <@- endif -@>
+</h1>
+
+<a
+  class="improve-v2-docs"
+  href="http://github.com/ionic-team/ionic-native/edit/master/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/') $>#L<$ doc.location.start.line $>"
+>
+  Improve this doc
+</a>
+
+<# --- Decorators --- #> <@- if doc.decorators @> <@ for prop in doc.decorators[0].argumentInfo @> <@ if doc.beta ==
+true @>
+<p class="beta-notice">
+  This plugin is still in beta stage and may not work as expected. Please submit any issues to the
+  <a target="_blank" href="<$ prop.repo $>/issues">plugin repo</a>.
+</p>
+<@ endif @> <@ if doc.paid == true @>
+<p class="paid-notice">
+  This plugin might require a paid license, or might take a share of your app's earnings. Check the
+  <a target="_blank" rel="nofollow" href="<$ prop.repo $>">plugin's repo</a> for more information.
+</p>
+<@ endif @> <# --- Plugin description --- #> <$ doc.description | marked $>
+
+<p>
+  Repo:
+  <a href="<$ prop.repo $>">
+    <$ prop.repo $>
+  </a>
+</p>
+
+<# --- Install commands --- #>
+<h2><a class="anchor" name="installation" href="#installation"></a>Installation</h2>
+<ol class="installation">
+  <li>
+    Install the Cordova and Ionic Native plugins:<br />
+    <pre><code class="nohighlight">$ <@ if prop.install @><$ prop.install | replace('<', '&lt;').replace('>', '&gt;') $><@ else @>ionic cordova plugin add <$ prop.plugin $><@ endif @>
+$ npm install @ionic-native/<$ doc.npmId $>
+</code></pre>
+  </li>
+  <li>
+    <a href="https://ionicframework.com/docs/native/#Add_Plugins_to_Your_App_Module"
+      >Add this plugin to your app's module</a
+    >
+  </li>
+</ol>
+
+<# --- Plugin supported platforms --- #> <@ if prop.platforms @>
+<h2><a class="anchor" name="platforms" href="#platforms"></a>Supported platforms</h2>
+<ul>
+  <@ for platform in prop.platforms -@>
+  <li><$ platform $></li>
+  <@- endfor @>
+</ul>
+<@ endif @> <@ endfor @> <@ endif -@> <# --- end of: if doc.decorators --- #> <# --- Plugin usage --- #> <@ if doc.usage
+@>
+<h2><a class="anchor" name="usage" href="#usage"></a>Usage</h2>
+<$ doc.usage | marked $> <@ endif @> <# --- Plugin attributes --- #> <@- if doc.properties -@>
+<h2><a class="anchor" name="attributes" href="#attributes"></a>Attributes:</h2>
+<table class="table" style="margin: 0;">
+  <thead>
+    <tr>
+      <th>Attribute</th>
+      <@ set hasTypes = false @> <@ for prop in doc.properties @> <@ if prop.type @> <@ set hasTypes = true @> <@ endif
+      @> <@ endfor @> <@ if hasTypes @>
+      <th>Type</th>
+      <@ endif @>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <@- for prop in doc.properties -@>
+    <tr>
+      <td>
+        <$ prop.name $>
+      </td>
+      <@ if hasTypes @>
+      <td>
+        <$ prop.type.name $>
+      </td>
+      <@ endif @>
+      <td>
+        <$ prop.description $>
+      </td>
+    </tr>
+    <@ endfor -@>
+  </tbody>
+</table>
+<@- endif -@> <# --- Plugin class documentation --- #> <$ documentClass(doc) $> <# --- Advanced usage --- #> <@- if
+doc.advanced -@>
+<h2><a class="anchor" name="advanced" href="#advanced"></a>Advanced</h2>
+<$ doc.advanced | marked $> <@- endif -@> <# --- Other classes --- #> <@- for tag in doc.tags.tags -@> <@- if
+tag.tagName == 'classes' -@> <@- set classes = tag.description.split('\n') -@> <@- for item in classes -@> <@- if
+item.length > 1 -@> <@- for export in doc.moduleDoc.exports -@> <@- if export.name == item -@>
+<h2><a class="anchor" name="<$ item $>" href="#<$ item $>"></a><$ item $></h2>
+<$ documentClass(export) $> <@- endif -@> <@- endfor -@> <@- endif -@> <@- endfor -@> <@- endif -@> <@- endfor -@> <#
+--- Other interfaces --- #> <@ for tag in doc.tags.tags -@> <@ if tag.tagName == 'interfaces' @> <@ set interfaces =
+tag.description.split('\n') @> <@ for item in interfaces -@> <@ if item.length > 1 @>
+<h2><a class="anchor" name="<$ item $>" href="#<$ item $>"></a><$ item $></h2>
+<$ interfaceTable(item) $> <@ endif @> <@- endfor @> <@ endif @> <@- endfor @> <# --- Related links --- #> <@- if
+doc.see @>
+<h2><a class="anchor" name="related" href="#related"></a>Related</h2>
+<@ for s in doc.see @> <$ s | safe $> <@- endfor -@> <@- endif -@>

scripts/docs/dgeni/templates/native_menu.template.html

@@ -0,0 +1,14 @@
+<li class="capitalize {% if page.id == 'overview' %}active{% endif %}">
+  <a href="/docs/native/">Overview</a>
+</li>
+<li class="capitalize {% if page.id == 'mocking' %}active{% endif %}">
+  <a href="/docs/native/browser.html">Browser Usage</a>
+</li>
+<@- for doc in docs @><@ if doc.URL and doc.private != true @>
+<li class="capitalize {% if page.id == '<$ doc.name|lower|dashify $>' %}active{% endif %}">
+  <a href="<$ doc.URL $>"
+    ><$ doc.name $><@ if doc.paid == true @> <span class="paid">Paid</span><@ endif @><@ if doc.beta == true @>
+    <span class="beta">&beta;</span><@ endif @></a
+  >
+</li>
+<@ endif @><@ endfor @>

scripts/docs/dgeni/templates/readme.template.md

@@ -0,0 +1,40 @@
+<a style="float:right;font-size:12px;" href="http://github.com/ionic-team/ionic-native/edit/master/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/') $>#L<$ doc.location.start.line $>">
+  Improve this doc
+</a>
+
+# <$ doc.name $>
+
+<@- if doc.beta == true @>
+
+  <p style="color:orange">
+    This plugin is still in beta stage and may not work as expected. Please
+    submit any issues to the <a target="_blank"
+    href="<$ prop.repo $>/issues">plugin repo</a>.
+  </p>
+<@ endif -@>
+
+<@ for prop in doc.decorators[0].argumentInfo @>
+
+```
+$ <@ if prop.install @><$ prop.install $><@ else @>ionic cordova plugin add <$ prop.plugin $><@ endif @>
+$ npm install @ionic-native/<$ doc.npmId $>
+```
+
+## [Usage Documentation](https://ionicframework.com/docs/native/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/')|replace('index.ts','')|replace('src/@ionic-native/plugins/','') $>)
+
+Plugin Repo: [<$ prop.repo $>](<$ prop.repo $>)
+
+<$ doc.description $>
+
+<@- if prop.platforms @>
+
+## Supported platforms
+
+<@ for platform in prop.platforms -@>
+
+- <$ platform $>
+  <@ endfor @>
+
+<@ endif -@>
+
+<@ endfor @>

scripts/docs/filters/capital.js

@@ -1,7 +0,0 @@
-module.exports = {
-  name: 'capital',
-  process: function(str) {
-    str || (str = '');
-    return str.charAt(0).toUpperCase() + str.substring(1);
-  }
-};

scripts/docs/filters/dump.js

@@ -1,6 +0,0 @@
-module.exports = {
-  name: 'dump',
-  process: function(obj) {
-    console.log(obj);
-  }
-};

scripts/docs/gulp-tasks.js

@@ -1,15 +1,34 @@
-var config = require('../config.json');
-var projectPackage = require('../../package.json');
-module.exports = function(gulp) {
-  gulp.task('docs', [], function() {
-    var Dgeni = require('dgeni');
-    var semver = require('semver');
+'use strict';
+const config = require('./config.json'),
+  projectPackage = require('../../package.json'),
+  path = require('path'),
+  fs = require('fs-extra'),
+  Dgeni = require('dgeni');
+
+module.exports = gulp => {
+  gulp.task('docs', () => {
     try {
-      var ionicPackage = require('./dgeni-config')(projectPackage.version);
-      var dgeni = new Dgeni([ionicPackage]);
-      return dgeni.generate();
+      const ionicPackage = require('./dgeni/dgeni-config')(projectPackage.version),
+        dgeni = new Dgeni([ionicPackage]);
+
+      return dgeni.generate().then(docs => console.log(docs.length + ' docs generated'));
     } catch (err) {
       console.log(err.stack);
     }
   });
-}
+
+  gulp.task('readmes', () => {
+    fs.copySync(
+      path.resolve(__dirname, '..', '..', 'README.md'),
+      path.resolve(__dirname, '..', '..', config.pluginDir, 'core', 'README.md')
+    );
+
+    try {
+      const ionicPackage = require('./dgeni/dgeni-readmes-config')(projectPackage.version),
+        dgeni = new Dgeni([ionicPackage]);
+      return dgeni.generate().then(docs => console.log(docs.length + ' README files generated'));
+    } catch (err) {
+      console.log(err.stack);
+    }
+  });
+};

scripts/docs/links-package/index.js

@@ -1,12 +0,0 @@
-var Package = require('dgeni').Package;
-
-module.exports = new Package('links', [])
-
-.factory(require('./inline-tag-defs/link'))
-.factory(require('dgeni-packages/ngdoc/services/getAliases'))
-.factory(require('dgeni-packages/ngdoc/services/getDocFromAlias'))
-.factory(require('./services/getLinkInfo'))
-
-.config(function(inlineTagProcessor, linkInlineTagDef) {
-  inlineTagProcessor.inlineTagDefinitions.push(linkInlineTagDef);
-});

scripts/docs/links-package/inline-tag-defs/link.js

@@ -1,33 +0,0 @@
-var INLINE_LINK = /(\S+)(?:\s+([\s\S]+))?/;
-
-/**
- * @dgService linkInlineTagDef
- * @description
- * Process inline link tags (of the form {@link some/uri Some Title}), replacing them with HTML anchors
- * @kind function
- * @param  {Object} url   The url to match
- * @param  {Function} docs error message
- * @return {String}  The html link information
- *
- * @property {boolean} relativeLinks Whether we expect the links to be relative to the originating doc
- */
-module.exports = function linkInlineTagDef(getLinkInfo, createDocMessage, log) {
-  return {
-    name: 'link',
-    description: 'Process inline link tags (of the form {@link some/uri Some Title}), replacing them with HTML anchors',
-    handler: function(doc, tagName, tagDescription) {
-
-      // Parse out the uri and title
-      return tagDescription.replace(INLINE_LINK, function(match, uri, title) {
-
-        var linkInfo = getLinkInfo(uri, title, doc);
-
-        if ( !linkInfo.valid ) {
-          log.warn(createDocMessage(linkInfo.error, doc));
-        }
-
-        return "<a href='" + linkInfo.url + "'>" + linkInfo.title + "</a>";
-      });
-    }
-  };
-};

scripts/docs/links-package/services/getLinkInfo.js

@@ -1,72 +0,0 @@
-var _ = require('lodash');
-var path = require('canonical-path');
-
-/**
- * @dgService getLinkInfo
- * @description
- * Get link information to a document that matches the given url
- * @kind function
- * @param  {String} url   The url to match
- * @param  {String} title An optional title to return in the link information
- * @return {Object}       The link information
- *
- * @property {boolean} relativeLinks Whether we expect the links to be relative to the originating doc
- */
-module.exports = function getLinkInfo(getDocFromAlias, encodeCodeBlock, log) {
-
-  return function getLinkInfoImpl(url, title, currentDoc) {
-    var linkInfo = {
-      url: url,
-      type: 'url',
-      valid: true,
-      title: title || url
-    };
-
-    if ( !url ) {
-      throw new Error('Invalid url');
-    }
-
-    var docs = getDocFromAlias(url, currentDoc);
-
-    if ( !getLinkInfoImpl.useFirstAmbiguousLink && docs.length > 1 ) {
-
-      linkInfo.valid = false;
-      linkInfo.errorType = 'ambiguous';
-      linkInfo.error = 'Ambiguous link: "' + url + '".\n' +
-        docs.reduce(function(msg, doc) { return msg + '\n  "' + doc.id + '" ('+ doc.docType + ') : (' + doc.path + ' / ' + doc.fileInfo.relativePath + ')'; }, 'Matching docs: ');
-
-    } else if ( docs.length >= 1 ) {
-
-      linkInfo.url = docs[0].path;
-      linkInfo.title = title || encodeCodeBlock(docs[0].name, true);
-      linkInfo.type = 'doc';
-
-      if ( getLinkInfoImpl.relativeLinks && currentDoc && currentDoc.path ) {
-        var currentFolder = path.dirname(currentDoc.path);
-        var docFolder = path.dirname(linkInfo.url);
-        var relativeFolder = path.relative(path.join('/', currentFolder), path.join('/', docFolder));
-        linkInfo.url = path.join(relativeFolder, path.basename(linkInfo.url));
-        log.debug(currentDoc.path, docs[0].path, linkInfo.url);
-      }
-
-    } else if ( url.indexOf('#') > 0 ) {
-      var pathAndHash = url.split('#');
-      linkInfo = getLinkInfoImpl(pathAndHash[0], title, currentDoc);
-      linkInfo.url = linkInfo.url + '#' + pathAndHash[1];
-      return linkInfo;
-
-    } else if ( url.indexOf('/') === -1 && url.indexOf('#') !== 0 ) {
-
-      linkInfo.valid = false;
-      linkInfo.errorType = 'missing';
-      linkInfo.error = 'Invalid link (does not match any doc): "' + url + '"';
-
-    } else {
-
-      linkInfo.title = title || (( url.indexOf('#') === 0 ) ? url.substring(1) : path.basename(url, '.html'));
-
-    }
-
-    return linkInfo;
-  };
-};

scripts/docs/prepare.sh

@@ -30,8 +30,8 @@ function run {
     git pull origin master
   fi
 
-  git rm -rf content/docs/v2/native/*/ || true
+  git rm -rf content/docs/native/*/ || true
 
 }
 
-source $(dirname $0)/../utils.inc.sh
+source $(dirname $0)/utils.inc.sh

scripts/docs/processors/collect-inputs-outputs.js

@@ -1,71 +0,0 @@
-module.exports = function collectInputsOutputs() {
-  return {
-
-    $runBefore: ['rendering-docs'],
-    $process: function(docs) {
-      docs.forEach(function(doc) {
-
-        if (doc.statics && doc.statics.length) {
-          for (var i in doc.statics) {
-            // identify properties to differentiate from methods
-            if (typeof doc.statics[i].parameters == 'undefined') {
-              doc.statics[i].isProperty = true;
-            }
-          }
-        }
-
-        if (doc.members && doc.members.length) {
-          var members = [];
-          var inputs = [];
-          var outputs = [];
-
-          memberLoop:
-          for (var i in doc.members) {
-
-            // identify properties to differentiate from methods
-            if (typeof doc.members[i].parameters == 'undefined') {
-              doc.members[i].isProperty = true;
-            }
-
-            if (doc.members[i].decorators && doc.members[i].decorators.length) {
-
-              decoratorLoop:
-              for (var ii in doc.members[i].decorators) {
-
-                if (doc.members[i].decorators[ii].name == 'Input') {
-                  inputs.push(parseMember(doc.members[i]));
-                  continue memberLoop;
-                }
-                if (doc.members[i].decorators[ii].name == 'Output') {
-                  outputs.push(parseMember(doc.members[i]));
-                  continue memberLoop;
-                }
-              }
-              // not an input or output, must be a plain member
-              members.push(doc.members[i]);
-            } else {
-              members.push(doc.members[i]);
-            };
-          }
-
-          // update doc with pruned members list and add inputs and outputs
-          doc.members = members;
-          doc.inputs = inputs;
-          doc.outputs = outputs;
-        }
-
-        function parseMember(member) {
-          member.type = member.content.substring(
-            member.content.indexOf('{') + 1,
-            member.content.indexOf('}')
-          );
-          member.description = member.content.substring(
-            member.content.indexOf('}') + 1,
-            member.content.length
-          );
-          return member;
-        }
-      });
-    }
-  };
-};

scripts/docs/processors/hide-private-api.js

@@ -1,18 +0,0 @@
-module.exports = function removePrivateApi() {
-  return {
-    name: 'remove-private-api',
-    description: 'Prevent the private apis from being rendered',
-    $runBefore: ['rendering-docs'],
-    $process: function(docs) {
-      var publicDocs = [];
-       docs.forEach(function(doc){
-        if(!doc.private){
-          publicDocs.push(doc);
-          return doc
-        }
-      })
-     docs = publicDocs;
-     return docs;
-    }
-  }
-};

scripts/docs/processors/jekyll.js

@@ -1,39 +0,0 @@
-module.exports = function jekyll(renderDocsProcessor) {
-  return {
-    name: 'jekyll',
-    description: 'Create jekyll includes',
-    $runAfter: ['paths-computed'],
-    $runBefore: ['rendering-docs'],
-    $process: function(docs) {
-      var currentVersion = renderDocsProcessor.extraData.version.current.name;
-
-      // pretty up and sort the docs object for menu generation
-      docs = docs.filter(function(doc) {
-        return (!!doc.name && !!doc.outputPath) || doc.docType === 'index-page';
-      });
-      docs.sort(function(a, b) {
-        textA = a.name ? a.name.toUpperCase() : '';
-        textB = b.name ? b.name.toUpperCase() : '';
-        return (textA < textB) ? -1 : (textA > textB) ? 1 : 0;
-      });
-      docs.forEach(function(doc, i) {
-        doc.outputPath = doc.outputPath.toLowerCase().replace(' ', '-');
-        docs[i].URL = doc.outputPath.replace('docs/v2//', 'docs/v2/')
-                                    .replace('/index.md', '')
-                                    .replace('content/', '');
-
-        docs[i].demo = !!docs[i].demo;
-      });
-
-      docs.push({
-        docType: 'native_menu-menu',
-        id: 'native_menu-menu',
-        template: 'native_menu.template.html',
-        outputPath: 'content/_includes/v2_fluid/native_menu.html'
-      });
-
-      // returning docs will replace docs object in the next process
-      return docs;
-    }
-  };
-};

scripts/docs/processors/latest-version.js

@@ -1,33 +0,0 @@
-var copy = require('cpr').cpr;
-var mkdirp = require('mkdirp');
-var path = require('canonical-path');
-var q = require('q');
-var fs = require('fs');
-
-module.exports = function latestVersion(renderDocsProcessor) {
-  return {
-    name: 'latest-version',
-    $runAfter: ['files-written'],
-    description: 'Copy the latest version (that was compiled to docs/) into docs/versionName',
-    $process: function(docs) {
-      var versionData = renderDocsProcessor.extraData.version;
-
-      var docsBase = 'dist/ionic-site/content/docs/v2/';
-      var versionDir = path.resolve(docsBase, versionData.latest.name);
-      var latestDir = path.resolve(docsBase, 'api');
-
-      var deferred = q.defer();
-
-      mkdirp(versionDir, function() {
-        copy(latestDir, path.join(versionDir, 'api'), {
-          deleteFirst: true,
-          overwrite: true
-        }, function(err, files) {
-          deferred.resolve(docs);
-        });
-      });
-
-      return deferred.promise;
-    }
-  }
-};

scripts/docs/processors/remove-private-members.js

@@ -1,24 +0,0 @@
-module.exports = function removePrivateMembers() {
-  return {
-    name: 'remove-private-members',
-    description: 'Remove member docs with @private tags',
-    $runAfter: ['tags-parsed'],
-    $runBefore: ['rendering-docs'],
-    $process: function(docs) {
-      docs.forEach(function(doc) {
-        if (doc.members) {
-          doc.members = doc.members.filter(function(member) {
-            return !member.tags.tagsByName.get('private');
-          });
-        }
-        if (doc.statics) {
-          doc.statics = doc.statics.filter(function(staticMethod) {
-            return !staticMethod.tags.tagsByName.get('private');
-          });
-        }
-      });
-
-      return docs;
-    }
-  };
-};

scripts/docs/tag-defs/tag-defs.js

@@ -1,11 +0,0 @@
-module.exports = [
-  {'name': 'advanced'},
-  {'name': 'demo'},
-  {'name': 'beta', transforms: function(doc, tag, value) {
-    // make the value true or undefined instead of '' or undefined
-    return typeof value !== 'undefined';
-  }},
-  {'name': 'usage'},
-  {'name': 'classes'}, // related classes
-  {'name': 'interfaces'} // related interfaces
-];

scripts/docs/templates/common.template.html

@@ -1,368 +0,0 @@
----
-layout: "v2_fluid/docs_base"
-version: "<$ version.current.name $>"
-versionHref: "<$ version.current.href.replace('content/','') $>"
-path: "<$ doc.path $>"
-category: native
-id: "<$ doc.name|lower|replace(' ','-') $>"
-title: "<@ if doc.docType == "directive" @><$ doc.name | dashCase $><@ else @><$ doc.name $><@ endif @>"
-header_sub_title: "<$ doc.docType | capital $> in module <$ doc.module $>"
-doc: "<$ doc.name $>"
-docType: "<$ doc.docType $>"
----
-
-<@ macro interfaceTable(interface) @>
-<@ for export in doc.moduleDoc.exports -@>
-<@ if export.name == interface @>
-<table class="table param-table" style="margin:0;">
-  <thead>
-  <tr>
-    <th>Param</th>
-    <th>Type</th>
-    <th>Details</th>
-  </tr>
-  </thead>
-  <tbody>
-  <@ for param in export.members @>
-  <tr>
-    <td>
-      <$ param.name $>
-      <@ if param.optional @><div><em>(optional)</em></div><@ endif @>
-    </td>
-    <td>
-      <code><$ param.returnType | escape $></code>
-    </td>
-    <td>
-      <$ param.description | marked $>
-    </td>
-  </tr>
-  <@ endfor @>
-  </tbody>
-</table>
-
-<@ endif @>
-<@- endfor @>
-<@ endmacro @>
-
-<@ macro paramList(paramData) -@>
-<@- if paramData -@><span class="params">(
-    <@- for param in paramData -@>
-      <span class="param"><$ param | escape $><@ if not loop.last @>, <@ endif @></span>
-    <@- endfor @>)</span>
-<@- endif @>
-<@- endmacro -@>
-
-<@ macro githubViewLink(doc) -@>
-<a href="https://github.com/<$ versionInfo.gitRepoInfo.owner $>/<$ versionInfo.gitRepoInfo.repo $>/tree/master/<$ doc.fileInfo.relativePath $>#L<$ doc.location.start.line+1 $>-L<$ doc.location.end.line+1 $>"><$ doc.fileInfo.relativePath $> (line <$ doc.location.start.line+1 $>)</a>
-<@- endmacro -@>
-
-<@ macro paramTable(params, isDirective) -@>
-<table class="table param-table" style="margin:0;">
-  <thead>
-  <tr>
-    <th><@ if isDirective @>Attr<@ else @>Param<@ endif @></th>
-    <th>Type</th>
-    <th>Details</th>
-  </tr>
-  </thead>
-  <tbody>
-  <@ for param in params @>
-  <tr>
-    <td>
-      <$ param.name $>
-      <@ if param.alias @>| <$ param.alias $><@ endif @>
-      <@ if param.type.optional @><div><em>(optional)</em></div><@ endif @>
-    </td>
-    <td>
-      <$ typeList(param.typeList) $>
-    </td>
-    <td>
-      <$ param.description | marked $>
-      <@ if param.default @><p><em>(default: <$ param.default $>)</em></p><@ endif @>
-    </td>
-  </tr>
-  <@ endfor @>
-  </tbody>
-</table>
-<@- endmacro -@>
-
-
-<@- macro functionSyntax(fn) @>
-  <@- set sep = joiner(',&nbsp;') -@>
-  <code><$ fn.name $><@- if not fn.isProperty @>(<@ endif -@><@- for param in fn.params @><$ sep() $>
-  <@- if param.type.optional @>[<@ endif -@>
-  <$ param.name $>
-  <@- if param.type.optional @>]<@ endif -@>
-  <@ endfor @><@- if not fn.isProperty @>)<@ endif -@></code>
-  <@ if fn.alias @><small>(alias: <$ fn.alias $>)</small><@ endif @>
-<@ endmacro -@>
-
-<@ macro typeList(types) -@>
-<@ set separator = joiner("|") @>
-<@ for type in types @><$ separator() $><$ type | code $><@ endfor @>
-<@- endmacro -@>
-
-<@- macro typeInfo(fn) -@>
-<$ typeList(fn.typeList) $> <$ fn.description $>
-<@- endmacro -@>
-
-
-
-<@ macro documentClass(doc) @>
-<@- if doc.statics.length -@>
-<h2>Static Members</h2>
-<@ for method in doc.statics -@>
-<@ if not method.internal @>
-<div id="<$ method.name $>"></div>
-<h3><$ functionSyntax(method) $></h3>
-<@- if method.decorators @>
-<@ for prop in method.decorators[0].argumentInfo @>
-<@ if prop.platforms @>
-<p>
-  <b>Platforms:</b>
-  <@- for platform in prop.platforms @>
-  <code><$ platform $></code>&nbsp;
-  <@ endfor -@>
-</p>
-<@ endif @>
-<@ endfor @>
-<@- endif @>
-
-<$ method.description $>
-
-<@ if method.params @>
-<$ paramTable(method.params) $>
-<@ endif @>
-
-<@ if method.this -@>
-<h4> Method's `this`
-  <$ method.this $>
-</h4>
-<@- endif @>
-
-<@ if method.returns @>
-<div class="return-value" markdown="1">
-  <i class="icon ion-arrow-return-left"></i>
-  <b>Returns:</b> <$ typeInfo(method.returns) $>
-</div>
-<@ endif @>
-<@ endif @>
-<@ endfor -@>
-<@ endif @>
-
-<!-- methods on the class -->
-<@- if doc.members and doc.members.length @>
-
-<h2>Instance Members</h2>
-<@ for method in doc.members -@>
-<div id="<$ method.name $>"></div>
-<h3>
-  <$ functionSyntax(method) $>
-</h3>
-<$ method.description $>
-<@ if method.params -@>
-<$ paramTable(method.params) $>
-<@- endif @>
-<@ if method.this -@>
-<h4> Method's `this`
-  <$ method.this $>
-</h4>
-<@- endif @>
-<@ if method.returns -@>
-<div class="return-value" markdown="1">
-  <i class="icon ion-arrow-return-left"></i>
-  <b>Returns:</b> <$ typeInfo(method.returns) $>
-</div>
-<@- endif @>
-<@- endfor @>
-<@- endif -@>
-<@ endmacro @>
-<@ block body @>
-<@ block content @>
-<@ block header @>
-<h1 class="api-title">
-  <@ if doc.docType == "directive" @>
-  <$ doc.name | dashCase $>
-  <@ else @>
-  <$ doc.name $>
-  <@ endif @>
-
-  <@ if doc.parent @>
-  <br />
-  <small>
-    Child of <$ doc.parent $>
-  </small>
-  <@ endif @>
-
-  <@ if doc.delegate @>
-  <br/>
-  <small>
-    Delegate: <$ doc.delegate $>
-  </small>
-  <@ endif @>
-  <@- if doc.beta == true -@>
-    <span class="beta" title="beta">&beta;</span>
-  <@- endif -@>
-</h1>
-
-<a class="improve-v2-docs" href="http://github.com/driftyco/ionic-native/edit/master/<$ doc.fileInfo.relativePath|replace('/home/ubuntu/ionic-native/', '')|replace('//','/') $>#L<$ doc.location.start.line $>">
-  Improve this doc
-</a>
-
-<@ endblock @>
-
-<!-- decorators -->
-<@- if doc.decorators @>
-
-<@ for prop in doc.decorators[0].argumentInfo @>
-
-<@ if doc.beta == true @>
-<p class="beta-notice">
-  This plugin is still in beta stage and may not work as expected. Please
-  submit any issues to the <a target="_blank"
-  href="<$ prop.repo $>/issues">plugin repo</a>.
-</p>
-<@ endif @>
-
-<pre><code>$ <@ if prop.install @><$ prop.install $><@ else @>ionic plugin add <$ prop.plugin $><@ endif -@></code></pre>
-<p>Repo:
-  <a href="<$ prop.repo $>">
-    <$ prop.repo $>
-  </a>
-</p>
-
-<!-- description -->
-<@ block description @>
-<$ doc.description | marked $>
-<@ endblock @>
-
-
-<@- if doc.directiveInfo @>
-<h2><$ doc.directiveInfo.type $></h2>
-<h3><$ doc.directiveInfo.properties[0].name $>: <code><$ doc.directiveInfo.properties[0].values $></code></h3>
-<@ endif -@>
-
-<@ if prop.platforms @>
-<!-- @platforms tag -->
-<h2>Supported platforms</h2>
-<@ block platforms @>
-<ul>
-  <@ for platform in prop.platforms -@>
-  <li><$ platform $></li>
-  <@- endfor @>
-</ul>
-<@ endblock @>
-<!-- @platforms tag end -->
-<@ endif @>
-<@ endfor @>
-<@ endif -@><!-- if doc.decorators -->
-
-<!-- @usage tag -->
-<@ if doc.usage @>
-<h2>Usage</h2>
-<@ block usage @>
-<$ doc.usage | marked $>
-<@ endblock @>
-<@ endif @>
-
-<!-- @property tags -->
-<@ if doc.properties @>
-<h2>Attributes:</h2>
-<table class="table" style="margin:0;">
-  <thead>
-  <tr>
-    <th>Attribute</th>
-
-    <@ set hasTypes = false @>
-    <@ for prop in doc.properties @>
-    <@ if prop.type @>
-    <@ set hasTypes = true @>
-    <@ endif @>
-    <@ endfor @>
-    <@ if hasTypes @>
-    <th>Type</th>
-    <@ endif @>
-
-    <th>Description</th>
-  </tr>
-  </thead>
-  <tbody>
-  <@ for prop in doc.properties -@>
-  <tr>
-    <td>
-      <$ prop.name $>
-    </td>
-    <@ if hasTypes @>
-    <td>
-      <$ prop.type.name $>
-    </td>
-    <@ endif @>
-
-    <td>
-      <$ prop.description $>
-    </td>
-  </tr>
-  <@- endfor @>
-  </tbody>
-</table>
-<@ endif @>
-
-<$ documentClass(doc) $>
-
-<@ block advanced @>
-<@- if doc.advanced -@>
-<h2><a class="anchor" name="advanced" href="#advanced"></a>Advanced</h2>
-<$ doc.advanced | marked $>
-<@- endif -@>
-<@ endblock @>
-
-<!-- other classes -->
-<@ for tag in doc.tags.tags -@>
-<@ if tag.tagName == 'classes' -@>
-<!--<h2><a class="anchor" name="related-classes" href="#related-classes"></a>Related Classes</h2>-->
-<@ set classes = tag.description.split('\n') @>
-<@ for item in classes -@>
-<@ if item.length > 1 @>
-<@ for export in doc.moduleDoc.exports -@>
-<@ if export.name == item @>
-<h2><a class="anchor" name="<$ item $>" href="#<$ item $>"></a><$ item $></h2>
-<$ documentClass(export) $>
-<@ endif @>
-<@- endfor @>
-<@ endif @>
-<@- endfor @>
-<@- endif @>
-<@- endfor @>
-<!-- end other classes -->
-
-<!-- interfaces -->
-<@ for tag in doc.tags.tags -@>
-<@ if tag.tagName == 'interfaces' @>
-<!--<h2><a class="anchor" name="interfaces" href="#interfaces"></a>Interfaces</h2>-->
-<@ set interfaces = tag.description.split('\n') @>
-<@ for item in interfaces -@>
-<@ if item.length > 1 @>
-<h2><a class="anchor" name="<$ item $>" href="#<$ item $>"></a><$ item $></h2>
-<$ interfaceTable(item) $>
-<@ endif @>
-<@- endfor @>
-<@ endif @>
-<@- endfor @>
-<!-- end interfaces -->
-
-<!-- related link -->
-<@- if doc.see @>
-
-<h2>Related</h2>
-<@ for s in doc.see @>
-<$ s | safe $>
-<@- endfor -@>
-
-<@- endif -@>
-
-
-<!-- end content block -->
-<@ endblock @>
-
-<!-- end body block -->
-<@ endblock @>

scripts/docs/templates/native_menu.template.html

@@ -1,9 +0,0 @@
-<@ for doc in docs @><@ if doc.URL and doc.private != true and doc.beta != true @>
-<li class="capitalize {% if page.id == '<$ doc.name|lower|replace(' ','-') $>' %}active{% endif %}">
-  <a href="/<$ doc.URL $>"><$ doc.name $></a>
-</li><@ endif @><@ endfor @>
-
-<@ for doc in docs @><@ if doc.URL and doc.private != true and doc.beta == true @>
-<li class="capitalize {% if page.id == '<$ doc.name|lower|replace(' ','-') $>' %}active{% endif %}">
-  <a href="/<$ doc.URL $>"><$ doc.name $> <span class="beta">&beta;</span></a>
-</li><@ endif @><@ endfor @>

scripts/docs/typescript-definition-package/index.js

@@ -1,100 +0,0 @@
-var Package = require('dgeni').Package;
-var jsdocPackage = require('dgeni-packages/jsdoc');
-var nunjucksPackage = require('dgeni-packages/nunjucks');
-var typescriptPackage = require('../typescript-package');
-var gitPackage = require('dgeni-packages/git');
-var path = require('canonical-path');
-
-// Define the dgeni package for generating the docs
-module.exports = new Package('angular-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, gitPackage])
-
-// Register the processors
-.processor(require('./processors/createTypeDefinitionFile'))
-
-.config(function(readFilesProcessor, inlineTagProcessor) {
-  readFilesProcessor.basePath = path.resolve(__dirname, '../..');
-  // Don't run unwanted processors
-  readFilesProcessor.$enabled = false;
-  inlineTagProcessor.$enabled = false;
-})
-
-
-// Configure the log service
-.config(function(log) {
-  log.level = 'info';
-})
-
-
-.config(function(renderDocsProcessor, versionInfo) {
-  renderDocsProcessor.extraData.versionInfo = versionInfo;
-})
-
-.config(function(readFilesProcessor, inlineTagProcessor, readTypeScriptModules, createTypeDefinitionFile) {
-
-  // Don't run unwanted processors
-  readFilesProcessor.$enabled = false; // We are not using the normal file reading processor
-  inlineTagProcessor.$enabled = false; // We are not actually processing the inline link tags
-
-  // Configure file reading
-  readFilesProcessor.basePath = path.resolve(__dirname, '../..');
-  readTypeScriptModules.sourceFiles = [
-    'angular2/angular2.ts',
-    'angular2/router.ts'
-  ];
-  readTypeScriptModules.basePath = path.resolve(path.resolve(__dirname, '../../modules'));
-  
-  createTypeDefinitionFile.typeDefinitions = [
-      {
-        id: 'angular2/angular2',
-        modules: {
-          'angular2/angular2': 'angular2/angular2',
-        }
-      },
-      {
-        id: 'angular2/router',
-        modules: {
-          'angular2/router': 'angular2/router'
-        }
-      }    
-  ];
-})
-
-
-.config(function(parseTagsProcessor, getInjectables) {
-  // We actually don't want to parse param docs in this package as we are getting the data out using TS
-  parseTagsProcessor.tagDefinitions.forEach(function(tagDef) {
-    if (tagDef.name === 'param') {
-      tagDef.docProperty = 'paramData';
-      tagDef.transforms = [];
-    }
-  });
-
-})
-
-
-// Configure file writing
-.config(function(writeFilesProcessor) {
-  writeFilesProcessor.outputFolder  = 'dist/docs';
-})
-
-
-// Configure rendering
-.config(function(templateFinder, templateEngine) {
-
-  // Nunjucks and Angular conflict in their template bindings so change Nunjucks
-  templateEngine.config.tags = {
-    variableStart: '{$',
-    variableEnd: '$}'
-  };
-
-  templateFinder.templateFolders
-      .unshift(path.resolve(__dirname, 'templates'));
-
-  templateFinder.templatePatterns = [
-    '${ doc.template }',
-    '${ doc.id }.${ doc.docType }.template.html',
-    '${ doc.id }.template.html',
-    '${ doc.docType }.template.html',
-    'common.template.html'
-  ];
-});

scripts/docs/typescript-definition-package/mocks/mockPackage.js

@@ -1,11 +0,0 @@
-var Package = require('dgeni').Package;
-
-module.exports = function mockPackage() {
-
-  return new Package('mockPackage', [require('../')])
-
-  // provide a mock log service
-  .factory('log', function() { return require('dgeni/lib/mocks/log')(false); })
-//  .factory('templateEngine', function() { return {}; });
-
-};

scripts/docs/typescript-definition-package/processors/createTypeDefinitionFile.js

@@ -1,86 +0,0 @@
-var _ = require('lodash');
-var path = require('canonical-path');
-
-module.exports = function createTypeDefinitionFile(log) {
-
-  return {
-    $runAfter: ['processing-docs'],
-    $runBefore: ['docs-processed'],
-    $validate: {
-      dtsPath: { presence: true },
-      dtsExtension: { presence: true },
-      typeDefinitions: { presence: true }
-    },
-    dtsPath: 'typings',
-    dtsExtension: '.d.ts',
-    typeDefinitions: [],
-    $process: function(docs) {
-      var dtsPath = this.dtsPath;
-      var dtsExtension = this.dtsExtension;
-
-      // For each type definition that we wish to create we define a dgeni "doc" for it
-      var typeDefDocs = _.map(this.typeDefinitions, function(def) {
-
-        var id = def.id + dtsExtension;
-        var docPath = path.join(dtsPath, id);
-
-        return {
-          docType: 'type-definition',
-          id: id,
-          aliases: [id],
-          path: docPath,
-          outputPath: docPath,
-          // A type definition may include a number of top level modules
-          // And those modules could be aliased (such as 'angular2/angular2.api' -> 'angular2/angular2')
-          moduleDocs: _.transform(def.modules, function(moduleDocs, id, alias) {
-            moduleDocs[id] = { id: alias, doc: null };
-          })
-        };
-      });
-
-      // Now add all the module docs to their corresponding type definition doc
-      _.forEach(docs, function(doc) {
-        _.forEach(typeDefDocs, function(typeDefDoc) {
-          if(typeDefDoc.moduleDocs[doc.id]) {
-            // Add a copy, because we are going to modify it
-            typeDefDoc.moduleDocs[doc.id].doc = doc;
-          }
-        });
-      });
-
-      return _.filter(typeDefDocs, function(doc) {
-        _.forEach(doc.moduleDocs, function(modDoc, alias) {
-          if (!doc || !modDoc.doc) {
-            log.error('createTypeDefinitionFile processor: no such module "' + alias + '" (Did you forget to add it to the modules to load?)');
-            doc = null;
-            return;
-          }
-          _.forEach(modDoc.doc.exports, function(exportDoc) {
-
-            // Search for classes with a constructor marked as `@private`
-            if (exportDoc.docType === 'class' && exportDoc.constructorDoc && exportDoc.constructorDoc.private) {
-
-              // Convert this class to an interface with no constructor
-              exportDoc.docType = 'interface';
-              exportDoc.constructorDoc = null;
-              
-              if (exportDoc.heritage) {
-                // convert the heritage since interfaces use `extends` not `implements`
-                exportDoc.heritage = exportDoc.heritage.replace('implements', 'extends');
-              }
-
-              // Add the `declare var SomeClass extends InjectableReference` construct
-              modDoc.doc.exports.push({
-                docType: 'var',
-                name: exportDoc.name,
-                id: exportDoc.id,
-                heritage: ': InjectableReference'
-              });
-            }
-          });
-        });
-        return !!doc;
-      });
-    }
-  };
-};

scripts/docs/typescript-definition-package/processors/createTypeDefinitionFile.spec.js

@@ -1,48 +0,0 @@
-var mockPackage = require('../mocks/mockPackage');
-var Dgeni = require('dgeni');
-var path = require('canonical-path');
-var _ = require('lodash');
-
-describe('createTypeDefinitionFile processor', function() {
-  var dgeni, injector, processor;
-
-  beforeEach(function() {
-    dgeni = new Dgeni([mockPackage()]);
-    injector = dgeni.configureInjector();
-    processor = injector.get('createTypeDefinitionFile');
-
-    // Initialize the processor
-    processor.typeDefinitions = [{
-      id: 'angular2/angular2',
-      modules: { 'angular2/angular2': 'angular2/angular2' }
-    }];
-  });
-
-
-
-  describe('classes with private constructors', function() {
-    
-    it('should convert heritage from `implements` into `extends`', function() {
-      
-      // Create some mock docs for testing
-      var docs = [
-        {
-          id: 'angular2/angular2',
-          exports: [
-            { docType: 'class', heritage: 'implements Xyz', constructorDoc: { private: true }  }
-          ]
-        }
-      ];
-
-      docs = processor.$process(docs);
-      
-      expect(docs.length).toEqual(1);
-      expect(docs[0].docType).toEqual('type-definition');
-
-      var moduleDoc = docs[0].moduleDocs['angular2/angular2'].doc;
-      expect(moduleDoc.exports.length).toEqual(2);
-      expect(moduleDoc.exports[0].heritage).toEqual('extends Xyz');
-    });
-  });
-	
-});

scripts/docs/typescript-definition-package/templates/angular2/angular2.d.ts.template.html

@@ -1,17 +0,0 @@
-{% extends '../type-definition.template.html' %}
-{% block staticDeclarations %}
-
-interface List<T> extends Array<T> {}
-interface Map<K,V> {}
-interface StringMap<K,V> extends Map<K,V> {}
-
-declare module ng {
-  // See https://github.com/Microsoft/TypeScript/issues/1168
-  class BaseException /* extends Error */ {
-    message: string;
-    stack: string;
-    toString(): string;
-  }
-  interface InjectableReference {}
-}
-{% endblock %}

scripts/docs/typescript-definition-package/templates/type-definition.template.html

@@ -1,72 +0,0 @@
-
-{%- macro commentBlock(doc, level) -%}
-{%- if doc.content | trim %}
-
-{% if level > 1 %}{$ '/**' | indent(level-1, true) | replace(r/\n$/, "") $}{% else %}/**{% endif %}
-{$ doc.content | trim | replace(r/^/gm, "* ") | indent(level, true) | replace(r/\n$/, "") $}
-{$ '*/' | indent(level, true) | replace(r/\n$/, "") $}{% endif -%}
-{%- endmacro -%}
-
-
-{%- macro memberInfo(member) -%}
-{$ commentBlock(member, 5) $}
-     {$ member.name $}{% if member.optional %}?{% endif -%}
-{% if member.typeParameters %}<{% for typeParam in member.typeParameters %}{$ typeParam $}{% if not loop.last %}, {% endif %}{% endfor %}>{% endif -%}
-{%- if member.parameters -%}({% for param in member.parameters %}{$ param $}{% if not loop.last %}, {% endif %}{% endfor %}){%- endif -%}
-{%- if member.returnType == 'Directive' %}: DirectiveAnnotation{%- elif member.returnType -%}: {$ member.returnType $}{%- else -%}: void
-{%- endif -%};
-{%- endmacro -%}
-
-
-// Type definitions for Angular v{$ versionInfo.currentVersion.full | replace(r/\+/, "_") $}
-// Project: http://angular.io/
-// Definitions by: angular team <https://github.com/angular/>
-// Definitions: https://github.com/borisyankov/DefinitelyTyped
-
-// ***********************************************************
-// This file is generated by the Angular build process.
-// Please do not create manual edits or send pull requests
-// modifying this file.
-// ***********************************************************
-{% block staticDeclarations %}{% endblock %}
-{% for alias, module in doc.moduleDocs %}
-{$ commentBlock(module.doc, 1) $}
-declare module ng {
-
-  {%- for export in module.doc.exports -%}
-  {%- if export.content -%}
-    {$ commentBlock(export, 3) $}
-  {%- endif %}
-  {$ export.docType $} {$ export.name $}{$ export.typeParams $}{%- if export.heritage == ' extends Directive' %} extends DirectiveAnnotation{% else %}{$ export.heritage $}{% endif %}
-  {%- if export.docType == 'class' or export.docType == 'interface' %} {
-  {%- if export.newMember %}
-    {$ memberInfo(export.newMember) $}
-  {% endif %}
-  {%- if export.callMember %}
-    {$ memberInfo(export.callMember) $}
-  {% endif -%}
-  {%- for member in export.members %}
-    {$ memberInfo(member) $}
-  {%- endfor %}
-  }
-
-  {%- elif export.docType == 'enum' %} {
-    {%- for member in export.members %}
-    {$ member $}{% if not loop.last %},
-    {%- endif -%}
-    {%- endfor %}
-  }
-
-  {%- else -%}
-    {% if export.parameters %}({% for param in export.parameters %}{$ param $}{% if not loop.last %}, {% endif %}{% endfor %}){%- endif %}
-    {%- if export.returnType %} : {$ export.returnType $} {% endif -%}
-    ;
-  {%- endif %}
-  {% endfor %}
-}
-
-{% endfor %}
-
-declare module "angular2/angular2" {
-  export = ng;
-}

scripts/docs/typescript-package/index.js

@@ -1,74 +0,0 @@
-var basePackage = require('dgeni-packages/base');
-var Package = require('dgeni').Package;
-var path = require('canonical-path');
-
-// Define the dgeni package for generating the docs
-module.exports = new Package('typescript-parsing', [basePackage])
-
-// Register the services and file readers
-.factory(require('./services/modules'))
-.factory(require('./services/tsParser'))
-.factory(require('./services/tsParser/createCompilerHost'))
-.factory(require('./services/tsParser/getFileInfo'))
-.factory(require('./services/tsParser/getExportDocType'))
-.factory(require('./services/tsParser/getContent'))
-.factory(require('./services/tsParser/getDirectiveInfo'))
-
-.factory(require('./services/convertPrivateClassesToInterfaces'))
-
-.factory('EXPORT_DOC_TYPES', function() {
-  return [
-    'class',
-    'interface',
-    'function',
-    'var',
-    'const',
-    'let',
-    'enum',
-    'type-alias'
-  ];
-})
-
-
-// Register the processors
-.processor(require('./processors/readTypeScriptModules'))
-
-
-// Configure the log service
-.config(function(log) {
-  log.level = 'warn';
-})
-
-
-// Configure ids and paths
-.config(function(computeIdsProcessor, computePathsProcessor, EXPORT_DOC_TYPES) {
-
-  computeIdsProcessor.idTemplates.push({
-    docTypes: ['member'],
-    idTemplate: '${classDoc.id}.${name}',
-    getAliases: function(doc) {
-      return doc.classDoc.aliases.map(function(alias) { return alias + '.' + doc.name; });
-    }
-  });
-
-  computePathsProcessor.pathTemplates.push({
-    docTypes: ['member'],
-    pathTemplate: '${classDoc.path}#${name}',
-    getOutputPath: function() {} // These docs are not written to their own file, instead they are part of their class doc
-  });
-
-  var MODULES_DOCS_PATH = 'partials/modules';
-
-  computePathsProcessor.pathTemplates.push({
-    docTypes: ['module'],
-    pathTemplate: '/${id}',
-    outputPathTemplate: MODULES_DOCS_PATH + '/${id}/index.html'
-  });
-
-  computePathsProcessor.pathTemplates.push({
-    docTypes: EXPORT_DOC_TYPES,
-    pathTemplate: '${moduleDoc.path}/${name}',
-    outputPathTemplate: MODULES_DOCS_PATH + '/${path}/index.html'
-  });
-
-});

scripts/docs/typescript-package/mocks/mockPackage.js

@@ -1,11 +0,0 @@
-var Package = require('dgeni').Package;
-
-module.exports = function mockPackage() {
-
-  return new Package('mockPackage', [require('../')])
-
-  // provide a mock log service
-  .factory('log', function() { return require('dgeni/lib/mocks/log')(false); })
-  .factory('templateEngine', function() { return {}; });
-
-};

scripts/docs/typescript-package/mocks/readTypeScriptModules/ignoreExportsMatching.ts

@@ -1,4 +0,0 @@
-export var __esModule = true;
-export class OKToExport {}
-export function _thisIsPrivate() {}
-export var thisIsOK = '!';

scripts/docs/typescript-package/mocks/readTypeScriptModules/interfaces.ts

@@ -1,5 +0,0 @@
-export interface MyInterface {
-  optionalProperty? : string
-  <T, U extends Findable<T>>(param: T) : U
-  new (param: number) : MyInterface
-}

scripts/docs/typescript-package/mocks/readTypeScriptModules/orderingOfMembers.ts

@@ -1,6 +0,0 @@
-export class Test {
-  firstItem;
-  constructor() { this.doStuff(); }
-  otherMethod() {}
-  doStuff() {}
-}

scripts/docs/typescript-package/mocks/readTypeScriptModules/privateModule.ts

@@ -1 +0,0 @@
-export var x = 10;

scripts/docs/typescript-package/mocks/readTypeScriptModules/publicModule.ts

@@ -1,3 +0,0 @@
-export { x as y} from './privateModule';
-
-export abstract class AbstractClass {}

scripts/docs/typescript-package/mocks/tsParser/importedSrc.ts

@@ -1 +0,0 @@
-export var x = 100;

scripts/docs/typescript-package/mocks/tsParser/testSrc.ts

@@ -1,34 +0,0 @@
-/**
- * @module
- * @description
- * This is the module description
- */
-
-export * from 'importedSrc';
-
-/**
- * This is some random other comment
- */
-
-/**
- * This is MyClass
- */
-export class MyClass {
-  message: String;
-
-  /**
-   * Create a new MyClass
-   * @param {String} name The name to say hello to
-   */
-  constructor(name) { this.message = 'hello ' + name; }
-
-  /**
-   * Return a greeting message
-   */
-  greet() { return this.message; }
-}
-
-/**
- * An exported function
- */
-export var myFn = (val: number) => return val * 2;

scripts/docs/typescript-package/processors/readTypeScriptModules.js

@@ -1,454 +0,0 @@
-var glob = require('glob');
-var path = require('canonical-path');
-var _ = require('lodash');
-var ts = require('typescript');
-
-module.exports = function readTypeScriptModules(tsParser, modules, getFileInfo,
-                                                getDirectiveInfo,
-                                                getExportDocType, getContent,
-                                                createDocMessage, log) {
-
-  return {
-    $runAfter: ['files-read'],
-    $runBefore: ['parsing-tags'],
-
-    $validate: {
-      sourceFiles: {presence: true},
-      basePath: {presence: true},
-      hidePrivateMembers: {inclusion: [true, false]},
-      sortClassMembers: {inclusion: [true, false]},
-      ignoreExportsMatching: {}
-    },
-
-    // A collection of globs that identify those modules for which we should create docs
-    sourceFiles: [],
-    // The base path from which to load the source files
-    basePath: '.',
-    // We can ignore members of classes that are private
-    hidePrivateMembers: true,
-    // We leave class members sorted in order of declaration
-    sortClassMembers: false,
-    // We can provide a collection of strings or regexes to ignore exports whose export names match
-    ignoreExportsMatching: ['___esModule'],
-
-    $process: function(docs) {
-
-      // Convert ignoreExportsMatching to an array of regexes
-      var ignoreExportsMatching = convertToRegexCollection(this.ignoreExportsMatching);
-
-      var hidePrivateMembers = this.hidePrivateMembers;
-      var sortClassMembers = this.sortClassMembers;
-
-      var basePath = path.resolve(this.basePath);
-      var filesPaths = expandSourceFiles(this.sourceFiles, basePath);
-      var parseInfo = tsParser.parse(filesPaths, this.basePath);
-      var moduleSymbols = parseInfo.moduleSymbols;
-
-      // Iterate through each of the modules that were parsed and generate a module doc
-      // as well as docs for each module's exports.
-      moduleSymbols.forEach(function(moduleSymbol) {
-
-        var moduleDoc = createModuleDoc(moduleSymbol, basePath);
-
-        // Add this module doc to the module lookup collection and the docs collection
-        modules[moduleDoc.id] = moduleDoc;
-        docs.push(moduleDoc);
-
-        // Iterate through this module's exports and generate a doc for each
-        moduleSymbol.exportArray.forEach(function(exportSymbol) {
-
-          // Ignore exports starting with an underscore
-          if (anyMatches(ignoreExportsMatching, exportSymbol.name)) return;
-
-          // If the symbol is an Alias then for most things we want the original resolved symbol
-          var resolvedExport = exportSymbol.resolvedSymbol || exportSymbol;
-
-          // If the resolved symbol contains no declarations then it is invalid
-          // (probably an abstract class)
-          // For the moment we are just going to ignore such exports
-          // TODO: find a way of generating docs for them
-          if (!resolvedExport.declarations) return;
-
-          var exportDoc = createExportDoc(exportSymbol.name, resolvedExport, moduleDoc, basePath, parseInfo.typeChecker);
-          log.debug('>>>> EXPORT: ' + exportDoc.name + ' (' + exportDoc.docType + ') from ' + moduleDoc.id);
-
-          // Add this export doc to its module doc
-          moduleDoc.exports.push(exportDoc);
-          docs.push(exportDoc);
-
-          exportDoc.members = [];
-          exportDoc.statics = [];
-
-          // Generate docs for each of the export's members
-          if (resolvedExport.flags & ts.SymbolFlags.HasMembers) {
-
-            for(var memberName in resolvedExport.members) {
-              // FIXME(alexeagle): why do generic type params appear in members?
-              if (memberName === 'T') {
-                continue;
-              }
-              log.silly('>>>>>> member: ' + memberName + ' from ' + exportDoc.id + ' in ' + moduleDoc.id);
-              var memberSymbol = resolvedExport.members[memberName];
-              var memberDoc = createMemberDoc(memberSymbol, exportDoc, basePath, parseInfo.typeChecker);
-
-              // We special case the constructor and sort the other members alphabetically
-              if (memberSymbol.flags & ts.SymbolFlags.Constructor) {
-                exportDoc.constructorDoc = memberDoc;
-                docs.push(memberDoc);
-              } else if (!hidePrivateMembers || memberSymbol.name.charAt(0) !== '_') {
-                docs.push(memberDoc);
-                exportDoc.members.push(memberDoc);
-              } else if (memberSymbol.name === '__call' && memberSymbol.flags & ts.SymbolFlags.Signature) {
-                docs.push(memberDoc);
-                exportDoc.callMember = memberDoc;
-              } else if (memberSymbol.name === '__new' && memberSymbol.flags & ts.SymbolFlags.Signature) {
-                docs.push(memberDoc);
-                exportDoc.newMember = memberDoc;
-              }
-            }
-          }
-
-          if (exportDoc.docType === 'enum') {
-            for(var memberName in resolvedExport.exports) {
-              log.silly('>>>>>> member: ' + memberName + ' from ' + exportDoc.id + ' in ' + moduleDoc.id);
-              var memberSymbol = resolvedExport.exports[memberName];
-              var memberDoc = createMemberDoc(memberSymbol, exportDoc, basePath, parseInfo.typeChecker);
-              docs.push(memberDoc);
-              exportDoc.members.push(memberDoc);
-            }
-          } else if (resolvedExport.flags & ts.SymbolFlags.HasExports) {
-            for (var exported in resolvedExport.exports) {
-              if (exported === 'prototype') continue;
-              if (hidePrivateMembers && exported.charAt(0) === '_') continue;
-              var memberSymbol = resolvedExport.exports[exported];
-              var memberDoc = createMemberDoc(memberSymbol, exportDoc, basePath, parseInfo.typeChecker);
-              memberDoc.isStatic = true;
-              docs.push(memberDoc);
-              exportDoc.statics.push(memberDoc);
-            }
-          }
-
-          if (sortClassMembers) {
-            exportDoc.members.sort(function(a, b) {
-              if (a.name > b.name) return 1;
-              if (a.name < b.name) return -1;
-              return 0;
-            });
-            exportDoc.statics.sort(function(a, b) {
-              if (a.name > b.name) return 1;
-              if (a.name < b.name) return -1;
-              return 0;
-            });
-          }
-        });
-      });
-    }
-  };
-
-
-  function createModuleDoc(moduleSymbol, basePath) {
-    var id = moduleSymbol.name.replace(/^"|"$/g, '');
-    var name = id.split('/').pop();
-    var moduleDoc = {
-      docType: 'module',
-      name: name,
-      id: id,
-      aliases: [id, name],
-      moduleTree: moduleSymbol,
-      content: getContent(moduleSymbol),
-      exports: [],
-      fileInfo: getFileInfo(moduleSymbol, basePath),
-      location: getLocation(moduleSymbol)
-    };
-    return moduleDoc;
-  }
-
-  function createExportDoc(name, exportSymbol, moduleDoc, basePath, typeChecker) {
-    var typeParamString = '';
-    var heritageString = '';
-    var typeDefinition = '';
-
-    exportSymbol.declarations.forEach(function(decl) {
-      var sourceFile = ts.getSourceFileOfNode(decl);
-
-      if (decl.typeParameters) {
-        typeParamString = '<' + getText(sourceFile, decl.typeParameters) + '>';
-      }
-
-      if (decl.symbol.flags & ts.SymbolFlags.TypeAlias) {
-        typeDefinition = getText(sourceFile, decl.type);
-      }
-
-      if (decl.heritageClauses) {
-        decl.heritageClauses.forEach(function(heritage) {
-
-          if (heritage.token == ts.SyntaxKind.ExtendsKeyword) {
-            heritageString += " extends";
-            heritage.types.forEach(function(typ, idx) {
-              heritageString += (idx > 0 ? ',' : '') + typ.getFullText();
-            });
-          }
-
-          if (heritage.token == ts.SyntaxKind.ImplementsKeyword) {
-            heritageString += " implements";
-            heritage.types.forEach(function(typ, idx) {
-              heritageString += (idx > 0 ? ', ' : '') + typ.getFullText();
-            });
-          }
-        });
-      }
-    });
-
-    //Make sure duplicate aliases aren't created, so "Ambiguous link" warnings are prevented
-    var aliasNames = [name, moduleDoc.id + '/' + name];
-    if (typeParamString) {
-      aliasNames.push(name + typeParamString);
-      aliasNames.push(moduleDoc.id + '/' + name + typeParamString);
-    }
-
-    var exportDoc = {
-      docType: getExportDocType(exportSymbol),
-      exportSymbol: exportSymbol,
-      name: name,
-      id: moduleDoc.id + '/' + name,
-      typeParams: typeParamString,
-      heritage: heritageString,
-      decorators: getDecorators(exportSymbol),
-      aliases: aliasNames,
-      moduleDoc: moduleDoc,
-      content: getContent(exportSymbol),
-      fileInfo: getFileInfo(exportSymbol, basePath),
-      location: getLocation(exportSymbol),
-      directiveInfo: getDirectiveInfo(exportSymbol)
-    };
-
-    if (exportDoc.docType === 'var' || exportDoc.docType === 'const' || exportDoc.docType === 'let') {
-      exportDoc.symbolTypeName = exportSymbol.valueDeclaration.type &&
-                                 exportSymbol.valueDeclaration.type.typeName &&
-                                 exportSymbol.valueDeclaration.type.typeName.text;
-    }
-
-    if (exportDoc.docType === 'type-alias') {
-      exportDoc.returnType = getReturnType(typeChecker, exportSymbol);
-    }
-
-    if(exportSymbol.flags & ts.SymbolFlags.Function) {
-      exportDoc.parameters = getParameters(typeChecker, exportSymbol);
-    }
-    if(exportSymbol.flags & ts.SymbolFlags.Value) {
-      exportDoc.returnType = getReturnType(typeChecker, exportSymbol);
-    }
-    if (exportSymbol.flags & ts.SymbolFlags.TypeAlias) {
-      exportDoc.typeDefinition = typeDefinition;
-    }
-
-    // Compute the original module name from the relative file path
-    exportDoc.originalModule = exportDoc.fileInfo.relativePath
-        .replace(new RegExp('\.' + exportDoc.fileInfo.extension + '$'), '');
-
-    return exportDoc;
-  }
-
-  function createMemberDoc(memberSymbol, classDoc, basePath, typeChecker) {
-    var memberDoc = {
-      docType: 'member',
-      classDoc: classDoc,
-      name: memberSymbol.name,
-      decorators: getDecorators(memberSymbol),
-      content: getContent(memberSymbol),
-      fileInfo: getFileInfo(memberSymbol, basePath),
-      location: getLocation(memberSymbol)
-    };
-
-    memberDoc.typeParameters = getTypeParameters(typeChecker, memberSymbol);
-
-    if(memberSymbol.flags & (ts.SymbolFlags.Signature) ) {
-      memberDoc.parameters = getParameters(typeChecker, memberSymbol);
-      memberDoc.returnType = getReturnType(typeChecker, memberSymbol);
-      switch(memberDoc.name) {
-        case '__call':
-          memberDoc.name = '';
-          break;
-        case '__new':
-          memberDoc.name = 'new';
-          break;
-      }
-    }
-
-    if (memberSymbol.flags & ts.SymbolFlags.Method) {
-      // NOTE: we use the property name `parameters` here so we don't conflict
-      // with the `params` property that will be updated by dgeni reading the
-      // `@param` tags from the docs
-      memberDoc.parameters = getParameters(typeChecker, memberSymbol);
-    }
-
-    if (memberSymbol.flags & ts.SymbolFlags.Constructor) {
-      memberDoc.parameters = getParameters(typeChecker, memberSymbol);
-      memberDoc.name = 'constructor';
-    }
-
-    if(memberSymbol.flags & ts.SymbolFlags.Value) {
-      memberDoc.returnType = getReturnType(typeChecker, memberSymbol);
-    }
-
-    if(memberSymbol.flags & ts.SymbolFlags.Optional) {
-      memberDoc.optional = true;
-    }
-
-    return memberDoc;
-  }
-
-
-  function getDecorators(symbol) {
-
-    var declaration = symbol.valueDeclaration || symbol.declarations[0];
-    var sourceFile = ts.getSourceFileOfNode(declaration);
-
-    var decorators = declaration.decorators && declaration.decorators.map(function(decorator) {
-      decorator = decorator.expression;
-      return {
-        name: decorator.expression ? decorator.expression.text : decorator.text,
-        arguments: decorator.arguments && decorator.arguments.map(function(argument) {
-          return getText(sourceFile, argument).trim();
-        }),
-        argumentInfo: decorator.arguments && decorator.arguments.map(function(argument) {
-          return parseArgument(argument);
-        }),
-        expression: decorator
-      };
-    });
-    return decorators;
-  }
-
-  function parseProperties(properties) {
-    var result = {};
-    _.forEach(properties, function(property) {
-      result[property.name.text] = parseArgument(property.initializer);
-    });
-    return result;
-  }
-
-  function parseArgument(argument) {
-    if (argument.text) return argument.text;
-    if (argument.properties) return parseProperties(argument.properties);
-    if (argument.elements) return argument.elements.map(function(element) { return element.text; });
-    var sourceFile = ts.getSourceFileOfNode(argument);
-    var text = getText(sourceFile, argument).trim();
-    return text;
-  }
-
-  function getParameters(typeChecker, symbol) {
-    var declaration = symbol.valueDeclaration || symbol.declarations[0];
-    var sourceFile = ts.getSourceFileOfNode(declaration);
-    if (!declaration.parameters) {
-      var location = getLocation(symbol);
-      throw new Error('missing declaration parameters for "' + symbol.name +
-        '" in ' + sourceFile.fileName +
-        ' at line ' + location.start.line);
-    }
-    return declaration.parameters.map(function(parameter) {
-      var paramText = '';
-      if (parameter.dotDotDotToken) {
-        paramText += '...';
-      }
-      paramText += getText(sourceFile, parameter.name);
-      if (parameter.questionToken || parameter.initializer) {
-        paramText += '?';
-      }
-      if (parameter.type) {
-        paramText += ':' + getType(sourceFile, parameter.type);
-      } else {
-        paramText += ': any';
-        if (parameter.dotDotDotToken) {
-          paramText += '[]';
-        }
-      }
-      return paramText.trim();
-    });
-  }
-
-  function getTypeParameters(typeChecker, symbol) {
-    var declaration = symbol.valueDeclaration || symbol.declarations[0];
-    var sourceFile = ts.getSourceFileOfNode(declaration);
-    if (!declaration.typeParameters) return;
-    var typeParams = declaration.typeParameters.map(function(type) {
-      return getText(sourceFile, type).trim();
-    });
-    return typeParams;
-  }
-
-  function getReturnType(typeChecker, symbol) {
-    var declaration = symbol.valueDeclaration || symbol.declarations[0];
-    var sourceFile = ts.getSourceFileOfNode(declaration);
-    if (declaration.type) {
-      return getType(sourceFile, declaration.type).trim();
-    } else if (declaration.initializer) {
-      // The symbol does not have a "type" but it is being initialized
-      // so we can deduce the type of from the initializer (mostly).
-      if (declaration.initializer.expression) {
-        return declaration.initializer.expression.text.trim();
-      } else {
-        return getType(sourceFile, declaration.initializer).trim();
-      }
-    }
-  }
-
-
-  function expandSourceFiles(sourceFiles, basePath) {
-    var filePaths = [];
-    sourceFiles.forEach(function(sourcePattern) {
-      filePaths = filePaths.concat(glob.sync(sourcePattern, { cwd: basePath }));
-    });
-    return filePaths;
-  }
-
-
-  function getText(sourceFile, node) {
-    return sourceFile.text.substring(node.pos, node.end);
-  }
-
-
-  // Strip any local renamed imports from the front of types
-  function getType(sourceFile, type) {
-    var text = getText(sourceFile, type);
-    while (text.indexOf(".") >= 0) {
-      // Keep namespaced symbols in RxNext
-      if (text.match(/^\s*RxNext\./)) break;
-      // handle the case List<thing.stuff> -> List<stuff>
-      text = text.replace(/([^.<]*)\.([^>]*)/, "$2");
-    }
-    return text;
-  }
-
-  function getLocation(symbol) {
-    var node = symbol.valueDeclaration || symbol.declarations[0];
-    var sourceFile = ts.getSourceFileOfNode(node);
-    var location = {
-      start: ts.getLineAndCharacterOfPosition(sourceFile, node.pos),
-      end: ts.getLineAndCharacterOfPosition(sourceFile, node.end)
-    };
-    return location;
-  }
-
-};
-
-function convertToRegexCollection(items) {
-  if (!items) return [];
-
-  // Must be an array
-  if (!_.isArray(items)) {
-    items = [items];
-  }
-
-  // Convert string to exact matching regexes
-  return items.map(function(item) {
-    return _.isString(item) ? new RegExp('^' + item + '$') : item;
-  });
-}
-
-function anyMatches(regexes, item) {
-  for(var i=0; i<regexes.length; ++i) {
-    if ( item.match(regexes[i]) ) return true;
-  }
-  return false;
-}

scripts/docs/typescript-package/processors/readTypeScriptModules.spec.js

@@ -1,136 +0,0 @@
-var mockPackage = require('../mocks/mockPackage');
-var Dgeni = require('dgeni');
-var path = require('canonical-path');
-var _ = require('lodash');
-
-describe('readTypeScriptModules', function() {
-  var dgeni, injector, processor;
-
-  beforeEach(function() {
-    dgeni = new Dgeni([mockPackage()]);
-    injector = dgeni.configureInjector();
-    processor = injector.get('readTypeScriptModules');
-    processor.basePath = path.resolve(__dirname, '../mocks/readTypeScriptModules');
-  });
-
-  describe('exportDocs', function() {
-    it('should provide the original module if the export is re-exported', function() {
-      processor.sourceFiles = [ 'publicModule.ts' ];
-      var docs = [];
-      processor.$process(docs);
-
-      var exportedDoc = docs[1];
-      expect(exportedDoc.originalModule).toEqual('privateModule');
-    });
-
-    it('should include exported abstract classes', function() {
-      processor.sourceFiles = [ 'publicModule.ts' ];
-      var docs = [];
-      processor.$process(docs);
-
-      var exportedDoc = docs[2];
-      expect(exportedDoc.name).toEqual('AbstractClass');
-    });
-
-  });
-
-
-  describe('ignoreExportsMatching', function() {
-    it('should ignore exports that match items in the `ignoreExportsMatching` property', function() {
-      processor.sourceFiles = [ 'ignoreExportsMatching.ts'];
-      processor.ignoreExportsMatching = [/^_/];
-      var docs = [];
-      processor.$process(docs);
-
-      var moduleDoc = docs[0];
-      expect(moduleDoc.docType).toEqual('module');
-      expect(moduleDoc.exports).toEqual([
-        jasmine.objectContaining({ name: 'OKToExport' }),
-        jasmine.objectContaining({ name: 'thisIsOK' })
-      ]);
-    });
-
-    it('should only ignore `___esModule` exports by default', function() {
-      processor.sourceFiles = [ 'ignoreExportsMatching.ts'];
-      var docs = [];
-      processor.$process(docs);
-
-      var moduleDoc = docs[0];
-      expect(moduleDoc.docType).toEqual('module');
-      expect(getNames(moduleDoc.exports)).toEqual([
-        'OKToExport',
-        '_thisIsPrivate',
-        'thisIsOK'
-      ]);
-    });
-  });
-
-
-  describe('interfaces', function() {
-
-    it('should mark optional properties', function() {
-      processor.sourceFiles = [ 'interfaces.ts'];
-      var docs = [];
-      processor.$process(docs);
-
-      var moduleDoc = docs[0];
-      var exportedInterface = moduleDoc.exports[0];
-      var member = exportedInterface.members[0];
-      expect(member.name).toEqual('optionalProperty');
-      expect(member.optional).toEqual(true);
-    });
-
-
-    it('should handle "call" type interfaces', function() {
-      processor.sourceFiles = [ 'interfaces.ts'];
-      var docs = [];
-      processor.$process(docs);
-
-      var moduleDoc = docs[0];
-      var exportedInterface = moduleDoc.exports[0];
-
-      expect(exportedInterface.callMember).toBeDefined();
-      expect(exportedInterface.callMember.parameters).toEqual(['param: T']);
-      expect(exportedInterface.callMember.returnType).toEqual('U');
-      expect(exportedInterface.callMember.typeParameters).toEqual(['T', 'U extends Findable<T>']);
-      expect(exportedInterface.newMember).toBeDefined();
-      expect(exportedInterface.newMember.parameters).toEqual(['param: number']);
-      expect(exportedInterface.newMember.returnType).toEqual('MyInterface');
-    });
-  });
-
-
-  describe('ordering of members', function() {
-    it('should order class members in order of appearance (by default)', function() {
-      processor.sourceFiles = ['orderingOfMembers.ts'];
-      var docs = [];
-      processor.$process(docs);
-      var classDoc = _.find(docs, { docType: 'class' });
-      expect(classDoc.docType).toEqual('class');
-      expect(getNames(classDoc.members)).toEqual([
-        'firstItem',
-        'otherMethod',
-        'doStuff',
-      ]);
-    });
-
-
-    it('should not order class members if not sortClassMembers is false', function() {
-      processor.sourceFiles = ['orderingOfMembers.ts'];
-      processor.sortClassMembers = false;
-      var docs = [];
-      processor.$process(docs);
-      var classDoc = _.find(docs, { docType: 'class' });
-      expect(classDoc.docType).toEqual('class');
-      expect(getNames(classDoc.members)).toEqual([
-        'firstItem',
-        'otherMethod',
-        'doStuff'
-      ]);
-    });
-  });
-});
-
-function getNames(collection) {
-  return collection.map(function(item) { return item.name; });
-}

scripts/docs/typescript-package/services/convertPrivateClassesToInterfaces.js

@@ -1,31 +0,0 @@
-var _ = require('lodash');
-
-module.exports = function convertPrivateClassesToInterfaces() {
-  return function(exportDocs, addInjectableReference) {
-    _.forEach(exportDocs, function(exportDoc) {
-
-      // Search for classes with a constructor marked as `@internal`
-      if (exportDoc.docType === 'class' && exportDoc.constructorDoc && exportDoc.constructorDoc.internal) {
-
-        // Convert this class to an interface with no constructor
-        exportDoc.docType = 'interface';
-        exportDoc.constructorDoc = null;
-
-        if (exportDoc.heritage) {
-          // convert the heritage since interfaces use `extends` not `implements`
-          exportDoc.heritage = exportDoc.heritage.replace('implements', 'extends');
-        }
-
-        if (addInjectableReference) {
-          // Add the `declare var SomeClass extends InjectableReference` construct
-          exportDocs.push({
-            docType: 'var',
-            name: exportDoc.name,
-            id: exportDoc.id,
-            returnType: 'InjectableReference'
-          });
-        }
-      }
-    });
-  };
-};

scripts/docs/typescript-package/services/convertPrivateClassesToInterfaces.spec.js

@@ -1,76 +0,0 @@
-var mockPackage = require('../mocks/mockPackage');
-var Dgeni = require('dgeni');
-var _ = require('lodash');
-
-describe('readTypeScriptModules', function() {
-  var dgeni, injector, convertPrivateClassesToInterfaces;
-
-  beforeEach(function() {
-    dgeni = new Dgeni([mockPackage()]);
-    injector = dgeni.configureInjector();
-    convertPrivateClassesToInterfaces = injector.get('convertPrivateClassesToInterfaces');
-  });
-
-  it('should convert private class docs to interface docs', function() {
-    var docs = [
-      {
-        docType: 'class',
-        name: 'privateClass',
-        id: 'privateClass',
-        constructorDoc: { internal: true }
-      }
-    ];
-    convertPrivateClassesToInterfaces(docs, false);
-    expect(docs[0].docType).toEqual('interface');
-  });
-
-
-  it('should not touch non-private class docs', function() {
-    var docs = [
-      {
-        docType: 'class',
-        name: 'privateClass',
-        id: 'privateClass',
-        constructorDoc: { }
-      }
-    ];
-    convertPrivateClassesToInterfaces(docs, false);
-    expect(docs[0].docType).toEqual('class');
-  });
-
-
-  it('should convert the heritage since interfaces use `extends` not `implements`', function() {
-    var docs = [
-      {
-        docType: 'class',
-        name: 'privateClass',
-        id: 'privateClass',
-        constructorDoc: { internal: true },
-        heritage: 'implements parentInterface'
-      }
-    ];
-    convertPrivateClassesToInterfaces(docs, false);
-    expect(docs[0].heritage).toEqual('extends parentInterface');
-  });
-
-
-  it('should add new injectable reference types, if specified, to the passed in collection', function() {
-    var docs = [
-      {
-        docType: 'class',
-        name: 'privateClass',
-        id: 'privateClass',
-        constructorDoc: { internal: true },
-        heritage: 'implements parentInterface'
-      }
-    ];
-    convertPrivateClassesToInterfaces(docs, true);
-    expect(docs[1]).toEqual({
-      docType : 'var',
-      name : 'privateClass',
-      id : 'privateClass',
-      returnType : 'InjectableReference'
-    });
-  });
-
-});

scripts/docs/typescript-package/services/modules.js

@@ -1,3 +0,0 @@
-module.exports = function modules() {
-  return {};
-};

scripts/docs/typescript-package/services/tsParser/createCompilerHost.js

@@ -1,80 +0,0 @@
-var ts = require('typescript');
-var fs = require('fs');
-var path = require('canonical-path');
-
-// We need to provide our own version of CompilerHost because we want to set the
-// base directory and specify what extensions to consider when trying to load a source
-// file
-module.exports = function createCompilerHost(log) {
-
-  return function createCompilerHost(options, baseDir, extensions) {
-
-    return {
-      getSourceFile: function(fileName, languageVersion, onError) {
-        var text, resolvedPath, resolvedPathWithExt;
-
-        // Strip off the extension and resolve relative to the baseDir
-        baseFilePath = fileName.replace(/\.[^.]+$/, '');
-        resolvedPath = path.resolve(baseDir, baseFilePath);
-
-        // Iterate through each possible extension and return the first source file that is actually found
-        for(var i=0; i<extensions.length; i++) {
-
-          // Try reading the content from files using each of the given extensions
-          try {
-            resolvedPathWithExt = resolvedPath + extensions[i];
-            log.silly('getSourceFile:', resolvedPathWithExt);
-            text = fs.readFileSync(resolvedPathWithExt, { encoding: options.charset });
-            log.debug('found source file:', fileName, resolvedPathWithExt);
-            return ts.createSourceFile(baseFilePath + extensions[i], text, languageVersion);
-          }
-          catch(e) {
-            // Try again if the file simply did not exist, otherwise report the error as a warning
-            if(e.code !== 'ENOENT') {
-              if (onError) onError(e.message);
-              log.warn('Error reading ' + resolvedPathWithExt + ' : ' + e.message);
-            }
-          }
-        }
-      },
-      getDefaultLibFileName: function(options) {
-        return path.resolve(path.dirname(ts.sys.getExecutingFilePath()), ts.getDefaultLibFileName(options));
-      },
-      writeFile: function(fileName, data, writeByteOrderMark, onError) {
-        // no-op
-      },
-      getCurrentDirectory: function() {
-        return baseDir;
-      },
-      useCaseSensitiveFileNames: function() {
-        return ts.sys.useCaseSensitiveFileNames;
-      },
-      getCanonicalFileName: function(fileName) {
-        // if underlying system can distinguish between two files whose names differs only in cases then file name already in canonical form.
-        // otherwise use toLowerCase as a canonical form.
-        return ts.sys.useCaseSensitiveFileNames ? fileName : fileName.toLowerCase();
-      },
-      getNewLine: function() {
-        return ts.sys.newLine;
-      },
-      fileExists: function(fileName) {
-        var text, resolvedPath, resolvedPathWithExt;
-
-        // Strip off the extension and resolve relative to the baseDir
-        baseFilePath = fileName.replace(/\.[^.]+$/, '');
-        resolvedPath = path.resolve(baseDir, baseFilePath);
-
-        // Iterate through each possible extension and return the first source file that is actually found
-        for(var i=0; i<extensions.length; i++) {
-          // Try reading the content from files using each of the given extensions
-          resolvedPathWithExt = resolvedPath + extensions[i];
-          if (fs.existsSync(resolvedPathWithExt)) return true;
-        }
-        return false;
-      },
-      readFile: function(fileName) {
-        console.log('readFile - NOT IMPLEMENTED', fileName);
-      }
-    };
-  };
-};

scripts/docs/typescript-package/services/tsParser/createCompilerHost.spec.js

@@ -1,80 +0,0 @@
-var mockPackage = require('../../mocks/mockPackage');
-var Dgeni = require('dgeni');
-var path = require('canonical-path');
-var ts = require('typescript');
-
-describe('createCompilerHost', function() {
-  var dgeni, injector, options, host, baseDir, extensions;
-
-  beforeEach(function() {
-    dgeni = new Dgeni([mockPackage()]);
-    injector = dgeni.configureInjector();
-    var createCompilerHost = injector.get('createCompilerHost');
-
-    options = { charset: 'utf8' };
-    baseDir = path.resolve(__dirname, '../../mocks/tsParser');
-    extensions = ['.ts', '.js'];
-
-    host = createCompilerHost(options, baseDir, extensions);
-  });
-
-  describe('getSourceFile', function() {
-    it('should return a SourceFile object for a given path, with fileName relative to baseDir', function() {
-      var sourceFile = host.getSourceFile('testSrc.ts');
-      expect(sourceFile.fileName).toEqual('testSrc.ts');
-      expect(sourceFile.pos).toEqual(0);
-      expect(sourceFile.text).toEqual(jasmine.any(String));
-    });
-
-    it('should try each of the configured extensions and update the filename to the correct extension', function() {
-      var sourceFile = host.getSourceFile('testSrc.js');
-      expect(sourceFile.fileName).toEqual('testSrc.ts');
-
-      sourceFile = host.getSourceFile('../mockPackage.ts');
-      expect(sourceFile.fileName).toEqual('../mockPackage.js');
-    });
-  });
-
-
-  describe('getDefaultLibFileName', function() {
-    it('should return a path to the default library', function() {
-      expect(host.getDefaultLibFileName(options)).toContain('typescript/lib/lib.d.ts');
-    });
-  });
-
-
-  describe('writeFile', function() {
-    it('should do nothing', function() {
-      host.writeFile();
-    });
-  });
-
-
-  describe('getCurrentDirectory', function() {
-    it('should return the baseDir', function() {
-      expect(host.getCurrentDirectory()).toEqual(baseDir);
-    });
-  });
-
-
-  describe('useCaseSensitiveFileNames', function() {
-    it('should return true if the OS is case sensitive', function() {
-      expect(host.useCaseSensitiveFileNames()).toBe(ts.sys.useCaseSensitiveFileNames);
-    });
-  });
-
-
-  describe('getCanonicalFileName', function() {
-    it('should lower case the filename', function() {
-      var expectedFilePath = host.useCaseSensitiveFileNames() ? 'SomeFile.ts' : 'somefile.ts';
-      expect(host.getCanonicalFileName('SomeFile.ts')).toEqual(expectedFilePath);
-    });
-  });
-
-
-  describe('getNewLine', function() {
-    it('should return the newline character for the OS', function() {
-      expect(host.getNewLine()).toEqual(require('os').EOL);
-    });
-  });
-});

scripts/docs/typescript-package/services/tsParser/getContent.js

@@ -1,49 +0,0 @@
-var ts = require('typescript');
-var LEADING_STAR = /^[^\S\r\n]*\*[^\S\n\r]?/gm;
-
-module.exports = function getContent() {
-  return function(symbol) {
-
-    var content = "";
-
-    if (!symbol.declarations) return content;
-
-    symbol.declarations.forEach(function(declaration) {
-
-      // If this is left side of dotted module declaration, there is no doc comment associated with this declaration
-      if (declaration.kind === ts.SyntaxKind.ModuleDeclaration && declaration.body.kind === ts.SyntaxKind.ModuleDeclaration) {
-          return content;
-      }
-
-      // If this is dotted module name, get the doc comments from the parent
-      while (declaration.kind === ts.SyntaxKind.ModuleDeclaration && declaration.parent.kind === ts.SyntaxKind.ModuleDeclaration) {
-          declaration = declaration.parent;
-      }
-
-      // If this is a variable declaration then we get the doc comments from the grand parent
-      if (declaration.kind === ts.SyntaxKind.VariableDeclaration) {
-        declaration = declaration.parent.parent;
-      }
-
-      // Get the source file of this declaration
-      var sourceFile = ts.getSourceFileOfNode(declaration);
-      var commentRanges = ts.getJsDocComments(declaration, sourceFile);
-
-      if (commentRanges) {
-        commentRanges.forEach(function(commentRange) {
-          content += sourceFile.text
-              .substring(commentRange.pos+ '/**'.length, commentRange.end - '*/'.length)
-              .replace(LEADING_STAR, '')
-              .trim();
-          if (commentRange.hasTrailingNewLine) {
-            content += '\n';
-          }
-        });
-      }
-
-      content += '\n';
-    });
-
-    return content;
-  };
-};

scripts/docs/typescript-package/services/tsParser/getDirectiveInfo.js

@@ -1,34 +0,0 @@
-
-module.exports = function getDirectiveInfo() {
-
-  return function (symbol) {
-    var directiveInfo;
-    if (symbol.valueDeclaration) {
-      var decorators = symbol.valueDeclaration.decorators;
-      decorators && decorators.forEach(function(decorator){
-        try {
-          var expr = decorator.expression;
-          var type = expr.expression.text.match(/Component|Directive/);
-          if (type) {
-            // type is either Component or Directive
-            // properties are selector, inputs and outputs
-            directiveInfo = { type: type[0], properties: [] };
-
-            //Directive only takes one argument
-            expr.arguments[0].properties.forEach(function(prop){
-              var name = prop.name.text;
-              if (name === "selector") {
-                directiveInfo.properties.push({name: name, values: prop.initializer.text.split(",")});
-              }
-              if (name === "inputs" || name === "outputs") {
-                var values = prop.initializer.elements.map(function(e){ return e.text });
-                directiveInfo.properties.push({name: name, values: values });
-              }
-            });
-          }
-        } catch(e){}
-      });
-    }
-    return directiveInfo;
-  };
-};

scripts/docs/typescript-package/services/tsParser/getExportDocType.js

@@ -1,54 +0,0 @@
-var ts = require('typescript');
-
-module.exports = function getExportDocType(log) {
-
-  return function(symbol) {
-    if(symbol.flags & ts.SymbolFlags.Function) {
-      return 'function';
-    }
-    if(symbol.flags & ts.SymbolFlags.Class) {
-      return 'class';
-    }
-    if(symbol.flags & ts.SymbolFlags.Interface) {
-      return 'interface';
-    }
-    if(symbol.flags & ts.SymbolFlags.ConstEnum) {
-      return 'enum';
-    }
-    if(symbol.flags & ts.SymbolFlags.RegularEnum) {
-      return 'enum';
-    }
-    if(symbol.flags & ts.SymbolFlags.Property) {
-      return 'module-property';
-    }
-    if(symbol.flags & ts.SymbolFlags.TypeAlias) {
-      return 'type-alias';
-    }
-    if(symbol.flags & ts.SymbolFlags.FunctionScopedVariable) {
-      return 'var';
-    }
-    if(symbol.flags & ts.SymbolFlags.BlockScopedVariable) {
-      return getBlockScopedVariableDocType(symbol);
-    }
-
-    log.warn('getExportDocType(): Unknown symbol type', {
-      symbolName: symbol.name,
-      symbolType: symbol.flags,
-      symbolTarget: symbol.target,
-      file: ts.getSourceFileOfNode(symbol.declarations[0]).fileName
-    });
-    return 'unknown';
-  };
-
-  function getBlockScopedVariableDocType(symbol) {
-
-    var node = symbol.valueDeclaration;
-    while(node) {
-      if ( node.flags & 0x2000 /* const */) {
-        return 'const';
-      }
-      node = node.parent;
-    }
-    return 'let';
-  }
-};

scripts/docs/typescript-package/services/tsParser/getFileInfo.js

@@ -1,20 +0,0 @@
-var path = require('canonical-path');
-var ts = require('typescript');
-
-module.exports = function getFileInfo(log) {
-
-  return function (symbol, basePath) {
-    var fileName = ts.getSourceFileOfNode(symbol.declarations[0]).fileName;
-
-    var file = path.resolve(basePath, fileName);
-    var fileInfo = {
-      filePath: file,
-      baseName: path.basename(file, path.extname(file)),
-      extension: path.extname(file).replace(/^\./, ''),
-      basePath: basePath,
-      relativePath: fileName,
-      projectRelativePath: fileName
-    };
-    return fileInfo;
-  };
-};