765 'ChatRoom' & 'ChatMessage' contexts and 'SendChatMessage' Intent

CHANGELOG.md

@@ -8,8 +8,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Added
 
+* Added a `SendChatMessage` intent to be used when a user wants to send a message to an existing chat room. ([#794](https://github.com/finos/FDC3/pull/794))
+* Added a context type representing a chat message (`fdc3.chat.message`). ([#794](https://github.com/finos/FDC3/pull/794))
+* Added a context type representing a chat room (`fdc3.chat.room`). ([#794](https://github.com/finos/FDC3/pull/794))
+
 ### Changed
 
+* Updated the `StartChat` intent to return a reference to the room. ([#794](https://github.com/finos/FDC3/pull/794))
+
 ### Deprecated
 
 ### Fixed

docs/context/ref/ChatInitSettings.md

@@ -66,19 +66,22 @@ const initSettings = {
 }
 
 const res = fdc3.raiseIntent('StartChat', initSettings);
-const roomRefs = await res.getResult();
+
+// Return a reference to the room
+const chatRoom = await res.getResult();
 ```
 
 ## See Also
 
 Other Types
 
+- [ChatRoom](ChatRoom)
 - [ContactList](ContactList)
 
 Intents
-
 - [StartChat](../../intents/ref/StartChat)
 - [StartCall](../../intents/ref/StartCall)
+- [SendChatMessage](../../intents/ref/StartChat)
 - [ViewContact](../../intents/ref/ViewContact)
 
 FINOS Financial Objects

docs/context/ref/ChatMessage.md

@@ -0,0 +1,51 @@
+---
+id: ChatMessage
+sidebar_label: ChatMessage
+title: ChatMessage
+hide_title: true
+---
+# `ChatMessage`
+
+A context representing a chat message. Typically used to send the message or to pre-populate a message for sending.
+
+## Type
+
+`fdc3.chat.message`
+
+## Schema
+
+- https://fdc3.finos.org/schemas/next/chatMessage.schema.json
+
+## Details
+
+| Property | Type | Required | Example Value |
+|-------------|---------|----------|-------------------|
+| `type` | string | Yes | `'fdc3.chat.message'` |
+| `chatRoom` | ChatRoom | Yes | `{ type: 'fdc3.chat.room', providerName: 'Symphony', id:{ roomId: 'j75xqXy25NBOdacUI3FNBH'} }` |
+| `message` | [Message](https://fdc3.finos.org/schemas/next/message.schema.json) | Yes | `'A message to send'` |
+
+## Example
+
+```js
+const chatMessage = {
+ type: "fdc3.chat.message",
+ chatRoom: {
+ type: 'fdc3.chat.room',
+ providerName: "Symphony",
+ id: {
+ roomId: "j75xqXy25NBOdacUI3FNBH"
+ }
+ },
+ message: "A message to send"
+}
+```
+
+## See Also
+
+Intents
+- [StartChat](../../intents/ref/StartChat)
+- [StartCall](../../intents/ref/StartCall)
+- [SendChatMessage](../../intents/ref/SendChatMessage)
+
+FINOS Financial Objects
+- [Contact](https://fo.finos.org/docs/objects/contact)

docs/context/ref/ChatRoom.md

@@ -0,0 +1,64 @@
+---
+id: ChatRoom
+sidebar_label: ChatRoom
+title: Contact
+hide_title: true
+---
+# `ChatRoom`
+
+Reference to the chat room(s) (which could be used later to send a message to the room(s)).
+
+## Type
+
+`fdc3.chat.room`
+
+## Schema
+
+https://fdc3.finos.org/schemas/next/chatRoom.schema.json
+
+## Details
+
+| Property | Type | Required | Example Value |
+|-------------|---------|----------|-------------------|
+| `type` | string | Yes | `'fdc3.chat.room'` |
+| `providerName` | string | Yes | `'Symphony'` |
+| `id` | object | Yes | `{ roomId: 'j75xqXy25NBOdacUI3FNBH', anyOtherKey: 'abcdef'}` |
+| `url` | string | No | `'http://symphony.com/ref/room/j75xqXy25NBOdacUI3FNBH___pqSsuJRdA'` |
+| `name` | string | No | `'My new room'` |
+
+The `url` is an universal url to access to the room. It could be opened from a browser, a mobile app, etc...
+
+## Example
+
+```js
+const chatRoom = {
+ type: "fdc3.chat.room",
+ providerName: "Symphony",
+ id: {
+ roomId: "j75xqXy25NBOdacUI3FNBH"
+ }
+ url: "http://symphony.com/ref/room/j75xqXy25NBOdacUI3FNBH___pqSsuJRdA",
+ name: 'My new room'
+};
+
+//Chat rooms are returned by the StartChat intent as a result
+const intentResolution = await fdc3.raiseIntent("StartChat", context);
+
+try {
+ const chatRooms = await intentResolution.getResult():
+} catch (error) {
+ //chat room were not created...
+}
+```
+
+## See Also
+
+Other Types
+* [ChatInitSettings](ChatInitSettings)
+
+Intents
+- [StartChat](../../intents/ref/StartChat)
+- [SendChatMessage](../../intents/ref/SendChatMessage)
+
+FINOS Financial Objects
+- [Contact](https://fo.finos.org/docs/objects/contact)

docs/context/spec.md

@@ -159,6 +159,8 @@ The following are standard FDC3 context types:
 
 * [`fdc3.chart`](ref/Chart) ([schema](/schemas/next/chart.schema.json))
 * [`fdc3.chat.initSettings`](ref/ChatInitSettings) ([schema](/schemas/next/chatInitSettings.schema.json))
+* [`fdc3.chat.room`](ref/ChatRoom) ([schema](/schemas/next/chatRoom.schema.json))
+* [`fdc3.chat.message`](ref/ChatMessage) ([schema](/schemas/next/chatMessage.schema.json))
 * [`fdc3.contact`](ref/Contact) ([schema](/schemas/next/contact.schema.json))
 * [`fdc3.contactList`](ref/ContactList) ([schema](/schemas/next/contactList.schema.json))
 * [`fdc3.country`](ref/Country) ([schema](/schemas/next/country.schema.json))

docs/intents/ref/SendChatMessage.md

@@ -0,0 +1,50 @@
+---
+id: SendChatMessage
+sidebar_label: SendChatMessage
+title: SendChatMessage
+hide_title: true
+---
+# `SendChatMessage`
+
+Send a message to an existing chat room.
+
+## Intent Name
+
+`SendChatMessage`
+
+## Display Name
+
+`Send Chat Message`
+
+## Possible Contexts
+
+* [ChatMessage](../../context/ref/ChatMessage)
+
+## Example
+
+```js
+// Start a chat and retrieve a reference to the chat room created
+const intentResolution = await fdc3.raiseIntent("StartChat", context);
+const chatRoom = intentResolution.getResult();
+
+//Some time later
+
+let chatMessage: ChatMessage = {
+ type: "fdc3.chat.message",
+ chatRoom,
+ message: "Another message to send in the room"
+}
+
+await fdc3.raiseIntent("SendChatMessage", context, intentResolution.source);
+```
+
+## See Also
+
+Context
+- [ChatMessage](../../context/ref/ChatMessage)
+- [ChatRoom](../../context/ref/ChatRoom)
+
+Intents
+* [StartChat](StartChat)
+* [StartCall](StartCall)
+* [StartEmail](StartEmail)

docs/intents/ref/StartChat.md

@@ -6,7 +6,7 @@ hide_title: true
 ---
 # `StartChat`
 
-Initiate a chat with a contact, a list of contacts or detailed initialization settings.
+Initiate a chat with a contact, a list of contacts or detailed initialization settings. This could be launched from within another application. For example initiating a chat from a research or OMS application.
 
 ## Intent Name
 
@@ -60,16 +60,20 @@ const initSettings = {
 }
 
 const resolution = fdc3.raiseIntent('StartChat', initSettings);
-const chatRoomRefs = await resolution.getResult();
+
+// Return a reference to the room
+const chatRoom = await resolution.getResult();
 ```
 
 ## See Also
 
 Context
+- [ChatRoom](../../context/ref/ChatRoom)
 - [Contact](../../context/ref/Contact)
 - [ContactList](../../context/ref/ContactList)
 - [ChatInitSettings](../../context/ref/ChatInitSettings)
 
 Intents
+* [SendChatMessage](SendChatMessage)
 * [StartCall](StartCall)
 * [StartEmail](StartEmail)

src/context/ContextType.ts

@@ -1,6 +1,7 @@
 export enum ContextTypes {
  Chart = 'fdc3.chart',
  ChatInitSettings = 'fdc3.chat.initSettings',
+ ChatRoom = 'fdc3.chat.room',
  Contact = 'fdc3.contact',
  ContactList = 'fdc3.contactList',
  Country = 'fdc3.country',

src/context/schemas.json

@@ -2,6 +2,8 @@
  "Context": ["https://fdc3.finos.org/schemas/next/context.schema.json"],
  "Chart": ["https://fdc3.finos.org/schemas/next/chart.schema.json"],
  "ChatInitSettings": ["https://fdc3.finos.org/schemas/next/chatInitSettings.schema.json"],
+ "ChatMessage": ["https://fdc3.finos.org/schemas/next/chatMessage.schema.json"],
+ "ChatRoom": ["https://fdc3.finos.org/schemas/next/chatRoom.schema.json"],
  "Contact": ["https://fdc3.finos.org/schemas/next/contact.schema.json"],
  "ContactList": ["https://fdc3.finos.org/schemas/next/contactList.schema.json"],
  "Country": ["https://fdc3.finos.org/schemas/next/country.schema.json"],

src/context/schemas/chatMessage.schema.json

@@ -0,0 +1,13 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "https://fdc3.finos.org/schemas/next/chatMessage.schema.json",
+ "type": "object",
+ "title": "ChatMessage",
+ "allOf": [{ "$ref": "context.schema.json#" }],
+ "properties": {
+ "type": { "const": "fdc3.chat.message" },
+ "chatRoom": { "$ref": "chatRoom.schema.json#" },
+ "message": { "$ref": "message.schema.json#" }
+ },
+ "required": ["type", "chatRoom", "message"]
+}

src/context/schemas/chatRoom.schema.json

@@ -0,0 +1,15 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "https://fdc3.finos.org/schemas/next/chatRoom.schema.json",
+ "type": "object",
+ "title": "ChatRoom",
+ "allOf": [{ "$ref": "context.schema.json#" }],
+ "properties": {
+ "type": { "const": "fdc3.chat.room" },
+ "providerName": { "type": "string" },
+ "id": { "type": "object" },
+ "url": { "type": "string" },
+ "name": { "type": "string" }
+ },
+ "required": ["providerName", "id"]
+}

src/intents/Intents.ts

@@ -1,4 +1,5 @@
 export enum Intents {
+ SendChatMessage = 'SendChatMessage',
  StartCall = 'StartCall',
  StartChat = 'StartChat',
  StartEmail = 'StartEmail',

website/sidebars.json

@@ -41,6 +41,7 @@
  "intents/ref/StartCall",
  "intents/ref/StartChat",
  "intents/ref/StartEmail",
+ "intents/ref/SendChatMessage",
  "intents/ref/ViewAnalysis",
  "intents/ref/ViewChart",
  "intents/ref/ViewHoldings",
@@ -62,6 +63,8 @@
  "context/ref/Context",
  "context/ref/Chart",
  "context/ref/ChatInitSettings",
+ "context/ref/ChatMessage",
+ "context/ref/ChatRoom",
  "context/ref/Contact",
  "context/ref/ContactList",
  "context/ref/Country",

website/static/schemas/next/chatMessage.schema.json

@@ -0,0 +1,13 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "https://fdc3.finos.org/schemas/next/chatMessage.schema.json",
+ "type": "object",
+ "title": "ChatMessage",
+ "allOf": [{ "$ref": "context.schema.json#" }],
+ "properties": {
+ "type": { "const": "fdc3.chat.message" },
+ "chatRoom": { "$ref": "chatRoom.schema.json#" },
+ "message": { "$ref": "message.schema.json#" }
+ },
+ "required": ["type", "chatRoom", "message"]
+}

website/static/schemas/next/chatRoom.schema.json

@@ -0,0 +1,15 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "$id": "https://fdc3.finos.org/schemas/next/chatRoom.schema.json",
+ "type": "object",
+ "title": "ChatRoom",
+ "allOf": [{ "$ref": "context.schema.json#" }],
+ "properties": {
+ "type": { "const": "fdc3.chat.room" },
+ "providerName": { "type": "string" },
+ "id": { "type": "object" },
+ "url": { "type": "string" },
+ "name": { "type": "string" }
+ },
+ "required": ["providerName", "id"]
+}

website/versioned_docs/version-2.0/intents/ref/StartChat.md

@@ -7,7 +7,7 @@ original_id: StartChat
 ---
 # `StartChat`
 
-Initiate a chat with a contact, a list of contacts or detailed initialization settings.
+Initiate a chat with a contact, a list of contacts or detailed initialization settings. This could be launched from within another application. For example initiating a chat from a research or OMS application.
 
 ## Intent Name
 
@@ -61,7 +61,7 @@ const initSettings = {
 }
 
 const resolution = fdc3.raiseIntent('StartChat', initSettings);
-const chatRoomRefs = await resolution.getResult();
+const chatRooms = await resolution.getResult();
 ```
 
 ## See Also