Node/Edge Option Type Editor

README.md

@@ -17,6 +17,9 @@ The Wiki has [detailed instructions](https://github.com/netcreateorg/netcreate-2
 
 This will get NetCreate installed and ready to run. It may take some time for the `npm ci` command to finish installing, so be patient!
 
+The first time you run Net.Create, you also need to create a `net-create.config` file.  This will tell Net.Create which dataset to open and which ports to use.  We have a script that can do this for you.  Run:
+* `./nc.js --dataset=demo` -- where `demo` will be the name of the dataset you want to use.
+
 ## QUICK OPERATION GUIDE
 
 Once you have NetCreate installed, make sure you are in the `netcreate-2018/build` directory. From there, you can execute **scripts** through the `npm` tool that is installed as part of NodeJS. 

build/app/assets/templates/_default.template

@@ -113,6 +113,7 @@
                 "_cmt4": "//updated is included in the edge tables if in admin mode, and in the graph tooltip  if indicated here. Probably those should be more consistent."
               },
     "delete": {
+      "_cmt5": "// Only admins see the delete button.  This hides delete button even for admins.",
       "type": "hidden",
       "hidden": false
     }

build/app/assets/templates/_default.template.toml

@@ -0,0 +1,175 @@
+name = "Untitled"
+description = "Default empty template"
+requireLogin = false
+hideDeleteNodeButton = false
+duplicateWarning = "You’re entering a duplicate node.  Do you want to View the Existing node, or Continue creating?"
+nodeIsLockedMessage = "This node is currently being edited by someone else, please try again later."
+edgeIsLockedMessage = "This edge is currently being edited by someone else, please try again later."
+nodeDefaultTransparency = 1.0
+edgeDefaultTransparency = 0.3
+searchColor = "#FFFF00"
+sourceColor = "#FFa500"
+
+[citation]
+text = "No citation set"
+hidden = false
+
+[nodeDefs.id]
+type = "number"
+displayLabel = "Id"
+exportLabel = "ID"
+help = "System-generated unique id number"
+
+[nodeDefs.label]
+type = "string"
+displayLabel = "Label"
+exportLabel = "Label"
+help = "Display name of the node"
+includeInGraphTooltip = true
+
+[nodeDefs.type]
+type = "select"
+displayLabel = "Type"
+exportLabel = "Type"
+help = "Multiple people are a 'Group'"
+includeInGraphTooltip = true
+hidden = false
+
+[[nodeDefs.type.options]]
+label = ""
+color = "#eeeeee"
+
+[[nodeDefs.type.options]]
+label = "Person"
+color = "#00fbff"
+
+[[nodeDefs.type.options]]
+label = "Group"
+color = "#3399ff"
+
+[[nodeDefs.type.options]]
+label = "Place"
+color = "#00ff00"
+
+[[nodeDefs.type.options]]
+label = "Thing"
+color = "#009999"
+
+[[nodeDefs.type.options]]
+label = "Event"
+color = "#ff0000"
+
+[nodeDefs.notes]
+type = "string"
+displayLabel = "Significance"
+exportLabel = "Notes"
+help = "Add some details"
+includeInGraphTooltip = true
+hidden = false
+
+[nodeDefs.info]
+type = "number"
+displayLabel = "Number"
+exportLabel = "Info"
+help = "Some number comparison"
+includeInGraphTooltip = true
+hidden = false
+
+[nodeDefs.degrees]
+type = "number"
+displayLabel = "Degrees"
+exportLabel = "Degrees"
+help = "Number of edges"
+includeInGraphTooltip = true
+hidden = false
+
+[nodeDefs.created]
+type = "string"
+displayLabel = "Created"
+exportLabel = "Created"
+help = "Date and time node was created"
+includeInGraphTooltip = true
+hidden = false
+
+[nodeDefs.updated]
+type = "string"
+displayLabel = "Last Updated"
+exportLabel = "Last Updated"
+help = "Date and time node was last modified"
+includeInGraphTooltip = true
+hidden = false
+
+[edgeDefs.id]
+type = "number"
+displayLabel = "Id"
+exportLabel = "ID"
+help = "System-generated unique id number"
+
+[edgeDefs.source]
+type = "node"
+displayLabel = "Source"
+exportLabel = "Source"
+help = ""
+hidden = false
+
+[edgeDefs.target]
+type = "node"
+displayLabel = "Target"
+exportLabel = "Target"
+help = ""
+hidden = false
+
+[edgeDefs.type]
+type = "select"
+displayLabel = "Type"
+exportLabel = "Type"
+help = ""
+hidden = false
+
+[[edgeDefs.type.options]]
+label = ""
+color = "#c2c2c2"
+
+[[edgeDefs.type.options]]
+label = "you've got, a \"friend\""
+color = "#0dbd00"
+
+[[edgeDefs.type.options]]
+label = "has unfriendly interaction with"
+color = "#ff0000"
+
+[[edgeDefs.type.options]]
+label = "is a member of"
+color = "#9ebeff"
+
+[[edgeDefs.type.options]]
+label = "visits"
+color = "#ffae00"
+
+[edgeDefs.notes]
+type = "string"
+displayLabel = "Significatnce"
+exportLabel = "Significatnce"
+help = ""
+hidden = false
+
+[edgeDefs.info]
+type = "number"
+displayLabel = "Date"
+exportLabel = "Date"
+help = "'YYYY-MM-DD' format"
+hidden = false
+
+[edgeDefs.citation]
+type = "string"
+displayLabel = "Citation"
+exportLabel = "Citation"
+help = "Source Book.Chapter (Part 2 06.03)"
+hidden = false
+
+[edgeDefs.category]
+type = "string"
+displayLabel = "Category"
+exportLabel = "Category"
+help = "Category?"
+hidden = false

