@indra.ai/deva 1.0.31 → 1.0.33

package/README.md

@@ -1,15 +1,26 @@
 # deva
 
-Deva is a class object that provides events and object management with inherited properties.
-
-[Back to indra.ai](https://indra.ai)
-
-## Install
+Deva is a class object that provides structure, events, and object management with inherited properties.
+
+## contents
+- [install](#install) - How to install the deva core.
+- [structure](#structure) - Basic structure of `deva`.
+- [agent](#agent) - The `agent` object stores the Agent Profile.
+- [vars](#vars) - Variables are stored in the `this.vars` object.
+- [listeners](#listeners) - Listeners are setup to allow a deva trigger events.
+- [devas](#listeners) - This is where sub-devas are loaded into the current deva.
+- [modules](#modules) - A `deva` can add modules to add to their functionality.
+- [func](#func) - A `deva` the internal functionality is written here.
+- [methods](#methods) - Methods expose the `deva` abilities to external commands/calls.
+- [states](#states) - There are various states that triger when a `deva` is doing things.
+- [utility](#utility) - Interal to a `deva` there are utility functions available to make actions easier like getting a unique id or status.
+
+## install
 ```bash
 $ npm i @indra.ai/deva --save-dev
 ```
 
-## Basic Structure
+## structure
 ```javascript
 // include the main Deva class
 const Deva = require('feecting/deva');
@@ -63,13 +74,14 @@ deva.init();
 
 ```
 
-## Breakdown
-### Agent
+## agent
+
 ```javascript
 this.agent
 ```
 The "me" object contains the profile information for the DEVA.
-##### Data Attributes
+
+### Data Attributes
 - **uid:** The unique id for the Deva.
 - **key:** The unique key for the Deva.
 - **name:** The name of the Deva.
@@ -88,17 +100,18 @@ The "me" object contains the profile information for the DEVA.
   - **gender:** The gender of the Deva
   - **describe:** A short description of the deva 100 characters or less.
 
-### Vars
+## vars
+
 ```javascript
 this.vars
 ```
+
 The vars can be use to set local variables for the deva that need to be used in your program.
 
 There are no default variables, so the scope is for you and your imagination to figure out.
 
-##### Example
+### example
 ```javascript
-...
   vars: {
     foo: 'bar',
     steps: 10,
@@ -112,64 +125,57 @@ There are no default variables, so the scope is for you and your imagination to
       'value 2',
     ]
   }
-...
-
 ```
-### Listeners
+
+## listeners
 Listeners are what you setup that allow your Deva to communicate with other Deva or parts of your application/system.
 
 ```javascript
 this.listeners
 ```
 
-#### Default Listeners
+### default
 
 Each Deva comes with a set of default listeners to provide basic functionality.
 
-##### Question
-The question event is the functionality that exposes the methods to the outside world. When a deva asks a question the string is parsed into a question format so that commands to access various methods can be exposed.
-
-```javascript
-const question = await this.question(`#*agent_key* *method*:*params* *question string*`);
-```
-
-##### Start
+### start
 This will trigger an event to start the Deva.
 
 ```javascript
 this.talk(`*agent_key*:start`);
 ```
 
-##### Stop
+### stop
 This will trigger an event to stop the Deva.
 
 ```javascript
 this.talk(`*agent_key*:stop`);
 ```
 
-##### Status
+### status
 This will trigger an event to broadcast the Deva status.
 
 ```javascript
 this.talk(`*agent_key*:status`);
 ```
 
-### Deva
+## devas
+
 ```javascript
-this.deva
+this.devas
 ```
 
 The main object for Deva that are bwlow this Deva.
 
-### Modules
+## modules
+
 The external modules that your Deva might require to function.
 
 ```javascript
 this.modules
 ```
 
-
-### Func
+## func
 The functions that your deva uses to operate. Functions are not exposed through
 the api to public access.
 
@@ -177,17 +183,18 @@ the api to public access.
 this.func
 ```
 
-### Methods
+### methods
 ```javascript
 this.methods
 ```
+
 The methods are exposed publicly through the question event that parses a string
 and sends a request to the question method that then interacts with functions, modules, and variables.
 
-### State Functions
+## states
 Provided are a set of state functions that trigger when a Deva is at various states of starting/stopping.
 
-#### onStart()
+### onStart()
 
 The `onStart()` function runs after the `start` function has completed.
 
@@ -197,7 +204,7 @@ this.onStart() {
 }
 ```
 
-#### onStop()
+### onStop()
 
 The `onStop()` function runs after the `stop` function has completed.
 
@@ -207,8 +214,7 @@ this.onStop() {
 }
 ```
 
-
-#### onEnter()
+### onEnter()
 
 The `onEnter()` function runs after the `enter` event has fired.
 
@@ -218,8 +224,7 @@ this.onEnter() {
 }
 ```
 
-
-#### onExit()
+### onExit()
 
 The `onExit()`function runs after the `exit` event has fired.
 
@@ -229,7 +234,7 @@ this.onExit() {
 }
 ```
 
-#### onDone()
+### onDone()
 
 The `onDone()`function runs after the `done` event has fired.
 
@@ -239,8 +244,7 @@ this.onDone() {
 }
 ```
 
-
-#### onInit()
+### onInit()
 
 The `onInit()` function runs after the `init()` function has completed.
 
@@ -250,14 +254,36 @@ this.onInit() {
 }
 ```
 
-## Utility Functions
+## utility
+
+### question
+
+The question event is the functionality that exposes the methods to the outside world. When a deva asks a question the string is parsed into a question format so that commands to access various methods can be exposed.
+
+The `question(packet)` function is a default function that allows the system to ask questions of itself or other Deva.
+
+The function checks the beginning of a string for a `#` to determine wether to issue a command to run a specific method.
+
+See [Question Listener](#question) for usage.
+
+
+```javascript
+// async await
+const question = await this.question('#*agent_key* *method*:*params* *question string*');
+
+// promises
+this.question('#*agent_key* *method*:*params* *question string*').then(response => {
+  ...
+}).catch(err => {
+  ...
+})
+```
 
 ### uid()
 Generates a unique ID that is used in packet transfer and other various ways.
 
 ```javascript
 this.uid() // inside the object
-deva.uid() // outside the object
 
 // example
 this.vars.id = this.uid()
@@ -334,13 +360,13 @@ this.func.listener = packet => {
 ```
 
 
-### Load(agent, opts)
+### load(agent, opts)
 
 To add a Deva dynamically use the `load()` function. This can be utilized to add Deva to an existing Deva after the object has already been created.
 
 ```javascript
 const opts = {
-  me: {...},
+  agent: {...},
   vars: {...},
   listeners: {...},
   deva: {...},
@@ -362,18 +388,6 @@ this.unload('deva-key');
 
 ```
 
-### question(packet)
-The `question(packet)` function is a default function that allows the system to ask questions of itself or other Deva.
-
-The function checks the beginning of a string for a `#` to determine wether to issue a command to run a specific method.
-
-See [Question Listener](#question) for usage.
-
-```bash
-#deva method:params message
-```
-
-
 ### status()
 The `status()` function will return the running status of the current Deva.
 
@@ -389,6 +403,8 @@ The `init()` function will initialize the Deva and run the `onInit()` state func
 ### initDeva()
 The `initDeva()` function will initialize the Deva located under the current Deva set. To be used in instances of a main Deva parent situation.
 
--
+---
+
+[Github Repo](https://github.com/indraai/deva)  
 [Back to indra.ai](https://indra.ai)  
 ©2021 Quinn Michaels; All Rights Reserved.

package/_config.yml

@@ -0,0 +1,7 @@
+# Copyright 2022 Quinn Michaels.
+
+author:
+  name: Quinn Michaels
+  email: "qce@indra.ai"
+
+google_analytics: UA-126646842-1

package/index.js

@@ -472,12 +472,12 @@ class Deva {
     return Promise.resolve({text});
   }
 
-  // universal prompt emitter
+  // prompt emitter
   prompt(text) {
-    this.talk('prompt', {text, prompt:this.agent.prompt});
+    this.talk('prompt', {text, agent:this.agent});
   }
 
-  // universal hash builder
+  // hash builder
   hash(packet) {
     if (!this.vars.hash) this.vars.hash = '0x';
     // setup basic hashing
@@ -500,9 +500,9 @@ class Deva {
       });
     });
   }
-  // initDeva interface is to initialize devas that this deva is a parent of.
+  // startDevas interface is to initialize devas that this deva is a parent of.
   // This feature allows a Deva to be a parent of a parent of a parent etc....
-  initDevas() {
+  startDevas() {
     return new Promise((resolve, reject) => {
       const devas = [];
       for (let x in this.devas) {

package/package.json

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