-
Notifications
You must be signed in to change notification settings - Fork 137
/
Copy pathContextTypes.ts
3038 lines (2863 loc) · 107 KB
/
ContextTypes.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// To parse this data:
//
// import { Convert, Action, Chart, ChatInitSettings, ChatMessage, ChatRoom, ChatSearchCriteria, Contact, ContactList, Context, Country, Currency, Email, FileAttachment, Instrument, InstrumentList, Interaction, Message, Nothing, Order, OrderList, Organization, Portfolio, Position, Product, TimeRange, Trade, TradeList, TransactionResult, Valuation } from "./file";
//
// const action = Convert.toAction(json);
// const chart = Convert.toChart(json);
// const chatInitSettings = Convert.toChatInitSettings(json);
// const chatMessage = Convert.toChatMessage(json);
// const chatRoom = Convert.toChatRoom(json);
// const chatSearchCriteria = Convert.toChatSearchCriteria(json);
// const contact = Convert.toContact(json);
// const contactList = Convert.toContactList(json);
// const context = Convert.toContext(json);
// const country = Convert.toCountry(json);
// const currency = Convert.toCurrency(json);
// const email = Convert.toEmail(json);
// const fileAttachment = Convert.toFileAttachment(json);
// const instrument = Convert.toInstrument(json);
// const instrumentList = Convert.toInstrumentList(json);
// const interaction = Convert.toInteraction(json);
// const message = Convert.toMessage(json);
// const nothing = Convert.toNothing(json);
// const order = Convert.toOrder(json);
// const orderList = Convert.toOrderList(json);
// const organization = Convert.toOrganization(json);
// const portfolio = Convert.toPortfolio(json);
// const position = Convert.toPosition(json);
// const product = Convert.toProduct(json);
// const timeRange = Convert.toTimeRange(json);
// const trade = Convert.toTrade(json);
// const tradeList = Convert.toTradeList(json);
// const transactionResult = Convert.toTransactionResult(json);
// const valuation = Convert.toValuation(json);
//
// These functions will throw an error if the JSON doesn't
// match the expected interface, even if the JSON is valid.
/**
* A representation of an FDC3 Action (specified via a Context or Context & Intent) that can
* be inserted inside another object, for example a chat message.
*
* The action may be completed by calling:
* - `fdc3.raiseIntent()` with the specified Intent and Context
* - `fdc3.raiseIntentForContext()` if only a context is specified, (which the Desktop Agent
* will resolve by presenting the user with a list of available Intents for the Context).
* - `channel.broadcast()` with the specified Context, if the `broadcast` action has been
* defined.
*
* Accepts an optional `app` parameter in order to specify a specific app.
*/
export interface Action {
/**
* The **action** field indicates the type of action:
* - **raiseIntent** : If no action or `raiseIntent` is specified, then `fdc3.raiseIntent`
* or `fdc3.raiseIntentForContext` will be called with the specified context (and intent if
* given).
* - **broadcast** : If `broadcast` and a `channelId` are specified then
* `fdc3.getOrCreateChannel(channelId)` is called to retrieve the channel and broadcast the
* context to it with `channel.broadcast(context)`. If no `channelId` has been specified,
* the context should be broadcast to the current channel (`fdc3.broadcast()`)
*/
action?: ActionType;
/**
* An optional target application identifier that should perform the action. The `app`
* property is ignored unless the action is raiseIntent.
*/
app?: AppIdentifier;
/**
* Optional channel on which to broadcast the context. The `channelId` property is ignored
* unless the `action` is broadcast.
*/
channelId?: string;
/**
* A context object with which the action will be performed
*/
context: ContextElement;
/**
* Optional Intent to raise to perform the actions. Should reference an intent type name,
* such as those defined in the FDC3 Standard. If intent is not set then
* `fdc3.raiseIntentForContext` should be used to perform the action as this will usually
* allow the user to choose the intent to raise.
*/
intent?: string;
/**
* A human readable display name for the action
*/
title: string;
type: "fdc3.action";
id?: { [key: string]: any };
name?: string;
[property: string]: any;
}
/**
* The **action** field indicates the type of action:
* - **raiseIntent** : If no action or `raiseIntent` is specified, then `fdc3.raiseIntent`
* or `fdc3.raiseIntentForContext` will be called with the specified context (and intent if
* given).
* - **broadcast** : If `broadcast` and a `channelId` are specified then
* `fdc3.getOrCreateChannel(channelId)` is called to retrieve the channel and broadcast the
* context to it with `channel.broadcast(context)`. If no `channelId` has been specified,
* the context should be broadcast to the current channel (`fdc3.broadcast()`)
*/
export type ActionType = "broadcast" | "raiseIntent";
/**
* An optional target application identifier that should perform the action. The `app`
* property is ignored unless the action is raiseIntent.
*
* Identifies an application, or instance of an application, and is used to target FDC3 API
* calls, such as `fdc3.open` or `fdc3.raiseIntent` at specific applications or application
* instances.
*
* Will always include at least an `appId` field, which uniquely identifies a specific app.
*
* If the `instanceId` field is set then the `AppMetadata` object represents a specific
* instance of the application that may be addressed using that Id.
*/
export interface AppIdentifier {
/**
* The unique application identifier located within a specific application directory
* instance. An example of an appId might be 'app@sub.root'.
*/
appId: string;
/**
* The Desktop Agent that the app is available on. Used in Desktop Agent Bridging to
* identify the Desktop Agent to target.
*/
desktopAgent?: string;
/**
* An optional instance identifier, indicating that this object represents a specific
* instance of the application described.
*/
instanceId?: string;
[property: string]: any;
}
/**
* A context object with which the action will be performed
*
* A context object returned by the transaction, possibly with updated data.
*
* The `fdc3.context` type defines the basic contract or "shape" for all data exchanged by
* FDC3 operations. As such, it is not really meant to be used on its own, but is imported
* by more specific type definitions (standardized or custom) to provide the structure and
* properties shared by all FDC3 context data types.
*
* The key element of FDC3 context types is their mandatory `type` property, which is used
* to identify what type of data the object represents, and what shape it has.
*
* The FDC3 context type, and all derived types, define the minimum set of fields a context
* data object of a particular type can be expected to have, but this can always be extended
* with custom fields as appropriate.
*/
export interface ContextElement {
/**
* Context data objects may include a set of equivalent key-value pairs that can be used to
* help applications identify and look up the context type they receive in their own domain.
* The idea behind this design is that applications can provide as many equivalent
* identifiers to a target application as possible, e.g. an instrument may be represented by
* an ISIN, CUSIP or Bloomberg identifier.
*
* Identifiers do not make sense for all types of data, so the `id` property is therefore
* optional, but some derived types may choose to require at least one identifier.
* Identifier values SHOULD always be of type string.
*/
id?: { [key: string]: any };
/**
* Context data objects may include a name property that can be used for more information,
* or display purposes. Some derived types may require the name object as mandatory,
* depending on use case.
*/
name?: string;
/**
* The type property is the only _required_ part of the FDC3 context data schema. The FDC3
* [API](https://fdc3.finos.org/docs/api/spec) relies on the `type` property being present
* to route shared context data appropriately.
*
* FDC3 [Intents](https://fdc3.finos.org/docs/intents/spec) also register the context data
* types they support in an FDC3 [App
* Directory](https://fdc3.finos.org/docs/app-directory/overview), used for intent discovery
* and routing.
*
* Standardized FDC3 context types have well-known `type` properties prefixed with the
* `fdc3` namespace, e.g. `fdc3.instrument`. For non-standard types, e.g. those defined and
* used by a particular organization, the convention is to prefix them with an
* organization-specific namespace, e.g. `blackrock.fund`.
*
* See the [Context Data Specification](https://fdc3.finos.org/docs/context/spec) for more
* information about context data types.
*/
type: string;
[property: string]: any;
}
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
/**
* A context type representing details of a Chart, which may be used to request plotting of
* a particular chart or to otherwise share details of its composition, such as:
*
* - A list of instruments for comparison
* - The time period to plot the chart over
* - The style of chart (line, bar, mountain, candle etc.)
* - Other settings such as indicators to calculate, or data representing drawings and
* annotations.
*
* In addition to handling requests to plot charts, a charting application may use this type
* to output a representation of what it is currently displaying so that it can be recorded
* by another application.
*/
export interface Chart {
/**
* An array of instrument contexts whose data should be plotted.
*/
instruments: InstrumentElement[];
/**
* It is common for charts to support other configuration, such as indicators, annotations
* etc., which do not have standardized formats, but may be included in the `otherConfig`
* array as context objects.
*/
otherConfig?: ContextElement[];
/**
* The time range that should be plotted
*/
range?: TimeRangeObject;
/**
* The type of chart that should be plotted
*/
style?: ChartStyle;
type: "fdc3.chart";
id?: { [key: string]: any };
name?: string;
[property: string]: any;
}
/**
* A financial instrument that relates to the definition of this product
*
*
*
* A financial instrument from any asset class.
*/
export interface InstrumentElement {
/**
* Any combination of instrument identifiers can be used together to resolve ambiguity, or
* for a better match. Not all applications will use the same instrument identifiers, which
* is why FDC3 allows for multiple to be specified. In general, the more identifiers an
* application can provide, the easier it will be to achieve interoperability.
*
* It is valid to include extra properties and metadata as part of the instrument payload,
* but the minimum requirement is for at least one instrument identifier to be provided.
*
* Try to only use instrument identifiers as intended. E.g. the `ticker` property is meant
* for tickers as used by an exchange.
* If the identifier you want to share is not a ticker or one of the other standardized
* fields, define a property that makes it clear what the value represents. Doing so will
* make interpretation easier for the developers of target applications.
*/
id: PurpleInstrumentIdentifiers;
/**
* The `market` map can be used to further specify the instrument and help achieve
* interoperability between disparate data sources. This is especially useful when using an
* `id` field that is not globally unique.
*/
market?: OrganizationMarket;
/**
* An optional human-readable name for the instrument
*/
name?: string;
type: "fdc3.instrument";
[property: string]: any;
}
/**
* Any combination of instrument identifiers can be used together to resolve ambiguity, or
* for a better match. Not all applications will use the same instrument identifiers, which
* is why FDC3 allows for multiple to be specified. In general, the more identifiers an
* application can provide, the easier it will be to achieve interoperability.
*
* It is valid to include extra properties and metadata as part of the instrument payload,
* but the minimum requirement is for at least one instrument identifier to be provided.
*
* Try to only use instrument identifiers as intended. E.g. the `ticker` property is meant
* for tickers as used by an exchange.
* If the identifier you want to share is not a ticker or one of the other standardized
* fields, define a property that makes it clear what the value represents. Doing so will
* make interpretation easier for the developers of target applications.
*/
export interface PurpleInstrumentIdentifiers {
/**
* https://www.bloomberg.com/
*/
BBG?: string;
/**
* https://www.cusip.com/
*/
CUSIP?: string;
/**
* https://www.factset.com/
*/
FDS_ID?: string;
/**
* https://www.openfigi.com/
*/
FIGI?: string;
/**
* https://www.isin.org/
*/
ISIN?: string;
/**
* https://permid.org/
*/
PERMID?: string;
/**
* https://www.refinitiv.com/
*/
RIC?: string;
/**
* https://www.lseg.com/sedol
*/
SEDOL?: string;
/**
* Unstandardized stock tickers
*/
ticker?: string;
[property: string]: any;
}
/**
* The `market` map can be used to further specify the instrument and help achieve
* interoperability between disparate data sources. This is especially useful when using an
* `id` field that is not globally unique.
*/
export interface OrganizationMarket {
/**
* https://www.bloomberg.com/
*/
BBG?: string;
/**
* https://www.iso.org/iso-3166-country-codes.html
*/
COUNTRY_ISOALPHA2?: string;
/**
* https://en.wikipedia.org/wiki/Market_Identifier_Code
*/
MIC?: string;
/**
* Human readable market name
*/
name?: string;
[property: string]: any;
}
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
/**
* The time range that should be plotted
*
* The time range over which the interaction occurred
*
* A context representing a period of time. Any user interfaces that represent or visualize
* events or activity over time can be filtered or focused on a particular time period,
* e.g.:
*
* - A pricing chart
* - A trade blotter
* - A record of client contact/activity in a CRM
*
* Example use cases:
*
* - User may want to view pricing/trades/customer activity for a security over a particular
* time period, the time range might be specified as the context for the `ViewChart` intent
* OR it might be embedded in another context (e.g. a context representing a chart to plot).
* - User filters a visualization (e.g. a pricing chart) to show a particular period, the
* `TimeRange` is broadcast and other visualizations (e.g. a heatmap of activity by
* instrument, or industry sector etc.) receive it and filter themselves to show data over
* the same range.
*
* Notes:
*
* - A `TimeRange` may be closed (i.e. `startTime` and `endTime` are both known) or open
* (i.e. only one of `startTime` or `endTime` is known).
* - Ranges corresponding to dates (e.g. `2022-05-12` to `2022-05-19`) should be specified
* using times as this prevents issues with timezone conversions and inclusive/exclusive
* date ranges.
* - String fields representing times are encoded according to [ISO
* 8601-1:2019](https://www.iso.org/standard/70907.html).
* - A timezone indicator should be specified, e.g. `"2022-05-12T15:18:03Z"` or
* `"2022-05-12T16:18:03+01:00"`
* - Times MAY be specified with millisecond precision, e.g. `"2022-05-12T15:18:03.349Z"`
*/
export interface TimeRangeObject {
/**
* The end time of the range, encoded according to [ISO
* 8601-1:2019](https://www.iso.org/standard/70907.html) with a timezone indicator.
*/
endTime?: Date;
/**
* The start time of the range, encoded according to [ISO
* 8601-1:2019](https://www.iso.org/standard/70907.html) with a timezone indicator.
*/
startTime?: Date;
type: "fdc3.timeRange";
id?: { [key: string]: any };
name?: string;
[property: string]: any;
}
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
/**
* The type of chart that should be plotted
*/
export type ChartStyle = "line" | "bar" | "stacked-bar" | "mountain" | "candle" | "pie" | "scatter" | "histogram" | "heatmap" | "custom";
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
/**
* A collection of settings to start a new chat conversation
*/
export interface ChatInitSettings {
/**
* Name to apply to the chat created
*/
chatName?: string;
/**
* Contacts to add to the chat
*/
members?: ContactListObject;
/**
* An initial message to post in the chat when created.
*/
message?: MessageObject | string;
/**
* Option settings that affect the creation of the chat
*/
options?: ChatOptions;
type: "fdc3.chat.initSettings";
id?: { [key: string]: any };
name?: string;
[property: string]: any;
}
/**
* Contacts to add to the chat
*
* A list of contacts involved in the interaction
*
* A collection of contacts, e.g. for chatting to or calling multiple contacts.
*
* The contact list schema does not explicitly include identifiers in the `id` section, as
* there is not a common standard for such identifiers. Applications can, however, populate
* this part of the contract with custom identifiers if so desired.
*/
export interface ContactListObject {
/**
* An array of contact contexts that forms the list.
*/
contacts: ContactElement[];
/**
* One or more identifiers that refer to the contact list in an OMS, EMS or related system.
* Specific key names for systems are expected to be standardized in future.
*/
id?: { [key: string]: string };
/**
* An optional human-readable summary of the contact list
*/
name?: string;
type: "fdc3.contactList";
[property: string]: any;
}
/**
* The contact that initiated the interaction
*
* A person contact that can be engaged with through email, calling, messaging, CMS, etc.
*/
export interface ContactElement {
/**
* Identifiers that relate to the Contact represented by this context
*/
id: PurpleContactIdentifiers;
/**
* An optional human-readable name for the contact
*/
name?: string;
type: "fdc3.contact";
[property: string]: any;
}
/**
* Identifiers that relate to the Contact represented by this context
*/
export interface PurpleContactIdentifiers {
/**
* The email address for the contact
*/
email?: string;
/**
* FactSet Permanent Identifier representing the contact
*/
FDS_ID?: string;
[property: string]: any;
}
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
/**
* A chat message to be sent through an instant messaging application. Can contain one or
* several text bodies (organized by mime-type, plaintext or markdown), as well as attached
* entities (either arbitrary file attachments or FDC3 actions to be embedded in the
* message). To be put inside a ChatInitSettings object.
*/
export interface MessageObject {
/**
* A map of string IDs to entities that should be attached to the message, such as an action
* to perform, a file attachment, or other FDC3 context object.
*/
entities?: { [key: string]: EntityValue };
/**
* A map of string mime-type to string content
*/
text?: PurpleMessageText;
type: "fdc3.message";
id?: { [key: string]: any };
name?: string;
[property: string]: any;
}
/**
* A representation of an FDC3 Action (specified via a Context or Context & Intent) that can
* be inserted inside another object, for example a chat message.
*
* The action may be completed by calling:
* - `fdc3.raiseIntent()` with the specified Intent and Context
* - `fdc3.raiseIntentForContext()` if only a context is specified, (which the Desktop Agent
* will resolve by presenting the user with a list of available Intents for the Context).
* - `channel.broadcast()` with the specified Context, if the `broadcast` action has been
* defined.
*
* Accepts an optional `app` parameter in order to specify a specific app.
*
* A File attachment encoded in the form of a data URI. Can be added to a Message.
*/
export interface EntityValue {
/**
* The **action** field indicates the type of action:
* - **raiseIntent** : If no action or `raiseIntent` is specified, then `fdc3.raiseIntent`
* or `fdc3.raiseIntentForContext` will be called with the specified context (and intent if
* given).
* - **broadcast** : If `broadcast` and a `channelId` are specified then
* `fdc3.getOrCreateChannel(channelId)` is called to retrieve the channel and broadcast the
* context to it with `channel.broadcast(context)`. If no `channelId` has been specified,
* the context should be broadcast to the current channel (`fdc3.broadcast()`)
*/
action?: ActionType;
/**
* An optional target application identifier that should perform the action. The `app`
* property is ignored unless the action is raiseIntent.
*/
app?: AppIdentifier;
/**
* Optional channel on which to broadcast the context. The `channelId` property is ignored
* unless the `action` is broadcast.
*/
channelId?: string;
/**
* A context object with which the action will be performed
*/
context?: ContextElement;
/**
* Optional Intent to raise to perform the actions. Should reference an intent type name,
* such as those defined in the FDC3 Standard. If intent is not set then
* `fdc3.raiseIntentForContext` should be used to perform the action as this will usually
* allow the user to choose the intent to raise.
*/
intent?: string;
/**
* A human readable display name for the action
*/
title?: string;
type: EntityType;
id?: { [key: string]: any };
name?: string;
data?: EntityData;
[property: string]: any;
}
export interface EntityData {
/**
* A data URI encoding the content of the file to be attached
*/
dataUri: string;
/**
* The name of the attached file
*/
name: string;
[property: string]: any;
}
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
export type EntityType = "fdc3.action" | "fdc3.fileAttachment";
/**
* A map of string mime-type to string content
*/
export interface PurpleMessageText {
/**
* Markdown encoded content
*/
"text/markdown"?: string;
/**
* Plain text encoded content.
*/
"text/plain"?: string;
[property: string]: any;
}
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
/**
* Option settings that affect the creation of the chat
*/
export interface ChatOptions {
/**
* if true members will be allowed to add other members to the chat
*/
allowAddUser?: boolean;
/**
* if true members will be allowed to browse past messages
*/
allowHistoryBrowsing?: boolean;
/**
* if true members will be allowed to copy/paste messages
*/
allowMessageCopy?: boolean;
/**
* if false a separate chat will be created for each member
*/
groupRecipients?: boolean;
/**
* if true the room will be visible to everyone in the chat application
*/
isPublic?: boolean;
[property: string]: any;
}
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
/**
* A context representing a chat message. Typically used to send the message or to
* pre-populate a message for sending.
*/
export interface ChatMessage {
chatRoom: ChatRoomObject;
message: MessageObject;
type: "fdc3.chat.message";
id?: { [key: string]: any };
name?: string;
[property: string]: any;
}
/**
* Reference to the chat room which could be used to send a message to the room
*/
export interface ChatRoomObject {
/**
* Identifier(s) for the chat - currently unstandardized
*/
id: { [key: string]: string };
/**
* Display name for the chat room
*/
name?: string;
/**
* The name of the service that hosts the chat
*/
providerName: string;
type: "fdc3.chat.room";
/**
* Universal url to access to the room. It could be opened from a browser, a mobile app,
* etc...
*/
url?: string;
[property: string]: any;
}
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
/**
* Reference to the chat room which could be used to send a message to the room
*/
export interface ChatRoom {
/**
* Identifier(s) for the chat - currently unstandardized
*/
id: { [key: string]: string };
/**
* Display name for the chat room
*/
name?: string;
/**
* The name of the service that hosts the chat
*/
providerName: string;
type: "fdc3.chat.room";
/**
* Universal url to access to the room. It could be opened from a browser, a mobile app,
* etc...
*/
url?: string;
[property: string]: any;
}
/**
* A context type that represents a simple search criterion, based on a list of other
* context objects, that can be used to search or filter messages in a chat application.
*/
export interface ChatSearchCriteria {
/**
* An array of criteria that should match chats returned from by a search.
*
* ⚠️ Operators (and/or/not) are not defined in `fdc3.chat.searchCriteria`. It is up to the
* application that processes the FDC3 Intent to choose and apply the operators between the
* criteria.
*
* Empty search criteria can be supported to allow resetting of filters.
*/
criteria: Array<OrganizationObject | string>;
type: "fdc3.chat.searchCriteria";
id?: { [key: string]: any };
name?: string;
[property: string]: any;
}
/**
* A financial instrument that relates to the definition of this product
*
*
*
* A financial instrument from any asset class.
*
* An entity that can be used when referencing private companies and other organizations
* where a specific instrument is not available or desired e.g. CRM and News workflows.
*
* It is valid to include extra properties and metadata as part of the organization payload,
* but the minimum requirement is for at least one specified identifier to be provided.
*
* The contact that initiated the interaction
*
* A person contact that can be engaged with through email, calling, messaging, CMS, etc.
*/
export interface OrganizationObject {
/**
* Any combination of instrument identifiers can be used together to resolve ambiguity, or
* for a better match. Not all applications will use the same instrument identifiers, which
* is why FDC3 allows for multiple to be specified. In general, the more identifiers an
* application can provide, the easier it will be to achieve interoperability.
*
* It is valid to include extra properties and metadata as part of the instrument payload,
* but the minimum requirement is for at least one instrument identifier to be provided.
*
* Try to only use instrument identifiers as intended. E.g. the `ticker` property is meant
* for tickers as used by an exchange.
* If the identifier you want to share is not a ticker or one of the other standardized
* fields, define a property that makes it clear what the value represents. Doing so will
* make interpretation easier for the developers of target applications.
*
* Identifiers for the organization, at least one must be provided.
*
* Identifiers that relate to the Contact represented by this context
*/
id: Identifiers;
/**
* The `market` map can be used to further specify the instrument and help achieve
* interoperability between disparate data sources. This is especially useful when using an
* `id` field that is not globally unique.
*/
market?: OrganizationMarket;
/**
* An optional human-readable name for the instrument
*
* An optional human-readable name of the organization
*
* An optional human-readable name for the contact
*/
name?: string;
type: TentacledInteractionType;
[property: string]: any;
}
/**
* Any combination of instrument identifiers can be used together to resolve ambiguity, or
* for a better match. Not all applications will use the same instrument identifiers, which
* is why FDC3 allows for multiple to be specified. In general, the more identifiers an
* application can provide, the easier it will be to achieve interoperability.
*
* It is valid to include extra properties and metadata as part of the instrument payload,
* but the minimum requirement is for at least one instrument identifier to be provided.
*
* Try to only use instrument identifiers as intended. E.g. the `ticker` property is meant
* for tickers as used by an exchange.
* If the identifier you want to share is not a ticker or one of the other standardized
* fields, define a property that makes it clear what the value represents. Doing so will
* make interpretation easier for the developers of target applications.
*
* Identifiers for the organization, at least one must be provided.
*
* Identifiers that relate to the Contact represented by this context
*/
export interface Identifiers {
/**
* https://www.bloomberg.com/
*/
BBG?: string;
/**
* https://www.cusip.com/
*/
CUSIP?: string;
/**
* https://www.factset.com/
*
* FactSet Permanent Identifier representing the organization
*
* FactSet Permanent Identifier representing the contact
*/
FDS_ID?: string;
/**
* https://www.openfigi.com/
*/
FIGI?: string;
/**
* https://www.isin.org/
*/
ISIN?: string;
/**
* https://permid.org/
*
* Refinitiv Permanent Identifiers, or PermID for the organization
*/
PERMID?: string;
/**
* https://www.refinitiv.com/
*/
RIC?: string;
/**
* https://www.lseg.com/sedol
*/
SEDOL?: string;
/**
* Unstandardized stock tickers
*/
ticker?: string;
/**
* The Legal Entity Identifier (LEI) is a 20-character, alpha-numeric code based on the ISO
* 17442 standard developed by the International Organization for Standardization (ISO). It
* connects to key reference information that enables clear and unique identification of
* legal entities participating in financial transactions.
*/
LEI?: string;
/**
* The email address for the contact
*/
email?: string;
[property: string]: any;
}
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
export type TentacledInteractionType = "fdc3.instrument" | "fdc3.organization" | "fdc3.contact";
/**
* Free text to be used for a keyword search
*
* `interactionType` SHOULD be one of `'Instant Message'`, `'Email'`, `'Call'`, or
* `'Meeting'` although other string values are permitted.
*/
/**
* A person contact that can be engaged with through email, calling, messaging, CMS, etc.
*/
export interface Contact {
/**
* Identifiers that relate to the Contact represented by this context
*/
id: FluffyContactIdentifiers;
/**
* An optional human-readable name for the contact
*/
name?: string;
type: "fdc3.contact";
[property: string]: any;
}
/**
* Identifiers that relate to the Contact represented by this context
*/
export interface FluffyContactIdentifiers {
/**
* The email address for the contact
*/
email?: string;
/**
* FactSet Permanent Identifier representing the contact
*/
FDS_ID?: string;
[property: string]: any;
}
/**
* A collection of contacts, e.g. for chatting to or calling multiple contacts.
*
* The contact list schema does not explicitly include identifiers in the `id` section, as
* there is not a common standard for such identifiers. Applications can, however, populate
* this part of the contract with custom identifiers if so desired.
*/
export interface ContactList {
/**
* An array of contact contexts that forms the list.
*/
contacts: ContactElement[];
/**
* One or more identifiers that refer to the contact list in an OMS, EMS or related system.
* Specific key names for systems are expected to be standardized in future.
*/
id?: { [key: string]: string };
/**
* An optional human-readable summary of the contact list
*/
name?: string;
type: "fdc3.contactList";
[property: string]: any;
}
/**
* The `fdc3.context` type defines the basic contract or "shape" for all data exchanged by