@openfin/workspace 10.2.4 → 10.3.0

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

@@ -1,23 +1,46 @@
 import type { ThemePaletteSet } from '@openfin/ui-library';
+import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
 export interface ComputedThemes extends Array<ComputedTheme> {
 }
 export interface ComputedTheme {
     label: string;
     logoUrl?: string;
     theme: ThemePaletteSet;
+    defaultScheme?: ColorSchemeOptionType;
 }
-export interface CustomThemes extends Array<CustomThemeOptions> {
-}
-export interface CustomThemeOptions {
+interface BaseThemeOptions {
     label: string;
     logoUrl?: string;
+}
+export interface CustomThemeOptions extends BaseThemeOptions {
     palette: CustomPaletteSet;
 }
+export interface CustomThemeOptionsWithScheme extends BaseThemeOptions {
+    default?: 'light' | 'dark';
+    palettes: {
+        light: CustomPaletteSet;
+        dark: CustomPaletteSet;
+    };
+}
+export interface CustomThemes extends Array<CustomThemeOptions | CustomThemeOptionsWithScheme> {
+}
 export interface DefaultPaletteSet {
     brandPrimary: string;
     brandSecondary: string;
     backgroundPrimary: string;
 }
+export interface BackgroundLayers {
+    background1: string;
+    background2: string;
+    background3: string;
+    background4: string;
+    background5: string;
+    background6: string;
+}
+export interface PaletteLayersBackgrounds {
+    light: Partial<BackgroundLayers>;
+    dark: Partial<BackgroundLayers>;
+}
 export interface CustomPaletteSet extends DefaultPaletteSet {
     functional1?: string;
     functional2?: string;
@@ -62,5 +85,7 @@ export interface CustomPaletteSet extends DefaultPaletteSet {
  * @param customPalettes
  * @returns theme object ready to be applied to the UI
  */
-export declare const computeThemes: (customPalettes: CustomThemes) => ComputedThemes;
+export declare const computeThemes: (customPalettes: CustomThemes, storedScheme?: ColorSchemeOptionType) => ComputedThemes;
 export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<ComputedTheme>;
+export declare const setSelectedScheme: (ctx: ColorSchemeOptionType) => Promise<void>;
+export {};

package/common/src/utils/create-and-migrate-ibd-store.d.ts

@@ -0,0 +1,2 @@
+import { UseStore } from 'idb-keyval';
+export declare const getNewStoreAndMigrateLegacyStore: (storeName: string, tableName: string) => UseStore;

package/common/src/utils/global-context-menu.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@openfin/core" />
 import { MenuItemType } from '../../../common/src/utils/context-menu';
 import * as WP from '../../../client-api-platform/src/index';
 import { GlobalContextMenuItemTemplate, GlobalContextMenuOptionType, Workspace } from '../../../client-api-platform/src/shapes';
@@ -40,4 +39,13 @@ export declare const getSavedWorkspaceContextMenuOptions: (activeWorkspace: Work
         workspaceId: string;
     };
 }[];
+export declare const getAppearanceContextMenuOptions: () => Promise<{
+    label: string;
+    type: MenuItemType;
+    checked: boolean;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+        scheme: WP.ColorSchemeOptionType;
+    };
+}[]>;
 export declare const getGlobalContextMenuTemplate: (winIdentity: OpenFin.Identity) => Promise<GlobalContextMenuItemTemplate[]>;

package/common/src/utils/landing-page.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@openfin/core" />
 interface LandingPageUrls {
     newPageUrl: string | false;
     newTabUrl: string | false;
@@ -6,5 +5,5 @@ interface LandingPageUrls {
 export declare const getLandingPageUrls: (winIdentity?: OpenFin.Identity) => Promise<LandingPageUrls>;
 export declare const checkHasNewTabUrl: () => Promise<boolean>;
 export declare const getNewLandingTabViewOptions: (target: OpenFin.Identity) => Promise<OpenFin.PlatformViewCreationOptions>;
-export declare const makeNewLandingPage: (winIdentity?: OpenFin.Identity) => Promise<import("@client-platform/").PageWithUpdatableRuntimeAttribs>;
+export declare const makeNewLandingPage: (winIdentity?: OpenFin.Identity) => Promise<import("@client-platform/shapes").PageWithUpdatableRuntimeAttribs>;
 export {};

package/common/src/utils/local-storage-key.d.ts

@@ -4,6 +4,8 @@ declare enum LocalStorageKey {
     MachineName = "machineName",
     NewTabPageLayout = "NewTabPageLayout",
     NewTabPageSort = "NewTabPageSort",
-    DockPosition = "DockPosition"
+    DockPosition = "DockPosition",
+    SelectedColorScheme = "SelectedColorScheme",
+    HasMovedStore = "HasMovedStore"
 }
 export default LocalStorageKey;

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

@@ -1,6 +1,5 @@
 /// <reference types="@openfin/core" />
 import { ResponseModalConfig } from './menu-config';
-import { Point } from './window';
 /**
  * returns the correct bounds for the response modal to be displayed at
  * this will return the correct bounds regardless of whether the window is maximized
@@ -10,7 +9,7 @@ import { Point } from './window';
  * @param centerOnMonitor whether the modal should be centered on the monitor
  * @returns a point (top/left) as to where the window should be placed
  */
-export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<Point>;
+export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean) => Promise<OpenFin.Bounds>;
 /**
  * calculates the percenage of the window that is present within the monitor (float in range 0-1)
  *
@@ -19,3 +18,4 @@ export declare const getResponseModalBounds: (modalOptions: ResponseModalConfig[
  */
 export declare function getPercentageOfBoundsInMonitor(bounds: OpenFin.Bounds, monitor: OpenFin.MonitorDetails): number;
 export declare function getMonitorWindowMaximizedOn(parentWindowBounds: OpenFin.WindowBounds): Promise<OpenFin.MonitorDetails>;
+export declare function getResponseModalBoundsAndCenterParentIfModalOffScreen(modalOptions: ResponseModalConfig['windowOptions'], parentWindowIdentity?: OpenFin.Identity, centerOnMonitor?: boolean): Promise<OpenFin.Bounds>;

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

@@ -0,0 +1,14 @@
+export declare function getNotifications(): Promise<typeof import("@client/notifications")>;
+/**
+ * Shows the Notification Center and navigates to "All" section.
+ */
+export declare function navigateToNotificationCenter(): Promise<void>;
+/**
+ * Toggles the Notification Center to Show/Hide it.
+ */
+export declare function toggleNotificationCenter(): Promise<void>;
+/**
+ * Create a specific notification for the saving of Pages as they are being closed.
+ * TODO: Make a better abstraction for notifications and have this use that abstraction
+ */
+export declare const sendPageSaveNotification: () => Promise<void>;

package/common/src/utils/page-tab-context-menu.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="@openfin/core" />
 import { PageTabContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
 export declare const getPageTabMenuTemplate: (pageId: string, winIdentity: OpenFin.Identity) => Promise<PageTabContextMenuItemTemplate[]>;

package/common/src/utils/promise-with-timeout.d.ts

@@ -0,0 +1 @@
+export declare const awaitPromiseWithTimeout: (promise: Promise<any>, timeout: number, timoutErrorMessage: string) => Promise<any>;

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

@@ -1,4 +1,4 @@
-import { CustomPaletteSet } from '../../../common/src/api/theming';
+import { BackgroundLayers, CustomPaletteSet } from '../../../common/src/api/theming';
 /**
  * Get hue from a CSS color
  *
@@ -25,24 +25,7 @@ import { CustomPaletteSet } from '../../../common/src/api/theming';
  * @returns hue as string
  */
 export declare const getHue: (colorInput: string) => string;
-export declare const makeBackgroundLayers: (hue: string) => {
-    light: {
-        background1: string;
-        background2: string;
-        background3: string;
-        background4: string;
-        background5: string;
-        background6: string;
-    };
-    dark: {
-        background1: string;
-        background2: string;
-        background3: string;
-        background4: string;
-        background5: string;
-        background6: string;
-    };
-};
+export declare const makeBackgroundLayers: (backgroundPrimary: string, isLightBackground?: boolean) => BackgroundLayers;
 /**
  * makePalette() - generic - doesn't care about scheme
  *

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

@@ -1,9 +1,20 @@
+/// <reference types="@openfin/core" />
+import { AttachedPage } from '../../../client-api-platform/src/shapes';
 export interface RegisterUsageStatus {
     apiVersion?: string;
     componentVersion?: string;
     allowed: boolean;
     rejectionCode?: string;
 }
+export declare enum ComponentName {
+    Browser = "Browser",
+    Dock = "Dock",
+    Home = "Home",
+    Notification = "Notification",
+    Storefront = "Storefront",
+    Platform = "Platform",
+    Theming = "Theming"
+}
 export declare const registerBrowserUsage: (status: RegisterUsageStatus) => Promise<void>;
 export declare const registerHomeUsage: (status: RegisterUsageStatus) => Promise<void>;
 export declare const registerStorefrontUsage: (status: RegisterUsageStatus) => Promise<void>;
@@ -11,3 +22,31 @@ export declare const registerDockUsage: (status: RegisterUsageStatus) => Promise
 export declare const registerNotificationUsage: (status: RegisterUsageStatus) => Promise<void>;
 export declare const registerPlatformUsage: (status: RegisterUsageStatus) => Promise<void>;
 export declare const registerThemingUsage: (status: RegisterUsageStatus) => Promise<void>;
+export declare enum AnalyticsSource {
+    Browser = "Browser",
+    Dock = "Dock",
+    Home = "Home",
+    Notification = "Notification",
+    Storefront = "Storefront",
+    Platform = "Platform",
+    Theming = "Theming",
+    Interop = "Interop"
+}
+/**
+ * Event for analytics
+ */
+export declare type AnalyticsEvent = {
+    source: AnalyticsSource;
+    type: string;
+    action: string;
+    value?: string;
+    entityId?: OpenFin.Identity;
+    data?: any;
+};
+export declare type AnalyticsEventInternal = Omit<AnalyticsEvent, 'source'>;
+export declare const raiseBrowserAnalytics: (payload: AnalyticsEventInternal) => Promise<void>;
+export declare const raiseBrowserPageAnalytics: (pages: AttachedPage[], action: string) => Promise<void>;
+export declare const raiseHomeAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventInternal) => Promise<void>;
+export declare const raiseDockAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventInternal) => Promise<void>;
+export declare const raiseStorefrontAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventInternal) => Promise<void>;
+export declare const raiseInteropAnalytics: (payload: AnalyticsEventInternal) => Promise<void>;

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

