@openfin/workspace 46.0.2 → 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.View | OpenFin.Identity | OpenFin.Platform | OpenFin.Application>;
10
+ export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.Platform | OpenFin.View | OpenFin.Application>;
11
11
  export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
12
12
  export declare function getResults(payload: {
13
13
  req: SearchSitesRequest;
@@ -724,13 +724,23 @@ export interface BrowserWorkspacePlatformWindowOptions {
724
724
  */
725
725
  title?: WindowTitle | string;
726
726
  /**
727
- * Landing page that shows up when you add a new tab from the plus button that exists in the tabstrip.
728
- * 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.
727
+ * URL used for new-tab actions: the plus button in the tabstrip, the new-tab hotkey, and the
728
+ * "New tab" context menu entry.
729
+ *
730
+ * If you do not provide a newTabUrl, then the plus button in the tabstrip will not be shown and
731
+ * users cannot create a new empty tab.
732
+ *
733
+ * This does not control a newly created window's initial content; that comes from `pages`.
729
734
  */
730
735
  newTabUrl?: string;
731
736
  /**
732
- * 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.
733
- * 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.
737
+ * URL used for new-page and new-window actions.
738
+ *
739
+ * If you do not provide a newPageUrl, then the new Page plus button will not be shown and you
740
+ * cannot create a new empty Page or Window.
741
+ *
742
+ * This does not automatically control a newly created window's initial content; a caller of
743
+ * `Browser.createWindow` must include a page using this URL in `pages`.
734
744
  */
735
745
  newPageUrl?: string;
736
746
  toolbarOptions?: ToolbarOptions;
@@ -1266,10 +1276,8 @@ export interface BrowserWindowModule {
1266
1276
  * ```ts
1267
1277
  *
1268
1278
  * const newPage = await makeNewLandingPage();
1269
- * const { newPageUrl } = await getLandingPageUrls();
1270
1279
  * const browser = getCurrentSync().Browser.wrapSync(currentOFIdentity);
1271
- * const actualNewPageUrl = newPageUrl ? newPageUrl : undefined;
1272
- * await browser._addDefaultPage({ identity: currentOFIdentity, page: newPage, newPageUrl: actualNewPageUrl });
1280
+ * await browser._addDefaultPage({ identity: currentOFIdentity, page: newPage });
1273
1281
  * ```
1274
1282
  * @param req the default page request object
1275
1283
  * @internal
@@ -272,8 +272,6 @@ export type AddDefaultPagePayload = {
272
272
  identity: OpenFin.Identity;
273
273
  /** The page to attach. */
274
274
  page: PageWithUpdatableRuntimeAttribs;
275
- /** The newPageUrl provided. */
276
- newPageUrl: string;
277
275
  };
278
276
  export type AddPagePayload = {
279
277
  /** The OF window identity to attach the pages to. */
@@ -11,7 +11,7 @@ export declare const isDocumentDefined: boolean;
11
11
  export declare const isWindowDefinedWithIndexDB: boolean;
12
12
  export declare const finUUID: string;
13
13
  export declare const finName: string;
14
- export declare const finEntityType: "" | "window" | "view";
14
+ export declare const finEntityType: "" | "view" | "window";
15
15
  export declare const isEnvLocal: boolean;
16
16
  export declare const isEnvDev: boolean;
17
17
  export declare const isEnvStaging: boolean;
@@ -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-platform/index").PageWithUpdatableRuntimeAttribs>;
20
+ export declare const makeNewLandingPage: (winIdentity?: OpenFin.Identity, urlSource?: NewLandingPageUrlSource) => Promise<import("@client-platform/index").PageWithUpdatableRuntimeAttribs>;
16
21
  export {};
@@ -59,14 +59,6 @@
59
59
  "issuer": "common/src/api/i18next.ts"
60
60
  }
61
61
  ],
62
- "lodash.clonedeep": [
63
- {
64
- "type": "explicit",
65
- "version": "4.5.0",
66
- "packageName": "common/package.json",
67
- "issuer": "common/src/utils/layout.ts"
68
- }
69
- ],
70
62
  "dexie": [
71
63
  {
72
64
  "type": "root-implicit",
@@ -84,13 +76,21 @@
84
76
  "type": "explicit",
85
77
  "version": "^4.0.11",
86
78
  "packageName": "common/package.json",
87
- "issuer": "common/src/api/pages/idb.ts"
79
+ "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
88
80
  },
89
81
  {
90
82
  "type": "explicit",
91
83
  "version": "^4.0.11",
92
84
  "packageName": "common/package.json",
93
- "issuer": "common/src/utils/create-and-migrate-ibd-store.ts"
85
+ "issuer": "common/src/api/pages/idb.ts"
86
+ }
87
+ ],
88
+ "lodash.clonedeep": [
89
+ {
90
+ "type": "explicit",
91
+ "version": "4.5.0",
92
+ "packageName": "common/package.json",
93
+ "issuer": "common/src/utils/layout.ts"
94
94
  }
95
95
  ]
96
96
  }