Add various utility functions

Signed-off-by: Andrei Floricel <andrei.floricel@gmail.com>

Author: andreifloricel

.prettierignore

@@ -9,3 +9,6 @@
 website
 dist
 src/app-directory/*/target
+
+# temporary, until Prettier is upgraded to at least v2.8, which supports the TS 'satisfies' syntax
+src/**/IntentsConfiguration.ts

package-lock.json

@@ -15,7 +15,11 @@ import {
   AppMetadata,
   PrivateChannel,
   Intent,
+  StandardContextType,
+  StandardIntent,
+  ContextTypeFor,
 } from '..';
+import { IntentsConfiguration, StandardContextsSet, StandardIntentsSet } from '../intents/IntentsConfiguration';
 
 const DEFAULT_TIMEOUT = 5000;
 
@@ -179,6 +183,30 @@ export function findInstances(app: AppIdentifier): Promise<AppIdentifier[]> {
   return rejectIfNoGlobal(() => window.fdc3.findInstances(app));
 }
 
+/**
+ * Check if the given context is a standard context type.
+ * @param contextType
+ */
+export function isStandardContextType(contextType: string): contextType is StandardContextType {
+  return StandardContextsSet.has(contextType as StandardContextType);
+}
+
+/**
+ * Check if the given intent is a standard intent.
+ * @param intent
+ */
+export function isStandardIntent(intent: string): intent is StandardIntent {
+  return StandardIntentsSet.has(intent as StandardIntent);
+}
+
+/**
+ * Get the possible context types for a given intent.
+ * @param intent
+ */
+export function getPossibleContextsForIntent<I extends StandardIntent>(intent: I): ContextTypeFor<I>[] {
+  return IntentsConfiguration[intent] ?? [];
+}
+
 /**
  * Compare numeric semver version number strings (in the form `1.2.3`).
  *

src/api/Methods.ts

@@ -3,6 +3,8 @@
  * Copyright FINOS FDC3 contributors - see NOTICE file
  */
 
+import { IntentsConfiguration } from './IntentsConfiguration';
+
 /**
  * @see https://fdc3.finos.org/docs/intents/spec#standard-intents
  */
@@ -30,3 +32,10 @@ export type StandardIntent =
  * @see https://fdc3.finos.org/docs/intents/spec
  */
 export type Intent = StandardIntent | (string & {});
+
+/**
+ * Typed possible context for a given intent
+ *
+ * @example `ContextTypeFor<'StartCall'>` is equivalent to `'fdc3.contact' | 'fdc3.contactList' | 'fdc3.nothing'`
+ */
+export type ContextTypeFor<I extends StandardIntent> = typeof IntentsConfiguration[I][number];

src/intents/Intents.ts

@@ -0,0 +1,66 @@
+import { StandardIntent } from './Intents';
+import { StandardContextType } from '../context/ContextType';
+
+export const IntentsConfiguration = {
+  CreateInteraction: ['fdc3.contactList', 'fdc3.interaction', 'fdc3.nothing'],
+  StartCall: ['fdc3.contact', 'fdc3.contactList', 'fdc3.nothing'],
+  StartChat: ['fdc3.contact', 'fdc3.contactList', 'fdc3.chat.initSettings', 'fdc3.nothing'],
+  StartEmail: ['fdc3.email', 'fdc3.nothing'],
+  SendChatMessage: ['fdc3.chat.message', 'fdc3.nothing'],
+  ViewAnalysis: ['fdc3.instrument', 'fdc3.organization', 'fdc3.portfolio', 'fdc3.nothing'],
+  ViewChat: ['fdc3.chat.room', 'fdc3.contact', 'fdc3.contactList', 'fdc3.nothing'],
+  ViewChart: [
+    'fdc3.chart',
+    'fdc3.instrument',
+    'fdc3.instrumentList',
+    'fdc3.portfolio',
+    'fdc3.position',
+    'fdc3.nothing',
+  ],
+  ViewContact: ['fdc3.contact', 'fdc3.nothing'],
+  ViewHoldings: ['fdc3.instrument', 'fdc3.instrumentList', 'fdc3.organization', 'fdc3.nothing'],
+  ViewInstrument: ['fdc3.instrument', 'fdc3.nothing'],
+  ViewInteractions: ['fdc3.contact', 'fdc3.instrument', 'fdc3.organization', 'fdc3.nothing'],
+  ViewMessages: ['fdc3.chat.searchCriteria', 'fdc3.nothing'],
+  ViewNews: [
+    'fdc3.country',
+    'fdc3.instrument',
+    'fdc3.instrumentList',
+    'fdc3.organization',
+    'fdc3.portfolio',
+    'fdc3.nothing',
+  ],
+  ViewOrders: ['fdc3.contact', 'fdc3.instrument', 'fdc3.organization', 'fdc3.nothing'],
+  ViewProfile: ['fdc3.contact', 'fdc3.organization', 'fdc3.nothing'],
+  ViewQuote: ['fdc3.instrument', 'fdc3.nothing'],
+  ViewResearch: ['fdc3.contact', 'fdc3.instrument', 'fdc3.organization', 'fdc3.nothing'],
+} satisfies Record<StandardIntent, StandardContextType[]>;
+
+const STANDARD_CONTEXT_TYPES: Readonly<StandardContextType[]> = [
+  'fdc3.action',
+  'fdc3.chart',
+  'fdc3.chat.initSettings',
+  'fdc3.chat.message',
+  'fdc3.chat.room',
+  'fdc3.chat.searchCriteria',
+  'fdc3.contact',
+  'fdc3.contactList',
+  'fdc3.country',
+  'fdc3.currency',
+  'fdc3.email',
+  'fdc3.instrument',
+  'fdc3.instrumentList',
+  'fdc3.interaction',
+  'fdc3.message',
+  'fdc3.organization',
+  'fdc3.portfolio',
+  'fdc3.position',
+  'fdc3.nothing',
+  'fdc3.timerange',
+  'fdc3.transactionResult',
+  'fdc3.valuation',
+] as const;
+
+// used internally to check if a given intent/context is a standard one
+export const StandardIntentsSet = new Set(Object.keys(IntentsConfiguration) as StandardIntent[]);
+export const StandardContextsSet = new Set(STANDARD_CONTEXT_TYPES);

