@openfin/bloomberg - npm Package Compare versions

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

package.json

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

types/bloomberg/bloomberg.types.d.ts

@@ -15,2 +15,9 @@ import type * as fdc3 from '@finos/fdc3';
 };
+/**
+ * Specifies a service endpoint for Bloomberg’s Terminal Connect API.
+ *
+ * This will either be the local service running on the same machine as the Terminal itself, or the remote service hosted by Bloomberg.
+ *
+ * @group Types
+ */
 export type TerminalConnectService = 'local' | 'remote';
@@ -17,0 +24,0 @@ export type TerminalConnectSubscription = Subscription & {

types/connection/connection.d.ts

@@ -6,10 +6,17 @@ import { DispatchChannelClientMessage } from '../adapter/adapter.types';
 /**
- * Creates a connection to the Bloomberg Terminal enabling the handling of {@link https://developers.openfin.co/of-docs/docs/interoperability-overview#context | context types} and {@link https://developers.openfin.co/of-docs/docs/interoperability-overview#intent | intents}.
+ * Establishes a connection to the Terminal.
  *
- * Note: The Terminal must be running locally and logged in, otherwise an error will be thrown.
+ * A Bloomberg Terminal Connect API key is required to establish a connection (contact your Bloomberg account manager for more information).
  *
- * @param config - Connection configuration settings. Uses {@link https://developers.openfin.co/of-docs/docs/integration-with-terminal-connect#default-integration-configuration | default configuration} if none provided.
+ * Note: the Terminal must be running locally and logged in, otherwise an error will be thrown.
  *
- * @throws {@link TerminalConnectionError} if the Bloomberg Terminal is not running or logged in.
- * @throws {@link ApiError} if an unspecified error occurs during connection.
+ * @param apiKey - Bloomberg Terminal Connect API key.
+ * @param config - Connection configuration settings (if not provided, the default configuration is used).
+ *
+ * @throws {@link InitializationError} if an error occurs when initializing the background adapter process.
+ * @throws {@link TerminalConnectionError} if an error occurs when attempting to connect to the Terminal.
+ * @throws {@link TerminalConnectRequestError} if a Terminal Connect API request fails.
+ * @throws {@link InteropError} if an error occurs when initializing interop functionality.
+ * @throws {@link AdapterError} if an unexpected error is thrown by the background adapter process.
+ * @throws {@link ApiError} if an unexpected error is thrown by the API.
  */
@@ -16,0 +23,0 @@ export declare const connect: (apiKey: string, config?: BloombergConnectionConfig) => Promise<BloombergConnection>;

types/connection/connection.types.d.ts

 import { BloombergPanel, TerminalConnectService } from '../bloomberg/bloomberg.types';
 import { ApiError } from '../errors/errors';
 /**
- * Action that will be handled by the Bloomberg Terminal.
+ * Action to be executed in the Terminal.
  *
- * If the action is a {@link BloombergTerminalCommand | command}, the Terminal will execute the command in the specified panel.
+ * This can be a {@link BloombergTerminalFunction | Terminal function}, a {@link BloombergGroupUpdate | Launchpad group update} or `undefined` to do nothing.
  *
- * If the action is a group name, the group’s security will be updated when handling {@link https://fdc3.finos.org/docs/context/ref/Instrument | instrument}
- * contexts.
+ * @group Types
+ */
+export type BloombergAction = BloombergTerminalFunction | BloombergGroupUpdate | undefined;
+/**
+ * Action that will update a Launchpad group’s security.
  *
  * @group Types
  */
-export type BloombergAction = BloombergTerminalCommand | BloombergGroupUpdate | undefined;
 export type BloombergGroupUpdate = {
+    /** The name of the Launchpad group to update (e.g. “Group-A”). */
     group: string;
+    /** The security to update the group with (e.g. “MSFT US Equity”). */
     security: string;
 };
 /**
- * Configuration determining which {@link https://developers.openfin.co/of-docs/docs/interoperability-overview#context | context types} and
- * {@link https://developers.openfin.co/of-docs/docs/interoperability-overview#intent | intents} will be handled by the Bloomberg Terminal, and how.
+ * Configuration determining which incoming {@link https://developers.openfin.co/of-docs/docs/interoperability-overview#context | context types} and {@link https://developers.openfin.co/of-docs/docs/interoperability-overview#intent | intents} will be handled by the API and their resultant actions in the Terminal.
  *
@@ -31,4 +34,3 @@ * @group Types
 /**
- * A connection to the Bloomberg Terminal that enables {@link https://developers.openfin.co/of-docs/docs/interoperability-overview | interoperability}
- * with other OpenFin apps.
+ * A connection to the Bloomberg Terminal.
  *
@@ -38,8 +40,20 @@ * @group Types
 export type BloombergConnection = {
-    /** Closes the connection preventing context types and intents from being handled by the Bloomberg Terminal. */
+    /** Terminates the connection and cleans up utilized resources. */
     disconnect: () => Promise<void>;
+    /**
+     * Executes a GraphQL request to the Bloomberg Terminal Connect API.
+     *
+     * Please refer to Bloomberg’s Terminal Connect API documentation for more information on executing Terminal Connect API requests.
+     *
+     * @typeParam T - A type that describes the requested data. This API includes a number of {@link TerminalConnectApiTypes | data types} for use with this function.
+     *
+     * @param query - The GraphQL query payload to execute.
+     * @param service - The Terminal Connect API service endpoint to direct the request to. Defaults to the local service endpoint.
+     *
+     * @returns The data object of type {@link T} contained in the API response.
+     */
     executeApiRequest: <T = unknown>(query: string, service?: TerminalConnectService) => Promise<T>;
 };
 /**
- * Configuration for a Bloomberg Connection.
+ * Configuration options for a Bloomberg Connection.
  *
@@ -49,6 +63,6 @@ * @group Types
 export type BloombergConnectionConfig = {
-    /** Context types and intents that will be handled along with their corresponding actions. */
+    /** Provide an actions config to extend or override the default actions used by the API. */
     actions?: BloombergActionsConfig;
     /**
-     * Bloomberg Launchpad group(s) that will set context whenever the group’s security changes.
+     * 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.
      *
@@ -58,12 +72,12 @@ * 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. */
+    /** Set to `true` to disable all interop functionality for the connection. */
     interopDisabled?: boolean;
     /**
-     * Callback that will be triggered whenever context changes.
+     * Function that will be executed whenever {@link https://developers.openfin.co/of-docs/docs/interoperability-overview#context | context } changes.
      *
-     * @param context - The new context.
+     * @param context - The incoming context object that has triggered execution of the function.
      */
     onContextChanged?: (context: unknown) => void;
     /**
-     * Callback that will be triggered whenever an error occurs after the connection has been created.
+     * Function that will be executed whenever an API error occurs after the connection has been created.
      *
@@ -75,20 +89,46 @@ * @param error - Error that was detected.
 /**
- * Command that will be handled by the Bloomberg Terminal.
+ * Action that will execute a Bloomberg function in the specified Terminal panel.
  *
  * @group Types
  */
