Question: Should ChatInitSettings options have a exported interface

[bingenito]

Question Area

[x] Context Data

Question

The documentation for fdc3.chatinitsettings has 5 documented optional boolean properties but the exported interface for ChatInitSettings defines options as any. Should we add the documented properties to an exported type and change options to be that type vs any?

[kriswest]

@bingenito good spot - I believe this portion of the schema is incorrectly defined:

FDC3/src/context/schemas/chatInitSettings.schema.json

Lines 19 to 25 in dc42f96

	"options": {
	"groupRecipients": "boolean",
	"public": "boolean",
	"allowHistoryBrowsing": "boolean",
	"allowMessageCopy": "boolean",
	"allowAddUser": "boolean"
	}

The schema should be closer to this:

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://fdc3.finos.org/schemas/next/chatInitSettings.schema.json",
    "type": "object",
    "title": "ChatInitSettings",
    "properties": {
        "type": {
            "const": "fdc3.chat.initSettings"
        },
        "chatName": {
            "type": "string"
        },
        "members": {
            "$ref": "contactList.schema.json#"
        },
        "initMessage": {
            "type": "string"
        },
        "options": {
            "type": "object",
            "properties": {
                "groupRecipients": {"type": "boolean"},
                "public": {"type": "boolean"},
                "allowHistoryBrowsing":  {"type": "boolean"},
                "allowMessageCopy":  {"type": "boolean"},
                "allowAddUser":  {"type": "boolean"}
            }
        }
    },
    "required": [
        "type"
    ]
}

Which does generate the properties.

However, I also note that we have field with the name public. This is a reserved word in Javascript/typescript and can't be used as a property name (see https://www.w3schools.com/js/js_reserved.asp and microsoft/TypeScript#2536). Hence we should really rename that field also.

@mistryvinay could the Symphony team look at fixing these two issues?

[symphony-jean-michael]

Hi @kriswest
Thank you for your investigation.
I'v created a new PR: #875
Could you please review it ?
Thanks