Fix import namespace and wrapper examples

Author: Kevin Richter

package-lock.json

@@ -8,6 +8,7 @@
     "@mapcreator/maps4news": "^1.4.22",
     "esdoc": "^1.1.0",
     "esdoc-ecmascript-proposal-plugin": "^1.0.0",
+    "esdoc-importpath-plugin": "^1.0.2",
     "esdoc-standard-plugin": "^1.0.0",
     "swagger-ui": "^3.18.1"
   },
@@ -47,8 +48,19 @@
         "option": {
           "all": true
         }
+      },
+      {
+        "name": "esdoc-importpath-plugin",
+        "option": {
+          "stripPackageName": true,
+          "replaces": [
+            {
+              "from": "src",
+              "to": "@mapcreator/maps4news/src"
+            }
+          ]
+        }
       }
     ]
   }
-
 }

package.json

@@ -5,3 +5,4 @@
    - [API OpenAPI (Swagger) Definition](api/index.html)
  - [API Wrapper](wrapper.html)
    - [API Wrapper Class Documentation](/wrapper/index.html)
+ - [Basic Usage Examples](examples.html)

source/includes/v1/_directory.md

@@ -44,9 +44,9 @@ To Log in and try it out hit the "Try out" button and use `client_id` **2**.
 }
 ```
 
-All JSON responses from the API a wrapper in a base object.
+All JSON responses from the API is wrapped in a base object.
 
-Be sure to include an `Accept: application/json` header, otherwise errors like `401, 403 & 404` will either return HTML or redirect you to the login page.
+Be sure to include an `Accept: application/json` header, otherwise errors like `401`, `403` & `404` will either return HTML or redirect you to the login page.
 
 
 # Query Parameters
@@ -70,7 +70,9 @@ X-Page: 1
 X-Per-Page: 50
 ```
 
-By default de API returns 12 items per page. This can be increased to a maximum of 50 items per page.
+By default the API returns 12 items per page and defaults to page 1. 
+
+The number of items per page can be increased to a maximum of 50 items.
 
 ## Sorting
 
@@ -80,7 +82,7 @@ By default de API returns 12 items per page. This can be increased to a maximum
 ?sort=-id,name
 ```
 
-The API supports sorting ascending or descending sorting on multiple columns (seperated by a comma) on the resources.
+The API supports sorting ascending or descending sorting on multiple columns (separated by a comma) on the resources.
 
 **Sortable columns are whitelisted inside the API, there is currently no documentation on what columns are whitelisted**
 
@@ -92,7 +94,8 @@ The API supports sorting ascending or descending sorting on multiple columns (se
 ?search[name]=Kevin&search[company]=$:4News
 ```
 
-Searching can be done on multiple columns, we use the URL array syntax for this.  
+Searching can be done on multiple columns, we use the URL array syntax for this.
+
 The basic syntax is `operator:value`, so: `=:Maps4News`
 
 **The same is for searchable columns, these are whitelisted per resource**

source/v1/api.html.md