-export type BloombergTerminalCommand = {
+export type BloombergTerminalFunction = {
     /** Mnemonic code of the Terminal function to execute. */
     mnemonic: string;
-    /** Securities to be used with the mnemonic/function. */
+    /** Securities to be used with the function. */
     securities?: string[];
-    /** Tail to be used with the mnemonic/function. */
+    /** Tail to be used with the function. */
     tail?: string;
-    /** The Terminal panel ID that will handle the command. */
+    /** The Terminal panel ID or named tab that will execute the function. */
     target: BloombergPanel | string;
 };
+/**
+ * Function that accepts a context object as a parameter and returns an action to be executed in the Terminal.
+ *
+ * @param context - The incoming {@link https://developers.openfin.co/of-docs/docs/interoperability-overview#context | context } object that will be passed to the handler so that it can determine the appropriate action.
+ *
+ * @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.
+ *
+ * @group Types
+ */
 export type ContextActionHandler = (context: unknown) => BloombergAction | Promise<BloombergAction>;
 /**
- * Map associating context types with their corresponding actions.
+ * Action map associating context types with their corresponding actions.
  *
+ * @example
+ * ```typescript
+ * import { BloombergConnectionConfig } from '@openfin/bloomberg';
+ * import * as fdc3 from '@finos/fdc3';
+ *
+ * const options: BloombergConnectionConfig = {
+ *  actions: {
+ *    contexts: [
+ *      [
+ *        fdc3.ContextTypes.Instrument,
+ *        (context) => ({ mnemonic: 'DES', securities: [(context as fdc3.Instrument).id.BBG], target: 0 }),
+ *      ],
+ *    ],
+ *  },
+ *};
+ * ```
+ *
  * @group Types
@@ -98,6 +138,28 @@ */
 /**
- * Map associating intents with their corresponding context types and actions.
+ * Action map associating intents with their corresponding context types and actions.
  *
+ * @example
+ * ```typescript
+ * import { BloombergConnectionConfig } from '@openfin/bloomberg';
+ * import * as fdc3 from '@finos/fdc3';
+ *
+ * const options: BloombergConnectionConfig = {
+ *  actions: {
+ *    intents: [
+ *      [
+ *        fdc3.Intents.ViewInstrument,
+ *        [
+ *          [
+ *            fdc3.ContextTypes.Instrument,
+ *            (context) => ({ mnemonic: 'DES', securities: [(context as fdc3.Instrument).id.BBG], target: 0 })
+ *          ]
+ *        ],
+ *      ],
+ *    ],
+ *  },
+ *};
+ * ```
+ *
  * @group Types
  */
 export type IntentActionMap = [string, ContextActionMap | undefined][];

types/errors/errors.d.ts

@@ -11,3 +11,3 @@ /**
 /**
- * Describes errors thrown by adapter.
+ * Thrown when an unexpected error occurs in the background adapter process.
  *
@@ -20,3 +20,3 @@ * @group Errors
 /**
- * Describes errors thrown when initializing adapter.
+ * Thrown when initialization of the background adapter process fails.
  *
@@ -29,3 +29,3 @@ * @group Errors
 /**
- * Error class used when an interop operation results in an error.
+ * Thrown when an interop operation results in an error.
  *
@@ -38,3 +38,3 @@ * @group Errors
 /**
- * Describes errors thrown when invalid parameter values are provided to API functions.
+ * Thrown when invalid parameter values are provided to API functions.
  *
@@ -50,3 +50,3 @@ * @group Errors
 /**
- * Error class used when unable to communicate with the local Bloomberg Terminal instance.
+ * Thrown when unable to establish a connection to the Terminal.
  *
@@ -59,3 +59,3 @@ * @group Errors
 /**
- * Error class used when a request to the Terminal Connect API fails.
+ * Thrown when a Terminal Connect API request fails.
  *
@@ -62,0 +62,0 @@ * @group Errors

types/index.d.ts

@@ -0,6 +1,11 @@
+/**
+ * Please refer to the {@link https://developers.openfin.co/of-docs/docs/bloomberg-integration | developer documentation} for additional information and code examples.
+ *
+ * @module @openfin/bloomberg
+ */
 export { BloombergPanel, TerminalConnectService } from './bloomberg/bloomberg.types';
 export { connect } from './connection/connection';
-export { BloombergAction, BloombergActionsConfig, BloombergConnection, BloombergConnectionConfig, BloombergGroupUpdate, BloombergTerminalCommand, ContextActionHandler, ContextActionMap, IntentActionMap, } from './connection/connection.types';
-export { AdapterError, ApiError, InitializationError, InteropError, TerminalConnectionError } from './errors/errors';
+export { BloombergAction, BloombergActionsConfig, BloombergConnection, BloombergConnectionConfig, BloombergGroupUpdate, BloombergTerminalFunction, ContextActionHandler, ContextActionMap, IntentActionMap, } from './connection/connection.types';
+export { AdapterError, ApiError, InitializationError, InteropError, TerminalConnectionError, TerminalConnectRequestError, } from './errors/errors';
 export { disableLogging, enableLogging } from './logger/logger';
 export { TerminalConnectApiTypes } from './terminal-connect/terminal-connect.types';

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.TerminalConnectGroupItem[]>;
+export declare const getGroups: (dispatchAdapterMessage: DispatchChannelClientMessage) => () => Promise<TC.TerminalConnectGroup[]>;
 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

@@ -0,57 +1,365 @@
+/**
+ * A collection of type definitions for use when making GraphQL requests to Bloomberg’s Terminal Connect API using the `BloombergConnection.executeApiRequest` function.
+ */
 export declare namespace TerminalConnectApiTypes {
-    type TerminalConnectBssoTokenResult = {
+    /**
+     * Entity type for an alert.
+     *
+     * @group Types
+     */
+    interface TerminalConnectAlert {
+        active?: boolean;
+        conditions?: TerminalConnectAlertCondition[];
+        expiry?: string;
+        frequency?: TerminalConnectAlertFrequency;
+        id?: string;
+        note?: string;
+        revision?: number;
+        source?: {
+            sourceId?: string;
+        }[];
+        timeRange?: TerminalConnectAlertTimeRange;
+    }
+    /**
+     * Entity type for an {@link TerminalConnectAlert | alert} condition.
+     *
+     * @group Types
+     */
+    interface TerminalConnectAlertCondition {
+        conditionField?: string;
+        conditionValue?: number;
+        operator?: TerminalConnectAlertConditionOperator;
+    }
+    /**
+     * Possible operator values for {@link TerminalConnectAlert | 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';
+    /**
+     * Possible  frequency values for {@link TerminalConnectAlert | alerts}.
+     *
+     * @group Types
+     */
+    type TerminalConnectAlertFrequency = 'ONCE_PER_DAY';
+    /**
+     * Result type for the `alerts` and `alertsById` queries.
+     *
+     * @group Types
+     */
+    interface TerminalConnectAlertsResult {
+        alerts: {
+            edges?: {
+                cursor?: string;
+                node?: TerminalConnectAlert;
+            }[];
+            itemCount?: number;
+            pageInfo?: TerminalConnectPageInfo;
+        } & TerminalConnectError;
+    }
+    /**
+     * Entity type for {@link TerminalConnectAlert | alert} time info.
+     *
+     * @group Types
+     */
+    interface TerminalConnectAlertTime {
+        hours?: number;
+        minutes?: number;
+    }
+    /**
+     * Entity type for an {@link TerminalConnectAlert | alert} time range.
+     *
+     * @group Types
+     */
+    interface TerminalConnectAlertTimeRange {
+        end?: TerminalConnectAlertTime;
+        start?: TerminalConnectAlertTime;
+        timezone?: TerminalConnectAlertTimeZone;
+    }
+    /**
+     * Possible time zone values for {@link TerminalConnectAlert | 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';
+    /**
+     * Result type for the `appendSecuritiesToWorksheet` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectAppendSecuritiesToWorksheetResult {
+        appendSecuritiesToWorksheet: TerminalConnectWorksheet & TerminalConnectError;
+    }
+    /**
+     * Result type for the `bssoToken` query.
+     *
+     * @group Types
+     */
+    interface TerminalConnectBssoTokenResult {
         bssoToken: {
             accessToken?: string;
-        } | TerminalConnectErrorResult;
-    };
-    type TerminalConnectErrorResult = {
-        errorCategory: 'AUTHORIZATION' | 'ERROR' | 'INVALID_INPUT' | 'RATE_LIMIT_EXCEEDED' | 'TIMEOUT';
-        errorMessage: string;
-    };
-    type TerminalConnectGroupEventListener = (event: TerminalConnectGroupEventType, group: Omit<TerminalConnectGroupItem, 'type'>) => void | Promise<void>;
-    type TerminalConnectGroupEventType = 'ANY' | 'CREATED' | 'DELETED' | 'RENAMED' | 'VALUE_CHANGED';
-    type TerminalConnectGroupItem = {
-        id: number;
-        name: string;
-        type: string;
+        } & TerminalConnectError;
+    }
+    /**
+     * Entity type for an individual Launchpad component window.
+     *
+     * @group Types
+     */
+    interface TerminalConnectComponent {
+        compId?: string;
+        name?: string;
+        tag?: string;
+        title?: string;
+    }
+    /**
+     * Result type for the `components` query.
+     *
+     * @group Types
+     */
+    interface TerminalConnectComponentsResult {
+        components: {
+            items?: TerminalConnectComponent[];
+        } & TerminalConnectError;
+    }
+    /**
+     * Result type for the `createLimitAlert` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectCreateAlertResult {
+        createLimitAlert: TerminalConnectAlert & TerminalConnectError;
+    }
+    /**
+     * Result type for the `createWorksheet` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectCreateWorksheetResult {
+        createWorksheet: TerminalConnectWorksheet & TerminalConnectError;
+    }
+    /**
+     * Result type for the `deleteAlert` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectDeleteAlertResult {
+        deleteAlert: {
+            successful?: boolean;
+        } & TerminalConnectError;
+    }
+    /**
+     * Entity type for a Terminal Connect operation error.
+     *
+     * @group Types
+     */
+    interface TerminalConnectError {
+        errorCategory?: 'AUTHORIZATION' | 'ERROR' | 'INVALID_INPUT' | 'RATE_LIMIT_EXCEEDED' | 'TIMEOUT';
+        errorMessage?: string;
+    }
+    /**
+     * Entity type for an individual Launchpad group.
+     *
+     * @group Types
+     */
+    interface TerminalConnectGroup {
+        id?: number;
+        name?: string;
+        type?: string;
         value: string;
-    };
-    type TerminalConnectGroupEvent = {
+    }
+    /**
+     * Result type for the `subscribeGroupEvents` subscription.
+     *
+     * @group Types
+     */
+    interface TerminalConnectGroupEvent {
         subscribeGroupEvents: {
-            group: Omit<TerminalConnectGroupItem, 'type'>;
-            type: TerminalConnectGroupEventType;
+            data?: string;
+            group?: TerminalConnectGroup;
+            type?: TerminalConnectGroupEventType;
         };
-    };
-    type TerminalConnectGroupsResult = {
+    }
+    /**
+     * Possible values for {@link TerminalConnectGroupEvent | group event} types.
+     *
+     * @group Types
+     */
+    type TerminalConnectGroupEventType = 'ANY' | 'CREATED' | 'DELETED' | 'RENAMED' | 'VALUE_CHANGED';
+    /**
+     * Result type for the `groups` query.
+     *
+     * @group Types
+     */
+    interface TerminalConnectGroupsResult {
         groups: {
-            items: TerminalConnectGroupItem[];
-        } | TerminalConnectErrorResult;
-    };
-    type TerminalConnectResponse<T = {
-        [key: string]: TerminalConnectResult | TerminalConnectErrorResult;
-    }> = {
-        data?: T;
-        errors?: {
-            locations: {
-                column: number;
-                line: number;
+            items?: TerminalConnectGroup[];
+        } & TerminalConnectError;
+    }
+    /**
+     * Result type for the `openInLaunchpad` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectOpenInLaunchpadResult {
+        openInLaunchpad: TerminalConnectComponent & TerminalConnectError;
+    }
+    /**
+     * Result type used for a number of different mutations.
+     *
+     * @group Types
+     */
+    interface TerminalConnectOperationResult {
+        details?: string;
+        succeeded?: boolean;
+    }
+    /**
+     * Entity type for paging info.
+     *
+     * @group Types
+     */
+    interface TerminalConnectPageInfo {
+        endCursor?: string;
+        hasNextPage?: boolean;
+        hasPreviousPage?: boolean;
+        startCursor?: string;
+    }
+    /**
+     * Result type for the `publishAlertEvent` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectPublishAlertEventResult {
+        publishAlertEvent: {
+            successful?: boolean;
+        } & TerminalConnectError;
+    }
+    /**
+     * Result type for the `removeSecuritiesFromWorksheet` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectRemoveSecuritiesFromWorksheetResult {
+        removeSecuritiesFromWorksheet: TerminalConnectWorksheet & TerminalConnectError;
+    }
+    /**
+     * Result type for the `replaceSecuritiesInWorksheet` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectReplaceSecuritiesInWorksheetResult {
+        replaceSecuritiesInWorksheet: TerminalConnectWorksheet & TerminalConnectError;
+    }
+    /**
+     * Result type for the `runFunctionInPanel` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectRunFunctionInPanelResult {
+        runFunctionInPanel: TerminalConnectOperationResult & TerminalConnectError;
+    }
+    /**
+     * Result type for the `runFunctionInTab` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectRunFunctionInTabResult {
+        runFunctionInTab: TerminalConnectOperationResult & TerminalConnectError;
+    }
+    /**
+     * Result type for the `securities` query.
+     *
+     * @group Types
+     */
+    interface TerminalConnectSecuritiesResult {
+        securities: {
+            edges?: {
+                cursor?: string;
+                node?: TerminalConnectSecurity;
             }[];
-            message: string;
+            itemCount?: number;
+            pageInfo?: TerminalConnectPageInfo;
+        } & TerminalConnectError;
+    }
+    /**
+     * Entity type for an individual security.
+     *
+     * @group Types
+     */
+    interface TerminalConnectSecurity {
+        id?: string;
+        name?: string;
+    }
+    /**
+     * Result type for the `setGroupValue` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectSetGroupValueResult {
+        setGroupValue: {
+            results?: TerminalConnectOperationResult[];
+        } & TerminalConnectError;
+    }
+    /**
+     * Result type for the `updateLimitAlert` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectUpdateAlertResult {
+        updateLimitAlert: TerminalConnectAlert & TerminalConnectError;
+    }
+    /**
+     * Result type for the `updateComponent` mutation.
+     *
+     * @group Types
+     */
+    interface TerminalConnectUpdateComponentResult {
+        updateComponent: TerminalConnectOperationResult & TerminalConnectError;
+    }
+    /**
+     * Entity type for an individual worksheet.
+     *
+     * @group Types
+     */
+    interface TerminalConnectWorksheet {
+        id?: string;
+        isOpen?: boolean;
+        name?: string;
+        securities: TerminalConnectWorksheetSecuritiesResult;
+    }
+    /**
+     * Result type for the collection of securities returned in a {@link TerminalConnectWorksheet | worksheet}.
+     *
+     * @group Types
+     */
+    interface TerminalConnectWorksheetSecuritiesResult {
+        edges?: {
+            cursor?: string;
+            node?: TerminalConnectWorksheetSecurity;
         }[];
-    };
-    type TerminalConnectResult = {
-        details?: string;
-        succeeded: boolean;
-    };
-    type TerminalConnectRunFunctionInPanelResult = {
-        runFunctionInPanel: TerminalConnectResult | TerminalConnectErrorResult;
-    };
-    type TerminalConnectRunFunctionInTabResult = {
-        runFunctionInTab: TerminalConnectResult | TerminalConnectErrorResult;
-    };
-    type TerminalConnectSetGroupValueResult = {
-        setGroupValue: {
-            results: TerminalConnectResult[];
-        } | TerminalConnectErrorResult;
-    };
+        itemCount?: number;
+        pageInfo?: TerminalConnectPageInfo;
+    }
+    /**
+     * Entity type for an individual worksheet security.
+     *
+     * @group Types
+     */
+    interface TerminalConnectWorksheetSecurity {
+        id?: string;
+    }
+    /**
+     * Result type for the `worksheets` and `worksheetsById` queries.
+     *
+     * @group Types
+     */
+    interface TerminalConnectWorksheetsResult {
+        worksheets: {
+            edges?: {
+                cursor?: string;
+                node?: TerminalConnectWorksheet;
+            }[];
+            itemCount?: number;
+            pageInfo?: TerminalConnectPageInfo;
+        } & TerminalConnectError;
+    }
 }

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

74082

increased by20.9%

Lines of code

811

increased by94.02%

No dependency changes