build/app/settings.js

@@ -63,6 +63,12 @@ let RELOAD_TIMER = null;
 /*/ MOD.CurrentTime = () => {
       return DATE.toDateString();
     };
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+/*/
+/*/ MOD.IsAdmin = () => {
+      return (MOD.EJSProp('client').ip === '127.0.0.1') ||
+        location.href.includes('admin=true');
+    }
 
 /// SERVER-PROVIDED PROPERTIES ////////////////////////////////////////////////
 /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

build/app/system/datastore.js

@@ -11,6 +11,7 @@ const DBG = { load: true };
 
 /// SYSTEM LIBRARIES //////////////////////////////////////////////////////////
 /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+const TOML = require("@iarna/toml");
 const SETTINGS = require("settings");
 const SESSION = require("unisys/common-session");
 const UNISYS = require("unisys/client");
@@ -34,7 +35,14 @@ let D3DATA = {};
 /*/ establish message handlers during INITIALIZE phase
 /*/
 DSTOR.Hook("INITIALIZE", () => {
+  // DBUPDATE_ALL is a local call originating from within the app
+  // Used to update the full D3DATA object during template updates
+  UDATA.HandleMessage("DBUPDATE_ALL", function(data) {
+    DSTOR.UpdateDataPromise(data);
+  });
+
   // DB_UPDATE is a local call originating from within the app
+  // Generally used to update individual nodes and edges
   UDATA.HandleMessage("DB_UPDATE", function(data) {
     DSTOR.UpdateServerDB(data);
   });
@@ -152,16 +160,68 @@ DSTOR.PromiseJSONFile = function(jsonFile) {
   return promise;
 };
 /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+/*/ API: Load default data set from a TOML file in /assets/data
+/*/
+DSTOR.PromiseTOMLFile = function (tomlFile) {
+  if (typeof tomlFile !== "string") {
+    throw new Error("pass arg <filename_in_assets/data>");
+  }
+  let promise = new Promise((resolve, reject) => {
+    let xobj = new XMLHttpRequest();
+    xobj.addEventListener("load", event => {
+      if (event.target.status === 404) {
+        reject(new Error(`file not found`));
+        return;
+      }
+      const data = event.target.responseText;
+      const tomlData = Object.assign(D3DATA, TOML.parse(data));
+      resolve(tomlData);
+    });
+    xobj.open("GET", `${tomlFile}`, true);
+    xobj.send();
+  });
+  return promise;
+};
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 /*/ API: Load D3 Database
 /*/
 DSTOR.PromiseD3Data = function() {
   // UDATA.Call() returns a promise
-  return UDATA.Call("SRV_DBGET", {});
+  return UDATA.Call("SRV_DBGET", {}); // server.js
+};
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+/*/ API: Write Template file to Server
+/*/
+DSTOR.SaveTemplateFile = template => {
+  // UDATA.Call() returns a promise
+  return UDATA.Call("SRV_TEMPLATESAVE", {template}); // server.js
+};
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+/*/ API: Get Template File Path.
+    Called by template-logic when downloading template file.
+/*/
+DSTOR.GetTemplateTOMLFileName = () => {
+  return UDATA.Call("SRV_GET_TEMPLATETOML_FILENAME");
+}
+/// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+/*/ API: Update database from d3data-formatted object
+/*/
+DSTOR.UpdateDataPromise = function (d3data) {
+  return new Promise((resolve, reject) => {
+    UDATA.Call("SRV_DBUPDATE_ALL", d3data).then(res => {
+      if (res.OK) {
+        console.log(PR, `database update OK`);
+        resolve(res);
+      } else {
+        reject(new Error(JSON.stringify(res)));
+      }
+    });
+  });
 };
 /// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 /*/ API: (WIP) write database from d3data-formatted object
 /*/
-DSTOR.OverwriteDataPromise = function(d3data) {
+DSTOR.OverwriteDataPromise = function (d3data) {
   return new Promise((resolve, reject) => {
     UDATA.Call("SRV_DBSET", d3data).then(res => {
       if (res.OK) {

build/app/unisys/client-state.js

@@ -122,6 +122,11 @@ var STATES_LISTEN = new Map(); // namespace str => emitter
       if (!namespace) throw Error(BAD_NSPACE);
       // update old state by partially overwrite of state
       if (!STATES.has(namespace)) STATES.set(namespace,{});
+      // NOTE Because we're using Object.assign:
+      // * Objects already in the state will remain in the state
+      //   if not overwritten by newState.  This can result in
+      //   the mysterious re-appearance of old paramters.
+      // * No deep clones
       Object.assign(STATES.get(namespace),newState);
       // forward new state to namespace listeners
       let msgr = m_GetStateMessager(namespace);