wickrio-bot-api - npm Package Compare versions

Comparing version 5.62.2 to 5.62.3

package.json

 {
 	"name": "wickrio-bot-api",
-	"version": "5.62.2",
+	"version": "5.62.3",
 	"description": "The official Wickr IO Bot API Framework",
@@ -9,3 +9,3 @@ "main": "src/WickrIOBot.js",
 		"simple-encryptor": "^3.0.0",
-		"wickrio_addon": "5.60.3"
+		"wickrio_addon": "5.60.x"
 	},
@@ -12,0 +12,0 @@ "scripts": {

src/README.md

@@ -44,1 +44,276 @@ # WickrIO Bot API
 For a full usage and easy to get started example see: <https://github.com/WickrInc/wickrio-example-app>
+
+## Message Parsing
+
+The WickrIO Node.js Bot API Framework provides an API to parse incoming messages. This API will return an object which can be used to process an incoming messages:
+
+```js
+import * as WickrIOBotAPI from 'wickrio-bot-api'
+const bot = new WickrIOBotAPI.WickrIOBot()
+
+async function listen(message) {
+  try {
+    // Parses an incoming message
+    // returns an object with fields specific to message type
+    const parsedMessage = bot.parseMessage(message)
+```
+
+The return value depends on the type of message being parsed. Each of the messages types supported will be shown below.
+
+Please note that the 'receiver' field returned will only be set for 1to1 conversations. The 'convotype' will identify 1to1 conversations with the value 'personal'. Also, the 'bor' value is not always set, if it has an undefined value then it did not have a value.
+
+### Text Messages
+
+The following is a normal text message received on a 1to1 conversation:
+
+```js
+{ message: 'hello',
+  command: '',
+  msgTS: '1597671805.827344',
+  time: '8/17/20 11:44 AM',
+  receiver: 'dkrsvr-bot',
+  argument: '',
+  vgroupid:
+   '2c747a5467b863812a10d15ccfa16bb6eb769a9692bca3f5e086c0537ee04dc4',
+  userEmail: '[e-mail]',
+  convotype: 'personal',
+  isAdmin: true,
+  msgtype: 'message',
+  ttl: '8/21/20 6:43 AM',
+  bor: undefined }
+```
+
+The following is a normal text message received on a room conversation:
+
+```js
+{ message: 'hello again',
+  command: '',
+  msgTS: '1597672022.80669',
+  time: '8/17/20 11:44 AM',
+  receiver: undefined,
+  argument: '',
+  vgroupid:
+   'Sb7064e806fe575b010ec417c12952d3364e620547f883651fff14a77aaf3c2b',
+  userEmail: '[e-mail]',
+  convotype: 'room',
+  isAdmin: true,
+  msgtype: 'message',
+  ttl: '8/21/20 6:47 AM',
+  bor: undefined }
+```
+
+The following is a file message:
+
+```js
+{ file:
+   '/opt/WickrIODebug/clients/dkrsvr-bot/attachments/attachment_20200817102019966_claymation.gif',
+  filename: 'claymation.gif',
+  vgroupid:
+   '2c747a5467b863812a10d15ccfa16bb6eb769a9692bca3f5e086c0537ee04dc4',
+  control: undefined,
+  msgTS: '1597674019.966755',
+  time: '8/17/20 11:44 AM',
+  receiver: 'dkrsvr-bot',
+  userEmail: '[e-mail]',
+  isVoiceMemo: false,
+  convotype: 'personal',
+  isAdmin: true,
+  msgtype: 'file',
+  ttl: '8/21/20 10:20 AM',
+  bor: undefined }
+```
+
+### Edit Messages
+
+The following is an edit message received when a user is sharing their location:
+
+```js
+{ vgroupid:
+   'Sb7064e806fe575b010ec417c12952d3364e620547f883651fff14a77aaf3c2b',
+  edit:
+   { latitude: 40.8320684,
+     longitude: -74.2000844,
+     shareexpiration: 1597678331,
+     type: 'location' },
+  msgTS: '1597674737.555474',
+  time: '8/17/20 11:44 AM',
+  receiver: undefined,
+  userEmail: '[e-mail]',
+  convotype: 'room',
+  isAdmin: false,
+  msgtype: 'edit',
+  ttl: '8/21/20 10:32 AM',
+  bor: '8/17/20 11:02 AM' }
+```
+
+The following is a sample of a react edit message:
+
+```js
+{ vgroupid:
+   'Sb7064e806fe575b010ec417c12952d3364e620547f883651fff14a77aaf3c2b',
+  edit: {
+    originalmessageid: '2101e300e08711ea93034fa243ae69f1',
+    reactAdded: false,
+    reaction: '❤',
+    type: 'reaction' },
+  msgTS: '1597669378.865087',
+  time: '8/17/20 11:44 AM',
+  receiver: undefined,
+  userEmail: '[e-mail]',
+  convotype: 'room',
+  isAdmin: true,
+  msgtype: 'edit',
+  ttl: '8/21/20 6:02 AM',
+  bor: undefined }
+
+```
+
+### Control Messages
+
+The following is a control message that is create a room conversation with the bot in it.
+
+```js
+{ vgroupid:
+   'S26b4210ff941053604ddc7772a33bf3b309490739d18564952d414f6836dca5',
+  control:
+   { bor: 0,
+     changemask: 47,
+     description: '',
+     masters: [ '[e-mail]' ],
+     members:
+      [ 'dkrsvr-bot',
+        '[e-mail]',
+        '[e-mail]' ],
+     msgtype: 4001,
+     title: 'Test Room',
+     ttl: 345600 },
+  msgTS: '1597672937.805061',
+  time: '8/17/20 11:44 AM',
+  receiver: undefined,
+  userEmail: '[e-mail]',
+  convotype: 'room',
+  isAdmin: true,
+  msgtype: 'edit',
+  ttl: '8/21/20 7:02 AM',
+  bor: undefined }
+```
+
+The following is a control message that is changing the BOR for the room conversation:
+
+```js
+{ vgroupid:
+   'Sb7064e806fe575b010ec417c12952d3364e620547f883651fff14a77aaf3c2b',
+  control:
+   { bor: 1800,
+     changemask: 32,
+     description: '',
+     masters:
+      [ 'dkrsvr-bot',
+        '[e-mail]' ],
+     members:
+      [ '[e-mail]',
+        'dkrsvr-bot',
+        '[e-mail]',
+        '[e-mail]' ],
+     msgtype: 4004,
+     title: 'Test the recorder bot',
+     ttl: 345600 },
+  msgTS: '1597673264.627652',
+  time: '8/17/20 11:44 AM',
+  receiver: undefined,
+  userEmail: '[e-mail]',
+  convotype: 'room',
+  isAdmin: true,
+  msgtype: 'edit',
+  ttl: '8/21/20 7:07 AM',
+  bor: undefined }
+```
+
+The following is a control message that is adding a user to the room conversaion:
+
+```js
+{ vgroupid:
+   'Sb7064e806fe575b010ec417c12952d3364e620547f883651fff14a77aaf3c2b',
+  control:
+   { addedusers: [ '[e-mail]' ],
+     deletedusers: [],
+     msgtype: 4002 },
+  msgTS: '1597673379.431875',
+  time: '8/17/20 11:44 AM',
+  receiver: undefined,
+  userEmail: '[e-mail]',
+  convotype: 'room',
+  isAdmin: true,
+  msgtype: 'edit',
+  ttl: '8/21/20 7:09 AM',
+  bor: '8/17/20 7:39 AM' }
+
+```
+
+The following is a control message that is adding a file to the list of saved items:
+
+```js
+{ vgroupid:
+   'Sb7064e806fe575b010ec417c12952d3364e620547f883651fff14a77aaf3c2b',
+  control:
+   { bor: 0,
+     changemask: 64,
+     description: '',
+     filevaultinfo:
+      { filehash:
+         '42b2b8073622e2565a0328f7372d00b77f8ff6d559eaaa647e4e78d78335af182e59a73514ebd464b9e12fcaeef3781bc4036b147fdecc6cbe0f2cb1720f73f9',
+        guid: '760E366E-2303-4F31-93BD-4680550B766B',
+        key:
+         '00f8b2f5d88fe9e16a7db033ad0a7ffc4a9394aa9df98260ceda5768ee903979f8' },
+     masters:
+      [ 'dkrsvr-bot',
+        '[e-mail]' ],
+     members:
+      [ '[e-mail]',
+        'dkrsvr-bot',
+        '[e-mail]',
+        '[e-mail]' ],
+     msgtype: 4004,
+     title: 'Test the recorder bot',
+     ttl: 345600 },
+  msgTS: '1597672364.639996',
+  time: '8/17/20 11:44 AM',
+  receiver: undefined,
+  userEmail: '[e-mail]',
+  convotype: 'room',
+  isAdmin: true,
+  msgtype: 'edit',
+  ttl: '8/21/20 6:52 AM',
+  bor: undefined }
+```
+
+### Calling Messages
+
+Bots cannot join calls so the messages received will be limited.
+
+The following is a start of a call.
+
+```js
+{ status: 0,
+  vgroupid:
+   '2c747a5467b863812a10d15ccfa16bb6eb769a9692bca3f5e086c0537ee04dc4',
+  call:
+   { calluri: '54.242.44.87:16422',
+     calluriipv6: '[2600:1f18:2741:9e02:dbce:1ad1:f081:e907]:16422',
+     meetingid: 0,
+     participants:
+      [ '5eabc0ed821a7dd12705006ed2a6f7c61e553a35f46420783a578de03e8a0460',
+        'de08b4191d3f5efdac3a009a3f6ec6a2b0c5f77a0b07cacbe6690bfc3dd17a00' ],
+     status: 0,
+     version: 2,
+     versioncheck: true },
+  msgTS: '1597674354.922994',
+  time: '8/17/20 11:44 AM',
+  receiver: 'dkrsvr-bot',
+  userEmail: '[e-mail]',
+  convotype: 'personal',
+  isAdmin: true,
+  msgtype: 'call',
+  ttl: '8/21/20 10:25 AM',
+  bor: undefined }
+```

src/WickrIOBot.js

@@ -311,3 +311,3 @@ const WickrIOAPI = require("wickrio_addon")
 		message = JSON.parse(message)
-		let { control, msg_ts, receiver, sender, ttl, bor } = message
+		let { edit, control, msg_ts, time, receiver, sender, ttl, bor } = message
 		var msgtype = message.msgtype
@@ -347,2 +347,3 @@ var vGroupID = message.vgroupid
 					msgTS: msg_ts,
+					time,
 					receiver,
@@ -365,2 +366,3 @@ userEmail: sender,
 					msgTS: msg_ts,
+					time,
 					receiver,
@@ -384,2 +386,3 @@ userEmail: sender,
 				msgTS: msg_ts,
+				time,
 				receiver,
@@ -398,4 +401,5 @@ userEmail: sender,
 				vgroupid: vGroupID,
-				control,
+				call : message.call,
 				msgTS: msg_ts,
+				time,
 				receiver,
@@ -415,2 +419,3 @@ userEmail: sender,
 				msgTS: msg_ts,
+				time,
 				receiver,
@@ -426,3 +431,31 @@ userEmail: sender,
 		} else if (message.control) {
-			return
+			var parsedObj = {
+				vgroupid: vGroupID,
+				control,
+				msgTS: msg_ts,
+				time,
+				receiver,
+				userEmail: sender,
+				convotype: convoType,
+				isAdmin: isAdmin,
+				msgtype: "edit",
+				ttl,
+				bor
+			}
+			return parsedObj
+		} else if (message.edit) {
+			var parsedObj = {
+				vgroupid: vGroupID,
+				edit,
+				msgTS: msg_ts,
+				time,
+				receiver,
+				userEmail: sender,
+				convotype: convoType,
+				isAdmin: isAdmin,
+				msgtype: "edit",
+				ttl,
+				bor
+			}
+			return parsedObj
 		} else if (message.message === undefined) {
@@ -453,4 +486,4 @@ return
 			command: command,
-			control,
 			msgTS: msg_ts,
+			time,
 			receiver,
@@ -457,0 +490,0 @@ argument: argument,

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

56979

increased by15.84%

Lines of code

1358

increased by2.49%

Number of lines in readme file

319

increased by625%

Dependency changes

• Updatedwickrio_addon@5.60.x