Editor DataModel Refactor (#175)

* editor datamodel refactor

* Apply suggestions from code review

Spelling

Co-authored-by: Gary Sun <garysun0451@gmail.com>

* Update Backend/editor/data/jsonConfig.go

Spelling

Co-authored-by: Gary Sun <garysun0451@gmail.com>

* general cleanup of marshaller

* cleaned up traversal logic

* Update Backend/editor/data/traversal.go

Co-authored-by: Gary Sun <garysun0451@gmail.com>

* Update Backend/editor/data/traversal.go

Co-authored-by: Gary Sun <garysun0451@gmail.com>

* accurate logging

Co-authored-by: Gary Sun <garysun0451@gmail.com>

Author: Varun-Sethu

Backend/.eslintrc.js renamed to Backend/client/.eslintrc.js

@@ -0,0 +1,44 @@
+package data
+
+// applicator manages the application of request objects to a provided datamodel
+
+import (
+	"errors"
+	"reflect"
+
+	"cms.csesoc.unsw.edu.au/editor/data/datamodels"
+)
+
+// TODO:
+// - Add error checking for the paths as we traverse, e.g missing an index when traversing an array (assuming we didn't reach the end)
+// - Make sure the item we are adding keeps the validity of the object
+
+// ApplyRequest takes a datamodel (as defined in the datamodels folder) and a request, it then proceeds to apply the request
+// to the model, note that this assumes that the operation in the request has been appropriately transformed
+func ApplyRequest(model datamodels.DataModel, request Request) error {
+	_, err := GetOperationTargetSite(model, request.path)
+	if err != nil {
+		return err
+	}
+
+	switch editType := request.payload.GetType(); editType {
+	case "textEdit":
+	case "keyEdit":
+	case "arrayEdit":
+	default:
+		return errors.New("invalid edit type")
+	}
+
+	return nil
+}
+
+// getOperationTargetSite Gets the target object at the end of the path, this is the operation that we need to apply
+// our operation to
+func GetOperationTargetSite(model datamodels.DataModel, subpaths []string) (reflect.Value, error) {
+	_, target, err := Traverse(model, subpaths)
+	if err != nil {
+		return reflect.Value{}, err
+	}
+
+	return target, nil
+}

Backend/.prettierrc renamed to Backend/client/.prettierrc

@@ -0,0 +1,9 @@
+# Data/Models
+
+Data/Models is where you define the core layout of the data format that you wish to use the collaborative editor with, currently there are only two supported data models, the CMS datamodel (used by the CMS frontend) and the Learning Platform datamodel (used by the learning platform).
+
+## Creating Models
+Note that in order to expose your new datamodel you must implement the `IsExposed()` method, this is to prevent passing the wrong models into the CMS functions (so hopefully this can be caught at compile time as opposed to runtime).
+
+## Details
+TODO :sunglasses:

Backend/package.json renamed to Backend/client/package.json

@@ -1,4 +1,4 @@
-package models
+package cmsmodel
 
 import "reflect"
 

Backend/tsconfig.json renamed to Backend/client/tsconfig.json

@@ -0,0 +1,11 @@
+package cmsmodel
+
+// Document is the main datamodel type of the CMS model, it implements the DataModel interface
+type Document struct {
+	DocumentName string
+	DocumentId   string
+	Content      []Component
+}
+
+// IsExposed is the required registration for our type
+func (d Document) IsExposed() bool { return true }

Backend/yarn.lock renamed to Backend/client/yarn.lock

@@ -1,6 +1,9 @@
-package models
+package cmsmodel
 
-import "reflect"
+import (
+	"errors"
+	"reflect"
+)
 
 // @implements the Component interface
 type Image struct {
@@ -16,6 +19,10 @@ func (i Image) Get(field string) (reflect.Value, error) {
 // Set sets a reflect.Value given a specific field
 func (i Image) Set(field string, value reflect.Value) error {
 	reflectionField := reflect.ValueOf(i).FieldByName(field)
-	reflectionField.Set(value)
-	return nil
+	if reflectionField.IsValid() {
+		reflectionField.Set(value)
+		return nil
+	}
+
+	return errors.New("invalid field provided")
 }