@@ -57,7 +57,7 @@ export declare const getCenterFromBounds: (bounds: OpenFin.WindowBounds) => Poin
  * @param size height and width of the window
  * @returns coords representing the left, top of window given the center point
  */
-export declare const getBoundsFromCenter: (center: Point, size: Size) => Point;
+export declare const getBoundsFromCenter: (center: Point, size: Size) => OpenFin.Bounds;
 /**
  * Get a wrapped OpenFin window.
  *
@@ -82,7 +82,7 @@ export declare function getCurrentOFWindow(): import("@openfin/core/src/api/wind
 export declare const homeOFIdentity: WindowIdentity;
 export declare const dockOFIdentity: WindowIdentity;
 export declare const notificationCenterOFIdentity: WindowIdentity;
-export declare const StorefrontOFIdentity: WindowIdentity;
+export declare const storefrontOFIdentity: WindowIdentity;
 export declare const providerOFIdentity: WindowIdentity;
 /**
  * Get the Home OpenFin window.
@@ -153,7 +153,6 @@ export declare const isNotificationCenterRunning: () => Promise<boolean>;
 export declare const isHomeWindowRunning: () => Promise<boolean>;
 export declare const showAndFocusStorefront: () => Promise<void>;
 export declare const showAndFocusDock: () => Promise<void>;
-export declare const centerWindowIfOffScreen: (windowIdentity?: WindowIdentity) => Promise<void>;
 export declare const getDisableMultiplePagesOption: (identity: WindowIdentity) => Promise<any>;
 export declare const getIsLockedOption: (identity: WindowIdentity) => Promise<any>;
 export declare const getPlatformWindowTitle: (identity: WindowIdentity) => Promise<any>;

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

@@ -1,4 +1,3 @@
-/// <reference types="@openfin/core" />
 import { ResponseModalConfig } from '../../../common/src/utils/menu-config';
 export declare const restoreChangesMenu: (windowIdentity: OpenFin.Identity) => Promise<ResponseModalConfig>;
 export declare const showSwitchWorkspaceModal: (windowIdentity: OpenFin.Identity, workspaceTitle: string) => Promise<boolean>;