@openfin/workspace 45.4.8 → 45.4.9

package/client-api-platform/src/api/app-directory.d.ts

@@ -7,7 +7,7 @@ import type { ContentSortRequest, LaunchAppRequest, SearchSitesRequest, SearchSi
  * @param app the app directory entry.
  * @param opts launch options.
  */
-export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.Platform | OpenFin.View | OpenFin.Application>;
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.View | OpenFin.Identity | OpenFin.Platform | OpenFin.Application>;
 export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
 export declare function getResults(payload: {
     req: SearchSitesRequest;

package/client-api-platform/src/api/context-menu/utils.d.ts

@@ -1,5 +1,6 @@
 import type OpenFin from '@openfin/core';
 import { PositioningType } from '../../../../common/src/utils/positioning';
+import type { PageCreationOrigin } from '../../../../common/src/api/pages/shapes';
 import { WorkspaceContextMenuItemData } from '../../../../client-api-platform/src/shapes';
 export declare const saveWorkspaceHandlerWithInjectables: ({ showModal, afterSuccessSave }: {
     showModal?: () => Promise<void>;
@@ -9,8 +10,9 @@ export declare const saveWorkspaceHandler: (identity: OpenFin.Identity) => Promi
 export declare const saveWorkspaceAsHandler: (identity: OpenFin.Identity) => void;
 /**
  * @param identity Identity of browser window to create a new page on.
+ * @param origin User interaction that requested the page. Menu callers omit this.
  */
-export declare const createNewPageHandler: (identity: OpenFin.Identity) => Promise<void>;
+export declare const createNewPageHandler: (identity: OpenFin.Identity, origin?: PageCreationOrigin) => Promise<void>;
 export declare const createNewWindowHandler: (identity: OpenFin.Identity) => Promise<void>;
 /**
  * @param identity Identity of browser window to execute save on.

package/common/src/api/pages/shapes.d.ts

@@ -267,11 +267,15 @@ export interface CopyPagePayload {
     /** Specifies the trigger for creating a copy. */
     reason: 'save-as' | 'duplicate';
 }
+/** The user interaction that created a new page. Reported in the `Create Page` analytics event. */
+export type PageCreationOrigin = 'new-tab-button' | 'menu' | 'hotkey' | 'dock' | 'new-window';
 export type AddDefaultPagePayload = {
     /** The OF window identity to attach the pages to. */
     identity: OpenFin.Identity;
     /** The page to attach. */
     page: PageWithUpdatableRuntimeAttribs;
+    /** The user interaction that requested the page. */
+    origin?: PageCreationOrigin;
 };
 export type AddPagePayload = {
     /** The OF window identity to attach the pages to. */

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

@@ -11,7 +11,7 @@ export declare const isDocumentDefined: boolean;
 export declare const isWindowDefinedWithIndexDB: boolean;
 export declare const finUUID: string;
 export declare const finName: string;
-export declare const finEntityType: "" | "view" | "window";
+export declare const finEntityType: "" | "window" | "view";
 export declare const isEnvLocal: boolean;
 export declare const isEnvDev: boolean;
 export declare const isEnvStaging: boolean;

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

@@ -0,0 +1,30 @@
+import type OpenFin from '@openfin/core';
+export declare enum InteropEventType {
+    JoinedContextGroup = "joined-context-group",
+    RemovedFromContextGroup = "removed-from-context-group"
+}
+type InteropEventPayload<E extends InteropEventType> = {
+    [InteropEventType.JoinedContextGroup]: {
+        viewIdentity: OpenFin.Identity;
+        contextGroupId: string;
+    };
+    [InteropEventType.RemovedFromContextGroup]: {
+        viewIdentity: OpenFin.Identity;
+    };
+}[E];
+export type InteropListener<EventType extends InteropEventType> = (payload: InteropEventPayload<EventType>) => void;
+/**
+ * Returns contextGroup data.
+ * @returns Promise<ContextGroup[]>
+ */
+export declare function getContextGroups(): Promise<OpenFin.ContextGroupInfo[]>;
+export declare const joinContextGroup: (viewIdentity: OpenFin.Identity, contextGroupId: string) => Promise<void>;
+export declare const removeFromGroup: (viewIdentity: OpenFin.Identity) => Promise<void>;
+export declare function getViewContextGroupId(viewIdentity: OpenFin.Identity): Promise<string | null | undefined>;
+/**
+ * Listen for interop events.
+ * @param event the interop event to listen for.
+ * @param listener the function to call when the event occurs.
+ */
+export declare const addInteropListener: <Event extends InteropEventType>(event: Event, listener: InteropListener<Event>) => Promise<void>;
+export {};

package/common/src/utils/usage-register.d.ts

@@ -1,4 +1,5 @@
 import type OpenFin from '@openfin/core';
+import type { Page, PageCreationOrigin } from '../../../common/src/api/pages/shapes';
 import { AttachedPage } from '../../../client-api-platform/src/shapes';
 export interface RegisterUsageStatus {
     apiVersion?: string;
@@ -63,6 +64,10 @@ export interface AnalyticsEventInternal extends AnalyticsEvent {
 export type AnalyticsEventRaise = Omit<AnalyticsEventInternal, 'source'>;
 export declare const raiseBrowserAnalytics: (payload: AnalyticsEventRaise) => Promise<void>;
 export declare const raiseBrowserPageAnalytics: (pages: AttachedPage[], action: string) => Promise<void>;
+/**
+ * Raised when a new page ID is minted, as opposed to `Open Page`, which also fires for restored pages.
+ */
+export declare const raiseCreatePageAnalytics: (page: Pick<Page, "pageId" | "title">, windowName: string, origin?: PageCreationOrigin) => Promise<void>;
 export declare const raiseHomeAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventRaise) => Promise<void>;
 export declare const raiseDockAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventRaise) => Promise<void>;
 export declare const raiseStorefrontAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventRaise) => Promise<void>;

package/externals.report.json

@@ -2,7 +2,7 @@
     "@openfin/notifications": [
         {
             "type": "explicit",
-            "version": "45.4.0-alpha-5165",
+            "version": "45.4.0-alpha-5168",
             "packageName": "client-api/package.json",
             "issuer": "client-api/src/notifications.ts"
         }
@@ -22,6 +22,12 @@
             "packageName": "client-api/package.json",
             "issuer": "client-api/src/internal/providers.ts"
         },
+        {
+            "type": "explicit",
+            "version": "3.0.3",
+            "packageName": "client-api-platform/package.json",
+            "issuer": "client-api-platform/src/api/context-menu/browser-pagetab-handler.ts"
+        },
         {
             "type": "explicit",
             "version": "3.0.3",
@@ -76,18 +82,18 @@
         }
     ],
     "dexie": [
-        {
-            "type": "root-implicit",
-            "version": "^4.0.11",
-            "packageName": "dock3/package.json",
-            "issuer": "dock3/src/api/idb.ts"
-        },
         {
             "type": "explicit",
             "version": "^4.0.11",
             "packageName": "common/package.json",
             "issuer": "common/src/api/pages/idb.ts"
         },
+        {
+            "type": "root-implicit",
+            "version": "^4.0.11",
+            "packageName": "dock3/package.json",
+            "issuer": "dock3/src/api/idb.ts"
+        },
         {
             "type": "explicit",
             "version": "^4.0.11",