dal-engine-core-js-lib-dev 0.0.2 → 0.0.4

package/src/DALEngine.js

@@ -20,6 +20,7 @@ import Participant from "./Members/Participant";
 export class DALEngine {
     constructor (args) {
         this.graph = new BehavioralControlGraph();
+        this.atomicGraphs = [];
         this.loadArgs(args);
     }
 
@@ -55,8 +56,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));
     }
 
     /**
@@ -93,33 +93,48 @@ export class DALEngine {
      * @returns {GraphNode}
      */
     getNode (behaviorId) {
-        return this.graph.findNode(behaviorId);
+        return this.graph._findNode(behaviorId);
     }
 
     /**
      * Adds a node to the graph with the given behaviorId and goToBehaviors.
      * @param {String} behaviorId
      * @param {Array} goToBehaviorsIds
+     * @param {Boolean} isAtomic
      * @returns {GraphNode}
      */
-    addNode (behaviorId, goToBehaviorsIds) {
-        const behavior = this.createBehavior({name: behaviorId});
-        return this.graph.addNode(behavior, goToBehaviorsIds);
+    addNode (behaviorId, goToBehaviorsIds, isAtomic) {
+        return this.graph._addNode(behaviorId, goToBehaviorsIds, isAtomic);
     }
 
     /**
-     * Adds a goToBehavior to the node with the given behaviorId.
+     * Deletes a node from the graph with the given behaviorId and
+     * removes it from the goToBehavior list of all other nodes.
      * @param {String} behaviorId
-     * @param {String|Array} goToBehaviorIds
-     * @returns {GraphNode}
      */
-    addGoToBehavior (behaviorId, goToBehaviorIds) {
-        const node = this.graph.findNode(behaviorId);
-        if (Array.isArray(goToBehaviorIds)) {
-            node.goToBehaviorsIds.push(...goToBehaviorIds);
-        } else {
-            node.goToBehaviorsIds.push(goToBehaviorIds);
+    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);
         }
-        return node;
+    }
+
+    /**
+     * 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);
     }
 }

package/src/Members/Behavior.js

@@ -18,9 +18,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);
         }
     }
 
@@ -29,7 +29,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.
@@ -47,7 +47,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)));
@@ -62,7 +62,7 @@ class Behavior extends Base {
      * @param {Participant} participant
      * @returns
      */
-    addParticpant (participant) {
+    addParticipant (participant) {
         this.participants.push(participant);
         return participant;
     }

package/src/Members/Invariant.js

@@ -18,9 +18,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);
         }
     }
 
@@ -29,7 +29,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.
@@ -47,7 +47,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;
         };

package/src/Members/Participant.js

@@ -14,14 +14,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);
         }
     }
 
@@ -30,7 +30,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.
@@ -48,7 +48,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)));

package/tests/DALEngine.test.js

