@openfin/workspace 10.3.8 → 11.0.0

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

@@ -1,5 +1,6 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { App, StorefrontFooter, StorefrontLandingPage, StorefrontNavigationItemAppGrid, StorefrontNavigationSection, StorefrontProviderInfo } from '../../../client-api/src/shapes';
+import { UpdateStoreCustomButtonStateRequest } from '../../../client-api-platform/src/shapes';
 export interface StorefrontProviderInfoWithIdentity extends StorefrontProviderInfo {
     platformIdentity: OpenFin.Identity;
 }
@@ -17,42 +18,62 @@ export interface StorefrontProviderIdentity {
      */
     platformIdentity: OpenFin.Identity;
 }
+/**
+ * Request object to launch an app.
+ */
 export interface LaunchStorefrontProviderAppRequest extends StorefrontProviderIdentity {
+    /**
+     * App to launch.
+     */
     app: App;
 }
 /**
  * Launch a Storefront app.
- * @param platformIdentity the identity of the platform that provided the app.
+ * @param req LaunchStorefrontProviderAppRequest request object.
  */
 export declare const launchStorefrontApp: (req: LaunchStorefrontProviderAppRequest) => Promise<void>;
+/**
+ * A request to update store primary button state.
+ */
+export interface UpdateStoreCustomButtonStateRequestWithProvider extends UpdateStoreCustomButtonStateRequest, StorefrontProviderIdentity {
+    /**
+     * App id.
+     */
+    appId: string;
+}
+/**
+ * Updates primary button state.
+ * @param req update request.
+ */
+export declare const setStoreButtonState: (req: UpdateStoreCustomButtonStateRequestWithProvider) => Promise<void>;
 /**
  * Get a list of applications for Storefront.
- * @param platformIdentity the identity of the platform to get the apps from.
+ * @param identity of the platform to get the apps from.
  * @returns the list of Storefront apps for the platform.
  */
 export declare const getStorefrontApps: (identity: StorefrontProviderIdentity) => Promise<App[]>;
 /**
  * Get the platform's landing page for Storefront.
- * @param platformIdentity the identity of the platform to get the landing page of.
+ * @param identity of the platform to get the landing page of.
  * @returns the platform's landing page.
  */
 export declare const getStorefrontLandingPage: (identity: StorefrontProviderIdentity) => Promise<StorefrontLandingPage | undefined>;
 /**
  * Get the platform's footer for Storefront.
- * @param platformIdentity the identity of the platform to get the footer of.
+ * @param identity of the platform to get the footer of.
  * @returns the platform's footer.
  */
 export declare const getStorefrontFooter: (identity: StorefrontProviderIdentity) => Promise<StorefrontFooter>;
 /**
  * Get the platform's navigation for Storefront.
- * @param platformIdentity the identity of the platform to get the navigation of.
+ * @param identity of the platform to get the navigation of.
  * @returns the platform's navigation.
  */
 export declare const getStorefrontNavigation: (identity: StorefrontProviderIdentity) => Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>;
 /**
  * A helper method that gets a Storefront navigation item by ID.
  * @param navigationItemId the id of the Storefront navigation item.
- * @param platformIdentity the platform identity.
+ * @param identity of the platform.
  * @returns the navigation item with the ID.
  */
 export declare const getStorefrontNavigationItemAppGrid: (navigationItemId: string, identity: StorefrontProviderIdentity) => Promise<StorefrontNavigationItemAppGrid | undefined>;

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

