Merge pull request #287 from harena-lab/development

Development

Gemfile.lock

@@ -67,7 +67,7 @@ GEM
       jekyll-theme-time-machine (= 0.1.1)
       jekyll-titles-from-headings (= 0.5.3)
       jemoji (= 0.12.0)
-      kramdown (= 2.3.0)
+      kramdown (= 2.3.1)
       kramdown-parser-gfm (= 1.1.0)
       liquid (= 4.0.3)
       mercenary (~> 0.3)

src/adonisjs/package.json

@@ -27,7 +27,7 @@
     "@adonisjs/session": "^1.0.29",
     "@adonisjs/shield": "^1.0.8",
     "@adonisjs/validator": "^5.0.6",
-    "axios": "^0.19.2",
+    "axios": "^0.21.1",
     "form-data": "^3.0.0",
     "mysql": "^2.16.0",
     "npm": "^6.14.7"

src/adonisjs/public/author/js/author.js

@@ -793,7 +793,7 @@ class AuthorManager {
 
       // finding the next nonblank node
       let pos
-      if (position = 'previous') { pos = (contentSel[elSel - 1].type == 'linefeed') ? elSel - 2 : elSel - 1 } else { pos = (contentSel[elSel + 1].type == 'linefeed') ? elSel + 2 : elSel + 1 }
+      if (position == 'previous') { pos = (contentSel[elSel - 1].type == 'linefeed') ? elSel - 2 : elSel - 1 } else { pos = (contentSel[elSel + 1].type == 'linefeed') ? elSel + 2 : elSel + 1 }
 
       // exchanging sequence ids
       const elSeq = contentSel[elSel].seq

src/adonisjs/public/dccs/base/dcc-block.js

@@ -34,7 +34,11 @@ class DCCBlock extends DCCVisual {
       this.location = locationM.message
     }
 
-    if (document.readyState === 'complete') { this._renderInterface() } else { window.addEventListener('load', this._renderInterface) }
+    if (document.readyState === 'complete') {
+      this._renderInterface()
+    } else {
+      window.addEventListener('load', this._renderInterface)
+    }
   }
 
   /* Attribute Handling */

src/adonisjs/public/dccs/components/control/dcc-compute.js