@@ -28,12 +28,12 @@ describe("DALEngine", () => {
     it("adds node to graph", () => {
         const d = new DALEngine({name: "Library Manager"});
         const goToBehaviorIds = ["AddBookToBasket"];
-        const node = d.addNode("AcceptBookFromUser", goToBehaviorIds)
+        const node = d.addNode("AcceptBookFromUser", goToBehaviorIds);
 
         const nodeType = node.type;
         expect(nodeType).toBe(ENGINE_TYPES.GRAPH_NODE);
-        expect(node.behavior.name).toStrictEqual("AcceptBookFromUser");
-        expect(node.goToBehaviorsIds).toStrictEqual(goToBehaviorIds);
+        expect(node.getBehavior().name).toStrictEqual("AcceptBookFromUser");
+        expect(node.getGoToBehaviors()).toStrictEqual(goToBehaviorIds);
     });
 
     it("find node that was added using behavior name", () => {
@@ -46,6 +46,21 @@ describe("DALEngine", () => {
         expect(foundNode).toStrictEqual(node);
     });
 
+    it("adds node to graph and removes it", () => {
+        const d = new DALEngine({name: "Library Manager"});
+        d.addNode("AcceptBookFromUser", []);
+        d.addNode("AddBookToBasket", []);
+
+        d.getNode("AcceptBookFromUser").addGoToBehavior("AddBookToBasket");
+
+        const node = d.getNode("AcceptBookFromUser");
+
+        const nodeType = node.type;
+        expect(nodeType).toBe(ENGINE_TYPES.GRAPH_NODE);
+        expect(node.getBehavior().name).toStrictEqual("AcceptBookFromUser");
+        expect(node.getGoToBehaviors()).toStrictEqual(["AddBookToBasket"]);
+    });
+
     it("find node and check if observed behavior is valid transition", () => {
         const d = new DALEngine({name: "Library Manager"});
         const node1 = d.addNode("AcceptBookFromUser", []);
@@ -57,31 +72,31 @@ describe("DALEngine", () => {
 
         // Misspell behavior name to trigger unknown behavior error
         expect(() => {
-            d.graph.setCurrentBehavior("AcceptBookromUser");
+            d.setCurrentBehavior("AcceptBookromUser");
         }).toThrow(UnknownBehaviorError);
 
-        d.graph.setCurrentBehavior("AcceptBookFromUser");
+        d.setCurrentBehavior("AcceptBookFromUser");
         expect(d.graph.currentNode).toBe(node1);
 
-        d.graph.goToBehavior("AddBookToBasket")
+        d.goToBehavior("AddBookToBasket")
         expect(d.graph.currentNode).toBe(node2);
 
         // Reset current behavior so transition is valid
-        d.graph.setCurrentBehavior("AcceptBookFromUser");
-        d.graph.goToBehavior("AddBookToBasket")
+        d.setCurrentBehavior("AcceptBookFromUser");
+        d.goToBehavior("AddBookToBasket")
         expect(d.graph.currentNode).toBe(node2);
 
         // Raises error because current behavior is "AnotherBehavior"
         // and it does not transition to itself.
         expect(() => {
-            d.graph.goToBehavior("AddBookToBasket")
+            d.goToBehavior("AddBookToBasket")
         }).toThrow(InvalidTransitionError);
 
         // Reset the current behavior and then go to a behavior
         // which is misspelled and expect an invalid transition error
         expect(() => {
-            d.graph.setCurrentBehavior("AcceptBookFromUser");
-            d.graph.goToBehavior("AddBookToasket")
+            d.setCurrentBehavior("AcceptBookFromUser");
+            d.goToBehavior("AddBookToasket")
         }).toThrow(InvalidTransitionError);
     });
 
@@ -121,14 +136,14 @@ describe("DALEngine", () => {
         book.addInvariant(invariant);
 
 
-        const node1 = d.addNode("AcceptBookFromUser", []);
+        d.addNode("AcceptBookFromUser", []);
         d.addNode("AddBookToBasket", []);
         d.addNode("AnotherBehavior", []);
 
-        node1.addGoToBehavior("AddBookToBasket");
-        node1.addGoToBehavior("AnotherBehavior");
+        d.getNode("AcceptBookFromUser").addGoToBehavior("AddBookToBasket");
+        d.getNode("AcceptBookFromUser").addGoToBehavior("AnotherBehavior");
 
-        node1.behavior.addParticpant(book);
+        d.getNode("AcceptBookFromUser").getBehavior().addParticipant(book);
 
         const filePath = resolve(__dirname, "./temp/inspectSerializeTemp.json")
         await writeFile(filePath, d.serialize())

package/tests/Invariant.test.js

@@ -73,26 +73,26 @@ describe("invariantTests", () => {
 
         // Create behavior and participant
         const node1 = d.addNode("AcceptBookFromUser", []);
-        node1.behavior.addParticpant(book);
+        node1.getBehavior().addParticipant(book);
 
         // Add value that respects invariant and expect valid world state
-        node1.behavior.setParticipantValue("book", {
+        node1.getBehavior().setParticipantValue("book", {
             "uid": 1,
             "value": {
                 "name": "Harry Potter and Chamber of Secrets",
             },
         })
-        expect(node1.behavior.invalidWorldState).toBe(false);
+        expect(node1.getBehavior().invalidWorldState).toBe(false);
 
 
         // Add value that violates invariant and expect invalid world state
-        node1.behavior.setParticipantValue("book", {
+        node1.getBehavior().setParticipantValue("book", {
             "uid": 1,
             "value": {
                 "name": "",
             },
         })
-        expect(node1.behavior.invalidWorldState).toBe(true);
+        expect(node1.getBehavior().invalidWorldState).toBe(true);
 
         // Write to file for inspection
         const filePath = resolve(__dirname, "./temp/invariantBehaviorTemp.json")

package/tests/SimpleDesign.test.js

@@ -21,7 +21,10 @@ describe("SimpleDesignTest", () => {
         d.addNode("CreateSlotOnBookShelf", ["AddBookToShelf"]);
         d.addNode("AddBookToShelf", ["GetBookFromBasket"]);
 
-        const filePath = resolve(__dirname, "./simple_design_temp.json")
+
+        d.removeNode("GetBookFromBasket");
+
+        const filePath = resolve(__dirname, "./temp/simple_design_temp.json")
         await writeFile(filePath, d.serialize())
 
         // Output can be viewed using https://mermaid.live/

package/tests/simple_design_temp.json

@@ -1 +0,0 @@
-{"uid":"0f4433c4-abd7-43da-96e3-6809863c93ab","type":5,"nodes":[{"uid":"1b0751a9-c46e-4fa6-ae7f-cf6204fdd83b","type":6,"goToBehaviorsIds":["AcceptBookFromUser"],"behavior":{"uid":"e336a950-f89c-43a6-b3c4-09df32f64831","type":1,"participants":[],"abstractionIds":[],"invalidWorldState":false,"name":"AcceptChoiceToAddBookToBasket"}},{"uid":"deb11624-0fae-4d1b-9d22-d421dea1d712","type":6,"goToBehaviorsIds":["AddBookToBasket"],"behavior":{"uid":"65b253bb-c4f2-4dee-8f36-648f73b3300c","type":1,"participants":[],"abstractionIds":[],"invalidWorldState":false,"name":"AcceptBookFromUser"}},{"uid":"f914f2c9-86e3-4c54-a926-b6c9c425cf9f","type":6,"goToBehaviorsIds":[],"behavior":{"uid":"76b6962c-24b1-4999-9719-5ac2e4f1c022","type":1,"participants":[],"abstractionIds":[],"invalidWorldState":false,"name":"AddBookToBasket"}},{"uid":"84912fd4-c193-4b7d-ad62-cdc6b254d529","type":6,"goToBehaviorsIds":["GenerateAuditReport"],"behavior":{"uid":"76f3d5a5-2e64-4bea-8beb-70d0d38e0645","type":1,"participants":[],"abstractionIds":[],"invalidWorldState":false,"name":"AcceptChoiceToAuditLibrary"}},{"uid":"4056410c-37c5-4ffa-8766-2ecd7a079617","type":6,"goToBehaviorsIds":["HandAuditToUser"],"behavior":{"uid":"f6a6e7d4-0151-4881-8d57-fb327620fd4a","type":1,"participants":[],"abstractionIds":[],"invalidWorldState":false,"name":"GenerateAuditReport"}},{"uid":"e6de6529-7d64-40f4-8787-c0e1c1c324eb","type":6,"goToBehaviorsIds":[],"behavior":{"uid":"8a3efec4-1068-4ee5-b66d-715bcc7b6d79","type":1,"participants":[],"abstractionIds":[],"invalidWorldState":false,"name":"HandAuditToUser"}},{"uid":"91b71f6c-e384-4c31-9d39-4eae95e61872","type":6,"goToBehaviorsIds":["GetBookFromBasket"],"behavior":{"uid":"9caee137-24b9-4314-b5a7-e4a7f6e93256","type":1,"participants":[],"abstractionIds":[],"invalidWorldState":false,"name":"AcceptChoiceToPlaceBooksOnShelf"}},{"uid":"4ea36149-15cf-4e6d-8770-cfd6bdc9645d","type":6,"goToBehaviorsIds":["GetFirstLetterOfBookName"],"behavior":{"uid":"1477b094-eb0a-4c2c-88b2-35ba99155f1e","type":1,"participants":[],"abstractionIds":[],"invalidWorldState":false,"name":"GetBookFromBasket"}},{"uid":"bd6116de-8cd9-41b2-a256-fab5d979d80e","type":6,"goToBehaviorsIds":["CreateSlotOnBookShelf","AddBookToShelf"],"behavior":{"uid":"36b0483d-d831-4478-a34e-c091db38370d","type":1,"participants":[],"abstractionIds":[],"invalidWorldState":false,"name":"GetFirstLetterOfBookName"}},{"uid":"54948771-65b7-40cb-8331-85f5b7d6cbf1","type":6,"goToBehaviorsIds":["AddBookToShelf"],"behavior":{"uid":"1fcd8aa4-6f25-4406-a0bc-ba43912ec572","type":1,"participants":[],"abstractionIds":[],"invalidWorldState":false,"name":"CreateSlotOnBookShelf"}},{"uid":"ff292a3c-e556-44de-9a47-9510ef0910e4","type":6,"goToBehaviorsIds":["GetBookFromBasket"],"behavior":{"uid":"b736147d-faf3-4718-86c2-a2e8ffa8fb51","type":1,"participants":[],"abstractionIds":[],"invalidWorldState":false,"name":"AddBookToShelf"}}]}