@@ -1,3 +1,4 @@
+import type OpenFin from '@openfin/core';
 import type { ThemePaletteSet } from '@openfin/ui-library';
 import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
 export interface ComputedThemes extends Array<ComputedTheme> {

package/common/src/api/workspaces/index.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 export interface Workspace {
     workspaceId: string;
     title: string;

package/common/src/test/fin-mocks.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 export declare enum ApplicationUUID {
     /**
      * The UUID of workspace.

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 export declare enum MenuItemType {
     Label = "normal",
     Separator = "separator",

package/common/src/utils/defer-show.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 interface InternalWindowOptions extends OpenFin.PlatformWindowCreationOptions {
     workspacePlatform: OpenFin.WindowOptions['workspacePlatform'] & {
         _internalDeferShowOptions?: {
@@ -32,7 +32,7 @@ export declare const applyDeferShowOptions: (opts: OpenFin.PlatformWindowCreatio
  * @param superCreateWindow the create window method to decorate.
  * @returns the `createWindow` method wrapped with this middleware.
  */
-export declare const withDeferShow: (superCreateWindow: (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity: OpenFin.Identity) => Promise<OpenFin.Window>) => (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity?: OpenFin.Identity) => Promise<import("@openfin/core/src/api/window")._Window>;
+export declare const withDeferShow: (superCreateWindow: (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity: OpenFin.Identity) => Promise<OpenFin.Window>) => (opts: OpenFin.PlatformWindowCreationOptions, callerIdentity: OpenFin.Identity) => Promise<import("@openfin/core/src/api/window")._Window>;
 /**
  * Assert if the window is able to be shown or not.
  * Upon calling `setCanShow(true)`, if the window was previously prevented

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

@@ -1,3 +1,4 @@
+import type OpenFin from '@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';

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

@@ -5,12 +5,12 @@ export declare enum BrowserIndicatorIcon {
 /**
  * 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<void>;
 /**
  * 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<void>;
 /**
  * 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<void>;

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

@@ -1,2 +1,2 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 export default function makeShowIndicator(opts?: OpenFin.PlatformWindowCreationOptions): (namespace: string, url: string, message: string, type: string) => Promise<void>;

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

@@ -1,3 +1,4 @@
+import type OpenFin from '@openfin/core';
 interface LandingPageUrls {
     newPageUrl: string | false;
     newTabUrl: string | false;

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
 import { WindowIdentity } from './window';
 export declare type LayoutComponentStateExtended = OpenFin.LayoutComponent['componentState'] & {
@@ -12,7 +12,7 @@ export declare type LayoutStack = {
     type: 'stack';
     content: OpenFin.LayoutContent;
 };
-export declare type LayoutContentItemExtended = OpenFin.LayoutRow | OpenFin.LayoutColumn | LayoutComponentExtended | LayoutStack;
+export declare type LayoutContentItemExtended = OpenFin.LayoutRow | OpenFin.LayoutColumn | LayoutStack | LayoutComponentExtended | OpenFin.LayoutItemConfig;
 export declare type LayoutContentExtended = LayoutContentItemExtended[];
 export declare type LayoutSettingsExtended = OpenFin.LayoutOptions['settings'] & {
     reorderEnabled?: boolean;
@@ -43,12 +43,23 @@ export declare const getFirstViewFromLayout: (identity?: WindowIdentity) => Prom
     name: any;
     uuid: any;
 }>;
+/**
+ * Copies the componentState and generates a name if it's not there
+ * @param componentState view's componentState in the layout object, corresponds to View options
+ * @returns A copy of the componentState with name filled in
+ */
+export declare const generateViewNameIfNotExists: <T extends {
+    name?: string;
+}>(componentState: T) => T & {
+    name: string;
+};
 /**
  * Deep clones a layout and adds view names if they don't exist.
  * @param layout The Layout to be cloned
  * @returns A copy of the layout with names added where necessary
  */
 export declare const cloneLayoutAndFillInViewNames: (layout: PageLayout) => any;
+export declare const cloneViewComponentWithoutName: (componentState: any) => any;
 /**
  * Deep clones a layout and removes view names.
  * @param layout The Layout to be cloned
@@ -56,7 +67,37 @@ export declare const cloneLayoutAndFillInViewNames: (layout: PageLayout) => any;
  */
 export declare const cloneLayoutAndRemoveNames: (layout: PageLayout) => any;
 export declare const mapContentComponentState: (content: OpenFin.LayoutContent | LayoutContentExtended) => LayoutComponentStateExtended[];
-export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<any>;
+export declare const getLayoutWithSingleView: (title: string, url: string, winIdentity?: OpenFin.Identity) => Promise<{
+    content: {
+        type: string;
+        content: {
+            type: string;
+            componentName: string;
+            componentState: {
+                title: string;
+                url: string;
+            };
+        }[];
+    }[];
+    settings?: {
+        popoutWholeStack?: boolean;
+        constrainDragToContainer?: boolean;
+        showPopoutIcon?: boolean;
+        showMaximiseIcon?: boolean;
+        showCloseIcon?: boolean;
+        constrainDragToHeaders?: boolean;
+        hasHeaders?: boolean;
+        reorderEnabled?: boolean;
+        preventDragOut?: boolean;
+        preventDragIn?: boolean;
+    };
+    dimensions?: {
+        borderWidth?: number;
+        minItemHeight?: number;
+        minItemWidth?: number;
+        headerHeight?: number;
+    };
+}>;
 export declare const isLayoutTabActive: (tabSelector: string) => boolean;
 export declare const containerId = "layout_container";
 export declare const getViewComponents: () => LayoutContentExtended;

package/common/src/utils/menu-config.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import type { OptionalExceptFor } from '../../../common/src/utils/types';
 export interface ModalResponseContent {
     title: string;

package/common/src/utils/menu-window-provider.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { ModalResponseContent } from '../../../common/src/utils/menu-config';
 import { Listener } from '../../../common/src/utils/shared-emitter';
 import type { OptionalExceptFor } from '../../../common/src/utils/types';

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { ResponseModalConfig } from './menu-config';
 /**
  * returns the correct bounds for the response modal to be displayed at

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

@@ -1,2 +1,3 @@
+import type OpenFin from '@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/snapshot.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 export declare type SnapshotDetailsExtended = OpenFin.Snapshot['snapshotDetails'] & {
     machineId: string;
     machineName?: string;

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { AttachedPage } from '../../../client-api-platform/src/shapes';
 export interface RegisterUsageStatus {
     apiVersion?: string;

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

@@ -1,4 +1,4 @@
-/// <reference types="@openfin/core" />
+import type OpenFin from '@openfin/core';
 import { ApplicationUUID } from './application';
 export declare enum WindowName {
     Home = "openfin-home",

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

@@ -1,3 +1,4 @@
+import type OpenFin from '@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>;