@openfin/workspace-platform 17.0.12 → 17.2.0

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

@@ -1,3 +1,4 @@
 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) => OpenFin.OverrideCallback<WorkspacePlatformProvider>;
+export declare const getOverrideCallback: (browserInitOptions: BrowserInitConfig | null, overrideCallback?: WorkspacePlatformOverrideCallback, notificationsConfig?: NotificationsCustomManifestOptions) => OpenFin.OverrideCallback<WorkspacePlatformProvider>;

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

@@ -4,6 +4,7 @@ import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/ut
 import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import type { AttachedPage, CopyPagePayload, HandleSaveModalOnPageClosePayload, Page, PageWithUpdatableRuntimeAttribs, SaveModalOnPageCloseResult } from '../../common/src/api/pages/shapes';
 import { SetActivePageForWindowPayload } from '../../common/src/api/pages/shapes';
+import { NotificationsCustomManifestOptions } from '../../common/src/api/shapes/notifications';
 import type { CustomThemes } from '../../common/src/api/theming';
 import type { App, DockProviderConfigWithIdentity, StoreButtonConfig } from '../../client-api/src/shapes';
 import type { WorkflowIntegration } from '../../client-api/src/shapes/integrations';
@@ -1361,6 +1362,10 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * ```
      */
     applyWorkspace(workspace: Workspace, options?: ApplyWorkspaceOptions): Promise<boolean>;
+    /**
+     * Implementation for getting the notifications workspace platform configuration.
+     */
+    getNotificationsConfig(): Promise<NotificationsCustomManifestOptions | undefined>;
     /**
      * The browser window factory for the Workspace Platform.
      */
@@ -1704,6 +1709,11 @@ export interface WorkspacePlatformInitConfig {
      * ```
      */
     integrations?: WorkflowIntegration[];
+    /**
+     * Config for overriding default notifications behaviour.
+     * Leave undefined to use OpenFin hosted Notification Center.
+     */
+    notifications?: NotificationsCustomManifestOptions;
 }
 /**
  * Extend or replace default functionality in order to customize behavior of a Workspace Platform Provider.

package/common/src/api/protocol/workspace-platform.d.ts

@@ -55,7 +55,8 @@ export declare enum WorkspacePlatformChannelAction {
     SaveDockProviderConfig = "saveDockProviderConfig",
     HandleSaveModalOnPageClose = "handleSaveModalOnPageClose",
     CopyPage = "copyPage",
-    HandlePageChanges = "handlePageChanges"
+    HandlePageChanges = "handlePageChanges",
+    GetNotificationsConfig = "getNotificationsConfig"
 }
 export type PlatFormSupportedFeatures = boolean | {
     isWorkspacePlatform: boolean;

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

@@ -0,0 +1,15 @@
+/**
+ * Options for using privately hosted notification service.
+ */
+export type NotificationsCustomManifestOptions = {
+    /**
+     * A custom manifest location to start the notification service from.
+     * The UUID cannot be OpenFin hosted Notification Service UUID, 'notifications-service'.
+     */
+    manifestUrl: string;
+    /**
+     * The UUID of the provided custom notifications service manifest.
+     * This value **MUST** match the UUID of the manifest provided in `manifestUrl`.
+     */
+    manifestUuid: string;
+};

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

@@ -62,8 +62,6 @@ export declare const mapContentComponentState: (content: OpenFin.LayoutContent)
 export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
 export declare const isLayoutTabActive: (tabSelector: string) => boolean;
 export declare const containerId = "layout_container";
-export declare const getViewComponents: () => OpenFin.LayoutContent;
-export declare const removeLayoutView: (name: string) => Promise<void>;
 export declare const addLayoutEventListener: (event: LayoutDOMEventType, listener: LayoutDOMEventListener) => void;
 /**
  * Initialize the layout for the current OF window.