@indra.ai/deva 1.2.18 → 1.2.20

package/config.json

@@ -30,6 +30,16 @@
     "context": false,
     "zone": "deva",
     "zones": {
+      "init": "Initialize",
+      "start": "Start",
+      "stop": "Stop",
+      "enter": "Enter",
+      "exit": "Exit",
+      "finish": "Finish",
+      "done": "Done",
+      "question": "Question",
+      "ask": "Ask",
+      "answer": "Answer",
       "deva": "Deva",
       "client": "Client",
       "agent": "Agent",
@@ -51,7 +61,6 @@
       "comedy": "Comedy",
       "drama": "Drama",
       "scifi": "SciFi",
-      "finish": "Finish",
       "help": "Help",
       "error": "ERROR!"
     },
@@ -66,6 +75,7 @@
       "listen": "Listen",
       "ask": "Ask",
       "question": "Question",
+      "cmd": "Command",
       "answer": "Answer",
       "ready": "Ready",
       "wait": "Waiting",
@@ -102,6 +112,8 @@
       "put": "Put",
       "push": "Push",
       "pull": "Pull",
+      "set": "Set",
+      "response": "Response",
       "invalid": "INVALID!",
       "abort": "ABORT!",
       "error": "ERROR!",
@@ -135,25 +147,23 @@
       "list": "List items",
       "reply": "Reply",
       "set": "Set",
+      "get": "Get",
       "return": "Return",
 
-      "question_ask": "Question ask",
-      "question_ask_answer": "Question ask answer",
+      "question_ask": "Ask question",
+      "question_ask_answer": "Answer question asked",
       "question_cmd": "Question command",
       "question_method": "Question method",
       "question_talk": "Question talk",
-      "question_answer": "Question answer",
+      "question_answer": "Answer question",
       "question_done": "Question done",
 
       "answer": "Answer",
-      "answer_talk": "Answer talk",
       "ask": "Ask",
-      "ask_answer": "Ask answer",
 
-      "security": "SECURITY",
-      "support": "SUPPORT",
-      "systems": "SYSTMS",
-      "services": "SERVICES",
+      "security": "Get Security",
+      "support": "Get Support",
+      "services": "Get Services",
 
       "Client": "Set client",
       "Security": "Set Security",

package/index.js

