@indra.ai/deva 1.1.92 → 1.1.94

package/config.json

@@ -182,6 +182,12 @@
       },
       "actions": {
         "wait": "::agent.name:: is waiting",
+        "start": "::agent.name:: has started",
+        "enter": "::agent.name:: has entered deva.world",
+        "exit": "::agent.name:: has exited deva.world",
+        "stop": "::agent.name:: is stopped",
+        "load": "::agent.name:: is loaded",
+        "unload": "::agent.name:: is unloaded",
         "question": "::agent.name:: received a question",
         "question_ask": "::agent.name:: is asking another Deva",
         "question_ask_answer": "::agent.name:: answered what they were asked",

package/index.js

@@ -75,6 +75,132 @@ class Deva {
     }
   }
 
+  /**************
+  func: _assignBind
+  params: none
+  describe:
+    The assign bind function will bind the translate functions and parse functions
+    of the agent and bind their functionality to the state machine.
+  ***************/
+  _assignBind() {
+    return new Promise((resolve, reject) => {
+      try {
+        this.bind.forEach(bind => { // loop over the bind items func, method, listener...
+          if (this[bind]) for (let x in this[bind]) { // if the root has a bind func, method, listener
+            if (typeof this[bind][x] === 'function') { // check to make sure object is a fucntion
+              this[bind][x] = this[bind][x].bind(this); // bind the item from the bind object
+            }
+          }
+        });
+        // bind translate
+        const translate = this._agent && this._agent.translate && typeof this._agent.translate === 'function';
+        if (translate) this._agent.translate = this._agent.translate.bind(this);
+        // bind parser
+        const parse = this._agent && this._agent.parse && typeof this._agent.parse === 'function';
+        if (parse) this._agent.parse = this._agent.parse.bind(this);
+        // bind process
+        const process = this._agent && this._agent.process && typeof this._agent.process === 'function';
+        if (process) this._agent.process = this._agent.process.bind(this);
+      }
+      catch (e) {
+        return this.error(e, false, reject); // trigger the this.error for errors
+      }
+      finally {
+        return resolve(); // when the configuration is complete then return an empty resolve.
+      }
+    });
+  }
+
+  /**************
+  func: _assignListeners
+  params: none
+  describe:
+    Assign listeners will take the this.lisners objects and assign the appropriate
+    lisnter values for the event bus.
+  ***************/
+  _assignListeners() {
+    return new Promise((resolve, reject) => {
+      try {
+        // set the default listeners for the states of the agent.
+
+        for (let state in this._states) {
+          if (typeof this[state] === 'function') {
+            this.events.on(`${this._agent.key}:${state}`, packet => {
+              return this[state](packet);
+            });
+          }
+        }
+
+        // set the assigned listeners for the agent.
+        for (let listener in this.listeners) {
+          this.events.on(listener, packet => {
+            return this.listeners[listener](packet);
+          })
+        }
+        return resolve();
+      }
+      catch (e) {
+        return this.error(e, false, reject);
+      }
+    });
+  }
+
+  // Some elements will inherit the data of the parent. this object will loop over
+  // any children data that theis deva has and assign the inherited information.
+  /**************
+  func: _assignInherit
+  params: none
+  describe:
+    The assign inherit will make sure the Devas in the current Deva have all the
+    inherited properties all setup to collaborate efficiently.
+  ***************/
+  _assignInherit() {
+    return new Promise((resolve, reject) => {
+      try {
+        for (let d in this.devas) {
+          this.inherit.forEach(inherit => {
+            this.devas[d][inherit] = this[inherit];
+          });
+        }
+        return resolve();
+      }
+      catch (e) {
+        return this.error(e, false, reject);
+      }
+    });
+  }
+
+  // General handler for when a method is NOT found from a user command.
+  /**************
+  func: _methodNotFound
+  params:
+    - packet: The packet to relay when a method is not found.
+  describe:
+    The _methodNotFound function allows for additional security by firing
+    a specfici program functon every single time a interaction happens wehre a
+    method is not located. This assits in security and support by identifying
+    troubls or users who may be attemptng to explit features.
+
+    Then we talk a security event that watches all methods and return the packet.
+
+    This will return a not found text string preventing any furhter processing.
+  ***************/
+  _methodNotFound(packet) {
+    packet.a = {
+      id: this.uid(),
+      agent: this.agent() || false,
+      client: this.client() || false,
+      text: `${this._messages.method_not_found}`,
+      meta: {
+        key: this._agent.key,
+        method: packet.q.meta.method,
+      },
+      created: Date.now(),
+    };
+    this.state('method_not_found');
+    return packet;
+  }
+
   /**************
   func: Client
   params: client - client provided data.
@@ -520,131 +646,6 @@ class Deva {
       }
     });
   }
-  /**************
-  func: _assignBind
-  params: none
-  describe:
-    The assign bind function will bind the translate functions and parse functions
-    of the agent and bind their functionality to the state machine.
-  ***************/
-  _assignBind() {
-    return new Promise((resolve, reject) => {
-      try {
-        this.bind.forEach(bind => { // loop over the bind items func, method, listener...
-          if (this[bind]) for (let x in this[bind]) { // if the root has a bind func, method, listener
-            if (typeof this[bind][x] === 'function') { // check to make sure object is a fucntion
-              this[bind][x] = this[bind][x].bind(this); // bind the item from the bind object
-            }
-          }
-        });
-        // bind translate
-        const translate = this._agent && this._agent.translate && typeof this._agent.translate === 'function';
-        if (translate) this._agent.translate = this._agent.translate.bind(this);
-        // bind parser
-        const parse = this._agent && this._agent.parse && typeof this._agent.parse === 'function';
-        if (parse) this._agent.parse = this._agent.parse.bind(this);
-        // bind process
-        const process = this._agent && this._agent.process && typeof this._agent.process === 'function';
-        if (process) this._agent.process = this._agent.process.bind(this);
-      }
-      catch (e) {
-        return this.error(e, false, reject); // trigger the this.error for errors
-      }
-      finally {
-        return resolve(); // when the configuration is complete then return an empty resolve.
-      }
-    });
-  }
-
-  /**************
-  func: _assignListeners
-  params: none
-  describe:
-    Assign listeners will take the this.lisners objects and assign the appropriate
-    lisnter values for the event bus.
-  ***************/
-  _assignListeners() {
-    return new Promise((resolve, reject) => {
-      try {
-        // set the default listeners for the states of the agent.
-
-        for (let state in this._states) {
-          if (typeof this[state] === 'function') {
-            this.events.on(`${this._agent.key}:${state}`, packet => {
-              return this[state](packet);
-            });
-          }
-        }
-
-        // set the assigned listeners for the agent.
-        for (let listener in this.listeners) {
-          this.events.on(listener, packet => {
-            return this.listeners[listener](packet);
-          })
-        }
-        return resolve();
-      }
-      catch (e) {
-        return this.error(e, false, reject);
-      }
-    });
-  }
-
-  // Some elements will inherit the data of the parent. this object will loop over
-  // any children data that theis deva has and assign the inherited information.
-  /**************
-  func: _assignInherit
-  params: none
-  describe:
-    The assign inherit will make sure the Devas in the current Deva have all the
-    inherited properties all setup to collaborate efficiently.
-  ***************/
-  _assignInherit() {
-    return new Promise((resolve, reject) => {
-      try {
-        for (let d in this.devas) {
-          this.inherit.forEach(inherit => {
-            this.devas[d][inherit] = this[inherit];
-          });
-        }
-        return resolve();
-      }
-      catch (e) {
-        return this.error(e, false, reject);
-      }
-    });
-  }
-
-  // General handler for when a method is NOT found from a user command.
-  /**************
-  func: _methodNotFound
-  params:
-    - packet: The packet to relay when a method is not found.
-  describe:
-    The _methodNotFound function allows for additional security by firing
-    a specfici program functon every single time a interaction happens wehre a
-    method is not located. This assits in security and support by identifying
-    troubls or users who may be attemptng to explit features.
-
-    Then we talk a security event that watches all methods and return the packet.
-
-    This will return a not found text string preventing any furhter processing.
-  ***************/
-  _methodNotFound(packet) {
-    packet.a = {
-      id: this.uid(),
-      agent: this.agent() || false,
-      client: this.client() || false,
-      text: `${this._messages.method_not_found}`,
-      meta: {
-        key: this._agent.key,
-        method: packet.q.meta.method,
-      },
-      created: Date.now(),
-    };
-    this.state('method_not_found');
-    return packet;
-  }
 
   /**************
   func: talk
@@ -848,7 +849,7 @@ class Deva {
       };
 
       // create a hash for the answer and insert into answer meta.
-      packet_answer.meta.hash = this.hash(JSON.stringify(packet_answer));
+      packet_answer.meta.hash = this.hash(packet_answer);
 
       packet.a = this.copy(packet_answer);
       packet.hash = this.hash(packet);     // hash the entire packet.
@@ -974,6 +975,9 @@ class Deva {
   usage: this.init(client_object)
   ***************/
   init(client) {
+    // set client
+    this._active = Date.now();
+
     const _data = {
       id: this.uid(true),
       key: 'return',
@@ -985,8 +989,6 @@ class Deva {
     }
     _data.hash = this.hash(_data);
 
-    // set client
-    this._active = Date.now();
     return new Promise((resolve, reject) => {
       this.events.setMaxListeners(this.maxListeners);
       this._assignInherit().then(() => {
@@ -1026,7 +1028,7 @@ class Deva {
     if (!this._active) return Promise.resolve(this._messages.states.offline);
     data.value = 'start';
     delete data.hash;
-    data.hash = this.hash(JSON.stringify(data));
+    data.hash = this.hash(data);
 
     if (this.info) {
       const _info = this.info(data.id);
@@ -1054,7 +1056,7 @@ class Deva {
     if (!this._active) return Promise.resolve(this._messages.states.offline);
     data.value = 'enter';
     delete data.hash;
-    data.hash = this.hash(JSON.stringify(data));
+    data.hash = this.hash(data);
     this.action(data.value);
     const hasOnEnter = this.onEnter && typeof this.onEnter === 'function' ? true : false;
     return hasOnEnter ? this.onEnter(data) : this.done(data)
@@ -1076,7 +1078,7 @@ class Deva {
     if (!this._active) return Promise.resolve(this._messages.states.offline);
     data.value = 'done';
     delete data.hash;
-    data.hash = this.hash(JSON.stringify(data));
+    data.hash = this.hash(data);
     this.action(data.value)
     const hasOnDone = this.onDone && typeof this.onDone === 'function' ? true : false;
     return hasOnDone ? this.onDone(data) : Promise.resolve(data);
@@ -1107,7 +1109,7 @@ class Deva {
       text: this._messages.states.stop,
       created: Date.now(),
     }
-    data.hash = this.hash(JSON.stringify(data));
+    data.hash = this.hash(data);
     this.action(data.value);
     const hasOnStop = this.onStop && typeof this.onStop === 'function';
     return hasOnStop ? this.onStop(data) : this.exit(data)
@@ -1133,7 +1135,7 @@ class Deva {
     this._active = false;
     data.value = 'exit';
     delete data.hash;
-    data.hash = this.hash(JSON.stringify(data));
+    data.hash = this.hash(data);
 
     // clear memory
     this._active = false;
@@ -1174,7 +1176,7 @@ class Deva {
         text,
         created: Date.now(),
       };
-      _data.hash = this.hash(JSON.stringify(_data));
+      _data.hash = this.hash(_data);
       this.talk(config.events.state, _data);
     } catch (e) {
       return this.error(e);
@@ -1210,7 +1212,7 @@ class Deva {
         data,
         created: Date.now(),
       };
-      _data.hash = this.hash(JSON.stringify(_data));
+      _data.hash = this.hash(_data);
       this.talk(config.events.zone, _data);
     } catch (e) {
       return this.error(e);
@@ -1237,7 +1239,7 @@ class Deva {
         text,
         created: Date.now(),
       };
-      _data.hash = this.hash(JSON.stringify(_data));
+      _data.hash = this.hash(_data);
       this.talk(config.events.action, _data);
     } catch (e) {
       return this.error(e)
@@ -1264,7 +1266,7 @@ class Deva {
         data,
         created: Date.now(),
       };
-      _data.hash = this.hash(JSON.stringify(_data));
+      _data.hash = this.hash(_data);
       this.talk(config.events.feature, _data);
     } catch (e) {
       return this.error(e);
@@ -1277,19 +1279,19 @@ class Deva {
     - st: The context flag to set for the Deva that matches to this._contexts
   describe
   ***************/
-  context(text) {
+  context(value) {
     try {
-      this._context = text;
+      this._context = value;
       const _data = {
         id: this.uid(true),
         key: 'context',
-        value: 'context',
+        value,
         agent: this.agent(),
         client: this.client(),
-        text,
+        text: this.vars.context[value] || value,
         created: Date.now(),
       };
-      _data.hash = this.hash(JSON.stringify(_data));
+      _data.hash = this.hash(_data);
       this.talk(config.events.context, _data);
     } catch (e) {
       return this.error(e);
@@ -1606,7 +1608,6 @@ class Deva {
       const max = Math.floor(Date.now() + (Date.now() * Math.PI));
       id = Math.floor(Math.random() * (max - min)) + min;
     }
-    this.action('uid');
     return id;
   }
 
@@ -1625,7 +1626,6 @@ class Deva {
     const the_hash = createHash(algo);
     the_hash.update(str.toString());
     const _digest = the_hash.digest('base64');
-    this.action('hash');
     return `${algo}:${_digest}`;
   }
 
@@ -1648,7 +1648,7 @@ class Deva {
     const _cipher = createCipheriv(algorithm, key_in_bytes, iv);
     const encrypted = _cipher.update(String(str), 'utf8', 'hex') + _cipher.final('hex');
 
-    this.action('cipher');
+
     return {
       iv: iv.toString('base64'),
       key,
@@ -1665,7 +1665,6 @@ class Deva {
     const decipher = createDecipheriv( algorithm, key_in_bytes, iv);
     const decrypted = decipher.update(encrypted);
     const final = Buffer.concat([decrypted, decipher.final()]);
-    this.action('decipher');
     return final.toString();
   }
 
@@ -1688,7 +1687,6 @@ class Deva {
     // create the text msg string
     let text = `${this._agent.profile.name} active since ${dateFormat}`;
     if (msg) text = text + `\n${msg}`;                      // append the msg string if msg true.
-    this.action('status');
     return Promise.resolve(text);                           // return final text string
   }
 
@@ -1831,6 +1829,11 @@ class Deva {
     return splitter.slice(0, maxwords).join(' ');
   }
 
+  /**************
+  func: dupes
+  params: dupers
+  describe: remove duplicees from an array.
+  ***************/
   dupes(dupers) {
     if (!Array.isArray(dupers)) return dupers;
     const check = [];
@@ -1842,6 +1845,31 @@ class Deva {
     });
   }
 
+  /**************
+  func: help
+  params:
+    - msg: the help msg to search against
+    - help_dir: base directory of the deva help files.
+  describe:
+    the help utility makes it easy to create help files for your deva. the utility
+    checks the existence of a help file in the passed in directory then if
+    one exists it will then present it based on the users request text input.
+  ***************/
+  help(msg, help_dir) {
+    return new Promise((resolve, reject) => {
+      const params = msg.split(' ');
+      let helpFile = 'main';
+      if (params[0]) helpFile = params[0];
+      if (params[1]) helpFile = `${params[0]}_${params[1]}`;
+      helpFile = path.join(help_dir, 'help', `${helpFile}.feecting`);
+      try {
+        return resolve(fs.readFileSync(helpFile, 'utf8'))
+      } catch (e) {
+        return reject(e)
+      }
+    });
+  }
+
   /**************
   func: error
   params:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indra.ai/deva",
-  "version": "1.1.92",
+  "version": "1.1.94",
   "description": "The Deva Core",
   "main": "index.js",
   "scripts": {
@@ -27,8 +27,8 @@
     }
   },
   "engines": {
-    "npm": ">=6.0.0",
-    "node": ">=10.0.0"
+    "npm": ">=9.5.1",
+    "node": ">=18.16.0"
   },
   "dependencies": {}
 }