Skip to content

Latest commit

 

History

History
156 lines (100 loc) · 3.72 KB

README.md

File metadata and controls

156 lines (100 loc) · 3.72 KB
Raw

JSON Node Editor

Node editor based around rete.js framework for editing JSON data.

As opposed to editing YAML/JSON data in text format:

{
    "a": {
        "b": 1,
        "c": "hello"
    }
}

the editor allows setting values in nodes, where sub-elements (like "b" and "c" to "a" above) are represented by connecting an output to subsequent nodes.

Schema

The editor supports JSON editing via a schema.

JSON Schema definitions is taken from here (Release 2019-09): https://json-schema.org/understanding-json-schema/UnderstandingJSONSchema.pdf

Known limitations

  • #ref must conform to standardised form: #/.../.../<refName>

  • foreign schemas not supported

  • Schema composition:

    • currently anyOf supported, but not the following:
      • allOf
      • oneOf
      • not

  • JSON object

    • properties not supported , only additionalProperties like a Python dictionary
    • Keywords not supported on html user input:
      • patternProperties
      • propertyNames
      • minProperties
      • maxProperties

  • JSON integer

    • Input only validated if numeric, not if integer

  • JSON number:

    • The following keywords not validated on html user input:
      • multipleOf
      • minimum
      • exclusiveMinimum
      • maximum
      • exclusiveMaximum

  • JSON array types

    • tuple validation not supported where items is specified as a list, only list validation, where items is a JSON object schema
    • Keywords unsupported
      • additionalItems
      • contains
      • minItems
      • maxItems
      • uniqueItems

  • enumerations

Output JSON can be validated against schema, just not in html input

Components

Each element in JSON is represented by a visual node in the editor - this could be a complex object or just a number or a string. By default a set of core components are provided as standard

Text Component

The text component provides a text area for input

Number Component

Input restricted to numeric values

Boolean Component

Boolean components provide a dropdown selection for True and False, with an option for blank (null)

Select Component

Dropdown component, same as Boolean, except the user specifies the options to display

Elementary Components

Elementary components have individual outputs representing a single element, to be connecting to another node where data is entered.

For each output, functionality is provided to:

  • Insert a new output directly after
  • Delete the output
  • Move the output up in the list
  • Move the output down in the list

(insert diagram how schema is passed down tree)

Named Components

Named components are defined in the schema

Understanding the Codebase

Data Attributes

It appears the retejs framework was designed to have the node data variable act as an index signature for control keys and values.

export class Control {

    key: string;
    data: unknown = {};
    parent: Node | Input | null = null;
	...
    getData(key: string) {
        return this.getNode().data[key];
    }

    putData(key: string, data: unknown) {
        this.getNode().data[key] = data;
    }  
}

However, this is not suitable for this application which requires more layers of storage.

Thus, data attributes are defined, where controls data as above would be under "controlsData", and so forth, so node data looks like:

{
    "controlsData": {
        "control_1": "a",
        "control_2": "b"
    },
    "outputMappings": {
        "output_1": "control_1"
    }
}

Retejs does not natively support outputs having controls, which is achieved by mapping output keys to control keys above. This tells the editor to display a control next to a particular output