dal-engine-core-js-lib-dev 0.0.1 → 0.0.3

package/dist/index.esm.js

@@ -80,9 +80,9 @@ class Invariant extends Base {
         this.invariantType = null;
         this.traceId = null;
         if (typeof args === "object" && Object.hasOwn(args, "uid")) {
-            this.loadInvariantFromJSON(args);
+            this._loadInvariantFromJSON(args);
         } else {
-            this.loadArgs(args);
+            this._loadArgs(args);
         }
     }
 
@@ -91,7 +91,7 @@ class Invariant extends Base {
      * @throws {MissingAttributes} Thrown when required attr is not present.
      * @param {Object} args
      */
-    loadArgs (args) {
+    _loadArgs (args) {
         const expectedAttributes = ["name", "rule"];
         if (typeof args !== "object" || args === null || Array.isArray(args)) {
             // Not an object, so all attributes are missing.
@@ -109,7 +109,7 @@ class Invariant extends Base {
      * Loads the participant from a JSON object.
      * @param {Object} invariantJSON
      */
-    loadInvariantFromJSON (invariantJSON) {
+    _loadInvariantFromJSON (invariantJSON) {
         for (const [key, value] of Object.entries(invariantJSON)) {
             this[key] = value;
         }        // Reset these because they are set by the execution
@@ -196,14 +196,14 @@ class Participant extends Base {
      */
     constructor (args) {
         super();
-        this.type = ENGINE_TYPES.INVARIANT;
+        this.type = ENGINE_TYPES.PARTICIPANT;
         this.invariants = [];
         this.abstractionId = null;
         this.invariantViolated = false;
         if (typeof args === "object" && Object.hasOwn(args, "uid")) {
-            this.loadParticipantFromJSON(args);
+            this._loadParticipantFromJSON(args);
         } else {
-            this.loadArgs(args);
+            this._loadArgs(args);
         }
     }
 
@@ -212,7 +212,7 @@ class Participant extends Base {
      * @throws {MissingAttributes} Thrown when required attr is not present.
      * @param {Object} args
      */
-    loadArgs (args) {
+    _loadArgs (args) {
         const expectedAttributes = ["name"];
         if (typeof args !== "object" || args === null || Array.isArray(args)) {
             // Not an object, so all attributes are missing.
@@ -230,7 +230,7 @@ class Participant extends Base {
      * Loads the participant from a JSON object.
      * @param {Object} participantJSON
      */
-    loadParticipantFromJSON (participantJSON) {
+    _loadParticipantFromJSON (participantJSON) {
         for (const [key, value] of Object.entries(participantJSON)) {
             if (key === "invariants") {
                 value.forEach(node => this.invariants.push(new Invariant(node)));
@@ -302,9 +302,9 @@ class Behavior extends Base {
         this.abstractionIds = [];
         this.invalidWorldState = false;
         if (typeof args === "object" && Object.hasOwn(args, "uid")) {
-            this.loadBehaviorFromJSON(args);
+            this._loadBehaviorFromJSON(args);
         } else {
-            this.loadArgs(args);
+            this._loadArgs(args);
         }
     }
 
@@ -313,7 +313,7 @@ class Behavior extends Base {
      * @throws {MissingAttributes} Thrown when required attr is not present.
      * @param {Object} args
      */
-    loadArgs (args) {
+    _loadArgs (args) {
         const expectedAttributes = ["name"];
         if (typeof args !== "object" || args === null || Array.isArray(args)) {
             // Not an object, so all attributes are missing.
@@ -331,7 +331,7 @@ class Behavior extends Base {
      * Loads the behavior from a JSON object.
      * @param {Object} behaviorJSON
      */
-    loadBehaviorFromJSON (behaviorJSON) {
+    _loadBehaviorFromJSON (behaviorJSON) {
         for (const [key, value] of Object.entries(behaviorJSON)) {
             if (key === "participants") {
                 value.forEach(node => this.participants.push(new Participant(node)));
@@ -345,7 +345,7 @@ class Behavior extends Base {
      * @param {Participant} participant
      * @returns
      */
-    addParticpant (participant) {
+    addParticipant (participant) {
         this.participants.push(participant);
         return participant;
     }
@@ -385,13 +385,14 @@ class GraphNode extends Base {
     constructor (args) {
         super();
         this.type = ENGINE_TYPES.GRAPH_NODE;
-        this.goToBehaviors = [];
+        this._behavior = null;
+        this._goToBehaviorIds = [];
         if (typeof args === "object" && args !== null) {
             if (Object.hasOwn(args, "uid")) {
-                this.loadNodeFromJSON(args);
+                this._loadNodeFromJSON(args);
             } else {
-                this.behavior = args.behavior;
-                this.goToBehaviors = args.goToBehaviors;
+                this._behavior = args.behavior;
+                this._goToBehaviorIds = args.goToBehaviorsIds;
             }
         }
     }
@@ -400,29 +401,68 @@ class GraphNode extends Base {
      * Loads the nodes from a JSON object.
      * @param {Object} nodesJSON
      */
-    loadNodeFromJSON (nodesJSON) {
+    _loadNodeFromJSON (nodesJSON) {
         for (const [key, value] of Object.entries(nodesJSON)) {
             if (key === "behavior") {
-                this.behavior = new Behavior(value);
-            } else if (key === "goToBehaviors") {
-                value.forEach(node => this.goToBehaviors.push(new Behavior(node)));
+                this._behavior = new Behavior(value);
+            } else if (key === "goToBehaviorsIds") {
+                value.forEach(behaviorId => this._goToBehaviorIds.push(behaviorId));
             } else {
                 this[key] = nodesJSON[key];
             }
         }    }
 
+    /**
+     * Returns the behavior of the node.
+     * @returns {Behavior|Null}
+     */
+    getBehavior () {
+        return this._behavior;
+    }
+
+    /**
+     * Returns the list of behavior names that this node transitions to.
+     * @returns {Array}
+     */
+    getGoToBehaviors () {
+        return this._goToBehaviorIds;
+    }
+
+    /**
+     * Adds a behavior name to the list of behaviors that this
+     * node transitions to.
+     * @param {String} behaviorId ID of behavior.
+     */
+    addGoToBehavior (behaviorId) {
+        this._goToBehaviorIds.push(behaviorId);
+    }
+
+    /**
+     * Adds a behavior name to the list of behaviors that this
+     * node transitions to.
+     * @param {Array} behaviorIds IDs of behaviors.
+     */
+    addGoToBehaviors (behaviorIds) {
+        this._goToBehaviorIds.push(...behaviorIds);
+    }
+
+    removeGoToBehavior (behaviorId) {
+        const goToIndex = this._goToBehaviorIds.indexOf(behaviorId);
+        if (goToIndex > -1) {
+            this._goToBehaviorIds.splice(goToIndex, 1);
+        }
+    }
+
     /**
      * Checks if the provided behavior name is a valid
-     * behavior that the control flow selects as a
-     * result of the this nodes state transformation. i.e.
-     * is this behavior in the goToBehavior list.
+     * transition from this node.
      * @param {String} behaviorName
      * @returns {Boolean}
      */
-    isValidGoToBehavior (behaviorName) {
-        for (let i = 0; i < this.goToBehaviors.length; i++) {
-            const behavior = this.goToBehaviors[i];
-            if (behavior.name === behaviorName) {
+    isValidTransition (behaviorName) {
+        for (let i = 0; i < this._goToBehaviorIds.length; i++) {
+            const behaviorId = this._goToBehaviorIds[i];
+            if (behaviorId === behaviorName) {
                 return true;
             }
         }
@@ -445,7 +485,7 @@ class BehavioralControlGraph extends Base {
         this.nodes = [];
         if (typeof args === "object" && args !== null) {
             if (Object.hasOwn(args, "uid")) {
-                this.loadGraphFromJSON(args);
+                this._loadGraphFromJSON(args);
             } else {
                 this.name = args.name;
             }
@@ -456,7 +496,7 @@ class BehavioralControlGraph extends Base {
      * Loads the graph from a JSON object..
      * @param {Object} graphJson
      */
-    loadGraphFromJSON (graphJson) {
+    _loadGraphFromJSON (graphJson) {
         for (const [key, value] of Object.entries(graphJson)) {
             if (key === "nodes") {
                 value.forEach(node => this.nodes.push(new GraphNode(node)));
@@ -468,13 +508,13 @@ class BehavioralControlGraph extends Base {
     /**
      * Adds a node to the graph.
      * @param {Behavior} behavior
-     * @param {Array} goToBehaviors
+     * @param {Array} goToBehaviorsIds
      * @returns
      */
-    addNode (behavior, goToBehaviors) {
+    _addNode (behavior, goToBehaviorsIds) {
         const node = new GraphNode({
             behavior: behavior,
-            goToBehaviors: goToBehaviors,
+            goToBehaviorsIds: goToBehaviorsIds,
         });
         this.nodes.push(node);
         return node;
@@ -488,9 +528,9 @@ class BehavioralControlGraph extends Base {
      * does not exist in the graph.
      * @returns
      */
-    findNode (behaviorName) {
+    _findNode (behaviorName) {
         for (let i = 0; i < this.nodes.length; i++) {
-            const behavior = this.nodes[i].behavior;
+            const behavior = this.nodes[i].getBehavior();
             if (behavior.name === behaviorName) {
                 return this.nodes[i];
             }
@@ -507,8 +547,8 @@ class BehavioralControlGraph extends Base {
      *
      * @param {String} behaviorName
      */
-    setCurrentBehavior (behaviorName) {
-        const node = this.findNode(behaviorName);
+    _setCurrentBehavior (behaviorName) {
+        const node = this._findNode(behaviorName);
         /**
          * TODO: Ensure it is atomic because the execution
          * will only set a behavior when its the first one.
@@ -524,11 +564,11 @@ class BehavioralControlGraph extends Base {
      * @throws {InvalidTransitionError} Raised when the provided
      * behavior is not a valid transition.
      */
-    goToBehavior (nextBehaviorName) {
-        if (this.currentNode.isValidGoToBehavior(nextBehaviorName)) {
-            this.currentNode = this.findNode(nextBehaviorName);
+    _goToBehavior (nextBehaviorName) {
+        if (this.currentNode.isValidTransition(nextBehaviorName)) {
+            this.currentNode = this._findNode(nextBehaviorName);
         } else {
-            throw new InvalidTransitionError(this.currentNode.behavior.name, nextBehaviorName);
+            throw new InvalidTransitionError(this.currentNode.getBehavior().name, nextBehaviorName);
         }
     }
 
@@ -539,8 +579,8 @@ class BehavioralControlGraph extends Base {
     exportAsMermaid () {
         let mermaid = "flowchart TD\n";
         this.nodes.forEach((node) => {
-            node.goToBehaviors.forEach((behavior) => {
-                mermaid += `  ${node.behavior.name} --> ${behavior.name}\n`;
+            node.getGoToBehaviors().forEach((behaviorId) => {
+                mermaid += `  ${node.getBehavior().name} --> ${behaviorId}\n`;
             });
         });
         return mermaid;
@@ -563,9 +603,26 @@ class BehavioralControlGraph extends Base {
 class DALEngine {
     constructor (args) {
         this.graph = new BehavioralControlGraph();
-        for (const [key, value] of Object.entries(args)) {
-            this[key] = value;
+        this.loadArgs(args);
+    }
+
+    /**
+     * Loads the provided arguments.
+     * @throws {MissingAttributes} Thrown when required attr is not present.
+     * @param {Object} args
+     */
+    loadArgs (args) {
+        const expectedAttributes = ["name"];
+        if (typeof args !== "object" || args === null || Array.isArray(args)) {
+            // Not an object, so all attributes are missing.
+            throw new MissingAttributes("Engine", expectedAttributes);
         }
+        expectedAttributes.forEach((attr) => {
+            if (!(attr in args)) {
+                throw new MissingAttributes("Engine", attr);
+            }
+            this[attr] = args[attr];
+        });
     }
 
     /**
@@ -581,8 +638,7 @@ class DALEngine {
      * @param {String} jsonText
      */
     deserialize (jsonText) {
-        this.graph = new BehavioralControlGraph();
-        this.graph.loadGraphFromJSON(JSON.parse(jsonText));
+        this.graph = new BehavioralControlGraph(JSON.parse(jsonText));
     }
 
     /**
@@ -611,6 +667,60 @@ class DALEngine {
     createInvariant (args) {
         return new Invariant(args);
     }
+
+
+    /**
+     * Returns the node in the graph with the given behavior name.
+     * @param {String} behaviorId
+     * @returns {GraphNode}
+     */
+    getNode (behaviorId) {
+        return this.graph._findNode(behaviorId);
+    }
+
+    /**
+     * Adds a node to the graph with the given behaviorId and goToBehaviors.
+     * @param {String} behaviorId
+     * @param {Array} goToBehaviorsIds
+     * @returns {GraphNode}
+     */
+    addNode (behaviorId, goToBehaviorsIds) {
+        const behavior = this.createBehavior({name: behaviorId});
+        const goToIds = goToBehaviorsIds?goToBehaviorsIds:[];
+        return this.graph._addNode(behavior, goToIds);
+    }
+
+    /**
+     * Deletes a node from the graph with the given behaviorId and
+     * removes it from the goToBehavior list of all other nodes.
+     * @param {String} behaviorId
+     */
+    removeNode (behaviorId) {
+        const node = this.graph._findNode(behaviorId);
+        const nodeIndex = this.graph.nodes.indexOf(node);
+        this.graph.nodes.splice(nodeIndex, 1);
+        for (const node of this.graph.nodes) {
+            node.removeGoToBehavior(behaviorId);
+        }
+    }
+
+    /**
+     * Sets the current behavior in the graph.
+     * @param {String} behaviorId
+     */
+    setCurrentBehavior (behaviorId) {
+        this.graph._setCurrentBehavior(behaviorId);
+    }
+
+
+    /**
+     * Transitions the graph to the given behavior if it
+     *  is a valid transition from the current behavior.
+     * @param {String} nextBehaviorId ID of the next behavior.
+     */
+    goToBehavior (nextBehaviorId) {
+        this.graph._goToBehavior(nextBehaviorId);
+    }
 }
 
 export { DALEngine };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dal-engine-core-js-lib-dev",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "main": "dist/index.cjs",
   "module": "dist/index.esm.js",
   "type": "module",

package/src/BehavioralControlGraph/BehavioralControlGraph.js

@@ -19,7 +19,7 @@ class BehavioralControlGraph extends Base {
         this.nodes = [];
         if (typeof args === "object" && args !== null) {
             if (Object.hasOwn(args, "uid")) {
-                this.loadGraphFromJSON(args);
+                this._loadGraphFromJSON(args);
             } else {
                 this.name = args.name;
             }
@@ -30,7 +30,7 @@ class BehavioralControlGraph extends Base {
      * Loads the graph from a JSON object..
      * @param {Object} graphJson
      */
-    loadGraphFromJSON (graphJson) {
+    _loadGraphFromJSON (graphJson) {
         for (const [key, value] of Object.entries(graphJson)) {
             if (key === "nodes") {
                 value.forEach(node => this.nodes.push(new GraphNode(node)));
@@ -43,13 +43,13 @@ class BehavioralControlGraph extends Base {
     /**
      * Adds a node to the graph.
      * @param {Behavior} behavior
-     * @param {Array} goToBehaviors
+     * @param {Array} goToBehaviorsIds
      * @returns
      */
-    addNode (behavior, goToBehaviors) {
+    _addNode (behavior, goToBehaviorsIds) {
         const node = new GraphNode({
             behavior: behavior,
-            goToBehaviors: goToBehaviors,
+            goToBehaviorsIds: goToBehaviorsIds,
         });
         this.nodes.push(node);
         return node;
@@ -63,9 +63,9 @@ class BehavioralControlGraph extends Base {
      * does not exist in the graph.
      * @returns
      */
-    findNode (behaviorName) {
+    _findNode (behaviorName) {
         for (let i = 0; i < this.nodes.length; i++) {
-            const behavior = this.nodes[i].behavior;
+            const behavior = this.nodes[i].getBehavior();
             if (behavior.name === behaviorName) {
                 return this.nodes[i];
             }
@@ -82,8 +82,8 @@ class BehavioralControlGraph extends Base {
      *
      * @param {String} behaviorName
      */
-    setCurrentBehavior (behaviorName) {
-        const node = this.findNode(behaviorName);
+    _setCurrentBehavior (behaviorName) {
+        const node = this._findNode(behaviorName);
         /**
          * TODO: Ensure it is atomic because the execution
          * will only set a behavior when its the first one.
@@ -99,11 +99,11 @@ class BehavioralControlGraph extends Base {
      * @throws {InvalidTransitionError} Raised when the provided
      * behavior is not a valid transition.
      */
-    goToBehavior (nextBehaviorName) {
-        if (this.currentNode.isValidGoToBehavior(nextBehaviorName)) {
-            this.currentNode = this.findNode(nextBehaviorName);
+    _goToBehavior (nextBehaviorName) {
+        if (this.currentNode.isValidTransition(nextBehaviorName)) {
+            this.currentNode = this._findNode(nextBehaviorName);
         } else {
-            throw new InvalidTransitionError(this.currentNode.behavior.name, nextBehaviorName);
+            throw new InvalidTransitionError(this.currentNode.getBehavior().name, nextBehaviorName);
         }
     }
 
@@ -114,8 +114,8 @@ class BehavioralControlGraph extends Base {
     exportAsMermaid () {
         let mermaid = "flowchart TD\n";
         this.nodes.forEach((node) => {
-            node.goToBehaviors.forEach((behavior) => {
-                mermaid += `  ${node.behavior.name} --> ${behavior.name}\n`;
+            node.getGoToBehaviors().forEach((behaviorId) => {
+                mermaid += `  ${node.getBehavior().name} --> ${behaviorId}\n`;
             });
         });
         return mermaid;

package/src/BehavioralControlGraph/GraphNode.js

@@ -13,13 +13,14 @@ class GraphNode extends Base {
     constructor (args) {
         super();
         this.type = ENGINE_TYPES.GRAPH_NODE;
-        this.goToBehaviors = [];
+        this._behavior = null;
+        this._goToBehaviorIds = [];
         if (typeof args === "object" && args !== null) {
             if (Object.hasOwn(args, "uid")) {
-                this.loadNodeFromJSON(args);
+                this._loadNodeFromJSON(args);
             } else {
-                this.behavior = args.behavior;
-                this.goToBehaviors = args.goToBehaviors;
+                this._behavior = args.behavior;
+                this._goToBehaviorIds = args.goToBehaviorsIds;
             }
         }
     }
@@ -28,30 +29,69 @@ class GraphNode extends Base {
      * Loads the nodes from a JSON object.
      * @param {Object} nodesJSON
      */
-    loadNodeFromJSON (nodesJSON) {
+    _loadNodeFromJSON (nodesJSON) {
         for (const [key, value] of Object.entries(nodesJSON)) {
             if (key === "behavior") {
-                this.behavior = new Behavior(value);
-            } else if (key === "goToBehaviors") {
-                value.forEach(node => this.goToBehaviors.push(new Behavior(node)));
+                this._behavior = new Behavior(value);
+            } else if (key === "goToBehaviorsIds") {
+                value.forEach(behaviorId => this._goToBehaviorIds.push(behaviorId));
             } else {
                 this[key] = nodesJSON[key];
             }
         };
     }
 
+    /**
+     * Returns the behavior of the node.
+     * @returns {Behavior|Null}
+     */
+    getBehavior () {
+        return this._behavior;
+    }
+
+    /**
+     * Returns the list of behavior names that this node transitions to.
+     * @returns {Array}
+     */
+    getGoToBehaviors () {
+        return this._goToBehaviorIds;
+    }
+
+    /**
+     * Adds a behavior name to the list of behaviors that this
+     * node transitions to.
+     * @param {String} behaviorId ID of behavior.
+     */
+    addGoToBehavior (behaviorId) {
+        this._goToBehaviorIds.push(behaviorId);
+    }
+
+    /**
+     * Adds a behavior name to the list of behaviors that this
+     * node transitions to.
+     * @param {Array} behaviorIds IDs of behaviors.
+     */
+    addGoToBehaviors (behaviorIds) {
+        this._goToBehaviorIds.push(...behaviorIds);
+    }
+
+    removeGoToBehavior (behaviorId) {
+        const goToIndex = this._goToBehaviorIds.indexOf(behaviorId);
+        if (goToIndex > -1) {
+            this._goToBehaviorIds.splice(goToIndex, 1);
+        }
+    }
+
     /**
      * Checks if the provided behavior name is a valid
-     * behavior that the control flow selects as a
-     * result of the this nodes state transformation. i.e.
-     * is this behavior in the goToBehavior list.
+     * transition from this node.
      * @param {String} behaviorName
      * @returns {Boolean}
      */
-    isValidGoToBehavior (behaviorName) {
-        for (let i = 0; i < this.goToBehaviors.length; i++) {
-            const behavior = this.goToBehaviors[i];
-            if (behavior.name === behaviorName) {
+    isValidTransition (behaviorName) {
+        for (let i = 0; i < this._goToBehaviorIds.length; i++) {
+            const behaviorId = this._goToBehaviorIds[i];
+            if (behaviorId === behaviorName) {
                 return true;
             }
         }

package/src/DALEngine.js

@@ -1,4 +1,5 @@
 import BehavioralControlGraph from "./BehavioralControlGraph/BehavioralControlGraph";
+import MissingAttributes from "./Errors/MissingAttributes";
 import Behavior from "./Members/Behavior";
 import Invariant from "./Members/Invariant";
 import Participant from "./Members/Participant";
@@ -19,9 +20,26 @@ import Participant from "./Members/Participant";
 export class DALEngine {
     constructor (args) {
         this.graph = new BehavioralControlGraph();
-        for (const [key, value] of Object.entries(args)) {
-            this[key] = value;
+        this.loadArgs(args);
+    }
+
+    /**
+     * Loads the provided arguments.
+     * @throws {MissingAttributes} Thrown when required attr is not present.
+     * @param {Object} args
+     */
+    loadArgs (args) {
+        const expectedAttributes = ["name"];
+        if (typeof args !== "object" || args === null || Array.isArray(args)) {
+            // Not an object, so all attributes are missing.
+            throw new MissingAttributes("Engine", expectedAttributes);
         }
+        expectedAttributes.forEach((attr) => {
+            if (!(attr in args)) {
+                throw new MissingAttributes("Engine", attr);
+            }
+            this[attr] = args[attr];
+        });
     }
 
     /**
@@ -37,8 +55,7 @@ export class DALEngine {
      * @param {String} jsonText
      */
     deserialize (jsonText) {
-        this.graph = new BehavioralControlGraph();
-        this.graph.loadGraphFromJSON(JSON.parse(jsonText));
+        this.graph = new BehavioralControlGraph(JSON.parse(jsonText));
     }
 
     /**
@@ -67,4 +84,58 @@ export class DALEngine {
     createInvariant (args) {
         return new Invariant(args);
     }
+
+
+    /**
+     * Returns the node in the graph with the given behavior name.
+     * @param {String} behaviorId
+     * @returns {GraphNode}
+     */
+    getNode (behaviorId) {
+        return this.graph._findNode(behaviorId);
+    }
+
+    /**
+     * Adds a node to the graph with the given behaviorId and goToBehaviors.
+     * @param {String} behaviorId
+     * @param {Array} goToBehaviorsIds
+     * @returns {GraphNode}
+     */
+    addNode (behaviorId, goToBehaviorsIds) {
+        const behavior = this.createBehavior({name: behaviorId});
+        const goToIds = goToBehaviorsIds?goToBehaviorsIds:[];
+        return this.graph._addNode(behavior, goToIds);
+    }
+
+    /**
+     * Deletes a node from the graph with the given behaviorId and
+     * removes it from the goToBehavior list of all other nodes.
+     * @param {String} behaviorId
+     */
+    removeNode (behaviorId) {
+        const node = this.graph._findNode(behaviorId);
+        const nodeIndex = this.graph.nodes.indexOf(node);
+        this.graph.nodes.splice(nodeIndex, 1);
+        for (const node of this.graph.nodes) {
+            node.removeGoToBehavior(behaviorId);
+        }
+    }
+
+    /**
+     * Sets the current behavior in the graph.
+     * @param {String} behaviorId
+     */
+    setCurrentBehavior (behaviorId) {
+        this.graph._setCurrentBehavior(behaviorId);
+    }
+
+
+    /**
+     * Transitions the graph to the given behavior if it
+     *  is a valid transition from the current behavior.
+     * @param {String} nextBehaviorId ID of the next behavior.
+     */
+    goToBehavior (nextBehaviorId) {
+        this.graph._goToBehavior(nextBehaviorId);
+    }
 }