sync with upstream

.eslintignore

@@ -0,0 +1,2 @@
+/node_modules/
+dist/

.eslintrc.json

@@ -0,0 +1,31 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": [
+            "./tsconfig.json"
+        ]
+    },
+    "plugins": [
+        "@typescript-eslint",
+        "jsx-a11y"
+    ],
+    "env": {
+        "browser": true,
+        "jest": true
+    },
+    "extends": [
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended",
+        "prettier"
+    ],
+    "rules": {
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-unused-vars": [
+            "error",
+            {
+                "argsIgnorePattern": "^_"
+            }
+        ]
+    }
+}

.github/workflows/package.yml

@@ -1,19 +1,22 @@
 name: npm-build
 
-# Only trigger on:
-# - main branch
-# - PR or Pull Request event types
-# - Exclide Docusaurus files: this file, docs/** and website/**
+# This workflow publishes releases to NPM, after checking that the version they would create does not already exist.
+# Hence, it will only publish if the version number in package.json is not already listed at: 
+# https://www.npmjs.com/package/@finos/fdc3?activeTab=versions
+# The workflow will:
+# - Only trigger on a push or PR merge to a release/* branch in the repository
+# - Ignore Docusaurus workflow, docs/** and website/** as they don't affect the NPM module build
+# WARNING: the workflow does NOT confirm that the version number in package JSON matches the branch name, which should be manually confirmed
 on:
   push:
     branches:
