@openfin/bloomberg - npm Package Compare versions

Comparing version 2.0.0-beta.4 to 2.0.0-beta.5

package.json

 {
   "name": "@openfin/bloomberg",
   "description": "Connect apps running in OpenFin with the Bloomberg Terminal.",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.5",
   "author": "OpenFin Inc.",
@@ -24,4 +24,5 @@ "homepage": "https://www.openfin.co/",
   "dependencies": {
+    "@finos/fdc3": "^2.1.0-beta.6",
     "deepmerge-ts": "^5.1.0"
   }
 }

types/adapter/adapter.d.ts

 import type OpenFin from '@openfin/core';
 import { BloombergAdapter } from './adapter.types';
-export declare const init: () => Promise<BloombergAdapter>;
+export declare const init: (adapterLoggingEnabled?: boolean) => Promise<BloombergAdapter>;
 export declare const logMessageTopicHandler: OpenFin.ChannelAction;
 export declare const subscriptionEventTopicHandler: OpenFin.ChannelAction;

types/adapter/adapter.generated-types.d.ts

 export interface AdapterConnectionRequest {
-    version: string;
+    version?: string;
 }
 export interface AdapterResponse {
-    data: string;
-    error: ErrorResponseInformation;
+    data?: string;
+    error?: ErrorResponseInformation;
     success: boolean;
 }
 export interface CancelSubscriptionRequest {
-    subscriptionId: string;
+    service?: TerminalConnectService;
+    subscriptionId?: string;
 }
@@ -22,3 +23,3 @@ export declare enum ChannelTopic {
 export interface ConnectRequest {
-    apiKey: string;
+    apiKey?: string;
 }
@@ -29,5 +30,5 @@ export interface CreateSubscriptionResponse {
 export interface ErrorResponseInformation {
-    message: string;
-    name: string;
-    stackTrace: string;
+    message?: string;
+    name?: string;
+    stackTrace?: string;
 }
@@ -41,11 +42,16 @@ export declare enum LogLevel {
     level: LogLevel;
-    message: string;
+    message?: string;
 }
 export interface SubscriptionEventRequest {
-    data: string;
-    error: ErrorResponseInformation;
-    subscriptionId: string;
+    data?: string;
+    error?: ErrorResponseInformation;
+    subscriptionId?: string;
 }
 export interface TerminalConnectGraphQlRequest {
     query: string;
+    service?: TerminalConnectService;
 }
+export declare enum TerminalConnectService {
+    Local = "Local",
+    Remote = "Remote"
+}

types/bloomberg/bloomberg.d.ts

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

types/bloomberg/bloomberg.types.d.ts

@@ -15,2 +15,3 @@ import type OpenFin from '@openfin/core';
 };
+export type TerminalConnectService = 'local' | 'remote';
 export type TerminalConnectSubscription = Subscription & {
@@ -17,0 +18,0 @@ id: string;

types/connection/connection.types.d.ts

@@ -1,2 +0,2 @@
-import { BloombergPanel } from '../bloomberg/bloomberg.types';
+import { BloombergPanel, TerminalConnectService } from '../bloomberg/bloomberg.types';
 import { ApiError } from '../errors/errors';
@@ -13,3 +13,7 @@ /**
  */
-export type BloombergAction = BloombergTerminalCommand | string;
+export type BloombergAction = BloombergTerminalCommand | BloombergGroupUpdate | undefined;
+export type BloombergGroupUpdate = {
+    group: string;
+    security: string;
+};
 /**
@@ -34,6 +38,5 @@ * Configuration determining which {@link https://developers.openfin.co/of-docs/docs/interoperability-overview#context | context types} and
 export type BloombergConnection = {
-    apiKey: string;
     /** Closes the connection preventing context types and intents from being handled by the Bloomberg Terminal. */
     disconnect: () => Promise<void>;
-    executeApiRequest: <T = unknown>(query: string) => Promise<T>;
+    executeApiRequest: <T = unknown>(query: string, service?: TerminalConnectService) => Promise<T>;
 };
@@ -48,5 +51,11 @@ /**
     actions?: BloombergActionsConfig;
-    /** Bloomberg Launchpad group that will set context whenever the group’s security changes. */
-    group?: string;
     /**
+     * Bloomberg Launchpad group(s) that will set context whenever 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']`).
+     */
+    groups?: '*' | string[];
+    /** Set to `true` to disable interop functionality for the connection. */
+    interopDisabled?: boolean;
+    /**
      * Callback that will be triggered whenever context changes.
@@ -72,7 +81,11 @@ *
     mnemonic: string;
-    /** Tails for the mnemonic/function. */
+    /** Securities to be used with the mnemonic/function. */
+    securities?: string[];
+    /** Tails to be used with the mnemonic/function. */
     tails?: string;
     /** The Terminal panel ID that will handle the command. */
-    target: BloombergPanel;
+    target: BloombergPanel | string;
 };