@@ -10,7 +10,7 @@ const { createHash, randomUUID, createCipheriv, createDecipheriv, randomBytes }
 const config = require('./config.json').DATA // load the deva core configuration data.
 class Deva {
   constructor(opts) {
-    opts = opts || {};
+    opts = opts || {}; // set opts to provided opts or an empty object.
     this._id = randomUUID(); // the unique id assigned to the agent at load
     this._info = opts.info || false; // the deva information from the package file.
     this._config = opts.config || {}; // local Config Object
@@ -20,17 +20,9 @@ class Deva {
     this._security = false; // inherited Security features.
     this._support = false; // inherited Support features.
     this._services = false; // inherited Service features.
-    this.os = require('os'); // It is used to provide basic operating system related utility functions.
-    this.fs = require('fs'); // this is so file system functions are in the core.
-    this.path = require('path'); // this is so we can get path in the system.
-    this.crypto = require('crypto'); // It is used to support cryptography for encryption and decryption.
-    this.zlib = require('zlib'); // provides compression functionality using Gzip, Deflate/Inflate, and Brotli.
-    this.dns = require('dns'); // It is used to lookup and resolve on domain names.
-    this.net = require('net'); // It used to create TCP server/client communicate using TCP protocol.
-    this.http = require('http'); // It is used to create Http server and Http client.
-    this.https = require('https'); // It is used to create Http server and Http client.
-    this.url = require('url'); // It is used for URL resolution and parsing.
-    this.assert = require('assert'); // It is used for testing itself.
+    this.os = os; // It is used to provide basic operating system related utility functions.
+    this.fs = fs; // this is so file system functions are in the core.
+    this.path = path; // this is so we can get path in the system.
     this.events = opts.events || new EventEmitter({}); // Event Bus
     this.libs = opts.libs || {}; // used for loading library functions
     this.utils = opts.utils || {}; // parse function
@@ -109,7 +101,6 @@ class Deva {
     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 => {
@@ -119,15 +110,17 @@ class Deva {
         }
 
         // set the assigned listeners for the agent.
-        for (let listener in this.listeners) {
-          this.events.on(listener, packet => {
-            return this.listeners[listener](packet);
+        for (let listener in this.listeners) { // loop over the liteners
+          this.events.on(listener, packet => { // set the event listener
+            return this.listeners[listener](packet); // return the listener function
           })
         }
-        return resolve();
       }
       catch (e) {
-        return this.error(e, false, reject);
+        return this.error(e, false, reject); // pass errors to this.error
+      }
+      finally {
+        return resolve(); // resolve the function after everything is done.
       }
     });
   }
@@ -208,7 +201,6 @@ class Deva {
         if (isFunc) this.methods[y] = methods[y].bind(this);
       }
     }
-    // console.log('CLINET BEFORE COPY', client);
     const _client = this.copy(client);                // copy the client parameter
     this._client = _client;                           // set local _client to this scope
     return Promise.resolve();
@@ -352,9 +344,9 @@ class Deva {
   /**************
   func: listen
   params:
-    - evt:      The vent label to listen for
+    - evt: The vent label to listen for
     - callback: The callback function to run when the event fires.
-  describe:
+  describe: setup a new event listener in the system.
   ***************/
   listen(evt, callback) {
     this.listeners[evt] = callback;
@@ -366,8 +358,7 @@ class Deva {
   /**************
   func: once
   params:
-    - evt:      The event to listen to for a once call. These event are handy
-                when waiting for a key response one time.
+    - evt: The event to listen to for a once call.
     - callback: The callback functoin to run when the event fires.
   describe:
   ***************/
@@ -378,10 +369,9 @@ class Deva {
   /**************
   func: ignore
   params:
-    - evt:      The event you'd like to ignore.
+    - evt: The event you'd like to ignore.
     - callback: a callback function to execute after removing the event from listerns.
-  describe:
-    The ignore function allow the removal of events that are in the existing devas lister group.
+  describe: The ignore function allow the removal of events in the listener group.
   ***************/
   ignore(evt, callback) {
     return this.events.removeListener(evt, callback);
@@ -399,10 +389,9 @@ class Deva {
   question(TEXT=false, DATA=false) {
     // check the active status
     if (!this._active) return Promise.resolve(this._messages.offline);
-
-    this.state('question');
-    const id = this.uid();                                // generate a unique id for transport.
-    const t_split = TEXT.split(' ');                      // split the text on spaces to get words.
+    this.zone('question'); // set the zone to question.
+    const id = this.uid(); // generate a unique id for transport.
+    const t_split = TEXT.split(' '); // split the text on spaces to get words.
 
     // check to see if the string is an #ask string to talk to the other Deva.
     const isAsk = t_split[0].startsWith(this.askChr);
@@ -411,79 +400,81 @@ class Deva {
     const isCmd = t_split[0].startsWith(this.cmdChr);
 
     // Format the packet for return on the request.
-    const data = DATA;                                    // set the DATA to data
-    const packet = {                                      // create the base q/a packet
-      id,                                                 // set the id into packet
-      q: false,                                              // create empty q object in packet
-      a: false,                                              // create empty a object in packet
-      created: Date.now(),                                // timestamp the packet
+    const data = DATA; // set the DATA to data
+    const packet = { // create the base q/a packet
+      id, // set the id into packet
+      q: false, // create empty q object in packet
+      a: false, // create empty a object in packet
+      created: Date.now(), // timestamp the packet
     };
 
-    let text = TEXT,                                      // let TEXT is text for a manipulation variable
-        params = false,                                   // params as false to build params string
-        method = 'question',                              // set the default method to question
-        key = this._agent.key;                            // set a temporary key from the agent key.
+    let text = TEXT, // let TEXT is text for a manipulation variable
+        params = false, // params as false to build params string
+        method = 'question', // set the default method to question
+        key = this._agent.key; // set a temporary key from the agent key.
 
     return new Promise((resolve, reject) => {
       // resolve with the no text message if the client says nothing.
       if (!TEXT) return this.finish(this._messages.notext, resolve);
-      // reject question if Deva offline
-      if (!this._active) return this.finish(this._messages.offline, resolve);
-      let _action = 'question'
-      try {                                               // try to answer the question
-        if (isAsk) {                                      // determine if hte question isAsk
+      let _action = 'question'; // set the initial _action to question.
+      this.state('question'); // set the state to question
+      try { // try to answer the question
+        if (isAsk) { // determine if hte question isAsk
+          this.state('ask');
           _action = 'question_ask';
-          key = t_split[0].substring(1);                  // if:isAsksplit the agent key and remove first command character
+          // if:isAsk split the agent key and remove first command character
+          key = t_split[0].substring(1);
           //if:isAsk use text split index 1 as the parameter block
           params = t_split[1] ? t_split[1].split(':') : false;
-          method = params[0];                             // the method to check is then params index 0
-          text = t_split.slice(2).join(' ').trim();       // then rejoin the text with spaces.
+          method = params[0]; // the method to check is then params index 0
+          text = t_split.slice(2).join(' ').trim(); // rejoin the text with space
         }
-        else if (isCmd) {                                 // determine if the question is a command
+        else if (isCmd) { // determine if the question is a command
+          this.state('cmd'); // set the state to cmd.
           _action = 'question_cmd';
           //if:isCmd use text split index 1 as the parameter block
           params = t_split[0] ? t_split[0].split(':').slice(1) : false;
-          method = t_split[0].substring(1);               // if:isCmd use the 0 index as the command
-          text = t_split.slice(1).join(' ').trim();       // if:isCmd rejoin the string on the space after removing first index
+          method = t_split[0].substring(1); // if:isCmd use the 0 index as the command
+          text = t_split.slice(1).join(' ').trim(); // if:isCmd rejoin the string on the space after removing first index
         }
 
-        packet.q = {                                      // build packet.q container
-            id: this.uid(),
-            agent: this.agent() || false,                  // set the agent
-            client: this.client() || false,                // set the client
-            meta: {                                       // build the meta container
-              key,                                        // set the key variable
-              method,                                     // set method to track function use
-              params,                                     // set any params that are associated
+        this.state('data');
+        packet.q = { // build packet.q container
+            id: this.uid(), // set the transport id for the question.
+            agent: this.agent(), // set the agent
+            client: this.client(), // set the client
+            meta: { // build the meta container
+              key, // set the key variable
+              method, // set method to track function use
+              params, // set any params that are associated
             },
-            text,                                         // set the text for the packet.
-            data,                                         // set the data object
-            created: Date.now(),                          // timestamp the question
+            text, // set the text for the packet.
+            data, // set the data object
+            created: Date.now(), // timestamp the question
         }
 
         // hash the question
         packet.q.meta.hash = this.hash(packet.q);
 
-        this.action(_action);
+        this.action(_action); // set current action to what was defined by _action variable.
         this.talk(config.events.question, this.copy(packet)); // global question event make sure to copy data.
 
-        if (isAsk) {                                      // isAsk check if the question isAsk and talk
+        if (isAsk) { // isAsk check if the question isAsk and talk
           // if: isAsk wait for the once event which is key'd to the packet ID for specified responses
           this.talk(`${key}:ask`, packet);
           this.once(`${key}:ask:${packet.id}`, answer => {
             this.action('question_ask_answer');
-
             this.talk(config.events.ask, this.copy(answer));
-            return this.finish(answer, resolve);                       // if:isAsk resolve the answer from the call
+            return this.finish(answer, resolve); // if:isAsk resolve the answer from the call
           });
         }
-        else {                                            // else: answer tue question locally
+        else { // else: answer tue question locally
           this.action('question_answer');
           return this.answer(packet, resolve, reject);
         }
       }
-      catch(e) {                                          // try block error trap
-        return this.error(e);                             // if a overall error happens this witll call this.error
+      catch(e) {
+        return this.error(e); // if a overall error happens this witll call this.error
       }
     });
   }
@@ -500,7 +491,9 @@ class Deva {
   ***************/
   answer(packet, resolve, reject) {
     if (!this._active) return Promise.resolve(this._messages.offline);
-    this.state('answer');
+    this.zone('answer');
+    const agent = this.agent();
+    const client = this.client();
     // check if method exists and is of type function
     const {method,params} = packet.q.meta;
     const isMethod = this.methods[method] && typeof this.methods[method] == 'function';
@@ -509,7 +502,7 @@ class Deva {
     }
     // Call the local method to process the question based the extracted parameters
     return this.methods[method](packet).then(result => {
-      this.action('answer');
+      this.state('answer');
       // check the result for the text, html, and data object.
       // this is for when answers are returned from nested Devas.
       const text = typeof result === 'object' ? result.text : result;
@@ -517,28 +510,25 @@ class Deva {
       // if the data passed is NOT an object it will FALSE
       const data = typeof result === 'object' ? result.data : false;
 
-      const agent = this.agent() || false;
-      const client = this.client() || false;
-      const packet_answer = {                                  // setup the packet.a container
+      const packet_answer = { // setup the packet.a container
         id: this.uid(),
-        agent,                                      // set the agent who answered the question
-        client,                                     // set the client asking the question
-        meta: {                                     // setup the answer meta container
-          key: agent.key,                           // set the agent key inot the meta
-          method,                                   // set the method into the meta
-          params,                                   // set the params into the meta
+        agent, // set the agent who answered the question
+        client, // set the client asking the question
+        meta: { // setup the answer meta container
+          key: agent.key, // set the agent key inot the meta
+          method, // set the method into the meta
+          params, // set the params into the meta
         },
-        text,                                       // set answer text
-        html,                                       // set the answer html
-        data,                                       // set the answer data
-        created: Date.now(),
+        text, // set answer text
+        html, // set the answer html
+        data, // set the answer data
+        created: Date.now(), // set the created date for the answer
       };
 
       // create a hash for the answer and insert into answer meta.
       packet_answer.meta.hash = this.hash(packet_answer);
-
-      packet.a = packet_answer;
-      this.action('answer_talk');
+      packet.a = packet_answer; // set the packet.a to the packet_answer
+      this.action('answer'); // set the action to answer
       this.talk(config.events.answer, this.copy(packet)); // global talk event
       return this.finish(packet, resolve); // resolve the packet to the caller.
     }).catch(err => { // catch any errors in the method
@@ -564,7 +554,7 @@ class Deva {
   ask(packet) {
     if (!this._active) return Promise.resolve(this._messages.offline);
 
-    this.state('ask');
+    this.zone('ask');
 
     const agent = this.agent();
     const client = this.client();
@@ -587,14 +577,14 @@ class Deva {
     try {
       if (typeof this.methods[packet.q.meta.method] !== 'function') {
         return setImmediate(() => {
-          this.action('invalid')
+          this.action('invalid');
           this.talk(`${this._agent.key}:ask:${packet.id}`, this._methodNotFound(packet));
         });
       }
 
+      this.state('ask');
       // The method is parsed and depending on what method is asked for it returns
       // the response based on the passed through packet.
-      this.action('ask');
       this.methods[packet.q.meta.method](packet).then(result => {
         if (typeof result === 'object') {
           packet_answer.text = result.text || false;
@@ -605,7 +595,7 @@ class Deva {
           packet_answer.text = result;
         }
         packet_answer.meta.hash = this.hash(packet_answer);
-        this.action('ask_answer');
+        this.action('ask');
         packet.a = packet_answer;
         this.talk(config.events.answer, this.copy(packet)); // global talk event
         this.talk(`${agent.key}:ask:${packet.id}`, packet);
@@ -652,7 +642,6 @@ class Deva {
     }
     _data.hash = this.hash(_data);
 
-    this.state('init');
     return new Promise((resolve, reject) => {
       this.events.setMaxListeners(this.maxListeners);
       this._assignInherit().then(() => {
@@ -664,6 +653,7 @@ class Deva {
       }).then(() => {
         return this.Security();
       }).then(() => {
+        this.zone('init');
         const hasOnInit = this.onInit && typeof this.onInit === 'function';
         return hasOnInit ? this.onInit(_data) : this.start(_data)
       }).catch(err => {
@@ -683,6 +673,7 @@ class Deva {
   usage: this.start('msg')
   ***************/
   start(data) {
+    this.zone('start');
     if (!this._active) return Promise.resolve(this._messages.offline);
     this.state('start');
     data.value = 'start';
@@ -705,6 +696,7 @@ class Deva {
   usage: this.enter('msg')
   ***************/
   enter(data) {
+    this.zone('enter');
     if (!this._active) return Promise.resolve(this._messages.offline);
     this.state('enter');
     data.value = 'enter';
@@ -727,6 +719,7 @@ class Deva {
   usage: this.done('msg')
   ***************/
   done(data) {
+    this.zone('done');
     if (!this._active) return Promise.resolve(this._messages.offline);
     this.state('done');
     data.value = 'done';
@@ -742,20 +735,25 @@ class Deva {
   params:
   - packet: the data to pass to the resolve
   - resolve: the finish resolve to pass back
-  describe:
-    This function is use to relay the Agent ito a finish state when resolving a
-    question or data.
-  usage:
-    this.finish(data, resolve)
+  describe: This function is use to relay the Agent ito a finish state when
+            resolving a question or data.
+  usage: this.finish(data, resolve)
   ***************/
   finish(packet, resolve) {
+    this.zone('finish'); // set the zone to finish
     if (!this._active) return Promise.resolve(this._messages.offline);
-    this.state('finish');
+
+    this.state('finish'); // set the finish state
     packet.hash = this.hash(packet);// hash the entire packet before finishing.
-    const hasOnFinish = this.onFinish && typeof this.onFinish === 'function' ? true : false;
+    // check for agent on finish function in agent
+    const hasOnFinish = this.onFinish && typeof this.onFinish === 'function';
+
+    this.action('finish'); // set the finish action
+    // if: agent has on finish then return on finish
 
+    this.context('finish'); // set the context to finish
     if (hasOnFinish) return this.onFinish(packet, resolve);
-    this.action('finish');
+    // return the provided resolve function or a promise resolve.
     return resolve ? resolve(packet) : Promise.resolve(packet);
   }
 
@@ -773,24 +771,21 @@ class Deva {
     this.stop()
   ***************/
   stop() {
+    this.zone('stop'); // set the zone to stop
     if (!this._active) return Promise.resolve(this._messages.offline);
-
-    this.action('stop');
-    const agent = this.agent();
-    const client = this.client();
-
-    const data = {
-      id: this.uid(true),
-      key: 'stop',
-      value: this._messages.stop,
-      agent,
-      client,
-      created: Date.now(),
+    this.state('stop'); // set the state to stop
+    const data = { // build the stop data
+      id: this.uid(), // set the id
+      agent: this.agent(), // set the agent
+      client: this.client(), // set the client
+      key: 'stop', // set the key
+      value: this._messages.stop, // set the value
+      created: Date.now(), // set the created date
     }
-    data.hash = this.hash(data);
-
-    this.state('stop');
+    this.action('stop'); // set the stop action
+    // has stop function then set hasOnStop variable
     const hasOnStop = this.onStop && typeof this.onStop === 'function';
+    // if: has on stop then run on stop function or return exit function.
     return hasOnStop ? this.onStop(data) : this.exit(data)
   }
 
@@ -811,9 +806,8 @@ class Deva {
   ***************/
   exit() {
     this.zone('exit');
-    this._active = false;
 
-    this.action('exit');
+    this.state('exit');
     const agent = this.agent();
     const client = this.client();
 
@@ -834,7 +828,7 @@ class Deva {
     this._support = false;
     this._services = false;
 
-    this.state('exit');
+    this.action('exit');
     const hasOnExit = this.onExit && typeof this.onExit === 'function';
     return hasOnExit ? this.onExit(data) : Promise.resolve(data)
   }
@@ -845,27 +839,28 @@ class Deva {
   /**************
   func: state
   params:
-    - st: The state flag to set for the Deva that matches to this._states
-  describe
+    - value: The state value to set for the Deva that matches to this._states
+    - extra: any extra text to add ot the state change.
   ***************/
-  state(state) {
+  state(value=false, extra=false) {
     try {
-      if (!this._states[state]) return;
-      this._state = state;
-      const text = this._states[state];
-      const data = {
-        id: this.uid(true),
-        key: 'state',
-        value: state,
-        agent: this.agent(),
-        client: this.client(),
-        text,
-        created: Date.now(),
+      if (!value || !this._states[value]) return; // return if no matching value
+      this._state = value; // set the local state variable.
+      const lookup = this._states[value]; // set the local states lookup
+      const text = extra ? `${lookup} ${extra}` : lookup; // set text from lookup with extra
+      const data = { // build the data object
+        id: this.uid(), // set the data id
+        agent: this.agent(), // set the agent
+        client: this.client(), // set the client
+        key: 'state', // set the key to state
+        value, // set the value to the passed in value
+        text, // set the text value of the data
+        created: Date.now(), // set the data created date.
       };
-      data.hash = this.hash(data);
-      this.talk(config.events.state, data);
-    } catch (e) {
-      return this.error(e);
+      data.hash = this.hash(data); // hash the data
+      this.talk(config.events.state, data); // broadcasat the state event
+    } catch (e) { // catch any errors
+      return this.error(e); // return if an error happens
     }
   }
 
@@ -890,16 +885,20 @@ class Deva {
     - st: The zone flag to set for the Deva that matches to this._zones
   describe
   ***************/
-  zone(value) {
-    if (!this._zones[value] || value === this._zone) return;
+  zone(value=false, extra=false) {
+    if (!value || !this._zones[value] || value === this._zone) return;
     try {
       this._zone = value;
-      const text = this._zones[value];
-      const data = {
-        id: this.uid(true),
+
+      const lookup = this._zones[value]; // set the lookup value
+      const text = extra ? `${lookup} ${extra}` : lookup; // set the text value
+
+      const data = { // build the zone data
+        id: this.uid(), // set the packetid
+        agent: this.agent(),
+        client: this.client(),
         key: 'zone',
         value,
-        agent: this.agent(),
         text,
         created: Date.now(),
       };
@@ -910,35 +909,46 @@ class Deva {
     }
   }
 
+  /**************
+  func: zones
+  params: none
+  describe: returns a listing of zones currently in the system.
+  ***************/
   zones() {
-    this.action('zones');
+    this.action('zones'); // set the action to zones
     return {
-      id: this.uid(true),
-      key: 'zones',
-      value: this._zones,
-      created: Date.now(),
+      id: this.uid(true), // set the uuid of the data
+      agent: this.agent(), // set the agent value
+      cleint: this.cleint(), // set the client value
+      key: 'zones', // set the key return value
+      value: this._zones, // set the list of zones
+      created: Date.now(), // set the created date of the object.
     }
   }
+
   /**************
   func: action
   params:
-    - st: The state flag to set for the Deva that matches to this._states
+    - value: The state flag to set for the Deva that matches to this._states
+    - extra: Any extra text to send with the action value.
   describe
   ***************/
-  action(action) {
+  action(value=false, extra=false) {
     try {
-      this._action = action; // set the local action variable
+      if (!value) return; // check feature value
+      this._action = value; // set the local action variable
       // check local vars for custom actions
-      const var_action = this.vars.actions ? this.vars.actions[action] : false;
-      // check action messages
-      const msg_action = this._actions[action] || var_action;
-      const text = msg_action || action; // set the text of the action
+      const var_action = this.vars.actions ? this.vars.actions[value] : false;
+      // check the message action
+      const msg_action = var_action || this._actions[value];
+      const msg = msg_action || action; // set the correct message
+      const text = extra ? `${msg} ${extra}` : msg; // set the text of the action
       const data = { // build the data object for the action.
         id: this.uid(true), // generate a guid for the action transmitssion.
-        key: 'action', // the key for event to transmit action type
-        value: action, // the value key which is the action passed
         agent: this.agent(), // the agent data to send with the action
         client: this.client(), // the client data to send with the action
+        key: 'action', // the key for event to transmit action type
+        value, // the value key which is the action passed
         text, // text of the action to send
         created: Date.now(), // action time stamp
       };
@@ -949,71 +959,90 @@ class Deva {
     }
   }
 
+  /**************
+  func: actions
+  params: none
+  describe: Returns a list of available actions in the system.
+  ***************/
   actions() {
     this.action('actions');
     return {
-      id: this.uid(true),
-      key: 'actions',
-      value: this._actions,
-      created: Date.now(),
+      id: this.uid(true), // set the id with a uuid
+      agent: this.agent(), // set the agent value
+      client: this.client(), // set the client value
+      key: 'actions', // set the data key
+      value: this._actions, // set the value to the actions list
+      created: Date.now(), // set the data created date
     }
   }
 
   /**************
   func: feature
   params:
-    - st: The state flag to set for the Deva that matches to this._states
+    - value: The feature flag to set for the Deva that matches to this._features
+    - extra: Any extra text to send with the feature value.
   describe
   ***************/
-  feature(feature) {
+  feature(value=false, extra=false) {
     try {
-      if (!this._features[feature]) return;
-      this._feature = feature;
-      const text = this._features[feature] ;
-      const talk = {
-        id: this.uid(true),
-        key: 'feature',
-        value: feature,
-        agent: this._agent,
-        text,
-        created: Date.now(),
+      if (!value || !this._features[value]) return; // check feature value
+      this._feature = value; // set local feature variable
+
+      const lookup = this._features[value]; // set the lookup value
+      const text = extra ? `${lookup} ${extra}` : lookup; // set the text value
+
+      const data = { // build data object
+        id: this.uid(true), // set the id
+        agent: this.agent(), // set the agent transporting the packet.
+        key: 'feature', // set the key for transport
+        value, // set the value of the key
+        text, // set the text value
+        created: Date.now(), // set the creation date
       };
-      talk.hash = this.hash(talk);
-      this.talk(config.events.feature, talk);
-    } catch (e) {
-      return this.error(e);
+      data.hash = this.hash(data); // generate the hash value of the data packet
+      this.talk(config.events.feature, data); // talk the feature event with data
+    } catch (e) { // catch any errors
+      return this.error(e); // retun this.error when an error is caught.
     }
   }
 
+  /**************
+  func: features
+  params: none
+  describe: return a list of features that are available to the system.
+  ***************/
   features() {
-    this.action('features');
-    return {
-      id: this.uid(true),
-      key: 'features',
-      value: this._features,
-      created: Date.now(),
+    this.action('features'); // set the action to features
+    return { // return the data object
+      id: this.uid(true), // set the object id
+      agent: this.agent(), // set the agent value.
+      client: this.client(), // set the client value.
+      key: 'features', // set the key
+      value: this._features, // set the value to the features list
+      created: Date.now(), // set the created date.
     }
   }
 
   /**************
   func: context
   params:
-    - st: The context flag to set for the Deva that matches to this._contexts
+    - value: The context flag to set for the Deva that matches to this._contexts
+    - extra: Any extra text that is sent with the context value.
   describe
   ***************/
   context(value=false, extra=false) {
     try {
-      if (!value) return this._context;
+      if (!value) return;
       this._context = value;
       const lookup = this.vars.context[value] || value;
       const text = extra ? `${lookup} ${extra}` : lookup;
 
       const data = {
         id: this.uid(true),
-        key: 'context',
-        value,
         agent: this.agent(),
         client: this.client(),
+        key: 'context',
+        value,
         text,
         created: Date.now(),
       };
@@ -1028,6 +1057,8 @@ class Deva {
     this.action('contexts');
     return {
       id: this.uid(true),
+      agent: this.agent(),
+      client: this.client(),
       key: 'contexts',
       value: this.vars.context || false,
       created: Date.now(),
@@ -1037,29 +1068,25 @@ class Deva {
   /**************
   func: client
   params: none
-  describe:
-    this function allows state management for when client prfioe is
-    being accessed.
+  describe: returns the current client values in the system.
   usage: this.client();
   ***************/
   client() {
-    if (!this._active) return this._messages.offline;    // check the active status
-    const client_copy = this.copy(this._client);
-    return client_copy;                                 // return the client feature
+    if (!this._active) return this._messages.offline; // check the active status
+    const client_copy = this.copy(this._client); // create a copy of the client data
+    return client_copy; // return the copy of the client data.
   }
 
   /**************
   func: agent
   params: none
-  describe:
-    this function allows statement management for when client prfioe is
-    being accessed.
+  describe: returns the current agent values in the system.
   usage: this.agent()
   ***************/
   agent() {
-    if (!this._active) return this._messages.offline;
-    const agent_copy = this.copy(this._agent);
-    return agent_copy;
+    if (!this._active) return this._messages.offline; // check the active status
+    const agent_copy = this.copy(this._agent); // create a copy of the agent data.
+    return agent_copy; // return the copy of the agent data.
   }
 
   // FEATURE FUNCTIONS
@@ -1088,11 +1115,13 @@ class Deva {
   support() {
     this.feature('support'); // set the support state
     if (!this._active) return this._messages.offline; // check the active status
-    this.state('data');
+    this.state('data'); // set the state to data
     try {
-      this.action('support');
+      this.action('support'); // set the action to support.
       return this.copy(this._support); // return the support feature
-    } catch (e) {return this.error(e);}
+    } catch (e) {
+      return this.error(e); // return this.error when error catch
+    }
   }
 
   /**************
@@ -1108,7 +1137,9 @@ class Deva {
     try {
       this.action('services'); // set the services state
       return this.copy(this._services); // return the services feature
-    } catch (e) {return this.error(e);}
+    } catch (e) {
+      return this.error(e); // return this.error when error catch
+    }
   }
 
   /**************

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@indra.ai/deva",
-  "version": "1.2.18",
+  "version": "1.2.20",
   "description": "The Deva Core",
   "main": "index.js",
   "scripts": {