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

package/dist/index.cjs

@@ -42,18 +42,6 @@ class UnknownBehaviorError extends DALEngineError {
     }
 }
 
-let ENGINE_TYPES = {
-    BEHAVIOR: 1,
-    INVARIANT: 2,
-    PARTICIPANT: 3,
-    PRIMITIVE: 4,
-    BEHAVIORAL_CONTROL_GRAPH: 5,
-    GRAPH_NODE: 6,
-};
-ENGINE_TYPES = Object.freeze(ENGINE_TYPES);
-
-var ENGINE_TYPES$1 = ENGINE_TYPES;
-
 class MissingAttributes extends DALEngineError {
     constructor (type, attribute) {
         let msg;
@@ -66,6 +54,18 @@ class MissingAttributes extends DALEngineError {
     }
 }
 
+let ENGINE_TYPES = {
+    BEHAVIOR: 1,
+    INVARIANT: 2,
+    PARTICIPANT: 3,
+    PRIMITIVE: 4,
+    BEHAVIORAL_CONTROL_GRAPH: 5,
+    GRAPH_NODE: 6,
+};
+ENGINE_TYPES = Object.freeze(ENGINE_TYPES);
+
+var ENGINE_TYPES$1 = ENGINE_TYPES;
+
 /**
  * Class representing a Invariant in the design.
  */
@@ -389,6 +389,7 @@ class GraphNode extends Base {
         this.type = ENGINE_TYPES$1.GRAPH_NODE;
         this._behavior = null;
         this._goToBehaviorIds = [];
+        this._isAtomic = false;
         if (typeof args === "object" && args !== null) {
             if (Object.hasOwn(args, "uid")) {
                 this._loadNodeFromJSON(args);
@@ -448,6 +449,10 @@ class GraphNode extends Base {
         this._goToBehaviorIds.push(...behaviorIds);
     }
 
+    /**
+     * Remove the behavior from the list of transitions.
+     * @param {String} behaviorId
+     */
     removeGoToBehavior (behaviorId) {
         const goToIndex = this._goToBehaviorIds.indexOf(behaviorId);
         if (goToIndex > -1) {
@@ -455,6 +460,22 @@ class GraphNode extends Base {
         }
     }
 
+    /**
+     * Raises a flag to indicate if the behavior is atomic or not.
+     * @param {Boolean} isAtomic Flag indicates if the behavior is atomic.
+     */
+    setAtomic (isAtomic) {
+        this._isAtomic = isAtomic;
+    }
+
+    /**
+     * Returns whether the behavior is atomic or not.
+     * @returns {Boolean}
+     */
+    isAtomic () {
+        return this._isAtomic;
+    }
+
     /**
      * Checks if the provided behavior name is a valid
      * transition from this node.
@@ -509,14 +530,16 @@ class BehavioralControlGraph extends Base {
 
     /**
      * Adds a node to the graph.
-     * @param {Behavior} behavior
+     * @param {Behavior} behaviorId
      * @param {Array} goToBehaviorsIds
+     * @param {Boolean} isAtomic
      * @returns
      */
-    _addNode (behavior, goToBehaviorsIds) {
+    _addNode (behaviorId, goToBehaviorsIds, isAtomic) {
         const node = new GraphNode({
-            behavior: behavior,
-            goToBehaviorsIds: goToBehaviorsIds,
+            behavior: new Behavior({name: behaviorId}),
+            goToBehaviorsIds: goToBehaviorsIds?goToBehaviorsIds:[],
+            isAtomic: isAtomic?isAtomic:false,
         });
         this.nodes.push(node);
         return node;
@@ -605,6 +628,7 @@ class BehavioralControlGraph extends Base {
 class DALEngine {
     constructor (args) {
         this.graph = new BehavioralControlGraph();
+        this.atomicGraphs = [];
         this.loadArgs(args);
     }
 
@@ -684,12 +708,11 @@ class DALEngine {
      * 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});
-        const goToIds = goToBehaviorsIds?goToBehaviorsIds:[];
-        return this.graph._addNode(behavior, goToIds);
+    addNode (behaviorId, goToBehaviorsIds, isAtomic) {
+        return this.graph._addNode(behaviorId, goToBehaviorsIds, isAtomic);
     }
 
     /**
@@ -714,7 +737,6 @@ class DALEngine {
         this.graph._setCurrentBehavior(behaviorId);
     }
 
-
     /**
      * Transitions the graph to the given behavior if it
      *  is a valid transition from the current behavior.

package/dist/index.esm.js

@@ -40,18 +40,6 @@ class UnknownBehaviorError extends DALEngineError {
     }
 }
 
-let ENGINE_TYPES$1 = {
-    BEHAVIOR: 1,
-    INVARIANT: 2,
-    PARTICIPANT: 3,
-    PRIMITIVE: 4,
-    BEHAVIORAL_CONTROL_GRAPH: 5,
-    GRAPH_NODE: 6,
-};
-ENGINE_TYPES$1 = Object.freeze(ENGINE_TYPES$1);
-
-var ENGINE_TYPES = ENGINE_TYPES$1;
-
 class MissingAttributes extends DALEngineError {
     constructor (type, attribute) {
         let msg;
@@ -64,6 +52,18 @@ class MissingAttributes extends DALEngineError {
     }
 }
 
+let ENGINE_TYPES$1 = {
+    BEHAVIOR: 1,
+    INVARIANT: 2,
+    PARTICIPANT: 3,
+    PRIMITIVE: 4,
+    BEHAVIORAL_CONTROL_GRAPH: 5,
+    GRAPH_NODE: 6,
+};
+ENGINE_TYPES$1 = Object.freeze(ENGINE_TYPES$1);
+
+var ENGINE_TYPES = ENGINE_TYPES$1;
+
 /**
  * Class representing a Invariant in the design.
  */
@@ -387,6 +387,7 @@ class GraphNode extends Base {
         this.type = ENGINE_TYPES.GRAPH_NODE;
         this._behavior = null;
         this._goToBehaviorIds = [];
+        this._isAtomic = false;
         if (typeof args === "object" && args !== null) {
             if (Object.hasOwn(args, "uid")) {
                 this._loadNodeFromJSON(args);
@@ -446,6 +447,10 @@ class GraphNode extends Base {
         this._goToBehaviorIds.push(...behaviorIds);
     }
 
+    /**
+     * Remove the behavior from the list of transitions.
+     * @param {String} behaviorId
+     */
     removeGoToBehavior (behaviorId) {
         const goToIndex = this._goToBehaviorIds.indexOf(behaviorId);
         if (goToIndex > -1) {
@@ -453,6 +458,22 @@ class GraphNode extends Base {
         }
     }
 
+    /**
+     * Raises a flag to indicate if the behavior is atomic or not.
+     * @param {Boolean} isAtomic Flag indicates if the behavior is atomic.
+     */
+    setAtomic (isAtomic) {
+        this._isAtomic = isAtomic;
+    }
+
+    /**
+     * Returns whether the behavior is atomic or not.
+     * @returns {Boolean}
+     */
+    isAtomic () {
+        return this._isAtomic;
+    }
+
     /**
      * Checks if the provided behavior name is a valid
      * transition from this node.
@@ -507,14 +528,16 @@ class BehavioralControlGraph extends Base {
 
     /**
      * Adds a node to the graph.
-     * @param {Behavior} behavior
+     * @param {Behavior} behaviorId
      * @param {Array} goToBehaviorsIds
+     * @param {Boolean} isAtomic
      * @returns
      */
-    _addNode (behavior, goToBehaviorsIds) {
+    _addNode (behaviorId, goToBehaviorsIds, isAtomic) {
         const node = new GraphNode({
-            behavior: behavior,
-            goToBehaviorsIds: goToBehaviorsIds,
+            behavior: new Behavior({name: behaviorId}),
+            goToBehaviorsIds: goToBehaviorsIds?goToBehaviorsIds:[],
+            isAtomic: isAtomic?isAtomic:false,
         });
         this.nodes.push(node);
         return node;
@@ -603,6 +626,7 @@ class BehavioralControlGraph extends Base {
 class DALEngine {
     constructor (args) {
         this.graph = new BehavioralControlGraph();
+        this.atomicGraphs = [];
         this.loadArgs(args);
     }
 
@@ -682,12 +706,11 @@ class DALEngine {
      * 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});
-        const goToIds = goToBehaviorsIds?goToBehaviorsIds:[];
-        return this.graph._addNode(behavior, goToIds);
+    addNode (behaviorId, goToBehaviorsIds, isAtomic) {
+        return this.graph._addNode(behaviorId, goToBehaviorsIds, isAtomic);
     }
 
     /**
@@ -712,7 +735,6 @@ class DALEngine {
         this.graph._setCurrentBehavior(behaviorId);
     }
 
-
     /**
      * Transitions the graph to the given behavior if it
      *  is a valid transition from the current behavior.

package/package.json

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

package/src/BehavioralControlGraph/BehavioralControlGraph.js

@@ -1,6 +1,7 @@
 import Base from "../Base";
 import InvalidTransitionError from "../Errors/InvalidTransitionError";
 import UnknownBehaviorError from "../Errors/UnknownBehaviorError";
+import Behavior from "../Members/Behavior";
 import ENGINE_TYPES from "../TYPES";
 import GraphNode from "./GraphNode";
 
@@ -42,14 +43,16 @@ class BehavioralControlGraph extends Base {
 
     /**
      * Adds a node to the graph.
-     * @param {Behavior} behavior
+     * @param {Behavior} behaviorId
      * @param {Array} goToBehaviorsIds
+     * @param {Boolean} isAtomic
      * @returns
      */
-    _addNode (behavior, goToBehaviorsIds) {
+    _addNode (behaviorId, goToBehaviorsIds, isAtomic) {
         const node = new GraphNode({
-            behavior: behavior,
-            goToBehaviorsIds: goToBehaviorsIds,
+            behavior: new Behavior({name: behaviorId}),
+            goToBehaviorsIds: goToBehaviorsIds?goToBehaviorsIds:[],
+            isAtomic: isAtomic?isAtomic:false,
         });
         this.nodes.push(node);
         return node;

package/src/BehavioralControlGraph/GraphNode.js

@@ -15,6 +15,7 @@ class GraphNode extends Base {
         this.type = ENGINE_TYPES.GRAPH_NODE;
         this._behavior = null;
         this._goToBehaviorIds = [];
+        this._isAtomic = false;
         if (typeof args === "object" && args !== null) {
             if (Object.hasOwn(args, "uid")) {
                 this._loadNodeFromJSON(args);
@@ -75,6 +76,10 @@ class GraphNode extends Base {
         this._goToBehaviorIds.push(...behaviorIds);
     }
 
+    /**
+     * Remove the behavior from the list of transitions.
+     * @param {String} behaviorId
+     */
     removeGoToBehavior (behaviorId) {
         const goToIndex = this._goToBehaviorIds.indexOf(behaviorId);
         if (goToIndex > -1) {
@@ -82,6 +87,22 @@ class GraphNode extends Base {
         }
     }
 
+    /**
+     * Raises a flag to indicate if the behavior is atomic or not.
+     * @param {Boolean} isAtomic Flag indicates if the behavior is atomic.
+     */
+    setAtomic (isAtomic) {
+        this._isAtomic = isAtomic;
+    }
+
+    /**
+     * Returns whether the behavior is atomic or not.
+     * @returns {Boolean}
+     */
+    isAtomic () {
+        return this._isAtomic;
+    }
+
     /**
      * Checks if the provided behavior name is a valid
      * transition from this node.

package/src/BehavioralControlGraph/Graphs.js

@@ -0,0 +1,35 @@
+import BehavioralControlGraph from "./BehavioralControlGraph";
+
+/**
+ * Class representing a collection of atomic graphs.
+ *
+ * These graphs together represent the design. I chose to separate
+ * them into their graphs because as the design grows larger, it will
+ * be easier to manage the design if it is separated into smaller graphs.
+ * It is also easier to visualize in the UI in managable way.
+ */
+export class Graphs {
+
+    constructor () {
+        this._graphs = {};
+    }
+
+    /**
+     * Adds a graph to the collection of graphs.
+     * @param {String} graphId ID of the graph.
+     * @returns {BehavioralControlGraph} The graph that was added.
+     */
+    addGraph (graphId) {
+        this._graphs[graphId] = new BehavioralControlGraph();
+        return this._graphs[graphId];
+    }
+
+    /**
+     * Returns the graph with the given graphId.
+     * @param {String} graphId ID of the graph to return.
+     * @returns {BehavioralControlGraph} The graph with the given graphId.
+     */
+    getGraph (graphId) {
+        return this._graphs[graphId];
+    }
+}

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);
     }
 
@@ -99,12 +100,11 @@ export class DALEngine {
      * 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});
-        const goToIds = goToBehaviorsIds?goToBehaviorsIds:[];
-        return this.graph._addNode(behavior, goToIds);
+    addNode (behaviorId, goToBehaviorsIds, isAtomic) {
+        return this.graph._addNode(behaviorId, goToBehaviorsIds, isAtomic);
     }
 
     /**
@@ -129,7 +129,6 @@ export class DALEngine {
         this.graph._setCurrentBehavior(behaviorId);
     }
 
-
     /**
      * Transitions the graph to the given behavior if it
      *  is a valid transition from the current behavior.