@openfin/workspace 22.5.0 → 22.5.1

package/client-api-platform/src/init/override-callback/dialogs.d.ts

@@ -1,4 +1,5 @@
 import type OpenFin from '@openfin/core';
-import { ShowQuitPlatformDialogRequest, ShowUpdateVersionModalRequest } from '../../../../client-api-platform/src/shapes';
+import { IntentResolverResponse, ShowIntentsResolverModalRequest, ShowQuitPlatformDialogRequest, ShowUpdateVersionModalRequest } from '../../../../client-api-platform/src/shapes';
 export declare const showQuitPlatformDialogInternal: (req: ShowQuitPlatformDialogRequest, identity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<void>;
 export declare const showUpdateVersionModalInternal: (req: ShowUpdateVersionModalRequest, identity: OpenFin.ProviderIdentity | OpenFin.ClientIdentity) => Promise<void>;
+export declare const showIntentsResolverModalInternal: (req: ShowIntentsResolverModalRequest) => Promise<IntentResolverResponse>;

package/client-api-platform/src/shapes.d.ts

@@ -2928,3 +2928,104 @@ export type AboutPageConfig = {
     rvmVersion: string;
     copyrightMessage?: string;
 };
+/**
+ * FDC3 2.0 Context object -> https://fdc3.finos.org/docs/context/spec
+ * @internal
+ */
+export interface FDC3Context {
+    type: string;
+    name?: string;
+    id?: Record<string, string>;
+    [key: string]: any;
+}
+/**
+ * Application instance information for intent resolution -> https://fdc3.finos.org/docs/api/ref/Types
+ * @internal
+ */
+export interface AppInstance {
+    /** Unique identifier for this instance */
+    instanceId: string;
+    /** Display name for this instance */
+    instanceName: string;
+    /** Whether this is a new instance that would be created */
+    isNewInstance?: boolean;
+    /** Icon URL for the instance */
+    icon?: string;
+}
+/**
+ * Application metadata for intent resolution
+ * @internal
+ */
+export interface IntentResolverApp {
+    /** Application identifier */
+    appId: string;
+    /** Display name of the application */
+    name: string;
+    /** Optional tooltip or description */
+    tooltip?: string;
+    /** Icon URL for the application */
+    icon?: string;
+    /** Available instances of this application */
+    instances?: AppInstance[];
+}
+/**
+ * Intent information for resolution
+ * @internal
+ */
+export interface IntentResolverIntent {
+    /** Intent name -> ViewContact, StartCall */
+    name: string;
+    /** Display name for the intent -> View Contact, Start a Call, Start a Chat */
+    displayName: string;
+}
+/**
+ * Response from the intents resolver modal
+ * @internal
+ */
+export type IntentResolverResponse = {
+    /** Returned when user selects desired intent destination and presses Open */
+    type: 'open';
+    data: {
+        /** Selected application ID */
+        appId?: string;
+        /** Selected instance ID */
+        instanceId?: string;
+        /** Selected intent name */
+        intentName?: string;
+        /** Whether user chose to remember this selection */
+        rememberSelection?: boolean;
+        /** Whether user cancelled the selection */
+        cancelled?: boolean;
+    };
+} | {
+    /** Returned when user cancels the modal or modal timeout */
+    type: 'cancel';
+} | {
+    /** Returned when there are no open browser windows */
+    type: 'no-target-available';
+};
+/**
+ * Payload for showing the intents resolver modal
+ * @internal
+ */
+export interface ShowIntentsResolverModalRequest {
+    /** The title for the intents resolver modal */
+    title: string;
+    /** Available applications that can handle the intent */
+    apps: IntentResolverApp[];
+    /** Available intents (if multiple intents are possible) */
+    intents?: IntentResolverIntent[];
+    /** The context data being passed */
+    context?: FDC3Context;
+    /** Timeout in milliseconds for user interaction (default: 45000) */
+    timeoutMs?: number;
+    /** Pre-selected values */
+    preselected?: {
+        appId?: string;
+        intentName?: string;
+        instanceId?: string;
+    };
+}
+export interface ShowIntentsResolverModalRequestInternal extends ShowIntentsResolverModalRequest {
+    identity: OpenFin.Identity;
+}

package/common/src/api/protocol/browser.d.ts

@@ -83,7 +83,8 @@ export declare enum CompanionDockChannelAction {
  * @internal
  */
 export declare enum EnterpriseRequestModalChannelAction {
-    SendUpdateVersionModalResponse = "send-update-version-modal-response"
+    SendUpdateVersionModalResponse = "send-update-version-modal-response",
+    SendIntentResolverModalResponse = "send-intent-resolver-modal-response"
 }
 export declare const BrowserChannelAction: {
     UpdateFavoriteEntries: CompanionDockChannelAction.UpdateFavoriteEntries;

package/common/src/utils/modal-bounds.d.ts

@@ -16,8 +16,8 @@ export declare const getCenterOfParentWindowMonitor: (parentWindowIdentity?: Ope
  * @param centerOnMonitor whether the modal should be centered on the monitor
  * @returns the bounds for where the modal is to be displayed
  */
-export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
-export declare function getResponseModalBoundsAndCenterParentIfModalOffScreen(modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean): Promise<OpenFin.Bounds>;
+export declare const getResponseModalBounds: (modalOptions: Pick<ResponseModalConfig['windowOptions'], 'defaultWidth' | 'defaultHeight'>, parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
+export declare function getResponseModalBoundsAndCenterParentIfModalOffScreen(modalOptions: Parameters<typeof getResponseModalBounds>[0], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean, relativeBounds?: boolean): Promise<OpenFin.Bounds>;
 /**
  * Adjusts the given bounds to be within the closest monitor's available bounds if they are offscreen.
  *

package/common/src/utils/modal-constants.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Constants for modal timeouts and configuration
+ */
+/**
+ * Default timeout for intents resolver modal in milliseconds
+ * Set to 45 seconds to allow sufficient time for user selection
+ */
+export declare const INTENTS_RESOLVER_MODAL_TIMEOUT_MS = 45000;

package/common/src/utils/route.d.ts

@@ -32,7 +32,8 @@ declare enum BrowserRoute {
     DropdownMenu = "/dropdown-menu/",
     EnterpriseDock = "/dock/",
     ZoomControlsDialog = "/zoom-controls-dialog/",
-    DesktopSignalsModal = "/popup-menu/desktop-signals-modal/"
+    DesktopSignalsModal = "/popup-menu/desktop-signals-modal/",
+    IntentsResolverModal = "/popup-menu/intents-resolver-modal/"
 }
 declare const PageRoute: {
     Browser: BrowserRoute.Browser;
@@ -53,6 +54,7 @@ declare const PageRoute: {
     EnterpriseDock: BrowserRoute.EnterpriseDock;
     ZoomControlsDialog: BrowserRoute.ZoomControlsDialog;
     DesktopSignalsModal: BrowserRoute.DesktopSignalsModal;
+    IntentsResolverModal: BrowserRoute.IntentsResolverModal;
     Home: WorkspaceRoute.Home;
     HomeSearch: WorkspaceRoute.HomeSearch;
     HomePagesRename: WorkspaceRoute.HomePagesRename;

package/common/src/utils/window.d.ts

@@ -20,7 +20,8 @@ export declare enum WindowName {
     UpdateVersionModal = "here-update-version-modal",
     ZoomControlsDialog = "here-zoom-controls-dialog",
     AboutPageWindow = "here-about-page",
-    DesktopSignalsModal = "here-desktop-signals-modal"
+    DesktopSignalsModal = "here-desktop-signals-modal",
+    IntentsResolverModal = "here-intents-resolver-modal"
 }
 export interface WindowIdentity {
     uuid: ApplicationUUID | string;

package/common/src/utils/workspace-modals.d.ts

@@ -1,5 +1,6 @@
 import type OpenFin from '@openfin/core';
 import { ResponseModalConfig } from '../../../common/src/utils/menu-config';
+import { IntentResolverResponse, ShowIntentsResolverModalRequestInternal } from '../../../client-api-platform/src/shapes';
 import { ModalResponseEvent } from './menu-window-provider';
 export type DeleteWorkspaceMenuPayload = {
     workspaceTitle: string;
@@ -33,3 +34,9 @@ export declare const showUpdateVersionModal: ({ identity, title, description }:
     title: string;
     description: string;
 }) => Promise<ModalResponseEvent['data']>;
+/**
+ * Shows the intents resolver modal and returns the user's selection
+ * @param request - The request containing modal configuration
+ * @returns Promise resolving to the user's intent resolution response
+ */
+export declare const showIntentsResolverModal: (request: ShowIntentsResolverModalRequestInternal) => Promise<IntentResolverResponse>;

package/externals.report.json

@@ -5,6 +5,14 @@
             "issuer": "client-api/src/notifications.ts"
         }
     ],
+    "@openfin/microsoft365": [
+        {
+            "type": "explicit",
+            "version": "^1.0.1",
+            "packageName": "client-api/package.json",
+            "issuer": "client-api/src/integrations/microsoft.ts"
+        }
+    ],
     "title-case": [
         {
             "type": "explicit",
@@ -19,14 +27,6 @@
             "issuer": "common/src/utils/color-linking.ts"
         }
     ],
-    "@openfin/microsoft365": [
-        {
-            "type": "explicit",
-            "version": "^1.0.1",
-            "packageName": "client-api/package.json",
-            "issuer": "client-api/src/integrations/microsoft.ts"
-        }
-    ],
     "lodash.debounce": [
         {
             "type": "explicit",
@@ -74,13 +74,13 @@
             "type": "root-implicit",
             "version": "^4.0.11",
             "packageName": "common/package.json",
-            "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
+            "issuer": "common/src/api/pages/idb.ts"
         },
         {
             "type": "root-implicit",
             "version": "^4.0.11",
             "packageName": "common/package.json",
-            "issuer": "common/src/api/pages/idb.ts"
+            "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
         }
     ]
 }