src/intents/IntentsConfiguration.ts

@@ -25,6 +25,8 @@ import {
   versionIsAtLeast,
   createPrivateChannel,
   findInstances,
+  isStandardContextType,
+  isStandardIntent,
 } from '../src';
 
 const UnavailableError = new Error('FDC3 DesktopAgent not available at `window.fdc3`.');
@@ -443,4 +445,58 @@ describe('test version comparison functions', () => {
     expect(versionIsAtLeast(metaOneTwoOne, '1.2.1')).toBe(true);
     expect(versionIsAtLeast(metaOneTwoOne, '2.0')).toBe(false);
   });
+
+  test('isStandardContextType should return TRUE for standard context types', () => {
+    expect(isStandardContextType('fdc3.action')).toBe(true);
+    expect(isStandardContextType('fdc3.chart')).toBe(true);
+    expect(isStandardContextType('fdc3.chat.initSettings')).toBe(true);
+    expect(isStandardContextType('fdc3.chat.message')).toBe(true);
+    expect(isStandardContextType('fdc3.chat.room')).toBe(true);
+    expect(isStandardContextType('fdc3.chat.searchCriteria')).toBe(true);
+    expect(isStandardContextType('fdc3.contact')).toBe(true);
+    expect(isStandardContextType('fdc3.contactList')).toBe(true);
+    expect(isStandardContextType('fdc3.country')).toBe(true);
+    expect(isStandardContextType('fdc3.currency')).toBe(true);
+    expect(isStandardContextType('fdc3.email')).toBe(true);
+    expect(isStandardContextType('fdc3.instrument')).toBe(true);
+    expect(isStandardContextType('fdc3.instrumentList')).toBe(true);
+    expect(isStandardContextType('fdc3.interaction')).toBe(true);
+    expect(isStandardContextType('fdc3.message')).toBe(true);
+    expect(isStandardContextType('fdc3.organization')).toBe(true);
+    expect(isStandardContextType('fdc3.portfolio')).toBe(true);
+    expect(isStandardContextType('fdc3.position')).toBe(true);
+    expect(isStandardContextType('fdc3.nothing')).toBe(true);
+    expect(isStandardContextType('fdc3.timerange')).toBe(true);
+    expect(isStandardContextType('fdc3.transactionResult')).toBe(true);
+    expect(isStandardContextType('fdc3.valuation')).toBe(true);
+  });
+
+  test('isStandardContextType should return FALSE for custom context types', () => {
+    expect(isStandardContextType('myApp.customContext')).toBe(false);
+  });
+
+  test('isStandardIntent should return TRUE for standard intents', () => {
+    expect(isStandardIntent('CreateInteraction')).toBe(true);
+    expect(isStandardIntent('SendChatMessage')).toBe(true);
+    expect(isStandardIntent('StartCall')).toBe(true);
+    expect(isStandardIntent('StartChat')).toBe(true);
+    expect(isStandardIntent('StartEmail')).toBe(true);
+    expect(isStandardIntent('ViewAnalysis')).toBe(true);
+    expect(isStandardIntent('ViewChat')).toBe(true);
+    expect(isStandardIntent('ViewChart')).toBe(true);
+    expect(isStandardIntent('ViewContact')).toBe(true);
+    expect(isStandardIntent('ViewHoldings')).toBe(true);
+    expect(isStandardIntent('ViewInstrument')).toBe(true);
+    expect(isStandardIntent('ViewInteractions')).toBe(true);
+    expect(isStandardIntent('ViewMessages')).toBe(true);
+    expect(isStandardIntent('ViewNews')).toBe(true);
+    expect(isStandardIntent('ViewOrders')).toBe(true);
+    expect(isStandardIntent('ViewProfile')).toBe(true);
+    expect(isStandardIntent('ViewQuote')).toBe(true);
+    expect(isStandardIntent('ViewResearch')).toBe(true);
+  });
+
+  test('isStandardIntent should return FALSE for custom intents', () => {
+    expect(isStandardIntent('myApp.CustomIntent')).toBe(false);
+  });
 });