Merge branch 'release/3.0.0-alpha1' into develop

Author: shprink

.editorconfig

@@ -0,0 +1,20 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -29,3 +29,4 @@ node_modules
 
 www/
 config.json
+typings

CHANGELOG.md

@@ -0,0 +1,4 @@
+<a name="3.0.0-alpha1"></a>
+### 3.0.0-alpha1 (2016-07-23)
+
+First version for ng2. 

README.md

@@ -1,96 +1,196 @@
 wp-api-angularjs
 ================
 
-AngularJS services to consume [WP-API v2](http://v2.wp-api.org/)
+Angular2 services to consume [WP-API v2](http://v2.wp-api.org/) (< 2.5kb gziped)
 
-## Documentation
-
-<http://shprink.github.io/wp-api-angularjs/>
+If you want to use AngularJS v1, here is the latest version: [v2.0.0-rc3](https://github.com/shprink/wp-api-angularjs/tree/v2.0.0-rc3)
 
 ## Installation
 
-### npm
+### Dependencies 
 
-```
-npm install wp-api-angularjs
-```
+make sure you have those packages installed:
 
-then import the dist file
+- '@angular/core'
+- '@angular/http'
+- 'rxjs'
 
-```
-# ES5
-require('wp-api-angularjs');
+### via npm
 
-# or ES6
-import 'wp-api-angularjs';
+```shell
+npm install wp-api-angularjs@v3.0.x
 ```
 
-### Bower
+## Bootstrap
 
-```
-bower install shprink/wp-api-angularjs
-```
 
-## Setup
+```js
+import {
+  WPAPI_PROVIDERS,
+  defaultWpApi
+} from 'wp-api-angularjs';
 
-To setup wp-api-angularjs in your app:
+import {App} from './app';
+
+bootstrap(App, [
+  WPAPI_PROVIDERS,
+  defaultWpApi({
+    baseUrl: "http://YOUR_DOMAIN/wp-json/",
+    namespace: '/wp/v2' // (optional, default: '/wp/v2')
+  })
+]);
 
 ```
-var app = angular.module('app', ['wp-api-angularjs']);
 
-app.config(function (WpApiProvider) {
-    WpApiProvider.setBaseUrl('http://www.example.com/wp-json/');
-});
+## API
 
-app.controller('PostsController', ['$scope', '$wpApiPosts', PostsController]);
+Every method return an Obervable. If you want to get a Promise you will need to add the rxjs `toPromise` operator:
 
-function PostsController($scope, $wpApiPosts) {
-    $scope.posts = [];
+```js
+import 'rxjs/add/operator/toPromise';
 
-    $wpApiPosts.getList({
-        page: 1,
-        per_page: 10
-    }).then(function (posts) {
-        $scope.posts = posts.data;
-    });
+class Test {
+  constructor(private wpApiPosts: WpApiPosts) {
+    this.wpApiPosts.getList()
+      .toPromise()
+      .then(response => response.json())
+      .then(body => {})
+      .catch(error => {})
+  }
 }
 
+```
 
+### RequestOptionsArgs
+
+Every request can have an optional [`RequestOptionsArgs`](https://angular.io/docs/ts/latest/api/http/index/RequestOptionsArgs-interface.html) object.
+
+```js
+class RequestOptionsArgs {
+  url : string
+  method : string|RequestMethod
+  search : string|URLSearchParams
+  headers : Headers
+  body : any
+  withCredentials : boolean
+}
 ```
 
-## Authentication
+This is where you can add query string to your request or change the headers.
+
+### WpApiPosts
+
+```ts
+  getList(options?: RequestOptionsArgs): Observable<Response>;
+  get(postId, options?: RequestOptionsArgs): Observable<Response>;
+  create(body: any, options?: RequestOptionsArgs): Observable<Response>;
+  update(postId, body: any, options?: RequestOptionsArgs): Observable<Response>;
+  delete(postId, options?: RequestOptionsArgs): Observable<Response>;
+  getMetaList(postId, options?: RequestOptionsArgs): Observable<Response>;
+  getMeta(postId, metaId, options?: RequestOptionsArgs): Observable<Response>;
+  getRevisionList(postId, options?: RequestOptionsArgs): Observable<Response>;
+  getRevision(postId, revisionId, options?: RequestOptionsArgs): Observable<Response>;
+  getCategoryList(postId, options?: RequestOptionsArgs): Observable<Response>;
+  getCategory(postId, categoryId, options?: RequestOptionsArgs): Observable<Response>;
+  getTagList(postId, options?: RequestOptionsArgs): Observable<Response>;
+  getTag(postId, tagId, options?: RequestOptionsArgs): Observable<Response>;
+```
+
+### WpApiPages
+
+```ts
+  getList(options?: RequestOptionsArgs): Observable<Response>;
+  get(pageId: number, options?: RequestOptionsArgs): Observable<Response>;
+  create(body: any, options?: RequestOptionsArgs): Observable<Response>;
+  update(pageId: number, body: any, options?: RequestOptionsArgs): Observable<Response>;
+  delete(pageId: number, options?: RequestOptionsArgs): Observable<Response>;
+  getMetaList(pageId: number, options?: RequestOptionsArgs): Observable<Response>;
+  getMeta(pageId: number, metaId: number, options?: RequestOptionsArgs): Observable<Response>;
+  getRevisionList(pageId: number, options?: RequestOptionsArgs): Observable<Response>;
+  getRevision(pageId: number, revisionId: number, options?: RequestOptionsArgs): Observable<Response>;
+```
 
-This library only supports basic auth. OAuth1 not being suitable for JS clients (it would mean exposing key and password out of the open)
+### WpApiComments
 
-### Basic auth
+```ts
+  getList(options?: RequestOptionsArgs): Observable<Response>;
+  get(commentId: number, options?: RequestOptionsArgs): Observable<Response>;
+  create(body: any, options?: RequestOptionsArgs): Observable<Response>;
+  update(commentId: number, body: any, options?: RequestOptionsArgs): Observable<Response>;
+  delete(commentId: number, options?: RequestOptionsArgs): Observable<Response>;
+```
+
+### WpApiTypes
 
-Basic auth is only secured to use if used during the app run time and used with a secured connection to your Blog (via SSL).
+```ts
+  getList(options?: RequestOptionsArgs): Observable<Response>;
+  get(postType: string, options?: RequestOptionsArgs): Observable<Response>;
+```
 
-#### During run time
+### WpApiMedia
 
-Make sure your WP-API runs with an SSL certificate (https) otherwise this will expose your credentials at every request.
+```ts
+  getList(options?: RequestOptionsArgs): Observable<Response>;
+  get(mediaId: number, options?: RequestOptionsArgs): Observable<Response>;
+  create(body: any, options?: RequestOptionsArgs): Observable<Response>;
+  update(mediaId: number, body: any, options?: RequestOptionsArgs): Observable<Response>;
+  delete(mediaId: number, options?: RequestOptionsArgs): Observable<Response>;
+```
 
-Display a form for users to connect and use the following code to register credentials:
+### WpApiUsers
 
+```ts
+  getList(options?: RequestOptionsArgs): Observable<Response>;
+  me(options?: RequestOptionsArgs): Observable<Response>;
+  get(userId: number, options?: RequestOptionsArgs): Observable<Response>;
+  create(body: any, options?: RequestOptionsArgs): Observable<Response>;
+  update(userId: number, body: any, options?: RequestOptionsArgs): Observable<Response>;
+  delete(userId: number, options?: RequestOptionsArgs): Observable<Response>;
 ```
-.controller(function(WpApi){
-    WpApi.setBasicCredentials(<login>, <password>);
-});
+
+### WpApiTaxonomies
+
+```ts
+  getList(options?: RequestOptionsArgs): Observable<Response>;
+  get(taxonomiesType: string, options?: RequestOptionsArgs): Observable<Response>;
 ```
 
-#### During configuration
+### WpApiStatuses
+
+```ts
+  getList(options?: RequestOptionsArgs): Observable<Response>;
+  get(statusesName: string, options?: RequestOptionsArgs): Observable<Response>;
+```
 
-You can also set basic credentials during the configuration but use this should only be used for testing as it embed credentials in the application code.
+### WpApiTerms
 
+`taxonomiesType` can be `tags`, `categories` and more.
+
+```ts
+  getList(taxonomiesType: string, options?: RequestOptionsArgs): Observable<Response>;
+  get(taxonomiesType: string, termId: number, options?: RequestOptionsArgs): Observable<Response>;
+  create(taxonomiesType: string, body: any, options?: RequestOptionsArgs): Observable<Response>;
+  update(taxonomiesType: string, termId: number, body: any, options?: RequestOptionsArgs): Observable<Response>;
+  delete(taxonomiesType: string, termId: number, options?: RequestOptionsArgs): Observable<Response>;
 ```
-.config(function(WpApiProvider){
-    WpApiProvider.setBasicCredentials(<login>, <password>);
-});
+
+### WpApiCustom
+
+```ts
+  getList(options?: RequestOptionsArgs): Observable<Response>;
+  get(customId: number, options?: RequestOptionsArgs): Observable<Response>;
+  create(body: any, options?: RequestOptionsArgs): Observable<Response>;
+  update(customId: number, body: any, options?: RequestOptionsArgs): Observable<Response>;
+  delete(customId: number, options?: RequestOptionsArgs): Observable<Response>;
 ```
 
+## Authentication
+
+TO BE DEFINED
+
 ## Contribute
 
-```
+```shell
 npm install
 cp config.dist.json config.json