@@ -54,7 +54,7 @@ Details about how to build a map object can be found on the [map object page](di
 <br/>
 
 ```javascript--wrapper
-await revision.build();
+await revision.build("http://example.com/callback");
 ```
 
 Lastly, we can queue a build of your map. This will create a `JobResult` resource for that revision.

source/v1/examples.html.md

@@ -143,9 +143,14 @@ api.authenticate().then(function() {
 ```
 
 
-This will create a pop-up window containing the login page. Once the pop-up redirects back to the callback it will resolve the promise. The callback can be an empty page hosted on the same domain.
+This will create a pop-up window containing the login page.
+Once the pop-up redirects back to the callback it will resolve the promise.
+The callback can be an empty page hosted on the same domain.
 
-Callback url is set to the current url by default. The script is smart enough close the page if it detects that it's a child after authentication. This means that either the current page can be set as the callback (default) or a blank page. The callback must be hosted on the same domain as the application to allow for cross window communication.
+Callback url is set to the current url by default.
+The script is smart enough close the page if it detects that it's a child after authentication.
+This means that either the current page can be set as the callback (default) or a blank page.
+The callback must be hosted on the same domain as the application to allow for cross window communication.
 
 ## Dummy flow
 
@@ -171,6 +176,9 @@ The dummy flow can be used when a token *should* be present in the cache.
 
 # Basics
 
+These examples assume that an instance of the api exists and is authenticated. 
+See the node and web authentication examples for more information on authenticating.
+
 ```js
 const me = await api.users.get('me');
 const colors = await me.colors.list();
@@ -182,10 +190,13 @@ const colors = await me.colors.list();
 const colors = await api.users.select('me').colors.list();
 ```
 
-These examples assume that an instance of the api exists and is authenticated. 
-See the node and web authentication examples for more information on authenticating.
+The wrapper exposes relations which return proxies.
+These proxies can be used to either build a route to a resource or to fetch resources.
+This means that `api.users.get('me')` is the same as calling the route `/v1/users/me`.
+All proxies expose the methods `new`, `list` and `lister`.
+Most proxies expose the methods `select` and `get`.
 
-The wrapper exposes relations which return proxies. These proxies can be used to either build a route to a resource or to fetch resources. This means that `api.users.get('me')` is the same as calling the route `/v1/users/me`. All proxies expose the methods `new`, `list` and `lister`. Most proxies expose the methods `select` and `get`.   
+<br/><br/>
 
 ```js
 // Case translation
@@ -195,17 +206,18 @@ const data = {
 
 const test = api.static().new(data);
 
-test.fooBarBaz === 123;
+test.fooBarBaz === 123; // true
 ```
 
-The wrapper will transform snake_case named variables returned from the api into camelCase named variables. This means that for example `place_name` will be transformed into `placeName`. 
+The wrapper will transform snake_case named variables returned from the api into camelCase named variables.
+This means that for example `place_name` will be transformed into `placeName`.
 
 Async methods return a `Promise` this means that both `then/catch` and `await/async` syntax are supported.
 
 
 ## Getting a resource
 
-> Fetch resource and all it's properties
+> Fetch resource and all its properties
 
 ```js
 api.colors.get(1).then(function(color) {
@@ -223,12 +235,13 @@ api.users.select('me').mapstyleSets.list().then(function(sets) {
 });
 ```
 
-Resources are bound to the base api class by default. Resources can be fetched in 
-two ways; by selecting them (`.select`) or by fetching them (`.get`). Selecting them will only set the
-object's id to it's properties. Fetching a resource
+Resources are bound to the base api class by default. Resources can be fetched in two ways;
+by selecting them (`.select`) or by fetching them (`.get`). Selecting them will only set the
+object's id to its properties. Fetching a resource returns a `Promise` that will resolve with the requested resource.
+
+Selection is only useful as a stepping stone to related resources that can be easily obtained using the id of the parent.
 
-Selection is only useful as a stepping stone to related resources that can be easily obtained 
-using the id of the parent. Please refer to the api documentation for further reference.
+Please refer to the [api documentation](/wrapper/class/src/proxy/ResourceProxy.js~ResourceProxy.html) for further reference.
 
 ## Create a new resource
 
@@ -262,29 +275,6 @@ api.colors.get(1).then(color => {
 
 Setting the id to null forces the creation of a new object upon saving. 
 
-## Creating a new job and revision
-
-```js
-const object = {}; // Should contain the map definition
-
-const job = await api.jobs.new({
-  title: "api map", 
-  jobTypeId: 1
-}).save();
-
-const revision = await job.revisions.new({
-  mapstyleSetId: 1
-}).save(object);
-
-// Will resolve when the request finishes. Not when the build is done. 
-await revision.build("https://example.com/callback"); 
-```
-
-Creating a new job and building it is pretty straight forward.
-Revisions are slightly different then other resource instances.
-Their save function requires the new map definition as an argument.
-This is to make it easier to re-use the same revision instance.
-
 ## Pagination
 
 > Listing resources with pagination. First page with 5 items per page