@openfin/workspace-platform 46.0.1 → 46.0.3

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.
@@ -7,7 +7,7 @@ import type { LaunchAppRequest, SearchSitesRequest, SearchSitesResponse, Site }
7
7
  * @param app the app directory entry.
8
8
  * @param opts launch options.
9
9
  */
10
- export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.View | OpenFin.Platform | OpenFin.Application>;
10
+ export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.Platform | OpenFin.Application | OpenFin.View>;
11
11
  export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
12
12
  export declare function getResults(payload: {
13
13
  req: SearchSitesRequest;
@@ -658,13 +658,23 @@ export interface BrowserWorkspacePlatformWindowOptions {
658
658
  */
659
659
  title?: WindowTitle | string;
660
660
  /**
661
- * Landing page that shows up when you add a new tab from the plus button that exists in the tabstrip.
662
- * If you do not provide a newTabUrl, then the plus button in the tabstrip will not be shown and users cannot create a new empty tab.
661
+ * URL used for new-tab actions: the plus button in the tabstrip, the new-tab hotkey, and the
662
+ * "New tab" context menu entry.
663
+ *
664
+ * If you do not provide a newTabUrl, then the plus button in the tabstrip will not be shown and
665
+ * users cannot create a new empty tab.
666
+ *
667
+ * This does not control a newly created window's initial content; that comes from `pages`.
663
668
  */
664
669
  newTabUrl?: string;
665
670
  /**
666
- * Landing page that shows up when you add a new page from the plus button that exists in the window frame where the page selector is shown.
667
- * If you do not provide a newPageUrl, then the new Page plus button will not be shown and you cannot create a new empty Page or Window.
671
+ * URL used for new-page and new-window actions.
672
+ *
673
+ * If you do not provide a newPageUrl, then the new Page plus button will not be shown and you
674
+ * cannot create a new empty Page or Window.
675
+ *
676
+ * This does not automatically control a newly created window's initial content; a caller of
677
+ * `Browser.createWindow` must include a page using this URL in `pages`.
668
678
  */
669
679
  newPageUrl?: string;
670
680
  toolbarOptions?: ToolbarOptions;
@@ -264,8 +264,6 @@ export type AddDefaultPagePayload = {
264
264
  identity: OpenFin.Identity;
265
265
  /** The page to attach. */
266
266
  page: PageWithUpdatableRuntimeAttribs;
267
- /** The newPageUrl provided. */
268
- newPageUrl: string;
269
267
  };
270
268
  export type AddPagePayload = {
271
269
  /** The OF window identity to attach the pages to. */
@@ -307,7 +307,7 @@ export declare const constructThemePaletteSheet: (themes: GeneratedPalettes, leg
307
307
  dark: string;
308
308
  }) => string;
309
309
  export declare const getComputedPlatformTheme: (platformIdentity: OpenFin.Identity) => Promise<{
310
- theme: GeneratedPalettes | CustomThemes;
310
+ theme: CustomThemes | GeneratedPalettes;
311
311
  defaultScheme: ColorSchemeOptionType;
312
312
  themePaletteSheet: string;
313
313
  }>;
@@ -3,14 +3,19 @@ interface LandingPageUrls {
3
3
  newPageUrl: string | false;
4
4
  newTabUrl: string | false;
5
5
  }
6
+ /**
7
+ * Which window option supplies the landing URL: `newTabUrl` for a new tab, `newPageUrl` for a new
8
+ * page or window. Enterprise Browser presents pages as tabs, so both go through page creation.
9
+ */
10
+ export type NewLandingPageUrlSource = 'newTab' | 'newPage';
6
11
  export declare const getLandingPageUrls: (winIdentity?: OpenFin.Identity) => Promise<LandingPageUrls>;
7
12
  export declare const checkHasNewTabUrl: () => Promise<boolean>;
8
13
  export declare const getNewLandingTabViewOptions: (target: OpenFin.Identity) => Promise<OpenFin.PlatformViewCreationOptions>;
9
14
  /**
10
15
  * Makes a new landing page.
11
16
  *
12
- * If winIdentity is specified, it uses the newPageUrl defined by the browser window options.
13
- * Otherwise, if the platform is Enterprise, it will use the landing page URL.
17
+ * If winIdentity is specified, it uses the URL defined by the browser window options for the given
18
+ * `urlSource`. Otherwise, if the platform is Enterprise, it will use the landing page URL.
14
19
  */
15
- export declare const makeNewLandingPage: (winIdentity?: OpenFin.Identity) => Promise<import("client-api-platform").PageWithUpdatableRuntimeAttribs>;
20
+ export declare const makeNewLandingPage: (winIdentity?: OpenFin.Identity, urlSource?: NewLandingPageUrlSource) => Promise<import("client-api-platform").PageWithUpdatableRuntimeAttribs>;
16
21
  export {};
@@ -13,6 +13,14 @@
13
13
  "issuer": "common/src/utils/layout.ts"
14
14
  }
15
15
  ],
16
+ "lodash.clonedeep": [
17
+ {
18
+ "type": "explicit",
19
+ "version": "4.5.0",
20
+ "packageName": "common/package.json",
21
+ "issuer": "common/src/utils/layout.ts"
22
+ }
23
+ ],
16
24
  "react-i18next": [
17
25
  {
18
26
  "type": "explicit",
@@ -29,19 +37,27 @@
29
37
  "issuer": "common/src/api/i18next.ts"
30
38
  }
31
39
  ],
32
- "dexie": [
40
+ "title-case": [
33
41
  {
34
- "type": "root-implicit",
35
- "version": "^4.0.11",
36
- "packageName": "dock3/package.json",
37
- "issuer": "dock3/src/api/idb.ts"
38
- },
42
+ "type": "explicit",
43
+ "version": "3.0.3",
44
+ "packageName": "common/package.json",
45
+ "issuer": "common/src/utils/color-linking.ts"
46
+ }
47
+ ],
48
+ "dexie": [
39
49
  {
40
50
  "type": "explicit",
41
51
  "version": "^4.0.11",
42
52
  "packageName": "client-api-platform/package.json",
43
53
  "issuer": "client-api-platform/src/api/dock/idb.ts"
44
54
  },
55
+ {
56
+ "type": "root-implicit",
57
+ "version": "^4.0.11",
58
+ "packageName": "dock3/package.json",
59
+ "issuer": "dock3/src/api/idb.ts"
60
+ },
45
61
  {
46
62
  "type": "explicit",
47
63
  "version": "^4.0.11",
@@ -54,21 +70,5 @@
54
70
  "packageName": "common/package.json",
55
71
  "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
56
72
  }
57
- ],
58
- "title-case": [
59
- {
60
- "type": "explicit",
61
- "version": "3.0.3",
62
- "packageName": "common/package.json",
63
- "issuer": "common/src/utils/color-linking.ts"
64
- }
65
- ],
66
- "lodash.clonedeep": [
67
- {
68
- "type": "explicit",
69
- "version": "4.5.0",
70
- "packageName": "common/package.json",
71
- "issuer": "common/src/utils/layout.ts"
72
- }
73
73
  ]
74
74
  }