@openfin/workspace-platform 17.0.4 → 17.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,4 +4,4 @@ import { BrowserInitConfig } from '../../../../client-api-platform/src/shapes';
4
4
  /**
5
5
  * Applies default options to the creation of browser windows.
6
6
  */
7
- export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions'> | undefined, theme?: CustomThemeOptions | CustomThemeOptionsWithScheme) => Promise<OpenFin.PlatformWindowCreationOptions>;
7
+ export declare const applyBrowserDefaults: (options: OpenFin.PlatformWindowCreationOptions, initOptions: Pick<BrowserInitConfig, 'defaultWindowOptions' | 'defaultPageOptions' | 'defaultViewOptions'> | undefined, theme?: CustomThemeOptions | CustomThemeOptionsWithScheme) => Promise<OpenFin.PlatformWindowCreationOptions>;
@@ -1,3 +1,3 @@
1
1
  import type { AttachedPage } from '../../../../common/src/api/pages/shapes';
2
2
  import type { BrowserInitConfig } from '../..';
3
- export declare const applyPageDefaults: (pages: AttachedPage[], defaultPageOptions?: BrowserInitConfig['defaultPageOptions']) => Promise<AttachedPage[]>;
3
+ export declare const applyPageDefaults: (pages: AttachedPage[], initOptions?: Pick<BrowserInitConfig, 'defaultPageOptions' | 'defaultViewOptions'>) => Promise<AttachedPage[]>;
@@ -0,0 +1,4 @@
1
+ import type OpenFin from '@openfin/core';
2
+ export declare const DEFAULT_VIEW_OPTIONS: Partial<OpenFin.MutableViewOptions>;
3
+ export declare const MANDATORY_VIEW_OPTIONS: Partial<OpenFin.MutableViewOptions>;
4
+ export declare function applyViewDefaults(options: Partial<OpenFin.ViewOptions>, initViewOptions?: Partial<OpenFin.ViewOptions>): any;
@@ -1,6 +1,5 @@
1
1
  import type OpenFin from '@openfin/core';
2
2
  import { BrowserCreateViewRequest, BrowserViewState, BrowserWorkspacePlatformViewOptions } from '../../../../client-api-platform/src/shapes';
3
- export declare function overrideViewOptions(options: Partial<OpenFin.ViewOptions>, initOptions: Partial<OpenFin.ViewOptions>): any;
4
3
  export declare function preserveInteropIfManifestConflict(opts: Partial<OpenFin.ViewOptions>, fetchManifest: ({ manifestUrl }: {
5
4
  manifestUrl: string;
6
5
  }, callerIdentity: OpenFin.Identity) => any, callerIdentity: OpenFin.Identity): Promise<any>;
@@ -23,6 +23,7 @@ export interface BaseCustomDropdownItem extends BaseCustomButtonConfig {
23
23
  checked?: boolean;
24
24
  /** icon URL for icon image */
25
25
  action?: any;
26
+ options?: (BaseCustomDropdownItem | BaseCustomDropdownConfig)[];
26
27
  }
27
28
  export type BaseCustomDropdownItems = BaseCustomDropdownItem[] | (() => Promise<BaseCustomDropdownItem[]>);
28
29
  /**
@@ -38,11 +39,13 @@ export interface BaseCustomDropdownConfig extends BaseCustomButtonConfig {
38
39
  export interface CustomButtonConfig extends BaseCustomButtonConfig {
39
40
  /** Custom action once the button is clicked */
40
41
  action: CustomActionSpecifier;
42
+ options?: never;
41
43
  }
42
44
  /**
43
45
  * Configuration for a button that presents a dropdown menu with options that dispatch custom actions when clicked.
44
46
  */
45
47
  export interface CustomDropdownConfig extends BaseCustomDropdownConfig {
46
48
  /** Options that will be displayed in the dropdown */
47
- options: CustomButtonConfig[];
49
+ options: (CustomButtonConfig | CustomDropdownConfig)[];
50
+ action?: never;
48
51
  }
@@ -1,23 +1,5 @@
1
1
  import { HomeProviderInternal } from '../../../../common/src/api/provider';
2
2
  import { DispatchedSearchResult, HomeSearchListenerRequest, HomeSearchResult } from '../../../../client-api/src/shapes';
3
- /**
4
- * The ids of home providers that are built into Home.
5
- */
6
- export declare const HomeBuiltInProviderID: {
7
- /**
8
- * Built in Home provider that provides commands.
9
- */
10
- readonly commands: "home-commands";
11
- };
12
- /**
13
- * The ids of home providers that are built into Home.
14
- */
15
- export declare const HomeBuiltInProviderUniqueID: {
16
- /**
17
- * Built in Home provider that provides commands.
18
- */
19
- readonly commands: string;
20
- };
21
3
  export declare const HOME_SEARCH_CHANNEL_NAME: "__search-openfin-browser-home-topic__";
22
4
  export type HomeClientApiDispatchRequest = {
23
5
  providerId: string;
@@ -46,11 +46,11 @@ export declare const generateViewNameAndIdentifierNameIfNotExists: <T extends {
46
46
  name?: string;
47
47
  };
48
48
  /**
49
- * Deep clones a layout and adds view names if they don't exist.
49
+ * Deep clones a layout and converts view options (add names if necessary, apply defaults).
50
50
  * @param layout The Layout to be cloned
51
- * @returns A copy of the layout with names added where necessary
51
+ * @returns A copy of the layout with view options converted
52
52
  */
53
- export declare const cloneLayoutAndFillInViewNames: (layout: PageLayout) => any;
53
+ export declare const cloneLayoutAndConvertViewOptions: (layout: PageLayout, initViewOptions?: Partial<OpenFin.ViewOptions>) => any;
54
54
  export declare const cloneViewComponentWithoutName: (componentState: any) => any;
55
55
  /**
56
56
  * Deep clones a layout and removes view names.