+export type ContextActionHandler = (context: unknown) => BloombergAction | Promise<BloombergAction>;
+export type ContextAction = ContextActionHandler;
 /**
@@ -83,10 +96,4 @@ * Map associating context types with their corresponding actions.
  */
-export type ContextActionMap = Map<ContextType, BloombergAction | undefined>;
+export type ContextActionMap = [string, ContextAction][];
 /**
- * Type name of a {@link https://developers.openfin.co/of-docs/docs/interoperability-overview#context | context} object.
- *
- * @group Types
- */
-export type ContextType = string;
-/**
  * Map associating intents with their corresponding context types and actions.
@@ -96,8 +103,2 @@ *
  */
-export type IntentActionMap = Map<IntentName, ContextActionMap | undefined>;
-/**
- * Name of an {@link https://developers.openfin.co/of-docs/docs/interoperability-overview#intent | intent}.
- *
- * @group Types
- */
-export type IntentName = string;
+export type IntentActionMap = [string, ContextActionMap | undefined][];

types/index.d.ts

@@ -1,8 +0,7 @@
-export { BloombergPanel } from './bloomberg/bloomberg.types';
+export { BloombergPanel, TerminalConnectService } from './bloomberg/bloomberg.types';
 export { connect } from './connection/connection';
-export { BloombergAction, BloombergActionsConfig, BloombergConnection, BloombergConnectionConfig, BloombergTerminalCommand, ContextActionMap, ContextType, IntentActionMap, IntentName, } from './connection/connection.types';
+export { BloombergAction, BloombergActionsConfig, BloombergConnection, BloombergConnectionConfig, BloombergTerminalCommand, ContextAction, ContextActionHandler, ContextActionMap, IntentActionMap, } from './connection/connection.types';
 export { ApiError, AppNotAuthorizedError, InteropError, TerminalCommandError, TerminalConnectionError, } from './errors/errors';
-export { getDefaultActions } from './interop/interop';
 export { disableLogging, enableLogging } from './logger/logger';
 export { TerminalConnectApiTypes } from './terminal-connect/terminal-connect.types';
 export { isCusip, isEquity, isFigi, isIsin } from './utils/utils';

types/logger/logger.d.ts

@@ -19,4 +19,5 @@ /**
 export declare const enableLogging: () => void;
+export declare const isLoggingEnabled: () => boolean;
 export declare const logError: (error: unknown, errorPrefix?: string) => void;
 export declare const logInfo: (...args: any[]) => void;
 export declare const logWarning: (...args: any[]) => void;

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

@@ -5,6 +5,6 @@ import type OpenFin from '@openfin/core';
 import { TerminalConnectApiTypes as TC } from './terminal-connect.types';
-export declare const executeApiRequest: (dispatchAdapterMessage: DispatchChannelClientMessage) => <T = unknown>(query: string) => Promise<T>;
-export declare const getGroups: (dispatchAdapterMessage: DispatchChannelClientMessage) => () => Promise<TC.TerminalConnectGroupItem[]>;
 export declare const connect: (channelClient: OpenFin.ChannelClient) => (apiKey: string) => Promise<void>;
 export declare const disconnect: (dispatchAdapterMessage: DispatchChannelClientMessage) => () => Promise<void>;
+export declare const executeApiRequest: (dispatchAdapterMessage: DispatchChannelClientMessage) => <T = unknown>(query: string, service?: string) => Promise<T>;
+export declare const getGroups: (dispatchAdapterMessage: DispatchChannelClientMessage) => () => Promise<TC.TerminalConnectGroupItem[]>;
 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/utils/utils.d.ts

@@ -1,6 +0,10 @@
-import type OpenFin from '@openfin/core';
+import * as fdc3 from '@finos/fdc3';
+import { BloombergMarketSector } from '../bloomberg/bloomberg.types';
 import { UsageFeatureName } from './utils.types';
+export declare const ensureBloombergSecurityString: (security?: string) => string | undefined;
 export declare const getApiVersion: () => string;
-export declare const getInstrumentContextFromSecurity: (security: string) => OpenFin.Context;
-export declare const getSecurityFromInstrumentContext: (context: OpenFin.Context) => string | undefined;
+export declare const getSecurityFromInstrumentContext: (context: fdc3.Instrument) => string | undefined;
+export declare const getDateFromIsoString: (utcString: string) => Date | undefined;
+export declare const getInstrumentContextFromSecurity: (security: string) => fdc3.Instrument;
+export declare const getMarketSectorFromSecurity: (security: string) => BloombergMarketSector | undefined;
 /**
@@ -7,0 +11,0 @@ * Determines if the provided text is a {@link https://www.cusip.com/cusip/index.htm | CUSIP}.

No alert changes

Improved metrics

Total package byte prevSize

62332

increased by9.5%

Lines of code

440

increased by1.15%

Worsened metrics

Dependency count

2

increased by100%

Number of package files

22

decreased by-4.35%

Dependency changes

• + Added@finos/fdc3@^2.1.0-beta.6

• + Added@finos/fdc3@2.1.1(transitive)

• + Added@rollup/rollup-linux-x64-gnu@4.14.1(transitive)