@openfin/bloomberg - npm Package Compare versions

Comparing version 2.0.0-beta.8 to 2.0.0-beta.9

CHANGELOG.md

@@ -1,9 +0,35 @@
-## v1.2.0
+## v2.0.0
 
 ### Enhancements
 
-- The NPM package now exports both ES and CommonJS modules.
+- This API has been updated to use the latest version of Bloomberg’s Terminal Connect API, as such the [`connect`](https://developer.openfin.co/docs/integrations/bloomberg/2.0.0/functions/connect.html) function now requires an additional "apiKey" parameter value which is your Terminal Connect API key (contact your Bloomberg account manager for more information).
+- Changed the way Terminal actions are mapped to context types to support different Terminal actions based on incoming context data.
+- Added a number of new [FDC3 intents](https://fdc3.finos.org/docs/intents/spec) to the default interop configuration, providing much more “out of the box” interop functionality than previous versions. Newly supported intents include [StartChat](https://fdc3.finos.org/docs/intents/ref/StartChat), [ViewAnalysis](https://fdc3.finos.org/docs/intents/ref/ViewAnalysis), [ViewChat](https://fdc3.finos.org/docs/intents/ref/ViewChat), [ViewNews](https://fdc3.finos.org/docs/intents/ref/ViewNews), [ViewProfile](https://fdc3.finos.org/docs/intents/ref/ViewProfile) and [ViewResearch](https://fdc3.finos.org/docs/intents/ref/ViewResearch).
+- The default interop configuration now supports the [fdc3.chart](https://fdc3.finos.org/docs/context/ref/Chart) context type when provided with the [ViewChart](https://fdc3.finos.org/docs/intents/ref/ViewChart) intent, using the additional data provided to display a more appropriate chart in the Terminal.
+- Added the ability to map multiple actions for the same context type in order to update multiple Terminal windows or Launchpad groups when incoming contexts or intents are detected.
+- Added the ability to execute Terminal functions in named tabs in addition to the standard numbered panels.
+- Added the ability to execute GraphQL query and mutation requests directly against the Terminal Connect API, and added numerous type definitions for use when making common requests.
+- Added support for FIGI values with [fdc3.instrument](https://fdc3.finos.org/docs/context/ref/Instrument) contexts.
+- Added the ability to map actions to any context type, whether FDC3 or custom (previous versions only supported a restricted set of FDC3 context types).
+- Updated configuration to support connection to multiple named Launchpad groups, rather than just one or all.
 
-### Resolved Issues
+### Breaking Changes
 
-- The time it takes for the [`connect`](https://developer.openfin.co/docs/integrations/bloomberg/1.2.0/functions/connect.html) and [`isBloombergTerminalReady`](https://developer.openfin.co/docs/integrations/bloomberg/1.2.0/functions/isBloombergTerminalReady.html) functions to resolve has been significantly reduced.
+- This API now requires that the consuming app’s manifest includes the [System.downloadAsset](https://developer.openfin.co/docs/javascript/stable/classes/OpenFin.System.html#downloadAsset) and [System.launchExternalProcess](https://developer.openfin.co/docs/javascript/stable/classes/OpenFin.System.html#launchExternalProcess) [secured APIs](https://developers.openfin.co/of-docs/docs/api-security) permissions, since the API now launches an intermediary process to handle Terminal Connect API requests.
+- The [`connect`](https://developer.openfin.co/docs/integrations/bloomberg/2.0.0/functions/connect.html) function now requires an additional "apiKey" parameter value which is your Terminal Connect API key (contact your Bloomberg account manager for more information).
+- Removed the `terminal` export (from `@openfin/bloomberg/terminal`) since that relates to the previous version of the Terminal Connect API.
+- The default interop configuration has changed in the following ways:
+  - The Terminal panel ID used to execute Terminal functions is now 0 (previously was 1).
+  - Incoming [ViewChart](https://fdc3.finos.org/docs/intents/ref/ViewChart) intents that contain an [fdc3.instrument](https://fdc3.finos.org/docs/context/ref/Instrument) context now execute the “GIP” function (previously was “GP”).
+  - Incoming [ViewQuote](https://fdc3.finos.org/docs/intents/ref/ViewQuote) intents now execute the “ALLQ” function (previously was “Q”).
+  - Incoming intents that contain an [fdc3.nothing](https://fdc3.finos.org/docs/context/ref/Nothing) context now execute the relevant Terminal function without changing the current security.
+- The connection configuration types have changed in the following ways:
+  - The way that [`actions`](https://developer.openfin.co/docs/integrations/bloomberg/2.0.0/types/BloombergActionsConfig.html) are defined has changed in that each [`ContextActionMap`](https://developer.openfin.co/docs/integrations/bloomberg/2.0.0/types/ContextActionMap.html) is no longer a `Map`, it is now a multi-dimensional array mapping context types to [`ContextActionHandler`](https://developer.openfin.co/docs/integrations/bloomberg/2.0.0/types/ContextActionHandler.html) functions. These functions are called when an incoming context matches the mapped context type and are passed the context object as a parameter. They must return (or resolve to) a [`BloombergAction`](https://developer.openfin.co/docs/integrations/bloomberg/2.0.0/types/BloombergAction.html) which instructs the Terminal on what to do.
+  - The [`BloombergAction`](https://developer.openfin.co/docs/integrations/bloomberg/2.0.0/types/BloombergAction.html) type has changed to support the new [`ContextActionHandler`](https://developer.openfin.co/docs/integrations/bloomberg/2.0.0/types/ContextActionHandler.html) function:
+    - The `BloombergTerminalCommand` has been replaced with the new [`BloombergTerminalFunction`](https://developer.openfin.co/docs/integrations/bloomberg/2.0.0/types/BloombergTerminalFunction.html) type which is similar but for the new “securities” property and modified “tail” property.
+    - The `BloombergGroup` type has been replaced with a new [`BloombergGroupUpdate`](https://developer.openfin.co/docs/integrations/bloomberg/2.0.0/types/BloombergGroupUpdate.html) type which defines the group to update and the security that the group should be set to.
+  - Connected Launchpad groups are now set as an array of group names, and by default all Launchpad groups are connected. The `BloombergGroup` type has been removed.
+  - The [`BloombergPanel`](https://developer.openfin.co/docs/integrations/bloomberg/2.0.0/types/BloombergPanel.html) type now properly reflects Terminal panel IDs as 0-3 not 1-4.
+  - The `ContextType` and `IntentName` types have been removed as they are redundant (string is now used across types referencing a context type or intent name).
+- The `isBloombergTerminalReady`, `isCusip`, `isEquity`, `isFigi` and `isIsin` functions have been removed.
+- The `AppNotAuthorizedError` and `TerminalCommandError` classes have been removed as they are no longer supported in the latest version of the Terminal Connect API.

package.json

 {
   "name": "@openfin/bloomberg",
   "description": "Connect apps running in OpenFin with the Bloomberg Terminal.",
-  "version": "2.0.0-beta.8",
+  "version": "2.0.0-beta.9",
   "author": "OpenFin Inc.",
@@ -6,0 +6,0 @@ "homepage": "https://www.openfin.co/",

types/bloomberg/bloomberg.d.ts

@@ -8,7 +8,7 @@ import type * as fdc3 from '@finos/fdc3';
 export declare const DEFAULT_TARGET: BloombergPanel;
-export declare const createGroupEventsSubscription: (dispatchAdapterMessage: DispatchChannelClientMessage, groupFilter: string | string[], onContextChanged?: ((context: unknown) => void) | undefined, onError?: ((error: ApiError) => void) | undefined) => Promise<TerminalConnectSubscription | undefined>;
+export declare const createGroupEventsSubscription: (dispatchAdapterMessage: DispatchChannelClientMessage, groupFilter: string | string[] | null, onContextChanged?: ((context: unknown) => void) | undefined, onError?: ((error: ApiError) => void) | undefined) => Promise<TerminalConnectSubscription | undefined>;
 export declare const unsubscribeGroupEvents: (dispatchAdapterMessage: DispatchChannelClientMessage, subscriptionId: string) => () => Promise<void>;
 export declare const getBloombergGroupEventListener: (onGroupEvent?: ((context: unknown) => void) | undefined, onError?: ((error: ApiError) => void) | undefined) => (context: fdc3.Context) => Promise<void>;
-export declare const handleGroupEvent: (subscriptionId: string, data: TC.TerminalConnectGroupEvent) => Promise<void>;
-export declare const getGroupIdsFromFilter: (dispatchAdapterMessage: DispatchChannelClientMessage) => (groupFilter: string | string[]) => Promise<number[] | undefined>;
+export declare const handleGroupEvent: (subscriptionId: string, data: TC.GroupEvent) => Promise<void>;
+export declare const getGroupIdsFromFilter: (dispatchAdapterMessage: DispatchChannelClientMessage) => (groupFilter: string | string[] | null) => Promise<number[] | undefined>;
 export declare const updateGroupSecurity: (dispatchAdapterMessage: DispatchChannelClientMessage) => (groupFilter: string, security?: string) => Promise<void>;

types/connection/connection.types.d.ts

@@ -6,7 +6,7 @@ import { BloombergPanel, TerminalConnectService } from '../bloomberg/bloomberg.types';
  *
- * This can be a {@link BloombergTerminalFunction | Terminal function}, a {@link BloombergGroupUpdate | Launchpad group update} or `undefined` to do nothing.
+ * This can be a {@link BloombergTerminalFunction | Terminal function}, a {@link BloombergGroupUpdate | Launchpad group update} or `null` to do nothing.
  *
  * @group Types
  */
-export type BloombergAction = BloombergTerminalFunction | BloombergGroupUpdate | undefined;
+export type BloombergAction = BloombergTerminalFunction | BloombergGroupUpdate | null | undefined;
 /**
@@ -65,7 +65,7 @@ * Action that will update a Launchpad group’s security.
     /**
-     * If set, the API will listen to the specified Launchpad group(s) and will broadcast an {@link https://fdc3.finos.org/docs/context/ref/Instrument | fdc3.instrument} context in the event that a specified group’s security changes.
+     * Provide a list of Launchpad group names (e.g. `['Group-A','Group-B']`) and an {@link https://fdc3.finos.org/docs/context/ref/Instrument | fdc3.instrument} context will be broadcast when one of the group’s security changes.
      *
-     * Set as an asterisk (e.g. `'*'`) to subscribe to all groups, or set as an array of individual group names (e.g. `['Group-A','Group-B']`).
+     * By default (if no value is provided), the API listens to all Launchpad groups. To stop the API from broadcasting context on group updates, set this to `null`.
      */
-    groups?: '*' | string[];
+    groups?: string[] | null;
     /** Set to `true` to disable all interop functionality for the connection. */
@@ -106,3 +106,3 @@ interopDisabled?: boolean;
  *
- * @returns The action that will be executed in the Terminal, which can be a {@link BloombergTerminalFunction | Terminal function} or a {@link BloombergGroupUpdate | Launchpad group update}. Alternatively, returning `undefined` will do nothing.
+ * @returns The action that will be executed in the Terminal, which can be a {@link BloombergTerminalFunction | Terminal function} or a {@link BloombergGroupUpdate | Launchpad group update}. Alternatively, returning `null` will do nothing.
  *
@@ -109,0 +109,0 @@ * @group Types

types/index.d.ts

@@ -12,1 +12,2 @@ /**
 export { TerminalConnectApiTypes } from './terminal-connect/terminal-connect.types';
+export { getSecurityFromInstrumentContext } from './utils/utils';

types/terminal-connect/terminal-connect.d.ts

@@ -8,3 +8,3 @@ import type OpenFin from '@openfin/core';
 export declare const executeApiRequest: (dispatchAdapterMessage: DispatchChannelClientMessage) => <T = unknown>(query: string, service?: string) => Promise<T>;
-export declare const getGroups: (dispatchAdapterMessage: DispatchChannelClientMessage) => () => Promise<TC.TerminalConnectGroup[]>;
+export declare const getGroups: (dispatchAdapterMessage: DispatchChannelClientMessage) => () => Promise<TC.Group[]>;
 export declare const runFunction: (dispatchAdapterMessage: DispatchChannelClientMessage) => (mnemonic: string, target: BloombergPanel | string, security1?: string, security2?: string, tail?: string) => Promise<void>;
@@ -11,0 +11,0 @@ export declare const setGroupValue: (dispatchAdapterMessage: DispatchChannelClientMessage) => (groupId: number, newValue: string) => Promise<void>;

types/terminal-connect/terminal-connect.types.d.ts

@@ -10,7 +10,7 @@ /**
      */
-    interface TerminalConnectAlert {
+    interface Alert {
         active?: boolean;
-        conditions?: TerminalConnectAlertCondition[];
+        conditions?: AlertCondition[];
         expiry?: string;
-        frequency?: TerminalConnectAlertFrequency;
+        frequency?: AlertFrequency;
         id?: string;
@@ -22,26 +22,26 @@ note?: string;
         }[];
-        timeRange?: TerminalConnectAlertTimeRange;
+        timeRange?: AlertTimeRange;
     }
     /**
-     * Entity type for an {@link TerminalConnectAlert | alert} condition.
+     * Entity type for an {@link Alert | alert} condition.
      *
      * @group Types
      */
-    interface TerminalConnectAlertCondition {
+    interface AlertCondition {
         conditionField?: string;
         conditionValue?: number;
-        operator?: TerminalConnectAlertConditionOperator;
+        operator?: AlertConditionOperator;
     }
     /**
-     * Possible operator values for {@link TerminalConnectAlert | alert} conditions.
+     * Possible operator values for {@link Alert | alert} conditions.
      *
      * @group Types
      */
-    type TerminalConnectAlertConditionOperator = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'CROSS' | 'CROSS_DOWN' | 'CROSS_UP';
+    type AlertConditionOperator = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'CROSS' | 'CROSS_DOWN' | 'CROSS_UP';
     /**
-     * Possible  frequency values for {@link TerminalConnectAlert | alerts}.
+     * Possible  frequency values for {@link Alert | alerts}.
      *
      * @group Types
      */
-    type TerminalConnectAlertFrequency = 'ONCE_PER_DAY';
+    type AlertFrequency = 'ONCE_PER_DAY';
     /**
@@ -52,18 +52,18 @@ * Result type for the `alerts` and `alertsById` queries.
      */
-    interface TerminalConnectAlertsResult {
+    interface AlertsResult {
         alerts: {
             edges?: {
                 cursor?: string;
-                node?: TerminalConnectAlert;
+                node?: Alert;
             }[];
             itemCount?: number;
-            pageInfo?: TerminalConnectPageInfo;
-        } & TerminalConnectError;
+            pageInfo?: PageInfo;
+        } & Error;
     }
     /**
-     * Entity type for {@link TerminalConnectAlert | alert} time info.
+     * Entity type for {@link Alert | alert} time info.
      *
      * @group Types
      */
-    interface TerminalConnectAlertTime {
+    interface AlertTime {
         hours?: number;
@@ -73,17 +73,17 @@ minutes?: number;
     /**
-     * Entity type for an {@link TerminalConnectAlert | alert} time range.
+     * Entity type for an {@link Alert | alert} time range.
      *
      * @group Types
      */
-    interface TerminalConnectAlertTimeRange {
-        end?: TerminalConnectAlertTime;
-        start?: TerminalConnectAlertTime;
-        timezone?: TerminalConnectAlertTimeZone;
+    interface AlertTimeRange {
+        end?: AlertTime;
+        start?: AlertTime;
+        timezone?: AlertTimeZone;
     }
     /**
-     * Possible time zone values for {@link TerminalConnectAlert | alert} time ranges.
+     * Possible time zone values for {@link Alert | alert} time ranges.
      *
      * @group Types
      */
-    type TerminalConnectAlertTimeZone = 'PACIFIC_HONOLULU' | 'PACIFIC_PAGO_PAGO' | 'PACIFIC_NORFOLK' | 'PACIFIC_FIJI' | 'PACIFIC_APIA' | 'PACIFIC_KIRITIMATI' | 'PACIFIC_AUCKLAND' | 'ATLANTIC_CAPE_VERDE' | 'ATLANTIC_AZORES' | 'AMERICA_NORONHA' | 'AMERICA_ST_JOHNS' | 'AMERICA_ARGENTINA_BUENOS_AIRES' | 'AMERICA_SANTIAGO' | 'AMERICA_TORONTO' | 'AMERICA_PANAMA' | 'AMERICA_GUATEMALA' | 'AMERICA_DENVER' | 'AMERICA_MEXICO_CITY' | 'AMERICA_VANCOUVER' | 'AMERICA_ANCHORAGE' | 'AMERICA_LOS_ANGELES' | 'AMERICA_PHOENIX' | 'AMERICA_CHICAGO' | 'AMERICA_NEW_YORK' | 'AMERICA_PUERTO_RICO' | 'AFRICA_ABIDJAN' | 'AFRICA_JOHANNESBURG' | 'AFRICA_NAIROBI' | 'EUROPE_LISBON' | 'EUROPE_ISTANBUL' | 'EUROPE_AMSTERDAM' | 'EUROPE_BRUSSELS' | 'EUROPE_MADRID' | 'EUROPE_PARIS' | 'EUROPE_WARSAW' | 'EUROPE_ZURICH' | 'EUROPE_LONDON' | 'EUROPE_BERLIN' | 'EUROPE_MOSCOW' | 'ASIA_BAGHDAD' | 'ASIA_BEIRUT' | 'ASIA_JERUSALEM' | 'ASIA_KOLKATA' | 'ASIA_DUBAI' | 'ASIA_BANGKOK' | 'ASIA_SINGAPORE' | 'ASIA_TOKYO' | 'ASIA_HO_CHI_MINH' | 'ASIA_SHANGHAI' | 'ASIA_MACAU' | 'ASIA_HONG_KONG' | 'ASIA_SEOUL' | 'INDIAN_MALDIVES' | 'INDIAN_CHAGOS' | 'AUSTRALIA_SYDNEY';
+    type AlertTimeZone = 'PACIFIC_HONOLULU' | 'PACIFIC_PAGO_PAGO' | 'PACIFIC_NORFOLK' | 'PACIFIC_FIJI' | 'PACIFIC_APIA' | 'PACIFIC_KIRITIMATI' | 'PACIFIC_AUCKLAND' | 'ATLANTIC_CAPE_VERDE' | 'ATLANTIC_AZORES' | 'AMERICA_NORONHA' | 'AMERICA_ST_JOHNS' | 'AMERICA_ARGENTINA_BUENOS_AIRES' | 'AMERICA_SANTIAGO' | 'AMERICA_TORONTO' | 'AMERICA_PANAMA' | 'AMERICA_GUATEMALA' | 'AMERICA_DENVER' | 'AMERICA_MEXICO_CITY' | 'AMERICA_VANCOUVER' | 'AMERICA_ANCHORAGE' | 'AMERICA_LOS_ANGELES' | 'AMERICA_PHOENIX' | 'AMERICA_CHICAGO' | 'AMERICA_NEW_YORK' | 'AMERICA_PUERTO_RICO' | 'AFRICA_ABIDJAN' | 'AFRICA_JOHANNESBURG' | 'AFRICA_NAIROBI' | 'EUROPE_LISBON' | 'EUROPE_ISTANBUL' | 'EUROPE_AMSTERDAM' | 'EUROPE_BRUSSELS' | 'EUROPE_MADRID' | 'EUROPE_PARIS' | 'EUROPE_WARSAW' | 'EUROPE_ZURICH' | 'EUROPE_LONDON' | 'EUROPE_BERLIN' | 'EUROPE_MOSCOW' | 'ASIA_BAGHDAD' | 'ASIA_BEIRUT' | 'ASIA_JERUSALEM' | 'ASIA_KOLKATA' | 'ASIA_DUBAI' | 'ASIA_BANGKOK' | 'ASIA_SINGAPORE' | 'ASIA_TOKYO' | 'ASIA_HO_CHI_MINH' | 'ASIA_SHANGHAI' | 'ASIA_MACAU' | 'ASIA_HONG_KONG' | 'ASIA_SEOUL' | 'INDIAN_MALDIVES' | 'INDIAN_CHAGOS' | 'AUSTRALIA_SYDNEY';
     /**
@@ -94,4 +94,4 @@ * Result type for the `appendSecuritiesToWorksheet` mutation.
      */
-    interface TerminalConnectAppendSecuritiesToWorksheetResult {
-        appendSecuritiesToWorksheet: TerminalConnectWorksheet & TerminalConnectError;
+    interface AppendSecuritiesToWorksheetResult {
+        appendSecuritiesToWorksheet: Worksheet & Error;
     }
@@ -103,6 +103,6 @@ /**
      */
-    interface TerminalConnectBssoTokenResult {
+    interface BssoTokenResult {
         bssoToken: {
             accessToken?: string;
-        } & TerminalConnectError;
+        } & Error;
     }
@@ -114,3 +114,3 @@ /**
      */
-    interface TerminalConnectComponent {
+    interface Component {
         compId?: string;
@@ -126,6 +126,6 @@ name?: string;
      */
-    interface TerminalConnectComponentsResult {
+    interface ComponentsResult {
         components: {
-            items?: TerminalConnectComponent[];
-        } & TerminalConnectError;
+            items?: Component[];
+        } & Error;
     }
@@ -137,4 +137,4 @@ /**
      */
-    interface TerminalConnectCreateAlertResult {
-        createLimitAlert: TerminalConnectAlert & TerminalConnectError;
+    interface CreateAlertResult {
+        createLimitAlert: Alert & Error;
     }
@@ -146,4 +146,4 @@ /**
      */
-    interface TerminalConnectCreateWorksheetResult {
-        createWorksheet: TerminalConnectWorksheet & TerminalConnectError;
+    interface CreateWorksheetResult {
+        createWorksheet: Worksheet & Error;
     }
@@ -155,6 +155,6 @@ /**
      */
-    interface TerminalConnectDeleteAlertResult {
+    interface DeleteAlertResult {
         deleteAlert: {
             successful?: boolean;
-        } & TerminalConnectError;
+        } & Error;
     }
@@ -166,3 +166,3 @@ /**
      */
-    interface TerminalConnectError {
+    interface Error {
         errorCategory?: 'AUTHORIZATION' | 'ERROR' | 'INVALID_INPUT' | 'RATE_LIMIT_EXCEEDED' | 'TIMEOUT';
@@ -176,3 +176,3 @@ errorMessage?: string;
      */
-    interface TerminalConnectGroup {
+    interface Group {
         id?: number;
@@ -188,15 +188,15 @@ name?: string;
      */
-    interface TerminalConnectGroupEvent {
+    interface GroupEvent {
         subscribeGroupEvents: {
             data?: string;
-            group?: TerminalConnectGroup;
-            type?: TerminalConnectGroupEventType;
+            group?: Group;
+            type?: GroupEventType;
         };
     }
     /**
-     * Possible values for {@link TerminalConnectGroupEvent | group event} types.
+     * Possible values for {@link GroupEvent | group event} types.
      *
      * @group Types
      */
-    type TerminalConnectGroupEventType = 'ANY' | 'CREATED' | 'DELETED' | 'RENAMED' | 'VALUE_CHANGED';
+    type GroupEventType = 'ANY' | 'CREATED' | 'DELETED' | 'RENAMED' | 'VALUE_CHANGED';
     /**
@@ -207,6 +207,6 @@ * Result type for the `groups` query.
      */
-    interface TerminalConnectGroupsResult {
+    interface GroupsResult {
         groups: {
-            items?: TerminalConnectGroup[];
-        } & TerminalConnectError;
+            items?: Group[];
+        } & Error;
     }
@@ -218,4 +218,4 @@ /**
      */
-    interface TerminalConnectOpenInLaunchpadResult {
-        openInLaunchpad: TerminalConnectComponent & TerminalConnectError;
+    interface OpenInLaunchpadResult {
+        openInLaunchpad: Component & Error;
     }
@@ -227,3 +227,3 @@ /**
      */
-    interface TerminalConnectOperationResult {
+    interface OperationResult {
         details?: string;
@@ -237,3 +237,3 @@ succeeded?: boolean;
      */
-    interface TerminalConnectPageInfo {
+    interface PageInfo {
         endCursor?: string;
@@ -249,6 +249,6 @@ hasNextPage?: boolean;
      */
-    interface TerminalConnectPublishAlertEventResult {
+    interface PublishAlertEventResult {
         publishAlertEvent: {
             successful?: boolean;
-        } & TerminalConnectError;
+        } & Error;
     }
@@ -260,4 +260,4 @@ /**
      */
-    interface TerminalConnectRemoveSecuritiesFromWorksheetResult {
-        removeSecuritiesFromWorksheet: TerminalConnectWorksheet & TerminalConnectError;
+    interface RemoveSecuritiesFromWorksheetResult {
+        removeSecuritiesFromWorksheet: Worksheet & Error;
     }
@@ -269,4 +269,4 @@ /**
      */
-    interface TerminalConnectReplaceSecuritiesInWorksheetResult {
-        replaceSecuritiesInWorksheet: TerminalConnectWorksheet & TerminalConnectError;
+    interface ReplaceSecuritiesInWorksheetResult {
+        replaceSecuritiesInWorksheet: Worksheet & Error;
     }
@@ -278,4 +278,4 @@ /**
      */
-    interface TerminalConnectRunFunctionInPanelResult {
-        runFunctionInPanel: TerminalConnectOperationResult & TerminalConnectError;
+    interface RunFunctionInPanelResult {
+        runFunctionInPanel: OperationResult & Error;
     }
@@ -287,4 +287,4 @@ /**
      */
-    interface TerminalConnectRunFunctionInTabResult {
-        runFunctionInTab: TerminalConnectOperationResult & TerminalConnectError;
+    interface RunFunctionInTabResult {
+        runFunctionInTab: OperationResult & Error;
     }
@@ -296,11 +296,11 @@ /**
      */
-    interface TerminalConnectSecuritiesResult {
+    interface SecuritiesResult {
         securities: {
             edges?: {
                 cursor?: string;
-                node?: TerminalConnectSecurity;
+                node?: Security;
             }[];
             itemCount?: number;
-            pageInfo?: TerminalConnectPageInfo;
-        } & TerminalConnectError;
+            pageInfo?: PageInfo;
+        } & Error;
     }
@@ -312,3 +312,3 @@ /**
      */
-    interface TerminalConnectSecurity {
+    interface Security {
         id?: string;
@@ -322,6 +322,6 @@ name?: string;
      */
-    interface TerminalConnectSetGroupValueResult {
+    interface SetGroupValueResult {
         setGroupValue: {
-            results?: TerminalConnectOperationResult[];
-        } & TerminalConnectError;
+            results?: OperationResult[];
+        } & Error;
     }
@@ -333,4 +333,4 @@ /**
      */
-    interface TerminalConnectUpdateAlertResult {
-        updateLimitAlert: TerminalConnectAlert & TerminalConnectError;
+    interface UpdateAlertResult {
+        updateLimitAlert: Alert & Error;
     }
@@ -342,4 +342,4 @@ /**
      */
-    interface TerminalConnectUpdateComponentResult {
-        updateComponent: TerminalConnectOperationResult & TerminalConnectError;
+    interface UpdateComponentResult {
+        updateComponent: OperationResult & Error;
     }
@@ -351,20 +351,20 @@ /**
      */
-    interface TerminalConnectWorksheet {
+    interface Worksheet {
         id?: string;
         isOpen?: boolean;
         name?: string;
-        securities: TerminalConnectWorksheetSecuritiesResult;
+        securities: WorksheetSecuritiesResult;
     }
     /**
-     * Result type for the collection of securities returned in a {@link TerminalConnectWorksheet | worksheet}.
+     * Result type for the collection of securities returned in a {@link Worksheet | worksheet}.
      *
      * @group Types
      */
-    interface TerminalConnectWorksheetSecuritiesResult {
+    interface WorksheetSecuritiesResult {
         edges?: {
             cursor?: string;
-            node?: TerminalConnectWorksheetSecurity;
+            node?: WorksheetSecurity;
         }[];
         itemCount?: number;
-        pageInfo?: TerminalConnectPageInfo;
+        pageInfo?: PageInfo;
     }
@@ -376,3 +376,3 @@ /**
      */
-    interface TerminalConnectWorksheetSecurity {
+    interface WorksheetSecurity {
         id?: string;
@@ -385,12 +385,12 @@ }
      */
-    interface TerminalConnectWorksheetsResult {
+    interface WorksheetsResult {
         worksheets: {
             edges?: {
                 cursor?: string;
-                node?: TerminalConnectWorksheet;
+                node?: Worksheet;
             }[];
             itemCount?: number;
-            pageInfo?: TerminalConnectPageInfo;
-        } & TerminalConnectError;
+            pageInfo?: PageInfo;
+        } & Error;
     }
 }

types/utils/utils.d.ts

@@ -8,6 +8,14 @@ import * as fdc3 from '@finos/fdc3';
 export declare const getMarketSectorFromSecurity: (security: string) => BloombergMarketSector | undefined;
-export declare const getSecurityFromInstrumentContext: (context: fdc3.Instrument) => string | undefined;
 /**
+ * Extracts a Bloomberg Terminal-compatible security string from an FDC3 instrument context.
+ *
+ * The function first checks for a `BBG` or `FIGI` identifier in the context, and if not found, constructs an Equity security string
+ * from the `ticker` identifier using the `market.BBG` property if set. Otherwise it defaults to `US` for the market code.
+ *
+ * @param context - FDC3 instrument context.
+ */
+export declare const getSecurityFromInstrumentContext: (context: unknown) => string | undefined;
+/**
  * Polyfills `crypto.randomUUID` if running in a non-secure context.
  */
 export declare const randomUUID: () => string;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

79591

increased by7.44%

Lines of code

820

increased by1.11%

No dependency changes