-      - main
       - release/**
     paths-ignore:
       - '.github/workflows/docusaurus.yml'
       - 'docs/**'
       - 'website/**'
   pull_request:
+    types: [opened, reopened, edited, ready_for_review]
     branches:
       - main
       - release/*
@@ -60,6 +63,7 @@ jobs:
     permissions:
       contents: read
       id-token: write
+      packages: write
     strategy:
       matrix:
        include:

docs/context/ref/Country.md

@@ -31,7 +31,7 @@ is for at least one standardized identifier to be provided
 |--------------------------|---------|----------|----------------------|
 | `type`                   | string  | Yes      | `'fdc3.country'`     |
 | `name`                   | string  | No       | `'Sweden'`           |
-| `id.COUNTRY_ISOALPHA2`   | string  | Yes      | `'SE'`               |
+| `id.COUNTRY_ISOALPHA2`   | string  | No       | `'SE'`               |
 | `id.COUNTRY_ISOALPHA3`   | string  | No       | `'SWE'`              |
 | `id.ISOALPHA2` *         | string  | No       | `'SE'`               |
 | `id.ISOALPHA3` *         | string  | No       | `'SWE'`              |

docs/use-cases/001-equity-sell-side-trader.md

@@ -5,15 +5,15 @@ sidebar_label: 1. Equity sell side trader
 layout: use_case
 ---
 
-## Preconditions
+![A diagrammatic representation of the applications available to the trader](/img/use-cases/1.png)
+
 On their desktop, this user has:
-- Their firm's internal research & analytics platform containing liquidity tools and internal research. The product is running and the liquidity tool is open
-- An installed chat application - product is running
-- A third party market data terminal with 3 open applications. These applications are all 'linked' through a channel. 
-    - A Watchlist
-    - An Order Book
-    - An Overview of pricing and fundamental data
-- A third party Charting Application access via a browser window. This is not open. 
+
+- Their firm's internal research & analytics platform, providing liquidity tools and internal research. The product is running and the **liquidity tool** is open.
+- An installed **chat application** is running.
+A **Watchlist** of stocks the trader is interested in
+A third-party **Charting Application** is available that the user accesses via a browser window. This is not open. 
+An **Overview** which gives pricing and fundamental data for stocks
 
 ## Workflow 1
 The user receives a message in the chat application containing an instrument identifier for Tesla. They want to do some analysis on Tesla and so see what applications are available through right clicking on the identifier for Tesla. A menu will appear within the chat application showing applications that can be launched from the Messenger tool. The menu shows two apps, both for analysis; one in the internal platform, the other in the market data terminal. 

docs/use-cases/002-buy-side-portfolio-manager.md

@@ -36,6 +36,7 @@ During the chat, the analyst shares a chart with some important observations hig
 
 ## Workflow 6
 During the chat, the user realizes that some changes should be done to their holdings in the company so hovers over the company identifier and launches the portfolio management system. While looking over the holdings the user also wants to contact the firm’s trader who is listed within the system. The user hovers over the name and launches the chat tool with a conversation with the trader in focus.
+
 ## Interoperability Points
 - API
 - Intents

docs/use-cases/009-call-transcription-to-crm.md → docs/use-cases/006-call-transcription-to-crm.md

@@ -1,7 +1,7 @@
 ---
-id: uc-9
-title: "Use Case 9: Call Transcription to CRM"
-sidebar_label: 9. Call Transcription to CRM
+id: uc-6
+title: "Use Case 6: Call Transcription to CRM"
+sidebar_label: 6. Call Transcription to CRM
 layout: use_case
 ---
 

docs/use-cases/010-realtime-trade-ticket-population.md → docs/use-cases/007-realtime-trade-ticket-population.md

@@ -1,7 +1,7 @@
 ---
-id: uc-10
-title: "Use Case 10: Real-Time voice trades -> trade ticket population"
-sidebar_label: "10. Real-Time voice trades -> trade ticket population"
+id: uc-7
+title: "Use Case 7: Real-Time voice trades -> trade ticket population"
+sidebar_label: "7. Real-Time voice trades -> trade ticket population"
 layout: use_case
 ---
 

docs/use-cases/013-user-launches-multiple-apps-from-a-single-container.md → docs/use-cases/008-user-launches-multiple-apps-from-a-single-container.md

@@ -1,7 +1,7 @@
 ---
-id: uc-13
-title: "Use Case 13: User launches multiple apps from a single container"
-sidebar_label: 13. User launches multiple apps from a single container
+id: uc-8
+title: "Use Case 8: User launches multiple apps from a single container"
+sidebar_label: 8. User launches multiple apps from a single container
 layout: use_case
 ---
 

docs/use-cases/015-sales-floor-base-workflow.md → docs/use-cases/009-sales-floor-base-workflow.md

@@ -1,7 +1,7 @@
 ---
-id: uc-15
-title: "Use Case 15: Sales Floor Base Workflow"
-sidebar_label: 15. Sales Floor Base Workflow
+id: uc-9
+title: "Use Case 9: Sales Floor Base Workflow"
+sidebar_label: 9. Sales Floor Base Workflow
 layout: use_case
 ---
 

docs/use-cases/016-quantifying-fdc3-interactions.md → docs/use-cases/010-quantifying-fdc3-interactions.md

@@ -1,7 +1,7 @@
 ---
-id: uc-16
-title: "Use Case 16: Quantifying FDC3 Interactions"
-sidebar_label: 16. Quantifying FDC3 Interactions
+id: uc-10
+title: "Use Case 10: Quantifying FDC3 Interactions"
+sidebar_label: 10. Quantifying FDC3 Interactions
 layout: use_case
 ---
 

docs/use-cases/017-fine-tuning-interop-with-channels.md → docs/use-cases/011-fine-tuning-interop-with-channels.md

@@ -1,7 +1,7 @@
 ---
-id: uc-17
-title: "Use Case 17: Fine-tuning InterOp with Channels"
-sidebar_label: 17. Fine-tuning InterOp with Channels
+id: uc-11
+title: "Use Case 11: Fine-tuning InterOp with Channels"
+sidebar_label: 11. Fine-tuning InterOp with Channels
 layout: use_case
 ---
 

jest.config.js

@@ -0,0 +1,14 @@
+/** @type {import('jest').Config} */
+module.exports = {
+    moduleFileExtensions: ["js", "ts"],
+    globals: {
+        "ts-jest": {
+            isolatedModules: true
+        }
+    },
+    transform: {
+        "^.+\\.ts?$": "ts-jest"
+    },
+    testRegex: ".+\\.test\\.ts?$",
+    testEnvironment: "jsdom",
+};