Merge pull request #205 from kuzzleio/2.0.0-rc4-proposal

Release 2.0.0 rc4 proposal

Author: Adrien Maret

.eslintrc.json

@@ -4,22 +4,29 @@
   "rules": {
     "@typescript-eslint/ban-ts-comment": "off",
     "@typescript-eslint/ban-ts-ignore": "off",
+    "@typescript-eslint/no-shadow": "error",
+    "@typescript-eslint/no-unused-vars": ["error"],
+    "brace-style": ["error", "stroustrup"],
+    "comma-spacing": 2,
     "consistent-return": 0,
     "curly": 2,
     "dot-notation": 2,
     "eqeqeq": 2,
     "func-names": ["error", "always"],
     "guard-for-in": 2,
     "indent": [2, 2, {"SwitchCase": 1}],
+    "key-spacing": ["error", { "afterColon": true }],
+    "keyword-spacing": ["error", { "before": true, "after": true }],
     "linebreak-style": [2, "unix"],
     "new-cap": 1,
     "no-caller": 2,
     "no-catch-shadow": 2,
     "no-console": 2,
     "no-else-return": 2,
+    "no-empty": ["error", { "allowEmptyCatch": true }],
+    "no-eval": 2,
     "no-extend-native": 2,
     "no-extra-bind": 2,
-    "no-eval": 2,
     "no-implicit-coercion": 2,
     "no-implied-eval": 2,
     "no-invalid-this": 2,
@@ -39,31 +46,28 @@
     "no-return-assign": 2,
     "no-self-compare": 2,
     "no-sequences": 2,
-    "no-shadow": 2,
+    "no-shadow": "off",
     "no-shadow-restricted-names": 2,
     "no-throw-literal": 2,
     "no-undef": 2,
     "no-undef-init": 1,
     "no-unreachable": 2,
     "no-unused-expressions": [2, {"allowShortCircuit": true}],
+    "no-unused-vars": "off",
     "no-useless-call": 2,
     "no-with": 2,
+    "object-curly-spacing": ["error", "always"],
+    "object-shorthand": ["error", "always"],
     "quotes": [2, "single"],
     "require-atomic-updates": 0,
     "semi": [2, "always"],
-    "space-before-blocks": 2,
-    "strict": [2, "global"],
-    "vars-on-top": 2,
-    "yoda": [2, "never"],
     "sort-keys": ["error", "asc"],
-    "keyword-spacing": ["error", { "before": true, "after": true }],
-    "object-curly-spacing": ["error", "always"],
+    "space-before-blocks": 2,
     "space-before-function-paren": ["error", "always"],
-    "comma-spacing": 2,
-    "brace-style": ["error", "stroustrup"],
     "space-infix-ops": 2,
     "space-unary-ops": [2, { "words": true, "nonwords": false, "overrides": { "!": true } }],
-    "key-spacing": ["error", { "afterColon": true }]
+    "strict": [2, "global"],
+    "vars-on-top": 2
   },
   "overrides": [
     {

.gitignore

@@ -20,6 +20,12 @@ lib/**/*.js
 features/fixtures/application/**/*.d.ts
 features/fixtures/application/**/*.js
 features/fixtures/application/**/*.js.map
+
+features/fakeclasses/**/*.d.ts
+features/fakeclasses/**/*.js
+features/fakeclasses/**/*.js.map
+
+
 index.d.ts
 index.js
 index.js.map
@@ -28,4 +34,4 @@ index.js.map
 doc/framework
 frontmatter-errors.json
 
-.vscode
+.vscode

doc/1/classes/relationalController/index.md

@@ -0,0 +1,34 @@
+---
+code: true
+type: page
+title: RelationalController
+description: Kuzzle IoT - RelationalController class
+---
+
+# RelationalController
+
+RelationalController is an abstract class that can be extend to create controller for entity that can be linked with other entities.
+It present different method to create, update and remove the relations, and to automatically update document that contain a copy of another document.
+The relation can be "embedded" or "nested". 
+
+# Nested relation
+
+An embedded relation is a relation that is symbolised by a string that contain the id of the linked document.
+There is no invert relation : the linked document do not know which document link it. 
+The link will be automatically removed when the object is removed calling genericDelete.
+
+# Embedded relation
+
+An embedded relation is a relation when an object contain a copy of the other object. 
+The embedded object contain a link to the container object. 
+Link are represented in the embedded document as FieldPath : A fieldPath contain the index, the collection, the id of the document and the field that contain the copy.
+Link are necessary to do edition propagation : When we edit an embedded object, each object that contain a copy must have its copy updated. When we remove an embedded object, each copy will be removed to.
+
+# Dead link and lazy deleting
+When we remove a container object, we do not have informations about where does the embbedded document come from (index, collection, field) so we cannot remove the fieldPath that represent the link in the embedded document.
+That should be ok, because fieldPath are designed for internal use in RelationalController.
+But if a custom code should exploit information in FieldPath, it must take dead link into consideration. 
+FieldPath will be removed when we try to propagate an edition : if the FieldPath is a dead link (referenced object is deleted), it will be deleted. 
+
+
+

doc/2/controllers/asset-category/create/index.md

@@ -0,0 +1,83 @@
+---
+code: true
+type: page
+title: create
+description: Creates a new asset-category
+---
+
+# create
+
+Creates a new asset-category inside a tenant index.
+
+Returns an error if the document already exists.
+
+See also the [document:create](/core/2/api/controllers/document/create) API action.
+
+---
+
+## Query Syntax
+
+### HTTP
+
+```http
+URL: http://kuzzle:7512/_/device-manager/:engineId/assetCategory[?refresh=wait_for]
+Method: POST
+Body:
+```
+
+```js
+{
+  // asset content
+  //Exemple :
+  {"name" : "myAsset"}
+}
+```
+
+### Other protocols
+
+```js
+{
+  "engineId": "<index>",
+  "controller": "device-manager/assetCategory",
+  "action": "create",
+  "body": {
+    // asset content
+  }
+}
+```
+
+### Kourou
+
+```bash
+kourou device-manager/assetCategory:create <engineId> --body '{ 
+  name: "<asset category name>"
+  }'
+```
+
+---
+
+## Arguments
+
+- `engineId`: engine id
+
+### Optional:
+
+- `refresh`: if set to `wait_for`, Kuzzle will not respond until the newly created document is indexed
+---
+
+## Body properties
+
+Asset content to create.
+
+Assets must contains at least the following properties:
+- `name`: Asset category name.
+
+---
+
+## Response
+
+Returns an object with the following properties:
+
+- `_id`: created document unique identifier
+- `_source`: document content
+- `_version`: version of the created document (should be `1`)

doc/2/controllers/asset-category/delete/index.md

@@ -0,0 +1,60 @@
+---
+code: true
+type: page
+title: delete
+description: Deletes an asset-category
+---
+
+# delete
+
+Deletes an asset-category.
+
+See also the [document:delete](/core/2/api/controllers/document/delete) API action.
+
+---
+
+## Query Syntax
+
+### HTTP
+
+```http
+URL: http://kuzzle:7512/_/device-manager/:engineId/assetCategory/:_id[?refresh=wait_for][&source]
+Method: DELETE
+```
+
+### Other protocols
+
+```js
+{
+  "engineId": "<engineId>",
+  "controller": "device-manager/assetCategory",
+  "action": "delete",
+  "_id": "<assetCategoryId>"
+}
+```
+
+### Kourou
+
+```bash
+kourou device-manager/assetCategory:delete <engineId> --id <assetCategoryId>
+```
+
+---
+
+## Arguments
+
+- `engineId`: engine id
+- `_id`: id of element to delete
+
+### Optional:
+
+- `refresh`: if set to `wait_for`, Kuzzle will not respond until the delete is indexed
+- `source`: if set to `true` Kuzzle will return the entire deleted document body in the response.
+
+---
+
+## Response
+
+Returns information about the deleted assetCategory:
+
+- `_id`: assetCategory unique identifier

doc/2/controllers/asset-category/get/index.md

@@ -0,0 +1,80 @@
+---
+code: true
+type: page
+title: delete
+description: Deletes an asset-category
+---
+
+# get
+
+Get an asset-category.
+
+You can also use [document:get](/core/2/api/controllers/document/get) API action if you have proper rights, but if you use this specific controller, the data is preprocessed and easier to use.
+
+---
+
+## Query Syntax
+
+### HTTP
+
+```http
+URL: http://kuzzle:7512/_/device-manager/:engineId/assetCategory/:_id
+Method: GET
+```
+
+### Other protocols
+
+```js
+{
+  "engineId": "<engineId>",
+  "controller": "device-manager/assetCategory",
+  "action": "get",
+  "_id": "<assetCategoryId>"
+}
+```
+
+### Kourou
+
+```bash
+kourou device-manager/assetCategory:get <engineId> --id <assetCategoryId>
+```
+
+---
+
+- `engineId`: engine id
+
+---
+
+## Response
+
+```js
+{
+    "action": "get",
+    "controller": "device-manager/assetCategory",
+    "error": null,
+    "headers": {},
+    "node": "knode-accessible-orwell-15416",
+    "requestId": "8fd1b8b5-1dfd-4fba-a12f-4b570622980e",
+    "result": {
+        "name": "myCategory",
+        "assetMetadata": [
+            {
+                "mandatory": true,
+                "name": "myMetadata",
+                "valueType": "string"
+            },
+            {
+                "mandatory": true,
+                "name": "myOtherMetadata",
+                "valueType": "string"
+            }
+        ],
+        "metadataValues": {
+            "myMetadata": "myValue"
+        }
+    },
+    "status": 200,
+    "volatile": null
+}
+```
+

doc/2/controllers/asset-category/index.md

@@ -0,0 +1,6 @@
+---
+code: true
+type: branch
+title: asset-category
+description: Kuzzle IoT - Device Manager AssetCategory Controller
+---