@openfin/workspace-platform 45.1.0-alpha.76fdf8b1 → 45.1.0-alpha.9477a30a

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.Platform | OpenFin.Application | OpenFin.View>;
10
+ export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | OpenFin.Identity | OpenFin.View | OpenFin.Platform | OpenFin.Application>;
11
11
  export declare const enterpriseAppDirectoryChannelClient: () => Promise<OpenFin.ChannelClient>;
12
12
  export declare function getResults(payload: {
13
13
  req: SearchSitesRequest;
@@ -1,6 +1,6 @@
1
1
  export * from './shapes';
2
2
  export * as Dock from '../../dock3/src/api';
3
3
  export * as HomeVpw from '../../home-vpw/src/api';
4
- export * as Storefront from '../../storefront-vpw/src/api';
4
+ export * as StorefrontVpw from '../../storefront-vpw/src/api';
5
5
  export { init } from './init';
6
6
  export { getCurrentSync, wrapSync } from './api';
@@ -1,19 +1,2 @@
1
1
  import { OpenFin } from '@openfin/core';
2
- interface ViewComponentDef {
3
- name: string;
4
- url: string;
5
- }
6
- /**
7
- * Create non-layout view components for the browser window.
8
- * This includes find-in-page, search view, and (if enabled) AI companion view.
9
- *
10
- * Returns the list of views that failed to create due to transient network errors.
11
- */
12
- export declare const createNonLayoutViewComponents: (isEnterprise: boolean, overrideOptions: OpenFin.PlatformWindowCreationOptions) => Promise<ViewComponentDef[]>;
13
- /**
14
- * Retries creating views that failed due to transient network errors.
15
- * Registers a one-shot `shown` listener on the window — by the time the window is
16
- * visible, network connectivity has been restored (content had to load to trigger show).
17
- */
18
- export declare const recoverFailedViewComponents: (viewCreationPromise: Promise<ViewComponentDef[]>, parentWindow: OpenFin.Window) => Promise<void>;
19
- export {};
2
+ export declare const createNonLayoutViewComponents: (isEnterprise: boolean, overrideOptions: OpenFin.PlatformWindowCreationOptions) => Promise<void[]>;
@@ -1,8 +1,9 @@
1
1
  import type OpenFin from '@openfin/core';
2
+ import type { BrowserCreateViewRequest } from '../../../../client-api-platform/src/shapes';
2
3
  type DefaultViewOptions = Partial<OpenFin.MutableViewOptions> & {
3
4
  downloadShelf?: OpenFin.ConstWindowOptions['downloadShelf'];
4
5
  hotkeys?: OpenFin.ViewOptions['hotkeys'];
5
6
  };
6
7
  export declare const DEFAULT_VIEW_OPTIONS: DefaultViewOptions;
7
- export declare function applyViewDefaults(options: Partial<OpenFin.ViewOptions>, initViewOptions?: Partial<OpenFin.ViewOptions>): Promise<any>;
8
+ export declare function applyViewDefaults(options: Partial<BrowserCreateViewRequest>, initViewOptions?: Partial<BrowserCreateViewRequest>): Promise<any>;
8
9
  export {};
@@ -2497,9 +2497,28 @@ export interface BrowserInitConfig {
2497
2497
  /** Default options when creating a new page. If `iconUrl`, `unsavedIconUrl`, `panels` or `closeButton` are not defined when creating a page, setting will default to `defaultPageOptions`. */
2498
2498
  defaultPageOptions?: Pick<Page, 'iconUrl' | 'unsavedIconUrl' | 'closeButton' | 'panels'>;
2499
2499
  /**
2500
- * The default options when creating a new browser window. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createView(options) call will default to the value provided in this field.
2500
+ * The default options when creating a new view. Any option not included in WorkspacePlatform.getCurrentSync().Browser.createView(options) call will default to the value provided in this field.
2501
+ *
2502
+ * @example
2503
+ * ```ts
2504
+ * import * as WorkspacePlatform from '@openfin/workspace-platform';
2505
+ *
2506
+ * await WorkspacePlatform.init({
2507
+ * browser: {
2508
+ * defaultViewOptions: {
2509
+ * workspacePlatform: {
2510
+ * browserNavigationButtons: {
2511
+ * back: true,
2512
+ * forward: true,
2513
+ * reload: true
2514
+ * }
2515
+ * }
2516
+ * }
2517
+ * }
2518
+ * });
2519
+ * ```
2501
2520
  */
2502
- defaultViewOptions?: Partial<OpenFin.ViewOptions>;
2521
+ defaultViewOptions?: Partial<BrowserCreateViewRequest>;
2503
2522
  /**
2504
2523
  * The platform title. UI friendly title for the platform in browser.
2505
2524
  */
@@ -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: CustomThemes | GeneratedPalettes;
310
+ theme: GeneratedPalettes | CustomThemes;
311
311
  defaultScheme: ColorSchemeOptionType;
312
312
  themePaletteSheet: string;
313
313
  }>;
@@ -1,7 +1,7 @@
1
1
  import type OpenFin from '@openfin/core';
2
2
  import { WindowIdentity } from '../../../common/src/utils/window';
3
3
  import type { PagePinnedState } from '../../../common/src/api/pages/shapes';
4
- import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
4
+ import { AttachedPage, BrowserCreateViewRequest, PageLayout } from '../../../client-api-platform/src/shapes';
5
5
  export type LayoutDOMEventType =
6
6
  /**
7
7
  * Fired when a tab is created in a container. (Emmitted by ??)
@@ -90,7 +90,7 @@ export declare const generateViewNameAndIdentifierNameIfNotExists: <T extends {
90
90
  * @param layout The Layout to be cloned
91
91
  * @returns A Promise resolving to a copy of the layout with view options converted
92
92
  */
93
- export declare const cloneLayoutAndConvertViewOptions: (layout: PageLayout, initViewOptions?: Partial<OpenFin.ViewOptions>) => Promise<PageLayout>;
93
+ export declare const cloneLayoutAndConvertViewOptions: (layout: PageLayout, initViewOptions?: Partial<BrowserCreateViewRequest>) => Promise<PageLayout>;
94
94
  export declare const cloneViewComponentWithoutName: (componentState: any) => any;
95
95
  /**
96
96
  * Deep clones a layout and removes generated view names.
@@ -2,6 +2,10 @@
2
2
  * All routes that serve HTML pages for the app.
3
3
  * Routes should include the zone that the HTML page is a part of.
4
4
  * Make sure to include trailing slash, as it is essential for deployed version to route correctly.
5
+ *
6
+ * Offline: zone `pages/` HTML is auto-precached at build time via
7
+ * `common/scripts/offline-document-routes.js` (used by createWorkspaceNextConfig).
8
+ * Adding a new page under `pages/` is enough — no manual SW list update.
5
9
  */
6
10
  declare enum WorkspaceRoute {
7
11
  Home = "/home/",
@@ -21,14 +21,6 @@
21
21
  "issuer": "common/src/utils/color-linking.ts"
22
22
  }
23
23
  ],
24
- "lodash.clonedeep": [
25
- {
26
- "type": "explicit",
27
- "version": "4.5.0",
28
- "packageName": "common/package.json",
29
- "issuer": "common/src/utils/layout.ts"
30
- }
31
- ],
32
24
  "react-i18next": [
33
25
  {
34
26
  "type": "explicit",
@@ -45,19 +37,27 @@
45
37
  "issuer": "common/src/api/i18next.ts"
46
38
  }
47
39
  ],
48
- "dexie": [
40
+ "lodash.clonedeep": [
49
41
  {
50
42
  "type": "explicit",
51
- "version": "^4.0.11",
52
- "packageName": "client-api-platform/package.json",
53
- "issuer": "client-api-platform/src/api/dock/idb.ts"
54
- },
43
+ "version": "4.5.0",
44
+ "packageName": "common/package.json",
45
+ "issuer": "common/src/utils/layout.ts"
46
+ }
47
+ ],
48
+ "dexie": [
55
49
  {
56
50
  "type": "root-implicit",
57
51
  "version": "^4.0.11",
58
52
  "packageName": "dock3/package.json",
59
53
  "issuer": "dock3/src/api/idb.ts"
60
54
  },
55
+ {
56
+ "type": "explicit",
57
+ "version": "^4.0.11",
58
+ "packageName": "client-api-platform/package.json",
59
+ "issuer": "client-api-platform/src/api/dock/idb.ts"
60
+ },
61
61
  {
62
62
  "type": "explicit",
63
63
  "version": "^4.0.11",