Merge pull request #1796 from finos/correct-missing-contexts

Add missing contexts to ContextTypes enum and TS type

Author: kriswest

CHANGELOG.md

@@ -47,6 +47,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Fix to ensure that Adding A Channel Change Event Listener Doesn't Send addEventListenerRequest - Conformance 2.2 ([#1606](https://github.com/finos/FDC3/pull/1606))
 * Updated Conformance tests to allow agents that fully qualify app Ids (as recommended in the Standard) to pass the conformance tests ([#1767](https://github.com/finos/FDC3/pull/1767))
 * Fixed import file extensions and module type to be esm module compliant ([#1677](https://github.com/finos/FDC3/pull/1677))
+* Added mising context types to types and enums in. ContextTypes.ts and implemented tests to ensure they stay in sync with the fdc3-context package ([#1796](https://github.com/finos/FDC3/pull/1796))
 
 ## [FDC3 Standard 2.2](https://github.com/finos/FDC3/compare/v2.1..v2.2) - 2025-03-12
 

packages/fdc3-standard/src/context/ContextType.ts

@@ -18,14 +18,15 @@ export type StandardContextType =
   | 'fdc3.country'
   | 'fdc3.currency'
   | 'fdc3.email'
+  | 'fdc3.fileAttachment'
   | 'fdc3.instrument'
   | 'fdc3.instrumentList'
   | 'fdc3.interaction'
   | 'fdc3.message'
+  | 'fdc3.nothing'
   | 'fdc3.organization'
   | 'fdc3.portfolio'
   | 'fdc3.position'
-  | 'fdc3.nothing'
   | 'fdc3.timeRange'
   | 'fdc3.transactionResult'
   | 'fdc3.valuation';
@@ -49,23 +50,32 @@ export type ContextType = StandardContextType | ExperimentalContextType | (strin
  * @deprecated Use {@link StandardContextType} instead
  */
 export enum ContextTypes {
+  Action = 'fdc3.action',
   Chart = 'fdc3.chart',
   ChatInitSettings = 'fdc3.chat.initSettings',
+  ChatMessage = 'fdc3.chat.message',
   ChatRoom = 'fdc3.chat.room',
+  ChatSearchCriteria = 'fdc3.chat.searchCriteria',
   Contact = 'fdc3.contact',
   ContactList = 'fdc3.contactList',
   Country = 'fdc3.country',
   Currency = 'fdc3.currency',
   Email = 'fdc3.email',
+  FileAttachment = 'fdc3.fileAttachment',
   Instrument = 'fdc3.instrument',
   InstrumentList = 'fdc3.instrumentList',
   Interaction = 'fdc3.interaction',
+  Message = 'fdc3.message',
   Nothing = 'fdc3.nothing',
+  Order = 'fdc3.order',
+  OrderList = 'fdc3.orderList',
   Organization = 'fdc3.organization',
   Portfolio = 'fdc3.portfolio',
   Position = 'fdc3.position',
-  ChatSearchCriteria = 'fdc3.chat.searchCriteria',
+  Product = 'fdc3.product',
   TimeRange = 'fdc3.timeRange',
+  Trade = 'fdc3.trade',
+  TradeList = 'fdc3.tradeList',
   TransactionResult = 'fdc3.transactionResult',
   Valuation = 'fdc3.valuation',
 }

packages/fdc3-standard/src/intents/standard intents.json

@@ -7,8 +7,8 @@
     "StartChat",
     "StartEmail",
     "ViewAnalysis",
-    "ViewChart",
     "ViewChat",
+    "ViewChart",
     "ViewContact",
     "ViewHoldings",
     "ViewInstrument",

packages/fdc3-standard/src/internal/contextConfiguration.ts

@@ -13,14 +13,15 @@ const STANDARD_CONTEXT_TYPES = exhaustiveStringTuple<StandardContextType>()(
   'fdc3.country',
   'fdc3.currency',
   'fdc3.email',
+  'fdc3.fileAttachment',
   'fdc3.instrument',
   'fdc3.instrumentList',
   'fdc3.interaction',
   'fdc3.message',
+  'fdc3.nothing',
   'fdc3.organization',
   'fdc3.portfolio',
   'fdc3.position',
-  'fdc3.nothing',
   'fdc3.timeRange',
   'fdc3.transactionResult',
   'fdc3.valuation'

packages/fdc3-standard/test/ContextTypeSync.test.ts

@@ -0,0 +1,62 @@
+import { describe, it, expect } from 'vitest';
+import { readdirSync, readFileSync } from 'fs';
+import { resolve, dirname } from 'path';
+import { createRequire } from 'module';
+import { ContextTypes } from '../src/context/ContextType.js';
+
+const require = createRequire(import.meta.url);
+
+/**
+ * Extracts the fdc3 context type string from a schema file by finding
+ * the "const" value of the "type" property.
+ */
+function extractContextType(schemaPath: string): string | null {
+  const schema = JSON.parse(readFileSync(schemaPath, 'utf-8'));
+  for (const entry of schema.allOf ?? []) {
+    const typeConst = entry?.properties?.type?.const;
+    if (typeof typeConst === 'string' && typeConst.startsWith('fdc3.')) {
+      return typeConst;
+    }
+  }
+  return null;
+}
+
+/**
+ * Reads all context schemas from the fdc3-context package and returns
+ * the set of fdc3.* type strings they define.
+ */
+function getSchemaContextTypes(): Set<string> {
+  const fdc3ContextEntry = require.resolve('@finos/fdc3-context');
+  const schemasDir = resolve(dirname(fdc3ContextEntry), '../schemas/context');
+  const types = new Set<string>();
+
+  for (const file of readdirSync(schemasDir)) {
+    if (!file.endsWith('.schema.json')) continue;
+    const contextType = extractContextType(resolve(schemasDir, file));
+    if (contextType) types.add(contextType);
+  }
+
+  return types;
+}
+
+describe('Context type definitions stay in sync with fdc3-context schemas', () => {
+  const schemaTypes = getSchemaContextTypes();
+  const enumValues = new Set(Object.values(ContextTypes));
+
+  it('should find context types in the schemas', () => {
+    expect(schemaTypes.size).toBeGreaterThan(0);
+  });
+
+  it('ContextTypes enum should include every schema-defined context type', () => {
+    const missingFromEnum = [...schemaTypes].filter(t => !enumValues.has(t)).sort();
+
+    if (missingFromEnum.length > 0) {
+      console.error(
+        '\n❌ Context types defined in fdc3-context schemas but missing from ContextTypes enum:\n' +
+          missingFromEnum.map(t => `  • ${t}`).join('\n')
+      );
+    }
+
+    expect(missingFromEnum).toEqual([]);
+  });
+});