Merge pull request #1225 from Urigo/feature/angular2-api-reference

Added Angular2-Meteor API Reference

Author: Urigo

docs/angular-meteor/both/router/api-docs/1.2.2.js renamed to docs/angular-meteor/both/router/api-docs/angular1-meteor/1.2.2.js

@@ -1,4 +1,4 @@
-API_DEFINITION = {
+ANGULAR1_API_DEFINITION = {
   '1.3.2': API_1_3_2('1.3.2', '1.3.1'),
   '1.3.1': API_1_3_1('1.3.1'),
   '1.3.0': API_1_3_0('1.3.0', '1.2.2'),
@@ -7,4 +7,4 @@ API_DEFINITION = {
   '1.2.0': API_1_2_2('1.2.0', '1.2.2')
 };
 
-DEFAULT_API = '1.3.2';
+ANGULAR1_DEFAULT_API = '1.3.2';

docs/angular-meteor/both/router/api-docs/1.3.0.js renamed to docs/angular-meteor/both/router/api-docs/angular1-meteor/1.3.0.js

@@ -0,0 +1,37 @@
+ANGULAR2_API_0_4_2 = function(version, basedOnTemplatesOf) {
+  var urlBase = '/api/angular2/' + version + '/';
+  var templatePrefix = basedOnTemplatesOf || version;
+
+  return {
+    groups: [
+      {
+        id: "0",
+        title: "",
+        route: "api",
+        path: urlBase,
+        redirectRoute: "/api/angular2/" + version + "/meteorComponent",
+        template: "api",
+        seoTitleSuffix: " | Angular2 Meteor API",
+        seoDesc: "angular2-meteor is a realtime full stack that combines the best frameworks. use your existing Angular2.0 applications with Meteor - the best backend framework for AngularJS 2.0 applications.",
+        pages: [
+          {
+            id: "01",
+            route: "api.angular2." + version + ".meteorComponent",
+            path: urlBase + "meteorComponent",
+            title: "MeteorComponent",
+            seoTitle: "MeteorComponent",
+            mdContent: "api.angular2." + templatePrefix + ".meteorComponent"
+          },
+          {
+            id: "02",
+            route: "api.angular2." + version + ".bootstrap",
+            path: urlBase + "bootstrap",
+            title: "bootstrap",
+            seoTitle: "bootstrap",
+            mdContent: "api.angular2." + templatePrefix + ".bootstrap"
+          }
+        ]
+      }
+    ]
+  }
+};

docs/angular-meteor/both/router/api-docs/1.3.1.js renamed to docs/angular-meteor/both/router/api-docs/angular1-meteor/1.3.1.js

@@ -0,0 +1,5 @@
+ANGULAR2_API_DEFINITION = {
+  '0.4.2': ANGULAR2_API_0_4_2('0.4.2')
+};
+
+ANGULAR2_DEFAULT_API = '0.4.2';

docs/angular-meteor/both/router/api-docs/1.3.2.js renamed to docs/angular-meteor/both/router/api-docs/angular1-meteor/1.3.2.js

@@ -161,32 +161,39 @@ Router.map(function () {
   });
 
   var directedRouteNames = [];
-  for (var apiKey in API_DEFINITION) {
-    var currentApi = API_DEFINITION[apiKey];
-
-    for (var coreAPI in currentApi.groups[0].pages) {
-      var routeName = currentApi.groups[0].pages[coreAPI].route;
-      routeName = routeName.slice(routeName.lastIndexOf('.') + 1);
-      var redirectFrom = '/api/' + routeName;
-      var redirectTo = '/api/' + apiKey + '/' + routeName;
-      if (!_.contains(directedRouteNames, routeName)) {
-        redirect(redirectFrom, redirectTo);
-        directedRouteNames.push(routeName);
+
+  var createApiRoutes = function(apisDefs, appendToLinks){
+    for (var apiKey in apisDefs) {
+      var currentApi = apisDefs[apiKey];
+
+      for (var coreAPI in currentApi.groups[0].pages) {
+        var routeName = currentApi.groups[0].pages[coreAPI].route;
+        routeName = routeName.slice(routeName.lastIndexOf('.') + 1);
+        var redirectFrom = '/api/' + appendToLinks + routeName;
+        var redirectTo = '/api/' + appendToLinks + apiKey + '/' + routeName;
+        if (!_.contains(directedRouteNames, routeName)) {
+          redirect(redirectFrom, redirectTo);
+          directedRouteNames.push(routeName);
+        }
       }
-    }
 
-    createSubRoutes(currentApi);
+      createSubRoutes(currentApi);
 
-    (function (routeUrl) {
-      if (routeUrl) {
-        Router.route('/api/' + apiKey, function () {
-          this.redirect(routeUrl);
-        });
-      }
-    })(currentApi.groups[0].redirectRoute);
-  }
+      (function (routeUrl) {
+        if (routeUrl) {
+          Router.route('/api/' + appendToLinks + apiKey, function () {
+            this.redirect(routeUrl);
+          });
+        }
+      })(currentApi.groups[0].redirectRoute);
+    }
+  };
+
+  createApiRoutes(ANGULAR1_API_DEFINITION, '');
+  createApiRoutes(ANGULAR2_API_DEFINITION, 'angular2');
 
-  redirect('/api', '/api/' + DEFAULT_API + '/helpers');
+  redirect('/api', '/api/' + ANGULAR1_DEFAULT_API + '/helpers');
+  redirect('/api/angular2', '/api/angular2/' + ANGULAR2_DEFAULT_API + '/meteorComponent');
 
   // -------------------------------------------------------------------------
   // Migration routes

docs/angular-meteor/both/router/api-docs/api_list.js renamed to docs/angular-meteor/both/router/api-docs/angular1-meteor/api_list.js

@@ -10,7 +10,8 @@ PAGES = [
     seoTitlePrefix: "Angular Meteor Tutorial | ",
     subHead: "Build your first Angular Meteor app",
     stepbarHide: true,
-    pages: SOCIALLY_ANGULAR1
+    pages: SOCIALLY_ANGULAR1,
+    apiPath: '/api/'
   },
   {
     id: "2",
@@ -23,7 +24,8 @@ PAGES = [
     seoTitlePrefix: "Angular 2.0 Meteor Tutorial | ",
     subHead: "Angular 2.0 Meteor tutorial",
     stepbarHide: true,
-    pages: SOCIALLY_ANGULAR2
+    pages: SOCIALLY_ANGULAR2,
+    apiPath: '/api/angular2/'
   },
   {
     id: "3",

docs/angular-meteor/both/router/api-docs/angular2-meteor/0.4.2.js

@@ -0,0 +1,80 @@
+<template name="api.angular2.0.4.2.bootstrap">
+  <div>
+    <a href="https://github.com/Urigo/angular-meteor/edit/master/docs/angular-meteor/client/content/api-reference/angular2-meteor/0.4.2/api.bootstrap.html"
+       class="btn btn-default btn-lg improve-button">
+      <i class="glyphicon glyphicon-edit">&nbsp;</i>Improve this doc
+    </a>
+
+    <do-nothing>
+        {{#markdown}}
+
+# bootstrap
+
+`bootstrap` method provides the basic application bootstrap process, it also adds support for iterating `Mongo.Cursor` object withing `ngFor`.
+
+This is a wrapper for Angular2 `bootstrap`, which documented [here](https://angular.io/docs/ts/latest/api/platform/browser/bootstrap-function.html).
+
+#### Usage Example
+
+When working with TypeScript, import `bootstrap` method from `angular2-meteor` package, as follow:
+
+    import {bootstrap} from 'angular2-meteor';
+
+And use it with your main application class,
+
+    @Component({
+        selector: 'app'
+    })
+    @View({
+        template: 'Hello World!'
+    })
+    class App {
+
+    }
+
+    bootstrap(App);
+
+
+## API Reference
+
+<table class="variables-matrix input-arguments">
+  <thead>
+  <tr>
+    <th>Argument Name</th>
+    <th>Type</th>
+    <th>Description</th>
+    <th>Default Value</th>
+    <th>Required</th>
+  </tr>
+  </thead>
+  <tbody>
+  <tr>
+    <td><strong>appComponentType</strong></td>
+    <td>
+      <a href="" class="label type-hint type-hint-class">class</a>
+    </td>
+    <td><p> The root component which should act as the application.</p>
+
+    </td>
+    <td><a href="" class="label type-hint type-hint-object">Yes</a></td>
+  </tr>
+  <tr>
+    <td>customProviders</td>
+    <td>
+      <a href="" class="label type-hint type-hint-array">array</a>
+    </td>
+    <td><p> An additional set of providers that can be added to the app injector to override default injection behavior. </p>
+
+    </td>
+    <td></td>
+    <td><a href="" class="label type-hint type-hint-object">No</a></td>
+  </tr>
+  </tbody>
+</table>
+
+        {{/markdown}}
+
+    </do-nothing>
+
+  </div>
+</template>