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

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

@@ -14,7 +14,8 @@ describe("DALEngine", () => {
         expect(dalInstance.name).toBe("Library Manager");
     });
 
-    it("throws on missing attributes", () => {
+    it(" throws on missing attributes", () => {
+        expect(() => {new DALEngine()}).toThrow(MissingAttributes);
         const d = new DALEngine({name: "Library Manager"});
         expect(() => {d.createBehavior()}).toThrow(MissingAttributes);
         expect(() => {d.createBehavior({})}).toThrow(MissingAttributes);
@@ -26,67 +27,76 @@ describe("DALEngine", () => {
 
     it("adds node to graph", () => {
         const d = new DALEngine({name: "Library Manager"});
-        const behavior1 = d.createBehavior({name: "AcceptBookFromUser"});
-        const behavior2 = d.createBehavior({name: "AddBookToBasket"});
-        const goToBehaviors = [behavior2];
-
-        const node = d.graph.addNode(behavior1, goToBehaviors)
+        const goToBehaviorIds = ["AddBookToBasket"];
+        const node = d.addNode("AcceptBookFromUser", goToBehaviorIds);
 
         const nodeType = node.type;
         expect(nodeType).toBe(ENGINE_TYPES.GRAPH_NODE);
-        expect(node.behavior).toStrictEqual(behavior1);
-        expect(node.goToBehaviors).toStrictEqual([behavior2]);
-
-        const foundNode = d.graph.findNode("AcceptBookFromUser");
-        expect(foundNode).toStrictEqual(node);
+        expect(node.getBehavior().name).toStrictEqual("AcceptBookFromUser");
+        expect(node.getGoToBehaviors()).toStrictEqual(goToBehaviorIds);
     });
 
     it("find node that was added using behavior name", () => {
         const d = new DALEngine({name: "Library Manager"});
-        const behavior1 = d.createBehavior({name: "AcceptBookFromUser"});
-        const behavior2 = d.createBehavior({name: "AddBookToBasket"});
-        const node = d.graph.addNode(behavior1, [behavior2])
+        const node = d.addNode("AcceptBookFromUser", []);
+
+        expect(() => {d.getNode("AcceptBookFrmUser")}).toThrow(UnknownBehaviorError);
 
-        const foundNode = d.graph.findNode("AcceptBookFromUser");
+        const foundNode = d.getNode("AcceptBookFromUser");
         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 behavior1 = d.createBehavior({name: "AcceptBookFromUser"});
-        const behavior2 = d.createBehavior({name: "AddBookToBasket"});
-        const behavior3 = d.createBehavior({name: "AnotherBehavior"});
-        d.graph.addNode(behavior1, [behavior2, behavior3]);
-        d.graph.addNode(behavior2, []);
-        d.graph.addNode(behavior3, []);
+        const node1 = d.addNode("AcceptBookFromUser", []);
+        const node2 = d.addNode("AddBookToBasket", []);
+        d.addNode("AnotherBehavior", []);
+
+        node1.addGoToBehavior("AddBookToBasket");
+        node2.addGoToBehavior("AnotherBehavior");
 
         // Misspell behavior name to trigger unknown behavior error
         expect(() => {
-            d.graph.setCurrentBehavior("AcceptBookromUser");
+            d.setCurrentBehavior("AcceptBookromUser");
         }).toThrow(UnknownBehaviorError);
 
-        d.graph.setCurrentBehavior("AcceptBookFromUser");
-        expect(d.graph.currentNode.behavior).toBe(behavior1);
+        d.setCurrentBehavior("AcceptBookFromUser");
+        expect(d.graph.currentNode).toBe(node1);
 
-        d.graph.goToBehavior("AddBookToBasket")
-        expect(d.graph.currentNode.behavior).toBe(behavior2);
+        d.goToBehavior("AddBookToBasket")
+        expect(d.graph.currentNode).toBe(node2);
 
         // Reset current behavior so transition is valid
-        d.graph.setCurrentBehavior("AcceptBookFromUser");
-        d.graph.goToBehavior("AnotherBehavior")
-        expect(d.graph.currentNode.behavior).toBe(behavior3);
+        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("AnotherBehavior")
+            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);
     });
 
@@ -125,13 +135,15 @@ describe("DALEngine", () => {
         );
         book.addInvariant(invariant);
 
-        const behavior1 = d.createBehavior({name: "AcceptBookFromUser"});
-        behavior1.addParticpant(book);
-        const behavior2 = d.createBehavior({name: "AddBookToBasket"});
-        const behavior3 = d.createBehavior({name: "AnotherBehavior"});
-        d.graph.addNode(behavior1, [behavior2, behavior3]);
-        d.graph.addNode(behavior2, []);
-        d.graph.addNode(behavior3, []);
+
+        d.addNode("AcceptBookFromUser", []);
+        d.addNode("AddBookToBasket", []);
+        d.addNode("AnotherBehavior", []);
+
+        d.getNode("AcceptBookFromUser").addGoToBehavior("AddBookToBasket");
+        d.getNode("AcceptBookFromUser").addGoToBehavior("AnotherBehavior");
+
+        d.getNode("AcceptBookFromUser").getBehavior().addParticipant(book);
 
         const filePath = resolve(__dirname, "./temp/inspectSerializeTemp.json")
         await writeFile(filePath, d.serialize())

package/tests/Invariant.test.js

@@ -72,28 +72,27 @@ describe("invariantTests", () => {
         ));
 
         // Create behavior and participant
-        const behavior1 = d.createBehavior({name: "AcceptBookFromUser"});
-        behavior1.addParticpant(book);
-        d.graph.addNode(behavior1, []);
+        const node1 = d.addNode("AcceptBookFromUser", []);
+        node1.getBehavior().addParticipant(book);
 
         // Add value that respects invariant and expect valid world state
-        behavior1.setParticipantValue("book", {
+        node1.getBehavior().setParticipantValue("book", {
             "uid": 1,
             "value": {
                 "name": "Harry Potter and Chamber of Secrets",
             },
         })
-        expect(behavior1.invalidWorldState).toBe(false);
+        expect(node1.getBehavior().invalidWorldState).toBe(false);
 
 
         // Add value that violates invariant and expect invalid world state
-        behavior1.setParticipantValue("book", {
+        node1.getBehavior().setParticipantValue("book", {
             "uid": 1,
             "value": {
                 "name": "",
             },
         })
-        expect(behavior1.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

@@ -8,31 +8,24 @@ describe("SimpleDesignTest", () => {
 
     it("create simple design", async () => {
         const d = new DALEngine({name: "Library Manager"});
-        let behavior = d.createBehavior({name: "AcceptChoiceToAddBookToBasket"});
-        const AcceptBookFromUser = d.createBehavior({name: "AcceptBookFromUser"});
-        d.graph.addNode(behavior, [AcceptBookFromUser]);
-        const AddBookToBasket = d.createBehavior({name: "AddBookToBasket"});
-        d.graph.addNode(AcceptBookFromUser, [AddBookToBasket]);
-
-        const AcceptChoiceToAuditLibrary = d.createBehavior({name: "AcceptChoiceToAuditLibrary"});
-        const GenerateAuditReport = d.createBehavior({name: "GenerateAuditReport"});
-        d.graph.addNode(AcceptChoiceToAuditLibrary, [GenerateAuditReport]);
-        const HandAuditToUser = d.createBehavior({name: "HandAuditToUser"});
-        d.graph.addNode(GenerateAuditReport, [HandAuditToUser]);
-
-        const AcceptChoiceToPlaceBooksOnShelf = d.createBehavior(
-            {name: "AcceptChoiceToPlaceBooksOnShelf"}
-        );
-        const GetBookFromBasket = d.createBehavior({name: "GetBookFromBasket"});
-        d.graph.addNode(AcceptChoiceToPlaceBooksOnShelf, [GetBookFromBasket]);
-        const GetFirstLetterOfBookName = d.createBehavior({name: "GetFirstLetterOfBookName"});
-        d.graph.addNode(GetBookFromBasket, [GetFirstLetterOfBookName]);
-        const CreateSlotOnBookShelf = d.createBehavior({name: "CreateSlotOnBookShelf"});
-        const AddBookToShelf = d.createBehavior({name: "AddBookToShelf"});
-        d.graph.addNode(GetFirstLetterOfBookName, [CreateSlotOnBookShelf]);
-        d.graph.addNode(GetFirstLetterOfBookName, [AddBookToShelf]);
-        d.graph.addNode(CreateSlotOnBookShelf, [AddBookToShelf]);
-        d.graph.addNode(AddBookToShelf, [GetBookFromBasket]);
+        d.addNode("AcceptChoiceToAddBookToBasket", ["AcceptBookFromUser"]);
+        d.addNode("AcceptBookFromUser", ["AddBookToBasket"]);
+        d.addNode("AddBookToBasket", []);
+        d.addNode("AcceptChoiceToAuditLibrary", ["GenerateAuditReport"]);
+        d.addNode("GenerateAuditReport", ["HandAuditToUser"]);
+        d.addNode("HandAuditToUser", []);
+
+        d.addNode("AcceptChoiceToPlaceBooksOnShelf", ["GetBookFromBasket"]);
+        d.addNode("GetBookFromBasket", ["GetFirstLetterOfBookName"]);
+        d.addNode("GetFirstLetterOfBookName", ["CreateSlotOnBookShelf", "AddBookToShelf"]);
+        d.addNode("CreateSlotOnBookShelf", ["AddBookToShelf"]);
+        d.addNode("AddBookToShelf", ["GetBookFromBasket"]);
+
+
+        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/
         const filePath2 = resolve(__dirname, "./temp/simple_design_mermaid.txt")