@openfin/workspace-platform 18.1.5 → 18.1.6

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

@@ -1,4 +1,5 @@
 import type OpenFin from '@openfin/core';
 import { NotificationsCustomManifestOptions } from '../../../../common/src/api/shapes/notifications';
 import { BrowserInitConfig, WorkspacePlatformOverrideCallback, WorkspacePlatformProvider } from '../../../../client-api-platform/src/shapes';
-export declare const getOverrideCallback: (browserInitOptions: BrowserInitConfig | null, overrideCallback?: WorkspacePlatformOverrideCallback, notificationsConfig?: NotificationsCustomManifestOptions) => OpenFin.OverrideCallback<WorkspacePlatformProvider>;
+export declare const getConstructorOverride: (browserInitOptions: BrowserInitConfig | null, notificationsConfig?: NotificationsCustomManifestOptions) => OpenFin.ConstructorOverride<WorkspacePlatformProvider>;
+export declare function getOverrideCallback(browserInitOptions: BrowserInitConfig | null, overrideCallback?: WorkspacePlatformOverrideCallback | OpenFin.ConstructorOverride<WorkspacePlatformProvider>[], notificationsConfig?: NotificationsCustomManifestOptions): WorkspacePlatformOverrideCallback | OpenFin.ConstructorOverride<WorkspacePlatformProvider>[];

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

@@ -32,11 +32,44 @@ export interface UpdateSavedPageRequest {
     /** The updated page. */
     page: Page;
 }
+export declare enum PageChangeEventType {
+    UrlChange = "URL_CHANGE",
+    ViewAdded = "VIEW_ADDED",
+    ViewRemoved = "VIEW_REMOVED",
+    PageContextAdded = "PAGE_CONTEXT_ADDED",
+    PageContextRemoved = "PAGE_CONTEXT_REMOVED"
+}
+export type PageChangeEventDetails = UrlChangeDetails | ViewAddedDetails | ViewRemovedDetails | PageContextRemovedDetails | PageContextAddedDetails;
+export interface PageContextRemovedDetails {
+    type: PageChangeEventType.PageContextRemoved;
+    viewIdentity: OpenFin.Identity;
+}
+export interface PageContextAddedDetails {
+    type: PageChangeEventType.PageContextAdded;
+    viewIdentity: OpenFin.Identity;
+    contextId: string;
+}
+export interface UrlChangeDetails {
+    type: PageChangeEventType.UrlChange;
+    viewIdentity: OpenFin.Identity;
+    urlBefore: string;
+    urlAfter: string;
+}
+export interface ViewAddedDetails {
+    type: PageChangeEventType.ViewAdded;
+    viewIdentity: OpenFin.Identity;
+}
+export interface ViewRemovedDetails {
+    type: PageChangeEventType.ViewRemoved;
+    viewIdentity: OpenFin.Identity;
+}
 export interface HandlePageChangesPayload {
     /** The page with new changes. */
     page: AttachedPage;
     /** The OF window identity containing the page. */
     identity: OpenFin.Identity;
+    /** Additional details about the page change event. */
+    eventDetails?: PageChangeEventDetails;
 }
 export interface ModifiedPageState {
     hasUnsavedChanges?: boolean;
@@ -1808,7 +1841,7 @@ export interface WorkspacePlatformInitConfig {
     /**
      * Override workspace platform behavior
      */
-    overrideCallback?: WorkspacePlatformOverrideCallback;
+    overrideCallback?: WorkspacePlatformOverrideCallback | OpenFin.ConstructorOverride<WorkspacePlatformProvider>[];
     /**
      * Override workspace platform interop behavior
      * https://developer.openfin.co/docs/javascript/stable/classes/OpenFin.InteropBroker.html

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

@@ -3,7 +3,7 @@ export declare enum InteropEventType {
     JoinedContextGroup = "joined-context-group",
     RemovedFromContextGroup = "removed-from-context-group"
 }
-export type InteropListener = (identity: OpenFin.Identity) => void;
+export type InteropListener = (identity: OpenFin.Identity, contextGroupId: string) => void;
 /**
  * Returns contextGroup data.
  * @returns Promise<ContextGroup[]>