@@ -14,13 +14,14 @@ class DCCCompute extends DCCBase {
     if (this.hasAttribute('expression')) {
       this._compiled =
         DCCCompute.compileStatementSet(this.expression.toLowerCase())
-      if (this._compiled != null && this.onload)
+      if (this._compiled != null && this.onload) {
         await this.update()
         if (this.active) {
           const variables = DCCCompute.filterVariables(this._compiled, false)
           for (let v of variables)
             MessageBus.ext.subscribe('var/' + v + '/set', this.update)
         }
+      }
     }
 
     if (this.hasAttribute('id'))

src/adonisjs/public/infra/README.md

@@ -1,159 +1,12 @@
-# Harena Message Protocol
-## Topic Structure and Wildcards
-The wildcards standard is based in the MQTT 3.1.1, as specified in the document: [MQTT Version 3.1.1](http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html), Section 4.7.1 Topic wildcards.
+# Harena General Specifications
 
-Extra information is based on:
-The HiveMQ Team. MQTT Essentials Part 5: MQTT Topics & Best Practices. February 9, 2015. online: https://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices/.
-## Topic Name Structure
+## Message Protocols
 
-Whenever a message is published or subscribed a **Topic Name** is specified. It is a hierarchical structure composed by one or more **Topic Levels** separated by slashes `/` (the **Topic Level Separators**).
-
-* **Topic Level** - Is a label formed with alphanumeric characters, and can also have: white space, underscore and minus.
-
-## Best Practices
-The following best practices have been adopted in the Harena project and must be followed by all developers. They are derived from [MQTT Essentials Part 5: MQTT Topics & Best Practices](https://www.hivemq.com/blog/mqtt-essentials-part-5-mqtt-topics-best-practices/).
-
-* **Never use a leading forward slash** - A Topic Name can optionally start and/or end by a slash `/`, but it adds an extra unnecessary level, therefore they are not adopted in Harena.
-
-* **Never use spaces in a topic** - Even though MQTT supports spaces, they are not used in Harena.
-
-## Topic Filters and Wildcards
-
-In the subscription process, it is possible to specify a specific Topic Name or a Topic Filter, which works as a regular expression representing a set of possible Topic Names.
-
-Wildcards are represented by the special `#` and/or `+` characters, appearing inside a Topic Name in the subscription process. They enable the subscription of a set of topics, since they generically represent one or more Topic Levels, according to the following rules:
-
-### Multilevel Wildcard `#`
-
-The wildcard `#` can be used only in two positions in the Topic Filter:
-* alone (the filter is only a `#`) - matches any Topic Name with any number of levels;
-* end of the Topic Name (always preceded by a `/ `) -  matches any number of Topic Levels with the prefix specified before the wildcard.
-
-### Single Level Wildcard `+`
-Only a single Topic Level can be matched by the wildcard  `+`, which represents any possible complete Topic Level Label. The `+` wildcard can appear only in four positions:
-* alone (the filter is only a `+`) - matches any Topic Label in a single level (without slashes);
-* beginning of the Topic Filter, always followed by a slash;
-* end of the Topic Filter, always preceded by a slash;
-* middle of the Topic Filter, always between two slashes.
-
-# Message Paths in the Bus
-
-## Control Actions
-
-General protocol: `control/<entity>/<action>`.
-
-Most of the control actions trigger the final action, for example, the `control/case/load` control action is the start of the process to trigger the `case/<case id>/load` action.
-
-Levels of detail:
-* `case`
-* `knot`
-* `element`
-
-
-* `control/case/load`
-* `control/case/selected`
-
-* `control/case/save`
-* `control/case/play`
-* `control/knot/edit`
-* `control/config/edit`
-
-## Persisted Messages
-
-All the internal paths are mapped to the external paths prefixing the path by: `/execution/<instance id>`, where `<instance id>` is the id of the case instance that is being executed.
-
-### Entity: `template_family`
-* `template_family/*/get` - Returns the list of the available template families.
-
-  response topic: `template_family/*`
-           message: `{<template_family id>: <template_family icon>}`
-
-### Entity: `template`
-* `data/theme/<template_family id>.<template id>/get` - Loads and returns the HTML of the template.
-
-  response topic: `data/theme/<template_family id>.<template id>`
-           message: `<template HTML>`
-
-
-### Entity: `case`
-* `case/*/get` - Returns the list of the available cases.
-
-  response topic: `case/*`
-           message: `{<case id>: <case icon>}`
-
-* `case/<case id>/get` - Loads and returns the markdown of the case.
-
-  response topic: `case/<case id>`
-           message: `<case markdown>`
-
-* `case/<case id>/set` - Saves the case in a markdown or object format (according to the format specified in the message).
-
-  message: `{format: "markdown" | "json", source: <case source>}`
-
-  * markdown format
-
-    response topic: `case/<case id>/version`
-           message: `<version id>` - id of the previous case version.
-
-  * object format
-
-    response topic: `case/<case id>/set/status`
-           message: `<status>` - status of the opperation.
-
-### Entity: `knot`
-`<knot title>` - The title given by the author to the knot in the case.
-`<knot id>` - Uniquely identifies a knot. Derived from the knot title replacing spaces for underscores (as we do not use spaces in the topics).
-
-* `knot/<knot id>/selected` - A knot has been selected in the authoring environment.
-
-  message: `<knot title>`
-
-* `knot/<knot id>/navigate` - The player navigates to a specific knot.
-* `knot/</navigate`
-* `knot/<</navigate`
-
-### Entity: `variable`
-
-Variable input cycle:
-  * `var/<variable>/input/ready`
-  * `var/<variable>/typed`
-  * `var/<variable>/changed`
-  * `var/<variable>/set`
-  * `var/<variable>/input/end`
-
-#### Details
-
-* `var/<variable>/typed` - Notifies that the user typed part of an input.
-
-  message: `{sourceType: "dcc-input", value: <value>}`
-
-* `var/<variable>/changed` - Notifies a change em the input variable.
-
-  message: `{sourceType: "dcc-input", value: <value>}`
-
-* `var/<variable>/set` - Notifies the input of a value by the user related to a `<variable>`.
-
-  message: `{sourceType: "dcc-input", value: "<value>"}`
-
-## Messages Not Persisted
-
-Messages to coordinate DCCs.
-
-### Entity: `dcc-block`
-
-Operations:
-* `get xstyle` \[`/dcc-block/get/xstyle`\] - Requests to a DCC Styler the styling policy.
-
-  return: \[`/dcc-block/xstyle`\] - one of the following values:
-  * `in ` - default style defined inside the DCC;
-  * `none` - no style defined;
-  * `out` - style defined externally.
-
-### Entity: `dcc-state-select`
-
-Operations:
-* `get states` \[`/dcc-state-select/get/states`\] - Requests for an upper level DCC (e.g., an aggregattor DCC) or a group coordinator DCC the set of possible states present in the selector.
-
-  return: \[`/dcc-state-select/states`\] - List of states separated by commas.
+The general rules to build Harena messages is based on:
+* [DCCs Message Protocol](/harena-docs/dccs/message/)
 
+The Harena specific message protocol:
+* [Harena Message Protocol](message/)
 
+The Development Guides has a section explaining Javascript implementation details of exchanging messages through the bus:
+* [DCCs Development Guide](/harena-docs/dccs/development/)

src/adonisjs/public/templates/simple/case/pocus_training-static.md

@@ -23,3 +23,4 @@ ___ Data ___
       * Soft Parts: simple/knot/pt_soft
       * Articulate: simple/knot/pt_articulate
       * Ocular: simple/knot/pt_ocular
+      * Extra: simple/knot/pt_extra