@openfin/workspace 14.1.0 → 14.1.2

package/README.md

@@ -4,8 +4,8 @@ The Workspace Client APIs enable custom integrations with OpenFin Workspace.
 
 ## Prerequisites
 
-- [Node.js](https://nodejs.org/en/) v16.0.0 or higher
-- [npm](https://www.npmjs.com/)
+-   [Node.js](https://nodejs.org/en/) v16.0.0 or higher
+-   [npm](https://www.npmjs.com/)
 
 ## Install
 
@@ -27,8 +27,8 @@ Prior to using Workspace, a Workspace Platform must be initialized.
 
 ### Home API
 
-- [Overview](https://developers.openfin.co/of-docs/docs/cli-providers)
-- [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/home.html)
+-   [Overview](https://developers.openfin.co/of-docs/docs/cli-providers)
+-   [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/home.html)
 
 ```ts
 import Home, CLIProvider from '@openfin/workspace';
@@ -64,8 +64,8 @@ searchButton.addEventListener('click', () => {
 
 ### Storefront API
 
-- [Overview](https://developers.openfin.co/of-docs/docs/provide-storefront-content)
-- [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/store.html)
+-   [Overview](https://developers.openfin.co/of-docs/docs/provide-storefront-content)
+-   [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/store.html)
 
 ```ts
 import { Storefront, StorefrontProvider } from "@openfin/workspace";
@@ -97,8 +97,8 @@ await Storefront.show();
 
 ### Dock API
 
-- [Overview](https://developers.openfin.co/of-docs/docs/dock-overview)
-- [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/dock.html)
+-   [Overview](https://developers.openfin.co/of-docs/docs/dock-overview)
+-   [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/dock.html)
 
 ```ts
 const provider: DockProvider = {
@@ -154,7 +154,7 @@ await Dock.show();
 
 ## For more information
 
-- [Developer guide](https://developers.openfin.co/of-docs/docs/overview-of-workspace).
-- [API reference](https://developer.openfin.co/workspace/docs/api/latest/index.html).
-- See the [workspace-starter](https://github.com/built-on-openfin/workspace-starter) project for example code.
-- See the [versions page](https://developer.openfin.co/versions/#/?product=Workspace) for a list of all available versions.
+-   [Developer guide](https://developers.openfin.co/of-docs/docs/overview-of-workspace).
+-   [API reference](https://developer.openfin.co/workspace/docs/api/latest/index.html).
+-   See the [workspace-starter](https://github.com/built-on-openfin/workspace-starter) project for example code.
+-   See the [versions page](https://developer.openfin.co/versions/#/?product=Workspace) for a list of all available versions.

package/client-api/src/dock.d.ts

@@ -1,5 +1,5 @@
 import type { DockProvider } from './shapes/dock';
-import { DockProviderRegistration } from './shapes/dock';
+import { type DockProviderRegistration } from './shapes/dock';
 export * from './shapes/dock';
 /**
  * API function to register a Dock provider.

package/client-api/src/internal/home/handlers/index.d.ts

@@ -1,5 +1,6 @@
+import { withDisconnectListener } from '../../../../../common/src/utils/channels';
 import { SearchAPIClientChannelClient } from '../../../../../common/src/api/protocol/shapes/search';
-type HomeWorkspaceAPIClientChannelClient = SearchAPIClientChannelClient & {
+type HomeWorkspaceAPIClientChannelClient = withDisconnectListener<SearchAPIClientChannelClient> & {
     homeChannelActionsRegistered?: boolean;
 };
 export declare function registerHomeChannelClientActions(channel: HomeWorkspaceAPIClientChannelClient): void;

package/client-api/src/notifications.d.ts

@@ -1,12 +1,12 @@
-import type { NotificationsPlatform, NotificationsRegistration } from './shapes/notifications';
-export * from 'openfin-notifications';
+import * as Notifications from 'openfin-notifications/dist/client/without-auto-launch';
+import type { NotificationsPlatform, NotificationsRegisterOptions } from './shapes/notifications';
+export * from 'openfin-notifications/dist/client/without-auto-launch';
 export * from './shapes/notifications';
 /**
- * Registers notifications platform. Throws if workspace platform is not initialized or if you run version of notifications-service which doesn't support platforms.
- *
- * @param platform {@link NotificationsPlatform} object
+ * @deprecated
  */
-export declare const register: (platform: NotificationsPlatform) => Promise<NotificationsRegistration>;
+export declare function register(platform?: NotificationsPlatform): Promise<Notifications.NotificationsRegistration>;
+export declare function register(platform?: NotificationsRegisterOptions): Promise<Notifications.NotificationsRegistration>;
 /**
  * Deregisters notifications platform. Throws if you run version of notifications-service which doesn't support platforms.
  * @param platformId id of the platform to deregister

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

@@ -1,7 +1,6 @@
 /**
  * This module exports only notifications types that are not defined in 'openfin-notifications' npm package
  */
-import type { NotificationPlatform as NotificationsPlatformInternal } from 'openfin-notifications';
 /**
  * Platform object to pass to `register` function.
  *
@@ -17,11 +16,24 @@ import type { NotificationPlatform as NotificationsPlatformInternal } from 'open
  * await register(platform);
  * ```
  */
-export type NotificationsPlatform = Omit<NotificationsPlatformInternal, 'theme'>;
-/**
- * Registration meta info returned by {@link register}
- */
-export type NotificationsRegistration = {
-    clientAPIVersion: string;
-    notificationsVersion: string;
-};
+export interface NotificationsPlatform {
+    /**
+     * Unique identifier of the platform.
+     */
+    id: string;
+    /**
+     * Stream title.
+     *
+     * Providing a different displayName for an existing stream id will update the
+     * displayName of the stream stored in Notification Center.
+     *
+     */
+    title: string;
+    /**
+     * URL of the icon to be displayed for this platform.
+     */
+    icon: string;
+}
+export interface NotificationsRegisterOptions {
+    notificationsPlatformOptions?: NotificationsPlatform;
+}

package/client-api-platform/src/init/browser-base-url.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Get the browser base url override if it exists
+ *
+ * @returns The browser base url override if it exists, otherwise null
+ */
+export declare function getBrowserBaseUrl(): Promise<string | null>;

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

@@ -1525,6 +1525,8 @@ export interface WorkspacePlatformInitConfig {
     /**
      * Customize the Looks and Feel of the Workspace Platform by providing a custom palette.
      *
+     * The `backgroundPrimary` color **must** be either a hex, rgb, rgba, hsl, or hsla value.
+     *
      * Two palettes are provided by default: `light` and `dark`.
      * The `dark` palette is used by default.
      *

package/common/src/api/overrides.d.ts

@@ -14,6 +14,7 @@ export interface Overrides {
         [key: string]: boolean;
     };
     disableRuntimeValidation: boolean;
+    browserBaseUrl: string;
     disableOpenFinAnalytics: boolean;
     analyticsEndpoint: string;
 }

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

@@ -1,7 +1,7 @@
 import type OpenFin from '@openfin/core';
 export declare const getWindowChannelId: (identity: OpenFin.Identity) => string;
 export interface ChannelClient extends OpenFin.ChannelClient {
-    dispatch: (action: typeof BrowserChannelAction[keyof BrowserChannelAction], payload?: any) => Promise<any>;
+    dispatch: (action: (typeof BrowserChannelAction)[keyof BrowserChannelAction], payload?: any) => Promise<any>;
 }
 export declare const getChannelClient: (identity: OpenFin.Identity) => Promise<ChannelClient>;
 /**
@@ -29,7 +29,8 @@ declare enum GeneralBrowserChannelActions {
     RemoveFromChannel = "remove-from-channel",
     OpenSaveModalInternal = "open-save-modal-internal",
     DuplicatePage = "duplicate-page",
-    SetSelectedScheme = "set-selected-scheme"
+    SetSelectedScheme = "set-selected-scheme",
+    ShowBrowserIndicator = "show-browser-indicator"
 }
 /**
  * All of the remote procedures that can be called in the
@@ -68,6 +69,7 @@ export declare const BrowserChannelAction: {
     OpenSaveModalInternal: GeneralBrowserChannelActions.OpenSaveModalInternal;
     DuplicatePage: GeneralBrowserChannelActions.DuplicatePage;
     SetSelectedScheme: GeneralBrowserChannelActions.SetSelectedScheme;
+    ShowBrowserIndicator: GeneralBrowserChannelActions.ShowBrowserIndicator;
 };
 export type BrowserChannelAction = typeof BrowserChannelAction;
 export {};

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

@@ -1,3 +1,4 @@
+import { withDisconnectListener } from '../../../../common/src/utils/channels';
 import { SearchAPIClientChannelClient } from '../../../../common/src/api/protocol/shapes/search';
 import type { WorkspaceAPIClientChannelClient, WorkspaceChannelProvider, WorkspaceComponentChannelClient } from './shapes/workspace';
 export type { WorkspaceAPIClientChannelClient, WorkspaceComponentChannelClient, WorkspaceChannelProvider };
@@ -5,7 +6,7 @@ export type { WorkspaceAPIClientChannelClient, WorkspaceComponentChannelClient,
 export declare const channelName: "__of_workspace_protocol__";
 export declare const getChannelClient: () => Promise<WorkspaceComponentChannelClient>;
 export declare const getClientAPIChannelClient: () => Promise<WorkspaceAPIClientChannelClient>;
-export declare const getSearchClientAPIChannelClient: () => Promise<SearchAPIClientChannelClient>;
+export declare const getSearchClientAPIChannelClient: () => Promise<withDisconnectListener<SearchAPIClientChannelClient>>;
 /**
  * Launches the Workspace Provider.
  * If the Workspace Provider is already running, does nothing.

package/common/src/api/search/common.d.ts

@@ -6,7 +6,7 @@ export interface InternalSearchListenerResponse {
     getRevokedBuffer(): string[];
     setRevokedBuffer(resultIds: string[]): void;
     getUpdatedContext(): any;
-    setUpdatedContext(context: any): void;
+    setUpdatedContext(context: any | null): void;
     onChange(): void;
     getStatus(): InternalSearchListenerResponseStatus;
     res: HomeSearchListenerResponse;

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

@@ -1,4 +1,7 @@
 import type OpenFin from '@openfin/core';
+export type withDisconnectListener<T> = T & {
+    addDisconnectionListener: (listener: () => void) => void;
+};
 /**
  * Make a function that connects to a channel.
  * If already connected to the channel, will return the channel connection.
@@ -6,4 +9,4 @@ import type OpenFin from '@openfin/core';
  * @param channelName the name of the channel to connect to.
  * @returns the function to connect to the channel.
  */
-export default function makeGetChannelClient(channelName: string): () => Promise<OpenFin.ChannelClient>;
+export default function makeGetChannelClient(channelName: string): () => Promise<withDisconnectListener<OpenFin.ChannelClient>>;

package/common/src/utils/indicators/browser.d.ts

@@ -1,16 +1,27 @@
+import { IndicatorType } from '../../../../common/src/components/Indicator/Indicator.constants';
 export declare enum BrowserIndicatorIcon {
     Locked = "LockClosedIcon",
     Unlocked = "LockOpen1Icon"
 }
+export interface ShowBrowserIndicatorPayload {
+    type: IndicatorType;
+    message: string;
+    parentBrowserName?: string;
+    icon?: BrowserIndicatorIcon;
+}
+/**
+ * Creates a window containing a visual indicator
+ */
+export declare function showBrowserIndicator(type: IndicatorType, message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<any>;
 /**
  * Creates a window containing an error indicator
  */
-export declare function showBrowserError(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<void>;
+export declare function showBrowserError(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<any>;
 /**
  * Creates a window containing a success indicator
  */
-export declare function showBrowserSuccess(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<void>;
+export declare function showBrowserSuccess(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<any>;
 /**
  * Creates a window containing an info indicator
  */
-export declare function showBrowserInfo(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<void>;
+export declare function showBrowserInfo(message: string, parentBrowserName?: string, icon?: BrowserIndicatorIcon): Promise<any>;

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

@@ -0,0 +1,18 @@
+type WorkspacePerformanceMarks = 'home-registration' | 'dock-registration' | 'store-registration';
+/**
+ * @classdesc
+ * WorkspacePerformance is a class that provides a set of methods to measure performance of workspace
+ *
+ */
+declare class WorkspacePerformance {
+    markStart(markName: WorkspacePerformanceMarks): void;
+    markEnd(markName: WorkspacePerformanceMarks): void;
+    markEndAndMeasure(markName: WorkspacePerformanceMarks): void;
+    reportWorkspacePerformanceEntries(): PerformanceEntry[];
+    reportWorkspacePerformance(): {
+        name: string;
+        duration: number;
+    }[];
+}
+declare const workspacePerformance: WorkspacePerformance;
+export default workspacePerformance;